[dpdk-dev] [PATCH 11/11] doc: add documentation for OCTEON TX2 crypto PMD

[Jerin Jacob Kollanukkaran]

> -----Original Message-----
> From: Anoob Joseph <anoobj at marvell.com>
> Sent: Friday, August 30, 2019 11:58 AM
> To: Akhil Goyal <akhil.goyal at nxp.com>; Pablo de Lara
> <pablo.de.lara.guarch at intel.com>; Thomas Monjalon
> <thomas at monjalon.net>
> Cc: Anoob Joseph <anoobj at marvell.com>; Jerin Jacob Kollanukkaran
> <jerinj at marvell.com>; Narayana Prasad Raju Athreya
> <pathreya at marvell.com>; Ankur Dwivedi <adwivedi at marvell.com>;
> Tejasree Kondoj <ktejasree at marvell.com>; dev at dpdk.org
> Subject: [PATCH 11/11] doc: add documentation for OCTEON TX2 crypto PMD
> 
> Adding feature list and user guide for OCTEONTX2 crypto PMD.
> 
> Signed-off-by: Ankur Dwivedi <adwivedi at marvell.com>
> Signed-off-by: Anoob Joseph <anoobj at marvell.com>
> ---
>  MAINTAINERS                                  |   7 ++
>  doc/guides/cryptodevs/features/octeontx2.ini |  62 ++++++++++++
>  doc/guides/cryptodevs/index.rst              |   1 +
>  doc/guides/cryptodevs/octeontx2.rst          | 142
> +++++++++++++++++++++++++++
>  doc/guides/platform/octeontx2.rst            |   3 +

Please update the doc/guides/rel_notes/release_19_11.rst

>  5 files changed, 215 insertions(+)
>  create mode 100644 doc/guides/cryptodevs/features/octeontx2.ini
>  create mode 100644 doc/guides/cryptodevs/octeontx2.rst
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 4100260..eef64f7 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -965,6 +965,13 @@ F: drivers/crypto/mvsam/
>  F: doc/guides/cryptodevs/mvsam.rst
>  F: doc/guides/cryptodevs/features/mvsam.ini
> 
> +Marvell OCTEON TX2 crypto
> +M: Ankur Dwivedi <adwivedi at marvell.com>
> +M: Anoob Joseph <anoobj at marvell.com>
> +F: drivers/crypto/octeontx2/
> +F: doc/guides/cryptodevs/octeontx2.rst
> +F: doc/guides/cryptodevs/features/octeontx2.ini


Move this section, next to OCTEON TX.

> +
>  Null Crypto
>  M: Declan Doherty <declan.doherty at intel.com>
>  F: drivers/crypto/null/
> diff --git a/doc/guides/cryptodevs/features/octeontx2.ini
> b/doc/guides/cryptodevs/features/octeontx2.ini
> new file mode 100644
> index 0000000..ac76b11
> +Initialization
> +--------------
> +
> +List the CPT PF devices available on your OCTEON TX2 platform:
> +
> +.. code-block:: console
> +
> +    lspci -d:a0fd

Change to use standard DPDK usertools/dpdk-devbind.py script.

> +
> +``a0fd`` is the CPT PF device id. You should see output similar to:
> +
> +.. code-block:: console
> +
> +    0002:10:00.0 Class 1080: Device 177d:a0fd
> +
> +Set ``sriov_numvfs`` on the CPT PF device, to create a VF:
> +
> +.. code-block:: console
> +
> +    echo 1 > /sys/bus/pci/drivers/octeontx2-cpt/0002:10:00.0/sriov_numvfs
> +
> +Bind the CPT VF device to the vfio_pci driver:
> +
> +.. code-block:: console
> +
> +    echo '177d a0fe' > /sys/bus/pci/drivers/vfio-pci/new_id
> +    echo 0002:10:00.1 > /sys/bus/pci/devices/0002:10:00.1/driver/unbind
> +    echo 0002:10:00.1 > /sys/bus/pci/drivers/vfio-pci/bind
> +
> +Another way to bind the VF would be to use the ``dpdk-devbind.py`` script:

I think, we can mention only the standard usertools/dpdk-devbind.py scheme.