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>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <net/regulatory.h>
27 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
28 * userspace and drivers, and offers some utility functionality associated
29 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
30 * by all modern wireless drivers in Linux, so that they offer a consistent
31 * API through nl80211. For backward compatibility, cfg80211 also offers
32 * wireless extensions to userspace, but hides them from drivers completely.
34 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
40 * DOC: Device registration
42 * In order for a driver to use cfg80211, it must register the hardware device
43 * with cfg80211. This happens through a number of hardware capability structs
46 * The fundamental structure for each device is the 'wiphy', of which each
47 * instance describes a physical wireless device connected to the system. Each
48 * such wiphy can have zero, one, or many virtual interfaces associated with
49 * it, which need to be identified as such by pointing the network interface's
50 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
51 * the wireless part of the interface, normally this struct is embedded in the
52 * network interface's private data area. Drivers can optionally allow creating
53 * or destroying virtual interfaces on the fly, but without at least one or the
54 * ability to create some the wireless device isn't useful.
56 * Each wiphy structure contains device capability information, and also has
57 * a pointer to the various operations the driver offers. The definitions and
58 * structures here describe these capabilities in detail.
64 * wireless hardware capability structures
68 * enum ieee80211_band - supported frequency bands
70 * The bands are assigned this way because the supported
71 * bitrates differ in these bands.
73 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
74 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
75 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
76 * @IEEE80211_NUM_BANDS: number of defined bands
79 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
80 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
81 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
88 * enum ieee80211_channel_flags - channel flags
90 * Channel flags set by the regulatory control code.
92 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
93 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
95 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
96 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
97 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
99 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
101 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
103 enum ieee80211_channel_flags {
104 IEEE80211_CHAN_DISABLED = 1<<0,
105 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
106 IEEE80211_CHAN_NO_IBSS = 1<<2,
107 IEEE80211_CHAN_RADAR = 1<<3,
108 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
109 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
110 IEEE80211_CHAN_NO_OFDM = 1<<6,
113 #define IEEE80211_CHAN_NO_HT40 \
114 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
117 * struct ieee80211_channel - channel definition
119 * This structure describes a single channel for use
122 * @center_freq: center frequency in MHz
123 * @hw_value: hardware-specific value for the channel
124 * @flags: channel flags from &enum ieee80211_channel_flags.
125 * @orig_flags: channel flags at registration time, used by regulatory
126 * code to support devices with additional restrictions
127 * @band: band this channel belongs to.
128 * @max_antenna_gain: maximum antenna gain in dBi
129 * @max_power: maximum transmission power (in dBm)
130 * @max_reg_power: maximum regulatory transmission power (in dBm)
131 * @beacon_found: helper to regulatory code to indicate when a beacon
132 * has been found on this channel. Use regulatory_hint_found_beacon()
133 * to enable this, this is useful only on 5 GHz band.
134 * @orig_mag: internal use
135 * @orig_mpwr: internal use
137 struct ieee80211_channel {
138 enum ieee80211_band band;
142 int max_antenna_gain;
147 int orig_mag, orig_mpwr;
151 * enum ieee80211_rate_flags - rate flags
153 * Hardware/specification flags for rates. These are structured
154 * in a way that allows using the same bitrate structure for
155 * different bands/PHY modes.
157 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
158 * preamble on this bitrate; only relevant in 2.4GHz band and
160 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
161 * when used with 802.11a (on the 5 GHz band); filled by the
162 * core code when registering the wiphy.
163 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
164 * when used with 802.11b (on the 2.4 GHz band); filled by the
165 * core code when registering the wiphy.
166 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
167 * when used with 802.11g (on the 2.4 GHz band); filled by the
168 * core code when registering the wiphy.
169 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
171 enum ieee80211_rate_flags {
172 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
173 IEEE80211_RATE_MANDATORY_A = 1<<1,
174 IEEE80211_RATE_MANDATORY_B = 1<<2,
175 IEEE80211_RATE_MANDATORY_G = 1<<3,
176 IEEE80211_RATE_ERP_G = 1<<4,
180 * struct ieee80211_rate - bitrate definition
182 * This structure describes a bitrate that an 802.11 PHY can
183 * operate with. The two values @hw_value and @hw_value_short
184 * are only for driver use when pointers to this structure are
187 * @flags: rate-specific flags
188 * @bitrate: bitrate in units of 100 Kbps
189 * @hw_value: driver/hardware value for this rate
190 * @hw_value_short: driver/hardware value for this rate when
191 * short preamble is used
193 struct ieee80211_rate {
196 u16 hw_value, hw_value_short;
200 * struct ieee80211_sta_ht_cap - STA's HT capabilities
202 * This structure describes most essential parameters needed
203 * to describe 802.11n HT capabilities for an STA.
205 * @ht_supported: is HT supported by the STA
206 * @cap: HT capabilities map as described in 802.11n spec
207 * @ampdu_factor: Maximum A-MPDU length factor
208 * @ampdu_density: Minimum A-MPDU spacing
209 * @mcs: Supported MCS rates
211 struct ieee80211_sta_ht_cap {
212 u16 cap; /* use IEEE80211_HT_CAP_ */
216 struct ieee80211_mcs_info mcs;
220 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
222 * This structure describes most essential parameters needed
223 * to describe 802.11ac VHT capabilities for an STA.
225 * @vht_supported: is VHT supported by the STA
226 * @cap: VHT capabilities map as described in 802.11ac spec
227 * @vht_mcs: Supported VHT MCS rates
229 struct ieee80211_sta_vht_cap {
231 u32 cap; /* use IEEE80211_VHT_CAP_ */
232 struct ieee80211_vht_mcs_info vht_mcs;
236 * struct ieee80211_supported_band - frequency band definition
238 * This structure describes a frequency band a wiphy
239 * is able to operate in.
241 * @channels: Array of channels the hardware can operate in
243 * @band: the band this structure represents
244 * @n_channels: Number of channels in @channels
245 * @bitrates: Array of bitrates the hardware can operate with
246 * in this band. Must be sorted to give a valid "supported
247 * rates" IE, i.e. CCK rates first, then OFDM.
248 * @n_bitrates: Number of bitrates in @bitrates
249 * @ht_cap: HT capabilities in this band
250 * @vht_cap: VHT capabilities in this band
252 struct ieee80211_supported_band {
253 struct ieee80211_channel *channels;
254 struct ieee80211_rate *bitrates;
255 enum ieee80211_band band;
258 struct ieee80211_sta_ht_cap ht_cap;
259 struct ieee80211_sta_vht_cap vht_cap;
263 * Wireless hardware/device configuration structures and methods
267 * DOC: Actions and configuration
269 * Each wireless device and each virtual interface offer a set of configuration
270 * operations and other actions that are invoked by userspace. Each of these
271 * actions is described in the operations structure, and the parameters these
272 * operations use are described separately.
274 * Additionally, some operations are asynchronous and expect to get status
275 * information via some functions that drivers need to call.
277 * Scanning and BSS list handling with its associated functionality is described
278 * in a separate chapter.
282 * struct vif_params - describes virtual interface parameters
283 * @use_4addr: use 4-address frames
290 * struct key_params - key information
292 * Information about a key
295 * @key_len: length of key material
296 * @cipher: cipher suite selector
297 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
298 * with the get_key() callback, must be in little endian,
299 * length given by @seq_len.
300 * @seq_len: length of @seq.
311 * struct cfg80211_chan_def - channel definition
312 * @chan: the (control) channel
313 * @width: channel width
314 * @center_freq1: center frequency of first segment
315 * @center_freq2: center frequency of second segment
316 * (only with 80+80 MHz)
318 struct cfg80211_chan_def {
319 struct ieee80211_channel *chan;
320 enum nl80211_chan_width width;
326 * cfg80211_get_chandef_type - return old channel type from chandef
327 * @chandef: the channel definition
329 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
330 * chandef, which must have a bandwidth allowing this conversion.
332 static inline enum nl80211_channel_type
333 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
335 switch (chandef->width) {
336 case NL80211_CHAN_WIDTH_20_NOHT:
337 return NL80211_CHAN_NO_HT;
338 case NL80211_CHAN_WIDTH_20:
339 return NL80211_CHAN_HT20;
340 case NL80211_CHAN_WIDTH_40:
341 if (chandef->center_freq1 > chandef->chan->center_freq)
342 return NL80211_CHAN_HT40PLUS;
343 return NL80211_CHAN_HT40MINUS;
346 return NL80211_CHAN_NO_HT;
351 * cfg80211_chandef_create - create channel definition using channel type
352 * @chandef: the channel definition struct to fill
353 * @channel: the control channel
354 * @chantype: the channel type
356 * Given a channel type, create a channel definition.
358 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
359 struct ieee80211_channel *channel,
360 enum nl80211_channel_type chantype);
363 * cfg80211_chandef_identical - check if two channel definitions are identical
364 * @chandef1: first channel definition
365 * @chandef2: second channel definition
367 * Return: %true if the channels defined by the channel definitions are
368 * identical, %false otherwise.
371 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
372 const struct cfg80211_chan_def *chandef2)
374 return (chandef1->chan == chandef2->chan &&
375 chandef1->width == chandef2->width &&
376 chandef1->center_freq1 == chandef2->center_freq1 &&
377 chandef1->center_freq2 == chandef2->center_freq2);
381 * cfg80211_chandef_compatible - check if two channel definitions are compatible
382 * @chandef1: first channel definition
383 * @chandef2: second channel definition
385 * Return: %NULL if the given channel definitions are incompatible,
386 * chandef1 or chandef2 otherwise.
388 const struct cfg80211_chan_def *
389 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
390 const struct cfg80211_chan_def *chandef2);
393 * cfg80211_chandef_valid - check if a channel definition is valid
394 * @chandef: the channel definition to check
395 * Return: %true if the channel definition is valid. %false otherwise.
397 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
400 * cfg80211_chandef_usable - check if secondary channels can be used
401 * @wiphy: the wiphy to validate against
402 * @chandef: the channel definition to check
403 * @prohibited_flags: the regulatory channel flags that must not be set
404 * Return: %true if secondary channels are usable. %false otherwise.
406 bool cfg80211_chandef_usable(struct wiphy *wiphy,
407 const struct cfg80211_chan_def *chandef,
408 u32 prohibited_flags);
411 * enum survey_info_flags - survey information flags
413 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
414 * @SURVEY_INFO_IN_USE: channel is currently being used
415 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
416 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
417 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
418 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
419 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
421 * Used by the driver to indicate which info in &struct survey_info
422 * it has filled in during the get_survey().
424 enum survey_info_flags {
425 SURVEY_INFO_NOISE_DBM = 1<<0,
426 SURVEY_INFO_IN_USE = 1<<1,
427 SURVEY_INFO_CHANNEL_TIME = 1<<2,
428 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
429 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
430 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
431 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
435 * struct survey_info - channel survey response
437 * @channel: the channel this survey record reports, mandatory
438 * @filled: bitflag of flags from &enum survey_info_flags
439 * @noise: channel noise in dBm. This and all following fields are
441 * @channel_time: amount of time in ms the radio spent on the channel
442 * @channel_time_busy: amount of time the primary channel was sensed busy
443 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
444 * @channel_time_rx: amount of time the radio spent receiving data
445 * @channel_time_tx: amount of time the radio spent transmitting data
447 * Used by dump_survey() to report back per-channel survey information.
449 * This structure can later be expanded with things like
450 * channel duty cycle etc.
453 struct ieee80211_channel *channel;
455 u64 channel_time_busy;
456 u64 channel_time_ext_busy;
464 * struct cfg80211_crypto_settings - Crypto settings
465 * @wpa_versions: indicates which, if any, WPA versions are enabled
466 * (from enum nl80211_wpa_versions)
467 * @cipher_group: group key cipher suite (or 0 if unset)
468 * @n_ciphers_pairwise: number of AP supported unicast ciphers
469 * @ciphers_pairwise: unicast key cipher suites
470 * @n_akm_suites: number of AKM suites
471 * @akm_suites: AKM suites
472 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
473 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
474 * required to assume that the port is unauthorized until authorized by
475 * user space. Otherwise, port is marked authorized by default.
476 * @control_port_ethertype: the control port protocol that should be
477 * allowed through even on unauthorized ports
478 * @control_port_no_encrypt: TRUE to prevent encryption of control port
481 struct cfg80211_crypto_settings {
484 int n_ciphers_pairwise;
485 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
487 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
489 __be16 control_port_ethertype;
490 bool control_port_no_encrypt;
494 * struct cfg80211_beacon_data - beacon data
495 * @head: head portion of beacon (before TIM IE)
496 * or %NULL if not changed
497 * @tail: tail portion of beacon (after TIM IE)
498 * or %NULL if not changed
499 * @head_len: length of @head
500 * @tail_len: length of @tail
501 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
502 * @beacon_ies_len: length of beacon_ies in octets
503 * @proberesp_ies: extra information element(s) to add into Probe Response
505 * @proberesp_ies_len: length of proberesp_ies in octets
506 * @assocresp_ies: extra information element(s) to add into (Re)Association
507 * Response frames or %NULL
508 * @assocresp_ies_len: length of assocresp_ies in octets
509 * @probe_resp_len: length of probe response template (@probe_resp)
510 * @probe_resp: probe response template (AP mode only)
512 struct cfg80211_beacon_data {
513 const u8 *head, *tail;
514 const u8 *beacon_ies;
515 const u8 *proberesp_ies;
516 const u8 *assocresp_ies;
517 const u8 *probe_resp;
519 size_t head_len, tail_len;
520 size_t beacon_ies_len;
521 size_t proberesp_ies_len;
522 size_t assocresp_ies_len;
523 size_t probe_resp_len;
527 * struct cfg80211_ap_settings - AP configuration
529 * Used to configure an AP interface.
531 * @chandef: defines the channel to use
532 * @beacon: beacon data
533 * @beacon_interval: beacon interval
534 * @dtim_period: DTIM period
535 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
537 * @ssid_len: length of @ssid
538 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
539 * @crypto: crypto settings
540 * @privacy: the BSS uses privacy
541 * @auth_type: Authentication type (algorithm)
542 * @inactivity_timeout: time in seconds to determine station's inactivity.
543 * @p2p_ctwindow: P2P CT Window
544 * @p2p_opp_ps: P2P opportunistic PS
546 struct cfg80211_ap_settings {
547 struct cfg80211_chan_def chandef;
549 struct cfg80211_beacon_data beacon;
551 int beacon_interval, dtim_period;
554 enum nl80211_hidden_ssid hidden_ssid;
555 struct cfg80211_crypto_settings crypto;
557 enum nl80211_auth_type auth_type;
558 int inactivity_timeout;
564 * enum plink_action - actions to perform in mesh peers
566 * @PLINK_ACTION_INVALID: action 0 is reserved
567 * @PLINK_ACTION_OPEN: start mesh peer link establishment
568 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
571 PLINK_ACTION_INVALID,
577 * enum station_parameters_apply_mask - station parameter values to apply
578 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
580 * Not all station parameters have in-band "no change" signalling,
581 * for those that don't these flags will are used.
583 enum station_parameters_apply_mask {
584 STATION_PARAM_APPLY_UAPSD = BIT(0),
588 * struct station_parameters - station parameters
590 * Used to change and create a new station.
592 * @vlan: vlan interface station should belong to
593 * @supported_rates: supported rates in IEEE 802.11 format
594 * (or NULL for no change)
595 * @supported_rates_len: number of supported rates
596 * @sta_flags_mask: station flags that changed
597 * (bitmask of BIT(NL80211_STA_FLAG_...))
598 * @sta_flags_set: station flags values
599 * (bitmask of BIT(NL80211_STA_FLAG_...))
600 * @listen_interval: listen interval or -1 for no change
601 * @aid: AID or zero for no change
602 * @plink_action: plink action to take
603 * @plink_state: set the peer link state for a station
604 * @ht_capa: HT capabilities of station
605 * @vht_capa: VHT capabilities of station
606 * @uapsd_queues: bitmap of queues configured for uapsd. same format
607 * as the AC bitmap in the QoS info field
608 * @max_sp: max Service Period. same format as the MAX_SP in the
609 * QoS info field (but already shifted down)
610 * @sta_modify_mask: bitmap indicating which parameters changed
611 * (for those that don't have a natural "no change" value),
612 * see &enum station_parameters_apply_mask
614 struct station_parameters {
616 struct net_device *vlan;
617 u32 sta_flags_mask, sta_flags_set;
621 u8 supported_rates_len;
624 struct ieee80211_ht_cap *ht_capa;
625 struct ieee80211_vht_cap *vht_capa;
631 * enum station_info_flags - station information flags
633 * Used by the driver to indicate which info in &struct station_info
634 * it has filled in during get_station() or dump_station().
636 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
637 * @STATION_INFO_RX_BYTES: @rx_bytes filled
638 * @STATION_INFO_TX_BYTES: @tx_bytes filled
639 * @STATION_INFO_LLID: @llid filled
640 * @STATION_INFO_PLID: @plid filled
641 * @STATION_INFO_PLINK_STATE: @plink_state filled
642 * @STATION_INFO_SIGNAL: @signal filled
643 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
644 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
645 * @STATION_INFO_RX_PACKETS: @rx_packets filled
646 * @STATION_INFO_TX_PACKETS: @tx_packets filled
647 * @STATION_INFO_TX_RETRIES: @tx_retries filled
648 * @STATION_INFO_TX_FAILED: @tx_failed filled
649 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
650 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
651 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
652 * @STATION_INFO_BSS_PARAM: @bss_param filled
653 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
654 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
655 * @STATION_INFO_STA_FLAGS: @sta_flags filled
656 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
657 * @STATION_INFO_T_OFFSET: @t_offset filled
659 enum station_info_flags {
660 STATION_INFO_INACTIVE_TIME = 1<<0,
661 STATION_INFO_RX_BYTES = 1<<1,
662 STATION_INFO_TX_BYTES = 1<<2,
663 STATION_INFO_LLID = 1<<3,
664 STATION_INFO_PLID = 1<<4,
665 STATION_INFO_PLINK_STATE = 1<<5,
666 STATION_INFO_SIGNAL = 1<<6,
667 STATION_INFO_TX_BITRATE = 1<<7,
668 STATION_INFO_RX_PACKETS = 1<<8,
669 STATION_INFO_TX_PACKETS = 1<<9,
670 STATION_INFO_TX_RETRIES = 1<<10,
671 STATION_INFO_TX_FAILED = 1<<11,
672 STATION_INFO_RX_DROP_MISC = 1<<12,
673 STATION_INFO_SIGNAL_AVG = 1<<13,
674 STATION_INFO_RX_BITRATE = 1<<14,
675 STATION_INFO_BSS_PARAM = 1<<15,
676 STATION_INFO_CONNECTED_TIME = 1<<16,
677 STATION_INFO_ASSOC_REQ_IES = 1<<17,
678 STATION_INFO_STA_FLAGS = 1<<18,
679 STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
680 STATION_INFO_T_OFFSET = 1<<20,
684 * enum station_info_rate_flags - bitrate info flags
686 * Used by the driver to indicate the specific rate transmission
687 * type for 802.11n transmissions.
689 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
690 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
691 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
692 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
693 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
694 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
695 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
696 * @RATE_INFO_FLAGS_60G: 60GHz MCS
698 enum rate_info_flags {
699 RATE_INFO_FLAGS_MCS = BIT(0),
700 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
701 RATE_INFO_FLAGS_40_MHZ_WIDTH = BIT(2),
702 RATE_INFO_FLAGS_80_MHZ_WIDTH = BIT(3),
703 RATE_INFO_FLAGS_80P80_MHZ_WIDTH = BIT(4),
704 RATE_INFO_FLAGS_160_MHZ_WIDTH = BIT(5),
705 RATE_INFO_FLAGS_SHORT_GI = BIT(6),
706 RATE_INFO_FLAGS_60G = BIT(7),
710 * struct rate_info - bitrate information
712 * Information about a receiving or transmitting bitrate
714 * @flags: bitflag of flags from &enum rate_info_flags
715 * @mcs: mcs index if struct describes a 802.11n bitrate
716 * @legacy: bitrate in 100kbit/s for 802.11abg
717 * @nss: number of streams (VHT only)
727 * enum station_info_rate_flags - bitrate info flags
729 * Used by the driver to indicate the specific rate transmission
730 * type for 802.11n transmissions.
732 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
733 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
734 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
736 enum bss_param_flags {
737 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
738 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
739 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
743 * struct sta_bss_parameters - BSS parameters for the attached station
745 * Information about the currently associated BSS
747 * @flags: bitflag of flags from &enum bss_param_flags
748 * @dtim_period: DTIM period for the BSS
749 * @beacon_interval: beacon interval
751 struct sta_bss_parameters {
758 * struct station_info - station information
760 * Station information filled by driver for get_station() and dump_station.
762 * @filled: bitflag of flags from &enum station_info_flags
763 * @connected_time: time(in secs) since a station is last connected
764 * @inactive_time: time since last station activity (tx/rx) in milliseconds
765 * @rx_bytes: bytes received from this station
766 * @tx_bytes: bytes transmitted to this station
767 * @llid: mesh local link id
768 * @plid: mesh peer link id
769 * @plink_state: mesh peer link state
770 * @signal: The signal strength, type depends on the wiphy's signal_type.
771 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
772 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
773 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
774 * @txrate: current unicast bitrate from this station
775 * @rxrate: current unicast bitrate to this station
776 * @rx_packets: packets received from this station
777 * @tx_packets: packets transmitted to this station
778 * @tx_retries: cumulative retry counts
779 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
780 * @rx_dropped_misc: Dropped for un-specified reason.
781 * @bss_param: current BSS parameters
782 * @generation: generation number for nl80211 dumps.
783 * This number should increase every time the list of stations
784 * changes, i.e. when a station is added or removed, so that
785 * userspace can tell whether it got a consistent snapshot.
786 * @assoc_req_ies: IEs from (Re)Association Request.
787 * This is used only when in AP mode with drivers that do not use
788 * user space MLME/SME implementation. The information is provided for
789 * the cfg80211_new_sta() calls to notify user space of the IEs.
790 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
791 * @sta_flags: station flags mask & values
792 * @beacon_loss_count: Number of times beacon loss event has triggered.
793 * @t_offset: Time offset of the station relative to this host.
795 struct station_info {
806 struct rate_info txrate;
807 struct rate_info rxrate;
813 struct sta_bss_parameters bss_param;
814 struct nl80211_sta_flag_update sta_flags;
818 const u8 *assoc_req_ies;
819 size_t assoc_req_ies_len;
821 u32 beacon_loss_count;
825 * Note: Add a new enum station_info_flags value for each new field and
826 * use it to check which fields are initialized.
831 * enum monitor_flags - monitor flags
833 * Monitor interface configuration flags. Note that these must be the bits
834 * according to the nl80211 flags.
836 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
837 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
838 * @MONITOR_FLAG_CONTROL: pass control frames
839 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
840 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
843 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
844 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
845 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
846 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
847 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
851 * enum mpath_info_flags - mesh path information flags
853 * Used by the driver to indicate which info in &struct mpath_info it has filled
854 * in during get_station() or dump_station().
856 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
857 * @MPATH_INFO_SN: @sn filled
858 * @MPATH_INFO_METRIC: @metric filled
859 * @MPATH_INFO_EXPTIME: @exptime filled
860 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
861 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
862 * @MPATH_INFO_FLAGS: @flags filled
864 enum mpath_info_flags {
865 MPATH_INFO_FRAME_QLEN = BIT(0),
866 MPATH_INFO_SN = BIT(1),
867 MPATH_INFO_METRIC = BIT(2),
868 MPATH_INFO_EXPTIME = BIT(3),
869 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
870 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
871 MPATH_INFO_FLAGS = BIT(6),
875 * struct mpath_info - mesh path information
877 * Mesh path information filled by driver for get_mpath() and dump_mpath().
879 * @filled: bitfield of flags from &enum mpath_info_flags
880 * @frame_qlen: number of queued frames for this destination
881 * @sn: target sequence number
882 * @metric: metric (cost) of this mesh path
883 * @exptime: expiration time for the mesh path from now, in msecs
884 * @flags: mesh path flags
885 * @discovery_timeout: total mesh path discovery timeout, in msecs
886 * @discovery_retries: mesh path discovery retries
887 * @generation: generation number for nl80211 dumps.
888 * This number should increase every time the list of mesh paths
889 * changes, i.e. when a station is added or removed, so that
890 * userspace can tell whether it got a consistent snapshot.
898 u32 discovery_timeout;
899 u8 discovery_retries;
906 * struct bss_parameters - BSS parameters
908 * Used to change BSS parameters (mainly for AP mode).
910 * @use_cts_prot: Whether to use CTS protection
911 * (0 = no, 1 = yes, -1 = do not change)
912 * @use_short_preamble: Whether the use of short preambles is allowed
913 * (0 = no, 1 = yes, -1 = do not change)
914 * @use_short_slot_time: Whether the use of short slot time is allowed
915 * (0 = no, 1 = yes, -1 = do not change)
916 * @basic_rates: basic rates in IEEE 802.11 format
917 * (or NULL for no change)
918 * @basic_rates_len: number of basic rates
919 * @ap_isolate: do not forward packets between connected stations
920 * @ht_opmode: HT Operation mode
921 * (u16 = opmode, -1 = do not change)
922 * @p2p_ctwindow: P2P CT Window (-1 = no change)
923 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
925 struct bss_parameters {
927 int use_short_preamble;
928 int use_short_slot_time;
933 s8 p2p_ctwindow, p2p_opp_ps;
937 * struct mesh_config - 802.11s mesh configuration
939 * These parameters can be changed while the mesh is active.
941 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
942 * by the Mesh Peering Open message
943 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
944 * used by the Mesh Peering Open message
945 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
946 * the mesh peering management to close a mesh peering
947 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
949 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
950 * be sent to establish a new peer link instance in a mesh
951 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
952 * @element_ttl: the value of TTL field set at a mesh STA for path selection
954 * @auto_open_plinks: whether we should automatically open peer links when we
955 * detect compatible mesh peers
956 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
957 * synchronize to for 11s default synchronization method
958 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
959 * that an originator mesh STA can send to a particular path target
960 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
961 * @min_discovery_timeout: the minimum length of time to wait until giving up on
962 * a path discovery in milliseconds
963 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
964 * receiving a PREQ shall consider the forwarding information from the
965 * root to be valid. (TU = time unit)
966 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
967 * which a mesh STA can send only one action frame containing a PREQ
969 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
970 * which a mesh STA can send only one Action frame containing a PERR
972 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
973 * it takes for an HWMP information element to propagate across the mesh
974 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
975 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
976 * announcements are transmitted
977 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
978 * station has access to a broader network beyond the MBSS. (This is
979 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
980 * only means that the station will announce others it's a mesh gate, but
981 * not necessarily using the gate announcement protocol. Still keeping the
982 * same nomenclature to be in sync with the spec)
983 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
984 * entity (default is TRUE - forwarding entity)
985 * @rssi_threshold: the threshold for average signal strength of candidate
986 * station to establish a peer link
987 * @ht_opmode: mesh HT protection mode
989 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
990 * receiving a proactive PREQ shall consider the forwarding information to
991 * the root mesh STA to be valid.
993 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
994 * PREQs are transmitted.
995 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
996 * during which a mesh STA can send only one Action frame containing
997 * a PREQ element for root path confirmation.
1000 u16 dot11MeshRetryTimeout;
1001 u16 dot11MeshConfirmTimeout;
1002 u16 dot11MeshHoldingTimeout;
1003 u16 dot11MeshMaxPeerLinks;
1004 u8 dot11MeshMaxRetries;
1007 bool auto_open_plinks;
1008 u32 dot11MeshNbrOffsetMaxNeighbor;
1009 u8 dot11MeshHWMPmaxPREQretries;
1010 u32 path_refresh_time;
1011 u16 min_discovery_timeout;
1012 u32 dot11MeshHWMPactivePathTimeout;
1013 u16 dot11MeshHWMPpreqMinInterval;
1014 u16 dot11MeshHWMPperrMinInterval;
1015 u16 dot11MeshHWMPnetDiameterTraversalTime;
1016 u8 dot11MeshHWMPRootMode;
1017 u16 dot11MeshHWMPRannInterval;
1018 bool dot11MeshGateAnnouncementProtocol;
1019 bool dot11MeshForwarding;
1022 u32 dot11MeshHWMPactivePathToRootTimeout;
1023 u16 dot11MeshHWMProotInterval;
1024 u16 dot11MeshHWMPconfirmationInterval;
1028 * struct mesh_setup - 802.11s mesh setup configuration
1029 * @chandef: defines the channel to use
1030 * @mesh_id: the mesh ID
1031 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1032 * @sync_method: which synchronization method to use
1033 * @path_sel_proto: which path selection protocol to use
1034 * @path_metric: which metric to use
1035 * @ie: vendor information elements (optional)
1036 * @ie_len: length of vendor information elements
1037 * @is_authenticated: this mesh requires authentication
1038 * @is_secure: this mesh uses security
1039 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1041 * These parameters are fixed when the mesh is created.
1044 struct cfg80211_chan_def chandef;
1052 bool is_authenticated;
1054 int mcast_rate[IEEE80211_NUM_BANDS];
1058 * struct ieee80211_txq_params - TX queue parameters
1059 * @ac: AC identifier
1060 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1061 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1063 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1065 * @aifs: Arbitration interframe space [0..255]
1067 struct ieee80211_txq_params {
1076 * DOC: Scanning and BSS list handling
1078 * The scanning process itself is fairly simple, but cfg80211 offers quite
1079 * a bit of helper functionality. To start a scan, the scan operation will
1080 * be invoked with a scan definition. This scan definition contains the
1081 * channels to scan, and the SSIDs to send probe requests for (including the
1082 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1083 * probe. Additionally, a scan request may contain extra information elements
1084 * that should be added to the probe request. The IEs are guaranteed to be
1085 * well-formed, and will not exceed the maximum length the driver advertised
1086 * in the wiphy structure.
1088 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1089 * it is responsible for maintaining the BSS list; the driver should not
1090 * maintain a list itself. For this notification, various functions exist.
1092 * Since drivers do not maintain a BSS list, there are also a number of
1093 * functions to search for a BSS and obtain information about it from the
1094 * BSS structure cfg80211 maintains. The BSS list is also made available
1099 * struct cfg80211_ssid - SSID description
1101 * @ssid_len: length of the ssid
1103 struct cfg80211_ssid {
1104 u8 ssid[IEEE80211_MAX_SSID_LEN];
1109 * struct cfg80211_scan_request - scan request description
1111 * @ssids: SSIDs to scan for (active scan only)
1112 * @n_ssids: number of SSIDs
1113 * @channels: channels to scan on.
1114 * @n_channels: total number of channels to scan
1115 * @ie: optional information element(s) to add into Probe Request or %NULL
1116 * @ie_len: length of ie in octets
1117 * @flags: bit field of flags controlling operation
1118 * @rates: bitmap of rates to advertise for each band
1119 * @wiphy: the wiphy this was for
1120 * @scan_start: time (in jiffies) when the scan started
1121 * @wdev: the wireless device to scan for
1122 * @aborted: (internal) scan request was notified as aborted
1123 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1125 struct cfg80211_scan_request {
1126 struct cfg80211_ssid *ssids;
1133 u32 rates[IEEE80211_NUM_BANDS];
1135 struct wireless_dev *wdev;
1138 struct wiphy *wiphy;
1139 unsigned long scan_start;
1144 struct ieee80211_channel *channels[0];
1148 * struct cfg80211_match_set - sets of attributes to match
1150 * @ssid: SSID to be matched
1152 struct cfg80211_match_set {
1153 struct cfg80211_ssid ssid;
1157 * struct cfg80211_sched_scan_request - scheduled scan request description
1159 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1160 * @n_ssids: number of SSIDs
1161 * @n_channels: total number of channels to scan
1162 * @interval: interval between each scheduled scan cycle
1163 * @ie: optional information element(s) to add into Probe Request or %NULL
1164 * @ie_len: length of ie in octets
1165 * @flags: bit field of flags controlling operation
1166 * @match_sets: sets of parameters to be matched for a scan result
1167 * entry to be considered valid and to be passed to the host
1168 * (others are filtered out).
1169 * If ommited, all results are passed.
1170 * @n_match_sets: number of match sets
1171 * @wiphy: the wiphy this was for
1172 * @dev: the interface
1173 * @channels: channels to scan
1174 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1176 struct cfg80211_sched_scan_request {
1177 struct cfg80211_ssid *ssids;
1184 struct cfg80211_match_set *match_sets;
1189 struct wiphy *wiphy;
1190 struct net_device *dev;
1191 unsigned long scan_start;
1194 struct ieee80211_channel *channels[0];
1198 * enum cfg80211_signal_type - signal type
1200 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1201 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1202 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1204 enum cfg80211_signal_type {
1205 CFG80211_SIGNAL_TYPE_NONE,
1206 CFG80211_SIGNAL_TYPE_MBM,
1207 CFG80211_SIGNAL_TYPE_UNSPEC,
1211 * struct cfg80211_bss_ie_data - BSS entry IE data
1212 * @rcu_head: internal use, for freeing
1213 * @len: length of the IEs
1216 struct cfg80211_bss_ies {
1217 struct rcu_head rcu_head;
1223 * struct cfg80211_bss - BSS description
1225 * This structure describes a BSS (which may also be a mesh network)
1226 * for use in scan results and similar.
1228 * @channel: channel this BSS is on
1229 * @bssid: BSSID of the BSS
1230 * @tsf: timestamp of last received update
1231 * @beacon_interval: the beacon interval as from the frame
1232 * @capability: the capability field in host byte order
1233 * @ies: the information elements (Note that there
1234 * is no guarantee that these are well-formed!); this is a pointer to
1235 * either the beacon_ies or proberesp_ies depending on whether Probe
1236 * Response frame has been received
1237 * @beacon_ies: the information elements from the last Beacon frame
1238 * @proberesp_ies: the information elements from the last Probe Response frame
1239 * @signal: signal strength value (type depends on the wiphy's signal_type)
1240 * @free_priv: function pointer to free private data
1241 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1243 struct cfg80211_bss {
1246 struct ieee80211_channel *channel;
1248 const struct cfg80211_bss_ies __rcu *ies;
1249 const struct cfg80211_bss_ies __rcu *beacon_ies;
1250 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1252 void (*free_priv)(struct cfg80211_bss *bss);
1256 u16 beacon_interval;
1261 u8 priv[0] __aligned(sizeof(void *));
1265 * ieee80211_bss_get_ie - find IE with given ID
1266 * @bss: the bss to search
1269 * Note that the return value is an RCU-protected pointer, so
1270 * rcu_read_lock() must be held when calling this function.
1271 * Return: %NULL if not found.
1273 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1277 * struct cfg80211_auth_request - Authentication request data
1279 * This structure provides information needed to complete IEEE 802.11
1282 * @bss: The BSS to authenticate with.
1283 * @auth_type: Authentication type (algorithm)
1284 * @ie: Extra IEs to add to Authentication frame or %NULL
1285 * @ie_len: Length of ie buffer in octets
1286 * @key_len: length of WEP key for shared key authentication
1287 * @key_idx: index of WEP key for shared key authentication
1288 * @key: WEP key for shared key authentication
1289 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1290 * Authentication transaction sequence number field.
1291 * @sae_data_len: Length of sae_data buffer in octets
1293 struct cfg80211_auth_request {
1294 struct cfg80211_bss *bss;
1297 enum nl80211_auth_type auth_type;
1299 u8 key_len, key_idx;
1301 size_t sae_data_len;
1305 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1307 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1309 enum cfg80211_assoc_req_flags {
1310 ASSOC_REQ_DISABLE_HT = BIT(0),
1314 * struct cfg80211_assoc_request - (Re)Association request data
1316 * This structure provides information needed to complete IEEE 802.11
1318 * @bss: The BSS to associate with. If the call is successful the driver
1319 * is given a reference that it must release, normally via a call to
1320 * cfg80211_send_rx_assoc(), or, if association timed out, with a
1321 * call to cfg80211_put_bss() (in addition to calling
1322 * cfg80211_send_assoc_timeout())
1323 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1324 * @ie_len: Length of ie buffer in octets
1325 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1326 * @crypto: crypto settings
1327 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1328 * @flags: See &enum cfg80211_assoc_req_flags
1329 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1330 * will be used in ht_capa. Un-supported values will be ignored.
1331 * @ht_capa_mask: The bits of ht_capa which are to be used.
1333 struct cfg80211_assoc_request {
1334 struct cfg80211_bss *bss;
1335 const u8 *ie, *prev_bssid;
1337 struct cfg80211_crypto_settings crypto;
1340 struct ieee80211_ht_cap ht_capa;
1341 struct ieee80211_ht_cap ht_capa_mask;
1345 * struct cfg80211_deauth_request - Deauthentication request data
1347 * This structure provides information needed to complete IEEE 802.11
1350 * @bssid: the BSSID of the BSS to deauthenticate from
1351 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1352 * @ie_len: Length of ie buffer in octets
1353 * @reason_code: The reason code for the deauthentication
1355 struct cfg80211_deauth_request {
1360 bool local_state_change;
1364 * struct cfg80211_disassoc_request - Disassociation request data
1366 * This structure provides information needed to complete IEEE 802.11
1369 * @bss: the BSS to disassociate from
1370 * @ie: Extra IEs to add to Disassociation frame or %NULL
1371 * @ie_len: Length of ie buffer in octets
1372 * @reason_code: The reason code for the disassociation
1373 * @local_state_change: This is a request for a local state only, i.e., no
1374 * Disassociation frame is to be transmitted.
1376 struct cfg80211_disassoc_request {
1377 struct cfg80211_bss *bss;
1381 bool local_state_change;
1385 * struct cfg80211_ibss_params - IBSS parameters
1387 * This structure defines the IBSS parameters for the join_ibss()
1390 * @ssid: The SSID, will always be non-null.
1391 * @ssid_len: The length of the SSID, will always be non-zero.
1392 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1393 * search for IBSSs with a different BSSID.
1394 * @chandef: defines the channel to use if no other IBSS to join can be found
1395 * @channel_fixed: The channel should be fixed -- do not search for
1396 * IBSSs to join on other channels.
1397 * @ie: information element(s) to include in the beacon
1398 * @ie_len: length of that
1399 * @beacon_interval: beacon interval to use
1400 * @privacy: this is a protected network, keys will be configured
1402 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1403 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1404 * required to assume that the port is unauthorized until authorized by
1405 * user space. Otherwise, port is marked authorized by default.
1406 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1407 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1409 struct cfg80211_ibss_params {
1412 struct cfg80211_chan_def chandef;
1414 u8 ssid_len, ie_len;
1415 u16 beacon_interval;
1420 int mcast_rate[IEEE80211_NUM_BANDS];
1424 * struct cfg80211_connect_params - Connection parameters
1426 * This structure provides information needed to complete IEEE 802.11
1427 * authentication and association.
1429 * @channel: The channel to use or %NULL if not specified (auto-select based
1431 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1434 * @ssid_len: Length of ssid in octets
1435 * @auth_type: Authentication type (algorithm)
1436 * @ie: IEs for association request
1437 * @ie_len: Length of assoc_ie in octets
1438 * @privacy: indicates whether privacy-enabled APs should be used
1439 * @crypto: crypto settings
1440 * @key_len: length of WEP key for shared key authentication
1441 * @key_idx: index of WEP key for shared key authentication
1442 * @key: WEP key for shared key authentication
1443 * @flags: See &enum cfg80211_assoc_req_flags
1444 * @bg_scan_period: Background scan period in seconds
1445 * or -1 to indicate that default value is to be used.
1446 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1447 * will be used in ht_capa. Un-supported values will be ignored.
1448 * @ht_capa_mask: The bits of ht_capa which are to be used.
1450 struct cfg80211_connect_params {
1451 struct ieee80211_channel *channel;
1455 enum nl80211_auth_type auth_type;
1459 struct cfg80211_crypto_settings crypto;
1461 u8 key_len, key_idx;
1464 struct ieee80211_ht_cap ht_capa;
1465 struct ieee80211_ht_cap ht_capa_mask;
1469 * enum wiphy_params_flags - set_wiphy_params bitfield values
1470 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1471 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1472 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1473 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1474 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1476 enum wiphy_params_flags {
1477 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1478 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1479 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1480 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1481 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1485 * cfg80211_bitrate_mask - masks for bitrate control
1487 struct cfg80211_bitrate_mask {
1490 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1491 } control[IEEE80211_NUM_BANDS];
1494 * struct cfg80211_pmksa - PMK Security Association
1496 * This structure is passed to the set/del_pmksa() method for PMKSA
1499 * @bssid: The AP's BSSID.
1500 * @pmkid: The PMK material itself.
1502 struct cfg80211_pmksa {
1508 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1509 * @mask: bitmask where to match pattern and where to ignore bytes,
1510 * one bit per byte, in same format as nl80211
1511 * @pattern: bytes to match where bitmask is 1
1512 * @pattern_len: length of pattern (in bytes)
1514 * Internal note: @mask and @pattern are allocated in one chunk of
1515 * memory, free @mask only!
1517 struct cfg80211_wowlan_trig_pkt_pattern {
1523 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1525 * This structure defines the enabled WoWLAN triggers for the device.
1526 * @any: wake up on any activity -- special trigger if device continues
1527 * operating as normal during suspend
1528 * @disconnect: wake up if getting disconnected
1529 * @magic_pkt: wake up on receiving magic packet
1530 * @patterns: wake up on receiving packet matching a pattern
1531 * @n_patterns: number of patterns
1532 * @gtk_rekey_failure: wake up on GTK rekey failure
1533 * @eap_identity_req: wake up on EAP identity request packet
1534 * @four_way_handshake: wake up on 4-way handshake
1535 * @rfkill_release: wake up when rfkill is released
1537 struct cfg80211_wowlan {
1538 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1539 eap_identity_req, four_way_handshake,
1541 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1546 * struct cfg80211_gtk_rekey_data - rekey data
1547 * @kek: key encryption key
1548 * @kck: key confirmation key
1549 * @replay_ctr: replay counter
1551 struct cfg80211_gtk_rekey_data {
1552 u8 kek[NL80211_KEK_LEN];
1553 u8 kck[NL80211_KCK_LEN];
1554 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1558 * struct cfg80211_ops - backend description for wireless configuration
1560 * This struct is registered by fullmac card drivers and/or wireless stacks
1561 * in order to handle configuration requests on their interfaces.
1563 * All callbacks except where otherwise noted should return 0
1564 * on success or a negative error code.
1566 * All operations are currently invoked under rtnl for consistency with the
1567 * wireless extensions but this is subject to reevaluation as soon as this
1568 * code is used more widely and we have a first user without wext.
1570 * @suspend: wiphy device needs to be suspended. The variable @wow will
1571 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1572 * configured for the device.
1573 * @resume: wiphy device needs to be resumed
1574 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1575 * to call device_set_wakeup_enable() to enable/disable wakeup from
1578 * @add_virtual_intf: create a new virtual interface with the given name,
1579 * must set the struct wireless_dev's iftype. Beware: You must create
1580 * the new netdev in the wiphy's network namespace! Returns the struct
1581 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
1582 * also set the address member in the wdev.
1584 * @del_virtual_intf: remove the virtual interface
1586 * @change_virtual_intf: change type/configuration of virtual interface,
1587 * keep the struct wireless_dev's iftype updated.
1589 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1590 * when adding a group key.
1592 * @get_key: get information about the key with the given parameters.
1593 * @mac_addr will be %NULL when requesting information for a group
1594 * key. All pointers given to the @callback function need not be valid
1595 * after it returns. This function should return an error if it is
1596 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1598 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1599 * and @key_index, return -ENOENT if the key doesn't exist.
1601 * @set_default_key: set the default key on an interface
1603 * @set_default_mgmt_key: set the default management frame key on an interface
1605 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1607 * @start_ap: Start acting in AP mode defined by the parameters.
1608 * @change_beacon: Change the beacon parameters for an access point mode
1609 * interface. This should reject the call when AP mode wasn't started.
1610 * @stop_ap: Stop being an AP, including stopping beaconing.
1612 * @add_station: Add a new station.
1613 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1614 * @change_station: Modify a given station. Note that flags changes are not much
1615 * validated in cfg80211, in particular the auth/assoc/authorized flags
1616 * might come to the driver in invalid combinations -- make sure to check
1617 * them, also against the existing state! Also, supported_rates changes are
1618 * not checked in station mode -- drivers need to reject (or ignore) them
1619 * for anything but TDLS peers.
1620 * @get_station: get station information for the station identified by @mac
1621 * @dump_station: dump station callback -- resume dump at index @idx
1623 * @add_mpath: add a fixed mesh path
1624 * @del_mpath: delete a given mesh path
1625 * @change_mpath: change a given mesh path
1626 * @get_mpath: get a mesh path for the given parameters
1627 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1628 * @join_mesh: join the mesh network with the specified parameters
1629 * @leave_mesh: leave the current mesh network
1631 * @get_mesh_config: Get the current mesh configuration
1633 * @update_mesh_config: Update mesh parameters on a running mesh.
1634 * The mask is a bitfield which tells us which parameters to
1635 * set, and which to leave alone.
1637 * @change_bss: Modify parameters for a given BSS.
1639 * @set_txq_params: Set TX queue parameters
1641 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
1642 * as it doesn't implement join_mesh and needs to set the channel to
1643 * join the mesh instead.
1645 * @set_monitor_channel: Set the monitor mode channel for the device. If other
1646 * interfaces are active this callback should reject the configuration.
1647 * If no interfaces are active or the device is down, the channel should
1648 * be stored for when a monitor interface becomes active.
1650 * @scan: Request to do a scan. If returning zero, the scan request is given
1651 * the driver, and will be valid until passed to cfg80211_scan_done().
1652 * For scan results, call cfg80211_inform_bss(); you can call this outside
1653 * the scan/scan_done bracket too.
1655 * @auth: Request to authenticate with the specified peer
1656 * @assoc: Request to (re)associate with the specified peer
1657 * @deauth: Request to deauthenticate from the specified peer
1658 * @disassoc: Request to disassociate from the specified peer
1660 * @connect: Connect to the ESS with the specified parameters. When connected,
1661 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1662 * If the connection fails for some reason, call cfg80211_connect_result()
1663 * with the status from the AP.
1664 * @disconnect: Disconnect from the BSS/ESS.
1666 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1667 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1669 * @leave_ibss: Leave the IBSS.
1671 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
1674 * @set_wiphy_params: Notify that wiphy parameters have changed;
1675 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1676 * have changed. The actual parameter values are available in
1677 * struct wiphy. If returning an error, no value should be changed.
1679 * @set_tx_power: set the transmit power according to the parameters,
1680 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
1681 * wdev may be %NULL if power was set for the wiphy, and will
1682 * always be %NULL unless the driver supports per-vif TX power
1683 * (as advertised by the nl80211 feature flag.)
1684 * @get_tx_power: store the current TX power into the dbm variable;
1685 * return 0 if successful
1687 * @set_wds_peer: set the WDS peer for a WDS interface
1689 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1690 * functions to adjust rfkill hw state
1692 * @dump_survey: get site survey information.
1694 * @remain_on_channel: Request the driver to remain awake on the specified
1695 * channel for the specified duration to complete an off-channel
1696 * operation (e.g., public action frame exchange). When the driver is
1697 * ready on the requested channel, it must indicate this with an event
1698 * notification by calling cfg80211_ready_on_channel().
1699 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1700 * This allows the operation to be terminated prior to timeout based on
1701 * the duration value.
1702 * @mgmt_tx: Transmit a management frame.
1703 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1704 * frame on another channel
1706 * @testmode_cmd: run a test mode command
1707 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1708 * used by the function, but 0 and 1 must not be touched. Additionally,
1709 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1710 * dump and return to userspace with an error, so be careful. If any data
1711 * was passed in from userspace then the data/len arguments will be present
1712 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1714 * @set_bitrate_mask: set the bitrate mask configuration
1716 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1717 * devices running firmwares capable of generating the (re) association
1718 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1719 * @del_pmksa: Delete a cached PMKID.
1720 * @flush_pmksa: Flush all cached PMKIDs.
1721 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1722 * allows the driver to adjust the dynamic ps timeout value.
1723 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1724 * @set_cqm_txe_config: Configure connection quality monitor TX error
1726 * @sched_scan_start: Tell the driver to start a scheduled scan.
1727 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan.
1729 * @mgmt_frame_register: Notify driver that a management frame type was
1730 * registered. Note that this callback may not sleep, and cannot run
1731 * concurrently with itself.
1733 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1734 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1735 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1736 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1738 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1740 * @set_ringparam: Set tx and rx ring sizes.
1742 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1744 * @tdls_mgmt: Transmit a TDLS management frame.
1745 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1747 * @probe_client: probe an associated client, must return a cookie that it
1748 * later passes to cfg80211_probe_status().
1750 * @set_noack_map: Set the NoAck Map for the TIDs.
1752 * @get_et_sset_count: Ethtool API to get string-set count.
1753 * See @ethtool_ops.get_sset_count
1755 * @get_et_stats: Ethtool API to get a set of u64 stats.
1756 * See @ethtool_ops.get_ethtool_stats
1758 * @get_et_strings: Ethtool API to get a set of strings to describe stats
1759 * and perhaps other supported types of ethtool data-sets.
1760 * See @ethtool_ops.get_strings
1762 * @get_channel: Get the current operating channel for the virtual interface.
1763 * For monitor interfaces, it should return %NULL unless there's a single
1764 * current monitoring channel.
1766 * @start_p2p_device: Start the given P2P device.
1767 * @stop_p2p_device: Stop the given P2P device.
1769 struct cfg80211_ops {
1770 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1771 int (*resume)(struct wiphy *wiphy);
1772 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
1774 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
1776 enum nl80211_iftype type,
1778 struct vif_params *params);
1779 int (*del_virtual_intf)(struct wiphy *wiphy,
1780 struct wireless_dev *wdev);
1781 int (*change_virtual_intf)(struct wiphy *wiphy,
1782 struct net_device *dev,
1783 enum nl80211_iftype type, u32 *flags,
1784 struct vif_params *params);
1786 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1787 u8 key_index, bool pairwise, const u8 *mac_addr,
1788 struct key_params *params);
1789 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1790 u8 key_index, bool pairwise, const u8 *mac_addr,
1792 void (*callback)(void *cookie, struct key_params*));
1793 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1794 u8 key_index, bool pairwise, const u8 *mac_addr);
1795 int (*set_default_key)(struct wiphy *wiphy,
1796 struct net_device *netdev,
1797 u8 key_index, bool unicast, bool multicast);
1798 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1799 struct net_device *netdev,
1802 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
1803 struct cfg80211_ap_settings *settings);
1804 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
1805 struct cfg80211_beacon_data *info);
1806 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
1809 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1810 u8 *mac, struct station_parameters *params);
1811 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1813 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1814 u8 *mac, struct station_parameters *params);
1815 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1816 u8 *mac, struct station_info *sinfo);
1817 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1818 int idx, u8 *mac, struct station_info *sinfo);
1820 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1821 u8 *dst, u8 *next_hop);
1822 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1824 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1825 u8 *dst, u8 *next_hop);
1826 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1827 u8 *dst, u8 *next_hop,
1828 struct mpath_info *pinfo);
1829 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1830 int idx, u8 *dst, u8 *next_hop,
1831 struct mpath_info *pinfo);
1832 int (*get_mesh_config)(struct wiphy *wiphy,
1833 struct net_device *dev,
1834 struct mesh_config *conf);
1835 int (*update_mesh_config)(struct wiphy *wiphy,
1836 struct net_device *dev, u32 mask,
1837 const struct mesh_config *nconf);
1838 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1839 const struct mesh_config *conf,
1840 const struct mesh_setup *setup);
1841 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1843 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1844 struct bss_parameters *params);
1846 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
1847 struct ieee80211_txq_params *params);
1849 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
1850 struct net_device *dev,
1851 struct ieee80211_channel *chan);
1853 int (*set_monitor_channel)(struct wiphy *wiphy,
1854 struct cfg80211_chan_def *chandef);
1856 int (*scan)(struct wiphy *wiphy,
1857 struct cfg80211_scan_request *request);
1859 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1860 struct cfg80211_auth_request *req);
1861 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1862 struct cfg80211_assoc_request *req);
1863 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1864 struct cfg80211_deauth_request *req);
1865 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1866 struct cfg80211_disassoc_request *req);
1868 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1869 struct cfg80211_connect_params *sme);
1870 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1873 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1874 struct cfg80211_ibss_params *params);
1875 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1877 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
1878 int rate[IEEE80211_NUM_BANDS]);
1880 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1882 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
1883 enum nl80211_tx_power_setting type, int mbm);
1884 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
1887 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1890 void (*rfkill_poll)(struct wiphy *wiphy);
1892 #ifdef CONFIG_NL80211_TESTMODE
1893 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1894 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
1895 struct netlink_callback *cb,
1896 void *data, int len);
1899 int (*set_bitrate_mask)(struct wiphy *wiphy,
1900 struct net_device *dev,
1902 const struct cfg80211_bitrate_mask *mask);
1904 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1905 int idx, struct survey_info *info);
1907 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1908 struct cfg80211_pmksa *pmksa);
1909 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1910 struct cfg80211_pmksa *pmksa);
1911 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1913 int (*remain_on_channel)(struct wiphy *wiphy,
1914 struct wireless_dev *wdev,
1915 struct ieee80211_channel *chan,
1916 unsigned int duration,
1918 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1919 struct wireless_dev *wdev,
1922 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
1923 struct ieee80211_channel *chan, bool offchan,
1924 unsigned int wait, const u8 *buf, size_t len,
1925 bool no_cck, bool dont_wait_for_ack, u64 *cookie);
1926 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1927 struct wireless_dev *wdev,
1930 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1931 bool enabled, int timeout);
1933 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1934 struct net_device *dev,
1935 s32 rssi_thold, u32 rssi_hyst);
1937 int (*set_cqm_txe_config)(struct wiphy *wiphy,
1938 struct net_device *dev,
1939 u32 rate, u32 pkts, u32 intvl);
1941 void (*mgmt_frame_register)(struct wiphy *wiphy,
1942 struct wireless_dev *wdev,
1943 u16 frame_type, bool reg);
1945 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1946 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1948 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1949 void (*get_ringparam)(struct wiphy *wiphy,
1950 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1952 int (*sched_scan_start)(struct wiphy *wiphy,
1953 struct net_device *dev,
1954 struct cfg80211_sched_scan_request *request);
1955 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
1957 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
1958 struct cfg80211_gtk_rekey_data *data);
1960 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1961 u8 *peer, u8 action_code, u8 dialog_token,
1962 u16 status_code, const u8 *buf, size_t len);
1963 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
1964 u8 *peer, enum nl80211_tdls_operation oper);
1966 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
1967 const u8 *peer, u64 *cookie);
1969 int (*set_noack_map)(struct wiphy *wiphy,
1970 struct net_device *dev,
1973 int (*get_et_sset_count)(struct wiphy *wiphy,
1974 struct net_device *dev, int sset);
1975 void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
1976 struct ethtool_stats *stats, u64 *data);
1977 void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
1978 u32 sset, u8 *data);
1980 int (*get_channel)(struct wiphy *wiphy,
1981 struct wireless_dev *wdev,
1982 struct cfg80211_chan_def *chandef);
1984 int (*start_p2p_device)(struct wiphy *wiphy,
1985 struct wireless_dev *wdev);
1986 void (*stop_p2p_device)(struct wiphy *wiphy,
1987 struct wireless_dev *wdev);
1991 * wireless hardware and networking interfaces structures
1992 * and registration/helper functions
1996 * enum wiphy_flags - wiphy capability flags
1998 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1999 * has its own custom regulatory domain and cannot identify the
2000 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
2001 * we will disregard the first regulatory hint (when the
2002 * initiator is %REGDOM_SET_BY_CORE).
2003 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
2004 * ignore regulatory domain settings until it gets its own regulatory
2005 * domain via its regulatory_hint() unless the regulatory hint is
2006 * from a country IE. After its gets its own regulatory domain it will
2007 * only allow further regulatory domain settings to further enhance
2008 * compliance. For example if channel 13 and 14 are disabled by this
2009 * regulatory domain no user regulatory domain can enable these channels
2010 * at a later time. This can be used for devices which do not have
2011 * calibration information guaranteed for frequencies or settings
2012 * outside of its regulatory domain. If used in combination with
2013 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
2015 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
2016 * that passive scan flags and beaconing flags may not be lifted by
2017 * cfg80211 due to regulatory beacon hints. For more information on beacon
2018 * hints read the documenation for regulatory_hint_found_beacon()
2019 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2021 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2022 * by default -- this flag will be set depending on the kernel's default
2023 * on wiphy_new(), but can be changed by the driver if it has a good
2024 * reason to override the default
2025 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2026 * on a VLAN interface)
2027 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2028 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2029 * control port protocol ethertype. The device also honours the
2030 * control_port_no_encrypt flag.
2031 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2032 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2033 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2034 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2035 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2037 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2038 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2039 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2040 * link setup/discovery operations internally. Setup, discovery and
2041 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2042 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2043 * used for asking the driver/firmware to perform a TDLS operation.
2044 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2045 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2046 * when there are virtual interfaces in AP mode by calling
2047 * cfg80211_report_obss_beacon().
2048 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2049 * responds to probe-requests in hardware.
2050 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2051 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2054 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
2055 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
2056 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
2057 WIPHY_FLAG_NETNS_OK = BIT(3),
2058 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2059 WIPHY_FLAG_4ADDR_AP = BIT(5),
2060 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2061 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2062 WIPHY_FLAG_IBSS_RSN = BIT(8),
2063 WIPHY_FLAG_MESH_AUTH = BIT(10),
2064 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2065 /* use hole at 12 */
2066 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2067 WIPHY_FLAG_AP_UAPSD = BIT(14),
2068 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2069 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2070 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2071 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2072 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2073 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2074 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2078 * struct ieee80211_iface_limit - limit on certain interface types
2079 * @max: maximum number of interfaces of these types
2080 * @types: interface types (bits)
2082 struct ieee80211_iface_limit {
2088 * struct ieee80211_iface_combination - possible interface combination
2089 * @limits: limits for the given interface types
2090 * @n_limits: number of limitations
2091 * @num_different_channels: can use up to this many different channels
2092 * @max_interfaces: maximum number of interfaces in total allowed in this
2094 * @beacon_int_infra_match: In this combination, the beacon intervals
2095 * between infrastructure and AP types must match. This is required
2096 * only in special cases.
2098 * These examples can be expressed as follows:
2100 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2102 * struct ieee80211_iface_limit limits1[] = {
2103 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2104 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2106 * struct ieee80211_iface_combination combination1 = {
2107 * .limits = limits1,
2108 * .n_limits = ARRAY_SIZE(limits1),
2109 * .max_interfaces = 2,
2110 * .beacon_int_infra_match = true,
2114 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2116 * struct ieee80211_iface_limit limits2[] = {
2117 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2118 * BIT(NL80211_IFTYPE_P2P_GO), },
2120 * struct ieee80211_iface_combination combination2 = {
2121 * .limits = limits2,
2122 * .n_limits = ARRAY_SIZE(limits2),
2123 * .max_interfaces = 8,
2124 * .num_different_channels = 1,
2128 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2129 * This allows for an infrastructure connection and three P2P connections.
2131 * struct ieee80211_iface_limit limits3[] = {
2132 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2133 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2134 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2136 * struct ieee80211_iface_combination combination3 = {
2137 * .limits = limits3,
2138 * .n_limits = ARRAY_SIZE(limits3),
2139 * .max_interfaces = 4,
2140 * .num_different_channels = 2,
2143 struct ieee80211_iface_combination {
2144 const struct ieee80211_iface_limit *limits;
2145 u32 num_different_channels;
2148 bool beacon_int_infra_match;
2151 struct mac_address {
2155 struct ieee80211_txrx_stypes {
2160 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2161 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2162 * trigger that keeps the device operating as-is and
2163 * wakes up the host on any activity, for example a
2164 * received packet that passed filtering; note that the
2165 * packet should be preserved in that case
2166 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2168 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2169 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2170 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2171 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2172 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2173 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2175 enum wiphy_wowlan_support_flags {
2176 WIPHY_WOWLAN_ANY = BIT(0),
2177 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2178 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2179 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2180 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2181 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2182 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2183 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2187 * struct wiphy_wowlan_support - WoWLAN support data
2188 * @flags: see &enum wiphy_wowlan_support_flags
2189 * @n_patterns: number of supported wakeup patterns
2190 * (see nl80211.h for the pattern definition)
2191 * @pattern_max_len: maximum length of each pattern
2192 * @pattern_min_len: minimum length of each pattern
2194 struct wiphy_wowlan_support {
2197 int pattern_max_len;
2198 int pattern_min_len;
2202 * struct wiphy - wireless hardware description
2203 * @reg_notifier: the driver's regulatory notification callback,
2204 * note that if your driver uses wiphy_apply_custom_regulatory()
2205 * the reg_notifier's request can be passed as NULL
2206 * @regd: the driver's regulatory domain, if one was requested via
2207 * the regulatory_hint() API. This can be used by the driver
2208 * on the reg_notifier() if it chooses to ignore future
2209 * regulatory domain changes caused by other drivers.
2210 * @signal_type: signal type reported in &struct cfg80211_bss.
2211 * @cipher_suites: supported cipher suites
2212 * @n_cipher_suites: number of supported cipher suites
2213 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2214 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2215 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2216 * -1 = fragmentation disabled, only odd values >= 256 used
2217 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2218 * @_net: the network namespace this wiphy currently lives in
2219 * @perm_addr: permanent MAC address of this device
2220 * @addr_mask: If the device supports multiple MAC addresses by masking,
2221 * set this to a mask with variable bits set to 1, e.g. if the last
2222 * four bits are variable then set it to 00:...:00:0f. The actual
2223 * variable bits shall be determined by the interfaces added, with
2224 * interfaces not matching the mask being rejected to be brought up.
2225 * @n_addresses: number of addresses in @addresses.
2226 * @addresses: If the device has more than one address, set this pointer
2227 * to a list of addresses (6 bytes each). The first one will be used
2228 * by default for perm_addr. In this case, the mask should be set to
2229 * all-zeroes. In this case it is assumed that the device can handle
2230 * the same number of arbitrary MAC addresses.
2231 * @registered: protects ->resume and ->suspend sysfs callbacks against
2232 * unregister hardware
2233 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2234 * automatically on wiphy renames
2235 * @dev: (virtual) struct device for this wiphy
2236 * @registered: helps synchronize suspend/resume with wiphy unregister
2237 * @wext: wireless extension handlers
2238 * @priv: driver private data (sized according to wiphy_new() parameter)
2239 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2240 * must be set by driver
2241 * @iface_combinations: Valid interface combinations array, should not
2242 * list single interface types.
2243 * @n_iface_combinations: number of entries in @iface_combinations array.
2244 * @software_iftypes: bitmask of software interface types, these are not
2245 * subject to any restrictions since they are purely managed in SW.
2246 * @flags: wiphy flags, see &enum wiphy_flags
2247 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2248 * @bss_priv_size: each BSS struct has private data allocated with it,
2249 * this variable determines its size
2250 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2252 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2253 * for in any given scheduled scan
2254 * @max_match_sets: maximum number of match sets the device can handle
2255 * when performing a scheduled scan, 0 if filtering is not
2257 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2258 * add to probe request frames transmitted during a scan, must not
2259 * include fixed IEs like supported rates
2260 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2262 * @coverage_class: current coverage class
2263 * @fw_version: firmware version for ethtool reporting
2264 * @hw_version: hardware version for ethtool reporting
2265 * @max_num_pmkids: maximum number of PMKIDs supported by device
2266 * @privid: a pointer that drivers can use to identify if an arbitrary
2267 * wiphy is theirs, e.g. in global notifiers
2268 * @bands: information about bands/channels supported by this device
2270 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2271 * transmitted through nl80211, points to an array indexed by interface
2274 * @available_antennas_tx: bitmap of antennas which are available to be
2275 * configured as TX antennas. Antenna configuration commands will be
2276 * rejected unless this or @available_antennas_rx is set.
2278 * @available_antennas_rx: bitmap of antennas which are available to be
2279 * configured as RX antennas. Antenna configuration commands will be
2280 * rejected unless this or @available_antennas_tx is set.
2282 * @probe_resp_offload:
2283 * Bitmap of supported protocols for probe response offloading.
2284 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2285 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2287 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2288 * may request, if implemented.
2290 * @wowlan: WoWLAN support information
2292 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2293 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2294 * If null, then none can be over-ridden.
2297 /* assign these fields before you register the wiphy */
2299 /* permanent MAC address(es) */
2300 u8 perm_addr[ETH_ALEN];
2301 u8 addr_mask[ETH_ALEN];
2303 struct mac_address *addresses;
2305 const struct ieee80211_txrx_stypes *mgmt_stypes;
2307 const struct ieee80211_iface_combination *iface_combinations;
2308 int n_iface_combinations;
2309 u16 software_iftypes;
2313 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2314 u16 interface_modes;
2316 u32 flags, features;
2320 enum cfg80211_signal_type signal_type;
2324 u8 max_sched_scan_ssids;
2326 u16 max_scan_ie_len;
2327 u16 max_sched_scan_ie_len;
2329 int n_cipher_suites;
2330 const u32 *cipher_suites;
2338 char fw_version[ETHTOOL_BUSINFO_LEN];
2342 struct wiphy_wowlan_support wowlan;
2345 u16 max_remain_on_channel_duration;
2349 u32 available_antennas_tx;
2350 u32 available_antennas_rx;
2353 * Bitmap of supported protocols for probe response offloading
2354 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2355 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2357 u32 probe_resp_offload;
2359 /* If multiple wiphys are registered and you're handed e.g.
2360 * a regular netdev with assigned ieee80211_ptr, you won't
2361 * know whether it points to a wiphy your driver has registered
2362 * or not. Assign this to something global to your driver to
2363 * help determine whether you own this wiphy or not. */
2366 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2368 /* Lets us get back the wiphy on the callback */
2369 void (*reg_notifier)(struct wiphy *wiphy,
2370 struct regulatory_request *request);
2372 /* fields below are read-only, assigned by cfg80211 */
2374 const struct ieee80211_regdomain __rcu *regd;
2376 /* the item in /sys/class/ieee80211/ points to this,
2377 * you need use set_wiphy_dev() (see below) */
2380 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2383 /* dir in debugfs: ieee80211/<wiphyname> */
2384 struct dentry *debugfsdir;
2386 const struct ieee80211_ht_cap *ht_capa_mod_mask;
2388 #ifdef CONFIG_NET_NS
2389 /* the network namespace this phy lives in currently */
2393 #ifdef CONFIG_CFG80211_WEXT
2394 const struct iw_handler_def *wext;
2397 char priv[0] __aligned(NETDEV_ALIGN);
2400 static inline struct net *wiphy_net(struct wiphy *wiphy)
2402 return read_pnet(&wiphy->_net);
2405 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2407 write_pnet(&wiphy->_net, net);
2411 * wiphy_priv - return priv from wiphy
2413 * @wiphy: the wiphy whose priv pointer to return
2414 * Return: The priv of @wiphy.
2416 static inline void *wiphy_priv(struct wiphy *wiphy)
2419 return &wiphy->priv;
2423 * priv_to_wiphy - return the wiphy containing the priv
2425 * @priv: a pointer previously returned by wiphy_priv
2426 * Return: The wiphy of @priv.
2428 static inline struct wiphy *priv_to_wiphy(void *priv)
2431 return container_of(priv, struct wiphy, priv);
2435 * set_wiphy_dev - set device pointer for wiphy
2437 * @wiphy: The wiphy whose device to bind
2438 * @dev: The device to parent it to
2440 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2442 wiphy->dev.parent = dev;
2446 * wiphy_dev - get wiphy dev pointer
2448 * @wiphy: The wiphy whose device struct to look up
2449 * Return: The dev of @wiphy.
2451 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2453 return wiphy->dev.parent;
2457 * wiphy_name - get wiphy name
2459 * @wiphy: The wiphy whose name to return
2460 * Return: The name of @wiphy.
2462 static inline const char *wiphy_name(const struct wiphy *wiphy)
2464 return dev_name(&wiphy->dev);
2468 * wiphy_new - create a new wiphy for use with cfg80211
2470 * @ops: The configuration operations for this device
2471 * @sizeof_priv: The size of the private area to allocate
2473 * Create a new wiphy and associate the given operations with it.
2474 * @sizeof_priv bytes are allocated for private use.
2476 * Return: A pointer to the new wiphy. This pointer must be
2477 * assigned to each netdev's ieee80211_ptr for proper operation.
2479 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2482 * wiphy_register - register a wiphy with cfg80211
2484 * @wiphy: The wiphy to register.
2486 * Return: A non-negative wiphy index or a negative error code.
2488 extern int wiphy_register(struct wiphy *wiphy);
2491 * wiphy_unregister - deregister a wiphy from cfg80211
2493 * @wiphy: The wiphy to unregister.
2495 * After this call, no more requests can be made with this priv
2496 * pointer, but the call may sleep to wait for an outstanding
2497 * request that is being handled.
2499 extern void wiphy_unregister(struct wiphy *wiphy);
2502 * wiphy_free - free wiphy
2504 * @wiphy: The wiphy to free
2506 extern void wiphy_free(struct wiphy *wiphy);
2508 /* internal structs */
2509 struct cfg80211_conn;
2510 struct cfg80211_internal_bss;
2511 struct cfg80211_cached_keys;
2514 * struct wireless_dev - wireless device state
2516 * For netdevs, this structure must be allocated by the driver
2517 * that uses the ieee80211_ptr field in struct net_device (this
2518 * is intentional so it can be allocated along with the netdev.)
2519 * It need not be registered then as netdev registration will
2520 * be intercepted by cfg80211 to see the new wireless device.
2522 * For non-netdev uses, it must also be allocated by the driver
2523 * in response to the cfg80211 callbacks that require it, as
2524 * there's no netdev registration in that case it may not be
2525 * allocated outside of callback operations that return it.
2527 * @wiphy: pointer to hardware description
2528 * @iftype: interface type
2529 * @list: (private) Used to collect the interfaces
2530 * @netdev: (private) Used to reference back to the netdev, may be %NULL
2531 * @identifier: (private) Identifier used in nl80211 to identify this
2532 * wireless device if it has no netdev
2533 * @current_bss: (private) Used by the internal configuration code
2534 * @channel: (private) Used by the internal configuration code to track
2535 * the user-set AP, monitor and WDS channel
2536 * @preset_chan: (private) Used by the internal configuration code to
2537 * track the channel to be used for AP later
2538 * @preset_chantype: (private) the corresponding channel type
2539 * @bssid: (private) Used by the internal configuration code
2540 * @ssid: (private) Used by the internal configuration code
2541 * @ssid_len: (private) Used by the internal configuration code
2542 * @mesh_id_len: (private) Used by the internal configuration code
2543 * @mesh_id_up_len: (private) Used by the internal configuration code
2544 * @wext: (private) Used by the internal wireless extensions compat code
2545 * @use_4addr: indicates 4addr mode is used on this interface, must be
2546 * set by driver (if supported) on add_interface BEFORE registering the
2547 * netdev and may otherwise be used by driver read-only, will be update
2548 * by cfg80211 on change_interface
2549 * @mgmt_registrations: list of registrations for management frames
2550 * @mgmt_registrations_lock: lock for the list
2551 * @mtx: mutex used to lock data in this struct
2552 * @cleanup_work: work struct used for cleanup that can't be done directly
2553 * @beacon_interval: beacon interval used on this device for transmitting
2554 * beacons, 0 when not valid
2555 * @address: The address for this device, valid only if @netdev is %NULL
2556 * @p2p_started: true if this is a P2P Device that has been started
2558 struct wireless_dev {
2559 struct wiphy *wiphy;
2560 enum nl80211_iftype iftype;
2562 /* the remainder of this struct should be private to cfg80211 */
2563 struct list_head list;
2564 struct net_device *netdev;
2568 struct list_head mgmt_registrations;
2569 spinlock_t mgmt_registrations_lock;
2573 struct work_struct cleanup_work;
2575 bool use_4addr, p2p_started;
2577 u8 address[ETH_ALEN] __aligned(sizeof(u16));
2579 /* currently used for IBSS and SME - might be rearranged later */
2580 u8 ssid[IEEE80211_MAX_SSID_LEN];
2581 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2584 CFG80211_SME_CONNECTING,
2585 CFG80211_SME_CONNECTED,
2587 struct cfg80211_conn *conn;
2588 struct cfg80211_cached_keys *connect_keys;
2590 struct list_head event_list;
2591 spinlock_t event_lock;
2593 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2594 struct cfg80211_chan_def preset_chandef;
2596 /* for AP and mesh channel tracking */
2597 struct ieee80211_channel *channel;
2604 int beacon_interval;
2606 u32 ap_unexpected_nlportid;
2608 #ifdef CONFIG_CFG80211_WEXT
2611 struct cfg80211_ibss_params ibss;
2612 struct cfg80211_connect_params connect;
2613 struct cfg80211_cached_keys *keys;
2616 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2617 u8 ssid[IEEE80211_MAX_SSID_LEN];
2618 s8 default_key, default_mgmt_key;
2619 bool prev_bssid_valid;
2624 static inline u8 *wdev_address(struct wireless_dev *wdev)
2627 return wdev->netdev->dev_addr;
2628 return wdev->address;
2632 * wdev_priv - return wiphy priv from wireless_dev
2634 * @wdev: The wireless device whose wiphy's priv pointer to return
2635 * Return: The wiphy priv of @wdev.
2637 static inline void *wdev_priv(struct wireless_dev *wdev)
2640 return wiphy_priv(wdev->wiphy);
2644 * DOC: Utility functions
2646 * cfg80211 offers a number of utility functions that can be useful.
2650 * ieee80211_channel_to_frequency - convert channel number to frequency
2651 * @chan: channel number
2652 * @band: band, necessary due to channel number overlap
2653 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
2655 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2658 * ieee80211_frequency_to_channel - convert frequency to channel number
2659 * @freq: center frequency
2660 * Return: The corresponding channel, or 0 if the conversion failed.
2662 extern int ieee80211_frequency_to_channel(int freq);
2665 * Name indirection necessary because the ieee80211 code also has
2666 * a function named "ieee80211_get_channel", so if you include
2667 * cfg80211's header file you get cfg80211's version, if you try
2668 * to include both header files you'll (rightfully!) get a symbol
2671 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2674 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2675 * @wiphy: the struct wiphy to get the channel for
2676 * @freq: the center frequency of the channel
2677 * Return: The channel struct from @wiphy at @freq.
2679 static inline struct ieee80211_channel *
2680 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2682 return __ieee80211_get_channel(wiphy, freq);
2686 * ieee80211_get_response_rate - get basic rate for a given rate
2688 * @sband: the band to look for rates in
2689 * @basic_rates: bitmap of basic rates
2690 * @bitrate: the bitrate for which to find the basic rate
2692 * Return: The basic rate corresponding to a given bitrate, that
2693 * is the next lower bitrate contained in the basic rate map,
2694 * which is, for this function, given as a bitmap of indices of
2695 * rates in the band's bitrate table.
2697 struct ieee80211_rate *
2698 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2699 u32 basic_rates, int bitrate);
2702 * Radiotap parsing functions -- for controlled injection support
2704 * Implemented in net/wireless/radiotap.c
2705 * Documentation in Documentation/networking/radiotap-headers.txt
2708 struct radiotap_align_size {
2709 uint8_t align:4, size:4;
2712 struct ieee80211_radiotap_namespace {
2713 const struct radiotap_align_size *align_size;
2719 struct ieee80211_radiotap_vendor_namespaces {
2720 const struct ieee80211_radiotap_namespace *ns;
2725 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2726 * @this_arg_index: index of current arg, valid after each successful call
2727 * to ieee80211_radiotap_iterator_next()
2728 * @this_arg: pointer to current radiotap arg; it is valid after each
2729 * call to ieee80211_radiotap_iterator_next() but also after
2730 * ieee80211_radiotap_iterator_init() where it will point to
2731 * the beginning of the actual data portion
2732 * @this_arg_size: length of the current arg, for convenience
2733 * @current_namespace: pointer to the current namespace definition
2734 * (or internally %NULL if the current namespace is unknown)
2735 * @is_radiotap_ns: indicates whether the current namespace is the default
2736 * radiotap namespace or not
2738 * @_rtheader: pointer to the radiotap header we are walking through
2739 * @_max_length: length of radiotap header in cpu byte ordering
2740 * @_arg_index: next argument index
2741 * @_arg: next argument pointer
2742 * @_next_bitmap: internal pointer to next present u32
2743 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2744 * @_vns: vendor namespace definitions
2745 * @_next_ns_data: beginning of the next namespace's data
2746 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2749 * Describes the radiotap parser state. Fields prefixed with an underscore
2750 * must not be used by users of the parser, only by the parser internally.
2753 struct ieee80211_radiotap_iterator {
2754 struct ieee80211_radiotap_header *_rtheader;
2755 const struct ieee80211_radiotap_vendor_namespaces *_vns;
2756 const struct ieee80211_radiotap_namespace *current_namespace;
2758 unsigned char *_arg, *_next_ns_data;
2759 __le32 *_next_bitmap;
2761 unsigned char *this_arg;
2769 uint32_t _bitmap_shifter;
2773 extern int ieee80211_radiotap_iterator_init(
2774 struct ieee80211_radiotap_iterator *iterator,
2775 struct ieee80211_radiotap_header *radiotap_header,
2776 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
2778 extern int ieee80211_radiotap_iterator_next(
2779 struct ieee80211_radiotap_iterator *iterator);
2782 extern const unsigned char rfc1042_header[6];
2783 extern const unsigned char bridge_tunnel_header[6];
2786 * ieee80211_get_hdrlen_from_skb - get header length from data
2790 * Given an skb with a raw 802.11 header at the data pointer this function
2791 * returns the 802.11 header length.
2793 * Return: The 802.11 header length in bytes (not including encryption
2794 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
2797 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
2800 * ieee80211_hdrlen - get header length in bytes from frame control
2801 * @fc: frame control field in little-endian format
2802 * Return: The header length in bytes.
2804 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2807 * ieee80211_get_mesh_hdrlen - get mesh extension header length
2808 * @meshhdr: the mesh extension header, only the flags field
2809 * (first byte) will be accessed
2810 * Return: The length of the extension header, which is always at
2811 * least 6 bytes and at most 18 if address 5 and 6 are present.
2813 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
2816 * DOC: Data path helpers
2818 * In addition to generic utilities, cfg80211 also offers
2819 * functions that help implement the data path for devices
2820 * that do not do the 802.11/802.3 conversion on the device.
2824 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2825 * @skb: the 802.11 data frame
2826 * @addr: the device MAC address
2827 * @iftype: the virtual interface type
2828 * Return: 0 on success. Non-zero on error.
2830 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2831 enum nl80211_iftype iftype);
2834 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2835 * @skb: the 802.3 frame
2836 * @addr: the device MAC address
2837 * @iftype: the virtual interface type
2838 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2839 * @qos: build 802.11 QoS data frame
2840 * Return: 0 on success, or a negative error code.
2842 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2843 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2846 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2848 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2849 * 802.3 frames. The @list will be empty if the decode fails. The
2850 * @skb is consumed after the function returns.
2852 * @skb: The input IEEE 802.11n A-MSDU frame.
2853 * @list: The output list of 802.3 frames. It must be allocated and
2854 * initialized by by the caller.
2855 * @addr: The device MAC address.
2856 * @iftype: The device interface type.
2857 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2858 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2860 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2861 const u8 *addr, enum nl80211_iftype iftype,
2862 const unsigned int extra_headroom,
2863 bool has_80211_header);
2866 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2867 * @skb: the data frame
2868 * Return: The 802.1p/1d tag.
2870 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2873 * cfg80211_find_ie - find information element in data
2876 * @ies: data consisting of IEs
2877 * @len: length of data
2879 * Return: %NULL if the element ID could not be found or if
2880 * the element is invalid (claims to be longer than the given
2881 * data), or a pointer to the first byte of the requested
2882 * element, that is the byte containing the element ID.
2884 * Note: There are no checks on the element length other than
2885 * having to fit into the given data.
2887 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2890 * cfg80211_find_vendor_ie - find vendor specific information element in data
2893 * @oui_type: vendor-specific OUI type
2894 * @ies: data consisting of IEs
2895 * @len: length of data
2897 * Return: %NULL if the vendor specific element ID could not be found or if the
2898 * element is invalid (claims to be longer than the given data), or a pointer to
2899 * the first byte of the requested element, that is the byte containing the
2902 * Note: There are no checks on the element length other than having to fit into
2905 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
2906 const u8 *ies, int len);
2909 * DOC: Regulatory enforcement infrastructure
2915 * regulatory_hint - driver hint to the wireless core a regulatory domain
2916 * @wiphy: the wireless device giving the hint (used only for reporting
2918 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2919 * should be in. If @rd is set this should be NULL. Note that if you
2920 * set this to NULL you should still set rd->alpha2 to some accepted
2923 * Wireless drivers can use this function to hint to the wireless core
2924 * what it believes should be the current regulatory domain by
2925 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2926 * domain should be in or by providing a completely build regulatory domain.
2927 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2928 * for a regulatory domain structure for the respective country.
2930 * The wiphy must have been registered to cfg80211 prior to this call.
2931 * For cfg80211 drivers this means you must first use wiphy_register(),
2932 * for mac80211 drivers you must first use ieee80211_register_hw().
2934 * Drivers should check the return value, its possible you can get
2937 * Return: 0 on success. -ENOMEM.
2939 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2942 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2943 * @wiphy: the wireless device we want to process the regulatory domain on
2944 * @regd: the custom regulatory domain to use for this wiphy
2946 * Drivers can sometimes have custom regulatory domains which do not apply
2947 * to a specific country. Drivers can use this to apply such custom regulatory
2948 * domains. This routine must be called prior to wiphy registration. The
2949 * custom regulatory domain will be trusted completely and as such previous
2950 * default channel settings will be disregarded. If no rule is found for a
2951 * channel on the regulatory domain the channel will be disabled.
2953 extern void wiphy_apply_custom_regulatory(
2954 struct wiphy *wiphy,
2955 const struct ieee80211_regdomain *regd);
2958 * freq_reg_info - get regulatory information for the given frequency
2959 * @wiphy: the wiphy for which we want to process this rule for
2960 * @center_freq: Frequency in KHz for which we want regulatory information for
2962 * Use this function to get the regulatory rule for a specific frequency on
2963 * a given wireless device. If the device has a specific regulatory domain
2964 * it wants to follow we respect that unless a country IE has been received
2965 * and processed already.
2967 * Return: A valid pointer, or, when an error occurs, for example if no rule
2968 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
2969 * check and PTR_ERR() to obtain the numeric return value. The numeric return
2970 * value will be -ERANGE if we determine the given center_freq does not even
2971 * have a regulatory rule for a frequency range in the center_freq's band.
2972 * See freq_in_rule_band() for our current definition of a band -- this is
2973 * purely subjective and right now it's 802.11 specific.
2975 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
2979 * callbacks for asynchronous cfg80211 methods, notification
2980 * functions and BSS handling helpers
2984 * cfg80211_scan_done - notify that scan finished
2986 * @request: the corresponding scan request
2987 * @aborted: set to true if the scan was aborted for any reason,
2988 * userspace will be notified of that
2990 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2993 * cfg80211_sched_scan_results - notify that new scan results are available
2995 * @wiphy: the wiphy which got scheduled scan results
2997 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3000 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3002 * @wiphy: the wiphy on which the scheduled scan stopped
3004 * The driver can call this function to inform cfg80211 that the
3005 * scheduled scan had to be stopped, for whatever reason. The driver
3006 * is then called back via the sched_scan_stop operation when done.
3008 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3011 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
3013 * @wiphy: the wiphy reporting the BSS
3014 * @channel: The channel the frame was received on
3015 * @mgmt: the management frame (probe response or beacon)
3016 * @len: length of the management frame
3017 * @signal: the signal strength, type depends on the wiphy's signal_type
3018 * @gfp: context flags
3020 * This informs cfg80211 that BSS information was found and
3021 * the BSS should be updated/added.
3023 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3024 * Or %NULL on error.
3026 struct cfg80211_bss * __must_check
3027 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3028 struct ieee80211_channel *channel,
3029 struct ieee80211_mgmt *mgmt, size_t len,
3030 s32 signal, gfp_t gfp);
3033 * cfg80211_inform_bss - inform cfg80211 of a new BSS
3035 * @wiphy: the wiphy reporting the BSS
3036 * @channel: The channel the frame was received on
3037 * @bssid: the BSSID of the BSS
3038 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3039 * @capability: the capability field sent by the peer
3040 * @beacon_interval: the beacon interval announced by the peer
3041 * @ie: additional IEs sent by the peer
3042 * @ielen: length of the additional IEs
3043 * @signal: the signal strength, type depends on the wiphy's signal_type
3044 * @gfp: context flags
3046 * This informs cfg80211 that BSS information was found and
3047 * the BSS should be updated/added.
3049 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3050 * Or %NULL on error.
3052 struct cfg80211_bss * __must_check
3053 cfg80211_inform_bss(struct wiphy *wiphy,
3054 struct ieee80211_channel *channel,
3055 const u8 *bssid, u64 tsf, u16 capability,
3056 u16 beacon_interval, const u8 *ie, size_t ielen,
3057 s32 signal, gfp_t gfp);
3059 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3060 struct ieee80211_channel *channel,
3062 const u8 *ssid, size_t ssid_len,
3063 u16 capa_mask, u16 capa_val);
3064 static inline struct cfg80211_bss *
3065 cfg80211_get_ibss(struct wiphy *wiphy,
3066 struct ieee80211_channel *channel,
3067 const u8 *ssid, size_t ssid_len)
3069 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3070 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3073 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
3074 struct ieee80211_channel *channel,
3075 const u8 *meshid, size_t meshidlen,
3078 * cfg80211_ref_bss - reference BSS struct
3079 * @bss: the BSS struct to reference
3081 * Increments the refcount of the given BSS struct.
3083 void cfg80211_ref_bss(struct cfg80211_bss *bss);
3086 * cfg80211_put_bss - unref BSS struct
3087 * @bss: the BSS struct
3089 * Decrements the refcount of the given BSS struct.
3091 void cfg80211_put_bss(struct cfg80211_bss *bss);
3094 * cfg80211_unlink_bss - unlink BSS from internal data structures
3096 * @bss: the bss to remove
3098 * This function removes the given BSS from the internal data structures
3099 * thereby making it no longer show up in scan results etc. Use this
3100 * function when you detect a BSS is gone. Normally BSSes will also time
3101 * out, so it is not necessary to use this function at all.
3103 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3106 * cfg80211_send_rx_auth - notification of processed authentication
3107 * @dev: network device
3108 * @buf: authentication frame (header + body)
3109 * @len: length of the frame data
3111 * This function is called whenever an authentication has been processed in
3112 * station mode. The driver is required to call either this function or
3113 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
3114 * call. This function may sleep.
3116 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
3119 * cfg80211_send_auth_timeout - notification of timed out authentication
3120 * @dev: network device
3121 * @addr: The MAC address of the device with which the authentication timed out
3123 * This function may sleep.
3125 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
3128 * cfg80211_send_rx_assoc - notification of processed association
3129 * @dev: network device
3130 * @bss: the BSS struct association was requested for, the struct reference
3131 * is owned by cfg80211 after this call
3132 * @buf: (re)association response frame (header + body)
3133 * @len: length of the frame data
3135 * This function is called whenever a (re)association response has been
3136 * processed in station mode. The driver is required to call either this
3137 * function or cfg80211_send_assoc_timeout() to indicate the result of
3138 * cfg80211_ops::assoc() call. This function may sleep.
3140 void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
3141 const u8 *buf, size_t len);
3144 * cfg80211_send_assoc_timeout - notification of timed out association
3145 * @dev: network device
3146 * @addr: The MAC address of the device with which the association timed out
3148 * This function may sleep.
3150 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
3153 * cfg80211_send_deauth - notification of processed deauthentication
3154 * @dev: network device
3155 * @buf: deauthentication frame (header + body)
3156 * @len: length of the frame data
3158 * This function is called whenever deauthentication has been processed in
3159 * station mode. This includes both received deauthentication frames and
3160 * locally generated ones. This function may sleep.
3162 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3165 * __cfg80211_send_deauth - notification of processed deauthentication
3166 * @dev: network device
3167 * @buf: deauthentication frame (header + body)
3168 * @len: length of the frame data
3170 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
3172 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3175 * cfg80211_send_disassoc - notification of processed disassociation
3176 * @dev: network device
3177 * @buf: disassociation response frame (header + body)
3178 * @len: length of the frame data
3180 * This function is called whenever disassociation has been processed in
3181 * station mode. This includes both received disassociation frames and locally
3182 * generated ones. This function may sleep.
3184 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
3187 * __cfg80211_send_disassoc - notification of processed disassociation
3188 * @dev: network device
3189 * @buf: disassociation response frame (header + body)
3190 * @len: length of the frame data
3192 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
3194 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
3198 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
3199 * @dev: network device
3200 * @buf: deauthentication frame (header + body)
3201 * @len: length of the frame data
3203 * This function is called whenever a received Deauthentication frame has been
3204 * dropped in station mode because of MFP being used but the Deauthentication
3205 * frame was not protected. This function may sleep.
3207 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
3211 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
3212 * @dev: network device
3213 * @buf: disassociation frame (header + body)
3214 * @len: length of the frame data
3216 * This function is called whenever a received Disassociation frame has been
3217 * dropped in station mode because of MFP being used but the Disassociation
3218 * frame was not protected. This function may sleep.
3220 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
3224 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3225 * @dev: network device
3226 * @addr: The source MAC address of the frame
3227 * @key_type: The key type that the received frame used
3228 * @key_id: Key identifier (0..3). Can be -1 if missing.
3229 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3230 * @gfp: allocation flags
3232 * This function is called whenever the local MAC detects a MIC failure in a
3233 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3236 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3237 enum nl80211_key_type key_type, int key_id,
3238 const u8 *tsc, gfp_t gfp);
3241 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3243 * @dev: network device
3244 * @bssid: the BSSID of the IBSS joined
3245 * @gfp: allocation flags
3247 * This function notifies cfg80211 that the device joined an IBSS or
3248 * switched to a different BSSID. Before this function can be called,
3249 * either a beacon has to have been received from the IBSS, or one of
3250 * the cfg80211_inform_bss{,_frame} functions must have been called
3251 * with the locally generated beacon -- this guarantees that there is
3252 * always a scan result for this IBSS. cfg80211 will handle the rest.
3254 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
3257 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3259 * @dev: network device
3260 * @macaddr: the MAC address of the new candidate
3261 * @ie: information elements advertised by the peer candidate
3262 * @ie_len: lenght of the information elements buffer
3263 * @gfp: allocation flags
3265 * This function notifies cfg80211 that the mesh peer candidate has been
3266 * detected, most likely via a beacon or, less likely, via a probe response.
3267 * cfg80211 then sends a notification to userspace.
3269 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3270 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3273 * DOC: RFkill integration
3275 * RFkill integration in cfg80211 is almost invisible to drivers,
3276 * as cfg80211 automatically registers an rfkill instance for each
3277 * wireless device it knows about. Soft kill is also translated
3278 * into disconnecting and turning all interfaces off, drivers are
3279 * expected to turn off the device when all interfaces are down.
3281 * However, devices may have a hard RFkill line, in which case they
3282 * also need to interact with the rfkill subsystem, via cfg80211.
3283 * They can do this with a few helper functions documented here.
3287 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3289 * @blocked: block status
3291 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3294 * wiphy_rfkill_start_polling - start polling rfkill
3297 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3300 * wiphy_rfkill_stop_polling - stop polling rfkill
3303 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3305 #ifdef CONFIG_NL80211_TESTMODE
3309 * Test mode is a set of utility functions to allow drivers to
3310 * interact with driver-specific tools to aid, for instance,
3311 * factory programming.
3313 * This chapter describes how drivers interact with it, for more
3314 * information see the nl80211 book's chapter on it.
3318 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3320 * @approxlen: an upper bound of the length of the data that will
3321 * be put into the skb
3323 * This function allocates and pre-fills an skb for a reply to
3324 * the testmode command. Since it is intended for a reply, calling
3325 * it outside of the @testmode_cmd operation is invalid.
3327 * The returned skb is pre-filled with the wiphy index and set up in
3328 * a way that any data that is put into the skb (with skb_put(),
3329 * nla_put() or similar) will end up being within the
3330 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
3331 * with the skb is adding data for the corresponding userspace tool
3332 * which can then read that data out of the testdata attribute. You
3333 * must not modify the skb in any other way.
3335 * When done, call cfg80211_testmode_reply() with the skb and return
3336 * its error code as the result of the @testmode_cmd operation.
3338 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3340 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
3344 * cfg80211_testmode_reply - send the reply skb
3345 * @skb: The skb, must have been allocated with
3346 * cfg80211_testmode_alloc_reply_skb()
3348 * Since calling this function will usually be the last thing
3349 * before returning from the @testmode_cmd you should return
3350 * the error code. Note that this function consumes the skb
3351 * regardless of the return value.
3353 * Return: An error code or 0 on success.
3355 int cfg80211_testmode_reply(struct sk_buff *skb);
3358 * cfg80211_testmode_alloc_event_skb - allocate testmode event
3360 * @approxlen: an upper bound of the length of the data that will
3361 * be put into the skb
3362 * @gfp: allocation flags
3364 * This function allocates and pre-fills an skb for an event on the
3365 * testmode multicast group.
3367 * The returned skb is set up in the same way as with
3368 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
3369 * there, you should simply add data to it that will then end up in the
3370 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
3373 * When done filling the skb, call cfg80211_testmode_event() with the
3374 * skb to send the event.
3376 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3378 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
3379 int approxlen, gfp_t gfp);
3382 * cfg80211_testmode_event - send the event
3383 * @skb: The skb, must have been allocated with
3384 * cfg80211_testmode_alloc_event_skb()
3385 * @gfp: allocation flags
3387 * This function sends the given @skb, which must have been allocated
3388 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3391 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3393 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3394 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3396 #define CFG80211_TESTMODE_CMD(cmd)
3397 #define CFG80211_TESTMODE_DUMP(cmd)
3401 * cfg80211_connect_result - notify cfg80211 of connection result
3403 * @dev: network device
3404 * @bssid: the BSSID of the AP
3405 * @req_ie: association request IEs (maybe be %NULL)
3406 * @req_ie_len: association request IEs length
3407 * @resp_ie: association response IEs (may be %NULL)
3408 * @resp_ie_len: assoc response IEs length
3409 * @status: status code, 0 for successful connection, use
3410 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3411 * the real status code for failures.
3412 * @gfp: allocation flags
3414 * It should be called by the underlying driver whenever connect() has
3417 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3418 const u8 *req_ie, size_t req_ie_len,
3419 const u8 *resp_ie, size_t resp_ie_len,
3420 u16 status, gfp_t gfp);
3423 * cfg80211_roamed - notify cfg80211 of roaming
3425 * @dev: network device
3426 * @channel: the channel of the new AP
3427 * @bssid: the BSSID of the new AP
3428 * @req_ie: association request IEs (maybe be %NULL)
3429 * @req_ie_len: association request IEs length
3430 * @resp_ie: association response IEs (may be %NULL)
3431 * @resp_ie_len: assoc response IEs length
3432 * @gfp: allocation flags
3434 * It should be called by the underlying driver whenever it roamed
3435 * from one AP to another while connected.
3437 void cfg80211_roamed(struct net_device *dev,
3438 struct ieee80211_channel *channel,
3440 const u8 *req_ie, size_t req_ie_len,
3441 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3444 * cfg80211_roamed_bss - notify cfg80211 of roaming
3446 * @dev: network device
3447 * @bss: entry of bss to which STA got roamed
3448 * @req_ie: association request IEs (maybe be %NULL)
3449 * @req_ie_len: association request IEs length
3450 * @resp_ie: association response IEs (may be %NULL)
3451 * @resp_ie_len: assoc response IEs length
3452 * @gfp: allocation flags
3454 * This is just a wrapper to notify cfg80211 of roaming event with driver
3455 * passing bss to avoid a race in timeout of the bss entry. It should be
3456 * called by the underlying driver whenever it roamed from one AP to another
3457 * while connected. Drivers which have roaming implemented in firmware
3458 * may use this function to avoid a race in bss entry timeout where the bss
3459 * entry of the new AP is seen in the driver, but gets timed out by the time
3460 * it is accessed in __cfg80211_roamed() due to delay in scheduling
3461 * rdev->event_work. In case of any failures, the reference is released
3462 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3463 * it will be released while diconneting from the current bss.
3465 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3466 const u8 *req_ie, size_t req_ie_len,
3467 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3470 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3472 * @dev: network device
3473 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3474 * @ie_len: length of IEs
3475 * @reason: reason code for the disconnection, set it to 0 if unknown
3476 * @gfp: allocation flags
3478 * After it calls this function, the driver should enter an idle state
3479 * and not try to connect to any AP any more.
3481 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3482 u8 *ie, size_t ie_len, gfp_t gfp);
3485 * cfg80211_ready_on_channel - notification of remain_on_channel start
3486 * @wdev: wireless device
3487 * @cookie: the request cookie
3488 * @chan: The current channel (from remain_on_channel request)
3489 * @duration: Duration in milliseconds that the driver intents to remain on the
3491 * @gfp: allocation flags
3493 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
3494 struct ieee80211_channel *chan,
3495 unsigned int duration, gfp_t gfp);
3498 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3499 * @wdev: wireless device
3500 * @cookie: the request cookie
3501 * @chan: The current channel (from remain_on_channel request)
3502 * @gfp: allocation flags
3504 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
3505 struct ieee80211_channel *chan,
3510 * cfg80211_new_sta - notify userspace about station
3513 * @mac_addr: the station's address
3514 * @sinfo: the station information
3515 * @gfp: allocation flags
3517 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3518 struct station_info *sinfo, gfp_t gfp);
3521 * cfg80211_del_sta - notify userspace about deletion of a station
3524 * @mac_addr: the station's address
3525 * @gfp: allocation flags
3527 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3530 * cfg80211_conn_failed - connection request failed notification
3533 * @mac_addr: the station's address
3534 * @reason: the reason for connection failure
3535 * @gfp: allocation flags
3537 * Whenever a station tries to connect to an AP and if the station
3538 * could not connect to the AP as the AP has rejected the connection
3539 * for some reasons, this function is called.
3541 * The reason for connection failure can be any of the value from
3542 * nl80211_connect_failed_reason enum
3544 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
3545 enum nl80211_connect_failed_reason reason,
3549 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3550 * @wdev: wireless device receiving the frame
3551 * @freq: Frequency on which the frame was received in MHz
3552 * @sig_dbm: signal strength in mBm, or 0 if unknown
3553 * @buf: Management frame (header + body)
3554 * @len: length of the frame data
3555 * @gfp: context flags
3557 * This function is called whenever an Action frame is received for a station
3558 * mode interface, but is not processed in kernel.
3560 * Return: %true if a user space application has registered for this frame.
3561 * For action frames, that makes it responsible for rejecting unrecognized
3562 * action frames; %false otherwise, in which case for action frames the
3563 * driver is responsible for rejecting the frame.
3565 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
3566 const u8 *buf, size_t len, gfp_t gfp);
3569 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3570 * @wdev: wireless device receiving the frame
3571 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3572 * @buf: Management frame (header + body)
3573 * @len: length of the frame data
3574 * @ack: Whether frame was acknowledged
3575 * @gfp: context flags
3577 * This function is called whenever a management frame was requested to be
3578 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3579 * transmission attempt.
3581 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
3582 const u8 *buf, size_t len, bool ack, gfp_t gfp);
3586 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3587 * @dev: network device
3588 * @rssi_event: the triggered RSSI event
3589 * @gfp: context flags
3591 * This function is called when a configured connection quality monitoring
3592 * rssi threshold reached event occurs.
3594 void cfg80211_cqm_rssi_notify(struct net_device *dev,
3595 enum nl80211_cqm_rssi_threshold_event rssi_event,
3599 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3600 * @dev: network device
3601 * @peer: peer's MAC address
3602 * @num_packets: how many packets were lost -- should be a fixed threshold
3603 * but probably no less than maybe 50, or maybe a throughput dependent
3604 * threshold (to account for temporary interference)
3605 * @gfp: context flags
3607 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3608 const u8 *peer, u32 num_packets, gfp_t gfp);
3611 * cfg80211_cqm_txe_notify - TX error rate event
3612 * @dev: network device
3613 * @peer: peer's MAC address
3614 * @num_packets: how many packets were lost
3615 * @rate: % of packets which failed transmission
3616 * @intvl: interval (in s) over which the TX failure threshold was breached.
3617 * @gfp: context flags
3619 * Notify userspace when configured % TX failures over number of packets in a
3620 * given interval is exceeded.
3622 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
3623 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
3626 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3627 * @dev: network device
3628 * @bssid: BSSID of AP (to avoid races)
3629 * @replay_ctr: new replay counter
3630 * @gfp: allocation flags
3632 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
3633 const u8 *replay_ctr, gfp_t gfp);
3636 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3637 * @dev: network device
3638 * @index: candidate index (the smaller the index, the higher the priority)
3639 * @bssid: BSSID of AP
3640 * @preauth: Whether AP advertises support for RSN pre-authentication
3641 * @gfp: allocation flags
3643 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
3644 const u8 *bssid, bool preauth, gfp_t gfp);
3647 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3648 * @dev: The device the frame matched to
3649 * @addr: the transmitter address
3650 * @gfp: context flags
3652 * This function is used in AP mode (only!) to inform userspace that
3653 * a spurious class 3 frame was received, to be able to deauth the
3655 * Return: %true if the frame was passed to userspace (or this failed
3656 * for a reason other than not having a subscription.)
3658 bool cfg80211_rx_spurious_frame(struct net_device *dev,
3659 const u8 *addr, gfp_t gfp);
3662 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3663 * @dev: The device the frame matched to
3664 * @addr: the transmitter address
3665 * @gfp: context flags
3667 * This function is used in AP mode (only!) to inform userspace that
3668 * an associated station sent a 4addr frame but that wasn't expected.
3669 * It is allowed and desirable to send this event only once for each
3670 * station to avoid event flooding.
3671 * Return: %true if the frame was passed to userspace (or this failed
3672 * for a reason other than not having a subscription.)
3674 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
3675 const u8 *addr, gfp_t gfp);
3678 * cfg80211_probe_status - notify userspace about probe status
3679 * @dev: the device the probe was sent on
3680 * @addr: the address of the peer
3681 * @cookie: the cookie filled in @probe_client previously
3682 * @acked: indicates whether probe was acked or not
3683 * @gfp: allocation flags
3685 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
3686 u64 cookie, bool acked, gfp_t gfp);
3689 * cfg80211_report_obss_beacon - report beacon from other APs
3690 * @wiphy: The wiphy that received the beacon
3692 * @len: length of the frame
3693 * @freq: frequency the frame was received on
3694 * @sig_dbm: signal strength in mBm, or 0 if unknown
3696 * Use this function to report to userspace when a beacon was
3697 * received. It is not useful to call this when there is no
3698 * netdev that is in AP/GO mode.
3700 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
3701 const u8 *frame, size_t len,
3702 int freq, int sig_dbm);
3705 * cfg80211_reg_can_beacon - check if beaconing is allowed
3707 * @chandef: the channel definition
3709 * Return: %true if there is no secondary channel or the secondary channel(s)
3710 * can be used for beaconing (i.e. is not a radar channel etc.)
3712 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
3713 struct cfg80211_chan_def *chandef);
3716 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
3717 * @dev: the device which switched channels
3718 * @chandef: the new channel definition
3720 * Acquires wdev_lock, so must only be called from sleepable driver context!
3722 void cfg80211_ch_switch_notify(struct net_device *dev,
3723 struct cfg80211_chan_def *chandef);
3726 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
3727 * @dev: the device on which the operation is requested
3728 * @peer: the MAC address of the peer device
3729 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
3730 * NL80211_TDLS_TEARDOWN)
3731 * @reason_code: the reason code for teardown request
3732 * @gfp: allocation flags
3734 * This function is used to request userspace to perform TDLS operation that
3735 * requires knowledge of keys, i.e., link setup or teardown when the AP
3736 * connection uses encryption. This is optional mechanism for the driver to use
3737 * if it can automatically determine when a TDLS link could be useful (e.g.,
3738 * based on traffic and signal strength for a peer).
3740 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
3741 enum nl80211_tdls_operation oper,
3742 u16 reason_code, gfp_t gfp);
3745 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
3746 * @rate: given rate_info to calculate bitrate from
3748 * return 0 if MCS index >= 32
3750 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
3753 * cfg80211_unregister_wdev - remove the given wdev
3754 * @wdev: struct wireless_dev to remove
3756 * Call this function only for wdevs that have no netdev assigned,
3757 * e.g. P2P Devices. It removes the device from the list so that
3758 * it can no longer be used. It is necessary to call this function
3759 * even when cfg80211 requests the removal of the interface by
3760 * calling the del_virtual_intf() callback. The function must also
3761 * be called when the driver wishes to unregister the wdev, e.g.
3762 * when the device is unbound from the driver.
3764 * Requires the RTNL to be held.
3766 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
3769 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
3770 * @ies: the input IE buffer
3771 * @len: the input length
3772 * @attr: the attribute ID to find
3773 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
3774 * if the function is only called to get the needed buffer size
3775 * @bufsize: size of the output buffer
3777 * The function finds a given P2P attribute in the (vendor) IEs and
3778 * copies its contents to the given buffer.
3780 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
3781 * malformed or the attribute can't be found (respectively), or the
3782 * length of the found attribute (which can be zero).
3784 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
3785 enum ieee80211_p2p_attr_id attr,
3786 u8 *buf, unsigned int bufsize);
3788 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3790 /* wiphy_printk helpers, similar to dev_printk */
3792 #define wiphy_printk(level, wiphy, format, args...) \
3793 dev_printk(level, &(wiphy)->dev, format, ##args)
3794 #define wiphy_emerg(wiphy, format, args...) \
3795 dev_emerg(&(wiphy)->dev, format, ##args)
3796 #define wiphy_alert(wiphy, format, args...) \
3797 dev_alert(&(wiphy)->dev, format, ##args)
3798 #define wiphy_crit(wiphy, format, args...) \
3799 dev_crit(&(wiphy)->dev, format, ##args)
3800 #define wiphy_err(wiphy, format, args...) \
3801 dev_err(&(wiphy)->dev, format, ##args)
3802 #define wiphy_warn(wiphy, format, args...) \
3803 dev_warn(&(wiphy)->dev, format, ##args)
3804 #define wiphy_notice(wiphy, format, args...) \
3805 dev_notice(&(wiphy)->dev, format, ##args)
3806 #define wiphy_info(wiphy, format, args...) \
3807 dev_info(&(wiphy)->dev, format, ##args)
3809 #define wiphy_debug(wiphy, format, args...) \
3810 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3812 #define wiphy_dbg(wiphy, format, args...) \
3813 dev_dbg(&(wiphy)->dev, format, ##args)
3815 #if defined(VERBOSE_DEBUG)
3816 #define wiphy_vdbg wiphy_dbg
3818 #define wiphy_vdbg(wiphy, format, args...) \
3821 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3827 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3828 * of using a WARN/WARN_ON to get the message out, including the
3829 * file/line information and a backtrace.
3831 #define wiphy_WARN(wiphy, format, args...) \
3832 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3834 #endif /* __NET_CFG80211_H */