devargs: restore device type API
[dpdk.git] / lib / librte_eal / common / include / rte_dev.h
index d18e6b8..5386d3a 100644 (file)
@@ -115,48 +115,33 @@ rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
 } while (0)
 
 /**
- * A generic memory resource representation.
+ * Device driver.
  */
-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. */
+enum rte_kernel_driver {
+       RTE_KDRV_UNKNOWN = 0,
+       RTE_KDRV_IGB_UIO,
+       RTE_KDRV_VFIO,
+       RTE_KDRV_UIO_GENERIC,
+       RTE_KDRV_NIC_UIO,
+       RTE_KDRV_NONE,
 };
 
-/** 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;
-
 /**
- * A structure describing a generic device.
+ * Device policies.
  */
-struct rte_device {
-       TAILQ_ENTRY(rte_device) next; /**< Next device */
-       const char *name;             /**< Device name */
-       const struct rte_driver *driver;/**< Associated driver */
-       int numa_node;                /**< NUMA node connection */
-       struct rte_devargs *devargs;  /**< Device user arguments */
+enum rte_dev_policy {
+       RTE_DEV_WHITELISTED,
+       RTE_DEV_BLACKLISTED,
 };
 
 /**
- * Insert a device detected by a bus scanning.
- *
- * @param dev
- *   A pointer to a rte_device structure describing the detected device.
- */
-void rte_eal_device_insert(struct rte_device *dev);
-
-/**
- * Remove a device (e.g. when being unplugged).
- *
- * @param dev
- *   A pointer to a rte_device structure describing the device to be removed.
+ * A generic memory resource representation.
  */
-void rte_eal_device_remove(struct rte_device *dev);
+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. */
+};
 
 /**
  * A structure describing a device driver.
@@ -167,23 +152,18 @@ struct rte_driver {
        const char *alias;              /**< Driver alias. */
 };
 
-/**
- * Register a device driver.
- *
- * @param driver
- *   A pointer to a rte_dev structure describing the driver
- *   to be registered.
- */
-void rte_eal_driver_register(struct rte_driver *driver);
+#define RTE_DEV_NAME_MAX_LEN (32)
 
 /**
- * Unregister a device driver.
- *
- * @param driver
- *   A pointer to a rte_dev structure describing the driver
- *   to be unregistered.
+ * A structure describing a generic device.
  */
-void rte_eal_driver_unregister(struct rte_driver *driver);
+struct rte_device {
+       TAILQ_ENTRY(rte_device) next; /**< Next device */
+       const char *name;             /**< Device name */
+       const struct rte_driver *driver;/**< Associated driver */
+       int numa_node;                /**< NUMA node connection */
+       struct rte_devargs *devargs;  /**< Device user arguments */
+};
 
 /**
  * Initialize a driver specified by name.
@@ -195,7 +175,7 @@ void rte_eal_driver_unregister(struct rte_driver *driver);
  * @return
  *  0 on success, negative on error
  */
-int rte_eal_vdev_init(const char *name, const char *args);
+int rte_vdev_init(const char *name, const char *args);
 
 /**
  * Uninitalize a driver specified by name.
@@ -205,7 +185,7 @@ int rte_eal_vdev_init(const char *name, const char *args);
  * @return
  *  0 on success, negative on error
  */
-int rte_eal_vdev_uninit(const char *name);
+int rte_vdev_uninit(const char *name);
 
 /**
  * Attach a device to a registered driver.
@@ -225,13 +205,67 @@ 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.
+ * @param dev
+ *   A pointer to a rte_device structure.
+ * @return
+ *   0 on success, negative on error.
+ */
+int rte_eal_dev_detach(struct rte_device *dev);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
+ * Hotplug add a given device to a specific bus.
+ *
+ * @param busname
+ *   The bus name the device is added to.
+ * @param devname
+ *   The device name. 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_detach(const char *name);
+int rte_eal_hotplug_add(const char *busname, const char *devname,
+                       const char *devargs);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
+ * Hotplug remove a given device from a specific bus.
+ *
+ * @param busname
+ *   The bus name the device is removed from.
+ * @param devname
+ *   The device name being removed.
+ * @return
+ *   0 on success, negative on error.
+ */
+int rte_eal_hotplug_remove(const char *busname, const char *devname);
+
+/**
+ * Device comparison function.
+ *
+ * This type of function is used to compare an rte_device with arbitrary
+ * data.
+ *
+ * @param dev
+ *   Device handle.
+ *
+ * @param data
+ *   Data to compare against. The type of this parameter is determined by
+ *   the kind of comparison performed by the function.
+ *
+ * @return
+ *   0 if the device matches the data.
+ *   !0 if the device does not match.
+ *   <0 if ordering is possible and the device is lower than the data.
+ *   >0 if ordering is possible and the device is greater than the data.
+ */
+typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);
 
 #define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]