[dpdk-dev] doc: announce crypto device type enumeration removal

Message ID 20170505112419.14965-1-slawomirx.mrozowicz@intel.com (mailing list archive)
State Accepted, archived
Headers

Checks

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

Commit Message

Slawomir Mrozowicz May 5, 2017, 11:24 a.m. UTC
  Refer to RFC patch - cryptodev: remove crypto device type enumeration

It is planned to remove device type enumeration rte_cryptodev_type from
library to remove the coupling between crypto PMD and the librte_cryptodev.

In this case following stuctures will be changed: rte_cryptodev_session,
rte_cryptodev_sym_session, rte_cryptodev_info, rte_cryptodev.

It is planned to change the function rte_cryptodev_count_devtype().
The function prototype doesn’t clearly show the operation.
From next release 17.08 the dev_type will be changed to driver_id.
So the function name will change to rte_cryptodev_device_count_by_driver().

Signed-off-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>
---
Refer to RFC patch: http://dpdk.org/dev/patchwork/patch/24119/
---
 doc/guides/rel_notes/deprecation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
  

Comments

De Lara Guarch, Pablo May 8, 2017, 9:50 a.m. UTC | #1
> -----Original Message-----

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Slawomir

> Mrozowicz

> Sent: Friday, May 05, 2017 12:24 PM

> To: Doherty, Declan

> Cc: dev@dpdk.org; Mrozowicz, SlawomirX

> Subject: [dpdk-dev] [PATCH] doc: announce crypto device type enumeration

> removal

> 

> Refer to RFC patch - cryptodev: remove crypto device type enumeration

> 

> It is planned to remove device type enumeration rte_cryptodev_type from

> library to remove the coupling between crypto PMD and the

> librte_cryptodev.

> 

> In this case following stuctures will be changed: rte_cryptodev_session,

> rte_cryptodev_sym_session, rte_cryptodev_info, rte_cryptodev.

> 

> It is planned to change the function rte_cryptodev_count_devtype().

> The function prototype doesn’t clearly show the operation.

> From next release 17.08 the dev_type will be changed to driver_id.

> So the function name will change to

> rte_cryptodev_device_count_by_driver().

> 

> Signed-off-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>


Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
  
Doherty, Declan May 8, 2017, 10:33 a.m. UTC | #2
On 05/05/2017 12:24 PM, Slawomir Mrozowicz wrote:
> Refer to RFC patch - cryptodev: remove crypto device type enumeration
>
> It is planned to remove device type enumeration rte_cryptodev_type from
> library to remove the coupling between crypto PMD and the librte_cryptodev.
>
> In this case following stuctures will be changed: rte_cryptodev_session,
> rte_cryptodev_sym_session, rte_cryptodev_info, rte_cryptodev.
>
> It is planned to change the function rte_cryptodev_count_devtype().
> The function prototype doesn’t clearly show the operation.
> From next release 17.08 the dev_type will be changed to driver_id.
> So the function name will change to rte_cryptodev_device_count_by_driver().
>
> Signed-off-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>
> ---
...
>

Acked-by: Declan Doherty <declan.doherty@intel.com>
  
Jerin Jacob May 8, 2017, 11:05 a.m. UTC | #3
-----Original Message-----
> Date: Fri, 5 May 2017 13:24:19 +0200
> From: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>
> To: declan.doherty@intel.com
> CC: dev@dpdk.org, Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: announce crypto device type enumeration
>  removal
> X-Mailer: git-send-email 2.9.3
> 
> Refer to RFC patch - cryptodev: remove crypto device type enumeration
> 
> It is planned to remove device type enumeration rte_cryptodev_type from
> library to remove the coupling between crypto PMD and the librte_cryptodev.
> 
> In this case following stuctures will be changed: rte_cryptodev_session,
> rte_cryptodev_sym_session, rte_cryptodev_info, rte_cryptodev.
> 
> It is planned to change the function rte_cryptodev_count_devtype().
> The function prototype doesn’t clearly show the operation.
> From next release 17.08 the dev_type will be changed to driver_id.
> So the function name will change to rte_cryptodev_device_count_by_driver().
> 
> Signed-off-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>

Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
  
Fiona Trahe May 8, 2017, 1:30 p.m. UTC | #4
> -----Original Message-----

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Jerin Jacob

> Sent: Monday, May 8, 2017 12:05 PM

> To: Mrozowicz, SlawomirX <slawomirx.mrozowicz@intel.com>

> Cc: Doherty, Declan <declan.doherty@intel.com>; dev@dpdk.org

> Subject: Re: [dpdk-dev] [PATCH] doc: announce crypto device type enumeration

> removal

> 

> -----Original Message-----

> > Date: Fri, 5 May 2017 13:24:19 +0200

> > From: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>

> > To: declan.doherty@intel.com

> > CC: dev@dpdk.org, Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>

> > Subject: [dpdk-dev] [PATCH] doc: announce crypto device type enumeration

> >  removal

> > X-Mailer: git-send-email 2.9.3

> >

> > Refer to RFC patch - cryptodev: remove crypto device type enumeration

> >

> > It is planned to remove device type enumeration rte_cryptodev_type from

> > library to remove the coupling between crypto PMD and the librte_cryptodev.

> >

> > In this case following stuctures will be changed: rte_cryptodev_session,

> > rte_cryptodev_sym_session, rte_cryptodev_info, rte_cryptodev.

> >

> > It is planned to change the function rte_cryptodev_count_devtype().

> > The function prototype doesn’t clearly show the operation.

> > From next release 17.08 the dev_type will be changed to driver_id.

> > So the function name will change to rte_cryptodev_device_count_by_driver().

> >

> > Signed-off-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>

> 

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

Acked-by: Fiona Trahe <fiona.trahe@intel.com>
  
Akhil Goyal May 9, 2017, 8:55 a.m. UTC | #5
On 5/5/2017 4:54 PM, Slawomir Mrozowicz wrote:
> Refer to RFC patch - cryptodev: remove crypto device type enumeration
>
> It is planned to remove device type enumeration rte_cryptodev_type from
> library to remove the coupling between crypto PMD and the librte_cryptodev.
>
> In this case following stuctures will be changed: rte_cryptodev_session,
> rte_cryptodev_sym_session, rte_cryptodev_info, rte_cryptodev.
>
> It is planned to change the function rte_cryptodev_count_devtype().
> The function prototype doesn’t clearly show the operation.
> From next release 17.08 the dev_type will be changed to driver_id.
> So the function name will change to rte_cryptodev_device_count_by_driver().
>
> Signed-off-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>
> ---
> Refer to RFC patch: http://dpdk.org/dev/patchwork/patch/24119/
> ---
>  doc/guides/rel_notes/deprecation.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index a3e7c72..313dcdf 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -81,3 +81,11 @@ Deprecation Notices
>
>    - ``rte_crpytodev_scheduler_mode_get``, replaced by ``rte_cryptodev_scheduler_mode_get``
>    - ``rte_crpytodev_scheduler_mode_set``, replaced by ``rte_cryptodev_scheduler_mode_set``
> +
> +* cryptodev: The following changes will be done in in 17.08:
> +
> +  - the device type enumeration ``rte_cryptodev_type`` will be removed
> +  - the following structures will be changed: ``rte_cryptodev_session``,
> +    ``rte_cryptodev_sym_session``, ``rte_cryptodev_info``, ``rte_cryptodev``
> +  - the function ``rte_cryptodev_count_devtype`` will be replaced by
> +    ``rte_cryptodev_device_count_by_driver``
> \ No newline at end of file
>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
  
Thomas Monjalon May 11, 2017, 12:48 a.m. UTC | #6
> > Refer to RFC patch - cryptodev: remove crypto device type enumeration
> > 
> > It is planned to remove device type enumeration rte_cryptodev_type from
> > library to remove the coupling between crypto PMD and the
> > librte_cryptodev.
> > 
> > In this case following stuctures will be changed: rte_cryptodev_session,
> > rte_cryptodev_sym_session, rte_cryptodev_info, rte_cryptodev.
> > 
> > It is planned to change the function rte_cryptodev_count_devtype().
> > The function prototype doesn’t clearly show the operation.
> > From next release 17.08 the dev_type will be changed to driver_id.
> > So the function name will change to
> > rte_cryptodev_device_count_by_driver().
> > 
> > Signed-off-by: Slawomir Mrozowicz <slawomirx.mrozowicz@intel.com>
> 
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index a3e7c72..313dcdf 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -81,3 +81,11 @@  Deprecation Notices
 
   - ``rte_crpytodev_scheduler_mode_get``, replaced by ``rte_cryptodev_scheduler_mode_get``
   - ``rte_crpytodev_scheduler_mode_set``, replaced by ``rte_cryptodev_scheduler_mode_set``
+
+* cryptodev: The following changes will be done in in 17.08:
+
+  - the device type enumeration ``rte_cryptodev_type`` will be removed
+  - the following structures will be changed: ``rte_cryptodev_session``,
+    ``rte_cryptodev_sym_session``, ``rte_cryptodev_info``, ``rte_cryptodev``
+  - the function ``rte_cryptodev_count_devtype`` will be replaced by
+    ``rte_cryptodev_device_count_by_driver``
\ No newline at end of file