qcacld-3.0: hdd: Fix kernel documentation in files(1/n)

Fix kernel documentation in files for kernel-doc rules to resolve
kernel-doc script warnings.

CRs-Fixed: 3237683
Change-Id: I3ba8e8c559a105ca0bc55219b623c606d2acca56

core/hdd/inc/hdd_config.h

@@ -37,12 +37,12 @@
 
 /**
  * enum hdd_wext_control - knob for wireless extensions
- * @hdd_wext_disabled - interface is completely disabled. An access
+ * @hdd_wext_disabled: interface is completely disabled. An access
  *      control error log will be generated for each attempted use.
- * @hdd_wext_deprecated - interface is available but should not be
+ * @hdd_wext_deprecated: interface is available but should not be
  *      used. An access control warning log will be generated for each
  *      use.
- * @hdd_wext_enabled - interface is available without restriction. No
+ * @hdd_wext_enabled: interface is available without restriction. No
  *      access control logs will be generated.
  *
  * enum hdd_wext_control is used to enable coarse grained control on

core/hdd/inc/wlan_hdd_apf.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2012-2020 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 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
@@ -95,7 +96,7 @@ void hdd_apf_context_destroy(struct hdd_adapter *adapter);
 /**
  * hdd_get_apf_capabilities_cb() - Callback function to get APF capabilities
  * @hdd_context: pointer to the hdd context
- * @apf_get_offload: struct for get offload
+ * @data: pointer to the data received
  *
  * This function receives the response/data from the lower layer and
  * checks to see if the thread is still waiting then post the results to

core/hdd/inc/wlan_hdd_cfg.h

@@ -21,7 +21,6 @@
 #define HDD_CONFIG_H__
 
 /**
- *
  * DOC: wlan_hdd_config.h
  *
  * WLAN Adapter Configuration functions
@@ -210,7 +209,7 @@ struct hdd_config {
 /**
  * hdd_to_csr_wmm_mode() - Utility function to convert HDD to CSR WMM mode
  *
- * @uint8_t mode - hdd WMM user mode
+ * @mode: hdd WMM user mode
  *
  * Return: CSR WMM mode
  */
@@ -310,7 +309,7 @@ QDF_STATUS hdd_get_rx_nss(struct hdd_adapter *adapter, uint8_t *rx_nss);
 
 /**
  * hdd_dfs_indicate_radar() - Block tx as radar found on the channel
- * @hdd_ctxt: HDD context pointer
+ * @hdd_ctx: HDD context pointer
  *
  * This function is invoked in atomic context when a radar
  * is found on the SAP current operating channel and Data Tx
@@ -348,7 +347,7 @@ void hdd_override_all_ps(struct hdd_context *hdd_ctx);
 /**
  * hdd_vendor_mode_to_phymode() - Get eCsrPhyMode according to vendor phy mode
  * @vendor_phy_mode: vendor phy mode
- * @crs_phy_mode: phy mode of eCsrPhyMode
+ * @csr_phy_mode: phy mode of eCsrPhyMode
  *
  * Return: 0 on success, negative errno value on error
  */

core/hdd/inc/wlan_hdd_cfr.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2020-2021, The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 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
@@ -15,7 +16,7 @@
  */
 
 /**
- * DOC : wlan_hdd_cfr.h
+ * DOC: wlan_hdd_cfr.h
  *
  * WLAN Host Device Driver cfr capture implementation
  *

core/hdd/inc/wlan_hdd_debugfs_csr.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2018-2020 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 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
@@ -54,7 +55,7 @@ struct wlan_hdd_debugfs_buffer_info {
 
 /**
  * struct hdd_roam_scan_stats_debugfs_priv - private data for request mgr
- * @res: pointer to roam scan stats response
+ * @roam_scan_stats_res: pointer to roam scan stats response
  */
 struct hdd_roam_scan_stats_debugfs_priv {
 	struct wmi_roam_scan_stats_res *roam_scan_stats_res;
@@ -89,6 +90,8 @@ wlan_hdd_current_time_info_debugfs(uint8_t *buf, ssize_t buf_avail_len);
 /**
  * wlan_hdd_debugfs_update_filters_info() - API to get offload info
  * into user buffer
+ * @hdd_ctx: Pointer to hdd context
+ * @adapter: pointer to the adapter targeted by the debugfs operation
  * @buf: output buffer to hold offload info
  * @buf_avail_len: available buffer length
  *
@@ -102,6 +105,8 @@ wlan_hdd_debugfs_update_filters_info(struct hdd_context *hdd_ctx,
 /**
  * wlan_hdd_debugfs_update_roam_stats() - API to get roam scan stats info
  * into user buffer
+ * @hdd_ctx: Pointer to hdd context
+ * @adapter: pointer to the adapter targeted by the debugfs operation
  * @buf: output buffer to hold roam scan stats info
  * @buf_avail_len: available buffer length
  *
@@ -113,47 +118,21 @@ wlan_hdd_debugfs_update_roam_stats(struct hdd_context *hdd_ctx,
 				   uint8_t *buf, ssize_t buf_avail_len);
 
 #else
-/**
- * wlan_hdd_debugfs_csr_init() - Create wifi diagnostic debugfs files
- * @adapter: pointer to adapter for which debugfs files are to be created
- *
- * Return: None
- */
+
 static inline void wlan_hdd_debugfs_csr_init(struct hdd_adapter *adapter)
 {
 }
 
-/**
- * wlan_hdd_debugfs_csr_deinit() - Remove wifi diagnostic debugfs files
- * @adapter: pointer to adapter for which debugfs files are to be removed
- *
- * Return: None
- */
 static inline void wlan_hdd_debugfs_csr_deinit(struct hdd_adapter *adapter)
 {
 }
 
-/**
- * wlan_hdd_current_time_info_debugfs() - API to get time into user buffer
- * @buf: output buffer to hold current time when queried
- * @buf_avail_len: available buffer length
- *
- * Return: No.of bytes copied
- */
 static inline ssize_t
 wlan_hdd_current_time_info_debugfs(uint8_t *buf, ssize_t buf_avail_len)
 {
 	return 0;
 }
 
-/**
- * wlan_hdd_debugfs_update_filters_info() - API to get offload info
- * into user buffer
- * @buf: output buffer to hold offload info
- * @buf_avail_len: available buffer length
- *
- * Return: No.of bytes copied
- */
 static inline ssize_t
 wlan_hdd_debugfs_update_filters_info(struct hdd_context *hdd_ctx,
 				     struct hdd_adapter *adapter,
@@ -162,14 +141,6 @@ wlan_hdd_debugfs_update_filters_info(struct hdd_context *hdd_ctx,
 	return 0;
 }
 
-/**
- * wlan_hdd_debugfs_update_roam_stats() - API to get roam scan stats info
- * into user buffer
- * @buf: output buffer to hold roam scan stats info
- * @buf_avail_len: available buffer length
- *
- * Return: No.of bytes copied
- */
 static inline ssize_t
 wlan_hdd_debugfs_update_roam_stats(struct hdd_context *hdd_ctx,
 				   struct hdd_adapter *adapter,

core/hdd/inc/wlan_hdd_debugfs_llstat.h

@@ -67,7 +67,7 @@ void hdd_debugfs_process_radio_stats(struct hdd_adapter *adapter,
 		uint32_t more_data, void *data, uint32_t num_radio);
 
 /**
- * hdd_link_layer_process_iface_stats() - This function is called after
+ * hdd_debugfs_process_iface_stats() - This function is called after
  * @adapter: Pointer to device adapter
  * @data: Pointer to stats data
  * @num_peers: Number of peers

core/hdd/inc/wlan_hdd_driver_ops.h

@@ -1,6 +1,7 @@
 /*
  * Copyright (c) 2015-2017, 2019, 2021 The Linux Foundation.
  * All rights reserved.
+ * Copyright (c) 2022 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
@@ -145,7 +146,7 @@ void hdd_soc_idle_restart_unlock(void);
  * hdd_set_hif_init_phase() - Enable/disable the
  * init_phase flag
  * @hif_ctx: hif opaque handle
- * @hal_init_phase: init phase flag
+ * @init_phase: init phase flag
  *
  * Return: None
  */

core/hdd/inc/wlan_hdd_fw_state.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2019-2020 The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 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,7 +29,7 @@
 #ifdef FEATURE_FW_STATE
 #include <net/cfg80211.h>
 /**
- * wlan_hdd_cfg80211_get_fw_status() - get fw state
+ * wlan_hdd_cfg80211_get_fw_state() - get fw state
  * @wiphy: wiphy pointer
  * @wdev: pointer to struct wireless_dev
  * @data: pointer to incoming NL vendor data

core/hdd/inc/wlan_hdd_hang_event.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2020, The Linux Foundation. All rights reserved.
+ * Copyright (c) 2022 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
@@ -31,7 +32,6 @@ QDF_STATUS wlan_hdd_hang_event_notifier_register(struct hdd_context *hdd_ctx);
 /**
  * wlan_hdd_hang_event_notifier_unregister() - HDD hang event notifier
  * unregister
- * @hdd_ctx: HDD context
  *
  * This function unregisters hdd layer notifier for the hang event notifier
  * chain.

core/hdd/inc/wlan_hdd_twt.h

@@ -18,7 +18,7 @@
  */
 
 /**
- * DOC : wlan_hdd_twt.h
+ * DOC: wlan_hdd_twt.h
  *
  * WLAN Host Device Driver file for TWT (Target Wake Time) support.
  *
@@ -58,6 +58,7 @@ wlan_hdd_wifi_twt_config_policy[QCA_WLAN_VENDOR_ATTR_CONFIG_TWT_MAX + 1];
  * @TWT_RESPONDER_INDV: Individual TWT responder role
  * @TWT_RESPONDER_BCAST: Broadcast TWT responder role
  * @TWT_ROLE_ALL: All TWT roles
+ * @TWT_ROLE_MAX: Place holder for max mode
  */
 enum twt_role {
 	TWT_REQUESTOR,
@@ -105,14 +106,14 @@ enum twt_status {
 
 /**
  * struct twt_conc_arg: TWT concurrency args
- * @ hdd_ctx: pointer to hdd context
+ * @hdd_ctx: pointer to hdd context
  */
 struct twt_conc_arg {
 	struct hdd_context *hdd_ctx;
 };
 
 /**
- * twt_ack_info_priv - twt ack private info
+ * struct twt_ack_info_priv - twt ack private info
  * @vdev_id: vdev id
  * @peer_macaddr: peer mac address
  * @dialog_id: dialog id
@@ -292,7 +293,9 @@ void hdd_twt_concurrency_update_on_mcc(struct wlan_objmgr_pdev *pdev,
 /**
  * hdd_twt_concurrency_update_on_dbs() - Send TWT enable command to fw if DBS
  * exists in two vdevs
- * @hdd_ctx: hdd context pointer
+ * @pdev: pdev pointer
+ * @object: object pointer
+ * @arg: argument pointer
  *
  * Return: None
  */