qcacmn: Fix hal/wifi3.0/qcn9000 documentation

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

Change-Id: I8e15c38f02610a02d9f5a553b328e0bc7333271e
CRs-Fixed: 3411746

hal/wifi3.0/qcn9000/hal_9000.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
@@ -131,12 +131,11 @@
 #include "hal_li_generic_api.h"
 
 /**
- * hal_rx_sw_mon_desc_info_get_9000(): API to read the
- * sw monitor ring descriptor
- *
+ * hal_rx_sw_mon_desc_info_get_9000() - API to read the sw monitor ring
+ *                                      descriptor
  * @rxdma_dst_ring_desc: sw monitor ring descriptor
- * @desc_info_buf: Descriptor info buffer to which
- * sw monitor ring descriptor is populated to
+ * @desc_info_buf: Descriptor info buffer to which sw monitor ring descriptor is
+ *                 populated to
  *
  * Return: void
  */
@@ -188,10 +187,9 @@ hal_rx_sw_mon_desc_info_get_9000(hal_ring_desc_t rxdma_dst_ring_desc,
 }
 
 /**
- * hal_rx_msdu_start_nss_get_9000(): API to get the NSS
- * Interval from rx_msdu_start
- *
+ * hal_rx_msdu_start_nss_get_9000() - API to get the NSS 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_9000(uint8_t *buf)
@@ -207,10 +205,10 @@ static uint32_t hal_rx_msdu_start_nss_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_start_get_len_9000(): API to get the MSDU length
- * from rx_msdu_start TLV
+ * hal_rx_msdu_start_get_len_9000() - 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_9000(uint8_t *buf)
@@ -226,10 +224,9 @@ static uint32_t hal_rx_msdu_start_get_len_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_mon_hw_desc_get_mpdu_status_9000(): 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_9000() - Retrieve MPDU status
+ * @hw_desc_addr: Start address of Rx HW TLVs
+ * @rs: Status for monitor mode
  *
  * Return: void
  */
@@ -263,7 +260,7 @@ static void hal_rx_mon_hw_desc_get_mpdu_status_9000(void *hw_desc_addr,
 
 #define LINK_DESC_SIZE (NUM_OF_DWORDS_RX_MSDU_LINK << 2)
 /**
- * hal_get_link_desc_size_9000(): API to get the link desc size
+ * hal_get_link_desc_size_9000() - API to get the link desc size
  *
  * Return: uint32_t
  */
@@ -273,9 +270,9 @@ static uint32_t hal_get_link_desc_size_9000(void)
 }
 
 /**
- * hal_rx_get_tlv_9000(): API to get the tlv
- *
+ * hal_rx_get_tlv_9000() - API to get the tlv
  * @rx_tlv: TLV data extracted from the rx packet
+ *
  * Return: uint8_t
  */
 static uint8_t hal_rx_get_tlv_9000(void *rx_tlv)
@@ -284,10 +281,9 @@ static uint8_t hal_rx_get_tlv_9000(void *rx_tlv)
 }
 
 /**
- * hal_rx_mpdu_start_tlv_tag_valid_9000 () - 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_9000() - 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.
  */
@@ -302,10 +298,9 @@ uint8_t hal_rx_mpdu_start_tlv_tag_valid_9000(void *rx_tlv_hdr)
 }
 
 /**
- * hal_rx_wbm_err_msdu_continuation_get_9000 () - API to check if WBM
- * msdu continuation bit is set
- *
- *@wbm_desc: wbm release ring descriptor
+ * hal_rx_wbm_err_msdu_continuation_get_9000() - API to check if WBM msdu
+ *                                               continuation bit is set
+ * @wbm_desc: wbm release ring descriptor
  *
  * Return: true if msdu continuation bit is set.
  */
@@ -320,9 +315,11 @@ uint8_t hal_rx_wbm_err_msdu_continuation_get_9000(void *wbm_desc)
 }
 
 /**
- * hal_rx_proc_phyrx_other_receive_info_tlv_9000(): API to get tlv info
+ * hal_rx_proc_phyrx_other_receive_info_tlv_9000() - API to get tlv info
+ * @rx_tlv_hdr: RX TLV header
+ * @ppdu_info_hdl: handle to PPDU info rto fill
  *
- * Return: uint32_t
+ * Return: None
  */
 static inline
 void hal_rx_proc_phyrx_other_receive_info_tlv_9000(void *rx_tlv_hdr,
@@ -410,10 +407,10 @@ void hal_rx_get_rtt_info_9000(void *rx_tlv, void *ppdu_info_hdl)
 }
 #endif
 /**
- * hal_rx_dump_msdu_start_tlv_9000() : 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_9000() - dump RX msdu_start TLV in structured
+ *                                     human readable format.
+ * @msdustart: pointer the msdu_start TLV in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -485,10 +482,10 @@ static void hal_rx_dump_msdu_start_tlv_9000(void *msdustart,
 }
 
 /**
- * hal_rx_dump_msdu_end_tlv_9000: 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_9000() - dump RX msdu_end TLV in structured human
+ *                                   readable format.
+ * @msduend: pointer the msdu_end TLV in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -586,10 +583,9 @@ static void hal_rx_dump_msdu_end_tlv_9000(void *msduend,
 }
 
 /**
- * hal_rx_mpdu_start_tid_get_9000(): API to get tid
- * from rx_msdu_start
- *
+ * hal_rx_mpdu_start_tid_get_9000() - 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_9000(uint8_t *buf)
@@ -605,10 +601,10 @@ static uint32_t hal_rx_mpdu_start_tid_get_9000(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_9000() - API to get the reception type
+ *                                               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_9000(uint8_t *buf)
@@ -623,11 +619,10 @@ static uint32_t hal_rx_msdu_start_reception_type_get_9000(uint8_t *buf)
 	return reception_type;
 }
 
- /**
- * hal_rx_msdu_end_da_idx_get_9000: API to get da_idx
- * from rx_msdu_end TLV
+/**
+ * hal_rx_msdu_end_da_idx_get_9000() - 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_9000(uint8_t *buf)
@@ -642,10 +637,11 @@ static uint16_t hal_rx_msdu_end_da_idx_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_rx_fragment_number_9000(): Function to retrieve rx fragment number
+ * hal_rx_get_rx_fragment_number_9000() - Function 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_9000(uint8_t *buf)
@@ -659,10 +655,10 @@ uint8_t hal_rx_get_rx_fragment_number_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_da_is_mcbc_get_9000(): API to check if pkt is MCBC
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_da_is_mcbc_get_9000() - 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
@@ -675,10 +671,10 @@ hal_rx_msdu_end_da_is_mcbc_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_sa_is_valid_get_9000(): API to get_9000 the
- * sa_is_valid bit from rx_msdu_end TLV
+ * hal_rx_msdu_end_sa_is_valid_get_9000() - API to get 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
@@ -694,10 +690,10 @@ hal_rx_msdu_end_sa_is_valid_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_sa_idx_get_9000(): API to get_9000 the
- * sa_idx from rx_msdu_end TLV
+ * hal_rx_msdu_end_sa_idx_get_9000() - API to get 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_9000(uint8_t *buf)
@@ -713,8 +709,6 @@ static uint16_t hal_rx_msdu_end_sa_idx_get_9000(uint8_t *buf)
 
 /**
  * hal_rx_desc_is_first_msdu_9000() - Check if first msdu
- *
- * @hal_soc_hdl: hal_soc handle
  * @hw_desc_addr: hardware descriptor address
  *
  * Return: 0 - success/ non-zero failure
@@ -728,10 +722,10 @@ static uint32_t hal_rx_desc_is_first_msdu_9000(void *hw_desc_addr)
 }
 
 /**
- * hal_rx_msdu_end_l3_hdr_padding_get_9000(): API to get_9000 the
- * l3_header padding from rx_msdu_end TLV
+ * hal_rx_msdu_end_l3_hdr_padding_get_9000() - 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_9000(uint8_t *buf)
@@ -746,10 +740,10 @@ static uint32_t hal_rx_msdu_end_l3_hdr_padding_get_9000(uint8_t *buf)
 }
 
 /**
- * @ hal_rx_encryption_info_valid_9000: Returns encryption type.
+ * hal_rx_encryption_info_valid_9000() - 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_9000(uint8_t *buf)
 {
@@ -762,11 +756,11 @@ inline uint32_t hal_rx_encryption_info_valid_9000(uint8_t *buf)
 	return encryption_info;
 }
 
-/*
- * @ hal_rx_print_pn_9000: Prints the PN of rx packet.
+/**
+ * hal_rx_print_pn_9000() - 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_9000(uint8_t *buf)
 {
@@ -785,10 +779,10 @@ static void hal_rx_print_pn_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_first_msdu_get_9000: API to get first msdu status
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_first_msdu_get_9000() - 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_9000(uint8_t *buf)
@@ -803,10 +797,10 @@ static uint8_t hal_rx_msdu_end_first_msdu_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_da_is_valid_get_9000: API to check if da is valid
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_da_is_valid_get_9000() - 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_9000(uint8_t *buf)
@@ -821,10 +815,10 @@ static uint8_t hal_rx_msdu_end_da_is_valid_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_last_msdu_get_9000: API to get last msdu status
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_last_msdu_get_9000() - 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_9000(uint8_t *buf)
@@ -838,11 +832,11 @@ static uint8_t hal_rx_msdu_end_last_msdu_get_9000(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_9000() - 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_9000(uint8_t *buf)
 {
@@ -856,7 +850,7 @@ inline bool hal_rx_get_mpdu_mac_ad4_valid_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_mpdu_start_sw_peer_id_get_9000: Retrieve sw peer_id
+ * hal_rx_mpdu_start_sw_peer_id_get_9000() - Retrieve sw peer_id
  * @buf: network buffer
  *
  * Return: sw peer_id
@@ -871,11 +865,10 @@ static uint32_t hal_rx_mpdu_start_sw_peer_id_get_9000(uint8_t *buf)
 		&mpdu_start->rx_mpdu_info_details);
 }
 
-/*
- * hal_rx_mpdu_get_to_ds_9000(): API to get the tods info
- * from rx_mpdu_start
- *
+/**
+ * hal_rx_mpdu_get_to_ds_9000() - 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_9000(uint8_t *buf)
@@ -889,11 +882,10 @@ static uint32_t hal_rx_mpdu_get_to_ds_9000(uint8_t *buf)
 	return HAL_RX_MPDU_GET_TODS(mpdu_info);
 }
 
-/*
- * hal_rx_mpdu_get_fr_ds_9000(): API to get the from ds info
- * from rx_mpdu_start
- *
+/**
+ * hal_rx_mpdu_get_fr_ds_9000() - 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_9000(uint8_t *buf)
@@ -907,12 +899,12 @@ static uint32_t hal_rx_mpdu_get_fr_ds_9000(uint8_t *buf)
 	return HAL_RX_MPDU_GET_FROMDS(mpdu_info);
 }
 
-/*
- * hal_rx_get_mpdu_frame_control_valid_9000(): Retrieves mpdu
- * frame control valid
+/**
+ * hal_rx_get_mpdu_frame_control_valid_9000() - 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_9000(uint8_t *buf)
 {
@@ -923,11 +915,11 @@ static uint8_t hal_rx_get_mpdu_frame_control_valid_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_mpdu_frame_control_field_9000(): Function
- * to retrieve frame control field
+ * hal_rx_get_mpdu_frame_control_field_9000() - 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_9000(uint8_t *buf)
@@ -941,11 +933,11 @@ static uint16_t hal_rx_get_mpdu_frame_control_field_9000(uint8_t *buf)
 	return frame_ctrl;
 }
 
-/*
- * hal_rx_mpdu_get_addr1_9000(): API to check get address1 of the mpdu
- *
+/**
+ * hal_rx_mpdu_get_addr1_9000() - 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_9000(uint8_t *buf,
@@ -975,12 +967,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr1_9000(uint8_t *buf,
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr2_9000(): API to check get address2 of the mpdu
- * in the packet
- *
+/**
+ * hal_rx_mpdu_get_addr2_9000() - 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_9000(uint8_t *buf, uint8_t *mac_addr)
@@ -1009,12 +1001,11 @@ static QDF_STATUS hal_rx_mpdu_get_addr2_9000(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr3_9000(): API to get address3 of the mpdu
- * in the packet
- *
+/**
+ * hal_rx_mpdu_get_addr3_9000() - 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_9000(uint8_t *buf, uint8_t *mac_addr)
@@ -1043,12 +1034,11 @@ static QDF_STATUS hal_rx_mpdu_get_addr3_9000(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr4_9000(): API to get address4 of the mpdu
- * in the packet
- *
+/**
+ * hal_rx_mpdu_get_addr4_9000() - 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_9000(uint8_t *buf, uint8_t *mac_addr)
@@ -1077,12 +1067,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr4_9000(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_get_mpdu_sequence_control_valid_9000(): Get mpdu
- * sequence control valid
+/**
+ * hal_rx_get_mpdu_sequence_control_valid_9000() - 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_9000(uint8_t *buf)
 {
@@ -1093,9 +1083,8 @@ static uint8_t hal_rx_get_mpdu_sequence_control_valid_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_is_unicast_9000: check packet is unicast frame or not.
- *
- * @ buf: pointer to rx pkt TLV.
+ * hal_rx_is_unicast_9000() - check packet is unicast frame or not.
+ * @buf: pointer to rx pkt TLV.
  *
  * Return: true on unicast.
  */
@@ -1116,7 +1105,7 @@ static bool hal_rx_is_unicast_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_tid_get_9000: get tid based on qos control valid.
+ * hal_rx_tid_get_9000() - get tid based on qos control valid.
  * @hal_soc_hdl: hal soc handle
  * @buf: pointer to rx pkt TLV.
  *
@@ -1141,7 +1130,7 @@ static uint32_t hal_rx_tid_get_9000(hal_soc_handle_t hal_soc_hdl, uint8_t *buf)
 }
 
 /**
- * hal_rx_hw_desc_get_ppduid_get_9000(): retrieve ppdu id
+ * hal_rx_hw_desc_get_ppduid_get_9000() - retrieve ppdu id
  * @rx_tlv_hdr: rx tlv header
  * @rxdma_dst_ring_desc: rxdma HW descriptor
  *
@@ -1156,12 +1145,12 @@ static uint32_t hal_rx_hw_desc_get_ppduid_get_9000(void *rx_tlv_hdr,
 }
 
 /**
- * hal_reo_status_get_header_9000 - Process reo desc info
+ * hal_reo_status_get_header_9000() - 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.
+ * Return: none.
  *
  */
 static void hal_reo_status_get_header_9000(hal_ring_desc_t ring_desc, int b,
@@ -1260,8 +1249,8 @@ static void hal_reo_status_get_header_9000(hal_ring_desc_t ring_desc, int b,
 }
 
 /**
- * hal_rx_mpdu_start_mpdu_qos_control_valid_get_9000():
- * Retrieve qos control valid bit from the tlv.
+ * hal_rx_mpdu_start_mpdu_qos_control_valid_get_9000() - Retrieve qos control
+ *                                                       valid bit from the tlv.
  * @buf: pointer to rx pkt TLV.
  *
  * Return: qos control value.
@@ -1278,8 +1267,8 @@ hal_rx_mpdu_start_mpdu_qos_control_valid_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_sa_sw_peer_id_get_9000(): API to get the
- * sa_sw_peer_id from rx_msdu_end TLV
+ * hal_rx_msdu_end_sa_sw_peer_id_get_9000() - API to get the sa_sw_peer_id from
+ *                                            rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
  * Return: sa_sw_peer_id index
@@ -1294,7 +1283,7 @@ hal_rx_msdu_end_sa_sw_peer_id_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_tx_desc_set_mesh_en_9000 - Set mesh_enable flag in Tx descriptor
+ * hal_tx_desc_set_mesh_en_9000() - 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
@@ -1369,7 +1358,7 @@ hal_rx_get_ppdu_id_9000(uint8_t *buf)
 }
 
 /**
- * hal_reo_config_9000(): Set reo config parameters
+ * hal_reo_config_9000() - Set reo config parameters
  * @soc: hal soc handle
  * @reg_val: value to be set
  * @reo_params: reo parameters
@@ -1386,9 +1375,9 @@ hal_reo_config_9000(struct hal_soc *soc,
 
 /**
  * hal_rx_msdu_desc_info_get_ptr_9000() - 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.
+ * Return: Pointer to rx_msdu_desc_info structure.
  *
  */
 static void *hal_rx_msdu_desc_info_get_ptr_9000(void *msdu_details_ptr)
@@ -1397,10 +1386,10 @@ static void *hal_rx_msdu_desc_info_get_ptr_9000(void *msdu_details_ptr)
 }
 
 /**
- * hal_rx_link_desc_msdu0_ptr_9000 - Get pointer to rx_msdu details
- * @link_desc - Pointer to link desc
+ * hal_rx_link_desc_msdu0_ptr_9000() - Get pointer to rx_msdu details
+ * @link_desc: Pointer to link desc
  *
- * Return - Pointer to rx_msdu_details structure
+ * Return: Pointer to rx_msdu_details structure
  *
  */
 static void *hal_rx_link_desc_msdu0_ptr_9000(void *link_desc)
@@ -1409,8 +1398,7 @@ static void *hal_rx_link_desc_msdu0_ptr_9000(void *link_desc)
 }
 
 /**
- * hal_rx_msdu_flow_idx_get_9000: API to get flow index
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_get_9000() - 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
@@ -1424,8 +1412,8 @@ static inline uint32_t hal_rx_msdu_flow_idx_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_flow_idx_invalid_9000: API to get flow index invalid
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_invalid_9000() - 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
@@ -1439,8 +1427,8 @@ static bool hal_rx_msdu_flow_idx_invalid_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_flow_idx_timeout_9000: API to get flow index timeout
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_timeout_9000() - 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
@@ -1454,8 +1442,8 @@ static bool hal_rx_msdu_flow_idx_timeout_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_fse_metadata_get_9000: API to get FSE metadata
- * from rx_msdu_end TLV
+ * hal_rx_msdu_fse_metadata_get_9000() - 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
@@ -1469,8 +1457,8 @@ static uint32_t hal_rx_msdu_fse_metadata_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_cce_metadata_get_9000: API to get CCE metadata
- * from rx_msdu_end TLV
+ * hal_rx_msdu_cce_metadata_get_9000() - API to get CCE metadata from
+ *                                       rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
  * Return: cce_metadata
@@ -1485,8 +1473,9 @@ hal_rx_msdu_cce_metadata_get_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_get_flow_params_9000: API to get flow index, flow index invalid
- * and flow index timeout from rx_msdu_end TLV
+ * hal_rx_msdu_get_flow_params_9000() - 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
@@ -1521,10 +1510,10 @@ hal_rx_tlv_get_tcp_chksum_9000(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_rx_sequence_9000(): Function to retrieve rx sequence number
+ * hal_rx_get_rx_sequence_9000() - 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_9000(uint8_t *buf)
@@ -1536,7 +1525,7 @@ uint16_t hal_rx_get_rx_sequence_9000(uint8_t *buf)
 }
 
 /**
- * hal_get_window_address_9000(): Function to get hp/tp address
+ * hal_get_window_address_9000() - Function to get hp/tp address
  * @hal_soc: Pointer to hal_soc
  * @addr: address offset of register
  *
@@ -1579,11 +1568,10 @@ static inline void hal_write_window_register(struct hal_soc *hal_soc)
 }
 
 /**
- * hal_rx_msdu_packet_metadata_get_9000(): 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_9000() - 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_9000(uint8_t *buf,
@@ -1604,9 +1592,9 @@ hal_rx_msdu_packet_metadata_get_9000(uint8_t *buf,
 
 /**
  * hal_rx_flow_setup_fse_9000() - 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
  */
@@ -2415,8 +2403,10 @@ struct hal_hw_srng_config hw_srng_table_9000[] = {
 };
 
 /**
- * hal_qcn9000_attach()- Attach 9000 target specific hal_soc ops,
- *			  offset and srng table
+ * hal_qcn9000_attach()- Attach 9000 target specific hal_soc ops, offset and
+ *                       srng table
+ * @hal_soc: HAL SoC context
+ *
  * Return: void
  */
 void hal_qcn9000_attach(struct hal_soc *hal_soc)

hal/wifi3.0/qcn9000/hal_9000_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
@@ -26,8 +26,8 @@
 #include "hal_api_mon.h"
 
 /**
- * hal_tx_desc_set_dscp_tid_table_id_9000() - Sets DSCP to TID conversion
- *						table ID
+ * hal_tx_desc_set_dscp_tid_table_id_9000() - Sets DSCP to TID conversion table
+ *                                            ID
  * @desc: Handle to Tx Descriptor
  * @id: DSCP to tid conversion table to be used for this frame
  *
@@ -113,12 +113,12 @@ static void hal_tx_set_dscp_tid_map_9000(struct hal_soc *soc,
 }
 
 /**
- * hal_tx_update_dscp_tid_9000() - Update the dscp tid map table as
-					updated by user
+ * hal_tx_update_dscp_tid_9000() - Update the dscp tid map table as updated by
+ *                                 user
  * @soc: HAL SoC context
- * @map: DSCP-TID mapping table
- * @id : MAP ID
- * @dscp: DSCP_TID map index
+ * @tid: TID
+ * @id: MAP ID
+ * @dscp: DSCP
  *
  * Return: void
  */
@@ -193,7 +193,7 @@ static void hal_tx_update_dscp_tid_9000(struct hal_soc *soc, uint8_t tid,
 }
 
 /**
- * hal_tx_desc_set_lmac_id_9000 - Set the lmac_id value
+ * hal_tx_desc_set_lmac_id_9000() - 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_9000(void *desc, uint8_t lmac_id)
 /**
  * hal_tx_init_cmd_credit_ring_9000() - 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
  */