qcacmn: Fix hal/wifi3.0/be documentation

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

Change-Id: I9730c36e4d36dbe0ae551067c5c500441f07569f
CRs-Fixed: 3400933
This commit is contained in:
Jeff Johnson
2023-02-08 17:24:55 -08:00
committed by Madan Koyyalamudi
parent 7453254a0c
commit f518df0727
8 changed files with 445 additions and 441 deletions

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
@@ -31,8 +31,8 @@ RX_MSDU_DETAILS_RX_MSDU_EXT_DESC_INFO_DETAILS_RESERVED_0A_OFFSET))
/**
* hal_reo_setup_generic_be - Initialize HW REO block
*
* @hal_soc: Opaque HAL SOC handle
* @reo_params: parameters needed by HAL for REO config
* @soc: Opaque HAL SOC handle
* @reoparams: parameters needed by HAL for REO config
* @qref_reset: reset qref
*/
void hal_reo_setup_generic_be(struct hal_soc *soc,
@@ -62,21 +62,37 @@ void hal_set_link_desc_addr_be(void *desc, uint32_t cookie,
uint8_t bm_id);
/**
* hal_hw_txrx_default_ops_attach_be(): Add default ops for BE chips
* @ hal_soc_hdl: hal_soc handle
* hal_hw_txrx_default_ops_attach_be() - Add default ops for BE chips
* @soc: hal_soc handle
*
* Return: None
*/
void hal_hw_txrx_default_ops_attach_be(struct hal_soc *soc);
uint32_t hal_tx_comp_get_buffer_source_generic_be(void *hal_desc);
/**
* hal_rx_ret_buf_manager_get_be() - Get return buffer manager from ring desc
* @ring_desc: ring descriptor
*
* Return: rbm
*/
uint8_t hal_rx_ret_buf_manager_get_be(hal_ring_desc_t ring_desc);
/**
* hal_rx_wbm_err_info_get_generic_be() - Retrieves WBM error code and reason and
* save it to hal_wbm_err_desc_info structure passed by caller
* @wbm_desc: wbm ring descriptor
* @wbm_er_info1: hal_wbm_err_desc_info structure, output parameter.
*
* Return: void
*/
void hal_rx_wbm_err_info_get_generic_be(void *wbm_desc, void *wbm_er_info1);
/**
* hal_reo_qdesc_setup - Setup HW REO queue descriptor
*
* @hal_soc: Opaque HAL SOC handle
* hal_reo_qdesc_setup_be() - Setup HW REO queue descriptor
* @hal_soc_hdl: Opaque HAL SOC handle
* @tid: TID
* @ba_window_size: BlockAck window size
* @start_seq: Starting sequence number
* @hw_qdesc_vaddr: Virtual address of REO queue descriptor memory
@@ -93,7 +109,7 @@ void hal_reo_qdesc_setup_be(hal_soc_handle_t hal_soc_hdl,
/**
* hal_cookie_conversion_reg_cfg_be() - set cookie conversion relevant register
* for REO/WBM
* @soc: HAL soc handle
* @hal_soc_hdl: Handle to HAL SoC structure
* @cc_cfg: structure pointer for HW cookie conversion configuration
*
* Return: None
@@ -102,13 +118,12 @@ void hal_cookie_conversion_reg_cfg_be(hal_soc_handle_t hal_soc_hdl,
struct hal_hw_cc_config *cc_cfg);
/**
* hal_reo_ix_remap_value_get() - Calculate reo remap register value from
* ring_id_mask which is used for hash based
* reo distribution
*
* @hal_soc: Handle to HAL SoC structure
* @ring_id_mask: mask value indicating the rx rings 0th bit set indicate
* REO2SW1 is included in hash distribution
* hal_reo_ix_remap_value_get_be() - Calculate reo remap register value from
* ring_id_mask which is used for hash based
* reo distribution
* @hal_soc_hdl: Handle to HAL SoC structure
* @rx_ring_mask: mask value indicating the rx rings 0th bit set indicate
* REO2SW1 is included in hash distribution
*
* Return: REO remap value
*/
@@ -118,8 +133,7 @@ hal_reo_ix_remap_value_get_be(hal_soc_handle_t hal_soc_hdl,
/**
* hal_reo_ring_remap_value_get_be() - return REO remap value
*
* @ring_id: REO2SW ring id
* @rx_ring_id: REO2SW ring mask
*
* Return: REO remap value
*/