drivers/bus/fslmc/rte_fslmc.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) 2016 NXP. All rights reserved.
   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 /** Name of FSLMC Bus */
  60 #define FSLMC_BUS_NAME "FSLMC"
  61
  62 struct rte_dpaa2_driver;
  63
  64 /* DPAA2 Device and Driver lists for FSLMC bus */
  65 TAILQ_HEAD(rte_fslmc_device_list, rte_dpaa2_device);
  66 TAILQ_HEAD(rte_fslmc_driver_list, rte_dpaa2_driver);
  67
  68 extern struct rte_fslmc_bus rte_fslmc_bus;
  69
  70 /**
  71  * A structure describing a DPAA2 device.
  72  */
  73 struct rte_dpaa2_device {
  74         TAILQ_ENTRY(rte_dpaa2_device) next; /**< Next probed DPAA2 device. */
  75         struct rte_device device;           /**< Inherit core device */
  76         union {
  77                 struct rte_eth_dev *eth_dev;        /**< ethernet device */
  78                 struct rte_cryptodev *cryptodev;    /**< Crypto Device */
  79         };
  80         uint16_t dev_type;                  /**< Device Type */
  81         uint16_t object_id;             /**< DPAA2 Object ID */
  82         struct rte_intr_handle intr_handle; /**< Interrupt handle */
  83         struct rte_dpaa2_driver *driver;    /**< Associated driver */
  84 };
  85
  86 typedef int (*rte_dpaa2_probe_t)(struct rte_dpaa2_driver *dpaa2_drv,
  87                                  struct rte_dpaa2_device *dpaa2_dev);
  88 typedef int (*rte_dpaa2_remove_t)(struct rte_dpaa2_device *dpaa2_dev);
  89
  90 /**
  91  * A structure describing a DPAA2 driver.
  92  */
  93 struct rte_dpaa2_driver {
  94         TAILQ_ENTRY(rte_dpaa2_driver) next; /**< Next in list. */
  95         struct rte_driver driver;           /**< Inherit core driver. */
  96         struct rte_fslmc_bus *fslmc_bus;    /**< FSLMC bus reference */
  97         uint32_t drv_flags;                 /**< Flags for controlling device.*/
  98         uint16_t drv_type;                  /**< Driver Type */
  99         rte_dpaa2_probe_t probe;
 100         rte_dpaa2_remove_t remove;
 101 };
 102
 103 /*
 104  * FSLMC bus
 105  */
 106 struct rte_fslmc_bus {
 107         struct rte_bus bus;     /**< Generic Bus object */
 108         struct rte_fslmc_device_list device_list;
 109                                 /**< FSLMC DPAA2 Device list */
 110         struct rte_fslmc_driver_list driver_list;
 111                                 /**< FSLMC DPAA2 Driver list */
 112         int device_count;
 113                                 /**< Optional: Count of devices on bus */
 114 };
 115
 116 /**
 117  * Register a DPAA2 driver.
 118  *
 119  * @param driver
 120  *   A pointer to a rte_dpaa2_driver structure describing the driver
 121  *   to be registered.
 122  */
 123 void rte_fslmc_driver_register(struct rte_dpaa2_driver *driver);
 124
 125 /**
 126  * Unregister a DPAA2 driver.
 127  *
 128  * @param driver
 129  *   A pointer to a rte_dpaa2_driver structure describing the driver
 130  *   to be unregistered.
 131  */
 132 void rte_fslmc_driver_unregister(struct rte_dpaa2_driver *driver);
 133
 134 /** Helper for DPAA2 device registration from driver (eth, crypto) instance */
 135 #define RTE_PMD_REGISTER_DPAA2(nm, dpaa2_drv) \
 136 RTE_INIT(dpaa2initfn_ ##nm); \
 137 static void dpaa2initfn_ ##nm(void) \
 138 {\
 139         (dpaa2_drv).driver.name = RTE_STR(nm);\
 140         rte_fslmc_driver_register(&dpaa2_drv); \
 141 } \
 142 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 143
 144 #ifdef __cplusplus
 145 }
 146 #endif
 147
 148 #endif /* _RTE_FSLMC_H_ */