qcacmn: Fix iot_sim documentation

The kernel-doc script identified some kernel-doc issues in the iot_sim
folder, so fix them.

Change-Id: Ia7d68ca807ec4f0aad48ee42f75df8fa2aeca7e1
CRs-Fixed: 3378028

iot_sim/core/iot_sim_cmn_api_i.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2020, 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 above
@@ -96,11 +97,12 @@ QDF_STATUS iot_sim_get_index_for_action_frm(uint8_t *frm, uint8_t *cat,
 					    uint8_t *act, bool rx);
 
 /**
- * iot_sim_find_peer_from_mac - function to find the iot sim peer data
- *                              based on the mac address provided
+ * iot_sim_find_peer_from_mac() - function to find the iot sim peer data
+ *                                based on the mac address provided
  *
  * @isc: iot_sim pdev private object
  * @mac: mac address of the peer
+ *
  * Return: iot_sim_rule_per_peer reference if exists else NULL
  */
 struct iot_sim_rule_per_peer *
@@ -111,6 +113,7 @@ iot_sim_find_peer_from_mac(struct iot_sim_context *isc,
  * iot_sim_frame_update() - Management frame update
  * @pdev: reference to global pdev object
  * @nbuf: frame buffer
+ * @param: beacon template parameters
  * @tx: TRUE in case of tx
  * @rx_param: mgmt_rx_event_params
  *
@@ -126,7 +129,7 @@ QDF_STATUS iot_sim_frame_update(struct wlan_objmgr_pdev *pdev,
 				bool tx,
 				struct mgmt_rx_event_params *rx_param);
 
-/*
+/**
  * iot_sim_get_ctx_from_pdev() - API to get iot_sim context object
  *                               from pdev
  * @pdev : Reference to psoc global object
@@ -150,9 +153,9 @@ iot_sim_get_ctx_from_pdev(struct wlan_objmgr_pdev *pdev)
 	return isc;
 }
 
-/*
- * iot_sim_delete_rule_for_mac - function to delete content change rule
- *                               for given peer mac
+/**
+ * iot_sim_delete_rule_for_mac() - function to delete content change rule
+ *                                 for given peer mac
  * @isc: iot sim context
  * @oper: iot sim operation
  * @seq: authentication sequence number, mostly 0 for non-authentication frame
@@ -170,11 +173,10 @@ iot_sim_delete_rule_for_mac(struct iot_sim_context *isc,
 			    uint8_t subtype,
 			    struct qdf_mac_addr *mac,
 			    bool action);
-/*
- * iot_sim_parse_user_input_content_change - function to parse user input into
- *					     predefined format for content
- *					     change operation. All arguments
- *					     passed will be filled upon success
+/**
+ * iot_sim_parse_user_input_content_change() - function to parse user input into
+ *					       predefined format for content
+ *					       change operation.
  * @isc: iot sim context
  * @userbuf: local copy of user input
  * @count: length of userbuf
@@ -185,6 +187,8 @@ iot_sim_delete_rule_for_mac(struct iot_sim_context *isc,
  * @content: double pointer to storage to store frame content after processing
  * @mac: pointer to mac address
  *
+ * All arguments passed will be filled upon success
+ *
  * Return: QDF_STATUS_SUCCESS on success
  *	   QDF_STATUS_E_FAILURE otherwise
  */

iot_sim/core/iot_sim_defs_i.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2020-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 above
@@ -101,24 +102,31 @@ enum iot_sim_action_cat_type {
 	IOT_SIM_MAX_CAT,
 };
 
-/*
+/**
  * struct iot_sim_debugfs - contains dentry pointer for opened
  *			    iot sim files and directory
- * @iot_sim_dir_de - dentry pointer to pdev specific folder
- * @iot_sim_file_de - dentry pointer representing operation specific files
+ * @iot_sim_dir_de: dentry pointer to pdev specific folder
+ * @iot_sim_file_de: dentry pointer representing operation specific files
  */
 struct iot_sim_debugfs {
 	struct dentry *iot_sim_dir_de;
 	struct dentry *iot_sim_file_de[IOT_SIM_DEBUGFS_FILE_NUM];
 };
 
-/*
+/**
  * struct iot_sim_rule - represent user configured rules
- * @len - Length of the content provided by user
- * @offset - offset at which modification done in capture frame
- * @frm_content - actual user data in hex
- * @drop - frame marked for drop
- * @delay_dur - duration of delay
+ * @len: Length of the content provided by user
+ * @offset: offset at which modification done in capture frame
+ * @frm_content: actual user data in hex
+ * @drop: frame marked for drop
+ * @delay_dur: duration of delay
+ * @rule_bitmap:
+ * @nbuf_list:
+ * @peer:
+ * @sec_buf:
+ * @dwork:
+ * @rx_param:
+ * @iot_sim_delay_lock:
  */
 struct iot_sim_rule {
 	uint16_t len;
@@ -135,12 +143,13 @@ struct iot_sim_rule {
 	qdf_spinlock_t iot_sim_delay_lock;
 };
 
-/*
+/**
  * struct iot_sim_rule_per_seq - rule structure per sequence iot sim files
  *				 and directory
  *
- * @rule_per_type - 2d array of iot_sim_rule per type subtype
- * @use_count - usage reference
+ * @rule_per_type: 2d array of iot_sim_rule per type subtype
+ * @rule_per_action_frm: 2d array of iot_sim_rule per category/action
+ * @use_count: usage reference
  */
 struct iot_sim_rule_per_seq {
 	struct iot_sim_rule *rule_per_type[N_FRAME_TYPE][N_FRAME_SUBTYPE];
@@ -148,13 +157,12 @@ struct iot_sim_rule_per_seq {
 	uint8_t use_count;
 };
 
-/*
+/**
  * struct iot_sim_rule_per_peer - peer specific structure for iot sim ops
  *
- * @addr - address of peer
- * @iot_sim_lock - spinlock
- * @rule_per_seq - array of iot_sim_rule_per_seq
- * @list - list variable
+ * @node: list node
+ * @addr: address of peer
+ * @rule_per_seq: array of iot_sim_rule_per_seq
  */
 struct iot_sim_rule_per_peer {
 	qdf_list_node_t node;
@@ -167,6 +175,11 @@ struct iot_sim_rule_per_peer {
  * @pdev_obj:Reference to pdev global object
  * @iot_sim_peer_list: peer list for peer specific rules
  * @bcast_peer: broadcast peer entry for storing rules for all peers
+ * @peer_list:
+ * @iot_sim_lock:
+ * @iot_sim_dbgfs_ctx:
+ * @iot_sim_update_beacon_trigger:
+ * @bcn_buf:
  */
 struct iot_sim_context {
 	struct wlan_objmgr_pdev *pdev_obj;
@@ -179,13 +192,12 @@ struct iot_sim_context {
 	qdf_nbuf_t bcn_buf;
 };
 
-/* enum iot_sim_operations - iot sim operations
- *
- * @INVALID_OPERATION - invalid operation
- * @CONTENT_CHANGE - Frame Content Change operation
- * @DROP - Frame drop operation
- * @DELAY - Frame delay operation
- * @IOT_SIM_MAX_OPERATION - iot sim max operation
+/**
+ * enum iot_sim_operations - iot sim operations
+ * @CONTENT_CHANGE: Frame Content Change operation
+ * @DROP: Frame drop operation
+ * @DELAY: Frame delay operation
+ * @IOT_SIM_MAX_OPERATION: iot sim max operation
  */
 enum iot_sim_operations {
 	CONTENT_CHANGE,
@@ -194,13 +206,13 @@ enum iot_sim_operations {
 	IOT_SIM_MAX_OPERATION
 };
 
-/* enum iot_sim_subcmd - iot sim FW related subcommands
- *
- * @ADD_RULE - Add Rule
- * @DEL_RULE - Delete Rule
- * @ADD_RULE_ACTION - Add rule for action frame
- * @DEL_RULE_ACTION - Del rule for action frame
- * @IOT_SIM_MAX_SUBCMD - iot sim max subcmd
+/**
+ * enum iot_sim_subcmd - iot sim FW related subcommands
+ * @ADD_RULE: Add Rule
+ * @DEL_RULE: Delete Rule
+ * @ADD_RULE_ACTION: Add rule for action frame
+ * @DEL_RULE_ACTION: Del rule for action frame
+ * @IOT_SIM_MAX_SUBCMD: iot sim max subcmd
  */
 enum iot_sim_subcmd {
 	ADD_RULE = 0,

iot_sim/dispatcher/inc/wlan_iot_sim_public_structs.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2020, 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 above
@@ -20,19 +21,20 @@
 #define _WLAN_IOT_SIM__PUBLIC_STRUCTS_H_
 
 /**
- * struct simulation_test_params
- * pdev_id: pdev id
- * vdev_id: vdev id
- * peer_macaddr: peer MAC address
- * test_cmd_type: test command type
- * test_subcmd_type: test command sub type
- * frame_type: frame type
- * frame_subtype: frame subtype
- * seq: sequence number
- * offset: Frame content offset
- * frame_length: Frame content length
- * buf_len: Buffer length
- * bufp: buffer
+ * struct simulation_test_params - IOT Similation test parameters
+ * @pdev_id: pdev id
+ * @vdev_id: vdev id
+ * @peer_mac: peer MAC address
+ * @test_cmd_type: test command type
+ * @test_subcmd_type: test command sub type
+ * @frame_type: frame type
+ * @frame_subtype: frame subtype
+ * @seq: sequence number
+ * @reserved: reserved for future use
+ * @offset: Frame content offset
+ * @frame_length: Frame content length
+ * @buf_len: Buffer length
+ * @bufp: buffer
  */
 struct simulation_test_params {
 	u32 pdev_id;

iot_sim/dispatcher/inc/wlan_iot_sim_utils_api.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2020, 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 above
@@ -28,7 +29,7 @@ struct wmi_iot_sim_cmd_ops;
 
 /**
  * struct iot_sim_cbacks - IOT Sim callbacks
- * @reg_beacon_trigger_handler: reg_beacon_trigger_handler
+ * @update_beacon_trigger: reg_beacon_trigger_handler
  */
 struct iot_sim_cbacks {
 	void (*update_beacon_trigger)(mlme_pdev_ext_t *);
@@ -36,10 +37,11 @@ struct iot_sim_cbacks {
 
 /**
  * iot_sim_cmd_handler() - IOT SIM frame handler function
- * @vdev - vdev object.
- * @buf - skb
- * @tx - TRUE in case of Tx
- * @rx_param - mgmt_rx_event_params
+ * @vdev: vdev object.
+ * @buf: skb
+ * @bcn_param:
+ * @tx: TRUE in case of Tx
+ * @param: mgmt_rx_event_params
  *
  * Return : QDF_STATUS_E_SUCCESS/QDF_STATUS_E_FAILURE.
  */
@@ -59,7 +61,7 @@ QDF_STATUS iot_sim_cmd_handler(struct wlan_objmgr_vdev *vdev, qdf_nbuf_t buf,
  */
 QDF_STATUS wlan_iot_sim_init(void);
 
-/*
+/**
  * wlan_iot_sim_deinit() - API to deinit iot_sim component
  *
  * This API is invoked from dispatcher deinit during all component deinit.
@@ -85,8 +87,8 @@ void wlan_lmac_if_iot_sim_register_rx_ops(struct wlan_lmac_if_rx_ops *rx_ops);
 /**
  * wlan_register_wmi_iot_sim_cmd_ops() - Register operations related to wmi
  * commands on iot_sim parameters
- * @pdev    - the physical device object
- * @cmd_ops - pointer to the structure holding the operations
+ * @pdev: the physical device object
+ * @cmd_ops: pointer to the structure holding the operations
  *	     related to wmi commands on iot_sim parameters
  *
  * API to register operations related to wmi commands on iot_sim parameters