samsung-sm8650/android_kernel_samsung_sm8650-modules
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

qcacmn: Fix hal/wifi3.0/qca8074v2 documentation

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

Change-Id: I03e263a2a8ae4cf256d143d772c3a32ed11dfe48
CRs-Fixed: 3411714
This commit is contained in:
Jeff Johnson
2023-02-20 08:10:09 -08:00
committed by Madan Koyyalamudi
parent 9c8278f7b9
commit 2cdca1a9c3
3 changed files with 149 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

233
hal/wifi3.0/qca8074v2/hal_8074v2.c
View File

@@ -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
@@ -119,11 +119,11 @@
#include "hal_li_generic_api.h"
/**
* hal_rx_get_rx_fragment_number_8074v2(): Function to retrieve
* hal_rx_get_rx_fragment_number_8074v2() - 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_8074v2(uint8_t *buf)
@@ -137,10 +137,10 @@ uint8_t hal_rx_get_rx_fragment_number_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_end_da_is_mcbc_get_8074v2: API to check if pkt is MCBC
* from rx_msdu_end TLV
* hal_rx_msdu_end_da_is_mcbc_get_8074v2() - 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
@@ -153,10 +153,10 @@ hal_rx_msdu_end_da_is_mcbc_get_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_end_sa_is_valid_get_8074v2(): API to get_8074v2 the
* sa_is_valid bit from rx_msdu_end TLV
* hal_rx_msdu_end_sa_is_valid_get_8074v2() - API to get_8074v2 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
@@ -172,10 +172,10 @@ hal_rx_msdu_end_sa_is_valid_get_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_end_sa_idx_get_8074v2(): API to get_8074v2 the
* sa_idx from rx_msdu_end TLV
* hal_rx_msdu_end_sa_idx_get_8074v2() - API to get_8074v2 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_8074v2(uint8_t *buf)
@@ -191,8 +191,6 @@ static uint16_t hal_rx_msdu_end_sa_idx_get_8074v2(uint8_t *buf)
/**
* hal_rx_desc_is_first_msdu_8074v2() - Check if first msdu
*
* @hal_soc_hdl: hal_soc handle
* @hw_desc_addr: hardware descriptor address
*
* Return: 0 - success/ non-zero failure
@@ -206,10 +204,11 @@ static uint32_t hal_rx_desc_is_first_msdu_8074v2(void *hw_desc_addr)
}
/**
* hal_rx_msdu_end_l3_hdr_padding_get_8074v2(): API to get_8074v2 the
* l3_header padding from rx_msdu_end TLV
* hal_rx_msdu_end_l3_hdr_padding_get_8074v2() - API to get_8074v2 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_8074v2(uint8_t *buf)
@@ -223,11 +222,11 @@ static uint32_t hal_rx_msdu_end_l3_hdr_padding_get_8074v2(uint8_t *buf)
return l3_header_padding;
}
/*
* @ hal_rx_encryption_info_valid_8074v2: Returns encryption type.
/**
* hal_rx_encryption_info_valid_8074v2() - 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_8074v2(uint8_t *buf)
{
@@ -240,11 +239,11 @@ static uint32_t hal_rx_encryption_info_valid_8074v2(uint8_t *buf)
return encryption_info;
}
/*
* @ hal_rx_print_pn_8074v2: Prints the PN of rx packet.
/**
* hal_rx_print_pn_8074v2() - 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_8074v2(uint8_t *buf)
{
@@ -263,10 +262,10 @@ static void hal_rx_print_pn_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_end_first_msdu_get_8074v2: API to get first msdu status
* from rx_msdu_end TLV
* hal_rx_msdu_end_first_msdu_get_8074v2() - 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_8074v2(uint8_t *buf)
@@ -281,10 +280,10 @@ static uint8_t hal_rx_msdu_end_first_msdu_get_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_end_da_is_valid_get_8074v2: API to check if da is valid
* from rx_msdu_end TLV
* hal_rx_msdu_end_da_is_valid_get_8074v2() - 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_8074v2(uint8_t *buf)
@@ -299,10 +298,10 @@ static uint8_t hal_rx_msdu_end_da_is_valid_get_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_end_last_msdu_get_8074v2: API to get last msdu status
* from rx_msdu_end TLV
* hal_rx_msdu_end_last_msdu_get_8074v2() - 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_8074v2(uint8_t *buf)
@@ -316,11 +315,11 @@ static uint8_t hal_rx_msdu_end_last_msdu_get_8074v2(uint8_t *buf)
return last_msdu;
}
/*
* hal_rx_get_mpdu_mac_ad4_valid_8074v2(): Retrieves if mpdu 4th addr is valid
/**
* hal_rx_get_mpdu_mac_ad4_valid_8074v2() - 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_8074v2(uint8_t *buf)
{
@@ -334,7 +333,7 @@ static bool hal_rx_get_mpdu_mac_ad4_valid_8074v2(uint8_t *buf)
}
/**
* hal_rx_mpdu_start_sw_peer_id_get_8074v2: Retrieve sw peer_id
* hal_rx_mpdu_start_sw_peer_id_get_8074v2() - Retrieve sw peer_id
* @buf: network buffer
*
* Return: sw peer_id
@@ -349,11 +348,10 @@ static uint32_t hal_rx_mpdu_start_sw_peer_id_get_8074v2(uint8_t *buf)
&mpdu_start->rx_mpdu_info_details);
}
/*
* hal_rx_mpdu_get_to_ds_8074v2(): API to get the tods info
* from rx_mpdu_start
*
/**
* hal_rx_mpdu_get_to_ds_8074v2() - 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_8074v2(uint8_t *buf)
@@ -367,11 +365,11 @@ static uint32_t hal_rx_mpdu_get_to_ds_8074v2(uint8_t *buf)
return HAL_RX_MPDU_GET_TODS(mpdu_info);
}
/*
* hal_rx_mpdu_get_fr_ds_8074v2(): API to get the from ds info
* from rx_mpdu_start
*
/**
* hal_rx_mpdu_get_fr_ds_8074v2() - 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_8074v2(uint8_t *buf)
@@ -385,12 +383,12 @@ static uint32_t hal_rx_mpdu_get_fr_ds_8074v2(uint8_t *buf)
return HAL_RX_MPDU_GET_FROMDS(mpdu_info);
}
/*
* hal_rx_get_mpdu_frame_control_valid_8074v2(): Retrieves mpdu
* frame control valid
/**
* hal_rx_get_mpdu_frame_control_valid_8074v2() - 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_8074v2(uint8_t *buf)
{
@@ -401,11 +399,11 @@ static uint8_t hal_rx_get_mpdu_frame_control_valid_8074v2(uint8_t *buf)
}
/**
* hal_rx_get_mpdu_frame_control_field_8074v2(): Function to
* retrieve frame control field
* hal_rx_get_mpdu_frame_control_field_8074v2() - 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_8074v2(uint8_t *buf)
@@ -419,11 +417,11 @@ static uint16_t hal_rx_get_mpdu_frame_control_field_8074v2(uint8_t *buf)
return frame_ctrl;
}
/*
* hal_rx_mpdu_get_addr1_8074v2(): API to check get address1 of the mpdu
*
/**
* hal_rx_mpdu_get_addr1_8074v2() - 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_8074v2(uint8_t *buf, uint8_t *mac_addr)
@@ -452,12 +450,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr1_8074v2(uint8_t *buf, uint8_t *mac_addr)
return QDF_STATUS_E_FAILURE;
}
/*
* hal_rx_mpdu_get_addr2_8074v2(): API to check get address2 of the mpdu
* in the packet
*
/**
* hal_rx_mpdu_get_addr2_8074v2() - 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_8074v2(uint8_t *buf, uint8_t *mac_addr)
@@ -486,12 +484,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr2_8074v2(uint8_t *buf, uint8_t *mac_addr)
return QDF_STATUS_E_FAILURE;
}
/*
* hal_rx_mpdu_get_addr3_8074v2(): API to get address3 of the mpdu
* in the packet
*
/**
* hal_rx_mpdu_get_addr3_8074v2() - 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_8074v2(uint8_t *buf, uint8_t *mac_addr)
@@ -520,12 +518,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr3_8074v2(uint8_t *buf, uint8_t *mac_addr)
return QDF_STATUS_E_FAILURE;
}
/*
* hal_rx_mpdu_get_addr4_8074v2(): API to get address4 of the mpdu
* in the packet
*
/**
* hal_rx_mpdu_get_addr4_8074v2() - 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_8074v2(uint8_t *buf, uint8_t *mac_addr)
@@ -554,12 +552,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr4_8074v2(uint8_t *buf, uint8_t *mac_addr)
return QDF_STATUS_E_FAILURE;
}
/*
* hal_rx_get_mpdu_sequence_control_valid_8074v2(): Get mpdu
* sequence control valid
/**
* hal_rx_get_mpdu_sequence_control_valid_8074v2() - 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_8074v2(uint8_t *buf)
{
@@ -570,9 +568,8 @@ static uint8_t hal_rx_get_mpdu_sequence_control_valid_8074v2(uint8_t *buf)
}
/**
* hal_rx_is_unicast_8074v2: check packet is unicast frame or not.
*
* @ buf: pointer to rx pkt TLV.
* hal_rx_is_unicast_8074v2() - check packet is unicast frame or not.
* @buf: pointer to rx pkt TLV.
*
* Return: true on unicast.
*/
@@ -593,7 +590,7 @@ static bool hal_rx_is_unicast_8074v2(uint8_t *buf)
}
/**
* hal_rx_tid_get_8074v2: get tid based on qos control valid.
* hal_rx_tid_get_8074v2() - get tid based on qos control valid.
* @hal_soc_hdl: hal soc handle
* @buf: pointer to rx pkt TLV.
*
@@ -619,7 +616,7 @@ static uint32_t hal_rx_tid_get_8074v2(hal_soc_handle_t hal_soc_hdl,
}
/**
* hal_rx_hw_desc_get_ppduid_get_8074v2(): retrieve ppdu id
* hal_rx_hw_desc_get_ppduid_get_8074v2() - retrieve ppdu id
* @rx_tlv_hdr: packtet rx tlv header
* @rxdma_dst_ring_desc: rxdma HW descriptor
*
@@ -638,13 +635,12 @@ static uint32_t hal_rx_hw_desc_get_ppduid_get_8074v2(void *rx_tlv_hdr,
}
/**
* hal_reo_status_get_header_8074v2 - Process reo desc info
* hal_reo_status_get_header_8074v2() - 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
*
* Return - none.
* @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_8074v2(hal_ring_desc_t ring_desc, int b,
void *h1)
@@ -742,8 +738,8 @@ static void hal_reo_status_get_header_8074v2(hal_ring_desc_t ring_desc, int b,
}
/**
* hal_rx_mpdu_start_mpdu_qos_control_valid_get_8074v2():
* Retrieve qos control valid bit from the tlv.
* hal_rx_mpdu_start_mpdu_qos_control_valid_get_8074v2() -
* Retrieve qos control valid bit from the tlv.
* @buf: pointer to rx pkt TLV.
*
* Return: qos control value.
@@ -760,8 +756,8 @@ hal_rx_mpdu_start_mpdu_qos_control_valid_get_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_end_sa_sw_peer_id_get_8074v2(): API to get the
* sa_sw_peer_id from rx_msdu_end TLV
* hal_rx_msdu_end_sa_sw_peer_id_get_8074v2() - 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
@@ -776,7 +772,7 @@ hal_rx_msdu_end_sa_sw_peer_id_get_8074v2(uint8_t *buf)
}
/**
* hal_tx_desc_set_mesh_en_8074v2 - Set mesh_enable flag in Tx descriptor
* hal_tx_desc_set_mesh_en_8074v2() - 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
@@ -851,7 +847,7 @@ hal_rx_get_ppdu_id_8074v2(uint8_t *buf)
}
/**
* hal_reo_config_8074v2(): Set reo config parameters
* hal_reo_config_8074v2() - Set reo config parameters
* @soc: hal soc handle
* @reg_val: value to be set
* @reo_params: reo parameters
@@ -868,9 +864,9 @@ hal_reo_config_8074v2(struct hal_soc *soc,
/**
* hal_rx_msdu_desc_info_get_ptr_8074v2() - 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_8074v2(void *msdu_details_ptr)
@@ -879,11 +875,10 @@ static void *hal_rx_msdu_desc_info_get_ptr_8074v2(void *msdu_details_ptr)
}
/**
* hal_rx_link_desc_msdu0_ptr_8074v2 - Get pointer to rx_msdu details
* @link_desc - Pointer to link desc
*
* Return - Pointer to rx_msdu_details structure
* hal_rx_link_desc_msdu0_ptr_8074v2() - 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_8074v2(void *link_desc)
{
@@ -891,8 +886,8 @@ static void *hal_rx_link_desc_msdu0_ptr_8074v2(void *link_desc)
}
/**
* hal_rx_msdu_flow_idx_get_8074v2: API to get flow index
* from rx_msdu_end TLV
* hal_rx_msdu_flow_idx_get_8074v2() - 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
@@ -906,8 +901,8 @@ static inline uint32_t hal_rx_msdu_flow_idx_get_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_flow_idx_invalid_8074v2: API to get flow index invalid
* from rx_msdu_end TLV
* hal_rx_msdu_flow_idx_invalid_8074v2() - 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
@@ -921,8 +916,8 @@ static bool hal_rx_msdu_flow_idx_invalid_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_flow_idx_timeout_8074v2: API to get flow index timeout
* from rx_msdu_end TLV
* hal_rx_msdu_flow_idx_timeout_8074v2() - 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
@@ -936,8 +931,8 @@ static bool hal_rx_msdu_flow_idx_timeout_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_fse_metadata_get_8074v2: API to get FSE metadata
* from rx_msdu_end TLV
* hal_rx_msdu_fse_metadata_get_8074v2() - 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
@@ -951,8 +946,8 @@ static uint32_t hal_rx_msdu_fse_metadata_get_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_cce_metadata_get_8074v2: API to get CCE metadata
* from rx_msdu_end TLV
* hal_rx_msdu_cce_metadata_get_8074v2() - API to get CCE metadata
* from rx_msdu_end TLV
* @buf: pointer to the start of RX PKT TLV headers
*
* Return: cce_metadata
@@ -967,8 +962,9 @@ hal_rx_msdu_cce_metadata_get_8074v2(uint8_t *buf)
}
/**
* hal_rx_msdu_get_flow_params_8074v2: API to get flow index, flow index invalid
* and flow index timeout from rx_msdu_end TLV
* hal_rx_msdu_get_flow_params_8074v2() - 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
@@ -1003,10 +999,10 @@ hal_rx_tlv_get_tcp_chksum_8074v2(uint8_t *buf)
}
/**
* hal_rx_get_rx_sequence_8074v2(): Function to retrieve rx sequence number
* hal_rx_get_rx_sequence_8074v2() - 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_8074v2(uint8_t *buf)
@@ -1018,7 +1014,7 @@ uint16_t hal_rx_get_rx_sequence_8074v2(uint8_t *buf)
}
/**
* hal_get_window_address_8074v2(): Function to get hp/tp address
* hal_get_window_address_8074v2() - Function to get hp/tp address
* @hal_soc: Pointer to hal_soc
* @addr: address offset of register
*
@@ -1050,9 +1046,9 @@ uint8_t hal_rx_mpdu_start_tlv_tag_valid_8074v2(void *rx_tlv_hdr)
/**
* hal_rx_flow_setup_fse_8074v2() - 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
*/
@@ -1854,7 +1850,8 @@ struct hal_hw_srng_config hw_srng_table_8074v2[] = {
/**
* hal_qca8074v2_attach() - Attach 8074v2 target specific hal_soc ops,
* offset and srng table
* offset and srng table
* @hal_soc: HAL SoC context
*/
void hal_qca8074v2_attach(struct hal_soc *hal_soc)
{