From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ferruh Yigit Subject: Re: [PATCH] ethdev: update description for functions Date: Thu, 17 May 2018 13:32:44 +0100 Message-ID: References: <1526554742-117308-1-git-send-email-vipin.varghese@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit To: Vipin Varghese , dev@dpdk.org, john.mcnamara@intel.com, lee.daly@intel.com, deepak.k.jain@intel.com Return-path: Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 09AAB37A0 for ; Thu, 17 May 2018 14:32:48 +0200 (CEST) In-Reply-To: <1526554742-117308-1-git-send-email-vipin.varghese@intel.com> Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On 5/17/2018 11:59 AM, Vipin Varghese wrote: > 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 > --- > 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 f8815e9..7387686 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 > +* Ex: > +* - PCIe, 0000:2:00.0 > +* - SoC, fslgmac0 > +* - vdev driver name, net_pcap0 driver name is "net_pcap", device name is "net_pcap0". Original "vdev name" seems more accurate, is there a reason to change it to "driver name"? > * > * @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 > +* Ex: What do you think say "Ex device name:" here and remove "device name" from below: PCIe, 0000:02:00.0 SoC, fslgmac0 vdev, net_pcap0, net_null0, net_tun0 or net_tap0, ... > +* - PCIe Bus:Domian:Function, 0000:02:00.0 > +* - SoC device name, fslgmac0 > +* - VDEV driver name, net_pcap0, net_null0, net_tun0 or net_tap0 Why VDEV capitalized? > * > * @param port_id > * Port identifier of the device. >