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

55
wmi/inc/wmi_unified_vdev_api.h
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2016-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
@@ -29,11 +29,11 @@
/**
* wmi_unified_peer_filter_set_tx_cmd_send() - WMI set tx peer filter function
* @param wmi_handle: handle to WMI.
* @param macaddr: MAC address
* @param param: pointer to hold peer filter parameter
* @wmi_handle: handle to WMI.
* @macaddr: MAC address
* @param: pointer to hold peer filter parameter
*
* @return QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
QDF_STATUS
wmi_unified_peer_filter_set_tx_cmd_send(struct wmi_unified *wmi_handle,
@@ -42,11 +42,11 @@ wmi_unified_peer_filter_set_tx_cmd_send(struct wmi_unified *wmi_handle,
/**
* wmi_unified_vdev_set_neighbour_rx_cmd_send() - WMI set neighbour rx function
* @param wmi_handle: handle to WMI.
* @param macaddr: MAC address
* @param param: pointer to hold neighbour rx parameter
* @wmi_handle: handle to WMI.
* @macaddr: MAC address
* @param: pointer to hold neighbour rx parameter
*
* @return QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
QDF_STATUS wmi_unified_vdev_set_neighbour_rx_cmd_send(
struct wmi_unified *wmi_handle,
@@ -55,10 +55,10 @@ QDF_STATUS wmi_unified_vdev_set_neighbour_rx_cmd_send(
/**
* wmi_unified_vdev_config_ratemask_cmd_send() - WMI config ratemask function
* @param wmi_handle: handle to WMI.
* @param param: pointer to hold config ratemask param
* @wmi_handle: handle to WMI.
* @param: pointer to hold config ratemask param
*
* @return QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
QDF_STATUS
wmi_unified_vdev_config_ratemask_cmd_send(struct wmi_unified *wmi_handle,
@@ -93,9 +93,8 @@ QDF_STATUS wmi_unified_send_multiple_vdev_set_param_cmd(
/**
* wmi_unified_beacon_send_cmd() - WMI beacon send function
* @param wmi_handle: handle to WMI.
* @param macaddr: MAC address
* @param param: pointer to hold beacon send cmd parameter
* @wmi_handle: handle to WMI.
* @param: pointer to hold beacon send cmd parameter
*
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
@@ -105,8 +104,8 @@ QDF_STATUS wmi_unified_beacon_send_cmd(struct wmi_unified *wmi_handle,
/**
* wmi_extract_vdev_start_resp() - extract vdev start response
* @wmi_handle: wmi handle
* @param evt_buf: pointer to event buffer
* @param vdev_rsp: Pointer to hold vdev response
* @evt_buf: pointer to event buffer
* @vdev_rsp: Pointer to hold vdev response
*
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
@@ -117,8 +116,8 @@ wmi_extract_vdev_start_resp(struct wmi_unified *wmi_handle, void *evt_buf,
/**
* wmi_extract_vdev_stopped_param() - extract vdev stop param from event
* @wmi_handle: wmi handle
* @param evt_buf: pointer to event buffer
* @param vdev_id: Pointer to hold vdev identifier
* @evt_buf: pointer to event buffer
* @vdev_id: Pointer to hold vdev identifier
*
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
@@ -129,8 +128,8 @@ wmi_extract_vdev_stopped_param(struct wmi_unified *wmi_handle, void *evt_buf,
/**
* wmi_extract_vdev_delete_resp() - extract vdev delete response
* @wmi_handle: wmi handle
* @param evt_buf: pointer to event buffer
* @param delete_rsp: Pointer to hold vdev delete response
* @evt_buf: pointer to event buffer
* @vdev_del_resp: Pointer to hold vdev delete response
*
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
@@ -142,8 +141,8 @@ wmi_extract_vdev_delete_resp(struct wmi_unified *wmi_handle, void *evt_buf,
* wmi_extract_vdev_peer_delete_all_response_event() - extract peer delete all
* response
* @wmi_handle: wmi handle
* @param evt_buf: pointer to event buffer
* @param delete_rsp: Pointer to hold peer delete all response
* @evt_buf: pointer to event buffer
* @delete_rsp: Pointer to hold peer delete all response
*
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
@@ -155,8 +154,8 @@ QDF_STATUS wmi_extract_vdev_peer_delete_all_response_event(
/**
* wmi_extract_ext_tbttoffset_num_vdevs() - extract ext tbtt offset num vdev
* @wmi_handle: wmi handle
* @param evt_buf: pointer to event buffer
* @param vdev_map: Pointer to hold num vdev
* @evt_buf: pointer to event buffer
* @num_vdevs: Pointer to hold num vdev
*
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
@@ -167,8 +166,8 @@ wmi_extract_ext_tbttoffset_num_vdevs(struct wmi_unified *wmi_handle,
/**
* wmi_extract_tbttoffset_num_vdevs() - extract tbtt offset num vdev
* @wmi_handle: wmi handle
* @param evt_buf: pointer to event buffer
* @param vdev_map: Pointer to hold num vdev
* @evt_buf: pointer to event buffer
* @num_vdevs: Pointer to hold num vdev
*
* Return: QDF_STATUS_SUCCESS on success and QDF_STATUS_E_FAILURE for failure
*/
@@ -204,7 +203,7 @@ wmi_unified_multisoc_tbtt_sync_cmd(wmi_unified_t wmi_handle,
#ifdef WLAN_FEATURE_SR
/**
* wmi_unified_vdev_param_sr_prohibit_send() - send vdev SR prohibit command
* @wmi: wmi handle
* @wmi_hdl: wmi handle
* @srp_param: SR Prohibit parameters
*
* Return: QDF_STATUS_SUCCESS for success or error code