xref: /wlan-driver/qcacld-3.0/components/mlme/dispatcher/inc/cfg_mlme_powersave.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 /**
20*5113495bSYour Name  * DOC: This file contains centralized definitions of power save related
21*5113495bSYour Name  * converged configurations.
22*5113495bSYour Name  */
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef __CFG_MLME_POWERSAVE_H
25*5113495bSYour Name #define __CFG_MLME_POWERSAVE_H
26*5113495bSYour Name 
27*5113495bSYour Name /*
28*5113495bSYour Name  * <ini>
29*5113495bSYour Name  * gEnableImps - Enable/Disable IMPS
30*5113495bSYour Name  * @Min: 0
31*5113495bSYour Name  * @Max: 1
32*5113495bSYour Name  * @Default: 1
33*5113495bSYour Name  *
34*5113495bSYour Name  * This ini is used to enable/Disable IMPS(IdleModePowerSave) Mode
35*5113495bSYour Name  *
36*5113495bSYour Name  * Related: None
37*5113495bSYour Name  *
38*5113495bSYour Name  * Supported Feature: Power Save
39*5113495bSYour Name  *
40*5113495bSYour Name  * Usage: External
41*5113495bSYour Name  *
42*5113495bSYour Name  * </ini>
43*5113495bSYour Name  */
44*5113495bSYour Name #define CFG_ENABLE_IMPS CFG_INI_BOOL( \
45*5113495bSYour Name 		"gEnableImps", \
46*5113495bSYour Name 		1,\
47*5113495bSYour Name 		"Enable/disable IMPS")
48*5113495bSYour Name 
49*5113495bSYour Name /*
50*5113495bSYour Name  * <ini>
51*5113495bSYour Name  * gEnableBmps - Enable/Disable BMPS
52*5113495bSYour Name  * @Min: 0
53*5113495bSYour Name  * @Max: 1
54*5113495bSYour Name  * @Default: 1
55*5113495bSYour Name  *
56*5113495bSYour Name  * This ini is used to enable/Disable BMPS(BeaconModePowerSave) Mode
57*5113495bSYour Name  *
58*5113495bSYour Name  * Related: None
59*5113495bSYour Name  *
60*5113495bSYour Name  * Supported Feature: Power Save
61*5113495bSYour Name  *
62*5113495bSYour Name  * Usage: External
63*5113495bSYour Name  *
64*5113495bSYour Name  * </ini>
65*5113495bSYour Name  */
66*5113495bSYour Name #define CFG_ENABLE_PS  CFG_INI_BOOL( \
67*5113495bSYour Name 		"gEnableBmps", \
68*5113495bSYour Name 		1,\
69*5113495bSYour Name 		"Enable/disable BMPS")
70*5113495bSYour Name 
71*5113495bSYour Name /*
72*5113495bSYour Name  * <ini>
73*5113495bSYour Name  * gAutoBmpsTimerValue - Set Auto BMPS Timer value
74*5113495bSYour Name  * @Min: 0
75*5113495bSYour Name  * @Max: 1000
76*5113495bSYour Name  * @Default: 600
77*5113495bSYour Name  *
78*5113495bSYour Name  * This ini is used to set Auto BMPS Timer value in seconds
79*5113495bSYour Name  *
80*5113495bSYour Name  * Related: gEnableBmps
81*5113495bSYour Name  *
82*5113495bSYour Name  * Supported Feature: Power Save
83*5113495bSYour Name  *
84*5113495bSYour Name  * Usage: External
85*5113495bSYour Name  *
86*5113495bSYour Name  * </ini>
87*5113495bSYour Name  */
88*5113495bSYour Name #define CFG_AUTO_BMPS_ENABLE_TIMER CFG_INI_UINT( \
89*5113495bSYour Name 		"gAutoBmpsTimerValue", \
90*5113495bSYour Name 		0, \
91*5113495bSYour Name 		1000, \
92*5113495bSYour Name 		600, \
93*5113495bSYour Name 		CFG_VALUE_OR_DEFAULT, \
94*5113495bSYour Name 		"Auto BMPS Timer value")
95*5113495bSYour Name 
96*5113495bSYour Name /*
97*5113495bSYour Name  * <ini>
98*5113495bSYour Name  * gBmpsMinListenInterval - Set BMPS Minimum Listen Interval
99*5113495bSYour Name  * @Min: 1
100*5113495bSYour Name  * @Max: 65535
101*5113495bSYour Name  * @Default: 1
102*5113495bSYour Name  *
103*5113495bSYour Name  * This ini is used to set BMPS Minimum Listen Interval. If gPowerUsage
104*5113495bSYour Name  * is set "Min", this INI need to be set.
105*5113495bSYour Name  *
106*5113495bSYour Name  * Related: gEnableBmps, gPowerUsage
107*5113495bSYour Name  *
108*5113495bSYour Name  * Supported Feature: Power Save
109*5113495bSYour Name  *
110*5113495bSYour Name  * Usage: External
111*5113495bSYour Name  *
112*5113495bSYour Name  * </ini>
113*5113495bSYour Name  */
114*5113495bSYour Name #define CFG_BMPS_MINIMUM_LI CFG_INI_UINT( \
115*5113495bSYour Name 		"gBmpsMinListenInterval", \
116*5113495bSYour Name 		1, \
117*5113495bSYour Name 		65535, \
118*5113495bSYour Name 		1, \
119*5113495bSYour Name 		CFG_VALUE_OR_DEFAULT, \
120*5113495bSYour Name 		"BMPS Minimum Listen Interval")
121*5113495bSYour Name 
122*5113495bSYour Name /*
123*5113495bSYour Name  * <ini>
124*5113495bSYour Name  * gBmpsMaxListenInterval - Set BMPS Maximum Listen Interval
125*5113495bSYour Name  * @Min: 1
126*5113495bSYour Name  * @Max: 65535
127*5113495bSYour Name  * @Default: 1
128*5113495bSYour Name  *
129*5113495bSYour Name  * This ini is used to set BMPS Maximum Listen Interval. If gPowerUsage
130*5113495bSYour Name  * is set "Max", this INI need to be set.
131*5113495bSYour Name  *
132*5113495bSYour Name  * Related: gEnableBmps, gPowerUsage
133*5113495bSYour Name  *
134*5113495bSYour Name  * Supported Feature: Power Save
135*5113495bSYour Name  *
136*5113495bSYour Name  * Usage: External
137*5113495bSYour Name  *
138*5113495bSYour Name  * </ini>
139*5113495bSYour Name  */
140*5113495bSYour Name #define CFG_BMPS_MAXIMUM_LI CFG_INI_UINT( \
141*5113495bSYour Name 		"gBmpsMaxListenInterval", \
142*5113495bSYour Name 		1, \
143*5113495bSYour Name 		65535, \
144*5113495bSYour Name 		1, \
145*5113495bSYour Name 		CFG_VALUE_OR_DEFAULT, \
146*5113495bSYour Name 		"BMPS Maximum Listen Interval")
147*5113495bSYour Name 
148*5113495bSYour Name /*
149*5113495bSYour Name  * <ini>
150*5113495bSYour Name  * gEnableDTIMSelectionDiversity - Enable/Disable chain
151*5113495bSYour Name  * selection optimization for one chain dtim
152*5113495bSYour Name  * @Min: 0
153*5113495bSYour Name  * @Max: 30
154*5113495bSYour Name  * @Default: 5
155*5113495bSYour Name  *
156*5113495bSYour Name  * Usage: External
157*5113495bSYour Name  *
158*5113495bSYour Name  * </ini>
159*5113495bSYour Name  */
160*5113495bSYour Name #define CFG_DTIM_SELECTION_DIVERSITY CFG_INI_UINT( \
161*5113495bSYour Name 		"gEnableDTIMSelectionDiversity", \
162*5113495bSYour Name 		0, \
163*5113495bSYour Name 		30, \
164*5113495bSYour Name 		5, \
165*5113495bSYour Name 		CFG_VALUE_OR_DEFAULT, \
166*5113495bSYour Name 		"Chain selection diversity value")
167*5113495bSYour Name 
168*5113495bSYour Name #define CFG_POWERSAVE_ALL \
169*5113495bSYour Name 	CFG(CFG_ENABLE_IMPS) \
170*5113495bSYour Name 	CFG(CFG_ENABLE_PS) \
171*5113495bSYour Name 	CFG(CFG_AUTO_BMPS_ENABLE_TIMER) \
172*5113495bSYour Name 	CFG(CFG_BMPS_MINIMUM_LI) \
173*5113495bSYour Name 	CFG(CFG_BMPS_MAXIMUM_LI) \
174*5113495bSYour Name 	CFG(CFG_DTIM_SELECTION_DIVERSITY)
175*5113495bSYour Name 
176*5113495bSYour Name #endif /* __CFG_MLME_POWERSAVE_H */
177