[dpdk-dev,v2] doc: update ethdev APIs to return named opaque type

Message ID 20180209101818.70041-1-ferruh.yigit@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

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

Commit Message

Ferruh Yigit Feb. 9, 2018, 10:18 a.m. UTC
  Ethdev APIs to add callback return the callback object as "void *",
update return type to actual object type
"struct rte_eth_rxtx_callback *"

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: Konstantin Ananyev <konstantin.ananyev@intel.com>
Cc: Stephen Hemminger <stephen@networkplumber.org>
Cc: Bruce Richardson <bruce.richardson@intel.com>
Cc: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)
  

Comments

Ananyev, Konstantin Feb. 9, 2018, 1:22 p.m. UTC | #1
> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Friday, February 9, 2018 10:18 AM
> To: Neil Horman <nhorman@tuxdriver.com>; Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; Yigit, Ferruh <ferruh.yigit@intel.com>; Ananyev, Konstantin <konstantin.ananyev@intel.com>; Stephen Hemminger
> <stephen@networkplumber.org>; Richardson, Bruce <bruce.richardson@intel.com>; Thomas Monjalon <thomas@monjalon.net>
> Subject: [PATCH v2] doc: update ethdev APIs to return named opaque type
> 
> Ethdev APIs to add callback return the callback object as "void *",
> update return type to actual object type
> "struct rte_eth_rxtx_callback *"
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
> Cc: Konstantin Ananyev <konstantin.ananyev@intel.com>
> Cc: Stephen Hemminger <stephen@networkplumber.org>
> Cc: Bruce Richardson <bruce.richardson@intel.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/guides/rel_notes/deprecation.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index bbd9456a7..5cb5a00d2 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -49,6 +49,13 @@ Deprecation Notices
>    rte_eth_dev_get_sec_ctx() is using uint8_t for port_id, which should be
>    uint16_t.
> 
> +* ethdev: functions add rx/tx callback will return named opaque type
> +  rte_eth_add_rx_callback(), rte_eth_add_first_rx_callback() and
> +  rte_eth_add_tx_callback() functions currently return callback object as
> +  "void \*" but APIs to delete callbacks get "struct rte_eth_rxtx_callback \*"
> +  as parameter. For consistency functions adding callback will return
> +  "struct rte_eth_rxtx_callback \*" instead of "void * ".
> +
>  * i40e: The default flexible payload configuration which extracts the first 16
>    bytes of the payload for RSS will be deprecated starting from 18.02. If
>    required the previous behavior can be configured using existing flow
> --

Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>

> 2.14.3
  
Jerin Jacob Feb. 10, 2018, 12:02 p.m. UTC | #2
-----Original Message-----
> Date: Fri, 9 Feb 2018 13:22:06 +0000
> From: "Ananyev, Konstantin" <konstantin.ananyev@intel.com>
> To: "Yigit, Ferruh" <ferruh.yigit@intel.com>, Neil Horman
>  <nhorman@tuxdriver.com>, "Mcnamara, John" <john.mcnamara@intel.com>,
>  "Kovacevic, Marko" <marko.kovacevic@intel.com>
> CC: "dev@dpdk.org" <dev@dpdk.org>, Stephen Hemminger
>  <stephen@networkplumber.org>, "Richardson, Bruce"
>  <bruce.richardson@intel.com>, Thomas Monjalon <thomas@monjalon.net>
> Subject: Re: [dpdk-dev] [PATCH v2] doc: update ethdev APIs to return named
>  opaque type
> 
> 
> 
> > -----Original Message-----
> > From: Yigit, Ferruh
> > Sent: Friday, February 9, 2018 10:18 AM
> > To: Neil Horman <nhorman@tuxdriver.com>; Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> > <marko.kovacevic@intel.com>
> > Cc: dev@dpdk.org; Yigit, Ferruh <ferruh.yigit@intel.com>; Ananyev, Konstantin <konstantin.ananyev@intel.com>; Stephen Hemminger
> > <stephen@networkplumber.org>; Richardson, Bruce <bruce.richardson@intel.com>; Thomas Monjalon <thomas@monjalon.net>
> > Subject: [PATCH v2] doc: update ethdev APIs to return named opaque type
> > 
> > Ethdev APIs to add callback return the callback object as "void *",
> > update return type to actual object type
> > "struct rte_eth_rxtx_callback *"
> > 
> > Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> > ---
> > Cc: Konstantin Ananyev <konstantin.ananyev@intel.com>
> > Cc: Stephen Hemminger <stephen@networkplumber.org>
> > Cc: Bruce Richardson <bruce.richardson@intel.com>
> > Cc: Thomas Monjalon <thomas@monjalon.net>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 7 +++++++
> >  1 file changed, 7 insertions(+)
> > 
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index bbd9456a7..5cb5a00d2 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -49,6 +49,13 @@ Deprecation Notices
> >    rte_eth_dev_get_sec_ctx() is using uint8_t for port_id, which should be
> >    uint16_t.
> > 
> > +* ethdev: functions add rx/tx callback will return named opaque type
> > +  rte_eth_add_rx_callback(), rte_eth_add_first_rx_callback() and
> > +  rte_eth_add_tx_callback() functions currently return callback object as
> > +  "void \*" but APIs to delete callbacks get "struct rte_eth_rxtx_callback \*"
> > +  as parameter. For consistency functions adding callback will return
> > +  "struct rte_eth_rxtx_callback \*" instead of "void * ".
> > +
> >  * i40e: The default flexible payload configuration which extracts the first 16
> >    bytes of the payload for RSS will be deprecated starting from 18.02. If
> >    required the previous behavior can be configured using existing flow
> > --
> 
> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>

Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>

> 
> > 2.14.3
>
  
Hemant Agrawal Feb. 13, 2018, 3:52 a.m. UTC | #3
On 2/10/2018 5:32 PM, Jerin Jacob wrote:
>>> -----Original Message-----
>>> From: Yigit, Ferruh
>>> Sent: Friday, February 9, 2018 10:18 AM
>>> To: Neil Horman <nhorman@tuxdriver.com>; Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
>>> <marko.kovacevic@intel.com>
>>> Cc: dev@dpdk.org; Yigit, Ferruh <ferruh.yigit@intel.com>; Ananyev, Konstantin <konstantin.ananyev@intel.com>; Stephen Hemminger
>>> <stephen@networkplumber.org>; Richardson, Bruce <bruce.richardson@intel.com>; Thomas Monjalon <thomas@monjalon.net>
>>> Subject: [PATCH v2] doc: update ethdev APIs to return named opaque type
>>>
>>> Ethdev APIs to add callback return the callback object as "void *",
>>> update return type to actual object type
>>> "struct rte_eth_rxtx_callback *"
>>>
>>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
>>> ---
>>> Cc: Konstantin Ananyev <konstantin.ananyev@intel.com>
>>> Cc: Stephen Hemminger <stephen@networkplumber.org>
>>> Cc: Bruce Richardson <bruce.richardson@intel.com>
>>> Cc: Thomas Monjalon <thomas@monjalon.net>
>>> ---
>>>   doc/guides/rel_notes/deprecation.rst | 7 +++++++
>>>   1 file changed, 7 insertions(+)
>>>
>>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
>>> index bbd9456a7..5cb5a00d2 100644
>>> --- a/doc/guides/rel_notes/deprecation.rst
>>> +++ b/doc/guides/rel_notes/deprecation.rst
>>> @@ -49,6 +49,13 @@ Deprecation Notices
>>>     rte_eth_dev_get_sec_ctx() is using uint8_t for port_id, which should be
>>>     uint16_t.
>>>
>>> +* ethdev: functions add rx/tx callback will return named opaque type
>>> +  rte_eth_add_rx_callback(), rte_eth_add_first_rx_callback() and
>>> +  rte_eth_add_tx_callback() functions currently return callback object as
>>> +  "void \*" but APIs to delete callbacks get "struct rte_eth_rxtx_callback \*"
>>> +  as parameter. For consistency functions adding callback will return
>>> +  "struct rte_eth_rxtx_callback \*" instead of "void * ".
>>> +
>>>   * i40e: The default flexible payload configuration which extracts the first 16
>>>     bytes of the payload for RSS will be deprecated starting from 18.02. If
>>>     required the previous behavior can be configured using existing flow
>>> --
>>
>> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> 
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> 
>>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
  
Thomas Monjalon Feb. 14, 2018, 5:10 p.m. UTC | #4
> >>> Ethdev APIs to add callback return the callback object as "void *",
> >>> update return type to actual object type
> >>> "struct rte_eth_rxtx_callback *"
> >>>
> >>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> >>> ---
> >>> +* ethdev: functions add rx/tx callback will return named opaque type
> >>> +  rte_eth_add_rx_callback(), rte_eth_add_first_rx_callback() and
> >>> +  rte_eth_add_tx_callback() functions currently return callback object as
> >>> +  "void \*" but APIs to delete callbacks get "struct rte_eth_rxtx_callback \*"
> >>> +  as parameter. For consistency functions adding callback will return
> >>> +  "struct rte_eth_rxtx_callback \*" instead of "void * ".
> >>> +
> >>>   * i40e: The default flexible payload configuration which extracts the first 16
> >>>     bytes of the payload for RSS will be deprecated starting from 18.02. If
> >>>     required the previous behavior can be configured using existing flow
> >>> --
> >>
> >> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> > 
> > Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > 
> Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>

Applied
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index bbd9456a7..5cb5a00d2 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -49,6 +49,13 @@  Deprecation Notices
   rte_eth_dev_get_sec_ctx() is using uint8_t for port_id, which should be
   uint16_t.
 
+* ethdev: functions add rx/tx callback will return named opaque type
+  rte_eth_add_rx_callback(), rte_eth_add_first_rx_callback() and
+  rte_eth_add_tx_callback() functions currently return callback object as
+  "void \*" but APIs to delete callbacks get "struct rte_eth_rxtx_callback \*"
+  as parameter. For consistency functions adding callback will return
+  "struct rte_eth_rxtx_callback \*" instead of "void * ".
+
 * i40e: The default flexible payload configuration which extracts the first 16
   bytes of the payload for RSS will be deprecated starting from 18.02. If
   required the previous behavior can be configured using existing flow