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