浏览代码

qcacmn: Fix umac/cmn_services/mgmt_txrx documentation

The kernel-doc script identified some documentation errors in the
umac/cmn_services/mgmt_txrx folder, so fix them.

Change-Id: I2315940874f6ae246582c81deb7c90b687b3489e
CRs-Fixed: 3387340
Jeff Johnson 2 年之前
父节点
当前提交
de12add913

+ 4 - 3
umac/cmn_services/mgmt_txrx/core/src/wlan_mgmt_txrx_main_i.h

@@ -1,5 +1,6 @@
 /*
  * 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
  * any purpose with or without fee is hereby granted, provided that the
@@ -57,8 +58,8 @@
 #define IEEE80211_FCO_SUBTYPE_ACTION_NO_ACK 0xe0
 
 /**
- * mgmt_wakelock_reason - reasons mgmt_txrx might hold a wakelock
- * @MGMT_TXRX_WAKELOCK_REASON_TX_CMP - wait for mgmt_tx_complete event
+ * enum mgmt_txrx_wakelock_reason - reasons mgmt_txrx might hold a wakelock
+ * @MGMT_TXRX_WAKELOCK_REASON_TX_CMP: wait for mgmt_tx_complete event
  */
 enum mgmt_txrx_wakelock_reason {
 	MGMT_TXRX_WAKELOCK_REASON_TX_CMP
@@ -202,7 +203,7 @@ struct mgmt_txrx_priv_psoc_context {
 };
 
 /**
- * struct mgmt_txrx_priv_context_dev - mgmt txrx private context
+ * struct mgmt_txrx_priv_pdev_context - mgmt txrx private context
  * @pdev:     pdev context
  * @mgmt_desc_pool:   pointer to mgmt desc. pool
  * @mgmt_txrx_stats:  pointer to mgmt txrx stats

+ 7 - 5
umac/cmn_services/mgmt_txrx/core/src/wlan_mgmt_txrx_rx_reo.c

@@ -302,6 +302,8 @@ mgmt_rx_reo_handle_stale_frame(struct mgmt_rx_reo_list *reo_list,
 #else
 /**
  * mgmt_rx_reo_sim_is_valid_link() - Check whether the given HW link is valid
+ * @sim_context: Pointer to reo simulation context object
+ * @link_id: Link id to be checked
  *
  * Return: true if @link_id is a valid link, else false
  */
@@ -333,8 +335,8 @@ mgmt_rx_reo_sim_is_valid_link(struct mgmt_rx_reo_sim_context *sim_context,
 
 /**
  * mgmt_rx_reo_is_valid_link() - Check whether the given HW link is valid
+ * @ml_grp_id: MLO Group id on which the Link ID  belongs to
  * @link_id: HW Link ID to be verified
- * @grp_id: MLO Group id on which the Link ID  belongs to
  *
  * Return: true if @link_id is a valid link else false
  */
@@ -389,6 +391,7 @@ mgmt_rx_reo_sim_get_num_mlo_links(struct mgmt_rx_reo_sim_context *sim_context)
  * mgmt_rx_reo_get_num_mlo_links() - Get number of MLO links from the reo
  * context object
  * @reo_context: Pointer to reo context object
+ * @grp_id: MLO Group id which it belongs to
  *
  * Return: On success returns number of MLO HW links. On failure
  * returns WLAN_MLO_INVALID_NUM_LINKS.
@@ -1415,7 +1418,7 @@ print_wait_count:
 	return QDF_STATUS_SUCCESS;
 }
 
-/*
+/**
  * struct mgmt_rx_reo_list_entry_debug_info - This structure holds the necessary
  * information about a reo list entry for debug purposes.
  * @link_id: link id
@@ -1716,6 +1719,7 @@ mgmt_rx_reo_log_egress_frame_before_delivery(
  * delivery to upper layer.
  * @reo_ctx: management rx reorder context
  * @entry: Pointer to reorder list entry
+ * @link_id: multi-link link ID
  *
  * Return: QDF_STATUS of operation
  */
@@ -3535,7 +3539,6 @@ failure:
  * mgmt_rx_reo_sim_init() - Initialize management rx reorder simulation
  * context.
  * @reo_context: Pointer to reo context
- * @ml_grp_id: MLO group id which it belongs to
  *
  * Return: QDF_STATUS of operation
  */
@@ -4547,7 +4550,7 @@ mgmt_rx_reo_sim_mac_hw_thread(void *data)
 /**
  * mgmt_rx_reo_sim_init_master_frame_list() - Initializes the master
  * management frame list
- * @pending_frame_list: Pointer to master frame list
+ * @master_frame_list: Pointer to master frame list
  *
  * This API initializes the master management frame list
  *
@@ -4925,7 +4928,6 @@ mgmt_rx_reo_sim_stop(uint8_t ml_grp_id)
  * mgmt_rx_reo_sim_init() - Initialize management rx reorder simulation
  * context.
  * @reo_context: Pointer to reo context
- * @ml_grp_id: MLO Group ID which it belongs to
  *
  * Return: QDF_STATUS of operation
  */

+ 1 - 1
umac/cmn_services/mgmt_txrx/core/src/wlan_mgmt_txrx_rx_reo_i.h

@@ -218,7 +218,7 @@ struct mgmt_rx_reo_global_ts_info {
 };
 
 /**
- * struct mgmt_rx_reo_list  Linked list used to reorder the management frames
+ * struct mgmt_rx_reo_list - Linked list used to reorder the management frames
  * received. Each list entry would correspond to a management frame. List
  * entries would be sorted in the same order in which they are received by MAC
  * HW.

+ 2 - 1
umac/cmn_services/mgmt_txrx/dispatcher/inc/wlan_mgmt_txrx_rx_reo_tgt_api.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 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
@@ -104,6 +104,7 @@ tgt_mgmt_rx_reo_get_valid_hw_link_bitmap(struct wlan_objmgr_psoc *psoc,
  * @id: Snapshot ID
  * @value: Pointer to the snapshot value where the snapshot
  * should be written
+ * @raw_snapshot: Raw snapshot data
  *
  * Read management rx-reorder snapshots from target.
  *

+ 1 - 1
umac/cmn_services/mgmt_txrx/dispatcher/inc/wlan_mgmt_txrx_rx_reo_utils_api.h

@@ -329,7 +329,7 @@ wlan_mgmt_rx_reo_is_feature_enabled_at_psoc(struct wlan_objmgr_psoc *psoc);
 /**
  * wlan_mgmt_rx_reo_is_feature_enabled_at_pdev() - Check if MGMT Rx REO feature
  * is enabled on a given pdev
- * @psoc: pointer to pdev object
+ * @pdev: pointer to pdev object
  *
  * Return: true if the feature is enabled, else false
  */

+ 10 - 7
umac/cmn_services/mgmt_txrx/dispatcher/inc/wlan_mgmt_txrx_utils_api.h

@@ -911,6 +911,7 @@ struct mlo_bcast_t2lm_info {
  * @pn_params: Frame PN params
  * @ext_params: Extended params
  * @is_conn_ap: Frame is from connected ap
+ * @cu_params: MLO MGMT Critical Update params
  * @link_removal_info: MLO link removal information array
  * @num_link_removal_info: Number of elements in @link_removal_info
  * @t2lm_params: T2LM related info received from FW
@@ -1026,7 +1027,8 @@ free_mgmt_rx_event_params(struct mgmt_rx_event_params *rx_params)
 #endif
 
 /**
- * mgmt_tx_download_comp_cb - function pointer for tx download completions.
+ * typedef mgmt_tx_download_comp_cb() - function pointer for tx download
+ *                                      completions.
  * @context: caller component specific context
  * @buf: buffer
  * @free: to free/not free the buffer
@@ -1040,7 +1042,7 @@ typedef QDF_STATUS (*mgmt_tx_download_comp_cb)(void *context,
 					 qdf_nbuf_t buf, bool free);
 
 /**
- * mgmt_ota_comp_cb - function pointer for tx ota completions.
+ * typedef mgmt_ota_comp_cb() - function pointer for tx ota completions.
  * @context: caller component specific context
  * @buf: buffer
  * @status: tx completion status
@@ -1054,7 +1056,8 @@ typedef QDF_STATUS (*mgmt_ota_comp_cb)(void *context, qdf_nbuf_t buf,
 				 uint32_t status, void *tx_compl_params);
 
 /**
- * mgmt_frame_rx_callback - function pointer for receiving mgmt rx frames
+ * typedef mgmt_frame_rx_callback() - function pointer for receiving mgmt
+ *                                    rx frames
  * @psoc: psoc context
  * @peer: peer
  * @buf: buffer
@@ -1073,7 +1076,7 @@ typedef QDF_STATUS (*mgmt_frame_rx_callback)(
 			enum mgmt_frame_type frm_type);
 
 /**
- * mgmt_frame_fill_peer_cb - Function pointer to fill peer in the buf
+ * typedef mgmt_frame_fill_peer_cb() - Function pointer to fill peer in the buf
  * @peer: peer
  * @buf: buffer
  *
@@ -1122,8 +1125,8 @@ QDF_STATUS wlan_mgmt_txrx_deinit(void);
  * @peer: peer
  * @context: caller component specific context
  * @buf: buffer to be transmitted
- * @comp_cb: download completion cb function
- * @ota_cb: post processing cb function
+ * @tx_comp_cb: download completion cb function
+ * @tx_ota_comp_cb: post processing cb function
  * @comp_id: umac component id
  * @mgmt_tx_params: mgmt tx params
  *
@@ -1148,7 +1151,7 @@ bool wlan_mgmt_is_rmf_mgmt_action_frame(uint8_t action_category);
 
 /**
  * wlan_mgmt_txrx_beacon_frame_tx() - transmits mgmt. beacon
- * @psoc: psoc context
+ * @peer: peer context
  * @buf: buffer to be transmitted
  * @comp_id: umac component id
  *

+ 4 - 4
umac/cmn_services/mgmt_txrx/dispatcher/src/wlan_mgmt_txrx_tgt_api.c

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2016-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
@@ -473,7 +473,7 @@ mgmt_get_wnm_action_subtype(uint8_t action_code)
 }
 
 /**
- * mgmt_get_wnm_action_subtype() - gets tdls action subtype
+ * mgmt_get_tdls_action_subtype() - gets tdls action subtype
  * @action_code: action code
  *
  * This function returns the subtype for tdls action
@@ -1063,8 +1063,8 @@ static QDF_STATUS simulation_frame_update(struct wlan_objmgr_psoc *psoc,
 
 /**
  * wlan_mgmt_rx_beacon_rate_limit() - rate limiting mgmt beacons
- * @psoc - pointer to psoc struct
- * @mgmt_rx_params - rx params
+ * @psoc: pointer to psoc struct
+ * @mgmt_rx_params: rx params
  *
  * This function will drop the beacons if the number of beacons
  * received is greater than the percentage of limit of beacons to max