[v1,6/6] crypto/ccp: updating ccp document
diff mbox series

Message ID 20191011070045.80202-1-somalapuram@gmail.com
State Superseded
Delegated to: akhil goyal
Headers show
Series
  • Untitled series #6800
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

AMARANATH Amarnath Oct. 11, 2019, 7 a.m. UTC
From: Amaranath Somalapuram <somalapuram@gmail.com>

Signed-off-by: Amaranath Somalapuram <somalapuram@gmail.com>
---
 doc/guides/cryptodevs/ccp.rst | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

Comments

Akhil Goyal Oct. 11, 2019, 2:50 p.m. UTC | #1
Hi,
> 
> From: Amaranath Somalapuram <somalapuram@gmail.com>
> 
> Signed-off-by: Amaranath Somalapuram <somalapuram@gmail.com>
> ---
Title should be "crypto/ccp: fix documentation"

Please add an appropriate description to the patch.
This patch is a fix and should also have fixes tag and also cc to stable@dpdk.org


>  doc/guides/cryptodevs/ccp.rst | 32 ++++++++++++++++----------------
>  1 file changed, 16 insertions(+), 16 deletions(-)
> 
> diff --git a/doc/guides/cryptodevs/ccp.rst b/doc/guides/cryptodevs/ccp.rst
> index 034d20367..a43fe92de 100644
> --- a/doc/guides/cryptodevs/ccp.rst
> +++ b/doc/guides/cryptodevs/ccp.rst
> @@ -109,14 +109,14 @@ To validate ccp pmd, l2fwd-crypto example can be
> used with following command:
> 
>  .. code-block:: console
> 
> -	sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1
> -	--chain CIPHER_HASH --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
> -	--iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
> -	--auth_op GENERATE --auth_algo SHA1_HMAC
> -	--auth_key
> 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> -
> 	:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:1
> 1:11:11
> -	:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> +        sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1
> +        --chain CIPHER_HASH --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
> +        --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
> +        --auth_op GENERATE --auth_algo sha1-hmac
> +        --auth_key
> 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> +        :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:1
> 1:11
> +        :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> 
>  The CCP PMD also supports computing authentication over CPU with cipher
> offloaded to CCP.
>  To enable this feature, pass an additional argument as ccp_auth_opt=1 to --
> vdev parameters as
> @@ -124,14 +124,14 @@ following:
> 
>  .. code-block:: console
> 
> -	sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1"
> -- -p 0x1
> -	--chain CIPHER_HASH --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
> -	--iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
> -	--auth_op GENERATE --auth_algo SHA1_HMAC
> -	--auth_key
> 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> -
> 	:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:1
> 1:11:11
> -	:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> +        sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1" -- -
> p 0x1
> +        --chain CIPHER_HASH --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
> +        --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
> +        --auth_op GENERATE --auth_algo sha1-hmac
> +        --auth_key
> 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> +        :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:1
> 1:11
> +        :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
> 
>  Limitations
>  -----------
> --
> 2.17.1

Patch
diff mbox series

diff --git a/doc/guides/cryptodevs/ccp.rst b/doc/guides/cryptodevs/ccp.rst
index 034d20367..a43fe92de 100644
--- a/doc/guides/cryptodevs/ccp.rst
+++ b/doc/guides/cryptodevs/ccp.rst
@@ -109,14 +109,14 @@  To validate ccp pmd, l2fwd-crypto example can be used with following command:
 
 .. code-block:: console
 
-	sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1
-	--chain CIPHER_HASH --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
-	--iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
-	--auth_op GENERATE --auth_algo SHA1_HMAC
-	--auth_key 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
-	:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
-	:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
+        sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1
+        --chain CIPHER_HASH --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
+        --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
+        --auth_op GENERATE --auth_algo sha1-hmac
+        --auth_key 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
+        :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
+        :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
 
 The CCP PMD also supports computing authentication over CPU with cipher offloaded to CCP.
 To enable this feature, pass an additional argument as ccp_auth_opt=1 to --vdev parameters as
@@ -124,14 +124,14 @@  following:
 
 .. code-block:: console
 
-	sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1
-	--chain CIPHER_HASH --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
-	--iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
-	--auth_op GENERATE --auth_algo SHA1_HMAC
-	--auth_key 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
-	:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
-	:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
+        sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1
+        --chain CIPHER_HASH --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
+        --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
+        --auth_op GENERATE --auth_algo sha1-hmac
+        --auth_key 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
+        :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
+        :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
 
 Limitations
 -----------