xref: /wlan-driver/qcacld-3.0/core/wma/inc/wma_twt.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019-2021 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 2021-2022 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 #ifndef __WMA_TWT_H
21*5113495bSYour Name #define __WMA_TWT_H
22*5113495bSYour Name 
23*5113495bSYour Name #include "wma.h"
24*5113495bSYour Name #include "wmi_unified_twt_param.h"
25*5113495bSYour Name 
26*5113495bSYour Name /**
27*5113495bSYour Name  * struct twt_enable_disable_conf - TWT enable/disable configuration/parameters
28*5113495bSYour Name  * @congestion_timeout: Congestion timer value in ms for firmware controlled TWT
29*5113495bSYour Name  * @bcast_en: If bcast TWT enabled
30*5113495bSYour Name  * @ext_conf_present: If extended config is present
31*5113495bSYour Name  * @role: The configuration is for WMI_TWT_ROLE
32*5113495bSYour Name  * @oper: The configuration is for WMI_TWT_OPERATION
33*5113495bSYour Name  */
34*5113495bSYour Name struct twt_enable_disable_conf {
35*5113495bSYour Name 	uint32_t congestion_timeout;
36*5113495bSYour Name 	bool bcast_en;
37*5113495bSYour Name 	bool ext_conf_present;
38*5113495bSYour Name 	enum WMI_TWT_ROLE role;
39*5113495bSYour Name 	enum WMI_TWT_OPERATION oper;
40*5113495bSYour Name };
41*5113495bSYour Name 
42*5113495bSYour Name /**
43*5113495bSYour Name  * struct wma_twt_add_dialog_complete_event - TWT add dialog complete event
44*5113495bSYour Name  * @params: Fixed parameters for TWT add dialog complete event
45*5113495bSYour Name  * @additional_params: additional parameters for TWT add dialog complete event
46*5113495bSYour Name  *
47*5113495bSYour Name  * Holds the fixed and additional parameters from add dialog
48*5113495bSYour Name  * complete event
49*5113495bSYour Name  */
50*5113495bSYour Name struct wma_twt_add_dialog_complete_event {
51*5113495bSYour Name 	struct wmi_twt_add_dialog_complete_event_param params;
52*5113495bSYour Name 	struct wmi_twt_add_dialog_additional_params additional_params;
53*5113495bSYour Name };
54*5113495bSYour Name 
55*5113495bSYour Name #ifdef WLAN_SUPPORT_TWT
56*5113495bSYour Name /**
57*5113495bSYour Name  * wma_send_twt_enable_cmd() - Send TWT Enable command to firmware
58*5113495bSYour Name  * @pdev_id: pdev id
59*5113495bSYour Name  * @conf: Pointer to twt_enable_disable_conf
60*5113495bSYour Name  *
61*5113495bSYour Name  * Return: None
62*5113495bSYour Name  */
63*5113495bSYour Name void wma_send_twt_enable_cmd(uint32_t pdev_id,
64*5113495bSYour Name 			     struct twt_enable_disable_conf *conf);
65*5113495bSYour Name 
66*5113495bSYour Name /**
67*5113495bSYour Name  * wma_set_twt_peer_caps() - Fill the peer TWT capabilities
68*5113495bSYour Name  * @params: STA context params which will store the capabilities
69*5113495bSYour Name  * @cmd: Command in which the capabilities should be populated
70*5113495bSYour Name  *
71*5113495bSYour Name  * Return: None
72*5113495bSYour Name  */
73*5113495bSYour Name void wma_set_twt_peer_caps(tpAddStaParams params,
74*5113495bSYour Name 			   struct peer_assoc_params *cmd);
75*5113495bSYour Name 
76*5113495bSYour Name /**
77*5113495bSYour Name  * wma_send_twt_disable_cmd() - Send TWT disable command to firmware
78*5113495bSYour Name  * @pdev_id: pdev id
79*5113495bSYour Name  * @conf: Pointer to twt_enable_disable_conf
80*5113495bSYour Name  *
81*5113495bSYour Name  * Return: None
82*5113495bSYour Name  */
83*5113495bSYour Name void wma_send_twt_disable_cmd(uint32_t pdev_id,
84*5113495bSYour Name 			      struct twt_enable_disable_conf *conf);
85*5113495bSYour Name 
86*5113495bSYour Name /**
87*5113495bSYour Name  * wma_twt_process_add_dialog() - Process twt add dialog command
88*5113495bSYour Name  * @wma_handle: wma handle
89*5113495bSYour Name  * @params: add dialog configuration parameters
90*5113495bSYour Name  *
91*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, other QDF_STATUS error code
92*5113495bSYour Name  * on failure
93*5113495bSYour Name  */
94*5113495bSYour Name 
95*5113495bSYour Name QDF_STATUS wma_twt_process_add_dialog(t_wma_handle *wma_handle,
96*5113495bSYour Name 				      struct wmi_twt_add_dialog_param *params);
97*5113495bSYour Name 
98*5113495bSYour Name /**
99*5113495bSYour Name  * wma_twt_process_del_dialog() - Process del dialog command
100*5113495bSYour Name  * @wma_handle: wma handle
101*5113495bSYour Name  * @params: del dialog configuration parameters
102*5113495bSYour Name  *
103*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, other QDF_STATUS error code
104*5113495bSYour Name  * on failure
105*5113495bSYour Name  */
106*5113495bSYour Name QDF_STATUS wma_twt_process_del_dialog(t_wma_handle *wma_handle,
107*5113495bSYour Name 				      struct wmi_twt_del_dialog_param *params);
108*5113495bSYour Name 
109*5113495bSYour Name /**
110*5113495bSYour Name  * wma_twt_process_pause_dialog() - Process pause dialog command
111*5113495bSYour Name  * @wma_handle: wma handle
112*5113495bSYour Name  * @params: pause dialog configuration parameters
113*5113495bSYour Name  *
114*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, other QDF_STATUS error code
115*5113495bSYour Name  * on failure
116*5113495bSYour Name  */
117*5113495bSYour Name QDF_STATUS
118*5113495bSYour Name wma_twt_process_pause_dialog(t_wma_handle *wma_handle,
119*5113495bSYour Name 			     struct wmi_twt_pause_dialog_cmd_param *params);
120*5113495bSYour Name 
121*5113495bSYour Name /**
122*5113495bSYour Name  * wma_twt_process_nudge_dialog() - Process nudge dialog command
123*5113495bSYour Name  * @wma_handle: wma handle
124*5113495bSYour Name  * @params: nudge dialog configuration parameters
125*5113495bSYour Name  *
126*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, other QDF_STATUS error code
127*5113495bSYour Name  * on failure
128*5113495bSYour Name  */
129*5113495bSYour Name QDF_STATUS
130*5113495bSYour Name wma_twt_process_nudge_dialog(t_wma_handle *wma_handle,
131*5113495bSYour Name 			     struct wmi_twt_nudge_dialog_cmd_param *params);
132*5113495bSYour Name 
133*5113495bSYour Name /**
134*5113495bSYour Name  * wma_twt_process_resume_dialog() - Process resume dialog command
135*5113495bSYour Name  * @wma_handle: wma handle
136*5113495bSYour Name  * @params: resume dialog configuration parameters
137*5113495bSYour Name  *
138*5113495bSYour Name  * Return: QDF_STATUS_SUCCESS on success, other QDF_STATUS error code
139*5113495bSYour Name  * on failure
140*5113495bSYour Name  */
141*5113495bSYour Name QDF_STATUS
142*5113495bSYour Name wma_twt_process_resume_dialog(t_wma_handle *wma_handle,
143*5113495bSYour Name 			      struct wmi_twt_resume_dialog_cmd_param *params);
144*5113495bSYour Name 
145*5113495bSYour Name /**
146*5113495bSYour Name  * wma_update_bcast_twt_support() - update bcost twt support
147*5113495bSYour Name  * @wh: wma handle
148*5113495bSYour Name  * @tgt_cfg: target configuration to be updated
149*5113495bSYour Name  *
150*5113495bSYour Name  * Update braodcast twt support based on service bit.
151*5113495bSYour Name  *
152*5113495bSYour Name  * Return: None
153*5113495bSYour Name  */
154*5113495bSYour Name void wma_update_bcast_twt_support(tp_wma_handle wh,
155*5113495bSYour Name 				  struct wma_tgt_cfg *tgt_cfg);
156*5113495bSYour Name 
157*5113495bSYour Name /**
158*5113495bSYour Name  * wma_update_twt_tgt_cap()- update the supported twt capabilities
159*5113495bSYour Name  * @wh: wma handle
160*5113495bSYour Name  * @tgt_cfg: target configuration to be updated
161*5113495bSYour Name  *
162*5113495bSYour Name  * Update support for twt capabilities based on service bit.
163*5113495bSYour Name  *
164*5113495bSYour Name  * Return: None
165*5113495bSYour Name  */
166*5113495bSYour Name void wma_update_twt_tgt_cap(tp_wma_handle wh, struct wma_tgt_cfg *tgt_cfg);
167*5113495bSYour Name 
168*5113495bSYour Name /**
169*5113495bSYour Name  * wma_register_twt_events() - register for TWT wmi events
170*5113495bSYour Name  * @wma_handle : wma handle
171*5113495bSYour Name  *
172*5113495bSYour Name  * Registers the wmi event handlers for TWT.
173*5113495bSYour Name  *
174*5113495bSYour Name  * Return: None
175*5113495bSYour Name  */
176*5113495bSYour Name void wma_register_twt_events(tp_wma_handle wma_handle);
177*5113495bSYour Name #else
178*5113495bSYour Name static inline void
wma_send_twt_enable_cmd(uint32_t pdev_id,struct twt_enable_disable_conf * conf)179*5113495bSYour Name wma_send_twt_enable_cmd(uint32_t pdev_id,
180*5113495bSYour Name 			struct twt_enable_disable_conf *conf)
181*5113495bSYour Name {
182*5113495bSYour Name 	wma_debug("TWT not supported as WLAN_SUPPORT_TWT is disabled");
183*5113495bSYour Name }
184*5113495bSYour Name 
185*5113495bSYour Name static inline void
wma_send_twt_disable_cmd(uint32_t pdev_id,struct twt_enable_disable_conf * conf)186*5113495bSYour Name wma_send_twt_disable_cmd(uint32_t pdev_id,
187*5113495bSYour Name 			 struct twt_enable_disable_conf *conf)
188*5113495bSYour Name {
189*5113495bSYour Name }
190*5113495bSYour Name 
wma_set_twt_peer_caps(tpAddStaParams params,struct peer_assoc_params * cmd)191*5113495bSYour Name static inline void wma_set_twt_peer_caps(tpAddStaParams params,
192*5113495bSYour Name 					 struct peer_assoc_params *cmd)
193*5113495bSYour Name {
194*5113495bSYour Name }
195*5113495bSYour Name 
196*5113495bSYour Name static inline
wma_twt_process_add_dialog(t_wma_handle * wma_handle,struct wmi_twt_add_dialog_param * params)197*5113495bSYour Name QDF_STATUS wma_twt_process_add_dialog(t_wma_handle *wma_handle,
198*5113495bSYour Name 				      struct wmi_twt_add_dialog_param *params)
199*5113495bSYour Name {
200*5113495bSYour Name 	wma_debug("TWT not supported as WLAN_SUPPORT_TWT is disabled");
201*5113495bSYour Name 
202*5113495bSYour Name 	return QDF_STATUS_E_INVAL;
203*5113495bSYour Name }
204*5113495bSYour Name 
205*5113495bSYour Name static inline
wma_twt_process_del_dialog(t_wma_handle * wma_handle,struct wmi_twt_del_dialog_param * params)206*5113495bSYour Name QDF_STATUS wma_twt_process_del_dialog(t_wma_handle *wma_handle,
207*5113495bSYour Name 				      struct wmi_twt_del_dialog_param *params)
208*5113495bSYour Name {
209*5113495bSYour Name 	wma_debug("TWT not supported as WLAN_SUPPORT_TWT is disabled");
210*5113495bSYour Name 
211*5113495bSYour Name 	return QDF_STATUS_E_INVAL;
212*5113495bSYour Name }
213*5113495bSYour Name 
214*5113495bSYour Name static inline QDF_STATUS
wma_twt_process_pause_dialog(t_wma_handle * wma_handle,struct wmi_twt_pause_dialog_cmd_param * params)215*5113495bSYour Name wma_twt_process_pause_dialog(t_wma_handle *wma_handle,
216*5113495bSYour Name 			     struct wmi_twt_pause_dialog_cmd_param *params)
217*5113495bSYour Name {
218*5113495bSYour Name 	wma_debug("TWT not supported as WLAN_SUPPORT_TWT is disabled");
219*5113495bSYour Name 
220*5113495bSYour Name 	return QDF_STATUS_E_INVAL;
221*5113495bSYour Name }
222*5113495bSYour Name 
223*5113495bSYour Name static inline QDF_STATUS
wma_twt_process_nudge_dialog(t_wma_handle * wma_handle,struct wmi_twt_nudge_dialog_cmd_param * params)224*5113495bSYour Name wma_twt_process_nudge_dialog(t_wma_handle *wma_handle,
225*5113495bSYour Name 			     struct wmi_twt_nudge_dialog_cmd_param *params)
226*5113495bSYour Name {
227*5113495bSYour Name 	wma_debug("TWT not supported as WLAN_SUPPORT_TWT is disabled");
228*5113495bSYour Name 
229*5113495bSYour Name 	return QDF_STATUS_E_INVAL;
230*5113495bSYour Name }
231*5113495bSYour Name 
232*5113495bSYour Name static inline QDF_STATUS
wma_twt_process_resume_dialog(t_wma_handle * wma_handle,struct wmi_twt_resume_dialog_cmd_param * params)233*5113495bSYour Name wma_twt_process_resume_dialog(t_wma_handle *wma_handle,
234*5113495bSYour Name 			      struct wmi_twt_resume_dialog_cmd_param *params)
235*5113495bSYour Name {
236*5113495bSYour Name 	wma_debug("TWT not supported as WLAN_SUPPORT_TWT is disabled");
237*5113495bSYour Name 
238*5113495bSYour Name 	return QDF_STATUS_E_INVAL;
239*5113495bSYour Name }
240*5113495bSYour Name 
wma_update_bcast_twt_support(tp_wma_handle wh,struct wma_tgt_cfg * tgt_cfg)241*5113495bSYour Name static inline void wma_update_bcast_twt_support(tp_wma_handle wh,
242*5113495bSYour Name 						struct wma_tgt_cfg *tgt_cfg)
243*5113495bSYour Name {
244*5113495bSYour Name }
245*5113495bSYour Name 
246*5113495bSYour Name static inline
wma_update_twt_tgt_cap(tp_wma_handle wh,struct wma_tgt_cfg * tgt_cfg)247*5113495bSYour Name void wma_update_twt_tgt_cap(tp_wma_handle wh, struct wma_tgt_cfg *tgt_cfg)
248*5113495bSYour Name {
249*5113495bSYour Name }
wma_register_twt_events(tp_wma_handle wma_handle)250*5113495bSYour Name static inline void wma_register_twt_events(tp_wma_handle wma_handle)
251*5113495bSYour Name {
252*5113495bSYour Name }
253*5113495bSYour Name #endif
254*5113495bSYour Name 
255*5113495bSYour Name #endif /* __WMA_HE_H */
256