X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcryptodevs%2Fdpaa_sec.rst;h=bac82421bca22c9c1043baede347d532727bd146;hb=b80c527a9ca4b8aa5ed1d8fba4e7882213883485;hp=b98f78646165c4d60096950405df0528e0b4f6f8;hpb=d81734caccade4dc17d24d2ffd8b71244d35a69f;p=dpdk.git diff --git a/doc/guides/cryptodevs/dpaa_sec.rst b/doc/guides/cryptodevs/dpaa_sec.rst index b98f786461..bac82421bc 100644 --- a/doc/guides/cryptodevs/dpaa_sec.rst +++ b/doc/guides/cryptodevs/dpaa_sec.rst @@ -58,6 +58,8 @@ Cipher algorithms: * ``RTE_CRYPTO_CIPHER_AES128_CTR`` * ``RTE_CRYPTO_CIPHER_AES192_CTR`` * ``RTE_CRYPTO_CIPHER_AES256_CTR`` +* ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2`` +* ``RTE_CRYPTO_CIPHER_ZUC_EEA3`` Hash algorithms: @@ -66,7 +68,9 @@ Hash algorithms: * ``RTE_CRYPTO_AUTH_SHA256_HMAC`` * ``RTE_CRYPTO_AUTH_SHA384_HMAC`` * ``RTE_CRYPTO_AUTH_SHA512_HMAC`` +* ``RTE_CRYPTO_AUTH_SNOW3G_UIA2`` * ``RTE_CRYPTO_AUTH_MD5_HMAC`` +* ``RTE_CRYPTO_AUTH_ZUC_EIA3`` AEAD algorithms: @@ -78,10 +82,22 @@ Supported DPAA SoCs * LS1046A/LS1026A * LS1043A/LS1023A +Allowing & Blocking +------------------- + +For blocking a DPAA device, following commands can be used. + + .. code-block:: console + + -b "dpaa:dpaa_sec-X" -- ... + e.g. "dpaa:dpaa_sec-1" + + or to disable all 4 SEC devices + -b "dpaa:dpaa_sec-1" -b "dpaa:dpaa_sec-2" -b "dpaa:dpaa_sec-3" -b "dpaa:dpaa_sec-4" + Limitations ----------- -* Chained mbufs are not supported. * Hash followed by Cipher mode is not supported * Only supports the session-oriented API implementation (session-less APIs are not supported). @@ -89,69 +105,21 @@ Prerequisites ------------- DPAA_SEC driver has similar pre-requisites as described in :ref:`dpaa_overview`. -The 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 `_. - -* **DPDK Extras Scripts** - - DPAA based resources can be configured easily with the help of ready scripts - as provided in the DPDK Extras repository. - `DPDK Extras Scripts `_. +See :doc:`../platform/dpaa` for setup information -Currently supported by DPDK: -* NXP SDK **2.0+**. -* Supported architectures: **arm64 LE**. +- Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. -* Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -Basic DPAA config file options are described in :ref:`dpaa_overview`. -In addition to those, the following options can be modified in the ``config`` file -to enable DPAA_SEC PMD. - -Please note that enabling debugging options may affect system performance. - -* ``CONFIG_RTE_LIBRTE_PMD_DPAA_SEC`` (default ``n``) - By default it is only enabled in defconfig_arm64-dpaa-* config. - Toggle compilation of the ``librte_pmd_dpaa_sec`` driver. - -* ``CONFIG_RTE_LIBRTE_DPAA_SEC_DEBUG_INIT`` (default ``n``) - Toggle display of initialization related driver messages - -* ``CONFIG_RTE_LIBRTE_DPAA_SEC_DEBUG_DRIVER`` (default ``n``) - Toggle display of driver runtime messages - -* ``CONFIG_RTE_LIBRTE_DPAA_SEC_DEBUG_RX`` (default ``n``) - Toggle display of receive fast path run-time message - -* ``CONFIG_RTE_DPAA_SEC_PMD_MAX_NB_SESSIONS`` - By default it is set as 2048 in defconfig_arm64-dpaa-* config. - It indicates Number of sessions to create in the session memory pool - on a single DPAA SEC device. - -Installations +Enabling logs ------------- -To compile the DPAA_SEC PMD for Linux arm64 gcc target, run the -following ``make`` command: + +For enabling logs, use the following EAL parameter: .. code-block:: console - cd - make config T=arm64-dpaa-linuxapp-gcc install + ./your_crypto_application --log-level=pmd.crypto.dpaa: + +Using ``pmd.crypto.dpaa`` as log matching criteria, all Crypto PMD logs can be +enabled which are lower than logging ``level``.