[qca-ns-drv] Added missing Doxygen comments
Change-Id: Id4c5f1dad1390787739da5688d3668662ffea2a7
Signed-off-by: Suruchi Agarwal <suruchia@codeaurora.org>
diff --git a/exports/nss_ipv4.h b/exports/nss_ipv4.h
index 98a51ee..0d73129 100644
--- a/exports/nss_ipv4.h
+++ b/exports/nss_ipv4.h
@@ -375,8 +375,8 @@
* IPv4 connection inquiry naming structure.
*/
struct nss_ipv4_inquiry_msg {
- /*
- * Request by its 5 tuple and get Response for other items.
+ /**
+ * Request by its 5-tuple and get response for other items.
*/
struct nss_ipv4_rule_create_msg rr;
};
diff --git a/exports/nss_ipv6.h b/exports/nss_ipv6.h
index d22da1d..f949168 100644
--- a/exports/nss_ipv6.h
+++ b/exports/nss_ipv6.h
@@ -439,8 +439,8 @@
* IPv6 connection inquiry sub-messages.
*/
struct nss_ipv6_inquiry_msg {
- /*
- * Request by 5 tuple, and Response in other items.
+ /**
+ * Request by 5-tuple and response in other items.
*/
struct nss_ipv6_rule_create_msg rr;
};
diff --git a/exports/nss_n2h.h b/exports/nss_n2h.h
index 59812f7..9a082dc 100644
--- a/exports/nss_n2h.h
+++ b/exports/nss_n2h.h
@@ -1,6 +1,6 @@
/*
**************************************************************************
- * Copyright (c) 2014-2017, The Linux Foundation. All rights reserved.
+ * Copyright (c) 2014-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.
@@ -148,7 +148,7 @@
/**< Virtual addresses of the buffers. */
#ifndef __LP64__
uint32_t padding[MAX_PAGES_PER_MSG];
- /* Pad to fit 64 bits, do not reuse. */
+ /**< Pad to fit 64 bits, do not reuse. */
#endif
};
diff --git a/exports/nss_project.h b/exports/nss_project.h
index 54c1f0a..4b1b711 100644
--- a/exports/nss_project.h
+++ b/exports/nss_project.h
@@ -125,7 +125,7 @@
/**< Enable or disable worker thread statistics. */
struct nss_project_msg_wt_stats_notify wt_stats_notify;
/**< One-way worker thread statistics message. */
- } msg;
+ } msg; /**< Message payload. */
};
/**
diff --git a/exports/nss_wifili_if.h b/exports/nss_wifili_if.h
index 5950dc9..abdf199 100644
--- a/exports/nss_wifili_if.h
+++ b/exports/nss_wifili_if.h
@@ -591,7 +591,7 @@
*/
struct nss_wifili_rx_dma_ring_stats {
uint32_t rx_hw_desc_unavailable; /**< Number of times hardware descriptor is unavailable. */
- uint32_t rx_buf_replenished; /**< Number of buffers replinshed. */
+ uint32_t rx_buf_replenished; /**< Number of buffers replenished. */
};
/**
@@ -644,10 +644,14 @@
* Per packet special data that has to be sent to host.
*/
struct nss_wifili_soc_per_packet_metadata {
- uint32_t pkt_type;
+ uint32_t pkt_type; /**< Packet type. */
+
+ /**
+ * Link descriptor per packet metadata.
+ */
union {
struct nss_wifili_soc_linkdesc_per_packet_metadata linkdesc_metadata;
- } metadata;
+ } metadata; /**< Per packet link descriptor metadata. */
};
/**
@@ -821,10 +825,14 @@
*/
struct nss_wifili_radio_cfg_msg {
uint32_t radio_if_num; /**< NSS assigned interface number for radio. */
+
+ /**
+ * Wi-Fi radio specific special command message.
+ */
union {
struct nss_wifili_radio_cmd_msg radiocmdmsg;
/**< Radio specific commands. */
- } radiomsg;
+ } radiomsg; /**< Wi-Fi radio command message. */
};
/**
@@ -833,6 +841,10 @@
*/
struct nss_wifili_msg {
struct nss_cmn_msg cm; /**< Common message header. */
+
+ /**
+ * Payload of wifili message.
+ */
union {
struct nss_wifili_init_msg init;
/**< Wi-Fi initialization data. */