qcacld-3.0: Fix os_if documentation

The kernel-doc script identified documentation issues in the os_if
layer, so fix them.

Change-Id: I71dd7893776e4b49a80f6be186740967b08d3347
CRs-Fixed: 3341451

os_if/coap/src/wlan_cfg80211_coap.c

@@ -277,7 +277,7 @@ wlan_cfg80211_coap_offload_fill_tx_ipv4(struct nlattr *attr_ipv4,
  * periodic transmitting
  * @vdev: pointer to vdev object
  * @req_id: request id
- * @attr_reply: pointer to CoAP offload periodic TX attribute
+ * @attr_periodic_tx: pointer to CoAP offload periodic TX attribute
  *
  * Return: 0 on success; error number otherwise
  */
@@ -329,7 +329,7 @@ wlan_cfg80211_coap_offload_periodic_tx_enable(struct wlan_objmgr_vdev *vdev,
 }
 
 /**
- * wlan_cfg80211_coap_offload_periodic_tx_enable() - disable CoAP offload
+ * wlan_cfg80211_coap_offload_periodic_tx_disable() - disable CoAP offload
  * periodic transmitting
  * @vdev: pointer to vdev object
  * @req_id: request id

os_if/coex/src/wlan_cfg80211_coex.c

@@ -111,9 +111,8 @@ __wlan_cfg80211_coex_set_btc_chain_mode(struct wlan_objmgr_vdev *vdev,
 }
 
 /**
- * wlan_hdd_cfg80211_set_btc_chain_mode() - set btc chain mode
- * @wiphy: pointer to wireless wiphy structure.
- * @wdev: pointer to wireless_dev structure.
+ * wlan_cfg80211_coex_set_btc_chain_mode() - set btc chain mode
+ * @vdev: pointer to vdev structure.
  * @data: pointer to btc chain mode command parameters.
  * @data_len: the length in byte of btc chain mode command parameters.
  *

os_if/cp_stats/inc/wlan_cfg80211_mc_cp_stats.h

@@ -87,8 +87,7 @@ wlan_cfg80211_mc_cp_stats_get_station_stats(struct wlan_objmgr_vdev *vdev,
 /**
  * wlan_cfg80211_mc_cp_stats_free_stats_event() - API to release station
  * statistics buffer
- * @vdev:    Pointer to vdev
- * @info:    pointer to object to populate with station stats
+ * @info:    pointer to object populated with station stats
  *
  * Return: None
  */

os_if/cp_stats/src/wlan_cfg80211_mc_cp_stats.c

@@ -914,7 +914,7 @@ static void infra_cp_stats_reset_cb(struct infra_cp_stats_event *ev,
 }
 
 /**
- * @wlan_cfg80211_mc_twt_clear_infra_cp_stats() - send clear twt statistics
+ * wlan_cfg80211_mc_twt_clear_infra_cp_stats() - send clear twt statistics
  * request to firmware
  * @vdev: vdev id
  * @dialog_id: dialog id of the twt session.

os_if/dp/inc/os_if_dp.h

@@ -42,7 +42,7 @@ enum qdisc_filter_status {
 
 /**
  * osif_dp_classify_pkt() - classify packet
- * @skb - sk buff
+ * @skb: sk buff
  *
  * Return: None
  */
@@ -50,7 +50,7 @@ void osif_dp_classify_pkt(struct sk_buff *skb);
 
 /**
  * osif_dp_mark_pkt_type() - Mark pkt type in CB
- * @skb - sk buff
+ * @skb: sk buff
  *
  * Return: None
  */

os_if/dp/inc/os_if_dp_lro.h

@@ -17,7 +17,7 @@
  */
 
 /**
- * DOC : osif_dp_lro.h
+ * DOC: osif_dp_lro.h
  *
  * WLAN Host Device Driver file for DP LRO support.
  *
@@ -32,7 +32,7 @@
 #if defined(FEATURE_LRO)
 /**
  * osif_dp_lro_rx() - Handle Rx processing via LRO
- * @vdev: Vdev obj mgr
+ * @dev: netdev
  * @nbuf: network buffer
  *
  * Return: QDF_STATUS_SUCCESS if processed via LRO or non zero return code

os_if/dp/src/os_if_dp_lro.c

@@ -51,7 +51,7 @@ static qdf_lro_ctx_t osif_dp_get_lro_ctx(struct sk_buff *skb)
 
 /**
  * osif_dp_lro_rx() - LRO receive function
- * @vdev: Vdev obj mgr
+ * @dev: netdev
  * @nbuf: network buffer
  *
  * Delivers LRO eligible frames to the LRO manager
@@ -106,7 +106,7 @@ QDF_STATUS osif_dp_lro_rx(qdf_netdev_t dev, qdf_nbuf_t nbuf)
 }
 
 /**
- * dp_lro_display_stats() - display LRO statistics
+ * osif_dp_lro_display_stats() - display LRO statistics
  * @vdev: vdev objmgr context
  *
  * Return: none

os_if/dp/src/os_if_dp_txrx.c

@@ -44,7 +44,7 @@
 
 /**
  * osif_dp_classify_pkt() - classify packet
- * @skb - sk buff
+ * @skb:  sk buff
  *
  * Return: none
  */
@@ -150,7 +150,7 @@ void osif_dp_mark_pkt_type(struct sk_buff *skb)
 		osif_dp_mark_non_critical_pkt(skb);
 }
 
-/**
+/*
  * When bus bandwidth is idle, if RX data is delivered with
  * napi_gro_receive, to reduce RX delay related with GRO,
  * check gro_result returned from napi_gro_receive to determine
@@ -363,6 +363,7 @@ __osif_check_for_prio_filter_in_clsact_qdisc(struct tcf_block *block,
  * osif_check_for_prio_filter_in_clsact_qdisc() - Check if priority 3 filter
  *  is configured in the ingress clsact qdisc
  * @qdisc: pointer to clsact qdisc
+ * @prio: traffic priority
  *
  * Return: qdisc filter status
  */
@@ -385,10 +386,10 @@ osif_check_for_prio_filter_in_clsact_qdisc(struct Qdisc *qdisc, uint32_t prio)
 }
 
 /**
- * osif_dp_rx_check_qdisc_for_configured() - Check if any ingress qdisc
- * configured for given adapter
- * @dp_intf: pointer to DP interface context
- * @rx_ctx_id: Rx context id
+ * osif_dp_rx_check_qdisc_configured() - Check if any ingress qdisc
+ * configured for given netdev
+ * @ndev: pointer to netdev
+ * @prio: traffic priority
  *
  * The function checks if ingress qdisc is registered for a given
  * net device.

os_if/fw_offload/inc/os_if_fwol.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 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
@@ -86,7 +87,8 @@ static inline int os_if_fwol_send_dscp_up_map_to_fw(
 #ifdef WLAN_FEATURE_MDNS_OFFLOAD
 /**
  * os_if_fwol_enable_mdns_offload() - Enable mdns offload
- * @vdev: Pointer to vdev
+ * @psoc: Pointer to psoc object
+ * @mdns_info: MDNS offload information
  *
  * This function will offload mdns response to FW.
  *
@@ -96,8 +98,8 @@ int os_if_fwol_enable_mdns_offload(struct wlan_objmgr_psoc *psoc,
 				   struct mdns_config_info *mdns_info);
 
 /**
- * os_if_fwol_diasable_mdns_offload() - Disable mdns offload
- * @vdev: Pointer to vdev
+ * os_if_fwol_disable_mdns_offload() - Disable mdns offload
+ * @psoc: Pointer to psoc
  *
  * This function will disable the mdns offload feature.
  *

os_if/nan/src/os_if_nan.c

@@ -683,7 +683,8 @@ static int os_if_nan_parse_security_params(struct nlattr **tb,
 
 /**
  * __os_if_nan_process_ndp_initiator_req() - NDP initiator request handler
- * @ctx: hdd context
+ * @psoc: psoc object
+ * @iface_name: interface name
  * @tb: parsed NL attribute list
  *
  * tb will contain following vendor attributes:
@@ -851,7 +852,7 @@ static int os_if_nan_process_ndp_initiator_req(struct wlan_objmgr_psoc *psoc,
 
 /**
  * __os_if_nan_process_ndp_responder_req() - NDP responder request handler
- * @nan_ctx: hdd context
+ * @psoc: psoc object
  * @tb: parsed NL attribute list
  *
  * tb includes following vendor attributes:
@@ -1230,7 +1231,7 @@ static inline uint32_t osif_ndp_get_ndp_initiator_rsp_len(void)
 /**
  * os_if_ndp_initiator_rsp_handler() - NDP initiator response handler
  * @vdev: pointer to vdev object
- * @rsp_params: response parameters
+ * @rsp: response parameters
  *
  * Following vendor event is sent to cfg80211:
  * QCA_WLAN_VENDOR_ATTR_NDP_SUBCMD =
@@ -1411,7 +1412,7 @@ static inline uint32_t osif_ndp_get_ndp_req_ind_len(
 /**
  * os_if_ndp_indication_handler() - NDP indication handler
  * @vdev: pointer to vdev object
- * @ind_params: indication parameters
+ * @event: indication parameters
  *
  * Following vendor event is sent to cfg80211:
  * QCA_WLAN_VENDOR_ATTR_NDP_SUBCMD =
@@ -1646,7 +1647,7 @@ static QDF_STATUS os_if_ndp_confirm_pack_ch_info(struct sk_buff *event,
 /**
  * os_if_ndp_confirm_ind_handler() - NDP confirm indication handler
  * @vdev: pointer to vdev object
- * @ind_params: indication parameters
+ * @ndp_confirm: indication parameters
  *
  * Following vendor event is sent to cfg80211:
  * QCA_WLAN_VENDOR_ATTR_NDP_SUBCMD =
@@ -1788,7 +1789,7 @@ static inline uint32_t osif_ndp_get_ndp_end_rsp_len(void)
 /**
  * os_if_ndp_end_rsp_handler() - NDP end response handler
  * @vdev: pointer to vdev object
- * @rsp_params: response parameters
+ * @rsp: response parameters
  *
  * Following vendor event is sent to cfg80211:
  * QCA_WLAN_VENDOR_ATTR_NDP_SUBCMD =
@@ -1865,7 +1866,7 @@ static inline uint32_t osif_ndp_get_ndp_end_ind_len(
 /**
  * os_if_ndp_end_ind_handler() - NDP end indication handler
  * @vdev: pointer to vdev object
- * @ind_params: indication parameters
+ * @end_ind: indication parameters
  *
  * Following vendor event is sent to cfg80211:
  * QCA_WLAN_VENDOR_ATTR_NDP_SUBCMD =
@@ -1927,8 +1928,8 @@ ndp_end_ind_nla_failed:
 
 /**
  * os_if_new_peer_ind_handler() - NDP new peer indication handler
- * @adapter: pointer to adapter context
- * @ind_params: indication parameters
+ * @vdev: vdev object
+ * @peer_ind: indication parameters
  *
  * Return: none
  */
@@ -1970,8 +1971,8 @@ static void os_if_new_peer_ind_handler(struct wlan_objmgr_vdev *vdev,
 
 /**
  * os_if_peer_departed_ind_handler() - Handle NDP peer departed indication
- * @adapter: pointer to adapter context
- * @ind_params: indication parameters
+ * @vdev: vdev object
+ * @peer_ind: indication parameters
  *
  * Return: none
  */
@@ -2021,7 +2022,8 @@ static inline uint32_t osif_ndp_get_ndi_create_rsp_len(void)
 
 /**
  * os_if_ndp_iface_create_rsp_handler() - NDP iface create response handler
- * @adapter: pointer to adapter context
+ * @psoc: soc object
+ * @vdev: vdev object
  * @rsp_params: response parameters
  *
  * The function is expected to send a response back to the user space
@@ -2137,7 +2139,8 @@ close_ndi:
 
 /**
  * os_if_ndp_iface_delete_rsp_handler() - NDP iface delete response handler
- * @adapter: pointer to adapter context
+ * @psoc: soc object
+ * @vdev: vdev object
  * @rsp_params: response parameters
  *
  * Return: none

os_if/p2p/inc/wlan_cfg80211_p2p.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2017-2018 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
@@ -82,6 +83,7 @@ int wlan_cfg80211_cancel_roc(struct wlan_objmgr_vdev *vdev,
  * wlan_cfg80211_mgmt_tx() - API to process cfg80211 mgmt tx request
  * @vdev: Pointer to vdev object
  * @chan: Pointer to channel
+ * @offchan: true if this is an off-channel frame
  * @wait: wait time for this mgmt tx request
  * @buf: TX buffer
  * @len: Length of tx buffer

os_if/pkt_capture/inc/os_if_pkt_capture.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2012-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
@@ -68,9 +69,10 @@ set_monitor_mode_policy[SET_MONITOR_MODE_CONFIG_MAX + 1];
  * os_if_monitor_mode_configure() - Process monitor mode configuration
  * operation in the received vendor command
  * @adapter: adapter pointer
- * @tb: nl attributes Handles QCA_NL80211_VENDOR_SUBCMD_SET_MONITOR_MODE
+ * @data: %QCA_NL80211_VENDOR_SUBCMD_SET_MONITOR_MODE payload
+ * @data_len: length of @data
  *
- * Return: 0 for Success and negative value for failure
+ * Return: %QDF_STATUS_SUCCESS on success, error status otherwise
  */
 QDF_STATUS os_if_monitor_mode_configure(struct hdd_adapter *adapter,
 					const void *data, int data_len);

os_if/pre_cac/inc/osif_pre_cac.h

@@ -23,6 +23,9 @@
 
 /**
  * typedef osif_conditional_csa_ind_legacy_cb - CSA indication callback
+ * @vdev: vdev upon which channel switch is occurring
+ * @completed: true if channel switch has completed, false if channel
+ *             switch is being initiated
  *
  * This callback is to send conditional channel switch status
  *
@@ -34,7 +37,11 @@ typedef void
 					      bool completed);
 
 /**
- * typedef osif_pre_cac_complete_legacy_cb - pre cac complete callback
+ * typedef osif_pre_cac_complete_status_legacy_cb - pre cac complete callback
+ * @psoc: SOC where pre-cac is required
+ * @vdev_id: ID of the vdev where pre-cac is required
+ * @status: QDF_STATUS_SUCCESS if pre-cac was successful, otherwise an
+ *          appropriate QDF error status code
  *
  * This callback is used to indicate the pre cac complete status
  *
@@ -47,7 +54,7 @@ typedef void
 						  QDF_STATUS status);
 
 /**
- * osif_pre_cac_ops: pre cac legacy callbacks
+ * struct osif_pre_cac_legacy_ops - pre cac legacy callbacks
  * @conditional_csa_ind_legacy_cb: Callback for CSA indication
  * @pre_cac_complete_legacy_cb: Callback for pre cac complete status
  */

os_if/son/inc/os_if_son.h

@@ -1,4 +1,3 @@
-
 /*
  * Copyright (c) 2021, The Linux Foundation. All rights reserved.
  * Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
@@ -17,7 +16,7 @@
  */
 
 /**
- * DOC : os_if_son.h
+ * DOC: os_if_son.h
  *
  * WLAN Host Device Driver file for son (Self Organizing Network)
  * support.
@@ -43,6 +42,7 @@
  * @os_if_set_bandwidth: set band width
  * @os_if_get_bandwidth: get band width
  * @os_if_set_chan: set chan
+ * @os_if_get_sta_count: get station count
  * @os_if_set_country_code: set country code
  * @os_if_set_candidate_freq: set freq to switch after radar detection
  * @os_if_get_candidate_freq: get freq to switch after radar detection
@@ -237,7 +237,7 @@ uint32_t os_if_son_is_cac_in_progress(struct wlan_objmgr_vdev *vdev);
 /**
  * os_if_son_set_chan_ext_offset() - set chan extend offset
  * @vdev: vdev
- * @son_chan_ext_offset son chan extend offset
+ * @son_chan_ext_offset: son chan extend offset
  *
  * Return: 0 on success, negative errno on failure
  */
@@ -424,7 +424,6 @@ void os_if_son_get_phy_stats(struct wlan_objmgr_vdev *vdev,
 
 /**
  * os_if_son_cbs_init() - cbs init
- * @vdev: vdev
  *
  * Return: 0 on success, negative errno on failure
  */
@@ -432,7 +431,6 @@ int os_if_son_cbs_init(void);
 
 /**
  * os_if_son_cbs_deinit() - cbs deinit
- * @vdev: vdev
  *
  * Return: 0 on success, negative errno on failure
  */
@@ -498,7 +496,7 @@ QDF_STATUS os_if_son_pdev_ops(struct wlan_objmgr_pdev *pdev,
  *
  * Return: QDF_SUCCCESS_SUCCESS in case of success
  */
-QDF_STATUS os_if_son_vdev_ops(struct wlan_objmgr_vdev *pdev,
+QDF_STATUS os_if_son_vdev_ops(struct wlan_objmgr_vdev *vdev,
 			      enum wlan_mlme_vdev_param type,
 			      void *data, void *ret);
 
@@ -624,7 +622,7 @@ int os_if_son_del_acl_mac(struct wlan_objmgr_vdev *vdev,
 /**
  * os_if_son_kickout_mac() - kickout sta with given mac
  * @vdev: vdev
- * @acl_mac: sta mac to kickout
+ * @mac: sta mac to kickout
  *
  * Return: 0 on success, negative errno on failure
  */

os_if/son/src/os_if_son.c

@@ -16,7 +16,7 @@
  */
 
 /**
- * DOC : os_if_son.c
+ * DOC: os_if_son.c
  *
  * WLAN Host Device Driver file for son (Self Organizing Network)
  * support.

os_if/sync/inc/osif_driver_sync.h

@@ -22,7 +22,7 @@
 
 #include "qdf_types.h"
 
-/**
+/*
  * struct osif_driver_sync - opaque synchronization handle for a driver
  */
 struct osif_driver_sync;

os_if/sync/inc/osif_psoc_sync.h

@@ -24,7 +24,7 @@
 #include "wlan_dsc_driver.h"
 #include "qdf_types.h"
 
-/**
+/*
  * struct osif_psoc_sync - opaque synchronization handle for a psoc
  */
 struct osif_psoc_sync;

os_if/sync/inc/osif_vdev_sync.h

@@ -162,8 +162,8 @@ __osif_vdev_sync_op_start(struct net_device *net_dev,
  *
  * Return: none
  */
-#define osif_vdev_sync_op_stop(net_dev) \
-	__osif_vdev_sync_op_stop(net_dev, __func__)
+#define osif_vdev_sync_op_stop(vdev_sync) \
+	__osif_vdev_sync_op_stop(vdev_sync, __func__)
 
 void __osif_vdev_sync_op_stop(struct osif_vdev_sync *vdev_sync,
 			      const char *func);

os_if/twt/inc/osif_twt_ext_req.h

@@ -17,7 +17,7 @@
  */
 
 /**
- * DOC : osif_twt_ext_req.h
+ * DOC: osif_twt_ext_req.h
  *
  * WLAN Host Device Driver file for TWT (Target Wake Time) support.
  *
@@ -213,7 +213,7 @@ int osif_twt_clear_session_traffic_stats(struct wlan_objmgr_vdev *vdev,
 
 /**
  * osif_twt_set_param() - pdev TWT param send
- * @psoc: Pointer to psoc object
+ * @vdev: Pointer to vdev object
  * @twt_param_attr: nlattr for TWT access category
  *
  * Return: QDF Status

os_if/twt/inc/osif_twt_ext_rsp.h

@@ -17,7 +17,7 @@
  */
 
 /**
- * DOC : osif_twt_ext_rsp.h
+ * DOC: osif_twt_ext_rsp.h
  *
  * WLAN Host Device Driver file for TWT (Target Wake Time) support.
  *
@@ -100,7 +100,7 @@ osif_twt_notify_complete_cb(struct wlan_objmgr_psoc *psoc,
 /**
  * osif_twt_ack_complete_cb() - ack complete osif callback
  * @psoc: psoc pointer
- * @event: ack complete response
+ * @params: ack complete response
  * @context: context
  *
  * Return: QDF_STATUS

os_if/twt/inc/osif_twt_internal.h

@@ -17,7 +17,7 @@
  */
 
 /**
- * DOC : osif_twt_internal.h
+ * DOC: osif_twt_internal.h
  *
  * WLAN Host Device Driver file for TWT (Target Wake Time) support.
  *

os_if/twt/src/osif_twt_ext_req.c

@@ -1082,8 +1082,7 @@ int osif_twt_setup_req(struct wlan_objmgr_vdev *vdev,
 
 /**
  * osif_twt_handle_renego_failure() - Upon re-nego failure send TWT teardown
- *
- * @adapter: Adapter pointer
+ * @psoc: Pointer to psoc object
  * @event: Pointer to Add dialog complete event structure
  *
  * Upon re-negotiation failure, this function constructs TWT teardown
@@ -2328,7 +2327,7 @@ enum twt_traffic_ac osif_twt_convert_ac_value(enum qca_wlan_ac_type ac_value)
 
 /**
  * osif_twt_add_ac_config() - pdev TWT param send
- * @psoc: Pointer to psoc object
+ * @vdev: Pointer to vdev object
  * @twt_ac: TWT access category
  *
  * Return: QDF Status

os_if/twt/src/osif_twt_ext_rsp.c

@@ -280,7 +280,7 @@ twt_nudge_status_to_vendor_twt_status(enum HOST_TWT_NUDGE_STATUS status)
 /**
  * twt_add_cmd_to_vendor_twt_resp_type() - convert from
  * HOST_TWT_COMMAND to qca_wlan_vendor_twt_setup_resp_type
- * @status: HOST_TWT_COMMAND value from firmware
+ * @type: HOST_TWT_COMMAND value from firmware
  *
  * Return: qca_wlan_vendor_twt_setup_resp_type values for valid
  * HOST_TWT_COMMAND value and -EINVAL for invalid value