qcacmn: Fix hal/wifi3.0/qca5018 documentation

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

Change-Id: I72d5664f7ce0dd289d26a006d9e4448b9753f082
CRs-Fixed: 3406484

hal/wifi3.0/qca5018/hal_5018.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
@@ -132,10 +132,10 @@
 #include "hal_li_generic_api.h"
 
 /**
- * hal_rx_msdu_start_nss_get_5018(): API to get the NSS
+ * hal_rx_msdu_start_nss_get_5018() - 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 hal_rx_msdu_start_nss_get_5018(uint8_t *buf)
@@ -151,10 +151,10 @@ static uint32_t hal_rx_msdu_start_nss_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_start_get_len_5018(): API to get the MSDU length
+ * hal_rx_msdu_start_get_len_5018() - 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_5018(uint8_t *buf)
@@ -170,10 +170,10 @@ static uint32_t hal_rx_msdu_start_get_len_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_mon_hw_desc_get_mpdu_status_5018(): Retrieve MPDU status
+ * hal_rx_mon_hw_desc_get_mpdu_status_5018() - Retrieve MPDU status
  *
- * @ hw_desc_addr: Start address of Rx HW TLVs
- * @ rs: Status for monitor mode
+ * @hw_desc_addr: Start address of Rx HW TLVs
+ * @rs: Status for monitor mode
  *
  * Return: void
  */
@@ -207,7 +207,7 @@ static void hal_rx_mon_hw_desc_get_mpdu_status_5018(void *hw_desc_addr,
 
 #define LINK_DESC_SIZE (NUM_OF_DWORDS_RX_MSDU_LINK << 2)
 /**
- * hal_get_link_desc_size_5018(): API to get the link desc size
+ * hal_get_link_desc_size_5018() - API to get the link desc size
  *
  * Return: uint32_t
  */
@@ -217,9 +217,9 @@ static uint32_t hal_get_link_desc_size_5018(void)
 }
 
 /**
- * hal_rx_get_tlv_5018(): API to get the tlv
- *
+ * hal_rx_get_tlv_5018() - API to get the tlv
  * @rx_tlv: TLV data extracted from the rx packet
+ *
  * Return: uint8_t
  */
 static uint8_t hal_rx_get_tlv_5018(void *rx_tlv)
@@ -228,10 +228,10 @@ static uint8_t hal_rx_get_tlv_5018(void *rx_tlv)
 }
 
 /**
- * hal_rx_mpdu_start_tlv_tag_valid_5018 () - API to check if RX_MPDU_START
+ * hal_rx_mpdu_start_tlv_tag_valid_5018() - API to check if RX_MPDU_START
  * tlv tag is valid
  *
- *@rx_tlv_hdr: start address of rx_pkt_tlvs
+ * @rx_tlv_hdr: start address of rx_pkt_tlvs
  *
  * Return: true if RX_MPDU_START is valid, else false.
  */
@@ -246,10 +246,10 @@ uint8_t hal_rx_mpdu_start_tlv_tag_valid_5018(void *rx_tlv_hdr)
 }
 
 /**
- * hal_rx_wbm_err_msdu_continuation_get_5018 () - API to check if WBM
+ * hal_rx_wbm_err_msdu_continuation_get_5018() - API to check if WBM
  * msdu continuation bit is set
  *
- *@wbm_desc: wbm release ring descriptor
+ * @wbm_desc: wbm release ring descriptor
  *
  * Return: true if msdu continuation bit is set.
  */
@@ -348,7 +348,9 @@ void hal_compute_reo_remap_ix2_ix3_5018(uint32_t *ring, uint32_t num_rings,
 }
 
 /**
- * hal_rx_proc_phyrx_other_receive_info_tlv_5018(): API to get tlv info
+ * hal_rx_proc_phyrx_other_receive_info_tlv_5018() - API to get tlv info
+ * @rx_tlv_hdr: start address of rx_pkt_tlvs
+ * @ppdu_info_hdl: PPDU info handle to fill
  *
  * Return: uint32_t
  */
@@ -403,10 +405,10 @@ void hal_rx_get_rtt_info_5018(void *rx_tlv,
 #endif
 
 /**
- * hal_rx_dump_msdu_start_tlv_5018() : 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_5018() - dump RX msdu_start TLV in structured
+ *			               human readable format.
+ * @msdustart: pointer the msdu_start TLV in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -478,10 +480,10 @@ static void hal_rx_dump_msdu_start_tlv_5018(void *msdustart,
 }
 
 /**
- * hal_rx_dump_msdu_end_tlv_5018: 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_5018() - dump RX msdu_end TLV in structured
+ *			             human readable format.
+ * @msduend: pointer the msdu_end TLV in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -579,10 +581,9 @@ static void hal_rx_dump_msdu_end_tlv_5018(void *msduend,
 }
 
 /**
- * hal_rx_mpdu_start_tid_get_5018(): API to get tid
- * from rx_msdu_start
- *
+ * hal_rx_mpdu_start_tid_get_5018() - API to get tid from rx_msdu_start
  * @buf: pointer to the start of RX PKT TLV header
+ *
  * Return: uint32_t(tid value)
  */
 static uint32_t hal_rx_mpdu_start_tid_get_5018(uint8_t *buf)
@@ -598,10 +599,10 @@ static uint32_t hal_rx_mpdu_start_tid_get_5018(uint8_t *buf)
 }
 
 /**
- * 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_5018() - 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 uint32_t hal_rx_msdu_start_reception_type_get_5018(uint8_t *buf)
@@ -616,11 +617,10 @@ static uint32_t hal_rx_msdu_start_reception_type_get_5018(uint8_t *buf)
 	return reception_type;
 }
 
- /**
- * hal_rx_msdu_end_da_idx_get_5018: API to get da_idx
- * from rx_msdu_end TLV
+/**
+ * hal_rx_msdu_end_da_idx_get_5018() - 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_5018(uint8_t *buf)
@@ -635,10 +635,10 @@ static uint16_t hal_rx_msdu_end_da_idx_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_rx_fragment_number_5018(): Function to retrieve rx fragment number
+ * hal_rx_get_rx_fragment_number_5018() - 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_5018(uint8_t *buf)
@@ -652,10 +652,10 @@ uint8_t hal_rx_get_rx_fragment_number_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_da_is_mcbc_get_5018(): API to check if pkt is MCBC
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_da_is_mcbc_get_5018() - 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
@@ -668,10 +668,10 @@ hal_rx_msdu_end_da_is_mcbc_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_sa_is_valid_get_5018(): API to get_5018 the
- * sa_is_valid bit from rx_msdu_end TLV
+ * hal_rx_msdu_end_sa_is_valid_get_5018() - API to get_5018 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
@@ -687,10 +687,10 @@ hal_rx_msdu_end_sa_is_valid_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_sa_idx_get_5018(): API to get_5018 the
- * sa_idx from rx_msdu_end TLV
+ * hal_rx_msdu_end_sa_idx_get_5018() - API to get_5018 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 uint16_t hal_rx_msdu_end_sa_idx_get_5018(uint8_t *buf)
@@ -706,8 +706,6 @@ static uint16_t hal_rx_msdu_end_sa_idx_get_5018(uint8_t *buf)
 
 /**
  * hal_rx_desc_is_first_msdu_5018() - Check if first msdu
- *
- * @hal_soc_hdl: hal_soc handle
  * @hw_desc_addr: hardware descriptor address
  *
  * Return: 0 - success/ non-zero failure
@@ -721,10 +719,11 @@ static uint32_t hal_rx_desc_is_first_msdu_5018(void *hw_desc_addr)
 }
 
 /**
- * hal_rx_msdu_end_l3_hdr_padding_get_5018(): API to get_5018 the
- * l3_header padding from rx_msdu_end TLV
+ * hal_rx_msdu_end_l3_hdr_padding_get_5018() - API to get_5018 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_5018(uint8_t *buf)
@@ -739,10 +738,10 @@ static uint32_t hal_rx_msdu_end_l3_hdr_padding_get_5018(uint8_t *buf)
 }
 
 /**
- * @ hal_rx_encryption_info_valid_5018: Returns encryption type.
+ * hal_rx_encryption_info_valid_5018() - 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
  */
 inline uint32_t hal_rx_encryption_info_valid_5018(uint8_t *buf)
 {
@@ -755,11 +754,11 @@ inline uint32_t hal_rx_encryption_info_valid_5018(uint8_t *buf)
 	return encryption_info;
 }
 
-/*
- * @ hal_rx_print_pn_5018: Prints the PN of rx packet.
+/**
+ * hal_rx_print_pn_5018() - 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_5018(uint8_t *buf)
 {
@@ -778,10 +777,10 @@ static void hal_rx_print_pn_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_first_msdu_get_5018: API to get first msdu status
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_first_msdu_get_5018() - 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_5018(uint8_t *buf)
@@ -796,10 +795,10 @@ static uint8_t hal_rx_msdu_end_first_msdu_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_da_is_valid_get_5018: API to check if da is valid
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_da_is_valid_get_5018() - 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_5018(uint8_t *buf)
@@ -814,10 +813,10 @@ static uint8_t hal_rx_msdu_end_da_is_valid_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_last_msdu_get_5018: API to get last msdu status
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_last_msdu_get_5018() - 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_5018(uint8_t *buf)
@@ -831,11 +830,11 @@ static uint8_t hal_rx_msdu_end_last_msdu_get_5018(uint8_t *buf)
 	return last_msdu;
 }
 
-/*
- * hal_rx_get_mpdu_mac_ad4_valid(): Retrieves if mpdu 4th addr is valid
+/**
+ * hal_rx_get_mpdu_mac_ad4_valid_5018() - 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
  */
 inline bool hal_rx_get_mpdu_mac_ad4_valid_5018(uint8_t *buf)
 {
@@ -849,7 +848,7 @@ inline bool hal_rx_get_mpdu_mac_ad4_valid_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_mpdu_start_sw_peer_id_get_5018: Retrieve sw peer_id
+ * hal_rx_mpdu_start_sw_peer_id_get_5018() - Retrieve sw peer_id
  * @buf: network buffer
  *
  * Return: sw peer_id
@@ -864,11 +863,11 @@ static uint32_t hal_rx_mpdu_start_sw_peer_id_get_5018(uint8_t *buf)
 		&mpdu_start->rx_mpdu_info_details);
 }
 
-/*
- * hal_rx_mpdu_get_to_ds_5018(): API to get the tods info
- * from rx_mpdu_start
- *
+/**
+ * hal_rx_mpdu_get_to_ds_5018() - 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_5018(uint8_t *buf)
@@ -882,11 +881,11 @@ static uint32_t hal_rx_mpdu_get_to_ds_5018(uint8_t *buf)
 	return HAL_RX_MPDU_GET_TODS(mpdu_info);
 }
 
-/*
- * hal_rx_mpdu_get_fr_ds_5018(): API to get the from ds info
- * from rx_mpdu_start
- *
+/**
+ * hal_rx_mpdu_get_fr_ds_5018() - 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_5018(uint8_t *buf)
@@ -900,12 +899,12 @@ static uint32_t hal_rx_mpdu_get_fr_ds_5018(uint8_t *buf)
 	return HAL_RX_MPDU_GET_FROMDS(mpdu_info);
 }
 
-/*
- * hal_rx_get_mpdu_frame_control_valid_5018(): Retrieves mpdu
- * frame control valid
+/**
+ * hal_rx_get_mpdu_frame_control_valid_5018() - 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_5018(uint8_t *buf)
 {
@@ -916,11 +915,11 @@ static uint8_t hal_rx_get_mpdu_frame_control_valid_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_mpdu_frame_control_field_5018(): Function to
- * retrieve frame control field
+ * hal_rx_get_mpdu_frame_control_field_5018() - Function to retrieve
+ *                                              frame control field
+ * @buf: Network buffer
  *
- * @nbuf: Network buffer
- * Returns: value of frame control field
+ * Return: value of frame control field
  */
 static uint16_t hal_rx_get_mpdu_frame_control_field_5018(uint8_t *buf)
 {
@@ -933,11 +932,11 @@ static uint16_t hal_rx_get_mpdu_frame_control_field_5018(uint8_t *buf)
 	return frame_ctrl;
 }
 
-/*
- * hal_rx_mpdu_get_addr1_5018(): API to check get address1 of the mpdu
- *
+/**
+ * hal_rx_mpdu_get_addr1_5018() - 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_5018(uint8_t *buf,
@@ -967,12 +966,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr1_5018(uint8_t *buf,
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr2_5018(): API to check get address2 of the mpdu
- * in the packet
- *
+/**
+ * hal_rx_mpdu_get_addr2_5018() - 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_5018(uint8_t *buf, uint8_t *mac_addr)
@@ -1001,12 +1000,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr2_5018(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr3_5018(): API to get address3 of the mpdu
- * in the packet
- *
+/**
+ * hal_rx_mpdu_get_addr3_5018() - 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_5018(uint8_t *buf, uint8_t *mac_addr)
@@ -1035,12 +1034,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr3_5018(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr4_5018(): API to get address4 of the mpdu
- * in the packet
- *
+/**
+ * hal_rx_mpdu_get_addr4_5018() - 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_5018(uint8_t *buf, uint8_t *mac_addr)
@@ -1069,12 +1068,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr4_5018(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_get_mpdu_sequence_control_valid_5018(): Get mpdu
- * sequence control valid
+/**
+ * hal_rx_get_mpdu_sequence_control_valid_5018() - 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_5018(uint8_t *buf)
 {
@@ -1085,9 +1084,8 @@ static uint8_t hal_rx_get_mpdu_sequence_control_valid_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_is_unicast_5018: check packet is unicast frame or not.
- *
- * @ buf: pointer to rx pkt TLV.
+ * hal_rx_is_unicast_5018() - check packet is unicast frame or not.
+ * @buf: pointer to rx pkt TLV.
  *
  * Return: true on unicast.
  */
@@ -1108,7 +1106,7 @@ static bool hal_rx_is_unicast_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_tid_get_5018: get tid based on qos control valid.
+ * hal_rx_tid_get_5018() - get tid based on qos control valid.
  * @hal_soc_hdl: hal soc handle
  * @buf: pointer to rx pkt TLV.
  *
@@ -1133,7 +1131,7 @@ static uint32_t hal_rx_tid_get_5018(hal_soc_handle_t hal_soc_hdl, uint8_t *buf)
 }
 
 /**
- * hal_rx_hw_desc_get_ppduid_get_5018(): retrieve ppdu id
+ * hal_rx_hw_desc_get_ppduid_get_5018() - retrieve ppdu id
  * @rx_tlv_hdr: rx tlv header
  * @rxdma_dst_ring_desc: rxdma HW descriptor
  *
@@ -1148,10 +1146,10 @@ static uint32_t hal_rx_hw_desc_get_ppduid_get_5018(void *rx_tlv_hdr,
 }
 
 /**
- * hal_reo_status_get_header_5018 - Process reo desc info
+ * hal_reo_status_get_header_5018() - 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.
  *
@@ -1270,7 +1268,7 @@ hal_rx_mpdu_start_mpdu_qos_control_valid_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_sa_sw_peer_id_get_5018(): API to get the
+ * hal_rx_msdu_end_sa_sw_peer_id_get_5018() - API to get the
  * sa_sw_peer_id from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
@@ -1286,7 +1284,7 @@ hal_rx_msdu_end_sa_sw_peer_id_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_tx_desc_set_mesh_en_5018 - Set mesh_enable flag in Tx descriptor
+ * hal_tx_desc_set_mesh_en_5018() - 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
@@ -1361,7 +1359,7 @@ hal_rx_get_ppdu_id_5018(uint8_t *buf)
 }
 
 /**
- * hal_reo_config_5018(): Set reo config parameters
+ * hal_reo_config_5018() - Set reo config parameters
  * @soc: hal soc handle
  * @reg_val: value to be set
  * @reo_params: reo parameters
@@ -1378,7 +1376,7 @@ hal_reo_config_5018(struct hal_soc *soc,
 
 /**
  * hal_rx_msdu_desc_info_get_ptr_5018() - 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.
  *
@@ -1390,7 +1388,7 @@ static void *hal_rx_msdu_desc_info_get_ptr_5018(void *msdu_details_ptr)
 
 /**
  * hal_rx_link_desc_msdu0_ptr_5018 - Get pointer to rx_msdu details
- * @link_desc - Pointer to link desc
+ * @link_desc: Pointer to link desc
  *
  * Return - Pointer to rx_msdu_details structure
  *
@@ -1401,8 +1399,8 @@ static void *hal_rx_link_desc_msdu0_ptr_5018(void *link_desc)
 }
 
 /**
- * hal_rx_msdu_flow_idx_get_5018: API to get flow index
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_get_5018() - 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
@@ -1416,8 +1414,8 @@ static inline uint32_t hal_rx_msdu_flow_idx_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_flow_idx_invalid_5018: API to get flow index invalid
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_invalid_5018() - 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
@@ -1431,7 +1429,7 @@ static bool hal_rx_msdu_flow_idx_invalid_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_flow_idx_timeout_5018: API to get flow index timeout
+ * hal_rx_msdu_flow_idx_timeout_5018() - API to get flow index timeout
  * from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
@@ -1446,7 +1444,7 @@ static bool hal_rx_msdu_flow_idx_timeout_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_fse_metadata_get_5018: API to get FSE metadata
+ * hal_rx_msdu_fse_metadata_get_5018() - API to get FSE metadata
  * from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
@@ -1461,7 +1459,7 @@ static uint32_t hal_rx_msdu_fse_metadata_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_cce_metadata_get_5018: API to get CCE metadata
+ * hal_rx_msdu_cce_metadata_get_5018() - API to get CCE metadata
  * from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
@@ -1477,8 +1475,9 @@ hal_rx_msdu_cce_metadata_get_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_get_flow_params_5018: API to get flow index, flow index invalid
- * and flow index timeout from rx_msdu_end TLV
+ * hal_rx_msdu_get_flow_params_5018() - 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
@@ -1513,10 +1512,10 @@ hal_rx_tlv_get_tcp_chksum_5018(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_rx_sequence_5018(): Function to retrieve rx sequence number
+ * hal_rx_get_rx_sequence_5018() - 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_5018(uint8_t *buf)
@@ -1528,7 +1527,7 @@ uint16_t hal_rx_get_rx_sequence_5018(uint8_t *buf)
 }
 
 /**
- * hal_get_window_address_5018(): Function to get hp/tp address
+ * hal_get_window_address_5018() - Function to get hp/tp address
  * @hal_soc: Pointer to hal_soc
  * @addr: address offset of register
  *
@@ -1568,11 +1567,10 @@ static inline void hal_write_window_register(struct hal_soc *hal_soc)
 }
 
 /**
- * hal_rx_msdu_packet_metadata_get_5018(): 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_5018() - API to get the msdu
+ *                                          information from rx_msdu_end TLV
+ * @buf: pointer to the start of RX PKT TLV headers
+ * @msdu_pkt_metadata: pointer to the msdu info structure
  */
 static void
 hal_rx_msdu_packet_metadata_get_5018(uint8_t *buf,
@@ -1593,9 +1591,9 @@ hal_rx_msdu_packet_metadata_get_5018(uint8_t *buf,
 
 /**
  * hal_rx_flow_setup_fse_5018() - 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
  *
  * Return: Success/Failure
  */
@@ -2307,6 +2305,8 @@ struct hal_hw_srng_config hw_srng_table_5018[] = {
 /**
  * hal_qca5018_attach()- Attach 5018 target specific hal_soc ops,
  *			  offset and srng table
+ * @hal_soc: hal_soc handle
+ *
  * Return: void
  */
 void hal_qca5018_attach(struct hal_soc *hal_soc)

hal/wifi3.0/qca5018/hal_5018_tx.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-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
@@ -114,9 +114,9 @@ static void hal_tx_set_dscp_tid_map_5018(struct hal_soc *soc,
 
 /**
  * hal_tx_update_dscp_tid_5018() - Update the dscp tid map table as
-					updated by user
+ *                                 updated by user
  * @soc: HAL SoC context
- * @map: DSCP-TID mapping table
+ * @tid: TID
  * @id : MAP ID
  * @dscp: DSCP_TID map index
  *
@@ -193,7 +193,7 @@ static void hal_tx_update_dscp_tid_5018(struct hal_soc *soc, uint8_t tid,
 }
 
 /**
- * hal_tx_desc_set_lmac_id_5018 - Set the lmac_id value
+ * hal_tx_desc_set_lmac_id_5018() - Set the lmac_id value
  * @desc: Handle to Tx Descriptor
  * @lmac_id: mac Id to ast matching
  *		     b00 – mac 0
@@ -212,7 +212,7 @@ static void hal_tx_desc_set_lmac_id_5018(void *desc, uint8_t lmac_id)
 /**
  * hal_tx_init_cmd_credit_ring_5018() - Initialize TCL 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
  */