xref: /wlan-driver/qca-wifi-host-cmn/umac/scan/dispatcher/inc/cfg_extscan.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2012-2021 The Linux Foundation. All rights reserved.
3  *
4  * Permission to use, copy, modify, and/or distribute this software for
5  * any purpose with or without fee is hereby granted, provided that the
6  * above copyright notice and this permission notice appear in all
7  * copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16  * PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 /**
20  * DOC: This file contains centralized definitions of EXTSCAN component
21  */
22 #ifndef _CONFIG_EXTSCAN_H_
23 #define _CONFIG_EXTSCAN_H_
24 
25 #include "cfg_define.h"
26 
27 #ifdef FEATURE_WLAN_EXTSCAN
28 
29 /*
30  * <ini>
31  * gExtScanPassiveMaxChannelTime - Set max channel time for external
32  * passive scan
33  * @Min: 0
34  * @Max: 500
35  * @Default: 110
36  *
37  * This ini is used to set maximum channel time  in secs spent in
38  * external passive scan
39  *
40  * Related: None
41  *
42  * Supported Feature: Scan
43  *
44  * Usage: External
45  *
46  * </ini>
47  */
48 #define CFG_EXTSCAN_PASSIVE_MAX_CHANNEL_TIME CFG_INI_UINT(\
49 		"gExtScanPassiveMaxChannelTime",\
50 		0, 500, 110, CFG_VALUE_OR_DEFAULT,\
51 		"ext scan passive max channel time")
52 
53 /*
54  * <ini>
55  * gExtScanPassiveMinChannelTime - Set min channel time for external
56  * passive scan
57  * @Min: 0
58  * @Max: 500
59  * @Default: 60
60  *
61  * This ini is used to set minimum channel time in secs spent in
62  * external passive scan
63  *
64  * Related: None
65  *
66  * Supported Feature: Scan
67  *
68  * Usage: External
69  *
70  * </ini>
71  */
72 #define CFG_EXTSCAN_PASSIVE_MIN_CHANNEL_TIME CFG_INI_UINT(\
73 		"gExtScanPassiveMinChannelTime",\
74 		0, 500, 60, CFG_VALUE_OR_DEFAULT,\
75 		"ext scan passive min channel time")
76 
77 /*
78  * <ini>
79  * gExtScanActiveMaxChannelTime - Set min channel time for external
80  * active scan
81  * @Min: 0
82  * @Max: 110
83  * @Default: 40
84  *
85  * This ini is used to set maximum channel time in secs spent in
86  * external active scan
87  *
88  * Related: None
89  *
90  * Supported Feature: Scan
91  *
92  * Usage: External
93  *
94  * </ini>
95  */
96 
97 #define CFG_EXTSCAN_ACTIVE_MAX_CHANNEL_TIME CFG_INI_UINT(\
98 		"gExtScanActiveMaxChannelTime",\
99 		0, 110, 40, CFG_VALUE_OR_DEFAULT,\
100 		"ext scan active max channel time")
101 
102 /*
103  * <ini>
104  * gExtScanActiveMinChannelTime - Set min channel time for external
105  * active scan
106  * @Min: 0
107  * @Max: 110
108  * @Default: 20
109  *
110  * This ini is used to set minimum channel time in secs spent in
111  * external active scan
112  *
113  * Related: None
114  *
115  * Supported Feature: Scan
116  *
117  * Usage: External
118  *
119  * </ini>
120  */
121 #define CFG_EXTSCAN_ACTIVE_MIN_CHANNEL_TIME CFG_INI_UINT(\
122 		"gExtScanActiveMinChannelTime",\
123 		0, 110, 20, CFG_VALUE_OR_DEFAULT,\
124 		"ext scan active min channel time")
125 
126 /*
127  * <ini>
128  * gExtScanEnable - Enable external scan
129  * @Min: 0
130  * @Max: 1
131  * @Default: 1
132  *
133  * This ini is used to control enabling of external scan
134  * feature.
135  *
136  * Related: None
137  *
138  * Supported Feature: Scan
139  *
140  * Usage: External
141  *
142  * </ini>
143  */
144 #define CFG_EXTSCAN_ALLOWED CFG_INI_BOOL(\
145 		"gExtScanEnable",\
146 		1,\
147 		"ext scan enable")
148 
149 #define CFG_EXTSCAN_ALL \
150 	CFG(CFG_EXTSCAN_PASSIVE_MAX_CHANNEL_TIME) \
151 	CFG(CFG_EXTSCAN_PASSIVE_MIN_CHANNEL_TIME) \
152 	CFG(CFG_EXTSCAN_ACTIVE_MAX_CHANNEL_TIME) \
153 	CFG(CFG_EXTSCAN_ACTIVE_MIN_CHANNEL_TIME) \
154 	CFG(CFG_EXTSCAN_ALLOWED)
155 
156 #else
157 #define CFG_EXTSCAN_ALL
158 #endif
159 #endif
160