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

qcacmn: Fix WMI documentation

Browse Source 
The kernel-doc script identified many documentation issues in
the wmi folder, so fix them.

Note that in quite a few cases there is duplicate documentation in .h
and .c files, and in those cases remove the documentation from the .c
files since the interface should be documented, not the
implementation.

Change-Id: I097d5b8e8f0ba09046b7b8abe338d05a00f8cc7e
CRs-Fixed: 3372831
This commit is contained in:
Jeff Johnson
2022-12-22 17:29:33 -08:00
committed by Madan Koyyalamudi
parent f75a30225c
commit 213581ab0b
37 changed files with 582 additions and 773 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
wmi/inc/wmi_unified_sta_api.h
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2013-2020 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
@@ -145,8 +145,8 @@ wmi_unified_wlm_latency_level_cmd(wmi_unified_t wmi_handle,
/**
* wmi_unified_process_set_ie_info_cmd() - Function to send IE info to firmware
* @wmi_handle: Pointer to WMi handle
* @ie_data: Pointer for ie data
* @wmi_handle: Pointer to WMI handle
* @ie_info: Pointer for IE information
*
* This function sends IE information to firmware
*
@@ -197,6 +197,7 @@ QDF_STATUS wmi_unified_update_fw_tdls_state_cmd(wmi_unified_t wmi_handle,
* wmi_unified_update_tdls_peer_state_cmd() - update TDLS peer state
* @wmi_handle: wmi handle
* @peer_state: TDLS peer state params
* @ch_mhz: peer channel list
*
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
@@ -259,9 +260,9 @@ QDF_STATUS wmi_unified_extract_sar_limit_event(wmi_unified_t wmi_handle,
QDF_STATUS wmi_unified_extract_sar2_result_event(void *handle,
uint8_t *event, uint32_t len);
/*
/**
* wmi_unified_set_del_pmkid_cache() - set delete PMKID
* @wmi_handle: wma handle
* @wmi_handle: wmi handle
* @pmksa: pointer to pmk cache entry
*
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
@@ -398,7 +399,7 @@ QDF_STATUS wmi_unified_pdev_set_dual_mac_config_cmd(
/**
* wmi_unified_send_adapt_dwelltime_params_cmd() - send wmi cmd of
* adaptive dwelltime configuration params
* @wma_handle: wma handler
* @wmi_handle: wmi handler
* @wmi_param: pointer to dwelltime_params
*
* Return: QDF_STATUS_SUCCESS on success and QDF failure reason code for failure
@@ -410,7 +411,7 @@ QDF_STATUS wmi_unified_send_adapt_dwelltime_params_cmd(
/**
* wmi_unified_send_dbs_scan_sel_params_cmd() - send wmi cmd of
* DBS scan selection configuration params
* @wma_handle: wma handler
* @wmi_handle: wmi handler
* @wmi_param: pointer to wmi_dbs_scan_sel_params
*
* Return: QDF_STATUS_SUCCESS on success and QDF failure reason code for failure