xref: /wlan-driver/qca-wifi-host-cmn/umac/twt/dispatcher/inc/wlan_twt_api.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name /**
19*5113495bSYour Name  * DOC: wlan_twt_api.h
20*5113495bSYour Name  */
21*5113495bSYour Name #ifndef _WLAN_TWT_API_H_
22*5113495bSYour Name #define _WLAN_TWT_API_H_
23*5113495bSYour Name 
24*5113495bSYour Name #if defined(WLAN_SUPPORT_TWT) && defined(WLAN_TWT_CONV_SUPPORTED)
25*5113495bSYour Name #include <wlan_objmgr_psoc_obj.h>
26*5113495bSYour Name #include <wlan_objmgr_global_obj.h>
27*5113495bSYour Name #include <wlan_lmac_if_def.h>
28*5113495bSYour Name #include <wlan_twt_public_structs.h>
29*5113495bSYour Name 
30*5113495bSYour Name #define twt_alert(params...) \
31*5113495bSYour Name 	QDF_TRACE_FATAL(QDF_MODULE_ID_TWT, params)
32*5113495bSYour Name #define twt_err(params...) \
33*5113495bSYour Name 	QDF_TRACE_ERROR(QDF_MODULE_ID_TWT, params)
34*5113495bSYour Name #define twt_warn(params...) \
35*5113495bSYour Name 	QDF_TRACE_WARN(QDF_MODULE_ID_TWT, params)
36*5113495bSYour Name #define twt_notice(params...) \
37*5113495bSYour Name 	QDF_TRACE_INFO(QDF_MODULE_ID_TWT, params)
38*5113495bSYour Name #define twt_debug(params...) \
39*5113495bSYour Name 	QDF_TRACE_DEBUG(QDF_MODULE_ID_TWT, params)
40*5113495bSYour Name 
41*5113495bSYour Name #define twt_nofl_alert(params...) \
42*5113495bSYour Name 	QDF_TRACE_FATAL_NO_FL(QDF_MODULE_ID_TWT, params)
43*5113495bSYour Name #define twt_nofl_err(params...) \
44*5113495bSYour Name 	QDF_TRACE_ERROR_NO_FL(QDF_MODULE_ID_TWT, params)
45*5113495bSYour Name #define twt_nofl_warn(params...) \
46*5113495bSYour Name 	QDF_TRACE_WARN_NO_FL(QDF_MODULE_ID_TWT, params)
47*5113495bSYour Name #define twt_nofl_notice(params...) \
48*5113495bSYour Name 	QDF_TRACE_INFO_NO_FL(QDF_MODULE_ID_TWT, params)
49*5113495bSYour Name #define twt_nofl_debug(params...) \
50*5113495bSYour Name 	QDF_TRACE_DEBUG_NO_FL(QDF_MODULE_ID_TWT, params)
51*5113495bSYour Name 
52*5113495bSYour Name /**
53*5113495bSYour Name  * twt_psoc_enable() - twt psoc enable
54*5113495bSYour Name  * @psoc: psoc handle
55*5113495bSYour Name  *
56*5113495bSYour Name  * return: QDF_STATUS
57*5113495bSYour Name  */
58*5113495bSYour Name QDF_STATUS twt_psoc_enable(struct wlan_objmgr_psoc *psoc);
59*5113495bSYour Name 
60*5113495bSYour Name /**
61*5113495bSYour Name  * twt_psoc_disable() - twt psoc disable
62*5113495bSYour Name  * @psoc: psoc handle
63*5113495bSYour Name  *
64*5113495bSYour Name  * return: QDF_STATUS
65*5113495bSYour Name  */
66*5113495bSYour Name QDF_STATUS twt_psoc_disable(struct wlan_objmgr_psoc *psoc);
67*5113495bSYour Name 
68*5113495bSYour Name /**
69*5113495bSYour Name  * wlan_twt_init() - twt init
70*5113495bSYour Name  *
71*5113495bSYour Name  * return: QDF_STATUS
72*5113495bSYour Name  */
73*5113495bSYour Name QDF_STATUS wlan_twt_init(void);
74*5113495bSYour Name 
75*5113495bSYour Name /**
76*5113495bSYour Name  * wlan_twt_deinit() - twt de-init
77*5113495bSYour Name  *
78*5113495bSYour Name  * return: QDF_STATUS
79*5113495bSYour Name  */
80*5113495bSYour Name QDF_STATUS wlan_twt_deinit(void);
81*5113495bSYour Name 
82*5113495bSYour Name /**
83*5113495bSYour Name  * wlan_twt_get_tx_ops() - get tx ops
84*5113495bSYour Name  * @psoc: psoc handle
85*5113495bSYour Name  *
86*5113495bSYour Name  * return: QDF_STATUS
87*5113495bSYour Name  */
88*5113495bSYour Name struct wlan_lmac_if_twt_tx_ops *
89*5113495bSYour Name wlan_twt_get_tx_ops(struct wlan_objmgr_psoc *psoc);
90*5113495bSYour Name 
91*5113495bSYour Name /**
92*5113495bSYour Name  * wlan_twt_get_rx_ops() - get rx ops
93*5113495bSYour Name  * @psoc: psoc handle
94*5113495bSYour Name  *
95*5113495bSYour Name  * return: QDF_STATUS
96*5113495bSYour Name  */
97*5113495bSYour Name struct wlan_lmac_if_twt_rx_ops *
98*5113495bSYour Name wlan_twt_get_rx_ops(struct wlan_objmgr_psoc *psoc);
99*5113495bSYour Name 
100*5113495bSYour Name /**
101*5113495bSYour Name  * wlan_twt_psoc_get_comp_private_obj() - get twt priv obj
102*5113495bSYour Name  * @psoc: psoc handle
103*5113495bSYour Name  *
104*5113495bSYour Name  * return: QDF_STATUS
105*5113495bSYour Name  */
106*5113495bSYour Name struct twt_psoc_priv_obj*
107*5113495bSYour Name wlan_twt_psoc_get_comp_private_obj(struct wlan_objmgr_psoc *psoc);
108*5113495bSYour Name 
109*5113495bSYour Name /**
110*5113495bSYour Name  * wlan_set_peer_twt_capabilities() - set peer twt capabilities
111*5113495bSYour Name  * @psoc: psoc handle
112*5113495bSYour Name  * @peer_mac: peer mac address
113*5113495bSYour Name  * @peer_cap: TWT peer capability bitmap. Refer enum
114*5113495bSYour Name  * wlan_twt_capabilities for representation.
115*5113495bSYour Name  *
116*5113495bSYour Name  * return: QDF_STATUS
117*5113495bSYour Name  */
118*5113495bSYour Name QDF_STATUS
119*5113495bSYour Name wlan_set_peer_twt_capabilities(struct wlan_objmgr_psoc *psoc,
120*5113495bSYour Name 			       struct qdf_mac_addr *peer_mac,
121*5113495bSYour Name 			       uint8_t peer_cap);
122*5113495bSYour Name /**
123*5113495bSYour Name  * wlan_twt_psoc_set_pmo_enable() - twt psoc set enable
124*5113495bSYour Name  * @psoc: psoc handle
125*5113495bSYour Name  * @reason: twt enable reason
126*5113495bSYour Name  *
127*5113495bSYour Name  * return: QDF_STATUS
128*5113495bSYour Name  */
129*5113495bSYour Name QDF_STATUS
130*5113495bSYour Name wlan_twt_psoc_set_pmo_enable(struct wlan_objmgr_psoc *psoc,
131*5113495bSYour Name 			     enum twt_disable_reason reason);
132*5113495bSYour Name /**
133*5113495bSYour Name  * wlan_twt_psoc_set_pmo_disable() - twt psoc set disable
134*5113495bSYour Name  * @psoc: psoc handle
135*5113495bSYour Name  * @reason: twt disable reason
136*5113495bSYour Name  *
137*5113495bSYour Name  *  return: QDF_STATUS
138*5113495bSYour Name  */
139*5113495bSYour Name QDF_STATUS
140*5113495bSYour Name wlan_twt_psoc_set_pmo_disable(struct wlan_objmgr_psoc *psoc,
141*5113495bSYour Name 			      enum twt_disable_reason reason);
142*5113495bSYour Name 
143*5113495bSYour Name #else
144*5113495bSYour Name static inline
twt_psoc_enable(struct wlan_objmgr_psoc * psoc)145*5113495bSYour Name QDF_STATUS twt_psoc_enable(struct wlan_objmgr_psoc *psoc)
146*5113495bSYour Name {
147*5113495bSYour Name 	return QDF_STATUS_SUCCESS;
148*5113495bSYour Name }
149*5113495bSYour Name 
150*5113495bSYour Name static inline
twt_psoc_disable(struct wlan_objmgr_psoc * psoc)151*5113495bSYour Name QDF_STATUS twt_psoc_disable(struct wlan_objmgr_psoc *psoc)
152*5113495bSYour Name {
153*5113495bSYour Name 	return QDF_STATUS_SUCCESS;
154*5113495bSYour Name }
155*5113495bSYour Name 
156*5113495bSYour Name static inline
wlan_twt_init(void)157*5113495bSYour Name QDF_STATUS wlan_twt_init(void)
158*5113495bSYour Name {
159*5113495bSYour Name 	return QDF_STATUS_SUCCESS;
160*5113495bSYour Name }
161*5113495bSYour Name 
162*5113495bSYour Name static inline
wlan_twt_deinit(void)163*5113495bSYour Name QDF_STATUS wlan_twt_deinit(void)
164*5113495bSYour Name {
165*5113495bSYour Name 	return QDF_STATUS_SUCCESS;
166*5113495bSYour Name }
167*5113495bSYour Name 
168*5113495bSYour Name static inline
wlan_set_peer_twt_capabilities(struct wlan_objmgr_psoc * psoc,struct qdf_mac_addr * peer_mac,uint8_t peer_cap)169*5113495bSYour Name QDF_STATUS wlan_set_peer_twt_capabilities(struct wlan_objmgr_psoc *psoc,
170*5113495bSYour Name 					  struct qdf_mac_addr *peer_mac,
171*5113495bSYour Name 					  uint8_t peer_cap)
172*5113495bSYour Name {
173*5113495bSYour Name 	return QDF_STATUS_SUCCESS;
174*5113495bSYour Name }
175*5113495bSYour Name 
176*5113495bSYour Name QDF_STATUS
177*5113495bSYour Name wlan_twt_psoc_set_pmo_enable(struct wlan_objmgr_psoc *psoc,
178*5113495bSYour Name 			     enum twt_disable_reason reason);
179*5113495bSYour Name 
180*5113495bSYour Name QDF_STATUS
181*5113495bSYour Name wlan_twt_psoc_set_pmo_disable(struct wlan_objmgr_psoc *psoc,
182*5113495bSYour Name 			      enum twt_disable_reason reason);
183*5113495bSYour Name #endif
184*5113495bSYour Name #endif /* _WLAN_TWT_API_H_ */
185