[dpdk-dev,v3] doc: add info on multiple instance SW crypto
Checks
Commit Message
Add infomration to explain applications using multiple instances of sw
crypto with example.
Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---
V3 Changes:
- moved the multiple sw crypto to more generic place holder - Pablo
V2 Changes:
- Updated Note for better wording - Pablo
- Multiple instance information to Crypto Device Lib - Pablo
---
doc/guides/prog_guide/cryptodev_lib.rst | 9 +++++++++
1 file changed, 9 insertions(+)
Comments
> -----Original Message-----
> From: Varghese, Vipin
> Sent: Tuesday, February 6, 2018 4:12 PM
> To: dev@dpdk.org; De Lara Guarch, Pablo
> <pablo.de.lara.guarch@intel.com>
> Cc: stable@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>;
> Kovacevic, Marko <marko.kovacevic@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>
> Subject: [PATCH v3] doc: add info on multiple instance SW crypto
>
> Add infomration to explain applications using multiple instances of sw
> crypto with example.
>
> Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> ---
>
> V3 Changes:
> - moved the multiple sw crypto to more generic place holder - Pablo
>
> V2 Changes:
> - Updated Note for better wording - Pablo
> - Multiple instance information to Crypto Device Lib - Pablo
> ---
> doc/guides/prog_guide/cryptodev_lib.rst | 9 +++++++++
> 1 file changed, 9 insertions(+)
>
> diff --git a/doc/guides/prog_guide/cryptodev_lib.rst
> b/doc/guides/prog_guide/cryptodev_lib.rst
> index 2b338b9..d11e377 100644
> --- a/doc/guides/prog_guide/cryptodev_lib.rst
> +++ b/doc/guides/prog_guide/cryptodev_lib.rst
> @@ -70,6 +70,15 @@ From the command line using the --vdev EAL option
>
> --vdev
> 'crypto_aesni_mb0,max_nb_queue_pairs=2,max_nb_sessions=1024,socket
> _id=0'
>
> +.. Note::
> +
> + * If DPDK application requires multiple software crypto PMD devices
> then required
> + number of ``--vdev`` with appropriate libraries are to be added.
> +
> + * An Application with crypto PMD instaces sharing the same library
> requires unique ID.
Typo: instances (which could be fixed when merging).
Also, there is no need to add stable@dpdk.org, so I will remove it from the CC list.
Apart from this:
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> > Add infomration to explain applications using multiple instances of sw
> > crypto with example.
> >
> > Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
>
> Typo: instances (which could be fixed when merging).
>
> Also, there is no need to add stable@dpdk.org, so I will remove it from the CC list.
>
> Apart from this:
>
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Applied, thanks
@@ -70,6 +70,15 @@ From the command line using the --vdev EAL option
--vdev 'crypto_aesni_mb0,max_nb_queue_pairs=2,max_nb_sessions=1024,socket_id=0'
+.. Note::
+
+ * If DPDK application requires multiple software crypto PMD devices then required
+ number of ``--vdev`` with appropriate libraries are to be added.
+
+ * An Application with crypto PMD instaces sharing the same library requires unique ID.
+
+ Example: ``--vdev 'crypto_aesni_mb0' --vdev 'crypto_aesni_mb1'``
+
Our using the rte_vdev_init API within the application code.
.. code-block:: c