qcacmn: Fix hal/wifi3.0/li documentation

The kernel-doc script identified some documentation issues in the
hal/wifi3.0/li folder, so fix them.

Change-Id: I4ac9d051ac1ba23ddeecdf1b1bb88b939956795e
CRs-Fixed: 3390587

hal/wifi3.0/li/hal_li_api.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021 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
@@ -24,7 +24,7 @@
 #include "hal_api.h"
 
 /**
- * hal_set_link_desc_addr_li - Setup link descriptor in a buffer_addr_info
+ * hal_set_link_desc_addr_li() - Setup link descriptor in a buffer_addr_info
  * HW structure
  *
  * @desc: Descriptor entry (from WBM_IDLE_LINK ring)
@@ -39,7 +39,7 @@ void hal_set_link_desc_addr_li(void *desc, uint32_t cookie,
 /**
  * hal_tx_init_data_ring_li() - Initialize all the TCL Descriptors in SRNG
  * @hal_soc_hdl: Handle to HAL SoC structure
- * @hal_srng: Handle to HAL SRNG structure
+ * @hal_ring_hdl: Handle to HAL SRNG structure
  *
  * Return: none
  */
@@ -48,19 +48,19 @@ void hal_tx_init_data_ring_li(hal_soc_handle_t hal_soc_hdl,
 
 /**
  * hal_hw_txrx_default_ops_attach_li(): Add default ops for Lithium chips
- * @ hal_soc_hdl: hal_soc handle
+ * @hal_soc: hal_soc handle
  *
  * Return: None
  */
-void hal_hw_txrx_default_ops_attach_li(struct hal_soc *soc);
+void hal_hw_txrx_default_ops_attach_li(struct hal_soc *hal_soc);
 
 uint32_t hal_rx_wbm_err_src_get_li(hal_ring_desc_t ring_desc);
 uint8_t hal_rx_ret_buf_manager_get_li(hal_ring_desc_t ring_desc);
 
 /**
- * hal_reo_qdesc_setup - Setup HW REO queue descriptor
- *
- * @hal_soc: Opaque HAL SOC handle
+ * hal_reo_qdesc_setup_li() - Setup HW REO queue descriptor
+ * @hal_soc_hdl: Opaque HAL SOC handle
+ * @tid: TID
  * @ba_window_size: BlockAck window size
  * @start_seq: Starting sequence number
  * @hw_qdesc_vaddr: Virtual address of REO queue descriptor memory

hal/wifi3.0/li/hal_li_generic_api.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
@@ -102,7 +102,7 @@ void hal_tx_init_data_ring_li(hal_soc_handle_t hal_soc_hdl,
 	}
 }
 
-/*
+/**
  * hal_rx_msdu_is_wlan_mcast_generic_li(): Check if the buffer is for multicast
  *					address
  * @nbuf: Network buffer
@@ -138,8 +138,9 @@ static uint32_t hal_rx_tlv_decap_format_get_li(void *hw_desc_addr)
 /**
  * hal_rx_dump_pkt_tlvs_li(): API to print all member elements of
  *			 RX TLVs
- * @ buf: pointer the pkt buffer.
- * @ dbg_level: log level.
+ * @hal_soc_hdl: hal_soc handle
+ * @buf: pointer the pkt buffer.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -191,8 +192,8 @@ hal_rx_tlv_get_offload_info_li(uint8_t *rx_tlv,
 	return 0;
 }
 
-/*
- * hal_rx_attn_phy_ppdu_id_get(): get phy_ppdu_id value
+/**
+ * hal_rx_attn_phy_ppdu_id_get_li(): get phy_ppdu_id value
  * from rx attention
  * @buf: pointer to rx_pkt_tlvs
  *
@@ -210,10 +211,11 @@ static uint16_t hal_rx_attn_phy_ppdu_id_get_li(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_start_msdu_len_get(): API to get the MSDU length
+ * hal_rx_msdu_start_msdu_len_get_li(): API to get the MSDU length
  * from rx_msdu_start TLV
  *
- * @ buf: pointer to the start of RX PKT TLV headers
+ * @buf: pointer to the start of RX PKT TLV headers
+ *
  * Return: msdu length
  */
 static uint32_t hal_rx_msdu_start_msdu_len_get_li(uint8_t *buf)
@@ -386,12 +388,13 @@ uint8_t hal_rx_ret_buf_manager_get_li(hal_ring_desc_t ring_desc)
 }
 
 /**
- * hal_rx_reo_buf_paddr_get_li: Gets the physical address and
+ * hal_rx_reo_buf_paddr_get_li() - Gets the physical address and
  * cookie from the REO destination ring element
  *
- * @ rx_desc: Opaque cookie pointer used by HAL to get to
+ * @rx_desc: Opaque cookie pointer used by HAL to get to
  * the current descriptor
- * @ buf_info: structure to return the buffer information
+ * @buf_info: structure to return the buffer information
+ *
  * Return: void
  */
 static void hal_rx_reo_buf_paddr_get_li(hal_ring_desc_t rx_desc,
@@ -407,12 +410,12 @@ static void hal_rx_reo_buf_paddr_get_li(hal_ring_desc_t rx_desc,
 }
 
 /**
- * hal_rx_msdu_link_desc_set_li: Retrieves MSDU Link Descriptor to WBM
+ * hal_rx_msdu_link_desc_set_li() - Retrieves MSDU Link Descriptor to WBM
  *
- * @ hal_soc_hdl	: HAL version of the SOC pointer
- * @ src_srng_desc	: void pointer to the WBM Release Ring descriptor
- * @ buf_addr_info	: void pointer to the buffer_addr_info
- * @ bm_action		: put in IDLE list or release to MSDU_LIST
+ * @hal_soc_hdl: HAL version of the SOC pointer
+ * @src_srng_desc: void pointer to the WBM Release Ring descriptor
+ * @buf_addr_info: void pointer to the buffer_addr_info
+ * @bm_action: put in IDLE list or release to MSDU_LIST
  *
  * Return: void
  */
@@ -481,14 +484,14 @@ void hal_rx_buf_cookie_rbm_get_li(uint32_t *buf_addr_info_hdl,
 }
 
 /**
- * hal_rx_msdu_link_desc_get(): API to get the MSDU information
+ * hal_rx_msdu_list_get_li(): API to get the MSDU information
  * from the MSDU link descriptor
  *
- * @ hal_soc_hdl	: HAL version of the SOC pointer
+ * @hal_soc_hdl: HAL version of the SOC pointer
  * @msdu_link_desc: Opaque pointer used by HAL to get to the
  * MSDU link descriptor (struct rx_msdu_link)
  *
- * @msdu_list: Return the list of MSDUs contained in this link descriptor
+ * @hal_msdu_list: Return the list of MSDUs contained in this link descriptor
  *
  * @num_msdus: Number of MSDUs in the MPDU
  *
@@ -593,6 +596,7 @@ static uint32_t hal_rx_get_reo_error_code_li(hal_ring_desc_t rx_desc)
 
 /**
  * hal_gen_reo_remap_val_generic_li() - Generate the reo map value
+ * @remap_reg: remap register
  * @ix0_map: mapping values for reo
  *
  * Return: IX0 reo remap register value to be written
@@ -635,7 +639,7 @@ hal_gen_reo_remap_val_generic_li(enum hal_reo_remap_reg remap_reg,
  * hal_rx_tlv_csum_err_get_li() - Get IP and tcp-udp checksum fail flag
  * @rx_tlv_hdr: start address of rx_tlv_hdr
  * @ip_csum_err: buffer to return ip_csum_fail flag
- * @tcp_udp_csum_fail: placeholder to return tcp-udp checksum fail flag
+ * @tcp_udp_csum_err: placeholder to return tcp-udp checksum fail flag
  *
  * Return: None
  */
@@ -974,11 +978,11 @@ hal_rx_tlv_get_is_decrypted_li(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_reo_dst_ind_get_li: Gets the REO
+ * hal_rx_msdu_reo_dst_ind_get_li() - Gets the REO
  * destination ring ID from the msdu desc info
  *
- * @ hal_soc_hdl	: HAL version of the SOC pointer
- * @msdu_link_desc : Opaque cookie pointer used by HAL to get to
+ * @hal_soc_hdl: HAL version of the SOC pointer
+ * @msdu_link_desc: Opaque cookie pointer used by HAL to get to
  * the current descriptor
  *
  * Return: dst_ind (REO destination ring ID)
@@ -1155,13 +1159,6 @@ static uint8_t hal_get_idle_link_bm_id_li(uint8_t chip_id)
 	return WBM_IDLE_DESC_LIST;
 }
 
-/**
- * hal_hw_txrx_default_ops_attach_li() - Attach the default hal ops for
- *		lithium chipsets.
- * @hal_soc_hdl: HAL soc handle
- *
- * Return: None
- */
 void hal_hw_txrx_default_ops_attach_li(struct hal_soc *hal_soc)
 {
 	hal_soc->ops->hal_get_reo_qdesc_size = hal_get_reo_qdesc_size_li;

hal/wifi3.0/li/hal_li_generic_api.h

@@ -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
@@ -49,10 +49,12 @@
 	WBM_RELEASE_RING_2_RXDMA_ERROR_CODE_LSB)
 
 /**
- * hal_rx_wbm_err_info_get_generic_li(): Retrieves WBM error code and reason and
- *	save it to hal_wbm_err_desc_info structure passed by caller
+ * hal_rx_wbm_err_info_get_generic_li() - Retrieves WBM error code and
+ *	reason and save it to hal_wbm_err_desc_info structure passed
+ *	by caller
  * @wbm_desc: wbm ring descriptor
  * @wbm_er_info1: hal_wbm_err_desc_info structure, output parameter.
+ *
  * Return: void
  */
 static inline
@@ -199,8 +201,10 @@ hal_rx_get_crc_he_sig_a_mu_dl_info(struct hal_rx_ppdu_info *ppdu_info,
 #endif /* QCA_UNDECODED_METADATA_SUPPORT */
 
 /**
- * hal_tx_comp_get_status() - TQM Release reason
- * @hal_desc: completion ring Tx status
+ * hal_tx_comp_get_status_generic_li() - Get tx completion status
+ * @desc: tx descriptor
+ * @ts1: completion ring Tx status
+ * @hal: hal_soc object
  *
  * This function will parse the WBM completion descriptor and populate in
  * HAL structure
@@ -270,13 +274,14 @@ hal_tx_comp_get_status_generic_li(void *desc, void *ts1,
 }
 
 /**
- * hal_tx_desc_set_buf_addr - Fill Buffer Address information in Tx Descriptor
+ * hal_tx_desc_set_buf_addr_generic_li() - Fill Buffer Address
+ *                                         information in Tx Descriptor
  * @desc: Handle to Tx Descriptor
  * @paddr: Physical Address
- * @pool_id: Return Buffer Manager ID
+ * @rbm_id: Return Buffer Manager ID
  * @desc_id: Descriptor ID
  * @type: 0 - Address points to a MSDU buffer
- *		1 - Address points to MSDU extension descriptor
+ *        1 - Address points to MSDU extension descriptor
  *
  * Return: void
  */
@@ -317,8 +322,8 @@ hal_tx_desc_set_buf_addr_generic_li(void *desc, dma_addr_t paddr,
 #if defined(QCA_WIFI_QCA6290_11AX_MU_UL) && defined(QCA_WIFI_QCA6290_11AX)
 /**
  * hal_rx_handle_other_tlvs() - handle special TLVs like MU_UL
- * tlv_tag: Taf of the TLVs
- * rx_tlv: the pointer to the TLVs
+ * @tlv_tag: Tag of the TLVs
+ * @rx_tlv: the pointer to the TLVs
  * @ppdu_info: pointer to ppdu_info
  *
  * Return: true if the tlv is handled, false if not
@@ -655,9 +660,11 @@ hal_update_rx_ctrl_frame_stats(struct hal_rx_ppdu_info *ppdu_info,
 #endif /* WLAN_SUPPORT_CTRL_FRAME_STATS */
 
 /**
- * hal_rx_status_get_tlv_info() - process receive info TLV
+ * hal_rx_status_get_tlv_info_generic_li() - process receive info TLV
  * @rx_tlv_hdr: pointer to TLV header
- * @ppdu_info: pointer to ppdu_info
+ * @ppduinfo: pointer to ppdu_info
+ * @hal_soc_hdl: hal_soc handle
+ * @nbuf: pointer the pkt buffer.
  *
  * Return: HAL_TLV_STATUS_PPDU_NOT_DONE or HAL_TLV_STATUS_PPDU_DONE from tlv
  */
@@ -1814,9 +1821,10 @@ static inline uint8_t hal_get_wbm_internal_error_generic_li(void *hal_desc)
 }
 
 /**
- * hal_rx_dump_mpdu_start_tlv_generic_li: dump RX mpdu_start TLV in structured
- *			       human readable format.
- * @mpdu_start: pointer the rx_attention TLV in pkt.
+ * hal_rx_dump_mpdu_start_tlv_generic_li() - dump RX mpdu_start TLV in
+ *			                     structured human readable
+ *			                     format.
+ * @mpdustart: pointer the rx_attention TLV in pkt.
  * @dbg_level: log level.
  *
  * Return: void
@@ -2078,7 +2086,7 @@ hal_tx_update_pcp_tid_generic_li(struct hal_soc *soc,
 /**
  * hal_tx_update_tidmap_prty_generic_li() - Update the tid map priority
  * @soc: HAL SoC context
- * @val: priority value
+ * @value: priority value
  *
  * Return: void
  */
@@ -2095,11 +2103,11 @@ void hal_tx_update_tidmap_prty_generic_li(struct hal_soc *soc, uint8_t value)
 }
 
 /**
- * hal_rx_msdu_packet_metadata_get(): API to get the
- * msdu information from rx_msdu_end TLV
- *
- * @ buf: pointer to the start of RX PKT TLV headers
- * @ hal_rx_msdu_metadata: pointer to the msdu info structure
+ * hal_rx_msdu_packet_metadata_get_generic_li() - API to get the msdu
+ *                                                information from
+ *                                                rx_msdu_end TLV
+ * @buf: pointer to the start of RX PKT TLV headers
+ * @pkt_msdu_metadata: pointer to the msdu info structure
  */
 static void
 hal_rx_msdu_packet_metadata_get_generic_li(uint8_t *buf,
@@ -2119,7 +2127,7 @@ hal_rx_msdu_packet_metadata_get_generic_li(uint8_t *buf,
 }
 
 /**
- * hal_rx_msdu_end_offset_get_generic(): API to get the
+ * hal_rx_msdu_end_offset_get_generic() - API to get the
  * msdu_end structure offset rx_pkt_tlv structure
  *
  * NOTE: API returns offset of msdu_end TLV from structure
@@ -2131,7 +2139,7 @@ static uint32_t hal_rx_msdu_end_offset_get_generic(void)
 }
 
 /**
- * hal_rx_attn_offset_get_generic(): API to get the
+ * hal_rx_attn_offset_get_generic() - API to get the
  * msdu_end structure offset rx_pkt_tlv structure
  *
  * NOTE: API returns offset of attn TLV from structure
@@ -2143,7 +2151,7 @@ static uint32_t hal_rx_attn_offset_get_generic(void)
 }
 
 /**
- * hal_rx_msdu_start_offset_get_generic(): API to get the
+ * hal_rx_msdu_start_offset_get_generic() - API to get the
  * msdu_start structure offset rx_pkt_tlv structure
  *
  * NOTE: API returns offset of attn TLV from structure
@@ -2155,7 +2163,7 @@ static uint32_t hal_rx_msdu_start_offset_get_generic(void)
 }
 
 /**
- * hal_rx_mpdu_start_offset_get_generic(): API to get the
+ * hal_rx_mpdu_start_offset_get_generic() - API to get the
  * mpdu_start structure offset rx_pkt_tlv structure
  *
  * NOTE: API returns offset of attn TLV from structure
@@ -2167,7 +2175,7 @@ static uint32_t hal_rx_mpdu_start_offset_get_generic(void)
 }
 
 /**
- * hal_rx_mpdu_end_offset_get_generic(): API to get the
+ * hal_rx_mpdu_end_offset_get_generic() - API to get the
  * mpdu_end structure offset rx_pkt_tlv structure
  *
  * NOTE: API returns offset of attn TLV from structure
@@ -2212,10 +2220,9 @@ static inline void hal_setup_reo_swap(struct hal_soc *soc)
 #endif
 
 /**
- * hal_reo_setup_generic_li - Initialize HW REO block
- *
- * @hal_soc: Opaque HAL SOC handle
- * @reo_params: parameters needed by HAL for REO config
+ * hal_reo_setup_generic_li() - Initialize HW REO block
+ * @soc: Opaque HAL SOC handle
+ * @reoparams: parameters needed by HAL for REO config
  * @qref_reset: reset qref
  */
 static
@@ -2315,10 +2322,9 @@ void hal_reo_setup_generic_li(struct hal_soc *soc, void *reoparams,
 }
 
 /**
- * hal_setup_link_idle_list_generic_li - Setup scattered idle list using the
- * buffer list provided
- *
- * @hal_soc: Opaque HAL SOC handle
+ * hal_setup_link_idle_list_generic_li() - Setup scattered idle list
+ *                                         using the buffer list provided
+ * @soc: Opaque HAL SOC handle
  * @scatter_bufs_base_paddr: Array of physical base addresses
  * @scatter_bufs_base_vaddr: Array of virtual base addresses
  * @num_scatter_bufs: Number of scatter buffers in the above lists
@@ -2467,7 +2473,7 @@ hal_setup_link_idle_list_generic_li(struct hal_soc *soc,
 
 #ifdef TCL_DATA_CMD_2_SEARCH_TYPE_OFFSET
 /**
- * hal_tx_desc_set_search_type_generic_li - Set the search type value
+ * hal_tx_desc_set_search_type_generic_li() - Set the search type value
  * @desc: Handle to Tx Descriptor
  * @search_type: search type
  *		     0 – Normal search
@@ -2492,7 +2498,7 @@ void hal_tx_desc_set_search_type_generic_li(void *desc, uint8_t search_type)
 
 #ifdef TCL_DATA_CMD_5_SEARCH_INDEX_OFFSET
 /**
- * hal_tx_desc_set_search_index_generic_li - Set the search index value
+ * hal_tx_desc_set_search_index_generic_li() - Set the search index value
  * @desc: Handle to Tx Descriptor
  * @search_index: The index that will be used for index based address or
  *                flow search. The field is valid when 'search_type' is
@@ -2515,7 +2521,7 @@ void hal_tx_desc_set_search_index_generic_li(void *desc, uint32_t search_index)
 
 #ifdef TCL_DATA_CMD_5_CACHE_SET_NUM_OFFSET
 /**
- * hal_tx_desc_set_cache_set_num_generic_li - Set the cache-set-num value
+ * hal_tx_desc_set_cache_set_num_generic_li() - Set the cache-set-num value
  * @desc: Handle to Tx Descriptor
  * @cache_num: Cache set number that should be used to cache the index
  *                based search results, for address and flow search.
@@ -2543,9 +2549,9 @@ void hal_tx_desc_set_cache_set_num_generic_li(void *desc, uint8_t cache_num)
 #ifdef WLAN_SUPPORT_RX_FISA
 /**
  * hal_rx_flow_get_tuple_info_li() - Setup a flow search entry in HW FST
- * @fst: Pointer to the Rx Flow Search Table
+ * @rx_fst: Pointer to the Rx Flow Search Table
  * @hal_hash: HAL 5 tuple hash
- * @tuple_info: 5-tuple info of the flow returned to the caller
+ * @flow_tuple_info: 5-tuple info of the flow returned to the caller
  *
  * Return: Success/Failure
  */
@@ -2614,7 +2620,7 @@ hal_rx_flow_get_tuple_info_li(uint8_t *rx_fst, uint32_t hal_hash,
 
 /**
  * hal_rx_flow_delete_entry_li() - Setup a flow search entry in HW FST
- * @fst: Pointer to the Rx Flow Search Table
+ * @rx_fst: Pointer to the Rx Flow Search Table
  * @hal_rx_fse: Pointer to the Rx Flow that is to be deleted from the FST
  *
  * Return: Success/Failure
@@ -2664,11 +2670,10 @@ hal_rx_fst_get_fse_size_li(void)
 #endif /* WLAN_SUPPORT_RX_FISA */
 
 /**
- * hal_rx_get_frame_ctrl_field(): Function to retrieve frame control field
- *
- * @nbuf: Network buffer
- * Returns: rx more fragment bit
+ * hal_rx_get_frame_ctrl_field_li() - Function to retrieve frame control field
+ * @buf: Network buffer
  *
+ * Return: rx more fragment bit
  */
 static uint16_t hal_rx_get_frame_ctrl_field_li(uint8_t *buf)
 {

hal/wifi3.0/li/hal_li_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
@@ -28,17 +28,6 @@ uint32_t hal_get_reo_reg_base_offset_li(void)
 	return SEQ_WCSS_UMAC_REO_REG_OFFSET;
 }
 
-/**
- * hal_reo_qdesc_setup - Setup HW REO queue descriptor
- *
- * @hal_soc: Opaque HAL SOC handle
- * @ba_window_size: BlockAck window size
- * @start_seq: Starting sequence number
- * @hw_qdesc_vaddr: Virtual address of REO queue descriptor memory
- * @hw_qdesc_paddr: Physical address of REO queue descriptor memory
- * @tid: TID
- *
- */
 void hal_reo_qdesc_setup_li(hal_soc_handle_t hal_soc_hdl, int tid,
 			    uint32_t ba_window_size,
 			    uint32_t start_seq, void *hw_qdesc_vaddr,
@@ -196,13 +185,6 @@ void hal_reo_qdesc_setup_li(hal_soc_handle_t hal_soc_hdl, int tid,
 
 qdf_export_symbol(hal_reo_qdesc_setup_li);
 
-/**
- * hal_get_ba_aging_timeout_li - Get BA Aging timeout
- *
- * @hal_soc: Opaque HAL SOC handle
- * @ac: Access category
- * @value: window size to get
- */
 void hal_get_ba_aging_timeout_li(hal_soc_handle_t hal_soc_hdl, uint8_t ac,
 				 uint32_t *value)
 {
@@ -236,14 +218,6 @@ void hal_get_ba_aging_timeout_li(hal_soc_handle_t hal_soc_hdl, uint8_t ac,
 }
 qdf_export_symbol(hal_get_ba_aging_timeout_li);
 
-/**
- * hal_set_ba_aging_timeout_li - Set BA Aging timeout
- *
- * @hal_soc: Opaque HAL SOC handle
- * @ac: Access category
- * ac: 0 - Background, 1 - Best Effort, 2 - Video, 3 - Voice
- * @value: Input value to set
- */
 void hal_set_ba_aging_timeout_li(hal_soc_handle_t hal_soc_hdl, uint8_t ac,
 				 uint32_t value)
 {

hal/wifi3.0/li/hal_li_reo.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2017-2019, 2021 The Linux Foundation. All rights reserved.
- * Copyright (c) 2021 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
@@ -25,11 +25,25 @@
 
 #define HAL_REO_QUEUE_EXT_DESC 9
 
-/* Proto-types */
+/**
+ * hal_get_ba_aging_timeout_li() - Get BA Aging timeout
+ * @hal_soc_hdl: Opaque HAL SOC handle
+ * @ac: Access category
+ * @value: window size to get
+ */
 void hal_get_ba_aging_timeout_li(hal_soc_handle_t hal_soc_hdl, uint8_t ac,
 				 uint32_t *value);
+
+/**
+ * hal_set_ba_aging_timeout_li() - Set BA Aging timeout
+ * @hal_soc_hdl: Opaque HAL SOC handle
+ * @ac: Access category
+ * ac: 0 - Background, 1 - Best Effort, 2 - Video, 3 - Voice
+ * @value: Input value to set
+ */
 void hal_set_ba_aging_timeout_li(hal_soc_handle_t hal_soc_hdl, uint8_t ac,
 				 uint32_t value);
+
 uint32_t hal_get_reo_reg_base_offset_li(void);
 
 int hal_reo_send_cmd_li(hal_soc_handle_t hal_soc_hdl,
@@ -68,8 +82,8 @@ hal_reo_rx_update_queue_status_li(hal_ring_desc_t ring_desc,
 /**
  * hal_reo_init_cmd_ring_li() - Initialize descriptors of REO command SRNG
  * with command number
- * @hal_soc: Handle to HAL SoC structure
- * @hal_ring: Handle to HAL SRNG structure
+ * @hal_soc_hdl: Handle to HAL SoC structure
+ * @hal_ring_hdl: Handle to HAL SRNG structure
  *
  * Return: none
  */

hal/wifi3.0/li/hal_li_rx.h

@@ -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
@@ -350,9 +350,9 @@ struct rx_mon_pkt_tlvs {
 
 /**
  * hal_rx_get_pkt_tlvs(): Function to retrieve pkt tlvs from nbuf
+ * @rx_buf_start: Pointer to data buffer field
  *
- * @nbuf: Pointer to data buffer field
- * Returns: pointer to rx_pkt_tlvs
+ * Return: pointer to rx_pkt_tlvs
  */
 static inline
 struct rx_pkt_tlvs *hal_rx_get_pkt_tlvs(uint8_t *rx_buf_start)
@@ -362,9 +362,9 @@ struct rx_pkt_tlvs *hal_rx_get_pkt_tlvs(uint8_t *rx_buf_start)
 
 /**
  * hal_rx_get_mpdu_info(): Function to retrieve mpdu info from pkt tlvs
- *
  * @pkt_tlvs: Pointer to pkt_tlvs
- * Returns: pointer to rx_mpdu_info structure
+ *
+ * Return: pointer to rx_mpdu_info structure
  */
 static inline
 struct rx_mpdu_info *hal_rx_get_mpdu_info(struct rx_pkt_tlvs *pkt_tlvs)
@@ -411,9 +411,9 @@ static inline void hal_rx_mon_dest_get_buffer_info_from_tlv(
 		RX_ATTENTION_1_TCP_UDP_CHKSUM_FAIL_MASK,	\
 		RX_ATTENTION_1_TCP_UDP_CHKSUM_FAIL_LSB))
 
-/*
- * hal_rx_attn_tcp_udp_cksum_fail_get(): get tcp_udp cksum fail bit
- * from rx attention
+/**
+ * hal_rx_attn_tcp_udp_cksum_fail_get() - get tcp_udp cksum fail bit
+ *                                        from rx attention
  * @buf: pointer to rx_pkt_tlvs
  *
  * Return: tcp_udp_cksum_fail
@@ -436,9 +436,9 @@ hal_rx_attn_tcp_udp_cksum_fail_get(uint8_t *buf)
 		RX_ATTENTION_1_IP_CHKSUM_FAIL_MASK,	\
 		RX_ATTENTION_1_IP_CHKSUM_FAIL_LSB))
 
-/*
- * hal_rx_attn_ip_cksum_fail_get(): get ip cksum fail bit
- * from rx attention
+/**
+ * hal_rx_attn_ip_cksum_fail_get() - get ip cksum fail bit
+ *                                   from rx attention
  * @buf: pointer to rx_pkt_tlvs
  *
  * Return: ip_cksum_fail
@@ -467,10 +467,11 @@ hal_rx_attn_ip_cksum_fail_get(uint8_t *buf)
 		RX_ATTENTION_1_CCE_MATCH_MASK,			\
 		RX_ATTENTION_1_CCE_MATCH_LSB))
 
-/*
- * hal_rx_msdu_cce_match_get_li(): get CCE match bit
- * from rx attention
+/**
+ * hal_rx_msdu_cce_match_get_li() - get CCE match bit
+ *                                  from rx attention
  * @buf: pointer to rx_pkt_tlvs
+ *
  * Return: CCE match value
  */
 static inline bool
@@ -520,12 +521,13 @@ hal_rx_mpdu_peer_meta_data_get_li(uint8_t *buf)
 		((peer_mdata) << RX_MPDU_INFO_8_PEER_META_DATA_LSB) &	\
 		RX_MPDU_INFO_8_PEER_META_DATA_MASK)
 
-/*
- * @ hal_rx_mpdu_peer_meta_data_set: set peer meta data in RX mpdu start tlv
+/**
+ * hal_rx_mpdu_peer_meta_data_set() - set peer meta data in RX mpdu
+ *                                    start tlv
+ * @buf: rx_tlv_hdr of the received packet
+ * @peer_mdata: peer meta data to be set.
  *
- * @ buf: rx_tlv_hdr of the received packet
- * @ peer_mdata: peer meta data to be set.
- * @ Return: void
+ * Return: void
  */
 static inline void
 hal_rx_mpdu_peer_meta_data_set(uint8_t *buf, uint32_t peer_mdata)
@@ -539,7 +541,7 @@ hal_rx_mpdu_peer_meta_data_set(uint8_t *buf, uint32_t peer_mdata)
 	HAL_RX_MPDU_PEER_META_DATA_SET(mpdu_info, peer_mdata);
 }
 
-/**
+/*
  * LRO information needed from the TLVs
  */
 #define HAL_RX_TLV_GET_LRO_ELIGIBLE(buf) \
@@ -649,10 +651,10 @@ hal_rx_mpdu_peer_meta_data_set(uint8_t *buf, uint32_t peer_mdata)
 		RX_MSDU_START_4_FLOW_ID_TOEPLITZ_LSB))
 
 /**
- * hal_rx_msdu_start_toeplitz_get: API to get the toeplitz hash
- * from rx_msdu_start TLV
+ * hal_rx_msdu_start_toeplitz_get() - API to get the toeplitz hash
+ *                                    from rx_msdu_start TLV
+ * @buf: pointer to the start of RX PKT TLV headers
  *
- * @ buf: pointer to the start of RX PKT TLV headers
  * Return: toeplitz hash
  */
 static inline uint32_t
@@ -697,11 +699,13 @@ hal_rx_msdu_start_toeplitz_get(uint8_t *buf)
 		RX_MSDU_START_5_USER_RSSI_OFFSET)),	\
 		RX_MSDU_START_5_USER_RSSI_MASK,		\
 		RX_MSDU_START_5_USER_RSSI_LSB))
-/*
- * hal_rx_msdu_start_get_rssi(): API to get the rssi of received pkt
- * from rx_msdu_start
+
+/**
+ * hal_rx_msdu_start_get_rssi() - API to get the rssi of received pkt
+ *                                from rx_msdu_start
  *
  * @buf: pointer to the start of RX PKT TLV header
+ *
  * Return: uint32_t(rssi)
  */
 static inline uint32_t
@@ -778,14 +782,14 @@ hal_rx_msdu_start_get_rssi(uint8_t *buf)
 		REO_DESTINATION_RING_7_REO_ERROR_CODE_MASK) >> \
 		REO_DESTINATION_RING_7_REO_ERROR_CODE_LSB)
 
-/*
- * hal_rx_msdu_link_desc_reinject: Re-injects the MSDU link descriptor to
- * REO entrance ring
+/**
+ * hal_rx_msdu_link_desc_reinject() - Re-injects the MSDU link
+ *                                    descriptor to REO entrance ring
  *
- * @ soc: HAL version of the SOC pointer
- * @ pa: Physical address of the MSDU Link Descriptor
- * @ cookie: SW cookie to get to the virtual address
- * @ error_enabled_reo_q: Argument to determine whether this needs to go
+ * @soc: HAL version of the SOC pointer
+ * @pa: Physical address of the MSDU Link Descriptor
+ * @cookie: SW cookie to get to the virtual address
+ * @error_enabled_reo_q: Argument to determine whether this needs to go
  * to the error enabled REO queue
  *
  * Return: void
@@ -837,10 +841,10 @@ HAL_RX_DESC_GET_DECAP_FORMAT(void *hw_desc_addr) {
 }
 
 /**
- * hal_rx_dump_rx_attention_tlv: dump RX attention TLV in structured
- *				 humman readable format.
- * @ rx_attn: pointer the rx_attention TLV in pkt.
- * @ dbg_level: log level.
+ * hal_rx_dump_rx_attention_tlv() - dump RX attention TLV in structured
+ *				    human readable format.
+ * @rx_attn: pointer the rx_attention TLV in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -953,10 +957,10 @@ static inline void hal_rx_dump_rx_attention_tlv(struct rx_attention *rx_attn,
 }
 
 /**
- * hal_rx_dump_mpdu_end_tlv: dump RX mpdu_end TLV in structured
+ * hal_rx_dump_mpdu_end_tlv() - dump RX mpdu_end TLV in structured
  *			     human readable format.
- * @ mpdu_end: pointer the mpdu_end TLV in pkt.
- * @ dbg_level: log level.
+ * @mpdu_end: pointer the mpdu_end TLV in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -1007,9 +1011,9 @@ static inline void hal_rx_dump_pkt_hdr_tlv(struct rx_pkt_tlvs *pkt_tlvs,
 }
 #else
 /**
- * hal_rx_dump_pkt_hdr_tlv: dump RX pkt header TLV in hex format
- * @ pkt_hdr_tlv: pointer the pkt_hdr_tlv in pkt.
- * @ dbg_level: log level.
+ * hal_rx_dump_pkt_hdr_tlv() - dump RX pkt header TLV in hex format
+ * @pkt_tlvs: pointer the pkt_hdr_tlv in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -1032,9 +1036,9 @@ static inline void hal_rx_dump_pkt_hdr_tlv(struct rx_pkt_tlvs *pkt_tlvs,
 		RX_MPDU_INFO_14_MPDU_FRAME_CONTROL_FIELD_LSB))
 /**
  * hal_rx_get_rx_more_frag_bit(): Function to retrieve more fragment bit
+ * @buf: Network buffer
  *
- * @nbuf: Network buffer
- * Returns: rx more fragment bit
+ * Return: rx more fragment bit
  */
 static inline
 uint8_t hal_rx_get_rx_more_frag_bit(uint8_t *buf)
@@ -1113,17 +1117,16 @@ uint32_t hal_rx_msdu_flags_get_li(rx_msdu_desc_info_t msdu_desc_info_hdl)
 	return HAL_RX_MSDU_FLAGS_GET(msdu_desc_info);
 }
 
-/*
- *hal_rx_msdu_desc_info_get_li: Gets the flags related to MSDU descriptor.
- *@desc_addr: REO ring descriptor addr
- *@msdu_desc_info: Holds MSDU descriptor info from HAL Rx descriptor
+/**
+ * hal_rx_msdu_desc_info_get_li() - Gets the flags related to MSDU descriptor.
+ * @desc_addr: REO ring descriptor addr
+ * @msdu_desc_info: Holds MSDU descriptor info from HAL Rx descriptor
  *
  * Specifically flags needed are: first_msdu_in_mpdu,
  * last_msdu_in_mpdu, msdu_continuation, sa_is_valid,
  * sa_idx_timeout, da_is_valid, da_idx_timeout, da_is_MCBC
  *
-
- *Return: void
+ * Return: void
  */
 static inline void
 hal_rx_msdu_desc_info_get_li(void *desc_addr,
@@ -1153,8 +1156,8 @@ hal_rx_msdu_desc_info_get_li(void *desc_addr,
 		RX_ATTENTION_1_MSDU_LENGTH_ERR_LSB))
 
 /**
- * hal_rx_attn_msdu_len_err_get_li(): Get msdu_len_err value from
- *  rx attention tlvs
+ * hal_rx_attn_msdu_len_err_get_li() - Get msdu_len_err value from rx
+ *                                     attention tlvs
  * @buf: pointer to rx pkt tlvs hdr
  *
  * Return: msdu_len_err value

hal/wifi3.0/li/hal_li_tx.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved.
+ * Copyright (c) 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
@@ -38,7 +39,9 @@ enum hal_li_tx_ret_buf_manager {
  */
 
 /**
- * hal_tx_desc_set_buf_addr - Fill Buffer Address information in Tx Descriptor
+ * hal_tx_desc_set_buf_addr() - Fill Buffer Address information in Tx
+ *                              Descriptor
+ * @hal_soc_hdl: hal_soc handle
  * @desc: Handle to Tx Descriptor
  * @paddr: Physical Address
  * @pool_id: Return Buffer Manager ID
@@ -61,7 +64,8 @@ void hal_tx_desc_set_buf_addr(hal_soc_handle_t hal_soc_hdl, void *desc,
 }
 
 /**
- * hal_tx_desc_set_lmac_id_li - Set the lmac_id value
+ * hal_tx_desc_set_lmac_id_li() - Set the lmac_id value
+ * @hal_soc_hdl: hal_soc handle
  * @desc: Handle to Tx Descriptor
  * @lmac_id: mac Id to ast matching
  *                     b00 – mac 0
@@ -80,7 +84,8 @@ static inline void hal_tx_desc_set_lmac_id_li(hal_soc_handle_t hal_soc_hdl,
 }
 
 /**
- * hal_tx_desc_set_search_type_li - Set the search type value
+ * hal_tx_desc_set_search_type_li() - Set the search type value
+ * @hal_soc_hdl: hal_soc handle
  * @desc: Handle to Tx Descriptor
  * @search_type: search type
  *		     0 – Normal search
@@ -99,7 +104,8 @@ static inline void hal_tx_desc_set_search_type_li(hal_soc_handle_t hal_soc_hdl,
 }
 
 /**
- * hal_tx_desc_set_search_index_li - Set the search index value
+ * hal_tx_desc_set_search_index_li() - Set the search index value
+ * @hal_soc_hdl: hal_soc handle
  * @desc: Handle to Tx Descriptor
  * @search_index: The index that will be used for index based address or
  *                flow search. The field is valid when 'search_type' is
@@ -117,7 +123,8 @@ static inline void hal_tx_desc_set_search_index_li(hal_soc_handle_t hal_soc_hdl,
 }
 
 /**
- * hal_tx_desc_set_cache_set_num - Set the cache-set-num value
+ * hal_tx_desc_set_cache_set_num() - Set the cache-set-num value
+ * @hal_soc_hdl: hal_soc handle
  * @desc: Handle to Tx Descriptor
  * @cache_num: Cache set number that should be used to cache the index
  *                based search results, for address and flow search.
@@ -232,10 +239,10 @@ static inline void hal_tx_desc_set_l4_checksum_en(void *desc,
 }
 
 /**
- * hal_tx_desc_set_l3_checksum_en -  Set IPv4 checksum enable flag in
- * Tx Descriptor for MSDU_buffer type
+ * hal_tx_desc_set_l3_checksum_en() -  Set IPv4 checksum enable flag in
+ *                                     Tx Descriptor for MSDU_buffer type
  * @desc: Handle to Tx Descriptor
- * @checksum_en_flags: ipv4 checksum enable flags
+ * @en: ipv4 checksum enable flags
  *
  * Return: void
  */
@@ -247,7 +254,8 @@ static inline void hal_tx_desc_set_l3_checksum_en(void *desc,
 }
 
 /**
- * hal_tx_desc_set_fw_metadata- Sets the metadata that is part of TCL descriptor
+ * hal_tx_desc_set_fw_metadata() - Sets the metadata that is part of
+ *                                 TCL descriptor
  * @desc:Handle to Tx Descriptor
  * @metadata: Metadata to be sent to Firmware
  *
@@ -261,7 +269,7 @@ static inline void hal_tx_desc_set_fw_metadata(void *desc,
 }
 
 /**
- * hal_tx_desc_set_to_fw - Set To_FW bit in Tx Descriptor.
+ * hal_tx_desc_set_to_fw() - Set To_FW bit in Tx Descriptor.
  * @desc:Handle to Tx Descriptor
  * @to_fw: if set, Forward packet to FW along with classification result
  *
@@ -274,7 +282,7 @@ static inline void hal_tx_desc_set_to_fw(void *desc, uint8_t to_fw)
 }
 
 /**
- * hal_tx_desc_set_mesh_en - Set mesh_enable flag in Tx descriptor
+ * hal_tx_desc_set_mesh_en() - Set mesh_enable flag in Tx descriptor
  * @hal_soc_hdl: hal soc handle
  * @desc: Handle to Tx Descriptor
  * @en:   For raw WiFi frames, this indicates transmission to a mesh STA,
@@ -294,7 +302,7 @@ static inline void hal_tx_desc_set_mesh_en(hal_soc_handle_t hal_soc_hdl,
 }
 
 /**
- * hal_tx_desc_set_hlos_tid - Set the TID value (override DSCP/PCP fields in
+ * hal_tx_desc_set_hlos_tid() - Set the TID value (override DSCP/PCP fields in
  * frame) to be used for Tx Frame
  * @desc: Handle to Tx Descriptor
  * @hlos_tid: HLOS TID
@@ -313,7 +321,7 @@ static inline void hal_tx_desc_set_hlos_tid(void *desc,
 
 /**
  * hal_tx_desc_set_dscp_tid_table_id() - Sets DSCP to TID conversion table ID
- * @hal_soc: Handle to HAL SoC structure
+ * @hal_soc_hdl: Handle to HAL SoC structure
  * @desc: Handle to Tx Descriptor
  * @id: DSCP to tid conversion table to be used for this frame
  *
@@ -329,7 +337,7 @@ void hal_tx_desc_set_dscp_tid_table_id(hal_soc_handle_t hal_soc_hdl,
 }
 
 /**
- * hal_tx_desc_clear - Clear the HW descriptor entry
+ * hal_tx_desc_clear() - Clear the HW descriptor entry
  * @hw_desc: Hardware descriptor to be cleared
  *
  * Return: void
@@ -341,8 +349,8 @@ static inline void hal_tx_desc_clear(void *hw_desc)
 }
 
 /**
- * hal_tx_desc_sync - Commit the descriptor to Hardware
- * @hal_tx_des_cached: Cached descriptor that software maintains
+ * hal_tx_desc_sync() - Commit the descriptor to Hardware
+ * @hal_tx_desc_cached: Cached descriptor that software maintains
  * @hw_desc: Hardware descriptor to be updated
  */
 static inline void hal_tx_desc_sync(void *hal_tx_desc_cached,