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

23
wmi/inc/wmi_unified_nan_api.h
View File

@@ -1,6 +1,6 @@
/*
* Copyright (c) 2013-2020 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
@@ -90,7 +90,7 @@ QDF_STATUS wmi_unified_terminate_all_ndps_req_cmd(wmi_unified_t wmi_handle,
/**
* wmi_extract_ndp_initiator_rsp - api to extract initiator rsp from even buffer
* @wmi_hdl: wmi handle
* @wmi_handle: wmi handle
* @data: event buffer
* @rsp: buffer to populate
*
@@ -102,7 +102,7 @@ wmi_extract_ndp_initiator_rsp(wmi_unified_t wmi_handle, uint8_t *data,
/**
* wmi_extract_ndp_ind - api to extract ndp indication struct from even buffer
* @wmi_hdl: wmi handle
* @wmi_handle: wmi handle
* @data: event buffer
* @ind: buffer to populate
*
@@ -113,6 +113,7 @@ QDF_STATUS wmi_extract_ndp_ind(wmi_unified_t wmi_handle, uint8_t *data,
/**
* wmi_extract_nan_msg - api to extract ndp dmesg buffer to print logs
* @wmi_handle: wmi handle
* @data: event buffer
* @msg: buffer to populate
*
@@ -123,7 +124,7 @@ QDF_STATUS wmi_extract_nan_msg(wmi_unified_t wmi_handle, uint8_t *data,
/**
* wmi_extract_ndp_confirm - api to extract ndp confim struct from even buffer
* @wmi_hdl: wmi handle
* @wmi_handle: wmi handle
* @data: event buffer
* @ev: buffer to populate
*
@@ -134,7 +135,7 @@ QDF_STATUS wmi_extract_ndp_confirm(wmi_unified_t wmi_handle, uint8_t *data,
/**
* wmi_extract_ndp_responder_rsp - api to extract responder rsp from even buffer
* @wmi_hdl: wmi handle
* @wmi_handle: wmi handle
* @data: event buffer
* @rsp: buffer to populate
*
@@ -146,7 +147,7 @@ wmi_extract_ndp_responder_rsp(wmi_unified_t wmi_handle, uint8_t *data,
/**
* wmi_extract_ndp_end_rsp - api to extract ndp end rsp from even buffer
* @wmi_hdl: wmi handle
* @wmi_handle: wmi handle
* @data: event buffer
* @rsp: buffer to populate
*
@@ -157,7 +158,7 @@ QDF_STATUS wmi_extract_ndp_end_rsp(wmi_unified_t wmi_handle, uint8_t *data,
/**
* wmi_extract_ndp_end_ind - api to extract ndp end indication from even buffer
* @wmi_hdl: wmi handle
* @wmi_handle: wmi handle
* @data: event buffer
* @ind: buffer to populate
*
@@ -169,7 +170,7 @@ wmi_extract_ndp_end_ind(wmi_unified_t wmi_handle, uint8_t *data,
/**
* wmi_extract_ndp_sch_update - api to extract ndp sch update from event buffer
* @wmi_hdl: wmi handle
* @wmi_handle: wmi handle
* @data: event buffer
* @ind: buffer to populate
*
@@ -181,8 +182,8 @@ wmi_extract_ndp_sch_update(wmi_unified_t wmi_handle, uint8_t *data,
/**
* wmi_extract_nan_event_rsp - api to extract nan event into event parameters
* @wmi_hdl: wmi handle
* @wvt_buf: pointer to the event buffer
* @wmi_handle: wmi handle
* @evt_buf: pointer to the event buffer
* @temp_evt_params: Pointer to a temporary parameters structure to populate
* @nan_msg_buf: Pointer to the NAN Message buffer encapsulated in the event
*
@@ -194,7 +195,7 @@ QDF_STATUS wmi_extract_nan_event_rsp(wmi_unified_t wmi_handle, void *evt_buf,
/**
* wmi_extract_ndp_host_event - api to extract ndp event from event buffer
* @wmi_hdl: wmi handle
* @wmi_handle: wmi handle
* @data: event buffer
* @evt: event buffer to populate
*