From 954b68224febbdd41de1f772de649757f8edafea Mon Sep 17 00:00:00 2001 From: Vipin Varghese Date: Fri, 18 May 2018 10:42:53 +0530 Subject: [PATCH] ethdev: update description of port name Change adds extra information on name parameter for API rte_eth_dev_get_name_by_port and rte_eth_dev_get_port_by_name. Signed-off-by: Vipin Varghese Reviewed-by: Ferruh Yigit --- lib/librte_ethdev/rte_ethdev.h | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h index 584af85ad0..36e3984eac 100644 --- a/lib/librte_ethdev/rte_ethdev.h +++ b/lib/librte_ethdev/rte_ethdev.h @@ -3657,7 +3657,10 @@ rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id, /** * Get the port id from pci address or device name -* Ex: 0000:2:00.0 or vdev name net_pcap0 +* Example: +* - PCIe, 0000:2:00.0 +* - SoC, fsl-gmac0 +* - vdev, net_pcap0 * * @param name * pci address or name of the device @@ -3672,6 +3675,10 @@ 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] * * @param port_id * Port identifier of the device. -- 2.20.1