From 8bfc4a2b4d3f0100a5c12074c4ac5b0974ce3573 Mon Sep 17 00:00:00 2001 From: Jasvinder Singh Date: Tue, 17 Jul 2018 19:32:55 +0100 Subject: [PATCH] ethdev: improve description for port name API Improve description of api used to get port name from port id or vice-versa. Signed-off-by: Jasvinder Singh Reviewed-by: Ferruh Yigit --- lib/librte_ethdev/rte_ethdev.h | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h index e3d8182b94..b74d597714 100644 --- a/lib/librte_ethdev/rte_ethdev.h +++ b/lib/librte_ethdev/rte_ethdev.h @@ -3629,11 +3629,11 @@ rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id, uint8_t en); /** -* Get the port id from pci address or device name -* Example: -* - PCIe, 0000:2:00.0 -* - SoC, fsl-gmac0 -* - vdev, net_pcap0 +* Get the port id from device name. The device name should be specified +* as below: +* - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0 +* - SoC device name, for example- fsl-gmac0 +* - vdev dpdk name, for example- net_[pcap0|null0|tap0] * * @param name * pci address or name of the device @@ -3647,11 +3647,10 @@ int rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id); /** -* Get the device name from port id -* Example: -* - PCIe Bus:Domain:Function, 0000:02:00.0 -* - SoC device name, fsl-gmac0 -* - vdev dpdk name, net_[pcap0|null0|tun0|tap0] +* Get the device name from port id. The device name is specified as below: +* - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0 +* - SoC device name, for example- fsl-gmac0 +* - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0] * * @param port_id * Port identifier of the device. -- 2.20.1