xref: /wlan-driver/qcacld-3.0/components/mlme/dispatcher/inc/cfg_mlme_oce.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 converged configuration.
21*5113495bSYour Name  */
22*5113495bSYour Name 
23*5113495bSYour Name #ifndef __CFG_MLME_OCE_H
24*5113495bSYour Name #define __CFG_MLME_OCE_H
25*5113495bSYour Name 
26*5113495bSYour Name /*
27*5113495bSYour Name  * <ini>
28*5113495bSYour Name  * g_enable_bcast_probe_rsp - Enable Broadcast probe response.
29*5113495bSYour Name  * @Min: 0
30*5113495bSYour Name  * @Max: 1
31*5113495bSYour Name  * @Default: 1
32*5113495bSYour Name  *
33*5113495bSYour Name  * This ini is used to enable/disable broadcast probe response.
34*5113495bSYour Name  * If this is disabled then OCE ini oce_sta_enable will also be
35*5113495bSYour Name  * disabled and OCE IE will not be sent in frames.
36*5113495bSYour Name  *
37*5113495bSYour Name  * Related: None
38*5113495bSYour Name  *
39*5113495bSYour Name  * Supported Feature: FILS
40*5113495bSYour Name  *
41*5113495bSYour Name  * Usage: External
42*5113495bSYour Name  *
43*5113495bSYour Name  * </ini>
44*5113495bSYour Name  */
45*5113495bSYour Name #define CFG_ENABLE_BCAST_PROBE_RESP CFG_INI_BOOL( \
46*5113495bSYour Name 		"g_enable_bcast_probe_rsp", \
47*5113495bSYour Name 		1, \
48*5113495bSYour Name 		"Enable Broadcast probe response")
49*5113495bSYour Name 
50*5113495bSYour Name /*
51*5113495bSYour Name  * <ini>
52*5113495bSYour Name  * oce_sta_enable - Enable/disable oce feature for STA
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/disable oce feature for STA
58*5113495bSYour Name  *
59*5113495bSYour Name  * Related: None
60*5113495bSYour Name  *
61*5113495bSYour Name  * Supported Feature: OCE
62*5113495bSYour Name  *
63*5113495bSYour Name  * Usage: External
64*5113495bSYour Name  *
65*5113495bSYour Name  * </ini>
66*5113495bSYour Name  */
67*5113495bSYour Name #define CFG_OCE_ENABLE_STA CFG_INI_BOOL( \
68*5113495bSYour Name 		"oce_sta_enable", \
69*5113495bSYour Name 		1, \
70*5113495bSYour Name 		"Enable/disable oce feature for STA")
71*5113495bSYour Name 
72*5113495bSYour Name /*
73*5113495bSYour Name  * <ini>
74*5113495bSYour Name  * oce_sap_enable - Enable/disable oce feature for SAP
75*5113495bSYour Name  * @Min: 0
76*5113495bSYour Name  * @Max: 1
77*5113495bSYour Name  * @Default: 1
78*5113495bSYour Name  *
79*5113495bSYour Name  * This ini is used to enable/disable oce feature for SAP
80*5113495bSYour Name  *
81*5113495bSYour Name  * Related: None
82*5113495bSYour Name  *
83*5113495bSYour Name  * Supported Feature: OCE
84*5113495bSYour Name  *
85*5113495bSYour Name  * Usage: External
86*5113495bSYour Name  *
87*5113495bSYour Name  * </ini>
88*5113495bSYour Name  */
89*5113495bSYour Name #define CFG_OCE_ENABLE_SAP CFG_INI_BOOL( \
90*5113495bSYour Name 		"oce_sap_enable", \
91*5113495bSYour Name 		1, \
92*5113495bSYour Name 		"Enable/disable oce feature for SAP")
93*5113495bSYour Name 
94*5113495bSYour Name /*
95*5113495bSYour Name  * <ini>
96*5113495bSYour Name  * oce_enable_rssi_assoc_reject - Enable/disable rssi based assoc rejection
97*5113495bSYour Name  * @Min: 0
98*5113495bSYour Name  * @Max: 1
99*5113495bSYour Name  * @Default: 1
100*5113495bSYour Name  *
101*5113495bSYour Name  * This ini is used to enable/disable rssi based assoc rejection. If this is
102*5113495bSYour Name  * disabled then OCE ini oce_sta_enable will also be disabled and OCE IE will
103*5113495bSYour Name  * not be sent in frames.
104*5113495bSYour Name  *
105*5113495bSYour Name  * Related: None
106*5113495bSYour Name  *
107*5113495bSYour Name  * Supported Feature: OCE
108*5113495bSYour Name  *
109*5113495bSYour Name  * Usage: External
110*5113495bSYour Name  *
111*5113495bSYour Name  * </ini>
112*5113495bSYour Name  */
113*5113495bSYour Name #define CFG_OCE_ENABLE_RSSI_BASED_ASSOC_REJECT CFG_INI_BOOL( \
114*5113495bSYour Name 		"oce_enable_rssi_assoc_reject", \
115*5113495bSYour Name 		1, \
116*5113495bSYour Name 		"Enable/disable rssi based assoc rejection")
117*5113495bSYour Name 
118*5113495bSYour Name /*
119*5113495bSYour Name  * <ini>
120*5113495bSYour Name  * oce_enable_probe_req_rate - Set probe request rate
121*5113495bSYour Name  * @Min: 0
122*5113495bSYour Name  * @Max: 1
123*5113495bSYour Name  * @Default: 1
124*5113495bSYour Name  *
125*5113495bSYour Name  * This ini is used to set probe request rate to 5.5Mbps as per OCE requirement
126*5113495bSYour Name  * in 2.4G band
127*5113495bSYour Name  *
128*5113495bSYour Name  * Related: None
129*5113495bSYour Name  *
130*5113495bSYour Name  * Supported Feature: OCE
131*5113495bSYour Name  *
132*5113495bSYour Name  * Usage: External
133*5113495bSYour Name  *
134*5113495bSYour Name  * </ini>
135*5113495bSYour Name  */
136*5113495bSYour Name #define CFG_OCE_PROBE_REQ_RATE CFG_INI_BOOL( \
137*5113495bSYour Name 		"oce_enable_probe_req_rate", \
138*5113495bSYour Name 		1, \
139*5113495bSYour Name 		"Set probe request rate for OCE")
140*5113495bSYour Name 
141*5113495bSYour Name /*
142*5113495bSYour Name  * <ini>
143*5113495bSYour Name  * oce_enable_probe_resp_rate - Set probe response rate
144*5113495bSYour Name  * @Min: 0
145*5113495bSYour Name  * @Max: 1
146*5113495bSYour Name  * @Default: 0
147*5113495bSYour Name  *
148*5113495bSYour Name  * This ini is used to set probe response rate to 5.5Mbps as per OCE requirement
149*5113495bSYour Name  * in 2.4G band
150*5113495bSYour Name  *
151*5113495bSYour Name  * Related: None
152*5113495bSYour Name  *
153*5113495bSYour Name  * Supported Feature: OCE
154*5113495bSYour Name  *
155*5113495bSYour Name  * Usage: External
156*5113495bSYour Name  *
157*5113495bSYour Name  * </ini>
158*5113495bSYour Name  */
159*5113495bSYour Name #define CFG_OCE_PROBE_RSP_RATE CFG_INI_BOOL( \
160*5113495bSYour Name 		"oce_enable_probe_resp_rate", \
161*5113495bSYour Name 		0, \
162*5113495bSYour Name 		"Set probe response rate for OCE")
163*5113495bSYour Name 
164*5113495bSYour Name /*
165*5113495bSYour Name  * <ini>
166*5113495bSYour Name  * oce_enable_beacon_rate - Set beacon rate
167*5113495bSYour Name  * @Min: 0
168*5113495bSYour Name  * @Max: 1
169*5113495bSYour Name  * @Default: 0
170*5113495bSYour Name  *
171*5113495bSYour Name  * This ini is used to set beacon rate to 5.5Mbps as per OCE requirement in
172*5113495bSYour Name  * 2.4G band
173*5113495bSYour Name  *
174*5113495bSYour Name  * Related: None
175*5113495bSYour Name  *
176*5113495bSYour Name  * Supported Feature: OCE
177*5113495bSYour Name  *
178*5113495bSYour Name  * Usage: External
179*5113495bSYour Name  *
180*5113495bSYour Name  * </ini>
181*5113495bSYour Name  */
182*5113495bSYour Name #define CFG_OCE_BEACON_RATE CFG_INI_BOOL( \
183*5113495bSYour Name 		"oce_enable_beacon_rate", \
184*5113495bSYour Name 		0, \
185*5113495bSYour Name 		"Set Beacon rate for OCE")
186*5113495bSYour Name /*
187*5113495bSYour Name  * <ini>
188*5113495bSYour Name  * oce_enable_probe_req_deferral - Enable/disable probe request deferral
189*5113495bSYour Name  * @Min: 0
190*5113495bSYour Name  * @Max: 1
191*5113495bSYour Name  * @Default: 1
192*5113495bSYour Name  *
193*5113495bSYour Name  * This ini is used to enable/disable probe request deferral as per OCE spec
194*5113495bSYour Name  *
195*5113495bSYour Name  * Related: None
196*5113495bSYour Name  *
197*5113495bSYour Name  * Supported Feature: OCE
198*5113495bSYour Name  *
199*5113495bSYour Name  * Usage: External
200*5113495bSYour Name  *
201*5113495bSYour Name  * </ini>
202*5113495bSYour Name  */
203*5113495bSYour Name #define CFG_ENABLE_PROBE_REQ_DEFERRAL CFG_INI_BOOL( \
204*5113495bSYour Name 		"oce_enable_probe_req_deferral", \
205*5113495bSYour Name 		1, \
206*5113495bSYour Name 		"Enable/disable probe request deferral for OCE")
207*5113495bSYour Name 
208*5113495bSYour Name /*
209*5113495bSYour Name  * <ini>
210*5113495bSYour Name  * oce_enable_fils_discovery_sap - Enable/disable fils discovery in sap mode
211*5113495bSYour Name  * @Min: 0
212*5113495bSYour Name  * @Max: 1
213*5113495bSYour Name  * @Default: 1
214*5113495bSYour Name  *
215*5113495bSYour Name  * This ini is used to enable/disable fils discovery in sap mode
216*5113495bSYour Name  *
217*5113495bSYour Name  * Related: None
218*5113495bSYour Name  *
219*5113495bSYour Name  * Supported Feature: FILS
220*5113495bSYour Name  *
221*5113495bSYour Name  * Usage: External
222*5113495bSYour Name  *
223*5113495bSYour Name  * </ini>
224*5113495bSYour Name  */
225*5113495bSYour Name #define CFG_ENABLE_FILS_DISCOVERY_SAP CFG_INI_BOOL( \
226*5113495bSYour Name 		"oce_enable_fils_discovery_sap", \
227*5113495bSYour Name 		1, \
228*5113495bSYour Name 		"Enable/disable fils discovery in sap mode")
229*5113495bSYour Name 
230*5113495bSYour Name /*
231*5113495bSYour Name  * <ini>
232*5113495bSYour Name  * enable_esp_for_roam - Enable/disable esp feature
233*5113495bSYour Name  * @Min: 0
234*5113495bSYour Name  * @Max: 1
235*5113495bSYour Name  * @Default: 1
236*5113495bSYour Name  *
237*5113495bSYour Name  * This ini is used to enable/disable ESP(Estimated service parameters) IE
238*5113495bSYour Name  * parsing and decides whether firmware will include this in its scoring algo.
239*5113495bSYour Name  *
240*5113495bSYour Name  * Related: None
241*5113495bSYour Name  *
242*5113495bSYour Name  * Supported Feature: STA
243*5113495bSYour Name  *
244*5113495bSYour Name  * Usage: External
245*5113495bSYour Name  *
246*5113495bSYour Name  * </ini>
247*5113495bSYour Name  */
248*5113495bSYour Name #define CFG_ENABLE_ESP_FEATURE CFG_INI_BOOL( \
249*5113495bSYour Name 		"enable_esp_for_roam", \
250*5113495bSYour Name 		1, \
251*5113495bSYour Name 		"Enable/disable esp feature")
252*5113495bSYour Name 
253*5113495bSYour Name /*
254*5113495bSYour Name  * <ini>
255*5113495bSYour Name  * g_is_fils_enabled - Enable/Disable FILS support in driver
256*5113495bSYour Name  * @Min: 0
257*5113495bSYour Name  * @Max: 1
258*5113495bSYour Name  * @Default: 1
259*5113495bSYour Name  *
260*5113495bSYour Name  * This ini is used to enable/disable FILS support in driver
261*5113495bSYour Name  * Driver will update config to supplicant based on this config.
262*5113495bSYour Name  *
263*5113495bSYour Name  * Related: None
264*5113495bSYour Name  *
265*5113495bSYour Name  * Supported Feature: FILS
266*5113495bSYour Name  *
267*5113495bSYour Name  * Usage: External
268*5113495bSYour Name  *
269*5113495bSYour Name  * </ini>
270*5113495bSYour Name  */
271*5113495bSYour Name #define CFG_IS_FILS_ENABLED CFG_INI_BOOL( \
272*5113495bSYour Name 		"g_is_fils_enabled", \
273*5113495bSYour Name 		1, \
274*5113495bSYour Name 		"Enable/disable support")
275*5113495bSYour Name 
276*5113495bSYour Name #define CFG_OCE_ALL \
277*5113495bSYour Name 	CFG(CFG_ENABLE_BCAST_PROBE_RESP) \
278*5113495bSYour Name 	CFG(CFG_OCE_ENABLE_STA) \
279*5113495bSYour Name 	CFG(CFG_OCE_ENABLE_SAP) \
280*5113495bSYour Name 	CFG(CFG_OCE_ENABLE_RSSI_BASED_ASSOC_REJECT) \
281*5113495bSYour Name 	CFG(CFG_OCE_PROBE_REQ_RATE) \
282*5113495bSYour Name 	CFG(CFG_OCE_PROBE_RSP_RATE) \
283*5113495bSYour Name 	CFG(CFG_OCE_BEACON_RATE) \
284*5113495bSYour Name 	CFG(CFG_ENABLE_PROBE_REQ_DEFERRAL) \
285*5113495bSYour Name 	CFG(CFG_ENABLE_FILS_DISCOVERY_SAP) \
286*5113495bSYour Name 	CFG(CFG_ENABLE_ESP_FEATURE) \
287*5113495bSYour Name 	CFG(CFG_IS_FILS_ENABLED)
288*5113495bSYour Name #endif /* __CFG_MLME_OCE_H */
289