From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
To: Ferruh Yigit <ferruh.yigit@intel.com>,
Thomas Monjalon <thomas@monjalon.net>, Ori Kam <orika@nvidia.com>
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v2 5/9] ethdev: fix VLAN spelling including VLAN ID case
Date: Wed, 20 Oct 2021 10:42:53 +0300 [thread overview]
Message-ID: <20211020074257.2349486-6-andrew.rybchenko@oktetlabs.ru> (raw)
In-Reply-To: <20211020074257.2349486-1-andrew.rybchenko@oktetlabs.ru>
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
next prev parent reply other threads:[~2021-10-20 7:43 UTC|newest]
Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-14 8:36 [dpdk-dev] [PATCH 0/5] ethdev: cosmetic fixes for just moved structures Andrew Rybchenko
2021-10-14 8:37 ` [dpdk-dev] [PATCH 1/5] ethdev: avoid documentation in next lines Andrew Rybchenko
2021-10-14 8:37 ` [dpdk-dev] [PATCH 2/5] ethdev: fix Rx/Tx spelling in just moved structures Andrew Rybchenko
2021-10-14 8:37 ` [dpdk-dev] [PATCH 3/5] ethdev: remove reserved fields from internal structures Andrew Rybchenko
2021-10-14 8:37 ` [dpdk-dev] [PATCH 4/5] ethdev: make device and data structures readable Andrew Rybchenko
2021-10-14 8:37 ` [dpdk-dev] [PATCH 5/5] ethdev: remove full stop after short comments and references Andrew Rybchenko
2021-10-19 11:55 ` [dpdk-dev] [PATCH 0/5] ethdev: cosmetic fixes for just moved structures Ferruh Yigit
2021-10-19 18:07 ` Andrew Rybchenko
2021-10-19 22:05 ` Ferruh Yigit
2021-10-19 22:20 ` Thomas Monjalon
2021-10-20 7:43 ` Andrew Rybchenko
2021-10-20 7:42 ` [dpdk-dev] [PATCH v2 0/9] ethdev: cosmetic fixes Andrew Rybchenko
2021-10-20 7:42 ` [dpdk-dev] [PATCH v2 1/9] ethdev: avoid documentation in next lines Andrew Rybchenko
2021-10-20 8:39 ` Ori Kam
2021-10-20 7:42 ` [dpdk-dev] [PATCH v2 2/9] ethdev: fix Rx/Tx spelling Andrew Rybchenko
2021-10-20 7:42 ` [dpdk-dev] [PATCH v2 3/9] ethdev: fix Ethernet spelling Andrew Rybchenko
2021-10-20 7:42 ` [dpdk-dev] [PATCH v2 4/9] ethdev: fix DCB and VMDq spelling Andrew Rybchenko
2021-10-20 7:42 ` Andrew Rybchenko [this message]
2021-10-20 8:40 ` [dpdk-dev] [PATCH v2 5/9] ethdev: fix VLAN spelling including VLAN ID case Ori Kam
2021-10-20 7:42 ` [dpdk-dev] [PATCH v2 6/9] ethdev: fix ID spelling in comments and log messages Andrew Rybchenko
2021-10-20 7:42 ` [dpdk-dev] [PATCH v2 7/9] ethdev: remove reserved fields from internal structures Andrew Rybchenko
2021-10-20 7:42 ` [dpdk-dev] [PATCH v2 8/9] ethdev: make device and data structures readable Andrew Rybchenko
2021-10-20 7:42 ` [dpdk-dev] [PATCH v2 9/9] ethdev: remove full stop after short comments and references Andrew Rybchenko
2021-10-20 9:31 ` [dpdk-dev] [PATCH v2 0/9] ethdev: cosmetic fixes Ferruh Yigit
2021-10-20 11:55 ` Andrew Rybchenko
2021-10-20 12:47 ` [dpdk-dev] [PATCH v3 00/10] " Andrew Rybchenko
2021-10-20 12:47 ` [dpdk-dev] [PATCH v3 01/10] ethdev: avoid documentation in next lines Andrew Rybchenko
2021-10-20 13:51 ` Ori Kam
2021-10-20 12:47 ` [dpdk-dev] [PATCH v3 02/10] ethdev: fix Rx/Tx spelling Andrew Rybchenko
2021-10-20 12:47 ` [dpdk-dev] [PATCH v3 03/10] ethdev: fix Ethernet spelling Andrew Rybchenko
2021-10-20 12:47 ` [dpdk-dev] [PATCH v3 04/10] ethdev: fix DCB and VMDq spelling Andrew Rybchenko
2021-10-20 12:47 ` [dpdk-dev] [PATCH v3 05/10] ethdev: fix VLAN spelling including VLAN ID case Andrew Rybchenko
2021-10-20 13:49 ` Ori Kam
2021-10-20 12:47 ` [dpdk-dev] [PATCH v3 06/10] ethdev: fix ID spelling in comments and log messages Andrew Rybchenko
2021-10-20 13:49 ` Ori Kam
2021-10-20 12:47 ` [dpdk-dev] [PATCH v3 07/10] ethdev: fix EEPROM spelling Andrew Rybchenko
2021-10-20 12:47 ` [dpdk-dev] [PATCH v3 08/10] ethdev: remove reserved fields from internal structures Andrew Rybchenko
2021-10-20 12:47 ` [dpdk-dev] [PATCH v3 09/10] ethdev: make device and data structures readable Andrew Rybchenko
2021-10-20 12:52 ` [dpdk-dev] [PATCH v3 10/10] ethdev: remove full stop after short comments and Andrew Rybchenko
2021-10-20 20:32 ` [dpdk-dev] [PATCH v3 00/10] ethdev: cosmetic fixes Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20211020074257.2349486-6-andrew.rybchenko@oktetlabs.ru \
--to=andrew.rybchenko@oktetlabs.ru \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=orika@nvidia.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).