drivers/bus/fslmc/rte_fslmc.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2016 NXP.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above copyright
  13  *       notice, this list of conditions and the following disclaimer in
  14  *       the documentation and/or other materials provided with the
  15  *       distribution.
  16  *     * Neither the name of NXP nor the names of its
  17  *       contributors may be used to endorse or promote products derived
  18  *       from this software without specific prior written permission.
  19  *
  20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef _RTE_FSLMC_H_
  34 #define _RTE_FSLMC_H_
  35
  36 /**
  37  * @file
  38  *
  39  * RTE FSLMC Bus Interface
  40  */
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 #include <stdio.h>
  47 #include <stdlib.h>
  48 #include <limits.h>
  49 #include <errno.h>
  50 #include <sys/queue.h>
  51 #include <stdint.h>
  52 #include <inttypes.h>
  53
  54 #include <rte_debug.h>
  55 #include <rte_interrupts.h>
  56 #include <rte_dev.h>
  57 #include <rte_bus.h>
  58
  59 #define FSLMC_OBJECT_MAX_LEN 32   /**< Length of each device on bus */
  60
  61 struct rte_dpaa2_driver;
  62
  63 /* DPAA2 Device and Driver lists for FSLMC bus */
  64 TAILQ_HEAD(rte_fslmc_device_list, rte_dpaa2_device);
  65 TAILQ_HEAD(rte_fslmc_driver_list, rte_dpaa2_driver);
  66
  67 extern struct rte_fslmc_bus rte_fslmc_bus;
  68
  69 enum rte_dpaa2_dev_type {
  70         /* Devices backed by DPDK driver */
  71         DPAA2_ETH,      /**< DPNI type device*/
  72         DPAA2_CRYPTO,   /**< DPSECI type device */
  73         DPAA2_CON,      /**< DPCONC type device */
  74         /* Devices not backed by a DPDK driver: DPIO, DPBP, DPCI, DPMCP */
  75         DPAA2_BPOOL,    /**< DPBP type device */
  76         DPAA2_IO,       /**< DPIO type device */
  77         DPAA2_CI,       /**< DPCI type device */
  78         DPAA2_MPORTAL,  /**< DPMCP type device */
  79         /* Unknown device placeholder */
  80         DPAA2_UNKNOWN
  81 };
  82
  83 /**
  84  * A structure describing a DPAA2 device.
  85  */
  86 struct rte_dpaa2_device {
  87         TAILQ_ENTRY(rte_dpaa2_device) next; /**< Next probed DPAA2 device. */
  88         struct rte_device device;           /**< Inherit core device */
  89         union {
  90                 struct rte_eth_dev *eth_dev;        /**< ethernet device */
  91                 struct rte_cryptodev *cryptodev;    /**< Crypto Device */
  92         };
  93         enum rte_dpaa2_dev_type dev_type;   /**< Device Type */
  94         uint16_t object_id;                 /**< DPAA2 Object ID */
  95         struct rte_intr_handle intr_handle; /**< Interrupt handle */
  96         struct rte_dpaa2_driver *driver;    /**< Associated driver */
  97         char name[FSLMC_OBJECT_MAX_LEN];    /**< DPAA2 Object name*/
  98 };
  99
 100 typedef int (*rte_dpaa2_probe_t)(struct rte_dpaa2_driver *dpaa2_drv,
 101                                  struct rte_dpaa2_device *dpaa2_dev);
 102 typedef int (*rte_dpaa2_remove_t)(struct rte_dpaa2_device *dpaa2_dev);
 103
 104 /**
 105  * A structure describing a DPAA2 driver.
 106  */
 107 struct rte_dpaa2_driver {
 108         TAILQ_ENTRY(rte_dpaa2_driver) next; /**< Next in list. */
 109         struct rte_driver driver;           /**< Inherit core driver. */
 110         struct rte_fslmc_bus *fslmc_bus;    /**< FSLMC bus reference */
 111         uint32_t drv_flags;                 /**< Flags for controlling device.*/
 112         enum rte_dpaa2_dev_type drv_type;   /**< Driver Type */
 113         rte_dpaa2_probe_t probe;
 114         rte_dpaa2_remove_t remove;
 115 };
 116
 117 /*
 118  * FSLMC bus
 119  */
 120 struct rte_fslmc_bus {
 121         struct rte_bus bus;     /**< Generic Bus object */
 122         struct rte_fslmc_device_list device_list;
 123                                 /**< FSLMC DPAA2 Device list */
 124         struct rte_fslmc_driver_list driver_list;
 125                                 /**< FSLMC DPAA2 Driver list */
 126         int device_count;
 127                                 /**< Optional: Count of devices on bus */
 128 };
 129
 130 /**
 131  * Register a DPAA2 driver.
 132  *
 133  * @param driver
 134  *   A pointer to a rte_dpaa2_driver structure describing the driver
 135  *   to be registered.
 136  */
 137 void rte_fslmc_driver_register(struct rte_dpaa2_driver *driver);
 138
 139 /**
 140  * Unregister a DPAA2 driver.
 141  *
 142  * @param driver
 143  *   A pointer to a rte_dpaa2_driver structure describing the driver
 144  *   to be unregistered.
 145  */
 146 void rte_fslmc_driver_unregister(struct rte_dpaa2_driver *driver);
 147
 148 /** Helper for DPAA2 device registration from driver (eth, crypto) instance */
 149 #define RTE_PMD_REGISTER_DPAA2(nm, dpaa2_drv) \
 150 RTE_INIT(dpaa2initfn_ ##nm); \
 151 static void dpaa2initfn_ ##nm(void) \
 152 {\
 153         (dpaa2_drv).driver.name = RTE_STR(nm);\
 154         rte_fslmc_driver_register(&dpaa2_drv); \
 155 } \
 156 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 157
 158 #ifdef __cplusplus
 159 }
 160 #endif
 161
 162 #endif /* _RTE_FSLMC_H_ */