[dpdk-dev] [PATCH 07/11] doc: add document for AMD CCP crypto PMD

[De Lara Guarch, Pablo]

Hi Ravi,

> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Ravi Kumar
> Sent: Thursday, November 30, 2017 1:12 PM
> To: dev at dpdk.org
> Subject: [dpdk-dev] [PATCH 07/11] doc: add document for AMD CCP crypto
> PMD
> 
> Signed-off-by: Ravi Kumar <Ravi1.kumar at amd.com>
> ---
>  doc/guides/cryptodevs/ccp.rst          | 124
> +++++++++++++++++++++++++++++++++
>  doc/guides/cryptodevs/features/ccp.ini |  57 +++++++++++++++
>  doc/guides/cryptodevs/index.rst        |   1 +
>  3 files changed, 182 insertions(+)
>  create mode 100644 doc/guides/cryptodevs/ccp.rst  create mode 100644
> doc/guides/cryptodevs/features/ccp.ini
> 
> diff --git a/doc/guides/cryptodevs/ccp.rst b/doc/guides/cryptodevs/ccp.rst
> new file mode 100644 index 0000000..b39af1d
> --- /dev/null
> +++ b/doc/guides/cryptodevs/ccp.rst
> @@ -0,0 +1,124 @@
> +.. Copyright(c) 2017 Advanced Micro Devices, Inc.
> +   All rights reserved.
> +
> +   Redistribution and use in source and binary forms, with or without
> +   modification, are permitted provided that the following conditions
> +   are met:
> +
> +   * Redistributions of source code must retain the above copyright
> +   notice, this list of conditions and the following disclaimer.
> +   * Redistributions in binary form must reproduce the above copyright
> +   notice, this list of conditions and the following disclaimer in the
> +   documentation and/or other materials provided with the distribution.
> +   * Neither the name of the copyright holder nor the names of its
> +   contributors may be used to endorse or promote products derived from
> +   this software without specific prior written permission.
> +
> +   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
> CONTRIBUTORS
> +   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
> NOT
> +   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
> FITNESS FOR
> +   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
> COPYRIGHT
> +   HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
> INCIDENTAL,
> +   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
> NOT
> +   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
> OF USE,
> +   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
> AND ON ANY
> +   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
> +   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
> THE USE
> +   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
> DAMAGE.
> +
> +AMD CCP Poll Mode Driver
> +========================
> +
> +This code provides the initial implementation of the ccp poll mode driver.
> +The CCP poll mode driver library (librte_pmd_ccp) implements support
> +for AMD’s cryptographic co-processor (CCP). The CCP PMD is a virtual
> +crypto poll mode driver which schedules crypto operations to one or
> +more available CCP hardware engines on the platform. The CCP PMD
> +provides poll mode crypto driver support for the following hardware
> accelerator devices::
> +
> +	AMD Cryptographic Co-processor (0x1456)
> +	AMD Cryptographic Co-processor (0x1468)
> +
> +Features
> +--------
> +
> +CCP PMD has support for:
> +
> +Supported cipher algorithms:

A blank line is required before starting a list
(same for the other two lists).

> +* ``RTE_CRYPTO_CIPHER_AES_CBC``
> +* ``RTE_CRYPTO_CIPHER_AES_ECB``
> +* ``RTE_CRYPTO_CIPHER_AES_CTR``
> +* ``RTE_CRYPTO_CIPHER_3DES_CBC``
> +