From: Ferruh Yigit <ferruh.yigit@intel.com>
To: dev@dpdk.org
Cc: Ferruh Yigit <ferruh.yigit@intel.com>,
Stephen Hemminger <stephen@networkplumber.org>,
Bruce Richardson <bruce.richardson@intel.com>,
Anatoly Burakov <anatoly.burakov@intel.com>
Subject: [dpdk-dev] [PATCH v9 04/20] ethtool: update header doxygen syntax
Date: Fri, 30 Jun 2017 17:51:24 +0100 [thread overview]
Message-ID: <20170630165140.59594-5-ferruh.yigit@intel.com> (raw)
In-Reply-To: <20170630165140.59594-1-ferruh.yigit@intel.com>
Minor corrections and doxygen syntax fixes on library header file.
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
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
}
--
2.13.0
next prev parent reply other threads:[~2017-06-30 16:52 UTC|newest]
Thread overview: 91+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-26 16:52 [dpdk-dev] [RFC] Kernel Control Path (KCP) Ferruh Yigit
2017-05-28 16:55 ` Wiles, Keith
2017-05-29 9:26 ` Bruce Richardson
2017-05-29 17:29 ` Wiles, Keith
2017-06-16 15:54 ` Ferruh Yigit
2017-06-20 12:33 ` Ferruh Yigit
2017-05-30 10:55 ` Thomas Monjalon
2017-06-13 17:21 ` Ferruh Yigit
2017-06-13 18:00 ` Jay Rolette
2017-06-13 18:04 ` Dumitrescu, Cristian
2017-06-13 18:18 ` Wiles, Keith
2017-06-15 12:07 ` Alex Rosenbaum
2017-06-16 15:27 ` Ferruh Yigit
2017-06-16 16:48 ` Stephen Hemminger
2017-06-13 18:17 ` Wiles, Keith
2017-06-21 11:06 ` [dpdk-dev] [PATCH v8 0/4] Userspace Network Control Interface (UNCI) Ferruh Yigit
2017-06-21 11:06 ` [dpdk-dev] [PATCH v8 1/4] ethtool: move from sample folder to lib folder Ferruh Yigit
2017-06-26 11:02 ` Bruce Richardson
2017-06-21 11:06 ` [dpdk-dev] [PATCH v8 2/4] unci: add kernel control path kernel module Ferruh Yigit
2017-06-21 15:23 ` Stephen Hemminger
2017-06-30 17:02 ` Ferruh Yigit
2017-06-21 11:06 ` [dpdk-dev] [PATCH v8 3/4] rte_ctrl_if: add control interface library Ferruh Yigit
2017-06-26 11:09 ` Bruce Richardson
2017-06-26 11:30 ` Bruce Richardson
2017-06-21 11:06 ` [dpdk-dev] [PATCH v8 4/4] ethdev: add control interface support Ferruh Yigit
2017-06-21 15:24 ` Stephen Hemminger
2017-06-30 17:06 ` Ferruh Yigit
2017-06-26 11:39 ` [dpdk-dev] [PATCH v8 0/4] Userspace Network Control Interface (UNCI) Bruce Richardson
2017-06-29 16:13 ` Ferruh Yigit
2017-06-30 16:56 ` Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 00/20] " Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 01/20] ethtool: add library skeleton Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 02/20] ethtool: move from sample folder into lib folder Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 03/20] ethtool: remove PMD specific API call Ferruh Yigit
2017-06-30 16:51 ` Ferruh Yigit [this message]
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 05/20] ethtool: enable library Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 06/20] doc: add ethtool library documentation Ferruh Yigit
2017-07-02 20:18 ` Mcnamara, John
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 07/20] doc: update ethtool sample app doc Ferruh Yigit
2017-07-02 20:17 ` Mcnamara, John
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 08/20] unci: add module skeleton Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 09/20] unci: add rtnl newlink Ferruh Yigit
2017-06-30 17:27 ` Stephen Hemminger
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 10/20] unci: init netlink Ferruh Yigit
2017-06-30 17:28 ` Stephen Hemminger
2017-06-30 17:29 ` Stephen Hemminger
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 11/20] unci: add netlink exec Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 12/20] unci: add netdevice ops Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 13/20] unci: add ethtool support Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 14/20] ctrl_if: add library skeleton Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 15/20] ctrl_if: add create destroy interface APIs Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 16/20] ctrl_if: initialize netlink interface Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 17/20] ctrl_if: process control messages Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 18/20] ctrl_if: process ethtool messages Ferruh Yigit
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 19/20] doc: add control interface library documentation Ferruh Yigit
2017-07-02 20:16 ` Mcnamara, John
2017-06-30 16:51 ` [dpdk-dev] [PATCH v9 20/20] ethdev: add control interface support Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 00/20] Userspace Network Control Interface (UNCI) Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 01/20] ethtool: add library skeleton Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 02/20] ethtool: move from sample folder into lib folder Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 03/20] ethtool: remove PMD specific API call Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 04/20] ethtool: update header doxygen syntax Ferruh Yigit
2017-07-06 9:18 ` Burakov, Anatoly
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 05/20] ethtool: enable library Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 06/20] doc: add ethtool library documentation Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 07/20] doc: update ethtool sample app doc Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 08/20] unci: add module skeleton Ferruh Yigit
2017-07-06 9:25 ` Burakov, Anatoly
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 09/20] unci: add rtnl newlink Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 10/20] unci: init netlink Ferruh Yigit
2017-07-06 9:32 ` Burakov, Anatoly
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 11/20] unci: add netlink exec Ferruh Yigit
2017-07-05 19:07 ` Stephen Hemminger
2017-07-06 10:45 ` Ferruh Yigit
2017-07-07 0:25 ` Stephen Hemminger
2017-07-05 19:15 ` Stephen Hemminger
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 12/20] unci: add netdevice ops Ferruh Yigit
2017-07-05 19:12 ` Stephen Hemminger
2017-07-05 19:12 ` Stephen Hemminger
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 13/20] unci: add ethtool support Ferruh Yigit
2017-07-05 19:07 ` Stephen Hemminger
2017-07-05 19:08 ` Stephen Hemminger
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 14/20] ctrl_if: add library skeleton Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 15/20] ctrl_if: add create destroy interface APIs Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 16/20] ctrl_if: initialize generic netlink interface Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 17/20] ctrl_if: process control messages Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 18/20] ctrl_if: process ethtool messages Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 19/20] doc: add control interface library documentation Ferruh Yigit
2017-07-04 16:13 ` [dpdk-dev] [PATCH v10 20/20] ethdev: add control interface support Ferruh Yigit
2017-07-08 6:28 ` Yuanhan Liu
2017-07-20 14:55 ` Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170630165140.59594-5-ferruh.yigit@intel.com \
--to=ferruh.yigit@intel.com \
--cc=anatoly.burakov@intel.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=stephen@networkplumber.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).