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_TIME: active time (in ms) was filled in
524 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
525 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
526 * @SURVEY_INFO_TIME_RX: receive time was filled in
527 * @SURVEY_INFO_TIME_TX: transmit time was filled in
528 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
530 * Used by the driver to indicate which info in &struct survey_info
531 * it has filled in during the get_survey().
533 enum survey_info_flags {
534 SURVEY_INFO_NOISE_DBM = BIT(0),
535 SURVEY_INFO_IN_USE = BIT(1),
536 SURVEY_INFO_TIME = BIT(2),
537 SURVEY_INFO_TIME_BUSY = BIT(3),
538 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
539 SURVEY_INFO_TIME_RX = BIT(5),
540 SURVEY_INFO_TIME_TX = BIT(6),
541 SURVEY_INFO_TIME_SCAN = BIT(7),
545 * struct survey_info - channel survey response
547 * @channel: the channel this survey record reports, may be %NULL for a single
548 * record to report global statistics
549 * @filled: bitflag of flags from &enum survey_info_flags
550 * @noise: channel noise in dBm. This and all following fields are
552 * @time: amount of time in ms the radio was turn on (on the channel)
553 * @time_busy: amount of time the primary channel was sensed busy
554 * @time_ext_busy: amount of time the extension channel was sensed busy
555 * @time_rx: amount of time the radio spent receiving data
556 * @time_tx: amount of time the radio spent transmitting data
557 * @time_scan: amount of time the radio spent for scanning
559 * Used by dump_survey() to report back per-channel survey information.
561 * This structure can later be expanded with things like
562 * channel duty cycle etc.
565 struct ieee80211_channel *channel;
577 * struct cfg80211_crypto_settings - Crypto settings
578 * @wpa_versions: indicates which, if any, WPA versions are enabled
579 * (from enum nl80211_wpa_versions)
580 * @cipher_group: group key cipher suite (or 0 if unset)
581 * @n_ciphers_pairwise: number of AP supported unicast ciphers
582 * @ciphers_pairwise: unicast key cipher suites
583 * @n_akm_suites: number of AKM suites
584 * @akm_suites: AKM suites
585 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
586 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
587 * required to assume that the port is unauthorized until authorized by
588 * user space. Otherwise, port is marked authorized by default.
589 * @control_port_ethertype: the control port protocol that should be
590 * allowed through even on unauthorized ports
591 * @control_port_no_encrypt: TRUE to prevent encryption of control port
594 struct cfg80211_crypto_settings {
597 int n_ciphers_pairwise;
598 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
600 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
602 __be16 control_port_ethertype;
603 bool control_port_no_encrypt;
607 * struct cfg80211_beacon_data - beacon data
608 * @head: head portion of beacon (before TIM IE)
609 * or %NULL if not changed
610 * @tail: tail portion of beacon (after TIM IE)
611 * or %NULL if not changed
612 * @head_len: length of @head
613 * @tail_len: length of @tail
614 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
615 * @beacon_ies_len: length of beacon_ies in octets
616 * @proberesp_ies: extra information element(s) to add into Probe Response
618 * @proberesp_ies_len: length of proberesp_ies in octets
619 * @assocresp_ies: extra information element(s) to add into (Re)Association
620 * Response frames or %NULL
621 * @assocresp_ies_len: length of assocresp_ies in octets
622 * @probe_resp_len: length of probe response template (@probe_resp)
623 * @probe_resp: probe response template (AP mode only)
625 struct cfg80211_beacon_data {
626 const u8 *head, *tail;
627 const u8 *beacon_ies;
628 const u8 *proberesp_ies;
629 const u8 *assocresp_ies;
630 const u8 *probe_resp;
632 size_t head_len, tail_len;
633 size_t beacon_ies_len;
634 size_t proberesp_ies_len;
635 size_t assocresp_ies_len;
636 size_t probe_resp_len;
644 * struct cfg80211_acl_data - Access control list data
646 * @acl_policy: ACL policy to be applied on the station's
647 * entry specified by mac_addr
648 * @n_acl_entries: Number of MAC address entries passed
649 * @mac_addrs: List of MAC addresses of stations to be used for ACL
651 struct cfg80211_acl_data {
652 enum nl80211_acl_policy acl_policy;
656 struct mac_address mac_addrs[];
660 * struct cfg80211_ap_settings - AP configuration
662 * Used to configure an AP interface.
664 * @chandef: defines the channel to use
665 * @beacon: beacon data
666 * @beacon_interval: beacon interval
667 * @dtim_period: DTIM period
668 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
670 * @ssid_len: length of @ssid
671 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
672 * @crypto: crypto settings
673 * @privacy: the BSS uses privacy
674 * @auth_type: Authentication type (algorithm)
675 * @smps_mode: SMPS mode
676 * @inactivity_timeout: time in seconds to determine station's inactivity.
677 * @p2p_ctwindow: P2P CT Window
678 * @p2p_opp_ps: P2P opportunistic PS
679 * @acl: ACL configuration used by the drivers which has support for
680 * MAC address based access control
682 struct cfg80211_ap_settings {
683 struct cfg80211_chan_def chandef;
685 struct cfg80211_beacon_data beacon;
687 int beacon_interval, dtim_period;
690 enum nl80211_hidden_ssid hidden_ssid;
691 struct cfg80211_crypto_settings crypto;
693 enum nl80211_auth_type auth_type;
694 enum nl80211_smps_mode smps_mode;
695 int inactivity_timeout;
698 const struct cfg80211_acl_data *acl;
702 * struct cfg80211_csa_settings - channel switch settings
704 * Used for channel switch
706 * @chandef: defines the channel to use after the switch
707 * @beacon_csa: beacon data while performing the switch
708 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
709 * @counter_offsets_presp: offsets of the counters within the probe response
710 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
711 * @n_counter_offsets_presp: number of csa counters in the probe response
712 * @beacon_after: beacon data to be used on the new channel
713 * @radar_required: whether radar detection is required on the new channel
714 * @block_tx: whether transmissions should be blocked while changing
715 * @count: number of beacons until switch
717 struct cfg80211_csa_settings {
718 struct cfg80211_chan_def chandef;
719 struct cfg80211_beacon_data beacon_csa;
720 const u16 *counter_offsets_beacon;
721 const u16 *counter_offsets_presp;
722 unsigned int n_counter_offsets_beacon;
723 unsigned int n_counter_offsets_presp;
724 struct cfg80211_beacon_data beacon_after;
731 * enum station_parameters_apply_mask - station parameter values to apply
732 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
733 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
734 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
736 * Not all station parameters have in-band "no change" signalling,
737 * for those that don't these flags will are used.
739 enum station_parameters_apply_mask {
740 STATION_PARAM_APPLY_UAPSD = BIT(0),
741 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
742 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
746 * struct station_parameters - station parameters
748 * Used to change and create a new station.
750 * @vlan: vlan interface station should belong to
751 * @supported_rates: supported rates in IEEE 802.11 format
752 * (or NULL for no change)
753 * @supported_rates_len: number of supported rates
754 * @sta_flags_mask: station flags that changed
755 * (bitmask of BIT(NL80211_STA_FLAG_...))
756 * @sta_flags_set: station flags values
757 * (bitmask of BIT(NL80211_STA_FLAG_...))
758 * @listen_interval: listen interval or -1 for no change
759 * @aid: AID or zero for no change
760 * @plink_action: plink action to take
761 * @plink_state: set the peer link state for a station
762 * @ht_capa: HT capabilities of station
763 * @vht_capa: VHT capabilities of station
764 * @uapsd_queues: bitmap of queues configured for uapsd. same format
765 * as the AC bitmap in the QoS info field
766 * @max_sp: max Service Period. same format as the MAX_SP in the
767 * QoS info field (but already shifted down)
768 * @sta_modify_mask: bitmap indicating which parameters changed
769 * (for those that don't have a natural "no change" value),
770 * see &enum station_parameters_apply_mask
771 * @local_pm: local link-specific mesh power save mode (no change when set
773 * @capability: station capability
774 * @ext_capab: extended capabilities of the station
775 * @ext_capab_len: number of extended capabilities
776 * @supported_channels: supported channels in IEEE 802.11 format
777 * @supported_channels_len: number of supported channels
778 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
779 * @supported_oper_classes_len: number of supported operating classes
780 * @opmode_notif: operating mode field from Operating Mode Notification
781 * @opmode_notif_used: information if operating mode field is used
783 struct station_parameters {
784 const u8 *supported_rates;
785 struct net_device *vlan;
786 u32 sta_flags_mask, sta_flags_set;
790 u8 supported_rates_len;
793 const struct ieee80211_ht_cap *ht_capa;
794 const struct ieee80211_vht_cap *vht_capa;
797 enum nl80211_mesh_power_mode local_pm;
801 const u8 *supported_channels;
802 u8 supported_channels_len;
803 const u8 *supported_oper_classes;
804 u8 supported_oper_classes_len;
806 bool opmode_notif_used;
810 * struct station_del_parameters - station deletion parameters
812 * Used to delete a station entry (or all stations).
814 * @mac: MAC address of the station to remove or NULL to remove all stations
815 * @subtype: Management frame subtype to use for indicating removal
816 * (10 = Disassociation, 12 = Deauthentication)
817 * @reason_code: Reason code for the Disassociation/Deauthentication frame
819 struct station_del_parameters {
826 * enum cfg80211_station_type - the type of station being modified
827 * @CFG80211_STA_AP_CLIENT: client of an AP interface
828 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
829 * the AP MLME in the device
830 * @CFG80211_STA_AP_STA: AP station on managed interface
831 * @CFG80211_STA_IBSS: IBSS station
832 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
833 * while TDLS setup is in progress, it moves out of this state when
834 * being marked authorized; use this only if TDLS with external setup is
836 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
837 * entry that is operating, has been marked authorized by userspace)
838 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
839 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
841 enum cfg80211_station_type {
842 CFG80211_STA_AP_CLIENT,
843 CFG80211_STA_AP_MLME_CLIENT,
846 CFG80211_STA_TDLS_PEER_SETUP,
847 CFG80211_STA_TDLS_PEER_ACTIVE,
848 CFG80211_STA_MESH_PEER_KERNEL,
849 CFG80211_STA_MESH_PEER_USER,
853 * cfg80211_check_station_change - validate parameter changes
854 * @wiphy: the wiphy this operates on
855 * @params: the new parameters for a station
856 * @statype: the type of station being modified
858 * Utility function for the @change_station driver method. Call this function
859 * with the appropriate station type looking up the station (and checking that
860 * it exists). It will verify whether the station change is acceptable, and if
861 * not will return an error code. Note that it may modify the parameters for
862 * backward compatibility reasons, so don't use them before calling this.
864 int cfg80211_check_station_change(struct wiphy *wiphy,
865 struct station_parameters *params,
866 enum cfg80211_station_type statype);
869 * enum station_info_rate_flags - bitrate info flags
871 * Used by the driver to indicate the specific rate transmission
872 * type for 802.11n transmissions.
874 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
875 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
876 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
877 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
878 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
879 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
880 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
881 * @RATE_INFO_FLAGS_60G: 60GHz MCS
883 enum rate_info_flags {
884 RATE_INFO_FLAGS_MCS = BIT(0),
885 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
886 RATE_INFO_FLAGS_40_MHZ_WIDTH = BIT(2),
887 RATE_INFO_FLAGS_80_MHZ_WIDTH = BIT(3),
888 RATE_INFO_FLAGS_80P80_MHZ_WIDTH = BIT(4),
889 RATE_INFO_FLAGS_160_MHZ_WIDTH = BIT(5),
890 RATE_INFO_FLAGS_SHORT_GI = BIT(6),
891 RATE_INFO_FLAGS_60G = BIT(7),
895 * struct rate_info - bitrate information
897 * Information about a receiving or transmitting bitrate
899 * @flags: bitflag of flags from &enum rate_info_flags
900 * @mcs: mcs index if struct describes a 802.11n bitrate
901 * @legacy: bitrate in 100kbit/s for 802.11abg
902 * @nss: number of streams (VHT only)
912 * enum station_info_rate_flags - bitrate info flags
914 * Used by the driver to indicate the specific rate transmission
915 * type for 802.11n transmissions.
917 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
918 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
919 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
921 enum bss_param_flags {
922 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
923 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
924 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
928 * struct sta_bss_parameters - BSS parameters for the attached station
930 * Information about the currently associated BSS
932 * @flags: bitflag of flags from &enum bss_param_flags
933 * @dtim_period: DTIM period for the BSS
934 * @beacon_interval: beacon interval
936 struct sta_bss_parameters {
942 #define IEEE80211_MAX_CHAINS 4
945 * struct station_info - station information
947 * Station information filled by driver for get_station() and dump_station.
949 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
950 * indicate the relevant values in this struct for them
951 * @connected_time: time(in secs) since a station is last connected
952 * @inactive_time: time since last station activity (tx/rx) in milliseconds
953 * @rx_bytes: bytes received from this station
954 * @tx_bytes: bytes transmitted to this station
955 * @llid: mesh local link id
956 * @plid: mesh peer link id
957 * @plink_state: mesh peer link state
958 * @signal: The signal strength, type depends on the wiphy's signal_type.
959 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
960 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
961 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
962 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
963 * @chain_signal: per-chain signal strength of last received packet in dBm
964 * @chain_signal_avg: per-chain signal strength average in dBm
965 * @txrate: current unicast bitrate from this station
966 * @rxrate: current unicast bitrate to this station
967 * @rx_packets: packets received from this station
968 * @tx_packets: packets transmitted to this station
969 * @tx_retries: cumulative retry counts
970 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
971 * @rx_dropped_misc: Dropped for un-specified reason.
972 * @bss_param: current BSS parameters
973 * @generation: generation number for nl80211 dumps.
974 * This number should increase every time the list of stations
975 * changes, i.e. when a station is added or removed, so that
976 * userspace can tell whether it got a consistent snapshot.
977 * @assoc_req_ies: IEs from (Re)Association Request.
978 * This is used only when in AP mode with drivers that do not use
979 * user space MLME/SME implementation. The information is provided for
980 * the cfg80211_new_sta() calls to notify user space of the IEs.
981 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
982 * @sta_flags: station flags mask & values
983 * @beacon_loss_count: Number of times beacon loss event has triggered.
984 * @t_offset: Time offset of the station relative to this host.
985 * @local_pm: local mesh STA power save mode
986 * @peer_pm: peer mesh STA power save mode
987 * @nonpeer_pm: non-peer mesh STA power save mode
988 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
989 * towards this station.
990 * @rx_beacon: number of beacons received from this peer
991 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
994 struct station_info {
1007 s8 chain_signal[IEEE80211_MAX_CHAINS];
1008 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1010 struct rate_info txrate;
1011 struct rate_info rxrate;
1016 u32 rx_dropped_misc;
1017 struct sta_bss_parameters bss_param;
1018 struct nl80211_sta_flag_update sta_flags;
1022 const u8 *assoc_req_ies;
1023 size_t assoc_req_ies_len;
1025 u32 beacon_loss_count;
1027 enum nl80211_mesh_power_mode local_pm;
1028 enum nl80211_mesh_power_mode peer_pm;
1029 enum nl80211_mesh_power_mode nonpeer_pm;
1031 u32 expected_throughput;
1034 u8 rx_beacon_signal_avg;
1038 * cfg80211_get_station - retrieve information about a given station
1039 * @dev: the device where the station is supposed to be connected to
1040 * @mac_addr: the mac address of the station of interest
1041 * @sinfo: pointer to the structure to fill with the information
1043 * Returns 0 on success and sinfo is filled with the available information
1044 * otherwise returns a negative error code and the content of sinfo has to be
1045 * considered undefined.
1047 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1048 struct station_info *sinfo);
1051 * enum monitor_flags - monitor flags
1053 * Monitor interface configuration flags. Note that these must be the bits
1054 * according to the nl80211 flags.
1056 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1057 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1058 * @MONITOR_FLAG_CONTROL: pass control frames
1059 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1060 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1061 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1063 enum monitor_flags {
1064 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1065 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1066 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1067 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1068 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1069 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1073 * enum mpath_info_flags - mesh path information flags
1075 * Used by the driver to indicate which info in &struct mpath_info it has filled
1076 * in during get_station() or dump_station().
1078 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1079 * @MPATH_INFO_SN: @sn filled
1080 * @MPATH_INFO_METRIC: @metric filled
1081 * @MPATH_INFO_EXPTIME: @exptime filled
1082 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1083 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1084 * @MPATH_INFO_FLAGS: @flags filled
1086 enum mpath_info_flags {
1087 MPATH_INFO_FRAME_QLEN = BIT(0),
1088 MPATH_INFO_SN = BIT(1),
1089 MPATH_INFO_METRIC = BIT(2),
1090 MPATH_INFO_EXPTIME = BIT(3),
1091 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1092 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1093 MPATH_INFO_FLAGS = BIT(6),
1097 * struct mpath_info - mesh path information
1099 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1101 * @filled: bitfield of flags from &enum mpath_info_flags
1102 * @frame_qlen: number of queued frames for this destination
1103 * @sn: target sequence number
1104 * @metric: metric (cost) of this mesh path
1105 * @exptime: expiration time for the mesh path from now, in msecs
1106 * @flags: mesh path flags
1107 * @discovery_timeout: total mesh path discovery timeout, in msecs
1108 * @discovery_retries: mesh path discovery retries
1109 * @generation: generation number for nl80211 dumps.
1110 * This number should increase every time the list of mesh paths
1111 * changes, i.e. when a station is added or removed, so that
1112 * userspace can tell whether it got a consistent snapshot.
1120 u32 discovery_timeout;
1121 u8 discovery_retries;
1128 * struct bss_parameters - BSS parameters
1130 * Used to change BSS parameters (mainly for AP mode).
1132 * @use_cts_prot: Whether to use CTS protection
1133 * (0 = no, 1 = yes, -1 = do not change)
1134 * @use_short_preamble: Whether the use of short preambles is allowed
1135 * (0 = no, 1 = yes, -1 = do not change)
1136 * @use_short_slot_time: Whether the use of short slot time is allowed
1137 * (0 = no, 1 = yes, -1 = do not change)
1138 * @basic_rates: basic rates in IEEE 802.11 format
1139 * (or NULL for no change)
1140 * @basic_rates_len: number of basic rates
1141 * @ap_isolate: do not forward packets between connected stations
1142 * @ht_opmode: HT Operation mode
1143 * (u16 = opmode, -1 = do not change)
1144 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1145 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1147 struct bss_parameters {
1149 int use_short_preamble;
1150 int use_short_slot_time;
1151 const u8 *basic_rates;
1155 s8 p2p_ctwindow, p2p_opp_ps;
1159 * struct mesh_config - 802.11s mesh configuration
1161 * These parameters can be changed while the mesh is active.
1163 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1164 * by the Mesh Peering Open message
1165 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1166 * used by the Mesh Peering Open message
1167 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1168 * the mesh peering management to close a mesh peering
1169 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1171 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1172 * be sent to establish a new peer link instance in a mesh
1173 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1174 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1176 * @auto_open_plinks: whether we should automatically open peer links when we
1177 * detect compatible mesh peers
1178 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1179 * synchronize to for 11s default synchronization method
1180 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1181 * that an originator mesh STA can send to a particular path target
1182 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1183 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1184 * a path discovery in milliseconds
1185 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1186 * receiving a PREQ shall consider the forwarding information from the
1187 * root to be valid. (TU = time unit)
1188 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1189 * which a mesh STA can send only one action frame containing a PREQ
1191 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1192 * which a mesh STA can send only one Action frame containing a PERR
1194 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1195 * it takes for an HWMP information element to propagate across the mesh
1196 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1197 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1198 * announcements are transmitted
1199 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1200 * station has access to a broader network beyond the MBSS. (This is
1201 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1202 * only means that the station will announce others it's a mesh gate, but
1203 * not necessarily using the gate announcement protocol. Still keeping the
1204 * same nomenclature to be in sync with the spec)
1205 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1206 * entity (default is TRUE - forwarding entity)
1207 * @rssi_threshold: the threshold for average signal strength of candidate
1208 * station to establish a peer link
1209 * @ht_opmode: mesh HT protection mode
1211 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1212 * receiving a proactive PREQ shall consider the forwarding information to
1213 * the root mesh STA to be valid.
1215 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1216 * PREQs are transmitted.
1217 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1218 * during which a mesh STA can send only one Action frame containing
1219 * a PREQ element for root path confirmation.
1220 * @power_mode: The default mesh power save mode which will be the initial
1221 * setting for new peer links.
1222 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1223 * after transmitting its beacon.
1224 * @plink_timeout: If no tx activity is seen from a STA we've established
1225 * peering with for longer than this time (in seconds), then remove it
1226 * from the STA's list of peers. Default is 30 minutes.
1228 struct mesh_config {
1229 u16 dot11MeshRetryTimeout;
1230 u16 dot11MeshConfirmTimeout;
1231 u16 dot11MeshHoldingTimeout;
1232 u16 dot11MeshMaxPeerLinks;
1233 u8 dot11MeshMaxRetries;
1236 bool auto_open_plinks;
1237 u32 dot11MeshNbrOffsetMaxNeighbor;
1238 u8 dot11MeshHWMPmaxPREQretries;
1239 u32 path_refresh_time;
1240 u16 min_discovery_timeout;
1241 u32 dot11MeshHWMPactivePathTimeout;
1242 u16 dot11MeshHWMPpreqMinInterval;
1243 u16 dot11MeshHWMPperrMinInterval;
1244 u16 dot11MeshHWMPnetDiameterTraversalTime;
1245 u8 dot11MeshHWMPRootMode;
1246 u16 dot11MeshHWMPRannInterval;
1247 bool dot11MeshGateAnnouncementProtocol;
1248 bool dot11MeshForwarding;
1251 u32 dot11MeshHWMPactivePathToRootTimeout;
1252 u16 dot11MeshHWMProotInterval;
1253 u16 dot11MeshHWMPconfirmationInterval;
1254 enum nl80211_mesh_power_mode power_mode;
1255 u16 dot11MeshAwakeWindowDuration;
1260 * struct mesh_setup - 802.11s mesh setup configuration
1261 * @chandef: defines the channel to use
1262 * @mesh_id: the mesh ID
1263 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1264 * @sync_method: which synchronization method to use
1265 * @path_sel_proto: which path selection protocol to use
1266 * @path_metric: which metric to use
1267 * @auth_id: which authentication method this mesh is using
1268 * @ie: vendor information elements (optional)
1269 * @ie_len: length of vendor information elements
1270 * @is_authenticated: this mesh requires authentication
1271 * @is_secure: this mesh uses security
1272 * @user_mpm: userspace handles all MPM functions
1273 * @dtim_period: DTIM period to use
1274 * @beacon_interval: beacon interval to use
1275 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1276 * @basic_rates: basic rates to use when creating the mesh
1278 * These parameters are fixed when the mesh is created.
1281 struct cfg80211_chan_def chandef;
1290 bool is_authenticated;
1294 u16 beacon_interval;
1295 int mcast_rate[IEEE80211_NUM_BANDS];
1300 * struct ocb_setup - 802.11p OCB mode setup configuration
1301 * @chandef: defines the channel to use
1303 * These parameters are fixed when connecting to the network
1306 struct cfg80211_chan_def chandef;
1310 * struct ieee80211_txq_params - TX queue parameters
1311 * @ac: AC identifier
1312 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1313 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1315 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1317 * @aifs: Arbitration interframe space [0..255]
1319 struct ieee80211_txq_params {
1328 * DOC: Scanning and BSS list handling
1330 * The scanning process itself is fairly simple, but cfg80211 offers quite
1331 * a bit of helper functionality. To start a scan, the scan operation will
1332 * be invoked with a scan definition. This scan definition contains the
1333 * channels to scan, and the SSIDs to send probe requests for (including the
1334 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1335 * probe. Additionally, a scan request may contain extra information elements
1336 * that should be added to the probe request. The IEs are guaranteed to be
1337 * well-formed, and will not exceed the maximum length the driver advertised
1338 * in the wiphy structure.
1340 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1341 * it is responsible for maintaining the BSS list; the driver should not
1342 * maintain a list itself. For this notification, various functions exist.
1344 * Since drivers do not maintain a BSS list, there are also a number of
1345 * functions to search for a BSS and obtain information about it from the
1346 * BSS structure cfg80211 maintains. The BSS list is also made available
1351 * struct cfg80211_ssid - SSID description
1353 * @ssid_len: length of the ssid
1355 struct cfg80211_ssid {
1356 u8 ssid[IEEE80211_MAX_SSID_LEN];
1361 * struct cfg80211_scan_request - scan request description
1363 * @ssids: SSIDs to scan for (active scan only)
1364 * @n_ssids: number of SSIDs
1365 * @channels: channels to scan on.
1366 * @n_channels: total number of channels to scan
1367 * @scan_width: channel width for scanning
1368 * @ie: optional information element(s) to add into Probe Request or %NULL
1369 * @ie_len: length of ie in octets
1370 * @flags: bit field of flags controlling operation
1371 * @rates: bitmap of rates to advertise for each band
1372 * @wiphy: the wiphy this was for
1373 * @scan_start: time (in jiffies) when the scan started
1374 * @wdev: the wireless device to scan for
1375 * @aborted: (internal) scan request was notified as aborted
1376 * @notified: (internal) scan request was notified as done or aborted
1377 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1378 * @mac_addr: MAC address used with randomisation
1379 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1380 * are 0 in the mask should be randomised, bits that are 1 should
1381 * be taken from the @mac_addr
1383 struct cfg80211_scan_request {
1384 struct cfg80211_ssid *ssids;
1387 enum nl80211_bss_scan_width scan_width;
1392 u32 rates[IEEE80211_NUM_BANDS];
1394 struct wireless_dev *wdev;
1396 u8 mac_addr[ETH_ALEN] __aligned(2);
1397 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1400 struct wiphy *wiphy;
1401 unsigned long scan_start;
1402 bool aborted, notified;
1406 struct ieee80211_channel *channels[0];
1409 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1413 get_random_bytes(buf, ETH_ALEN);
1414 for (i = 0; i < ETH_ALEN; i++) {
1416 buf[i] |= addr[i] & mask[i];
1421 * struct cfg80211_match_set - sets of attributes to match
1423 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1424 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1426 struct cfg80211_match_set {
1427 struct cfg80211_ssid ssid;
1432 * struct cfg80211_sched_scan_request - scheduled scan request description
1434 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1435 * @n_ssids: number of SSIDs
1436 * @n_channels: total number of channels to scan
1437 * @scan_width: channel width for scanning
1438 * @interval: interval between each scheduled scan cycle
1439 * @ie: optional information element(s) to add into Probe Request or %NULL
1440 * @ie_len: length of ie in octets
1441 * @flags: bit field of flags controlling operation
1442 * @match_sets: sets of parameters to be matched for a scan result
1443 * entry to be considered valid and to be passed to the host
1444 * (others are filtered out).
1445 * If ommited, all results are passed.
1446 * @n_match_sets: number of match sets
1447 * @wiphy: the wiphy this was for
1448 * @dev: the interface
1449 * @scan_start: start time of the scheduled scan
1450 * @channels: channels to scan
1451 * @min_rssi_thold: for drivers only supporting a single threshold, this
1452 * contains the minimum over all matchsets
1453 * @mac_addr: MAC address used with randomisation
1454 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1455 * are 0 in the mask should be randomised, bits that are 1 should
1456 * be taken from the @mac_addr
1457 * @rcu_head: RCU callback used to free the struct
1458 * @owner_nlportid: netlink portid of owner (if this should is a request
1459 * owned by a particular socket)
1461 struct cfg80211_sched_scan_request {
1462 struct cfg80211_ssid *ssids;
1465 enum nl80211_bss_scan_width scan_width;
1470 struct cfg80211_match_set *match_sets;
1474 u8 mac_addr[ETH_ALEN] __aligned(2);
1475 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1478 struct wiphy *wiphy;
1479 struct net_device *dev;
1480 unsigned long scan_start;
1481 struct rcu_head rcu_head;
1485 struct ieee80211_channel *channels[0];
1489 * enum cfg80211_signal_type - signal type
1491 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1492 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1493 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1495 enum cfg80211_signal_type {
1496 CFG80211_SIGNAL_TYPE_NONE,
1497 CFG80211_SIGNAL_TYPE_MBM,
1498 CFG80211_SIGNAL_TYPE_UNSPEC,
1502 * struct cfg80211_bss_ie_data - BSS entry IE data
1503 * @tsf: TSF contained in the frame that carried these IEs
1504 * @rcu_head: internal use, for freeing
1505 * @len: length of the IEs
1506 * @from_beacon: these IEs are known to come from a beacon
1509 struct cfg80211_bss_ies {
1511 struct rcu_head rcu_head;
1518 * struct cfg80211_bss - BSS description
1520 * This structure describes a BSS (which may also be a mesh network)
1521 * for use in scan results and similar.
1523 * @channel: channel this BSS is on
1524 * @scan_width: width of the control channel
1525 * @bssid: BSSID of the BSS
1526 * @beacon_interval: the beacon interval as from the frame
1527 * @capability: the capability field in host byte order
1528 * @ies: the information elements (Note that there is no guarantee that these
1529 * are well-formed!); this is a pointer to either the beacon_ies or
1530 * proberesp_ies depending on whether Probe Response frame has been
1531 * received. It is always non-%NULL.
1532 * @beacon_ies: the information elements from the last Beacon frame
1533 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1534 * own the beacon_ies, but they're just pointers to the ones from the
1535 * @hidden_beacon_bss struct)
1536 * @proberesp_ies: the information elements from the last Probe Response frame
1537 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1538 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1539 * that holds the beacon data. @beacon_ies is still valid, of course, and
1540 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1541 * @signal: signal strength value (type depends on the wiphy's signal_type)
1542 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1544 struct cfg80211_bss {
1545 struct ieee80211_channel *channel;
1546 enum nl80211_bss_scan_width scan_width;
1548 const struct cfg80211_bss_ies __rcu *ies;
1549 const struct cfg80211_bss_ies __rcu *beacon_ies;
1550 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1552 struct cfg80211_bss *hidden_beacon_bss;
1556 u16 beacon_interval;
1561 u8 priv[0] __aligned(sizeof(void *));
1565 * ieee80211_bss_get_ie - find IE with given ID
1566 * @bss: the bss to search
1569 * Note that the return value is an RCU-protected pointer, so
1570 * rcu_read_lock() must be held when calling this function.
1571 * Return: %NULL if not found.
1573 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1577 * struct cfg80211_auth_request - Authentication request data
1579 * This structure provides information needed to complete IEEE 802.11
1582 * @bss: The BSS to authenticate with, the callee must obtain a reference
1583 * to it if it needs to keep it.
1584 * @auth_type: Authentication type (algorithm)
1585 * @ie: Extra IEs to add to Authentication frame or %NULL
1586 * @ie_len: Length of ie buffer in octets
1587 * @key_len: length of WEP key for shared key authentication
1588 * @key_idx: index of WEP key for shared key authentication
1589 * @key: WEP key for shared key authentication
1590 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1591 * Authentication transaction sequence number field.
1592 * @sae_data_len: Length of sae_data buffer in octets
1594 struct cfg80211_auth_request {
1595 struct cfg80211_bss *bss;
1598 enum nl80211_auth_type auth_type;
1600 u8 key_len, key_idx;
1602 size_t sae_data_len;
1606 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1608 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1609 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1610 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1612 enum cfg80211_assoc_req_flags {
1613 ASSOC_REQ_DISABLE_HT = BIT(0),
1614 ASSOC_REQ_DISABLE_VHT = BIT(1),
1615 ASSOC_REQ_USE_RRM = BIT(2),
1619 * struct cfg80211_assoc_request - (Re)Association request data
1621 * This structure provides information needed to complete IEEE 802.11
1623 * @bss: The BSS to associate with. If the call is successful the driver is
1624 * given a reference that it must give back to cfg80211_send_rx_assoc()
1625 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1626 * association requests while already associating must be rejected.
1627 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1628 * @ie_len: Length of ie buffer in octets
1629 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1630 * @crypto: crypto settings
1631 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1632 * @flags: See &enum cfg80211_assoc_req_flags
1633 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1634 * will be used in ht_capa. Un-supported values will be ignored.
1635 * @ht_capa_mask: The bits of ht_capa which are to be used.
1636 * @vht_capa: VHT capability override
1637 * @vht_capa_mask: VHT capability mask indicating which fields to use
1639 struct cfg80211_assoc_request {
1640 struct cfg80211_bss *bss;
1641 const u8 *ie, *prev_bssid;
1643 struct cfg80211_crypto_settings crypto;
1646 struct ieee80211_ht_cap ht_capa;
1647 struct ieee80211_ht_cap ht_capa_mask;
1648 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1652 * struct cfg80211_deauth_request - Deauthentication request data
1654 * This structure provides information needed to complete IEEE 802.11
1657 * @bssid: the BSSID of the BSS to deauthenticate from
1658 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1659 * @ie_len: Length of ie buffer in octets
1660 * @reason_code: The reason code for the deauthentication
1661 * @local_state_change: if set, change local state only and
1662 * do not set a deauth frame
1664 struct cfg80211_deauth_request {
1669 bool local_state_change;
1673 * struct cfg80211_disassoc_request - Disassociation request data
1675 * This structure provides information needed to complete IEEE 802.11
1678 * @bss: the BSS to disassociate from
1679 * @ie: Extra IEs to add to Disassociation frame or %NULL
1680 * @ie_len: Length of ie buffer in octets
1681 * @reason_code: The reason code for the disassociation
1682 * @local_state_change: This is a request for a local state only, i.e., no
1683 * Disassociation frame is to be transmitted.
1685 struct cfg80211_disassoc_request {
1686 struct cfg80211_bss *bss;
1690 bool local_state_change;
1694 * struct cfg80211_ibss_params - IBSS parameters
1696 * This structure defines the IBSS parameters for the join_ibss()
1699 * @ssid: The SSID, will always be non-null.
1700 * @ssid_len: The length of the SSID, will always be non-zero.
1701 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1702 * search for IBSSs with a different BSSID.
1703 * @chandef: defines the channel to use if no other IBSS to join can be found
1704 * @channel_fixed: The channel should be fixed -- do not search for
1705 * IBSSs to join on other channels.
1706 * @ie: information element(s) to include in the beacon
1707 * @ie_len: length of that
1708 * @beacon_interval: beacon interval to use
1709 * @privacy: this is a protected network, keys will be configured
1711 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1712 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1713 * required to assume that the port is unauthorized until authorized by
1714 * user space. Otherwise, port is marked authorized by default.
1715 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1716 * changes the channel when a radar is detected. This is required
1717 * to operate on DFS channels.
1718 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1719 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1720 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1721 * will be used in ht_capa. Un-supported values will be ignored.
1722 * @ht_capa_mask: The bits of ht_capa which are to be used.
1724 struct cfg80211_ibss_params {
1727 struct cfg80211_chan_def chandef;
1729 u8 ssid_len, ie_len;
1730 u16 beacon_interval;
1735 bool userspace_handles_dfs;
1736 int mcast_rate[IEEE80211_NUM_BANDS];
1737 struct ieee80211_ht_cap ht_capa;
1738 struct ieee80211_ht_cap ht_capa_mask;
1742 * struct cfg80211_connect_params - Connection parameters
1744 * This structure provides information needed to complete IEEE 802.11
1745 * authentication and association.
1747 * @channel: The channel to use or %NULL if not specified (auto-select based
1749 * @channel_hint: The channel of the recommended BSS for initial connection or
1750 * %NULL if not specified
1751 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1753 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1754 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1755 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1758 * @ssid_len: Length of ssid in octets
1759 * @auth_type: Authentication type (algorithm)
1760 * @ie: IEs for association request
1761 * @ie_len: Length of assoc_ie in octets
1762 * @privacy: indicates whether privacy-enabled APs should be used
1763 * @mfp: indicate whether management frame protection is used
1764 * @crypto: crypto settings
1765 * @key_len: length of WEP key for shared key authentication
1766 * @key_idx: index of WEP key for shared key authentication
1767 * @key: WEP key for shared key authentication
1768 * @flags: See &enum cfg80211_assoc_req_flags
1769 * @bg_scan_period: Background scan period in seconds
1770 * or -1 to indicate that default value is to be used.
1771 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1772 * will be used in ht_capa. Un-supported values will be ignored.
1773 * @ht_capa_mask: The bits of ht_capa which are to be used.
1774 * @vht_capa: VHT Capability overrides
1775 * @vht_capa_mask: The bits of vht_capa which are to be used.
1777 struct cfg80211_connect_params {
1778 struct ieee80211_channel *channel;
1779 struct ieee80211_channel *channel_hint;
1781 const u8 *bssid_hint;
1784 enum nl80211_auth_type auth_type;
1788 enum nl80211_mfp mfp;
1789 struct cfg80211_crypto_settings crypto;
1791 u8 key_len, key_idx;
1794 struct ieee80211_ht_cap ht_capa;
1795 struct ieee80211_ht_cap ht_capa_mask;
1796 struct ieee80211_vht_cap vht_capa;
1797 struct ieee80211_vht_cap vht_capa_mask;
1801 * enum wiphy_params_flags - set_wiphy_params bitfield values
1802 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1803 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1804 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1805 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1806 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1807 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
1809 enum wiphy_params_flags {
1810 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1811 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1812 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1813 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1814 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1815 WIPHY_PARAM_DYN_ACK = 1 << 5,
1819 * cfg80211_bitrate_mask - masks for bitrate control
1821 struct cfg80211_bitrate_mask {
1824 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
1825 u16 vht_mcs[NL80211_VHT_NSS_MAX];
1826 enum nl80211_txrate_gi gi;
1827 } control[IEEE80211_NUM_BANDS];
1830 * struct cfg80211_pmksa - PMK Security Association
1832 * This structure is passed to the set/del_pmksa() method for PMKSA
1835 * @bssid: The AP's BSSID.
1836 * @pmkid: The PMK material itself.
1838 struct cfg80211_pmksa {
1844 * struct cfg80211_pkt_pattern - packet pattern
1845 * @mask: bitmask where to match pattern and where to ignore bytes,
1846 * one bit per byte, in same format as nl80211
1847 * @pattern: bytes to match where bitmask is 1
1848 * @pattern_len: length of pattern (in bytes)
1849 * @pkt_offset: packet offset (in bytes)
1851 * Internal note: @mask and @pattern are allocated in one chunk of
1852 * memory, free @mask only!
1854 struct cfg80211_pkt_pattern {
1855 const u8 *mask, *pattern;
1861 * struct cfg80211_wowlan_tcp - TCP connection parameters
1863 * @sock: (internal) socket for source port allocation
1864 * @src: source IP address
1865 * @dst: destination IP address
1866 * @dst_mac: destination MAC address
1867 * @src_port: source port
1868 * @dst_port: destination port
1869 * @payload_len: data payload length
1870 * @payload: data payload buffer
1871 * @payload_seq: payload sequence stamping configuration
1872 * @data_interval: interval at which to send data packets
1873 * @wake_len: wakeup payload match length
1874 * @wake_data: wakeup payload match data
1875 * @wake_mask: wakeup payload match mask
1876 * @tokens_size: length of the tokens buffer
1877 * @payload_tok: payload token usage configuration
1879 struct cfg80211_wowlan_tcp {
1880 struct socket *sock;
1882 u16 src_port, dst_port;
1883 u8 dst_mac[ETH_ALEN];
1886 struct nl80211_wowlan_tcp_data_seq payload_seq;
1889 const u8 *wake_data, *wake_mask;
1891 /* must be last, variable member */
1892 struct nl80211_wowlan_tcp_data_token payload_tok;
1896 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1898 * This structure defines the enabled WoWLAN triggers for the device.
1899 * @any: wake up on any activity -- special trigger if device continues
1900 * operating as normal during suspend
1901 * @disconnect: wake up if getting disconnected
1902 * @magic_pkt: wake up on receiving magic packet
1903 * @patterns: wake up on receiving packet matching a pattern
1904 * @n_patterns: number of patterns
1905 * @gtk_rekey_failure: wake up on GTK rekey failure
1906 * @eap_identity_req: wake up on EAP identity request packet
1907 * @four_way_handshake: wake up on 4-way handshake
1908 * @rfkill_release: wake up when rfkill is released
1909 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
1910 * NULL if not configured.
1911 * @nd_config: configuration for the scan to be used for net detect wake.
1913 struct cfg80211_wowlan {
1914 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1915 eap_identity_req, four_way_handshake,
1917 struct cfg80211_pkt_pattern *patterns;
1918 struct cfg80211_wowlan_tcp *tcp;
1920 struct cfg80211_sched_scan_request *nd_config;
1924 * struct cfg80211_coalesce_rules - Coalesce rule parameters
1926 * This structure defines coalesce rule for the device.
1927 * @delay: maximum coalescing delay in msecs.
1928 * @condition: condition for packet coalescence.
1929 * see &enum nl80211_coalesce_condition.
1930 * @patterns: array of packet patterns
1931 * @n_patterns: number of patterns
1933 struct cfg80211_coalesce_rules {
1935 enum nl80211_coalesce_condition condition;
1936 struct cfg80211_pkt_pattern *patterns;
1941 * struct cfg80211_coalesce - Packet coalescing settings
1943 * This structure defines coalescing settings.
1944 * @rules: array of coalesce rules
1945 * @n_rules: number of rules
1947 struct cfg80211_coalesce {
1948 struct cfg80211_coalesce_rules *rules;
1953 * struct cfg80211_wowlan_nd_match - information about the match
1955 * @ssid: SSID of the match that triggered the wake up
1956 * @n_channels: Number of channels where the match occurred. This
1957 * value may be zero if the driver can't report the channels.
1958 * @channels: center frequencies of the channels where a match
1961 struct cfg80211_wowlan_nd_match {
1962 struct cfg80211_ssid ssid;
1968 * struct cfg80211_wowlan_nd_info - net detect wake up information
1970 * @n_matches: Number of match information instances provided in
1971 * @matches. This value may be zero if the driver can't provide
1972 * match information.
1973 * @matches: Array of pointers to matches containing information about
1974 * the matches that triggered the wake up.
1976 struct cfg80211_wowlan_nd_info {
1978 struct cfg80211_wowlan_nd_match *matches[];
1982 * struct cfg80211_wowlan_wakeup - wakeup report
1983 * @disconnect: woke up by getting disconnected
1984 * @magic_pkt: woke up by receiving magic packet
1985 * @gtk_rekey_failure: woke up by GTK rekey failure
1986 * @eap_identity_req: woke up by EAP identity request packet
1987 * @four_way_handshake: woke up by 4-way handshake
1988 * @rfkill_release: woke up by rfkill being released
1989 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
1990 * @packet_present_len: copied wakeup packet data
1991 * @packet_len: original wakeup packet length
1992 * @packet: The packet causing the wakeup, if any.
1993 * @packet_80211: For pattern match, magic packet and other data
1994 * frame triggers an 802.3 frame should be reported, for
1995 * disconnect due to deauth 802.11 frame. This indicates which
1997 * @tcp_match: TCP wakeup packet received
1998 * @tcp_connlost: TCP connection lost or failed to establish
1999 * @tcp_nomoretokens: TCP data ran out of tokens
2000 * @net_detect: if not %NULL, woke up because of net detect
2002 struct cfg80211_wowlan_wakeup {
2003 bool disconnect, magic_pkt, gtk_rekey_failure,
2004 eap_identity_req, four_way_handshake,
2005 rfkill_release, packet_80211,
2006 tcp_match, tcp_connlost, tcp_nomoretokens;
2008 u32 packet_present_len, packet_len;
2010 struct cfg80211_wowlan_nd_info *net_detect;
2014 * struct cfg80211_gtk_rekey_data - rekey data
2015 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2016 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2017 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2019 struct cfg80211_gtk_rekey_data {
2020 const u8 *kek, *kck, *replay_ctr;
2024 * struct cfg80211_update_ft_ies_params - FT IE Information
2026 * This structure provides information needed to update the fast transition IE
2028 * @md: The Mobility Domain ID, 2 Octet value
2029 * @ie: Fast Transition IEs
2030 * @ie_len: Length of ft_ie in octets
2032 struct cfg80211_update_ft_ies_params {
2039 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2041 * This structure provides information needed to transmit a mgmt frame
2043 * @chan: channel to use
2044 * @offchan: indicates wether off channel operation is required
2045 * @wait: duration for ROC
2046 * @buf: buffer to transmit
2047 * @len: buffer length
2048 * @no_cck: don't use cck rates for this frame
2049 * @dont_wait_for_ack: tells the low level not to wait for an ack
2050 * @n_csa_offsets: length of csa_offsets array
2051 * @csa_offsets: array of all the csa offsets in the frame
2053 struct cfg80211_mgmt_tx_params {
2054 struct ieee80211_channel *chan;
2060 bool dont_wait_for_ack;
2062 const u16 *csa_offsets;
2066 * struct cfg80211_dscp_exception - DSCP exception
2068 * @dscp: DSCP value that does not adhere to the user priority range definition
2069 * @up: user priority value to which the corresponding DSCP value belongs
2071 struct cfg80211_dscp_exception {
2077 * struct cfg80211_dscp_range - DSCP range definition for user priority
2079 * @low: lowest DSCP value of this user priority range, inclusive
2080 * @high: highest DSCP value of this user priority range, inclusive
2082 struct cfg80211_dscp_range {
2087 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2088 #define IEEE80211_QOS_MAP_MAX_EX 21
2089 #define IEEE80211_QOS_MAP_LEN_MIN 16
2090 #define IEEE80211_QOS_MAP_LEN_MAX \
2091 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2094 * struct cfg80211_qos_map - QoS Map Information
2096 * This struct defines the Interworking QoS map setting for DSCP values
2098 * @num_des: number of DSCP exceptions (0..21)
2099 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2100 * the user priority DSCP range definition
2101 * @up: DSCP range definition for a particular user priority
2103 struct cfg80211_qos_map {
2105 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2106 struct cfg80211_dscp_range up[8];
2110 * struct cfg80211_ops - backend description for wireless configuration
2112 * This struct is registered by fullmac card drivers and/or wireless stacks
2113 * in order to handle configuration requests on their interfaces.
2115 * All callbacks except where otherwise noted should return 0
2116 * on success or a negative error code.
2118 * All operations are currently invoked under rtnl for consistency with the
2119 * wireless extensions but this is subject to reevaluation as soon as this
2120 * code is used more widely and we have a first user without wext.
2122 * @suspend: wiphy device needs to be suspended. The variable @wow will
2123 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2124 * configured for the device.
2125 * @resume: wiphy device needs to be resumed
2126 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2127 * to call device_set_wakeup_enable() to enable/disable wakeup from
2130 * @add_virtual_intf: create a new virtual interface with the given name,
2131 * must set the struct wireless_dev's iftype. Beware: You must create
2132 * the new netdev in the wiphy's network namespace! Returns the struct
2133 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2134 * also set the address member in the wdev.
2136 * @del_virtual_intf: remove the virtual interface
2138 * @change_virtual_intf: change type/configuration of virtual interface,
2139 * keep the struct wireless_dev's iftype updated.
2141 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2142 * when adding a group key.
2144 * @get_key: get information about the key with the given parameters.
2145 * @mac_addr will be %NULL when requesting information for a group
2146 * key. All pointers given to the @callback function need not be valid
2147 * after it returns. This function should return an error if it is
2148 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2150 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2151 * and @key_index, return -ENOENT if the key doesn't exist.
2153 * @set_default_key: set the default key on an interface
2155 * @set_default_mgmt_key: set the default management frame key on an interface
2157 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2159 * @start_ap: Start acting in AP mode defined by the parameters.
2160 * @change_beacon: Change the beacon parameters for an access point mode
2161 * interface. This should reject the call when AP mode wasn't started.
2162 * @stop_ap: Stop being an AP, including stopping beaconing.
2164 * @add_station: Add a new station.
2165 * @del_station: Remove a station
2166 * @change_station: Modify a given station. Note that flags changes are not much
2167 * validated in cfg80211, in particular the auth/assoc/authorized flags
2168 * might come to the driver in invalid combinations -- make sure to check
2169 * them, also against the existing state! Drivers must call
2170 * cfg80211_check_station_change() to validate the information.
2171 * @get_station: get station information for the station identified by @mac
2172 * @dump_station: dump station callback -- resume dump at index @idx
2174 * @add_mpath: add a fixed mesh path
2175 * @del_mpath: delete a given mesh path
2176 * @change_mpath: change a given mesh path
2177 * @get_mpath: get a mesh path for the given parameters
2178 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2179 * @get_mpp: get a mesh proxy path for the given parameters
2180 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2181 * @join_mesh: join the mesh network with the specified parameters
2182 * (invoked with the wireless_dev mutex held)
2183 * @leave_mesh: leave the current mesh network
2184 * (invoked with the wireless_dev mutex held)
2186 * @get_mesh_config: Get the current mesh configuration
2188 * @update_mesh_config: Update mesh parameters on a running mesh.
2189 * The mask is a bitfield which tells us which parameters to
2190 * set, and which to leave alone.
2192 * @change_bss: Modify parameters for a given BSS.
2194 * @set_txq_params: Set TX queue parameters
2196 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2197 * as it doesn't implement join_mesh and needs to set the channel to
2198 * join the mesh instead.
2200 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2201 * interfaces are active this callback should reject the configuration.
2202 * If no interfaces are active or the device is down, the channel should
2203 * be stored for when a monitor interface becomes active.
2205 * @scan: Request to do a scan. If returning zero, the scan request is given
2206 * the driver, and will be valid until passed to cfg80211_scan_done().
2207 * For scan results, call cfg80211_inform_bss(); you can call this outside
2208 * the scan/scan_done bracket too.
2210 * @auth: Request to authenticate with the specified peer
2211 * (invoked with the wireless_dev mutex held)
2212 * @assoc: Request to (re)associate with the specified peer
2213 * (invoked with the wireless_dev mutex held)
2214 * @deauth: Request to deauthenticate from the specified peer
2215 * (invoked with the wireless_dev mutex held)
2216 * @disassoc: Request to disassociate from the specified peer
2217 * (invoked with the wireless_dev mutex held)
2219 * @connect: Connect to the ESS with the specified parameters. When connected,
2220 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
2221 * If the connection fails for some reason, call cfg80211_connect_result()
2222 * with the status from the AP.
2223 * (invoked with the wireless_dev mutex held)
2224 * @disconnect: Disconnect from the BSS/ESS.
2225 * (invoked with the wireless_dev mutex held)
2227 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2228 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2230 * (invoked with the wireless_dev mutex held)
2231 * @leave_ibss: Leave the IBSS.
2232 * (invoked with the wireless_dev mutex held)
2234 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2237 * @set_wiphy_params: Notify that wiphy parameters have changed;
2238 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2239 * have changed. The actual parameter values are available in
2240 * struct wiphy. If returning an error, no value should be changed.
2242 * @set_tx_power: set the transmit power according to the parameters,
2243 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2244 * wdev may be %NULL if power was set for the wiphy, and will
2245 * always be %NULL unless the driver supports per-vif TX power
2246 * (as advertised by the nl80211 feature flag.)
2247 * @get_tx_power: store the current TX power into the dbm variable;
2248 * return 0 if successful
2250 * @set_wds_peer: set the WDS peer for a WDS interface
2252 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2253 * functions to adjust rfkill hw state
2255 * @dump_survey: get site survey information.
2257 * @remain_on_channel: Request the driver to remain awake on the specified
2258 * channel for the specified duration to complete an off-channel
2259 * operation (e.g., public action frame exchange). When the driver is
2260 * ready on the requested channel, it must indicate this with an event
2261 * notification by calling cfg80211_ready_on_channel().
2262 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2263 * This allows the operation to be terminated prior to timeout based on
2264 * the duration value.
2265 * @mgmt_tx: Transmit a management frame.
2266 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2267 * frame on another channel
2269 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2270 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2271 * used by the function, but 0 and 1 must not be touched. Additionally,
2272 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2273 * dump and return to userspace with an error, so be careful. If any data
2274 * was passed in from userspace then the data/len arguments will be present
2275 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2277 * @set_bitrate_mask: set the bitrate mask configuration
2279 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2280 * devices running firmwares capable of generating the (re) association
2281 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2282 * @del_pmksa: Delete a cached PMKID.
2283 * @flush_pmksa: Flush all cached PMKIDs.
2284 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2285 * allows the driver to adjust the dynamic ps timeout value.
2286 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2287 * @set_cqm_txe_config: Configure connection quality monitor TX error
2289 * @sched_scan_start: Tell the driver to start a scheduled scan.
2290 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2291 * call must stop the scheduled scan and be ready for starting a new one
2292 * before it returns, i.e. @sched_scan_start may be called immediately
2293 * after that again and should not fail in that case. The driver should
2294 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2295 * method returns 0.)
2297 * @mgmt_frame_register: Notify driver that a management frame type was
2298 * registered. Note that this callback may not sleep, and cannot run
2299 * concurrently with itself.
2301 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2302 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2303 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2304 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2306 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2308 * @tdls_mgmt: Transmit a TDLS management frame.
2309 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2311 * @probe_client: probe an associated client, must return a cookie that it
2312 * later passes to cfg80211_probe_status().
2314 * @set_noack_map: Set the NoAck Map for the TIDs.
2316 * @get_channel: Get the current operating channel for the virtual interface.
2317 * For monitor interfaces, it should return %NULL unless there's a single
2318 * current monitoring channel.
2320 * @start_p2p_device: Start the given P2P device.
2321 * @stop_p2p_device: Stop the given P2P device.
2323 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2324 * Parameters include ACL policy, an array of MAC address of stations
2325 * and the number of MAC addresses. If there is already a list in driver
2326 * this new list replaces the existing one. Driver has to clear its ACL
2327 * when number of MAC addresses entries is passed as 0. Drivers which
2328 * advertise the support for MAC based ACL have to implement this callback.
2330 * @start_radar_detection: Start radar detection in the driver.
2332 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2333 * driver. If the SME is in the driver/firmware, this information can be
2334 * used in building Authentication and Reassociation Request frames.
2336 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2337 * for a given duration (milliseconds). The protocol is provided so the
2338 * driver can take the most appropriate actions.
2339 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2340 * reliability. This operation can not fail.
2341 * @set_coalesce: Set coalesce parameters.
2343 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2344 * responsible for veryfing if the switch is possible. Since this is
2345 * inherently tricky driver may decide to disconnect an interface later
2346 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2347 * everything. It should do it's best to verify requests and reject them
2348 * as soon as possible.
2350 * @set_qos_map: Set QoS mapping information to the driver
2352 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2353 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2354 * changes during the lifetime of the BSS.
2356 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2357 * with the given parameters; action frame exchange has been handled by
2358 * userspace so this just has to modify the TX path to take the TS into
2360 * If the admitted time is 0 just validate the parameters to make sure
2361 * the session can be created at all; it is valid to just always return
2362 * success for that but that may result in inefficient behaviour (handshake
2363 * with the peer followed by immediate teardown when the addition is later
2365 * @del_tx_ts: remove an existing TX TS
2367 * @join_ocb: join the OCB network with the specified parameters
2368 * (invoked with the wireless_dev mutex held)
2369 * @leave_ocb: leave the current OCB network
2370 * (invoked with the wireless_dev mutex held)
2372 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2373 * is responsible for continually initiating channel-switching operations
2374 * and returning to the base channel for communication with the AP.
2375 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2376 * peers must be on the base channel when the call completes.
2378 struct cfg80211_ops {
2379 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2380 int (*resume)(struct wiphy *wiphy);
2381 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2383 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2385 enum nl80211_iftype type,
2387 struct vif_params *params);
2388 int (*del_virtual_intf)(struct wiphy *wiphy,
2389 struct wireless_dev *wdev);
2390 int (*change_virtual_intf)(struct wiphy *wiphy,
2391 struct net_device *dev,
2392 enum nl80211_iftype type, u32 *flags,
2393 struct vif_params *params);
2395 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2396 u8 key_index, bool pairwise, const u8 *mac_addr,
2397 struct key_params *params);
2398 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2399 u8 key_index, bool pairwise, const u8 *mac_addr,
2401 void (*callback)(void *cookie, struct key_params*));
2402 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2403 u8 key_index, bool pairwise, const u8 *mac_addr);
2404 int (*set_default_key)(struct wiphy *wiphy,
2405 struct net_device *netdev,
2406 u8 key_index, bool unicast, bool multicast);
2407 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2408 struct net_device *netdev,
2411 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2412 struct cfg80211_ap_settings *settings);
2413 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2414 struct cfg80211_beacon_data *info);
2415 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2418 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2420 struct station_parameters *params);
2421 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2422 struct station_del_parameters *params);
2423 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2425 struct station_parameters *params);
2426 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2427 const u8 *mac, struct station_info *sinfo);
2428 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2429 int idx, u8 *mac, struct station_info *sinfo);
2431 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2432 const u8 *dst, const u8 *next_hop);
2433 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2435 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2436 const u8 *dst, const u8 *next_hop);
2437 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2438 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2439 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2440 int idx, u8 *dst, u8 *next_hop,
2441 struct mpath_info *pinfo);
2442 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2443 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2444 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2445 int idx, u8 *dst, u8 *mpp,
2446 struct mpath_info *pinfo);
2447 int (*get_mesh_config)(struct wiphy *wiphy,
2448 struct net_device *dev,
2449 struct mesh_config *conf);
2450 int (*update_mesh_config)(struct wiphy *wiphy,
2451 struct net_device *dev, u32 mask,
2452 const struct mesh_config *nconf);
2453 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2454 const struct mesh_config *conf,
2455 const struct mesh_setup *setup);
2456 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2458 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2459 struct ocb_setup *setup);
2460 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2462 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2463 struct bss_parameters *params);
2465 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2466 struct ieee80211_txq_params *params);
2468 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2469 struct net_device *dev,
2470 struct ieee80211_channel *chan);
2472 int (*set_monitor_channel)(struct wiphy *wiphy,
2473 struct cfg80211_chan_def *chandef);
2475 int (*scan)(struct wiphy *wiphy,
2476 struct cfg80211_scan_request *request);
2478 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2479 struct cfg80211_auth_request *req);
2480 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2481 struct cfg80211_assoc_request *req);
2482 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2483 struct cfg80211_deauth_request *req);
2484 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2485 struct cfg80211_disassoc_request *req);
2487 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2488 struct cfg80211_connect_params *sme);
2489 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2492 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2493 struct cfg80211_ibss_params *params);
2494 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2496 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2497 int rate[IEEE80211_NUM_BANDS]);
2499 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2501 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2502 enum nl80211_tx_power_setting type, int mbm);
2503 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2506 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2509 void (*rfkill_poll)(struct wiphy *wiphy);
2511 #ifdef CONFIG_NL80211_TESTMODE
2512 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2513 void *data, int len);
2514 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2515 struct netlink_callback *cb,
2516 void *data, int len);
2519 int (*set_bitrate_mask)(struct wiphy *wiphy,
2520 struct net_device *dev,
2522 const struct cfg80211_bitrate_mask *mask);
2524 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2525 int idx, struct survey_info *info);
2527 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2528 struct cfg80211_pmksa *pmksa);
2529 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2530 struct cfg80211_pmksa *pmksa);
2531 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2533 int (*remain_on_channel)(struct wiphy *wiphy,
2534 struct wireless_dev *wdev,
2535 struct ieee80211_channel *chan,
2536 unsigned int duration,
2538 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2539 struct wireless_dev *wdev,
2542 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2543 struct cfg80211_mgmt_tx_params *params,
2545 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2546 struct wireless_dev *wdev,
2549 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2550 bool enabled, int timeout);
2552 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2553 struct net_device *dev,
2554 s32 rssi_thold, u32 rssi_hyst);
2556 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2557 struct net_device *dev,
2558 u32 rate, u32 pkts, u32 intvl);
2560 void (*mgmt_frame_register)(struct wiphy *wiphy,
2561 struct wireless_dev *wdev,
2562 u16 frame_type, bool reg);
2564 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2565 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2567 int (*sched_scan_start)(struct wiphy *wiphy,
2568 struct net_device *dev,
2569 struct cfg80211_sched_scan_request *request);
2570 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2572 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2573 struct cfg80211_gtk_rekey_data *data);
2575 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2576 const u8 *peer, u8 action_code, u8 dialog_token,
2577 u16 status_code, u32 peer_capability,
2578 bool initiator, const u8 *buf, size_t len);
2579 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2580 const u8 *peer, enum nl80211_tdls_operation oper);
2582 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2583 const u8 *peer, u64 *cookie);
2585 int (*set_noack_map)(struct wiphy *wiphy,
2586 struct net_device *dev,
2589 int (*get_channel)(struct wiphy *wiphy,
2590 struct wireless_dev *wdev,
2591 struct cfg80211_chan_def *chandef);
2593 int (*start_p2p_device)(struct wiphy *wiphy,
2594 struct wireless_dev *wdev);
2595 void (*stop_p2p_device)(struct wiphy *wiphy,
2596 struct wireless_dev *wdev);
2598 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2599 const struct cfg80211_acl_data *params);
2601 int (*start_radar_detection)(struct wiphy *wiphy,
2602 struct net_device *dev,
2603 struct cfg80211_chan_def *chandef,
2605 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2606 struct cfg80211_update_ft_ies_params *ftie);
2607 int (*crit_proto_start)(struct wiphy *wiphy,
2608 struct wireless_dev *wdev,
2609 enum nl80211_crit_proto_id protocol,
2611 void (*crit_proto_stop)(struct wiphy *wiphy,
2612 struct wireless_dev *wdev);
2613 int (*set_coalesce)(struct wiphy *wiphy,
2614 struct cfg80211_coalesce *coalesce);
2616 int (*channel_switch)(struct wiphy *wiphy,
2617 struct net_device *dev,
2618 struct cfg80211_csa_settings *params);
2620 int (*set_qos_map)(struct wiphy *wiphy,
2621 struct net_device *dev,
2622 struct cfg80211_qos_map *qos_map);
2624 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
2625 struct cfg80211_chan_def *chandef);
2627 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2628 u8 tsid, const u8 *peer, u8 user_prio,
2630 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2631 u8 tsid, const u8 *peer);
2633 int (*tdls_channel_switch)(struct wiphy *wiphy,
2634 struct net_device *dev,
2635 const u8 *addr, u8 oper_class,
2636 struct cfg80211_chan_def *chandef);
2637 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
2638 struct net_device *dev,
2643 * wireless hardware and networking interfaces structures
2644 * and registration/helper functions
2648 * enum wiphy_flags - wiphy capability flags
2650 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2652 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2653 * by default -- this flag will be set depending on the kernel's default
2654 * on wiphy_new(), but can be changed by the driver if it has a good
2655 * reason to override the default
2656 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2657 * on a VLAN interface)
2658 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2659 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2660 * control port protocol ethertype. The device also honours the
2661 * control_port_no_encrypt flag.
2662 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2663 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2664 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2665 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2666 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2668 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2669 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2670 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2671 * link setup/discovery operations internally. Setup, discovery and
2672 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2673 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2674 * used for asking the driver/firmware to perform a TDLS operation.
2675 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2676 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2677 * when there are virtual interfaces in AP mode by calling
2678 * cfg80211_report_obss_beacon().
2679 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2680 * responds to probe-requests in hardware.
2681 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2682 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2683 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2684 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2685 * beaconing mode (AP, IBSS, Mesh, ...).
2691 WIPHY_FLAG_NETNS_OK = BIT(3),
2692 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2693 WIPHY_FLAG_4ADDR_AP = BIT(5),
2694 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2695 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2696 WIPHY_FLAG_IBSS_RSN = BIT(8),
2697 WIPHY_FLAG_MESH_AUTH = BIT(10),
2698 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2699 /* use hole at 12 */
2700 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2701 WIPHY_FLAG_AP_UAPSD = BIT(14),
2702 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2703 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2704 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2705 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2706 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2707 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2708 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2709 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
2710 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
2714 * struct ieee80211_iface_limit - limit on certain interface types
2715 * @max: maximum number of interfaces of these types
2716 * @types: interface types (bits)
2718 struct ieee80211_iface_limit {
2724 * struct ieee80211_iface_combination - possible interface combination
2725 * @limits: limits for the given interface types
2726 * @n_limits: number of limitations
2727 * @num_different_channels: can use up to this many different channels
2728 * @max_interfaces: maximum number of interfaces in total allowed in this
2730 * @beacon_int_infra_match: In this combination, the beacon intervals
2731 * between infrastructure and AP types must match. This is required
2732 * only in special cases.
2733 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2734 * @radar_detect_regions: bitmap of regions supported for radar detection
2736 * With this structure the driver can describe which interface
2737 * combinations it supports concurrently.
2741 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2743 * struct ieee80211_iface_limit limits1[] = {
2744 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2745 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2747 * struct ieee80211_iface_combination combination1 = {
2748 * .limits = limits1,
2749 * .n_limits = ARRAY_SIZE(limits1),
2750 * .max_interfaces = 2,
2751 * .beacon_int_infra_match = true,
2755 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2757 * struct ieee80211_iface_limit limits2[] = {
2758 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2759 * BIT(NL80211_IFTYPE_P2P_GO), },
2761 * struct ieee80211_iface_combination combination2 = {
2762 * .limits = limits2,
2763 * .n_limits = ARRAY_SIZE(limits2),
2764 * .max_interfaces = 8,
2765 * .num_different_channels = 1,
2769 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2771 * This allows for an infrastructure connection and three P2P connections.
2773 * struct ieee80211_iface_limit limits3[] = {
2774 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2775 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2776 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2778 * struct ieee80211_iface_combination combination3 = {
2779 * .limits = limits3,
2780 * .n_limits = ARRAY_SIZE(limits3),
2781 * .max_interfaces = 4,
2782 * .num_different_channels = 2,
2785 struct ieee80211_iface_combination {
2786 const struct ieee80211_iface_limit *limits;
2787 u32 num_different_channels;
2790 bool beacon_int_infra_match;
2791 u8 radar_detect_widths;
2792 u8 radar_detect_regions;
2795 struct ieee80211_txrx_stypes {
2800 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2801 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2802 * trigger that keeps the device operating as-is and
2803 * wakes up the host on any activity, for example a
2804 * received packet that passed filtering; note that the
2805 * packet should be preserved in that case
2806 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2808 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2809 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2810 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2811 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2812 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2813 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2814 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
2816 enum wiphy_wowlan_support_flags {
2817 WIPHY_WOWLAN_ANY = BIT(0),
2818 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2819 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2820 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2821 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2822 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2823 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2824 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2825 WIPHY_WOWLAN_NET_DETECT = BIT(8),
2828 struct wiphy_wowlan_tcp_support {
2829 const struct nl80211_wowlan_tcp_data_token_feature *tok;
2830 u32 data_payload_max;
2831 u32 data_interval_max;
2832 u32 wake_payload_max;
2837 * struct wiphy_wowlan_support - WoWLAN support data
2838 * @flags: see &enum wiphy_wowlan_support_flags
2839 * @n_patterns: number of supported wakeup patterns
2840 * (see nl80211.h for the pattern definition)
2841 * @pattern_max_len: maximum length of each pattern
2842 * @pattern_min_len: minimum length of each pattern
2843 * @max_pkt_offset: maximum Rx packet offset
2844 * @max_nd_match_sets: maximum number of matchsets for net-detect,
2845 * similar, but not necessarily identical, to max_match_sets for
2847 * See &struct cfg80211_sched_scan_request.@match_sets for more
2849 * @tcp: TCP wakeup support information
2851 struct wiphy_wowlan_support {
2854 int pattern_max_len;
2855 int pattern_min_len;
2857 int max_nd_match_sets;
2858 const struct wiphy_wowlan_tcp_support *tcp;
2862 * struct wiphy_coalesce_support - coalesce support data
2863 * @n_rules: maximum number of coalesce rules
2864 * @max_delay: maximum supported coalescing delay in msecs
2865 * @n_patterns: number of supported patterns in a rule
2866 * (see nl80211.h for the pattern definition)
2867 * @pattern_max_len: maximum length of each pattern
2868 * @pattern_min_len: minimum length of each pattern
2869 * @max_pkt_offset: maximum Rx packet offset
2871 struct wiphy_coalesce_support {
2875 int pattern_max_len;
2876 int pattern_min_len;
2881 * enum wiphy_vendor_command_flags - validation flags for vendor commands
2882 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
2883 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
2884 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
2885 * (must be combined with %_WDEV or %_NETDEV)
2887 enum wiphy_vendor_command_flags {
2888 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
2889 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
2890 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
2894 * struct wiphy_vendor_command - vendor command definition
2895 * @info: vendor command identifying information, as used in nl80211
2896 * @flags: flags, see &enum wiphy_vendor_command_flags
2897 * @doit: callback for the operation, note that wdev is %NULL if the
2898 * flags didn't ask for a wdev and non-%NULL otherwise; the data
2899 * pointer may be %NULL if userspace provided no data at all
2901 struct wiphy_vendor_command {
2902 struct nl80211_vendor_cmd_info info;
2904 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
2905 const void *data, int data_len);
2909 * struct wiphy - wireless hardware description
2910 * @reg_notifier: the driver's regulatory notification callback,
2911 * note that if your driver uses wiphy_apply_custom_regulatory()
2912 * the reg_notifier's request can be passed as NULL
2913 * @regd: the driver's regulatory domain, if one was requested via
2914 * the regulatory_hint() API. This can be used by the driver
2915 * on the reg_notifier() if it chooses to ignore future
2916 * regulatory domain changes caused by other drivers.
2917 * @signal_type: signal type reported in &struct cfg80211_bss.
2918 * @cipher_suites: supported cipher suites
2919 * @n_cipher_suites: number of supported cipher suites
2920 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2921 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2922 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2923 * -1 = fragmentation disabled, only odd values >= 256 used
2924 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2925 * @_net: the network namespace this wiphy currently lives in
2926 * @perm_addr: permanent MAC address of this device
2927 * @addr_mask: If the device supports multiple MAC addresses by masking,
2928 * set this to a mask with variable bits set to 1, e.g. if the last
2929 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
2930 * variable bits shall be determined by the interfaces added, with
2931 * interfaces not matching the mask being rejected to be brought up.
2932 * @n_addresses: number of addresses in @addresses.
2933 * @addresses: If the device has more than one address, set this pointer
2934 * to a list of addresses (6 bytes each). The first one will be used
2935 * by default for perm_addr. In this case, the mask should be set to
2936 * all-zeroes. In this case it is assumed that the device can handle
2937 * the same number of arbitrary MAC addresses.
2938 * @registered: protects ->resume and ->suspend sysfs callbacks against
2939 * unregister hardware
2940 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2941 * automatically on wiphy renames
2942 * @dev: (virtual) struct device for this wiphy
2943 * @registered: helps synchronize suspend/resume with wiphy unregister
2944 * @wext: wireless extension handlers
2945 * @priv: driver private data (sized according to wiphy_new() parameter)
2946 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2947 * must be set by driver
2948 * @iface_combinations: Valid interface combinations array, should not
2949 * list single interface types.
2950 * @n_iface_combinations: number of entries in @iface_combinations array.
2951 * @software_iftypes: bitmask of software interface types, these are not
2952 * subject to any restrictions since they are purely managed in SW.
2953 * @flags: wiphy flags, see &enum wiphy_flags
2954 * @regulatory_flags: wiphy regulatory flags, see
2955 * &enum ieee80211_regulatory_flags
2956 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2957 * @ext_features: extended features advertised to nl80211, see
2958 * &enum nl80211_ext_feature_index.
2959 * @bss_priv_size: each BSS struct has private data allocated with it,
2960 * this variable determines its size
2961 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2963 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2964 * for in any given scheduled scan
2965 * @max_match_sets: maximum number of match sets the device can handle
2966 * when performing a scheduled scan, 0 if filtering is not
2968 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2969 * add to probe request frames transmitted during a scan, must not
2970 * include fixed IEs like supported rates
2971 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2973 * @coverage_class: current coverage class
2974 * @fw_version: firmware version for ethtool reporting
2975 * @hw_version: hardware version for ethtool reporting
2976 * @max_num_pmkids: maximum number of PMKIDs supported by device
2977 * @privid: a pointer that drivers can use to identify if an arbitrary
2978 * wiphy is theirs, e.g. in global notifiers
2979 * @bands: information about bands/channels supported by this device
2981 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2982 * transmitted through nl80211, points to an array indexed by interface
2985 * @available_antennas_tx: bitmap of antennas which are available to be
2986 * configured as TX antennas. Antenna configuration commands will be
2987 * rejected unless this or @available_antennas_rx is set.
2989 * @available_antennas_rx: bitmap of antennas which are available to be
2990 * configured as RX antennas. Antenna configuration commands will be
2991 * rejected unless this or @available_antennas_tx is set.
2993 * @probe_resp_offload:
2994 * Bitmap of supported protocols for probe response offloading.
2995 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2996 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2998 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2999 * may request, if implemented.
3001 * @wowlan: WoWLAN support information
3002 * @wowlan_config: current WoWLAN configuration; this should usually not be
3003 * used since access to it is necessarily racy, use the parameter passed
3004 * to the suspend() operation instead.
3006 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3007 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3008 * If null, then none can be over-ridden.
3009 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3010 * If null, then none can be over-ridden.
3012 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3015 * @extended_capabilities: extended capabilities supported by the driver,
3016 * additional capabilities might be supported by userspace; these are
3017 * the 802.11 extended capabilities ("Extended Capabilities element")
3018 * and are in the same format as in the information element. See
3019 * 802.11-2012 8.4.2.29 for the defined fields.
3020 * @extended_capabilities_mask: mask of the valid values
3021 * @extended_capabilities_len: length of the extended capabilities
3022 * @coalesce: packet coalescing support information
3024 * @vendor_commands: array of vendor commands supported by the hardware
3025 * @n_vendor_commands: number of vendor commands
3026 * @vendor_events: array of vendor events supported by the hardware
3027 * @n_vendor_events: number of vendor events
3029 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3030 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3031 * driver is allowed to advertise a theoretical limit that it can reach in
3032 * some cases, but may not always reach.
3034 * @max_num_csa_counters: Number of supported csa_counters in beacons
3035 * and probe responses. This value should be set if the driver
3036 * wishes to limit the number of csa counters. Default (0) means
3038 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3039 * frame was sent and the channel on which the frame was heard for which
3040 * the reported rssi is still valid. If a driver is able to compensate the
3041 * low rssi when a frame is heard on different channel, then it should set
3042 * this variable to the maximal offset for which it can compensate.
3043 * This value should be set in MHz.
3046 /* assign these fields before you register the wiphy */
3048 /* permanent MAC address(es) */
3049 u8 perm_addr[ETH_ALEN];
3050 u8 addr_mask[ETH_ALEN];
3052 struct mac_address *addresses;
3054 const struct ieee80211_txrx_stypes *mgmt_stypes;
3056 const struct ieee80211_iface_combination *iface_combinations;
3057 int n_iface_combinations;
3058 u16 software_iftypes;
3062 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3063 u16 interface_modes;
3065 u16 max_acl_mac_addrs;
3067 u32 flags, regulatory_flags, features;
3068 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3072 enum cfg80211_signal_type signal_type;
3076 u8 max_sched_scan_ssids;
3078 u16 max_scan_ie_len;
3079 u16 max_sched_scan_ie_len;
3081 int n_cipher_suites;
3082 const u32 *cipher_suites;
3090 char fw_version[ETHTOOL_FWVERS_LEN];
3094 const struct wiphy_wowlan_support *wowlan;
3095 struct cfg80211_wowlan *wowlan_config;
3098 u16 max_remain_on_channel_duration;
3102 u32 available_antennas_tx;
3103 u32 available_antennas_rx;
3106 * Bitmap of supported protocols for probe response offloading
3107 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3108 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3110 u32 probe_resp_offload;
3112 const u8 *extended_capabilities, *extended_capabilities_mask;
3113 u8 extended_capabilities_len;
3115 /* If multiple wiphys are registered and you're handed e.g.
3116 * a regular netdev with assigned ieee80211_ptr, you won't
3117 * know whether it points to a wiphy your driver has registered
3118 * or not. Assign this to something global to your driver to
3119 * help determine whether you own this wiphy or not. */
3122 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
3124 /* Lets us get back the wiphy on the callback */
3125 void (*reg_notifier)(struct wiphy *wiphy,
3126 struct regulatory_request *request);
3128 /* fields below are read-only, assigned by cfg80211 */
3130 const struct ieee80211_regdomain __rcu *regd;
3132 /* the item in /sys/class/ieee80211/ points to this,
3133 * you need use set_wiphy_dev() (see below) */
3136 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3139 /* dir in debugfs: ieee80211/<wiphyname> */
3140 struct dentry *debugfsdir;
3142 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3143 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3145 #ifdef CONFIG_NET_NS
3146 /* the network namespace this phy lives in currently */
3150 #ifdef CONFIG_CFG80211_WEXT
3151 const struct iw_handler_def *wext;
3154 const struct wiphy_coalesce_support *coalesce;
3156 const struct wiphy_vendor_command *vendor_commands;
3157 const struct nl80211_vendor_cmd_info *vendor_events;
3158 int n_vendor_commands, n_vendor_events;
3160 u16 max_ap_assoc_sta;
3162 u8 max_num_csa_counters;
3163 u8 max_adj_channel_rssi_comp;
3165 char priv[0] __aligned(NETDEV_ALIGN);
3168 static inline struct net *wiphy_net(struct wiphy *wiphy)
3170 return read_pnet(&wiphy->_net);
3173 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3175 write_pnet(&wiphy->_net, net);
3179 * wiphy_priv - return priv from wiphy
3181 * @wiphy: the wiphy whose priv pointer to return
3182 * Return: The priv of @wiphy.
3184 static inline void *wiphy_priv(struct wiphy *wiphy)
3187 return &wiphy->priv;
3191 * priv_to_wiphy - return the wiphy containing the priv
3193 * @priv: a pointer previously returned by wiphy_priv
3194 * Return: The wiphy of @priv.
3196 static inline struct wiphy *priv_to_wiphy(void *priv)
3199 return container_of(priv, struct wiphy, priv);
3203 * set_wiphy_dev - set device pointer for wiphy
3205 * @wiphy: The wiphy whose device to bind
3206 * @dev: The device to parent it to
3208 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3210 wiphy->dev.parent = dev;
3214 * wiphy_dev - get wiphy dev pointer
3216 * @wiphy: The wiphy whose device struct to look up
3217 * Return: The dev of @wiphy.
3219 static inline struct device *wiphy_dev(struct wiphy *wiphy)
3221 return wiphy->dev.parent;
3225 * wiphy_name - get wiphy name
3227 * @wiphy: The wiphy whose name to return
3228 * Return: The name of @wiphy.
3230 static inline const char *wiphy_name(const struct wiphy *wiphy)
3232 return dev_name(&wiphy->dev);
3236 * wiphy_new_nm - create a new wiphy for use with cfg80211
3238 * @ops: The configuration operations for this device
3239 * @sizeof_priv: The size of the private area to allocate
3240 * @requested_name: Request a particular name.
3241 * NULL is valid value, and means use the default phy%d naming.
3243 * Create a new wiphy and associate the given operations with it.
3244 * @sizeof_priv bytes are allocated for private use.
3246 * Return: A pointer to the new wiphy. This pointer must be
3247 * assigned to each netdev's ieee80211_ptr for proper operation.
3249 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3250 const char *requested_name);
3253 * wiphy_new - create a new wiphy for use with cfg80211
3255 * @ops: The configuration operations for this device
3256 * @sizeof_priv: The size of the private area to allocate
3258 * Create a new wiphy and associate the given operations with it.
3259 * @sizeof_priv bytes are allocated for private use.
3261 * Return: A pointer to the new wiphy. This pointer must be
3262 * assigned to each netdev's ieee80211_ptr for proper operation.
3264 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3267 return wiphy_new_nm(ops, sizeof_priv, NULL);
3271 * wiphy_register - register a wiphy with cfg80211
3273 * @wiphy: The wiphy to register.
3275 * Return: A non-negative wiphy index or a negative error code.
3277 int wiphy_register(struct wiphy *wiphy);
3280 * wiphy_unregister - deregister a wiphy from cfg80211
3282 * @wiphy: The wiphy to unregister.
3284 * After this call, no more requests can be made with this priv
3285 * pointer, but the call may sleep to wait for an outstanding
3286 * request that is being handled.
3288 void wiphy_unregister(struct wiphy *wiphy);
3291 * wiphy_free - free wiphy
3293 * @wiphy: The wiphy to free
3295 void wiphy_free(struct wiphy *wiphy);
3297 /* internal structs */
3298 struct cfg80211_conn;
3299 struct cfg80211_internal_bss;
3300 struct cfg80211_cached_keys;
3303 * struct wireless_dev - wireless device state
3305 * For netdevs, this structure must be allocated by the driver
3306 * that uses the ieee80211_ptr field in struct net_device (this
3307 * is intentional so it can be allocated along with the netdev.)
3308 * It need not be registered then as netdev registration will
3309 * be intercepted by cfg80211 to see the new wireless device.
3311 * For non-netdev uses, it must also be allocated by the driver
3312 * in response to the cfg80211 callbacks that require it, as
3313 * there's no netdev registration in that case it may not be
3314 * allocated outside of callback operations that return it.
3316 * @wiphy: pointer to hardware description
3317 * @iftype: interface type
3318 * @list: (private) Used to collect the interfaces
3319 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3320 * @identifier: (private) Identifier used in nl80211 to identify this
3321 * wireless device if it has no netdev
3322 * @current_bss: (private) Used by the internal configuration code
3323 * @chandef: (private) Used by the internal configuration code to track
3324 * the user-set channel definition.
3325 * @preset_chandef: (private) Used by the internal configuration code to
3326 * track the channel to be used for AP later
3327 * @bssid: (private) Used by the internal configuration code
3328 * @ssid: (private) Used by the internal configuration code
3329 * @ssid_len: (private) Used by the internal configuration code
3330 * @mesh_id_len: (private) Used by the internal configuration code
3331 * @mesh_id_up_len: (private) Used by the internal configuration code
3332 * @wext: (private) Used by the internal wireless extensions compat code
3333 * @use_4addr: indicates 4addr mode is used on this interface, must be
3334 * set by driver (if supported) on add_interface BEFORE registering the
3335 * netdev and may otherwise be used by driver read-only, will be update
3336 * by cfg80211 on change_interface
3337 * @mgmt_registrations: list of registrations for management frames
3338 * @mgmt_registrations_lock: lock for the list
3339 * @mtx: mutex used to lock data in this struct, may be used by drivers
3340 * and some API functions require it held
3341 * @beacon_interval: beacon interval used on this device for transmitting
3342 * beacons, 0 when not valid
3343 * @address: The address for this device, valid only if @netdev is %NULL
3344 * @p2p_started: true if this is a P2P Device that has been started
3345 * @cac_started: true if DFS channel availability check has been started
3346 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3347 * @cac_time_ms: CAC time in ms
3348 * @ps: powersave mode is enabled
3349 * @ps_timeout: dynamic powersave timeout
3350 * @ap_unexpected_nlportid: (private) netlink port ID of application
3351 * registered for unexpected class 3 frames (AP mode)
3352 * @conn: (private) cfg80211 software SME connection state machine data
3353 * @connect_keys: (private) keys to set after connection is established
3354 * @ibss_fixed: (private) IBSS is using fixed BSSID
3355 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3356 * @event_list: (private) list for internal event processing
3357 * @event_lock: (private) lock for event list
3358 * @owner_nlportid: (private) owner socket port ID
3360 struct wireless_dev {
3361 struct wiphy *wiphy;
3362 enum nl80211_iftype iftype;
3364 /* the remainder of this struct should be private to cfg80211 */
3365 struct list_head list;
3366 struct net_device *netdev;
3370 struct list_head mgmt_registrations;
3371 spinlock_t mgmt_registrations_lock;
3375 bool use_4addr, p2p_started;
3377 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3379 /* currently used for IBSS and SME - might be rearranged later */
3380 u8 ssid[IEEE80211_MAX_SSID_LEN];
3381 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3382 struct cfg80211_conn *conn;
3383 struct cfg80211_cached_keys *connect_keys;
3385 struct list_head event_list;
3386 spinlock_t event_lock;
3388 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3389 struct cfg80211_chan_def preset_chandef;
3390 struct cfg80211_chan_def chandef;
3393 bool ibss_dfs_possible;
3398 int beacon_interval;
3400 u32 ap_unexpected_nlportid;
3403 unsigned long cac_start_time;
3404 unsigned int cac_time_ms;
3408 #ifdef CONFIG_CFG80211_WEXT
3411 struct cfg80211_ibss_params ibss;
3412 struct cfg80211_connect_params connect;
3413 struct cfg80211_cached_keys *keys;
3416 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3417 u8 ssid[IEEE80211_MAX_SSID_LEN];
3418 s8 default_key, default_mgmt_key;
3419 bool prev_bssid_valid;
3424 static inline u8 *wdev_address(struct wireless_dev *wdev)
3427 return wdev->netdev->dev_addr;
3428 return wdev->address;
3432 * wdev_priv - return wiphy priv from wireless_dev
3434 * @wdev: The wireless device whose wiphy's priv pointer to return
3435 * Return: The wiphy priv of @wdev.
3437 static inline void *wdev_priv(struct wireless_dev *wdev)
3440 return wiphy_priv(wdev->wiphy);
3444 * DOC: Utility functions
3446 * cfg80211 offers a number of utility functions that can be useful.
3450 * ieee80211_channel_to_frequency - convert channel number to frequency
3451 * @chan: channel number
3452 * @band: band, necessary due to channel number overlap
3453 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3455 int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
3458 * ieee80211_frequency_to_channel - convert frequency to channel number
3459 * @freq: center frequency
3460 * Return: The corresponding channel, or 0 if the conversion failed.
3462 int ieee80211_frequency_to_channel(int freq);
3465 * Name indirection necessary because the ieee80211 code also has
3466 * a function named "ieee80211_get_channel", so if you include
3467 * cfg80211's header file you get cfg80211's version, if you try
3468 * to include both header files you'll (rightfully!) get a symbol
3471 struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3474 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3475 * @wiphy: the struct wiphy to get the channel for
3476 * @freq: the center frequency of the channel
3477 * Return: The channel struct from @wiphy at @freq.
3479 static inline struct ieee80211_channel *
3480 ieee80211_get_channel(struct wiphy *wiphy, int freq)
3482 return __ieee80211_get_channel(wiphy, freq);
3486 * ieee80211_get_response_rate - get basic rate for a given rate
3488 * @sband: the band to look for rates in
3489 * @basic_rates: bitmap of basic rates
3490 * @bitrate: the bitrate for which to find the basic rate
3492 * Return: The basic rate corresponding to a given bitrate, that
3493 * is the next lower bitrate contained in the basic rate map,
3494 * which is, for this function, given as a bitmap of indices of
3495 * rates in the band's bitrate table.
3497 struct ieee80211_rate *
3498 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3499 u32 basic_rates, int bitrate);
3502 * ieee80211_mandatory_rates - get mandatory rates for a given band
3503 * @sband: the band to look for rates in
3504 * @scan_width: width of the control channel
3506 * This function returns a bitmap of the mandatory rates for the given
3507 * band, bits are set according to the rate position in the bitrates array.
3509 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3510 enum nl80211_bss_scan_width scan_width);
3513 * Radiotap parsing functions -- for controlled injection support
3515 * Implemented in net/wireless/radiotap.c
3516 * Documentation in Documentation/networking/radiotap-headers.txt
3519 struct radiotap_align_size {
3520 uint8_t align:4, size:4;
3523 struct ieee80211_radiotap_namespace {
3524 const struct radiotap_align_size *align_size;
3530 struct ieee80211_radiotap_vendor_namespaces {
3531 const struct ieee80211_radiotap_namespace *ns;
3536 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3537 * @this_arg_index: index of current arg, valid after each successful call
3538 * to ieee80211_radiotap_iterator_next()
3539 * @this_arg: pointer to current radiotap arg; it is valid after each
3540 * call to ieee80211_radiotap_iterator_next() but also after
3541 * ieee80211_radiotap_iterator_init() where it will point to
3542 * the beginning of the actual data portion
3543 * @this_arg_size: length of the current arg, for convenience
3544 * @current_namespace: pointer to the current namespace definition
3545 * (or internally %NULL if the current namespace is unknown)
3546 * @is_radiotap_ns: indicates whether the current namespace is the default
3547 * radiotap namespace or not
3549 * @_rtheader: pointer to the radiotap header we are walking through
3550 * @_max_length: length of radiotap header in cpu byte ordering
3551 * @_arg_index: next argument index
3552 * @_arg: next argument pointer
3553 * @_next_bitmap: internal pointer to next present u32
3554 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3555 * @_vns: vendor namespace definitions
3556 * @_next_ns_data: beginning of the next namespace's data
3557 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3560 * Describes the radiotap parser state. Fields prefixed with an underscore
3561 * must not be used by users of the parser, only by the parser internally.
3564 struct ieee80211_radiotap_iterator {
3565 struct ieee80211_radiotap_header *_rtheader;
3566 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3567 const struct ieee80211_radiotap_namespace *current_namespace;
3569 unsigned char *_arg, *_next_ns_data;
3570 __le32 *_next_bitmap;
3572 unsigned char *this_arg;
3580 uint32_t _bitmap_shifter;
3585 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3586 struct ieee80211_radiotap_header *radiotap_header,
3588 const struct ieee80211_radiotap_vendor_namespaces *vns);
3591 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3594 extern const unsigned char rfc1042_header[6];
3595 extern const unsigned char bridge_tunnel_header[6];
3598 * ieee80211_get_hdrlen_from_skb - get header length from data
3602 * Given an skb with a raw 802.11 header at the data pointer this function
3603 * returns the 802.11 header length.
3605 * Return: The 802.11 header length in bytes (not including encryption
3606 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3609 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3612 * ieee80211_hdrlen - get header length in bytes from frame control
3613 * @fc: frame control field in little-endian format
3614 * Return: The header length in bytes.
3616 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3619 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3620 * @meshhdr: the mesh extension header, only the flags field
3621 * (first byte) will be accessed
3622 * Return: The length of the extension header, which is always at
3623 * least 6 bytes and at most 18 if address 5 and 6 are present.
3625 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3628 * DOC: Data path helpers
3630 * In addition to generic utilities, cfg80211 also offers
3631 * functions that help implement the data path for devices
3632 * that do not do the 802.11/802.3 conversion on the device.
3636 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3637 * @skb: the 802.11 data frame
3638 * @addr: the device MAC address
3639 * @iftype: the virtual interface type
3640 * Return: 0 on success. Non-zero on error.
3642 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3643 enum nl80211_iftype iftype);
3646 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3647 * @skb: the 802.3 frame
3648 * @addr: the device MAC address
3649 * @iftype: the virtual interface type
3650 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3651 * @qos: build 802.11 QoS data frame
3652 * Return: 0 on success, or a negative error code.
3654 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3655 enum nl80211_iftype iftype, const u8 *bssid,
3659 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3661 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3662 * 802.3 frames. The @list will be empty if the decode fails. The
3663 * @skb is consumed after the function returns.
3665 * @skb: The input IEEE 802.11n A-MSDU frame.
3666 * @list: The output list of 802.3 frames. It must be allocated and
3667 * initialized by by the caller.
3668 * @addr: The device MAC address.
3669 * @iftype: The device interface type.
3670 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3671 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3673 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3674 const u8 *addr, enum nl80211_iftype iftype,
3675 const unsigned int extra_headroom,
3676 bool has_80211_header);
3679 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3680 * @skb: the data frame
3681 * @qos_map: Interworking QoS mapping or %NULL if not in use
3682 * Return: The 802.1p/1d tag.
3684 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3685 struct cfg80211_qos_map *qos_map);
3688 * cfg80211_find_ie - find information element in data
3691 * @ies: data consisting of IEs
3692 * @len: length of data
3694 * Return: %NULL if the element ID could not be found or if
3695 * the element is invalid (claims to be longer than the given
3696 * data), or a pointer to the first byte of the requested
3697 * element, that is the byte containing the element ID.
3699 * Note: There are no checks on the element length other than
3700 * having to fit into the given data.
3702 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3705 * cfg80211_find_vendor_ie - find vendor specific information element in data
3708 * @oui_type: vendor-specific OUI type
3709 * @ies: data consisting of IEs
3710 * @len: length of data
3712 * Return: %NULL if the vendor specific element ID could not be found or if the
3713 * element is invalid (claims to be longer than the given data), or a pointer to
3714 * the first byte of the requested element, that is the byte containing the
3717 * Note: There are no checks on the element length other than having to fit into
3720 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3721 const u8 *ies, int len);
3724 * DOC: Regulatory enforcement infrastructure
3730 * regulatory_hint - driver hint to the wireless core a regulatory domain
3731 * @wiphy: the wireless device giving the hint (used only for reporting
3733 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3734 * should be in. If @rd is set this should be NULL. Note that if you
3735 * set this to NULL you should still set rd->alpha2 to some accepted
3738 * Wireless drivers can use this function to hint to the wireless core
3739 * what it believes should be the current regulatory domain by
3740 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3741 * domain should be in or by providing a completely build regulatory domain.
3742 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3743 * for a regulatory domain structure for the respective country.
3745 * The wiphy must have been registered to cfg80211 prior to this call.
3746 * For cfg80211 drivers this means you must first use wiphy_register(),
3747 * for mac80211 drivers you must first use ieee80211_register_hw().
3749 * Drivers should check the return value, its possible you can get
3752 * Return: 0 on success. -ENOMEM.
3754 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3757 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
3758 * @wiphy: the wireless device we want to process the regulatory domain on
3759 * @rd: the regulatory domain informatoin to use for this wiphy
3761 * Set the regulatory domain information for self-managed wiphys, only they
3762 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
3765 * Return: 0 on success. -EINVAL, -EPERM
3767 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
3768 struct ieee80211_regdomain *rd);
3771 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3772 * @wiphy: the wireless device we want to process the regulatory domain on
3773 * @regd: the custom regulatory domain to use for this wiphy
3775 * Drivers can sometimes have custom regulatory domains which do not apply
3776 * to a specific country. Drivers can use this to apply such custom regulatory
3777 * domains. This routine must be called prior to wiphy registration. The
3778 * custom regulatory domain will be trusted completely and as such previous
3779 * default channel settings will be disregarded. If no rule is found for a
3780 * channel on the regulatory domain the channel will be disabled.
3781 * Drivers using this for a wiphy should also set the wiphy flag
3782 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
3783 * that called this helper.
3785 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
3786 const struct ieee80211_regdomain *regd);
3789 * freq_reg_info - get regulatory information for the given frequency
3790 * @wiphy: the wiphy for which we want to process this rule for
3791 * @center_freq: Frequency in KHz for which we want regulatory information for
3793 * Use this function to get the regulatory rule for a specific frequency on
3794 * a given wireless device. If the device has a specific regulatory domain
3795 * it wants to follow we respect that unless a country IE has been received
3796 * and processed already.
3798 * Return: A valid pointer, or, when an error occurs, for example if no rule
3799 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3800 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3801 * value will be -ERANGE if we determine the given center_freq does not even
3802 * have a regulatory rule for a frequency range in the center_freq's band.
3803 * See freq_in_rule_band() for our current definition of a band -- this is
3804 * purely subjective and right now it's 802.11 specific.
3806 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3810 * reg_initiator_name - map regulatory request initiator enum to name
3811 * @initiator: the regulatory request initiator
3813 * You can use this to map the regulatory request initiator enum to a
3814 * proper string representation.
3816 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
3819 * callbacks for asynchronous cfg80211 methods, notification
3820 * functions and BSS handling helpers
3824 * cfg80211_scan_done - notify that scan finished
3826 * @request: the corresponding scan request
3827 * @aborted: set to true if the scan was aborted for any reason,
3828 * userspace will be notified of that
3830 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3833 * cfg80211_sched_scan_results - notify that new scan results are available
3835 * @wiphy: the wiphy which got scheduled scan results
3837 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3840 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3842 * @wiphy: the wiphy on which the scheduled scan stopped
3844 * The driver can call this function to inform cfg80211 that the
3845 * scheduled scan had to be stopped, for whatever reason. The driver
3846 * is then called back via the sched_scan_stop operation when done.
3848 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3851 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
3853 * @wiphy: the wiphy on which the scheduled scan stopped
3855 * The driver can call this function to inform cfg80211 that the
3856 * scheduled scan had to be stopped, for whatever reason. The driver
3857 * is then called back via the sched_scan_stop operation when done.
3858 * This function should be called with rtnl locked.
3860 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
3863 * cfg80211_inform_bss_width_frame - inform cfg80211 of a received BSS frame
3865 * @wiphy: the wiphy reporting the BSS
3866 * @rx_channel: The channel the frame was received on
3867 * @scan_width: width of the control channel
3868 * @mgmt: the management frame (probe response or beacon)
3869 * @len: length of the management frame
3870 * @signal: the signal strength, type depends on the wiphy's signal_type
3871 * @gfp: context flags
3873 * This informs cfg80211 that BSS information was found and
3874 * the BSS should be updated/added.
3876 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3877 * Or %NULL on error.
3879 struct cfg80211_bss * __must_check
3880 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
3881 struct ieee80211_channel *rx_channel,
3882 enum nl80211_bss_scan_width scan_width,
3883 struct ieee80211_mgmt *mgmt, size_t len,
3884 s32 signal, gfp_t gfp);
3886 static inline struct cfg80211_bss * __must_check
3887 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3888 struct ieee80211_channel *rx_channel,
3889 struct ieee80211_mgmt *mgmt, size_t len,
3890 s32 signal, gfp_t gfp)
3892 return cfg80211_inform_bss_width_frame(wiphy, rx_channel,
3893 NL80211_BSS_CHAN_WIDTH_20,
3894 mgmt, len, signal, gfp);
3898 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
3899 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
3900 * from a beacon or probe response
3901 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
3902 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
3904 enum cfg80211_bss_frame_type {
3905 CFG80211_BSS_FTYPE_UNKNOWN,
3906 CFG80211_BSS_FTYPE_BEACON,
3907 CFG80211_BSS_FTYPE_PRESP,
3911 * cfg80211_inform_bss_width - inform cfg80211 of a new BSS
3913 * @wiphy: the wiphy reporting the BSS
3914 * @rx_channel: The channel the frame was received on
3915 * @scan_width: width of the control channel
3916 * @ftype: frame type (if known)
3917 * @bssid: the BSSID of the BSS
3918 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3919 * @capability: the capability field sent by the peer
3920 * @beacon_interval: the beacon interval announced by the peer
3921 * @ie: additional IEs sent by the peer
3922 * @ielen: length of the additional IEs
3923 * @signal: the signal strength, type depends on the wiphy's signal_type
3924 * @gfp: context flags
3926 * This informs cfg80211 that BSS information was found and
3927 * the BSS should be updated/added.
3929 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3930 * Or %NULL on error.
3932 struct cfg80211_bss * __must_check
3933 cfg80211_inform_bss_width(struct wiphy *wiphy,
3934 struct ieee80211_channel *rx_channel,
3935 enum nl80211_bss_scan_width scan_width,
3936 enum cfg80211_bss_frame_type ftype,
3937 const u8 *bssid, u64 tsf, u16 capability,
3938 u16 beacon_interval, const u8 *ie, size_t ielen,
3939 s32 signal, gfp_t gfp);
3941 static inline struct cfg80211_bss * __must_check
3942 cfg80211_inform_bss(struct wiphy *wiphy,
3943 struct ieee80211_channel *rx_channel,
3944 enum cfg80211_bss_frame_type ftype,
3945 const u8 *bssid, u64 tsf, u16 capability,
3946 u16 beacon_interval, const u8 *ie, size_t ielen,
3947 s32 signal, gfp_t gfp)
3949 return cfg80211_inform_bss_width(wiphy, rx_channel,
3950 NL80211_BSS_CHAN_WIDTH_20, ftype,
3951 bssid, tsf, capability,
3952 beacon_interval, ie, ielen, signal,
3956 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3957 struct ieee80211_channel *channel,
3959 const u8 *ssid, size_t ssid_len,
3960 u16 capa_mask, u16 capa_val);
3961 static inline struct cfg80211_bss *
3962 cfg80211_get_ibss(struct wiphy *wiphy,
3963 struct ieee80211_channel *channel,
3964 const u8 *ssid, size_t ssid_len)
3966 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3967 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3971 * cfg80211_ref_bss - reference BSS struct
3972 * @wiphy: the wiphy this BSS struct belongs to
3973 * @bss: the BSS struct to reference
3975 * Increments the refcount of the given BSS struct.
3977 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3980 * cfg80211_put_bss - unref BSS struct
3981 * @wiphy: the wiphy this BSS struct belongs to
3982 * @bss: the BSS struct
3984 * Decrements the refcount of the given BSS struct.
3986 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3989 * cfg80211_unlink_bss - unlink BSS from internal data structures
3991 * @bss: the bss to remove
3993 * This function removes the given BSS from the internal data structures
3994 * thereby making it no longer show up in scan results etc. Use this
3995 * function when you detect a BSS is gone. Normally BSSes will also time
3996 * out, so it is not necessary to use this function at all.
3998 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4000 static inline enum nl80211_bss_scan_width
4001 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4003 switch (chandef->width) {
4004 case NL80211_CHAN_WIDTH_5:
4005 return NL80211_BSS_CHAN_WIDTH_5;
4006 case NL80211_CHAN_WIDTH_10:
4007 return NL80211_BSS_CHAN_WIDTH_10;
4009 return NL80211_BSS_CHAN_WIDTH_20;
4014 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4015 * @dev: network device
4016 * @buf: authentication frame (header + body)
4017 * @len: length of the frame data
4019 * This function is called whenever an authentication, disassociation or
4020 * deauthentication frame has been received and processed in station mode.
4021 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4022 * call either this function or cfg80211_auth_timeout().
4023 * After being asked to associate via cfg80211_ops::assoc() the driver must
4024 * call either this function or cfg80211_auth_timeout().
4025 * While connected, the driver must calls this for received and processed
4026 * disassociation and deauthentication frames. If the frame couldn't be used
4027 * because it was unprotected, the driver must call the function
4028 * cfg80211_rx_unprot_mlme_mgmt() instead.
4030 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4032 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4035 * cfg80211_auth_timeout - notification of timed out authentication
4036 * @dev: network device
4037 * @addr: The MAC address of the device with which the authentication timed out
4039 * This function may sleep. The caller must hold the corresponding wdev's
4042 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4045 * cfg80211_rx_assoc_resp - notification of processed association response
4046 * @dev: network device
4047 * @bss: the BSS that association was requested with, ownership of the pointer
4048 * moves to cfg80211 in this call
4049 * @buf: authentication frame (header + body)
4050 * @len: length of the frame data
4051 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
4053 * After being asked to associate via cfg80211_ops::assoc() the driver must
4054 * call either this function or cfg80211_auth_timeout().
4056 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4058 void cfg80211_rx_assoc_resp(struct net_device *dev,
4059 struct cfg80211_bss *bss,
4060 const u8 *buf, size_t len,
4064 * cfg80211_assoc_timeout - notification of timed out association
4065 * @dev: network device
4066 * @bss: The BSS entry with which association timed out.
4068 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4070 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4073 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4074 * @dev: network device
4075 * @buf: 802.11 frame (header + body)
4076 * @len: length of the frame data
4078 * This function is called whenever deauthentication has been processed in
4079 * station mode. This includes both received deauthentication frames and
4080 * locally generated ones. This function may sleep. The caller must hold the
4081 * corresponding wdev's mutex.
4083 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4086 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4087 * @dev: network device
4088 * @buf: deauthentication frame (header + body)
4089 * @len: length of the frame data
4091 * This function is called whenever a received deauthentication or dissassoc
4092 * frame has been dropped in station mode because of MFP being used but the
4093 * frame was not protected. This function may sleep.
4095 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4096 const u8 *buf, size_t len);
4099 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4100 * @dev: network device
4101 * @addr: The source MAC address of the frame
4102 * @key_type: The key type that the received frame used
4103 * @key_id: Key identifier (0..3). Can be -1 if missing.
4104 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4105 * @gfp: allocation flags
4107 * This function is called whenever the local MAC detects a MIC failure in a
4108 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4111 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4112 enum nl80211_key_type key_type, int key_id,
4113 const u8 *tsc, gfp_t gfp);
4116 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4118 * @dev: network device
4119 * @bssid: the BSSID of the IBSS joined
4120 * @channel: the channel of the IBSS joined
4121 * @gfp: allocation flags
4123 * This function notifies cfg80211 that the device joined an IBSS or
4124 * switched to a different BSSID. Before this function can be called,
4125 * either a beacon has to have been received from the IBSS, or one of
4126 * the cfg80211_inform_bss{,_frame} functions must have been called
4127 * with the locally generated beacon -- this guarantees that there is
4128 * always a scan result for this IBSS. cfg80211 will handle the rest.
4130 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4131 struct ieee80211_channel *channel, gfp_t gfp);
4134 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4136 * @dev: network device
4137 * @macaddr: the MAC address of the new candidate
4138 * @ie: information elements advertised by the peer candidate
4139 * @ie_len: lenght of the information elements buffer
4140 * @gfp: allocation flags
4142 * This function notifies cfg80211 that the mesh peer candidate has been
4143 * detected, most likely via a beacon or, less likely, via a probe response.
4144 * cfg80211 then sends a notification to userspace.
4146 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4147 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4150 * DOC: RFkill integration
4152 * RFkill integration in cfg80211 is almost invisible to drivers,
4153 * as cfg80211 automatically registers an rfkill instance for each
4154 * wireless device it knows about. Soft kill is also translated
4155 * into disconnecting and turning all interfaces off, drivers are
4156 * expected to turn off the device when all interfaces are down.
4158 * However, devices may have a hard RFkill line, in which case they
4159 * also need to interact with the rfkill subsystem, via cfg80211.
4160 * They can do this with a few helper functions documented here.
4164 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4166 * @blocked: block status
4168 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4171 * wiphy_rfkill_start_polling - start polling rfkill
4174 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4177 * wiphy_rfkill_stop_polling - stop polling rfkill
4180 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4183 * DOC: Vendor commands
4185 * Occasionally, there are special protocol or firmware features that
4186 * can't be implemented very openly. For this and similar cases, the
4187 * vendor command functionality allows implementing the features with
4188 * (typically closed-source) userspace and firmware, using nl80211 as
4189 * the configuration mechanism.
4191 * A driver supporting vendor commands must register them as an array
4192 * in struct wiphy, with handlers for each one, each command has an
4193 * OUI and sub command ID to identify it.
4195 * Note that this feature should not be (ab)used to implement protocol
4196 * features that could openly be shared across drivers. In particular,
4197 * it must never be required to use vendor commands to implement any
4198 * "normal" functionality that higher-level userspace like connection
4199 * managers etc. need.
4202 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4203 enum nl80211_commands cmd,
4204 enum nl80211_attrs attr,
4207 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4208 enum nl80211_commands cmd,
4209 enum nl80211_attrs attr,
4210 int vendor_event_idx,
4211 int approxlen, gfp_t gfp);
4213 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4216 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4218 * @approxlen: an upper bound of the length of the data that will
4219 * be put into the skb
4221 * This function allocates and pre-fills an skb for a reply to
4222 * a vendor command. Since it is intended for a reply, calling
4223 * it outside of a vendor command's doit() operation is invalid.
4225 * The returned skb is pre-filled with some identifying data in
4226 * a way that any data that is put into the skb (with skb_put(),
4227 * nla_put() or similar) will end up being within the
4228 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4229 * with the skb is adding data for the corresponding userspace tool
4230 * which can then read that data out of the vendor data attribute.
4231 * You must not modify the skb in any other way.
4233 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4234 * its error code as the result of the doit() operation.
4236 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4238 static inline struct sk_buff *
4239 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4241 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4242 NL80211_ATTR_VENDOR_DATA, approxlen);
4246 * cfg80211_vendor_cmd_reply - send the reply skb
4247 * @skb: The skb, must have been allocated with
4248 * cfg80211_vendor_cmd_alloc_reply_skb()
4250 * Since calling this function will usually be the last thing
4251 * before returning from the vendor command doit() you should
4252 * return the error code. Note that this function consumes the
4253 * skb regardless of the return value.
4255 * Return: An error code or 0 on success.
4257 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4260 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4262 * @event_idx: index of the vendor event in the wiphy's vendor_events
4263 * @approxlen: an upper bound of the length of the data that will
4264 * be put into the skb
4265 * @gfp: allocation flags
4267 * This function allocates and pre-fills an skb for an event on the
4268 * vendor-specific multicast group.
4270 * When done filling the skb, call cfg80211_vendor_event() with the
4271 * skb to send the event.
4273 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4275 static inline struct sk_buff *
4276 cfg80211_vendor_event_alloc(struct wiphy *wiphy, int approxlen,
4277 int event_idx, gfp_t gfp)
4279 return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_VENDOR,
4280 NL80211_ATTR_VENDOR_DATA,
4281 event_idx, approxlen, gfp);
4285 * cfg80211_vendor_event - send the event
4286 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4287 * @gfp: allocation flags
4289 * This function sends the given @skb, which must have been allocated
4290 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4292 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4294 __cfg80211_send_event_skb(skb, gfp);
4297 #ifdef CONFIG_NL80211_TESTMODE
4301 * Test mode is a set of utility functions to allow drivers to
4302 * interact with driver-specific tools to aid, for instance,
4303 * factory programming.
4305 * This chapter describes how drivers interact with it, for more
4306 * information see the nl80211 book's chapter on it.
4310 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4312 * @approxlen: an upper bound of the length of the data that will
4313 * be put into the skb
4315 * This function allocates and pre-fills an skb for a reply to
4316 * the testmode command. Since it is intended for a reply, calling
4317 * it outside of the @testmode_cmd operation is invalid.
4319 * The returned skb is pre-filled with the wiphy index and set up in
4320 * a way that any data that is put into the skb (with skb_put(),
4321 * nla_put() or similar) will end up being within the
4322 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4323 * with the skb is adding data for the corresponding userspace tool
4324 * which can then read that data out of the testdata attribute. You
4325 * must not modify the skb in any other way.
4327 * When done, call cfg80211_testmode_reply() with the skb and return
4328 * its error code as the result of the @testmode_cmd operation.
4330 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4332 static inline struct sk_buff *
4333 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4335 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4336 NL80211_ATTR_TESTDATA, approxlen);
4340 * cfg80211_testmode_reply - send the reply skb
4341 * @skb: The skb, must have been allocated with
4342 * cfg80211_testmode_alloc_reply_skb()
4344 * Since calling this function will usually be the last thing
4345 * before returning from the @testmode_cmd you should return
4346 * the error code. Note that this function consumes the skb
4347 * regardless of the return value.
4349 * Return: An error code or 0 on success.
4351 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4353 return cfg80211_vendor_cmd_reply(skb);
4357 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4359 * @approxlen: an upper bound of the length of the data that will
4360 * be put into the skb
4361 * @gfp: allocation flags
4363 * This function allocates and pre-fills an skb for an event on the
4364 * testmode multicast group.
4366 * The returned skb is set up in the same way as with
4367 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4368 * there, you should simply add data to it that will then end up in the
4369 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4372 * When done filling the skb, call cfg80211_testmode_event() with the
4373 * skb to send the event.
4375 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4377 static inline struct sk_buff *
4378 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4380 return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_TESTMODE,
4381 NL80211_ATTR_TESTDATA, -1,
4386 * cfg80211_testmode_event - send the event
4387 * @skb: The skb, must have been allocated with
4388 * cfg80211_testmode_alloc_event_skb()
4389 * @gfp: allocation flags
4391 * This function sends the given @skb, which must have been allocated
4392 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4395 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4397 __cfg80211_send_event_skb(skb, gfp);
4400 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
4401 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
4403 #define CFG80211_TESTMODE_CMD(cmd)
4404 #define CFG80211_TESTMODE_DUMP(cmd)
4408 * cfg80211_connect_result - notify cfg80211 of connection result
4410 * @dev: network device
4411 * @bssid: the BSSID of the AP
4412 * @req_ie: association request IEs (maybe be %NULL)
4413 * @req_ie_len: association request IEs length
4414 * @resp_ie: association response IEs (may be %NULL)
4415 * @resp_ie_len: assoc response IEs length
4416 * @status: status code, 0 for successful connection, use
4417 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4418 * the real status code for failures.
4419 * @gfp: allocation flags
4421 * It should be called by the underlying driver whenever connect() has
4424 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4425 const u8 *req_ie, size_t req_ie_len,
4426 const u8 *resp_ie, size_t resp_ie_len,
4427 u16 status, gfp_t gfp);
4430 * cfg80211_roamed - notify cfg80211 of roaming
4432 * @dev: network device
4433 * @channel: the channel of the new AP
4434 * @bssid: the BSSID of the new AP
4435 * @req_ie: association request IEs (maybe be %NULL)
4436 * @req_ie_len: association request IEs length
4437 * @resp_ie: association response IEs (may be %NULL)
4438 * @resp_ie_len: assoc response IEs length
4439 * @gfp: allocation flags
4441 * It should be called by the underlying driver whenever it roamed
4442 * from one AP to another while connected.
4444 void cfg80211_roamed(struct net_device *dev,
4445 struct ieee80211_channel *channel,
4447 const u8 *req_ie, size_t req_ie_len,
4448 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4451 * cfg80211_roamed_bss - notify cfg80211 of roaming
4453 * @dev: network device
4454 * @bss: entry of bss to which STA got roamed
4455 * @req_ie: association request IEs (maybe be %NULL)
4456 * @req_ie_len: association request IEs length
4457 * @resp_ie: association response IEs (may be %NULL)
4458 * @resp_ie_len: assoc response IEs length
4459 * @gfp: allocation flags
4461 * This is just a wrapper to notify cfg80211 of roaming event with driver
4462 * passing bss to avoid a race in timeout of the bss entry. It should be
4463 * called by the underlying driver whenever it roamed from one AP to another
4464 * while connected. Drivers which have roaming implemented in firmware
4465 * may use this function to avoid a race in bss entry timeout where the bss
4466 * entry of the new AP is seen in the driver, but gets timed out by the time
4467 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4468 * rdev->event_work. In case of any failures, the reference is released
4469 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4470 * it will be released while diconneting from the current bss.
4472 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4473 const u8 *req_ie, size_t req_ie_len,
4474 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4477 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4479 * @dev: network device
4480 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4481 * @ie_len: length of IEs
4482 * @reason: reason code for the disconnection, set it to 0 if unknown
4483 * @gfp: allocation flags
4485 * After it calls this function, the driver should enter an idle state
4486 * and not try to connect to any AP any more.
4488 void cfg80211_disconnected(struct net_device *dev, u16 reason,
4489 const u8 *ie, size_t ie_len, gfp_t gfp);
4492 * cfg80211_ready_on_channel - notification of remain_on_channel start
4493 * @wdev: wireless device
4494 * @cookie: the request cookie
4495 * @chan: The current channel (from remain_on_channel request)
4496 * @duration: Duration in milliseconds that the driver intents to remain on the
4498 * @gfp: allocation flags
4500 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4501 struct ieee80211_channel *chan,
4502 unsigned int duration, gfp_t gfp);
4505 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4506 * @wdev: wireless device
4507 * @cookie: the request cookie
4508 * @chan: The current channel (from remain_on_channel request)
4509 * @gfp: allocation flags
4511 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4512 struct ieee80211_channel *chan,
4517 * cfg80211_new_sta - notify userspace about station
4520 * @mac_addr: the station's address
4521 * @sinfo: the station information
4522 * @gfp: allocation flags
4524 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4525 struct station_info *sinfo, gfp_t gfp);
4528 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
4530 * @mac_addr: the station's address
4531 * @sinfo: the station information/statistics
4532 * @gfp: allocation flags
4534 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
4535 struct station_info *sinfo, gfp_t gfp);
4538 * cfg80211_del_sta - notify userspace about deletion of a station
4541 * @mac_addr: the station's address
4542 * @gfp: allocation flags
4544 static inline void cfg80211_del_sta(struct net_device *dev,
4545 const u8 *mac_addr, gfp_t gfp)
4547 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
4551 * cfg80211_conn_failed - connection request failed notification
4554 * @mac_addr: the station's address
4555 * @reason: the reason for connection failure
4556 * @gfp: allocation flags
4558 * Whenever a station tries to connect to an AP and if the station
4559 * could not connect to the AP as the AP has rejected the connection
4560 * for some reasons, this function is called.
4562 * The reason for connection failure can be any of the value from
4563 * nl80211_connect_failed_reason enum
4565 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4566 enum nl80211_connect_failed_reason reason,
4570 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4571 * @wdev: wireless device receiving the frame
4572 * @freq: Frequency on which the frame was received in MHz
4573 * @sig_dbm: signal strength in mBm, or 0 if unknown
4574 * @buf: Management frame (header + body)
4575 * @len: length of the frame data
4576 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4578 * This function is called whenever an Action frame is received for a station
4579 * mode interface, but is not processed in kernel.
4581 * Return: %true if a user space application has registered for this frame.
4582 * For action frames, that makes it responsible for rejecting unrecognized
4583 * action frames; %false otherwise, in which case for action frames the
4584 * driver is responsible for rejecting the frame.
4586 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4587 const u8 *buf, size_t len, u32 flags);
4590 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4591 * @wdev: wireless device receiving the frame
4592 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4593 * @buf: Management frame (header + body)
4594 * @len: length of the frame data
4595 * @ack: Whether frame was acknowledged
4596 * @gfp: context flags
4598 * This function is called whenever a management frame was requested to be
4599 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4600 * transmission attempt.
4602 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4603 const u8 *buf, size_t len, bool ack, gfp_t gfp);
4607 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4608 * @dev: network device
4609 * @rssi_event: the triggered RSSI event
4610 * @gfp: context flags
4612 * This function is called when a configured connection quality monitoring
4613 * rssi threshold reached event occurs.
4615 void cfg80211_cqm_rssi_notify(struct net_device *dev,
4616 enum nl80211_cqm_rssi_threshold_event rssi_event,
4620 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4621 * @dev: network device
4622 * @peer: peer's MAC address
4623 * @num_packets: how many packets were lost -- should be a fixed threshold
4624 * but probably no less than maybe 50, or maybe a throughput dependent
4625 * threshold (to account for temporary interference)
4626 * @gfp: context flags
4628 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4629 const u8 *peer, u32 num_packets, gfp_t gfp);
4632 * cfg80211_cqm_txe_notify - TX error rate event
4633 * @dev: network device
4634 * @peer: peer's MAC address
4635 * @num_packets: how many packets were lost
4636 * @rate: % of packets which failed transmission
4637 * @intvl: interval (in s) over which the TX failure threshold was breached.
4638 * @gfp: context flags
4640 * Notify userspace when configured % TX failures over number of packets in a
4641 * given interval is exceeded.
4643 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4644 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4647 * cfg80211_cqm_beacon_loss_notify - beacon loss event
4648 * @dev: network device
4649 * @gfp: context flags
4651 * Notify userspace about beacon loss from the connected AP.
4653 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
4656 * cfg80211_radar_event - radar detection event
4658 * @chandef: chandef for the current channel
4659 * @gfp: context flags
4661 * This function is called when a radar is detected on the current chanenl.
4663 void cfg80211_radar_event(struct wiphy *wiphy,
4664 struct cfg80211_chan_def *chandef, gfp_t gfp);
4667 * cfg80211_cac_event - Channel availability check (CAC) event
4668 * @netdev: network device
4669 * @chandef: chandef for the current channel
4670 * @event: type of event
4671 * @gfp: context flags
4673 * This function is called when a Channel availability check (CAC) is finished
4674 * or aborted. This must be called to notify the completion of a CAC process,
4675 * also by full-MAC drivers.
4677 void cfg80211_cac_event(struct net_device *netdev,
4678 const struct cfg80211_chan_def *chandef,
4679 enum nl80211_radar_event event, gfp_t gfp);
4683 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4684 * @dev: network device
4685 * @bssid: BSSID of AP (to avoid races)
4686 * @replay_ctr: new replay counter
4687 * @gfp: allocation flags
4689 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4690 const u8 *replay_ctr, gfp_t gfp);
4693 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4694 * @dev: network device
4695 * @index: candidate index (the smaller the index, the higher the priority)
4696 * @bssid: BSSID of AP
4697 * @preauth: Whether AP advertises support for RSN pre-authentication
4698 * @gfp: allocation flags
4700 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4701 const u8 *bssid, bool preauth, gfp_t gfp);
4704 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4705 * @dev: The device the frame matched to
4706 * @addr: the transmitter address
4707 * @gfp: context flags
4709 * This function is used in AP mode (only!) to inform userspace that
4710 * a spurious class 3 frame was received, to be able to deauth the
4712 * Return: %true if the frame was passed to userspace (or this failed
4713 * for a reason other than not having a subscription.)
4715 bool cfg80211_rx_spurious_frame(struct net_device *dev,
4716 const u8 *addr, gfp_t gfp);
4719 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4720 * @dev: The device the frame matched to
4721 * @addr: the transmitter address
4722 * @gfp: context flags
4724 * This function is used in AP mode (only!) to inform userspace that
4725 * an associated station sent a 4addr frame but that wasn't expected.
4726 * It is allowed and desirable to send this event only once for each
4727 * station to avoid event flooding.
4728 * Return: %true if the frame was passed to userspace (or this failed
4729 * for a reason other than not having a subscription.)
4731 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4732 const u8 *addr, gfp_t gfp);
4735 * cfg80211_probe_status - notify userspace about probe status
4736 * @dev: the device the probe was sent on
4737 * @addr: the address of the peer
4738 * @cookie: the cookie filled in @probe_client previously
4739 * @acked: indicates whether probe was acked or not
4740 * @gfp: allocation flags
4742 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4743 u64 cookie, bool acked, gfp_t gfp);
4746 * cfg80211_report_obss_beacon - report beacon from other APs
4747 * @wiphy: The wiphy that received the beacon
4749 * @len: length of the frame
4750 * @freq: frequency the frame was received on
4751 * @sig_dbm: signal strength in mBm, or 0 if unknown
4753 * Use this function to report to userspace when a beacon was
4754 * received. It is not useful to call this when there is no
4755 * netdev that is in AP/GO mode.
4757 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4758 const u8 *frame, size_t len,
4759 int freq, int sig_dbm);
4762 * cfg80211_reg_can_beacon - check if beaconing is allowed
4764 * @chandef: the channel definition
4765 * @iftype: interface type
4767 * Return: %true if there is no secondary channel or the secondary channel(s)
4768 * can be used for beaconing (i.e. is not a radar channel etc.)
4770 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4771 struct cfg80211_chan_def *chandef,
4772 enum nl80211_iftype iftype);
4775 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
4776 * @dev: the device which switched channels
4777 * @chandef: the new channel definition
4779 * Caller must acquire wdev_lock, therefore must only be called from sleepable
4782 void cfg80211_ch_switch_notify(struct net_device *dev,
4783 struct cfg80211_chan_def *chandef);
4786 * cfg80211_ch_switch_started_notify - notify channel switch start
4787 * @dev: the device on which the channel switch started
4788 * @chandef: the future channel definition
4789 * @count: the number of TBTTs until the channel switch happens
4791 * Inform the userspace about the channel switch that has just
4792 * started, so that it can take appropriate actions (eg. starting
4793 * channel switch on other vifs), if necessary.
4795 void cfg80211_ch_switch_started_notify(struct net_device *dev,
4796 struct cfg80211_chan_def *chandef,
4800 * ieee80211_operating_class_to_band - convert operating class to band
4802 * @operating_class: the operating class to convert
4803 * @band: band pointer to fill
4805 * Returns %true if the conversion was successful, %false otherwise.
4807 bool ieee80211_operating_class_to_band(u8 operating_class,
4808 enum ieee80211_band *band);
4811 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
4812 * @dev: the device on which the operation is requested
4813 * @peer: the MAC address of the peer device
4814 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
4815 * NL80211_TDLS_TEARDOWN)
4816 * @reason_code: the reason code for teardown request
4817 * @gfp: allocation flags
4819 * This function is used to request userspace to perform TDLS operation that
4820 * requires knowledge of keys, i.e., link setup or teardown when the AP
4821 * connection uses encryption. This is optional mechanism for the driver to use
4822 * if it can automatically determine when a TDLS link could be useful (e.g.,
4823 * based on traffic and signal strength for a peer).
4825 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
4826 enum nl80211_tdls_operation oper,
4827 u16 reason_code, gfp_t gfp);
4830 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
4831 * @rate: given rate_info to calculate bitrate from
4833 * return 0 if MCS index >= 32
4835 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
4838 * cfg80211_unregister_wdev - remove the given wdev
4839 * @wdev: struct wireless_dev to remove
4841 * Call this function only for wdevs that have no netdev assigned,
4842 * e.g. P2P Devices. It removes the device from the list so that
4843 * it can no longer be used. It is necessary to call this function
4844 * even when cfg80211 requests the removal of the interface by
4845 * calling the del_virtual_intf() callback. The function must also
4846 * be called when the driver wishes to unregister the wdev, e.g.
4847 * when the device is unbound from the driver.
4849 * Requires the RTNL to be held.
4851 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
4854 * struct cfg80211_ft_event - FT Information Elements
4856 * @ies_len: length of the FT IE in bytes
4857 * @target_ap: target AP's MAC address
4859 * @ric_ies_len: length of the RIC IE in bytes
4861 struct cfg80211_ft_event_params {
4864 const u8 *target_ap;
4870 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
4871 * @netdev: network device
4872 * @ft_event: IE information
4874 void cfg80211_ft_event(struct net_device *netdev,
4875 struct cfg80211_ft_event_params *ft_event);
4878 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
4879 * @ies: the input IE buffer
4880 * @len: the input length
4881 * @attr: the attribute ID to find
4882 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
4883 * if the function is only called to get the needed buffer size
4884 * @bufsize: size of the output buffer
4886 * The function finds a given P2P attribute in the (vendor) IEs and
4887 * copies its contents to the given buffer.
4889 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
4890 * malformed or the attribute can't be found (respectively), or the
4891 * length of the found attribute (which can be zero).
4893 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
4894 enum ieee80211_p2p_attr_id attr,
4895 u8 *buf, unsigned int bufsize);
4898 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
4899 * @wdev: the wireless device reporting the wakeup
4900 * @wakeup: the wakeup report
4901 * @gfp: allocation flags
4903 * This function reports that the given device woke up. If it
4904 * caused the wakeup, report the reason(s), otherwise you may
4905 * pass %NULL as the @wakeup parameter to advertise that something
4906 * else caused the wakeup.
4908 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
4909 struct cfg80211_wowlan_wakeup *wakeup,
4913 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
4915 * @wdev: the wireless device for which critical protocol is stopped.
4916 * @gfp: allocation flags
4918 * This function can be called by the driver to indicate it has reverted
4919 * operation back to normal. One reason could be that the duration given
4920 * by .crit_proto_start() has expired.
4922 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
4925 * ieee80211_get_num_supported_channels - get number of channels device has
4928 * Return: the number of channels supported by the device.
4930 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
4933 * cfg80211_check_combinations - check interface combinations
4936 * @num_different_channels: the number of different channels we want
4937 * to use for verification
4938 * @radar_detect: a bitmap where each bit corresponds to a channel
4939 * width where radar detection is needed, as in the definition of
4940 * &struct ieee80211_iface_combination.@radar_detect_widths
4941 * @iftype_num: array with the numbers of interfaces of each interface
4942 * type. The index is the interface type as specified in &enum
4945 * This function can be called by the driver to check whether a
4946 * combination of interfaces and their types are allowed according to
4947 * the interface combinations.
4949 int cfg80211_check_combinations(struct wiphy *wiphy,
4950 const int num_different_channels,
4951 const u8 radar_detect,
4952 const int iftype_num[NUM_NL80211_IFTYPES]);
4955 * cfg80211_iter_combinations - iterate over matching combinations
4958 * @num_different_channels: the number of different channels we want
4959 * to use for verification
4960 * @radar_detect: a bitmap where each bit corresponds to a channel
4961 * width where radar detection is needed, as in the definition of
4962 * &struct ieee80211_iface_combination.@radar_detect_widths
4963 * @iftype_num: array with the numbers of interfaces of each interface
4964 * type. The index is the interface type as specified in &enum
4966 * @iter: function to call for each matching combination
4967 * @data: pointer to pass to iter function
4969 * This function can be called by the driver to check what possible
4970 * combinations it fits in at a given moment, e.g. for channel switching
4973 int cfg80211_iter_combinations(struct wiphy *wiphy,
4974 const int num_different_channels,
4975 const u8 radar_detect,
4976 const int iftype_num[NUM_NL80211_IFTYPES],
4977 void (*iter)(const struct ieee80211_iface_combination *c,
4982 * cfg80211_stop_iface - trigger interface disconnection
4985 * @wdev: wireless device
4986 * @gfp: context flags
4988 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
4991 * Note: This doesn't need any locks and is asynchronous.
4993 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
4997 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
4998 * @wiphy: the wiphy to shut down
5000 * This function shuts down all interfaces belonging to this wiphy by
5001 * calling dev_close() (and treating non-netdev interfaces as needed).
5002 * It shouldn't really be used unless there are some fatal device errors
5003 * that really can't be recovered in any other way.
5005 * Callers must hold the RTNL and be able to deal with callbacks into
5006 * the driver while the function is running.
5008 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5011 * wiphy_ext_feature_set - set the extended feature flag
5013 * @wiphy: the wiphy to modify.
5014 * @ftidx: extended feature bit index.
5016 * The extended features are flagged in multiple bytes (see
5017 * &struct wiphy.@ext_features)
5019 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
5020 enum nl80211_ext_feature_index ftidx)
5024 ft_byte = &wiphy->ext_features[ftidx / 8];
5025 *ft_byte |= BIT(ftidx % 8);
5029 * wiphy_ext_feature_isset - check the extended feature flag
5031 * @wiphy: the wiphy to modify.
5032 * @ftidx: extended feature bit index.
5034 * The extended features are flagged in multiple bytes (see
5035 * &struct wiphy.@ext_features)
5038 wiphy_ext_feature_isset(struct wiphy *wiphy,
5039 enum nl80211_ext_feature_index ftidx)
5043 ft_byte = wiphy->ext_features[ftidx / 8];
5044 return (ft_byte & BIT(ftidx % 8)) != 0;
5047 /* ethtool helper */
5048 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5050 /* Logging, debugging and troubleshooting/diagnostic helpers. */
5052 /* wiphy_printk helpers, similar to dev_printk */
5054 #define wiphy_printk(level, wiphy, format, args...) \
5055 dev_printk(level, &(wiphy)->dev, format, ##args)
5056 #define wiphy_emerg(wiphy, format, args...) \
5057 dev_emerg(&(wiphy)->dev, format, ##args)
5058 #define wiphy_alert(wiphy, format, args...) \
5059 dev_alert(&(wiphy)->dev, format, ##args)
5060 #define wiphy_crit(wiphy, format, args...) \
5061 dev_crit(&(wiphy)->dev, format, ##args)
5062 #define wiphy_err(wiphy, format, args...) \
5063 dev_err(&(wiphy)->dev, format, ##args)
5064 #define wiphy_warn(wiphy, format, args...) \
5065 dev_warn(&(wiphy)->dev, format, ##args)
5066 #define wiphy_notice(wiphy, format, args...) \
5067 dev_notice(&(wiphy)->dev, format, ##args)
5068 #define wiphy_info(wiphy, format, args...) \
5069 dev_info(&(wiphy)->dev, format, ##args)
5071 #define wiphy_debug(wiphy, format, args...) \
5072 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5074 #define wiphy_dbg(wiphy, format, args...) \
5075 dev_dbg(&(wiphy)->dev, format, ##args)
5077 #if defined(VERBOSE_DEBUG)
5078 #define wiphy_vdbg wiphy_dbg
5080 #define wiphy_vdbg(wiphy, format, args...) \
5083 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
5089 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5090 * of using a WARN/WARN_ON to get the message out, including the
5091 * file/line information and a backtrace.
5093 #define wiphy_WARN(wiphy, format, args...) \
5094 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5096 #endif /* __NET_CFG80211_H */