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