qcacmn: Fix dp wifi3.0 documentation

The kernel-doc script identified a large number of kernel-doc issues
in the dp/wifi3.0 folder. A series of patches have addressed most of
the issues, so now fix the remaining issues. Just like in the previous
patches, there are a number of instances where public functions have
their implementation documented instead of having their interface
documented, so make sure that the interfaces are documented.

Change-Id: I4bc39b0e1a9d8c264b72ec6db76ff7e92d24f277
CRs-Fixed: 3373822

dp/wifi3.0/dp_cal_client_api.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2017-2019 The Linux Foundation. All rights reserved.
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. 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
@@ -18,8 +18,8 @@
  */
 
 /**
- * @file cal_client_api.h
- * @brief: define timer to update DP stats
+ * DOC: dp_cal_client_api.h
+ *      define timer to update DP stats
  */
 #ifndef _DP_CAL_CLIENT_H_
 #define _DP_CAL_CLIENT_H_

dp/wifi3.0/dp_hist.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2020 The Linux Foundation. All rights reserved.
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. 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
@@ -192,8 +192,8 @@ const char *dp_hist_delay_percentile_str(uint8_t index)
 	return dp_hist_delay_percentile_dbucket_str[index];
 }
 
-/*
- * dp_hist_find_bucket_idx: Find the bucket index
+/**
+ * dp_hist_find_bucket_idx() - Find the bucket index
  * @bucket_array: Bucket array
  * @value: Frequency value
  *
@@ -211,8 +211,8 @@ static int dp_hist_find_bucket_idx(int16_t *bucket_array, int value)
 	return idx;
 }
 
-/*
- * dp_hist_fill_buckets: Fill the histogram frequency buckets
+/**
+ * dp_hist_fill_buckets() - Fill the histogram frequency buckets
  * @hist_bucket: Histogram bukcets
  * @value: Frequency value
  *
@@ -260,13 +260,6 @@ static void dp_hist_fill_buckets(struct cdp_hist_bucket *hist_bucket, int value)
 	hist_bucket->freq[idx]++;
 }
 
-/*
- * dp_hist_update_stats: Update histogram stats
- * @hist_stats: Hist stats object
- * @value: Delay value
- *
- * Return: void
- */
 void dp_hist_update_stats(struct cdp_hist_stats *hist_stats, int value)
 {
 	if (qdf_unlikely(!hist_stats))
@@ -293,13 +286,6 @@ void dp_hist_update_stats(struct cdp_hist_stats *hist_stats, int value)
 		hist_stats->avg = (hist_stats->avg + value) / 2;
 }
 
-/*
- * dp_copy_hist_stats(): Copy the histogram stats
- * @src_hist_stats: Source histogram stats
- * @dst_hist_stats: Destination histogram stats
- *
- * Return: void
- */
 void dp_copy_hist_stats(struct cdp_hist_stats *src_hist_stats,
 			struct cdp_hist_stats *dst_hist_stats)
 {
@@ -313,13 +299,6 @@ void dp_copy_hist_stats(struct cdp_hist_stats *src_hist_stats,
 	dst_hist_stats->avg = src_hist_stats->avg;
 }
 
-/*
- * dp_accumulate_hist_stats(): Accumulate the hist src to dst
- * @src_hist_stats: Source histogram stats
- * @dst_hist_stats: Destination histogram stats
- *
- * Return: void
- */
 void dp_accumulate_hist_stats(struct cdp_hist_stats *src_hist_stats,
 			      struct cdp_hist_stats *dst_hist_stats)
 {
@@ -345,11 +324,6 @@ void dp_accumulate_hist_stats(struct cdp_hist_stats *src_hist_stats,
 	}
 }
 
-/*
- * dp_hist_init(): Initialize the histogram object
- * @hist_stats: Hist stats object
- * @hist_type: Histogram type
- */
 void dp_hist_init(struct cdp_hist_stats *hist_stats,
 		  enum cdp_hist_types hist_type)
 {

dp/wifi3.0/dp_hist.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2020 The Linux Foundation. All rights reserved.
- * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. 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
@@ -18,8 +18,8 @@
  */
 
 /**
- * @file dp_hist.h
- * @brief: histogram header file
+ * DOC: dp_hist.h
+ *      histogram header file
  */
 
 #ifndef __DP_HIST_H_
@@ -27,20 +27,43 @@
 
 #define HIST_AVG_WEIGHT_DENOM 4
 
-/*
- * dp_hist_update_stats: Update histogram stats
- * @hist_delay: Delay histogram
+/**
+ * dp_hist_update_stats() - Update histogram stats
+ * @hist_stats: Delay histogram
  * @value: Delay value
  *
  * Return: void
  */
 void dp_hist_update_stats(struct cdp_hist_stats *hist_stats, int value);
+
+/**
+ * dp_hist_init() - Initialize the histogram object
+ * @hist_stats: Hist stats object
+ * @hist_type: Histogram type
+ */
 void dp_hist_init(struct cdp_hist_stats *hist_stats,
 		  enum cdp_hist_types hist_type);
+
+/**
+ * dp_accumulate_hist_stats() - Accumulate the hist src to dst
+ * @src_hist_stats: Source histogram stats
+ * @dst_hist_stats: Destination histogram stats
+ *
+ * Return: void
+ */
 void dp_accumulate_hist_stats(struct cdp_hist_stats *src_hist_stats,
 			      struct cdp_hist_stats *dst_hist_stats);
+
+/**
+ * dp_copy_hist_stats() - Copy the histogram stats
+ * @src_hist_stats: Source histogram stats
+ * @dst_hist_stats: Destination histogram stats
+ *
+ * Return: void
+ */
 void dp_copy_hist_stats(struct cdp_hist_stats *src_hist_stats,
 			struct cdp_hist_stats *dst_hist_stats);
+
 const char *dp_hist_tx_hw_delay_str(uint8_t index);
 const char *dp_hist_delay_percentile_str(uint8_t index);
 #endif /* __DP_HIST_H_ */

dp/wifi3.0/dp_reo.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. 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
@@ -66,36 +66,16 @@ void dp_reo_cmd_srng_event_record(struct dp_soc *soc,
 #endif /*WLAN_FEATURE_DP_EVENT_HISTORY */
 
 #ifdef DP_UMAC_HW_RESET_SUPPORT
-/**
- * dp_pause_reo_send_cmd() - Pause Reo send commands.
- * @soc: dp soc
- *
- * Return: status
- */
 void dp_pause_reo_send_cmd(struct dp_soc *soc)
 {
 	hal_unregister_reo_send_cmd(soc->hal_soc);
 }
 
-/**
- * dp_resume_reo_send_cmd() - Resume Reo send commands.
- * @soc: dp soc
- *
- * Return: status
- */
 void dp_resume_reo_send_cmd(struct dp_soc *soc)
 {
 	hal_register_reo_send_cmd(soc->hal_soc);
 }
 
-/**
- * dp_reset_rx_reo_tid_queue() - Reset the reo tid queues
- * @soc: dp soc
- * @hw_qdesc_vaddr: starting address of the tid queues
- * @size: size of the memory pointed to by hw_qdesc_vaddr
- *
- * Return: status
- */
 void
 dp_reset_rx_reo_tid_queue(struct dp_soc *soc, void *hw_qdesc_vaddr,
 			  uint32_t size)
@@ -195,11 +175,6 @@ next:
 	return processed_count;
 }
 
-/**
- * dp_reo_cmdlist_destroy - Free REO commands in the queue
- * @soc: DP SoC handle
- *
- */
 void dp_reo_cmdlist_destroy(struct dp_soc *soc)
 {
 	struct dp_reo_cmd_info *reo_cmd = NULL;
@@ -221,11 +196,6 @@ void dp_reo_cmdlist_destroy(struct dp_soc *soc)
 }
 
 #ifdef DP_UMAC_HW_RESET_SUPPORT
-/**
- * dp_cleanup_reo_cmd_module - Clean up the reo cmd module
- * @soc: DP SoC handle
- *
- */
 void dp_cleanup_reo_cmd_module(struct dp_soc *soc)
 {
 	dp_reo_cmdlist_destroy(soc);

dp/wifi3.0/dp_rx_desc.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
+ * Copyright (c) 2021-2023 Qualcomm Innovation Center, Inc. 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
@@ -28,14 +28,6 @@ A_COMPILE_TIME_ASSERT(cookie_size_check,
 		       sizeof(union dp_rx_desc_list_elem_t))
 		      <= (1 << DP_RX_DESC_PAGE_ID_SHIFT));
 
-/*
- * dp_rx_desc_pool_is_allocated() - check if memory is allocated for the
- *					rx descriptor pool
- *
- * @rx_desc_pool: rx descriptor pool pointer
- * Return: QDF_STATUS  QDF_STATUS_SUCCESS
- *		       QDF_STATUS_E_NOMEM
- */
 QDF_STATUS dp_rx_desc_pool_is_allocated(struct rx_desc_pool *rx_desc_pool)
 {
 	if (!rx_desc_pool->desc_pages.num_pages) {
@@ -48,18 +40,6 @@ QDF_STATUS dp_rx_desc_pool_is_allocated(struct rx_desc_pool *rx_desc_pool)
 
 qdf_export_symbol(dp_rx_desc_pool_is_allocated);
 
-/*
- * dp_rx_desc_pool_alloc() - Allocate a memory pool for software rx
- *			     descriptors
- *
- * @soc: core txrx main context
- * @num_elem: number of rx descriptors (size of the pool)
- * @rx_desc_pool: rx descriptor pool pointer
- *
- * Return: QDF_STATUS  QDF_STATUS_SUCCESS
- *		       QDF_STATUS_E_NOMEM
- *		       QDF_STATUS_E_FAULT
- */
 QDF_STATUS dp_rx_desc_pool_alloc(struct dp_soc *soc,
 				 uint32_t num_elem,
 				 struct rx_desc_pool *rx_desc_pool)
@@ -130,17 +110,6 @@ QDF_STATUS dp_rx_desc_pool_init_generic(struct dp_soc *soc,
 	return QDF_STATUS_SUCCESS;
 }
 
-/*
- * dp_rx_desc_pool_init() - Initialize the software RX descriptor pool
- *			convert the pool of memory into a list of
- *			rx descriptors and create locks to access this
- *			list of rx descriptors.
- *
- * @soc: core txrx main context
- * @pool_id: pool_id which is one of 3 mac_ids
- * @pool_size: size of the rx descriptor pool
- * @rx_desc_pool: rx descriptor pool pointer
- */
 void dp_rx_desc_pool_init(struct dp_soc *soc, uint32_t pool_id,
 			  uint32_t pool_size, struct rx_desc_pool *rx_desc_pool)
 {
@@ -304,15 +273,6 @@ void dp_rx_desc_pool_deinit(struct dp_soc *soc,
 
 qdf_export_symbol(dp_rx_desc_pool_deinit);
 #else
-/*
- * dp_rx_desc_pool_is_allocated() - check if memory is allocated for the
- *					rx descriptor pool
- *
- * @rx_desc_pool: rx descriptor pool pointer
- *
- * Return: QDF_STATUS  QDF_STATUS_SUCCESS
- *		       QDF_STATUS_E_NOMEM
- */
 QDF_STATUS dp_rx_desc_pool_is_allocated(struct rx_desc_pool *rx_desc_pool)
 {
 	if (!rx_desc_pool->array) {
@@ -324,18 +284,6 @@ QDF_STATUS dp_rx_desc_pool_is_allocated(struct rx_desc_pool *rx_desc_pool)
 
 qdf_export_symbol(dp_rx_desc_pool_is_allocated);
 
-/*
- * dp_rx_desc_pool_alloc() - Allocate a memory pool for software rx
- *			     descriptors
- *
- * @soc: core txrx main context
- * @num_elem: number of rx descriptors (size of the pool)
- * @rx_desc_pool: rx descriptor pool pointer
- *
- * Return: QDF_STATUS  QDF_STATUS_SUCCESS
- *		       QDF_STATUS_E_NOMEM
- *		       QDF_STATUS_E_FAULT
- */
 QDF_STATUS dp_rx_desc_pool_alloc(struct dp_soc *soc,
 				 uint32_t pool_size,
 				 struct rx_desc_pool *rx_desc_pool)
@@ -372,17 +320,6 @@ QDF_STATUS dp_rx_desc_pool_init_generic(struct dp_soc *soc,
 	return QDF_STATUS_SUCCESS;
 }
 
-/*
- * dp_rx_desc_pool_init() - Initialize the software RX descriptor pool
- *			convert the pool of memory into a list of
- *			rx descriptors and create locks to access this
- *			list of rx descriptors.
- *
- * @soc: core txrx main context
- * @pool_id: pool_id which is one of 3 mac_ids
- * @pool_size: size of the rx descriptor pool
- * @rx_desc_pool: rx descriptor pool pointer
- */
 void dp_rx_desc_pool_init(struct dp_soc *soc, uint32_t pool_id,
 			  uint32_t pool_size, struct rx_desc_pool *rx_desc_pool)
 {
@@ -456,14 +393,6 @@ void dp_rx_desc_nbuf_free(struct dp_soc *soc,
 
 qdf_export_symbol(dp_rx_desc_nbuf_free);
 
-/**
- * dp_rx_desc_frag_free() - Free desc frag buffer
- *
- * @soc: core txrx main context
- * @rx_desc_pool: rx descriptor pool pointer
- *
- * Return: None
- */
 #ifdef DP_RX_MON_MEM_FRAG
 void dp_rx_desc_frag_free(struct dp_soc *soc,
 			  struct rx_desc_pool *rx_desc_pool)
@@ -511,7 +440,7 @@ void dp_rx_desc_pool_deinit(struct dp_soc *soc,
 	rx_desc_pool->freelist = NULL;
 	rx_desc_pool->pool_size = 0;
 
-	/* Deinitialize rx mon desr frag flag */
+	/* Deinitialize rx mon dest frag flag */
 	rx_desc_pool->rx_mon_dest_frag_enable = false;
 
 	soc->arch_ops.dp_rx_desc_pool_deinit(soc, rx_desc_pool, pool_id);
@@ -530,19 +459,6 @@ void dp_rx_desc_pool_deinit_generic(struct dp_soc *soc,
 {
 }
 
-/*
- * dp_rx_get_free_desc_list() - provide a list of descriptors from
- *				the free rx desc pool.
- *
- * @soc: core txrx main context
- * @pool_id: pool_id which is one of 3 mac_ids
- * @rx_desc_pool: rx descriptor pool pointer
- * @num_descs: number of descs requested from freelist
- * @desc_list: attach the descs to this list (output parameter)
- * @tail: attach the point to last desc of free list (output parameter)
- *
- * Return: number of descs allocated from free list.
- */
 uint16_t dp_rx_get_free_desc_list(struct dp_soc *soc, uint32_t pool_id,
 				struct rx_desc_pool *rx_desc_pool,
 				uint16_t num_descs,
@@ -571,16 +487,6 @@ uint16_t dp_rx_get_free_desc_list(struct dp_soc *soc, uint32_t pool_id,
 
 qdf_export_symbol(dp_rx_get_free_desc_list);
 
-/*
- * dp_rx_add_desc_list_to_free_list() - append unused desc_list back to
- *					freelist.
- *
- * @soc: core txrx main context
- * @local_desc_list: local desc list provided by the caller
- * @tail: attach the point to last desc of local desc list
- * @pool_id: pool_id which is one of 3 mac_ids
- * @rx_desc_pool: rx descriptor pool pointer
- */
 void dp_rx_add_desc_list_to_free_list(struct dp_soc *soc,
 				union dp_rx_desc_list_elem_t **local_desc_list,
 				union dp_rx_desc_list_elem_t **tail,

dp/wifi3.0/dp_rx_err.c

@@ -183,15 +183,6 @@ void dp_rx_link_desc_refill_duplicate_check(
 	*buf_info = current_link_desc_buf_info;
 }
 
-/**
- * dp_rx_link_desc_return_by_addr - Return a MPDU link descriptor to
- *					(WBM) by address
- *
- * @soc: core DP main context
- * @link_desc_addr: link descriptor addr
- *
- * Return: QDF_STATUS
- */
 QDF_STATUS
 dp_rx_link_desc_return_by_addr(struct dp_soc *soc,
 			       hal_buff_addrinfo_t link_desc_addr,
@@ -255,15 +246,6 @@ done:
 
 qdf_export_symbol(dp_rx_link_desc_return_by_addr);
 
-/**
- * dp_rx_link_desc_return() - Return a MPDU link descriptor to HW
- *				(WBM), following error handling
- *
- * @soc: core DP main context
- * @ring_desc: opaque pointer to the REO error ring descriptor
- *
- * Return: QDF_STATUS
- */
 QDF_STATUS
 dp_rx_link_desc_return(struct dp_soc *soc, hal_ring_desc_t ring_desc,
 		       uint8_t bm_action)
@@ -281,8 +263,7 @@ dp_rx_link_desc_return(struct dp_soc *soc, hal_ring_desc_t ring_desc,
  * @soc: core txrx main context
  * @ring_desc: opaque pointer to the REO error ring descriptor
  * @mpdu_desc_info: MPDU descriptor information from ring descriptor
- * @head: head of the local descriptor free-list
- * @tail: tail of the local descriptor free-list
+ * @mac_id: mac ID
  * @quota: No. of units (packets) that can be serviced in one shot.
  *
  * This function is used to drop all MSDU in an MPDU
@@ -422,8 +403,7 @@ more_msdu_link_desc:
  * @soc: core txrx main context
  * @ring_desc: opaque pointer to the REO error ring descriptor
  * @mpdu_desc_info: MPDU descriptor information from ring descriptor
- * @head: head of the local descriptor free-list
- * @tail: tail of the local descriptor free-list
+ * @mac_id: mac ID
  * @quota: No. of units (packets) that can be serviced in one shot.
  *
  * This function implements PN error handling
@@ -478,7 +458,7 @@ dp_rx_pn_error_handle(struct dp_soc *soc, hal_ring_desc_t ring_desc,
 /**
  * dp_rx_deliver_oor_frame() - deliver OOR frames to stack
  * @soc: Datapath soc handler
- * @peer: pointer to DP peer
+ * @txrx_peer: pointer to DP peer
  * @nbuf: pointer to the skb of RX frame
  * @frame_mask: the mask for special frame needed
  * @rx_tlv_hdr: start of rx tlv header
@@ -726,6 +706,8 @@ _dp_rx_bar_frame_handle(struct dp_soc *soc, qdf_nbuf_t nbuf,
  * @ring_desc: Hal ring desc
  * @rx_desc: dp rx desc
  * @mpdu_desc_info: mpdu desc info
+ * @err_status: error status
+ * @err_code: error code
  *
  * Handle the error BAR frames received. Ensure the SOC level
  * stats are updated based on the REO error code. The BAR frames
@@ -781,31 +763,8 @@ dp_rx_bar_frame_handle(struct dp_soc *soc,
 
 #endif /* QCA_HOST_MODE_WIFI_DISABLED */
 
-/**
- * dp_2k_jump_handle() - Function to handle 2k jump exception
- *                        on WBM ring
- *
- * @soc: core DP main context
- * @nbuf: buffer pointer
- * @rx_tlv_hdr: start of rx tlv header
- * @peer_id: peer id of first msdu
- * @tid: Tid for which exception occurred
- *
- * This function handles 2k jump violations arising out
- * of receiving aggregates in non BA case. This typically
- * may happen if aggregates are received on a QOS enabled TID
- * while Rx window size is still initialized to value of 2. Or
- * it may also happen if negotiated window size is 1 but peer
- * sends aggregates.
- *
- */
-
-void
-dp_2k_jump_handle(struct dp_soc *soc,
-		  qdf_nbuf_t nbuf,
-		  uint8_t *rx_tlv_hdr,
-		  uint16_t peer_id,
-		  uint8_t tid)
+void dp_2k_jump_handle(struct dp_soc *soc, qdf_nbuf_t nbuf, uint8_t *rx_tlv_hdr,
+		       uint16_t peer_id, uint8_t tid)
 {
 	struct dp_peer *peer = NULL;
 	struct dp_rx_tid *rx_tid = NULL;
@@ -956,14 +915,6 @@ dp_rx_deliver_to_osif_stack(struct dp_soc *soc,
 #endif
 
 #ifdef WLAN_FEATURE_11BE_MLO
-/*
- * dp_rx_err_match_dhost() - function to check whether dest-mac is correct
- * @eh: Ethernet header of incoming packet
- * @vdev: dp_vdev object of the VAP on which this data packet is received
- *
- * Return: 1 if the destination mac is correct,
- *         0 if this frame is not correctly destined to this VAP/MLD
- */
 int dp_rx_err_match_dhost(qdf_ether_header_t *eh, struct dp_vdev *vdev)
 {
 	return ((qdf_mem_cmp(eh->ether_dhost, &vdev->mac_addr.raw[0],
@@ -1327,19 +1278,6 @@ process_next_msdu:
 
 #endif /* QCA_HOST_MODE_WIFI_DISABLED */
 
-/**
- * dp_rx_process_rxdma_err() - Function to deliver rxdma unencrypted_err
- *			       frames to OS or wifi parse errors.
- * @soc: core DP main context
- * @nbuf: buffer pointer
- * @rx_tlv_hdr: start of rx tlv header
- * @txrx_peer: peer reference
- * @err_code: rxdma err code
- * @mac_id: mac_id which is one of 3 mac_ids(Assuming mac_id and
- * pool_id has same mapping)
- *
- * Return: None
- */
 void
 dp_rx_process_rxdma_err(struct dp_soc *soc, qdf_nbuf_t nbuf,
 			uint8_t *rx_tlv_hdr, struct dp_txrx_peer *txrx_peer,
@@ -1494,15 +1432,6 @@ process_rx:
 	return;
 }
 
-/**
- * dp_rx_process_mic_error(): Function to pass mic error indication to umac
- * @soc: core DP main context
- * @nbuf: buffer pointer
- * @rx_tlv_hdr: start of rx tlv header
- * @txrx_peer: txrx peer handle
- *
- * return: void
- */
 void dp_rx_process_mic_error(struct dp_soc *soc, qdf_nbuf_t nbuf,
 			     uint8_t *rx_tlv_hdr,
 			     struct dp_txrx_peer *txrx_peer)
@@ -1781,7 +1710,7 @@ dp_rx_link_cookie_invalidate(hal_ring_desc_t ring_desc)
  * @sw_cookie: SW cookie of the buffer in RX err ring
  * @rbm: Return buffer manager of the buffer in RX err ring
  *
- * Returns: None
+ * Return: None
  */
 static inline void
 dp_rx_err_ring_record_entry(struct dp_soc *soc, uint64_t paddr,
@@ -1921,19 +1850,19 @@ static int dp_rx_err_exception(struct dp_soc *soc, hal_ring_desc_t ring_desc)
 #endif /* HANDLE_RX_REROUTE_ERR */
 
 #ifdef WLAN_MLO_MULTI_CHIP
-/*
+/**
  * dp_idle_link_bm_id_check() - war for HW issue
  *
- * This is a war for HW issue where link descriptor
- * of partner soc received due to packets wrongly
- * interpreted as fragments
- *
  * @soc: DP SOC handle
  * @rbm: idle link RBM value
  * @ring_desc: reo error link descriptor
  *
- * returns: true in case link desc is consumed
- *	    false in other cases
+ * This is a war for HW issue where link descriptor
+ * of partner soc received due to packets wrongly
+ * interpreted as fragments
+ *
+ * Return: true in case link desc is consumed
+ *	   false in other cases
  */
 static bool dp_idle_link_bm_id_check(struct dp_soc *soc, uint8_t rbm,
 				     void *ring_desc)
@@ -2745,7 +2674,7 @@ static void dup_desc_dbg(struct dp_soc *soc,
  * @rxdma_dst_ring_desc: void pointer to monitor link descriptor buf addr info
  * @head: head of descs list to be freed
  * @tail: tail of decs list to be freed
-
+ *
  * Return: number of msdu in MPDU to be popped
  */
 static inline uint32_t
@@ -3054,26 +2983,6 @@ dp_wbm_int_err_mpdu_pop(struct dp_soc *soc, uint32_t mac_id,
 	} while (buf_info.paddr);
 }
 
-/*
- *
- * dp_handle_wbm_internal_error() - handles wbm_internal_error case
- *
- * @soc: core DP main context
- * @hal_desc: hal descriptor
- * @buf_type: indicates if the buffer is of type link disc or msdu
- * Return: None
- *
- * wbm_internal_error is seen in following scenarios :
- *
- * 1.  Null pointers detected in WBM_RELEASE_RING descriptors
- * 2.  Null pointers detected during delinking process
- *
- * Some null pointer cases:
- *
- * a. MSDU buffer pointer is NULL
- * b. Next_MSDU_Link_Desc pointer is NULL, with no last msdu flag
- * c. MSDU buffer pointer is NULL or Next_Link_Desc pointer is NULL
- */
 void
 dp_handle_wbm_internal_error(struct dp_soc *soc, void *hal_desc,
 			     uint32_t buf_type)

dp/wifi3.0/dp_tx_flow_control.c

@@ -205,13 +205,6 @@ dp_tx_flow_ctrl_reset_subqueues(struct dp_soc *soc,
 
 #endif
 
-/**
- * dp_tx_dump_flow_pool_info() - dump global_pool and flow_pool info
- *
- * @ctx: Handle to struct dp_soc.
- *
- * Return: none
- */
 void dp_tx_dump_flow_pool_info(struct cdp_soc_t *soc_hdl)
 {
 	struct dp_soc *soc = cdp_soc_t_to_dp_soc(soc_hdl);
@@ -665,7 +658,7 @@ void dp_tx_flow_pool_unmap_handler(struct dp_pdev *pdev, uint8_t flow_id,
 
 /**
  * dp_tx_flow_control_init() - Initialize tx flow control
- * @tx_desc_pool: Handle to flow_pool
+ * @soc: Handle to struct dp_soc
  *
  * Return: none
  */
@@ -676,7 +669,7 @@ void dp_tx_flow_control_init(struct dp_soc *soc)
 
 /**
  * dp_tx_desc_pool_dealloc() - De-allocate tx desc pool
- * @tx_desc_pool: Handle to flow_pool
+ * @soc: Handle to struct dp_soc
  *
  * Return: none
  */
@@ -697,7 +690,7 @@ static inline void dp_tx_desc_pool_dealloc(struct dp_soc *soc)
 
 /**
  * dp_tx_flow_control_deinit() - Deregister fw based tx flow control
- * @tx_desc_pool: Handle to flow_pool
+ * @soc: Handle to struct dp_soc
  *
  * Return: none
  */
@@ -710,7 +703,7 @@ void dp_tx_flow_control_deinit(struct dp_soc *soc)
 
 /**
  * dp_txrx_register_pause_cb() - Register pause callback
- * @ctx: Handle to struct dp_soc
+ * @handle: Handle to struct dp_soc
  * @pause_cb: Tx pause_cb
  *
  * Return: none

dp/wifi3.0/dp_umac_reset.c

@@ -177,7 +177,8 @@ QDF_STATUS dp_soc_umac_reset_deinit(struct cdp_soc_t *txrx_soc)
 }
 
 /**
- * dp_umac_reset_get_rx_event() - Extract the Rx event from the shared memory
+ * dp_umac_reset_get_rx_event_from_shmem() - Extract the Rx event from the
+ *                                           shared memory
  * @umac_reset_ctx: UMAC reset context
  *
  * Return: Extracted Rx event in the form of enumeration umac_reset_rx_event

dp/wifi3.0/dp_wdi_event.c

@@ -27,7 +27,7 @@
 #include <qdf_module.h>
 
 #ifdef WDI_EVENT_ENABLE
-/*
+/**
  * dp_wdi_event_next_sub() - Return handle for Next WDI event
  * @wdi_sub: WDI Event handle
  *
@@ -47,12 +47,13 @@ dp_wdi_event_next_sub(wdi_event_subscribe *wdi_sub)
 }
 
 
-/*
- * dp_wdi_event_del_subs() -Delete Event subscription
+/**
+ * dp_wdi_event_del_subs() - Delete Event subscription
  * @wdi_sub: WDI Event handle
  * @event_index: Event index from list
  *
  * This API will delete subscribed event from list
+ *
  * Return: None
  */
 static inline void
@@ -62,12 +63,12 @@ dp_wdi_event_del_subs(wdi_event_subscribe *wdi_sub, int event_index)
 }
 
 
-/*
+/**
  * dp_wdi_event_iter_sub() - Iterate through all WDI event in the list
  * and pass WDI event to callback function
  * @pdev: DP pdev handle
  * @event_index: Event index in list
- * @wdi_event: WDI event handle
+ * @wdi_sub: WDI event subscriber
  * @data: pointer to data
  * @peer_id: peer id number
  * @status: HTT rx status
@@ -95,19 +96,6 @@ dp_wdi_event_iter_sub(
 }
 
 
-/*
- * dp_wdi_event_handler() - Event handler for WDI event
- * @event: wdi event number
- * @soc: soc handle
- * @data: pointer to data
- * @peer_id: peer id number
- * @status: HTT rx status
- * @pdev_id: id of pdev
- *
- * It will be called to register WDI event
- *
- * Return: None
- */
 void
 dp_wdi_event_handler(
 	enum WDI_EVENT event,
@@ -149,15 +137,6 @@ dp_wdi_event_handler(
 
 qdf_export_symbol(dp_wdi_event_handler);
 
-/*
- * dp_wdi_event_sub() - Subscribe WDI event
- * @soc: soc handle
- * @pdev_id: id of pdev
- * @event_cb_sub_handle: subscribe event handle
- * @event: Event to be subscribe
- *
- * Return: 0 for success. nonzero for failure.
- */
 int
 dp_wdi_event_sub(
 	struct cdp_soc_t *soc, uint8_t pdev_id,
@@ -222,16 +201,6 @@ dp_wdi_event_sub(
 
 }
 
-/*
- * dp_wdi_event_unsub() - WDI event unsubscribe
- * @soc: soc handle
- * @pdev_id: id of pdev
- * @event_cb_sub_handle: subscribed event handle
- * @event: Event to be unsubscribe
- *
- *
- * Return: 0 for success. nonzero for failure.
- */
 int
 dp_wdi_event_unsub(
 	struct cdp_soc_t *soc, uint8_t pdev_id,
@@ -270,12 +239,6 @@ dp_wdi_event_unsub(
 }
 
 
-/*
- * dp_wdi_event_attach() - Attach wdi event
- * @txrx_pdev: DP pdev handle
- *
- * Return: 0 for success. nonzero for failure.
- */
 int
 dp_wdi_event_attach(struct dp_pdev *txrx_pdev)
 {
@@ -297,13 +260,6 @@ dp_wdi_event_attach(struct dp_pdev *txrx_pdev)
 	return 0;
 }
 
-
-/*
- * dp_wdi_event_detach() - Detach WDI event
- * @txrx_pdev: DP pdev handle
- *
- * Return: 0 for success. nonzero for failure.
- */
 int
 dp_wdi_event_detach(struct dp_pdev *txrx_pdev)
 {