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. This will only
323 * be used for non-netdevice interfaces. If this parameter is set
324 * to zero address the driver may determine the address as needed.
328 u8 macaddr[ETH_ALEN];
332 * struct key_params - key information
334 * Information about a key
337 * @key_len: length of key material
338 * @cipher: cipher suite selector
339 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
340 * with the get_key() callback, must be in little endian,
341 * length given by @seq_len.
342 * @seq_len: length of @seq.
353 * struct cfg80211_chan_def - channel definition
354 * @chan: the (control) channel
355 * @width: channel width
356 * @center_freq1: center frequency of first segment
357 * @center_freq2: center frequency of second segment
358 * (only with 80+80 MHz)
360 struct cfg80211_chan_def {
361 struct ieee80211_channel *chan;
362 enum nl80211_chan_width width;
368 * cfg80211_get_chandef_type - return old channel type from chandef
369 * @chandef: the channel definition
371 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
372 * chandef, which must have a bandwidth allowing this conversion.
374 static inline enum nl80211_channel_type
375 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
377 switch (chandef->width) {
378 case NL80211_CHAN_WIDTH_20_NOHT:
379 return NL80211_CHAN_NO_HT;
380 case NL80211_CHAN_WIDTH_20:
381 return NL80211_CHAN_HT20;
382 case NL80211_CHAN_WIDTH_40:
383 if (chandef->center_freq1 > chandef->chan->center_freq)
384 return NL80211_CHAN_HT40PLUS;
385 return NL80211_CHAN_HT40MINUS;
388 return NL80211_CHAN_NO_HT;
393 * cfg80211_chandef_create - create channel definition using channel type
394 * @chandef: the channel definition struct to fill
395 * @channel: the control channel
396 * @chantype: the channel type
398 * Given a channel type, create a channel definition.
400 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
401 struct ieee80211_channel *channel,
402 enum nl80211_channel_type chantype);
405 * cfg80211_chandef_identical - check if two channel definitions are identical
406 * @chandef1: first channel definition
407 * @chandef2: second channel definition
409 * Return: %true if the channels defined by the channel definitions are
410 * identical, %false otherwise.
413 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
414 const struct cfg80211_chan_def *chandef2)
416 return (chandef1->chan == chandef2->chan &&
417 chandef1->width == chandef2->width &&
418 chandef1->center_freq1 == chandef2->center_freq1 &&
419 chandef1->center_freq2 == chandef2->center_freq2);
423 * cfg80211_chandef_compatible - check if two channel definitions are compatible
424 * @chandef1: first channel definition
425 * @chandef2: second channel definition
427 * Return: %NULL if the given channel definitions are incompatible,
428 * chandef1 or chandef2 otherwise.
430 const struct cfg80211_chan_def *
431 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
432 const struct cfg80211_chan_def *chandef2);
435 * cfg80211_chandef_valid - check if a channel definition is valid
436 * @chandef: the channel definition to check
437 * Return: %true if the channel definition is valid. %false otherwise.
439 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
442 * cfg80211_chandef_usable - check if secondary channels can be used
443 * @wiphy: the wiphy to validate against
444 * @chandef: the channel definition to check
445 * @prohibited_flags: the regulatory channel flags that must not be set
446 * Return: %true if secondary channels are usable. %false otherwise.
448 bool cfg80211_chandef_usable(struct wiphy *wiphy,
449 const struct cfg80211_chan_def *chandef,
450 u32 prohibited_flags);
453 * cfg80211_chandef_dfs_required - checks if radar detection is required
454 * @wiphy: the wiphy to validate against
455 * @chandef: the channel definition to check
456 * @iftype: the interface type as specified in &enum nl80211_iftype
458 * 1 if radar detection is required, 0 if it is not, < 0 on error
460 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
461 const struct cfg80211_chan_def *chandef,
462 enum nl80211_iftype iftype);
465 * ieee80211_chandef_rate_flags - returns rate flags for a channel
467 * In some channel types, not all rates may be used - for example CCK
468 * rates may not be used in 5/10 MHz channels.
470 * @chandef: channel definition for the channel
472 * Returns: rate flags which apply for this channel
474 static inline enum ieee80211_rate_flags
475 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
477 switch (chandef->width) {
478 case NL80211_CHAN_WIDTH_5:
479 return IEEE80211_RATE_SUPPORTS_5MHZ;
480 case NL80211_CHAN_WIDTH_10:
481 return IEEE80211_RATE_SUPPORTS_10MHZ;
489 * ieee80211_chandef_max_power - maximum transmission power for the chandef
491 * In some regulations, the transmit power may depend on the configured channel
492 * bandwidth which may be defined as dBm/MHz. This function returns the actual
493 * max_power for non-standard (20 MHz) channels.
495 * @chandef: channel definition for the channel
497 * Returns: maximum allowed transmission power in dBm for the chandef
500 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
502 switch (chandef->width) {
503 case NL80211_CHAN_WIDTH_5:
504 return min(chandef->chan->max_reg_power - 6,
505 chandef->chan->max_power);
506 case NL80211_CHAN_WIDTH_10:
507 return min(chandef->chan->max_reg_power - 3,
508 chandef->chan->max_power);
512 return chandef->chan->max_power;
516 * enum survey_info_flags - survey information flags
518 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
519 * @SURVEY_INFO_IN_USE: channel is currently being used
520 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
521 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
522 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
523 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
524 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
526 * Used by the driver to indicate which info in &struct survey_info
527 * it has filled in during the get_survey().
529 enum survey_info_flags {
530 SURVEY_INFO_NOISE_DBM = 1<<0,
531 SURVEY_INFO_IN_USE = 1<<1,
532 SURVEY_INFO_CHANNEL_TIME = 1<<2,
533 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
534 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
535 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
536 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
540 * struct survey_info - channel survey response
542 * @channel: the channel this survey record reports, mandatory
543 * @filled: bitflag of flags from &enum survey_info_flags
544 * @noise: channel noise in dBm. This and all following fields are
546 * @channel_time: amount of time in ms the radio spent on the channel
547 * @channel_time_busy: amount of time the primary channel was sensed busy
548 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
549 * @channel_time_rx: amount of time the radio spent receiving data
550 * @channel_time_tx: amount of time the radio spent transmitting data
552 * Used by dump_survey() to report back per-channel survey information.
554 * This structure can later be expanded with things like
555 * channel duty cycle etc.
558 struct ieee80211_channel *channel;
560 u64 channel_time_busy;
561 u64 channel_time_ext_busy;
569 * struct cfg80211_crypto_settings - Crypto settings
570 * @wpa_versions: indicates which, if any, WPA versions are enabled
571 * (from enum nl80211_wpa_versions)
572 * @cipher_group: group key cipher suite (or 0 if unset)
573 * @n_ciphers_pairwise: number of AP supported unicast ciphers
574 * @ciphers_pairwise: unicast key cipher suites
575 * @n_akm_suites: number of AKM suites
576 * @akm_suites: AKM suites
577 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
578 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
579 * required to assume that the port is unauthorized until authorized by
580 * user space. Otherwise, port is marked authorized by default.
581 * @control_port_ethertype: the control port protocol that should be
582 * allowed through even on unauthorized ports
583 * @control_port_no_encrypt: TRUE to prevent encryption of control port
586 struct cfg80211_crypto_settings {
589 int n_ciphers_pairwise;
590 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
592 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
594 __be16 control_port_ethertype;
595 bool control_port_no_encrypt;
599 * struct cfg80211_beacon_data - beacon data
600 * @head: head portion of beacon (before TIM IE)
601 * or %NULL if not changed
602 * @tail: tail portion of beacon (after TIM IE)
603 * or %NULL if not changed
604 * @head_len: length of @head
605 * @tail_len: length of @tail
606 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
607 * @beacon_ies_len: length of beacon_ies in octets
608 * @proberesp_ies: extra information element(s) to add into Probe Response
610 * @proberesp_ies_len: length of proberesp_ies in octets
611 * @assocresp_ies: extra information element(s) to add into (Re)Association
612 * Response frames or %NULL
613 * @assocresp_ies_len: length of assocresp_ies in octets
614 * @probe_resp_len: length of probe response template (@probe_resp)
615 * @probe_resp: probe response template (AP mode only)
617 struct cfg80211_beacon_data {
618 const u8 *head, *tail;
619 const u8 *beacon_ies;
620 const u8 *proberesp_ies;
621 const u8 *assocresp_ies;
622 const u8 *probe_resp;
624 size_t head_len, tail_len;
625 size_t beacon_ies_len;
626 size_t proberesp_ies_len;
627 size_t assocresp_ies_len;
628 size_t probe_resp_len;
636 * struct cfg80211_acl_data - Access control list data
638 * @acl_policy: ACL policy to be applied on the station's
639 * entry specified by mac_addr
640 * @n_acl_entries: Number of MAC address entries passed
641 * @mac_addrs: List of MAC addresses of stations to be used for ACL
643 struct cfg80211_acl_data {
644 enum nl80211_acl_policy acl_policy;
648 struct mac_address mac_addrs[];
652 * struct cfg80211_ap_settings - AP configuration
654 * Used to configure an AP interface.
656 * @chandef: defines the channel to use
657 * @beacon: beacon data
658 * @beacon_interval: beacon interval
659 * @dtim_period: DTIM period
660 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
662 * @ssid_len: length of @ssid
663 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
664 * @crypto: crypto settings
665 * @privacy: the BSS uses privacy
666 * @auth_type: Authentication type (algorithm)
667 * @inactivity_timeout: time in seconds to determine station's inactivity.
668 * @p2p_ctwindow: P2P CT Window
669 * @p2p_opp_ps: P2P opportunistic PS
670 * @acl: ACL configuration used by the drivers which has support for
671 * MAC address based access control
673 struct cfg80211_ap_settings {
674 struct cfg80211_chan_def chandef;
676 struct cfg80211_beacon_data beacon;
678 int beacon_interval, dtim_period;
681 enum nl80211_hidden_ssid hidden_ssid;
682 struct cfg80211_crypto_settings crypto;
684 enum nl80211_auth_type auth_type;
685 int inactivity_timeout;
688 const struct cfg80211_acl_data *acl;
692 * struct cfg80211_csa_settings - channel switch settings
694 * Used for channel switch
696 * @chandef: defines the channel to use after the switch
697 * @beacon_csa: beacon data while performing the switch
698 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
699 * @counter_offsets_presp: offsets of the counters within the probe response
700 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
701 * @n_counter_offsets_presp: number of csa counters in the probe response
702 * @beacon_after: beacon data to be used on the new channel
703 * @radar_required: whether radar detection is required on the new channel
704 * @block_tx: whether transmissions should be blocked while changing
705 * @count: number of beacons until switch
707 struct cfg80211_csa_settings {
708 struct cfg80211_chan_def chandef;
709 struct cfg80211_beacon_data beacon_csa;
710 const u16 *counter_offsets_beacon;
711 const u16 *counter_offsets_presp;
712 unsigned int n_counter_offsets_beacon;
713 unsigned int n_counter_offsets_presp;
714 struct cfg80211_beacon_data beacon_after;
721 * enum station_parameters_apply_mask - station parameter values to apply
722 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
723 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
724 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
726 * Not all station parameters have in-band "no change" signalling,
727 * for those that don't these flags will are used.
729 enum station_parameters_apply_mask {
730 STATION_PARAM_APPLY_UAPSD = BIT(0),
731 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
732 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
736 * struct station_parameters - station parameters
738 * Used to change and create a new station.
740 * @vlan: vlan interface station should belong to
741 * @supported_rates: supported rates in IEEE 802.11 format
742 * (or NULL for no change)
743 * @supported_rates_len: number of supported rates
744 * @sta_flags_mask: station flags that changed
745 * (bitmask of BIT(NL80211_STA_FLAG_...))
746 * @sta_flags_set: station flags values
747 * (bitmask of BIT(NL80211_STA_FLAG_...))
748 * @listen_interval: listen interval or -1 for no change
749 * @aid: AID or zero for no change
750 * @plink_action: plink action to take
751 * @plink_state: set the peer link state for a station
752 * @ht_capa: HT capabilities of station
753 * @vht_capa: VHT capabilities of station
754 * @uapsd_queues: bitmap of queues configured for uapsd. same format
755 * as the AC bitmap in the QoS info field
756 * @max_sp: max Service Period. same format as the MAX_SP in the
757 * QoS info field (but already shifted down)
758 * @sta_modify_mask: bitmap indicating which parameters changed
759 * (for those that don't have a natural "no change" value),
760 * see &enum station_parameters_apply_mask
761 * @local_pm: local link-specific mesh power save mode (no change when set
763 * @capability: station capability
764 * @ext_capab: extended capabilities of the station
765 * @ext_capab_len: number of extended capabilities
766 * @supported_channels: supported channels in IEEE 802.11 format
767 * @supported_channels_len: number of supported channels
768 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
769 * @supported_oper_classes_len: number of supported operating classes
770 * @opmode_notif: operating mode field from Operating Mode Notification
771 * @opmode_notif_used: information if operating mode field is used
773 struct station_parameters {
774 const u8 *supported_rates;
775 struct net_device *vlan;
776 u32 sta_flags_mask, sta_flags_set;
780 u8 supported_rates_len;
783 const struct ieee80211_ht_cap *ht_capa;
784 const struct ieee80211_vht_cap *vht_capa;
787 enum nl80211_mesh_power_mode local_pm;
791 const u8 *supported_channels;
792 u8 supported_channels_len;
793 const u8 *supported_oper_classes;
794 u8 supported_oper_classes_len;
796 bool opmode_notif_used;
800 * enum cfg80211_station_type - the type of station being modified
801 * @CFG80211_STA_AP_CLIENT: client of an AP interface
802 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
803 * the AP MLME in the device
804 * @CFG80211_STA_AP_STA: AP station on managed interface
805 * @CFG80211_STA_IBSS: IBSS station
806 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
807 * while TDLS setup is in progress, it moves out of this state when
808 * being marked authorized; use this only if TDLS with external setup is
810 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
811 * entry that is operating, has been marked authorized by userspace)
812 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
813 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
815 enum cfg80211_station_type {
816 CFG80211_STA_AP_CLIENT,
817 CFG80211_STA_AP_MLME_CLIENT,
820 CFG80211_STA_TDLS_PEER_SETUP,
821 CFG80211_STA_TDLS_PEER_ACTIVE,
822 CFG80211_STA_MESH_PEER_KERNEL,
823 CFG80211_STA_MESH_PEER_USER,
827 * cfg80211_check_station_change - validate parameter changes
828 * @wiphy: the wiphy this operates on
829 * @params: the new parameters for a station
830 * @statype: the type of station being modified
832 * Utility function for the @change_station driver method. Call this function
833 * with the appropriate station type looking up the station (and checking that
834 * it exists). It will verify whether the station change is acceptable, and if
835 * not will return an error code. Note that it may modify the parameters for
836 * backward compatibility reasons, so don't use them before calling this.
838 int cfg80211_check_station_change(struct wiphy *wiphy,
839 struct station_parameters *params,
840 enum cfg80211_station_type statype);
843 * enum station_info_flags - station information flags
845 * Used by the driver to indicate which info in &struct station_info
846 * it has filled in during get_station() or dump_station().
848 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
849 * @STATION_INFO_RX_BYTES: @rx_bytes filled
850 * @STATION_INFO_TX_BYTES: @tx_bytes filled
851 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
852 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
853 * @STATION_INFO_LLID: @llid filled
854 * @STATION_INFO_PLID: @plid filled
855 * @STATION_INFO_PLINK_STATE: @plink_state filled
856 * @STATION_INFO_SIGNAL: @signal filled
857 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
858 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
859 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
860 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
861 * @STATION_INFO_TX_RETRIES: @tx_retries filled
862 * @STATION_INFO_TX_FAILED: @tx_failed filled
863 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
864 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
865 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
866 * @STATION_INFO_BSS_PARAM: @bss_param filled
867 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
868 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
869 * @STATION_INFO_STA_FLAGS: @sta_flags filled
870 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
871 * @STATION_INFO_T_OFFSET: @t_offset filled
872 * @STATION_INFO_LOCAL_PM: @local_pm filled
873 * @STATION_INFO_PEER_PM: @peer_pm filled
874 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
875 * @STATION_INFO_CHAIN_SIGNAL: @chain_signal filled
876 * @STATION_INFO_CHAIN_SIGNAL_AVG: @chain_signal_avg filled
877 * @STATION_INFO_EXPECTED_THROUGHPUT: @expected_throughput filled
879 enum station_info_flags {
880 STATION_INFO_INACTIVE_TIME = BIT(0),
881 STATION_INFO_RX_BYTES = BIT(1),
882 STATION_INFO_TX_BYTES = BIT(2),
883 STATION_INFO_LLID = BIT(3),
884 STATION_INFO_PLID = BIT(4),
885 STATION_INFO_PLINK_STATE = BIT(5),
886 STATION_INFO_SIGNAL = BIT(6),
887 STATION_INFO_TX_BITRATE = BIT(7),
888 STATION_INFO_RX_PACKETS = BIT(8),
889 STATION_INFO_TX_PACKETS = BIT(9),
890 STATION_INFO_TX_RETRIES = BIT(10),
891 STATION_INFO_TX_FAILED = BIT(11),
892 STATION_INFO_RX_DROP_MISC = BIT(12),
893 STATION_INFO_SIGNAL_AVG = BIT(13),
894 STATION_INFO_RX_BITRATE = BIT(14),
895 STATION_INFO_BSS_PARAM = BIT(15),
896 STATION_INFO_CONNECTED_TIME = BIT(16),
897 STATION_INFO_ASSOC_REQ_IES = BIT(17),
898 STATION_INFO_STA_FLAGS = BIT(18),
899 STATION_INFO_BEACON_LOSS_COUNT = BIT(19),
900 STATION_INFO_T_OFFSET = BIT(20),
901 STATION_INFO_LOCAL_PM = BIT(21),
902 STATION_INFO_PEER_PM = BIT(22),
903 STATION_INFO_NONPEER_PM = BIT(23),
904 STATION_INFO_RX_BYTES64 = BIT(24),
905 STATION_INFO_TX_BYTES64 = BIT(25),
906 STATION_INFO_CHAIN_SIGNAL = BIT(26),
907 STATION_INFO_CHAIN_SIGNAL_AVG = BIT(27),
908 STATION_INFO_EXPECTED_THROUGHPUT = BIT(28),
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 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
918 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
919 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
920 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
921 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
922 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
923 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
924 * @RATE_INFO_FLAGS_60G: 60GHz MCS
926 enum rate_info_flags {
927 RATE_INFO_FLAGS_MCS = BIT(0),
928 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
929 RATE_INFO_FLAGS_40_MHZ_WIDTH = BIT(2),
930 RATE_INFO_FLAGS_80_MHZ_WIDTH = BIT(3),
931 RATE_INFO_FLAGS_80P80_MHZ_WIDTH = BIT(4),
932 RATE_INFO_FLAGS_160_MHZ_WIDTH = BIT(5),
933 RATE_INFO_FLAGS_SHORT_GI = BIT(6),
934 RATE_INFO_FLAGS_60G = BIT(7),
938 * struct rate_info - bitrate information
940 * Information about a receiving or transmitting bitrate
942 * @flags: bitflag of flags from &enum rate_info_flags
943 * @mcs: mcs index if struct describes a 802.11n bitrate
944 * @legacy: bitrate in 100kbit/s for 802.11abg
945 * @nss: number of streams (VHT only)
955 * enum station_info_rate_flags - bitrate info flags
957 * Used by the driver to indicate the specific rate transmission
958 * type for 802.11n transmissions.
960 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
961 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
962 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
964 enum bss_param_flags {
965 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
966 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
967 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
971 * struct sta_bss_parameters - BSS parameters for the attached station
973 * Information about the currently associated BSS
975 * @flags: bitflag of flags from &enum bss_param_flags
976 * @dtim_period: DTIM period for the BSS
977 * @beacon_interval: beacon interval
979 struct sta_bss_parameters {
985 #define IEEE80211_MAX_CHAINS 4
988 * struct station_info - station information
990 * Station information filled by driver for get_station() and dump_station.
992 * @filled: bitflag of flags from &enum station_info_flags
993 * @connected_time: time(in secs) since a station is last connected
994 * @inactive_time: time since last station activity (tx/rx) in milliseconds
995 * @rx_bytes: bytes received from this station
996 * @tx_bytes: bytes transmitted to this station
997 * @llid: mesh local link id
998 * @plid: mesh peer link id
999 * @plink_state: mesh peer link state
1000 * @signal: The signal strength, type depends on the wiphy's signal_type.
1001 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1002 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1003 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1004 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1005 * @chain_signal: per-chain signal strength of last received packet in dBm
1006 * @chain_signal_avg: per-chain signal strength average in dBm
1007 * @txrate: current unicast bitrate from this station
1008 * @rxrate: current unicast bitrate to this station
1009 * @rx_packets: packets received from this station
1010 * @tx_packets: packets transmitted to this station
1011 * @tx_retries: cumulative retry counts
1012 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
1013 * @rx_dropped_misc: Dropped for un-specified reason.
1014 * @bss_param: current BSS parameters
1015 * @generation: generation number for nl80211 dumps.
1016 * This number should increase every time the list of stations
1017 * changes, i.e. when a station is added or removed, so that
1018 * userspace can tell whether it got a consistent snapshot.
1019 * @assoc_req_ies: IEs from (Re)Association Request.
1020 * This is used only when in AP mode with drivers that do not use
1021 * user space MLME/SME implementation. The information is provided for
1022 * the cfg80211_new_sta() calls to notify user space of the IEs.
1023 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1024 * @sta_flags: station flags mask & values
1025 * @beacon_loss_count: Number of times beacon loss event has triggered.
1026 * @t_offset: Time offset of the station relative to this host.
1027 * @local_pm: local mesh STA power save mode
1028 * @peer_pm: peer mesh STA power save mode
1029 * @nonpeer_pm: non-peer mesh STA power save mode
1030 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1031 * towards this station.
1033 struct station_info {
1046 s8 chain_signal[IEEE80211_MAX_CHAINS];
1047 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1049 struct rate_info txrate;
1050 struct rate_info rxrate;
1055 u32 rx_dropped_misc;
1056 struct sta_bss_parameters bss_param;
1057 struct nl80211_sta_flag_update sta_flags;
1061 const u8 *assoc_req_ies;
1062 size_t assoc_req_ies_len;
1064 u32 beacon_loss_count;
1066 enum nl80211_mesh_power_mode local_pm;
1067 enum nl80211_mesh_power_mode peer_pm;
1068 enum nl80211_mesh_power_mode nonpeer_pm;
1070 u32 expected_throughput;
1073 * Note: Add a new enum station_info_flags value for each new field and
1074 * use it to check which fields are initialized.
1079 * cfg80211_get_station - retrieve information about a given station
1080 * @dev: the device where the station is supposed to be connected to
1081 * @mac_addr: the mac address of the station of interest
1082 * @sinfo: pointer to the structure to fill with the information
1084 * Returns 0 on success and sinfo is filled with the available information
1085 * otherwise returns a negative error code and the content of sinfo has to be
1086 * considered undefined.
1088 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1089 struct station_info *sinfo);
1092 * enum monitor_flags - monitor flags
1094 * Monitor interface configuration flags. Note that these must be the bits
1095 * according to the nl80211 flags.
1097 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1098 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1099 * @MONITOR_FLAG_CONTROL: pass control frames
1100 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1101 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1102 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1104 enum monitor_flags {
1105 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1106 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1107 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1108 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1109 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1110 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1114 * enum mpath_info_flags - mesh path information flags
1116 * Used by the driver to indicate which info in &struct mpath_info it has filled
1117 * in during get_station() or dump_station().
1119 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1120 * @MPATH_INFO_SN: @sn filled
1121 * @MPATH_INFO_METRIC: @metric filled
1122 * @MPATH_INFO_EXPTIME: @exptime filled
1123 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1124 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1125 * @MPATH_INFO_FLAGS: @flags filled
1127 enum mpath_info_flags {
1128 MPATH_INFO_FRAME_QLEN = BIT(0),
1129 MPATH_INFO_SN = BIT(1),
1130 MPATH_INFO_METRIC = BIT(2),
1131 MPATH_INFO_EXPTIME = BIT(3),
1132 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1133 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1134 MPATH_INFO_FLAGS = BIT(6),
1138 * struct mpath_info - mesh path information
1140 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1142 * @filled: bitfield of flags from &enum mpath_info_flags
1143 * @frame_qlen: number of queued frames for this destination
1144 * @sn: target sequence number
1145 * @metric: metric (cost) of this mesh path
1146 * @exptime: expiration time for the mesh path from now, in msecs
1147 * @flags: mesh path flags
1148 * @discovery_timeout: total mesh path discovery timeout, in msecs
1149 * @discovery_retries: mesh path discovery retries
1150 * @generation: generation number for nl80211 dumps.
1151 * This number should increase every time the list of mesh paths
1152 * changes, i.e. when a station is added or removed, so that
1153 * userspace can tell whether it got a consistent snapshot.
1161 u32 discovery_timeout;
1162 u8 discovery_retries;
1169 * struct bss_parameters - BSS parameters
1171 * Used to change BSS parameters (mainly for AP mode).
1173 * @use_cts_prot: Whether to use CTS protection
1174 * (0 = no, 1 = yes, -1 = do not change)
1175 * @use_short_preamble: Whether the use of short preambles is allowed
1176 * (0 = no, 1 = yes, -1 = do not change)
1177 * @use_short_slot_time: Whether the use of short slot time is allowed
1178 * (0 = no, 1 = yes, -1 = do not change)
1179 * @basic_rates: basic rates in IEEE 802.11 format
1180 * (or NULL for no change)
1181 * @basic_rates_len: number of basic rates
1182 * @ap_isolate: do not forward packets between connected stations
1183 * @ht_opmode: HT Operation mode
1184 * (u16 = opmode, -1 = do not change)
1185 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1186 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1188 struct bss_parameters {
1190 int use_short_preamble;
1191 int use_short_slot_time;
1192 const u8 *basic_rates;
1196 s8 p2p_ctwindow, p2p_opp_ps;
1200 * struct mesh_config - 802.11s mesh configuration
1202 * These parameters can be changed while the mesh is active.
1204 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1205 * by the Mesh Peering Open message
1206 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1207 * used by the Mesh Peering Open message
1208 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1209 * the mesh peering management to close a mesh peering
1210 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1212 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1213 * be sent to establish a new peer link instance in a mesh
1214 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1215 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1217 * @auto_open_plinks: whether we should automatically open peer links when we
1218 * detect compatible mesh peers
1219 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1220 * synchronize to for 11s default synchronization method
1221 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1222 * that an originator mesh STA can send to a particular path target
1223 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1224 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1225 * a path discovery in milliseconds
1226 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1227 * receiving a PREQ shall consider the forwarding information from the
1228 * root to be valid. (TU = time unit)
1229 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1230 * which a mesh STA can send only one action frame containing a PREQ
1232 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1233 * which a mesh STA can send only one Action frame containing a PERR
1235 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1236 * it takes for an HWMP information element to propagate across the mesh
1237 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1238 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1239 * announcements are transmitted
1240 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1241 * station has access to a broader network beyond the MBSS. (This is
1242 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1243 * only means that the station will announce others it's a mesh gate, but
1244 * not necessarily using the gate announcement protocol. Still keeping the
1245 * same nomenclature to be in sync with the spec)
1246 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1247 * entity (default is TRUE - forwarding entity)
1248 * @rssi_threshold: the threshold for average signal strength of candidate
1249 * station to establish a peer link
1250 * @ht_opmode: mesh HT protection mode
1252 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1253 * receiving a proactive PREQ shall consider the forwarding information to
1254 * the root mesh STA to be valid.
1256 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1257 * PREQs are transmitted.
1258 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1259 * during which a mesh STA can send only one Action frame containing
1260 * a PREQ element for root path confirmation.
1261 * @power_mode: The default mesh power save mode which will be the initial
1262 * setting for new peer links.
1263 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1264 * after transmitting its beacon.
1265 * @plink_timeout: If no tx activity is seen from a STA we've established
1266 * peering with for longer than this time (in seconds), then remove it
1267 * from the STA's list of peers. Default is 30 minutes.
1269 struct mesh_config {
1270 u16 dot11MeshRetryTimeout;
1271 u16 dot11MeshConfirmTimeout;
1272 u16 dot11MeshHoldingTimeout;
1273 u16 dot11MeshMaxPeerLinks;
1274 u8 dot11MeshMaxRetries;
1277 bool auto_open_plinks;
1278 u32 dot11MeshNbrOffsetMaxNeighbor;
1279 u8 dot11MeshHWMPmaxPREQretries;
1280 u32 path_refresh_time;
1281 u16 min_discovery_timeout;
1282 u32 dot11MeshHWMPactivePathTimeout;
1283 u16 dot11MeshHWMPpreqMinInterval;
1284 u16 dot11MeshHWMPperrMinInterval;
1285 u16 dot11MeshHWMPnetDiameterTraversalTime;
1286 u8 dot11MeshHWMPRootMode;
1287 u16 dot11MeshHWMPRannInterval;
1288 bool dot11MeshGateAnnouncementProtocol;
1289 bool dot11MeshForwarding;
1292 u32 dot11MeshHWMPactivePathToRootTimeout;
1293 u16 dot11MeshHWMProotInterval;
1294 u16 dot11MeshHWMPconfirmationInterval;
1295 enum nl80211_mesh_power_mode power_mode;
1296 u16 dot11MeshAwakeWindowDuration;
1301 * struct mesh_setup - 802.11s mesh setup configuration
1302 * @chandef: defines the channel to use
1303 * @mesh_id: the mesh ID
1304 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1305 * @sync_method: which synchronization method to use
1306 * @path_sel_proto: which path selection protocol to use
1307 * @path_metric: which metric to use
1308 * @auth_id: which authentication method this mesh is using
1309 * @ie: vendor information elements (optional)
1310 * @ie_len: length of vendor information elements
1311 * @is_authenticated: this mesh requires authentication
1312 * @is_secure: this mesh uses security
1313 * @user_mpm: userspace handles all MPM functions
1314 * @dtim_period: DTIM period to use
1315 * @beacon_interval: beacon interval to use
1316 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1317 * @basic_rates: basic rates to use when creating the mesh
1319 * These parameters are fixed when the mesh is created.
1322 struct cfg80211_chan_def chandef;
1331 bool is_authenticated;
1335 u16 beacon_interval;
1336 int mcast_rate[IEEE80211_NUM_BANDS];
1341 * struct ieee80211_txq_params - TX queue parameters
1342 * @ac: AC identifier
1343 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1344 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1346 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1348 * @aifs: Arbitration interframe space [0..255]
1350 struct ieee80211_txq_params {
1359 * DOC: Scanning and BSS list handling
1361 * The scanning process itself is fairly simple, but cfg80211 offers quite
1362 * a bit of helper functionality. To start a scan, the scan operation will
1363 * be invoked with a scan definition. This scan definition contains the
1364 * channels to scan, and the SSIDs to send probe requests for (including the
1365 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1366 * probe. Additionally, a scan request may contain extra information elements
1367 * that should be added to the probe request. The IEs are guaranteed to be
1368 * well-formed, and will not exceed the maximum length the driver advertised
1369 * in the wiphy structure.
1371 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1372 * it is responsible for maintaining the BSS list; the driver should not
1373 * maintain a list itself. For this notification, various functions exist.
1375 * Since drivers do not maintain a BSS list, there are also a number of
1376 * functions to search for a BSS and obtain information about it from the
1377 * BSS structure cfg80211 maintains. The BSS list is also made available
1382 * struct cfg80211_ssid - SSID description
1384 * @ssid_len: length of the ssid
1386 struct cfg80211_ssid {
1387 u8 ssid[IEEE80211_MAX_SSID_LEN];
1392 * struct cfg80211_scan_request - scan request description
1394 * @ssids: SSIDs to scan for (active scan only)
1395 * @n_ssids: number of SSIDs
1396 * @channels: channels to scan on.
1397 * @n_channels: total number of channels to scan
1398 * @scan_width: channel width for scanning
1399 * @ie: optional information element(s) to add into Probe Request or %NULL
1400 * @ie_len: length of ie in octets
1401 * @flags: bit field of flags controlling operation
1402 * @rates: bitmap of rates to advertise for each band
1403 * @wiphy: the wiphy this was for
1404 * @scan_start: time (in jiffies) when the scan started
1405 * @wdev: the wireless device to scan for
1406 * @aborted: (internal) scan request was notified as aborted
1407 * @notified: (internal) scan request was notified as done or aborted
1408 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1410 struct cfg80211_scan_request {
1411 struct cfg80211_ssid *ssids;
1414 enum nl80211_bss_scan_width scan_width;
1419 u32 rates[IEEE80211_NUM_BANDS];
1421 struct wireless_dev *wdev;
1424 struct wiphy *wiphy;
1425 unsigned long scan_start;
1426 bool aborted, notified;
1430 struct ieee80211_channel *channels[0];
1434 * struct cfg80211_match_set - sets of attributes to match
1436 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1437 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1439 struct cfg80211_match_set {
1440 struct cfg80211_ssid ssid;
1445 * struct cfg80211_sched_scan_request - scheduled scan request description
1447 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1448 * @n_ssids: number of SSIDs
1449 * @n_channels: total number of channels to scan
1450 * @scan_width: channel width for scanning
1451 * @interval: interval between each scheduled scan cycle
1452 * @ie: optional information element(s) to add into Probe Request or %NULL
1453 * @ie_len: length of ie in octets
1454 * @flags: bit field of flags controlling operation
1455 * @match_sets: sets of parameters to be matched for a scan result
1456 * entry to be considered valid and to be passed to the host
1457 * (others are filtered out).
1458 * If ommited, all results are passed.
1459 * @n_match_sets: number of match sets
1460 * @wiphy: the wiphy this was for
1461 * @dev: the interface
1462 * @scan_start: start time of the scheduled scan
1463 * @channels: channels to scan
1464 * @min_rssi_thold: for drivers only supporting a single threshold, this
1465 * contains the minimum over all matchsets
1467 struct cfg80211_sched_scan_request {
1468 struct cfg80211_ssid *ssids;
1471 enum nl80211_bss_scan_width scan_width;
1476 struct cfg80211_match_set *match_sets;
1481 struct wiphy *wiphy;
1482 struct net_device *dev;
1483 unsigned long scan_start;
1486 struct ieee80211_channel *channels[0];
1490 * enum cfg80211_signal_type - signal type
1492 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1493 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1494 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1496 enum cfg80211_signal_type {
1497 CFG80211_SIGNAL_TYPE_NONE,
1498 CFG80211_SIGNAL_TYPE_MBM,
1499 CFG80211_SIGNAL_TYPE_UNSPEC,
1503 * struct cfg80211_bss_ie_data - BSS entry IE data
1504 * @tsf: TSF contained in the frame that carried these IEs
1505 * @rcu_head: internal use, for freeing
1506 * @len: length of the IEs
1507 * @from_beacon: these IEs are known to come from a beacon
1510 struct cfg80211_bss_ies {
1512 struct rcu_head rcu_head;
1519 * struct cfg80211_bss - BSS description
1521 * This structure describes a BSS (which may also be a mesh network)
1522 * for use in scan results and similar.
1524 * @channel: channel this BSS is on
1525 * @scan_width: width of the control channel
1526 * @bssid: BSSID of the BSS
1527 * @beacon_interval: the beacon interval as from the frame
1528 * @capability: the capability field in host byte order
1529 * @ies: the information elements (Note that there is no guarantee that these
1530 * are well-formed!); this is a pointer to either the beacon_ies or
1531 * proberesp_ies depending on whether Probe Response frame has been
1532 * received. It is always non-%NULL.
1533 * @beacon_ies: the information elements from the last Beacon frame
1534 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1535 * own the beacon_ies, but they're just pointers to the ones from the
1536 * @hidden_beacon_bss struct)
1537 * @proberesp_ies: the information elements from the last Probe Response frame
1538 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1539 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1540 * that holds the beacon data. @beacon_ies is still valid, of course, and
1541 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1542 * @signal: signal strength value (type depends on the wiphy's signal_type)
1543 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1545 struct cfg80211_bss {
1546 struct ieee80211_channel *channel;
1547 enum nl80211_bss_scan_width scan_width;
1549 const struct cfg80211_bss_ies __rcu *ies;
1550 const struct cfg80211_bss_ies __rcu *beacon_ies;
1551 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1553 struct cfg80211_bss *hidden_beacon_bss;
1557 u16 beacon_interval;
1562 u8 priv[0] __aligned(sizeof(void *));
1566 * ieee80211_bss_get_ie - find IE with given ID
1567 * @bss: the bss to search
1570 * Note that the return value is an RCU-protected pointer, so
1571 * rcu_read_lock() must be held when calling this function.
1572 * Return: %NULL if not found.
1574 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1578 * struct cfg80211_auth_request - Authentication request data
1580 * This structure provides information needed to complete IEEE 802.11
1583 * @bss: The BSS to authenticate with, the callee must obtain a reference
1584 * to it if it needs to keep it.
1585 * @auth_type: Authentication type (algorithm)
1586 * @ie: Extra IEs to add to Authentication frame or %NULL
1587 * @ie_len: Length of ie buffer in octets
1588 * @key_len: length of WEP key for shared key authentication
1589 * @key_idx: index of WEP key for shared key authentication
1590 * @key: WEP key for shared key authentication
1591 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1592 * Authentication transaction sequence number field.
1593 * @sae_data_len: Length of sae_data buffer in octets
1595 struct cfg80211_auth_request {
1596 struct cfg80211_bss *bss;
1599 enum nl80211_auth_type auth_type;
1601 u8 key_len, key_idx;
1603 size_t sae_data_len;
1607 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1609 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1610 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1611 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1613 enum cfg80211_assoc_req_flags {
1614 ASSOC_REQ_DISABLE_HT = BIT(0),
1615 ASSOC_REQ_DISABLE_VHT = BIT(1),
1616 ASSOC_REQ_USE_RRM = BIT(2),
1620 * struct cfg80211_assoc_request - (Re)Association request data
1622 * This structure provides information needed to complete IEEE 802.11
1624 * @bss: The BSS to associate with. If the call is successful the driver is
1625 * given a reference that it must give back to cfg80211_send_rx_assoc()
1626 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1627 * association requests while already associating must be rejected.
1628 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1629 * @ie_len: Length of ie buffer in octets
1630 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1631 * @crypto: crypto settings
1632 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1633 * @flags: See &enum cfg80211_assoc_req_flags
1634 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1635 * will be used in ht_capa. Un-supported values will be ignored.
1636 * @ht_capa_mask: The bits of ht_capa which are to be used.
1637 * @vht_capa: VHT capability override
1638 * @vht_capa_mask: VHT capability mask indicating which fields to use
1640 struct cfg80211_assoc_request {
1641 struct cfg80211_bss *bss;
1642 const u8 *ie, *prev_bssid;
1644 struct cfg80211_crypto_settings crypto;
1647 struct ieee80211_ht_cap ht_capa;
1648 struct ieee80211_ht_cap ht_capa_mask;
1649 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1653 * struct cfg80211_deauth_request - Deauthentication request data
1655 * This structure provides information needed to complete IEEE 802.11
1658 * @bssid: the BSSID of the BSS to deauthenticate from
1659 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1660 * @ie_len: Length of ie buffer in octets
1661 * @reason_code: The reason code for the deauthentication
1662 * @local_state_change: if set, change local state only and
1663 * do not set a deauth frame
1665 struct cfg80211_deauth_request {
1670 bool local_state_change;
1674 * struct cfg80211_disassoc_request - Disassociation request data
1676 * This structure provides information needed to complete IEEE 802.11
1679 * @bss: the BSS to disassociate from
1680 * @ie: Extra IEs to add to Disassociation frame or %NULL
1681 * @ie_len: Length of ie buffer in octets
1682 * @reason_code: The reason code for the disassociation
1683 * @local_state_change: This is a request for a local state only, i.e., no
1684 * Disassociation frame is to be transmitted.
1686 struct cfg80211_disassoc_request {
1687 struct cfg80211_bss *bss;
1691 bool local_state_change;
1695 * struct cfg80211_ibss_params - IBSS parameters
1697 * This structure defines the IBSS parameters for the join_ibss()
1700 * @ssid: The SSID, will always be non-null.
1701 * @ssid_len: The length of the SSID, will always be non-zero.
1702 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1703 * search for IBSSs with a different BSSID.
1704 * @chandef: defines the channel to use if no other IBSS to join can be found
1705 * @channel_fixed: The channel should be fixed -- do not search for
1706 * IBSSs to join on other channels.
1707 * @ie: information element(s) to include in the beacon
1708 * @ie_len: length of that
1709 * @beacon_interval: beacon interval to use
1710 * @privacy: this is a protected network, keys will be configured
1712 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1713 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1714 * required to assume that the port is unauthorized until authorized by
1715 * user space. Otherwise, port is marked authorized by default.
1716 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1717 * changes the channel when a radar is detected. This is required
1718 * to operate on DFS channels.
1719 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1720 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1721 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1722 * will be used in ht_capa. Un-supported values will be ignored.
1723 * @ht_capa_mask: The bits of ht_capa which are to be used.
1725 struct cfg80211_ibss_params {
1728 struct cfg80211_chan_def chandef;
1730 u8 ssid_len, ie_len;
1731 u16 beacon_interval;
1736 bool userspace_handles_dfs;
1737 int mcast_rate[IEEE80211_NUM_BANDS];
1738 struct ieee80211_ht_cap ht_capa;
1739 struct ieee80211_ht_cap ht_capa_mask;
1743 * struct cfg80211_connect_params - Connection parameters
1745 * This structure provides information needed to complete IEEE 802.11
1746 * authentication and association.
1748 * @channel: The channel to use or %NULL if not specified (auto-select based
1750 * @channel_hint: The channel of the recommended BSS for initial connection or
1751 * %NULL if not specified
1752 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1754 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1755 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1756 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1759 * @ssid_len: Length of ssid in octets
1760 * @auth_type: Authentication type (algorithm)
1761 * @ie: IEs for association request
1762 * @ie_len: Length of assoc_ie in octets
1763 * @privacy: indicates whether privacy-enabled APs should be used
1764 * @mfp: indicate whether management frame protection is used
1765 * @crypto: crypto settings
1766 * @key_len: length of WEP key for shared key authentication
1767 * @key_idx: index of WEP key for shared key authentication
1768 * @key: WEP key for shared key authentication
1769 * @flags: See &enum cfg80211_assoc_req_flags
1770 * @bg_scan_period: Background scan period in seconds
1771 * or -1 to indicate that default value is to be used.
1772 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1773 * will be used in ht_capa. Un-supported values will be ignored.
1774 * @ht_capa_mask: The bits of ht_capa which are to be used.
1775 * @vht_capa: VHT Capability overrides
1776 * @vht_capa_mask: The bits of vht_capa which are to be used.
1778 struct cfg80211_connect_params {
1779 struct ieee80211_channel *channel;
1780 struct ieee80211_channel *channel_hint;
1782 const u8 *bssid_hint;
1785 enum nl80211_auth_type auth_type;
1789 enum nl80211_mfp mfp;
1790 struct cfg80211_crypto_settings crypto;
1792 u8 key_len, key_idx;
1795 struct ieee80211_ht_cap ht_capa;
1796 struct ieee80211_ht_cap ht_capa_mask;
1797 struct ieee80211_vht_cap vht_capa;
1798 struct ieee80211_vht_cap vht_capa_mask;
1802 * enum wiphy_params_flags - set_wiphy_params bitfield values
1803 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1804 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1805 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1806 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1807 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1808 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
1810 enum wiphy_params_flags {
1811 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1812 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1813 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1814 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1815 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1816 WIPHY_PARAM_DYN_ACK = 1 << 5,
1820 * cfg80211_bitrate_mask - masks for bitrate control
1822 struct cfg80211_bitrate_mask {
1825 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
1826 u16 vht_mcs[NL80211_VHT_NSS_MAX];
1827 enum nl80211_txrate_gi gi;
1828 } control[IEEE80211_NUM_BANDS];
1831 * struct cfg80211_pmksa - PMK Security Association
1833 * This structure is passed to the set/del_pmksa() method for PMKSA
1836 * @bssid: The AP's BSSID.
1837 * @pmkid: The PMK material itself.
1839 struct cfg80211_pmksa {
1845 * struct cfg80211_pkt_pattern - packet pattern
1846 * @mask: bitmask where to match pattern and where to ignore bytes,
1847 * one bit per byte, in same format as nl80211
1848 * @pattern: bytes to match where bitmask is 1
1849 * @pattern_len: length of pattern (in bytes)
1850 * @pkt_offset: packet offset (in bytes)
1852 * Internal note: @mask and @pattern are allocated in one chunk of
1853 * memory, free @mask only!
1855 struct cfg80211_pkt_pattern {
1856 const u8 *mask, *pattern;
1862 * struct cfg80211_wowlan_tcp - TCP connection parameters
1864 * @sock: (internal) socket for source port allocation
1865 * @src: source IP address
1866 * @dst: destination IP address
1867 * @dst_mac: destination MAC address
1868 * @src_port: source port
1869 * @dst_port: destination port
1870 * @payload_len: data payload length
1871 * @payload: data payload buffer
1872 * @payload_seq: payload sequence stamping configuration
1873 * @data_interval: interval at which to send data packets
1874 * @wake_len: wakeup payload match length
1875 * @wake_data: wakeup payload match data
1876 * @wake_mask: wakeup payload match mask
1877 * @tokens_size: length of the tokens buffer
1878 * @payload_tok: payload token usage configuration
1880 struct cfg80211_wowlan_tcp {
1881 struct socket *sock;
1883 u16 src_port, dst_port;
1884 u8 dst_mac[ETH_ALEN];
1887 struct nl80211_wowlan_tcp_data_seq payload_seq;
1890 const u8 *wake_data, *wake_mask;
1892 /* must be last, variable member */
1893 struct nl80211_wowlan_tcp_data_token payload_tok;
1897 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1899 * This structure defines the enabled WoWLAN triggers for the device.
1900 * @any: wake up on any activity -- special trigger if device continues
1901 * operating as normal during suspend
1902 * @disconnect: wake up if getting disconnected
1903 * @magic_pkt: wake up on receiving magic packet
1904 * @patterns: wake up on receiving packet matching a pattern
1905 * @n_patterns: number of patterns
1906 * @gtk_rekey_failure: wake up on GTK rekey failure
1907 * @eap_identity_req: wake up on EAP identity request packet
1908 * @four_way_handshake: wake up on 4-way handshake
1909 * @rfkill_release: wake up when rfkill is released
1910 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
1911 * NULL if not configured.
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;
1923 * struct cfg80211_coalesce_rules - Coalesce rule parameters
1925 * This structure defines coalesce rule for the device.
1926 * @delay: maximum coalescing delay in msecs.
1927 * @condition: condition for packet coalescence.
1928 * see &enum nl80211_coalesce_condition.
1929 * @patterns: array of packet patterns
1930 * @n_patterns: number of patterns
1932 struct cfg80211_coalesce_rules {
1934 enum nl80211_coalesce_condition condition;
1935 struct cfg80211_pkt_pattern *patterns;
1940 * struct cfg80211_coalesce - Packet coalescing settings
1942 * This structure defines coalescing settings.
1943 * @rules: array of coalesce rules
1944 * @n_rules: number of rules
1946 struct cfg80211_coalesce {
1947 struct cfg80211_coalesce_rules *rules;
1952 * struct cfg80211_wowlan_wakeup - wakeup report
1953 * @disconnect: woke up by getting disconnected
1954 * @magic_pkt: woke up by receiving magic packet
1955 * @gtk_rekey_failure: woke up by GTK rekey failure
1956 * @eap_identity_req: woke up by EAP identity request packet
1957 * @four_way_handshake: woke up by 4-way handshake
1958 * @rfkill_release: woke up by rfkill being released
1959 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
1960 * @packet_present_len: copied wakeup packet data
1961 * @packet_len: original wakeup packet length
1962 * @packet: The packet causing the wakeup, if any.
1963 * @packet_80211: For pattern match, magic packet and other data
1964 * frame triggers an 802.3 frame should be reported, for
1965 * disconnect due to deauth 802.11 frame. This indicates which
1967 * @tcp_match: TCP wakeup packet received
1968 * @tcp_connlost: TCP connection lost or failed to establish
1969 * @tcp_nomoretokens: TCP data ran out of tokens
1971 struct cfg80211_wowlan_wakeup {
1972 bool disconnect, magic_pkt, gtk_rekey_failure,
1973 eap_identity_req, four_way_handshake,
1974 rfkill_release, packet_80211,
1975 tcp_match, tcp_connlost, tcp_nomoretokens;
1977 u32 packet_present_len, packet_len;
1982 * struct cfg80211_gtk_rekey_data - rekey data
1983 * @kek: key encryption key (NL80211_KEK_LEN bytes)
1984 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
1985 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
1987 struct cfg80211_gtk_rekey_data {
1988 const u8 *kek, *kck, *replay_ctr;
1992 * struct cfg80211_update_ft_ies_params - FT IE Information
1994 * This structure provides information needed to update the fast transition IE
1996 * @md: The Mobility Domain ID, 2 Octet value
1997 * @ie: Fast Transition IEs
1998 * @ie_len: Length of ft_ie in octets
2000 struct cfg80211_update_ft_ies_params {
2007 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2009 * This structure provides information needed to transmit a mgmt frame
2011 * @chan: channel to use
2012 * @offchan: indicates wether off channel operation is required
2013 * @wait: duration for ROC
2014 * @buf: buffer to transmit
2015 * @len: buffer length
2016 * @no_cck: don't use cck rates for this frame
2017 * @dont_wait_for_ack: tells the low level not to wait for an ack
2018 * @n_csa_offsets: length of csa_offsets array
2019 * @csa_offsets: array of all the csa offsets in the frame
2021 struct cfg80211_mgmt_tx_params {
2022 struct ieee80211_channel *chan;
2028 bool dont_wait_for_ack;
2030 const u16 *csa_offsets;
2034 * struct cfg80211_dscp_exception - DSCP exception
2036 * @dscp: DSCP value that does not adhere to the user priority range definition
2037 * @up: user priority value to which the corresponding DSCP value belongs
2039 struct cfg80211_dscp_exception {
2045 * struct cfg80211_dscp_range - DSCP range definition for user priority
2047 * @low: lowest DSCP value of this user priority range, inclusive
2048 * @high: highest DSCP value of this user priority range, inclusive
2050 struct cfg80211_dscp_range {
2055 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2056 #define IEEE80211_QOS_MAP_MAX_EX 21
2057 #define IEEE80211_QOS_MAP_LEN_MIN 16
2058 #define IEEE80211_QOS_MAP_LEN_MAX \
2059 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2062 * struct cfg80211_qos_map - QoS Map Information
2064 * This struct defines the Interworking QoS map setting for DSCP values
2066 * @num_des: number of DSCP exceptions (0..21)
2067 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2068 * the user priority DSCP range definition
2069 * @up: DSCP range definition for a particular user priority
2071 struct cfg80211_qos_map {
2073 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2074 struct cfg80211_dscp_range up[8];
2078 * struct cfg80211_ops - backend description for wireless configuration
2080 * This struct is registered by fullmac card drivers and/or wireless stacks
2081 * in order to handle configuration requests on their interfaces.
2083 * All callbacks except where otherwise noted should return 0
2084 * on success or a negative error code.
2086 * All operations are currently invoked under rtnl for consistency with the
2087 * wireless extensions but this is subject to reevaluation as soon as this
2088 * code is used more widely and we have a first user without wext.
2090 * @suspend: wiphy device needs to be suspended. The variable @wow will
2091 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2092 * configured for the device.
2093 * @resume: wiphy device needs to be resumed
2094 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2095 * to call device_set_wakeup_enable() to enable/disable wakeup from
2098 * @add_virtual_intf: create a new virtual interface with the given name,
2099 * must set the struct wireless_dev's iftype. Beware: You must create
2100 * the new netdev in the wiphy's network namespace! Returns the struct
2101 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2102 * also set the address member in the wdev.
2104 * @del_virtual_intf: remove the virtual interface
2106 * @change_virtual_intf: change type/configuration of virtual interface,
2107 * keep the struct wireless_dev's iftype updated.
2109 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2110 * when adding a group key.
2112 * @get_key: get information about the key with the given parameters.
2113 * @mac_addr will be %NULL when requesting information for a group
2114 * key. All pointers given to the @callback function need not be valid
2115 * after it returns. This function should return an error if it is
2116 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2118 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2119 * and @key_index, return -ENOENT if the key doesn't exist.
2121 * @set_default_key: set the default key on an interface
2123 * @set_default_mgmt_key: set the default management frame key on an interface
2125 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2127 * @start_ap: Start acting in AP mode defined by the parameters.
2128 * @change_beacon: Change the beacon parameters for an access point mode
2129 * interface. This should reject the call when AP mode wasn't started.
2130 * @stop_ap: Stop being an AP, including stopping beaconing.
2132 * @add_station: Add a new station.
2133 * @del_station: Remove a station; @mac may be NULL to remove all stations.
2134 * @change_station: Modify a given station. Note that flags changes are not much
2135 * validated in cfg80211, in particular the auth/assoc/authorized flags
2136 * might come to the driver in invalid combinations -- make sure to check
2137 * them, also against the existing state! Drivers must call
2138 * cfg80211_check_station_change() to validate the information.
2139 * @get_station: get station information for the station identified by @mac
2140 * @dump_station: dump station callback -- resume dump at index @idx
2142 * @add_mpath: add a fixed mesh path
2143 * @del_mpath: delete a given mesh path
2144 * @change_mpath: change a given mesh path
2145 * @get_mpath: get a mesh path for the given parameters
2146 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2147 * @join_mesh: join the mesh network with the specified parameters
2148 * (invoked with the wireless_dev mutex held)
2149 * @leave_mesh: leave the current mesh network
2150 * (invoked with the wireless_dev mutex held)
2152 * @get_mesh_config: Get the current mesh configuration
2154 * @update_mesh_config: Update mesh parameters on a running mesh.
2155 * The mask is a bitfield which tells us which parameters to
2156 * set, and which to leave alone.
2158 * @change_bss: Modify parameters for a given BSS.
2160 * @set_txq_params: Set TX queue parameters
2162 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2163 * as it doesn't implement join_mesh and needs to set the channel to
2164 * join the mesh instead.
2166 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2167 * interfaces are active this callback should reject the configuration.
2168 * If no interfaces are active or the device is down, the channel should
2169 * be stored for when a monitor interface becomes active.
2171 * @scan: Request to do a scan. If returning zero, the scan request is given
2172 * the driver, and will be valid until passed to cfg80211_scan_done().
2173 * For scan results, call cfg80211_inform_bss(); you can call this outside
2174 * the scan/scan_done bracket too.
2176 * @auth: Request to authenticate with the specified peer
2177 * (invoked with the wireless_dev mutex held)
2178 * @assoc: Request to (re)associate with the specified peer
2179 * (invoked with the wireless_dev mutex held)
2180 * @deauth: Request to deauthenticate from the specified peer
2181 * (invoked with the wireless_dev mutex held)
2182 * @disassoc: Request to disassociate from the specified peer
2183 * (invoked with the wireless_dev mutex held)
2185 * @connect: Connect to the ESS with the specified parameters. When connected,
2186 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
2187 * If the connection fails for some reason, call cfg80211_connect_result()
2188 * with the status from the AP.
2189 * (invoked with the wireless_dev mutex held)
2190 * @disconnect: Disconnect from the BSS/ESS.
2191 * (invoked with the wireless_dev mutex held)
2193 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2194 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2196 * (invoked with the wireless_dev mutex held)
2197 * @leave_ibss: Leave the IBSS.
2198 * (invoked with the wireless_dev mutex held)
2200 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2203 * @set_wiphy_params: Notify that wiphy parameters have changed;
2204 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2205 * have changed. The actual parameter values are available in
2206 * struct wiphy. If returning an error, no value should be changed.
2208 * @set_tx_power: set the transmit power according to the parameters,
2209 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2210 * wdev may be %NULL if power was set for the wiphy, and will
2211 * always be %NULL unless the driver supports per-vif TX power
2212 * (as advertised by the nl80211 feature flag.)
2213 * @get_tx_power: store the current TX power into the dbm variable;
2214 * return 0 if successful
2216 * @set_wds_peer: set the WDS peer for a WDS interface
2218 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2219 * functions to adjust rfkill hw state
2221 * @dump_survey: get site survey information.
2223 * @remain_on_channel: Request the driver to remain awake on the specified
2224 * channel for the specified duration to complete an off-channel
2225 * operation (e.g., public action frame exchange). When the driver is
2226 * ready on the requested channel, it must indicate this with an event
2227 * notification by calling cfg80211_ready_on_channel().
2228 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2229 * This allows the operation to be terminated prior to timeout based on
2230 * the duration value.
2231 * @mgmt_tx: Transmit a management frame.
2232 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2233 * frame on another channel
2235 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2236 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2237 * used by the function, but 0 and 1 must not be touched. Additionally,
2238 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2239 * dump and return to userspace with an error, so be careful. If any data
2240 * was passed in from userspace then the data/len arguments will be present
2241 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2243 * @set_bitrate_mask: set the bitrate mask configuration
2245 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2246 * devices running firmwares capable of generating the (re) association
2247 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2248 * @del_pmksa: Delete a cached PMKID.
2249 * @flush_pmksa: Flush all cached PMKIDs.
2250 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2251 * allows the driver to adjust the dynamic ps timeout value.
2252 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2253 * @set_cqm_txe_config: Configure connection quality monitor TX error
2255 * @sched_scan_start: Tell the driver to start a scheduled scan.
2256 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2257 * call must stop the scheduled scan and be ready for starting a new one
2258 * before it returns, i.e. @sched_scan_start may be called immediately
2259 * after that again and should not fail in that case. The driver should
2260 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2261 * method returns 0.)
2263 * @mgmt_frame_register: Notify driver that a management frame type was
2264 * registered. Note that this callback may not sleep, and cannot run
2265 * concurrently with itself.
2267 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2268 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2269 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2270 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2272 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2274 * @tdls_mgmt: Transmit a TDLS management frame.
2275 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2277 * @probe_client: probe an associated client, must return a cookie that it
2278 * later passes to cfg80211_probe_status().
2280 * @set_noack_map: Set the NoAck Map for the TIDs.
2282 * @get_channel: Get the current operating channel for the virtual interface.
2283 * For monitor interfaces, it should return %NULL unless there's a single
2284 * current monitoring channel.
2286 * @start_p2p_device: Start the given P2P device.
2287 * @stop_p2p_device: Stop the given P2P device.
2289 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2290 * Parameters include ACL policy, an array of MAC address of stations
2291 * and the number of MAC addresses. If there is already a list in driver
2292 * this new list replaces the existing one. Driver has to clear its ACL
2293 * when number of MAC addresses entries is passed as 0. Drivers which
2294 * advertise the support for MAC based ACL have to implement this callback.
2296 * @start_radar_detection: Start radar detection in the driver.
2298 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2299 * driver. If the SME is in the driver/firmware, this information can be
2300 * used in building Authentication and Reassociation Request frames.
2302 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2303 * for a given duration (milliseconds). The protocol is provided so the
2304 * driver can take the most appropriate actions.
2305 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2306 * reliability. This operation can not fail.
2307 * @set_coalesce: Set coalesce parameters.
2309 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2310 * responsible for veryfing if the switch is possible. Since this is
2311 * inherently tricky driver may decide to disconnect an interface later
2312 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2313 * everything. It should do it's best to verify requests and reject them
2314 * as soon as possible.
2316 * @set_qos_map: Set QoS mapping information to the driver
2318 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2319 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2320 * changes during the lifetime of the BSS.
2322 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2323 * with the given parameters; action frame exchange has been handled by
2324 * userspace so this just has to modify the TX path to take the TS into
2326 * If the admitted time is 0 just validate the parameters to make sure
2327 * the session can be created at all; it is valid to just always return
2328 * success for that but that may result in inefficient behaviour (handshake
2329 * with the peer followed by immediate teardown when the addition is later
2331 * @del_tx_ts: remove an existing TX TS
2333 struct cfg80211_ops {
2334 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2335 int (*resume)(struct wiphy *wiphy);
2336 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2338 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2340 enum nl80211_iftype type,
2342 struct vif_params *params);
2343 int (*del_virtual_intf)(struct wiphy *wiphy,
2344 struct wireless_dev *wdev);
2345 int (*change_virtual_intf)(struct wiphy *wiphy,
2346 struct net_device *dev,
2347 enum nl80211_iftype type, u32 *flags,
2348 struct vif_params *params);
2350 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2351 u8 key_index, bool pairwise, const u8 *mac_addr,
2352 struct key_params *params);
2353 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2354 u8 key_index, bool pairwise, const u8 *mac_addr,
2356 void (*callback)(void *cookie, struct key_params*));
2357 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2358 u8 key_index, bool pairwise, const u8 *mac_addr);
2359 int (*set_default_key)(struct wiphy *wiphy,
2360 struct net_device *netdev,
2361 u8 key_index, bool unicast, bool multicast);
2362 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2363 struct net_device *netdev,
2366 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2367 struct cfg80211_ap_settings *settings);
2368 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2369 struct cfg80211_beacon_data *info);
2370 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2373 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2375 struct station_parameters *params);
2376 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2378 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2380 struct station_parameters *params);
2381 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2382 const u8 *mac, struct station_info *sinfo);
2383 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2384 int idx, u8 *mac, struct station_info *sinfo);
2386 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2387 const u8 *dst, const u8 *next_hop);
2388 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2390 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2391 const u8 *dst, const u8 *next_hop);
2392 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2393 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2394 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2395 int idx, u8 *dst, u8 *next_hop,
2396 struct mpath_info *pinfo);
2397 int (*get_mesh_config)(struct wiphy *wiphy,
2398 struct net_device *dev,
2399 struct mesh_config *conf);
2400 int (*update_mesh_config)(struct wiphy *wiphy,
2401 struct net_device *dev, u32 mask,
2402 const struct mesh_config *nconf);
2403 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2404 const struct mesh_config *conf,
2405 const struct mesh_setup *setup);
2406 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2408 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2409 struct bss_parameters *params);
2411 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2412 struct ieee80211_txq_params *params);
2414 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2415 struct net_device *dev,
2416 struct ieee80211_channel *chan);
2418 int (*set_monitor_channel)(struct wiphy *wiphy,
2419 struct cfg80211_chan_def *chandef);
2421 int (*scan)(struct wiphy *wiphy,
2422 struct cfg80211_scan_request *request);
2424 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2425 struct cfg80211_auth_request *req);
2426 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2427 struct cfg80211_assoc_request *req);
2428 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2429 struct cfg80211_deauth_request *req);
2430 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2431 struct cfg80211_disassoc_request *req);
2433 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2434 struct cfg80211_connect_params *sme);
2435 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2438 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2439 struct cfg80211_ibss_params *params);
2440 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2442 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2443 int rate[IEEE80211_NUM_BANDS]);
2445 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2447 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2448 enum nl80211_tx_power_setting type, int mbm);
2449 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2452 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2455 void (*rfkill_poll)(struct wiphy *wiphy);
2457 #ifdef CONFIG_NL80211_TESTMODE
2458 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2459 void *data, int len);
2460 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2461 struct netlink_callback *cb,
2462 void *data, int len);
2465 int (*set_bitrate_mask)(struct wiphy *wiphy,
2466 struct net_device *dev,
2468 const struct cfg80211_bitrate_mask *mask);
2470 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2471 int idx, struct survey_info *info);
2473 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2474 struct cfg80211_pmksa *pmksa);
2475 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2476 struct cfg80211_pmksa *pmksa);
2477 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2479 int (*remain_on_channel)(struct wiphy *wiphy,
2480 struct wireless_dev *wdev,
2481 struct ieee80211_channel *chan,
2482 unsigned int duration,
2484 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2485 struct wireless_dev *wdev,
2488 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2489 struct cfg80211_mgmt_tx_params *params,
2491 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2492 struct wireless_dev *wdev,
2495 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2496 bool enabled, int timeout);
2498 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2499 struct net_device *dev,
2500 s32 rssi_thold, u32 rssi_hyst);
2502 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2503 struct net_device *dev,
2504 u32 rate, u32 pkts, u32 intvl);
2506 void (*mgmt_frame_register)(struct wiphy *wiphy,
2507 struct wireless_dev *wdev,
2508 u16 frame_type, bool reg);
2510 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2511 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2513 int (*sched_scan_start)(struct wiphy *wiphy,
2514 struct net_device *dev,
2515 struct cfg80211_sched_scan_request *request);
2516 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2518 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2519 struct cfg80211_gtk_rekey_data *data);
2521 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2522 const u8 *peer, u8 action_code, u8 dialog_token,
2523 u16 status_code, u32 peer_capability,
2524 bool initiator, const u8 *buf, size_t len);
2525 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2526 const u8 *peer, enum nl80211_tdls_operation oper);
2528 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2529 const u8 *peer, u64 *cookie);
2531 int (*set_noack_map)(struct wiphy *wiphy,
2532 struct net_device *dev,
2535 int (*get_channel)(struct wiphy *wiphy,
2536 struct wireless_dev *wdev,
2537 struct cfg80211_chan_def *chandef);
2539 int (*start_p2p_device)(struct wiphy *wiphy,
2540 struct wireless_dev *wdev);
2541 void (*stop_p2p_device)(struct wiphy *wiphy,
2542 struct wireless_dev *wdev);
2544 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2545 const struct cfg80211_acl_data *params);
2547 int (*start_radar_detection)(struct wiphy *wiphy,
2548 struct net_device *dev,
2549 struct cfg80211_chan_def *chandef,
2551 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2552 struct cfg80211_update_ft_ies_params *ftie);
2553 int (*crit_proto_start)(struct wiphy *wiphy,
2554 struct wireless_dev *wdev,
2555 enum nl80211_crit_proto_id protocol,
2557 void (*crit_proto_stop)(struct wiphy *wiphy,
2558 struct wireless_dev *wdev);
2559 int (*set_coalesce)(struct wiphy *wiphy,
2560 struct cfg80211_coalesce *coalesce);
2562 int (*channel_switch)(struct wiphy *wiphy,
2563 struct net_device *dev,
2564 struct cfg80211_csa_settings *params);
2566 int (*set_qos_map)(struct wiphy *wiphy,
2567 struct net_device *dev,
2568 struct cfg80211_qos_map *qos_map);
2570 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
2571 struct cfg80211_chan_def *chandef);
2573 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2574 u8 tsid, const u8 *peer, u8 user_prio,
2576 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2577 u8 tsid, const u8 *peer);
2581 * wireless hardware and networking interfaces structures
2582 * and registration/helper functions
2586 * enum wiphy_flags - wiphy capability flags
2588 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2590 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2591 * by default -- this flag will be set depending on the kernel's default
2592 * on wiphy_new(), but can be changed by the driver if it has a good
2593 * reason to override the default
2594 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2595 * on a VLAN interface)
2596 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2597 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2598 * control port protocol ethertype. The device also honours the
2599 * control_port_no_encrypt flag.
2600 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2601 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2602 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2603 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2604 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2606 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2607 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2608 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2609 * link setup/discovery operations internally. Setup, discovery and
2610 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2611 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2612 * used for asking the driver/firmware to perform a TDLS operation.
2613 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2614 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2615 * when there are virtual interfaces in AP mode by calling
2616 * cfg80211_report_obss_beacon().
2617 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2618 * responds to probe-requests in hardware.
2619 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2620 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2621 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2622 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2623 * beaconing mode (AP, IBSS, Mesh, ...).
2624 * @WIPHY_FLAG_SUPPORTS_WMM_ADMISSION: the device supports setting up WMM
2625 * TSPEC sessions (TID aka TSID 0-7) with the NL80211_CMD_ADD_TX_TS
2626 * command. Standard IEEE 802.11 TSPEC setup is not yet supported, it
2627 * needs to be able to handle Block-Ack agreements and other things.
2630 WIPHY_FLAG_SUPPORTS_WMM_ADMISSION = BIT(0),
2633 WIPHY_FLAG_NETNS_OK = BIT(3),
2634 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2635 WIPHY_FLAG_4ADDR_AP = BIT(5),
2636 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2637 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2638 WIPHY_FLAG_IBSS_RSN = BIT(8),
2639 WIPHY_FLAG_MESH_AUTH = BIT(10),
2640 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2641 /* use hole at 12 */
2642 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2643 WIPHY_FLAG_AP_UAPSD = BIT(14),
2644 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2645 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2646 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2647 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2648 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2649 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2650 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2651 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
2652 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
2656 * struct ieee80211_iface_limit - limit on certain interface types
2657 * @max: maximum number of interfaces of these types
2658 * @types: interface types (bits)
2660 struct ieee80211_iface_limit {
2666 * struct ieee80211_iface_combination - possible interface combination
2667 * @limits: limits for the given interface types
2668 * @n_limits: number of limitations
2669 * @num_different_channels: can use up to this many different channels
2670 * @max_interfaces: maximum number of interfaces in total allowed in this
2672 * @beacon_int_infra_match: In this combination, the beacon intervals
2673 * between infrastructure and AP types must match. This is required
2674 * only in special cases.
2675 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2676 * @radar_detect_regions: bitmap of regions supported for radar detection
2678 * With this structure the driver can describe which interface
2679 * combinations it supports concurrently.
2683 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2685 * struct ieee80211_iface_limit limits1[] = {
2686 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2687 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2689 * struct ieee80211_iface_combination combination1 = {
2690 * .limits = limits1,
2691 * .n_limits = ARRAY_SIZE(limits1),
2692 * .max_interfaces = 2,
2693 * .beacon_int_infra_match = true,
2697 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2699 * struct ieee80211_iface_limit limits2[] = {
2700 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2701 * BIT(NL80211_IFTYPE_P2P_GO), },
2703 * struct ieee80211_iface_combination combination2 = {
2704 * .limits = limits2,
2705 * .n_limits = ARRAY_SIZE(limits2),
2706 * .max_interfaces = 8,
2707 * .num_different_channels = 1,
2711 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2713 * This allows for an infrastructure connection and three P2P connections.
2715 * struct ieee80211_iface_limit limits3[] = {
2716 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2717 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2718 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2720 * struct ieee80211_iface_combination combination3 = {
2721 * .limits = limits3,
2722 * .n_limits = ARRAY_SIZE(limits3),
2723 * .max_interfaces = 4,
2724 * .num_different_channels = 2,
2727 struct ieee80211_iface_combination {
2728 const struct ieee80211_iface_limit *limits;
2729 u32 num_different_channels;
2732 bool beacon_int_infra_match;
2733 u8 radar_detect_widths;
2734 u8 radar_detect_regions;
2737 struct ieee80211_txrx_stypes {
2742 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2743 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2744 * trigger that keeps the device operating as-is and
2745 * wakes up the host on any activity, for example a
2746 * received packet that passed filtering; note that the
2747 * packet should be preserved in that case
2748 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2750 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2751 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2752 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2753 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2754 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2755 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2757 enum wiphy_wowlan_support_flags {
2758 WIPHY_WOWLAN_ANY = BIT(0),
2759 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2760 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2761 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2762 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2763 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2764 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2765 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2768 struct wiphy_wowlan_tcp_support {
2769 const struct nl80211_wowlan_tcp_data_token_feature *tok;
2770 u32 data_payload_max;
2771 u32 data_interval_max;
2772 u32 wake_payload_max;
2777 * struct wiphy_wowlan_support - WoWLAN support data
2778 * @flags: see &enum wiphy_wowlan_support_flags
2779 * @n_patterns: number of supported wakeup patterns
2780 * (see nl80211.h for the pattern definition)
2781 * @pattern_max_len: maximum length of each pattern
2782 * @pattern_min_len: minimum length of each pattern
2783 * @max_pkt_offset: maximum Rx packet offset
2784 * @tcp: TCP wakeup support information
2786 struct wiphy_wowlan_support {
2789 int pattern_max_len;
2790 int pattern_min_len;
2792 const struct wiphy_wowlan_tcp_support *tcp;
2796 * struct wiphy_coalesce_support - coalesce support data
2797 * @n_rules: maximum number of coalesce rules
2798 * @max_delay: maximum supported coalescing delay in msecs
2799 * @n_patterns: number of supported patterns in a rule
2800 * (see nl80211.h for the pattern definition)
2801 * @pattern_max_len: maximum length of each pattern
2802 * @pattern_min_len: minimum length of each pattern
2803 * @max_pkt_offset: maximum Rx packet offset
2805 struct wiphy_coalesce_support {
2809 int pattern_max_len;
2810 int pattern_min_len;
2815 * enum wiphy_vendor_command_flags - validation flags for vendor commands
2816 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
2817 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
2818 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
2819 * (must be combined with %_WDEV or %_NETDEV)
2821 enum wiphy_vendor_command_flags {
2822 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
2823 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
2824 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
2828 * struct wiphy_vendor_command - vendor command definition
2829 * @info: vendor command identifying information, as used in nl80211
2830 * @flags: flags, see &enum wiphy_vendor_command_flags
2831 * @doit: callback for the operation, note that wdev is %NULL if the
2832 * flags didn't ask for a wdev and non-%NULL otherwise; the data
2833 * pointer may be %NULL if userspace provided no data at all
2835 struct wiphy_vendor_command {
2836 struct nl80211_vendor_cmd_info info;
2838 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
2839 const void *data, int data_len);
2843 * struct wiphy - wireless hardware description
2844 * @reg_notifier: the driver's regulatory notification callback,
2845 * note that if your driver uses wiphy_apply_custom_regulatory()
2846 * the reg_notifier's request can be passed as NULL
2847 * @regd: the driver's regulatory domain, if one was requested via
2848 * the regulatory_hint() API. This can be used by the driver
2849 * on the reg_notifier() if it chooses to ignore future
2850 * regulatory domain changes caused by other drivers.
2851 * @signal_type: signal type reported in &struct cfg80211_bss.
2852 * @cipher_suites: supported cipher suites
2853 * @n_cipher_suites: number of supported cipher suites
2854 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2855 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2856 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2857 * -1 = fragmentation disabled, only odd values >= 256 used
2858 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2859 * @_net: the network namespace this wiphy currently lives in
2860 * @perm_addr: permanent MAC address of this device
2861 * @addr_mask: If the device supports multiple MAC addresses by masking,
2862 * set this to a mask with variable bits set to 1, e.g. if the last
2863 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
2864 * variable bits shall be determined by the interfaces added, with
2865 * interfaces not matching the mask being rejected to be brought up.
2866 * @n_addresses: number of addresses in @addresses.
2867 * @addresses: If the device has more than one address, set this pointer
2868 * to a list of addresses (6 bytes each). The first one will be used
2869 * by default for perm_addr. In this case, the mask should be set to
2870 * all-zeroes. In this case it is assumed that the device can handle
2871 * the same number of arbitrary MAC addresses.
2872 * @registered: protects ->resume and ->suspend sysfs callbacks against
2873 * unregister hardware
2874 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2875 * automatically on wiphy renames
2876 * @dev: (virtual) struct device for this wiphy
2877 * @registered: helps synchronize suspend/resume with wiphy unregister
2878 * @wext: wireless extension handlers
2879 * @priv: driver private data (sized according to wiphy_new() parameter)
2880 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2881 * must be set by driver
2882 * @iface_combinations: Valid interface combinations array, should not
2883 * list single interface types.
2884 * @n_iface_combinations: number of entries in @iface_combinations array.
2885 * @software_iftypes: bitmask of software interface types, these are not
2886 * subject to any restrictions since they are purely managed in SW.
2887 * @flags: wiphy flags, see &enum wiphy_flags
2888 * @regulatory_flags: wiphy regulatory flags, see
2889 * &enum ieee80211_regulatory_flags
2890 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2891 * @bss_priv_size: each BSS struct has private data allocated with it,
2892 * this variable determines its size
2893 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2895 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2896 * for in any given scheduled scan
2897 * @max_match_sets: maximum number of match sets the device can handle
2898 * when performing a scheduled scan, 0 if filtering is not
2900 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2901 * add to probe request frames transmitted during a scan, must not
2902 * include fixed IEs like supported rates
2903 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2905 * @coverage_class: current coverage class
2906 * @fw_version: firmware version for ethtool reporting
2907 * @hw_version: hardware version for ethtool reporting
2908 * @max_num_pmkids: maximum number of PMKIDs supported by device
2909 * @privid: a pointer that drivers can use to identify if an arbitrary
2910 * wiphy is theirs, e.g. in global notifiers
2911 * @bands: information about bands/channels supported by this device
2913 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2914 * transmitted through nl80211, points to an array indexed by interface
2917 * @available_antennas_tx: bitmap of antennas which are available to be
2918 * configured as TX antennas. Antenna configuration commands will be
2919 * rejected unless this or @available_antennas_rx is set.
2921 * @available_antennas_rx: bitmap of antennas which are available to be
2922 * configured as RX antennas. Antenna configuration commands will be
2923 * rejected unless this or @available_antennas_tx is set.
2925 * @probe_resp_offload:
2926 * Bitmap of supported protocols for probe response offloading.
2927 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2928 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2930 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2931 * may request, if implemented.
2933 * @wowlan: WoWLAN support information
2934 * @wowlan_config: current WoWLAN configuration; this should usually not be
2935 * used since access to it is necessarily racy, use the parameter passed
2936 * to the suspend() operation instead.
2938 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2939 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2940 * If null, then none can be over-ridden.
2941 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
2942 * If null, then none can be over-ridden.
2944 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
2947 * @extended_capabilities: extended capabilities supported by the driver,
2948 * additional capabilities might be supported by userspace; these are
2949 * the 802.11 extended capabilities ("Extended Capabilities element")
2950 * and are in the same format as in the information element. See
2951 * 802.11-2012 8.4.2.29 for the defined fields.
2952 * @extended_capabilities_mask: mask of the valid values
2953 * @extended_capabilities_len: length of the extended capabilities
2954 * @coalesce: packet coalescing support information
2956 * @vendor_commands: array of vendor commands supported by the hardware
2957 * @n_vendor_commands: number of vendor commands
2958 * @vendor_events: array of vendor events supported by the hardware
2959 * @n_vendor_events: number of vendor events
2961 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
2962 * (including P2P GO) or 0 to indicate no such limit is advertised. The
2963 * driver is allowed to advertise a theoretical limit that it can reach in
2964 * some cases, but may not always reach.
2966 * @max_num_csa_counters: Number of supported csa_counters in beacons
2967 * and probe responses. This value should be set if the driver
2968 * wishes to limit the number of csa counters. Default (0) means
2970 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
2971 * frame was sent and the channel on which the frame was heard for which
2972 * the reported rssi is still valid. If a driver is able to compensate the
2973 * low rssi when a frame is heard on different channel, then it should set
2974 * this variable to the maximal offset for which it can compensate.
2975 * This value should be set in MHz.
2978 /* assign these fields before you register the wiphy */
2980 /* permanent MAC address(es) */
2981 u8 perm_addr[ETH_ALEN];
2982 u8 addr_mask[ETH_ALEN];
2984 struct mac_address *addresses;
2986 const struct ieee80211_txrx_stypes *mgmt_stypes;
2988 const struct ieee80211_iface_combination *iface_combinations;
2989 int n_iface_combinations;
2990 u16 software_iftypes;
2994 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2995 u16 interface_modes;
2997 u16 max_acl_mac_addrs;
2999 u32 flags, regulatory_flags, features;
3003 enum cfg80211_signal_type signal_type;
3007 u8 max_sched_scan_ssids;
3009 u16 max_scan_ie_len;
3010 u16 max_sched_scan_ie_len;
3012 int n_cipher_suites;
3013 const u32 *cipher_suites;
3021 char fw_version[ETHTOOL_FWVERS_LEN];
3025 const struct wiphy_wowlan_support *wowlan;
3026 struct cfg80211_wowlan *wowlan_config;
3029 u16 max_remain_on_channel_duration;
3033 u32 available_antennas_tx;
3034 u32 available_antennas_rx;
3037 * Bitmap of supported protocols for probe response offloading
3038 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3039 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3041 u32 probe_resp_offload;
3043 const u8 *extended_capabilities, *extended_capabilities_mask;
3044 u8 extended_capabilities_len;
3046 /* If multiple wiphys are registered and you're handed e.g.
3047 * a regular netdev with assigned ieee80211_ptr, you won't
3048 * know whether it points to a wiphy your driver has registered
3049 * or not. Assign this to something global to your driver to
3050 * help determine whether you own this wiphy or not. */
3053 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
3055 /* Lets us get back the wiphy on the callback */
3056 void (*reg_notifier)(struct wiphy *wiphy,
3057 struct regulatory_request *request);
3059 /* fields below are read-only, assigned by cfg80211 */
3061 const struct ieee80211_regdomain __rcu *regd;
3063 /* the item in /sys/class/ieee80211/ points to this,
3064 * you need use set_wiphy_dev() (see below) */
3067 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3070 /* dir in debugfs: ieee80211/<wiphyname> */
3071 struct dentry *debugfsdir;
3073 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3074 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3076 #ifdef CONFIG_NET_NS
3077 /* the network namespace this phy lives in currently */
3081 #ifdef CONFIG_CFG80211_WEXT
3082 const struct iw_handler_def *wext;
3085 const struct wiphy_coalesce_support *coalesce;
3087 const struct wiphy_vendor_command *vendor_commands;
3088 const struct nl80211_vendor_cmd_info *vendor_events;
3089 int n_vendor_commands, n_vendor_events;
3091 u16 max_ap_assoc_sta;
3093 u8 max_num_csa_counters;
3094 u8 max_adj_channel_rssi_comp;
3096 char priv[0] __aligned(NETDEV_ALIGN);
3099 static inline struct net *wiphy_net(struct wiphy *wiphy)
3101 return read_pnet(&wiphy->_net);
3104 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3106 write_pnet(&wiphy->_net, net);
3110 * wiphy_priv - return priv from wiphy
3112 * @wiphy: the wiphy whose priv pointer to return
3113 * Return: The priv of @wiphy.
3115 static inline void *wiphy_priv(struct wiphy *wiphy)
3118 return &wiphy->priv;
3122 * priv_to_wiphy - return the wiphy containing the priv
3124 * @priv: a pointer previously returned by wiphy_priv
3125 * Return: The wiphy of @priv.
3127 static inline struct wiphy *priv_to_wiphy(void *priv)
3130 return container_of(priv, struct wiphy, priv);
3134 * set_wiphy_dev - set device pointer for wiphy
3136 * @wiphy: The wiphy whose device to bind
3137 * @dev: The device to parent it to
3139 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3141 wiphy->dev.parent = dev;
3145 * wiphy_dev - get wiphy dev pointer
3147 * @wiphy: The wiphy whose device struct to look up
3148 * Return: The dev of @wiphy.
3150 static inline struct device *wiphy_dev(struct wiphy *wiphy)
3152 return wiphy->dev.parent;
3156 * wiphy_name - get wiphy name
3158 * @wiphy: The wiphy whose name to return
3159 * Return: The name of @wiphy.
3161 static inline const char *wiphy_name(const struct wiphy *wiphy)
3163 return dev_name(&wiphy->dev);
3167 * wiphy_new - create a new wiphy for use with cfg80211
3169 * @ops: The configuration operations for this device
3170 * @sizeof_priv: The size of the private area to allocate
3172 * Create a new wiphy and associate the given operations with it.
3173 * @sizeof_priv bytes are allocated for private use.
3175 * Return: A pointer to the new wiphy. This pointer must be
3176 * assigned to each netdev's ieee80211_ptr for proper operation.
3178 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
3181 * wiphy_register - register a wiphy with cfg80211
3183 * @wiphy: The wiphy to register.
3185 * Return: A non-negative wiphy index or a negative error code.
3187 int wiphy_register(struct wiphy *wiphy);
3190 * wiphy_unregister - deregister a wiphy from cfg80211
3192 * @wiphy: The wiphy to unregister.
3194 * After this call, no more requests can be made with this priv
3195 * pointer, but the call may sleep to wait for an outstanding
3196 * request that is being handled.
3198 void wiphy_unregister(struct wiphy *wiphy);
3201 * wiphy_free - free wiphy
3203 * @wiphy: The wiphy to free
3205 void wiphy_free(struct wiphy *wiphy);
3207 /* internal structs */
3208 struct cfg80211_conn;
3209 struct cfg80211_internal_bss;
3210 struct cfg80211_cached_keys;
3213 * struct wireless_dev - wireless device state
3215 * For netdevs, this structure must be allocated by the driver
3216 * that uses the ieee80211_ptr field in struct net_device (this
3217 * is intentional so it can be allocated along with the netdev.)
3218 * It need not be registered then as netdev registration will
3219 * be intercepted by cfg80211 to see the new wireless device.
3221 * For non-netdev uses, it must also be allocated by the driver
3222 * in response to the cfg80211 callbacks that require it, as
3223 * there's no netdev registration in that case it may not be
3224 * allocated outside of callback operations that return it.
3226 * @wiphy: pointer to hardware description
3227 * @iftype: interface type
3228 * @list: (private) Used to collect the interfaces
3229 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3230 * @identifier: (private) Identifier used in nl80211 to identify this
3231 * wireless device if it has no netdev
3232 * @current_bss: (private) Used by the internal configuration code
3233 * @chandef: (private) Used by the internal configuration code to track
3234 * the user-set channel definition.
3235 * @preset_chandef: (private) Used by the internal configuration code to
3236 * track the channel to be used for AP later
3237 * @bssid: (private) Used by the internal configuration code
3238 * @ssid: (private) Used by the internal configuration code
3239 * @ssid_len: (private) Used by the internal configuration code
3240 * @mesh_id_len: (private) Used by the internal configuration code
3241 * @mesh_id_up_len: (private) Used by the internal configuration code
3242 * @wext: (private) Used by the internal wireless extensions compat code
3243 * @use_4addr: indicates 4addr mode is used on this interface, must be
3244 * set by driver (if supported) on add_interface BEFORE registering the
3245 * netdev and may otherwise be used by driver read-only, will be update
3246 * by cfg80211 on change_interface
3247 * @mgmt_registrations: list of registrations for management frames
3248 * @mgmt_registrations_lock: lock for the list
3249 * @mtx: mutex used to lock data in this struct, may be used by drivers
3250 * and some API functions require it held
3251 * @beacon_interval: beacon interval used on this device for transmitting
3252 * beacons, 0 when not valid
3253 * @address: The address for this device, valid only if @netdev is %NULL
3254 * @p2p_started: true if this is a P2P Device that has been started
3255 * @cac_started: true if DFS channel availability check has been started
3256 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3257 * @cac_time_ms: CAC time in ms
3258 * @ps: powersave mode is enabled
3259 * @ps_timeout: dynamic powersave timeout
3260 * @ap_unexpected_nlportid: (private) netlink port ID of application
3261 * registered for unexpected class 3 frames (AP mode)
3262 * @conn: (private) cfg80211 software SME connection state machine data
3263 * @connect_keys: (private) keys to set after connection is established
3264 * @ibss_fixed: (private) IBSS is using fixed BSSID
3265 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3266 * @event_list: (private) list for internal event processing
3267 * @event_lock: (private) lock for event list
3268 * @owner_nlportid: (private) owner socket port ID
3270 struct wireless_dev {
3271 struct wiphy *wiphy;
3272 enum nl80211_iftype iftype;
3274 /* the remainder of this struct should be private to cfg80211 */
3275 struct list_head list;
3276 struct net_device *netdev;
3280 struct list_head mgmt_registrations;
3281 spinlock_t mgmt_registrations_lock;
3285 bool use_4addr, p2p_started;
3287 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3289 /* currently used for IBSS and SME - might be rearranged later */
3290 u8 ssid[IEEE80211_MAX_SSID_LEN];
3291 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3292 struct cfg80211_conn *conn;
3293 struct cfg80211_cached_keys *connect_keys;
3295 struct list_head event_list;
3296 spinlock_t event_lock;
3298 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3299 struct cfg80211_chan_def preset_chandef;
3300 struct cfg80211_chan_def chandef;
3303 bool ibss_dfs_possible;
3308 int beacon_interval;
3310 u32 ap_unexpected_nlportid;
3313 unsigned long cac_start_time;
3314 unsigned int cac_time_ms;
3318 #ifdef CONFIG_CFG80211_WEXT
3321 struct cfg80211_ibss_params ibss;
3322 struct cfg80211_connect_params connect;
3323 struct cfg80211_cached_keys *keys;
3326 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3327 u8 ssid[IEEE80211_MAX_SSID_LEN];
3328 s8 default_key, default_mgmt_key;
3329 bool prev_bssid_valid;
3334 static inline u8 *wdev_address(struct wireless_dev *wdev)
3337 return wdev->netdev->dev_addr;
3338 return wdev->address;
3342 * wdev_priv - return wiphy priv from wireless_dev
3344 * @wdev: The wireless device whose wiphy's priv pointer to return
3345 * Return: The wiphy priv of @wdev.
3347 static inline void *wdev_priv(struct wireless_dev *wdev)
3350 return wiphy_priv(wdev->wiphy);
3354 * DOC: Utility functions
3356 * cfg80211 offers a number of utility functions that can be useful.
3360 * ieee80211_channel_to_frequency - convert channel number to frequency
3361 * @chan: channel number
3362 * @band: band, necessary due to channel number overlap
3363 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3365 int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
3368 * ieee80211_frequency_to_channel - convert frequency to channel number
3369 * @freq: center frequency
3370 * Return: The corresponding channel, or 0 if the conversion failed.
3372 int ieee80211_frequency_to_channel(int freq);
3375 * Name indirection necessary because the ieee80211 code also has
3376 * a function named "ieee80211_get_channel", so if you include
3377 * cfg80211's header file you get cfg80211's version, if you try
3378 * to include both header files you'll (rightfully!) get a symbol
3381 struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3384 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3385 * @wiphy: the struct wiphy to get the channel for
3386 * @freq: the center frequency of the channel
3387 * Return: The channel struct from @wiphy at @freq.
3389 static inline struct ieee80211_channel *
3390 ieee80211_get_channel(struct wiphy *wiphy, int freq)
3392 return __ieee80211_get_channel(wiphy, freq);
3396 * ieee80211_get_response_rate - get basic rate for a given rate
3398 * @sband: the band to look for rates in
3399 * @basic_rates: bitmap of basic rates
3400 * @bitrate: the bitrate for which to find the basic rate
3402 * Return: The basic rate corresponding to a given bitrate, that
3403 * is the next lower bitrate contained in the basic rate map,
3404 * which is, for this function, given as a bitmap of indices of
3405 * rates in the band's bitrate table.
3407 struct ieee80211_rate *
3408 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3409 u32 basic_rates, int bitrate);
3412 * ieee80211_mandatory_rates - get mandatory rates for a given band
3413 * @sband: the band to look for rates in
3414 * @scan_width: width of the control channel
3416 * This function returns a bitmap of the mandatory rates for the given
3417 * band, bits are set according to the rate position in the bitrates array.
3419 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3420 enum nl80211_bss_scan_width scan_width);
3423 * Radiotap parsing functions -- for controlled injection support
3425 * Implemented in net/wireless/radiotap.c
3426 * Documentation in Documentation/networking/radiotap-headers.txt
3429 struct radiotap_align_size {
3430 uint8_t align:4, size:4;
3433 struct ieee80211_radiotap_namespace {
3434 const struct radiotap_align_size *align_size;
3440 struct ieee80211_radiotap_vendor_namespaces {
3441 const struct ieee80211_radiotap_namespace *ns;
3446 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3447 * @this_arg_index: index of current arg, valid after each successful call
3448 * to ieee80211_radiotap_iterator_next()
3449 * @this_arg: pointer to current radiotap arg; it is valid after each
3450 * call to ieee80211_radiotap_iterator_next() but also after
3451 * ieee80211_radiotap_iterator_init() where it will point to
3452 * the beginning of the actual data portion
3453 * @this_arg_size: length of the current arg, for convenience
3454 * @current_namespace: pointer to the current namespace definition
3455 * (or internally %NULL if the current namespace is unknown)
3456 * @is_radiotap_ns: indicates whether the current namespace is the default
3457 * radiotap namespace or not
3459 * @_rtheader: pointer to the radiotap header we are walking through
3460 * @_max_length: length of radiotap header in cpu byte ordering
3461 * @_arg_index: next argument index
3462 * @_arg: next argument pointer
3463 * @_next_bitmap: internal pointer to next present u32
3464 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3465 * @_vns: vendor namespace definitions
3466 * @_next_ns_data: beginning of the next namespace's data
3467 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3470 * Describes the radiotap parser state. Fields prefixed with an underscore
3471 * must not be used by users of the parser, only by the parser internally.
3474 struct ieee80211_radiotap_iterator {
3475 struct ieee80211_radiotap_header *_rtheader;
3476 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3477 const struct ieee80211_radiotap_namespace *current_namespace;
3479 unsigned char *_arg, *_next_ns_data;
3480 __le32 *_next_bitmap;
3482 unsigned char *this_arg;
3490 uint32_t _bitmap_shifter;
3495 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3496 struct ieee80211_radiotap_header *radiotap_header,
3498 const struct ieee80211_radiotap_vendor_namespaces *vns);
3501 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3504 extern const unsigned char rfc1042_header[6];
3505 extern const unsigned char bridge_tunnel_header[6];
3508 * ieee80211_get_hdrlen_from_skb - get header length from data
3512 * Given an skb with a raw 802.11 header at the data pointer this function
3513 * returns the 802.11 header length.
3515 * Return: The 802.11 header length in bytes (not including encryption
3516 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3519 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3522 * ieee80211_hdrlen - get header length in bytes from frame control
3523 * @fc: frame control field in little-endian format
3524 * Return: The header length in bytes.
3526 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3529 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3530 * @meshhdr: the mesh extension header, only the flags field
3531 * (first byte) will be accessed
3532 * Return: The length of the extension header, which is always at
3533 * least 6 bytes and at most 18 if address 5 and 6 are present.
3535 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3538 * DOC: Data path helpers
3540 * In addition to generic utilities, cfg80211 also offers
3541 * functions that help implement the data path for devices
3542 * that do not do the 802.11/802.3 conversion on the device.
3546 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3547 * @skb: the 802.11 data frame
3548 * @addr: the device MAC address
3549 * @iftype: the virtual interface type
3550 * Return: 0 on success. Non-zero on error.
3552 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3553 enum nl80211_iftype iftype);
3556 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3557 * @skb: the 802.3 frame
3558 * @addr: the device MAC address
3559 * @iftype: the virtual interface type
3560 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3561 * @qos: build 802.11 QoS data frame
3562 * Return: 0 on success, or a negative error code.
3564 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3565 enum nl80211_iftype iftype, const u8 *bssid,
3569 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3571 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3572 * 802.3 frames. The @list will be empty if the decode fails. The
3573 * @skb is consumed after the function returns.
3575 * @skb: The input IEEE 802.11n A-MSDU frame.
3576 * @list: The output list of 802.3 frames. It must be allocated and
3577 * initialized by by the caller.
3578 * @addr: The device MAC address.
3579 * @iftype: The device interface type.
3580 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3581 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3583 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3584 const u8 *addr, enum nl80211_iftype iftype,
3585 const unsigned int extra_headroom,
3586 bool has_80211_header);
3589 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3590 * @skb: the data frame
3591 * @qos_map: Interworking QoS mapping or %NULL if not in use
3592 * Return: The 802.1p/1d tag.
3594 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3595 struct cfg80211_qos_map *qos_map);
3598 * cfg80211_find_ie - find information element in data
3601 * @ies: data consisting of IEs
3602 * @len: length of data
3604 * Return: %NULL if the element ID could not be found or if
3605 * the element is invalid (claims to be longer than the given
3606 * data), or a pointer to the first byte of the requested
3607 * element, that is the byte containing the element ID.
3609 * Note: There are no checks on the element length other than
3610 * having to fit into the given data.
3612 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3615 * cfg80211_find_vendor_ie - find vendor specific information element in data
3618 * @oui_type: vendor-specific OUI type
3619 * @ies: data consisting of IEs
3620 * @len: length of data
3622 * Return: %NULL if the vendor specific element ID could not be found or if the
3623 * element is invalid (claims to be longer than the given data), or a pointer to
3624 * the first byte of the requested element, that is the byte containing the
3627 * Note: There are no checks on the element length other than having to fit into
3630 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3631 const u8 *ies, int len);
3634 * DOC: Regulatory enforcement infrastructure
3640 * regulatory_hint - driver hint to the wireless core a regulatory domain
3641 * @wiphy: the wireless device giving the hint (used only for reporting
3643 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3644 * should be in. If @rd is set this should be NULL. Note that if you
3645 * set this to NULL you should still set rd->alpha2 to some accepted
3648 * Wireless drivers can use this function to hint to the wireless core
3649 * what it believes should be the current regulatory domain by
3650 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3651 * domain should be in or by providing a completely build regulatory domain.
3652 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3653 * for a regulatory domain structure for the respective country.
3655 * The wiphy must have been registered to cfg80211 prior to this call.
3656 * For cfg80211 drivers this means you must first use wiphy_register(),
3657 * for mac80211 drivers you must first use ieee80211_register_hw().
3659 * Drivers should check the return value, its possible you can get
3662 * Return: 0 on success. -ENOMEM.
3664 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3667 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3668 * @wiphy: the wireless device we want to process the regulatory domain on
3669 * @regd: the custom regulatory domain to use for this wiphy
3671 * Drivers can sometimes have custom regulatory domains which do not apply
3672 * to a specific country. Drivers can use this to apply such custom regulatory
3673 * domains. This routine must be called prior to wiphy registration. The
3674 * custom regulatory domain will be trusted completely and as such previous
3675 * default channel settings will be disregarded. If no rule is found for a
3676 * channel on the regulatory domain the channel will be disabled.
3677 * Drivers using this for a wiphy should also set the wiphy flag
3678 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
3679 * that called this helper.
3681 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
3682 const struct ieee80211_regdomain *regd);
3685 * freq_reg_info - get regulatory information for the given frequency
3686 * @wiphy: the wiphy for which we want to process this rule for
3687 * @center_freq: Frequency in KHz for which we want regulatory information for
3689 * Use this function to get the regulatory rule for a specific frequency on
3690 * a given wireless device. If the device has a specific regulatory domain
3691 * it wants to follow we respect that unless a country IE has been received
3692 * and processed already.
3694 * Return: A valid pointer, or, when an error occurs, for example if no rule
3695 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3696 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3697 * value will be -ERANGE if we determine the given center_freq does not even
3698 * have a regulatory rule for a frequency range in the center_freq's band.
3699 * See freq_in_rule_band() for our current definition of a band -- this is
3700 * purely subjective and right now it's 802.11 specific.
3702 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3706 * reg_initiator_name - map regulatory request initiator enum to name
3707 * @initiator: the regulatory request initiator
3709 * You can use this to map the regulatory request initiator enum to a
3710 * proper string representation.
3712 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
3715 * callbacks for asynchronous cfg80211 methods, notification
3716 * functions and BSS handling helpers
3720 * cfg80211_scan_done - notify that scan finished
3722 * @request: the corresponding scan request
3723 * @aborted: set to true if the scan was aborted for any reason,
3724 * userspace will be notified of that
3726 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3729 * cfg80211_sched_scan_results - notify that new scan results are available
3731 * @wiphy: the wiphy which got scheduled scan results
3733 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3736 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3738 * @wiphy: the wiphy on which the scheduled scan stopped
3740 * The driver can call this function to inform cfg80211 that the
3741 * scheduled scan had to be stopped, for whatever reason. The driver
3742 * is then called back via the sched_scan_stop operation when done.
3744 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3747 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
3749 * @wiphy: the wiphy on which the scheduled scan stopped
3751 * The driver can call this function to inform cfg80211 that the
3752 * scheduled scan had to be stopped, for whatever reason. The driver
3753 * is then called back via the sched_scan_stop operation when done.
3754 * This function should be called with rtnl locked.
3756 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
3759 * cfg80211_inform_bss_width_frame - inform cfg80211 of a received BSS frame
3761 * @wiphy: the wiphy reporting the BSS
3762 * @rx_channel: The channel the frame was received on
3763 * @scan_width: width of the control channel
3764 * @mgmt: the management frame (probe response or beacon)
3765 * @len: length of the management frame
3766 * @signal: the signal strength, type depends on the wiphy's signal_type
3767 * @gfp: context flags
3769 * This informs cfg80211 that BSS information was found and
3770 * the BSS should be updated/added.
3772 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3773 * Or %NULL on error.
3775 struct cfg80211_bss * __must_check
3776 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
3777 struct ieee80211_channel *rx_channel,
3778 enum nl80211_bss_scan_width scan_width,
3779 struct ieee80211_mgmt *mgmt, size_t len,
3780 s32 signal, gfp_t gfp);
3782 static inline struct cfg80211_bss * __must_check
3783 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3784 struct ieee80211_channel *rx_channel,
3785 struct ieee80211_mgmt *mgmt, size_t len,
3786 s32 signal, gfp_t gfp)
3788 return cfg80211_inform_bss_width_frame(wiphy, rx_channel,
3789 NL80211_BSS_CHAN_WIDTH_20,
3790 mgmt, len, signal, gfp);
3794 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
3795 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
3796 * from a beacon or probe response
3797 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
3798 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
3800 enum cfg80211_bss_frame_type {
3801 CFG80211_BSS_FTYPE_UNKNOWN,
3802 CFG80211_BSS_FTYPE_BEACON,
3803 CFG80211_BSS_FTYPE_PRESP,
3807 * cfg80211_inform_bss_width - inform cfg80211 of a new BSS
3809 * @wiphy: the wiphy reporting the BSS
3810 * @rx_channel: The channel the frame was received on
3811 * @scan_width: width of the control channel
3812 * @ftype: frame type (if known)
3813 * @bssid: the BSSID of the BSS
3814 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3815 * @capability: the capability field sent by the peer
3816 * @beacon_interval: the beacon interval announced by the peer
3817 * @ie: additional IEs sent by the peer
3818 * @ielen: length of the additional IEs
3819 * @signal: the signal strength, type depends on the wiphy's signal_type
3820 * @gfp: context flags
3822 * This informs cfg80211 that BSS information was found and
3823 * the BSS should be updated/added.
3825 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3826 * Or %NULL on error.
3828 struct cfg80211_bss * __must_check
3829 cfg80211_inform_bss_width(struct wiphy *wiphy,
3830 struct ieee80211_channel *rx_channel,
3831 enum nl80211_bss_scan_width scan_width,
3832 enum cfg80211_bss_frame_type ftype,
3833 const u8 *bssid, u64 tsf, u16 capability,
3834 u16 beacon_interval, const u8 *ie, size_t ielen,
3835 s32 signal, gfp_t gfp);
3837 static inline struct cfg80211_bss * __must_check
3838 cfg80211_inform_bss(struct wiphy *wiphy,
3839 struct ieee80211_channel *rx_channel,
3840 enum cfg80211_bss_frame_type ftype,
3841 const u8 *bssid, u64 tsf, u16 capability,
3842 u16 beacon_interval, const u8 *ie, size_t ielen,
3843 s32 signal, gfp_t gfp)
3845 return cfg80211_inform_bss_width(wiphy, rx_channel,
3846 NL80211_BSS_CHAN_WIDTH_20, ftype,
3847 bssid, tsf, capability,
3848 beacon_interval, ie, ielen, signal,
3852 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3853 struct ieee80211_channel *channel,
3855 const u8 *ssid, size_t ssid_len,
3856 u16 capa_mask, u16 capa_val);
3857 static inline struct cfg80211_bss *
3858 cfg80211_get_ibss(struct wiphy *wiphy,
3859 struct ieee80211_channel *channel,
3860 const u8 *ssid, size_t ssid_len)
3862 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3863 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3867 * cfg80211_ref_bss - reference BSS struct
3868 * @wiphy: the wiphy this BSS struct belongs to
3869 * @bss: the BSS struct to reference
3871 * Increments the refcount of the given BSS struct.
3873 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3876 * cfg80211_put_bss - unref BSS struct
3877 * @wiphy: the wiphy this BSS struct belongs to
3878 * @bss: the BSS struct
3880 * Decrements the refcount of the given BSS struct.
3882 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3885 * cfg80211_unlink_bss - unlink BSS from internal data structures
3887 * @bss: the bss to remove
3889 * This function removes the given BSS from the internal data structures
3890 * thereby making it no longer show up in scan results etc. Use this
3891 * function when you detect a BSS is gone. Normally BSSes will also time
3892 * out, so it is not necessary to use this function at all.
3894 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3896 static inline enum nl80211_bss_scan_width
3897 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
3899 switch (chandef->width) {
3900 case NL80211_CHAN_WIDTH_5:
3901 return NL80211_BSS_CHAN_WIDTH_5;
3902 case NL80211_CHAN_WIDTH_10:
3903 return NL80211_BSS_CHAN_WIDTH_10;
3905 return NL80211_BSS_CHAN_WIDTH_20;
3910 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
3911 * @dev: network device
3912 * @buf: authentication frame (header + body)
3913 * @len: length of the frame data
3915 * This function is called whenever an authentication, disassociation or
3916 * deauthentication frame has been received and processed in station mode.
3917 * After being asked to authenticate via cfg80211_ops::auth() the driver must
3918 * call either this function or cfg80211_auth_timeout().
3919 * After being asked to associate via cfg80211_ops::assoc() the driver must
3920 * call either this function or cfg80211_auth_timeout().
3921 * While connected, the driver must calls this for received and processed
3922 * disassociation and deauthentication frames. If the frame couldn't be used
3923 * because it was unprotected, the driver must call the function
3924 * cfg80211_rx_unprot_mlme_mgmt() instead.
3926 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3928 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
3931 * cfg80211_auth_timeout - notification of timed out authentication
3932 * @dev: network device
3933 * @addr: The MAC address of the device with which the authentication timed out
3935 * This function may sleep. The caller must hold the corresponding wdev's
3938 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
3941 * cfg80211_rx_assoc_resp - notification of processed association response
3942 * @dev: network device
3943 * @bss: the BSS that association was requested with, ownership of the pointer
3944 * moves to cfg80211 in this call
3945 * @buf: authentication frame (header + body)
3946 * @len: length of the frame data
3947 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
3949 * After being asked to associate via cfg80211_ops::assoc() the driver must
3950 * call either this function or cfg80211_auth_timeout().
3952 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3954 void cfg80211_rx_assoc_resp(struct net_device *dev,
3955 struct cfg80211_bss *bss,
3956 const u8 *buf, size_t len,
3960 * cfg80211_assoc_timeout - notification of timed out association
3961 * @dev: network device
3962 * @bss: The BSS entry with which association timed out.
3964 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3966 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
3969 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
3970 * @dev: network device
3971 * @buf: 802.11 frame (header + body)
3972 * @len: length of the frame data
3974 * This function is called whenever deauthentication has been processed in
3975 * station mode. This includes both received deauthentication frames and
3976 * locally generated ones. This function may sleep. The caller must hold the
3977 * corresponding wdev's mutex.
3979 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
3982 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
3983 * @dev: network device
3984 * @buf: deauthentication frame (header + body)
3985 * @len: length of the frame data
3987 * This function is called whenever a received deauthentication or dissassoc
3988 * frame has been dropped in station mode because of MFP being used but the
3989 * frame was not protected. This function may sleep.
3991 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
3992 const u8 *buf, size_t len);
3995 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3996 * @dev: network device
3997 * @addr: The source MAC address of the frame
3998 * @key_type: The key type that the received frame used
3999 * @key_id: Key identifier (0..3). Can be -1 if missing.
4000 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4001 * @gfp: allocation flags
4003 * This function is called whenever the local MAC detects a MIC failure in a
4004 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4007 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4008 enum nl80211_key_type key_type, int key_id,
4009 const u8 *tsc, gfp_t gfp);
4012 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4014 * @dev: network device
4015 * @bssid: the BSSID of the IBSS joined
4016 * @channel: the channel of the IBSS joined
4017 * @gfp: allocation flags
4019 * This function notifies cfg80211 that the device joined an IBSS or
4020 * switched to a different BSSID. Before this function can be called,
4021 * either a beacon has to have been received from the IBSS, or one of
4022 * the cfg80211_inform_bss{,_frame} functions must have been called
4023 * with the locally generated beacon -- this guarantees that there is
4024 * always a scan result for this IBSS. cfg80211 will handle the rest.
4026 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4027 struct ieee80211_channel *channel, gfp_t gfp);
4030 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4032 * @dev: network device
4033 * @macaddr: the MAC address of the new candidate
4034 * @ie: information elements advertised by the peer candidate
4035 * @ie_len: lenght of the information elements buffer
4036 * @gfp: allocation flags
4038 * This function notifies cfg80211 that the mesh peer candidate has been
4039 * detected, most likely via a beacon or, less likely, via a probe response.
4040 * cfg80211 then sends a notification to userspace.
4042 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4043 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4046 * DOC: RFkill integration
4048 * RFkill integration in cfg80211 is almost invisible to drivers,
4049 * as cfg80211 automatically registers an rfkill instance for each
4050 * wireless device it knows about. Soft kill is also translated
4051 * into disconnecting and turning all interfaces off, drivers are
4052 * expected to turn off the device when all interfaces are down.
4054 * However, devices may have a hard RFkill line, in which case they
4055 * also need to interact with the rfkill subsystem, via cfg80211.
4056 * They can do this with a few helper functions documented here.
4060 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4062 * @blocked: block status
4064 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4067 * wiphy_rfkill_start_polling - start polling rfkill
4070 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4073 * wiphy_rfkill_stop_polling - stop polling rfkill
4076 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4079 * DOC: Vendor commands
4081 * Occasionally, there are special protocol or firmware features that
4082 * can't be implemented very openly. For this and similar cases, the
4083 * vendor command functionality allows implementing the features with
4084 * (typically closed-source) userspace and firmware, using nl80211 as
4085 * the configuration mechanism.
4087 * A driver supporting vendor commands must register them as an array
4088 * in struct wiphy, with handlers for each one, each command has an
4089 * OUI and sub command ID to identify it.
4091 * Note that this feature should not be (ab)used to implement protocol
4092 * features that could openly be shared across drivers. In particular,
4093 * it must never be required to use vendor commands to implement any
4094 * "normal" functionality that higher-level userspace like connection
4095 * managers etc. need.
4098 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4099 enum nl80211_commands cmd,
4100 enum nl80211_attrs attr,
4103 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4104 enum nl80211_commands cmd,
4105 enum nl80211_attrs attr,
4106 int vendor_event_idx,
4107 int approxlen, gfp_t gfp);
4109 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4112 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4114 * @approxlen: an upper bound of the length of the data that will
4115 * be put into the skb
4117 * This function allocates and pre-fills an skb for a reply to
4118 * a vendor command. Since it is intended for a reply, calling
4119 * it outside of a vendor command's doit() operation is invalid.
4121 * The returned skb is pre-filled with some identifying data in
4122 * a way that any data that is put into the skb (with skb_put(),
4123 * nla_put() or similar) will end up being within the
4124 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4125 * with the skb is adding data for the corresponding userspace tool
4126 * which can then read that data out of the vendor data attribute.
4127 * You must not modify the skb in any other way.
4129 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4130 * its error code as the result of the doit() operation.
4132 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4134 static inline struct sk_buff *
4135 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4137 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4138 NL80211_ATTR_VENDOR_DATA, approxlen);
4142 * cfg80211_vendor_cmd_reply - send the reply skb
4143 * @skb: The skb, must have been allocated with
4144 * cfg80211_vendor_cmd_alloc_reply_skb()
4146 * Since calling this function will usually be the last thing
4147 * before returning from the vendor command doit() you should
4148 * return the error code. Note that this function consumes the
4149 * skb regardless of the return value.
4151 * Return: An error code or 0 on success.
4153 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4156 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4158 * @event_idx: index of the vendor event in the wiphy's vendor_events
4159 * @approxlen: an upper bound of the length of the data that will
4160 * be put into the skb
4161 * @gfp: allocation flags
4163 * This function allocates and pre-fills an skb for an event on the
4164 * vendor-specific multicast group.
4166 * When done filling the skb, call cfg80211_vendor_event() with the
4167 * skb to send the event.
4169 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4171 static inline struct sk_buff *
4172 cfg80211_vendor_event_alloc(struct wiphy *wiphy, int approxlen,
4173 int event_idx, gfp_t gfp)
4175 return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_VENDOR,
4176 NL80211_ATTR_VENDOR_DATA,
4177 event_idx, approxlen, gfp);
4181 * cfg80211_vendor_event - send the event
4182 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4183 * @gfp: allocation flags
4185 * This function sends the given @skb, which must have been allocated
4186 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4188 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4190 __cfg80211_send_event_skb(skb, gfp);
4193 #ifdef CONFIG_NL80211_TESTMODE
4197 * Test mode is a set of utility functions to allow drivers to
4198 * interact with driver-specific tools to aid, for instance,
4199 * factory programming.
4201 * This chapter describes how drivers interact with it, for more
4202 * information see the nl80211 book's chapter on it.
4206 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4208 * @approxlen: an upper bound of the length of the data that will
4209 * be put into the skb
4211 * This function allocates and pre-fills an skb for a reply to
4212 * the testmode command. Since it is intended for a reply, calling
4213 * it outside of the @testmode_cmd operation is invalid.
4215 * The returned skb is pre-filled with the wiphy index and set up in
4216 * a way that any data that is put into the skb (with skb_put(),
4217 * nla_put() or similar) will end up being within the
4218 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4219 * with the skb is adding data for the corresponding userspace tool
4220 * which can then read that data out of the testdata attribute. You
4221 * must not modify the skb in any other way.
4223 * When done, call cfg80211_testmode_reply() with the skb and return
4224 * its error code as the result of the @testmode_cmd operation.
4226 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4228 static inline struct sk_buff *
4229 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4231 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4232 NL80211_ATTR_TESTDATA, approxlen);
4236 * cfg80211_testmode_reply - send the reply skb
4237 * @skb: The skb, must have been allocated with
4238 * cfg80211_testmode_alloc_reply_skb()
4240 * Since calling this function will usually be the last thing
4241 * before returning from the @testmode_cmd you should return
4242 * the error code. Note that this function consumes the skb
4243 * regardless of the return value.
4245 * Return: An error code or 0 on success.
4247 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4249 return cfg80211_vendor_cmd_reply(skb);
4253 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4255 * @approxlen: an upper bound of the length of the data that will
4256 * be put into the skb
4257 * @gfp: allocation flags
4259 * This function allocates and pre-fills an skb for an event on the
4260 * testmode multicast group.
4262 * The returned skb is set up in the same way as with
4263 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4264 * there, you should simply add data to it that will then end up in the
4265 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4268 * When done filling the skb, call cfg80211_testmode_event() with the
4269 * skb to send the event.
4271 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4273 static inline struct sk_buff *
4274 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4276 return __cfg80211_alloc_event_skb(wiphy, NL80211_CMD_TESTMODE,
4277 NL80211_ATTR_TESTDATA, -1,
4282 * cfg80211_testmode_event - send the event
4283 * @skb: The skb, must have been allocated with
4284 * cfg80211_testmode_alloc_event_skb()
4285 * @gfp: allocation flags
4287 * This function sends the given @skb, which must have been allocated
4288 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4291 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4293 __cfg80211_send_event_skb(skb, gfp);
4296 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
4297 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
4299 #define CFG80211_TESTMODE_CMD(cmd)
4300 #define CFG80211_TESTMODE_DUMP(cmd)
4304 * cfg80211_connect_result - notify cfg80211 of connection result
4306 * @dev: network device
4307 * @bssid: the BSSID of the AP
4308 * @req_ie: association request IEs (maybe be %NULL)
4309 * @req_ie_len: association request IEs length
4310 * @resp_ie: association response IEs (may be %NULL)
4311 * @resp_ie_len: assoc response IEs length
4312 * @status: status code, 0 for successful connection, use
4313 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4314 * the real status code for failures.
4315 * @gfp: allocation flags
4317 * It should be called by the underlying driver whenever connect() has
4320 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4321 const u8 *req_ie, size_t req_ie_len,
4322 const u8 *resp_ie, size_t resp_ie_len,
4323 u16 status, gfp_t gfp);
4326 * cfg80211_roamed - notify cfg80211 of roaming
4328 * @dev: network device
4329 * @channel: the channel of the new AP
4330 * @bssid: the BSSID of the new AP
4331 * @req_ie: association request IEs (maybe be %NULL)
4332 * @req_ie_len: association request IEs length
4333 * @resp_ie: association response IEs (may be %NULL)
4334 * @resp_ie_len: assoc response IEs length
4335 * @gfp: allocation flags
4337 * It should be called by the underlying driver whenever it roamed
4338 * from one AP to another while connected.
4340 void cfg80211_roamed(struct net_device *dev,
4341 struct ieee80211_channel *channel,
4343 const u8 *req_ie, size_t req_ie_len,
4344 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4347 * cfg80211_roamed_bss - notify cfg80211 of roaming
4349 * @dev: network device
4350 * @bss: entry of bss to which STA got roamed
4351 * @req_ie: association request IEs (maybe be %NULL)
4352 * @req_ie_len: association request IEs length
4353 * @resp_ie: association response IEs (may be %NULL)
4354 * @resp_ie_len: assoc response IEs length
4355 * @gfp: allocation flags
4357 * This is just a wrapper to notify cfg80211 of roaming event with driver
4358 * passing bss to avoid a race in timeout of the bss entry. It should be
4359 * called by the underlying driver whenever it roamed from one AP to another
4360 * while connected. Drivers which have roaming implemented in firmware
4361 * may use this function to avoid a race in bss entry timeout where the bss
4362 * entry of the new AP is seen in the driver, but gets timed out by the time
4363 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4364 * rdev->event_work. In case of any failures, the reference is released
4365 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4366 * it will be released while diconneting from the current bss.
4368 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4369 const u8 *req_ie, size_t req_ie_len,
4370 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4373 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4375 * @dev: network device
4376 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4377 * @ie_len: length of IEs
4378 * @reason: reason code for the disconnection, set it to 0 if unknown
4379 * @gfp: allocation flags
4381 * After it calls this function, the driver should enter an idle state
4382 * and not try to connect to any AP any more.
4384 void cfg80211_disconnected(struct net_device *dev, u16 reason,
4385 const u8 *ie, size_t ie_len, gfp_t gfp);
4388 * cfg80211_ready_on_channel - notification of remain_on_channel start
4389 * @wdev: wireless device
4390 * @cookie: the request cookie
4391 * @chan: The current channel (from remain_on_channel request)
4392 * @duration: Duration in milliseconds that the driver intents to remain on the
4394 * @gfp: allocation flags
4396 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4397 struct ieee80211_channel *chan,
4398 unsigned int duration, gfp_t gfp);
4401 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4402 * @wdev: wireless device
4403 * @cookie: the request cookie
4404 * @chan: The current channel (from remain_on_channel request)
4405 * @gfp: allocation flags
4407 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4408 struct ieee80211_channel *chan,
4413 * cfg80211_new_sta - notify userspace about station
4416 * @mac_addr: the station's address
4417 * @sinfo: the station information
4418 * @gfp: allocation flags
4420 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4421 struct station_info *sinfo, gfp_t gfp);
4424 * cfg80211_del_sta - notify userspace about deletion of a station
4427 * @mac_addr: the station's address
4428 * @gfp: allocation flags
4430 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
4433 * cfg80211_conn_failed - connection request failed notification
4436 * @mac_addr: the station's address
4437 * @reason: the reason for connection failure
4438 * @gfp: allocation flags
4440 * Whenever a station tries to connect to an AP and if the station
4441 * could not connect to the AP as the AP has rejected the connection
4442 * for some reasons, this function is called.
4444 * The reason for connection failure can be any of the value from
4445 * nl80211_connect_failed_reason enum
4447 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4448 enum nl80211_connect_failed_reason reason,
4452 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4453 * @wdev: wireless device receiving the frame
4454 * @freq: Frequency on which the frame was received in MHz
4455 * @sig_dbm: signal strength in mBm, or 0 if unknown
4456 * @buf: Management frame (header + body)
4457 * @len: length of the frame data
4458 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4460 * This function is called whenever an Action frame is received for a station
4461 * mode interface, but is not processed in kernel.
4463 * Return: %true if a user space application has registered for this frame.
4464 * For action frames, that makes it responsible for rejecting unrecognized
4465 * action frames; %false otherwise, in which case for action frames the
4466 * driver is responsible for rejecting the frame.
4468 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4469 const u8 *buf, size_t len, u32 flags);
4472 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4473 * @wdev: wireless device receiving the frame
4474 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4475 * @buf: Management frame (header + body)
4476 * @len: length of the frame data
4477 * @ack: Whether frame was acknowledged
4478 * @gfp: context flags
4480 * This function is called whenever a management frame was requested to be
4481 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4482 * transmission attempt.
4484 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4485 const u8 *buf, size_t len, bool ack, gfp_t gfp);
4489 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4490 * @dev: network device
4491 * @rssi_event: the triggered RSSI event
4492 * @gfp: context flags
4494 * This function is called when a configured connection quality monitoring
4495 * rssi threshold reached event occurs.
4497 void cfg80211_cqm_rssi_notify(struct net_device *dev,
4498 enum nl80211_cqm_rssi_threshold_event rssi_event,
4502 * cfg80211_radar_event - radar detection event
4504 * @chandef: chandef for the current channel
4505 * @gfp: context flags
4507 * This function is called when a radar is detected on the current chanenl.
4509 void cfg80211_radar_event(struct wiphy *wiphy,
4510 struct cfg80211_chan_def *chandef, gfp_t gfp);
4513 * cfg80211_cac_event - Channel availability check (CAC) event
4514 * @netdev: network device
4515 * @chandef: chandef for the current channel
4516 * @event: type of event
4517 * @gfp: context flags
4519 * This function is called when a Channel availability check (CAC) is finished
4520 * or aborted. This must be called to notify the completion of a CAC process,
4521 * also by full-MAC drivers.
4523 void cfg80211_cac_event(struct net_device *netdev,
4524 const struct cfg80211_chan_def *chandef,
4525 enum nl80211_radar_event event, gfp_t gfp);
4529 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4530 * @dev: network device
4531 * @peer: peer's MAC address
4532 * @num_packets: how many packets were lost -- should be a fixed threshold
4533 * but probably no less than maybe 50, or maybe a throughput dependent
4534 * threshold (to account for temporary interference)
4535 * @gfp: context flags
4537 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4538 const u8 *peer, u32 num_packets, gfp_t gfp);
4541 * cfg80211_cqm_txe_notify - TX error rate event
4542 * @dev: network device
4543 * @peer: peer's MAC address
4544 * @num_packets: how many packets were lost
4545 * @rate: % of packets which failed transmission
4546 * @intvl: interval (in s) over which the TX failure threshold was breached.
4547 * @gfp: context flags
4549 * Notify userspace when configured % TX failures over number of packets in a
4550 * given interval is exceeded.
4552 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4553 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4556 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4557 * @dev: network device
4558 * @bssid: BSSID of AP (to avoid races)
4559 * @replay_ctr: new replay counter
4560 * @gfp: allocation flags
4562 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4563 const u8 *replay_ctr, gfp_t gfp);
4566 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4567 * @dev: network device
4568 * @index: candidate index (the smaller the index, the higher the priority)
4569 * @bssid: BSSID of AP
4570 * @preauth: Whether AP advertises support for RSN pre-authentication
4571 * @gfp: allocation flags
4573 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4574 const u8 *bssid, bool preauth, gfp_t gfp);
4577 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4578 * @dev: The device the frame matched to
4579 * @addr: the transmitter address
4580 * @gfp: context flags
4582 * This function is used in AP mode (only!) to inform userspace that
4583 * a spurious class 3 frame was received, to be able to deauth the
4585 * Return: %true if the frame was passed to userspace (or this failed
4586 * for a reason other than not having a subscription.)
4588 bool cfg80211_rx_spurious_frame(struct net_device *dev,
4589 const u8 *addr, gfp_t gfp);
4592 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4593 * @dev: The device the frame matched to
4594 * @addr: the transmitter address
4595 * @gfp: context flags
4597 * This function is used in AP mode (only!) to inform userspace that
4598 * an associated station sent a 4addr frame but that wasn't expected.
4599 * It is allowed and desirable to send this event only once for each
4600 * station to avoid event flooding.
4601 * Return: %true if the frame was passed to userspace (or this failed
4602 * for a reason other than not having a subscription.)
4604 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4605 const u8 *addr, gfp_t gfp);
4608 * cfg80211_probe_status - notify userspace about probe status
4609 * @dev: the device the probe was sent on
4610 * @addr: the address of the peer
4611 * @cookie: the cookie filled in @probe_client previously
4612 * @acked: indicates whether probe was acked or not
4613 * @gfp: allocation flags
4615 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4616 u64 cookie, bool acked, gfp_t gfp);
4619 * cfg80211_report_obss_beacon - report beacon from other APs
4620 * @wiphy: The wiphy that received the beacon
4622 * @len: length of the frame
4623 * @freq: frequency the frame was received on
4624 * @sig_dbm: signal strength in mBm, or 0 if unknown
4626 * Use this function to report to userspace when a beacon was
4627 * received. It is not useful to call this when there is no
4628 * netdev that is in AP/GO mode.
4630 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4631 const u8 *frame, size_t len,
4632 int freq, int sig_dbm);
4635 * cfg80211_reg_can_beacon - check if beaconing is allowed
4637 * @chandef: the channel definition
4638 * @iftype: interface type
4640 * Return: %true if there is no secondary channel or the secondary channel(s)
4641 * can be used for beaconing (i.e. is not a radar channel etc.)
4643 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4644 struct cfg80211_chan_def *chandef,
4645 enum nl80211_iftype iftype);
4648 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
4649 * @dev: the device which switched channels
4650 * @chandef: the new channel definition
4652 * Caller must acquire wdev_lock, therefore must only be called from sleepable
4655 void cfg80211_ch_switch_notify(struct net_device *dev,
4656 struct cfg80211_chan_def *chandef);
4659 * ieee80211_operating_class_to_band - convert operating class to band
4661 * @operating_class: the operating class to convert
4662 * @band: band pointer to fill
4664 * Returns %true if the conversion was successful, %false otherwise.
4666 bool ieee80211_operating_class_to_band(u8 operating_class,
4667 enum ieee80211_band *band);
4670 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
4671 * @dev: the device on which the operation is requested
4672 * @peer: the MAC address of the peer device
4673 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
4674 * NL80211_TDLS_TEARDOWN)
4675 * @reason_code: the reason code for teardown request
4676 * @gfp: allocation flags
4678 * This function is used to request userspace to perform TDLS operation that
4679 * requires knowledge of keys, i.e., link setup or teardown when the AP
4680 * connection uses encryption. This is optional mechanism for the driver to use
4681 * if it can automatically determine when a TDLS link could be useful (e.g.,
4682 * based on traffic and signal strength for a peer).
4684 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
4685 enum nl80211_tdls_operation oper,
4686 u16 reason_code, gfp_t gfp);
4689 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
4690 * @rate: given rate_info to calculate bitrate from
4692 * return 0 if MCS index >= 32
4694 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
4697 * cfg80211_unregister_wdev - remove the given wdev
4698 * @wdev: struct wireless_dev to remove
4700 * Call this function only for wdevs that have no netdev assigned,
4701 * e.g. P2P Devices. It removes the device from the list so that
4702 * it can no longer be used. It is necessary to call this function
4703 * even when cfg80211 requests the removal of the interface by
4704 * calling the del_virtual_intf() callback. The function must also
4705 * be called when the driver wishes to unregister the wdev, e.g.
4706 * when the device is unbound from the driver.
4708 * Requires the RTNL to be held.
4710 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
4713 * struct cfg80211_ft_event - FT Information Elements
4715 * @ies_len: length of the FT IE in bytes
4716 * @target_ap: target AP's MAC address
4718 * @ric_ies_len: length of the RIC IE in bytes
4720 struct cfg80211_ft_event_params {
4723 const u8 *target_ap;
4729 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
4730 * @netdev: network device
4731 * @ft_event: IE information
4733 void cfg80211_ft_event(struct net_device *netdev,
4734 struct cfg80211_ft_event_params *ft_event);
4737 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
4738 * @ies: the input IE buffer
4739 * @len: the input length
4740 * @attr: the attribute ID to find
4741 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
4742 * if the function is only called to get the needed buffer size
4743 * @bufsize: size of the output buffer
4745 * The function finds a given P2P attribute in the (vendor) IEs and
4746 * copies its contents to the given buffer.
4748 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
4749 * malformed or the attribute can't be found (respectively), or the
4750 * length of the found attribute (which can be zero).
4752 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
4753 enum ieee80211_p2p_attr_id attr,
4754 u8 *buf, unsigned int bufsize);
4757 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
4758 * @wdev: the wireless device reporting the wakeup
4759 * @wakeup: the wakeup report
4760 * @gfp: allocation flags
4762 * This function reports that the given device woke up. If it
4763 * caused the wakeup, report the reason(s), otherwise you may
4764 * pass %NULL as the @wakeup parameter to advertise that something
4765 * else caused the wakeup.
4767 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
4768 struct cfg80211_wowlan_wakeup *wakeup,
4772 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
4774 * @wdev: the wireless device for which critical protocol is stopped.
4775 * @gfp: allocation flags
4777 * This function can be called by the driver to indicate it has reverted
4778 * operation back to normal. One reason could be that the duration given
4779 * by .crit_proto_start() has expired.
4781 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
4784 * ieee80211_get_num_supported_channels - get number of channels device has
4787 * Return: the number of channels supported by the device.
4789 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
4792 * cfg80211_check_combinations - check interface combinations
4795 * @num_different_channels: the number of different channels we want
4796 * to use for verification
4797 * @radar_detect: a bitmap where each bit corresponds to a channel
4798 * width where radar detection is needed, as in the definition of
4799 * &struct ieee80211_iface_combination.@radar_detect_widths
4800 * @iftype_num: array with the numbers of interfaces of each interface
4801 * type. The index is the interface type as specified in &enum
4804 * This function can be called by the driver to check whether a
4805 * combination of interfaces and their types are allowed according to
4806 * the interface combinations.
4808 int cfg80211_check_combinations(struct wiphy *wiphy,
4809 const int num_different_channels,
4810 const u8 radar_detect,
4811 const int iftype_num[NUM_NL80211_IFTYPES]);
4814 * cfg80211_iter_combinations - iterate over matching combinations
4817 * @num_different_channels: the number of different channels we want
4818 * to use for verification
4819 * @radar_detect: a bitmap where each bit corresponds to a channel
4820 * width where radar detection is needed, as in the definition of
4821 * &struct ieee80211_iface_combination.@radar_detect_widths
4822 * @iftype_num: array with the numbers of interfaces of each interface
4823 * type. The index is the interface type as specified in &enum
4825 * @iter: function to call for each matching combination
4826 * @data: pointer to pass to iter function
4828 * This function can be called by the driver to check what possible
4829 * combinations it fits in at a given moment, e.g. for channel switching
4832 int cfg80211_iter_combinations(struct wiphy *wiphy,
4833 const int num_different_channels,
4834 const u8 radar_detect,
4835 const int iftype_num[NUM_NL80211_IFTYPES],
4836 void (*iter)(const struct ieee80211_iface_combination *c,
4841 * cfg80211_stop_iface - trigger interface disconnection
4844 * @wdev: wireless device
4845 * @gfp: context flags
4847 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
4850 * Note: This doesn't need any locks and is asynchronous.
4852 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
4856 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
4857 * @wiphy: the wiphy to shut down
4859 * This function shuts down all interfaces belonging to this wiphy by
4860 * calling dev_close() (and treating non-netdev interfaces as needed).
4861 * It shouldn't really be used unless there are some fatal device errors
4862 * that really can't be recovered in any other way.
4864 * Callers must hold the RTNL and be able to deal with callbacks into
4865 * the driver while the function is running.
4867 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
4870 /* ethtool helper */
4871 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
4873 /* Logging, debugging and troubleshooting/diagnostic helpers. */
4875 /* wiphy_printk helpers, similar to dev_printk */
4877 #define wiphy_printk(level, wiphy, format, args...) \
4878 dev_printk(level, &(wiphy)->dev, format, ##args)
4879 #define wiphy_emerg(wiphy, format, args...) \
4880 dev_emerg(&(wiphy)->dev, format, ##args)
4881 #define wiphy_alert(wiphy, format, args...) \
4882 dev_alert(&(wiphy)->dev, format, ##args)
4883 #define wiphy_crit(wiphy, format, args...) \
4884 dev_crit(&(wiphy)->dev, format, ##args)
4885 #define wiphy_err(wiphy, format, args...) \
4886 dev_err(&(wiphy)->dev, format, ##args)
4887 #define wiphy_warn(wiphy, format, args...) \
4888 dev_warn(&(wiphy)->dev, format, ##args)
4889 #define wiphy_notice(wiphy, format, args...) \
4890 dev_notice(&(wiphy)->dev, format, ##args)
4891 #define wiphy_info(wiphy, format, args...) \
4892 dev_info(&(wiphy)->dev, format, ##args)
4894 #define wiphy_debug(wiphy, format, args...) \
4895 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
4897 #define wiphy_dbg(wiphy, format, args...) \
4898 dev_dbg(&(wiphy)->dev, format, ##args)
4900 #if defined(VERBOSE_DEBUG)
4901 #define wiphy_vdbg wiphy_dbg
4903 #define wiphy_vdbg(wiphy, format, args...) \
4906 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
4912 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
4913 * of using a WARN/WARN_ON to get the message out, including the
4914 * file/line information and a backtrace.
4916 #define wiphy_WARN(wiphy, format, args...) \
4917 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
4919 #endif /* __NET_CFG80211_H */