[dpdk-dev] [PATCH 0/5] ethdev: cosmetic fixes for just moved structures

[dpdk-dev] [PATCH 0/5] ethdev: cosmetic fixes for just moved structures

[Andrew Rybchenko]

Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
right now is a good chance to make a cleanup.

No strong opinion, but I think it would be useful for the future.

Make be at least some fixes from below could be accepted.

Andrew Rybchenko (5):
  ethdev: avoid documentation in next lines
  ethdev: fix Rx/Tx spelling in just moved structures
  ethdev: remove reserved fields from internal structures
  ethdev: make device and data structures readable
  ethdev: remove full stop after short comments and references

 lib/ethdev/ethdev_driver.h | 124 +++++++++++++++++++------------------
 1 file changed, 64 insertions(+), 60 deletions(-)

-- 
2.30.2

[dpdk-dev] [PATCH 1/5] ethdev: avoid documentation in next lines

[Andrew Rybchenko]

Documentation in the next separate line is confusing. If documentation
requires own line it should be before, not after.

Fixes: 9f3eb8826450 ("ethdev: hide eth dev related structures")

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 72 ++++++++++++++++++--------------------
 1 file changed, 35 insertions(+), 37 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 0174ba03d7..e5c7d08160 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -44,18 +44,17 @@ struct rte_eth_rxtx_callback {
 struct rte_eth_dev {
 	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
 	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
+	/** Pointer to PMD transmit prepare function. */
 	eth_tx_prep_t tx_pkt_prepare;
-	/**< Pointer to PMD transmit prepare function. */
+	/** Get the number of used RX descriptors. */
 	eth_rx_queue_count_t rx_queue_count;
-	/**< Get the number of used RX descriptors. */
+	/** Check the status of a Rx descriptor. */
 	eth_rx_descriptor_status_t rx_descriptor_status;
-	/**< Check the status of a Rx descriptor. */
+	/** Check the status of a Tx descriptor. */
 	eth_tx_descriptor_status_t tx_descriptor_status;
-	/**< Check the status of a Tx descriptor. */
 
 	/**
-	 * points to device data that is shared between
-	 * primary and secondary processes.
+	 * Device data that is shared between primary and secondary processes.
 	 */
 	struct rte_eth_dev_data *data;
 	void *process_private; /**< Pointer to per-process device data. */
@@ -100,64 +99,63 @@ struct rte_eth_dev_data {
 
 	struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 
+	/** PMD-specific private data. @see rte_eth_dev_release_port(). */
 	void *dev_private;
-			/**< PMD-specific private data.
-			 *   @see rte_eth_dev_release_port()
-			 */
 
 	struct rte_eth_link dev_link;   /**< Link-level information & status. */
 	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
 	uint16_t mtu;                   /**< Maximum Transmission Unit. */
+	/** Common RX buffer size handled by all queues. */
 	uint32_t min_rx_buf_size;
-			/**< Common RX buffer size handled by all queues. */
 
 	uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
+	/** Device Ethernet link address. @see rte_eth_dev_release_port(). */
 	struct rte_ether_addr *mac_addrs;
-			/**< Device Ethernet link address.
-			 *   @see rte_eth_dev_release_port()
-			 */
+	/** Bitmap associating MAC addresses to pools. */
 	uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
-			/**< Bitmap associating MAC addresses to pools. */
+	/**
+	 * Device Ethernet MAC addresses of hash filtering.
+	 * @see rte_eth_dev_release_port()
+	 */
 	struct rte_ether_addr *hash_mac_addrs;
-			/**< Device Ethernet MAC addresses of hash filtering.
-			 *   @see rte_eth_dev_release_port()
-			 */
 	uint16_t port_id;           /**< Device [external] port identifier. */
 
 	__extension__
-	uint8_t promiscuous   : 1,
-		/**< RX promiscuous mode ON(1) / OFF(0). */
+	uint8_t /** RX promiscuous mode ON(1) / OFF(0). */
+		promiscuous   : 1,
+		/** RX of scattered packets is ON(1) / OFF(0) */
 		scattered_rx : 1,
-		/**< RX of scattered packets is ON(1) / OFF(0) */
+		/** RX all multicast mode ON(1) / OFF(0). */
 		all_multicast : 1,
-		/**< RX all multicast mode ON(1) / OFF(0). */
+		/** Device state: STARTED(1) / STOPPED(0). */
 		dev_started : 1,
-		/**< Device state: STARTED(1) / STOPPED(0). */
+		/** RX LRO is ON(1) / OFF(0) */
 		lro         : 1,
-		/**< RX LRO is ON(1) / OFF(0) */
-		dev_configured : 1;
-		/**< Indicates whether the device is configured.
-		 *   CONFIGURED(1) / NOT CONFIGURED(0).
+		/**
+		 * Indicates whether the device is configured.
+		 * CONFIGURED(1) / NOT CONFIGURED(0).
 		 */
+		dev_configured : 1;
+	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
-		/**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
+	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
-		/**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint32_t dev_flags;             /**< Capabilities. */
 	int numa_node;                  /**< NUMA node connection. */
+	/** VLAN filter configuration. */
 	struct rte_vlan_filter_conf vlan_filter_conf;
-			/**< VLAN filter configuration. */
 	struct rte_eth_dev_owner owner; /**< The port owner. */
+	/**
+	 * Switch-specific identifier.
+	 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
+	 */
 	uint16_t representor_id;
-			/**< Switch-specific identifier.
-			 *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
-			 */
+	/**
+	 * Port ID of the backing device.
+	 * This device will be used to query representor info and calculate
+	 * representor IDs. Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
+	 */
 	uint16_t backer_port_id;
-			/**< Port ID of the backing device.
-			 *   This device will be used to query representor
-			 *   info and calculate representor IDs.
-			 *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
-			 */
 
 	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
 	uint64_t reserved_64s[4]; /**< Reserved for future fields */
-- 
2.30.2

[dpdk-dev] [PATCH 2/5] ethdev: fix Rx/Tx spelling in just moved structures

[Andrew Rybchenko]

Fixes: 9f3eb8826450 ("ethdev: hide eth dev related structures")

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index e5c7d08160..af9f379692 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -46,7 +46,7 @@ struct rte_eth_dev {
 	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
 	/** Pointer to PMD transmit prepare function. */
 	eth_tx_prep_t tx_pkt_prepare;
-	/** Get the number of used RX descriptors. */
+	/** Get the number of used Rx descriptors. */
 	eth_rx_queue_count_t rx_queue_count;
 	/** Check the status of a Rx descriptor. */
 	eth_rx_descriptor_status_t rx_descriptor_status;
@@ -92,10 +92,10 @@ struct rte_eth_dev_owner;
 struct rte_eth_dev_data {
 	char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
 
-	void **rx_queues; /**< Array of pointers to RX queues. */
-	void **tx_queues; /**< Array of pointers to TX queues. */
-	uint16_t nb_rx_queues; /**< Number of RX queues. */
-	uint16_t nb_tx_queues; /**< Number of TX queues. */
+	void **rx_queues; /**< Array of pointers to Rx queues. */
+	void **tx_queues; /**< Array of pointers to Tx queues. */
+	uint16_t nb_rx_queues; /**< Number of Rx queues. */
+	uint16_t nb_tx_queues; /**< Number of Tx queues. */
 
 	struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 
@@ -105,10 +105,10 @@ struct rte_eth_dev_data {
 	struct rte_eth_link dev_link;   /**< Link-level information & status. */
 	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
 	uint16_t mtu;                   /**< Maximum Transmission Unit. */
-	/** Common RX buffer size handled by all queues. */
+	/** Common Rx buffer size handled by all queues. */
 	uint32_t min_rx_buf_size;
 
-	uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
+	uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures. */
 	/** Device Ethernet link address. @see rte_eth_dev_release_port(). */
 	struct rte_ether_addr *mac_addrs;
 	/** Bitmap associating MAC addresses to pools. */
@@ -121,15 +121,15 @@ struct rte_eth_dev_data {
 	uint16_t port_id;           /**< Device [external] port identifier. */
 
 	__extension__
-	uint8_t /** RX promiscuous mode ON(1) / OFF(0). */
+	uint8_t /** Rx promiscuous mode ON(1) / OFF(0). */
 		promiscuous   : 1,
-		/** RX of scattered packets is ON(1) / OFF(0) */
+		/** Rx of scattered packets is ON(1) / OFF(0) */
 		scattered_rx : 1,
-		/** RX all multicast mode ON(1) / OFF(0). */
+		/** Rx all multicast mode ON(1) / OFF(0). */
 		all_multicast : 1,
 		/** Device state: STARTED(1) / STOPPED(0). */
 		dev_started : 1,
-		/** RX LRO is ON(1) / OFF(0) */
+		/** Rx LRO is ON(1) / OFF(0) */
 		lro         : 1,
 		/**
 		 * Indicates whether the device is configured.
-- 
2.30.2

[dpdk-dev] [PATCH 3/5] ethdev: remove reserved fields from internal structures

[Andrew Rybchenko]

Fixes: 9f3eb8826450 ("ethdev: hide eth dev related structures")

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index af9f379692..80d5784166 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -75,9 +75,6 @@ struct rte_eth_dev {
 	struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 	enum rte_eth_dev_state state; /**< Flag indicating the port state */
 	void *security_ctx; /**< Context for security ops */
-
-	uint64_t reserved_64s[4]; /**< Reserved for future fields */
-	void *reserved_ptrs[4];   /**< Reserved for future fields */
 } __rte_cache_aligned;
 
 struct rte_eth_dev_sriov;
@@ -158,8 +155,6 @@ struct rte_eth_dev_data {
 	uint16_t backer_port_id;
 
 	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
-	uint64_t reserved_64s[4]; /**< Reserved for future fields */
-	void *reserved_ptrs[4];   /**< Reserved for future fields */
 } __rte_cache_aligned;
 
 /**
-- 
2.30.2

[dpdk-dev] [PATCH 4/5] ethdev: make device and data structures readable

[Andrew Rybchenko]

Add empty lines to separate fields commented using different styles.

Fixes: 9f3eb8826450 ("ethdev: hide eth dev related structures")

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 80d5784166..0dd5dc6f61 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -44,6 +44,7 @@ struct rte_eth_rxtx_callback {
 struct rte_eth_dev {
 	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
 	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
+
 	/** Pointer to PMD transmit prepare function. */
 	eth_tx_prep_t tx_pkt_prepare;
 	/** Get the number of used Rx descriptors. */
@@ -61,6 +62,7 @@ struct rte_eth_dev {
 	const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
 	struct rte_device *device; /**< Backing device */
 	struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
+
 	/** User application callbacks for NIC interrupts */
 	struct rte_eth_dev_cb_list link_intr_cbs;
 	/**
@@ -73,6 +75,7 @@ struct rte_eth_dev {
 	 * received packets before passing them to the driver for transmission.
 	 */
 	struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
+
 	enum rte_eth_dev_state state; /**< Flag indicating the port state */
 	void *security_ctx; /**< Context for security ops */
 } __rte_cache_aligned;
@@ -102,10 +105,12 @@ struct rte_eth_dev_data {
 	struct rte_eth_link dev_link;   /**< Link-level information & status. */
 	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
 	uint16_t mtu;                   /**< Maximum Transmission Unit. */
+
 	/** Common Rx buffer size handled by all queues. */
 	uint32_t min_rx_buf_size;
 
 	uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures. */
+
 	/** Device Ethernet link address. @see rte_eth_dev_release_port(). */
 	struct rte_ether_addr *mac_addrs;
 	/** Bitmap associating MAC addresses to pools. */
@@ -115,6 +120,7 @@ struct rte_eth_dev_data {
 	 * @see rte_eth_dev_release_port()
 	 */
 	struct rte_ether_addr *hash_mac_addrs;
+
 	uint16_t port_id;           /**< Device [external] port identifier. */
 
 	__extension__
@@ -133,15 +139,20 @@ struct rte_eth_dev_data {
 		 * CONFIGURED(1) / NOT CONFIGURED(0).
 		 */
 		dev_configured : 1;
+
 	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
 	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
+
 	uint32_t dev_flags;             /**< Capabilities. */
 	int numa_node;                  /**< NUMA node connection. */
+
 	/** VLAN filter configuration. */
 	struct rte_vlan_filter_conf vlan_filter_conf;
+
 	struct rte_eth_dev_owner owner; /**< The port owner. */
+
 	/**
 	 * Switch-specific identifier.
 	 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
-- 
2.30.2

[dpdk-dev] [PATCH 5/5] ethdev: remove full stop after short comments and references

[Andrew Rybchenko]

Full stop at the end of short comment just make line longer. It
should be either everywhere or nowhere to be consistent.

Fixes: 9f3eb8826450 ("ethdev: hide eth dev related structures")

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 68 +++++++++++++++++++-------------------
 1 file changed, 34 insertions(+), 34 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 0dd5dc6f61..756b2ba3f9 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -42,23 +42,23 @@ struct rte_eth_rxtx_callback {
  * process, while the actual configuration data for the device is shared.
  */
 struct rte_eth_dev {
-	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
-	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
+	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function */
+	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function */
 
-	/** Pointer to PMD transmit prepare function. */
+	/** Pointer to PMD transmit prepare function */
 	eth_tx_prep_t tx_pkt_prepare;
-	/** Get the number of used Rx descriptors. */
+	/** Get the number of used Rx descriptors */
 	eth_rx_queue_count_t rx_queue_count;
-	/** Check the status of a Rx descriptor. */
+	/** Check the status of a Rx descriptor */
 	eth_rx_descriptor_status_t rx_descriptor_status;
-	/** Check the status of a Tx descriptor. */
+	/** Check the status of a Tx descriptor */
 	eth_tx_descriptor_status_t tx_descriptor_status;
 
 	/**
-	 * Device data that is shared between primary and secondary processes.
+	 * Device data that is shared between primary and secondary processes
 	 */
 	struct rte_eth_dev_data *data;
-	void *process_private; /**< Pointer to per-process device data. */
+	void *process_private; /**< Pointer to per-process device data */
 	const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
 	struct rte_device *device; /**< Backing device */
 	struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
@@ -72,7 +72,7 @@ struct rte_eth_dev {
 	struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 	/**
 	 * User-supplied functions called from tx_burst to pre-process
-	 * received packets before passing them to the driver for transmission.
+	 * received packets before passing them to the driver for transmission
 	 */
 	struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 
@@ -92,28 +92,28 @@ struct rte_eth_dev_owner;
 struct rte_eth_dev_data {
 	char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
 
-	void **rx_queues; /**< Array of pointers to Rx queues. */
-	void **tx_queues; /**< Array of pointers to Tx queues. */
-	uint16_t nb_rx_queues; /**< Number of Rx queues. */
-	uint16_t nb_tx_queues; /**< Number of Tx queues. */
+	void **rx_queues; /**< Array of pointers to Rx queues */
+	void **tx_queues; /**< Array of pointers to Tx queues */
+	uint16_t nb_rx_queues; /**< Number of Rx queues */
+	uint16_t nb_tx_queues; /**< Number of Tx queues */
 
 	struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 
-	/** PMD-specific private data. @see rte_eth_dev_release_port(). */
+	/** PMD-specific private data. @see rte_eth_dev_release_port() */
 	void *dev_private;
 
-	struct rte_eth_link dev_link;   /**< Link-level information & status. */
-	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
-	uint16_t mtu;                   /**< Maximum Transmission Unit. */
+	struct rte_eth_link dev_link;   /**< Link-level information & status */
+	struct rte_eth_conf dev_conf;   /**< Configuration applied to device */
+	uint16_t mtu;                   /**< Maximum Transmission Unit */
 
-	/** Common Rx buffer size handled by all queues. */
+	/** Common Rx buffer size handled by all queues */
 	uint32_t min_rx_buf_size;
 
-	uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures. */
+	uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures */
 
-	/** Device Ethernet link address. @see rte_eth_dev_release_port(). */
+	/** Device Ethernet link address. @see rte_eth_dev_release_port() */
 	struct rte_ether_addr *mac_addrs;
-	/** Bitmap associating MAC addresses to pools. */
+	/** Bitmap associating MAC addresses to pools */
 	uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
 	/**
 	 * Device Ethernet MAC addresses of hash filtering.
@@ -121,37 +121,37 @@ struct rte_eth_dev_data {
 	 */
 	struct rte_ether_addr *hash_mac_addrs;
 
-	uint16_t port_id;           /**< Device [external] port identifier. */
+	uint16_t port_id;           /**< Device [external] port identifier */
 
 	__extension__
-	uint8_t /** Rx promiscuous mode ON(1) / OFF(0). */
+	uint8_t /** Rx promiscuous mode ON(1) / OFF(0) */
 		promiscuous   : 1,
 		/** Rx of scattered packets is ON(1) / OFF(0) */
 		scattered_rx : 1,
-		/** Rx all multicast mode ON(1) / OFF(0). */
+		/** Rx all multicast mode ON(1) / OFF(0) */
 		all_multicast : 1,
-		/** Device state: STARTED(1) / STOPPED(0). */
+		/** Device state: STARTED(1) / STOPPED(0) */
 		dev_started : 1,
 		/** Rx LRO is ON(1) / OFF(0) */
 		lro         : 1,
 		/**
-		 * Indicates whether the device is configured.
-		 * CONFIGURED(1) / NOT CONFIGURED(0).
+		 * Indicates whether the device is configured:
+		 * CONFIGURED(1) / NOT CONFIGURED(0)
 		 */
 		dev_configured : 1;
 
-	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
+	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
 	uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
-	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
+	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
 	uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
 
-	uint32_t dev_flags;             /**< Capabilities. */
-	int numa_node;                  /**< NUMA node connection. */
+	uint32_t dev_flags;             /**< Capabilities */
+	int numa_node;                  /**< NUMA node connection */
 
-	/** VLAN filter configuration. */
+	/** VLAN filter configuration */
 	struct rte_vlan_filter_conf vlan_filter_conf;
 
-	struct rte_eth_dev_owner owner; /**< The port owner. */
+	struct rte_eth_dev_owner owner; /**< The port owner */
 
 	/**
 	 * Switch-specific identifier.
@@ -165,7 +165,7 @@ struct rte_eth_dev_data {
 	 */
 	uint16_t backer_port_id;
 
-	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
+	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex */
 } __rte_cache_aligned;
 
 /**
-- 
2.30.2

Re: [dpdk-dev] [PATCH 0/5] ethdev: cosmetic fixes for just moved structures

[Ferruh Yigit]

On 10/14/2021 9:36 AM, Andrew Rybchenko wrote:
> Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
> right now is a good chance to make a cleanup.
> 
> No strong opinion, but I think it would be useful for the future.
> 
> Make be at least some fixes from below could be accepted.
> 
> Andrew Rybchenko (5):
>    ethdev: avoid documentation in next lines
>    ethdev: fix Rx/Tx spelling in just moved structures
>    ethdev: remove reserved fields from internal structures
>    ethdev: make device and data structures readable
>    ethdev: remove full stop after short comments and references
> 

Overall +1 to these changes, I think this release is the opportunity
to have changes like this.

But as far as I can see only new moved code updated in 'ethdev_driver.h',
why not update whole 'ethdev_driver.h'?

Re: [dpdk-dev] [PATCH 0/5] ethdev: cosmetic fixes for just moved structures

[Andrew Rybchenko]

On 10/19/21 2:55 PM, Ferruh Yigit wrote:
> On 10/14/2021 9:36 AM, Andrew Rybchenko wrote:
>> Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
>> right now is a good chance to make a cleanup.
>>
>> No strong opinion, but I think it would be useful for the future.
>>
>> Make be at least some fixes from below could be accepted.
>>
>> Andrew Rybchenko (5):
>>    ethdev: avoid documentation in next lines
>>    ethdev: fix Rx/Tx spelling in just moved structures
>>    ethdev: remove reserved fields from internal structures
>>    ethdev: make device and data structures readable
>>    ethdev: remove full stop after short comments and references
>>
> 
> Overall +1 to these changes, I think this release is the opportunity
> to have changes like this.
> 
> But as far as I can see only new moved code updated in 'ethdev_driver.h',
> why not update whole 'ethdev_driver.h'?

Simply don't want to complicate search by git blame because of cosmetic
changes. No strong opinion, but decided to go this way for now.

Re: [dpdk-dev] [PATCH 0/5] ethdev: cosmetic fixes for just moved structures

[Ferruh Yigit]

On 10/19/2021 7:07 PM, Andrew Rybchenko wrote:
> On 10/19/21 2:55 PM, Ferruh Yigit wrote:
>> On 10/14/2021 9:36 AM, Andrew Rybchenko wrote:
>>> Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
>>> right now is a good chance to make a cleanup.
>>>
>>> No strong opinion, but I think it would be useful for the future.
>>>
>>> Make be at least some fixes from below could be accepted.
>>>
>>> Andrew Rybchenko (5):
>>>    ethdev: avoid documentation in next lines
>>>    ethdev: fix Rx/Tx spelling in just moved structures
>>>    ethdev: remove reserved fields from internal structures
>>>    ethdev: make device and data structures readable
>>>    ethdev: remove full stop after short comments and references
>>>
>>
>> Overall +1 to these changes, I think this release is the opportunity
>> to have changes like this.
>>
>> But as far as I can see only new moved code updated in 'ethdev_driver.h',
>> why not update whole 'ethdev_driver.h'?
> 
> Simply don't want to complicate search by git blame because of cosmetic
> changes. No strong opinion, but decided to go this way for now.

Normally agree to NOT get cosmetic changes because the reason you mentioned,
noise in the git history. But in this release we already shuffled things a bit,
that is why I think it is good opportunity to get these kind of changes.

Also there will be some inconsistencies in 'ethdev_driver.h' after your changes,
like 'RX' -> 'Rx' change done in one patch, but half of the file still uses 'RX'.

I also don't have strong opinion, but my preference is either fix all, or none.
Lets get some more comments.

Re: [dpdk-dev] [PATCH 0/5] ethdev: cosmetic fixes for just moved structures

[Thomas Monjalon]

20/10/2021 00:05, Ferruh Yigit:
> On 10/19/2021 7:07 PM, Andrew Rybchenko wrote:
> > On 10/19/21 2:55 PM, Ferruh Yigit wrote:
> >> On 10/14/2021 9:36 AM, Andrew Rybchenko wrote:
> >>> Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
> >>> right now is a good chance to make a cleanup.
> >>>
> >>> No strong opinion, but I think it would be useful for the future.
> >>>
> >>> Make be at least some fixes from below could be accepted.
> >>>
> >>> Andrew Rybchenko (5):
> >>>    ethdev: avoid documentation in next lines
> >>>    ethdev: fix Rx/Tx spelling in just moved structures
> >>>    ethdev: remove reserved fields from internal structures
> >>>    ethdev: make device and data structures readable
> >>>    ethdev: remove full stop after short comments and references
> >>>
> >>
> >> Overall +1 to these changes, I think this release is the opportunity
> >> to have changes like this.
> >>
> >> But as far as I can see only new moved code updated in 'ethdev_driver.h',
> >> why not update whole 'ethdev_driver.h'?
> > 
> > Simply don't want to complicate search by git blame because of cosmetic
> > changes. No strong opinion, but decided to go this way for now.
> 
> Normally agree to NOT get cosmetic changes because the reason you mentioned,
> noise in the git history. But in this release we already shuffled things a bit,
> that is why I think it is good opportunity to get these kind of changes.
> 
> Also there will be some inconsistencies in 'ethdev_driver.h' after your changes,
> like 'RX' -> 'Rx' change done in one patch, but half of the file still uses 'RX'.
> 
> I also don't have strong opinion, but my preference is either fix all, or none.
> Lets get some more comments.

OK to fix all, given ethdev is already shuffled a lot.

Re: [dpdk-dev] [PATCH 0/5] ethdev: cosmetic fixes for just moved structures

[Andrew Rybchenko]

On 10/20/21 1:20 AM, Thomas Monjalon wrote:
> 20/10/2021 00:05, Ferruh Yigit:
>> On 10/19/2021 7:07 PM, Andrew Rybchenko wrote:
>>> On 10/19/21 2:55 PM, Ferruh Yigit wrote:
>>>> On 10/14/2021 9:36 AM, Andrew Rybchenko wrote:
>>>>> Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
>>>>> right now is a good chance to make a cleanup.
>>>>>
>>>>> No strong opinion, but I think it would be useful for the future.
>>>>>
>>>>> Make be at least some fixes from below could be accepted.
>>>>>
>>>>> Andrew Rybchenko (5):
>>>>>    ethdev: avoid documentation in next lines
>>>>>    ethdev: fix Rx/Tx spelling in just moved structures
>>>>>    ethdev: remove reserved fields from internal structures
>>>>>    ethdev: make device and data structures readable
>>>>>    ethdev: remove full stop after short comments and references
>>>>>
>>>>
>>>> Overall +1 to these changes, I think this release is the opportunity
>>>> to have changes like this.
>>>>
>>>> But as far as I can see only new moved code updated in 'ethdev_driver.h',
>>>> why not update whole 'ethdev_driver.h'?
>>>
>>> Simply don't want to complicate search by git blame because of cosmetic
>>> changes. No strong opinion, but decided to go this way for now.
>>
>> Normally agree to NOT get cosmetic changes because the reason you mentioned,
>> noise in the git history. But in this release we already shuffled things a bit,
>> that is why I think it is good opportunity to get these kind of changes.
>>
>> Also there will be some inconsistencies in 'ethdev_driver.h' after your changes,
>> like 'RX' -> 'Rx' change done in one patch, but half of the file still uses 'RX'.
>>
>> I also don't have strong opinion, but my preference is either fix all, or none.
>> Lets get some more comments.
> 
> OK to fix all, given ethdev is already shuffled a lot.
> 

I've made the next step. See v2. Let me know if it is OK, too
much or insufficient.

[dpdk-dev] [PATCH v2 0/9] ethdev: cosmetic fixes

[Andrew Rybchenko]

Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
right now is a good chance to make a cleanup. Moreover ethdev is
or will be shuffled a lot in the release, so do cleanup in all
files.

Maybe at least some fixes from below could be accepted.

Spelling is fixed in log messages as well. Hopefully it isn ot a
problem, but let me know if I'm wrong and I'll avoid it in the
next version.

Since changes are cosmetic no Fixes tags and no backporting to
stable.

Andrew Rybchenko (9):
  ethdev: avoid documentation in next lines
  ethdev: fix Rx/Tx spelling
  ethdev: fix Ethernet spelling
  ethdev: fix DCB and VMDq spelling
  ethdev: fix VLAN spelling including VLAN ID case
  ethdev: fix ID spelling in comments and log messages
  ethdev: remove reserved fields from internal structures
  ethdev: make device and data structures readable
  ethdev: remove full stop after short comments and references

 lib/ethdev/ethdev_driver.h   | 380 ++++++++++++-------------
 lib/ethdev/ethdev_pci.h      |   2 +-
 lib/ethdev/ethdev_private.h  |   2 +-
 lib/ethdev/ethdev_profile.c  |   6 +-
 lib/ethdev/ethdev_vdev.h     |   2 +-
 lib/ethdev/rte_class_eth.c   |   2 +-
 lib/ethdev/rte_eth_ctrl.h    |   2 +-
 lib/ethdev/rte_ethdev.c      |  66 ++---
 lib/ethdev/rte_ethdev.h      | 518 ++++++++++++++++++-----------------
 lib/ethdev/rte_ethdev_core.h |  20 +-
 lib/ethdev/rte_flow.h        |  48 ++--
 lib/ethdev/rte_mtr_driver.h  |  30 +-
 lib/ethdev/rte_tm.h          |  14 +-
 13 files changed, 558 insertions(+), 534 deletions(-)

-- 
2.30.2

[dpdk-dev] [PATCH v2 1/9] ethdev: avoid documentation in next lines

[Andrew Rybchenko]

Documentation in the next separate line is confusing. If documentation
requires own line it should be before, not after.

Fix a number of incorrect markups on the way.

When corresponding lines are touched by the patch anyway, add
missing full stop to defined types description.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h   | 270 ++++++++++++++++++-----------------
 lib/ethdev/rte_ethdev.h      | 134 ++++++++---------
 lib/ethdev/rte_ethdev_core.h |  18 ++-
 lib/ethdev/rte_flow.h        |  38 ++---
 lib/ethdev/rte_mtr_driver.h  |  30 ++--
 5 files changed, 254 insertions(+), 236 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 0174ba03d7..8800c9c067 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -44,18 +44,17 @@ struct rte_eth_rxtx_callback {
 struct rte_eth_dev {
 	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
 	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
+	/** Pointer to PMD transmit prepare function. */
 	eth_tx_prep_t tx_pkt_prepare;
-	/**< Pointer to PMD transmit prepare function. */
+	/** Get the number of used RX descriptors. */
 	eth_rx_queue_count_t rx_queue_count;
-	/**< Get the number of used RX descriptors. */
+	/** Check the status of a Rx descriptor. */
 	eth_rx_descriptor_status_t rx_descriptor_status;
-	/**< Check the status of a Rx descriptor. */
+	/** Check the status of a Tx descriptor. */
 	eth_tx_descriptor_status_t tx_descriptor_status;
-	/**< Check the status of a Tx descriptor. */
 
 	/**
-	 * points to device data that is shared between
-	 * primary and secondary processes.
+	 * Device data that is shared between primary and secondary processes.
 	 */
 	struct rte_eth_dev_data *data;
 	void *process_private; /**< Pointer to per-process device data. */
@@ -100,64 +99,63 @@ struct rte_eth_dev_data {
 
 	struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 
+	/** PMD-specific private data. @see rte_eth_dev_release_port(). */
 	void *dev_private;
-			/**< PMD-specific private data.
-			 *   @see rte_eth_dev_release_port()
-			 */
 
 	struct rte_eth_link dev_link;   /**< Link-level information & status. */
 	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
 	uint16_t mtu;                   /**< Maximum Transmission Unit. */
+	/** Common RX buffer size handled by all queues. */
 	uint32_t min_rx_buf_size;
-			/**< Common RX buffer size handled by all queues. */
 
 	uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
+	/** Device Ethernet link address. @see rte_eth_dev_release_port(). */
 	struct rte_ether_addr *mac_addrs;
-			/**< Device Ethernet link address.
-			 *   @see rte_eth_dev_release_port()
-			 */
+	/** Bitmap associating MAC addresses to pools. */
 	uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
-			/**< Bitmap associating MAC addresses to pools. */
+	/**
+	 * Device Ethernet MAC addresses of hash filtering.
+	 * @see rte_eth_dev_release_port()
+	 */
 	struct rte_ether_addr *hash_mac_addrs;
-			/**< Device Ethernet MAC addresses of hash filtering.
-			 *   @see rte_eth_dev_release_port()
-			 */
 	uint16_t port_id;           /**< Device [external] port identifier. */
 
 	__extension__
-	uint8_t promiscuous   : 1,
-		/**< RX promiscuous mode ON(1) / OFF(0). */
+	uint8_t /** RX promiscuous mode ON(1) / OFF(0). */
+		promiscuous   : 1,
+		/** RX of scattered packets is ON(1) / OFF(0) */
 		scattered_rx : 1,
-		/**< RX of scattered packets is ON(1) / OFF(0) */
+		/** RX all multicast mode ON(1) / OFF(0). */
 		all_multicast : 1,
-		/**< RX all multicast mode ON(1) / OFF(0). */
+		/** Device state: STARTED(1) / STOPPED(0). */
 		dev_started : 1,
-		/**< Device state: STARTED(1) / STOPPED(0). */
+		/** RX LRO is ON(1) / OFF(0) */
 		lro         : 1,
-		/**< RX LRO is ON(1) / OFF(0) */
-		dev_configured : 1;
-		/**< Indicates whether the device is configured.
-		 *   CONFIGURED(1) / NOT CONFIGURED(0).
+		/**
+		 * Indicates whether the device is configured.
+		 * CONFIGURED(1) / NOT CONFIGURED(0).
 		 */
+		dev_configured : 1;
+	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
-		/**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
+	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
-		/**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint32_t dev_flags;             /**< Capabilities. */
 	int numa_node;                  /**< NUMA node connection. */
+	/** VLAN filter configuration. */
 	struct rte_vlan_filter_conf vlan_filter_conf;
-			/**< VLAN filter configuration. */
 	struct rte_eth_dev_owner owner; /**< The port owner. */
+	/**
+	 * Switch-specific identifier.
+	 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
+	 */
 	uint16_t representor_id;
-			/**< Switch-specific identifier.
-			 *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
-			 */
+	/**
+	 * Port ID of the backing device.
+	 * This device will be used to query representor info and calculate
+	 * representor IDs. Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
+	 */
 	uint16_t backer_port_id;
-			/**< Port ID of the backing device.
-			 *   This device will be used to query representor
-			 *   info and calculate representor IDs.
-			 *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
-			 */
 
 	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
 	uint64_t reserved_64s[4]; /**< Reserved for future fields */
@@ -171,7 +169,7 @@ struct rte_eth_dev_data {
  */
 extern struct rte_eth_dev rte_eth_devices[];
 
-/**< @internal Declaration of the hairpin peer queue information structure. */
+/** @internal Declaration of the hairpin peer queue information structure. */
 struct rte_hairpin_peer_info;
 
 /*
@@ -180,29 +178,29 @@ struct rte_hairpin_peer_info;
  * structure associated with an Ethernet device.
  */
 
+/** @internal Ethernet device configuration. */
 typedef int  (*eth_dev_configure_t)(struct rte_eth_dev *dev);
-/**< @internal Ethernet device configuration. */
 
+/** @internal Function used to start a configured Ethernet device. */
 typedef int  (*eth_dev_start_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to start a configured Ethernet device. */
 
+/** @internal Function used to stop a configured Ethernet device. */
 typedef int (*eth_dev_stop_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to stop a configured Ethernet device. */
 
+/** @internal Function used to link up a configured Ethernet device. */
 typedef int  (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to link up a configured Ethernet device. */
 
+/** @internal Function used to link down a configured Ethernet device. */
 typedef int  (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to link down a configured Ethernet device. */
 
+/** @internal Function used to close a configured Ethernet device. */
 typedef int (*eth_dev_close_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to close a configured Ethernet device. */
 
+/** @internal Function used to reset a configured Ethernet device. */
 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
-/** <@internal Function used to reset a configured Ethernet device. */
 
+/** @internal Function used to detect an Ethernet device removal. */
 typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to detect an Ethernet device removal. */
 
 /**
  * @internal
@@ -304,13 +302,16 @@ typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
  */
 typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
 
+/**
+ * @internal
+ * Get link speed, duplex mode and state (up/down) of an Ethernet device.
+ */
 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
 				int wait_to_complete);
-/**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
 
+/** @internal Get global I/O statistics of an Ethernet device. */
 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
 				struct rte_eth_stats *igb_stats);
-/**< @internal Get global I/O statistics of an Ethernet device. */
 
 /**
  * @internal
@@ -333,9 +334,9 @@ typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
  */
 typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);
 
+/** @internal Get extended stats of an Ethernet device. */
 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
 	struct rte_eth_xstat *stats, unsigned int n);
-/**< @internal Get extended stats of an Ethernet device. */
 
 /**
  * @internal
@@ -381,9 +382,9 @@ typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
  */
 typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
 
+/** @internal Get names of extended stats of an Ethernet device. */
 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
 	struct rte_eth_xstat_name *xstats_names, unsigned int size);
-/**< @internal Get names of extended stats of an Ethernet device. */
 
 /**
  * @internal
@@ -407,18 +408,21 @@ typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
 	const uint64_t *ids, struct rte_eth_xstat_name *xstats_names,
 	unsigned int size);
 
+/**
+ * @internal
+ * Set a queue statistics mapping for a tx/rx queue of an Ethernet device.
+ */
 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
 					     uint16_t queue_id,
 					     uint8_t stat_idx,
 					     uint8_t is_rx);
-/**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
 
+/** @internal Get specific information of an Ethernet device. */
 typedef int (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
 				   struct rte_eth_dev_info *dev_info);
-/**< @internal Get specific information of an Ethernet device. */
 
+/** @internal Get supported ptypes of an Ethernet device. */
 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
-/**< @internal Get supported ptypes of an Ethernet device. */
 
 /**
  * @internal
@@ -435,47 +439,47 @@ typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *de
 typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
 				     uint32_t ptype_mask);
 
+/** @internal Start rx and tx of a queue of an Ethernet device. */
 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
 				    uint16_t queue_id);
-/**< @internal Start rx and tx of a queue of an Ethernet device. */
 
+/** @internal Stop rx and tx of a queue of an Ethernet device. */
 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
 				    uint16_t queue_id);
-/**< @internal Stop rx and tx of a queue of an Ethernet device. */
 
+/** @internal Set up a receive queue of an Ethernet device. */
 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
 				    uint16_t rx_queue_id,
 				    uint16_t nb_rx_desc,
 				    unsigned int socket_id,
 				    const struct rte_eth_rxconf *rx_conf,
 				    struct rte_mempool *mb_pool);
-/**< @internal Set up a receive queue of an Ethernet device. */
 
+/** @internal Setup a transmit queue of an Ethernet device. */
 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
 				    uint16_t tx_queue_id,
 				    uint16_t nb_tx_desc,
 				    unsigned int socket_id,
 				    const struct rte_eth_txconf *tx_conf);
-/**< @internal Setup a transmit queue of an Ethernet device. */
 
+/** @internal Enable interrupt of a receive queue of an Ethernet device. */
 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
 				    uint16_t rx_queue_id);
-/**< @internal Enable interrupt of a receive queue of an Ethernet device. */
 
+/** @internal Disable interrupt of a receive queue of an Ethernet device. */
 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
 				    uint16_t rx_queue_id);
-/**< @internal Disable interrupt of a receive queue of an Ethernet device. */
 
+/** @internal Release memory resources allocated by given RX/TX queue. */
 typedef void (*eth_queue_release_t)(struct rte_eth_dev *dev,
 				    uint16_t queue_id);
-/**< @internal Release memory resources allocated by given RX/TX queue. */
 
+/** @internal Get firmware information of an Ethernet device. */
 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
 				     char *fw_version, size_t fw_size);
-/**< @internal Get firmware information of an Ethernet device. */
 
+/** @internal Force mbufs to be from TX ring. */
 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
-/**< @internal Force mbufs to be from TX ring. */
 
 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
 	uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
@@ -486,159 +490,159 @@ typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
 typedef int (*eth_burst_mode_get_t)(struct rte_eth_dev *dev,
 	uint16_t queue_id, struct rte_eth_burst_mode *mode);
 
+/** @internal Set MTU. */
 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
-/**< @internal Set MTU. */
 
+/** @internal Filtering of a VLAN Tag Identifier by an Ethernet device. */
 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
 				  uint16_t vlan_id,
 				  int on);
-/**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
 
+/** @internal Set the outer/inner VLAN-TPID by an Ethernet device. */
 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
 			       enum rte_vlan_type type, uint16_t tpid);
-/**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
 
+/** @internal Set VLAN offload function by an Ethernet device. */
 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
-/**< @internal set VLAN offload function by an Ethernet device. */
 
+/** @internal Set port based TX VLAN insertion by an Ethernet device. */
 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
 			       uint16_t vlan_id,
 			       int on);
-/**< @internal set port based TX VLAN insertion by an Ethernet device. */
 
+/** @internal VLAN stripping enable/disable by an queue of Ethernet device. */
 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
 				  uint16_t rx_queue_id,
 				  int on);
-/**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
 
+/** @internal Get current flow control parameter on an Ethernet device. */
 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
 			       struct rte_eth_fc_conf *fc_conf);
-/**< @internal Get current flow control parameter on an Ethernet device */
 
+/** @internal Setup flow control parameter on an Ethernet device. */
 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
 			       struct rte_eth_fc_conf *fc_conf);
-/**< @internal Setup flow control parameter on an Ethernet device */
 
+/** @internal Setup priority flow control parameter on an Ethernet device. */
 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
 				struct rte_eth_pfc_conf *pfc_conf);
-/**< @internal Setup priority flow control parameter on an Ethernet device */
 
+/** @internal Update RSS redirection table on an Ethernet device. */
 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
 			     struct rte_eth_rss_reta_entry64 *reta_conf,
 			     uint16_t reta_size);
-/**< @internal Update RSS redirection table on an Ethernet device */
 
+/** @internal Query RSS redirection table on an Ethernet device. */
 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
 			    struct rte_eth_rss_reta_entry64 *reta_conf,
 			    uint16_t reta_size);
-/**< @internal Query RSS redirection table on an Ethernet device */
 
+/** @internal Update RSS hash configuration of an Ethernet device. */
 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
 				 struct rte_eth_rss_conf *rss_conf);
-/**< @internal Update RSS hash configuration of an Ethernet device */
 
+/** @internal Get current RSS hash configuration of an Ethernet device. */
 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
 				   struct rte_eth_rss_conf *rss_conf);
-/**< @internal Get current RSS hash configuration of an Ethernet device */
 
+/** @internal Turn on SW controllable LED on an Ethernet device. */
 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
-/**< @internal Turn on SW controllable LED on an Ethernet device */
 
+/** @internal Turn off SW controllable LED on an Ethernet device. */
 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
-/**< @internal Turn off SW controllable LED on an Ethernet device */
 
+/** @internal Remove MAC address from receive address register. */
 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
-/**< @internal Remove MAC address from receive address register */
 
+/** @internal Set a MAC address into Receive Address Register. */
 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
 				  struct rte_ether_addr *mac_addr,
 				  uint32_t index,
 				  uint32_t vmdq);
-/**< @internal Set a MAC address into Receive Address Register */
 
+/** @internal Set a MAC address into Receive Address Register. */
 typedef int (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
 				  struct rte_ether_addr *mac_addr);
-/**< @internal Set a MAC address into Receive Address Register */
 
+/** @internal Set a Unicast Hash bitmap. */
 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
 				  struct rte_ether_addr *mac_addr,
 				  uint8_t on);
-/**< @internal Set a Unicast Hash bitmap */
 
+/** @internal Set all Unicast Hash bitmap. */
 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
 				  uint8_t on);
-/**< @internal Set all Unicast Hash bitmap */
 
+/** @internal Set queue TX rate. */
 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
 				uint16_t queue_idx,
 				uint16_t tx_rate);
-/**< @internal Set queue TX rate */
 
+/** @internal Add tunneling UDP port. */
 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
 					 struct rte_eth_udp_tunnel *tunnel_udp);
-/**< @internal Add tunneling UDP port */
 
+/** @internal Delete tunneling UDP port. */
 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
 					 struct rte_eth_udp_tunnel *tunnel_udp);
-/**< @internal Delete tunneling UDP port */
 
+/** @internal set the list of multicast addresses on an Ethernet device. */
 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
 				      struct rte_ether_addr *mc_addr_set,
 				      uint32_t nb_mc_addr);
-/**< @internal set the list of multicast addresses on an Ethernet device */
 
+/** @internal Function used to enable IEEE1588/802.1AS timestamping. */
 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
 
+/** @internal Function used to disable IEEE1588/802.1AS timestamping. */
 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
 
+/** @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
 						struct timespec *timestamp,
 						uint32_t flags);
-/**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
 
+/** @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
 						struct timespec *timestamp);
-/**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
 
+/** @internal Function used to adjust the device clock. */
 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
-/**< @internal Function used to adjust the device clock */
 
+/** @internal Function used to get time from the device clock. */
 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
 				      struct timespec *timestamp);
-/**< @internal Function used to get time from the device clock. */
 
+/** @internal Function used to get time from the device clock. */
 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
 				       const struct timespec *timestamp);
-/**< @internal Function used to get time from the device clock */
 
+/** @internal Function used to get the current value of the device clock. */
 typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
 				      uint64_t *timestamp);
-/**< @internal Function used to get the current value of the device clock. */
 
+/** @internal Retrieve registers. */
 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
 				struct rte_dev_reg_info *info);
-/**< @internal Retrieve registers  */
 
+/** @internal Retrieve eeprom size. */
 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
-/**< @internal Retrieve eeprom size  */
 
+/** @internal Retrieve eeprom data. */
 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
 				struct rte_dev_eeprom_info *info);
-/**< @internal Retrieve eeprom data  */
 
+/** @internal Program eeprom data. */
 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
 				struct rte_dev_eeprom_info *info);
-/**< @internal Program eeprom data  */
 
+/** @internal Retrieve type and size of plugin module eeprom. */
 typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
 				     struct rte_eth_dev_module_info *modinfo);
-/**< @internal Retrieve type and size of plugin module eeprom */
 
+/** @internal Retrieve plugin module eeprom data. */
 typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
 				       struct rte_dev_eeprom_info *info);
-/**< @internal Retrieve plugin module eeprom data */
 
 struct rte_flow_ops;
 /**
@@ -651,19 +655,19 @@ struct rte_flow_ops;
 typedef int (*eth_flow_ops_get_t)(struct rte_eth_dev *dev,
 				  const struct rte_flow_ops **ops);
 
+/** @internal Get Traffic Management (TM) operations on an Ethernet device. */
 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
-/**< @internal Get Traffic Management (TM) operations on an Ethernet device */
 
+/** @internal Get Traffic Metering and Policing (MTR) operations. */
 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
-/**< @internal Get Traffic Metering and Policing (MTR) operations */
 
+/** @internal Get dcb information on an Ethernet device. */
 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
 				 struct rte_eth_dcb_info *dcb_info);
-/**< @internal Get dcb information on an Ethernet device */
 
+/** @internal Test if a port supports specific mempool ops. */
 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
 						const char *pool);
-/**< @internal Test if a port supports specific mempool ops */
 
 /**
  * @internal
@@ -905,20 +909,20 @@ typedef int (*eth_hairpin_bind_t)(struct rte_eth_dev *dev,
 typedef int (*eth_hairpin_unbind_t)(struct rte_eth_dev *dev,
 				  uint16_t rx_port);
 
+/** @internal Update and fetch peer queue information. */
 typedef int (*eth_hairpin_queue_peer_update_t)
 	(struct rte_eth_dev *dev, uint16_t peer_queue,
 	 struct rte_hairpin_peer_info *current_info,
 	 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
-/**< @internal Update and fetch peer queue information. */
 
+/** @internal Bind peer queue to the current queue with fetched information. */
 typedef int (*eth_hairpin_queue_peer_bind_t)
 	(struct rte_eth_dev *dev, uint16_t cur_queue,
 	 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
-/**< @internal Bind peer queue to the current queue with fetched information. */
 
+/** @internal Unbind peer queue from the current queue. */
 typedef int (*eth_hairpin_queue_peer_unbind_t)
 	(struct rte_eth_dev *dev, uint16_t cur_queue, uint32_t direction);
-/**< @internal Unbind peer queue from the current queue. */
 
 /**
  * @internal
@@ -992,8 +996,8 @@ struct eth_dev_ops {
 	eth_dev_close_t            dev_close;     /**< Close device. */
 	eth_dev_reset_t		   dev_reset;	  /**< Reset device. */
 	eth_link_update_t          link_update;   /**< Get device link state. */
+	/** Check if the device was physically removed. */
 	eth_is_removed_t           is_removed;
-	/**< Check if the device was physically removed. */
 
 	eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON. */
 	eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF. */
@@ -1009,10 +1013,10 @@ struct eth_dev_ops {
 	eth_stats_reset_t          stats_reset;   /**< Reset generic device statistics. */
 	eth_xstats_get_t           xstats_get;    /**< Get extended device statistics. */
 	eth_xstats_reset_t         xstats_reset;  /**< Reset extended device statistics. */
+	/** Get names of extended statistics. */
 	eth_xstats_get_names_t     xstats_get_names;
-	/**< Get names of extended statistics. */
+	/** Configure per queue stat counter mapping. */
 	eth_queue_stats_mapping_set_t queue_stats_mapping_set;
-	/**< Configure per queue stat counter mapping. */
 
 	eth_dev_infos_get_t        dev_infos_get; /**< Get device info. */
 	eth_rxq_info_get_t         rxq_info_get; /**< retrieve RX queue information. */
@@ -1020,10 +1024,13 @@ struct eth_dev_ops {
 	eth_burst_mode_get_t       rx_burst_mode_get; /**< Get RX burst mode */
 	eth_burst_mode_get_t       tx_burst_mode_get; /**< Get TX burst mode */
 	eth_fw_version_get_t       fw_version_get; /**< Get firmware version. */
+	/** Get packet types supported and identified by device. */
 	eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
-	/**< Get packet types supported and identified by device. */
+	/**
+	 * Inform Ethernet device about reduced range of packet types to
+	 * handle.
+	 */
 	eth_dev_ptypes_set_t dev_ptypes_set;
-	/**< Inform Ethernet device about reduced range of packet types to handle. */
 
 	vlan_filter_set_t          vlan_filter_set; /**< Filter VLAN Setup. */
 	vlan_tpid_set_t            vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
@@ -1092,51 +1099,52 @@ struct eth_dev_ops {
 
 	eth_read_clock             read_clock;
 
+	/** Get extended device statistic values by ID. */
 	eth_xstats_get_by_id_t     xstats_get_by_id;
-	/**< Get extended device statistic values by ID. */
+	/** Get name of extended device statistics by ID. */
 	eth_xstats_get_names_by_id_t xstats_get_names_by_id;
-	/**< Get name of extended device statistics by ID. */
 
+	/** Get Traffic Management (TM) operations. */
 	eth_tm_ops_get_t tm_ops_get;
-	/**< Get Traffic Management (TM) operations. */
 
+	/** Get Traffic Metering and Policing (MTR) operations. */
 	eth_mtr_ops_get_t mtr_ops_get;
-	/**< Get Traffic Metering and Policing (MTR) operations. */
 
+	/** Test if a port supports specific mempool ops */
 	eth_pool_ops_supported_t pool_ops_supported;
-	/**< Test if a port supports specific mempool ops */
 
+	/** Returns the hairpin capabilities. */
 	eth_hairpin_cap_get_t hairpin_cap_get;
-	/**< Returns the hairpin capabilities. */
+	/** Set up device RX hairpin queue. */
 	eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
-	/**< Set up device RX hairpin queue. */
+	/** Set up device TX hairpin queue. */
 	eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
-	/**< Set up device TX hairpin queue. */
 
+	/** Get Forward Error Correction(FEC) capability. */
 	eth_fec_get_capability_t fec_get_capability;
-	/**< Get Forward Error Correction(FEC) capability. */
+	/** Get Forward Error Correction(FEC) mode. */
 	eth_fec_get_t fec_get;
-	/**< Get Forward Error Correction(FEC) mode. */
+	/** Set Forward Error Correction(FEC) mode. */
 	eth_fec_set_t fec_set;
-	/**< Set Forward Error Correction(FEC) mode. */
+
+	/** Get hairpin peer ports list. */
 	hairpin_get_peer_ports_t hairpin_get_peer_ports;
-	/**< Get hairpin peer ports list. */
+	/** Bind all hairpin Tx queues of device to the peer port Rx queues. */
 	eth_hairpin_bind_t hairpin_bind;
-	/**< Bind all hairpin Tx queues of device to the peer port Rx queues. */
+	/** Unbind all hairpin Tx queues from the peer port Rx queues. */
 	eth_hairpin_unbind_t hairpin_unbind;
-	/**< Unbind all hairpin Tx queues from the peer port Rx queues. */
+	/** Pass the current queue info and get the peer queue info. */
 	eth_hairpin_queue_peer_update_t hairpin_queue_peer_update;
-	/**< Pass the current queue info and get the peer queue info. */
+	/** Set up the connection between the pair of hairpin queues. */
 	eth_hairpin_queue_peer_bind_t hairpin_queue_peer_bind;
-	/**< Set up the connection between the pair of hairpin queues. */
+	/** Disconnect the hairpin queues of a pair from each other. */
 	eth_hairpin_queue_peer_unbind_t hairpin_queue_peer_unbind;
-	/**< Disconnect the hairpin queues of a pair from each other. */
 
+	/** Get power monitoring condition for Rx queue. */
 	eth_get_monitor_addr_t get_monitor_addr;
-	/**< Get power monitoring condition for Rx queue. */
 
+	/** Get representor info. */
 	eth_representor_info_get_t representor_info_get;
-	/**< Get representor info. */
 
 	/**
 	 * Negotiate the NIC's ability to deliver specific
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 69766eaae2..2d43c226f6 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -256,24 +256,25 @@ struct rte_eth_stats {
 	uint64_t opackets;  /**< Total number of successfully transmitted packets.*/
 	uint64_t ibytes;    /**< Total number of successfully received bytes. */
 	uint64_t obytes;    /**< Total number of successfully transmitted bytes. */
-	uint64_t imissed;
-	/**< Total of RX packets dropped by the HW,
+	/**
+	 * Total of RX packets dropped by the HW,
 	 * because there are no available buffer (i.e. RX queues are full).
 	 */
+	uint64_t imissed;
 	uint64_t ierrors;   /**< Total number of erroneous received packets. */
 	uint64_t oerrors;   /**< Total number of failed transmitted packets. */
 	uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
 	/* Queue stats are limited to max 256 queues */
+	/** Total number of queue RX packets. */
 	uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/**< Total number of queue RX packets. */
+	/** Total number of queue TX packets. */
 	uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/**< Total number of queue TX packets. */
+	/** Total number of successfully received queue bytes. */
 	uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/**< Total number of successfully received queue bytes. */
+	/** Total number of successfully transmitted queue bytes. */
 	uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/**< Total number of successfully transmitted queue bytes. */
+	/** Total number of queue packets received that are dropped. */
 	uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/**< Total number of queue packets received that are dropped. */
 };
 
 /**@{@name Link speed capabilities
@@ -499,8 +500,8 @@ struct rte_eth_rss_conf {
 #define RTE_ETH_FLOW_IPV6_EX            15
 #define RTE_ETH_FLOW_IPV6_TCP_EX        16
 #define RTE_ETH_FLOW_IPV6_UDP_EX        17
+/** Consider device port number as a flow differentiator */
 #define RTE_ETH_FLOW_PORT               18
-	/**< Consider device port number as a flow differentiator */
 #define RTE_ETH_FLOW_VXLAN              19 /**< VXLAN protocol based flow */
 #define RTE_ETH_FLOW_GENEVE             20 /**< GENEVE protocol based flow */
 #define RTE_ETH_FLOW_NVGRE              21 /**< NVGRE protocol based flow */
@@ -768,7 +769,7 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
 	ETH_RSS_S_VLAN  | \
 	ETH_RSS_C_VLAN)
 
-/**< Mask of valid RSS hash protocols */
+/** Mask of valid RSS hash protocols */
 #define ETH_RSS_PROTO_MASK ( \
 	ETH_RSS_IPV4 | \
 	ETH_RSS_FRAG_IPV4 | \
@@ -851,10 +852,10 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
  * is needed.
  */
 struct rte_eth_rss_reta_entry64 {
+	/** Mask bits indicate which entries need to be updated/queried. */
 	uint64_t mask;
-	/**< Mask bits indicate which entries need to be updated/queried. */
+	/** Group of 64 redirection table entries. */
 	uint16_t reta[RTE_RETA_GROUP_SIZE];
-	/**< Group of 64 redirection table entries. */
 };
 
 /**
@@ -920,8 +921,8 @@ struct rte_eth_vmdq_dcb_conf {
 		uint16_t vlan_id; /**< The vlan id of the received frame */
 		uint64_t pools;   /**< Bitmask of pools for packet rx */
 	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
+	/** Selects a queue in a pool */
 	uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
-	/**< Selects a queue in a pool */
 };
 
 /**
@@ -969,12 +970,12 @@ struct rte_eth_txmode {
 
 	uint16_t pvid;
 	__extension__
-	uint8_t hw_vlan_reject_tagged : 1,
-		/**< If set, reject sending out tagged pkts */
+	uint8_t /** If set, reject sending out tagged pkts */
+		hw_vlan_reject_tagged : 1,
+		/** If set, reject sending out untagged pkts */
 		hw_vlan_reject_untagged : 1,
-		/**< If set, reject sending out untagged pkts */
+		/** If set, enable port based VLAN insertion */
 		hw_vlan_insert_pvid : 1;
-		/**< If set, enable port based VLAN insertion */
 
 	uint64_t reserved_64s[2]; /**< Reserved for future fields */
 	void *reserved_ptrs[2];   /**< Reserved for future fields */
@@ -1268,8 +1269,8 @@ struct rte_fdir_conf {
 	/** RX queue of packets matching a "drop" filter in perfect mode. */
 	uint8_t drop_queue;
 	struct rte_eth_fdir_masks mask;
+	/** Flex payload configuration. */
 	struct rte_eth_fdir_flex_conf flex_conf;
-	/**< Flex payload configuration. */
 };
 
 /**
@@ -1320,20 +1321,20 @@ struct rte_eth_conf {
 				 are defined in implementation of each driver. */
 	struct {
 		struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
+		/** Port vmdq+dcb configuration. */
 		struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
-		/**< Port vmdq+dcb configuration. */
+		/** Port dcb RX configuration. */
 		struct rte_eth_dcb_rx_conf dcb_rx_conf;
-		/**< Port dcb RX configuration. */
+		/** Port vmdq RX configuration. */
 		struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
-		/**< Port vmdq RX configuration. */
 	} rx_adv_conf; /**< Port RX filtering configuration. */
 	union {
+		/** Port vmdq+dcb TX configuration. */
 		struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
-		/**< Port vmdq+dcb TX configuration. */
+		/** Port dcb TX configuration. */
 		struct rte_eth_dcb_tx_conf dcb_tx_conf;
-		/**< Port dcb TX configuration. */
+		/** Port vmdq TX configuration. */
 		struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
-		/**< Port vmdq TX configuration. */
 	} tx_adv_conf; /**< Port TX DCB configuration (union). */
 	/** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
 	    is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
@@ -1400,17 +1401,19 @@ struct rte_eth_conf {
 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO     0x00000800    /**< Used for tunneling packet. */
 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO   0x00001000    /**< Used for tunneling packet. */
 #define DEV_TX_OFFLOAD_MACSEC_INSERT    0x00002000
-#define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
-/**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
+/**
+ * Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
  * tx queue without SW lock.
  */
+#define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
+/** Device supports multi segment send. */
 #define DEV_TX_OFFLOAD_MULTI_SEGS	0x00008000
-/**< Device supports multi segment send. */
-#define DEV_TX_OFFLOAD_MBUF_FAST_FREE	0x00010000
-/**< Device supports optimization for fast release of mbufs.
- *   When set application must guarantee that per-queue all mbufs comes from
- *   the same mempool and has refcnt = 1.
+/**
+ * Device supports optimization for fast release of mbufs.
+ * When set application must guarantee that per-queue all mbufs comes from
+ * the same mempool and has refcnt = 1.
  */
+#define DEV_TX_OFFLOAD_MBUF_FAST_FREE	0x00010000
 #define DEV_TX_OFFLOAD_SECURITY         0x00020000
 /**
  * Device supports generic UDP tunneled packet TSO.
@@ -1479,14 +1482,14 @@ struct rte_eth_dev_portconf {
 struct rte_eth_switch_info {
 	const char *name;	/**< switch name */
 	uint16_t domain_id;	/**< switch domain id */
-	uint16_t port_id;
-	/**<
-	 * mapping to the devices physical switch port as enumerated from the
+	/**
+	 * Mapping to the devices physical switch port as enumerated from the
 	 * perspective of the embedded interconnect/switch. For SR-IOV enabled
 	 * device this may correspond to the VF_ID of each virtual function,
 	 * but each driver should explicitly define the mapping of switch
 	 * port identifier to that physical interconnect/switch
 	 */
+	uint16_t port_id;
 };
 
 /**
@@ -1543,16 +1546,16 @@ struct rte_eth_dev_info {
 	uint16_t max_vfs; /**< Maximum number of VFs. */
 	uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
 	struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/
+	/** All RX offload capabilities including all per-queue ones */
 	uint64_t rx_offload_capa;
-	/**< All RX offload capabilities including all per-queue ones */
+	/** All TX offload capabilities including all per-queue ones */
 	uint64_t tx_offload_capa;
-	/**< All TX offload capabilities including all per-queue ones */
+	/** Device per-queue RX offload capabilities. */
 	uint64_t rx_queue_offload_capa;
-	/**< Device per-queue RX offload capabilities. */
+	/** Device per-queue TX offload capabilities. */
 	uint64_t tx_queue_offload_capa;
-	/**< Device per-queue TX offload capabilities. */
+	/** Device redirection table size, the total number of entries. */
 	uint16_t reta_size;
-	/**< Device redirection table size, the total number of entries. */
 	uint8_t hash_key_size; /**< Hash key size in bytes */
 	/** Bit mask of RSS offloads, the bit offset also means flow type */
 	uint64_t flow_type_rss_offloads;
@@ -1740,13 +1743,13 @@ struct rte_eth_fec_capa {
 } while (0)
 
 /**@{@name L2 tunnel configuration */
-/**< l2 tunnel enable mask */
+/** L2 tunnel enable mask */
 #define ETH_L2_TUNNEL_ENABLE_MASK       0x00000001
-/**< l2 tunnel insertion mask */
+/** L2 tunnel insertion mask */
 #define ETH_L2_TUNNEL_INSERTION_MASK    0x00000002
-/**< l2 tunnel stripping mask */
+/** L2 tunnel stripping mask */
 #define ETH_L2_TUNNEL_STRIPPING_MASK    0x00000004
-/**< l2 tunnel forwarding mask */
+/** L2 tunnel forwarding mask */
 #define ETH_L2_TUNNEL_FORWARDING_MASK   0x00000008
 /**@}*/
 
@@ -3347,8 +3350,8 @@ struct rte_eth_dev_tx_buffer {
 	void *error_userdata;
 	uint16_t size;           /**< Size of buffer for buffered tx */
 	uint16_t length;         /**< Number of packets in the array */
+	/** Pending packets to be sent on explicit flush or when full */
 	struct rte_mbuf *pkts[];
-	/**< Pending packets to be sent on explicit flush or when full */
 };
 
 /**
@@ -3487,16 +3490,16 @@ rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
  * eth device.
  */
 enum rte_eth_event_ipsec_subtype {
+	/** Unknown event type */
 	RTE_ETH_EVENT_IPSEC_UNKNOWN = 0,
-			/**< Unknown event type */
+	/** Sequence number overflow */
 	RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW,
-			/**< Sequence number overflow */
+	/** Soft time expiry of SA */
 	RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY,
-			/**< Soft time expiry of SA */
+	/** Soft byte expiry of SA */
 	RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY,
-			/**< Soft byte expiry of SA */
+	/** Max value of this enum */
 	RTE_ETH_EVENT_IPSEC_MAX
-			/**< Max value of this enum */
 };
 
 /**
@@ -3504,22 +3507,23 @@ enum rte_eth_event_ipsec_subtype {
  * information of the IPsec offload event.
  */
 struct rte_eth_event_ipsec_desc {
+	/** Type of RTE_ETH_EVENT_IPSEC_* event */
 	enum rte_eth_event_ipsec_subtype subtype;
-			/**< Type of RTE_ETH_EVENT_IPSEC_* event */
+	/**
+	 * Event specific metadata.
+	 *
+	 * For the following events, *userdata* registered
+	 * with the *rte_security_session* would be returned
+	 * as metadata,
+	 *
+	 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
+	 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
+	 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
+	 *
+	 * @see struct rte_security_session_conf
+	 *
+	 */
 	uint64_t metadata;
-			/**< Event specific metadata
-			 *
-			 * For the following events, *userdata* registered
-			 * with the *rte_security_session* would be returned
-			 * as metadata,
-			 *
-			 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
-			 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
-			 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
-			 *
-			 * @see struct rte_security_session_conf
-			 *
-			 */
 };
 
 /**
@@ -3528,10 +3532,10 @@ struct rte_eth_event_ipsec_desc {
 enum rte_eth_event_type {
 	RTE_ETH_EVENT_UNKNOWN,  /**< unknown event type */
 	RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
+	/** queue state event (enabled/disabled) */
 	RTE_ETH_EVENT_QUEUE_STATE,
-				/**< queue state event (enabled/disabled) */
+	/** reset interrupt event, sent to VF on PF reset */
 	RTE_ETH_EVENT_INTR_RESET,
-			/**< reset interrupt event, sent to VF on PF reset */
 	RTE_ETH_EVENT_VF_MBOX,  /**< message from the VF received by PF */
 	RTE_ETH_EVENT_MACSEC,   /**< MACsec offload related event */
 	RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
@@ -3542,9 +3546,9 @@ enum rte_eth_event_type {
 	RTE_ETH_EVENT_MAX       /**< max value of this enum */
 };
 
+/** User application callback to be registered for interrupts. */
 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
 		enum rte_eth_event_type event, void *cb_arg, void *ret_param);
-/**< user application callback to be registered for interrupts */
 
 /**
  * Register a callback function for port event.
diff --git a/lib/ethdev/rte_ethdev_core.h b/lib/ethdev/rte_ethdev_core.h
index 2b8660c578..18d725fca1 100644
--- a/lib/ethdev/rte_ethdev_core.h
+++ b/lib/ethdev/rte_ethdev_core.h
@@ -25,30 +25,36 @@ RTE_TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
 
 struct rte_eth_dev;
 
+/**
+ * @internal Retrieve input packets from a receive queue of an Ethernet device.
+ */
 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
 				   struct rte_mbuf **rx_pkts,
 				   uint16_t nb_pkts);
-/**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
 
+/**
+ * @internal Send output packets on a transmit queue of an Ethernet device.
+ */
 typedef uint16_t (*eth_tx_burst_t)(void *txq,
 				   struct rte_mbuf **tx_pkts,
 				   uint16_t nb_pkts);
-/**< @internal Send output packets on a transmit queue of an Ethernet device. */
 
+/**
+ * @internal Prepare output packets on a transmit queue of an Ethernet device.
+ */
 typedef uint16_t (*eth_tx_prep_t)(void *txq,
 				   struct rte_mbuf **tx_pkts,
 				   uint16_t nb_pkts);
-/**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
 
 
+/** @internal Get number of used descriptors on a receive queue. */
 typedef uint32_t (*eth_rx_queue_count_t)(void *rxq);
-/**< @internal Get number of used descriptors on a receive queue. */
 
+/** @internal Check the status of a Rx descriptor */
 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
-/**< @internal Check the status of a Rx descriptor */
 
+/** @internal Check the status of a Tx descriptor */
 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
-/**< @internal Check the status of a Tx descriptor */
 
 /**
  * @internal
diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index d5bfdaaaf2..45b360d4ac 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -892,8 +892,8 @@ struct rte_flow_item_vlan {
 		};
 		struct rte_vlan_hdr hdr;
 	};
+	/** Packet header contains at least one more VLAN, after this VLAN. */
 	uint32_t has_more_vlan:1;
-	/**< Packet header contains at least one more VLAN, after this VLAN. */
 	uint32_t reserved:31; /**< Reserved, must be zero. */
 };
 
@@ -935,26 +935,26 @@ static const struct rte_flow_item_ipv4 rte_flow_item_ipv4_mask = {
  */
 struct rte_flow_item_ipv6 {
 	struct rte_ipv6_hdr hdr; /**< IPv6 header definition. */
+	/** Header contains Hop-by-Hop Options extension header. */
 	uint32_t has_hop_ext:1;
-	/**< Header contains Hop-by-Hop Options extension header. */
+	/** Header contains Routing extension header. */
 	uint32_t has_route_ext:1;
-	/**< Header contains Routing extension header. */
+	/** Header contains Fragment extension header. */
 	uint32_t has_frag_ext:1;
-	/**< Header contains Fragment extension header. */
+	/** Header contains Authentication extension header. */
 	uint32_t has_auth_ext:1;
-	/**< Header contains Authentication extension header. */
+	/** Header contains Encapsulation Security Payload extension header. */
 	uint32_t has_esp_ext:1;
-	/**< Header contains Encapsulation Security Payload extension header. */
+	/** Header contains Destination Options extension header. */
 	uint32_t has_dest_ext:1;
-	/**< Header contains Destination Options extension header. */
+	/** Header contains Mobility extension header. */
 	uint32_t has_mobil_ext:1;
-	/**< Header contains Mobility extension header. */
+	/** Header contains Host Identity Protocol extension header. */
 	uint32_t has_hip_ext:1;
-	/**< Header contains Host Identity Protocol extension header. */
+	/** Header contains Shim6 Protocol extension header. */
 	uint32_t has_shim6_ext:1;
-	/**< Header contains Shim6 Protocol extension header. */
+	/** Reserved for future extension headers, must be zero. */
 	uint32_t reserved:23;
-	/**< Reserved for future extension headers, must be zero. */
 };
 
 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6. */
@@ -2597,8 +2597,8 @@ struct rte_flow_action_queue {
 struct rte_flow_action_age {
 	uint32_t timeout:24; /**< Time in seconds. */
 	uint32_t reserved:8; /**< Reserved, must be zero. */
+	/** The user flow context, NULL means the rte_flow pointer. */
 	void *context;
-		/**< The user flow context, NULL means the rte_flow pointer. */
 };
 
 /**
@@ -2610,8 +2610,8 @@ struct rte_flow_action_age {
 struct rte_flow_query_age {
 	uint32_t reserved:6; /**< Reserved, must be zero. */
 	uint32_t aged:1; /**< 1 if aging timeout expired, 0 otherwise. */
+	/** sec_since_last_hit value is valid. */
 	uint32_t sec_since_last_hit_valid:1;
-	/**< sec_since_last_hit value is valid. */
 	uint32_t sec_since_last_hit:24; /**< Seconds since last traffic hit. */
 };
 
@@ -3242,7 +3242,7 @@ struct rte_flow_action_conntrack {
 	uint32_t last_direction:1;
 	/** No TCP check will be done except the state change. */
 	uint32_t liberal_mode:1;
-	/**<The current state of this connection. */
+	/** The current state of this connection. */
 	enum rte_flow_conntrack_state state;
 	/** Scaling factor for maximal allowed ACK window. */
 	uint8_t max_ack_window;
@@ -3355,9 +3355,9 @@ struct rte_flow_action_modify_data {
 	RTE_STD_C11
 	union {
 		struct {
-			/**< Encapsulation level or tag index. */
+			/** Encapsulation level or tag index. */
 			uint32_t level;
-			/**< Number of bits to skip from a field. */
+			/** Number of bits to skip from a field. */
 			uint32_t offset;
 		};
 		/**
@@ -3468,8 +3468,8 @@ struct rte_flow;
  */
 struct rte_flow_action_sample {
 	uint32_t ratio; /**< packets sampled equals to '1/ratio'. */
+	/** sub-action list specific for the sampling hit cases. */
 	const struct rte_flow_action *actions;
-		/**< sub-action list specific for the sampling hit cases. */
 };
 
 /**
@@ -4101,10 +4101,10 @@ struct rte_flow_indir_action_conf {
 	 * Action should be valid at least for one flow direction,
 	 * otherwise it is invalid for both ingress and egress rules.
 	 */
+	/** Action valid for rules applied to ingress traffic. */
 	uint32_t ingress:1;
-	/**< Action valid for rules applied to ingress traffic. */
+	/** Action valid for rules applied to egress traffic. */
 	uint32_t egress:1;
-	/**< Action valid for rules applied to egress traffic. */
 	/**
 	 * When set to 1, indicates that the action is valid for
 	 * transfer traffic; otherwise, for non-transfer traffic.
diff --git a/lib/ethdev/rte_mtr_driver.h b/lib/ethdev/rte_mtr_driver.h
index 62273ed3a9..ee8c6ef7ad 100644
--- a/lib/ethdev/rte_mtr_driver.h
+++ b/lib/ethdev/rte_mtr_driver.h
@@ -25,91 +25,91 @@
 extern "C" {
 #endif
 
+/** @internal MTR capabilities get. */
 typedef int (*rte_mtr_capabilities_get_t)(struct rte_eth_dev *dev,
 	struct rte_mtr_capabilities *cap,
 	struct rte_mtr_error *error);
-/**< @internal MTR capabilities get */
 
+/** @internal MTR meter profile add. */
 typedef int (*rte_mtr_meter_profile_add_t)(struct rte_eth_dev *dev,
 	uint32_t meter_profile_id,
 	struct rte_mtr_meter_profile *profile,
 	struct rte_mtr_error *error);
-/**< @internal MTR meter profile add */
 
+/** @internal MTR meter profile delete. */
 typedef int (*rte_mtr_meter_profile_delete_t)(struct rte_eth_dev *dev,
 	uint32_t meter_profile_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR meter profile delete */
 
+/** @internal MTR meter policy validate. */
 typedef int (*rte_mtr_meter_policy_validate_t)(struct rte_eth_dev *dev,
 	struct rte_mtr_meter_policy_params *policy,
 	struct rte_mtr_error *error);
-/**< @internal MTR meter policy validate */
 
+/** @internal MTR meter policy add. */
 typedef int (*rte_mtr_meter_policy_add_t)(struct rte_eth_dev *dev,
 	uint32_t policy_id,
 	struct rte_mtr_meter_policy_params *policy,
 	struct rte_mtr_error *error);
-/**< @internal MTR meter policy add */
 
+/** @internal MTR meter policy delete. */
 typedef int (*rte_mtr_meter_policy_delete_t)(struct rte_eth_dev *dev,
 	uint32_t policy_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR meter policy delete */
 
+/** @internal MTR object create. */
 typedef int (*rte_mtr_create_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	struct rte_mtr_params *params,
 	int shared,
 	struct rte_mtr_error *error);
-/**< @internal MTR object create */
 
+/** @internal MTR object destroy. */
 typedef int (*rte_mtr_destroy_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR object destroy */
 
+/** @internal MTR object meter enable. */
 typedef int (*rte_mtr_meter_enable_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR object meter enable */
 
+/** @internal MTR object meter disable. */
 typedef int (*rte_mtr_meter_disable_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR object meter disable */
 
+/** @internal MTR object meter profile update. */
 typedef int (*rte_mtr_meter_profile_update_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	uint32_t meter_profile_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR object meter profile update */
 
+/** @internal MTR object meter policy update. */
 typedef int (*rte_mtr_meter_policy_update_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	uint32_t meter_policy_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR object meter policy update */
 
+/** @internal MTR object meter DSCP table update. */
 typedef int (*rte_mtr_meter_dscp_table_update_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	enum rte_color *dscp_table,
 	struct rte_mtr_error *error);
-/**< @internal MTR object meter DSCP table update */
 
+/** @internal MTR object enabled stats update. */
 typedef int (*rte_mtr_stats_update_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	uint64_t stats_mask,
 	struct rte_mtr_error *error);
-/**< @internal MTR object enabled stats update */
 
+/** @internal MTR object stats read. */
 typedef int (*rte_mtr_stats_read_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	struct rte_mtr_stats *stats,
 	uint64_t *stats_mask,
 	int clear,
 	struct rte_mtr_error *error);
-/**< @internal MTR object stats read */
 
 struct rte_mtr_ops {
 	/** MTR capabilities get */
-- 
2.30.2

Re: [dpdk-dev] [PATCH v2 1/9] ethdev: avoid documentation in next lines

[Ori Kam]

> -----Original Message-----
> From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> Sent: Wednesday, October 20, 2021 10:43 AM
> To: Ferruh Yigit <ferruh.yigit@intel.com>; NBU-Contact-Thomas Monjalon <thomas@monjalon.net>;
> Ori Kam <orika@nvidia.com>; Cristian Dumitrescu <cristian.dumitrescu@intel.com>
> Cc: dev@dpdk.org
> Subject: [PATCH v2 1/9] ethdev: avoid documentation in next lines
> 
> Documentation in the next separate line is confusing. If documentation
> requires own line it should be before, not after.
> 
> Fix a number of incorrect markups on the way.
> 
> When corresponding lines are touched by the patch anyway, add
> missing full stop to defined types description.
> 
> Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> ---
>  lib/ethdev/ethdev_driver.h   | 270 ++++++++++++++++++-----------------
>  lib/ethdev/rte_ethdev.h      | 134 ++++++++---------
>  lib/ethdev/rte_ethdev_core.h |  18 ++-
>  lib/ethdev/rte_flow.h        |  38 ++---
>  lib/ethdev/rte_mtr_driver.h  |  30 ++--
>  5 files changed, 254 insertions(+), 236 deletions(-)
> 
> diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
> index 0174ba03d7..8800c9c067 100644
> --- a/lib/ethdev/ethdev_driver.h
> +++ b/lib/ethdev/ethdev_driver.h
> @@ -44,18 +44,17 @@ struct rte_eth_rxtx_callback {
>  struct rte_eth_dev {
>  	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
>  	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
> +	/** Pointer to PMD transmit prepare function. */
>  	eth_tx_prep_t tx_pkt_prepare;
> -	/**< Pointer to PMD transmit prepare function. */
> +	/** Get the number of used RX descriptors. */
>  	eth_rx_queue_count_t rx_queue_count;
> -	/**< Get the number of used RX descriptors. */
> +	/** Check the status of a Rx descriptor. */
>  	eth_rx_descriptor_status_t rx_descriptor_status;
> -	/**< Check the status of a Rx descriptor. */
> +	/** Check the status of a Tx descriptor. */
>  	eth_tx_descriptor_status_t tx_descriptor_status;
> -	/**< Check the status of a Tx descriptor. */
> 
>  	/**
> -	 * points to device data that is shared between
> -	 * primary and secondary processes.
> +	 * Device data that is shared between primary and secondary processes.
>  	 */
>  	struct rte_eth_dev_data *data;
>  	void *process_private; /**< Pointer to per-process device data. */
> @@ -100,64 +99,63 @@ struct rte_eth_dev_data {
> 
>  	struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
> 
> +	/** PMD-specific private data. @see rte_eth_dev_release_port(). */
>  	void *dev_private;
> -			/**< PMD-specific private data.
> -			 *   @see rte_eth_dev_release_port()
> -			 */
> 
>  	struct rte_eth_link dev_link;   /**< Link-level information & status. */
>  	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
>  	uint16_t mtu;                   /**< Maximum Transmission Unit. */
> +	/** Common RX buffer size handled by all queues. */
>  	uint32_t min_rx_buf_size;
> -			/**< Common RX buffer size handled by all queues. */
> 
>  	uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
> +	/** Device Ethernet link address. @see rte_eth_dev_release_port(). */
>  	struct rte_ether_addr *mac_addrs;
> -			/**< Device Ethernet link address.
> -			 *   @see rte_eth_dev_release_port()
> -			 */
> +	/** Bitmap associating MAC addresses to pools. */
>  	uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
> -			/**< Bitmap associating MAC addresses to pools. */
> +	/**
> +	 * Device Ethernet MAC addresses of hash filtering.
> +	 * @see rte_eth_dev_release_port()
> +	 */
>  	struct rte_ether_addr *hash_mac_addrs;
> -			/**< Device Ethernet MAC addresses of hash filtering.
> -			 *   @see rte_eth_dev_release_port()
> -			 */
>  	uint16_t port_id;           /**< Device [external] port identifier. */
> 
>  	__extension__
> -	uint8_t promiscuous   : 1,
> -		/**< RX promiscuous mode ON(1) / OFF(0). */
> +	uint8_t /** RX promiscuous mode ON(1) / OFF(0). */
> +		promiscuous   : 1,
> +		/** RX of scattered packets is ON(1) / OFF(0) */
>  		scattered_rx : 1,
> -		/**< RX of scattered packets is ON(1) / OFF(0) */
> +		/** RX all multicast mode ON(1) / OFF(0). */
>  		all_multicast : 1,
> -		/**< RX all multicast mode ON(1) / OFF(0). */
> +		/** Device state: STARTED(1) / STOPPED(0). */
>  		dev_started : 1,
> -		/**< Device state: STARTED(1) / STOPPED(0). */
> +		/** RX LRO is ON(1) / OFF(0) */
>  		lro         : 1,
> -		/**< RX LRO is ON(1) / OFF(0) */
> -		dev_configured : 1;
> -		/**< Indicates whether the device is configured.
> -		 *   CONFIGURED(1) / NOT CONFIGURED(0).
> +		/**
> +		 * Indicates whether the device is configured.
> +		 * CONFIGURED(1) / NOT CONFIGURED(0).
>  		 */
> +		dev_configured : 1;
> +	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
>  	uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
> -		/**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
> +	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
>  	uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
> -		/**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
>  	uint32_t dev_flags;             /**< Capabilities. */
>  	int numa_node;                  /**< NUMA node connection. */
> +	/** VLAN filter configuration. */
>  	struct rte_vlan_filter_conf vlan_filter_conf;
> -			/**< VLAN filter configuration. */
>  	struct rte_eth_dev_owner owner; /**< The port owner. */
> +	/**
> +	 * Switch-specific identifier.
> +	 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
> +	 */
>  	uint16_t representor_id;
> -			/**< Switch-specific identifier.
> -			 *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
> -			 */
> +	/**
> +	 * Port ID of the backing device.
> +	 * This device will be used to query representor info and calculate
> +	 * representor IDs. Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
> +	 */
>  	uint16_t backer_port_id;
> -			/**< Port ID of the backing device.
> -			 *   This device will be used to query representor
> -			 *   info and calculate representor IDs.
> -			 *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
> -			 */
> 
>  	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
>  	uint64_t reserved_64s[4]; /**< Reserved for future fields */
> @@ -171,7 +169,7 @@ struct rte_eth_dev_data {
>   */
>  extern struct rte_eth_dev rte_eth_devices[];
> 
> -/**< @internal Declaration of the hairpin peer queue information structure. */
> +/** @internal Declaration of the hairpin peer queue information structure. */
>  struct rte_hairpin_peer_info;
> 
>  /*
> @@ -180,29 +178,29 @@ struct rte_hairpin_peer_info;
>   * structure associated with an Ethernet device.
>   */
> 
> +/** @internal Ethernet device configuration. */
>  typedef int  (*eth_dev_configure_t)(struct rte_eth_dev *dev);
> -/**< @internal Ethernet device configuration. */
> 
> +/** @internal Function used to start a configured Ethernet device. */
>  typedef int  (*eth_dev_start_t)(struct rte_eth_dev *dev);
> -/**< @internal Function used to start a configured Ethernet device. */
> 
> +/** @internal Function used to stop a configured Ethernet device. */
>  typedef int (*eth_dev_stop_t)(struct rte_eth_dev *dev);
> -/**< @internal Function used to stop a configured Ethernet device. */
> 
> +/** @internal Function used to link up a configured Ethernet device. */
>  typedef int  (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
> -/**< @internal Function used to link up a configured Ethernet device. */
> 
> +/** @internal Function used to link down a configured Ethernet device. */
>  typedef int  (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
> -/**< @internal Function used to link down a configured Ethernet device. */
> 
> +/** @internal Function used to close a configured Ethernet device. */
>  typedef int (*eth_dev_close_t)(struct rte_eth_dev *dev);
> -/**< @internal Function used to close a configured Ethernet device. */
> 
> +/** @internal Function used to reset a configured Ethernet device. */
>  typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
> -/** <@internal Function used to reset a configured Ethernet device. */
> 
> +/** @internal Function used to detect an Ethernet device removal. */
>  typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
> -/**< @internal Function used to detect an Ethernet device removal. */
> 
>  /**
>   * @internal
> @@ -304,13 +302,16 @@ typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
>   */
>  typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
> 
> +/**
> + * @internal
> + * Get link speed, duplex mode and state (up/down) of an Ethernet device.
> + */
>  typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
>  				int wait_to_complete);
> -/**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
> 
> +/** @internal Get global I/O statistics of an Ethernet device. */
>  typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
>  				struct rte_eth_stats *igb_stats);
> -/**< @internal Get global I/O statistics of an Ethernet device. */
> 
>  /**
>   * @internal
> @@ -333,9 +334,9 @@ typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
>   */
>  typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);
> 
> +/** @internal Get extended stats of an Ethernet device. */
>  typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
>  	struct rte_eth_xstat *stats, unsigned int n);
> -/**< @internal Get extended stats of an Ethernet device. */
> 
>  /**
>   * @internal
> @@ -381,9 +382,9 @@ typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
>   */
>  typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
> 
> +/** @internal Get names of extended stats of an Ethernet device. */
>  typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
>  	struct rte_eth_xstat_name *xstats_names, unsigned int size);
> -/**< @internal Get names of extended stats of an Ethernet device. */
> 
>  /**
>   * @internal
> @@ -407,18 +408,21 @@ typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
>  	const uint64_t *ids, struct rte_eth_xstat_name *xstats_names,
>  	unsigned int size);
> 
> +/**
> + * @internal
> + * Set a queue statistics mapping for a tx/rx queue of an Ethernet device.
> + */
>  typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
>  					     uint16_t queue_id,
>  					     uint8_t stat_idx,
>  					     uint8_t is_rx);
> -/**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
> 
> +/** @internal Get specific information of an Ethernet device. */
>  typedef int (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
>  				   struct rte_eth_dev_info *dev_info);
> -/**< @internal Get specific information of an Ethernet device. */
> 
> +/** @internal Get supported ptypes of an Ethernet device. */
>  typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
> -/**< @internal Get supported ptypes of an Ethernet device. */
> 
>  /**
>   * @internal
> @@ -435,47 +439,47 @@ typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct
> rte_eth_dev *de
>  typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
>  				     uint32_t ptype_mask);
> 
> +/** @internal Start rx and tx of a queue of an Ethernet device. */
>  typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
>  				    uint16_t queue_id);
> -/**< @internal Start rx and tx of a queue of an Ethernet device. */
> 
> +/** @internal Stop rx and tx of a queue of an Ethernet device. */
>  typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
>  				    uint16_t queue_id);
> -/**< @internal Stop rx and tx of a queue of an Ethernet device. */
> 
> +/** @internal Set up a receive queue of an Ethernet device. */
>  typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
>  				    uint16_t rx_queue_id,
>  				    uint16_t nb_rx_desc,
>  				    unsigned int socket_id,
>  				    const struct rte_eth_rxconf *rx_conf,
>  				    struct rte_mempool *mb_pool);
> -/**< @internal Set up a receive queue of an Ethernet device. */
> 
> +/** @internal Setup a transmit queue of an Ethernet device. */
>  typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
>  				    uint16_t tx_queue_id,
>  				    uint16_t nb_tx_desc,
>  				    unsigned int socket_id,
>  				    const struct rte_eth_txconf *tx_conf);
> -/**< @internal Setup a transmit queue of an Ethernet device. */
> 
> +/** @internal Enable interrupt of a receive queue of an Ethernet device. */
>  typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
>  				    uint16_t rx_queue_id);
> -/**< @internal Enable interrupt of a receive queue of an Ethernet device. */
> 
> +/** @internal Disable interrupt of a receive queue of an Ethernet device. */
>  typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
>  				    uint16_t rx_queue_id);
> -/**< @internal Disable interrupt of a receive queue of an Ethernet device. */
> 
> +/** @internal Release memory resources allocated by given RX/TX queue. */
>  typedef void (*eth_queue_release_t)(struct rte_eth_dev *dev,
>  				    uint16_t queue_id);
> -/**< @internal Release memory resources allocated by given RX/TX queue. */
> 
> +/** @internal Get firmware information of an Ethernet device. */
>  typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
>  				     char *fw_version, size_t fw_size);
> -/**< @internal Get firmware information of an Ethernet device. */
> 
> +/** @internal Force mbufs to be from TX ring. */
>  typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
> -/**< @internal Force mbufs to be from TX ring. */
> 
>  typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
>  	uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
> @@ -486,159 +490,159 @@ typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
>  typedef int (*eth_burst_mode_get_t)(struct rte_eth_dev *dev,
>  	uint16_t queue_id, struct rte_eth_burst_mode *mode);
> 
> +/** @internal Set MTU. */
>  typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
> -/**< @internal Set MTU. */
> 
> +/** @internal Filtering of a VLAN Tag Identifier by an Ethernet device. */
>  typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
>  				  uint16_t vlan_id,
>  				  int on);
> -/**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
> 
> +/** @internal Set the outer/inner VLAN-TPID by an Ethernet device. */
>  typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
>  			       enum rte_vlan_type type, uint16_t tpid);
> -/**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
> 
> +/** @internal Set VLAN offload function by an Ethernet device. */
>  typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
> -/**< @internal set VLAN offload function by an Ethernet device. */
> 
> +/** @internal Set port based TX VLAN insertion by an Ethernet device. */
>  typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
>  			       uint16_t vlan_id,
>  			       int on);
> -/**< @internal set port based TX VLAN insertion by an Ethernet device. */
> 
> +/** @internal VLAN stripping enable/disable by an queue of Ethernet device. */
>  typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
>  				  uint16_t rx_queue_id,
>  				  int on);
> -/**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
> 
> +/** @internal Get current flow control parameter on an Ethernet device. */
>  typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
>  			       struct rte_eth_fc_conf *fc_conf);
> -/**< @internal Get current flow control parameter on an Ethernet device */
> 
> +/** @internal Setup flow control parameter on an Ethernet device. */
>  typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
>  			       struct rte_eth_fc_conf *fc_conf);
> -/**< @internal Setup flow control parameter on an Ethernet device */
> 
> +/** @internal Setup priority flow control parameter on an Ethernet device. */
>  typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
>  				struct rte_eth_pfc_conf *pfc_conf);
> -/**< @internal Setup priority flow control parameter on an Ethernet device */
> 
> +/** @internal Update RSS redirection table on an Ethernet device. */
>  typedef int (*reta_update_t)(struct rte_eth_dev *dev,
>  			     struct rte_eth_rss_reta_entry64 *reta_conf,
>  			     uint16_t reta_size);
> -/**< @internal Update RSS redirection table on an Ethernet device */
> 
> +/** @internal Query RSS redirection table on an Ethernet device. */
>  typedef int (*reta_query_t)(struct rte_eth_dev *dev,
>  			    struct rte_eth_rss_reta_entry64 *reta_conf,
>  			    uint16_t reta_size);
> -/**< @internal Query RSS redirection table on an Ethernet device */
> 
> +/** @internal Update RSS hash configuration of an Ethernet device. */
>  typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
>  				 struct rte_eth_rss_conf *rss_conf);
> -/**< @internal Update RSS hash configuration of an Ethernet device */
> 
> +/** @internal Get current RSS hash configuration of an Ethernet device. */
>  typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
>  				   struct rte_eth_rss_conf *rss_conf);
> -/**< @internal Get current RSS hash configuration of an Ethernet device */
> 
> +/** @internal Turn on SW controllable LED on an Ethernet device. */
>  typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
> -/**< @internal Turn on SW controllable LED on an Ethernet device */
> 
> +/** @internal Turn off SW controllable LED on an Ethernet device. */
>  typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
> -/**< @internal Turn off SW controllable LED on an Ethernet device */
> 
> +/** @internal Remove MAC address from receive address register. */
>  typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
> -/**< @internal Remove MAC address from receive address register */
> 
> +/** @internal Set a MAC address into Receive Address Register. */
>  typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
>  				  struct rte_ether_addr *mac_addr,
>  				  uint32_t index,
>  				  uint32_t vmdq);
> -/**< @internal Set a MAC address into Receive Address Register */
> 
> +/** @internal Set a MAC address into Receive Address Register. */
>  typedef int (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
>  				  struct rte_ether_addr *mac_addr);
> -/**< @internal Set a MAC address into Receive Address Register */
> 
> +/** @internal Set a Unicast Hash bitmap. */
>  typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
>  				  struct rte_ether_addr *mac_addr,
>  				  uint8_t on);
> -/**< @internal Set a Unicast Hash bitmap */
> 
> +/** @internal Set all Unicast Hash bitmap. */
>  typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
>  				  uint8_t on);
> -/**< @internal Set all Unicast Hash bitmap */
> 
> +/** @internal Set queue TX rate. */
>  typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
>  				uint16_t queue_idx,
>  				uint16_t tx_rate);
> -/**< @internal Set queue TX rate */
> 
> +/** @internal Add tunneling UDP port. */
>  typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
>  					 struct rte_eth_udp_tunnel *tunnel_udp);
> -/**< @internal Add tunneling UDP port */
> 
> +/** @internal Delete tunneling UDP port. */
>  typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
>  					 struct rte_eth_udp_tunnel *tunnel_udp);
> -/**< @internal Delete tunneling UDP port */
> 
> +/** @internal set the list of multicast addresses on an Ethernet device. */
>  typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
>  				      struct rte_ether_addr *mc_addr_set,
>  				      uint32_t nb_mc_addr);
> -/**< @internal set the list of multicast addresses on an Ethernet device */
> 
> +/** @internal Function used to enable IEEE1588/802.1AS timestamping. */
>  typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
> -/**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
> 
> +/** @internal Function used to disable IEEE1588/802.1AS timestamping. */
>  typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
> -/**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
> 
> +/** @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
>  typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
>  						struct timespec *timestamp,
>  						uint32_t flags);
> -/**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
> 
> +/** @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
>  typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
>  						struct timespec *timestamp);
> -/**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
> 
> +/** @internal Function used to adjust the device clock. */
>  typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
> -/**< @internal Function used to adjust the device clock */
> 
> +/** @internal Function used to get time from the device clock. */
>  typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
>  				      struct timespec *timestamp);
> -/**< @internal Function used to get time from the device clock. */
> 
> +/** @internal Function used to get time from the device clock. */
>  typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
>  				       const struct timespec *timestamp);
> -/**< @internal Function used to get time from the device clock */
> 
> +/** @internal Function used to get the current value of the device clock. */
>  typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
>  				      uint64_t *timestamp);
> -/**< @internal Function used to get the current value of the device clock. */
> 
> +/** @internal Retrieve registers. */
>  typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
>  				struct rte_dev_reg_info *info);
> -/**< @internal Retrieve registers  */
> 
> +/** @internal Retrieve eeprom size. */
>  typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
> -/**< @internal Retrieve eeprom size  */
> 
> +/** @internal Retrieve eeprom data. */
>  typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
>  				struct rte_dev_eeprom_info *info);
> -/**< @internal Retrieve eeprom data  */
> 
> +/** @internal Program eeprom data. */
>  typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
>  				struct rte_dev_eeprom_info *info);
> -/**< @internal Program eeprom data  */
> 
> +/** @internal Retrieve type and size of plugin module eeprom. */
>  typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
>  				     struct rte_eth_dev_module_info *modinfo);
> -/**< @internal Retrieve type and size of plugin module eeprom */
> 
> +/** @internal Retrieve plugin module eeprom data. */
>  typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
>  				       struct rte_dev_eeprom_info *info);
> -/**< @internal Retrieve plugin module eeprom data */
> 
>  struct rte_flow_ops;
>  /**
> @@ -651,19 +655,19 @@ struct rte_flow_ops;
>  typedef int (*eth_flow_ops_get_t)(struct rte_eth_dev *dev,
>  				  const struct rte_flow_ops **ops);
> 
> +/** @internal Get Traffic Management (TM) operations on an Ethernet device. */
>  typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
> -/**< @internal Get Traffic Management (TM) operations on an Ethernet device */
> 
> +/** @internal Get Traffic Metering and Policing (MTR) operations. */
>  typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
> -/**< @internal Get Traffic Metering and Policing (MTR) operations */
> 
> +/** @internal Get dcb information on an Ethernet device. */
>  typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
>  				 struct rte_eth_dcb_info *dcb_info);
> -/**< @internal Get dcb information on an Ethernet device */
> 
> +/** @internal Test if a port supports specific mempool ops. */
>  typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
>  						const char *pool);
> -/**< @internal Test if a port supports specific mempool ops */
> 
>  /**
>   * @internal
> @@ -905,20 +909,20 @@ typedef int (*eth_hairpin_bind_t)(struct rte_eth_dev *dev,
>  typedef int (*eth_hairpin_unbind_t)(struct rte_eth_dev *dev,
>  				  uint16_t rx_port);
> 
> +/** @internal Update and fetch peer queue information. */
>  typedef int (*eth_hairpin_queue_peer_update_t)
>  	(struct rte_eth_dev *dev, uint16_t peer_queue,
>  	 struct rte_hairpin_peer_info *current_info,
>  	 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
> -/**< @internal Update and fetch peer queue information. */
> 
> +/** @internal Bind peer queue to the current queue with fetched information. */
>  typedef int (*eth_hairpin_queue_peer_bind_t)
>  	(struct rte_eth_dev *dev, uint16_t cur_queue,
>  	 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
> -/**< @internal Bind peer queue to the current queue with fetched information. */
> 
> +/** @internal Unbind peer queue from the current queue. */
>  typedef int (*eth_hairpin_queue_peer_unbind_t)
>  	(struct rte_eth_dev *dev, uint16_t cur_queue, uint32_t direction);
> -/**< @internal Unbind peer queue from the current queue. */
> 
>  /**
>   * @internal
> @@ -992,8 +996,8 @@ struct eth_dev_ops {
>  	eth_dev_close_t            dev_close;     /**< Close device. */
>  	eth_dev_reset_t		   dev_reset;	  /**< Reset device. */
>  	eth_link_update_t          link_update;   /**< Get device link state. */
> +	/** Check if the device was physically removed. */
>  	eth_is_removed_t           is_removed;
> -	/**< Check if the device was physically removed. */
> 
>  	eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON. */
>  	eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF. */
> @@ -1009,10 +1013,10 @@ struct eth_dev_ops {
>  	eth_stats_reset_t          stats_reset;   /**< Reset generic device statistics. */
>  	eth_xstats_get_t           xstats_get;    /**< Get extended device statistics. */
>  	eth_xstats_reset_t         xstats_reset;  /**< Reset extended device statistics. */
> +	/** Get names of extended statistics. */
>  	eth_xstats_get_names_t     xstats_get_names;
> -	/**< Get names of extended statistics. */
> +	/** Configure per queue stat counter mapping. */
>  	eth_queue_stats_mapping_set_t queue_stats_mapping_set;
> -	/**< Configure per queue stat counter mapping. */
> 
>  	eth_dev_infos_get_t        dev_infos_get; /**< Get device info. */
>  	eth_rxq_info_get_t         rxq_info_get; /**< retrieve RX queue information. */
> @@ -1020,10 +1024,13 @@ struct eth_dev_ops {
>  	eth_burst_mode_get_t       rx_burst_mode_get; /**< Get RX burst mode */
>  	eth_burst_mode_get_t       tx_burst_mode_get; /**< Get TX burst mode */
>  	eth_fw_version_get_t       fw_version_get; /**< Get firmware version. */
> +	/** Get packet types supported and identified by device. */
>  	eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
> -	/**< Get packet types supported and identified by device. */
> +	/**
> +	 * Inform Ethernet device about reduced range of packet types to
> +	 * handle.
> +	 */
>  	eth_dev_ptypes_set_t dev_ptypes_set;
> -	/**< Inform Ethernet device about reduced range of packet types to handle. */
> 
>  	vlan_filter_set_t          vlan_filter_set; /**< Filter VLAN Setup. */
>  	vlan_tpid_set_t            vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
> @@ -1092,51 +1099,52 @@ struct eth_dev_ops {
> 
>  	eth_read_clock             read_clock;
> 
> +	/** Get extended device statistic values by ID. */
>  	eth_xstats_get_by_id_t     xstats_get_by_id;
> -	/**< Get extended device statistic values by ID. */
> +	/** Get name of extended device statistics by ID. */
>  	eth_xstats_get_names_by_id_t xstats_get_names_by_id;
> -	/**< Get name of extended device statistics by ID. */
> 
> +	/** Get Traffic Management (TM) operations. */
>  	eth_tm_ops_get_t tm_ops_get;
> -	/**< Get Traffic Management (TM) operations. */
> 
> +	/** Get Traffic Metering and Policing (MTR) operations. */
>  	eth_mtr_ops_get_t mtr_ops_get;
> -	/**< Get Traffic Metering and Policing (MTR) operations. */
> 
> +	/** Test if a port supports specific mempool ops */
>  	eth_pool_ops_supported_t pool_ops_supported;
> -	/**< Test if a port supports specific mempool ops */
> 
> +	/** Returns the hairpin capabilities. */
>  	eth_hairpin_cap_get_t hairpin_cap_get;
> -	/**< Returns the hairpin capabilities. */
> +	/** Set up device RX hairpin queue. */
>  	eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
> -	/**< Set up device RX hairpin queue. */
> +	/** Set up device TX hairpin queue. */
>  	eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
> -	/**< Set up device TX hairpin queue. */
> 
> +	/** Get Forward Error Correction(FEC) capability. */
>  	eth_fec_get_capability_t fec_get_capability;
> -	/**< Get Forward Error Correction(FEC) capability. */
> +	/** Get Forward Error Correction(FEC) mode. */
>  	eth_fec_get_t fec_get;
> -	/**< Get Forward Error Correction(FEC) mode. */
> +	/** Set Forward Error Correction(FEC) mode. */
>  	eth_fec_set_t fec_set;
> -	/**< Set Forward Error Correction(FEC) mode. */
> +
> +	/** Get hairpin peer ports list. */
>  	hairpin_get_peer_ports_t hairpin_get_peer_ports;
> -	/**< Get hairpin peer ports list. */
> +	/** Bind all hairpin Tx queues of device to the peer port Rx queues. */
>  	eth_hairpin_bind_t hairpin_bind;
> -	/**< Bind all hairpin Tx queues of device to the peer port Rx queues. */
> +	/** Unbind all hairpin Tx queues from the peer port Rx queues. */
>  	eth_hairpin_unbind_t hairpin_unbind;
> -	/**< Unbind all hairpin Tx queues from the peer port Rx queues. */
> +	/** Pass the current queue info and get the peer queue info. */
>  	eth_hairpin_queue_peer_update_t hairpin_queue_peer_update;
> -	/**< Pass the current queue info and get the peer queue info. */
> +	/** Set up the connection between the pair of hairpin queues. */
>  	eth_hairpin_queue_peer_bind_t hairpin_queue_peer_bind;
> -	/**< Set up the connection between the pair of hairpin queues. */
> +	/** Disconnect the hairpin queues of a pair from each other. */
>  	eth_hairpin_queue_peer_unbind_t hairpin_queue_peer_unbind;
> -	/**< Disconnect the hairpin queues of a pair from each other. */
> 
> +	/** Get power monitoring condition for Rx queue. */
>  	eth_get_monitor_addr_t get_monitor_addr;
> -	/**< Get power monitoring condition for Rx queue. */
> 
> +	/** Get representor info. */
>  	eth_representor_info_get_t representor_info_get;
> -	/**< Get representor info. */
> 
>  	/**
>  	 * Negotiate the NIC's ability to deliver specific
> diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
> index 69766eaae2..2d43c226f6 100644
> --- a/lib/ethdev/rte_ethdev.h
> +++ b/lib/ethdev/rte_ethdev.h
> @@ -256,24 +256,25 @@ struct rte_eth_stats {
>  	uint64_t opackets;  /**< Total number of successfully transmitted packets.*/
>  	uint64_t ibytes;    /**< Total number of successfully received bytes. */
>  	uint64_t obytes;    /**< Total number of successfully transmitted bytes. */
> -	uint64_t imissed;
> -	/**< Total of RX packets dropped by the HW,
> +	/**
> +	 * Total of RX packets dropped by the HW,
>  	 * because there are no available buffer (i.e. RX queues are full).
>  	 */
> +	uint64_t imissed;
>  	uint64_t ierrors;   /**< Total number of erroneous received packets. */
>  	uint64_t oerrors;   /**< Total number of failed transmitted packets. */
>  	uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
>  	/* Queue stats are limited to max 256 queues */
> +	/** Total number of queue RX packets. */
>  	uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
> -	/**< Total number of queue RX packets. */
> +	/** Total number of queue TX packets. */
>  	uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
> -	/**< Total number of queue TX packets. */
> +	/** Total number of successfully received queue bytes. */
>  	uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
> -	/**< Total number of successfully received queue bytes. */
> +	/** Total number of successfully transmitted queue bytes. */
>  	uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
> -	/**< Total number of successfully transmitted queue bytes. */
> +	/** Total number of queue packets received that are dropped. */
>  	uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
> -	/**< Total number of queue packets received that are dropped. */
>  };
> 
>  /**@{@name Link speed capabilities
> @@ -499,8 +500,8 @@ struct rte_eth_rss_conf {
>  #define RTE_ETH_FLOW_IPV6_EX            15
>  #define RTE_ETH_FLOW_IPV6_TCP_EX        16
>  #define RTE_ETH_FLOW_IPV6_UDP_EX        17
> +/** Consider device port number as a flow differentiator */
>  #define RTE_ETH_FLOW_PORT               18
> -	/**< Consider device port number as a flow differentiator */
>  #define RTE_ETH_FLOW_VXLAN              19 /**< VXLAN protocol based flow */
>  #define RTE_ETH_FLOW_GENEVE             20 /**< GENEVE protocol based flow */
>  #define RTE_ETH_FLOW_NVGRE              21 /**< NVGRE protocol based flow */
> @@ -768,7 +769,7 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
>  	ETH_RSS_S_VLAN  | \
>  	ETH_RSS_C_VLAN)
> 
> -/**< Mask of valid RSS hash protocols */
> +/** Mask of valid RSS hash protocols */
>  #define ETH_RSS_PROTO_MASK ( \
>  	ETH_RSS_IPV4 | \
>  	ETH_RSS_FRAG_IPV4 | \
> @@ -851,10 +852,10 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
>   * is needed.
>   */
>  struct rte_eth_rss_reta_entry64 {
> +	/** Mask bits indicate which entries need to be updated/queried. */
>  	uint64_t mask;
> -	/**< Mask bits indicate which entries need to be updated/queried. */
> +	/** Group of 64 redirection table entries. */
>  	uint16_t reta[RTE_RETA_GROUP_SIZE];
> -	/**< Group of 64 redirection table entries. */
>  };
> 
>  /**
> @@ -920,8 +921,8 @@ struct rte_eth_vmdq_dcb_conf {
>  		uint16_t vlan_id; /**< The vlan id of the received frame */
>  		uint64_t pools;   /**< Bitmask of pools for packet rx */
>  	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
> +	/** Selects a queue in a pool */
>  	uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
> -	/**< Selects a queue in a pool */
>  };
> 
>  /**
> @@ -969,12 +970,12 @@ struct rte_eth_txmode {
> 
>  	uint16_t pvid;
>  	__extension__
> -	uint8_t hw_vlan_reject_tagged : 1,
> -		/**< If set, reject sending out tagged pkts */
> +	uint8_t /** If set, reject sending out tagged pkts */
> +		hw_vlan_reject_tagged : 1,
> +		/** If set, reject sending out untagged pkts */
>  		hw_vlan_reject_untagged : 1,
> -		/**< If set, reject sending out untagged pkts */
> +		/** If set, enable port based VLAN insertion */
>  		hw_vlan_insert_pvid : 1;
> -		/**< If set, enable port based VLAN insertion */
> 
>  	uint64_t reserved_64s[2]; /**< Reserved for future fields */
>  	void *reserved_ptrs[2];   /**< Reserved for future fields */
> @@ -1268,8 +1269,8 @@ struct rte_fdir_conf {
>  	/** RX queue of packets matching a "drop" filter in perfect mode. */
>  	uint8_t drop_queue;
>  	struct rte_eth_fdir_masks mask;
> +	/** Flex payload configuration. */
>  	struct rte_eth_fdir_flex_conf flex_conf;
> -	/**< Flex payload configuration. */
>  };
> 
>  /**
> @@ -1320,20 +1321,20 @@ struct rte_eth_conf {
>  				 are defined in implementation of each driver. */
>  	struct {
>  		struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
> +		/** Port vmdq+dcb configuration. */
>  		struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
> -		/**< Port vmdq+dcb configuration. */
> +		/** Port dcb RX configuration. */
>  		struct rte_eth_dcb_rx_conf dcb_rx_conf;
> -		/**< Port dcb RX configuration. */
> +		/** Port vmdq RX configuration. */
>  		struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
> -		/**< Port vmdq RX configuration. */
>  	} rx_adv_conf; /**< Port RX filtering configuration. */
>  	union {
> +		/** Port vmdq+dcb TX configuration. */
>  		struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
> -		/**< Port vmdq+dcb TX configuration. */
> +		/** Port dcb TX configuration. */
>  		struct rte_eth_dcb_tx_conf dcb_tx_conf;
> -		/**< Port dcb TX configuration. */
> +		/** Port vmdq TX configuration. */
>  		struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
> -		/**< Port vmdq TX configuration. */
>  	} tx_adv_conf; /**< Port TX DCB configuration (union). */
>  	/** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
>  	    is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
> @@ -1400,17 +1401,19 @@ struct rte_eth_conf {
>  #define DEV_TX_OFFLOAD_IPIP_TNL_TSO     0x00000800    /**< Used for tunneling packet. */
>  #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO   0x00001000    /**< Used for tunneling packet. */
>  #define DEV_TX_OFFLOAD_MACSEC_INSERT    0x00002000
> -#define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
> -/**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
> +/**
> + * Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
>   * tx queue without SW lock.
>   */
> +#define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
> +/** Device supports multi segment send. */
>  #define DEV_TX_OFFLOAD_MULTI_SEGS	0x00008000
> -/**< Device supports multi segment send. */
> -#define DEV_TX_OFFLOAD_MBUF_FAST_FREE	0x00010000
> -/**< Device supports optimization for fast release of mbufs.
> - *   When set application must guarantee that per-queue all mbufs comes from
> - *   the same mempool and has refcnt = 1.
> +/**
> + * Device supports optimization for fast release of mbufs.
> + * When set application must guarantee that per-queue all mbufs comes from
> + * the same mempool and has refcnt = 1.
>   */
> +#define DEV_TX_OFFLOAD_MBUF_FAST_FREE	0x00010000
>  #define DEV_TX_OFFLOAD_SECURITY         0x00020000
>  /**
>   * Device supports generic UDP tunneled packet TSO.
> @@ -1479,14 +1482,14 @@ struct rte_eth_dev_portconf {
>  struct rte_eth_switch_info {
>  	const char *name;	/**< switch name */
>  	uint16_t domain_id;	/**< switch domain id */
> -	uint16_t port_id;
> -	/**<
> -	 * mapping to the devices physical switch port as enumerated from the
> +	/**
> +	 * Mapping to the devices physical switch port as enumerated from the
>  	 * perspective of the embedded interconnect/switch. For SR-IOV enabled
>  	 * device this may correspond to the VF_ID of each virtual function,
>  	 * but each driver should explicitly define the mapping of switch
>  	 * port identifier to that physical interconnect/switch
>  	 */
> +	uint16_t port_id;
>  };
> 
>  /**
> @@ -1543,16 +1546,16 @@ struct rte_eth_dev_info {
>  	uint16_t max_vfs; /**< Maximum number of VFs. */
>  	uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
>  	struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/
> +	/** All RX offload capabilities including all per-queue ones */
>  	uint64_t rx_offload_capa;
> -	/**< All RX offload capabilities including all per-queue ones */
> +	/** All TX offload capabilities including all per-queue ones */
>  	uint64_t tx_offload_capa;
> -	/**< All TX offload capabilities including all per-queue ones */
> +	/** Device per-queue RX offload capabilities. */
>  	uint64_t rx_queue_offload_capa;
> -	/**< Device per-queue RX offload capabilities. */
> +	/** Device per-queue TX offload capabilities. */
>  	uint64_t tx_queue_offload_capa;
> -	/**< Device per-queue TX offload capabilities. */
> +	/** Device redirection table size, the total number of entries. */
>  	uint16_t reta_size;
> -	/**< Device redirection table size, the total number of entries. */
>  	uint8_t hash_key_size; /**< Hash key size in bytes */
>  	/** Bit mask of RSS offloads, the bit offset also means flow type */
>  	uint64_t flow_type_rss_offloads;
> @@ -1740,13 +1743,13 @@ struct rte_eth_fec_capa {
>  } while (0)
> 
>  /**@{@name L2 tunnel configuration */
> -/**< l2 tunnel enable mask */
> +/** L2 tunnel enable mask */
>  #define ETH_L2_TUNNEL_ENABLE_MASK       0x00000001
> -/**< l2 tunnel insertion mask */
> +/** L2 tunnel insertion mask */
>  #define ETH_L2_TUNNEL_INSERTION_MASK    0x00000002
> -/**< l2 tunnel stripping mask */
> +/** L2 tunnel stripping mask */
>  #define ETH_L2_TUNNEL_STRIPPING_MASK    0x00000004
> -/**< l2 tunnel forwarding mask */
> +/** L2 tunnel forwarding mask */
>  #define ETH_L2_TUNNEL_FORWARDING_MASK   0x00000008
>  /**@}*/
> 
> @@ -3347,8 +3350,8 @@ struct rte_eth_dev_tx_buffer {
>  	void *error_userdata;
>  	uint16_t size;           /**< Size of buffer for buffered tx */
>  	uint16_t length;         /**< Number of packets in the array */
> +	/** Pending packets to be sent on explicit flush or when full */
>  	struct rte_mbuf *pkts[];
> -	/**< Pending packets to be sent on explicit flush or when full */
>  };
> 
>  /**
> @@ -3487,16 +3490,16 @@ rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t
> free_cnt);
>   * eth device.
>   */
>  enum rte_eth_event_ipsec_subtype {
> +	/** Unknown event type */
>  	RTE_ETH_EVENT_IPSEC_UNKNOWN = 0,
> -			/**< Unknown event type */
> +	/** Sequence number overflow */
>  	RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW,
> -			/**< Sequence number overflow */
> +	/** Soft time expiry of SA */
>  	RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY,
> -			/**< Soft time expiry of SA */
> +	/** Soft byte expiry of SA */
>  	RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY,
> -			/**< Soft byte expiry of SA */
> +	/** Max value of this enum */
>  	RTE_ETH_EVENT_IPSEC_MAX
> -			/**< Max value of this enum */
>  };
> 
>  /**
> @@ -3504,22 +3507,23 @@ enum rte_eth_event_ipsec_subtype {
>   * information of the IPsec offload event.
>   */
>  struct rte_eth_event_ipsec_desc {
> +	/** Type of RTE_ETH_EVENT_IPSEC_* event */
>  	enum rte_eth_event_ipsec_subtype subtype;
> -			/**< Type of RTE_ETH_EVENT_IPSEC_* event */
> +	/**
> +	 * Event specific metadata.
> +	 *
> +	 * For the following events, *userdata* registered
> +	 * with the *rte_security_session* would be returned
> +	 * as metadata,
> +	 *
> +	 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
> +	 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
> +	 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
> +	 *
> +	 * @see struct rte_security_session_conf
> +	 *
> +	 */
>  	uint64_t metadata;
> -			/**< Event specific metadata
> -			 *
> -			 * For the following events, *userdata* registered
> -			 * with the *rte_security_session* would be returned
> -			 * as metadata,
> -			 *
> -			 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
> -			 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
> -			 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
> -			 *
> -			 * @see struct rte_security_session_conf
> -			 *
> -			 */
>  };
> 
>  /**
> @@ -3528,10 +3532,10 @@ struct rte_eth_event_ipsec_desc {
>  enum rte_eth_event_type {
>  	RTE_ETH_EVENT_UNKNOWN,  /**< unknown event type */
>  	RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
> +	/** queue state event (enabled/disabled) */
>  	RTE_ETH_EVENT_QUEUE_STATE,
> -				/**< queue state event (enabled/disabled) */
> +	/** reset interrupt event, sent to VF on PF reset */
>  	RTE_ETH_EVENT_INTR_RESET,
> -			/**< reset interrupt event, sent to VF on PF reset */
>  	RTE_ETH_EVENT_VF_MBOX,  /**< message from the VF received by PF */
>  	RTE_ETH_EVENT_MACSEC,   /**< MACsec offload related event */
>  	RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
> @@ -3542,9 +3546,9 @@ enum rte_eth_event_type {
>  	RTE_ETH_EVENT_MAX       /**< max value of this enum */
>  };
> 
> +/** User application callback to be registered for interrupts. */
>  typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
>  		enum rte_eth_event_type event, void *cb_arg, void *ret_param);
> -/**< user application callback to be registered for interrupts */
> 
>  /**
>   * Register a callback function for port event.
> diff --git a/lib/ethdev/rte_ethdev_core.h b/lib/ethdev/rte_ethdev_core.h
> index 2b8660c578..18d725fca1 100644
> --- a/lib/ethdev/rte_ethdev_core.h
> +++ b/lib/ethdev/rte_ethdev_core.h
> @@ -25,30 +25,36 @@ RTE_TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
> 
>  struct rte_eth_dev;
> 
> +/**
> + * @internal Retrieve input packets from a receive queue of an Ethernet device.
> + */
>  typedef uint16_t (*eth_rx_burst_t)(void *rxq,
>  				   struct rte_mbuf **rx_pkts,
>  				   uint16_t nb_pkts);
> -/**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
> 
> +/**
> + * @internal Send output packets on a transmit queue of an Ethernet device.
> + */
>  typedef uint16_t (*eth_tx_burst_t)(void *txq,
>  				   struct rte_mbuf **tx_pkts,
>  				   uint16_t nb_pkts);
> -/**< @internal Send output packets on a transmit queue of an Ethernet device. */
> 
> +/**
> + * @internal Prepare output packets on a transmit queue of an Ethernet device.
> + */
>  typedef uint16_t (*eth_tx_prep_t)(void *txq,
>  				   struct rte_mbuf **tx_pkts,
>  				   uint16_t nb_pkts);
> -/**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
> 
> 
> +/** @internal Get number of used descriptors on a receive queue. */
>  typedef uint32_t (*eth_rx_queue_count_t)(void *rxq);
> -/**< @internal Get number of used descriptors on a receive queue. */
> 
> +/** @internal Check the status of a Rx descriptor */
>  typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
> -/**< @internal Check the status of a Rx descriptor */
> 
> +/** @internal Check the status of a Tx descriptor */
>  typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
> -/**< @internal Check the status of a Tx descriptor */
> 
>  /**
>   * @internal
> diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
> index d5bfdaaaf2..45b360d4ac 100644
> --- a/lib/ethdev/rte_flow.h
> +++ b/lib/ethdev/rte_flow.h
> @@ -892,8 +892,8 @@ struct rte_flow_item_vlan {
>  		};
>  		struct rte_vlan_hdr hdr;
>  	};
> +	/** Packet header contains at least one more VLAN, after this VLAN. */
>  	uint32_t has_more_vlan:1;
> -	/**< Packet header contains at least one more VLAN, after this VLAN. */
>  	uint32_t reserved:31; /**< Reserved, must be zero. */
>  };
> 
> @@ -935,26 +935,26 @@ static const struct rte_flow_item_ipv4 rte_flow_item_ipv4_mask = {
>   */
>  struct rte_flow_item_ipv6 {
>  	struct rte_ipv6_hdr hdr; /**< IPv6 header definition. */
> +	/** Header contains Hop-by-Hop Options extension header. */
>  	uint32_t has_hop_ext:1;
> -	/**< Header contains Hop-by-Hop Options extension header. */
> +	/** Header contains Routing extension header. */
>  	uint32_t has_route_ext:1;
> -	/**< Header contains Routing extension header. */
> +	/** Header contains Fragment extension header. */
>  	uint32_t has_frag_ext:1;
> -	/**< Header contains Fragment extension header. */
> +	/** Header contains Authentication extension header. */
>  	uint32_t has_auth_ext:1;
> -	/**< Header contains Authentication extension header. */
> +	/** Header contains Encapsulation Security Payload extension header. */
>  	uint32_t has_esp_ext:1;
> -	/**< Header contains Encapsulation Security Payload extension header. */
> +	/** Header contains Destination Options extension header. */
>  	uint32_t has_dest_ext:1;
> -	/**< Header contains Destination Options extension header. */
> +	/** Header contains Mobility extension header. */
>  	uint32_t has_mobil_ext:1;
> -	/**< Header contains Mobility extension header. */
> +	/** Header contains Host Identity Protocol extension header. */
>  	uint32_t has_hip_ext:1;
> -	/**< Header contains Host Identity Protocol extension header. */
> +	/** Header contains Shim6 Protocol extension header. */
>  	uint32_t has_shim6_ext:1;
> -	/**< Header contains Shim6 Protocol extension header. */
> +	/** Reserved for future extension headers, must be zero. */
>  	uint32_t reserved:23;
> -	/**< Reserved for future extension headers, must be zero. */
>  };
> 
>  /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6. */
> @@ -2597,8 +2597,8 @@ struct rte_flow_action_queue {
>  struct rte_flow_action_age {
>  	uint32_t timeout:24; /**< Time in seconds. */
>  	uint32_t reserved:8; /**< Reserved, must be zero. */
> +	/** The user flow context, NULL means the rte_flow pointer. */
>  	void *context;
> -		/**< The user flow context, NULL means the rte_flow pointer. */
>  };
> 
>  /**
> @@ -2610,8 +2610,8 @@ struct rte_flow_action_age {
>  struct rte_flow_query_age {
>  	uint32_t reserved:6; /**< Reserved, must be zero. */
>  	uint32_t aged:1; /**< 1 if aging timeout expired, 0 otherwise. */
> +	/** sec_since_last_hit value is valid. */
>  	uint32_t sec_since_last_hit_valid:1;
> -	/**< sec_since_last_hit value is valid. */
>  	uint32_t sec_since_last_hit:24; /**< Seconds since last traffic hit. */
>  };
> 
> @@ -3242,7 +3242,7 @@ struct rte_flow_action_conntrack {
>  	uint32_t last_direction:1;
>  	/** No TCP check will be done except the state change. */
>  	uint32_t liberal_mode:1;
> -	/**<The current state of this connection. */
> +	/** The current state of this connection. */
>  	enum rte_flow_conntrack_state state;
>  	/** Scaling factor for maximal allowed ACK window. */
>  	uint8_t max_ack_window;
> @@ -3355,9 +3355,9 @@ struct rte_flow_action_modify_data {
>  	RTE_STD_C11
>  	union {
>  		struct {
> -			/**< Encapsulation level or tag index. */
> +			/** Encapsulation level or tag index. */
>  			uint32_t level;
> -			/**< Number of bits to skip from a field. */
> +			/** Number of bits to skip from a field. */
>  			uint32_t offset;
>  		};
>  		/**
> @@ -3468,8 +3468,8 @@ struct rte_flow;
>   */
>  struct rte_flow_action_sample {
>  	uint32_t ratio; /**< packets sampled equals to '1/ratio'. */
> +	/** sub-action list specific for the sampling hit cases. */
>  	const struct rte_flow_action *actions;
> -		/**< sub-action list specific for the sampling hit cases. */
>  };
> 
>  /**
> @@ -4101,10 +4101,10 @@ struct rte_flow_indir_action_conf {
>  	 * Action should be valid at least for one flow direction,
>  	 * otherwise it is invalid for both ingress and egress rules.
>  	 */
> +	/** Action valid for rules applied to ingress traffic. */
>  	uint32_t ingress:1;
> -	/**< Action valid for rules applied to ingress traffic. */
> +	/** Action valid for rules applied to egress traffic. */
>  	uint32_t egress:1;
> -	/**< Action valid for rules applied to egress traffic. */
>  	/**
>  	 * When set to 1, indicates that the action is valid for
>  	 * transfer traffic; otherwise, for non-transfer traffic.
> diff --git a/lib/ethdev/rte_mtr_driver.h b/lib/ethdev/rte_mtr_driver.h
> index 62273ed3a9..ee8c6ef7ad 100644
> --- a/lib/ethdev/rte_mtr_driver.h
> +++ b/lib/ethdev/rte_mtr_driver.h
> @@ -25,91 +25,91 @@
>  extern "C" {
>  #endif
> 
> +/** @internal MTR capabilities get. */
>  typedef int (*rte_mtr_capabilities_get_t)(struct rte_eth_dev *dev,
>  	struct rte_mtr_capabilities *cap,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR capabilities get */
> 
> +/** @internal MTR meter profile add. */
>  typedef int (*rte_mtr_meter_profile_add_t)(struct rte_eth_dev *dev,
>  	uint32_t meter_profile_id,
>  	struct rte_mtr_meter_profile *profile,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR meter profile add */
> 
> +/** @internal MTR meter profile delete. */
>  typedef int (*rte_mtr_meter_profile_delete_t)(struct rte_eth_dev *dev,
>  	uint32_t meter_profile_id,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR meter profile delete */
> 
> +/** @internal MTR meter policy validate. */
>  typedef int (*rte_mtr_meter_policy_validate_t)(struct rte_eth_dev *dev,
>  	struct rte_mtr_meter_policy_params *policy,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR meter policy validate */
> 
> +/** @internal MTR meter policy add. */
>  typedef int (*rte_mtr_meter_policy_add_t)(struct rte_eth_dev *dev,
>  	uint32_t policy_id,
>  	struct rte_mtr_meter_policy_params *policy,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR meter policy add */
> 
> +/** @internal MTR meter policy delete. */
>  typedef int (*rte_mtr_meter_policy_delete_t)(struct rte_eth_dev *dev,
>  	uint32_t policy_id,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR meter policy delete */
> 
> +/** @internal MTR object create. */
>  typedef int (*rte_mtr_create_t)(struct rte_eth_dev *dev,
>  	uint32_t mtr_id,
>  	struct rte_mtr_params *params,
>  	int shared,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR object create */
> 
> +/** @internal MTR object destroy. */
>  typedef int (*rte_mtr_destroy_t)(struct rte_eth_dev *dev,
>  	uint32_t mtr_id,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR object destroy */
> 
> +/** @internal MTR object meter enable. */
>  typedef int (*rte_mtr_meter_enable_t)(struct rte_eth_dev *dev,
>  	uint32_t mtr_id,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR object meter enable */
> 
> +/** @internal MTR object meter disable. */
>  typedef int (*rte_mtr_meter_disable_t)(struct rte_eth_dev *dev,
>  	uint32_t mtr_id,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR object meter disable */
> 
> +/** @internal MTR object meter profile update. */
>  typedef int (*rte_mtr_meter_profile_update_t)(struct rte_eth_dev *dev,
>  	uint32_t mtr_id,
>  	uint32_t meter_profile_id,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR object meter profile update */
> 
> +/** @internal MTR object meter policy update. */
>  typedef int (*rte_mtr_meter_policy_update_t)(struct rte_eth_dev *dev,
>  	uint32_t mtr_id,
>  	uint32_t meter_policy_id,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR object meter policy update */
> 
> +/** @internal MTR object meter DSCP table update. */
>  typedef int (*rte_mtr_meter_dscp_table_update_t)(struct rte_eth_dev *dev,
>  	uint32_t mtr_id,
>  	enum rte_color *dscp_table,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR object meter DSCP table update */
> 
> +/** @internal MTR object enabled stats update. */
>  typedef int (*rte_mtr_stats_update_t)(struct rte_eth_dev *dev,
>  	uint32_t mtr_id,
>  	uint64_t stats_mask,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR object enabled stats update */
> 
> +/** @internal MTR object stats read. */
>  typedef int (*rte_mtr_stats_read_t)(struct rte_eth_dev *dev,
>  	uint32_t mtr_id,
>  	struct rte_mtr_stats *stats,
>  	uint64_t *stats_mask,
>  	int clear,
>  	struct rte_mtr_error *error);
> -/**< @internal MTR object stats read */
> 
>  struct rte_mtr_ops {
>  	/** MTR capabilities get */
> --
> 2.30.2

Acked-by: Ori Kam <orika@nvidia.com>
Best,
Ori

[dpdk-dev] [PATCH v2 2/9] ethdev: fix Rx/Tx spelling

[Andrew Rybchenko]

Fix it everywhere in ethdev including log messages.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h   |  94 ++++++------
 lib/ethdev/ethdev_profile.c  |   4 +-
 lib/ethdev/rte_eth_ctrl.h    |   2 +-
 lib/ethdev/rte_ethdev.c      |  50 +++----
 lib/ethdev/rte_ethdev.h      | 278 +++++++++++++++++------------------
 lib/ethdev/rte_ethdev_core.h |   2 +-
 lib/ethdev/rte_tm.h          |  14 +-
 7 files changed, 222 insertions(+), 222 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 8800c9c067..7deb9911bd 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -20,7 +20,7 @@
 /**
  * @internal
  * Structure used to hold information about the callbacks to be called for a
- * queue on RX and TX.
+ * queue on Rx and Tx.
  */
 struct rte_eth_rxtx_callback {
 	struct rte_eth_rxtx_callback *next;
@@ -46,7 +46,7 @@ struct rte_eth_dev {
 	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
 	/** Pointer to PMD transmit prepare function. */
 	eth_tx_prep_t tx_pkt_prepare;
-	/** Get the number of used RX descriptors. */
+	/** Get the number of used Rx descriptors. */
 	eth_rx_queue_count_t rx_queue_count;
 	/** Check the status of a Rx descriptor. */
 	eth_rx_descriptor_status_t rx_descriptor_status;
@@ -92,10 +92,10 @@ struct rte_eth_dev_owner;
 struct rte_eth_dev_data {
 	char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
 
-	void **rx_queues; /**< Array of pointers to RX queues. */
-	void **tx_queues; /**< Array of pointers to TX queues. */
-	uint16_t nb_rx_queues; /**< Number of RX queues. */
-	uint16_t nb_tx_queues; /**< Number of TX queues. */
+	void **rx_queues; /**< Array of pointers to Rx queues. */
+	void **tx_queues; /**< Array of pointers to Tx queues. */
+	uint16_t nb_rx_queues; /**< Number of Rx queues. */
+	uint16_t nb_tx_queues; /**< Number of Tx queues. */
 
 	struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 
@@ -105,10 +105,10 @@ struct rte_eth_dev_data {
 	struct rte_eth_link dev_link;   /**< Link-level information & status. */
 	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
 	uint16_t mtu;                   /**< Maximum Transmission Unit. */
-	/** Common RX buffer size handled by all queues. */
+	/** Common Rx buffer size handled by all queues. */
 	uint32_t min_rx_buf_size;
 
-	uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
+	uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures. */
 	/** Device Ethernet link address. @see rte_eth_dev_release_port(). */
 	struct rte_ether_addr *mac_addrs;
 	/** Bitmap associating MAC addresses to pools. */
@@ -121,15 +121,15 @@ struct rte_eth_dev_data {
 	uint16_t port_id;           /**< Device [external] port identifier. */
 
 	__extension__
-	uint8_t /** RX promiscuous mode ON(1) / OFF(0). */
+	uint8_t /** Rx promiscuous mode ON(1) / OFF(0). */
 		promiscuous   : 1,
-		/** RX of scattered packets is ON(1) / OFF(0) */
+		/** Rx of scattered packets is ON(1) / OFF(0) */
 		scattered_rx : 1,
-		/** RX all multicast mode ON(1) / OFF(0). */
+		/** Rx all multicast mode ON(1) / OFF(0). */
 		all_multicast : 1,
 		/** Device state: STARTED(1) / STOPPED(0). */
 		dev_started : 1,
-		/** RX LRO is ON(1) / OFF(0) */
+		/** Rx LRO is ON(1) / OFF(0) */
 		lro         : 1,
 		/**
 		 * Indicates whether the device is configured.
@@ -410,7 +410,7 @@ typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
 
 /**
  * @internal
- * Set a queue statistics mapping for a tx/rx queue of an Ethernet device.
+ * Set a queue statistics mapping for a Tx/Rx queue of an Ethernet device.
  */
 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
 					     uint16_t queue_id,
@@ -439,11 +439,11 @@ typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *de
 typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
 				     uint32_t ptype_mask);
 
-/** @internal Start rx and tx of a queue of an Ethernet device. */
+/** @internal Start Rx and Tx of a queue of an Ethernet device. */
 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
 				    uint16_t queue_id);
 
-/** @internal Stop rx and tx of a queue of an Ethernet device. */
+/** @internal Stop Rx and Tx of a queue of an Ethernet device. */
 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
 				    uint16_t queue_id);
 
@@ -470,7 +470,7 @@ typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
 				    uint16_t rx_queue_id);
 
-/** @internal Release memory resources allocated by given RX/TX queue. */
+/** @internal Release memory resources allocated by given Rx/Tx queue. */
 typedef void (*eth_queue_release_t)(struct rte_eth_dev *dev,
 				    uint16_t queue_id);
 
@@ -478,7 +478,7 @@ typedef void (*eth_queue_release_t)(struct rte_eth_dev *dev,
 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
 				     char *fw_version, size_t fw_size);
 
-/** @internal Force mbufs to be from TX ring. */
+/** @internal Force mbufs to be from Tx ring. */
 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
 
 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
@@ -505,7 +505,7 @@ typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
 /** @internal Set VLAN offload function by an Ethernet device. */
 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
 
-/** @internal Set port based TX VLAN insertion by an Ethernet device. */
+/** @internal Set port based Tx VLAN insertion by an Ethernet device. */
 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
 			       uint16_t vlan_id,
 			       int on);
@@ -573,7 +573,7 @@ typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
 				  uint8_t on);
 
-/** @internal Set queue TX rate. */
+/** @internal Set queue Tx rate. */
 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
 				uint16_t queue_idx,
 				uint16_t tx_rate);
@@ -597,12 +597,12 @@ typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
 /** @internal Function used to disable IEEE1588/802.1AS timestamping. */
 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
 
-/** @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
+/** @internal Function used to read an Rx IEEE1588/802.1AS timestamp. */
 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
 						struct timespec *timestamp,
 						uint32_t flags);
 
-/** @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
+/** @internal Function used to read a Tx IEEE1588/802.1AS timestamp. */
 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
 						struct timespec *timestamp);
 
@@ -691,16 +691,16 @@ typedef int (*eth_hairpin_cap_get_t)(struct rte_eth_dev *dev,
 
 /**
  * @internal
- * Setup RX hairpin queue.
+ * Setup Rx hairpin queue.
  *
  * @param dev
  *   ethdev handle of port.
  * @param rx_queue_id
- *   the selected RX queue index.
+ *   the selected Rx queue index.
  * @param nb_rx_desc
  *   the requested number of descriptors for this queue. 0 - use PMD default.
  * @param conf
- *   the RX hairpin configuration structure.
+ *   the Rx hairpin configuration structure.
  *
  * @return
  *   Negative errno value on error, 0 on success.
@@ -721,16 +721,16 @@ typedef int (*eth_rx_hairpin_queue_setup_t)
 
 /**
  * @internal
- * Setup TX hairpin queue.
+ * Setup Tx hairpin queue.
  *
  * @param dev
  *   ethdev handle of port.
  * @param tx_queue_id
- *   the selected TX queue index.
+ *   the selected Tx queue index.
  * @param nb_tx_desc
  *   the requested number of descriptors for this queue. 0 - use PMD default.
  * @param conf
- *   the TX hairpin configuration structure.
+ *   the Tx hairpin configuration structure.
  *
  * @return
  *   Negative errno value on error, 0 on success.
@@ -1001,8 +1001,8 @@ struct eth_dev_ops {
 
 	eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON. */
 	eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF. */
-	eth_allmulticast_enable_t  allmulticast_enable;/**< RX multicast ON. */
-	eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
+	eth_allmulticast_enable_t  allmulticast_enable;/**< Rx multicast ON. */
+	eth_allmulticast_disable_t allmulticast_disable;/**< Rx multicast OFF. */
 	eth_mac_addr_remove_t      mac_addr_remove; /**< Remove MAC address. */
 	eth_mac_addr_add_t         mac_addr_add;  /**< Add a MAC address. */
 	eth_mac_addr_set_t         mac_addr_set;  /**< Set a MAC address. */
@@ -1019,10 +1019,10 @@ struct eth_dev_ops {
 	eth_queue_stats_mapping_set_t queue_stats_mapping_set;
 
 	eth_dev_infos_get_t        dev_infos_get; /**< Get device info. */
-	eth_rxq_info_get_t         rxq_info_get; /**< retrieve RX queue information. */
-	eth_txq_info_get_t         txq_info_get; /**< retrieve TX queue information. */
-	eth_burst_mode_get_t       rx_burst_mode_get; /**< Get RX burst mode */
-	eth_burst_mode_get_t       tx_burst_mode_get; /**< Get TX burst mode */
+	eth_rxq_info_get_t         rxq_info_get; /**< retrieve Rx queue information. */
+	eth_txq_info_get_t         txq_info_get; /**< retrieve Tx queue information. */
+	eth_burst_mode_get_t       rx_burst_mode_get; /**< Get Rx burst mode */
+	eth_burst_mode_get_t       tx_burst_mode_get; /**< Get Tx burst mode */
 	eth_fw_version_get_t       fw_version_get; /**< Get firmware version. */
 	/** Get packet types supported and identified by device. */
 	eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
@@ -1036,20 +1036,20 @@ struct eth_dev_ops {
 	vlan_tpid_set_t            vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
 	vlan_strip_queue_set_t     vlan_strip_queue_set; /**< VLAN Stripping on queue. */
 	vlan_offload_set_t         vlan_offload_set; /**< Set VLAN Offload. */
-	vlan_pvid_set_t            vlan_pvid_set; /**< Set port based TX VLAN insertion. */
+	vlan_pvid_set_t            vlan_pvid_set; /**< Set port based Tx VLAN insertion. */
 
-	eth_queue_start_t          rx_queue_start;/**< Start RX for a queue. */
-	eth_queue_stop_t           rx_queue_stop; /**< Stop RX for a queue. */
-	eth_queue_start_t          tx_queue_start;/**< Start TX for a queue. */
-	eth_queue_stop_t           tx_queue_stop; /**< Stop TX for a queue. */
-	eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device RX queue. */
-	eth_queue_release_t        rx_queue_release; /**< Release RX queue. */
+	eth_queue_start_t          rx_queue_start;/**< Start Rx for a queue. */
+	eth_queue_stop_t           rx_queue_stop; /**< Stop Rx for a queue. */
+	eth_queue_start_t          tx_queue_start;/**< Start Tx for a queue. */
+	eth_queue_stop_t           tx_queue_stop; /**< Stop Tx for a queue. */
+	eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device Rx queue. */
+	eth_queue_release_t        rx_queue_release; /**< Release Rx queue. */
 
 	eth_rx_enable_intr_t       rx_queue_intr_enable;  /**< Enable Rx queue interrupt. */
 	eth_rx_disable_intr_t      rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
-	eth_tx_queue_setup_t       tx_queue_setup;/**< Set up device TX queue. */
-	eth_queue_release_t        tx_queue_release; /**< Release TX queue. */
-	eth_tx_done_cleanup_t      tx_done_cleanup;/**< Free tx ring mbufs */
+	eth_tx_queue_setup_t       tx_queue_setup;/**< Set up device Tx queue. */
+	eth_queue_release_t        tx_queue_release; /**< Release Tx queue. */
+	eth_tx_done_cleanup_t      tx_done_cleanup;/**< Free Tx ring mbufs */
 
 	eth_dev_led_on_t           dev_led_on;    /**< Turn on LED. */
 	eth_dev_led_off_t          dev_led_off;   /**< Turn off LED. */
@@ -1090,9 +1090,9 @@ struct eth_dev_ops {
 	eth_timesync_disable_t     timesync_disable;
 	/** Turn IEEE1588/802.1AS timestamping off. */
 	eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
-	/** Read the IEEE1588/802.1AS RX timestamp. */
+	/** Read the IEEE1588/802.1AS Rx timestamp. */
 	eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
-	/** Read the IEEE1588/802.1AS TX timestamp. */
+	/** Read the IEEE1588/802.1AS Tx timestamp. */
 	eth_timesync_adjust_time   timesync_adjust_time; /** Adjust the device clock. */
 	eth_timesync_read_time     timesync_read_time; /** Get the device clock time. */
 	eth_timesync_write_time    timesync_write_time; /** Set the device clock time. */
@@ -1115,9 +1115,9 @@ struct eth_dev_ops {
 
 	/** Returns the hairpin capabilities. */
 	eth_hairpin_cap_get_t hairpin_cap_get;
-	/** Set up device RX hairpin queue. */
+	/** Set up device Rx hairpin queue. */
 	eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
-	/** Set up device TX hairpin queue. */
+	/** Set up device Tx hairpin queue. */
 	eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
 
 	/** Get Forward Error Correction(FEC) capability. */
diff --git a/lib/ethdev/ethdev_profile.c b/lib/ethdev/ethdev_profile.c
index a3c303f62c..0ac9e7cac4 100644
--- a/lib/ethdev/ethdev_profile.c
+++ b/lib/ethdev/ethdev_profile.c
@@ -23,13 +23,13 @@ profile_hook_rx_burst_cb(
 }
 
 /**
- * Setting profiling rx callback for a given Ethernet device.
+ * Setting profiling Rx callback for a given Ethernet device.
  * This function must be invoked when ethernet device is being configured.
  *
  * @param port_id
  *  The port identifier of the Ethernet device.
  * @param rx_queue_num
- *  The number of RX queues on specified port.
+ *  The number of Rx queues on specified port.
  *
  * @return
  *  - On success, zero.
diff --git a/lib/ethdev/rte_eth_ctrl.h b/lib/ethdev/rte_eth_ctrl.h
index 42652f9cce..fc511f227d 100644
--- a/lib/ethdev/rte_eth_ctrl.h
+++ b/lib/ethdev/rte_eth_ctrl.h
@@ -350,7 +350,7 @@ struct rte_eth_fdir_filter {
 
 /**
  *  A structure used to configure FDIR masks that are used by the device
- *  to match the various fields of RX packet headers.
+ *  to match the various fields of Rx packet headers.
  */
 struct rte_eth_fdir_masks {
 	uint16_t vlan_tci_mask;   /**< Bit mask for vlan_tci in big endian */
diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
index 3b8ef9ef22..acb667c112 100644
--- a/lib/ethdev/rte_ethdev.c
+++ b/lib/ethdev/rte_ethdev.c
@@ -50,10 +50,10 @@ struct rte_eth_fp_ops rte_eth_fp_ops[RTE_MAX_ETHPORTS];
 /* spinlock for eth device callbacks */
 static rte_spinlock_t eth_dev_cb_lock = RTE_SPINLOCK_INITIALIZER;
 
-/* spinlock for add/remove rx callbacks */
+/* spinlock for add/remove Rx callbacks */
 static rte_spinlock_t eth_dev_rx_cb_lock = RTE_SPINLOCK_INITIALIZER;
 
-/* spinlock for add/remove tx callbacks */
+/* spinlock for add/remove Tx callbacks */
 static rte_spinlock_t eth_dev_tx_cb_lock = RTE_SPINLOCK_INITIALIZER;
 
 /* spinlock for shared data allocation */
@@ -1440,7 +1440,7 @@ rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q,
 
 	if (nb_rx_q > RTE_MAX_QUEUES_PER_PORT) {
 		RTE_ETHDEV_LOG(ERR,
-			"Number of RX queues requested (%u) is greater than max supported(%d)\n",
+			"Number of Rx queues requested (%u) is greater than max supported(%d)\n",
 			nb_rx_q, RTE_MAX_QUEUES_PER_PORT);
 		ret = -EINVAL;
 		goto rollback;
@@ -1448,15 +1448,15 @@ rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q,
 
 	if (nb_tx_q > RTE_MAX_QUEUES_PER_PORT) {
 		RTE_ETHDEV_LOG(ERR,
-			"Number of TX queues requested (%u) is greater than max supported(%d)\n",
+			"Number of Tx queues requested (%u) is greater than max supported(%d)\n",
 			nb_tx_q, RTE_MAX_QUEUES_PER_PORT);
 		ret = -EINVAL;
 		goto rollback;
 	}
 
 	/*
-	 * Check that the numbers of RX and TX queues are not greater
-	 * than the maximum number of RX and TX queues supported by the
+	 * Check that the numbers of Rx and Tx queues are not greater
+	 * than the maximum number of Rx and Tx queues supported by the
 	 * configured device.
 	 */
 	if (nb_rx_q > dev_info.max_rx_queues) {
@@ -1571,7 +1571,7 @@ rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q,
 	}
 
 	/*
-	 * Setup new number of RX/TX queues and reconfigure device.
+	 * Setup new number of Rx/Tx queues and reconfigure device.
 	 */
 	diag = eth_dev_rx_queue_config(dev, nb_rx_q);
 	if (diag != 0) {
@@ -2035,7 +2035,7 @@ rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (rx_queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", rx_queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", rx_queue_id);
 		return -EINVAL;
 	}
 
@@ -2220,7 +2220,7 @@ rte_eth_rx_hairpin_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (rx_queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", rx_queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", rx_queue_id);
 		return -EINVAL;
 	}
 
@@ -2292,7 +2292,7 @@ rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (tx_queue_id >= dev->data->nb_tx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", tx_queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u\n", tx_queue_id);
 		return -EINVAL;
 	}
 
@@ -2386,7 +2386,7 @@ rte_eth_tx_hairpin_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (tx_queue_id >= dev->data->nb_tx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", tx_queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u\n", tx_queue_id);
 		return -EINVAL;
 	}
 
@@ -4771,13 +4771,13 @@ rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data)
 	dev = &rte_eth_devices[port_id];
 
 	if (!dev->intr_handle) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr handle unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr handle unset\n");
 		return -ENOTSUP;
 	}
 
 	intr_handle = dev->intr_handle;
 	if (!intr_handle->intr_vec) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr vector unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr vector unset\n");
 		return -EPERM;
 	}
 
@@ -4786,7 +4786,7 @@ rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data)
 		rc = rte_intr_rx_ctl(intr_handle, epfd, op, vec, data);
 		if (rc && rc != -EEXIST) {
 			RTE_ETHDEV_LOG(ERR,
-				"p %u q %u rx ctl error op %d epfd %d vec %u\n",
+				"p %u q %u Rx ctl error op %d epfd %d vec %u\n",
 				port_id, qid, op, epfd, vec);
 		}
 	}
@@ -4807,18 +4807,18 @@ rte_eth_dev_rx_intr_ctl_q_get_fd(uint16_t port_id, uint16_t queue_id)
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id);
 		return -1;
 	}
 
 	if (!dev->intr_handle) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr handle unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr handle unset\n");
 		return -1;
 	}
 
 	intr_handle = dev->intr_handle;
 	if (!intr_handle->intr_vec) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr vector unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr vector unset\n");
 		return -1;
 	}
 
@@ -4993,18 +4993,18 @@ rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id);
 		return -EINVAL;
 	}
 
 	if (!dev->intr_handle) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr handle unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr handle unset\n");
 		return -ENOTSUP;
 	}
 
 	intr_handle = dev->intr_handle;
 	if (!intr_handle->intr_vec) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr vector unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr vector unset\n");
 		return -EPERM;
 	}
 
@@ -5012,7 +5012,7 @@ rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
 	rc = rte_intr_rx_ctl(intr_handle, epfd, op, vec, data);
 	if (rc && rc != -EEXIST) {
 		RTE_ETHDEV_LOG(ERR,
-			"p %u q %u rx ctl error op %d epfd %d vec %u\n",
+			"p %u q %u Rx ctl error op %d epfd %d vec %u\n",
 			port_id, queue_id, op, epfd, vec);
 		return rc;
 	}
@@ -5290,7 +5290,7 @@ rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id);
 		return -EINVAL;
 	}
 
@@ -5335,7 +5335,7 @@ rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_tx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u\n", queue_id);
 		return -EINVAL;
 	}
 
@@ -5380,7 +5380,7 @@ rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id);
 		return -EINVAL;
 	}
 
@@ -5407,7 +5407,7 @@ rte_eth_tx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_tx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u\n", queue_id);
 		return -EINVAL;
 	}
 
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 2d43c226f6..0fbb436cd1 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -13,7 +13,7 @@
  * The Ethernet Device API is composed of two parts:
  *
  * - The application-oriented Ethernet API that includes functions to setup
- *   an Ethernet device (configure it, setup its RX and TX queues and start it),
+ *   an Ethernet device (configure it, setup its Rx and Tx queues and start it),
  *   to get its MAC address, the speed and the status of its physical link,
  *   to receive and to transmit packets, and so on.
  *
@@ -26,8 +26,8 @@
  * are lock-free functions which assume to not be invoked in parallel on
  * different logical cores to work on the same target object.  For instance,
  * the receive function of a PMD cannot be invoked in parallel on two logical
- * cores to poll the same RX queue [of the same port]. Of course, this function
- * can be invoked in parallel by different logical cores on different RX queues.
+ * cores to poll the same Rx queue [of the same port]. Of course, this function
+ * can be invoked in parallel by different logical cores on different Rx queues.
  * It is the responsibility of the upper level application to enforce this rule.
  *
  * If needed, parallel accesses by multiple logical cores to shared queues
@@ -111,7 +111,7 @@
  * performs an indirect invocation of the corresponding driver function
  * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
  *
- * For performance reasons, the address of the burst-oriented RX and TX
+ * For performance reasons, the address of the burst-oriented Rx and Tx
  * functions of the Ethernet driver are not contained in the *eth_dev_ops*
  * structure. Instead, they are directly stored at the beginning of the
  * *rte_eth_dev* structure to avoid an extra indirect memory access during
@@ -257,17 +257,17 @@ struct rte_eth_stats {
 	uint64_t ibytes;    /**< Total number of successfully received bytes. */
 	uint64_t obytes;    /**< Total number of successfully transmitted bytes. */
 	/**
-	 * Total of RX packets dropped by the HW,
-	 * because there are no available buffer (i.e. RX queues are full).
+	 * Total of Rx packets dropped by the HW,
+	 * because there are no available buffer (i.e. Rx queues are full).
 	 */
 	uint64_t imissed;
 	uint64_t ierrors;   /**< Total number of erroneous received packets. */
 	uint64_t oerrors;   /**< Total number of failed transmitted packets. */
-	uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
+	uint64_t rx_nombuf; /**< Total number of Rx mbuf allocation failures. */
 	/* Queue stats are limited to max 256 queues */
-	/** Total number of queue RX packets. */
+	/** Total number of queue Rx packets. */
 	uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/** Total number of queue TX packets. */
+	/** Total number of queue Tx packets. */
 	uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
 	/** Total number of successfully received queue bytes. */
 	uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
@@ -343,7 +343,7 @@ struct rte_eth_link {
 /**@}*/
 
 /**
- * A structure used to configure the ring threshold registers of an RX/TX
+ * A structure used to configure the ring threshold registers of an Rx/Tx
  * queue for an Ethernet port.
  */
 struct rte_eth_thresh {
@@ -368,9 +368,9 @@ enum rte_eth_rx_mq_mode {
 	/** None of DCB,RSS or VMDQ mode */
 	ETH_MQ_RX_NONE = 0,
 
-	/** For RX side, only RSS is on */
+	/** For Rx side, only RSS is on */
 	ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
-	/** For RX side,only DCB is on. */
+	/** For Rx side,only DCB is on. */
 	ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
 	/** Both DCB and RSS enable */
 	ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
@@ -387,7 +387,7 @@ enum rte_eth_rx_mq_mode {
 };
 
 /**
- * for rx mq mode backward compatible
+ * for Rx mq mode backward compatible
  */
 #define ETH_RSS                       ETH_MQ_RX_RSS
 #define VMDQ_DCB                      ETH_MQ_RX_VMDQ_DCB
@@ -399,20 +399,20 @@ enum rte_eth_rx_mq_mode {
  */
 enum rte_eth_tx_mq_mode {
 	ETH_MQ_TX_NONE    = 0,  /**< It is in neither DCB nor VT mode. */
-	ETH_MQ_TX_DCB,          /**< For TX side,only DCB is on. */
-	ETH_MQ_TX_VMDQ_DCB,	/**< For TX side,both DCB and VT is on. */
+	ETH_MQ_TX_DCB,          /**< For Tx side,only DCB is on. */
+	ETH_MQ_TX_VMDQ_DCB,	/**< For Tx side,both DCB and VT is on. */
 	ETH_MQ_TX_VMDQ_ONLY,    /**< Only VT on, no DCB */
 };
 
 /**
- * for tx mq mode backward compatible
+ * for Tx mq mode backward compatible
  */
 #define ETH_DCB_NONE                ETH_MQ_TX_NONE
 #define ETH_VMDQ_DCB_TX             ETH_MQ_TX_VMDQ_DCB
 #define ETH_DCB_TX                  ETH_MQ_TX_DCB
 
 /**
- * A structure used to configure the RX features of an Ethernet port.
+ * A structure used to configure the Rx features of an Ethernet port.
  */
 struct rte_eth_rxmode {
 	/** The multi-queue packet distribution mode to be used, e.g. RSS. */
@@ -919,7 +919,7 @@ struct rte_eth_vmdq_dcb_conf {
 	uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
 	struct {
 		uint16_t vlan_id; /**< The vlan id of the received frame */
-		uint64_t pools;   /**< Bitmask of pools for packet rx */
+		uint64_t pools;   /**< Bitmask of pools for packet Rx */
 	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
 	/** Selects a queue in a pool */
 	uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
@@ -952,15 +952,15 @@ struct rte_eth_vmdq_rx_conf {
 	uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
 	struct {
 		uint16_t vlan_id; /**< The vlan id of the received frame */
-		uint64_t pools;   /**< Bitmask of pools for packet rx */
+		uint64_t pools;   /**< Bitmask of pools for packet Rx */
 	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
 };
 
 /**
- * A structure used to configure the TX features of an Ethernet port.
+ * A structure used to configure the Tx features of an Ethernet port.
  */
 struct rte_eth_txmode {
-	enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
+	enum rte_eth_tx_mq_mode mq_mode; /**< Tx multi-queues mode. */
 	/**
 	 * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
 	 * Only offloads set on tx_offload_capa field on rte_eth_dev_info
@@ -1037,11 +1037,11 @@ union rte_eth_rxseg {
 };
 
 /**
- * A structure used to configure an RX ring of an Ethernet port.
+ * A structure used to configure an Rx ring of an Ethernet port.
  */
 struct rte_eth_rxconf {
-	struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
-	uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
+	struct rte_eth_thresh rx_thresh; /**< Rx ring threshold registers. */
+	uint16_t rx_free_thresh; /**< Drives the freeing of Rx descriptors. */
 	uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
 	uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
 	uint16_t rx_nseg; /**< Number of descriptions in rx_seg array. */
@@ -1065,12 +1065,12 @@ struct rte_eth_rxconf {
 };
 
 /**
- * A structure used to configure a TX ring of an Ethernet port.
+ * A structure used to configure a Tx ring of an Ethernet port.
  */
 struct rte_eth_txconf {
-	struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
+	struct rte_eth_thresh tx_thresh; /**< Tx ring threshold registers. */
 	uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
-	uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
+	uint16_t tx_free_thresh; /**< Start freeing Tx buffers if there are
 				      less free descriptors than this value. */
 
 	uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
@@ -1187,8 +1187,8 @@ struct rte_eth_desc_lim {
  */
 enum rte_eth_fc_mode {
 	RTE_FC_NONE = 0, /**< Disable flow control. */
-	RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
-	RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
+	RTE_FC_RX_PAUSE, /**< Rx pause frame, enable flowctrl on Tx side. */
+	RTE_FC_TX_PAUSE, /**< Tx pause frame, enable flowctrl on Rx side. */
 	RTE_FC_FULL      /**< Enable flow control on both side. */
 };
 
@@ -1248,7 +1248,7 @@ enum rte_fdir_pballoc_type {
 };
 
 /**
- *  Select report mode of FDIR hash information in RX descriptors.
+ *  Select report mode of FDIR hash information in Rx descriptors.
  */
 enum rte_fdir_status_mode {
 	RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
@@ -1266,7 +1266,7 @@ struct rte_fdir_conf {
 	enum rte_fdir_mode mode; /**< Flow Director mode. */
 	enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
 	enum rte_fdir_status_mode status;  /**< How to report FDIR hash. */
-	/** RX queue of packets matching a "drop" filter in perfect mode. */
+	/** Rx queue of packets matching a "drop" filter in perfect mode. */
 	uint8_t drop_queue;
 	struct rte_eth_fdir_masks mask;
 	/** Flex payload configuration. */
@@ -1301,7 +1301,7 @@ struct rte_intr_conf {
 
 /**
  * A structure used to configure an Ethernet port.
- * Depending upon the RX multi-queue mode, extra advanced
+ * Depending upon the Rx multi-queue mode, extra advanced
  * configuration settings may be needed.
  */
 struct rte_eth_conf {
@@ -1312,8 +1312,8 @@ struct rte_eth_conf {
 				speeds to be advertised. If the special value
 				ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
 				supported are advertised. */
-	struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
-	struct rte_eth_txmode txmode; /**< Port TX configuration. */
+	struct rte_eth_rxmode rxmode; /**< Port Rx configuration. */
+	struct rte_eth_txmode txmode; /**< Port Tx configuration. */
 	uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
 			         is 0, meaning the loopback mode is disabled.
 				 Read the datasheet of given ethernet controller
@@ -1323,19 +1323,19 @@ struct rte_eth_conf {
 		struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
 		/** Port vmdq+dcb configuration. */
 		struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
-		/** Port dcb RX configuration. */
+		/** Port dcb Rx configuration. */
 		struct rte_eth_dcb_rx_conf dcb_rx_conf;
-		/** Port vmdq RX configuration. */
+		/** Port vmdq Rx configuration. */
 		struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
-	} rx_adv_conf; /**< Port RX filtering configuration. */
+	} rx_adv_conf; /**< Port Rx filtering configuration. */
 	union {
-		/** Port vmdq+dcb TX configuration. */
+		/** Port vmdq+dcb Tx configuration. */
 		struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
-		/** Port dcb TX configuration. */
+		/** Port dcb Tx configuration. */
 		struct rte_eth_dcb_tx_conf dcb_tx_conf;
-		/** Port vmdq TX configuration. */
+		/** Port vmdq Tx configuration. */
 		struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
-	} tx_adv_conf; /**< Port TX DCB configuration (union). */
+	} tx_adv_conf; /**< Port Tx DCB configuration (union). */
 	/** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
 	    is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
 	uint32_t dcb_capability_en;
@@ -1344,7 +1344,7 @@ struct rte_eth_conf {
 };
 
 /**
- * RX offload capabilities of a device.
+ * Rx offload capabilities of a device.
  */
 #define DEV_RX_OFFLOAD_VLAN_STRIP  0x00000001
 #define DEV_RX_OFFLOAD_IPV4_CKSUM  0x00000002
@@ -1385,7 +1385,7 @@ struct rte_eth_conf {
  */
 
 /**
- * TX offload capabilities of a device.
+ * Tx offload capabilities of a device.
  */
 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
 #define DEV_TX_OFFLOAD_IPV4_CKSUM  0x00000002
@@ -1403,7 +1403,7 @@ struct rte_eth_conf {
 #define DEV_TX_OFFLOAD_MACSEC_INSERT    0x00002000
 /**
  * Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
- * tx queue without SW lock.
+ * Tx queue without SW lock.
  */
 #define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
 /** Device supports multi segment send. */
@@ -1534,42 +1534,42 @@ struct rte_eth_dev_info {
 	uint16_t min_mtu;	/**< Minimum MTU allowed */
 	uint16_t max_mtu;	/**< Maximum MTU allowed */
 	const uint32_t *dev_flags; /**< Device flags */
-	uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
-	uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
+	uint32_t min_rx_bufsize; /**< Minimum size of Rx buffer. */
+	uint32_t max_rx_pktlen; /**< Maximum configurable length of Rx pkt. */
 	/** Maximum configurable size of LRO aggregated packet. */
 	uint32_t max_lro_pkt_size;
-	uint16_t max_rx_queues; /**< Maximum number of RX queues. */
-	uint16_t max_tx_queues; /**< Maximum number of TX queues. */
+	uint16_t max_rx_queues; /**< Maximum number of Rx queues. */
+	uint16_t max_tx_queues; /**< Maximum number of Tx queues. */
 	uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
 	uint32_t max_hash_mac_addrs;
 	/** Maximum number of hash MAC addresses for MTA and UTA. */
 	uint16_t max_vfs; /**< Maximum number of VFs. */
 	uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
 	struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/
-	/** All RX offload capabilities including all per-queue ones */
+	/** All Rx offload capabilities including all per-queue ones */
 	uint64_t rx_offload_capa;
-	/** All TX offload capabilities including all per-queue ones */
+	/** All Tx offload capabilities including all per-queue ones */
 	uint64_t tx_offload_capa;
-	/** Device per-queue RX offload capabilities. */
+	/** Device per-queue Rx offload capabilities. */
 	uint64_t rx_queue_offload_capa;
-	/** Device per-queue TX offload capabilities. */
+	/** Device per-queue Tx offload capabilities. */
 	uint64_t tx_queue_offload_capa;
 	/** Device redirection table size, the total number of entries. */
 	uint16_t reta_size;
 	uint8_t hash_key_size; /**< Hash key size in bytes */
 	/** Bit mask of RSS offloads, the bit offset also means flow type */
 	uint64_t flow_type_rss_offloads;
-	struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
-	struct rte_eth_txconf default_txconf; /**< Default TX configuration */
+	struct rte_eth_rxconf default_rxconf; /**< Default Rx configuration */
+	struct rte_eth_txconf default_txconf; /**< Default Tx configuration */
 	uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
 	uint16_t vmdq_queue_num;  /**< Queue number for VMDQ pools. */
 	uint16_t vmdq_pool_base;  /**< First ID of VMDQ pools. */
-	struct rte_eth_desc_lim rx_desc_lim;  /**< RX descriptors limits */
-	struct rte_eth_desc_lim tx_desc_lim;  /**< TX descriptors limits */
+	struct rte_eth_desc_lim rx_desc_lim;  /**< Rx descriptors limits */
+	struct rte_eth_desc_lim tx_desc_lim;  /**< Tx descriptors limits */
 	uint32_t speed_capa;  /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
-	/** Configured number of rx/tx queues */
-	uint16_t nb_rx_queues; /**< Number of RX queues. */
-	uint16_t nb_tx_queues; /**< Number of TX queues. */
+	/** Configured number of Rx/Tx queues */
+	uint16_t nb_rx_queues; /**< Number of Rx queues. */
+	uint16_t nb_tx_queues; /**< Number of Tx queues. */
 	/** Rx parameter recommendations */
 	struct rte_eth_dev_portconf default_rxportconf;
 	/** Tx parameter recommendations */
@@ -1593,20 +1593,20 @@ struct rte_eth_dev_info {
 /**@}*/
 
 /**
- * Ethernet device RX queue information structure.
+ * Ethernet device Rx queue information structure.
  * Used to retrieve information about configured queue.
  */
 struct rte_eth_rxq_info {
 	struct rte_mempool *mp;     /**< mempool used by that queue. */
 	struct rte_eth_rxconf conf; /**< queue config parameters. */
-	uint8_t scattered_rx;       /**< scattered packets RX supported. */
+	uint8_t scattered_rx;       /**< scattered packets Rx supported. */
 	uint8_t queue_state;        /**< one of RTE_ETH_QUEUE_STATE_*. */
 	uint16_t nb_desc;           /**< configured number of RXDs. */
 	uint16_t rx_buf_size;       /**< hardware receive buffer size. */
 } __rte_cache_min_aligned;
 
 /**
- * Ethernet device TX queue information structure.
+ * Ethernet device Tx queue information structure.
  * Used to retrieve information about configured queue.
  */
 struct rte_eth_txq_info {
@@ -1625,7 +1625,7 @@ struct rte_eth_txq_info {
 #define RTE_ETH_BURST_FLAG_PER_QUEUE     (1ULL << 0)
 
 /**
- * Ethernet device RX/TX queue packet burst mode information structure.
+ * Ethernet device Rx/Tx queue packet burst mode information structure.
  * Used to retrieve information about packet burst mode setting.
  */
 struct rte_eth_burst_mode {
@@ -1675,15 +1675,15 @@ struct rte_eth_xstat_name {
 
 /**
  * A structure used to get the information of queue and
- * TC mapping on both TX and RX paths.
+ * TC mapping on both Tx and Rx paths.
  */
 struct rte_eth_dcb_tc_queue_mapping {
-	/** rx queues assigned to tc per Pool */
+	/** Rx queues assigned to tc per Pool */
 	struct {
 		uint16_t base;
 		uint16_t nb_queue;
 	} tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
-	/** rx queues assigned to tc per Pool */
+	/** Rx queues assigned to tc per Pool */
 	struct {
 		uint16_t base;
 		uint16_t nb_queue;
@@ -1697,8 +1697,8 @@ struct rte_eth_dcb_tc_queue_mapping {
 struct rte_eth_dcb_info {
 	uint8_t nb_tcs;        /**< number of TCs */
 	uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
-	uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
-	/** rx queues assigned to tc */
+	uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< Tx BW percentage for each TC */
+	/** Rx queues assigned to tc */
 	struct rte_eth_dcb_tc_queue_mapping tc_queue;
 };
 
@@ -1754,13 +1754,13 @@ struct rte_eth_fec_capa {
 /**@}*/
 
 /**
- * Function type used for RX packet processing packet callbacks.
+ * Function type used for Rx packet processing packet callbacks.
  *
- * The callback function is called on RX with a burst of packets that have
+ * The callback function is called on Rx with a burst of packets that have
  * been received on the given port and queue.
  *
  * @param port_id
- *   The Ethernet port on which RX is being performed.
+ *   The Ethernet port on which Rx is being performed.
  * @param queue
  *   The queue on the Ethernet port which is being used to receive the packets.
  * @param pkts
@@ -1780,13 +1780,13 @@ typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue,
 	void *user_param);
 
 /**
- * Function type used for TX packet processing packet callbacks.
+ * Function type used for Tx packet processing packet callbacks.
  *
- * The callback function is called on TX with a burst of packets immediately
+ * The callback function is called on Tx with a burst of packets immediately
  * before the packets are put onto the hardware queue for transmission.
  *
  * @param port_id
- *   The Ethernet port on which TX is being performed.
+ *   The Ethernet port on which Tx is being performed.
  * @param queue
  *   The queue on the Ethernet port which is being used to transmit the packets.
  * @param pkts
@@ -1816,7 +1816,7 @@ enum rte_eth_dev_state {
 
 struct rte_eth_dev_sriov {
 	uint8_t active;               /**< SRIOV is active with 16, 32 or 64 pools */
-	uint8_t nb_q_per_pool;        /**< rx queue number per pool */
+	uint8_t nb_q_per_pool;        /**< Rx queue number per pool */
 	uint16_t def_vmdq_idx;        /**< Default pool num used for PF */
 	uint16_t def_pool_q_idx;      /**< Default pool queue start reg index */
 };
@@ -2114,7 +2114,7 @@ const char *rte_eth_dev_tx_offload_name(uint64_t offload);
  *        Any type of device supported offloading set in the input argument
  *        eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled
  *        on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup()
- *     -  the Receive Side Scaling (RSS) configuration when using multiple RX
+ *     -  the Receive Side Scaling (RSS) configuration when using multiple Rx
  *        queues per port. Any RSS hash function set in eth_conf->rss_conf.rss_hf
  *        must be within the flow_type_rss_offloads provided by drivers via
  *        rte_eth_dev_info_get() API.
@@ -2166,7 +2166,7 @@ rte_eth_dev_is_removed(uint16_t port_id);
  *   the DMA memory allocated for the receive descriptors of the ring.
  * @param rx_conf
  *   The pointer to the configuration data to be used for the receive queue.
- *   NULL value is allowed, in which case default RX configuration
+ *   NULL value is allowed, in which case default Rx configuration
  *   will be used.
  *   The *rx_conf* structure contains an *rx_thresh* structure with the values
  *   of the Prefetch, Host, and Write-Back threshold registers of the receive
@@ -2260,7 +2260,7 @@ int rte_eth_rx_hairpin_queue_setup
  *   the DMA memory allocated for the transmit descriptors of the ring.
  * @param tx_conf
  *   The pointer to the configuration data to be used for the transmit queue.
- *   NULL value is allowed, in which case default TX configuration
+ *   NULL value is allowed, in which case default Tx configuration
  *   will be used.
  *   The *tx_conf* structure contains the following data:
  *   - The *tx_thresh* structure with the values of the Prefetch, Host, and
@@ -2431,13 +2431,13 @@ int rte_eth_dev_socket_id(uint16_t port_id);
 int rte_eth_dev_is_valid_port(uint16_t port_id);
 
 /**
- * Start specified RX queue of a port. It is used when rx_deferred_start
+ * Start specified Rx queue of a port. It is used when rx_deferred_start
  * flag of the specified queue is true.
  *
  * @param port_id
  *   The port identifier of the Ethernet device
  * @param rx_queue_id
- *   The index of the rx queue to update the ring.
+ *   The index of the Rx queue to update the ring.
  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
@@ -2450,12 +2450,12 @@ int rte_eth_dev_is_valid_port(uint16_t port_id);
 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
 
 /**
- * Stop specified RX queue of a port
+ * Stop specified Rx queue of a port
  *
  * @param port_id
  *   The port identifier of the Ethernet device
  * @param rx_queue_id
- *   The index of the rx queue to update the ring.
+ *   The index of the Rx queue to update the ring.
  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
@@ -2468,13 +2468,13 @@ int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
 
 /**
- * Start TX for specified queue of a port. It is used when tx_deferred_start
+ * Start Tx for specified queue of a port. It is used when tx_deferred_start
  * flag of the specified queue is true.
  *
  * @param port_id
  *   The port identifier of the Ethernet device
  * @param tx_queue_id
- *   The index of the tx queue to update the ring.
+ *   The index of the Tx queue to update the ring.
  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
@@ -2487,12 +2487,12 @@ int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
 
 /**
- * Stop specified TX queue of a port
+ * Stop specified Tx queue of a port
  *
  * @param port_id
  *   The port identifier of the Ethernet device
  * @param tx_queue_id
- *   The index of the tx queue to update the ring.
+ *   The index of the Tx queue to update the ring.
  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
@@ -2540,7 +2540,7 @@ int rte_eth_dev_stop(uint16_t port_id);
 /**
  * Link up an Ethernet device.
  *
- * Set device link up will re-enable the device rx/tx
+ * Set device link up will re-enable the device Rx/Tx
  * functionality after it is previously set device linked down.
  *
  * @param port_id
@@ -2553,7 +2553,7 @@ int rte_eth_dev_set_link_up(uint16_t port_id);
 
 /**
  * Link down an Ethernet device.
- * The device rx/tx functionality will be disabled if success,
+ * The device Rx/Tx functionality will be disabled if success,
  * and it can be re-enabled with a call to
  * rte_eth_dev_set_link_up()
  *
@@ -3138,7 +3138,7 @@ int rte_eth_dev_fw_version_get(uint16_t port_id,
  * can still set a matching packet type in a received packet.
  *
  * @note
- *   Better to invoke this API after the device is already started or rx burst
+ *   Better to invoke this API after the device is already started or Rx burst
  *   function is decided, to obtain correct supported ptypes.
  * @note
  *   if a given PMD does not report what ptypes it supports, then the supported
@@ -3248,7 +3248,7 @@ int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
 
 /**
- * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
+ * Enable/Disable hardware VLAN Strip by a Rx queue of an Ethernet device.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -3323,14 +3323,14 @@ int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
 
 /**
- * Set port based TX VLAN insertion on or off.
+ * Set port based Tx VLAN insertion on or off.
  *
  * @param port_id
  *  The port identifier of the Ethernet device.
  * @param pvid
- *  Port based TX VLAN identifier together with user priority.
+ *  Port based Tx VLAN identifier together with user priority.
  * @param on
- *  Turn on or off the port based TX VLAN insertion.
+ *  Turn on or off the port based Tx VLAN insertion.
  *
  * @return
  *   - (0) if successful.
@@ -3342,20 +3342,20 @@ typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
 		void *userdata);
 
 /**
- * Structure used to buffer packets for future TX
+ * Structure used to buffer packets for future Tx
  * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
  */
 struct rte_eth_dev_tx_buffer {
 	buffer_tx_error_fn error_callback;
 	void *error_userdata;
-	uint16_t size;           /**< Size of buffer for buffered tx */
+	uint16_t size;           /**< Size of buffer for buffered Tx */
 	uint16_t length;         /**< Number of packets in the array */
 	/** Pending packets to be sent on explicit flush or when full */
 	struct rte_mbuf *pkts[];
 };
 
 /**
- * Calculate the size of the tx buffer.
+ * Calculate the size of the Tx buffer.
  *
  * @param sz
  *   Number of stored packets.
@@ -3409,7 +3409,7 @@ rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
  *
  * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
  * adjust the default behavior when buffered packets cannot be sent. This
- * function drops any unsent packets silently and is used by tx buffered
+ * function drops any unsent packets silently and is used by Tx buffered
  * operations as default behavior.
  *
  * NOTE: this function should not be called directly, instead it should be used
@@ -3594,12 +3594,12 @@ int rte_eth_dev_callback_unregister(uint16_t port_id,
 		rte_eth_dev_cb_fn cb_fn, void *cb_arg);
 
 /**
- * When there is no rx packet coming in Rx Queue for a long time, we can
- * sleep lcore related to RX Queue for power saving, and enable rx interrupt
+ * When there is no Rx packet coming in Rx Queue for a long time, we can
+ * sleep lcore related to Rx Queue for power saving, and enable Rx interrupt
  * to be triggered when Rx packet arrives.
  *
- * The rte_eth_dev_rx_intr_enable() function enables rx queue
- * interrupt on specific rx queue of a port.
+ * The rte_eth_dev_rx_intr_enable() function enables Rx queue
+ * interrupt on specific Rx queue of a port.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -3617,11 +3617,11 @@ int rte_eth_dev_callback_unregister(uint16_t port_id,
 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
 
 /**
- * When lcore wakes up from rx interrupt indicating packet coming, disable rx
+ * When lcore wakes up from Rx interrupt indicating packet coming, disable Rx
  * interrupt and returns to polling mode.
  *
- * The rte_eth_dev_rx_intr_disable() function disables rx queue
- * interrupt on specific rx queue of a port.
+ * The rte_eth_dev_rx_intr_disable() function disables Rx queue
+ * interrupt on specific Rx queue of a port.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -3639,7 +3639,7 @@ int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
 
 /**
- * RX Interrupt control per port.
+ * Rx Interrupt control per port.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -3658,7 +3658,7 @@ int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
 
 /**
- * RX Interrupt control per queue.
+ * Rx Interrupt control per queue.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -3961,7 +3961,7 @@ int rte_eth_dev_rss_reta_query(uint16_t port_id,
 
 /**
  * Updates unicast hash table for receiving packet with the given destination
- * MAC address, and the packet is routed to all VFs for which the RX mode is
+ * MAC address, and the packet is routed to all VFs for which the Rx mode is
  * accept packets that match the unicast hash table.
  *
  * @param port_id
@@ -3983,7 +3983,7 @@ int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct rte_ether_addr *addr,
 
 /**
  * Updates all unicast hash bitmaps for receiving packet with any Unicast
- * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
+ * Ethernet MAC addresses,the packet is routed to all VFs for which the Rx
  * mode is accept packets that match the unicast hash table.
  *
  * @param port_id
@@ -4009,7 +4009,7 @@ int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
  * @param queue_idx
  *   The queue id.
  * @param tx_rate
- *   The tx rate in Mbps. Allocated from the total port link speed.
+ *   The Tx rate in Mbps. Allocated from the total port link speed.
  * @return
  *   - (0) if successful.
  *   - (-ENOTSUP) if hardware doesn't support this feature.
@@ -4127,7 +4127,7 @@ int rte_eth_dev_get_dcb_info(uint16_t port_id,
 struct rte_eth_rxtx_callback;
 
 /**
- * Add a callback to be called on packet RX on a given port and queue.
+ * Add a callback to be called on packet Rx on a given port and queue.
  *
  * This API configures a function to be called for each burst of
  * packets received on a given NIC port queue. The return value is a pointer
@@ -4156,7 +4156,7 @@ rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
 		rte_rx_callback_fn fn, void *user_param);
 
 /**
- * Add a callback that must be called first on packet RX on a given port
+ * Add a callback that must be called first on packet Rx on a given port
  * and queue.
  *
  * This API configures a first function to be called for each burst of
@@ -4186,7 +4186,7 @@ rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
 		rte_rx_callback_fn fn, void *user_param);
 
 /**
- * Add a callback to be called on packet TX on a given port and queue.
+ * Add a callback to be called on packet Tx on a given port and queue.
  *
  * This API configures a function to be called for each burst of
  * packets sent on a given NIC port queue. The return value is a pointer
@@ -4215,7 +4215,7 @@ rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
 		rte_tx_callback_fn fn, void *user_param);
 
 /**
- * Remove an RX packet callback from a given port and queue.
+ * Remove an Rx packet callback from a given port and queue.
  *
  * This function is used to removed callbacks that were added to a NIC port
  * queue using rte_eth_add_rx_callback().
@@ -4225,7 +4225,7 @@ rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
  * subsequently freed back by the application by calling rte_free():
  *
  * - Immediately - if the port is stopped, or the user knows that no
- *   callbacks are in flight e.g. if called from the thread doing RX/TX
+ *   callbacks are in flight e.g. if called from the thread doing Rx/Tx
  *   on that queue.
  *
  * - After a short delay - where the delay is sufficient to allow any
@@ -4251,7 +4251,7 @@ int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
 		const struct rte_eth_rxtx_callback *user_cb);
 
 /**
- * Remove a TX packet callback from a given port and queue.
+ * Remove a Tx packet callback from a given port and queue.
  *
  * This function is used to removed callbacks that were added to a NIC port
  * queue using rte_eth_add_tx_callback().
@@ -4261,7 +4261,7 @@ int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
  * subsequently freed back by the application by calling rte_free():
  *
  * - Immediately - if the port is stopped, or the user knows that no
- *   callbacks are in flight e.g. if called from the thread doing RX/TX
+ *   callbacks are in flight e.g. if called from the thread doing Rx/Tx
  *   on that queue.
  *
  * - After a short delay - where the delay is sufficient to allow any
@@ -4287,12 +4287,12 @@ int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
 		const struct rte_eth_rxtx_callback *user_cb);
 
 /**
- * Retrieve information about given port's RX queue.
+ * Retrieve information about given port's Rx queue.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param queue_id
- *   The RX queue on the Ethernet device for which information
+ *   The Rx queue on the Ethernet device for which information
  *   will be retrieved.
  * @param qinfo
  *   A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
@@ -4309,12 +4309,12 @@ int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
 	struct rte_eth_rxq_info *qinfo);
 
 /**
- * Retrieve information about given port's TX queue.
+ * Retrieve information about given port's Tx queue.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param queue_id
- *   The TX queue on the Ethernet device for which information
+ *   The Tx queue on the Ethernet device for which information
  *   will be retrieved.
  * @param qinfo
  *   A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
@@ -4565,14 +4565,14 @@ int rte_eth_timesync_enable(uint16_t port_id);
 int rte_eth_timesync_disable(uint16_t port_id);
 
 /**
- * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
+ * Read an IEEE1588/802.1AS Rx timestamp from an Ethernet device.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param timestamp
  *   Pointer to the timestamp struct.
  * @param flags
- *   Device specific flags. Used to pass the RX timesync register index to
+ *   Device specific flags. Used to pass the Rx timesync register index to
  *   i40e. Unused in igb/ixgbe, pass 0 instead.
  *
  * @return
@@ -4586,7 +4586,7 @@ int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
 		struct timespec *timestamp, uint32_t flags);
 
 /**
- * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
+ * Read an IEEE1588/802.1AS Tx timestamp from an Ethernet device.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -4962,18 +4962,18 @@ uint16_t rte_eth_call_rx_callbacks(uint16_t port_id, uint16_t queue_id,
  * device. The retrieved packets are stored in *rte_mbuf* structures whose
  * pointers are supplied in the *rx_pkts* array.
  *
- * The rte_eth_rx_burst() function loops, parsing the RX ring of the
- * receive queue, up to *nb_pkts* packets, and for each completed RX
+ * The rte_eth_rx_burst() function loops, parsing the Rx ring of the
+ * receive queue, up to *nb_pkts* packets, and for each completed Rx
  * descriptor in the ring, it performs the following operations:
  *
  * - Initialize the *rte_mbuf* data structure associated with the
- *   RX descriptor according to the information provided by the NIC into
- *   that RX descriptor.
+ *   Rx descriptor according to the information provided by the NIC into
+ *   that Rx descriptor.
  *
  * - Store the *rte_mbuf* data structure into the next entry of the
  *   *rx_pkts* array.
  *
- * - Replenish the RX descriptor with a new *rte_mbuf* buffer
+ * - Replenish the Rx descriptor with a new *rte_mbuf* buffer
  *   allocated from the memory pool associated with the receive queue at
  *   initialization time.
  *
@@ -4985,7 +4985,7 @@ uint16_t rte_eth_call_rx_callbacks(uint16_t port_id, uint16_t queue_id,
  * The rte_eth_rx_burst() function returns the number of packets
  * actually retrieved, which is the number of *rte_mbuf* data structures
  * effectively supplied into the *rx_pkts* array.
- * A return value equal to *nb_pkts* indicates that the RX queue contained
+ * A return value equal to *nb_pkts* indicates that the Rx queue contained
  * at least *rx_pkts* packets, and this is likely to signify that other
  * received packets remain in the input queue. Applications implementing
  * a "retrieve as much received packets as possible" policy can check this
@@ -5069,7 +5069,7 @@ rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
 	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
 
 	if (qd == NULL) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u for port_id=%u\n",
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u for port_id=%u\n",
 			queue_id, port_id);
 		return 0;
 	}
@@ -5100,7 +5100,7 @@ rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
 }
 
 /**
- * Get the number of used descriptors of a rx queue
+ * Get the number of used descriptors of a Rx queue
  *
  * @param port_id
  *  The port identifier of the Ethernet device.
@@ -5311,7 +5311,7 @@ uint16_t rte_eth_call_tx_callbacks(uint16_t port_id, uint16_t queue_id,
  * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
  * allocated from a pool created with rte_pktmbuf_pool_create().
  * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
- * up to the number of transmit descriptors available in the TX ring of the
+ * up to the number of transmit descriptors available in the Tx ring of the
  * transmit queue.
  * For each packet to send, the rte_eth_tx_burst() function performs
  * the following operations:
@@ -5339,12 +5339,12 @@ uint16_t rte_eth_call_tx_callbacks(uint16_t port_id, uint16_t queue_id,
  * transparently free the memory buffers of packets previously sent.
  * This feature is driven by the *tx_free_thresh* value supplied to the
  * rte_eth_dev_configure() function at device configuration time.
- * When the number of free TX descriptors drops below this threshold, the
+ * When the number of free Tx descriptors drops below this threshold, the
  * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf*  buffers
  * of those packets whose transmission was effectively completed.
  *
  * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
- * invoke this function concurrently on the same tx queue without SW lock.
+ * invoke this function concurrently on the same Tx queue without SW lock.
  * @see rte_eth_dev_info_get, struct rte_eth_txconf::offloads
  *
  * @see rte_eth_tx_prepare to perform some prior checks or adjustments
@@ -5392,7 +5392,7 @@ rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
 	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
 
 	if (qd == NULL) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u for port_id=%u\n",
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u for port_id=%u\n",
 			queue_id, port_id);
 		return 0;
 	}
@@ -5434,13 +5434,13 @@ rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
  * For each packet to send, the rte_eth_tx_prepare() function performs
  * the following operations:
  *
- * - Check if packet meets devices requirements for tx offloads.
+ * - Check if packet meets devices requirements for Tx offloads.
  *
  * - Check limitations about number of segments.
  *
  * - Check additional requirements when debug is enabled.
  *
- * - Update and/or reset required checksums when tx offload is set for packet.
+ * - Update and/or reset required checksums when Tx offload is set for packet.
  *
  * Since this function can modify packet data, provided mbufs must be safely
  * writable (e.g. modified data cannot be in shared segment).
@@ -5502,12 +5502,12 @@ rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
 
 #ifdef RTE_ETHDEV_DEBUG_TX
 	if (!rte_eth_dev_is_valid_port(port_id)) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX port_id=%u\n", port_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx port_id=%u\n", port_id);
 		rte_errno = ENODEV;
 		return 0;
 	}
 	if (qd == NULL) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u for port_id=%u\n",
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u for port_id=%u\n",
 			queue_id, port_id);
 		rte_errno = EINVAL;
 		return 0;
diff --git a/lib/ethdev/rte_ethdev_core.h b/lib/ethdev/rte_ethdev_core.h
index 18d725fca1..dcf8adab92 100644
--- a/lib/ethdev/rte_ethdev_core.h
+++ b/lib/ethdev/rte_ethdev_core.h
@@ -86,7 +86,7 @@ struct rte_eth_fp_ops {
 	 */
 	/** PMD receive function. */
 	eth_rx_burst_t rx_pkt_burst;
-	/** Get the number of used RX descriptors. */
+	/** Get the number of used Rx descriptors. */
 	eth_rx_queue_count_t rx_queue_count;
 	/** Check the status of a Rx descriptor. */
 	eth_rx_descriptor_status_t rx_descriptor_status;
diff --git a/lib/ethdev/rte_tm.h b/lib/ethdev/rte_tm.h
index 175417a15f..d39e897849 100644
--- a/lib/ethdev/rte_tm.h
+++ b/lib/ethdev/rte_tm.h
@@ -47,7 +47,7 @@ extern "C" {
 /**
  * Ethernet framing overhead including the Frame Check Sequence (FCS) field.
  * Useful when FCS is generated and added at the end of the Ethernet frame on
- * TX side without any SW intervention.
+ * Tx side without any SW intervention.
  *
  * One of the typical values for the pkt_length_adjust field of the shaper
  * profile.
@@ -1089,9 +1089,9 @@ struct rte_tm_shaper_params {
  * the lowest weight. For each SP priority, the WFQ weight mode can be set as
  * either byte-based or packet-based.
  *
- * Each leaf node sits on top of a TX queue of the current Ethernet port. Hence,
+ * Each leaf node sits on top of a Tx queue of the current Ethernet port. Hence,
  * the leaf nodes are predefined, with their node IDs set to 0 .. (N-1), where N
- * is the number of TX queues configured for the current Ethernet port. The
+ * is the number of Tx queues configured for the current Ethernet port. The
  * non-leaf nodes have their IDs generated by the application.
  */
 struct rte_tm_node_params {
@@ -1230,9 +1230,9 @@ struct rte_tm_error {
 /**
  * Traffic manager get number of leaf nodes
  *
- * Each leaf node sits on on top of a TX queue of the current Ethernet port.
+ * Each leaf node sits on top of a Tx queue of the current Ethernet port.
  * Therefore, the set of leaf nodes is predefined, their number is always equal
- * to N (where N is the number of TX queues configured for the current port)
+ * to N (where N is the number of Tx queues configured for the current port)
  * and their IDs are 0 .. (N-1).
  *
  * @param[in] port_id
@@ -1254,7 +1254,7 @@ rte_tm_get_number_of_leaf_nodes(uint16_t port_id,
  * Traffic manager node ID validate and type (i.e. leaf or non-leaf) get
  *
  * The leaf nodes have predefined IDs in the range of 0 .. (N-1), where N is
- * the number of TX queues of the current Ethernet port. The non-leaf nodes
+ * the number of Tx queues of the current Ethernet port. The non-leaf nodes
  * have their IDs generated by the application outside of the above range,
  * which is reserved for leaf nodes.
  *
@@ -1558,7 +1558,7 @@ rte_tm_shared_shaper_delete(uint16_t port_id,
  *
  * This function has to be called for both leaf and non-leaf nodes. In the case
  * of leaf nodes (i.e. *node_id* is within the range of 0 .. (N-1), with N as
- * the number of configured TX queues of the current port), the leaf node is
+ * the number of configured Tx queues of the current port), the leaf node is
  * configured rather than created (as the set of leaf nodes is predefined) and
  * it is also connected as child of an existing node.
  *
-- 
2.30.2

[dpdk-dev] [PATCH v2 3/9] ethdev: fix Ethernet spelling

[Andrew Rybchenko]

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h  |  6 +++---
 lib/ethdev/ethdev_pci.h     |  2 +-
 lib/ethdev/ethdev_profile.c |  2 +-
 lib/ethdev/ethdev_vdev.h    |  2 +-
 lib/ethdev/rte_ethdev.h     | 10 +++++-----
 5 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 7deb9911bd..fdaf20b3c8 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -33,7 +33,7 @@ struct rte_eth_rxtx_callback {
 
 /**
  * @internal
- * The generic data structure associated with each ethernet device.
+ * The generic data structure associated with each Ethernet device.
  *
  * Pointers to burst-oriented packet receive and transmit functions are
  * located at the beginning of the structure, along with the pointer to
@@ -85,7 +85,7 @@ struct rte_eth_dev_owner;
 
 /**
  * @internal
- * The data part, with no function pointers, associated with each ethernet
+ * The data part, with no function pointers, associated with each Ethernet
  * device. This structure is safe to place in shared memory to be common
  * among different processes in a multi-process configuration.
  */
@@ -1197,7 +1197,7 @@ struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
 
 /**
  * @internal
- * Allocates a new ethdev slot for an ethernet device and returns the pointer
+ * Allocates a new ethdev slot for an Ethernet device and returns the pointer
  * to that slot for the driver to use.
  *
  * @param	name	Unique identifier name for each Ethernet device
diff --git a/lib/ethdev/ethdev_pci.h b/lib/ethdev/ethdev_pci.h
index 8edca82ce8..12015b6b87 100644
--- a/lib/ethdev/ethdev_pci.h
+++ b/lib/ethdev/ethdev_pci.h
@@ -59,7 +59,7 @@ eth_dev_pci_specific_init(struct rte_eth_dev *eth_dev, void *bus_device) {
 
 /**
  * @internal
- * Allocates a new ethdev slot for an ethernet device and returns the pointer
+ * Allocates a new ethdev slot for an Ethernet device and returns the pointer
  * to that slot for the driver to use.
  *
  * @param dev
diff --git a/lib/ethdev/ethdev_profile.c b/lib/ethdev/ethdev_profile.c
index 0ac9e7cac4..7978f351ac 100644
--- a/lib/ethdev/ethdev_profile.c
+++ b/lib/ethdev/ethdev_profile.c
@@ -24,7 +24,7 @@ profile_hook_rx_burst_cb(
 
 /**
  * Setting profiling Rx callback for a given Ethernet device.
- * This function must be invoked when ethernet device is being configured.
+ * This function must be invoked when Ethernet device is being configured.
  *
  * @param port_id
  *  The port identifier of the Ethernet device.
diff --git a/lib/ethdev/ethdev_vdev.h b/lib/ethdev/ethdev_vdev.h
index 46c75d9e5f..2b49e9665b 100644
--- a/lib/ethdev/ethdev_vdev.h
+++ b/lib/ethdev/ethdev_vdev.h
@@ -13,7 +13,7 @@
 
 /**
  * @internal
- * Allocates a new ethdev slot for an ethernet device and returns the pointer
+ * Allocates a new ethdev slot for an Ethernet device and returns the pointer
  * to that slot for the driver to use.
  *
  * @param dev
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 0fbb436cd1..6ae6d9ba99 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -117,7 +117,7 @@
  * *rte_eth_dev* structure to avoid an extra indirect memory access during
  * their invocation.
  *
- * RTE ethernet device drivers do not use interrupts for transmitting or
+ * RTE Ethernet device drivers do not use interrupts for transmitting or
  * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
  * functions to applications.
  * Both receive and transmit functions are packet-burst oriented to minimize
@@ -1316,7 +1316,7 @@ struct rte_eth_conf {
 	struct rte_eth_txmode txmode; /**< Port Tx configuration. */
 	uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
 			         is 0, meaning the loopback mode is disabled.
-				 Read the datasheet of given ethernet controller
+				 Read the datasheet of given Ethernet controller
 				 for details. The possible values of this field
 				 are defined in implementation of each driver. */
 	struct {
@@ -3380,7 +3380,7 @@ rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
  * Configure a callback for buffered packets which cannot be sent
  *
  * Register a specific callback to be called when an attempt is made to send
- * all packets buffered on an ethernet port, but not all packets can
+ * all packets buffered on an Ethernet port, but not all packets can
  * successfully be sent. The callback registered here will be called only
  * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
  * The default callback configured for each queue by default just frees the
@@ -4746,7 +4746,7 @@ rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
 
 /**
  * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
- * the ethernet device information, otherwise adjust them to boundaries.
+ * the Ethernet device information, otherwise adjust them to boundaries.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -4816,7 +4816,7 @@ int rte_eth_dev_hairpin_capability_get(uint16_t port_id,
  * @warning
  * @b EXPERIMENTAL: this structure may change without prior notice.
  *
- * ethernet device representor ID range entry
+ * Ethernet device representor ID range entry
  */
 struct rte_eth_representor_range {
 	enum rte_eth_representor_type type; /**< Representor type */
-- 
2.30.2

[dpdk-dev] [PATCH v2 4/9] ethdev: fix DCB and VMDq spelling

[Andrew Rybchenko]

Fix both in one changeset since they share line in a number of cases.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h |  2 +-
 lib/ethdev/rte_ethdev.h    | 42 +++++++++++++++++++-------------------
 2 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index fdaf20b3c8..9d570de3ef 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -661,7 +661,7 @@ typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
 /** @internal Get Traffic Metering and Policing (MTR) operations. */
 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
 
-/** @internal Get dcb information on an Ethernet device. */
+/** @internal Get DCB information on an Ethernet device. */
 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
 				 struct rte_eth_dcb_info *dcb_info);
 
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 6ae6d9ba99..d903f51196 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -83,7 +83,7 @@
  *     - MTU
  *     - flow control settings
  *     - receive mode configuration (promiscuous mode, all-multicast mode,
- *       hardware checksum mode, RSS/VMDQ settings etc.)
+ *       hardware checksum mode, RSS/VMDq settings etc.)
  *     - VLAN filtering configuration
  *     - default MAC address
  *     - MAC addresses supplied to MAC address array
@@ -365,7 +365,7 @@ struct rte_eth_thresh {
  *  packets to multiple queues.
  */
 enum rte_eth_rx_mq_mode {
-	/** None of DCB,RSS or VMDQ mode */
+	/** None of DCB, RSS or VMDq mode */
 	ETH_MQ_RX_NONE = 0,
 
 	/** For Rx side, only RSS is on */
@@ -375,13 +375,13 @@ enum rte_eth_rx_mq_mode {
 	/** Both DCB and RSS enable */
 	ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
 
-	/** Only VMDQ, no RSS nor DCB */
+	/** Only VMDq, no RSS nor DCB */
 	ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
-	/** RSS mode with VMDQ */
+	/** RSS mode with VMDq */
 	ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
-	/** Use VMDQ+DCB to route traffic to queues */
+	/** Use VMDq+DCB to route traffic to queues */
 	ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
-	/** Enable both VMDQ and DCB in VMDq */
+	/** Enable both VMDq and DCB in VMDq */
 	ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
 				 ETH_MQ_RX_VMDQ_FLAG,
 };
@@ -805,9 +805,9 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
 #define RTE_RETA_GROUP_SIZE   64
 
 /**@{@name VMDq and DCB maximums */
-#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDQ vlan filters. */
+#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDq vlan filters. */
 #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
-#define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDQ DCB queues. */
+#define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDq DCB queues. */
 #define ETH_DCB_NUM_QUEUES          128 /**< Maximum nb. of DCB queues. */
 /**@}*/
 
@@ -869,7 +869,7 @@ enum rte_eth_nb_tcs {
 
 /**
  * This enum indicates the possible number of queue pools
- * in VMDQ configurations.
+ * in VMDq configurations.
  */
 enum rte_eth_nb_pools {
 	ETH_8_POOLS = 8,    /**< 8 VMDq pools. */
@@ -902,7 +902,7 @@ struct rte_eth_vmdq_tx_conf {
 };
 
 /**
- * A structure used to configure the VMDQ+DCB feature
+ * A structure used to configure the VMDq+DCB feature
  * of an Ethernet port.
  *
  * Using this feature, packets are routed to a pool of queues, based
@@ -926,7 +926,7 @@ struct rte_eth_vmdq_dcb_conf {
 };
 
 /**
- * A structure used to configure the VMDQ feature of an Ethernet port when
+ * A structure used to configure the VMDq feature of an Ethernet port when
  * not combined with the DCB feature.
  *
  * Using this feature, packets are routed to a pool of queues. By default,
@@ -1321,19 +1321,19 @@ struct rte_eth_conf {
 				 are defined in implementation of each driver. */
 	struct {
 		struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
-		/** Port vmdq+dcb configuration. */
+		/** Port VMDq+DCB configuration. */
 		struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
-		/** Port dcb Rx configuration. */
+		/** Port DCB Rx configuration. */
 		struct rte_eth_dcb_rx_conf dcb_rx_conf;
-		/** Port vmdq Rx configuration. */
+		/** Port VMDq Rx configuration. */
 		struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
 	} rx_adv_conf; /**< Port Rx filtering configuration. */
 	union {
-		/** Port vmdq+dcb Tx configuration. */
+		/** Port VMDq+DCB Tx configuration. */
 		struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
-		/** Port dcb Tx configuration. */
+		/** Port DCB Tx configuration. */
 		struct rte_eth_dcb_tx_conf dcb_tx_conf;
-		/** Port vmdq Tx configuration. */
+		/** Port VMDq Tx configuration. */
 		struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
 	} tx_adv_conf; /**< Port Tx DCB configuration (union). */
 	/** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
@@ -1561,9 +1561,9 @@ struct rte_eth_dev_info {
 	uint64_t flow_type_rss_offloads;
 	struct rte_eth_rxconf default_rxconf; /**< Default Rx configuration */
 	struct rte_eth_txconf default_txconf; /**< Default Tx configuration */
-	uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
-	uint16_t vmdq_queue_num;  /**< Queue number for VMDQ pools. */
-	uint16_t vmdq_pool_base;  /**< First ID of VMDQ pools. */
+	uint16_t vmdq_queue_base; /**< First queue ID for VMDq pools. */
+	uint16_t vmdq_queue_num;  /**< Queue number for VMDq pools. */
+	uint16_t vmdq_pool_base;  /**< First ID of VMDq pools. */
 	struct rte_eth_desc_lim rx_desc_lim;  /**< Rx descriptors limits */
 	struct rte_eth_desc_lim tx_desc_lim;  /**< Tx descriptors limits */
 	uint32_t speed_capa;  /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
@@ -4113,7 +4113,7 @@ rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param dcb_info
- *   dcb information.
+ *   DCB information.
  * @return
  *   - (0) if successful.
  *   - (-ENODEV) if port identifier is invalid.
-- 
2.30.2

[dpdk-dev] [PATCH v2 5/9] ethdev: fix VLAN spelling including VLAN ID case

[Andrew Rybchenko]

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/rte_ethdev.c |  2 +-
 lib/ethdev/rte_ethdev.h | 30 +++++++++++++++---------------
 lib/ethdev/rte_flow.h   |  6 +++---
 3 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
index acb667c112..9d1793e216 100644
--- a/lib/ethdev/rte_ethdev.c
+++ b/lib/ethdev/rte_ethdev.c
@@ -3707,7 +3707,7 @@ rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on)
 
 	if (!(dev->data->dev_conf.rxmode.offloads &
 	      DEV_RX_OFFLOAD_VLAN_FILTER)) {
-		RTE_ETHDEV_LOG(ERR, "Port %u: vlan-filtering disabled\n",
+		RTE_ETHDEV_LOG(ERR, "Port %u: VLAN-filtering disabled\n",
 			port_id);
 		return -ENOSYS;
 	}
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index d903f51196..2c35caf000 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -444,7 +444,7 @@ enum rte_vlan_type {
 };
 
 /**
- * A structure used to describe a vlan filter.
+ * A structure used to describe a VLAN filter.
  * If the bit corresponding to a VID is set, such VID is on.
  */
 struct rte_vlan_filter_conf {
@@ -805,7 +805,7 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
 #define RTE_RETA_GROUP_SIZE   64
 
 /**@{@name VMDq and DCB maximums */
-#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDq vlan filters. */
+#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDq VLAN filters. */
 #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
 #define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDq DCB queues. */
 #define ETH_DCB_NUM_QUEUES          128 /**< Maximum nb. of DCB queues. */
@@ -906,11 +906,11 @@ struct rte_eth_vmdq_tx_conf {
  * of an Ethernet port.
  *
  * Using this feature, packets are routed to a pool of queues, based
- * on the vlan id in the vlan tag, and then to a specific queue within
- * that pool, using the user priority vlan tag field.
+ * on the VLAN ID in the VLAN tag, and then to a specific queue within
+ * that pool, using the user priority VLAN tag field.
  *
  * A default pool may be used, if desired, to route all traffic which
- * does not match the vlan filter rules.
+ * does not match the VLAN filter rules.
  */
 struct rte_eth_vmdq_dcb_conf {
 	enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
@@ -918,9 +918,9 @@ struct rte_eth_vmdq_dcb_conf {
 	uint8_t default_pool; /**< The default pool, if applicable */
 	uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
 	struct {
-		uint16_t vlan_id; /**< The vlan id of the received frame */
+		uint16_t vlan_id; /**< The VLAN ID of the received frame */
 		uint64_t pools;   /**< Bitmask of pools for packet Rx */
-	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
+	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */
 	/** Selects a queue in a pool */
 	uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
 };
@@ -930,8 +930,8 @@ struct rte_eth_vmdq_dcb_conf {
  * not combined with the DCB feature.
  *
  * Using this feature, packets are routed to a pool of queues. By default,
- * the pool selection is based on the MAC address, the vlan id in the
- * vlan tag as specified in the pool_map array.
+ * the pool selection is based on the MAC address, the VLAN ID in the
+ * VLAN tag as specified in the pool_map array.
  * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
  * selection using only the MAC address. MAC address to pool mapping is done
  * using the rte_eth_dev_mac_addr_add function, with the pool parameter
@@ -941,7 +941,7 @@ struct rte_eth_vmdq_dcb_conf {
  * it is enabled or revert to the first queue of the pool if not.
  *
  * A default pool may be used, if desired, to route all traffic which
- * does not match the vlan filter rules or any pool MAC address.
+ * does not match the VLAN filter rules or any pool MAC address.
  */
 struct rte_eth_vmdq_rx_conf {
 	enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
@@ -951,9 +951,9 @@ struct rte_eth_vmdq_rx_conf {
 	uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
 	uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
 	struct {
-		uint16_t vlan_id; /**< The vlan id of the received frame */
+		uint16_t vlan_id; /**< The VLAN ID of the received frame */
 		uint64_t pools;   /**< Bitmask of pools for packet Rx */
-	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
+	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */
 };
 
 /**
@@ -3127,9 +3127,9 @@ int rte_eth_dev_fw_version_get(uint16_t port_id,
  * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
  * packet types for these packets:
  * - Ether/IPv4              -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
- * - Ether/Vlan/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
+ * - Ether/VLAN/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
  * - Ether/[anything else]   -> RTE_PTYPE_L2_ETHER
- * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
+ * - Ether/VLAN/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
  *
  * When a packet is received by a PMD, the most precise type must be
  * returned among the ones supported. However a PMD is allowed to set
@@ -3275,7 +3275,7 @@ int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param vlan_type
- *   The vlan type.
+ *   The VLAN type.
  * @param tag_type
  *   The Tag Protocol ID
  * @return
diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index 45b360d4ac..e3c2277582 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -2181,7 +2181,7 @@ enum rte_flow_action_type {
 	RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN,
 
 	/**
-	 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as
+	 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN ID") as
 	 * defined by the OpenFlow Switch Specification.
 	 *
 	 * See struct rte_flow_action_of_set_vlan_vid.
@@ -2853,11 +2853,11 @@ struct rte_flow_action_of_push_vlan {
 /**
  * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID
  *
- * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as defined by
+ * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN ID") as defined by
  * the OpenFlow Switch Specification.
  */
 struct rte_flow_action_of_set_vlan_vid {
-	rte_be16_t vlan_vid; /**< VLAN id. */
+	rte_be16_t vlan_vid; /**< VLAN ID. */
 };
 
 /**
-- 
2.30.2

Re: [dpdk-dev] [PATCH v2 5/9] ethdev: fix VLAN spelling including VLAN ID case

[Ori Kam]

Hi Andrew,

> -----Original Message-----
> From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> Subject: [PATCH v2 5/9] ethdev: fix VLAN spelling including VLAN ID case
> 
> Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> ---
>  lib/ethdev/rte_ethdev.c |  2 +-
>  lib/ethdev/rte_ethdev.h | 30 +++++++++++++++---------------
>  lib/ethdev/rte_flow.h   |  6 +++---
>  3 files changed, 19 insertions(+), 19 deletions(-)
> 
> diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
> index acb667c112..9d1793e216 100644
> --- a/lib/ethdev/rte_ethdev.c
> +++ b/lib/ethdev/rte_ethdev.c
> @@ -3707,7 +3707,7 @@ rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on)
> 
>  	if (!(dev->data->dev_conf.rxmode.offloads &
>  	      DEV_RX_OFFLOAD_VLAN_FILTER)) {
> -		RTE_ETHDEV_LOG(ERR, "Port %u: vlan-filtering disabled\n",
> +		RTE_ETHDEV_LOG(ERR, "Port %u: VLAN-filtering disabled\n",
>  			port_id);
>  		return -ENOSYS;
>  	}
> diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
> index d903f51196..2c35caf000 100644
> --- a/lib/ethdev/rte_ethdev.h
> +++ b/lib/ethdev/rte_ethdev.h
> @@ -444,7 +444,7 @@ enum rte_vlan_type {
>  };
> 
>  /**
> - * A structure used to describe a vlan filter.
> + * A structure used to describe a VLAN filter.
>   * If the bit corresponding to a VID is set, such VID is on.
>   */
>  struct rte_vlan_filter_conf {
> @@ -805,7 +805,7 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
>  #define RTE_RETA_GROUP_SIZE   64
> 
>  /**@{@name VMDq and DCB maximums */
> -#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDq vlan filters. */
> +#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDq VLAN filters. */
>  #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
>  #define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDq DCB queues. */
>  #define ETH_DCB_NUM_QUEUES          128 /**< Maximum nb. of DCB queues. */
> @@ -906,11 +906,11 @@ struct rte_eth_vmdq_tx_conf {
>   * of an Ethernet port.
>   *
>   * Using this feature, packets are routed to a pool of queues, based
> - * on the vlan id in the vlan tag, and then to a specific queue within
> - * that pool, using the user priority vlan tag field.
> + * on the VLAN ID in the VLAN tag, and then to a specific queue within
> + * that pool, using the user priority VLAN tag field.
>   *
>   * A default pool may be used, if desired, to route all traffic which
> - * does not match the vlan filter rules.
> + * does not match the VLAN filter rules.
>   */
>  struct rte_eth_vmdq_dcb_conf {
>  	enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
> @@ -918,9 +918,9 @@ struct rte_eth_vmdq_dcb_conf {
>  	uint8_t default_pool; /**< The default pool, if applicable */
>  	uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
>  	struct {
> -		uint16_t vlan_id; /**< The vlan id of the received frame */
> +		uint16_t vlan_id; /**< The VLAN ID of the received frame */
>  		uint64_t pools;   /**< Bitmask of pools for packet Rx */
> -	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
> +	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */
>  	/** Selects a queue in a pool */
>  	uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
>  };
> @@ -930,8 +930,8 @@ struct rte_eth_vmdq_dcb_conf {
>   * not combined with the DCB feature.
>   *
>   * Using this feature, packets are routed to a pool of queues. By default,
> - * the pool selection is based on the MAC address, the vlan id in the
> - * vlan tag as specified in the pool_map array.
> + * the pool selection is based on the MAC address, the VLAN ID in the
> + * VLAN tag as specified in the pool_map array.
>   * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
>   * selection using only the MAC address. MAC address to pool mapping is done
>   * using the rte_eth_dev_mac_addr_add function, with the pool parameter
> @@ -941,7 +941,7 @@ struct rte_eth_vmdq_dcb_conf {
>   * it is enabled or revert to the first queue of the pool if not.
>   *
>   * A default pool may be used, if desired, to route all traffic which
> - * does not match the vlan filter rules or any pool MAC address.
> + * does not match the VLAN filter rules or any pool MAC address.
>   */
>  struct rte_eth_vmdq_rx_conf {
>  	enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
> @@ -951,9 +951,9 @@ struct rte_eth_vmdq_rx_conf {
>  	uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
>  	uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
>  	struct {
> -		uint16_t vlan_id; /**< The vlan id of the received frame */
> +		uint16_t vlan_id; /**< The VLAN ID of the received frame */
>  		uint64_t pools;   /**< Bitmask of pools for packet Rx */
> -	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
> +	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */
>  };
> 
>  /**
> @@ -3127,9 +3127,9 @@ int rte_eth_dev_fw_version_get(uint16_t port_id,
>   * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
>   * packet types for these packets:
>   * - Ether/IPv4              -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
> - * - Ether/Vlan/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
> + * - Ether/VLAN/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
>   * - Ether/[anything else]   -> RTE_PTYPE_L2_ETHER
> - * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
> + * - Ether/VLAN/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
>   *
>   * When a packet is received by a PMD, the most precise type must be
>   * returned among the ones supported. However a PMD is allowed to set
> @@ -3275,7 +3275,7 @@ int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t
> rx_queue_id,
>   * @param port_id
>   *   The port identifier of the Ethernet device.
>   * @param vlan_type
> - *   The vlan type.
> + *   The VLAN type.
>   * @param tag_type
>   *   The Tag Protocol ID
>   * @return
> diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
> index 45b360d4ac..e3c2277582 100644
> --- a/lib/ethdev/rte_flow.h
> +++ b/lib/ethdev/rte_flow.h
> @@ -2181,7 +2181,7 @@ enum rte_flow_action_type {
>  	RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN,
> 
>  	/**
> -	 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as
> +	 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN ID") as
>  	 * defined by the OpenFlow Switch Specification.
>  	 *
>  	 * See struct rte_flow_action_of_set_vlan_vid.
> @@ -2853,11 +2853,11 @@ struct rte_flow_action_of_push_vlan {
>  /**
>   * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID
>   *
> - * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as defined by
> + * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN ID") as defined by
>   * the OpenFlow Switch Specification.
>   */
>  struct rte_flow_action_of_set_vlan_vid {
> -	rte_be16_t vlan_vid; /**< VLAN id. */
> +	rte_be16_t vlan_vid; /**< VLAN ID. */
>  };
> 
>  /**
> --
> 2.30.2

Acked-by: Ori Kam <orika@nvidia.com>
Best,
Ori

[dpdk-dev] [PATCH v2 6/9] ethdev: fix ID spelling in comments and log messages

[Andrew Rybchenko]

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h  |  2 +-
 lib/ethdev/ethdev_private.h |  2 +-
 lib/ethdev/rte_class_eth.c  |  2 +-
 lib/ethdev/rte_ethdev.c     | 14 ++++-----
 lib/ethdev/rte_ethdev.h     | 62 ++++++++++++++++++-------------------
 lib/ethdev/rte_flow.h       |  4 +--
 6 files changed, 43 insertions(+), 43 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 9d570de3ef..09a9bcbb50 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -1391,7 +1391,7 @@ rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
  *
  * A pool of switch domain identifiers which can be allocated on request. This
  * will enabled devices which support the concept of switch domains to request
- * a switch domain id which is guaranteed to be unique from other devices
+ * a switch domain ID which is guaranteed to be unique from other devices
  * running in the same process.
  *
  * @param domain_id
diff --git a/lib/ethdev/ethdev_private.h b/lib/ethdev/ethdev_private.h
index 5721be7bdc..cc91025e8d 100644
--- a/lib/ethdev/ethdev_private.h
+++ b/lib/ethdev/ethdev_private.h
@@ -10,7 +10,7 @@
 #include "rte_ethdev.h"
 
 /*
- * Convert rte_eth_dev pointer to port id.
+ * Convert rte_eth_dev pointer to port ID.
  * NULL will be translated to RTE_MAX_ETHPORTS.
  */
 uint16_t eth_dev_to_id(const struct rte_eth_dev *dev);
diff --git a/lib/ethdev/rte_class_eth.c b/lib/ethdev/rte_class_eth.c
index eda216ced5..c8e8fc9244 100644
--- a/lib/ethdev/rte_class_eth.c
+++ b/lib/ethdev/rte_class_eth.c
@@ -90,7 +90,7 @@ eth_representor_cmp(const char *key __rte_unused,
 	np = eth_da.nb_ports > 0 ? eth_da.nb_ports : 1;
 	nf = eth_da.nb_representor_ports > 0 ? eth_da.nb_representor_ports : 1;
 
-	/* Return 0 if representor id is matching one of the values. */
+	/* Return 0 if representor ID is matching one of the values. */
 	for (i = 0; i < nc * np * nf; ++i) {
 		c = i / (np * nf);
 		p = (i / nf) % np;
diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
index 9d1793e216..02c2034000 100644
--- a/lib/ethdev/rte_ethdev.c
+++ b/lib/ethdev/rte_ethdev.c
@@ -538,7 +538,7 @@ rte_eth_dev_allocate(const char *name)
 
 /*
  * Attach to a port already registered by the primary process, which
- * makes sure that the same device would have the same port id both
+ * makes sure that the same device would have the same port ID both
  * in the primary and secondary process.
  */
 struct rte_eth_dev *
@@ -668,7 +668,7 @@ eth_dev_owner_set(const uint16_t port_id, const uint64_t old_owner_id,
 	struct rte_eth_dev_owner *port_owner;
 
 	if (port_id >= RTE_MAX_ETHPORTS || !eth_dev_is_allocated(ethdev)) {
-		RTE_ETHDEV_LOG(ERR, "Port id %"PRIu16" is not allocated\n",
+		RTE_ETHDEV_LOG(ERR, "Port ID %"PRIu16" is not allocated\n",
 			port_id);
 		return -ENODEV;
 	}
@@ -760,7 +760,7 @@ rte_eth_dev_owner_delete(const uint64_t owner_id)
 			owner_id);
 	} else {
 		RTE_ETHDEV_LOG(ERR,
-			       "Invalid owner id=%016"PRIx64"\n",
+			       "Invalid owner ID=%016"PRIx64"\n",
 			       owner_id);
 		ret = -EINVAL;
 	}
@@ -779,7 +779,7 @@ rte_eth_dev_owner_get(const uint16_t port_id, struct rte_eth_dev_owner *owner)
 	ethdev = &rte_eth_devices[port_id];
 
 	if (!eth_dev_is_allocated(ethdev)) {
-		RTE_ETHDEV_LOG(ERR, "Port id %"PRIu16" is not allocated\n",
+		RTE_ETHDEV_LOG(ERR, "Port ID %"PRIu16" is not allocated\n",
 			port_id);
 		return -ENODEV;
 	}
@@ -4327,7 +4327,7 @@ rte_eth_dev_mac_addr_add(uint16_t port_id, struct rte_ether_addr *addr,
 		return -EINVAL;
 	}
 	if (pool >= ETH_64_POOLS) {
-		RTE_ETHDEV_LOG(ERR, "Pool id must be 0-%d\n", ETH_64_POOLS - 1);
+		RTE_ETHDEV_LOG(ERR, "Pool ID must be 0-%d\n", ETH_64_POOLS - 1);
 		return -EINVAL;
 	}
 
@@ -4552,7 +4552,7 @@ int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
 
 	if (queue_idx > dev_info.max_tx_queues) {
 		RTE_ETHDEV_LOG(ERR,
-			"Set queue rate limit:port %u: invalid queue id=%u\n",
+			"Set queue rate limit:port %u: invalid queue ID=%u\n",
 			port_id, queue_idx);
 		return -EINVAL;
 	}
@@ -6409,7 +6409,7 @@ rte_eth_rx_metadata_negotiate(uint16_t port_id, uint64_t *features)
 
 	if (dev->data->dev_configured != 0) {
 		RTE_ETHDEV_LOG(ERR,
-			"The port (id=%"PRIu16") is already configured\n",
+			"The port (ID=%"PRIu16") is already configured\n",
 			port_id);
 		return -EBUSY;
 	}
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 2c35caf000..f7be628f7d 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -197,7 +197,7 @@ int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
  * Iterates on devices with devargs filter.
  * The ownership is not checked.
  *
- * The next port id is returned, and the iterator is updated.
+ * The next port ID is returned, and the iterator is updated.
  *
  * @param iter
  *   Device iterator handle initialized by rte_eth_iterator_init().
@@ -205,7 +205,7 @@ int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
  *   by calling rte_eth_iterator_cleanup().
  *
  * @return
- *   A port id if found, RTE_MAX_ETHPORTS otherwise.
+ *   A port ID if found, RTE_MAX_ETHPORTS otherwise.
  */
 uint16_t rte_eth_iterator_next(struct rte_dev_iterator *iter);
 
@@ -230,7 +230,7 @@ void rte_eth_iterator_cleanup(struct rte_dev_iterator *iter);
  * the function rte_eth_iterator_cleanup() must be called.
  *
  * @param id
- *   Iterated port id of type uint16_t.
+ *   Iterated port ID of type uint16_t.
  * @param devargs
  *   Device parameters input as string of type char*.
  * @param iter
@@ -935,7 +935,7 @@ struct rte_eth_vmdq_dcb_conf {
  * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
  * selection using only the MAC address. MAC address to pool mapping is done
  * using the rte_eth_dev_mac_addr_add function, with the pool parameter
- * corresponding to the pool id.
+ * corresponding to the pool ID.
  *
  * Queue selection within the selected pool will be done using RSS when
  * it is enabled or revert to the first queue of the pool if not.
@@ -1471,7 +1471,7 @@ struct rte_eth_dev_portconf {
 };
 
 /**
- * Default values for switch domain id when ethdev does not support switch
+ * Default values for switch domain ID when ethdev does not support switch
  * domain definitions.
  */
 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID	(UINT16_MAX)
@@ -1481,7 +1481,7 @@ struct rte_eth_dev_portconf {
  */
 struct rte_eth_switch_info {
 	const char *name;	/**< switch name */
-	uint16_t domain_id;	/**< switch domain id */
+	uint16_t domain_id;	/**< switch domain ID */
 	/**
 	 * Mapping to the devices physical switch port as enumerated from the
 	 * perspective of the embedded interconnect/switch. For SR-IOV enabled
@@ -1644,7 +1644,7 @@ struct rte_eth_burst_mode {
  * This structure is used by rte_eth_xstats_get() to provide
  * statistics that are not provided in the generic *rte_eth_stats*
  * structure.
- * It maps a name id, corresponding to an index in the array returned
+ * It maps a name ID, corresponding to an index in the array returned
  * by rte_eth_xstats_get_names(), to a statistic value.
  */
 struct rte_eth_xstat {
@@ -1860,12 +1860,12 @@ struct rte_eth_dev_owner {
  * Iterates over valid ethdev ports owned by a specific owner.
  *
  * @param port_id
- *   The id of the next possible valid owned port.
+ *   The ID of the next possible valid owned port.
  * @param	owner_id
  *  The owner identifier.
  *  RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports.
  * @return
- *   Next valid port id owned by owner_id, RTE_MAX_ETHPORTS if there is none.
+ *   Next valid port ID owned by owner_id, RTE_MAX_ETHPORTS if there is none.
  */
 uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
 		const uint64_t owner_id);
@@ -1882,9 +1882,9 @@ uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
  * Iterates over valid ethdev ports.
  *
  * @param port_id
- *   The id of the next possible valid port.
+ *   The ID of the next possible valid port.
  * @return
- *   Next valid port id, RTE_MAX_ETHPORTS if there is none.
+ *   Next valid port ID, RTE_MAX_ETHPORTS if there is none.
  */
 uint16_t rte_eth_find_next(uint16_t port_id);
 
@@ -1898,11 +1898,11 @@ uint16_t rte_eth_find_next(uint16_t port_id);
  * Iterates over ethdev ports of a specified device.
  *
  * @param port_id_start
- *   The id of the next possible valid port.
+ *   The ID of the next possible valid port.
  * @param parent
  *   The generic device behind the ports to iterate.
  * @return
- *   Next port id of the device, possibly port_id_start,
+ *   Next port ID of the device, possibly port_id_start,
  *   RTE_MAX_ETHPORTS if there is none.
  */
 uint16_t
@@ -1913,7 +1913,7 @@ rte_eth_find_next_of(uint16_t port_id_start,
  * Macro to iterate over all ethdev ports of a specified device.
  *
  * @param port_id
- *   The id of the matching port being iterated.
+ *   The ID of the matching port being iterated.
  * @param parent
  *   The rte_device pointer matching the iterated ports.
  */
@@ -1926,11 +1926,11 @@ rte_eth_find_next_of(uint16_t port_id_start,
  * Iterates over sibling ethdev ports (i.e. sharing the same rte_device).
  *
  * @param port_id_start
- *   The id of the next possible valid sibling port.
+ *   The ID of the next possible valid sibling port.
  * @param ref_port_id
- *   The id of a reference port to compare rte_device with.
+ *   The ID of a reference port to compare rte_device with.
  * @return
- *   Next sibling port id, possibly port_id_start or ref_port_id itself,
+ *   Next sibling port ID, possibly port_id_start or ref_port_id itself,
  *   RTE_MAX_ETHPORTS if there is none.
  */
 uint16_t
@@ -1942,9 +1942,9 @@ rte_eth_find_next_sibling(uint16_t port_id_start, uint16_t ref_port_id);
  * Note: the specified reference port is part of the loop iterations.
  *
  * @param port_id
- *   The id of the matching port being iterated.
+ *   The ID of the matching port being iterated.
  * @param ref_port_id
- *   The id of the port being compared.
+ *   The ID of the port being compared.
  */
 #define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id) \
 	for (port_id = rte_eth_find_next_sibling(0, ref_port_id); \
@@ -2413,7 +2413,7 @@ int rte_eth_hairpin_unbind(uint16_t tx_port, uint16_t rx_port);
  * @param port_id
  *   The port identifier of the Ethernet device
  * @return
- *   The NUMA socket id to which the Ethernet device is connected or
+ *   The NUMA socket ID to which the Ethernet device is connected or
  *   a default of zero if the socket could not be determined.
  *   -1 is returned is the port_id value is out of range.
  */
@@ -2575,7 +2575,7 @@ int rte_eth_dev_set_link_down(uint16_t port_id);
 int rte_eth_dev_close(uint16_t port_id);
 
 /**
- * Reset a Ethernet device and keep its port id.
+ * Reset a Ethernet device and keep its port ID.
  *
  * When a port has to be reset passively, the DPDK application can invoke
  * this function. For example when a PF is reset, all its VFs should also
@@ -2586,7 +2586,7 @@ int rte_eth_dev_close(uint16_t port_id);
  * When this function is called, it first stops the port and then calls the
  * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
  * state, in which no Tx and Rx queues are setup, as if the port has been
- * reset and not started. The port keeps the port id it had before the
+ * reset and not started. The port keeps the port ID it had before the
  * function call.
  *
  * After calling rte_eth_dev_reset( ), the application should use
@@ -2821,7 +2821,7 @@ int rte_eth_stats_reset(uint16_t port_id);
  *     is too small. The return value corresponds to the size that should
  *     be given to succeed. The entries in the table are not valid and
  *     shall not be used by the caller.
- *   - A negative value on error (invalid port id).
+ *   - A negative value on error (invalid port ID).
  */
 int rte_eth_xstats_get_names(uint16_t port_id,
 		struct rte_eth_xstat_name *xstats_names,
@@ -2854,7 +2854,7 @@ int rte_eth_xstats_get_names(uint16_t port_id,
  *     is too small. The return value corresponds to the size that should
  *     be given to succeed. The entries in the table are not valid and
  *     shall not be used by the caller.
- *   - A negative value on error (invalid port id).
+ *   - A negative value on error (invalid port ID).
  */
 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
 		unsigned int n);
@@ -3554,7 +3554,7 @@ typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
  * Register a callback function for port event.
  *
  * @param port_id
- *  Port id.
+ *  Port ID.
  *  RTE_ETH_ALL means register the event for all port ids.
  * @param event
  *  Event interested.
@@ -3575,7 +3575,7 @@ int rte_eth_dev_callback_register(uint16_t port_id,
  * Unregister a callback function for port event.
  *
  * @param port_id
- *  Port id.
+ *  Port ID.
  *  RTE_ETH_ALL means unregister the event for all port ids.
  * @param event
  *  Event interested.
@@ -4007,7 +4007,7 @@ int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param queue_idx
- *   The queue id.
+ *   The queue ID.
  * @param tx_rate
  *   The Tx rate in Mbps. Allocated from the total port link speed.
  * @return
@@ -4709,7 +4709,7 @@ int
 rte_eth_read_clock(uint16_t port_id, uint64_t *clock);
 
 /**
-* Get the port id from device name. The device name should be specified
+* Get the port ID from device name. The device name should be specified
 * as below:
 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0
 * - SoC device name, for example- fsl-gmac0
@@ -4727,7 +4727,7 @@ int
 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
 
 /**
-* Get the device name from port id. The device name is specified as below:
+* Get the device name from port ID. The device name is specified as below:
 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0
 * - SoC device name, for example- fsl-gmac0
 * - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0]
@@ -5105,7 +5105,7 @@ rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
  * @param port_id
  *  The port identifier of the Ethernet device.
  * @param queue_id
- *  The queue id on the specific port.
+ *  The queue ID on the specific port.
  * @return
  *  The number of used descriptors in the specific queue, or:
  *   - (-ENODEV) if *port_id* is invalid.
@@ -5455,7 +5455,7 @@ rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
- *   The value must be a valid port id.
+ *   The value must be a valid port ID.
  * @param queue_id
  *   The index of the transmit queue through which output packets must be
  *   sent.
diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index e3c2277582..9546453762 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -2624,12 +2624,12 @@ struct rte_flow_query_age {
  * Adds a counter action to a matched flow.
  *
  * If more than one count action is specified in a single flow rule, then each
- * action must specify a unique id.
+ * action must specify a unique ID.
  *
  * Counters can be retrieved and reset through ``rte_flow_query()``, see
  * ``struct rte_flow_query_count``.
  *
- * For ports within the same switch domain then the counter id namespace extends
+ * For ports within the same switch domain then the counter ID namespace extends
  * to all ports within that switch domain.
  */
 struct rte_flow_action_count {
-- 
2.30.2

[dpdk-dev] [PATCH v2 7/9] ethdev: remove reserved fields from internal structures

[Andrew Rybchenko]

Fixes: 8ea354d92f80 ("ethdev: hide eth dev related structures")

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 09a9bcbb50..7bfc43a99b 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -75,9 +75,6 @@ struct rte_eth_dev {
 	struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 	enum rte_eth_dev_state state; /**< Flag indicating the port state */
 	void *security_ctx; /**< Context for security ops */
-
-	uint64_t reserved_64s[4]; /**< Reserved for future fields */
-	void *reserved_ptrs[4];   /**< Reserved for future fields */
 } __rte_cache_aligned;
 
 struct rte_eth_dev_sriov;
@@ -158,8 +155,6 @@ struct rte_eth_dev_data {
 	uint16_t backer_port_id;
 
 	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
-	uint64_t reserved_64s[4]; /**< Reserved for future fields */
-	void *reserved_ptrs[4];   /**< Reserved for future fields */
 } __rte_cache_aligned;
 
 /**
-- 
2.30.2

[dpdk-dev] [PATCH v2 8/9] ethdev: make device and data structures readable

[Andrew Rybchenko]

Add empty lines to separate fields commented using different styles.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 7bfc43a99b..dee6b26a5f 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -44,6 +44,7 @@ struct rte_eth_rxtx_callback {
 struct rte_eth_dev {
 	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
 	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
+
 	/** Pointer to PMD transmit prepare function. */
 	eth_tx_prep_t tx_pkt_prepare;
 	/** Get the number of used Rx descriptors. */
@@ -61,6 +62,7 @@ struct rte_eth_dev {
 	const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
 	struct rte_device *device; /**< Backing device */
 	struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
+
 	/** User application callbacks for NIC interrupts */
 	struct rte_eth_dev_cb_list link_intr_cbs;
 	/**
@@ -73,6 +75,7 @@ struct rte_eth_dev {
 	 * received packets before passing them to the driver for transmission.
 	 */
 	struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
+
 	enum rte_eth_dev_state state; /**< Flag indicating the port state */
 	void *security_ctx; /**< Context for security ops */
 } __rte_cache_aligned;
@@ -102,10 +105,12 @@ struct rte_eth_dev_data {
 	struct rte_eth_link dev_link;   /**< Link-level information & status. */
 	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
 	uint16_t mtu;                   /**< Maximum Transmission Unit. */
+
 	/** Common Rx buffer size handled by all queues. */
 	uint32_t min_rx_buf_size;
 
 	uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures. */
+
 	/** Device Ethernet link address. @see rte_eth_dev_release_port(). */
 	struct rte_ether_addr *mac_addrs;
 	/** Bitmap associating MAC addresses to pools. */
@@ -115,6 +120,7 @@ struct rte_eth_dev_data {
 	 * @see rte_eth_dev_release_port()
 	 */
 	struct rte_ether_addr *hash_mac_addrs;
+
 	uint16_t port_id;           /**< Device [external] port identifier. */
 
 	__extension__
@@ -133,15 +139,20 @@ struct rte_eth_dev_data {
 		 * CONFIGURED(1) / NOT CONFIGURED(0).
 		 */
 		dev_configured : 1;
+
 	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
 	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
+
 	uint32_t dev_flags;             /**< Capabilities. */
 	int numa_node;                  /**< NUMA node connection. */
+
 	/** VLAN filter configuration. */
 	struct rte_vlan_filter_conf vlan_filter_conf;
+
 	struct rte_eth_dev_owner owner; /**< The port owner. */
+
 	/**
 	 * Switch-specific identifier.
 	 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
-- 
2.30.2

[dpdk-dev] [PATCH v2 9/9] ethdev: remove full stop after short comments and references

[Andrew Rybchenko]

Full stop at the end of short comment just make line longer. It
should be either everywhere or nowhere to be consistent.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 68 +++++++++++++++++++-------------------
 1 file changed, 34 insertions(+), 34 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index dee6b26a5f..a50ea87ca0 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -42,23 +42,23 @@ struct rte_eth_rxtx_callback {
  * process, while the actual configuration data for the device is shared.
  */
 struct rte_eth_dev {
-	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
-	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
+	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function */
+	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function */
 
-	/** Pointer to PMD transmit prepare function. */
+	/** Pointer to PMD transmit prepare function */
 	eth_tx_prep_t tx_pkt_prepare;
-	/** Get the number of used Rx descriptors. */
+	/** Get the number of used Rx descriptors */
 	eth_rx_queue_count_t rx_queue_count;
-	/** Check the status of a Rx descriptor. */
+	/** Check the status of a Rx descriptor */
 	eth_rx_descriptor_status_t rx_descriptor_status;
-	/** Check the status of a Tx descriptor. */
+	/** Check the status of a Tx descriptor */
 	eth_tx_descriptor_status_t tx_descriptor_status;
 
 	/**
-	 * Device data that is shared between primary and secondary processes.
+	 * Device data that is shared between primary and secondary processes
 	 */
 	struct rte_eth_dev_data *data;
-	void *process_private; /**< Pointer to per-process device data. */
+	void *process_private; /**< Pointer to per-process device data */
 	const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
 	struct rte_device *device; /**< Backing device */
 	struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
@@ -72,7 +72,7 @@ struct rte_eth_dev {
 	struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 	/**
 	 * User-supplied functions called from tx_burst to pre-process
-	 * received packets before passing them to the driver for transmission.
+	 * received packets before passing them to the driver for transmission
 	 */
 	struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 
@@ -92,28 +92,28 @@ struct rte_eth_dev_owner;
 struct rte_eth_dev_data {
 	char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
 
-	void **rx_queues; /**< Array of pointers to Rx queues. */
-	void **tx_queues; /**< Array of pointers to Tx queues. */
-	uint16_t nb_rx_queues; /**< Number of Rx queues. */
-	uint16_t nb_tx_queues; /**< Number of Tx queues. */
+	void **rx_queues; /**< Array of pointers to Rx queues */
+	void **tx_queues; /**< Array of pointers to Tx queues */
+	uint16_t nb_rx_queues; /**< Number of Rx queues */
+	uint16_t nb_tx_queues; /**< Number of Tx queues */
 
 	struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 
-	/** PMD-specific private data. @see rte_eth_dev_release_port(). */
+	/** PMD-specific private data. @see rte_eth_dev_release_port() */
 	void *dev_private;
 
-	struct rte_eth_link dev_link;   /**< Link-level information & status. */
-	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
-	uint16_t mtu;                   /**< Maximum Transmission Unit. */
+	struct rte_eth_link dev_link;   /**< Link-level information & status */
+	struct rte_eth_conf dev_conf;   /**< Configuration applied to device */
+	uint16_t mtu;                   /**< Maximum Transmission Unit */
 
-	/** Common Rx buffer size handled by all queues. */
+	/** Common Rx buffer size handled by all queues */
 	uint32_t min_rx_buf_size;
 
-	uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures. */
+	uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures */
 
-	/** Device Ethernet link address. @see rte_eth_dev_release_port(). */
+	/** Device Ethernet link address. @see rte_eth_dev_release_port() */
 	struct rte_ether_addr *mac_addrs;
-	/** Bitmap associating MAC addresses to pools. */
+	/** Bitmap associating MAC addresses to pools */
 	uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
 	/**
 	 * Device Ethernet MAC addresses of hash filtering.
@@ -121,37 +121,37 @@ struct rte_eth_dev_data {
 	 */
 	struct rte_ether_addr *hash_mac_addrs;
 
-	uint16_t port_id;           /**< Device [external] port identifier. */
+	uint16_t port_id;           /**< Device [external] port identifier */
 
 	__extension__
-	uint8_t /** Rx promiscuous mode ON(1) / OFF(0). */
+	uint8_t /** Rx promiscuous mode ON(1) / OFF(0) */
 		promiscuous   : 1,
 		/** Rx of scattered packets is ON(1) / OFF(0) */
 		scattered_rx : 1,
-		/** Rx all multicast mode ON(1) / OFF(0). */
+		/** Rx all multicast mode ON(1) / OFF(0) */
 		all_multicast : 1,
-		/** Device state: STARTED(1) / STOPPED(0). */
+		/** Device state: STARTED(1) / STOPPED(0) */
 		dev_started : 1,
 		/** Rx LRO is ON(1) / OFF(0) */
 		lro         : 1,
 		/**
-		 * Indicates whether the device is configured.
-		 * CONFIGURED(1) / NOT CONFIGURED(0).
+		 * Indicates whether the device is configured:
+		 * CONFIGURED(1) / NOT CONFIGURED(0)
 		 */
 		dev_configured : 1;
 
-	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
+	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
 	uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
-	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
+	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
 	uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
 
-	uint32_t dev_flags;             /**< Capabilities. */
-	int numa_node;                  /**< NUMA node connection. */
+	uint32_t dev_flags;             /**< Capabilities */
+	int numa_node;                  /**< NUMA node connection */
 
-	/** VLAN filter configuration. */
+	/** VLAN filter configuration */
 	struct rte_vlan_filter_conf vlan_filter_conf;
 
-	struct rte_eth_dev_owner owner; /**< The port owner. */
+	struct rte_eth_dev_owner owner; /**< The port owner */
 
 	/**
 	 * Switch-specific identifier.
@@ -165,7 +165,7 @@ struct rte_eth_dev_data {
 	 */
 	uint16_t backer_port_id;
 
-	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
+	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex */
 } __rte_cache_aligned;
 
 /**
-- 
2.30.2

Re: [dpdk-dev] [PATCH v2 0/9] ethdev: cosmetic fixes

[Ferruh Yigit]

On 10/20/2021 8:42 AM, Andrew Rybchenko wrote:
> Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
> right now is a good chance to make a cleanup. Moreover ethdev is
> or will be shuffled a lot in the release, so do cleanup in all
> files.
> 
> Maybe at least some fixes from below could be accepted.
> 
> Spelling is fixed in log messages as well. Hopefully it isn ot a
> problem, but let me know if I'm wrong and I'll avoid it in the
> next version.
> 
> Since changes are cosmetic no Fixes tags and no backporting to
> stable.
> 
> Andrew Rybchenko (9):
>    ethdev: avoid documentation in next lines
>    ethdev: fix Rx/Tx spelling
>    ethdev: fix Ethernet spelling
>    ethdev: fix DCB and VMDq spelling
>    ethdev: fix VLAN spelling including VLAN ID case
>    ethdev: fix ID spelling in comments and log messages
>    ethdev: remove reserved fields from internal structures
>    ethdev: make device and data structures readable
>    ethdev: remove full stop after short comments and references
> 

I am OK with changes in principal, will look more detailed later.

Only patch 9/9 also can be extended to whole file, instead of just
moved structures.

Re: [dpdk-dev] [PATCH v2 0/9] ethdev: cosmetic fixes

[Andrew Rybchenko]

On 10/20/21 12:31 PM, Ferruh Yigit wrote:
> On 10/20/2021 8:42 AM, Andrew Rybchenko wrote:
>> Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
>> right now is a good chance to make a cleanup. Moreover ethdev is
>> or will be shuffled a lot in the release, so do cleanup in all
>> files.
>>
>> Maybe at least some fixes from below could be accepted.
>>
>> Spelling is fixed in log messages as well. Hopefully it isn ot a
>> problem, but let me know if I'm wrong and I'll avoid it in the
>> next version.
>>
>> Since changes are cosmetic no Fixes tags and no backporting to
>> stable.
>>
>> Andrew Rybchenko (9):
>>    ethdev: avoid documentation in next lines
>>    ethdev: fix Rx/Tx spelling
>>    ethdev: fix Ethernet spelling
>>    ethdev: fix DCB and VMDq spelling
>>    ethdev: fix VLAN spelling including VLAN ID case
>>    ethdev: fix ID spelling in comments and log messages
>>    ethdev: remove reserved fields from internal structures
>>    ethdev: make device and data structures readable
>>    ethdev: remove full stop after short comments and references
>>
> 
> I am OK with changes in principal, will look more detailed later.
> 
> Only patch 9/9 also can be extended to whole file, instead of just
> moved structures.

OK, I'll send v3 in an hour.

[dpdk-dev] [PATCH v3 00/10] ethdev: cosmetic fixes

[Andrew Rybchenko]

Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
right now is a good chance to make a cleanup. Moreover ethdev is
or will be shuffled a lot in the release, so do cleanup in all
files.

Maybe at least some fixes from below could be accepted.

Spelling is fixed in log messages as well. Hopefully it isn ot a
problem, but let me know if I'm wrong and I'll avoid it in the
next version.

Since changes are cosmetic no Fixes tags and no backporting to
stable.

v3:
    - fix EEPROM spelling
    - cleanup full stop in structure fields documentation in
      entire ethdev_driver.h
    - do more in the first patch which moves documentation to
      avoid long lines and apply some cosmeic fixes on the way
      when line is moved to avoid changes in next patches

Andrew Rybchenko (10):
  ethdev: avoid documentation in next lines
  ethdev: fix Rx/Tx spelling
  ethdev: fix Ethernet spelling
  ethdev: fix DCB and VMDq spelling
  ethdev: fix VLAN spelling including VLAN ID case
  ethdev: fix ID spelling in comments and log messages
  ethdev: fix EEPROM spelling
  ethdev: remove reserved fields from internal structures
  ethdev: make device and data structures readable
  ethdev: remove full stop after short comments and references

 lib/ethdev/ethdev_driver.h   | 575 +++++++++++++++++++----------------
 lib/ethdev/ethdev_pci.h      |   2 +-
 lib/ethdev/ethdev_private.h  |   2 +-
 lib/ethdev/ethdev_profile.c  |   6 +-
 lib/ethdev/ethdev_vdev.h     |   2 +-
 lib/ethdev/rte_class_eth.c   |   2 +-
 lib/ethdev/rte_dev_info.h    |  14 +-
 lib/ethdev/rte_eth_ctrl.h    |   2 +-
 lib/ethdev/rte_ethdev.c      |  66 ++--
 lib/ethdev/rte_ethdev.h      | 518 +++++++++++++++----------------
 lib/ethdev/rte_ethdev_core.h |  20 +-
 lib/ethdev/rte_flow.h        |  48 +--
 lib/ethdev/rte_mtr_driver.h  |  30 +-
 lib/ethdev/rte_tm.h          |  14 +-
 14 files changed, 677 insertions(+), 624 deletions(-)

-- 
2.30.2

[dpdk-dev] [PATCH v3 01/10] ethdev: avoid documentation in next lines

[Andrew Rybchenko]

Documentation in the next separate line is confusing. If documentation
requires own line it should be before, not after.

Move documentation to the previous line if documention on the same
line makes it too long.

Fix a number of incorrect markups on the way.

When a lines is touched by the patch anyway, do other cosmetics
changes to avoid changes in next patches.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h   | 375 +++++++++++++++++++----------------
 lib/ethdev/rte_ethdev.h      | 134 +++++++------
 lib/ethdev/rte_ethdev_core.h |  18 +-
 lib/ethdev/rte_flow.h        |  38 ++--
 lib/ethdev/rte_mtr_driver.h  |  30 +--
 5 files changed, 321 insertions(+), 274 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 0174ba03d7..8ccc4f6015 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -44,18 +44,17 @@ struct rte_eth_rxtx_callback {
 struct rte_eth_dev {
 	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
 	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
+	/** Pointer to PMD transmit prepare function */
 	eth_tx_prep_t tx_pkt_prepare;
-	/**< Pointer to PMD transmit prepare function. */
+	/** Get the number of used Rx descriptors */
 	eth_rx_queue_count_t rx_queue_count;
-	/**< Get the number of used RX descriptors. */
+	/** Check the status of a Rx descriptor */
 	eth_rx_descriptor_status_t rx_descriptor_status;
-	/**< Check the status of a Rx descriptor. */
+	/** Check the status of a Tx descriptor */
 	eth_tx_descriptor_status_t tx_descriptor_status;
-	/**< Check the status of a Tx descriptor. */
 
 	/**
-	 * points to device data that is shared between
-	 * primary and secondary processes.
+	 * Device data that is shared between primary and secondary processes
 	 */
 	struct rte_eth_dev_data *data;
 	void *process_private; /**< Pointer to per-process device data. */
@@ -100,64 +99,63 @@ struct rte_eth_dev_data {
 
 	struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 
+	/** PMD-specific private data. @see rte_eth_dev_release_port() */
 	void *dev_private;
-			/**< PMD-specific private data.
-			 *   @see rte_eth_dev_release_port()
-			 */
 
 	struct rte_eth_link dev_link;   /**< Link-level information & status. */
 	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
 	uint16_t mtu;                   /**< Maximum Transmission Unit. */
+	/** Common Rx buffer size handled by all queues */
 	uint32_t min_rx_buf_size;
-			/**< Common RX buffer size handled by all queues. */
 
 	uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
+	/** Device Ethernet link address. @see rte_eth_dev_release_port() */
 	struct rte_ether_addr *mac_addrs;
-			/**< Device Ethernet link address.
-			 *   @see rte_eth_dev_release_port()
-			 */
+	/** Bitmap associating MAC addresses to pools */
 	uint64_t mac_pool_sel[ETH_NUM_RECEIVE_MAC_ADDR];
-			/**< Bitmap associating MAC addresses to pools. */
+	/**
+	 * Device Ethernet MAC addresses of hash filtering.
+	 * @see rte_eth_dev_release_port()
+	 */
 	struct rte_ether_addr *hash_mac_addrs;
-			/**< Device Ethernet MAC addresses of hash filtering.
-			 *   @see rte_eth_dev_release_port()
-			 */
 	uint16_t port_id;           /**< Device [external] port identifier. */
 
 	__extension__
-	uint8_t promiscuous   : 1,
-		/**< RX promiscuous mode ON(1) / OFF(0). */
+	uint8_t /** Rx promiscuous mode ON(1) / OFF(0) */
+		promiscuous   : 1,
+		/** Rx of scattered packets is ON(1) / OFF(0) */
 		scattered_rx : 1,
-		/**< RX of scattered packets is ON(1) / OFF(0) */
+		/** Rx all multicast mode ON(1) / OFF(0) */
 		all_multicast : 1,
-		/**< RX all multicast mode ON(1) / OFF(0). */
+		/** Device state: STARTED(1) / STOPPED(0) */
 		dev_started : 1,
-		/**< Device state: STARTED(1) / STOPPED(0). */
+		/** Rx LRO is ON(1) / OFF(0) */
 		lro         : 1,
-		/**< RX LRO is ON(1) / OFF(0) */
-		dev_configured : 1;
-		/**< Indicates whether the device is configured.
-		 *   CONFIGURED(1) / NOT CONFIGURED(0).
+		/**
+		 * Indicates whether the device is configured:
+		 * CONFIGURED(1) / NOT CONFIGURED(0)
 		 */
+		dev_configured : 1;
+	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
 	uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
-		/**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
+	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
 	uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
-		/**< Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0). */
 	uint32_t dev_flags;             /**< Capabilities. */
 	int numa_node;                  /**< NUMA node connection. */
+	/** VLAN filter configuration */
 	struct rte_vlan_filter_conf vlan_filter_conf;
-			/**< VLAN filter configuration. */
 	struct rte_eth_dev_owner owner; /**< The port owner. */
+	/**
+	 * Switch-specific identifier.
+	 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
+	 */
 	uint16_t representor_id;
-			/**< Switch-specific identifier.
-			 *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
-			 */
+	/**
+	 * Port ID of the backing device.
+	 * This device will be used to query representor info and calculate
+	 * representor IDs. Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
+	 */
 	uint16_t backer_port_id;
-			/**< Port ID of the backing device.
-			 *   This device will be used to query representor
-			 *   info and calculate representor IDs.
-			 *   Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
-			 */
 
 	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
 	uint64_t reserved_64s[4]; /**< Reserved for future fields */
@@ -171,7 +169,7 @@ struct rte_eth_dev_data {
  */
 extern struct rte_eth_dev rte_eth_devices[];
 
-/**< @internal Declaration of the hairpin peer queue information structure. */
+/** @internal Declaration of the hairpin peer queue information structure. */
 struct rte_hairpin_peer_info;
 
 /*
@@ -180,29 +178,29 @@ struct rte_hairpin_peer_info;
  * structure associated with an Ethernet device.
  */
 
+/** @internal Ethernet device configuration. */
 typedef int  (*eth_dev_configure_t)(struct rte_eth_dev *dev);
-/**< @internal Ethernet device configuration. */
 
+/** @internal Function used to start a configured Ethernet device. */
 typedef int  (*eth_dev_start_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to start a configured Ethernet device. */
 
+/** @internal Function used to stop a configured Ethernet device. */
 typedef int (*eth_dev_stop_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to stop a configured Ethernet device. */
 
+/** @internal Function used to link up a configured Ethernet device. */
 typedef int  (*eth_dev_set_link_up_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to link up a configured Ethernet device. */
 
+/** @internal Function used to link down a configured Ethernet device. */
 typedef int  (*eth_dev_set_link_down_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to link down a configured Ethernet device. */
 
+/** @internal Function used to close a configured Ethernet device. */
 typedef int (*eth_dev_close_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to close a configured Ethernet device. */
 
+/** @internal Function used to reset a configured Ethernet device. */
 typedef int (*eth_dev_reset_t)(struct rte_eth_dev *dev);
-/** <@internal Function used to reset a configured Ethernet device. */
 
+/** @internal Function used to detect an Ethernet device removal. */
 typedef int (*eth_is_removed_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to detect an Ethernet device removal. */
 
 /**
  * @internal
@@ -304,13 +302,16 @@ typedef int (*eth_allmulticast_enable_t)(struct rte_eth_dev *dev);
  */
 typedef int (*eth_allmulticast_disable_t)(struct rte_eth_dev *dev);
 
+/**
+ * @internal
+ * Get link speed, duplex mode and state (up/down) of an Ethernet device.
+ */
 typedef int (*eth_link_update_t)(struct rte_eth_dev *dev,
 				int wait_to_complete);
-/**< @internal Get link speed, duplex mode and state (up/down) of an Ethernet device. */
 
+/** @internal Get global I/O statistics of an Ethernet device. */
 typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
 				struct rte_eth_stats *igb_stats);
-/**< @internal Get global I/O statistics of an Ethernet device. */
 
 /**
  * @internal
@@ -333,9 +334,9 @@ typedef int (*eth_stats_get_t)(struct rte_eth_dev *dev,
  */
 typedef int (*eth_stats_reset_t)(struct rte_eth_dev *dev);
 
+/** @internal Get extended stats of an Ethernet device. */
 typedef int (*eth_xstats_get_t)(struct rte_eth_dev *dev,
 	struct rte_eth_xstat *stats, unsigned int n);
-/**< @internal Get extended stats of an Ethernet device. */
 
 /**
  * @internal
@@ -381,9 +382,9 @@ typedef int (*eth_xstats_get_by_id_t)(struct rte_eth_dev *dev,
  */
 typedef int (*eth_xstats_reset_t)(struct rte_eth_dev *dev);
 
+/** @internal Get names of extended stats of an Ethernet device. */
 typedef int (*eth_xstats_get_names_t)(struct rte_eth_dev *dev,
 	struct rte_eth_xstat_name *xstats_names, unsigned int size);
-/**< @internal Get names of extended stats of an Ethernet device. */
 
 /**
  * @internal
@@ -407,18 +408,21 @@ typedef int (*eth_xstats_get_names_by_id_t)(struct rte_eth_dev *dev,
 	const uint64_t *ids, struct rte_eth_xstat_name *xstats_names,
 	unsigned int size);
 
+/**
+ * @internal
+ * Set a queue statistics mapping for a Tx/Rx queue of an Ethernet device.
+ */
 typedef int (*eth_queue_stats_mapping_set_t)(struct rte_eth_dev *dev,
 					     uint16_t queue_id,
 					     uint8_t stat_idx,
 					     uint8_t is_rx);
-/**< @internal Set a queue statistics mapping for a tx/rx queue of an Ethernet device. */
 
+/** @internal Get specific information of an Ethernet device. */
 typedef int (*eth_dev_infos_get_t)(struct rte_eth_dev *dev,
 				   struct rte_eth_dev_info *dev_info);
-/**< @internal Get specific information of an Ethernet device. */
 
+/** @internal Get supported ptypes of an Ethernet device. */
 typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *dev);
-/**< @internal Get supported ptypes of an Ethernet device. */
 
 /**
  * @internal
@@ -435,47 +439,47 @@ typedef const uint32_t *(*eth_dev_supported_ptypes_get_t)(struct rte_eth_dev *de
 typedef int (*eth_dev_ptypes_set_t)(struct rte_eth_dev *dev,
 				     uint32_t ptype_mask);
 
+/** @internal Start Rx and Tx of a queue of an Ethernet device. */
 typedef int (*eth_queue_start_t)(struct rte_eth_dev *dev,
 				    uint16_t queue_id);
-/**< @internal Start rx and tx of a queue of an Ethernet device. */
 
+/** @internal Stop Rx and Tx of a queue of an Ethernet device. */
 typedef int (*eth_queue_stop_t)(struct rte_eth_dev *dev,
 				    uint16_t queue_id);
-/**< @internal Stop rx and tx of a queue of an Ethernet device. */
 
+/** @internal Set up a receive queue of an Ethernet device. */
 typedef int (*eth_rx_queue_setup_t)(struct rte_eth_dev *dev,
 				    uint16_t rx_queue_id,
 				    uint16_t nb_rx_desc,
 				    unsigned int socket_id,
 				    const struct rte_eth_rxconf *rx_conf,
 				    struct rte_mempool *mb_pool);
-/**< @internal Set up a receive queue of an Ethernet device. */
 
+/** @internal Setup a transmit queue of an Ethernet device. */
 typedef int (*eth_tx_queue_setup_t)(struct rte_eth_dev *dev,
 				    uint16_t tx_queue_id,
 				    uint16_t nb_tx_desc,
 				    unsigned int socket_id,
 				    const struct rte_eth_txconf *tx_conf);
-/**< @internal Setup a transmit queue of an Ethernet device. */
 
+/** @internal Enable interrupt of a receive queue of an Ethernet device. */
 typedef int (*eth_rx_enable_intr_t)(struct rte_eth_dev *dev,
 				    uint16_t rx_queue_id);
-/**< @internal Enable interrupt of a receive queue of an Ethernet device. */
 
+/** @internal Disable interrupt of a receive queue of an Ethernet device. */
 typedef int (*eth_rx_disable_intr_t)(struct rte_eth_dev *dev,
 				    uint16_t rx_queue_id);
-/**< @internal Disable interrupt of a receive queue of an Ethernet device. */
 
+/** @internal Release memory resources allocated by given Rx/Tx queue. */
 typedef void (*eth_queue_release_t)(struct rte_eth_dev *dev,
 				    uint16_t queue_id);
-/**< @internal Release memory resources allocated by given RX/TX queue. */
 
+/** @internal Get firmware information of an Ethernet device. */
 typedef int (*eth_fw_version_get_t)(struct rte_eth_dev *dev,
 				     char *fw_version, size_t fw_size);
-/**< @internal Get firmware information of an Ethernet device. */
 
+/** @internal Force mbufs to be from Tx ring. */
 typedef int (*eth_tx_done_cleanup_t)(void *txq, uint32_t free_cnt);
-/**< @internal Force mbufs to be from TX ring. */
 
 typedef void (*eth_rxq_info_get_t)(struct rte_eth_dev *dev,
 	uint16_t rx_queue_id, struct rte_eth_rxq_info *qinfo);
@@ -486,159 +490,159 @@ typedef void (*eth_txq_info_get_t)(struct rte_eth_dev *dev,
 typedef int (*eth_burst_mode_get_t)(struct rte_eth_dev *dev,
 	uint16_t queue_id, struct rte_eth_burst_mode *mode);
 
+/** @internal Set MTU. */
 typedef int (*mtu_set_t)(struct rte_eth_dev *dev, uint16_t mtu);
-/**< @internal Set MTU. */
 
+/** @internal Filtering of a VLAN Tag Identifier by an Ethernet device. */
 typedef int (*vlan_filter_set_t)(struct rte_eth_dev *dev,
 				  uint16_t vlan_id,
 				  int on);
-/**< @internal filtering of a VLAN Tag Identifier by an Ethernet device. */
 
+/** @internal Set the outer/inner VLAN-TPID by an Ethernet device. */
 typedef int (*vlan_tpid_set_t)(struct rte_eth_dev *dev,
 			       enum rte_vlan_type type, uint16_t tpid);
-/**< @internal set the outer/inner VLAN-TPID by an Ethernet device. */
 
+/** @internal Set VLAN offload function by an Ethernet device. */
 typedef int (*vlan_offload_set_t)(struct rte_eth_dev *dev, int mask);
-/**< @internal set VLAN offload function by an Ethernet device. */
 
+/** @internal Set port based Tx VLAN insertion by an Ethernet device. */
 typedef int (*vlan_pvid_set_t)(struct rte_eth_dev *dev,
 			       uint16_t vlan_id,
 			       int on);
-/**< @internal set port based TX VLAN insertion by an Ethernet device. */
 
+/** @internal VLAN stripping enable/disable by an queue of Ethernet device. */
 typedef void (*vlan_strip_queue_set_t)(struct rte_eth_dev *dev,
 				  uint16_t rx_queue_id,
 				  int on);
-/**< @internal VLAN stripping enable/disable by an queue of Ethernet device. */
 
+/** @internal Get current flow control parameter on an Ethernet device. */
 typedef int (*flow_ctrl_get_t)(struct rte_eth_dev *dev,
 			       struct rte_eth_fc_conf *fc_conf);
-/**< @internal Get current flow control parameter on an Ethernet device */
 
+/** @internal Setup flow control parameter on an Ethernet device. */
 typedef int (*flow_ctrl_set_t)(struct rte_eth_dev *dev,
 			       struct rte_eth_fc_conf *fc_conf);
-/**< @internal Setup flow control parameter on an Ethernet device */
 
+/** @internal Setup priority flow control parameter on an Ethernet device. */
 typedef int (*priority_flow_ctrl_set_t)(struct rte_eth_dev *dev,
 				struct rte_eth_pfc_conf *pfc_conf);
-/**< @internal Setup priority flow control parameter on an Ethernet device */
 
+/** @internal Update RSS redirection table on an Ethernet device. */
 typedef int (*reta_update_t)(struct rte_eth_dev *dev,
 			     struct rte_eth_rss_reta_entry64 *reta_conf,
 			     uint16_t reta_size);
-/**< @internal Update RSS redirection table on an Ethernet device */
 
+/** @internal Query RSS redirection table on an Ethernet device. */
 typedef int (*reta_query_t)(struct rte_eth_dev *dev,
 			    struct rte_eth_rss_reta_entry64 *reta_conf,
 			    uint16_t reta_size);
-/**< @internal Query RSS redirection table on an Ethernet device */
 
+/** @internal Update RSS hash configuration of an Ethernet device. */
 typedef int (*rss_hash_update_t)(struct rte_eth_dev *dev,
 				 struct rte_eth_rss_conf *rss_conf);
-/**< @internal Update RSS hash configuration of an Ethernet device */
 
+/** @internal Get current RSS hash configuration of an Ethernet device. */
 typedef int (*rss_hash_conf_get_t)(struct rte_eth_dev *dev,
 				   struct rte_eth_rss_conf *rss_conf);
-/**< @internal Get current RSS hash configuration of an Ethernet device */
 
+/** @internal Turn on SW controllable LED on an Ethernet device. */
 typedef int (*eth_dev_led_on_t)(struct rte_eth_dev *dev);
-/**< @internal Turn on SW controllable LED on an Ethernet device */
 
+/** @internal Turn off SW controllable LED on an Ethernet device. */
 typedef int (*eth_dev_led_off_t)(struct rte_eth_dev *dev);
-/**< @internal Turn off SW controllable LED on an Ethernet device */
 
+/** @internal Remove MAC address from receive address register. */
 typedef void (*eth_mac_addr_remove_t)(struct rte_eth_dev *dev, uint32_t index);
-/**< @internal Remove MAC address from receive address register */
 
+/** @internal Set a MAC address into Receive Address Register. */
 typedef int (*eth_mac_addr_add_t)(struct rte_eth_dev *dev,
 				  struct rte_ether_addr *mac_addr,
 				  uint32_t index,
 				  uint32_t vmdq);
-/**< @internal Set a MAC address into Receive Address Register */
 
+/** @internal Set a MAC address into Receive Address Register. */
 typedef int (*eth_mac_addr_set_t)(struct rte_eth_dev *dev,
 				  struct rte_ether_addr *mac_addr);
-/**< @internal Set a MAC address into Receive Address Register */
 
+/** @internal Set a Unicast Hash bitmap. */
 typedef int (*eth_uc_hash_table_set_t)(struct rte_eth_dev *dev,
 				  struct rte_ether_addr *mac_addr,
 				  uint8_t on);
-/**< @internal Set a Unicast Hash bitmap */
 
+/** @internal Set all Unicast Hash bitmap. */
 typedef int (*eth_uc_all_hash_table_set_t)(struct rte_eth_dev *dev,
 				  uint8_t on);
-/**< @internal Set all Unicast Hash bitmap */
 
+/** @internal Set queue Tx rate. */
 typedef int (*eth_set_queue_rate_limit_t)(struct rte_eth_dev *dev,
 				uint16_t queue_idx,
 				uint16_t tx_rate);
-/**< @internal Set queue TX rate */
 
+/** @internal Add tunneling UDP port. */
 typedef int (*eth_udp_tunnel_port_add_t)(struct rte_eth_dev *dev,
 					 struct rte_eth_udp_tunnel *tunnel_udp);
-/**< @internal Add tunneling UDP port */
 
+/** @internal Delete tunneling UDP port. */
 typedef int (*eth_udp_tunnel_port_del_t)(struct rte_eth_dev *dev,
 					 struct rte_eth_udp_tunnel *tunnel_udp);
-/**< @internal Delete tunneling UDP port */
 
+/** @internal set the list of multicast addresses on an Ethernet device. */
 typedef int (*eth_set_mc_addr_list_t)(struct rte_eth_dev *dev,
 				      struct rte_ether_addr *mc_addr_set,
 				      uint32_t nb_mc_addr);
-/**< @internal set the list of multicast addresses on an Ethernet device */
 
+/** @internal Function used to enable IEEE1588/802.1AS timestamping. */
 typedef int (*eth_timesync_enable_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to enable IEEE1588/802.1AS timestamping. */
 
+/** @internal Function used to disable IEEE1588/802.1AS timestamping. */
 typedef int (*eth_timesync_disable_t)(struct rte_eth_dev *dev);
-/**< @internal Function used to disable IEEE1588/802.1AS timestamping. */
 
+/** @internal Function used to read an Rx IEEE1588/802.1AS timestamp. */
 typedef int (*eth_timesync_read_rx_timestamp_t)(struct rte_eth_dev *dev,
 						struct timespec *timestamp,
 						uint32_t flags);
-/**< @internal Function used to read an RX IEEE1588/802.1AS timestamp. */
 
+/** @internal Function used to read a Tx IEEE1588/802.1AS timestamp. */
 typedef int (*eth_timesync_read_tx_timestamp_t)(struct rte_eth_dev *dev,
 						struct timespec *timestamp);
-/**< @internal Function used to read a TX IEEE1588/802.1AS timestamp. */
 
+/** @internal Function used to adjust the device clock. */
 typedef int (*eth_timesync_adjust_time)(struct rte_eth_dev *dev, int64_t);
-/**< @internal Function used to adjust the device clock */
 
+/** @internal Function used to get time from the device clock. */
 typedef int (*eth_timesync_read_time)(struct rte_eth_dev *dev,
 				      struct timespec *timestamp);
-/**< @internal Function used to get time from the device clock. */
 
+/** @internal Function used to get time from the device clock. */
 typedef int (*eth_timesync_write_time)(struct rte_eth_dev *dev,
 				       const struct timespec *timestamp);
-/**< @internal Function used to get time from the device clock */
 
+/** @internal Function used to get the current value of the device clock. */
 typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
 				      uint64_t *timestamp);
-/**< @internal Function used to get the current value of the device clock. */
 
+/** @internal Retrieve registers. */
 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
 				struct rte_dev_reg_info *info);
-/**< @internal Retrieve registers  */
 
+/** @internal Retrieve eeprom size. */
 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
-/**< @internal Retrieve eeprom size  */
 
+/** @internal Retrieve eeprom data. */
 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
 				struct rte_dev_eeprom_info *info);
-/**< @internal Retrieve eeprom data  */
 
+/** @internal Program eeprom data. */
 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
 				struct rte_dev_eeprom_info *info);
-/**< @internal Program eeprom data  */
 
+/** @internal Retrieve type and size of plugin module eeprom. */
 typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
 				     struct rte_eth_dev_module_info *modinfo);
-/**< @internal Retrieve type and size of plugin module eeprom */
 
+/** @internal Retrieve plugin module eeprom data. */
 typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
 				       struct rte_dev_eeprom_info *info);
-/**< @internal Retrieve plugin module eeprom data */
 
 struct rte_flow_ops;
 /**
@@ -651,19 +655,19 @@ struct rte_flow_ops;
 typedef int (*eth_flow_ops_get_t)(struct rte_eth_dev *dev,
 				  const struct rte_flow_ops **ops);
 
+/** @internal Get Traffic Management (TM) operations on an Ethernet device. */
 typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
-/**< @internal Get Traffic Management (TM) operations on an Ethernet device */
 
+/** @internal Get Traffic Metering and Policing (MTR) operations. */
 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
-/**< @internal Get Traffic Metering and Policing (MTR) operations */
 
+/** @internal Get dcb information on an Ethernet device. */
 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
 				 struct rte_eth_dcb_info *dcb_info);
-/**< @internal Get dcb information on an Ethernet device */
 
+/** @internal Test if a port supports specific mempool ops. */
 typedef int (*eth_pool_ops_supported_t)(struct rte_eth_dev *dev,
 						const char *pool);
-/**< @internal Test if a port supports specific mempool ops */
 
 /**
  * @internal
@@ -905,20 +909,20 @@ typedef int (*eth_hairpin_bind_t)(struct rte_eth_dev *dev,
 typedef int (*eth_hairpin_unbind_t)(struct rte_eth_dev *dev,
 				  uint16_t rx_port);
 
+/** @internal Update and fetch peer queue information. */
 typedef int (*eth_hairpin_queue_peer_update_t)
 	(struct rte_eth_dev *dev, uint16_t peer_queue,
 	 struct rte_hairpin_peer_info *current_info,
 	 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
-/**< @internal Update and fetch peer queue information. */
 
+/** @internal Bind peer queue to the current queue with fetched information. */
 typedef int (*eth_hairpin_queue_peer_bind_t)
 	(struct rte_eth_dev *dev, uint16_t cur_queue,
 	 struct rte_hairpin_peer_info *peer_info, uint32_t direction);
-/**< @internal Bind peer queue to the current queue with fetched information. */
 
+/** @internal Unbind peer queue from the current queue. */
 typedef int (*eth_hairpin_queue_peer_unbind_t)
 	(struct rte_eth_dev *dev, uint16_t cur_queue, uint32_t direction);
-/**< @internal Unbind peer queue from the current queue. */
 
 /**
  * @internal
@@ -992,8 +996,8 @@ struct eth_dev_ops {
 	eth_dev_close_t            dev_close;     /**< Close device. */
 	eth_dev_reset_t		   dev_reset;	  /**< Reset device. */
 	eth_link_update_t          link_update;   /**< Get device link state. */
+	/** Check if the device was physically removed */
 	eth_is_removed_t           is_removed;
-	/**< Check if the device was physically removed. */
 
 	eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON. */
 	eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF. */
@@ -1002,34 +1006,50 @@ struct eth_dev_ops {
 	eth_mac_addr_remove_t      mac_addr_remove; /**< Remove MAC address. */
 	eth_mac_addr_add_t         mac_addr_add;  /**< Add a MAC address. */
 	eth_mac_addr_set_t         mac_addr_set;  /**< Set a MAC address. */
-	eth_set_mc_addr_list_t     set_mc_addr_list; /**< set list of mcast addrs. */
+	/** Set list of multicast addresses */
+	eth_set_mc_addr_list_t     set_mc_addr_list;
 	mtu_set_t                  mtu_set;       /**< Set MTU. */
 
-	eth_stats_get_t            stats_get;     /**< Get generic device statistics. */
-	eth_stats_reset_t          stats_reset;   /**< Reset generic device statistics. */
-	eth_xstats_get_t           xstats_get;    /**< Get extended device statistics. */
-	eth_xstats_reset_t         xstats_reset;  /**< Reset extended device statistics. */
+	/** Get generic device statistics */
+	eth_stats_get_t            stats_get;
+	/** Reset generic device statistics */
+	eth_stats_reset_t          stats_reset;
+	/** Get extended device statistics */
+	eth_xstats_get_t           xstats_get;
+	/** Reset extended device statistics */
+	eth_xstats_reset_t         xstats_reset;
+	/** Get names of extended statistics */
 	eth_xstats_get_names_t     xstats_get_names;
-	/**< Get names of extended statistics. */
+	/** Configure per queue stat counter mapping */
 	eth_queue_stats_mapping_set_t queue_stats_mapping_set;
-	/**< Configure per queue stat counter mapping. */
 
 	eth_dev_infos_get_t        dev_infos_get; /**< Get device info. */
-	eth_rxq_info_get_t         rxq_info_get; /**< retrieve RX queue information. */
-	eth_txq_info_get_t         txq_info_get; /**< retrieve TX queue information. */
+	/** Retrieve Rx queue information */
+	eth_rxq_info_get_t         rxq_info_get;
+	/** Retrieve Tx queue information */
+	eth_txq_info_get_t         txq_info_get;
 	eth_burst_mode_get_t       rx_burst_mode_get; /**< Get RX burst mode */
 	eth_burst_mode_get_t       tx_burst_mode_get; /**< Get TX burst mode */
 	eth_fw_version_get_t       fw_version_get; /**< Get firmware version. */
+
+	/** Get packet types supported and identified by device */
 	eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
-	/**< Get packet types supported and identified by device. */
+	/**
+	 * Inform Ethernet device about reduced range of packet types to
+	 * handle
+	 */
 	eth_dev_ptypes_set_t dev_ptypes_set;
-	/**< Inform Ethernet device about reduced range of packet types to handle. */
 
-	vlan_filter_set_t          vlan_filter_set; /**< Filter VLAN Setup. */
-	vlan_tpid_set_t            vlan_tpid_set; /**< Outer/Inner VLAN TPID Setup. */
-	vlan_strip_queue_set_t     vlan_strip_queue_set; /**< VLAN Stripping on queue. */
-	vlan_offload_set_t         vlan_offload_set; /**< Set VLAN Offload. */
-	vlan_pvid_set_t            vlan_pvid_set; /**< Set port based TX VLAN insertion. */
+	/** Filter VLAN Setup */
+	vlan_filter_set_t          vlan_filter_set;
+	/** Outer/Inner VLAN TPID Setup */
+	vlan_tpid_set_t            vlan_tpid_set;
+	/** VLAN Stripping on queue */
+	vlan_strip_queue_set_t     vlan_strip_queue_set;
+	/** Set VLAN Offload */
+	vlan_offload_set_t         vlan_offload_set;
+	/** Set port based Tx VLAN insertion */
+	vlan_pvid_set_t            vlan_pvid_set;
 
 	eth_queue_start_t          rx_queue_start;/**< Start RX for a queue. */
 	eth_queue_stop_t           rx_queue_stop; /**< Stop RX for a queue. */
@@ -1038,8 +1058,11 @@ struct eth_dev_ops {
 	eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device RX queue. */
 	eth_queue_release_t        rx_queue_release; /**< Release RX queue. */
 
-	eth_rx_enable_intr_t       rx_queue_intr_enable;  /**< Enable Rx queue interrupt. */
-	eth_rx_disable_intr_t      rx_queue_intr_disable; /**< Disable Rx queue interrupt. */
+	/** Enable Rx queue interrupt */
+	eth_rx_enable_intr_t       rx_queue_intr_enable;
+	/** Disable Rx queue interrupt */
+	eth_rx_disable_intr_t      rx_queue_intr_disable;
+
 	eth_tx_queue_setup_t       tx_queue_setup;/**< Set up device TX queue. */
 	eth_queue_release_t        tx_queue_release; /**< Release TX queue. */
 	eth_tx_done_cleanup_t      tx_done_cleanup;/**< Free tx ring mbufs */
@@ -1049,94 +1072,108 @@ struct eth_dev_ops {
 
 	flow_ctrl_get_t            flow_ctrl_get; /**< Get flow control. */
 	flow_ctrl_set_t            flow_ctrl_set; /**< Setup flow control. */
-	priority_flow_ctrl_set_t   priority_flow_ctrl_set; /**< Setup priority flow control. */
-
-	eth_uc_hash_table_set_t    uc_hash_table_set; /**< Set Unicast Table Array. */
-	eth_uc_all_hash_table_set_t uc_all_hash_table_set; /**< Set Unicast hash bitmap. */
-
-	eth_udp_tunnel_port_add_t  udp_tunnel_port_add; /** Add UDP tunnel port. */
-	eth_udp_tunnel_port_del_t  udp_tunnel_port_del; /** Del UDP tunnel port. */
-
-	eth_set_queue_rate_limit_t set_queue_rate_limit; /**< Set queue rate limit. */
-
-	rss_hash_update_t          rss_hash_update; /** Configure RSS hash protocols. */
-	rss_hash_conf_get_t        rss_hash_conf_get; /** Get current RSS hash configuration. */
-	reta_update_t              reta_update;   /** Update redirection table. */
-	reta_query_t               reta_query;    /** Query redirection table. */
+	/** Setup priority flow control */
+	priority_flow_ctrl_set_t   priority_flow_ctrl_set;
+
+	/** Set Unicast Table Array */
+	eth_uc_hash_table_set_t    uc_hash_table_set;
+	/** Set Unicast hash bitmap */
+	eth_uc_all_hash_table_set_t uc_all_hash_table_set;
+
+	/** Add UDP tunnel port */
+	eth_udp_tunnel_port_add_t  udp_tunnel_port_add;
+	/** Delete UDP tunnel port */
+	eth_udp_tunnel_port_del_t  udp_tunnel_port_del;
+
+	/** Set queue rate limit */
+	eth_set_queue_rate_limit_t set_queue_rate_limit;
+
+	/** Configure RSS hash protocols and hashing key */
+	rss_hash_update_t          rss_hash_update;
+	/** Get current RSS hash configuration */
+	rss_hash_conf_get_t        rss_hash_conf_get;
+	/** Update redirection table */
+	reta_update_t              reta_update;
+	/** Query redirection table */
+	reta_query_t               reta_query;
 
 	eth_get_reg_t              get_reg;           /**< Get registers. */
 	eth_get_eeprom_length_t    get_eeprom_length; /**< Get eeprom length. */
 	eth_get_eeprom_t           get_eeprom;        /**< Get eeprom data. */
 	eth_set_eeprom_t           set_eeprom;        /**< Set eeprom. */
 
+	/** Get plugin module eeprom attribute */
 	eth_get_module_info_t      get_module_info;
-	/** Get plugin module eeprom attribute. */
+	/** Get plugin module eeprom data */
 	eth_get_module_eeprom_t    get_module_eeprom;
-	/** Get plugin module eeprom data. */
 
 	eth_flow_ops_get_t         flow_ops_get; /**< Get flow operations. */
 
-	eth_get_dcb_info           get_dcb_info; /** Get DCB information. */
+	eth_get_dcb_info           get_dcb_info; /**< Get DCB information */
 
+	/** Turn IEEE1588/802.1AS timestamping on */
 	eth_timesync_enable_t      timesync_enable;
-	/** Turn IEEE1588/802.1AS timestamping on. */
+	/** Turn IEEE1588/802.1AS timestamping off */
 	eth_timesync_disable_t     timesync_disable;
-	/** Turn IEEE1588/802.1AS timestamping off. */
+	/** Read the IEEE1588/802.1AS Rx timestamp */
 	eth_timesync_read_rx_timestamp_t timesync_read_rx_timestamp;
-	/** Read the IEEE1588/802.1AS RX timestamp. */
+	/** Read the IEEE1588/802.1AS Tx timestamp */
 	eth_timesync_read_tx_timestamp_t timesync_read_tx_timestamp;
-	/** Read the IEEE1588/802.1AS TX timestamp. */
-	eth_timesync_adjust_time   timesync_adjust_time; /** Adjust the device clock. */
-	eth_timesync_read_time     timesync_read_time; /** Get the device clock time. */
-	eth_timesync_write_time    timesync_write_time; /** Set the device clock time. */
+	/** Adjust the device clock */
+	eth_timesync_adjust_time   timesync_adjust_time;
+	/** Get the device clock time */
+	eth_timesync_read_time     timesync_read_time;
+	/** Set the device clock time */
+	eth_timesync_write_time    timesync_write_time;
 
 	eth_read_clock             read_clock;
 
+	/** Get extended device statistic values by ID */
 	eth_xstats_get_by_id_t     xstats_get_by_id;
-	/**< Get extended device statistic values by ID. */
+	/** Get name of extended device statistics by ID */
 	eth_xstats_get_names_by_id_t xstats_get_names_by_id;
-	/**< Get name of extended device statistics by ID. */
 
+	/** Get Traffic Management (TM) operations */
 	eth_tm_ops_get_t tm_ops_get;
-	/**< Get Traffic Management (TM) operations. */
 
+	/** Get Traffic Metering and Policing (MTR) operations */
 	eth_mtr_ops_get_t mtr_ops_get;
-	/**< Get Traffic Metering and Policing (MTR) operations. */
 
+	/** Test if a port supports specific mempool ops */
 	eth_pool_ops_supported_t pool_ops_supported;
-	/**< Test if a port supports specific mempool ops */
 
+	/** Returns the hairpin capabilities */
 	eth_hairpin_cap_get_t hairpin_cap_get;
-	/**< Returns the hairpin capabilities. */
+	/** Set up device Rx hairpin queue */
 	eth_rx_hairpin_queue_setup_t rx_hairpin_queue_setup;
-	/**< Set up device RX hairpin queue. */
+	/** Set up device Tx hairpin queue */
 	eth_tx_hairpin_queue_setup_t tx_hairpin_queue_setup;
-	/**< Set up device TX hairpin queue. */
 
+	/** Get Forward Error Correction(FEC) capability */
 	eth_fec_get_capability_t fec_get_capability;
-	/**< Get Forward Error Correction(FEC) capability. */
+	/** Get Forward Error Correction(FEC) mode */
 	eth_fec_get_t fec_get;
-	/**< Get Forward Error Correction(FEC) mode. */
+	/** Set Forward Error Correction(FEC) mode */
 	eth_fec_set_t fec_set;
-	/**< Set Forward Error Correction(FEC) mode. */
+
+	/** Get hairpin peer ports list */
 	hairpin_get_peer_ports_t hairpin_get_peer_ports;
-	/**< Get hairpin peer ports list. */
+	/** Bind all hairpin Tx queues of device to the peer port Rx queues */
 	eth_hairpin_bind_t hairpin_bind;
-	/**< Bind all hairpin Tx queues of device to the peer port Rx queues. */
+	/** Unbind all hairpin Tx queues from the peer port Rx queues */
 	eth_hairpin_unbind_t hairpin_unbind;
-	/**< Unbind all hairpin Tx queues from the peer port Rx queues. */
+	/** Pass the current queue info and get the peer queue info */
 	eth_hairpin_queue_peer_update_t hairpin_queue_peer_update;
-	/**< Pass the current queue info and get the peer queue info. */
+	/** Set up the connection between the pair of hairpin queues */
 	eth_hairpin_queue_peer_bind_t hairpin_queue_peer_bind;
-	/**< Set up the connection between the pair of hairpin queues. */
+	/** Disconnect the hairpin queues of a pair from each other */
 	eth_hairpin_queue_peer_unbind_t hairpin_queue_peer_unbind;
-	/**< Disconnect the hairpin queues of a pair from each other. */
 
+	/** Get power monitoring condition for Rx queue */
 	eth_get_monitor_addr_t get_monitor_addr;
-	/**< Get power monitoring condition for Rx queue. */
 
+	/** Get representor info */
 	eth_representor_info_get_t representor_info_get;
-	/**< Get representor info. */
 
 	/**
 	 * Negotiate the NIC's ability to deliver specific
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 69766eaae2..2d43c226f6 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -256,24 +256,25 @@ struct rte_eth_stats {
 	uint64_t opackets;  /**< Total number of successfully transmitted packets.*/
 	uint64_t ibytes;    /**< Total number of successfully received bytes. */
 	uint64_t obytes;    /**< Total number of successfully transmitted bytes. */
-	uint64_t imissed;
-	/**< Total of RX packets dropped by the HW,
+	/**
+	 * Total of RX packets dropped by the HW,
 	 * because there are no available buffer (i.e. RX queues are full).
 	 */
+	uint64_t imissed;
 	uint64_t ierrors;   /**< Total number of erroneous received packets. */
 	uint64_t oerrors;   /**< Total number of failed transmitted packets. */
 	uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
 	/* Queue stats are limited to max 256 queues */
+	/** Total number of queue RX packets. */
 	uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/**< Total number of queue RX packets. */
+	/** Total number of queue TX packets. */
 	uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/**< Total number of queue TX packets. */
+	/** Total number of successfully received queue bytes. */
 	uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/**< Total number of successfully received queue bytes. */
+	/** Total number of successfully transmitted queue bytes. */
 	uint64_t q_obytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/**< Total number of successfully transmitted queue bytes. */
+	/** Total number of queue packets received that are dropped. */
 	uint64_t q_errors[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/**< Total number of queue packets received that are dropped. */
 };
 
 /**@{@name Link speed capabilities
@@ -499,8 +500,8 @@ struct rte_eth_rss_conf {
 #define RTE_ETH_FLOW_IPV6_EX            15
 #define RTE_ETH_FLOW_IPV6_TCP_EX        16
 #define RTE_ETH_FLOW_IPV6_UDP_EX        17
+/** Consider device port number as a flow differentiator */
 #define RTE_ETH_FLOW_PORT               18
-	/**< Consider device port number as a flow differentiator */
 #define RTE_ETH_FLOW_VXLAN              19 /**< VXLAN protocol based flow */
 #define RTE_ETH_FLOW_GENEVE             20 /**< GENEVE protocol based flow */
 #define RTE_ETH_FLOW_NVGRE              21 /**< NVGRE protocol based flow */
@@ -768,7 +769,7 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
 	ETH_RSS_S_VLAN  | \
 	ETH_RSS_C_VLAN)
 
-/**< Mask of valid RSS hash protocols */
+/** Mask of valid RSS hash protocols */
 #define ETH_RSS_PROTO_MASK ( \
 	ETH_RSS_IPV4 | \
 	ETH_RSS_FRAG_IPV4 | \
@@ -851,10 +852,10 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
  * is needed.
  */
 struct rte_eth_rss_reta_entry64 {
+	/** Mask bits indicate which entries need to be updated/queried. */
 	uint64_t mask;
-	/**< Mask bits indicate which entries need to be updated/queried. */
+	/** Group of 64 redirection table entries. */
 	uint16_t reta[RTE_RETA_GROUP_SIZE];
-	/**< Group of 64 redirection table entries. */
 };
 
 /**
@@ -920,8 +921,8 @@ struct rte_eth_vmdq_dcb_conf {
 		uint16_t vlan_id; /**< The vlan id of the received frame */
 		uint64_t pools;   /**< Bitmask of pools for packet rx */
 	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
+	/** Selects a queue in a pool */
 	uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
-	/**< Selects a queue in a pool */
 };
 
 /**
@@ -969,12 +970,12 @@ struct rte_eth_txmode {
 
 	uint16_t pvid;
 	__extension__
-	uint8_t hw_vlan_reject_tagged : 1,
-		/**< If set, reject sending out tagged pkts */
+	uint8_t /** If set, reject sending out tagged pkts */
+		hw_vlan_reject_tagged : 1,
+		/** If set, reject sending out untagged pkts */
 		hw_vlan_reject_untagged : 1,
-		/**< If set, reject sending out untagged pkts */
+		/** If set, enable port based VLAN insertion */
 		hw_vlan_insert_pvid : 1;
-		/**< If set, enable port based VLAN insertion */
 
 	uint64_t reserved_64s[2]; /**< Reserved for future fields */
 	void *reserved_ptrs[2];   /**< Reserved for future fields */
@@ -1268,8 +1269,8 @@ struct rte_fdir_conf {
 	/** RX queue of packets matching a "drop" filter in perfect mode. */
 	uint8_t drop_queue;
 	struct rte_eth_fdir_masks mask;
+	/** Flex payload configuration. */
 	struct rte_eth_fdir_flex_conf flex_conf;
-	/**< Flex payload configuration. */
 };
 
 /**
@@ -1320,20 +1321,20 @@ struct rte_eth_conf {
 				 are defined in implementation of each driver. */
 	struct {
 		struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
+		/** Port vmdq+dcb configuration. */
 		struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
-		/**< Port vmdq+dcb configuration. */
+		/** Port dcb RX configuration. */
 		struct rte_eth_dcb_rx_conf dcb_rx_conf;
-		/**< Port dcb RX configuration. */
+		/** Port vmdq RX configuration. */
 		struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
-		/**< Port vmdq RX configuration. */
 	} rx_adv_conf; /**< Port RX filtering configuration. */
 	union {
+		/** Port vmdq+dcb TX configuration. */
 		struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
-		/**< Port vmdq+dcb TX configuration. */
+		/** Port dcb TX configuration. */
 		struct rte_eth_dcb_tx_conf dcb_tx_conf;
-		/**< Port dcb TX configuration. */
+		/** Port vmdq TX configuration. */
 		struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
-		/**< Port vmdq TX configuration. */
 	} tx_adv_conf; /**< Port TX DCB configuration (union). */
 	/** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
 	    is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
@@ -1400,17 +1401,19 @@ struct rte_eth_conf {
 #define DEV_TX_OFFLOAD_IPIP_TNL_TSO     0x00000800    /**< Used for tunneling packet. */
 #define DEV_TX_OFFLOAD_GENEVE_TNL_TSO   0x00001000    /**< Used for tunneling packet. */
 #define DEV_TX_OFFLOAD_MACSEC_INSERT    0x00002000
-#define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
-/**< Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
+/**
+ * Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
  * tx queue without SW lock.
  */
+#define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
+/** Device supports multi segment send. */
 #define DEV_TX_OFFLOAD_MULTI_SEGS	0x00008000
-/**< Device supports multi segment send. */
-#define DEV_TX_OFFLOAD_MBUF_FAST_FREE	0x00010000
-/**< Device supports optimization for fast release of mbufs.
- *   When set application must guarantee that per-queue all mbufs comes from
- *   the same mempool and has refcnt = 1.
+/**
+ * Device supports optimization for fast release of mbufs.
+ * When set application must guarantee that per-queue all mbufs comes from
+ * the same mempool and has refcnt = 1.
  */
+#define DEV_TX_OFFLOAD_MBUF_FAST_FREE	0x00010000
 #define DEV_TX_OFFLOAD_SECURITY         0x00020000
 /**
  * Device supports generic UDP tunneled packet TSO.
@@ -1479,14 +1482,14 @@ struct rte_eth_dev_portconf {
 struct rte_eth_switch_info {
 	const char *name;	/**< switch name */
 	uint16_t domain_id;	/**< switch domain id */
-	uint16_t port_id;
-	/**<
-	 * mapping to the devices physical switch port as enumerated from the
+	/**
+	 * Mapping to the devices physical switch port as enumerated from the
 	 * perspective of the embedded interconnect/switch. For SR-IOV enabled
 	 * device this may correspond to the VF_ID of each virtual function,
 	 * but each driver should explicitly define the mapping of switch
 	 * port identifier to that physical interconnect/switch
 	 */
+	uint16_t port_id;
 };
 
 /**
@@ -1543,16 +1546,16 @@ struct rte_eth_dev_info {
 	uint16_t max_vfs; /**< Maximum number of VFs. */
 	uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
 	struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/
+	/** All RX offload capabilities including all per-queue ones */
 	uint64_t rx_offload_capa;
-	/**< All RX offload capabilities including all per-queue ones */
+	/** All TX offload capabilities including all per-queue ones */
 	uint64_t tx_offload_capa;
-	/**< All TX offload capabilities including all per-queue ones */
+	/** Device per-queue RX offload capabilities. */
 	uint64_t rx_queue_offload_capa;
-	/**< Device per-queue RX offload capabilities. */
+	/** Device per-queue TX offload capabilities. */
 	uint64_t tx_queue_offload_capa;
-	/**< Device per-queue TX offload capabilities. */
+	/** Device redirection table size, the total number of entries. */
 	uint16_t reta_size;
-	/**< Device redirection table size, the total number of entries. */
 	uint8_t hash_key_size; /**< Hash key size in bytes */
 	/** Bit mask of RSS offloads, the bit offset also means flow type */
 	uint64_t flow_type_rss_offloads;
@@ -1740,13 +1743,13 @@ struct rte_eth_fec_capa {
 } while (0)
 
 /**@{@name L2 tunnel configuration */
-/**< l2 tunnel enable mask */
+/** L2 tunnel enable mask */
 #define ETH_L2_TUNNEL_ENABLE_MASK       0x00000001
-/**< l2 tunnel insertion mask */
+/** L2 tunnel insertion mask */
 #define ETH_L2_TUNNEL_INSERTION_MASK    0x00000002
-/**< l2 tunnel stripping mask */
+/** L2 tunnel stripping mask */
 #define ETH_L2_TUNNEL_STRIPPING_MASK    0x00000004
-/**< l2 tunnel forwarding mask */
+/** L2 tunnel forwarding mask */
 #define ETH_L2_TUNNEL_FORWARDING_MASK   0x00000008
 /**@}*/
 
@@ -3347,8 +3350,8 @@ struct rte_eth_dev_tx_buffer {
 	void *error_userdata;
 	uint16_t size;           /**< Size of buffer for buffered tx */
 	uint16_t length;         /**< Number of packets in the array */
+	/** Pending packets to be sent on explicit flush or when full */
 	struct rte_mbuf *pkts[];
-	/**< Pending packets to be sent on explicit flush or when full */
 };
 
 /**
@@ -3487,16 +3490,16 @@ rte_eth_tx_done_cleanup(uint16_t port_id, uint16_t queue_id, uint32_t free_cnt);
  * eth device.
  */
 enum rte_eth_event_ipsec_subtype {
+	/** Unknown event type */
 	RTE_ETH_EVENT_IPSEC_UNKNOWN = 0,
-			/**< Unknown event type */
+	/** Sequence number overflow */
 	RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW,
-			/**< Sequence number overflow */
+	/** Soft time expiry of SA */
 	RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY,
-			/**< Soft time expiry of SA */
+	/** Soft byte expiry of SA */
 	RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY,
-			/**< Soft byte expiry of SA */
+	/** Max value of this enum */
 	RTE_ETH_EVENT_IPSEC_MAX
-			/**< Max value of this enum */
 };
 
 /**
@@ -3504,22 +3507,23 @@ enum rte_eth_event_ipsec_subtype {
  * information of the IPsec offload event.
  */
 struct rte_eth_event_ipsec_desc {
+	/** Type of RTE_ETH_EVENT_IPSEC_* event */
 	enum rte_eth_event_ipsec_subtype subtype;
-			/**< Type of RTE_ETH_EVENT_IPSEC_* event */
+	/**
+	 * Event specific metadata.
+	 *
+	 * For the following events, *userdata* registered
+	 * with the *rte_security_session* would be returned
+	 * as metadata,
+	 *
+	 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
+	 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
+	 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
+	 *
+	 * @see struct rte_security_session_conf
+	 *
+	 */
 	uint64_t metadata;
-			/**< Event specific metadata
-			 *
-			 * For the following events, *userdata* registered
-			 * with the *rte_security_session* would be returned
-			 * as metadata,
-			 *
-			 * - @ref RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW
-			 * - @ref RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY
-			 * - @ref RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY
-			 *
-			 * @see struct rte_security_session_conf
-			 *
-			 */
 };
 
 /**
@@ -3528,10 +3532,10 @@ struct rte_eth_event_ipsec_desc {
 enum rte_eth_event_type {
 	RTE_ETH_EVENT_UNKNOWN,  /**< unknown event type */
 	RTE_ETH_EVENT_INTR_LSC, /**< lsc interrupt event */
+	/** queue state event (enabled/disabled) */
 	RTE_ETH_EVENT_QUEUE_STATE,
-				/**< queue state event (enabled/disabled) */
+	/** reset interrupt event, sent to VF on PF reset */
 	RTE_ETH_EVENT_INTR_RESET,
-			/**< reset interrupt event, sent to VF on PF reset */
 	RTE_ETH_EVENT_VF_MBOX,  /**< message from the VF received by PF */
 	RTE_ETH_EVENT_MACSEC,   /**< MACsec offload related event */
 	RTE_ETH_EVENT_INTR_RMV, /**< device removal event */
@@ -3542,9 +3546,9 @@ enum rte_eth_event_type {
 	RTE_ETH_EVENT_MAX       /**< max value of this enum */
 };
 
+/** User application callback to be registered for interrupts. */
 typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
 		enum rte_eth_event_type event, void *cb_arg, void *ret_param);
-/**< user application callback to be registered for interrupts */
 
 /**
  * Register a callback function for port event.
diff --git a/lib/ethdev/rte_ethdev_core.h b/lib/ethdev/rte_ethdev_core.h
index 2b8660c578..18d725fca1 100644
--- a/lib/ethdev/rte_ethdev_core.h
+++ b/lib/ethdev/rte_ethdev_core.h
@@ -25,30 +25,36 @@ RTE_TAILQ_HEAD(rte_eth_dev_cb_list, rte_eth_dev_callback);
 
 struct rte_eth_dev;
 
+/**
+ * @internal Retrieve input packets from a receive queue of an Ethernet device.
+ */
 typedef uint16_t (*eth_rx_burst_t)(void *rxq,
 				   struct rte_mbuf **rx_pkts,
 				   uint16_t nb_pkts);
-/**< @internal Retrieve input packets from a receive queue of an Ethernet device. */
 
+/**
+ * @internal Send output packets on a transmit queue of an Ethernet device.
+ */
 typedef uint16_t (*eth_tx_burst_t)(void *txq,
 				   struct rte_mbuf **tx_pkts,
 				   uint16_t nb_pkts);
-/**< @internal Send output packets on a transmit queue of an Ethernet device. */
 
+/**
+ * @internal Prepare output packets on a transmit queue of an Ethernet device.
+ */
 typedef uint16_t (*eth_tx_prep_t)(void *txq,
 				   struct rte_mbuf **tx_pkts,
 				   uint16_t nb_pkts);
-/**< @internal Prepare output packets on a transmit queue of an Ethernet device. */
 
 
+/** @internal Get number of used descriptors on a receive queue. */
 typedef uint32_t (*eth_rx_queue_count_t)(void *rxq);
-/**< @internal Get number of used descriptors on a receive queue. */
 
+/** @internal Check the status of a Rx descriptor */
 typedef int (*eth_rx_descriptor_status_t)(void *rxq, uint16_t offset);
-/**< @internal Check the status of a Rx descriptor */
 
+/** @internal Check the status of a Tx descriptor */
 typedef int (*eth_tx_descriptor_status_t)(void *txq, uint16_t offset);
-/**< @internal Check the status of a Tx descriptor */
 
 /**
  * @internal
diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index d5bfdaaaf2..45b360d4ac 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -892,8 +892,8 @@ struct rte_flow_item_vlan {
 		};
 		struct rte_vlan_hdr hdr;
 	};
+	/** Packet header contains at least one more VLAN, after this VLAN. */
 	uint32_t has_more_vlan:1;
-	/**< Packet header contains at least one more VLAN, after this VLAN. */
 	uint32_t reserved:31; /**< Reserved, must be zero. */
 };
 
@@ -935,26 +935,26 @@ static const struct rte_flow_item_ipv4 rte_flow_item_ipv4_mask = {
  */
 struct rte_flow_item_ipv6 {
 	struct rte_ipv6_hdr hdr; /**< IPv6 header definition. */
+	/** Header contains Hop-by-Hop Options extension header. */
 	uint32_t has_hop_ext:1;
-	/**< Header contains Hop-by-Hop Options extension header. */
+	/** Header contains Routing extension header. */
 	uint32_t has_route_ext:1;
-	/**< Header contains Routing extension header. */
+	/** Header contains Fragment extension header. */
 	uint32_t has_frag_ext:1;
-	/**< Header contains Fragment extension header. */
+	/** Header contains Authentication extension header. */
 	uint32_t has_auth_ext:1;
-	/**< Header contains Authentication extension header. */
+	/** Header contains Encapsulation Security Payload extension header. */
 	uint32_t has_esp_ext:1;
-	/**< Header contains Encapsulation Security Payload extension header. */
+	/** Header contains Destination Options extension header. */
 	uint32_t has_dest_ext:1;
-	/**< Header contains Destination Options extension header. */
+	/** Header contains Mobility extension header. */
 	uint32_t has_mobil_ext:1;
-	/**< Header contains Mobility extension header. */
+	/** Header contains Host Identity Protocol extension header. */
 	uint32_t has_hip_ext:1;
-	/**< Header contains Host Identity Protocol extension header. */
+	/** Header contains Shim6 Protocol extension header. */
 	uint32_t has_shim6_ext:1;
-	/**< Header contains Shim6 Protocol extension header. */
+	/** Reserved for future extension headers, must be zero. */
 	uint32_t reserved:23;
-	/**< Reserved for future extension headers, must be zero. */
 };
 
 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6. */
@@ -2597,8 +2597,8 @@ struct rte_flow_action_queue {
 struct rte_flow_action_age {
 	uint32_t timeout:24; /**< Time in seconds. */
 	uint32_t reserved:8; /**< Reserved, must be zero. */
+	/** The user flow context, NULL means the rte_flow pointer. */
 	void *context;
-		/**< The user flow context, NULL means the rte_flow pointer. */
 };
 
 /**
@@ -2610,8 +2610,8 @@ struct rte_flow_action_age {
 struct rte_flow_query_age {
 	uint32_t reserved:6; /**< Reserved, must be zero. */
 	uint32_t aged:1; /**< 1 if aging timeout expired, 0 otherwise. */
+	/** sec_since_last_hit value is valid. */
 	uint32_t sec_since_last_hit_valid:1;
-	/**< sec_since_last_hit value is valid. */
 	uint32_t sec_since_last_hit:24; /**< Seconds since last traffic hit. */
 };
 
@@ -3242,7 +3242,7 @@ struct rte_flow_action_conntrack {
 	uint32_t last_direction:1;
 	/** No TCP check will be done except the state change. */
 	uint32_t liberal_mode:1;
-	/**<The current state of this connection. */
+	/** The current state of this connection. */
 	enum rte_flow_conntrack_state state;
 	/** Scaling factor for maximal allowed ACK window. */
 	uint8_t max_ack_window;
@@ -3355,9 +3355,9 @@ struct rte_flow_action_modify_data {
 	RTE_STD_C11
 	union {
 		struct {
-			/**< Encapsulation level or tag index. */
+			/** Encapsulation level or tag index. */
 			uint32_t level;
-			/**< Number of bits to skip from a field. */
+			/** Number of bits to skip from a field. */
 			uint32_t offset;
 		};
 		/**
@@ -3468,8 +3468,8 @@ struct rte_flow;
  */
 struct rte_flow_action_sample {
 	uint32_t ratio; /**< packets sampled equals to '1/ratio'. */
+	/** sub-action list specific for the sampling hit cases. */
 	const struct rte_flow_action *actions;
-		/**< sub-action list specific for the sampling hit cases. */
 };
 
 /**
@@ -4101,10 +4101,10 @@ struct rte_flow_indir_action_conf {
 	 * Action should be valid at least for one flow direction,
 	 * otherwise it is invalid for both ingress and egress rules.
 	 */
+	/** Action valid for rules applied to ingress traffic. */
 	uint32_t ingress:1;
-	/**< Action valid for rules applied to ingress traffic. */
+	/** Action valid for rules applied to egress traffic. */
 	uint32_t egress:1;
-	/**< Action valid for rules applied to egress traffic. */
 	/**
 	 * When set to 1, indicates that the action is valid for
 	 * transfer traffic; otherwise, for non-transfer traffic.
diff --git a/lib/ethdev/rte_mtr_driver.h b/lib/ethdev/rte_mtr_driver.h
index 62273ed3a9..ee8c6ef7ad 100644
--- a/lib/ethdev/rte_mtr_driver.h
+++ b/lib/ethdev/rte_mtr_driver.h
@@ -25,91 +25,91 @@
 extern "C" {
 #endif
 
+/** @internal MTR capabilities get. */
 typedef int (*rte_mtr_capabilities_get_t)(struct rte_eth_dev *dev,
 	struct rte_mtr_capabilities *cap,
 	struct rte_mtr_error *error);
-/**< @internal MTR capabilities get */
 
+/** @internal MTR meter profile add. */
 typedef int (*rte_mtr_meter_profile_add_t)(struct rte_eth_dev *dev,
 	uint32_t meter_profile_id,
 	struct rte_mtr_meter_profile *profile,
 	struct rte_mtr_error *error);
-/**< @internal MTR meter profile add */
 
+/** @internal MTR meter profile delete. */
 typedef int (*rte_mtr_meter_profile_delete_t)(struct rte_eth_dev *dev,
 	uint32_t meter_profile_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR meter profile delete */
 
+/** @internal MTR meter policy validate. */
 typedef int (*rte_mtr_meter_policy_validate_t)(struct rte_eth_dev *dev,
 	struct rte_mtr_meter_policy_params *policy,
 	struct rte_mtr_error *error);
-/**< @internal MTR meter policy validate */
 
+/** @internal MTR meter policy add. */
 typedef int (*rte_mtr_meter_policy_add_t)(struct rte_eth_dev *dev,
 	uint32_t policy_id,
 	struct rte_mtr_meter_policy_params *policy,
 	struct rte_mtr_error *error);
-/**< @internal MTR meter policy add */
 
+/** @internal MTR meter policy delete. */
 typedef int (*rte_mtr_meter_policy_delete_t)(struct rte_eth_dev *dev,
 	uint32_t policy_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR meter policy delete */
 
+/** @internal MTR object create. */
 typedef int (*rte_mtr_create_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	struct rte_mtr_params *params,
 	int shared,
 	struct rte_mtr_error *error);
-/**< @internal MTR object create */
 
+/** @internal MTR object destroy. */
 typedef int (*rte_mtr_destroy_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR object destroy */
 
+/** @internal MTR object meter enable. */
 typedef int (*rte_mtr_meter_enable_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR object meter enable */
 
+/** @internal MTR object meter disable. */
 typedef int (*rte_mtr_meter_disable_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR object meter disable */
 
+/** @internal MTR object meter profile update. */
 typedef int (*rte_mtr_meter_profile_update_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	uint32_t meter_profile_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR object meter profile update */
 
+/** @internal MTR object meter policy update. */
 typedef int (*rte_mtr_meter_policy_update_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	uint32_t meter_policy_id,
 	struct rte_mtr_error *error);
-/**< @internal MTR object meter policy update */
 
+/** @internal MTR object meter DSCP table update. */
 typedef int (*rte_mtr_meter_dscp_table_update_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	enum rte_color *dscp_table,
 	struct rte_mtr_error *error);
-/**< @internal MTR object meter DSCP table update */
 
+/** @internal MTR object enabled stats update. */
 typedef int (*rte_mtr_stats_update_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	uint64_t stats_mask,
 	struct rte_mtr_error *error);
-/**< @internal MTR object enabled stats update */
 
+/** @internal MTR object stats read. */
 typedef int (*rte_mtr_stats_read_t)(struct rte_eth_dev *dev,
 	uint32_t mtr_id,
 	struct rte_mtr_stats *stats,
 	uint64_t *stats_mask,
 	int clear,
 	struct rte_mtr_error *error);
-/**< @internal MTR object stats read */
 
 struct rte_mtr_ops {
 	/** MTR capabilities get */
-- 
2.30.2

Re: [dpdk-dev] [PATCH v3 01/10] ethdev: avoid documentation in next lines

[Ori Kam]

Hi Andrew,

> -----Original Message-----
> From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> Sent: Wednesday, October 20, 2021 3:47 PM
> Subject: [PATCH v3 01/10] ethdev: avoid documentation in next lines
> 
> Documentation in the next separate line is confusing. If documentation
> requires own line it should be before, not after.
> 
> Move documentation to the previous line if documention on the same
> line makes it too long.
> 
> Fix a number of incorrect markups on the way.
> 
> When a lines is touched by the patch anyway, do other cosmetics
> changes to avoid changes in next patches.
> 
> Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> ---


Acked-by: Ori Kam <orika@nvidia.com>
Best,
Ori

[dpdk-dev] [PATCH v3 02/10] ethdev: fix Rx/Tx spelling

[Andrew Rybchenko]

Fix it everywhere in ethdev including log messages.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h   |  50 +++----
 lib/ethdev/ethdev_profile.c  |   4 +-
 lib/ethdev/rte_eth_ctrl.h    |   2 +-
 lib/ethdev/rte_ethdev.c      |  50 +++----
 lib/ethdev/rte_ethdev.h      | 278 +++++++++++++++++------------------
 lib/ethdev/rte_ethdev_core.h |   2 +-
 lib/ethdev/rte_tm.h          |  14 +-
 7 files changed, 200 insertions(+), 200 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 8ccc4f6015..345138531d 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -20,7 +20,7 @@
 /**
  * @internal
  * Structure used to hold information about the callbacks to be called for a
- * queue on RX and TX.
+ * queue on Rx and Tx.
  */
 struct rte_eth_rxtx_callback {
 	struct rte_eth_rxtx_callback *next;
@@ -92,10 +92,10 @@ struct rte_eth_dev_owner;
 struct rte_eth_dev_data {
 	char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
 
-	void **rx_queues; /**< Array of pointers to RX queues. */
-	void **tx_queues; /**< Array of pointers to TX queues. */
-	uint16_t nb_rx_queues; /**< Number of RX queues. */
-	uint16_t nb_tx_queues; /**< Number of TX queues. */
+	void **rx_queues; /**< Array of pointers to Rx queues. */
+	void **tx_queues; /**< Array of pointers to Tx queues. */
+	uint16_t nb_rx_queues; /**< Number of Rx queues. */
+	uint16_t nb_tx_queues; /**< Number of Tx queues. */
 
 	struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 
@@ -108,7 +108,7 @@ struct rte_eth_dev_data {
 	/** Common Rx buffer size handled by all queues */
 	uint32_t min_rx_buf_size;
 
-	uint64_t rx_mbuf_alloc_failed; /**< RX ring mbuf allocation failures. */
+	uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures */
 	/** Device Ethernet link address. @see rte_eth_dev_release_port() */
 	struct rte_ether_addr *mac_addrs;
 	/** Bitmap associating MAC addresses to pools */
@@ -691,16 +691,16 @@ typedef int (*eth_hairpin_cap_get_t)(struct rte_eth_dev *dev,
 
 /**
  * @internal
- * Setup RX hairpin queue.
+ * Setup Rx hairpin queue.
  *
  * @param dev
  *   ethdev handle of port.
  * @param rx_queue_id
- *   the selected RX queue index.
+ *   the selected Rx queue index.
  * @param nb_rx_desc
  *   the requested number of descriptors for this queue. 0 - use PMD default.
  * @param conf
- *   the RX hairpin configuration structure.
+ *   the Rx hairpin configuration structure.
  *
  * @return
  *   Negative errno value on error, 0 on success.
@@ -721,16 +721,16 @@ typedef int (*eth_rx_hairpin_queue_setup_t)
 
 /**
  * @internal
- * Setup TX hairpin queue.
+ * Setup Tx hairpin queue.
  *
  * @param dev
  *   ethdev handle of port.
  * @param tx_queue_id
- *   the selected TX queue index.
+ *   the selected Tx queue index.
  * @param nb_tx_desc
  *   the requested number of descriptors for this queue. 0 - use PMD default.
  * @param conf
- *   the TX hairpin configuration structure.
+ *   the Tx hairpin configuration structure.
  *
  * @return
  *   Negative errno value on error, 0 on success.
@@ -1001,8 +1001,8 @@ struct eth_dev_ops {
 
 	eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON. */
 	eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF. */
-	eth_allmulticast_enable_t  allmulticast_enable;/**< RX multicast ON. */
-	eth_allmulticast_disable_t allmulticast_disable;/**< RX multicast OFF. */
+	eth_allmulticast_enable_t  allmulticast_enable;/**< Rx multicast ON. */
+	eth_allmulticast_disable_t allmulticast_disable;/**< Rx multicast OFF. */
 	eth_mac_addr_remove_t      mac_addr_remove; /**< Remove MAC address. */
 	eth_mac_addr_add_t         mac_addr_add;  /**< Add a MAC address. */
 	eth_mac_addr_set_t         mac_addr_set;  /**< Set a MAC address. */
@@ -1028,8 +1028,8 @@ struct eth_dev_ops {
 	eth_rxq_info_get_t         rxq_info_get;
 	/** Retrieve Tx queue information */
 	eth_txq_info_get_t         txq_info_get;
-	eth_burst_mode_get_t       rx_burst_mode_get; /**< Get RX burst mode */
-	eth_burst_mode_get_t       tx_burst_mode_get; /**< Get TX burst mode */
+	eth_burst_mode_get_t       rx_burst_mode_get; /**< Get Rx burst mode */
+	eth_burst_mode_get_t       tx_burst_mode_get; /**< Get Tx burst mode */
 	eth_fw_version_get_t       fw_version_get; /**< Get firmware version. */
 
 	/** Get packet types supported and identified by device */
@@ -1051,21 +1051,21 @@ struct eth_dev_ops {
 	/** Set port based Tx VLAN insertion */
 	vlan_pvid_set_t            vlan_pvid_set;
 
-	eth_queue_start_t          rx_queue_start;/**< Start RX for a queue. */
-	eth_queue_stop_t           rx_queue_stop; /**< Stop RX for a queue. */
-	eth_queue_start_t          tx_queue_start;/**< Start TX for a queue. */
-	eth_queue_stop_t           tx_queue_stop; /**< Stop TX for a queue. */
-	eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device RX queue. */
-	eth_queue_release_t        rx_queue_release; /**< Release RX queue. */
+	eth_queue_start_t          rx_queue_start;/**< Start Rx for a queue. */
+	eth_queue_stop_t           rx_queue_stop; /**< Stop Rx for a queue. */
+	eth_queue_start_t          tx_queue_start;/**< Start Tx for a queue. */
+	eth_queue_stop_t           tx_queue_stop; /**< Stop Tx for a queue. */
+	eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device Rx queue. */
+	eth_queue_release_t        rx_queue_release; /**< Release Rx queue. */
 
 	/** Enable Rx queue interrupt */
 	eth_rx_enable_intr_t       rx_queue_intr_enable;
 	/** Disable Rx queue interrupt */
 	eth_rx_disable_intr_t      rx_queue_intr_disable;
 
-	eth_tx_queue_setup_t       tx_queue_setup;/**< Set up device TX queue. */
-	eth_queue_release_t        tx_queue_release; /**< Release TX queue. */
-	eth_tx_done_cleanup_t      tx_done_cleanup;/**< Free tx ring mbufs */
+	eth_tx_queue_setup_t       tx_queue_setup;/**< Set up device Tx queue */
+	eth_queue_release_t        tx_queue_release; /**< Release Tx queue */
+	eth_tx_done_cleanup_t      tx_done_cleanup;/**< Free Tx ring mbufs */
 
 	eth_dev_led_on_t           dev_led_on;    /**< Turn on LED. */
 	eth_dev_led_off_t          dev_led_off;   /**< Turn off LED. */
diff --git a/lib/ethdev/ethdev_profile.c b/lib/ethdev/ethdev_profile.c
index a3c303f62c..0ac9e7cac4 100644
--- a/lib/ethdev/ethdev_profile.c
+++ b/lib/ethdev/ethdev_profile.c
@@ -23,13 +23,13 @@ profile_hook_rx_burst_cb(
 }
 
 /**
- * Setting profiling rx callback for a given Ethernet device.
+ * Setting profiling Rx callback for a given Ethernet device.
  * This function must be invoked when ethernet device is being configured.
  *
  * @param port_id
  *  The port identifier of the Ethernet device.
  * @param rx_queue_num
- *  The number of RX queues on specified port.
+ *  The number of Rx queues on specified port.
  *
  * @return
  *  - On success, zero.
diff --git a/lib/ethdev/rte_eth_ctrl.h b/lib/ethdev/rte_eth_ctrl.h
index 42652f9cce..fc511f227d 100644
--- a/lib/ethdev/rte_eth_ctrl.h
+++ b/lib/ethdev/rte_eth_ctrl.h
@@ -350,7 +350,7 @@ struct rte_eth_fdir_filter {
 
 /**
  *  A structure used to configure FDIR masks that are used by the device
- *  to match the various fields of RX packet headers.
+ *  to match the various fields of Rx packet headers.
  */
 struct rte_eth_fdir_masks {
 	uint16_t vlan_tci_mask;   /**< Bit mask for vlan_tci in big endian */
diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
index 3b8ef9ef22..acb667c112 100644
--- a/lib/ethdev/rte_ethdev.c
+++ b/lib/ethdev/rte_ethdev.c
@@ -50,10 +50,10 @@ struct rte_eth_fp_ops rte_eth_fp_ops[RTE_MAX_ETHPORTS];
 /* spinlock for eth device callbacks */
 static rte_spinlock_t eth_dev_cb_lock = RTE_SPINLOCK_INITIALIZER;
 
-/* spinlock for add/remove rx callbacks */
+/* spinlock for add/remove Rx callbacks */
 static rte_spinlock_t eth_dev_rx_cb_lock = RTE_SPINLOCK_INITIALIZER;
 
-/* spinlock for add/remove tx callbacks */
+/* spinlock for add/remove Tx callbacks */
 static rte_spinlock_t eth_dev_tx_cb_lock = RTE_SPINLOCK_INITIALIZER;
 
 /* spinlock for shared data allocation */
@@ -1440,7 +1440,7 @@ rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q,
 
 	if (nb_rx_q > RTE_MAX_QUEUES_PER_PORT) {
 		RTE_ETHDEV_LOG(ERR,
-			"Number of RX queues requested (%u) is greater than max supported(%d)\n",
+			"Number of Rx queues requested (%u) is greater than max supported(%d)\n",
 			nb_rx_q, RTE_MAX_QUEUES_PER_PORT);
 		ret = -EINVAL;
 		goto rollback;
@@ -1448,15 +1448,15 @@ rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q,
 
 	if (nb_tx_q > RTE_MAX_QUEUES_PER_PORT) {
 		RTE_ETHDEV_LOG(ERR,
-			"Number of TX queues requested (%u) is greater than max supported(%d)\n",
+			"Number of Tx queues requested (%u) is greater than max supported(%d)\n",
 			nb_tx_q, RTE_MAX_QUEUES_PER_PORT);
 		ret = -EINVAL;
 		goto rollback;
 	}
 
 	/*
-	 * Check that the numbers of RX and TX queues are not greater
-	 * than the maximum number of RX and TX queues supported by the
+	 * Check that the numbers of Rx and Tx queues are not greater
+	 * than the maximum number of Rx and Tx queues supported by the
 	 * configured device.
 	 */
 	if (nb_rx_q > dev_info.max_rx_queues) {
@@ -1571,7 +1571,7 @@ rte_eth_dev_configure(uint16_t port_id, uint16_t nb_rx_q, uint16_t nb_tx_q,
 	}
 
 	/*
-	 * Setup new number of RX/TX queues and reconfigure device.
+	 * Setup new number of Rx/Tx queues and reconfigure device.
 	 */
 	diag = eth_dev_rx_queue_config(dev, nb_rx_q);
 	if (diag != 0) {
@@ -2035,7 +2035,7 @@ rte_eth_rx_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (rx_queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", rx_queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", rx_queue_id);
 		return -EINVAL;
 	}
 
@@ -2220,7 +2220,7 @@ rte_eth_rx_hairpin_queue_setup(uint16_t port_id, uint16_t rx_queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (rx_queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", rx_queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", rx_queue_id);
 		return -EINVAL;
 	}
 
@@ -2292,7 +2292,7 @@ rte_eth_tx_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (tx_queue_id >= dev->data->nb_tx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", tx_queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u\n", tx_queue_id);
 		return -EINVAL;
 	}
 
@@ -2386,7 +2386,7 @@ rte_eth_tx_hairpin_queue_setup(uint16_t port_id, uint16_t tx_queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (tx_queue_id >= dev->data->nb_tx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", tx_queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u\n", tx_queue_id);
 		return -EINVAL;
 	}
 
@@ -4771,13 +4771,13 @@ rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data)
 	dev = &rte_eth_devices[port_id];
 
 	if (!dev->intr_handle) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr handle unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr handle unset\n");
 		return -ENOTSUP;
 	}
 
 	intr_handle = dev->intr_handle;
 	if (!intr_handle->intr_vec) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr vector unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr vector unset\n");
 		return -EPERM;
 	}
 
@@ -4786,7 +4786,7 @@ rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data)
 		rc = rte_intr_rx_ctl(intr_handle, epfd, op, vec, data);
 		if (rc && rc != -EEXIST) {
 			RTE_ETHDEV_LOG(ERR,
-				"p %u q %u rx ctl error op %d epfd %d vec %u\n",
+				"p %u q %u Rx ctl error op %d epfd %d vec %u\n",
 				port_id, qid, op, epfd, vec);
 		}
 	}
@@ -4807,18 +4807,18 @@ rte_eth_dev_rx_intr_ctl_q_get_fd(uint16_t port_id, uint16_t queue_id)
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id);
 		return -1;
 	}
 
 	if (!dev->intr_handle) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr handle unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr handle unset\n");
 		return -1;
 	}
 
 	intr_handle = dev->intr_handle;
 	if (!intr_handle->intr_vec) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr vector unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr vector unset\n");
 		return -1;
 	}
 
@@ -4993,18 +4993,18 @@ rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id);
 		return -EINVAL;
 	}
 
 	if (!dev->intr_handle) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr handle unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr handle unset\n");
 		return -ENOTSUP;
 	}
 
 	intr_handle = dev->intr_handle;
 	if (!intr_handle->intr_vec) {
-		RTE_ETHDEV_LOG(ERR, "RX Intr vector unset\n");
+		RTE_ETHDEV_LOG(ERR, "Rx Intr vector unset\n");
 		return -EPERM;
 	}
 
@@ -5012,7 +5012,7 @@ rte_eth_dev_rx_intr_ctl_q(uint16_t port_id, uint16_t queue_id,
 	rc = rte_intr_rx_ctl(intr_handle, epfd, op, vec, data);
 	if (rc && rc != -EEXIST) {
 		RTE_ETHDEV_LOG(ERR,
-			"p %u q %u rx ctl error op %d epfd %d vec %u\n",
+			"p %u q %u Rx ctl error op %d epfd %d vec %u\n",
 			port_id, queue_id, op, epfd, vec);
 		return rc;
 	}
@@ -5290,7 +5290,7 @@ rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id);
 		return -EINVAL;
 	}
 
@@ -5335,7 +5335,7 @@ rte_eth_tx_queue_info_get(uint16_t port_id, uint16_t queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_tx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u\n", queue_id);
 		return -EINVAL;
 	}
 
@@ -5380,7 +5380,7 @@ rte_eth_rx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_rx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id);
 		return -EINVAL;
 	}
 
@@ -5407,7 +5407,7 @@ rte_eth_tx_burst_mode_get(uint16_t port_id, uint16_t queue_id,
 	dev = &rte_eth_devices[port_id];
 
 	if (queue_id >= dev->data->nb_tx_queues) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u\n", queue_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u\n", queue_id);
 		return -EINVAL;
 	}
 
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 2d43c226f6..0fbb436cd1 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -13,7 +13,7 @@
  * The Ethernet Device API is composed of two parts:
  *
  * - The application-oriented Ethernet API that includes functions to setup
- *   an Ethernet device (configure it, setup its RX and TX queues and start it),
+ *   an Ethernet device (configure it, setup its Rx and Tx queues and start it),
  *   to get its MAC address, the speed and the status of its physical link,
  *   to receive and to transmit packets, and so on.
  *
@@ -26,8 +26,8 @@
  * are lock-free functions which assume to not be invoked in parallel on
  * different logical cores to work on the same target object.  For instance,
  * the receive function of a PMD cannot be invoked in parallel on two logical
- * cores to poll the same RX queue [of the same port]. Of course, this function
- * can be invoked in parallel by different logical cores on different RX queues.
+ * cores to poll the same Rx queue [of the same port]. Of course, this function
+ * can be invoked in parallel by different logical cores on different Rx queues.
  * It is the responsibility of the upper level application to enforce this rule.
  *
  * If needed, parallel accesses by multiple logical cores to shared queues
@@ -111,7 +111,7 @@
  * performs an indirect invocation of the corresponding driver function
  * supplied in the *eth_dev_ops* structure of the *rte_eth_dev* structure.
  *
- * For performance reasons, the address of the burst-oriented RX and TX
+ * For performance reasons, the address of the burst-oriented Rx and Tx
  * functions of the Ethernet driver are not contained in the *eth_dev_ops*
  * structure. Instead, they are directly stored at the beginning of the
  * *rte_eth_dev* structure to avoid an extra indirect memory access during
@@ -257,17 +257,17 @@ struct rte_eth_stats {
 	uint64_t ibytes;    /**< Total number of successfully received bytes. */
 	uint64_t obytes;    /**< Total number of successfully transmitted bytes. */
 	/**
-	 * Total of RX packets dropped by the HW,
-	 * because there are no available buffer (i.e. RX queues are full).
+	 * Total of Rx packets dropped by the HW,
+	 * because there are no available buffer (i.e. Rx queues are full).
 	 */
 	uint64_t imissed;
 	uint64_t ierrors;   /**< Total number of erroneous received packets. */
 	uint64_t oerrors;   /**< Total number of failed transmitted packets. */
-	uint64_t rx_nombuf; /**< Total number of RX mbuf allocation failures. */
+	uint64_t rx_nombuf; /**< Total number of Rx mbuf allocation failures. */
 	/* Queue stats are limited to max 256 queues */
-	/** Total number of queue RX packets. */
+	/** Total number of queue Rx packets. */
 	uint64_t q_ipackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
-	/** Total number of queue TX packets. */
+	/** Total number of queue Tx packets. */
 	uint64_t q_opackets[RTE_ETHDEV_QUEUE_STAT_CNTRS];
 	/** Total number of successfully received queue bytes. */
 	uint64_t q_ibytes[RTE_ETHDEV_QUEUE_STAT_CNTRS];
@@ -343,7 +343,7 @@ struct rte_eth_link {
 /**@}*/
 
 /**
- * A structure used to configure the ring threshold registers of an RX/TX
+ * A structure used to configure the ring threshold registers of an Rx/Tx
  * queue for an Ethernet port.
  */
 struct rte_eth_thresh {
@@ -368,9 +368,9 @@ enum rte_eth_rx_mq_mode {
 	/** None of DCB,RSS or VMDQ mode */
 	ETH_MQ_RX_NONE = 0,
 
-	/** For RX side, only RSS is on */
+	/** For Rx side, only RSS is on */
 	ETH_MQ_RX_RSS = ETH_MQ_RX_RSS_FLAG,
-	/** For RX side,only DCB is on. */
+	/** For Rx side,only DCB is on. */
 	ETH_MQ_RX_DCB = ETH_MQ_RX_DCB_FLAG,
 	/** Both DCB and RSS enable */
 	ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
@@ -387,7 +387,7 @@ enum rte_eth_rx_mq_mode {
 };
 
 /**
- * for rx mq mode backward compatible
+ * for Rx mq mode backward compatible
  */
 #define ETH_RSS                       ETH_MQ_RX_RSS
 #define VMDQ_DCB                      ETH_MQ_RX_VMDQ_DCB
@@ -399,20 +399,20 @@ enum rte_eth_rx_mq_mode {
  */
 enum rte_eth_tx_mq_mode {
 	ETH_MQ_TX_NONE    = 0,  /**< It is in neither DCB nor VT mode. */
-	ETH_MQ_TX_DCB,          /**< For TX side,only DCB is on. */
-	ETH_MQ_TX_VMDQ_DCB,	/**< For TX side,both DCB and VT is on. */
+	ETH_MQ_TX_DCB,          /**< For Tx side,only DCB is on. */
+	ETH_MQ_TX_VMDQ_DCB,	/**< For Tx side,both DCB and VT is on. */
 	ETH_MQ_TX_VMDQ_ONLY,    /**< Only VT on, no DCB */
 };
 
 /**
- * for tx mq mode backward compatible
+ * for Tx mq mode backward compatible
  */
 #define ETH_DCB_NONE                ETH_MQ_TX_NONE
 #define ETH_VMDQ_DCB_TX             ETH_MQ_TX_VMDQ_DCB
 #define ETH_DCB_TX                  ETH_MQ_TX_DCB
 
 /**
- * A structure used to configure the RX features of an Ethernet port.
+ * A structure used to configure the Rx features of an Ethernet port.
  */
 struct rte_eth_rxmode {
 	/** The multi-queue packet distribution mode to be used, e.g. RSS. */
@@ -919,7 +919,7 @@ struct rte_eth_vmdq_dcb_conf {
 	uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
 	struct {
 		uint16_t vlan_id; /**< The vlan id of the received frame */
-		uint64_t pools;   /**< Bitmask of pools for packet rx */
+		uint64_t pools;   /**< Bitmask of pools for packet Rx */
 	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
 	/** Selects a queue in a pool */
 	uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
@@ -952,15 +952,15 @@ struct rte_eth_vmdq_rx_conf {
 	uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
 	struct {
 		uint16_t vlan_id; /**< The vlan id of the received frame */
-		uint64_t pools;   /**< Bitmask of pools for packet rx */
+		uint64_t pools;   /**< Bitmask of pools for packet Rx */
 	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
 };
 
 /**
- * A structure used to configure the TX features of an Ethernet port.
+ * A structure used to configure the Tx features of an Ethernet port.
  */
 struct rte_eth_txmode {
-	enum rte_eth_tx_mq_mode mq_mode; /**< TX multi-queues mode. */
+	enum rte_eth_tx_mq_mode mq_mode; /**< Tx multi-queues mode. */
 	/**
 	 * Per-port Tx offloads to be set using DEV_TX_OFFLOAD_* flags.
 	 * Only offloads set on tx_offload_capa field on rte_eth_dev_info
@@ -1037,11 +1037,11 @@ union rte_eth_rxseg {
 };
 
 /**
- * A structure used to configure an RX ring of an Ethernet port.
+ * A structure used to configure an Rx ring of an Ethernet port.
  */
 struct rte_eth_rxconf {
-	struct rte_eth_thresh rx_thresh; /**< RX ring threshold registers. */
-	uint16_t rx_free_thresh; /**< Drives the freeing of RX descriptors. */
+	struct rte_eth_thresh rx_thresh; /**< Rx ring threshold registers. */
+	uint16_t rx_free_thresh; /**< Drives the freeing of Rx descriptors. */
 	uint8_t rx_drop_en; /**< Drop packets if no descriptors are available. */
 	uint8_t rx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
 	uint16_t rx_nseg; /**< Number of descriptions in rx_seg array. */
@@ -1065,12 +1065,12 @@ struct rte_eth_rxconf {
 };
 
 /**
- * A structure used to configure a TX ring of an Ethernet port.
+ * A structure used to configure a Tx ring of an Ethernet port.
  */
 struct rte_eth_txconf {
-	struct rte_eth_thresh tx_thresh; /**< TX ring threshold registers. */
+	struct rte_eth_thresh tx_thresh; /**< Tx ring threshold registers. */
 	uint16_t tx_rs_thresh; /**< Drives the setting of RS bit on TXDs. */
-	uint16_t tx_free_thresh; /**< Start freeing TX buffers if there are
+	uint16_t tx_free_thresh; /**< Start freeing Tx buffers if there are
 				      less free descriptors than this value. */
 
 	uint8_t tx_deferred_start; /**< Do not start queue with rte_eth_dev_start(). */
@@ -1187,8 +1187,8 @@ struct rte_eth_desc_lim {
  */
 enum rte_eth_fc_mode {
 	RTE_FC_NONE = 0, /**< Disable flow control. */
-	RTE_FC_RX_PAUSE, /**< RX pause frame, enable flowctrl on TX side. */
-	RTE_FC_TX_PAUSE, /**< TX pause frame, enable flowctrl on RX side. */
+	RTE_FC_RX_PAUSE, /**< Rx pause frame, enable flowctrl on Tx side. */
+	RTE_FC_TX_PAUSE, /**< Tx pause frame, enable flowctrl on Rx side. */
 	RTE_FC_FULL      /**< Enable flow control on both side. */
 };
 
@@ -1248,7 +1248,7 @@ enum rte_fdir_pballoc_type {
 };
 
 /**
- *  Select report mode of FDIR hash information in RX descriptors.
+ *  Select report mode of FDIR hash information in Rx descriptors.
  */
 enum rte_fdir_status_mode {
 	RTE_FDIR_NO_REPORT_STATUS = 0, /**< Never report FDIR hash. */
@@ -1266,7 +1266,7 @@ struct rte_fdir_conf {
 	enum rte_fdir_mode mode; /**< Flow Director mode. */
 	enum rte_fdir_pballoc_type pballoc; /**< Space for FDIR filters. */
 	enum rte_fdir_status_mode status;  /**< How to report FDIR hash. */
-	/** RX queue of packets matching a "drop" filter in perfect mode. */
+	/** Rx queue of packets matching a "drop" filter in perfect mode. */
 	uint8_t drop_queue;
 	struct rte_eth_fdir_masks mask;
 	/** Flex payload configuration. */
@@ -1301,7 +1301,7 @@ struct rte_intr_conf {
 
 /**
  * A structure used to configure an Ethernet port.
- * Depending upon the RX multi-queue mode, extra advanced
+ * Depending upon the Rx multi-queue mode, extra advanced
  * configuration settings may be needed.
  */
 struct rte_eth_conf {
@@ -1312,8 +1312,8 @@ struct rte_eth_conf {
 				speeds to be advertised. If the special value
 				ETH_LINK_SPEED_AUTONEG (0) is used, all speeds
 				supported are advertised. */
-	struct rte_eth_rxmode rxmode; /**< Port RX configuration. */
-	struct rte_eth_txmode txmode; /**< Port TX configuration. */
+	struct rte_eth_rxmode rxmode; /**< Port Rx configuration. */
+	struct rte_eth_txmode txmode; /**< Port Tx configuration. */
 	uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
 			         is 0, meaning the loopback mode is disabled.
 				 Read the datasheet of given ethernet controller
@@ -1323,19 +1323,19 @@ struct rte_eth_conf {
 		struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
 		/** Port vmdq+dcb configuration. */
 		struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
-		/** Port dcb RX configuration. */
+		/** Port dcb Rx configuration. */
 		struct rte_eth_dcb_rx_conf dcb_rx_conf;
-		/** Port vmdq RX configuration. */
+		/** Port vmdq Rx configuration. */
 		struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
-	} rx_adv_conf; /**< Port RX filtering configuration. */
+	} rx_adv_conf; /**< Port Rx filtering configuration. */
 	union {
-		/** Port vmdq+dcb TX configuration. */
+		/** Port vmdq+dcb Tx configuration. */
 		struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
-		/** Port dcb TX configuration. */
+		/** Port dcb Tx configuration. */
 		struct rte_eth_dcb_tx_conf dcb_tx_conf;
-		/** Port vmdq TX configuration. */
+		/** Port vmdq Tx configuration. */
 		struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
-	} tx_adv_conf; /**< Port TX DCB configuration (union). */
+	} tx_adv_conf; /**< Port Tx DCB configuration (union). */
 	/** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
 	    is needed,and the variable must be set ETH_DCB_PFC_SUPPORT. */
 	uint32_t dcb_capability_en;
@@ -1344,7 +1344,7 @@ struct rte_eth_conf {
 };
 
 /**
- * RX offload capabilities of a device.
+ * Rx offload capabilities of a device.
  */
 #define DEV_RX_OFFLOAD_VLAN_STRIP  0x00000001
 #define DEV_RX_OFFLOAD_IPV4_CKSUM  0x00000002
@@ -1385,7 +1385,7 @@ struct rte_eth_conf {
  */
 
 /**
- * TX offload capabilities of a device.
+ * Tx offload capabilities of a device.
  */
 #define DEV_TX_OFFLOAD_VLAN_INSERT 0x00000001
 #define DEV_TX_OFFLOAD_IPV4_CKSUM  0x00000002
@@ -1403,7 +1403,7 @@ struct rte_eth_conf {
 #define DEV_TX_OFFLOAD_MACSEC_INSERT    0x00002000
 /**
  * Multiple threads can invoke rte_eth_tx_burst() concurrently on the same
- * tx queue without SW lock.
+ * Tx queue without SW lock.
  */
 #define DEV_TX_OFFLOAD_MT_LOCKFREE      0x00004000
 /** Device supports multi segment send. */
@@ -1534,42 +1534,42 @@ struct rte_eth_dev_info {
 	uint16_t min_mtu;	/**< Minimum MTU allowed */
 	uint16_t max_mtu;	/**< Maximum MTU allowed */
 	const uint32_t *dev_flags; /**< Device flags */
-	uint32_t min_rx_bufsize; /**< Minimum size of RX buffer. */
-	uint32_t max_rx_pktlen; /**< Maximum configurable length of RX pkt. */
+	uint32_t min_rx_bufsize; /**< Minimum size of Rx buffer. */
+	uint32_t max_rx_pktlen; /**< Maximum configurable length of Rx pkt. */
 	/** Maximum configurable size of LRO aggregated packet. */
 	uint32_t max_lro_pkt_size;
-	uint16_t max_rx_queues; /**< Maximum number of RX queues. */
-	uint16_t max_tx_queues; /**< Maximum number of TX queues. */
+	uint16_t max_rx_queues; /**< Maximum number of Rx queues. */
+	uint16_t max_tx_queues; /**< Maximum number of Tx queues. */
 	uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
 	uint32_t max_hash_mac_addrs;
 	/** Maximum number of hash MAC addresses for MTA and UTA. */
 	uint16_t max_vfs; /**< Maximum number of VFs. */
 	uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
 	struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/
-	/** All RX offload capabilities including all per-queue ones */
+	/** All Rx offload capabilities including all per-queue ones */
 	uint64_t rx_offload_capa;
-	/** All TX offload capabilities including all per-queue ones */
+	/** All Tx offload capabilities including all per-queue ones */
 	uint64_t tx_offload_capa;
-	/** Device per-queue RX offload capabilities. */
+	/** Device per-queue Rx offload capabilities. */
 	uint64_t rx_queue_offload_capa;
-	/** Device per-queue TX offload capabilities. */
+	/** Device per-queue Tx offload capabilities. */
 	uint64_t tx_queue_offload_capa;
 	/** Device redirection table size, the total number of entries. */
 	uint16_t reta_size;
 	uint8_t hash_key_size; /**< Hash key size in bytes */
 	/** Bit mask of RSS offloads, the bit offset also means flow type */
 	uint64_t flow_type_rss_offloads;
-	struct rte_eth_rxconf default_rxconf; /**< Default RX configuration */
-	struct rte_eth_txconf default_txconf; /**< Default TX configuration */
+	struct rte_eth_rxconf default_rxconf; /**< Default Rx configuration */
+	struct rte_eth_txconf default_txconf; /**< Default Tx configuration */
 	uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
 	uint16_t vmdq_queue_num;  /**< Queue number for VMDQ pools. */
 	uint16_t vmdq_pool_base;  /**< First ID of VMDQ pools. */
-	struct rte_eth_desc_lim rx_desc_lim;  /**< RX descriptors limits */
-	struct rte_eth_desc_lim tx_desc_lim;  /**< TX descriptors limits */
+	struct rte_eth_desc_lim rx_desc_lim;  /**< Rx descriptors limits */
+	struct rte_eth_desc_lim tx_desc_lim;  /**< Tx descriptors limits */
 	uint32_t speed_capa;  /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
-	/** Configured number of rx/tx queues */
-	uint16_t nb_rx_queues; /**< Number of RX queues. */
-	uint16_t nb_tx_queues; /**< Number of TX queues. */
+	/** Configured number of Rx/Tx queues */
+	uint16_t nb_rx_queues; /**< Number of Rx queues. */
+	uint16_t nb_tx_queues; /**< Number of Tx queues. */
 	/** Rx parameter recommendations */
 	struct rte_eth_dev_portconf default_rxportconf;
 	/** Tx parameter recommendations */
@@ -1593,20 +1593,20 @@ struct rte_eth_dev_info {
 /**@}*/
 
 /**
- * Ethernet device RX queue information structure.
+ * Ethernet device Rx queue information structure.
  * Used to retrieve information about configured queue.
  */
 struct rte_eth_rxq_info {
 	struct rte_mempool *mp;     /**< mempool used by that queue. */
 	struct rte_eth_rxconf conf; /**< queue config parameters. */
-	uint8_t scattered_rx;       /**< scattered packets RX supported. */
+	uint8_t scattered_rx;       /**< scattered packets Rx supported. */
 	uint8_t queue_state;        /**< one of RTE_ETH_QUEUE_STATE_*. */
 	uint16_t nb_desc;           /**< configured number of RXDs. */
 	uint16_t rx_buf_size;       /**< hardware receive buffer size. */
 } __rte_cache_min_aligned;
 
 /**
- * Ethernet device TX queue information structure.
+ * Ethernet device Tx queue information structure.
  * Used to retrieve information about configured queue.
  */
 struct rte_eth_txq_info {
@@ -1625,7 +1625,7 @@ struct rte_eth_txq_info {
 #define RTE_ETH_BURST_FLAG_PER_QUEUE     (1ULL << 0)
 
 /**
- * Ethernet device RX/TX queue packet burst mode information structure.
+ * Ethernet device Rx/Tx queue packet burst mode information structure.
  * Used to retrieve information about packet burst mode setting.
  */
 struct rte_eth_burst_mode {
@@ -1675,15 +1675,15 @@ struct rte_eth_xstat_name {
 
 /**
  * A structure used to get the information of queue and
- * TC mapping on both TX and RX paths.
+ * TC mapping on both Tx and Rx paths.
  */
 struct rte_eth_dcb_tc_queue_mapping {
-	/** rx queues assigned to tc per Pool */
+	/** Rx queues assigned to tc per Pool */
 	struct {
 		uint16_t base;
 		uint16_t nb_queue;
 	} tc_rxq[ETH_MAX_VMDQ_POOL][ETH_DCB_NUM_TCS];
-	/** rx queues assigned to tc per Pool */
+	/** Rx queues assigned to tc per Pool */
 	struct {
 		uint16_t base;
 		uint16_t nb_queue;
@@ -1697,8 +1697,8 @@ struct rte_eth_dcb_tc_queue_mapping {
 struct rte_eth_dcb_info {
 	uint8_t nb_tcs;        /**< number of TCs */
 	uint8_t prio_tc[ETH_DCB_NUM_USER_PRIORITIES]; /**< Priority to tc */
-	uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< TX BW percentage for each TC */
-	/** rx queues assigned to tc */
+	uint8_t tc_bws[ETH_DCB_NUM_TCS]; /**< Tx BW percentage for each TC */
+	/** Rx queues assigned to tc */
 	struct rte_eth_dcb_tc_queue_mapping tc_queue;
 };
 
@@ -1754,13 +1754,13 @@ struct rte_eth_fec_capa {
 /**@}*/
 
 /**
- * Function type used for RX packet processing packet callbacks.
+ * Function type used for Rx packet processing packet callbacks.
  *
- * The callback function is called on RX with a burst of packets that have
+ * The callback function is called on Rx with a burst of packets that have
  * been received on the given port and queue.
  *
  * @param port_id
- *   The Ethernet port on which RX is being performed.
+ *   The Ethernet port on which Rx is being performed.
  * @param queue
  *   The queue on the Ethernet port which is being used to receive the packets.
  * @param pkts
@@ -1780,13 +1780,13 @@ typedef uint16_t (*rte_rx_callback_fn)(uint16_t port_id, uint16_t queue,
 	void *user_param);
 
 /**
- * Function type used for TX packet processing packet callbacks.
+ * Function type used for Tx packet processing packet callbacks.
  *
- * The callback function is called on TX with a burst of packets immediately
+ * The callback function is called on Tx with a burst of packets immediately
  * before the packets are put onto the hardware queue for transmission.
  *
  * @param port_id
- *   The Ethernet port on which TX is being performed.
+ *   The Ethernet port on which Tx is being performed.
  * @param queue
  *   The queue on the Ethernet port which is being used to transmit the packets.
  * @param pkts
@@ -1816,7 +1816,7 @@ enum rte_eth_dev_state {
 
 struct rte_eth_dev_sriov {
 	uint8_t active;               /**< SRIOV is active with 16, 32 or 64 pools */
-	uint8_t nb_q_per_pool;        /**< rx queue number per pool */
+	uint8_t nb_q_per_pool;        /**< Rx queue number per pool */
 	uint16_t def_vmdq_idx;        /**< Default pool num used for PF */
 	uint16_t def_pool_q_idx;      /**< Default pool queue start reg index */
 };
@@ -2114,7 +2114,7 @@ const char *rte_eth_dev_tx_offload_name(uint64_t offload);
  *        Any type of device supported offloading set in the input argument
  *        eth_conf->[rt]xmode.offloads to rte_eth_dev_configure() is enabled
  *        on all queues and it can't be disabled in rte_eth_[rt]x_queue_setup()
- *     -  the Receive Side Scaling (RSS) configuration when using multiple RX
+ *     -  the Receive Side Scaling (RSS) configuration when using multiple Rx
  *        queues per port. Any RSS hash function set in eth_conf->rss_conf.rss_hf
  *        must be within the flow_type_rss_offloads provided by drivers via
  *        rte_eth_dev_info_get() API.
@@ -2166,7 +2166,7 @@ rte_eth_dev_is_removed(uint16_t port_id);
  *   the DMA memory allocated for the receive descriptors of the ring.
  * @param rx_conf
  *   The pointer to the configuration data to be used for the receive queue.
- *   NULL value is allowed, in which case default RX configuration
+ *   NULL value is allowed, in which case default Rx configuration
  *   will be used.
  *   The *rx_conf* structure contains an *rx_thresh* structure with the values
  *   of the Prefetch, Host, and Write-Back threshold registers of the receive
@@ -2260,7 +2260,7 @@ int rte_eth_rx_hairpin_queue_setup
  *   the DMA memory allocated for the transmit descriptors of the ring.
  * @param tx_conf
  *   The pointer to the configuration data to be used for the transmit queue.
- *   NULL value is allowed, in which case default TX configuration
+ *   NULL value is allowed, in which case default Tx configuration
  *   will be used.
  *   The *tx_conf* structure contains the following data:
  *   - The *tx_thresh* structure with the values of the Prefetch, Host, and
@@ -2431,13 +2431,13 @@ int rte_eth_dev_socket_id(uint16_t port_id);
 int rte_eth_dev_is_valid_port(uint16_t port_id);
 
 /**
- * Start specified RX queue of a port. It is used when rx_deferred_start
+ * Start specified Rx queue of a port. It is used when rx_deferred_start
  * flag of the specified queue is true.
  *
  * @param port_id
  *   The port identifier of the Ethernet device
  * @param rx_queue_id
- *   The index of the rx queue to update the ring.
+ *   The index of the Rx queue to update the ring.
  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
@@ -2450,12 +2450,12 @@ int rte_eth_dev_is_valid_port(uint16_t port_id);
 int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
 
 /**
- * Stop specified RX queue of a port
+ * Stop specified Rx queue of a port
  *
  * @param port_id
  *   The port identifier of the Ethernet device
  * @param rx_queue_id
- *   The index of the rx queue to update the ring.
+ *   The index of the Rx queue to update the ring.
  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
@@ -2468,13 +2468,13 @@ int rte_eth_dev_rx_queue_start(uint16_t port_id, uint16_t rx_queue_id);
 int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
 
 /**
- * Start TX for specified queue of a port. It is used when tx_deferred_start
+ * Start Tx for specified queue of a port. It is used when tx_deferred_start
  * flag of the specified queue is true.
  *
  * @param port_id
  *   The port identifier of the Ethernet device
  * @param tx_queue_id
- *   The index of the tx queue to update the ring.
+ *   The index of the Tx queue to update the ring.
  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
@@ -2487,12 +2487,12 @@ int rte_eth_dev_rx_queue_stop(uint16_t port_id, uint16_t rx_queue_id);
 int rte_eth_dev_tx_queue_start(uint16_t port_id, uint16_t tx_queue_id);
 
 /**
- * Stop specified TX queue of a port
+ * Stop specified Tx queue of a port
  *
  * @param port_id
  *   The port identifier of the Ethernet device
  * @param tx_queue_id
- *   The index of the tx queue to update the ring.
+ *   The index of the Tx queue to update the ring.
  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
@@ -2540,7 +2540,7 @@ int rte_eth_dev_stop(uint16_t port_id);
 /**
  * Link up an Ethernet device.
  *
- * Set device link up will re-enable the device rx/tx
+ * Set device link up will re-enable the device Rx/Tx
  * functionality after it is previously set device linked down.
  *
  * @param port_id
@@ -2553,7 +2553,7 @@ int rte_eth_dev_set_link_up(uint16_t port_id);
 
 /**
  * Link down an Ethernet device.
- * The device rx/tx functionality will be disabled if success,
+ * The device Rx/Tx functionality will be disabled if success,
  * and it can be re-enabled with a call to
  * rte_eth_dev_set_link_up()
  *
@@ -3138,7 +3138,7 @@ int rte_eth_dev_fw_version_get(uint16_t port_id,
  * can still set a matching packet type in a received packet.
  *
  * @note
- *   Better to invoke this API after the device is already started or rx burst
+ *   Better to invoke this API after the device is already started or Rx burst
  *   function is decided, to obtain correct supported ptypes.
  * @note
  *   if a given PMD does not report what ptypes it supports, then the supported
@@ -3248,7 +3248,7 @@ int rte_eth_dev_set_mtu(uint16_t port_id, uint16_t mtu);
 int rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on);
 
 /**
- * Enable/Disable hardware VLAN Strip by a rx queue of an Ethernet device.
+ * Enable/Disable hardware VLAN Strip by a Rx queue of an Ethernet device.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -3323,14 +3323,14 @@ int rte_eth_dev_set_vlan_offload(uint16_t port_id, int offload_mask);
 int rte_eth_dev_get_vlan_offload(uint16_t port_id);
 
 /**
- * Set port based TX VLAN insertion on or off.
+ * Set port based Tx VLAN insertion on or off.
  *
  * @param port_id
  *  The port identifier of the Ethernet device.
  * @param pvid
- *  Port based TX VLAN identifier together with user priority.
+ *  Port based Tx VLAN identifier together with user priority.
  * @param on
- *  Turn on or off the port based TX VLAN insertion.
+ *  Turn on or off the port based Tx VLAN insertion.
  *
  * @return
  *   - (0) if successful.
@@ -3342,20 +3342,20 @@ typedef void (*buffer_tx_error_fn)(struct rte_mbuf **unsent, uint16_t count,
 		void *userdata);
 
 /**
- * Structure used to buffer packets for future TX
+ * Structure used to buffer packets for future Tx
  * Used by APIs rte_eth_tx_buffer and rte_eth_tx_buffer_flush
  */
 struct rte_eth_dev_tx_buffer {
 	buffer_tx_error_fn error_callback;
 	void *error_userdata;
-	uint16_t size;           /**< Size of buffer for buffered tx */
+	uint16_t size;           /**< Size of buffer for buffered Tx */
 	uint16_t length;         /**< Number of packets in the array */
 	/** Pending packets to be sent on explicit flush or when full */
 	struct rte_mbuf *pkts[];
 };
 
 /**
- * Calculate the size of the tx buffer.
+ * Calculate the size of the Tx buffer.
  *
  * @param sz
  *   Number of stored packets.
@@ -3409,7 +3409,7 @@ rte_eth_tx_buffer_set_err_callback(struct rte_eth_dev_tx_buffer *buffer,
  *
  * This function can be passed to rte_eth_tx_buffer_set_err_callback() to
  * adjust the default behavior when buffered packets cannot be sent. This
- * function drops any unsent packets silently and is used by tx buffered
+ * function drops any unsent packets silently and is used by Tx buffered
  * operations as default behavior.
  *
  * NOTE: this function should not be called directly, instead it should be used
@@ -3594,12 +3594,12 @@ int rte_eth_dev_callback_unregister(uint16_t port_id,
 		rte_eth_dev_cb_fn cb_fn, void *cb_arg);
 
 /**
- * When there is no rx packet coming in Rx Queue for a long time, we can
- * sleep lcore related to RX Queue for power saving, and enable rx interrupt
+ * When there is no Rx packet coming in Rx Queue for a long time, we can
+ * sleep lcore related to Rx Queue for power saving, and enable Rx interrupt
  * to be triggered when Rx packet arrives.
  *
- * The rte_eth_dev_rx_intr_enable() function enables rx queue
- * interrupt on specific rx queue of a port.
+ * The rte_eth_dev_rx_intr_enable() function enables Rx queue
+ * interrupt on specific Rx queue of a port.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -3617,11 +3617,11 @@ int rte_eth_dev_callback_unregister(uint16_t port_id,
 int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
 
 /**
- * When lcore wakes up from rx interrupt indicating packet coming, disable rx
+ * When lcore wakes up from Rx interrupt indicating packet coming, disable Rx
  * interrupt and returns to polling mode.
  *
- * The rte_eth_dev_rx_intr_disable() function disables rx queue
- * interrupt on specific rx queue of a port.
+ * The rte_eth_dev_rx_intr_disable() function disables Rx queue
+ * interrupt on specific Rx queue of a port.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -3639,7 +3639,7 @@ int rte_eth_dev_rx_intr_enable(uint16_t port_id, uint16_t queue_id);
 int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
 
 /**
- * RX Interrupt control per port.
+ * Rx Interrupt control per port.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -3658,7 +3658,7 @@ int rte_eth_dev_rx_intr_disable(uint16_t port_id, uint16_t queue_id);
 int rte_eth_dev_rx_intr_ctl(uint16_t port_id, int epfd, int op, void *data);
 
 /**
- * RX Interrupt control per queue.
+ * Rx Interrupt control per queue.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -3961,7 +3961,7 @@ int rte_eth_dev_rss_reta_query(uint16_t port_id,
 
 /**
  * Updates unicast hash table for receiving packet with the given destination
- * MAC address, and the packet is routed to all VFs for which the RX mode is
+ * MAC address, and the packet is routed to all VFs for which the Rx mode is
  * accept packets that match the unicast hash table.
  *
  * @param port_id
@@ -3983,7 +3983,7 @@ int rte_eth_dev_uc_hash_table_set(uint16_t port_id, struct rte_ether_addr *addr,
 
 /**
  * Updates all unicast hash bitmaps for receiving packet with any Unicast
- * Ethernet MAC addresses,the packet is routed to all VFs for which the RX
+ * Ethernet MAC addresses,the packet is routed to all VFs for which the Rx
  * mode is accept packets that match the unicast hash table.
  *
  * @param port_id
@@ -4009,7 +4009,7 @@ int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
  * @param queue_idx
  *   The queue id.
  * @param tx_rate
- *   The tx rate in Mbps. Allocated from the total port link speed.
+ *   The Tx rate in Mbps. Allocated from the total port link speed.
  * @return
  *   - (0) if successful.
  *   - (-ENOTSUP) if hardware doesn't support this feature.
@@ -4127,7 +4127,7 @@ int rte_eth_dev_get_dcb_info(uint16_t port_id,
 struct rte_eth_rxtx_callback;
 
 /**
- * Add a callback to be called on packet RX on a given port and queue.
+ * Add a callback to be called on packet Rx on a given port and queue.
  *
  * This API configures a function to be called for each burst of
  * packets received on a given NIC port queue. The return value is a pointer
@@ -4156,7 +4156,7 @@ rte_eth_add_rx_callback(uint16_t port_id, uint16_t queue_id,
 		rte_rx_callback_fn fn, void *user_param);
 
 /**
- * Add a callback that must be called first on packet RX on a given port
+ * Add a callback that must be called first on packet Rx on a given port
  * and queue.
  *
  * This API configures a first function to be called for each burst of
@@ -4186,7 +4186,7 @@ rte_eth_add_first_rx_callback(uint16_t port_id, uint16_t queue_id,
 		rte_rx_callback_fn fn, void *user_param);
 
 /**
- * Add a callback to be called on packet TX on a given port and queue.
+ * Add a callback to be called on packet Tx on a given port and queue.
  *
  * This API configures a function to be called for each burst of
  * packets sent on a given NIC port queue. The return value is a pointer
@@ -4215,7 +4215,7 @@ rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
 		rte_tx_callback_fn fn, void *user_param);
 
 /**
- * Remove an RX packet callback from a given port and queue.
+ * Remove an Rx packet callback from a given port and queue.
  *
  * This function is used to removed callbacks that were added to a NIC port
  * queue using rte_eth_add_rx_callback().
@@ -4225,7 +4225,7 @@ rte_eth_add_tx_callback(uint16_t port_id, uint16_t queue_id,
  * subsequently freed back by the application by calling rte_free():
  *
  * - Immediately - if the port is stopped, or the user knows that no
- *   callbacks are in flight e.g. if called from the thread doing RX/TX
+ *   callbacks are in flight e.g. if called from the thread doing Rx/Tx
  *   on that queue.
  *
  * - After a short delay - where the delay is sufficient to allow any
@@ -4251,7 +4251,7 @@ int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
 		const struct rte_eth_rxtx_callback *user_cb);
 
 /**
- * Remove a TX packet callback from a given port and queue.
+ * Remove a Tx packet callback from a given port and queue.
  *
  * This function is used to removed callbacks that were added to a NIC port
  * queue using rte_eth_add_tx_callback().
@@ -4261,7 +4261,7 @@ int rte_eth_remove_rx_callback(uint16_t port_id, uint16_t queue_id,
  * subsequently freed back by the application by calling rte_free():
  *
  * - Immediately - if the port is stopped, or the user knows that no
- *   callbacks are in flight e.g. if called from the thread doing RX/TX
+ *   callbacks are in flight e.g. if called from the thread doing Rx/Tx
  *   on that queue.
  *
  * - After a short delay - where the delay is sufficient to allow any
@@ -4287,12 +4287,12 @@ int rte_eth_remove_tx_callback(uint16_t port_id, uint16_t queue_id,
 		const struct rte_eth_rxtx_callback *user_cb);
 
 /**
- * Retrieve information about given port's RX queue.
+ * Retrieve information about given port's Rx queue.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param queue_id
- *   The RX queue on the Ethernet device for which information
+ *   The Rx queue on the Ethernet device for which information
  *   will be retrieved.
  * @param qinfo
  *   A pointer to a structure of type *rte_eth_rxq_info_info* to be filled with
@@ -4309,12 +4309,12 @@ int rte_eth_rx_queue_info_get(uint16_t port_id, uint16_t queue_id,
 	struct rte_eth_rxq_info *qinfo);
 
 /**
- * Retrieve information about given port's TX queue.
+ * Retrieve information about given port's Tx queue.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param queue_id
- *   The TX queue on the Ethernet device for which information
+ *   The Tx queue on the Ethernet device for which information
  *   will be retrieved.
  * @param qinfo
  *   A pointer to a structure of type *rte_eth_txq_info_info* to be filled with
@@ -4565,14 +4565,14 @@ int rte_eth_timesync_enable(uint16_t port_id);
 int rte_eth_timesync_disable(uint16_t port_id);
 
 /**
- * Read an IEEE1588/802.1AS RX timestamp from an Ethernet device.
+ * Read an IEEE1588/802.1AS Rx timestamp from an Ethernet device.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param timestamp
  *   Pointer to the timestamp struct.
  * @param flags
- *   Device specific flags. Used to pass the RX timesync register index to
+ *   Device specific flags. Used to pass the Rx timesync register index to
  *   i40e. Unused in igb/ixgbe, pass 0 instead.
  *
  * @return
@@ -4586,7 +4586,7 @@ int rte_eth_timesync_read_rx_timestamp(uint16_t port_id,
 		struct timespec *timestamp, uint32_t flags);
 
 /**
- * Read an IEEE1588/802.1AS TX timestamp from an Ethernet device.
+ * Read an IEEE1588/802.1AS Tx timestamp from an Ethernet device.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -4962,18 +4962,18 @@ uint16_t rte_eth_call_rx_callbacks(uint16_t port_id, uint16_t queue_id,
  * device. The retrieved packets are stored in *rte_mbuf* structures whose
  * pointers are supplied in the *rx_pkts* array.
  *
- * The rte_eth_rx_burst() function loops, parsing the RX ring of the
- * receive queue, up to *nb_pkts* packets, and for each completed RX
+ * The rte_eth_rx_burst() function loops, parsing the Rx ring of the
+ * receive queue, up to *nb_pkts* packets, and for each completed Rx
  * descriptor in the ring, it performs the following operations:
  *
  * - Initialize the *rte_mbuf* data structure associated with the
- *   RX descriptor according to the information provided by the NIC into
- *   that RX descriptor.
+ *   Rx descriptor according to the information provided by the NIC into
+ *   that Rx descriptor.
  *
  * - Store the *rte_mbuf* data structure into the next entry of the
  *   *rx_pkts* array.
  *
- * - Replenish the RX descriptor with a new *rte_mbuf* buffer
+ * - Replenish the Rx descriptor with a new *rte_mbuf* buffer
  *   allocated from the memory pool associated with the receive queue at
  *   initialization time.
  *
@@ -4985,7 +4985,7 @@ uint16_t rte_eth_call_rx_callbacks(uint16_t port_id, uint16_t queue_id,
  * The rte_eth_rx_burst() function returns the number of packets
  * actually retrieved, which is the number of *rte_mbuf* data structures
  * effectively supplied into the *rx_pkts* array.
- * A return value equal to *nb_pkts* indicates that the RX queue contained
+ * A return value equal to *nb_pkts* indicates that the Rx queue contained
  * at least *rx_pkts* packets, and this is likely to signify that other
  * received packets remain in the input queue. Applications implementing
  * a "retrieve as much received packets as possible" policy can check this
@@ -5069,7 +5069,7 @@ rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
 	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
 
 	if (qd == NULL) {
-		RTE_ETHDEV_LOG(ERR, "Invalid RX queue_id=%u for port_id=%u\n",
+		RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u for port_id=%u\n",
 			queue_id, port_id);
 		return 0;
 	}
@@ -5100,7 +5100,7 @@ rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
 }
 
 /**
- * Get the number of used descriptors of a rx queue
+ * Get the number of used descriptors of a Rx queue
  *
  * @param port_id
  *  The port identifier of the Ethernet device.
@@ -5311,7 +5311,7 @@ uint16_t rte_eth_call_tx_callbacks(uint16_t port_id, uint16_t queue_id,
  * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them
  * allocated from a pool created with rte_pktmbuf_pool_create().
  * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets,
- * up to the number of transmit descriptors available in the TX ring of the
+ * up to the number of transmit descriptors available in the Tx ring of the
  * transmit queue.
  * For each packet to send, the rte_eth_tx_burst() function performs
  * the following operations:
@@ -5339,12 +5339,12 @@ uint16_t rte_eth_call_tx_callbacks(uint16_t port_id, uint16_t queue_id,
  * transparently free the memory buffers of packets previously sent.
  * This feature is driven by the *tx_free_thresh* value supplied to the
  * rte_eth_dev_configure() function at device configuration time.
- * When the number of free TX descriptors drops below this threshold, the
+ * When the number of free Tx descriptors drops below this threshold, the
  * rte_eth_tx_burst() function must [attempt to] free the *rte_mbuf*  buffers
  * of those packets whose transmission was effectively completed.
  *
  * If the PMD is DEV_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can
- * invoke this function concurrently on the same tx queue without SW lock.
+ * invoke this function concurrently on the same Tx queue without SW lock.
  * @see rte_eth_dev_info_get, struct rte_eth_txconf::offloads
  *
  * @see rte_eth_tx_prepare to perform some prior checks or adjustments
@@ -5392,7 +5392,7 @@ rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
 	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, 0);
 
 	if (qd == NULL) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u for port_id=%u\n",
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u for port_id=%u\n",
 			queue_id, port_id);
 		return 0;
 	}
@@ -5434,13 +5434,13 @@ rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
  * For each packet to send, the rte_eth_tx_prepare() function performs
  * the following operations:
  *
- * - Check if packet meets devices requirements for tx offloads.
+ * - Check if packet meets devices requirements for Tx offloads.
  *
  * - Check limitations about number of segments.
  *
  * - Check additional requirements when debug is enabled.
  *
- * - Update and/or reset required checksums when tx offload is set for packet.
+ * - Update and/or reset required checksums when Tx offload is set for packet.
  *
  * Since this function can modify packet data, provided mbufs must be safely
  * writable (e.g. modified data cannot be in shared segment).
@@ -5502,12 +5502,12 @@ rte_eth_tx_prepare(uint16_t port_id, uint16_t queue_id,
 
 #ifdef RTE_ETHDEV_DEBUG_TX
 	if (!rte_eth_dev_is_valid_port(port_id)) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX port_id=%u\n", port_id);
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx port_id=%u\n", port_id);
 		rte_errno = ENODEV;
 		return 0;
 	}
 	if (qd == NULL) {
-		RTE_ETHDEV_LOG(ERR, "Invalid TX queue_id=%u for port_id=%u\n",
+		RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u for port_id=%u\n",
 			queue_id, port_id);
 		rte_errno = EINVAL;
 		return 0;
diff --git a/lib/ethdev/rte_ethdev_core.h b/lib/ethdev/rte_ethdev_core.h
index 18d725fca1..dcf8adab92 100644
--- a/lib/ethdev/rte_ethdev_core.h
+++ b/lib/ethdev/rte_ethdev_core.h
@@ -86,7 +86,7 @@ struct rte_eth_fp_ops {
 	 */
 	/** PMD receive function. */
 	eth_rx_burst_t rx_pkt_burst;
-	/** Get the number of used RX descriptors. */
+	/** Get the number of used Rx descriptors. */
 	eth_rx_queue_count_t rx_queue_count;
 	/** Check the status of a Rx descriptor. */
 	eth_rx_descriptor_status_t rx_descriptor_status;
diff --git a/lib/ethdev/rte_tm.h b/lib/ethdev/rte_tm.h
index 175417a15f..d39e897849 100644
--- a/lib/ethdev/rte_tm.h
+++ b/lib/ethdev/rte_tm.h
@@ -47,7 +47,7 @@ extern "C" {
 /**
  * Ethernet framing overhead including the Frame Check Sequence (FCS) field.
  * Useful when FCS is generated and added at the end of the Ethernet frame on
- * TX side without any SW intervention.
+ * Tx side without any SW intervention.
  *
  * One of the typical values for the pkt_length_adjust field of the shaper
  * profile.
@@ -1089,9 +1089,9 @@ struct rte_tm_shaper_params {
  * the lowest weight. For each SP priority, the WFQ weight mode can be set as
  * either byte-based or packet-based.
  *
- * Each leaf node sits on top of a TX queue of the current Ethernet port. Hence,
+ * Each leaf node sits on top of a Tx queue of the current Ethernet port. Hence,
  * the leaf nodes are predefined, with their node IDs set to 0 .. (N-1), where N
- * is the number of TX queues configured for the current Ethernet port. The
+ * is the number of Tx queues configured for the current Ethernet port. The
  * non-leaf nodes have their IDs generated by the application.
  */
 struct rte_tm_node_params {
@@ -1230,9 +1230,9 @@ struct rte_tm_error {
 /**
  * Traffic manager get number of leaf nodes
  *
- * Each leaf node sits on on top of a TX queue of the current Ethernet port.
+ * Each leaf node sits on top of a Tx queue of the current Ethernet port.
  * Therefore, the set of leaf nodes is predefined, their number is always equal
- * to N (where N is the number of TX queues configured for the current port)
+ * to N (where N is the number of Tx queues configured for the current port)
  * and their IDs are 0 .. (N-1).
  *
  * @param[in] port_id
@@ -1254,7 +1254,7 @@ rte_tm_get_number_of_leaf_nodes(uint16_t port_id,
  * Traffic manager node ID validate and type (i.e. leaf or non-leaf) get
  *
  * The leaf nodes have predefined IDs in the range of 0 .. (N-1), where N is
- * the number of TX queues of the current Ethernet port. The non-leaf nodes
+ * the number of Tx queues of the current Ethernet port. The non-leaf nodes
  * have their IDs generated by the application outside of the above range,
  * which is reserved for leaf nodes.
  *
@@ -1558,7 +1558,7 @@ rte_tm_shared_shaper_delete(uint16_t port_id,
  *
  * This function has to be called for both leaf and non-leaf nodes. In the case
  * of leaf nodes (i.e. *node_id* is within the range of 0 .. (N-1), with N as
- * the number of configured TX queues of the current port), the leaf node is
+ * the number of configured Tx queues of the current port), the leaf node is
  * configured rather than created (as the set of leaf nodes is predefined) and
  * it is also connected as child of an existing node.
  *
-- 
2.30.2

[dpdk-dev] [PATCH v3 03/10] ethdev: fix Ethernet spelling

[Andrew Rybchenko]

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h  |  6 +++---
 lib/ethdev/ethdev_pci.h     |  2 +-
 lib/ethdev/ethdev_profile.c |  2 +-
 lib/ethdev/ethdev_vdev.h    |  2 +-
 lib/ethdev/rte_ethdev.h     | 10 +++++-----
 5 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 345138531d..dbd32bc1cd 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -33,7 +33,7 @@ struct rte_eth_rxtx_callback {
 
 /**
  * @internal
- * The generic data structure associated with each ethernet device.
+ * The generic data structure associated with each Ethernet device.
  *
  * Pointers to burst-oriented packet receive and transmit functions are
  * located at the beginning of the structure, along with the pointer to
@@ -85,7 +85,7 @@ struct rte_eth_dev_owner;
 
 /**
  * @internal
- * The data part, with no function pointers, associated with each ethernet
+ * The data part, with no function pointers, associated with each Ethernet
  * device. This structure is safe to place in shared memory to be common
  * among different processes in a multi-process configuration.
  */
@@ -1226,7 +1226,7 @@ struct rte_eth_dev *rte_eth_dev_allocated(const char *name);
 
 /**
  * @internal
- * Allocates a new ethdev slot for an ethernet device and returns the pointer
+ * Allocates a new ethdev slot for an Ethernet device and returns the pointer
  * to that slot for the driver to use.
  *
  * @param	name	Unique identifier name for each Ethernet device
diff --git a/lib/ethdev/ethdev_pci.h b/lib/ethdev/ethdev_pci.h
index 8edca82ce8..12015b6b87 100644
--- a/lib/ethdev/ethdev_pci.h
+++ b/lib/ethdev/ethdev_pci.h
@@ -59,7 +59,7 @@ eth_dev_pci_specific_init(struct rte_eth_dev *eth_dev, void *bus_device) {
 
 /**
  * @internal
- * Allocates a new ethdev slot for an ethernet device and returns the pointer
+ * Allocates a new ethdev slot for an Ethernet device and returns the pointer
  * to that slot for the driver to use.
  *
  * @param dev
diff --git a/lib/ethdev/ethdev_profile.c b/lib/ethdev/ethdev_profile.c
index 0ac9e7cac4..7978f351ac 100644
--- a/lib/ethdev/ethdev_profile.c
+++ b/lib/ethdev/ethdev_profile.c
@@ -24,7 +24,7 @@ profile_hook_rx_burst_cb(
 
 /**
  * Setting profiling Rx callback for a given Ethernet device.
- * This function must be invoked when ethernet device is being configured.
+ * This function must be invoked when Ethernet device is being configured.
  *
  * @param port_id
  *  The port identifier of the Ethernet device.
diff --git a/lib/ethdev/ethdev_vdev.h b/lib/ethdev/ethdev_vdev.h
index 46c75d9e5f..2b49e9665b 100644
--- a/lib/ethdev/ethdev_vdev.h
+++ b/lib/ethdev/ethdev_vdev.h
@@ -13,7 +13,7 @@
 
 /**
  * @internal
- * Allocates a new ethdev slot for an ethernet device and returns the pointer
+ * Allocates a new ethdev slot for an Ethernet device and returns the pointer
  * to that slot for the driver to use.
  *
  * @param dev
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 0fbb436cd1..6ae6d9ba99 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -117,7 +117,7 @@
  * *rte_eth_dev* structure to avoid an extra indirect memory access during
  * their invocation.
  *
- * RTE ethernet device drivers do not use interrupts for transmitting or
+ * RTE Ethernet device drivers do not use interrupts for transmitting or
  * receiving. Instead, Ethernet drivers export Poll-Mode receive and transmit
  * functions to applications.
  * Both receive and transmit functions are packet-burst oriented to minimize
@@ -1316,7 +1316,7 @@ struct rte_eth_conf {
 	struct rte_eth_txmode txmode; /**< Port Tx configuration. */
 	uint32_t lpbk_mode; /**< Loopback operation mode. By default the value
 			         is 0, meaning the loopback mode is disabled.
-				 Read the datasheet of given ethernet controller
+				 Read the datasheet of given Ethernet controller
 				 for details. The possible values of this field
 				 are defined in implementation of each driver. */
 	struct {
@@ -3380,7 +3380,7 @@ rte_eth_tx_buffer_init(struct rte_eth_dev_tx_buffer *buffer, uint16_t size);
  * Configure a callback for buffered packets which cannot be sent
  *
  * Register a specific callback to be called when an attempt is made to send
- * all packets buffered on an ethernet port, but not all packets can
+ * all packets buffered on an Ethernet port, but not all packets can
  * successfully be sent. The callback registered here will be called only
  * from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs.
  * The default callback configured for each queue by default just frees the
@@ -4746,7 +4746,7 @@ rte_eth_dev_get_name_by_port(uint16_t port_id, char *name);
 
 /**
  * Check that numbers of Rx and Tx descriptors satisfy descriptors limits from
- * the ethernet device information, otherwise adjust them to boundaries.
+ * the Ethernet device information, otherwise adjust them to boundaries.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -4816,7 +4816,7 @@ int rte_eth_dev_hairpin_capability_get(uint16_t port_id,
  * @warning
  * @b EXPERIMENTAL: this structure may change without prior notice.
  *
- * ethernet device representor ID range entry
+ * Ethernet device representor ID range entry
  */
 struct rte_eth_representor_range {
 	enum rte_eth_representor_type type; /**< Representor type */
-- 
2.30.2

[dpdk-dev] [PATCH v3 04/10] ethdev: fix DCB and VMDq spelling

[Andrew Rybchenko]

Fix both in one changeset since they share line in a number of cases.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h |  2 +-
 lib/ethdev/rte_ethdev.h    | 42 +++++++++++++++++++-------------------
 2 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index dbd32bc1cd..94878f94fc 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -661,7 +661,7 @@ typedef int (*eth_tm_ops_get_t)(struct rte_eth_dev *dev, void *ops);
 /** @internal Get Traffic Metering and Policing (MTR) operations. */
 typedef int (*eth_mtr_ops_get_t)(struct rte_eth_dev *dev, void *ops);
 
-/** @internal Get dcb information on an Ethernet device. */
+/** @internal Get DCB information on an Ethernet device. */
 typedef int (*eth_get_dcb_info)(struct rte_eth_dev *dev,
 				 struct rte_eth_dcb_info *dcb_info);
 
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 6ae6d9ba99..d903f51196 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -83,7 +83,7 @@
  *     - MTU
  *     - flow control settings
  *     - receive mode configuration (promiscuous mode, all-multicast mode,
- *       hardware checksum mode, RSS/VMDQ settings etc.)
+ *       hardware checksum mode, RSS/VMDq settings etc.)
  *     - VLAN filtering configuration
  *     - default MAC address
  *     - MAC addresses supplied to MAC address array
@@ -365,7 +365,7 @@ struct rte_eth_thresh {
  *  packets to multiple queues.
  */
 enum rte_eth_rx_mq_mode {
-	/** None of DCB,RSS or VMDQ mode */
+	/** None of DCB, RSS or VMDq mode */
 	ETH_MQ_RX_NONE = 0,
 
 	/** For Rx side, only RSS is on */
@@ -375,13 +375,13 @@ enum rte_eth_rx_mq_mode {
 	/** Both DCB and RSS enable */
 	ETH_MQ_RX_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG,
 
-	/** Only VMDQ, no RSS nor DCB */
+	/** Only VMDq, no RSS nor DCB */
 	ETH_MQ_RX_VMDQ_ONLY = ETH_MQ_RX_VMDQ_FLAG,
-	/** RSS mode with VMDQ */
+	/** RSS mode with VMDq */
 	ETH_MQ_RX_VMDQ_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_VMDQ_FLAG,
-	/** Use VMDQ+DCB to route traffic to queues */
+	/** Use VMDq+DCB to route traffic to queues */
 	ETH_MQ_RX_VMDQ_DCB = ETH_MQ_RX_VMDQ_FLAG | ETH_MQ_RX_DCB_FLAG,
-	/** Enable both VMDQ and DCB in VMDq */
+	/** Enable both VMDq and DCB in VMDq */
 	ETH_MQ_RX_VMDQ_DCB_RSS = ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG |
 				 ETH_MQ_RX_VMDQ_FLAG,
 };
@@ -805,9 +805,9 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
 #define RTE_RETA_GROUP_SIZE   64
 
 /**@{@name VMDq and DCB maximums */
-#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDQ vlan filters. */
+#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDq vlan filters. */
 #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
-#define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDQ DCB queues. */
+#define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDq DCB queues. */
 #define ETH_DCB_NUM_QUEUES          128 /**< Maximum nb. of DCB queues. */
 /**@}*/
 
@@ -869,7 +869,7 @@ enum rte_eth_nb_tcs {
 
 /**
  * This enum indicates the possible number of queue pools
- * in VMDQ configurations.
+ * in VMDq configurations.
  */
 enum rte_eth_nb_pools {
 	ETH_8_POOLS = 8,    /**< 8 VMDq pools. */
@@ -902,7 +902,7 @@ struct rte_eth_vmdq_tx_conf {
 };
 
 /**
- * A structure used to configure the VMDQ+DCB feature
+ * A structure used to configure the VMDq+DCB feature
  * of an Ethernet port.
  *
  * Using this feature, packets are routed to a pool of queues, based
@@ -926,7 +926,7 @@ struct rte_eth_vmdq_dcb_conf {
 };
 
 /**
- * A structure used to configure the VMDQ feature of an Ethernet port when
+ * A structure used to configure the VMDq feature of an Ethernet port when
  * not combined with the DCB feature.
  *
  * Using this feature, packets are routed to a pool of queues. By default,
@@ -1321,19 +1321,19 @@ struct rte_eth_conf {
 				 are defined in implementation of each driver. */
 	struct {
 		struct rte_eth_rss_conf rss_conf; /**< Port RSS configuration */
-		/** Port vmdq+dcb configuration. */
+		/** Port VMDq+DCB configuration. */
 		struct rte_eth_vmdq_dcb_conf vmdq_dcb_conf;
-		/** Port dcb Rx configuration. */
+		/** Port DCB Rx configuration. */
 		struct rte_eth_dcb_rx_conf dcb_rx_conf;
-		/** Port vmdq Rx configuration. */
+		/** Port VMDq Rx configuration. */
 		struct rte_eth_vmdq_rx_conf vmdq_rx_conf;
 	} rx_adv_conf; /**< Port Rx filtering configuration. */
 	union {
-		/** Port vmdq+dcb Tx configuration. */
+		/** Port VMDq+DCB Tx configuration. */
 		struct rte_eth_vmdq_dcb_tx_conf vmdq_dcb_tx_conf;
-		/** Port dcb Tx configuration. */
+		/** Port DCB Tx configuration. */
 		struct rte_eth_dcb_tx_conf dcb_tx_conf;
-		/** Port vmdq Tx configuration. */
+		/** Port VMDq Tx configuration. */
 		struct rte_eth_vmdq_tx_conf vmdq_tx_conf;
 	} tx_adv_conf; /**< Port Tx DCB configuration (union). */
 	/** Currently,Priority Flow Control(PFC) are supported,if DCB with PFC
@@ -1561,9 +1561,9 @@ struct rte_eth_dev_info {
 	uint64_t flow_type_rss_offloads;
 	struct rte_eth_rxconf default_rxconf; /**< Default Rx configuration */
 	struct rte_eth_txconf default_txconf; /**< Default Tx configuration */
-	uint16_t vmdq_queue_base; /**< First queue ID for VMDQ pools. */
-	uint16_t vmdq_queue_num;  /**< Queue number for VMDQ pools. */
-	uint16_t vmdq_pool_base;  /**< First ID of VMDQ pools. */
+	uint16_t vmdq_queue_base; /**< First queue ID for VMDq pools. */
+	uint16_t vmdq_queue_num;  /**< Queue number for VMDq pools. */
+	uint16_t vmdq_pool_base;  /**< First ID of VMDq pools. */
 	struct rte_eth_desc_lim rx_desc_lim;  /**< Rx descriptors limits */
 	struct rte_eth_desc_lim tx_desc_lim;  /**< Tx descriptors limits */
 	uint32_t speed_capa;  /**< Supported speeds bitmap (ETH_LINK_SPEED_). */
@@ -4113,7 +4113,7 @@ rte_eth_dev_udp_tunnel_port_delete(uint16_t port_id,
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param dcb_info
- *   dcb information.
+ *   DCB information.
  * @return
  *   - (0) if successful.
  *   - (-ENODEV) if port identifier is invalid.
-- 
2.30.2

[dpdk-dev] [PATCH v3 05/10] ethdev: fix VLAN spelling including VLAN ID case

[Andrew Rybchenko]

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/rte_ethdev.c |  2 +-
 lib/ethdev/rte_ethdev.h | 30 +++++++++++++++---------------
 lib/ethdev/rte_flow.h   |  6 +++---
 3 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
index acb667c112..9d1793e216 100644
--- a/lib/ethdev/rte_ethdev.c
+++ b/lib/ethdev/rte_ethdev.c
@@ -3707,7 +3707,7 @@ rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on)
 
 	if (!(dev->data->dev_conf.rxmode.offloads &
 	      DEV_RX_OFFLOAD_VLAN_FILTER)) {
-		RTE_ETHDEV_LOG(ERR, "Port %u: vlan-filtering disabled\n",
+		RTE_ETHDEV_LOG(ERR, "Port %u: VLAN-filtering disabled\n",
 			port_id);
 		return -ENOSYS;
 	}
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index d903f51196..2c35caf000 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -444,7 +444,7 @@ enum rte_vlan_type {
 };
 
 /**
- * A structure used to describe a vlan filter.
+ * A structure used to describe a VLAN filter.
  * If the bit corresponding to a VID is set, such VID is on.
  */
 struct rte_vlan_filter_conf {
@@ -805,7 +805,7 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
 #define RTE_RETA_GROUP_SIZE   64
 
 /**@{@name VMDq and DCB maximums */
-#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDq vlan filters. */
+#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDq VLAN filters. */
 #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
 #define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDq DCB queues. */
 #define ETH_DCB_NUM_QUEUES          128 /**< Maximum nb. of DCB queues. */
@@ -906,11 +906,11 @@ struct rte_eth_vmdq_tx_conf {
  * of an Ethernet port.
  *
  * Using this feature, packets are routed to a pool of queues, based
- * on the vlan id in the vlan tag, and then to a specific queue within
- * that pool, using the user priority vlan tag field.
+ * on the VLAN ID in the VLAN tag, and then to a specific queue within
+ * that pool, using the user priority VLAN tag field.
  *
  * A default pool may be used, if desired, to route all traffic which
- * does not match the vlan filter rules.
+ * does not match the VLAN filter rules.
  */
 struct rte_eth_vmdq_dcb_conf {
 	enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
@@ -918,9 +918,9 @@ struct rte_eth_vmdq_dcb_conf {
 	uint8_t default_pool; /**< The default pool, if applicable */
 	uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
 	struct {
-		uint16_t vlan_id; /**< The vlan id of the received frame */
+		uint16_t vlan_id; /**< The VLAN ID of the received frame */
 		uint64_t pools;   /**< Bitmask of pools for packet Rx */
-	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
+	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */
 	/** Selects a queue in a pool */
 	uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
 };
@@ -930,8 +930,8 @@ struct rte_eth_vmdq_dcb_conf {
  * not combined with the DCB feature.
  *
  * Using this feature, packets are routed to a pool of queues. By default,
- * the pool selection is based on the MAC address, the vlan id in the
- * vlan tag as specified in the pool_map array.
+ * the pool selection is based on the MAC address, the VLAN ID in the
+ * VLAN tag as specified in the pool_map array.
  * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
  * selection using only the MAC address. MAC address to pool mapping is done
  * using the rte_eth_dev_mac_addr_add function, with the pool parameter
@@ -941,7 +941,7 @@ struct rte_eth_vmdq_dcb_conf {
  * it is enabled or revert to the first queue of the pool if not.
  *
  * A default pool may be used, if desired, to route all traffic which
- * does not match the vlan filter rules or any pool MAC address.
+ * does not match the VLAN filter rules or any pool MAC address.
  */
 struct rte_eth_vmdq_rx_conf {
 	enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
@@ -951,9 +951,9 @@ struct rte_eth_vmdq_rx_conf {
 	uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
 	uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
 	struct {
-		uint16_t vlan_id; /**< The vlan id of the received frame */
+		uint16_t vlan_id; /**< The VLAN ID of the received frame */
 		uint64_t pools;   /**< Bitmask of pools for packet Rx */
-	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
+	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */
 };
 
 /**
@@ -3127,9 +3127,9 @@ int rte_eth_dev_fw_version_get(uint16_t port_id,
  * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
  * packet types for these packets:
  * - Ether/IPv4              -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
- * - Ether/Vlan/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
+ * - Ether/VLAN/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
  * - Ether/[anything else]   -> RTE_PTYPE_L2_ETHER
- * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
+ * - Ether/VLAN/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
  *
  * When a packet is received by a PMD, the most precise type must be
  * returned among the ones supported. However a PMD is allowed to set
@@ -3275,7 +3275,7 @@ int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param vlan_type
- *   The vlan type.
+ *   The VLAN type.
  * @param tag_type
  *   The Tag Protocol ID
  * @return
diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index 45b360d4ac..e3c2277582 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -2181,7 +2181,7 @@ enum rte_flow_action_type {
 	RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN,
 
 	/**
-	 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as
+	 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN ID") as
 	 * defined by the OpenFlow Switch Specification.
 	 *
 	 * See struct rte_flow_action_of_set_vlan_vid.
@@ -2853,11 +2853,11 @@ struct rte_flow_action_of_push_vlan {
 /**
  * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID
  *
- * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as defined by
+ * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN ID") as defined by
  * the OpenFlow Switch Specification.
  */
 struct rte_flow_action_of_set_vlan_vid {
-	rte_be16_t vlan_vid; /**< VLAN id. */
+	rte_be16_t vlan_vid; /**< VLAN ID. */
 };
 
 /**
-- 
2.30.2

Re: [dpdk-dev] [PATCH v3 05/10] ethdev: fix VLAN spelling including VLAN ID case

[Ori Kam]

Hi Andrew,

> -----Original Message-----
> From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> Sent: Wednesday, October 20, 2021 3:47 PM
> Subject: [PATCH v3 05/10] ethdev: fix VLAN spelling including VLAN ID case
> 
> Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> ---
>  lib/ethdev/rte_ethdev.c |  2 +-
>  lib/ethdev/rte_ethdev.h | 30 +++++++++++++++---------------
>  lib/ethdev/rte_flow.h   |  6 +++---
>  3 files changed, 19 insertions(+), 19 deletions(-)
> 
> diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
> index acb667c112..9d1793e216 100644
> --- a/lib/ethdev/rte_ethdev.c
> +++ b/lib/ethdev/rte_ethdev.c
> @@ -3707,7 +3707,7 @@ rte_eth_dev_vlan_filter(uint16_t port_id, uint16_t vlan_id, int on)
> 
>  	if (!(dev->data->dev_conf.rxmode.offloads &
>  	      DEV_RX_OFFLOAD_VLAN_FILTER)) {
> -		RTE_ETHDEV_LOG(ERR, "Port %u: vlan-filtering disabled\n",
> +		RTE_ETHDEV_LOG(ERR, "Port %u: VLAN-filtering disabled\n",
>  			port_id);
>  		return -ENOSYS;
>  	}
> diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
> index d903f51196..2c35caf000 100644
> --- a/lib/ethdev/rte_ethdev.h
> +++ b/lib/ethdev/rte_ethdev.h
> @@ -444,7 +444,7 @@ enum rte_vlan_type {
>  };
> 
>  /**
> - * A structure used to describe a vlan filter.
> + * A structure used to describe a VLAN filter.
>   * If the bit corresponding to a VID is set, such VID is on.
>   */
>  struct rte_vlan_filter_conf {
> @@ -805,7 +805,7 @@ rte_eth_rss_hf_refine(uint64_t rss_hf)
>  #define RTE_RETA_GROUP_SIZE   64
> 
>  /**@{@name VMDq and DCB maximums */
> -#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDq vlan filters. */
> +#define ETH_VMDQ_MAX_VLAN_FILTERS   64 /**< Maximum nb. of VMDq VLAN filters. */
>  #define ETH_DCB_NUM_USER_PRIORITIES 8  /**< Maximum nb. of DCB priorities. */
>  #define ETH_VMDQ_DCB_NUM_QUEUES     128 /**< Maximum nb. of VMDq DCB queues. */
>  #define ETH_DCB_NUM_QUEUES          128 /**< Maximum nb. of DCB queues. */
> @@ -906,11 +906,11 @@ struct rte_eth_vmdq_tx_conf {
>   * of an Ethernet port.
>   *
>   * Using this feature, packets are routed to a pool of queues, based
> - * on the vlan id in the vlan tag, and then to a specific queue within
> - * that pool, using the user priority vlan tag field.
> + * on the VLAN ID in the VLAN tag, and then to a specific queue within
> + * that pool, using the user priority VLAN tag field.
>   *
>   * A default pool may be used, if desired, to route all traffic which
> - * does not match the vlan filter rules.
> + * does not match the VLAN filter rules.
>   */
>  struct rte_eth_vmdq_dcb_conf {
>  	enum rte_eth_nb_pools nb_queue_pools; /**< With DCB, 16 or 32 pools */
> @@ -918,9 +918,9 @@ struct rte_eth_vmdq_dcb_conf {
>  	uint8_t default_pool; /**< The default pool, if applicable */
>  	uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
>  	struct {
> -		uint16_t vlan_id; /**< The vlan id of the received frame */
> +		uint16_t vlan_id; /**< The VLAN ID of the received frame */
>  		uint64_t pools;   /**< Bitmask of pools for packet Rx */
> -	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
> +	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */
>  	/** Selects a queue in a pool */
>  	uint8_t dcb_tc[ETH_DCB_NUM_USER_PRIORITIES];
>  };
> @@ -930,8 +930,8 @@ struct rte_eth_vmdq_dcb_conf {
>   * not combined with the DCB feature.
>   *
>   * Using this feature, packets are routed to a pool of queues. By default,
> - * the pool selection is based on the MAC address, the vlan id in the
> - * vlan tag as specified in the pool_map array.
> + * the pool selection is based on the MAC address, the VLAN ID in the
> + * VLAN tag as specified in the pool_map array.
>   * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
>   * selection using only the MAC address. MAC address to pool mapping is done
>   * using the rte_eth_dev_mac_addr_add function, with the pool parameter
> @@ -941,7 +941,7 @@ struct rte_eth_vmdq_dcb_conf {
>   * it is enabled or revert to the first queue of the pool if not.
>   *
>   * A default pool may be used, if desired, to route all traffic which
> - * does not match the vlan filter rules or any pool MAC address.
> + * does not match the VLAN filter rules or any pool MAC address.
>   */
>  struct rte_eth_vmdq_rx_conf {
>  	enum rte_eth_nb_pools nb_queue_pools; /**< VMDq only mode, 8 or 64 pools */
> @@ -951,9 +951,9 @@ struct rte_eth_vmdq_rx_conf {
>  	uint8_t nb_pool_maps; /**< We can have up to 64 filters/mappings */
>  	uint32_t rx_mode; /**< Flags from ETH_VMDQ_ACCEPT_* */
>  	struct {
> -		uint16_t vlan_id; /**< The vlan id of the received frame */
> +		uint16_t vlan_id; /**< The VLAN ID of the received frame */
>  		uint64_t pools;   /**< Bitmask of pools for packet Rx */
> -	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq vlan pool maps. */
> +	} pool_map[ETH_VMDQ_MAX_VLAN_FILTERS]; /**< VMDq VLAN pool maps. */
>  };
> 
>  /**
> @@ -3127,9 +3127,9 @@ int rte_eth_dev_fw_version_get(uint16_t port_id,
>   * and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following
>   * packet types for these packets:
>   * - Ether/IPv4              -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
> - * - Ether/Vlan/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
> + * - Ether/VLAN/IPv4         -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
>   * - Ether/[anything else]   -> RTE_PTYPE_L2_ETHER
> - * - Ether/Vlan/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
> + * - Ether/VLAN/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN
>   *
>   * When a packet is received by a PMD, the most precise type must be
>   * returned among the ones supported. However a PMD is allowed to set
> @@ -3275,7 +3275,7 @@ int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t
> rx_queue_id,
>   * @param port_id
>   *   The port identifier of the Ethernet device.
>   * @param vlan_type
> - *   The vlan type.
> + *   The VLAN type.
>   * @param tag_type
>   *   The Tag Protocol ID
>   * @return
> diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
> index 45b360d4ac..e3c2277582 100644
> --- a/lib/ethdev/rte_flow.h
> +++ b/lib/ethdev/rte_flow.h
> @@ -2181,7 +2181,7 @@ enum rte_flow_action_type {
>  	RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN,
> 
>  	/**
> -	 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as
> +	 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN ID") as
>  	 * defined by the OpenFlow Switch Specification.
>  	 *
>  	 * See struct rte_flow_action_of_set_vlan_vid.
> @@ -2853,11 +2853,11 @@ struct rte_flow_action_of_push_vlan {
>  /**
>   * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID
>   *
> - * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as defined by
> + * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN ID") as defined by
>   * the OpenFlow Switch Specification.
>   */
>  struct rte_flow_action_of_set_vlan_vid {
> -	rte_be16_t vlan_vid; /**< VLAN id. */
> +	rte_be16_t vlan_vid; /**< VLAN ID. */
>  };
> 
>  /**
> --
> 2.30.2

Acked-by: Ori Kam <orika@nvidia.com>
Best,
Ori

[dpdk-dev] [PATCH v3 06/10] ethdev: fix ID spelling in comments and log messages

[Andrew Rybchenko]

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h  |  2 +-
 lib/ethdev/ethdev_private.h |  2 +-
 lib/ethdev/rte_class_eth.c  |  2 +-
 lib/ethdev/rte_ethdev.c     | 14 ++++-----
 lib/ethdev/rte_ethdev.h     | 62 ++++++++++++++++++-------------------
 lib/ethdev/rte_flow.h       |  4 +--
 6 files changed, 43 insertions(+), 43 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 94878f94fc..6b01ea829d 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -1420,7 +1420,7 @@ rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
  *
  * A pool of switch domain identifiers which can be allocated on request. This
  * will enabled devices which support the concept of switch domains to request
- * a switch domain id which is guaranteed to be unique from other devices
+ * a switch domain ID which is guaranteed to be unique from other devices
  * running in the same process.
  *
  * @param domain_id
diff --git a/lib/ethdev/ethdev_private.h b/lib/ethdev/ethdev_private.h
index 5721be7bdc..cc91025e8d 100644
--- a/lib/ethdev/ethdev_private.h
+++ b/lib/ethdev/ethdev_private.h
@@ -10,7 +10,7 @@
 #include "rte_ethdev.h"
 
 /*
- * Convert rte_eth_dev pointer to port id.
+ * Convert rte_eth_dev pointer to port ID.
  * NULL will be translated to RTE_MAX_ETHPORTS.
  */
 uint16_t eth_dev_to_id(const struct rte_eth_dev *dev);
diff --git a/lib/ethdev/rte_class_eth.c b/lib/ethdev/rte_class_eth.c
index eda216ced5..c8e8fc9244 100644
--- a/lib/ethdev/rte_class_eth.c
+++ b/lib/ethdev/rte_class_eth.c
@@ -90,7 +90,7 @@ eth_representor_cmp(const char *key __rte_unused,
 	np = eth_da.nb_ports > 0 ? eth_da.nb_ports : 1;
 	nf = eth_da.nb_representor_ports > 0 ? eth_da.nb_representor_ports : 1;
 
-	/* Return 0 if representor id is matching one of the values. */
+	/* Return 0 if representor ID is matching one of the values. */
 	for (i = 0; i < nc * np * nf; ++i) {
 		c = i / (np * nf);
 		p = (i / nf) % np;
diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
index 9d1793e216..02c2034000 100644
--- a/lib/ethdev/rte_ethdev.c
+++ b/lib/ethdev/rte_ethdev.c
@@ -538,7 +538,7 @@ rte_eth_dev_allocate(const char *name)
 
 /*
  * Attach to a port already registered by the primary process, which
- * makes sure that the same device would have the same port id both
+ * makes sure that the same device would have the same port ID both
  * in the primary and secondary process.
  */
 struct rte_eth_dev *
@@ -668,7 +668,7 @@ eth_dev_owner_set(const uint16_t port_id, const uint64_t old_owner_id,
 	struct rte_eth_dev_owner *port_owner;
 
 	if (port_id >= RTE_MAX_ETHPORTS || !eth_dev_is_allocated(ethdev)) {
-		RTE_ETHDEV_LOG(ERR, "Port id %"PRIu16" is not allocated\n",
+		RTE_ETHDEV_LOG(ERR, "Port ID %"PRIu16" is not allocated\n",
 			port_id);
 		return -ENODEV;
 	}
@@ -760,7 +760,7 @@ rte_eth_dev_owner_delete(const uint64_t owner_id)
 			owner_id);
 	} else {
 		RTE_ETHDEV_LOG(ERR,
-			       "Invalid owner id=%016"PRIx64"\n",
+			       "Invalid owner ID=%016"PRIx64"\n",
 			       owner_id);
 		ret = -EINVAL;
 	}
@@ -779,7 +779,7 @@ rte_eth_dev_owner_get(const uint16_t port_id, struct rte_eth_dev_owner *owner)
 	ethdev = &rte_eth_devices[port_id];
 
 	if (!eth_dev_is_allocated(ethdev)) {
-		RTE_ETHDEV_LOG(ERR, "Port id %"PRIu16" is not allocated\n",
+		RTE_ETHDEV_LOG(ERR, "Port ID %"PRIu16" is not allocated\n",
 			port_id);
 		return -ENODEV;
 	}
@@ -4327,7 +4327,7 @@ rte_eth_dev_mac_addr_add(uint16_t port_id, struct rte_ether_addr *addr,
 		return -EINVAL;
 	}
 	if (pool >= ETH_64_POOLS) {
-		RTE_ETHDEV_LOG(ERR, "Pool id must be 0-%d\n", ETH_64_POOLS - 1);
+		RTE_ETHDEV_LOG(ERR, "Pool ID must be 0-%d\n", ETH_64_POOLS - 1);
 		return -EINVAL;
 	}
 
@@ -4552,7 +4552,7 @@ int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
 
 	if (queue_idx > dev_info.max_tx_queues) {
 		RTE_ETHDEV_LOG(ERR,
-			"Set queue rate limit:port %u: invalid queue id=%u\n",
+			"Set queue rate limit:port %u: invalid queue ID=%u\n",
 			port_id, queue_idx);
 		return -EINVAL;
 	}
@@ -6409,7 +6409,7 @@ rte_eth_rx_metadata_negotiate(uint16_t port_id, uint64_t *features)
 
 	if (dev->data->dev_configured != 0) {
 		RTE_ETHDEV_LOG(ERR,
-			"The port (id=%"PRIu16") is already configured\n",
+			"The port (ID=%"PRIu16") is already configured\n",
 			port_id);
 		return -EBUSY;
 	}
diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 2c35caf000..f7be628f7d 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -197,7 +197,7 @@ int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
  * Iterates on devices with devargs filter.
  * The ownership is not checked.
  *
- * The next port id is returned, and the iterator is updated.
+ * The next port ID is returned, and the iterator is updated.
  *
  * @param iter
  *   Device iterator handle initialized by rte_eth_iterator_init().
@@ -205,7 +205,7 @@ int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
  *   by calling rte_eth_iterator_cleanup().
  *
  * @return
- *   A port id if found, RTE_MAX_ETHPORTS otherwise.
+ *   A port ID if found, RTE_MAX_ETHPORTS otherwise.
  */
 uint16_t rte_eth_iterator_next(struct rte_dev_iterator *iter);
 
@@ -230,7 +230,7 @@ void rte_eth_iterator_cleanup(struct rte_dev_iterator *iter);
  * the function rte_eth_iterator_cleanup() must be called.
  *
  * @param id
- *   Iterated port id of type uint16_t.
+ *   Iterated port ID of type uint16_t.
  * @param devargs
  *   Device parameters input as string of type char*.
  * @param iter
@@ -935,7 +935,7 @@ struct rte_eth_vmdq_dcb_conf {
  * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
  * selection using only the MAC address. MAC address to pool mapping is done
  * using the rte_eth_dev_mac_addr_add function, with the pool parameter
- * corresponding to the pool id.
+ * corresponding to the pool ID.
  *
  * Queue selection within the selected pool will be done using RSS when
  * it is enabled or revert to the first queue of the pool if not.
@@ -1471,7 +1471,7 @@ struct rte_eth_dev_portconf {
 };
 
 /**
- * Default values for switch domain id when ethdev does not support switch
+ * Default values for switch domain ID when ethdev does not support switch
  * domain definitions.
  */
 #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID	(UINT16_MAX)
@@ -1481,7 +1481,7 @@ struct rte_eth_dev_portconf {
  */
 struct rte_eth_switch_info {
 	const char *name;	/**< switch name */
-	uint16_t domain_id;	/**< switch domain id */
+	uint16_t domain_id;	/**< switch domain ID */
 	/**
 	 * Mapping to the devices physical switch port as enumerated from the
 	 * perspective of the embedded interconnect/switch. For SR-IOV enabled
@@ -1644,7 +1644,7 @@ struct rte_eth_burst_mode {
  * This structure is used by rte_eth_xstats_get() to provide
  * statistics that are not provided in the generic *rte_eth_stats*
  * structure.
- * It maps a name id, corresponding to an index in the array returned
+ * It maps a name ID, corresponding to an index in the array returned
  * by rte_eth_xstats_get_names(), to a statistic value.
  */
 struct rte_eth_xstat {
@@ -1860,12 +1860,12 @@ struct rte_eth_dev_owner {
  * Iterates over valid ethdev ports owned by a specific owner.
  *
  * @param port_id
- *   The id of the next possible valid owned port.
+ *   The ID of the next possible valid owned port.
  * @param	owner_id
  *  The owner identifier.
  *  RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports.
  * @return
- *   Next valid port id owned by owner_id, RTE_MAX_ETHPORTS if there is none.
+ *   Next valid port ID owned by owner_id, RTE_MAX_ETHPORTS if there is none.
  */
 uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
 		const uint64_t owner_id);
@@ -1882,9 +1882,9 @@ uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
  * Iterates over valid ethdev ports.
  *
  * @param port_id
- *   The id of the next possible valid port.
+ *   The ID of the next possible valid port.
  * @return
- *   Next valid port id, RTE_MAX_ETHPORTS if there is none.
+ *   Next valid port ID, RTE_MAX_ETHPORTS if there is none.
  */
 uint16_t rte_eth_find_next(uint16_t port_id);
 
@@ -1898,11 +1898,11 @@ uint16_t rte_eth_find_next(uint16_t port_id);
  * Iterates over ethdev ports of a specified device.
  *
  * @param port_id_start
- *   The id of the next possible valid port.
+ *   The ID of the next possible valid port.
  * @param parent
  *   The generic device behind the ports to iterate.
  * @return
- *   Next port id of the device, possibly port_id_start,
+ *   Next port ID of the device, possibly port_id_start,
  *   RTE_MAX_ETHPORTS if there is none.
  */
 uint16_t
@@ -1913,7 +1913,7 @@ rte_eth_find_next_of(uint16_t port_id_start,
  * Macro to iterate over all ethdev ports of a specified device.
  *
  * @param port_id
- *   The id of the matching port being iterated.
+ *   The ID of the matching port being iterated.
  * @param parent
  *   The rte_device pointer matching the iterated ports.
  */
@@ -1926,11 +1926,11 @@ rte_eth_find_next_of(uint16_t port_id_start,
  * Iterates over sibling ethdev ports (i.e. sharing the same rte_device).
  *
  * @param port_id_start
- *   The id of the next possible valid sibling port.
+ *   The ID of the next possible valid sibling port.
  * @param ref_port_id
- *   The id of a reference port to compare rte_device with.
+ *   The ID of a reference port to compare rte_device with.
  * @return
- *   Next sibling port id, possibly port_id_start or ref_port_id itself,
+ *   Next sibling port ID, possibly port_id_start or ref_port_id itself,
  *   RTE_MAX_ETHPORTS if there is none.
  */
 uint16_t
@@ -1942,9 +1942,9 @@ rte_eth_find_next_sibling(uint16_t port_id_start, uint16_t ref_port_id);
  * Note: the specified reference port is part of the loop iterations.
  *
  * @param port_id
- *   The id of the matching port being iterated.
+ *   The ID of the matching port being iterated.
  * @param ref_port_id
- *   The id of the port being compared.
+ *   The ID of the port being compared.
  */
 #define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id) \
 	for (port_id = rte_eth_find_next_sibling(0, ref_port_id); \
@@ -2413,7 +2413,7 @@ int rte_eth_hairpin_unbind(uint16_t tx_port, uint16_t rx_port);
  * @param port_id
  *   The port identifier of the Ethernet device
  * @return
- *   The NUMA socket id to which the Ethernet device is connected or
+ *   The NUMA socket ID to which the Ethernet device is connected or
  *   a default of zero if the socket could not be determined.
  *   -1 is returned is the port_id value is out of range.
  */
@@ -2575,7 +2575,7 @@ int rte_eth_dev_set_link_down(uint16_t port_id);
 int rte_eth_dev_close(uint16_t port_id);
 
 /**
- * Reset a Ethernet device and keep its port id.
+ * Reset a Ethernet device and keep its port ID.
  *
  * When a port has to be reset passively, the DPDK application can invoke
  * this function. For example when a PF is reset, all its VFs should also
@@ -2586,7 +2586,7 @@ int rte_eth_dev_close(uint16_t port_id);
  * When this function is called, it first stops the port and then calls the
  * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
  * state, in which no Tx and Rx queues are setup, as if the port has been
- * reset and not started. The port keeps the port id it had before the
+ * reset and not started. The port keeps the port ID it had before the
  * function call.
  *
  * After calling rte_eth_dev_reset( ), the application should use
@@ -2821,7 +2821,7 @@ int rte_eth_stats_reset(uint16_t port_id);
  *     is too small. The return value corresponds to the size that should
  *     be given to succeed. The entries in the table are not valid and
  *     shall not be used by the caller.
- *   - A negative value on error (invalid port id).
+ *   - A negative value on error (invalid port ID).
  */
 int rte_eth_xstats_get_names(uint16_t port_id,
 		struct rte_eth_xstat_name *xstats_names,
@@ -2854,7 +2854,7 @@ int rte_eth_xstats_get_names(uint16_t port_id,
  *     is too small. The return value corresponds to the size that should
  *     be given to succeed. The entries in the table are not valid and
  *     shall not be used by the caller.
- *   - A negative value on error (invalid port id).
+ *   - A negative value on error (invalid port ID).
  */
 int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
 		unsigned int n);
@@ -3554,7 +3554,7 @@ typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
  * Register a callback function for port event.
  *
  * @param port_id
- *  Port id.
+ *  Port ID.
  *  RTE_ETH_ALL means register the event for all port ids.
  * @param event
  *  Event interested.
@@ -3575,7 +3575,7 @@ int rte_eth_dev_callback_register(uint16_t port_id,
  * Unregister a callback function for port event.
  *
  * @param port_id
- *  Port id.
+ *  Port ID.
  *  RTE_ETH_ALL means unregister the event for all port ids.
  * @param event
  *  Event interested.
@@ -4007,7 +4007,7 @@ int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param queue_idx
- *   The queue id.
+ *   The queue ID.
  * @param tx_rate
  *   The Tx rate in Mbps. Allocated from the total port link speed.
  * @return
@@ -4709,7 +4709,7 @@ int
 rte_eth_read_clock(uint16_t port_id, uint64_t *clock);
 
 /**
-* Get the port id from device name. The device name should be specified
+* Get the port ID from device name. The device name should be specified
 * as below:
 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0
 * - SoC device name, for example- fsl-gmac0
@@ -4727,7 +4727,7 @@ int
 rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
 
 /**
-* Get the device name from port id. The device name is specified as below:
+* Get the device name from port ID. The device name is specified as below:
 * - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0
 * - SoC device name, for example- fsl-gmac0
 * - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0]
@@ -5105,7 +5105,7 @@ rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
  * @param port_id
  *  The port identifier of the Ethernet device.
  * @param queue_id
- *  The queue id on the specific port.
+ *  The queue ID on the specific port.
  * @return
  *  The number of used descriptors in the specific queue, or:
  *   - (-ENODEV) if *port_id* is invalid.
@@ -5455,7 +5455,7 @@ rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
- *   The value must be a valid port id.
+ *   The value must be a valid port ID.
  * @param queue_id
  *   The index of the transmit queue through which output packets must be
  *   sent.
diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
index e3c2277582..9546453762 100644
--- a/lib/ethdev/rte_flow.h
+++ b/lib/ethdev/rte_flow.h
@@ -2624,12 +2624,12 @@ struct rte_flow_query_age {
  * Adds a counter action to a matched flow.
  *
  * If more than one count action is specified in a single flow rule, then each
- * action must specify a unique id.
+ * action must specify a unique ID.
  *
  * Counters can be retrieved and reset through ``rte_flow_query()``, see
  * ``struct rte_flow_query_count``.
  *
- * For ports within the same switch domain then the counter id namespace extends
+ * For ports within the same switch domain then the counter ID namespace extends
  * to all ports within that switch domain.
  */
 struct rte_flow_action_count {
-- 
2.30.2

Re: [dpdk-dev] [PATCH v3 06/10] ethdev: fix ID spelling in comments and log messages

[Ori Kam]

Hi Andrew,

> -----Original Message-----
> From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> Sent: Wednesday, October 20, 2021 3:47 PM
> Subject: [PATCH v3 06/10] ethdev: fix ID spelling in comments and log messages
> 
> Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
> ---
>  lib/ethdev/ethdev_driver.h  |  2 +-
>  lib/ethdev/ethdev_private.h |  2 +-
>  lib/ethdev/rte_class_eth.c  |  2 +-
>  lib/ethdev/rte_ethdev.c     | 14 ++++-----
>  lib/ethdev/rte_ethdev.h     | 62 ++++++++++++++++++-------------------
>  lib/ethdev/rte_flow.h       |  4 +--
>  6 files changed, 43 insertions(+), 43 deletions(-)
> 
> diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
> index 94878f94fc..6b01ea829d 100644
> --- a/lib/ethdev/ethdev_driver.h
> +++ b/lib/ethdev/ethdev_driver.h
> @@ -1420,7 +1420,7 @@ rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
>   *
>   * A pool of switch domain identifiers which can be allocated on request. This
>   * will enabled devices which support the concept of switch domains to request
> - * a switch domain id which is guaranteed to be unique from other devices
> + * a switch domain ID which is guaranteed to be unique from other devices
>   * running in the same process.
>   *
>   * @param domain_id
> diff --git a/lib/ethdev/ethdev_private.h b/lib/ethdev/ethdev_private.h
> index 5721be7bdc..cc91025e8d 100644
> --- a/lib/ethdev/ethdev_private.h
> +++ b/lib/ethdev/ethdev_private.h
> @@ -10,7 +10,7 @@
>  #include "rte_ethdev.h"
> 
>  /*
> - * Convert rte_eth_dev pointer to port id.
> + * Convert rte_eth_dev pointer to port ID.
>   * NULL will be translated to RTE_MAX_ETHPORTS.
>   */
>  uint16_t eth_dev_to_id(const struct rte_eth_dev *dev);
> diff --git a/lib/ethdev/rte_class_eth.c b/lib/ethdev/rte_class_eth.c
> index eda216ced5..c8e8fc9244 100644
> --- a/lib/ethdev/rte_class_eth.c
> +++ b/lib/ethdev/rte_class_eth.c
> @@ -90,7 +90,7 @@ eth_representor_cmp(const char *key __rte_unused,
>  	np = eth_da.nb_ports > 0 ? eth_da.nb_ports : 1;
>  	nf = eth_da.nb_representor_ports > 0 ? eth_da.nb_representor_ports : 1;
> 
> -	/* Return 0 if representor id is matching one of the values. */
> +	/* Return 0 if representor ID is matching one of the values. */
>  	for (i = 0; i < nc * np * nf; ++i) {
>  		c = i / (np * nf);
>  		p = (i / nf) % np;
> diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
> index 9d1793e216..02c2034000 100644
> --- a/lib/ethdev/rte_ethdev.c
> +++ b/lib/ethdev/rte_ethdev.c
> @@ -538,7 +538,7 @@ rte_eth_dev_allocate(const char *name)
> 
>  /*
>   * Attach to a port already registered by the primary process, which
> - * makes sure that the same device would have the same port id both
> + * makes sure that the same device would have the same port ID both
>   * in the primary and secondary process.
>   */
>  struct rte_eth_dev *
> @@ -668,7 +668,7 @@ eth_dev_owner_set(const uint16_t port_id, const uint64_t old_owner_id,
>  	struct rte_eth_dev_owner *port_owner;
> 
>  	if (port_id >= RTE_MAX_ETHPORTS || !eth_dev_is_allocated(ethdev)) {
> -		RTE_ETHDEV_LOG(ERR, "Port id %"PRIu16" is not allocated\n",
> +		RTE_ETHDEV_LOG(ERR, "Port ID %"PRIu16" is not allocated\n",
>  			port_id);
>  		return -ENODEV;
>  	}
> @@ -760,7 +760,7 @@ rte_eth_dev_owner_delete(const uint64_t owner_id)
>  			owner_id);
>  	} else {
>  		RTE_ETHDEV_LOG(ERR,
> -			       "Invalid owner id=%016"PRIx64"\n",
> +			       "Invalid owner ID=%016"PRIx64"\n",
>  			       owner_id);
>  		ret = -EINVAL;
>  	}
> @@ -779,7 +779,7 @@ rte_eth_dev_owner_get(const uint16_t port_id, struct rte_eth_dev_owner
> *owner)
>  	ethdev = &rte_eth_devices[port_id];
> 
>  	if (!eth_dev_is_allocated(ethdev)) {
> -		RTE_ETHDEV_LOG(ERR, "Port id %"PRIu16" is not allocated\n",
> +		RTE_ETHDEV_LOG(ERR, "Port ID %"PRIu16" is not allocated\n",
>  			port_id);
>  		return -ENODEV;
>  	}
> @@ -4327,7 +4327,7 @@ rte_eth_dev_mac_addr_add(uint16_t port_id, struct rte_ether_addr *addr,
>  		return -EINVAL;
>  	}
>  	if (pool >= ETH_64_POOLS) {
> -		RTE_ETHDEV_LOG(ERR, "Pool id must be 0-%d\n", ETH_64_POOLS - 1);
> +		RTE_ETHDEV_LOG(ERR, "Pool ID must be 0-%d\n", ETH_64_POOLS - 1);
>  		return -EINVAL;
>  	}
> 
> @@ -4552,7 +4552,7 @@ int rte_eth_set_queue_rate_limit(uint16_t port_id, uint16_t queue_idx,
> 
>  	if (queue_idx > dev_info.max_tx_queues) {
>  		RTE_ETHDEV_LOG(ERR,
> -			"Set queue rate limit:port %u: invalid queue id=%u\n",
> +			"Set queue rate limit:port %u: invalid queue ID=%u\n",
>  			port_id, queue_idx);
>  		return -EINVAL;
>  	}
> @@ -6409,7 +6409,7 @@ rte_eth_rx_metadata_negotiate(uint16_t port_id, uint64_t *features)
> 
>  	if (dev->data->dev_configured != 0) {
>  		RTE_ETHDEV_LOG(ERR,
> -			"The port (id=%"PRIu16") is already configured\n",
> +			"The port (ID=%"PRIu16") is already configured\n",
>  			port_id);
>  		return -EBUSY;
>  	}
> diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
> index 2c35caf000..f7be628f7d 100644
> --- a/lib/ethdev/rte_ethdev.h
> +++ b/lib/ethdev/rte_ethdev.h
> @@ -197,7 +197,7 @@ int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
>   * Iterates on devices with devargs filter.
>   * The ownership is not checked.
>   *
> - * The next port id is returned, and the iterator is updated.
> + * The next port ID is returned, and the iterator is updated.
>   *
>   * @param iter
>   *   Device iterator handle initialized by rte_eth_iterator_init().
> @@ -205,7 +205,7 @@ int rte_eth_iterator_init(struct rte_dev_iterator *iter, const char *devargs);
>   *   by calling rte_eth_iterator_cleanup().
>   *
>   * @return
> - *   A port id if found, RTE_MAX_ETHPORTS otherwise.
> + *   A port ID if found, RTE_MAX_ETHPORTS otherwise.
>   */
>  uint16_t rte_eth_iterator_next(struct rte_dev_iterator *iter);
> 
> @@ -230,7 +230,7 @@ void rte_eth_iterator_cleanup(struct rte_dev_iterator *iter);
>   * the function rte_eth_iterator_cleanup() must be called.
>   *
>   * @param id
> - *   Iterated port id of type uint16_t.
> + *   Iterated port ID of type uint16_t.
>   * @param devargs
>   *   Device parameters input as string of type char*.
>   * @param iter
> @@ -935,7 +935,7 @@ struct rte_eth_vmdq_dcb_conf {
>   * Passing the ETH_VMDQ_ACCEPT_UNTAG in the rx_mode field allows pool
>   * selection using only the MAC address. MAC address to pool mapping is done
>   * using the rte_eth_dev_mac_addr_add function, with the pool parameter
> - * corresponding to the pool id.
> + * corresponding to the pool ID.
>   *
>   * Queue selection within the selected pool will be done using RSS when
>   * it is enabled or revert to the first queue of the pool if not.
> @@ -1471,7 +1471,7 @@ struct rte_eth_dev_portconf {
>  };
> 
>  /**
> - * Default values for switch domain id when ethdev does not support switch
> + * Default values for switch domain ID when ethdev does not support switch
>   * domain definitions.
>   */
>  #define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID	(UINT16_MAX)
> @@ -1481,7 +1481,7 @@ struct rte_eth_dev_portconf {
>   */
>  struct rte_eth_switch_info {
>  	const char *name;	/**< switch name */
> -	uint16_t domain_id;	/**< switch domain id */
> +	uint16_t domain_id;	/**< switch domain ID */
>  	/**
>  	 * Mapping to the devices physical switch port as enumerated from the
>  	 * perspective of the embedded interconnect/switch. For SR-IOV enabled
> @@ -1644,7 +1644,7 @@ struct rte_eth_burst_mode {
>   * This structure is used by rte_eth_xstats_get() to provide
>   * statistics that are not provided in the generic *rte_eth_stats*
>   * structure.
> - * It maps a name id, corresponding to an index in the array returned
> + * It maps a name ID, corresponding to an index in the array returned
>   * by rte_eth_xstats_get_names(), to a statistic value.
>   */
>  struct rte_eth_xstat {
> @@ -1860,12 +1860,12 @@ struct rte_eth_dev_owner {
>   * Iterates over valid ethdev ports owned by a specific owner.
>   *
>   * @param port_id
> - *   The id of the next possible valid owned port.
> + *   The ID of the next possible valid owned port.
>   * @param	owner_id
>   *  The owner identifier.
>   *  RTE_ETH_DEV_NO_OWNER means iterate over all valid ownerless ports.
>   * @return
> - *   Next valid port id owned by owner_id, RTE_MAX_ETHPORTS if there is none.
> + *   Next valid port ID owned by owner_id, RTE_MAX_ETHPORTS if there is none.
>   */
>  uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
>  		const uint64_t owner_id);
> @@ -1882,9 +1882,9 @@ uint64_t rte_eth_find_next_owned_by(uint16_t port_id,
>   * Iterates over valid ethdev ports.
>   *
>   * @param port_id
> - *   The id of the next possible valid port.
> + *   The ID of the next possible valid port.
>   * @return
> - *   Next valid port id, RTE_MAX_ETHPORTS if there is none.
> + *   Next valid port ID, RTE_MAX_ETHPORTS if there is none.
>   */
>  uint16_t rte_eth_find_next(uint16_t port_id);
> 
> @@ -1898,11 +1898,11 @@ uint16_t rte_eth_find_next(uint16_t port_id);
>   * Iterates over ethdev ports of a specified device.
>   *
>   * @param port_id_start
> - *   The id of the next possible valid port.
> + *   The ID of the next possible valid port.
>   * @param parent
>   *   The generic device behind the ports to iterate.
>   * @return
> - *   Next port id of the device, possibly port_id_start,
> + *   Next port ID of the device, possibly port_id_start,
>   *   RTE_MAX_ETHPORTS if there is none.
>   */
>  uint16_t
> @@ -1913,7 +1913,7 @@ rte_eth_find_next_of(uint16_t port_id_start,
>   * Macro to iterate over all ethdev ports of a specified device.
>   *
>   * @param port_id
> - *   The id of the matching port being iterated.
> + *   The ID of the matching port being iterated.
>   * @param parent
>   *   The rte_device pointer matching the iterated ports.
>   */
> @@ -1926,11 +1926,11 @@ rte_eth_find_next_of(uint16_t port_id_start,
>   * Iterates over sibling ethdev ports (i.e. sharing the same rte_device).
>   *
>   * @param port_id_start
> - *   The id of the next possible valid sibling port.
> + *   The ID of the next possible valid sibling port.
>   * @param ref_port_id
> - *   The id of a reference port to compare rte_device with.
> + *   The ID of a reference port to compare rte_device with.
>   * @return
> - *   Next sibling port id, possibly port_id_start or ref_port_id itself,
> + *   Next sibling port ID, possibly port_id_start or ref_port_id itself,
>   *   RTE_MAX_ETHPORTS if there is none.
>   */
>  uint16_t
> @@ -1942,9 +1942,9 @@ rte_eth_find_next_sibling(uint16_t port_id_start, uint16_t ref_port_id);
>   * Note: the specified reference port is part of the loop iterations.
>   *
>   * @param port_id
> - *   The id of the matching port being iterated.
> + *   The ID of the matching port being iterated.
>   * @param ref_port_id
> - *   The id of the port being compared.
> + *   The ID of the port being compared.
>   */
>  #define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id) \
>  	for (port_id = rte_eth_find_next_sibling(0, ref_port_id); \
> @@ -2413,7 +2413,7 @@ int rte_eth_hairpin_unbind(uint16_t tx_port, uint16_t rx_port);
>   * @param port_id
>   *   The port identifier of the Ethernet device
>   * @return
> - *   The NUMA socket id to which the Ethernet device is connected or
> + *   The NUMA socket ID to which the Ethernet device is connected or
>   *   a default of zero if the socket could not be determined.
>   *   -1 is returned is the port_id value is out of range.
>   */
> @@ -2575,7 +2575,7 @@ int rte_eth_dev_set_link_down(uint16_t port_id);
>  int rte_eth_dev_close(uint16_t port_id);
> 
>  /**
> - * Reset a Ethernet device and keep its port id.
> + * Reset a Ethernet device and keep its port ID.
>   *
>   * When a port has to be reset passively, the DPDK application can invoke
>   * this function. For example when a PF is reset, all its VFs should also
> @@ -2586,7 +2586,7 @@ int rte_eth_dev_close(uint16_t port_id);
>   * When this function is called, it first stops the port and then calls the
>   * PMD specific dev_uninit( ) and dev_init( ) to return the port to initial
>   * state, in which no Tx and Rx queues are setup, as if the port has been
> - * reset and not started. The port keeps the port id it had before the
> + * reset and not started. The port keeps the port ID it had before the
>   * function call.
>   *
>   * After calling rte_eth_dev_reset( ), the application should use
> @@ -2821,7 +2821,7 @@ int rte_eth_stats_reset(uint16_t port_id);
>   *     is too small. The return value corresponds to the size that should
>   *     be given to succeed. The entries in the table are not valid and
>   *     shall not be used by the caller.
> - *   - A negative value on error (invalid port id).
> + *   - A negative value on error (invalid port ID).
>   */
>  int rte_eth_xstats_get_names(uint16_t port_id,
>  		struct rte_eth_xstat_name *xstats_names,
> @@ -2854,7 +2854,7 @@ int rte_eth_xstats_get_names(uint16_t port_id,
>   *     is too small. The return value corresponds to the size that should
>   *     be given to succeed. The entries in the table are not valid and
>   *     shall not be used by the caller.
> - *   - A negative value on error (invalid port id).
> + *   - A negative value on error (invalid port ID).
>   */
>  int rte_eth_xstats_get(uint16_t port_id, struct rte_eth_xstat *xstats,
>  		unsigned int n);
> @@ -3554,7 +3554,7 @@ typedef int (*rte_eth_dev_cb_fn)(uint16_t port_id,
>   * Register a callback function for port event.
>   *
>   * @param port_id
> - *  Port id.
> + *  Port ID.
>   *  RTE_ETH_ALL means register the event for all port ids.
>   * @param event
>   *  Event interested.
> @@ -3575,7 +3575,7 @@ int rte_eth_dev_callback_register(uint16_t port_id,
>   * Unregister a callback function for port event.
>   *
>   * @param port_id
> - *  Port id.
> + *  Port ID.
>   *  RTE_ETH_ALL means unregister the event for all port ids.
>   * @param event
>   *  Event interested.
> @@ -4007,7 +4007,7 @@ int rte_eth_dev_uc_all_hash_table_set(uint16_t port_id, uint8_t on);
>   * @param port_id
>   *   The port identifier of the Ethernet device.
>   * @param queue_idx
> - *   The queue id.
> + *   The queue ID.
>   * @param tx_rate
>   *   The Tx rate in Mbps. Allocated from the total port link speed.
>   * @return
> @@ -4709,7 +4709,7 @@ int
>  rte_eth_read_clock(uint16_t port_id, uint64_t *clock);
> 
>  /**
> -* Get the port id from device name. The device name should be specified
> +* Get the port ID from device name. The device name should be specified
>  * as below:
>  * - PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0
>  * - SoC device name, for example- fsl-gmac0
> @@ -4727,7 +4727,7 @@ int
>  rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
> 
>  /**
> -* Get the device name from port id. The device name is specified as below:
> +* Get the device name from port ID. The device name is specified as below:
>  * - PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0
>  * - SoC device name, for example- fsl-gmac0
>  * - vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0]
> @@ -5105,7 +5105,7 @@ rte_eth_rx_burst(uint16_t port_id, uint16_t queue_id,
>   * @param port_id
>   *  The port identifier of the Ethernet device.
>   * @param queue_id
> - *  The queue id on the specific port.
> + *  The queue ID on the specific port.
>   * @return
>   *  The number of used descriptors in the specific queue, or:
>   *   - (-ENODEV) if *port_id* is invalid.
> @@ -5455,7 +5455,7 @@ rte_eth_tx_burst(uint16_t port_id, uint16_t queue_id,
>   *
>   * @param port_id
>   *   The port identifier of the Ethernet device.
> - *   The value must be a valid port id.
> + *   The value must be a valid port ID.
>   * @param queue_id
>   *   The index of the transmit queue through which output packets must be
>   *   sent.
> diff --git a/lib/ethdev/rte_flow.h b/lib/ethdev/rte_flow.h
> index e3c2277582..9546453762 100644
> --- a/lib/ethdev/rte_flow.h
> +++ b/lib/ethdev/rte_flow.h
> @@ -2624,12 +2624,12 @@ struct rte_flow_query_age {
>   * Adds a counter action to a matched flow.
>   *
>   * If more than one count action is specified in a single flow rule, then each
> - * action must specify a unique id.
> + * action must specify a unique ID.
>   *
>   * Counters can be retrieved and reset through ``rte_flow_query()``, see
>   * ``struct rte_flow_query_count``.
>   *
> - * For ports within the same switch domain then the counter id namespace extends
> + * For ports within the same switch domain then the counter ID namespace extends
>   * to all ports within that switch domain.
>   */
>  struct rte_flow_action_count {
> --
> 2.30.2

Acked-by: Ori Kam <orika@nvidia.com>
Best,
Ori

[dpdk-dev] [PATCH v3 07/10] ethdev: fix EEPROM spelling

[Andrew Rybchenko]

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 20 ++++++++++----------
 lib/ethdev/rte_dev_info.h  | 14 +++++++-------
 2 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 6b01ea829d..1dcd0392cc 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -625,22 +625,22 @@ typedef int (*eth_read_clock)(struct rte_eth_dev *dev,
 typedef int (*eth_get_reg_t)(struct rte_eth_dev *dev,
 				struct rte_dev_reg_info *info);
 
-/** @internal Retrieve eeprom size. */
+/** @internal Retrieve EEPROM size. */
 typedef int (*eth_get_eeprom_length_t)(struct rte_eth_dev *dev);
 
-/** @internal Retrieve eeprom data. */
+/** @internal Retrieve EEPROM data. */
 typedef int (*eth_get_eeprom_t)(struct rte_eth_dev *dev,
 				struct rte_dev_eeprom_info *info);
 
-/** @internal Program eeprom data. */
+/** @internal Program EEPROM data. */
 typedef int (*eth_set_eeprom_t)(struct rte_eth_dev *dev,
 				struct rte_dev_eeprom_info *info);
 
-/** @internal Retrieve type and size of plugin module eeprom. */
+/** @internal Retrieve type and size of plugin module EEPROM. */
 typedef int (*eth_get_module_info_t)(struct rte_eth_dev *dev,
 				     struct rte_eth_dev_module_info *modinfo);
 
-/** @internal Retrieve plugin module eeprom data. */
+/** @internal Retrieve plugin module EEPROM data. */
 typedef int (*eth_get_module_eeprom_t)(struct rte_eth_dev *dev,
 				       struct rte_dev_eeprom_info *info);
 
@@ -1098,13 +1098,13 @@ struct eth_dev_ops {
 	reta_query_t               reta_query;
 
 	eth_get_reg_t              get_reg;           /**< Get registers. */
-	eth_get_eeprom_length_t    get_eeprom_length; /**< Get eeprom length. */
-	eth_get_eeprom_t           get_eeprom;        /**< Get eeprom data. */
-	eth_set_eeprom_t           set_eeprom;        /**< Set eeprom. */
+	eth_get_eeprom_length_t    get_eeprom_length; /**< Get EEPROM length. */
+	eth_get_eeprom_t           get_eeprom;        /**< Get EEPROM data. */
+	eth_set_eeprom_t           set_eeprom;        /**< Set EEPROM. */
 
-	/** Get plugin module eeprom attribute */
+	/** Get plugin module EEPROM attribute */
 	eth_get_module_info_t      get_module_info;
-	/** Get plugin module eeprom data */
+	/** Get plugin module EEPROM data */
 	eth_get_module_eeprom_t    get_module_eeprom;
 
 	eth_flow_ops_get_t         flow_ops_get; /**< Get flow operations. */
diff --git a/lib/ethdev/rte_dev_info.h b/lib/ethdev/rte_dev_info.h
index 7a6b61fdb7..cb2fe0ae97 100644
--- a/lib/ethdev/rte_dev_info.h
+++ b/lib/ethdev/rte_dev_info.h
@@ -19,21 +19,21 @@ struct rte_dev_reg_info {
 };
 
 /*
- * Placeholder for accessing device eeprom
+ * Placeholder for accessing device EEPROM
  */
 struct rte_dev_eeprom_info {
-	void *data; /**< Buffer for return eeprom */
-	uint32_t offset; /**< Start eeprom address for access*/
-	uint32_t length; /**< Length of eeprom region to access */
+	void *data; /**< Buffer for return EEPROM */
+	uint32_t offset; /**< Start EEPROM address for access*/
+	uint32_t length; /**< Length of EEPROM region to access */
 	uint32_t magic; /**< Device-specific key, such as device-id */
 };
 
 /**
- * Placeholder for accessing plugin module eeprom
+ * Placeholder for accessing plugin module EEPROM
  */
 struct rte_eth_dev_module_info {
-	uint32_t type; /**< Type of plugin module eeprom */
-	uint32_t eeprom_len; /**< Length of plugin module eeprom */
+	uint32_t type; /**< Type of plugin module EEPROM */
+	uint32_t eeprom_len; /**< Length of plugin module EEPROM */
 };
 
 /* EEPROM Standards for plug in modules */
-- 
2.30.2

[dpdk-dev] [PATCH v3 08/10] ethdev: remove reserved fields from internal structures

[Andrew Rybchenko]

Fixes: 8ea354d92f80 ("ethdev: hide eth dev related structures")

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 1dcd0392cc..3e8d2e783c 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -75,9 +75,6 @@ struct rte_eth_dev {
 	struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 	enum rte_eth_dev_state state; /**< Flag indicating the port state */
 	void *security_ctx; /**< Context for security ops */
-
-	uint64_t reserved_64s[4]; /**< Reserved for future fields */
-	void *reserved_ptrs[4];   /**< Reserved for future fields */
 } __rte_cache_aligned;
 
 struct rte_eth_dev_sriov;
@@ -158,8 +155,6 @@ struct rte_eth_dev_data {
 	uint16_t backer_port_id;
 
 	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
-	uint64_t reserved_64s[4]; /**< Reserved for future fields */
-	void *reserved_ptrs[4];   /**< Reserved for future fields */
 } __rte_cache_aligned;
 
 /**
-- 
2.30.2

[dpdk-dev] [PATCH v3 09/10] ethdev: make device and data structures readable

[Andrew Rybchenko]

Add empty lines to separate fields commented using different styles.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index 3e8d2e783c..f6f2490668 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -44,6 +44,7 @@ struct rte_eth_rxtx_callback {
 struct rte_eth_dev {
 	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
 	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
+
 	/** Pointer to PMD transmit prepare function */
 	eth_tx_prep_t tx_pkt_prepare;
 	/** Get the number of used Rx descriptors */
@@ -61,6 +62,7 @@ struct rte_eth_dev {
 	const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
 	struct rte_device *device; /**< Backing device */
 	struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
+
 	/** User application callbacks for NIC interrupts */
 	struct rte_eth_dev_cb_list link_intr_cbs;
 	/**
@@ -73,6 +75,7 @@ struct rte_eth_dev {
 	 * received packets before passing them to the driver for transmission.
 	 */
 	struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
+
 	enum rte_eth_dev_state state; /**< Flag indicating the port state */
 	void *security_ctx; /**< Context for security ops */
 } __rte_cache_aligned;
@@ -102,10 +105,12 @@ struct rte_eth_dev_data {
 	struct rte_eth_link dev_link;   /**< Link-level information & status. */
 	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
 	uint16_t mtu;                   /**< Maximum Transmission Unit. */
+
 	/** Common Rx buffer size handled by all queues */
 	uint32_t min_rx_buf_size;
 
 	uint64_t rx_mbuf_alloc_failed; /**< Rx ring mbuf allocation failures */
+
 	/** Device Ethernet link address. @see rte_eth_dev_release_port() */
 	struct rte_ether_addr *mac_addrs;
 	/** Bitmap associating MAC addresses to pools */
@@ -115,6 +120,7 @@ struct rte_eth_dev_data {
 	 * @see rte_eth_dev_release_port()
 	 */
 	struct rte_ether_addr *hash_mac_addrs;
+
 	uint16_t port_id;           /**< Device [external] port identifier. */
 
 	__extension__
@@ -133,15 +139,20 @@ struct rte_eth_dev_data {
 		 * CONFIGURED(1) / NOT CONFIGURED(0)
 		 */
 		dev_configured : 1;
+
 	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
 	uint8_t rx_queue_state[RTE_MAX_QUEUES_PER_PORT];
 	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
 	uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
+
 	uint32_t dev_flags;             /**< Capabilities. */
 	int numa_node;                  /**< NUMA node connection. */
+
 	/** VLAN filter configuration */
 	struct rte_vlan_filter_conf vlan_filter_conf;
+
 	struct rte_eth_dev_owner owner; /**< The port owner. */
+
 	/**
 	 * Switch-specific identifier.
 	 * Valid if RTE_ETH_DEV_REPRESENTOR in dev_flags.
-- 
2.30.2

[dpdk-dev] [PATCH v3 10/10] ethdev: remove full stop after short comments and

[Andrew Rybchenko]

Full stop at the end of short comment just make line longer. It
should be either everywhere or nowhere to be consistent.

Signed-off-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
---
 lib/ethdev/ethdev_driver.h | 130 ++++++++++++++++++-------------------
 1 file changed, 65 insertions(+), 65 deletions(-)

diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index f6f2490668..b530ac6e32 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -42,8 +42,8 @@ struct rte_eth_rxtx_callback {
  * process, while the actual configuration data for the device is shared.
  */
 struct rte_eth_dev {
-	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function. */
-	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function. */
+	eth_rx_burst_t rx_pkt_burst; /**< Pointer to PMD receive function */
+	eth_tx_burst_t tx_pkt_burst; /**< Pointer to PMD transmit function */
 
 	/** Pointer to PMD transmit prepare function */
 	eth_tx_prep_t tx_pkt_prepare;
@@ -58,7 +58,7 @@ struct rte_eth_dev {
 	 * Device data that is shared between primary and secondary processes
 	 */
 	struct rte_eth_dev_data *data;
-	void *process_private; /**< Pointer to per-process device data. */
+	void *process_private; /**< Pointer to per-process device data */
 	const struct eth_dev_ops *dev_ops; /**< Functions exported by PMD */
 	struct rte_device *device; /**< Backing device */
 	struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
@@ -72,7 +72,7 @@ struct rte_eth_dev {
 	struct rte_eth_rxtx_callback *post_rx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 	/**
 	 * User-supplied functions called from tx_burst to pre-process
-	 * received packets before passing them to the driver for transmission.
+	 * received packets before passing them to the driver for transmission
 	 */
 	struct rte_eth_rxtx_callback *pre_tx_burst_cbs[RTE_MAX_QUEUES_PER_PORT];
 
@@ -92,19 +92,19 @@ struct rte_eth_dev_owner;
 struct rte_eth_dev_data {
 	char name[RTE_ETH_NAME_MAX_LEN]; /**< Unique identifier name */
 
-	void **rx_queues; /**< Array of pointers to Rx queues. */
-	void **tx_queues; /**< Array of pointers to Tx queues. */
-	uint16_t nb_rx_queues; /**< Number of Rx queues. */
-	uint16_t nb_tx_queues; /**< Number of Tx queues. */
+	void **rx_queues; /**< Array of pointers to Rx queues */
+	void **tx_queues; /**< Array of pointers to Tx queues */
+	uint16_t nb_rx_queues; /**< Number of Rx queues */
+	uint16_t nb_tx_queues; /**< Number of Tx queues */
 
 	struct rte_eth_dev_sriov sriov;    /**< SRIOV data */
 
 	/** PMD-specific private data. @see rte_eth_dev_release_port() */
 	void *dev_private;
 
-	struct rte_eth_link dev_link;   /**< Link-level information & status. */
-	struct rte_eth_conf dev_conf;   /**< Configuration applied to device. */
-	uint16_t mtu;                   /**< Maximum Transmission Unit. */
+	struct rte_eth_link dev_link;   /**< Link-level information & status */
+	struct rte_eth_conf dev_conf;   /**< Configuration applied to device */
+	uint16_t mtu;                   /**< Maximum Transmission Unit */
 
 	/** Common Rx buffer size handled by all queues */
 	uint32_t min_rx_buf_size;
@@ -121,7 +121,7 @@ struct rte_eth_dev_data {
 	 */
 	struct rte_ether_addr *hash_mac_addrs;
 
-	uint16_t port_id;           /**< Device [external] port identifier. */
+	uint16_t port_id;           /**< Device [external] port identifier */
 
 	__extension__
 	uint8_t /** Rx promiscuous mode ON(1) / OFF(0) */
@@ -145,13 +145,13 @@ struct rte_eth_dev_data {
 	/** Queues state: HAIRPIN(2) / STARTED(1) / STOPPED(0) */
 	uint8_t tx_queue_state[RTE_MAX_QUEUES_PER_PORT];
 
-	uint32_t dev_flags;             /**< Capabilities. */
-	int numa_node;                  /**< NUMA node connection. */
+	uint32_t dev_flags;             /**< Capabilities */
+	int numa_node;                  /**< NUMA node connection */
 
 	/** VLAN filter configuration */
 	struct rte_vlan_filter_conf vlan_filter_conf;
 
-	struct rte_eth_dev_owner owner; /**< The port owner. */
+	struct rte_eth_dev_owner owner; /**< The port owner */
 
 	/**
 	 * Switch-specific identifier.
@@ -165,7 +165,7 @@ struct rte_eth_dev_data {
 	 */
 	uint16_t backer_port_id;
 
-	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex. */
+	pthread_mutex_t flow_ops_mutex; /**< rte_flow ops mutex */
 } __rte_cache_aligned;
 
 /**
@@ -994,27 +994,27 @@ typedef int (*eth_rx_metadata_negotiate_t)(struct rte_eth_dev *dev,
  * @internal A structure containing the functions exported by an Ethernet driver.
  */
 struct eth_dev_ops {
-	eth_dev_configure_t        dev_configure; /**< Configure device. */
-	eth_dev_start_t            dev_start;     /**< Start device. */
-	eth_dev_stop_t             dev_stop;      /**< Stop device. */
-	eth_dev_set_link_up_t      dev_set_link_up;   /**< Device link up. */
-	eth_dev_set_link_down_t    dev_set_link_down; /**< Device link down. */
-	eth_dev_close_t            dev_close;     /**< Close device. */
-	eth_dev_reset_t		   dev_reset;	  /**< Reset device. */
-	eth_link_update_t          link_update;   /**< Get device link state. */
+	eth_dev_configure_t        dev_configure; /**< Configure device */
+	eth_dev_start_t            dev_start;     /**< Start device */
+	eth_dev_stop_t             dev_stop;      /**< Stop device */
+	eth_dev_set_link_up_t      dev_set_link_up;   /**< Device link up */
+	eth_dev_set_link_down_t    dev_set_link_down; /**< Device link down */
+	eth_dev_close_t            dev_close;     /**< Close device */
+	eth_dev_reset_t		   dev_reset;	  /**< Reset device */
+	eth_link_update_t          link_update;   /**< Get device link state */
 	/** Check if the device was physically removed */
 	eth_is_removed_t           is_removed;
 
-	eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON. */
-	eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF. */
-	eth_allmulticast_enable_t  allmulticast_enable;/**< Rx multicast ON. */
-	eth_allmulticast_disable_t allmulticast_disable;/**< Rx multicast OFF. */
-	eth_mac_addr_remove_t      mac_addr_remove; /**< Remove MAC address. */
-	eth_mac_addr_add_t         mac_addr_add;  /**< Add a MAC address. */
-	eth_mac_addr_set_t         mac_addr_set;  /**< Set a MAC address. */
+	eth_promiscuous_enable_t   promiscuous_enable; /**< Promiscuous ON */
+	eth_promiscuous_disable_t  promiscuous_disable;/**< Promiscuous OFF */
+	eth_allmulticast_enable_t  allmulticast_enable;/**< Rx multicast ON */
+	eth_allmulticast_disable_t allmulticast_disable;/**< Rx multicast OFF */
+	eth_mac_addr_remove_t      mac_addr_remove; /**< Remove MAC address */
+	eth_mac_addr_add_t         mac_addr_add;  /**< Add a MAC address */
+	eth_mac_addr_set_t         mac_addr_set;  /**< Set a MAC address */
 	/** Set list of multicast addresses */
 	eth_set_mc_addr_list_t     set_mc_addr_list;
-	mtu_set_t                  mtu_set;       /**< Set MTU. */
+	mtu_set_t                  mtu_set;       /**< Set MTU */
 
 	/** Get generic device statistics */
 	eth_stats_get_t            stats_get;
@@ -1029,14 +1029,14 @@ struct eth_dev_ops {
 	/** Configure per queue stat counter mapping */
 	eth_queue_stats_mapping_set_t queue_stats_mapping_set;
 
-	eth_dev_infos_get_t        dev_infos_get; /**< Get device info. */
+	eth_dev_infos_get_t        dev_infos_get; /**< Get device info */
 	/** Retrieve Rx queue information */
 	eth_rxq_info_get_t         rxq_info_get;
 	/** Retrieve Tx queue information */
 	eth_txq_info_get_t         txq_info_get;
 	eth_burst_mode_get_t       rx_burst_mode_get; /**< Get Rx burst mode */
 	eth_burst_mode_get_t       tx_burst_mode_get; /**< Get Tx burst mode */
-	eth_fw_version_get_t       fw_version_get; /**< Get firmware version. */
+	eth_fw_version_get_t       fw_version_get; /**< Get firmware version */
 
 	/** Get packet types supported and identified by device */
 	eth_dev_supported_ptypes_get_t dev_supported_ptypes_get;
@@ -1057,12 +1057,12 @@ struct eth_dev_ops {
 	/** Set port based Tx VLAN insertion */
 	vlan_pvid_set_t            vlan_pvid_set;
 
-	eth_queue_start_t          rx_queue_start;/**< Start Rx for a queue. */
-	eth_queue_stop_t           rx_queue_stop; /**< Stop Rx for a queue. */
-	eth_queue_start_t          tx_queue_start;/**< Start Tx for a queue. */
-	eth_queue_stop_t           tx_queue_stop; /**< Stop Tx for a queue. */
-	eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device Rx queue. */
-	eth_queue_release_t        rx_queue_release; /**< Release Rx queue. */
+	eth_queue_start_t          rx_queue_start;/**< Start Rx for a queue */
+	eth_queue_stop_t           rx_queue_stop; /**< Stop Rx for a queue */
+	eth_queue_start_t          tx_queue_start;/**< Start Tx for a queue */
+	eth_queue_stop_t           tx_queue_stop; /**< Stop Tx for a queue */
+	eth_rx_queue_setup_t       rx_queue_setup;/**< Set up device Rx queue */
+	eth_queue_release_t        rx_queue_release; /**< Release Rx queue */
 
 	/** Enable Rx queue interrupt */
 	eth_rx_enable_intr_t       rx_queue_intr_enable;
@@ -1073,11 +1073,11 @@ struct eth_dev_ops {
 	eth_queue_release_t        tx_queue_release; /**< Release Tx queue */
 	eth_tx_done_cleanup_t      tx_done_cleanup;/**< Free Tx ring mbufs */
 
-	eth_dev_led_on_t           dev_led_on;    /**< Turn on LED. */
-	eth_dev_led_off_t          dev_led_off;   /**< Turn off LED. */
+	eth_dev_led_on_t           dev_led_on;    /**< Turn on LED */
+	eth_dev_led_off_t          dev_led_off;   /**< Turn off LED */
 
-	flow_ctrl_get_t            flow_ctrl_get; /**< Get flow control. */
-	flow_ctrl_set_t            flow_ctrl_set; /**< Setup flow control. */
+	flow_ctrl_get_t            flow_ctrl_get; /**< Get flow control */
+	flow_ctrl_set_t            flow_ctrl_set; /**< Setup flow control */
 	/** Setup priority flow control */
 	priority_flow_ctrl_set_t   priority_flow_ctrl_set;
 
@@ -1103,17 +1103,17 @@ struct eth_dev_ops {
 	/** Query redirection table */
 	reta_query_t               reta_query;
 
-	eth_get_reg_t              get_reg;           /**< Get registers. */
-	eth_get_eeprom_length_t    get_eeprom_length; /**< Get EEPROM length. */
-	eth_get_eeprom_t           get_eeprom;        /**< Get EEPROM data. */
-	eth_set_eeprom_t           set_eeprom;        /**< Set EEPROM. */
+	eth_get_reg_t              get_reg;           /**< Get registers */
+	eth_get_eeprom_length_t    get_eeprom_length; /**< Get EEPROM length */
+	eth_get_eeprom_t           get_eeprom;        /**< Get EEPROM data */
+	eth_set_eeprom_t           set_eeprom;        /**< Set EEPROM */
 
 	/** Get plugin module EEPROM attribute */
 	eth_get_module_info_t      get_module_info;
 	/** Get plugin module EEPROM data */
 	eth_get_module_eeprom_t    get_module_eeprom;
 
-	eth_flow_ops_get_t         flow_ops_get; /**< Get flow operations. */
+	eth_flow_ops_get_t         flow_ops_get; /**< Get flow operations */
 
 	eth_get_dcb_info           get_dcb_info; /**< Get DCB information */
 
@@ -1183,7 +1183,7 @@ struct eth_dev_ops {
 
 	/**
 	 * Negotiate the NIC's ability to deliver specific
-	 * kinds of metadata to the PMD.
+	 * kinds of metadata to the PMD
 	 */
 	eth_rx_metadata_negotiate_t rx_metadata_negotiate;
 };
@@ -1681,10 +1681,10 @@ enum rte_filter_type {
  * to support RTE_ETH_FILTER_ETHERTYPE data representation.
  */
 struct rte_eth_ethertype_filter {
-	struct rte_ether_addr mac_addr;   /**< Mac address to match. */
+	struct rte_ether_addr mac_addr;   /**< Mac address to match */
 	uint16_t ether_type;          /**< Ether type to match */
 	uint16_t flags;               /**< Flags from RTE_ETHTYPE_FLAGS_* */
-	uint16_t queue;               /**< Queue assigned to when match*/
+	uint16_t queue;               /**< Queue assigned to when match */
 };
 
 /**
@@ -1692,7 +1692,7 @@ struct rte_eth_ethertype_filter {
  * to support RTE_ETH_FILTER_SYN data representation.
  */
 struct rte_eth_syn_filter {
-	/** 1 - higher priority than other filters, 0 - lower priority. */
+	/** 1 - higher priority than other filters, 0 - lower priority */
 	uint8_t hig_pri;
 	uint16_t queue;      /**< Queue assigned to when match */
 };
@@ -1722,32 +1722,32 @@ struct rte_eth_syn_filter {
  *  Select IPv4 or IPv6 for tunnel filters.
  */
 enum rte_tunnel_iptype {
-	RTE_TUNNEL_IPTYPE_IPV4 = 0, /**< IPv4. */
-	RTE_TUNNEL_IPTYPE_IPV6,     /**< IPv6. */
+	RTE_TUNNEL_IPTYPE_IPV4 = 0, /**< IPv4 */
+	RTE_TUNNEL_IPTYPE_IPV6,     /**< IPv6 */
 };
 
 /**
  * Tunneling Packet filter configuration.
  */
 struct rte_eth_tunnel_filter_conf {
-	struct rte_ether_addr outer_mac;    /**< Outer MAC address to match. */
-	struct rte_ether_addr inner_mac;    /**< Inner MAC address to match. */
-	uint16_t inner_vlan;            /**< Inner VLAN to match. */
-	enum rte_tunnel_iptype ip_type; /**< IP address type. */
+	struct rte_ether_addr outer_mac;    /**< Outer MAC address to match */
+	struct rte_ether_addr inner_mac;    /**< Inner MAC address to match */
+	uint16_t inner_vlan;                /**< Inner VLAN to match */
+	enum rte_tunnel_iptype ip_type;     /**< IP address type */
 	/**
 	 * Outer destination IP address to match if ETH_TUNNEL_FILTER_OIP
 	 * is set in filter_type, or inner destination IP address to match
 	 * if ETH_TUNNEL_FILTER_IIP is set in filter_type.
 	 */
 	union {
-		uint32_t ipv4_addr;     /**< IPv4 address in big endian. */
-		uint32_t ipv6_addr[4];  /**< IPv6 address in big endian. */
+		uint32_t ipv4_addr;         /**< IPv4 address in big endian */
+		uint32_t ipv6_addr[4];      /**< IPv6 address in big endian */
 	} ip_addr;
-	/** Flags from ETH_TUNNEL_FILTER_XX - see above. */
+	/** Flags from ETH_TUNNEL_FILTER_XX - see above */
 	uint16_t filter_type;
-	enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type. */
-	uint32_t tenant_id;     /**< Tenant ID to match. VNI, GRE key... */
-	uint16_t queue_id;      /**< Queue assigned to if match. */
+	enum rte_eth_tunnel_type tunnel_type; /**< Tunnel Type */
+	uint32_t tenant_id;     /**< Tenant ID to match: VNI, GRE key... */
+	uint16_t queue_id;      /**< Queue assigned to if match */
 };
 
 #endif /* _RTE_ETHDEV_DRIVER_H_ */
-- 
2.30.2

Re: [dpdk-dev] [PATCH v3 00/10] ethdev: cosmetic fixes

[Ferruh Yigit]

On 10/20/2021 1:47 PM, Andrew Rybchenko wrote:
> Sicne rte_eth_dev and rte_eth_dev_data structures are just moved
> right now is a good chance to make a cleanup. Moreover ethdev is
> or will be shuffled a lot in the release, so do cleanup in all
> files.
> 
> Maybe at least some fixes from below could be accepted.
> 
> Spelling is fixed in log messages as well. Hopefully it isn ot a
> problem, but let me know if I'm wrong and I'll avoid it in the
> next version.
> 
> Since changes are cosmetic no Fixes tags and no backporting to
> stable.
> 
> v3:
>      - fix EEPROM spelling
>      - cleanup full stop in structure fields documentation in
>        entire ethdev_driver.h
>      - do more in the first patch which moves documentation to
>        avoid long lines and apply some cosmeic fixes on the way
>        when line is moved to avoid changes in next patches
> 
> Andrew Rybchenko (10):
>    ethdev: avoid documentation in next lines
>    ethdev: fix Rx/Tx spelling
>    ethdev: fix Ethernet spelling
>    ethdev: fix DCB and VMDq spelling
>    ethdev: fix VLAN spelling including VLAN ID case
>    ethdev: fix ID spelling in comments and log messages
>    ethdev: fix EEPROM spelling
>    ethdev: remove reserved fields from internal structures
>    ethdev: make device and data structures readable
>    ethdev: remove full stop after short comments and references
> 

For series,
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Series applied to dpdk-next-net/main, thanks.