xref: /wlan-driver/qcacld-3.0/components/pmo/dispatcher/inc/wlan_pmo_extwow_cfg.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2012-2019 The Linux Foundation. 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 #ifndef WLAN_PMO_EXTWOW_CFG_H__
20*5113495bSYour Name #define WLAN_PMO_EXTWOW_CFG_H__
21*5113495bSYour Name 
22*5113495bSYour Name #ifdef WLAN_FEATURE_EXTWOW_SUPPORT
23*5113495bSYour Name /*
24*5113495bSYour Name  * <ini>
25*5113495bSYour Name  * gExtWoWgotoSuspend - Enable/Disable Extended WoW
26*5113495bSYour Name  * @Min: 0
27*5113495bSYour Name  * @Max: 1
28*5113495bSYour Name  * @Default: 1
29*5113495bSYour Name  *
30*5113495bSYour Name  * This ini is used to enable/disable Extended WoW.
31*5113495bSYour Name  *
32*5113495bSYour Name  * Related: None
33*5113495bSYour Name  *
34*5113495bSYour Name  * Supported Feature: Power Save
35*5113495bSYour Name  *
36*5113495bSYour Name  * Usage: External
37*5113495bSYour Name  *
38*5113495bSYour Name  * </ini>
39*5113495bSYour Name  */
40*5113495bSYour Name #define CFG_EXTWOW_GOTO_SUSPEND CFG_INI_BOOL("gExtWoWgotoSuspend", \
41*5113495bSYour Name 					     1, \
42*5113495bSYour Name 					     "Enable Ext WoW goto support")
43*5113495bSYour Name /*
44*5113495bSYour Name  * <ini>
45*5113495bSYour Name  * gExtWowApp1WakeupPinNumber - Set wakeup1 PIN number
46*5113495bSYour Name  * @Min: 0
47*5113495bSYour Name  * @Max: 255
48*5113495bSYour Name  * @Default: 12
49*5113495bSYour Name  *
50*5113495bSYour Name  * This ini is used to set EXT WOW APP1 wakeup PIN number
51*5113495bSYour Name  *
52*5113495bSYour Name  * Related: None
53*5113495bSYour Name  *
54*5113495bSYour Name  * Supported Feature: Power Save
55*5113495bSYour Name  *
56*5113495bSYour Name  * Usage: External
57*5113495bSYour Name  *
58*5113495bSYour Name  * </ini>
59*5113495bSYour Name  */
60*5113495bSYour Name #define CFG_EXTWOW_APP1_WAKE_PIN_NUMBER \
61*5113495bSYour Name 		CFG_INI_UINT("gExtWowApp1WakeupPinNumber", \
62*5113495bSYour Name 			     0, 255, 12, \
63*5113495bSYour Name 			     CFG_VALUE_OR_DEFAULT, \
64*5113495bSYour Name 			     "Set wakeup1 PIN number")
65*5113495bSYour Name /*
66*5113495bSYour Name  * <ini>
67*5113495bSYour Name  * gExtWowApp2WakeupPinNumber - Set wakeup2 PIN number
68*5113495bSYour Name  * @Min: 0
69*5113495bSYour Name  * @Max: 255
70*5113495bSYour Name  * @Default: 16
71*5113495bSYour Name  *
72*5113495bSYour Name  * This ini is used to set EXT WOW APP2 wakeup PIN number
73*5113495bSYour Name  *
74*5113495bSYour Name  * Related: None
75*5113495bSYour Name  *
76*5113495bSYour Name  * Supported Feature: Power Save
77*5113495bSYour Name  *
78*5113495bSYour Name  * Usage: External
79*5113495bSYour Name  *
80*5113495bSYour Name  * </ini>
81*5113495bSYour Name  */
82*5113495bSYour Name #define CFG_EXTWOW_APP2_WAKE_PIN_NUMBER \
83*5113495bSYour Name 		CFG_INI_UINT("gExtWowApp2WakeupPinNumber", \
84*5113495bSYour Name 			     0, 255, 16, \
85*5113495bSYour Name 			     CFG_VALUE_OR_DEFAULT, \
86*5113495bSYour Name 			     "Set wakeup2 PIN number")
87*5113495bSYour Name /*
88*5113495bSYour Name  * <ini>
89*5113495bSYour Name  * gExtWoWApp2KAInitPingInterval - Set Keep Alive Init Ping Interval
90*5113495bSYour Name  * @Min: 0
91*5113495bSYour Name  * @Max: 0xffffffff
92*5113495bSYour Name  * @Default: 240
93*5113495bSYour Name  *
94*5113495bSYour Name  * This ini is used to set Keep Alive Init Ping Interval for EXT WOW
95*5113495bSYour Name  *
96*5113495bSYour Name  * Related: None
97*5113495bSYour Name  *
98*5113495bSYour Name  * Supported Feature: Power Save
99*5113495bSYour Name  *
100*5113495bSYour Name  * Usage: External
101*5113495bSYour Name  *
102*5113495bSYour Name  * </ini>
103*5113495bSYour Name  */
104*5113495bSYour Name #define CFG_EXTWOW_KA_INIT_PING_INTERVAL \
105*5113495bSYour Name 		CFG_INI_UINT("gExtWoWApp2KAInitPingInterval", \
106*5113495bSYour Name 			     0, 0xffffffff, 240, \
107*5113495bSYour Name 			     CFG_VALUE_OR_DEFAULT, \
108*5113495bSYour Name 			     "Set Keep Alive Init Ping Interval")
109*5113495bSYour Name /*
110*5113495bSYour Name  * <ini>
111*5113495bSYour Name  * gExtWoWApp2KAMinPingInterval - Set Keep Alive Minimum Ping Interval
112*5113495bSYour Name  * @Min: 0
113*5113495bSYour Name  * @Max: 0xffffffff
114*5113495bSYour Name  * @Default: 240
115*5113495bSYour Name  *
116*5113495bSYour Name  * This ini is used to set Keep Alive Minimum Ping Interval for EXT WOW
117*5113495bSYour Name  *
118*5113495bSYour Name  * Related: None
119*5113495bSYour Name  *
120*5113495bSYour Name  * Supported Feature: Power Save
121*5113495bSYour Name  *
122*5113495bSYour Name  * Usage: External
123*5113495bSYour Name  *
124*5113495bSYour Name  * </ini>
125*5113495bSYour Name  */
126*5113495bSYour Name #define CFG_EXTWOW_KA_MIN_PING_INTERVAL \
127*5113495bSYour Name 		CFG_INI_UINT("gExtWoWApp2KAMinPingInterval", \
128*5113495bSYour Name 			     0, 0xffffffff, 240, \
129*5113495bSYour Name 			     CFG_VALUE_OR_DEFAULT, \
130*5113495bSYour Name 			     "Set Keep Alive Minimum Ping Interval")
131*5113495bSYour Name /*
132*5113495bSYour Name  * <ini>
133*5113495bSYour Name  * gExtWoWApp2KAMaxPingInterval - Set Keep Alive Maximum Ping Interval
134*5113495bSYour Name  * @Min: 0
135*5113495bSYour Name  * @Max: 0xffffffff
136*5113495bSYour Name  * @Default: 1280
137*5113495bSYour Name  *
138*5113495bSYour Name  * This ini is used to set Keep Alive Maximum Ping Interval for EXT WOW
139*5113495bSYour Name  *
140*5113495bSYour Name  * Related: None
141*5113495bSYour Name  *
142*5113495bSYour Name  * Supported Feature: Power Save
143*5113495bSYour Name  *
144*5113495bSYour Name  * Usage: External
145*5113495bSYour Name  *
146*5113495bSYour Name  * </ini>
147*5113495bSYour Name  */
148*5113495bSYour Name #define CFG_EXTWOW_KA_MAX_PING_INTERVAL \
149*5113495bSYour Name 		CFG_INI_UINT("gExtWoWApp2KAMaxPingInterval", \
150*5113495bSYour Name 			     0, 0xffffffff, 1280, \
151*5113495bSYour Name 			     CFG_VALUE_OR_DEFAULT, \
152*5113495bSYour Name 			     "Set Keep Alive Maximum Ping Interval")
153*5113495bSYour Name /*
154*5113495bSYour Name  * <ini>
155*5113495bSYour Name  * gExtWoWApp2KAIncPingInterval - Set Keep Alive increment of Ping Interval
156*5113495bSYour Name  * @Min: 0
157*5113495bSYour Name  * @Max: 0xffffffff
158*5113495bSYour Name  * @Default: 4
159*5113495bSYour Name  *
160*5113495bSYour Name  * This ini is used to set Keep Alive increment of Ping Interval for EXT WOW
161*5113495bSYour Name  *
162*5113495bSYour Name  * Related: None
163*5113495bSYour Name  *
164*5113495bSYour Name  * Supported Feature: Power Save
165*5113495bSYour Name  *
166*5113495bSYour Name  * Usage: External
167*5113495bSYour Name  *
168*5113495bSYour Name  * </ini>
169*5113495bSYour Name  */
170*5113495bSYour Name #define CFG_EXTWOW_KA_INC_PING_INTERVAL \
171*5113495bSYour Name 		CFG_INI_UINT("gExtWoWApp2KAIncPingInterval", \
172*5113495bSYour Name 			     0, 0xffffffff, 4, \
173*5113495bSYour Name 			     CFG_VALUE_OR_DEFAULT, \
174*5113495bSYour Name 			     "Set Keep Alive increment of Ping Interval")
175*5113495bSYour Name /*
176*5113495bSYour Name  * <ini>
177*5113495bSYour Name  * gExtWoWApp2TcpSrcPort - Set TCP source port
178*5113495bSYour Name  * @Min: 0
179*5113495bSYour Name  * @Max: 65535
180*5113495bSYour Name  * @Default: 5000
181*5113495bSYour Name  *
182*5113495bSYour Name  * This ini is used to set TCP source port when EXT WOW is enabled
183*5113495bSYour Name  *
184*5113495bSYour Name  * Related: None
185*5113495bSYour Name  *
186*5113495bSYour Name  * Supported Feature: Power Save
187*5113495bSYour Name  *
188*5113495bSYour Name  * Usage: External
189*5113495bSYour Name  *
190*5113495bSYour Name  * </ini>
191*5113495bSYour Name  */
192*5113495bSYour Name #define CFG_EXTWOW_TCP_SRC_PORT \
193*5113495bSYour Name 		CFG_INI_UINT("gExtWoWApp2TcpSrcPort", \
194*5113495bSYour Name 			     0, 65535, 5000, \
195*5113495bSYour Name 			     CFG_VALUE_OR_DEFAULT, \
196*5113495bSYour Name 			     "Set TCP source port")
197*5113495bSYour Name /*
198*5113495bSYour Name  * <ini>
199*5113495bSYour Name  * gExtWoWApp2TcpDstPort - Set TCP Destination port
200*5113495bSYour Name  * @Min: 0
201*5113495bSYour Name  * @Max: 65535
202*5113495bSYour Name  * @Default: 5001
203*5113495bSYour Name  *
204*5113495bSYour Name  * This ini is used to set TCP Destination port when EXT WOW is enabled
205*5113495bSYour Name  *
206*5113495bSYour Name  * Related: None
207*5113495bSYour Name  *
208*5113495bSYour Name  * Supported Feature: Power Save
209*5113495bSYour Name  *
210*5113495bSYour Name  * Usage: External
211*5113495bSYour Name  *
212*5113495bSYour Name  * </ini>
213*5113495bSYour Name  */
214*5113495bSYour Name #define CFG_EXTWOW_TCP_DST_PORT \
215*5113495bSYour Name 		CFG_INI_UINT("gExtWoWApp2TcpDstPort", \
216*5113495bSYour Name 			     0, 65535, 5001, \
217*5113495bSYour Name 			     CFG_VALUE_OR_DEFAULT, \
218*5113495bSYour Name 			     "Set TCP Destination port")
219*5113495bSYour Name /*
220*5113495bSYour Name  * <ini>
221*5113495bSYour Name  * gExtWoWApp2TcpTxTimeout - Set TCP tx timeout
222*5113495bSYour Name  * @Min: 0
223*5113495bSYour Name  * @Max: 0xffffffff
224*5113495bSYour Name  * @Default: 200
225*5113495bSYour Name  *
226*5113495bSYour Name  * This ini is used to set TCP Tx timeout when EXT WOW is enabled
227*5113495bSYour Name  *
228*5113495bSYour Name  * Related: None
229*5113495bSYour Name  *
230*5113495bSYour Name  * Supported Feature: Power Save
231*5113495bSYour Name  *
232*5113495bSYour Name  * Usage: External
233*5113495bSYour Name  *
234*5113495bSYour Name  * </ini>
235*5113495bSYour Name  */
236*5113495bSYour Name #define CFG_EXTWOW_TCP_TX_TIMEOUT \
237*5113495bSYour Name 		CFG_INI_UINT("gExtWoWApp2TcpTxTimeout", \
238*5113495bSYour Name 			     0, 0xffffffff, 200, \
239*5113495bSYour Name 			     CFG_VALUE_OR_DEFAULT, \
240*5113495bSYour Name 			     "Set TCP tx timeout")
241*5113495bSYour Name 
242*5113495bSYour Name /*
243*5113495bSYour Name  * <ini>
244*5113495bSYour Name  * gExtWoWApp2TcpRxTimeout - Set TCP rx timeout
245*5113495bSYour Name  * @Min: 0
246*5113495bSYour Name  * @Max: 0xffffffff
247*5113495bSYour Name  * @Default: 200
248*5113495bSYour Name  *
249*5113495bSYour Name  * This ini is used to set TCP Rx timeout when EXT WOW is enabled
250*5113495bSYour Name  *
251*5113495bSYour Name  * Supported Feature: Power Save
252*5113495bSYour Name  *
253*5113495bSYour Name  * Usage: External
254*5113495bSYour Name  *
255*5113495bSYour Name  * </ini>
256*5113495bSYour Name  */
257*5113495bSYour Name #define CFG_EXTWOW_TCP_RX_TIMEOUT \
258*5113495bSYour Name 		CFG_INI_UINT("gExtWoWApp2TcpRxTimeout", \
259*5113495bSYour Name 			     0, 0xffffffff, 200, \
260*5113495bSYour Name 			     CFG_VALUE_OR_DEFAULT, \
261*5113495bSYour Name 			     "ExtWow App2 tcp rx timeout")
262*5113495bSYour Name 
263*5113495bSYour Name #define CFG_EXTWOW_ALL \
264*5113495bSYour Name 	CFG(CFG_EXTWOW_GOTO_SUSPEND) \
265*5113495bSYour Name 	CFG(CFG_EXTWOW_APP1_WAKE_PIN_NUMBER) \
266*5113495bSYour Name 	CFG(CFG_EXTWOW_APP2_WAKE_PIN_NUMBER) \
267*5113495bSYour Name 	CFG(CFG_EXTWOW_KA_INIT_PING_INTERVAL) \
268*5113495bSYour Name 	CFG(CFG_EXTWOW_KA_MIN_PING_INTERVAL) \
269*5113495bSYour Name 	CFG(CFG_EXTWOW_KA_MAX_PING_INTERVAL) \
270*5113495bSYour Name 	CFG(CFG_EXTWOW_KA_INC_PING_INTERVAL) \
271*5113495bSYour Name 	CFG(CFG_EXTWOW_TCP_SRC_PORT) \
272*5113495bSYour Name 	CFG(CFG_EXTWOW_TCP_DST_PORT) \
273*5113495bSYour Name 	CFG(CFG_EXTWOW_TCP_TX_TIMEOUT) \
274*5113495bSYour Name 	CFG(CFG_EXTWOW_TCP_RX_TIMEOUT)
275*5113495bSYour Name #else
276*5113495bSYour Name #define CFG_EXTWOW_ALL
277*5113495bSYour Name #endif /* WLAN_FEATURE_EXTWOW_SUPPORT */
278*5113495bSYour Name #endif /* WLAN_PMO_EXTWOW_CFG_H_ */
279