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         /* Unknown device placeholder */
  65         DPAA2_UNKNOWN
  66 };
  67
  68 TAILQ_HEAD(rte_dpaa2_object_list, rte_dpaa2_object);
  69
  70 typedef int (*rte_dpaa2_obj_create_t)(int vdev_fd,
  71                                       struct vfio_device_info *obj_info,
  72                                       int object_id);
  73
  74 /**
  75  * A structure describing a DPAA2 object.
  76  */
  77 struct rte_dpaa2_object {
  78         TAILQ_ENTRY(rte_dpaa2_object) next; /**< Next in list. */
  79         const char *name;                   /**< Name of Object. */
  80         enum rte_dpaa2_dev_type dev_type;   /**< Type of device */
  81         rte_dpaa2_obj_create_t create;
  82 };
  83
  84 /**
  85  * A structure describing a DPAA2 device.
  86  */
  87 struct rte_dpaa2_device {
  88         TAILQ_ENTRY(rte_dpaa2_device) next; /**< Next probed DPAA2 device. */
  89         struct rte_device device;           /**< Inherit core device */
  90         union {
  91                 struct rte_eth_dev *eth_dev;        /**< ethernet device */
  92                 struct rte_cryptodev *cryptodev;    /**< Crypto Device */
  93         };
  94         enum rte_dpaa2_dev_type dev_type;   /**< Device Type */
  95         uint16_t object_id;                 /**< DPAA2 Object ID */
  96         struct rte_intr_handle intr_handle; /**< Interrupt handle */
  97         struct rte_dpaa2_driver *driver;    /**< Associated driver */
  98         char name[FSLMC_OBJECT_MAX_LEN];    /**< DPAA2 Object name*/
  99 };
 100
 101 typedef int (*rte_dpaa2_probe_t)(struct rte_dpaa2_driver *dpaa2_drv,
 102                                  struct rte_dpaa2_device *dpaa2_dev);
 103 typedef int (*rte_dpaa2_remove_t)(struct rte_dpaa2_device *dpaa2_dev);
 104
 105 /**
 106  * A structure describing a DPAA2 driver.
 107  */
 108 struct rte_dpaa2_driver {
 109         TAILQ_ENTRY(rte_dpaa2_driver) next; /**< Next in list. */
 110         struct rte_driver driver;           /**< Inherit core driver. */
 111         struct rte_fslmc_bus *fslmc_bus;    /**< FSLMC bus reference */
 112         uint32_t drv_flags;                 /**< Flags for controlling device.*/
 113         enum rte_dpaa2_dev_type drv_type;   /**< Driver Type */
 114         rte_dpaa2_probe_t probe;
 115         rte_dpaa2_remove_t remove;
 116 };
 117
 118 /*
 119  * FSLMC bus
 120  */
 121 struct rte_fslmc_bus {
 122         struct rte_bus bus;     /**< Generic Bus object */
 123         struct rte_fslmc_device_list device_list;
 124                                 /**< FSLMC DPAA2 Device list */
 125         struct rte_fslmc_driver_list driver_list;
 126                                 /**< FSLMC DPAA2 Driver list */
 127         int device_count;
 128                                 /**< Optional: Count of devices on bus */
 129 };
 130
 131 /**
 132  * Register a DPAA2 driver.
 133  *
 134  * @param driver
 135  *   A pointer to a rte_dpaa2_driver structure describing the driver
 136  *   to be registered.
 137  */
 138 void rte_fslmc_driver_register(struct rte_dpaa2_driver *driver);
 139
 140 /**
 141  * Unregister a DPAA2 driver.
 142  *
 143  * @param driver
 144  *   A pointer to a rte_dpaa2_driver structure describing the driver
 145  *   to be unregistered.
 146  */
 147 void rte_fslmc_driver_unregister(struct rte_dpaa2_driver *driver);
 148
 149 /** Helper for DPAA2 device registration from driver (eth, crypto) instance */
 150 #define RTE_PMD_REGISTER_DPAA2(nm, dpaa2_drv) \
 151 RTE_INIT(dpaa2initfn_ ##nm); \
 152 static void dpaa2initfn_ ##nm(void) \
 153 {\
 154         (dpaa2_drv).driver.name = RTE_STR(nm);\
 155         rte_fslmc_driver_register(&dpaa2_drv); \
 156 } \
 157 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 158
 159 /**
 160  * Register a DPAA2 MC Object driver.
 161  *
 162  * @param mc_object
 163  *   A pointer to a rte_dpaa_object structure describing the mc object
 164  *   to be registered.
 165  */
 166 void rte_fslmc_object_register(struct rte_dpaa2_object *object);
 167
 168 /** Helper for DPAA2 object registration */
 169 #define RTE_PMD_REGISTER_DPAA2_OBJECT(nm, dpaa2_obj) \
 170 RTE_INIT(dpaa2objinitfn_ ##nm); \
 171 static void dpaa2objinitfn_ ##nm(void) \
 172 {\
 173         (dpaa2_obj).name = RTE_STR(nm);\
 174         rte_fslmc_object_register(&dpaa2_obj); \
 175 } \
 176 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 177
 178 #ifdef __cplusplus
 179 }
 180 #endif
 181
 182 #endif /* _RTE_FSLMC_H_ */