qcacmn: Fix hal/wifi3.0/qca6390 documentation

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

Change-Id: I56bf59aea331e4f720610436222af824ee0265d7
CRs-Fixed: 3410710
This commit is contained in:
Jeff Johnson
2023-02-19 17:37:11 -08:00
committed by Madan Koyyalamudi
parent e867292a52
commit f11e72a709
3 changed files with 134 additions and 136 deletions

View File

@@ -1,6 +1,6 @@
/* /*
* Copyright (c) 2016-2021 The Linux Foundation. All rights reserved. * 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 * Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the * any purpose with or without fee is hereby granted, provided that the
@@ -114,10 +114,10 @@
#include "hal_li_generic_api.h" #include "hal_li_generic_api.h"
/** /**
* hal_rx_get_rx_fragment_number_6390(): Function to retrieve rx fragment number * hal_rx_get_rx_fragment_number_6390() - API to retrieve rx fragment number
* @buf: Network buffer
* *
* @nbuf: Network buffer * Return: rx fragment number
* Returns: rx fragment number
*/ */
static static
uint8_t hal_rx_get_rx_fragment_number_6390(uint8_t *buf) uint8_t hal_rx_get_rx_fragment_number_6390(uint8_t *buf)
@@ -131,10 +131,10 @@ uint8_t hal_rx_get_rx_fragment_number_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_end_da_is_mcbc_get_6390(): API to check if pkt is MCBC * hal_rx_msdu_end_da_is_mcbc_get_6390() - API to check if pkt is MCBC
* from rx_msdu_end TLV * 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 * Return: da_is_mcbc
*/ */
static uint8_t static uint8_t
@@ -147,10 +147,10 @@ hal_rx_msdu_end_da_is_mcbc_get_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_end_sa_is_valid_get_6390(): API to get_6390 the * hal_rx_msdu_end_sa_is_valid_get_6390() - API to get_6390 the sa_is_valid
* sa_is_valid bit from rx_msdu_end TLV * 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 * Return: sa_is_valid bit
*/ */
static uint8_t static uint8_t
@@ -166,10 +166,10 @@ hal_rx_msdu_end_sa_is_valid_get_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_end_sa_idx_get_6390(): API to get_6390 the * hal_rx_msdu_end_sa_idx_get_6390() - API to get_6390 the sa_idx from
* sa_idx from rx_msdu_end TLV * 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) * Return: sa_idx (SA AST index)
*/ */
static static
@@ -186,8 +186,6 @@ uint16_t hal_rx_msdu_end_sa_idx_get_6390(uint8_t *buf)
/** /**
* hal_rx_desc_is_first_msdu_6390() - Check if first msdu * hal_rx_desc_is_first_msdu_6390() - Check if first msdu
*
* @hal_soc_hdl: hal_soc handle
* @hw_desc_addr: hardware descriptor address * @hw_desc_addr: hardware descriptor address
* *
* Return: 0 - success/ non-zero failure * Return: 0 - success/ non-zero failure
@@ -201,10 +199,10 @@ static uint32_t hal_rx_desc_is_first_msdu_6390(void *hw_desc_addr)
} }
/** /**
* hal_rx_msdu_end_l3_hdr_padding_get_6390(): API to get_6390 the * hal_rx_msdu_end_l3_hdr_padding_get_6390() - API to get_6390 the l3_header
* l3_header padding from rx_msdu_end TLV * 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 * Return: number of l3 header padding bytes
*/ */
static uint32_t hal_rx_msdu_end_l3_hdr_padding_get_6390(uint8_t *buf) static uint32_t hal_rx_msdu_end_l3_hdr_padding_get_6390(uint8_t *buf)
@@ -218,11 +216,11 @@ static uint32_t hal_rx_msdu_end_l3_hdr_padding_get_6390(uint8_t *buf)
return l3_header_padding; return l3_header_padding;
} }
/* /**
* @ hal_rx_encryption_info_valid_6390: Returns encryption type. * hal_rx_encryption_info_valid_6390() - 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_6390(uint8_t *buf) static uint32_t hal_rx_encryption_info_valid_6390(uint8_t *buf)
{ {
@@ -235,11 +233,11 @@ static uint32_t hal_rx_encryption_info_valid_6390(uint8_t *buf)
return encryption_info; return encryption_info;
} }
/* /**
* @ hal_rx_print_pn_6390: Prints the PN of rx packet. * hal_rx_print_pn_6390() - 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_6390(uint8_t *buf) static void hal_rx_print_pn_6390(uint8_t *buf)
{ {
@@ -258,10 +256,10 @@ static void hal_rx_print_pn_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_end_first_msduget_6390: API to get first msdu status * hal_rx_msdu_end_first_msdu_get_6390() - API to get first msdu status
* from rx_msdu_end TLV * 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 * Return: first_msdu
*/ */
static uint8_t hal_rx_msdu_end_first_msdu_get_6390(uint8_t *buf) static uint8_t hal_rx_msdu_end_first_msdu_get_6390(uint8_t *buf)
@@ -276,10 +274,10 @@ static uint8_t hal_rx_msdu_end_first_msdu_get_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_end_da_is_valid_get_6390: API to check if da is valid * hal_rx_msdu_end_da_is_valid_get_6390() - API to check if da is valid
* from rx_msdu_end TLV * 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 * Return: da_is_valid
*/ */
static uint8_t hal_rx_msdu_end_da_is_valid_get_6390(uint8_t *buf) static uint8_t hal_rx_msdu_end_da_is_valid_get_6390(uint8_t *buf)
@@ -294,10 +292,10 @@ static uint8_t hal_rx_msdu_end_da_is_valid_get_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_end_last_msdu_get_6390: API to get last msdu status * hal_rx_msdu_end_last_msdu_get_6390() - API to get last msdu status
* from rx_msdu_end TLV * 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 * Return: last_msdu
*/ */
static uint8_t hal_rx_msdu_end_last_msdu_get_6390(uint8_t *buf) static uint8_t hal_rx_msdu_end_last_msdu_get_6390(uint8_t *buf)
@@ -311,11 +309,11 @@ static uint8_t hal_rx_msdu_end_last_msdu_get_6390(uint8_t *buf)
return last_msdu; return last_msdu;
} }
/* /**
* hal_rx_get_mpdu_mac_ad4_valid_6390(): Retrieves if mpdu 4th addr is valid * hal_rx_get_mpdu_mac_ad4_valid_6390() - Retrieves if mpdu 4th addr is valid
* @buf: Network buffer
* *
* @nbuf: Network buffer * Return: value of mpdu 4th address valid field
* Returns: value of mpdu 4th address valid field
*/ */
static bool hal_rx_get_mpdu_mac_ad4_valid_6390(uint8_t *buf) static bool hal_rx_get_mpdu_mac_ad4_valid_6390(uint8_t *buf)
{ {
@@ -329,7 +327,7 @@ static bool hal_rx_get_mpdu_mac_ad4_valid_6390(uint8_t *buf)
} }
/** /**
* hal_rx_mpdu_start_sw_peer_id_get_6390: Retrieve sw peer_id * hal_rx_mpdu_start_sw_peer_id_get_6390() - Retrieve sw peer_id
* @buf: network buffer * @buf: network buffer
* *
* Return: sw peer_id * Return: sw peer_id
@@ -344,11 +342,11 @@ static uint32_t hal_rx_mpdu_start_sw_peer_id_get_6390(uint8_t *buf)
&mpdu_start->rx_mpdu_info_details); &mpdu_start->rx_mpdu_info_details);
} }
/* /**
* hal_rx_mpdu_get_to_ds_6390(): API to get the tods info * hal_rx_mpdu_get_to_ds_6390() - API to get the tods info
* from rx_mpdu_start * from rx_mpdu_start
*
* @buf: pointer to the start of RX PKT TLV header * @buf: pointer to the start of RX PKT TLV header
*
* Return: uint32_t(to_ds) * Return: uint32_t(to_ds)
*/ */
static uint32_t hal_rx_mpdu_get_to_ds_6390(uint8_t *buf) static uint32_t hal_rx_mpdu_get_to_ds_6390(uint8_t *buf)
@@ -362,11 +360,11 @@ static uint32_t hal_rx_mpdu_get_to_ds_6390(uint8_t *buf)
return HAL_RX_MPDU_GET_TODS(mpdu_info); return HAL_RX_MPDU_GET_TODS(mpdu_info);
} }
/* /**
* hal_rx_mpdu_get_fr_ds_6390(): API to get the from ds info * hal_rx_mpdu_get_fr_ds_6390() - API to get the from ds info
* from rx_mpdu_start * from rx_mpdu_start
*
* @buf: pointer to the start of RX PKT TLV header * @buf: pointer to the start of RX PKT TLV header
*
* Return: uint32_t(fr_ds) * Return: uint32_t(fr_ds)
*/ */
static uint32_t hal_rx_mpdu_get_fr_ds_6390(uint8_t *buf) static uint32_t hal_rx_mpdu_get_fr_ds_6390(uint8_t *buf)
@@ -380,12 +378,12 @@ static uint32_t hal_rx_mpdu_get_fr_ds_6390(uint8_t *buf)
return HAL_RX_MPDU_GET_FROMDS(mpdu_info); return HAL_RX_MPDU_GET_FROMDS(mpdu_info);
} }
/* /**
* hal_rx_get_mpdu_frame_control_valid_6390(): Retrieves mpdu * hal_rx_get_mpdu_frame_control_valid_6390() - Retrieves mpdu
* frame control valid * frame control valid
* @buf: Network buffer
* *
* @nbuf: Network buffer * Return: value of frame control valid field
* Returns: value of frame control valid field
*/ */
static uint8_t hal_rx_get_mpdu_frame_control_valid_6390(uint8_t *buf) static uint8_t hal_rx_get_mpdu_frame_control_valid_6390(uint8_t *buf)
{ {
@@ -395,11 +393,11 @@ static uint8_t hal_rx_get_mpdu_frame_control_valid_6390(uint8_t *buf)
return HAL_RX_MPDU_GET_FRAME_CONTROL_VALID(rx_mpdu_info); return HAL_RX_MPDU_GET_FRAME_CONTROL_VALID(rx_mpdu_info);
} }
/* /**
* hal_rx_mpdu_get_addr1_6390(): API to check get address1 of the mpdu * hal_rx_mpdu_get_addr1_6390() - API to check get address1 of the mpdu
*
* @buf: pointer to the start of RX PKT TLV headera * @buf: pointer to the start of RX PKT TLV headera
* @mac_addr: pointer to mac address * @mac_addr: pointer to mac address
*
* Return: success/failure * Return: success/failure
*/ */
static QDF_STATUS hal_rx_mpdu_get_addr1_6390(uint8_t *buf, uint8_t *mac_addr) static QDF_STATUS hal_rx_mpdu_get_addr1_6390(uint8_t *buf, uint8_t *mac_addr)
@@ -428,12 +426,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr1_6390(uint8_t *buf, uint8_t *mac_addr)
return QDF_STATUS_E_FAILURE; return QDF_STATUS_E_FAILURE;
} }
/* /**
* hal_rx_mpdu_get_addr2_6390(): API to check get address2 of the mpdu * hal_rx_mpdu_get_addr2_6390() - API to check get address2 of the mpdu
* in the packet * in the packet
*
* @buf: pointer to the start of RX PKT TLV header * @buf: pointer to the start of RX PKT TLV header
* @mac_addr: pointer to mac address * @mac_addr: pointer to mac address
*
* Return: success/failure * Return: success/failure
*/ */
static QDF_STATUS hal_rx_mpdu_get_addr2_6390(uint8_t *buf, static QDF_STATUS hal_rx_mpdu_get_addr2_6390(uint8_t *buf,
@@ -463,12 +461,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr2_6390(uint8_t *buf,
return QDF_STATUS_E_FAILURE; return QDF_STATUS_E_FAILURE;
} }
/* /**
* hal_rx_mpdu_get_addr3_6390(): API to get address3 of the mpdu * hal_rx_mpdu_get_addr3_6390() - API to get address3 of the mpdu
* in the packet * in the packet
*
* @buf: pointer to the start of RX PKT TLV header * @buf: pointer to the start of RX PKT TLV header
* @mac_addr: pointer to mac address * @mac_addr: pointer to mac address
*
* Return: success/failure * Return: success/failure
*/ */
static QDF_STATUS hal_rx_mpdu_get_addr3_6390(uint8_t *buf, uint8_t *mac_addr) static QDF_STATUS hal_rx_mpdu_get_addr3_6390(uint8_t *buf, uint8_t *mac_addr)
@@ -497,12 +495,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr3_6390(uint8_t *buf, uint8_t *mac_addr)
return QDF_STATUS_E_FAILURE; return QDF_STATUS_E_FAILURE;
} }
/* /**
* hal_rx_mpdu_get_addr4_6390(): API to get address4 of the mpdu * hal_rx_mpdu_get_addr4_6390() - API to get address4 of the mpdu
* in the packet * in the packet
*
* @buf: pointer to the start of RX PKT TLV header * @buf: pointer to the start of RX PKT TLV header
* @mac_addr: pointer to mac address * @mac_addr: pointer to mac address
*
* Return: success/failure * Return: success/failure
*/ */
static QDF_STATUS hal_rx_mpdu_get_addr4_6390(uint8_t *buf, uint8_t *mac_addr) static QDF_STATUS hal_rx_mpdu_get_addr4_6390(uint8_t *buf, uint8_t *mac_addr)
@@ -531,12 +529,12 @@ static QDF_STATUS hal_rx_mpdu_get_addr4_6390(uint8_t *buf, uint8_t *mac_addr)
return QDF_STATUS_E_FAILURE; return QDF_STATUS_E_FAILURE;
} }
/* /**
* hal_rx_get_mpdu_sequence_control_valid_6390(): Get mpdu * hal_rx_get_mpdu_sequence_control_valid_6390() - Get mpdu sequence
* sequence control valid * control valid
* @buf: Network buffer
* *
* @nbuf: Network buffer * Return: value of sequence control valid field
* Returns: value of sequence control valid field
*/ */
static uint8_t hal_rx_get_mpdu_sequence_control_valid_6390(uint8_t *buf) static uint8_t hal_rx_get_mpdu_sequence_control_valid_6390(uint8_t *buf)
{ {
@@ -547,9 +545,8 @@ static uint8_t hal_rx_get_mpdu_sequence_control_valid_6390(uint8_t *buf)
} }
/** /**
* hal_rx_is_unicast_6390: check packet is unicast frame or not. * hal_rx_is_unicast_6390() - check packet is unicast frame or not.
* * @buf: pointer to rx pkt TLV.
* @ buf: pointer to rx pkt TLV.
* *
* Return: true on unicast. * Return: true on unicast.
*/ */
@@ -570,7 +567,7 @@ static bool hal_rx_is_unicast_6390(uint8_t *buf)
} }
/** /**
* hal_rx_tid_get_6390: get tid based on qos control valid. * hal_rx_tid_get_6390() - get tid based on qos control valid.
* @hal_soc_hdl: hal soc handle * @hal_soc_hdl: hal soc handle
* @buf: pointer to rx pkt TLV. * @buf: pointer to rx pkt TLV.
* *
@@ -595,7 +592,7 @@ static uint32_t hal_rx_tid_get_6390(hal_soc_handle_t hal_soc_hdl, uint8_t *buf)
} }
/** /**
* hal_rx_hw_desc_get_ppduid_get_6390(): retrieve ppdu id * hal_rx_hw_desc_get_ppduid_get_6390() - retrieve ppdu id
* @rx_tlv_hdr: start address of rx_pkt_tlvs * @rx_tlv_hdr: start address of rx_pkt_tlvs
* @rxdma_dst_ring_desc: Rx HW descriptor * @rxdma_dst_ring_desc: Rx HW descriptor
* *
@@ -614,13 +611,12 @@ static uint32_t hal_rx_hw_desc_get_ppduid_get_6390(void *rx_tlv_hdr,
} }
/** /**
* hal_reo_status_get_header_6390 - Process reo desc info * hal_reo_status_get_header_6390() - Process reo desc info
* @ring_desc: REO status ring descriptor * @ring_desc: REO status ring descriptor
* @b - tlv type info * @b: tlv type info
* @h1 - Pointer to hal_reo_status_header where info to be stored * @h1: Pointer to hal_reo_status_header where info to be stored
*
* Return - none.
* *
* Return: none.
*/ */
static void hal_reo_status_get_header_6390(hal_ring_desc_t ring_desc, int b, static void hal_reo_status_get_header_6390(hal_ring_desc_t ring_desc, int b,
void *h1) void *h1)
@@ -718,8 +714,8 @@ static void hal_reo_status_get_header_6390(hal_ring_desc_t ring_desc, int b,
} }
/** /**
* hal_rx_mpdu_start_mpdu_qos_control_valid_get_6390(): * hal_rx_mpdu_start_mpdu_qos_control_valid_get_6390() - Retrieve qos control
* Retrieve qos control valid bit from the tlv. * valid bit from the tlv.
* @buf: pointer to rx pkt TLV. * @buf: pointer to rx pkt TLV.
* *
* Return: qos control value. * Return: qos control value.
@@ -736,8 +732,8 @@ hal_rx_mpdu_start_mpdu_qos_control_valid_get_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_end_sa_sw_peer_id_get_6390(): API to get the * hal_rx_msdu_end_sa_sw_peer_id_get_6390() - API to get the sa_sw_peer_id
* sa_sw_peer_id from rx_msdu_end TLV * 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_sw_peer_id index * Return: sa_sw_peer_id index
@@ -752,7 +748,7 @@ hal_rx_msdu_end_sa_sw_peer_id_get_6390(uint8_t *buf)
} }
/** /**
* hal_tx_desc_set_mesh_en_6390 - Set mesh_enable flag in Tx descriptor * hal_tx_desc_set_mesh_en_6390() - Set mesh_enable flag in Tx descriptor
* @desc: Handle to Tx Descriptor * @desc: Handle to Tx Descriptor
* @en: For raw WiFi frames, this indicates transmission to a mesh STA, * @en: For raw WiFi frames, this indicates transmission to a mesh STA,
* enabling the interpretation of the 'Mesh Control Present' bit * enabling the interpretation of the 'Mesh Control Present' bit
@@ -821,7 +817,7 @@ hal_rx_get_ppdu_id_6390(uint8_t *buf)
} }
/** /**
* hal_reo_config_6390(): Set reo config parameters * hal_reo_config_6390() - Set reo config parameters
* @soc: hal soc handle * @soc: hal soc handle
* @reg_val: value to be set * @reg_val: value to be set
* @reo_params: reo parameters * @reo_params: reo parameters
@@ -838,8 +834,9 @@ void hal_reo_config_6390(struct hal_soc *soc,
/** /**
* hal_rx_msdu_desc_info_get_ptr_6390() - Get msdu desc info ptr * hal_rx_msdu_desc_info_get_ptr_6390() - 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_6390(void *msdu_details_ptr) static void *hal_rx_msdu_desc_info_get_ptr_6390(void *msdu_details_ptr)
@@ -848,9 +845,10 @@ static void *hal_rx_msdu_desc_info_get_ptr_6390(void *msdu_details_ptr)
} }
/** /**
* hal_rx_link_desc_msdu0_ptr_6390 - Get pointer to rx_msdu details * hal_rx_link_desc_msdu0_ptr_6390() - Get pointer to rx_msdu details
* @link_desc - Pointer to link desc * @link_desc: Pointer to link desc
* Return - Pointer to rx_msdu_details structure *
* Return: Pointer to rx_msdu_details structure
* *
*/ */
static void *hal_rx_link_desc_msdu0_ptr_6390(void *link_desc) static void *hal_rx_link_desc_msdu0_ptr_6390(void *link_desc)
@@ -859,8 +857,7 @@ static void *hal_rx_link_desc_msdu0_ptr_6390(void *link_desc)
} }
/** /**
* hal_rx_msdu_flow_idx_get_6390: API to get flow index * hal_rx_msdu_flow_idx_get_6390() - API to get flow index from rx_msdu_end TLV
* 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: flow index value from MSDU END TLV * Return: flow index value from MSDU END TLV
@@ -874,8 +871,8 @@ static inline uint32_t hal_rx_msdu_flow_idx_get_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_flow_idx_invalid_6390: API to get flow index invalid * hal_rx_msdu_flow_idx_invalid_6390() - API to get flow index invalid
* from rx_msdu_end TLV * 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: flow index invalid value from MSDU END TLV * Return: flow index invalid value from MSDU END TLV
@@ -889,8 +886,8 @@ static bool hal_rx_msdu_flow_idx_invalid_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_flow_idx_timeout_6390: API to get flow index timeout * hal_rx_msdu_flow_idx_timeout_6390() - API to get flow index timeout
* from rx_msdu_end TLV * 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: flow index timeout value from MSDU END TLV * Return: flow index timeout value from MSDU END TLV
@@ -904,8 +901,8 @@ static bool hal_rx_msdu_flow_idx_timeout_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_fse_metadata_get_6390: API to get FSE metadata * hal_rx_msdu_fse_metadata_get_6390() - API to get FSE metadata
* from rx_msdu_end TLV * 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: fse metadata value from MSDU END TLV * Return: fse metadata value from MSDU END TLV
@@ -919,8 +916,8 @@ static uint32_t hal_rx_msdu_fse_metadata_get_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_cce_metadata_get_6390: API to get CCE metadata * hal_rx_msdu_cce_metadata_get_6390() - API to get CCE metadata
* from rx_msdu_end TLV * 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: cce metadata * Return: cce metadata
@@ -935,8 +932,9 @@ hal_rx_msdu_cce_metadata_get_6390(uint8_t *buf)
} }
/** /**
* hal_rx_msdu_get_flow_params_6390: API to get flow index, flow index invalid * hal_rx_msdu_get_flow_params_6390() - API to get flow index, flow index
* and flow index timeout from rx_msdu_end TLV * invalid and flow index timeout 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
* @flow_invalid: pointer to return value of flow_idx_valid * @flow_invalid: pointer to return value of flow_idx_valid
* @flow_timeout: pointer to return value of flow_idx_timeout * @flow_timeout: pointer to return value of flow_idx_timeout
@@ -971,10 +969,10 @@ hal_rx_tlv_get_tcp_chksum_6390(uint8_t *buf)
} }
/** /**
* hal_rx_get_rx_sequence_6390(): Function to retrieve rx sequence number * hal_rx_get_rx_sequence_6390() - Function to retrieve rx sequence number
* @buf: Network buffer
* *
* @nbuf: Network buffer * Return: rx sequence number
* Returns: rx sequence number
*/ */
static static
uint16_t hal_rx_get_rx_sequence_6390(uint8_t *buf) uint16_t hal_rx_get_rx_sequence_6390(uint8_t *buf)
@@ -986,10 +984,9 @@ uint16_t hal_rx_get_rx_sequence_6390(uint8_t *buf)
} }
/** /**
* hal_rx_mpdu_start_tlv_tag_valid_6390 () - API to check if RX_MPDU_START * hal_rx_mpdu_start_tlv_tag_valid_6390() - API to check if RX_MPDU_START
* tlv tag is valid * tlv tag is valid
* * @rx_tlv_hdr: start address of rx_pkt_tlvs
*@rx_tlv_hdr: start address of rx_pkt_tlvs
* *
* Return: true if RX_MPDU_START is valid, else false. * Return: true if RX_MPDU_START is valid, else false.
*/ */
@@ -1004,7 +1001,7 @@ static uint8_t hal_rx_mpdu_start_tlv_tag_valid_6390(void *rx_tlv_hdr)
} }
/** /**
* hal_get_window_address_6390(): Function to get hp/tp address * hal_get_window_address_6390() - Function to get hp/tp address
* @hal_soc: Pointer to hal_soc * @hal_soc: Pointer to hal_soc
* @addr: address offset of register * @addr: address offset of register
* *
@@ -1017,7 +1014,7 @@ static inline qdf_iomem_t hal_get_window_address_6390(struct hal_soc *hal_soc,
} }
/** /**
* hal_reo_set_err_dst_remap_6390(): Function to set REO error destination * hal_reo_set_err_dst_remap_6390() - Function to set REO error destination
* ring remap register * ring remap register
* @hal_soc: Pointer to hal_soc * @hal_soc: Pointer to hal_soc
* *
@@ -1115,14 +1112,14 @@ void hal_compute_reo_remap_ix0_6390(uint32_t *remap0)
#ifdef WLAN_FEATURE_MARK_FIRST_WAKEUP_PACKET #ifdef WLAN_FEATURE_MARK_FIRST_WAKEUP_PACKET
/** /**
* hal_get_first_wow_wakeup_packet_6390(): Function to get if the buffer * hal_get_first_wow_wakeup_packet_6390() - Function to get if the buffer is
* is the first one that wakes up host from WoW. * the first one that wakes up host
* * from WoW.
* @buf: network buffer * @buf: network buffer
* *
* Dummy function for QCA6390 * Dummy function for QCA6390
* *
* 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 * WoW. Otherwise 0
*/ */
static inline uint8_t hal_get_first_wow_wakeup_packet_6390(uint8_t *buf) static inline uint8_t hal_get_first_wow_wakeup_packet_6390(uint8_t *buf)
@@ -1742,6 +1739,7 @@ struct hal_hw_srng_config hw_srng_table_6390[] = {
/** /**
* hal_qca6390_attach() - Attach 6390 target specific hal_soc ops, * hal_qca6390_attach() - Attach 6390 target specific hal_soc ops,
* offset and srng table * offset and srng table
* @hal_soc: HAL SoC context
*/ */
void hal_qca6390_attach(struct hal_soc *hal_soc) void hal_qca6390_attach(struct hal_soc *hal_soc)
{ {

View File

@@ -1,5 +1,6 @@
/* /*
* Copyright (c) 2016-2021 The Linux Foundation. All rights reserved. * 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 * Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the * any purpose with or without fee is hereby granted, provided that the
@@ -380,9 +381,8 @@ hal_rx_msdu_start_nss_get_6390(uint8_t *buf)
/** /**
* hal_rx_mon_hw_desc_get_mpdu_status_6390(): Retrieve MPDU status * hal_rx_mon_hw_desc_get_mpdu_status_6390(): Retrieve MPDU status
* * @hw_desc_addr: Start address of Rx HW TLVs
* @ hw_desc_addr: Start address of Rx HW TLVs * @rs: Status for monitor mode
* @ rs: Status for monitor mode
* *
* Return: void * Return: void
*/ */
@@ -437,7 +437,7 @@ static uint8_t hal_rx_get_tlv_6390(void *rx_tlv)
* hal_rx_proc_phyrx_other_receive_info_tlv_6390() * hal_rx_proc_phyrx_other_receive_info_tlv_6390()
* - process other receive info TLV * - process other receive info TLV
* @rx_tlv_hdr: pointer to TLV header * @rx_tlv_hdr: pointer to TLV header
* @ppdu_info: pointer to ppdu_info * @ppdu_info_handle: pointer to ppdu_info
* *
* Return: None * Return: None
*/ */
@@ -472,10 +472,10 @@ void hal_rx_proc_phyrx_other_receive_info_tlv_6390(void *rx_tlv_hdr,
} }
/** /**
* hal_rx_dump_msdu_start_tlv_6390() : dump RX msdu_start TLV in structured * hal_rx_dump_msdu_start_tlv_6390() - dump RX msdu_start TLV in structured
* human readable format. * human readable format.
* @ msdu_start: pointer the msdu_start TLV in pkt. * @msdustart: pointer the msdu_start TLV in pkt.
* @ dbg_level: log level. * @dbg_level: log level.
* *
* Return: void * Return: void
*/ */
@@ -549,10 +549,10 @@ static void hal_rx_dump_msdu_start_tlv_6390(void *msdustart, uint8_t dbg_level)
} }
/** /**
* hal_rx_dump_msdu_end_tlv_6390: dump RX msdu_end TLV in structured * hal_rx_dump_msdu_end_tlv_6390() - dump RX msdu_end TLV in structured
* human readable format. * human readable format.
* @ msdu_end: pointer the msdu_end TLV in pkt. * @msduend: pointer the msdu_end TLV in pkt.
* @ dbg_level: log level. * @dbg_level: log level.
* *
* Return: void * Return: void
*/ */

View File

@@ -1,6 +1,6 @@
/* /*
* Copyright (c) 2016-2020 The Linux Foundation. All rights reserved. * 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 * Permission to use, copy, modify, and/or distribute this software for
* any purpose with or without fee is hereby granted, provided that the * any purpose with or without fee is hereby granted, provided that the
@@ -115,9 +115,9 @@ static void hal_tx_set_dscp_tid_map_6390(struct hal_soc *soc, uint8_t *map,
/** /**
* hal_tx_update_dscp_tid_6390() - Update the dscp tid map table as updated * hal_tx_update_dscp_tid_6390() - Update the dscp tid map table as updated
* by the user * by the user
* @soc: HAL SoC context * @soc: HAL SoC context
* @map: DSCP-TID mapping table * @tid: TID mapping table
* @id : MAP ID * @id : MAP ID
* @dscp: DSCP_TID map index * @dscp: DSCP_TID map index
* *
@@ -146,7 +146,7 @@ static void hal_tx_update_dscp_tid_6390(struct hal_soc *soc, uint8_t tid,
} }
/** /**
* hal_tx_desc_set_lmac_id - Set the lmac_id value * hal_tx_desc_set_lmac_id_6390() - Set the lmac_id value
* @desc: Handle to Tx Descriptor * @desc: Handle to Tx Descriptor
* @lmac_id: mac Id to ast matching * @lmac_id: mac Id to ast matching
* b00 mac 0 * b00 mac 0
@@ -165,7 +165,7 @@ static void hal_tx_desc_set_lmac_id_6390(void *desc, uint8_t lmac_id)
/** /**
* hal_tx_init_cmd_credit_ring_6390() - Initialize command/credit SRNG * hal_tx_init_cmd_credit_ring_6390() - Initialize command/credit SRNG
* @hal_soc_hdl: Handle to HAL SoC structure * @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 * Return: none
*/ */