qcacmn: Fix dp/wifi3.0/be documentation
The kernel-doc script identified a large number of documentation issues in dp/wifi3.0/be, so fix those issues. In addition, there are a number of instances where public functions have their implementation documented instead of having their interface documented, so move that documentation. Change-Id: I15c8570aa1832ed053fa38f536fa36b2ca0aa56b CRs-Fixed: 3373157
Este commit está contenido en:

cometido por
Madan Koyyalamudi

padre
fad8228802
commit
afe5a28707
@@ -29,7 +29,9 @@
|
||||
#define DP_MLO_MAX_DEST_CHIP_ID 3
|
||||
|
||||
/*
|
||||
* dp_mlo_ctxt
|
||||
* NB: intentionally not using kernel-doc comment because the kernel-doc
|
||||
* script does not handle the TAILQ_HEAD macro
|
||||
* struct dp_mlo_ctxt - datapath MLO context
|
||||
*
|
||||
* @ctrl_ctxt: opaque handle of cp mlo mgr
|
||||
* @ml_soc_list: list of socs which are mlo enabled. This also maintains
|
||||
@@ -39,6 +41,8 @@
|
||||
* @mld_peer_hash: peer hash table for ML peers
|
||||
* Associated peer with this MAC address)
|
||||
* @mld_peer_hash_lock: lock to protect mld_peer_hash
|
||||
* @toeplitz_hash_ipv4:
|
||||
* @toeplitz_hash_ipv6:
|
||||
* @link_to_pdev_map: link to pdev mapping
|
||||
* @rx_fst: pointer to rx_fst handle
|
||||
* @rx_fst_ref_cnt: ref count of rx_fst
|
||||
@@ -77,9 +81,8 @@ struct cdp_mlo_ctxt *dp_mlo_ctx_to_cdp(struct dp_mlo_ctxt *mlo_ctxt)
|
||||
}
|
||||
|
||||
/**
|
||||
* cdp_mlo_ctx_to_dp() - typecast cdp_soc_t to
|
||||
* dp soc handle
|
||||
* @psoc: CDP psoc handle
|
||||
* cdp_mlo_ctx_to_dp() - typecast CDP MLO context to DP MLO context
|
||||
* @mlo_ctxt: CDP MLO context
|
||||
*
|
||||
* Return: struct dp_soc pointer
|
||||
*/
|
||||
@@ -108,6 +111,17 @@ void dp_soc_mlo_fill_params(struct dp_soc *soc,
|
||||
*/
|
||||
void dp_pdev_mlo_fill_params(struct dp_pdev *pdev,
|
||||
struct cdp_pdev_attach_params *params);
|
||||
|
||||
/**
|
||||
* dp_mlo_get_soc_ref_by_chip_id() - Get DP soc from DP ML context.
|
||||
* @ml_ctxt: DP ML context handle
|
||||
* @chip_id: MLO chip id
|
||||
*
|
||||
* This API will increment a reference count for DP soc. Caller has
|
||||
* to take care for decrementing refcount.
|
||||
*
|
||||
* Return: dp_soc
|
||||
*/
|
||||
struct dp_soc*
|
||||
dp_mlo_get_soc_ref_by_chip_id(struct dp_mlo_ctxt *ml_ctxt, uint8_t chip_id);
|
||||
|
||||
@@ -152,7 +166,7 @@ struct dp_rx_fst *dp_mlo_get_rx_fst(struct dp_soc *soc);
|
||||
void dp_mlo_set_rx_fst(struct dp_soc *soc, struct dp_rx_fst *fst);
|
||||
|
||||
/**
|
||||
* dp_mlo_update_link_to_pdev_map : map link-id to pdev mapping
|
||||
* dp_mlo_update_link_to_pdev_map() - map link-id to pdev mapping
|
||||
* @soc: DP SOC
|
||||
* @pdev: DP PDEV
|
||||
*
|
||||
@@ -161,7 +175,7 @@ void dp_mlo_set_rx_fst(struct dp_soc *soc, struct dp_rx_fst *fst);
|
||||
void dp_mlo_update_link_to_pdev_map(struct dp_soc *soc, struct dp_pdev *pdev);
|
||||
|
||||
/**
|
||||
* dp_mlo_update_link_to_pdev_unmap : unmap link-id to pdev mapping
|
||||
* dp_mlo_update_link_to_pdev_unmap() - unmap link-id to pdev mapping
|
||||
* @soc: DP SOC
|
||||
* @pdev: DP PDEV
|
||||
*
|
||||
|
Referencia en una nueva incidencia
Block a user