eal: simplify meson build of common directory
[dpdk.git] / lib / librte_eal / common / include / rte_devargs.h
index 58fbd90..898efa0 100644 (file)
@@ -51,43 +51,55 @@ struct rte_devargs {
        enum rte_devtype type;
        /** Device policy. */
        enum rte_dev_policy policy;
-       /** Bus handle for the device. */
-       struct rte_bus *bus;
        /** Name of the device. */
        char name[RTE_DEV_NAME_MAX_LEN];
+       RTE_STD_C11
+       union {
        /** Arguments string as given by user or "" for no argument. */
-       char *args;
+               char *args;
+               const char *drv_str;
+       };
+       struct rte_bus *bus; /**< bus handle. */
+       struct rte_class *cls; /**< class handle. */
+       const char *bus_str; /**< bus-related part of device string. */
+       const char *cls_str; /**< class-related part of device string. */
+       const char *data; /**< Device string storage. */
 };
 
 /**
- * @deprecated
- * Parse a devargs string.
+ * Parse a device string.
  *
- * For PCI devices, the format of arguments string is "PCI_ADDR" or
- * "PCI_ADDR,key=val,key2=val2,...". Examples: "08:00.1", "0000:5:00.0",
- * "04:00.0,arg=val".
+ * Verify that a bus is capable of handling the device passed
+ * in argument. Store which bus will handle the device, its name
+ * and the eventual device parameters.
  *
- * For virtual devices, the format of arguments string is "DRIVER_NAME*"
- * or "DRIVER_NAME*,key=val,key2=val2,...". Examples: "net_ring",
- * "net_ring0", "net_pmdAnything,arg=0:arg2=1".
+ * The syntax is:
  *
- * The function parses the arguments string to get driver name and driver
- * arguments.
+ *     bus:device_identifier,arg1=val1,arg2=val2
  *
- * @param devargs_str
- *   The arguments as given by the user.
- * @param drvname
- *   The pointer to the string to store parsed driver name.
- * @param drvargs
- *   The pointer to the string to store parsed driver arguments.
+ * where "bus:" is the bus name followed by any character separator.
+ * The bus name is optional. If no bus name is specified, each bus
+ * will attempt to recognize the device identifier. The first one
+ * to succeed will be used.
+ *
+ * Examples:
+ *
+ *     pci:0000:05.00.0,arg=val
+ *     05.00.0,arg=val
+ *     vdev:net_ring0
+ *
+ * @param da
+ *   The devargs structure holding the device information.
+ *
+ * @param dev
+ *   String describing a device.
  *
  * @return
- *   - 0 on success
- *   - A negative value on error
+ *   - 0 on success.
+ *   - Negative errno on error.
  */
-__rte_deprecated
-int rte_eal_parse_devargs_str(const char *devargs_str,
-                               char **drvname, char **drvargs);
+int
+rte_devargs_parse(struct rte_devargs *da, const char *dev);
 
 /**
  * Parse a device string.
@@ -122,25 +134,25 @@ int rte_eal_parse_devargs_str(const char *devargs_str,
  *   - 0 on success.
  *   - Negative errno on error.
  */
-__rte_experimental
 int
-rte_devargs_parse(struct rte_devargs *da,
-                 const char *format, ...)
-__attribute__((format(printf, 2, 0)));
+rte_devargs_parsef(struct rte_devargs *da,
+                  const char *format, ...)
+__rte_format_printf(2, 0);
 
 /**
  * Insert an rte_devargs in the global list.
  *
  * @param da
  *  The devargs structure to insert.
+ *  If a devargs for the same device is already inserted,
+ *  it will be updated and returned. It means *da pointer can change.
  *
  * @return
  *   - 0 on success
  *   - Negative on error.
  */
-__rte_experimental
 int
-rte_devargs_insert(struct rte_devargs *da);
+rte_devargs_insert(struct rte_devargs **da);
 
 /**
  * Add a device to the user device list
@@ -155,45 +167,22 @@ rte_devargs_insert(struct rte_devargs *da);
  *   - 0 on success
  *   - A negative value on error
  */
-__rte_experimental
 int rte_devargs_add(enum rte_devtype devtype, const char *devargs_str);
 
-/**
- * @deprecated
- * Add a device to the user device list
- * See rte_devargs_parse() for details.
- *
- * @param devtype
- *   The type of the device.
- * @param devargs_str
- *   The arguments as given by the user.
- *
- * @return
- *   - 0 on success
- *   - A negative value on error
- */
-__rte_deprecated
-int rte_eal_devargs_add(enum rte_devtype devtype, const char *devargs_str);
-
 /**
  * Remove a device from the user device list.
  * Its resources are freed.
  * If the devargs cannot be found, nothing happens.
  *
- * @param busname
- *   bus name of the devargs to remove.
- *
- * @param devname
- *   device name of the devargs to remove.
+ * @param devargs
+ *   The instance or a copy of devargs to remove.
  *
  * @return
  *   0 on success.
  *   <0 on error.
  *   >0 if the devargs was not within the user device list.
  */
-__rte_experimental
-int rte_devargs_remove(const char *busname,
-                      const char *devname);
+int rte_devargs_remove(struct rte_devargs *devargs);
 
 /**
  * Count the number of user devices of a specified type
@@ -204,43 +193,17 @@ int rte_devargs_remove(const char *busname,
  * @return
  *   The number of devices.
  */
-__rte_experimental
 unsigned int
 rte_devargs_type_count(enum rte_devtype devtype);
 
-/**
- * @deprecated
- * Count the number of user devices of a specified type
- *
- * @param devtype
- *   The type of the devices to counted.
- *
- * @return
- *   The number of devices.
- */
-__rte_deprecated
-unsigned int
-rte_eal_devargs_type_count(enum rte_devtype devtype);
-
 /**
  * This function dumps the list of user device and their arguments.
  *
  * @param f
  *   A pointer to a file for output
  */
-__rte_experimental
 void rte_devargs_dump(FILE *f);
 
-/**
- * @deprecated
- * This function dumps the list of user device and their arguments.
- *
- * @param f
- *   A pointer to a file for output
- */
-__rte_deprecated
-void rte_eal_devargs_dump(FILE *f);
-
 /**
  * Find next rte_devargs matching the provided bus name.
  *
@@ -257,7 +220,6 @@ void rte_eal_devargs_dump(FILE *f);
  *   Next rte_devargs entry matching the requested bus,
  *   NULL if there is none.
  */
-__rte_experimental
 struct rte_devargs *
 rte_devargs_next(const char *busname, const struct rte_devargs *start);