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