Browse Source

qcacmn: Fix wlan_utility.h documentation

The kernel-doc script identified some documentation issues in the
umac/cmn_services/utils folder, all in wlan_utility.h, so fix them.

Change-Id: I91763c8103083b75dd26aa21b254f45de793b8b6
CRs-Fixed: 3390582
Jeff Johnson 2 năm trước cách đây
mục cha
commit
08131fd0bb
1 tập tin đã thay đổi với 53 bổ sung52 xóa
  1. 53 52
      umac/cmn_services/utils/inc/wlan_utility.h

+ 53 - 52
umac/cmn_services/utils/inc/wlan_utility.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2017-2021 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 any
  * purpose with or without fee is hereby granted, provided that the above
@@ -44,7 +44,7 @@ struct wlan_vdev_ch_check_filter {
 };
 
 /**
- * struct wlan_peer_count- vdev connected peer count
+ * struct wlan_op_mode_peer_count - vdev connected peer count
  * @opmode: QDF mode
  * @peer_count: peer count
  **/
@@ -302,8 +302,8 @@ wlan_get_subelem_fragseq_requirements(uint8_t subelemid,
  * is carried out inline within the source buffer and no memmoves/memcopy would
  * be required for the lead subelement.
  * @subelemid: Subelement ID
- * @subelemid: Fragment ID to be used for the subelement (this can potentially
- * vary across protocol areas)
+ * @subelemfragid: Fragment ID to be used for the subelement (this can
+ * potentially vary across protocol areas)
  * @payloadbuff: Buffer containing the subelement payload to be fragmented. If
  * inline fragmentation is selected, the corresponding subelement fragment
  * sequence will be generated inline into this buffer, and prior to the payload
@@ -490,8 +490,8 @@ QDF_STATUS wlan_defrag_elem_fragseq(bool inline_defrag,
  * wlan_get_subelem_fragseq_info() - Get information about subelement fragment
  * sequence
  *
- * @subelemid: Fragment ID applicable for the subelement (this can potentially
- * vary across protocol areas)
+ * @subelemfragid: Fragment ID applicable for the subelement (this can
+ * potentially vary across protocol areas)
  * @subelembuff: Buffer containing a series of subelements to be checked for
  * whether a contiguous subset of these subelements (starting with the first
  * subelement in the buffer) form a subelement fragment sequence. The containing
@@ -559,8 +559,8 @@ QDF_STATUS wlan_get_subelem_fragseq_info(uint8_t subelemfragid,
  * @inline_defrag: Whether to use inline defragmentation, wherein the
  * defragmentation is carried out inline within the source buffer and no
  * memmoves/memcopy would be required for the lead subelement.
- * @subelemid: Fragment ID applicable for the subelement (this can potentially
- * vary across protocol areas)
+ * @subelemfragid: Fragment ID applicable for the subelement (this can
+ * potentially vary across protocol areas)
  * @fragbuff: Source buffer containing the subelement fragment sequence starting
  * with the subelement ID of the lead subelement. The containing element is
  * required to have already been defragmented (if applicable). If inline
@@ -627,7 +627,7 @@ QDF_STATUS wlan_defrag_subelem_fragseq(bool inline_defrag,
 
 /**
  * wlan_is_emulation_platform() - check if platform is emulation based
- * @phy_version - psoc nif phy_version
+ * @phy_version: psoc nif phy_version
  *
  * Return: boolean value based on platform type
  */
@@ -672,7 +672,7 @@ QDF_STATUS wlan_vdev_is_up(struct wlan_objmgr_vdev *vdev);
  *                                        with other vdevs in pdev
  * @pdev: pdev object
  * @vdev: vdev object
- * @ref_id: object manager ref id
+ * @dbg_id: object manager ref id
  *
  * This function checks the vdev desired channel with other vdev channels
  *
@@ -720,7 +720,7 @@ bool wlan_util_map_is_any_index_set(unsigned long *map, unsigned long nbytes);
  *                                         pending flag
  * @pdev: pdev object
  * @vdev_id_map: bitmap to derive channel change vdevs
- * @ref_id: object manager ref id
+ * @dbg_id: object manager ref id
  *
  * This function test/set channel change pending flag
  *
@@ -736,7 +736,7 @@ QDF_STATUS wlan_pdev_chan_change_pending_vdevs(struct wlan_objmgr_pdev *pdev,
  *                                              change pending flag
  * @pdev: pdev object
  * @vdev_id_map: bitmap to derive channel change vdevs
- * @ref_id: object manager ref id
+ * @dbg_id: object manager ref id
  *
  * This function test/set channel change pending flag
  *
@@ -753,7 +753,7 @@ QDF_STATUS wlan_pdev_chan_change_pending_vdevs_down(
  *                                            change pending flag for AP VDEVs
  * @pdev: pdev object
  * @vdev_id_map: bitmap to derive channel change AP vdevs
- * @ref_id: object manager ref id
+ * @dbg_id: object manager ref id
  *
  * This function test/set channel change pending flag for AP vdevs
  *
@@ -903,45 +903,46 @@ uint16_t wlan_util_get_peer_count_for_mode(struct wlan_objmgr_pdev *pdev,
 					   enum QDF_OPMODE mode);
 
 /**
- * wlan_minidump_host_data - Data structure type logged in Minidump
- * @WLAN_MD_CP_EXT_PDEV - ol_ath_softc_net80211
- * @WLAN_MD_CP_EXT_PSOC - ol_ath_soc_softc
- * @WLAN_MD_CP_EXT_VDEV - ieee80211vap
- * @WLAN_MD_CP_EXT_PEER - ieee80211_node
- * @WLAN_MD_DP_SOC - dp_soc
- * @WLAN_MD_DP_PDEV - dp_pdev
- * @WLAN_MD_DP_VDEV - dp_vdev
- * @WLAN_MD_DP_PEER - dp_peer
- * @WLAN_MD_DP_SRNG_REO_DEST - dp_srng type for reo dest
- * @WLAN_MD_DP_SRNG_REO_EXCEPTION - dp_srng type for reo exception
- * @WLAN_MD_DP_SRNG_REO_CMD - dp_srng type for reo cmd
- * @WLAN_MD_DP_SRNG_RX_REL - dp_srng type for reo release
- * @WLAN_MD_DP_SRNG_REO_REINJECT - dp_srng type for reo reinject
- * @WLAN_MD_DP_SRNG_REO_STATUS - dp_srng type for reo status
- * @WLAN_MD_DP_SRNG_TCL_DATA - dp_srng type for tcl data
- * @WLAN_MD_DP_SRNG_TCL_STATUS - dp_srng type for tcl status
- * @WLAN_MD_DP_SRNG_TX_COMP - dp_srng type for tcl comp
- * @WLAN_MD_DP_SRNG_WBM_DESC_REL - dp_srng_type for wbm desc rel
- * @WLAN_MD_DP_SRNG_WBM_IDLE_LINK - dp_srng type for wbm idle link
- * @WLAN_MD_DP_LINK_DESC_BANK - Wbm link_desc_bank
- * @WLAN_MD_DP_SRNG_RXDMA_MON_STATUS - dp_srng type for rxdma mon status
- * @WLAN_MD_DP_SRNG_RXDMA_MON_BUF - dp_srng type for rxdma mon buf
- * @WLAN_MD_DP_SRNG_RXDMA_MON_DST - dp_srng type for rxdma mon dest
- * @WLAN_MD_DP_SRNG_RXDMA_MON_DESC - dp_srng type for rxdma mon desc
- * @WLAN_MD_DP_SRNG_RXDMA_ERR_DST - dp_srng type for rxdma err dst
- * @WLAN_MD_DP_HAL_SOC - hal_soc
- * @WLAN_MD_OBJMGR_PSOC - wlan_objmgr_psoc
- * @WLAN_MD_OBJMGR_PSOC_TGT_INFO - wlan_objmgr_tgt_psoc_info
- * @WLAN_MD_OBJMGR_PDEV - wlan_objmgr_pdev
- * @WLAN_MD_OBJMGR_PDEV_MLME - pdev_mlme
- * @WLAN_MD_OBJMGR_VDEV - wlan_objmgr_vdev
- * @WLAN_MD_OBJMGR_VDEV_MLME -vdev mlme
- * @WLAN_MD_OBJMGR_VDEV_SM - wlan_sm
- * @WLAN_MD_DP_SRNG_REO2PPE- dp_srng type PPE rx ring
- * @WLAN_MD_DP_SRNG_PPE2TCL - dp_srng type for PPE tx ring
- * @WLAN_MD_DP_SRNG_PPE_RELEASE - dp_srng type for PPE tx com ring
- * @WLAN_MD_DP_SRNG_PPE_WBM2SW_RELEASE - dp_srng type for PPE2TCL tx com ring
- * @WLAN_MD_MAX - Max value
+ * enum wlan_minidump_host_data - Data structure type logged in Minidump
+ * @WLAN_MD_CP_EXT_PDEV: ol_ath_softc_net80211
+ * @WLAN_MD_CP_EXT_PSOC: ol_ath_soc_softc
+ * @WLAN_MD_CP_EXT_VDEV: ieee80211vap
+ * @WLAN_MD_CP_EXT_PEER: ieee80211_node
+ * @WLAN_MD_DP_SOC: dp_soc
+ * @WLAN_MD_DP_PDEV: dp_pdev
+ * @WLAN_MD_DP_VDEV: dp_vdev
+ * @WLAN_MD_DP_PEER: dp_peer
+ * @WLAN_MD_DP_SRNG_REO_DEST: dp_srng type for reo dest
+ * @WLAN_MD_DP_SRNG_REO_EXCEPTION: dp_srng type for reo exception
+ * @WLAN_MD_DP_SRNG_REO_CMD: dp_srng type for reo cmd
+ * @WLAN_MD_DP_SRNG_RX_REL: dp_srng type for reo release
+ * @WLAN_MD_DP_SRNG_REO_REINJECT: dp_srng type for reo reinject
+ * @WLAN_MD_DP_SRNG_REO_STATUS: dp_srng type for reo status
+ * @WLAN_MD_DP_SRNG_TCL_DATA: dp_srng type for tcl data
+ * @WLAN_MD_DP_SRNG_TCL_CMD: dp_srng type for tcl cmd
+ * @WLAN_MD_DP_SRNG_TCL_STATUS: dp_srng type for tcl status
+ * @WLAN_MD_DP_SRNG_TX_COMP: dp_srng type for tcl comp
+ * @WLAN_MD_DP_SRNG_WBM_DESC_REL: dp_srng_type for wbm desc rel
+ * @WLAN_MD_DP_SRNG_WBM_IDLE_LINK: dp_srng type for wbm idle link
+ * @WLAN_MD_DP_LINK_DESC_BANK: Wbm link_desc_bank
+ * @WLAN_MD_DP_SRNG_RXDMA_MON_STATUS: dp_srng type for rxdma mon status
+ * @WLAN_MD_DP_SRNG_RXDMA_MON_BUF: dp_srng type for rxdma mon buf
+ * @WLAN_MD_DP_SRNG_RXDMA_MON_DST: dp_srng type for rxdma mon dest
+ * @WLAN_MD_DP_SRNG_RXDMA_MON_DESC: dp_srng type for rxdma mon desc
+ * @WLAN_MD_DP_SRNG_RXDMA_ERR_DST: dp_srng type for rxdma err dst
+ * @WLAN_MD_DP_HAL_SOC: hal_soc
+ * @WLAN_MD_OBJMGR_PSOC: wlan_objmgr_psoc
+ * @WLAN_MD_OBJMGR_PSOC_TGT_INFO: wlan_objmgr_tgt_psoc_info
+ * @WLAN_MD_OBJMGR_PDEV: wlan_objmgr_pdev
+ * @WLAN_MD_OBJMGR_PDEV_MLME: pdev_mlme
+ * @WLAN_MD_OBJMGR_VDEV: wlan_objmgr_vdev
+ * @WLAN_MD_OBJMGR_VDEV_MLME: vdev mlme
+ * @WLAN_MD_OBJMGR_VDEV_SM: wlan_sm
+ * @WLAN_MD_DP_SRNG_REO2PPE: dp_srng type PPE rx ring
+ * @WLAN_MD_DP_SRNG_PPE2TCL: dp_srng type for PPE tx ring
+ * @WLAN_MD_DP_SRNG_PPE_RELEASE: dp_srng type for PPE tx com ring
+ * @WLAN_MD_DP_SRNG_PPE_WBM2SW_RELEASE: dp_srng type for PPE2TCL tx com ring
+ * @WLAN_MD_MAX: Max value
  */
 enum wlan_minidump_host_data {
 	WLAN_MD_CP_EXT_PDEV,