From patchwork Fri Jun 30 16:51:24 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ferruh Yigit X-Patchwork-Id: 26119 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id EBD6A7CB4; Fri, 30 Jun 2017 18:52:24 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 619C3235 for ; Fri, 30 Jun 2017 18:52:03 +0200 (CEST) Received: from orsmga004.jf.intel.com ([10.7.209.38]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 30 Jun 2017 09:51:58 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.40,287,1496127600"; d="scan'208";a="103233209" Received: from silpixa00372839.ir.intel.com (HELO silpixa00372839.ger.corp.intel.com) ([10.237.222.154]) by orsmga004.jf.intel.com with ESMTP; 30 Jun 2017 09:51:48 -0700 From: Ferruh Yigit To: dev@dpdk.org Cc: Ferruh Yigit , Stephen Hemminger , Bruce Richardson , Anatoly Burakov Date: Fri, 30 Jun 2017 17:51:24 +0100 Message-Id: <20170630165140.59594-5-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.13.0 In-Reply-To: <20170630165140.59594-1-ferruh.yigit@intel.com> References: <20170621110651.75299-1-ferruh.yigit@intel.com> <20170630165140.59594-1-ferruh.yigit@intel.com> Subject: [dpdk-dev] [PATCH v9 04/20] ethtool: update header doxygen syntax 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" Minor corrections and doxygen syntax fixes on library header file. Signed-off-by: Ferruh Yigit --- lib/librte_ethtool/rte_ethtool.h | 57 +++++++++++++++++++++------------------- 1 file changed, 30 insertions(+), 27 deletions(-) diff --git a/lib/librte_ethtool/rte_ethtool.h b/lib/librte_ethtool/rte_ethtool.h index 18f44404b..bcf20870c 100644 --- a/lib/librte_ethtool/rte_ethtool.h +++ b/lib/librte_ethtool/rte_ethtool.h @@ -34,11 +34,13 @@ #ifndef _RTE_ETHTOOL_H_ #define _RTE_ETHTOOL_H_ -/* +/** + * @file + * * This new interface is designed to provide a user-space shim layer for * Ethtool and Netdevice op API. * - * rte_ethtool_get_driver: ethtool_ops::get_driverinfo + * rte_ethtool_get_drvinfo: ethtool_ops::get_driverinfo * rte_ethtool_get_link: ethtool_ops::get_link * rte_ethtool_get_regs_len: ethtool_ops::get_regs_len * rte_ethtool_get_regs: ethtool_ops::get_regs @@ -47,6 +49,8 @@ * rte_ethtool_set_eeprom: ethtool_ops::set_eeprom * rte_ethtool_get_pauseparam: ethtool_ops::get_pauseparam * rte_ethtool_set_pauseparam: ethtool_ops::set_pauseparam + * rte_ethtool_get_ringparam: ethtool_ops::set_ringparam + * rte_ethtool_set_ringparam: ethtool_ops::set_ringparam * * rte_ethtool_net_open: net_device_ops::ndo_open * rte_ethtool_net_stop: net_device_ops::ndo_stop @@ -101,7 +105,7 @@ int rte_ethtool_get_regs_len(uint8_t port_id); * * @param port_id * The port identifier of the Ethernet device. - * @param reg + * @param regs * A pointer to ethtool_regs that has register information * @param data * A pointer to a buffer that is used to retrieve device register content @@ -112,7 +116,7 @@ int rte_ethtool_get_regs_len(uint8_t port_id); * - others depends on the specific operations implementation. */ int rte_ethtool_get_regs(uint8_t port_id, struct ethtool_regs *regs, - void *data); + void *data); /** * Retrieve the Ethernet device link status @@ -135,7 +139,7 @@ int rte_ethtool_get_link(uint8_t port_id); * @param port_id * The port identifier of the Ethernet device. * @return - * - (> 0) device EEPROM size in bytes + * - (> 0) device EEPROM size in bytes * - (0) device has NO EEPROM * - (-ENOTSUP) if hardware doesn't support. * - (-ENODEV) if *port_id* invalid. @@ -150,9 +154,9 @@ int rte_ethtool_get_eeprom_len(uint8_t port_id); * @param port_id * The port identifier of the Ethernet device. * @param eeprom - * The pointer of ethtool_eeprom that provides eeprom range + * The pointer of ethtool_eeprom that provides eeprom range * @param words - * A buffer that holds data read from eeprom + * A buffer that holds data read from eeprom * @return * - (0) if successful. * - (-ENOTSUP) if hardware doesn't support. @@ -160,7 +164,7 @@ int rte_ethtool_get_eeprom_len(uint8_t port_id); * - others depends on the specific operations implementation. */ int rte_ethtool_get_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom, - void *words); + void *words); /** * Setting EEPROM content based upon eeprom range described in ethtool @@ -169,9 +173,9 @@ int rte_ethtool_get_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom, * @param port_id * The port identifier of the Ethernet device. * @param eeprom - * The pointer of ethtool_eeprom that provides eeprom range + * The pointer of ethtool_eeprom that provides eeprom range * @param words - * A buffer that holds data to be written into eeprom + * A buffer that holds data to be written into eeprom * @return * - (0) if successful. * - (-ENOTSUP) if hardware doesn't support. @@ -180,7 +184,7 @@ int rte_ethtool_get_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom, * - others depends on the specific operations implementation. */ int rte_ethtool_set_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom, - void *words); + void *words); /** * Retrieve the Ethernet device pause frame configuration according to @@ -190,8 +194,8 @@ int rte_ethtool_set_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom, * @param port_id * The port identifier of the Ethernet device. * @param pause_param - * The pointer of ethtool_coalesce that gets pause frame - * configuration parameters + * The pointer of ethtool_coalesce that gets pause frame + * configuration parameters * @return * - (0) if successful. * - (-ENOTSUP) if hardware doesn't support. @@ -200,7 +204,7 @@ int rte_ethtool_set_eeprom(uint8_t port_id, struct ethtool_eeprom *eeprom, * - others depends on the specific operations implementation. */ int rte_ethtool_get_pauseparam(uint8_t port_id, - struct ethtool_pauseparam *pause_param); + struct ethtool_pauseparam *pause_param); /** * Setting the Ethernet device pause frame configuration according to @@ -208,8 +212,8 @@ int rte_ethtool_get_pauseparam(uint8_t port_id, * * @param port_id * The port identifier of the Ethernet device. - * @param pause_param - * The pointer of ethtool_coalesce that gets ring configuration parameters + * @param param + * The pointer of ethtool_coalesce that gets ring configuration parameters * @return * - (0) if successful. * - (-ENOTSUP) if hardware doesn't support. @@ -218,7 +222,7 @@ int rte_ethtool_get_pauseparam(uint8_t port_id, * - others depends on the specific operations implementation. */ int rte_ethtool_set_pauseparam(uint8_t port_id, - struct ethtool_pauseparam *param); + struct ethtool_pauseparam *param); /** * Start the Ethernet device. @@ -250,7 +254,7 @@ int rte_ethtool_net_stop(uint8_t port_id); * @param port_id * The port identifier of the Ethernet device. * @param addr - * MAC address of the Ethernet device. + * MAC address of the Ethernet device. * @return * - (0) if successful. * - (-ENODEV) if *port_id* invalid. @@ -263,7 +267,7 @@ int rte_ethtool_net_get_mac_addr(uint8_t port_id, struct ether_addr *addr); * @param port_id * The port identifier of the Ethernet device. * @param addr - * The new MAC addr. + * The new MAC addr. * @return * - (0) if successful. * - (-ENOTSUP) if hardware doesn't support. @@ -279,7 +283,7 @@ int rte_ethtool_net_set_mac_addr(uint8_t port_id, struct ether_addr *addr); * @param port_id * The port identifier of the Ethernet device. * @param addr - * A pointer to a buffer (6-byte, 48bit) for the target MAC address + * A pointer to a buffer (6-byte, 48bit) for the target MAC address * @return * - (0) if successful. * - (-ENOTSUP) if hardware doesn't support. @@ -295,7 +299,7 @@ int rte_ethtool_net_validate_addr(uint8_t port_id, struct ether_addr *addr); * @param port_id * The port identifier of the Ethernet device. * @param mtu - * New MTU + * New MTU * @return * - (0) if successful. * - (-ENOTSUP) if hardware doesn't support. @@ -311,7 +315,7 @@ int rte_ethtool_net_change_mtu(uint8_t port_id, int mtu); * @param port_id * The port identifier of the Ethernet device. * @param stats - * A pointer to struct rte_eth_stats for statistics parameters + * A pointer to struct rte_eth_stats for statistics parameters * @return * - (0) if successful. * - (-ENOTSUP) if hardware doesn't support. @@ -327,7 +331,7 @@ int rte_ethtool_net_get_stats64(uint8_t port_id, struct rte_eth_stats *stats); * @param port_id * The port identifier of the Ethernet device. * @param vid - * A new VLAN id + * A new VLAN id * @return * - (0) if successful. * - (-ENOTSUP) if hardware doesn't support. @@ -342,7 +346,7 @@ int rte_ethtool_net_vlan_rx_add_vid(uint8_t port_id, uint16_t vid); * @param port_id * The port identifier of the Ethernet device. * @param vid - * A new VLAN id + * A new VLAN id * @return * - (0) if successful. * - (-ENOTSUP) if hardware doesn't support. @@ -381,7 +385,7 @@ int rte_ethtool_net_set_rx_mode(uint8_t port_id); * are used, and the function only gets parameters for queue 0. */ int rte_ethtool_get_ringparam(uint8_t port_id, - struct ethtool_ringparam *ring_param); + struct ethtool_ringparam *ring_param); /** * Setting ring parameters for Ethernet device. @@ -400,8 +404,7 @@ int rte_ethtool_get_ringparam(uint8_t port_id, * are used, and the function only sets parameters for queue 0. */ int rte_ethtool_set_ringparam(uint8_t port_id, - struct ethtool_ringparam *ring_param); - + struct ethtool_ringparam *ring_param); #ifdef __cplusplus }