doc/tm: update support for pf only

Message ID 20181015070451.35332-1-vipin.varghese@intel.com (mailing list archive)
State Rejected, archived
Delegated to: Cristian Dumitrescu
Headers
Series doc/tm: update support for pf only |

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Varghese, Vipin Oct. 15, 2018, 7:04 a.m. UTC
  Documentation is updated to highlight the support for DPDK ethernet
interface for Traffic Manager is currently limited to PF only.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---
 doc/guides/prog_guide/traffic_management.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
  

Comments

Jerin Jacob Oct. 15, 2018, 3:34 p.m. UTC | #1
-----Original Message-----
> Date: Mon, 15 Oct 2018 12:34:51 +0530
> From: Vipin Varghese <vipin.varghese@intel.com>
> To: dev@dpdk.org, cristian.dumitrescu@intel.com
> CC: stephen1.byrne@intel.com, john.mcnamara@intel.com,
>  declan.doherty@intel.com, Vipin Varghese <vipin.varghese@intel.com>
> Subject: [dpdk-dev] [PATCH] doc/tm: update support for pf only
> X-Mailer: git-send-email 2.17.1
> 
> 
> Documentation is updated to highlight the support for DPDK ethernet
> interface for Traffic Manager is currently limited to PF only.

Why limit the specification to only PF devices? If a specific HW can
support only PF devices, it can register tm ops only to PF devices.
There are Hardwars which can support TM on VF as well, off course HW
capabilities may be different, It can expressed with exiting TM capabilities
structures.
  
Cristian Dumitrescu Oct. 15, 2018, 3:52 p.m. UTC | #2
> -----Original Message-----
> From: Jerin Jacob [mailto:jerin.jacob@caviumnetworks.com]
> Sent: Monday, October 15, 2018 4:35 PM
> To: Varghese, Vipin <vipin.varghese@intel.com>
> Cc: dev@dpdk.org; Dumitrescu, Cristian <cristian.dumitrescu@intel.com>;
> Byrne, Stephen1 <stephen1.byrne@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Doherty, Declan <declan.doherty@intel.com>
> Subject: Re: [dpdk-dev] [PATCH] doc/tm: update support for pf only
> 
> -----Original Message-----
> > Date: Mon, 15 Oct 2018 12:34:51 +0530
> > From: Vipin Varghese <vipin.varghese@intel.com>
> > To: dev@dpdk.org, cristian.dumitrescu@intel.com
> > CC: stephen1.byrne@intel.com, john.mcnamara@intel.com,
> >  declan.doherty@intel.com, Vipin Varghese <vipin.varghese@intel.com>
> > Subject: [dpdk-dev] [PATCH] doc/tm: update support for pf only
> > X-Mailer: git-send-email 2.17.1
> >
> >
> > Documentation is updated to highlight the support for DPDK ethernet
> > interface for Traffic Manager is currently limited to PF only.
> 
> Why limit the specification to only PF devices? If a specific HW can
> support only PF devices, it can register tm ops only to PF devices.
> There are Hardwars which can support TM on VF as well, off course HW
> capabilities may be different, It can expressed with exiting TM capabilities
> structures.

NAK, Agree with Jerin.

The API is agnostic of the nature of ethdev port. The API is the same, whether it is called for a PF port or for a VF port.
  
Cristian Dumitrescu Oct. 15, 2018, 3:52 p.m. UTC | #3
> -----Original Message-----
> From: Varghese, Vipin
> Sent: Monday, October 15, 2018 8:05 AM
> To: dev@dpdk.org; Dumitrescu, Cristian <cristian.dumitrescu@intel.com>
> Cc: Byrne, Stephen1 <stephen1.byrne@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Doherty, Declan
> <declan.doherty@intel.com>; Varghese, Vipin <vipin.varghese@intel.com>
> Subject: [PATCH] doc/tm: update support for pf only
> 
> Documentation is updated to highlight the support for DPDK ethernet
> interface for Traffic Manager is currently limited to PF only.
> 
> Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> ---
>  doc/guides/prog_guide/traffic_management.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/prog_guide/traffic_management.rst
> b/doc/guides/prog_guide/traffic_management.rst
> index 98ac4310b..e6304d372 100644
> --- a/doc/guides/prog_guide/traffic_management.rst
> +++ b/doc/guides/prog_guide/traffic_management.rst
> @@ -16,7 +16,8 @@ is agnostic of the underlying HW, SW or mixed HW-SW
> implementation.
>  Main features:
> 
>  * Part of DPDK rte_ethdev API
> -* Capability query API per port, per hierarchy level and per hierarchy node
> +* Capability query API per port, per hierarchy level and per hierarchy node
> on
> +  PF ethernet devices
>  * Scheduling algorithms: Strict Priority (SP), Weighed Fair Queuing (WFQ)
>  * Traffic shaping: single/dual rate, private (per node) and
>    shared (by multiple nodes) shapers
> @@ -221,3 +222,4 @@ thus operations such as node add/delete, node
> suspend/resume, parent node
>  update, etc., can be invoked after the Ethernet port has been started,
> subject
>  to the specific implementation supporting them. The set of dynamic updates
>  supported by the implementation is advertised through the port capability
> set.
> +TM features are currently supported for PF Ethernet devices.
> --
> 2.17.1

NAK.

The API is agnostic of the nature of ethdev port. The API is the same, whether it is called for a PF port or for a VF port.
  

Patch

diff --git a/doc/guides/prog_guide/traffic_management.rst b/doc/guides/prog_guide/traffic_management.rst
index 98ac4310b..e6304d372 100644
--- a/doc/guides/prog_guide/traffic_management.rst
+++ b/doc/guides/prog_guide/traffic_management.rst
@@ -16,7 +16,8 @@  is agnostic of the underlying HW, SW or mixed HW-SW implementation.
 Main features:
 
 * Part of DPDK rte_ethdev API
-* Capability query API per port, per hierarchy level and per hierarchy node
+* Capability query API per port, per hierarchy level and per hierarchy node on
+  PF ethernet devices
 * Scheduling algorithms: Strict Priority (SP), Weighed Fair Queuing (WFQ)
 * Traffic shaping: single/dual rate, private (per node) and
   shared (by multiple nodes) shapers
@@ -221,3 +222,4 @@  thus operations such as node add/delete, node suspend/resume, parent node
 update, etc., can be invoked after the Ethernet port has been started, subject
 to the specific implementation supporting them. The set of dynamic updates
 supported by the implementation is advertised through the port capability set.
+TM features are currently supported for PF Ethernet devices.