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