[qca-nss-drv] Doxygen updates
Change-Id: Ia9fac471b0f0f190994051a290b41ac15d8488cb
Signed-off-by: Suruchi Agarwal <suruchia@codeaurora.org>
diff --git a/exports/arch/nss_fsm9010.h b/exports/arch/nss_fsm9010.h
index 847e84f..d7f57c6 100644
--- a/exports/arch/nss_fsm9010.h
+++ b/exports/arch/nss_fsm9010.h
@@ -22,16 +22,16 @@
#define __NSS_FSM9010_H
/**
- * @addtogroup nss_arch_macros
+ * @addtogroup nss_arch_macros_fsm9010
* @{
*/
-#define NSS_MAX_NUM_PRI 1 /**< Maximum number of priority queues in NSS for the FSM9010 chipset. */
-#define NSS_HOST_CORES 4 /**< Number of host cores for the FSM9010 chipset. */
+#define NSS_MAX_NUM_PRI 1 /**< Maximum number of priority queues in NSS. */
+#define NSS_HOST_CORES 4 /**< Number of host cores. */
-#define NSS_N2H_RING_COUNT 3 /**< Number of N2H rings for the FSM9010 chipset. */
-#define NSS_H2N_RING_COUNT 4 /**< Number of H2N rings for the FSM9010 chipset. */
-#define NSS_RING_SIZE 128 /**< Ring size for the FSM9010 chipset. */
+#define NSS_N2H_RING_COUNT 3 /**< Number of N2H rings. */
+#define NSS_H2N_RING_COUNT 4 /**< Number of H2N rings. */
+#define NSS_RING_SIZE 128 /**< Ring size. */
/**
* @}
diff --git a/exports/arch/nss_ipq40xx.h b/exports/arch/nss_ipq40xx.h
index 5b47ac7..671ef38 100644
--- a/exports/arch/nss_ipq40xx.h
+++ b/exports/arch/nss_ipq40xx.h
@@ -22,16 +22,16 @@
#define __NSS_IPQ40XX_H
/**
- * @addtogroup nss_arch_macros
+ * @addtogroup nss_arch_macros_ipq40xx
* @{
*/
-#define NSS_MAX_NUM_PRI 1 /**< Maximum number of priority queues in NSS for the IPQ40xx chipsets. */
-#define NSS_HOST_CORES 4 /**< Number of host cores for the IPQ40xx chipsets. */
+#define NSS_MAX_NUM_PRI 1 /**< Maximum number of priority queues in NSS. */
+#define NSS_HOST_CORES 4 /**< Number of host cores. */
-#define NSS_N2H_RING_COUNT 0 /**< Number of N2H rings for the IPQ40xx chipsets. */
-#define NSS_H2N_RING_COUNT 0 /**< Number of H2N rings for the IPQ40xx chipsets. */
-#define NSS_RING_SIZE 128 /**< Ring size for the IPQ40xx chipsets. */
+#define NSS_N2H_RING_COUNT 0 /**< Number of N2H rings. */
+#define NSS_H2N_RING_COUNT 0 /**< Number of H2N rings. */
+#define NSS_RING_SIZE 128 /**< Ring size. */
/**
* @}
diff --git a/exports/arch/nss_ipq806x.h b/exports/arch/nss_ipq806x.h
index ca0409d..4519ffb 100644
--- a/exports/arch/nss_ipq806x.h
+++ b/exports/arch/nss_ipq806x.h
@@ -22,16 +22,16 @@
#define __NSS_IPQ806X_H
/**
- * @addtogroup nss_arch_macros
+ * @addtogroup nss_arch_macros_ipq806x
* @{
*/
-#define NSS_MAX_NUM_PRI 4 /**< Maximum number of priority queues in NSS for the IPQ806x chipsets. */
-#define NSS_HOST_CORES 2 /**< Number of host cores for the IPQ806x chipsets. */
+#define NSS_MAX_NUM_PRI 4 /**< Maximum number of priority queues in NSS. */
+#define NSS_HOST_CORES 2 /**< Number of host cores. */
-#define NSS_N2H_RING_COUNT 3 /**< Number of N2H rings for the IPQ806x chipsets. */
-#define NSS_H2N_RING_COUNT 4 /**< Number of H2N rings for the IPQ806x chipsets. */
-#define NSS_RING_SIZE 128 /**< Ring size for the IPQ806x chipsets. */
+#define NSS_N2H_RING_COUNT 3 /**< Number of N2H rings. */
+#define NSS_H2N_RING_COUNT 4 /**< Number of H2N rings. */
+#define NSS_RING_SIZE 128 /**< Ring size. */
/**
* @}
diff --git a/exports/arch/nss_ipq807x.h b/exports/arch/nss_ipq807x.h
index 9ed8330..88be9ee 100644
--- a/exports/arch/nss_ipq807x.h
+++ b/exports/arch/nss_ipq807x.h
@@ -22,17 +22,17 @@
#define __NSS_IPQ807X_H
/**
- * @addtogroup nss_arch_macros
+ * @addtogroup nss_arch_macros_ipq807x
* @{
*/
-#define NSS_MAX_NUM_PRI 4 /**< Maximum number of priority queues in NSS for the IPQ807x chipsets. */
-#define NSS_HOST_CORES 4 /**< Number of host cores for the IPQ807x chipsets. */
-#define NSS_PPE_SUPPORTED /**< PPE supported flag for the IPQ807x chipsets. */
+#define NSS_MAX_NUM_PRI 4 /**< Maximum number of priority queues in NSS. */
+#define NSS_HOST_CORES 4 /**< Number of host cores. */
+#define NSS_PPE_SUPPORTED /**< PPE supported flag. */
-#define NSS_N2H_RING_COUNT 5 /**< Number of N2H rings for the IPQ807x chipsets. */
-#define NSS_H2N_RING_COUNT 11 /**< Number of H2N rings for the IPQ807x chipsets. */
-#define NSS_RING_SIZE 128 /**< Ring size for the IPQ807x chipsets. */
+#define NSS_N2H_RING_COUNT 5 /**< Number of N2H rings. */
+#define NSS_H2N_RING_COUNT 11 /**< Number of H2N rings. */
+#define NSS_RING_SIZE 128 /**< Ring size. */
/**
* @}
diff --git a/exports/arch/nss_ipq807x_64.h b/exports/arch/nss_ipq807x_64.h
index 7921a00..c505c5a 100644
--- a/exports/arch/nss_ipq807x_64.h
+++ b/exports/arch/nss_ipq807x_64.h
@@ -22,17 +22,17 @@
#define __NSS_IPQ807x_64_H
/**
- * @addtogroup nss_arch_macros
+ * @addtogroup nss_arch_macros_ipq807x_64
* @{
*/
-#define NSS_MAX_NUM_PRI 4 /**< Maximum number of priority queues in NSS for the IPQ807x 64-bit chipsets. */
-#define NSS_HOST_CORES 4 /**< Number of host cores for the IPQ807x 64-bit chipsets. */
-#define NSS_PPE_SUPPORTED /**< PPE supported flag for the IPQ807x 64-bit chipsets. */
+#define NSS_MAX_NUM_PRI 4 /**< Maximum number of priority queues in NSS. */
+#define NSS_HOST_CORES 4 /**< Number of host cores. */
+#define NSS_PPE_SUPPORTED /**< PPE supported flag. */
-#define NSS_N2H_RING_COUNT 5 /**< Number of N2H rings for the IPQ807x 64-bit chipsets. */
-#define NSS_H2N_RING_COUNT 11 /**< Number of H2N rings for the IPQ807x 64-bit chipsets. */
-#define NSS_RING_SIZE 128 /**< Ring size for the IPQ807x 64-bit chipsets. */
+#define NSS_N2H_RING_COUNT 5 /**< Number of N2H rings. */
+#define NSS_H2N_RING_COUNT 11 /**< Number of H2N rings. */
+#define NSS_RING_SIZE 128 /**< Ring size. */
/**
* @}
diff --git a/exports/nss_gre.h b/exports/nss_gre.h
index d12af1d..9ff8de8 100644
--- a/exports/nss_gre.h
+++ b/exports/nss_gre.h
@@ -1,6 +1,6 @@
/*
**************************************************************************
- * Copyright (c) 2017, The Linux Foundation. All rights reserved.
+ * Copyright (c) 2017-2018, The Linux Foundation. All rights reserved.
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
* above copyright notice and this permission notice appear in all copies.
@@ -307,11 +307,11 @@
* nss_gre_msg_callback_t \n
* net_device
*
- * @param[in] if_num NSS interface number.
- * @param[in] nss_gre_data_callback Callback for the data.
- * @param[in] msg_callback Callback for the message.
- * @param[in] netdev Pointer to the associated network device.
- * @param[in] features Socket buffer types supported by this interface.
+ * @param[in] if_num NSS interface number.
+ * @param[in] gre_callback Callback for the data.
+ * @param[in] msg_callback Callback for the message.
+ * @param[in] netdev Pointer to the associated network device.
+ * @param[in] features Socket buffer types supported by this interface.
*
* @return
* Pointer to the NSS core context.
diff --git a/exports/nss_l2tpv2.h b/exports/nss_l2tpv2.h
index 008d146..6e45b80 100644
--- a/exports/nss_l2tpv2.h
+++ b/exports/nss_l2tpv2.h
@@ -1,6 +1,6 @@
/*
**************************************************************************
- * Copyright (c) 2015, 2017, The Linux Foundation. All rights reserved.
+ * Copyright (c) 2015, 2017-2018, The Linux Foundation. All rights reserved.
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
* above copyright notice and this permission notice appear in all copies.
@@ -199,8 +199,8 @@
* nss_unregister_l2tpv2_if
* Deregisters the L2TPV2 tunnel interface from the NSS.
*
- * @param[in] if_num NSS interface number
-. *
+ * @param[in] if_num NSS interface number.
+ *
* @return
* None.
*
diff --git a/exports/nss_ppe.h b/exports/nss_ppe.h
index 8bb6274..5be460e 100644
--- a/exports/nss_ppe.h
+++ b/exports/nss_ppe.h
@@ -39,7 +39,7 @@
* nss_ppe_message_types
* Message types for Packet Processing Engine (PPE) requests and responses.
*
- * Note: PPE messages are added as short term approach, expect all
+ * Note: PPE messages are added as short term approach; expect all
* messages below to be deprecated for more integrated approach.
*/
enum nss_ppe_message_types {
@@ -263,7 +263,7 @@
* @return
* None.
*/
-void nss_ppe_msg_init(struct nss_ppe_msg *ncm, uint16_t if_num, uint32_t type, uint32_t len, void *cb, void *app_data);
+void nss_ppe_msg_init(struct nss_ppe_msg *ncm, uint16_t if_num, uint32_t type, uint32_t len, void *cb, void *app_data);
/**
* nss_ppe_get_context
@@ -278,7 +278,7 @@
* nss_ppe_tx_l2_exception_msg
* Sends the PPE a message to enable/disable L2 exceptions.
*
- * @param[in] if_num Interface number of the PPE.
+ * @param[in] if_num Interface number of the PPE.
* @param[in] exception_enable Enable/disable flag.
*
* @return
@@ -290,9 +290,9 @@
* nss_ppe_tx_ipsec_config_msg
* Sends the PPE a message to configure inline IPsec port.
*
- * @param[in] if_num Static IPsec interface number.
- * @param[in] vsi_num Default VSI number associated with inline IPsec port.
- * @param[in] mtu Default MTU of static inline IPsec port.
+ * @param[in] nss_ifnum Static IPsec interface number.
+ * @param[in] vsi_num Default VSI number associated with inline IPsec port.
+ * @param[in] mtu Default MTU of static inline IPsec port.
*
* @return
* Status of the Tx operation.
@@ -315,7 +315,7 @@
* nss_ppe_tx_ipsec_add_intf_msg
* Sends the PPE a message to attach a dynamic interface number to IPsec port.
*
- * @param[in] if_num Dynamic IPsec/DTLS interface number.
+ * @param[in] nss_ifnum Dynamic IPsec/DTLS interface number.
*
* @return
* Status of the Tx operation.
@@ -326,7 +326,7 @@
* nss_ppe_tx_ipsec_del_intf_msg
* Sends the PPE a message to detach a dynamic interface number to IPsec port.
*
- * @param[in] if_num Dynamic IPsec/DTLS interface number.
+ * @param[in] nss_ifnum Dynamic IPsec/DTLS interface number.
*
* @return
* Status of the Tx operation.
diff --git a/exports/nss_tunipip6.h b/exports/nss_tunipip6.h
index 3c19c4b..2aed088 100644
--- a/exports/nss_tunipip6.h
+++ b/exports/nss_tunipip6.h
@@ -1,6 +1,6 @@
/*
**************************************************************************
- * Copyright (c) 2014, 2017, The Linux Foundation. All rights reserved.
+ * Copyright (c) 2014, 2017-2018, The Linux Foundation. All rights reserved.
* Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the
* above copyright notice and this permission notice appear in all copies.
@@ -162,7 +162,7 @@
* Deregisters the TUNIPIP6 interface from the NSS.
*
* @param[in] if_num NSS interface number.
-. *
+ *
* @return
* None.
*/
diff --git a/exports/nss_wifili_if.h b/exports/nss_wifili_if.h
index 3086711..28975ea 100644
--- a/exports/nss_wifili_if.h
+++ b/exports/nss_wifili_if.h
@@ -683,7 +683,7 @@
* Tx peer statistics.
*/
struct nss_wifili_tx_ctrl_stats {
- uint32_t ofdma; /**< Number of Orthogonal frequency-division multiple
+ uint32_t ofdma; /**< Number of orthogonal frequency-division multiple
access packets. */
uint32_t non_amsdu_cnt; /**< Number of MSDUs with no MSDU level aggregation. */
uint32_t amsdu_cnt; /**< Number of MSDUs part of AMSDU. */