doc: remove unneeded deprecation notice
[dpdk.git] / doc / guides / cryptodevs / overview.rst
index 656cf18..493cd5f 100644 (file)
@@ -1,31 +1,5 @@
-..  BSD LICENSE
-    Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions
-    are met:
-
-    * Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in
-    the documentation and/or other materials provided with the
-    distribution.
-    * Neither the name of 6WIND S.A. nor the names of its
-    contributors may be used to endorse or promote products derived
-    from this software without specific prior written permission.
-
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2016-2017 Intel Corporation.
 
 Crypto Device Supported Functionality Matrices
 ==============================================
@@ -35,119 +9,23 @@ Supported Feature Flags
 
 .. _table_crypto_pmd_features:
 
-.. raw:: html
+.. include:: overview_feature_table.txt
 
-   <style>
-      .wy-nav-content {
-         opacity: .99;
-      }
-      table#id1 {
-         cursor: default;
-         overflow: hidden;
-      }
-      table#id1 th, table#id1 td {
-         text-align: center;
-      }
-      table#id1 th {
-         font-size: 80%;
-         white-space: pre-wrap;
-         vertical-align: top;
-         padding: 2px;
-      }
-      table#id1 th:first-child {
-         vertical-align: bottom;
-      }
-      table#id1 td {
-         font-size: 70%;
-         padding: 1px;
-      }
-      table#id1 td:first-child {
-         padding-left: 1em;
-         text-align: left;
-      }
-      table#id1 tr:nth-child(2n-1) td {
-         background-color: rgba(210, 210, 210, 0.2);
-      }
-      table#id1 th:not(:first-child):hover,
-      table#id1 td:not(:first-child):hover {
-         position: relative;
-      }
-      table#id1 th:not(:first-child):hover::after,
-      table#id1 td:not(:first-child):hover::after {
-         content: '';
-         height: 6000px;
-         top: -3000px;
-         width: 100%;
-         left: 0;
-         position: absolute;
-         z-index: -1;
-         background-color: #ffb;
-      }
-      table#id1 tr:hover td {
-         background-color: #ffb;
-      }
-   </style>
+Note, the mbuf scatter gather feature (aka chained mbufs, scatter-gather-lists
+or SGLs) indicate all following combinations are supported unless otherwise called
+out in the Limitations section of each PMD.
+
+* In place operation, input buffer as multiple segments, same buffer used for output
+* Out of place operation, input buffer as single segment and output as multiple segments
+* Out of place operation, input buffer as multiple segments and output as single segment
+* Out of place operation, input buffer as multiple segments and output as multiple segments
 
-.. include:: overview_feature_table.txt
 
 Supported Cipher Algorithms
 ---------------------------
 
 .. _table_crypto_pmd_cipher_algos:
 
-.. raw:: html
-
-   <style>
-      .wy-nav-content {
-         opacity: .99;
-      }
-      table#id2 {
-         cursor: default;
-         overflow: hidden;
-      }
-      table#id2 th, table#id2 td {
-         text-align: center;
-      }
-      table#id2 th {
-         font-size: 80%;
-         white-space: pre-wrap;
-         vertical-align: top;
-         padding: 2px;
-      }
-      table#id2 th:first-child {
-         vertical-align: bottom;
-      }
-      table#id2 td {
-         font-size: 70%;
-         padding: 1px;
-      }
-      table#id2 td:first-child {
-         padding-left: 1em;
-         text-align: left;
-      }
-      table#id2 tr:nth-child(2n-1) td {
-         background-color: rgba(210, 210, 210, 0.2);
-      }
-      table#id2 th:not(:first-child):hover,
-      table#id2 td:not(:first-child):hover {
-         position: relative;
-      }
-      table#id2 th:not(:first-child):hover::after,
-      table#id2 td:not(:first-child):hover::after {
-         content: '';
-         height: 6000px;
-         top: -3000px;
-         width: 100%;
-         left: 0;
-         position: absolute;
-         z-index: -1;
-         background-color: #ffb;
-      }
-      table#id2 tr:hover td {
-         background-color: #ffb;
-      }
-   </style>
-
 .. include:: overview_cipher_table.txt
 
 Supported Authentication Algorithms
@@ -155,59 +33,6 @@ Supported Authentication Algorithms
 
 .. _table_crypto_pmd_auth_algos:
 
-.. raw:: html
-
-   <style>
-      .wy-nav-content {
-         opacity: .99;
-      }
-      table#id3 {
-         cursor: default;
-         overflow: hidden;
-      }
-      table#id3 th, table#id3 td {
-         text-align: center;
-      }
-      table#id3 th {
-         font-size: 80%;
-         white-space: pre-wrap;
-         vertical-align: top;
-         padding: 2px;
-      }
-      table#id3 th:first-child {
-         vertical-align: bottom;
-      }
-      table#id3 td {
-         font-size: 70%;
-         padding: 1px;
-      }
-      table#id3 td:first-child {
-         padding-left: 1em;
-         text-align: left;
-      }
-      table#id3 tr:nth-child(2n-1) td {
-         background-color: rgba(210, 210, 210, 0.2);
-      }
-      table#id3 th:not(:first-child):hover,
-      table#id3 td:not(:first-child):hover {
-         position: relative;
-      }
-      table#id3 th:not(:first-child):hover::after,
-      table#id3 td:not(:first-child):hover::after {
-         content: '';
-         height: 6000px;
-         top: -3000px;
-         width: 100%;
-         left: 0;
-         position: absolute;
-         z-index: -1;
-         background-color: #ffb;
-      }
-      table#id3 tr:hover td {
-         background-color: #ffb;
-      }
-   </style>
-
 .. include:: overview_auth_table.txt
 
 Supported AEAD Algorithms
@@ -215,57 +40,4 @@ Supported AEAD Algorithms
 
 .. _table_crypto_pmd_aead_algos:
 
-.. raw:: html
-
-   <style>
-      .wy-nav-content {
-         opacity: .99;
-      }
-      table#id4 {
-         cursor: default;
-         overflow: hidden;
-      }
-      table#id4 th, table#id4 td {
-         text-align: center;
-      }
-      table#id4 th {
-         font-size: 80%;
-         white-space: pre-wrap;
-         vertical-align: top;
-         padding: 2px;
-      }
-      table#id4 th:first-child {
-         vertical-align: bottom;
-      }
-      table#id4 td {
-         font-size: 70%;
-         padding: 1px;
-      }
-      table#id4 td:first-child {
-         padding-left: 1em;
-         text-align: left;
-      }
-      table#id4 tr:nth-child(2n-1) td {
-         background-color: rgba(210, 210, 210, 0.2);
-      }
-      table#id4 th:not(:first-child):hover,
-      table#id4 td:not(:first-child):hover {
-         position: relative;
-      }
-      table#id4 th:not(:first-child):hover::after,
-      table#id4 td:not(:first-child):hover::after {
-         content: '';
-         height: 6000px;
-         top: -3000px;
-         width: 100%;
-         left: 0;
-         position: absolute;
-         z-index: -1;
-         background-color: #ffb;
-      }
-      table#id4 tr:hover td {
-         background-color: #ffb;
-      }
-   </style>
-
 .. include:: overview_aead_table.txt