samsung-sm8650/android_kernel_samsung_sm8650-modules
1
0
複製 0
程式碼 問題管理 合併請求 Actions Packages Projects 版本發佈 Wiki Activity

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
父節點 3388a6e5a2
當前提交 7bc9ad4d74
共有 23 個文件被更改，包括 157 次插入 和 91 次删除
Download Patch File Download Diff File Expand all files Collapse all files

12
os_if/linux/mlme/inc/osif_cm_util.h
查看文件

@@ -334,18 +334,18 @@ typedef QDF_STATUS
#endif
/**
* osif_cm_ops: connection manager legacy callbacks
* @osif_cm_connect_comp_cb: callback for connect complete to legacy
* struct osif_cm_ops - connection manager legacy callbacks
* @connect_complete_cb: callback for connect complete to legacy
* modules
* @osif_cm_disconnect_comp_cb: callback for disconnect complete to
* @disconnect_complete_cb: callback for disconnect complete to
* legacy modules
* @osif_cm_netif_queue_ctrl_cb: callback to legacy module to take
* @netif_queue_control_cb: callback to legacy module to take
* actions on netif queue
* @os_if_cm_napi_serialize_ctrl_cb: callback to legacy module to take
* @napi_serialize_control_cb: callback to legacy module to take
* actions on napi serialization
* @save_gtk_cb : callback to legacy module to save gtk
* @send_vdev_keys_cb: callback to send vdev keys
* @osif_cm_get_scan_ie_params_cb: callback to get scan ie params
* @get_scan_ie_params_cb: callback to get scan ie params
* @set_hlp_data_cb: callback to legacy module to save hlp data
* @ft_preauth_complete_cb: callback to legacy module to send fast
* transition event

9
os_if/linux/mlme/inc/wlan_cfg80211_vdev_mlme.h
查看文件

@@ -1,5 +1,6 @@
/*
* Copyright (c) 2019 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
@@ -30,7 +31,7 @@
#include "include/wlan_vdev_mlme.h"
/**
* wlan_cfg80211_vdev_mlme_get_param_ssid() – cfg80211 MLME API to
* wlan_cfg80211_vdev_mlme_get_param_ssid() - cfg80211 MLME API to
* get ssid
* @vdev: pointer to vdev object
* @ssid: pointer to store the ssid
@@ -44,7 +45,7 @@ wlan_cfg80211_vdev_mlme_get_param_ssid(struct wlan_objmgr_vdev *vdev,
uint8_t *ssid_len);
/**
* wlan_cfg80211_vdev_mlme_get_trans_bssid() – cfg80211 MLME API to
* wlan_cfg80211_vdev_mlme_get_trans_bssid() - cfg80211 MLME API to
* get trans bssid
* @vdev: pointer to vdev object
* @addr: pointer to store the addr of the transmission bssid
@@ -56,7 +57,7 @@ wlan_cfg80211_vdev_mlme_get_trans_bssid(struct wlan_objmgr_vdev *vdev,
uint8_t *addr);
/**
* wlan_cfg80211_vdev_mlme_set_param() – cfg80211 MLME API to fill common
* wlan_cfg80211_vdev_mlme_set_param() - cfg80211 MLME API to fill common
* parameters of vdev_mlme object
* @vdev: pointer to vdev object
* @param_id: param id for which the value should be set
@@ -70,7 +71,7 @@ wlan_cfg80211_vdev_mlme_set_param(struct wlan_objmgr_vdev *vdev,
struct wlan_vdev_mgr_cfg mlme_cfg);
/**
* wlan_cfg80211_vdev_mlme_get_param() – cfg80211 MLME API to get common
* wlan_cfg80211_vdev_mlme_get_param() - cfg80211 MLME API to get common
* parameters of vdev_mlme object
* @vdev: pointer to vdev object
* @param_id: param id for which the value should be set

15
os_if/linux/mlme/src/osif_cm_connect_rsp.c
查看文件

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2012-2015, 2020-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 above
@@ -141,7 +141,7 @@ osif_get_connect_status_code(struct wlan_cm_connect_resp *rsp)
/**
* osif_convert_timeout_reason() - Convert to kernel specific enum
* @timeout_reason: reason for connect timeout
* @reason: reason for connect timeout
*
* This function is used to convert host timeout
* reason enum to kernel specific enum.
@@ -199,7 +199,8 @@ osif_connect_timeout(struct net_device *dev, const u8 *bssid,
* __osif_connect_bss() - API to send connection status to supplicant
* @dev: network device
* @bss: bss info
* @connect_rsp: Connection manager connect response
* @rsp: Connection manager connect response
* @status: 802.11 status code
*
* Context: Any context.
* Return: void
@@ -266,7 +267,7 @@ static void __osif_connect_bss(struct net_device *dev,
* osif_connect_bss() - API to send connection status to supplicant
* @dev: network device
* @bss: bss info
* @connect_rsp: Connection manager connect response
* @rsp: Connection manager connect response
*
* The API is a wrapper to send connection status to supplicant
*
@@ -314,7 +315,7 @@ static void osif_connect_bss(struct net_device *dev, struct cfg80211_bss *bss,
#if defined(CFG80211_FILS_SK_OFFLOAD_SUPPORT)
/**
* osif_populate_fils_params() - Populate FILS keys to connect response
* @conn_rsp_params: connect response to supplicant
* @rsp_params: connect response to supplicant
* @connect_ies: Connect response IEs
*
* Context: Any context.
@@ -349,7 +350,7 @@ osif_populate_fils_params(struct cfg80211_connect_resp_params *rsp_params,
#if defined(WLAN_FEATURE_FILS_SK)
/**
* osif_populate_fils_params() - Populate FILS keys to connect response
* @conn_rsp_params: connect response to supplicant
* @rsp_params: connect response to supplicant
* @connect_ies: Connect response IEs
*
* Context: Any context.
@@ -802,7 +803,7 @@ osif_connect_done(struct net_device *dev, struct cfg80211_bss *bss,
* supplicant.
* @dev: network device
* @bss: bss info
* @connect_rsp: Connection manager connect response
* @rsp: Connection manager connect response
* @vdev: pointer to vdev
*
* The API is a wrapper to send connection status to supplicant

33
os_if/linux/mlme/src/osif_cm_roam_rsp.c
查看文件

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2012-2015,2020-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 above
@@ -52,17 +52,6 @@ static inline void osif_update_fils_hlp_data(struct net_device *dev,
}
#endif
/**
* osif_roamed_ind() - send roamed indication to cfg80211
* @dev: network device
* @bss: cfg80211 roamed bss pointer
* @req_ie: IEs used in reassociation request
* @req_ie_len: Length of the @req_ie
* @resp_ie: IEs received in successful reassociation response
* @resp_ie_len: Length of @resp_ie
*
* Return: none
*/
#if defined CFG80211_ROAMED_API_UNIFIED || \
(LINUX_VERSION_CODE >= KERNEL_VERSION(4, 12, 0))
#ifdef CFG80211_SINGLE_NETDEV_MULTI_LINK_SUPPORT
@@ -196,6 +185,19 @@ static void osif_fill_mlo_roam_params(struct wlan_objmgr_vdev *vdev,
struct cfg80211_roam_info *info)
{}
#endif
/**
* osif_roamed_ind() - send roamed indication to cfg80211
* @dev: network device
* @vdev: vdev object
* @rsp: CM connect response
* @bss: cfg80211 roamed bss pointer
* @req_ie: IEs used in reassociation request
* @req_ie_len: Length of the @req_ie
* @resp_ie: IEs received in successful reassociation response
* @resp_ie_len: Length of @resp_ie
*
* Return: none
*/
static void osif_roamed_ind(struct net_device *dev,
struct wlan_objmgr_vdev *vdev,
struct wlan_cm_connect_resp *rsp,
@@ -232,7 +234,7 @@ static inline void osif_roamed_ind(struct net_device *dev,
#ifdef WLAN_FEATURE_ROAM_OFFLOAD
#ifdef WLAN_FEATURE_FILS_SK
/**
* wlan_hdd_add_fils_params_roam_auth_event() - Adds FILS params in roam auth
* osif_add_fils_params_roam_auth_event() - Adds FILS params in roam auth
* @skb: SK buffer
* @roam_info: Roam info
*
@@ -334,6 +336,7 @@ static uint8_t *osif_get_bss_mac_addr(struct wlan_objmgr_vdev *vdev)
* links event response to kernel
* @skb : sk buffer pointer
* @vdev: vdev pointer
* @osif_priv: osif vdev private data
* @rsp: Connection manager response
*
* This is called when wlan driver needs to send the mlo links roaming
@@ -443,6 +446,10 @@ osif_send_roam_auth_mlo_links_event(struct sk_buff *skb,
* @vdev: vdev pointer
* @osif_priv: OS private structure of vdev
* @rsp: Connection manager response
* @req_ie: request IE
* @req_ie_len: request IE length
* @resp_ie: response IE
* @resp_ie_len: response IE length
*
* This is called when wlan driver needs to send the roaming and
* authorization information after roaming.

15
os_if/linux/mlme/src/osif_cm_rsp.h
查看文件

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2012-2015,2020-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 above
@@ -47,7 +47,7 @@ QDF_STATUS osif_disconnect_handler(struct wlan_objmgr_vdev *vdev,
* osif_cm_get_assoc_req_ie_data() - Get the assoc req IE offset and length
* if valid assoc req is present
* @assoc_req: assoc req info
* @ie_data_len: IE date length to be calculated
* @ie_data_len: IE data length to be calculated
* @ie_data_ptr: IE data pointer to be calculated
*
* Return: void
@@ -59,8 +59,8 @@ void osif_cm_get_assoc_req_ie_data(struct element_info *assoc_req,
/**
* osif_cm_get_assoc_rsp_ie_data() - Get the assoc resp IE offset and length
* if valid assoc req is present
* @assoc_req: assoc req info
* @ie_data_len: IE date length to be calculated
* @assoc_rsp: assoc response info
* @ie_data_len: IE data length to be calculated
* @ie_data_ptr: IE data pointer to be calculated
*
* Return: void
@@ -99,7 +99,7 @@ void osif_indicate_reassoc_results(struct wlan_objmgr_vdev *vdev,
struct wlan_cm_connect_resp *rsp);
/**
* @osif_pmksa_candidate_notify_cb: Roam pmksa candidate notify callback
* osif_pmksa_candidate_notify() - Roam pmksa candidate notify callback
* @vdev: vdev pointer
* @bssid: bssid
* @index: index
@@ -161,7 +161,7 @@ osif_cm_indicate_disconnect(struct wlan_objmgr_vdev *vdev,
/**
* osif_get_partner_info_from_mlie() - API to get partner information
* from basic variant mlo ie
* @rsp: Connection manager connect response for the candidate
* @connect_rsp: Connection manager connect response for the candidate
* @partner_info: mlo partner info pointer
*
* The API is is used get partner information from basic variant ml ie.
@@ -172,11 +172,12 @@ osif_cm_indicate_disconnect(struct wlan_objmgr_vdev *vdev,
QDF_STATUS
osif_get_partner_info_from_mlie(struct wlan_cm_connect_resp *connect_rsp,
struct mlo_partner_info *partner_info);
/**
* osif_get_link_id_from_assoc_ml_ie() - API to get link id from assoc rsp
* ml ie.
* @rsp_link_info: pointer to mlo link info
* @partner_info: mlo partner info pointer
* @assoc_partner_info: mlo partner info pointer
* @link_id: Link id information
*
* The API is used to get link id from assoc response basic variant mlo ie

12
os_if/linux/mlme/src/osif_cm_util.c
查看文件

@@ -216,8 +216,8 @@ osif_cm_failed_candidate_cb(struct wlan_objmgr_vdev *vdev,
* osif_cm_update_id_and_src_cb() - Callback to update id and
* source of the connect/disconnect request
* @vdev: vdev pointer
* @Source: Source of the connect req
* @id: Connect/disconnect id
* @source: Source of the connect req
* @cm_id: Connect/disconnect id
*
* Context: Any context. Takes and releases cmd id spinlock
* Return: QDF_STATUS
@@ -244,7 +244,7 @@ osif_cm_update_id_and_src_cb(struct wlan_objmgr_vdev *vdev,
/**
* osif_cm_disconnect_complete_cb() - Disconnect done callback
* @vdev: vdev pointer
* @disconnect_rsp: Disconnect response
* @rsp: Disconnect response
*
* Context: Any context
* Return: QDF_STATUS
@@ -309,7 +309,7 @@ osif_cm_roam_sync_cb(struct wlan_objmgr_vdev *vdev)
}
/**
* @osif_pmksa_candidate_notify_cb: Roam pmksa candidate notify callback
* osif_pmksa_candidate_notify_cb() - Roam pmksa candidate notify callback
* @vdev: vdev pointer
* @bssid: bssid
* @index: index
@@ -328,6 +328,9 @@ osif_pmksa_candidate_notify_cb(struct wlan_objmgr_vdev *vdev,
/**
* osif_cm_send_keys_cb() - Send keys callback
* @vdev: vdev pointer
* @key_index: key index
* @pairwise: true if pairwise
* @cipher_type: cipher type
*
* This callback indicates os_if that
* so that os_if can stop all the activity on this connection
@@ -406,7 +409,6 @@ osif_cm_roam_abort_cb(struct wlan_objmgr_vdev *vdev)
/**
* osif_cm_roam_cmpl_cb() - Roam sync complete callback
* @vdev: vdev pointer
* @rsp: connect rsp
*
* This callback indicates os_if that roam sync is complete
* so that os_if can stop all the activity on this connection