[v2] doc: add table of supported operating systems for cryptodevs
Checks
Commit Message
Added table to the crypto device drivers documentation
stating the support of each PMD on Linux, FreeBSD and Windows.
Signed-off-by: Tal Shnaiderman <talshn@nvidia.com>
---
v2: add chacha20_poly1305 to the table [AkhilG]
---
doc/guides/conf.py | 5 +++++
doc/guides/cryptodevs/features/aesni_gcm.ini | 7 +++++++
doc/guides/cryptodevs/features/aesni_mb.ini | 7 +++++++
doc/guides/cryptodevs/features/armv8.ini | 7 +++++++
doc/guides/cryptodevs/features/bcmfs.ini | 7 +++++++
doc/guides/cryptodevs/features/caam_jr.ini | 6 ++++++
doc/guides/cryptodevs/features/ccp.ini | 6 ++++++
doc/guides/cryptodevs/features/chacha20_poly1305.ini | 7 +++++++
doc/guides/cryptodevs/features/cn10k.ini | 6 ++++++
doc/guides/cryptodevs/features/cn9k.ini | 6 ++++++
doc/guides/cryptodevs/features/default.ini | 8 ++++++++
doc/guides/cryptodevs/features/dpaa2_sec.ini | 6 ++++++
doc/guides/cryptodevs/features/dpaa_sec.ini | 6 ++++++
doc/guides/cryptodevs/features/kasumi.ini | 7 +++++++
doc/guides/cryptodevs/features/mlx5.ini | 7 +++++++
doc/guides/cryptodevs/features/mvsam.ini | 7 +++++++
doc/guides/cryptodevs/features/nitrox.ini | 6 ++++++
doc/guides/cryptodevs/features/null.ini | 9 ++++++++-
doc/guides/cryptodevs/features/octeontx.ini | 7 +++++++
doc/guides/cryptodevs/features/octeontx2.ini | 6 ++++++
doc/guides/cryptodevs/features/openssl.ini | 7 +++++++
doc/guides/cryptodevs/features/qat.ini | 7 +++++++
doc/guides/cryptodevs/features/snow3g.ini | 7 +++++++
doc/guides/cryptodevs/features/virtio.ini | 7 +++++++
doc/guides/cryptodevs/features/zuc.ini | 7 +++++++
doc/guides/cryptodevs/overview.rst | 7 +++++++
26 files changed, 174 insertions(+), 1 deletion(-)
Comments
> Added table to the crypto device drivers documentation
> stating the support of each PMD on Linux, FreeBSD and Windows.
>
> Signed-off-by: Tal Shnaiderman <talshn@nvidia.com>
>
> ---
> v2: add chacha20_poly1305 to the table [AkhilG]
Acked-by: Akhil Goyal <gakhil@marvell.com>
Applied to dpdk-next-crypto
Title updated.
04/11/2021 19:48, Tal Shnaiderman:
> Added table to the crypto device drivers documentation
> stating the support of each PMD on Linux, FreeBSD and Windows.
>
> Signed-off-by: Tal Shnaiderman <talshn@nvidia.com>
>
> ---
> v2: add chacha20_poly1305 to the table [AkhilG]
> ---
> doc/guides/conf.py | 5 +++++
> doc/guides/cryptodevs/features/aesni_gcm.ini | 7 +++++++
> doc/guides/cryptodevs/features/aesni_mb.ini | 7 +++++++
> doc/guides/cryptodevs/features/armv8.ini | 7 +++++++
> doc/guides/cryptodevs/features/bcmfs.ini | 7 +++++++
> doc/guides/cryptodevs/features/caam_jr.ini | 6 ++++++
> doc/guides/cryptodevs/features/ccp.ini | 6 ++++++
> doc/guides/cryptodevs/features/chacha20_poly1305.ini | 7 +++++++
> doc/guides/cryptodevs/features/cn10k.ini | 6 ++++++
> doc/guides/cryptodevs/features/cn9k.ini | 6 ++++++
> doc/guides/cryptodevs/features/default.ini | 8 ++++++++
> doc/guides/cryptodevs/features/dpaa2_sec.ini | 6 ++++++
> doc/guides/cryptodevs/features/dpaa_sec.ini | 6 ++++++
> doc/guides/cryptodevs/features/kasumi.ini | 7 +++++++
> doc/guides/cryptodevs/features/mlx5.ini | 7 +++++++
> doc/guides/cryptodevs/features/mvsam.ini | 7 +++++++
> doc/guides/cryptodevs/features/nitrox.ini | 6 ++++++
> doc/guides/cryptodevs/features/null.ini | 9 ++++++++-
> doc/guides/cryptodevs/features/octeontx.ini | 7 +++++++
> doc/guides/cryptodevs/features/octeontx2.ini | 6 ++++++
> doc/guides/cryptodevs/features/openssl.ini | 7 +++++++
> doc/guides/cryptodevs/features/qat.ini | 7 +++++++
> doc/guides/cryptodevs/features/snow3g.ini | 7 +++++++
> doc/guides/cryptodevs/features/virtio.ini | 7 +++++++
> doc/guides/cryptodevs/features/zuc.ini | 7 +++++++
> doc/guides/cryptodevs/overview.rst | 7 +++++++
> 26 files changed, 174 insertions(+), 1 deletion(-)
An addition in .gitignore is missing:
doc/guides/cryptodevs/overview_os_table.txt
Will fix when pulling.
@@ -368,6 +368,11 @@ def setup(app):
'Asymmetric',
'Asymmetric algorithms in crypto drivers',
'Asymmetric algorithm')
+ table_file = dirname(__file__) + '/cryptodevs/overview_os_table.txt'
+ generate_overview_table(table_file, 6,
+ 'OS',
+ 'Operating systems support for crypto drivers',
+ 'Operating system')
table_file = dirname(__file__) + '/compressdevs/overview_feature_table.txt'
generate_overview_table(table_file, 1,
'Features',
@@ -39,3 +39,10 @@ AES GCM (256) = Y
; Supported Asymmetric algorithms of the 'aesni_gcm' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'aesni_gcm' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
@@ -74,3 +74,10 @@ CHACHA20-POLY1305 = Y
; Supported Asymmetric algorithms of the 'aesni_mb' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'aesni_mb' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
\ No newline at end of file
@@ -32,3 +32,10 @@ SHA256 HMAC = Y
; Supported Asymmetric algorithms of the 'armv8' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'armv8' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
\ No newline at end of file
@@ -58,3 +58,10 @@ AES CCM (256) = Y
; Supported Asymmetric algorithms of the 'bcmfs' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'bcmfs' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
\ No newline at end of file
@@ -49,3 +49,9 @@ AES GCM (256) = Y
; Supported Asymmetric algorithms of the 'dpaa2_sec' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'dpaa2_sec' crypto driver.
+;
+[OS]
+Linux = Y
\ No newline at end of file
@@ -63,3 +63,9 @@ AES GCM (256) = Y
; Supported Asymmetric algorithms of the 'ccp' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'ccp' crypto driver.
+;
+[OS]
+Linux = Y
\ No newline at end of file
@@ -33,3 +33,10 @@ CHACHA20-POLY1305 = Y
; Supported Asymmetric algorithms of the 'chacha20_poly1305' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'chacha20_poly1305' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
@@ -79,3 +79,9 @@ Modular Inversion =
Diffie-hellman =
ECDSA = Y
ECPM = Y
+
+;
+; Supported Operating systems of the 'cn10k' crypto driver.
+;
+[OS]
+Linux = Y
\ No newline at end of file
@@ -78,3 +78,9 @@ Modular Inversion =
Diffie-hellman =
ECDSA = Y
ECPM = Y
+
+;
+; Supported Operating systems of the 'cn9k' crypto driver.
+;
+[OS]
+Linux = Y
\ No newline at end of file
@@ -118,3 +118,11 @@ Modular Inversion =
Diffie-hellman =
ECDSA =
ECPM =
+
+;
+; Supported Operating systems of a default crypto driver.
+;
+[OS]
+Linux =
+FreeBSD =
+Windows =
@@ -62,3 +62,9 @@ AES GCM (256) = Y
; Supported Asymmetric algorithms of the 'dpaa2_sec' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'dpaa2_sec' crypto driver.
+;
+[OS]
+Linux = Y
@@ -62,3 +62,9 @@ AES GCM (256) = Y
; Supported Asymmetric algorithms of the 'dpaa_sec' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'dpaa_sec' crypto driver.
+;
+[OS]
+Linux = Y
@@ -30,3 +30,10 @@ KASUMI F9 = Y
; Supported Asymmetric algorithms of the 'kasumi' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'kasumi' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
@@ -35,3 +35,10 @@ AES XTS (256) = Y
; Supported Asymmetric algorithms of a mlx5 crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'mlx5' crypto driver.
+;
+[OS]
+Linux = Y
+Windows = Y
@@ -58,3 +58,10 @@ AES GCM (256) = Y
; Supported Asymmetric algorithms of the 'mvsam' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'mvsam' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
@@ -42,3 +42,9 @@ AES GCM (256) = Y
; Supported Asymmetric algorithms of the 'nitrox' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'nitrox' crypto driver.
+;
+[OS]
+Linux = Y
@@ -28,4 +28,11 @@ NULL = Y
;
; Supported Asymmetric algorithms of the 'null' crypto driver.
;
-[Asymmetric]
\ No newline at end of file
+[Asymmetric]
+
+;
+; Supported Operating systems of the 'null' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
\ No newline at end of file
@@ -77,3 +77,10 @@ Modular Inversion =
Diffie-hellman =
ECDSA = Y
ECPM = Y
+
+;
+; Supported Operating systems of the 'octeontx' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
@@ -79,3 +79,9 @@ Modular Inversion =
Diffie-hellman =
ECDSA = Y
ECPM = Y
+
+;
+; Supported Operating systems of the 'octeontx2' crypto driver.
+;
+[OS]
+Linux = Y
@@ -65,3 +65,10 @@ DSA = Y
Modular Exponentiation = Y
Modular Inversion = Y
Diffie-hellman = Y
+
+;
+; Supported Operating systems of the 'openssl' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
@@ -82,3 +82,10 @@ CHACHA20-POLY1305 = Y
Modular Exponentiation = Y
Modular Inversion = Y
RSA = Y
+
+;
+; Supported Operating systems of the 'qat' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
\ No newline at end of file
@@ -31,3 +31,10 @@ SNOW3G UIA2 = Y
; Supported Asymmetric algorithms of the 'snow3g' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'snow3g' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
@@ -30,3 +30,10 @@ SHA1 HMAC = Y
; Supported Asymmetric algorithms of the 'virtio' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'virtio' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
@@ -30,3 +30,10 @@ ZUC EIA3 = Y
; Supported Asymmetric algorithms of the 'zuc' crypto driver.
;
[Asymmetric]
+
+;
+; Supported Operating systems of the 'zuc' crypto driver.
+;
+[OS]
+Linux = Y
+FreeBSD = Y
@@ -80,3 +80,10 @@ Supported Asymmetric Algorithms
.. _table_crypto_pmd_asym_algos:
.. include:: overview_asym_table.txt
+
+Supported Operating Systems
+-------------------------------
+
+.. _table_crypto_pmd_os:
+
+.. include:: overview_os_table.txt