[dpdk-dev] [PATCH 15/16] doc: add Cavium's CPT guide

[De Lara Guarch, Pablo]

> -----Original Message-----
> From: Anoob Joseph [mailto:anoob.joseph at caviumnetworks.com]
> Sent: Friday, June 8, 2018 5:45 PM
> To: Akhil Goyal <akhil.goyal at nxp.com>; De Lara Guarch, Pablo
> <pablo.de.lara.guarch at intel.com>; Thomas Monjalon <thomas at monjalon.net>
> Cc: Ragothaman Jayaraman <Ragothaman.Jayaraman at cavium.com>; Ankur
> Dwivedi <ankur.dwivedi at cavium.com>; Jerin Jacob
> <jerin.jacob at caviumnetworks.com>; Murthy NSSR
> <Nidadavolu.Murthy at cavium.com>; Narayana Prasad
> <narayanaprasad.athreya at caviumnetworks.com>; Nithin Dabilpuram
> <nithin.dabilpuram at cavium.com>; Srisivasubramanian Srinivasan
> <Srisivasubramanian.Srinivasan at cavium.com>; dev at dpdk.org
> Subject: [PATCH 15/16] doc: add Cavium's CPT guide
> 
> From: Ragothaman Jayaraman <Ragothaman.Jayaraman at cavium.com>
> 
> The guide contains information about packages needed to compile the CPT
> PMD. It also contains the compilation steps and how to execute an examples
> application.

You need to add the guide in index.rst.
Also, you should add cpt.ini under doc/guides/cryptodevs/features/.


> 
> Signed-off-by: Ankur Dwivedi <ankur.dwivedi at cavium.com>
> Signed-off-by: Murthy NSSR <Nidadavolu.Murthy at cavium.com>
> Signed-off-by: Nithin Dabilpuram <nithin.dabilpuram at cavium.com>
> Signed-off-by: Ragothaman Jayaraman
> <Ragothaman.Jayaraman at cavium.com>
> Signed-off-by: Srisivasubramanian Srinivasan
> <Srisivasubramanian.Srinivasan at cavium.com>
> ---
>  doc/guides/cryptodevs/cpt.rst | 112
> ++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 112 insertions(+)
>  create mode 100644 doc/guides/cryptodevs/cpt.rst
> 
> diff --git a/doc/guides/cryptodevs/cpt.rst b/doc/guides/cryptodevs/cpt.rst new
> file mode 100644 index 0000000..262ce9e
> --- /dev/null
> +++ b/doc/guides/cryptodevs/cpt.rst
> @@ -0,0 +1,112 @@
> +.. SPDX-License-Identifier: BSD-3-Clause
> +   Copyright(c) 2017 Cavium, Inc
> +
> +*****************************
> +Cavium's CPT Poll Mode Driver
> +******************************

Please, use the standard title underlines used in other guides
("=" for title, "-" for section, "~" for subsection).

> +
> +The CPT poll mode driver provides support for offloading cryptographic
> +operations on the Cavium's cryptographic accelerator unit(CPT)
> +coprocessor hardware. This coprocessor is present on the Cavium's thunder
> boards(CN8xxx).

...

> +Compilation
> +############
> +
> +The thunder board must be running the linux kernel based on sdk-6.2.0 patch 2.
> +In this the cpt pf driver is already built in. Also install the openssl
> +package, because the cpt driver depends on the crypto library.

Is this true? I could compile this without openssl.

> +
> +For compiling the cpt poll mode driver, the CONFIG_RTE_LIBRTE_PMD_CPT
> +setting should be made as `y` in config/common_base file. By default it is set to
> `n`.
> +

...

> +Then the corresponding vf should be binded to the vfio-pci driver using
> +the
> +following:
> +
> +.. code-block:: console
> +
> +        cd <dpdk directory>
> +        ./usertools/dpdk-devbind.py -u <vf device no>
> +        ./usertools/dpdk-devbind.py -bvfio-pci <vf device no>

Space between -b and vfio-pci?