• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * ACS - Automatic Channel Selection module
3  * Copyright (c) 2011, Atheros Communications
4  * Copyright (c) 2013, Qualcomm Atheros, Inc.
5  *
6  * This software may be distributed under the terms of the BSD license.
7  * See README for more details.
8  */
9 
10 #include "utils/includes.h"
11 #include <math.h>
12 
13 #include "utils/common.h"
14 #include "utils/list.h"
15 #include "common/ieee802_11_defs.h"
16 #include "common/hw_features_common.h"
17 #include "common/wpa_ctrl.h"
18 #include "drivers/driver.h"
19 #include "hostapd.h"
20 #include "ap_drv_ops.h"
21 #include "ap_config.h"
22 #include "hw_features.h"
23 #include "acs.h"
24 
25 /*
26  * Automatic Channel Selection
27  * ===========================
28  *
29  * More info at
30  * ------------
31  * http://wireless.kernel.org/en/users/Documentation/acs
32  *
33  * How to use
34  * ----------
35  * - make sure you have CONFIG_ACS=y in hostapd's .config
36  * - use channel=0 or channel=acs to enable ACS
37  *
38  * How does it work
39  * ----------------
40  * 1. passive scans are used to collect survey data
41  *    (it is assumed that scan trigger collection of survey data in driver)
42  * 2. interference factor is calculated for each channel
43  * 3. ideal channel is picked depending on channel width by using adjacent
44  *    channel interference factors
45  *
46  * Known limitations
47  * -----------------
48  * - Current implementation depends heavily on the amount of time willing to
49  *   spend gathering survey data during hostapd startup. Short traffic bursts
50  *   may be missed and a suboptimal channel may be picked.
51  * - Ideal channel may end up overlapping a channel with 40 MHz intolerant BSS
52  *
53  * Todo / Ideas
54  * ------------
55  * - implement other interference computation methods
56  *   - BSS/RSSI based
57  *   - spectral scan based
58  *   (should be possibly to hook this up with current ACS scans)
59  * - add wpa_supplicant support (for P2P)
60  * - collect a histogram of interference over time allowing more educated
61  *   guess about an ideal channel (perhaps CSA could be used to migrate AP to a
62  *   new "better" channel while running)
63  * - include neighboring BSS scan to avoid conflicts with 40 MHz intolerant BSSs
64  *   when choosing the ideal channel
65  *
66  * Survey interference factor implementation details
67  * -------------------------------------------------
68  * Generic interference_factor in struct hostapd_channel_data is used.
69  *
70  * The survey interference factor is defined as the ratio of the
71  * observed busy time over the time we spent on the channel,
72  * this value is then amplified by the observed noise floor on
73  * the channel in comparison to the lowest noise floor observed
74  * on the entire band.
75  *
76  * This corresponds to:
77  * ---
78  * (busy time - tx time) / (active time - tx time) * 2^(chan_nf + band_min_nf)
79  * ---
80  *
81  * The coefficient of 2 reflects the way power in "far-field"
82  * radiation decreases as the square of distance from the antenna [1].
83  * What this does is it decreases the observed busy time ratio if the
84  * noise observed was low but increases it if the noise was high,
85  * proportionally to the way "far field" radiation changes over
86  * distance.
87  *
88  * If channel busy time is not available the fallback is to use channel RX time.
89  *
90  * Since noise floor is in dBm it is necessary to convert it into Watts so that
91  * combined channel interference (e.g., HT40, which uses two channels) can be
92  * calculated easily.
93  * ---
94  * (busy time - tx time) / (active time - tx time) *
95  *    2^(10^(chan_nf/10) + 10^(band_min_nf/10))
96  * ---
97  *
98  * However to account for cases where busy/rx time is 0 (channel load is then
99  * 0%) channel noise floor signal power is combined into the equation so a
100  * channel with lower noise floor is preferred. The equation becomes:
101  * ---
102  * 10^(chan_nf/5) + (busy time - tx time) / (active time - tx time) *
103  *    2^(10^(chan_nf/10) + 10^(band_min_nf/10))
104  * ---
105  *
106  * All this "interference factor" is purely subjective and only time
107  * will tell how usable this is. By using the minimum noise floor we
108  * remove any possible issues due to card calibration. The computation
109  * of the interference factor then is dependent on what the card itself
110  * picks up as the minimum noise, not an actual real possible card
111  * noise value.
112  *
113  * Total interference computation details
114  * --------------------------------------
115  * The above channel interference factor is calculated with no respect to
116  * target operational bandwidth.
117  *
118  * To find an ideal channel the above data is combined by taking into account
119  * the target operational bandwidth and selected band. E.g., on 2.4 GHz channels
120  * overlap with 20 MHz bandwidth, but there is no overlap for 20 MHz bandwidth
121  * on 5 GHz.
122  *
123  * Each valid and possible channel spec (i.e., channel + width) is taken and its
124  * interference factor is computed by summing up interferences of each channel
125  * it overlaps. The one with least total interference is picked up.
126  *
127  * Note: This implies base channel interference factor must be non-negative
128  * allowing easy summing up.
129  *
130  * Example ACS analysis printout
131  * -----------------------------
132  *
133  * ACS: Trying survey-based ACS
134  * ACS: Survey analysis for channel 1 (2412 MHz)
135  * ACS:  1: min_nf=-113 interference_factor=0.0802469 nf=-113 time=162 busy=0 rx=13
136  * ACS:  2: min_nf=-113 interference_factor=0.0745342 nf=-113 time=161 busy=0 rx=12
137  * ACS:  3: min_nf=-113 interference_factor=0.0679012 nf=-113 time=162 busy=0 rx=11
138  * ACS:  4: min_nf=-113 interference_factor=0.0310559 nf=-113 time=161 busy=0 rx=5
139  * ACS:  5: min_nf=-113 interference_factor=0.0248447 nf=-113 time=161 busy=0 rx=4
140  * ACS:  * interference factor average: 0.0557166
141  * ACS: Survey analysis for channel 2 (2417 MHz)
142  * ACS:  1: min_nf=-113 interference_factor=0.0185185 nf=-113 time=162 busy=0 rx=3
143  * ACS:  2: min_nf=-113 interference_factor=0.0246914 nf=-113 time=162 busy=0 rx=4
144  * ACS:  3: min_nf=-113 interference_factor=0.037037 nf=-113 time=162 busy=0 rx=6
145  * ACS:  4: min_nf=-113 interference_factor=0.149068 nf=-113 time=161 busy=0 rx=24
146  * ACS:  5: min_nf=-113 interference_factor=0.0248447 nf=-113 time=161 busy=0 rx=4
147  * ACS:  * interference factor average: 0.050832
148  * ACS: Survey analysis for channel 3 (2422 MHz)
149  * ACS:  1: min_nf=-113 interference_factor=2.51189e-23 nf=-113 time=162 busy=0 rx=0
150  * ACS:  2: min_nf=-113 interference_factor=0.0185185 nf=-113 time=162 busy=0 rx=3
151  * ACS:  3: min_nf=-113 interference_factor=0.0186335 nf=-113 time=161 busy=0 rx=3
152  * ACS:  4: min_nf=-113 interference_factor=0.0186335 nf=-113 time=161 busy=0 rx=3
153  * ACS:  5: min_nf=-113 interference_factor=0.0186335 nf=-113 time=161 busy=0 rx=3
154  * ACS:  * interference factor average: 0.0148838
155  * ACS: Survey analysis for channel 4 (2427 MHz)
156  * ACS:  1: min_nf=-114 interference_factor=1.58489e-23 nf=-114 time=162 busy=0 rx=0
157  * ACS:  2: min_nf=-114 interference_factor=0.0555556 nf=-114 time=162 busy=0 rx=9
158  * ACS:  3: min_nf=-114 interference_factor=1.58489e-23 nf=-114 time=161 busy=0 rx=0
159  * ACS:  4: min_nf=-114 interference_factor=0.0186335 nf=-114 time=161 busy=0 rx=3
160  * ACS:  5: min_nf=-114 interference_factor=0.00621118 nf=-114 time=161 busy=0 rx=1
161  * ACS:  * interference factor average: 0.0160801
162  * ACS: Survey analysis for channel 5 (2432 MHz)
163  * ACS:  1: min_nf=-114 interference_factor=0.409938 nf=-113 time=161 busy=0 rx=66
164  * ACS:  2: min_nf=-114 interference_factor=0.0432099 nf=-113 time=162 busy=0 rx=7
165  * ACS:  3: min_nf=-114 interference_factor=0.0124224 nf=-113 time=161 busy=0 rx=2
166  * ACS:  4: min_nf=-114 interference_factor=0.677019 nf=-113 time=161 busy=0 rx=109
167  * ACS:  5: min_nf=-114 interference_factor=0.0186335 nf=-114 time=161 busy=0 rx=3
168  * ACS:  * interference factor average: 0.232244
169  * ACS: Survey analysis for channel 6 (2437 MHz)
170  * ACS:  1: min_nf=-113 interference_factor=0.552795 nf=-113 time=161 busy=0 rx=89
171  * ACS:  2: min_nf=-113 interference_factor=0.0807453 nf=-112 time=161 busy=0 rx=13
172  * ACS:  3: min_nf=-113 interference_factor=0.0310559 nf=-113 time=161 busy=0 rx=5
173  * ACS:  4: min_nf=-113 interference_factor=0.434783 nf=-112 time=161 busy=0 rx=70
174  * ACS:  5: min_nf=-113 interference_factor=0.0621118 nf=-113 time=161 busy=0 rx=10
175  * ACS:  * interference factor average: 0.232298
176  * ACS: Survey analysis for channel 7 (2442 MHz)
177  * ACS:  1: min_nf=-113 interference_factor=0.440994 nf=-112 time=161 busy=0 rx=71
178  * ACS:  2: min_nf=-113 interference_factor=0.385093 nf=-113 time=161 busy=0 rx=62
179  * ACS:  3: min_nf=-113 interference_factor=0.0372671 nf=-113 time=161 busy=0 rx=6
180  * ACS:  4: min_nf=-113 interference_factor=0.0372671 nf=-113 time=161 busy=0 rx=6
181  * ACS:  5: min_nf=-113 interference_factor=0.0745342 nf=-113 time=161 busy=0 rx=12
182  * ACS:  * interference factor average: 0.195031
183  * ACS: Survey analysis for channel 8 (2447 MHz)
184  * ACS:  1: min_nf=-114 interference_factor=0.0496894 nf=-112 time=161 busy=0 rx=8
185  * ACS:  2: min_nf=-114 interference_factor=0.0496894 nf=-114 time=161 busy=0 rx=8
186  * ACS:  3: min_nf=-114 interference_factor=0.0372671 nf=-113 time=161 busy=0 rx=6
187  * ACS:  4: min_nf=-114 interference_factor=0.12963 nf=-113 time=162 busy=0 rx=21
188  * ACS:  5: min_nf=-114 interference_factor=0.166667 nf=-114 time=162 busy=0 rx=27
189  * ACS:  * interference factor average: 0.0865885
190  * ACS: Survey analysis for channel 9 (2452 MHz)
191  * ACS:  1: min_nf=-114 interference_factor=0.0124224 nf=-114 time=161 busy=0 rx=2
192  * ACS:  2: min_nf=-114 interference_factor=0.0310559 nf=-114 time=161 busy=0 rx=5
193  * ACS:  3: min_nf=-114 interference_factor=1.58489e-23 nf=-114 time=161 busy=0 rx=0
194  * ACS:  4: min_nf=-114 interference_factor=0.00617284 nf=-114 time=162 busy=0 rx=1
195  * ACS:  5: min_nf=-114 interference_factor=1.58489e-23 nf=-114 time=162 busy=0 rx=0
196  * ACS:  * interference factor average: 0.00993022
197  * ACS: Survey analysis for channel 10 (2457 MHz)
198  * ACS:  1: min_nf=-114 interference_factor=0.00621118 nf=-114 time=161 busy=0 rx=1
199  * ACS:  2: min_nf=-114 interference_factor=0.00621118 nf=-114 time=161 busy=0 rx=1
200  * ACS:  3: min_nf=-114 interference_factor=0.00621118 nf=-114 time=161 busy=0 rx=1
201  * ACS:  4: min_nf=-114 interference_factor=0.0493827 nf=-114 time=162 busy=0 rx=8
202  * ACS:  5: min_nf=-114 interference_factor=1.58489e-23 nf=-114 time=162 busy=0 rx=0
203  * ACS:  * interference factor average: 0.0136033
204  * ACS: Survey analysis for channel 11 (2462 MHz)
205  * ACS:  1: min_nf=-114 interference_factor=1.58489e-23 nf=-114 time=161 busy=0 rx=0
206  * ACS:  2: min_nf=-114 interference_factor=2.51189e-23 nf=-113 time=161 busy=0 rx=0
207  * ACS:  3: min_nf=-114 interference_factor=2.51189e-23 nf=-113 time=161 busy=0 rx=0
208  * ACS:  4: min_nf=-114 interference_factor=0.0432099 nf=-114 time=162 busy=0 rx=7
209  * ACS:  5: min_nf=-114 interference_factor=0.0925926 nf=-114 time=162 busy=0 rx=15
210  * ACS:  * interference factor average: 0.0271605
211  * ACS: Survey analysis for channel 12 (2467 MHz)
212  * ACS:  1: min_nf=-114 interference_factor=0.0621118 nf=-113 time=161 busy=0 rx=10
213  * ACS:  2: min_nf=-114 interference_factor=0.00621118 nf=-114 time=161 busy=0 rx=1
214  * ACS:  3: min_nf=-114 interference_factor=2.51189e-23 nf=-113 time=162 busy=0 rx=0
215  * ACS:  4: min_nf=-114 interference_factor=2.51189e-23 nf=-113 time=162 busy=0 rx=0
216  * ACS:  5: min_nf=-114 interference_factor=0.00617284 nf=-113 time=162 busy=0 rx=1
217  * ACS:  * interference factor average: 0.0148992
218  * ACS: Survey analysis for channel 13 (2472 MHz)
219  * ACS:  1: min_nf=-114 interference_factor=0.0745342 nf=-114 time=161 busy=0 rx=12
220  * ACS:  2: min_nf=-114 interference_factor=0.0555556 nf=-114 time=162 busy=0 rx=9
221  * ACS:  3: min_nf=-114 interference_factor=1.58489e-23 nf=-114 time=162 busy=0 rx=0
222  * ACS:  4: min_nf=-114 interference_factor=1.58489e-23 nf=-114 time=162 busy=0 rx=0
223  * ACS:  5: min_nf=-114 interference_factor=1.58489e-23 nf=-114 time=162 busy=0 rx=0
224  * ACS:  * interference factor average: 0.0260179
225  * ACS: Survey analysis for selected bandwidth 20MHz
226  * ACS:  * channel 1: total interference = 0.121432
227  * ACS:  * channel 2: total interference = 0.137512
228  * ACS:  * channel 3: total interference = 0.369757
229  * ACS:  * channel 4: total interference = 0.546338
230  * ACS:  * channel 5: total interference = 0.690538
231  * ACS:  * channel 6: total interference = 0.762242
232  * ACS:  * channel 7: total interference = 0.756092
233  * ACS:  * channel 8: total interference = 0.537451
234  * ACS:  * channel 9: total interference = 0.332313
235  * ACS:  * channel 10: total interference = 0.152182
236  * ACS:  * channel 11: total interference = 0.0916111
237  * ACS:  * channel 12: total interference = 0.0816809
238  * ACS:  * channel 13: total interference = 0.0680776
239  * ACS: Ideal channel is 13 (2472 MHz) with total interference factor of 0.0680776
240  *
241  * [1] http://en.wikipedia.org/wiki/Near_and_far_field
242  */
243 
244 enum bw_type {
245 	ACS_BW40,
246 	ACS_BW80,
247 	ACS_BW160,
248 };
249 
250 struct bw_item {
251 	int first;
252 	int last;
253 	int center_chan;
254 };
255 
256 static const struct bw_item bw_40[] = {
257 	{ 5180, 5200, 38 }, { 5220, 5240, 46 }, { 5260, 5280, 54 },
258 	{ 5300, 5320, 62 }, { 5500, 5520, 102 }, { 5540, 5560, 110 },
259 	{ 5580, 5600, 110 }, { 5620, 5640, 126}, { 5660, 5680, 134 },
260 	{ 5700, 5720, 142 }, { 5745, 5765, 151 }, { 5785, 5805, 159 },
261 	{ 5825, 5845, 167 }, { 5865, 5885, 175 },
262 	{ 5955, 5975, 3 }, { 5995, 6015, 11 }, { 6035, 6055, 19 },
263 	{ 6075, 6095, 27 }, { 6115, 6135, 35 }, { 6155, 6175, 43 },
264 	{ 6195, 6215, 51 }, { 6235, 6255, 59 }, { 6275, 6295, 67 },
265 	{ 6315, 6335, 75 }, { 6355, 6375, 83 }, { 6395, 6415, 91 },
266 	{ 6435, 6455, 99 }, { 6475, 6495, 107 }, { 6515, 6535, 115 },
267 	{ 6555, 6575, 123 }, { 6595, 6615, 131 }, { 6635, 6655, 139 },
268 	{ 6675, 6695, 147 }, { 6715, 6735, 155 }, { 6755, 6775, 163 },
269 	{ 6795, 6815, 171 }, { 6835, 6855, 179 }, { 6875, 6895, 187 },
270 	{ 6915, 6935, 195 }, { 6955, 6975, 203 }, { 6995, 7015, 211 },
271 	{ 7035, 7055, 219 }, { 7075, 7095, 227}, { -1, -1, -1 }
272 };
273 static const struct bw_item bw_80[] = {
274 	{ 5180, 5240, 42 }, { 5260, 5320, 58 }, { 5500, 5560, 106 },
275 	{ 5580, 5640, 122 }, { 5660, 5720, 138 }, { 5745, 5805, 155 },
276 	{ 5825, 5885, 171},
277 	{ 5955, 6015, 7 }, { 6035, 6095, 23 }, { 6115, 6175, 39 },
278 	{ 6195, 6255, 55 }, { 6275, 6335, 71 }, { 6355, 6415, 87 },
279 	{ 6435, 6495, 103 }, { 6515, 6575, 119 }, { 6595, 6655, 135 },
280 	{ 6675, 6735, 151 }, { 6755, 6815, 167 }, { 6835, 6895, 183 },
281 	{ 6915, 6975, 199 }, { 6995, 7055, 215 }, { -1, -1, -1 }
282 };
283 static const struct bw_item bw_160[] = {
284 	{ 5180, 5320, 50 }, { 5500, 5640, 114 }, { 5745, 5885, 163 },
285 	{ 5955, 6095, 15 }, { 6115, 6255, 47 }, { 6275, 6415, 79 },
286 	{ 6435, 6575, 111 }, { 6595, 6735, 143 },
287 	{ 6755, 6895, 175 }, { 6915, 7055, 207 }, { -1, -1, -1 }
288 };
289 static const struct bw_item *bw_desc[] = {
290 	[ACS_BW40] = bw_40,
291 	[ACS_BW80] = bw_80,
292 	[ACS_BW160] = bw_160,
293 };
294 
295 
296 static int acs_request_scan(struct hostapd_iface *iface);
297 static int acs_survey_is_sufficient(struct freq_survey *survey);
298 
299 
acs_clean_chan_surveys(struct hostapd_channel_data * chan)300 static void acs_clean_chan_surveys(struct hostapd_channel_data *chan)
301 {
302 	struct freq_survey *survey, *tmp;
303 
304 	if (dl_list_empty(&chan->survey_list))
305 		return;
306 
307 	dl_list_for_each_safe(survey, tmp, &chan->survey_list,
308 			      struct freq_survey, list) {
309 		dl_list_del(&survey->list);
310 		os_free(survey);
311 	}
312 }
313 
314 
acs_cleanup_mode(struct hostapd_hw_modes * mode)315 static void acs_cleanup_mode(struct hostapd_hw_modes *mode)
316 {
317 	int i;
318 	struct hostapd_channel_data *chan;
319 
320 	for (i = 0; i < mode->num_channels; i++) {
321 		chan = &mode->channels[i];
322 
323 		if (chan->flag & HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED)
324 			acs_clean_chan_surveys(chan);
325 
326 		dl_list_init(&chan->survey_list);
327 		chan->flag |= HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED;
328 		chan->min_nf = 0;
329 		chan->punct_bitmap = 0;
330 	}
331 }
332 
333 
acs_cleanup(struct hostapd_iface * iface)334 void acs_cleanup(struct hostapd_iface *iface)
335 {
336 	int i;
337 
338 	for (i = 0; i < iface->num_hw_features; i++)
339 		acs_cleanup_mode(&iface->hw_features[i]);
340 
341 	iface->chans_surveyed = 0;
342 	iface->acs_num_completed_scans = 0;
343 }
344 
345 
acs_fail(struct hostapd_iface * iface)346 static void acs_fail(struct hostapd_iface *iface)
347 {
348 	wpa_printf(MSG_ERROR, "ACS: Failed to start");
349 	acs_cleanup(iface);
350 	hostapd_disable_iface(iface);
351 }
352 
353 
354 static long double
acs_survey_interference_factor(struct freq_survey * survey,s8 min_nf)355 acs_survey_interference_factor(struct freq_survey *survey, s8 min_nf)
356 {
357 	long double factor, busy, total;
358 
359 	if (survey->filled & SURVEY_HAS_CHAN_TIME_BUSY)
360 		busy = survey->channel_time_busy;
361 	else if (survey->filled & SURVEY_HAS_CHAN_TIME_RX)
362 		busy = survey->channel_time_rx;
363 	else {
364 		wpa_printf(MSG_ERROR, "ACS: Survey data missing");
365 		return 0;
366 	}
367 
368 	total = survey->channel_time;
369 
370 	if (survey->filled & SURVEY_HAS_CHAN_TIME_TX) {
371 		busy -= survey->channel_time_tx;
372 		total -= survey->channel_time_tx;
373 	}
374 
375 	/* TODO: figure out the best multiplier for noise floor base */
376 	factor = pow(10, survey->nf / 5.0L) +
377 		(total ? (busy / total) : 0) *
378 		pow(2, pow(10, (long double) survey->nf / 10.0L) -
379 		    pow(10, (long double) min_nf / 10.0L));
380 
381 	return factor;
382 }
383 
384 
385 static void
acs_survey_chan_interference_factor(struct hostapd_iface * iface,struct hostapd_channel_data * chan)386 acs_survey_chan_interference_factor(struct hostapd_iface *iface,
387 				    struct hostapd_channel_data *chan)
388 {
389 	struct freq_survey *survey;
390 	unsigned int i = 0;
391 	long double int_factor = 0;
392 	unsigned count = 0;
393 
394 	if (dl_list_empty(&chan->survey_list) ||
395 	    (chan->flag & HOSTAPD_CHAN_DISABLED))
396 		return;
397 
398 	chan->interference_factor = 0;
399 
400 	dl_list_for_each(survey, &chan->survey_list, struct freq_survey, list)
401 	{
402 		i++;
403 
404 		if (!acs_survey_is_sufficient(survey)) {
405 			wpa_printf(MSG_DEBUG, "ACS: %d: insufficient data", i);
406 			continue;
407 		}
408 
409 		count++;
410 		int_factor = acs_survey_interference_factor(survey,
411 							    iface->lowest_nf);
412 		chan->interference_factor += int_factor;
413 		wpa_printf(MSG_DEBUG, "ACS: %d: min_nf=%d interference_factor=%Lg nf=%d time=%lu busy=%lu rx=%lu",
414 			   i, chan->min_nf, int_factor,
415 			   survey->nf, (unsigned long) survey->channel_time,
416 			   (unsigned long) survey->channel_time_busy,
417 			   (unsigned long) survey->channel_time_rx);
418 	}
419 
420 	if (count)
421 		chan->interference_factor /= count;
422 }
423 
424 
acs_usable_bw_chan(const struct hostapd_channel_data * chan,enum bw_type bw)425 static bool acs_usable_bw_chan(const struct hostapd_channel_data *chan,
426 			       enum bw_type bw)
427 {
428 	unsigned int i = 0;
429 
430 	while (bw_desc[bw][i].first != -1) {
431 		if (chan->freq == bw_desc[bw][i].first)
432 			return true;
433 		i++;
434 	}
435 
436 	return false;
437 }
438 
439 
acs_get_bw_center_chan(int freq,enum bw_type bw)440 static int acs_get_bw_center_chan(int freq, enum bw_type bw)
441 {
442 	unsigned int i = 0;
443 
444 	while (bw_desc[bw][i].first != -1) {
445 		if (freq >= bw_desc[bw][i].first &&
446 		    freq <= bw_desc[bw][i].last)
447 			return bw_desc[bw][i].center_chan;
448 		i++;
449 	}
450 
451 	return 0;
452 }
453 
454 
acs_survey_is_sufficient(struct freq_survey * survey)455 static int acs_survey_is_sufficient(struct freq_survey *survey)
456 {
457 	if (!(survey->filled & SURVEY_HAS_NF)) {
458 		wpa_printf(MSG_INFO,
459 			   "ACS: Survey for freq %d is missing noise floor",
460 			   survey->freq);
461 		return 0;
462 	}
463 
464 	if (!(survey->filled & SURVEY_HAS_CHAN_TIME)) {
465 		wpa_printf(MSG_INFO,
466 			   "ACS: Survey for freq %d is missing channel time",
467 			   survey->freq);
468 		return 0;
469 	}
470 
471 	if (!(survey->filled & SURVEY_HAS_CHAN_TIME_BUSY) &&
472 	    !(survey->filled & SURVEY_HAS_CHAN_TIME_RX)) {
473 		wpa_printf(MSG_INFO,
474 			   "ACS: Survey for freq %d is missing RX and busy time (at least one is required)",
475 			   survey->freq);
476 		return 0;
477 	}
478 
479 	return 1;
480 }
481 
482 
acs_survey_list_is_sufficient(struct hostapd_channel_data * chan)483 static int acs_survey_list_is_sufficient(struct hostapd_channel_data *chan)
484 {
485 	struct freq_survey *survey;
486 	int ret = -1;
487 
488 	dl_list_for_each(survey, &chan->survey_list, struct freq_survey, list)
489 	{
490 		if (acs_survey_is_sufficient(survey)) {
491 			ret = 1;
492 			break;
493 		}
494 		ret = 0;
495 	}
496 
497 	if (ret == -1)
498 		ret = 1; /* no survey list entries */
499 
500 	if (!ret) {
501 		wpa_printf(MSG_INFO,
502 			   "ACS: Channel %d has insufficient survey data",
503 			   chan->chan);
504 	}
505 
506 	return ret;
507 }
508 
509 
acs_surveys_are_sufficient_mode(struct hostapd_hw_modes * mode)510 static int acs_surveys_are_sufficient_mode(struct hostapd_hw_modes *mode)
511 {
512 	int i;
513 	struct hostapd_channel_data *chan;
514 
515 	for (i = 0; i < mode->num_channels; i++) {
516 		chan = &mode->channels[i];
517 		if (!(chan->flag & HOSTAPD_CHAN_DISABLED) &&
518 		    acs_survey_list_is_sufficient(chan))
519 			return 1;
520 	}
521 
522 	return 0;
523 }
524 
525 
acs_surveys_are_sufficient(struct hostapd_iface * iface)526 static int acs_surveys_are_sufficient(struct hostapd_iface *iface)
527 {
528 	int i;
529 	struct hostapd_hw_modes *mode;
530 
531 	for (i = 0; i < iface->num_hw_features; i++) {
532 		mode = &iface->hw_features[i];
533 		if (!hostapd_hw_skip_mode(iface, mode) &&
534 		    acs_surveys_are_sufficient_mode(mode))
535 			return 1;
536 	}
537 
538 	return 0;
539 }
540 
541 
acs_usable_chan(struct hostapd_channel_data * chan)542 static int acs_usable_chan(struct hostapd_channel_data *chan)
543 {
544 	return !dl_list_empty(&chan->survey_list) &&
545 		!(chan->flag & HOSTAPD_CHAN_DISABLED) &&
546 		acs_survey_list_is_sufficient(chan);
547 }
548 
549 
is_in_chanlist(struct hostapd_iface * iface,struct hostapd_channel_data * chan)550 static int is_in_chanlist(struct hostapd_iface *iface,
551 			  struct hostapd_channel_data *chan)
552 {
553 	if (!iface->conf->acs_ch_list.num)
554 		return 1;
555 
556 	return freq_range_list_includes(&iface->conf->acs_ch_list, chan->chan);
557 }
558 
559 
is_in_freqlist(struct hostapd_iface * iface,struct hostapd_channel_data * chan)560 static int is_in_freqlist(struct hostapd_iface *iface,
561 			  struct hostapd_channel_data *chan)
562 {
563 	if (!iface->conf->acs_freq_list.num)
564 		return 1;
565 
566 	return freq_range_list_includes(&iface->conf->acs_freq_list,
567 					chan->freq);
568 }
569 
570 
acs_survey_mode_interference_factor(struct hostapd_iface * iface,struct hostapd_hw_modes * mode)571 static void acs_survey_mode_interference_factor(
572 	struct hostapd_iface *iface, struct hostapd_hw_modes *mode)
573 {
574 	int i;
575 	struct hostapd_channel_data *chan;
576 
577 	for (i = 0; i < mode->num_channels; i++) {
578 		chan = &mode->channels[i];
579 
580 		if (!acs_usable_chan(chan))
581 			continue;
582 
583 		if ((chan->flag & HOSTAPD_CHAN_RADAR) &&
584 		    iface->conf->acs_exclude_dfs)
585 			continue;
586 
587 		if (!is_in_chanlist(iface, chan))
588 			continue;
589 
590 		if (!is_in_freqlist(iface, chan))
591 			continue;
592 
593 		if (chan->max_tx_power < iface->conf->min_tx_power)
594 			continue;
595 
596 		if ((chan->flag & HOSTAPD_CHAN_INDOOR_ONLY) &&
597 		    iface->conf->country[2] == 0x4f)
598 			continue;
599 
600 		wpa_printf(MSG_DEBUG, "ACS: Survey analysis for channel %d (%d MHz)",
601 			   chan->chan, chan->freq);
602 
603 		acs_survey_chan_interference_factor(iface, chan);
604 
605 		wpa_printf(MSG_DEBUG, "ACS:  * interference factor average: %Lg",
606 			   chan->interference_factor);
607 	}
608 }
609 
610 
acs_survey_all_chans_interference_factor(struct hostapd_iface * iface)611 static void acs_survey_all_chans_interference_factor(
612 	struct hostapd_iface *iface)
613 {
614 	int i;
615 	struct hostapd_hw_modes *mode;
616 
617 	for (i = 0; i < iface->num_hw_features; i++) {
618 		mode = &iface->hw_features[i];
619 		if (!hostapd_hw_skip_mode(iface, mode))
620 			acs_survey_mode_interference_factor(iface, mode);
621 	}
622 }
623 
624 
625 static struct hostapd_channel_data *
acs_find_chan_mode(struct hostapd_hw_modes * mode,int freq)626 acs_find_chan_mode(struct hostapd_hw_modes *mode, int freq)
627 {
628 	struct hostapd_channel_data *chan;
629 	int i;
630 
631 	for (i = 0; i < mode->num_channels; i++) {
632 		chan = &mode->channels[i];
633 
634 		if (chan->flag & HOSTAPD_CHAN_DISABLED)
635 			continue;
636 
637 		if (chan->freq == freq)
638 			return chan;
639 	}
640 
641 	return NULL;
642 }
643 
644 
645 static enum hostapd_hw_mode
acs_find_mode(struct hostapd_iface * iface,int freq)646 acs_find_mode(struct hostapd_iface *iface, int freq)
647 {
648 	int i;
649 	struct hostapd_hw_modes *mode;
650 	struct hostapd_channel_data *chan;
651 
652 	for (i = 0; i < iface->num_hw_features; i++) {
653 		mode = &iface->hw_features[i];
654 		if (!hostapd_hw_skip_mode(iface, mode)) {
655 			chan = acs_find_chan_mode(mode, freq);
656 			if (chan)
657 				return mode->mode;
658 		}
659 	}
660 
661 	return HOSTAPD_MODE_IEEE80211ANY;
662 }
663 
664 
665 static struct hostapd_channel_data *
acs_find_chan(struct hostapd_iface * iface,int freq)666 acs_find_chan(struct hostapd_iface *iface, int freq)
667 {
668 	int i;
669 	struct hostapd_hw_modes *mode;
670 	struct hostapd_channel_data *chan;
671 
672 	for (i = 0; i < iface->num_hw_features; i++) {
673 		mode = &iface->hw_features[i];
674 		if (!hostapd_hw_skip_mode(iface, mode)) {
675 			chan = acs_find_chan_mode(mode, freq);
676 			if (chan)
677 				return chan;
678 		}
679 	}
680 
681 	return NULL;
682 }
683 
684 
is_24ghz_mode(enum hostapd_hw_mode mode)685 static int is_24ghz_mode(enum hostapd_hw_mode mode)
686 {
687 	return mode == HOSTAPD_MODE_IEEE80211B ||
688 		mode == HOSTAPD_MODE_IEEE80211G;
689 }
690 
691 
is_common_24ghz_chan(int chan)692 static int is_common_24ghz_chan(int chan)
693 {
694 	return chan == 1 || chan == 6 || chan == 11;
695 }
696 
697 
698 #ifndef ACS_ADJ_WEIGHT
699 #define ACS_ADJ_WEIGHT 0.85
700 #endif /* ACS_ADJ_WEIGHT */
701 
702 #ifndef ACS_NEXT_ADJ_WEIGHT
703 #define ACS_NEXT_ADJ_WEIGHT 0.55
704 #endif /* ACS_NEXT_ADJ_WEIGHT */
705 
706 #ifndef ACS_24GHZ_PREFER_1_6_11
707 /*
708  * Select commonly used channels 1, 6, 11 by default even if a neighboring
709  * channel has a smaller interference factor as long as it is not better by more
710  * than this multiplier.
711  */
712 #define ACS_24GHZ_PREFER_1_6_11 0.8
713 #endif /* ACS_24GHZ_PREFER_1_6_11 */
714 
715 
716 #ifdef CONFIG_IEEE80211BE
acs_update_puncturing_bitmap(struct hostapd_iface * iface,struct hostapd_hw_modes * mode,u32 bw,int n_chans,struct hostapd_channel_data * chan,long double factor,int index_primary)717 static void acs_update_puncturing_bitmap(struct hostapd_iface *iface,
718 					 struct hostapd_hw_modes *mode, u32 bw,
719 					 int n_chans,
720 					 struct hostapd_channel_data *chan,
721 					 long double factor,
722 					 int index_primary)
723 {
724 	struct hostapd_config *conf = iface->conf;
725 	struct hostapd_channel_data *adj_chan = NULL, *first_chan = chan;
726 	int i;
727 	long double threshold;
728 
729 	/*
730 	 * If threshold is 0 or user configured puncturing pattern is
731 	 * available then don't add additional puncturing.
732 	 */
733 	if (!conf->punct_acs_threshold || conf->punct_bitmap)
734 		return;
735 
736 	if (is_24ghz_mode(mode->mode) || bw < 80)
737 		return;
738 
739 	threshold = factor * conf->punct_acs_threshold / 100;
740 	for (i = 0; i < n_chans; i++) {
741 		int adj_freq;
742 
743 		if (i == index_primary)
744 			continue; /* Cannot puncture primary channel */
745 
746 		if (i > index_primary)
747 			adj_freq = chan->freq + (i - index_primary) * 20;
748 		else
749 			adj_freq = chan->freq - (index_primary - i) * 20;
750 
751 		adj_chan = acs_find_chan(iface, adj_freq);
752 		if (!adj_chan) {
753 			chan->punct_bitmap = 0;
754 			return;
755 		}
756 
757 		if (i == 0)
758 			first_chan = adj_chan;
759 
760 		if (adj_chan->interference_factor > threshold)
761 			chan->punct_bitmap |= BIT(i);
762 	}
763 
764 	if (!is_punct_bitmap_valid(bw, (chan->freq - first_chan->freq) / 20,
765 				   chan->punct_bitmap))
766 		chan->punct_bitmap = 0;
767 }
768 #endif /* CONFIG_IEEE80211BE */
769 
770 
771 static void
acs_find_ideal_chan_mode(struct hostapd_iface * iface,struct hostapd_hw_modes * mode,int n_chans,u32 bw,struct hostapd_channel_data ** rand_chan,struct hostapd_channel_data ** ideal_chan,long double * ideal_factor)772 acs_find_ideal_chan_mode(struct hostapd_iface *iface,
773 			 struct hostapd_hw_modes *mode,
774 			 int n_chans, u32 bw,
775 			 struct hostapd_channel_data **rand_chan,
776 			 struct hostapd_channel_data **ideal_chan,
777 			 long double *ideal_factor)
778 {
779 	struct hostapd_channel_data *chan, *adj_chan = NULL, *best;
780 	long double factor;
781 	int i, j;
782 	unsigned int k;
783 
784 	for (i = 0; i < mode->num_channels; i++) {
785 		double total_weight;
786 		struct acs_bias *bias, tmp_bias;
787 		bool update_best = true;
788 
789 		best = chan = &mode->channels[i];
790 
791 		/* Since in the current ACS implementation the first channel is
792 		 * always a primary channel, skip channels not available as
793 		 * primary until more sophisticated channel selection is
794 		 * implemented.
795 		 *
796 		 * If this implementation is changed to allow any channel in
797 		 * the bandwidth to be the primary one, the last parameter to
798 		 * acs_update_puncturing_bitmap() should be changed to the index
799 		 * of the primary channel
800 		 */
801 		if (!chan_pri_allowed(chan))
802 			continue;
803 
804 		if ((chan->flag & HOSTAPD_CHAN_RADAR) &&
805 		    iface->conf->acs_exclude_dfs)
806 			continue;
807 
808 		if (!is_in_chanlist(iface, chan))
809 			continue;
810 
811 		if (!is_in_freqlist(iface, chan))
812 			continue;
813 
814 		if (chan->max_tx_power < iface->conf->min_tx_power)
815 			continue;
816 
817 		if ((chan->flag & HOSTAPD_CHAN_INDOOR_ONLY) &&
818 		    iface->conf->country[2] == 0x4f)
819 			continue;
820 
821 		if (!chan_bw_allowed(chan, bw, 1, 1)) {
822 			wpa_printf(MSG_DEBUG,
823 				   "ACS: Channel %d: BW %u is not supported",
824 				   chan->chan, bw);
825 			continue;
826 		}
827 
828 		/* HT40 on 5 GHz has a limited set of primary channels as per
829 		 * 11n Annex J */
830 		if (mode->mode == HOSTAPD_MODE_IEEE80211A &&
831 		    ((iface->conf->ieee80211n &&
832 		      iface->conf->secondary_channel) ||
833 		     is_6ghz_freq(chan->freq)) &&
834 		    !acs_usable_bw_chan(chan, ACS_BW40)) {
835 			wpa_printf(MSG_DEBUG,
836 				   "ACS: Channel %d: not allowed as primary channel for 40 MHz bandwidth",
837 				   chan->chan);
838 			continue;
839 		}
840 
841 		if (mode->mode == HOSTAPD_MODE_IEEE80211A &&
842 		    (iface->conf->ieee80211ac || iface->conf->ieee80211ax)) {
843 			if (hostapd_get_oper_chwidth(iface->conf) ==
844 			    CONF_OPER_CHWIDTH_80MHZ &&
845 			    !acs_usable_bw_chan(chan, ACS_BW80)) {
846 				wpa_printf(MSG_DEBUG,
847 					   "ACS: Channel %d: not allowed as primary channel for 80 MHz bandwidth",
848 					   chan->chan);
849 				continue;
850 			}
851 
852 			if (hostapd_get_oper_chwidth(iface->conf) ==
853 			    CONF_OPER_CHWIDTH_160MHZ &&
854 			    !acs_usable_bw_chan(chan, ACS_BW160)) {
855 				wpa_printf(MSG_DEBUG,
856 					   "ACS: Channel %d: not allowed as primary channel for 160 MHz bandwidth",
857 					   chan->chan);
858 				continue;
859 			}
860 		}
861 
862 		factor = 0;
863 		if (acs_usable_chan(chan))
864 			factor = chan->interference_factor;
865 		total_weight = 1;
866 
867 		for (j = 1; j < n_chans; j++) {
868 			adj_chan = acs_find_chan(iface, chan->freq + (j * 20));
869 			if (!adj_chan)
870 				break;
871 
872 			if (!chan_bw_allowed(adj_chan, bw, 1, 0)) {
873 				wpa_printf(MSG_DEBUG,
874 					   "ACS: PRI Channel %d: secondary channel %d BW %u is not supported",
875 					   chan->chan, adj_chan->chan, bw);
876 				break;
877 			}
878 
879 			if (acs_usable_chan(adj_chan)) {
880 				factor += adj_chan->interference_factor;
881 				total_weight += 1;
882 			} else {
883 				update_best = false;
884 			}
885 
886 			/* find the best channel in this segment */
887 			if (update_best &&
888 			    adj_chan->interference_factor <
889 			    best->interference_factor)
890 				best = adj_chan;
891 		}
892 
893 		if (j != n_chans) {
894 			wpa_printf(MSG_DEBUG, "ACS: Channel %d: not enough bandwidth",
895 				   chan->chan);
896 			continue;
897 		}
898 
899 		/* If the AP is in the 5 GHz or 6 GHz band, lets prefer a less
900 		 * crowded primary channel if one was found in the segment */
901 		if (iface->current_mode->mode == HOSTAPD_MODE_IEEE80211A &&
902 		    chan != best) {
903 			wpa_printf(MSG_DEBUG,
904 				   "ACS: promoting channel %d over %d (less interference %Lg/%Lg)",
905 				   best->chan, chan->chan,
906 				   chan->interference_factor,
907 				   best->interference_factor);
908 			chan = best;
909 		}
910 
911 		/* 2.4 GHz has overlapping 20 MHz channels. Include adjacent
912 		 * channel interference factor. */
913 		if (is_24ghz_mode(mode->mode)) {
914 			for (j = 0; j < n_chans; j++) {
915 				adj_chan = acs_find_chan(iface, chan->freq +
916 							 (j * 20) - 5);
917 				if (adj_chan && acs_usable_chan(adj_chan)) {
918 					factor += ACS_ADJ_WEIGHT *
919 						adj_chan->interference_factor;
920 					total_weight += ACS_ADJ_WEIGHT;
921 				}
922 
923 				adj_chan = acs_find_chan(iface, chan->freq +
924 							 (j * 20) - 10);
925 				if (adj_chan && acs_usable_chan(adj_chan)) {
926 					factor += ACS_NEXT_ADJ_WEIGHT *
927 						adj_chan->interference_factor;
928 					total_weight += ACS_NEXT_ADJ_WEIGHT;
929 				}
930 
931 				adj_chan = acs_find_chan(iface, chan->freq +
932 							 (j * 20) + 5);
933 				if (adj_chan && acs_usable_chan(adj_chan)) {
934 					factor += ACS_ADJ_WEIGHT *
935 						adj_chan->interference_factor;
936 					total_weight += ACS_ADJ_WEIGHT;
937 				}
938 
939 				adj_chan = acs_find_chan(iface, chan->freq +
940 							 (j * 20) + 10);
941 				if (adj_chan && acs_usable_chan(adj_chan)) {
942 					factor += ACS_NEXT_ADJ_WEIGHT *
943 						adj_chan->interference_factor;
944 					total_weight += ACS_NEXT_ADJ_WEIGHT;
945 				}
946 			}
947 		}
948 
949 		factor /= total_weight;
950 
951 		bias = NULL;
952 		if (iface->conf->acs_chan_bias) {
953 			for (k = 0; k < iface->conf->num_acs_chan_bias; k++) {
954 				bias = &iface->conf->acs_chan_bias[k];
955 				if (bias->channel == chan->chan)
956 					break;
957 				bias = NULL;
958 			}
959 		} else if (is_24ghz_mode(mode->mode) &&
960 			   is_common_24ghz_chan(chan->chan)) {
961 			tmp_bias.channel = chan->chan;
962 			tmp_bias.bias = ACS_24GHZ_PREFER_1_6_11;
963 			bias = &tmp_bias;
964 		}
965 
966 		if (bias) {
967 			factor *= bias->bias;
968 			wpa_printf(MSG_DEBUG,
969 				   "ACS:  * channel %d: total interference = %Lg (%f bias)",
970 				   chan->chan, factor, bias->bias);
971 		} else {
972 			wpa_printf(MSG_DEBUG,
973 				   "ACS:  * channel %d: total interference = %Lg",
974 				   chan->chan, factor);
975 		}
976 
977 		if (acs_usable_chan(chan) &&
978 		    (!*ideal_chan || factor < *ideal_factor)) {
979 			/* Reset puncturing bitmap for the previous ideal
980 			 * channel */
981 			if (*ideal_chan)
982 				(*ideal_chan)->punct_bitmap = 0;
983 
984 			*ideal_factor = factor;
985 			*ideal_chan = chan;
986 
987 #ifdef CONFIG_IEEE80211BE
988 			if (iface->conf->ieee80211be)
989 				acs_update_puncturing_bitmap(iface, mode, bw,
990 							     n_chans, chan,
991 							     factor, 0);
992 #endif /* CONFIG_IEEE80211BE */
993 		}
994 
995 		/* This channel would at least be usable */
996 		if (!(*rand_chan))
997 			*rand_chan = chan;
998 	}
999 }
1000 
1001 
1002 /*
1003  * At this point it's assumed chan->interference_factor has been computed.
1004  * This function should be reusable regardless of interference computation
1005  * option (survey, BSS, spectral, ...). chan->interference factor must be
1006  * summable (i.e., must be always greater than zero).
1007  */
1008 static struct hostapd_channel_data *
acs_find_ideal_chan(struct hostapd_iface * iface)1009 acs_find_ideal_chan(struct hostapd_iface *iface)
1010 {
1011 	struct hostapd_channel_data *ideal_chan = NULL,
1012 		*rand_chan = NULL;
1013 	long double ideal_factor = 0;
1014 	int i;
1015 	int n_chans = 1;
1016 	u32 bw;
1017 	struct hostapd_hw_modes *mode;
1018 
1019 	if (is_6ghz_op_class(iface->conf->op_class)) {
1020 		bw = op_class_to_bandwidth(iface->conf->op_class);
1021 		n_chans = bw / 20;
1022 		goto bw_selected;
1023 	}
1024 
1025 	/* TODO: HT40- support */
1026 
1027 	if (iface->conf->ieee80211n &&
1028 	    iface->conf->secondary_channel == -1) {
1029 		wpa_printf(MSG_ERROR, "ACS: HT40- is not supported yet. Please try HT40+");
1030 		return NULL;
1031 	}
1032 
1033 	if (iface->conf->ieee80211n &&
1034 	    iface->conf->secondary_channel)
1035 		n_chans = 2;
1036 
1037 	if (iface->conf->ieee80211ac || iface->conf->ieee80211ax) {
1038 		switch (hostapd_get_oper_chwidth(iface->conf)) {
1039 		case CONF_OPER_CHWIDTH_80MHZ:
1040 			n_chans = 4;
1041 			break;
1042 		case CONF_OPER_CHWIDTH_160MHZ:
1043 			n_chans = 8;
1044 			break;
1045 		default:
1046 			break;
1047 		}
1048 	}
1049 
1050 	bw = num_chan_to_bw(n_chans);
1051 
1052 bw_selected:
1053 	/* TODO: VHT/HE80+80. Update acs_adjust_center_freq() too. */
1054 
1055 	wpa_printf(MSG_DEBUG,
1056 		   "ACS: Survey analysis for selected bandwidth %d MHz", bw);
1057 
1058 	for (i = 0; i < iface->num_hw_features; i++) {
1059 		mode = &iface->hw_features[i];
1060 		if (!hostapd_hw_skip_mode(iface, mode))
1061 			acs_find_ideal_chan_mode(iface, mode, n_chans, bw,
1062 						 &rand_chan, &ideal_chan,
1063 						 &ideal_factor);
1064 	}
1065 
1066 	if (ideal_chan) {
1067 		wpa_printf(MSG_DEBUG, "ACS: Ideal channel is %d (%d MHz) with total interference factor of %Lg",
1068 			   ideal_chan->chan, ideal_chan->freq, ideal_factor);
1069 
1070 #ifdef CONFIG_IEEE80211BE
1071 		if (iface->conf->punct_acs_threshold)
1072 			wpa_printf(MSG_DEBUG, "ACS: RU puncturing bitmap 0x%x",
1073 				   ideal_chan->punct_bitmap);
1074 #endif /* CONFIG_IEEE80211BE */
1075 
1076 		return ideal_chan;
1077 	}
1078 
1079 #ifdef CONFIG_IEEE80211BE
1080 	if (iface->conf->punct_acs_threshold)
1081 		wpa_printf(MSG_DEBUG, "ACS: RU puncturing bitmap 0x%x",
1082 			   ideal_chan->punct_bitmap);
1083 #endif /* CONFIG_IEEE80211BE */
1084 
1085 	return rand_chan;
1086 }
1087 
1088 
acs_adjust_secondary(struct hostapd_iface * iface)1089 static void acs_adjust_secondary(struct hostapd_iface *iface)
1090 {
1091 	unsigned int i;
1092 
1093 	/* When working with bandwidth over 20 MHz on the 5 GHz or 6 GHz band,
1094 	 * ACS can return a secondary channel which is not the first channel of
1095 	 * the segment and we need to adjust. */
1096 	if (!iface->conf->secondary_channel ||
1097 	    acs_find_mode(iface, iface->freq) != HOSTAPD_MODE_IEEE80211A)
1098 		return;
1099 
1100 	wpa_printf(MSG_DEBUG, "ACS: Adjusting HT/VHT/HE secondary frequency");
1101 
1102 	for (i = 0; bw_desc[ACS_BW40][i].first != -1; i++) {
1103 		if (iface->freq == bw_desc[ACS_BW40][i].first)
1104 			iface->conf->secondary_channel = 1;
1105 		else if (iface->freq == bw_desc[ACS_BW40][i].last)
1106 			iface->conf->secondary_channel = -1;
1107 	}
1108 }
1109 
1110 
acs_adjust_center_freq(struct hostapd_iface * iface)1111 static void acs_adjust_center_freq(struct hostapd_iface *iface)
1112 {
1113 	int center;
1114 
1115 	wpa_printf(MSG_DEBUG, "ACS: Adjusting VHT center frequency");
1116 
1117 	switch (hostapd_get_oper_chwidth(iface->conf)) {
1118 	case CONF_OPER_CHWIDTH_USE_HT:
1119 		if (iface->conf->secondary_channel &&
1120 		    iface->freq >= 2400 && iface->freq < 2500)
1121 			center = iface->conf->channel +
1122 				2 * iface->conf->secondary_channel;
1123 		else if (iface->conf->secondary_channel)
1124 			center = acs_get_bw_center_chan(iface->freq, ACS_BW40);
1125 		else
1126 			center = iface->conf->channel;
1127 		break;
1128 	case CONF_OPER_CHWIDTH_80MHZ:
1129 		center = acs_get_bw_center_chan(iface->freq, ACS_BW80);
1130 		break;
1131 	case CONF_OPER_CHWIDTH_160MHZ:
1132 		center = acs_get_bw_center_chan(iface->freq, ACS_BW160);
1133 		break;
1134 	default:
1135 		/* TODO: How can this be calculated? Adjust
1136 		 * acs_find_ideal_chan() */
1137 		wpa_printf(MSG_INFO,
1138 			   "ACS: Only VHT20/40/80/160 is supported now");
1139 		return;
1140 	}
1141 
1142 	hostapd_set_oper_centr_freq_seg0_idx(iface->conf, center);
1143 }
1144 
1145 
acs_study_survey_based(struct hostapd_iface * iface)1146 static int acs_study_survey_based(struct hostapd_iface *iface)
1147 {
1148 	wpa_printf(MSG_DEBUG, "ACS: Trying survey-based ACS");
1149 
1150 	if (!iface->chans_surveyed) {
1151 		wpa_printf(MSG_ERROR, "ACS: Unable to collect survey data");
1152 		return -1;
1153 	}
1154 
1155 	if (!acs_surveys_are_sufficient(iface)) {
1156 		wpa_printf(MSG_ERROR, "ACS: Surveys have insufficient data");
1157 		return -1;
1158 	}
1159 
1160 	acs_survey_all_chans_interference_factor(iface);
1161 	return 0;
1162 }
1163 
1164 
acs_study_options(struct hostapd_iface * iface)1165 static int acs_study_options(struct hostapd_iface *iface)
1166 {
1167 	if (acs_study_survey_based(iface) == 0)
1168 		return 0;
1169 
1170 	/* TODO: If no surveys are available/sufficient this is a good
1171 	 * place to fallback to BSS-based ACS */
1172 
1173 	return -1;
1174 }
1175 
1176 
acs_study(struct hostapd_iface * iface)1177 static void acs_study(struct hostapd_iface *iface)
1178 {
1179 	struct hostapd_channel_data *ideal_chan;
1180 	int err;
1181 
1182 	err = acs_study_options(iface);
1183 	if (err < 0) {
1184 		wpa_printf(MSG_ERROR, "ACS: All study options have failed");
1185 		goto fail;
1186 	}
1187 
1188 	ideal_chan = acs_find_ideal_chan(iface);
1189 	if (!ideal_chan) {
1190 		wpa_printf(MSG_ERROR, "ACS: Failed to compute ideal channel");
1191 		err = -1;
1192 		goto fail;
1193 	}
1194 
1195 	iface->conf->channel = ideal_chan->chan;
1196 	iface->freq = ideal_chan->freq;
1197 #ifdef CONFIG_IEEE80211BE
1198 	iface->conf->punct_bitmap = ideal_chan->punct_bitmap;
1199 #endif /* CONFIG_IEEE80211BE */
1200 
1201 	if (iface->conf->ieee80211ac || iface->conf->ieee80211ax) {
1202 		acs_adjust_secondary(iface);
1203 		acs_adjust_center_freq(iface);
1204 	}
1205 
1206 	err = hostapd_select_hw_mode(iface);
1207 	if (err) {
1208 		wpa_printf(MSG_ERROR,
1209 			   "ACS: Could not (err: %d) select hw_mode for freq=%d channel=%d",
1210 			err, iface->freq, iface->conf->channel);
1211 		err = -1;
1212 		goto fail;
1213 	}
1214 
1215 	err = 0;
1216 fail:
1217 	/*
1218 	 * hostapd_setup_interface_complete() will return -1 on failure,
1219 	 * 0 on success and 0 is HOSTAPD_CHAN_VALID :)
1220 	 */
1221 	if (hostapd_acs_completed(iface, err) == HOSTAPD_CHAN_VALID) {
1222 		acs_cleanup(iface);
1223 		return;
1224 	}
1225 
1226 	/* This can possibly happen if channel parameters (secondary
1227 	 * channel, center frequencies) are misconfigured */
1228 	wpa_printf(MSG_ERROR, "ACS: Possibly channel configuration is invalid, please report this along with your config file.");
1229 	acs_fail(iface);
1230 }
1231 
1232 
acs_scan_complete(struct hostapd_iface * iface)1233 static void acs_scan_complete(struct hostapd_iface *iface)
1234 {
1235 	int err;
1236 
1237 	iface->scan_cb = NULL;
1238 
1239 	wpa_printf(MSG_DEBUG, "ACS: Using survey based algorithm (acs_num_scans=%d)",
1240 		   iface->conf->acs_num_scans);
1241 
1242 	err = hostapd_drv_get_survey(iface->bss[0], 0);
1243 	if (err) {
1244 		wpa_printf(MSG_ERROR, "ACS: Failed to get survey data");
1245 		goto fail;
1246 	}
1247 
1248 	if (++iface->acs_num_completed_scans < iface->conf->acs_num_scans) {
1249 		err = acs_request_scan(iface);
1250 		if (err) {
1251 			wpa_printf(MSG_ERROR, "ACS: Failed to request scan");
1252 			goto fail;
1253 		}
1254 
1255 		return;
1256 	}
1257 
1258 	acs_study(iface);
1259 	return;
1260 fail:
1261 	hostapd_acs_completed(iface, 1);
1262 	acs_fail(iface);
1263 }
1264 
1265 
acs_request_scan_add_freqs(struct hostapd_iface * iface,struct hostapd_hw_modes * mode,int * freq)1266 static int * acs_request_scan_add_freqs(struct hostapd_iface *iface,
1267 					struct hostapd_hw_modes *mode,
1268 					int *freq)
1269 {
1270 	struct hostapd_channel_data *chan;
1271 	int i;
1272 
1273 	for (i = 0; i < mode->num_channels; i++) {
1274 		chan = &mode->channels[i];
1275 		if ((chan->flag & HOSTAPD_CHAN_DISABLED) ||
1276 		    ((chan->flag & HOSTAPD_CHAN_RADAR) &&
1277 		     iface->conf->acs_exclude_dfs))
1278 			continue;
1279 
1280 		if (!is_in_chanlist(iface, chan))
1281 			continue;
1282 
1283 		if (!is_in_freqlist(iface, chan))
1284 			continue;
1285 
1286 		if (chan->max_tx_power < iface->conf->min_tx_power)
1287 			continue;
1288 
1289 		if ((chan->flag & HOSTAPD_CHAN_INDOOR_ONLY) &&
1290 		    iface->conf->country[2] == 0x4f)
1291 			continue;
1292 
1293 		*freq++ = chan->freq;
1294 	}
1295 
1296 	return freq;
1297 }
1298 
1299 
acs_request_scan(struct hostapd_iface * iface)1300 static int acs_request_scan(struct hostapd_iface *iface)
1301 {
1302 	struct wpa_driver_scan_params params;
1303 	int i, *freq;
1304 	int num_channels;
1305 	struct hostapd_hw_modes *mode;
1306 
1307 	os_memset(&params, 0, sizeof(params));
1308 
1309 	num_channels = 0;
1310 	for (i = 0; i < iface->num_hw_features; i++) {
1311 		mode = &iface->hw_features[i];
1312 		if (!hostapd_hw_skip_mode(iface, mode))
1313 			num_channels += mode->num_channels;
1314 	}
1315 
1316 	params.freqs = os_calloc(num_channels + 1, sizeof(params.freqs[0]));
1317 	if (params.freqs == NULL)
1318 		return -1;
1319 
1320 	freq = params.freqs;
1321 
1322 	for (i = 0; i < iface->num_hw_features; i++) {
1323 		mode = &iface->hw_features[i];
1324 		if (!hostapd_hw_skip_mode(iface, mode))
1325 			freq = acs_request_scan_add_freqs(iface, mode, freq);
1326 	}
1327 
1328 	*freq = 0;
1329 
1330 	if (params.freqs == freq) {
1331 		wpa_printf(MSG_ERROR, "ACS: No available channels found");
1332 		os_free(params.freqs);
1333 		return -1;
1334 	}
1335 
1336 	iface->scan_cb = acs_scan_complete;
1337 
1338 	wpa_printf(MSG_DEBUG, "ACS: Scanning %d / %d",
1339 		   iface->acs_num_completed_scans + 1,
1340 		   iface->conf->acs_num_scans);
1341 
1342 	if (hostapd_driver_scan(iface->bss[0], &params) < 0) {
1343 		wpa_printf(MSG_ERROR, "ACS: Failed to request initial scan");
1344 		acs_cleanup(iface);
1345 		os_free(params.freqs);
1346 		return -1;
1347 	}
1348 
1349 	os_free(params.freqs);
1350 	return 0;
1351 }
1352 
1353 
acs_init(struct hostapd_iface * iface)1354 enum hostapd_chan_status acs_init(struct hostapd_iface *iface)
1355 {
1356 	wpa_printf(MSG_INFO, "ACS: Automatic channel selection started, this may take a bit");
1357 
1358 	if (iface->drv_flags & WPA_DRIVER_FLAGS_ACS_OFFLOAD) {
1359 		wpa_printf(MSG_INFO, "ACS: Offloading to driver");
1360 		if (hostapd_drv_do_acs(iface->bss[0]))
1361 			return HOSTAPD_CHAN_INVALID;
1362 		return HOSTAPD_CHAN_ACS;
1363 	}
1364 
1365 	if (!iface->current_mode &&
1366 	    iface->conf->hw_mode != HOSTAPD_MODE_IEEE80211ANY)
1367 		return HOSTAPD_CHAN_INVALID;
1368 
1369 	acs_cleanup(iface);
1370 
1371 	if (acs_request_scan(iface) < 0)
1372 		return HOSTAPD_CHAN_INVALID;
1373 
1374 	hostapd_set_state(iface, HAPD_IFACE_ACS);
1375 	wpa_msg(iface->bss[0]->msg_ctx, MSG_INFO, ACS_EVENT_STARTED);
1376 
1377 	return HOSTAPD_CHAN_ACS;
1378 }
1379