13. MVSAM Crypto Poll Mode Driver

The MVSAM CRYPTO PMD (librte_crypto_mvsam_pmd) provides poll mode crypto driver support by utilizing MUSDK library, which provides cryptographic operations acceleration by using Security Acceleration Engine (EIP197) directly from user-space with minimum overhead and high performance.

Detailed information about SoCs that use MVSAM crypto driver can be obtained here:

13.1. Features

MVSAM CRYPTO PMD has support for:

Cipher algorithms:

RTE_CRYPTO_CIPHER_NULL
RTE_CRYPTO_CIPHER_AES_CBC
RTE_CRYPTO_CIPHER_AES_CTR
RTE_CRYPTO_CIPHER_AES_ECB
RTE_CRYPTO_CIPHER_3DES_CBC
RTE_CRYPTO_CIPHER_3DES_CTR
RTE_CRYPTO_CIPHER_3DES_ECB

Hash algorithms:

RTE_CRYPTO_AUTH_NULL
RTE_CRYPTO_AUTH_MD5
RTE_CRYPTO_AUTH_MD5_HMAC
RTE_CRYPTO_AUTH_SHA1
RTE_CRYPTO_AUTH_SHA1_HMAC
RTE_CRYPTO_AUTH_SHA224
RTE_CRYPTO_AUTH_SHA224_HMAC
RTE_CRYPTO_AUTH_SHA256
RTE_CRYPTO_AUTH_SHA256_HMAC
RTE_CRYPTO_AUTH_SHA384
RTE_CRYPTO_AUTH_SHA384_HMAC
RTE_CRYPTO_AUTH_SHA512
RTE_CRYPTO_AUTH_SHA512_HMAC
RTE_CRYPTO_AUTH_AES_GMAC

AEAD algorithms:

RTE_CRYPTO_AEAD_AES_GCM

For supported feature flags please consult Crypto Device Supported Functionality Matrices.

13.2. Limitations

Hardware only supports scenarios where ICV (digest buffer) is placed just after the authenticated data. Other placement will result in error.

13.3. Installation

MVSAM CRYPTO PMD driver compilation is disabled by default due to external dependencies. Currently there are two driver specific compilation options in config/common_base available:

CONFIG_RTE_LIBRTE_PMD_MVSAM_CRYPTO (default: n)

Toggle compilation of the librte_pmd_mvsam driver.

MVSAM CRYPTO PMD requires MUSDK built with EIP197 support thus following extra option must be passed to the library configuration script:

--enable-sam [--enable-sam-statistics] [--enable-sam-debug]

For instructions how to build required kernel modules please refer to doc/musdk_get_started.txt.

13.4. Initialization

After successfully building MVSAM CRYPTO PMD, the following modules need to be loaded:

insmod musdk_cma.ko
insmod crypto_safexcel.ko rings=0,0
insmod mv_sam_uio.ko

The following parameters (all optional) are exported by the driver:

max_nb_queue_pairs: maximum number of queue pairs in the device (default: 8 - A8K, 4 - A7K/A3K).
max_nb_sessions: maximum number of sessions that can be created (default: 2048).
socket_id: socket on which to allocate the device resources on.

l2fwd-crypto example application can be used to verify MVSAM CRYPTO PMD operation:

./l2fwd-crypto --vdev=eth_mvpp2,iface=eth0 --vdev=crypto_mvsam -- \
  --cipher_op ENCRYPT --cipher_algo aes-cbc \
  --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f  \
  --auth_op GENERATE --auth_algo sha1-hmac \
  --auth_key 10:11:12:13:14:15:16:17:18:19:1a:1b:1c:1d:1e:1f