drivers/bus/fslmc/rte_fslmc.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  *
   3  *   Copyright 2016 NXP
   4  *
   5  */
   6
   7 #ifndef _RTE_FSLMC_H_
   8 #define _RTE_FSLMC_H_
   9
  10 /**
  11  * @file
  12  *
  13  * RTE FSLMC Bus Interface
  14  */
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <limits.h>
  23 #include <errno.h>
  24 #include <sys/queue.h>
  25 #include <stdint.h>
  26 #include <inttypes.h>
  27 #include <linux/vfio.h>
  28
  29 #include <rte_debug.h>
  30 #include <rte_interrupts.h>
  31 #include <rte_dev.h>
  32 #include <rte_bus.h>
  33 #include <rte_tailq.h>
  34 #include <rte_devargs.h>
  35
  36 #include <fslmc_vfio.h>
  37
  38 #define FSLMC_OBJECT_MAX_LEN 32   /**< Length of each device on bus */
  39
  40
  41 /** Device driver supports link state interrupt */
  42 #define RTE_DPAA2_DRV_INTR_LSC  0x0008
  43
  44 /** Device driver supports IOVA as VA */
  45 #define RTE_DPAA2_DRV_IOVA_AS_VA 0X0040
  46
  47 struct rte_dpaa2_driver;
  48
  49 /* DPAA2 Device and Driver lists for FSLMC bus */
  50 TAILQ_HEAD(rte_fslmc_device_list, rte_dpaa2_device);
  51 TAILQ_HEAD(rte_fslmc_driver_list, rte_dpaa2_driver);
  52
  53 #define RTE_DEV_TO_FSLMC_CONST(ptr) \
  54         container_of(ptr, const struct rte_dpaa2_device, device)
  55
  56 extern struct rte_fslmc_bus rte_fslmc_bus;
  57
  58 enum rte_dpaa2_dev_type {
  59         /* Devices backed by DPDK driver */
  60         DPAA2_ETH,      /**< DPNI type device*/
  61         DPAA2_CRYPTO,   /**< DPSECI type device */
  62         DPAA2_CON,      /**< DPCONC type device */
  63         /* Devices not backed by a DPDK driver: DPIO, DPBP, DPCI, DPMCP */
  64         DPAA2_BPOOL,    /**< DPBP type device */
  65         DPAA2_IO,       /**< DPIO type device */
  66         DPAA2_CI,       /**< DPCI type device */
  67         DPAA2_MPORTAL,  /**< DPMCP type device */
  68         DPAA2_QDMA,     /**< DPDMAI type device */
  69         /* Unknown device placeholder */
  70         DPAA2_UNKNOWN,
  71         DPAA2_DEVTYPE_MAX,
  72 };
  73
  74 TAILQ_HEAD(rte_dpaa2_object_list, rte_dpaa2_object);
  75
  76 typedef int (*rte_dpaa2_obj_create_t)(int vdev_fd,
  77                                       struct vfio_device_info *obj_info,
  78                                       int object_id);
  79
  80 /**
  81  * A structure describing a DPAA2 object.
  82  */
  83 struct rte_dpaa2_object {
  84         TAILQ_ENTRY(rte_dpaa2_object) next; /**< Next in list. */
  85         const char *name;                   /**< Name of Object. */
  86         enum rte_dpaa2_dev_type dev_type;   /**< Type of device */
  87         rte_dpaa2_obj_create_t create;
  88 };
  89
  90 /**
  91  * A structure describing a DPAA2 device.
  92  */
  93 struct rte_dpaa2_device {
  94         TAILQ_ENTRY(rte_dpaa2_device) next; /**< Next probed DPAA2 device. */
  95         struct rte_device device;           /**< Inherit core device */
  96         union {
  97                 struct rte_eth_dev *eth_dev;        /**< ethernet device */
  98                 struct rte_cryptodev *cryptodev;    /**< Crypto Device */
  99                 struct rte_rawdev *rawdev;          /**< Raw Device */
 100         };
 101         enum rte_dpaa2_dev_type dev_type;   /**< Device Type */
 102         uint16_t object_id;                 /**< DPAA2 Object ID */
 103         struct rte_intr_handle intr_handle; /**< Interrupt handle */
 104         struct rte_dpaa2_driver *driver;    /**< Associated driver */
 105         char name[FSLMC_OBJECT_MAX_LEN];    /**< DPAA2 Object name*/
 106 };
 107
 108 typedef int (*rte_dpaa2_probe_t)(struct rte_dpaa2_driver *dpaa2_drv,
 109                                  struct rte_dpaa2_device *dpaa2_dev);
 110 typedef int (*rte_dpaa2_remove_t)(struct rte_dpaa2_device *dpaa2_dev);
 111
 112 /**
 113  * A structure describing a DPAA2 driver.
 114  */
 115 struct rte_dpaa2_driver {
 116         TAILQ_ENTRY(rte_dpaa2_driver) next; /**< Next in list. */
 117         struct rte_driver driver;           /**< Inherit core driver. */
 118         struct rte_fslmc_bus *fslmc_bus;    /**< FSLMC bus reference */
 119         uint32_t drv_flags;                 /**< Flags for controlling device.*/
 120         enum rte_dpaa2_dev_type drv_type;   /**< Driver Type */
 121         rte_dpaa2_probe_t probe;
 122         rte_dpaa2_remove_t remove;
 123 };
 124
 125 /*
 126  * FSLMC bus
 127  */
 128 struct rte_fslmc_bus {
 129         struct rte_bus bus;     /**< Generic Bus object */
 130         struct rte_fslmc_device_list device_list;
 131                                 /**< FSLMC DPAA2 Device list */
 132         struct rte_fslmc_driver_list driver_list;
 133                                 /**< FSLMC DPAA2 Driver list */
 134         int device_count[DPAA2_DEVTYPE_MAX];
 135                                 /**< Count of all devices scanned */
 136 };
 137
 138 #define DPAA2_PORTAL_DEQUEUE_DEPTH      32
 139
 140 /* Create storage for dqrr entries per lcore */
 141 struct dpaa2_portal_dqrr {
 142         struct rte_mbuf *mbuf[DPAA2_PORTAL_DEQUEUE_DEPTH];
 143         uint64_t dqrr_held;
 144         uint8_t dqrr_size;
 145 };
 146
 147 RTE_DECLARE_PER_LCORE(struct dpaa2_portal_dqrr, dpaa2_held_bufs);
 148
 149 #define DPAA2_PER_LCORE_DQRR_SIZE \
 150         RTE_PER_LCORE(dpaa2_held_bufs).dqrr_size
 151 #define DPAA2_PER_LCORE_DQRR_HELD \
 152         RTE_PER_LCORE(dpaa2_held_bufs).dqrr_held
 153 #define DPAA2_PER_LCORE_DQRR_MBUF(i) \
 154         RTE_PER_LCORE(dpaa2_held_bufs).mbuf[i]
 155
 156 /**
 157  * Register a DPAA2 driver.
 158  *
 159  * @param driver
 160  *   A pointer to a rte_dpaa2_driver structure describing the driver
 161  *   to be registered.
 162  */
 163 void rte_fslmc_driver_register(struct rte_dpaa2_driver *driver);
 164
 165 /**
 166  * Unregister a DPAA2 driver.
 167  *
 168  * @param driver
 169  *   A pointer to a rte_dpaa2_driver structure describing the driver
 170  *   to be unregistered.
 171  */
 172 void rte_fslmc_driver_unregister(struct rte_dpaa2_driver *driver);
 173
 174 /** Helper for DPAA2 device registration from driver (eth, crypto) instance */
 175 #define RTE_PMD_REGISTER_DPAA2(nm, dpaa2_drv) \
 176 RTE_INIT(dpaa2initfn_ ##nm); \
 177 static void dpaa2initfn_ ##nm(void) \
 178 {\
 179         (dpaa2_drv).driver.name = RTE_STR(nm);\
 180         rte_fslmc_driver_register(&dpaa2_drv); \
 181 } \
 182 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 183
 184 /**
 185  * Register a DPAA2 MC Object driver.
 186  *
 187  * @param mc_object
 188  *   A pointer to a rte_dpaa_object structure describing the mc object
 189  *   to be registered.
 190  */
 191 void rte_fslmc_object_register(struct rte_dpaa2_object *object);
 192
 193 /**
 194  * Count of a particular type of DPAA2 device scanned on the bus.
 195  *
 196  * @param dev_type
 197  *   Type of device as rte_dpaa2_dev_type enumerator
 198  * @return
 199  *   >=0 for count; 0 indicates either no device of the said type scanned or
 200  *   invalid device type.
 201  */
 202 uint32_t rte_fslmc_get_device_count(enum rte_dpaa2_dev_type device_type);
 203
 204 /** Helper for DPAA2 object registration */
 205 #define RTE_PMD_REGISTER_DPAA2_OBJECT(nm, dpaa2_obj) \
 206 RTE_INIT(dpaa2objinitfn_ ##nm); \
 207 static void dpaa2objinitfn_ ##nm(void) \
 208 {\
 209         (dpaa2_obj).name = RTE_STR(nm);\
 210         rte_fslmc_object_register(&dpaa2_obj); \
 211 } \
 212 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 213
 214 #ifdef __cplusplus
 215 }
 216 #endif
 217
 218 #endif /* _RTE_FSLMC_H_ */