浏览代码

qcacmn: Fix hal/wifi3.0/qca6490 documentation

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

Change-Id: If86930db21f7961acc067da4751641c749cadc48
CRs-Fixed: 3410723
Jeff Johnson 2 年之前
父节点
当前提交
9c8278f7b9
共有 2 个文件被更改,包括 156 次插入164 次删除
  1. 148 156
      hal/wifi3.0/qca6490/hal_6490.c
  2. 8 8
      hal/wifi3.0/qca6490/hal_6490_tx.h

+ 148 - 156
hal/wifi3.0/qca6490/hal_6490.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2019-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_6490(): API to get the NSS
- * Interval from rx_msdu_start
- *
+/**
+ * hal_rx_msdu_start_nss_get_6490() - 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_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_start_get_len_6490(): API to get the MSDU length
- * from rx_msdu_start TLV
+ * hal_rx_msdu_start_get_len_6490() - 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_6490(uint8_t *buf)
@@ -158,10 +158,9 @@ static uint32_t hal_rx_msdu_start_get_len_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_mon_hw_desc_get_mpdu_status_6490(): 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_6490() - Retrieve MPDU status
+ * @hw_desc_addr: Start address of Rx HW TLVs
+ * @rs: Status for monitor mode
  *
  * Return: void
  */
@@ -206,10 +205,10 @@ static uint32_t hal_get_link_desc_size_6490(void)
 	return LINK_DESC_SIZE;
 }
 
-/*
- * hal_rx_get_tlv_6490(): API to get the tlv
- *
+/**
+ * hal_rx_get_tlv_6490() - API to get the tlv
  * @rx_tlv: TLV data extracted from the rx packet
+ *
  * Return: uint8_t
  */
 static uint8_t hal_rx_get_tlv_6490(void *rx_tlv)
@@ -221,7 +220,7 @@ static uint8_t hal_rx_get_tlv_6490(void *rx_tlv)
  * hal_rx_proc_phyrx_other_receive_info_tlv_6490()
  *				    - 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
  */
@@ -256,10 +255,10 @@ void hal_rx_proc_phyrx_other_receive_info_tlv_6490(void *rx_tlv_hdr,
 }
 
 /**
- * hal_rx_dump_msdu_start_tlv_6490() : 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_6490() - dump RX msdu_start TLV in structured
+ *                                     human readable format.
+ * @msdustart: pointer the msdu_start TLV in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -333,10 +332,10 @@ static void hal_rx_dump_msdu_start_tlv_6490(void *msdustart, uint8_t dbg_level)
 }
 
 /**
- * hal_rx_dump_msdu_end_tlv_6490: 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_6490() - dump RX msdu_end TLV in structured
+ *                                   human readable format.
+ * @msduend: pointer the msdu_end TLV in pkt.
+ * @dbg_level: log level.
  *
  * Return: void
  */
@@ -483,11 +482,11 @@ static uint32_t hal_rx_mpdu_start_tid_get_6490(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_6490() - 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
@@ -504,10 +503,9 @@ uint32_t hal_rx_msdu_start_reception_type_get_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_da_idx_get_6490: API to get da_idx
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_da_idx_get_6490() - 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_6490(uint8_t *buf)
@@ -520,11 +518,12 @@ static uint16_t hal_rx_msdu_end_da_idx_get_6490(uint8_t *buf)
 
 	return da_idx;
 }
+
 /**
- * hal_rx_get_rx_fragment_number_6490(): Function to retrieve rx fragment number
+ * hal_rx_get_rx_fragment_number_6490() - 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_6490(uint8_t *buf)
@@ -538,10 +537,10 @@ uint8_t hal_rx_get_rx_fragment_number_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_da_is_mcbc_get_6490(): API to check if pkt is MCBC
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_da_is_mcbc_get_6490() - 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
@@ -554,10 +553,10 @@ hal_rx_msdu_end_da_is_mcbc_get_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_sa_is_valid_get_6490(): API to get_6490 the
- * sa_is_valid bit from rx_msdu_end TLV
+ * hal_rx_msdu_end_sa_is_valid_get_6490() - API to get_6490 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
@@ -573,10 +572,10 @@ hal_rx_msdu_end_sa_is_valid_get_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_sa_idx_get_6490(): API to get_6490 the
- * sa_idx from rx_msdu_end TLV
+ * hal_rx_msdu_end_sa_idx_get_6490() - API to get_6490 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
@@ -593,8 +592,6 @@ uint16_t hal_rx_msdu_end_sa_idx_get_6490(uint8_t *buf)
 
 /**
  * hal_rx_desc_is_first_msdu_6490() - Check if first msdu
- *
- * @hal_soc_hdl: hal_soc handle
  * @hw_desc_addr: hardware descriptor address
  *
  * Return: 0 - success/ non-zero failure
@@ -608,10 +605,10 @@ static uint32_t hal_rx_desc_is_first_msdu_6490(void *hw_desc_addr)
 }
 
 /**
- * hal_rx_msdu_end_l3_hdr_padding_get_6490(): API to get_6490 the
- * l3_header padding from rx_msdu_end TLV
+ * hal_rx_msdu_end_l3_hdr_padding_get_6490() - API to get_6490 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_6490(uint8_t *buf)
@@ -625,11 +622,11 @@ static uint32_t hal_rx_msdu_end_l3_hdr_padding_get_6490(uint8_t *buf)
 	return l3_header_padding;
 }
 
-/*
- * @ hal_rx_encryption_info_valid_6490: Returns encryption type.
+/**
+ * hal_rx_encryption_info_valid_6490() - 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_6490(uint8_t *buf)
 {
@@ -642,11 +639,11 @@ static uint32_t hal_rx_encryption_info_valid_6490(uint8_t *buf)
 	return encryption_info;
 }
 
-/*
- * @ hal_rx_print_pn_6490: Prints the PN of rx packet.
+/**
+ * hal_rx_print_pn_6490() - 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_6490(uint8_t *buf)
 {
@@ -665,10 +662,10 @@ static void hal_rx_print_pn_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_first_msdu_get_6490: API to get first msdu status
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_first_msdu_get_6490() - 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_6490(uint8_t *buf)
@@ -683,10 +680,10 @@ static uint8_t hal_rx_msdu_end_first_msdu_get_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_da_is_valid_get_6490: API to check if da is valid
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_da_is_valid_get_6490() - 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_6490(uint8_t *buf)
@@ -701,10 +698,10 @@ static uint8_t hal_rx_msdu_end_da_is_valid_get_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_end_last_msdu_get_6490: API to get last msdu status
- * from rx_msdu_end TLV
+ * hal_rx_msdu_end_last_msdu_get_6490() - 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_6490(uint8_t *buf)
@@ -718,11 +715,11 @@ static uint8_t hal_rx_msdu_end_last_msdu_get_6490(uint8_t *buf)
 	return last_msdu;
 }
 
-/*
- * hal_rx_get_mpdu_mac_ad4_valid_6490(): Retrieves if mpdu 4th addr is valid
+/**
+ * hal_rx_get_mpdu_mac_ad4_valid_6490() - 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_6490(uint8_t *buf)
 {
@@ -736,7 +733,7 @@ static bool hal_rx_get_mpdu_mac_ad4_valid_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_mpdu_start_sw_peer_id_get_6490: Retrieve sw peer_id
+ * hal_rx_mpdu_start_sw_peer_id_get_6490() - Retrieve sw peer_id
  * @buf: network buffer
  *
  * Return: sw peer_id
@@ -752,10 +749,10 @@ static uint32_t hal_rx_mpdu_start_sw_peer_id_get_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_mpdu_get_to_ds_6490(): API to get the tods info
- * from rx_mpdu_start
- *
+ * hal_rx_mpdu_get_to_ds_6490() - 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_6490(uint8_t *buf)
@@ -769,11 +766,11 @@ static uint32_t hal_rx_mpdu_get_to_ds_6490(uint8_t *buf)
 	return HAL_RX_MPDU_GET_TODS(mpdu_info);
 }
 
-/*
- * hal_rx_mpdu_get_fr_ds_6490(): API to get the from ds info
- * from rx_mpdu_start
- *
+/**
+ * hal_rx_mpdu_get_fr_ds_6490() - 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_6490(uint8_t *buf)
@@ -787,12 +784,12 @@ static uint32_t hal_rx_mpdu_get_fr_ds_6490(uint8_t *buf)
 	return HAL_RX_MPDU_GET_FROMDS(mpdu_info);
 }
 
-/*
- * hal_rx_get_mpdu_frame_control_valid_6490(): Retrieves mpdu
- * frame control valid
+/**
+ * hal_rx_get_mpdu_frame_control_valid_6490() - 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_6490(uint8_t *buf)
 {
@@ -802,11 +799,11 @@ static uint8_t hal_rx_get_mpdu_frame_control_valid_6490(uint8_t *buf)
 	return HAL_RX_MPDU_GET_FRAME_CONTROL_VALID(rx_mpdu_info);
 }
 
-/*
- * hal_rx_mpdu_get_addr1_6490(): API to check get address1 of the mpdu
- *
+/**
+ * hal_rx_mpdu_get_addr1_6490() - 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_6490(uint8_t *buf, uint8_t *mac_addr)
@@ -835,12 +832,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr1_6490(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr2_6490(): API to check get address2 of the mpdu
+/**
+ * hal_rx_mpdu_get_addr2_6490() - 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_6490(uint8_t *buf,
@@ -870,12 +867,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr2_6490(uint8_t *buf,
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr3_6490(): API to get address3 of the mpdu
- * in the packet
- *
+/**
+ * hal_rx_mpdu_get_addr3_6490() - 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_6490(uint8_t *buf, uint8_t *mac_addr)
@@ -904,12 +901,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr3_6490(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_mpdu_get_addr4_6490(): API to get address4 of the mpdu
- * in the packet
- *
+/**
+ * hal_rx_mpdu_get_addr4_6490() - 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_6490(uint8_t *buf, uint8_t *mac_addr)
@@ -938,12 +935,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr4_6490(uint8_t *buf, uint8_t *mac_addr)
 	return QDF_STATUS_E_FAILURE;
 }
 
-/*
- * hal_rx_get_mpdu_sequence_control_valid_6490(): Get mpdu
- * sequence control valid
+/**
+ * hal_rx_get_mpdu_sequence_control_valid_6490() - 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_6490(uint8_t *buf)
 {
@@ -954,9 +951,8 @@ static uint8_t hal_rx_get_mpdu_sequence_control_valid_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_is_unicast_6490: check packet is unicast frame or not.
- *
- * @ buf: pointer to rx pkt TLV.
+ * hal_rx_is_unicast_6490() - check packet is unicast frame or not.
+ * @buf: pointer to rx pkt TLV.
  *
  * Return: true on unicast.
  */
@@ -977,9 +973,9 @@ static bool hal_rx_is_unicast_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_tid_get_6490: get tid based on qos control valid.
+ * hal_rx_tid_get_6490() - 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
  */
@@ -1002,7 +998,7 @@ static uint32_t hal_rx_tid_get_6490(hal_soc_handle_t hal_soc_hdl, uint8_t *buf)
 }
 
 /**
- * hal_rx_hw_desc_get_ppduid_get_6490(): retrieve ppdu id
+ * hal_rx_hw_desc_get_ppduid_get_6490() - retrieve ppdu id
  * @rx_tlv_hdr: start address of rx_pkt_tlvs
  * @rxdma_dst_ring_desc: Rx HW descriptor
  *
@@ -1021,13 +1017,12 @@ static uint32_t hal_rx_hw_desc_get_ppduid_get_6490(void *rx_tlv_hdr,
 }
 
 /**
- * hal_reo_status_get_header_6490 - Process reo desc info
+ * hal_reo_status_get_header_6490() - 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.
- *
  */
 static void hal_reo_status_get_header_6490(hal_ring_desc_t ring_desc, int b,
 					   void *h1)
@@ -1125,7 +1120,7 @@ static void hal_reo_status_get_header_6490(hal_ring_desc_t ring_desc, int b,
 }
 
 /**
- * hal_tx_desc_set_mesh_en_6490 - Set mesh_enable flag in Tx descriptor
+ * hal_tx_desc_set_mesh_en_6490() - 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
@@ -1194,7 +1189,7 @@ hal_rx_get_ppdu_id_6490(uint8_t *buf)
 }
 
 /**
- * hal_reo_config_6490(): Set reo config parameters
+ * hal_reo_config_6490() - Set reo config parameters
  * @soc: hal soc handle
  * @reg_val: value to be set
  * @reo_params: reo parameters
@@ -1211,10 +1206,9 @@ void hal_reo_config_6490(struct hal_soc *soc,
 
 /**
  * hal_rx_msdu_desc_info_get_ptr_6490() - 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.
- *
  */
 static void *hal_rx_msdu_desc_info_get_ptr_6490(void *msdu_details_ptr)
 {
@@ -1222,11 +1216,10 @@ static void *hal_rx_msdu_desc_info_get_ptr_6490(void *msdu_details_ptr)
 }
 
 /**
- * hal_rx_link_desc_msdu0_ptr_6490 - Get pointer to rx_msdu details
- * @link_desc - Pointer to link desc
+ * hal_rx_link_desc_msdu0_ptr_6490() - Get pointer to rx_msdu details
+ * @link_desc: Pointer to link desc
  *
  * Return - Pointer to rx_msdu_details structure
- *
  */
 static void *hal_rx_link_desc_msdu0_ptr_6490(void *link_desc)
 {
@@ -1234,8 +1227,8 @@ static void *hal_rx_link_desc_msdu0_ptr_6490(void *link_desc)
 }
 
 /**
- * hal_rx_msdu_flow_idx_get_6490: API to get flow index
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_get_6490() - 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
@@ -1249,10 +1242,11 @@ static inline uint32_t hal_rx_msdu_flow_idx_get_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_get_reo_destination_indication_6490: API to get
- * reo_destination_indication from rx_msdu_end TLV
+ * hal_rx_msdu_get_reo_destination_indication_6490() - 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
+ * @reo_destination_indication: pointer to return value of
+ *                              reo_destination_indication
  *
  * Return: none
  */
@@ -1267,8 +1261,8 @@ hal_rx_msdu_get_reo_destination_indication_6490(uint8_t *buf,
 }
 
 /**
- * hal_rx_msdu_flow_idx_invalid_6490: API to get flow index invalid
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_invalid_6490() - 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
@@ -1282,8 +1276,8 @@ static bool hal_rx_msdu_flow_idx_invalid_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_flow_idx_timeout_6490: API to get flow index timeout
- * from rx_msdu_end TLV
+ * hal_rx_msdu_flow_idx_timeout_6490() - 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
@@ -1297,8 +1291,8 @@ static bool hal_rx_msdu_flow_idx_timeout_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_fse_metadata_get_6490: API to get FSE metadata
- * from rx_msdu_end TLV
+ * hal_rx_msdu_fse_metadata_get_6490() - 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
@@ -1312,8 +1306,8 @@ static uint32_t hal_rx_msdu_fse_metadata_get_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_cce_metadata_get_6490: API to get CCE metadata
- * from rx_msdu_end TLV
+ * hal_rx_msdu_cce_metadata_get_6490() - API to get CCE metadata
+ *                                       from rx_msdu_end TLV
  * @buf: pointer to the start of RX PKT TLV headers
  *
  * Return: cce_metadata
@@ -1328,8 +1322,9 @@ hal_rx_msdu_cce_metadata_get_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_msdu_get_flow_params_6490: API to get flow index, flow index invalid
- * and flow index timeout from rx_msdu_end TLV
+ * hal_rx_msdu_get_flow_params_6490() - 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
@@ -1364,10 +1359,10 @@ hal_rx_tlv_get_tcp_chksum_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_rx_sequence_6490(): Function to retrieve rx sequence number
+ * hal_rx_get_rx_sequence_6490() - 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_6490(uint8_t *buf)
@@ -1379,7 +1374,7 @@ uint16_t hal_rx_get_rx_sequence_6490(uint8_t *buf)
 }
 
 /**
- * hal_get_window_address_6490(): Function to get hp/tp address
+ * hal_get_window_address_6490() - Function to get hp/tp address
  * @hal_soc: Pointer to hal_soc
  * @addr: address offset of register
  *
@@ -1430,8 +1425,7 @@ bool hal_rx_get_udp_proto_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_flow_agg_continuation_6490() - retrieve flow agg
- *                                           continuation
+ * hal_rx_get_flow_agg_continuation_6490() - retrieve flow agg continuation
  * @buf: buffer
  *
  * Return: flow agg
@@ -1443,7 +1437,7 @@ bool hal_rx_get_flow_agg_continuation_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_get_flow_agg_count_6490()- Retrieve flow agg count
+ * hal_rx_get_flow_agg_count_6490() - Retrieve flow agg count
  * @buf: buffer
  *
  * Return: flow agg count
@@ -1467,10 +1461,9 @@ bool hal_rx_get_fisa_timeout_6490(uint8_t *buf)
 }
 
 /**
- * hal_rx_mpdu_start_tlv_tag_valid_6490 () - 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_6490() - 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.
  */
@@ -1485,8 +1478,8 @@ static uint8_t hal_rx_mpdu_start_tlv_tag_valid_6490(void *rx_tlv_hdr)
 }
 
 /**
- * hal_reo_set_err_dst_remap_6490(): Function to set REO error destination
- *				     ring remap register
+ * hal_reo_set_err_dst_remap_6490() - Function to set REO error destination
+ *                                    ring remap register
  * @hal_soc: Pointer to hal_soc
  *
  * Return: none.
@@ -1542,9 +1535,9 @@ hal_reo_set_err_dst_remap_6490(void *hal_soc)
 
 /**
  * hal_rx_flow_setup_fse_6490() - 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.
  *
@@ -1715,15 +1708,14 @@ void hal_compute_reo_remap_ix0_6490(uint32_t *remap0)
 
 #ifdef WLAN_FEATURE_MARK_FIRST_WAKEUP_PACKET
 /**
- * hal_get_first_wow_wakeup_packet_6490(): Function to retrieve
- *					   rx_msdu_end_1_reserved_1a
+ * hal_get_first_wow_wakeup_packet_6490() - 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
- *
- * 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 uint8_t hal_get_first_wow_wakeup_packet_6490(uint8_t *buf)
@@ -1736,11 +1728,10 @@ static uint8_t hal_get_first_wow_wakeup_packet_6490(uint8_t *buf)
 #endif
 
 /**
- * hal_rx_tlv_l3_type_get_6490(): Function to retrieve l3_type
- *
+ * hal_rx_tlv_l3_type_get_6490() - Function to retrieve l3_type
  * @buf: Network buffer
  *
- * Returns: l3_type
+ * Return: l3_type
  */
 static uint32_t hal_rx_tlv_l3_type_get_6490(uint8_t *buf)
 {
@@ -2385,6 +2376,7 @@ struct hal_hw_srng_config hw_srng_table_6490[] = {
 /**
  * hal_qca6490_attach() - Attach 6490 target specific hal_soc ops,
  *			  offset and srng table
+ * @hal_soc: HAL SoC context
  */
 void hal_qca6490_attach(struct hal_soc *hal_soc)
 {

+ 8 - 8
hal/wifi3.0/qca6490/hal_6490_tx.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2019-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
@@ -49,7 +49,7 @@ static void hal_tx_desc_set_dscp_tid_table_id_6490(void *desc, uint8_t id)
 
 /**
  * hal_tx_set_dscp_tid_map_6490() - 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
  *
@@ -119,10 +119,10 @@ static void hal_tx_set_dscp_tid_map_6490(struct hal_soc *hal_soc, uint8_t *map,
 /**
  * hal_tx_update_dscp_tid_6490() - Update the dscp tid map table as updated
  *					by the user
- * @soc: HAL SoC context
- * @map: DSCP-TID mapping table
- * @id : MAP ID
- * @dscp: DSCP_TID map index
+ * @hal_soc: HAL SoC context
+ * @tid: TID
+ * @id: MAP ID
+ * @dscp: DSCP
  *
  * Return: void
  */
@@ -150,7 +150,7 @@ static void hal_tx_update_dscp_tid_6490(struct hal_soc *hal_soc, uint8_t tid,
 }
 
 /**
- * hal_tx_desc_set_lmac_id - Set the lmac_id value
+ * hal_tx_desc_set_lmac_id_6490() - Set the lmac_id value
  * @desc: Handle to Tx Descriptor
  * @lmac_id: mac Id to ast matching
  *		     b00 – mac 0
@@ -169,7 +169,7 @@ static void hal_tx_desc_set_lmac_id_6490(void *desc, uint8_t lmac_id)
 /**
  * hal_tx_init_cmd_credit_ring_6490() - 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
  */