xref: /wlan-driver/qca-wifi-host-cmn/umac/green_ap/dispatcher/inc/cfg_green_ap_params.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2012-2019 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  * Copyright (c) 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 /**
21*5113495bSYour Name  * DOC: This file contains centralized definitions of converged configuration.
22*5113495bSYour Name  */
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef __CFG_GREEN_AP_PARAMS_H
25*5113495bSYour Name #define __CFG_GREEN_AP_PARAMS_H
26*5113495bSYour Name 
27*5113495bSYour Name /*
28*5113495bSYour Name  * <ini>
29*5113495bSYour Name  * gEnableGreenAp - Enable green ap feature
30*5113495bSYour Name  * @Min: 0
31*5113495bSYour Name  * @Max: 1
32*5113495bSYour Name  * @Default: 0
33*5113495bSYour Name  *
34*5113495bSYour Name  * This ini is used to enable green ap feature
35*5113495bSYour Name  *
36*5113495bSYour Name  * Related: None
37*5113495bSYour Name  *
38*5113495bSYour Name  * Supported Feature: SAP
39*5113495bSYour Name  *
40*5113495bSYour Name  * Usage: Internal/External
41*5113495bSYour Name  *
42*5113495bSYour Name  * </ini>
43*5113495bSYour Name  */
44*5113495bSYour Name 
45*5113495bSYour Name #define CFG_ENABLE_GREEN_AP_FEATURE CFG_INI_BOOL( \
46*5113495bSYour Name 		"gEnableGreenAp", \
47*5113495bSYour Name 		PLATFORM_VALUE(1, 0), \
48*5113495bSYour Name 		"enable green ap")
49*5113495bSYour Name 
50*5113495bSYour Name /*
51*5113495bSYour Name  * <ini>
52*5113495bSYour Name  * gEnableEGAP - Enable the enhanced green ap feature
53*5113495bSYour Name  * @Min: 0
54*5113495bSYour Name  * @Max: 1
55*5113495bSYour Name  * @Default: 1
56*5113495bSYour Name  *
57*5113495bSYour Name  * This ini is used to enable the enhanced green ap feature
58*5113495bSYour Name  *
59*5113495bSYour Name  * Related: None
60*5113495bSYour Name  *
61*5113495bSYour Name  * Supported Feature: SAP
62*5113495bSYour Name  *
63*5113495bSYour Name  * Usage: Internal/External
64*5113495bSYour Name  *
65*5113495bSYour Name  * </ini>
66*5113495bSYour Name  */
67*5113495bSYour Name 
68*5113495bSYour Name #define CFG_ENABLE_EGAP_FEATURE CFG_INI_BOOL( \
69*5113495bSYour Name 		"gEnableEGAP", \
70*5113495bSYour Name 		PLATFORM_VALUE(1, 0), \
71*5113495bSYour Name 		"enable e-gap")
72*5113495bSYour Name /*
73*5113495bSYour Name  * <ini>
74*5113495bSYour Name  * gEGAPInactTime - configure the inactive time for EGAP
75*5113495bSYour Name  * @Min: 0
76*5113495bSYour Name  * @Max: 300000
77*5113495bSYour Name  * @Default: 2000
78*5113495bSYour Name  *
79*5113495bSYour Name  * This ini is used to configure the inactive time for EGAP
80*5113495bSYour Name  *
81*5113495bSYour Name  * Related: None
82*5113495bSYour Name  *
83*5113495bSYour Name  * Supported Feature: SAP
84*5113495bSYour Name  *
85*5113495bSYour Name  * Usage: Internal/External
86*5113495bSYour Name  *
87*5113495bSYour Name  * </ini>
88*5113495bSYour Name  */
89*5113495bSYour Name 
90*5113495bSYour Name #define CFG_EGAP_INACT_TIME_FEATURE CFG_INI_UINT( \
91*5113495bSYour Name 		"gEGAPInactTime", \
92*5113495bSYour Name 		0, \
93*5113495bSYour Name 		300000, \
94*5113495bSYour Name 		2000, \
95*5113495bSYour Name 		CFG_VALUE_OR_DEFAULT, \
96*5113495bSYour Name 		"egap inactivity time")
97*5113495bSYour Name 
98*5113495bSYour Name #ifdef WLAN_SUPPORT_GAP_LL_PS_MODE
99*5113495bSYour Name /*
100*5113495bSYour Name  * <ini>
101*5113495bSYour Name  * gGAPLowBeaconMult - configure Low Beacon interval multiplier.
102*5113495bSYour Name  * @Min: 0
103*5113495bSYour Name  * @Max: 10
104*5113495bSYour Name  * @Default: 10
105*5113495bSYour Name  *
106*5113495bSYour Name  * This ini is used to configure the Low Beacon interval
107*5113495bSYour Name  * multiplier which is used to calculate Low Beacon interval for
108*5113495bSYour Name  * power save.
109*5113495bSYour Name  *
110*5113495bSYour Name  * Related: None
111*5113495bSYour Name  *
112*5113495bSYour Name  * Supported Feature: SAP
113*5113495bSYour Name  *
114*5113495bSYour Name  * Usage: External
115*5113495bSYour Name  *
116*5113495bSYour Name  * </ini>
117*5113495bSYour Name  */
118*5113495bSYour Name 
119*5113495bSYour Name #define CFG_GAP_LL_PS_LOW_BEACON_MULT CFG_INI_UINT( \
120*5113495bSYour Name 		"gGAPLowBeaconMult", \
121*5113495bSYour Name 		0, \
122*5113495bSYour Name 		10, \
123*5113495bSYour Name 		10, \
124*5113495bSYour Name 		CFG_VALUE_OR_DEFAULT, \
125*5113495bSYour Name 		"low beacon interval multiplier")
126*5113495bSYour Name 
127*5113495bSYour Name #define CFG_GAP_LL_PS_ALL_CFG CFG(CFG_GAP_LL_PS_LOW_BEACON_MULT)
128*5113495bSYour Name #else
129*5113495bSYour Name #define CFG_GAP_LL_PS_ALL_CFG
130*5113495bSYour Name #endif
131*5113495bSYour Name 
132*5113495bSYour Name /*
133*5113495bSYour Name  * <ini>
134*5113495bSYour Name  * gEGAPWaitTime - configure the wait time for EGAP
135*5113495bSYour Name  * @Min: 0
136*5113495bSYour Name  * @Max: 300000
137*5113495bSYour Name  * @Default: 150
138*5113495bSYour Name  *
139*5113495bSYour Name  * This ini is used to configure the wait time for EGAP
140*5113495bSYour Name  *
141*5113495bSYour Name  * Related: None
142*5113495bSYour Name  *
143*5113495bSYour Name  * Supported Feature: SAP
144*5113495bSYour Name  *
145*5113495bSYour Name  * Usage: Internal/External
146*5113495bSYour Name  *
147*5113495bSYour Name  * </ini>
148*5113495bSYour Name  */
149*5113495bSYour Name 
150*5113495bSYour Name #define CFG_EGAP_WAIT_TIME_FEATURE CFG_INI_UINT( \
151*5113495bSYour Name 		"gEGAPWaitTime", \
152*5113495bSYour Name 		0, \
153*5113495bSYour Name 		300000, \
154*5113495bSYour Name 		150, \
155*5113495bSYour Name 		CFG_VALUE_OR_DEFAULT, \
156*5113495bSYour Name 		"egap wait time")
157*5113495bSYour Name /*
158*5113495bSYour Name  * <ini>
159*5113495bSYour Name  * gEGAPFeatures - Configure the EGAP flags
160*5113495bSYour Name  * @Min: 0
161*5113495bSYour Name  * @Max: 15
162*5113495bSYour Name  * @Default: 3
163*5113495bSYour Name  *
164*5113495bSYour Name  * This ini is used to configure the EGAP flags
165*5113495bSYour Name  *
166*5113495bSYour Name  * Related: None
167*5113495bSYour Name  *
168*5113495bSYour Name  * Supported Feature: SAP
169*5113495bSYour Name  *
170*5113495bSYour Name  * Usage: Internal/External
171*5113495bSYour Name  *
172*5113495bSYour Name  * </ini>
173*5113495bSYour Name  */
174*5113495bSYour Name 
175*5113495bSYour Name #define CFG_EGAP_FLAGS_FEATURE CFG_INI_UINT( \
176*5113495bSYour Name 		"gEGAPFeatures", \
177*5113495bSYour Name 		0, \
178*5113495bSYour Name 		15, \
179*5113495bSYour Name 		3, \
180*5113495bSYour Name 		CFG_VALUE_OR_DEFAULT, \
181*5113495bSYour Name 		"egap flag")
182*5113495bSYour Name 
183*5113495bSYour Name #ifdef WLAN_SUPPORT_GREEN_AP
184*5113495bSYour Name #define CFG_GREEN_AP_ALL \
185*5113495bSYour Name 	CFG(CFG_ENABLE_GREEN_AP_FEATURE) \
186*5113495bSYour Name 	CFG(CFG_ENABLE_EGAP_FEATURE) \
187*5113495bSYour Name 	CFG(CFG_EGAP_INACT_TIME_FEATURE) \
188*5113495bSYour Name 	CFG(CFG_EGAP_WAIT_TIME_FEATURE) \
189*5113495bSYour Name 	CFG(CFG_EGAP_FLAGS_FEATURE) \
190*5113495bSYour Name 	CFG_GAP_LL_PS_ALL_CFG
191*5113495bSYour Name #else
192*5113495bSYour Name #define CFG_GREEN_AP_ALL
193*5113495bSYour Name #endif
194*5113495bSYour Name 
195*5113495bSYour Name #endif /* __CFG_GREEN_AP_PARAMS_H */
196*5113495bSYour Name 
197