[dpdk-dev] [PATCH v1] doc: announce API and ABI change for ethdev

[dpdk-dev] [PATCH v1] doc: announce API and ABI change for ethdev

[Bernard Iremonger]

In 17.05 nine rte_eth_dev_* functions will be removed from
librte_ether, renamed and moved to the ixgbe PMD.

Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 61 ++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1438c77..f3d79d8 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -79,3 +79,64 @@ Deprecation Notices
   PMDs that implement the latter.
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
+
+* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_* functions
+  and move them into the ixgbe PMD:
+
+  ``rte_eth_dev_bypass_init``
+
+  ``rte_eth_dev_bypass_state_set``
+
+  ``rte_eth_dev_bypass_state_show``
+
+  ``rte_eth_dev_bypass_event_store``
+
+  ``rte_eth_dev_bypass_event_show``
+
+  ``rte_eth_dev_wd_timeout_store``
+
+  ``rte_eth_dev_bypass_wd_timeout_show``
+
+  ``rte_eth_dev_bypass_ver_show``
+
+  ``rte_eth_dev_bypass_wd_reset``
+
+  The following fields will be removed from ``struct eth_dev_ops``:
+
+  ``bypass_init_t``
+
+  ``bypass_state_set_t``
+
+  ``bypass_state_show_t``
+
+  ``bypass_event_set_t``
+
+  ``bypass_event_show_t``
+
+  ``bypass_wd_timeout_set_t``
+
+  ``bypass_wd_timeout_show_t``
+
+  ``bypass_ver_show_t``
+
+  ``bypass_wd_reset_t``
+
+  The functions will be renamed to the following, and moved to the ``ixgbe`` PMD:
+
+  ``rte_pmd_ixgbe_bypass_init``
+
+  ``rte_pmd_ixgbe_bypass_state_set``
+
+  ``rte_pmd_ixgbe_bypass_state_show``
+
+  ``rte_pmd_ixgbe_bypass_event_set``
+
+  ``rte_pmd_ixgbe_bypass_event_show``
+
+  ``rte_pmd_ixgbe_bypass_wd_timeout_set``
+
+  ``rte_pmd_ixgbe_bypass_wd_timeout_show``
+
+  ``rte_pmd_ixgbe_bypass_ver_show``
+
+  ``rte_pmd_ixgbe_bypass_wd_reset``
-- 
2.10.1

Re: [dpdk-dev] [PATCH v1] doc: announce API and ABI change for ethdev

[Thomas Monjalon]

2017-01-05 10:44, Bernard Iremonger:
> In 17.05 nine rte_eth_dev_* functions will be removed from
> librte_ether, renamed and moved to the ixgbe PMD.

I agree it is a good move to clean up ethdev API.

> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> +* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_* functions
> +  and move them into the ixgbe PMD:
> +
> +  ``rte_eth_dev_bypass_init``
> +
> +  ``rte_eth_dev_bypass_state_set``
> +
> +  ``rte_eth_dev_bypass_state_show``
> +
> +  ``rte_eth_dev_bypass_event_store``
> +
> +  ``rte_eth_dev_bypass_event_show``
> +
> +  ``rte_eth_dev_wd_timeout_store``
> +
> +  ``rte_eth_dev_bypass_wd_timeout_show``
> +
> +  ``rte_eth_dev_bypass_ver_show``
> +
> +  ``rte_eth_dev_bypass_wd_reset``
> +
> +  The following fields will be removed from ``struct eth_dev_ops``:
> +
> +  ``bypass_init_t``
> +
> +  ``bypass_state_set_t``
> +
> +  ``bypass_state_show_t``
> +
> +  ``bypass_event_set_t``
> +
> +  ``bypass_event_show_t``
> +
> +  ``bypass_wd_timeout_set_t``
> +
> +  ``bypass_wd_timeout_show_t``
> +
> +  ``bypass_ver_show_t``
> +
> +  ``bypass_wd_reset_t``
> +
> +  The functions will be renamed to the following, and moved to the ``ixgbe`` PMD:
> +
> +  ``rte_pmd_ixgbe_bypass_init``
> +
> +  ``rte_pmd_ixgbe_bypass_state_set``
> +
> +  ``rte_pmd_ixgbe_bypass_state_show``
> +
> +  ``rte_pmd_ixgbe_bypass_event_set``
> +
> +  ``rte_pmd_ixgbe_bypass_event_show``
> +
> +  ``rte_pmd_ixgbe_bypass_wd_timeout_set``
> +
> +  ``rte_pmd_ixgbe_bypass_wd_timeout_show``
> +
> +  ``rte_pmd_ixgbe_bypass_ver_show``
> +
> +  ``rte_pmd_ixgbe_bypass_wd_reset``
> 

Please could you make it shorter by using commas for listing?

Re: [dpdk-dev] [PATCH v1] doc: announce API and ABI change for ethdev

[Iremonger, Bernard]

Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Thursday, January 5, 2017 1:31 PM
> To: Iremonger, Bernard <bernard.iremonger@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v1] doc: announce API and ABI change for
> ethdev
> 
> 2017-01-05 10:44, Bernard Iremonger:
> > In 17.05 nine rte_eth_dev_* functions will be removed from
> > librte_ether, renamed and moved to the ixgbe PMD.
> 
> I agree it is a good move to clean up ethdev API.
> 
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > +* ethdev: for 17.05 it is planned to deprecate the following nine
> > +rte_eth_dev_* functions
> > +  and move them into the ixgbe PMD:
> > +
> > +  ``rte_eth_dev_bypass_init``
> > +
> > +  ``rte_eth_dev_bypass_state_set``
> > +
> > +  ``rte_eth_dev_bypass_state_show``
> > +
> > +  ``rte_eth_dev_bypass_event_store``
> > +
> > +  ``rte_eth_dev_bypass_event_show``
> > +
> > +  ``rte_eth_dev_wd_timeout_store``
> > +
> > +  ``rte_eth_dev_bypass_wd_timeout_show``
> > +
> > +  ``rte_eth_dev_bypass_ver_show``
> > +
> > +  ``rte_eth_dev_bypass_wd_reset``
> > +
> > +  The following fields will be removed from ``struct eth_dev_ops``:
> > +
> > +  ``bypass_init_t``
> > +
> > +  ``bypass_state_set_t``
> > +
> > +  ``bypass_state_show_t``
> > +
> > +  ``bypass_event_set_t``
> > +
> > +  ``bypass_event_show_t``
> > +
> > +  ``bypass_wd_timeout_set_t``
> > +
> > +  ``bypass_wd_timeout_show_t``
> > +
> > +  ``bypass_ver_show_t``
> > +
> > +  ``bypass_wd_reset_t``
> > +
> > +  The functions will be renamed to the following, and moved to the
> ``ixgbe`` PMD:
> > +
> > +  ``rte_pmd_ixgbe_bypass_init``
> > +
> > +  ``rte_pmd_ixgbe_bypass_state_set``
> > +
> > +  ``rte_pmd_ixgbe_bypass_state_show``
> > +
> > +  ``rte_pmd_ixgbe_bypass_event_set``
> > +
> > +  ``rte_pmd_ixgbe_bypass_event_show``
> > +
> > +  ``rte_pmd_ixgbe_bypass_wd_timeout_set``
> > +
> > +  ``rte_pmd_ixgbe_bypass_wd_timeout_show``
> > +
> > +  ``rte_pmd_ixgbe_bypass_ver_show``
> > +
> > +  ``rte_pmd_ixgbe_bypass_wd_reset``
> >
> 
> Please could you make it shorter by using commas for listing?

I will use commas for the listing in v2.

Regards,

Bernard.

[dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Bernard Iremonger]

In 17.05 nine rte_eth_dev_* functions will be removed from
librte_ether, renamed and moved to the ixgbe PMD.

Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
---
v2:
Used comma's to shorten lists.

 doc/guides/rel_notes/deprecation.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1438c77..985cda8 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -79,3 +79,22 @@ Deprecation Notices
   PMDs that implement the latter.
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
+
+* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_* functions
+  and move them into the ixgbe PMD:
+
+  ``rte_eth_dev_bypass_init``, ``rte_eth_dev_bypass_state_set``, ``rte_eth_dev_bypass_state_show``,
+  ``rte_eth_dev_bypass_event_store``, ``rte_eth_dev_bypass_event_show``, ``rte_eth_dev_wd_timeout_store``,
+  ``rte_eth_dev_bypass_wd_timeout_show``, ``rte_eth_dev_bypass_ver_show``, ``rte_eth_dev_bypass_wd_reset``.
+
+  The following fields will be removed from ``struct eth_dev_ops``:
+
+  ``bypass_init_t``, ``bypass_state_set_t``, ``bypass_state_show_t``, ``bypass_event_set_t``,
+  ``bypass_event_show_t``, ``bypass_wd_timeout_set_t``, ``bypass_wd_timeout_show_t``,
+  ``bypass_ver_show_t``, ``bypass_wd_reset_t``.
+
+  The functions will be renamed to the following, and moved to the ``ixgbe`` PMD:
+
+  ``rte_pmd_ixgbe_bypass_init``, ``rte_pmd_ixgbe_bypass_state_set``, ``rte_pmd_ixgbe_bypass_state_show``,
+  ``rte_pmd_ixgbe_bypass_event_set``, ``rte_pmd_ixgbe_bypass_event_show``, ``rte_pmd_ixgbe_bypass_wd_timeout_set``,
+  ``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``, ``rte_pmd_ixgbe_bypass_wd_reset``.
-- 
2.10.1

Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Thomas Monjalon]

2017-01-05 15:25, Bernard Iremonger:
> In 17.05 nine rte_eth_dev_* functions will be removed from
> librte_ether, renamed and moved to the ixgbe PMD.
> 
> Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>

"ixgbe bypass" should be in the title and the description.
I'll reword to:

doc: announce move of ethdev bypass function to ixgbe API

In 17.05, nine rte_eth_dev_* functions for bypass control,
and implemented only in ixgbe, will be removed from ethdev,
renamed and moved to the ixgbe PMD-specific API.

Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>

Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Jerin Jacob]

On Mon, Feb 13, 2017 at 06:57:20PM +0100, Thomas Monjalon wrote:
> 2017-01-05 15:25, Bernard Iremonger:
> > In 17.05 nine rte_eth_dev_* functions will be removed from
> > librte_ether, renamed and moved to the ixgbe PMD.
> > 
> > Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
> 
> "ixgbe bypass" should be in the title and the description.
> I'll reword to:
> 
> doc: announce move of ethdev bypass function to ixgbe API
> 
> In 17.05, nine rte_eth_dev_* functions for bypass control,
> and implemented only in ixgbe, will be removed from ethdev,
> renamed and moved to the ixgbe PMD-specific API.
> 
> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>

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

Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Iremonger, Bernard]

> -----Original Message-----
> From: Jerin Jacob [mailto:jerin.jacob@caviumnetworks.com]
> Sent: Tuesday, February 14, 2017 3:17 AM
> To: Thomas Monjalon <thomas.monjalon@6wind.com>
> Cc: Iremonger, Bernard <bernard.iremonger@intel.com>; dev@dpdk.org;
> Mcnamara, John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for
> ethdev
> 
> On Mon, Feb 13, 2017 at 06:57:20PM +0100, Thomas Monjalon wrote:
> > 2017-01-05 15:25, Bernard Iremonger:
> > > In 17.05 nine rte_eth_dev_* functions will be removed from
> > > librte_ether, renamed and moved to the ixgbe PMD.
> > >
> > > Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
> >
> > "ixgbe bypass" should be in the title and the description.
> > I'll reword to:
> >
> > doc: announce move of ethdev bypass function to ixgbe API
> >
> > In 17.05, nine rte_eth_dev_* functions for bypass control, and
> > implemented only in ixgbe, will be removed from ethdev, renamed and
> > moved to the ixgbe PMD-specific API.
> >
> > Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> 
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>

Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Thomas Monjalon]

Applied

Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Shahaf Shuler]

Friday, August 4, 2017 9:56 AM, Remy Horton:
> On 04/08/2017 06:27, Zhiyong Yang wrote:
> > This is an API/ABI change notice for DPDK 17.11 on redefinition of
> > port_id. port_id is defined as uint8_t by now, which is just ranged
> > from 0 to 255. For more and more scenerioes, more than 256 ports are
> > needed to support for vdev scalability.
> >
> > It is necessary for redefinition of port_id to extend from 1 bytes to
> > 2 bytes. All ethdev APIs and use cases related to port_id will be
> > changed at the same time.
> 
> I think this reads a little better:
> 
> This is an API/ABI change notice for DPDK 17.11 announcing the redefinition
> of port_id. port_id is currently defined as uint8_t, which is limited to the
> range 0 to 255. A larger range is required for vdev scalability.
> 
> It is necessary for a redefinition of port_id to extend it from 1 bytes to 2
> bytes. All ethdev APIs and usages related to port_id will be changed at the
> same time.
> 
> >  doc/guides/rel_notes/deprecation.rst | 6 ++++++
> >  1 file changed, 6 insertions(+)
> 
> Acked-by: Remy Horton <remy.horton@intel.com>

Acked-by: Shahaf Shuler <shahafs@mellanox.com>

Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Thomas Monjalon]

07/08/2017 05:07, Yang, Zhiyong:
> Hi, Thomas:
> 	Need I sent another V3 patch to update commit log according to Remy's suggestion?

Yes it would be better if you can do it please

Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Yang, Zhiyong]

Hi, Thomas:
	Need I sent another V3 patch to update commit log according to Remy's suggestion?
Thanks
Zhiyong

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Yang, Zhiyong
> Sent: Saturday, August 5, 2017 6:35 PM
> To: Horton, Remy <remy.horton@intel.com>; dev@dpdk.org
> Cc: Tan, Jianfeng <jianfeng.tan@intel.com>; yliu@fridaylinux.org;
> jerin.jacob@caviumnetworks.com; thomas@monjalon.net
> Subject: Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for
> ethdev
> 
> Hi, Remy:
> 
> > -----Original Message-----
> > From: Horton, Remy
> > Sent: Friday, August 4, 2017 2:56 PM
> > To: Yang, Zhiyong <zhiyong.yang@intel.com>; dev@dpdk.org
> > Cc: Tan, Jianfeng <jianfeng.tan@intel.com>; yliu@fridaylinux.org;
> > jerin.jacob@caviumnetworks.com; thomas@monjalon.net
> > Subject: Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change
> > for ethdev
> >
> >
> > On 04/08/2017 06:27, Zhiyong Yang wrote:
> > > This is an API/ABI change notice for DPDK 17.11 on redefinition of
> > > port_id. port_id is defined as uint8_t by now, which is just ranged
> > > from 0 to 255. For more and more scenerioes, more than 256 ports are
> > > needed to support for vdev scalability.
> > >
> > > It is necessary for redefinition of port_id to extend from 1 bytes
> > > to
> > > 2 bytes. All ethdev APIs and use cases related to port_id will be
> > > changed at the same time.
> >
> > I think this reads a little better:
> >
> > This is an API/ABI change notice for DPDK 17.11 announcing the
> > redefinition of port_id. port_id is currently defined as uint8_t,
> > which is limited to the range 0 to 255. A larger range is required for vdev
> scalability.
> >
> > It is necessary for a redefinition of port_id to extend it from 1 bytes to 2 bytes.
> > All ethdev APIs and usages related to port_id will be changed at the same time.
> 
> Thanks Remy, of course. Your statement is better. I have a lot of things  to learn
> when speaking in English. I hope I can describe things like you, a native
> speaker. :) Thanks again for your ack.
> 
> Zhiyong
> 
> >
> > >  doc/guides/rel_notes/deprecation.rst | 6 ++++++
> > >  1 file changed, 6 insertions(+)
> >
> > Acked-by: Remy Horton <remy.horton@intel.com>

Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Yang, Zhiyong]

Hi, Remy:

> -----Original Message-----
> From: Horton, Remy
> Sent: Friday, August 4, 2017 2:56 PM
> To: Yang, Zhiyong <zhiyong.yang@intel.com>; dev@dpdk.org
> Cc: Tan, Jianfeng <jianfeng.tan@intel.com>; yliu@fridaylinux.org;
> jerin.jacob@caviumnetworks.com; thomas@monjalon.net
> Subject: Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for
> ethdev
> 
> 
> On 04/08/2017 06:27, Zhiyong Yang wrote:
> > This is an API/ABI change notice for DPDK 17.11 on redefinition of
> > port_id. port_id is defined as uint8_t by now, which is just ranged
> > from 0 to 255. For more and more scenerioes, more than 256 ports are
> > needed to support for vdev scalability.
> >
> > It is necessary for redefinition of port_id to extend from 1 bytes to
> > 2 bytes. All ethdev APIs and use cases related to port_id will be
> > changed at the same time.
> 
> I think this reads a little better:
> 
> This is an API/ABI change notice for DPDK 17.11 announcing the redefinition of
> port_id. port_id is currently defined as uint8_t, which is limited to the range 0 to
> 255. A larger range is required for vdev scalability.
> 
> It is necessary for a redefinition of port_id to extend it from 1 bytes to 2 bytes.
> All ethdev APIs and usages related to port_id will be changed at the same time.

Thanks Remy, of course. Your statement is better. I have a lot of things  to learn
when speaking in English. I hope I can describe things like you, a native speaker. :)
Thanks again for your ack.
 
Zhiyong

> 
> >  doc/guides/rel_notes/deprecation.rst | 6 ++++++
> >  1 file changed, 6 insertions(+)
> 
> Acked-by: Remy Horton <remy.horton@intel.com>

Re: [dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Remy Horton]

On 04/08/2017 06:27, Zhiyong Yang wrote:
> This is an API/ABI change notice for DPDK 17.11 on redefinition of
> port_id. port_id is defined as uint8_t by now, which is just ranged
> from 0 to 255. For more and more scenerioes, more than 256 ports are
> needed to support for vdev scalability.
>
> It is necessary for redefinition of port_id to extend from 1 bytes
> to 2 bytes. All ethdev APIs and use cases related to port_id will be
> changed at the same time.

I think this reads a little better:

This is an API/ABI change notice for DPDK 17.11 announcing the 
redefinition of port_id. port_id is currently defined as uint8_t, which 
is limited to the range 0 to 255. A larger range is required for vdev 
scalability.

It is necessary for a redefinition of port_id to extend it from 1 bytes 
to 2 bytes. All ethdev APIs and usages related to port_id will be 
changed at the same time.

>  doc/guides/rel_notes/deprecation.rst | 6 ++++++
>  1 file changed, 6 insertions(+)

Acked-by: Remy Horton <remy.horton@intel.com>

[dpdk-dev] [PATCH v2] doc: announce API and ABI change for ethdev

[Zhiyong Yang]

This is an API/ABI change notice for DPDK 17.11 on redefinition of
port_id. port_id is defined as uint8_t by now, which is just ranged
from 0 to 255. For more and more scenerioes, more than 256 ports are
needed to support for vdev scalability.

It is necessary for redefinition of port_id to extend from 1 bytes
to 2 bytes. All ethdev APIs and use cases related to port_id will be
changed at the same time.

cc: jianfeng.tan@intel.com
cc: yliu@fridaylinux.org
cc: jerin.jacob@caviumnetworks.com
cc: thomas@monjalon.net

Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
Acked-by: Jianfeng Tan <jianfeng.tan@intel.com>
Acked-by: Yuanhan Liu <yliu@fridaylinux.org>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
---

Change in V2.
1. remove indent of paragraph in commit log.
2. add more description about API/ABI according to yuanhan's comments.

 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 72aa40495..4edaf92fb 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -49,6 +49,12 @@ Deprecation Notices
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
 
+* ABI/API changes are planned for 17.11 in all structures which include port_id
+  definition such as "rte_eth_dev_data", "rte_port_ethdev_reader_params",
+  "rte_port_ethdev_writer_params", and so on. The definition of port_id will be
+  changed from 8 bits to 16 bits in order to support more than 256 ports in
+  DPDK. All APIs which have port_id parameter will be changed at the same time.
+
 * librte_table: The ``key_mask`` parameter will be added to all the hash tables
   that currently do not have it, as well as to the hash compute function prototype.
   The non-"do-sig" versions of the hash tables will be removed
-- 
2.13.3