X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcryptodevs%2Focteontx.rst;h=d813cb2974cfbfacf91309a275d3f7ec11ba7112;hb=5a3cca342417f7d4be4ac4b6225ca509617777c4;hp=660e980ccfb4178edaf0731a65088027d9b53635;hpb=9c4491cf5c89a015cf358011151a92b9cba78560;p=dpdk.git diff --git a/doc/guides/cryptodevs/octeontx.rst b/doc/guides/cryptodevs/octeontx.rst index 660e980ccf..d813cb2974 100644 --- a/doc/guides/cryptodevs/octeontx.rst +++ b/doc/guides/cryptodevs/octeontx.rst @@ -10,8 +10,8 @@ cryptographic operations to cryptographic accelerator units on poll mode driver enqueues the crypto request to this accelerator and dequeues the response once the operation is completed. -Supported Algorithms --------------------- +Supported Symmetric Crypto Algorithms +------------------------------------- Cipher Algorithms ~~~~~~~~~~~~~~~~~ @@ -53,35 +53,28 @@ AEAD Algorithms * ``RTE_CRYPTO_AEAD_AES_GCM`` -Compilation ------------ +Supported Asymmetric Crypto Algorithms +-------------------------------------- -The **OCTEON TX** :sup:`®` board must be running the linux kernel based on -sdk-6.2.0 patch 3. In this, the OCTEON TX crypto PF driver is already built in. +* ``RTE_CRYPTO_ASYM_XFORM_RSA`` +* ``RTE_CRYPTO_ASYM_XFORM_MODEX`` -For compiling the OCTEON TX crypto poll mode driver, please check if the -CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO setting is set to `y` in -config/common_base file. -* ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO=y`` +Compilation +----------- -The following are the steps to compile the OCTEON TX crypto poll mode driver: +The OCTEON TX crypto poll mode driver can be compiled either natively on +**OCTEON TX** :sup:`®` board or cross-compiled on an x86 based platform. -.. code-block:: console +Refer :doc:`../platform/octeontx` for details about setting up the platform +and building DPDK applications. - cd - make config T=arm64-thunderx-linuxapp-gcc - make - -The example applications can be compiled using the following: +.. note:: -.. code-block:: console + OCTEON TX crypto PF driver needs microcode to be available at `/lib/firmware/` directory. + Refer SDK documents for further information. - cd - export RTE_SDK=$PWD - export RTE_TARGET=build - cd examples/ - make +SDK and related information can be obtained from: `Cavium support site `_. Execution --------- @@ -125,3 +118,22 @@ OCTEON TX crypto PMD. ./build/ipsec-secgw --log-level=8 -c 0xff -- -P -p 0x3 -u 0x2 --config "(1,0,0),(0,0,0)" -f ep1.cfg + +Testing +------- + +The symmetric crypto operations on OCTEON TX crypto PMD may be verified by running the test +application: + +.. code-block:: console + + ./dpdk-test + RTE>>cryptodev_octeontx_autotest + +The asymmetric crypto operations on OCTEON TX crypto PMD may be verified by running the test +application: + +.. code-block:: console + + ./dpdk-test + RTE>>cryptodev_octeontx_asym_autotest