qcacmn: Fix hal/wifi3.0/qca6750 documentation

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

Change-Id: I1b8c33da5d4baedb65ce632e983ce0ef5ec8a8f5
CRs-Fixed: 3410755

hal/wifi3.0/qca6750/hal_6750.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2020-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
@@ -118,11 +118,11 @@
 #include "hal_li_api.h"
 #include "hal_li_generic_api.h"
 
-/*
- * hal_rx_msdu_start_nss_get_6750(): API to get the NSS
- * Interval from rx_msdu_start
- *
+/**
+ * hal_rx_msdu_start_nss_get_6750() - API to get the NSS Interval from
+ *                                    rx_msdu_start
  * @buf: pointer to the start of RX PKT TLV header
+ *
  * Return: uint32_t(nss)
  */
 static uint32_t
@@ -139,10 +139,10 @@ hal_rx_msdu_start_nss_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_start_get_len_6750(): API to get the MSDU length
- * from rx_msdu_start TLV
+ * hal_rx_msdu_start_get_len_6750() - 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: (uint32_t)msdu length
  */
 static uint32_t hal_rx_msdu_start_get_len_6750(uint8_t *buf)
@@ -158,10 +158,9 @@ static uint32_t hal_rx_msdu_start_get_len_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_mon_hw_desc_get_mpdu_status_6750(): Retrieve MPDU status
- *
- * @ hw_desc_addr: Start address of Rx HW TLVs
- * @ rs: Status for monitor mode
+ * hal_rx_mon_hw_desc_get_mpdu_status_6750() - Retrieve MPDU status
+ * @hw_desc_addr: Start address of Rx HW TLVs
+ * @rs: Status for monitor mode
  *
  * Return: void
  */
@@ -201,10 +200,10 @@ static uint32_t hal_get_link_desc_size_6750(void)
 	return LINK_DESC_SIZE;
 }
 
-/*
- * hal_rx_get_tlv_6750(): API to get the tlv
- *
+/**
+ * hal_rx_get_tlv_6750() - API to get the tlv
  * @rx_tlv: TLV data extracted from the rx packet
+ *
  * Return: uint8_t
  */
 static uint8_t hal_rx_get_tlv_6750(void *rx_tlv)
@@ -216,7 +215,7 @@ static uint8_t hal_rx_get_tlv_6750(void *rx_tlv)
  * hal_rx_proc_phyrx_other_receive_info_tlv_6750()
  *				    - process other receive info TLV
  * @rx_tlv_hdr: pointer to TLV header
- * @ppdu_info: pointer to ppdu_info
+ * @ppdu_info_handle: pointer to ppdu_info
  *
  * Return: None
  */
@@ -251,10 +250,10 @@ void hal_rx_proc_phyrx_other_receive_info_tlv_6750(void *rx_tlv_hdr,
 }
 
 /**
- * hal_rx_dump_msdu_start_tlv_6750() : dump RX msdu_start TLV in structured
- *			     human readable format.
- * @ msdu_start: pointer the msdu_start TLV in pkt.
- * @ dbg_level: log level.
+ * hal_rx_dump_msdu_start_tlv_6750() - dump RX msdu_start TLV in structured
+ *                                     human readable format.
+ * @msdustart: pointer the msdu_start TLV in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -328,10 +327,10 @@ static void hal_rx_dump_msdu_start_tlv_6750(void *msdustart, uint8_t dbg_level)
 }
 
 /**
- * hal_rx_dump_msdu_end_tlv_6750: dump RX msdu_end TLV in structured
- *			     human readable format.
- * @ msdu_end: pointer the msdu_end TLV in pkt.
- * @ dbg_level: log level.
+ * hal_rx_dump_msdu_end_tlv_6750() - dump RX msdu_end TLV in structured
+ *                                   human readable format.
+ * @msduend: pointer the msdu_end TLV in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -472,11 +471,11 @@ static uint32_t hal_rx_mpdu_start_tid_get_6750(uint8_t *buf)
 	RX_MSDU_START_5_RECEPTION_TYPE_MASK,		\
 	RX_MSDU_START_5_RECEPTION_TYPE_LSB))
 
-/*
- * hal_rx_msdu_start_reception_type_get(): API to get the reception type
- * Interval from rx_msdu_start
- *
+/**
+ * hal_rx_msdu_start_reception_type_get_6750() - API to get the reception type
+ *                                               Interval from rx_msdu_start
  * @buf: pointer to the start of RX PKT TLV header
+ *
  * Return: uint32_t(reception_type)
  */
 static
@@ -493,10 +492,9 @@ uint32_t hal_rx_msdu_start_reception_type_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_da_idx_get_6750: API to get da_idx
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_da_idx_get_6750() - API to get da_idx from rx_msdu_end TLV
+ * @buf: pointer to the start of RX PKT TLV headers
  *
- * @ buf: pointer to the start of RX PKT TLV headers
  * Return: da index
  */
 static uint16_t hal_rx_msdu_end_da_idx_get_6750(uint8_t *buf)
@@ -511,10 +509,10 @@ static uint16_t hal_rx_msdu_end_da_idx_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_rx_fragment_number_6750(): Function to retrieve rx fragment number
+ * hal_rx_get_rx_fragment_number_6750() - API to retrieve rx fragment number
+ * @buf: Network buffer
  *
- * @nbuf: Network buffer
- * Returns: rx fragment number
+ * Return: rx fragment number
  */
 static
 uint8_t hal_rx_get_rx_fragment_number_6750(uint8_t *buf)
@@ -528,10 +526,10 @@ uint8_t hal_rx_get_rx_fragment_number_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_da_is_mcbc_get_6750(): API to check if pkt is MCBC
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_da_is_mcbc_get_6750() - API to check if pkt is MCBC
+ *                                         from rx_msdu_end TLV
+ * @buf: pointer to the start of RX PKT TLV headers
  *
- * @ buf: pointer to the start of RX PKT TLV headers
  * Return: da_is_mcbc
  */
 static uint8_t
@@ -544,10 +542,10 @@ hal_rx_msdu_end_da_is_mcbc_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_sa_is_valid_get_6750(): API to get_6750 the
- * sa_is_valid bit from rx_msdu_end TLV
+ * hal_rx_msdu_end_sa_is_valid_get_6750() - API to get_6750 the sa_is_valid bit
+ *                                          from rx_msdu_end TLV
+ * @buf: pointer to the start of RX PKT TLV headers
  *
- * @ buf: pointer to the start of RX PKT TLV headers
  * Return: sa_is_valid bit
  */
 static uint8_t
@@ -563,10 +561,10 @@ hal_rx_msdu_end_sa_is_valid_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_sa_idx_get_6750(): API to get_6750 the
- * sa_idx from rx_msdu_end TLV
+ * hal_rx_msdu_end_sa_idx_get_6750() - API to get_6750 the sa_idx from
+ *                                     rx_msdu_end TLV
+ * @buf: pointer to the start of RX PKT TLV headers
  *
- * @ buf: pointer to the start of RX PKT TLV headers
  * Return: sa_idx (SA AST index)
  */
 static
@@ -583,8 +581,6 @@ uint16_t hal_rx_msdu_end_sa_idx_get_6750(uint8_t *buf)
 
 /**
  * hal_rx_desc_is_first_msdu_6750() - Check if first msdu
- *
- * @hal_soc_hdl: hal_soc handle
  * @hw_desc_addr: hardware descriptor address
  *
  * Return: 0 - success/ non-zero failure
@@ -598,10 +594,10 @@ static uint32_t hal_rx_desc_is_first_msdu_6750(void *hw_desc_addr)
 }
 
 /**
- * hal_rx_msdu_end_l3_hdr_padding_get_6750(): API to get_6750 the
- * l3_header padding from rx_msdu_end TLV
+ * hal_rx_msdu_end_l3_hdr_padding_get_6750() - API to get the l3_header padding
+ *                                             from rx_msdu_end TLV
+ * @buf: pointer to the start of RX PKT TLV headers
  *
- * @ buf: pointer to the start of RX PKT TLV headers
  * Return: number of l3 header padding bytes
  */
 static uint32_t hal_rx_msdu_end_l3_hdr_padding_get_6750(uint8_t *buf)
@@ -615,11 +611,11 @@ static uint32_t hal_rx_msdu_end_l3_hdr_padding_get_6750(uint8_t *buf)
 	return l3_header_padding;
 }
 
-/*
- * @ hal_rx_encryption_info_valid_6750: Returns encryption type.
+/**
+ * hal_rx_encryption_info_valid_6750() - Returns encryption type.
+ * @buf: rx_tlv_hdr of the received packet
  *
- * @ buf: rx_tlv_hdr of the received packet
- * @ Return: encryption type
+ * Return: encryption type
  */
 static uint32_t hal_rx_encryption_info_valid_6750(uint8_t *buf)
 {
@@ -632,11 +628,11 @@ static uint32_t hal_rx_encryption_info_valid_6750(uint8_t *buf)
 	return encryption_info;
 }
 
-/*
- * @ hal_rx_print_pn_6750: Prints the PN of rx packet.
+/**
+ * hal_rx_print_pn_6750() - Prints the PN of rx packet.
+ * @buf: rx_tlv_hdr of the received packet
  *
- * @ buf: rx_tlv_hdr of the received packet
- * @ Return: void
+ * Return: void
  */
 static void hal_rx_print_pn_6750(uint8_t *buf)
 {
@@ -655,10 +651,10 @@ static void hal_rx_print_pn_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_first_msdu_get_6750: API to get first msdu status
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_first_msdu_get_6750() - API to get first msdu status
+ *                                         from rx_msdu_end TLV
+ * @buf: pointer to the start of RX PKT TLV headers
  *
- * @ buf: pointer to the start of RX PKT TLV headers
  * Return: first_msdu
  */
 static uint8_t hal_rx_msdu_end_first_msdu_get_6750(uint8_t *buf)
@@ -673,10 +669,10 @@ static uint8_t hal_rx_msdu_end_first_msdu_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_da_is_valid_get_6750: API to check if da is valid
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_da_is_valid_get_6750() - API to check if da is valid
+ *                                          from rx_msdu_end TLV
+ * @buf: pointer to the start of RX PKT TLV headers
  *
- * @ buf: pointer to the start of RX PKT TLV headers
  * Return: da_is_valid
  */
 static uint8_t hal_rx_msdu_end_da_is_valid_get_6750(uint8_t *buf)
@@ -691,10 +687,10 @@ static uint8_t hal_rx_msdu_end_da_is_valid_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_last_msdu_get_6750: API to get last msdu status
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_last_msdu_get_6750() - API to get last msdu status
+ *                                        from rx_msdu_end TLV
+ * @buf: pointer to the start of RX PKT TLV headers
  *
- * @ buf: pointer to the start of RX PKT TLV headers
  * Return: last_msdu
  */
 static uint8_t hal_rx_msdu_end_last_msdu_get_6750(uint8_t *buf)
@@ -708,11 +704,11 @@ static uint8_t hal_rx_msdu_end_last_msdu_get_6750(uint8_t *buf)
 	return last_msdu;
 }
 
-/*
- * hal_rx_get_mpdu_mac_ad4_valid_6750(): Retrieves if mpdu 4th addr is valid
+/**
+ * hal_rx_get_mpdu_mac_ad4_valid_6750() - Retrieves if mpdu 4th addr is valid
+ * @buf: Network buffer
  *
- * @nbuf: Network buffer
- * Returns: value of mpdu 4th address valid field
+ * Return: value of mpdu 4th address valid field
  */
 static bool hal_rx_get_mpdu_mac_ad4_valid_6750(uint8_t *buf)
 {
@@ -726,7 +722,7 @@ static bool hal_rx_get_mpdu_mac_ad4_valid_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_mpdu_start_sw_peer_id_get_6750: Retrieve sw peer_id
+ * hal_rx_mpdu_start_sw_peer_id_get_6750() - Retrieve sw peer_id
  * @buf: network buffer
  *
  * Return: sw peer_id
@@ -742,10 +738,9 @@ static uint32_t hal_rx_mpdu_start_sw_peer_id_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_mpdu_get_to_ds_6750(): API to get the tods info
- * from rx_mpdu_start
- *
+ * hal_rx_mpdu_get_to_ds_6750() - API to get the tods info from rx_mpdu_start
  * @buf: pointer to the start of RX PKT TLV header
+ *
  * Return: uint32_t(to_ds)
  */
 static uint32_t hal_rx_mpdu_get_to_ds_6750(uint8_t *buf)
@@ -759,11 +754,10 @@ static uint32_t hal_rx_mpdu_get_to_ds_6750(uint8_t *buf)
 	return HAL_RX_MPDU_GET_TODS(mpdu_info);
 }
 
-/*
- * hal_rx_mpdu_get_fr_ds_6750(): API to get the from ds info
- * from rx_mpdu_start
- *
+/**
+ * hal_rx_mpdu_get_fr_ds_6750() - API to get the from ds info from rx_mpdu_start
  * @buf: pointer to the start of RX PKT TLV header
+ *
  * Return: uint32_t(fr_ds)
  */
 static uint32_t hal_rx_mpdu_get_fr_ds_6750(uint8_t *buf)
@@ -777,12 +771,12 @@ static uint32_t hal_rx_mpdu_get_fr_ds_6750(uint8_t *buf)
 	return HAL_RX_MPDU_GET_FROMDS(mpdu_info);
 }
 
-/*
- * hal_rx_get_mpdu_frame_control_valid_6750(): Retrieves mpdu
- * frame control valid
+/**
+ * hal_rx_get_mpdu_frame_control_valid_6750() - Retrieves mpdu
+ *                                              frame control valid
+ * @buf: Network buffer
  *
- * @nbuf: Network buffer
- * Returns: value of frame control valid field
+ * Return: value of frame control valid field
  */
 static uint8_t hal_rx_get_mpdu_frame_control_valid_6750(uint8_t *buf)
 {
@@ -792,11 +786,11 @@ static uint8_t hal_rx_get_mpdu_frame_control_valid_6750(uint8_t *buf)
 	return HAL_RX_MPDU_GET_FRAME_CONTROL_VALID(rx_mpdu_info);
 }
 
-/*
- * hal_rx_mpdu_get_addr1_6750(): API to check get address1 of the mpdu
- *
+/**
+ * hal_rx_mpdu_get_addr1_6750() - API to check get address1 of the mpdu
  * @buf: pointer to the start of RX PKT TLV headera
  * @mac_addr: pointer to mac address
+ *
  * Return: success/failure
  */
 static QDF_STATUS hal_rx_mpdu_get_addr1_6750(uint8_t *buf, uint8_t *mac_addr)
@@ -825,12 +819,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr1_6750(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr2_6750(): API to check get address2 of the mpdu
+/**
+ * hal_rx_mpdu_get_addr2_6750() - API to check get address2 of the mpdu
  * in the packet
- *
  * @buf: pointer to the start of RX PKT TLV header
  * @mac_addr: pointer to mac address
+ *
  * Return: success/failure
  */
 static QDF_STATUS hal_rx_mpdu_get_addr2_6750(uint8_t *buf,
@@ -860,12 +854,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr2_6750(uint8_t *buf,
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr3_6750(): API to get address3 of the mpdu
+/**
+ * hal_rx_mpdu_get_addr3_6750() - API to get address3 of the mpdu
  * in the packet
- *
  * @buf: pointer to the start of RX PKT TLV header
  * @mac_addr: pointer to mac address
+ *
  * Return: success/failure
  */
 static QDF_STATUS hal_rx_mpdu_get_addr3_6750(uint8_t *buf, uint8_t *mac_addr)
@@ -894,12 +888,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr3_6750(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr4_6750(): API to get address4 of the mpdu
+/**
+ * hal_rx_mpdu_get_addr4_6750() - API to get address4 of the mpdu
  * in the packet
- *
  * @buf: pointer to the start of RX PKT TLV header
  * @mac_addr: pointer to mac address
+ *
  * Return: success/failure
  */
 static QDF_STATUS hal_rx_mpdu_get_addr4_6750(uint8_t *buf, uint8_t *mac_addr)
@@ -928,12 +922,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr4_6750(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_get_mpdu_sequence_control_valid_6750(): Get mpdu
- * sequence control valid
+/**
+ * hal_rx_get_mpdu_sequence_control_valid_6750() - Get mpdu sequence
+ *                                                 control valid
+ * @buf: Network buffer
  *
- * @nbuf: Network buffer
- * Returns: value of sequence control valid field
+ * Return: value of sequence control valid field
  */
 static uint8_t hal_rx_get_mpdu_sequence_control_valid_6750(uint8_t *buf)
 {
@@ -944,9 +938,8 @@ static uint8_t hal_rx_get_mpdu_sequence_control_valid_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_is_unicast_6750: check packet is unicast frame or not.
- *
- * @ buf: pointer to rx pkt TLV.
+ * hal_rx_is_unicast_6750() - check packet is unicast frame or not.
+ * @buf: pointer to rx pkt TLV.
  *
  * Return: true on unicast.
  */
@@ -967,9 +960,9 @@ static bool hal_rx_is_unicast_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_tid_get_6750: get tid based on qos control valid.
+ * hal_rx_tid_get_6750() - get tid based on qos control valid.
  * @hal_soc_hdl: hal_soc handle
- * @ buf: pointer to rx pkt TLV.
+ * @buf: pointer to rx pkt TLV.
  *
  * Return: tid
  */
@@ -992,7 +985,7 @@ static uint32_t hal_rx_tid_get_6750(hal_soc_handle_t hal_soc_hdl, uint8_t *buf)
 }
 
 /**
- * hal_rx_hw_desc_get_ppduid_get_6750(): retrieve ppdu id
+ * hal_rx_hw_desc_get_ppduid_get_6750() - retrieve ppdu id
  * @rx_tlv_hdr: rx tlv header
  * @rxdma_dst_ring_desc: rxdma HW descriptor
  *
@@ -1011,10 +1004,10 @@ static uint32_t hal_rx_hw_desc_get_ppduid_get_6750(void *rx_tlv_hdr,
 }
 
 /**
- * hal_reo_status_get_header_6750 - Process reo desc info
+ * hal_reo_status_get_header_6750() - Process reo desc info
  * @ring_desc: REO status ring descriptor
- * @b - tlv type info
- * @h1 - Pointer to hal_reo_status_header where info to be stored
+ * @b: tlv type info
+ * @h1: Pointer to hal_reo_status_header where info to be stored
  *
  * Return - none.
  *
@@ -1115,7 +1108,7 @@ static void hal_reo_status_get_header_6750(hal_ring_desc_t ring_desc, int b,
 }
 
 /**
- * hal_tx_desc_set_mesh_en_6750 - Set mesh_enable flag in Tx descriptor
+ * hal_tx_desc_set_mesh_en_6750() - Set mesh_enable flag in Tx descriptor
  * @desc: Handle to Tx Descriptor
  * @en:   For raw WiFi frames, this indicates transmission to a mesh STA,
  *        enabling the interpretation of the 'Mesh Control Present' bit
@@ -1184,7 +1177,7 @@ hal_rx_get_ppdu_id_6750(uint8_t *buf)
 }
 
 /**
- * hal_reo_config_6750(): Set reo config parameters
+ * hal_reo_config_6750() - Set reo config parameters
  * @soc: hal soc handle
  * @reg_val: value to be set
  * @reo_params: reo parameters
@@ -1201,7 +1194,7 @@ void hal_reo_config_6750(struct hal_soc *soc,
 
 /**
  * hal_rx_msdu_desc_info_get_ptr_6750() - Get msdu desc info ptr
- * @msdu_details_ptr - Pointer to msdu_details_ptr
+ * @msdu_details_ptr: Pointer to msdu_details_ptr
  *
  * Return - Pointer to rx_msdu_desc_info structure.
  *
@@ -1212,8 +1205,8 @@ static void *hal_rx_msdu_desc_info_get_ptr_6750(void *msdu_details_ptr)
 }
 
 /**
- * hal_rx_link_desc_msdu0_ptr_6750 - Get pointer to rx_msdu details
- * @link_desc - Pointer to link desc
+ * hal_rx_link_desc_msdu0_ptr_6750() - Get pointer to rx_msdu details
+ * @link_desc: Pointer to link desc
  *
  * Return - Pointer to rx_msdu_details structure
  *
@@ -1224,8 +1217,8 @@ static void *hal_rx_link_desc_msdu0_ptr_6750(void *link_desc)
 }
 
 /**
- * hal_rx_msdu_flow_idx_get_6750: API to get flow index
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_get_6750() - API to get flow index
+ *                                   from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
  * Return: flow index value from MSDU END TLV
@@ -1239,8 +1232,8 @@ static inline uint32_t hal_rx_msdu_flow_idx_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_flow_idx_invalid_6750: API to get flow index invalid
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_invalid_6750() - API to get flow index invalid
+ *                                       from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
  * Return: flow index invalid value from MSDU END TLV
@@ -1254,8 +1247,8 @@ static bool hal_rx_msdu_flow_idx_invalid_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_flow_idx_timeout_6750: API to get flow index timeout
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_timeout_6750() - API to get flow index timeout
+ *                                       from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
  * Return: flow index timeout value from MSDU END TLV
@@ -1269,8 +1262,8 @@ static bool hal_rx_msdu_flow_idx_timeout_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_fse_metadata_get_6750: API to get FSE metadata
- * from rx_msdu_end TLV
+ * hal_rx_msdu_fse_metadata_get_6750() - API to get FSE metadata
+ *                                       from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
  * Return: fse metadata value from MSDU END TLV
@@ -1284,8 +1277,8 @@ static uint32_t hal_rx_msdu_fse_metadata_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_cce_metadata_get_6750: API to get CCE metadata
- * from rx_msdu_end TLV
+ * hal_rx_msdu_cce_metadata_get_6750() - API to get CCE metadata
+ *                                       from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
  * Return: cce_metadata
@@ -1300,8 +1293,9 @@ hal_rx_msdu_cce_metadata_get_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_get_flow_params_6750: API to get flow index, flow index invalid
- * and flow index timeout from rx_msdu_end TLV
+ * hal_rx_msdu_get_flow_params_6750() - API to get flow index, flow index
+ *                                      invalid and flow index timeout from
+ *                                      rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  * @flow_invalid: pointer to return value of flow_idx_valid
  * @flow_timeout: pointer to return value of flow_idx_timeout
@@ -1336,10 +1330,10 @@ hal_rx_tlv_get_tcp_chksum_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_rx_sequence_6750(): Function to retrieve rx sequence number
+ * hal_rx_get_rx_sequence_6750() - Function to retrieve rx sequence number
+ * @buf: Network buffer
  *
- * @nbuf: Network buffer
- * Returns: rx sequence number
+ * Return: rx sequence number
  */
 static
 uint16_t hal_rx_get_rx_sequence_6750(uint8_t *buf)
@@ -1355,7 +1349,7 @@ uint16_t hal_rx_get_rx_sequence_6750(uint8_t *buf)
 #define CMEM_WINDOW_REMAP_RANGE 0x2
 
 /**
- * hal_get_window_address_6750(): Function to get hp/tp address
+ * hal_get_window_address_6750() - Function to get hp/tp address
  * @hal_soc: Pointer to hal_soc
  * @addr: address offset of register
  *
@@ -1469,10 +1463,9 @@ bool hal_rx_get_fisa_timeout_6750(uint8_t *buf)
 }
 
 /**
- * hal_rx_mpdu_start_tlv_tag_valid_6750 () - API to check if RX_MPDU_START
- * tlv tag is valid
- *
- *@rx_tlv_hdr: start address of rx_pkt_tlvs
+ * hal_rx_mpdu_start_tlv_tag_valid_6750() - API to check if RX_MPDU_START
+ *                                          tlv tag is valid
+ * @rx_tlv_hdr: start address of rx_pkt_tlvs
  *
  * Return: true if RX_MPDU_START is valid, else false.
  */
@@ -1487,8 +1480,8 @@ static uint8_t hal_rx_mpdu_start_tlv_tag_valid_6750(void *rx_tlv_hdr)
 }
 
 /**
- * hal_reo_set_err_dst_remap_6750(): Function to set REO error destination
- *				     ring remap register
+ * hal_reo_set_err_dst_remap_6750() - Function to set REO error destination
+ *                                    ring remap register
  * @hal_soc: Pointer to hal_soc
  *
  * Return: none.
@@ -1542,11 +1535,11 @@ hal_reo_set_err_dst_remap_6750(void *hal_soc)
 			 SEQ_WCSS_UMAC_REO_REG_OFFSET)));
 }
 
-/*
+/**
  * hal_rx_flow_setup_fse_6750() - 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
  * @table_offset: offset into the table where the flow is to be setup
- * @flow: Flow Parameters
+ * @rx_flow: Flow Parameters
  *
  * Flow table entry fields are updated in host byte order, little endian order.
  *
@@ -1656,12 +1649,12 @@ hal_rx_flow_setup_fse_6750(uint8_t *rx_fst, uint32_t table_offset,
 	return fse;
 }
 
-/*
+/**
  * hal_rx_flow_setup_cmem_fse_6750() - Setup a flow search entry in HW CMEM FST
  * @hal_soc: hal_soc reference
  * @cmem_ba: CMEM base address
  * @table_offset: offset into the table where the flow is to be setup
- * @flow: Flow Parameters
+ * @rx_flow: Flow Parameters
  *
  * Return: Success/Failure
  */
@@ -1790,8 +1783,8 @@ hal_rx_flow_get_cmem_fse_6750(struct hal_soc *hal_soc, uint32_t fse_offset,
 }
 
 /**
- * hal_rx_msdu_get_reo_destination_indication_6750: API to get
- * reo_destination_indication from rx_msdu_end TLV
+ * hal_rx_msdu_get_reo_destination_indication_6750() - API to get
+ *                             reo_destination_indication from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  * @reo_destination_indication: pointer to return value of reo_destination_indication
  *
@@ -1868,17 +1861,16 @@ void hal_compute_reo_remap_ix0_6750(uint32_t *remap0)
 
 #ifdef WLAN_FEATURE_MARK_FIRST_WAKEUP_PACKET
 /**
- * hal_get_first_wow_wakeup_packet_6750(): Function to retrieve
- *					   rx_msdu_end_1_reserved_1a
+ * hal_get_first_wow_wakeup_packet_6750() - Function to retrieve
+ *                                          rx_msdu_end_1_reserved_1a
+ * @buf: Network buffer
  *
  * reserved_1a is used by target to tag the first packet that wakes up host from
  * WoW
  *
- * @buf: Network buffer
- *
  * Dummy function for QCA6750
  *
- * Returns: 1 to indicate it is first packet received that wakes up host from
+ * Return: 1 to indicate it is first packet received that wakes up host from
  *	    WoW. Otherwise 0
  */
 static inline uint8_t hal_get_first_wow_wakeup_packet_6750(uint8_t *buf)
@@ -2519,6 +2511,7 @@ struct hal_hw_srng_config hw_srng_table_6750[] = {
 /**
  * hal_qca6750_attach() - Attach 6750 target specific hal_soc ops,
  *			  offset and srng table
+ * @hal_soc: HAL SoC context
  */
 void hal_qca6750_attach(struct hal_soc *hal_soc)
 {

hal/wifi3.0/qca6750/hal_6750_tx.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
@@ -52,7 +52,7 @@ static void hal_tx_desc_set_dscp_tid_table_id_6750(void *desc, uint8_t id)
 
 /**
  * hal_tx_set_dscp_tid_map_6750() - Configure default DSCP to TID map table
- * @soc: HAL SoC context
+ * @hal_soc: HAL SoC context
  * @map: DSCP-TID mapping table
  * @id: mapping table ID - 0-31
  *
@@ -121,11 +121,11 @@ static void hal_tx_set_dscp_tid_map_6750(struct hal_soc *hal_soc, uint8_t *map,
 
 /**
  * hal_tx_update_dscp_tid_6750() - Update the dscp tid map table as updated
- *					by the user
- * @soc: HAL SoC context
- * @map: DSCP-TID mapping table
+ *                                 by the user
+ * @hal_soc: HAL SoC context
+ * @tid: TID
  * @id : MAP ID
- * @dscp: DSCP_TID map index
+ * @dscp: DSCP
  *
  * Return: void
  */
@@ -153,7 +153,7 @@ static void hal_tx_update_dscp_tid_6750(struct hal_soc *hal_soc, uint8_t tid,
 }
 
 /**
- * hal_tx_desc_set_lmac_id_6750 - Set the lmac_id value
+ * hal_tx_desc_set_lmac_id_6750() - Set the lmac_id value
  * @desc: Handle to Tx Descriptor
  * @lmac_id: mac Id to ast matching
  *		     b00 – mac 0
@@ -172,7 +172,7 @@ static void hal_tx_desc_set_lmac_id_6750(void *desc, uint8_t lmac_id)
 /**
  * hal_tx_init_cmd_credit_ring_6750() - Initialize command/credit 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
  */