* [PATCH] doc: add supported APIs section to nfp guide
@ 2022-12-01 1:38 Chaoyong He
2023-01-19 9:18 ` Ferruh Yigit
0 siblings, 1 reply; 5+ messages in thread
From: Chaoyong He @ 2022-12-01 1:38 UTC (permalink / raw)
To: dev; +Cc: oss-drivers, niklas.soderlund, Chaoyong He
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(+)
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``
--
2.29.3
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] doc: add supported APIs section to nfp guide
2022-12-01 1:38 [PATCH] doc: add supported APIs section to nfp guide Chaoyong He
@ 2023-01-19 9:18 ` Ferruh Yigit
2023-01-24 2:44 ` Chaoyong He
0 siblings, 1 reply; 5+ messages in thread
From: Ferruh Yigit @ 2023-01-19 9:18 UTC (permalink / raw)
To: Chaoyong He, dev; +Cc: oss-drivers, niklas.soderlund
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``
^ permalink raw reply [flat|nested] 5+ messages in thread
* RE: [PATCH] doc: add supported APIs section to nfp guide
2023-01-19 9:18 ` Ferruh Yigit
@ 2023-01-24 2:44 ` Chaoyong He
2023-01-24 9:13 ` Ferruh Yigit
0 siblings, 1 reply; 5+ messages in thread
From: Chaoyong He @ 2023-01-24 2:44 UTC (permalink / raw)
To: Ferruh Yigit, dev; +Cc: oss-drivers, Niklas Soderlund
> 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``
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] doc: add supported APIs section to nfp guide
2023-01-24 2:44 ` Chaoyong He
@ 2023-01-24 9:13 ` Ferruh Yigit
2023-02-08 17:05 ` Niklas Soderlund
0 siblings, 1 reply; 5+ messages in thread
From: Ferruh Yigit @ 2023-01-24 9:13 UTC (permalink / raw)
To: Chaoyong He, dev, Ajit Khaparde
Cc: oss-drivers, Niklas Soderlund, Thomas Monjalon, Andrew Rybchenko
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``
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] doc: add supported APIs section to nfp guide
2023-01-24 9:13 ` Ferruh Yigit
@ 2023-02-08 17:05 ` Niklas Soderlund
0 siblings, 0 replies; 5+ messages in thread
From: Niklas Soderlund @ 2023-02-08 17:05 UTC (permalink / raw)
To: Ajit Khaparde
Cc: Ferruh Yigit, Chaoyong He, dev, oss-drivers, Thomas Monjalon,
Andrew Rybchenko
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``
> >
>
--
Kind Regards,
Niklas Söderlund
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2023-02-08 17:05 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-12-01 1:38 [PATCH] doc: add supported APIs section to nfp guide Chaoyong He
2023-01-19 9:18 ` Ferruh Yigit
2023-01-24 2:44 ` Chaoyong He
2023-01-24 9:13 ` Ferruh Yigit
2023-02-08 17:05 ` Niklas Soderlund
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).