[v3,3/8] doc: remove unnecessary API code from security guide
Checks
Commit Message
Various xform structures are being copied in
rte_security guide which can be referred from the
API documentation generated by Doxygen. The security guide
does not talk about specific details of these xforms and
thus are removed from the security guide.
Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
---
doc/guides/prog_guide/rte_security.rst | 55 +-------------------------
1 file changed, 1 insertion(+), 54 deletions(-)
@@ -1,5 +1,5 @@
.. SPDX-License-Identifier: BSD-3-Clause
- Copyright 2017 NXP
+ Copyright 2017,2020 NXP
@@ -647,63 +647,10 @@ which will be updated in the future.
IPsec related configuration parameters are defined in ``rte_security_ipsec_xform``
-.. code-block:: c
-
- struct rte_security_ipsec_xform {
- uint32_t spi;
- /**< SA security parameter index */
- uint32_t salt;
- /**< SA salt */
- struct rte_security_ipsec_sa_options options;
- /**< various SA options */
- enum rte_security_ipsec_sa_direction direction;
- /**< IPsec SA Direction - Egress/Ingress */
- enum rte_security_ipsec_sa_protocol proto;
- /**< IPsec SA Protocol - AH/ESP */
- enum rte_security_ipsec_sa_mode mode;
- /**< IPsec SA Mode - transport/tunnel */
- struct rte_security_ipsec_tunnel_param tunnel;
- /**< Tunnel parameters, NULL for transport mode */
- };
-
PDCP related configuration parameters are defined in ``rte_security_pdcp_xform``
-.. code-block:: c
-
- struct rte_security_pdcp_xform {
- int8_t bearer; /**< PDCP bearer ID */
- /** Enable in order delivery, this field shall be set only if
- * driver/HW is capable. See RTE_SECURITY_PDCP_ORDERING_CAP.
- */
- uint8_t en_ordering;
- /** Notify driver/HW to detect and remove duplicate packets.
- * This field should be set only when driver/hw is capable.
- * See RTE_SECURITY_PDCP_DUP_DETECT_CAP.
- */
- uint8_t remove_duplicates;
- /** PDCP mode of operation: Control or data */
- enum rte_security_pdcp_domain domain;
- /** PDCP Frame Direction 0:UL 1:DL */
- enum rte_security_pdcp_direction pkt_dir;
- /** Sequence number size, 5/7/12/15/18 */
- enum rte_security_pdcp_sn_size sn_size;
- /** Starting Hyper Frame Number to be used together with the SN
- * from the PDCP frames
- */
- uint32_t hfn;
- /** HFN Threshold for key renegotiation */
- uint32_t hfn_threshold;
- };
-
DOCSIS related configuration parameters are defined in ``rte_security_docsis_xform``
-.. code-block:: c
-
- struct rte_security_docsis_xform {
- enum rte_security_docsis_direction direction;
- /**< DOCSIS direction */
- };
-
Security API
~~~~~~~~~~~~