Hi David,
> Subject: [PATCH v3 8/8] doc: add doc updates for DOCSIS security protocol
>
> Update Security library, AESNI-MB crypto PMD, QAT crypto PMD,
> dpdk-test-crypto-perf tool and release note documentation for DOCSIS
> protocol support.
>
> Signed-off-by: David Coyle <david.co...@intel.com>
> Signed-off-by: Mairtin o Loingsigh <mairtin.oloings...@intel.com>
Overall the patches looks good. However, I will do a detailed review soon.
> ---
> doc/guides/cryptodevs/aesni_mb.rst | 8 ++
> doc/guides/cryptodevs/features/aesni_mb.ini | 1 +
> doc/guides/cryptodevs/features/qat.ini | 1 +
> doc/guides/cryptodevs/qat.rst | 7 ++
> doc/guides/prog_guide/rte_security.rst | 114 +++++++++++++++++++-
> doc/guides/rel_notes/release_20_08.rst | 16 +++
> doc/guides/tools/cryptoperf.rst | 5 +
> 7 files changed, 150 insertions(+), 2 deletions(-)
This patch should be split and merged to relevant other patches in the series.
rte_security related in 1/8
Like aesni-mb related changes should go in 3/8
qat related should be part of 4/8
crypto-perf should be part of 7/8
And release notes should also be split into 3 different entries and squashed
into
Rte_security, qat and aesni-mb patches.
<snip>
> +The encryption/decryption is a combination of CBC and CFB modes using either
> AES
> +or DES algorithms as specified in the DOCSIS Security Specification (from
> DPDK
> +lib_rtecryptodev perspective, these are RTE_CRYPTO_CIPHER_AES_DOCSISBPI
> and
> +RTE_CRYPTO_CIPHER_DES_DOCSISBPI).
> +
> +The CRC is Ethernet CRC-32 as specified in Ethernet/[ISO/IEC 8802-3].
> +
> +.. note::
> +
> + * The CRC offset and length are specified via the auth offset and
> + length fields of the rte_crypto_sym_op.
The above note is not correct. It should be
* The offset and length of data for which CRC need to be computed are specified
via the auth offset and length fields of the rte_crypto_sym_op.
> + * Other DOCSIS protocol functionality such as Header Checksum (HCS)
> + calculation may be added in the future.
> +
> Device Features and Capabilities
> ---------------------------------
>
<snip>
> diff --git a/doc/guides/rel_notes/release_20_08.rst
> b/doc/guides/rel_notes/release_20_08.rst
> index 39064afbe..0e72a26b1 100644
> --- a/doc/guides/rel_notes/release_20_08.rst
> +++ b/doc/guides/rel_notes/release_20_08.rst
> @@ -56,6 +56,22 @@ New Features
> Also, make sure to start the actual text at the margin.
> =========================================================
>
> +* **Added support for DOCSIS protocol to rte_security.**
> +
> + Added support for combined crypto and CRC operations for the DOCSIS
> protocol
> + to ``rte_security``. Test and test-crypto-perf applications have been
> updated
> + for unit testing.
Split this release note entry into two, 1 for 1/8 and one for 7/8
> +
> +* **Updated the AESNI MB crypto PMD.**
> +
> + Added support for lookaside protocol offload for DOCSIS through the
> + ``rte_security`` API.
> +
> +* **Updated the QuickAssist Technology (QAT) Crypto PMD.**
> +
> + Added support for lookaside protocol offload for DOCSIS through the
> + ``rte_security`` API.
> +
>
