diff options
Diffstat (limited to 'doc/guides/prog_guide/cryptodev_lib.rst')
| -rw-r--r-- | doc/guides/prog_guide/cryptodev_lib.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst index 8ee33c87..23770ffd 100644 --- a/doc/guides/prog_guide/cryptodev_lib.rst +++ b/doc/guides/prog_guide/cryptodev_lib.rst @@ -14,7 +14,7 @@ and AEAD symmetric and asymmetric Crypto operations. Design Principles ----------------- -The cryptodev library follows the same basic principles as those used in DPDKs +The cryptodev library follows the same basic principles as those used in DPDK's Ethernet Device framework. The Crypto framework provides a generic Crypto device framework which supports both physical (hardware) and virtual (software) Crypto devices as well as a generic Crypto API which allows Crypto devices to be @@ -48,7 +48,7 @@ From the command line using the --vdev EAL option * If DPDK application requires multiple software crypto PMD devices then required number of ``--vdev`` with appropriate libraries are to be added. - * An Application with crypto PMD instaces sharing the same library requires unique ID. + * An Application with crypto PMD instances sharing the same library requires unique ID. Example: ``--vdev 'crypto_aesni_mb0' --vdev 'crypto_aesni_mb1'`` @@ -382,7 +382,7 @@ Operation Management and Allocation The cryptodev library provides an API set for managing Crypto operations which utilize the Mempool Library to allocate operation buffers. Therefore, it ensures -that the crytpo operation is interleaved optimally across the channels and +that the crypto operation is interleaved optimally across the channels and ranks for optimal processing. A ``rte_crypto_op`` contains a field indicating the pool that it originated from. When calling ``rte_crypto_op_free(op)``, the operation returns to its original pool. @@ -586,7 +586,7 @@ Sample code There are various sample applications that show how to use the cryptodev library, such as the L2fwd with Crypto sample application (L2fwd-crypto) and -the IPSec Security Gateway application (ipsec-secgw). +the IPsec Security Gateway application (ipsec-secgw). While these applications demonstrate how an application can be created to perform generic crypto operation, the required complexity hides the basic steps of @@ -767,7 +767,7 @@ using one of the crypto PMDs available in DPDK. /* * Dequeue the crypto operations until all the operations - * are proccessed in the crypto device. + * are processed in the crypto device. */ uint16_t num_dequeued_ops, total_num_dequeued_ops = 0; do { @@ -846,7 +846,7 @@ the order in which the transforms are passed indicates the order of the chaining Not all asymmetric crypto xforms are supported for chaining. Currently supported asymmetric crypto chaining is Diffie-Hellman private key generation followed by public generation. Also, currently API does not support chaining of symmetric and -asymmetric crypto xfroms. +asymmetric crypto xforms. Each xform defines specific asymmetric crypto algo. Currently supported are: * RSA |