qcacld-3.0: Fix Firmware Offload documentation

The kernel-doc script identified a multitude of documentation issues
in components/fw_offload, so fix them.

Change-Id: I9c5b3f561d74ac433bd7f8c47cab737af9af3ecb
CRs-Fixed: 3357050

components/fw_offload/dispatcher/inc/wlan_fwol_public_structs.h

@@ -32,9 +32,9 @@
 
 /**
  * enum fwol_extlna_mode - provides elna modes
- * @EXTLNA_MODE_DISABLE_ELNA_BYPASS - disables elna bypass
- * @EXTLNA_MODE_ENABLE_ELNA_BYPASS  - enables elna bypass
- * @EXTLNA_MODE_FIRMWARE_DEFAULT    - Reset eLNA bypass configuration,
+ * @EXTLNA_MODE_DISABLE_ELNA_BYPASS:  disables elna bypass
+ * @EXTLNA_MODE_ENABLE_ELNA_BYPASS:   enables elna bypass
+ * @EXTLNA_MODE_FIRMWARE_DEFAULT:     Reset eLNA bypass configuration,
  *                                    the driver should revert to the default
  *                                    configuration of eLNA bypass
  */

components/fw_offload/dispatcher/inc/wlan_fwol_tgt_api.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
@@ -53,7 +54,7 @@ QDF_STATUS tgt_fwol_register_rx_ops(struct wlan_fwol_rx_ops *rx_ops);
 /**
  * tgt_fwol_pdev_param_send() - send pdev params to firmware
  * @pdev: pdev handle
- * @pdev_params: pdev params
+ * @pdev_param: pdev params
  *
  * Return: QDF_STATUS_SUCCESS on success
  */
@@ -63,7 +64,7 @@ QDF_STATUS tgt_fwol_pdev_param_send(struct wlan_objmgr_pdev *pdev,
 /**
  * tgt_fwol_vdev_param_send() - send vdev params to firmware
  * @psoc: psoc handle
- * @vdev_set_params: vdev params
+ * @vdev_param: vdev params
  *
  * Return: QDF_STATUS_SUCCESS on success
  */

components/fw_offload/dispatcher/inc/wlan_fwol_ucfg_api.h

@@ -59,7 +59,7 @@ void ucfg_fwol_psoc_close(struct wlan_objmgr_psoc *psoc);
 QDF_STATUS ucfg_fwol_psoc_enable(struct wlan_objmgr_psoc *psoc);
 
 /**
- * ucfg_fwol_psoc_close() - FWOL component disable
+ * ucfg_fwol_psoc_disable() - FWOL component disable
  * @psoc: pointer to psoc object
  *
  * Return: None
@@ -167,7 +167,8 @@ ucfg_fwol_get_thermal_temp(struct wlan_objmgr_psoc *psoc,
 			   struct wlan_fwol_thermal_temp *thermal_temp);
 
 /**
- * ucfg_fwol_get_neighbor_report_req() - Get neighbor report request bit
+ * ucfg_fwol_is_neighbor_report_req_supported() - Get neighbor report request
+ *                                                supported bit
  * @psoc: Pointer to psoc object
  * @neighbor_report_req: Pointer to return value
  *
@@ -208,8 +209,10 @@ QDF_STATUS
 ucfg_fwol_get_all_allowlist_params(struct wlan_objmgr_psoc *psoc,
 				   struct wlan_fwol_ie_allowlist *allowlist);
 
-/** ucfg_fwol_get_ani_enabled() - Assigns the ani_enabled value
+/**
+ * ucfg_fwol_get_ani_enabled() - Assigns the ani_enabled value
  * @psoc: pointer to the psoc object
+ * @ani_enabled: pointer to return ani_enabled value
  *
  * Return: QDF Status
  */
@@ -217,8 +220,10 @@ QDF_STATUS ucfg_fwol_get_ani_enabled(struct wlan_objmgr_psoc *psoc,
 				     bool *ani_enabled);
 
 /**
- * ucfg_fwol_get_ani_enabled() - Assigns the enable_rts_sifsbursting value
+ * ucfg_get_enable_rts_sifsbursting() - Assigns the enable_rts_sifsbursting
+ *                                      value
  * @psoc: pointer to the psoc object
+ * @enable_rts_sifsbursting: pointer to return enable_rts_sifsbursting value
  *
  * Return: QDF Status
  */
@@ -238,6 +243,7 @@ QDF_STATUS ucfg_get_enable_sifs_burst(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_get_max_mpdus_inampdu() - Assigns the max_mpdus_inampdu value
  * @psoc: pointer to the psoc object
+ * @max_mpdus_inampdu: pointer to return max_mpdus_inampdu value
  *
  * Return: QDF Status
  */
@@ -247,6 +253,7 @@ QDF_STATUS ucfg_get_max_mpdus_inampdu(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_get_enable_phy_reg_retention() - Assigns enable_phy_reg_retention value
  * @psoc: pointer to the psoc object
+ * @enable_phy_reg_retention: pointer to return enable_phy_reg_retention value
  *
  * Return: QDF Status
  */
@@ -256,6 +263,7 @@ QDF_STATUS ucfg_get_enable_phy_reg_retention(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_get_upper_brssi_thresh() - Assigns upper_brssi_thresh value
  * @psoc: pointer to the psoc object
+ * @upper_brssi_thresh: pointer to return upper_brssi_thresh value
  *
  * Return: QDF Status
  */
@@ -265,6 +273,7 @@ QDF_STATUS ucfg_get_upper_brssi_thresh(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_get_lower_brssi_thresh() - Assigns lower_brssi_thresh value
  * @psoc: pointer to the psoc object
+ * @lower_brssi_thresh: pointer to return lower_brssi_thresh value
  *
  * Return: QDF Status
  */
@@ -274,6 +283,7 @@ QDF_STATUS ucfg_get_lower_brssi_thresh(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_get_enable_dtim_1chrx() - Assigns enable_dtim_1chrx value
  * @psoc: pointer to the psoc object
+ * @enable_dtim_1chrx: pointer to return enable_dtim_1chrx value
  *
  * Return: QDF Status
  */
@@ -281,8 +291,11 @@ QDF_STATUS ucfg_get_enable_dtim_1chrx(struct wlan_objmgr_psoc *psoc,
 				      bool *enable_dtim_1chrx);
 
 /**
- * ucfg_get_alternate_chainmask_enabled() - Assigns alt chainmask_enabled value
+ * ucfg_get_alternative_chainmask_enabled() - Assigns alt chainmask_enabled
+ *                                            value
  * @psoc: pointer to the psoc object
+ * @alternative_chainmask_enabled: pointer to return
+ *                                 alternative_chainmask_enabled value
  *
  * Return: QDF Status
  */
@@ -293,6 +306,7 @@ ucfg_get_alternative_chainmask_enabled(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_get_smart_chainmask_enabled() - Assigns smart_chainmask_enabled value
  * @psoc: pointer to the psoc object
+ * @smart_chainmask_enabled: pointer to return smart_chainmask_enabled value
  *
  * Return: QDF Status
  */
@@ -302,6 +316,7 @@ QDF_STATUS ucfg_get_smart_chainmask_enabled(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_fwol_get_rts_profile() - Assigns get_rts_profile value
  * @psoc: pointer to the psoc object
+ * @get_rts_profile: pointer to return RTS profile value
  *
  * Return: QDF Status
  */
@@ -311,6 +326,7 @@ QDF_STATUS ucfg_fwol_get_rts_profile(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_fwol_get_enable_fw_log_level() - Assigns enable_fw_log_level value
  * @psoc: pointer to the psoc object
+ * @enable_fw_log_level: pointer to return firmware log level enable bitmap
  *
  * Return: QDF Status
  */
@@ -320,11 +336,13 @@ QDF_STATUS ucfg_fwol_get_enable_fw_log_level(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_fwol_get_enable_fw_log_type() - Assigns enable_fw_log_type value
  * @psoc: pointer to the psoc object
+ * @enable_fw_log_type: pointer to return firmware log type bitmap
  *
  * Return: QDF Status
  */
 QDF_STATUS ucfg_fwol_get_enable_fw_log_type(struct wlan_objmgr_psoc *psoc,
 					    uint16_t *enable_fw_log_type);
+
 /**
  * ucfg_fwol_get_enable_fw_module_log_level() - Assigns
  * enable_fw_module_log_level string
@@ -372,6 +390,7 @@ QDF_STATUS ucfg_fwol_get_sap_xlna_bypass(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_fwol_set_is_rate_limit_enabled() - Sets the is_rate_limit_enabled value
  * @psoc: pointer to the psoc object
+ * @is_rate_limit_enabled: value to set rate limit enabled bool
  *
  * Return: QDF Status
  */
@@ -381,6 +400,7 @@ QDF_STATUS ucfg_fwol_set_is_rate_limit_enabled(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_fwol_get_is_rate_limit_enabled() - Assigns is_rate_limit_enabled value
  * @psoc: pointer to the psoc object
+ * @is_rate_limit_enabled: pointer to return rate limit enabled bool
  *
  * Return: QDF Status
  */
@@ -392,6 +412,7 @@ QDF_STATUS ucfg_fwol_get_is_rate_limit_enabled(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_fwol_get_tsf_gpio_pin() - Assigns tsf_gpio_pin value
  * @psoc: pointer to the psoc object
+ * @tsf_gpio_pin: pointer to return TSF GPIO pin value
  *
  * Return: QDF Status
  */
@@ -403,6 +424,7 @@ QDF_STATUS ucfg_fwol_get_tsf_gpio_pin(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_fwol_get_tsf_irq_host_gpio_pin() - Assigns tsf_irq_host_gpio_pin value
  * @psoc: pointer to the psoc object
+ * @tsf_irq_host_gpio_pin: pointer to return the TSF IRQ GPIO pin number
  *
  * Return: QDF Status
  */
@@ -416,6 +438,7 @@ ucfg_fwol_get_tsf_irq_host_gpio_pin(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_fwol_get_tsf_sync_host_gpio_pin() - Assigns tsf_sync_host_gpio_pin value
  * @psoc: pointer to the psoc object
+ * @tsf_irq_host_gpio_pin: pointer to return the TSF sync GPIO pin number
  *
  * Return: QDF Status
  */
@@ -429,6 +452,8 @@ ucfg_fwol_get_tsf_sync_host_gpio_pin(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_fwol_get_enable_dhcp_server_offload()-Assign enable_dhcp_server_offload
  * @psoc: pointer to the psoc object
+ * @enable_dhcp_server_offload: pointer to return enable_dhcp_server_offload
+ *                              value
  *
  * Return: QDF Status
  */
@@ -439,6 +464,7 @@ ucfg_fwol_get_enable_dhcp_server_offload(struct wlan_objmgr_psoc *psoc,
 /**
  * ucfg_fwol_get_dhcp_max_num_clients() - Assigns dhcp_max_num_clients value
  * @psoc: pointer to the psoc object
+ * @dhcp_max_num_clients: pointer to return the max number of DHC clients value
  *
  * Return: QDF Status
  */
@@ -527,7 +553,7 @@ static inline QDF_STATUS ucfg_fwol_get_ofdm_scrambler_seed(
 /**
  * ucfg_fwol_get_enable_secondary_rate() - Get enable secondary rate
  * @psoc: pointer to the psoc object
- * @enable_tx_sch_delay: Pointer to return enable secondary rate value
+ * @enable_secondary_rate: Pointer to return enable secondary rate value
  *
  * Return: QDF Status
  */
@@ -535,7 +561,7 @@ QDF_STATUS ucfg_fwol_get_enable_secondary_rate(struct wlan_objmgr_psoc *psoc,
 					       uint32_t *enable_secondary_rate);
 /**
  * ucfg_fwol_get_all_adaptive_dwelltime_params() - Get all adaptive
-						   dwelltime_params
+ *						   dwelltime_params
  * @psoc: Pointer to psoc object
  * @dwelltime_params: Pointer to struct adaptive_dwelltime_params
  *
@@ -568,7 +594,7 @@ ucfg_fwol_get_adaptive_dwell_mode_enabled(struct wlan_objmgr_psoc *psoc,
  * For uses : see enum scan_dwelltime_adaptive_mode
  *
  * @psoc: pointer to psoc object
- * global_adapt_dwelltime_mode@: global adaptive dwell mode value
+ * @global_adapt_dwelltime_mode: global adaptive dwell mode value
  *
  * Return: QDF Status
  */
@@ -616,7 +642,7 @@ QDF_STATUS ucfg_fwol_get_adapt_dwell_wifi_act_threshold(
  * ucfg_fwol_init_adapt_dwelltime_in_cfg - API to initialize adaptive
  *                                         dwell params
  * @psoc: pointer to psoc object
- * @adaptive_dwelltime_params: pointer to adaptive_dwelltime_params structure
+ * @dwelltime_params: pointer to adaptive_dwelltime_params structure
  *
  * Return: QDF Status
  */
@@ -631,7 +657,7 @@ ucfg_fwol_init_adapt_dwelltime_in_cfg(
 /**
  * ucfg_fwol_set_adaptive_dwelltime_config - API to set adaptive
  *                                           dwell params config
- * @adaptive_dwelltime_params: adaptive_dwelltime_params structure
+ * @dwelltime_params: adaptive_dwelltime_params structure
  *
  * Return: QDF Status
  */