1 /* SPDX-License-Identifier: GPL-2.0-only */
2 #ifndef __NET_CFG80211_H
3 #define __NET_CFG80211_H
4 /*
5 * 802.11 device and configuration interface
6 *
7 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * Copyright 2013-2014 Intel Mobile Communications GmbH
9 * Copyright 2015-2017 Intel Deutschland GmbH
10 * Copyright (C) 2018-2021 Intel Corporation
11 */
12
13 #include <linux/ethtool.h>
14 #include <uapi/linux/rfkill.h>
15 #include <linux/netdevice.h>
16 #include <linux/debugfs.h>
17 #include <linux/list.h>
18 #include <linux/bug.h>
19 #include <linux/netlink.h>
20 #include <linux/skbuff.h>
21 #include <linux/nl80211.h>
22 #include <linux/if_ether.h>
23 #include <linux/ieee80211.h>
24 #include <linux/net.h>
25 #include <linux/rfkill.h>
26 #include <linux/android_kabi.h>
27 #include <net/regulatory.h>
28
29 /**
30 * DOC: Introduction
31 *
32 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
33 * userspace and drivers, and offers some utility functionality associated
34 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
35 * by all modern wireless drivers in Linux, so that they offer a consistent
36 * API through nl80211. For backward compatibility, cfg80211 also offers
37 * wireless extensions to userspace, but hides them from drivers completely.
38 *
39 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
40 * use restrictions.
41 */
42
43
44 /**
45 * DOC: Device registration
46 *
47 * In order for a driver to use cfg80211, it must register the hardware device
48 * with cfg80211. This happens through a number of hardware capability structs
49 * described below.
50 *
51 * The fundamental structure for each device is the 'wiphy', of which each
52 * instance describes a physical wireless device connected to the system. Each
53 * such wiphy can have zero, one, or many virtual interfaces associated with
54 * it, which need to be identified as such by pointing the network interface's
55 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
56 * the wireless part of the interface, normally this struct is embedded in the
57 * network interface's private data area. Drivers can optionally allow creating
58 * or destroying virtual interfaces on the fly, but without at least one or the
59 * ability to create some the wireless device isn't useful.
60 *
61 * Each wiphy structure contains device capability information, and also has
62 * a pointer to the various operations the driver offers. The definitions and
63 * structures here describe these capabilities in detail.
64 */
65
66 struct wiphy;
67
68 /*
69 * wireless hardware capability structures
70 */
71
72 /**
73 * enum ieee80211_channel_flags - channel flags
74 *
75 * Channel flags set by the regulatory control code.
76 *
77 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
78 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
79 * sending probe requests or beaconing.
80 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
81 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
82 * is not permitted.
83 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
84 * is not permitted.
85 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
86 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
87 * this flag indicates that an 80 MHz channel cannot use this
88 * channel as the control or any of the secondary channels.
89 * This may be due to the driver or due to regulatory bandwidth
90 * restrictions.
91 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
92 * this flag indicates that an 160 MHz channel cannot use this
93 * channel as the control or any of the secondary channels.
94 * This may be due to the driver or due to regulatory bandwidth
95 * restrictions.
96 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
97 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
98 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
99 * on this channel.
100 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
101 * on this channel.
102 * @IEEE80211_CHAN_NO_HE: HE operation is not permitted on this channel.
103 * @IEEE80211_CHAN_1MHZ: 1 MHz bandwidth is permitted
104 * on this channel.
105 * @IEEE80211_CHAN_2MHZ: 2 MHz bandwidth is permitted
106 * on this channel.
107 * @IEEE80211_CHAN_4MHZ: 4 MHz bandwidth is permitted
108 * on this channel.
109 * @IEEE80211_CHAN_8MHZ: 8 MHz bandwidth is permitted
110 * on this channel.
111 * @IEEE80211_CHAN_16MHZ: 16 MHz bandwidth is permitted
112 * on this channel.
113 * @IEEE80211_CHAN_NO_320MHZ: If the driver supports 320 MHz on the band,
114 * this flag indicates that a 320 MHz channel cannot use this
115 * channel as the control or any of the secondary channels.
116 * This may be due to the driver or due to regulatory bandwidth
117 * restrictions.
118 * @IEEE80211_CHAN_NO_EHT: EHT operation is not permitted on this channel.
119 */
120 enum ieee80211_channel_flags {
121 IEEE80211_CHAN_DISABLED = 1<<0,
122 IEEE80211_CHAN_NO_IR = 1<<1,
123 /* hole at 1<<2 */
124 IEEE80211_CHAN_RADAR = 1<<3,
125 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
126 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
127 IEEE80211_CHAN_NO_OFDM = 1<<6,
128 IEEE80211_CHAN_NO_80MHZ = 1<<7,
129 IEEE80211_CHAN_NO_160MHZ = 1<<8,
130 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
131 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
132 IEEE80211_CHAN_NO_20MHZ = 1<<11,
133 IEEE80211_CHAN_NO_10MHZ = 1<<12,
134 IEEE80211_CHAN_NO_HE = 1<<13,
135 IEEE80211_CHAN_1MHZ = 1<<14,
136 IEEE80211_CHAN_2MHZ = 1<<15,
137 IEEE80211_CHAN_4MHZ = 1<<16,
138 IEEE80211_CHAN_8MHZ = 1<<17,
139 IEEE80211_CHAN_16MHZ = 1<<18,
140 IEEE80211_CHAN_NO_320MHZ = 1<<19,
141 IEEE80211_CHAN_NO_EHT = 1<<20,
142 };
143
144 #define IEEE80211_CHAN_NO_HT40 \
145 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
146
147 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
148 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
149
150 /**
151 * struct ieee80211_channel - channel definition
152 *
153 * This structure describes a single channel for use
154 * with cfg80211.
155 *
156 * @center_freq: center frequency in MHz
157 * @freq_offset: offset from @center_freq, in KHz
158 * @hw_value: hardware-specific value for the channel
159 * @flags: channel flags from &enum ieee80211_channel_flags.
160 * @orig_flags: channel flags at registration time, used by regulatory
161 * code to support devices with additional restrictions
162 * @band: band this channel belongs to.
163 * @max_antenna_gain: maximum antenna gain in dBi
164 * @max_power: maximum transmission power (in dBm)
165 * @max_reg_power: maximum regulatory transmission power (in dBm)
166 * @beacon_found: helper to regulatory code to indicate when a beacon
167 * has been found on this channel. Use regulatory_hint_found_beacon()
168 * to enable this, this is useful only on 5 GHz band.
169 * @orig_mag: internal use
170 * @orig_mpwr: internal use
171 * @dfs_state: current state of this channel. Only relevant if radar is required
172 * on this channel.
173 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
174 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
175 */
176 struct ieee80211_channel {
177 enum nl80211_band band;
178 u32 center_freq;
179 u16 freq_offset;
180 u16 hw_value;
181 u32 flags;
182 int max_antenna_gain;
183 int max_power;
184 int max_reg_power;
185 bool beacon_found;
186 u32 orig_flags;
187 int orig_mag, orig_mpwr;
188 enum nl80211_dfs_state dfs_state;
189 unsigned long dfs_state_entered;
190 unsigned int dfs_cac_ms;
191 };
192
193 /**
194 * enum ieee80211_rate_flags - rate flags
195 *
196 * Hardware/specification flags for rates. These are structured
197 * in a way that allows using the same bitrate structure for
198 * different bands/PHY modes.
199 *
200 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
201 * preamble on this bitrate; only relevant in 2.4GHz band and
202 * with CCK rates.
203 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
204 * when used with 802.11a (on the 5 GHz band); filled by the
205 * core code when registering the wiphy.
206 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
207 * when used with 802.11b (on the 2.4 GHz band); filled by the
208 * core code when registering the wiphy.
209 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
210 * when used with 802.11g (on the 2.4 GHz band); filled by the
211 * core code when registering the wiphy.
212 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
213 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
214 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
215 */
216 enum ieee80211_rate_flags {
217 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
218 IEEE80211_RATE_MANDATORY_A = 1<<1,
219 IEEE80211_RATE_MANDATORY_B = 1<<2,
220 IEEE80211_RATE_MANDATORY_G = 1<<3,
221 IEEE80211_RATE_ERP_G = 1<<4,
222 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
223 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
224 };
225
226 /**
227 * enum ieee80211_bss_type - BSS type filter
228 *
229 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
230 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
231 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
232 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
233 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
234 */
235 enum ieee80211_bss_type {
236 IEEE80211_BSS_TYPE_ESS,
237 IEEE80211_BSS_TYPE_PBSS,
238 IEEE80211_BSS_TYPE_IBSS,
239 IEEE80211_BSS_TYPE_MBSS,
240 IEEE80211_BSS_TYPE_ANY
241 };
242
243 /**
244 * enum ieee80211_privacy - BSS privacy filter
245 *
246 * @IEEE80211_PRIVACY_ON: privacy bit set
247 * @IEEE80211_PRIVACY_OFF: privacy bit clear
248 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
249 */
250 enum ieee80211_privacy {
251 IEEE80211_PRIVACY_ON,
252 IEEE80211_PRIVACY_OFF,
253 IEEE80211_PRIVACY_ANY
254 };
255
256 #define IEEE80211_PRIVACY(x) \
257 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
258
259 /**
260 * struct ieee80211_rate - bitrate definition
261 *
262 * This structure describes a bitrate that an 802.11 PHY can
263 * operate with. The two values @hw_value and @hw_value_short
264 * are only for driver use when pointers to this structure are
265 * passed around.
266 *
267 * @flags: rate-specific flags
268 * @bitrate: bitrate in units of 100 Kbps
269 * @hw_value: driver/hardware value for this rate
270 * @hw_value_short: driver/hardware value for this rate when
271 * short preamble is used
272 */
273 struct ieee80211_rate {
274 u32 flags;
275 u16 bitrate;
276 u16 hw_value, hw_value_short;
277 };
278
279 /**
280 * struct ieee80211_he_obss_pd - AP settings for spatial reuse
281 *
282 * @enable: is the feature enabled.
283 * @sr_ctrl: The SR Control field of SRP element.
284 * @non_srg_max_offset: non-SRG maximum tx power offset
285 * @min_offset: minimal tx power offset an associated station shall use
286 * @max_offset: maximum tx power offset an associated station shall use
287 * @bss_color_bitmap: bitmap that indicates the BSS color values used by
288 * members of the SRG
289 * @partial_bssid_bitmap: bitmap that indicates the partial BSSID values
290 * used by members of the SRG
291 */
292 struct ieee80211_he_obss_pd {
293 bool enable;
294 u8 sr_ctrl;
295 u8 non_srg_max_offset;
296 u8 min_offset;
297 u8 max_offset;
298 u8 bss_color_bitmap[8];
299 u8 partial_bssid_bitmap[8];
300 };
301
302 /**
303 * struct cfg80211_he_bss_color - AP settings for BSS coloring
304 *
305 * @color: the current color.
306 * @enabled: HE BSS color is used
307 * @partial: define the AID equation.
308 */
309 struct cfg80211_he_bss_color {
310 u8 color;
311 bool enabled;
312 bool partial;
313 };
314
315 /**
316 * struct ieee80211_sta_ht_cap - STA's HT capabilities
317 *
318 * This structure describes most essential parameters needed
319 * to describe 802.11n HT capabilities for an STA.
320 *
321 * @ht_supported: is HT supported by the STA
322 * @cap: HT capabilities map as described in 802.11n spec
323 * @ampdu_factor: Maximum A-MPDU length factor
324 * @ampdu_density: Minimum A-MPDU spacing
325 * @mcs: Supported MCS rates
326 */
327 struct ieee80211_sta_ht_cap {
328 u16 cap; /* use IEEE80211_HT_CAP_ */
329 bool ht_supported;
330 u8 ampdu_factor;
331 u8 ampdu_density;
332 struct ieee80211_mcs_info mcs;
333 };
334
335 /**
336 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
337 *
338 * This structure describes most essential parameters needed
339 * to describe 802.11ac VHT capabilities for an STA.
340 *
341 * @vht_supported: is VHT supported by the STA
342 * @cap: VHT capabilities map as described in 802.11ac spec
343 * @vht_mcs: Supported VHT MCS rates
344 */
345 struct ieee80211_sta_vht_cap {
346 bool vht_supported;
347 u32 cap; /* use IEEE80211_VHT_CAP_ */
348 struct ieee80211_vht_mcs_info vht_mcs;
349 };
350
351 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25
352
353 /**
354 * struct ieee80211_sta_he_cap - STA's HE capabilities
355 *
356 * This structure describes most essential parameters needed
357 * to describe 802.11ax HE capabilities for a STA.
358 *
359 * @has_he: true iff HE data is valid.
360 * @he_cap_elem: Fixed portion of the HE capabilities element.
361 * @he_mcs_nss_supp: The supported NSS/MCS combinations.
362 * @ppe_thres: Holds the PPE Thresholds data.
363 */
364 struct ieee80211_sta_he_cap {
365 bool has_he;
366 struct ieee80211_he_cap_elem he_cap_elem;
367 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
368 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
369 };
370
371 /**
372 * struct ieee80211_eht_mcs_nss_supp - EHT max supported NSS per MCS
373 *
374 * See P802.11be_D1.3 Table 9-401k - "Subfields of the Supported EHT-MCS
375 * and NSS Set field"
376 *
377 * @only_20mhz: MCS/NSS support for 20 MHz-only STA.
378 * @bw: MCS/NSS support for 80, 160 and 320 MHz
379 * @bw._80: MCS/NSS support for BW <= 80 MHz
380 * @bw._160: MCS/NSS support for BW = 160 MHz
381 * @bw._320: MCS/NSS support for BW = 320 MHz
382 */
383 struct ieee80211_eht_mcs_nss_supp {
384 union {
385 struct ieee80211_eht_mcs_nss_supp_20mhz_only only_20mhz;
386 struct {
387 struct ieee80211_eht_mcs_nss_supp_bw _80;
388 struct ieee80211_eht_mcs_nss_supp_bw _160;
389 struct ieee80211_eht_mcs_nss_supp_bw _320;
390 } __packed bw;
391 } __packed;
392 } __packed;
393
394 #define IEEE80211_EHT_PPE_THRES_MAX_LEN 32
395
396 /**
397 * struct ieee80211_sta_eht_cap - STA's EHT capabilities
398 *
399 * This structure describes most essential parameters needed
400 * to describe 802.11be EHT capabilities for a STA.
401 *
402 * @has_eht: true iff EHT data is valid.
403 * @eht_cap_elem: Fixed portion of the eht capabilities element.
404 * @eht_mcs_nss_supp: The supported NSS/MCS combinations.
405 * @eht_ppe_thres: Holds the PPE Thresholds data.
406 */
407 struct ieee80211_sta_eht_cap {
408 bool has_eht;
409 struct ieee80211_eht_cap_elem_fixed eht_cap_elem;
410 struct ieee80211_eht_mcs_nss_supp eht_mcs_nss_supp;
411 u8 eht_ppe_thres[IEEE80211_EHT_PPE_THRES_MAX_LEN];
412 };
413
414 /**
415 * struct ieee80211_sband_iftype_data - sband data per interface type
416 *
417 * This structure encapsulates sband data that is relevant for the
418 * interface types defined in @types_mask. Each type in the
419 * @types_mask must be unique across all instances of iftype_data.
420 *
421 * @types_mask: interface types mask
422 * @he_cap: holds the HE capabilities
423 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
424 * 6 GHz band channel (and 0 may be valid value).
425 * @eht_cap: STA's EHT capabilities
426 * @vendor_elems: vendor element(s) to advertise
427 * @vendor_elems.data: vendor element(s) data
428 * @vendor_elems.len: vendor element(s) length
429 */
430 struct ieee80211_sband_iftype_data {
431 u16 types_mask;
432 struct ieee80211_sta_he_cap he_cap;
433 struct ieee80211_he_6ghz_capa he_6ghz_capa;
434 struct ieee80211_sta_eht_cap eht_cap;
435 struct {
436 const u8 *data;
437 unsigned int len;
438 } vendor_elems;
439 };
440
441 /**
442 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
443 *
444 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
445 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
446 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
447 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
448 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
449 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
450 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
451 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
452 * 2.16GHz+2.16GHz
453 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
454 * 4.32GHz + 4.32GHz
455 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
456 * 4.32GHz + 4.32GHz
457 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
458 * and 4.32GHz + 4.32GHz
459 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
460 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
461 */
462 enum ieee80211_edmg_bw_config {
463 IEEE80211_EDMG_BW_CONFIG_4 = 4,
464 IEEE80211_EDMG_BW_CONFIG_5 = 5,
465 IEEE80211_EDMG_BW_CONFIG_6 = 6,
466 IEEE80211_EDMG_BW_CONFIG_7 = 7,
467 IEEE80211_EDMG_BW_CONFIG_8 = 8,
468 IEEE80211_EDMG_BW_CONFIG_9 = 9,
469 IEEE80211_EDMG_BW_CONFIG_10 = 10,
470 IEEE80211_EDMG_BW_CONFIG_11 = 11,
471 IEEE80211_EDMG_BW_CONFIG_12 = 12,
472 IEEE80211_EDMG_BW_CONFIG_13 = 13,
473 IEEE80211_EDMG_BW_CONFIG_14 = 14,
474 IEEE80211_EDMG_BW_CONFIG_15 = 15,
475 };
476
477 /**
478 * struct ieee80211_edmg - EDMG configuration
479 *
480 * This structure describes most essential parameters needed
481 * to describe 802.11ay EDMG configuration
482 *
483 * @channels: bitmap that indicates the 2.16 GHz channel(s)
484 * that are allowed to be used for transmissions.
485 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
486 * Set to 0 indicate EDMG not supported.
487 * @bw_config: Channel BW Configuration subfield encodes
488 * the allowed channel bandwidth configurations
489 */
490 struct ieee80211_edmg {
491 u8 channels;
492 enum ieee80211_edmg_bw_config bw_config;
493 };
494
495 /**
496 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities
497 *
498 * This structure describes most essential parameters needed
499 * to describe 802.11ah S1G capabilities for a STA.
500 *
501 * @s1g: is STA an S1G STA
502 * @cap: S1G capabilities information
503 * @nss_mcs: Supported NSS MCS set
504 */
505 struct ieee80211_sta_s1g_cap {
506 bool s1g;
507 u8 cap[10]; /* use S1G_CAPAB_ */
508 u8 nss_mcs[5];
509 };
510
511 /**
512 * struct ieee80211_supported_band - frequency band definition
513 *
514 * This structure describes a frequency band a wiphy
515 * is able to operate in.
516 *
517 * @channels: Array of channels the hardware can operate with
518 * in this band.
519 * @band: the band this structure represents
520 * @n_channels: Number of channels in @channels
521 * @bitrates: Array of bitrates the hardware can operate with
522 * in this band. Must be sorted to give a valid "supported
523 * rates" IE, i.e. CCK rates first, then OFDM.
524 * @n_bitrates: Number of bitrates in @bitrates
525 * @ht_cap: HT capabilities in this band
526 * @vht_cap: VHT capabilities in this band
527 * @s1g_cap: S1G capabilities in this band
528 * @edmg_cap: EDMG capabilities in this band
529 * @s1g_cap: S1G capabilities in this band (S1B band only, of course)
530 * @n_iftype_data: number of iftype data entries
531 * @iftype_data: interface type data entries. Note that the bits in
532 * @types_mask inside this structure cannot overlap (i.e. only
533 * one occurrence of each type is allowed across all instances of
534 * iftype_data).
535 */
536 struct ieee80211_supported_band {
537 struct ieee80211_channel *channels;
538 struct ieee80211_rate *bitrates;
539 enum nl80211_band band;
540 int n_channels;
541 int n_bitrates;
542 struct ieee80211_sta_ht_cap ht_cap;
543 struct ieee80211_sta_vht_cap vht_cap;
544 struct ieee80211_sta_s1g_cap s1g_cap;
545 struct ieee80211_edmg edmg_cap;
546 u16 n_iftype_data;
547 const struct ieee80211_sband_iftype_data *iftype_data;
548 };
549
550 /**
551 * ieee80211_get_sband_iftype_data - return sband data for a given iftype
552 * @sband: the sband to search for the STA on
553 * @iftype: enum nl80211_iftype
554 *
555 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
556 */
557 static inline const struct ieee80211_sband_iftype_data *
ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band * sband,u8 iftype)558 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
559 u8 iftype)
560 {
561 int i;
562
563 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
564 return NULL;
565
566 if (iftype == NL80211_IFTYPE_AP_VLAN)
567 iftype = NL80211_IFTYPE_AP;
568
569 for (i = 0; i < sband->n_iftype_data; i++) {
570 const struct ieee80211_sband_iftype_data *data =
571 &sband->iftype_data[i];
572
573 if (data->types_mask & BIT(iftype))
574 return data;
575 }
576
577 return NULL;
578 }
579
580 /**
581 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
582 * @sband: the sband to search for the iftype on
583 * @iftype: enum nl80211_iftype
584 *
585 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
586 */
587 static inline const struct ieee80211_sta_he_cap *
ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band * sband,u8 iftype)588 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
589 u8 iftype)
590 {
591 const struct ieee80211_sband_iftype_data *data =
592 ieee80211_get_sband_iftype_data(sband, iftype);
593
594 if (data && data->he_cap.has_he)
595 return &data->he_cap;
596
597 return NULL;
598 }
599
600 /**
601 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities
602 * @sband: the sband to search for the STA on
603 * @iftype: the iftype to search for
604 *
605 * Return: the 6GHz capabilities
606 */
607 static inline __le16
ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band * sband,enum nl80211_iftype iftype)608 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband,
609 enum nl80211_iftype iftype)
610 {
611 const struct ieee80211_sband_iftype_data *data =
612 ieee80211_get_sband_iftype_data(sband, iftype);
613
614 if (WARN_ON(!data || !data->he_cap.has_he))
615 return 0;
616
617 return data->he_6ghz_capa.capa;
618 }
619
620 /**
621 * ieee80211_get_eht_iftype_cap - return ETH capabilities for an sband's iftype
622 * @sband: the sband to search for the iftype on
623 * @iftype: enum nl80211_iftype
624 *
625 * Return: pointer to the struct ieee80211_sta_eht_cap, or NULL is none found
626 */
627 static inline const struct ieee80211_sta_eht_cap *
ieee80211_get_eht_iftype_cap(const struct ieee80211_supported_band * sband,enum nl80211_iftype iftype)628 ieee80211_get_eht_iftype_cap(const struct ieee80211_supported_band *sband,
629 enum nl80211_iftype iftype)
630 {
631 const struct ieee80211_sband_iftype_data *data =
632 ieee80211_get_sband_iftype_data(sband, iftype);
633
634 if (data && data->eht_cap.has_eht)
635 return &data->eht_cap;
636
637 return NULL;
638 }
639
640 /**
641 * wiphy_read_of_freq_limits - read frequency limits from device tree
642 *
643 * @wiphy: the wireless device to get extra limits for
644 *
645 * Some devices may have extra limitations specified in DT. This may be useful
646 * for chipsets that normally support more bands but are limited due to board
647 * design (e.g. by antennas or external power amplifier).
648 *
649 * This function reads info from DT and uses it to *modify* channels (disable
650 * unavailable ones). It's usually a *bad* idea to use it in drivers with
651 * shared channel data as DT limitations are device specific. You should make
652 * sure to call it only if channels in wiphy are copied and can be modified
653 * without affecting other devices.
654 *
655 * As this function access device node it has to be called after set_wiphy_dev.
656 * It also modifies channels so they have to be set first.
657 * If using this helper, call it before wiphy_register().
658 */
659 #ifdef CONFIG_OF
660 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
661 #else /* CONFIG_OF */
wiphy_read_of_freq_limits(struct wiphy * wiphy)662 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
663 {
664 }
665 #endif /* !CONFIG_OF */
666
667
668 /*
669 * Wireless hardware/device configuration structures and methods
670 */
671
672 /**
673 * DOC: Actions and configuration
674 *
675 * Each wireless device and each virtual interface offer a set of configuration
676 * operations and other actions that are invoked by userspace. Each of these
677 * actions is described in the operations structure, and the parameters these
678 * operations use are described separately.
679 *
680 * Additionally, some operations are asynchronous and expect to get status
681 * information via some functions that drivers need to call.
682 *
683 * Scanning and BSS list handling with its associated functionality is described
684 * in a separate chapter.
685 */
686
687 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
688 WLAN_USER_POSITION_LEN)
689
690 /**
691 * struct vif_params - describes virtual interface parameters
692 * @flags: monitor interface flags, unchanged if 0, otherwise
693 * %MONITOR_FLAG_CHANGED will be set
694 * @use_4addr: use 4-address frames
695 * @macaddr: address to use for this virtual interface.
696 * If this parameter is set to zero address the driver may
697 * determine the address as needed.
698 * This feature is only fully supported by drivers that enable the
699 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
700 ** only p2p devices with specified MAC.
701 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
702 * belonging to that MU-MIMO groupID; %NULL if not changed
703 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
704 * MU-MIMO packets going to the specified station; %NULL if not changed
705 */
706 struct vif_params {
707 u32 flags;
708 int use_4addr;
709 u8 macaddr[ETH_ALEN];
710 const u8 *vht_mumimo_groups;
711 const u8 *vht_mumimo_follow_addr;
712 };
713
714 /**
715 * struct key_params - key information
716 *
717 * Information about a key
718 *
719 * @key: key material
720 * @key_len: length of key material
721 * @cipher: cipher suite selector
722 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
723 * with the get_key() callback, must be in little endian,
724 * length given by @seq_len.
725 * @seq_len: length of @seq.
726 * @vlan_id: vlan_id for VLAN group key (if nonzero)
727 * @mode: key install mode (RX_TX, NO_TX or SET_TX)
728 */
729 struct key_params {
730 const u8 *key;
731 const u8 *seq;
732 int key_len;
733 int seq_len;
734 u16 vlan_id;
735 u32 cipher;
736 enum nl80211_key_mode mode;
737 };
738
739 /**
740 * struct cfg80211_chan_def - channel definition
741 * @chan: the (control) channel
742 * @width: channel width
743 * @center_freq1: center frequency of first segment
744 * @center_freq2: center frequency of second segment
745 * (only with 80+80 MHz)
746 * @edmg: define the EDMG channels configuration.
747 * If edmg is requested (i.e. the .channels member is non-zero),
748 * chan will define the primary channel and all other
749 * parameters are ignored.
750 * @freq1_offset: offset from @center_freq1, in KHz
751 */
752 struct cfg80211_chan_def {
753 struct ieee80211_channel *chan;
754 enum nl80211_chan_width width;
755 u32 center_freq1;
756 u32 center_freq2;
757 struct ieee80211_edmg edmg;
758 u16 freq1_offset;
759 };
760
761 /*
762 * cfg80211_bitrate_mask - masks for bitrate control
763 */
764 struct cfg80211_bitrate_mask {
765 struct {
766 u32 legacy;
767 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
768 u16 vht_mcs[NL80211_VHT_NSS_MAX];
769 u16 he_mcs[NL80211_HE_NSS_MAX];
770 enum nl80211_txrate_gi gi;
771 enum nl80211_he_gi he_gi;
772 enum nl80211_he_ltf he_ltf;
773 } control[NUM_NL80211_BANDS];
774 };
775
776
777 /**
778 * struct cfg80211_tid_cfg - TID specific configuration
779 * @config_override: Flag to notify driver to reset TID configuration
780 * of the peer.
781 * @tids: bitmap of TIDs to modify
782 * @mask: bitmap of attributes indicating which parameter changed,
783 * similar to &nl80211_tid_config_supp.
784 * @noack: noack configuration value for the TID
785 * @retry_long: retry count value
786 * @retry_short: retry count value
787 * @ampdu: Enable/Disable MPDU aggregation
788 * @rtscts: Enable/Disable RTS/CTS
789 * @amsdu: Enable/Disable MSDU aggregation
790 * @txrate_type: Tx bitrate mask type
791 * @txrate_mask: Tx bitrate to be applied for the TID
792 */
793 struct cfg80211_tid_cfg {
794 bool config_override;
795 u8 tids;
796 u64 mask;
797 enum nl80211_tid_config noack;
798 u8 retry_long, retry_short;
799 enum nl80211_tid_config ampdu;
800 enum nl80211_tid_config rtscts;
801 enum nl80211_tid_config amsdu;
802 enum nl80211_tx_rate_setting txrate_type;
803 struct cfg80211_bitrate_mask txrate_mask;
804 };
805
806 /**
807 * struct cfg80211_tid_config - TID configuration
808 * @peer: Station's MAC address
809 * @n_tid_conf: Number of TID specific configurations to be applied
810 * @tid_conf: Configuration change info
811 */
812 struct cfg80211_tid_config {
813 const u8 *peer;
814 u32 n_tid_conf;
815 struct cfg80211_tid_cfg tid_conf[];
816 };
817
818 /**
819 * struct cfg80211_fils_aad - FILS AAD data
820 * @macaddr: STA MAC address
821 * @kek: FILS KEK
822 * @kek_len: FILS KEK length
823 * @snonce: STA Nonce
824 * @anonce: AP Nonce
825 */
826 struct cfg80211_fils_aad {
827 const u8 *macaddr;
828 const u8 *kek;
829 u8 kek_len;
830 const u8 *snonce;
831 const u8 *anonce;
832 };
833
834 /**
835 * cfg80211_get_chandef_type - return old channel type from chandef
836 * @chandef: the channel definition
837 *
838 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
839 * chandef, which must have a bandwidth allowing this conversion.
840 */
841 static inline enum nl80211_channel_type
cfg80211_get_chandef_type(const struct cfg80211_chan_def * chandef)842 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
843 {
844 switch (chandef->width) {
845 case NL80211_CHAN_WIDTH_20_NOHT:
846 return NL80211_CHAN_NO_HT;
847 case NL80211_CHAN_WIDTH_20:
848 return NL80211_CHAN_HT20;
849 case NL80211_CHAN_WIDTH_40:
850 if (chandef->center_freq1 > chandef->chan->center_freq)
851 return NL80211_CHAN_HT40PLUS;
852 return NL80211_CHAN_HT40MINUS;
853 default:
854 WARN_ON(1);
855 return NL80211_CHAN_NO_HT;
856 }
857 }
858
859 /**
860 * cfg80211_chandef_create - create channel definition using channel type
861 * @chandef: the channel definition struct to fill
862 * @channel: the control channel
863 * @chantype: the channel type
864 *
865 * Given a channel type, create a channel definition.
866 */
867 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
868 struct ieee80211_channel *channel,
869 enum nl80211_channel_type chantype);
870
871 /**
872 * cfg80211_chandef_identical - check if two channel definitions are identical
873 * @chandef1: first channel definition
874 * @chandef2: second channel definition
875 *
876 * Return: %true if the channels defined by the channel definitions are
877 * identical, %false otherwise.
878 */
879 static inline bool
cfg80211_chandef_identical(const struct cfg80211_chan_def * chandef1,const struct cfg80211_chan_def * chandef2)880 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
881 const struct cfg80211_chan_def *chandef2)
882 {
883 return (chandef1->chan == chandef2->chan &&
884 chandef1->width == chandef2->width &&
885 chandef1->center_freq1 == chandef2->center_freq1 &&
886 chandef1->freq1_offset == chandef2->freq1_offset &&
887 chandef1->center_freq2 == chandef2->center_freq2);
888 }
889
890 /**
891 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
892 *
893 * @chandef: the channel definition
894 *
895 * Return: %true if EDMG defined, %false otherwise.
896 */
897 static inline bool
cfg80211_chandef_is_edmg(const struct cfg80211_chan_def * chandef)898 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
899 {
900 return chandef->edmg.channels || chandef->edmg.bw_config;
901 }
902
903 /**
904 * cfg80211_chandef_compatible - check if two channel definitions are compatible
905 * @chandef1: first channel definition
906 * @chandef2: second channel definition
907 *
908 * Return: %NULL if the given channel definitions are incompatible,
909 * chandef1 or chandef2 otherwise.
910 */
911 const struct cfg80211_chan_def *
912 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
913 const struct cfg80211_chan_def *chandef2);
914
915 /**
916 * cfg80211_chandef_valid - check if a channel definition is valid
917 * @chandef: the channel definition to check
918 * Return: %true if the channel definition is valid. %false otherwise.
919 */
920 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
921
922 /**
923 * cfg80211_chandef_usable - check if secondary channels can be used
924 * @wiphy: the wiphy to validate against
925 * @chandef: the channel definition to check
926 * @prohibited_flags: the regulatory channel flags that must not be set
927 * Return: %true if secondary channels are usable. %false otherwise.
928 */
929 bool cfg80211_chandef_usable(struct wiphy *wiphy,
930 const struct cfg80211_chan_def *chandef,
931 u32 prohibited_flags);
932
933 /**
934 * cfg80211_chandef_dfs_required - checks if radar detection is required
935 * @wiphy: the wiphy to validate against
936 * @chandef: the channel definition to check
937 * @iftype: the interface type as specified in &enum nl80211_iftype
938 * Returns:
939 * 1 if radar detection is required, 0 if it is not, < 0 on error
940 */
941 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
942 const struct cfg80211_chan_def *chandef,
943 enum nl80211_iftype iftype);
944
945 /**
946 * ieee80211_chanwidth_rate_flags - return rate flags for channel width
947 * @width: the channel width of the channel
948 *
949 * In some channel types, not all rates may be used - for example CCK
950 * rates may not be used in 5/10 MHz channels.
951 *
952 * Returns: rate flags which apply for this channel width
953 */
954 static inline enum ieee80211_rate_flags
ieee80211_chanwidth_rate_flags(enum nl80211_chan_width width)955 ieee80211_chanwidth_rate_flags(enum nl80211_chan_width width)
956 {
957 switch (width) {
958 case NL80211_CHAN_WIDTH_5:
959 return IEEE80211_RATE_SUPPORTS_5MHZ;
960 case NL80211_CHAN_WIDTH_10:
961 return IEEE80211_RATE_SUPPORTS_10MHZ;
962 default:
963 break;
964 }
965 return 0;
966 }
967
968 /**
969 * ieee80211_chandef_rate_flags - returns rate flags for a channel
970 * @chandef: channel definition for the channel
971 *
972 * See ieee80211_chanwidth_rate_flags().
973 *
974 * Returns: rate flags which apply for this channel
975 */
976 static inline enum ieee80211_rate_flags
ieee80211_chandef_rate_flags(struct cfg80211_chan_def * chandef)977 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
978 {
979 return ieee80211_chanwidth_rate_flags(chandef->width);
980 }
981
982 /**
983 * ieee80211_chandef_max_power - maximum transmission power for the chandef
984 *
985 * In some regulations, the transmit power may depend on the configured channel
986 * bandwidth which may be defined as dBm/MHz. This function returns the actual
987 * max_power for non-standard (20 MHz) channels.
988 *
989 * @chandef: channel definition for the channel
990 *
991 * Returns: maximum allowed transmission power in dBm for the chandef
992 */
993 static inline int
ieee80211_chandef_max_power(struct cfg80211_chan_def * chandef)994 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
995 {
996 switch (chandef->width) {
997 case NL80211_CHAN_WIDTH_5:
998 return min(chandef->chan->max_reg_power - 6,
999 chandef->chan->max_power);
1000 case NL80211_CHAN_WIDTH_10:
1001 return min(chandef->chan->max_reg_power - 3,
1002 chandef->chan->max_power);
1003 default:
1004 break;
1005 }
1006 return chandef->chan->max_power;
1007 }
1008
1009 /**
1010 * cfg80211_any_usable_channels - check for usable channels
1011 * @wiphy: the wiphy to check for
1012 * @band_mask: which bands to check on
1013 * @prohibited_flags: which channels to not consider usable,
1014 * %IEEE80211_CHAN_DISABLED is always taken into account
1015 */
1016 bool cfg80211_any_usable_channels(struct wiphy *wiphy,
1017 unsigned long band_mask,
1018 u32 prohibited_flags);
1019
1020 /**
1021 * enum survey_info_flags - survey information flags
1022 *
1023 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
1024 * @SURVEY_INFO_IN_USE: channel is currently being used
1025 * @SURVEY_INFO_TIME: active time (in ms) was filled in
1026 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
1027 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
1028 * @SURVEY_INFO_TIME_RX: receive time was filled in
1029 * @SURVEY_INFO_TIME_TX: transmit time was filled in
1030 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
1031 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
1032 *
1033 * Used by the driver to indicate which info in &struct survey_info
1034 * it has filled in during the get_survey().
1035 */
1036 enum survey_info_flags {
1037 SURVEY_INFO_NOISE_DBM = BIT(0),
1038 SURVEY_INFO_IN_USE = BIT(1),
1039 SURVEY_INFO_TIME = BIT(2),
1040 SURVEY_INFO_TIME_BUSY = BIT(3),
1041 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
1042 SURVEY_INFO_TIME_RX = BIT(5),
1043 SURVEY_INFO_TIME_TX = BIT(6),
1044 SURVEY_INFO_TIME_SCAN = BIT(7),
1045 SURVEY_INFO_TIME_BSS_RX = BIT(8),
1046 };
1047
1048 /**
1049 * struct survey_info - channel survey response
1050 *
1051 * @channel: the channel this survey record reports, may be %NULL for a single
1052 * record to report global statistics
1053 * @filled: bitflag of flags from &enum survey_info_flags
1054 * @noise: channel noise in dBm. This and all following fields are
1055 * optional
1056 * @time: amount of time in ms the radio was turn on (on the channel)
1057 * @time_busy: amount of time the primary channel was sensed busy
1058 * @time_ext_busy: amount of time the extension channel was sensed busy
1059 * @time_rx: amount of time the radio spent receiving data
1060 * @time_tx: amount of time the radio spent transmitting data
1061 * @time_scan: amount of time the radio spent for scanning
1062 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
1063 *
1064 * Used by dump_survey() to report back per-channel survey information.
1065 *
1066 * This structure can later be expanded with things like
1067 * channel duty cycle etc.
1068 */
1069 struct survey_info {
1070 struct ieee80211_channel *channel;
1071 u64 time;
1072 u64 time_busy;
1073 u64 time_ext_busy;
1074 u64 time_rx;
1075 u64 time_tx;
1076 u64 time_scan;
1077 u64 time_bss_rx;
1078 u32 filled;
1079 s8 noise;
1080 };
1081
1082 #define CFG80211_MAX_WEP_KEYS 4
1083 #define CFG80211_MAX_NUM_AKM_SUITES 10
1084
1085 /**
1086 * struct cfg80211_crypto_settings - Crypto settings
1087 * @wpa_versions: indicates which, if any, WPA versions are enabled
1088 * (from enum nl80211_wpa_versions)
1089 * @cipher_group: group key cipher suite (or 0 if unset)
1090 * @n_ciphers_pairwise: number of AP supported unicast ciphers
1091 * @ciphers_pairwise: unicast key cipher suites
1092 * @n_akm_suites: number of AKM suites
1093 * @akm_suites: AKM suites
1094 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
1095 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1096 * required to assume that the port is unauthorized until authorized by
1097 * user space. Otherwise, port is marked authorized by default.
1098 * @control_port_ethertype: the control port protocol that should be
1099 * allowed through even on unauthorized ports
1100 * @control_port_no_encrypt: TRUE to prevent encryption of control port
1101 * protocol frames.
1102 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1103 * port frames over NL80211 instead of the network interface.
1104 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control
1105 * port for mac80211
1106 * @wep_keys: static WEP keys, if not NULL points to an array of
1107 * CFG80211_MAX_WEP_KEYS WEP keys
1108 * @wep_tx_key: key index (0..3) of the default TX static WEP key
1109 * @psk: PSK (for devices supporting 4-way-handshake offload)
1110 * @sae_pwd: password for SAE authentication (for devices supporting SAE
1111 * offload)
1112 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
1113 * @sae_pwe: The mechanisms allowed for SAE PWE derivation:
1114 *
1115 * NL80211_SAE_PWE_UNSPECIFIED
1116 * Not-specified, used to indicate userspace did not specify any
1117 * preference. The driver should follow its internal policy in
1118 * such a scenario.
1119 *
1120 * NL80211_SAE_PWE_HUNT_AND_PECK
1121 * Allow hunting-and-pecking loop only
1122 *
1123 * NL80211_SAE_PWE_HASH_TO_ELEMENT
1124 * Allow hash-to-element only
1125 *
1126 * NL80211_SAE_PWE_BOTH
1127 * Allow either hunting-and-pecking loop or hash-to-element
1128 */
1129 struct cfg80211_crypto_settings {
1130 u32 wpa_versions;
1131 u32 cipher_group;
1132 int n_ciphers_pairwise;
1133 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
1134 int n_akm_suites;
1135 u32 akm_suites[CFG80211_MAX_NUM_AKM_SUITES];
1136 bool control_port;
1137 __be16 control_port_ethertype;
1138 bool control_port_no_encrypt;
1139 bool control_port_over_nl80211;
1140 bool control_port_no_preauth;
1141 struct key_params *wep_keys;
1142 int wep_tx_key;
1143 const u8 *psk;
1144 const u8 *sae_pwd;
1145 u8 sae_pwd_len;
1146 enum nl80211_sae_pwe_mechanism sae_pwe;
1147
1148 ANDROID_KABI_RESERVE(1);
1149 };
1150
1151 /**
1152 * struct cfg80211_mbssid_config - AP settings for multi bssid
1153 *
1154 * @tx_wdev: pointer to the transmitted interface in the MBSSID set
1155 * @index: index of this AP in the multi bssid group.
1156 * @ema: set to true if the beacons should be sent out in EMA mode.
1157 */
1158 struct cfg80211_mbssid_config {
1159 struct wireless_dev *tx_wdev;
1160 u8 index;
1161 bool ema;
1162 };
1163
1164 /**
1165 * struct cfg80211_mbssid_elems - Multiple BSSID elements
1166 *
1167 * @cnt: Number of elements in array %elems.
1168 *
1169 * @elem: Array of multiple BSSID element(s) to be added into Beacon frames.
1170 * @elem.data: Data for multiple BSSID elements.
1171 * @elem.len: Length of data.
1172 */
1173 struct cfg80211_mbssid_elems {
1174 u8 cnt;
1175 struct {
1176 const u8 *data;
1177 size_t len;
1178 } elem[];
1179 };
1180
1181 /**
1182 * struct cfg80211_beacon_data - beacon data
1183 * @link_id: the link ID for the AP MLD link sending this beacon
1184 * @head: head portion of beacon (before TIM IE)
1185 * or %NULL if not changed
1186 * @tail: tail portion of beacon (after TIM IE)
1187 * or %NULL if not changed
1188 * @head_len: length of @head
1189 * @tail_len: length of @tail
1190 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
1191 * @beacon_ies_len: length of beacon_ies in octets
1192 * @proberesp_ies: extra information element(s) to add into Probe Response
1193 * frames or %NULL
1194 * @proberesp_ies_len: length of proberesp_ies in octets
1195 * @assocresp_ies: extra information element(s) to add into (Re)Association
1196 * Response frames or %NULL
1197 * @assocresp_ies_len: length of assocresp_ies in octets
1198 * @probe_resp_len: length of probe response template (@probe_resp)
1199 * @probe_resp: probe response template (AP mode only)
1200 * @mbssid_ies: multiple BSSID elements
1201 * @ftm_responder: enable FTM responder functionality; -1 for no change
1202 * (which also implies no change in LCI/civic location data)
1203 * @lci: Measurement Report element content, starting with Measurement Token
1204 * (measurement type 8)
1205 * @civicloc: Measurement Report element content, starting with Measurement
1206 * Token (measurement type 11)
1207 * @lci_len: LCI data length
1208 * @civicloc_len: Civic location data length
1209 * @he_bss_color: BSS Color settings
1210 * @he_bss_color_valid: indicates whether bss color
1211 * attribute is present in beacon data or not.
1212 */
1213 struct cfg80211_beacon_data {
1214 unsigned int link_id;
1215
1216 const u8 *head, *tail;
1217 const u8 *beacon_ies;
1218 const u8 *proberesp_ies;
1219 const u8 *assocresp_ies;
1220 const u8 *probe_resp;
1221 const u8 *lci;
1222 const u8 *civicloc;
1223 struct cfg80211_mbssid_elems *mbssid_ies;
1224 s8 ftm_responder;
1225
1226 size_t head_len, tail_len;
1227 size_t beacon_ies_len;
1228 size_t proberesp_ies_len;
1229 size_t assocresp_ies_len;
1230 size_t probe_resp_len;
1231 size_t lci_len;
1232 size_t civicloc_len;
1233 struct cfg80211_he_bss_color he_bss_color;
1234 bool he_bss_color_valid;
1235
1236 ANDROID_KABI_RESERVE(1);
1237 };
1238
1239 struct mac_address {
1240 u8 addr[ETH_ALEN];
1241 };
1242
1243 /**
1244 * struct cfg80211_acl_data - Access control list data
1245 *
1246 * @acl_policy: ACL policy to be applied on the station's
1247 * entry specified by mac_addr
1248 * @n_acl_entries: Number of MAC address entries passed
1249 * @mac_addrs: List of MAC addresses of stations to be used for ACL
1250 */
1251 struct cfg80211_acl_data {
1252 enum nl80211_acl_policy acl_policy;
1253 int n_acl_entries;
1254
1255 /* Keep it last */
1256 struct mac_address mac_addrs[];
1257 };
1258
1259 /**
1260 * struct cfg80211_fils_discovery - FILS discovery parameters from
1261 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
1262 *
1263 * @min_interval: Minimum packet interval in TUs (0 - 10000)
1264 * @max_interval: Maximum packet interval in TUs (0 - 10000)
1265 * @tmpl_len: Template length
1266 * @tmpl: Template data for FILS discovery frame including the action
1267 * frame headers.
1268 */
1269 struct cfg80211_fils_discovery {
1270 u32 min_interval;
1271 u32 max_interval;
1272 size_t tmpl_len;
1273 const u8 *tmpl;
1274 };
1275
1276 /**
1277 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe
1278 * response parameters in 6GHz.
1279 *
1280 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned
1281 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive
1282 * scanning
1283 * @tmpl_len: Template length
1284 * @tmpl: Template data for probe response
1285 */
1286 struct cfg80211_unsol_bcast_probe_resp {
1287 u32 interval;
1288 size_t tmpl_len;
1289 const u8 *tmpl;
1290 };
1291
1292 /**
1293 * struct cfg80211_ap_settings - AP configuration
1294 *
1295 * Used to configure an AP interface.
1296 *
1297 * @chandef: defines the channel to use
1298 * @beacon: beacon data
1299 * @beacon_interval: beacon interval
1300 * @dtim_period: DTIM period
1301 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
1302 * user space)
1303 * @ssid_len: length of @ssid
1304 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
1305 * @crypto: crypto settings
1306 * @privacy: the BSS uses privacy
1307 * @auth_type: Authentication type (algorithm)
1308 * @smps_mode: SMPS mode
1309 * @inactivity_timeout: time in seconds to determine station's inactivity.
1310 * @p2p_ctwindow: P2P CT Window
1311 * @p2p_opp_ps: P2P opportunistic PS
1312 * @acl: ACL configuration used by the drivers which has support for
1313 * MAC address based access control
1314 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
1315 * networks.
1316 * @beacon_rate: bitrate to be used for beacons
1317 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
1318 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
1319 * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
1320 * @eht_cap: EHT capabilities (or %NULL if EHT isn't enabled)
1321 * @eht_oper: EHT operation IE (or %NULL if EHT isn't enabled)
1322 * @ht_required: stations must support HT
1323 * @vht_required: stations must support VHT
1324 * @twt_responder: Enable Target Wait Time
1325 * @he_required: stations must support HE
1326 * @sae_h2e_required: stations must support direct H2E technique in SAE
1327 * @flags: flags, as defined in enum cfg80211_ap_settings_flags
1328 * @he_obss_pd: OBSS Packet Detection settings
1329 * @he_oper: HE operation IE (or %NULL if HE isn't enabled)
1330 * @fils_discovery: FILS discovery transmission parameters
1331 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters
1332 * @mbssid_config: AP settings for multiple bssid
1333 * @punct_bitmap: Preamble puncturing bitmap. Each bit represents
1334 * a 20 MHz channel, lowest bit corresponding to the lowest channel.
1335 * Bit set to 1 indicates that the channel is punctured.
1336 */
1337 struct cfg80211_ap_settings {
1338 struct cfg80211_chan_def chandef;
1339
1340 struct cfg80211_beacon_data beacon;
1341
1342 int beacon_interval, dtim_period;
1343 const u8 *ssid;
1344 size_t ssid_len;
1345 enum nl80211_hidden_ssid hidden_ssid;
1346 struct cfg80211_crypto_settings crypto;
1347 bool privacy;
1348 enum nl80211_auth_type auth_type;
1349 enum nl80211_smps_mode smps_mode;
1350 int inactivity_timeout;
1351 u8 p2p_ctwindow;
1352 bool p2p_opp_ps;
1353 const struct cfg80211_acl_data *acl;
1354 bool pbss;
1355 struct cfg80211_bitrate_mask beacon_rate;
1356
1357 const struct ieee80211_ht_cap *ht_cap;
1358 const struct ieee80211_vht_cap *vht_cap;
1359 const struct ieee80211_he_cap_elem *he_cap;
1360 const struct ieee80211_he_operation *he_oper;
1361 const struct ieee80211_eht_cap_elem *eht_cap;
1362 const struct ieee80211_eht_operation *eht_oper;
1363 bool ht_required, vht_required, he_required, sae_h2e_required;
1364 bool twt_responder;
1365 u32 flags;
1366 struct ieee80211_he_obss_pd he_obss_pd;
1367 struct cfg80211_fils_discovery fils_discovery;
1368 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp;
1369 struct cfg80211_mbssid_config mbssid_config;
1370 u16 punct_bitmap;
1371
1372 ANDROID_KABI_RESERVE(1);
1373 };
1374
1375 /**
1376 * struct cfg80211_csa_settings - channel switch settings
1377 *
1378 * Used for channel switch
1379 *
1380 * @chandef: defines the channel to use after the switch
1381 * @beacon_csa: beacon data while performing the switch
1382 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1383 * @counter_offsets_presp: offsets of the counters within the probe response
1384 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1385 * @n_counter_offsets_presp: number of csa counters in the probe response
1386 * @beacon_after: beacon data to be used on the new channel
1387 * @radar_required: whether radar detection is required on the new channel
1388 * @block_tx: whether transmissions should be blocked while changing
1389 * @count: number of beacons until switch
1390 * @punct_bitmap: Preamble puncturing bitmap. Each bit represents
1391 * a 20 MHz channel, lowest bit corresponding to the lowest channel.
1392 * Bit set to 1 indicates that the channel is punctured.
1393 */
1394 struct cfg80211_csa_settings {
1395 struct cfg80211_chan_def chandef;
1396 struct cfg80211_beacon_data beacon_csa;
1397 const u16 *counter_offsets_beacon;
1398 const u16 *counter_offsets_presp;
1399 unsigned int n_counter_offsets_beacon;
1400 unsigned int n_counter_offsets_presp;
1401 struct cfg80211_beacon_data beacon_after;
1402 bool radar_required;
1403 bool block_tx;
1404 u8 count;
1405 u16 punct_bitmap;
1406
1407 ANDROID_KABI_RESERVE(1);
1408 };
1409
1410 /**
1411 * struct cfg80211_color_change_settings - color change settings
1412 *
1413 * Used for bss color change
1414 *
1415 * @beacon_color_change: beacon data while performing the color countdown
1416 * @counter_offset_beacon: offsets of the counters within the beacon (tail)
1417 * @counter_offset_presp: offsets of the counters within the probe response
1418 * @beacon_next: beacon data to be used after the color change
1419 * @count: number of beacons until the color change
1420 * @color: the color used after the change
1421 */
1422 struct cfg80211_color_change_settings {
1423 struct cfg80211_beacon_data beacon_color_change;
1424 u16 counter_offset_beacon;
1425 u16 counter_offset_presp;
1426 struct cfg80211_beacon_data beacon_next;
1427 u8 count;
1428 u8 color;
1429 };
1430
1431 /**
1432 * struct iface_combination_params - input parameters for interface combinations
1433 *
1434 * Used to pass interface combination parameters
1435 *
1436 * @num_different_channels: the number of different channels we want
1437 * to use for verification
1438 * @radar_detect: a bitmap where each bit corresponds to a channel
1439 * width where radar detection is needed, as in the definition of
1440 * &struct ieee80211_iface_combination.@radar_detect_widths
1441 * @iftype_num: array with the number of interfaces of each interface
1442 * type. The index is the interface type as specified in &enum
1443 * nl80211_iftype.
1444 * @new_beacon_int: set this to the beacon interval of a new interface
1445 * that's not operating yet, if such is to be checked as part of
1446 * the verification
1447 */
1448 struct iface_combination_params {
1449 int num_different_channels;
1450 u8 radar_detect;
1451 int iftype_num[NUM_NL80211_IFTYPES];
1452 u32 new_beacon_int;
1453 };
1454
1455 /**
1456 * enum station_parameters_apply_mask - station parameter values to apply
1457 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1458 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1459 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1460 * @STATION_PARAM_APPLY_STA_TXPOWER: apply tx power for STA
1461 *
1462 * Not all station parameters have in-band "no change" signalling,
1463 * for those that don't these flags will are used.
1464 */
1465 enum station_parameters_apply_mask {
1466 STATION_PARAM_APPLY_UAPSD = BIT(0),
1467 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1468 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1469 };
1470
1471 /**
1472 * struct sta_txpwr - station txpower configuration
1473 *
1474 * Used to configure txpower for station.
1475 *
1476 * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1477 * is not provided, the default per-interface tx power setting will be
1478 * overriding. Driver should be picking up the lowest tx power, either tx
1479 * power per-interface or per-station.
1480 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1481 * will be less than or equal to specified from userspace, whereas if TPC
1482 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1483 * NL80211_TX_POWER_FIXED is not a valid configuration option for
1484 * per peer TPC.
1485 */
1486 struct sta_txpwr {
1487 s16 power;
1488 enum nl80211_tx_power_setting type;
1489 };
1490
1491 /**
1492 * struct link_station_parameters - link station parameters
1493 *
1494 * Used to change and create a new link station.
1495 *
1496 * @mld_mac: MAC address of the station
1497 * @link_id: the link id (-1 for non-MLD station)
1498 * @link_mac: MAC address of the link
1499 * @supported_rates: supported rates in IEEE 802.11 format
1500 * (or NULL for no change)
1501 * @supported_rates_len: number of supported rates
1502 * @ht_capa: HT capabilities of station
1503 * @vht_capa: VHT capabilities of station
1504 * @opmode_notif: operating mode field from Operating Mode Notification
1505 * @opmode_notif_used: information if operating mode field is used
1506 * @he_capa: HE capabilities of station
1507 * @he_capa_len: the length of the HE capabilities
1508 * @txpwr: transmit power for an associated station
1509 * @txpwr_set: txpwr field is set
1510 * @he_6ghz_capa: HE 6 GHz Band capabilities of station
1511 * @eht_capa: EHT capabilities of station
1512 * @eht_capa_len: the length of the EHT capabilities
1513 */
1514 struct link_station_parameters {
1515 const u8 *mld_mac;
1516 int link_id;
1517 const u8 *link_mac;
1518 const u8 *supported_rates;
1519 u8 supported_rates_len;
1520 const struct ieee80211_ht_cap *ht_capa;
1521 const struct ieee80211_vht_cap *vht_capa;
1522 u8 opmode_notif;
1523 bool opmode_notif_used;
1524 const struct ieee80211_he_cap_elem *he_capa;
1525 u8 he_capa_len;
1526 struct sta_txpwr txpwr;
1527 bool txpwr_set;
1528 const struct ieee80211_he_6ghz_capa *he_6ghz_capa;
1529 const struct ieee80211_eht_cap_elem *eht_capa;
1530 u8 eht_capa_len;
1531 };
1532
1533 /**
1534 * struct link_station_del_parameters - link station deletion parameters
1535 *
1536 * Used to delete a link station entry (or all stations).
1537 *
1538 * @mld_mac: MAC address of the station
1539 * @link_id: the link id
1540 */
1541 struct link_station_del_parameters {
1542 const u8 *mld_mac;
1543 u32 link_id;
1544 };
1545
1546 /**
1547 * struct station_parameters - station parameters
1548 *
1549 * Used to change and create a new station.
1550 *
1551 * @vlan: vlan interface station should belong to
1552 * @sta_flags_mask: station flags that changed
1553 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1554 * @sta_flags_set: station flags values
1555 * (bitmask of BIT(%NL80211_STA_FLAG_...))
1556 * @listen_interval: listen interval or -1 for no change
1557 * @aid: AID or zero for no change
1558 * @vlan_id: VLAN ID for station (if nonzero)
1559 * @peer_aid: mesh peer AID or zero for no change
1560 * @plink_action: plink action to take
1561 * @plink_state: set the peer link state for a station
1562 * @uapsd_queues: bitmap of queues configured for uapsd. same format
1563 * as the AC bitmap in the QoS info field
1564 * @max_sp: max Service Period. same format as the MAX_SP in the
1565 * QoS info field (but already shifted down)
1566 * @sta_modify_mask: bitmap indicating which parameters changed
1567 * (for those that don't have a natural "no change" value),
1568 * see &enum station_parameters_apply_mask
1569 * @local_pm: local link-specific mesh power save mode (no change when set
1570 * to unknown)
1571 * @capability: station capability
1572 * @ext_capab: extended capabilities of the station
1573 * @ext_capab_len: number of extended capabilities
1574 * @supported_channels: supported channels in IEEE 802.11 format
1575 * @supported_channels_len: number of supported channels
1576 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1577 * @supported_oper_classes_len: number of supported operating classes
1578 * @support_p2p_ps: information if station supports P2P PS mechanism
1579 * @airtime_weight: airtime scheduler weight for this station
1580 * @link_sta_params: link related params.
1581 */
1582 struct station_parameters {
1583 struct net_device *vlan;
1584 u32 sta_flags_mask, sta_flags_set;
1585 u32 sta_modify_mask;
1586 int listen_interval;
1587 u16 aid;
1588 u16 vlan_id;
1589 u16 peer_aid;
1590 u8 plink_action;
1591 u8 plink_state;
1592 u8 uapsd_queues;
1593 u8 max_sp;
1594 enum nl80211_mesh_power_mode local_pm;
1595 u16 capability;
1596 const u8 *ext_capab;
1597 u8 ext_capab_len;
1598 const u8 *supported_channels;
1599 u8 supported_channels_len;
1600 const u8 *supported_oper_classes;
1601 u8 supported_oper_classes_len;
1602 int support_p2p_ps;
1603 u16 airtime_weight;
1604 struct link_station_parameters link_sta_params;
1605
1606 ANDROID_KABI_RESERVE(1);
1607 };
1608
1609 /**
1610 * struct station_del_parameters - station deletion parameters
1611 *
1612 * Used to delete a station entry (or all stations).
1613 *
1614 * @mac: MAC address of the station to remove or NULL to remove all stations
1615 * @subtype: Management frame subtype to use for indicating removal
1616 * (10 = Disassociation, 12 = Deauthentication)
1617 * @reason_code: Reason code for the Disassociation/Deauthentication frame
1618 */
1619 struct station_del_parameters {
1620 const u8 *mac;
1621 u8 subtype;
1622 u16 reason_code;
1623 };
1624
1625 /**
1626 * enum cfg80211_station_type - the type of station being modified
1627 * @CFG80211_STA_AP_CLIENT: client of an AP interface
1628 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1629 * unassociated (update properties for this type of client is permitted)
1630 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1631 * the AP MLME in the device
1632 * @CFG80211_STA_AP_STA: AP station on managed interface
1633 * @CFG80211_STA_IBSS: IBSS station
1634 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1635 * while TDLS setup is in progress, it moves out of this state when
1636 * being marked authorized; use this only if TDLS with external setup is
1637 * supported/used)
1638 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1639 * entry that is operating, has been marked authorized by userspace)
1640 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1641 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1642 */
1643 enum cfg80211_station_type {
1644 CFG80211_STA_AP_CLIENT,
1645 CFG80211_STA_AP_CLIENT_UNASSOC,
1646 CFG80211_STA_AP_MLME_CLIENT,
1647 CFG80211_STA_AP_STA,
1648 CFG80211_STA_IBSS,
1649 CFG80211_STA_TDLS_PEER_SETUP,
1650 CFG80211_STA_TDLS_PEER_ACTIVE,
1651 CFG80211_STA_MESH_PEER_KERNEL,
1652 CFG80211_STA_MESH_PEER_USER,
1653 };
1654
1655 /**
1656 * cfg80211_check_station_change - validate parameter changes
1657 * @wiphy: the wiphy this operates on
1658 * @params: the new parameters for a station
1659 * @statype: the type of station being modified
1660 *
1661 * Utility function for the @change_station driver method. Call this function
1662 * with the appropriate station type looking up the station (and checking that
1663 * it exists). It will verify whether the station change is acceptable, and if
1664 * not will return an error code. Note that it may modify the parameters for
1665 * backward compatibility reasons, so don't use them before calling this.
1666 */
1667 int cfg80211_check_station_change(struct wiphy *wiphy,
1668 struct station_parameters *params,
1669 enum cfg80211_station_type statype);
1670
1671 /**
1672 * enum rate_info_flags - bitrate info flags
1673 *
1674 * Used by the driver to indicate the specific rate transmission
1675 * type for 802.11n transmissions.
1676 *
1677 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1678 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1679 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1680 * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1681 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1682 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1683 * @RATE_INFO_FLAGS_EXTENDED_SC_DMG: 60GHz extended SC MCS
1684 * @RATE_INFO_FLAGS_EHT_MCS: EHT MCS information
1685 */
1686 enum rate_info_flags {
1687 RATE_INFO_FLAGS_MCS = BIT(0),
1688 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
1689 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1690 RATE_INFO_FLAGS_DMG = BIT(3),
1691 RATE_INFO_FLAGS_HE_MCS = BIT(4),
1692 RATE_INFO_FLAGS_EDMG = BIT(5),
1693 RATE_INFO_FLAGS_EXTENDED_SC_DMG = BIT(6),
1694 RATE_INFO_FLAGS_EHT_MCS = BIT(7),
1695 };
1696
1697 /**
1698 * enum rate_info_bw - rate bandwidth information
1699 *
1700 * Used by the driver to indicate the rate bandwidth.
1701 *
1702 * @RATE_INFO_BW_5: 5 MHz bandwidth
1703 * @RATE_INFO_BW_10: 10 MHz bandwidth
1704 * @RATE_INFO_BW_20: 20 MHz bandwidth
1705 * @RATE_INFO_BW_40: 40 MHz bandwidth
1706 * @RATE_INFO_BW_80: 80 MHz bandwidth
1707 * @RATE_INFO_BW_160: 160 MHz bandwidth
1708 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1709 * @RATE_INFO_BW_320: 320 MHz bandwidth
1710 * @RATE_INFO_BW_EHT_RU: bandwidth determined by EHT RU allocation
1711 */
1712 enum rate_info_bw {
1713 RATE_INFO_BW_20 = 0,
1714 RATE_INFO_BW_5,
1715 RATE_INFO_BW_10,
1716 RATE_INFO_BW_40,
1717 RATE_INFO_BW_80,
1718 RATE_INFO_BW_160,
1719 RATE_INFO_BW_HE_RU,
1720 RATE_INFO_BW_320,
1721 RATE_INFO_BW_EHT_RU,
1722 };
1723
1724 /**
1725 * struct rate_info - bitrate information
1726 *
1727 * Information about a receiving or transmitting bitrate
1728 *
1729 * @flags: bitflag of flags from &enum rate_info_flags
1730 * @mcs: mcs index if struct describes an HT/VHT/HE rate
1731 * @legacy: bitrate in 100kbit/s for 802.11abg
1732 * @nss: number of streams (VHT & HE only)
1733 * @bw: bandwidth (from &enum rate_info_bw)
1734 * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1735 * @he_dcm: HE DCM value
1736 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1737 * only valid if bw is %RATE_INFO_BW_HE_RU)
1738 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1739 * @eht_gi: EHT guard interval (from &enum nl80211_eht_gi)
1740 * @eht_ru_alloc: EHT RU allocation (from &enum nl80211_eht_ru_alloc,
1741 * only valid if bw is %RATE_INFO_BW_EHT_RU)
1742 */
1743 struct rate_info {
1744 u8 flags;
1745 u8 mcs;
1746 u16 legacy;
1747 u8 nss;
1748 u8 bw;
1749 u8 he_gi;
1750 u8 he_dcm;
1751 u8 he_ru_alloc;
1752 u8 n_bonded_ch;
1753 u8 eht_gi;
1754 u8 eht_ru_alloc;
1755 };
1756
1757 /**
1758 * enum bss_param_flags - bitrate info flags
1759 *
1760 * Used by the driver to indicate the specific rate transmission
1761 * type for 802.11n transmissions.
1762 *
1763 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1764 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1765 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1766 */
1767 enum bss_param_flags {
1768 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1769 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1770 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1771 };
1772
1773 /**
1774 * struct sta_bss_parameters - BSS parameters for the attached station
1775 *
1776 * Information about the currently associated BSS
1777 *
1778 * @flags: bitflag of flags from &enum bss_param_flags
1779 * @dtim_period: DTIM period for the BSS
1780 * @beacon_interval: beacon interval
1781 */
1782 struct sta_bss_parameters {
1783 u8 flags;
1784 u8 dtim_period;
1785 u16 beacon_interval;
1786 };
1787
1788 /**
1789 * struct cfg80211_txq_stats - TXQ statistics for this TID
1790 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1791 * indicate the relevant values in this struct are filled
1792 * @backlog_bytes: total number of bytes currently backlogged
1793 * @backlog_packets: total number of packets currently backlogged
1794 * @flows: number of new flows seen
1795 * @drops: total number of packets dropped
1796 * @ecn_marks: total number of packets marked with ECN CE
1797 * @overlimit: number of drops due to queue space overflow
1798 * @overmemory: number of drops due to memory limit overflow
1799 * @collisions: number of hash collisions
1800 * @tx_bytes: total number of bytes dequeued
1801 * @tx_packets: total number of packets dequeued
1802 * @max_flows: maximum number of flows supported
1803 */
1804 struct cfg80211_txq_stats {
1805 u32 filled;
1806 u32 backlog_bytes;
1807 u32 backlog_packets;
1808 u32 flows;
1809 u32 drops;
1810 u32 ecn_marks;
1811 u32 overlimit;
1812 u32 overmemory;
1813 u32 collisions;
1814 u32 tx_bytes;
1815 u32 tx_packets;
1816 u32 max_flows;
1817 };
1818
1819 /**
1820 * struct cfg80211_tid_stats - per-TID statistics
1821 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1822 * indicate the relevant values in this struct are filled
1823 * @rx_msdu: number of received MSDUs
1824 * @tx_msdu: number of (attempted) transmitted MSDUs
1825 * @tx_msdu_retries: number of retries (not counting the first) for
1826 * transmitted MSDUs
1827 * @tx_msdu_failed: number of failed transmitted MSDUs
1828 * @txq_stats: TXQ statistics
1829 */
1830 struct cfg80211_tid_stats {
1831 u32 filled;
1832 u64 rx_msdu;
1833 u64 tx_msdu;
1834 u64 tx_msdu_retries;
1835 u64 tx_msdu_failed;
1836 struct cfg80211_txq_stats txq_stats;
1837 };
1838
1839 #define IEEE80211_MAX_CHAINS 4
1840
1841 /**
1842 * struct station_info - station information
1843 *
1844 * Station information filled by driver for get_station() and dump_station.
1845 *
1846 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1847 * indicate the relevant values in this struct for them
1848 * @connected_time: time(in secs) since a station is last connected
1849 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1850 * @assoc_at: bootime (ns) of the last association
1851 * @rx_bytes: bytes (size of MPDUs) received from this station
1852 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1853 * @llid: mesh local link id
1854 * @plid: mesh peer link id
1855 * @plink_state: mesh peer link state
1856 * @signal: The signal strength, type depends on the wiphy's signal_type.
1857 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1858 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1859 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1860 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1861 * @chain_signal: per-chain signal strength of last received packet in dBm
1862 * @chain_signal_avg: per-chain signal strength average in dBm
1863 * @txrate: current unicast bitrate from this station
1864 * @rxrate: current unicast bitrate to this station
1865 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1866 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1867 * @tx_retries: cumulative retry counts (MPDUs)
1868 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1869 * @rx_dropped_misc: Dropped for un-specified reason.
1870 * @bss_param: current BSS parameters
1871 * @generation: generation number for nl80211 dumps.
1872 * This number should increase every time the list of stations
1873 * changes, i.e. when a station is added or removed, so that
1874 * userspace can tell whether it got a consistent snapshot.
1875 * @assoc_req_ies: IEs from (Re)Association Request.
1876 * This is used only when in AP mode with drivers that do not use
1877 * user space MLME/SME implementation. The information is provided for
1878 * the cfg80211_new_sta() calls to notify user space of the IEs.
1879 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1880 * @sta_flags: station flags mask & values
1881 * @beacon_loss_count: Number of times beacon loss event has triggered.
1882 * @t_offset: Time offset of the station relative to this host.
1883 * @local_pm: local mesh STA power save mode
1884 * @peer_pm: peer mesh STA power save mode
1885 * @nonpeer_pm: non-peer mesh STA power save mode
1886 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1887 * towards this station.
1888 * @rx_beacon: number of beacons received from this peer
1889 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1890 * from this peer
1891 * @connected_to_gate: true if mesh STA has a path to mesh gate
1892 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1893 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1894 * @airtime_weight: current airtime scheduling weight
1895 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1896 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1897 * Note that this doesn't use the @filled bit, but is used if non-NULL.
1898 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1899 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1900 * been sent.
1901 * @rx_mpdu_count: number of MPDUs received from this station
1902 * @fcs_err_count: number of packets (MPDUs) received from this station with
1903 * an FCS error. This counter should be incremented only when TA of the
1904 * received packet with an FCS error matches the peer MAC address.
1905 * @airtime_link_metric: mesh airtime link metric.
1906 * @connected_to_as: true if mesh STA has a path to authentication server
1907 */
1908 struct station_info {
1909 u64 filled;
1910 u32 connected_time;
1911 u32 inactive_time;
1912 u64 assoc_at;
1913 u64 rx_bytes;
1914 u64 tx_bytes;
1915 u16 llid;
1916 u16 plid;
1917 u8 plink_state;
1918 s8 signal;
1919 s8 signal_avg;
1920
1921 u8 chains;
1922 s8 chain_signal[IEEE80211_MAX_CHAINS];
1923 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1924
1925 struct rate_info txrate;
1926 struct rate_info rxrate;
1927 u32 rx_packets;
1928 u32 tx_packets;
1929 u32 tx_retries;
1930 u32 tx_failed;
1931 u32 rx_dropped_misc;
1932 struct sta_bss_parameters bss_param;
1933 struct nl80211_sta_flag_update sta_flags;
1934
1935 int generation;
1936
1937 const u8 *assoc_req_ies;
1938 size_t assoc_req_ies_len;
1939
1940 u32 beacon_loss_count;
1941 s64 t_offset;
1942 enum nl80211_mesh_power_mode local_pm;
1943 enum nl80211_mesh_power_mode peer_pm;
1944 enum nl80211_mesh_power_mode nonpeer_pm;
1945
1946 u32 expected_throughput;
1947
1948 u64 tx_duration;
1949 u64 rx_duration;
1950 u64 rx_beacon;
1951 u8 rx_beacon_signal_avg;
1952 u8 connected_to_gate;
1953
1954 struct cfg80211_tid_stats *pertid;
1955 s8 ack_signal;
1956 s8 avg_ack_signal;
1957
1958 u16 airtime_weight;
1959
1960 u32 rx_mpdu_count;
1961 u32 fcs_err_count;
1962
1963 u32 airtime_link_metric;
1964
1965 u8 connected_to_as;
1966
1967 ANDROID_KABI_RESERVE(1);
1968 };
1969
1970 /**
1971 * struct cfg80211_sar_sub_specs - sub specs limit
1972 * @power: power limitation in 0.25dbm
1973 * @freq_range_index: index the power limitation applies to
1974 */
1975 struct cfg80211_sar_sub_specs {
1976 s32 power;
1977 u32 freq_range_index;
1978 };
1979
1980 /**
1981 * struct cfg80211_sar_specs - sar limit specs
1982 * @type: it's set with power in 0.25dbm or other types
1983 * @num_sub_specs: number of sar sub specs
1984 * @sub_specs: memory to hold the sar sub specs
1985 */
1986 struct cfg80211_sar_specs {
1987 enum nl80211_sar_type type;
1988 u32 num_sub_specs;
1989 struct cfg80211_sar_sub_specs sub_specs[];
1990 };
1991
1992
1993 /**
1994 * struct cfg80211_sar_freq_ranges - sar frequency ranges
1995 * @start_freq: start range edge frequency
1996 * @end_freq: end range edge frequency
1997 */
1998 struct cfg80211_sar_freq_ranges {
1999 u32 start_freq;
2000 u32 end_freq;
2001 };
2002
2003 /**
2004 * struct cfg80211_sar_capa - sar limit capability
2005 * @type: it's set via power in 0.25dbm or other types
2006 * @num_freq_ranges: number of frequency ranges
2007 * @freq_ranges: memory to hold the freq ranges.
2008 *
2009 * Note: WLAN driver may append new ranges or split an existing
2010 * range to small ones and then append them.
2011 */
2012 struct cfg80211_sar_capa {
2013 enum nl80211_sar_type type;
2014 u32 num_freq_ranges;
2015 const struct cfg80211_sar_freq_ranges *freq_ranges;
2016 };
2017
2018 #if IS_ENABLED(CONFIG_CFG80211)
2019 /**
2020 * cfg80211_get_station - retrieve information about a given station
2021 * @dev: the device where the station is supposed to be connected to
2022 * @mac_addr: the mac address of the station of interest
2023 * @sinfo: pointer to the structure to fill with the information
2024 *
2025 * Returns 0 on success and sinfo is filled with the available information
2026 * otherwise returns a negative error code and the content of sinfo has to be
2027 * considered undefined.
2028 */
2029 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
2030 struct station_info *sinfo);
2031 #else
cfg80211_get_station(struct net_device * dev,const u8 * mac_addr,struct station_info * sinfo)2032 static inline int cfg80211_get_station(struct net_device *dev,
2033 const u8 *mac_addr,
2034 struct station_info *sinfo)
2035 {
2036 return -ENOENT;
2037 }
2038 #endif
2039
2040 /**
2041 * enum monitor_flags - monitor flags
2042 *
2043 * Monitor interface configuration flags. Note that these must be the bits
2044 * according to the nl80211 flags.
2045 *
2046 * @MONITOR_FLAG_CHANGED: set if the flags were changed
2047 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
2048 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
2049 * @MONITOR_FLAG_CONTROL: pass control frames
2050 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
2051 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
2052 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
2053 */
2054 enum monitor_flags {
2055 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
2056 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
2057 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
2058 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
2059 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
2060 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
2061 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
2062 };
2063
2064 /**
2065 * enum mpath_info_flags - mesh path information flags
2066 *
2067 * Used by the driver to indicate which info in &struct mpath_info it has filled
2068 * in during get_station() or dump_station().
2069 *
2070 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
2071 * @MPATH_INFO_SN: @sn filled
2072 * @MPATH_INFO_METRIC: @metric filled
2073 * @MPATH_INFO_EXPTIME: @exptime filled
2074 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
2075 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
2076 * @MPATH_INFO_FLAGS: @flags filled
2077 * @MPATH_INFO_HOP_COUNT: @hop_count filled
2078 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
2079 */
2080 enum mpath_info_flags {
2081 MPATH_INFO_FRAME_QLEN = BIT(0),
2082 MPATH_INFO_SN = BIT(1),
2083 MPATH_INFO_METRIC = BIT(2),
2084 MPATH_INFO_EXPTIME = BIT(3),
2085 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
2086 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
2087 MPATH_INFO_FLAGS = BIT(6),
2088 MPATH_INFO_HOP_COUNT = BIT(7),
2089 MPATH_INFO_PATH_CHANGE = BIT(8),
2090 };
2091
2092 /**
2093 * struct mpath_info - mesh path information
2094 *
2095 * Mesh path information filled by driver for get_mpath() and dump_mpath().
2096 *
2097 * @filled: bitfield of flags from &enum mpath_info_flags
2098 * @frame_qlen: number of queued frames for this destination
2099 * @sn: target sequence number
2100 * @metric: metric (cost) of this mesh path
2101 * @exptime: expiration time for the mesh path from now, in msecs
2102 * @flags: mesh path flags
2103 * @discovery_timeout: total mesh path discovery timeout, in msecs
2104 * @discovery_retries: mesh path discovery retries
2105 * @generation: generation number for nl80211 dumps.
2106 * This number should increase every time the list of mesh paths
2107 * changes, i.e. when a station is added or removed, so that
2108 * userspace can tell whether it got a consistent snapshot.
2109 * @hop_count: hops to destination
2110 * @path_change_count: total number of path changes to destination
2111 */
2112 struct mpath_info {
2113 u32 filled;
2114 u32 frame_qlen;
2115 u32 sn;
2116 u32 metric;
2117 u32 exptime;
2118 u32 discovery_timeout;
2119 u8 discovery_retries;
2120 u8 flags;
2121 u8 hop_count;
2122 u32 path_change_count;
2123
2124 int generation;
2125 };
2126
2127 /**
2128 * struct bss_parameters - BSS parameters
2129 *
2130 * Used to change BSS parameters (mainly for AP mode).
2131 *
2132 * @use_cts_prot: Whether to use CTS protection
2133 * (0 = no, 1 = yes, -1 = do not change)
2134 * @use_short_preamble: Whether the use of short preambles is allowed
2135 * (0 = no, 1 = yes, -1 = do not change)
2136 * @use_short_slot_time: Whether the use of short slot time is allowed
2137 * (0 = no, 1 = yes, -1 = do not change)
2138 * @basic_rates: basic rates in IEEE 802.11 format
2139 * (or NULL for no change)
2140 * @basic_rates_len: number of basic rates
2141 * @ap_isolate: do not forward packets between connected stations
2142 * (0 = no, 1 = yes, -1 = do not change)
2143 * @ht_opmode: HT Operation mode
2144 * (u16 = opmode, -1 = do not change)
2145 * @p2p_ctwindow: P2P CT Window (-1 = no change)
2146 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
2147 */
2148 struct bss_parameters {
2149 int use_cts_prot;
2150 int use_short_preamble;
2151 int use_short_slot_time;
2152 const u8 *basic_rates;
2153 u8 basic_rates_len;
2154 int ap_isolate;
2155 int ht_opmode;
2156 s8 p2p_ctwindow, p2p_opp_ps;
2157 };
2158
2159 /**
2160 * struct mesh_config - 802.11s mesh configuration
2161 *
2162 * These parameters can be changed while the mesh is active.
2163 *
2164 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
2165 * by the Mesh Peering Open message
2166 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
2167 * used by the Mesh Peering Open message
2168 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
2169 * the mesh peering management to close a mesh peering
2170 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
2171 * mesh interface
2172 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
2173 * be sent to establish a new peer link instance in a mesh
2174 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
2175 * @element_ttl: the value of TTL field set at a mesh STA for path selection
2176 * elements
2177 * @auto_open_plinks: whether we should automatically open peer links when we
2178 * detect compatible mesh peers
2179 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
2180 * synchronize to for 11s default synchronization method
2181 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
2182 * that an originator mesh STA can send to a particular path target
2183 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
2184 * @min_discovery_timeout: the minimum length of time to wait until giving up on
2185 * a path discovery in milliseconds
2186 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
2187 * receiving a PREQ shall consider the forwarding information from the
2188 * root to be valid. (TU = time unit)
2189 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
2190 * which a mesh STA can send only one action frame containing a PREQ
2191 * element
2192 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
2193 * which a mesh STA can send only one Action frame containing a PERR
2194 * element
2195 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
2196 * it takes for an HWMP information element to propagate across the mesh
2197 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
2198 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
2199 * announcements are transmitted
2200 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
2201 * station has access to a broader network beyond the MBSS. (This is
2202 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
2203 * only means that the station will announce others it's a mesh gate, but
2204 * not necessarily using the gate announcement protocol. Still keeping the
2205 * same nomenclature to be in sync with the spec)
2206 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
2207 * entity (default is TRUE - forwarding entity)
2208 * @rssi_threshold: the threshold for average signal strength of candidate
2209 * station to establish a peer link
2210 * @ht_opmode: mesh HT protection mode
2211 *
2212 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
2213 * receiving a proactive PREQ shall consider the forwarding information to
2214 * the root mesh STA to be valid.
2215 *
2216 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
2217 * PREQs are transmitted.
2218 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
2219 * during which a mesh STA can send only one Action frame containing
2220 * a PREQ element for root path confirmation.
2221 * @power_mode: The default mesh power save mode which will be the initial
2222 * setting for new peer links.
2223 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
2224 * after transmitting its beacon.
2225 * @plink_timeout: If no tx activity is seen from a STA we've established
2226 * peering with for longer than this time (in seconds), then remove it
2227 * from the STA's list of peers. Default is 30 minutes.
2228 * @dot11MeshConnectedToAuthServer: if set to true then this mesh STA
2229 * will advertise that it is connected to a authentication server
2230 * in the mesh formation field.
2231 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
2232 * connected to a mesh gate in mesh formation info. If false, the
2233 * value in mesh formation is determined by the presence of root paths
2234 * in the mesh path table
2235 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP
2236 * for HWMP) if the destination is a direct neighbor. Note that this might
2237 * not be the optimal decision as a multi-hop route might be better. So
2238 * if using this setting you will likely also want to disable
2239 * dot11MeshForwarding and use another mesh routing protocol on top.
2240 */
2241 struct mesh_config {
2242 u16 dot11MeshRetryTimeout;
2243 u16 dot11MeshConfirmTimeout;
2244 u16 dot11MeshHoldingTimeout;
2245 u16 dot11MeshMaxPeerLinks;
2246 u8 dot11MeshMaxRetries;
2247 u8 dot11MeshTTL;
2248 u8 element_ttl;
2249 bool auto_open_plinks;
2250 u32 dot11MeshNbrOffsetMaxNeighbor;
2251 u8 dot11MeshHWMPmaxPREQretries;
2252 u32 path_refresh_time;
2253 u16 min_discovery_timeout;
2254 u32 dot11MeshHWMPactivePathTimeout;
2255 u16 dot11MeshHWMPpreqMinInterval;
2256 u16 dot11MeshHWMPperrMinInterval;
2257 u16 dot11MeshHWMPnetDiameterTraversalTime;
2258 u8 dot11MeshHWMPRootMode;
2259 bool dot11MeshConnectedToMeshGate;
2260 bool dot11MeshConnectedToAuthServer;
2261 u16 dot11MeshHWMPRannInterval;
2262 bool dot11MeshGateAnnouncementProtocol;
2263 bool dot11MeshForwarding;
2264 s32 rssi_threshold;
2265 u16 ht_opmode;
2266 u32 dot11MeshHWMPactivePathToRootTimeout;
2267 u16 dot11MeshHWMProotInterval;
2268 u16 dot11MeshHWMPconfirmationInterval;
2269 enum nl80211_mesh_power_mode power_mode;
2270 u16 dot11MeshAwakeWindowDuration;
2271 u32 plink_timeout;
2272 bool dot11MeshNolearn;
2273
2274 ANDROID_KABI_RESERVE(1);
2275 };
2276
2277 /**
2278 * struct mesh_setup - 802.11s mesh setup configuration
2279 * @chandef: defines the channel to use
2280 * @mesh_id: the mesh ID
2281 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
2282 * @sync_method: which synchronization method to use
2283 * @path_sel_proto: which path selection protocol to use
2284 * @path_metric: which metric to use
2285 * @auth_id: which authentication method this mesh is using
2286 * @ie: vendor information elements (optional)
2287 * @ie_len: length of vendor information elements
2288 * @is_authenticated: this mesh requires authentication
2289 * @is_secure: this mesh uses security
2290 * @user_mpm: userspace handles all MPM functions
2291 * @dtim_period: DTIM period to use
2292 * @beacon_interval: beacon interval to use
2293 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
2294 * @basic_rates: basic rates to use when creating the mesh
2295 * @beacon_rate: bitrate to be used for beacons
2296 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2297 * changes the channel when a radar is detected. This is required
2298 * to operate on DFS channels.
2299 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2300 * port frames over NL80211 instead of the network interface.
2301 *
2302 * These parameters are fixed when the mesh is created.
2303 */
2304 struct mesh_setup {
2305 struct cfg80211_chan_def chandef;
2306 const u8 *mesh_id;
2307 u8 mesh_id_len;
2308 u8 sync_method;
2309 u8 path_sel_proto;
2310 u8 path_metric;
2311 u8 auth_id;
2312 const u8 *ie;
2313 u8 ie_len;
2314 bool is_authenticated;
2315 bool is_secure;
2316 bool user_mpm;
2317 u8 dtim_period;
2318 u16 beacon_interval;
2319 int mcast_rate[NUM_NL80211_BANDS];
2320 u32 basic_rates;
2321 struct cfg80211_bitrate_mask beacon_rate;
2322 bool userspace_handles_dfs;
2323 bool control_port_over_nl80211;
2324
2325 ANDROID_KABI_RESERVE(1);
2326 };
2327
2328 /**
2329 * struct ocb_setup - 802.11p OCB mode setup configuration
2330 * @chandef: defines the channel to use
2331 *
2332 * These parameters are fixed when connecting to the network
2333 */
2334 struct ocb_setup {
2335 struct cfg80211_chan_def chandef;
2336 };
2337
2338 /**
2339 * struct ieee80211_txq_params - TX queue parameters
2340 * @ac: AC identifier
2341 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
2342 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
2343 * 1..32767]
2344 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
2345 * 1..32767]
2346 * @aifs: Arbitration interframe space [0..255]
2347 * @link_id: link_id or -1 for non-MLD
2348 */
2349 struct ieee80211_txq_params {
2350 enum nl80211_ac ac;
2351 u16 txop;
2352 u16 cwmin;
2353 u16 cwmax;
2354 u8 aifs;
2355 int link_id;
2356 };
2357
2358 /**
2359 * DOC: Scanning and BSS list handling
2360 *
2361 * The scanning process itself is fairly simple, but cfg80211 offers quite
2362 * a bit of helper functionality. To start a scan, the scan operation will
2363 * be invoked with a scan definition. This scan definition contains the
2364 * channels to scan, and the SSIDs to send probe requests for (including the
2365 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
2366 * probe. Additionally, a scan request may contain extra information elements
2367 * that should be added to the probe request. The IEs are guaranteed to be
2368 * well-formed, and will not exceed the maximum length the driver advertised
2369 * in the wiphy structure.
2370 *
2371 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
2372 * it is responsible for maintaining the BSS list; the driver should not
2373 * maintain a list itself. For this notification, various functions exist.
2374 *
2375 * Since drivers do not maintain a BSS list, there are also a number of
2376 * functions to search for a BSS and obtain information about it from the
2377 * BSS structure cfg80211 maintains. The BSS list is also made available
2378 * to userspace.
2379 */
2380
2381 /**
2382 * struct cfg80211_ssid - SSID description
2383 * @ssid: the SSID
2384 * @ssid_len: length of the ssid
2385 */
2386 struct cfg80211_ssid {
2387 u8 ssid[IEEE80211_MAX_SSID_LEN];
2388 u8 ssid_len;
2389 };
2390
2391 /**
2392 * struct cfg80211_scan_info - information about completed scan
2393 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
2394 * wireless device that requested the scan is connected to. If this
2395 * information is not available, this field is left zero.
2396 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
2397 * @aborted: set to true if the scan was aborted for any reason,
2398 * userspace will be notified of that
2399 */
2400 struct cfg80211_scan_info {
2401 u64 scan_start_tsf;
2402 u8 tsf_bssid[ETH_ALEN] __aligned(2);
2403 bool aborted;
2404 };
2405
2406 /**
2407 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
2408 *
2409 * @short_ssid: short ssid to scan for
2410 * @bssid: bssid to scan for
2411 * @channel_idx: idx of the channel in the channel array in the scan request
2412 * which the above info relvant to
2413 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
2414 * @short_ssid_valid: @short_ssid is valid and can be used
2415 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
2416 * 20 TUs before starting to send probe requests.
2417 */
2418 struct cfg80211_scan_6ghz_params {
2419 u32 short_ssid;
2420 u32 channel_idx;
2421 u8 bssid[ETH_ALEN];
2422 bool unsolicited_probe;
2423 bool short_ssid_valid;
2424 bool psc_no_listen;
2425 };
2426
2427 /**
2428 * struct cfg80211_scan_request - scan request description
2429 *
2430 * @ssids: SSIDs to scan for (active scan only)
2431 * @n_ssids: number of SSIDs
2432 * @channels: channels to scan on.
2433 * @n_channels: total number of channels to scan
2434 * @scan_width: channel width for scanning
2435 * @ie: optional information element(s) to add into Probe Request or %NULL
2436 * @ie_len: length of ie in octets
2437 * @duration: how long to listen on each channel, in TUs. If
2438 * %duration_mandatory is not set, this is the maximum dwell time and
2439 * the actual dwell time may be shorter.
2440 * @duration_mandatory: if set, the scan duration must be as specified by the
2441 * %duration field.
2442 * @flags: bit field of flags controlling operation
2443 * @rates: bitmap of rates to advertise for each band
2444 * @wiphy: the wiphy this was for
2445 * @scan_start: time (in jiffies) when the scan started
2446 * @wdev: the wireless device to scan for
2447 * @info: (internal) information about completed scan
2448 * @notified: (internal) scan request was notified as done or aborted
2449 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
2450 * @mac_addr: MAC address used with randomisation
2451 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2452 * are 0 in the mask should be randomised, bits that are 1 should
2453 * be taken from the @mac_addr
2454 * @scan_6ghz: relevant for split scan request only,
2455 * true if this is the second scan request
2456 * @n_6ghz_params: number of 6 GHz params
2457 * @scan_6ghz_params: 6 GHz params
2458 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
2459 */
2460 struct cfg80211_scan_request {
2461 struct cfg80211_ssid *ssids;
2462 int n_ssids;
2463 u32 n_channels;
2464 enum nl80211_bss_scan_width scan_width;
2465 const u8 *ie;
2466 size_t ie_len;
2467 u16 duration;
2468 bool duration_mandatory;
2469 u32 flags;
2470
2471 u32 rates[NUM_NL80211_BANDS];
2472
2473 struct wireless_dev *wdev;
2474
2475 u8 mac_addr[ETH_ALEN] __aligned(2);
2476 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2477 u8 bssid[ETH_ALEN] __aligned(2);
2478
2479 /* internal */
2480 struct wiphy *wiphy;
2481 unsigned long scan_start;
2482 struct cfg80211_scan_info info;
2483 bool notified;
2484 bool no_cck;
2485 bool scan_6ghz;
2486 u32 n_6ghz_params;
2487 struct cfg80211_scan_6ghz_params *scan_6ghz_params;
2488
2489 ANDROID_KABI_RESERVE(1);
2490
2491 /* keep last */
2492 struct ieee80211_channel *channels[];
2493 };
2494
get_random_mask_addr(u8 * buf,const u8 * addr,const u8 * mask)2495 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
2496 {
2497 int i;
2498
2499 get_random_bytes(buf, ETH_ALEN);
2500 for (i = 0; i < ETH_ALEN; i++) {
2501 buf[i] &= ~mask[i];
2502 buf[i] |= addr[i] & mask[i];
2503 }
2504 }
2505
2506 /**
2507 * struct cfg80211_match_set - sets of attributes to match
2508 *
2509 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
2510 * or no match (RSSI only)
2511 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
2512 * or no match (RSSI only)
2513 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
2514 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
2515 * for filtering out scan results received. Drivers advertize this support
2516 * of band specific rssi based filtering through the feature capability
2517 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
2518 * specific rssi thresholds take precedence over rssi_thold, if specified.
2519 * If not specified for any band, it will be assigned with rssi_thold of
2520 * corresponding matchset.
2521 */
2522 struct cfg80211_match_set {
2523 struct cfg80211_ssid ssid;
2524 u8 bssid[ETH_ALEN];
2525 s32 rssi_thold;
2526 s32 per_band_rssi_thold[NUM_NL80211_BANDS];
2527 };
2528
2529 /**
2530 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
2531 *
2532 * @interval: interval between scheduled scan iterations. In seconds.
2533 * @iterations: number of scan iterations in this scan plan. Zero means
2534 * infinite loop.
2535 * The last scan plan will always have this parameter set to zero,
2536 * all other scan plans will have a finite number of iterations.
2537 */
2538 struct cfg80211_sched_scan_plan {
2539 u32 interval;
2540 u32 iterations;
2541 };
2542
2543 /**
2544 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2545 *
2546 * @band: band of BSS which should match for RSSI level adjustment.
2547 * @delta: value of RSSI level adjustment.
2548 */
2549 struct cfg80211_bss_select_adjust {
2550 enum nl80211_band band;
2551 s8 delta;
2552 };
2553
2554 /**
2555 * struct cfg80211_sched_scan_request - scheduled scan request description
2556 *
2557 * @reqid: identifies this request.
2558 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2559 * @n_ssids: number of SSIDs
2560 * @n_channels: total number of channels to scan
2561 * @scan_width: channel width for scanning
2562 * @ie: optional information element(s) to add into Probe Request or %NULL
2563 * @ie_len: length of ie in octets
2564 * @flags: bit field of flags controlling operation
2565 * @match_sets: sets of parameters to be matched for a scan result
2566 * entry to be considered valid and to be passed to the host
2567 * (others are filtered out).
2568 * If ommited, all results are passed.
2569 * @n_match_sets: number of match sets
2570 * @report_results: indicates that results were reported for this request
2571 * @wiphy: the wiphy this was for
2572 * @dev: the interface
2573 * @scan_start: start time of the scheduled scan
2574 * @channels: channels to scan
2575 * @min_rssi_thold: for drivers only supporting a single threshold, this
2576 * contains the minimum over all matchsets
2577 * @mac_addr: MAC address used with randomisation
2578 * @mac_addr_mask: MAC address mask used with randomisation, bits that
2579 * are 0 in the mask should be randomised, bits that are 1 should
2580 * be taken from the @mac_addr
2581 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2582 * index must be executed first.
2583 * @n_scan_plans: number of scan plans, at least 1.
2584 * @rcu_head: RCU callback used to free the struct
2585 * @owner_nlportid: netlink portid of owner (if this should is a request
2586 * owned by a particular socket)
2587 * @nl_owner_dead: netlink owner socket was closed - this request be freed
2588 * @list: for keeping list of requests.
2589 * @delay: delay in seconds to use before starting the first scan
2590 * cycle. The driver may ignore this parameter and start
2591 * immediately (or at any other time), if this feature is not
2592 * supported.
2593 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2594 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2595 * reporting in connected state to cases where a matching BSS is determined
2596 * to have better or slightly worse RSSI than the current connected BSS.
2597 * The relative RSSI threshold values are ignored in disconnected state.
2598 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2599 * to the specified band while deciding whether a better BSS is reported
2600 * using @relative_rssi. If delta is a negative number, the BSSs that
2601 * belong to the specified band will be penalized by delta dB in relative
2602 * comparisions.
2603 */
2604 struct cfg80211_sched_scan_request {
2605 u64 reqid;
2606 struct cfg80211_ssid *ssids;
2607 int n_ssids;
2608 u32 n_channels;
2609 enum nl80211_bss_scan_width scan_width;
2610 const u8 *ie;
2611 size_t ie_len;
2612 u32 flags;
2613 struct cfg80211_match_set *match_sets;
2614 int n_match_sets;
2615 s32 min_rssi_thold;
2616 u32 delay;
2617 struct cfg80211_sched_scan_plan *scan_plans;
2618 int n_scan_plans;
2619
2620 u8 mac_addr[ETH_ALEN] __aligned(2);
2621 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2622
2623 bool relative_rssi_set;
2624 s8 relative_rssi;
2625 struct cfg80211_bss_select_adjust rssi_adjust;
2626
2627 /* internal */
2628 struct wiphy *wiphy;
2629 struct net_device *dev;
2630 unsigned long scan_start;
2631 bool report_results;
2632 struct rcu_head rcu_head;
2633 u32 owner_nlportid;
2634 bool nl_owner_dead;
2635 struct list_head list;
2636
2637 ANDROID_KABI_RESERVE(1);
2638
2639 /* keep last */
2640 struct ieee80211_channel *channels[];
2641 };
2642
2643 /**
2644 * enum cfg80211_signal_type - signal type
2645 *
2646 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2647 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2648 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2649 */
2650 enum cfg80211_signal_type {
2651 CFG80211_SIGNAL_TYPE_NONE,
2652 CFG80211_SIGNAL_TYPE_MBM,
2653 CFG80211_SIGNAL_TYPE_UNSPEC,
2654 };
2655
2656 /**
2657 * struct cfg80211_inform_bss - BSS inform data
2658 * @chan: channel the frame was received on
2659 * @scan_width: scan width that was used
2660 * @signal: signal strength value, according to the wiphy's
2661 * signal type
2662 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2663 * received; should match the time when the frame was actually
2664 * received by the device (not just by the host, in case it was
2665 * buffered on the device) and be accurate to about 10ms.
2666 * If the frame isn't buffered, just passing the return value of
2667 * ktime_get_boottime_ns() is likely appropriate.
2668 * @parent_tsf: the time at the start of reception of the first octet of the
2669 * timestamp field of the frame. The time is the TSF of the BSS specified
2670 * by %parent_bssid.
2671 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2672 * the BSS that requested the scan in which the beacon/probe was received.
2673 * @chains: bitmask for filled values in @chain_signal.
2674 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2675 */
2676 struct cfg80211_inform_bss {
2677 struct ieee80211_channel *chan;
2678 enum nl80211_bss_scan_width scan_width;
2679 s32 signal;
2680 u64 boottime_ns;
2681 u64 parent_tsf;
2682 u8 parent_bssid[ETH_ALEN] __aligned(2);
2683 u8 chains;
2684 s8 chain_signal[IEEE80211_MAX_CHAINS];
2685 };
2686
2687 /**
2688 * struct cfg80211_bss_ies - BSS entry IE data
2689 * @tsf: TSF contained in the frame that carried these IEs
2690 * @rcu_head: internal use, for freeing
2691 * @len: length of the IEs
2692 * @from_beacon: these IEs are known to come from a beacon
2693 * @data: IE data
2694 */
2695 struct cfg80211_bss_ies {
2696 u64 tsf;
2697 struct rcu_head rcu_head;
2698 int len;
2699 bool from_beacon;
2700 u8 data[];
2701 };
2702
2703 /**
2704 * struct cfg80211_bss - BSS description
2705 *
2706 * This structure describes a BSS (which may also be a mesh network)
2707 * for use in scan results and similar.
2708 *
2709 * @channel: channel this BSS is on
2710 * @scan_width: width of the control channel
2711 * @bssid: BSSID of the BSS
2712 * @beacon_interval: the beacon interval as from the frame
2713 * @capability: the capability field in host byte order
2714 * @ies: the information elements (Note that there is no guarantee that these
2715 * are well-formed!); this is a pointer to either the beacon_ies or
2716 * proberesp_ies depending on whether Probe Response frame has been
2717 * received. It is always non-%NULL.
2718 * @beacon_ies: the information elements from the last Beacon frame
2719 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
2720 * own the beacon_ies, but they're just pointers to the ones from the
2721 * @hidden_beacon_bss struct)
2722 * @proberesp_ies: the information elements from the last Probe Response frame
2723 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2724 * a BSS that hides the SSID in its beacon, this points to the BSS struct
2725 * that holds the beacon data. @beacon_ies is still valid, of course, and
2726 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
2727 * @transmitted_bss: pointer to the transmitted BSS, if this is a
2728 * non-transmitted one (multi-BSSID support)
2729 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2730 * (multi-BSSID support)
2731 * @signal: signal strength value (type depends on the wiphy's signal_type)
2732 * @chains: bitmask for filled values in @chain_signal.
2733 * @chain_signal: per-chain signal strength of last received BSS in dBm.
2734 * @bssid_index: index in the multiple BSS set
2735 * @max_bssid_indicator: max number of members in the BSS set
2736 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2737 */
2738 struct cfg80211_bss {
2739 struct ieee80211_channel *channel;
2740 enum nl80211_bss_scan_width scan_width;
2741
2742 const struct cfg80211_bss_ies __rcu *ies;
2743 const struct cfg80211_bss_ies __rcu *beacon_ies;
2744 const struct cfg80211_bss_ies __rcu *proberesp_ies;
2745
2746 struct cfg80211_bss *hidden_beacon_bss;
2747 struct cfg80211_bss *transmitted_bss;
2748 struct list_head nontrans_list;
2749
2750 s32 signal;
2751
2752 u16 beacon_interval;
2753 u16 capability;
2754
2755 u8 bssid[ETH_ALEN];
2756 u8 chains;
2757 s8 chain_signal[IEEE80211_MAX_CHAINS];
2758
2759 u8 bssid_index;
2760 u8 max_bssid_indicator;
2761
2762 ANDROID_KABI_RESERVE(1);
2763
2764 u8 priv[] __aligned(sizeof(void *));
2765 };
2766
2767 /**
2768 * ieee80211_bss_get_elem - find element with given ID
2769 * @bss: the bss to search
2770 * @id: the element ID
2771 *
2772 * Note that the return value is an RCU-protected pointer, so
2773 * rcu_read_lock() must be held when calling this function.
2774 * Return: %NULL if not found.
2775 */
2776 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2777
2778 /**
2779 * ieee80211_bss_get_ie - find IE with given ID
2780 * @bss: the bss to search
2781 * @id: the element ID
2782 *
2783 * Note that the return value is an RCU-protected pointer, so
2784 * rcu_read_lock() must be held when calling this function.
2785 * Return: %NULL if not found.
2786 */
ieee80211_bss_get_ie(struct cfg80211_bss * bss,u8 id)2787 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2788 {
2789 return (void *)ieee80211_bss_get_elem(bss, id);
2790 }
2791
2792
2793 /**
2794 * struct cfg80211_auth_request - Authentication request data
2795 *
2796 * This structure provides information needed to complete IEEE 802.11
2797 * authentication.
2798 *
2799 * @bss: The BSS to authenticate with, the callee must obtain a reference
2800 * to it if it needs to keep it.
2801 * @auth_type: Authentication type (algorithm)
2802 * @ie: Extra IEs to add to Authentication frame or %NULL
2803 * @ie_len: Length of ie buffer in octets
2804 * @key_len: length of WEP key for shared key authentication
2805 * @key_idx: index of WEP key for shared key authentication
2806 * @key: WEP key for shared key authentication
2807 * @auth_data: Fields and elements in Authentication frames. This contains
2808 * the authentication frame body (non-IE and IE data), excluding the
2809 * Authentication algorithm number, i.e., starting at the Authentication
2810 * transaction sequence number field.
2811 * @auth_data_len: Length of auth_data buffer in octets
2812 * @link_id: if >= 0, indicates authentication should be done as an MLD,
2813 * the interface address is included as the MLD address and the
2814 * necessary link (with the given link_id) will be created (and
2815 * given an MLD address) by the driver
2816 * @ap_mld_addr: AP MLD address in case of authentication request with
2817 * an AP MLD, valid iff @link_id >= 0
2818 */
2819 struct cfg80211_auth_request {
2820 struct cfg80211_bss *bss;
2821 const u8 *ie;
2822 size_t ie_len;
2823 enum nl80211_auth_type auth_type;
2824 const u8 *key;
2825 u8 key_len;
2826 s8 key_idx;
2827 const u8 *auth_data;
2828 size_t auth_data_len;
2829 s8 link_id;
2830 const u8 *ap_mld_addr;
2831 };
2832
2833 /**
2834 * struct cfg80211_assoc_link - per-link information for MLO association
2835 * @bss: the BSS pointer, see also &struct cfg80211_assoc_request::bss;
2836 * if this is %NULL for a link, that link is not requested
2837 * @elems: extra elements for the per-STA profile for this link
2838 * @elems_len: length of the elements
2839 */
2840 struct cfg80211_assoc_link {
2841 struct cfg80211_bss *bss;
2842 const u8 *elems;
2843 size_t elems_len;
2844 };
2845
2846 /**
2847 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2848 *
2849 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
2850 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
2851 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2852 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2853 * authentication capability. Drivers can offload authentication to
2854 * userspace if this flag is set. Only applicable for cfg80211_connect()
2855 * request (connect callback).
2856 * @ASSOC_REQ_DISABLE_HE: Disable HE
2857 * @ASSOC_REQ_DISABLE_EHT: Disable EHT
2858 * @CONNECT_REQ_MLO_SUPPORT: Userspace indicates support for handling MLD links.
2859 * Drivers shall disable MLO features for the current association if this
2860 * flag is not set.
2861 */
2862 enum cfg80211_assoc_req_flags {
2863 ASSOC_REQ_DISABLE_HT = BIT(0),
2864 ASSOC_REQ_DISABLE_VHT = BIT(1),
2865 ASSOC_REQ_USE_RRM = BIT(2),
2866 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
2867 ASSOC_REQ_DISABLE_HE = BIT(4),
2868 ASSOC_REQ_DISABLE_EHT = BIT(5),
2869 CONNECT_REQ_MLO_SUPPORT = BIT(6),
2870 };
2871
2872 /**
2873 * struct cfg80211_assoc_request - (Re)Association request data
2874 *
2875 * This structure provides information needed to complete IEEE 802.11
2876 * (re)association.
2877 * @bss: The BSS to associate with. If the call is successful the driver is
2878 * given a reference that it must give back to cfg80211_send_rx_assoc()
2879 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2880 * association requests while already associating must be rejected.
2881 * This also applies to the @links.bss parameter, which is used instead
2882 * of this one (it is %NULL) for MLO associations.
2883 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2884 * @ie_len: Length of ie buffer in octets
2885 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2886 * @crypto: crypto settings
2887 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2888 * to indicate a request to reassociate within the ESS instead of a request
2889 * do the initial association with the ESS. When included, this is set to
2890 * the BSSID of the current association, i.e., to the value that is
2891 * included in the Current AP address field of the Reassociation Request
2892 * frame.
2893 * @flags: See &enum cfg80211_assoc_req_flags
2894 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2895 * will be used in ht_capa. Un-supported values will be ignored.
2896 * @ht_capa_mask: The bits of ht_capa which are to be used.
2897 * @vht_capa: VHT capability override
2898 * @vht_capa_mask: VHT capability mask indicating which fields to use
2899 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2900 * %NULL if FILS is not used.
2901 * @fils_kek_len: Length of fils_kek in octets
2902 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2903 * Request/Response frame or %NULL if FILS is not used. This field starts
2904 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2905 * @s1g_capa: S1G capability override
2906 * @s1g_capa_mask: S1G capability override mask
2907 * @links: per-link information for MLO connections
2908 * @link_id: >= 0 for MLO connections, where links are given, and indicates
2909 * the link on which the association request should be sent
2910 * @ap_mld_addr: AP MLD address in case of MLO association request,
2911 * valid iff @link_id >= 0
2912 */
2913 struct cfg80211_assoc_request {
2914 struct cfg80211_bss *bss;
2915 const u8 *ie, *prev_bssid;
2916 size_t ie_len;
2917 struct cfg80211_crypto_settings crypto;
2918 bool use_mfp;
2919 u32 flags;
2920 struct ieee80211_ht_cap ht_capa;
2921 struct ieee80211_ht_cap ht_capa_mask;
2922 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2923 const u8 *fils_kek;
2924 size_t fils_kek_len;
2925 const u8 *fils_nonces;
2926 struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask;
2927 struct cfg80211_assoc_link links[IEEE80211_MLD_MAX_NUM_LINKS];
2928 const u8 *ap_mld_addr;
2929 s8 link_id;
2930
2931 ANDROID_KABI_RESERVE(1);
2932 };
2933
2934 /**
2935 * struct cfg80211_deauth_request - Deauthentication request data
2936 *
2937 * This structure provides information needed to complete IEEE 802.11
2938 * deauthentication.
2939 *
2940 * @bssid: the BSSID or AP MLD address to deauthenticate from
2941 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2942 * @ie_len: Length of ie buffer in octets
2943 * @reason_code: The reason code for the deauthentication
2944 * @local_state_change: if set, change local state only and
2945 * do not set a deauth frame
2946 */
2947 struct cfg80211_deauth_request {
2948 const u8 *bssid;
2949 const u8 *ie;
2950 size_t ie_len;
2951 u16 reason_code;
2952 bool local_state_change;
2953 };
2954
2955 /**
2956 * struct cfg80211_disassoc_request - Disassociation request data
2957 *
2958 * This structure provides information needed to complete IEEE 802.11
2959 * disassociation.
2960 *
2961 * @ap_addr: the BSSID or AP MLD address to disassociate from
2962 * @ie: Extra IEs to add to Disassociation frame or %NULL
2963 * @ie_len: Length of ie buffer in octets
2964 * @reason_code: The reason code for the disassociation
2965 * @local_state_change: This is a request for a local state only, i.e., no
2966 * Disassociation frame is to be transmitted.
2967 */
2968 struct cfg80211_disassoc_request {
2969 const u8 *ap_addr;
2970 const u8 *ie;
2971 size_t ie_len;
2972 u16 reason_code;
2973 bool local_state_change;
2974 };
2975
2976 /**
2977 * struct cfg80211_ibss_params - IBSS parameters
2978 *
2979 * This structure defines the IBSS parameters for the join_ibss()
2980 * method.
2981 *
2982 * @ssid: The SSID, will always be non-null.
2983 * @ssid_len: The length of the SSID, will always be non-zero.
2984 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2985 * search for IBSSs with a different BSSID.
2986 * @chandef: defines the channel to use if no other IBSS to join can be found
2987 * @channel_fixed: The channel should be fixed -- do not search for
2988 * IBSSs to join on other channels.
2989 * @ie: information element(s) to include in the beacon
2990 * @ie_len: length of that
2991 * @beacon_interval: beacon interval to use
2992 * @privacy: this is a protected network, keys will be configured
2993 * after joining
2994 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2995 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2996 * required to assume that the port is unauthorized until authorized by
2997 * user space. Otherwise, port is marked authorized by default.
2998 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2999 * port frames over NL80211 instead of the network interface.
3000 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
3001 * changes the channel when a radar is detected. This is required
3002 * to operate on DFS channels.
3003 * @basic_rates: bitmap of basic rates to use when creating the IBSS
3004 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
3005 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
3006 * will be used in ht_capa. Un-supported values will be ignored.
3007 * @ht_capa_mask: The bits of ht_capa which are to be used.
3008 * @wep_keys: static WEP keys, if not NULL points to an array of
3009 * CFG80211_MAX_WEP_KEYS WEP keys
3010 * @wep_tx_key: key index (0..3) of the default TX static WEP key
3011 */
3012 struct cfg80211_ibss_params {
3013 const u8 *ssid;
3014 const u8 *bssid;
3015 struct cfg80211_chan_def chandef;
3016 const u8 *ie;
3017 u8 ssid_len, ie_len;
3018 u16 beacon_interval;
3019 u32 basic_rates;
3020 bool channel_fixed;
3021 bool privacy;
3022 bool control_port;
3023 bool control_port_over_nl80211;
3024 bool userspace_handles_dfs;
3025 int mcast_rate[NUM_NL80211_BANDS];
3026 struct ieee80211_ht_cap ht_capa;
3027 struct ieee80211_ht_cap ht_capa_mask;
3028 struct key_params *wep_keys;
3029 int wep_tx_key;
3030
3031 ANDROID_KABI_RESERVE(1);
3032 };
3033
3034 /**
3035 * struct cfg80211_bss_selection - connection parameters for BSS selection.
3036 *
3037 * @behaviour: requested BSS selection behaviour.
3038 * @param: parameters for requestion behaviour.
3039 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
3040 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
3041 */
3042 struct cfg80211_bss_selection {
3043 enum nl80211_bss_select_attr behaviour;
3044 union {
3045 enum nl80211_band band_pref;
3046 struct cfg80211_bss_select_adjust adjust;
3047 } param;
3048 };
3049
3050 /**
3051 * struct cfg80211_connect_params - Connection parameters
3052 *
3053 * This structure provides information needed to complete IEEE 802.11
3054 * authentication and association.
3055 *
3056 * @channel: The channel to use or %NULL if not specified (auto-select based
3057 * on scan results)
3058 * @channel_hint: The channel of the recommended BSS for initial connection or
3059 * %NULL if not specified
3060 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
3061 * results)
3062 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
3063 * %NULL if not specified. Unlike the @bssid parameter, the driver is
3064 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
3065 * to use.
3066 * @ssid: SSID
3067 * @ssid_len: Length of ssid in octets
3068 * @auth_type: Authentication type (algorithm)
3069 * @ie: IEs for association request
3070 * @ie_len: Length of assoc_ie in octets
3071 * @privacy: indicates whether privacy-enabled APs should be used
3072 * @mfp: indicate whether management frame protection is used
3073 * @crypto: crypto settings
3074 * @key_len: length of WEP key for shared key authentication
3075 * @key_idx: index of WEP key for shared key authentication
3076 * @key: WEP key for shared key authentication
3077 * @flags: See &enum cfg80211_assoc_req_flags
3078 * @bg_scan_period: Background scan period in seconds
3079 * or -1 to indicate that default value is to be used.
3080 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
3081 * will be used in ht_capa. Un-supported values will be ignored.
3082 * @ht_capa_mask: The bits of ht_capa which are to be used.
3083 * @vht_capa: VHT Capability overrides
3084 * @vht_capa_mask: The bits of vht_capa which are to be used.
3085 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
3086 * networks.
3087 * @bss_select: criteria to be used for BSS selection.
3088 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
3089 * to indicate a request to reassociate within the ESS instead of a request
3090 * do the initial association with the ESS. When included, this is set to
3091 * the BSSID of the current association, i.e., to the value that is
3092 * included in the Current AP address field of the Reassociation Request
3093 * frame.
3094 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
3095 * NAI or %NULL if not specified. This is used to construct FILS wrapped
3096 * data IE.
3097 * @fils_erp_username_len: Length of @fils_erp_username in octets.
3098 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
3099 * %NULL if not specified. This specifies the domain name of ER server and
3100 * is used to construct FILS wrapped data IE.
3101 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
3102 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
3103 * messages. This is also used to construct FILS wrapped data IE.
3104 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
3105 * keys in FILS or %NULL if not specified.
3106 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
3107 * @want_1x: indicates user-space supports and wants to use 802.1X driver
3108 * offload of 4-way handshake.
3109 * @edmg: define the EDMG channels.
3110 * This may specify multiple channels and bonding options for the driver
3111 * to choose from, based on BSS configuration.
3112 */
3113 struct cfg80211_connect_params {
3114 struct ieee80211_channel *channel;
3115 struct ieee80211_channel *channel_hint;
3116 const u8 *bssid;
3117 const u8 *bssid_hint;
3118 const u8 *ssid;
3119 size_t ssid_len;
3120 enum nl80211_auth_type auth_type;
3121 const u8 *ie;
3122 size_t ie_len;
3123 bool privacy;
3124 enum nl80211_mfp mfp;
3125 struct cfg80211_crypto_settings crypto;
3126 const u8 *key;
3127 u8 key_len, key_idx;
3128 u32 flags;
3129 int bg_scan_period;
3130 struct ieee80211_ht_cap ht_capa;
3131 struct ieee80211_ht_cap ht_capa_mask;
3132 struct ieee80211_vht_cap vht_capa;
3133 struct ieee80211_vht_cap vht_capa_mask;
3134 bool pbss;
3135 struct cfg80211_bss_selection bss_select;
3136 const u8 *prev_bssid;
3137 const u8 *fils_erp_username;
3138 size_t fils_erp_username_len;
3139 const u8 *fils_erp_realm;
3140 size_t fils_erp_realm_len;
3141 u16 fils_erp_next_seq_num;
3142 const u8 *fils_erp_rrk;
3143 size_t fils_erp_rrk_len;
3144 bool want_1x;
3145 struct ieee80211_edmg edmg;
3146
3147 ANDROID_KABI_RESERVE(1);
3148 };
3149
3150 /**
3151 * enum cfg80211_connect_params_changed - Connection parameters being updated
3152 *
3153 * This enum provides information of all connect parameters that
3154 * have to be updated as part of update_connect_params() call.
3155 *
3156 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
3157 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
3158 * username, erp sequence number and rrk) are updated
3159 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
3160 */
3161 enum cfg80211_connect_params_changed {
3162 UPDATE_ASSOC_IES = BIT(0),
3163 UPDATE_FILS_ERP_INFO = BIT(1),
3164 UPDATE_AUTH_TYPE = BIT(2),
3165 };
3166
3167 /**
3168 * enum wiphy_params_flags - set_wiphy_params bitfield values
3169 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
3170 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
3171 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
3172 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
3173 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
3174 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
3175 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
3176 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
3177 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
3178 */
3179 enum wiphy_params_flags {
3180 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
3181 WIPHY_PARAM_RETRY_LONG = 1 << 1,
3182 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
3183 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
3184 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
3185 WIPHY_PARAM_DYN_ACK = 1 << 5,
3186 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
3187 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
3188 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
3189 };
3190
3191 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256
3192
3193 /* The per TXQ device queue limit in airtime */
3194 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000
3195 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000
3196
3197 /* The per interface airtime threshold to switch to lower queue limit */
3198 #define IEEE80211_AQL_THRESHOLD 24000
3199
3200 /**
3201 * struct cfg80211_pmksa - PMK Security Association
3202 *
3203 * This structure is passed to the set/del_pmksa() method for PMKSA
3204 * caching.
3205 *
3206 * @bssid: The AP's BSSID (may be %NULL).
3207 * @pmkid: The identifier to refer a PMKSA.
3208 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
3209 * derivation by a FILS STA. Otherwise, %NULL.
3210 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
3211 * the hash algorithm used to generate this.
3212 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
3213 * cache identifier (may be %NULL).
3214 * @ssid_len: Length of the @ssid in octets.
3215 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
3216 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
3217 * %NULL).
3218 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds
3219 * (dot11RSNAConfigPMKLifetime) or 0 if not specified.
3220 * The configured PMKSA must not be used for PMKSA caching after
3221 * expiration and any keys derived from this PMK become invalid on
3222 * expiration, i.e., the current association must be dropped if the PMK
3223 * used for it expires.
3224 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of
3225 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified.
3226 * Drivers are expected to trigger a full authentication instead of using
3227 * this PMKSA for caching when reassociating to a new BSS after this
3228 * threshold to generate a new PMK before the current one expires.
3229 */
3230 struct cfg80211_pmksa {
3231 const u8 *bssid;
3232 const u8 *pmkid;
3233 const u8 *pmk;
3234 size_t pmk_len;
3235 const u8 *ssid;
3236 size_t ssid_len;
3237 const u8 *cache_id;
3238 u32 pmk_lifetime;
3239 u8 pmk_reauth_threshold;
3240 };
3241
3242 /**
3243 * struct cfg80211_pkt_pattern - packet pattern
3244 * @mask: bitmask where to match pattern and where to ignore bytes,
3245 * one bit per byte, in same format as nl80211
3246 * @pattern: bytes to match where bitmask is 1
3247 * @pattern_len: length of pattern (in bytes)
3248 * @pkt_offset: packet offset (in bytes)
3249 *
3250 * Internal note: @mask and @pattern are allocated in one chunk of
3251 * memory, free @mask only!
3252 */
3253 struct cfg80211_pkt_pattern {
3254 const u8 *mask, *pattern;
3255 int pattern_len;
3256 int pkt_offset;
3257 };
3258
3259 /**
3260 * struct cfg80211_wowlan_tcp - TCP connection parameters
3261 *
3262 * @sock: (internal) socket for source port allocation
3263 * @src: source IP address
3264 * @dst: destination IP address
3265 * @dst_mac: destination MAC address
3266 * @src_port: source port
3267 * @dst_port: destination port
3268 * @payload_len: data payload length
3269 * @payload: data payload buffer
3270 * @payload_seq: payload sequence stamping configuration
3271 * @data_interval: interval at which to send data packets
3272 * @wake_len: wakeup payload match length
3273 * @wake_data: wakeup payload match data
3274 * @wake_mask: wakeup payload match mask
3275 * @tokens_size: length of the tokens buffer
3276 * @payload_tok: payload token usage configuration
3277 */
3278 struct cfg80211_wowlan_tcp {
3279 struct socket *sock;
3280 __be32 src, dst;
3281 u16 src_port, dst_port;
3282 u8 dst_mac[ETH_ALEN];
3283 int payload_len;
3284 const u8 *payload;
3285 struct nl80211_wowlan_tcp_data_seq payload_seq;
3286 u32 data_interval;
3287 u32 wake_len;
3288 const u8 *wake_data, *wake_mask;
3289 u32 tokens_size;
3290 /* must be last, variable member */
3291 struct nl80211_wowlan_tcp_data_token payload_tok;
3292 };
3293
3294 /**
3295 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
3296 *
3297 * This structure defines the enabled WoWLAN triggers for the device.
3298 * @any: wake up on any activity -- special trigger if device continues
3299 * operating as normal during suspend
3300 * @disconnect: wake up if getting disconnected
3301 * @magic_pkt: wake up on receiving magic packet
3302 * @patterns: wake up on receiving packet matching a pattern
3303 * @n_patterns: number of patterns
3304 * @gtk_rekey_failure: wake up on GTK rekey failure
3305 * @eap_identity_req: wake up on EAP identity request packet
3306 * @four_way_handshake: wake up on 4-way handshake
3307 * @rfkill_release: wake up when rfkill is released
3308 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
3309 * NULL if not configured.
3310 * @nd_config: configuration for the scan to be used for net detect wake.
3311 */
3312 struct cfg80211_wowlan {
3313 bool any, disconnect, magic_pkt, gtk_rekey_failure,
3314 eap_identity_req, four_way_handshake,
3315 rfkill_release;
3316 struct cfg80211_pkt_pattern *patterns;
3317 struct cfg80211_wowlan_tcp *tcp;
3318 int n_patterns;
3319 struct cfg80211_sched_scan_request *nd_config;
3320 };
3321
3322 /**
3323 * struct cfg80211_coalesce_rules - Coalesce rule parameters
3324 *
3325 * This structure defines coalesce rule for the device.
3326 * @delay: maximum coalescing delay in msecs.
3327 * @condition: condition for packet coalescence.
3328 * see &enum nl80211_coalesce_condition.
3329 * @patterns: array of packet patterns
3330 * @n_patterns: number of patterns
3331 */
3332 struct cfg80211_coalesce_rules {
3333 int delay;
3334 enum nl80211_coalesce_condition condition;
3335 struct cfg80211_pkt_pattern *patterns;
3336 int n_patterns;
3337 };
3338
3339 /**
3340 * struct cfg80211_coalesce - Packet coalescing settings
3341 *
3342 * This structure defines coalescing settings.
3343 * @rules: array of coalesce rules
3344 * @n_rules: number of rules
3345 */
3346 struct cfg80211_coalesce {
3347 struct cfg80211_coalesce_rules *rules;
3348 int n_rules;
3349 };
3350
3351 /**
3352 * struct cfg80211_wowlan_nd_match - information about the match
3353 *
3354 * @ssid: SSID of the match that triggered the wake up
3355 * @n_channels: Number of channels where the match occurred. This
3356 * value may be zero if the driver can't report the channels.
3357 * @channels: center frequencies of the channels where a match
3358 * occurred (in MHz)
3359 */
3360 struct cfg80211_wowlan_nd_match {
3361 struct cfg80211_ssid ssid;
3362 int n_channels;
3363 u32 channels[];
3364 };
3365
3366 /**
3367 * struct cfg80211_wowlan_nd_info - net detect wake up information
3368 *
3369 * @n_matches: Number of match information instances provided in
3370 * @matches. This value may be zero if the driver can't provide
3371 * match information.
3372 * @matches: Array of pointers to matches containing information about
3373 * the matches that triggered the wake up.
3374 */
3375 struct cfg80211_wowlan_nd_info {
3376 int n_matches;
3377 struct cfg80211_wowlan_nd_match *matches[];
3378 };
3379
3380 /**
3381 * struct cfg80211_wowlan_wakeup - wakeup report
3382 * @disconnect: woke up by getting disconnected
3383 * @magic_pkt: woke up by receiving magic packet
3384 * @gtk_rekey_failure: woke up by GTK rekey failure
3385 * @eap_identity_req: woke up by EAP identity request packet
3386 * @four_way_handshake: woke up by 4-way handshake
3387 * @rfkill_release: woke up by rfkill being released
3388 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
3389 * @packet_present_len: copied wakeup packet data
3390 * @packet_len: original wakeup packet length
3391 * @packet: The packet causing the wakeup, if any.
3392 * @packet_80211: For pattern match, magic packet and other data
3393 * frame triggers an 802.3 frame should be reported, for
3394 * disconnect due to deauth 802.11 frame. This indicates which
3395 * it is.
3396 * @tcp_match: TCP wakeup packet received
3397 * @tcp_connlost: TCP connection lost or failed to establish
3398 * @tcp_nomoretokens: TCP data ran out of tokens
3399 * @net_detect: if not %NULL, woke up because of net detect
3400 */
3401 struct cfg80211_wowlan_wakeup {
3402 bool disconnect, magic_pkt, gtk_rekey_failure,
3403 eap_identity_req, four_way_handshake,
3404 rfkill_release, packet_80211,
3405 tcp_match, tcp_connlost, tcp_nomoretokens;
3406 s32 pattern_idx;
3407 u32 packet_present_len, packet_len;
3408 const void *packet;
3409 struct cfg80211_wowlan_nd_info *net_detect;
3410 };
3411
3412 /**
3413 * struct cfg80211_gtk_rekey_data - rekey data
3414 * @kek: key encryption key (@kek_len bytes)
3415 * @kck: key confirmation key (@kck_len bytes)
3416 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
3417 * @kek_len: length of kek
3418 * @kck_len: length of kck
3419 * @akm: akm (oui, id)
3420 */
3421 struct cfg80211_gtk_rekey_data {
3422 const u8 *kek, *kck, *replay_ctr;
3423 u32 akm;
3424 u8 kek_len, kck_len;
3425 };
3426
3427 /**
3428 * struct cfg80211_update_ft_ies_params - FT IE Information
3429 *
3430 * This structure provides information needed to update the fast transition IE
3431 *
3432 * @md: The Mobility Domain ID, 2 Octet value
3433 * @ie: Fast Transition IEs
3434 * @ie_len: Length of ft_ie in octets
3435 */
3436 struct cfg80211_update_ft_ies_params {
3437 u16 md;
3438 const u8 *ie;
3439 size_t ie_len;
3440 };
3441
3442 /**
3443 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
3444 *
3445 * This structure provides information needed to transmit a mgmt frame
3446 *
3447 * @chan: channel to use
3448 * @offchan: indicates wether off channel operation is required
3449 * @wait: duration for ROC
3450 * @buf: buffer to transmit
3451 * @len: buffer length
3452 * @no_cck: don't use cck rates for this frame
3453 * @dont_wait_for_ack: tells the low level not to wait for an ack
3454 * @n_csa_offsets: length of csa_offsets array
3455 * @csa_offsets: array of all the csa offsets in the frame
3456 * @link_id: for MLO, the link ID to transmit on, -1 if not given; note
3457 * that the link ID isn't validated (much), it's in range but the
3458 * link might not exist (or be used by the receiver STA)
3459 */
3460 struct cfg80211_mgmt_tx_params {
3461 struct ieee80211_channel *chan;
3462 bool offchan;
3463 unsigned int wait;
3464 const u8 *buf;
3465 size_t len;
3466 bool no_cck;
3467 bool dont_wait_for_ack;
3468 int n_csa_offsets;
3469 const u16 *csa_offsets;
3470 int link_id;
3471 };
3472
3473 /**
3474 * struct cfg80211_dscp_exception - DSCP exception
3475 *
3476 * @dscp: DSCP value that does not adhere to the user priority range definition
3477 * @up: user priority value to which the corresponding DSCP value belongs
3478 */
3479 struct cfg80211_dscp_exception {
3480 u8 dscp;
3481 u8 up;
3482 };
3483
3484 /**
3485 * struct cfg80211_dscp_range - DSCP range definition for user priority
3486 *
3487 * @low: lowest DSCP value of this user priority range, inclusive
3488 * @high: highest DSCP value of this user priority range, inclusive
3489 */
3490 struct cfg80211_dscp_range {
3491 u8 low;
3492 u8 high;
3493 };
3494
3495 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
3496 #define IEEE80211_QOS_MAP_MAX_EX 21
3497 #define IEEE80211_QOS_MAP_LEN_MIN 16
3498 #define IEEE80211_QOS_MAP_LEN_MAX \
3499 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
3500
3501 /**
3502 * struct cfg80211_qos_map - QoS Map Information
3503 *
3504 * This struct defines the Interworking QoS map setting for DSCP values
3505 *
3506 * @num_des: number of DSCP exceptions (0..21)
3507 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
3508 * the user priority DSCP range definition
3509 * @up: DSCP range definition for a particular user priority
3510 */
3511 struct cfg80211_qos_map {
3512 u8 num_des;
3513 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
3514 struct cfg80211_dscp_range up[8];
3515 };
3516
3517 /**
3518 * struct cfg80211_nan_conf - NAN configuration
3519 *
3520 * This struct defines NAN configuration parameters
3521 *
3522 * @master_pref: master preference (1 - 255)
3523 * @bands: operating bands, a bitmap of &enum nl80211_band values.
3524 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
3525 * (i.e. BIT(NL80211_BAND_2GHZ)).
3526 */
3527 struct cfg80211_nan_conf {
3528 u8 master_pref;
3529 u8 bands;
3530 };
3531
3532 /**
3533 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
3534 * configuration
3535 *
3536 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
3537 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
3538 */
3539 enum cfg80211_nan_conf_changes {
3540 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
3541 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
3542 };
3543
3544 /**
3545 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
3546 *
3547 * @filter: the content of the filter
3548 * @len: the length of the filter
3549 */
3550 struct cfg80211_nan_func_filter {
3551 const u8 *filter;
3552 u8 len;
3553 };
3554
3555 /**
3556 * struct cfg80211_nan_func - a NAN function
3557 *
3558 * @type: &enum nl80211_nan_function_type
3559 * @service_id: the service ID of the function
3560 * @publish_type: &nl80211_nan_publish_type
3561 * @close_range: if true, the range should be limited. Threshold is
3562 * implementation specific.
3563 * @publish_bcast: if true, the solicited publish should be broadcasted
3564 * @subscribe_active: if true, the subscribe is active
3565 * @followup_id: the instance ID for follow up
3566 * @followup_reqid: the requestor instance ID for follow up
3567 * @followup_dest: MAC address of the recipient of the follow up
3568 * @ttl: time to live counter in DW.
3569 * @serv_spec_info: Service Specific Info
3570 * @serv_spec_info_len: Service Specific Info length
3571 * @srf_include: if true, SRF is inclusive
3572 * @srf_bf: Bloom Filter
3573 * @srf_bf_len: Bloom Filter length
3574 * @srf_bf_idx: Bloom Filter index
3575 * @srf_macs: SRF MAC addresses
3576 * @srf_num_macs: number of MAC addresses in SRF
3577 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
3578 * @tx_filters: filters that should be transmitted in the SDF.
3579 * @num_rx_filters: length of &rx_filters.
3580 * @num_tx_filters: length of &tx_filters.
3581 * @instance_id: driver allocated id of the function.
3582 * @cookie: unique NAN function identifier.
3583 */
3584 struct cfg80211_nan_func {
3585 enum nl80211_nan_function_type type;
3586 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
3587 u8 publish_type;
3588 bool close_range;
3589 bool publish_bcast;
3590 bool subscribe_active;
3591 u8 followup_id;
3592 u8 followup_reqid;
3593 struct mac_address followup_dest;
3594 u32 ttl;
3595 const u8 *serv_spec_info;
3596 u8 serv_spec_info_len;
3597 bool srf_include;
3598 const u8 *srf_bf;
3599 u8 srf_bf_len;
3600 u8 srf_bf_idx;
3601 struct mac_address *srf_macs;
3602 int srf_num_macs;
3603 struct cfg80211_nan_func_filter *rx_filters;
3604 struct cfg80211_nan_func_filter *tx_filters;
3605 u8 num_tx_filters;
3606 u8 num_rx_filters;
3607 u8 instance_id;
3608 u64 cookie;
3609
3610 ANDROID_KABI_RESERVE(1);
3611 };
3612
3613 /**
3614 * struct cfg80211_pmk_conf - PMK configuration
3615 *
3616 * @aa: authenticator address
3617 * @pmk_len: PMK length in bytes.
3618 * @pmk: the PMK material
3619 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3620 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3621 * holds PMK-R0.
3622 */
3623 struct cfg80211_pmk_conf {
3624 const u8 *aa;
3625 u8 pmk_len;
3626 const u8 *pmk;
3627 const u8 *pmk_r0_name;
3628 };
3629
3630 /**
3631 * struct cfg80211_external_auth_params - Trigger External authentication.
3632 *
3633 * Commonly used across the external auth request and event interfaces.
3634 *
3635 * @action: action type / trigger for external authentication. Only significant
3636 * for the authentication request event interface (driver to user space).
3637 * @bssid: BSSID of the peer with which the authentication has
3638 * to happen. Used by both the authentication request event and
3639 * authentication response command interface.
3640 * @ssid: SSID of the AP. Used by both the authentication request event and
3641 * authentication response command interface.
3642 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3643 * authentication request event interface.
3644 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3645 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3646 * the real status code for failures. Used only for the authentication
3647 * response command interface (user space to driver).
3648 * @pmkid: The identifier to refer a PMKSA.
3649 */
3650 struct cfg80211_external_auth_params {
3651 enum nl80211_external_auth_action action;
3652 u8 bssid[ETH_ALEN] __aligned(2);
3653 struct cfg80211_ssid ssid;
3654 unsigned int key_mgmt_suite;
3655 u16 status;
3656 const u8 *pmkid;
3657 };
3658
3659 /**
3660 * struct cfg80211_ftm_responder_stats - FTM responder statistics
3661 *
3662 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3663 * indicate the relevant values in this struct for them
3664 * @success_num: number of FTM sessions in which all frames were successfully
3665 * answered
3666 * @partial_num: number of FTM sessions in which part of frames were
3667 * successfully answered
3668 * @failed_num: number of failed FTM sessions
3669 * @asap_num: number of ASAP FTM sessions
3670 * @non_asap_num: number of non-ASAP FTM sessions
3671 * @total_duration_ms: total sessions durations - gives an indication
3672 * of how much time the responder was busy
3673 * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3674 * initiators that didn't finish successfully the negotiation phase with
3675 * the responder
3676 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3677 * for a new scheduling although it already has scheduled FTM slot
3678 * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3679 */
3680 struct cfg80211_ftm_responder_stats {
3681 u32 filled;
3682 u32 success_num;
3683 u32 partial_num;
3684 u32 failed_num;
3685 u32 asap_num;
3686 u32 non_asap_num;
3687 u64 total_duration_ms;
3688 u32 unknown_triggers_num;
3689 u32 reschedule_requests_num;
3690 u32 out_of_window_triggers_num;
3691 };
3692
3693 /**
3694 * struct cfg80211_pmsr_ftm_result - FTM result
3695 * @failure_reason: if this measurement failed (PMSR status is
3696 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3697 * reason than just "failure"
3698 * @burst_index: if reporting partial results, this is the index
3699 * in [0 .. num_bursts-1] of the burst that's being reported
3700 * @num_ftmr_attempts: number of FTM request frames transmitted
3701 * @num_ftmr_successes: number of FTM request frames acked
3702 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3703 * fill this to indicate in how many seconds a retry is deemed possible
3704 * by the responder
3705 * @num_bursts_exp: actual number of bursts exponent negotiated
3706 * @burst_duration: actual burst duration negotiated
3707 * @ftms_per_burst: actual FTMs per burst negotiated
3708 * @lci_len: length of LCI information (if present)
3709 * @civicloc_len: length of civic location information (if present)
3710 * @lci: LCI data (may be %NULL)
3711 * @civicloc: civic location data (may be %NULL)
3712 * @rssi_avg: average RSSI over FTM action frames reported
3713 * @rssi_spread: spread of the RSSI over FTM action frames reported
3714 * @tx_rate: bitrate for transmitted FTM action frame response
3715 * @rx_rate: bitrate of received FTM action frame
3716 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3717 * @rtt_variance: variance of RTTs measured (note that standard deviation is
3718 * the square root of the variance)
3719 * @rtt_spread: spread of the RTTs measured
3720 * @dist_avg: average of distances (mm) measured
3721 * (must have either this or @rtt_avg)
3722 * @dist_variance: variance of distances measured (see also @rtt_variance)
3723 * @dist_spread: spread of distances measured (see also @rtt_spread)
3724 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3725 * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3726 * @rssi_avg_valid: @rssi_avg is valid
3727 * @rssi_spread_valid: @rssi_spread is valid
3728 * @tx_rate_valid: @tx_rate is valid
3729 * @rx_rate_valid: @rx_rate is valid
3730 * @rtt_avg_valid: @rtt_avg is valid
3731 * @rtt_variance_valid: @rtt_variance is valid
3732 * @rtt_spread_valid: @rtt_spread is valid
3733 * @dist_avg_valid: @dist_avg is valid
3734 * @dist_variance_valid: @dist_variance is valid
3735 * @dist_spread_valid: @dist_spread is valid
3736 */
3737 struct cfg80211_pmsr_ftm_result {
3738 const u8 *lci;
3739 const u8 *civicloc;
3740 unsigned int lci_len;
3741 unsigned int civicloc_len;
3742 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3743 u32 num_ftmr_attempts, num_ftmr_successes;
3744 s16 burst_index;
3745 u8 busy_retry_time;
3746 u8 num_bursts_exp;
3747 u8 burst_duration;
3748 u8 ftms_per_burst;
3749 s32 rssi_avg;
3750 s32 rssi_spread;
3751 struct rate_info tx_rate, rx_rate;
3752 s64 rtt_avg;
3753 s64 rtt_variance;
3754 s64 rtt_spread;
3755 s64 dist_avg;
3756 s64 dist_variance;
3757 s64 dist_spread;
3758
3759 u16 num_ftmr_attempts_valid:1,
3760 num_ftmr_successes_valid:1,
3761 rssi_avg_valid:1,
3762 rssi_spread_valid:1,
3763 tx_rate_valid:1,
3764 rx_rate_valid:1,
3765 rtt_avg_valid:1,
3766 rtt_variance_valid:1,
3767 rtt_spread_valid:1,
3768 dist_avg_valid:1,
3769 dist_variance_valid:1,
3770 dist_spread_valid:1;
3771
3772 ANDROID_KABI_RESERVE(1);
3773 };
3774
3775 /**
3776 * struct cfg80211_pmsr_result - peer measurement result
3777 * @addr: address of the peer
3778 * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3779 * measurement was made)
3780 * @ap_tsf: AP's TSF at measurement time
3781 * @status: status of the measurement
3782 * @final: if reporting partial results, mark this as the last one; if not
3783 * reporting partial results always set this flag
3784 * @ap_tsf_valid: indicates the @ap_tsf value is valid
3785 * @type: type of the measurement reported, note that we only support reporting
3786 * one type at a time, but you can report multiple results separately and
3787 * they're all aggregated for userspace.
3788 * @ftm: FTM result
3789 */
3790 struct cfg80211_pmsr_result {
3791 u64 host_time, ap_tsf;
3792 enum nl80211_peer_measurement_status status;
3793
3794 u8 addr[ETH_ALEN];
3795
3796 u8 final:1,
3797 ap_tsf_valid:1;
3798
3799 enum nl80211_peer_measurement_type type;
3800
3801 union {
3802 struct cfg80211_pmsr_ftm_result ftm;
3803 };
3804 };
3805
3806 /**
3807 * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3808 * @requested: indicates FTM is requested
3809 * @preamble: frame preamble to use
3810 * @burst_period: burst period to use
3811 * @asap: indicates to use ASAP mode
3812 * @num_bursts_exp: number of bursts exponent
3813 * @burst_duration: burst duration
3814 * @ftms_per_burst: number of FTMs per burst
3815 * @ftmr_retries: number of retries for FTM request
3816 * @request_lci: request LCI information
3817 * @request_civicloc: request civic location information
3818 * @trigger_based: use trigger based ranging for the measurement
3819 * If neither @trigger_based nor @non_trigger_based is set,
3820 * EDCA based ranging will be used.
3821 * @non_trigger_based: use non trigger based ranging for the measurement
3822 * If neither @trigger_based nor @non_trigger_based is set,
3823 * EDCA based ranging will be used.
3824 * @lmr_feedback: negotiate for I2R LMR feedback. Only valid if either
3825 * @trigger_based or @non_trigger_based is set.
3826 * @bss_color: the bss color of the responder. Optional. Set to zero to
3827 * indicate the driver should set the BSS color. Only valid if
3828 * @non_trigger_based or @trigger_based is set.
3829 *
3830 * See also nl80211 for the respective attribute documentation.
3831 */
3832 struct cfg80211_pmsr_ftm_request_peer {
3833 enum nl80211_preamble preamble;
3834 u16 burst_period;
3835 u8 requested:1,
3836 asap:1,
3837 request_lci:1,
3838 request_civicloc:1,
3839 trigger_based:1,
3840 non_trigger_based:1,
3841 lmr_feedback:1;
3842 u8 num_bursts_exp;
3843 u8 burst_duration;
3844 u8 ftms_per_burst;
3845 u8 ftmr_retries;
3846 u8 bss_color;
3847 };
3848
3849 /**
3850 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3851 * @addr: MAC address
3852 * @chandef: channel to use
3853 * @report_ap_tsf: report the associated AP's TSF
3854 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3855 */
3856 struct cfg80211_pmsr_request_peer {
3857 u8 addr[ETH_ALEN];
3858 struct cfg80211_chan_def chandef;
3859 u8 report_ap_tsf:1;
3860 struct cfg80211_pmsr_ftm_request_peer ftm;
3861 };
3862
3863 /**
3864 * struct cfg80211_pmsr_request - peer measurement request
3865 * @cookie: cookie, set by cfg80211
3866 * @nl_portid: netlink portid - used by cfg80211
3867 * @drv_data: driver data for this request, if required for aborting,
3868 * not otherwise freed or anything by cfg80211
3869 * @mac_addr: MAC address used for (randomised) request
3870 * @mac_addr_mask: MAC address mask used for randomisation, bits that
3871 * are 0 in the mask should be randomised, bits that are 1 should
3872 * be taken from the @mac_addr
3873 * @list: used by cfg80211 to hold on to the request
3874 * @timeout: timeout (in milliseconds) for the whole operation, if
3875 * zero it means there's no timeout
3876 * @n_peers: number of peers to do measurements with
3877 * @peers: per-peer measurement request data
3878 */
3879 struct cfg80211_pmsr_request {
3880 u64 cookie;
3881 void *drv_data;
3882 u32 n_peers;
3883 u32 nl_portid;
3884
3885 u32 timeout;
3886
3887 u8 mac_addr[ETH_ALEN] __aligned(2);
3888 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3889
3890 struct list_head list;
3891
3892 struct cfg80211_pmsr_request_peer peers[];
3893 };
3894
3895 /**
3896 * struct cfg80211_update_owe_info - OWE Information
3897 *
3898 * This structure provides information needed for the drivers to offload OWE
3899 * (Opportunistic Wireless Encryption) processing to the user space.
3900 *
3901 * Commonly used across update_owe_info request and event interfaces.
3902 *
3903 * @peer: MAC address of the peer device for which the OWE processing
3904 * has to be done.
3905 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3906 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3907 * cannot give you the real status code for failures. Used only for
3908 * OWE update request command interface (user space to driver).
3909 * @ie: IEs obtained from the peer or constructed by the user space. These are
3910 * the IEs of the remote peer in the event from the host driver and
3911 * the constructed IEs by the user space in the request interface.
3912 * @ie_len: Length of IEs in octets.
3913 */
3914 struct cfg80211_update_owe_info {
3915 u8 peer[ETH_ALEN] __aligned(2);
3916 u16 status;
3917 const u8 *ie;
3918 size_t ie_len;
3919 };
3920
3921 /**
3922 * struct mgmt_frame_regs - management frame registrations data
3923 * @global_stypes: bitmap of management frame subtypes registered
3924 * for the entire device
3925 * @interface_stypes: bitmap of management frame subtypes registered
3926 * for the given interface
3927 * @global_mcast_stypes: mcast RX is needed globally for these subtypes
3928 * @interface_mcast_stypes: mcast RX is needed on this interface
3929 * for these subtypes
3930 */
3931 struct mgmt_frame_regs {
3932 u32 global_stypes, interface_stypes;
3933 u32 global_mcast_stypes, interface_mcast_stypes;
3934 };
3935
3936 /**
3937 * struct cfg80211_ops - backend description for wireless configuration
3938 *
3939 * This struct is registered by fullmac card drivers and/or wireless stacks
3940 * in order to handle configuration requests on their interfaces.
3941 *
3942 * All callbacks except where otherwise noted should return 0
3943 * on success or a negative error code.
3944 *
3945 * All operations are invoked with the wiphy mutex held. The RTNL may be
3946 * held in addition (due to wireless extensions) but this cannot be relied
3947 * upon except in cases where documented below. Note that due to ordering,
3948 * the RTNL also cannot be acquired in any handlers.
3949 *
3950 * @suspend: wiphy device needs to be suspended. The variable @wow will
3951 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
3952 * configured for the device.
3953 * @resume: wiphy device needs to be resumed
3954 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3955 * to call device_set_wakeup_enable() to enable/disable wakeup from
3956 * the device.
3957 *
3958 * @add_virtual_intf: create a new virtual interface with the given name,
3959 * must set the struct wireless_dev's iftype. Beware: You must create
3960 * the new netdev in the wiphy's network namespace! Returns the struct
3961 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3962 * also set the address member in the wdev.
3963 * This additionally holds the RTNL to be able to do netdev changes.
3964 *
3965 * @del_virtual_intf: remove the virtual interface
3966 * This additionally holds the RTNL to be able to do netdev changes.
3967 *
3968 * @change_virtual_intf: change type/configuration of virtual interface,
3969 * keep the struct wireless_dev's iftype updated.
3970 * This additionally holds the RTNL to be able to do netdev changes.
3971 *
3972 * @add_intf_link: Add a new MLO link to the given interface. Note that
3973 * the wdev->link[] data structure has been updated, so the new link
3974 * address is available.
3975 * @del_intf_link: Remove an MLO link from the given interface.
3976 *
3977 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3978 * when adding a group key. @link_id will be -1 for non-MLO connection.
3979 * For MLO connection, @link_id will be >= 0 for group key and -1 for
3980 * pairwise key, @mac_addr will be peer's MLD address for MLO pairwise key.
3981 *
3982 * @get_key: get information about the key with the given parameters.
3983 * @mac_addr will be %NULL when requesting information for a group
3984 * key. All pointers given to the @callback function need not be valid
3985 * after it returns. This function should return an error if it is
3986 * not possible to retrieve the key, -ENOENT if it doesn't exist.
3987 * @link_id will be -1 for non-MLO connection. For MLO connection,
3988 * @link_id will be >= 0 for group key and -1 for pairwise key, @mac_addr
3989 * will be peer's MLD address for MLO pairwise key.
3990 *
3991 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3992 * and @key_index, return -ENOENT if the key doesn't exist. @link_id will
3993 * be -1 for non-MLO connection. For MLO connection, @link_id will be >= 0
3994 * for group key and -1 for pairwise key, @mac_addr will be peer's MLD
3995 * address for MLO pairwise key.
3996 *
3997 * @set_default_key: set the default key on an interface. @link_id will be >= 0
3998 * for MLO connection and -1 for non-MLO connection.
3999 *
4000 * @set_default_mgmt_key: set the default management frame key on an interface.
4001 * @link_id will be >= 0 for MLO connection and -1 for non-MLO connection.
4002 *
4003 * @set_default_beacon_key: set the default Beacon frame key on an interface.
4004 * @link_id will be >= 0 for MLO connection and -1 for non-MLO connection.
4005 *
4006 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
4007 *
4008 * @start_ap: Start acting in AP mode defined by the parameters.
4009 * @change_beacon: Change the beacon parameters for an access point mode
4010 * interface. This should reject the call when AP mode wasn't started.
4011 * @stop_ap: Stop being an AP, including stopping beaconing.
4012 *
4013 * @add_station: Add a new station.
4014 * @del_station: Remove a station
4015 * @change_station: Modify a given station. Note that flags changes are not much
4016 * validated in cfg80211, in particular the auth/assoc/authorized flags
4017 * might come to the driver in invalid combinations -- make sure to check
4018 * them, also against the existing state! Drivers must call
4019 * cfg80211_check_station_change() to validate the information.
4020 * @get_station: get station information for the station identified by @mac
4021 * @dump_station: dump station callback -- resume dump at index @idx
4022 *
4023 * @add_mpath: add a fixed mesh path
4024 * @del_mpath: delete a given mesh path
4025 * @change_mpath: change a given mesh path
4026 * @get_mpath: get a mesh path for the given parameters
4027 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
4028 * @get_mpp: get a mesh proxy path for the given parameters
4029 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
4030 * @join_mesh: join the mesh network with the specified parameters
4031 * (invoked with the wireless_dev mutex held)
4032 * @leave_mesh: leave the current mesh network
4033 * (invoked with the wireless_dev mutex held)
4034 *
4035 * @get_mesh_config: Get the current mesh configuration
4036 *
4037 * @update_mesh_config: Update mesh parameters on a running mesh.
4038 * The mask is a bitfield which tells us which parameters to
4039 * set, and which to leave alone.
4040 *
4041 * @change_bss: Modify parameters for a given BSS.
4042 *
4043 * @set_txq_params: Set TX queue parameters
4044 *
4045 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
4046 * as it doesn't implement join_mesh and needs to set the channel to
4047 * join the mesh instead.
4048 *
4049 * @set_monitor_channel: Set the monitor mode channel for the device. If other
4050 * interfaces are active this callback should reject the configuration.
4051 * If no interfaces are active or the device is down, the channel should
4052 * be stored for when a monitor interface becomes active.
4053 *
4054 * @scan: Request to do a scan. If returning zero, the scan request is given
4055 * the driver, and will be valid until passed to cfg80211_scan_done().
4056 * For scan results, call cfg80211_inform_bss(); you can call this outside
4057 * the scan/scan_done bracket too.
4058 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
4059 * indicate the status of the scan through cfg80211_scan_done().
4060 *
4061 * @auth: Request to authenticate with the specified peer
4062 * (invoked with the wireless_dev mutex held)
4063 * @assoc: Request to (re)associate with the specified peer
4064 * (invoked with the wireless_dev mutex held)
4065 * @deauth: Request to deauthenticate from the specified peer
4066 * (invoked with the wireless_dev mutex held)
4067 * @disassoc: Request to disassociate from the specified peer
4068 * (invoked with the wireless_dev mutex held)
4069 *
4070 * @connect: Connect to the ESS with the specified parameters. When connected,
4071 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
4072 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
4073 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
4074 * from the AP or cfg80211_connect_timeout() if no frame with status code
4075 * was received.
4076 * The driver is allowed to roam to other BSSes within the ESS when the
4077 * other BSS matches the connect parameters. When such roaming is initiated
4078 * by the driver, the driver is expected to verify that the target matches
4079 * the configured security parameters and to use Reassociation Request
4080 * frame instead of Association Request frame.
4081 * The connect function can also be used to request the driver to perform a
4082 * specific roam when connected to an ESS. In that case, the prev_bssid
4083 * parameter is set to the BSSID of the currently associated BSS as an
4084 * indication of requesting reassociation.
4085 * In both the driver-initiated and new connect() call initiated roaming
4086 * cases, the result of roaming is indicated with a call to
4087 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
4088 * @update_connect_params: Update the connect parameters while connected to a
4089 * BSS. The updated parameters can be used by driver/firmware for
4090 * subsequent BSS selection (roaming) decisions and to form the
4091 * Authentication/(Re)Association Request frames. This call does not
4092 * request an immediate disassociation or reassociation with the current
4093 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
4094 * changed are defined in &enum cfg80211_connect_params_changed.
4095 * (invoked with the wireless_dev mutex held)
4096 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
4097 * connection is in progress. Once done, call cfg80211_disconnected() in
4098 * case connection was already established (invoked with the
4099 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
4100 *
4101 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
4102 * cfg80211_ibss_joined(), also call that function when changing BSSID due
4103 * to a merge.
4104 * (invoked with the wireless_dev mutex held)
4105 * @leave_ibss: Leave the IBSS.
4106 * (invoked with the wireless_dev mutex held)
4107 *
4108 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
4109 * MESH mode)
4110 *
4111 * @set_wiphy_params: Notify that wiphy parameters have changed;
4112 * @changed bitfield (see &enum wiphy_params_flags) describes which values
4113 * have changed. The actual parameter values are available in
4114 * struct wiphy. If returning an error, no value should be changed.
4115 *
4116 * @set_tx_power: set the transmit power according to the parameters,
4117 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
4118 * wdev may be %NULL if power was set for the wiphy, and will
4119 * always be %NULL unless the driver supports per-vif TX power
4120 * (as advertised by the nl80211 feature flag.)
4121 * @get_tx_power: store the current TX power into the dbm variable;
4122 * return 0 if successful
4123 *
4124 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
4125 * functions to adjust rfkill hw state
4126 *
4127 * @dump_survey: get site survey information.
4128 *
4129 * @remain_on_channel: Request the driver to remain awake on the specified
4130 * channel for the specified duration to complete an off-channel
4131 * operation (e.g., public action frame exchange). When the driver is
4132 * ready on the requested channel, it must indicate this with an event
4133 * notification by calling cfg80211_ready_on_channel().
4134 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
4135 * This allows the operation to be terminated prior to timeout based on
4136 * the duration value.
4137 * @mgmt_tx: Transmit a management frame.
4138 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
4139 * frame on another channel
4140 *
4141 * @testmode_cmd: run a test mode command; @wdev may be %NULL
4142 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
4143 * used by the function, but 0 and 1 must not be touched. Additionally,
4144 * return error codes other than -ENOBUFS and -ENOENT will terminate the
4145 * dump and return to userspace with an error, so be careful. If any data
4146 * was passed in from userspace then the data/len arguments will be present
4147 * and point to the data contained in %NL80211_ATTR_TESTDATA.
4148 *
4149 * @set_bitrate_mask: set the bitrate mask configuration
4150 *
4151 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
4152 * devices running firmwares capable of generating the (re) association
4153 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
4154 * @del_pmksa: Delete a cached PMKID.
4155 * @flush_pmksa: Flush all cached PMKIDs.
4156 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
4157 * allows the driver to adjust the dynamic ps timeout value.
4158 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
4159 * After configuration, the driver should (soon) send an event indicating
4160 * the current level is above/below the configured threshold; this may
4161 * need some care when the configuration is changed (without first being
4162 * disabled.)
4163 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
4164 * connection quality monitor. An event is to be sent only when the
4165 * signal level is found to be outside the two values. The driver should
4166 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
4167 * If it is provided then there's no point providing @set_cqm_rssi_config.
4168 * @set_cqm_txe_config: Configure connection quality monitor TX error
4169 * thresholds.
4170 * @sched_scan_start: Tell the driver to start a scheduled scan.
4171 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
4172 * given request id. This call must stop the scheduled scan and be ready
4173 * for starting a new one before it returns, i.e. @sched_scan_start may be
4174 * called immediately after that again and should not fail in that case.
4175 * The driver should not call cfg80211_sched_scan_stopped() for a requested
4176 * stop (when this method returns 0).
4177 *
4178 * @update_mgmt_frame_registrations: Notify the driver that management frame
4179 * registrations were updated. The callback is allowed to sleep.
4180 *
4181 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
4182 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
4183 * reject TX/RX mask combinations they cannot support by returning -EINVAL
4184 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
4185 *
4186 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
4187 *
4188 * @tdls_mgmt: Transmit a TDLS management frame.
4189 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
4190 *
4191 * @probe_client: probe an associated client, must return a cookie that it
4192 * later passes to cfg80211_probe_status().
4193 *
4194 * @set_noack_map: Set the NoAck Map for the TIDs.
4195 *
4196 * @get_channel: Get the current operating channel for the virtual interface.
4197 * For monitor interfaces, it should return %NULL unless there's a single
4198 * current monitoring channel.
4199 *
4200 * @start_p2p_device: Start the given P2P device.
4201 * @stop_p2p_device: Stop the given P2P device.
4202 *
4203 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
4204 * Parameters include ACL policy, an array of MAC address of stations
4205 * and the number of MAC addresses. If there is already a list in driver
4206 * this new list replaces the existing one. Driver has to clear its ACL
4207 * when number of MAC addresses entries is passed as 0. Drivers which
4208 * advertise the support for MAC based ACL have to implement this callback.
4209 *
4210 * @start_radar_detection: Start radar detection in the driver.
4211 *
4212 * @end_cac: End running CAC, probably because a related CAC
4213 * was finished on another phy.
4214 *
4215 * @update_ft_ies: Provide updated Fast BSS Transition information to the
4216 * driver. If the SME is in the driver/firmware, this information can be
4217 * used in building Authentication and Reassociation Request frames.
4218 *
4219 * @crit_proto_start: Indicates a critical protocol needs more link reliability
4220 * for a given duration (milliseconds). The protocol is provided so the
4221 * driver can take the most appropriate actions.
4222 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
4223 * reliability. This operation can not fail.
4224 * @set_coalesce: Set coalesce parameters.
4225 *
4226 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
4227 * responsible for veryfing if the switch is possible. Since this is
4228 * inherently tricky driver may decide to disconnect an interface later
4229 * with cfg80211_stop_iface(). This doesn't mean driver can accept
4230 * everything. It should do it's best to verify requests and reject them
4231 * as soon as possible.
4232 *
4233 * @set_qos_map: Set QoS mapping information to the driver
4234 *
4235 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
4236 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
4237 * changes during the lifetime of the BSS.
4238 *
4239 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
4240 * with the given parameters; action frame exchange has been handled by
4241 * userspace so this just has to modify the TX path to take the TS into
4242 * account.
4243 * If the admitted time is 0 just validate the parameters to make sure
4244 * the session can be created at all; it is valid to just always return
4245 * success for that but that may result in inefficient behaviour (handshake
4246 * with the peer followed by immediate teardown when the addition is later
4247 * rejected)
4248 * @del_tx_ts: remove an existing TX TS
4249 *
4250 * @join_ocb: join the OCB network with the specified parameters
4251 * (invoked with the wireless_dev mutex held)
4252 * @leave_ocb: leave the current OCB network
4253 * (invoked with the wireless_dev mutex held)
4254 *
4255 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
4256 * is responsible for continually initiating channel-switching operations
4257 * and returning to the base channel for communication with the AP.
4258 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
4259 * peers must be on the base channel when the call completes.
4260 * @start_nan: Start the NAN interface.
4261 * @stop_nan: Stop the NAN interface.
4262 * @add_nan_func: Add a NAN function. Returns negative value on failure.
4263 * On success @nan_func ownership is transferred to the driver and
4264 * it may access it outside of the scope of this function. The driver
4265 * should free the @nan_func when no longer needed by calling
4266 * cfg80211_free_nan_func().
4267 * On success the driver should assign an instance_id in the
4268 * provided @nan_func.
4269 * @del_nan_func: Delete a NAN function.
4270 * @nan_change_conf: changes NAN configuration. The changed parameters must
4271 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
4272 * All other parameters must be ignored.
4273 *
4274 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
4275 *
4276 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
4277 * function should return phy stats, and interface stats otherwise.
4278 *
4279 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
4280 * If not deleted through @del_pmk the PMK remains valid until disconnect
4281 * upon which the driver should clear it.
4282 * (invoked with the wireless_dev mutex held)
4283 * @del_pmk: delete the previously configured PMK for the given authenticator.
4284 * (invoked with the wireless_dev mutex held)
4285 *
4286 * @external_auth: indicates result of offloaded authentication processing from
4287 * user space
4288 *
4289 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
4290 * tells the driver that the frame should not be encrypted.
4291 *
4292 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
4293 * Statistics should be cumulative, currently no way to reset is provided.
4294 * @start_pmsr: start peer measurement (e.g. FTM)
4295 * @abort_pmsr: abort peer measurement
4296 *
4297 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
4298 * but offloading OWE processing to the user space will get the updated
4299 * DH IE through this interface.
4300 *
4301 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
4302 * and overrule HWMP path selection algorithm.
4303 * @set_tid_config: TID specific configuration, this can be peer or BSS specific
4304 * This callback may sleep.
4305 * @reset_tid_config: Reset TID specific configuration for the peer, for the
4306 * given TIDs. This callback may sleep.
4307 *
4308 * @set_sar_specs: Update the SAR (TX power) settings.
4309 *
4310 * @color_change: Initiate a color change.
4311 *
4312 * @set_fils_aad: Set FILS AAD data to the AP driver so that the driver can use
4313 * those to decrypt (Re)Association Request and encrypt (Re)Association
4314 * Response frame.
4315 *
4316 * @set_radar_background: Configure dedicated offchannel chain available for
4317 * radar/CAC detection on some hw. This chain can't be used to transmit
4318 * or receive frames and it is bounded to a running wdev.
4319 * Background radar/CAC detection allows to avoid the CAC downtime
4320 * switching to a different channel during CAC detection on the selected
4321 * radar channel.
4322 * The caller is expected to set chandef pointer to NULL in order to
4323 * disable background CAC/radar detection.
4324 * @add_link_station: Add a link to a station.
4325 * @mod_link_station: Modify a link of a station.
4326 * @del_link_station: Remove a link of a station.
4327 */
4328 struct cfg80211_ops {
4329 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
4330 int (*resume)(struct wiphy *wiphy);
4331 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
4332
4333 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
4334 const char *name,
4335 unsigned char name_assign_type,
4336 enum nl80211_iftype type,
4337 struct vif_params *params);
4338 int (*del_virtual_intf)(struct wiphy *wiphy,
4339 struct wireless_dev *wdev);
4340 int (*change_virtual_intf)(struct wiphy *wiphy,
4341 struct net_device *dev,
4342 enum nl80211_iftype type,
4343 struct vif_params *params);
4344
4345 int (*add_intf_link)(struct wiphy *wiphy,
4346 struct wireless_dev *wdev,
4347 unsigned int link_id);
4348 void (*del_intf_link)(struct wiphy *wiphy,
4349 struct wireless_dev *wdev,
4350 unsigned int link_id);
4351
4352 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
4353 int link_id, u8 key_index, bool pairwise,
4354 const u8 *mac_addr, struct key_params *params);
4355 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
4356 int link_id, u8 key_index, bool pairwise,
4357 const u8 *mac_addr, void *cookie,
4358 void (*callback)(void *cookie, struct key_params*));
4359 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
4360 int link_id, u8 key_index, bool pairwise,
4361 const u8 *mac_addr);
4362 int (*set_default_key)(struct wiphy *wiphy,
4363 struct net_device *netdev, int link_id,
4364 u8 key_index, bool unicast, bool multicast);
4365 int (*set_default_mgmt_key)(struct wiphy *wiphy,
4366 struct net_device *netdev, int link_id,
4367 u8 key_index);
4368 int (*set_default_beacon_key)(struct wiphy *wiphy,
4369 struct net_device *netdev,
4370 int link_id,
4371 u8 key_index);
4372
4373 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
4374 struct cfg80211_ap_settings *settings);
4375 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
4376 struct cfg80211_beacon_data *info);
4377 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev,
4378 unsigned int link_id);
4379
4380
4381 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
4382 const u8 *mac,
4383 struct station_parameters *params);
4384 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
4385 struct station_del_parameters *params);
4386 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
4387 const u8 *mac,
4388 struct station_parameters *params);
4389 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
4390 const u8 *mac, struct station_info *sinfo);
4391 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
4392 int idx, u8 *mac, struct station_info *sinfo);
4393
4394 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
4395 const u8 *dst, const u8 *next_hop);
4396 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
4397 const u8 *dst);
4398 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
4399 const u8 *dst, const u8 *next_hop);
4400 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
4401 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
4402 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
4403 int idx, u8 *dst, u8 *next_hop,
4404 struct mpath_info *pinfo);
4405 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
4406 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
4407 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
4408 int idx, u8 *dst, u8 *mpp,
4409 struct mpath_info *pinfo);
4410 int (*get_mesh_config)(struct wiphy *wiphy,
4411 struct net_device *dev,
4412 struct mesh_config *conf);
4413 int (*update_mesh_config)(struct wiphy *wiphy,
4414 struct net_device *dev, u32 mask,
4415 const struct mesh_config *nconf);
4416 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
4417 const struct mesh_config *conf,
4418 const struct mesh_setup *setup);
4419 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
4420
4421 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
4422 struct ocb_setup *setup);
4423 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
4424
4425 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
4426 struct bss_parameters *params);
4427
4428 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
4429 struct ieee80211_txq_params *params);
4430
4431 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
4432 struct net_device *dev,
4433 struct ieee80211_channel *chan);
4434
4435 int (*set_monitor_channel)(struct wiphy *wiphy,
4436 struct cfg80211_chan_def *chandef);
4437
4438 int (*scan)(struct wiphy *wiphy,
4439 struct cfg80211_scan_request *request);
4440 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4441
4442 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
4443 struct cfg80211_auth_request *req);
4444 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
4445 struct cfg80211_assoc_request *req);
4446 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
4447 struct cfg80211_deauth_request *req);
4448 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
4449 struct cfg80211_disassoc_request *req);
4450
4451 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
4452 struct cfg80211_connect_params *sme);
4453 int (*update_connect_params)(struct wiphy *wiphy,
4454 struct net_device *dev,
4455 struct cfg80211_connect_params *sme,
4456 u32 changed);
4457 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
4458 u16 reason_code);
4459
4460 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
4461 struct cfg80211_ibss_params *params);
4462 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
4463
4464 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
4465 int rate[NUM_NL80211_BANDS]);
4466
4467 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
4468
4469 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4470 enum nl80211_tx_power_setting type, int mbm);
4471 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
4472 int *dbm);
4473
4474 void (*rfkill_poll)(struct wiphy *wiphy);
4475
4476 #ifdef CONFIG_NL80211_TESTMODE
4477 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
4478 void *data, int len);
4479 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
4480 struct netlink_callback *cb,
4481 void *data, int len);
4482 #endif
4483
4484 int (*set_bitrate_mask)(struct wiphy *wiphy,
4485 struct net_device *dev,
4486 unsigned int link_id,
4487 const u8 *peer,
4488 const struct cfg80211_bitrate_mask *mask);
4489
4490 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
4491 int idx, struct survey_info *info);
4492
4493 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4494 struct cfg80211_pmksa *pmksa);
4495 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
4496 struct cfg80211_pmksa *pmksa);
4497 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
4498
4499 int (*remain_on_channel)(struct wiphy *wiphy,
4500 struct wireless_dev *wdev,
4501 struct ieee80211_channel *chan,
4502 unsigned int duration,
4503 u64 *cookie);
4504 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
4505 struct wireless_dev *wdev,
4506 u64 cookie);
4507
4508 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
4509 struct cfg80211_mgmt_tx_params *params,
4510 u64 *cookie);
4511 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
4512 struct wireless_dev *wdev,
4513 u64 cookie);
4514
4515 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4516 bool enabled, int timeout);
4517
4518 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
4519 struct net_device *dev,
4520 s32 rssi_thold, u32 rssi_hyst);
4521
4522 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
4523 struct net_device *dev,
4524 s32 rssi_low, s32 rssi_high);
4525
4526 int (*set_cqm_txe_config)(struct wiphy *wiphy,
4527 struct net_device *dev,
4528 u32 rate, u32 pkts, u32 intvl);
4529
4530 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy,
4531 struct wireless_dev *wdev,
4532 struct mgmt_frame_regs *upd);
4533
4534 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
4535 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
4536
4537 int (*sched_scan_start)(struct wiphy *wiphy,
4538 struct net_device *dev,
4539 struct cfg80211_sched_scan_request *request);
4540 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
4541 u64 reqid);
4542
4543 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
4544 struct cfg80211_gtk_rekey_data *data);
4545
4546 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
4547 const u8 *peer, u8 action_code, u8 dialog_token,
4548 u16 status_code, u32 peer_capability,
4549 bool initiator, const u8 *buf, size_t len);
4550 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
4551 const u8 *peer, enum nl80211_tdls_operation oper);
4552
4553 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
4554 const u8 *peer, u64 *cookie);
4555
4556 int (*set_noack_map)(struct wiphy *wiphy,
4557 struct net_device *dev,
4558 u16 noack_map);
4559
4560 int (*get_channel)(struct wiphy *wiphy,
4561 struct wireless_dev *wdev,
4562 unsigned int link_id,
4563 struct cfg80211_chan_def *chandef);
4564
4565 int (*start_p2p_device)(struct wiphy *wiphy,
4566 struct wireless_dev *wdev);
4567 void (*stop_p2p_device)(struct wiphy *wiphy,
4568 struct wireless_dev *wdev);
4569
4570 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
4571 const struct cfg80211_acl_data *params);
4572
4573 int (*start_radar_detection)(struct wiphy *wiphy,
4574 struct net_device *dev,
4575 struct cfg80211_chan_def *chandef,
4576 u32 cac_time_ms);
4577 void (*end_cac)(struct wiphy *wiphy,
4578 struct net_device *dev);
4579 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
4580 struct cfg80211_update_ft_ies_params *ftie);
4581 int (*crit_proto_start)(struct wiphy *wiphy,
4582 struct wireless_dev *wdev,
4583 enum nl80211_crit_proto_id protocol,
4584 u16 duration);
4585 void (*crit_proto_stop)(struct wiphy *wiphy,
4586 struct wireless_dev *wdev);
4587 int (*set_coalesce)(struct wiphy *wiphy,
4588 struct cfg80211_coalesce *coalesce);
4589
4590 int (*channel_switch)(struct wiphy *wiphy,
4591 struct net_device *dev,
4592 struct cfg80211_csa_settings *params);
4593
4594 int (*set_qos_map)(struct wiphy *wiphy,
4595 struct net_device *dev,
4596 struct cfg80211_qos_map *qos_map);
4597
4598 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
4599 unsigned int link_id,
4600 struct cfg80211_chan_def *chandef);
4601
4602 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4603 u8 tsid, const u8 *peer, u8 user_prio,
4604 u16 admitted_time);
4605 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
4606 u8 tsid, const u8 *peer);
4607
4608 int (*tdls_channel_switch)(struct wiphy *wiphy,
4609 struct net_device *dev,
4610 const u8 *addr, u8 oper_class,
4611 struct cfg80211_chan_def *chandef);
4612 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
4613 struct net_device *dev,
4614 const u8 *addr);
4615 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
4616 struct cfg80211_nan_conf *conf);
4617 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
4618 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4619 struct cfg80211_nan_func *nan_func);
4620 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
4621 u64 cookie);
4622 int (*nan_change_conf)(struct wiphy *wiphy,
4623 struct wireless_dev *wdev,
4624 struct cfg80211_nan_conf *conf,
4625 u32 changes);
4626
4627 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
4628 struct net_device *dev,
4629 const bool enabled);
4630
4631 int (*get_txq_stats)(struct wiphy *wiphy,
4632 struct wireless_dev *wdev,
4633 struct cfg80211_txq_stats *txqstats);
4634
4635 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
4636 const struct cfg80211_pmk_conf *conf);
4637 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
4638 const u8 *aa);
4639 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
4640 struct cfg80211_external_auth_params *params);
4641
4642 int (*tx_control_port)(struct wiphy *wiphy,
4643 struct net_device *dev,
4644 const u8 *buf, size_t len,
4645 const u8 *dest, const __be16 proto,
4646 const bool noencrypt, int link_id,
4647 u64 *cookie);
4648
4649 int (*get_ftm_responder_stats)(struct wiphy *wiphy,
4650 struct net_device *dev,
4651 struct cfg80211_ftm_responder_stats *ftm_stats);
4652
4653 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4654 struct cfg80211_pmsr_request *request);
4655 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
4656 struct cfg80211_pmsr_request *request);
4657 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
4658 struct cfg80211_update_owe_info *owe_info);
4659 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
4660 const u8 *buf, size_t len);
4661 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4662 struct cfg80211_tid_config *tid_conf);
4663 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev,
4664 const u8 *peer, u8 tids);
4665 int (*set_sar_specs)(struct wiphy *wiphy,
4666 struct cfg80211_sar_specs *sar);
4667 int (*color_change)(struct wiphy *wiphy,
4668 struct net_device *dev,
4669 struct cfg80211_color_change_settings *params);
4670 int (*set_fils_aad)(struct wiphy *wiphy, struct net_device *dev,
4671 struct cfg80211_fils_aad *fils_aad);
4672 int (*set_radar_background)(struct wiphy *wiphy,
4673 struct cfg80211_chan_def *chandef);
4674 int (*add_link_station)(struct wiphy *wiphy, struct net_device *dev,
4675 struct link_station_parameters *params);
4676 int (*mod_link_station)(struct wiphy *wiphy, struct net_device *dev,
4677 struct link_station_parameters *params);
4678 int (*del_link_station)(struct wiphy *wiphy, struct net_device *dev,
4679 struct link_station_del_parameters *params);
4680
4681 ANDROID_KABI_RESERVE(1);
4682 ANDROID_KABI_RESERVE(2);
4683 ANDROID_KABI_RESERVE(3);
4684 ANDROID_KABI_RESERVE(4);
4685 };
4686
4687 /*
4688 * wireless hardware and networking interfaces structures
4689 * and registration/helper functions
4690 */
4691
4692 /**
4693 * enum wiphy_flags - wiphy capability flags
4694 *
4695 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split
4696 * into two, first for legacy bands and second for UHB.
4697 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
4698 * wiphy at all
4699 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
4700 * by default -- this flag will be set depending on the kernel's default
4701 * on wiphy_new(), but can be changed by the driver if it has a good
4702 * reason to override the default
4703 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
4704 * on a VLAN interface). This flag also serves an extra purpose of
4705 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
4706 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
4707 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
4708 * control port protocol ethertype. The device also honours the
4709 * control_port_no_encrypt flag.
4710 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
4711 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
4712 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
4713 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
4714 * firmware.
4715 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
4716 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
4717 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
4718 * link setup/discovery operations internally. Setup, discovery and
4719 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
4720 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
4721 * used for asking the driver/firmware to perform a TDLS operation.
4722 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
4723 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
4724 * when there are virtual interfaces in AP mode by calling
4725 * cfg80211_report_obss_beacon().
4726 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
4727 * responds to probe-requests in hardware.
4728 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
4729 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
4730 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
4731 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
4732 * beaconing mode (AP, IBSS, Mesh, ...).
4733 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
4734 * before connection.
4735 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys
4736 * @WIPHY_FLAG_SUPPORTS_MLO: This is a temporary flag gating the MLO APIs,
4737 * in order to not have them reachable in normal drivers, until we have
4738 * complete feature/interface combinations/etc. advertisement. No driver
4739 * should set this flag for now.
4740 */
4741 enum wiphy_flags {
4742 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK = BIT(0),
4743 WIPHY_FLAG_SUPPORTS_MLO = BIT(1),
4744 WIPHY_FLAG_SPLIT_SCAN_6GHZ = BIT(2),
4745 WIPHY_FLAG_NETNS_OK = BIT(3),
4746 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
4747 WIPHY_FLAG_4ADDR_AP = BIT(5),
4748 WIPHY_FLAG_4ADDR_STATION = BIT(6),
4749 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
4750 WIPHY_FLAG_IBSS_RSN = BIT(8),
4751 WIPHY_FLAG_MESH_AUTH = BIT(10),
4752 /* use hole at 11 */
4753 /* use hole at 12 */
4754 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
4755 WIPHY_FLAG_AP_UAPSD = BIT(14),
4756 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
4757 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
4758 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
4759 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
4760 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
4761 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
4762 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
4763 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
4764 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
4765 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
4766 };
4767
4768 /**
4769 * struct ieee80211_iface_limit - limit on certain interface types
4770 * @max: maximum number of interfaces of these types
4771 * @types: interface types (bits)
4772 */
4773 struct ieee80211_iface_limit {
4774 u16 max;
4775 u16 types;
4776 };
4777
4778 /**
4779 * struct ieee80211_iface_combination - possible interface combination
4780 *
4781 * With this structure the driver can describe which interface
4782 * combinations it supports concurrently.
4783 *
4784 * Examples:
4785 *
4786 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4787 *
4788 * .. code-block:: c
4789 *
4790 * struct ieee80211_iface_limit limits1[] = {
4791 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4792 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4793 * };
4794 * struct ieee80211_iface_combination combination1 = {
4795 * .limits = limits1,
4796 * .n_limits = ARRAY_SIZE(limits1),
4797 * .max_interfaces = 2,
4798 * .beacon_int_infra_match = true,
4799 * };
4800 *
4801 *
4802 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4803 *
4804 * .. code-block:: c
4805 *
4806 * struct ieee80211_iface_limit limits2[] = {
4807 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4808 * BIT(NL80211_IFTYPE_P2P_GO), },
4809 * };
4810 * struct ieee80211_iface_combination combination2 = {
4811 * .limits = limits2,
4812 * .n_limits = ARRAY_SIZE(limits2),
4813 * .max_interfaces = 8,
4814 * .num_different_channels = 1,
4815 * };
4816 *
4817 *
4818 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4819 *
4820 * This allows for an infrastructure connection and three P2P connections.
4821 *
4822 * .. code-block:: c
4823 *
4824 * struct ieee80211_iface_limit limits3[] = {
4825 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4826 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4827 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
4828 * };
4829 * struct ieee80211_iface_combination combination3 = {
4830 * .limits = limits3,
4831 * .n_limits = ARRAY_SIZE(limits3),
4832 * .max_interfaces = 4,
4833 * .num_different_channels = 2,
4834 * };
4835 *
4836 */
4837 struct ieee80211_iface_combination {
4838 /**
4839 * @limits:
4840 * limits for the given interface types
4841 */
4842 const struct ieee80211_iface_limit *limits;
4843
4844 /**
4845 * @num_different_channels:
4846 * can use up to this many different channels
4847 */
4848 u32 num_different_channels;
4849
4850 /**
4851 * @max_interfaces:
4852 * maximum number of interfaces in total allowed in this group
4853 */
4854 u16 max_interfaces;
4855
4856 /**
4857 * @n_limits:
4858 * number of limitations
4859 */
4860 u8 n_limits;
4861
4862 /**
4863 * @beacon_int_infra_match:
4864 * In this combination, the beacon intervals between infrastructure
4865 * and AP types must match. This is required only in special cases.
4866 */
4867 bool beacon_int_infra_match;
4868
4869 /**
4870 * @radar_detect_widths:
4871 * bitmap of channel widths supported for radar detection
4872 */
4873 u8 radar_detect_widths;
4874
4875 /**
4876 * @radar_detect_regions:
4877 * bitmap of regions supported for radar detection
4878 */
4879 u8 radar_detect_regions;
4880
4881 /**
4882 * @beacon_int_min_gcd:
4883 * This interface combination supports different beacon intervals.
4884 *
4885 * = 0
4886 * all beacon intervals for different interface must be same.
4887 * > 0
4888 * any beacon interval for the interface part of this combination AND
4889 * GCD of all beacon intervals from beaconing interfaces of this
4890 * combination must be greater or equal to this value.
4891 */
4892 u32 beacon_int_min_gcd;
4893 };
4894
4895 struct ieee80211_txrx_stypes {
4896 u16 tx, rx;
4897 };
4898
4899 /**
4900 * enum wiphy_wowlan_support_flags - WoWLAN support flags
4901 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4902 * trigger that keeps the device operating as-is and
4903 * wakes up the host on any activity, for example a
4904 * received packet that passed filtering; note that the
4905 * packet should be preserved in that case
4906 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4907 * (see nl80211.h)
4908 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4909 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4910 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4911 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4912 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4913 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4914 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4915 */
4916 enum wiphy_wowlan_support_flags {
4917 WIPHY_WOWLAN_ANY = BIT(0),
4918 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
4919 WIPHY_WOWLAN_DISCONNECT = BIT(2),
4920 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4921 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
4922 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
4923 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
4924 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
4925 WIPHY_WOWLAN_NET_DETECT = BIT(8),
4926 };
4927
4928 struct wiphy_wowlan_tcp_support {
4929 const struct nl80211_wowlan_tcp_data_token_feature *tok;
4930 u32 data_payload_max;
4931 u32 data_interval_max;
4932 u32 wake_payload_max;
4933 bool seq;
4934 };
4935
4936 /**
4937 * struct wiphy_wowlan_support - WoWLAN support data
4938 * @flags: see &enum wiphy_wowlan_support_flags
4939 * @n_patterns: number of supported wakeup patterns
4940 * (see nl80211.h for the pattern definition)
4941 * @pattern_max_len: maximum length of each pattern
4942 * @pattern_min_len: minimum length of each pattern
4943 * @max_pkt_offset: maximum Rx packet offset
4944 * @max_nd_match_sets: maximum number of matchsets for net-detect,
4945 * similar, but not necessarily identical, to max_match_sets for
4946 * scheduled scans.
4947 * See &struct cfg80211_sched_scan_request.@match_sets for more
4948 * details.
4949 * @tcp: TCP wakeup support information
4950 */
4951 struct wiphy_wowlan_support {
4952 u32 flags;
4953 int n_patterns;
4954 int pattern_max_len;
4955 int pattern_min_len;
4956 int max_pkt_offset;
4957 int max_nd_match_sets;
4958 const struct wiphy_wowlan_tcp_support *tcp;
4959 };
4960
4961 /**
4962 * struct wiphy_coalesce_support - coalesce support data
4963 * @n_rules: maximum number of coalesce rules
4964 * @max_delay: maximum supported coalescing delay in msecs
4965 * @n_patterns: number of supported patterns in a rule
4966 * (see nl80211.h for the pattern definition)
4967 * @pattern_max_len: maximum length of each pattern
4968 * @pattern_min_len: minimum length of each pattern
4969 * @max_pkt_offset: maximum Rx packet offset
4970 */
4971 struct wiphy_coalesce_support {
4972 int n_rules;
4973 int max_delay;
4974 int n_patterns;
4975 int pattern_max_len;
4976 int pattern_min_len;
4977 int max_pkt_offset;
4978 };
4979
4980 /**
4981 * enum wiphy_vendor_command_flags - validation flags for vendor commands
4982 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4983 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4984 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4985 * (must be combined with %_WDEV or %_NETDEV)
4986 */
4987 enum wiphy_vendor_command_flags {
4988 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4989 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4990 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4991 };
4992
4993 /**
4994 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4995 *
4996 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4997 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4998 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4999 *
5000 */
5001 enum wiphy_opmode_flag {
5002 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
5003 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
5004 STA_OPMODE_N_SS_CHANGED = BIT(2),
5005 };
5006
5007 /**
5008 * struct sta_opmode_info - Station's ht/vht operation mode information
5009 * @changed: contains value from &enum wiphy_opmode_flag
5010 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
5011 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
5012 * @rx_nss: new rx_nss value of a station
5013 */
5014
5015 struct sta_opmode_info {
5016 u32 changed;
5017 enum nl80211_smps_mode smps_mode;
5018 enum nl80211_chan_width bw;
5019 u8 rx_nss;
5020 };
5021
5022 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
5023
5024 /**
5025 * struct wiphy_vendor_command - vendor command definition
5026 * @info: vendor command identifying information, as used in nl80211
5027 * @flags: flags, see &enum wiphy_vendor_command_flags
5028 * @doit: callback for the operation, note that wdev is %NULL if the
5029 * flags didn't ask for a wdev and non-%NULL otherwise; the data
5030 * pointer may be %NULL if userspace provided no data at all
5031 * @dumpit: dump callback, for transferring bigger/multiple items. The
5032 * @storage points to cb->args[5], ie. is preserved over the multiple
5033 * dumpit calls.
5034 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
5035 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
5036 * attribute is just raw data (e.g. a firmware command).
5037 * @maxattr: highest attribute number in policy
5038 * It's recommended to not have the same sub command with both @doit and
5039 * @dumpit, so that userspace can assume certain ones are get and others
5040 * are used with dump requests.
5041 */
5042 struct wiphy_vendor_command {
5043 struct nl80211_vendor_cmd_info info;
5044 u32 flags;
5045 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
5046 const void *data, int data_len);
5047 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
5048 struct sk_buff *skb, const void *data, int data_len,
5049 unsigned long *storage);
5050 const struct nla_policy *policy;
5051 unsigned int maxattr;
5052
5053 ANDROID_KABI_RESERVE(1);
5054 };
5055
5056 /**
5057 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
5058 * @iftype: interface type
5059 * @extended_capabilities: extended capabilities supported by the driver,
5060 * additional capabilities might be supported by userspace; these are the
5061 * 802.11 extended capabilities ("Extended Capabilities element") and are
5062 * in the same format as in the information element. See IEEE Std
5063 * 802.11-2012 8.4.2.29 for the defined fields.
5064 * @extended_capabilities_mask: mask of the valid values
5065 * @extended_capabilities_len: length of the extended capabilities
5066 * @eml_capabilities: EML capabilities (for MLO)
5067 * @mld_capa_and_ops: MLD capabilities and operations (for MLO)
5068 */
5069 struct wiphy_iftype_ext_capab {
5070 enum nl80211_iftype iftype;
5071 const u8 *extended_capabilities;
5072 const u8 *extended_capabilities_mask;
5073 u8 extended_capabilities_len;
5074 u16 eml_capabilities;
5075 u16 mld_capa_and_ops;
5076 };
5077
5078 /**
5079 * cfg80211_get_iftype_ext_capa - lookup interface type extended capability
5080 * @wiphy: the wiphy to look up from
5081 * @type: the interface type to look up
5082 */
5083 const struct wiphy_iftype_ext_capab *
5084 cfg80211_get_iftype_ext_capa(struct wiphy *wiphy, enum nl80211_iftype type);
5085
5086 /**
5087 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
5088 * @max_peers: maximum number of peers in a single measurement
5089 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
5090 * @randomize_mac_addr: can randomize MAC address for measurement
5091 * @ftm: FTM measurement data
5092 * @ftm.supported: FTM measurement is supported
5093 * @ftm.asap: ASAP-mode is supported
5094 * @ftm.non_asap: non-ASAP-mode is supported
5095 * @ftm.request_lci: can request LCI data
5096 * @ftm.request_civicloc: can request civic location data
5097 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
5098 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
5099 * @ftm.max_bursts_exponent: maximum burst exponent supported
5100 * (set to -1 if not limited; note that setting this will necessarily
5101 * forbid using the value 15 to let the responder pick)
5102 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
5103 * not limited)
5104 * @ftm.trigger_based: trigger based ranging measurement is supported
5105 * @ftm.non_trigger_based: non trigger based ranging measurement is supported
5106 */
5107 struct cfg80211_pmsr_capabilities {
5108 unsigned int max_peers;
5109 u8 report_ap_tsf:1,
5110 randomize_mac_addr:1;
5111
5112 struct {
5113 u32 preambles;
5114 u32 bandwidths;
5115 s8 max_bursts_exponent;
5116 u8 max_ftms_per_burst;
5117 u8 supported:1,
5118 asap:1,
5119 non_asap:1,
5120 request_lci:1,
5121 request_civicloc:1,
5122 trigger_based:1,
5123 non_trigger_based:1;
5124 } ftm;
5125 };
5126
5127 /**
5128 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm
5129 * suites for interface types defined in @iftypes_mask. Each type in the
5130 * @iftypes_mask must be unique across all instances of iftype_akm_suites.
5131 *
5132 * @iftypes_mask: bitmask of interfaces types
5133 * @akm_suites: points to an array of supported akm suites
5134 * @n_akm_suites: number of supported AKM suites
5135 */
5136 struct wiphy_iftype_akm_suites {
5137 u16 iftypes_mask;
5138 const u32 *akm_suites;
5139 int n_akm_suites;
5140 };
5141
5142 /**
5143 * struct wiphy - wireless hardware description
5144 * @mtx: mutex for the data (structures) of this device
5145 * @reg_notifier: the driver's regulatory notification callback,
5146 * note that if your driver uses wiphy_apply_custom_regulatory()
5147 * the reg_notifier's request can be passed as NULL
5148 * @regd: the driver's regulatory domain, if one was requested via
5149 * the regulatory_hint() API. This can be used by the driver
5150 * on the reg_notifier() if it chooses to ignore future
5151 * regulatory domain changes caused by other drivers.
5152 * @signal_type: signal type reported in &struct cfg80211_bss.
5153 * @cipher_suites: supported cipher suites
5154 * @n_cipher_suites: number of supported cipher suites
5155 * @akm_suites: supported AKM suites. These are the default AKMs supported if
5156 * the supported AKMs not advertized for a specific interface type in
5157 * iftype_akm_suites.
5158 * @n_akm_suites: number of supported AKM suites
5159 * @iftype_akm_suites: array of supported akm suites info per interface type.
5160 * Note that the bits in @iftypes_mask inside this structure cannot
5161 * overlap (i.e. only one occurrence of each type is allowed across all
5162 * instances of iftype_akm_suites).
5163 * @num_iftype_akm_suites: number of interface types for which supported akm
5164 * suites are specified separately.
5165 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
5166 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
5167 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
5168 * -1 = fragmentation disabled, only odd values >= 256 used
5169 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
5170 * @_net: the network namespace this wiphy currently lives in
5171 * @perm_addr: permanent MAC address of this device
5172 * @addr_mask: If the device supports multiple MAC addresses by masking,
5173 * set this to a mask with variable bits set to 1, e.g. if the last
5174 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
5175 * variable bits shall be determined by the interfaces added, with
5176 * interfaces not matching the mask being rejected to be brought up.
5177 * @n_addresses: number of addresses in @addresses.
5178 * @addresses: If the device has more than one address, set this pointer
5179 * to a list of addresses (6 bytes each). The first one will be used
5180 * by default for perm_addr. In this case, the mask should be set to
5181 * all-zeroes. In this case it is assumed that the device can handle
5182 * the same number of arbitrary MAC addresses.
5183 * @registered: protects ->resume and ->suspend sysfs callbacks against
5184 * unregister hardware
5185 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>).
5186 * It will be renamed automatically on wiphy renames
5187 * @dev: (virtual) struct device for this wiphy. The item in
5188 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev()
5189 * (see below).
5190 * @wext: wireless extension handlers
5191 * @priv: driver private data (sized according to wiphy_new() parameter)
5192 * @interface_modes: bitmask of interfaces types valid for this wiphy,
5193 * must be set by driver
5194 * @iface_combinations: Valid interface combinations array, should not
5195 * list single interface types.
5196 * @n_iface_combinations: number of entries in @iface_combinations array.
5197 * @software_iftypes: bitmask of software interface types, these are not
5198 * subject to any restrictions since they are purely managed in SW.
5199 * @flags: wiphy flags, see &enum wiphy_flags
5200 * @regulatory_flags: wiphy regulatory flags, see
5201 * &enum ieee80211_regulatory_flags
5202 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
5203 * @ext_features: extended features advertised to nl80211, see
5204 * &enum nl80211_ext_feature_index.
5205 * @bss_priv_size: each BSS struct has private data allocated with it,
5206 * this variable determines its size
5207 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
5208 * any given scan
5209 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
5210 * the device can run concurrently.
5211 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
5212 * for in any given scheduled scan
5213 * @max_match_sets: maximum number of match sets the device can handle
5214 * when performing a scheduled scan, 0 if filtering is not
5215 * supported.
5216 * @max_scan_ie_len: maximum length of user-controlled IEs device can
5217 * add to probe request frames transmitted during a scan, must not
5218 * include fixed IEs like supported rates
5219 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
5220 * scans
5221 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
5222 * of iterations) for scheduled scan supported by the device.
5223 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
5224 * single scan plan supported by the device.
5225 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
5226 * scan plan supported by the device.
5227 * @coverage_class: current coverage class
5228 * @fw_version: firmware version for ethtool reporting
5229 * @hw_version: hardware version for ethtool reporting
5230 * @max_num_pmkids: maximum number of PMKIDs supported by device
5231 * @privid: a pointer that drivers can use to identify if an arbitrary
5232 * wiphy is theirs, e.g. in global notifiers
5233 * @bands: information about bands/channels supported by this device
5234 *
5235 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
5236 * transmitted through nl80211, points to an array indexed by interface
5237 * type
5238 *
5239 * @available_antennas_tx: bitmap of antennas which are available to be
5240 * configured as TX antennas. Antenna configuration commands will be
5241 * rejected unless this or @available_antennas_rx is set.
5242 *
5243 * @available_antennas_rx: bitmap of antennas which are available to be
5244 * configured as RX antennas. Antenna configuration commands will be
5245 * rejected unless this or @available_antennas_tx is set.
5246 *
5247 * @probe_resp_offload:
5248 * Bitmap of supported protocols for probe response offloading.
5249 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
5250 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
5251 *
5252 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
5253 * may request, if implemented.
5254 *
5255 * @wowlan: WoWLAN support information
5256 * @wowlan_config: current WoWLAN configuration; this should usually not be
5257 * used since access to it is necessarily racy, use the parameter passed
5258 * to the suspend() operation instead.
5259 *
5260 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
5261 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
5262 * If null, then none can be over-ridden.
5263 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
5264 * If null, then none can be over-ridden.
5265 *
5266 * @wdev_list: the list of associated (virtual) interfaces; this list must
5267 * not be modified by the driver, but can be read with RTNL/RCU protection.
5268 *
5269 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
5270 * supports for ACL.
5271 *
5272 * @extended_capabilities: extended capabilities supported by the driver,
5273 * additional capabilities might be supported by userspace; these are
5274 * the 802.11 extended capabilities ("Extended Capabilities element")
5275 * and are in the same format as in the information element. See
5276 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
5277 * extended capabilities to be used if the capabilities are not specified
5278 * for a specific interface type in iftype_ext_capab.
5279 * @extended_capabilities_mask: mask of the valid values
5280 * @extended_capabilities_len: length of the extended capabilities
5281 * @iftype_ext_capab: array of extended capabilities per interface type
5282 * @num_iftype_ext_capab: number of interface types for which extended
5283 * capabilities are specified separately.
5284 * @coalesce: packet coalescing support information
5285 *
5286 * @vendor_commands: array of vendor commands supported by the hardware
5287 * @n_vendor_commands: number of vendor commands
5288 * @vendor_events: array of vendor events supported by the hardware
5289 * @n_vendor_events: number of vendor events
5290 *
5291 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
5292 * (including P2P GO) or 0 to indicate no such limit is advertised. The
5293 * driver is allowed to advertise a theoretical limit that it can reach in
5294 * some cases, but may not always reach.
5295 *
5296 * @max_num_csa_counters: Number of supported csa_counters in beacons
5297 * and probe responses. This value should be set if the driver
5298 * wishes to limit the number of csa counters. Default (0) means
5299 * infinite.
5300 * @bss_select_support: bitmask indicating the BSS selection criteria supported
5301 * by the driver in the .connect() callback. The bit position maps to the
5302 * attribute indices defined in &enum nl80211_bss_select_attr.
5303 *
5304 * @nan_supported_bands: bands supported by the device in NAN mode, a
5305 * bitmap of &enum nl80211_band values. For instance, for
5306 * NL80211_BAND_2GHZ, bit 0 would be set
5307 * (i.e. BIT(NL80211_BAND_2GHZ)).
5308 *
5309 * @txq_limit: configuration of internal TX queue frame limit
5310 * @txq_memory_limit: configuration internal TX queue memory limit
5311 * @txq_quantum: configuration of internal TX queue scheduler quantum
5312 *
5313 * @tx_queue_len: allow setting transmit queue len for drivers not using
5314 * wake_tx_queue
5315 *
5316 * @support_mbssid: can HW support association with nontransmitted AP
5317 * @support_only_he_mbssid: don't parse MBSSID elements if it is not
5318 * HE AP, in order to avoid compatibility issues.
5319 * @support_mbssid must be set for this to have any effect.
5320 *
5321 * @pmsr_capa: peer measurement capabilities
5322 *
5323 * @tid_config_support: describes the per-TID config support that the
5324 * device has
5325 * @tid_config_support.vif: bitmap of attributes (configurations)
5326 * supported by the driver for each vif
5327 * @tid_config_support.peer: bitmap of attributes (configurations)
5328 * supported by the driver for each peer
5329 * @tid_config_support.max_retry: maximum supported retry count for
5330 * long/short retry configuration
5331 *
5332 * @max_data_retry_count: maximum supported per TID retry count for
5333 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and
5334 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes
5335 * @sar_capa: SAR control capabilities
5336 * @rfkill: a pointer to the rfkill structure
5337 *
5338 * @mbssid_max_interfaces: maximum number of interfaces supported by the driver
5339 * in a multiple BSSID set. This field must be set to a non-zero value
5340 * by the driver to advertise MBSSID support.
5341 * @ema_max_profile_periodicity: maximum profile periodicity supported by
5342 * the driver. Setting this field to a non-zero value indicates that the
5343 * driver supports enhanced multi-BSSID advertisements (EMA AP).
5344 * @max_num_akm_suites: maximum number of AKM suites allowed for
5345 * configuration through %NL80211_CMD_CONNECT, %NL80211_CMD_ASSOCIATE and
5346 * %NL80211_CMD_START_AP. Set to NL80211_MAX_NR_AKM_SUITES if not set by
5347 * driver. If set by driver minimum allowed value is
5348 * NL80211_MAX_NR_AKM_SUITES in order to avoid compatibility issues with
5349 * legacy userspace and maximum allowed value is
5350 * CFG80211_MAX_NUM_AKM_SUITES.
5351 */
5352 struct wiphy {
5353 struct mutex mtx;
5354
5355 /* assign these fields before you register the wiphy */
5356
5357 u8 perm_addr[ETH_ALEN];
5358 u8 addr_mask[ETH_ALEN];
5359
5360 struct mac_address *addresses;
5361
5362 const struct ieee80211_txrx_stypes *mgmt_stypes;
5363
5364 const struct ieee80211_iface_combination *iface_combinations;
5365 int n_iface_combinations;
5366 u16 software_iftypes;
5367
5368 u16 n_addresses;
5369
5370 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
5371 u16 interface_modes;
5372
5373 u16 max_acl_mac_addrs;
5374
5375 u32 flags, regulatory_flags, features;
5376 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
5377
5378 u32 ap_sme_capa;
5379
5380 enum cfg80211_signal_type signal_type;
5381
5382 int bss_priv_size;
5383 u8 max_scan_ssids;
5384 u8 max_sched_scan_reqs;
5385 u8 max_sched_scan_ssids;
5386 u8 max_match_sets;
5387 u16 max_scan_ie_len;
5388 u16 max_sched_scan_ie_len;
5389 u32 max_sched_scan_plans;
5390 u32 max_sched_scan_plan_interval;
5391 u32 max_sched_scan_plan_iterations;
5392
5393 int n_cipher_suites;
5394 const u32 *cipher_suites;
5395
5396 int n_akm_suites;
5397 const u32 *akm_suites;
5398
5399 const struct wiphy_iftype_akm_suites *iftype_akm_suites;
5400 unsigned int num_iftype_akm_suites;
5401
5402 u8 retry_short;
5403 u8 retry_long;
5404 u32 frag_threshold;
5405 u32 rts_threshold;
5406 u8 coverage_class;
5407
5408 char fw_version[ETHTOOL_FWVERS_LEN];
5409 u32 hw_version;
5410
5411 #ifdef CONFIG_PM
5412 const struct wiphy_wowlan_support *wowlan;
5413 struct cfg80211_wowlan *wowlan_config;
5414 #endif
5415
5416 u16 max_remain_on_channel_duration;
5417
5418 u8 max_num_pmkids;
5419
5420 u32 available_antennas_tx;
5421 u32 available_antennas_rx;
5422
5423 u32 probe_resp_offload;
5424
5425 const u8 *extended_capabilities, *extended_capabilities_mask;
5426 u8 extended_capabilities_len;
5427
5428 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
5429 unsigned int num_iftype_ext_capab;
5430
5431 const void *privid;
5432
5433 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
5434
5435 void (*reg_notifier)(struct wiphy *wiphy,
5436 struct regulatory_request *request);
5437
5438 /* fields below are read-only, assigned by cfg80211 */
5439
5440 const struct ieee80211_regdomain __rcu *regd;
5441
5442 struct device dev;
5443
5444 bool registered;
5445
5446 struct dentry *debugfsdir;
5447
5448 const struct ieee80211_ht_cap *ht_capa_mod_mask;
5449 const struct ieee80211_vht_cap *vht_capa_mod_mask;
5450
5451 struct list_head wdev_list;
5452
5453 possible_net_t _net;
5454
5455 #ifdef CONFIG_CFG80211_WEXT
5456 const struct iw_handler_def *wext;
5457 #endif
5458
5459 const struct wiphy_coalesce_support *coalesce;
5460
5461 const struct wiphy_vendor_command *vendor_commands;
5462 const struct nl80211_vendor_cmd_info *vendor_events;
5463 int n_vendor_commands, n_vendor_events;
5464
5465 u16 max_ap_assoc_sta;
5466
5467 u8 max_num_csa_counters;
5468
5469 u32 bss_select_support;
5470
5471 u8 nan_supported_bands;
5472
5473 u32 txq_limit;
5474 u32 txq_memory_limit;
5475 u32 txq_quantum;
5476
5477 unsigned long tx_queue_len;
5478
5479 u8 support_mbssid:1,
5480 support_only_he_mbssid:1;
5481
5482 const struct cfg80211_pmsr_capabilities *pmsr_capa;
5483
5484 struct {
5485 u64 peer, vif;
5486 u8 max_retry;
5487 } tid_config_support;
5488
5489 u8 max_data_retry_count;
5490
5491 const struct cfg80211_sar_capa *sar_capa;
5492
5493 struct rfkill *rfkill;
5494
5495 u8 mbssid_max_interfaces;
5496 u8 ema_max_profile_periodicity;
5497 u16 max_num_akm_suites;
5498
5499 ANDROID_KABI_RESERVE(1);
5500
5501 char priv[] __aligned(NETDEV_ALIGN);
5502 };
5503
wiphy_net(struct wiphy * wiphy)5504 static inline struct net *wiphy_net(struct wiphy *wiphy)
5505 {
5506 return read_pnet(&wiphy->_net);
5507 }
5508
wiphy_net_set(struct wiphy * wiphy,struct net * net)5509 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
5510 {
5511 write_pnet(&wiphy->_net, net);
5512 }
5513
5514 /**
5515 * wiphy_priv - return priv from wiphy
5516 *
5517 * @wiphy: the wiphy whose priv pointer to return
5518 * Return: The priv of @wiphy.
5519 */
wiphy_priv(struct wiphy * wiphy)5520 static inline void *wiphy_priv(struct wiphy *wiphy)
5521 {
5522 BUG_ON(!wiphy);
5523 return &wiphy->priv;
5524 }
5525
5526 /**
5527 * priv_to_wiphy - return the wiphy containing the priv
5528 *
5529 * @priv: a pointer previously returned by wiphy_priv
5530 * Return: The wiphy of @priv.
5531 */
priv_to_wiphy(void * priv)5532 static inline struct wiphy *priv_to_wiphy(void *priv)
5533 {
5534 BUG_ON(!priv);
5535 return container_of(priv, struct wiphy, priv);
5536 }
5537
5538 /**
5539 * set_wiphy_dev - set device pointer for wiphy
5540 *
5541 * @wiphy: The wiphy whose device to bind
5542 * @dev: The device to parent it to
5543 */
set_wiphy_dev(struct wiphy * wiphy,struct device * dev)5544 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
5545 {
5546 wiphy->dev.parent = dev;
5547 }
5548
5549 /**
5550 * wiphy_dev - get wiphy dev pointer
5551 *
5552 * @wiphy: The wiphy whose device struct to look up
5553 * Return: The dev of @wiphy.
5554 */
wiphy_dev(struct wiphy * wiphy)5555 static inline struct device *wiphy_dev(struct wiphy *wiphy)
5556 {
5557 return wiphy->dev.parent;
5558 }
5559
5560 /**
5561 * wiphy_name - get wiphy name
5562 *
5563 * @wiphy: The wiphy whose name to return
5564 * Return: The name of @wiphy.
5565 */
wiphy_name(const struct wiphy * wiphy)5566 static inline const char *wiphy_name(const struct wiphy *wiphy)
5567 {
5568 return dev_name(&wiphy->dev);
5569 }
5570
5571 /**
5572 * wiphy_new_nm - create a new wiphy for use with cfg80211
5573 *
5574 * @ops: The configuration operations for this device
5575 * @sizeof_priv: The size of the private area to allocate
5576 * @requested_name: Request a particular name.
5577 * NULL is valid value, and means use the default phy%d naming.
5578 *
5579 * Create a new wiphy and associate the given operations with it.
5580 * @sizeof_priv bytes are allocated for private use.
5581 *
5582 * Return: A pointer to the new wiphy. This pointer must be
5583 * assigned to each netdev's ieee80211_ptr for proper operation.
5584 */
5585 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
5586 const char *requested_name);
5587
5588 /**
5589 * wiphy_new - create a new wiphy for use with cfg80211
5590 *
5591 * @ops: The configuration operations for this device
5592 * @sizeof_priv: The size of the private area to allocate
5593 *
5594 * Create a new wiphy and associate the given operations with it.
5595 * @sizeof_priv bytes are allocated for private use.
5596 *
5597 * Return: A pointer to the new wiphy. This pointer must be
5598 * assigned to each netdev's ieee80211_ptr for proper operation.
5599 */
wiphy_new(const struct cfg80211_ops * ops,int sizeof_priv)5600 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
5601 int sizeof_priv)
5602 {
5603 return wiphy_new_nm(ops, sizeof_priv, NULL);
5604 }
5605
5606 /**
5607 * wiphy_register - register a wiphy with cfg80211
5608 *
5609 * @wiphy: The wiphy to register.
5610 *
5611 * Return: A non-negative wiphy index or a negative error code.
5612 */
5613 int wiphy_register(struct wiphy *wiphy);
5614
5615 /* this is a define for better error reporting (file/line) */
5616 #define lockdep_assert_wiphy(wiphy) lockdep_assert_held(&(wiphy)->mtx)
5617
5618 /**
5619 * rcu_dereference_wiphy - rcu_dereference with debug checking
5620 * @wiphy: the wiphy to check the locking on
5621 * @p: The pointer to read, prior to dereferencing
5622 *
5623 * Do an rcu_dereference(p), but check caller either holds rcu_read_lock()
5624 * or RTNL. Note: Please prefer wiphy_dereference() or rcu_dereference().
5625 */
5626 #define rcu_dereference_wiphy(wiphy, p) \
5627 rcu_dereference_check(p, lockdep_is_held(&wiphy->mtx))
5628
5629 /**
5630 * wiphy_dereference - fetch RCU pointer when updates are prevented by wiphy mtx
5631 * @wiphy: the wiphy to check the locking on
5632 * @p: The pointer to read, prior to dereferencing
5633 *
5634 * Return the value of the specified RCU-protected pointer, but omit the
5635 * READ_ONCE(), because caller holds the wiphy mutex used for updates.
5636 */
5637 #define wiphy_dereference(wiphy, p) \
5638 rcu_dereference_protected(p, lockdep_is_held(&wiphy->mtx))
5639
5640 /**
5641 * get_wiphy_regdom - get custom regdomain for the given wiphy
5642 * @wiphy: the wiphy to get the regdomain from
5643 */
5644 const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy);
5645
5646 /**
5647 * wiphy_unregister - deregister a wiphy from cfg80211
5648 *
5649 * @wiphy: The wiphy to unregister.
5650 *
5651 * After this call, no more requests can be made with this priv
5652 * pointer, but the call may sleep to wait for an outstanding
5653 * request that is being handled.
5654 */
5655 void wiphy_unregister(struct wiphy *wiphy);
5656
5657 /**
5658 * wiphy_free - free wiphy
5659 *
5660 * @wiphy: The wiphy to free
5661 */
5662 void wiphy_free(struct wiphy *wiphy);
5663
5664 /* internal structs */
5665 struct cfg80211_conn;
5666 struct cfg80211_internal_bss;
5667 struct cfg80211_cached_keys;
5668 struct cfg80211_cqm_config;
5669
5670 /**
5671 * wiphy_lock - lock the wiphy
5672 * @wiphy: the wiphy to lock
5673 *
5674 * This is mostly exposed so it can be done around registering and
5675 * unregistering netdevs that aren't created through cfg80211 calls,
5676 * since that requires locking in cfg80211 when the notifiers is
5677 * called, but that cannot differentiate which way it's called.
5678 *
5679 * When cfg80211 ops are called, the wiphy is already locked.
5680 */
wiphy_lock(struct wiphy * wiphy)5681 static inline void wiphy_lock(struct wiphy *wiphy)
5682 __acquires(&wiphy->mtx)
5683 {
5684 mutex_lock(&wiphy->mtx);
5685 __acquire(&wiphy->mtx);
5686 }
5687
5688 /**
5689 * wiphy_unlock - unlock the wiphy again
5690 * @wiphy: the wiphy to unlock
5691 */
wiphy_unlock(struct wiphy * wiphy)5692 static inline void wiphy_unlock(struct wiphy *wiphy)
5693 __releases(&wiphy->mtx)
5694 {
5695 __release(&wiphy->mtx);
5696 mutex_unlock(&wiphy->mtx);
5697 }
5698
5699 /**
5700 * struct wireless_dev - wireless device state
5701 *
5702 * For netdevs, this structure must be allocated by the driver
5703 * that uses the ieee80211_ptr field in struct net_device (this
5704 * is intentional so it can be allocated along with the netdev.)
5705 * It need not be registered then as netdev registration will
5706 * be intercepted by cfg80211 to see the new wireless device,
5707 * however, drivers must lock the wiphy before registering or
5708 * unregistering netdevs if they pre-create any netdevs (in ops
5709 * called from cfg80211, the wiphy is already locked.)
5710 *
5711 * For non-netdev uses, it must also be allocated by the driver
5712 * in response to the cfg80211 callbacks that require it, as
5713 * there's no netdev registration in that case it may not be
5714 * allocated outside of callback operations that return it.
5715 *
5716 * @wiphy: pointer to hardware description
5717 * @iftype: interface type
5718 * @registered: is this wdev already registered with cfg80211
5719 * @registering: indicates we're doing registration under wiphy lock
5720 * for the notifier
5721 * @list: (private) Used to collect the interfaces
5722 * @netdev: (private) Used to reference back to the netdev, may be %NULL
5723 * @identifier: (private) Identifier used in nl80211 to identify this
5724 * wireless device if it has no netdev
5725 * @u: union containing data specific to @iftype
5726 * @connected: indicates if connected or not (STA mode)
5727 * @bssid: (private) Used by the internal configuration code
5728 * @wext: (private) Used by the internal wireless extensions compat code
5729 * @wext.ibss: (private) IBSS data part of wext handling
5730 * @wext.connect: (private) connection handling data
5731 * @wext.keys: (private) (WEP) key data
5732 * @wext.ie: (private) extra elements for association
5733 * @wext.ie_len: (private) length of extra elements
5734 * @wext.bssid: (private) selected network BSSID
5735 * @wext.ssid: (private) selected network SSID
5736 * @wext.default_key: (private) selected default key index
5737 * @wext.default_mgmt_key: (private) selected default management key index
5738 * @wext.prev_bssid: (private) previous BSSID for reassociation
5739 * @wext.prev_bssid_valid: (private) previous BSSID validity
5740 * @use_4addr: indicates 4addr mode is used on this interface, must be
5741 * set by driver (if supported) on add_interface BEFORE registering the
5742 * netdev and may otherwise be used by driver read-only, will be update
5743 * by cfg80211 on change_interface
5744 * @mgmt_registrations: list of registrations for management frames
5745 * @mgmt_registrations_need_update: mgmt registrations were updated,
5746 * need to propagate the update to the driver
5747 * @mtx: mutex used to lock data in this struct, may be used by drivers
5748 * and some API functions require it held
5749 * @beacon_interval: beacon interval used on this device for transmitting
5750 * beacons, 0 when not valid
5751 * @address: The address for this device, valid only if @netdev is %NULL
5752 * @is_running: true if this is a non-netdev device that has been started, e.g.
5753 * the P2P Device.
5754 * @cac_started: true if DFS channel availability check has been started
5755 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
5756 * @cac_time_ms: CAC time in ms
5757 * @ps: powersave mode is enabled
5758 * @ps_timeout: dynamic powersave timeout
5759 * @ap_unexpected_nlportid: (private) netlink port ID of application
5760 * registered for unexpected class 3 frames (AP mode)
5761 * @conn: (private) cfg80211 software SME connection state machine data
5762 * @connect_keys: (private) keys to set after connection is established
5763 * @conn_bss_type: connecting/connected BSS type
5764 * @conn_owner_nlportid: (private) connection owner socket port ID
5765 * @disconnect_wk: (private) auto-disconnect work
5766 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
5767 * @event_list: (private) list for internal event processing
5768 * @event_lock: (private) lock for event list
5769 * @owner_nlportid: (private) owner socket port ID
5770 * @nl_owner_dead: (private) owner socket went away
5771 * @cqm_config: (private) nl80211 RSSI monitor state
5772 * @pmsr_list: (private) peer measurement requests
5773 * @pmsr_lock: (private) peer measurements requests/results lock
5774 * @pmsr_free_wk: (private) peer measurements cleanup work
5775 * @unprot_beacon_reported: (private) timestamp of last
5776 * unprotected beacon report
5777 * @links: array of %IEEE80211_MLD_MAX_NUM_LINKS elements containing @addr
5778 * @ap and @client for each link
5779 * @valid_links: bitmap describing what elements of @links are valid
5780 */
5781 struct wireless_dev {
5782 struct wiphy *wiphy;
5783 enum nl80211_iftype iftype;
5784
5785 /* the remainder of this struct should be private to cfg80211 */
5786 struct list_head list;
5787 struct net_device *netdev;
5788
5789 u32 identifier;
5790
5791 struct list_head mgmt_registrations;
5792 u8 mgmt_registrations_need_update:1;
5793
5794 struct mutex mtx;
5795
5796 bool use_4addr, is_running, registered, registering;
5797
5798 u8 address[ETH_ALEN] __aligned(sizeof(u16));
5799
5800 /* currently used for IBSS and SME - might be rearranged later */
5801 struct cfg80211_conn *conn;
5802 struct cfg80211_cached_keys *connect_keys;
5803 enum ieee80211_bss_type conn_bss_type;
5804 u32 conn_owner_nlportid;
5805
5806 struct work_struct disconnect_wk;
5807 u8 disconnect_bssid[ETH_ALEN];
5808
5809 struct list_head event_list;
5810 spinlock_t event_lock;
5811
5812 u8 connected:1;
5813
5814 bool ps;
5815 int ps_timeout;
5816
5817 u32 ap_unexpected_nlportid;
5818
5819 u32 owner_nlportid;
5820 bool nl_owner_dead;
5821
5822 /* FIXME: need to rework radar detection for MLO */
5823 bool cac_started;
5824 unsigned long cac_start_time;
5825 unsigned int cac_time_ms;
5826
5827 #ifdef CONFIG_CFG80211_WEXT
5828 /* wext data */
5829 struct {
5830 struct cfg80211_ibss_params ibss;
5831 struct cfg80211_connect_params connect;
5832 struct cfg80211_cached_keys *keys;
5833 const u8 *ie;
5834 size_t ie_len;
5835 u8 bssid[ETH_ALEN];
5836 u8 prev_bssid[ETH_ALEN];
5837 u8 ssid[IEEE80211_MAX_SSID_LEN];
5838 s8 default_key, default_mgmt_key;
5839 bool prev_bssid_valid;
5840 } wext;
5841 #endif
5842
5843 struct cfg80211_cqm_config *cqm_config;
5844
5845 struct list_head pmsr_list;
5846 spinlock_t pmsr_lock;
5847 struct work_struct pmsr_free_wk;
5848
5849 unsigned long unprot_beacon_reported;
5850
5851 union {
5852 struct {
5853 u8 connected_addr[ETH_ALEN] __aligned(2);
5854 u8 ssid[IEEE80211_MAX_SSID_LEN];
5855 u8 ssid_len;
5856 } client;
5857 struct {
5858 int beacon_interval;
5859 struct cfg80211_chan_def preset_chandef;
5860 struct cfg80211_chan_def chandef;
5861 u8 id[IEEE80211_MAX_SSID_LEN];
5862 u8 id_len, id_up_len;
5863 } mesh;
5864 struct {
5865 struct cfg80211_chan_def preset_chandef;
5866 u8 ssid[IEEE80211_MAX_SSID_LEN];
5867 u8 ssid_len;
5868 } ap;
5869 struct {
5870 struct cfg80211_internal_bss *current_bss;
5871 struct cfg80211_chan_def chandef;
5872 int beacon_interval;
5873 u8 ssid[IEEE80211_MAX_SSID_LEN];
5874 u8 ssid_len;
5875 } ibss;
5876 struct {
5877 struct cfg80211_chan_def chandef;
5878 } ocb;
5879 } u;
5880
5881 struct {
5882 u8 addr[ETH_ALEN] __aligned(2);
5883 union {
5884 struct {
5885 unsigned int beacon_interval;
5886 struct cfg80211_chan_def chandef;
5887 } ap;
5888 struct {
5889 struct cfg80211_internal_bss *current_bss;
5890 } client;
5891 };
5892 } links[IEEE80211_MLD_MAX_NUM_LINKS];
5893 u16 valid_links;
5894
5895 ANDROID_KABI_RESERVE(1);
5896 ANDROID_KABI_RESERVE(2);
5897 };
5898
wdev_address(struct wireless_dev * wdev)5899 static inline u8 *wdev_address(struct wireless_dev *wdev)
5900 {
5901 if (wdev->netdev)
5902 return wdev->netdev->dev_addr;
5903 return wdev->address;
5904 }
5905
wdev_running(struct wireless_dev * wdev)5906 static inline bool wdev_running(struct wireless_dev *wdev)
5907 {
5908 if (wdev->netdev)
5909 return netif_running(wdev->netdev);
5910 return wdev->is_running;
5911 }
5912
5913 /**
5914 * wdev_priv - return wiphy priv from wireless_dev
5915 *
5916 * @wdev: The wireless device whose wiphy's priv pointer to return
5917 * Return: The wiphy priv of @wdev.
5918 */
wdev_priv(struct wireless_dev * wdev)5919 static inline void *wdev_priv(struct wireless_dev *wdev)
5920 {
5921 BUG_ON(!wdev);
5922 return wiphy_priv(wdev->wiphy);
5923 }
5924
5925 /**
5926 * wdev_chandef - return chandef pointer from wireless_dev
5927 * @wdev: the wdev
5928 * @link_id: the link ID for MLO
5929 *
5930 * Return: The chandef depending on the mode, or %NULL.
5931 */
5932 struct cfg80211_chan_def *wdev_chandef(struct wireless_dev *wdev,
5933 unsigned int link_id);
5934
WARN_INVALID_LINK_ID(struct wireless_dev * wdev,unsigned int link_id)5935 static inline void WARN_INVALID_LINK_ID(struct wireless_dev *wdev,
5936 unsigned int link_id)
5937 {
5938 WARN_ON(link_id && !wdev->valid_links);
5939 WARN_ON(wdev->valid_links &&
5940 !(wdev->valid_links & BIT(link_id)));
5941 }
5942
5943 #define for_each_valid_link(link_info, link_id) \
5944 for (link_id = 0; \
5945 link_id < ((link_info)->valid_links ? \
5946 ARRAY_SIZE((link_info)->links) : 1); \
5947 link_id++) \
5948 if (!(link_info)->valid_links || \
5949 ((link_info)->valid_links & BIT(link_id)))
5950
5951 /**
5952 * DOC: Utility functions
5953 *
5954 * cfg80211 offers a number of utility functions that can be useful.
5955 */
5956
5957 /**
5958 * ieee80211_channel_equal - compare two struct ieee80211_channel
5959 *
5960 * @a: 1st struct ieee80211_channel
5961 * @b: 2nd struct ieee80211_channel
5962 * Return: true if center frequency of @a == @b
5963 */
5964 static inline bool
ieee80211_channel_equal(struct ieee80211_channel * a,struct ieee80211_channel * b)5965 ieee80211_channel_equal(struct ieee80211_channel *a,
5966 struct ieee80211_channel *b)
5967 {
5968 return (a->center_freq == b->center_freq &&
5969 a->freq_offset == b->freq_offset);
5970 }
5971
5972 /**
5973 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz
5974 * @chan: struct ieee80211_channel to convert
5975 * Return: The corresponding frequency (in KHz)
5976 */
5977 static inline u32
ieee80211_channel_to_khz(const struct ieee80211_channel * chan)5978 ieee80211_channel_to_khz(const struct ieee80211_channel *chan)
5979 {
5980 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset;
5981 }
5982
5983 /**
5984 * ieee80211_s1g_channel_width - get allowed channel width from @chan
5985 *
5986 * Only allowed for band NL80211_BAND_S1GHZ
5987 * @chan: channel
5988 * Return: The allowed channel width for this center_freq
5989 */
5990 enum nl80211_chan_width
5991 ieee80211_s1g_channel_width(const struct ieee80211_channel *chan);
5992
5993 /**
5994 * ieee80211_channel_to_freq_khz - convert channel number to frequency
5995 * @chan: channel number
5996 * @band: band, necessary due to channel number overlap
5997 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed.
5998 */
5999 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band);
6000
6001 /**
6002 * ieee80211_channel_to_frequency - convert channel number to frequency
6003 * @chan: channel number
6004 * @band: band, necessary due to channel number overlap
6005 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
6006 */
6007 static inline int
ieee80211_channel_to_frequency(int chan,enum nl80211_band band)6008 ieee80211_channel_to_frequency(int chan, enum nl80211_band band)
6009 {
6010 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band));
6011 }
6012
6013 /**
6014 * ieee80211_freq_khz_to_channel - convert frequency to channel number
6015 * @freq: center frequency in KHz
6016 * Return: The corresponding channel, or 0 if the conversion failed.
6017 */
6018 int ieee80211_freq_khz_to_channel(u32 freq);
6019
6020 /**
6021 * ieee80211_frequency_to_channel - convert frequency to channel number
6022 * @freq: center frequency in MHz
6023 * Return: The corresponding channel, or 0 if the conversion failed.
6024 */
6025 static inline int
ieee80211_frequency_to_channel(int freq)6026 ieee80211_frequency_to_channel(int freq)
6027 {
6028 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq));
6029 }
6030
6031 /**
6032 * ieee80211_get_channel_khz - get channel struct from wiphy for specified
6033 * frequency
6034 * @wiphy: the struct wiphy to get the channel for
6035 * @freq: the center frequency (in KHz) of the channel
6036 * Return: The channel struct from @wiphy at @freq.
6037 */
6038 struct ieee80211_channel *
6039 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq);
6040
6041 /**
6042 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
6043 *
6044 * @wiphy: the struct wiphy to get the channel for
6045 * @freq: the center frequency (in MHz) of the channel
6046 * Return: The channel struct from @wiphy at @freq.
6047 */
6048 static inline struct ieee80211_channel *
ieee80211_get_channel(struct wiphy * wiphy,int freq)6049 ieee80211_get_channel(struct wiphy *wiphy, int freq)
6050 {
6051 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq));
6052 }
6053
6054 /**
6055 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC
6056 * @chan: control channel to check
6057 *
6058 * The Preferred Scanning Channels (PSC) are defined in
6059 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3
6060 */
cfg80211_channel_is_psc(struct ieee80211_channel * chan)6061 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan)
6062 {
6063 if (chan->band != NL80211_BAND_6GHZ)
6064 return false;
6065
6066 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5;
6067 }
6068
6069 /**
6070 * ieee80211_get_response_rate - get basic rate for a given rate
6071 *
6072 * @sband: the band to look for rates in
6073 * @basic_rates: bitmap of basic rates
6074 * @bitrate: the bitrate for which to find the basic rate
6075 *
6076 * Return: The basic rate corresponding to a given bitrate, that
6077 * is the next lower bitrate contained in the basic rate map,
6078 * which is, for this function, given as a bitmap of indices of
6079 * rates in the band's bitrate table.
6080 */
6081 const struct ieee80211_rate *
6082 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
6083 u32 basic_rates, int bitrate);
6084
6085 /**
6086 * ieee80211_mandatory_rates - get mandatory rates for a given band
6087 * @sband: the band to look for rates in
6088 * @scan_width: width of the control channel
6089 *
6090 * This function returns a bitmap of the mandatory rates for the given
6091 * band, bits are set according to the rate position in the bitrates array.
6092 */
6093 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
6094 enum nl80211_bss_scan_width scan_width);
6095
6096 /*
6097 * Radiotap parsing functions -- for controlled injection support
6098 *
6099 * Implemented in net/wireless/radiotap.c
6100 * Documentation in Documentation/networking/radiotap-headers.rst
6101 */
6102
6103 struct radiotap_align_size {
6104 uint8_t align:4, size:4;
6105 };
6106
6107 struct ieee80211_radiotap_namespace {
6108 const struct radiotap_align_size *align_size;
6109 int n_bits;
6110 uint32_t oui;
6111 uint8_t subns;
6112 };
6113
6114 struct ieee80211_radiotap_vendor_namespaces {
6115 const struct ieee80211_radiotap_namespace *ns;
6116 int n_ns;
6117 };
6118
6119 /**
6120 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
6121 * @this_arg_index: index of current arg, valid after each successful call
6122 * to ieee80211_radiotap_iterator_next()
6123 * @this_arg: pointer to current radiotap arg; it is valid after each
6124 * call to ieee80211_radiotap_iterator_next() but also after
6125 * ieee80211_radiotap_iterator_init() where it will point to
6126 * the beginning of the actual data portion
6127 * @this_arg_size: length of the current arg, for convenience
6128 * @current_namespace: pointer to the current namespace definition
6129 * (or internally %NULL if the current namespace is unknown)
6130 * @is_radiotap_ns: indicates whether the current namespace is the default
6131 * radiotap namespace or not
6132 *
6133 * @_rtheader: pointer to the radiotap header we are walking through
6134 * @_max_length: length of radiotap header in cpu byte ordering
6135 * @_arg_index: next argument index
6136 * @_arg: next argument pointer
6137 * @_next_bitmap: internal pointer to next present u32
6138 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
6139 * @_vns: vendor namespace definitions
6140 * @_next_ns_data: beginning of the next namespace's data
6141 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
6142 * next bitmap word
6143 *
6144 * Describes the radiotap parser state. Fields prefixed with an underscore
6145 * must not be used by users of the parser, only by the parser internally.
6146 */
6147
6148 struct ieee80211_radiotap_iterator {
6149 struct ieee80211_radiotap_header *_rtheader;
6150 const struct ieee80211_radiotap_vendor_namespaces *_vns;
6151 const struct ieee80211_radiotap_namespace *current_namespace;
6152
6153 unsigned char *_arg, *_next_ns_data;
6154 __le32 *_next_bitmap;
6155
6156 unsigned char *this_arg;
6157 int this_arg_index;
6158 int this_arg_size;
6159
6160 int is_radiotap_ns;
6161
6162 int _max_length;
6163 int _arg_index;
6164 uint32_t _bitmap_shifter;
6165 int _reset_on_ext;
6166 };
6167
6168 int
6169 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
6170 struct ieee80211_radiotap_header *radiotap_header,
6171 int max_length,
6172 const struct ieee80211_radiotap_vendor_namespaces *vns);
6173
6174 int
6175 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
6176
6177
6178 extern const unsigned char rfc1042_header[6];
6179 extern const unsigned char bridge_tunnel_header[6];
6180
6181 /**
6182 * ieee80211_get_hdrlen_from_skb - get header length from data
6183 *
6184 * @skb: the frame
6185 *
6186 * Given an skb with a raw 802.11 header at the data pointer this function
6187 * returns the 802.11 header length.
6188 *
6189 * Return: The 802.11 header length in bytes (not including encryption
6190 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
6191 * 802.11 header.
6192 */
6193 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
6194
6195 /**
6196 * ieee80211_hdrlen - get header length in bytes from frame control
6197 * @fc: frame control field in little-endian format
6198 * Return: The header length in bytes.
6199 */
6200 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
6201
6202 /**
6203 * ieee80211_get_mesh_hdrlen - get mesh extension header length
6204 * @meshhdr: the mesh extension header, only the flags field
6205 * (first byte) will be accessed
6206 * Return: The length of the extension header, which is always at
6207 * least 6 bytes and at most 18 if address 5 and 6 are present.
6208 */
6209 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
6210
6211 /**
6212 * DOC: Data path helpers
6213 *
6214 * In addition to generic utilities, cfg80211 also offers
6215 * functions that help implement the data path for devices
6216 * that do not do the 802.11/802.3 conversion on the device.
6217 */
6218
6219 /**
6220 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
6221 * @skb: the 802.11 data frame
6222 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
6223 * of it being pushed into the SKB
6224 * @addr: the device MAC address
6225 * @iftype: the virtual interface type
6226 * @data_offset: offset of payload after the 802.11 header
6227 * @is_amsdu: true if the 802.11 header is A-MSDU
6228 * Return: 0 on success. Non-zero on error.
6229 */
6230 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
6231 const u8 *addr, enum nl80211_iftype iftype,
6232 u8 data_offset, bool is_amsdu);
6233
6234 /**
6235 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
6236 * @skb: the 802.11 data frame
6237 * @addr: the device MAC address
6238 * @iftype: the virtual interface type
6239 * Return: 0 on success. Non-zero on error.
6240 */
ieee80211_data_to_8023(struct sk_buff * skb,const u8 * addr,enum nl80211_iftype iftype)6241 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
6242 enum nl80211_iftype iftype)
6243 {
6244 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0, false);
6245 }
6246
6247 /**
6248 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
6249 *
6250 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
6251 * The @list will be empty if the decode fails. The @skb must be fully
6252 * header-less before being passed in here; it is freed in this function.
6253 *
6254 * @skb: The input A-MSDU frame without any headers.
6255 * @list: The output list of 802.3 frames. It must be allocated and
6256 * initialized by the caller.
6257 * @addr: The device MAC address.
6258 * @iftype: The device interface type.
6259 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
6260 * @check_da: DA to check in the inner ethernet header, or NULL
6261 * @check_sa: SA to check in the inner ethernet header, or NULL
6262 */
6263 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
6264 const u8 *addr, enum nl80211_iftype iftype,
6265 const unsigned int extra_headroom,
6266 const u8 *check_da, const u8 *check_sa);
6267
6268 /**
6269 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
6270 * @skb: the data frame
6271 * @qos_map: Interworking QoS mapping or %NULL if not in use
6272 * Return: The 802.1p/1d tag.
6273 */
6274 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
6275 struct cfg80211_qos_map *qos_map);
6276
6277 /**
6278 * cfg80211_find_elem_match - match information element and byte array in data
6279 *
6280 * @eid: element ID
6281 * @ies: data consisting of IEs
6282 * @len: length of data
6283 * @match: byte array to match
6284 * @match_len: number of bytes in the match array
6285 * @match_offset: offset in the IE data where the byte array should match.
6286 * Note the difference to cfg80211_find_ie_match() which considers
6287 * the offset to start from the element ID byte, but here we take
6288 * the data portion instead.
6289 *
6290 * Return: %NULL if the element ID could not be found or if
6291 * the element is invalid (claims to be longer than the given
6292 * data) or if the byte array doesn't match; otherwise return the
6293 * requested element struct.
6294 *
6295 * Note: There are no checks on the element length other than
6296 * having to fit into the given data and being large enough for the
6297 * byte array to match.
6298 */
6299 const struct element *
6300 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
6301 const u8 *match, unsigned int match_len,
6302 unsigned int match_offset);
6303
6304 /**
6305 * cfg80211_find_ie_match - match information element and byte array in data
6306 *
6307 * @eid: element ID
6308 * @ies: data consisting of IEs
6309 * @len: length of data
6310 * @match: byte array to match
6311 * @match_len: number of bytes in the match array
6312 * @match_offset: offset in the IE where the byte array should match.
6313 * If match_len is zero, this must also be set to zero.
6314 * Otherwise this must be set to 2 or more, because the first
6315 * byte is the element id, which is already compared to eid, and
6316 * the second byte is the IE length.
6317 *
6318 * Return: %NULL if the element ID could not be found or if
6319 * the element is invalid (claims to be longer than the given
6320 * data) or if the byte array doesn't match, or a pointer to the first
6321 * byte of the requested element, that is the byte containing the
6322 * element ID.
6323 *
6324 * Note: There are no checks on the element length other than
6325 * having to fit into the given data and being large enough for the
6326 * byte array to match.
6327 */
6328 static inline const u8 *
cfg80211_find_ie_match(u8 eid,const u8 * ies,unsigned int len,const u8 * match,unsigned int match_len,unsigned int match_offset)6329 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
6330 const u8 *match, unsigned int match_len,
6331 unsigned int match_offset)
6332 {
6333 /* match_offset can't be smaller than 2, unless match_len is
6334 * zero, in which case match_offset must be zero as well.
6335 */
6336 if (WARN_ON((match_len && match_offset < 2) ||
6337 (!match_len && match_offset)))
6338 return NULL;
6339
6340 return (void *)cfg80211_find_elem_match(eid, ies, len,
6341 match, match_len,
6342 match_offset ?
6343 match_offset - 2 : 0);
6344 }
6345
6346 /**
6347 * cfg80211_find_elem - find information element in data
6348 *
6349 * @eid: element ID
6350 * @ies: data consisting of IEs
6351 * @len: length of data
6352 *
6353 * Return: %NULL if the element ID could not be found or if
6354 * the element is invalid (claims to be longer than the given
6355 * data) or if the byte array doesn't match; otherwise return the
6356 * requested element struct.
6357 *
6358 * Note: There are no checks on the element length other than
6359 * having to fit into the given data.
6360 */
6361 static inline const struct element *
cfg80211_find_elem(u8 eid,const u8 * ies,int len)6362 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
6363 {
6364 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
6365 }
6366
6367 /**
6368 * cfg80211_find_ie - find information element in data
6369 *
6370 * @eid: element ID
6371 * @ies: data consisting of IEs
6372 * @len: length of data
6373 *
6374 * Return: %NULL if the element ID could not be found or if
6375 * the element is invalid (claims to be longer than the given
6376 * data), or a pointer to the first byte of the requested
6377 * element, that is the byte containing the element ID.
6378 *
6379 * Note: There are no checks on the element length other than
6380 * having to fit into the given data.
6381 */
cfg80211_find_ie(u8 eid,const u8 * ies,int len)6382 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
6383 {
6384 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
6385 }
6386
6387 /**
6388 * cfg80211_find_ext_elem - find information element with EID Extension in data
6389 *
6390 * @ext_eid: element ID Extension
6391 * @ies: data consisting of IEs
6392 * @len: length of data
6393 *
6394 * Return: %NULL if the etended element could not be found or if
6395 * the element is invalid (claims to be longer than the given
6396 * data) or if the byte array doesn't match; otherwise return the
6397 * requested element struct.
6398 *
6399 * Note: There are no checks on the element length other than
6400 * having to fit into the given data.
6401 */
6402 static inline const struct element *
cfg80211_find_ext_elem(u8 ext_eid,const u8 * ies,int len)6403 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
6404 {
6405 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
6406 &ext_eid, 1, 0);
6407 }
6408
6409 /**
6410 * cfg80211_find_ext_ie - find information element with EID Extension in data
6411 *
6412 * @ext_eid: element ID Extension
6413 * @ies: data consisting of IEs
6414 * @len: length of data
6415 *
6416 * Return: %NULL if the extended element ID could not be found or if
6417 * the element is invalid (claims to be longer than the given
6418 * data), or a pointer to the first byte of the requested
6419 * element, that is the byte containing the element ID.
6420 *
6421 * Note: There are no checks on the element length other than
6422 * having to fit into the given data.
6423 */
cfg80211_find_ext_ie(u8 ext_eid,const u8 * ies,int len)6424 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
6425 {
6426 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
6427 &ext_eid, 1, 2);
6428 }
6429
6430 /**
6431 * cfg80211_find_vendor_elem - find vendor specific information element in data
6432 *
6433 * @oui: vendor OUI
6434 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
6435 * @ies: data consisting of IEs
6436 * @len: length of data
6437 *
6438 * Return: %NULL if the vendor specific element ID could not be found or if the
6439 * element is invalid (claims to be longer than the given data); otherwise
6440 * return the element structure for the requested element.
6441 *
6442 * Note: There are no checks on the element length other than having to fit into
6443 * the given data.
6444 */
6445 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
6446 const u8 *ies,
6447 unsigned int len);
6448
6449 /**
6450 * cfg80211_find_vendor_ie - find vendor specific information element in data
6451 *
6452 * @oui: vendor OUI
6453 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
6454 * @ies: data consisting of IEs
6455 * @len: length of data
6456 *
6457 * Return: %NULL if the vendor specific element ID could not be found or if the
6458 * element is invalid (claims to be longer than the given data), or a pointer to
6459 * the first byte of the requested element, that is the byte containing the
6460 * element ID.
6461 *
6462 * Note: There are no checks on the element length other than having to fit into
6463 * the given data.
6464 */
6465 static inline const u8 *
cfg80211_find_vendor_ie(unsigned int oui,int oui_type,const u8 * ies,unsigned int len)6466 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
6467 const u8 *ies, unsigned int len)
6468 {
6469 return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
6470 }
6471
6472 /**
6473 * cfg80211_send_layer2_update - send layer 2 update frame
6474 *
6475 * @dev: network device
6476 * @addr: STA MAC address
6477 *
6478 * Wireless drivers can use this function to update forwarding tables in bridge
6479 * devices upon STA association.
6480 */
6481 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
6482
6483 /**
6484 * DOC: Regulatory enforcement infrastructure
6485 *
6486 * TODO
6487 */
6488
6489 /**
6490 * regulatory_hint - driver hint to the wireless core a regulatory domain
6491 * @wiphy: the wireless device giving the hint (used only for reporting
6492 * conflicts)
6493 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
6494 * should be in. If @rd is set this should be NULL. Note that if you
6495 * set this to NULL you should still set rd->alpha2 to some accepted
6496 * alpha2.
6497 *
6498 * Wireless drivers can use this function to hint to the wireless core
6499 * what it believes should be the current regulatory domain by
6500 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
6501 * domain should be in or by providing a completely build regulatory domain.
6502 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
6503 * for a regulatory domain structure for the respective country.
6504 *
6505 * The wiphy must have been registered to cfg80211 prior to this call.
6506 * For cfg80211 drivers this means you must first use wiphy_register(),
6507 * for mac80211 drivers you must first use ieee80211_register_hw().
6508 *
6509 * Drivers should check the return value, its possible you can get
6510 * an -ENOMEM.
6511 *
6512 * Return: 0 on success. -ENOMEM.
6513 */
6514 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
6515
6516 /**
6517 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
6518 * @wiphy: the wireless device we want to process the regulatory domain on
6519 * @rd: the regulatory domain informatoin to use for this wiphy
6520 *
6521 * Set the regulatory domain information for self-managed wiphys, only they
6522 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
6523 * information.
6524 *
6525 * Return: 0 on success. -EINVAL, -EPERM
6526 */
6527 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
6528 struct ieee80211_regdomain *rd);
6529
6530 /**
6531 * regulatory_set_wiphy_regd_sync - set regdom for self-managed drivers
6532 * @wiphy: the wireless device we want to process the regulatory domain on
6533 * @rd: the regulatory domain information to use for this wiphy
6534 *
6535 * This functions requires the RTNL and the wiphy mutex to be held and
6536 * applies the new regdomain synchronously to this wiphy. For more details
6537 * see regulatory_set_wiphy_regd().
6538 *
6539 * Return: 0 on success. -EINVAL, -EPERM
6540 */
6541 int regulatory_set_wiphy_regd_sync(struct wiphy *wiphy,
6542 struct ieee80211_regdomain *rd);
6543
6544 /**
6545 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
6546 * @wiphy: the wireless device we want to process the regulatory domain on
6547 * @regd: the custom regulatory domain to use for this wiphy
6548 *
6549 * Drivers can sometimes have custom regulatory domains which do not apply
6550 * to a specific country. Drivers can use this to apply such custom regulatory
6551 * domains. This routine must be called prior to wiphy registration. The
6552 * custom regulatory domain will be trusted completely and as such previous
6553 * default channel settings will be disregarded. If no rule is found for a
6554 * channel on the regulatory domain the channel will be disabled.
6555 * Drivers using this for a wiphy should also set the wiphy flag
6556 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
6557 * that called this helper.
6558 */
6559 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
6560 const struct ieee80211_regdomain *regd);
6561
6562 /**
6563 * freq_reg_info - get regulatory information for the given frequency
6564 * @wiphy: the wiphy for which we want to process this rule for
6565 * @center_freq: Frequency in KHz for which we want regulatory information for
6566 *
6567 * Use this function to get the regulatory rule for a specific frequency on
6568 * a given wireless device. If the device has a specific regulatory domain
6569 * it wants to follow we respect that unless a country IE has been received
6570 * and processed already.
6571 *
6572 * Return: A valid pointer, or, when an error occurs, for example if no rule
6573 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
6574 * check and PTR_ERR() to obtain the numeric return value. The numeric return
6575 * value will be -ERANGE if we determine the given center_freq does not even
6576 * have a regulatory rule for a frequency range in the center_freq's band.
6577 * See freq_in_rule_band() for our current definition of a band -- this is
6578 * purely subjective and right now it's 802.11 specific.
6579 */
6580 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
6581 u32 center_freq);
6582
6583 /**
6584 * reg_initiator_name - map regulatory request initiator enum to name
6585 * @initiator: the regulatory request initiator
6586 *
6587 * You can use this to map the regulatory request initiator enum to a
6588 * proper string representation.
6589 */
6590 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
6591
6592 /**
6593 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
6594 * @wiphy: wiphy for which pre-CAC capability is checked.
6595 *
6596 * Pre-CAC is allowed only in some regdomains (notable ETSI).
6597 */
6598 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
6599
6600 /**
6601 * DOC: Internal regulatory db functions
6602 *
6603 */
6604
6605 /**
6606 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
6607 * Regulatory self-managed driver can use it to proactively
6608 *
6609 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
6610 * @freq: the freqency(in MHz) to be queried.
6611 * @rule: pointer to store the wmm rule from the regulatory db.
6612 *
6613 * Self-managed wireless drivers can use this function to query
6614 * the internal regulatory database to check whether the given
6615 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
6616 *
6617 * Drivers should check the return value, its possible you can get
6618 * an -ENODATA.
6619 *
6620 * Return: 0 on success. -ENODATA.
6621 */
6622 int reg_query_regdb_wmm(char *alpha2, int freq,
6623 struct ieee80211_reg_rule *rule);
6624
6625 /*
6626 * callbacks for asynchronous cfg80211 methods, notification
6627 * functions and BSS handling helpers
6628 */
6629
6630 /**
6631 * cfg80211_scan_done - notify that scan finished
6632 *
6633 * @request: the corresponding scan request
6634 * @info: information about the completed scan
6635 */
6636 void cfg80211_scan_done(struct cfg80211_scan_request *request,
6637 struct cfg80211_scan_info *info);
6638
6639 /**
6640 * cfg80211_sched_scan_results - notify that new scan results are available
6641 *
6642 * @wiphy: the wiphy which got scheduled scan results
6643 * @reqid: identifier for the related scheduled scan request
6644 */
6645 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
6646
6647 /**
6648 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
6649 *
6650 * @wiphy: the wiphy on which the scheduled scan stopped
6651 * @reqid: identifier for the related scheduled scan request
6652 *
6653 * The driver can call this function to inform cfg80211 that the
6654 * scheduled scan had to be stopped, for whatever reason. The driver
6655 * is then called back via the sched_scan_stop operation when done.
6656 */
6657 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
6658
6659 /**
6660 * cfg80211_sched_scan_stopped_locked - notify that the scheduled scan has stopped
6661 *
6662 * @wiphy: the wiphy on which the scheduled scan stopped
6663 * @reqid: identifier for the related scheduled scan request
6664 *
6665 * The driver can call this function to inform cfg80211 that the
6666 * scheduled scan had to be stopped, for whatever reason. The driver
6667 * is then called back via the sched_scan_stop operation when done.
6668 * This function should be called with the wiphy mutex held.
6669 */
6670 void cfg80211_sched_scan_stopped_locked(struct wiphy *wiphy, u64 reqid);
6671
6672 /**
6673 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
6674 * @wiphy: the wiphy reporting the BSS
6675 * @data: the BSS metadata
6676 * @mgmt: the management frame (probe response or beacon)
6677 * @len: length of the management frame
6678 * @gfp: context flags
6679 *
6680 * This informs cfg80211 that BSS information was found and
6681 * the BSS should be updated/added.
6682 *
6683 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6684 * Or %NULL on error.
6685 */
6686 struct cfg80211_bss * __must_check
6687 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
6688 struct cfg80211_inform_bss *data,
6689 struct ieee80211_mgmt *mgmt, size_t len,
6690 gfp_t gfp);
6691
6692 static inline struct cfg80211_bss * __must_check
cfg80211_inform_bss_width_frame(struct wiphy * wiphy,struct ieee80211_channel * rx_channel,enum nl80211_bss_scan_width scan_width,struct ieee80211_mgmt * mgmt,size_t len,s32 signal,gfp_t gfp)6693 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
6694 struct ieee80211_channel *rx_channel,
6695 enum nl80211_bss_scan_width scan_width,
6696 struct ieee80211_mgmt *mgmt, size_t len,
6697 s32 signal, gfp_t gfp)
6698 {
6699 struct cfg80211_inform_bss data = {
6700 .chan = rx_channel,
6701 .scan_width = scan_width,
6702 .signal = signal,
6703 };
6704
6705 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6706 }
6707
6708 static inline struct cfg80211_bss * __must_check
cfg80211_inform_bss_frame(struct wiphy * wiphy,struct ieee80211_channel * rx_channel,struct ieee80211_mgmt * mgmt,size_t len,s32 signal,gfp_t gfp)6709 cfg80211_inform_bss_frame(struct wiphy *wiphy,
6710 struct ieee80211_channel *rx_channel,
6711 struct ieee80211_mgmt *mgmt, size_t len,
6712 s32 signal, gfp_t gfp)
6713 {
6714 struct cfg80211_inform_bss data = {
6715 .chan = rx_channel,
6716 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6717 .signal = signal,
6718 };
6719
6720 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
6721 }
6722
6723 /**
6724 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
6725 * @bssid: transmitter BSSID
6726 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
6727 * @mbssid_index: BSSID index, taken from Multiple BSSID index element
6728 * @new_bssid: calculated nontransmitted BSSID
6729 */
cfg80211_gen_new_bssid(const u8 * bssid,u8 max_bssid,u8 mbssid_index,u8 * new_bssid)6730 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
6731 u8 mbssid_index, u8 *new_bssid)
6732 {
6733 u64 bssid_u64 = ether_addr_to_u64(bssid);
6734 u64 mask = GENMASK_ULL(max_bssid - 1, 0);
6735 u64 new_bssid_u64;
6736
6737 new_bssid_u64 = bssid_u64 & ~mask;
6738
6739 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
6740
6741 u64_to_ether_addr(new_bssid_u64, new_bssid);
6742 }
6743
6744 /**
6745 * cfg80211_is_element_inherited - returns if element ID should be inherited
6746 * @element: element to check
6747 * @non_inherit_element: non inheritance element
6748 */
6749 bool cfg80211_is_element_inherited(const struct element *element,
6750 const struct element *non_inherit_element);
6751
6752 /**
6753 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
6754 * @ie: ies
6755 * @ielen: length of IEs
6756 * @mbssid_elem: current MBSSID element
6757 * @sub_elem: current MBSSID subelement (profile)
6758 * @merged_ie: location of the merged profile
6759 * @max_copy_len: max merged profile length
6760 */
6761 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
6762 const struct element *mbssid_elem,
6763 const struct element *sub_elem,
6764 u8 *merged_ie, size_t max_copy_len);
6765
6766 /**
6767 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
6768 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
6769 * from a beacon or probe response
6770 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
6771 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
6772 */
6773 enum cfg80211_bss_frame_type {
6774 CFG80211_BSS_FTYPE_UNKNOWN,
6775 CFG80211_BSS_FTYPE_BEACON,
6776 CFG80211_BSS_FTYPE_PRESP,
6777 };
6778
6779 /**
6780 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
6781 *
6782 * @wiphy: the wiphy reporting the BSS
6783 * @data: the BSS metadata
6784 * @ftype: frame type (if known)
6785 * @bssid: the BSSID of the BSS
6786 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
6787 * @capability: the capability field sent by the peer
6788 * @beacon_interval: the beacon interval announced by the peer
6789 * @ie: additional IEs sent by the peer
6790 * @ielen: length of the additional IEs
6791 * @gfp: context flags
6792 *
6793 * This informs cfg80211 that BSS information was found and
6794 * the BSS should be updated/added.
6795 *
6796 * Return: A referenced struct, must be released with cfg80211_put_bss()!
6797 * Or %NULL on error.
6798 */
6799 struct cfg80211_bss * __must_check
6800 cfg80211_inform_bss_data(struct wiphy *wiphy,
6801 struct cfg80211_inform_bss *data,
6802 enum cfg80211_bss_frame_type ftype,
6803 const u8 *bssid, u64 tsf, u16 capability,
6804 u16 beacon_interval, const u8 *ie, size_t ielen,
6805 gfp_t gfp);
6806
6807 static inline struct cfg80211_bss * __must_check
cfg80211_inform_bss_width(struct wiphy * wiphy,struct ieee80211_channel * rx_channel,enum nl80211_bss_scan_width scan_width,enum cfg80211_bss_frame_type ftype,const u8 * bssid,u64 tsf,u16 capability,u16 beacon_interval,const u8 * ie,size_t ielen,s32 signal,gfp_t gfp)6808 cfg80211_inform_bss_width(struct wiphy *wiphy,
6809 struct ieee80211_channel *rx_channel,
6810 enum nl80211_bss_scan_width scan_width,
6811 enum cfg80211_bss_frame_type ftype,
6812 const u8 *bssid, u64 tsf, u16 capability,
6813 u16 beacon_interval, const u8 *ie, size_t ielen,
6814 s32 signal, gfp_t gfp)
6815 {
6816 struct cfg80211_inform_bss data = {
6817 .chan = rx_channel,
6818 .scan_width = scan_width,
6819 .signal = signal,
6820 };
6821
6822 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6823 capability, beacon_interval, ie, ielen,
6824 gfp);
6825 }
6826
6827 static inline struct cfg80211_bss * __must_check
cfg80211_inform_bss(struct wiphy * wiphy,struct ieee80211_channel * rx_channel,enum cfg80211_bss_frame_type ftype,const u8 * bssid,u64 tsf,u16 capability,u16 beacon_interval,const u8 * ie,size_t ielen,s32 signal,gfp_t gfp)6828 cfg80211_inform_bss(struct wiphy *wiphy,
6829 struct ieee80211_channel *rx_channel,
6830 enum cfg80211_bss_frame_type ftype,
6831 const u8 *bssid, u64 tsf, u16 capability,
6832 u16 beacon_interval, const u8 *ie, size_t ielen,
6833 s32 signal, gfp_t gfp)
6834 {
6835 struct cfg80211_inform_bss data = {
6836 .chan = rx_channel,
6837 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
6838 .signal = signal,
6839 };
6840
6841 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
6842 capability, beacon_interval, ie, ielen,
6843 gfp);
6844 }
6845
6846 /**
6847 * cfg80211_get_bss - get a BSS reference
6848 * @wiphy: the wiphy this BSS struct belongs to
6849 * @channel: the channel to search on (or %NULL)
6850 * @bssid: the desired BSSID (or %NULL)
6851 * @ssid: the desired SSID (or %NULL)
6852 * @ssid_len: length of the SSID (or 0)
6853 * @bss_type: type of BSS, see &enum ieee80211_bss_type
6854 * @privacy: privacy filter, see &enum ieee80211_privacy
6855 */
6856 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
6857 struct ieee80211_channel *channel,
6858 const u8 *bssid,
6859 const u8 *ssid, size_t ssid_len,
6860 enum ieee80211_bss_type bss_type,
6861 enum ieee80211_privacy privacy);
6862 static inline struct cfg80211_bss *
cfg80211_get_ibss(struct wiphy * wiphy,struct ieee80211_channel * channel,const u8 * ssid,size_t ssid_len)6863 cfg80211_get_ibss(struct wiphy *wiphy,
6864 struct ieee80211_channel *channel,
6865 const u8 *ssid, size_t ssid_len)
6866 {
6867 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
6868 IEEE80211_BSS_TYPE_IBSS,
6869 IEEE80211_PRIVACY_ANY);
6870 }
6871
6872 /**
6873 * cfg80211_ref_bss - reference BSS struct
6874 * @wiphy: the wiphy this BSS struct belongs to
6875 * @bss: the BSS struct to reference
6876 *
6877 * Increments the refcount of the given BSS struct.
6878 */
6879 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6880
6881 /**
6882 * cfg80211_put_bss - unref BSS struct
6883 * @wiphy: the wiphy this BSS struct belongs to
6884 * @bss: the BSS struct
6885 *
6886 * Decrements the refcount of the given BSS struct.
6887 */
6888 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6889
6890 /**
6891 * cfg80211_unlink_bss - unlink BSS from internal data structures
6892 * @wiphy: the wiphy
6893 * @bss: the bss to remove
6894 *
6895 * This function removes the given BSS from the internal data structures
6896 * thereby making it no longer show up in scan results etc. Use this
6897 * function when you detect a BSS is gone. Normally BSSes will also time
6898 * out, so it is not necessary to use this function at all.
6899 */
6900 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
6901
6902 /**
6903 * cfg80211_bss_iter - iterate all BSS entries
6904 *
6905 * This function iterates over the BSS entries associated with the given wiphy
6906 * and calls the callback for the iterated BSS. The iterator function is not
6907 * allowed to call functions that might modify the internal state of the BSS DB.
6908 *
6909 * @wiphy: the wiphy
6910 * @chandef: if given, the iterator function will be called only if the channel
6911 * of the currently iterated BSS is a subset of the given channel.
6912 * @iter: the iterator function to call
6913 * @iter_data: an argument to the iterator function
6914 */
6915 void cfg80211_bss_iter(struct wiphy *wiphy,
6916 struct cfg80211_chan_def *chandef,
6917 void (*iter)(struct wiphy *wiphy,
6918 struct cfg80211_bss *bss,
6919 void *data),
6920 void *iter_data);
6921
6922 static inline enum nl80211_bss_scan_width
cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def * chandef)6923 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
6924 {
6925 switch (chandef->width) {
6926 case NL80211_CHAN_WIDTH_5:
6927 return NL80211_BSS_CHAN_WIDTH_5;
6928 case NL80211_CHAN_WIDTH_10:
6929 return NL80211_BSS_CHAN_WIDTH_10;
6930 default:
6931 return NL80211_BSS_CHAN_WIDTH_20;
6932 }
6933 }
6934
6935 /**
6936 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
6937 * @dev: network device
6938 * @buf: authentication frame (header + body)
6939 * @len: length of the frame data
6940 *
6941 * This function is called whenever an authentication, disassociation or
6942 * deauthentication frame has been received and processed in station mode.
6943 * After being asked to authenticate via cfg80211_ops::auth() the driver must
6944 * call either this function or cfg80211_auth_timeout().
6945 * After being asked to associate via cfg80211_ops::assoc() the driver must
6946 * call either this function or cfg80211_auth_timeout().
6947 * While connected, the driver must calls this for received and processed
6948 * disassociation and deauthentication frames. If the frame couldn't be used
6949 * because it was unprotected, the driver must call the function
6950 * cfg80211_rx_unprot_mlme_mgmt() instead.
6951 *
6952 * This function may sleep. The caller must hold the corresponding wdev's mutex.
6953 */
6954 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
6955
6956 /**
6957 * cfg80211_auth_timeout - notification of timed out authentication
6958 * @dev: network device
6959 * @addr: The MAC address of the device with which the authentication timed out
6960 *
6961 * This function may sleep. The caller must hold the corresponding wdev's
6962 * mutex.
6963 */
6964 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
6965
6966 /**
6967 * struct cfg80211_rx_assoc_resp - association response data
6968 * @bss: the BSS that association was requested with, ownership of the pointer
6969 * moves to cfg80211 in the call to cfg80211_rx_assoc_resp()
6970 * @buf: (Re)Association Response frame (header + body)
6971 * @len: length of the frame data
6972 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
6973 * as the AC bitmap in the QoS info field
6974 * @req_ies: information elements from the (Re)Association Request frame
6975 * @req_ies_len: length of req_ies data
6976 * @ap_mld_addr: AP MLD address (in case of MLO)
6977 * @links: per-link information indexed by link ID, use links[0] for
6978 * non-MLO connections
6979 */
6980 struct cfg80211_rx_assoc_resp {
6981 const u8 *buf;
6982 size_t len;
6983 const u8 *req_ies;
6984 size_t req_ies_len;
6985 int uapsd_queues;
6986 const u8 *ap_mld_addr;
6987 struct {
6988 const u8 *addr;
6989 struct cfg80211_bss *bss;
6990 } links[IEEE80211_MLD_MAX_NUM_LINKS];
6991 };
6992
6993 /**
6994 * cfg80211_rx_assoc_resp - notification of processed association response
6995 * @dev: network device
6996 * @data: association response data, &struct cfg80211_rx_assoc_resp
6997 *
6998 * After being asked to associate via cfg80211_ops::assoc() the driver must
6999 * call either this function or cfg80211_auth_timeout().
7000 *
7001 * This function may sleep. The caller must hold the corresponding wdev's mutex.
7002 */
7003 void cfg80211_rx_assoc_resp(struct net_device *dev,
7004 struct cfg80211_rx_assoc_resp *data);
7005
7006 /**
7007 * struct cfg80211_assoc_failure - association failure data
7008 * @ap_mld_addr: AP MLD address, or %NULL
7009 * @bss: list of BSSes, must use entry 0 for non-MLO connections
7010 * (@ap_mld_addr is %NULL)
7011 * @timeout: indicates the association failed due to timeout, otherwise
7012 * the association was abandoned for a reason reported through some
7013 * other API (e.g. deauth RX)
7014 */
7015 struct cfg80211_assoc_failure {
7016 const u8 *ap_mld_addr;
7017 struct cfg80211_bss *bss[IEEE80211_MLD_MAX_NUM_LINKS];
7018 bool timeout;
7019 };
7020
7021 /**
7022 * cfg80211_assoc_failure - notification of association failure
7023 * @dev: network device
7024 * @data: data describing the association failure
7025 *
7026 * This function may sleep. The caller must hold the corresponding wdev's mutex.
7027 */
7028 void cfg80211_assoc_failure(struct net_device *dev,
7029 struct cfg80211_assoc_failure *data);
7030
7031 /**
7032 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
7033 * @dev: network device
7034 * @buf: 802.11 frame (header + body)
7035 * @len: length of the frame data
7036 * @reconnect: immediate reconnect is desired (include the nl80211 attribute)
7037 *
7038 * This function is called whenever deauthentication has been processed in
7039 * station mode. This includes both received deauthentication frames and
7040 * locally generated ones. This function may sleep. The caller must hold the
7041 * corresponding wdev's mutex.
7042 */
7043 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len,
7044 bool reconnect);
7045
7046 /**
7047 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
7048 * @dev: network device
7049 * @buf: received management frame (header + body)
7050 * @len: length of the frame data
7051 *
7052 * This function is called whenever a received deauthentication or dissassoc
7053 * frame has been dropped in station mode because of MFP being used but the
7054 * frame was not protected. This is also used to notify reception of a Beacon
7055 * frame that was dropped because it did not include a valid MME MIC while
7056 * beacon protection was enabled (BIGTK configured in station mode).
7057 *
7058 * This function may sleep.
7059 */
7060 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
7061 const u8 *buf, size_t len);
7062
7063 /**
7064 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
7065 * @dev: network device
7066 * @addr: The source MAC address of the frame
7067 * @key_type: The key type that the received frame used
7068 * @key_id: Key identifier (0..3). Can be -1 if missing.
7069 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
7070 * @gfp: allocation flags
7071 *
7072 * This function is called whenever the local MAC detects a MIC failure in a
7073 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
7074 * primitive.
7075 */
7076 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
7077 enum nl80211_key_type key_type, int key_id,
7078 const u8 *tsc, gfp_t gfp);
7079
7080 /**
7081 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
7082 *
7083 * @dev: network device
7084 * @bssid: the BSSID of the IBSS joined
7085 * @channel: the channel of the IBSS joined
7086 * @gfp: allocation flags
7087 *
7088 * This function notifies cfg80211 that the device joined an IBSS or
7089 * switched to a different BSSID. Before this function can be called,
7090 * either a beacon has to have been received from the IBSS, or one of
7091 * the cfg80211_inform_bss{,_frame} functions must have been called
7092 * with the locally generated beacon -- this guarantees that there is
7093 * always a scan result for this IBSS. cfg80211 will handle the rest.
7094 */
7095 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
7096 struct ieee80211_channel *channel, gfp_t gfp);
7097
7098 /**
7099 * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer
7100 * candidate
7101 *
7102 * @dev: network device
7103 * @macaddr: the MAC address of the new candidate
7104 * @ie: information elements advertised by the peer candidate
7105 * @ie_len: length of the information elements buffer
7106 * @sig_dbm: signal level in dBm
7107 * @gfp: allocation flags
7108 *
7109 * This function notifies cfg80211 that the mesh peer candidate has been
7110 * detected, most likely via a beacon or, less likely, via a probe response.
7111 * cfg80211 then sends a notification to userspace.
7112 */
7113 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
7114 const u8 *macaddr, const u8 *ie, u8 ie_len,
7115 int sig_dbm, gfp_t gfp);
7116
7117 /**
7118 * DOC: RFkill integration
7119 *
7120 * RFkill integration in cfg80211 is almost invisible to drivers,
7121 * as cfg80211 automatically registers an rfkill instance for each
7122 * wireless device it knows about. Soft kill is also translated
7123 * into disconnecting and turning all interfaces off, drivers are
7124 * expected to turn off the device when all interfaces are down.
7125 *
7126 * However, devices may have a hard RFkill line, in which case they
7127 * also need to interact with the rfkill subsystem, via cfg80211.
7128 * They can do this with a few helper functions documented here.
7129 */
7130
7131 /**
7132 * wiphy_rfkill_set_hw_state_reason - notify cfg80211 about hw block state
7133 * @wiphy: the wiphy
7134 * @blocked: block status
7135 * @reason: one of reasons in &enum rfkill_hard_block_reasons
7136 */
7137 void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked,
7138 enum rfkill_hard_block_reasons reason);
7139
wiphy_rfkill_set_hw_state(struct wiphy * wiphy,bool blocked)7140 static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked)
7141 {
7142 wiphy_rfkill_set_hw_state_reason(wiphy, blocked,
7143 RFKILL_HARD_BLOCK_SIGNAL);
7144 }
7145
7146 /**
7147 * wiphy_rfkill_start_polling - start polling rfkill
7148 * @wiphy: the wiphy
7149 */
7150 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
7151
7152 /**
7153 * wiphy_rfkill_stop_polling - stop polling rfkill
7154 * @wiphy: the wiphy
7155 */
wiphy_rfkill_stop_polling(struct wiphy * wiphy)7156 static inline void wiphy_rfkill_stop_polling(struct wiphy *wiphy)
7157 {
7158 rfkill_pause_polling(wiphy->rfkill);
7159 }
7160
7161 /**
7162 * DOC: Vendor commands
7163 *
7164 * Occasionally, there are special protocol or firmware features that
7165 * can't be implemented very openly. For this and similar cases, the
7166 * vendor command functionality allows implementing the features with
7167 * (typically closed-source) userspace and firmware, using nl80211 as
7168 * the configuration mechanism.
7169 *
7170 * A driver supporting vendor commands must register them as an array
7171 * in struct wiphy, with handlers for each one, each command has an
7172 * OUI and sub command ID to identify it.
7173 *
7174 * Note that this feature should not be (ab)used to implement protocol
7175 * features that could openly be shared across drivers. In particular,
7176 * it must never be required to use vendor commands to implement any
7177 * "normal" functionality that higher-level userspace like connection
7178 * managers etc. need.
7179 */
7180
7181 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
7182 enum nl80211_commands cmd,
7183 enum nl80211_attrs attr,
7184 int approxlen);
7185
7186 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
7187 struct wireless_dev *wdev,
7188 enum nl80211_commands cmd,
7189 enum nl80211_attrs attr,
7190 unsigned int portid,
7191 int vendor_event_idx,
7192 int approxlen, gfp_t gfp);
7193
7194 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
7195
7196 /**
7197 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
7198 * @wiphy: the wiphy
7199 * @approxlen: an upper bound of the length of the data that will
7200 * be put into the skb
7201 *
7202 * This function allocates and pre-fills an skb for a reply to
7203 * a vendor command. Since it is intended for a reply, calling
7204 * it outside of a vendor command's doit() operation is invalid.
7205 *
7206 * The returned skb is pre-filled with some identifying data in
7207 * a way that any data that is put into the skb (with skb_put(),
7208 * nla_put() or similar) will end up being within the
7209 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
7210 * with the skb is adding data for the corresponding userspace tool
7211 * which can then read that data out of the vendor data attribute.
7212 * You must not modify the skb in any other way.
7213 *
7214 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
7215 * its error code as the result of the doit() operation.
7216 *
7217 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7218 */
7219 static inline struct sk_buff *
cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy * wiphy,int approxlen)7220 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
7221 {
7222 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
7223 NL80211_ATTR_VENDOR_DATA, approxlen);
7224 }
7225
7226 /**
7227 * cfg80211_vendor_cmd_reply - send the reply skb
7228 * @skb: The skb, must have been allocated with
7229 * cfg80211_vendor_cmd_alloc_reply_skb()
7230 *
7231 * Since calling this function will usually be the last thing
7232 * before returning from the vendor command doit() you should
7233 * return the error code. Note that this function consumes the
7234 * skb regardless of the return value.
7235 *
7236 * Return: An error code or 0 on success.
7237 */
7238 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
7239
7240 /**
7241 * cfg80211_vendor_cmd_get_sender - get the current sender netlink ID
7242 * @wiphy: the wiphy
7243 *
7244 * Return the current netlink port ID in a vendor command handler.
7245 * Valid to call only there.
7246 */
7247 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
7248
7249 /**
7250 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
7251 * @wiphy: the wiphy
7252 * @wdev: the wireless device
7253 * @event_idx: index of the vendor event in the wiphy's vendor_events
7254 * @approxlen: an upper bound of the length of the data that will
7255 * be put into the skb
7256 * @gfp: allocation flags
7257 *
7258 * This function allocates and pre-fills an skb for an event on the
7259 * vendor-specific multicast group.
7260 *
7261 * If wdev != NULL, both the ifindex and identifier of the specified
7262 * wireless device are added to the event message before the vendor data
7263 * attribute.
7264 *
7265 * When done filling the skb, call cfg80211_vendor_event() with the
7266 * skb to send the event.
7267 *
7268 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7269 */
7270 static inline struct sk_buff *
cfg80211_vendor_event_alloc(struct wiphy * wiphy,struct wireless_dev * wdev,int approxlen,int event_idx,gfp_t gfp)7271 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
7272 int approxlen, int event_idx, gfp_t gfp)
7273 {
7274 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
7275 NL80211_ATTR_VENDOR_DATA,
7276 0, event_idx, approxlen, gfp);
7277 }
7278
7279 /**
7280 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
7281 * @wiphy: the wiphy
7282 * @wdev: the wireless device
7283 * @event_idx: index of the vendor event in the wiphy's vendor_events
7284 * @portid: port ID of the receiver
7285 * @approxlen: an upper bound of the length of the data that will
7286 * be put into the skb
7287 * @gfp: allocation flags
7288 *
7289 * This function allocates and pre-fills an skb for an event to send to
7290 * a specific (userland) socket. This socket would previously have been
7291 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
7292 * care to register a netlink notifier to see when the socket closes.
7293 *
7294 * If wdev != NULL, both the ifindex and identifier of the specified
7295 * wireless device are added to the event message before the vendor data
7296 * attribute.
7297 *
7298 * When done filling the skb, call cfg80211_vendor_event() with the
7299 * skb to send the event.
7300 *
7301 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7302 */
7303 static inline struct sk_buff *
cfg80211_vendor_event_alloc_ucast(struct wiphy * wiphy,struct wireless_dev * wdev,unsigned int portid,int approxlen,int event_idx,gfp_t gfp)7304 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
7305 struct wireless_dev *wdev,
7306 unsigned int portid, int approxlen,
7307 int event_idx, gfp_t gfp)
7308 {
7309 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
7310 NL80211_ATTR_VENDOR_DATA,
7311 portid, event_idx, approxlen, gfp);
7312 }
7313
7314 /**
7315 * cfg80211_vendor_event - send the event
7316 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
7317 * @gfp: allocation flags
7318 *
7319 * This function sends the given @skb, which must have been allocated
7320 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
7321 */
cfg80211_vendor_event(struct sk_buff * skb,gfp_t gfp)7322 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
7323 {
7324 __cfg80211_send_event_skb(skb, gfp);
7325 }
7326
7327 #ifdef CONFIG_NL80211_TESTMODE
7328 /**
7329 * DOC: Test mode
7330 *
7331 * Test mode is a set of utility functions to allow drivers to
7332 * interact with driver-specific tools to aid, for instance,
7333 * factory programming.
7334 *
7335 * This chapter describes how drivers interact with it, for more
7336 * information see the nl80211 book's chapter on it.
7337 */
7338
7339 /**
7340 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
7341 * @wiphy: the wiphy
7342 * @approxlen: an upper bound of the length of the data that will
7343 * be put into the skb
7344 *
7345 * This function allocates and pre-fills an skb for a reply to
7346 * the testmode command. Since it is intended for a reply, calling
7347 * it outside of the @testmode_cmd operation is invalid.
7348 *
7349 * The returned skb is pre-filled with the wiphy index and set up in
7350 * a way that any data that is put into the skb (with skb_put(),
7351 * nla_put() or similar) will end up being within the
7352 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
7353 * with the skb is adding data for the corresponding userspace tool
7354 * which can then read that data out of the testdata attribute. You
7355 * must not modify the skb in any other way.
7356 *
7357 * When done, call cfg80211_testmode_reply() with the skb and return
7358 * its error code as the result of the @testmode_cmd operation.
7359 *
7360 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7361 */
7362 static inline struct sk_buff *
cfg80211_testmode_alloc_reply_skb(struct wiphy * wiphy,int approxlen)7363 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
7364 {
7365 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
7366 NL80211_ATTR_TESTDATA, approxlen);
7367 }
7368
7369 /**
7370 * cfg80211_testmode_reply - send the reply skb
7371 * @skb: The skb, must have been allocated with
7372 * cfg80211_testmode_alloc_reply_skb()
7373 *
7374 * Since calling this function will usually be the last thing
7375 * before returning from the @testmode_cmd you should return
7376 * the error code. Note that this function consumes the skb
7377 * regardless of the return value.
7378 *
7379 * Return: An error code or 0 on success.
7380 */
cfg80211_testmode_reply(struct sk_buff * skb)7381 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
7382 {
7383 return cfg80211_vendor_cmd_reply(skb);
7384 }
7385
7386 /**
7387 * cfg80211_testmode_alloc_event_skb - allocate testmode event
7388 * @wiphy: the wiphy
7389 * @approxlen: an upper bound of the length of the data that will
7390 * be put into the skb
7391 * @gfp: allocation flags
7392 *
7393 * This function allocates and pre-fills an skb for an event on the
7394 * testmode multicast group.
7395 *
7396 * The returned skb is set up in the same way as with
7397 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
7398 * there, you should simply add data to it that will then end up in the
7399 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
7400 * in any other way.
7401 *
7402 * When done filling the skb, call cfg80211_testmode_event() with the
7403 * skb to send the event.
7404 *
7405 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
7406 */
7407 static inline struct sk_buff *
cfg80211_testmode_alloc_event_skb(struct wiphy * wiphy,int approxlen,gfp_t gfp)7408 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
7409 {
7410 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
7411 NL80211_ATTR_TESTDATA, 0, -1,
7412 approxlen, gfp);
7413 }
7414
7415 /**
7416 * cfg80211_testmode_event - send the event
7417 * @skb: The skb, must have been allocated with
7418 * cfg80211_testmode_alloc_event_skb()
7419 * @gfp: allocation flags
7420 *
7421 * This function sends the given @skb, which must have been allocated
7422 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
7423 * consumes it.
7424 */
cfg80211_testmode_event(struct sk_buff * skb,gfp_t gfp)7425 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
7426 {
7427 __cfg80211_send_event_skb(skb, gfp);
7428 }
7429
7430 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
7431 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
7432 #else
7433 #define CFG80211_TESTMODE_CMD(cmd)
7434 #define CFG80211_TESTMODE_DUMP(cmd)
7435 #endif
7436
7437 /**
7438 * struct cfg80211_fils_resp_params - FILS connection response params
7439 * @kek: KEK derived from a successful FILS connection (may be %NULL)
7440 * @kek_len: Length of @fils_kek in octets
7441 * @update_erp_next_seq_num: Boolean value to specify whether the value in
7442 * @erp_next_seq_num is valid.
7443 * @erp_next_seq_num: The next sequence number to use in ERP message in
7444 * FILS Authentication. This value should be specified irrespective of the
7445 * status for a FILS connection.
7446 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
7447 * @pmk_len: Length of @pmk in octets
7448 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
7449 * used for this FILS connection (may be %NULL).
7450 */
7451 struct cfg80211_fils_resp_params {
7452 const u8 *kek;
7453 size_t kek_len;
7454 bool update_erp_next_seq_num;
7455 u16 erp_next_seq_num;
7456 const u8 *pmk;
7457 size_t pmk_len;
7458 const u8 *pmkid;
7459 };
7460
7461 /**
7462 * struct cfg80211_connect_resp_params - Connection response params
7463 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
7464 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7465 * the real status code for failures. If this call is used to report a
7466 * failure due to a timeout (e.g., not receiving an Authentication frame
7467 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7468 * indicate that this is a failure, but without a status code.
7469 * @timeout_reason is used to report the reason for the timeout in that
7470 * case.
7471 * @req_ie: Association request IEs (may be %NULL)
7472 * @req_ie_len: Association request IEs length
7473 * @resp_ie: Association response IEs (may be %NULL)
7474 * @resp_ie_len: Association response IEs length
7475 * @fils: FILS connection response parameters.
7476 * @timeout_reason: Reason for connection timeout. This is used when the
7477 * connection fails due to a timeout instead of an explicit rejection from
7478 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7479 * not known. This value is used only if @status < 0 to indicate that the
7480 * failure is due to a timeout and not due to explicit rejection by the AP.
7481 * This value is ignored in other cases (@status >= 0).
7482 * @valid_links: For MLO connection, BIT mask of the valid link ids. Otherwise
7483 * zero.
7484 * @ap_mld_addr: For MLO connection, MLD address of the AP. Otherwise %NULL.
7485 * @links : For MLO connection, contains link info for the valid links indicated
7486 * using @valid_links. For non-MLO connection, links[0] contains the
7487 * connected AP info.
7488 * @links.addr: For MLO connection, MAC address of the STA link. Otherwise
7489 * %NULL.
7490 * @links.bssid: For MLO connection, MAC address of the AP link. For non-MLO
7491 * connection, links[0].bssid points to the BSSID of the AP (may be %NULL).
7492 * @links.bss: For MLO connection, entry of bss to which STA link is connected.
7493 * For non-MLO connection, links[0].bss points to entry of bss to which STA
7494 * is connected. It can be obtained through cfg80211_get_bss() (may be
7495 * %NULL). It is recommended to store the bss from the connect_request and
7496 * hold a reference to it and return through this param to avoid a warning
7497 * if the bss is expired during the connection, esp. for those drivers
7498 * implementing connect op. Only one parameter among @bssid and @bss needs
7499 * to be specified.
7500 */
7501 struct cfg80211_connect_resp_params {
7502 int status;
7503 const u8 *req_ie;
7504 size_t req_ie_len;
7505 const u8 *resp_ie;
7506 size_t resp_ie_len;
7507 struct cfg80211_fils_resp_params fils;
7508 enum nl80211_timeout_reason timeout_reason;
7509
7510 const u8 *ap_mld_addr;
7511 u16 valid_links;
7512 struct {
7513 const u8 *addr;
7514 const u8 *bssid;
7515 struct cfg80211_bss *bss;
7516 } links[IEEE80211_MLD_MAX_NUM_LINKS];
7517 };
7518
7519 /**
7520 * cfg80211_connect_done - notify cfg80211 of connection result
7521 *
7522 * @dev: network device
7523 * @params: connection response parameters
7524 * @gfp: allocation flags
7525 *
7526 * It should be called by the underlying driver once execution of the connection
7527 * request from connect() has been completed. This is similar to
7528 * cfg80211_connect_bss(), but takes a structure pointer for connection response
7529 * parameters. Only one of the functions among cfg80211_connect_bss(),
7530 * cfg80211_connect_result(), cfg80211_connect_timeout(),
7531 * and cfg80211_connect_done() should be called.
7532 */
7533 void cfg80211_connect_done(struct net_device *dev,
7534 struct cfg80211_connect_resp_params *params,
7535 gfp_t gfp);
7536
7537 /**
7538 * cfg80211_connect_bss - notify cfg80211 of connection result
7539 *
7540 * @dev: network device
7541 * @bssid: the BSSID of the AP
7542 * @bss: Entry of bss to which STA got connected to, can be obtained through
7543 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the
7544 * bss from the connect_request and hold a reference to it and return
7545 * through this param to avoid a warning if the bss is expired during the
7546 * connection, esp. for those drivers implementing connect op.
7547 * Only one parameter among @bssid and @bss needs to be specified.
7548 * @req_ie: association request IEs (maybe be %NULL)
7549 * @req_ie_len: association request IEs length
7550 * @resp_ie: association response IEs (may be %NULL)
7551 * @resp_ie_len: assoc response IEs length
7552 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7553 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7554 * the real status code for failures. If this call is used to report a
7555 * failure due to a timeout (e.g., not receiving an Authentication frame
7556 * from the AP) instead of an explicit rejection by the AP, -1 is used to
7557 * indicate that this is a failure, but without a status code.
7558 * @timeout_reason is used to report the reason for the timeout in that
7559 * case.
7560 * @gfp: allocation flags
7561 * @timeout_reason: reason for connection timeout. This is used when the
7562 * connection fails due to a timeout instead of an explicit rejection from
7563 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
7564 * not known. This value is used only if @status < 0 to indicate that the
7565 * failure is due to a timeout and not due to explicit rejection by the AP.
7566 * This value is ignored in other cases (@status >= 0).
7567 *
7568 * It should be called by the underlying driver once execution of the connection
7569 * request from connect() has been completed. This is similar to
7570 * cfg80211_connect_result(), but with the option of identifying the exact bss
7571 * entry for the connection. Only one of the functions among
7572 * cfg80211_connect_bss(), cfg80211_connect_result(),
7573 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7574 */
7575 static inline void
cfg80211_connect_bss(struct net_device * dev,const u8 * bssid,struct cfg80211_bss * bss,const u8 * req_ie,size_t req_ie_len,const u8 * resp_ie,size_t resp_ie_len,int status,gfp_t gfp,enum nl80211_timeout_reason timeout_reason)7576 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
7577 struct cfg80211_bss *bss, const u8 *req_ie,
7578 size_t req_ie_len, const u8 *resp_ie,
7579 size_t resp_ie_len, int status, gfp_t gfp,
7580 enum nl80211_timeout_reason timeout_reason)
7581 {
7582 struct cfg80211_connect_resp_params params;
7583
7584 memset(¶ms, 0, sizeof(params));
7585 params.status = status;
7586 params.links[0].bssid = bssid;
7587 params.links[0].bss = bss;
7588 params.req_ie = req_ie;
7589 params.req_ie_len = req_ie_len;
7590 params.resp_ie = resp_ie;
7591 params.resp_ie_len = resp_ie_len;
7592 params.timeout_reason = timeout_reason;
7593
7594 cfg80211_connect_done(dev, ¶ms, gfp);
7595 }
7596
7597 /**
7598 * cfg80211_connect_result - notify cfg80211 of connection result
7599 *
7600 * @dev: network device
7601 * @bssid: the BSSID of the AP
7602 * @req_ie: association request IEs (maybe be %NULL)
7603 * @req_ie_len: association request IEs length
7604 * @resp_ie: association response IEs (may be %NULL)
7605 * @resp_ie_len: assoc response IEs length
7606 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
7607 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
7608 * the real status code for failures.
7609 * @gfp: allocation flags
7610 *
7611 * It should be called by the underlying driver once execution of the connection
7612 * request from connect() has been completed. This is similar to
7613 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
7614 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
7615 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7616 */
7617 static inline void
cfg80211_connect_result(struct net_device * dev,const u8 * bssid,const u8 * req_ie,size_t req_ie_len,const u8 * resp_ie,size_t resp_ie_len,u16 status,gfp_t gfp)7618 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
7619 const u8 *req_ie, size_t req_ie_len,
7620 const u8 *resp_ie, size_t resp_ie_len,
7621 u16 status, gfp_t gfp)
7622 {
7623 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
7624 resp_ie_len, status, gfp,
7625 NL80211_TIMEOUT_UNSPECIFIED);
7626 }
7627
7628 /**
7629 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
7630 *
7631 * @dev: network device
7632 * @bssid: the BSSID of the AP
7633 * @req_ie: association request IEs (maybe be %NULL)
7634 * @req_ie_len: association request IEs length
7635 * @gfp: allocation flags
7636 * @timeout_reason: reason for connection timeout.
7637 *
7638 * It should be called by the underlying driver whenever connect() has failed
7639 * in a sequence where no explicit authentication/association rejection was
7640 * received from the AP. This could happen, e.g., due to not being able to send
7641 * out the Authentication or Association Request frame or timing out while
7642 * waiting for the response. Only one of the functions among
7643 * cfg80211_connect_bss(), cfg80211_connect_result(),
7644 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
7645 */
7646 static inline void
cfg80211_connect_timeout(struct net_device * dev,const u8 * bssid,const u8 * req_ie,size_t req_ie_len,gfp_t gfp,enum nl80211_timeout_reason timeout_reason)7647 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
7648 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
7649 enum nl80211_timeout_reason timeout_reason)
7650 {
7651 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
7652 gfp, timeout_reason);
7653 }
7654
7655 /**
7656 * struct cfg80211_roam_info - driver initiated roaming information
7657 *
7658 * @req_ie: association request IEs (maybe be %NULL)
7659 * @req_ie_len: association request IEs length
7660 * @resp_ie: association response IEs (may be %NULL)
7661 * @resp_ie_len: assoc response IEs length
7662 * @fils: FILS related roaming information.
7663 * @valid_links: For MLO roaming, BIT mask of the new valid links is set.
7664 * Otherwise zero.
7665 * @ap_mld_addr: For MLO roaming, MLD address of the new AP. Otherwise %NULL.
7666 * @links : For MLO roaming, contains new link info for the valid links set in
7667 * @valid_links. For non-MLO roaming, links[0] contains the new AP info.
7668 * @links.addr: For MLO roaming, MAC address of the STA link. Otherwise %NULL.
7669 * @links.bssid: For MLO roaming, MAC address of the new AP link. For non-MLO
7670 * roaming, links[0].bssid points to the BSSID of the new AP. May be
7671 * %NULL if %links.bss is set.
7672 * @links.channel: the channel of the new AP.
7673 * @links.bss: For MLO roaming, entry of new bss to which STA link got
7674 * roamed. For non-MLO roaming, links[0].bss points to entry of bss to
7675 * which STA got roamed (may be %NULL if %links.bssid is set)
7676 */
7677 struct cfg80211_roam_info {
7678 const u8 *req_ie;
7679 size_t req_ie_len;
7680 const u8 *resp_ie;
7681 size_t resp_ie_len;
7682 struct cfg80211_fils_resp_params fils;
7683
7684 const u8 *ap_mld_addr;
7685 u16 valid_links;
7686 struct {
7687 const u8 *addr;
7688 const u8 *bssid;
7689 struct ieee80211_channel *channel;
7690 struct cfg80211_bss *bss;
7691 } links[IEEE80211_MLD_MAX_NUM_LINKS];
7692 };
7693
7694 /**
7695 * cfg80211_roamed - notify cfg80211 of roaming
7696 *
7697 * @dev: network device
7698 * @info: information about the new BSS. struct &cfg80211_roam_info.
7699 * @gfp: allocation flags
7700 *
7701 * This function may be called with the driver passing either the BSSID of the
7702 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
7703 * It should be called by the underlying driver whenever it roamed from one AP
7704 * to another while connected. Drivers which have roaming implemented in
7705 * firmware should pass the bss entry to avoid a race in bss entry timeout where
7706 * the bss entry of the new AP is seen in the driver, but gets timed out by the
7707 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
7708 * rdev->event_work. In case of any failures, the reference is released
7709 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
7710 * released while disconnecting from the current bss.
7711 */
7712 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
7713 gfp_t gfp);
7714
7715 /**
7716 * cfg80211_port_authorized - notify cfg80211 of successful security association
7717 *
7718 * @dev: network device
7719 * @bssid: the BSSID of the AP
7720 * @td_bitmap: transition disable policy
7721 * @td_bitmap_len: Length of transition disable policy
7722 * @gfp: allocation flags
7723 *
7724 * This function should be called by a driver that supports 4 way handshake
7725 * offload after a security association was successfully established (i.e.,
7726 * the 4 way handshake was completed successfully). The call to this function
7727 * should be preceded with a call to cfg80211_connect_result(),
7728 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
7729 * indicate the 802.11 association.
7730 */
7731 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
7732 const u8* td_bitmap, u8 td_bitmap_len, gfp_t gfp);
7733
7734 /**
7735 * cfg80211_disconnected - notify cfg80211 that connection was dropped
7736 *
7737 * @dev: network device
7738 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
7739 * @ie_len: length of IEs
7740 * @reason: reason code for the disconnection, set it to 0 if unknown
7741 * @locally_generated: disconnection was requested locally
7742 * @gfp: allocation flags
7743 *
7744 * After it calls this function, the driver should enter an idle state
7745 * and not try to connect to any AP any more.
7746 */
7747 void cfg80211_disconnected(struct net_device *dev, u16 reason,
7748 const u8 *ie, size_t ie_len,
7749 bool locally_generated, gfp_t gfp);
7750
7751 /**
7752 * cfg80211_ready_on_channel - notification of remain_on_channel start
7753 * @wdev: wireless device
7754 * @cookie: the request cookie
7755 * @chan: The current channel (from remain_on_channel request)
7756 * @duration: Duration in milliseconds that the driver intents to remain on the
7757 * channel
7758 * @gfp: allocation flags
7759 */
7760 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
7761 struct ieee80211_channel *chan,
7762 unsigned int duration, gfp_t gfp);
7763
7764 /**
7765 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
7766 * @wdev: wireless device
7767 * @cookie: the request cookie
7768 * @chan: The current channel (from remain_on_channel request)
7769 * @gfp: allocation flags
7770 */
7771 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
7772 struct ieee80211_channel *chan,
7773 gfp_t gfp);
7774
7775 /**
7776 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
7777 * @wdev: wireless device
7778 * @cookie: the requested cookie
7779 * @chan: The current channel (from tx_mgmt request)
7780 * @gfp: allocation flags
7781 */
7782 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
7783 struct ieee80211_channel *chan, gfp_t gfp);
7784
7785 /**
7786 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
7787 *
7788 * @sinfo: the station information
7789 * @gfp: allocation flags
7790 */
7791 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
7792
7793 /**
7794 * cfg80211_sinfo_release_content - release contents of station info
7795 * @sinfo: the station information
7796 *
7797 * Releases any potentially allocated sub-information of the station
7798 * information, but not the struct itself (since it's typically on
7799 * the stack.)
7800 */
cfg80211_sinfo_release_content(struct station_info * sinfo)7801 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
7802 {
7803 kfree(sinfo->pertid);
7804 }
7805
7806 /**
7807 * cfg80211_new_sta - notify userspace about station
7808 *
7809 * @dev: the netdev
7810 * @mac_addr: the station's address
7811 * @sinfo: the station information
7812 * @gfp: allocation flags
7813 */
7814 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
7815 struct station_info *sinfo, gfp_t gfp);
7816
7817 /**
7818 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
7819 * @dev: the netdev
7820 * @mac_addr: the station's address
7821 * @sinfo: the station information/statistics
7822 * @gfp: allocation flags
7823 */
7824 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
7825 struct station_info *sinfo, gfp_t gfp);
7826
7827 /**
7828 * cfg80211_del_sta - notify userspace about deletion of a station
7829 *
7830 * @dev: the netdev
7831 * @mac_addr: the station's address
7832 * @gfp: allocation flags
7833 */
cfg80211_del_sta(struct net_device * dev,const u8 * mac_addr,gfp_t gfp)7834 static inline void cfg80211_del_sta(struct net_device *dev,
7835 const u8 *mac_addr, gfp_t gfp)
7836 {
7837 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
7838 }
7839
7840 /**
7841 * cfg80211_conn_failed - connection request failed notification
7842 *
7843 * @dev: the netdev
7844 * @mac_addr: the station's address
7845 * @reason: the reason for connection failure
7846 * @gfp: allocation flags
7847 *
7848 * Whenever a station tries to connect to an AP and if the station
7849 * could not connect to the AP as the AP has rejected the connection
7850 * for some reasons, this function is called.
7851 *
7852 * The reason for connection failure can be any of the value from
7853 * nl80211_connect_failed_reason enum
7854 */
7855 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
7856 enum nl80211_connect_failed_reason reason,
7857 gfp_t gfp);
7858
7859 /**
7860 * struct cfg80211_rx_info - received management frame info
7861 *
7862 * @freq: Frequency on which the frame was received in kHz
7863 * @sig_dbm: signal strength in dBm, or 0 if unknown
7864 * @have_link_id: indicates the frame was received on a link of
7865 * an MLD, i.e. the @link_id field is valid
7866 * @link_id: the ID of the link the frame was received on
7867 * @buf: Management frame (header + body)
7868 * @len: length of the frame data
7869 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7870 * @rx_tstamp: Hardware timestamp of frame RX in nanoseconds
7871 * @ack_tstamp: Hardware timestamp of ack TX in nanoseconds
7872 */
7873 struct cfg80211_rx_info {
7874 int freq;
7875 int sig_dbm;
7876 bool have_link_id;
7877 u8 link_id;
7878 const u8 *buf;
7879 size_t len;
7880 u32 flags;
7881 u64 rx_tstamp;
7882 u64 ack_tstamp;
7883 };
7884
7885 /**
7886 * cfg80211_rx_mgmt_ext - management frame notification with extended info
7887 * @wdev: wireless device receiving the frame
7888 * @info: RX info as defined in struct cfg80211_rx_info
7889 *
7890 * This function is called whenever an Action frame is received for a station
7891 * mode interface, but is not processed in kernel.
7892 *
7893 * Return: %true if a user space application has registered for this frame.
7894 * For action frames, that makes it responsible for rejecting unrecognized
7895 * action frames; %false otherwise, in which case for action frames the
7896 * driver is responsible for rejecting the frame.
7897 */
7898 bool cfg80211_rx_mgmt_ext(struct wireless_dev *wdev,
7899 struct cfg80211_rx_info *info);
7900
7901 /**
7902 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame
7903 * @wdev: wireless device receiving the frame
7904 * @freq: Frequency on which the frame was received in KHz
7905 * @sig_dbm: signal strength in dBm, or 0 if unknown
7906 * @buf: Management frame (header + body)
7907 * @len: length of the frame data
7908 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7909 *
7910 * This function is called whenever an Action frame is received for a station
7911 * mode interface, but is not processed in kernel.
7912 *
7913 * Return: %true if a user space application has registered for this frame.
7914 * For action frames, that makes it responsible for rejecting unrecognized
7915 * action frames; %false otherwise, in which case for action frames the
7916 * driver is responsible for rejecting the frame.
7917 */
cfg80211_rx_mgmt_khz(struct wireless_dev * wdev,int freq,int sig_dbm,const u8 * buf,size_t len,u32 flags)7918 static inline bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq,
7919 int sig_dbm, const u8 *buf, size_t len,
7920 u32 flags)
7921 {
7922 struct cfg80211_rx_info info = {
7923 .freq = freq,
7924 .sig_dbm = sig_dbm,
7925 .buf = buf,
7926 .len = len,
7927 .flags = flags
7928 };
7929
7930 return cfg80211_rx_mgmt_ext(wdev, &info);
7931 }
7932
7933 /**
7934 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
7935 * @wdev: wireless device receiving the frame
7936 * @freq: Frequency on which the frame was received in MHz
7937 * @sig_dbm: signal strength in dBm, or 0 if unknown
7938 * @buf: Management frame (header + body)
7939 * @len: length of the frame data
7940 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
7941 *
7942 * This function is called whenever an Action frame is received for a station
7943 * mode interface, but is not processed in kernel.
7944 *
7945 * Return: %true if a user space application has registered for this frame.
7946 * For action frames, that makes it responsible for rejecting unrecognized
7947 * action frames; %false otherwise, in which case for action frames the
7948 * driver is responsible for rejecting the frame.
7949 */
cfg80211_rx_mgmt(struct wireless_dev * wdev,int freq,int sig_dbm,const u8 * buf,size_t len,u32 flags)7950 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq,
7951 int sig_dbm, const u8 *buf, size_t len,
7952 u32 flags)
7953 {
7954 struct cfg80211_rx_info info = {
7955 .freq = MHZ_TO_KHZ(freq),
7956 .sig_dbm = sig_dbm,
7957 .buf = buf,
7958 .len = len,
7959 .flags = flags
7960 };
7961
7962 return cfg80211_rx_mgmt_ext(wdev, &info);
7963 }
7964
7965 /**
7966 * struct cfg80211_tx_status - TX status for management frame information
7967 *
7968 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
7969 * @tx_tstamp: hardware TX timestamp in nanoseconds
7970 * @ack_tstamp: hardware ack RX timestamp in nanoseconds
7971 * @buf: Management frame (header + body)
7972 * @len: length of the frame data
7973 * @ack: Whether frame was acknowledged
7974 */
7975 struct cfg80211_tx_status {
7976 u64 cookie;
7977 u64 tx_tstamp;
7978 u64 ack_tstamp;
7979 const u8 *buf;
7980 size_t len;
7981 bool ack;
7982 };
7983
7984 /**
7985 * cfg80211_mgmt_tx_status_ext - TX status notification with extended info
7986 * @wdev: wireless device receiving the frame
7987 * @status: TX status data
7988 * @gfp: context flags
7989 *
7990 * This function is called whenever a management frame was requested to be
7991 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
7992 * transmission attempt with extended info.
7993 */
7994 void cfg80211_mgmt_tx_status_ext(struct wireless_dev *wdev,
7995 struct cfg80211_tx_status *status, gfp_t gfp);
7996
7997 /**
7998 * cfg80211_mgmt_tx_status - notification of TX status for management frame
7999 * @wdev: wireless device receiving the frame
8000 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
8001 * @buf: Management frame (header + body)
8002 * @len: length of the frame data
8003 * @ack: Whether frame was acknowledged
8004 * @gfp: context flags
8005 *
8006 * This function is called whenever a management frame was requested to be
8007 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
8008 * transmission attempt.
8009 */
cfg80211_mgmt_tx_status(struct wireless_dev * wdev,u64 cookie,const u8 * buf,size_t len,bool ack,gfp_t gfp)8010 static inline void cfg80211_mgmt_tx_status(struct wireless_dev *wdev,
8011 u64 cookie, const u8 *buf,
8012 size_t len, bool ack, gfp_t gfp)
8013 {
8014 struct cfg80211_tx_status status = {
8015 .cookie = cookie,
8016 .buf = buf,
8017 .len = len,
8018 .ack = ack
8019 };
8020
8021 cfg80211_mgmt_tx_status_ext(wdev, &status, gfp);
8022 }
8023
8024 /**
8025 * cfg80211_control_port_tx_status - notification of TX status for control
8026 * port frames
8027 * @wdev: wireless device receiving the frame
8028 * @cookie: Cookie returned by cfg80211_ops::tx_control_port()
8029 * @buf: Data frame (header + body)
8030 * @len: length of the frame data
8031 * @ack: Whether frame was acknowledged
8032 * @gfp: context flags
8033 *
8034 * This function is called whenever a control port frame was requested to be
8035 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of
8036 * the transmission attempt.
8037 */
8038 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie,
8039 const u8 *buf, size_t len, bool ack,
8040 gfp_t gfp);
8041
8042 /**
8043 * cfg80211_rx_control_port - notification about a received control port frame
8044 * @dev: The device the frame matched to
8045 * @skb: The skbuf with the control port frame. It is assumed that the skbuf
8046 * is 802.3 formatted (with 802.3 header). The skb can be non-linear.
8047 * This function does not take ownership of the skb, so the caller is
8048 * responsible for any cleanup. The caller must also ensure that
8049 * skb->protocol is set appropriately.
8050 * @unencrypted: Whether the frame was received unencrypted
8051 *
8052 * This function is used to inform userspace about a received control port
8053 * frame. It should only be used if userspace indicated it wants to receive
8054 * control port frames over nl80211.
8055 *
8056 * The frame is the data portion of the 802.3 or 802.11 data frame with all
8057 * network layer headers removed (e.g. the raw EAPoL frame).
8058 *
8059 * Return: %true if the frame was passed to userspace
8060 */
8061 bool cfg80211_rx_control_port(struct net_device *dev,
8062 struct sk_buff *skb, bool unencrypted);
8063
8064 /**
8065 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
8066 * @dev: network device
8067 * @rssi_event: the triggered RSSI event
8068 * @rssi_level: new RSSI level value or 0 if not available
8069 * @gfp: context flags
8070 *
8071 * This function is called when a configured connection quality monitoring
8072 * rssi threshold reached event occurs.
8073 */
8074 void cfg80211_cqm_rssi_notify(struct net_device *dev,
8075 enum nl80211_cqm_rssi_threshold_event rssi_event,
8076 s32 rssi_level, gfp_t gfp);
8077
8078 /**
8079 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
8080 * @dev: network device
8081 * @peer: peer's MAC address
8082 * @num_packets: how many packets were lost -- should be a fixed threshold
8083 * but probably no less than maybe 50, or maybe a throughput dependent
8084 * threshold (to account for temporary interference)
8085 * @gfp: context flags
8086 */
8087 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
8088 const u8 *peer, u32 num_packets, gfp_t gfp);
8089
8090 /**
8091 * cfg80211_cqm_txe_notify - TX error rate event
8092 * @dev: network device
8093 * @peer: peer's MAC address
8094 * @num_packets: how many packets were lost
8095 * @rate: % of packets which failed transmission
8096 * @intvl: interval (in s) over which the TX failure threshold was breached.
8097 * @gfp: context flags
8098 *
8099 * Notify userspace when configured % TX failures over number of packets in a
8100 * given interval is exceeded.
8101 */
8102 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
8103 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
8104
8105 /**
8106 * cfg80211_cqm_beacon_loss_notify - beacon loss event
8107 * @dev: network device
8108 * @gfp: context flags
8109 *
8110 * Notify userspace about beacon loss from the connected AP.
8111 */
8112 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
8113
8114 /**
8115 * __cfg80211_radar_event - radar detection event
8116 * @wiphy: the wiphy
8117 * @chandef: chandef for the current channel
8118 * @offchan: the radar has been detected on the offchannel chain
8119 * @gfp: context flags
8120 *
8121 * This function is called when a radar is detected on the current chanenl.
8122 */
8123 void __cfg80211_radar_event(struct wiphy *wiphy,
8124 struct cfg80211_chan_def *chandef,
8125 bool offchan, gfp_t gfp);
8126
8127 static inline void
cfg80211_radar_event(struct wiphy * wiphy,struct cfg80211_chan_def * chandef,gfp_t gfp)8128 cfg80211_radar_event(struct wiphy *wiphy,
8129 struct cfg80211_chan_def *chandef,
8130 gfp_t gfp)
8131 {
8132 __cfg80211_radar_event(wiphy, chandef, false, gfp);
8133 }
8134
8135 static inline void
cfg80211_background_radar_event(struct wiphy * wiphy,struct cfg80211_chan_def * chandef,gfp_t gfp)8136 cfg80211_background_radar_event(struct wiphy *wiphy,
8137 struct cfg80211_chan_def *chandef,
8138 gfp_t gfp)
8139 {
8140 __cfg80211_radar_event(wiphy, chandef, true, gfp);
8141 }
8142
8143 /**
8144 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
8145 * @dev: network device
8146 * @mac: MAC address of a station which opmode got modified
8147 * @sta_opmode: station's current opmode value
8148 * @gfp: context flags
8149 *
8150 * Driver should call this function when station's opmode modified via action
8151 * frame.
8152 */
8153 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
8154 struct sta_opmode_info *sta_opmode,
8155 gfp_t gfp);
8156
8157 /**
8158 * cfg80211_cac_event - Channel availability check (CAC) event
8159 * @netdev: network device
8160 * @chandef: chandef for the current channel
8161 * @event: type of event
8162 * @gfp: context flags
8163 *
8164 * This function is called when a Channel availability check (CAC) is finished
8165 * or aborted. This must be called to notify the completion of a CAC process,
8166 * also by full-MAC drivers.
8167 */
8168 void cfg80211_cac_event(struct net_device *netdev,
8169 const struct cfg80211_chan_def *chandef,
8170 enum nl80211_radar_event event, gfp_t gfp);
8171
8172 /**
8173 * cfg80211_background_cac_abort - Channel Availability Check offchan abort event
8174 * @wiphy: the wiphy
8175 *
8176 * This function is called by the driver when a Channel Availability Check
8177 * (CAC) is aborted by a offchannel dedicated chain.
8178 */
8179 void cfg80211_background_cac_abort(struct wiphy *wiphy);
8180
8181 /**
8182 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
8183 * @dev: network device
8184 * @bssid: BSSID of AP (to avoid races)
8185 * @replay_ctr: new replay counter
8186 * @gfp: allocation flags
8187 */
8188 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
8189 const u8 *replay_ctr, gfp_t gfp);
8190
8191 /**
8192 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
8193 * @dev: network device
8194 * @index: candidate index (the smaller the index, the higher the priority)
8195 * @bssid: BSSID of AP
8196 * @preauth: Whether AP advertises support for RSN pre-authentication
8197 * @gfp: allocation flags
8198 */
8199 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
8200 const u8 *bssid, bool preauth, gfp_t gfp);
8201
8202 /**
8203 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
8204 * @dev: The device the frame matched to
8205 * @addr: the transmitter address
8206 * @gfp: context flags
8207 *
8208 * This function is used in AP mode (only!) to inform userspace that
8209 * a spurious class 3 frame was received, to be able to deauth the
8210 * sender.
8211 * Return: %true if the frame was passed to userspace (or this failed
8212 * for a reason other than not having a subscription.)
8213 */
8214 bool cfg80211_rx_spurious_frame(struct net_device *dev,
8215 const u8 *addr, gfp_t gfp);
8216
8217 /**
8218 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
8219 * @dev: The device the frame matched to
8220 * @addr: the transmitter address
8221 * @gfp: context flags
8222 *
8223 * This function is used in AP mode (only!) to inform userspace that
8224 * an associated station sent a 4addr frame but that wasn't expected.
8225 * It is allowed and desirable to send this event only once for each
8226 * station to avoid event flooding.
8227 * Return: %true if the frame was passed to userspace (or this failed
8228 * for a reason other than not having a subscription.)
8229 */
8230 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
8231 const u8 *addr, gfp_t gfp);
8232
8233 /**
8234 * cfg80211_probe_status - notify userspace about probe status
8235 * @dev: the device the probe was sent on
8236 * @addr: the address of the peer
8237 * @cookie: the cookie filled in @probe_client previously
8238 * @acked: indicates whether probe was acked or not
8239 * @ack_signal: signal strength (in dBm) of the ACK frame.
8240 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
8241 * @gfp: allocation flags
8242 */
8243 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
8244 u64 cookie, bool acked, s32 ack_signal,
8245 bool is_valid_ack_signal, gfp_t gfp);
8246
8247 /**
8248 * cfg80211_report_obss_beacon_khz - report beacon from other APs
8249 * @wiphy: The wiphy that received the beacon
8250 * @frame: the frame
8251 * @len: length of the frame
8252 * @freq: frequency the frame was received on in KHz
8253 * @sig_dbm: signal strength in dBm, or 0 if unknown
8254 *
8255 * Use this function to report to userspace when a beacon was
8256 * received. It is not useful to call this when there is no
8257 * netdev that is in AP/GO mode.
8258 */
8259 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame,
8260 size_t len, int freq, int sig_dbm);
8261
8262 /**
8263 * cfg80211_report_obss_beacon - report beacon from other APs
8264 * @wiphy: The wiphy that received the beacon
8265 * @frame: the frame
8266 * @len: length of the frame
8267 * @freq: frequency the frame was received on
8268 * @sig_dbm: signal strength in dBm, or 0 if unknown
8269 *
8270 * Use this function to report to userspace when a beacon was
8271 * received. It is not useful to call this when there is no
8272 * netdev that is in AP/GO mode.
8273 */
cfg80211_report_obss_beacon(struct wiphy * wiphy,const u8 * frame,size_t len,int freq,int sig_dbm)8274 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy,
8275 const u8 *frame, size_t len,
8276 int freq, int sig_dbm)
8277 {
8278 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq),
8279 sig_dbm);
8280 }
8281
8282 /**
8283 * cfg80211_reg_can_beacon - check if beaconing is allowed
8284 * @wiphy: the wiphy
8285 * @chandef: the channel definition
8286 * @iftype: interface type
8287 *
8288 * Return: %true if there is no secondary channel or the secondary channel(s)
8289 * can be used for beaconing (i.e. is not a radar channel etc.)
8290 */
8291 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
8292 struct cfg80211_chan_def *chandef,
8293 enum nl80211_iftype iftype);
8294
8295 /**
8296 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
8297 * @wiphy: the wiphy
8298 * @chandef: the channel definition
8299 * @iftype: interface type
8300 *
8301 * Return: %true if there is no secondary channel or the secondary channel(s)
8302 * can be used for beaconing (i.e. is not a radar channel etc.). This version
8303 * also checks if IR-relaxation conditions apply, to allow beaconing under
8304 * more permissive conditions.
8305 *
8306 * Requires the wiphy mutex to be held.
8307 */
8308 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
8309 struct cfg80211_chan_def *chandef,
8310 enum nl80211_iftype iftype);
8311
8312 /*
8313 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
8314 * @dev: the device which switched channels
8315 * @chandef: the new channel definition
8316 * @link_id: the link ID for MLO, must be 0 for non-MLO
8317 * @punct_bitmap: the new puncturing bitmap
8318 *
8319 * Caller must acquire wdev_lock, therefore must only be called from sleepable
8320 * driver context!
8321 */
8322 void cfg80211_ch_switch_notify(struct net_device *dev,
8323 struct cfg80211_chan_def *chandef,
8324 unsigned int link_id, u16 punct_bitmap);
8325
8326 /*
8327 * cfg80211_ch_switch_started_notify - notify channel switch start
8328 * @dev: the device on which the channel switch started
8329 * @chandef: the future channel definition
8330 * @link_id: the link ID for MLO, must be 0 for non-MLO
8331 * @count: the number of TBTTs until the channel switch happens
8332 * @quiet: whether or not immediate quiet was requested by the AP
8333 * @punct_bitmap: the future puncturing bitmap
8334 *
8335 * Inform the userspace about the channel switch that has just
8336 * started, so that it can take appropriate actions (eg. starting
8337 * channel switch on other vifs), if necessary.
8338 */
8339 void cfg80211_ch_switch_started_notify(struct net_device *dev,
8340 struct cfg80211_chan_def *chandef,
8341 unsigned int link_id, u8 count,
8342 bool quiet, u16 punct_bitmap);
8343
8344 /**
8345 * ieee80211_operating_class_to_band - convert operating class to band
8346 *
8347 * @operating_class: the operating class to convert
8348 * @band: band pointer to fill
8349 *
8350 * Returns %true if the conversion was successful, %false otherwise.
8351 */
8352 bool ieee80211_operating_class_to_band(u8 operating_class,
8353 enum nl80211_band *band);
8354
8355 /**
8356 * ieee80211_chandef_to_operating_class - convert chandef to operation class
8357 *
8358 * @chandef: the chandef to convert
8359 * @op_class: a pointer to the resulting operating class
8360 *
8361 * Returns %true if the conversion was successful, %false otherwise.
8362 */
8363 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
8364 u8 *op_class);
8365
8366 /**
8367 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz
8368 *
8369 * @chandef: the chandef to convert
8370 *
8371 * Returns the center frequency of chandef (1st segment) in KHz.
8372 */
8373 static inline u32
ieee80211_chandef_to_khz(const struct cfg80211_chan_def * chandef)8374 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef)
8375 {
8376 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset;
8377 }
8378
8379 /*
8380 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
8381 * @dev: the device on which the operation is requested
8382 * @peer: the MAC address of the peer device
8383 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
8384 * NL80211_TDLS_TEARDOWN)
8385 * @reason_code: the reason code for teardown request
8386 * @gfp: allocation flags
8387 *
8388 * This function is used to request userspace to perform TDLS operation that
8389 * requires knowledge of keys, i.e., link setup or teardown when the AP
8390 * connection uses encryption. This is optional mechanism for the driver to use
8391 * if it can automatically determine when a TDLS link could be useful (e.g.,
8392 * based on traffic and signal strength for a peer).
8393 */
8394 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
8395 enum nl80211_tdls_operation oper,
8396 u16 reason_code, gfp_t gfp);
8397
8398 /*
8399 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
8400 * @rate: given rate_info to calculate bitrate from
8401 *
8402 * return 0 if MCS index >= 32
8403 */
8404 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
8405
8406 /**
8407 * cfg80211_unregister_wdev - remove the given wdev
8408 * @wdev: struct wireless_dev to remove
8409 *
8410 * This function removes the device so it can no longer be used. It is necessary
8411 * to call this function even when cfg80211 requests the removal of the device
8412 * by calling the del_virtual_intf() callback. The function must also be called
8413 * when the driver wishes to unregister the wdev, e.g. when the hardware device
8414 * is unbound from the driver.
8415 *
8416 * Requires the RTNL and wiphy mutex to be held.
8417 */
8418 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
8419
8420 /**
8421 * cfg80211_register_netdevice - register the given netdev
8422 * @dev: the netdev to register
8423 *
8424 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
8425 * than register_netdevice(), unregister_netdev() is impossible as the RTNL is
8426 * held. Otherwise, both register_netdevice() and register_netdev() are usable
8427 * instead as well.
8428 *
8429 * Requires the RTNL and wiphy mutex to be held.
8430 */
8431 int cfg80211_register_netdevice(struct net_device *dev);
8432
8433 /**
8434 * cfg80211_unregister_netdevice - unregister the given netdev
8435 * @dev: the netdev to register
8436 *
8437 * Note: In contexts coming from cfg80211 callbacks, you must call this rather
8438 * than unregister_netdevice(), unregister_netdev() is impossible as the RTNL
8439 * is held. Otherwise, both unregister_netdevice() and unregister_netdev() are
8440 * usable instead as well.
8441 *
8442 * Requires the RTNL and wiphy mutex to be held.
8443 */
cfg80211_unregister_netdevice(struct net_device * dev)8444 static inline void cfg80211_unregister_netdevice(struct net_device *dev)
8445 {
8446 cfg80211_unregister_wdev(dev->ieee80211_ptr);
8447 }
8448
8449 /**
8450 * struct cfg80211_ft_event_params - FT Information Elements
8451 * @ies: FT IEs
8452 * @ies_len: length of the FT IE in bytes
8453 * @target_ap: target AP's MAC address
8454 * @ric_ies: RIC IE
8455 * @ric_ies_len: length of the RIC IE in bytes
8456 */
8457 struct cfg80211_ft_event_params {
8458 const u8 *ies;
8459 size_t ies_len;
8460 const u8 *target_ap;
8461 const u8 *ric_ies;
8462 size_t ric_ies_len;
8463 };
8464
8465 /**
8466 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
8467 * @netdev: network device
8468 * @ft_event: IE information
8469 */
8470 void cfg80211_ft_event(struct net_device *netdev,
8471 struct cfg80211_ft_event_params *ft_event);
8472
8473 /**
8474 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
8475 * @ies: the input IE buffer
8476 * @len: the input length
8477 * @attr: the attribute ID to find
8478 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
8479 * if the function is only called to get the needed buffer size
8480 * @bufsize: size of the output buffer
8481 *
8482 * The function finds a given P2P attribute in the (vendor) IEs and
8483 * copies its contents to the given buffer.
8484 *
8485 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
8486 * malformed or the attribute can't be found (respectively), or the
8487 * length of the found attribute (which can be zero).
8488 */
8489 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
8490 enum ieee80211_p2p_attr_id attr,
8491 u8 *buf, unsigned int bufsize);
8492
8493 /**
8494 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
8495 * @ies: the IE buffer
8496 * @ielen: the length of the IE buffer
8497 * @ids: an array with element IDs that are allowed before
8498 * the split. A WLAN_EID_EXTENSION value means that the next
8499 * EID in the list is a sub-element of the EXTENSION IE.
8500 * @n_ids: the size of the element ID array
8501 * @after_ric: array IE types that come after the RIC element
8502 * @n_after_ric: size of the @after_ric array
8503 * @offset: offset where to start splitting in the buffer
8504 *
8505 * This function splits an IE buffer by updating the @offset
8506 * variable to point to the location where the buffer should be
8507 * split.
8508 *
8509 * It assumes that the given IE buffer is well-formed, this
8510 * has to be guaranteed by the caller!
8511 *
8512 * It also assumes that the IEs in the buffer are ordered
8513 * correctly, if not the result of using this function will not
8514 * be ordered correctly either, i.e. it does no reordering.
8515 *
8516 * The function returns the offset where the next part of the
8517 * buffer starts, which may be @ielen if the entire (remainder)
8518 * of the buffer should be used.
8519 */
8520 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
8521 const u8 *ids, int n_ids,
8522 const u8 *after_ric, int n_after_ric,
8523 size_t offset);
8524
8525 /**
8526 * ieee80211_ie_split - split an IE buffer according to ordering
8527 * @ies: the IE buffer
8528 * @ielen: the length of the IE buffer
8529 * @ids: an array with element IDs that are allowed before
8530 * the split. A WLAN_EID_EXTENSION value means that the next
8531 * EID in the list is a sub-element of the EXTENSION IE.
8532 * @n_ids: the size of the element ID array
8533 * @offset: offset where to start splitting in the buffer
8534 *
8535 * This function splits an IE buffer by updating the @offset
8536 * variable to point to the location where the buffer should be
8537 * split.
8538 *
8539 * It assumes that the given IE buffer is well-formed, this
8540 * has to be guaranteed by the caller!
8541 *
8542 * It also assumes that the IEs in the buffer are ordered
8543 * correctly, if not the result of using this function will not
8544 * be ordered correctly either, i.e. it does no reordering.
8545 *
8546 * The function returns the offset where the next part of the
8547 * buffer starts, which may be @ielen if the entire (remainder)
8548 * of the buffer should be used.
8549 */
ieee80211_ie_split(const u8 * ies,size_t ielen,const u8 * ids,int n_ids,size_t offset)8550 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
8551 const u8 *ids, int n_ids, size_t offset)
8552 {
8553 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
8554 }
8555
8556 /**
8557 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
8558 * @wdev: the wireless device reporting the wakeup
8559 * @wakeup: the wakeup report
8560 * @gfp: allocation flags
8561 *
8562 * This function reports that the given device woke up. If it
8563 * caused the wakeup, report the reason(s), otherwise you may
8564 * pass %NULL as the @wakeup parameter to advertise that something
8565 * else caused the wakeup.
8566 */
8567 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
8568 struct cfg80211_wowlan_wakeup *wakeup,
8569 gfp_t gfp);
8570
8571 /**
8572 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
8573 *
8574 * @wdev: the wireless device for which critical protocol is stopped.
8575 * @gfp: allocation flags
8576 *
8577 * This function can be called by the driver to indicate it has reverted
8578 * operation back to normal. One reason could be that the duration given
8579 * by .crit_proto_start() has expired.
8580 */
8581 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
8582
8583 /**
8584 * ieee80211_get_num_supported_channels - get number of channels device has
8585 * @wiphy: the wiphy
8586 *
8587 * Return: the number of channels supported by the device.
8588 */
8589 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
8590
8591 /**
8592 * cfg80211_check_combinations - check interface combinations
8593 *
8594 * @wiphy: the wiphy
8595 * @params: the interface combinations parameter
8596 *
8597 * This function can be called by the driver to check whether a
8598 * combination of interfaces and their types are allowed according to
8599 * the interface combinations.
8600 */
8601 int cfg80211_check_combinations(struct wiphy *wiphy,
8602 struct iface_combination_params *params);
8603
8604 /**
8605 * cfg80211_iter_combinations - iterate over matching combinations
8606 *
8607 * @wiphy: the wiphy
8608 * @params: the interface combinations parameter
8609 * @iter: function to call for each matching combination
8610 * @data: pointer to pass to iter function
8611 *
8612 * This function can be called by the driver to check what possible
8613 * combinations it fits in at a given moment, e.g. for channel switching
8614 * purposes.
8615 */
8616 int cfg80211_iter_combinations(struct wiphy *wiphy,
8617 struct iface_combination_params *params,
8618 void (*iter)(const struct ieee80211_iface_combination *c,
8619 void *data),
8620 void *data);
8621
8622 /*
8623 * cfg80211_stop_iface - trigger interface disconnection
8624 *
8625 * @wiphy: the wiphy
8626 * @wdev: wireless device
8627 * @gfp: context flags
8628 *
8629 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
8630 * disconnected.
8631 *
8632 * Note: This doesn't need any locks and is asynchronous.
8633 */
8634 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
8635 gfp_t gfp);
8636
8637 /**
8638 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
8639 * @wiphy: the wiphy to shut down
8640 *
8641 * This function shuts down all interfaces belonging to this wiphy by
8642 * calling dev_close() (and treating non-netdev interfaces as needed).
8643 * It shouldn't really be used unless there are some fatal device errors
8644 * that really can't be recovered in any other way.
8645 *
8646 * Callers must hold the RTNL and be able to deal with callbacks into
8647 * the driver while the function is running.
8648 */
8649 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
8650
8651 /**
8652 * wiphy_ext_feature_set - set the extended feature flag
8653 *
8654 * @wiphy: the wiphy to modify.
8655 * @ftidx: extended feature bit index.
8656 *
8657 * The extended features are flagged in multiple bytes (see
8658 * &struct wiphy.@ext_features)
8659 */
wiphy_ext_feature_set(struct wiphy * wiphy,enum nl80211_ext_feature_index ftidx)8660 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
8661 enum nl80211_ext_feature_index ftidx)
8662 {
8663 u8 *ft_byte;
8664
8665 ft_byte = &wiphy->ext_features[ftidx / 8];
8666 *ft_byte |= BIT(ftidx % 8);
8667 }
8668
8669 /**
8670 * wiphy_ext_feature_isset - check the extended feature flag
8671 *
8672 * @wiphy: the wiphy to modify.
8673 * @ftidx: extended feature bit index.
8674 *
8675 * The extended features are flagged in multiple bytes (see
8676 * &struct wiphy.@ext_features)
8677 */
8678 static inline bool
wiphy_ext_feature_isset(struct wiphy * wiphy,enum nl80211_ext_feature_index ftidx)8679 wiphy_ext_feature_isset(struct wiphy *wiphy,
8680 enum nl80211_ext_feature_index ftidx)
8681 {
8682 u8 ft_byte;
8683
8684 ft_byte = wiphy->ext_features[ftidx / 8];
8685 return (ft_byte & BIT(ftidx % 8)) != 0;
8686 }
8687
8688 /**
8689 * cfg80211_free_nan_func - free NAN function
8690 * @f: NAN function that should be freed
8691 *
8692 * Frees all the NAN function and all it's allocated members.
8693 */
8694 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
8695
8696 /**
8697 * struct cfg80211_nan_match_params - NAN match parameters
8698 * @type: the type of the function that triggered a match. If it is
8699 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
8700 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
8701 * result.
8702 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
8703 * @inst_id: the local instance id
8704 * @peer_inst_id: the instance id of the peer's function
8705 * @addr: the MAC address of the peer
8706 * @info_len: the length of the &info
8707 * @info: the Service Specific Info from the peer (if any)
8708 * @cookie: unique identifier of the corresponding function
8709 */
8710 struct cfg80211_nan_match_params {
8711 enum nl80211_nan_function_type type;
8712 u8 inst_id;
8713 u8 peer_inst_id;
8714 const u8 *addr;
8715 u8 info_len;
8716 const u8 *info;
8717 u64 cookie;
8718 };
8719
8720 /**
8721 * cfg80211_nan_match - report a match for a NAN function.
8722 * @wdev: the wireless device reporting the match
8723 * @match: match notification parameters
8724 * @gfp: allocation flags
8725 *
8726 * This function reports that the a NAN function had a match. This
8727 * can be a subscribe that had a match or a solicited publish that
8728 * was sent. It can also be a follow up that was received.
8729 */
8730 void cfg80211_nan_match(struct wireless_dev *wdev,
8731 struct cfg80211_nan_match_params *match, gfp_t gfp);
8732
8733 /**
8734 * cfg80211_nan_func_terminated - notify about NAN function termination.
8735 *
8736 * @wdev: the wireless device reporting the match
8737 * @inst_id: the local instance id
8738 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
8739 * @cookie: unique NAN function identifier
8740 * @gfp: allocation flags
8741 *
8742 * This function reports that the a NAN function is terminated.
8743 */
8744 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
8745 u8 inst_id,
8746 enum nl80211_nan_func_term_reason reason,
8747 u64 cookie, gfp_t gfp);
8748
8749 /* ethtool helper */
8750 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
8751
8752 /**
8753 * cfg80211_external_auth_request - userspace request for authentication
8754 * @netdev: network device
8755 * @params: External authentication parameters
8756 * @gfp: allocation flags
8757 * Returns: 0 on success, < 0 on error
8758 */
8759 int cfg80211_external_auth_request(struct net_device *netdev,
8760 struct cfg80211_external_auth_params *params,
8761 gfp_t gfp);
8762
8763 /**
8764 * cfg80211_pmsr_report - report peer measurement result data
8765 * @wdev: the wireless device reporting the measurement
8766 * @req: the original measurement request
8767 * @result: the result data
8768 * @gfp: allocation flags
8769 */
8770 void cfg80211_pmsr_report(struct wireless_dev *wdev,
8771 struct cfg80211_pmsr_request *req,
8772 struct cfg80211_pmsr_result *result,
8773 gfp_t gfp);
8774
8775 /**
8776 * cfg80211_pmsr_complete - report peer measurement completed
8777 * @wdev: the wireless device reporting the measurement
8778 * @req: the original measurement request
8779 * @gfp: allocation flags
8780 *
8781 * Report that the entire measurement completed, after this
8782 * the request pointer will no longer be valid.
8783 */
8784 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
8785 struct cfg80211_pmsr_request *req,
8786 gfp_t gfp);
8787
8788 /**
8789 * cfg80211_iftype_allowed - check whether the interface can be allowed
8790 * @wiphy: the wiphy
8791 * @iftype: interface type
8792 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
8793 * @check_swif: check iftype against software interfaces
8794 *
8795 * Check whether the interface is allowed to operate; additionally, this API
8796 * can be used to check iftype against the software interfaces when
8797 * check_swif is '1'.
8798 */
8799 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
8800 bool is_4addr, u8 check_swif);
8801
8802
8803 /**
8804 * cfg80211_assoc_comeback - notification of association that was
8805 * temporarly rejected with a comeback
8806 * @netdev: network device
8807 * @ap_addr: AP (MLD) address that rejected the assocation
8808 * @timeout: timeout interval value TUs.
8809 *
8810 * this function may sleep. the caller must hold the corresponding wdev's mutex.
8811 */
8812 void cfg80211_assoc_comeback(struct net_device *netdev,
8813 const u8 *ap_addr, u32 timeout);
8814
8815 /* Logging, debugging and troubleshooting/diagnostic helpers. */
8816
8817 /* wiphy_printk helpers, similar to dev_printk */
8818
8819 #define wiphy_printk(level, wiphy, format, args...) \
8820 dev_printk(level, &(wiphy)->dev, format, ##args)
8821 #define wiphy_emerg(wiphy, format, args...) \
8822 dev_emerg(&(wiphy)->dev, format, ##args)
8823 #define wiphy_alert(wiphy, format, args...) \
8824 dev_alert(&(wiphy)->dev, format, ##args)
8825 #define wiphy_crit(wiphy, format, args...) \
8826 dev_crit(&(wiphy)->dev, format, ##args)
8827 #define wiphy_err(wiphy, format, args...) \
8828 dev_err(&(wiphy)->dev, format, ##args)
8829 #define wiphy_warn(wiphy, format, args...) \
8830 dev_warn(&(wiphy)->dev, format, ##args)
8831 #define wiphy_notice(wiphy, format, args...) \
8832 dev_notice(&(wiphy)->dev, format, ##args)
8833 #define wiphy_info(wiphy, format, args...) \
8834 dev_info(&(wiphy)->dev, format, ##args)
8835 #define wiphy_info_once(wiphy, format, args...) \
8836 dev_info_once(&(wiphy)->dev, format, ##args)
8837
8838 #define wiphy_err_ratelimited(wiphy, format, args...) \
8839 dev_err_ratelimited(&(wiphy)->dev, format, ##args)
8840 #define wiphy_warn_ratelimited(wiphy, format, args...) \
8841 dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
8842
8843 #define wiphy_debug(wiphy, format, args...) \
8844 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
8845
8846 #define wiphy_dbg(wiphy, format, args...) \
8847 dev_dbg(&(wiphy)->dev, format, ##args)
8848
8849 #if defined(VERBOSE_DEBUG)
8850 #define wiphy_vdbg wiphy_dbg
8851 #else
8852 #define wiphy_vdbg(wiphy, format, args...) \
8853 ({ \
8854 if (0) \
8855 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
8856 0; \
8857 })
8858 #endif
8859
8860 /*
8861 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
8862 * of using a WARN/WARN_ON to get the message out, including the
8863 * file/line information and a backtrace.
8864 */
8865 #define wiphy_WARN(wiphy, format, args...) \
8866 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
8867
8868 /**
8869 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
8870 * @netdev: network device
8871 * @owe_info: peer's owe info
8872 * @gfp: allocation flags
8873 */
8874 void cfg80211_update_owe_info_event(struct net_device *netdev,
8875 struct cfg80211_update_owe_info *owe_info,
8876 gfp_t gfp);
8877
8878 /**
8879 * cfg80211_bss_flush - resets all the scan entries
8880 * @wiphy: the wiphy
8881 */
8882 void cfg80211_bss_flush(struct wiphy *wiphy);
8883
8884 /**
8885 * cfg80211_bss_color_notify - notify about bss color event
8886 * @dev: network device
8887 * @gfp: allocation flags
8888 * @cmd: the actual event we want to notify
8889 * @count: the number of TBTTs until the color change happens
8890 * @color_bitmap: representations of the colors that the local BSS is aware of
8891 */
8892 int cfg80211_bss_color_notify(struct net_device *dev, gfp_t gfp,
8893 enum nl80211_commands cmd, u8 count,
8894 u64 color_bitmap);
8895
8896 /**
8897 * cfg80211_obss_color_collision_notify - notify about bss color collision
8898 * @dev: network device
8899 * @color_bitmap: representations of the colors that the local BSS is aware of
8900 */
cfg80211_obss_color_collision_notify(struct net_device * dev,u64 color_bitmap)8901 static inline int cfg80211_obss_color_collision_notify(struct net_device *dev,
8902 u64 color_bitmap)
8903 {
8904 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8905 NL80211_CMD_OBSS_COLOR_COLLISION,
8906 0, color_bitmap);
8907 }
8908
8909 /**
8910 * cfg80211_color_change_started_notify - notify color change start
8911 * @dev: the device on which the color is switched
8912 * @count: the number of TBTTs until the color change happens
8913 *
8914 * Inform the userspace about the color change that has started.
8915 */
cfg80211_color_change_started_notify(struct net_device * dev,u8 count)8916 static inline int cfg80211_color_change_started_notify(struct net_device *dev,
8917 u8 count)
8918 {
8919 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8920 NL80211_CMD_COLOR_CHANGE_STARTED,
8921 count, 0);
8922 }
8923
8924 /**
8925 * cfg80211_color_change_aborted_notify - notify color change abort
8926 * @dev: the device on which the color is switched
8927 *
8928 * Inform the userspace about the color change that has aborted.
8929 */
cfg80211_color_change_aborted_notify(struct net_device * dev)8930 static inline int cfg80211_color_change_aborted_notify(struct net_device *dev)
8931 {
8932 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8933 NL80211_CMD_COLOR_CHANGE_ABORTED,
8934 0, 0);
8935 }
8936
8937 /**
8938 * cfg80211_color_change_notify - notify color change completion
8939 * @dev: the device on which the color was switched
8940 *
8941 * Inform the userspace about the color change that has completed.
8942 */
cfg80211_color_change_notify(struct net_device * dev)8943 static inline int cfg80211_color_change_notify(struct net_device *dev)
8944 {
8945 return cfg80211_bss_color_notify(dev, GFP_KERNEL,
8946 NL80211_CMD_COLOR_CHANGE_COMPLETED,
8947 0, 0);
8948 }
8949
8950 /**
8951 * cfg80211_valid_disable_subchannel_bitmap - validate puncturing bitmap
8952 * @bitmap: bitmap to be validated
8953 * @chandef: channel definition
8954 *
8955 * Validate the puncturing bitmap.
8956 *
8957 * Return: %true if the bitmap is valid. %false otherwise.
8958 */
8959 bool cfg80211_valid_disable_subchannel_bitmap(u16 *bitmap,
8960 const struct cfg80211_chan_def *chandef);
8961
8962 #endif /* __NET_CFG80211_H */
8963