qcacmn: Fix OSIF Documentation

The kernel-doc script identified some documentation issues in the
os_if folder, so fix most of them. However do not modify the file
qca_vendor.h since most of the issues there are present upstream, and
the downstream file should match the upstream file.

Change-Id: I71948fb497c1ea2d1dd46308277d99beefde18b8
CRs-Fixed: 3390428
This commit is contained in:
Jeff Johnson
2023-01-27 15:44:46 -08:00
committed by Madan Koyyalamudi
parent 3388a6e5a2
commit 7bc9ad4d74
23 changed files with 157 additions and 91 deletions

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2017-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
@@ -65,8 +65,7 @@ extern const struct nla_policy cfg80211_scan_policy[
#define SCAN_WAKE_LOCK_SCAN_DURATION (5 * 1000) /* in msec */
/**
* typedef struct qcom_ie_age - age ie
*
* typedef qcom_ie_age - age ie
* @element_id: Element id
* @len: Length
* @oui_1: OUI 1
@@ -93,11 +92,11 @@ typedef struct {
/**
* struct osif_scan_pdev - OS scan private structure
* scan_req_q: Scan request queue
* scan_req_q_lock: Protect scan request queue
* req_id: Scan request Id
* runtime_pm_lock: Runtime suspend lock
* scan_wake_lock: Scan wake lock
* @scan_req_q: Scan request queue
* @scan_req_q_lock: Protect scan request queue
* @req_id: Scan request Id
* @runtime_pm_lock: Runtime suspend lock
* @scan_wake_lock: Scan wake lock
*/
struct osif_scan_pdev{
qdf_list_t scan_req_q;
@@ -279,7 +278,7 @@ int wlan_cfg80211_scan(struct wlan_objmgr_vdev *vdev,
/**
* wlan_cfg80211_inform_bss_frame_data() - API to inform beacon to cfg80211
* @wiphy: wiphy
* @bss_data: bss data
* @bss: bss data
*
* API to inform beacon to cfg80211
*
@@ -293,7 +292,6 @@ wlan_cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
* wlan_cfg80211_inform_bss_frame() - API to inform beacon to cfg80211
* @pdev: Pointer to pdev
* @scan_params: scan entry
* @request: Pointer to scan request
*
* API to inform beacon to cfg80211
*
@@ -401,7 +399,7 @@ void wlan_cfg80211_cleanup_scan_queue(struct wlan_objmgr_pdev *pdev,
struct net_device *dev);
/**
* wlan_hdd_cfg80211_add_connected_pno_support() - Set connected PNO support
* wlan_scan_cfg80211_add_connected_pno_support() - Set connected PNO support
* @wiphy: Pointer to wireless phy
*
* This function is used to set connected PNO support to kernel
@@ -423,9 +421,9 @@ void wlan_scan_cfg80211_add_connected_pno_support(struct wiphy *wiphy)
defined(CFG80211_MULTI_SCAN_PLAN_BACKPORT)) && \
defined(FEATURE_WLAN_SCAN_PNO)
/**
* hdd_config_sched_scan_plans_to_wiphy() - configure sched scan plans to wiphy
* wlan_config_sched_scan_plans_to_wiphy() - configure sched scan plans to wiphy
* @wiphy: pointer to wiphy
* @config: pointer to config
* @psoc: pointer to psoc object
*
* Return: None
*/

View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2017-2021 The Linux Foundation. All rights reserved.
* Copyright (c) 2021-2022 Qualcomm Innovation Center, Inc. All rights reserved.
* Copyright (c) 2021-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
@@ -166,6 +166,7 @@ static void wlan_scan_rand_attrs(struct wlan_objmgr_vdev *vdev,
/**
* wlan_config_sched_scan_plan() - configures the sched scan plans
* from the framework.
* @psoc: psoc object
* @pno_req: pointer to PNO scan request
* @request: pointer to scan request from framework
*
@@ -756,11 +757,12 @@ wlan_schedule_scan_start_request(struct wlan_objmgr_pdev *pdev,
/**
* wlan_scan_request_dequeue() - dequeue scan request
* @nl_ctx: Global HDD context
* @pdev: pdev object
* @scan_id: scan id
* @req: scan request
* @dev: net device
* @source : returns source of the scan request
* @dev: returns source net device
* @scan_start_timestamp: returns scan start timestamp
*
* Return: QDF_STATUS
*/
@@ -875,7 +877,7 @@ void wlan_cfg80211_scan_done(struct net_device *netdev,
* @netdev: Net device
* @req : Scan request
* @aborted : true scan aborted false scan success
* @osif_priv - OS private structure
* @osif_priv: OS private structure
*
* This function notifies scan done to cfg80211
*
@@ -1377,7 +1379,8 @@ void wlan_cfg80211_cleanup_scan_queue(struct wlan_objmgr_pdev *pdev,
/**
* wlan_cfg80211_update_scan_policy_type_flags() - Set scan flags according to
* scan request
* @scan_req: Pointer to csr scan req
* @req: scan request to populate
* @scan_req: Pointer to scan request params
*
* Return: None
*/
@@ -2007,8 +2010,8 @@ static inline void wlan_add_age_ie(uint8_t *mgmt_frame,
defined(CFG80211_INFORM_BSS_FRAME_DATA)
/**
* wlan_fill_per_chain_rssi() - fill per chain RSSI in inform bss
* @data: bss data
* @per_chain_snr: per chain RSSI
* @data: destination bss data
* @bss: source bss data containing per chain RSSI
*
* Return: void
*/