Skip to contentSkip to conversation

doc: documentation update

PATCH In review [email protected] 3 participants 4 messages Oct 15, 2019 – Nov 8, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/6 doc: documentation update

From: Amaranath Somalapuram <[email protected]>

Update the docs, fixing description of some parameter. Changing AES_CBC to aes-cbc, SHA1_HMAC to sha1-hmac.
Cc: [email protected]

---
 doc/guides/cryptodevs/ccp.rst | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)
doc/guides/cryptodevs/ccp.rst +16 -16
index 034d20367..a43fe92de 100644
@@ -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
 -----------
Signature · 1 line
2.17.1
#1 lore raw

Title should be "doc: fix app usage in CCP guide"

Quoted 5 lines

From: Amaranath Somalapuram <[email protected]>

Update the docs, fixing description of some parameter. Changing AES_CBC to aes-cbc, SHA1_HMAC to sha1-hmac.

Patch description should be something like:
Command line arguments for running l2fwd-crypto was updated but the AMD CCP PMD still uses old arguments.
This patch updates the command line arguments of l2fwd-crypto while running with crypto-ccp

Please add a fixes line here specifying the commit Id and patch title
Of the patch which originally introduced this issue.

Quoted 74 lines
---
 doc/guides/cryptodevs/ccp.rst | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)
doc/guides/cryptodevs/ccp.rst +0 -0
index 034d20367..a43fe92de 100644
@@ -109,14 +109,14 @@ To validate ccp pmd, l2fwd-crypto example can be

used with following command:

.. code-block:: console

doc/guides/cryptodevs/ccp.rst +0 -6
-	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

doc/guides/cryptodevs/ccp.rst +6 -1
-	: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

doc/guides/cryptodevs/ccp.rst +0 -7
@@ -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

doc/guides/cryptodevs/ccp.rst +1 -1
-	: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

doc/guides/cryptodevs/ccp.rst +5 -0
+        --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

#2 lore raw

Hi Akhil,
If I use fix as a tag. I get the below message.
Is this messages is ok or do we need to have bug numbers for this?

./devtools/check-git-log.sh
Missing 'Fixes' tag:
doc: fix app usage in CCP guide

Regards,
S.Amarnath

-----Original Message-----
From: Akhil Goyal <[email protected]>
Sent: Tuesday, October 15, 2019 4:24 PM
To: Somalapuram, Amaranath <[email protected]>; [email protected]
Cc: [email protected]
Subject: RE: [PATCH v1 1/6] doc: documentation update

[CAUTION: External Email]

Title should be "doc: fix app usage in CCP guide"

Quoted 5 lines

From: Amaranath Somalapuram <[email protected]>

Update the docs, fixing description of some parameter. Changing AES_CBC to aes-cbc, SHA1_HMAC to sha1-hmac.

Patch description should be something like:
Command line arguments for running l2fwd-crypto was updated but the AMD CCP PMD still uses old arguments. This patch updates the command line arguments of l2fwd-crypto while running with crypto-ccp

Please add a fixes line here specifying the commit Id and patch title Of the patch which originally introduced this issue.

Quoted 80 lines
---
 doc/guides/cryptodevs/ccp.rst | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)
(quoted diff) +0 -0

b/doc/guides/cryptodevs/ccp.rst index 034d20367..a43fe92de 100644

doc/guides/cryptodevs/ccp.rst +0 -0
@@ -109,14 +109,14 @@ To validate ccp pmd, l2fwd-crypto example can be 

used with following command:

.. code-block:: console

doc/guides/cryptodevs/ccp.rst +0 -6
-     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

doc/guides/cryptodevs/ccp.rst +6 -1
-     :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:1
+ 1: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

doc/guides/cryptodevs/ccp.rst +0 -7
-     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

doc/guides/cryptodevs/ccp.rst +2 -1
-     :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

doc/guides/cryptodevs/ccp.rst +5 -0
+        --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:1
+ 1:1
1:11
+ :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11

Limitations
-----------
--
2.17.1

#3 lore raw
Quoted 6 lines

Hi Akhil,
If I use fix as a tag. I get the below message.
Is this messages is ok or do we need to have bug numbers for this?

Quoted 7 lines

./devtools/check-git-log.sh
Missing 'Fixes' tag:
doc: fix app usage in CCP guide

Regards,
S.Amarnath

Yes, it should have a fixes tag
For this patch it would be

Fixes 4433ced9aa4b ("doc: add AMD CCP guide")

And patch title would be "doc: fix app usage in CCP guide".

You should find the commit ID of the original patch which introduced this issue. You can use git blame.

Please make similar changes in all the patches.

Regards,
Akhil

Quoted 98 lines

Title should be "doc: fix app usage in CCP guide"

Quoted 5 lines

From: Amaranath Somalapuram <[email protected]>

Update the docs, fixing description of some parameter. Changing AES_CBC to aes-cbc, SHA1_HMAC to sha1-hmac.

Patch description should be something like:
Command line arguments for running l2fwd-crypto was updated but the AMD CCP PMD still uses old arguments.
This patch updates the command line arguments of l2fwd-crypto while running with crypto-ccp

Please add a fixes line here specifying the commit Id and patch title Of the patch which originally introduced this issue.

Quoted 80 lines
---
 doc/guides/cryptodevs/ccp.rst | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)
(quoted diff) +0 -0

b/doc/guides/cryptodevs/ccp.rst index 034d20367..a43fe92de 100644

doc/guides/cryptodevs/ccp.rst +0 -0
@@ -109,14 +109,14 @@ To validate ccp pmd, l2fwd-crypto example can be

used with following command:

.. code-block:: console

doc/guides/cryptodevs/ccp.rst +0 -6
-     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

doc/guides/cryptodevs/ccp.rst +6 -1
-     :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:1
+ 1: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

doc/guides/cryptodevs/ccp.rst +0 -7
-     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

doc/guides/cryptodevs/ccp.rst +2 -1
-     :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

doc/guides/cryptodevs/ccp.rst +5 -0
+        --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:1
+ 1:1
1:11
+ :11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11

Limitations
-----------
--
2.17.1