xref: /wlan-driver/qca-wifi-host-cmn/wmi/inc/wmi_unified_dbr_api.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2013-2019 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name /**
20*5113495bSYour Name  * DOC: Implement API's specific to DBR component.
21*5113495bSYour Name  */
22*5113495bSYour Name 
23*5113495bSYour Name #ifndef _WMI_UNIFIED_DBR_API_H_
24*5113495bSYour Name #define _WMI_UNIFIED_DBR_API_H_
25*5113495bSYour Name 
26*5113495bSYour Name #include "wmi_unified_dbr_param.h"
27*5113495bSYour Name 
28*5113495bSYour Name /**
29*5113495bSYour Name  * wmi_unified_dbr_ring_cfg: Configure direct buffer rx rings
30*5113495bSYour Name  * @wmi_handle: WMI handle
31*5113495bSYour Name  * @cfg: pointer to direct buffer rx config request
32*5113495bSYour Name  *
33*5113495bSYour Name  * Return: QDF status of operation
34*5113495bSYour Name  */
35*5113495bSYour Name QDF_STATUS wmi_unified_dbr_ring_cfg(wmi_unified_t wmi_handle,
36*5113495bSYour Name 				    struct direct_buf_rx_cfg_req *cfg);
37*5113495bSYour Name 
38*5113495bSYour Name /**
39*5113495bSYour Name  * wmi_extract_dbr_buf_release_fixed : Extract direct buffer rx fixed param
40*5113495bSYour Name  *				     from buffer release event
41*5113495bSYour Name  * @wmi_handle: WMI handle
42*5113495bSYour Name  * @evt_buf: Event buffer
43*5113495bSYour Name  * @param: Pointer to direct buffer rx response struct
44*5113495bSYour Name  *
45*5113495bSYour Name  * Return: QDF status of operation
46*5113495bSYour Name  */
47*5113495bSYour Name QDF_STATUS wmi_extract_dbr_buf_release_fixed(
48*5113495bSYour Name 			wmi_unified_t wmi_handle,
49*5113495bSYour Name 			uint8_t *evt_buf,
50*5113495bSYour Name 			struct direct_buf_rx_rsp *param);
51*5113495bSYour Name 
52*5113495bSYour Name /**
53*5113495bSYour Name  * wmi_extract_dbr_buf_release_entry: Extract direct buffer rx buffer tlv
54*5113495bSYour Name  *
55*5113495bSYour Name  * @wmi_handle: WMI handle
56*5113495bSYour Name  * @evt_buf: Event buffer
57*5113495bSYour Name  * @idx: Index of the module for which capability is received
58*5113495bSYour Name  * @param: Pointer to direct buffer rx entry
59*5113495bSYour Name  *
60*5113495bSYour Name  * Return: QDF status of operation
61*5113495bSYour Name  */
62*5113495bSYour Name QDF_STATUS wmi_extract_dbr_buf_release_entry(
63*5113495bSYour Name 			wmi_unified_t wmi_handle,
64*5113495bSYour Name 			uint8_t *evt_buf, uint8_t idx,
65*5113495bSYour Name 			struct direct_buf_rx_entry *param);
66*5113495bSYour Name 
67*5113495bSYour Name /**
68*5113495bSYour Name  * wmi_extract_dbr_buf_metadata: Extract direct buffer metadata
69*5113495bSYour Name  *
70*5113495bSYour Name  * @wmi_handle: WMI handle
71*5113495bSYour Name  * @evt_buf: Event buffer
72*5113495bSYour Name  * @idx: Index of the module for which capability is received
73*5113495bSYour Name  * @param: Pointer to direct buffer metadata
74*5113495bSYour Name  *
75*5113495bSYour Name  * Return: QDF status of operation
76*5113495bSYour Name  */
77*5113495bSYour Name QDF_STATUS wmi_extract_dbr_buf_metadata(
78*5113495bSYour Name 			wmi_unified_t wmi_handle,
79*5113495bSYour Name 			uint8_t *evt_buf, uint8_t idx,
80*5113495bSYour Name 			struct direct_buf_rx_metadata *param);
81*5113495bSYour Name 
82*5113495bSYour Name /**
83*5113495bSYour Name  * wmi_extract_dbr_buf_cv_metadata: Extract direct buffer TxBF cbf cv metadata
84*5113495bSYour Name  *
85*5113495bSYour Name  * @wmi_handle: WMI handle
86*5113495bSYour Name  * @evt_buf: Event buffer
87*5113495bSYour Name  * @idx: Index of the module for which capability is received
88*5113495bSYour Name  * @param: Pointer to direct buffer cv metadata
89*5113495bSYour Name  *
90*5113495bSYour Name  * Return: QDF status of operation
91*5113495bSYour Name  */
92*5113495bSYour Name QDF_STATUS wmi_extract_dbr_buf_cv_metadata(
93*5113495bSYour Name 			wmi_unified_t wmi_handle,
94*5113495bSYour Name 			uint8_t *evt_buf, uint8_t idx,
95*5113495bSYour Name 			struct direct_buf_rx_cv_metadata *param);
96*5113495bSYour Name 
97*5113495bSYour Name /**
98*5113495bSYour Name  * wmi_extract_dbr_buf_cqi_metadata: Extract direct buffer TxBF cqi metadata
99*5113495bSYour Name  *
100*5113495bSYour Name  * @wmi_handle: WMI handle
101*5113495bSYour Name  * @evt_buf: Event buffer
102*5113495bSYour Name  * @idx: Index of the module for which capability is received
103*5113495bSYour Name  * @param: Pointer to direct buffer cqi metadata
104*5113495bSYour Name  *
105*5113495bSYour Name  * Return: QDF status of operation
106*5113495bSYour Name  */
107*5113495bSYour Name QDF_STATUS wmi_extract_dbr_buf_cqi_metadata(
108*5113495bSYour Name 			wmi_unified_t wmi_handle,
109*5113495bSYour Name 			uint8_t *evt_buf, uint8_t idx,
110*5113495bSYour Name 			struct direct_buf_rx_cqi_metadata *param);
111*5113495bSYour Name #endif /* _WMI_UNIFIED_DBR_API_H_ */
112