[dpdk-dev] [PATCH v4 14/15] doc: add caam jr cryptodev details

Gagandeep Singh G.Singh at nxp.com
Mon Oct 22 16:18:03 CEST 2018

From: Hemant Agrawal <hemant.agrawal at nxp.com>

add caam jr driver details, supported features and algorithms
in the document.

release note and MAINTAINERS are also updated.

Signed-off-by: Hemant Agrawal <hemant.agrawal at nxp.com>
Signed-off-by: Gagandeep Singh <g.singh at nxp.com>
Acked-by: Akhil Goyal <akhil.goyal at nxp.com>
 MAINTAINERS                                |   2 +
 doc/guides/cryptodevs/caam_jr.rst          | 150 +++++++++++++++++++++
 doc/guides/cryptodevs/features/caam_jr.ini |  46 +++++++
 doc/guides/cryptodevs/index.rst            |   1 +
 doc/guides/rel_notes/release_18_11.rst     |   5 +
 5 files changed, 204 insertions(+)
 create mode 100644 doc/guides/cryptodevs/caam_jr.rst
 create mode 100644 doc/guides/cryptodevs/features/caam_jr.ini

index 9de01189a..3079c187e 100644
@@ -855,6 +855,8 @@ NXP CAAM JR
 M: Gagandeep Singh <g.singh at nxp.com>
 M: Hemant Agrawal <hemant.agrawal at nxp.com>
 F: drivers/crypto/caam_jr/
+F: doc/guides/cryptodevs/caam_jr.rst
+F: doc/guides/cryptodevs/features/caam_jr.ini
 M: Akhil Goyal <akhil.goyal at nxp.com>
diff --git a/doc/guides/cryptodevs/caam_jr.rst b/doc/guides/cryptodevs/caam_jr.rst
new file mode 100644
index 000000000..e87ff0915
--- /dev/null
+++ b/doc/guides/cryptodevs/caam_jr.rst
@@ -0,0 +1,150 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright 2018 NXP
+NXP CAAM JOB RING (caam_jr)
+The caam_jr PMD provides poll mode crypto driver support for NXP SEC 4.x+ (CAAM)
+hardware accelerator. More information is available at:
+`NXP Cryptographic Acceleration Technology  <https://www.nxp.com/applications/solutions/internet-of-things/secure-things/network-security-technology/cryptographic-acceleration-technology:NETWORK_SECURITY_CRYPTOG>`_.
+SEC is the SOC's security engine, which serves as NXP's latest cryptographic
+acceleration and offloading hardware. It combines functions previously
+implemented in separate modules to create a modular and scalable acceleration
+and assurance engine. It also implements block encryption algorithms, stream
+cipher algorithms, hashing algorithms, public key algorithms, run-time
+integrity checking, and a hardware random number generator. SEC performs
+higher-level cryptographic operations than previous NXP cryptographic
+accelerators. This provides significant improvement to system level performance.
+SEC HW accelerator above 4.x+ version are also known as CAAM.
+caam_jr PMD is one of DPAA drivers which uses uio interface to interact with
+Linux kernel for configure and destroy the device instance (ring).
+SEC provides platform assurance by working with SecMon, which is a companion
+logic block that tracks the security state of the SOC. SEC is programmed by
+means of descriptors (not to be confused with frame descriptors (FDs)) that
+indicate the operations to be performed and link to the message and
+associated data. SEC incorporates two DMA engines to fetch the descriptors,
+read the message data, and write the results of the operations. The DMA
+engine provides a scatter/gather capability so that SEC can read and write
+data scattered in memory. SEC may be configured by means of software for
+dynamic changes in byte ordering. The default configuration for this version
+of SEC is little-endian mode.
+Note that one physical Job Ring represent one caam_jr device.
+The CAAM_JR PMD has support for:
+Cipher algorithms:
+Hash algorithms:
+AEAD algorithms:
+Supported DPAA SoCs
+* LS1046A/LS1026A
+* LS1043A/LS1023A
+* LS1028A
+* LS1012A
+* Hash followed by Cipher mode is not supported
+* Only supports the session-oriented API implementation (session-less APIs are not supported).
+caam_jr driver has following dependencies are not part of DPDK and must be installed separately:
+* **NXP Linux SDK**
+  NXP Linux software development kit (SDK) includes support for the family
+  of QorIQ® ARM-Architecture-based system on chip (SoC) processors
+  and corresponding boards.
+  It includes the Linux board support packages (BSPs) for NXP SoCs,
+  a fully operational tool chain, kernel and board specific modules.
+  SDK and related information can be obtained from:  `NXP QorIQ SDK  <http://www.nxp.com/products/software-and-tools/run-time-software/linux-sdk/linux-sdk-for-qoriq-processors:SDKLINUX>`_.
+Currently supported by DPDK:
+* NXP SDK **18.09+**.
+* Supported architectures:  **arm64 LE**.
+* Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
+Pre-Installation Configuration
+Config File Options
+The following options can be modified in the ``config`` file
+to enable caam_jr PMD.
+Please note that enabling debugging options may affect system performance.
+* ``CONFIG_RTE_LIBRTE_PMD_CAAM_JR`` (default ``n``)
+  By default it is only enabled in common_linuxapp config.
+  Toggle compilation of the ``librte_pmd_caam_jr`` driver.
+* ``CONFIG_RTE_LIBRTE_PMD_CAAM_JR_BE`` (default ``n``)
+  By default it is disabled.
+  It can be used when the underlying hardware supports the CAAM in BE mode.
+  e.g. LS1043A, LS1046A supports CAAM in BE mode.
+  BE mode is enabled by default in defconfig-arm64-dpaa-linuxapp-gcc.
+To compile the caam_jr PMD for Linux arm64 gcc target, run the
+following ``make`` command:
+.. code-block:: console
+   cd <DPDK-source-directory>
+   make config T=arm64-armv8a-linuxapp-gcc install
+Enabling logs
+For enabling logs, use the following EAL parameter:
+.. code-block:: console
+   ./your_crypto_application <EAL args> --log-level=pmd.crypto.caam,<level>
diff --git a/doc/guides/cryptodevs/features/caam_jr.ini b/doc/guides/cryptodevs/features/caam_jr.ini
new file mode 100644
index 000000000..68f8d8195
--- /dev/null
+++ b/doc/guides/cryptodevs/features/caam_jr.ini
@@ -0,0 +1,46 @@
+; Supported features of the 'caam_jr' crypto driver.
+; Refer to default.ini for the full list of available PMD features.
+Symmetric crypto       = Y
+Sym operation chaining = Y
+HW Accelerated         = Y
+Protocol offload       = Y
+In Place SGL           = Y
+OOP SGL In SGL Out     = Y
+OOP SGL In LB  Out     = Y
+OOP LB  In SGL Out     = Y
+OOP LB  In LB  Out     = Y
+; Supported crypto algorithms of the 'dpaa2_sec' crypto driver.
+AES CBC (128) = Y
+AES CBC (192) = Y
+AES CBC (256) = Y
+AES CTR (128) = Y
+AES CTR (192) = Y
+AES CTR (256) = Y
+3DES CBC      = Y
+; Supported authentication algorithms of the 'dpaa2_sec' crypto driver.
+MD5 HMAC     = Y
+SHA1 HMAC    = Y
+SHA224 HMAC  = Y
+SHA256 HMAC  = Y
+SHA384 HMAC  = Y
+SHA512 HMAC  = Y
+; Supported AEAD algorithms of the 'dpaa2_sec' crypto driver.
+AES GCM (128) = Y
+AES GCM (192) = Y
+AES GCM (256) = Y
diff --git a/doc/guides/cryptodevs/index.rst b/doc/guides/cryptodevs/index.rst
index bd1588537..83610e64f 100644
--- a/doc/guides/cryptodevs/index.rst
+++ b/doc/guides/cryptodevs/index.rst
@@ -13,6 +13,7 @@ Crypto Device Drivers
+    caam_jr
diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst
index a0dd1bed9..af9a6f89f 100644
--- a/doc/guides/rel_notes/release_18_11.rst
+++ b/doc/guides/rel_notes/release_18_11.rst
@@ -186,6 +186,11 @@ New Features
   The AESNI MB PMD has been updated with additional support for AES-GCM
   algorithm support.
+* **Added NXP CAAM JR PMD.**
+  Added the new caam job ring driver for NXP platforms. See the
+  "NXP CAAM JOB RING (caam_jr)" document for more details on this new driver.
 API Changes

More information about the dev mailing list