ipsec: infra for selecting backends
[vpp.git] / src / plugins / dpdk / ipsec / dpdk_crypto_ipsec_doc.md
index b3dbd6e..8cf51f0 100644 (file)
@@ -32,35 +32,32 @@ Additionally, on x86_64 platforms, DPDK is built with SW crypto support.
 
 VPP allocates crypto resources based on a best effort approach:
 * first allocate Hardware crypto resources, then Software.
-* if there are not enough crypto resources for all workers, the graph node is not modifed and the default VPP IPsec implementation based in OpenSSL is used. The following message is displayed:
+* if there are not enough crypto resources for all workers, the graph node is not modified and the default VPP IPsec implementation based in OpenSSL is used. The following message is displayed:
 
       0: dpdk_ipsec_init: not enough Cryptodevs, default to OpenSSL IPsec
 
 
 ### Configuration example
 
-To enable DPDK Cryptodev the user just need to provide cryptodevs int the
-startup.conf.
+To enable DPDK Cryptodev the user just need to provide cryptodevs in the startup.conf.
 
-Example startup.conf:
+Below is an example startup.conf, it is not meant to be a default configuration:
 
 ```
 dpdk {
-    socket-mem 1024,1024
-    num-mbufs 131072
     dev 0000:81:00.0
     dev 0000:81:00.1
-    enable-cryptodev
     dev 0000:85:01.0
     dev 0000:85:01.1
-    vdev cryptodev_aesni_mb_pmd,socket_id=1
-    vdev cryptodev_aesni_mb_pmd,socket_id=1
+    vdev crypto_aesni_mb0,socket_id=1
+    vdev crypto_aesni_mb1,socket_id=1
 }
 ```
 
 In the above configuration:
-* 0000:85:01.0 and 0000:85:01.1 are crypto BDFs and they require the same driver binding as DPDK Ethernet devices but they do not support any extra configuration options.
-* Two AESNI-MB Software Cryptodev PMDs are created in NUMA node 1.
+* 0000:81:01.0 and 0000:81:01.1 are Ethernet device BDFs.
+* 0000:85:01.0 and 0000:85:01.1 are Crypto device BDFs and they require the same driver binding as DPDK Ethernet devices but they do not support any extra configuration options.
+* Two AESNI-MB Software (Virtual) Cryptodev PMDs are created in NUMA node 1.
 
 For further details refer to [DPDK Crypto Device Driver documentation](http://dpdk.org/doc/guides/cryptodevs/index.html)