213581ab0b
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
132 lines
3.8 KiB
C
132 lines
3.8 KiB
C
/*
|
|
* Copyright (c) 2017-2019, 2021 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
|
|
* above copyright notice and this permission notice appear in all
|
|
* copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
|
|
* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
|
|
* WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
|
|
* AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
|
|
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
|
|
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
* PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
/**
|
|
* DOC: This file contains the API definitions for the Unified Wireless Module
|
|
* Interface (WMI) which are specific to DFS module.
|
|
*/
|
|
|
|
#ifndef _WMI_UNIFIED_DFS_API_H_
|
|
#define _WMI_UNIFIED_DFS_API_H_
|
|
|
|
#include <wlan_objmgr_vdev_obj.h>
|
|
#include <wlan_dfs_utils_api.h>
|
|
|
|
/**
|
|
* wmi_extract_dfs_cac_complete_event() - function to handle cac complete event
|
|
* @wmi_handle: wmi handle
|
|
* @evt_buf: event buffer
|
|
* @vdev_id: vdev id
|
|
* @len: length of buffer
|
|
*
|
|
* Return: 0 for success or error code
|
|
*/
|
|
QDF_STATUS wmi_extract_dfs_cac_complete_event(
|
|
wmi_unified_t wmi_handle,
|
|
uint8_t *evt_buf,
|
|
uint32_t *vdev_id,
|
|
uint32_t len);
|
|
|
|
/**
|
|
* wmi_extract_dfs_ocac_complete_event() - function to handle off channel
|
|
* CAC complete event
|
|
* @wmi_handle: wmi handle
|
|
* @evt_buf: event buffer
|
|
* @param: off channel cac complete params
|
|
*
|
|
* Return: 0 for success or error code
|
|
*/
|
|
QDF_STATUS
|
|
wmi_extract_dfs_ocac_complete_event(wmi_unified_t wmi_handle, uint8_t *evt_buf,
|
|
struct vdev_adfs_complete_status *param);
|
|
|
|
/**
|
|
* wmi_extract_dfs_radar_detection_event() - function to handle radar event
|
|
* @wmi_handle: wmi handle
|
|
* @evt_buf: event buffer
|
|
* @radar_found: radar found event info
|
|
* @len: length of buffer
|
|
*
|
|
* Return: 0 for success or error code
|
|
*/
|
|
QDF_STATUS wmi_extract_dfs_radar_detection_event(
|
|
wmi_unified_t wmi_handle,
|
|
uint8_t *evt_buf,
|
|
struct radar_found_info *radar_found,
|
|
uint32_t len);
|
|
|
|
#ifdef MOBILE_DFS_SUPPORT
|
|
/**
|
|
* wmi_extract_wlan_radar_event_info() - function to handle radar pulse event.
|
|
* @wmi_handle: wmi handle
|
|
* @evt_buf: event buffer
|
|
* @wlan_radar_event: pointer to radar event info structure
|
|
* @len: length of buffer
|
|
*
|
|
* Return: QDF_STATUS
|
|
*/
|
|
QDF_STATUS wmi_extract_wlan_radar_event_info(
|
|
wmi_unified_t wmi_handle,
|
|
uint8_t *evt_buf,
|
|
struct radar_event_info *wlan_radar_event,
|
|
uint32_t len);
|
|
#endif
|
|
|
|
#if defined(WLAN_DFS_FULL_OFFLOAD) && defined(QCA_DFS_NOL_OFFLOAD)
|
|
/**
|
|
* wmi_send_usenol_pdev_param() - function to send usenol pdev param.
|
|
* @wmi_handle: wmi handle
|
|
* @usenol: value of usenol
|
|
* @pdev: pointer to objmgr_pdev structure
|
|
*
|
|
* Return: QDF_STATUS
|
|
*/
|
|
QDF_STATUS wmi_send_usenol_pdev_param(wmi_unified_t wmi_handle, bool usenol,
|
|
struct wlan_objmgr_pdev *pdev);
|
|
|
|
/**
|
|
* wmi_send_subchan_marking_pdev_param() - Function to send subchannel
|
|
* marking pdev param.
|
|
* @wmi_handle: WMI handle.
|
|
* @subchanmark: Value of use subchannel marking.
|
|
* @pdev: Pointer to objmgr_pdev structure.
|
|
*
|
|
* Return: QDF_STATUS
|
|
*/
|
|
QDF_STATUS
|
|
wmi_send_subchan_marking_pdev_param(wmi_unified_t wmi_handle,
|
|
bool subchanmark,
|
|
struct wlan_objmgr_pdev *pdev);
|
|
#else
|
|
static inline QDF_STATUS
|
|
wmi_send_usenol_pdev_param(wmi_unified_t wmi_hdl, bool usenol,
|
|
struct wlan_objmgr_pdev *pdev)
|
|
{
|
|
return QDF_STATUS_SUCCESS;
|
|
}
|
|
|
|
static inline QDF_STATUS
|
|
wmi_send_subchan_marking_pdev_param(wmi_unified_t wmi_handle,
|
|
bool subchanmark,
|
|
struct wlan_objmgr_pdev *pdev)
|
|
{
|
|
return QDF_STATUS_SUCCESS;
|
|
}
|
|
#endif
|
|
#endif /* _WMI_UNIFIED_DFS_API_H_ */
|