From patchwork Thu May 17 10:59:02 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Varghese, Vipin" X-Patchwork-Id: 40143 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id DE2514C79; Thu, 17 May 2018 12:59:10 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 83CBA2BAE for ; Thu, 17 May 2018 12:59:09 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 17 May 2018 03:59:08 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.49,410,1520924400"; d="scan'208";a="47260869" Received: from unknown (HELO saesrv02-S2600CWR.intel.com) ([10.224.122.203]) by fmsmga002.fm.intel.com with ESMTP; 17 May 2018 03:59:06 -0700 From: Vipin Varghese To: dev@dpdk.org, john.mcnamara@intel.com, lee.daly@intel.com, deepak.k.jain@intel.com Cc: Vipin Varghese Date: Thu, 17 May 2018 16:29:02 +0530 Message-Id: <1526554742-117308-1-git-send-email-vipin.varghese@intel.com> X-Mailer: git-send-email 2.7.4 Subject: [dpdk-dev] [PATCH] ethdev: update description for functions X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 * * @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: +* - PCIe Bus:Domian:Function, 0000:02:00.0 +* - SoC device name, fslgmac0 +* - VDEV driver name, net_pcap0, net_null0, net_tun0 or net_tap0 * * @param port_id * Port identifier of the device.