samsung-sm8650/android_kernel_samsung_sm8650-modules
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

qcacld-3.0: Fix WMI Documentation

Browse Source 
The kernel-doc script identified multiple documentation issues
in components/wmi, so fix them.

Change-Id: Ic5bc41350ef846de91a1001d6fe1d28016e0f982
CRs-Fixed: 3361701
This commit is contained in:
Jeff Johnson
2023-01-04 13:02:44 -08:00
committed by Madan Koyyalamudi
parent ec471e92f2
commit d78ed5cc16
3 changed files with 34 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
components/wmi/inc/wmi_unified_roam_api.h
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2013-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
@@ -202,7 +202,7 @@ QDF_STATUS wmi_unified_roam_synch_complete_cmd(wmi_unified_t wmi_handle,
uint8_t vdev_id);
/**
* wmi_unified__roam_invoke_cmd() - send roam invoke command to fw.
* wmi_unified_roam_invoke_cmd() - send roam invoke command to fw.
* @wmi_handle: wmi handle
* @roaminvoke: roam invoke command
*
@@ -229,8 +229,8 @@ QDF_STATUS wmi_unified_set_roam_triggers(wmi_unified_t wmi_handle,
/**
* wmi_unified_send_disconnect_roam_params() - Send disconnect roam trigger
* parameters to firmware
* @wmi_hdl: wmi handle
* @params: pointer to wlan_roam_disconnect_params
* @wmi_handle: wmi handle
* @req: pointer to wlan_roam_disconnect_params
*
* Return: QDF_STATUS
*/
@@ -256,8 +256,8 @@ QDF_STATUS wmi_unified_roam_vendor_handoff_req_cmd(wmi_unified_t wmi_handle,
/**
* wmi_unified_send_idle_roam_params() - Send idle roam trigger params to fw
* @wmi_hdl: wmi handle
* @params: pointer to wlan_roam_idle_params
* @wmi_handle: wmi handle
* @req: pointer to wlan_roam_idle_params
*
* Return: QDF_STATUS
*/
@@ -295,7 +295,7 @@ QDF_STATUS wmi_unified_vdev_set_pcl_cmd(wmi_unified_t wmi_handle,
* @wmi_handle: WMI handle
* @evt_buf: Event buffer
* @len: evt buffer data len
* @synd_ind: roam sync ptr
* @sync_ind: roam sync ptr
*
* This api will allocate memory for roam sync info, extract
* the information sent by FW and pass to CM.The memory will be
@@ -440,7 +440,7 @@ wmi_unified_extract_roam_extract_frame_info(wmi_unified_t wmi, void *evt_buf,
* @wmi_handle: WMI handle
* @event: Event data received from firmware
* @data_len: Event data length received from firmware
* @roam_event: Extract the event and fill in auth_event
* @auth_event: Extract the event and fill in auth_event
*
* Return: QDF_STATUS
*/
@@ -493,7 +493,6 @@ wmi_unified_roam_mlo_config_cmd(wmi_unified_t wmi_handle,
/**
* wmi_unified_roam_scan_offload_mode_cmd() - set roam scan parameters
* @wmi_handle: wmi handle
* @scan_cmd_fp: scan related parameters
* @rso_cfg: roam scan offload parameters
*
* This function reads the incoming @rso_cfg and fill in the destination