1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
4 * 802.11 device and configuration interface
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright 2015-2017 Intel Deutschland GmbH
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.
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>
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.
37 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
43 * DOC: Device registration
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
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.
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.
67 * wireless hardware capability structures
71 * enum ieee80211_channel_flags - channel flags
73 * Channel flags set by the regulatory control code.
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
81 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
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
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
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
98 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
102 enum ieee80211_channel_flags {
103 IEEE80211_CHAN_DISABLED = 1<<0,
104 IEEE80211_CHAN_NO_IR = 1<<1,
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,
118 #define IEEE80211_CHAN_NO_HT40 \
119 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
121 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
122 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
125 * struct ieee80211_channel - channel definition
127 * This structure describes a single channel for use
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
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.
149 struct ieee80211_channel {
150 enum nl80211_band band;
154 int max_antenna_gain;
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;
166 * enum ieee80211_rate_flags - rate flags
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.
172 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
173 * preamble on this bitrate; only relevant in 2.4GHz band and
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
188 enum ieee80211_rate_flags {
189 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
190 IEEE80211_RATE_MANDATORY_A = 1<<1,
191 IEEE80211_RATE_MANDATORY_B = 1<<2,
192 IEEE80211_RATE_MANDATORY_G = 1<<3,
193 IEEE80211_RATE_ERP_G = 1<<4,
194 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
195 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
199 * enum ieee80211_bss_type - BSS type filter
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
207 enum ieee80211_bss_type {
208 IEEE80211_BSS_TYPE_ESS,
209 IEEE80211_BSS_TYPE_PBSS,
210 IEEE80211_BSS_TYPE_IBSS,
211 IEEE80211_BSS_TYPE_MBSS,
212 IEEE80211_BSS_TYPE_ANY
216 * enum ieee80211_privacy - BSS privacy filter
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
222 enum ieee80211_privacy {
223 IEEE80211_PRIVACY_ON,
224 IEEE80211_PRIVACY_OFF,
225 IEEE80211_PRIVACY_ANY
228 #define IEEE80211_PRIVACY(x) \
229 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
232 * struct ieee80211_rate - bitrate definition
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
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
245 struct ieee80211_rate {
248 u16 hw_value, hw_value_short;
252 * struct ieee80211_sta_ht_cap - STA's HT capabilities
254 * This structure describes most essential parameters needed
255 * to describe 802.11n HT capabilities for an STA.
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
263 struct ieee80211_sta_ht_cap {
264 u16 cap; /* use IEEE80211_HT_CAP_ */
268 struct ieee80211_mcs_info mcs;
272 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
274 * This structure describes most essential parameters needed
275 * to describe 802.11ac VHT capabilities for an STA.
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
281 struct ieee80211_sta_vht_cap {
283 u32 cap; /* use IEEE80211_VHT_CAP_ */
284 struct ieee80211_vht_mcs_info vht_mcs;
288 * struct ieee80211_supported_band - frequency band definition
290 * This structure describes a frequency band a wiphy
291 * is able to operate in.
293 * @channels: Array of channels the hardware can operate in
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
304 struct ieee80211_supported_band {
305 struct ieee80211_channel *channels;
306 struct ieee80211_rate *bitrates;
307 enum nl80211_band band;
310 struct ieee80211_sta_ht_cap ht_cap;
311 struct ieee80211_sta_vht_cap vht_cap;
315 * wiphy_read_of_freq_limits - read frequency limits from device tree
317 * @wiphy: the wireless device to get extra limits for
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).
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.
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().
334 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
335 #else /* CONFIG_OF */
336 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
339 #endif /* !CONFIG_OF */
343 * Wireless hardware/device configuration structures and methods
347 * DOC: Actions and configuration
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.
354 * Additionally, some operations are asynchronous and expect to get status
355 * information via some functions that drivers need to call.
357 * Scanning and BSS list handling with its associated functionality is described
358 * in a separate chapter.
361 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
362 WLAN_USER_POSITION_LEN)
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
383 u8 macaddr[ETH_ALEN];
384 const u8 *vht_mumimo_groups;
385 const u8 *vht_mumimo_follow_addr;
389 * struct key_params - key information
391 * Information about a key
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.
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)
417 struct cfg80211_chan_def {
418 struct ieee80211_channel *chan;
419 enum nl80211_chan_width width;
425 * cfg80211_get_chandef_type - return old channel type from chandef
426 * @chandef: the channel definition
428 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
429 * chandef, which must have a bandwidth allowing this conversion.
431 static inline enum nl80211_channel_type
432 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
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;
445 return NL80211_CHAN_NO_HT;
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
455 * Given a channel type, create a channel definition.
457 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
458 struct ieee80211_channel *channel,
459 enum nl80211_channel_type chantype);
462 * cfg80211_chandef_identical - check if two channel definitions are identical
463 * @chandef1: first channel definition
464 * @chandef2: second channel definition
466 * Return: %true if the channels defined by the channel definitions are
467 * identical, %false otherwise.
470 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
471 const struct cfg80211_chan_def *chandef2)
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);
480 * cfg80211_chandef_compatible - check if two channel definitions are compatible
481 * @chandef1: first channel definition
482 * @chandef2: second channel definition
484 * Return: %NULL if the given channel definitions are incompatible,
485 * chandef1 or chandef2 otherwise.
487 const struct cfg80211_chan_def *
488 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
489 const struct cfg80211_chan_def *chandef2);
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.
496 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
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.
505 bool cfg80211_chandef_usable(struct wiphy *wiphy,
506 const struct cfg80211_chan_def *chandef,
507 u32 prohibited_flags);
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
515 * 1 if radar detection is required, 0 if it is not, < 0 on error
517 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
518 const struct cfg80211_chan_def *chandef,
519 enum nl80211_iftype iftype);
522 * ieee80211_chandef_rate_flags - returns rate flags for a channel
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.
527 * @chandef: channel definition for the channel
529 * Returns: rate flags which apply for this channel
531 static inline enum ieee80211_rate_flags
532 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
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;
546 * ieee80211_chandef_max_power - maximum transmission power for the chandef
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.
552 * @chandef: channel definition for the channel
554 * Returns: maximum allowed transmission power in dBm for the chandef
557 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
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);
569 return chandef->chan->max_power;
573 * enum survey_info_flags - survey information flags
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
584 * Used by the driver to indicate which info in &struct survey_info
585 * it has filled in during the get_survey().
587 enum 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),
599 * struct survey_info - channel survey response
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
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
613 * Used by dump_survey() to report back per-channel survey information.
615 * This structure can later be expanded with things like
616 * channel duty cycle etc.
619 struct ieee80211_channel *channel;
630 #define CFG80211_MAX_WEP_KEYS 4
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
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)
654 struct cfg80211_crypto_settings {
657 int n_ciphers_pairwise;
658 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
660 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
662 __be16 control_port_ethertype;
663 bool control_port_no_encrypt;
664 struct key_params *wep_keys;
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
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)
688 struct 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;
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;
707 * struct cfg80211_acl_data - Access control list data
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
714 struct cfg80211_acl_data {
715 enum nl80211_acl_policy acl_policy;
719 struct mac_address mac_addrs[];
723 * cfg80211_bitrate_mask - masks for bitrate control
725 struct cfg80211_bitrate_mask {
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];
735 * struct cfg80211_ap_settings - AP configuration
737 * Used to configure an AP interface.
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
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
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
764 struct cfg80211_ap_settings {
765 struct cfg80211_chan_def chandef;
767 struct cfg80211_beacon_data beacon;
769 int beacon_interval, dtim_period;
772 enum nl80211_hidden_ssid hidden_ssid;
773 struct cfg80211_crypto_settings crypto;
775 enum nl80211_auth_type auth_type;
776 enum nl80211_smps_mode smps_mode;
777 int inactivity_timeout;
780 const struct cfg80211_acl_data *acl;
782 struct cfg80211_bitrate_mask beacon_rate;
784 const struct ieee80211_ht_cap *ht_cap;
785 const struct ieee80211_vht_cap *vht_cap;
786 bool ht_required, vht_required;
790 * struct cfg80211_csa_settings - channel switch settings
792 * Used for channel switch
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
805 struct 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;
818 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
821 * struct iface_combination_params - input parameters for interface combinations
823 * Used to pass interface combination parameters
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
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
837 struct iface_combination_params {
838 int num_different_channels;
840 int iftype_num[NUM_NL80211_IFTYPES];
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
850 * Not all station parameters have in-band "no change" signalling,
851 * for those that don't these flags will are used.
853 enum 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),
860 * struct station_parameters - station parameters
862 * Used to change and create a new station.
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
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
899 struct station_parameters {
900 const u8 *supported_rates;
901 struct net_device *vlan;
902 u32 sta_flags_mask, sta_flags_set;
907 u8 supported_rates_len;
910 const struct ieee80211_ht_cap *ht_capa;
911 const struct ieee80211_vht_cap *vht_capa;
914 enum nl80211_mesh_power_mode local_pm;
918 const u8 *supported_channels;
919 u8 supported_channels_len;
920 const u8 *supported_oper_classes;
921 u8 supported_oper_classes_len;
923 bool opmode_notif_used;
928 * struct station_del_parameters - station deletion parameters
930 * Used to delete a station entry (or all stations).
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
937 struct station_del_parameters {
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
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)
961 enum cfg80211_station_type {
962 CFG80211_STA_AP_CLIENT,
963 CFG80211_STA_AP_CLIENT_UNASSOC,
964 CFG80211_STA_AP_MLME_CLIENT,
967 CFG80211_STA_TDLS_PEER_SETUP,
968 CFG80211_STA_TDLS_PEER_ACTIVE,
969 CFG80211_STA_MESH_PEER_KERNEL,
970 CFG80211_STA_MESH_PEER_USER,
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
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.
985 int cfg80211_check_station_change(struct wiphy *wiphy,
986 struct station_parameters *params,
987 enum cfg80211_station_type statype);
990 * enum station_info_rate_flags - bitrate info flags
992 * Used by the driver to indicate the specific rate transmission
993 * type for 802.11n transmissions.
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
1000 enum 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),
1008 * enum rate_info_bw - rate bandwidth information
1010 * Used by the driver to indicate the rate bandwidth.
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
1020 RATE_INFO_BW_20 = 0,
1029 * struct rate_info - bitrate information
1031 * Information about a receiving or transmitting bitrate
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)
1048 * enum station_info_rate_flags - bitrate info flags
1050 * Used by the driver to indicate the specific rate transmission
1051 * type for 802.11n transmissions.
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
1057 enum 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,
1064 * struct sta_bss_parameters - BSS parameters for the attached station
1066 * Information about the currently associated BSS
1068 * @flags: bitflag of flags from &enum bss_param_flags
1069 * @dtim_period: DTIM period for the BSS
1070 * @beacon_interval: beacon interval
1072 struct sta_bss_parameters {
1075 u16 beacon_interval;
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
1086 * @tx_msdu_failed: number of failed transmitted MSDUs
1088 struct cfg80211_tid_stats {
1092 u64 tx_msdu_retries;
1096 #define IEEE80211_MAX_CHAINS 4
1099 * struct station_info - station information
1101 * Station information filled by driver for get_station() and dump_station.
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
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 * @ack_signal: signal strength (in dBm) of the last ACK frame.
1152 struct station_info {
1165 s8 chain_signal[IEEE80211_MAX_CHAINS];
1166 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1168 struct rate_info txrate;
1169 struct rate_info rxrate;
1174 u32 rx_dropped_misc;
1175 struct sta_bss_parameters bss_param;
1176 struct nl80211_sta_flag_update sta_flags;
1180 const u8 *assoc_req_ies;
1181 size_t assoc_req_ies_len;
1183 u32 beacon_loss_count;
1185 enum nl80211_mesh_power_mode local_pm;
1186 enum nl80211_mesh_power_mode peer_pm;
1187 enum nl80211_mesh_power_mode nonpeer_pm;
1189 u32 expected_throughput;
1193 u8 rx_beacon_signal_avg;
1194 struct cfg80211_tid_stats pertid[IEEE80211_NUM_TIDS + 1];
1198 #if IS_ENABLED(CONFIG_CFG80211)
1200 * cfg80211_get_station - retrieve information about a given station
1201 * @dev: the device where the station is supposed to be connected to
1202 * @mac_addr: the mac address of the station of interest
1203 * @sinfo: pointer to the structure to fill with the information
1205 * Returns 0 on success and sinfo is filled with the available information
1206 * otherwise returns a negative error code and the content of sinfo has to be
1207 * considered undefined.
1209 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1210 struct station_info *sinfo);
1212 static inline int cfg80211_get_station(struct net_device *dev,
1214 struct station_info *sinfo)
1221 * enum monitor_flags - monitor flags
1223 * Monitor interface configuration flags. Note that these must be the bits
1224 * according to the nl80211 flags.
1226 * @MONITOR_FLAG_CHANGED: set if the flags were changed
1227 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1228 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1229 * @MONITOR_FLAG_CONTROL: pass control frames
1230 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1231 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1232 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1234 enum monitor_flags {
1235 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
1236 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1237 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1238 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1239 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1240 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1241 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1245 * enum mpath_info_flags - mesh path information flags
1247 * Used by the driver to indicate which info in &struct mpath_info it has filled
1248 * in during get_station() or dump_station().
1250 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1251 * @MPATH_INFO_SN: @sn filled
1252 * @MPATH_INFO_METRIC: @metric filled
1253 * @MPATH_INFO_EXPTIME: @exptime filled
1254 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1255 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1256 * @MPATH_INFO_FLAGS: @flags filled
1258 enum mpath_info_flags {
1259 MPATH_INFO_FRAME_QLEN = BIT(0),
1260 MPATH_INFO_SN = BIT(1),
1261 MPATH_INFO_METRIC = BIT(2),
1262 MPATH_INFO_EXPTIME = BIT(3),
1263 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1264 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1265 MPATH_INFO_FLAGS = BIT(6),
1269 * struct mpath_info - mesh path information
1271 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1273 * @filled: bitfield of flags from &enum mpath_info_flags
1274 * @frame_qlen: number of queued frames for this destination
1275 * @sn: target sequence number
1276 * @metric: metric (cost) of this mesh path
1277 * @exptime: expiration time for the mesh path from now, in msecs
1278 * @flags: mesh path flags
1279 * @discovery_timeout: total mesh path discovery timeout, in msecs
1280 * @discovery_retries: mesh path discovery retries
1281 * @generation: generation number for nl80211 dumps.
1282 * This number should increase every time the list of mesh paths
1283 * changes, i.e. when a station is added or removed, so that
1284 * userspace can tell whether it got a consistent snapshot.
1292 u32 discovery_timeout;
1293 u8 discovery_retries;
1300 * struct bss_parameters - BSS parameters
1302 * Used to change BSS parameters (mainly for AP mode).
1304 * @use_cts_prot: Whether to use CTS protection
1305 * (0 = no, 1 = yes, -1 = do not change)
1306 * @use_short_preamble: Whether the use of short preambles is allowed
1307 * (0 = no, 1 = yes, -1 = do not change)
1308 * @use_short_slot_time: Whether the use of short slot time is allowed
1309 * (0 = no, 1 = yes, -1 = do not change)
1310 * @basic_rates: basic rates in IEEE 802.11 format
1311 * (or NULL for no change)
1312 * @basic_rates_len: number of basic rates
1313 * @ap_isolate: do not forward packets between connected stations
1314 * @ht_opmode: HT Operation mode
1315 * (u16 = opmode, -1 = do not change)
1316 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1317 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1319 struct bss_parameters {
1321 int use_short_preamble;
1322 int use_short_slot_time;
1323 const u8 *basic_rates;
1327 s8 p2p_ctwindow, p2p_opp_ps;
1331 * struct mesh_config - 802.11s mesh configuration
1333 * These parameters can be changed while the mesh is active.
1335 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1336 * by the Mesh Peering Open message
1337 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1338 * used by the Mesh Peering Open message
1339 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1340 * the mesh peering management to close a mesh peering
1341 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1343 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1344 * be sent to establish a new peer link instance in a mesh
1345 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1346 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1348 * @auto_open_plinks: whether we should automatically open peer links when we
1349 * detect compatible mesh peers
1350 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1351 * synchronize to for 11s default synchronization method
1352 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1353 * that an originator mesh STA can send to a particular path target
1354 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1355 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1356 * a path discovery in milliseconds
1357 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1358 * receiving a PREQ shall consider the forwarding information from the
1359 * root to be valid. (TU = time unit)
1360 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1361 * which a mesh STA can send only one action frame containing a PREQ
1363 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1364 * which a mesh STA can send only one Action frame containing a PERR
1366 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1367 * it takes for an HWMP information element to propagate across the mesh
1368 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1369 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1370 * announcements are transmitted
1371 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1372 * station has access to a broader network beyond the MBSS. (This is
1373 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1374 * only means that the station will announce others it's a mesh gate, but
1375 * not necessarily using the gate announcement protocol. Still keeping the
1376 * same nomenclature to be in sync with the spec)
1377 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1378 * entity (default is TRUE - forwarding entity)
1379 * @rssi_threshold: the threshold for average signal strength of candidate
1380 * station to establish a peer link
1381 * @ht_opmode: mesh HT protection mode
1383 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1384 * receiving a proactive PREQ shall consider the forwarding information to
1385 * the root mesh STA to be valid.
1387 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1388 * PREQs are transmitted.
1389 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1390 * during which a mesh STA can send only one Action frame containing
1391 * a PREQ element for root path confirmation.
1392 * @power_mode: The default mesh power save mode which will be the initial
1393 * setting for new peer links.
1394 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1395 * after transmitting its beacon.
1396 * @plink_timeout: If no tx activity is seen from a STA we've established
1397 * peering with for longer than this time (in seconds), then remove it
1398 * from the STA's list of peers. Default is 30 minutes.
1400 struct mesh_config {
1401 u16 dot11MeshRetryTimeout;
1402 u16 dot11MeshConfirmTimeout;
1403 u16 dot11MeshHoldingTimeout;
1404 u16 dot11MeshMaxPeerLinks;
1405 u8 dot11MeshMaxRetries;
1408 bool auto_open_plinks;
1409 u32 dot11MeshNbrOffsetMaxNeighbor;
1410 u8 dot11MeshHWMPmaxPREQretries;
1411 u32 path_refresh_time;
1412 u16 min_discovery_timeout;
1413 u32 dot11MeshHWMPactivePathTimeout;
1414 u16 dot11MeshHWMPpreqMinInterval;
1415 u16 dot11MeshHWMPperrMinInterval;
1416 u16 dot11MeshHWMPnetDiameterTraversalTime;
1417 u8 dot11MeshHWMPRootMode;
1418 u16 dot11MeshHWMPRannInterval;
1419 bool dot11MeshGateAnnouncementProtocol;
1420 bool dot11MeshForwarding;
1423 u32 dot11MeshHWMPactivePathToRootTimeout;
1424 u16 dot11MeshHWMProotInterval;
1425 u16 dot11MeshHWMPconfirmationInterval;
1426 enum nl80211_mesh_power_mode power_mode;
1427 u16 dot11MeshAwakeWindowDuration;
1432 * struct mesh_setup - 802.11s mesh setup configuration
1433 * @chandef: defines the channel to use
1434 * @mesh_id: the mesh ID
1435 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1436 * @sync_method: which synchronization method to use
1437 * @path_sel_proto: which path selection protocol to use
1438 * @path_metric: which metric to use
1439 * @auth_id: which authentication method this mesh is using
1440 * @ie: vendor information elements (optional)
1441 * @ie_len: length of vendor information elements
1442 * @is_authenticated: this mesh requires authentication
1443 * @is_secure: this mesh uses security
1444 * @user_mpm: userspace handles all MPM functions
1445 * @dtim_period: DTIM period to use
1446 * @beacon_interval: beacon interval to use
1447 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1448 * @basic_rates: basic rates to use when creating the mesh
1449 * @beacon_rate: bitrate to be used for beacons
1450 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1451 * changes the channel when a radar is detected. This is required
1452 * to operate on DFS channels.
1454 * These parameters are fixed when the mesh is created.
1457 struct cfg80211_chan_def chandef;
1466 bool is_authenticated;
1470 u16 beacon_interval;
1471 int mcast_rate[NUM_NL80211_BANDS];
1473 struct cfg80211_bitrate_mask beacon_rate;
1474 bool userspace_handles_dfs;
1478 * struct ocb_setup - 802.11p OCB mode setup configuration
1479 * @chandef: defines the channel to use
1481 * These parameters are fixed when connecting to the network
1484 struct cfg80211_chan_def chandef;
1488 * struct ieee80211_txq_params - TX queue parameters
1489 * @ac: AC identifier
1490 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1491 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1493 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1495 * @aifs: Arbitration interframe space [0..255]
1497 struct ieee80211_txq_params {
1506 * DOC: Scanning and BSS list handling
1508 * The scanning process itself is fairly simple, but cfg80211 offers quite
1509 * a bit of helper functionality. To start a scan, the scan operation will
1510 * be invoked with a scan definition. This scan definition contains the
1511 * channels to scan, and the SSIDs to send probe requests for (including the
1512 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1513 * probe. Additionally, a scan request may contain extra information elements
1514 * that should be added to the probe request. The IEs are guaranteed to be
1515 * well-formed, and will not exceed the maximum length the driver advertised
1516 * in the wiphy structure.
1518 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1519 * it is responsible for maintaining the BSS list; the driver should not
1520 * maintain a list itself. For this notification, various functions exist.
1522 * Since drivers do not maintain a BSS list, there are also a number of
1523 * functions to search for a BSS and obtain information about it from the
1524 * BSS structure cfg80211 maintains. The BSS list is also made available
1529 * struct cfg80211_ssid - SSID description
1531 * @ssid_len: length of the ssid
1533 struct cfg80211_ssid {
1534 u8 ssid[IEEE80211_MAX_SSID_LEN];
1539 * struct cfg80211_scan_info - information about completed scan
1540 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1541 * wireless device that requested the scan is connected to. If this
1542 * information is not available, this field is left zero.
1543 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1544 * @aborted: set to true if the scan was aborted for any reason,
1545 * userspace will be notified of that
1547 struct cfg80211_scan_info {
1549 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1554 * struct cfg80211_scan_request - scan request description
1556 * @ssids: SSIDs to scan for (active scan only)
1557 * @n_ssids: number of SSIDs
1558 * @channels: channels to scan on.
1559 * @n_channels: total number of channels to scan
1560 * @scan_width: channel width for scanning
1561 * @ie: optional information element(s) to add into Probe Request or %NULL
1562 * @ie_len: length of ie in octets
1563 * @duration: how long to listen on each channel, in TUs. If
1564 * %duration_mandatory is not set, this is the maximum dwell time and
1565 * the actual dwell time may be shorter.
1566 * @duration_mandatory: if set, the scan duration must be as specified by the
1568 * @flags: bit field of flags controlling operation
1569 * @rates: bitmap of rates to advertise for each band
1570 * @wiphy: the wiphy this was for
1571 * @scan_start: time (in jiffies) when the scan started
1572 * @wdev: the wireless device to scan for
1573 * @info: (internal) information about completed scan
1574 * @notified: (internal) scan request was notified as done or aborted
1575 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1576 * @mac_addr: MAC address used with randomisation
1577 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1578 * are 0 in the mask should be randomised, bits that are 1 should
1579 * be taken from the @mac_addr
1580 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1582 struct cfg80211_scan_request {
1583 struct cfg80211_ssid *ssids;
1586 enum nl80211_bss_scan_width scan_width;
1590 bool duration_mandatory;
1593 u32 rates[NUM_NL80211_BANDS];
1595 struct wireless_dev *wdev;
1597 u8 mac_addr[ETH_ALEN] __aligned(2);
1598 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1599 u8 bssid[ETH_ALEN] __aligned(2);
1602 struct wiphy *wiphy;
1603 unsigned long scan_start;
1604 struct cfg80211_scan_info info;
1609 struct ieee80211_channel *channels[0];
1612 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1616 get_random_bytes(buf, ETH_ALEN);
1617 for (i = 0; i < ETH_ALEN; i++) {
1619 buf[i] |= addr[i] & mask[i];
1624 * struct cfg80211_match_set - sets of attributes to match
1626 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
1627 * or no match (RSSI only)
1628 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
1629 * or no match (RSSI only)
1630 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1632 struct cfg80211_match_set {
1633 struct cfg80211_ssid ssid;
1639 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1641 * @interval: interval between scheduled scan iterations. In seconds.
1642 * @iterations: number of scan iterations in this scan plan. Zero means
1644 * The last scan plan will always have this parameter set to zero,
1645 * all other scan plans will have a finite number of iterations.
1647 struct cfg80211_sched_scan_plan {
1653 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1655 * @band: band of BSS which should match for RSSI level adjustment.
1656 * @delta: value of RSSI level adjustment.
1658 struct cfg80211_bss_select_adjust {
1659 enum nl80211_band band;
1664 * struct cfg80211_sched_scan_request - scheduled scan request description
1666 * @reqid: identifies this request.
1667 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1668 * @n_ssids: number of SSIDs
1669 * @n_channels: total number of channels to scan
1670 * @scan_width: channel width for scanning
1671 * @ie: optional information element(s) to add into Probe Request or %NULL
1672 * @ie_len: length of ie in octets
1673 * @flags: bit field of flags controlling operation
1674 * @match_sets: sets of parameters to be matched for a scan result
1675 * entry to be considered valid and to be passed to the host
1676 * (others are filtered out).
1677 * If ommited, all results are passed.
1678 * @n_match_sets: number of match sets
1679 * @report_results: indicates that results were reported for this request
1680 * @wiphy: the wiphy this was for
1681 * @dev: the interface
1682 * @scan_start: start time of the scheduled scan
1683 * @channels: channels to scan
1684 * @min_rssi_thold: for drivers only supporting a single threshold, this
1685 * contains the minimum over all matchsets
1686 * @mac_addr: MAC address used with randomisation
1687 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1688 * are 0 in the mask should be randomised, bits that are 1 should
1689 * be taken from the @mac_addr
1690 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1691 * index must be executed first.
1692 * @n_scan_plans: number of scan plans, at least 1.
1693 * @rcu_head: RCU callback used to free the struct
1694 * @owner_nlportid: netlink portid of owner (if this should is a request
1695 * owned by a particular socket)
1696 * @nl_owner_dead: netlink owner socket was closed - this request be freed
1697 * @list: for keeping list of requests.
1698 * @delay: delay in seconds to use before starting the first scan
1699 * cycle. The driver may ignore this parameter and start
1700 * immediately (or at any other time), if this feature is not
1702 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
1703 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
1704 * reporting in connected state to cases where a matching BSS is determined
1705 * to have better or slightly worse RSSI than the current connected BSS.
1706 * The relative RSSI threshold values are ignored in disconnected state.
1707 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
1708 * to the specified band while deciding whether a better BSS is reported
1709 * using @relative_rssi. If delta is a negative number, the BSSs that
1710 * belong to the specified band will be penalized by delta dB in relative
1713 struct cfg80211_sched_scan_request {
1715 struct cfg80211_ssid *ssids;
1718 enum nl80211_bss_scan_width scan_width;
1722 struct cfg80211_match_set *match_sets;
1726 struct cfg80211_sched_scan_plan *scan_plans;
1729 u8 mac_addr[ETH_ALEN] __aligned(2);
1730 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1732 bool relative_rssi_set;
1734 struct cfg80211_bss_select_adjust rssi_adjust;
1737 struct wiphy *wiphy;
1738 struct net_device *dev;
1739 unsigned long scan_start;
1740 bool report_results;
1741 struct rcu_head rcu_head;
1744 struct list_head list;
1747 struct ieee80211_channel *channels[0];
1751 * enum cfg80211_signal_type - signal type
1753 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1754 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1755 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1757 enum cfg80211_signal_type {
1758 CFG80211_SIGNAL_TYPE_NONE,
1759 CFG80211_SIGNAL_TYPE_MBM,
1760 CFG80211_SIGNAL_TYPE_UNSPEC,
1764 * struct cfg80211_inform_bss - BSS inform data
1765 * @chan: channel the frame was received on
1766 * @scan_width: scan width that was used
1767 * @signal: signal strength value, according to the wiphy's
1769 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1770 * received; should match the time when the frame was actually
1771 * received by the device (not just by the host, in case it was
1772 * buffered on the device) and be accurate to about 10ms.
1773 * If the frame isn't buffered, just passing the return value of
1774 * ktime_get_boot_ns() is likely appropriate.
1775 * @parent_tsf: the time at the start of reception of the first octet of the
1776 * timestamp field of the frame. The time is the TSF of the BSS specified
1778 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1779 * the BSS that requested the scan in which the beacon/probe was received.
1780 * @chains: bitmask for filled values in @chain_signal.
1781 * @chain_signal: per-chain signal strength of last received BSS in dBm.
1783 struct cfg80211_inform_bss {
1784 struct ieee80211_channel *chan;
1785 enum nl80211_bss_scan_width scan_width;
1789 u8 parent_bssid[ETH_ALEN] __aligned(2);
1791 s8 chain_signal[IEEE80211_MAX_CHAINS];
1795 * struct cfg80211_bss_ies - BSS entry IE data
1796 * @tsf: TSF contained in the frame that carried these IEs
1797 * @rcu_head: internal use, for freeing
1798 * @len: length of the IEs
1799 * @from_beacon: these IEs are known to come from a beacon
1802 struct cfg80211_bss_ies {
1804 struct rcu_head rcu_head;
1811 * struct cfg80211_bss - BSS description
1813 * This structure describes a BSS (which may also be a mesh network)
1814 * for use in scan results and similar.
1816 * @channel: channel this BSS is on
1817 * @scan_width: width of the control channel
1818 * @bssid: BSSID of the BSS
1819 * @beacon_interval: the beacon interval as from the frame
1820 * @capability: the capability field in host byte order
1821 * @ies: the information elements (Note that there is no guarantee that these
1822 * are well-formed!); this is a pointer to either the beacon_ies or
1823 * proberesp_ies depending on whether Probe Response frame has been
1824 * received. It is always non-%NULL.
1825 * @beacon_ies: the information elements from the last Beacon frame
1826 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1827 * own the beacon_ies, but they're just pointers to the ones from the
1828 * @hidden_beacon_bss struct)
1829 * @proberesp_ies: the information elements from the last Probe Response frame
1830 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1831 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1832 * that holds the beacon data. @beacon_ies is still valid, of course, and
1833 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1834 * @signal: signal strength value (type depends on the wiphy's signal_type)
1835 * @chains: bitmask for filled values in @chain_signal.
1836 * @chain_signal: per-chain signal strength of last received BSS in dBm.
1837 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1839 struct cfg80211_bss {
1840 struct ieee80211_channel *channel;
1841 enum nl80211_bss_scan_width scan_width;
1843 const struct cfg80211_bss_ies __rcu *ies;
1844 const struct cfg80211_bss_ies __rcu *beacon_ies;
1845 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1847 struct cfg80211_bss *hidden_beacon_bss;
1851 u16 beacon_interval;
1856 s8 chain_signal[IEEE80211_MAX_CHAINS];
1858 u8 priv[0] __aligned(sizeof(void *));
1862 * ieee80211_bss_get_ie - find IE with given ID
1863 * @bss: the bss to search
1866 * Note that the return value is an RCU-protected pointer, so
1867 * rcu_read_lock() must be held when calling this function.
1868 * Return: %NULL if not found.
1870 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1874 * struct cfg80211_auth_request - Authentication request data
1876 * This structure provides information needed to complete IEEE 802.11
1879 * @bss: The BSS to authenticate with, the callee must obtain a reference
1880 * to it if it needs to keep it.
1881 * @auth_type: Authentication type (algorithm)
1882 * @ie: Extra IEs to add to Authentication frame or %NULL
1883 * @ie_len: Length of ie buffer in octets
1884 * @key_len: length of WEP key for shared key authentication
1885 * @key_idx: index of WEP key for shared key authentication
1886 * @key: WEP key for shared key authentication
1887 * @auth_data: Fields and elements in Authentication frames. This contains
1888 * the authentication frame body (non-IE and IE data), excluding the
1889 * Authentication algorithm number, i.e., starting at the Authentication
1890 * transaction sequence number field.
1891 * @auth_data_len: Length of auth_data buffer in octets
1893 struct cfg80211_auth_request {
1894 struct cfg80211_bss *bss;
1897 enum nl80211_auth_type auth_type;
1899 u8 key_len, key_idx;
1900 const u8 *auth_data;
1901 size_t auth_data_len;
1905 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1907 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1908 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1909 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1910 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
1911 * authentication capability. Drivers can offload authentication to
1912 * userspace if this flag is set. Only applicable for cfg80211_connect()
1913 * request (connect callback).
1915 enum cfg80211_assoc_req_flags {
1916 ASSOC_REQ_DISABLE_HT = BIT(0),
1917 ASSOC_REQ_DISABLE_VHT = BIT(1),
1918 ASSOC_REQ_USE_RRM = BIT(2),
1919 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
1923 * struct cfg80211_assoc_request - (Re)Association request data
1925 * This structure provides information needed to complete IEEE 802.11
1927 * @bss: The BSS to associate with. If the call is successful the driver is
1928 * given a reference that it must give back to cfg80211_send_rx_assoc()
1929 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1930 * association requests while already associating must be rejected.
1931 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1932 * @ie_len: Length of ie buffer in octets
1933 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1934 * @crypto: crypto settings
1935 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1936 * to indicate a request to reassociate within the ESS instead of a request
1937 * do the initial association with the ESS. When included, this is set to
1938 * the BSSID of the current association, i.e., to the value that is
1939 * included in the Current AP address field of the Reassociation Request
1941 * @flags: See &enum cfg80211_assoc_req_flags
1942 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1943 * will be used in ht_capa. Un-supported values will be ignored.
1944 * @ht_capa_mask: The bits of ht_capa which are to be used.
1945 * @vht_capa: VHT capability override
1946 * @vht_capa_mask: VHT capability mask indicating which fields to use
1947 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
1948 * %NULL if FILS is not used.
1949 * @fils_kek_len: Length of fils_kek in octets
1950 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
1951 * Request/Response frame or %NULL if FILS is not used. This field starts
1952 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
1954 struct cfg80211_assoc_request {
1955 struct cfg80211_bss *bss;
1956 const u8 *ie, *prev_bssid;
1958 struct cfg80211_crypto_settings crypto;
1961 struct ieee80211_ht_cap ht_capa;
1962 struct ieee80211_ht_cap ht_capa_mask;
1963 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1965 size_t fils_kek_len;
1966 const u8 *fils_nonces;
1970 * struct cfg80211_deauth_request - Deauthentication request data
1972 * This structure provides information needed to complete IEEE 802.11
1975 * @bssid: the BSSID of the BSS to deauthenticate from
1976 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1977 * @ie_len: Length of ie buffer in octets
1978 * @reason_code: The reason code for the deauthentication
1979 * @local_state_change: if set, change local state only and
1980 * do not set a deauth frame
1982 struct cfg80211_deauth_request {
1987 bool local_state_change;
1991 * struct cfg80211_disassoc_request - Disassociation request data
1993 * This structure provides information needed to complete IEEE 802.11
1996 * @bss: the BSS to disassociate from
1997 * @ie: Extra IEs to add to Disassociation frame or %NULL
1998 * @ie_len: Length of ie buffer in octets
1999 * @reason_code: The reason code for the disassociation
2000 * @local_state_change: This is a request for a local state only, i.e., no
2001 * Disassociation frame is to be transmitted.
2003 struct cfg80211_disassoc_request {
2004 struct cfg80211_bss *bss;
2008 bool local_state_change;
2012 * struct cfg80211_ibss_params - IBSS parameters
2014 * This structure defines the IBSS parameters for the join_ibss()
2017 * @ssid: The SSID, will always be non-null.
2018 * @ssid_len: The length of the SSID, will always be non-zero.
2019 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2020 * search for IBSSs with a different BSSID.
2021 * @chandef: defines the channel to use if no other IBSS to join can be found
2022 * @channel_fixed: The channel should be fixed -- do not search for
2023 * IBSSs to join on other channels.
2024 * @ie: information element(s) to include in the beacon
2025 * @ie_len: length of that
2026 * @beacon_interval: beacon interval to use
2027 * @privacy: this is a protected network, keys will be configured
2029 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2030 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2031 * required to assume that the port is unauthorized until authorized by
2032 * user space. Otherwise, port is marked authorized by default.
2033 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2034 * changes the channel when a radar is detected. This is required
2035 * to operate on DFS channels.
2036 * @basic_rates: bitmap of basic rates to use when creating the IBSS
2037 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2038 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2039 * will be used in ht_capa. Un-supported values will be ignored.
2040 * @ht_capa_mask: The bits of ht_capa which are to be used.
2041 * @wep_keys: static WEP keys, if not NULL points to an array of
2042 * CFG80211_MAX_WEP_KEYS WEP keys
2043 * @wep_tx_key: key index (0..3) of the default TX static WEP key
2045 struct cfg80211_ibss_params {
2048 struct cfg80211_chan_def chandef;
2050 u8 ssid_len, ie_len;
2051 u16 beacon_interval;
2056 bool userspace_handles_dfs;
2057 int mcast_rate[NUM_NL80211_BANDS];
2058 struct ieee80211_ht_cap ht_capa;
2059 struct ieee80211_ht_cap ht_capa_mask;
2060 struct key_params *wep_keys;
2065 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2067 * @behaviour: requested BSS selection behaviour.
2068 * @param: parameters for requestion behaviour.
2069 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2070 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2072 struct cfg80211_bss_selection {
2073 enum nl80211_bss_select_attr behaviour;
2075 enum nl80211_band band_pref;
2076 struct cfg80211_bss_select_adjust adjust;
2081 * struct cfg80211_connect_params - Connection parameters
2083 * This structure provides information needed to complete IEEE 802.11
2084 * authentication and association.
2086 * @channel: The channel to use or %NULL if not specified (auto-select based
2088 * @channel_hint: The channel of the recommended BSS for initial connection or
2089 * %NULL if not specified
2090 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2092 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2093 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2094 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2097 * @ssid_len: Length of ssid in octets
2098 * @auth_type: Authentication type (algorithm)
2099 * @ie: IEs for association request
2100 * @ie_len: Length of assoc_ie in octets
2101 * @privacy: indicates whether privacy-enabled APs should be used
2102 * @mfp: indicate whether management frame protection is used
2103 * @crypto: crypto settings
2104 * @key_len: length of WEP key for shared key authentication
2105 * @key_idx: index of WEP key for shared key authentication
2106 * @key: WEP key for shared key authentication
2107 * @flags: See &enum cfg80211_assoc_req_flags
2108 * @bg_scan_period: Background scan period in seconds
2109 * or -1 to indicate that default value is to be used.
2110 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
2111 * will be used in ht_capa. Un-supported values will be ignored.
2112 * @ht_capa_mask: The bits of ht_capa which are to be used.
2113 * @vht_capa: VHT Capability overrides
2114 * @vht_capa_mask: The bits of vht_capa which are to be used.
2115 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2117 * @bss_select: criteria to be used for BSS selection.
2118 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2119 * to indicate a request to reassociate within the ESS instead of a request
2120 * do the initial association with the ESS. When included, this is set to
2121 * the BSSID of the current association, i.e., to the value that is
2122 * included in the Current AP address field of the Reassociation Request
2124 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2125 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2127 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2128 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2129 * %NULL if not specified. This specifies the domain name of ER server and
2130 * is used to construct FILS wrapped data IE.
2131 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2132 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2133 * messages. This is also used to construct FILS wrapped data IE.
2134 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2135 * keys in FILS or %NULL if not specified.
2136 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2137 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2138 * offload of 4-way handshake.
2140 struct cfg80211_connect_params {
2141 struct ieee80211_channel *channel;
2142 struct ieee80211_channel *channel_hint;
2144 const u8 *bssid_hint;
2147 enum nl80211_auth_type auth_type;
2151 enum nl80211_mfp mfp;
2152 struct cfg80211_crypto_settings crypto;
2154 u8 key_len, key_idx;
2157 struct ieee80211_ht_cap ht_capa;
2158 struct ieee80211_ht_cap ht_capa_mask;
2159 struct ieee80211_vht_cap vht_capa;
2160 struct ieee80211_vht_cap vht_capa_mask;
2162 struct cfg80211_bss_selection bss_select;
2163 const u8 *prev_bssid;
2164 const u8 *fils_erp_username;
2165 size_t fils_erp_username_len;
2166 const u8 *fils_erp_realm;
2167 size_t fils_erp_realm_len;
2168 u16 fils_erp_next_seq_num;
2169 const u8 *fils_erp_rrk;
2170 size_t fils_erp_rrk_len;
2175 * enum cfg80211_connect_params_changed - Connection parameters being updated
2177 * This enum provides information of all connect parameters that
2178 * have to be updated as part of update_connect_params() call.
2180 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2182 enum cfg80211_connect_params_changed {
2183 UPDATE_ASSOC_IES = BIT(0),
2187 * enum wiphy_params_flags - set_wiphy_params bitfield values
2188 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2189 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2190 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2191 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2192 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2193 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2195 enum wiphy_params_flags {
2196 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2197 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2198 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2199 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2200 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2201 WIPHY_PARAM_DYN_ACK = 1 << 5,
2205 * struct cfg80211_pmksa - PMK Security Association
2207 * This structure is passed to the set/del_pmksa() method for PMKSA
2210 * @bssid: The AP's BSSID (may be %NULL).
2211 * @pmkid: The identifier to refer a PMKSA.
2212 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2213 * derivation by a FILS STA. Otherwise, %NULL.
2214 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2215 * the hash algorithm used to generate this.
2216 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2217 * cache identifier (may be %NULL).
2218 * @ssid_len: Length of the @ssid in octets.
2219 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2220 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2223 struct cfg80211_pmksa {
2234 * struct cfg80211_pkt_pattern - packet pattern
2235 * @mask: bitmask where to match pattern and where to ignore bytes,
2236 * one bit per byte, in same format as nl80211
2237 * @pattern: bytes to match where bitmask is 1
2238 * @pattern_len: length of pattern (in bytes)
2239 * @pkt_offset: packet offset (in bytes)
2241 * Internal note: @mask and @pattern are allocated in one chunk of
2242 * memory, free @mask only!
2244 struct cfg80211_pkt_pattern {
2245 const u8 *mask, *pattern;
2251 * struct cfg80211_wowlan_tcp - TCP connection parameters
2253 * @sock: (internal) socket for source port allocation
2254 * @src: source IP address
2255 * @dst: destination IP address
2256 * @dst_mac: destination MAC address
2257 * @src_port: source port
2258 * @dst_port: destination port
2259 * @payload_len: data payload length
2260 * @payload: data payload buffer
2261 * @payload_seq: payload sequence stamping configuration
2262 * @data_interval: interval at which to send data packets
2263 * @wake_len: wakeup payload match length
2264 * @wake_data: wakeup payload match data
2265 * @wake_mask: wakeup payload match mask
2266 * @tokens_size: length of the tokens buffer
2267 * @payload_tok: payload token usage configuration
2269 struct cfg80211_wowlan_tcp {
2270 struct socket *sock;
2272 u16 src_port, dst_port;
2273 u8 dst_mac[ETH_ALEN];
2276 struct nl80211_wowlan_tcp_data_seq payload_seq;
2279 const u8 *wake_data, *wake_mask;
2281 /* must be last, variable member */
2282 struct nl80211_wowlan_tcp_data_token payload_tok;
2286 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2288 * This structure defines the enabled WoWLAN triggers for the device.
2289 * @any: wake up on any activity -- special trigger if device continues
2290 * operating as normal during suspend
2291 * @disconnect: wake up if getting disconnected
2292 * @magic_pkt: wake up on receiving magic packet
2293 * @patterns: wake up on receiving packet matching a pattern
2294 * @n_patterns: number of patterns
2295 * @gtk_rekey_failure: wake up on GTK rekey failure
2296 * @eap_identity_req: wake up on EAP identity request packet
2297 * @four_way_handshake: wake up on 4-way handshake
2298 * @rfkill_release: wake up when rfkill is released
2299 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2300 * NULL if not configured.
2301 * @nd_config: configuration for the scan to be used for net detect wake.
2303 struct cfg80211_wowlan {
2304 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2305 eap_identity_req, four_way_handshake,
2307 struct cfg80211_pkt_pattern *patterns;
2308 struct cfg80211_wowlan_tcp *tcp;
2310 struct cfg80211_sched_scan_request *nd_config;
2314 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2316 * This structure defines coalesce rule for the device.
2317 * @delay: maximum coalescing delay in msecs.
2318 * @condition: condition for packet coalescence.
2319 * see &enum nl80211_coalesce_condition.
2320 * @patterns: array of packet patterns
2321 * @n_patterns: number of patterns
2323 struct cfg80211_coalesce_rules {
2325 enum nl80211_coalesce_condition condition;
2326 struct cfg80211_pkt_pattern *patterns;
2331 * struct cfg80211_coalesce - Packet coalescing settings
2333 * This structure defines coalescing settings.
2334 * @rules: array of coalesce rules
2335 * @n_rules: number of rules
2337 struct cfg80211_coalesce {
2338 struct cfg80211_coalesce_rules *rules;
2343 * struct cfg80211_wowlan_nd_match - information about the match
2345 * @ssid: SSID of the match that triggered the wake up
2346 * @n_channels: Number of channels where the match occurred. This
2347 * value may be zero if the driver can't report the channels.
2348 * @channels: center frequencies of the channels where a match
2351 struct cfg80211_wowlan_nd_match {
2352 struct cfg80211_ssid ssid;
2358 * struct cfg80211_wowlan_nd_info - net detect wake up information
2360 * @n_matches: Number of match information instances provided in
2361 * @matches. This value may be zero if the driver can't provide
2362 * match information.
2363 * @matches: Array of pointers to matches containing information about
2364 * the matches that triggered the wake up.
2366 struct cfg80211_wowlan_nd_info {
2368 struct cfg80211_wowlan_nd_match *matches[];
2372 * struct cfg80211_wowlan_wakeup - wakeup report
2373 * @disconnect: woke up by getting disconnected
2374 * @magic_pkt: woke up by receiving magic packet
2375 * @gtk_rekey_failure: woke up by GTK rekey failure
2376 * @eap_identity_req: woke up by EAP identity request packet
2377 * @four_way_handshake: woke up by 4-way handshake
2378 * @rfkill_release: woke up by rfkill being released
2379 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2380 * @packet_present_len: copied wakeup packet data
2381 * @packet_len: original wakeup packet length
2382 * @packet: The packet causing the wakeup, if any.
2383 * @packet_80211: For pattern match, magic packet and other data
2384 * frame triggers an 802.3 frame should be reported, for
2385 * disconnect due to deauth 802.11 frame. This indicates which
2387 * @tcp_match: TCP wakeup packet received
2388 * @tcp_connlost: TCP connection lost or failed to establish
2389 * @tcp_nomoretokens: TCP data ran out of tokens
2390 * @net_detect: if not %NULL, woke up because of net detect
2392 struct cfg80211_wowlan_wakeup {
2393 bool disconnect, magic_pkt, gtk_rekey_failure,
2394 eap_identity_req, four_way_handshake,
2395 rfkill_release, packet_80211,
2396 tcp_match, tcp_connlost, tcp_nomoretokens;
2398 u32 packet_present_len, packet_len;
2400 struct cfg80211_wowlan_nd_info *net_detect;
2404 * struct cfg80211_gtk_rekey_data - rekey data
2405 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2406 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2407 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2409 struct cfg80211_gtk_rekey_data {
2410 const u8 *kek, *kck, *replay_ctr;
2414 * struct cfg80211_update_ft_ies_params - FT IE Information
2416 * This structure provides information needed to update the fast transition IE
2418 * @md: The Mobility Domain ID, 2 Octet value
2419 * @ie: Fast Transition IEs
2420 * @ie_len: Length of ft_ie in octets
2422 struct cfg80211_update_ft_ies_params {
2429 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2431 * This structure provides information needed to transmit a mgmt frame
2433 * @chan: channel to use
2434 * @offchan: indicates wether off channel operation is required
2435 * @wait: duration for ROC
2436 * @buf: buffer to transmit
2437 * @len: buffer length
2438 * @no_cck: don't use cck rates for this frame
2439 * @dont_wait_for_ack: tells the low level not to wait for an ack
2440 * @n_csa_offsets: length of csa_offsets array
2441 * @csa_offsets: array of all the csa offsets in the frame
2443 struct cfg80211_mgmt_tx_params {
2444 struct ieee80211_channel *chan;
2450 bool dont_wait_for_ack;
2452 const u16 *csa_offsets;
2456 * struct cfg80211_dscp_exception - DSCP exception
2458 * @dscp: DSCP value that does not adhere to the user priority range definition
2459 * @up: user priority value to which the corresponding DSCP value belongs
2461 struct cfg80211_dscp_exception {
2467 * struct cfg80211_dscp_range - DSCP range definition for user priority
2469 * @low: lowest DSCP value of this user priority range, inclusive
2470 * @high: highest DSCP value of this user priority range, inclusive
2472 struct cfg80211_dscp_range {
2477 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2478 #define IEEE80211_QOS_MAP_MAX_EX 21
2479 #define IEEE80211_QOS_MAP_LEN_MIN 16
2480 #define IEEE80211_QOS_MAP_LEN_MAX \
2481 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2484 * struct cfg80211_qos_map - QoS Map Information
2486 * This struct defines the Interworking QoS map setting for DSCP values
2488 * @num_des: number of DSCP exceptions (0..21)
2489 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2490 * the user priority DSCP range definition
2491 * @up: DSCP range definition for a particular user priority
2493 struct cfg80211_qos_map {
2495 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2496 struct cfg80211_dscp_range up[8];
2500 * struct cfg80211_nan_conf - NAN configuration
2502 * This struct defines NAN configuration parameters
2504 * @master_pref: master preference (1 - 255)
2505 * @bands: operating bands, a bitmap of &enum nl80211_band values.
2506 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2507 * (i.e. BIT(NL80211_BAND_2GHZ)).
2509 struct cfg80211_nan_conf {
2515 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2518 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2519 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2521 enum cfg80211_nan_conf_changes {
2522 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2523 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
2527 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2529 * @filter: the content of the filter
2530 * @len: the length of the filter
2532 struct cfg80211_nan_func_filter {
2538 * struct cfg80211_nan_func - a NAN function
2540 * @type: &enum nl80211_nan_function_type
2541 * @service_id: the service ID of the function
2542 * @publish_type: &nl80211_nan_publish_type
2543 * @close_range: if true, the range should be limited. Threshold is
2544 * implementation specific.
2545 * @publish_bcast: if true, the solicited publish should be broadcasted
2546 * @subscribe_active: if true, the subscribe is active
2547 * @followup_id: the instance ID for follow up
2548 * @followup_reqid: the requestor instance ID for follow up
2549 * @followup_dest: MAC address of the recipient of the follow up
2550 * @ttl: time to live counter in DW.
2551 * @serv_spec_info: Service Specific Info
2552 * @serv_spec_info_len: Service Specific Info length
2553 * @srf_include: if true, SRF is inclusive
2554 * @srf_bf: Bloom Filter
2555 * @srf_bf_len: Bloom Filter length
2556 * @srf_bf_idx: Bloom Filter index
2557 * @srf_macs: SRF MAC addresses
2558 * @srf_num_macs: number of MAC addresses in SRF
2559 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2560 * @tx_filters: filters that should be transmitted in the SDF.
2561 * @num_rx_filters: length of &rx_filters.
2562 * @num_tx_filters: length of &tx_filters.
2563 * @instance_id: driver allocated id of the function.
2564 * @cookie: unique NAN function identifier.
2566 struct cfg80211_nan_func {
2567 enum nl80211_nan_function_type type;
2568 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2572 bool subscribe_active;
2575 struct mac_address followup_dest;
2577 const u8 *serv_spec_info;
2578 u8 serv_spec_info_len;
2583 struct mac_address *srf_macs;
2585 struct cfg80211_nan_func_filter *rx_filters;
2586 struct cfg80211_nan_func_filter *tx_filters;
2594 * struct cfg80211_pmk_conf - PMK configuration
2596 * @aa: authenticator address
2597 * @pmk_len: PMK length in bytes.
2598 * @pmk: the PMK material
2599 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
2600 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
2603 struct cfg80211_pmk_conf {
2607 const u8 *pmk_r0_name;
2611 * struct cfg80211_external_auth_params - Trigger External authentication.
2613 * Commonly used across the external auth request and event interfaces.
2615 * @action: action type / trigger for external authentication. Only significant
2616 * for the authentication request event interface (driver to user space).
2617 * @bssid: BSSID of the peer with which the authentication has
2618 * to happen. Used by both the authentication request event and
2619 * authentication response command interface.
2620 * @ssid: SSID of the AP. Used by both the authentication request event and
2621 * authentication response command interface.
2622 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
2623 * authentication request event interface.
2624 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
2625 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
2626 * the real status code for failures. Used only for the authentication
2627 * response command interface (user space to driver).
2629 struct cfg80211_external_auth_params {
2630 enum nl80211_external_auth_action action;
2631 u8 bssid[ETH_ALEN] __aligned(2);
2632 struct cfg80211_ssid ssid;
2633 unsigned int key_mgmt_suite;
2638 * struct cfg80211_ops - backend description for wireless configuration
2640 * This struct is registered by fullmac card drivers and/or wireless stacks
2641 * in order to handle configuration requests on their interfaces.
2643 * All callbacks except where otherwise noted should return 0
2644 * on success or a negative error code.
2646 * All operations are currently invoked under rtnl for consistency with the
2647 * wireless extensions but this is subject to reevaluation as soon as this
2648 * code is used more widely and we have a first user without wext.
2650 * @suspend: wiphy device needs to be suspended. The variable @wow will
2651 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2652 * configured for the device.
2653 * @resume: wiphy device needs to be resumed
2654 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2655 * to call device_set_wakeup_enable() to enable/disable wakeup from
2658 * @add_virtual_intf: create a new virtual interface with the given name,
2659 * must set the struct wireless_dev's iftype. Beware: You must create
2660 * the new netdev in the wiphy's network namespace! Returns the struct
2661 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2662 * also set the address member in the wdev.
2664 * @del_virtual_intf: remove the virtual interface
2666 * @change_virtual_intf: change type/configuration of virtual interface,
2667 * keep the struct wireless_dev's iftype updated.
2669 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2670 * when adding a group key.
2672 * @get_key: get information about the key with the given parameters.
2673 * @mac_addr will be %NULL when requesting information for a group
2674 * key. All pointers given to the @callback function need not be valid
2675 * after it returns. This function should return an error if it is
2676 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2678 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2679 * and @key_index, return -ENOENT if the key doesn't exist.
2681 * @set_default_key: set the default key on an interface
2683 * @set_default_mgmt_key: set the default management frame key on an interface
2685 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2687 * @start_ap: Start acting in AP mode defined by the parameters.
2688 * @change_beacon: Change the beacon parameters for an access point mode
2689 * interface. This should reject the call when AP mode wasn't started.
2690 * @stop_ap: Stop being an AP, including stopping beaconing.
2692 * @add_station: Add a new station.
2693 * @del_station: Remove a station
2694 * @change_station: Modify a given station. Note that flags changes are not much
2695 * validated in cfg80211, in particular the auth/assoc/authorized flags
2696 * might come to the driver in invalid combinations -- make sure to check
2697 * them, also against the existing state! Drivers must call
2698 * cfg80211_check_station_change() to validate the information.
2699 * @get_station: get station information for the station identified by @mac
2700 * @dump_station: dump station callback -- resume dump at index @idx
2702 * @add_mpath: add a fixed mesh path
2703 * @del_mpath: delete a given mesh path
2704 * @change_mpath: change a given mesh path
2705 * @get_mpath: get a mesh path for the given parameters
2706 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2707 * @get_mpp: get a mesh proxy path for the given parameters
2708 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2709 * @join_mesh: join the mesh network with the specified parameters
2710 * (invoked with the wireless_dev mutex held)
2711 * @leave_mesh: leave the current mesh network
2712 * (invoked with the wireless_dev mutex held)
2714 * @get_mesh_config: Get the current mesh configuration
2716 * @update_mesh_config: Update mesh parameters on a running mesh.
2717 * The mask is a bitfield which tells us which parameters to
2718 * set, and which to leave alone.
2720 * @change_bss: Modify parameters for a given BSS.
2722 * @set_txq_params: Set TX queue parameters
2724 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2725 * as it doesn't implement join_mesh and needs to set the channel to
2726 * join the mesh instead.
2728 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2729 * interfaces are active this callback should reject the configuration.
2730 * If no interfaces are active or the device is down, the channel should
2731 * be stored for when a monitor interface becomes active.
2733 * @scan: Request to do a scan. If returning zero, the scan request is given
2734 * the driver, and will be valid until passed to cfg80211_scan_done().
2735 * For scan results, call cfg80211_inform_bss(); you can call this outside
2736 * the scan/scan_done bracket too.
2737 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2738 * indicate the status of the scan through cfg80211_scan_done().
2740 * @auth: Request to authenticate with the specified peer
2741 * (invoked with the wireless_dev mutex held)
2742 * @assoc: Request to (re)associate with the specified peer
2743 * (invoked with the wireless_dev mutex held)
2744 * @deauth: Request to deauthenticate from the specified peer
2745 * (invoked with the wireless_dev mutex held)
2746 * @disassoc: Request to disassociate from the specified peer
2747 * (invoked with the wireless_dev mutex held)
2749 * @connect: Connect to the ESS with the specified parameters. When connected,
2750 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2751 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2752 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2753 * from the AP or cfg80211_connect_timeout() if no frame with status code
2755 * The driver is allowed to roam to other BSSes within the ESS when the
2756 * other BSS matches the connect parameters. When such roaming is initiated
2757 * by the driver, the driver is expected to verify that the target matches
2758 * the configured security parameters and to use Reassociation Request
2759 * frame instead of Association Request frame.
2760 * The connect function can also be used to request the driver to perform a
2761 * specific roam when connected to an ESS. In that case, the prev_bssid
2762 * parameter is set to the BSSID of the currently associated BSS as an
2763 * indication of requesting reassociation.
2764 * In both the driver-initiated and new connect() call initiated roaming
2765 * cases, the result of roaming is indicated with a call to
2766 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
2767 * @update_connect_params: Update the connect parameters while connected to a
2768 * BSS. The updated parameters can be used by driver/firmware for
2769 * subsequent BSS selection (roaming) decisions and to form the
2770 * Authentication/(Re)Association Request frames. This call does not
2771 * request an immediate disassociation or reassociation with the current
2772 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
2773 * changed are defined in &enum cfg80211_connect_params_changed.
2774 * (invoked with the wireless_dev mutex held)
2775 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
2776 * connection is in progress. Once done, call cfg80211_disconnected() in
2777 * case connection was already established (invoked with the
2778 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
2780 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2781 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2783 * (invoked with the wireless_dev mutex held)
2784 * @leave_ibss: Leave the IBSS.
2785 * (invoked with the wireless_dev mutex held)
2787 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2790 * @set_wiphy_params: Notify that wiphy parameters have changed;
2791 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2792 * have changed. The actual parameter values are available in
2793 * struct wiphy. If returning an error, no value should be changed.
2795 * @set_tx_power: set the transmit power according to the parameters,
2796 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2797 * wdev may be %NULL if power was set for the wiphy, and will
2798 * always be %NULL unless the driver supports per-vif TX power
2799 * (as advertised by the nl80211 feature flag.)
2800 * @get_tx_power: store the current TX power into the dbm variable;
2801 * return 0 if successful
2803 * @set_wds_peer: set the WDS peer for a WDS interface
2805 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2806 * functions to adjust rfkill hw state
2808 * @dump_survey: get site survey information.
2810 * @remain_on_channel: Request the driver to remain awake on the specified
2811 * channel for the specified duration to complete an off-channel
2812 * operation (e.g., public action frame exchange). When the driver is
2813 * ready on the requested channel, it must indicate this with an event
2814 * notification by calling cfg80211_ready_on_channel().
2815 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2816 * This allows the operation to be terminated prior to timeout based on
2817 * the duration value.
2818 * @mgmt_tx: Transmit a management frame.
2819 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2820 * frame on another channel
2822 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2823 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2824 * used by the function, but 0 and 1 must not be touched. Additionally,
2825 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2826 * dump and return to userspace with an error, so be careful. If any data
2827 * was passed in from userspace then the data/len arguments will be present
2828 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2830 * @set_bitrate_mask: set the bitrate mask configuration
2832 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2833 * devices running firmwares capable of generating the (re) association
2834 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2835 * @del_pmksa: Delete a cached PMKID.
2836 * @flush_pmksa: Flush all cached PMKIDs.
2837 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2838 * allows the driver to adjust the dynamic ps timeout value.
2839 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2840 * After configuration, the driver should (soon) send an event indicating
2841 * the current level is above/below the configured threshold; this may
2842 * need some care when the configuration is changed (without first being
2844 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
2845 * connection quality monitor. An event is to be sent only when the
2846 * signal level is found to be outside the two values. The driver should
2847 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
2848 * If it is provided then there's no point providing @set_cqm_rssi_config.
2849 * @set_cqm_txe_config: Configure connection quality monitor TX error
2851 * @sched_scan_start: Tell the driver to start a scheduled scan.
2852 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
2853 * given request id. This call must stop the scheduled scan and be ready
2854 * for starting a new one before it returns, i.e. @sched_scan_start may be
2855 * called immediately after that again and should not fail in that case.
2856 * The driver should not call cfg80211_sched_scan_stopped() for a requested
2857 * stop (when this method returns 0).
2859 * @mgmt_frame_register: Notify driver that a management frame type was
2860 * registered. The callback is allowed to sleep.
2862 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2863 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2864 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2865 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2867 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2869 * @tdls_mgmt: Transmit a TDLS management frame.
2870 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2872 * @probe_client: probe an associated client, must return a cookie that it
2873 * later passes to cfg80211_probe_status().
2875 * @set_noack_map: Set the NoAck Map for the TIDs.
2877 * @get_channel: Get the current operating channel for the virtual interface.
2878 * For monitor interfaces, it should return %NULL unless there's a single
2879 * current monitoring channel.
2881 * @start_p2p_device: Start the given P2P device.
2882 * @stop_p2p_device: Stop the given P2P device.
2884 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2885 * Parameters include ACL policy, an array of MAC address of stations
2886 * and the number of MAC addresses. If there is already a list in driver
2887 * this new list replaces the existing one. Driver has to clear its ACL
2888 * when number of MAC addresses entries is passed as 0. Drivers which
2889 * advertise the support for MAC based ACL have to implement this callback.
2891 * @start_radar_detection: Start radar detection in the driver.
2893 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2894 * driver. If the SME is in the driver/firmware, this information can be
2895 * used in building Authentication and Reassociation Request frames.
2897 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2898 * for a given duration (milliseconds). The protocol is provided so the
2899 * driver can take the most appropriate actions.
2900 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2901 * reliability. This operation can not fail.
2902 * @set_coalesce: Set coalesce parameters.
2904 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2905 * responsible for veryfing if the switch is possible. Since this is
2906 * inherently tricky driver may decide to disconnect an interface later
2907 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2908 * everything. It should do it's best to verify requests and reject them
2909 * as soon as possible.
2911 * @set_qos_map: Set QoS mapping information to the driver
2913 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2914 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2915 * changes during the lifetime of the BSS.
2917 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2918 * with the given parameters; action frame exchange has been handled by
2919 * userspace so this just has to modify the TX path to take the TS into
2921 * If the admitted time is 0 just validate the parameters to make sure
2922 * the session can be created at all; it is valid to just always return
2923 * success for that but that may result in inefficient behaviour (handshake
2924 * with the peer followed by immediate teardown when the addition is later
2926 * @del_tx_ts: remove an existing TX TS
2928 * @join_ocb: join the OCB network with the specified parameters
2929 * (invoked with the wireless_dev mutex held)
2930 * @leave_ocb: leave the current OCB network
2931 * (invoked with the wireless_dev mutex held)
2933 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2934 * is responsible for continually initiating channel-switching operations
2935 * and returning to the base channel for communication with the AP.
2936 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2937 * peers must be on the base channel when the call completes.
2938 * @start_nan: Start the NAN interface.
2939 * @stop_nan: Stop the NAN interface.
2940 * @add_nan_func: Add a NAN function. Returns negative value on failure.
2941 * On success @nan_func ownership is transferred to the driver and
2942 * it may access it outside of the scope of this function. The driver
2943 * should free the @nan_func when no longer needed by calling
2944 * cfg80211_free_nan_func().
2945 * On success the driver should assign an instance_id in the
2946 * provided @nan_func.
2947 * @del_nan_func: Delete a NAN function.
2948 * @nan_change_conf: changes NAN configuration. The changed parameters must
2949 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
2950 * All other parameters must be ignored.
2952 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
2954 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
2955 * If not deleted through @del_pmk the PMK remains valid until disconnect
2956 * upon which the driver should clear it.
2957 * (invoked with the wireless_dev mutex held)
2958 * @del_pmk: delete the previously configured PMK for the given authenticator.
2959 * (invoked with the wireless_dev mutex held)
2961 * @external_auth: indicates result of offloaded authentication processing from
2964 struct cfg80211_ops {
2965 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2966 int (*resume)(struct wiphy *wiphy);
2967 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2969 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2971 unsigned char name_assign_type,
2972 enum nl80211_iftype type,
2973 struct vif_params *params);
2974 int (*del_virtual_intf)(struct wiphy *wiphy,
2975 struct wireless_dev *wdev);
2976 int (*change_virtual_intf)(struct wiphy *wiphy,
2977 struct net_device *dev,
2978 enum nl80211_iftype type,
2979 struct vif_params *params);
2981 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2982 u8 key_index, bool pairwise, const u8 *mac_addr,
2983 struct key_params *params);
2984 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2985 u8 key_index, bool pairwise, const u8 *mac_addr,
2987 void (*callback)(void *cookie, struct key_params*));
2988 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2989 u8 key_index, bool pairwise, const u8 *mac_addr);
2990 int (*set_default_key)(struct wiphy *wiphy,
2991 struct net_device *netdev,
2992 u8 key_index, bool unicast, bool multicast);
2993 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2994 struct net_device *netdev,
2997 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2998 struct cfg80211_ap_settings *settings);
2999 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3000 struct cfg80211_beacon_data *info);
3001 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3004 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3006 struct station_parameters *params);
3007 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3008 struct station_del_parameters *params);
3009 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3011 struct station_parameters *params);
3012 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3013 const u8 *mac, struct station_info *sinfo);
3014 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3015 int idx, u8 *mac, struct station_info *sinfo);
3017 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3018 const u8 *dst, const u8 *next_hop);
3019 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3021 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3022 const u8 *dst, const u8 *next_hop);
3023 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3024 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3025 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3026 int idx, u8 *dst, u8 *next_hop,
3027 struct mpath_info *pinfo);
3028 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3029 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3030 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3031 int idx, u8 *dst, u8 *mpp,
3032 struct mpath_info *pinfo);
3033 int (*get_mesh_config)(struct wiphy *wiphy,
3034 struct net_device *dev,
3035 struct mesh_config *conf);
3036 int (*update_mesh_config)(struct wiphy *wiphy,
3037 struct net_device *dev, u32 mask,
3038 const struct mesh_config *nconf);
3039 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3040 const struct mesh_config *conf,
3041 const struct mesh_setup *setup);
3042 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3044 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3045 struct ocb_setup *setup);
3046 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3048 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3049 struct bss_parameters *params);
3051 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3052 struct ieee80211_txq_params *params);
3054 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3055 struct net_device *dev,
3056 struct ieee80211_channel *chan);
3058 int (*set_monitor_channel)(struct wiphy *wiphy,
3059 struct cfg80211_chan_def *chandef);
3061 int (*scan)(struct wiphy *wiphy,
3062 struct cfg80211_scan_request *request);
3063 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3065 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
3066 struct cfg80211_auth_request *req);
3067 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3068 struct cfg80211_assoc_request *req);
3069 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3070 struct cfg80211_deauth_request *req);
3071 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3072 struct cfg80211_disassoc_request *req);
3074 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
3075 struct cfg80211_connect_params *sme);
3076 int (*update_connect_params)(struct wiphy *wiphy,
3077 struct net_device *dev,
3078 struct cfg80211_connect_params *sme,
3080 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3083 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3084 struct cfg80211_ibss_params *params);
3085 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3087 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3088 int rate[NUM_NL80211_BANDS]);
3090 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3092 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3093 enum nl80211_tx_power_setting type, int mbm);
3094 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3097 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3100 void (*rfkill_poll)(struct wiphy *wiphy);
3102 #ifdef CONFIG_NL80211_TESTMODE
3103 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3104 void *data, int len);
3105 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3106 struct netlink_callback *cb,
3107 void *data, int len);
3110 int (*set_bitrate_mask)(struct wiphy *wiphy,
3111 struct net_device *dev,
3113 const struct cfg80211_bitrate_mask *mask);
3115 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3116 int idx, struct survey_info *info);
3118 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3119 struct cfg80211_pmksa *pmksa);
3120 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3121 struct cfg80211_pmksa *pmksa);
3122 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3124 int (*remain_on_channel)(struct wiphy *wiphy,
3125 struct wireless_dev *wdev,
3126 struct ieee80211_channel *chan,
3127 unsigned int duration,
3129 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
3130 struct wireless_dev *wdev,
3133 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3134 struct cfg80211_mgmt_tx_params *params,
3136 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3137 struct wireless_dev *wdev,
3140 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3141 bool enabled, int timeout);
3143 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
3144 struct net_device *dev,
3145 s32 rssi_thold, u32 rssi_hyst);
3147 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3148 struct net_device *dev,
3149 s32 rssi_low, s32 rssi_high);
3151 int (*set_cqm_txe_config)(struct wiphy *wiphy,
3152 struct net_device *dev,
3153 u32 rate, u32 pkts, u32 intvl);
3155 void (*mgmt_frame_register)(struct wiphy *wiphy,
3156 struct wireless_dev *wdev,
3157 u16 frame_type, bool reg);
3159 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3160 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3162 int (*sched_scan_start)(struct wiphy *wiphy,
3163 struct net_device *dev,
3164 struct cfg80211_sched_scan_request *request);
3165 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3168 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3169 struct cfg80211_gtk_rekey_data *data);
3171 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3172 const u8 *peer, u8 action_code, u8 dialog_token,
3173 u16 status_code, u32 peer_capability,
3174 bool initiator, const u8 *buf, size_t len);
3175 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3176 const u8 *peer, enum nl80211_tdls_operation oper);
3178 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3179 const u8 *peer, u64 *cookie);
3181 int (*set_noack_map)(struct wiphy *wiphy,
3182 struct net_device *dev,
3185 int (*get_channel)(struct wiphy *wiphy,
3186 struct wireless_dev *wdev,
3187 struct cfg80211_chan_def *chandef);
3189 int (*start_p2p_device)(struct wiphy *wiphy,
3190 struct wireless_dev *wdev);
3191 void (*stop_p2p_device)(struct wiphy *wiphy,
3192 struct wireless_dev *wdev);
3194 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3195 const struct cfg80211_acl_data *params);
3197 int (*start_radar_detection)(struct wiphy *wiphy,
3198 struct net_device *dev,
3199 struct cfg80211_chan_def *chandef,
3201 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3202 struct cfg80211_update_ft_ies_params *ftie);
3203 int (*crit_proto_start)(struct wiphy *wiphy,
3204 struct wireless_dev *wdev,
3205 enum nl80211_crit_proto_id protocol,
3207 void (*crit_proto_stop)(struct wiphy *wiphy,
3208 struct wireless_dev *wdev);
3209 int (*set_coalesce)(struct wiphy *wiphy,
3210 struct cfg80211_coalesce *coalesce);
3212 int (*channel_switch)(struct wiphy *wiphy,
3213 struct net_device *dev,
3214 struct cfg80211_csa_settings *params);
3216 int (*set_qos_map)(struct wiphy *wiphy,
3217 struct net_device *dev,
3218 struct cfg80211_qos_map *qos_map);
3220 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3221 struct cfg80211_chan_def *chandef);
3223 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3224 u8 tsid, const u8 *peer, u8 user_prio,
3226 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3227 u8 tsid, const u8 *peer);
3229 int (*tdls_channel_switch)(struct wiphy *wiphy,
3230 struct net_device *dev,
3231 const u8 *addr, u8 oper_class,
3232 struct cfg80211_chan_def *chandef);
3233 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3234 struct net_device *dev,
3236 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3237 struct cfg80211_nan_conf *conf);
3238 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3239 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3240 struct cfg80211_nan_func *nan_func);
3241 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3243 int (*nan_change_conf)(struct wiphy *wiphy,
3244 struct wireless_dev *wdev,
3245 struct cfg80211_nan_conf *conf,
3248 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
3249 struct net_device *dev,
3250 const bool enabled);
3252 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3253 const struct cfg80211_pmk_conf *conf);
3254 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3256 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
3257 struct cfg80211_external_auth_params *params);
3261 * wireless hardware and networking interfaces structures
3262 * and registration/helper functions
3266 * enum wiphy_flags - wiphy capability flags
3268 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3270 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3271 * by default -- this flag will be set depending on the kernel's default
3272 * on wiphy_new(), but can be changed by the driver if it has a good
3273 * reason to override the default
3274 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3275 * on a VLAN interface)
3276 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3277 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3278 * control port protocol ethertype. The device also honours the
3279 * control_port_no_encrypt flag.
3280 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3281 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3282 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3283 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3285 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3286 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3287 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3288 * link setup/discovery operations internally. Setup, discovery and
3289 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3290 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3291 * used for asking the driver/firmware to perform a TDLS operation.
3292 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3293 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3294 * when there are virtual interfaces in AP mode by calling
3295 * cfg80211_report_obss_beacon().
3296 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3297 * responds to probe-requests in hardware.
3298 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3299 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3300 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3301 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3302 * beaconing mode (AP, IBSS, Mesh, ...).
3303 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3304 * before connection.
3310 WIPHY_FLAG_NETNS_OK = BIT(3),
3311 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
3312 WIPHY_FLAG_4ADDR_AP = BIT(5),
3313 WIPHY_FLAG_4ADDR_STATION = BIT(6),
3314 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
3315 WIPHY_FLAG_IBSS_RSN = BIT(8),
3316 WIPHY_FLAG_MESH_AUTH = BIT(10),
3317 /* use hole at 11 */
3318 /* use hole at 12 */
3319 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
3320 WIPHY_FLAG_AP_UAPSD = BIT(14),
3321 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
3322 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
3323 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
3324 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
3325 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
3326 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
3327 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
3328 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
3329 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
3330 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
3334 * struct ieee80211_iface_limit - limit on certain interface types
3335 * @max: maximum number of interfaces of these types
3336 * @types: interface types (bits)
3338 struct ieee80211_iface_limit {
3344 * struct ieee80211_iface_combination - possible interface combination
3346 * With this structure the driver can describe which interface
3347 * combinations it supports concurrently.
3351 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
3355 * struct ieee80211_iface_limit limits1[] = {
3356 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3357 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3359 * struct ieee80211_iface_combination combination1 = {
3360 * .limits = limits1,
3361 * .n_limits = ARRAY_SIZE(limits1),
3362 * .max_interfaces = 2,
3363 * .beacon_int_infra_match = true,
3367 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
3371 * struct ieee80211_iface_limit limits2[] = {
3372 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3373 * BIT(NL80211_IFTYPE_P2P_GO), },
3375 * struct ieee80211_iface_combination combination2 = {
3376 * .limits = limits2,
3377 * .n_limits = ARRAY_SIZE(limits2),
3378 * .max_interfaces = 8,
3379 * .num_different_channels = 1,
3383 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3385 * This allows for an infrastructure connection and three P2P connections.
3389 * struct ieee80211_iface_limit limits3[] = {
3390 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3391 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3392 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
3394 * struct ieee80211_iface_combination combination3 = {
3395 * .limits = limits3,
3396 * .n_limits = ARRAY_SIZE(limits3),
3397 * .max_interfaces = 4,
3398 * .num_different_channels = 2,
3402 struct ieee80211_iface_combination {
3405 * limits for the given interface types
3407 const struct ieee80211_iface_limit *limits;
3410 * @num_different_channels:
3411 * can use up to this many different channels
3413 u32 num_different_channels;
3417 * maximum number of interfaces in total allowed in this group
3423 * number of limitations
3428 * @beacon_int_infra_match:
3429 * In this combination, the beacon intervals between infrastructure
3430 * and AP types must match. This is required only in special cases.
3432 bool beacon_int_infra_match;
3435 * @radar_detect_widths:
3436 * bitmap of channel widths supported for radar detection
3438 u8 radar_detect_widths;
3441 * @radar_detect_regions:
3442 * bitmap of regions supported for radar detection
3444 u8 radar_detect_regions;
3447 * @beacon_int_min_gcd:
3448 * This interface combination supports different beacon intervals.
3451 * all beacon intervals for different interface must be same.
3453 * any beacon interval for the interface part of this combination AND
3454 * GCD of all beacon intervals from beaconing interfaces of this
3455 * combination must be greater or equal to this value.
3457 u32 beacon_int_min_gcd;
3460 struct ieee80211_txrx_stypes {
3465 * enum wiphy_wowlan_support_flags - WoWLAN support flags
3466 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3467 * trigger that keeps the device operating as-is and
3468 * wakes up the host on any activity, for example a
3469 * received packet that passed filtering; note that the
3470 * packet should be preserved in that case
3471 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3473 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3474 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3475 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3476 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3477 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3478 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3479 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3481 enum wiphy_wowlan_support_flags {
3482 WIPHY_WOWLAN_ANY = BIT(0),
3483 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
3484 WIPHY_WOWLAN_DISCONNECT = BIT(2),
3485 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
3486 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
3487 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
3488 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
3489 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
3490 WIPHY_WOWLAN_NET_DETECT = BIT(8),
3493 struct wiphy_wowlan_tcp_support {
3494 const struct nl80211_wowlan_tcp_data_token_feature *tok;
3495 u32 data_payload_max;
3496 u32 data_interval_max;
3497 u32 wake_payload_max;
3502 * struct wiphy_wowlan_support - WoWLAN support data
3503 * @flags: see &enum wiphy_wowlan_support_flags
3504 * @n_patterns: number of supported wakeup patterns
3505 * (see nl80211.h for the pattern definition)
3506 * @pattern_max_len: maximum length of each pattern
3507 * @pattern_min_len: minimum length of each pattern
3508 * @max_pkt_offset: maximum Rx packet offset
3509 * @max_nd_match_sets: maximum number of matchsets for net-detect,
3510 * similar, but not necessarily identical, to max_match_sets for
3512 * See &struct cfg80211_sched_scan_request.@match_sets for more
3514 * @tcp: TCP wakeup support information
3516 struct wiphy_wowlan_support {
3519 int pattern_max_len;
3520 int pattern_min_len;
3522 int max_nd_match_sets;
3523 const struct wiphy_wowlan_tcp_support *tcp;
3527 * struct wiphy_coalesce_support - coalesce support data
3528 * @n_rules: maximum number of coalesce rules
3529 * @max_delay: maximum supported coalescing delay in msecs
3530 * @n_patterns: number of supported patterns in a rule
3531 * (see nl80211.h for the pattern definition)
3532 * @pattern_max_len: maximum length of each pattern
3533 * @pattern_min_len: minimum length of each pattern
3534 * @max_pkt_offset: maximum Rx packet offset
3536 struct wiphy_coalesce_support {
3540 int pattern_max_len;
3541 int pattern_min_len;
3546 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3547 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3548 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3549 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3550 * (must be combined with %_WDEV or %_NETDEV)
3552 enum wiphy_vendor_command_flags {
3553 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3554 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3555 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3559 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
3561 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
3562 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
3563 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
3566 enum wiphy_opmode_flag {
3567 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
3568 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
3569 STA_OPMODE_N_SS_CHANGED = BIT(2),
3573 * struct sta_opmode_info - Station's ht/vht operation mode information
3574 * @changed: contains value from &enum wiphy_opmode_flag
3575 * @smps_mode: New SMPS mode of a station
3576 * @bw: new max bandwidth value of a station
3577 * @rx_nss: new rx_nss value of a station
3580 struct sta_opmode_info {
3588 * struct wiphy_vendor_command - vendor command definition
3589 * @info: vendor command identifying information, as used in nl80211
3590 * @flags: flags, see &enum wiphy_vendor_command_flags
3591 * @doit: callback for the operation, note that wdev is %NULL if the
3592 * flags didn't ask for a wdev and non-%NULL otherwise; the data
3593 * pointer may be %NULL if userspace provided no data at all
3594 * @dumpit: dump callback, for transferring bigger/multiple items. The
3595 * @storage points to cb->args[5], ie. is preserved over the multiple
3597 * It's recommended to not have the same sub command with both @doit and
3598 * @dumpit, so that userspace can assume certain ones are get and others
3599 * are used with dump requests.
3601 struct wiphy_vendor_command {
3602 struct nl80211_vendor_cmd_info info;
3604 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3605 const void *data, int data_len);
3606 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3607 struct sk_buff *skb, const void *data, int data_len,
3608 unsigned long *storage);
3612 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3613 * @iftype: interface type
3614 * @extended_capabilities: extended capabilities supported by the driver,
3615 * additional capabilities might be supported by userspace; these are the
3616 * 802.11 extended capabilities ("Extended Capabilities element") and are
3617 * in the same format as in the information element. See IEEE Std
3618 * 802.11-2012 8.4.2.29 for the defined fields.
3619 * @extended_capabilities_mask: mask of the valid values
3620 * @extended_capabilities_len: length of the extended capabilities
3622 struct wiphy_iftype_ext_capab {
3623 enum nl80211_iftype iftype;
3624 const u8 *extended_capabilities;
3625 const u8 *extended_capabilities_mask;
3626 u8 extended_capabilities_len;
3630 * struct wiphy - wireless hardware description
3631 * @reg_notifier: the driver's regulatory notification callback,
3632 * note that if your driver uses wiphy_apply_custom_regulatory()
3633 * the reg_notifier's request can be passed as NULL
3634 * @regd: the driver's regulatory domain, if one was requested via
3635 * the regulatory_hint() API. This can be used by the driver
3636 * on the reg_notifier() if it chooses to ignore future
3637 * regulatory domain changes caused by other drivers.
3638 * @signal_type: signal type reported in &struct cfg80211_bss.
3639 * @cipher_suites: supported cipher suites
3640 * @n_cipher_suites: number of supported cipher suites
3641 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3642 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3643 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3644 * -1 = fragmentation disabled, only odd values >= 256 used
3645 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3646 * @_net: the network namespace this wiphy currently lives in
3647 * @perm_addr: permanent MAC address of this device
3648 * @addr_mask: If the device supports multiple MAC addresses by masking,
3649 * set this to a mask with variable bits set to 1, e.g. if the last
3650 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
3651 * variable bits shall be determined by the interfaces added, with
3652 * interfaces not matching the mask being rejected to be brought up.
3653 * @n_addresses: number of addresses in @addresses.
3654 * @addresses: If the device has more than one address, set this pointer
3655 * to a list of addresses (6 bytes each). The first one will be used
3656 * by default for perm_addr. In this case, the mask should be set to
3657 * all-zeroes. In this case it is assumed that the device can handle
3658 * the same number of arbitrary MAC addresses.
3659 * @registered: protects ->resume and ->suspend sysfs callbacks against
3660 * unregister hardware
3661 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3662 * automatically on wiphy renames
3663 * @dev: (virtual) struct device for this wiphy
3664 * @registered: helps synchronize suspend/resume with wiphy unregister
3665 * @wext: wireless extension handlers
3666 * @priv: driver private data (sized according to wiphy_new() parameter)
3667 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3668 * must be set by driver
3669 * @iface_combinations: Valid interface combinations array, should not
3670 * list single interface types.
3671 * @n_iface_combinations: number of entries in @iface_combinations array.
3672 * @software_iftypes: bitmask of software interface types, these are not
3673 * subject to any restrictions since they are purely managed in SW.
3674 * @flags: wiphy flags, see &enum wiphy_flags
3675 * @regulatory_flags: wiphy regulatory flags, see
3676 * &enum ieee80211_regulatory_flags
3677 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3678 * @ext_features: extended features advertised to nl80211, see
3679 * &enum nl80211_ext_feature_index.
3680 * @bss_priv_size: each BSS struct has private data allocated with it,
3681 * this variable determines its size
3682 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3684 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
3685 * the device can run concurrently.
3686 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3687 * for in any given scheduled scan
3688 * @max_match_sets: maximum number of match sets the device can handle
3689 * when performing a scheduled scan, 0 if filtering is not
3691 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3692 * add to probe request frames transmitted during a scan, must not
3693 * include fixed IEs like supported rates
3694 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3696 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3697 * of iterations) for scheduled scan supported by the device.
3698 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3699 * single scan plan supported by the device.
3700 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3701 * scan plan supported by the device.
3702 * @coverage_class: current coverage class
3703 * @fw_version: firmware version for ethtool reporting
3704 * @hw_version: hardware version for ethtool reporting
3705 * @max_num_pmkids: maximum number of PMKIDs supported by device
3706 * @privid: a pointer that drivers can use to identify if an arbitrary
3707 * wiphy is theirs, e.g. in global notifiers
3708 * @bands: information about bands/channels supported by this device
3710 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3711 * transmitted through nl80211, points to an array indexed by interface
3714 * @available_antennas_tx: bitmap of antennas which are available to be
3715 * configured as TX antennas. Antenna configuration commands will be
3716 * rejected unless this or @available_antennas_rx is set.
3718 * @available_antennas_rx: bitmap of antennas which are available to be
3719 * configured as RX antennas. Antenna configuration commands will be
3720 * rejected unless this or @available_antennas_tx is set.
3722 * @probe_resp_offload:
3723 * Bitmap of supported protocols for probe response offloading.
3724 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3725 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3727 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3728 * may request, if implemented.
3730 * @wowlan: WoWLAN support information
3731 * @wowlan_config: current WoWLAN configuration; this should usually not be
3732 * used since access to it is necessarily racy, use the parameter passed
3733 * to the suspend() operation instead.
3735 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3736 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3737 * If null, then none can be over-ridden.
3738 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3739 * If null, then none can be over-ridden.
3741 * @wdev_list: the list of associated (virtual) interfaces; this list must
3742 * not be modified by the driver, but can be read with RTNL/RCU protection.
3744 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3747 * @extended_capabilities: extended capabilities supported by the driver,
3748 * additional capabilities might be supported by userspace; these are
3749 * the 802.11 extended capabilities ("Extended Capabilities element")
3750 * and are in the same format as in the information element. See
3751 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
3752 * extended capabilities to be used if the capabilities are not specified
3753 * for a specific interface type in iftype_ext_capab.
3754 * @extended_capabilities_mask: mask of the valid values
3755 * @extended_capabilities_len: length of the extended capabilities
3756 * @iftype_ext_capab: array of extended capabilities per interface type
3757 * @num_iftype_ext_capab: number of interface types for which extended
3758 * capabilities are specified separately.
3759 * @coalesce: packet coalescing support information
3761 * @vendor_commands: array of vendor commands supported by the hardware
3762 * @n_vendor_commands: number of vendor commands
3763 * @vendor_events: array of vendor events supported by the hardware
3764 * @n_vendor_events: number of vendor events
3766 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3767 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3768 * driver is allowed to advertise a theoretical limit that it can reach in
3769 * some cases, but may not always reach.
3771 * @max_num_csa_counters: Number of supported csa_counters in beacons
3772 * and probe responses. This value should be set if the driver
3773 * wishes to limit the number of csa counters. Default (0) means
3775 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3776 * frame was sent and the channel on which the frame was heard for which
3777 * the reported rssi is still valid. If a driver is able to compensate the
3778 * low rssi when a frame is heard on different channel, then it should set
3779 * this variable to the maximal offset for which it can compensate.
3780 * This value should be set in MHz.
3781 * @bss_select_support: bitmask indicating the BSS selection criteria supported
3782 * by the driver in the .connect() callback. The bit position maps to the
3783 * attribute indices defined in &enum nl80211_bss_select_attr.
3785 * @cookie_counter: unique generic cookie counter, used to identify objects.
3786 * @nan_supported_bands: bands supported by the device in NAN mode, a
3787 * bitmap of &enum nl80211_band values. For instance, for
3788 * NL80211_BAND_2GHZ, bit 0 would be set
3789 * (i.e. BIT(NL80211_BAND_2GHZ)).
3792 /* assign these fields before you register the wiphy */
3794 /* permanent MAC address(es) */
3795 u8 perm_addr[ETH_ALEN];
3796 u8 addr_mask[ETH_ALEN];
3798 struct mac_address *addresses;
3800 const struct ieee80211_txrx_stypes *mgmt_stypes;
3802 const struct ieee80211_iface_combination *iface_combinations;
3803 int n_iface_combinations;
3804 u16 software_iftypes;
3808 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3809 u16 interface_modes;
3811 u16 max_acl_mac_addrs;
3813 u32 flags, regulatory_flags, features;
3814 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3818 enum cfg80211_signal_type signal_type;
3822 u8 max_sched_scan_reqs;
3823 u8 max_sched_scan_ssids;
3825 u16 max_scan_ie_len;
3826 u16 max_sched_scan_ie_len;
3827 u32 max_sched_scan_plans;
3828 u32 max_sched_scan_plan_interval;
3829 u32 max_sched_scan_plan_iterations;
3831 int n_cipher_suites;
3832 const u32 *cipher_suites;
3840 char fw_version[ETHTOOL_FWVERS_LEN];
3844 const struct wiphy_wowlan_support *wowlan;
3845 struct cfg80211_wowlan *wowlan_config;
3848 u16 max_remain_on_channel_duration;
3852 u32 available_antennas_tx;
3853 u32 available_antennas_rx;
3856 * Bitmap of supported protocols for probe response offloading
3857 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3858 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3860 u32 probe_resp_offload;
3862 const u8 *extended_capabilities, *extended_capabilities_mask;
3863 u8 extended_capabilities_len;
3865 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
3866 unsigned int num_iftype_ext_capab;
3868 /* If multiple wiphys are registered and you're handed e.g.
3869 * a regular netdev with assigned ieee80211_ptr, you won't
3870 * know whether it points to a wiphy your driver has registered
3871 * or not. Assign this to something global to your driver to
3872 * help determine whether you own this wiphy or not. */
3875 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
3877 /* Lets us get back the wiphy on the callback */
3878 void (*reg_notifier)(struct wiphy *wiphy,
3879 struct regulatory_request *request);
3881 /* fields below are read-only, assigned by cfg80211 */
3883 const struct ieee80211_regdomain __rcu *regd;
3885 /* the item in /sys/class/ieee80211/ points to this,
3886 * you need use set_wiphy_dev() (see below) */
3889 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3892 /* dir in debugfs: ieee80211/<wiphyname> */
3893 struct dentry *debugfsdir;
3895 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3896 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3898 struct list_head wdev_list;
3900 /* the network namespace this phy lives in currently */
3901 possible_net_t _net;
3903 #ifdef CONFIG_CFG80211_WEXT
3904 const struct iw_handler_def *wext;
3907 const struct wiphy_coalesce_support *coalesce;
3909 const struct wiphy_vendor_command *vendor_commands;
3910 const struct nl80211_vendor_cmd_info *vendor_events;
3911 int n_vendor_commands, n_vendor_events;
3913 u16 max_ap_assoc_sta;
3915 u8 max_num_csa_counters;
3916 u8 max_adj_channel_rssi_comp;
3918 u32 bss_select_support;
3922 u8 nan_supported_bands;
3924 char priv[0] __aligned(NETDEV_ALIGN);
3927 static inline struct net *wiphy_net(struct wiphy *wiphy)
3929 return read_pnet(&wiphy->_net);
3932 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3934 write_pnet(&wiphy->_net, net);
3938 * wiphy_priv - return priv from wiphy
3940 * @wiphy: the wiphy whose priv pointer to return
3941 * Return: The priv of @wiphy.
3943 static inline void *wiphy_priv(struct wiphy *wiphy)
3946 return &wiphy->priv;
3950 * priv_to_wiphy - return the wiphy containing the priv
3952 * @priv: a pointer previously returned by wiphy_priv
3953 * Return: The wiphy of @priv.
3955 static inline struct wiphy *priv_to_wiphy(void *priv)
3958 return container_of(priv, struct wiphy, priv);
3962 * set_wiphy_dev - set device pointer for wiphy
3964 * @wiphy: The wiphy whose device to bind
3965 * @dev: The device to parent it to
3967 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3969 wiphy->dev.parent = dev;
3973 * wiphy_dev - get wiphy dev pointer
3975 * @wiphy: The wiphy whose device struct to look up
3976 * Return: The dev of @wiphy.
3978 static inline struct device *wiphy_dev(struct wiphy *wiphy)
3980 return wiphy->dev.parent;
3984 * wiphy_name - get wiphy name
3986 * @wiphy: The wiphy whose name to return
3987 * Return: The name of @wiphy.
3989 static inline const char *wiphy_name(const struct wiphy *wiphy)
3991 return dev_name(&wiphy->dev);
3995 * wiphy_new_nm - create a new wiphy for use with cfg80211
3997 * @ops: The configuration operations for this device
3998 * @sizeof_priv: The size of the private area to allocate
3999 * @requested_name: Request a particular name.
4000 * NULL is valid value, and means use the default phy%d naming.
4002 * Create a new wiphy and associate the given operations with it.
4003 * @sizeof_priv bytes are allocated for private use.
4005 * Return: A pointer to the new wiphy. This pointer must be
4006 * assigned to each netdev's ieee80211_ptr for proper operation.
4008 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4009 const char *requested_name);
4012 * wiphy_new - create a new wiphy for use with cfg80211
4014 * @ops: The configuration operations for this device
4015 * @sizeof_priv: The size of the private area to allocate
4017 * Create a new wiphy and associate the given operations with it.
4018 * @sizeof_priv bytes are allocated for private use.
4020 * Return: A pointer to the new wiphy. This pointer must be
4021 * assigned to each netdev's ieee80211_ptr for proper operation.
4023 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4026 return wiphy_new_nm(ops, sizeof_priv, NULL);
4030 * wiphy_register - register a wiphy with cfg80211
4032 * @wiphy: The wiphy to register.
4034 * Return: A non-negative wiphy index or a negative error code.
4036 int wiphy_register(struct wiphy *wiphy);
4039 * wiphy_unregister - deregister a wiphy from cfg80211
4041 * @wiphy: The wiphy to unregister.
4043 * After this call, no more requests can be made with this priv
4044 * pointer, but the call may sleep to wait for an outstanding
4045 * request that is being handled.
4047 void wiphy_unregister(struct wiphy *wiphy);
4050 * wiphy_free - free wiphy
4052 * @wiphy: The wiphy to free
4054 void wiphy_free(struct wiphy *wiphy);
4056 /* internal structs */
4057 struct cfg80211_conn;
4058 struct cfg80211_internal_bss;
4059 struct cfg80211_cached_keys;
4060 struct cfg80211_cqm_config;
4063 * struct wireless_dev - wireless device state
4065 * For netdevs, this structure must be allocated by the driver
4066 * that uses the ieee80211_ptr field in struct net_device (this
4067 * is intentional so it can be allocated along with the netdev.)
4068 * It need not be registered then as netdev registration will
4069 * be intercepted by cfg80211 to see the new wireless device.
4071 * For non-netdev uses, it must also be allocated by the driver
4072 * in response to the cfg80211 callbacks that require it, as
4073 * there's no netdev registration in that case it may not be
4074 * allocated outside of callback operations that return it.
4076 * @wiphy: pointer to hardware description
4077 * @iftype: interface type
4078 * @list: (private) Used to collect the interfaces
4079 * @netdev: (private) Used to reference back to the netdev, may be %NULL
4080 * @identifier: (private) Identifier used in nl80211 to identify this
4081 * wireless device if it has no netdev
4082 * @current_bss: (private) Used by the internal configuration code
4083 * @chandef: (private) Used by the internal configuration code to track
4084 * the user-set channel definition.
4085 * @preset_chandef: (private) Used by the internal configuration code to
4086 * track the channel to be used for AP later
4087 * @bssid: (private) Used by the internal configuration code
4088 * @ssid: (private) Used by the internal configuration code
4089 * @ssid_len: (private) Used by the internal configuration code
4090 * @mesh_id_len: (private) Used by the internal configuration code
4091 * @mesh_id_up_len: (private) Used by the internal configuration code
4092 * @wext: (private) Used by the internal wireless extensions compat code
4093 * @use_4addr: indicates 4addr mode is used on this interface, must be
4094 * set by driver (if supported) on add_interface BEFORE registering the
4095 * netdev and may otherwise be used by driver read-only, will be update
4096 * by cfg80211 on change_interface
4097 * @mgmt_registrations: list of registrations for management frames
4098 * @mgmt_registrations_lock: lock for the list
4099 * @mtx: mutex used to lock data in this struct, may be used by drivers
4100 * and some API functions require it held
4101 * @beacon_interval: beacon interval used on this device for transmitting
4102 * beacons, 0 when not valid
4103 * @address: The address for this device, valid only if @netdev is %NULL
4104 * @is_running: true if this is a non-netdev device that has been started, e.g.
4106 * @cac_started: true if DFS channel availability check has been started
4107 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4108 * @cac_time_ms: CAC time in ms
4109 * @ps: powersave mode is enabled
4110 * @ps_timeout: dynamic powersave timeout
4111 * @ap_unexpected_nlportid: (private) netlink port ID of application
4112 * registered for unexpected class 3 frames (AP mode)
4113 * @conn: (private) cfg80211 software SME connection state machine data
4114 * @connect_keys: (private) keys to set after connection is established
4115 * @conn_bss_type: connecting/connected BSS type
4116 * @conn_owner_nlportid: (private) connection owner socket port ID
4117 * @disconnect_wk: (private) auto-disconnect work
4118 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4119 * @ibss_fixed: (private) IBSS is using fixed BSSID
4120 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4121 * @event_list: (private) list for internal event processing
4122 * @event_lock: (private) lock for event list
4123 * @owner_nlportid: (private) owner socket port ID
4124 * @nl_owner_dead: (private) owner socket went away
4125 * @cqm_config: (private) nl80211 RSSI monitor state
4127 struct wireless_dev {
4128 struct wiphy *wiphy;
4129 enum nl80211_iftype iftype;
4131 /* the remainder of this struct should be private to cfg80211 */
4132 struct list_head list;
4133 struct net_device *netdev;
4137 struct list_head mgmt_registrations;
4138 spinlock_t mgmt_registrations_lock;
4142 bool use_4addr, is_running;
4144 u8 address[ETH_ALEN] __aligned(sizeof(u16));
4146 /* currently used for IBSS and SME - might be rearranged later */
4147 u8 ssid[IEEE80211_MAX_SSID_LEN];
4148 u8 ssid_len, mesh_id_len, mesh_id_up_len;
4149 struct cfg80211_conn *conn;
4150 struct cfg80211_cached_keys *connect_keys;
4151 enum ieee80211_bss_type conn_bss_type;
4152 u32 conn_owner_nlportid;
4154 struct work_struct disconnect_wk;
4155 u8 disconnect_bssid[ETH_ALEN];
4157 struct list_head event_list;
4158 spinlock_t event_lock;
4160 struct cfg80211_internal_bss *current_bss; /* associated / joined */
4161 struct cfg80211_chan_def preset_chandef;
4162 struct cfg80211_chan_def chandef;
4165 bool ibss_dfs_possible;
4170 int beacon_interval;
4172 u32 ap_unexpected_nlportid;
4178 unsigned long cac_start_time;
4179 unsigned int cac_time_ms;
4181 #ifdef CONFIG_CFG80211_WEXT
4184 struct cfg80211_ibss_params ibss;
4185 struct cfg80211_connect_params connect;
4186 struct cfg80211_cached_keys *keys;
4189 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
4190 u8 ssid[IEEE80211_MAX_SSID_LEN];
4191 s8 default_key, default_mgmt_key;
4192 bool prev_bssid_valid;
4196 struct cfg80211_cqm_config *cqm_config;
4199 static inline u8 *wdev_address(struct wireless_dev *wdev)
4202 return wdev->netdev->dev_addr;
4203 return wdev->address;
4206 static inline bool wdev_running(struct wireless_dev *wdev)
4209 return netif_running(wdev->netdev);
4210 return wdev->is_running;
4214 * wdev_priv - return wiphy priv from wireless_dev
4216 * @wdev: The wireless device whose wiphy's priv pointer to return
4217 * Return: The wiphy priv of @wdev.
4219 static inline void *wdev_priv(struct wireless_dev *wdev)
4222 return wiphy_priv(wdev->wiphy);
4226 * DOC: Utility functions
4228 * cfg80211 offers a number of utility functions that can be useful.
4232 * ieee80211_channel_to_frequency - convert channel number to frequency
4233 * @chan: channel number
4234 * @band: band, necessary due to channel number overlap
4235 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
4237 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
4240 * ieee80211_frequency_to_channel - convert frequency to channel number
4241 * @freq: center frequency
4242 * Return: The corresponding channel, or 0 if the conversion failed.
4244 int ieee80211_frequency_to_channel(int freq);
4247 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
4249 * @wiphy: the struct wiphy to get the channel for
4250 * @freq: the center frequency of the channel
4252 * Return: The channel struct from @wiphy at @freq.
4254 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
4257 * ieee80211_get_response_rate - get basic rate for a given rate
4259 * @sband: the band to look for rates in
4260 * @basic_rates: bitmap of basic rates
4261 * @bitrate: the bitrate for which to find the basic rate
4263 * Return: The basic rate corresponding to a given bitrate, that
4264 * is the next lower bitrate contained in the basic rate map,
4265 * which is, for this function, given as a bitmap of indices of
4266 * rates in the band's bitrate table.
4268 struct ieee80211_rate *
4269 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
4270 u32 basic_rates, int bitrate);
4273 * ieee80211_mandatory_rates - get mandatory rates for a given band
4274 * @sband: the band to look for rates in
4275 * @scan_width: width of the control channel
4277 * This function returns a bitmap of the mandatory rates for the given
4278 * band, bits are set according to the rate position in the bitrates array.
4280 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
4281 enum nl80211_bss_scan_width scan_width);
4284 * Radiotap parsing functions -- for controlled injection support
4286 * Implemented in net/wireless/radiotap.c
4287 * Documentation in Documentation/networking/radiotap-headers.txt
4290 struct radiotap_align_size {
4291 uint8_t align:4, size:4;
4294 struct ieee80211_radiotap_namespace {
4295 const struct radiotap_align_size *align_size;
4301 struct ieee80211_radiotap_vendor_namespaces {
4302 const struct ieee80211_radiotap_namespace *ns;
4307 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
4308 * @this_arg_index: index of current arg, valid after each successful call
4309 * to ieee80211_radiotap_iterator_next()
4310 * @this_arg: pointer to current radiotap arg; it is valid after each
4311 * call to ieee80211_radiotap_iterator_next() but also after
4312 * ieee80211_radiotap_iterator_init() where it will point to
4313 * the beginning of the actual data portion
4314 * @this_arg_size: length of the current arg, for convenience
4315 * @current_namespace: pointer to the current namespace definition
4316 * (or internally %NULL if the current namespace is unknown)
4317 * @is_radiotap_ns: indicates whether the current namespace is the default
4318 * radiotap namespace or not
4320 * @_rtheader: pointer to the radiotap header we are walking through
4321 * @_max_length: length of radiotap header in cpu byte ordering
4322 * @_arg_index: next argument index
4323 * @_arg: next argument pointer
4324 * @_next_bitmap: internal pointer to next present u32
4325 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
4326 * @_vns: vendor namespace definitions
4327 * @_next_ns_data: beginning of the next namespace's data
4328 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
4331 * Describes the radiotap parser state. Fields prefixed with an underscore
4332 * must not be used by users of the parser, only by the parser internally.
4335 struct ieee80211_radiotap_iterator {
4336 struct ieee80211_radiotap_header *_rtheader;
4337 const struct ieee80211_radiotap_vendor_namespaces *_vns;
4338 const struct ieee80211_radiotap_namespace *current_namespace;
4340 unsigned char *_arg, *_next_ns_data;
4341 __le32 *_next_bitmap;
4343 unsigned char *this_arg;
4351 uint32_t _bitmap_shifter;
4356 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
4357 struct ieee80211_radiotap_header *radiotap_header,
4359 const struct ieee80211_radiotap_vendor_namespaces *vns);
4362 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
4365 extern const unsigned char rfc1042_header[6];
4366 extern const unsigned char bridge_tunnel_header[6];
4369 * ieee80211_get_hdrlen_from_skb - get header length from data
4373 * Given an skb with a raw 802.11 header at the data pointer this function
4374 * returns the 802.11 header length.
4376 * Return: The 802.11 header length in bytes (not including encryption
4377 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
4380 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
4383 * ieee80211_hdrlen - get header length in bytes from frame control
4384 * @fc: frame control field in little-endian format
4385 * Return: The header length in bytes.
4387 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
4390 * ieee80211_get_mesh_hdrlen - get mesh extension header length
4391 * @meshhdr: the mesh extension header, only the flags field
4392 * (first byte) will be accessed
4393 * Return: The length of the extension header, which is always at
4394 * least 6 bytes and at most 18 if address 5 and 6 are present.
4396 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
4399 * DOC: Data path helpers
4401 * In addition to generic utilities, cfg80211 also offers
4402 * functions that help implement the data path for devices
4403 * that do not do the 802.11/802.3 conversion on the device.
4407 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
4408 * @skb: the 802.11 data frame
4409 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
4410 * of it being pushed into the SKB
4411 * @addr: the device MAC address
4412 * @iftype: the virtual interface type
4413 * @data_offset: offset of payload after the 802.11 header
4414 * Return: 0 on success. Non-zero on error.
4416 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
4417 const u8 *addr, enum nl80211_iftype iftype,
4421 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
4422 * @skb: the 802.11 data frame
4423 * @addr: the device MAC address
4424 * @iftype: the virtual interface type
4425 * Return: 0 on success. Non-zero on error.
4427 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
4428 enum nl80211_iftype iftype)
4430 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
4434 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
4436 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
4437 * The @list will be empty if the decode fails. The @skb must be fully
4438 * header-less before being passed in here; it is freed in this function.
4440 * @skb: The input A-MSDU frame without any headers.
4441 * @list: The output list of 802.3 frames. It must be allocated and
4442 * initialized by by the caller.
4443 * @addr: The device MAC address.
4444 * @iftype: The device interface type.
4445 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
4446 * @check_da: DA to check in the inner ethernet header, or NULL
4447 * @check_sa: SA to check in the inner ethernet header, or NULL
4449 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
4450 const u8 *addr, enum nl80211_iftype iftype,
4451 const unsigned int extra_headroom,
4452 const u8 *check_da, const u8 *check_sa);
4455 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
4456 * @skb: the data frame
4457 * @qos_map: Interworking QoS mapping or %NULL if not in use
4458 * Return: The 802.1p/1d tag.
4460 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
4461 struct cfg80211_qos_map *qos_map);
4464 * cfg80211_find_ie_match - match information element and byte array in data
4467 * @ies: data consisting of IEs
4468 * @len: length of data
4469 * @match: byte array to match
4470 * @match_len: number of bytes in the match array
4471 * @match_offset: offset in the IE where the byte array should match.
4472 * If match_len is zero, this must also be set to zero.
4473 * Otherwise this must be set to 2 or more, because the first
4474 * byte is the element id, which is already compared to eid, and
4475 * the second byte is the IE length.
4477 * Return: %NULL if the element ID could not be found or if
4478 * the element is invalid (claims to be longer than the given
4479 * data) or if the byte array doesn't match, or a pointer to the first
4480 * byte of the requested element, that is the byte containing the
4483 * Note: There are no checks on the element length other than
4484 * having to fit into the given data and being large enough for the
4485 * byte array to match.
4487 const u8 *cfg80211_find_ie_match(u8 eid, const u8 *ies, int len,
4488 const u8 *match, int match_len,
4492 * cfg80211_find_ie - find information element in data
4495 * @ies: data consisting of IEs
4496 * @len: length of data
4498 * Return: %NULL if the element ID could not be found or if
4499 * the element is invalid (claims to be longer than the given
4500 * data), or a pointer to the first byte of the requested
4501 * element, that is the byte containing the element ID.
4503 * Note: There are no checks on the element length other than
4504 * having to fit into the given data.
4506 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
4508 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
4512 * cfg80211_find_ext_ie - find information element with EID Extension in data
4514 * @ext_eid: element ID Extension
4515 * @ies: data consisting of IEs
4516 * @len: length of data
4518 * Return: %NULL if the extended element ID could not be found or if
4519 * the element is invalid (claims to be longer than the given
4520 * data), or a pointer to the first byte of the requested
4521 * element, that is the byte containing the element ID.
4523 * Note: There are no checks on the element length other than
4524 * having to fit into the given data.
4526 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
4528 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
4533 * cfg80211_find_vendor_ie - find vendor specific information element in data
4536 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
4537 * @ies: data consisting of IEs
4538 * @len: length of data
4540 * Return: %NULL if the vendor specific element ID could not be found or if the
4541 * element is invalid (claims to be longer than the given data), or a pointer to
4542 * the first byte of the requested element, that is the byte containing the
4545 * Note: There are no checks on the element length other than having to fit into
4548 const u8 *cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
4549 const u8 *ies, int len);
4552 * DOC: Regulatory enforcement infrastructure
4558 * regulatory_hint - driver hint to the wireless core a regulatory domain
4559 * @wiphy: the wireless device giving the hint (used only for reporting
4561 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
4562 * should be in. If @rd is set this should be NULL. Note that if you
4563 * set this to NULL you should still set rd->alpha2 to some accepted
4566 * Wireless drivers can use this function to hint to the wireless core
4567 * what it believes should be the current regulatory domain by
4568 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4569 * domain should be in or by providing a completely build regulatory domain.
4570 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4571 * for a regulatory domain structure for the respective country.
4573 * The wiphy must have been registered to cfg80211 prior to this call.
4574 * For cfg80211 drivers this means you must first use wiphy_register(),
4575 * for mac80211 drivers you must first use ieee80211_register_hw().
4577 * Drivers should check the return value, its possible you can get
4580 * Return: 0 on success. -ENOMEM.
4582 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
4585 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4586 * @wiphy: the wireless device we want to process the regulatory domain on
4587 * @rd: the regulatory domain informatoin to use for this wiphy
4589 * Set the regulatory domain information for self-managed wiphys, only they
4590 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4593 * Return: 0 on success. -EINVAL, -EPERM
4595 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
4596 struct ieee80211_regdomain *rd);
4599 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4600 * @wiphy: the wireless device we want to process the regulatory domain on
4601 * @rd: the regulatory domain information to use for this wiphy
4603 * This functions requires the RTNL to be held and applies the new regdomain
4604 * synchronously to this wiphy. For more details see
4605 * regulatory_set_wiphy_regd().
4607 * Return: 0 on success. -EINVAL, -EPERM
4609 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
4610 struct ieee80211_regdomain *rd);
4613 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4614 * @wiphy: the wireless device we want to process the regulatory domain on
4615 * @regd: the custom regulatory domain to use for this wiphy
4617 * Drivers can sometimes have custom regulatory domains which do not apply
4618 * to a specific country. Drivers can use this to apply such custom regulatory
4619 * domains. This routine must be called prior to wiphy registration. The
4620 * custom regulatory domain will be trusted completely and as such previous
4621 * default channel settings will be disregarded. If no rule is found for a
4622 * channel on the regulatory domain the channel will be disabled.
4623 * Drivers using this for a wiphy should also set the wiphy flag
4624 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4625 * that called this helper.
4627 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
4628 const struct ieee80211_regdomain *regd);
4631 * freq_reg_info - get regulatory information for the given frequency
4632 * @wiphy: the wiphy for which we want to process this rule for
4633 * @center_freq: Frequency in KHz for which we want regulatory information for
4635 * Use this function to get the regulatory rule for a specific frequency on
4636 * a given wireless device. If the device has a specific regulatory domain
4637 * it wants to follow we respect that unless a country IE has been received
4638 * and processed already.
4640 * Return: A valid pointer, or, when an error occurs, for example if no rule
4641 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4642 * check and PTR_ERR() to obtain the numeric return value. The numeric return
4643 * value will be -ERANGE if we determine the given center_freq does not even
4644 * have a regulatory rule for a frequency range in the center_freq's band.
4645 * See freq_in_rule_band() for our current definition of a band -- this is
4646 * purely subjective and right now it's 802.11 specific.
4648 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
4652 * reg_initiator_name - map regulatory request initiator enum to name
4653 * @initiator: the regulatory request initiator
4655 * You can use this to map the regulatory request initiator enum to a
4656 * proper string representation.
4658 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
4661 * callbacks for asynchronous cfg80211 methods, notification
4662 * functions and BSS handling helpers
4666 * cfg80211_scan_done - notify that scan finished
4668 * @request: the corresponding scan request
4669 * @info: information about the completed scan
4671 void cfg80211_scan_done(struct cfg80211_scan_request *request,
4672 struct cfg80211_scan_info *info);
4675 * cfg80211_sched_scan_results - notify that new scan results are available
4677 * @wiphy: the wiphy which got scheduled scan results
4678 * @reqid: identifier for the related scheduled scan request
4680 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
4683 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4685 * @wiphy: the wiphy on which the scheduled scan stopped
4686 * @reqid: identifier for the related scheduled scan request
4688 * The driver can call this function to inform cfg80211 that the
4689 * scheduled scan had to be stopped, for whatever reason. The driver
4690 * is then called back via the sched_scan_stop operation when done.
4692 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
4695 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4697 * @wiphy: the wiphy on which the scheduled scan stopped
4698 * @reqid: identifier for the related scheduled scan request
4700 * The driver can call this function to inform cfg80211 that the
4701 * scheduled scan had to be stopped, for whatever reason. The driver
4702 * is then called back via the sched_scan_stop operation when done.
4703 * This function should be called with rtnl locked.
4705 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
4708 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4709 * @wiphy: the wiphy reporting the BSS
4710 * @data: the BSS metadata
4711 * @mgmt: the management frame (probe response or beacon)
4712 * @len: length of the management frame
4713 * @gfp: context flags
4715 * This informs cfg80211 that BSS information was found and
4716 * the BSS should be updated/added.
4718 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4719 * Or %NULL on error.
4721 struct cfg80211_bss * __must_check
4722 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4723 struct cfg80211_inform_bss *data,
4724 struct ieee80211_mgmt *mgmt, size_t len,
4727 static inline struct cfg80211_bss * __must_check
4728 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4729 struct ieee80211_channel *rx_channel,
4730 enum nl80211_bss_scan_width scan_width,
4731 struct ieee80211_mgmt *mgmt, size_t len,
4732 s32 signal, gfp_t gfp)
4734 struct cfg80211_inform_bss data = {
4736 .scan_width = scan_width,
4740 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4743 static inline struct cfg80211_bss * __must_check
4744 cfg80211_inform_bss_frame(struct wiphy *wiphy,
4745 struct ieee80211_channel *rx_channel,
4746 struct ieee80211_mgmt *mgmt, size_t len,
4747 s32 signal, gfp_t gfp)
4749 struct cfg80211_inform_bss data = {
4751 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4755 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4759 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4760 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4761 * from a beacon or probe response
4762 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4763 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4765 enum cfg80211_bss_frame_type {
4766 CFG80211_BSS_FTYPE_UNKNOWN,
4767 CFG80211_BSS_FTYPE_BEACON,
4768 CFG80211_BSS_FTYPE_PRESP,
4772 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4774 * @wiphy: the wiphy reporting the BSS
4775 * @data: the BSS metadata
4776 * @ftype: frame type (if known)
4777 * @bssid: the BSSID of the BSS
4778 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4779 * @capability: the capability field sent by the peer
4780 * @beacon_interval: the beacon interval announced by the peer
4781 * @ie: additional IEs sent by the peer
4782 * @ielen: length of the additional IEs
4783 * @gfp: context flags
4785 * This informs cfg80211 that BSS information was found and
4786 * the BSS should be updated/added.
4788 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4789 * Or %NULL on error.
4791 struct cfg80211_bss * __must_check
4792 cfg80211_inform_bss_data(struct wiphy *wiphy,
4793 struct cfg80211_inform_bss *data,
4794 enum cfg80211_bss_frame_type ftype,
4795 const u8 *bssid, u64 tsf, u16 capability,
4796 u16 beacon_interval, const u8 *ie, size_t ielen,
4799 static inline struct cfg80211_bss * __must_check
4800 cfg80211_inform_bss_width(struct wiphy *wiphy,
4801 struct ieee80211_channel *rx_channel,
4802 enum nl80211_bss_scan_width scan_width,
4803 enum cfg80211_bss_frame_type ftype,
4804 const u8 *bssid, u64 tsf, u16 capability,
4805 u16 beacon_interval, const u8 *ie, size_t ielen,
4806 s32 signal, gfp_t gfp)
4808 struct cfg80211_inform_bss data = {
4810 .scan_width = scan_width,
4814 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4815 capability, beacon_interval, ie, ielen,
4819 static inline struct cfg80211_bss * __must_check
4820 cfg80211_inform_bss(struct wiphy *wiphy,
4821 struct ieee80211_channel *rx_channel,
4822 enum cfg80211_bss_frame_type ftype,
4823 const u8 *bssid, u64 tsf, u16 capability,
4824 u16 beacon_interval, const u8 *ie, size_t ielen,
4825 s32 signal, gfp_t gfp)
4827 struct cfg80211_inform_bss data = {
4829 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4833 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4834 capability, beacon_interval, ie, ielen,
4839 * cfg80211_get_bss - get a BSS reference
4840 * @wiphy: the wiphy this BSS struct belongs to
4841 * @channel: the channel to search on (or %NULL)
4842 * @bssid: the desired BSSID (or %NULL)
4843 * @ssid: the desired SSID (or %NULL)
4844 * @ssid_len: length of the SSID (or 0)
4845 * @bss_type: type of BSS, see &enum ieee80211_bss_type
4846 * @privacy: privacy filter, see &enum ieee80211_privacy
4848 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4849 struct ieee80211_channel *channel,
4851 const u8 *ssid, size_t ssid_len,
4852 enum ieee80211_bss_type bss_type,
4853 enum ieee80211_privacy privacy);
4854 static inline struct cfg80211_bss *
4855 cfg80211_get_ibss(struct wiphy *wiphy,
4856 struct ieee80211_channel *channel,
4857 const u8 *ssid, size_t ssid_len)
4859 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4860 IEEE80211_BSS_TYPE_IBSS,
4861 IEEE80211_PRIVACY_ANY);
4865 * cfg80211_ref_bss - reference BSS struct
4866 * @wiphy: the wiphy this BSS struct belongs to
4867 * @bss: the BSS struct to reference
4869 * Increments the refcount of the given BSS struct.
4871 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4874 * cfg80211_put_bss - unref BSS struct
4875 * @wiphy: the wiphy this BSS struct belongs to
4876 * @bss: the BSS struct
4878 * Decrements the refcount of the given BSS struct.
4880 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4883 * cfg80211_unlink_bss - unlink BSS from internal data structures
4885 * @bss: the bss to remove
4887 * This function removes the given BSS from the internal data structures
4888 * thereby making it no longer show up in scan results etc. Use this
4889 * function when you detect a BSS is gone. Normally BSSes will also time
4890 * out, so it is not necessary to use this function at all.
4892 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4894 static inline enum nl80211_bss_scan_width
4895 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4897 switch (chandef->width) {
4898 case NL80211_CHAN_WIDTH_5:
4899 return NL80211_BSS_CHAN_WIDTH_5;
4900 case NL80211_CHAN_WIDTH_10:
4901 return NL80211_BSS_CHAN_WIDTH_10;
4903 return NL80211_BSS_CHAN_WIDTH_20;
4908 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4909 * @dev: network device
4910 * @buf: authentication frame (header + body)
4911 * @len: length of the frame data
4913 * This function is called whenever an authentication, disassociation or
4914 * deauthentication frame has been received and processed in station mode.
4915 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4916 * call either this function or cfg80211_auth_timeout().
4917 * After being asked to associate via cfg80211_ops::assoc() the driver must
4918 * call either this function or cfg80211_auth_timeout().
4919 * While connected, the driver must calls this for received and processed
4920 * disassociation and deauthentication frames. If the frame couldn't be used
4921 * because it was unprotected, the driver must call the function
4922 * cfg80211_rx_unprot_mlme_mgmt() instead.
4924 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4926 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4929 * cfg80211_auth_timeout - notification of timed out authentication
4930 * @dev: network device
4931 * @addr: The MAC address of the device with which the authentication timed out
4933 * This function may sleep. The caller must hold the corresponding wdev's
4936 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4939 * cfg80211_rx_assoc_resp - notification of processed association response
4940 * @dev: network device
4941 * @bss: the BSS that association was requested with, ownership of the pointer
4942 * moves to cfg80211 in this call
4943 * @buf: authentication frame (header + body)
4944 * @len: length of the frame data
4945 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
4946 * as the AC bitmap in the QoS info field
4948 * After being asked to associate via cfg80211_ops::assoc() the driver must
4949 * call either this function or cfg80211_auth_timeout().
4951 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4953 void cfg80211_rx_assoc_resp(struct net_device *dev,
4954 struct cfg80211_bss *bss,
4955 const u8 *buf, size_t len,
4959 * cfg80211_assoc_timeout - notification of timed out association
4960 * @dev: network device
4961 * @bss: The BSS entry with which association timed out.
4963 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4965 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4968 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
4969 * @dev: network device
4970 * @bss: The BSS entry with which association was abandoned.
4972 * Call this whenever - for reasons reported through other API, like deauth RX,
4973 * an association attempt was abandoned.
4974 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4976 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
4979 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4980 * @dev: network device
4981 * @buf: 802.11 frame (header + body)
4982 * @len: length of the frame data
4984 * This function is called whenever deauthentication has been processed in
4985 * station mode. This includes both received deauthentication frames and
4986 * locally generated ones. This function may sleep. The caller must hold the
4987 * corresponding wdev's mutex.
4989 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4992 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4993 * @dev: network device
4994 * @buf: deauthentication frame (header + body)
4995 * @len: length of the frame data
4997 * This function is called whenever a received deauthentication or dissassoc
4998 * frame has been dropped in station mode because of MFP being used but the
4999 * frame was not protected. This function may sleep.
5001 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
5002 const u8 *buf, size_t len);
5005 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
5006 * @dev: network device
5007 * @addr: The source MAC address of the frame
5008 * @key_type: The key type that the received frame used
5009 * @key_id: Key identifier (0..3). Can be -1 if missing.
5010 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
5011 * @gfp: allocation flags
5013 * This function is called whenever the local MAC detects a MIC failure in a
5014 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
5017 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
5018 enum nl80211_key_type key_type, int key_id,
5019 const u8 *tsc, gfp_t gfp);
5022 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
5024 * @dev: network device
5025 * @bssid: the BSSID of the IBSS joined
5026 * @channel: the channel of the IBSS joined
5027 * @gfp: allocation flags
5029 * This function notifies cfg80211 that the device joined an IBSS or
5030 * switched to a different BSSID. Before this function can be called,
5031 * either a beacon has to have been received from the IBSS, or one of
5032 * the cfg80211_inform_bss{,_frame} functions must have been called
5033 * with the locally generated beacon -- this guarantees that there is
5034 * always a scan result for this IBSS. cfg80211 will handle the rest.
5036 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
5037 struct ieee80211_channel *channel, gfp_t gfp);
5040 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
5042 * @dev: network device
5043 * @macaddr: the MAC address of the new candidate
5044 * @ie: information elements advertised by the peer candidate
5045 * @ie_len: lenght of the information elements buffer
5046 * @gfp: allocation flags
5048 * This function notifies cfg80211 that the mesh peer candidate has been
5049 * detected, most likely via a beacon or, less likely, via a probe response.
5050 * cfg80211 then sends a notification to userspace.
5052 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
5053 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
5056 * DOC: RFkill integration
5058 * RFkill integration in cfg80211 is almost invisible to drivers,
5059 * as cfg80211 automatically registers an rfkill instance for each
5060 * wireless device it knows about. Soft kill is also translated
5061 * into disconnecting and turning all interfaces off, drivers are
5062 * expected to turn off the device when all interfaces are down.
5064 * However, devices may have a hard RFkill line, in which case they
5065 * also need to interact with the rfkill subsystem, via cfg80211.
5066 * They can do this with a few helper functions documented here.
5070 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
5072 * @blocked: block status
5074 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
5077 * wiphy_rfkill_start_polling - start polling rfkill
5080 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
5083 * wiphy_rfkill_stop_polling - stop polling rfkill
5086 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
5089 * DOC: Vendor commands
5091 * Occasionally, there are special protocol or firmware features that
5092 * can't be implemented very openly. For this and similar cases, the
5093 * vendor command functionality allows implementing the features with
5094 * (typically closed-source) userspace and firmware, using nl80211 as
5095 * the configuration mechanism.
5097 * A driver supporting vendor commands must register them as an array
5098 * in struct wiphy, with handlers for each one, each command has an
5099 * OUI and sub command ID to identify it.
5101 * Note that this feature should not be (ab)used to implement protocol
5102 * features that could openly be shared across drivers. In particular,
5103 * it must never be required to use vendor commands to implement any
5104 * "normal" functionality that higher-level userspace like connection
5105 * managers etc. need.
5108 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
5109 enum nl80211_commands cmd,
5110 enum nl80211_attrs attr,
5113 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
5114 struct wireless_dev *wdev,
5115 enum nl80211_commands cmd,
5116 enum nl80211_attrs attr,
5117 int vendor_event_idx,
5118 int approxlen, gfp_t gfp);
5120 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
5123 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
5125 * @approxlen: an upper bound of the length of the data that will
5126 * be put into the skb
5128 * This function allocates and pre-fills an skb for a reply to
5129 * a vendor command. Since it is intended for a reply, calling
5130 * it outside of a vendor command's doit() operation is invalid.
5132 * The returned skb is pre-filled with some identifying data in
5133 * a way that any data that is put into the skb (with skb_put(),
5134 * nla_put() or similar) will end up being within the
5135 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
5136 * with the skb is adding data for the corresponding userspace tool
5137 * which can then read that data out of the vendor data attribute.
5138 * You must not modify the skb in any other way.
5140 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
5141 * its error code as the result of the doit() operation.
5143 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5145 static inline struct sk_buff *
5146 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5148 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
5149 NL80211_ATTR_VENDOR_DATA, approxlen);
5153 * cfg80211_vendor_cmd_reply - send the reply skb
5154 * @skb: The skb, must have been allocated with
5155 * cfg80211_vendor_cmd_alloc_reply_skb()
5157 * Since calling this function will usually be the last thing
5158 * before returning from the vendor command doit() you should
5159 * return the error code. Note that this function consumes the
5160 * skb regardless of the return value.
5162 * Return: An error code or 0 on success.
5164 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
5167 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
5169 * @wdev: the wireless device
5170 * @event_idx: index of the vendor event in the wiphy's vendor_events
5171 * @approxlen: an upper bound of the length of the data that will
5172 * be put into the skb
5173 * @gfp: allocation flags
5175 * This function allocates and pre-fills an skb for an event on the
5176 * vendor-specific multicast group.
5178 * If wdev != NULL, both the ifindex and identifier of the specified
5179 * wireless device are added to the event message before the vendor data
5182 * When done filling the skb, call cfg80211_vendor_event() with the
5183 * skb to send the event.
5185 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5187 static inline struct sk_buff *
5188 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
5189 int approxlen, int event_idx, gfp_t gfp)
5191 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
5192 NL80211_ATTR_VENDOR_DATA,
5193 event_idx, approxlen, gfp);
5197 * cfg80211_vendor_event - send the event
5198 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
5199 * @gfp: allocation flags
5201 * This function sends the given @skb, which must have been allocated
5202 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
5204 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
5206 __cfg80211_send_event_skb(skb, gfp);
5209 #ifdef CONFIG_NL80211_TESTMODE
5213 * Test mode is a set of utility functions to allow drivers to
5214 * interact with driver-specific tools to aid, for instance,
5215 * factory programming.
5217 * This chapter describes how drivers interact with it, for more
5218 * information see the nl80211 book's chapter on it.
5222 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
5224 * @approxlen: an upper bound of the length of the data that will
5225 * be put into the skb
5227 * This function allocates and pre-fills an skb for a reply to
5228 * the testmode command. Since it is intended for a reply, calling
5229 * it outside of the @testmode_cmd operation is invalid.
5231 * The returned skb is pre-filled with the wiphy index and set up in
5232 * a way that any data that is put into the skb (with skb_put(),
5233 * nla_put() or similar) will end up being within the
5234 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
5235 * with the skb is adding data for the corresponding userspace tool
5236 * which can then read that data out of the testdata attribute. You
5237 * must not modify the skb in any other way.
5239 * When done, call cfg80211_testmode_reply() with the skb and return
5240 * its error code as the result of the @testmode_cmd operation.
5242 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5244 static inline struct sk_buff *
5245 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5247 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
5248 NL80211_ATTR_TESTDATA, approxlen);
5252 * cfg80211_testmode_reply - send the reply skb
5253 * @skb: The skb, must have been allocated with
5254 * cfg80211_testmode_alloc_reply_skb()
5256 * Since calling this function will usually be the last thing
5257 * before returning from the @testmode_cmd you should return
5258 * the error code. Note that this function consumes the skb
5259 * regardless of the return value.
5261 * Return: An error code or 0 on success.
5263 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
5265 return cfg80211_vendor_cmd_reply(skb);
5269 * cfg80211_testmode_alloc_event_skb - allocate testmode event
5271 * @approxlen: an upper bound of the length of the data that will
5272 * be put into the skb
5273 * @gfp: allocation flags
5275 * This function allocates and pre-fills an skb for an event on the
5276 * testmode multicast group.
5278 * The returned skb is set up in the same way as with
5279 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
5280 * there, you should simply add data to it that will then end up in the
5281 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
5284 * When done filling the skb, call cfg80211_testmode_event() with the
5285 * skb to send the event.
5287 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5289 static inline struct sk_buff *
5290 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
5292 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
5293 NL80211_ATTR_TESTDATA, -1,
5298 * cfg80211_testmode_event - send the event
5299 * @skb: The skb, must have been allocated with
5300 * cfg80211_testmode_alloc_event_skb()
5301 * @gfp: allocation flags
5303 * This function sends the given @skb, which must have been allocated
5304 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
5307 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
5309 __cfg80211_send_event_skb(skb, gfp);
5312 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
5313 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
5315 #define CFG80211_TESTMODE_CMD(cmd)
5316 #define CFG80211_TESTMODE_DUMP(cmd)
5320 * struct cfg80211_connect_resp_params - Connection response params
5321 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
5322 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5323 * the real status code for failures. If this call is used to report a
5324 * failure due to a timeout (e.g., not receiving an Authentication frame
5325 * from the AP) instead of an explicit rejection by the AP, -1 is used to
5326 * indicate that this is a failure, but without a status code.
5327 * @timeout_reason is used to report the reason for the timeout in that
5329 * @bssid: The BSSID of the AP (may be %NULL)
5330 * @bss: Entry of bss to which STA got connected to, can be obtained through
5331 * cfg80211_get_bss() (may be %NULL). Only one parameter among @bssid and
5332 * @bss needs to be specified.
5333 * @req_ie: Association request IEs (may be %NULL)
5334 * @req_ie_len: Association request IEs length
5335 * @resp_ie: Association response IEs (may be %NULL)
5336 * @resp_ie_len: Association response IEs length
5337 * @fils_kek: KEK derived from a successful FILS connection (may be %NULL)
5338 * @fils_kek_len: Length of @fils_kek in octets
5339 * @update_erp_next_seq_num: Boolean value to specify whether the value in
5340 * @fils_erp_next_seq_num is valid.
5341 * @fils_erp_next_seq_num: The next sequence number to use in ERP message in
5342 * FILS Authentication. This value should be specified irrespective of the
5343 * status for a FILS connection.
5344 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
5345 * @pmk_len: Length of @pmk in octets
5346 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
5347 * used for this FILS connection (may be %NULL).
5348 * @timeout_reason: Reason for connection timeout. This is used when the
5349 * connection fails due to a timeout instead of an explicit rejection from
5350 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5351 * not known. This value is used only if @status < 0 to indicate that the
5352 * failure is due to a timeout and not due to explicit rejection by the AP.
5353 * This value is ignored in other cases (@status >= 0).
5355 struct cfg80211_connect_resp_params {
5358 struct cfg80211_bss *bss;
5364 size_t fils_kek_len;
5365 bool update_erp_next_seq_num;
5366 u16 fils_erp_next_seq_num;
5370 enum nl80211_timeout_reason timeout_reason;
5374 * cfg80211_connect_done - notify cfg80211 of connection result
5376 * @dev: network device
5377 * @params: connection response parameters
5378 * @gfp: allocation flags
5380 * It should be called by the underlying driver once execution of the connection
5381 * request from connect() has been completed. This is similar to
5382 * cfg80211_connect_bss(), but takes a structure pointer for connection response
5383 * parameters. Only one of the functions among cfg80211_connect_bss(),
5384 * cfg80211_connect_result(), cfg80211_connect_timeout(),
5385 * and cfg80211_connect_done() should be called.
5387 void cfg80211_connect_done(struct net_device *dev,
5388 struct cfg80211_connect_resp_params *params,
5392 * cfg80211_connect_bss - notify cfg80211 of connection result
5394 * @dev: network device
5395 * @bssid: the BSSID of the AP
5396 * @bss: entry of bss to which STA got connected to, can be obtained
5397 * through cfg80211_get_bss (may be %NULL)
5398 * @req_ie: association request IEs (maybe be %NULL)
5399 * @req_ie_len: association request IEs length
5400 * @resp_ie: association response IEs (may be %NULL)
5401 * @resp_ie_len: assoc response IEs length
5402 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5403 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5404 * the real status code for failures. If this call is used to report a
5405 * failure due to a timeout (e.g., not receiving an Authentication frame
5406 * from the AP) instead of an explicit rejection by the AP, -1 is used to
5407 * indicate that this is a failure, but without a status code.
5408 * @timeout_reason is used to report the reason for the timeout in that
5410 * @gfp: allocation flags
5411 * @timeout_reason: reason for connection timeout. This is used when the
5412 * connection fails due to a timeout instead of an explicit rejection from
5413 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5414 * not known. This value is used only if @status < 0 to indicate that the
5415 * failure is due to a timeout and not due to explicit rejection by the AP.
5416 * This value is ignored in other cases (@status >= 0).
5418 * It should be called by the underlying driver once execution of the connection
5419 * request from connect() has been completed. This is similar to
5420 * cfg80211_connect_result(), but with the option of identifying the exact bss
5421 * entry for the connection. Only one of the functions among
5422 * cfg80211_connect_bss(), cfg80211_connect_result(),
5423 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5426 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
5427 struct cfg80211_bss *bss, const u8 *req_ie,
5428 size_t req_ie_len, const u8 *resp_ie,
5429 size_t resp_ie_len, int status, gfp_t gfp,
5430 enum nl80211_timeout_reason timeout_reason)
5432 struct cfg80211_connect_resp_params params;
5434 memset(¶ms, 0, sizeof(params));
5435 params.status = status;
5436 params.bssid = bssid;
5438 params.req_ie = req_ie;
5439 params.req_ie_len = req_ie_len;
5440 params.resp_ie = resp_ie;
5441 params.resp_ie_len = resp_ie_len;
5442 params.timeout_reason = timeout_reason;
5444 cfg80211_connect_done(dev, ¶ms, gfp);
5448 * cfg80211_connect_result - notify cfg80211 of connection result
5450 * @dev: network device
5451 * @bssid: the BSSID of the AP
5452 * @req_ie: association request IEs (maybe be %NULL)
5453 * @req_ie_len: association request IEs length
5454 * @resp_ie: association response IEs (may be %NULL)
5455 * @resp_ie_len: assoc response IEs length
5456 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5457 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5458 * the real status code for failures.
5459 * @gfp: allocation flags
5461 * It should be called by the underlying driver once execution of the connection
5462 * request from connect() has been completed. This is similar to
5463 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
5464 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
5465 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5468 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
5469 const u8 *req_ie, size_t req_ie_len,
5470 const u8 *resp_ie, size_t resp_ie_len,
5471 u16 status, gfp_t gfp)
5473 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
5474 resp_ie_len, status, gfp,
5475 NL80211_TIMEOUT_UNSPECIFIED);
5479 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
5481 * @dev: network device
5482 * @bssid: the BSSID of the AP
5483 * @req_ie: association request IEs (maybe be %NULL)
5484 * @req_ie_len: association request IEs length
5485 * @gfp: allocation flags
5486 * @timeout_reason: reason for connection timeout.
5488 * It should be called by the underlying driver whenever connect() has failed
5489 * in a sequence where no explicit authentication/association rejection was
5490 * received from the AP. This could happen, e.g., due to not being able to send
5491 * out the Authentication or Association Request frame or timing out while
5492 * waiting for the response. Only one of the functions among
5493 * cfg80211_connect_bss(), cfg80211_connect_result(),
5494 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
5497 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
5498 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
5499 enum nl80211_timeout_reason timeout_reason)
5501 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
5502 gfp, timeout_reason);
5506 * struct cfg80211_roam_info - driver initiated roaming information
5508 * @channel: the channel of the new AP
5509 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
5510 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
5511 * @req_ie: association request IEs (maybe be %NULL)
5512 * @req_ie_len: association request IEs length
5513 * @resp_ie: association response IEs (may be %NULL)
5514 * @resp_ie_len: assoc response IEs length
5516 struct cfg80211_roam_info {
5517 struct ieee80211_channel *channel;
5518 struct cfg80211_bss *bss;
5527 * cfg80211_roamed - notify cfg80211 of roaming
5529 * @dev: network device
5530 * @info: information about the new BSS. struct &cfg80211_roam_info.
5531 * @gfp: allocation flags
5533 * This function may be called with the driver passing either the BSSID of the
5534 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
5535 * It should be called by the underlying driver whenever it roamed from one AP
5536 * to another while connected. Drivers which have roaming implemented in
5537 * firmware should pass the bss entry to avoid a race in bss entry timeout where
5538 * the bss entry of the new AP is seen in the driver, but gets timed out by the
5539 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
5540 * rdev->event_work. In case of any failures, the reference is released
5541 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
5542 * released while diconneting from the current bss.
5544 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
5548 * cfg80211_port_authorized - notify cfg80211 of successful security association
5550 * @dev: network device
5551 * @bssid: the BSSID of the AP
5552 * @gfp: allocation flags
5554 * This function should be called by a driver that supports 4 way handshake
5555 * offload after a security association was successfully established (i.e.,
5556 * the 4 way handshake was completed successfully). The call to this function
5557 * should be preceded with a call to cfg80211_connect_result(),
5558 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
5559 * indicate the 802.11 association.
5561 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
5565 * cfg80211_disconnected - notify cfg80211 that connection was dropped
5567 * @dev: network device
5568 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
5569 * @ie_len: length of IEs
5570 * @reason: reason code for the disconnection, set it to 0 if unknown
5571 * @locally_generated: disconnection was requested locally
5572 * @gfp: allocation flags
5574 * After it calls this function, the driver should enter an idle state
5575 * and not try to connect to any AP any more.
5577 void cfg80211_disconnected(struct net_device *dev, u16 reason,
5578 const u8 *ie, size_t ie_len,
5579 bool locally_generated, gfp_t gfp);
5582 * cfg80211_ready_on_channel - notification of remain_on_channel start
5583 * @wdev: wireless device
5584 * @cookie: the request cookie
5585 * @chan: The current channel (from remain_on_channel request)
5586 * @duration: Duration in milliseconds that the driver intents to remain on the
5588 * @gfp: allocation flags
5590 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
5591 struct ieee80211_channel *chan,
5592 unsigned int duration, gfp_t gfp);
5595 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
5596 * @wdev: wireless device
5597 * @cookie: the request cookie
5598 * @chan: The current channel (from remain_on_channel request)
5599 * @gfp: allocation flags
5601 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
5602 struct ieee80211_channel *chan,
5607 * cfg80211_new_sta - notify userspace about station
5610 * @mac_addr: the station's address
5611 * @sinfo: the station information
5612 * @gfp: allocation flags
5614 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
5615 struct station_info *sinfo, gfp_t gfp);
5618 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
5620 * @mac_addr: the station's address
5621 * @sinfo: the station information/statistics
5622 * @gfp: allocation flags
5624 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
5625 struct station_info *sinfo, gfp_t gfp);
5628 * cfg80211_del_sta - notify userspace about deletion of a station
5631 * @mac_addr: the station's address
5632 * @gfp: allocation flags
5634 static inline void cfg80211_del_sta(struct net_device *dev,
5635 const u8 *mac_addr, gfp_t gfp)
5637 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
5641 * cfg80211_conn_failed - connection request failed notification
5644 * @mac_addr: the station's address
5645 * @reason: the reason for connection failure
5646 * @gfp: allocation flags
5648 * Whenever a station tries to connect to an AP and if the station
5649 * could not connect to the AP as the AP has rejected the connection
5650 * for some reasons, this function is called.
5652 * The reason for connection failure can be any of the value from
5653 * nl80211_connect_failed_reason enum
5655 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
5656 enum nl80211_connect_failed_reason reason,
5660 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
5661 * @wdev: wireless device receiving the frame
5662 * @freq: Frequency on which the frame was received in MHz
5663 * @sig_dbm: signal strength in dBm, or 0 if unknown
5664 * @buf: Management frame (header + body)
5665 * @len: length of the frame data
5666 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
5668 * This function is called whenever an Action frame is received for a station
5669 * mode interface, but is not processed in kernel.
5671 * Return: %true if a user space application has registered for this frame.
5672 * For action frames, that makes it responsible for rejecting unrecognized
5673 * action frames; %false otherwise, in which case for action frames the
5674 * driver is responsible for rejecting the frame.
5676 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
5677 const u8 *buf, size_t len, u32 flags);
5680 * cfg80211_mgmt_tx_status - notification of TX status for management frame
5681 * @wdev: wireless device receiving the frame
5682 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
5683 * @buf: Management frame (header + body)
5684 * @len: length of the frame data
5685 * @ack: Whether frame was acknowledged
5686 * @gfp: context flags
5688 * This function is called whenever a management frame was requested to be
5689 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
5690 * transmission attempt.
5692 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
5693 const u8 *buf, size_t len, bool ack, gfp_t gfp);
5697 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
5698 * @dev: network device
5699 * @rssi_event: the triggered RSSI event
5700 * @rssi_level: new RSSI level value or 0 if not available
5701 * @gfp: context flags
5703 * This function is called when a configured connection quality monitoring
5704 * rssi threshold reached event occurs.
5706 void cfg80211_cqm_rssi_notify(struct net_device *dev,
5707 enum nl80211_cqm_rssi_threshold_event rssi_event,
5708 s32 rssi_level, gfp_t gfp);
5711 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
5712 * @dev: network device
5713 * @peer: peer's MAC address
5714 * @num_packets: how many packets were lost -- should be a fixed threshold
5715 * but probably no less than maybe 50, or maybe a throughput dependent
5716 * threshold (to account for temporary interference)
5717 * @gfp: context flags
5719 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
5720 const u8 *peer, u32 num_packets, gfp_t gfp);
5723 * cfg80211_cqm_txe_notify - TX error rate event
5724 * @dev: network device
5725 * @peer: peer's MAC address
5726 * @num_packets: how many packets were lost
5727 * @rate: % of packets which failed transmission
5728 * @intvl: interval (in s) over which the TX failure threshold was breached.
5729 * @gfp: context flags
5731 * Notify userspace when configured % TX failures over number of packets in a
5732 * given interval is exceeded.
5734 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
5735 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
5738 * cfg80211_cqm_beacon_loss_notify - beacon loss event
5739 * @dev: network device
5740 * @gfp: context flags
5742 * Notify userspace about beacon loss from the connected AP.
5744 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
5747 * cfg80211_radar_event - radar detection event
5749 * @chandef: chandef for the current channel
5750 * @gfp: context flags
5752 * This function is called when a radar is detected on the current chanenl.
5754 void cfg80211_radar_event(struct wiphy *wiphy,
5755 struct cfg80211_chan_def *chandef, gfp_t gfp);
5758 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
5759 * @dev: network device
5760 * @mac: MAC address of a station which opmode got modified
5761 * @sta_opmode: station's current opmode value
5762 * @gfp: context flags
5764 * Driver should call this function when station's opmode modified via action
5767 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
5768 struct sta_opmode_info *sta_opmode,
5772 * cfg80211_cac_event - Channel availability check (CAC) event
5773 * @netdev: network device
5774 * @chandef: chandef for the current channel
5775 * @event: type of event
5776 * @gfp: context flags
5778 * This function is called when a Channel availability check (CAC) is finished
5779 * or aborted. This must be called to notify the completion of a CAC process,
5780 * also by full-MAC drivers.
5782 void cfg80211_cac_event(struct net_device *netdev,
5783 const struct cfg80211_chan_def *chandef,
5784 enum nl80211_radar_event event, gfp_t gfp);
5788 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5789 * @dev: network device
5790 * @bssid: BSSID of AP (to avoid races)
5791 * @replay_ctr: new replay counter
5792 * @gfp: allocation flags
5794 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
5795 const u8 *replay_ctr, gfp_t gfp);
5798 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5799 * @dev: network device
5800 * @index: candidate index (the smaller the index, the higher the priority)
5801 * @bssid: BSSID of AP
5802 * @preauth: Whether AP advertises support for RSN pre-authentication
5803 * @gfp: allocation flags
5805 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
5806 const u8 *bssid, bool preauth, gfp_t gfp);
5809 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5810 * @dev: The device the frame matched to
5811 * @addr: the transmitter address
5812 * @gfp: context flags
5814 * This function is used in AP mode (only!) to inform userspace that
5815 * a spurious class 3 frame was received, to be able to deauth the
5817 * Return: %true if the frame was passed to userspace (or this failed
5818 * for a reason other than not having a subscription.)
5820 bool cfg80211_rx_spurious_frame(struct net_device *dev,
5821 const u8 *addr, gfp_t gfp);
5824 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5825 * @dev: The device the frame matched to
5826 * @addr: the transmitter address
5827 * @gfp: context flags
5829 * This function is used in AP mode (only!) to inform userspace that
5830 * an associated station sent a 4addr frame but that wasn't expected.
5831 * It is allowed and desirable to send this event only once for each
5832 * station to avoid event flooding.
5833 * Return: %true if the frame was passed to userspace (or this failed
5834 * for a reason other than not having a subscription.)
5836 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
5837 const u8 *addr, gfp_t gfp);
5840 * cfg80211_probe_status - notify userspace about probe status
5841 * @dev: the device the probe was sent on
5842 * @addr: the address of the peer
5843 * @cookie: the cookie filled in @probe_client previously
5844 * @acked: indicates whether probe was acked or not
5845 * @ack_signal: signal strength (in dBm) of the ACK frame.
5846 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
5847 * @gfp: allocation flags
5849 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
5850 u64 cookie, bool acked, s32 ack_signal,
5851 bool is_valid_ack_signal, gfp_t gfp);
5854 * cfg80211_report_obss_beacon - report beacon from other APs
5855 * @wiphy: The wiphy that received the beacon
5857 * @len: length of the frame
5858 * @freq: frequency the frame was received on
5859 * @sig_dbm: signal strength in dBm, or 0 if unknown
5861 * Use this function to report to userspace when a beacon was
5862 * received. It is not useful to call this when there is no
5863 * netdev that is in AP/GO mode.
5865 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
5866 const u8 *frame, size_t len,
5867 int freq, int sig_dbm);
5870 * cfg80211_reg_can_beacon - check if beaconing is allowed
5872 * @chandef: the channel definition
5873 * @iftype: interface type
5875 * Return: %true if there is no secondary channel or the secondary channel(s)
5876 * can be used for beaconing (i.e. is not a radar channel etc.)
5878 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
5879 struct cfg80211_chan_def *chandef,
5880 enum nl80211_iftype iftype);
5883 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
5885 * @chandef: the channel definition
5886 * @iftype: interface type
5888 * Return: %true if there is no secondary channel or the secondary channel(s)
5889 * can be used for beaconing (i.e. is not a radar channel etc.). This version
5890 * also checks if IR-relaxation conditions apply, to allow beaconing under
5891 * more permissive conditions.
5893 * Requires the RTNL to be held.
5895 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
5896 struct cfg80211_chan_def *chandef,
5897 enum nl80211_iftype iftype);
5900 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5901 * @dev: the device which switched channels
5902 * @chandef: the new channel definition
5904 * Caller must acquire wdev_lock, therefore must only be called from sleepable
5907 void cfg80211_ch_switch_notify(struct net_device *dev,
5908 struct cfg80211_chan_def *chandef);
5911 * cfg80211_ch_switch_started_notify - notify channel switch start
5912 * @dev: the device on which the channel switch started
5913 * @chandef: the future channel definition
5914 * @count: the number of TBTTs until the channel switch happens
5916 * Inform the userspace about the channel switch that has just
5917 * started, so that it can take appropriate actions (eg. starting
5918 * channel switch on other vifs), if necessary.
5920 void cfg80211_ch_switch_started_notify(struct net_device *dev,
5921 struct cfg80211_chan_def *chandef,
5925 * ieee80211_operating_class_to_band - convert operating class to band
5927 * @operating_class: the operating class to convert
5928 * @band: band pointer to fill
5930 * Returns %true if the conversion was successful, %false otherwise.
5932 bool ieee80211_operating_class_to_band(u8 operating_class,
5933 enum nl80211_band *band);
5936 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5938 * @chandef: the chandef to convert
5939 * @op_class: a pointer to the resulting operating class
5941 * Returns %true if the conversion was successful, %false otherwise.
5943 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5947 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5948 * @dev: the device on which the operation is requested
5949 * @peer: the MAC address of the peer device
5950 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5951 * NL80211_TDLS_TEARDOWN)
5952 * @reason_code: the reason code for teardown request
5953 * @gfp: allocation flags
5955 * This function is used to request userspace to perform TDLS operation that
5956 * requires knowledge of keys, i.e., link setup or teardown when the AP
5957 * connection uses encryption. This is optional mechanism for the driver to use
5958 * if it can automatically determine when a TDLS link could be useful (e.g.,
5959 * based on traffic and signal strength for a peer).
5961 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5962 enum nl80211_tdls_operation oper,
5963 u16 reason_code, gfp_t gfp);
5966 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5967 * @rate: given rate_info to calculate bitrate from
5969 * return 0 if MCS index >= 32
5971 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5974 * cfg80211_unregister_wdev - remove the given wdev
5975 * @wdev: struct wireless_dev to remove
5977 * Call this function only for wdevs that have no netdev assigned,
5978 * e.g. P2P Devices. It removes the device from the list so that
5979 * it can no longer be used. It is necessary to call this function
5980 * even when cfg80211 requests the removal of the interface by
5981 * calling the del_virtual_intf() callback. The function must also
5982 * be called when the driver wishes to unregister the wdev, e.g.
5983 * when the device is unbound from the driver.
5985 * Requires the RTNL to be held.
5987 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5990 * struct cfg80211_ft_event - FT Information Elements
5992 * @ies_len: length of the FT IE in bytes
5993 * @target_ap: target AP's MAC address
5995 * @ric_ies_len: length of the RIC IE in bytes
5997 struct cfg80211_ft_event_params {
6000 const u8 *target_ap;
6006 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
6007 * @netdev: network device
6008 * @ft_event: IE information
6010 void cfg80211_ft_event(struct net_device *netdev,
6011 struct cfg80211_ft_event_params *ft_event);
6014 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
6015 * @ies: the input IE buffer
6016 * @len: the input length
6017 * @attr: the attribute ID to find
6018 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
6019 * if the function is only called to get the needed buffer size
6020 * @bufsize: size of the output buffer
6022 * The function finds a given P2P attribute in the (vendor) IEs and
6023 * copies its contents to the given buffer.
6025 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
6026 * malformed or the attribute can't be found (respectively), or the
6027 * length of the found attribute (which can be zero).
6029 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
6030 enum ieee80211_p2p_attr_id attr,
6031 u8 *buf, unsigned int bufsize);
6034 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
6035 * @ies: the IE buffer
6036 * @ielen: the length of the IE buffer
6037 * @ids: an array with element IDs that are allowed before
6038 * the split. A WLAN_EID_EXTENSION value means that the next
6039 * EID in the list is a sub-element of the EXTENSION IE.
6040 * @n_ids: the size of the element ID array
6041 * @after_ric: array IE types that come after the RIC element
6042 * @n_after_ric: size of the @after_ric array
6043 * @offset: offset where to start splitting in the buffer
6045 * This function splits an IE buffer by updating the @offset
6046 * variable to point to the location where the buffer should be
6049 * It assumes that the given IE buffer is well-formed, this
6050 * has to be guaranteed by the caller!
6052 * It also assumes that the IEs in the buffer are ordered
6053 * correctly, if not the result of using this function will not
6054 * be ordered correctly either, i.e. it does no reordering.
6056 * The function returns the offset where the next part of the
6057 * buffer starts, which may be @ielen if the entire (remainder)
6058 * of the buffer should be used.
6060 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
6061 const u8 *ids, int n_ids,
6062 const u8 *after_ric, int n_after_ric,
6066 * ieee80211_ie_split - split an IE buffer according to ordering
6067 * @ies: the IE buffer
6068 * @ielen: the length of the IE buffer
6069 * @ids: an array with element IDs that are allowed before
6070 * the split. A WLAN_EID_EXTENSION value means that the next
6071 * EID in the list is a sub-element of the EXTENSION IE.
6072 * @n_ids: the size of the element ID array
6073 * @offset: offset where to start splitting in the buffer
6075 * This function splits an IE buffer by updating the @offset
6076 * variable to point to the location where the buffer should be
6079 * It assumes that the given IE buffer is well-formed, this
6080 * has to be guaranteed by the caller!
6082 * It also assumes that the IEs in the buffer are ordered
6083 * correctly, if not the result of using this function will not
6084 * be ordered correctly either, i.e. it does no reordering.
6086 * The function returns the offset where the next part of the
6087 * buffer starts, which may be @ielen if the entire (remainder)
6088 * of the buffer should be used.
6090 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
6091 const u8 *ids, int n_ids, size_t offset)
6093 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
6097 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
6098 * @wdev: the wireless device reporting the wakeup
6099 * @wakeup: the wakeup report
6100 * @gfp: allocation flags
6102 * This function reports that the given device woke up. If it
6103 * caused the wakeup, report the reason(s), otherwise you may
6104 * pass %NULL as the @wakeup parameter to advertise that something
6105 * else caused the wakeup.
6107 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
6108 struct cfg80211_wowlan_wakeup *wakeup,
6112 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
6114 * @wdev: the wireless device for which critical protocol is stopped.
6115 * @gfp: allocation flags
6117 * This function can be called by the driver to indicate it has reverted
6118 * operation back to normal. One reason could be that the duration given
6119 * by .crit_proto_start() has expired.
6121 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
6124 * ieee80211_get_num_supported_channels - get number of channels device has
6127 * Return: the number of channels supported by the device.
6129 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
6132 * cfg80211_check_combinations - check interface combinations
6135 * @params: the interface combinations parameter
6137 * This function can be called by the driver to check whether a
6138 * combination of interfaces and their types are allowed according to
6139 * the interface combinations.
6141 int cfg80211_check_combinations(struct wiphy *wiphy,
6142 struct iface_combination_params *params);
6145 * cfg80211_iter_combinations - iterate over matching combinations
6148 * @params: the interface combinations parameter
6149 * @iter: function to call for each matching combination
6150 * @data: pointer to pass to iter function
6152 * This function can be called by the driver to check what possible
6153 * combinations it fits in at a given moment, e.g. for channel switching
6156 int cfg80211_iter_combinations(struct wiphy *wiphy,
6157 struct iface_combination_params *params,
6158 void (*iter)(const struct ieee80211_iface_combination *c,
6163 * cfg80211_stop_iface - trigger interface disconnection
6166 * @wdev: wireless device
6167 * @gfp: context flags
6169 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
6172 * Note: This doesn't need any locks and is asynchronous.
6174 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
6178 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
6179 * @wiphy: the wiphy to shut down
6181 * This function shuts down all interfaces belonging to this wiphy by
6182 * calling dev_close() (and treating non-netdev interfaces as needed).
6183 * It shouldn't really be used unless there are some fatal device errors
6184 * that really can't be recovered in any other way.
6186 * Callers must hold the RTNL and be able to deal with callbacks into
6187 * the driver while the function is running.
6189 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
6192 * wiphy_ext_feature_set - set the extended feature flag
6194 * @wiphy: the wiphy to modify.
6195 * @ftidx: extended feature bit index.
6197 * The extended features are flagged in multiple bytes (see
6198 * &struct wiphy.@ext_features)
6200 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
6201 enum nl80211_ext_feature_index ftidx)
6205 ft_byte = &wiphy->ext_features[ftidx / 8];
6206 *ft_byte |= BIT(ftidx % 8);
6210 * wiphy_ext_feature_isset - check the extended feature flag
6212 * @wiphy: the wiphy to modify.
6213 * @ftidx: extended feature bit index.
6215 * The extended features are flagged in multiple bytes (see
6216 * &struct wiphy.@ext_features)
6219 wiphy_ext_feature_isset(struct wiphy *wiphy,
6220 enum nl80211_ext_feature_index ftidx)
6224 ft_byte = wiphy->ext_features[ftidx / 8];
6225 return (ft_byte & BIT(ftidx % 8)) != 0;
6229 * cfg80211_free_nan_func - free NAN function
6230 * @f: NAN function that should be freed
6232 * Frees all the NAN function and all it's allocated members.
6234 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
6237 * struct cfg80211_nan_match_params - NAN match parameters
6238 * @type: the type of the function that triggered a match. If it is
6239 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
6240 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
6242 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
6243 * @inst_id: the local instance id
6244 * @peer_inst_id: the instance id of the peer's function
6245 * @addr: the MAC address of the peer
6246 * @info_len: the length of the &info
6247 * @info: the Service Specific Info from the peer (if any)
6248 * @cookie: unique identifier of the corresponding function
6250 struct cfg80211_nan_match_params {
6251 enum nl80211_nan_function_type type;
6261 * cfg80211_nan_match - report a match for a NAN function.
6262 * @wdev: the wireless device reporting the match
6263 * @match: match notification parameters
6264 * @gfp: allocation flags
6266 * This function reports that the a NAN function had a match. This
6267 * can be a subscribe that had a match or a solicited publish that
6268 * was sent. It can also be a follow up that was received.
6270 void cfg80211_nan_match(struct wireless_dev *wdev,
6271 struct cfg80211_nan_match_params *match, gfp_t gfp);
6274 * cfg80211_nan_func_terminated - notify about NAN function termination.
6276 * @wdev: the wireless device reporting the match
6277 * @inst_id: the local instance id
6278 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6279 * @cookie: unique NAN function identifier
6280 * @gfp: allocation flags
6282 * This function reports that the a NAN function is terminated.
6284 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
6286 enum nl80211_nan_func_term_reason reason,
6287 u64 cookie, gfp_t gfp);
6289 /* ethtool helper */
6290 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
6293 * cfg80211_external_auth_request - userspace request for authentication
6294 * @netdev: network device
6295 * @params: External authentication parameters
6296 * @gfp: allocation flags
6297 * Returns: 0 on success, < 0 on error
6299 int cfg80211_external_auth_request(struct net_device *netdev,
6300 struct cfg80211_external_auth_params *params,
6303 /* Logging, debugging and troubleshooting/diagnostic helpers. */
6305 /* wiphy_printk helpers, similar to dev_printk */
6307 #define wiphy_printk(level, wiphy, format, args...) \
6308 dev_printk(level, &(wiphy)->dev, format, ##args)
6309 #define wiphy_emerg(wiphy, format, args...) \
6310 dev_emerg(&(wiphy)->dev, format, ##args)
6311 #define wiphy_alert(wiphy, format, args...) \
6312 dev_alert(&(wiphy)->dev, format, ##args)
6313 #define wiphy_crit(wiphy, format, args...) \
6314 dev_crit(&(wiphy)->dev, format, ##args)
6315 #define wiphy_err(wiphy, format, args...) \
6316 dev_err(&(wiphy)->dev, format, ##args)
6317 #define wiphy_warn(wiphy, format, args...) \
6318 dev_warn(&(wiphy)->dev, format, ##args)
6319 #define wiphy_notice(wiphy, format, args...) \
6320 dev_notice(&(wiphy)->dev, format, ##args)
6321 #define wiphy_info(wiphy, format, args...) \
6322 dev_info(&(wiphy)->dev, format, ##args)
6324 #define wiphy_debug(wiphy, format, args...) \
6325 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
6327 #define wiphy_dbg(wiphy, format, args...) \
6328 dev_dbg(&(wiphy)->dev, format, ##args)
6330 #if defined(VERBOSE_DEBUG)
6331 #define wiphy_vdbg wiphy_dbg
6333 #define wiphy_vdbg(wiphy, format, args...) \
6336 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
6342 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
6343 * of using a WARN/WARN_ON to get the message out, including the
6344 * file/line information and a backtrace.
6346 #define wiphy_WARN(wiphy, format, args...) \
6347 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
6349 #endif /* __NET_CFG80211_H */