summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGaetan Rivet <gaetan.rivet@6wind.com>2018-04-24 01:54:50 +0200
committerThomas Monjalon <thomas@monjalon.net>2018-04-25 03:58:49 +0200
commitb629ab790c5cab7ee2879feb7d117b42cbeb9bf1 (patch)
treec1c44b6808ee4f3247f80c6fbc35da165ad62116
parent9e6b5ea9925a204965b859f1cc11641df03232af (diff)
downloaddpdk-b629ab790c5cab7ee2879feb7d117b42cbeb9bf1.zip
dpdk-b629ab790c5cab7ee2879feb7d117b42cbeb9bf1.tar.gz
dpdk-b629ab790c5cab7ee2879feb7d117b42cbeb9bf1.tar.xz
devargs: update syntax documentation
Device syntax documentation is out of date. Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com> Acked-by: Thomas Monjalon <thomas@monjalon.net>
-rw-r--r--lib/librte_eal/common/include/rte_devargs.h26
1 files changed, 16 insertions, 10 deletions
diff --git a/lib/librte_eal/common/include/rte_devargs.h b/lib/librte_eal/common/include/rte_devargs.h
index eff7a3f..bfe4da4 100644
--- a/lib/librte_eal/common/include/rte_devargs.h
+++ b/lib/librte_eal/common/include/rte_devargs.h
@@ -96,6 +96,21 @@ int rte_eal_parse_devargs_str(const char *devargs_str,
*
* The device string is built with a printf-like syntax.
*
+ * The syntax is:
+ *
+ * bus:device_identifier,arg1=val1,arg2=val2
+ *
+ * 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 format
@@ -125,16 +140,7 @@ rte_eal_devargs_insert(struct rte_devargs *da);
/**
* Add a device to the user device list
- *
- * 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".
- *
- * 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 validity of the
- * driver name is not checked by this function, it is done when probing
- * the drivers.
+ * See rte_eal_devargs_parse() for details.
*
* @param devtype
* The type of the device.