diff mbox series

doc: add supported APIs section to nfp guide

Message ID 20221201013848.19843-1-chaoyong.he@corigine.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series doc: add supported APIs section to nfp guide |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-broadcom-Performance fail Performance Testing issues
ci/iol-mellanox-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-abi-testing warning Testing issues
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS

Commit Message

Chaoyong He Dec. 1, 2022, 1:38 a.m. UTC 
  Add a new section 'Supported APIs', inculding the supported
APIs/items/actions of rte_flow.

Signed-off-by: Chaoyong He <chaoyong.he@corigine.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@corigine.com>
---
 doc/guides/nics/nfp.rst | 71 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)

Comments

Ferruh Yigit Jan. 19, 2023, 9:18 a.m. UTC | #1 
On 12/1/2022 1:38 AM, Chaoyong He wrote:
> Add a new section 'Supported APIs', inculding the supported
> APIs/items/actions of rte_flow.
> 

Isn't this information already exists in
'doc/guides/nics/features/nfp.ini'? Why to duplicate here?

> Signed-off-by: Chaoyong He <chaoyong.he@corigine.com>
> Reviewed-by: Niklas Söderlund <niklas.soderlund@corigine.com>
> ---
>  doc/guides/nics/nfp.rst | 71 +++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 71 insertions(+)
> 
> diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst
> index b74067c875..615f7dab9f 100644
> --- a/doc/guides/nics/nfp.rst
> +++ b/doc/guides/nics/nfp.rst
> @@ -213,3 +213,74 @@ PF vNIC.
>  The ctrl vNIC service handling various control message, like the creation and
>  configuration of representor port, the pattern and action of flow rules, the
>  statistics of flow rules, and so on.
> +
> +Supported APIs
> +--------------
> +
> +rte_flow APIs
> +~~~~~~~~~~~~~
> +
> +Listed below are the rte_flow functions supported:
> +* ``rte_flow_ops_get``
> +* ``rte_flow_validate``
> +* ``rte_flow_create``
> +* ``rte_flow_destroy``
> +* ``rte_flow_flush``
> +* ``nfp_flow_query``
> +* ``rte_flow_tunnel_action_decap_release``
> +* ``rte_flow_tunnel_decap_set``
> +* ``rte_flow_tunnel_item_release``
> +* ``rte_flow_tunnel_match``
> +
> +rte_flow Items
> +~~~~~~~~~~~~~~
> +
> +Refer to "Table 1.2 rte_flow items availability in networking drivers" in
> +`Overview of Networking Drivers <https://doc.dpdk.org/guides/nics/overview.html>`.
> +
> +Listed below are the rte_flow items supported:
> +
> +* ``eth``
> +* ``geneve``
> +* ``gre``
> +* ``gre_key``
> +* ``ipv4``
> +* ``ipv6``
> +* ``port_id``
> +* ``sctp``
> +* ``tcp``
> +* ``udp``
> +* ``vlan``
> +* ``vxlan``
> +
> +rte_flow Actions
> +~~~~~~~~~~~~~~~~
> +
> +Refer to "Table 1.3 rte_flow actions availability in networking drivers" in
> +`Overview of Networking Drivers <https://doc.dpdk.org/guides/nics/overview.html>`.
> +
> +Listed below are the rte_flow actions supported:
> +
> +* ``count``
> +* ``drop``
> +* ``jump``
> +* ``of_pop_vlan``
> +* ``of_push_vlan``
> +* ``of_set_vlan_pcp``
> +* ``of_set_vlan_vid``
> +* ``raw_decap``
> +* ``raw_encap``
> +* ``port_id``
> +* ``set_ipv4_dscp``
> +* ``set_ipv4_dst``
> +* ``set_ipv4_src``
> +* ``set_ipv6_dscp``
> +* ``set_ipv6_dst``
> +* ``set_ipv6_src``
> +* ``set_mac_dst``
> +* ``set_mac_src``
> +* ``set_tp_dst``
> +* ``set_tp_src``
> +* ``set_ttl``
> +* ``vxlan_decap``
> +* ``vxlan_encap``
Chaoyong He Jan. 24, 2023, 2:44 a.m. UTC | #2 
> On 12/1/2022 1:38 AM, Chaoyong He wrote:
> > Add a new section 'Supported APIs', inculding the supported
> > APIs/items/actions of rte_flow.
> >
> 
> Isn't this information already exists in 'doc/guides/nics/features/nfp.ini'? Why to
> duplicate here?
> 

Oh, one customer say they wants this section like the `bnxt.rst`, so we added this.

> > Signed-off-by: Chaoyong He <chaoyong.he@corigine.com>
> > Reviewed-by: Niklas Söderlund <niklas.soderlund@corigine.com>
> > ---
> >  doc/guides/nics/nfp.rst | 71
> > +++++++++++++++++++++++++++++++++++++++++
> >  1 file changed, 71 insertions(+)
> >
> > diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index
> > b74067c875..615f7dab9f 100644
> > --- a/doc/guides/nics/nfp.rst
> > +++ b/doc/guides/nics/nfp.rst
> > @@ -213,3 +213,74 @@ PF vNIC.
> >  The ctrl vNIC service handling various control message, like the
> > creation and  configuration of representor port, the pattern and
> > action of flow rules, the  statistics of flow rules, and so on.
> > +
> > +Supported APIs
> > +--------------
> > +
> > +rte_flow APIs
> > +~~~~~~~~~~~~~
> > +
> > +Listed below are the rte_flow functions supported:
> > +* ``rte_flow_ops_get``
> > +* ``rte_flow_validate``
> > +* ``rte_flow_create``
> > +* ``rte_flow_destroy``
> > +* ``rte_flow_flush``
> > +* ``nfp_flow_query``
> > +* ``rte_flow_tunnel_action_decap_release``
> > +* ``rte_flow_tunnel_decap_set``
> > +* ``rte_flow_tunnel_item_release``
> > +* ``rte_flow_tunnel_match``
> > +
> > +rte_flow Items
> > +~~~~~~~~~~~~~~
> > +
> > +Refer to "Table 1.2 rte_flow items availability in networking
> > +drivers" in `Overview of Networking Drivers
> <https://doc.dpdk.org/guides/nics/overview.html>`.
> > +
> > +Listed below are the rte_flow items supported:
> > +
> > +* ``eth``
> > +* ``geneve``
> > +* ``gre``
> > +* ``gre_key``
> > +* ``ipv4``
> > +* ``ipv6``
> > +* ``port_id``
> > +* ``sctp``
> > +* ``tcp``
> > +* ``udp``
> > +* ``vlan``
> > +* ``vxlan``
> > +
> > +rte_flow Actions
> > +~~~~~~~~~~~~~~~~
> > +
> > +Refer to "Table 1.3 rte_flow actions availability in networking
> > +drivers" in `Overview of Networking Drivers
> <https://doc.dpdk.org/guides/nics/overview.html>`.
> > +
> > +Listed below are the rte_flow actions supported:
> > +
> > +* ``count``
> > +* ``drop``
> > +* ``jump``
> > +* ``of_pop_vlan``
> > +* ``of_push_vlan``
> > +* ``of_set_vlan_pcp``
> > +* ``of_set_vlan_vid``
> > +* ``raw_decap``
> > +* ``raw_encap``
> > +* ``port_id``
> > +* ``set_ipv4_dscp``
> > +* ``set_ipv4_dst``
> > +* ``set_ipv4_src``
> > +* ``set_ipv6_dscp``
> > +* ``set_ipv6_dst``
> > +* ``set_ipv6_src``
> > +* ``set_mac_dst``
> > +* ``set_mac_src``
> > +* ``set_tp_dst``
> > +* ``set_tp_src``
> > +* ``set_ttl``
> > +* ``vxlan_decap``
> > +* ``vxlan_encap``
Ferruh Yigit Jan. 24, 2023, 9:13 a.m. UTC | #3 
On 1/24/2023 2:44 AM, Chaoyong He wrote:
>> On 12/1/2022 1:38 AM, Chaoyong He wrote:
>>> Add a new section 'Supported APIs', inculding the supported
>>> APIs/items/actions of rte_flow.
>>>
>>
>> Isn't this information already exists in 'doc/guides/nics/features/nfp.ini'? Why to
>> duplicate here?
>>
> 
> Oh, one customer say they wants this section like the `bnxt.rst`, so we added this.
> 

You are right, and I think that is a duplication for bnxt too, cc'ed
Ajit for comment.


>>> Signed-off-by: Chaoyong He <chaoyong.he@corigine.com>
>>> Reviewed-by: Niklas Söderlund <niklas.soderlund@corigine.com>
>>> ---
>>>  doc/guides/nics/nfp.rst | 71
>>> +++++++++++++++++++++++++++++++++++++++++
>>>  1 file changed, 71 insertions(+)
>>>
>>> diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index
>>> b74067c875..615f7dab9f 100644
>>> --- a/doc/guides/nics/nfp.rst
>>> +++ b/doc/guides/nics/nfp.rst
>>> @@ -213,3 +213,74 @@ PF vNIC.
>>>  The ctrl vNIC service handling various control message, like the
>>> creation and  configuration of representor port, the pattern and
>>> action of flow rules, the  statistics of flow rules, and so on.
>>> +
>>> +Supported APIs
>>> +--------------
>>> +
>>> +rte_flow APIs
>>> +~~~~~~~~~~~~~
>>> +
>>> +Listed below are the rte_flow functions supported:
>>> +* ``rte_flow_ops_get``
>>> +* ``rte_flow_validate``
>>> +* ``rte_flow_create``
>>> +* ``rte_flow_destroy``
>>> +* ``rte_flow_flush``
>>> +* ``nfp_flow_query``
>>> +* ``rte_flow_tunnel_action_decap_release``
>>> +* ``rte_flow_tunnel_decap_set``
>>> +* ``rte_flow_tunnel_item_release``
>>> +* ``rte_flow_tunnel_match``
>>> +
>>> +rte_flow Items
>>> +~~~~~~~~~~~~~~
>>> +
>>> +Refer to "Table 1.2 rte_flow items availability in networking
>>> +drivers" in `Overview of Networking Drivers
>> <https://doc.dpdk.org/guides/nics/overview.html>`.
>>> +
>>> +Listed below are the rte_flow items supported:
>>> +
>>> +* ``eth``
>>> +* ``geneve``
>>> +* ``gre``
>>> +* ``gre_key``
>>> +* ``ipv4``
>>> +* ``ipv6``
>>> +* ``port_id``
>>> +* ``sctp``
>>> +* ``tcp``
>>> +* ``udp``
>>> +* ``vlan``
>>> +* ``vxlan``
>>> +
>>> +rte_flow Actions
>>> +~~~~~~~~~~~~~~~~
>>> +
>>> +Refer to "Table 1.3 rte_flow actions availability in networking
>>> +drivers" in `Overview of Networking Drivers
>> <https://doc.dpdk.org/guides/nics/overview.html>`.
>>> +
>>> +Listed below are the rte_flow actions supported:
>>> +
>>> +* ``count``
>>> +* ``drop``
>>> +* ``jump``
>>> +* ``of_pop_vlan``
>>> +* ``of_push_vlan``
>>> +* ``of_set_vlan_pcp``
>>> +* ``of_set_vlan_vid``
>>> +* ``raw_decap``
>>> +* ``raw_encap``
>>> +* ``port_id``
>>> +* ``set_ipv4_dscp``
>>> +* ``set_ipv4_dst``
>>> +* ``set_ipv4_src``
>>> +* ``set_ipv6_dscp``
>>> +* ``set_ipv6_dst``
>>> +* ``set_ipv6_src``
>>> +* ``set_mac_dst``
>>> +* ``set_mac_src``
>>> +* ``set_tp_dst``
>>> +* ``set_tp_src``
>>> +* ``set_ttl``
>>> +* ``vxlan_decap``
>>> +* ``vxlan_encap``
>
Niklas Söderlund Feb. 8, 2023, 5:05 p.m. UTC | #4 
Hello Ajit,

On 2023-01-24 09:13:20 +0000, Ferruh Yigit wrote:
> On 1/24/2023 2:44 AM, Chaoyong He wrote:
> >> On 12/1/2022 1:38 AM, Chaoyong He wrote:
> >>> Add a new section 'Supported APIs', inculding the supported
> >>> APIs/items/actions of rte_flow.
> >>>
> >>
> >> Isn't this information already exists in 'doc/guides/nics/features/nfp.ini'? Why to
> >> duplicate here?
> >>
> > 
> > Oh, one customer say they wants this section like the `bnxt.rst`, so we added this.
> > 
> 
> You are right, and I think that is a duplication for bnxt too, cc'ed
> Ajit for comment.

Small ping on a comment here.

> 
> 
> >>> Signed-off-by: Chaoyong He <chaoyong.he@corigine.com>
> >>> Reviewed-by: Niklas Söderlund <niklas.soderlund@corigine.com>
> >>> ---
> >>>  doc/guides/nics/nfp.rst | 71
> >>> +++++++++++++++++++++++++++++++++++++++++
> >>>  1 file changed, 71 insertions(+)
> >>>
> >>> diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index
> >>> b74067c875..615f7dab9f 100644
> >>> --- a/doc/guides/nics/nfp.rst
> >>> +++ b/doc/guides/nics/nfp.rst
> >>> @@ -213,3 +213,74 @@ PF vNIC.
> >>>  The ctrl vNIC service handling various control message, like the
> >>> creation and  configuration of representor port, the pattern and
> >>> action of flow rules, the  statistics of flow rules, and so on.
> >>> +
> >>> +Supported APIs
> >>> +--------------
> >>> +
> >>> +rte_flow APIs
> >>> +~~~~~~~~~~~~~
> >>> +
> >>> +Listed below are the rte_flow functions supported:
> >>> +* ``rte_flow_ops_get``
> >>> +* ``rte_flow_validate``
> >>> +* ``rte_flow_create``
> >>> +* ``rte_flow_destroy``
> >>> +* ``rte_flow_flush``
> >>> +* ``nfp_flow_query``
> >>> +* ``rte_flow_tunnel_action_decap_release``
> >>> +* ``rte_flow_tunnel_decap_set``
> >>> +* ``rte_flow_tunnel_item_release``
> >>> +* ``rte_flow_tunnel_match``
> >>> +
> >>> +rte_flow Items
> >>> +~~~~~~~~~~~~~~
> >>> +
> >>> +Refer to "Table 1.2 rte_flow items availability in networking
> >>> +drivers" in `Overview of Networking Drivers
> >> <https://doc.dpdk.org/guides/nics/overview.html>`.
> >>> +
> >>> +Listed below are the rte_flow items supported:
> >>> +
> >>> +* ``eth``
> >>> +* ``geneve``
> >>> +* ``gre``
> >>> +* ``gre_key``
> >>> +* ``ipv4``
> >>> +* ``ipv6``
> >>> +* ``port_id``
> >>> +* ``sctp``
> >>> +* ``tcp``
> >>> +* ``udp``
> >>> +* ``vlan``
> >>> +* ``vxlan``
> >>> +
> >>> +rte_flow Actions
> >>> +~~~~~~~~~~~~~~~~
> >>> +
> >>> +Refer to "Table 1.3 rte_flow actions availability in networking
> >>> +drivers" in `Overview of Networking Drivers
> >> <https://doc.dpdk.org/guides/nics/overview.html>`.
> >>> +
> >>> +Listed below are the rte_flow actions supported:
> >>> +
> >>> +* ``count``
> >>> +* ``drop``
> >>> +* ``jump``
> >>> +* ``of_pop_vlan``
> >>> +* ``of_push_vlan``
> >>> +* ``of_set_vlan_pcp``
> >>> +* ``of_set_vlan_vid``
> >>> +* ``raw_decap``
> >>> +* ``raw_encap``
> >>> +* ``port_id``
> >>> +* ``set_ipv4_dscp``
> >>> +* ``set_ipv4_dst``
> >>> +* ``set_ipv4_src``
> >>> +* ``set_ipv6_dscp``
> >>> +* ``set_ipv6_dst``
> >>> +* ``set_ipv6_src``
> >>> +* ``set_mac_dst``
> >>> +* ``set_mac_src``
> >>> +* ``set_tp_dst``
> >>> +* ``set_tp_src``
> >>> +* ``set_ttl``
> >>> +* ``vxlan_decap``
> >>> +* ``vxlan_encap``
> > 
>
diff mbox series

Patch

diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst
index b74067c875..615f7dab9f 100644
--- a/doc/guides/nics/nfp.rst
+++ b/doc/guides/nics/nfp.rst
@@ -213,3 +213,74 @@  PF vNIC.
 The ctrl vNIC service handling various control message, like the creation and
 configuration of representor port, the pattern and action of flow rules, the
 statistics of flow rules, and so on.
+
+Supported APIs
+--------------
+
+rte_flow APIs
+~~~~~~~~~~~~~
+
+Listed below are the rte_flow functions supported:
+* ``rte_flow_ops_get``
+* ``rte_flow_validate``
+* ``rte_flow_create``
+* ``rte_flow_destroy``
+* ``rte_flow_flush``
+* ``nfp_flow_query``
+* ``rte_flow_tunnel_action_decap_release``
+* ``rte_flow_tunnel_decap_set``
+* ``rte_flow_tunnel_item_release``
+* ``rte_flow_tunnel_match``
+
+rte_flow Items
+~~~~~~~~~~~~~~
+
+Refer to "Table 1.2 rte_flow items availability in networking drivers" in
+`Overview of Networking Drivers <https://doc.dpdk.org/guides/nics/overview.html>`.
+
+Listed below are the rte_flow items supported:
+
+* ``eth``
+* ``geneve``
+* ``gre``
+* ``gre_key``
+* ``ipv4``
+* ``ipv6``
+* ``port_id``
+* ``sctp``
+* ``tcp``
+* ``udp``
+* ``vlan``
+* ``vxlan``
+
+rte_flow Actions
+~~~~~~~~~~~~~~~~
+
+Refer to "Table 1.3 rte_flow actions availability in networking drivers" in
+`Overview of Networking Drivers <https://doc.dpdk.org/guides/nics/overview.html>`.
+
+Listed below are the rte_flow actions supported:
+
+* ``count``
+* ``drop``
+* ``jump``
+* ``of_pop_vlan``
+* ``of_push_vlan``
+* ``of_set_vlan_pcp``
+* ``of_set_vlan_vid``
+* ``raw_decap``
+* ``raw_encap``
+* ``port_id``
+* ``set_ipv4_dscp``
+* ``set_ipv4_dst``
+* ``set_ipv4_src``
+* ``set_ipv6_dscp``
+* ``set_ipv6_dst``
+* ``set_ipv6_src``
+* ``set_mac_dst``
+* ``set_mac_src``
+* ``set_tp_dst``
+* ``set_tp_src``
+* ``set_ttl``
+* ``vxlan_decap``
+* ``vxlan_encap``