qcacmn: Fix dp wifi3.0 documentation
The kernel-doc script identified a large number of kernel-doc issues in the dp/wifi3.0 folder. A series of patches have addressed most of the issues, so now fix the remaining issues. Just like in the previous patches, there are a number of instances where public functions have their implementation documented instead of having their interface documented, so make sure that the interfaces are documented. Change-Id: I4bc39b0e1a9d8c264b72ec6db76ff7e92d24f277 CRs-Fixed: 3373822
此提交包含在：
Jeff Johnson
@@ -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
|
||||
@@ -28,14 +28,6 @@ A_COMPILE_TIME_ASSERT(cookie_size_check,
|
||||
sizeof(union dp_rx_desc_list_elem_t))
|
||||
<= (1 << DP_RX_DESC_PAGE_ID_SHIFT));
|
||||
|
||||
/*
|
||||
* dp_rx_desc_pool_is_allocated() - check if memory is allocated for the
|
||||
* rx descriptor pool
|
||||
*
|
||||
* @rx_desc_pool: rx descriptor pool pointer
|
||||
* Return: QDF_STATUS QDF_STATUS_SUCCESS
|
||||
* QDF_STATUS_E_NOMEM
|
||||
*/
|
||||
QDF_STATUS dp_rx_desc_pool_is_allocated(struct rx_desc_pool *rx_desc_pool)
|
||||
{
|
||||
if (!rx_desc_pool->desc_pages.num_pages) {
|
||||
@@ -48,18 +40,6 @@ QDF_STATUS dp_rx_desc_pool_is_allocated(struct rx_desc_pool *rx_desc_pool)
|
||||
|
||||
qdf_export_symbol(dp_rx_desc_pool_is_allocated);
|
||||
|
||||
/*
|
||||
* dp_rx_desc_pool_alloc() - Allocate a memory pool for software rx
|
||||
* descriptors
|
||||
*
|
||||
* @soc: core txrx main context
|
||||
* @num_elem: number of rx descriptors (size of the pool)
|
||||
* @rx_desc_pool: rx descriptor pool pointer
|
||||
*
|
||||
* Return: QDF_STATUS QDF_STATUS_SUCCESS
|
||||
* QDF_STATUS_E_NOMEM
|
||||
* QDF_STATUS_E_FAULT
|
||||
*/
|
||||
QDF_STATUS dp_rx_desc_pool_alloc(struct dp_soc *soc,
|
||||
uint32_t num_elem,
|
||||
struct rx_desc_pool *rx_desc_pool)
|
||||
@@ -130,17 +110,6 @@ QDF_STATUS dp_rx_desc_pool_init_generic(struct dp_soc *soc,
|
||||
return QDF_STATUS_SUCCESS;
|
||||
}
|
||||
|
||||
/*
|
||||
* dp_rx_desc_pool_init() - Initialize the software RX descriptor pool
|
||||
* convert the pool of memory into a list of
|
||||
* rx descriptors and create locks to access this
|
||||
* list of rx descriptors.
|
||||
*
|
||||
* @soc: core txrx main context
|
||||
* @pool_id: pool_id which is one of 3 mac_ids
|
||||
* @pool_size: size of the rx descriptor pool
|
||||
* @rx_desc_pool: rx descriptor pool pointer
|
||||
*/
|
||||
void dp_rx_desc_pool_init(struct dp_soc *soc, uint32_t pool_id,
|
||||
uint32_t pool_size, struct rx_desc_pool *rx_desc_pool)
|
||||
{
|
||||
@@ -304,15 +273,6 @@ void dp_rx_desc_pool_deinit(struct dp_soc *soc,
|
||||
|
||||
qdf_export_symbol(dp_rx_desc_pool_deinit);
|
||||
#else
|
||||
/*
|
||||
* dp_rx_desc_pool_is_allocated() - check if memory is allocated for the
|
||||
* rx descriptor pool
|
||||
*
|
||||
* @rx_desc_pool: rx descriptor pool pointer
|
||||
*
|
||||
* Return: QDF_STATUS QDF_STATUS_SUCCESS
|
||||
* QDF_STATUS_E_NOMEM
|
||||
*/
|
||||
QDF_STATUS dp_rx_desc_pool_is_allocated(struct rx_desc_pool *rx_desc_pool)
|
||||
{
|
||||
if (!rx_desc_pool->array) {
|
||||
@@ -324,18 +284,6 @@ QDF_STATUS dp_rx_desc_pool_is_allocated(struct rx_desc_pool *rx_desc_pool)
|
||||
|
||||
qdf_export_symbol(dp_rx_desc_pool_is_allocated);
|
||||
|
||||
/*
|
||||
* dp_rx_desc_pool_alloc() - Allocate a memory pool for software rx
|
||||
* descriptors
|
||||
*
|
||||
* @soc: core txrx main context
|
||||
* @num_elem: number of rx descriptors (size of the pool)
|
||||
* @rx_desc_pool: rx descriptor pool pointer
|
||||
*
|
||||
* Return: QDF_STATUS QDF_STATUS_SUCCESS
|
||||
* QDF_STATUS_E_NOMEM
|
||||
* QDF_STATUS_E_FAULT
|
||||
*/
|
||||
QDF_STATUS dp_rx_desc_pool_alloc(struct dp_soc *soc,
|
||||
uint32_t pool_size,
|
||||
struct rx_desc_pool *rx_desc_pool)
|
||||
@@ -372,17 +320,6 @@ QDF_STATUS dp_rx_desc_pool_init_generic(struct dp_soc *soc,
|
||||
return QDF_STATUS_SUCCESS;
|
||||
}
|
||||
|
||||
/*
|
||||
* dp_rx_desc_pool_init() - Initialize the software RX descriptor pool
|
||||
* convert the pool of memory into a list of
|
||||
* rx descriptors and create locks to access this
|
||||
* list of rx descriptors.
|
||||
*
|
||||
* @soc: core txrx main context
|
||||
* @pool_id: pool_id which is one of 3 mac_ids
|
||||
* @pool_size: size of the rx descriptor pool
|
||||
* @rx_desc_pool: rx descriptor pool pointer
|
||||
*/
|
||||
void dp_rx_desc_pool_init(struct dp_soc *soc, uint32_t pool_id,
|
||||
uint32_t pool_size, struct rx_desc_pool *rx_desc_pool)
|
||||
{
|
||||
@@ -456,14 +393,6 @@ void dp_rx_desc_nbuf_free(struct dp_soc *soc,
|
||||
|
||||
qdf_export_symbol(dp_rx_desc_nbuf_free);
|
||||
|
||||
/**
|
||||
* dp_rx_desc_frag_free() - Free desc frag buffer
|
||||
*
|
||||
* @soc: core txrx main context
|
||||
* @rx_desc_pool: rx descriptor pool pointer
|
||||
*
|
||||
* Return: None
|
||||
*/
|
||||
#ifdef DP_RX_MON_MEM_FRAG
|
||||
void dp_rx_desc_frag_free(struct dp_soc *soc,
|
||||
struct rx_desc_pool *rx_desc_pool)
|
||||
@@ -511,7 +440,7 @@ void dp_rx_desc_pool_deinit(struct dp_soc *soc,
|
||||
rx_desc_pool->freelist = NULL;
|
||||
rx_desc_pool->pool_size = 0;
|
||||
|
||||
/* Deinitialize rx mon desr frag flag */
|
||||
/* Deinitialize rx mon dest frag flag */
|
||||
rx_desc_pool->rx_mon_dest_frag_enable = false;
|
||||
|
||||
soc->arch_ops.dp_rx_desc_pool_deinit(soc, rx_desc_pool, pool_id);
|
||||
@@ -530,19 +459,6 @@ void dp_rx_desc_pool_deinit_generic(struct dp_soc *soc,
|
||||
{
|
||||
}
|
||||
|
||||
/*
|
||||
* dp_rx_get_free_desc_list() - provide a list of descriptors from
|
||||
* the free rx desc pool.
|
||||
*
|
||||
* @soc: core txrx main context
|
||||
* @pool_id: pool_id which is one of 3 mac_ids
|
||||
* @rx_desc_pool: rx descriptor pool pointer
|
||||
* @num_descs: number of descs requested from freelist
|
||||
* @desc_list: attach the descs to this list (output parameter)
|
||||
* @tail: attach the point to last desc of free list (output parameter)
|
||||
*
|
||||
* Return: number of descs allocated from free list.
|
||||
*/
|
||||
uint16_t dp_rx_get_free_desc_list(struct dp_soc *soc, uint32_t pool_id,
|
||||
struct rx_desc_pool *rx_desc_pool,
|
||||
uint16_t num_descs,
|
||||
@@ -571,16 +487,6 @@ uint16_t dp_rx_get_free_desc_list(struct dp_soc *soc, uint32_t pool_id,
|
||||
|
||||
qdf_export_symbol(dp_rx_get_free_desc_list);
|
||||
|
||||
/*
|
||||
* dp_rx_add_desc_list_to_free_list() - append unused desc_list back to
|
||||
* freelist.
|
||||
*
|
||||
* @soc: core txrx main context
|
||||
* @local_desc_list: local desc list provided by the caller
|
||||
* @tail: attach the point to last desc of local desc list
|
||||
* @pool_id: pool_id which is one of 3 mac_ids
|
||||
* @rx_desc_pool: rx descriptor pool pointer
|
||||
*/
|
||||
void dp_rx_add_desc_list_to_free_list(struct dp_soc *soc,
|
||||
union dp_rx_desc_list_elem_t **local_desc_list,
|
||||
union dp_rx_desc_list_elem_t **tail,
|
||||
|
||||
新增問題並參考
封鎖使用者