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 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 * Wireless hardware/device configuration structures and methods
319 * DOC: Actions and configuration
321 * Each wireless device and each virtual interface offer a set of configuration
322 * operations and other actions that are invoked by userspace. Each of these
323 * actions is described in the operations structure, and the parameters these
324 * operations use are described separately.
326 * Additionally, some operations are asynchronous and expect to get status
327 * information via some functions that drivers need to call.
329 * Scanning and BSS list handling with its associated functionality is described
330 * in a separate chapter.
333 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
334 WLAN_USER_POSITION_LEN)
337 * struct vif_params - describes virtual interface parameters
338 * @use_4addr: use 4-address frames
339 * @macaddr: address to use for this virtual interface.
340 * If this parameter is set to zero address the driver may
341 * determine the address as needed.
342 * This feature is only fully supported by drivers that enable the
343 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
344 ** only p2p devices with specified MAC.
345 * @vht_mumimo_groups: MU-MIMO groupID. used for monitoring only
346 * packets belonging to that MU-MIMO groupID.
350 u8 macaddr[ETH_ALEN];
351 u8 vht_mumimo_groups[VHT_MUMIMO_GROUPS_DATA_LEN];
355 * struct key_params - key information
357 * Information about a key
360 * @key_len: length of key material
361 * @cipher: cipher suite selector
362 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
363 * with the get_key() callback, must be in little endian,
364 * length given by @seq_len.
365 * @seq_len: length of @seq.
376 * struct cfg80211_chan_def - channel definition
377 * @chan: the (control) channel
378 * @width: channel width
379 * @center_freq1: center frequency of first segment
380 * @center_freq2: center frequency of second segment
381 * (only with 80+80 MHz)
383 struct cfg80211_chan_def {
384 struct ieee80211_channel *chan;
385 enum nl80211_chan_width width;
391 * cfg80211_get_chandef_type - return old channel type from chandef
392 * @chandef: the channel definition
394 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
395 * chandef, which must have a bandwidth allowing this conversion.
397 static inline enum nl80211_channel_type
398 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
400 switch (chandef->width) {
401 case NL80211_CHAN_WIDTH_20_NOHT:
402 return NL80211_CHAN_NO_HT;
403 case NL80211_CHAN_WIDTH_20:
404 return NL80211_CHAN_HT20;
405 case NL80211_CHAN_WIDTH_40:
406 if (chandef->center_freq1 > chandef->chan->center_freq)
407 return NL80211_CHAN_HT40PLUS;
408 return NL80211_CHAN_HT40MINUS;
411 return NL80211_CHAN_NO_HT;
416 * cfg80211_chandef_create - create channel definition using channel type
417 * @chandef: the channel definition struct to fill
418 * @channel: the control channel
419 * @chantype: the channel type
421 * Given a channel type, create a channel definition.
423 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
424 struct ieee80211_channel *channel,
425 enum nl80211_channel_type chantype);
428 * cfg80211_chandef_identical - check if two channel definitions are identical
429 * @chandef1: first channel definition
430 * @chandef2: second channel definition
432 * Return: %true if the channels defined by the channel definitions are
433 * identical, %false otherwise.
436 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
437 const struct cfg80211_chan_def *chandef2)
439 return (chandef1->chan == chandef2->chan &&
440 chandef1->width == chandef2->width &&
441 chandef1->center_freq1 == chandef2->center_freq1 &&
442 chandef1->center_freq2 == chandef2->center_freq2);
446 * cfg80211_chandef_compatible - check if two channel definitions are compatible
447 * @chandef1: first channel definition
448 * @chandef2: second channel definition
450 * Return: %NULL if the given channel definitions are incompatible,
451 * chandef1 or chandef2 otherwise.
453 const struct cfg80211_chan_def *
454 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
455 const struct cfg80211_chan_def *chandef2);
458 * cfg80211_chandef_valid - check if a channel definition is valid
459 * @chandef: the channel definition to check
460 * Return: %true if the channel definition is valid. %false otherwise.
462 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
465 * cfg80211_chandef_usable - check if secondary channels can be used
466 * @wiphy: the wiphy to validate against
467 * @chandef: the channel definition to check
468 * @prohibited_flags: the regulatory channel flags that must not be set
469 * Return: %true if secondary channels are usable. %false otherwise.
471 bool cfg80211_chandef_usable(struct wiphy *wiphy,
472 const struct cfg80211_chan_def *chandef,
473 u32 prohibited_flags);
476 * cfg80211_chandef_dfs_required - checks if radar detection is required
477 * @wiphy: the wiphy to validate against
478 * @chandef: the channel definition to check
479 * @iftype: the interface type as specified in &enum nl80211_iftype
481 * 1 if radar detection is required, 0 if it is not, < 0 on error
483 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
484 const struct cfg80211_chan_def *chandef,
485 enum nl80211_iftype iftype);
488 * ieee80211_chandef_rate_flags - returns rate flags for a channel
490 * In some channel types, not all rates may be used - for example CCK
491 * rates may not be used in 5/10 MHz channels.
493 * @chandef: channel definition for the channel
495 * Returns: rate flags which apply for this channel
497 static inline enum ieee80211_rate_flags
498 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
500 switch (chandef->width) {
501 case NL80211_CHAN_WIDTH_5:
502 return IEEE80211_RATE_SUPPORTS_5MHZ;
503 case NL80211_CHAN_WIDTH_10:
504 return IEEE80211_RATE_SUPPORTS_10MHZ;
512 * ieee80211_chandef_max_power - maximum transmission power for the chandef
514 * In some regulations, the transmit power may depend on the configured channel
515 * bandwidth which may be defined as dBm/MHz. This function returns the actual
516 * max_power for non-standard (20 MHz) channels.
518 * @chandef: channel definition for the channel
520 * Returns: maximum allowed transmission power in dBm for the chandef
523 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
525 switch (chandef->width) {
526 case NL80211_CHAN_WIDTH_5:
527 return min(chandef->chan->max_reg_power - 6,
528 chandef->chan->max_power);
529 case NL80211_CHAN_WIDTH_10:
530 return min(chandef->chan->max_reg_power - 3,
531 chandef->chan->max_power);
535 return chandef->chan->max_power;
539 * enum survey_info_flags - survey information flags
541 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
542 * @SURVEY_INFO_IN_USE: channel is currently being used
543 * @SURVEY_INFO_TIME: active time (in ms) was filled in
544 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
545 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
546 * @SURVEY_INFO_TIME_RX: receive time was filled in
547 * @SURVEY_INFO_TIME_TX: transmit time was filled in
548 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
550 * Used by the driver to indicate which info in &struct survey_info
551 * it has filled in during the get_survey().
553 enum survey_info_flags {
554 SURVEY_INFO_NOISE_DBM = BIT(0),
555 SURVEY_INFO_IN_USE = BIT(1),
556 SURVEY_INFO_TIME = BIT(2),
557 SURVEY_INFO_TIME_BUSY = BIT(3),
558 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
559 SURVEY_INFO_TIME_RX = BIT(5),
560 SURVEY_INFO_TIME_TX = BIT(6),
561 SURVEY_INFO_TIME_SCAN = BIT(7),
565 * struct survey_info - channel survey response
567 * @channel: the channel this survey record reports, may be %NULL for a single
568 * record to report global statistics
569 * @filled: bitflag of flags from &enum survey_info_flags
570 * @noise: channel noise in dBm. This and all following fields are
572 * @time: amount of time in ms the radio was turn on (on the channel)
573 * @time_busy: amount of time the primary channel was sensed busy
574 * @time_ext_busy: amount of time the extension channel was sensed busy
575 * @time_rx: amount of time the radio spent receiving data
576 * @time_tx: amount of time the radio spent transmitting data
577 * @time_scan: amount of time the radio spent for scanning
579 * Used by dump_survey() to report back per-channel survey information.
581 * This structure can later be expanded with things like
582 * channel duty cycle etc.
585 struct ieee80211_channel *channel;
597 * struct cfg80211_crypto_settings - Crypto settings
598 * @wpa_versions: indicates which, if any, WPA versions are enabled
599 * (from enum nl80211_wpa_versions)
600 * @cipher_group: group key cipher suite (or 0 if unset)
601 * @n_ciphers_pairwise: number of AP supported unicast ciphers
602 * @ciphers_pairwise: unicast key cipher suites
603 * @n_akm_suites: number of AKM suites
604 * @akm_suites: AKM suites
605 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
606 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
607 * required to assume that the port is unauthorized until authorized by
608 * user space. Otherwise, port is marked authorized by default.
609 * @control_port_ethertype: the control port protocol that should be
610 * allowed through even on unauthorized ports
611 * @control_port_no_encrypt: TRUE to prevent encryption of control port
614 struct cfg80211_crypto_settings {
617 int n_ciphers_pairwise;
618 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
620 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
622 __be16 control_port_ethertype;
623 bool control_port_no_encrypt;
627 * struct cfg80211_beacon_data - beacon data
628 * @head: head portion of beacon (before TIM IE)
629 * or %NULL if not changed
630 * @tail: tail portion of beacon (after TIM IE)
631 * or %NULL if not changed
632 * @head_len: length of @head
633 * @tail_len: length of @tail
634 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
635 * @beacon_ies_len: length of beacon_ies in octets
636 * @proberesp_ies: extra information element(s) to add into Probe Response
638 * @proberesp_ies_len: length of proberesp_ies in octets
639 * @assocresp_ies: extra information element(s) to add into (Re)Association
640 * Response frames or %NULL
641 * @assocresp_ies_len: length of assocresp_ies in octets
642 * @probe_resp_len: length of probe response template (@probe_resp)
643 * @probe_resp: probe response template (AP mode only)
645 struct cfg80211_beacon_data {
646 const u8 *head, *tail;
647 const u8 *beacon_ies;
648 const u8 *proberesp_ies;
649 const u8 *assocresp_ies;
650 const u8 *probe_resp;
652 size_t head_len, tail_len;
653 size_t beacon_ies_len;
654 size_t proberesp_ies_len;
655 size_t assocresp_ies_len;
656 size_t probe_resp_len;
664 * struct cfg80211_acl_data - Access control list data
666 * @acl_policy: ACL policy to be applied on the station's
667 * entry specified by mac_addr
668 * @n_acl_entries: Number of MAC address entries passed
669 * @mac_addrs: List of MAC addresses of stations to be used for ACL
671 struct cfg80211_acl_data {
672 enum nl80211_acl_policy acl_policy;
676 struct mac_address mac_addrs[];
680 * cfg80211_bitrate_mask - masks for bitrate control
682 struct cfg80211_bitrate_mask {
685 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
686 u16 vht_mcs[NL80211_VHT_NSS_MAX];
687 enum nl80211_txrate_gi gi;
688 } control[NUM_NL80211_BANDS];
692 * struct cfg80211_ap_settings - AP configuration
694 * Used to configure an AP interface.
696 * @chandef: defines the channel to use
697 * @beacon: beacon data
698 * @beacon_interval: beacon interval
699 * @dtim_period: DTIM period
700 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
702 * @ssid_len: length of @ssid
703 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
704 * @crypto: crypto settings
705 * @privacy: the BSS uses privacy
706 * @auth_type: Authentication type (algorithm)
707 * @smps_mode: SMPS mode
708 * @inactivity_timeout: time in seconds to determine station's inactivity.
709 * @p2p_ctwindow: P2P CT Window
710 * @p2p_opp_ps: P2P opportunistic PS
711 * @acl: ACL configuration used by the drivers which has support for
712 * MAC address based access control
713 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
715 * @beacon_rate: bitrate to be used for beacons
717 struct cfg80211_ap_settings {
718 struct cfg80211_chan_def chandef;
720 struct cfg80211_beacon_data beacon;
722 int beacon_interval, dtim_period;
725 enum nl80211_hidden_ssid hidden_ssid;
726 struct cfg80211_crypto_settings crypto;
728 enum nl80211_auth_type auth_type;
729 enum nl80211_smps_mode smps_mode;
730 int inactivity_timeout;
733 const struct cfg80211_acl_data *acl;
735 struct cfg80211_bitrate_mask beacon_rate;
739 * struct cfg80211_csa_settings - channel switch settings
741 * Used for channel switch
743 * @chandef: defines the channel to use after the switch
744 * @beacon_csa: beacon data while performing the switch
745 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
746 * @counter_offsets_presp: offsets of the counters within the probe response
747 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
748 * @n_counter_offsets_presp: number of csa counters in the probe response
749 * @beacon_after: beacon data to be used on the new channel
750 * @radar_required: whether radar detection is required on the new channel
751 * @block_tx: whether transmissions should be blocked while changing
752 * @count: number of beacons until switch
754 struct cfg80211_csa_settings {
755 struct cfg80211_chan_def chandef;
756 struct cfg80211_beacon_data beacon_csa;
757 const u16 *counter_offsets_beacon;
758 const u16 *counter_offsets_presp;
759 unsigned int n_counter_offsets_beacon;
760 unsigned int n_counter_offsets_presp;
761 struct cfg80211_beacon_data beacon_after;
768 * enum station_parameters_apply_mask - station parameter values to apply
769 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
770 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
771 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
773 * Not all station parameters have in-band "no change" signalling,
774 * for those that don't these flags will are used.
776 enum station_parameters_apply_mask {
777 STATION_PARAM_APPLY_UAPSD = BIT(0),
778 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
779 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
783 * struct station_parameters - station parameters
785 * Used to change and create a new station.
787 * @vlan: vlan interface station should belong to
788 * @supported_rates: supported rates in IEEE 802.11 format
789 * (or NULL for no change)
790 * @supported_rates_len: number of supported rates
791 * @sta_flags_mask: station flags that changed
792 * (bitmask of BIT(NL80211_STA_FLAG_...))
793 * @sta_flags_set: station flags values
794 * (bitmask of BIT(NL80211_STA_FLAG_...))
795 * @listen_interval: listen interval or -1 for no change
796 * @aid: AID or zero for no change
797 * @peer_aid: mesh peer AID or zero for no change
798 * @plink_action: plink action to take
799 * @plink_state: set the peer link state for a station
800 * @ht_capa: HT capabilities of station
801 * @vht_capa: VHT capabilities of station
802 * @uapsd_queues: bitmap of queues configured for uapsd. same format
803 * as the AC bitmap in the QoS info field
804 * @max_sp: max Service Period. same format as the MAX_SP in the
805 * QoS info field (but already shifted down)
806 * @sta_modify_mask: bitmap indicating which parameters changed
807 * (for those that don't have a natural "no change" value),
808 * see &enum station_parameters_apply_mask
809 * @local_pm: local link-specific mesh power save mode (no change when set
811 * @capability: station capability
812 * @ext_capab: extended capabilities of the station
813 * @ext_capab_len: number of extended capabilities
814 * @supported_channels: supported channels in IEEE 802.11 format
815 * @supported_channels_len: number of supported channels
816 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
817 * @supported_oper_classes_len: number of supported operating classes
818 * @opmode_notif: operating mode field from Operating Mode Notification
819 * @opmode_notif_used: information if operating mode field is used
820 * @support_p2p_ps: information if station supports P2P PS mechanism
822 struct station_parameters {
823 const u8 *supported_rates;
824 struct net_device *vlan;
825 u32 sta_flags_mask, sta_flags_set;
830 u8 supported_rates_len;
833 const struct ieee80211_ht_cap *ht_capa;
834 const struct ieee80211_vht_cap *vht_capa;
837 enum nl80211_mesh_power_mode local_pm;
841 const u8 *supported_channels;
842 u8 supported_channels_len;
843 const u8 *supported_oper_classes;
844 u8 supported_oper_classes_len;
846 bool opmode_notif_used;
851 * struct station_del_parameters - station deletion parameters
853 * Used to delete a station entry (or all stations).
855 * @mac: MAC address of the station to remove or NULL to remove all stations
856 * @subtype: Management frame subtype to use for indicating removal
857 * (10 = Disassociation, 12 = Deauthentication)
858 * @reason_code: Reason code for the Disassociation/Deauthentication frame
860 struct station_del_parameters {
867 * enum cfg80211_station_type - the type of station being modified
868 * @CFG80211_STA_AP_CLIENT: client of an AP interface
869 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
870 * unassociated (update properties for this type of client is permitted)
871 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
872 * the AP MLME in the device
873 * @CFG80211_STA_AP_STA: AP station on managed interface
874 * @CFG80211_STA_IBSS: IBSS station
875 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
876 * while TDLS setup is in progress, it moves out of this state when
877 * being marked authorized; use this only if TDLS with external setup is
879 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
880 * entry that is operating, has been marked authorized by userspace)
881 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
882 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
884 enum cfg80211_station_type {
885 CFG80211_STA_AP_CLIENT,
886 CFG80211_STA_AP_CLIENT_UNASSOC,
887 CFG80211_STA_AP_MLME_CLIENT,
890 CFG80211_STA_TDLS_PEER_SETUP,
891 CFG80211_STA_TDLS_PEER_ACTIVE,
892 CFG80211_STA_MESH_PEER_KERNEL,
893 CFG80211_STA_MESH_PEER_USER,
897 * cfg80211_check_station_change - validate parameter changes
898 * @wiphy: the wiphy this operates on
899 * @params: the new parameters for a station
900 * @statype: the type of station being modified
902 * Utility function for the @change_station driver method. Call this function
903 * with the appropriate station type looking up the station (and checking that
904 * it exists). It will verify whether the station change is acceptable, and if
905 * not will return an error code. Note that it may modify the parameters for
906 * backward compatibility reasons, so don't use them before calling this.
908 int cfg80211_check_station_change(struct wiphy *wiphy,
909 struct station_parameters *params,
910 enum cfg80211_station_type statype);
913 * enum station_info_rate_flags - bitrate info flags
915 * Used by the driver to indicate the specific rate transmission
916 * type for 802.11n transmissions.
918 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
919 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
920 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
921 * @RATE_INFO_FLAGS_60G: 60GHz MCS
923 enum rate_info_flags {
924 RATE_INFO_FLAGS_MCS = BIT(0),
925 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
926 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
927 RATE_INFO_FLAGS_60G = BIT(3),
931 * enum rate_info_bw - rate bandwidth information
933 * Used by the driver to indicate the rate bandwidth.
935 * @RATE_INFO_BW_5: 5 MHz bandwidth
936 * @RATE_INFO_BW_10: 10 MHz bandwidth
937 * @RATE_INFO_BW_20: 20 MHz bandwidth
938 * @RATE_INFO_BW_40: 40 MHz bandwidth
939 * @RATE_INFO_BW_80: 80 MHz bandwidth
940 * @RATE_INFO_BW_160: 160 MHz bandwidth
952 * struct rate_info - bitrate information
954 * Information about a receiving or transmitting bitrate
956 * @flags: bitflag of flags from &enum rate_info_flags
957 * @mcs: mcs index if struct describes a 802.11n bitrate
958 * @legacy: bitrate in 100kbit/s for 802.11abg
959 * @nss: number of streams (VHT only)
960 * @bw: bandwidth (from &enum rate_info_bw)
971 * enum station_info_rate_flags - bitrate info flags
973 * Used by the driver to indicate the specific rate transmission
974 * type for 802.11n transmissions.
976 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
977 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
978 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
980 enum bss_param_flags {
981 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
982 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
983 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
987 * struct sta_bss_parameters - BSS parameters for the attached station
989 * Information about the currently associated BSS
991 * @flags: bitflag of flags from &enum bss_param_flags
992 * @dtim_period: DTIM period for the BSS
993 * @beacon_interval: beacon interval
995 struct sta_bss_parameters {
1002 * struct cfg80211_tid_stats - per-TID statistics
1003 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1004 * indicate the relevant values in this struct are filled
1005 * @rx_msdu: number of received MSDUs
1006 * @tx_msdu: number of (attempted) transmitted MSDUs
1007 * @tx_msdu_retries: number of retries (not counting the first) for
1009 * @tx_msdu_failed: number of failed transmitted MSDUs
1011 struct cfg80211_tid_stats {
1015 u64 tx_msdu_retries;
1019 #define IEEE80211_MAX_CHAINS 4
1022 * struct station_info - station information
1024 * Station information filled by driver for get_station() and dump_station.
1026 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1027 * indicate the relevant values in this struct for them
1028 * @connected_time: time(in secs) since a station is last connected
1029 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1030 * @rx_bytes: bytes (size of MPDUs) received from this station
1031 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1032 * @llid: mesh local link id
1033 * @plid: mesh peer link id
1034 * @plink_state: mesh peer link state
1035 * @signal: The signal strength, type depends on the wiphy's signal_type.
1036 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1037 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1038 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1039 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1040 * @chain_signal: per-chain signal strength of last received packet in dBm
1041 * @chain_signal_avg: per-chain signal strength average in dBm
1042 * @txrate: current unicast bitrate from this station
1043 * @rxrate: current unicast bitrate to this station
1044 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1045 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1046 * @tx_retries: cumulative retry counts (MPDUs)
1047 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1048 * @rx_dropped_misc: Dropped for un-specified reason.
1049 * @bss_param: current BSS parameters
1050 * @generation: generation number for nl80211 dumps.
1051 * This number should increase every time the list of stations
1052 * changes, i.e. when a station is added or removed, so that
1053 * userspace can tell whether it got a consistent snapshot.
1054 * @assoc_req_ies: IEs from (Re)Association Request.
1055 * This is used only when in AP mode with drivers that do not use
1056 * user space MLME/SME implementation. The information is provided for
1057 * the cfg80211_new_sta() calls to notify user space of the IEs.
1058 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1059 * @sta_flags: station flags mask & values
1060 * @beacon_loss_count: Number of times beacon loss event has triggered.
1061 * @t_offset: Time offset of the station relative to this host.
1062 * @local_pm: local mesh STA power save mode
1063 * @peer_pm: peer mesh STA power save mode
1064 * @nonpeer_pm: non-peer mesh STA power save mode
1065 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1066 * towards this station.
1067 * @rx_beacon: number of beacons received from this peer
1068 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1070 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1071 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1072 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1074 struct station_info {
1087 s8 chain_signal[IEEE80211_MAX_CHAINS];
1088 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1090 struct rate_info txrate;
1091 struct rate_info rxrate;
1096 u32 rx_dropped_misc;
1097 struct sta_bss_parameters bss_param;
1098 struct nl80211_sta_flag_update sta_flags;
1102 const u8 *assoc_req_ies;
1103 size_t assoc_req_ies_len;
1105 u32 beacon_loss_count;
1107 enum nl80211_mesh_power_mode local_pm;
1108 enum nl80211_mesh_power_mode peer_pm;
1109 enum nl80211_mesh_power_mode nonpeer_pm;
1111 u32 expected_throughput;
1115 u8 rx_beacon_signal_avg;
1116 struct cfg80211_tid_stats pertid[IEEE80211_NUM_TIDS + 1];
1119 #if IS_ENABLED(CONFIG_CFG80211)
1121 * cfg80211_get_station - retrieve information about a given station
1122 * @dev: the device where the station is supposed to be connected to
1123 * @mac_addr: the mac address of the station of interest
1124 * @sinfo: pointer to the structure to fill with the information
1126 * Returns 0 on success and sinfo is filled with the available information
1127 * otherwise returns a negative error code and the content of sinfo has to be
1128 * considered undefined.
1130 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1131 struct station_info *sinfo);
1133 static inline int cfg80211_get_station(struct net_device *dev,
1135 struct station_info *sinfo)
1142 * enum monitor_flags - monitor flags
1144 * Monitor interface configuration flags. Note that these must be the bits
1145 * according to the nl80211 flags.
1147 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1148 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1149 * @MONITOR_FLAG_CONTROL: pass control frames
1150 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1151 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1152 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1154 enum monitor_flags {
1155 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1156 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1157 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1158 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1159 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1160 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1164 * enum mpath_info_flags - mesh path information flags
1166 * Used by the driver to indicate which info in &struct mpath_info it has filled
1167 * in during get_station() or dump_station().
1169 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1170 * @MPATH_INFO_SN: @sn filled
1171 * @MPATH_INFO_METRIC: @metric filled
1172 * @MPATH_INFO_EXPTIME: @exptime filled
1173 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1174 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1175 * @MPATH_INFO_FLAGS: @flags filled
1177 enum mpath_info_flags {
1178 MPATH_INFO_FRAME_QLEN = BIT(0),
1179 MPATH_INFO_SN = BIT(1),
1180 MPATH_INFO_METRIC = BIT(2),
1181 MPATH_INFO_EXPTIME = BIT(3),
1182 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1183 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1184 MPATH_INFO_FLAGS = BIT(6),
1188 * struct mpath_info - mesh path information
1190 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1192 * @filled: bitfield of flags from &enum mpath_info_flags
1193 * @frame_qlen: number of queued frames for this destination
1194 * @sn: target sequence number
1195 * @metric: metric (cost) of this mesh path
1196 * @exptime: expiration time for the mesh path from now, in msecs
1197 * @flags: mesh path flags
1198 * @discovery_timeout: total mesh path discovery timeout, in msecs
1199 * @discovery_retries: mesh path discovery retries
1200 * @generation: generation number for nl80211 dumps.
1201 * This number should increase every time the list of mesh paths
1202 * changes, i.e. when a station is added or removed, so that
1203 * userspace can tell whether it got a consistent snapshot.
1211 u32 discovery_timeout;
1212 u8 discovery_retries;
1219 * struct bss_parameters - BSS parameters
1221 * Used to change BSS parameters (mainly for AP mode).
1223 * @use_cts_prot: Whether to use CTS protection
1224 * (0 = no, 1 = yes, -1 = do not change)
1225 * @use_short_preamble: Whether the use of short preambles is allowed
1226 * (0 = no, 1 = yes, -1 = do not change)
1227 * @use_short_slot_time: Whether the use of short slot time is allowed
1228 * (0 = no, 1 = yes, -1 = do not change)
1229 * @basic_rates: basic rates in IEEE 802.11 format
1230 * (or NULL for no change)
1231 * @basic_rates_len: number of basic rates
1232 * @ap_isolate: do not forward packets between connected stations
1233 * @ht_opmode: HT Operation mode
1234 * (u16 = opmode, -1 = do not change)
1235 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1236 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1238 struct bss_parameters {
1240 int use_short_preamble;
1241 int use_short_slot_time;
1242 const u8 *basic_rates;
1246 s8 p2p_ctwindow, p2p_opp_ps;
1250 * struct mesh_config - 802.11s mesh configuration
1252 * These parameters can be changed while the mesh is active.
1254 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1255 * by the Mesh Peering Open message
1256 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1257 * used by the Mesh Peering Open message
1258 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1259 * the mesh peering management to close a mesh peering
1260 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1262 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1263 * be sent to establish a new peer link instance in a mesh
1264 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1265 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1267 * @auto_open_plinks: whether we should automatically open peer links when we
1268 * detect compatible mesh peers
1269 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1270 * synchronize to for 11s default synchronization method
1271 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1272 * that an originator mesh STA can send to a particular path target
1273 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1274 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1275 * a path discovery in milliseconds
1276 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1277 * receiving a PREQ shall consider the forwarding information from the
1278 * root to be valid. (TU = time unit)
1279 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1280 * which a mesh STA can send only one action frame containing a PREQ
1282 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1283 * which a mesh STA can send only one Action frame containing a PERR
1285 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1286 * it takes for an HWMP information element to propagate across the mesh
1287 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1288 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1289 * announcements are transmitted
1290 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1291 * station has access to a broader network beyond the MBSS. (This is
1292 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1293 * only means that the station will announce others it's a mesh gate, but
1294 * not necessarily using the gate announcement protocol. Still keeping the
1295 * same nomenclature to be in sync with the spec)
1296 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1297 * entity (default is TRUE - forwarding entity)
1298 * @rssi_threshold: the threshold for average signal strength of candidate
1299 * station to establish a peer link
1300 * @ht_opmode: mesh HT protection mode
1302 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1303 * receiving a proactive PREQ shall consider the forwarding information to
1304 * the root mesh STA to be valid.
1306 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1307 * PREQs are transmitted.
1308 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1309 * during which a mesh STA can send only one Action frame containing
1310 * a PREQ element for root path confirmation.
1311 * @power_mode: The default mesh power save mode which will be the initial
1312 * setting for new peer links.
1313 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1314 * after transmitting its beacon.
1315 * @plink_timeout: If no tx activity is seen from a STA we've established
1316 * peering with for longer than this time (in seconds), then remove it
1317 * from the STA's list of peers. Default is 30 minutes.
1319 struct mesh_config {
1320 u16 dot11MeshRetryTimeout;
1321 u16 dot11MeshConfirmTimeout;
1322 u16 dot11MeshHoldingTimeout;
1323 u16 dot11MeshMaxPeerLinks;
1324 u8 dot11MeshMaxRetries;
1327 bool auto_open_plinks;
1328 u32 dot11MeshNbrOffsetMaxNeighbor;
1329 u8 dot11MeshHWMPmaxPREQretries;
1330 u32 path_refresh_time;
1331 u16 min_discovery_timeout;
1332 u32 dot11MeshHWMPactivePathTimeout;
1333 u16 dot11MeshHWMPpreqMinInterval;
1334 u16 dot11MeshHWMPperrMinInterval;
1335 u16 dot11MeshHWMPnetDiameterTraversalTime;
1336 u8 dot11MeshHWMPRootMode;
1337 u16 dot11MeshHWMPRannInterval;
1338 bool dot11MeshGateAnnouncementProtocol;
1339 bool dot11MeshForwarding;
1342 u32 dot11MeshHWMPactivePathToRootTimeout;
1343 u16 dot11MeshHWMProotInterval;
1344 u16 dot11MeshHWMPconfirmationInterval;
1345 enum nl80211_mesh_power_mode power_mode;
1346 u16 dot11MeshAwakeWindowDuration;
1351 * struct mesh_setup - 802.11s mesh setup configuration
1352 * @chandef: defines the channel to use
1353 * @mesh_id: the mesh ID
1354 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1355 * @sync_method: which synchronization method to use
1356 * @path_sel_proto: which path selection protocol to use
1357 * @path_metric: which metric to use
1358 * @auth_id: which authentication method this mesh is using
1359 * @ie: vendor information elements (optional)
1360 * @ie_len: length of vendor information elements
1361 * @is_authenticated: this mesh requires authentication
1362 * @is_secure: this mesh uses security
1363 * @user_mpm: userspace handles all MPM functions
1364 * @dtim_period: DTIM period to use
1365 * @beacon_interval: beacon interval to use
1366 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1367 * @basic_rates: basic rates to use when creating the mesh
1368 * @beacon_rate: bitrate to be used for beacons
1370 * These parameters are fixed when the mesh is created.
1373 struct cfg80211_chan_def chandef;
1382 bool is_authenticated;
1386 u16 beacon_interval;
1387 int mcast_rate[NUM_NL80211_BANDS];
1389 struct cfg80211_bitrate_mask beacon_rate;
1393 * struct ocb_setup - 802.11p OCB mode setup configuration
1394 * @chandef: defines the channel to use
1396 * These parameters are fixed when connecting to the network
1399 struct cfg80211_chan_def chandef;
1403 * struct ieee80211_txq_params - TX queue parameters
1404 * @ac: AC identifier
1405 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1406 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1408 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1410 * @aifs: Arbitration interframe space [0..255]
1412 struct ieee80211_txq_params {
1421 * DOC: Scanning and BSS list handling
1423 * The scanning process itself is fairly simple, but cfg80211 offers quite
1424 * a bit of helper functionality. To start a scan, the scan operation will
1425 * be invoked with a scan definition. This scan definition contains the
1426 * channels to scan, and the SSIDs to send probe requests for (including the
1427 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1428 * probe. Additionally, a scan request may contain extra information elements
1429 * that should be added to the probe request. The IEs are guaranteed to be
1430 * well-formed, and will not exceed the maximum length the driver advertised
1431 * in the wiphy structure.
1433 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1434 * it is responsible for maintaining the BSS list; the driver should not
1435 * maintain a list itself. For this notification, various functions exist.
1437 * Since drivers do not maintain a BSS list, there are also a number of
1438 * functions to search for a BSS and obtain information about it from the
1439 * BSS structure cfg80211 maintains. The BSS list is also made available
1444 * struct cfg80211_ssid - SSID description
1446 * @ssid_len: length of the ssid
1448 struct cfg80211_ssid {
1449 u8 ssid[IEEE80211_MAX_SSID_LEN];
1454 * struct cfg80211_scan_info - information about completed scan
1455 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1456 * wireless device that requested the scan is connected to. If this
1457 * information is not available, this field is left zero.
1458 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1459 * @aborted: set to true if the scan was aborted for any reason,
1460 * userspace will be notified of that
1462 struct cfg80211_scan_info {
1464 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1469 * struct cfg80211_scan_request - scan request description
1471 * @ssids: SSIDs to scan for (active scan only)
1472 * @n_ssids: number of SSIDs
1473 * @channels: channels to scan on.
1474 * @n_channels: total number of channels to scan
1475 * @scan_width: channel width for scanning
1476 * @ie: optional information element(s) to add into Probe Request or %NULL
1477 * @ie_len: length of ie in octets
1478 * @duration: how long to listen on each channel, in TUs. If
1479 * %duration_mandatory is not set, this is the maximum dwell time and
1480 * the actual dwell time may be shorter.
1481 * @duration_mandatory: if set, the scan duration must be as specified by the
1483 * @flags: bit field of flags controlling operation
1484 * @rates: bitmap of rates to advertise for each band
1485 * @wiphy: the wiphy this was for
1486 * @scan_start: time (in jiffies) when the scan started
1487 * @wdev: the wireless device to scan for
1488 * @info: (internal) information about completed scan
1489 * @notified: (internal) scan request was notified as done or aborted
1490 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1491 * @mac_addr: MAC address used with randomisation
1492 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1493 * are 0 in the mask should be randomised, bits that are 1 should
1494 * be taken from the @mac_addr
1495 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1497 struct cfg80211_scan_request {
1498 struct cfg80211_ssid *ssids;
1501 enum nl80211_bss_scan_width scan_width;
1505 bool duration_mandatory;
1508 u32 rates[NUM_NL80211_BANDS];
1510 struct wireless_dev *wdev;
1512 u8 mac_addr[ETH_ALEN] __aligned(2);
1513 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1514 u8 bssid[ETH_ALEN] __aligned(2);
1517 struct wiphy *wiphy;
1518 unsigned long scan_start;
1519 struct cfg80211_scan_info info;
1524 struct ieee80211_channel *channels[0];
1527 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1531 get_random_bytes(buf, ETH_ALEN);
1532 for (i = 0; i < ETH_ALEN; i++) {
1534 buf[i] |= addr[i] & mask[i];
1539 * struct cfg80211_match_set - sets of attributes to match
1541 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1542 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1544 struct cfg80211_match_set {
1545 struct cfg80211_ssid ssid;
1550 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1552 * @interval: interval between scheduled scan iterations. In seconds.
1553 * @iterations: number of scan iterations in this scan plan. Zero means
1555 * The last scan plan will always have this parameter set to zero,
1556 * all other scan plans will have a finite number of iterations.
1558 struct cfg80211_sched_scan_plan {
1564 * struct cfg80211_sched_scan_request - scheduled scan request description
1566 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1567 * @n_ssids: number of SSIDs
1568 * @n_channels: total number of channels to scan
1569 * @scan_width: channel width for scanning
1570 * @ie: optional information element(s) to add into Probe Request or %NULL
1571 * @ie_len: length of ie in octets
1572 * @flags: bit field of flags controlling operation
1573 * @match_sets: sets of parameters to be matched for a scan result
1574 * entry to be considered valid and to be passed to the host
1575 * (others are filtered out).
1576 * If ommited, all results are passed.
1577 * @n_match_sets: number of match sets
1578 * @wiphy: the wiphy this was for
1579 * @dev: the interface
1580 * @scan_start: start time of the scheduled scan
1581 * @channels: channels to scan
1582 * @min_rssi_thold: for drivers only supporting a single threshold, this
1583 * contains the minimum over all matchsets
1584 * @mac_addr: MAC address used with randomisation
1585 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1586 * are 0 in the mask should be randomised, bits that are 1 should
1587 * be taken from the @mac_addr
1588 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1589 * index must be executed first.
1590 * @n_scan_plans: number of scan plans, at least 1.
1591 * @rcu_head: RCU callback used to free the struct
1592 * @owner_nlportid: netlink portid of owner (if this should is a request
1593 * owned by a particular socket)
1594 * @delay: delay in seconds to use before starting the first scan
1595 * cycle. The driver may ignore this parameter and start
1596 * immediately (or at any other time), if this feature is not
1599 struct cfg80211_sched_scan_request {
1600 struct cfg80211_ssid *ssids;
1603 enum nl80211_bss_scan_width scan_width;
1607 struct cfg80211_match_set *match_sets;
1611 struct cfg80211_sched_scan_plan *scan_plans;
1614 u8 mac_addr[ETH_ALEN] __aligned(2);
1615 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1618 struct wiphy *wiphy;
1619 struct net_device *dev;
1620 unsigned long scan_start;
1621 struct rcu_head rcu_head;
1625 struct ieee80211_channel *channels[0];
1629 * enum cfg80211_signal_type - signal type
1631 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1632 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1633 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1635 enum cfg80211_signal_type {
1636 CFG80211_SIGNAL_TYPE_NONE,
1637 CFG80211_SIGNAL_TYPE_MBM,
1638 CFG80211_SIGNAL_TYPE_UNSPEC,
1642 * struct cfg80211_inform_bss - BSS inform data
1643 * @chan: channel the frame was received on
1644 * @scan_width: scan width that was used
1645 * @signal: signal strength value, according to the wiphy's
1647 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1648 * received; should match the time when the frame was actually
1649 * received by the device (not just by the host, in case it was
1650 * buffered on the device) and be accurate to about 10ms.
1651 * If the frame isn't buffered, just passing the return value of
1652 * ktime_get_boot_ns() is likely appropriate.
1653 * @parent_tsf: the time at the start of reception of the first octet of the
1654 * timestamp field of the frame. The time is the TSF of the BSS specified
1656 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1657 * the BSS that requested the scan in which the beacon/probe was received.
1659 struct cfg80211_inform_bss {
1660 struct ieee80211_channel *chan;
1661 enum nl80211_bss_scan_width scan_width;
1665 u8 parent_bssid[ETH_ALEN] __aligned(2);
1669 * struct cfg80211_bss_ies - BSS entry IE data
1670 * @tsf: TSF contained in the frame that carried these IEs
1671 * @rcu_head: internal use, for freeing
1672 * @len: length of the IEs
1673 * @from_beacon: these IEs are known to come from a beacon
1676 struct cfg80211_bss_ies {
1678 struct rcu_head rcu_head;
1685 * struct cfg80211_bss - BSS description
1687 * This structure describes a BSS (which may also be a mesh network)
1688 * for use in scan results and similar.
1690 * @channel: channel this BSS is on
1691 * @scan_width: width of the control channel
1692 * @bssid: BSSID of the BSS
1693 * @beacon_interval: the beacon interval as from the frame
1694 * @capability: the capability field in host byte order
1695 * @ies: the information elements (Note that there is no guarantee that these
1696 * are well-formed!); this is a pointer to either the beacon_ies or
1697 * proberesp_ies depending on whether Probe Response frame has been
1698 * received. It is always non-%NULL.
1699 * @beacon_ies: the information elements from the last Beacon frame
1700 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1701 * own the beacon_ies, but they're just pointers to the ones from the
1702 * @hidden_beacon_bss struct)
1703 * @proberesp_ies: the information elements from the last Probe Response frame
1704 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1705 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1706 * that holds the beacon data. @beacon_ies is still valid, of course, and
1707 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1708 * @signal: signal strength value (type depends on the wiphy's signal_type)
1709 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1711 struct cfg80211_bss {
1712 struct ieee80211_channel *channel;
1713 enum nl80211_bss_scan_width scan_width;
1715 const struct cfg80211_bss_ies __rcu *ies;
1716 const struct cfg80211_bss_ies __rcu *beacon_ies;
1717 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1719 struct cfg80211_bss *hidden_beacon_bss;
1723 u16 beacon_interval;
1728 u8 priv[0] __aligned(sizeof(void *));
1732 * ieee80211_bss_get_ie - find IE with given ID
1733 * @bss: the bss to search
1736 * Note that the return value is an RCU-protected pointer, so
1737 * rcu_read_lock() must be held when calling this function.
1738 * Return: %NULL if not found.
1740 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1744 * struct cfg80211_auth_request - Authentication request data
1746 * This structure provides information needed to complete IEEE 802.11
1749 * @bss: The BSS to authenticate with, the callee must obtain a reference
1750 * to it if it needs to keep it.
1751 * @auth_type: Authentication type (algorithm)
1752 * @ie: Extra IEs to add to Authentication frame or %NULL
1753 * @ie_len: Length of ie buffer in octets
1754 * @key_len: length of WEP key for shared key authentication
1755 * @key_idx: index of WEP key for shared key authentication
1756 * @key: WEP key for shared key authentication
1757 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1758 * Authentication transaction sequence number field.
1759 * @sae_data_len: Length of sae_data buffer in octets
1761 struct cfg80211_auth_request {
1762 struct cfg80211_bss *bss;
1765 enum nl80211_auth_type auth_type;
1767 u8 key_len, key_idx;
1769 size_t sae_data_len;
1773 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1775 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1776 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1777 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1779 enum cfg80211_assoc_req_flags {
1780 ASSOC_REQ_DISABLE_HT = BIT(0),
1781 ASSOC_REQ_DISABLE_VHT = BIT(1),
1782 ASSOC_REQ_USE_RRM = BIT(2),
1786 * struct cfg80211_assoc_request - (Re)Association request data
1788 * This structure provides information needed to complete IEEE 802.11
1790 * @bss: The BSS to associate with. If the call is successful the driver is
1791 * given a reference that it must give back to cfg80211_send_rx_assoc()
1792 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1793 * association requests while already associating must be rejected.
1794 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1795 * @ie_len: Length of ie buffer in octets
1796 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1797 * @crypto: crypto settings
1798 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1799 * to indicate a request to reassociate within the ESS instead of a request
1800 * do the initial association with the ESS. When included, this is set to
1801 * the BSSID of the current association, i.e., to the value that is
1802 * included in the Current AP address field of the Reassociation Request
1804 * @flags: See &enum cfg80211_assoc_req_flags
1805 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1806 * will be used in ht_capa. Un-supported values will be ignored.
1807 * @ht_capa_mask: The bits of ht_capa which are to be used.
1808 * @vht_capa: VHT capability override
1809 * @vht_capa_mask: VHT capability mask indicating which fields to use
1811 struct cfg80211_assoc_request {
1812 struct cfg80211_bss *bss;
1813 const u8 *ie, *prev_bssid;
1815 struct cfg80211_crypto_settings crypto;
1818 struct ieee80211_ht_cap ht_capa;
1819 struct ieee80211_ht_cap ht_capa_mask;
1820 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1824 * struct cfg80211_deauth_request - Deauthentication request data
1826 * This structure provides information needed to complete IEEE 802.11
1829 * @bssid: the BSSID of the BSS to deauthenticate from
1830 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1831 * @ie_len: Length of ie buffer in octets
1832 * @reason_code: The reason code for the deauthentication
1833 * @local_state_change: if set, change local state only and
1834 * do not set a deauth frame
1836 struct cfg80211_deauth_request {
1841 bool local_state_change;
1845 * struct cfg80211_disassoc_request - Disassociation request data
1847 * This structure provides information needed to complete IEEE 802.11
1850 * @bss: the BSS to disassociate from
1851 * @ie: Extra IEs to add to Disassociation frame or %NULL
1852 * @ie_len: Length of ie buffer in octets
1853 * @reason_code: The reason code for the disassociation
1854 * @local_state_change: This is a request for a local state only, i.e., no
1855 * Disassociation frame is to be transmitted.
1857 struct cfg80211_disassoc_request {
1858 struct cfg80211_bss *bss;
1862 bool local_state_change;
1866 * struct cfg80211_ibss_params - IBSS parameters
1868 * This structure defines the IBSS parameters for the join_ibss()
1871 * @ssid: The SSID, will always be non-null.
1872 * @ssid_len: The length of the SSID, will always be non-zero.
1873 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1874 * search for IBSSs with a different BSSID.
1875 * @chandef: defines the channel to use if no other IBSS to join can be found
1876 * @channel_fixed: The channel should be fixed -- do not search for
1877 * IBSSs to join on other channels.
1878 * @ie: information element(s) to include in the beacon
1879 * @ie_len: length of that
1880 * @beacon_interval: beacon interval to use
1881 * @privacy: this is a protected network, keys will be configured
1883 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1884 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1885 * required to assume that the port is unauthorized until authorized by
1886 * user space. Otherwise, port is marked authorized by default.
1887 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1888 * changes the channel when a radar is detected. This is required
1889 * to operate on DFS channels.
1890 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1891 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1892 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1893 * will be used in ht_capa. Un-supported values will be ignored.
1894 * @ht_capa_mask: The bits of ht_capa which are to be used.
1896 struct cfg80211_ibss_params {
1899 struct cfg80211_chan_def chandef;
1901 u8 ssid_len, ie_len;
1902 u16 beacon_interval;
1907 bool userspace_handles_dfs;
1908 int mcast_rate[NUM_NL80211_BANDS];
1909 struct ieee80211_ht_cap ht_capa;
1910 struct ieee80211_ht_cap ht_capa_mask;
1914 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1916 * @band: band of BSS which should match for RSSI level adjustment.
1917 * @delta: value of RSSI level adjustment.
1919 struct cfg80211_bss_select_adjust {
1920 enum nl80211_band band;
1925 * struct cfg80211_bss_selection - connection parameters for BSS selection.
1927 * @behaviour: requested BSS selection behaviour.
1928 * @param: parameters for requestion behaviour.
1929 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
1930 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
1932 struct cfg80211_bss_selection {
1933 enum nl80211_bss_select_attr behaviour;
1935 enum nl80211_band band_pref;
1936 struct cfg80211_bss_select_adjust adjust;
1941 * struct cfg80211_connect_params - Connection parameters
1943 * This structure provides information needed to complete IEEE 802.11
1944 * authentication and association.
1946 * @channel: The channel to use or %NULL if not specified (auto-select based
1948 * @channel_hint: The channel of the recommended BSS for initial connection or
1949 * %NULL if not specified
1950 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1952 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1953 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1954 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1957 * @ssid_len: Length of ssid in octets
1958 * @auth_type: Authentication type (algorithm)
1959 * @ie: IEs for association request
1960 * @ie_len: Length of assoc_ie in octets
1961 * @privacy: indicates whether privacy-enabled APs should be used
1962 * @mfp: indicate whether management frame protection is used
1963 * @crypto: crypto settings
1964 * @key_len: length of WEP key for shared key authentication
1965 * @key_idx: index of WEP key for shared key authentication
1966 * @key: WEP key for shared key authentication
1967 * @flags: See &enum cfg80211_assoc_req_flags
1968 * @bg_scan_period: Background scan period in seconds
1969 * or -1 to indicate that default value is to be used.
1970 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1971 * will be used in ht_capa. Un-supported values will be ignored.
1972 * @ht_capa_mask: The bits of ht_capa which are to be used.
1973 * @vht_capa: VHT Capability overrides
1974 * @vht_capa_mask: The bits of vht_capa which are to be used.
1975 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
1977 * @bss_select: criteria to be used for BSS selection.
1978 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1979 * to indicate a request to reassociate within the ESS instead of a request
1980 * do the initial association with the ESS. When included, this is set to
1981 * the BSSID of the current association, i.e., to the value that is
1982 * included in the Current AP address field of the Reassociation Request
1985 struct cfg80211_connect_params {
1986 struct ieee80211_channel *channel;
1987 struct ieee80211_channel *channel_hint;
1989 const u8 *bssid_hint;
1992 enum nl80211_auth_type auth_type;
1996 enum nl80211_mfp mfp;
1997 struct cfg80211_crypto_settings crypto;
1999 u8 key_len, key_idx;
2002 struct ieee80211_ht_cap ht_capa;
2003 struct ieee80211_ht_cap ht_capa_mask;
2004 struct ieee80211_vht_cap vht_capa;
2005 struct ieee80211_vht_cap vht_capa_mask;
2007 struct cfg80211_bss_selection bss_select;
2008 const u8 *prev_bssid;
2012 * enum wiphy_params_flags - set_wiphy_params bitfield values
2013 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2014 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2015 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2016 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2017 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2018 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2020 enum wiphy_params_flags {
2021 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2022 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2023 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2024 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2025 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2026 WIPHY_PARAM_DYN_ACK = 1 << 5,
2030 * struct cfg80211_pmksa - PMK Security Association
2032 * This structure is passed to the set/del_pmksa() method for PMKSA
2035 * @bssid: The AP's BSSID.
2036 * @pmkid: The PMK material itself.
2038 struct cfg80211_pmksa {
2044 * struct cfg80211_pkt_pattern - packet pattern
2045 * @mask: bitmask where to match pattern and where to ignore bytes,
2046 * one bit per byte, in same format as nl80211
2047 * @pattern: bytes to match where bitmask is 1
2048 * @pattern_len: length of pattern (in bytes)
2049 * @pkt_offset: packet offset (in bytes)
2051 * Internal note: @mask and @pattern are allocated in one chunk of
2052 * memory, free @mask only!
2054 struct cfg80211_pkt_pattern {
2055 const u8 *mask, *pattern;
2061 * struct cfg80211_wowlan_tcp - TCP connection parameters
2063 * @sock: (internal) socket for source port allocation
2064 * @src: source IP address
2065 * @dst: destination IP address
2066 * @dst_mac: destination MAC address
2067 * @src_port: source port
2068 * @dst_port: destination port
2069 * @payload_len: data payload length
2070 * @payload: data payload buffer
2071 * @payload_seq: payload sequence stamping configuration
2072 * @data_interval: interval at which to send data packets
2073 * @wake_len: wakeup payload match length
2074 * @wake_data: wakeup payload match data
2075 * @wake_mask: wakeup payload match mask
2076 * @tokens_size: length of the tokens buffer
2077 * @payload_tok: payload token usage configuration
2079 struct cfg80211_wowlan_tcp {
2080 struct socket *sock;
2082 u16 src_port, dst_port;
2083 u8 dst_mac[ETH_ALEN];
2086 struct nl80211_wowlan_tcp_data_seq payload_seq;
2089 const u8 *wake_data, *wake_mask;
2091 /* must be last, variable member */
2092 struct nl80211_wowlan_tcp_data_token payload_tok;
2096 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2098 * This structure defines the enabled WoWLAN triggers for the device.
2099 * @any: wake up on any activity -- special trigger if device continues
2100 * operating as normal during suspend
2101 * @disconnect: wake up if getting disconnected
2102 * @magic_pkt: wake up on receiving magic packet
2103 * @patterns: wake up on receiving packet matching a pattern
2104 * @n_patterns: number of patterns
2105 * @gtk_rekey_failure: wake up on GTK rekey failure
2106 * @eap_identity_req: wake up on EAP identity request packet
2107 * @four_way_handshake: wake up on 4-way handshake
2108 * @rfkill_release: wake up when rfkill is released
2109 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2110 * NULL if not configured.
2111 * @nd_config: configuration for the scan to be used for net detect wake.
2113 struct cfg80211_wowlan {
2114 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2115 eap_identity_req, four_way_handshake,
2117 struct cfg80211_pkt_pattern *patterns;
2118 struct cfg80211_wowlan_tcp *tcp;
2120 struct cfg80211_sched_scan_request *nd_config;
2124 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2126 * This structure defines coalesce rule for the device.
2127 * @delay: maximum coalescing delay in msecs.
2128 * @condition: condition for packet coalescence.
2129 * see &enum nl80211_coalesce_condition.
2130 * @patterns: array of packet patterns
2131 * @n_patterns: number of patterns
2133 struct cfg80211_coalesce_rules {
2135 enum nl80211_coalesce_condition condition;
2136 struct cfg80211_pkt_pattern *patterns;
2141 * struct cfg80211_coalesce - Packet coalescing settings
2143 * This structure defines coalescing settings.
2144 * @rules: array of coalesce rules
2145 * @n_rules: number of rules
2147 struct cfg80211_coalesce {
2148 struct cfg80211_coalesce_rules *rules;
2153 * struct cfg80211_wowlan_nd_match - information about the match
2155 * @ssid: SSID of the match that triggered the wake up
2156 * @n_channels: Number of channels where the match occurred. This
2157 * value may be zero if the driver can't report the channels.
2158 * @channels: center frequencies of the channels where a match
2161 struct cfg80211_wowlan_nd_match {
2162 struct cfg80211_ssid ssid;
2168 * struct cfg80211_wowlan_nd_info - net detect wake up information
2170 * @n_matches: Number of match information instances provided in
2171 * @matches. This value may be zero if the driver can't provide
2172 * match information.
2173 * @matches: Array of pointers to matches containing information about
2174 * the matches that triggered the wake up.
2176 struct cfg80211_wowlan_nd_info {
2178 struct cfg80211_wowlan_nd_match *matches[];
2182 * struct cfg80211_wowlan_wakeup - wakeup report
2183 * @disconnect: woke up by getting disconnected
2184 * @magic_pkt: woke up by receiving magic packet
2185 * @gtk_rekey_failure: woke up by GTK rekey failure
2186 * @eap_identity_req: woke up by EAP identity request packet
2187 * @four_way_handshake: woke up by 4-way handshake
2188 * @rfkill_release: woke up by rfkill being released
2189 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2190 * @packet_present_len: copied wakeup packet data
2191 * @packet_len: original wakeup packet length
2192 * @packet: The packet causing the wakeup, if any.
2193 * @packet_80211: For pattern match, magic packet and other data
2194 * frame triggers an 802.3 frame should be reported, for
2195 * disconnect due to deauth 802.11 frame. This indicates which
2197 * @tcp_match: TCP wakeup packet received
2198 * @tcp_connlost: TCP connection lost or failed to establish
2199 * @tcp_nomoretokens: TCP data ran out of tokens
2200 * @net_detect: if not %NULL, woke up because of net detect
2202 struct cfg80211_wowlan_wakeup {
2203 bool disconnect, magic_pkt, gtk_rekey_failure,
2204 eap_identity_req, four_way_handshake,
2205 rfkill_release, packet_80211,
2206 tcp_match, tcp_connlost, tcp_nomoretokens;
2208 u32 packet_present_len, packet_len;
2210 struct cfg80211_wowlan_nd_info *net_detect;
2214 * struct cfg80211_gtk_rekey_data - rekey data
2215 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2216 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2217 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2219 struct cfg80211_gtk_rekey_data {
2220 const u8 *kek, *kck, *replay_ctr;
2224 * struct cfg80211_update_ft_ies_params - FT IE Information
2226 * This structure provides information needed to update the fast transition IE
2228 * @md: The Mobility Domain ID, 2 Octet value
2229 * @ie: Fast Transition IEs
2230 * @ie_len: Length of ft_ie in octets
2232 struct cfg80211_update_ft_ies_params {
2239 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2241 * This structure provides information needed to transmit a mgmt frame
2243 * @chan: channel to use
2244 * @offchan: indicates wether off channel operation is required
2245 * @wait: duration for ROC
2246 * @buf: buffer to transmit
2247 * @len: buffer length
2248 * @no_cck: don't use cck rates for this frame
2249 * @dont_wait_for_ack: tells the low level not to wait for an ack
2250 * @n_csa_offsets: length of csa_offsets array
2251 * @csa_offsets: array of all the csa offsets in the frame
2253 struct cfg80211_mgmt_tx_params {
2254 struct ieee80211_channel *chan;
2260 bool dont_wait_for_ack;
2262 const u16 *csa_offsets;
2266 * struct cfg80211_dscp_exception - DSCP exception
2268 * @dscp: DSCP value that does not adhere to the user priority range definition
2269 * @up: user priority value to which the corresponding DSCP value belongs
2271 struct cfg80211_dscp_exception {
2277 * struct cfg80211_dscp_range - DSCP range definition for user priority
2279 * @low: lowest DSCP value of this user priority range, inclusive
2280 * @high: highest DSCP value of this user priority range, inclusive
2282 struct cfg80211_dscp_range {
2287 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2288 #define IEEE80211_QOS_MAP_MAX_EX 21
2289 #define IEEE80211_QOS_MAP_LEN_MIN 16
2290 #define IEEE80211_QOS_MAP_LEN_MAX \
2291 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2294 * struct cfg80211_qos_map - QoS Map Information
2296 * This struct defines the Interworking QoS map setting for DSCP values
2298 * @num_des: number of DSCP exceptions (0..21)
2299 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2300 * the user priority DSCP range definition
2301 * @up: DSCP range definition for a particular user priority
2303 struct cfg80211_qos_map {
2305 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2306 struct cfg80211_dscp_range up[8];
2310 * struct cfg80211_ops - backend description for wireless configuration
2312 * This struct is registered by fullmac card drivers and/or wireless stacks
2313 * in order to handle configuration requests on their interfaces.
2315 * All callbacks except where otherwise noted should return 0
2316 * on success or a negative error code.
2318 * All operations are currently invoked under rtnl for consistency with the
2319 * wireless extensions but this is subject to reevaluation as soon as this
2320 * code is used more widely and we have a first user without wext.
2322 * @suspend: wiphy device needs to be suspended. The variable @wow will
2323 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2324 * configured for the device.
2325 * @resume: wiphy device needs to be resumed
2326 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2327 * to call device_set_wakeup_enable() to enable/disable wakeup from
2330 * @add_virtual_intf: create a new virtual interface with the given name,
2331 * must set the struct wireless_dev's iftype. Beware: You must create
2332 * the new netdev in the wiphy's network namespace! Returns the struct
2333 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2334 * also set the address member in the wdev.
2336 * @del_virtual_intf: remove the virtual interface
2338 * @change_virtual_intf: change type/configuration of virtual interface,
2339 * keep the struct wireless_dev's iftype updated.
2341 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2342 * when adding a group key.
2344 * @get_key: get information about the key with the given parameters.
2345 * @mac_addr will be %NULL when requesting information for a group
2346 * key. All pointers given to the @callback function need not be valid
2347 * after it returns. This function should return an error if it is
2348 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2350 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2351 * and @key_index, return -ENOENT if the key doesn't exist.
2353 * @set_default_key: set the default key on an interface
2355 * @set_default_mgmt_key: set the default management frame key on an interface
2357 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2359 * @start_ap: Start acting in AP mode defined by the parameters.
2360 * @change_beacon: Change the beacon parameters for an access point mode
2361 * interface. This should reject the call when AP mode wasn't started.
2362 * @stop_ap: Stop being an AP, including stopping beaconing.
2364 * @add_station: Add a new station.
2365 * @del_station: Remove a station
2366 * @change_station: Modify a given station. Note that flags changes are not much
2367 * validated in cfg80211, in particular the auth/assoc/authorized flags
2368 * might come to the driver in invalid combinations -- make sure to check
2369 * them, also against the existing state! Drivers must call
2370 * cfg80211_check_station_change() to validate the information.
2371 * @get_station: get station information for the station identified by @mac
2372 * @dump_station: dump station callback -- resume dump at index @idx
2374 * @add_mpath: add a fixed mesh path
2375 * @del_mpath: delete a given mesh path
2376 * @change_mpath: change a given mesh path
2377 * @get_mpath: get a mesh path for the given parameters
2378 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2379 * @get_mpp: get a mesh proxy path for the given parameters
2380 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2381 * @join_mesh: join the mesh network with the specified parameters
2382 * (invoked with the wireless_dev mutex held)
2383 * @leave_mesh: leave the current mesh network
2384 * (invoked with the wireless_dev mutex held)
2386 * @get_mesh_config: Get the current mesh configuration
2388 * @update_mesh_config: Update mesh parameters on a running mesh.
2389 * The mask is a bitfield which tells us which parameters to
2390 * set, and which to leave alone.
2392 * @change_bss: Modify parameters for a given BSS.
2394 * @set_txq_params: Set TX queue parameters
2396 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2397 * as it doesn't implement join_mesh and needs to set the channel to
2398 * join the mesh instead.
2400 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2401 * interfaces are active this callback should reject the configuration.
2402 * If no interfaces are active or the device is down, the channel should
2403 * be stored for when a monitor interface becomes active.
2405 * @scan: Request to do a scan. If returning zero, the scan request is given
2406 * the driver, and will be valid until passed to cfg80211_scan_done().
2407 * For scan results, call cfg80211_inform_bss(); you can call this outside
2408 * the scan/scan_done bracket too.
2409 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2410 * indicate the status of the scan through cfg80211_scan_done().
2412 * @auth: Request to authenticate with the specified peer
2413 * (invoked with the wireless_dev mutex held)
2414 * @assoc: Request to (re)associate with the specified peer
2415 * (invoked with the wireless_dev mutex held)
2416 * @deauth: Request to deauthenticate from the specified peer
2417 * (invoked with the wireless_dev mutex held)
2418 * @disassoc: Request to disassociate from the specified peer
2419 * (invoked with the wireless_dev mutex held)
2421 * @connect: Connect to the ESS with the specified parameters. When connected,
2422 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2423 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2424 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2425 * from the AP or cfg80211_connect_timeout() if no frame with status code
2427 * The driver is allowed to roam to other BSSes within the ESS when the
2428 * other BSS matches the connect parameters. When such roaming is initiated
2429 * by the driver, the driver is expected to verify that the target matches
2430 * the configured security parameters and to use Reassociation Request
2431 * frame instead of Association Request frame.
2432 * The connect function can also be used to request the driver to perform a
2433 * specific roam when connected to an ESS. In that case, the prev_bssid
2434 * parameter is set to the BSSID of the currently associated BSS as an
2435 * indication of requesting reassociation.
2436 * In both the driver-initiated and new connect() call initiated roaming
2437 * cases, the result of roaming is indicated with a call to
2438 * cfg80211_roamed() or cfg80211_roamed_bss().
2439 * (invoked with the wireless_dev mutex held)
2440 * @disconnect: Disconnect from the BSS/ESS. Once done, call
2441 * cfg80211_disconnected().
2442 * (invoked with the wireless_dev mutex held)
2444 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2445 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2447 * (invoked with the wireless_dev mutex held)
2448 * @leave_ibss: Leave the IBSS.
2449 * (invoked with the wireless_dev mutex held)
2451 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2454 * @set_wiphy_params: Notify that wiphy parameters have changed;
2455 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2456 * have changed. The actual parameter values are available in
2457 * struct wiphy. If returning an error, no value should be changed.
2459 * @set_tx_power: set the transmit power according to the parameters,
2460 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2461 * wdev may be %NULL if power was set for the wiphy, and will
2462 * always be %NULL unless the driver supports per-vif TX power
2463 * (as advertised by the nl80211 feature flag.)
2464 * @get_tx_power: store the current TX power into the dbm variable;
2465 * return 0 if successful
2467 * @set_wds_peer: set the WDS peer for a WDS interface
2469 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2470 * functions to adjust rfkill hw state
2472 * @dump_survey: get site survey information.
2474 * @remain_on_channel: Request the driver to remain awake on the specified
2475 * channel for the specified duration to complete an off-channel
2476 * operation (e.g., public action frame exchange). When the driver is
2477 * ready on the requested channel, it must indicate this with an event
2478 * notification by calling cfg80211_ready_on_channel().
2479 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2480 * This allows the operation to be terminated prior to timeout based on
2481 * the duration value.
2482 * @mgmt_tx: Transmit a management frame.
2483 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2484 * frame on another channel
2486 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2487 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2488 * used by the function, but 0 and 1 must not be touched. Additionally,
2489 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2490 * dump and return to userspace with an error, so be careful. If any data
2491 * was passed in from userspace then the data/len arguments will be present
2492 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2494 * @set_bitrate_mask: set the bitrate mask configuration
2496 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2497 * devices running firmwares capable of generating the (re) association
2498 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2499 * @del_pmksa: Delete a cached PMKID.
2500 * @flush_pmksa: Flush all cached PMKIDs.
2501 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2502 * allows the driver to adjust the dynamic ps timeout value.
2503 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2504 * After configuration, the driver should (soon) send an event indicating
2505 * the current level is above/below the configured threshold; this may
2506 * need some care when the configuration is changed (without first being
2508 * @set_cqm_txe_config: Configure connection quality monitor TX error
2510 * @sched_scan_start: Tell the driver to start a scheduled scan.
2511 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2512 * call must stop the scheduled scan and be ready for starting a new one
2513 * before it returns, i.e. @sched_scan_start may be called immediately
2514 * after that again and should not fail in that case. The driver should
2515 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2516 * method returns 0.)
2518 * @mgmt_frame_register: Notify driver that a management frame type was
2519 * registered. The callback is allowed to sleep.
2521 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2522 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2523 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2524 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2526 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2528 * @tdls_mgmt: Transmit a TDLS management frame.
2529 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2531 * @probe_client: probe an associated client, must return a cookie that it
2532 * later passes to cfg80211_probe_status().
2534 * @set_noack_map: Set the NoAck Map for the TIDs.
2536 * @get_channel: Get the current operating channel for the virtual interface.
2537 * For monitor interfaces, it should return %NULL unless there's a single
2538 * current monitoring channel.
2540 * @start_p2p_device: Start the given P2P device.
2541 * @stop_p2p_device: Stop the given P2P device.
2543 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2544 * Parameters include ACL policy, an array of MAC address of stations
2545 * and the number of MAC addresses. If there is already a list in driver
2546 * this new list replaces the existing one. Driver has to clear its ACL
2547 * when number of MAC addresses entries is passed as 0. Drivers which
2548 * advertise the support for MAC based ACL have to implement this callback.
2550 * @start_radar_detection: Start radar detection in the driver.
2552 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2553 * driver. If the SME is in the driver/firmware, this information can be
2554 * used in building Authentication and Reassociation Request frames.
2556 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2557 * for a given duration (milliseconds). The protocol is provided so the
2558 * driver can take the most appropriate actions.
2559 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2560 * reliability. This operation can not fail.
2561 * @set_coalesce: Set coalesce parameters.
2563 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2564 * responsible for veryfing if the switch is possible. Since this is
2565 * inherently tricky driver may decide to disconnect an interface later
2566 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2567 * everything. It should do it's best to verify requests and reject them
2568 * as soon as possible.
2570 * @set_qos_map: Set QoS mapping information to the driver
2572 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2573 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2574 * changes during the lifetime of the BSS.
2576 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2577 * with the given parameters; action frame exchange has been handled by
2578 * userspace so this just has to modify the TX path to take the TS into
2580 * If the admitted time is 0 just validate the parameters to make sure
2581 * the session can be created at all; it is valid to just always return
2582 * success for that but that may result in inefficient behaviour (handshake
2583 * with the peer followed by immediate teardown when the addition is later
2585 * @del_tx_ts: remove an existing TX TS
2587 * @join_ocb: join the OCB network with the specified parameters
2588 * (invoked with the wireless_dev mutex held)
2589 * @leave_ocb: leave the current OCB network
2590 * (invoked with the wireless_dev mutex held)
2592 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2593 * is responsible for continually initiating channel-switching operations
2594 * and returning to the base channel for communication with the AP.
2595 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2596 * peers must be on the base channel when the call completes.
2598 struct cfg80211_ops {
2599 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2600 int (*resume)(struct wiphy *wiphy);
2601 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2603 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2605 unsigned char name_assign_type,
2606 enum nl80211_iftype type,
2608 struct vif_params *params);
2609 int (*del_virtual_intf)(struct wiphy *wiphy,
2610 struct wireless_dev *wdev);
2611 int (*change_virtual_intf)(struct wiphy *wiphy,
2612 struct net_device *dev,
2613 enum nl80211_iftype type, u32 *flags,
2614 struct vif_params *params);
2616 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2617 u8 key_index, bool pairwise, const u8 *mac_addr,
2618 struct key_params *params);
2619 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2620 u8 key_index, bool pairwise, const u8 *mac_addr,
2622 void (*callback)(void *cookie, struct key_params*));
2623 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2624 u8 key_index, bool pairwise, const u8 *mac_addr);
2625 int (*set_default_key)(struct wiphy *wiphy,
2626 struct net_device *netdev,
2627 u8 key_index, bool unicast, bool multicast);
2628 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2629 struct net_device *netdev,
2632 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2633 struct cfg80211_ap_settings *settings);
2634 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2635 struct cfg80211_beacon_data *info);
2636 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2639 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2641 struct station_parameters *params);
2642 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2643 struct station_del_parameters *params);
2644 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2646 struct station_parameters *params);
2647 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2648 const u8 *mac, struct station_info *sinfo);
2649 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2650 int idx, u8 *mac, struct station_info *sinfo);
2652 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2653 const u8 *dst, const u8 *next_hop);
2654 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2656 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2657 const u8 *dst, const u8 *next_hop);
2658 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2659 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2660 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2661 int idx, u8 *dst, u8 *next_hop,
2662 struct mpath_info *pinfo);
2663 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2664 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2665 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2666 int idx, u8 *dst, u8 *mpp,
2667 struct mpath_info *pinfo);
2668 int (*get_mesh_config)(struct wiphy *wiphy,
2669 struct net_device *dev,
2670 struct mesh_config *conf);
2671 int (*update_mesh_config)(struct wiphy *wiphy,
2672 struct net_device *dev, u32 mask,
2673 const struct mesh_config *nconf);
2674 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2675 const struct mesh_config *conf,
2676 const struct mesh_setup *setup);
2677 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2679 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2680 struct ocb_setup *setup);
2681 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2683 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2684 struct bss_parameters *params);
2686 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2687 struct ieee80211_txq_params *params);
2689 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2690 struct net_device *dev,
2691 struct ieee80211_channel *chan);
2693 int (*set_monitor_channel)(struct wiphy *wiphy,
2694 struct cfg80211_chan_def *chandef);
2696 int (*scan)(struct wiphy *wiphy,
2697 struct cfg80211_scan_request *request);
2698 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
2700 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2701 struct cfg80211_auth_request *req);
2702 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2703 struct cfg80211_assoc_request *req);
2704 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2705 struct cfg80211_deauth_request *req);
2706 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2707 struct cfg80211_disassoc_request *req);
2709 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2710 struct cfg80211_connect_params *sme);
2711 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2714 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2715 struct cfg80211_ibss_params *params);
2716 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2718 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2719 int rate[NUM_NL80211_BANDS]);
2721 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2723 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2724 enum nl80211_tx_power_setting type, int mbm);
2725 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2728 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2731 void (*rfkill_poll)(struct wiphy *wiphy);
2733 #ifdef CONFIG_NL80211_TESTMODE
2734 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2735 void *data, int len);
2736 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2737 struct netlink_callback *cb,
2738 void *data, int len);
2741 int (*set_bitrate_mask)(struct wiphy *wiphy,
2742 struct net_device *dev,
2744 const struct cfg80211_bitrate_mask *mask);
2746 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2747 int idx, struct survey_info *info);
2749 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2750 struct cfg80211_pmksa *pmksa);
2751 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2752 struct cfg80211_pmksa *pmksa);
2753 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2755 int (*remain_on_channel)(struct wiphy *wiphy,
2756 struct wireless_dev *wdev,
2757 struct ieee80211_channel *chan,
2758 unsigned int duration,
2760 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2761 struct wireless_dev *wdev,
2764 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2765 struct cfg80211_mgmt_tx_params *params,
2767 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2768 struct wireless_dev *wdev,
2771 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2772 bool enabled, int timeout);
2774 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2775 struct net_device *dev,
2776 s32 rssi_thold, u32 rssi_hyst);
2778 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2779 struct net_device *dev,
2780 u32 rate, u32 pkts, u32 intvl);
2782 void (*mgmt_frame_register)(struct wiphy *wiphy,
2783 struct wireless_dev *wdev,
2784 u16 frame_type, bool reg);
2786 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2787 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2789 int (*sched_scan_start)(struct wiphy *wiphy,
2790 struct net_device *dev,
2791 struct cfg80211_sched_scan_request *request);
2792 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2794 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2795 struct cfg80211_gtk_rekey_data *data);
2797 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2798 const u8 *peer, u8 action_code, u8 dialog_token,
2799 u16 status_code, u32 peer_capability,
2800 bool initiator, const u8 *buf, size_t len);
2801 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2802 const u8 *peer, enum nl80211_tdls_operation oper);
2804 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2805 const u8 *peer, u64 *cookie);
2807 int (*set_noack_map)(struct wiphy *wiphy,
2808 struct net_device *dev,
2811 int (*get_channel)(struct wiphy *wiphy,
2812 struct wireless_dev *wdev,
2813 struct cfg80211_chan_def *chandef);
2815 int (*start_p2p_device)(struct wiphy *wiphy,
2816 struct wireless_dev *wdev);
2817 void (*stop_p2p_device)(struct wiphy *wiphy,
2818 struct wireless_dev *wdev);
2820 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2821 const struct cfg80211_acl_data *params);
2823 int (*start_radar_detection)(struct wiphy *wiphy,
2824 struct net_device *dev,
2825 struct cfg80211_chan_def *chandef,
2827 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2828 struct cfg80211_update_ft_ies_params *ftie);
2829 int (*crit_proto_start)(struct wiphy *wiphy,
2830 struct wireless_dev *wdev,
2831 enum nl80211_crit_proto_id protocol,
2833 void (*crit_proto_stop)(struct wiphy *wiphy,
2834 struct wireless_dev *wdev);
2835 int (*set_coalesce)(struct wiphy *wiphy,
2836 struct cfg80211_coalesce *coalesce);
2838 int (*channel_switch)(struct wiphy *wiphy,
2839 struct net_device *dev,
2840 struct cfg80211_csa_settings *params);
2842 int (*set_qos_map)(struct wiphy *wiphy,
2843 struct net_device *dev,
2844 struct cfg80211_qos_map *qos_map);
2846 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
2847 struct cfg80211_chan_def *chandef);
2849 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2850 u8 tsid, const u8 *peer, u8 user_prio,
2852 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2853 u8 tsid, const u8 *peer);
2855 int (*tdls_channel_switch)(struct wiphy *wiphy,
2856 struct net_device *dev,
2857 const u8 *addr, u8 oper_class,
2858 struct cfg80211_chan_def *chandef);
2859 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
2860 struct net_device *dev,
2865 * wireless hardware and networking interfaces structures
2866 * and registration/helper functions
2870 * enum wiphy_flags - wiphy capability flags
2872 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2874 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2875 * by default -- this flag will be set depending on the kernel's default
2876 * on wiphy_new(), but can be changed by the driver if it has a good
2877 * reason to override the default
2878 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2879 * on a VLAN interface)
2880 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2881 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2882 * control port protocol ethertype. The device also honours the
2883 * control_port_no_encrypt flag.
2884 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2885 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2886 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2887 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2888 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2890 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2891 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2892 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2893 * link setup/discovery operations internally. Setup, discovery and
2894 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2895 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2896 * used for asking the driver/firmware to perform a TDLS operation.
2897 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2898 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2899 * when there are virtual interfaces in AP mode by calling
2900 * cfg80211_report_obss_beacon().
2901 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2902 * responds to probe-requests in hardware.
2903 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2904 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2905 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2906 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2907 * beaconing mode (AP, IBSS, Mesh, ...).
2913 WIPHY_FLAG_NETNS_OK = BIT(3),
2914 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2915 WIPHY_FLAG_4ADDR_AP = BIT(5),
2916 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2917 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2918 WIPHY_FLAG_IBSS_RSN = BIT(8),
2919 WIPHY_FLAG_MESH_AUTH = BIT(10),
2920 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2921 /* use hole at 12 */
2922 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2923 WIPHY_FLAG_AP_UAPSD = BIT(14),
2924 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2925 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2926 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2927 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2928 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2929 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2930 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2931 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
2932 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
2936 * struct ieee80211_iface_limit - limit on certain interface types
2937 * @max: maximum number of interfaces of these types
2938 * @types: interface types (bits)
2940 struct ieee80211_iface_limit {
2946 * struct ieee80211_iface_combination - possible interface combination
2947 * @limits: limits for the given interface types
2948 * @n_limits: number of limitations
2949 * @num_different_channels: can use up to this many different channels
2950 * @max_interfaces: maximum number of interfaces in total allowed in this
2952 * @beacon_int_infra_match: In this combination, the beacon intervals
2953 * between infrastructure and AP types must match. This is required
2954 * only in special cases.
2955 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2956 * @radar_detect_regions: bitmap of regions supported for radar detection
2958 * With this structure the driver can describe which interface
2959 * combinations it supports concurrently.
2963 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2965 * struct ieee80211_iface_limit limits1[] = {
2966 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2967 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2969 * struct ieee80211_iface_combination combination1 = {
2970 * .limits = limits1,
2971 * .n_limits = ARRAY_SIZE(limits1),
2972 * .max_interfaces = 2,
2973 * .beacon_int_infra_match = true,
2977 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2979 * struct ieee80211_iface_limit limits2[] = {
2980 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2981 * BIT(NL80211_IFTYPE_P2P_GO), },
2983 * struct ieee80211_iface_combination combination2 = {
2984 * .limits = limits2,
2985 * .n_limits = ARRAY_SIZE(limits2),
2986 * .max_interfaces = 8,
2987 * .num_different_channels = 1,
2991 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2993 * This allows for an infrastructure connection and three P2P connections.
2995 * struct ieee80211_iface_limit limits3[] = {
2996 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2997 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2998 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
3000 * struct ieee80211_iface_combination combination3 = {
3001 * .limits = limits3,
3002 * .n_limits = ARRAY_SIZE(limits3),
3003 * .max_interfaces = 4,
3004 * .num_different_channels = 2,
3007 struct ieee80211_iface_combination {
3008 const struct ieee80211_iface_limit *limits;
3009 u32 num_different_channels;
3012 bool beacon_int_infra_match;
3013 u8 radar_detect_widths;
3014 u8 radar_detect_regions;
3017 struct ieee80211_txrx_stypes {
3022 * enum wiphy_wowlan_support_flags - WoWLAN support flags
3023 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3024 * trigger that keeps the device operating as-is and
3025 * wakes up the host on any activity, for example a
3026 * received packet that passed filtering; note that the
3027 * packet should be preserved in that case
3028 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3030 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3031 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3032 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3033 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3034 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3035 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3036 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3038 enum wiphy_wowlan_support_flags {
3039 WIPHY_WOWLAN_ANY = BIT(0),
3040 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
3041 WIPHY_WOWLAN_DISCONNECT = BIT(2),
3042 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
3043 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
3044 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
3045 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
3046 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
3047 WIPHY_WOWLAN_NET_DETECT = BIT(8),
3050 struct wiphy_wowlan_tcp_support {
3051 const struct nl80211_wowlan_tcp_data_token_feature *tok;
3052 u32 data_payload_max;
3053 u32 data_interval_max;
3054 u32 wake_payload_max;
3059 * struct wiphy_wowlan_support - WoWLAN support data
3060 * @flags: see &enum wiphy_wowlan_support_flags
3061 * @n_patterns: number of supported wakeup patterns
3062 * (see nl80211.h for the pattern definition)
3063 * @pattern_max_len: maximum length of each pattern
3064 * @pattern_min_len: minimum length of each pattern
3065 * @max_pkt_offset: maximum Rx packet offset
3066 * @max_nd_match_sets: maximum number of matchsets for net-detect,
3067 * similar, but not necessarily identical, to max_match_sets for
3069 * See &struct cfg80211_sched_scan_request.@match_sets for more
3071 * @tcp: TCP wakeup support information
3073 struct wiphy_wowlan_support {
3076 int pattern_max_len;
3077 int pattern_min_len;
3079 int max_nd_match_sets;
3080 const struct wiphy_wowlan_tcp_support *tcp;
3084 * struct wiphy_coalesce_support - coalesce support data
3085 * @n_rules: maximum number of coalesce rules
3086 * @max_delay: maximum supported coalescing delay in msecs
3087 * @n_patterns: number of supported patterns in a rule
3088 * (see nl80211.h for the pattern definition)
3089 * @pattern_max_len: maximum length of each pattern
3090 * @pattern_min_len: minimum length of each pattern
3091 * @max_pkt_offset: maximum Rx packet offset
3093 struct wiphy_coalesce_support {
3097 int pattern_max_len;
3098 int pattern_min_len;
3103 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3104 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3105 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3106 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3107 * (must be combined with %_WDEV or %_NETDEV)
3109 enum wiphy_vendor_command_flags {
3110 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3111 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3112 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3116 * struct wiphy_vendor_command - vendor command definition
3117 * @info: vendor command identifying information, as used in nl80211
3118 * @flags: flags, see &enum wiphy_vendor_command_flags
3119 * @doit: callback for the operation, note that wdev is %NULL if the
3120 * flags didn't ask for a wdev and non-%NULL otherwise; the data
3121 * pointer may be %NULL if userspace provided no data at all
3122 * @dumpit: dump callback, for transferring bigger/multiple items. The
3123 * @storage points to cb->args[5], ie. is preserved over the multiple
3125 * It's recommended to not have the same sub command with both @doit and
3126 * @dumpit, so that userspace can assume certain ones are get and others
3127 * are used with dump requests.
3129 struct wiphy_vendor_command {
3130 struct nl80211_vendor_cmd_info info;
3132 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3133 const void *data, int data_len);
3134 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3135 struct sk_buff *skb, const void *data, int data_len,
3136 unsigned long *storage);
3140 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3141 * @iftype: interface type
3142 * @extended_capabilities: extended capabilities supported by the driver,
3143 * additional capabilities might be supported by userspace; these are the
3144 * 802.11 extended capabilities ("Extended Capabilities element") and are
3145 * in the same format as in the information element. See IEEE Std
3146 * 802.11-2012 8.4.2.29 for the defined fields.
3147 * @extended_capabilities_mask: mask of the valid values
3148 * @extended_capabilities_len: length of the extended capabilities
3150 struct wiphy_iftype_ext_capab {
3151 enum nl80211_iftype iftype;
3152 const u8 *extended_capabilities;
3153 const u8 *extended_capabilities_mask;
3154 u8 extended_capabilities_len;
3158 * struct wiphy - wireless hardware description
3159 * @reg_notifier: the driver's regulatory notification callback,
3160 * note that if your driver uses wiphy_apply_custom_regulatory()
3161 * the reg_notifier's request can be passed as NULL
3162 * @regd: the driver's regulatory domain, if one was requested via
3163 * the regulatory_hint() API. This can be used by the driver
3164 * on the reg_notifier() if it chooses to ignore future
3165 * regulatory domain changes caused by other drivers.
3166 * @signal_type: signal type reported in &struct cfg80211_bss.
3167 * @cipher_suites: supported cipher suites
3168 * @n_cipher_suites: number of supported cipher suites
3169 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3170 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3171 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3172 * -1 = fragmentation disabled, only odd values >= 256 used
3173 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3174 * @_net: the network namespace this wiphy currently lives in
3175 * @perm_addr: permanent MAC address of this device
3176 * @addr_mask: If the device supports multiple MAC addresses by masking,
3177 * set this to a mask with variable bits set to 1, e.g. if the last
3178 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
3179 * variable bits shall be determined by the interfaces added, with
3180 * interfaces not matching the mask being rejected to be brought up.
3181 * @n_addresses: number of addresses in @addresses.
3182 * @addresses: If the device has more than one address, set this pointer
3183 * to a list of addresses (6 bytes each). The first one will be used
3184 * by default for perm_addr. In this case, the mask should be set to
3185 * all-zeroes. In this case it is assumed that the device can handle
3186 * the same number of arbitrary MAC addresses.
3187 * @registered: protects ->resume and ->suspend sysfs callbacks against
3188 * unregister hardware
3189 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3190 * automatically on wiphy renames
3191 * @dev: (virtual) struct device for this wiphy
3192 * @registered: helps synchronize suspend/resume with wiphy unregister
3193 * @wext: wireless extension handlers
3194 * @priv: driver private data (sized according to wiphy_new() parameter)
3195 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3196 * must be set by driver
3197 * @iface_combinations: Valid interface combinations array, should not
3198 * list single interface types.
3199 * @n_iface_combinations: number of entries in @iface_combinations array.
3200 * @software_iftypes: bitmask of software interface types, these are not
3201 * subject to any restrictions since they are purely managed in SW.
3202 * @flags: wiphy flags, see &enum wiphy_flags
3203 * @regulatory_flags: wiphy regulatory flags, see
3204 * &enum ieee80211_regulatory_flags
3205 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3206 * @ext_features: extended features advertised to nl80211, see
3207 * &enum nl80211_ext_feature_index.
3208 * @bss_priv_size: each BSS struct has private data allocated with it,
3209 * this variable determines its size
3210 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3212 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3213 * for in any given scheduled scan
3214 * @max_match_sets: maximum number of match sets the device can handle
3215 * when performing a scheduled scan, 0 if filtering is not
3217 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3218 * add to probe request frames transmitted during a scan, must not
3219 * include fixed IEs like supported rates
3220 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3222 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3223 * of iterations) for scheduled scan supported by the device.
3224 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3225 * single scan plan supported by the device.
3226 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3227 * scan plan supported by the device.
3228 * @coverage_class: current coverage class
3229 * @fw_version: firmware version for ethtool reporting
3230 * @hw_version: hardware version for ethtool reporting
3231 * @max_num_pmkids: maximum number of PMKIDs supported by device
3232 * @privid: a pointer that drivers can use to identify if an arbitrary
3233 * wiphy is theirs, e.g. in global notifiers
3234 * @bands: information about bands/channels supported by this device
3236 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3237 * transmitted through nl80211, points to an array indexed by interface
3240 * @available_antennas_tx: bitmap of antennas which are available to be
3241 * configured as TX antennas. Antenna configuration commands will be
3242 * rejected unless this or @available_antennas_rx is set.
3244 * @available_antennas_rx: bitmap of antennas which are available to be
3245 * configured as RX antennas. Antenna configuration commands will be
3246 * rejected unless this or @available_antennas_tx is set.
3248 * @probe_resp_offload:
3249 * Bitmap of supported protocols for probe response offloading.
3250 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3251 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3253 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3254 * may request, if implemented.
3256 * @wowlan: WoWLAN support information
3257 * @wowlan_config: current WoWLAN configuration; this should usually not be
3258 * used since access to it is necessarily racy, use the parameter passed
3259 * to the suspend() operation instead.
3261 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3262 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3263 * If null, then none can be over-ridden.
3264 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3265 * If null, then none can be over-ridden.
3267 * @wdev_list: the list of associated (virtual) interfaces; this list must
3268 * not be modified by the driver, but can be read with RTNL/RCU protection.
3270 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3273 * @extended_capabilities: extended capabilities supported by the driver,
3274 * additional capabilities might be supported by userspace; these are
3275 * the 802.11 extended capabilities ("Extended Capabilities element")
3276 * and are in the same format as in the information element. See
3277 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
3278 * extended capabilities to be used if the capabilities are not specified
3279 * for a specific interface type in iftype_ext_capab.
3280 * @extended_capabilities_mask: mask of the valid values
3281 * @extended_capabilities_len: length of the extended capabilities
3282 * @iftype_ext_capab: array of extended capabilities per interface type
3283 * @num_iftype_ext_capab: number of interface types for which extended
3284 * capabilities are specified separately.
3285 * @coalesce: packet coalescing support information
3287 * @vendor_commands: array of vendor commands supported by the hardware
3288 * @n_vendor_commands: number of vendor commands
3289 * @vendor_events: array of vendor events supported by the hardware
3290 * @n_vendor_events: number of vendor events
3292 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3293 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3294 * driver is allowed to advertise a theoretical limit that it can reach in
3295 * some cases, but may not always reach.
3297 * @max_num_csa_counters: Number of supported csa_counters in beacons
3298 * and probe responses. This value should be set if the driver
3299 * wishes to limit the number of csa counters. Default (0) means
3301 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3302 * frame was sent and the channel on which the frame was heard for which
3303 * the reported rssi is still valid. If a driver is able to compensate the
3304 * low rssi when a frame is heard on different channel, then it should set
3305 * this variable to the maximal offset for which it can compensate.
3306 * This value should be set in MHz.
3307 * @bss_select_support: bitmask indicating the BSS selection criteria supported
3308 * by the driver in the .connect() callback. The bit position maps to the
3309 * attribute indices defined in &enum nl80211_bss_select_attr.
3312 /* assign these fields before you register the wiphy */
3314 /* permanent MAC address(es) */
3315 u8 perm_addr[ETH_ALEN];
3316 u8 addr_mask[ETH_ALEN];
3318 struct mac_address *addresses;
3320 const struct ieee80211_txrx_stypes *mgmt_stypes;
3322 const struct ieee80211_iface_combination *iface_combinations;
3323 int n_iface_combinations;
3324 u16 software_iftypes;
3328 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3329 u16 interface_modes;
3331 u16 max_acl_mac_addrs;
3333 u32 flags, regulatory_flags, features;
3334 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3338 enum cfg80211_signal_type signal_type;
3342 u8 max_sched_scan_ssids;
3344 u16 max_scan_ie_len;
3345 u16 max_sched_scan_ie_len;
3346 u32 max_sched_scan_plans;
3347 u32 max_sched_scan_plan_interval;
3348 u32 max_sched_scan_plan_iterations;
3350 int n_cipher_suites;
3351 const u32 *cipher_suites;
3359 char fw_version[ETHTOOL_FWVERS_LEN];
3363 const struct wiphy_wowlan_support *wowlan;
3364 struct cfg80211_wowlan *wowlan_config;
3367 u16 max_remain_on_channel_duration;
3371 u32 available_antennas_tx;
3372 u32 available_antennas_rx;
3375 * Bitmap of supported protocols for probe response offloading
3376 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3377 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3379 u32 probe_resp_offload;
3381 const u8 *extended_capabilities, *extended_capabilities_mask;
3382 u8 extended_capabilities_len;
3384 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
3385 unsigned int num_iftype_ext_capab;
3387 /* If multiple wiphys are registered and you're handed e.g.
3388 * a regular netdev with assigned ieee80211_ptr, you won't
3389 * know whether it points to a wiphy your driver has registered
3390 * or not. Assign this to something global to your driver to
3391 * help determine whether you own this wiphy or not. */
3394 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
3396 /* Lets us get back the wiphy on the callback */
3397 void (*reg_notifier)(struct wiphy *wiphy,
3398 struct regulatory_request *request);
3400 /* fields below are read-only, assigned by cfg80211 */
3402 const struct ieee80211_regdomain __rcu *regd;
3404 /* the item in /sys/class/ieee80211/ points to this,
3405 * you need use set_wiphy_dev() (see below) */
3408 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3411 /* dir in debugfs: ieee80211/<wiphyname> */
3412 struct dentry *debugfsdir;
3414 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3415 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3417 struct list_head wdev_list;
3419 /* the network namespace this phy lives in currently */
3420 possible_net_t _net;
3422 #ifdef CONFIG_CFG80211_WEXT
3423 const struct iw_handler_def *wext;
3426 const struct wiphy_coalesce_support *coalesce;
3428 const struct wiphy_vendor_command *vendor_commands;
3429 const struct nl80211_vendor_cmd_info *vendor_events;
3430 int n_vendor_commands, n_vendor_events;
3432 u16 max_ap_assoc_sta;
3434 u8 max_num_csa_counters;
3435 u8 max_adj_channel_rssi_comp;
3437 u32 bss_select_support;
3439 char priv[0] __aligned(NETDEV_ALIGN);
3442 static inline struct net *wiphy_net(struct wiphy *wiphy)
3444 return read_pnet(&wiphy->_net);
3447 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3449 write_pnet(&wiphy->_net, net);
3453 * wiphy_priv - return priv from wiphy
3455 * @wiphy: the wiphy whose priv pointer to return
3456 * Return: The priv of @wiphy.
3458 static inline void *wiphy_priv(struct wiphy *wiphy)
3461 return &wiphy->priv;
3465 * priv_to_wiphy - return the wiphy containing the priv
3467 * @priv: a pointer previously returned by wiphy_priv
3468 * Return: The wiphy of @priv.
3470 static inline struct wiphy *priv_to_wiphy(void *priv)
3473 return container_of(priv, struct wiphy, priv);
3477 * set_wiphy_dev - set device pointer for wiphy
3479 * @wiphy: The wiphy whose device to bind
3480 * @dev: The device to parent it to
3482 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3484 wiphy->dev.parent = dev;
3488 * wiphy_dev - get wiphy dev pointer
3490 * @wiphy: The wiphy whose device struct to look up
3491 * Return: The dev of @wiphy.
3493 static inline struct device *wiphy_dev(struct wiphy *wiphy)
3495 return wiphy->dev.parent;
3499 * wiphy_name - get wiphy name
3501 * @wiphy: The wiphy whose name to return
3502 * Return: The name of @wiphy.
3504 static inline const char *wiphy_name(const struct wiphy *wiphy)
3506 return dev_name(&wiphy->dev);
3510 * wiphy_new_nm - create a new wiphy for use with cfg80211
3512 * @ops: The configuration operations for this device
3513 * @sizeof_priv: The size of the private area to allocate
3514 * @requested_name: Request a particular name.
3515 * NULL is valid value, and means use the default phy%d naming.
3517 * Create a new wiphy and associate the given operations with it.
3518 * @sizeof_priv bytes are allocated for private use.
3520 * Return: A pointer to the new wiphy. This pointer must be
3521 * assigned to each netdev's ieee80211_ptr for proper operation.
3523 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3524 const char *requested_name);
3527 * wiphy_new - create a new wiphy for use with cfg80211
3529 * @ops: The configuration operations for this device
3530 * @sizeof_priv: The size of the private area to allocate
3532 * Create a new wiphy and associate the given operations with it.
3533 * @sizeof_priv bytes are allocated for private use.
3535 * Return: A pointer to the new wiphy. This pointer must be
3536 * assigned to each netdev's ieee80211_ptr for proper operation.
3538 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3541 return wiphy_new_nm(ops, sizeof_priv, NULL);
3545 * wiphy_register - register a wiphy with cfg80211
3547 * @wiphy: The wiphy to register.
3549 * Return: A non-negative wiphy index or a negative error code.
3551 int wiphy_register(struct wiphy *wiphy);
3554 * wiphy_unregister - deregister a wiphy from cfg80211
3556 * @wiphy: The wiphy to unregister.
3558 * After this call, no more requests can be made with this priv
3559 * pointer, but the call may sleep to wait for an outstanding
3560 * request that is being handled.
3562 void wiphy_unregister(struct wiphy *wiphy);
3565 * wiphy_free - free wiphy
3567 * @wiphy: The wiphy to free
3569 void wiphy_free(struct wiphy *wiphy);
3571 /* internal structs */
3572 struct cfg80211_conn;
3573 struct cfg80211_internal_bss;
3574 struct cfg80211_cached_keys;
3577 * struct wireless_dev - wireless device state
3579 * For netdevs, this structure must be allocated by the driver
3580 * that uses the ieee80211_ptr field in struct net_device (this
3581 * is intentional so it can be allocated along with the netdev.)
3582 * It need not be registered then as netdev registration will
3583 * be intercepted by cfg80211 to see the new wireless device.
3585 * For non-netdev uses, it must also be allocated by the driver
3586 * in response to the cfg80211 callbacks that require it, as
3587 * there's no netdev registration in that case it may not be
3588 * allocated outside of callback operations that return it.
3590 * @wiphy: pointer to hardware description
3591 * @iftype: interface type
3592 * @list: (private) Used to collect the interfaces
3593 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3594 * @identifier: (private) Identifier used in nl80211 to identify this
3595 * wireless device if it has no netdev
3596 * @current_bss: (private) Used by the internal configuration code
3597 * @chandef: (private) Used by the internal configuration code to track
3598 * the user-set channel definition.
3599 * @preset_chandef: (private) Used by the internal configuration code to
3600 * track the channel to be used for AP later
3601 * @bssid: (private) Used by the internal configuration code
3602 * @ssid: (private) Used by the internal configuration code
3603 * @ssid_len: (private) Used by the internal configuration code
3604 * @mesh_id_len: (private) Used by the internal configuration code
3605 * @mesh_id_up_len: (private) Used by the internal configuration code
3606 * @wext: (private) Used by the internal wireless extensions compat code
3607 * @use_4addr: indicates 4addr mode is used on this interface, must be
3608 * set by driver (if supported) on add_interface BEFORE registering the
3609 * netdev and may otherwise be used by driver read-only, will be update
3610 * by cfg80211 on change_interface
3611 * @mgmt_registrations: list of registrations for management frames
3612 * @mgmt_registrations_lock: lock for the list
3613 * @mtx: mutex used to lock data in this struct, may be used by drivers
3614 * and some API functions require it held
3615 * @beacon_interval: beacon interval used on this device for transmitting
3616 * beacons, 0 when not valid
3617 * @address: The address for this device, valid only if @netdev is %NULL
3618 * @p2p_started: true if this is a P2P Device that has been started
3619 * @cac_started: true if DFS channel availability check has been started
3620 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3621 * @cac_time_ms: CAC time in ms
3622 * @ps: powersave mode is enabled
3623 * @ps_timeout: dynamic powersave timeout
3624 * @ap_unexpected_nlportid: (private) netlink port ID of application
3625 * registered for unexpected class 3 frames (AP mode)
3626 * @conn: (private) cfg80211 software SME connection state machine data
3627 * @connect_keys: (private) keys to set after connection is established
3628 * @conn_bss_type: connecting/connected BSS type
3629 * @ibss_fixed: (private) IBSS is using fixed BSSID
3630 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3631 * @event_list: (private) list for internal event processing
3632 * @event_lock: (private) lock for event list
3633 * @owner_nlportid: (private) owner socket port ID
3635 struct wireless_dev {
3636 struct wiphy *wiphy;
3637 enum nl80211_iftype iftype;
3639 /* the remainder of this struct should be private to cfg80211 */
3640 struct list_head list;
3641 struct net_device *netdev;
3645 struct list_head mgmt_registrations;
3646 spinlock_t mgmt_registrations_lock;
3650 bool use_4addr, p2p_started;
3652 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3654 /* currently used for IBSS and SME - might be rearranged later */
3655 u8 ssid[IEEE80211_MAX_SSID_LEN];
3656 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3657 struct cfg80211_conn *conn;
3658 struct cfg80211_cached_keys *connect_keys;
3659 enum ieee80211_bss_type conn_bss_type;
3661 struct list_head event_list;
3662 spinlock_t event_lock;
3664 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3665 struct cfg80211_chan_def preset_chandef;
3666 struct cfg80211_chan_def chandef;
3669 bool ibss_dfs_possible;
3674 int beacon_interval;
3676 u32 ap_unexpected_nlportid;
3679 unsigned long cac_start_time;
3680 unsigned int cac_time_ms;
3684 #ifdef CONFIG_CFG80211_WEXT
3687 struct cfg80211_ibss_params ibss;
3688 struct cfg80211_connect_params connect;
3689 struct cfg80211_cached_keys *keys;
3692 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3693 u8 ssid[IEEE80211_MAX_SSID_LEN];
3694 s8 default_key, default_mgmt_key;
3695 bool prev_bssid_valid;
3700 static inline u8 *wdev_address(struct wireless_dev *wdev)
3703 return wdev->netdev->dev_addr;
3704 return wdev->address;
3708 * wdev_priv - return wiphy priv from wireless_dev
3710 * @wdev: The wireless device whose wiphy's priv pointer to return
3711 * Return: The wiphy priv of @wdev.
3713 static inline void *wdev_priv(struct wireless_dev *wdev)
3716 return wiphy_priv(wdev->wiphy);
3720 * DOC: Utility functions
3722 * cfg80211 offers a number of utility functions that can be useful.
3726 * ieee80211_channel_to_frequency - convert channel number to frequency
3727 * @chan: channel number
3728 * @band: band, necessary due to channel number overlap
3729 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3731 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
3734 * ieee80211_frequency_to_channel - convert frequency to channel number
3735 * @freq: center frequency
3736 * Return: The corresponding channel, or 0 if the conversion failed.
3738 int ieee80211_frequency_to_channel(int freq);
3741 * Name indirection necessary because the ieee80211 code also has
3742 * a function named "ieee80211_get_channel", so if you include
3743 * cfg80211's header file you get cfg80211's version, if you try
3744 * to include both header files you'll (rightfully!) get a symbol
3747 struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3750 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3751 * @wiphy: the struct wiphy to get the channel for
3752 * @freq: the center frequency of the channel
3753 * Return: The channel struct from @wiphy at @freq.
3755 static inline struct ieee80211_channel *
3756 ieee80211_get_channel(struct wiphy *wiphy, int freq)
3758 return __ieee80211_get_channel(wiphy, freq);
3762 * ieee80211_get_response_rate - get basic rate for a given rate
3764 * @sband: the band to look for rates in
3765 * @basic_rates: bitmap of basic rates
3766 * @bitrate: the bitrate for which to find the basic rate
3768 * Return: The basic rate corresponding to a given bitrate, that
3769 * is the next lower bitrate contained in the basic rate map,
3770 * which is, for this function, given as a bitmap of indices of
3771 * rates in the band's bitrate table.
3773 struct ieee80211_rate *
3774 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3775 u32 basic_rates, int bitrate);
3778 * ieee80211_mandatory_rates - get mandatory rates for a given band
3779 * @sband: the band to look for rates in
3780 * @scan_width: width of the control channel
3782 * This function returns a bitmap of the mandatory rates for the given
3783 * band, bits are set according to the rate position in the bitrates array.
3785 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3786 enum nl80211_bss_scan_width scan_width);
3789 * Radiotap parsing functions -- for controlled injection support
3791 * Implemented in net/wireless/radiotap.c
3792 * Documentation in Documentation/networking/radiotap-headers.txt
3795 struct radiotap_align_size {
3796 uint8_t align:4, size:4;
3799 struct ieee80211_radiotap_namespace {
3800 const struct radiotap_align_size *align_size;
3806 struct ieee80211_radiotap_vendor_namespaces {
3807 const struct ieee80211_radiotap_namespace *ns;
3812 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3813 * @this_arg_index: index of current arg, valid after each successful call
3814 * to ieee80211_radiotap_iterator_next()
3815 * @this_arg: pointer to current radiotap arg; it is valid after each
3816 * call to ieee80211_radiotap_iterator_next() but also after
3817 * ieee80211_radiotap_iterator_init() where it will point to
3818 * the beginning of the actual data portion
3819 * @this_arg_size: length of the current arg, for convenience
3820 * @current_namespace: pointer to the current namespace definition
3821 * (or internally %NULL if the current namespace is unknown)
3822 * @is_radiotap_ns: indicates whether the current namespace is the default
3823 * radiotap namespace or not
3825 * @_rtheader: pointer to the radiotap header we are walking through
3826 * @_max_length: length of radiotap header in cpu byte ordering
3827 * @_arg_index: next argument index
3828 * @_arg: next argument pointer
3829 * @_next_bitmap: internal pointer to next present u32
3830 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3831 * @_vns: vendor namespace definitions
3832 * @_next_ns_data: beginning of the next namespace's data
3833 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3836 * Describes the radiotap parser state. Fields prefixed with an underscore
3837 * must not be used by users of the parser, only by the parser internally.
3840 struct ieee80211_radiotap_iterator {
3841 struct ieee80211_radiotap_header *_rtheader;
3842 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3843 const struct ieee80211_radiotap_namespace *current_namespace;
3845 unsigned char *_arg, *_next_ns_data;
3846 __le32 *_next_bitmap;
3848 unsigned char *this_arg;
3856 uint32_t _bitmap_shifter;
3861 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3862 struct ieee80211_radiotap_header *radiotap_header,
3864 const struct ieee80211_radiotap_vendor_namespaces *vns);
3867 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3870 extern const unsigned char rfc1042_header[6];
3871 extern const unsigned char bridge_tunnel_header[6];
3874 * ieee80211_get_hdrlen_from_skb - get header length from data
3878 * Given an skb with a raw 802.11 header at the data pointer this function
3879 * returns the 802.11 header length.
3881 * Return: The 802.11 header length in bytes (not including encryption
3882 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3885 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3888 * ieee80211_hdrlen - get header length in bytes from frame control
3889 * @fc: frame control field in little-endian format
3890 * Return: The header length in bytes.
3892 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3895 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3896 * @meshhdr: the mesh extension header, only the flags field
3897 * (first byte) will be accessed
3898 * Return: The length of the extension header, which is always at
3899 * least 6 bytes and at most 18 if address 5 and 6 are present.
3901 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3904 * DOC: Data path helpers
3906 * In addition to generic utilities, cfg80211 also offers
3907 * functions that help implement the data path for devices
3908 * that do not do the 802.11/802.3 conversion on the device.
3912 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3913 * @skb: the 802.11 data frame
3914 * @addr: the device MAC address
3915 * @iftype: the virtual interface type
3916 * Return: 0 on success. Non-zero on error.
3918 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3919 enum nl80211_iftype iftype);
3922 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3923 * @skb: the 802.3 frame
3924 * @addr: the device MAC address
3925 * @iftype: the virtual interface type
3926 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3927 * @qos: build 802.11 QoS data frame
3928 * Return: 0 on success, or a negative error code.
3930 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3931 enum nl80211_iftype iftype, const u8 *bssid,
3935 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3937 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3938 * 802.3 frames. The @list will be empty if the decode fails. The
3939 * @skb is consumed after the function returns.
3941 * @skb: The input IEEE 802.11n A-MSDU frame.
3942 * @list: The output list of 802.3 frames. It must be allocated and
3943 * initialized by by the caller.
3944 * @addr: The device MAC address.
3945 * @iftype: The device interface type.
3946 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3947 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3949 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3950 const u8 *addr, enum nl80211_iftype iftype,
3951 const unsigned int extra_headroom,
3952 bool has_80211_header);
3955 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3956 * @skb: the data frame
3957 * @qos_map: Interworking QoS mapping or %NULL if not in use
3958 * Return: The 802.1p/1d tag.
3960 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3961 struct cfg80211_qos_map *qos_map);
3964 * cfg80211_find_ie_match - match information element and byte array in data
3967 * @ies: data consisting of IEs
3968 * @len: length of data
3969 * @match: byte array to match
3970 * @match_len: number of bytes in the match array
3971 * @match_offset: offset in the IE where the byte array should match.
3972 * If match_len is zero, this must also be set to zero.
3973 * Otherwise this must be set to 2 or more, because the first
3974 * byte is the element id, which is already compared to eid, and
3975 * the second byte is the IE length.
3977 * Return: %NULL if the element ID could not be found or if
3978 * the element is invalid (claims to be longer than the given
3979 * data) or if the byte array doesn't match, or a pointer to the first
3980 * byte of the requested element, that is the byte containing the
3983 * Note: There are no checks on the element length other than
3984 * having to fit into the given data and being large enough for the
3985 * byte array to match.
3987 const u8 *cfg80211_find_ie_match(u8 eid, const u8 *ies, int len,
3988 const u8 *match, int match_len,
3992 * cfg80211_find_ie - find information element in data
3995 * @ies: data consisting of IEs
3996 * @len: length of data
3998 * Return: %NULL if the element ID could not be found or if
3999 * the element is invalid (claims to be longer than the given
4000 * data), or a pointer to the first byte of the requested
4001 * element, that is the byte containing the element ID.
4003 * Note: There are no checks on the element length other than
4004 * having to fit into the given data.
4006 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
4008 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
4012 * cfg80211_find_vendor_ie - find vendor specific information element in data
4015 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
4016 * @ies: data consisting of IEs
4017 * @len: length of data
4019 * Return: %NULL if the vendor specific element ID could not be found or if the
4020 * element is invalid (claims to be longer than the given data), or a pointer to
4021 * the first byte of the requested element, that is the byte containing the
4024 * Note: There are no checks on the element length other than having to fit into
4027 const u8 *cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
4028 const u8 *ies, int len);
4031 * DOC: Regulatory enforcement infrastructure
4037 * regulatory_hint - driver hint to the wireless core a regulatory domain
4038 * @wiphy: the wireless device giving the hint (used only for reporting
4040 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
4041 * should be in. If @rd is set this should be NULL. Note that if you
4042 * set this to NULL you should still set rd->alpha2 to some accepted
4045 * Wireless drivers can use this function to hint to the wireless core
4046 * what it believes should be the current regulatory domain by
4047 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4048 * domain should be in or by providing a completely build regulatory domain.
4049 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4050 * for a regulatory domain structure for the respective country.
4052 * The wiphy must have been registered to cfg80211 prior to this call.
4053 * For cfg80211 drivers this means you must first use wiphy_register(),
4054 * for mac80211 drivers you must first use ieee80211_register_hw().
4056 * Drivers should check the return value, its possible you can get
4059 * Return: 0 on success. -ENOMEM.
4061 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
4064 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4065 * @wiphy: the wireless device we want to process the regulatory domain on
4066 * @rd: the regulatory domain informatoin to use for this wiphy
4068 * Set the regulatory domain information for self-managed wiphys, only they
4069 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4072 * Return: 0 on success. -EINVAL, -EPERM
4074 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
4075 struct ieee80211_regdomain *rd);
4078 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4079 * @wiphy: the wireless device we want to process the regulatory domain on
4080 * @rd: the regulatory domain information to use for this wiphy
4082 * This functions requires the RTNL to be held and applies the new regdomain
4083 * synchronously to this wiphy. For more details see
4084 * regulatory_set_wiphy_regd().
4086 * Return: 0 on success. -EINVAL, -EPERM
4088 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
4089 struct ieee80211_regdomain *rd);
4092 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4093 * @wiphy: the wireless device we want to process the regulatory domain on
4094 * @regd: the custom regulatory domain to use for this wiphy
4096 * Drivers can sometimes have custom regulatory domains which do not apply
4097 * to a specific country. Drivers can use this to apply such custom regulatory
4098 * domains. This routine must be called prior to wiphy registration. The
4099 * custom regulatory domain will be trusted completely and as such previous
4100 * default channel settings will be disregarded. If no rule is found for a
4101 * channel on the regulatory domain the channel will be disabled.
4102 * Drivers using this for a wiphy should also set the wiphy flag
4103 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4104 * that called this helper.
4106 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
4107 const struct ieee80211_regdomain *regd);
4110 * freq_reg_info - get regulatory information for the given frequency
4111 * @wiphy: the wiphy for which we want to process this rule for
4112 * @center_freq: Frequency in KHz for which we want regulatory information for
4114 * Use this function to get the regulatory rule for a specific frequency on
4115 * a given wireless device. If the device has a specific regulatory domain
4116 * it wants to follow we respect that unless a country IE has been received
4117 * and processed already.
4119 * Return: A valid pointer, or, when an error occurs, for example if no rule
4120 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4121 * check and PTR_ERR() to obtain the numeric return value. The numeric return
4122 * value will be -ERANGE if we determine the given center_freq does not even
4123 * have a regulatory rule for a frequency range in the center_freq's band.
4124 * See freq_in_rule_band() for our current definition of a band -- this is
4125 * purely subjective and right now it's 802.11 specific.
4127 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
4131 * reg_initiator_name - map regulatory request initiator enum to name
4132 * @initiator: the regulatory request initiator
4134 * You can use this to map the regulatory request initiator enum to a
4135 * proper string representation.
4137 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
4140 * callbacks for asynchronous cfg80211 methods, notification
4141 * functions and BSS handling helpers
4145 * cfg80211_scan_done - notify that scan finished
4147 * @request: the corresponding scan request
4148 * @info: information about the completed scan
4150 void cfg80211_scan_done(struct cfg80211_scan_request *request,
4151 struct cfg80211_scan_info *info);
4154 * cfg80211_sched_scan_results - notify that new scan results are available
4156 * @wiphy: the wiphy which got scheduled scan results
4158 void cfg80211_sched_scan_results(struct wiphy *wiphy);
4161 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4163 * @wiphy: the wiphy on which the scheduled scan stopped
4165 * The driver can call this function to inform cfg80211 that the
4166 * scheduled scan had to be stopped, for whatever reason. The driver
4167 * is then called back via the sched_scan_stop operation when done.
4169 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
4172 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4174 * @wiphy: the wiphy on which the scheduled scan stopped
4176 * The driver can call this function to inform cfg80211 that the
4177 * scheduled scan had to be stopped, for whatever reason. The driver
4178 * is then called back via the sched_scan_stop operation when done.
4179 * This function should be called with rtnl locked.
4181 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
4184 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4185 * @wiphy: the wiphy reporting the BSS
4186 * @data: the BSS metadata
4187 * @mgmt: the management frame (probe response or beacon)
4188 * @len: length of the management frame
4189 * @gfp: context flags
4191 * This informs cfg80211 that BSS information was found and
4192 * the BSS should be updated/added.
4194 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4195 * Or %NULL on error.
4197 struct cfg80211_bss * __must_check
4198 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4199 struct cfg80211_inform_bss *data,
4200 struct ieee80211_mgmt *mgmt, size_t len,
4203 static inline struct cfg80211_bss * __must_check
4204 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4205 struct ieee80211_channel *rx_channel,
4206 enum nl80211_bss_scan_width scan_width,
4207 struct ieee80211_mgmt *mgmt, size_t len,
4208 s32 signal, gfp_t gfp)
4210 struct cfg80211_inform_bss data = {
4212 .scan_width = scan_width,
4216 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4219 static inline struct cfg80211_bss * __must_check
4220 cfg80211_inform_bss_frame(struct wiphy *wiphy,
4221 struct ieee80211_channel *rx_channel,
4222 struct ieee80211_mgmt *mgmt, size_t len,
4223 s32 signal, gfp_t gfp)
4225 struct cfg80211_inform_bss data = {
4227 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4231 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4235 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4236 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4237 * from a beacon or probe response
4238 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4239 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4241 enum cfg80211_bss_frame_type {
4242 CFG80211_BSS_FTYPE_UNKNOWN,
4243 CFG80211_BSS_FTYPE_BEACON,
4244 CFG80211_BSS_FTYPE_PRESP,
4248 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4250 * @wiphy: the wiphy reporting the BSS
4251 * @data: the BSS metadata
4252 * @ftype: frame type (if known)
4253 * @bssid: the BSSID of the BSS
4254 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4255 * @capability: the capability field sent by the peer
4256 * @beacon_interval: the beacon interval announced by the peer
4257 * @ie: additional IEs sent by the peer
4258 * @ielen: length of the additional IEs
4259 * @gfp: context flags
4261 * This informs cfg80211 that BSS information was found and
4262 * the BSS should be updated/added.
4264 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4265 * Or %NULL on error.
4267 struct cfg80211_bss * __must_check
4268 cfg80211_inform_bss_data(struct wiphy *wiphy,
4269 struct cfg80211_inform_bss *data,
4270 enum cfg80211_bss_frame_type ftype,
4271 const u8 *bssid, u64 tsf, u16 capability,
4272 u16 beacon_interval, const u8 *ie, size_t ielen,
4275 static inline struct cfg80211_bss * __must_check
4276 cfg80211_inform_bss_width(struct wiphy *wiphy,
4277 struct ieee80211_channel *rx_channel,
4278 enum nl80211_bss_scan_width scan_width,
4279 enum cfg80211_bss_frame_type ftype,
4280 const u8 *bssid, u64 tsf, u16 capability,
4281 u16 beacon_interval, const u8 *ie, size_t ielen,
4282 s32 signal, gfp_t gfp)
4284 struct cfg80211_inform_bss data = {
4286 .scan_width = scan_width,
4290 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4291 capability, beacon_interval, ie, ielen,
4295 static inline struct cfg80211_bss * __must_check
4296 cfg80211_inform_bss(struct wiphy *wiphy,
4297 struct ieee80211_channel *rx_channel,
4298 enum cfg80211_bss_frame_type ftype,
4299 const u8 *bssid, u64 tsf, u16 capability,
4300 u16 beacon_interval, const u8 *ie, size_t ielen,
4301 s32 signal, gfp_t gfp)
4303 struct cfg80211_inform_bss data = {
4305 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4309 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4310 capability, beacon_interval, ie, ielen,
4314 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4315 struct ieee80211_channel *channel,
4317 const u8 *ssid, size_t ssid_len,
4318 enum ieee80211_bss_type bss_type,
4319 enum ieee80211_privacy);
4320 static inline struct cfg80211_bss *
4321 cfg80211_get_ibss(struct wiphy *wiphy,
4322 struct ieee80211_channel *channel,
4323 const u8 *ssid, size_t ssid_len)
4325 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4326 IEEE80211_BSS_TYPE_IBSS,
4327 IEEE80211_PRIVACY_ANY);
4331 * cfg80211_ref_bss - reference BSS struct
4332 * @wiphy: the wiphy this BSS struct belongs to
4333 * @bss: the BSS struct to reference
4335 * Increments the refcount of the given BSS struct.
4337 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4340 * cfg80211_put_bss - unref BSS struct
4341 * @wiphy: the wiphy this BSS struct belongs to
4342 * @bss: the BSS struct
4344 * Decrements the refcount of the given BSS struct.
4346 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4349 * cfg80211_unlink_bss - unlink BSS from internal data structures
4351 * @bss: the bss to remove
4353 * This function removes the given BSS from the internal data structures
4354 * thereby making it no longer show up in scan results etc. Use this
4355 * function when you detect a BSS is gone. Normally BSSes will also time
4356 * out, so it is not necessary to use this function at all.
4358 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4360 static inline enum nl80211_bss_scan_width
4361 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4363 switch (chandef->width) {
4364 case NL80211_CHAN_WIDTH_5:
4365 return NL80211_BSS_CHAN_WIDTH_5;
4366 case NL80211_CHAN_WIDTH_10:
4367 return NL80211_BSS_CHAN_WIDTH_10;
4369 return NL80211_BSS_CHAN_WIDTH_20;
4374 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4375 * @dev: network device
4376 * @buf: authentication frame (header + body)
4377 * @len: length of the frame data
4379 * This function is called whenever an authentication, disassociation or
4380 * deauthentication frame has been received and processed in station mode.
4381 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4382 * call either this function or cfg80211_auth_timeout().
4383 * After being asked to associate via cfg80211_ops::assoc() the driver must
4384 * call either this function or cfg80211_auth_timeout().
4385 * While connected, the driver must calls this for received and processed
4386 * disassociation and deauthentication frames. If the frame couldn't be used
4387 * because it was unprotected, the driver must call the function
4388 * cfg80211_rx_unprot_mlme_mgmt() instead.
4390 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4392 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4395 * cfg80211_auth_timeout - notification of timed out authentication
4396 * @dev: network device
4397 * @addr: The MAC address of the device with which the authentication timed out
4399 * This function may sleep. The caller must hold the corresponding wdev's
4402 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4405 * cfg80211_rx_assoc_resp - notification of processed association response
4406 * @dev: network device
4407 * @bss: the BSS that association was requested with, ownership of the pointer
4408 * moves to cfg80211 in this call
4409 * @buf: authentication frame (header + body)
4410 * @len: length of the frame data
4411 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
4413 * After being asked to associate via cfg80211_ops::assoc() the driver must
4414 * call either this function or cfg80211_auth_timeout().
4416 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4418 void cfg80211_rx_assoc_resp(struct net_device *dev,
4419 struct cfg80211_bss *bss,
4420 const u8 *buf, size_t len,
4424 * cfg80211_assoc_timeout - notification of timed out association
4425 * @dev: network device
4426 * @bss: The BSS entry with which association timed out.
4428 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4430 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4433 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4434 * @dev: network device
4435 * @buf: 802.11 frame (header + body)
4436 * @len: length of the frame data
4438 * This function is called whenever deauthentication has been processed in
4439 * station mode. This includes both received deauthentication frames and
4440 * locally generated ones. This function may sleep. The caller must hold the
4441 * corresponding wdev's mutex.
4443 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4446 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4447 * @dev: network device
4448 * @buf: deauthentication frame (header + body)
4449 * @len: length of the frame data
4451 * This function is called whenever a received deauthentication or dissassoc
4452 * frame has been dropped in station mode because of MFP being used but the
4453 * frame was not protected. This function may sleep.
4455 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4456 const u8 *buf, size_t len);
4459 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4460 * @dev: network device
4461 * @addr: The source MAC address of the frame
4462 * @key_type: The key type that the received frame used
4463 * @key_id: Key identifier (0..3). Can be -1 if missing.
4464 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4465 * @gfp: allocation flags
4467 * This function is called whenever the local MAC detects a MIC failure in a
4468 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4471 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4472 enum nl80211_key_type key_type, int key_id,
4473 const u8 *tsc, gfp_t gfp);
4476 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4478 * @dev: network device
4479 * @bssid: the BSSID of the IBSS joined
4480 * @channel: the channel of the IBSS joined
4481 * @gfp: allocation flags
4483 * This function notifies cfg80211 that the device joined an IBSS or
4484 * switched to a different BSSID. Before this function can be called,
4485 * either a beacon has to have been received from the IBSS, or one of
4486 * the cfg80211_inform_bss{,_frame} functions must have been called
4487 * with the locally generated beacon -- this guarantees that there is
4488 * always a scan result for this IBSS. cfg80211 will handle the rest.
4490 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4491 struct ieee80211_channel *channel, gfp_t gfp);
4494 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4496 * @dev: network device
4497 * @macaddr: the MAC address of the new candidate
4498 * @ie: information elements advertised by the peer candidate
4499 * @ie_len: lenght of the information elements buffer
4500 * @gfp: allocation flags
4502 * This function notifies cfg80211 that the mesh peer candidate has been
4503 * detected, most likely via a beacon or, less likely, via a probe response.
4504 * cfg80211 then sends a notification to userspace.
4506 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4507 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4510 * DOC: RFkill integration
4512 * RFkill integration in cfg80211 is almost invisible to drivers,
4513 * as cfg80211 automatically registers an rfkill instance for each
4514 * wireless device it knows about. Soft kill is also translated
4515 * into disconnecting and turning all interfaces off, drivers are
4516 * expected to turn off the device when all interfaces are down.
4518 * However, devices may have a hard RFkill line, in which case they
4519 * also need to interact with the rfkill subsystem, via cfg80211.
4520 * They can do this with a few helper functions documented here.
4524 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4526 * @blocked: block status
4528 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4531 * wiphy_rfkill_start_polling - start polling rfkill
4534 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4537 * wiphy_rfkill_stop_polling - stop polling rfkill
4540 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4543 * DOC: Vendor commands
4545 * Occasionally, there are special protocol or firmware features that
4546 * can't be implemented very openly. For this and similar cases, the
4547 * vendor command functionality allows implementing the features with
4548 * (typically closed-source) userspace and firmware, using nl80211 as
4549 * the configuration mechanism.
4551 * A driver supporting vendor commands must register them as an array
4552 * in struct wiphy, with handlers for each one, each command has an
4553 * OUI and sub command ID to identify it.
4555 * Note that this feature should not be (ab)used to implement protocol
4556 * features that could openly be shared across drivers. In particular,
4557 * it must never be required to use vendor commands to implement any
4558 * "normal" functionality that higher-level userspace like connection
4559 * managers etc. need.
4562 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4563 enum nl80211_commands cmd,
4564 enum nl80211_attrs attr,
4567 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4568 struct wireless_dev *wdev,
4569 enum nl80211_commands cmd,
4570 enum nl80211_attrs attr,
4571 int vendor_event_idx,
4572 int approxlen, gfp_t gfp);
4574 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4577 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4579 * @approxlen: an upper bound of the length of the data that will
4580 * be put into the skb
4582 * This function allocates and pre-fills an skb for a reply to
4583 * a vendor command. Since it is intended for a reply, calling
4584 * it outside of a vendor command's doit() operation is invalid.
4586 * The returned skb is pre-filled with some identifying data in
4587 * a way that any data that is put into the skb (with skb_put(),
4588 * nla_put() or similar) will end up being within the
4589 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4590 * with the skb is adding data for the corresponding userspace tool
4591 * which can then read that data out of the vendor data attribute.
4592 * You must not modify the skb in any other way.
4594 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4595 * its error code as the result of the doit() operation.
4597 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4599 static inline struct sk_buff *
4600 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4602 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4603 NL80211_ATTR_VENDOR_DATA, approxlen);
4607 * cfg80211_vendor_cmd_reply - send the reply skb
4608 * @skb: The skb, must have been allocated with
4609 * cfg80211_vendor_cmd_alloc_reply_skb()
4611 * Since calling this function will usually be the last thing
4612 * before returning from the vendor command doit() you should
4613 * return the error code. Note that this function consumes the
4614 * skb regardless of the return value.
4616 * Return: An error code or 0 on success.
4618 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4621 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4623 * @wdev: the wireless device
4624 * @event_idx: index of the vendor event in the wiphy's vendor_events
4625 * @approxlen: an upper bound of the length of the data that will
4626 * be put into the skb
4627 * @gfp: allocation flags
4629 * This function allocates and pre-fills an skb for an event on the
4630 * vendor-specific multicast group.
4632 * If wdev != NULL, both the ifindex and identifier of the specified
4633 * wireless device are added to the event message before the vendor data
4636 * When done filling the skb, call cfg80211_vendor_event() with the
4637 * skb to send the event.
4639 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4641 static inline struct sk_buff *
4642 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
4643 int approxlen, int event_idx, gfp_t gfp)
4645 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
4646 NL80211_ATTR_VENDOR_DATA,
4647 event_idx, approxlen, gfp);
4651 * cfg80211_vendor_event - send the event
4652 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4653 * @gfp: allocation flags
4655 * This function sends the given @skb, which must have been allocated
4656 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4658 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4660 __cfg80211_send_event_skb(skb, gfp);
4663 #ifdef CONFIG_NL80211_TESTMODE
4667 * Test mode is a set of utility functions to allow drivers to
4668 * interact with driver-specific tools to aid, for instance,
4669 * factory programming.
4671 * This chapter describes how drivers interact with it, for more
4672 * information see the nl80211 book's chapter on it.
4676 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4678 * @approxlen: an upper bound of the length of the data that will
4679 * be put into the skb
4681 * This function allocates and pre-fills an skb for a reply to
4682 * the testmode command. Since it is intended for a reply, calling
4683 * it outside of the @testmode_cmd operation is invalid.
4685 * The returned skb is pre-filled with the wiphy index and set up in
4686 * a way that any data that is put into the skb (with skb_put(),
4687 * nla_put() or similar) will end up being within the
4688 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4689 * with the skb is adding data for the corresponding userspace tool
4690 * which can then read that data out of the testdata attribute. You
4691 * must not modify the skb in any other way.
4693 * When done, call cfg80211_testmode_reply() with the skb and return
4694 * its error code as the result of the @testmode_cmd operation.
4696 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4698 static inline struct sk_buff *
4699 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4701 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4702 NL80211_ATTR_TESTDATA, approxlen);
4706 * cfg80211_testmode_reply - send the reply skb
4707 * @skb: The skb, must have been allocated with
4708 * cfg80211_testmode_alloc_reply_skb()
4710 * Since calling this function will usually be the last thing
4711 * before returning from the @testmode_cmd you should return
4712 * the error code. Note that this function consumes the skb
4713 * regardless of the return value.
4715 * Return: An error code or 0 on success.
4717 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4719 return cfg80211_vendor_cmd_reply(skb);
4723 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4725 * @approxlen: an upper bound of the length of the data that will
4726 * be put into the skb
4727 * @gfp: allocation flags
4729 * This function allocates and pre-fills an skb for an event on the
4730 * testmode multicast group.
4732 * The returned skb is set up in the same way as with
4733 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4734 * there, you should simply add data to it that will then end up in the
4735 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4738 * When done filling the skb, call cfg80211_testmode_event() with the
4739 * skb to send the event.
4741 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4743 static inline struct sk_buff *
4744 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4746 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
4747 NL80211_ATTR_TESTDATA, -1,
4752 * cfg80211_testmode_event - send the event
4753 * @skb: The skb, must have been allocated with
4754 * cfg80211_testmode_alloc_event_skb()
4755 * @gfp: allocation flags
4757 * This function sends the given @skb, which must have been allocated
4758 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4761 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4763 __cfg80211_send_event_skb(skb, gfp);
4766 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
4767 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
4769 #define CFG80211_TESTMODE_CMD(cmd)
4770 #define CFG80211_TESTMODE_DUMP(cmd)
4774 * cfg80211_connect_bss - notify cfg80211 of connection result
4776 * @dev: network device
4777 * @bssid: the BSSID of the AP
4778 * @bss: entry of bss to which STA got connected to, can be obtained
4779 * through cfg80211_get_bss (may be %NULL)
4780 * @req_ie: association request IEs (maybe be %NULL)
4781 * @req_ie_len: association request IEs length
4782 * @resp_ie: association response IEs (may be %NULL)
4783 * @resp_ie_len: assoc response IEs length
4784 * @status: status code, 0 for successful connection, use
4785 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4786 * the real status code for failures.
4787 * @gfp: allocation flags
4789 * It should be called by the underlying driver whenever connect() has
4790 * succeeded. This is similar to cfg80211_connect_result(), but with the
4791 * option of identifying the exact bss entry for the connection. Only one of
4792 * these functions should be called.
4794 void cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
4795 struct cfg80211_bss *bss, const u8 *req_ie,
4796 size_t req_ie_len, const u8 *resp_ie,
4797 size_t resp_ie_len, int status, gfp_t gfp);
4800 * cfg80211_connect_result - notify cfg80211 of connection result
4802 * @dev: network device
4803 * @bssid: the BSSID of the AP
4804 * @req_ie: association request IEs (maybe be %NULL)
4805 * @req_ie_len: association request IEs length
4806 * @resp_ie: association response IEs (may be %NULL)
4807 * @resp_ie_len: assoc response IEs length
4808 * @status: status code, 0 for successful connection, use
4809 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4810 * the real status code for failures.
4811 * @gfp: allocation flags
4813 * It should be called by the underlying driver whenever connect() has
4817 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4818 const u8 *req_ie, size_t req_ie_len,
4819 const u8 *resp_ie, size_t resp_ie_len,
4820 u16 status, gfp_t gfp)
4822 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
4823 resp_ie_len, status, gfp);
4827 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
4829 * @dev: network device
4830 * @bssid: the BSSID of the AP
4831 * @req_ie: association request IEs (maybe be %NULL)
4832 * @req_ie_len: association request IEs length
4833 * @gfp: allocation flags
4835 * It should be called by the underlying driver whenever connect() has failed
4836 * in a sequence where no explicit authentication/association rejection was
4837 * received from the AP. This could happen, e.g., due to not being able to send
4838 * out the Authentication or Association Request frame or timing out while
4839 * waiting for the response.
4842 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
4843 const u8 *req_ie, size_t req_ie_len, gfp_t gfp)
4845 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
4850 * cfg80211_roamed - notify cfg80211 of roaming
4852 * @dev: network device
4853 * @channel: the channel of the new AP
4854 * @bssid: the BSSID of the new AP
4855 * @req_ie: association request IEs (maybe be %NULL)
4856 * @req_ie_len: association request IEs length
4857 * @resp_ie: association response IEs (may be %NULL)
4858 * @resp_ie_len: assoc response IEs length
4859 * @gfp: allocation flags
4861 * It should be called by the underlying driver whenever it roamed
4862 * from one AP to another while connected.
4864 void cfg80211_roamed(struct net_device *dev,
4865 struct ieee80211_channel *channel,
4867 const u8 *req_ie, size_t req_ie_len,
4868 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4871 * cfg80211_roamed_bss - notify cfg80211 of roaming
4873 * @dev: network device
4874 * @bss: entry of bss to which STA got roamed
4875 * @req_ie: association request IEs (maybe be %NULL)
4876 * @req_ie_len: association request IEs length
4877 * @resp_ie: association response IEs (may be %NULL)
4878 * @resp_ie_len: assoc response IEs length
4879 * @gfp: allocation flags
4881 * This is just a wrapper to notify cfg80211 of roaming event with driver
4882 * passing bss to avoid a race in timeout of the bss entry. It should be
4883 * called by the underlying driver whenever it roamed from one AP to another
4884 * while connected. Drivers which have roaming implemented in firmware
4885 * may use this function to avoid a race in bss entry timeout where the bss
4886 * entry of the new AP is seen in the driver, but gets timed out by the time
4887 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4888 * rdev->event_work. In case of any failures, the reference is released
4889 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4890 * it will be released while diconneting from the current bss.
4892 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4893 const u8 *req_ie, size_t req_ie_len,
4894 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4897 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4899 * @dev: network device
4900 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4901 * @ie_len: length of IEs
4902 * @reason: reason code for the disconnection, set it to 0 if unknown
4903 * @locally_generated: disconnection was requested locally
4904 * @gfp: allocation flags
4906 * After it calls this function, the driver should enter an idle state
4907 * and not try to connect to any AP any more.
4909 void cfg80211_disconnected(struct net_device *dev, u16 reason,
4910 const u8 *ie, size_t ie_len,
4911 bool locally_generated, gfp_t gfp);
4914 * cfg80211_ready_on_channel - notification of remain_on_channel start
4915 * @wdev: wireless device
4916 * @cookie: the request cookie
4917 * @chan: The current channel (from remain_on_channel request)
4918 * @duration: Duration in milliseconds that the driver intents to remain on the
4920 * @gfp: allocation flags
4922 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4923 struct ieee80211_channel *chan,
4924 unsigned int duration, gfp_t gfp);
4927 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4928 * @wdev: wireless device
4929 * @cookie: the request cookie
4930 * @chan: The current channel (from remain_on_channel request)
4931 * @gfp: allocation flags
4933 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4934 struct ieee80211_channel *chan,
4939 * cfg80211_new_sta - notify userspace about station
4942 * @mac_addr: the station's address
4943 * @sinfo: the station information
4944 * @gfp: allocation flags
4946 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4947 struct station_info *sinfo, gfp_t gfp);
4950 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
4952 * @mac_addr: the station's address
4953 * @sinfo: the station information/statistics
4954 * @gfp: allocation flags
4956 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
4957 struct station_info *sinfo, gfp_t gfp);
4960 * cfg80211_del_sta - notify userspace about deletion of a station
4963 * @mac_addr: the station's address
4964 * @gfp: allocation flags
4966 static inline void cfg80211_del_sta(struct net_device *dev,
4967 const u8 *mac_addr, gfp_t gfp)
4969 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
4973 * cfg80211_conn_failed - connection request failed notification
4976 * @mac_addr: the station's address
4977 * @reason: the reason for connection failure
4978 * @gfp: allocation flags
4980 * Whenever a station tries to connect to an AP and if the station
4981 * could not connect to the AP as the AP has rejected the connection
4982 * for some reasons, this function is called.
4984 * The reason for connection failure can be any of the value from
4985 * nl80211_connect_failed_reason enum
4987 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4988 enum nl80211_connect_failed_reason reason,
4992 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4993 * @wdev: wireless device receiving the frame
4994 * @freq: Frequency on which the frame was received in MHz
4995 * @sig_dbm: signal strength in mBm, or 0 if unknown
4996 * @buf: Management frame (header + body)
4997 * @len: length of the frame data
4998 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
5000 * This function is called whenever an Action frame is received for a station
5001 * mode interface, but is not processed in kernel.
5003 * Return: %true if a user space application has registered for this frame.
5004 * For action frames, that makes it responsible for rejecting unrecognized
5005 * action frames; %false otherwise, in which case for action frames the
5006 * driver is responsible for rejecting the frame.
5008 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
5009 const u8 *buf, size_t len, u32 flags);
5012 * cfg80211_mgmt_tx_status - notification of TX status for management frame
5013 * @wdev: wireless device receiving the frame
5014 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
5015 * @buf: Management frame (header + body)
5016 * @len: length of the frame data
5017 * @ack: Whether frame was acknowledged
5018 * @gfp: context flags
5020 * This function is called whenever a management frame was requested to be
5021 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
5022 * transmission attempt.
5024 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
5025 const u8 *buf, size_t len, bool ack, gfp_t gfp);
5029 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
5030 * @dev: network device
5031 * @rssi_event: the triggered RSSI event
5032 * @gfp: context flags
5034 * This function is called when a configured connection quality monitoring
5035 * rssi threshold reached event occurs.
5037 void cfg80211_cqm_rssi_notify(struct net_device *dev,
5038 enum nl80211_cqm_rssi_threshold_event rssi_event,
5042 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
5043 * @dev: network device
5044 * @peer: peer's MAC address
5045 * @num_packets: how many packets were lost -- should be a fixed threshold
5046 * but probably no less than maybe 50, or maybe a throughput dependent
5047 * threshold (to account for temporary interference)
5048 * @gfp: context flags
5050 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
5051 const u8 *peer, u32 num_packets, gfp_t gfp);
5054 * cfg80211_cqm_txe_notify - TX error rate event
5055 * @dev: network device
5056 * @peer: peer's MAC address
5057 * @num_packets: how many packets were lost
5058 * @rate: % of packets which failed transmission
5059 * @intvl: interval (in s) over which the TX failure threshold was breached.
5060 * @gfp: context flags
5062 * Notify userspace when configured % TX failures over number of packets in a
5063 * given interval is exceeded.
5065 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
5066 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
5069 * cfg80211_cqm_beacon_loss_notify - beacon loss event
5070 * @dev: network device
5071 * @gfp: context flags
5073 * Notify userspace about beacon loss from the connected AP.
5075 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
5078 * cfg80211_radar_event - radar detection event
5080 * @chandef: chandef for the current channel
5081 * @gfp: context flags
5083 * This function is called when a radar is detected on the current chanenl.
5085 void cfg80211_radar_event(struct wiphy *wiphy,
5086 struct cfg80211_chan_def *chandef, gfp_t gfp);
5089 * cfg80211_cac_event - Channel availability check (CAC) event
5090 * @netdev: network device
5091 * @chandef: chandef for the current channel
5092 * @event: type of event
5093 * @gfp: context flags
5095 * This function is called when a Channel availability check (CAC) is finished
5096 * or aborted. This must be called to notify the completion of a CAC process,
5097 * also by full-MAC drivers.
5099 void cfg80211_cac_event(struct net_device *netdev,
5100 const struct cfg80211_chan_def *chandef,
5101 enum nl80211_radar_event event, gfp_t gfp);
5105 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5106 * @dev: network device
5107 * @bssid: BSSID of AP (to avoid races)
5108 * @replay_ctr: new replay counter
5109 * @gfp: allocation flags
5111 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
5112 const u8 *replay_ctr, gfp_t gfp);
5115 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5116 * @dev: network device
5117 * @index: candidate index (the smaller the index, the higher the priority)
5118 * @bssid: BSSID of AP
5119 * @preauth: Whether AP advertises support for RSN pre-authentication
5120 * @gfp: allocation flags
5122 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
5123 const u8 *bssid, bool preauth, gfp_t gfp);
5126 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5127 * @dev: The device the frame matched to
5128 * @addr: the transmitter address
5129 * @gfp: context flags
5131 * This function is used in AP mode (only!) to inform userspace that
5132 * a spurious class 3 frame was received, to be able to deauth the
5134 * Return: %true if the frame was passed to userspace (or this failed
5135 * for a reason other than not having a subscription.)
5137 bool cfg80211_rx_spurious_frame(struct net_device *dev,
5138 const u8 *addr, gfp_t gfp);
5141 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5142 * @dev: The device the frame matched to
5143 * @addr: the transmitter address
5144 * @gfp: context flags
5146 * This function is used in AP mode (only!) to inform userspace that
5147 * an associated station sent a 4addr frame but that wasn't expected.
5148 * It is allowed and desirable to send this event only once for each
5149 * station to avoid event flooding.
5150 * Return: %true if the frame was passed to userspace (or this failed
5151 * for a reason other than not having a subscription.)
5153 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
5154 const u8 *addr, gfp_t gfp);
5157 * cfg80211_probe_status - notify userspace about probe status
5158 * @dev: the device the probe was sent on
5159 * @addr: the address of the peer
5160 * @cookie: the cookie filled in @probe_client previously
5161 * @acked: indicates whether probe was acked or not
5162 * @gfp: allocation flags
5164 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
5165 u64 cookie, bool acked, gfp_t gfp);
5168 * cfg80211_report_obss_beacon - report beacon from other APs
5169 * @wiphy: The wiphy that received the beacon
5171 * @len: length of the frame
5172 * @freq: frequency the frame was received on
5173 * @sig_dbm: signal strength in mBm, or 0 if unknown
5175 * Use this function to report to userspace when a beacon was
5176 * received. It is not useful to call this when there is no
5177 * netdev that is in AP/GO mode.
5179 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
5180 const u8 *frame, size_t len,
5181 int freq, int sig_dbm);
5184 * cfg80211_reg_can_beacon - check if beaconing is allowed
5186 * @chandef: the channel definition
5187 * @iftype: interface type
5189 * Return: %true if there is no secondary channel or the secondary channel(s)
5190 * can be used for beaconing (i.e. is not a radar channel etc.)
5192 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
5193 struct cfg80211_chan_def *chandef,
5194 enum nl80211_iftype iftype);
5197 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
5199 * @chandef: the channel definition
5200 * @iftype: interface type
5202 * Return: %true if there is no secondary channel or the secondary channel(s)
5203 * can be used for beaconing (i.e. is not a radar channel etc.). This version
5204 * also checks if IR-relaxation conditions apply, to allow beaconing under
5205 * more permissive conditions.
5207 * Requires the RTNL to be held.
5209 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
5210 struct cfg80211_chan_def *chandef,
5211 enum nl80211_iftype iftype);
5214 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5215 * @dev: the device which switched channels
5216 * @chandef: the new channel definition
5218 * Caller must acquire wdev_lock, therefore must only be called from sleepable
5221 void cfg80211_ch_switch_notify(struct net_device *dev,
5222 struct cfg80211_chan_def *chandef);
5225 * cfg80211_ch_switch_started_notify - notify channel switch start
5226 * @dev: the device on which the channel switch started
5227 * @chandef: the future channel definition
5228 * @count: the number of TBTTs until the channel switch happens
5230 * Inform the userspace about the channel switch that has just
5231 * started, so that it can take appropriate actions (eg. starting
5232 * channel switch on other vifs), if necessary.
5234 void cfg80211_ch_switch_started_notify(struct net_device *dev,
5235 struct cfg80211_chan_def *chandef,
5239 * ieee80211_operating_class_to_band - convert operating class to band
5241 * @operating_class: the operating class to convert
5242 * @band: band pointer to fill
5244 * Returns %true if the conversion was successful, %false otherwise.
5246 bool ieee80211_operating_class_to_band(u8 operating_class,
5247 enum nl80211_band *band);
5250 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5252 * @chandef: the chandef to convert
5253 * @op_class: a pointer to the resulting operating class
5255 * Returns %true if the conversion was successful, %false otherwise.
5257 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5261 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5262 * @dev: the device on which the operation is requested
5263 * @peer: the MAC address of the peer device
5264 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5265 * NL80211_TDLS_TEARDOWN)
5266 * @reason_code: the reason code for teardown request
5267 * @gfp: allocation flags
5269 * This function is used to request userspace to perform TDLS operation that
5270 * requires knowledge of keys, i.e., link setup or teardown when the AP
5271 * connection uses encryption. This is optional mechanism for the driver to use
5272 * if it can automatically determine when a TDLS link could be useful (e.g.,
5273 * based on traffic and signal strength for a peer).
5275 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5276 enum nl80211_tdls_operation oper,
5277 u16 reason_code, gfp_t gfp);
5280 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5281 * @rate: given rate_info to calculate bitrate from
5283 * return 0 if MCS index >= 32
5285 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5288 * cfg80211_unregister_wdev - remove the given wdev
5289 * @wdev: struct wireless_dev to remove
5291 * Call this function only for wdevs that have no netdev assigned,
5292 * e.g. P2P Devices. It removes the device from the list so that
5293 * it can no longer be used. It is necessary to call this function
5294 * even when cfg80211 requests the removal of the interface by
5295 * calling the del_virtual_intf() callback. The function must also
5296 * be called when the driver wishes to unregister the wdev, e.g.
5297 * when the device is unbound from the driver.
5299 * Requires the RTNL to be held.
5301 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5304 * struct cfg80211_ft_event - FT Information Elements
5306 * @ies_len: length of the FT IE in bytes
5307 * @target_ap: target AP's MAC address
5309 * @ric_ies_len: length of the RIC IE in bytes
5311 struct cfg80211_ft_event_params {
5314 const u8 *target_ap;
5320 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5321 * @netdev: network device
5322 * @ft_event: IE information
5324 void cfg80211_ft_event(struct net_device *netdev,
5325 struct cfg80211_ft_event_params *ft_event);
5328 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5329 * @ies: the input IE buffer
5330 * @len: the input length
5331 * @attr: the attribute ID to find
5332 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5333 * if the function is only called to get the needed buffer size
5334 * @bufsize: size of the output buffer
5336 * The function finds a given P2P attribute in the (vendor) IEs and
5337 * copies its contents to the given buffer.
5339 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5340 * malformed or the attribute can't be found (respectively), or the
5341 * length of the found attribute (which can be zero).
5343 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
5344 enum ieee80211_p2p_attr_id attr,
5345 u8 *buf, unsigned int bufsize);
5348 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5349 * @ies: the IE buffer
5350 * @ielen: the length of the IE buffer
5351 * @ids: an array with element IDs that are allowed before
5353 * @n_ids: the size of the element ID array
5354 * @after_ric: array IE types that come after the RIC element
5355 * @n_after_ric: size of the @after_ric array
5356 * @offset: offset where to start splitting in the buffer
5358 * This function splits an IE buffer by updating the @offset
5359 * variable to point to the location where the buffer should be
5362 * It assumes that the given IE buffer is well-formed, this
5363 * has to be guaranteed by the caller!
5365 * It also assumes that the IEs in the buffer are ordered
5366 * correctly, if not the result of using this function will not
5367 * be ordered correctly either, i.e. it does no reordering.
5369 * The function returns the offset where the next part of the
5370 * buffer starts, which may be @ielen if the entire (remainder)
5371 * of the buffer should be used.
5373 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
5374 const u8 *ids, int n_ids,
5375 const u8 *after_ric, int n_after_ric,
5379 * ieee80211_ie_split - split an IE buffer according to ordering
5380 * @ies: the IE buffer
5381 * @ielen: the length of the IE buffer
5382 * @ids: an array with element IDs that are allowed before
5384 * @n_ids: the size of the element ID array
5385 * @offset: offset where to start splitting in the buffer
5387 * This function splits an IE buffer by updating the @offset
5388 * variable to point to the location where the buffer should be
5391 * It assumes that the given IE buffer is well-formed, this
5392 * has to be guaranteed by the caller!
5394 * It also assumes that the IEs in the buffer are ordered
5395 * correctly, if not the result of using this function will not
5396 * be ordered correctly either, i.e. it does no reordering.
5398 * The function returns the offset where the next part of the
5399 * buffer starts, which may be @ielen if the entire (remainder)
5400 * of the buffer should be used.
5402 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5403 const u8 *ids, int n_ids, size_t offset)
5405 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
5409 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5410 * @wdev: the wireless device reporting the wakeup
5411 * @wakeup: the wakeup report
5412 * @gfp: allocation flags
5414 * This function reports that the given device woke up. If it
5415 * caused the wakeup, report the reason(s), otherwise you may
5416 * pass %NULL as the @wakeup parameter to advertise that something
5417 * else caused the wakeup.
5419 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
5420 struct cfg80211_wowlan_wakeup *wakeup,
5424 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5426 * @wdev: the wireless device for which critical protocol is stopped.
5427 * @gfp: allocation flags
5429 * This function can be called by the driver to indicate it has reverted
5430 * operation back to normal. One reason could be that the duration given
5431 * by .crit_proto_start() has expired.
5433 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
5436 * ieee80211_get_num_supported_channels - get number of channels device has
5439 * Return: the number of channels supported by the device.
5441 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
5444 * cfg80211_check_combinations - check interface combinations
5447 * @num_different_channels: the number of different channels we want
5448 * to use for verification
5449 * @radar_detect: a bitmap where each bit corresponds to a channel
5450 * width where radar detection is needed, as in the definition of
5451 * &struct ieee80211_iface_combination.@radar_detect_widths
5452 * @iftype_num: array with the numbers of interfaces of each interface
5453 * type. The index is the interface type as specified in &enum
5456 * This function can be called by the driver to check whether a
5457 * combination of interfaces and their types are allowed according to
5458 * the interface combinations.
5460 int cfg80211_check_combinations(struct wiphy *wiphy,
5461 const int num_different_channels,
5462 const u8 radar_detect,
5463 const int iftype_num[NUM_NL80211_IFTYPES]);
5466 * cfg80211_iter_combinations - iterate over matching combinations
5469 * @num_different_channels: the number of different channels we want
5470 * to use for verification
5471 * @radar_detect: a bitmap where each bit corresponds to a channel
5472 * width where radar detection is needed, as in the definition of
5473 * &struct ieee80211_iface_combination.@radar_detect_widths
5474 * @iftype_num: array with the numbers of interfaces of each interface
5475 * type. The index is the interface type as specified in &enum
5477 * @iter: function to call for each matching combination
5478 * @data: pointer to pass to iter function
5480 * This function can be called by the driver to check what possible
5481 * combinations it fits in at a given moment, e.g. for channel switching
5484 int cfg80211_iter_combinations(struct wiphy *wiphy,
5485 const int num_different_channels,
5486 const u8 radar_detect,
5487 const int iftype_num[NUM_NL80211_IFTYPES],
5488 void (*iter)(const struct ieee80211_iface_combination *c,
5493 * cfg80211_stop_iface - trigger interface disconnection
5496 * @wdev: wireless device
5497 * @gfp: context flags
5499 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
5502 * Note: This doesn't need any locks and is asynchronous.
5504 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
5508 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
5509 * @wiphy: the wiphy to shut down
5511 * This function shuts down all interfaces belonging to this wiphy by
5512 * calling dev_close() (and treating non-netdev interfaces as needed).
5513 * It shouldn't really be used unless there are some fatal device errors
5514 * that really can't be recovered in any other way.
5516 * Callers must hold the RTNL and be able to deal with callbacks into
5517 * the driver while the function is running.
5519 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5522 * wiphy_ext_feature_set - set the extended feature flag
5524 * @wiphy: the wiphy to modify.
5525 * @ftidx: extended feature bit index.
5527 * The extended features are flagged in multiple bytes (see
5528 * &struct wiphy.@ext_features)
5530 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
5531 enum nl80211_ext_feature_index ftidx)
5535 ft_byte = &wiphy->ext_features[ftidx / 8];
5536 *ft_byte |= BIT(ftidx % 8);
5540 * wiphy_ext_feature_isset - check the extended feature flag
5542 * @wiphy: the wiphy to modify.
5543 * @ftidx: extended feature bit index.
5545 * The extended features are flagged in multiple bytes (see
5546 * &struct wiphy.@ext_features)
5549 wiphy_ext_feature_isset(struct wiphy *wiphy,
5550 enum nl80211_ext_feature_index ftidx)
5554 ft_byte = wiphy->ext_features[ftidx / 8];
5555 return (ft_byte & BIT(ftidx % 8)) != 0;
5558 /* ethtool helper */
5559 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5561 /* Logging, debugging and troubleshooting/diagnostic helpers. */
5563 /* wiphy_printk helpers, similar to dev_printk */
5565 #define wiphy_printk(level, wiphy, format, args...) \
5566 dev_printk(level, &(wiphy)->dev, format, ##args)
5567 #define wiphy_emerg(wiphy, format, args...) \
5568 dev_emerg(&(wiphy)->dev, format, ##args)
5569 #define wiphy_alert(wiphy, format, args...) \
5570 dev_alert(&(wiphy)->dev, format, ##args)
5571 #define wiphy_crit(wiphy, format, args...) \
5572 dev_crit(&(wiphy)->dev, format, ##args)
5573 #define wiphy_err(wiphy, format, args...) \
5574 dev_err(&(wiphy)->dev, format, ##args)
5575 #define wiphy_warn(wiphy, format, args...) \
5576 dev_warn(&(wiphy)->dev, format, ##args)
5577 #define wiphy_notice(wiphy, format, args...) \
5578 dev_notice(&(wiphy)->dev, format, ##args)
5579 #define wiphy_info(wiphy, format, args...) \
5580 dev_info(&(wiphy)->dev, format, ##args)
5582 #define wiphy_debug(wiphy, format, args...) \
5583 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5585 #define wiphy_dbg(wiphy, format, args...) \
5586 dev_dbg(&(wiphy)->dev, format, ##args)
5588 #if defined(VERBOSE_DEBUG)
5589 #define wiphy_vdbg wiphy_dbg
5591 #define wiphy_vdbg(wiphy, format, args...) \
5594 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
5600 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5601 * of using a WARN/WARN_ON to get the message out, including the
5602 * file/line information and a backtrace.
5604 #define wiphy_WARN(wiphy, format, args...) \
5605 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5607 #endif /* __NET_CFG80211_H */