[v2] ethdev: remove device-specific comments from VLAN API

Message ID 20200804094808.3339810-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Headers
Series [v2] ethdev: remove device-specific comments from VLAN API |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS

Commit Message

Thomas Monjalon Aug. 4, 2020, 9:48 a.m. UTC
  Some confusing comments were still present from old days,
when most drivers were from Intel.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
v2: remove i40e comment for pvid field
---
 lib/librte_ethdev/rte_ethdev.h | 12 ++----------
 1 file changed, 2 insertions(+), 10 deletions(-)
  

Comments

David Marchand Aug. 5, 2020, 9:19 a.m. UTC | #1
On Tue, Aug 4, 2020 at 11:48 AM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> Some confusing comments were still present from old days,
> when most drivers were from Intel.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
> v2: remove i40e comment for pvid field
> ---
>  lib/librte_ethdev/rte_ethdev.h | 12 ++----------
>  1 file changed, 2 insertions(+), 10 deletions(-)
>
> diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
> index 57e4a6ca58..d29930fd84 100644
> --- a/lib/librte_ethdev/rte_ethdev.h
> +++ b/lib/librte_ethdev/rte_ethdev.h
> @@ -924,7 +924,6 @@ struct rte_eth_txmode {
>          */
>         uint64_t offloads;
>
> -       /* For i40e specifically */
>         uint16_t pvid;
>         __extension__
>         uint8_t hw_vlan_reject_tagged : 1,
> @@ -2846,7 +2845,6 @@ 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.
> - * 82599/X540/X550 can support VLAN stripping at the rx queue level
>   *
>   * @param port_id
>   *   The port identifier of the Ethernet device.
> @@ -2868,8 +2866,7 @@ int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
>
>  /**
>   * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
> - * the VLAN Header. This is a register setup available on some Intel NIC, not
> - * but all, please check the data sheet for availability.
> + * the VLAN header.
>   *
>   * @param port_id
>   *   The port identifier of the Ethernet device.
> @@ -2888,12 +2885,7 @@ int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
>                                     uint16_t tag_type);
>
>  /**
> - * Set VLAN offload configuration on an Ethernet device
> - * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
> - * available on some Intel NIC, not but all, please check the data sheet for
> - * availability.
> - * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
> - * the configuration is applied on the port level.
> + * Set VLAN offload configuration on an Ethernet device.
>   *
>   * @param port_id
>   *   The port identifier of the Ethernet device.

Reviewed-by: David Marchand <david.marchand@redhat.com>
  
Andrew Rybchenko Aug. 5, 2020, 11:27 a.m. UTC | #2
On 8/4/20 12:48 PM, Thomas Monjalon wrote:
> Some confusing comments were still present from old days,
> when most drivers were from Intel.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
  
Ferruh Yigit Aug. 5, 2020, 4:57 p.m. UTC | #3
On 8/5/2020 12:27 PM, Andrew Rybchenko wrote:
> On 8/4/20 12:48 PM, Thomas Monjalon wrote:
>> Some confusing comments were still present from old days,
>> when most drivers were from Intel.
>>
>> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
> 

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Thomas Monjalon Aug. 5, 2020, 6:02 p.m. UTC | #4
05/08/2020 18:57, Ferruh Yigit:
> On 8/5/2020 12:27 PM, Andrew Rybchenko wrote:
> > On 8/4/20 12:48 PM, Thomas Monjalon wrote:
> >> Some confusing comments were still present from old days,
> >> when most drivers were from Intel.
> >>
> >> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied
  

Patch

diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index 57e4a6ca58..d29930fd84 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -924,7 +924,6 @@  struct rte_eth_txmode {
 	 */
 	uint64_t offloads;
 
-	/* For i40e specifically */
 	uint16_t pvid;
 	__extension__
 	uint8_t hw_vlan_reject_tagged : 1,
@@ -2846,7 +2845,6 @@  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.
- * 82599/X540/X550 can support VLAN stripping at the rx queue level
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -2868,8 +2866,7 @@  int rte_eth_dev_set_vlan_strip_on_queue(uint16_t port_id, uint16_t rx_queue_id,
 
 /**
  * Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to
- * the VLAN Header. This is a register setup available on some Intel NIC, not
- * but all, please check the data sheet for availability.
+ * the VLAN header.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.
@@ -2888,12 +2885,7 @@  int rte_eth_dev_set_vlan_ether_type(uint16_t port_id,
 				    uint16_t tag_type);
 
 /**
- * Set VLAN offload configuration on an Ethernet device
- * Enable/Disable Extended VLAN by an Ethernet device, This is a register setup
- * available on some Intel NIC, not but all, please check the data sheet for
- * availability.
- * Enable/Disable VLAN Strip can be done on rx queue for certain NIC, but here
- * the configuration is applied on the port level.
+ * Set VLAN offload configuration on an Ethernet device.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.