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
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #include <linux/netdevice.h>
15 #include <linux/debugfs.h>
16 #include <linux/list.h>
17 #include <linux/bug.h>
18 #include <linux/netlink.h>
19 #include <linux/skbuff.h>
20 #include <linux/nl80211.h>
21 #include <linux/if_ether.h>
22 #include <linux/ieee80211.h>
23 #include <linux/net.h>
24 #include <net/regulatory.h>
29 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
30 * userspace and drivers, and offers some utility functionality associated
31 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
32 * by all modern wireless drivers in Linux, so that they offer a consistent
33 * API through nl80211. For backward compatibility, cfg80211 also offers
34 * wireless extensions to userspace, but hides them from drivers completely.
36 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
42 * DOC: Device registration
44 * In order for a driver to use cfg80211, it must register the hardware device
45 * with cfg80211. This happens through a number of hardware capability structs
48 * The fundamental structure for each device is the 'wiphy', of which each
49 * instance describes a physical wireless device connected to the system. Each
50 * such wiphy can have zero, one, or many virtual interfaces associated with
51 * it, which need to be identified as such by pointing the network interface's
52 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
53 * the wireless part of the interface, normally this struct is embedded in the
54 * network interface's private data area. Drivers can optionally allow creating
55 * or destroying virtual interfaces on the fly, but without at least one or the
56 * ability to create some the wireless device isn't useful.
58 * Each wiphy structure contains device capability information, and also has
59 * a pointer to the various operations the driver offers. The definitions and
60 * structures here describe these capabilities in detail.
66 * wireless hardware capability structures
70 * enum ieee80211_band - supported frequency bands
72 * The bands are assigned this way because the supported
73 * bitrates differ in these bands.
75 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
76 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
77 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
78 * @IEEE80211_NUM_BANDS: number of defined bands
81 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
82 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
83 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
90 * enum ieee80211_channel_flags - channel flags
92 * Channel flags set by the regulatory control code.
94 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
95 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
96 * sending probe requests or beaconing.
97 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
98 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
100 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
102 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
103 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
104 * this flag indicates that an 80 MHz channel cannot use this
105 * channel as the control or any of the secondary channels.
106 * This may be due to the driver or due to regulatory bandwidth
108 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
109 * this flag indicates that an 160 MHz channel cannot use this
110 * channel as the control or any of the secondary channels.
111 * This may be due to the driver or due to regulatory bandwidth
113 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
114 * @IEEE80211_CHAN_GO_CONCURRENT: see %NL80211_FREQUENCY_ATTR_GO_CONCURRENT
115 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
117 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
121 enum ieee80211_channel_flags {
122 IEEE80211_CHAN_DISABLED = 1<<0,
123 IEEE80211_CHAN_NO_IR = 1<<1,
125 IEEE80211_CHAN_RADAR = 1<<3,
126 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
127 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
128 IEEE80211_CHAN_NO_OFDM = 1<<6,
129 IEEE80211_CHAN_NO_80MHZ = 1<<7,
130 IEEE80211_CHAN_NO_160MHZ = 1<<8,
131 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
132 IEEE80211_CHAN_GO_CONCURRENT = 1<<10,
133 IEEE80211_CHAN_NO_20MHZ = 1<<11,
134 IEEE80211_CHAN_NO_10MHZ = 1<<12,
137 #define IEEE80211_CHAN_NO_HT40 \
138 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
140 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
141 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
144 * struct ieee80211_channel - channel definition
146 * This structure describes a single channel for use
149 * @center_freq: center frequency in MHz
150 * @hw_value: hardware-specific value for the channel
151 * @flags: channel flags from &enum ieee80211_channel_flags.
152 * @orig_flags: channel flags at registration time, used by regulatory
153 * code to support devices with additional restrictions
154 * @band: band this channel belongs to.
155 * @max_antenna_gain: maximum antenna gain in dBi
156 * @max_power: maximum transmission power (in dBm)
157 * @max_reg_power: maximum regulatory transmission power (in dBm)
158 * @beacon_found: helper to regulatory code to indicate when a beacon
159 * has been found on this channel. Use regulatory_hint_found_beacon()
160 * to enable this, this is useful only on 5 GHz band.
161 * @orig_mag: internal use
162 * @orig_mpwr: internal use
163 * @dfs_state: current state of this channel. Only relevant if radar is required
165 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
166 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
168 struct ieee80211_channel {
169 enum ieee80211_band band;
173 int max_antenna_gain;
178 int orig_mag, orig_mpwr;
179 enum nl80211_dfs_state dfs_state;
180 unsigned long dfs_state_entered;
181 unsigned int dfs_cac_ms;
185 * enum ieee80211_rate_flags - rate flags
187 * Hardware/specification flags for rates. These are structured
188 * in a way that allows using the same bitrate structure for
189 * different bands/PHY modes.
191 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
192 * preamble on this bitrate; only relevant in 2.4GHz band and
194 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
195 * when used with 802.11a (on the 5 GHz band); filled by the
196 * core code when registering the wiphy.
197 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
198 * when used with 802.11b (on the 2.4 GHz band); filled by the
199 * core code when registering the wiphy.
200 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
201 * when used with 802.11g (on the 2.4 GHz band); filled by the
202 * core code when registering the wiphy.
203 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
204 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
205 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
207 enum ieee80211_rate_flags {
208 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
209 IEEE80211_RATE_MANDATORY_A = 1<<1,
210 IEEE80211_RATE_MANDATORY_B = 1<<2,
211 IEEE80211_RATE_MANDATORY_G = 1<<3,
212 IEEE80211_RATE_ERP_G = 1<<4,
213 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
214 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
218 * struct ieee80211_rate - bitrate definition
220 * This structure describes a bitrate that an 802.11 PHY can
221 * operate with. The two values @hw_value and @hw_value_short
222 * are only for driver use when pointers to this structure are
225 * @flags: rate-specific flags
226 * @bitrate: bitrate in units of 100 Kbps
227 * @hw_value: driver/hardware value for this rate
228 * @hw_value_short: driver/hardware value for this rate when
229 * short preamble is used
231 struct ieee80211_rate {
234 u16 hw_value, hw_value_short;
238 * struct ieee80211_sta_ht_cap - STA's HT capabilities
240 * This structure describes most essential parameters needed
241 * to describe 802.11n HT capabilities for an STA.
243 * @ht_supported: is HT supported by the STA
244 * @cap: HT capabilities map as described in 802.11n spec
245 * @ampdu_factor: Maximum A-MPDU length factor
246 * @ampdu_density: Minimum A-MPDU spacing
247 * @mcs: Supported MCS rates
249 struct ieee80211_sta_ht_cap {
250 u16 cap; /* use IEEE80211_HT_CAP_ */
254 struct ieee80211_mcs_info mcs;
258 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
260 * This structure describes most essential parameters needed
261 * to describe 802.11ac VHT capabilities for an STA.
263 * @vht_supported: is VHT supported by the STA
264 * @cap: VHT capabilities map as described in 802.11ac spec
265 * @vht_mcs: Supported VHT MCS rates
267 struct ieee80211_sta_vht_cap {
269 u32 cap; /* use IEEE80211_VHT_CAP_ */
270 struct ieee80211_vht_mcs_info vht_mcs;
274 * struct ieee80211_supported_band - frequency band definition
276 * This structure describes a frequency band a wiphy
277 * is able to operate in.
279 * @channels: Array of channels the hardware can operate in
281 * @band: the band this structure represents
282 * @n_channels: Number of channels in @channels
283 * @bitrates: Array of bitrates the hardware can operate with
284 * in this band. Must be sorted to give a valid "supported
285 * rates" IE, i.e. CCK rates first, then OFDM.
286 * @n_bitrates: Number of bitrates in @bitrates
287 * @ht_cap: HT capabilities in this band
288 * @vht_cap: VHT capabilities in this band
290 struct ieee80211_supported_band {
291 struct ieee80211_channel *channels;
292 struct ieee80211_rate *bitrates;
293 enum ieee80211_band band;
296 struct ieee80211_sta_ht_cap ht_cap;
297 struct ieee80211_sta_vht_cap vht_cap;
301 * Wireless hardware/device configuration structures and methods
305 * DOC: Actions and configuration
307 * Each wireless device and each virtual interface offer a set of configuration
308 * operations and other actions that are invoked by userspace. Each of these
309 * actions is described in the operations structure, and the parameters these
310 * operations use are described separately.
312 * Additionally, some operations are asynchronous and expect to get status
313 * information via some functions that drivers need to call.
315 * Scanning and BSS list handling with its associated functionality is described
316 * in a separate chapter.
320 * struct vif_params - describes virtual interface parameters
321 * @use_4addr: use 4-address frames
322 * @macaddr: address to use for this virtual interface.
323 * If this parameter is set to zero address the driver may
324 * determine the address as needed.
325 * This feature is only fully supported by drivers that enable the
326 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
327 ** only p2p devices with specified MAC.
331 u8 macaddr[ETH_ALEN];
335 * struct key_params - key information
337 * Information about a key
340 * @key_len: length of key material
341 * @cipher: cipher suite selector
342 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
343 * with the get_key() callback, must be in little endian,
344 * length given by @seq_len.
345 * @seq_len: length of @seq.
356 * struct cfg80211_chan_def - channel definition
357 * @chan: the (control) channel
358 * @width: channel width
359 * @center_freq1: center frequency of first segment
360 * @center_freq2: center frequency of second segment
361 * (only with 80+80 MHz)
363 struct cfg80211_chan_def {
364 struct ieee80211_channel *chan;
365 enum nl80211_chan_width width;
371 * cfg80211_get_chandef_type - return old channel type from chandef
372 * @chandef: the channel definition
374 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
375 * chandef, which must have a bandwidth allowing this conversion.
377 static inline enum nl80211_channel_type
378 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
380 switch (chandef->width) {
381 case NL80211_CHAN_WIDTH_20_NOHT:
382 return NL80211_CHAN_NO_HT;
383 case NL80211_CHAN_WIDTH_20:
384 return NL80211_CHAN_HT20;
385 case NL80211_CHAN_WIDTH_40:
386 if (chandef->center_freq1 > chandef->chan->center_freq)
387 return NL80211_CHAN_HT40PLUS;
388 return NL80211_CHAN_HT40MINUS;
391 return NL80211_CHAN_NO_HT;
396 * cfg80211_chandef_create - create channel definition using channel type
397 * @chandef: the channel definition struct to fill
398 * @channel: the control channel
399 * @chantype: the channel type
401 * Given a channel type, create a channel definition.
403 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
404 struct ieee80211_channel *channel,
405 enum nl80211_channel_type chantype);
408 * cfg80211_chandef_identical - check if two channel definitions are identical
409 * @chandef1: first channel definition
410 * @chandef2: second channel definition
412 * Return: %true if the channels defined by the channel definitions are
413 * identical, %false otherwise.
416 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
417 const struct cfg80211_chan_def *chandef2)
419 return (chandef1->chan == chandef2->chan &&
420 chandef1->width == chandef2->width &&
421 chandef1->center_freq1 == chandef2->center_freq1 &&
422 chandef1->center_freq2 == chandef2->center_freq2);
426 * cfg80211_chandef_compatible - check if two channel definitions are compatible
427 * @chandef1: first channel definition
428 * @chandef2: second channel definition
430 * Return: %NULL if the given channel definitions are incompatible,
431 * chandef1 or chandef2 otherwise.
433 const struct cfg80211_chan_def *
434 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
435 const struct cfg80211_chan_def *chandef2);
438 * cfg80211_chandef_valid - check if a channel definition is valid
439 * @chandef: the channel definition to check
440 * Return: %true if the channel definition is valid. %false otherwise.
442 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
445 * cfg80211_chandef_usable - check if secondary channels can be used
446 * @wiphy: the wiphy to validate against
447 * @chandef: the channel definition to check
448 * @prohibited_flags: the regulatory channel flags that must not be set
449 * Return: %true if secondary channels are usable. %false otherwise.
451 bool cfg80211_chandef_usable(struct wiphy *wiphy,
452 const struct cfg80211_chan_def *chandef,
453 u32 prohibited_flags);
456 * cfg80211_chandef_dfs_required - checks if radar detection is required
457 * @wiphy: the wiphy to validate against
458 * @chandef: the channel definition to check
459 * @iftype: the interface type as specified in &enum nl80211_iftype
461 * 1 if radar detection is required, 0 if it is not, < 0 on error
463 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
464 const struct cfg80211_chan_def *chandef,
465 enum nl80211_iftype iftype);
468 * ieee80211_chandef_rate_flags - returns rate flags for a channel
470 * In some channel types, not all rates may be used - for example CCK
471 * rates may not be used in 5/10 MHz channels.
473 * @chandef: channel definition for the channel
475 * Returns: rate flags which apply for this channel
477 static inline enum ieee80211_rate_flags
478 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
480 switch (chandef->width) {
481 case NL80211_CHAN_WIDTH_5:
482 return IEEE80211_RATE_SUPPORTS_5MHZ;
483 case NL80211_CHAN_WIDTH_10:
484 return IEEE80211_RATE_SUPPORTS_10MHZ;
492 * ieee80211_chandef_max_power - maximum transmission power for the chandef
494 * In some regulations, the transmit power may depend on the configured channel
495 * bandwidth which may be defined as dBm/MHz. This function returns the actual
496 * max_power for non-standard (20 MHz) channels.
498 * @chandef: channel definition for the channel
500 * Returns: maximum allowed transmission power in dBm for the chandef
503 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
505 switch (chandef->width) {
506 case NL80211_CHAN_WIDTH_5:
507 return min(chandef->chan->max_reg_power - 6,
508 chandef->chan->max_power);
509 case NL80211_CHAN_WIDTH_10:
510 return min(chandef->chan->max_reg_power - 3,
511 chandef->chan->max_power);
515 return chandef->chan->max_power;
519 * enum survey_info_flags - survey information flags
521 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
522 * @SURVEY_INFO_IN_USE: channel is currently being used
523 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
524 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
525 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
526 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
527 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
529 * Used by the driver to indicate which info in &struct survey_info
530 * it has filled in during the get_survey().
532 enum survey_info_flags {
533 SURVEY_INFO_NOISE_DBM = 1<<0,
534 SURVEY_INFO_IN_USE = 1<<1,
535 SURVEY_INFO_CHANNEL_TIME = 1<<2,
536 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
537 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
538 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
539 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
543 * struct survey_info - channel survey response
545 * @channel: the channel this survey record reports, mandatory
546 * @filled: bitflag of flags from &enum survey_info_flags
547 * @noise: channel noise in dBm. This and all following fields are
549 * @channel_time: amount of time in ms the radio spent on the channel
550 * @channel_time_busy: amount of time the primary channel was sensed busy
551 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
552 * @channel_time_rx: amount of time the radio spent receiving data
553 * @channel_time_tx: amount of time the radio spent transmitting data
555 * Used by dump_survey() to report back per-channel survey information.
557 * This structure can later be expanded with things like
558 * channel duty cycle etc.
561 struct ieee80211_channel *channel;
563 u64 channel_time_busy;
564 u64 channel_time_ext_busy;
572 * struct cfg80211_crypto_settings - Crypto settings
573 * @wpa_versions: indicates which, if any, WPA versions are enabled
574 * (from enum nl80211_wpa_versions)
575 * @cipher_group: group key cipher suite (or 0 if unset)
576 * @n_ciphers_pairwise: number of AP supported unicast ciphers
577 * @ciphers_pairwise: unicast key cipher suites
578 * @n_akm_suites: number of AKM suites
579 * @akm_suites: AKM suites
580 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
581 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
582 * required to assume that the port is unauthorized until authorized by
583 * user space. Otherwise, port is marked authorized by default.
584 * @control_port_ethertype: the control port protocol that should be
585 * allowed through even on unauthorized ports
586 * @control_port_no_encrypt: TRUE to prevent encryption of control port
589 struct cfg80211_crypto_settings {
592 int n_ciphers_pairwise;
593 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
595 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
597 __be16 control_port_ethertype;
598 bool control_port_no_encrypt;
602 * struct cfg80211_beacon_data - beacon data
603 * @head: head portion of beacon (before TIM IE)
604 * or %NULL if not changed
605 * @tail: tail portion of beacon (after TIM IE)
606 * or %NULL if not changed
607 * @head_len: length of @head
608 * @tail_len: length of @tail
609 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
610 * @beacon_ies_len: length of beacon_ies in octets
611 * @proberesp_ies: extra information element(s) to add into Probe Response
613 * @proberesp_ies_len: length of proberesp_ies in octets
614 * @assocresp_ies: extra information element(s) to add into (Re)Association
615 * Response frames or %NULL
616 * @assocresp_ies_len: length of assocresp_ies in octets
617 * @probe_resp_len: length of probe response template (@probe_resp)
618 * @probe_resp: probe response template (AP mode only)
620 struct cfg80211_beacon_data {
621 const u8 *head, *tail;
622 const u8 *beacon_ies;
623 const u8 *proberesp_ies;
624 const u8 *assocresp_ies;
625 const u8 *probe_resp;
627 size_t head_len, tail_len;
628 size_t beacon_ies_len;
629 size_t proberesp_ies_len;
630 size_t assocresp_ies_len;
631 size_t probe_resp_len;
639 * struct cfg80211_acl_data - Access control list data
641 * @acl_policy: ACL policy to be applied on the station's
642 * entry specified by mac_addr
643 * @n_acl_entries: Number of MAC address entries passed
644 * @mac_addrs: List of MAC addresses of stations to be used for ACL
646 struct cfg80211_acl_data {
647 enum nl80211_acl_policy acl_policy;
651 struct mac_address mac_addrs[];
655 * struct cfg80211_ap_settings - AP configuration
657 * Used to configure an AP interface.
659 * @chandef: defines the channel to use
660 * @beacon: beacon data
661 * @beacon_interval: beacon interval
662 * @dtim_period: DTIM period
663 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
665 * @ssid_len: length of @ssid
666 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
667 * @crypto: crypto settings
668 * @privacy: the BSS uses privacy
669 * @auth_type: Authentication type (algorithm)
670 * @smps_mode: SMPS mode
671 * @inactivity_timeout: time in seconds to determine station's inactivity.
672 * @p2p_ctwindow: P2P CT Window
673 * @p2p_opp_ps: P2P opportunistic PS
674 * @acl: ACL configuration used by the drivers which has support for
675 * MAC address based access control
677 struct cfg80211_ap_settings {
678 struct cfg80211_chan_def chandef;
680 struct cfg80211_beacon_data beacon;
682 int beacon_interval, dtim_period;
685 enum nl80211_hidden_ssid hidden_ssid;
686 struct cfg80211_crypto_settings crypto;
688 enum nl80211_auth_type auth_type;
689 enum nl80211_smps_mode smps_mode;
690 int inactivity_timeout;
693 const struct cfg80211_acl_data *acl;
697 * struct cfg80211_csa_settings - channel switch settings
699 * Used for channel switch
701 * @chandef: defines the channel to use after the switch
702 * @beacon_csa: beacon data while performing the switch
703 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
704 * @counter_offsets_presp: offsets of the counters within the probe response
705 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
706 * @n_counter_offsets_presp: number of csa counters in the probe response
707 * @beacon_after: beacon data to be used on the new channel
708 * @radar_required: whether radar detection is required on the new channel
709 * @block_tx: whether transmissions should be blocked while changing
710 * @count: number of beacons until switch
712 struct cfg80211_csa_settings {
713 struct cfg80211_chan_def chandef;
714 struct cfg80211_beacon_data beacon_csa;
715 const u16 *counter_offsets_beacon;
716 const u16 *counter_offsets_presp;
717 unsigned int n_counter_offsets_beacon;
718 unsigned int n_counter_offsets_presp;
719 struct cfg80211_beacon_data beacon_after;
726 * enum station_parameters_apply_mask - station parameter values to apply
727 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
728 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
729 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
731 * Not all station parameters have in-band "no change" signalling,
732 * for those that don't these flags will are used.
734 enum station_parameters_apply_mask {
735 STATION_PARAM_APPLY_UAPSD = BIT(0),
736 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
737 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
741 * struct station_parameters - station parameters
743 * Used to change and create a new station.
745 * @vlan: vlan interface station should belong to
746 * @supported_rates: supported rates in IEEE 802.11 format
747 * (or NULL for no change)
748 * @supported_rates_len: number of supported rates
749 * @sta_flags_mask: station flags that changed
750 * (bitmask of BIT(NL80211_STA_FLAG_...))
751 * @sta_flags_set: station flags values
752 * (bitmask of BIT(NL80211_STA_FLAG_...))
753 * @listen_interval: listen interval or -1 for no change
754 * @aid: AID or zero for no change
755 * @plink_action: plink action to take
756 * @plink_state: set the peer link state for a station
757 * @ht_capa: HT capabilities of station
758 * @vht_capa: VHT capabilities of station
759 * @uapsd_queues: bitmap of queues configured for uapsd. same format
760 * as the AC bitmap in the QoS info field
761 * @max_sp: max Service Period. same format as the MAX_SP in the
762 * QoS info field (but already shifted down)
763 * @sta_modify_mask: bitmap indicating which parameters changed
764 * (for those that don't have a natural "no change" value),
765 * see &enum station_parameters_apply_mask
766 * @local_pm: local link-specific mesh power save mode (no change when set
768 * @capability: station capability
769 * @ext_capab: extended capabilities of the station
770 * @ext_capab_len: number of extended capabilities
771 * @supported_channels: supported channels in IEEE 802.11 format
772 * @supported_channels_len: number of supported channels
773 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
774 * @supported_oper_classes_len: number of supported operating classes
775 * @opmode_notif: operating mode field from Operating Mode Notification
776 * @opmode_notif_used: information if operating mode field is used
778 struct station_parameters {
779 const u8 *supported_rates;
780 struct net_device *vlan;
781 u32 sta_flags_mask, sta_flags_set;
785 u8 supported_rates_len;
788 const struct ieee80211_ht_cap *ht_capa;
789 const struct ieee80211_vht_cap *vht_capa;
792 enum nl80211_mesh_power_mode local_pm;
796 const u8 *supported_channels;
797 u8 supported_channels_len;
798 const u8 *supported_oper_classes;
799 u8 supported_oper_classes_len;
801 bool opmode_notif_used;
805 * struct station_del_parameters - station deletion parameters
807 * Used to delete a station entry (or all stations).
809 * @mac: MAC address of the station to remove or NULL to remove all stations
810 * @subtype: Management frame subtype to use for indicating removal
811 * (10 = Disassociation, 12 = Deauthentication)
812 * @reason_code: Reason code for the Disassociation/Deauthentication frame
814 struct station_del_parameters {
821 * enum cfg80211_station_type - the type of station being modified
822 * @CFG80211_STA_AP_CLIENT: client of an AP interface
823 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
824 * the AP MLME in the device
825 * @CFG80211_STA_AP_STA: AP station on managed interface
826 * @CFG80211_STA_IBSS: IBSS station
827 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
828 * while TDLS setup is in progress, it moves out of this state when
829 * being marked authorized; use this only if TDLS with external setup is
831 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
832 * entry that is operating, has been marked authorized by userspace)
833 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
834 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
836 enum cfg80211_station_type {
837 CFG80211_STA_AP_CLIENT,
838 CFG80211_STA_AP_MLME_CLIENT,
841 CFG80211_STA_TDLS_PEER_SETUP,
842 CFG80211_STA_TDLS_PEER_ACTIVE,
843 CFG80211_STA_MESH_PEER_KERNEL,
844 CFG80211_STA_MESH_PEER_USER,
848 * cfg80211_check_station_change - validate parameter changes
849 * @wiphy: the wiphy this operates on
850 * @params: the new parameters for a station
851 * @statype: the type of station being modified
853 * Utility function for the @change_station driver method. Call this function
854 * with the appropriate station type looking up the station (and checking that
855 * it exists). It will verify whether the station change is acceptable, and if
856 * not will return an error code. Note that it may modify the parameters for
857 * backward compatibility reasons, so don't use them before calling this.
859 int cfg80211_check_station_change(struct wiphy *wiphy,
860 struct station_parameters *params,
861 enum cfg80211_station_type statype);
864 * enum station_info_flags - station information flags
866 * Used by the driver to indicate which info in &struct station_info
867 * it has filled in during get_station() or dump_station().
869 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
870 * @STATION_INFO_RX_BYTES: @rx_bytes filled
871 * @STATION_INFO_TX_BYTES: @tx_bytes filled
872 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
873 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
874 * @STATION_INFO_LLID: @llid filled
875 * @STATION_INFO_PLID: @plid filled
876 * @STATION_INFO_PLINK_STATE: @plink_state filled
877 * @STATION_INFO_SIGNAL: @signal filled
878 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
879 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
880 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
881 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
882 * @STATION_INFO_TX_RETRIES: @tx_retries filled
883 * @STATION_INFO_TX_FAILED: @tx_failed filled
884 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
885 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
886 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
887 * @STATION_INFO_BSS_PARAM: @bss_param filled
888 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
889 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
890 * @STATION_INFO_STA_FLAGS: @sta_flags filled
891 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
892 * @STATION_INFO_T_OFFSET: @t_offset filled
893 * @STATION_INFO_LOCAL_PM: @local_pm filled
894 * @STATION_INFO_PEER_PM: @peer_pm filled
895 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
896 * @STATION_INFO_CHAIN_SIGNAL: @chain_signal filled
897 * @STATION_INFO_CHAIN_SIGNAL_AVG: @chain_signal_avg filled
898 * @STATION_INFO_EXPECTED_THROUGHPUT: @expected_throughput filled
900 enum station_info_flags {
901 STATION_INFO_INACTIVE_TIME = BIT(0),
902 STATION_INFO_RX_BYTES = BIT(1),
903 STATION_INFO_TX_BYTES = BIT(2),
904 STATION_INFO_LLID = BIT(3),
905 STATION_INFO_PLID = BIT(4),
906 STATION_INFO_PLINK_STATE = BIT(5),
907 STATION_INFO_SIGNAL = BIT(6),
908 STATION_INFO_TX_BITRATE = BIT(7),
909 STATION_INFO_RX_PACKETS = BIT(8),
910 STATION_INFO_TX_PACKETS = BIT(9),
911 STATION_INFO_TX_RETRIES = BIT(10),
912 STATION_INFO_TX_FAILED = BIT(11),
913 STATION_INFO_RX_DROP_MISC = BIT(12),
914 STATION_INFO_SIGNAL_AVG = BIT(13),
915 STATION_INFO_RX_BITRATE = BIT(14),
916 STATION_INFO_BSS_PARAM = BIT(15),
917 STATION_INFO_CONNECTED_TIME = BIT(16),
918 STATION_INFO_ASSOC_REQ_IES = BIT(17),
919 STATION_INFO_STA_FLAGS = BIT(18),
920 STATION_INFO_BEACON_LOSS_COUNT = BIT(19),
921 STATION_INFO_T_OFFSET = BIT(20),
922 STATION_INFO_LOCAL_PM = BIT(21),
923 STATION_INFO_PEER_PM = BIT(22),
924 STATION_INFO_NONPEER_PM = BIT(23),
925 STATION_INFO_RX_BYTES64 = BIT(24),
926 STATION_INFO_TX_BYTES64 = BIT(25),
927 STATION_INFO_CHAIN_SIGNAL = BIT(26),
928 STATION_INFO_CHAIN_SIGNAL_AVG = BIT(27),
929 STATION_INFO_EXPECTED_THROUGHPUT = BIT(28),
933 * enum station_info_rate_flags - bitrate info flags
935 * Used by the driver to indicate the specific rate transmission
936 * type for 802.11n transmissions.
938 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
939 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
940 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
941 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
942 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
943 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
944 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
945 * @RATE_INFO_FLAGS_60G: 60GHz MCS
947 enum rate_info_flags {
948 RATE_INFO_FLAGS_MCS = BIT(0),
949 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
950 RATE_INFO_FLAGS_40_MHZ_WIDTH = BIT(2),
951 RATE_INFO_FLAGS_80_MHZ_WIDTH = BIT(3),
952 RATE_INFO_FLAGS_80P80_MHZ_WIDTH = BIT(4),
953 RATE_INFO_FLAGS_160_MHZ_WIDTH = BIT(5),
954 RATE_INFO_FLAGS_SHORT_GI = BIT(6),
955 RATE_INFO_FLAGS_60G = BIT(7),
959 * struct rate_info - bitrate information
961 * Information about a receiving or transmitting bitrate
963 * @flags: bitflag of flags from &enum rate_info_flags
964 * @mcs: mcs index if struct describes a 802.11n bitrate
965 * @legacy: bitrate in 100kbit/s for 802.11abg
966 * @nss: number of streams (VHT only)
976 * enum station_info_rate_flags - bitrate info flags
978 * Used by the driver to indicate the specific rate transmission
979 * type for 802.11n transmissions.
981 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
982 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
983 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
985 enum bss_param_flags {
986 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
987 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
988 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
992 * struct sta_bss_parameters - BSS parameters for the attached station
994 * Information about the currently associated BSS
996 * @flags: bitflag of flags from &enum bss_param_flags
997 * @dtim_period: DTIM period for the BSS
998 * @beacon_interval: beacon interval
1000 struct sta_bss_parameters {
1003 u16 beacon_interval;
1006 #define IEEE80211_MAX_CHAINS 4
1009 * struct station_info - station information
1011 * Station information filled by driver for get_station() and dump_station.
1013 * @filled: bitflag of flags from &enum station_info_flags
1014 * @connected_time: time(in secs) since a station is last connected
1015 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1016 * @rx_bytes: bytes received from this station
1017 * @tx_bytes: bytes transmitted to this station
1018 * @llid: mesh local link id
1019 * @plid: mesh peer link id
1020 * @plink_state: mesh peer link state
1021 * @signal: The signal strength, type depends on the wiphy's signal_type.
1022 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1023 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1024 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1025 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1026 * @chain_signal: per-chain signal strength of last received packet in dBm
1027 * @chain_signal_avg: per-chain signal strength average in dBm
1028 * @txrate: current unicast bitrate from this station
1029 * @rxrate: current unicast bitrate to this station
1030 * @rx_packets: packets received from this station
1031 * @tx_packets: packets transmitted to this station
1032 * @tx_retries: cumulative retry counts
1033 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
1034 * @rx_dropped_misc: Dropped for un-specified reason.
1035 * @bss_param: current BSS parameters
1036 * @generation: generation number for nl80211 dumps.
1037 * This number should increase every time the list of stations
1038 * changes, i.e. when a station is added or removed, so that
1039 * userspace can tell whether it got a consistent snapshot.
1040 * @assoc_req_ies: IEs from (Re)Association Request.
1041 * This is used only when in AP mode with drivers that do not use
1042 * user space MLME/SME implementation. The information is provided for
1043 * the cfg80211_new_sta() calls to notify user space of the IEs.
1044 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1045 * @sta_flags: station flags mask & values
1046 * @beacon_loss_count: Number of times beacon loss event has triggered.
1047 * @t_offset: Time offset of the station relative to this host.
1048 * @local_pm: local mesh STA power save mode
1049 * @peer_pm: peer mesh STA power save mode
1050 * @nonpeer_pm: non-peer mesh STA power save mode
1051 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1052 * towards this station.
1054 struct station_info {
1067 s8 chain_signal[IEEE80211_MAX_CHAINS];
1068 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1070 struct rate_info txrate;
1071 struct rate_info rxrate;
1076 u32 rx_dropped_misc;
1077 struct sta_bss_parameters bss_param;
1078 struct nl80211_sta_flag_update sta_flags;
1082 const u8 *assoc_req_ies;
1083 size_t assoc_req_ies_len;
1085 u32 beacon_loss_count;
1087 enum nl80211_mesh_power_mode local_pm;
1088 enum nl80211_mesh_power_mode peer_pm;
1089 enum nl80211_mesh_power_mode nonpeer_pm;
1091 u32 expected_throughput;
1094 * Note: Add a new enum station_info_flags value for each new field and
1095 * use it to check which fields are initialized.
1100 * cfg80211_get_station - retrieve information about a given station
1101 * @dev: the device where the station is supposed to be connected to
1102 * @mac_addr: the mac address of the station of interest
1103 * @sinfo: pointer to the structure to fill with the information
1105 * Returns 0 on success and sinfo is filled with the available information
1106 * otherwise returns a negative error code and the content of sinfo has to be
1107 * considered undefined.
1109 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1110 struct station_info *sinfo);
1113 * enum monitor_flags - monitor flags
1115 * Monitor interface configuration flags. Note that these must be the bits
1116 * according to the nl80211 flags.
1118 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1119 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1120 * @MONITOR_FLAG_CONTROL: pass control frames
1121 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1122 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1123 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1125 enum monitor_flags {
1126 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1127 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1128 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1129 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1130 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1131 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1135 * enum mpath_info_flags - mesh path information flags
1137 * Used by the driver to indicate which info in &struct mpath_info it has filled
1138 * in during get_station() or dump_station().
1140 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1141 * @MPATH_INFO_SN: @sn filled
1142 * @MPATH_INFO_METRIC: @metric filled
1143 * @MPATH_INFO_EXPTIME: @exptime filled
1144 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1145 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1146 * @MPATH_INFO_FLAGS: @flags filled
1148 enum mpath_info_flags {
1149 MPATH_INFO_FRAME_QLEN = BIT(0),
1150 MPATH_INFO_SN = BIT(1),
1151 MPATH_INFO_METRIC = BIT(2),
1152 MPATH_INFO_EXPTIME = BIT(3),
1153 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1154 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1155 MPATH_INFO_FLAGS = BIT(6),
1159 * struct mpath_info - mesh path information
1161 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1163 * @filled: bitfield of flags from &enum mpath_info_flags
1164 * @frame_qlen: number of queued frames for this destination
1165 * @sn: target sequence number
1166 * @metric: metric (cost) of this mesh path
1167 * @exptime: expiration time for the mesh path from now, in msecs
1168 * @flags: mesh path flags
1169 * @discovery_timeout: total mesh path discovery timeout, in msecs
1170 * @discovery_retries: mesh path discovery retries
1171 * @generation: generation number for nl80211 dumps.
1172 * This number should increase every time the list of mesh paths
1173 * changes, i.e. when a station is added or removed, so that
1174 * userspace can tell whether it got a consistent snapshot.
1182 u32 discovery_timeout;
1183 u8 discovery_retries;
1190 * struct bss_parameters - BSS parameters
1192 * Used to change BSS parameters (mainly for AP mode).
1194 * @use_cts_prot: Whether to use CTS protection
1195 * (0 = no, 1 = yes, -1 = do not change)
1196 * @use_short_preamble: Whether the use of short preambles is allowed
1197 * (0 = no, 1 = yes, -1 = do not change)
1198 * @use_short_slot_time: Whether the use of short slot time is allowed
1199 * (0 = no, 1 = yes, -1 = do not change)
1200 * @basic_rates: basic rates in IEEE 802.11 format
1201 * (or NULL for no change)
1202 * @basic_rates_len: number of basic rates
1203 * @ap_isolate: do not forward packets between connected stations
1204 * @ht_opmode: HT Operation mode
1205 * (u16 = opmode, -1 = do not change)
1206 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1207 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1209 struct bss_parameters {
1211 int use_short_preamble;
1212 int use_short_slot_time;
1213 const u8 *basic_rates;
1217 s8 p2p_ctwindow, p2p_opp_ps;
1221 * struct mesh_config - 802.11s mesh configuration
1223 * These parameters can be changed while the mesh is active.
1225 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1226 * by the Mesh Peering Open message
1227 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1228 * used by the Mesh Peering Open message
1229 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1230 * the mesh peering management to close a mesh peering
1231 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1233 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1234 * be sent to establish a new peer link instance in a mesh
1235 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1236 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1238 * @auto_open_plinks: whether we should automatically open peer links when we
1239 * detect compatible mesh peers
1240 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1241 * synchronize to for 11s default synchronization method
1242 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1243 * that an originator mesh STA can send to a particular path target
1244 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1245 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1246 * a path discovery in milliseconds
1247 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1248 * receiving a PREQ shall consider the forwarding information from the
1249 * root to be valid. (TU = time unit)
1250 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1251 * which a mesh STA can send only one action frame containing a PREQ
1253 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1254 * which a mesh STA can send only one Action frame containing a PERR
1256 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1257 * it takes for an HWMP information element to propagate across the mesh
1258 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1259 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1260 * announcements are transmitted
1261 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1262 * station has access to a broader network beyond the MBSS. (This is
1263 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1264 * only means that the station will announce others it's a mesh gate, but
1265 * not necessarily using the gate announcement protocol. Still keeping the
1266 * same nomenclature to be in sync with the spec)
1267 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1268 * entity (default is TRUE - forwarding entity)
1269 * @rssi_threshold: the threshold for average signal strength of candidate
1270 * station to establish a peer link
1271 * @ht_opmode: mesh HT protection mode
1273 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1274 * receiving a proactive PREQ shall consider the forwarding information to
1275 * the root mesh STA to be valid.
1277 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1278 * PREQs are transmitted.
1279 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1280 * during which a mesh STA can send only one Action frame containing
1281 * a PREQ element for root path confirmation.
1282 * @power_mode: The default mesh power save mode which will be the initial
1283 * setting for new peer links.
1284 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1285 * after transmitting its beacon.
1286 * @plink_timeout: If no tx activity is seen from a STA we've established
1287 * peering with for longer than this time (in seconds), then remove it
1288 * from the STA's list of peers. Default is 30 minutes.
1290 struct mesh_config {
1291 u16 dot11MeshRetryTimeout;
1292 u16 dot11MeshConfirmTimeout;
1293 u16 dot11MeshHoldingTimeout;
1294 u16 dot11MeshMaxPeerLinks;
1295 u8 dot11MeshMaxRetries;
1298 bool auto_open_plinks;
1299 u32 dot11MeshNbrOffsetMaxNeighbor;
1300 u8 dot11MeshHWMPmaxPREQretries;
1301 u32 path_refresh_time;
1302 u16 min_discovery_timeout;
1303 u32 dot11MeshHWMPactivePathTimeout;
1304 u16 dot11MeshHWMPpreqMinInterval;
1305 u16 dot11MeshHWMPperrMinInterval;
1306 u16 dot11MeshHWMPnetDiameterTraversalTime;
1307 u8 dot11MeshHWMPRootMode;
1308 u16 dot11MeshHWMPRannInterval;
1309 bool dot11MeshGateAnnouncementProtocol;
1310 bool dot11MeshForwarding;
1313 u32 dot11MeshHWMPactivePathToRootTimeout;
1314 u16 dot11MeshHWMProotInterval;
1315 u16 dot11MeshHWMPconfirmationInterval;
1316 enum nl80211_mesh_power_mode power_mode;
1317 u16 dot11MeshAwakeWindowDuration;
1322 * struct mesh_setup - 802.11s mesh setup configuration
1323 * @chandef: defines the channel to use
1324 * @mesh_id: the mesh ID
1325 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1326 * @sync_method: which synchronization method to use
1327 * @path_sel_proto: which path selection protocol to use
1328 * @path_metric: which metric to use
1329 * @auth_id: which authentication method this mesh is using
1330 * @ie: vendor information elements (optional)
1331 * @ie_len: length of vendor information elements
1332 * @is_authenticated: this mesh requires authentication
1333 * @is_secure: this mesh uses security
1334 * @user_mpm: userspace handles all MPM functions
1335 * @dtim_period: DTIM period to use
1336 * @beacon_interval: beacon interval to use
1337 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1338 * @basic_rates: basic rates to use when creating the mesh
1340 * These parameters are fixed when the mesh is created.
1343 struct cfg80211_chan_def chandef;
1352 bool is_authenticated;
1356 u16 beacon_interval;
1357 int mcast_rate[IEEE80211_NUM_BANDS];
1362 * struct ocb_setup - 802.11p OCB mode setup configuration
1363 * @chandef: defines the channel to use
1365 * These parameters are fixed when connecting to the network
1368 struct cfg80211_chan_def chandef;
1372 * struct ieee80211_txq_params - TX queue parameters
1373 * @ac: AC identifier
1374 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1375 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1377 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1379 * @aifs: Arbitration interframe space [0..255]
1381 struct ieee80211_txq_params {
1390 * DOC: Scanning and BSS list handling
1392 * The scanning process itself is fairly simple, but cfg80211 offers quite
1393 * a bit of helper functionality. To start a scan, the scan operation will
1394 * be invoked with a scan definition. This scan definition contains the
1395 * channels to scan, and the SSIDs to send probe requests for (including the
1396 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1397 * probe. Additionally, a scan request may contain extra information elements
1398 * that should be added to the probe request. The IEs are guaranteed to be
1399 * well-formed, and will not exceed the maximum length the driver advertised
1400 * in the wiphy structure.
1402 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1403 * it is responsible for maintaining the BSS list; the driver should not
1404 * maintain a list itself. For this notification, various functions exist.
1406 * Since drivers do not maintain a BSS list, there are also a number of
1407 * functions to search for a BSS and obtain information about it from the
1408 * BSS structure cfg80211 maintains. The BSS list is also made available
1413 * struct cfg80211_ssid - SSID description
1415 * @ssid_len: length of the ssid
1417 struct cfg80211_ssid {
1418 u8 ssid[IEEE80211_MAX_SSID_LEN];
1423 * struct cfg80211_scan_request - scan request description
1425 * @ssids: SSIDs to scan for (active scan only)
1426 * @n_ssids: number of SSIDs
1427 * @channels: channels to scan on.
1428 * @n_channels: total number of channels to scan
1429 * @scan_width: channel width for scanning
1430 * @ie: optional information element(s) to add into Probe Request or %NULL
1431 * @ie_len: length of ie in octets
1432 * @flags: bit field of flags controlling operation
1433 * @rates: bitmap of rates to advertise for each band
1434 * @wiphy: the wiphy this was for
1435 * @scan_start: time (in jiffies) when the scan started
1436 * @wdev: the wireless device to scan for
1437 * @aborted: (internal) scan request was notified as aborted
1438 * @notified: (internal) scan request was notified as done or aborted
1439 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1441 struct cfg80211_scan_request {
1442 struct cfg80211_ssid *ssids;
1445 enum nl80211_bss_scan_width scan_width;
1450 u32 rates[IEEE80211_NUM_BANDS];
1452 struct wireless_dev *wdev;
1455 struct wiphy *wiphy;
1456 unsigned long scan_start;
1457 bool aborted, notified;
1461 struct ieee80211_channel *channels[0];
1465 * struct cfg80211_match_set - sets of attributes to match
1467 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1468 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1470 struct cfg80211_match_set {
1471 struct cfg80211_ssid ssid;
1476 * struct cfg80211_sched_scan_request - scheduled scan request description
1478 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1479 * @n_ssids: number of SSIDs
1480 * @n_channels: total number of channels to scan
1481 * @scan_width: channel width for scanning
1482 * @interval: interval between each scheduled scan cycle
1483 * @ie: optional information element(s) to add into Probe Request or %NULL
1484 * @ie_len: length of ie in octets
1485 * @flags: bit field of flags controlling operation
1486 * @match_sets: sets of parameters to be matched for a scan result
1487 * entry to be considered valid and to be passed to the host
1488 * (others are filtered out).
1489 * If ommited, all results are passed.
1490 * @n_match_sets: number of match sets
1491 * @wiphy: the wiphy this was for
1492 * @dev: the interface
1493 * @scan_start: start time of the scheduled scan
1494 * @channels: channels to scan
1495 * @min_rssi_thold: for drivers only supporting a single threshold, this
1496 * contains the minimum over all matchsets
1498 struct cfg80211_sched_scan_request {
1499 struct cfg80211_ssid *ssids;
1502 enum nl80211_bss_scan_width scan_width;
1507 struct cfg80211_match_set *match_sets;
1512 struct wiphy *wiphy;
1513 struct net_device *dev;
1514 unsigned long scan_start;
1517 struct ieee80211_channel *channels[0];
1521 * enum cfg80211_signal_type - signal type
1523 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1524 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1525 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1527 enum cfg80211_signal_type {
1528 CFG80211_SIGNAL_TYPE_NONE,
1529 CFG80211_SIGNAL_TYPE_MBM,
1530 CFG80211_SIGNAL_TYPE_UNSPEC,
1534 * struct cfg80211_bss_ie_data - BSS entry IE data
1535 * @tsf: TSF contained in the frame that carried these IEs
1536 * @rcu_head: internal use, for freeing
1537 * @len: length of the IEs
1538 * @from_beacon: these IEs are known to come from a beacon
1541 struct cfg80211_bss_ies {
1543 struct rcu_head rcu_head;
1550 * struct cfg80211_bss - BSS description
1552 * This structure describes a BSS (which may also be a mesh network)
1553 * for use in scan results and similar.
1555 * @channel: channel this BSS is on
1556 * @scan_width: width of the control channel
1557 * @bssid: BSSID of the BSS
1558 * @beacon_interval: the beacon interval as from the frame
1559 * @capability: the capability field in host byte order
1560 * @ies: the information elements (Note that there is no guarantee that these
1561 * are well-formed!); this is a pointer to either the beacon_ies or
1562 * proberesp_ies depending on whether Probe Response frame has been
1563 * received. It is always non-%NULL.
1564 * @beacon_ies: the information elements from the last Beacon frame
1565 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1566 * own the beacon_ies, but they're just pointers to the ones from the
1567 * @hidden_beacon_bss struct)
1568 * @proberesp_ies: the information elements from the last Probe Response frame
1569 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1570 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1571 * that holds the beacon data. @beacon_ies is still valid, of course, and
1572 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1573 * @signal: signal strength value (type depends on the wiphy's signal_type)
1574 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1576 struct cfg80211_bss {
1577 struct ieee80211_channel *channel;
1578 enum nl80211_bss_scan_width scan_width;
1580 const struct cfg80211_bss_ies __rcu *ies;
1581 const struct cfg80211_bss_ies __rcu *beacon_ies;
1582 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1584 struct cfg80211_bss *hidden_beacon_bss;
1588 u16 beacon_interval;
1593 u8 priv[0] __aligned(sizeof(void *));
1597 * ieee80211_bss_get_ie - find IE with given ID
1598 * @bss: the bss to search
1601 * Note that the return value is an RCU-protected pointer, so
1602 * rcu_read_lock() must be held when calling this function.
1603 * Return: %NULL if not found.
1605 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1609 * struct cfg80211_auth_request - Authentication request data
1611 * This structure provides information needed to complete IEEE 802.11
1614 * @bss: The BSS to authenticate with, the callee must obtain a reference
1615 * to it if it needs to keep it.
1616 * @auth_type: Authentication type (algorithm)
1617 * @ie: Extra IEs to add to Authentication frame or %NULL
1618 * @ie_len: Length of ie buffer in octets
1619 * @key_len: length of WEP key for shared key authentication
1620 * @key_idx: index of WEP key for shared key authentication
1621 * @key: WEP key for shared key authentication
1622 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1623 * Authentication transaction sequence number field.
1624 * @sae_data_len: Length of sae_data buffer in octets
1626 struct cfg80211_auth_request {
1627 struct cfg80211_bss *bss;
1630 enum nl80211_auth_type auth_type;
1632 u8 key_len, key_idx;
1634 size_t sae_data_len;
1638 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1640 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1641 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1642 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1644 enum cfg80211_assoc_req_flags {
1645 ASSOC_REQ_DISABLE_HT = BIT(0),
1646 ASSOC_REQ_DISABLE_VHT = BIT(1),
1647 ASSOC_REQ_USE_RRM = BIT(2),
1651 * struct cfg80211_assoc_request - (Re)Association request data
1653 * This structure provides information needed to complete IEEE 802.11
1655 * @bss: The BSS to associate with. If the call is successful the driver is
1656 * given a reference that it must give back to cfg80211_send_rx_assoc()
1657 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1658 * association requests while already associating must be rejected.
1659 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1660 * @ie_len: Length of ie buffer in octets
1661 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1662 * @crypto: crypto settings
1663 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1664 * @flags: See &enum cfg80211_assoc_req_flags
1665 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1666 * will be used in ht_capa. Un-supported values will be ignored.
1667 * @ht_capa_mask: The bits of ht_capa which are to be used.
1668 * @vht_capa: VHT capability override
1669 * @vht_capa_mask: VHT capability mask indicating which fields to use
1671 struct cfg80211_assoc_request {
1672 struct cfg80211_bss *bss;
1673 const u8 *ie, *prev_bssid;
1675 struct cfg80211_crypto_settings crypto;
1678 struct ieee80211_ht_cap ht_capa;
1679 struct ieee80211_ht_cap ht_capa_mask;
1680 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1684 * struct cfg80211_deauth_request - Deauthentication request data
1686 * This structure provides information needed to complete IEEE 802.11
1689 * @bssid: the BSSID of the BSS to deauthenticate from
1690 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1691 * @ie_len: Length of ie buffer in octets
1692 * @reason_code: The reason code for the deauthentication
1693 * @local_state_change: if set, change local state only and
1694 * do not set a deauth frame
1696 struct cfg80211_deauth_request {
1701 bool local_state_change;
1705 * struct cfg80211_disassoc_request - Disassociation request data
1707 * This structure provides information needed to complete IEEE 802.11
1710 * @bss: the BSS to disassociate from
1711 * @ie: Extra IEs to add to Disassociation frame or %NULL
1712 * @ie_len: Length of ie buffer in octets
1713 * @reason_code: The reason code for the disassociation
1714 * @local_state_change: This is a request for a local state only, i.e., no
1715 * Disassociation frame is to be transmitted.
1717 struct cfg80211_disassoc_request {
1718 struct cfg80211_bss *bss;
1722 bool local_state_change;
1726 * struct cfg80211_ibss_params - IBSS parameters
1728 * This structure defines the IBSS parameters for the join_ibss()
1731 * @ssid: The SSID, will always be non-null.
1732 * @ssid_len: The length of the SSID, will always be non-zero.
1733 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1734 * search for IBSSs with a different BSSID.
1735 * @chandef: defines the channel to use if no other IBSS to join can be found
1736 * @channel_fixed: The channel should be fixed -- do not search for
1737 * IBSSs to join on other channels.
1738 * @ie: information element(s) to include in the beacon
1739 * @ie_len: length of that
1740 * @beacon_interval: beacon interval to use
1741 * @privacy: this is a protected network, keys will be configured
1743 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1744 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1745 * required to assume that the port is unauthorized until authorized by
1746 * user space. Otherwise, port is marked authorized by default.
1747 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1748 * changes the channel when a radar is detected. This is required
1749 * to operate on DFS channels.
1750 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1751 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1752 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1753 * will be used in ht_capa. Un-supported values will be ignored.
1754 * @ht_capa_mask: The bits of ht_capa which are to be used.
1756 struct cfg80211_ibss_params {
1759 struct cfg80211_chan_def chandef;
1761 u8 ssid_len, ie_len;
1762 u16 beacon_interval;
1767 bool userspace_handles_dfs;
1768 int mcast_rate[IEEE80211_NUM_BANDS];
1769 struct ieee80211_ht_cap ht_capa;
1770 struct ieee80211_ht_cap ht_capa_mask;
1774 * struct cfg80211_connect_params - Connection parameters
1776 * This structure provides information needed to complete IEEE 802.11
1777 * authentication and association.
1779 * @channel: The channel to use or %NULL if not specified (auto-select based
1781 * @channel_hint: The channel of the recommended BSS for initial connection or
1782 * %NULL if not specified
1783 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1785 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1786 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1787 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1790 * @ssid_len: Length of ssid in octets
1791 * @auth_type: Authentication type (algorithm)
1792 * @ie: IEs for association request
1793 * @ie_len: Length of assoc_ie in octets
1794 * @privacy: indicates whether privacy-enabled APs should be used
1795 * @mfp: indicate whether management frame protection is used
1796 * @crypto: crypto settings
1797 * @key_len: length of WEP key for shared key authentication
1798 * @key_idx: index of WEP key for shared key authentication
1799 * @key: WEP key for shared key authentication
1800 * @flags: See &enum cfg80211_assoc_req_flags
1801 * @bg_scan_period: Background scan period in seconds
1802 * or -1 to indicate that default value is to be used.
1803 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1804 * will be used in ht_capa. Un-supported values will be ignored.
1805 * @ht_capa_mask: The bits of ht_capa which are to be used.
1806 * @vht_capa: VHT Capability overrides
1807 * @vht_capa_mask: The bits of vht_capa which are to be used.
1809 struct cfg80211_connect_params {
1810 struct ieee80211_channel *channel;
1811 struct ieee80211_channel *channel_hint;
1813 const u8 *bssid_hint;
1816 enum nl80211_auth_type auth_type;
1820 enum nl80211_mfp mfp;
1821 struct cfg80211_crypto_settings crypto;
1823 u8 key_len, key_idx;
1826 struct ieee80211_ht_cap ht_capa;
1827 struct ieee80211_ht_cap ht_capa_mask;
1828 struct ieee80211_vht_cap vht_capa;
1829 struct ieee80211_vht_cap vht_capa_mask;
1833 * enum wiphy_params_flags - set_wiphy_params bitfield values
1834 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1835 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1836 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1837 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1838 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1839 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
1841 enum wiphy_params_flags {
1842 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1843 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1844 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1845 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1846 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1847 WIPHY_PARAM_DYN_ACK = 1 << 5,
1851 * cfg80211_bitrate_mask - masks for bitrate control
1853 struct cfg80211_bitrate_mask {
1856 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
1857 u16 vht_mcs[NL80211_VHT_NSS_MAX];
1858 enum nl80211_txrate_gi gi;
1859 } control[IEEE80211_NUM_BANDS];
1862 * struct cfg80211_pmksa - PMK Security Association
1864 * This structure is passed to the set/del_pmksa() method for PMKSA
1867 * @bssid: The AP's BSSID.
1868 * @pmkid: The PMK material itself.
1870 struct cfg80211_pmksa {
1876 * struct cfg80211_pkt_pattern - packet pattern
1877 * @mask: bitmask where to match pattern and where to ignore bytes,
1878 * one bit per byte, in same format as nl80211
1879 * @pattern: bytes to match where bitmask is 1
1880 * @pattern_len: length of pattern (in bytes)
1881 * @pkt_offset: packet offset (in bytes)
1883 * Internal note: @mask and @pattern are allocated in one chunk of
1884 * memory, free @mask only!
1886 struct cfg80211_pkt_pattern {
1887 const u8 *mask, *pattern;
1893 * struct cfg80211_wowlan_tcp - TCP connection parameters
1895 * @sock: (internal) socket for source port allocation
1896 * @src: source IP address
1897 * @dst: destination IP address
1898 * @dst_mac: destination MAC address
1899 * @src_port: source port
1900 * @dst_port: destination port
1901 * @payload_len: data payload length
1902 * @payload: data payload buffer
1903 * @payload_seq: payload sequence stamping configuration
1904 * @data_interval: interval at which to send data packets
1905 * @wake_len: wakeup payload match length
1906 * @wake_data: wakeup payload match data
1907 * @wake_mask: wakeup payload match mask
1908 * @tokens_size: length of the tokens buffer
1909 * @payload_tok: payload token usage configuration
1911 struct cfg80211_wowlan_tcp {
1912 struct socket *sock;
1914 u16 src_port, dst_port;
1915 u8 dst_mac[ETH_ALEN];
1918 struct nl80211_wowlan_tcp_data_seq payload_seq;
1921 const u8 *wake_data, *wake_mask;
1923 /* must be last, variable member */
1924 struct nl80211_wowlan_tcp_data_token payload_tok;
1928 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1930 * This structure defines the enabled WoWLAN triggers for the device.
1931 * @any: wake up on any activity -- special trigger if device continues
1932 * operating as normal during suspend
1933 * @disconnect: wake up if getting disconnected
1934 * @magic_pkt: wake up on receiving magic packet
1935 * @patterns: wake up on receiving packet matching a pattern
1936 * @n_patterns: number of patterns
1937 * @gtk_rekey_failure: wake up on GTK rekey failure
1938 * @eap_identity_req: wake up on EAP identity request packet
1939 * @four_way_handshake: wake up on 4-way handshake
1940 * @rfkill_release: wake up when rfkill is released
1941 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
1942 * NULL if not configured.
1943 * @nd_config: configuration for the scan to be used for net detect wake.
1945 struct cfg80211_wowlan {
1946 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1947 eap_identity_req, four_way_handshake,
1949 struct cfg80211_pkt_pattern *patterns;
1950 struct cfg80211_wowlan_tcp *tcp;
1952 struct cfg80211_sched_scan_request *nd_config;
1956 * struct cfg80211_coalesce_rules - Coalesce rule parameters
1958 * This structure defines coalesce rule for the device.
1959 * @delay: maximum coalescing delay in msecs.
1960 * @condition: condition for packet coalescence.
1961 * see &enum nl80211_coalesce_condition.
1962 * @patterns: array of packet patterns
1963 * @n_patterns: number of patterns
1965 struct cfg80211_coalesce_rules {
1967 enum nl80211_coalesce_condition condition;
1968 struct cfg80211_pkt_pattern *patterns;
1973 * struct cfg80211_coalesce - Packet coalescing settings
1975 * This structure defines coalescing settings.
1976 * @rules: array of coalesce rules
1977 * @n_rules: number of rules
1979 struct cfg80211_coalesce {
1980 struct cfg80211_coalesce_rules *rules;
1985 * struct cfg80211_wowlan_nd_match - information about the match
1987 * @ssid: SSID of the match that triggered the wake up
1988 * @n_channels: Number of channels where the match occurred. This
1989 * value may be zero if the driver can't report the channels.
1990 * @channels: center frequencies of the channels where a match
1993 struct cfg80211_wowlan_nd_match {
1994 struct cfg80211_ssid ssid;
2000 * struct cfg80211_wowlan_nd_info - net detect wake up information
2002 * @n_matches: Number of match information instances provided in
2003 * @matches. This value may be zero if the driver can't provide
2004 * match information.
2005 * @matches: Array of pointers to matches containing information about
2006 * the matches that triggered the wake up.
2008 struct cfg80211_wowlan_nd_info {
2010 struct cfg80211_wowlan_nd_match *matches[];
2014 * struct cfg80211_wowlan_wakeup - wakeup report
2015 * @disconnect: woke up by getting disconnected
2016 * @magic_pkt: woke up by receiving magic packet
2017 * @gtk_rekey_failure: woke up by GTK rekey failure
2018 * @eap_identity_req: woke up by EAP identity request packet
2019 * @four_way_handshake: woke up by 4-way handshake
2020 * @rfkill_release: woke up by rfkill being released
2021 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2022 * @packet_present_len: copied wakeup packet data
2023 * @packet_len: original wakeup packet length
2024 * @packet: The packet causing the wakeup, if any.
2025 * @packet_80211: For pattern match, magic packet and other data
2026 * frame triggers an 802.3 frame should be reported, for
2027 * disconnect due to deauth 802.11 frame. This indicates which
2029 * @tcp_match: TCP wakeup packet received
2030 * @tcp_connlost: TCP connection lost or failed to establish
2031 * @tcp_nomoretokens: TCP data ran out of tokens
2032 * @net_detect: if not %NULL, woke up because of net detect
2034 struct cfg80211_wowlan_wakeup {
2035 bool disconnect, magic_pkt, gtk_rekey_failure,
2036 eap_identity_req, four_way_handshake,
2037 rfkill_release, packet_80211,
2038 tcp_match, tcp_connlost, tcp_nomoretokens;
2040 u32 packet_present_len, packet_len;
2042 struct cfg80211_wowlan_nd_info *net_detect;
2046 * struct cfg80211_gtk_rekey_data - rekey data
2047 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2048 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2049 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2051 struct cfg80211_gtk_rekey_data {
2052 const u8 *kek, *kck, *replay_ctr;
2056 * struct cfg80211_update_ft_ies_params - FT IE Information
2058 * This structure provides information needed to update the fast transition IE
2060 * @md: The Mobility Domain ID, 2 Octet value
2061 * @ie: Fast Transition IEs
2062 * @ie_len: Length of ft_ie in octets
2064 struct cfg80211_update_ft_ies_params {
2071 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2073 * This structure provides information needed to transmit a mgmt frame
2075 * @chan: channel to use
2076 * @offchan: indicates wether off channel operation is required
2077 * @wait: duration for ROC
2078 * @buf: buffer to transmit
2079 * @len: buffer length
2080 * @no_cck: don't use cck rates for this frame
2081 * @dont_wait_for_ack: tells the low level not to wait for an ack
2082 * @n_csa_offsets: length of csa_offsets array
2083 * @csa_offsets: array of all the csa offsets in the frame
2085 struct cfg80211_mgmt_tx_params {
2086 struct ieee80211_channel *chan;
2092 bool dont_wait_for_ack;
2094 const u16 *csa_offsets;
2098 * struct cfg80211_dscp_exception - DSCP exception
2100 * @dscp: DSCP value that does not adhere to the user priority range definition
2101 * @up: user priority value to which the corresponding DSCP value belongs
2103 struct cfg80211_dscp_exception {
2109 * struct cfg80211_dscp_range - DSCP range definition for user priority
2111 * @low: lowest DSCP value of this user priority range, inclusive
2112 * @high: highest DSCP value of this user priority range, inclusive
2114 struct cfg80211_dscp_range {
2119 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2120 #define IEEE80211_QOS_MAP_MAX_EX 21
2121 #define IEEE80211_QOS_MAP_LEN_MIN 16
2122 #define IEEE80211_QOS_MAP_LEN_MAX \
2123 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2126 * struct cfg80211_qos_map - QoS Map Information
2128 * This struct defines the Interworking QoS map setting for DSCP values
2130 * @num_des: number of DSCP exceptions (0..21)
2131 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2132 * the user priority DSCP range definition
2133 * @up: DSCP range definition for a particular user priority
2135 struct cfg80211_qos_map {
2137 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2138 struct cfg80211_dscp_range up[8];
2142 * struct cfg80211_ops - backend description for wireless configuration
2144 * This struct is registered by fullmac card drivers and/or wireless stacks
2145 * in order to handle configuration requests on their interfaces.
2147 * All callbacks except where otherwise noted should return 0
2148 * on success or a negative error code.
2150 * All operations are currently invoked under rtnl for consistency with the
2151 * wireless extensions but this is subject to reevaluation as soon as this
2152 * code is used more widely and we have a first user without wext.
2154 * @suspend: wiphy device needs to be suspended. The variable @wow will
2155 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2156 * configured for the device.
2157 * @resume: wiphy device needs to be resumed
2158 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2159 * to call device_set_wakeup_enable() to enable/disable wakeup from
2162 * @add_virtual_intf: create a new virtual interface with the given name,
2163 * must set the struct wireless_dev's iftype. Beware: You must create
2164 * the new netdev in the wiphy's network namespace! Returns the struct
2165 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2166 * also set the address member in the wdev.
2168 * @del_virtual_intf: remove the virtual interface
2170 * @change_virtual_intf: change type/configuration of virtual interface,
2171 * keep the struct wireless_dev's iftype updated.
2173 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2174 * when adding a group key.
2176 * @get_key: get information about the key with the given parameters.
2177 * @mac_addr will be %NULL when requesting information for a group
2178 * key. All pointers given to the @callback function need not be valid
2179 * after it returns. This function should return an error if it is
2180 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2182 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2183 * and @key_index, return -ENOENT if the key doesn't exist.
2185 * @set_default_key: set the default key on an interface
2187 * @set_default_mgmt_key: set the default management frame key on an interface
2189 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2191 * @start_ap: Start acting in AP mode defined by the parameters.
2192 * @change_beacon: Change the beacon parameters for an access point mode
2193 * interface. This should reject the call when AP mode wasn't started.
2194 * @stop_ap: Stop being an AP, including stopping beaconing.
2196 * @add_station: Add a new station.
2197 * @del_station: Remove a station
2198 * @change_station: Modify a given station. Note that flags changes are not much
2199 * validated in cfg80211, in particular the auth/assoc/authorized flags
2200 * might come to the driver in invalid combinations -- make sure to check
2201 * them, also against the existing state! Drivers must call
2202 * cfg80211_check_station_change() to validate the information.
2203 * @get_station: get station information for the station identified by @mac
2204 * @dump_station: dump station callback -- resume dump at index @idx
2206 * @add_mpath: add a fixed mesh path
2207 * @del_mpath: delete a given mesh path
2208 * @change_mpath: change a given mesh path
2209 * @get_mpath: get a mesh path for the given parameters
2210 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2211 * @get_mpp: get a mesh proxy path for the given parameters
2212 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2213 * @join_mesh: join the mesh network with the specified parameters
2214 * (invoked with the wireless_dev mutex held)
2215 * @leave_mesh: leave the current mesh network
2216 * (invoked with the wireless_dev mutex held)
2218 * @get_mesh_config: Get the current mesh configuration
2220 * @update_mesh_config: Update mesh parameters on a running mesh.
2221 * The mask is a bitfield which tells us which parameters to
2222 * set, and which to leave alone.
2224 * @change_bss: Modify parameters for a given BSS.
2226 * @set_txq_params: Set TX queue parameters
2228 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2229 * as it doesn't implement join_mesh and needs to set the channel to
2230 * join the mesh instead.
2232 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2233 * interfaces are active this callback should reject the configuration.
2234 * If no interfaces are active or the device is down, the channel should
2235 * be stored for when a monitor interface becomes active.
2237 * @scan: Request to do a scan. If returning zero, the scan request is given
2238 * the driver, and will be valid until passed to cfg80211_scan_done().
2239 * For scan results, call cfg80211_inform_bss(); you can call this outside
2240 * the scan/scan_done bracket too.
2242 * @auth: Request to authenticate with the specified peer
2243 * (invoked with the wireless_dev mutex held)
2244 * @assoc: Request to (re)associate with the specified peer
2245 * (invoked with the wireless_dev mutex held)
2246 * @deauth: Request to deauthenticate from the specified peer
2247 * (invoked with the wireless_dev mutex held)
2248 * @disassoc: Request to disassociate from the specified peer
2249 * (invoked with the wireless_dev mutex held)
2251 * @connect: Connect to the ESS with the specified parameters. When connected,
2252 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
2253 * If the connection fails for some reason, call cfg80211_connect_result()
2254 * with the status from the AP.
2255 * (invoked with the wireless_dev mutex held)
2256 * @disconnect: Disconnect from the BSS/ESS.
2257 * (invoked with the wireless_dev mutex held)
2259 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2260 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2262 * (invoked with the wireless_dev mutex held)
2263 * @leave_ibss: Leave the IBSS.
2264 * (invoked with the wireless_dev mutex held)
2266 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2269 * @set_wiphy_params: Notify that wiphy parameters have changed;
2270 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2271 * have changed. The actual parameter values are available in
2272 * struct wiphy. If returning an error, no value should be changed.
2274 * @set_tx_power: set the transmit power according to the parameters,
2275 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2276 * wdev may be %NULL if power was set for the wiphy, and will
2277 * always be %NULL unless the driver supports per-vif TX power
2278 * (as advertised by the nl80211 feature flag.)
2279 * @get_tx_power: store the current TX power into the dbm variable;
2280 * return 0 if successful
2282 * @set_wds_peer: set the WDS peer for a WDS interface
2284 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2285 * functions to adjust rfkill hw state
2287 * @dump_survey: get site survey information.
2289 * @remain_on_channel: Request the driver to remain awake on the specified
2290 * channel for the specified duration to complete an off-channel
2291 * operation (e.g., public action frame exchange). When the driver is
2292 * ready on the requested channel, it must indicate this with an event
2293 * notification by calling cfg80211_ready_on_channel().
2294 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2295 * This allows the operation to be terminated prior to timeout based on
2296 * the duration value.
2297 * @mgmt_tx: Transmit a management frame.
2298 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2299 * frame on another channel
2301 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2302 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2303 * used by the function, but 0 and 1 must not be touched. Additionally,
2304 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2305 * dump and return to userspace with an error, so be careful. If any data
2306 * was passed in from userspace then the data/len arguments will be present
2307 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2309 * @set_bitrate_mask: set the bitrate mask configuration
2311 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2312 * devices running firmwares capable of generating the (re) association
2313 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2314 * @del_pmksa: Delete a cached PMKID.
2315 * @flush_pmksa: Flush all cached PMKIDs.
2316 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2317 * allows the driver to adjust the dynamic ps timeout value.
2318 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2319 * @set_cqm_txe_config: Configure connection quality monitor TX error
2321 * @sched_scan_start: Tell the driver to start a scheduled scan.
2322 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2323 * call must stop the scheduled scan and be ready for starting a new one
2324 * before it returns, i.e. @sched_scan_start may be called immediately
2325 * after that again and should not fail in that case. The driver should
2326 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2327 * method returns 0.)
2329 * @mgmt_frame_register: Notify driver that a management frame type was
2330 * registered. Note that this callback may not sleep, and cannot run
2331 * concurrently with itself.
2333 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2334 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2335 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2336 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2338 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2340 * @tdls_mgmt: Transmit a TDLS management frame.
2341 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2343 * @probe_client: probe an associated client, must return a cookie that it
2344 * later passes to cfg80211_probe_status().
2346 * @set_noack_map: Set the NoAck Map for the TIDs.
2348 * @get_channel: Get the current operating channel for the virtual interface.
2349 * For monitor interfaces, it should return %NULL unless there's a single
2350 * current monitoring channel.
2352 * @start_p2p_device: Start the given P2P device.
2353 * @stop_p2p_device: Stop the given P2P device.
2355 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2356 * Parameters include ACL policy, an array of MAC address of stations
2357 * and the number of MAC addresses. If there is already a list in driver
2358 * this new list replaces the existing one. Driver has to clear its ACL
2359 * when number of MAC addresses entries is passed as 0. Drivers which
2360 * advertise the support for MAC based ACL have to implement this callback.
2362 * @start_radar_detection: Start radar detection in the driver.
2364 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2365 * driver. If the SME is in the driver/firmware, this information can be
2366 * used in building Authentication and Reassociation Request frames.
2368 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2369 * for a given duration (milliseconds). The protocol is provided so the
2370 * driver can take the most appropriate actions.
2371 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2372 * reliability. This operation can not fail.
2373 * @set_coalesce: Set coalesce parameters.
2375 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2376 * responsible for veryfing if the switch is possible. Since this is
2377 * inherently tricky driver may decide to disconnect an interface later
2378 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2379 * everything. It should do it's best to verify requests and reject them
2380 * as soon as possible.
2382 * @set_qos_map: Set QoS mapping information to the driver
2384 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2385 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2386 * changes during the lifetime of the BSS.
2388 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2389 * with the given parameters; action frame exchange has been handled by
2390 * userspace so this just has to modify the TX path to take the TS into
2392 * If the admitted time is 0 just validate the parameters to make sure
2393 * the session can be created at all; it is valid to just always return
2394 * success for that but that may result in inefficient behaviour (handshake
2395 * with the peer followed by immediate teardown when the addition is later
2397 * @del_tx_ts: remove an existing TX TS
2399 * @join_ocb: join the OCB network with the specified parameters
2400 * (invoked with the wireless_dev mutex held)
2401 * @leave_ocb: leave the current OCB network
2402 * (invoked with the wireless_dev mutex held)
2404 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2405 * is responsible for continually initiating channel-switching operations
2406 * and returning to the base channel for communication with the AP.
2407 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2408 * peers must be on the base channel when the call completes.
2410 struct cfg80211_ops {
2411 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2412 int (*resume)(struct wiphy *wiphy);
2413 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2415 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2417 enum nl80211_iftype type,
2419 struct vif_params *params);
2420 int (*del_virtual_intf)(struct wiphy *wiphy,
2421 struct wireless_dev *wdev);
2422 int (*change_virtual_intf)(struct wiphy *wiphy,
2423 struct net_device *dev,
2424 enum nl80211_iftype type, u32 *flags,
2425 struct vif_params *params);
2427 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2428 u8 key_index, bool pairwise, const u8 *mac_addr,
2429 struct key_params *params);
2430 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2431 u8 key_index, bool pairwise, const u8 *mac_addr,
2433 void (*callback)(void *cookie, struct key_params*));
2434 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2435 u8 key_index, bool pairwise, const u8 *mac_addr);
2436 int (*set_default_key)(struct wiphy *wiphy,
2437 struct net_device *netdev,
2438 u8 key_index, bool unicast, bool multicast);
2439 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2440 struct net_device *netdev,
2443 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2444 struct cfg80211_ap_settings *settings);
2445 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2446 struct cfg80211_beacon_data *info);
2447 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2450 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2452 struct station_parameters *params);
2453 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2454 struct station_del_parameters *params);
2455 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2457 struct station_parameters *params);
2458 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2459 const u8 *mac, struct station_info *sinfo);
2460 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2461 int idx, u8 *mac, struct station_info *sinfo);
2463 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2464 const u8 *dst, const u8 *next_hop);
2465 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2467 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2468 const u8 *dst, const u8 *next_hop);
2469 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2470 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2471 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2472 int idx, u8 *dst, u8 *next_hop,
2473 struct mpath_info *pinfo);
2474 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2475 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2476 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2477 int idx, u8 *dst, u8 *mpp,
2478 struct mpath_info *pinfo);
2479 int (*get_mesh_config)(struct wiphy *wiphy,
2480 struct net_device *dev,
2481 struct mesh_config *conf);
2482 int (*update_mesh_config)(struct wiphy *wiphy,
2483 struct net_device *dev, u32 mask,
2484 const struct mesh_config *nconf);
2485 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2486 const struct mesh_config *conf,
2487 const struct mesh_setup *setup);
2488 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2490 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2491 struct ocb_setup *setup);
2492 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2494 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2495 struct bss_parameters *params);
2497 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2498 struct ieee80211_txq_params *params);
2500 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2501 struct net_device *dev,
2502 struct ieee80211_channel *chan);
2504 int (*set_monitor_channel)(struct wiphy *wiphy,
2505 struct cfg80211_chan_def *chandef);
2507 int (*scan)(struct wiphy *wiphy,
2508 struct cfg80211_scan_request *request);
2510 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2511 struct cfg80211_auth_request *req);
2512 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2513 struct cfg80211_assoc_request *req);
2514 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2515 struct cfg80211_deauth_request *req);
2516 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2517 struct cfg80211_disassoc_request *req);
2519 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2520 struct cfg80211_connect_params *sme);
2521 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2524 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2525 struct cfg80211_ibss_params *params);
2526 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2528 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2529 int rate[IEEE80211_NUM_BANDS]);
2531 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2533 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2534 enum nl80211_tx_power_setting type, int mbm);
2535 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2538 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2541 void (*rfkill_poll)(struct wiphy *wiphy);
2543 #ifdef CONFIG_NL80211_TESTMODE
2544 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2545 void *data, int len);
2546 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2547 struct netlink_callback *cb,
2548 void *data, int len);
2551 int (*set_bitrate_mask)(struct wiphy *wiphy,
2552 struct net_device *dev,
2554 const struct cfg80211_bitrate_mask *mask);
2556 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2557 int idx, struct survey_info *info);
2559 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2560 struct cfg80211_pmksa *pmksa);
2561 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2562 struct cfg80211_pmksa *pmksa);
2563 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2565 int (*remain_on_channel)(struct wiphy *wiphy,
2566 struct wireless_dev *wdev,
2567 struct ieee80211_channel *chan,
2568 unsigned int duration,
2570 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2571 struct wireless_dev *wdev,
2574 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2575 struct cfg80211_mgmt_tx_params *params,
2577 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2578 struct wireless_dev *wdev,
2581 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2582 bool enabled, int timeout);
2584 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2585 struct net_device *dev,
2586 s32 rssi_thold, u32 rssi_hyst);
2588 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2589 struct net_device *dev,
2590 u32 rate, u32 pkts, u32 intvl);
2592 void (*mgmt_frame_register)(struct wiphy *wiphy,
2593 struct wireless_dev *wdev,
2594 u16 frame_type, bool reg);
2596 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2597 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2599 int (*sched_scan_start)(struct wiphy *wiphy,
2600 struct net_device *dev,
2601 struct cfg80211_sched_scan_request *request);
2602 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2604 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2605 struct cfg80211_gtk_rekey_data *data);
2607 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2608 const u8 *peer, u8 action_code, u8 dialog_token,
2609 u16 status_code, u32 peer_capability,
2610 bool initiator, const u8 *buf, size_t len);
2611 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2612 const u8 *peer, enum nl80211_tdls_operation oper);
2614 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2615 const u8 *peer, u64 *cookie);
2617 int (*set_noack_map)(struct wiphy *wiphy,
2618 struct net_device *dev,
2621 int (*get_channel)(struct wiphy *wiphy,
2622 struct wireless_dev *wdev,
2623 struct cfg80211_chan_def *chandef);
2625 int (*start_p2p_device)(struct wiphy *wiphy,
2626 struct wireless_dev *wdev);
2627 void (*stop_p2p_device)(struct wiphy *wiphy,
2628 struct wireless_dev *wdev);
2630 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2631 const struct cfg80211_acl_data *params);
2633 int (*start_radar_detection)(struct wiphy *wiphy,
2634 struct net_device *dev,
2635 struct cfg80211_chan_def *chandef,
2637 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2638 struct cfg80211_update_ft_ies_params *ftie);
2639 int (*crit_proto_start)(struct wiphy *wiphy,
2640 struct wireless_dev *wdev,
2641 enum nl80211_crit_proto_id protocol,
2643 void (*crit_proto_stop)(struct wiphy *wiphy,
2644 struct wireless_dev *wdev);
2645 int (*set_coalesce)(struct wiphy *wiphy,
2646 struct cfg80211_coalesce *coalesce);
2648 int (*channel_switch)(struct wiphy *wiphy,
2649 struct net_device *dev,
2650 struct cfg80211_csa_settings *params);
2652 int (*set_qos_map)(struct wiphy *wiphy,
2653 struct net_device *dev,
2654 struct cfg80211_qos_map *qos_map);
2656 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
2657 struct cfg80211_chan_def *chandef);
2659 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2660 u8 tsid, const u8 *peer, u8 user_prio,
2662 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2663 u8 tsid, const u8 *peer);
2665 int (*tdls_channel_switch)(struct wiphy *wiphy,
2666 struct net_device *dev,
2667 const u8 *addr, u8 oper_class,
2668 struct cfg80211_chan_def *chandef);
2669 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
2670 struct net_device *dev,
2675 * wireless hardware and networking interfaces structures
2676 * and registration/helper functions
2680 * enum wiphy_flags - wiphy capability flags
2682 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2684 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2685 * by default -- this flag will be set depending on the kernel's default
2686 * on wiphy_new(), but can be changed by the driver if it has a good
2687 * reason to override the default
2688 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2689 * on a VLAN interface)
2690 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2691 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2692 * control port protocol ethertype. The device also honours the
2693 * control_port_no_encrypt flag.
2694 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2695 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2696 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2697 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2698 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2700 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2701 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2702 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2703 * link setup/discovery operations internally. Setup, discovery and
2704 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2705 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2706 * used for asking the driver/firmware to perform a TDLS operation.
2707 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2708 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2709 * when there are virtual interfaces in AP mode by calling
2710 * cfg80211_report_obss_beacon().
2711 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2712 * responds to probe-requests in hardware.
2713 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2714 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2715 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2716 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2717 * beaconing mode (AP, IBSS, Mesh, ...).
2723 WIPHY_FLAG_NETNS_OK = BIT(3),
2724 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2725 WIPHY_FLAG_4ADDR_AP = BIT(5),
2726 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2727 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2728 WIPHY_FLAG_IBSS_RSN = BIT(8),
2729 WIPHY_FLAG_MESH_AUTH = BIT(10),
2730 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2731 /* use hole at 12 */
2732 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2733 WIPHY_FLAG_AP_UAPSD = BIT(14),
2734 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2735 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2736 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2737 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2738 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2739 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2740 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2741 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
2742 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
2746 * struct ieee80211_iface_limit - limit on certain interface types
2747 * @max: maximum number of interfaces of these types
2748 * @types: interface types (bits)
2750 struct ieee80211_iface_limit {
2756 * struct ieee80211_iface_combination - possible interface combination
2757 * @limits: limits for the given interface types
2758 * @n_limits: number of limitations
2759 * @num_different_channels: can use up to this many different channels
2760 * @max_interfaces: maximum number of interfaces in total allowed in this
2762 * @beacon_int_infra_match: In this combination, the beacon intervals
2763 * between infrastructure and AP types must match. This is required
2764 * only in special cases.
2765 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2766 * @radar_detect_regions: bitmap of regions supported for radar detection
2768 * With this structure the driver can describe which interface
2769 * combinations it supports concurrently.
2773 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2775 * struct ieee80211_iface_limit limits1[] = {
2776 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2777 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2779 * struct ieee80211_iface_combination combination1 = {
2780 * .limits = limits1,
2781 * .n_limits = ARRAY_SIZE(limits1),
2782 * .max_interfaces = 2,
2783 * .beacon_int_infra_match = true,
2787 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2789 * struct ieee80211_iface_limit limits2[] = {
2790 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2791 * BIT(NL80211_IFTYPE_P2P_GO), },
2793 * struct ieee80211_iface_combination combination2 = {
2794 * .limits = limits2,
2795 * .n_limits = ARRAY_SIZE(limits2),
2796 * .max_interfaces = 8,
2797 * .num_different_channels = 1,
2801 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2803 * This allows for an infrastructure connection and three P2P connections.
2805 * struct ieee80211_iface_limit limits3[] = {
2806 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2807 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2808 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2810 * struct ieee80211_iface_combination combination3 = {
2811 * .limits = limits3,
2812 * .n_limits = ARRAY_SIZE(limits3),
2813 * .max_interfaces = 4,
2814 * .num_different_channels = 2,
2817 struct ieee80211_iface_combination {
2818 const struct ieee80211_iface_limit *limits;
2819 u32 num_different_channels;
2822 bool beacon_int_infra_match;
2823 u8 radar_detect_widths;
2824 u8 radar_detect_regions;
2827 struct ieee80211_txrx_stypes {
2832 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2833 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2834 * trigger that keeps the device operating as-is and
2835 * wakes up the host on any activity, for example a
2836 * received packet that passed filtering; note that the
2837 * packet should be preserved in that case
2838 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2840 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2841 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2842 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2843 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2844 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2845 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2846 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
2848 enum wiphy_wowlan_support_flags {
2849 WIPHY_WOWLAN_ANY = BIT(0),
2850 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2851 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2852 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2853 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2854 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2855 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2856 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2857 WIPHY_WOWLAN_NET_DETECT = BIT(8),
2860 struct wiphy_wowlan_tcp_support {
2861 const struct nl80211_wowlan_tcp_data_token_feature *tok;
2862 u32 data_payload_max;
2863 u32 data_interval_max;
2864 u32 wake_payload_max;
2869 * struct wiphy_wowlan_support - WoWLAN support data
2870 * @flags: see &enum wiphy_wowlan_support_flags
2871 * @n_patterns: number of supported wakeup patterns
2872 * (see nl80211.h for the pattern definition)
2873 * @pattern_max_len: maximum length of each pattern
2874 * @pattern_min_len: minimum length of each pattern
2875 * @max_pkt_offset: maximum Rx packet offset
2876 * @max_nd_match_sets: maximum number of matchsets for net-detect,
2877 * similar, but not necessarily identical, to max_match_sets for
2879 * See &struct cfg80211_sched_scan_request.@match_sets for more
2881 * @tcp: TCP wakeup support information
2883 struct wiphy_wowlan_support {
2886 int pattern_max_len;
2887 int pattern_min_len;
2889 int max_nd_match_sets;
2890 const struct wiphy_wowlan_tcp_support *tcp;
2894 * struct wiphy_coalesce_support - coalesce support data
2895 * @n_rules: maximum number of coalesce rules
2896 * @max_delay: maximum supported coalescing delay in msecs
2897 * @n_patterns: number of supported patterns in a rule
2898 * (see nl80211.h for the pattern definition)
2899 * @pattern_max_len: maximum length of each pattern
2900 * @pattern_min_len: minimum length of each pattern
2901 * @max_pkt_offset: maximum Rx packet offset
2903 struct wiphy_coalesce_support {
2907 int pattern_max_len;
2908 int pattern_min_len;
2913 * enum wiphy_vendor_command_flags - validation flags for vendor commands
2914 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
2915 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
2916 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
2917 * (must be combined with %_WDEV or %_NETDEV)
2919 enum wiphy_vendor_command_flags {
2920 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
2921 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
2922 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
2926 * struct wiphy_vendor_command - vendor command definition
2927 * @info: vendor command identifying information, as used in nl80211
2928 * @flags: flags, see &enum wiphy_vendor_command_flags
2929 * @doit: callback for the operation, note that wdev is %NULL if the
2930 * flags didn't ask for a wdev and non-%NULL otherwise; the data
2931 * pointer may be %NULL if userspace provided no data at all
2933 struct wiphy_vendor_command {
2934 struct nl80211_vendor_cmd_info info;
2936 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
2937 const void *data, int data_len);
2941 * struct wiphy - wireless hardware description
2942 * @reg_notifier: the driver's regulatory notification callback,
2943 * note that if your driver uses wiphy_apply_custom_regulatory()
2944 * the reg_notifier's request can be passed as NULL
2945 * @regd: the driver's regulatory domain, if one was requested via
2946 * the regulatory_hint() API. This can be used by the driver
2947 * on the reg_notifier() if it chooses to ignore future
2948 * regulatory domain changes caused by other drivers.
2949 * @signal_type: signal type reported in &struct cfg80211_bss.
2950 * @cipher_suites: supported cipher suites
2951 * @n_cipher_suites: number of supported cipher suites
2952 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2953 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2954 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2955 * -1 = fragmentation disabled, only odd values >= 256 used
2956 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2957 * @_net: the network namespace this wiphy currently lives in
2958 * @perm_addr: permanent MAC address of this device
2959 * @addr_mask: If the device supports multiple MAC addresses by masking,
2960 * set this to a mask with variable bits set to 1, e.g. if the last
2961 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
2962 * variable bits shall be determined by the interfaces added, with
2963 * interfaces not matching the mask being rejected to be brought up.
2964 * @n_addresses: number of addresses in @addresses.
2965 * @addresses: If the device has more than one address, set this pointer
2966 * to a list of addresses (6 bytes each). The first one will be used
2967 * by default for perm_addr. In this case, the mask should be set to
2968 * all-zeroes. In this case it is assumed that the device can handle
2969 * the same number of arbitrary MAC addresses.
2970 * @registered: protects ->resume and ->suspend sysfs callbacks against
2971 * unregister hardware
2972 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2973 * automatically on wiphy renames
2974 * @dev: (virtual) struct device for this wiphy
2975 * @registered: helps synchronize suspend/resume with wiphy unregister
2976 * @wext: wireless extension handlers
2977 * @priv: driver private data (sized according to wiphy_new() parameter)
2978 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2979 * must be set by driver
2980 * @iface_combinations: Valid interface combinations array, should not
2981 * list single interface types.
2982 * @n_iface_combinations: number of entries in @iface_combinations array.
2983 * @software_iftypes: bitmask of software interface types, these are not
2984 * subject to any restrictions since they are purely managed in SW.
2985 * @flags: wiphy flags, see &enum wiphy_flags
2986 * @regulatory_flags: wiphy regulatory flags, see
2987 * &enum ieee80211_regulatory_flags
2988 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2989 * @bss_priv_size: each BSS struct has private data allocated with it,
2990 * this variable determines its size
2991 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2993 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2994 * for in any given scheduled scan
2995 * @max_match_sets: maximum number of match sets the device can handle
2996 * when performing a scheduled scan, 0 if filtering is not
2998 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2999 * add to probe request frames transmitted during a scan, must not
3000 * include fixed IEs like supported rates
3001 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3003 * @coverage_class: current coverage class
3004 * @fw_version: firmware version for ethtool reporting
3005 * @hw_version: hardware version for ethtool reporting
3006 * @max_num_pmkids: maximum number of PMKIDs supported by device
3007 * @privid: a pointer that drivers can use to identify if an arbitrary
3008 * wiphy is theirs, e.g. in global notifiers
3009 * @bands: information about bands/channels supported by this device
3011 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3012 * transmitted through nl80211, points to an array indexed by interface
3015 * @available_antennas_tx: bitmap of antennas which are available to be
3016 * configured as TX antennas. Antenna configuration commands will be
3017 * rejected unless this or @available_antennas_rx is set.
3019 * @available_antennas_rx: bitmap of antennas which are available to be
3020 * configured as RX antennas. Antenna configuration commands will be
3021 * rejected unless this or @available_antennas_tx is set.
3023 * @probe_resp_offload:
3024 * Bitmap of supported protocols for probe response offloading.
3025 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3026 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3028 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3029 * may request, if implemented.
3031 * @wowlan: WoWLAN support information
3032 * @wowlan_config: current WoWLAN configuration; this should usually not be
3033 * used since access to it is necessarily racy, use the parameter passed
3034 * to the suspend() operation instead.
3036 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3037 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3038 * If null, then none can be over-ridden.
3039 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3040 * If null, then none can be over-ridden.
3042 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3045 * @extended_capabilities: extended capabilities supported by the driver,
3046 * additional capabilities might be supported by userspace; these are
3047 * the 802.11 extended capabilities ("Extended Capabilities element")
3048 * and are in the same format as in the information element. See
3049 * 802.11-2012 8.4.2.29 for the defined fields.
3050 * @extended_capabilities_mask: mask of the valid values
3051 * @extended_capabilities_len: length of the extended capabilities
3052 * @coalesce: packet coalescing support information
3054 * @vendor_commands: array of vendor commands supported by the hardware
3055 * @n_vendor_commands: number of vendor commands
3056 * @vendor_events: array of vendor events supported by the hardware
3057 * @n_vendor_events: number of vendor events
3059 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3060 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3061 * driver is allowed to advertise a theoretical limit that it can reach in
3062 * some cases, but may not always reach.
3064 * @max_num_csa_counters: Number of supported csa_counters in beacons
3065 * and probe responses. This value should be set if the driver
3066 * wishes to limit the number of csa counters. Default (0) means
3068 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3069 * frame was sent and the channel on which the frame was heard for which
3070 * the reported rssi is still valid. If a driver is able to compensate the
3071 * low rssi when a frame is heard on different channel, then it should set
3072 * this variable to the maximal offset for which it can compensate.
3073 * This value should be set in MHz.
3076 /* assign these fields before you register the wiphy */
3078 /* permanent MAC address(es) */
3079 u8 perm_addr[ETH_ALEN];
3080 u8 addr_mask[ETH_ALEN];
3082 struct mac_address *addresses;
3084 const struct ieee80211_txrx_stypes *mgmt_stypes;
3086 const struct ieee80211_iface_combination *iface_combinations;
3087 int n_iface_combinations;
3088 u16 software_iftypes;
3092 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3093 u16 interface_modes;
3095 u16 max_acl_mac_addrs;
3097 u32 flags, regulatory_flags, features;
3101 enum cfg80211_signal_type signal_type;
3105 u8 max_sched_scan_ssids;
3107 u16 max_scan_ie_len;
3108 u16 max_sched_scan_ie_len;
3110 int n_cipher_suites;
3111 const u32 *cipher_suites;
3119 char fw_version[ETHTOOL_FWVERS_LEN];
3123 const struct wiphy_wowlan_support *wowlan;
3124 struct cfg80211_wowlan *wowlan_config;
3127 u16 max_remain_on_channel_duration;
3131 u32 available_antennas_tx;
3132 u32 available_antennas_rx;
3135 * Bitmap of supported protocols for probe response offloading
3136 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3137 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3139 u32 probe_resp_offload;
3141 const u8 *extended_capabilities, *extended_capabilities_mask;
3142 u8 extended_capabilities_len;
3144 /* If multiple wiphys are registered and you're handed e.g.
3145 * a regular netdev with assigned ieee80211_ptr, you won't
3146 * know whether it points to a wiphy your driver has registered
3147 * or not. Assign this to something global to your driver to
3148 * help determine whether you own this wiphy or not. */
3151 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
3153 /* Lets us get back the wiphy on the callback */
3154 void (*reg_notifier)(struct wiphy *wiphy,
3155 struct regulatory_request *request);
3157 /* fields below are read-only, assigned by cfg80211 */
3159 const struct ieee80211_regdomain __rcu *regd;
3161 /* the item in /sys/class/ieee80211/ points to this,
3162 * you need use set_wiphy_dev() (see below) */
3165 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3168 /* dir in debugfs: ieee80211/<wiphyname> */
3169 struct dentry *debugfsdir;
3171 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3172 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3174 #ifdef CONFIG_NET_NS
3175 /* the network namespace this phy lives in currently */
3179 #ifdef CONFIG_CFG80211_WEXT
3180 const struct iw_handler_def *wext;
3183 const struct wiphy_coalesce_support *coalesce;
3185 const struct wiphy_vendor_command *vendor_commands;
3186 const struct nl80211_vendor_cmd_info *vendor_events;
3187 int n_vendor_commands, n_vendor_events;
3189 u16 max_ap_assoc_sta;
3191 u8 max_num_csa_counters;
3192 u8 max_adj_channel_rssi_comp;
3194 char priv[0] __aligned(NETDEV_ALIGN);
3197 static inline struct net *wiphy_net(struct wiphy *wiphy)
3199 return read_pnet(&wiphy->_net);
3202 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3204 write_pnet(&wiphy->_net, net);
3208 * wiphy_priv - return priv from wiphy
3210 * @wiphy: the wiphy whose priv pointer to return
3211 * Return: The priv of @wiphy.
3213 static inline void *wiphy_priv(struct wiphy *wiphy)
3216 return &wiphy->priv;
3220 * priv_to_wiphy - return the wiphy containing the priv
3222 * @priv: a pointer previously returned by wiphy_priv
3223 * Return: The wiphy of @priv.
3225 static inline struct wiphy *priv_to_wiphy(void *priv)
3228 return container_of(priv, struct wiphy, priv);
3232 * set_wiphy_dev - set device pointer for wiphy
3234 * @wiphy: The wiphy whose device to bind
3235 * @dev: The device to parent it to
3237 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3239 wiphy->dev.parent = dev;
3243 * wiphy_dev - get wiphy dev pointer
3245 * @wiphy: The wiphy whose device struct to look up
3246 * Return: The dev of @wiphy.
3248 static inline struct device *wiphy_dev(struct wiphy *wiphy)
3250 return wiphy->dev.parent;
3254 * wiphy_name - get wiphy name
3256 * @wiphy: The wiphy whose name to return
3257 * Return: The name of @wiphy.
3259 static inline const char *wiphy_name(const struct wiphy *wiphy)
3261 return dev_name(&wiphy->dev);
3265 * wiphy_new_nm - create a new wiphy for use with cfg80211
3267 * @ops: The configuration operations for this device
3268 * @sizeof_priv: The size of the private area to allocate
3269 * @requested_name: Request a particular name.
3270 * NULL is valid value, and means use the default phy%d naming.
3272 * Create a new wiphy and associate the given operations with it.
3273 * @sizeof_priv bytes are allocated for private use.
3275 * Return: A pointer to the new wiphy. This pointer must be
3276 * assigned to each netdev's ieee80211_ptr for proper operation.
3278 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3279 const char *requested_name);
3282 * wiphy_new - create a new wiphy for use with cfg80211
3284 * @ops: The configuration operations for this device
3285 * @sizeof_priv: The size of the private area to allocate
3287 * Create a new wiphy and associate the given operations with it.
3288 * @sizeof_priv bytes are allocated for private use.
3290 * Return: A pointer to the new wiphy. This pointer must be
3291 * assigned to each netdev's ieee80211_ptr for proper operation.
3293 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3296 return wiphy_new_nm(ops, sizeof_priv, NULL);
3300 * wiphy_register - register a wiphy with cfg80211
3302 * @wiphy: The wiphy to register.
3304 * Return: A non-negative wiphy index or a negative error code.
3306 int wiphy_register(struct wiphy *wiphy);
3309 * wiphy_unregister - deregister a wiphy from cfg80211
3311 * @wiphy: The wiphy to unregister.
3313 * After this call, no more requests can be made with this priv
3314 * pointer, but the call may sleep to wait for an outstanding
3315 * request that is being handled.
3317 void wiphy_unregister(struct wiphy *wiphy);
3320 * wiphy_free - free wiphy
3322 * @wiphy: The wiphy to free
3324 void wiphy_free(struct wiphy *wiphy);
3326 /* internal structs */
3327 struct cfg80211_conn;
3328 struct cfg80211_internal_bss;
3329 struct cfg80211_cached_keys;
3332 * struct wireless_dev - wireless device state
3334 * For netdevs, this structure must be allocated by the driver
3335 * that uses the ieee80211_ptr field in struct net_device (this
3336 * is intentional so it can be allocated along with the netdev.)
3337 * It need not be registered then as netdev registration will
3338 * be intercepted by cfg80211 to see the new wireless device.
3340 * For non-netdev uses, it must also be allocated by the driver
3341 * in response to the cfg80211 callbacks that require it, as
3342 * there's no netdev registration in that case it may not be
3343 * allocated outside of callback operations that return it.
3345 * @wiphy: pointer to hardware description
3346 * @iftype: interface type
3347 * @list: (private) Used to collect the interfaces
3348 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3349 * @identifier: (private) Identifier used in nl80211 to identify this
3350 * wireless device if it has no netdev
3351 * @current_bss: (private) Used by the internal configuration code
3352 * @chandef: (private) Used by the internal configuration code to track
3353 * the user-set channel definition.
3354 * @preset_chandef: (private) Used by the internal configuration code to
3355 * track the channel to be used for AP later
3356 * @bssid: (private) Used by the internal configuration code
3357 * @ssid: (private) Used by the internal configuration code
3358 * @ssid_len: (private) Used by the internal configuration code
3359 * @mesh_id_len: (private) Used by the internal configuration code
3360 * @mesh_id_up_len: (private) Used by the internal configuration code
3361 * @wext: (private) Used by the internal wireless extensions compat code
3362 * @use_4addr: indicates 4addr mode is used on this interface, must be
3363 * set by driver (if supported) on add_interface BEFORE registering the
3364 * netdev and may otherwise be used by driver read-only, will be update
3365 * by cfg80211 on change_interface
3366 * @mgmt_registrations: list of registrations for management frames
3367 * @mgmt_registrations_lock: lock for the list
3368 * @mtx: mutex used to lock data in this struct, may be used by drivers
3369 * and some API functions require it held
3370 * @beacon_interval: beacon interval used on this device for transmitting
3371 * beacons, 0 when not valid
3372 * @address: The address for this device, valid only if @netdev is %NULL
3373 * @p2p_started: true if this is a P2P Device that has been started
3374 * @cac_started: true if DFS channel availability check has been started
3375 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3376 * @cac_time_ms: CAC time in ms
3377 * @ps: powersave mode is enabled
3378 * @ps_timeout: dynamic powersave timeout
3379 * @ap_unexpected_nlportid: (private) netlink port ID of application
3380 * registered for unexpected class 3 frames (AP mode)
3381 * @conn: (private) cfg80211 software SME connection state machine data
3382 * @connect_keys: (private) keys to set after connection is established
3383 * @ibss_fixed: (private) IBSS is using fixed BSSID
3384 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3385 * @event_list: (private) list for internal event processing
3386 * @event_lock: (private) lock for event list
3387 * @owner_nlportid: (private) owner socket port ID
3389 struct wireless_dev {
3390 struct wiphy *wiphy;
3391 enum nl80211_iftype iftype;
3393 /* the remainder of this struct should be private to cfg80211 */
3394 struct list_head list;
3395 struct net_device *netdev;
3399 struct list_head mgmt_registrations;
3400 spinlock_t mgmt_registrations_lock;
3404 bool use_4addr, p2p_started;
3406 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3408 /* currently used for IBSS and SME - might be rearranged later */
3409 u8 ssid[IEEE80211_MAX_SSID_LEN];
3410 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3411 struct cfg80211_conn *conn;
3412 struct cfg80211_cached_keys *connect_keys;
3414 struct list_head event_list;
3415 spinlock_t event_lock;
3417 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3418 struct cfg80211_chan_def preset_chandef;
3419 struct cfg80211_chan_def chandef;
3422 bool ibss_dfs_possible;
3427 int beacon_interval;
3429 u32 ap_unexpected_nlportid;
3432 unsigned long cac_start_time;
3433 unsigned int cac_time_ms;
3437 #ifdef CONFIG_CFG80211_WEXT
3440 struct cfg80211_ibss_params ibss;
3441 struct cfg80211_connect_params connect;
3442 struct cfg80211_cached_keys *keys;
3445 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3446 u8 ssid[IEEE80211_MAX_SSID_LEN];
3447 s8 default_key, default_mgmt_key;
3448 bool prev_bssid_valid;
3453 static inline u8 *wdev_address(struct wireless_dev *wdev)
3456 return wdev->netdev->dev_addr;
3457 return wdev->address;
3461 * wdev_priv - return wiphy priv from wireless_dev
3463 * @wdev: The wireless device whose wiphy's priv pointer to return
3464 * Return: The wiphy priv of @wdev.
3466 static inline void *wdev_priv(struct wireless_dev *wdev)
3469 return wiphy_priv(wdev->wiphy);
3473 * DOC: Utility functions
3475 * cfg80211 offers a number of utility functions that can be useful.
3479 * ieee80211_channel_to_frequency - convert channel number to frequency
3480 * @chan: channel number
3481 * @band: band, necessary due to channel number overlap
3482 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3484 int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
3487 * ieee80211_frequency_to_channel - convert frequency to channel number
3488 * @freq: center frequency
3489 * Return: The corresponding channel, or 0 if the conversion failed.
3491 int ieee80211_frequency_to_channel(int freq);
3494 * Name indirection necessary because the ieee80211 code also has
3495 * a function named "ieee80211_get_channel", so if you include
3496 * cfg80211's header file you get cfg80211's version, if you try
3497 * to include both header files you'll (rightfully!) get a symbol
3500 struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3503 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3504 * @wiphy: the struct wiphy to get the channel for
3505 * @freq: the center frequency of the channel
3506 * Return: The channel struct from @wiphy at @freq.
3508 static inline struct ieee80211_channel *
3509 ieee80211_get_channel(struct wiphy *wiphy, int freq)
3511 return __ieee80211_get_channel(wiphy, freq);
3515 * ieee80211_get_response_rate - get basic rate for a given rate
3517 * @sband: the band to look for rates in
3518 * @basic_rates: bitmap of basic rates
3519 * @bitrate: the bitrate for which to find the basic rate
3521 * Return: The basic rate corresponding to a given bitrate, that
3522 * is the next lower bitrate contained in the basic rate map,
3523 * which is, for this function, given as a bitmap of indices of
3524 * rates in the band's bitrate table.
3526 struct ieee80211_rate *
3527 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3528 u32 basic_rates, int bitrate);
3531 * ieee80211_mandatory_rates - get mandatory rates for a given band
3532 * @sband: the band to look for rates in
3533 * @scan_width: width of the control channel
3535 * This function returns a bitmap of the mandatory rates for the given
3536 * band, bits are set according to the rate position in the bitrates array.
3538 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3539 enum nl80211_bss_scan_width scan_width);
3542 * Radiotap parsing functions -- for controlled injection support
3544 * Implemented in net/wireless/radiotap.c
3545 * Documentation in Documentation/networking/radiotap-headers.txt
3548 struct radiotap_align_size {
3549 uint8_t align:4, size:4;
3552 struct ieee80211_radiotap_namespace {
3553 const struct radiotap_align_size *align_size;
3559 struct ieee80211_radiotap_vendor_namespaces {
3560 const struct ieee80211_radiotap_namespace *ns;
3565 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3566 * @this_arg_index: index of current arg, valid after each successful call
3567 * to ieee80211_radiotap_iterator_next()
3568 * @this_arg: pointer to current radiotap arg; it is valid after each
3569 * call to ieee80211_radiotap_iterator_next() but also after
3570 * ieee80211_radiotap_iterator_init() where it will point to
3571 * the beginning of the actual data portion
3572 * @this_arg_size: length of the current arg, for convenience
3573 * @current_namespace: pointer to the current namespace definition
3574 * (or internally %NULL if the current namespace is unknown)
3575 * @is_radiotap_ns: indicates whether the current namespace is the default
3576 * radiotap namespace or not
3578 * @_rtheader: pointer to the radiotap header we are walking through
3579 * @_max_length: length of radiotap header in cpu byte ordering
3580 * @_arg_index: next argument index
3581 * @_arg: next argument pointer
3582 * @_next_bitmap: internal pointer to next present u32
3583 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3584 * @_vns: vendor namespace definitions
3585 * @_next_ns_data: beginning of the next namespace's data
3586 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3589 * Describes the radiotap parser state. Fields prefixed with an underscore
3590 * must not be used by users of the parser, only by the parser internally.
3593 struct ieee80211_radiotap_iterator {
3594 struct ieee80211_radiotap_header *_rtheader;
3595 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3596 const struct ieee80211_radiotap_namespace *current_namespace;
3598 unsigned char *_arg, *_next_ns_data;
3599 __le32 *_next_bitmap;
3601 unsigned char *this_arg;
3609 uint32_t _bitmap_shifter;
3614 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3615 struct ieee80211_radiotap_header *radiotap_header,
3617 const struct ieee80211_radiotap_vendor_namespaces *vns);
3620 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3623 extern const unsigned char rfc1042_header[6];
3624 extern const unsigned char bridge_tunnel_header[6];
3627 * ieee80211_get_hdrlen_from_skb - get header length from data
3631 * Given an skb with a raw 802.11 header at the data pointer this function
3632 * returns the 802.11 header length.
3634 * Return: The 802.11 header length in bytes (not including encryption
3635 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3638 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3641 * ieee80211_hdrlen - get header length in bytes from frame control
3642 * @fc: frame control field in little-endian format
3643 * Return: The header length in bytes.
3645 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3648 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3649 * @meshhdr: the mesh extension header, only the flags field
3650 * (first byte) will be accessed
3651 * Return: The length of the extension header, which is always at
3652 * least 6 bytes and at most 18 if address 5 and 6 are present.
3654 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3657 * DOC: Data path helpers
3659 * In addition to generic utilities, cfg80211 also offers
3660 * functions that help implement the data path for devices
3661 * that do not do the 802.11/802.3 conversion on the device.
3665 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3666 * @skb: the 802.11 data frame
3667 * @addr: the device MAC address
3668 * @iftype: the virtual interface type
3669 * Return: 0 on success. Non-zero on error.
3671 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3672 enum nl80211_iftype iftype);
3675 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3676 * @skb: the 802.3 frame
3677 * @addr: the device MAC address
3678 * @iftype: the virtual interface type
3679 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3680 * @qos: build 802.11 QoS data frame
3681 * Return: 0 on success, or a negative error code.
3683 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3684 enum nl80211_iftype iftype, const u8 *bssid,
3688 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3690 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3691 * 802.3 frames. The @list will be empty if the decode fails. The
3692 * @skb is consumed after the function returns.
3694 * @skb: The input IEEE 802.11n A-MSDU frame.
3695 * @list: The output list of 802.3 frames. It must be allocated and
3696 * initialized by by the caller.
3697 * @addr: The device MAC address.
3698 * @iftype: The device interface type.
3699 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3700 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3702 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3703 const u8 *addr, enum nl80211_iftype iftype,
3704 const unsigned int extra_headroom,
3705 bool has_80211_header);
3708 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3709 * @skb: the data frame
3710 * @qos_map: Interworking QoS mapping or %NULL if not in use
3711 * Return: The 802.1p/1d tag.
3713 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3714 struct cfg80211_qos_map *qos_map);
3717 * cfg80211_find_ie - find information element in data
3720 * @ies: data consisting of IEs
3721 * @len: length of data
3723 * Return: %NULL if the element ID could not be found or if
3724 * the element is invalid (claims to be longer than the given
3725 * data), or a pointer to the first byte of the requested
3726 * element, that is the byte containing the element ID.
3728 * Note: There are no checks on the element length other than
3729 * having to fit into the given data.
3731 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3734 * cfg80211_find_vendor_ie - find vendor specific information element in data
3737 * @oui_type: vendor-specific OUI type
3738 * @ies: data consisting of IEs
3739 * @len: length of data
3741 * Return: %NULL if the vendor specific element ID could not be found or if the
3742 * element is invalid (claims to be longer than the given data), or a pointer to
3743 * the first byte of the requested element, that is the byte containing the
3746 * Note: There are no checks on the element length other than having to fit into
3749 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3750 const u8 *ies, int len);
3753 * DOC: Regulatory enforcement infrastructure
3759 * regulatory_hint - driver hint to the wireless core a regulatory domain
3760 * @wiphy: the wireless device giving the hint (used only for reporting
3762 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3763 * should be in. If @rd is set this should be NULL. Note that if you
3764 * set this to NULL you should still set rd->alpha2 to some accepted
3767 * Wireless drivers can use this function to hint to the wireless core
3768 * what it believes should be the current regulatory domain by
3769 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3770 * domain should be in or by providing a completely build regulatory domain.
3771 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3772 * for a regulatory domain structure for the respective country.
3774 * The wiphy must have been registered to cfg80211 prior to this call.
3775 * For cfg80211 drivers this means you must first use wiphy_register(),
3776 * for mac80211 drivers you must first use ieee80211_register_hw().
3778 * Drivers should check the return value, its possible you can get
3781 * Return: 0 on success. -ENOMEM.
3783 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3786 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3787 * @wiphy: the wireless device we want to process the regulatory domain on
3788 * @regd: the custom regulatory domain to use for this wiphy
3790 * Drivers can sometimes have custom regulatory domains which do not apply
3791 * to a specific country. Drivers can use this to apply such custom regulatory
3792 * domains. This routine must be called prior to wiphy registration. The
3793 * custom regulatory domain will be trusted completely and as such previous
3794 * default channel settings will be disregarded. If no rule is found for a
3795 * channel on the regulatory domain the channel will be disabled.
3796 * Drivers using this for a wiphy should also set the wiphy flag
3797 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
3798 * that called this helper.
3800 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
3801 const struct ieee80211_regdomain *regd);
3804 * freq_reg_info - get regulatory information for the given frequency
3805 * @wiphy: the wiphy for which we want to process this rule for
3806 * @center_freq: Frequency in KHz for which we want regulatory information for
3808 * Use this function to get the regulatory rule for a specific frequency on
3809 * a given wireless device. If the device has a specific regulatory domain
3810 * it wants to follow we respect that unless a country IE has been received
3811 * and processed already.
3813 * Return: A valid pointer, or, when an error occurs, for example if no rule
3814 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3815 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3816 * value will be -ERANGE if we determine the given center_freq does not even
3817 * have a regulatory rule for a frequency range in the center_freq's band.
3818 * See freq_in_rule_band() for our current definition of a band -- this is
3819 * purely subjective and right now it's 802.11 specific.
3821 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3825 * reg_initiator_name - map regulatory request initiator enum to name
3826 * @initiator: the regulatory request initiator
3828 * You can use this to map the regulatory request initiator enum to a
3829 * proper string representation.
3831 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
3834 * callbacks for asynchronous cfg80211 methods, notification
3835 * functions and BSS handling helpers
3839 * cfg80211_scan_done - notify that scan finished
3841 * @request: the corresponding scan request
3842 * @aborted: set to true if the scan was aborted for any reason,
3843 * userspace will be notified of that
3845 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3848 * cfg80211_sched_scan_results - notify that new scan results are available
3850 * @wiphy: the wiphy which got scheduled scan results
3852 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3855 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3857 * @wiphy: the wiphy on which the scheduled scan stopped
3859 * The driver can call this function to inform cfg80211 that the
3860 * scheduled scan had to be stopped, for whatever reason. The driver
3861 * is then called back via the sched_scan_stop operation when done.
3863 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3866 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
3868 * @wiphy: the wiphy on which the scheduled scan stopped
3870 * The driver can call this function to inform cfg80211 that the
3871 * scheduled scan had to be stopped, for whatever reason. The driver
3872 * is then called back via the sched_scan_stop operation when done.
3873 * This function should be called with rtnl locked.
3875 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
3878 * cfg80211_inform_bss_width_frame - inform cfg80211 of a received BSS frame
3880 * @wiphy: the wiphy reporting the BSS
3881 * @rx_channel: The channel the frame was received on
3882 * @scan_width: width of the control channel
3883 * @mgmt: the management frame (probe response or beacon)
3884 * @len: length of the management frame
3885 * @signal: the signal strength, type depends on the wiphy's signal_type
3886 * @gfp: context flags
3888 * This informs cfg80211 that BSS information was found and
3889 * the BSS should be updated/added.
3891 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3892 * Or %NULL on error.
3894 struct cfg80211_bss * __must_check
3895 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
3896 struct ieee80211_channel *rx_channel,
3897 enum nl80211_bss_scan_width scan_width,
3898 struct ieee80211_mgmt *mgmt, size_t len,
3899 s32 signal, gfp_t gfp);
3901 static inline struct cfg80211_bss * __must_check
3902 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3903 struct ieee80211_channel *rx_channel,
3904 struct ieee80211_mgmt *mgmt, size_t len,
3905 s32 signal, gfp_t gfp)
3907 return cfg80211_inform_bss_width_frame(wiphy, rx_channel,
3908 NL80211_BSS_CHAN_WIDTH_20,
3909 mgmt, len, signal, gfp);
3913 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
3914 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
3915 * from a beacon or probe response
3916 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
3917 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
3919 enum cfg80211_bss_frame_type {
3920 CFG80211_BSS_FTYPE_UNKNOWN,
3921 CFG80211_BSS_FTYPE_BEACON,
3922 CFG80211_BSS_FTYPE_PRESP,
3926 * cfg80211_inform_bss_width - inform cfg80211 of a new BSS
3928 * @wiphy: the wiphy reporting the BSS
3929 * @rx_channel: The channel the frame was received on
3930 * @scan_width: width of the control channel
3931 * @ftype: frame type (if known)
3932 * @bssid: the BSSID of the BSS
3933 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3934 * @capability: the capability field sent by the peer
3935 * @beacon_interval: the beacon interval announced by the peer
3936 * @ie: additional IEs sent by the peer
3937 * @ielen: length of the additional IEs
3938 * @signal: the signal strength, type depends on the wiphy's signal_type
3939 * @gfp: context flags
3941 * This informs cfg80211 that BSS information was found and
3942 * the BSS should be updated/added.
3944 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3945 * Or %NULL on error.
3947 struct cfg80211_bss * __must_check
3948 cfg80211_inform_bss_width(struct wiphy *wiphy,
3949 struct ieee80211_channel *rx_channel,
3950 enum nl80211_bss_scan_width scan_width,
3951 enum cfg80211_bss_frame_type ftype,
3952 const u8 *bssid, u64 tsf, u16 capability,
3953 u16 beacon_interval, const u8 *ie, size_t ielen,
3954 s32 signal, gfp_t gfp);
3956 static inline struct cfg80211_bss * __must_check
3957 cfg80211_inform_bss(struct wiphy *wiphy,
3958 struct ieee80211_channel *rx_channel,
3959 enum cfg80211_bss_frame_type ftype,
3960 const u8 *bssid, u64 tsf, u16 capability,
3961 u16 beacon_interval, const u8 *ie, size_t ielen,
3962 s32 signal, gfp_t gfp)
3964 return cfg80211_inform_bss_width(wiphy, rx_channel,
3965 NL80211_BSS_CHAN_WIDTH_20, ftype,
3966 bssid, tsf, capability,
3967 beacon_interval, ie, ielen, signal,
3971 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3972 struct ieee80211_channel *channel,
3974 const u8 *ssid, size_t ssid_len,
3975 u16 capa_mask, u16 capa_val);
3976 static inline struct cfg80211_bss *
3977 cfg80211_get_ibss(struct wiphy *wiphy,
3978 struct ieee80211_channel *channel,
3979 const u8 *ssid, size_t ssid_len)
3981 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3982 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3986 * cfg80211_ref_bss - reference BSS struct
3987 * @wiphy: the wiphy this BSS struct belongs to
3988 * @bss: the BSS struct to reference
3990 * Increments the refcount of the given BSS struct.
3992 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3995 * cfg80211_put_bss - unref BSS struct
3996 * @wiphy: the wiphy this BSS struct belongs to
3997 * @bss: the BSS struct
3999 * Decrements the refcount of the given BSS struct.
4001 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4004 * cfg80211_unlink_bss - unlink BSS from internal data structures
4006 * @bss: the bss to remove
4008 * This function removes the given BSS from the internal data structures
4009 * thereby making it no longer show up in scan results etc. Use this
4010 * function when you detect a BSS is gone. Normally BSSes will also time
4011 * out, so it is not necessary to use this function at all.
4013 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4015 static inline enum nl80211_bss_scan_width
4016 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4018 switch (chandef->width) {
4019 case NL80211_CHAN_WIDTH_5:
4020 return NL80211_BSS_CHAN_WIDTH_5;
4021 case NL80211_CHAN_WIDTH_10:
4022 return NL80211_BSS_CHAN_WIDTH_10;
4024 return NL80211_BSS_CHAN_WIDTH_20;
4029 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4030 * @dev: network device
4031 * @buf: authentication frame (header + body)
4032 * @len: length of the frame data
4034 * This function is called whenever an authentication, disassociation or
4035 * deauthentication frame has been received and processed in station mode.
4036 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4037 * call either this function or cfg80211_auth_timeout().
4038 * After being asked to associate via cfg80211_ops::assoc() the driver must
4039 * call either this function or cfg80211_auth_timeout().
4040 * While connected, the driver must calls this for received and processed
4041 * disassociation and deauthentication frames. If the frame couldn't be used
4042 * because it was unprotected, the driver must call the function
4043 * cfg80211_rx_unprot_mlme_mgmt() instead.
4045 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4047 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4050 * cfg80211_auth_timeout - notification of timed out authentication
4051 * @dev: network device
4052 * @addr: The MAC address of the device with which the authentication timed out
4054 * This function may sleep. The caller must hold the corresponding wdev's
4057 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4060 * cfg80211_rx_assoc_resp - notification of processed association response
4061 * @dev: network device
4062 * @bss: the BSS that association was requested with, ownership of the pointer
4063 * moves to cfg80211 in this call
4064 * @buf: authentication frame (header + body)
4065 * @len: length of the frame data
4066 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
4068 * After being asked to associate via cfg80211_ops::assoc() the driver must
4069 * call either this function or cfg80211_auth_timeout().
4071 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4073 void cfg80211_rx_assoc_resp(struct net_device *dev,
4074 struct cfg80211_bss *bss,
4075 const u8 *buf, size_t len,
4079 * cfg80211_assoc_timeout - notification of timed out association
4080 * @dev: network device
4081 * @bss: The BSS entry with which association timed out.
4083 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4085 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4088 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4089 * @dev: network device
4090 * @buf: 802.11 frame (header + body)
4091 * @len: length of the frame data
4093 * This function is called whenever deauthentication has been processed in
4094 * station mode. This includes both received deauthentication frames and
4095 * locally generated ones. This function may sleep. The caller must hold the
4096 * corresponding wdev's mutex.
4098 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4101 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4102 * @dev: network device
4103 * @buf: deauthentication frame (header + body)
4104 * @len: length of the frame data
4106 * This function is called whenever a received deauthentication or dissassoc
4107 * frame has been dropped in station mode because of MFP being used but the
4108 * frame was not protected. This function may sleep.
4110 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4111 const u8 *buf, size_t len);
4114 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4115 * @dev: network device
4116 * @addr: The source MAC address of the frame
4117 * @key_type: The key type that the received frame used
4118 * @key_id: Key identifier (0..3). Can be -1 if missing.
4119 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4120 * @gfp: allocation flags
4122 * This function is called whenever the local MAC detects a MIC failure in a
4123 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4126 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4127 enum nl80211_key_type key_type, int key_id,
4128 const u8 *tsc, gfp_t gfp);
4131 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4133 * @dev: network device
4134 * @bssid: the BSSID of the IBSS joined
4135 * @channel: the channel of the IBSS joined
4136 * @gfp: allocation flags
4138 * This function notifies cfg80211 that the device joined an IBSS or
4139 * switched to a different BSSID. Before this function can be called,
4140 * either a beacon has to have been received from the IBSS, or one of
4141 * the cfg80211_inform_bss{,_frame} functions must have been called
4142 * with the locally generated beacon -- this guarantees that there is
4143 * always a scan result for this IBSS. cfg80211 will handle the rest.
4145 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4146 struct ieee80211_channel *channel, gfp_t gfp);
4149 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4151 * @dev: network device
4152 * @macaddr: the MAC address of the new candidate
4153 * @ie: information elements advertised by the peer candidate
4154 * @ie_len: lenght of the information elements buffer
4155 * @gfp: allocation flags
4157 * This function notifies cfg80211 that the mesh peer candidate has been
4158 * detected, most likely via a beacon or, less likely, via a probe response.
4159 * cfg80211 then sends a notification to userspace.
4161 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4162 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4165 * DOC: RFkill integration
4167 * RFkill integration in cfg80211 is almost invisible to drivers,
4168 * as cfg80211 automatically registers an rfkill instance for each
4169 * wireless device it knows about. Soft kill is also translated
4170 * into disconnecting and turning all interfaces off, drivers are
4171 * expected to turn off the device when all interfaces are down.
4173 * However, devices may have a hard RFkill line, in which case they
4174 * also need to interact with the rfkill subsystem, via cfg80211.
4175 * They can do this with a few helper functions documented here.
4179 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4181 * @blocked: block status
4183 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4186 * wiphy_rfkill_start_polling - start polling rfkill
4189 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4192 * wiphy_rfkill_stop_polling - stop polling rfkill
4195 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4198 * DOC: Vendor commands
4200 * Occasionally, there are special protocol or firmware features that
4201 * can't be implemented very openly. For this and similar cases, the
4202 * vendor command functionality allows implementing the features with
4203 * (typically closed-source) userspace and firmware, using nl80211 as
4204 * the configuration mechanism.
4206 * A driver supporting vendor commands must register them as an array
4207 * in struct wiphy, with handlers for each one, each command has an
4208 * OUI and sub command ID to identify it.
4210 * Note that this feature should not be (ab)used to implement protocol
4211 * features that could openly be shared across drivers. In particular,
4212 * it must never be required to use vendor commands to implement any
4213 * "normal" functionality that higher-level userspace like connection
4214 * managers etc. need.
4217 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4218 enum nl80211_commands cmd,
4219 enum nl80211_attrs attr,
4222 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4223 enum nl80211_commands cmd,
4224 enum nl80211_attrs attr,
4225 int vendor_event_idx,
4226 int approxlen, gfp_t gfp);
4228 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4231 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4233 * @approxlen: an upper bound of the length of the data that will
4234 * be put into the skb
4236 * This function allocates and pre-fills an skb for a reply to
4237 * a vendor command. Since it is intended for a reply, calling
4238 * it outside of a vendor command's doit() operation is invalid.
4240 * The returned skb is pre-filled with some identifying data in
4241 * a way that any data that is put into the skb (with skb_put(),
4242 * nla_put() or similar) will end up being within the
4243 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4244 * with the skb is adding data for the corresponding userspace tool
4245 * which can then read that data out of the vendor data attribute.
4246 * You must not modify the skb in any other way.
4248 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4249 * its error code as the result of the doit() operation.
4251 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4253 static inline struct sk_buff *
4254 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4256 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4257 NL80211_ATTR_VENDOR_DATA, approxlen);
4261 * cfg80211_vendor_cmd_reply - send the reply skb
4262 * @skb: The skb, must have been allocated with
4263 * cfg80211_vendor_cmd_alloc_reply_skb()
4265 * Since calling this function will usually be the last thing
4266 * before returning from the vendor command doit() you should
4267 * return the error code. Note that this function consumes the
4268 * skb regardless of the return value.
4270 * Return: An error code or 0 on success.
4272 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4275 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4277 * @event_idx: index of the vendor event in the wiphy's vendor_events
4278 * @approxlen: an upper bound of the length of the data that will
4279 * be put into the skb
4280 * @gfp: allocation flags
4282 * This function allocates and pre-fills an skb for an event on the
4283 * vendor-specific multicast group.
4285 * When done filling the skb, call cfg80211_vendor_event() with the
4286 * skb to send the event.
4288 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4290 static inline struct sk_buff *
4291 cfg80211_vendor_event_alloc(struct wiphy *wiphy, int approxlen,
4292 int event_idx, gfp_t gfp)
4294 return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_VENDOR,
4295 NL80211_ATTR_VENDOR_DATA,
4296 event_idx, approxlen, gfp);
4300 * cfg80211_vendor_event - send the event
4301 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4302 * @gfp: allocation flags
4304 * This function sends the given @skb, which must have been allocated
4305 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4307 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4309 __cfg80211_send_event_skb(skb, gfp);
4312 #ifdef CONFIG_NL80211_TESTMODE
4316 * Test mode is a set of utility functions to allow drivers to
4317 * interact with driver-specific tools to aid, for instance,
4318 * factory programming.
4320 * This chapter describes how drivers interact with it, for more
4321 * information see the nl80211 book's chapter on it.
4325 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4327 * @approxlen: an upper bound of the length of the data that will
4328 * be put into the skb
4330 * This function allocates and pre-fills an skb for a reply to
4331 * the testmode command. Since it is intended for a reply, calling
4332 * it outside of the @testmode_cmd operation is invalid.
4334 * The returned skb is pre-filled with the wiphy index and set up in
4335 * a way that any data that is put into the skb (with skb_put(),
4336 * nla_put() or similar) will end up being within the
4337 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4338 * with the skb is adding data for the corresponding userspace tool
4339 * which can then read that data out of the testdata attribute. You
4340 * must not modify the skb in any other way.
4342 * When done, call cfg80211_testmode_reply() with the skb and return
4343 * its error code as the result of the @testmode_cmd operation.
4345 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4347 static inline struct sk_buff *
4348 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4350 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4351 NL80211_ATTR_TESTDATA, approxlen);
4355 * cfg80211_testmode_reply - send the reply skb
4356 * @skb: The skb, must have been allocated with
4357 * cfg80211_testmode_alloc_reply_skb()
4359 * Since calling this function will usually be the last thing
4360 * before returning from the @testmode_cmd you should return
4361 * the error code. Note that this function consumes the skb
4362 * regardless of the return value.
4364 * Return: An error code or 0 on success.
4366 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4368 return cfg80211_vendor_cmd_reply(skb);
4372 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4374 * @approxlen: an upper bound of the length of the data that will
4375 * be put into the skb
4376 * @gfp: allocation flags
4378 * This function allocates and pre-fills an skb for an event on the
4379 * testmode multicast group.
4381 * The returned skb is set up in the same way as with
4382 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4383 * there, you should simply add data to it that will then end up in the
4384 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4387 * When done filling the skb, call cfg80211_testmode_event() with the
4388 * skb to send the event.
4390 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4392 static inline struct sk_buff *
4393 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4395 return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_TESTMODE,
4396 NL80211_ATTR_TESTDATA, -1,
4401 * cfg80211_testmode_event - send the event
4402 * @skb: The skb, must have been allocated with
4403 * cfg80211_testmode_alloc_event_skb()
4404 * @gfp: allocation flags
4406 * This function sends the given @skb, which must have been allocated
4407 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4410 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4412 __cfg80211_send_event_skb(skb, gfp);
4415 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
4416 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
4418 #define CFG80211_TESTMODE_CMD(cmd)
4419 #define CFG80211_TESTMODE_DUMP(cmd)
4423 * cfg80211_connect_result - notify cfg80211 of connection result
4425 * @dev: network device
4426 * @bssid: the BSSID of the AP
4427 * @req_ie: association request IEs (maybe be %NULL)
4428 * @req_ie_len: association request IEs length
4429 * @resp_ie: association response IEs (may be %NULL)
4430 * @resp_ie_len: assoc response IEs length
4431 * @status: status code, 0 for successful connection, use
4432 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4433 * the real status code for failures.
4434 * @gfp: allocation flags
4436 * It should be called by the underlying driver whenever connect() has
4439 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4440 const u8 *req_ie, size_t req_ie_len,
4441 const u8 *resp_ie, size_t resp_ie_len,
4442 u16 status, gfp_t gfp);
4445 * cfg80211_roamed - notify cfg80211 of roaming
4447 * @dev: network device
4448 * @channel: the channel of the new AP
4449 * @bssid: the BSSID of the new AP
4450 * @req_ie: association request IEs (maybe be %NULL)
4451 * @req_ie_len: association request IEs length
4452 * @resp_ie: association response IEs (may be %NULL)
4453 * @resp_ie_len: assoc response IEs length
4454 * @gfp: allocation flags
4456 * It should be called by the underlying driver whenever it roamed
4457 * from one AP to another while connected.
4459 void cfg80211_roamed(struct net_device *dev,
4460 struct ieee80211_channel *channel,
4462 const u8 *req_ie, size_t req_ie_len,
4463 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4466 * cfg80211_roamed_bss - notify cfg80211 of roaming
4468 * @dev: network device
4469 * @bss: entry of bss to which STA got roamed
4470 * @req_ie: association request IEs (maybe be %NULL)
4471 * @req_ie_len: association request IEs length
4472 * @resp_ie: association response IEs (may be %NULL)
4473 * @resp_ie_len: assoc response IEs length
4474 * @gfp: allocation flags
4476 * This is just a wrapper to notify cfg80211 of roaming event with driver
4477 * passing bss to avoid a race in timeout of the bss entry. It should be
4478 * called by the underlying driver whenever it roamed from one AP to another
4479 * while connected. Drivers which have roaming implemented in firmware
4480 * may use this function to avoid a race in bss entry timeout where the bss
4481 * entry of the new AP is seen in the driver, but gets timed out by the time
4482 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4483 * rdev->event_work. In case of any failures, the reference is released
4484 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4485 * it will be released while diconneting from the current bss.
4487 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4488 const u8 *req_ie, size_t req_ie_len,
4489 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4492 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4494 * @dev: network device
4495 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4496 * @ie_len: length of IEs
4497 * @reason: reason code for the disconnection, set it to 0 if unknown
4498 * @gfp: allocation flags
4500 * After it calls this function, the driver should enter an idle state
4501 * and not try to connect to any AP any more.
4503 void cfg80211_disconnected(struct net_device *dev, u16 reason,
4504 const u8 *ie, size_t ie_len, gfp_t gfp);
4507 * cfg80211_ready_on_channel - notification of remain_on_channel start
4508 * @wdev: wireless device
4509 * @cookie: the request cookie
4510 * @chan: The current channel (from remain_on_channel request)
4511 * @duration: Duration in milliseconds that the driver intents to remain on the
4513 * @gfp: allocation flags
4515 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4516 struct ieee80211_channel *chan,
4517 unsigned int duration, gfp_t gfp);
4520 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4521 * @wdev: wireless device
4522 * @cookie: the request cookie
4523 * @chan: The current channel (from remain_on_channel request)
4524 * @gfp: allocation flags
4526 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4527 struct ieee80211_channel *chan,
4532 * cfg80211_new_sta - notify userspace about station
4535 * @mac_addr: the station's address
4536 * @sinfo: the station information
4537 * @gfp: allocation flags
4539 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4540 struct station_info *sinfo, gfp_t gfp);
4543 * cfg80211_del_sta - notify userspace about deletion of a station
4546 * @mac_addr: the station's address
4547 * @gfp: allocation flags
4549 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
4552 * cfg80211_conn_failed - connection request failed notification
4555 * @mac_addr: the station's address
4556 * @reason: the reason for connection failure
4557 * @gfp: allocation flags
4559 * Whenever a station tries to connect to an AP and if the station
4560 * could not connect to the AP as the AP has rejected the connection
4561 * for some reasons, this function is called.
4563 * The reason for connection failure can be any of the value from
4564 * nl80211_connect_failed_reason enum
4566 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4567 enum nl80211_connect_failed_reason reason,
4571 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4572 * @wdev: wireless device receiving the frame
4573 * @freq: Frequency on which the frame was received in MHz
4574 * @sig_dbm: signal strength in mBm, or 0 if unknown
4575 * @buf: Management frame (header + body)
4576 * @len: length of the frame data
4577 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4579 * This function is called whenever an Action frame is received for a station
4580 * mode interface, but is not processed in kernel.
4582 * Return: %true if a user space application has registered for this frame.
4583 * For action frames, that makes it responsible for rejecting unrecognized
4584 * action frames; %false otherwise, in which case for action frames the
4585 * driver is responsible for rejecting the frame.
4587 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4588 const u8 *buf, size_t len, u32 flags);
4591 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4592 * @wdev: wireless device receiving the frame
4593 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4594 * @buf: Management frame (header + body)
4595 * @len: length of the frame data
4596 * @ack: Whether frame was acknowledged
4597 * @gfp: context flags
4599 * This function is called whenever a management frame was requested to be
4600 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4601 * transmission attempt.
4603 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4604 const u8 *buf, size_t len, bool ack, gfp_t gfp);
4608 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4609 * @dev: network device
4610 * @rssi_event: the triggered RSSI event
4611 * @gfp: context flags
4613 * This function is called when a configured connection quality monitoring
4614 * rssi threshold reached event occurs.
4616 void cfg80211_cqm_rssi_notify(struct net_device *dev,
4617 enum nl80211_cqm_rssi_threshold_event rssi_event,
4621 * cfg80211_radar_event - radar detection event
4623 * @chandef: chandef for the current channel
4624 * @gfp: context flags
4626 * This function is called when a radar is detected on the current chanenl.
4628 void cfg80211_radar_event(struct wiphy *wiphy,
4629 struct cfg80211_chan_def *chandef, gfp_t gfp);
4632 * cfg80211_cac_event - Channel availability check (CAC) event
4633 * @netdev: network device
4634 * @chandef: chandef for the current channel
4635 * @event: type of event
4636 * @gfp: context flags
4638 * This function is called when a Channel availability check (CAC) is finished
4639 * or aborted. This must be called to notify the completion of a CAC process,
4640 * also by full-MAC drivers.
4642 void cfg80211_cac_event(struct net_device *netdev,
4643 const struct cfg80211_chan_def *chandef,
4644 enum nl80211_radar_event event, gfp_t gfp);
4648 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4649 * @dev: network device
4650 * @peer: peer's MAC address
4651 * @num_packets: how many packets were lost -- should be a fixed threshold
4652 * but probably no less than maybe 50, or maybe a throughput dependent
4653 * threshold (to account for temporary interference)
4654 * @gfp: context flags
4656 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4657 const u8 *peer, u32 num_packets, gfp_t gfp);
4660 * cfg80211_cqm_txe_notify - TX error rate event
4661 * @dev: network device
4662 * @peer: peer's MAC address
4663 * @num_packets: how many packets were lost
4664 * @rate: % of packets which failed transmission
4665 * @intvl: interval (in s) over which the TX failure threshold was breached.
4666 * @gfp: context flags
4668 * Notify userspace when configured % TX failures over number of packets in a
4669 * given interval is exceeded.
4671 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4672 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4675 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4676 * @dev: network device
4677 * @bssid: BSSID of AP (to avoid races)
4678 * @replay_ctr: new replay counter
4679 * @gfp: allocation flags
4681 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4682 const u8 *replay_ctr, gfp_t gfp);
4685 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4686 * @dev: network device
4687 * @index: candidate index (the smaller the index, the higher the priority)
4688 * @bssid: BSSID of AP
4689 * @preauth: Whether AP advertises support for RSN pre-authentication
4690 * @gfp: allocation flags
4692 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4693 const u8 *bssid, bool preauth, gfp_t gfp);
4696 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4697 * @dev: The device the frame matched to
4698 * @addr: the transmitter address
4699 * @gfp: context flags
4701 * This function is used in AP mode (only!) to inform userspace that
4702 * a spurious class 3 frame was received, to be able to deauth the
4704 * Return: %true if the frame was passed to userspace (or this failed
4705 * for a reason other than not having a subscription.)
4707 bool cfg80211_rx_spurious_frame(struct net_device *dev,
4708 const u8 *addr, gfp_t gfp);
4711 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4712 * @dev: The device the frame matched to
4713 * @addr: the transmitter address
4714 * @gfp: context flags
4716 * This function is used in AP mode (only!) to inform userspace that
4717 * an associated station sent a 4addr frame but that wasn't expected.
4718 * It is allowed and desirable to send this event only once for each
4719 * station to avoid event flooding.
4720 * Return: %true if the frame was passed to userspace (or this failed
4721 * for a reason other than not having a subscription.)
4723 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4724 const u8 *addr, gfp_t gfp);
4727 * cfg80211_probe_status - notify userspace about probe status
4728 * @dev: the device the probe was sent on
4729 * @addr: the address of the peer
4730 * @cookie: the cookie filled in @probe_client previously
4731 * @acked: indicates whether probe was acked or not
4732 * @gfp: allocation flags
4734 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4735 u64 cookie, bool acked, gfp_t gfp);
4738 * cfg80211_report_obss_beacon - report beacon from other APs
4739 * @wiphy: The wiphy that received the beacon
4741 * @len: length of the frame
4742 * @freq: frequency the frame was received on
4743 * @sig_dbm: signal strength in mBm, or 0 if unknown
4745 * Use this function to report to userspace when a beacon was
4746 * received. It is not useful to call this when there is no
4747 * netdev that is in AP/GO mode.
4749 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4750 const u8 *frame, size_t len,
4751 int freq, int sig_dbm);
4754 * cfg80211_reg_can_beacon - check if beaconing is allowed
4756 * @chandef: the channel definition
4757 * @iftype: interface type
4759 * Return: %true if there is no secondary channel or the secondary channel(s)
4760 * can be used for beaconing (i.e. is not a radar channel etc.)
4762 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4763 struct cfg80211_chan_def *chandef,
4764 enum nl80211_iftype iftype);
4767 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
4768 * @dev: the device which switched channels
4769 * @chandef: the new channel definition
4771 * Caller must acquire wdev_lock, therefore must only be called from sleepable
4774 void cfg80211_ch_switch_notify(struct net_device *dev,
4775 struct cfg80211_chan_def *chandef);
4778 * cfg80211_ch_switch_started_notify - notify channel switch start
4779 * @dev: the device on which the channel switch started
4780 * @chandef: the future channel definition
4781 * @count: the number of TBTTs until the channel switch happens
4783 * Inform the userspace about the channel switch that has just
4784 * started, so that it can take appropriate actions (eg. starting
4785 * channel switch on other vifs), if necessary.
4787 void cfg80211_ch_switch_started_notify(struct net_device *dev,
4788 struct cfg80211_chan_def *chandef,
4792 * ieee80211_operating_class_to_band - convert operating class to band
4794 * @operating_class: the operating class to convert
4795 * @band: band pointer to fill
4797 * Returns %true if the conversion was successful, %false otherwise.
4799 bool ieee80211_operating_class_to_band(u8 operating_class,
4800 enum ieee80211_band *band);
4803 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
4804 * @dev: the device on which the operation is requested
4805 * @peer: the MAC address of the peer device
4806 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
4807 * NL80211_TDLS_TEARDOWN)
4808 * @reason_code: the reason code for teardown request
4809 * @gfp: allocation flags
4811 * This function is used to request userspace to perform TDLS operation that
4812 * requires knowledge of keys, i.e., link setup or teardown when the AP
4813 * connection uses encryption. This is optional mechanism for the driver to use
4814 * if it can automatically determine when a TDLS link could be useful (e.g.,
4815 * based on traffic and signal strength for a peer).
4817 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
4818 enum nl80211_tdls_operation oper,
4819 u16 reason_code, gfp_t gfp);
4822 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
4823 * @rate: given rate_info to calculate bitrate from
4825 * return 0 if MCS index >= 32
4827 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
4830 * cfg80211_unregister_wdev - remove the given wdev
4831 * @wdev: struct wireless_dev to remove
4833 * Call this function only for wdevs that have no netdev assigned,
4834 * e.g. P2P Devices. It removes the device from the list so that
4835 * it can no longer be used. It is necessary to call this function
4836 * even when cfg80211 requests the removal of the interface by
4837 * calling the del_virtual_intf() callback. The function must also
4838 * be called when the driver wishes to unregister the wdev, e.g.
4839 * when the device is unbound from the driver.
4841 * Requires the RTNL to be held.
4843 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
4846 * struct cfg80211_ft_event - FT Information Elements
4848 * @ies_len: length of the FT IE in bytes
4849 * @target_ap: target AP's MAC address
4851 * @ric_ies_len: length of the RIC IE in bytes
4853 struct cfg80211_ft_event_params {
4856 const u8 *target_ap;
4862 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
4863 * @netdev: network device
4864 * @ft_event: IE information
4866 void cfg80211_ft_event(struct net_device *netdev,
4867 struct cfg80211_ft_event_params *ft_event);
4870 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
4871 * @ies: the input IE buffer
4872 * @len: the input length
4873 * @attr: the attribute ID to find
4874 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
4875 * if the function is only called to get the needed buffer size
4876 * @bufsize: size of the output buffer
4878 * The function finds a given P2P attribute in the (vendor) IEs and
4879 * copies its contents to the given buffer.
4881 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
4882 * malformed or the attribute can't be found (respectively), or the
4883 * length of the found attribute (which can be zero).
4885 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
4886 enum ieee80211_p2p_attr_id attr,
4887 u8 *buf, unsigned int bufsize);
4890 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
4891 * @wdev: the wireless device reporting the wakeup
4892 * @wakeup: the wakeup report
4893 * @gfp: allocation flags
4895 * This function reports that the given device woke up. If it
4896 * caused the wakeup, report the reason(s), otherwise you may
4897 * pass %NULL as the @wakeup parameter to advertise that something
4898 * else caused the wakeup.
4900 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
4901 struct cfg80211_wowlan_wakeup *wakeup,
4905 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
4907 * @wdev: the wireless device for which critical protocol is stopped.
4908 * @gfp: allocation flags
4910 * This function can be called by the driver to indicate it has reverted
4911 * operation back to normal. One reason could be that the duration given
4912 * by .crit_proto_start() has expired.
4914 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
4917 * ieee80211_get_num_supported_channels - get number of channels device has
4920 * Return: the number of channels supported by the device.
4922 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
4925 * cfg80211_check_combinations - check interface combinations
4928 * @num_different_channels: the number of different channels we want
4929 * to use for verification
4930 * @radar_detect: a bitmap where each bit corresponds to a channel
4931 * width where radar detection is needed, as in the definition of
4932 * &struct ieee80211_iface_combination.@radar_detect_widths
4933 * @iftype_num: array with the numbers of interfaces of each interface
4934 * type. The index is the interface type as specified in &enum
4937 * This function can be called by the driver to check whether a
4938 * combination of interfaces and their types are allowed according to
4939 * the interface combinations.
4941 int cfg80211_check_combinations(struct wiphy *wiphy,
4942 const int num_different_channels,
4943 const u8 radar_detect,
4944 const int iftype_num[NUM_NL80211_IFTYPES]);
4947 * cfg80211_iter_combinations - iterate over matching combinations
4950 * @num_different_channels: the number of different channels we want
4951 * to use for verification
4952 * @radar_detect: a bitmap where each bit corresponds to a channel
4953 * width where radar detection is needed, as in the definition of
4954 * &struct ieee80211_iface_combination.@radar_detect_widths
4955 * @iftype_num: array with the numbers of interfaces of each interface
4956 * type. The index is the interface type as specified in &enum
4958 * @iter: function to call for each matching combination
4959 * @data: pointer to pass to iter function
4961 * This function can be called by the driver to check what possible
4962 * combinations it fits in at a given moment, e.g. for channel switching
4965 int cfg80211_iter_combinations(struct wiphy *wiphy,
4966 const int num_different_channels,
4967 const u8 radar_detect,
4968 const int iftype_num[NUM_NL80211_IFTYPES],
4969 void (*iter)(const struct ieee80211_iface_combination *c,
4974 * cfg80211_stop_iface - trigger interface disconnection
4977 * @wdev: wireless device
4978 * @gfp: context flags
4980 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
4983 * Note: This doesn't need any locks and is asynchronous.
4985 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
4989 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
4990 * @wiphy: the wiphy to shut down
4992 * This function shuts down all interfaces belonging to this wiphy by
4993 * calling dev_close() (and treating non-netdev interfaces as needed).
4994 * It shouldn't really be used unless there are some fatal device errors
4995 * that really can't be recovered in any other way.
4997 * Callers must hold the RTNL and be able to deal with callbacks into
4998 * the driver while the function is running.
5000 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5003 /* ethtool helper */
5004 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5006 /* Logging, debugging and troubleshooting/diagnostic helpers. */
5008 /* wiphy_printk helpers, similar to dev_printk */
5010 #define wiphy_printk(level, wiphy, format, args...) \
5011 dev_printk(level, &(wiphy)->dev, format, ##args)
5012 #define wiphy_emerg(wiphy, format, args...) \
5013 dev_emerg(&(wiphy)->dev, format, ##args)
5014 #define wiphy_alert(wiphy, format, args...) \
5015 dev_alert(&(wiphy)->dev, format, ##args)
5016 #define wiphy_crit(wiphy, format, args...) \
5017 dev_crit(&(wiphy)->dev, format, ##args)
5018 #define wiphy_err(wiphy, format, args...) \
5019 dev_err(&(wiphy)->dev, format, ##args)
5020 #define wiphy_warn(wiphy, format, args...) \
5021 dev_warn(&(wiphy)->dev, format, ##args)
5022 #define wiphy_notice(wiphy, format, args...) \
5023 dev_notice(&(wiphy)->dev, format, ##args)
5024 #define wiphy_info(wiphy, format, args...) \
5025 dev_info(&(wiphy)->dev, format, ##args)
5027 #define wiphy_debug(wiphy, format, args...) \
5028 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5030 #define wiphy_dbg(wiphy, format, args...) \
5031 dev_dbg(&(wiphy)->dev, format, ##args)
5033 #if defined(VERBOSE_DEBUG)
5034 #define wiphy_vdbg wiphy_dbg
5036 #define wiphy_vdbg(wiphy, format, args...) \
5039 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
5045 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5046 * of using a WARN/WARN_ON to get the message out, including the
5047 * file/line information and a backtrace.
5049 #define wiphy_WARN(wiphy, format, args...) \
5050 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5052 #endif /* __NET_CFG80211_H */