bus/fslmc: mark internal symbols
[dpdk.git] / drivers / bus / fslmc / rte_fslmc.h
index e60d6eb..5078b48 100644 (file)
@@ -1,33 +1,7 @@
-/*-
- *   BSD LICENSE
+/* SPDX-License-Identifier: BSD-3-Clause
  *
- *   Copyright 2016 NXP.
+ *   Copyright 2016,2019 NXP
  *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of NXP nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef _RTE_FSLMC_H_
@@ -50,11 +24,25 @@ extern "C" {
 #include <sys/queue.h>
 #include <stdint.h>
 #include <inttypes.h>
+#include <linux/vfio.h>
 
 #include <rte_debug.h>
 #include <rte_interrupts.h>
 #include <rte_dev.h>
 #include <rte_bus.h>
+#include <rte_tailq.h>
+#include <rte_devargs.h>
+
+#include <fslmc_vfio.h>
+
+#define FSLMC_OBJECT_MAX_LEN 32   /**< Length of each device on bus */
+
+
+/** Device driver supports link state interrupt */
+#define RTE_DPAA2_DRV_INTR_LSC 0x0008
+
+/** Device driver supports IOVA as VA */
+#define RTE_DPAA2_DRV_IOVA_AS_VA 0X0040
 
 struct rte_dpaa2_driver;
 
@@ -62,8 +50,45 @@ struct rte_dpaa2_driver;
 TAILQ_HEAD(rte_fslmc_device_list, rte_dpaa2_device);
 TAILQ_HEAD(rte_fslmc_driver_list, rte_dpaa2_driver);
 
+#define RTE_DEV_TO_FSLMC_CONST(ptr) \
+       container_of(ptr, const struct rte_dpaa2_device, device)
+
 extern struct rte_fslmc_bus rte_fslmc_bus;
 
+enum rte_dpaa2_dev_type {
+       /* Devices backed by DPDK driver */
+       DPAA2_ETH,      /**< DPNI type device*/
+       DPAA2_CRYPTO,   /**< DPSECI type device */
+       DPAA2_CON,      /**< DPCONC type device */
+       /* Devices not backed by a DPDK driver: DPIO, DPBP, DPCI, DPMCP */
+       DPAA2_BPOOL,    /**< DPBP type device */
+       DPAA2_IO,       /**< DPIO type device */
+       DPAA2_CI,       /**< DPCI type device */
+       DPAA2_MPORTAL,  /**< DPMCP type device */
+       DPAA2_QDMA,     /**< DPDMAI type device */
+       DPAA2_MUX,      /**< DPDMUX type device */
+       DPAA2_DPRTC,    /**< DPRTC type device */
+       /* Unknown device placeholder */
+       DPAA2_UNKNOWN,
+       DPAA2_DEVTYPE_MAX,
+};
+
+TAILQ_HEAD(rte_dpaa2_object_list, rte_dpaa2_object);
+
+typedef int (*rte_dpaa2_obj_create_t)(int vdev_fd,
+                                     struct vfio_device_info *obj_info,
+                                     int object_id);
+
+/**
+ * A structure describing a DPAA2 object.
+ */
+struct rte_dpaa2_object {
+       TAILQ_ENTRY(rte_dpaa2_object) next; /**< Next in list. */
+       const char *name;                   /**< Name of Object. */
+       enum rte_dpaa2_dev_type dev_type;   /**< Type of device */
+       rte_dpaa2_obj_create_t create;
+};
+
 /**
  * A structure describing a DPAA2 device.
  */
@@ -73,12 +98,13 @@ struct rte_dpaa2_device {
        union {
                struct rte_eth_dev *eth_dev;        /**< ethernet device */
                struct rte_cryptodev *cryptodev;    /**< Crypto Device */
+               struct rte_rawdev *rawdev;          /**< Raw Device */
        };
-       uint16_t dev_type;                  /**< Device Type */
-       uint16_t object_id;             /**< DPAA2 Object ID */
+       enum rte_dpaa2_dev_type dev_type;   /**< Device Type */
+       uint16_t object_id;                 /**< DPAA2 Object ID */
        struct rte_intr_handle intr_handle; /**< Interrupt handle */
        struct rte_dpaa2_driver *driver;    /**< Associated driver */
-       char name[32];          /**< DPAA2 Object name*/
+       char name[FSLMC_OBJECT_MAX_LEN];    /**< DPAA2 Object name*/
 };
 
 typedef int (*rte_dpaa2_probe_t)(struct rte_dpaa2_driver *dpaa2_drv,
@@ -93,7 +119,7 @@ struct rte_dpaa2_driver {
        struct rte_driver driver;           /**< Inherit core driver. */
        struct rte_fslmc_bus *fslmc_bus;    /**< FSLMC bus reference */
        uint32_t drv_flags;                 /**< Flags for controlling device.*/
-       uint16_t drv_type;                  /**< Driver Type */
+       enum rte_dpaa2_dev_type drv_type;   /**< Driver Type */
        rte_dpaa2_probe_t probe;
        rte_dpaa2_remove_t remove;
 };
@@ -107,10 +133,28 @@ struct rte_fslmc_bus {
                                /**< FSLMC DPAA2 Device list */
        struct rte_fslmc_driver_list driver_list;
                                /**< FSLMC DPAA2 Driver list */
-       int device_count;
-                               /**< Optional: Count of devices on bus */
+       int device_count[DPAA2_DEVTYPE_MAX];
+                               /**< Count of all devices scanned */
+};
+
+#define DPAA2_PORTAL_DEQUEUE_DEPTH     32
+
+/* Create storage for dqrr entries per lcore */
+struct dpaa2_portal_dqrr {
+       struct rte_mbuf *mbuf[DPAA2_PORTAL_DEQUEUE_DEPTH];
+       uint64_t dqrr_held;
+       uint8_t dqrr_size;
 };
 
+RTE_DECLARE_PER_LCORE(struct dpaa2_portal_dqrr, dpaa2_held_bufs);
+
+#define DPAA2_PER_LCORE_DQRR_SIZE \
+       RTE_PER_LCORE(dpaa2_held_bufs).dqrr_size
+#define DPAA2_PER_LCORE_DQRR_HELD \
+       RTE_PER_LCORE(dpaa2_held_bufs).dqrr_held
+#define DPAA2_PER_LCORE_DQRR_MBUF(i) \
+       RTE_PER_LCORE(dpaa2_held_bufs).mbuf[i]
+
 /**
  * Register a DPAA2 driver.
  *
@@ -118,6 +162,7 @@ struct rte_fslmc_bus {
  *   A pointer to a rte_dpaa2_driver structure describing the driver
  *   to be registered.
  */
+__rte_internal
 void rte_fslmc_driver_register(struct rte_dpaa2_driver *driver);
 
 /**
@@ -127,18 +172,49 @@ void rte_fslmc_driver_register(struct rte_dpaa2_driver *driver);
  *   A pointer to a rte_dpaa2_driver structure describing the driver
  *   to be unregistered.
  */
+__rte_internal
 void rte_fslmc_driver_unregister(struct rte_dpaa2_driver *driver);
 
 /** Helper for DPAA2 device registration from driver (eth, crypto) instance */
 #define RTE_PMD_REGISTER_DPAA2(nm, dpaa2_drv) \
-RTE_INIT(dpaa2initfn_ ##nm); \
-static void dpaa2initfn_ ##nm(void) \
+RTE_INIT(dpaa2initfn_ ##nm) \
 {\
        (dpaa2_drv).driver.name = RTE_STR(nm);\
        rte_fslmc_driver_register(&dpaa2_drv); \
 } \
 RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
 
+/**
+ * Register a DPAA2 MC Object driver.
+ *
+ * @param mc_object
+ *   A pointer to a rte_dpaa_object structure describing the mc object
+ *   to be registered.
+ */
+__rte_internal
+void rte_fslmc_object_register(struct rte_dpaa2_object *object);
+
+/**
+ * Count of a particular type of DPAA2 device scanned on the bus.
+ *
+ * @param dev_type
+ *   Type of device as rte_dpaa2_dev_type enumerator
+ * @return
+ *   >=0 for count; 0 indicates either no device of the said type scanned or
+ *   invalid device type.
+ */
+__rte_internal
+uint32_t rte_fslmc_get_device_count(enum rte_dpaa2_dev_type device_type);
+
+/** Helper for DPAA2 object registration */
+#define RTE_PMD_REGISTER_DPAA2_OBJECT(nm, dpaa2_obj) \
+RTE_INIT(dpaa2objinitfn_ ##nm) \
+{\
+       (dpaa2_obj).name = RTE_STR(nm);\
+       rte_fslmc_object_register(&dpaa2_obj); \
+} \
+RTE_PMD_EXPORT_NAME(nm, __COUNTER__)
+
 #ifdef __cplusplus
 }
 #endif