doc: add cryptodev table for supported operating systems

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>
Acked-by: Akhil Goyal <gakhil@marvell.com>

diff --git a/.gitignore b/.gitignore
index b19c0717e685fe6ed91798801309a5eec8697a3b..7ec8688342fe73fb336783aa78e2e82b90837425 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -10,6 +10,7 @@ doc/guides/cryptodevs/overview_cipher_table.txt
 doc/guides/cryptodevs/overview_auth_table.txt
 doc/guides/cryptodevs/overview_aead_table.txt
 doc/guides/cryptodevs/overview_asym_table.txt
+doc/guides/cryptodevs/overview_os_table.txt
 doc/guides/compressdevs/overview_feature_table.txt
 doc/guides/regexdevs/overview_feature_table.txt
 doc/guides/vdpadevs/overview_feature_table.txt

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index 67d2dd62c7fcd2820562b55abe4534529f3c19f7..0494b0efe7e3d24abab59bc21454a16d01730f23 100644 (file)
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -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',

diff --git a/doc/guides/cryptodevs/features/aesni_gcm.ini b/doc/guides/cryptodevs/features/aesni_gcm.ini
index c592298668bffa42170c6ca1e138e1ba6a85e6d2..58ab133e5fbe857532bce50cbe1caaa350383950 100644 (file)
--- a/doc/guides/cryptodevs/features/aesni_gcm.ini
+++ b/doc/guides/cryptodevs/features/aesni_gcm.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/aesni_mb.ini b/doc/guides/cryptodevs/features/aesni_mb.ini
index 1883217868e4d9249eac74dfb604c9dac342f7df..e616f13d504ef3b0dab99c33565f79c3dd113509 100644 (file)
--- a/doc/guides/cryptodevs/features/aesni_mb.ini
+++ b/doc/guides/cryptodevs/features/aesni_mb.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/armv8.ini b/doc/guides/cryptodevs/features/armv8.ini
index beb40c05783ac827efd822e2562362a4810973a6..33c1291ce6e9ed95c37bdbe33f1c1ad64bc93f4f 100644 (file)
--- a/doc/guides/cryptodevs/features/armv8.ini
+++ b/doc/guides/cryptodevs/features/armv8.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/bcmfs.ini b/doc/guides/cryptodevs/features/bcmfs.ini
index f7fb2ed884cf8f080daffa323e366d626e37770d..5def12f8a595392521c11703c77c56a4dab70c0e 100644 (file)
--- a/doc/guides/cryptodevs/features/bcmfs.ini
+++ b/doc/guides/cryptodevs/features/bcmfs.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/caam_jr.ini b/doc/guides/cryptodevs/features/caam_jr.ini
index 8d55cdb6cd3e58506cf34f91828b61e4826874da..ba6d10c8809394bde48698b4e4394677ec55c5dc 100644 (file)
--- a/doc/guides/cryptodevs/features/caam_jr.ini
+++ b/doc/guides/cryptodevs/features/caam_jr.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/ccp.ini b/doc/guides/cryptodevs/features/ccp.ini
index 866d4c52e79270690d0a31f04266624f5986545f..53abd2b68edc89cba77ab401757edea056883193 100644 (file)
--- a/doc/guides/cryptodevs/features/ccp.ini
+++ b/doc/guides/cryptodevs/features/ccp.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/chacha20_poly1305.ini b/doc/guides/cryptodevs/features/chacha20_poly1305.ini
index 3353e031c9118089738c229061e4cadaaf20cf96..b5a7b39bd0ed3e8bc7e19dbf42638f92d61f14d2 100644 (file)
--- a/doc/guides/cryptodevs/features/chacha20_poly1305.ini
+++ b/doc/guides/cryptodevs/features/chacha20_poly1305.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/cn10k.ini b/doc/guides/cryptodevs/features/cn10k.ini
index 9d08bd5c0490aa8000672c975102fde2e5a8f7a6..ab21d9da43ef0f5b372e9ee8ba91c99d3fd0fb0d 100644 (file)
--- a/doc/guides/cryptodevs/features/cn10k.ini
+++ b/doc/guides/cryptodevs/features/cn10k.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/cn9k.ini b/doc/guides/cryptodevs/features/cn9k.ini
index dd935d439d0f87b2dacd150a75827a9623b1fb5f..d834659d29aabf18125bd620fa9096912c279701 100644 (file)
--- a/doc/guides/cryptodevs/features/cn9k.ini
+++ b/doc/guides/cryptodevs/features/cn9k.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/default.ini b/doc/guides/cryptodevs/features/default.ini
index 96d95ddc8151e4138ea8aff9983c0212c464b9d9..018fe0221e2068fdc1776d78b886c7fc1f503a85 100644 (file)
--- a/doc/guides/cryptodevs/features/default.ini
+++ b/doc/guides/cryptodevs/features/default.ini
@@ -118,3 +118,11 @@ Modular Inversion       =
 Diffie-hellman          =
 ECDSA                   =
 ECPM                    =
+
+;
+; Supported Operating systems of a default crypto driver.
+;
+[OS]
+Linux   =
+FreeBSD =
+Windows =

diff --git a/doc/guides/cryptodevs/features/dpaa2_sec.ini b/doc/guides/cryptodevs/features/dpaa2_sec.ini
index a1c91821de041d8827241db659c10d0b1056d16e..3d6e449ca138a013358b24582509dfd7ff892448 100644 (file)
--- a/doc/guides/cryptodevs/features/dpaa2_sec.ini
+++ b/doc/guides/cryptodevs/features/dpaa2_sec.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/dpaa_sec.ini b/doc/guides/cryptodevs/features/dpaa_sec.ini
index 6a8f77fb1d2e2ff9a014c6628de99c9ed9168e11..77101fa12dd4a3f493066223c8cd655858c26fe4 100644 (file)
--- a/doc/guides/cryptodevs/features/dpaa_sec.ini
+++ b/doc/guides/cryptodevs/features/dpaa_sec.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/kasumi.ini b/doc/guides/cryptodevs/features/kasumi.ini
index fbdb47e89f1f1a31f065ba22d87505f42a756f72..d400a4269d85b9fda7ac84bed13f3d572885e7af 100644 (file)
--- a/doc/guides/cryptodevs/features/kasumi.ini
+++ b/doc/guides/cryptodevs/features/kasumi.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/mlx5.ini b/doc/guides/cryptodevs/features/mlx5.ini
index a89526add0b92e6b627f4123b671c874e549d235..0d210b2114681291f41f87223f8ab4de0844c2d1 100644 (file)
--- a/doc/guides/cryptodevs/features/mlx5.ini
+++ b/doc/guides/cryptodevs/features/mlx5.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/mvsam.ini b/doc/guides/cryptodevs/features/mvsam.ini
index 7516c31861444bf2818d017999d79b6f02586cad..e1d182dd8ee67af195398a664bc813dbd3f82729 100644 (file)
--- a/doc/guides/cryptodevs/features/mvsam.ini
+++ b/doc/guides/cryptodevs/features/mvsam.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/nitrox.ini b/doc/guides/cryptodevs/features/nitrox.ini
index a1d6bcb4f1aeacf762c150f435cbb76d25a36f35..6cab93a343a81543dd34cd11c25b452bff038c1a 100644 (file)
--- a/doc/guides/cryptodevs/features/nitrox.ini
+++ b/doc/guides/cryptodevs/features/nitrox.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/null.ini b/doc/guides/cryptodevs/features/null.ini
index a1c3e22a36f2730772e4f1c4ebafd05c0f97e664..ae09cdd1c018f9641e9922e5272b42149a18613c 100644 (file)
--- a/doc/guides/cryptodevs/features/null.ini
+++ b/doc/guides/cryptodevs/features/null.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/octeontx.ini b/doc/guides/cryptodevs/features/octeontx.ini
index d9776a578875446ab89cbb02d85a3b3b80886d13..acc361f99bffc0abe40993cbe291f704e0cfe842 100644 (file)
--- a/doc/guides/cryptodevs/features/octeontx.ini
+++ b/doc/guides/cryptodevs/features/octeontx.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/octeontx2.ini b/doc/guides/cryptodevs/features/octeontx2.ini
index 66c5fefde6232c63e2cfbc55d3d2371e8aae7228..c54dc9409cf9f2017de59cd680e9997dfa73e9f2 100644 (file)
--- a/doc/guides/cryptodevs/features/octeontx2.ini
+++ b/doc/guides/cryptodevs/features/octeontx2.ini
@@ -79,3 +79,9 @@ Modular Inversion       =
 Diffie-hellman          =
 ECDSA                   = Y
 ECPM                    = Y
+
+;
+; Supported Operating systems of the 'octeontx2' crypto driver.
+;
+[OS]
+Linux = Y

diff --git a/doc/guides/cryptodevs/features/openssl.ini b/doc/guides/cryptodevs/features/openssl.ini
index 74bb987ecd17cef506330ef6a496da750c343790..4b0f9b162ebe510339379e82944f88940bd34c74 100644 (file)
--- a/doc/guides/cryptodevs/features/openssl.ini
+++ b/doc/guides/cryptodevs/features/openssl.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/qat.ini b/doc/guides/cryptodevs/features/qat.ini
index 6cc09cde7098863a925896156560ff1eef04ff09..bc50ecf032ca58942eb8a64ebf7455be340f9d01 100644 (file)
--- a/doc/guides/cryptodevs/features/qat.ini
+++ b/doc/guides/cryptodevs/features/qat.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/snow3g.ini b/doc/guides/cryptodevs/features/snow3g.ini
index 4d4c5b579b7d8981f6857d649ae011b55d986a99..8d6d8092687dac923cfce7287c784c7672349e2b 100644 (file)
--- a/doc/guides/cryptodevs/features/snow3g.ini
+++ b/doc/guides/cryptodevs/features/snow3g.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/virtio.ini b/doc/guides/cryptodevs/features/virtio.ini
index 5dff094821e0b73608685bc07c4a6cda07d7de7d..8f22b6210b5a1c63d7c4cc1d3479f993bf5d5ae2 100644 (file)
--- a/doc/guides/cryptodevs/features/virtio.ini
+++ b/doc/guides/cryptodevs/features/virtio.ini
@@ -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

diff --git a/doc/guides/cryptodevs/features/zuc.ini b/doc/guides/cryptodevs/features/zuc.ini
index 1c53454a6c80205e95da7a9ce7323787151bfb4f..fa120c1d4d50362676d5295bec7651e4fe25d066 100644 (file)
--- a/doc/guides/cryptodevs/features/zuc.ini
+++ b/doc/guides/cryptodevs/features/zuc.ini
@@ -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

diff --git a/doc/guides/cryptodevs/overview.rst b/doc/guides/cryptodevs/overview.rst
index b87c4c6a275f220883ca74944cfe793b55b638d4..11722979156fcc7c7d2f7cc0400d162bd8b0745a 100644 (file)
--- a/doc/guides/cryptodevs/overview.rst
+++ b/doc/guides/cryptodevs/overview.rst
@@ -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