From 5047c5345a4f73e3605db57b17a8693d70b1fb90 Mon Sep 17 00:00:00 2001 From: Jeff Johnson Date: Sun, 19 Feb 2023 19:50:49 -0800 Subject: [PATCH] qcacmn: Fix hal/wifi3.0/qca8074v1 documentation The kernel-doc script identified some documentation issues in the hal/wifi3.0/qca8074v1 folder, so fix them. Change-Id: I7d1b018a7ba9e8967ad8a9998a8a1757881b7ed1 CRs-Fixed: 3410790 --- hal/wifi3.0/qca8074v1/hal_8074v1.c | 235 +++++++++++++------------- hal/wifi3.0/qca8074v1/hal_8074v1_rx.h | 50 +++--- hal/wifi3.0/qca8074v1/hal_8074v1_tx.h | 15 +- 3 files changed, 149 insertions(+), 151 deletions(-) diff --git a/hal/wifi3.0/qca8074v1/hal_8074v1.c b/hal/wifi3.0/qca8074v1/hal_8074v1.c index fd36f60187..bc19fb5b07 100644 --- a/hal/wifi3.0/qca8074v1/hal_8074v1.c +++ b/hal/wifi3.0/qca8074v1/hal_8074v1.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 @@ -118,7 +118,7 @@ #include "hal_li_generic_api.h" /** - * hal_get_window_address_8074(): Function to get hp/tp address + * hal_get_window_address_8074() - Function to get hp/tp address * @hal_soc: Pointer to hal_soc * @addr: address offset of register * @@ -131,11 +131,11 @@ static inline qdf_iomem_t hal_get_window_address_8074(struct hal_soc *hal_soc, } /** - * hal_rx_get_rx_fragment_number_8074v1(): Function to retrieve + * hal_rx_get_rx_fragment_number_8074v1() - 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_8074v1(uint8_t *buf) @@ -149,10 +149,10 @@ uint8_t hal_rx_get_rx_fragment_number_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_end_da_is_mcbc_get_8074v1(): API to check if - * pkt is MCBC from rx_msdu_end TLV + * hal_rx_msdu_end_da_is_mcbc_get_8074v1() - 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 @@ -165,10 +165,11 @@ hal_rx_msdu_end_da_is_mcbc_get_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_end_sa_is_valid_get_8074v1(): API to get_8074v1 the - * sa_is_valid bit from rx_msdu_end TLV + * hal_rx_msdu_end_sa_is_valid_get_8074v1() - API to get_8074v1 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 @@ -184,10 +185,10 @@ hal_rx_msdu_end_sa_is_valid_get_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_end_sa_idx_get_8074v1(): API to get_8074v1 the - * sa_idx from rx_msdu_end TLV + * hal_rx_msdu_end_sa_idx_get_8074v1() - API to get_8074v1 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_8074v1(uint8_t *buf) @@ -203,8 +204,6 @@ static uint16_t hal_rx_msdu_end_sa_idx_get_8074v1(uint8_t *buf) /** * hal_rx_desc_is_first_msdu_8074v1() - Check if first msdu - * - * @hal_soc_hdl: hal_soc handle * @hw_desc_addr: hardware descriptor address * * Return: 0 - success/ non-zero failure @@ -218,10 +217,11 @@ static uint32_t hal_rx_desc_is_first_msdu_8074v1(void *hw_desc_addr) } /** - * hal_rx_msdu_end_l3_hdr_padding_get_8074v1(): API to get_8074v1 the - * l3_header padding from rx_msdu_end TLV + * hal_rx_msdu_end_l3_hdr_padding_get_8074v1() - API to get_8074v1 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_8074v1(uint8_t *buf) @@ -235,11 +235,11 @@ static uint32_t hal_rx_msdu_end_l3_hdr_padding_get_8074v1(uint8_t *buf) return l3_header_padding; } -/* - * @ hal_rx_encryption_info_valid_8074v1: Returns encryption type. +/** + * hal_rx_encryption_info_valid_8074v1() - 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_8074v1(uint8_t *buf) { @@ -252,11 +252,11 @@ static uint32_t hal_rx_encryption_info_valid_8074v1(uint8_t *buf) return encryption_info; } -/* - * @ hal_rx_print_pn_8074v1: Prints the PN of rx packet. +/** + * hal_rx_print_pn_8074v1() - 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_8074v1(uint8_t *buf) { @@ -275,10 +275,10 @@ static void hal_rx_print_pn_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_end_first_msdu_get_8074v1: API to get first msdu status - * from rx_msdu_end TLV + * hal_rx_msdu_end_first_msdu_get_8074v1() - 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 @@ -294,10 +294,10 @@ hal_rx_msdu_end_first_msdu_get_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_end_da_is_valid_get_8074v1: API to check if da is valid - * from rx_msdu_end TLV + * hal_rx_msdu_end_da_is_valid_get_8074v1() - 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_8074v1(uint8_t *buf) @@ -312,10 +312,10 @@ static uint8_t hal_rx_msdu_end_da_is_valid_get_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_end_last_msdu_get_8074v1: API to get last msdu status - * from rx_msdu_end TLV + * hal_rx_msdu_end_last_msdu_get_8074v1() - 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_8074v1(uint8_t *buf) @@ -329,11 +329,11 @@ static uint8_t hal_rx_msdu_end_last_msdu_get_8074v1(uint8_t *buf) return last_msdu; } -/* - * hal_rx_get_mpdu_mac_ad4_valid_8074v1(): Retrieves if mpdu 4th addr is valid +/** + * hal_rx_get_mpdu_mac_ad4_valid_8074v1() - 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_8074v1(uint8_t *buf) { @@ -347,7 +347,7 @@ static bool hal_rx_get_mpdu_mac_ad4_valid_8074v1(uint8_t *buf) } /** - * hal_rx_mpdu_start_sw_peer_id_get_8074v1: Retrieve sw peer_id + * hal_rx_mpdu_start_sw_peer_id_get_8074v1() - Retrieve sw peer_id * @buf: network buffer * * Return: sw peer_id @@ -362,11 +362,10 @@ static uint32_t hal_rx_mpdu_start_sw_peer_id_get_8074v1(uint8_t *buf) &mpdu_start->rx_mpdu_info_details); } -/* - * hal_rx_mpdu_get_to_ds_8074v1(): API to get the tods info - * from rx_mpdu_start - * +/** + * hal_rx_mpdu_get_to_ds_8074v1() - 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) */ @@ -381,11 +380,11 @@ static uint32_t hal_rx_mpdu_get_to_ds_8074v1(uint8_t *buf) return HAL_RX_MPDU_GET_TODS(mpdu_info); } -/* - * hal_rx_mpdu_get_fr_ds_8074v1(): API to get the from ds info - * from rx_mpdu_start - * +/** + * hal_rx_mpdu_get_fr_ds_8074v1() - 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_8074v1(uint8_t *buf) @@ -399,12 +398,12 @@ static uint32_t hal_rx_mpdu_get_fr_ds_8074v1(uint8_t *buf) return HAL_RX_MPDU_GET_FROMDS(mpdu_info); } -/* - * hal_rx_get_mpdu_frame_control_valid_8074v1(): Retrieves mpdu - * frame control valid +/** + * hal_rx_get_mpdu_frame_control_valid_8074v1() - 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_8074v1(uint8_t *buf) { @@ -415,11 +414,11 @@ static uint8_t hal_rx_get_mpdu_frame_control_valid_8074v1(uint8_t *buf) } /** - * hal_rx_get_mpdu_frame_control_field_8074v1(): Function to - * retrieve frame control field + * hal_rx_get_mpdu_frame_control_field_8074v1() - 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_8074v1(uint8_t *buf) @@ -433,11 +432,11 @@ static uint16_t hal_rx_get_mpdu_frame_control_field_8074v1(uint8_t *buf) return frame_ctrl; } -/* - * hal_rx_mpdu_get_addr1_8074v1(): API to check get address1 of the mpdu - * +/** + * hal_rx_mpdu_get_addr1_8074v1() - 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_8074v1(uint8_t *buf, @@ -467,12 +466,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr1_8074v1(uint8_t *buf, return QDF_STATUS_E_FAILURE; } -/* - * hal_rx_mpdu_get_addr2_8074v1(): API to check get address2 of the mpdu - * in the packet - * +/** + * hal_rx_mpdu_get_addr2_8074v1() - 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_8074v1(uint8_t *buf, uint8_t *mac_addr) @@ -501,12 +500,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr2_8074v1(uint8_t *buf, uint8_t *mac_addr) return QDF_STATUS_E_FAILURE; } -/* - * hal_rx_mpdu_get_addr3_8074v1(): API to get address3 of the mpdu - * in the packet - * +/** + * hal_rx_mpdu_get_addr3_8074v1() - 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_8074v1(uint8_t *buf, uint8_t *mac_addr) @@ -535,12 +534,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr3_8074v1(uint8_t *buf, uint8_t *mac_addr) return QDF_STATUS_E_FAILURE; } -/* - * hal_rx_mpdu_get_addr4_8074v1(): API to get address4 of the mpdu - * in the packet - * +/** + * hal_rx_mpdu_get_addr4_8074v1() - 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_8074v1(uint8_t *buf, uint8_t *mac_addr) @@ -569,12 +568,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr4_8074v1(uint8_t *buf, uint8_t *mac_addr) return QDF_STATUS_E_FAILURE; } -/* - * hal_rx_get_mpdu_sequence_control_valid_8074v1(): Get mpdu - * sequence control valid +/** + * hal_rx_get_mpdu_sequence_control_valid_8074v1() - 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_8074v1(uint8_t *buf) { @@ -585,9 +584,8 @@ static uint8_t hal_rx_get_mpdu_sequence_control_valid_8074v1(uint8_t *buf) } /** - * hal_rx_is_unicast_8074v1: check packet is unicast frame or not. - * - * @ buf: pointer to rx pkt TLV. + * hal_rx_is_unicast_8074v1() - check packet is unicast frame or not. + * @buf: pointer to rx pkt TLV. * * Return: true on unicast. */ @@ -608,9 +606,9 @@ static bool hal_rx_is_unicast_8074v1(uint8_t *buf) } /** - * hal_rx_tid_get_8074v1: get tid based on qos control valid. - * - * @ buf: pointer to rx pkt TLV. + * hal_rx_tid_get_8074v1() - get tid based on qos control valid. + * @hal_soc_hdl: HAL SoC handle + * @buf: pointer to rx pkt TLV. * * Return: tid */ @@ -634,7 +632,7 @@ static uint32_t hal_rx_tid_get_8074v1(hal_soc_handle_t hal_soc_hdl, } /** - * hal_rx_hw_desc_get_ppduid_get_8074v1(): retrieve ppdu id + * hal_rx_hw_desc_get_ppduid_get_8074v1() - retrieve ppdu id * @rx_tlv_hdr: Rx tlv header * @rxdma_dst_ring_desc: Rx HW descriptor * @@ -653,10 +651,10 @@ static uint32_t hal_rx_hw_desc_get_ppduid_get_8074v1(void *rx_tlv_hdr, } /** - * hal_reo_status_get_header_8074v1 - Process reo desc info + * hal_reo_status_get_header_8074v1() - 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. * @@ -757,8 +755,8 @@ static void hal_reo_status_get_header_8074v1(hal_ring_desc_t ring_desc, int b, } /** - * hal_rx_mpdu_start_mpdu_qos_control_valid_get_8074v1(): - * Retrieve qos control valid bit from the tlv. + * hal_rx_mpdu_start_mpdu_qos_control_valid_get_8074v1() - + * Retrieve qos control valid bit from the tlv. * @buf: pointer to rx pkt TLV. * * Return: qos control value. @@ -775,8 +773,8 @@ hal_rx_mpdu_start_mpdu_qos_control_valid_get_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_end_sa_sw_peer_id_get_8074v1(): API to get the - * sa_sw_peer_id from rx_msdu_end TLV + * hal_rx_msdu_end_sa_sw_peer_id_get_8074v1() - 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 @@ -791,7 +789,7 @@ hal_rx_msdu_end_sa_sw_peer_id_get_8074v1(uint8_t *buf) } /** - * hal_tx_desc_set_mesh_en_8074v1 - Set mesh_enable flag in Tx descriptor + * hal_tx_desc_set_mesh_en_8074v1() - 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 @@ -866,7 +864,7 @@ hal_rx_get_ppdu_id_8074v1(uint8_t *buf) } /** - * hal_reo_config_8074v1(): Set reo config parameters + * hal_reo_config_8074v1() - Set reo config parameters * @soc: hal soc handle * @reg_val: value to be set * @reo_params: reo parameters @@ -883,7 +881,7 @@ hal_reo_config_8074v1(struct hal_soc *soc, /** * hal_rx_msdu_desc_info_get_ptr_8074v1() - 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. * @@ -894,8 +892,8 @@ static void *hal_rx_msdu_desc_info_get_ptr_8074v1(void *msdu_details_ptr) } /** - * hal_rx_link_desc_msdu0_ptr_8074v1 - Get pointer to rx_msdu details - * @link_desc - Pointer to link desc + * hal_rx_link_desc_msdu0_ptr_8074v1() - Get pointer to rx_msdu details + * @link_desc: Pointer to link desc * * Return - Pointer to rx_msdu_details structure * @@ -906,8 +904,8 @@ static void *hal_rx_link_desc_msdu0_ptr_8074v1(void *link_desc) } /** - * hal_rx_msdu_flow_idx_get_8074v1: API to get flow index - * from rx_msdu_end TLV + * hal_rx_msdu_flow_idx_get_8074v1() - 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 @@ -921,8 +919,8 @@ static inline uint32_t hal_rx_msdu_flow_idx_get_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_flow_idx_invalid_8074v1: API to get flow index invalid - * from rx_msdu_end TLV + * hal_rx_msdu_flow_idx_invalid_8074v1() - 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 @@ -936,8 +934,8 @@ static bool hal_rx_msdu_flow_idx_invalid_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_flow_idx_timeout_8074v1: API to get flow index timeout - * from rx_msdu_end TLV + * hal_rx_msdu_flow_idx_timeout_8074v1() - 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 @@ -951,8 +949,8 @@ static bool hal_rx_msdu_flow_idx_timeout_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_fse_metadata_get_8074v1: API to get FSE metadata - * from rx_msdu_end TLV + * hal_rx_msdu_fse_metadata_get_8074v1() - 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 @@ -966,8 +964,8 @@ static uint32_t hal_rx_msdu_fse_metadata_get_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_cce_metadata_get_8074v1: API to get CCE metadata - * from rx_msdu_end TLV + * hal_rx_msdu_cce_metadata_get_8074v1() - API to get CCE metadata + * from rx_msdu_end TLV * @buf: pointer to the start of RX PKT TLV headers * * Return: cce_metadata @@ -982,8 +980,9 @@ hal_rx_msdu_cce_metadata_get_8074v1(uint8_t *buf) } /** - * hal_rx_msdu_get_flow_params_8074v1: API to get flow index, flow index invalid - * and flow index timeout from rx_msdu_end TLV + * hal_rx_msdu_get_flow_params_8074v1() - 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 @@ -1018,10 +1017,10 @@ hal_rx_tlv_get_tcp_chksum_8074v1(uint8_t *buf) } /** - * hal_rx_get_rx_sequence_8074v1(): Function to retrieve rx sequence number + * hal_rx_get_rx_sequence_8074v1() - 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_8074v1(uint8_t *buf) @@ -1033,9 +1032,8 @@ uint16_t hal_rx_get_rx_sequence_8074v1(uint8_t *buf) } /** - * hal_rx_mpdu_start_tlv_tag_valid_8074v1 () - API to check if RX_MPDU_START - * tlv tag is valid - * + * hal_rx_mpdu_start_tlv_tag_valid_8074v1() - 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. @@ -1053,9 +1051,9 @@ uint8_t hal_rx_mpdu_start_tlv_tag_valid_8074v1(void *rx_tlv_hdr) /** * hal_rx_flow_setup_fse_8074v1() - 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 */ @@ -1850,7 +1848,8 @@ struct hal_hw_srng_config hw_srng_table_8074[] = { /** * hal_qca8074_attach() - Attach 8074 target specific hal_soc ops, - * offset and srng table + * offset and srng table + * @hal_soc: HAL SoC context */ void hal_qca8074_attach(struct hal_soc *hal_soc) { diff --git a/hal/wifi3.0/qca8074v1/hal_8074v1_rx.h b/hal/wifi3.0/qca8074v1/hal_8074v1_rx.h index 6c38ab628f..ec6c7afb9b 100644 --- a/hal/wifi3.0/qca8074v1/hal_8074v1_rx.h +++ b/hal/wifi3.0/qca8074v1/hal_8074v1_rx.h @@ -1,5 +1,6 @@ /* * Copyright (c) 2016-2021 The Linux Foundation. All rights reserved. + * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for * any purpose with or without fee is hereby granted, provided that the @@ -344,11 +345,10 @@ UNIFIED_RX_MSDU_DETAILS_2_RX_MSDU_DESC_INFO_RX_MSDU_DESC_INFO_DETAILS_OFFSET)) RX_MSDU_END_1_TCP_UDP_CHKSUM_MASK, \ RX_MSDU_END_1_TCP_UDP_CHKSUM_LSB)) -/* - * hal_rx_msdu_start_nss_get_8074(): API to get the NSS - * Interval from rx_msdu_start - * +/** + * hal_rx_msdu_start_nss_get_8074() - 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 @@ -364,10 +364,9 @@ hal_rx_msdu_start_nss_get_8074(uint8_t *buf) } /** - * hal_rx_mon_hw_desc_get_mpdu_status_8074(): 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_8074() - Retrieve MPDU status + * @hw_desc_addr: Start address of Rx HW TLVs + * @rs: Status for monitor mode * * Return: void */ @@ -406,10 +405,10 @@ static uint32_t hal_get_link_desc_size_8074(void) return LINK_DESC_SIZE; } -/* - * hal_rx_get_tlv_8074(): API to get the tlv - * +/** + * hal_rx_get_tlv_8074() - API to get the tlv * @rx_tlv: TLV data extracted from the rx packet + * * Return: uint8_t */ static uint8_t hal_rx_get_tlv_8074(void *rx_tlv) @@ -419,7 +418,7 @@ static uint8_t hal_rx_get_tlv_8074(void *rx_tlv) /** * hal_rx_proc_phyrx_other_receive_info_tlv_8074() - * -process other receive info TLV + * - process other receive info TLV * @rx_tlv_hdr: pointer to TLV header * @ppdu_info: pointer to ppdu_info * @@ -435,8 +434,8 @@ void hal_rx_proc_phyrx_other_receive_info_tlv_8074(void *rx_tlv_hdr, /** * hal_rx_dump_msdu_start_tlv_8074() : dump RX msdu_start TLV in structured * human readable format. - * @ msdu_start: pointer the msdu_start TLV in pkt. - * @ dbg_level: log level. + * @msdustart: pointer the msdu_start TLV in pkt. + * @dbg_level: log level. * * Return: void */ @@ -512,10 +511,10 @@ static void hal_rx_dump_msdu_start_tlv_8074(void *msdustart, } /** - * hal_rx_dump_msdu_end_tlv_8074: 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_8074() - dump RX msdu_end TLV in structured + * human readable format. + * @msduend: pointer the msdu_end TLV in pkt. + * @dbg_level: log level. * * Return: void */ @@ -648,11 +647,11 @@ static uint32_t hal_rx_mpdu_start_tid_get_8074(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_8074() - 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_8074(uint8_t *buf) @@ -673,11 +672,10 @@ static uint32_t hal_rx_msdu_start_reception_type_get_8074(uint8_t *buf) RX_MSDU_END_13_DA_IDX_MASK, \ RX_MSDU_END_13_DA_IDX_LSB)) - /** - * hal_rx_msdu_end_da_idx_get_8074: API to get da_idx - * from rx_msdu_end TLV +/** + * hal_rx_msdu_end_da_idx_get_8074() - 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_8074(uint8_t *buf) diff --git a/hal/wifi3.0/qca8074v1/hal_8074v1_tx.h b/hal/wifi3.0/qca8074v1/hal_8074v1_tx.h index 77f5e207d5..c7a9ac56bf 100644 --- a/hal/wifi3.0/qca8074v1/hal_8074v1_tx.h +++ b/hal/wifi3.0/qca8074v1/hal_8074v1_tx.h @@ -1,5 +1,6 @@ /* * Copyright (c) 2016-2020 The Linux Foundation. All rights reserved. + * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for * any purpose with or without fee is hereby granted, provided that the @@ -26,7 +27,7 @@ /** * hal_tx_desc_set_dscp_tid_table_id_8074() - Sets DSCP to TID conversion - * table ID + * table ID * @desc: Handle to Tx Descriptor * @id: DSCP to tid conversion table to be used for this frame * @@ -91,11 +92,11 @@ static void hal_tx_set_dscp_tid_map_8074(struct hal_soc *soc, uint8_t *map, /** * hal_tx_update_dscp_tid_8074() - Update the dscp tid map table as - updated by user + * 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 */ @@ -131,7 +132,7 @@ void hal_tx_update_dscp_tid_8074(struct hal_soc *soc, uint8_t tid, } /** - * hal_tx_desc_set_lmac_id - Set the lmac_id value + * hal_tx_desc_set_lmac_id_8074() - Set the lmac_id value * @desc: Handle to Tx Descriptor * @lmac_id: mac Id to ast matching * b00 – mac 0 @@ -148,7 +149,7 @@ static void hal_tx_desc_set_lmac_id_8074(void *desc, uint8_t lmac_id) /** * hal_tx_init_cmd_credit_ring_8074v1() - 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 */