drivers: advertise kmod dependencies in pmdinfo
[dpdk.git] / lib / librte_eal / common / include / rte_dev.h
index f601d21..1708244 100644 (file)
 extern "C" {
 #endif
 
+#include <stdio.h>
 #include <sys/queue.h>
 
+#include <rte_log.h>
+
+__attribute__((format(printf, 2, 0)))
+static inline void
+rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
+{
+       va_list ap;
+
+       va_start(ap, fmt);
+
+       char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];
+
+       va_end(ap);
+
+       va_start(ap, fmt);
+       vsnprintf(buffer, sizeof(buffer), fmt, ap);
+       va_end(ap);
+
+       rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s", func_name, buffer);
+}
+
+/* Macros for checking for restricting functions to primary instance only */
+#define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
+       if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
+               RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
+               return retval; \
+       } \
+} while (0)
+
+#define RTE_PROC_PRIMARY_OR_RET() do { \
+       if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
+               RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
+               return; \
+       } \
+} while (0)
+
+/* Macros to check for invalid function pointers */
+#define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
+       if ((func) == NULL) { \
+               RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
+               return retval; \
+       } \
+} while (0)
+
+#define RTE_FUNC_PTR_OR_RET(func) do { \
+       if ((func) == NULL) { \
+               RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
+               return; \
+       } \
+} while (0)
+
+/**
+ * A generic memory resource representation.
+ */
+struct rte_mem_resource {
+       uint64_t phys_addr; /**< Physical address, 0 if not resource. */
+       uint64_t len;       /**< Length of the resource. */
+       void *addr;         /**< Virtual address, NULL when not mapped. */
+};
+
 /** Double linked list of device drivers. */
 TAILQ_HEAD(rte_driver_list, rte_driver);
+/** Double linked list of devices. */
+TAILQ_HEAD(rte_device_list, rte_device);
+
+/* Forward declaration */
+struct rte_driver;
 
 /**
- * Initialization function called for each device driver once.
+ * A structure describing a generic device.
  */
-typedef int (rte_dev_init_t)(const char *name, const char *args);
+struct rte_device {
+       TAILQ_ENTRY(rte_device) next; /**< Next device */
+       struct rte_driver *driver;    /**< Associated driver */
+       int numa_node;                /**< NUMA node connection */
+       struct rte_devargs *devargs;  /**< Device user arguments */
+};
 
 /**
- * Uninitilization function called for each device driver once.
+ * Insert a device detected by a bus scanning.
+ *
+ * @param dev
+ *   A pointer to a rte_device structure describing the detected device.
  */
-typedef int (rte_dev_uninit_t)(const char *name);
+void rte_eal_device_insert(struct rte_device *dev);
 
 /**
- * Driver type enumeration
+ * Remove a device (e.g. when being unplugged).
+ *
+ * @param dev
+ *   A pointer to a rte_device structure describing the device to be removed.
  */
-enum pmd_type {
-       PMD_VDEV = 0,
-       PMD_PDEV = 1,
-};
+void rte_eal_device_remove(struct rte_device *dev);
 
 /**
  * A structure describing a device driver.
  */
 struct rte_driver {
        TAILQ_ENTRY(rte_driver) next;  /**< Next in list. */
-       enum pmd_type type;                /**< PMD Driver type */
        const char *name;                   /**< Driver name. */
-       rte_dev_init_t *init;              /**< Device init. function. */
-       rte_dev_uninit_t *uninit;          /**< Device uninit. function. */
+       const char *alias;              /**< Driver alias. */
 };
 
 /**
@@ -125,12 +197,72 @@ int rte_eal_vdev_init(const char *name, const char *args);
  */
 int rte_eal_vdev_uninit(const char *name);
 
-#define PMD_REGISTER_DRIVER(d)\
-void devinitfn_ ##d(void);\
-void __attribute__((constructor, used)) devinitfn_ ##d(void)\
-{\
-       rte_eal_driver_register(&d);\
-}
+/**
+ * Attach a device to a registered driver.
+ *
+ * @param name
+ *   The device name, that refers to a pci device (or some private
+ *   way of designating a vdev device). Based on this device name, eal
+ *   will identify a driver capable of handling it and pass it to the
+ *   driver probing function.
+ * @param devargs
+ *   Device arguments to be passed to the driver.
+ * @return
+ *   0 on success, negative on error.
+ */
+int rte_eal_dev_attach(const char *name, const char *devargs);
+
+/**
+ * Detach a device from its driver.
+ *
+ * @param name
+ *   Same description as for rte_eal_dev_attach().
+ *   Here, eal will call the driver detaching function.
+ * @return
+ *   0 on success, negative on error.
+ */
+int rte_eal_dev_detach(const char *name);
+
+#define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]
+
+#define RTE_PMD_EXPORT_NAME(name, idx) \
+static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
+__attribute__((used)) = RTE_STR(name)
+
+#define DRV_EXP_TAG(name, tag) __##name##_##tag
+
+#define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
+static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
+RTE_STR(table)
+
+#define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
+static const char DRV_EXP_TAG(name, param_string_export)[] \
+__attribute__((used)) = str
+
+/**
+ * Advertise the list of kernel modules required to run this driver
+ *
+ * This string lists the kernel modules required for the devices
+ * associated to a PMD. The format of each line of the string is:
+ * "<device-pattern> <kmod-expression>".
+ *
+ * The possible formats for the device pattern are:
+ *   "*"                     all devices supported by this driver
+ *   "pci:*"                 all PCI devices supported by this driver
+ *   "pci:v8086:d*:sv*:sd*"  all PCI devices supported by this driver
+ *                           whose vendor id is 0x8086.
+ *
+ * The format of the kernel modules list is a parenthesed expression
+ * containing logical-and (&) and logical-or (|).
+ *
+ * The device pattern and the kmod expression are separated by a space.
+ *
+ * Example:
+ * - "* igb_uio | uio_pci_generic | vfio"
+ */
+#define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
+static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
+__attribute__((used)) = str
 
 #ifdef __cplusplus
 }