Merge "[qca-nss-drv] Export bridge verify API and rename function."
diff --git a/exports/nss_api_if.h b/exports/nss_api_if.h
index d23e18c..9f58580 100644
--- a/exports/nss_api_if.h
+++ b/exports/nss_api_if.h
@@ -69,7 +69,7 @@
#endif
/**
- * @addtogroup nss_driver_api_subsystem
+ * @addtogroup nss_driver_subsystem
* @{
*/
@@ -206,7 +206,7 @@
/**< Special interface number for project node. */
/**
- * Wireless Multimedia Extention Access Category to TID.
+ * Wireless Multimedia Extention Access Category to TID. @hideinitializer
*/
#define NSS_WIFILI_WME_AC_TO_TID(_ac) ( \
((_ac) == NSS_WIFILI_WME_AC_VO) ? 6 : \
@@ -215,7 +215,7 @@
0)))
/**
- * Wireless TID to Wireless Extension Multimedia Access Category.
+ * Wireless TID to Wireless Extension Multimedia Access Category. @hideinitializer
*/
#define NSS_WIFILI_TID_TO_WME_AC(_tid) ( \
(((_tid) == 0) || ((_tid) == 3)) ? NSS_WIFILI_WME_AC_BE : \
diff --git a/exports/nss_crypto_cmn.h b/exports/nss_crypto_cmn.h
index 4338531..8ae5d36 100644
--- a/exports/nss_crypto_cmn.h
+++ b/exports/nss_crypto_cmn.h
@@ -27,10 +27,10 @@
*/
/*
- * nss_crypto_cmn_ctx message related array sizes
+ * Context message related array sizes
*/
-#define NSS_CRYPTO_CMN_CTX_SPARE 4 /**< words */
-#define NSS_CRYPTO_CMN_VER_WORDS 4 /**< words */
+#define NSS_CRYPTO_CMN_CTX_SPARE 4 /**< Context spare words size. */
+#define NSS_CRYPTO_CMN_VER_WORDS 4 /**< Firmware version words size.*/
/**
* nss_crypto_cmn_algo
diff --git a/exports/nss_shaper.h b/exports/nss_shaper.h
index 49e2e33..fcb49cc 100644
--- a/exports/nss_shaper.h
+++ b/exports/nss_shaper.h
@@ -707,10 +707,10 @@
*
* @param[in] if_num NSS interface number.
* @param[in] cb Callback function for the message. This callback is
- invoked when the NSS returns a sk_buff after shaping.
+ * invoked when the NSS returns a sk_buff after shaping.
* @param[in] app_data Pointer to the application context of the message.
- This context is passed to the callback together with the
- sk_buff to provide context to the registrant (state).
+ * This context is passed to the callback together with the
+ * sk_buff to provide context to the registrant (state).
* @param[in] owner Pointer to the kernel module. The module is held until it deregisters.
*
* @return
@@ -743,10 +743,10 @@
*
* @param[in] if_num NSS interface number.
* @param[in] cb Callback function for the message. This callback is
- invoked when the NSS returns a sk_buff after shaping.
+ * invoked when the NSS returns a sk_buff after shaping.
* @param[in] app_data Pointer to the application context of the message.
- This context is passed to the callback together with the
- sk_buff to provide context to the registrant (state).
+ * This context is passed to the callback together with the
+ * sk_buff to provide context to the registrant (state).
* @param[in] owner Pointer to the kernel module.
*
* @return
diff --git a/exports/nss_virt_if.h b/exports/nss_virt_if.h
index 1484cb2..a4b8bd7 100644
--- a/exports/nss_virt_if.h
+++ b/exports/nss_virt_if.h
@@ -254,7 +254,7 @@
* @param[in] nvim Pointer to the virtual interface message.
*
* @return
- * command Tx status
+ * Command Tx status.
*/
extern nss_tx_status_t nss_virt_if_tx_msg(struct nss_ctx_instance *nss_ctx, struct nss_virt_if_msg *nvim);
@@ -278,7 +278,7 @@
/**
* nss_virt_if_register
- * Registers a virtual Interface with NSS driver,
+ * Registers a virtual Interface with NSS driver.
*
* @datatypes
* nss_virt_if_handle \n
@@ -335,7 +335,7 @@
dynamic interface allocation).
*
* @return
- * virtual interface number.
+ * Virtual interface number.
*/
extern int32_t nss_virt_if_get_interface_num(struct nss_virt_if_handle *handle);
diff --git a/exports/nss_wifi.h b/exports/nss_wifi.h
index 2288b6a..3d8995f 100644
--- a/exports/nss_wifi.h
+++ b/exports/nss_wifi.h
@@ -365,37 +365,41 @@
};
/**
- * peer tx time stamp stats per tid
+ * nss_wifi_peer_txtime_stats
+ * Peer Tx timestamp statistics per TID.
*/
struct nss_wifi_peer_txtime_stats {
- uint32_t sum_tx; /**< sum of sojourn for each packet */
- uint32_t sum_msdus; /**< num of msdus per peer per tid */
+ uint32_t sum_tx; /**< Sum of sojourn for each packet. */
+ uint32_t sum_msdus; /**< Number of MSDU per peer per TID. */
};
/**
- * peer id and timestamp stats per tid
+ * nss_wifi_peer_tstamp_stats
+ * Peer ID and timestamp statistics per TID.
*/
struct nss_wifi_peer_tstamp_stats {
- uint32_t peer_id; /**< tid value */
+ uint32_t peer_id; /**< TID value. */
struct nss_wifi_peer_txtime_stats sum[NSS_WIFI_TX_NUM_TOS_TIDS];
- /**< timestamps */
- uint32_t avg[NSS_WIFI_TX_NUM_TOS_TIDS]; /**< exponential weighted avg */
+ /**< Timestamps. */
+ uint32_t avg[NSS_WIFI_TX_NUM_TOS_TIDS]; /**< Exponential weighted average. */
};
/**
- * nss wifi tx timestamp msg for npeers
+ * nss_wifi_ol_peer_time_msg
+ * NSS Wi-Fi Tx timestamp message for n number of peers.
*/
struct nss_wifi_ol_peer_time_msg {
- uint32_t npeers; /**< number of peers */
+ uint32_t npeers; /**< Number of peers. */
struct nss_wifi_peer_tstamp_stats tstats[1];
- /**< one instance of struct */
+ /**< One instance of struct. */
};
/**
- * wifi enable/disable send packet to host
+ * nss_wifi_enable_ol_statsv2
+ * Wi-Fi enable/disable send packet to host.
*/
struct nss_wifi_enable_ol_statsv2 {
- uint32_t enable_ol_statsv2; /**< flag to send packet to host */
+ uint32_t enable_ol_statsv2; /**< Flag to send packet to host. */
};
/**
@@ -421,8 +425,8 @@
* nss_wifi_always_primary_set_msg
* Always set the Wi-Fi primary radio.
*
- * The primary radio is set using the nss_wifi_primary_radio_set_msg flag. When the
- * nss_wifi_always_primary_set_msg flag is set:
+ * The primary radio is set using the nss_wifi_primary_radio_set_msg flag.
+ * When the nss_wifi_always_primary_set_msg flag is set:
* - Tx -- Do not drop a unicast packet on the secondary station the VAP. Instead, give that
* packet to the primary station the VAP.
* - Rx -- Do not drop a received unicast packet on the secondary station the VAP. Instead,
@@ -440,10 +444,10 @@
/**
* nss_wifi_force_client_mcast_traffic_set_msg
- * Wi-Fi message to set the client multi-cast traffic for a radio
+ * Wi-Fi message to set the client multi-cast traffic for a radio.
*/
struct nss_wifi_force_client_mcast_traffic_set_msg {
- uint32_t flag; /**< Flag to force set the multi-cast traffic in a radio */
+ uint32_t flag; /**< Flag to force set the multi-cast traffic in a radio. */
};
/**
@@ -751,17 +755,16 @@
/**
* nss_wifi_append_metaheader
- *
* Append metaheader after pbuf->data for stats_v2.
*/
struct nss_wifi_append_statsv2_metahdr {
- uint32_t rxstatsmagic; /**< Magic to be verified on host */
- uint32_t seq_number; /**< sequence number of packets sent from nss */
- uint16_t peer_id; /**< peer_id of peer */
- uint16_t num_msdus; /**< msdus in ppdu */
- uint16_t num_retries; /**< retries in ppdu */
- uint16_t num_mpdus; /**< mpdus in ppdu */
- uint32_t num_bytes; /**< bytes in ppdu */
+ uint32_t rxstatsmagic; /**< Magic to be verified on host. */
+ uint32_t seq_number; /**< Sequence number of packets sent from NSS. */
+ uint16_t peer_id; /**< Peer ID of peer. */
+ uint16_t num_msdus; /**< Number of MSDU in PPDU. */
+ uint16_t num_retries; /**< Number of retries in PPDU. */
+ uint16_t num_mpdus; /**< Number of MPDU in PPDU. */
+ uint32_t num_bytes; /**< Number of bytes in PPDU. */
};
/**
@@ -899,13 +902,13 @@
struct nss_wifi_enable_ol_statsv2 wesh_msg;
/**< Enable version 2 tx/rx stats. */
struct nss_wifi_ol_peer_time_msg wopt_msg;
- /**< Send per peer/tid timestamp stats to host. */
+ /**< Send per peer/TID timestamp statistics to host. */
} msg; /**< Message Payload. */
};
/**
* nss_wifi_get_context
- * Gets the wifi context used in nss_gre_tx.
+ * Gets the Wi-Fi context used in nss_gre_tx.
*
* @return
* Pointer to the NSS core context.
diff --git a/exports/nss_wifi_vdev.h b/exports/nss_wifi_vdev.h
index 763ceb3..a42916d 100644
--- a/exports/nss_wifi_vdev.h
+++ b/exports/nss_wifi_vdev.h
@@ -115,18 +115,18 @@
*/
enum nss_wifi_vdev_ext_data_pkt_type {
NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_NONE = 0,
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_IGMP = 1, /**< igmp packets */
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_MESH = 2, /**< mesh packets */
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_INSPECT = 3, /**< host inspect packets */
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_TXINFO = 4, /**< tx completion info packets */
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_MPSTA_TX = 5, /**< mpsta tx meta data */
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_MPSTA_RX = 6, /**< mpsta rx meta data */
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_RX_ERR = 7, /**< rx error packets meta data */
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_EXTAP_TX = 8, /**< extap tx meta data */
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_EXTAP_RX = 9, /**< extap rx meta data */
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_WNM_TFS = 10, /**< wnm tfs related meta data */
- NSS_WIFI_VDEV_EXT_TX_COMPL_PKT_TYPE = 11, /**< tx completion */
- NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_WDS_LEARN = 12, /**< wds source port learning cmd */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_IGMP = 1, /**< IGMP packets. */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_MESH = 2, /**< MESH packets. */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_INSPECT = 3, /**< Host inspect packets. */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_TXINFO = 4, /**< Tx completion information packets. */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_MPSTA_TX = 5, /**< MP station Tx meta data. */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_MPSTA_RX = 6, /**< MP station Rx meta data. */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_RX_ERR = 7, /**< Rx error packets meta data. */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_EXTAP_TX = 8, /**< ExtAP Tx meta data. */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_EXTAP_RX = 9, /**< ExtAP Rx meta data. */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_WNM_TFS = 10, /**< WNM TFGS related meta data. */
+ NSS_WIFI_VDEV_EXT_TX_COMPL_PKT_TYPE = 11, /**< Tx completion. */
+ NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_WDS_LEARN = 12, /**< WDS source port learning command. */
NSS_WIFI_VDEV_EXT_DATA_PKT_TYPE_MAX
};
@@ -373,11 +373,12 @@
};
/**
- * nss_wifi dscp to tid map id
+ * nss_wifi_vdev_dscptid_map_id
+ * DSCP to TID map ID.
*/
struct nss_wifi_vdev_dscptid_map_id {
uint8_t dscp_tid_map_id;
- /**< Dscp to tid mapping id to be used */
+ /**< Dscp to TID mapping id to be used. */
};
/**
@@ -411,7 +412,7 @@
uint16_t msdu_count; /**< Count of MSDUs in the MSDU list. */
uint16_t num_msdu; /**< Sequence Number of MSDU in the MSDU list. */
uint32_t msdu_q_time; /**< Time spent by an MSDU in the Wi-Fi firmware. */
- uint32_t ppdu_rate; /**< PPDU rate in ratecode. ??what is ratecode?*/
+ uint32_t ppdu_rate; /**< PPDU rate in code rate. */
uint8_t ppdu_num_mpdus_success; /**< Number of successful MPDUs. */
uint8_t ppdu_num_mpdus_fail; /**< Number of failed MPDUs. */
uint16_t ppdu_num_msdus_success; /**< Number of successful MSDUs. */
@@ -468,7 +469,7 @@
/**
* nss_wifi_vdev_mpsta_per_packet_rx_metadata
- * Per-packet metadata for receiving packets from an mp station.
+ * Per-packet metadata for receiving packets from an MP station.
*/
struct nss_wifi_vdev_mpsta_per_packet_rx_metadata {
uint16_t vdev_id; /**< Virtual device ID. */
@@ -526,7 +527,7 @@
uint8_t is_sa_valid; /**< Specifies whether source address is valid. */
uint8_t reserved; /**< Reserve bytes for alignment. */
enum wifi_vdev_ext_wds_info_type wds_type;
- /**< WDS message type. */
+ /**< WDS message type. */
};
/**
@@ -621,8 +622,8 @@
uint16_t vdev_id; /**< Virtual device ID. */
uint8_t nentries; /**< Number of group entries carried by this message. */
uint8_t radio_ifnum; /**< Interface number of the Wi-Fi radio. */
- /**< Array for multicast group entries. */
struct nss_wifi_vdev_me_host_sync_grp_entry grp_entry[NSS_WIFI_VDEV_MAX_ME_ENTRIES];
+ /**< Array for multicast group entries. */
};
/**
@@ -689,22 +690,24 @@
* Message to get virtual device statistics from NSS Firmware to Host.
*/
struct nss_wifi_vdev_stats_sync_msg {
- uint32_t dropped; /**< Number of dropped packets */
- uint32_t tx_enqueue_cnt; /**< tx pnode enqueue count */
- uint32_t tx_enqueue_fail_cnt; /**< tx pnode enqueue count */
- uint32_t tx_intra_bss_enqueue_cnt; /**< intra bss enqueue cnt */
- uint32_t tx_intra_bss_enqueue_fail_cnt; /**< intra bss enqueue fail cnt */
- uint32_t tx_intra_bss_mcast_send_cnt; /**< vdev mcast/bcast packet cnt in ap mode */
- uint32_t tx_intra_bss_mcast_send_fail_cnt; /**< vdev mcast/bcast packet cnt in ap mode */
- uint32_t tx_enqueue_bytes; /**< tx enqueue bytes count */
- uint32_t rx_enqueue_cnt; /**< eth node enqueue count */
- uint32_t rx_enqueue_fail_cnt; /**< eth node enqueue fail count */
- uint32_t rx_except_enqueue_cnt; /**< n2h node enqueue count */
- uint32_t rx_except_enqueue_fail_cnt; /**< n2h node enqueue fail cnt */
- uint32_t rx_enqueue_bytes; /**< rx enqueue bytes count */
- uint32_t rx_wds_learn_send_cnt; /**< vdev wds source port learn cnt */
- uint32_t rx_wds_learn_send_fail_cnt; /**< vdev wds source cnt fail */
- struct nss_wifi_vdev_mcast_enhance_stats wvmes; /**< Multicast enhancement statistics */
+ uint32_t dropped; /**< Number of dropped packets. */
+ uint32_t tx_enqueue_cnt; /**< Tx node enqueue count. */
+ uint32_t tx_enqueue_fail_cnt; /**< Tx node enqueue fail count. */
+ uint32_t tx_intra_bss_enqueue_cnt; /**< Intra BSS enqueue count. */
+ uint32_t tx_intra_bss_enqueue_fail_cnt; /**< Intra BSS enqueue fail count. */
+ uint32_t tx_intra_bss_mcast_send_cnt;
+ /**< Virtual device multicast/broadcast packet count in AP mode. */
+ uint32_t tx_intra_bss_mcast_send_fail_cnt;
+ /**< Virtual device multicast/broadcast packet fail count in AP mode. */
+ uint32_t tx_enqueue_bytes; /**< Tx enqueue bytes count. */
+ uint32_t rx_enqueue_cnt; /**< Ethernet node enqueue count. */
+ uint32_t rx_enqueue_fail_cnt; /**< Ethernet node enqueue fail count. */
+ uint32_t rx_except_enqueue_cnt; /**< N2H node enqueue count. */
+ uint32_t rx_except_enqueue_fail_cnt; /**< N2H node enqueue fail count. */
+ uint32_t rx_enqueue_bytes; /**< Rx enqueue bytes count. */
+ uint32_t rx_wds_learn_send_cnt; /**< Virtual device WDS source port learn count. */
+ uint32_t rx_wds_learn_send_fail_cnt; /**< Virtual device WDS source fail count.*/
+ struct nss_wifi_vdev_mcast_enhance_stats wvmes; /**< Multicast enhancement statistics. */
};
/**