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 <linux/net.h>
23 #include <net/regulatory.h>
28 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
29 * userspace and drivers, and offers some utility functionality associated
30 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
31 * by all modern wireless drivers in Linux, so that they offer a consistent
32 * API through nl80211. For backward compatibility, cfg80211 also offers
33 * wireless extensions to userspace, but hides them from drivers completely.
35 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
41 * DOC: Device registration
43 * In order for a driver to use cfg80211, it must register the hardware device
44 * with cfg80211. This happens through a number of hardware capability structs
47 * The fundamental structure for each device is the 'wiphy', of which each
48 * instance describes a physical wireless device connected to the system. Each
49 * such wiphy can have zero, one, or many virtual interfaces associated with
50 * it, which need to be identified as such by pointing the network interface's
51 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
52 * the wireless part of the interface, normally this struct is embedded in the
53 * network interface's private data area. Drivers can optionally allow creating
54 * or destroying virtual interfaces on the fly, but without at least one or the
55 * ability to create some the wireless device isn't useful.
57 * Each wiphy structure contains device capability information, and also has
58 * a pointer to the various operations the driver offers. The definitions and
59 * structures here describe these capabilities in detail.
65 * wireless hardware capability structures
69 * enum ieee80211_band - supported frequency bands
71 * The bands are assigned this way because the supported
72 * bitrates differ in these bands.
74 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
75 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
76 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
77 * @IEEE80211_NUM_BANDS: number of defined bands
80 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
81 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
82 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
89 * enum ieee80211_channel_flags - channel flags
91 * Channel flags set by the regulatory control code.
93 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
94 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
96 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
97 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
98 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
100 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
102 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
103 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
104 * this flag indicates that an 80 MHz channel cannot use this
105 * channel as the control or any of the secondary channels.
106 * This may be due to the driver or due to regulatory bandwidth
108 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
109 * this flag indicates that an 160 MHz channel cannot use this
110 * channel as the control or any of the secondary channels.
111 * This may be due to the driver or due to regulatory bandwidth
114 enum ieee80211_channel_flags {
115 IEEE80211_CHAN_DISABLED = 1<<0,
116 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
117 IEEE80211_CHAN_NO_IBSS = 1<<2,
118 IEEE80211_CHAN_RADAR = 1<<3,
119 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
120 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
121 IEEE80211_CHAN_NO_OFDM = 1<<6,
122 IEEE80211_CHAN_NO_80MHZ = 1<<7,
123 IEEE80211_CHAN_NO_160MHZ = 1<<8,
126 #define IEEE80211_CHAN_NO_HT40 \
127 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
129 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
130 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
133 * struct ieee80211_channel - channel definition
135 * This structure describes a single channel for use
138 * @center_freq: center frequency in MHz
139 * @hw_value: hardware-specific value for the channel
140 * @flags: channel flags from &enum ieee80211_channel_flags.
141 * @orig_flags: channel flags at registration time, used by regulatory
142 * code to support devices with additional restrictions
143 * @band: band this channel belongs to.
144 * @max_antenna_gain: maximum antenna gain in dBi
145 * @max_power: maximum transmission power (in dBm)
146 * @max_reg_power: maximum regulatory transmission power (in dBm)
147 * @beacon_found: helper to regulatory code to indicate when a beacon
148 * has been found on this channel. Use regulatory_hint_found_beacon()
149 * to enable this, this is useful only on 5 GHz band.
150 * @orig_mag: internal use
151 * @orig_mpwr: internal use
152 * @dfs_state: current state of this channel. Only relevant if radar is required
154 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
156 struct ieee80211_channel {
157 enum ieee80211_band band;
161 int max_antenna_gain;
166 int orig_mag, orig_mpwr;
167 enum nl80211_dfs_state dfs_state;
168 unsigned long dfs_state_entered;
172 * enum ieee80211_rate_flags - rate flags
174 * Hardware/specification flags for rates. These are structured
175 * in a way that allows using the same bitrate structure for
176 * different bands/PHY modes.
178 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
179 * preamble on this bitrate; only relevant in 2.4GHz band and
181 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
182 * when used with 802.11a (on the 5 GHz band); filled by the
183 * core code when registering the wiphy.
184 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
185 * when used with 802.11b (on the 2.4 GHz band); filled by the
186 * core code when registering the wiphy.
187 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
188 * when used with 802.11g (on the 2.4 GHz band); filled by the
189 * core code when registering the wiphy.
190 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
191 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
192 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
194 enum ieee80211_rate_flags {
195 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
196 IEEE80211_RATE_MANDATORY_A = 1<<1,
197 IEEE80211_RATE_MANDATORY_B = 1<<2,
198 IEEE80211_RATE_MANDATORY_G = 1<<3,
199 IEEE80211_RATE_ERP_G = 1<<4,
200 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
201 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
205 * struct ieee80211_rate - bitrate definition
207 * This structure describes a bitrate that an 802.11 PHY can
208 * operate with. The two values @hw_value and @hw_value_short
209 * are only for driver use when pointers to this structure are
212 * @flags: rate-specific flags
213 * @bitrate: bitrate in units of 100 Kbps
214 * @hw_value: driver/hardware value for this rate
215 * @hw_value_short: driver/hardware value for this rate when
216 * short preamble is used
218 struct ieee80211_rate {
221 u16 hw_value, hw_value_short;
225 * struct ieee80211_sta_ht_cap - STA's HT capabilities
227 * This structure describes most essential parameters needed
228 * to describe 802.11n HT capabilities for an STA.
230 * @ht_supported: is HT supported by the STA
231 * @cap: HT capabilities map as described in 802.11n spec
232 * @ampdu_factor: Maximum A-MPDU length factor
233 * @ampdu_density: Minimum A-MPDU spacing
234 * @mcs: Supported MCS rates
236 struct ieee80211_sta_ht_cap {
237 u16 cap; /* use IEEE80211_HT_CAP_ */
241 struct ieee80211_mcs_info mcs;
245 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
247 * This structure describes most essential parameters needed
248 * to describe 802.11ac VHT capabilities for an STA.
250 * @vht_supported: is VHT supported by the STA
251 * @cap: VHT capabilities map as described in 802.11ac spec
252 * @vht_mcs: Supported VHT MCS rates
254 struct ieee80211_sta_vht_cap {
256 u32 cap; /* use IEEE80211_VHT_CAP_ */
257 struct ieee80211_vht_mcs_info vht_mcs;
261 * struct ieee80211_supported_band - frequency band definition
263 * This structure describes a frequency band a wiphy
264 * is able to operate in.
266 * @channels: Array of channels the hardware can operate in
268 * @band: the band this structure represents
269 * @n_channels: Number of channels in @channels
270 * @bitrates: Array of bitrates the hardware can operate with
271 * in this band. Must be sorted to give a valid "supported
272 * rates" IE, i.e. CCK rates first, then OFDM.
273 * @n_bitrates: Number of bitrates in @bitrates
274 * @ht_cap: HT capabilities in this band
275 * @vht_cap: VHT capabilities in this band
277 struct ieee80211_supported_band {
278 struct ieee80211_channel *channels;
279 struct ieee80211_rate *bitrates;
280 enum ieee80211_band band;
283 struct ieee80211_sta_ht_cap ht_cap;
284 struct ieee80211_sta_vht_cap vht_cap;
288 * Wireless hardware/device configuration structures and methods
292 * DOC: Actions and configuration
294 * Each wireless device and each virtual interface offer a set of configuration
295 * operations and other actions that are invoked by userspace. Each of these
296 * actions is described in the operations structure, and the parameters these
297 * operations use are described separately.
299 * Additionally, some operations are asynchronous and expect to get status
300 * information via some functions that drivers need to call.
302 * Scanning and BSS list handling with its associated functionality is described
303 * in a separate chapter.
307 * struct vif_params - describes virtual interface parameters
308 * @use_4addr: use 4-address frames
309 * @macaddr: address to use for this virtual interface. This will only
310 * be used for non-netdevice interfaces. If this parameter is set
311 * to zero address the driver may determine the address as needed.
315 u8 macaddr[ETH_ALEN];
319 * struct key_params - key information
321 * Information about a key
324 * @key_len: length of key material
325 * @cipher: cipher suite selector
326 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
327 * with the get_key() callback, must be in little endian,
328 * length given by @seq_len.
329 * @seq_len: length of @seq.
340 * struct cfg80211_chan_def - channel definition
341 * @chan: the (control) channel
342 * @width: channel width
343 * @center_freq1: center frequency of first segment
344 * @center_freq2: center frequency of second segment
345 * (only with 80+80 MHz)
347 struct cfg80211_chan_def {
348 struct ieee80211_channel *chan;
349 enum nl80211_chan_width width;
355 * cfg80211_get_chandef_type - return old channel type from chandef
356 * @chandef: the channel definition
358 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
359 * chandef, which must have a bandwidth allowing this conversion.
361 static inline enum nl80211_channel_type
362 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
364 switch (chandef->width) {
365 case NL80211_CHAN_WIDTH_20_NOHT:
366 return NL80211_CHAN_NO_HT;
367 case NL80211_CHAN_WIDTH_20:
368 return NL80211_CHAN_HT20;
369 case NL80211_CHAN_WIDTH_40:
370 if (chandef->center_freq1 > chandef->chan->center_freq)
371 return NL80211_CHAN_HT40PLUS;
372 return NL80211_CHAN_HT40MINUS;
375 return NL80211_CHAN_NO_HT;
380 * cfg80211_chandef_create - create channel definition using channel type
381 * @chandef: the channel definition struct to fill
382 * @channel: the control channel
383 * @chantype: the channel type
385 * Given a channel type, create a channel definition.
387 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
388 struct ieee80211_channel *channel,
389 enum nl80211_channel_type chantype);
392 * cfg80211_chandef_identical - check if two channel definitions are identical
393 * @chandef1: first channel definition
394 * @chandef2: second channel definition
396 * Return: %true if the channels defined by the channel definitions are
397 * identical, %false otherwise.
400 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
401 const struct cfg80211_chan_def *chandef2)
403 return (chandef1->chan == chandef2->chan &&
404 chandef1->width == chandef2->width &&
405 chandef1->center_freq1 == chandef2->center_freq1 &&
406 chandef1->center_freq2 == chandef2->center_freq2);
410 * cfg80211_chandef_compatible - check if two channel definitions are compatible
411 * @chandef1: first channel definition
412 * @chandef2: second channel definition
414 * Return: %NULL if the given channel definitions are incompatible,
415 * chandef1 or chandef2 otherwise.
417 const struct cfg80211_chan_def *
418 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
419 const struct cfg80211_chan_def *chandef2);
422 * cfg80211_chandef_valid - check if a channel definition is valid
423 * @chandef: the channel definition to check
424 * Return: %true if the channel definition is valid. %false otherwise.
426 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
429 * cfg80211_chandef_usable - check if secondary channels can be used
430 * @wiphy: the wiphy to validate against
431 * @chandef: the channel definition to check
432 * @prohibited_flags: the regulatory channel flags that must not be set
433 * Return: %true if secondary channels are usable. %false otherwise.
435 bool cfg80211_chandef_usable(struct wiphy *wiphy,
436 const struct cfg80211_chan_def *chandef,
437 u32 prohibited_flags);
440 * cfg80211_chandef_dfs_required - checks if radar detection is required
441 * @wiphy: the wiphy to validate against
442 * @chandef: the channel definition to check
443 * Return: 1 if radar detection is required, 0 if it is not, < 0 on error
445 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
446 const struct cfg80211_chan_def *chandef);
449 * ieee80211_chandef_rate_flags - returns rate flags for a channel
451 * In some channel types, not all rates may be used - for example CCK
452 * rates may not be used in 5/10 MHz channels.
454 * @chandef: channel definition for the channel
456 * Returns: rate flags which apply for this channel
458 static inline enum ieee80211_rate_flags
459 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
461 switch (chandef->width) {
462 case NL80211_CHAN_WIDTH_5:
463 return IEEE80211_RATE_SUPPORTS_5MHZ;
464 case NL80211_CHAN_WIDTH_10:
465 return IEEE80211_RATE_SUPPORTS_10MHZ;
473 * ieee80211_chandef_max_power - maximum transmission power for the chandef
475 * In some regulations, the transmit power may depend on the configured channel
476 * bandwidth which may be defined as dBm/MHz. This function returns the actual
477 * max_power for non-standard (20 MHz) channels.
479 * @chandef: channel definition for the channel
481 * Returns: maximum allowed transmission power in dBm for the chandef
484 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
486 switch (chandef->width) {
487 case NL80211_CHAN_WIDTH_5:
488 return min(chandef->chan->max_reg_power - 6,
489 chandef->chan->max_power);
490 case NL80211_CHAN_WIDTH_10:
491 return min(chandef->chan->max_reg_power - 3,
492 chandef->chan->max_power);
496 return chandef->chan->max_power;
500 * enum survey_info_flags - survey information flags
502 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
503 * @SURVEY_INFO_IN_USE: channel is currently being used
504 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
505 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
506 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
507 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
508 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
510 * Used by the driver to indicate which info in &struct survey_info
511 * it has filled in during the get_survey().
513 enum survey_info_flags {
514 SURVEY_INFO_NOISE_DBM = 1<<0,
515 SURVEY_INFO_IN_USE = 1<<1,
516 SURVEY_INFO_CHANNEL_TIME = 1<<2,
517 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
518 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
519 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
520 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
524 * struct survey_info - channel survey response
526 * @channel: the channel this survey record reports, mandatory
527 * @filled: bitflag of flags from &enum survey_info_flags
528 * @noise: channel noise in dBm. This and all following fields are
530 * @channel_time: amount of time in ms the radio spent on the channel
531 * @channel_time_busy: amount of time the primary channel was sensed busy
532 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
533 * @channel_time_rx: amount of time the radio spent receiving data
534 * @channel_time_tx: amount of time the radio spent transmitting data
536 * Used by dump_survey() to report back per-channel survey information.
538 * This structure can later be expanded with things like
539 * channel duty cycle etc.
542 struct ieee80211_channel *channel;
544 u64 channel_time_busy;
545 u64 channel_time_ext_busy;
553 * struct cfg80211_crypto_settings - Crypto settings
554 * @wpa_versions: indicates which, if any, WPA versions are enabled
555 * (from enum nl80211_wpa_versions)
556 * @cipher_group: group key cipher suite (or 0 if unset)
557 * @n_ciphers_pairwise: number of AP supported unicast ciphers
558 * @ciphers_pairwise: unicast key cipher suites
559 * @n_akm_suites: number of AKM suites
560 * @akm_suites: AKM suites
561 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
562 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
563 * required to assume that the port is unauthorized until authorized by
564 * user space. Otherwise, port is marked authorized by default.
565 * @control_port_ethertype: the control port protocol that should be
566 * allowed through even on unauthorized ports
567 * @control_port_no_encrypt: TRUE to prevent encryption of control port
570 struct cfg80211_crypto_settings {
573 int n_ciphers_pairwise;
574 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
576 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
578 __be16 control_port_ethertype;
579 bool control_port_no_encrypt;
583 * struct cfg80211_beacon_data - beacon data
584 * @head: head portion of beacon (before TIM IE)
585 * or %NULL if not changed
586 * @tail: tail portion of beacon (after TIM IE)
587 * or %NULL if not changed
588 * @head_len: length of @head
589 * @tail_len: length of @tail
590 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
591 * @beacon_ies_len: length of beacon_ies in octets
592 * @proberesp_ies: extra information element(s) to add into Probe Response
594 * @proberesp_ies_len: length of proberesp_ies in octets
595 * @assocresp_ies: extra information element(s) to add into (Re)Association
596 * Response frames or %NULL
597 * @assocresp_ies_len: length of assocresp_ies in octets
598 * @probe_resp_len: length of probe response template (@probe_resp)
599 * @probe_resp: probe response template (AP mode only)
601 struct cfg80211_beacon_data {
602 const u8 *head, *tail;
603 const u8 *beacon_ies;
604 const u8 *proberesp_ies;
605 const u8 *assocresp_ies;
606 const u8 *probe_resp;
608 size_t head_len, tail_len;
609 size_t beacon_ies_len;
610 size_t proberesp_ies_len;
611 size_t assocresp_ies_len;
612 size_t probe_resp_len;
620 * struct cfg80211_acl_data - Access control list data
622 * @acl_policy: ACL policy to be applied on the station's
623 * entry specified by mac_addr
624 * @n_acl_entries: Number of MAC address entries passed
625 * @mac_addrs: List of MAC addresses of stations to be used for ACL
627 struct cfg80211_acl_data {
628 enum nl80211_acl_policy acl_policy;
632 struct mac_address mac_addrs[];
636 * struct cfg80211_ap_settings - AP configuration
638 * Used to configure an AP interface.
640 * @chandef: defines the channel to use
641 * @beacon: beacon data
642 * @beacon_interval: beacon interval
643 * @dtim_period: DTIM period
644 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
646 * @ssid_len: length of @ssid
647 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
648 * @crypto: crypto settings
649 * @privacy: the BSS uses privacy
650 * @auth_type: Authentication type (algorithm)
651 * @inactivity_timeout: time in seconds to determine station's inactivity.
652 * @p2p_ctwindow: P2P CT Window
653 * @p2p_opp_ps: P2P opportunistic PS
654 * @acl: ACL configuration used by the drivers which has support for
655 * MAC address based access control
656 * @radar_required: set if radar detection is required
658 struct cfg80211_ap_settings {
659 struct cfg80211_chan_def chandef;
661 struct cfg80211_beacon_data beacon;
663 int beacon_interval, dtim_period;
666 enum nl80211_hidden_ssid hidden_ssid;
667 struct cfg80211_crypto_settings crypto;
669 enum nl80211_auth_type auth_type;
670 int inactivity_timeout;
673 const struct cfg80211_acl_data *acl;
678 * struct cfg80211_csa_settings - channel switch settings
680 * Used for channel switch
682 * @chandef: defines the channel to use after the switch
683 * @beacon_csa: beacon data while performing the switch
684 * @counter_offset_beacon: offset for the counter within the beacon (tail)
685 * @counter_offset_presp: offset for the counter within the probe response
686 * @beacon_after: beacon data to be used on the new channel
687 * @radar_required: whether radar detection is required on the new channel
688 * @block_tx: whether transmissions should be blocked while changing
689 * @count: number of beacons until switch
691 struct cfg80211_csa_settings {
692 struct cfg80211_chan_def chandef;
693 struct cfg80211_beacon_data beacon_csa;
694 u16 counter_offset_beacon, counter_offset_presp;
695 struct cfg80211_beacon_data beacon_after;
702 * enum station_parameters_apply_mask - station parameter values to apply
703 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
704 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
705 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
707 * Not all station parameters have in-band "no change" signalling,
708 * for those that don't these flags will are used.
710 enum station_parameters_apply_mask {
711 STATION_PARAM_APPLY_UAPSD = BIT(0),
712 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
713 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
717 * struct station_parameters - station parameters
719 * Used to change and create a new station.
721 * @vlan: vlan interface station should belong to
722 * @supported_rates: supported rates in IEEE 802.11 format
723 * (or NULL for no change)
724 * @supported_rates_len: number of supported rates
725 * @sta_flags_mask: station flags that changed
726 * (bitmask of BIT(NL80211_STA_FLAG_...))
727 * @sta_flags_set: station flags values
728 * (bitmask of BIT(NL80211_STA_FLAG_...))
729 * @listen_interval: listen interval or -1 for no change
730 * @aid: AID or zero for no change
731 * @plink_action: plink action to take
732 * @plink_state: set the peer link state for a station
733 * @ht_capa: HT capabilities of station
734 * @vht_capa: VHT capabilities of station
735 * @uapsd_queues: bitmap of queues configured for uapsd. same format
736 * as the AC bitmap in the QoS info field
737 * @max_sp: max Service Period. same format as the MAX_SP in the
738 * QoS info field (but already shifted down)
739 * @sta_modify_mask: bitmap indicating which parameters changed
740 * (for those that don't have a natural "no change" value),
741 * see &enum station_parameters_apply_mask
742 * @local_pm: local link-specific mesh power save mode (no change when set
744 * @capability: station capability
745 * @ext_capab: extended capabilities of the station
746 * @ext_capab_len: number of extended capabilities
748 struct station_parameters {
749 const u8 *supported_rates;
750 struct net_device *vlan;
751 u32 sta_flags_mask, sta_flags_set;
755 u8 supported_rates_len;
758 const struct ieee80211_ht_cap *ht_capa;
759 const struct ieee80211_vht_cap *vht_capa;
762 enum nl80211_mesh_power_mode local_pm;
769 * enum cfg80211_station_type - the type of station being modified
770 * @CFG80211_STA_AP_CLIENT: client of an AP interface
771 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
772 * the AP MLME in the device
773 * @CFG80211_STA_AP_STA: AP station on managed interface
774 * @CFG80211_STA_IBSS: IBSS station
775 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
776 * while TDLS setup is in progress, it moves out of this state when
777 * being marked authorized; use this only if TDLS with external setup is
779 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
780 * entry that is operating, has been marked authorized by userspace)
781 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
782 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
784 enum cfg80211_station_type {
785 CFG80211_STA_AP_CLIENT,
786 CFG80211_STA_AP_MLME_CLIENT,
789 CFG80211_STA_TDLS_PEER_SETUP,
790 CFG80211_STA_TDLS_PEER_ACTIVE,
791 CFG80211_STA_MESH_PEER_KERNEL,
792 CFG80211_STA_MESH_PEER_USER,
796 * cfg80211_check_station_change - validate parameter changes
797 * @wiphy: the wiphy this operates on
798 * @params: the new parameters for a station
799 * @statype: the type of station being modified
801 * Utility function for the @change_station driver method. Call this function
802 * with the appropriate station type looking up the station (and checking that
803 * it exists). It will verify whether the station change is acceptable, and if
804 * not will return an error code. Note that it may modify the parameters for
805 * backward compatibility reasons, so don't use them before calling this.
807 int cfg80211_check_station_change(struct wiphy *wiphy,
808 struct station_parameters *params,
809 enum cfg80211_station_type statype);
812 * enum station_info_flags - station information flags
814 * Used by the driver to indicate which info in &struct station_info
815 * it has filled in during get_station() or dump_station().
817 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
818 * @STATION_INFO_RX_BYTES: @rx_bytes filled
819 * @STATION_INFO_TX_BYTES: @tx_bytes filled
820 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
821 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
822 * @STATION_INFO_LLID: @llid filled
823 * @STATION_INFO_PLID: @plid filled
824 * @STATION_INFO_PLINK_STATE: @plink_state filled
825 * @STATION_INFO_SIGNAL: @signal filled
826 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
827 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
828 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
829 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
830 * @STATION_INFO_TX_RETRIES: @tx_retries filled
831 * @STATION_INFO_TX_FAILED: @tx_failed filled
832 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
833 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
834 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
835 * @STATION_INFO_BSS_PARAM: @bss_param filled
836 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
837 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
838 * @STATION_INFO_STA_FLAGS: @sta_flags filled
839 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
840 * @STATION_INFO_T_OFFSET: @t_offset filled
841 * @STATION_INFO_LOCAL_PM: @local_pm filled
842 * @STATION_INFO_PEER_PM: @peer_pm filled
843 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
844 * @STATION_INFO_CHAIN_SIGNAL: @chain_signal filled
845 * @STATION_INFO_CHAIN_SIGNAL_AVG: @chain_signal_avg filled
847 enum station_info_flags {
848 STATION_INFO_INACTIVE_TIME = 1<<0,
849 STATION_INFO_RX_BYTES = 1<<1,
850 STATION_INFO_TX_BYTES = 1<<2,
851 STATION_INFO_LLID = 1<<3,
852 STATION_INFO_PLID = 1<<4,
853 STATION_INFO_PLINK_STATE = 1<<5,
854 STATION_INFO_SIGNAL = 1<<6,
855 STATION_INFO_TX_BITRATE = 1<<7,
856 STATION_INFO_RX_PACKETS = 1<<8,
857 STATION_INFO_TX_PACKETS = 1<<9,
858 STATION_INFO_TX_RETRIES = 1<<10,
859 STATION_INFO_TX_FAILED = 1<<11,
860 STATION_INFO_RX_DROP_MISC = 1<<12,
861 STATION_INFO_SIGNAL_AVG = 1<<13,
862 STATION_INFO_RX_BITRATE = 1<<14,
863 STATION_INFO_BSS_PARAM = 1<<15,
864 STATION_INFO_CONNECTED_TIME = 1<<16,
865 STATION_INFO_ASSOC_REQ_IES = 1<<17,
866 STATION_INFO_STA_FLAGS = 1<<18,
867 STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
868 STATION_INFO_T_OFFSET = 1<<20,
869 STATION_INFO_LOCAL_PM = 1<<21,
870 STATION_INFO_PEER_PM = 1<<22,
871 STATION_INFO_NONPEER_PM = 1<<23,
872 STATION_INFO_RX_BYTES64 = 1<<24,
873 STATION_INFO_TX_BYTES64 = 1<<25,
874 STATION_INFO_CHAIN_SIGNAL = 1<<26,
875 STATION_INFO_CHAIN_SIGNAL_AVG = 1<<27,
879 * enum station_info_rate_flags - bitrate info flags
881 * Used by the driver to indicate the specific rate transmission
882 * type for 802.11n transmissions.
884 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
885 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
886 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
887 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
888 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
889 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
890 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
891 * @RATE_INFO_FLAGS_60G: 60GHz MCS
893 enum rate_info_flags {
894 RATE_INFO_FLAGS_MCS = BIT(0),
895 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
896 RATE_INFO_FLAGS_40_MHZ_WIDTH = BIT(2),
897 RATE_INFO_FLAGS_80_MHZ_WIDTH = BIT(3),
898 RATE_INFO_FLAGS_80P80_MHZ_WIDTH = BIT(4),
899 RATE_INFO_FLAGS_160_MHZ_WIDTH = BIT(5),
900 RATE_INFO_FLAGS_SHORT_GI = BIT(6),
901 RATE_INFO_FLAGS_60G = BIT(7),
905 * struct rate_info - bitrate information
907 * Information about a receiving or transmitting bitrate
909 * @flags: bitflag of flags from &enum rate_info_flags
910 * @mcs: mcs index if struct describes a 802.11n bitrate
911 * @legacy: bitrate in 100kbit/s for 802.11abg
912 * @nss: number of streams (VHT only)
922 * enum station_info_rate_flags - bitrate info flags
924 * Used by the driver to indicate the specific rate transmission
925 * type for 802.11n transmissions.
927 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
928 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
929 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
931 enum bss_param_flags {
932 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
933 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
934 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
938 * struct sta_bss_parameters - BSS parameters for the attached station
940 * Information about the currently associated BSS
942 * @flags: bitflag of flags from &enum bss_param_flags
943 * @dtim_period: DTIM period for the BSS
944 * @beacon_interval: beacon interval
946 struct sta_bss_parameters {
952 #define IEEE80211_MAX_CHAINS 4
955 * struct station_info - station information
957 * Station information filled by driver for get_station() and dump_station.
959 * @filled: bitflag of flags from &enum station_info_flags
960 * @connected_time: time(in secs) since a station is last connected
961 * @inactive_time: time since last station activity (tx/rx) in milliseconds
962 * @rx_bytes: bytes received from this station
963 * @tx_bytes: bytes transmitted to this station
964 * @llid: mesh local link id
965 * @plid: mesh peer link id
966 * @plink_state: mesh peer link state
967 * @signal: The signal strength, type depends on the wiphy's signal_type.
968 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
969 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
970 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
971 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
972 * @chain_signal: per-chain signal strength of last received packet in dBm
973 * @chain_signal_avg: per-chain signal strength average in dBm
974 * @txrate: current unicast bitrate from this station
975 * @rxrate: current unicast bitrate to this station
976 * @rx_packets: packets received from this station
977 * @tx_packets: packets transmitted to this station
978 * @tx_retries: cumulative retry counts
979 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
980 * @rx_dropped_misc: Dropped for un-specified reason.
981 * @bss_param: current BSS parameters
982 * @generation: generation number for nl80211 dumps.
983 * This number should increase every time the list of stations
984 * changes, i.e. when a station is added or removed, so that
985 * userspace can tell whether it got a consistent snapshot.
986 * @assoc_req_ies: IEs from (Re)Association Request.
987 * This is used only when in AP mode with drivers that do not use
988 * user space MLME/SME implementation. The information is provided for
989 * the cfg80211_new_sta() calls to notify user space of the IEs.
990 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
991 * @sta_flags: station flags mask & values
992 * @beacon_loss_count: Number of times beacon loss event has triggered.
993 * @t_offset: Time offset of the station relative to this host.
994 * @local_pm: local mesh STA power save mode
995 * @peer_pm: peer mesh STA power save mode
996 * @nonpeer_pm: non-peer mesh STA power save mode
998 struct station_info {
1011 s8 chain_signal[IEEE80211_MAX_CHAINS];
1012 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1014 struct rate_info txrate;
1015 struct rate_info rxrate;
1020 u32 rx_dropped_misc;
1021 struct sta_bss_parameters bss_param;
1022 struct nl80211_sta_flag_update sta_flags;
1026 const u8 *assoc_req_ies;
1027 size_t assoc_req_ies_len;
1029 u32 beacon_loss_count;
1031 enum nl80211_mesh_power_mode local_pm;
1032 enum nl80211_mesh_power_mode peer_pm;
1033 enum nl80211_mesh_power_mode nonpeer_pm;
1036 * Note: Add a new enum station_info_flags value for each new field and
1037 * use it to check which fields are initialized.
1042 * enum monitor_flags - monitor flags
1044 * Monitor interface configuration flags. Note that these must be the bits
1045 * according to the nl80211 flags.
1047 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1048 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1049 * @MONITOR_FLAG_CONTROL: pass control frames
1050 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1051 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1052 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1054 enum monitor_flags {
1055 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1056 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1057 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1058 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1059 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1060 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1064 * enum mpath_info_flags - mesh path information flags
1066 * Used by the driver to indicate which info in &struct mpath_info it has filled
1067 * in during get_station() or dump_station().
1069 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1070 * @MPATH_INFO_SN: @sn filled
1071 * @MPATH_INFO_METRIC: @metric filled
1072 * @MPATH_INFO_EXPTIME: @exptime filled
1073 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1074 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1075 * @MPATH_INFO_FLAGS: @flags filled
1077 enum mpath_info_flags {
1078 MPATH_INFO_FRAME_QLEN = BIT(0),
1079 MPATH_INFO_SN = BIT(1),
1080 MPATH_INFO_METRIC = BIT(2),
1081 MPATH_INFO_EXPTIME = BIT(3),
1082 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1083 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1084 MPATH_INFO_FLAGS = BIT(6),
1088 * struct mpath_info - mesh path information
1090 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1092 * @filled: bitfield of flags from &enum mpath_info_flags
1093 * @frame_qlen: number of queued frames for this destination
1094 * @sn: target sequence number
1095 * @metric: metric (cost) of this mesh path
1096 * @exptime: expiration time for the mesh path from now, in msecs
1097 * @flags: mesh path flags
1098 * @discovery_timeout: total mesh path discovery timeout, in msecs
1099 * @discovery_retries: mesh path discovery retries
1100 * @generation: generation number for nl80211 dumps.
1101 * This number should increase every time the list of mesh paths
1102 * changes, i.e. when a station is added or removed, so that
1103 * userspace can tell whether it got a consistent snapshot.
1111 u32 discovery_timeout;
1112 u8 discovery_retries;
1119 * struct bss_parameters - BSS parameters
1121 * Used to change BSS parameters (mainly for AP mode).
1123 * @use_cts_prot: Whether to use CTS protection
1124 * (0 = no, 1 = yes, -1 = do not change)
1125 * @use_short_preamble: Whether the use of short preambles is allowed
1126 * (0 = no, 1 = yes, -1 = do not change)
1127 * @use_short_slot_time: Whether the use of short slot time is allowed
1128 * (0 = no, 1 = yes, -1 = do not change)
1129 * @basic_rates: basic rates in IEEE 802.11 format
1130 * (or NULL for no change)
1131 * @basic_rates_len: number of basic rates
1132 * @ap_isolate: do not forward packets between connected stations
1133 * @ht_opmode: HT Operation mode
1134 * (u16 = opmode, -1 = do not change)
1135 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1136 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1138 struct bss_parameters {
1140 int use_short_preamble;
1141 int use_short_slot_time;
1146 s8 p2p_ctwindow, p2p_opp_ps;
1150 * struct mesh_config - 802.11s mesh configuration
1152 * These parameters can be changed while the mesh is active.
1154 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1155 * by the Mesh Peering Open message
1156 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1157 * used by the Mesh Peering Open message
1158 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1159 * the mesh peering management to close a mesh peering
1160 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1162 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1163 * be sent to establish a new peer link instance in a mesh
1164 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1165 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1167 * @auto_open_plinks: whether we should automatically open peer links when we
1168 * detect compatible mesh peers
1169 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1170 * synchronize to for 11s default synchronization method
1171 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1172 * that an originator mesh STA can send to a particular path target
1173 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1174 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1175 * a path discovery in milliseconds
1176 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1177 * receiving a PREQ shall consider the forwarding information from the
1178 * root to be valid. (TU = time unit)
1179 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1180 * which a mesh STA can send only one action frame containing a PREQ
1182 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1183 * which a mesh STA can send only one Action frame containing a PERR
1185 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1186 * it takes for an HWMP information element to propagate across the mesh
1187 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1188 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1189 * announcements are transmitted
1190 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1191 * station has access to a broader network beyond the MBSS. (This is
1192 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1193 * only means that the station will announce others it's a mesh gate, but
1194 * not necessarily using the gate announcement protocol. Still keeping the
1195 * same nomenclature to be in sync with the spec)
1196 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1197 * entity (default is TRUE - forwarding entity)
1198 * @rssi_threshold: the threshold for average signal strength of candidate
1199 * station to establish a peer link
1200 * @ht_opmode: mesh HT protection mode
1202 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1203 * receiving a proactive PREQ shall consider the forwarding information to
1204 * the root mesh STA to be valid.
1206 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1207 * PREQs are transmitted.
1208 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1209 * during which a mesh STA can send only one Action frame containing
1210 * a PREQ element for root path confirmation.
1211 * @power_mode: The default mesh power save mode which will be the initial
1212 * setting for new peer links.
1213 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1214 * after transmitting its beacon.
1215 * @plink_timeout: If no tx activity is seen from a STA we've established
1216 * peering with for longer than this time (in seconds), then remove it
1217 * from the STA's list of peers. Default is 30 minutes.
1219 struct mesh_config {
1220 u16 dot11MeshRetryTimeout;
1221 u16 dot11MeshConfirmTimeout;
1222 u16 dot11MeshHoldingTimeout;
1223 u16 dot11MeshMaxPeerLinks;
1224 u8 dot11MeshMaxRetries;
1227 bool auto_open_plinks;
1228 u32 dot11MeshNbrOffsetMaxNeighbor;
1229 u8 dot11MeshHWMPmaxPREQretries;
1230 u32 path_refresh_time;
1231 u16 min_discovery_timeout;
1232 u32 dot11MeshHWMPactivePathTimeout;
1233 u16 dot11MeshHWMPpreqMinInterval;
1234 u16 dot11MeshHWMPperrMinInterval;
1235 u16 dot11MeshHWMPnetDiameterTraversalTime;
1236 u8 dot11MeshHWMPRootMode;
1237 u16 dot11MeshHWMPRannInterval;
1238 bool dot11MeshGateAnnouncementProtocol;
1239 bool dot11MeshForwarding;
1242 u32 dot11MeshHWMPactivePathToRootTimeout;
1243 u16 dot11MeshHWMProotInterval;
1244 u16 dot11MeshHWMPconfirmationInterval;
1245 enum nl80211_mesh_power_mode power_mode;
1246 u16 dot11MeshAwakeWindowDuration;
1251 * struct mesh_setup - 802.11s mesh setup configuration
1252 * @chandef: defines the channel to use
1253 * @mesh_id: the mesh ID
1254 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1255 * @sync_method: which synchronization method to use
1256 * @path_sel_proto: which path selection protocol to use
1257 * @path_metric: which metric to use
1258 * @auth_id: which authentication method this mesh is using
1259 * @ie: vendor information elements (optional)
1260 * @ie_len: length of vendor information elements
1261 * @is_authenticated: this mesh requires authentication
1262 * @is_secure: this mesh uses security
1263 * @user_mpm: userspace handles all MPM functions
1264 * @dtim_period: DTIM period to use
1265 * @beacon_interval: beacon interval to use
1266 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1267 * @basic_rates: basic rates to use when creating the mesh
1269 * These parameters are fixed when the mesh is created.
1272 struct cfg80211_chan_def chandef;
1281 bool is_authenticated;
1285 u16 beacon_interval;
1286 int mcast_rate[IEEE80211_NUM_BANDS];
1291 * struct ieee80211_txq_params - TX queue parameters
1292 * @ac: AC identifier
1293 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1294 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1296 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1298 * @aifs: Arbitration interframe space [0..255]
1300 struct ieee80211_txq_params {
1309 * DOC: Scanning and BSS list handling
1311 * The scanning process itself is fairly simple, but cfg80211 offers quite
1312 * a bit of helper functionality. To start a scan, the scan operation will
1313 * be invoked with a scan definition. This scan definition contains the
1314 * channels to scan, and the SSIDs to send probe requests for (including the
1315 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1316 * probe. Additionally, a scan request may contain extra information elements
1317 * that should be added to the probe request. The IEs are guaranteed to be
1318 * well-formed, and will not exceed the maximum length the driver advertised
1319 * in the wiphy structure.
1321 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1322 * it is responsible for maintaining the BSS list; the driver should not
1323 * maintain a list itself. For this notification, various functions exist.
1325 * Since drivers do not maintain a BSS list, there are also a number of
1326 * functions to search for a BSS and obtain information about it from the
1327 * BSS structure cfg80211 maintains. The BSS list is also made available
1332 * struct cfg80211_ssid - SSID description
1334 * @ssid_len: length of the ssid
1336 struct cfg80211_ssid {
1337 u8 ssid[IEEE80211_MAX_SSID_LEN];
1342 * struct cfg80211_scan_request - scan request description
1344 * @ssids: SSIDs to scan for (active scan only)
1345 * @n_ssids: number of SSIDs
1346 * @channels: channels to scan on.
1347 * @n_channels: total number of channels to scan
1348 * @scan_width: channel width for scanning
1349 * @ie: optional information element(s) to add into Probe Request or %NULL
1350 * @ie_len: length of ie in octets
1351 * @flags: bit field of flags controlling operation
1352 * @rates: bitmap of rates to advertise for each band
1353 * @wiphy: the wiphy this was for
1354 * @scan_start: time (in jiffies) when the scan started
1355 * @wdev: the wireless device to scan for
1356 * @aborted: (internal) scan request was notified as aborted
1357 * @notified: (internal) scan request was notified as done or aborted
1358 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1360 struct cfg80211_scan_request {
1361 struct cfg80211_ssid *ssids;
1364 enum nl80211_bss_scan_width scan_width;
1369 u32 rates[IEEE80211_NUM_BANDS];
1371 struct wireless_dev *wdev;
1374 struct wiphy *wiphy;
1375 unsigned long scan_start;
1376 bool aborted, notified;
1380 struct ieee80211_channel *channels[0];
1384 * struct cfg80211_match_set - sets of attributes to match
1386 * @ssid: SSID to be matched
1388 struct cfg80211_match_set {
1389 struct cfg80211_ssid ssid;
1393 * struct cfg80211_sched_scan_request - scheduled scan request description
1395 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1396 * @n_ssids: number of SSIDs
1397 * @n_channels: total number of channels to scan
1398 * @scan_width: channel width for scanning
1399 * @interval: interval between each scheduled scan cycle
1400 * @ie: optional information element(s) to add into Probe Request or %NULL
1401 * @ie_len: length of ie in octets
1402 * @flags: bit field of flags controlling operation
1403 * @match_sets: sets of parameters to be matched for a scan result
1404 * entry to be considered valid and to be passed to the host
1405 * (others are filtered out).
1406 * If ommited, all results are passed.
1407 * @n_match_sets: number of match sets
1408 * @wiphy: the wiphy this was for
1409 * @dev: the interface
1410 * @scan_start: start time of the scheduled scan
1411 * @channels: channels to scan
1412 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1414 struct cfg80211_sched_scan_request {
1415 struct cfg80211_ssid *ssids;
1418 enum nl80211_bss_scan_width scan_width;
1423 struct cfg80211_match_set *match_sets;
1428 struct wiphy *wiphy;
1429 struct net_device *dev;
1430 unsigned long scan_start;
1433 struct ieee80211_channel *channels[0];
1437 * enum cfg80211_signal_type - signal type
1439 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1440 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1441 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1443 enum cfg80211_signal_type {
1444 CFG80211_SIGNAL_TYPE_NONE,
1445 CFG80211_SIGNAL_TYPE_MBM,
1446 CFG80211_SIGNAL_TYPE_UNSPEC,
1450 * struct cfg80211_bss_ie_data - BSS entry IE data
1451 * @tsf: TSF contained in the frame that carried these IEs
1452 * @rcu_head: internal use, for freeing
1453 * @len: length of the IEs
1456 struct cfg80211_bss_ies {
1458 struct rcu_head rcu_head;
1464 * struct cfg80211_bss - BSS description
1466 * This structure describes a BSS (which may also be a mesh network)
1467 * for use in scan results and similar.
1469 * @channel: channel this BSS is on
1470 * @scan_width: width of the control channel
1471 * @bssid: BSSID of the BSS
1472 * @beacon_interval: the beacon interval as from the frame
1473 * @capability: the capability field in host byte order
1474 * @ies: the information elements (Note that there is no guarantee that these
1475 * are well-formed!); this is a pointer to either the beacon_ies or
1476 * proberesp_ies depending on whether Probe Response frame has been
1477 * received. It is always non-%NULL.
1478 * @beacon_ies: the information elements from the last Beacon frame
1479 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1480 * own the beacon_ies, but they're just pointers to the ones from the
1481 * @hidden_beacon_bss struct)
1482 * @proberesp_ies: the information elements from the last Probe Response frame
1483 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1484 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1485 * that holds the beacon data. @beacon_ies is still valid, of course, and
1486 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1487 * @signal: signal strength value (type depends on the wiphy's signal_type)
1488 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1490 struct cfg80211_bss {
1491 struct ieee80211_channel *channel;
1492 enum nl80211_bss_scan_width scan_width;
1494 const struct cfg80211_bss_ies __rcu *ies;
1495 const struct cfg80211_bss_ies __rcu *beacon_ies;
1496 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1498 struct cfg80211_bss *hidden_beacon_bss;
1502 u16 beacon_interval;
1507 u8 priv[0] __aligned(sizeof(void *));
1511 * ieee80211_bss_get_ie - find IE with given ID
1512 * @bss: the bss to search
1515 * Note that the return value is an RCU-protected pointer, so
1516 * rcu_read_lock() must be held when calling this function.
1517 * Return: %NULL if not found.
1519 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1523 * struct cfg80211_auth_request - Authentication request data
1525 * This structure provides information needed to complete IEEE 802.11
1528 * @bss: The BSS to authenticate with, the callee must obtain a reference
1529 * to it if it needs to keep it.
1530 * @auth_type: Authentication type (algorithm)
1531 * @ie: Extra IEs to add to Authentication frame or %NULL
1532 * @ie_len: Length of ie buffer in octets
1533 * @key_len: length of WEP key for shared key authentication
1534 * @key_idx: index of WEP key for shared key authentication
1535 * @key: WEP key for shared key authentication
1536 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1537 * Authentication transaction sequence number field.
1538 * @sae_data_len: Length of sae_data buffer in octets
1540 struct cfg80211_auth_request {
1541 struct cfg80211_bss *bss;
1544 enum nl80211_auth_type auth_type;
1546 u8 key_len, key_idx;
1548 size_t sae_data_len;
1552 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1554 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1555 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1557 enum cfg80211_assoc_req_flags {
1558 ASSOC_REQ_DISABLE_HT = BIT(0),
1559 ASSOC_REQ_DISABLE_VHT = BIT(1),
1563 * struct cfg80211_assoc_request - (Re)Association request data
1565 * This structure provides information needed to complete IEEE 802.11
1567 * @bss: The BSS to associate with. If the call is successful the driver is
1568 * given a reference that it must give back to cfg80211_send_rx_assoc()
1569 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1570 * association requests while already associating must be rejected.
1571 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1572 * @ie_len: Length of ie buffer in octets
1573 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1574 * @crypto: crypto settings
1575 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1576 * @flags: See &enum cfg80211_assoc_req_flags
1577 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1578 * will be used in ht_capa. Un-supported values will be ignored.
1579 * @ht_capa_mask: The bits of ht_capa which are to be used.
1580 * @vht_capa: VHT capability override
1581 * @vht_capa_mask: VHT capability mask indicating which fields to use
1583 struct cfg80211_assoc_request {
1584 struct cfg80211_bss *bss;
1585 const u8 *ie, *prev_bssid;
1587 struct cfg80211_crypto_settings crypto;
1590 struct ieee80211_ht_cap ht_capa;
1591 struct ieee80211_ht_cap ht_capa_mask;
1592 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1596 * struct cfg80211_deauth_request - Deauthentication request data
1598 * This structure provides information needed to complete IEEE 802.11
1601 * @bssid: the BSSID of the BSS to deauthenticate from
1602 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1603 * @ie_len: Length of ie buffer in octets
1604 * @reason_code: The reason code for the deauthentication
1605 * @local_state_change: if set, change local state only and
1606 * do not set a deauth frame
1608 struct cfg80211_deauth_request {
1613 bool local_state_change;
1617 * struct cfg80211_disassoc_request - Disassociation request data
1619 * This structure provides information needed to complete IEEE 802.11
1622 * @bss: the BSS to disassociate from
1623 * @ie: Extra IEs to add to Disassociation frame or %NULL
1624 * @ie_len: Length of ie buffer in octets
1625 * @reason_code: The reason code for the disassociation
1626 * @local_state_change: This is a request for a local state only, i.e., no
1627 * Disassociation frame is to be transmitted.
1629 struct cfg80211_disassoc_request {
1630 struct cfg80211_bss *bss;
1634 bool local_state_change;
1638 * struct cfg80211_ibss_params - IBSS parameters
1640 * This structure defines the IBSS parameters for the join_ibss()
1643 * @ssid: The SSID, will always be non-null.
1644 * @ssid_len: The length of the SSID, will always be non-zero.
1645 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1646 * search for IBSSs with a different BSSID.
1647 * @chandef: defines the channel to use if no other IBSS to join can be found
1648 * @channel_fixed: The channel should be fixed -- do not search for
1649 * IBSSs to join on other channels.
1650 * @ie: information element(s) to include in the beacon
1651 * @ie_len: length of that
1652 * @beacon_interval: beacon interval to use
1653 * @privacy: this is a protected network, keys will be configured
1655 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1656 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1657 * required to assume that the port is unauthorized until authorized by
1658 * user space. Otherwise, port is marked authorized by default.
1659 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1660 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1661 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1662 * will be used in ht_capa. Un-supported values will be ignored.
1663 * @ht_capa_mask: The bits of ht_capa which are to be used.
1665 struct cfg80211_ibss_params {
1668 struct cfg80211_chan_def chandef;
1670 u8 ssid_len, ie_len;
1671 u16 beacon_interval;
1676 int mcast_rate[IEEE80211_NUM_BANDS];
1677 struct ieee80211_ht_cap ht_capa;
1678 struct ieee80211_ht_cap ht_capa_mask;
1682 * struct cfg80211_connect_params - Connection parameters
1684 * This structure provides information needed to complete IEEE 802.11
1685 * authentication and association.
1687 * @channel: The channel to use or %NULL if not specified (auto-select based
1689 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1692 * @ssid_len: Length of ssid in octets
1693 * @auth_type: Authentication type (algorithm)
1694 * @ie: IEs for association request
1695 * @ie_len: Length of assoc_ie in octets
1696 * @privacy: indicates whether privacy-enabled APs should be used
1697 * @mfp: indicate whether management frame protection is used
1698 * @crypto: crypto settings
1699 * @key_len: length of WEP key for shared key authentication
1700 * @key_idx: index of WEP key for shared key authentication
1701 * @key: WEP key for shared key authentication
1702 * @flags: See &enum cfg80211_assoc_req_flags
1703 * @bg_scan_period: Background scan period in seconds
1704 * or -1 to indicate that default value is to be used.
1705 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1706 * will be used in ht_capa. Un-supported values will be ignored.
1707 * @ht_capa_mask: The bits of ht_capa which are to be used.
1708 * @vht_capa: VHT Capability overrides
1709 * @vht_capa_mask: The bits of vht_capa which are to be used.
1711 struct cfg80211_connect_params {
1712 struct ieee80211_channel *channel;
1716 enum nl80211_auth_type auth_type;
1720 enum nl80211_mfp mfp;
1721 struct cfg80211_crypto_settings crypto;
1723 u8 key_len, key_idx;
1726 struct ieee80211_ht_cap ht_capa;
1727 struct ieee80211_ht_cap ht_capa_mask;
1728 struct ieee80211_vht_cap vht_capa;
1729 struct ieee80211_vht_cap vht_capa_mask;
1733 * enum wiphy_params_flags - set_wiphy_params bitfield values
1734 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1735 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1736 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1737 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1738 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1740 enum wiphy_params_flags {
1741 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1742 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1743 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1744 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1745 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1749 * cfg80211_bitrate_mask - masks for bitrate control
1751 struct cfg80211_bitrate_mask {
1754 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1755 } control[IEEE80211_NUM_BANDS];
1758 * struct cfg80211_pmksa - PMK Security Association
1760 * This structure is passed to the set/del_pmksa() method for PMKSA
1763 * @bssid: The AP's BSSID.
1764 * @pmkid: The PMK material itself.
1766 struct cfg80211_pmksa {
1772 * struct cfg80211_pkt_pattern - packet pattern
1773 * @mask: bitmask where to match pattern and where to ignore bytes,
1774 * one bit per byte, in same format as nl80211
1775 * @pattern: bytes to match where bitmask is 1
1776 * @pattern_len: length of pattern (in bytes)
1777 * @pkt_offset: packet offset (in bytes)
1779 * Internal note: @mask and @pattern are allocated in one chunk of
1780 * memory, free @mask only!
1782 struct cfg80211_pkt_pattern {
1789 * struct cfg80211_wowlan_tcp - TCP connection parameters
1791 * @sock: (internal) socket for source port allocation
1792 * @src: source IP address
1793 * @dst: destination IP address
1794 * @dst_mac: destination MAC address
1795 * @src_port: source port
1796 * @dst_port: destination port
1797 * @payload_len: data payload length
1798 * @payload: data payload buffer
1799 * @payload_seq: payload sequence stamping configuration
1800 * @data_interval: interval at which to send data packets
1801 * @wake_len: wakeup payload match length
1802 * @wake_data: wakeup payload match data
1803 * @wake_mask: wakeup payload match mask
1804 * @tokens_size: length of the tokens buffer
1805 * @payload_tok: payload token usage configuration
1807 struct cfg80211_wowlan_tcp {
1808 struct socket *sock;
1810 u16 src_port, dst_port;
1811 u8 dst_mac[ETH_ALEN];
1814 struct nl80211_wowlan_tcp_data_seq payload_seq;
1817 const u8 *wake_data, *wake_mask;
1819 /* must be last, variable member */
1820 struct nl80211_wowlan_tcp_data_token payload_tok;
1824 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1826 * This structure defines the enabled WoWLAN triggers for the device.
1827 * @any: wake up on any activity -- special trigger if device continues
1828 * operating as normal during suspend
1829 * @disconnect: wake up if getting disconnected
1830 * @magic_pkt: wake up on receiving magic packet
1831 * @patterns: wake up on receiving packet matching a pattern
1832 * @n_patterns: number of patterns
1833 * @gtk_rekey_failure: wake up on GTK rekey failure
1834 * @eap_identity_req: wake up on EAP identity request packet
1835 * @four_way_handshake: wake up on 4-way handshake
1836 * @rfkill_release: wake up when rfkill is released
1837 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
1838 * NULL if not configured.
1840 struct cfg80211_wowlan {
1841 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1842 eap_identity_req, four_way_handshake,
1844 struct cfg80211_pkt_pattern *patterns;
1845 struct cfg80211_wowlan_tcp *tcp;
1850 * struct cfg80211_coalesce_rules - Coalesce rule parameters
1852 * This structure defines coalesce rule for the device.
1853 * @delay: maximum coalescing delay in msecs.
1854 * @condition: condition for packet coalescence.
1855 * see &enum nl80211_coalesce_condition.
1856 * @patterns: array of packet patterns
1857 * @n_patterns: number of patterns
1859 struct cfg80211_coalesce_rules {
1861 enum nl80211_coalesce_condition condition;
1862 struct cfg80211_pkt_pattern *patterns;
1867 * struct cfg80211_coalesce - Packet coalescing settings
1869 * This structure defines coalescing settings.
1870 * @rules: array of coalesce rules
1871 * @n_rules: number of rules
1873 struct cfg80211_coalesce {
1874 struct cfg80211_coalesce_rules *rules;
1879 * struct cfg80211_wowlan_wakeup - wakeup report
1880 * @disconnect: woke up by getting disconnected
1881 * @magic_pkt: woke up by receiving magic packet
1882 * @gtk_rekey_failure: woke up by GTK rekey failure
1883 * @eap_identity_req: woke up by EAP identity request packet
1884 * @four_way_handshake: woke up by 4-way handshake
1885 * @rfkill_release: woke up by rfkill being released
1886 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
1887 * @packet_present_len: copied wakeup packet data
1888 * @packet_len: original wakeup packet length
1889 * @packet: The packet causing the wakeup, if any.
1890 * @packet_80211: For pattern match, magic packet and other data
1891 * frame triggers an 802.3 frame should be reported, for
1892 * disconnect due to deauth 802.11 frame. This indicates which
1894 * @tcp_match: TCP wakeup packet received
1895 * @tcp_connlost: TCP connection lost or failed to establish
1896 * @tcp_nomoretokens: TCP data ran out of tokens
1898 struct cfg80211_wowlan_wakeup {
1899 bool disconnect, magic_pkt, gtk_rekey_failure,
1900 eap_identity_req, four_way_handshake,
1901 rfkill_release, packet_80211,
1902 tcp_match, tcp_connlost, tcp_nomoretokens;
1904 u32 packet_present_len, packet_len;
1909 * struct cfg80211_gtk_rekey_data - rekey data
1910 * @kek: key encryption key
1911 * @kck: key confirmation key
1912 * @replay_ctr: replay counter
1914 struct cfg80211_gtk_rekey_data {
1915 u8 kek[NL80211_KEK_LEN];
1916 u8 kck[NL80211_KCK_LEN];
1917 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1921 * struct cfg80211_update_ft_ies_params - FT IE Information
1923 * This structure provides information needed to update the fast transition IE
1925 * @md: The Mobility Domain ID, 2 Octet value
1926 * @ie: Fast Transition IEs
1927 * @ie_len: Length of ft_ie in octets
1929 struct cfg80211_update_ft_ies_params {
1936 * struct cfg80211_ops - backend description for wireless configuration
1938 * This struct is registered by fullmac card drivers and/or wireless stacks
1939 * in order to handle configuration requests on their interfaces.
1941 * All callbacks except where otherwise noted should return 0
1942 * on success or a negative error code.
1944 * All operations are currently invoked under rtnl for consistency with the
1945 * wireless extensions but this is subject to reevaluation as soon as this
1946 * code is used more widely and we have a first user without wext.
1948 * @suspend: wiphy device needs to be suspended. The variable @wow will
1949 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1950 * configured for the device.
1951 * @resume: wiphy device needs to be resumed
1952 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1953 * to call device_set_wakeup_enable() to enable/disable wakeup from
1956 * @add_virtual_intf: create a new virtual interface with the given name,
1957 * must set the struct wireless_dev's iftype. Beware: You must create
1958 * the new netdev in the wiphy's network namespace! Returns the struct
1959 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
1960 * also set the address member in the wdev.
1962 * @del_virtual_intf: remove the virtual interface
1964 * @change_virtual_intf: change type/configuration of virtual interface,
1965 * keep the struct wireless_dev's iftype updated.
1967 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1968 * when adding a group key.
1970 * @get_key: get information about the key with the given parameters.
1971 * @mac_addr will be %NULL when requesting information for a group
1972 * key. All pointers given to the @callback function need not be valid
1973 * after it returns. This function should return an error if it is
1974 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1976 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1977 * and @key_index, return -ENOENT if the key doesn't exist.
1979 * @set_default_key: set the default key on an interface
1981 * @set_default_mgmt_key: set the default management frame key on an interface
1983 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1985 * @start_ap: Start acting in AP mode defined by the parameters.
1986 * @change_beacon: Change the beacon parameters for an access point mode
1987 * interface. This should reject the call when AP mode wasn't started.
1988 * @stop_ap: Stop being an AP, including stopping beaconing.
1990 * @add_station: Add a new station.
1991 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1992 * @change_station: Modify a given station. Note that flags changes are not much
1993 * validated in cfg80211, in particular the auth/assoc/authorized flags
1994 * might come to the driver in invalid combinations -- make sure to check
1995 * them, also against the existing state! Drivers must call
1996 * cfg80211_check_station_change() to validate the information.
1997 * @get_station: get station information for the station identified by @mac
1998 * @dump_station: dump station callback -- resume dump at index @idx
2000 * @add_mpath: add a fixed mesh path
2001 * @del_mpath: delete a given mesh path
2002 * @change_mpath: change a given mesh path
2003 * @get_mpath: get a mesh path for the given parameters
2004 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2005 * @join_mesh: join the mesh network with the specified parameters
2006 * (invoked with the wireless_dev mutex held)
2007 * @leave_mesh: leave the current mesh network
2008 * (invoked with the wireless_dev mutex held)
2010 * @get_mesh_config: Get the current mesh configuration
2012 * @update_mesh_config: Update mesh parameters on a running mesh.
2013 * The mask is a bitfield which tells us which parameters to
2014 * set, and which to leave alone.
2016 * @change_bss: Modify parameters for a given BSS.
2018 * @set_txq_params: Set TX queue parameters
2020 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2021 * as it doesn't implement join_mesh and needs to set the channel to
2022 * join the mesh instead.
2024 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2025 * interfaces are active this callback should reject the configuration.
2026 * If no interfaces are active or the device is down, the channel should
2027 * be stored for when a monitor interface becomes active.
2029 * @scan: Request to do a scan. If returning zero, the scan request is given
2030 * the driver, and will be valid until passed to cfg80211_scan_done().
2031 * For scan results, call cfg80211_inform_bss(); you can call this outside
2032 * the scan/scan_done bracket too.
2034 * @auth: Request to authenticate with the specified peer
2035 * (invoked with the wireless_dev mutex held)
2036 * @assoc: Request to (re)associate with the specified peer
2037 * (invoked with the wireless_dev mutex held)
2038 * @deauth: Request to deauthenticate from the specified peer
2039 * (invoked with the wireless_dev mutex held)
2040 * @disassoc: Request to disassociate from the specified peer
2041 * (invoked with the wireless_dev mutex held)
2043 * @connect: Connect to the ESS with the specified parameters. When connected,
2044 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
2045 * If the connection fails for some reason, call cfg80211_connect_result()
2046 * with the status from the AP.
2047 * (invoked with the wireless_dev mutex held)
2048 * @disconnect: Disconnect from the BSS/ESS.
2049 * (invoked with the wireless_dev mutex held)
2051 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2052 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2054 * (invoked with the wireless_dev mutex held)
2055 * @leave_ibss: Leave the IBSS.
2056 * (invoked with the wireless_dev mutex held)
2058 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2061 * @set_wiphy_params: Notify that wiphy parameters have changed;
2062 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2063 * have changed. The actual parameter values are available in
2064 * struct wiphy. If returning an error, no value should be changed.
2066 * @set_tx_power: set the transmit power according to the parameters,
2067 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2068 * wdev may be %NULL if power was set for the wiphy, and will
2069 * always be %NULL unless the driver supports per-vif TX power
2070 * (as advertised by the nl80211 feature flag.)
2071 * @get_tx_power: store the current TX power into the dbm variable;
2072 * return 0 if successful
2074 * @set_wds_peer: set the WDS peer for a WDS interface
2076 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2077 * functions to adjust rfkill hw state
2079 * @dump_survey: get site survey information.
2081 * @remain_on_channel: Request the driver to remain awake on the specified
2082 * channel for the specified duration to complete an off-channel
2083 * operation (e.g., public action frame exchange). When the driver is
2084 * ready on the requested channel, it must indicate this with an event
2085 * notification by calling cfg80211_ready_on_channel().
2086 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2087 * This allows the operation to be terminated prior to timeout based on
2088 * the duration value.
2089 * @mgmt_tx: Transmit a management frame.
2090 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2091 * frame on another channel
2093 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2094 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2095 * used by the function, but 0 and 1 must not be touched. Additionally,
2096 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2097 * dump and return to userspace with an error, so be careful. If any data
2098 * was passed in from userspace then the data/len arguments will be present
2099 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2101 * @set_bitrate_mask: set the bitrate mask configuration
2103 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2104 * devices running firmwares capable of generating the (re) association
2105 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2106 * @del_pmksa: Delete a cached PMKID.
2107 * @flush_pmksa: Flush all cached PMKIDs.
2108 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2109 * allows the driver to adjust the dynamic ps timeout value.
2110 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2111 * @set_cqm_txe_config: Configure connection quality monitor TX error
2113 * @sched_scan_start: Tell the driver to start a scheduled scan.
2114 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan.
2116 * @mgmt_frame_register: Notify driver that a management frame type was
2117 * registered. Note that this callback may not sleep, and cannot run
2118 * concurrently with itself.
2120 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2121 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2122 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2123 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2125 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2127 * @set_ringparam: Set tx and rx ring sizes.
2129 * @get_ringparam: Get tx and rx ring current and maximum sizes.
2131 * @tdls_mgmt: Transmit a TDLS management frame.
2132 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2134 * @probe_client: probe an associated client, must return a cookie that it
2135 * later passes to cfg80211_probe_status().
2137 * @set_noack_map: Set the NoAck Map for the TIDs.
2139 * @get_et_sset_count: Ethtool API to get string-set count.
2140 * See @ethtool_ops.get_sset_count
2142 * @get_et_stats: Ethtool API to get a set of u64 stats.
2143 * See @ethtool_ops.get_ethtool_stats
2145 * @get_et_strings: Ethtool API to get a set of strings to describe stats
2146 * and perhaps other supported types of ethtool data-sets.
2147 * See @ethtool_ops.get_strings
2149 * @get_channel: Get the current operating channel for the virtual interface.
2150 * For monitor interfaces, it should return %NULL unless there's a single
2151 * current monitoring channel.
2153 * @start_p2p_device: Start the given P2P device.
2154 * @stop_p2p_device: Stop the given P2P device.
2156 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2157 * Parameters include ACL policy, an array of MAC address of stations
2158 * and the number of MAC addresses. If there is already a list in driver
2159 * this new list replaces the existing one. Driver has to clear its ACL
2160 * when number of MAC addresses entries is passed as 0. Drivers which
2161 * advertise the support for MAC based ACL have to implement this callback.
2163 * @start_radar_detection: Start radar detection in the driver.
2165 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2166 * driver. If the SME is in the driver/firmware, this information can be
2167 * used in building Authentication and Reassociation Request frames.
2169 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2170 * for a given duration (milliseconds). The protocol is provided so the
2171 * driver can take the most appropriate actions.
2172 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2173 * reliability. This operation can not fail.
2174 * @set_coalesce: Set coalesce parameters.
2176 * @channel_switch: initiate channel-switch procedure (with CSA)
2178 struct cfg80211_ops {
2179 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2180 int (*resume)(struct wiphy *wiphy);
2181 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2183 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2185 enum nl80211_iftype type,
2187 struct vif_params *params);
2188 int (*del_virtual_intf)(struct wiphy *wiphy,
2189 struct wireless_dev *wdev);
2190 int (*change_virtual_intf)(struct wiphy *wiphy,
2191 struct net_device *dev,
2192 enum nl80211_iftype type, u32 *flags,
2193 struct vif_params *params);
2195 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2196 u8 key_index, bool pairwise, const u8 *mac_addr,
2197 struct key_params *params);
2198 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2199 u8 key_index, bool pairwise, const u8 *mac_addr,
2201 void (*callback)(void *cookie, struct key_params*));
2202 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2203 u8 key_index, bool pairwise, const u8 *mac_addr);
2204 int (*set_default_key)(struct wiphy *wiphy,
2205 struct net_device *netdev,
2206 u8 key_index, bool unicast, bool multicast);
2207 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2208 struct net_device *netdev,
2211 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2212 struct cfg80211_ap_settings *settings);
2213 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2214 struct cfg80211_beacon_data *info);
2215 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2218 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2219 u8 *mac, struct station_parameters *params);
2220 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2222 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2223 u8 *mac, struct station_parameters *params);
2224 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2225 u8 *mac, struct station_info *sinfo);
2226 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2227 int idx, u8 *mac, struct station_info *sinfo);
2229 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2230 u8 *dst, u8 *next_hop);
2231 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2233 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2234 u8 *dst, u8 *next_hop);
2235 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2236 u8 *dst, u8 *next_hop,
2237 struct mpath_info *pinfo);
2238 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2239 int idx, u8 *dst, u8 *next_hop,
2240 struct mpath_info *pinfo);
2241 int (*get_mesh_config)(struct wiphy *wiphy,
2242 struct net_device *dev,
2243 struct mesh_config *conf);
2244 int (*update_mesh_config)(struct wiphy *wiphy,
2245 struct net_device *dev, u32 mask,
2246 const struct mesh_config *nconf);
2247 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2248 const struct mesh_config *conf,
2249 const struct mesh_setup *setup);
2250 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2252 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2253 struct bss_parameters *params);
2255 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2256 struct ieee80211_txq_params *params);
2258 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2259 struct net_device *dev,
2260 struct ieee80211_channel *chan);
2262 int (*set_monitor_channel)(struct wiphy *wiphy,
2263 struct cfg80211_chan_def *chandef);
2265 int (*scan)(struct wiphy *wiphy,
2266 struct cfg80211_scan_request *request);
2268 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2269 struct cfg80211_auth_request *req);
2270 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2271 struct cfg80211_assoc_request *req);
2272 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2273 struct cfg80211_deauth_request *req);
2274 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2275 struct cfg80211_disassoc_request *req);
2277 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2278 struct cfg80211_connect_params *sme);
2279 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2282 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2283 struct cfg80211_ibss_params *params);
2284 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2286 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2287 int rate[IEEE80211_NUM_BANDS]);
2289 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2291 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2292 enum nl80211_tx_power_setting type, int mbm);
2293 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2296 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2299 void (*rfkill_poll)(struct wiphy *wiphy);
2301 #ifdef CONFIG_NL80211_TESTMODE
2302 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2303 void *data, int len);
2304 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2305 struct netlink_callback *cb,
2306 void *data, int len);
2309 int (*set_bitrate_mask)(struct wiphy *wiphy,
2310 struct net_device *dev,
2312 const struct cfg80211_bitrate_mask *mask);
2314 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2315 int idx, struct survey_info *info);
2317 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2318 struct cfg80211_pmksa *pmksa);
2319 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2320 struct cfg80211_pmksa *pmksa);
2321 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2323 int (*remain_on_channel)(struct wiphy *wiphy,
2324 struct wireless_dev *wdev,
2325 struct ieee80211_channel *chan,
2326 unsigned int duration,
2328 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2329 struct wireless_dev *wdev,
2332 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2333 struct ieee80211_channel *chan, bool offchan,
2334 unsigned int wait, const u8 *buf, size_t len,
2335 bool no_cck, bool dont_wait_for_ack, u64 *cookie);
2336 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2337 struct wireless_dev *wdev,
2340 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2341 bool enabled, int timeout);
2343 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2344 struct net_device *dev,
2345 s32 rssi_thold, u32 rssi_hyst);
2347 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2348 struct net_device *dev,
2349 u32 rate, u32 pkts, u32 intvl);
2351 void (*mgmt_frame_register)(struct wiphy *wiphy,
2352 struct wireless_dev *wdev,
2353 u16 frame_type, bool reg);
2355 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2356 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2358 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
2359 void (*get_ringparam)(struct wiphy *wiphy,
2360 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2362 int (*sched_scan_start)(struct wiphy *wiphy,
2363 struct net_device *dev,
2364 struct cfg80211_sched_scan_request *request);
2365 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2367 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2368 struct cfg80211_gtk_rekey_data *data);
2370 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2371 u8 *peer, u8 action_code, u8 dialog_token,
2372 u16 status_code, const u8 *buf, size_t len);
2373 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2374 u8 *peer, enum nl80211_tdls_operation oper);
2376 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2377 const u8 *peer, u64 *cookie);
2379 int (*set_noack_map)(struct wiphy *wiphy,
2380 struct net_device *dev,
2383 int (*get_et_sset_count)(struct wiphy *wiphy,
2384 struct net_device *dev, int sset);
2385 void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
2386 struct ethtool_stats *stats, u64 *data);
2387 void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
2388 u32 sset, u8 *data);
2390 int (*get_channel)(struct wiphy *wiphy,
2391 struct wireless_dev *wdev,
2392 struct cfg80211_chan_def *chandef);
2394 int (*start_p2p_device)(struct wiphy *wiphy,
2395 struct wireless_dev *wdev);
2396 void (*stop_p2p_device)(struct wiphy *wiphy,
2397 struct wireless_dev *wdev);
2399 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2400 const struct cfg80211_acl_data *params);
2402 int (*start_radar_detection)(struct wiphy *wiphy,
2403 struct net_device *dev,
2404 struct cfg80211_chan_def *chandef);
2405 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2406 struct cfg80211_update_ft_ies_params *ftie);
2407 int (*crit_proto_start)(struct wiphy *wiphy,
2408 struct wireless_dev *wdev,
2409 enum nl80211_crit_proto_id protocol,
2411 void (*crit_proto_stop)(struct wiphy *wiphy,
2412 struct wireless_dev *wdev);
2413 int (*set_coalesce)(struct wiphy *wiphy,
2414 struct cfg80211_coalesce *coalesce);
2416 int (*channel_switch)(struct wiphy *wiphy,
2417 struct net_device *dev,
2418 struct cfg80211_csa_settings *params);
2422 * wireless hardware and networking interfaces structures
2423 * and registration/helper functions
2427 * enum wiphy_flags - wiphy capability flags
2429 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
2430 * has its own custom regulatory domain and cannot identify the
2431 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
2432 * we will disregard the first regulatory hint (when the
2433 * initiator is %REGDOM_SET_BY_CORE).
2434 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
2435 * ignore regulatory domain settings until it gets its own regulatory
2436 * domain via its regulatory_hint() unless the regulatory hint is
2437 * from a country IE. After its gets its own regulatory domain it will
2438 * only allow further regulatory domain settings to further enhance
2439 * compliance. For example if channel 13 and 14 are disabled by this
2440 * regulatory domain no user regulatory domain can enable these channels
2441 * at a later time. This can be used for devices which do not have
2442 * calibration information guaranteed for frequencies or settings
2443 * outside of its regulatory domain. If used in combination with
2444 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
2446 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
2447 * that passive scan flags and beaconing flags may not be lifted by
2448 * cfg80211 due to regulatory beacon hints. For more information on beacon
2449 * hints read the documenation for regulatory_hint_found_beacon()
2450 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2452 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2453 * by default -- this flag will be set depending on the kernel's default
2454 * on wiphy_new(), but can be changed by the driver if it has a good
2455 * reason to override the default
2456 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2457 * on a VLAN interface)
2458 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2459 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2460 * control port protocol ethertype. The device also honours the
2461 * control_port_no_encrypt flag.
2462 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2463 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2464 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2465 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2466 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2468 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2469 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2470 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2471 * link setup/discovery operations internally. Setup, discovery and
2472 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2473 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2474 * used for asking the driver/firmware to perform a TDLS operation.
2475 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2476 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2477 * when there are virtual interfaces in AP mode by calling
2478 * cfg80211_report_obss_beacon().
2479 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2480 * responds to probe-requests in hardware.
2481 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2482 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2483 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2484 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2485 * beaconing mode (AP, IBSS, Mesh, ...).
2488 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
2489 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
2490 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
2491 WIPHY_FLAG_NETNS_OK = BIT(3),
2492 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2493 WIPHY_FLAG_4ADDR_AP = BIT(5),
2494 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2495 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2496 WIPHY_FLAG_IBSS_RSN = BIT(8),
2497 WIPHY_FLAG_MESH_AUTH = BIT(10),
2498 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2499 /* use hole at 12 */
2500 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2501 WIPHY_FLAG_AP_UAPSD = BIT(14),
2502 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2503 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2504 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2505 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2506 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2507 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2508 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2509 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
2510 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
2514 * struct ieee80211_iface_limit - limit on certain interface types
2515 * @max: maximum number of interfaces of these types
2516 * @types: interface types (bits)
2518 struct ieee80211_iface_limit {
2524 * struct ieee80211_iface_combination - possible interface combination
2525 * @limits: limits for the given interface types
2526 * @n_limits: number of limitations
2527 * @num_different_channels: can use up to this many different channels
2528 * @max_interfaces: maximum number of interfaces in total allowed in this
2530 * @beacon_int_infra_match: In this combination, the beacon intervals
2531 * between infrastructure and AP types must match. This is required
2532 * only in special cases.
2533 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2535 * These examples can be expressed as follows:
2537 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2539 * struct ieee80211_iface_limit limits1[] = {
2540 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2541 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2543 * struct ieee80211_iface_combination combination1 = {
2544 * .limits = limits1,
2545 * .n_limits = ARRAY_SIZE(limits1),
2546 * .max_interfaces = 2,
2547 * .beacon_int_infra_match = true,
2551 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2553 * struct ieee80211_iface_limit limits2[] = {
2554 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2555 * BIT(NL80211_IFTYPE_P2P_GO), },
2557 * struct ieee80211_iface_combination combination2 = {
2558 * .limits = limits2,
2559 * .n_limits = ARRAY_SIZE(limits2),
2560 * .max_interfaces = 8,
2561 * .num_different_channels = 1,
2565 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2566 * This allows for an infrastructure connection and three P2P connections.
2568 * struct ieee80211_iface_limit limits3[] = {
2569 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2570 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2571 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2573 * struct ieee80211_iface_combination combination3 = {
2574 * .limits = limits3,
2575 * .n_limits = ARRAY_SIZE(limits3),
2576 * .max_interfaces = 4,
2577 * .num_different_channels = 2,
2580 struct ieee80211_iface_combination {
2581 const struct ieee80211_iface_limit *limits;
2582 u32 num_different_channels;
2585 bool beacon_int_infra_match;
2586 u8 radar_detect_widths;
2589 struct ieee80211_txrx_stypes {
2594 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2595 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2596 * trigger that keeps the device operating as-is and
2597 * wakes up the host on any activity, for example a
2598 * received packet that passed filtering; note that the
2599 * packet should be preserved in that case
2600 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2602 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2603 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2604 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2605 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2606 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2607 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2609 enum wiphy_wowlan_support_flags {
2610 WIPHY_WOWLAN_ANY = BIT(0),
2611 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2612 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2613 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2614 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2615 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2616 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2617 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2620 struct wiphy_wowlan_tcp_support {
2621 const struct nl80211_wowlan_tcp_data_token_feature *tok;
2622 u32 data_payload_max;
2623 u32 data_interval_max;
2624 u32 wake_payload_max;
2629 * struct wiphy_wowlan_support - WoWLAN support data
2630 * @flags: see &enum wiphy_wowlan_support_flags
2631 * @n_patterns: number of supported wakeup patterns
2632 * (see nl80211.h for the pattern definition)
2633 * @pattern_max_len: maximum length of each pattern
2634 * @pattern_min_len: minimum length of each pattern
2635 * @max_pkt_offset: maximum Rx packet offset
2636 * @tcp: TCP wakeup support information
2638 struct wiphy_wowlan_support {
2641 int pattern_max_len;
2642 int pattern_min_len;
2644 const struct wiphy_wowlan_tcp_support *tcp;
2648 * struct wiphy_coalesce_support - coalesce support data
2649 * @n_rules: maximum number of coalesce rules
2650 * @max_delay: maximum supported coalescing delay in msecs
2651 * @n_patterns: number of supported patterns in a rule
2652 * (see nl80211.h for the pattern definition)
2653 * @pattern_max_len: maximum length of each pattern
2654 * @pattern_min_len: minimum length of each pattern
2655 * @max_pkt_offset: maximum Rx packet offset
2657 struct wiphy_coalesce_support {
2661 int pattern_max_len;
2662 int pattern_min_len;
2667 * struct wiphy - wireless hardware description
2668 * @reg_notifier: the driver's regulatory notification callback,
2669 * note that if your driver uses wiphy_apply_custom_regulatory()
2670 * the reg_notifier's request can be passed as NULL
2671 * @regd: the driver's regulatory domain, if one was requested via
2672 * the regulatory_hint() API. This can be used by the driver
2673 * on the reg_notifier() if it chooses to ignore future
2674 * regulatory domain changes caused by other drivers.
2675 * @signal_type: signal type reported in &struct cfg80211_bss.
2676 * @cipher_suites: supported cipher suites
2677 * @n_cipher_suites: number of supported cipher suites
2678 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2679 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2680 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2681 * -1 = fragmentation disabled, only odd values >= 256 used
2682 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2683 * @_net: the network namespace this wiphy currently lives in
2684 * @perm_addr: permanent MAC address of this device
2685 * @addr_mask: If the device supports multiple MAC addresses by masking,
2686 * set this to a mask with variable bits set to 1, e.g. if the last
2687 * four bits are variable then set it to 00:...:00:0f. The actual
2688 * variable bits shall be determined by the interfaces added, with
2689 * interfaces not matching the mask being rejected to be brought up.
2690 * @n_addresses: number of addresses in @addresses.
2691 * @addresses: If the device has more than one address, set this pointer
2692 * to a list of addresses (6 bytes each). The first one will be used
2693 * by default for perm_addr. In this case, the mask should be set to
2694 * all-zeroes. In this case it is assumed that the device can handle
2695 * the same number of arbitrary MAC addresses.
2696 * @registered: protects ->resume and ->suspend sysfs callbacks against
2697 * unregister hardware
2698 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2699 * automatically on wiphy renames
2700 * @dev: (virtual) struct device for this wiphy
2701 * @registered: helps synchronize suspend/resume with wiphy unregister
2702 * @wext: wireless extension handlers
2703 * @priv: driver private data (sized according to wiphy_new() parameter)
2704 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2705 * must be set by driver
2706 * @iface_combinations: Valid interface combinations array, should not
2707 * list single interface types.
2708 * @n_iface_combinations: number of entries in @iface_combinations array.
2709 * @software_iftypes: bitmask of software interface types, these are not
2710 * subject to any restrictions since they are purely managed in SW.
2711 * @flags: wiphy flags, see &enum wiphy_flags
2712 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2713 * @bss_priv_size: each BSS struct has private data allocated with it,
2714 * this variable determines its size
2715 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2717 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2718 * for in any given scheduled scan
2719 * @max_match_sets: maximum number of match sets the device can handle
2720 * when performing a scheduled scan, 0 if filtering is not
2722 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2723 * add to probe request frames transmitted during a scan, must not
2724 * include fixed IEs like supported rates
2725 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2727 * @coverage_class: current coverage class
2728 * @fw_version: firmware version for ethtool reporting
2729 * @hw_version: hardware version for ethtool reporting
2730 * @max_num_pmkids: maximum number of PMKIDs supported by device
2731 * @privid: a pointer that drivers can use to identify if an arbitrary
2732 * wiphy is theirs, e.g. in global notifiers
2733 * @bands: information about bands/channels supported by this device
2735 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2736 * transmitted through nl80211, points to an array indexed by interface
2739 * @available_antennas_tx: bitmap of antennas which are available to be
2740 * configured as TX antennas. Antenna configuration commands will be
2741 * rejected unless this or @available_antennas_rx is set.
2743 * @available_antennas_rx: bitmap of antennas which are available to be
2744 * configured as RX antennas. Antenna configuration commands will be
2745 * rejected unless this or @available_antennas_tx is set.
2747 * @probe_resp_offload:
2748 * Bitmap of supported protocols for probe response offloading.
2749 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2750 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2752 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2753 * may request, if implemented.
2755 * @wowlan: WoWLAN support information
2756 * @wowlan_config: current WoWLAN configuration; this should usually not be
2757 * used since access to it is necessarily racy, use the parameter passed
2758 * to the suspend() operation instead.
2760 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2761 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2762 * If null, then none can be over-ridden.
2763 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
2764 * If null, then none can be over-ridden.
2766 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
2769 * @extended_capabilities: extended capabilities supported by the driver,
2770 * additional capabilities might be supported by userspace; these are
2771 * the 802.11 extended capabilities ("Extended Capabilities element")
2772 * and are in the same format as in the information element. See
2773 * 802.11-2012 8.4.2.29 for the defined fields.
2774 * @extended_capabilities_mask: mask of the valid values
2775 * @extended_capabilities_len: length of the extended capabilities
2776 * @coalesce: packet coalescing support information
2779 /* assign these fields before you register the wiphy */
2781 /* permanent MAC address(es) */
2782 u8 perm_addr[ETH_ALEN];
2783 u8 addr_mask[ETH_ALEN];
2785 struct mac_address *addresses;
2787 const struct ieee80211_txrx_stypes *mgmt_stypes;
2789 const struct ieee80211_iface_combination *iface_combinations;
2790 int n_iface_combinations;
2791 u16 software_iftypes;
2795 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2796 u16 interface_modes;
2798 u16 max_acl_mac_addrs;
2800 u32 flags, features;
2804 enum cfg80211_signal_type signal_type;
2808 u8 max_sched_scan_ssids;
2810 u16 max_scan_ie_len;
2811 u16 max_sched_scan_ie_len;
2813 int n_cipher_suites;
2814 const u32 *cipher_suites;
2822 char fw_version[ETHTOOL_FWVERS_LEN];
2826 const struct wiphy_wowlan_support *wowlan;
2827 struct cfg80211_wowlan *wowlan_config;
2830 u16 max_remain_on_channel_duration;
2834 u32 available_antennas_tx;
2835 u32 available_antennas_rx;
2838 * Bitmap of supported protocols for probe response offloading
2839 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2840 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2842 u32 probe_resp_offload;
2844 const u8 *extended_capabilities, *extended_capabilities_mask;
2845 u8 extended_capabilities_len;
2847 /* If multiple wiphys are registered and you're handed e.g.
2848 * a regular netdev with assigned ieee80211_ptr, you won't
2849 * know whether it points to a wiphy your driver has registered
2850 * or not. Assign this to something global to your driver to
2851 * help determine whether you own this wiphy or not. */
2854 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2856 /* Lets us get back the wiphy on the callback */
2857 void (*reg_notifier)(struct wiphy *wiphy,
2858 struct regulatory_request *request);
2860 /* fields below are read-only, assigned by cfg80211 */
2862 const struct ieee80211_regdomain __rcu *regd;
2864 /* the item in /sys/class/ieee80211/ points to this,
2865 * you need use set_wiphy_dev() (see below) */
2868 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2871 /* dir in debugfs: ieee80211/<wiphyname> */
2872 struct dentry *debugfsdir;
2874 const struct ieee80211_ht_cap *ht_capa_mod_mask;
2875 const struct ieee80211_vht_cap *vht_capa_mod_mask;
2877 #ifdef CONFIG_NET_NS
2878 /* the network namespace this phy lives in currently */
2882 #ifdef CONFIG_CFG80211_WEXT
2883 const struct iw_handler_def *wext;
2886 const struct wiphy_coalesce_support *coalesce;
2888 char priv[0] __aligned(NETDEV_ALIGN);
2891 static inline struct net *wiphy_net(struct wiphy *wiphy)
2893 return read_pnet(&wiphy->_net);
2896 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2898 write_pnet(&wiphy->_net, net);
2902 * wiphy_priv - return priv from wiphy
2904 * @wiphy: the wiphy whose priv pointer to return
2905 * Return: The priv of @wiphy.
2907 static inline void *wiphy_priv(struct wiphy *wiphy)
2910 return &wiphy->priv;
2914 * priv_to_wiphy - return the wiphy containing the priv
2916 * @priv: a pointer previously returned by wiphy_priv
2917 * Return: The wiphy of @priv.
2919 static inline struct wiphy *priv_to_wiphy(void *priv)
2922 return container_of(priv, struct wiphy, priv);
2926 * set_wiphy_dev - set device pointer for wiphy
2928 * @wiphy: The wiphy whose device to bind
2929 * @dev: The device to parent it to
2931 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2933 wiphy->dev.parent = dev;
2937 * wiphy_dev - get wiphy dev pointer
2939 * @wiphy: The wiphy whose device struct to look up
2940 * Return: The dev of @wiphy.
2942 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2944 return wiphy->dev.parent;
2948 * wiphy_name - get wiphy name
2950 * @wiphy: The wiphy whose name to return
2951 * Return: The name of @wiphy.
2953 static inline const char *wiphy_name(const struct wiphy *wiphy)
2955 return dev_name(&wiphy->dev);
2959 * wiphy_new - create a new wiphy for use with cfg80211
2961 * @ops: The configuration operations for this device
2962 * @sizeof_priv: The size of the private area to allocate
2964 * Create a new wiphy and associate the given operations with it.
2965 * @sizeof_priv bytes are allocated for private use.
2967 * Return: A pointer to the new wiphy. This pointer must be
2968 * assigned to each netdev's ieee80211_ptr for proper operation.
2970 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2973 * wiphy_register - register a wiphy with cfg80211
2975 * @wiphy: The wiphy to register.
2977 * Return: A non-negative wiphy index or a negative error code.
2979 int wiphy_register(struct wiphy *wiphy);
2982 * wiphy_unregister - deregister a wiphy from cfg80211
2984 * @wiphy: The wiphy to unregister.
2986 * After this call, no more requests can be made with this priv
2987 * pointer, but the call may sleep to wait for an outstanding
2988 * request that is being handled.
2990 void wiphy_unregister(struct wiphy *wiphy);
2993 * wiphy_free - free wiphy
2995 * @wiphy: The wiphy to free
2997 void wiphy_free(struct wiphy *wiphy);
2999 /* internal structs */
3000 struct cfg80211_conn;
3001 struct cfg80211_internal_bss;
3002 struct cfg80211_cached_keys;
3005 * struct wireless_dev - wireless device state
3007 * For netdevs, this structure must be allocated by the driver
3008 * that uses the ieee80211_ptr field in struct net_device (this
3009 * is intentional so it can be allocated along with the netdev.)
3010 * It need not be registered then as netdev registration will
3011 * be intercepted by cfg80211 to see the new wireless device.
3013 * For non-netdev uses, it must also be allocated by the driver
3014 * in response to the cfg80211 callbacks that require it, as
3015 * there's no netdev registration in that case it may not be
3016 * allocated outside of callback operations that return it.
3018 * @wiphy: pointer to hardware description
3019 * @iftype: interface type
3020 * @list: (private) Used to collect the interfaces
3021 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3022 * @identifier: (private) Identifier used in nl80211 to identify this
3023 * wireless device if it has no netdev
3024 * @current_bss: (private) Used by the internal configuration code
3025 * @channel: (private) Used by the internal configuration code to track
3026 * the user-set AP, monitor and WDS channel
3027 * @preset_chandef: (private) Used by the internal configuration code to
3028 * track the channel to be used for AP later
3029 * @bssid: (private) Used by the internal configuration code
3030 * @ssid: (private) Used by the internal configuration code
3031 * @ssid_len: (private) Used by the internal configuration code
3032 * @mesh_id_len: (private) Used by the internal configuration code
3033 * @mesh_id_up_len: (private) Used by the internal configuration code
3034 * @wext: (private) Used by the internal wireless extensions compat code
3035 * @use_4addr: indicates 4addr mode is used on this interface, must be
3036 * set by driver (if supported) on add_interface BEFORE registering the
3037 * netdev and may otherwise be used by driver read-only, will be update
3038 * by cfg80211 on change_interface
3039 * @mgmt_registrations: list of registrations for management frames
3040 * @mgmt_registrations_lock: lock for the list
3041 * @mtx: mutex used to lock data in this struct, may be used by drivers
3042 * and some API functions require it held
3043 * @beacon_interval: beacon interval used on this device for transmitting
3044 * beacons, 0 when not valid
3045 * @address: The address for this device, valid only if @netdev is %NULL
3046 * @p2p_started: true if this is a P2P Device that has been started
3047 * @cac_started: true if DFS channel availability check has been started
3048 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3049 * @ps: powersave mode is enabled
3050 * @ps_timeout: dynamic powersave timeout
3051 * @ap_unexpected_nlportid: (private) netlink port ID of application
3052 * registered for unexpected class 3 frames (AP mode)
3053 * @conn: (private) cfg80211 software SME connection state machine data
3054 * @connect_keys: (private) keys to set after connection is established
3055 * @ibss_fixed: (private) IBSS is using fixed BSSID
3056 * @event_list: (private) list for internal event processing
3057 * @event_lock: (private) lock for event list
3059 struct wireless_dev {
3060 struct wiphy *wiphy;
3061 enum nl80211_iftype iftype;
3063 /* the remainder of this struct should be private to cfg80211 */
3064 struct list_head list;
3065 struct net_device *netdev;
3069 struct list_head mgmt_registrations;
3070 spinlock_t mgmt_registrations_lock;
3074 bool use_4addr, p2p_started;
3076 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3078 /* currently used for IBSS and SME - might be rearranged later */
3079 u8 ssid[IEEE80211_MAX_SSID_LEN];
3080 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3081 struct cfg80211_conn *conn;
3082 struct cfg80211_cached_keys *connect_keys;
3084 struct list_head event_list;
3085 spinlock_t event_lock;
3087 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3088 struct cfg80211_chan_def preset_chandef;
3090 /* for AP and mesh channel tracking */
3091 struct ieee80211_channel *channel;
3098 int beacon_interval;
3100 u32 ap_unexpected_nlportid;
3103 unsigned long cac_start_time;
3105 #ifdef CONFIG_CFG80211_WEXT
3108 struct cfg80211_ibss_params ibss;
3109 struct cfg80211_connect_params connect;
3110 struct cfg80211_cached_keys *keys;
3113 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3114 u8 ssid[IEEE80211_MAX_SSID_LEN];
3115 s8 default_key, default_mgmt_key;
3116 bool prev_bssid_valid;
3121 static inline u8 *wdev_address(struct wireless_dev *wdev)
3124 return wdev->netdev->dev_addr;
3125 return wdev->address;
3129 * wdev_priv - return wiphy priv from wireless_dev
3131 * @wdev: The wireless device whose wiphy's priv pointer to return
3132 * Return: The wiphy priv of @wdev.
3134 static inline void *wdev_priv(struct wireless_dev *wdev)
3137 return wiphy_priv(wdev->wiphy);
3141 * DOC: Utility functions
3143 * cfg80211 offers a number of utility functions that can be useful.
3147 * ieee80211_channel_to_frequency - convert channel number to frequency
3148 * @chan: channel number
3149 * @band: band, necessary due to channel number overlap
3150 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3152 int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
3155 * ieee80211_frequency_to_channel - convert frequency to channel number
3156 * @freq: center frequency
3157 * Return: The corresponding channel, or 0 if the conversion failed.
3159 int ieee80211_frequency_to_channel(int freq);
3162 * Name indirection necessary because the ieee80211 code also has
3163 * a function named "ieee80211_get_channel", so if you include
3164 * cfg80211's header file you get cfg80211's version, if you try
3165 * to include both header files you'll (rightfully!) get a symbol
3168 struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3171 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3172 * @wiphy: the struct wiphy to get the channel for
3173 * @freq: the center frequency of the channel
3174 * Return: The channel struct from @wiphy at @freq.
3176 static inline struct ieee80211_channel *
3177 ieee80211_get_channel(struct wiphy *wiphy, int freq)
3179 return __ieee80211_get_channel(wiphy, freq);
3183 * ieee80211_get_response_rate - get basic rate for a given rate
3185 * @sband: the band to look for rates in
3186 * @basic_rates: bitmap of basic rates
3187 * @bitrate: the bitrate for which to find the basic rate
3189 * Return: The basic rate corresponding to a given bitrate, that
3190 * is the next lower bitrate contained in the basic rate map,
3191 * which is, for this function, given as a bitmap of indices of
3192 * rates in the band's bitrate table.
3194 struct ieee80211_rate *
3195 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3196 u32 basic_rates, int bitrate);
3199 * ieee80211_mandatory_rates - get mandatory rates for a given band
3200 * @sband: the band to look for rates in
3201 * @scan_width: width of the control channel
3203 * This function returns a bitmap of the mandatory rates for the given
3204 * band, bits are set according to the rate position in the bitrates array.
3206 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3207 enum nl80211_bss_scan_width scan_width);
3210 * Radiotap parsing functions -- for controlled injection support
3212 * Implemented in net/wireless/radiotap.c
3213 * Documentation in Documentation/networking/radiotap-headers.txt
3216 struct radiotap_align_size {
3217 uint8_t align:4, size:4;
3220 struct ieee80211_radiotap_namespace {
3221 const struct radiotap_align_size *align_size;
3227 struct ieee80211_radiotap_vendor_namespaces {
3228 const struct ieee80211_radiotap_namespace *ns;
3233 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3234 * @this_arg_index: index of current arg, valid after each successful call
3235 * to ieee80211_radiotap_iterator_next()
3236 * @this_arg: pointer to current radiotap arg; it is valid after each
3237 * call to ieee80211_radiotap_iterator_next() but also after
3238 * ieee80211_radiotap_iterator_init() where it will point to
3239 * the beginning of the actual data portion
3240 * @this_arg_size: length of the current arg, for convenience
3241 * @current_namespace: pointer to the current namespace definition
3242 * (or internally %NULL if the current namespace is unknown)
3243 * @is_radiotap_ns: indicates whether the current namespace is the default
3244 * radiotap namespace or not
3246 * @_rtheader: pointer to the radiotap header we are walking through
3247 * @_max_length: length of radiotap header in cpu byte ordering
3248 * @_arg_index: next argument index
3249 * @_arg: next argument pointer
3250 * @_next_bitmap: internal pointer to next present u32
3251 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3252 * @_vns: vendor namespace definitions
3253 * @_next_ns_data: beginning of the next namespace's data
3254 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3257 * Describes the radiotap parser state. Fields prefixed with an underscore
3258 * must not be used by users of the parser, only by the parser internally.
3261 struct ieee80211_radiotap_iterator {
3262 struct ieee80211_radiotap_header *_rtheader;
3263 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3264 const struct ieee80211_radiotap_namespace *current_namespace;
3266 unsigned char *_arg, *_next_ns_data;
3267 __le32 *_next_bitmap;
3269 unsigned char *this_arg;
3277 uint32_t _bitmap_shifter;
3282 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3283 struct ieee80211_radiotap_header *radiotap_header,
3285 const struct ieee80211_radiotap_vendor_namespaces *vns);
3288 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3291 extern const unsigned char rfc1042_header[6];
3292 extern const unsigned char bridge_tunnel_header[6];
3295 * ieee80211_get_hdrlen_from_skb - get header length from data
3299 * Given an skb with a raw 802.11 header at the data pointer this function
3300 * returns the 802.11 header length.
3302 * Return: The 802.11 header length in bytes (not including encryption
3303 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3306 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3309 * ieee80211_hdrlen - get header length in bytes from frame control
3310 * @fc: frame control field in little-endian format
3311 * Return: The header length in bytes.
3313 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3316 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3317 * @meshhdr: the mesh extension header, only the flags field
3318 * (first byte) will be accessed
3319 * Return: The length of the extension header, which is always at
3320 * least 6 bytes and at most 18 if address 5 and 6 are present.
3322 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3325 * DOC: Data path helpers
3327 * In addition to generic utilities, cfg80211 also offers
3328 * functions that help implement the data path for devices
3329 * that do not do the 802.11/802.3 conversion on the device.
3333 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3334 * @skb: the 802.11 data frame
3335 * @addr: the device MAC address
3336 * @iftype: the virtual interface type
3337 * Return: 0 on success. Non-zero on error.
3339 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3340 enum nl80211_iftype iftype);
3343 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3344 * @skb: the 802.3 frame
3345 * @addr: the device MAC address
3346 * @iftype: the virtual interface type
3347 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3348 * @qos: build 802.11 QoS data frame
3349 * Return: 0 on success, or a negative error code.
3351 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3352 enum nl80211_iftype iftype, u8 *bssid, bool qos);
3355 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3357 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3358 * 802.3 frames. The @list will be empty if the decode fails. The
3359 * @skb is consumed after the function returns.
3361 * @skb: The input IEEE 802.11n A-MSDU frame.
3362 * @list: The output list of 802.3 frames. It must be allocated and
3363 * initialized by by the caller.
3364 * @addr: The device MAC address.
3365 * @iftype: The device interface type.
3366 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3367 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3369 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3370 const u8 *addr, enum nl80211_iftype iftype,
3371 const unsigned int extra_headroom,
3372 bool has_80211_header);
3375 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3376 * @skb: the data frame
3377 * Return: The 802.1p/1d tag.
3379 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
3382 * cfg80211_find_ie - find information element in data
3385 * @ies: data consisting of IEs
3386 * @len: length of data
3388 * Return: %NULL if the element ID could not be found or if
3389 * the element is invalid (claims to be longer than the given
3390 * data), or a pointer to the first byte of the requested
3391 * element, that is the byte containing the element ID.
3393 * Note: There are no checks on the element length other than
3394 * having to fit into the given data.
3396 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3399 * cfg80211_find_vendor_ie - find vendor specific information element in data
3402 * @oui_type: vendor-specific OUI type
3403 * @ies: data consisting of IEs
3404 * @len: length of data
3406 * Return: %NULL if the vendor specific element ID could not be found or if the
3407 * element is invalid (claims to be longer than the given data), or a pointer to
3408 * the first byte of the requested element, that is the byte containing the
3411 * Note: There are no checks on the element length other than having to fit into
3414 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3415 const u8 *ies, int len);
3418 * DOC: Regulatory enforcement infrastructure
3424 * regulatory_hint - driver hint to the wireless core a regulatory domain
3425 * @wiphy: the wireless device giving the hint (used only for reporting
3427 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3428 * should be in. If @rd is set this should be NULL. Note that if you
3429 * set this to NULL you should still set rd->alpha2 to some accepted
3432 * Wireless drivers can use this function to hint to the wireless core
3433 * what it believes should be the current regulatory domain by
3434 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3435 * domain should be in or by providing a completely build regulatory domain.
3436 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3437 * for a regulatory domain structure for the respective country.
3439 * The wiphy must have been registered to cfg80211 prior to this call.
3440 * For cfg80211 drivers this means you must first use wiphy_register(),
3441 * for mac80211 drivers you must first use ieee80211_register_hw().
3443 * Drivers should check the return value, its possible you can get
3446 * Return: 0 on success. -ENOMEM.
3448 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3451 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3452 * @wiphy: the wireless device we want to process the regulatory domain on
3453 * @regd: the custom regulatory domain to use for this wiphy
3455 * Drivers can sometimes have custom regulatory domains which do not apply
3456 * to a specific country. Drivers can use this to apply such custom regulatory
3457 * domains. This routine must be called prior to wiphy registration. The
3458 * custom regulatory domain will be trusted completely and as such previous
3459 * default channel settings will be disregarded. If no rule is found for a
3460 * channel on the regulatory domain the channel will be disabled.
3462 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
3463 const struct ieee80211_regdomain *regd);
3466 * freq_reg_info - get regulatory information for the given frequency
3467 * @wiphy: the wiphy for which we want to process this rule for
3468 * @center_freq: Frequency in KHz for which we want regulatory information for
3470 * Use this function to get the regulatory rule for a specific frequency on
3471 * a given wireless device. If the device has a specific regulatory domain
3472 * it wants to follow we respect that unless a country IE has been received
3473 * and processed already.
3475 * Return: A valid pointer, or, when an error occurs, for example if no rule
3476 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3477 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3478 * value will be -ERANGE if we determine the given center_freq does not even
3479 * have a regulatory rule for a frequency range in the center_freq's band.
3480 * See freq_in_rule_band() for our current definition of a band -- this is
3481 * purely subjective and right now it's 802.11 specific.
3483 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3487 * callbacks for asynchronous cfg80211 methods, notification
3488 * functions and BSS handling helpers
3492 * cfg80211_scan_done - notify that scan finished
3494 * @request: the corresponding scan request
3495 * @aborted: set to true if the scan was aborted for any reason,
3496 * userspace will be notified of that
3498 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3501 * cfg80211_sched_scan_results - notify that new scan results are available
3503 * @wiphy: the wiphy which got scheduled scan results
3505 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3508 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3510 * @wiphy: the wiphy on which the scheduled scan stopped
3512 * The driver can call this function to inform cfg80211 that the
3513 * scheduled scan had to be stopped, for whatever reason. The driver
3514 * is then called back via the sched_scan_stop operation when done.
3516 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3519 * cfg80211_inform_bss_width_frame - inform cfg80211 of a received BSS frame
3521 * @wiphy: the wiphy reporting the BSS
3522 * @channel: The channel the frame was received on
3523 * @scan_width: width of the control channel
3524 * @mgmt: the management frame (probe response or beacon)
3525 * @len: length of the management frame
3526 * @signal: the signal strength, type depends on the wiphy's signal_type
3527 * @gfp: context flags
3529 * This informs cfg80211 that BSS information was found and
3530 * the BSS should be updated/added.
3532 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3533 * Or %NULL on error.
3535 struct cfg80211_bss * __must_check
3536 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
3537 struct ieee80211_channel *channel,
3538 enum nl80211_bss_scan_width scan_width,
3539 struct ieee80211_mgmt *mgmt, size_t len,
3540 s32 signal, gfp_t gfp);
3542 static inline struct cfg80211_bss * __must_check
3543 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3544 struct ieee80211_channel *channel,
3545 struct ieee80211_mgmt *mgmt, size_t len,
3546 s32 signal, gfp_t gfp)
3548 return cfg80211_inform_bss_width_frame(wiphy, channel,
3549 NL80211_BSS_CHAN_WIDTH_20,
3550 mgmt, len, signal, gfp);
3554 * cfg80211_inform_bss - inform cfg80211 of a new BSS
3556 * @wiphy: the wiphy reporting the BSS
3557 * @channel: The channel the frame was received on
3558 * @scan_width: width of the control channel
3559 * @bssid: the BSSID of the BSS
3560 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3561 * @capability: the capability field sent by the peer
3562 * @beacon_interval: the beacon interval announced by the peer
3563 * @ie: additional IEs sent by the peer
3564 * @ielen: length of the additional IEs
3565 * @signal: the signal strength, type depends on the wiphy's signal_type
3566 * @gfp: context flags
3568 * This informs cfg80211 that BSS information was found and
3569 * the BSS should be updated/added.
3571 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3572 * Or %NULL on error.
3574 struct cfg80211_bss * __must_check
3575 cfg80211_inform_bss_width(struct wiphy *wiphy,
3576 struct ieee80211_channel *channel,
3577 enum nl80211_bss_scan_width scan_width,
3578 const u8 *bssid, u64 tsf, u16 capability,
3579 u16 beacon_interval, const u8 *ie, size_t ielen,
3580 s32 signal, gfp_t gfp);
3582 static inline struct cfg80211_bss * __must_check
3583 cfg80211_inform_bss(struct wiphy *wiphy,
3584 struct ieee80211_channel *channel,
3585 const u8 *bssid, u64 tsf, u16 capability,
3586 u16 beacon_interval, const u8 *ie, size_t ielen,
3587 s32 signal, gfp_t gfp)
3589 return cfg80211_inform_bss_width(wiphy, channel,
3590 NL80211_BSS_CHAN_WIDTH_20,
3591 bssid, tsf, capability,
3592 beacon_interval, ie, ielen, signal,
3596 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3597 struct ieee80211_channel *channel,
3599 const u8 *ssid, size_t ssid_len,
3600 u16 capa_mask, u16 capa_val);
3601 static inline struct cfg80211_bss *
3602 cfg80211_get_ibss(struct wiphy *wiphy,
3603 struct ieee80211_channel *channel,
3604 const u8 *ssid, size_t ssid_len)
3606 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3607 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3611 * cfg80211_ref_bss - reference BSS struct
3612 * @wiphy: the wiphy this BSS struct belongs to
3613 * @bss: the BSS struct to reference
3615 * Increments the refcount of the given BSS struct.
3617 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3620 * cfg80211_put_bss - unref BSS struct
3621 * @wiphy: the wiphy this BSS struct belongs to
3622 * @bss: the BSS struct
3624 * Decrements the refcount of the given BSS struct.
3626 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3629 * cfg80211_unlink_bss - unlink BSS from internal data structures
3631 * @bss: the bss to remove
3633 * This function removes the given BSS from the internal data structures
3634 * thereby making it no longer show up in scan results etc. Use this
3635 * function when you detect a BSS is gone. Normally BSSes will also time
3636 * out, so it is not necessary to use this function at all.
3638 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3640 static inline enum nl80211_bss_scan_width
3641 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
3643 switch (chandef->width) {
3644 case NL80211_CHAN_WIDTH_5:
3645 return NL80211_BSS_CHAN_WIDTH_5;
3646 case NL80211_CHAN_WIDTH_10:
3647 return NL80211_BSS_CHAN_WIDTH_10;
3649 return NL80211_BSS_CHAN_WIDTH_20;
3654 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
3655 * @dev: network device
3656 * @buf: authentication frame (header + body)
3657 * @len: length of the frame data
3659 * This function is called whenever an authentication, disassociation or
3660 * deauthentication frame has been received and processed in station mode.
3661 * After being asked to authenticate via cfg80211_ops::auth() the driver must
3662 * call either this function or cfg80211_auth_timeout().
3663 * After being asked to associate via cfg80211_ops::assoc() the driver must
3664 * call either this function or cfg80211_auth_timeout().
3665 * While connected, the driver must calls this for received and processed
3666 * disassociation and deauthentication frames. If the frame couldn't be used
3667 * because it was unprotected, the driver must call the function
3668 * cfg80211_rx_unprot_mlme_mgmt() instead.
3670 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3672 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
3675 * cfg80211_auth_timeout - notification of timed out authentication
3676 * @dev: network device
3677 * @addr: The MAC address of the device with which the authentication timed out
3679 * This function may sleep. The caller must hold the corresponding wdev's
3682 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
3685 * cfg80211_rx_assoc_resp - notification of processed association response
3686 * @dev: network device
3687 * @bss: the BSS that association was requested with, ownership of the pointer
3688 * moves to cfg80211 in this call
3689 * @buf: authentication frame (header + body)
3690 * @len: length of the frame data
3692 * After being asked to associate via cfg80211_ops::assoc() the driver must
3693 * call either this function or cfg80211_auth_timeout().
3695 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3697 void cfg80211_rx_assoc_resp(struct net_device *dev,
3698 struct cfg80211_bss *bss,
3699 const u8 *buf, size_t len);
3702 * cfg80211_assoc_timeout - notification of timed out association
3703 * @dev: network device
3704 * @bss: The BSS entry with which association timed out.
3706 * This function may sleep. The caller must hold the corresponding wdev's mutex.
3708 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
3711 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
3712 * @dev: network device
3713 * @buf: 802.11 frame (header + body)
3714 * @len: length of the frame data
3716 * This function is called whenever deauthentication has been processed in
3717 * station mode. This includes both received deauthentication frames and
3718 * locally generated ones. This function may sleep. The caller must hold the
3719 * corresponding wdev's mutex.
3721 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
3724 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
3725 * @dev: network device
3726 * @buf: deauthentication frame (header + body)
3727 * @len: length of the frame data
3729 * This function is called whenever a received deauthentication or dissassoc
3730 * frame has been dropped in station mode because of MFP being used but the
3731 * frame was not protected. This function may sleep.
3733 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
3734 const u8 *buf, size_t len);
3737 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3738 * @dev: network device
3739 * @addr: The source MAC address of the frame
3740 * @key_type: The key type that the received frame used
3741 * @key_id: Key identifier (0..3). Can be -1 if missing.
3742 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3743 * @gfp: allocation flags
3745 * This function is called whenever the local MAC detects a MIC failure in a
3746 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3749 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3750 enum nl80211_key_type key_type, int key_id,
3751 const u8 *tsc, gfp_t gfp);
3754 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3756 * @dev: network device
3757 * @bssid: the BSSID of the IBSS joined
3758 * @gfp: allocation flags
3760 * This function notifies cfg80211 that the device joined an IBSS or
3761 * switched to a different BSSID. Before this function can be called,
3762 * either a beacon has to have been received from the IBSS, or one of
3763 * the cfg80211_inform_bss{,_frame} functions must have been called
3764 * with the locally generated beacon -- this guarantees that there is
3765 * always a scan result for this IBSS. cfg80211 will handle the rest.
3767 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
3770 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3772 * @dev: network device
3773 * @macaddr: the MAC address of the new candidate
3774 * @ie: information elements advertised by the peer candidate
3775 * @ie_len: lenght of the information elements buffer
3776 * @gfp: allocation flags
3778 * This function notifies cfg80211 that the mesh peer candidate has been
3779 * detected, most likely via a beacon or, less likely, via a probe response.
3780 * cfg80211 then sends a notification to userspace.
3782 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3783 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3786 * DOC: RFkill integration
3788 * RFkill integration in cfg80211 is almost invisible to drivers,
3789 * as cfg80211 automatically registers an rfkill instance for each
3790 * wireless device it knows about. Soft kill is also translated
3791 * into disconnecting and turning all interfaces off, drivers are
3792 * expected to turn off the device when all interfaces are down.
3794 * However, devices may have a hard RFkill line, in which case they
3795 * also need to interact with the rfkill subsystem, via cfg80211.
3796 * They can do this with a few helper functions documented here.
3800 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3802 * @blocked: block status
3804 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3807 * wiphy_rfkill_start_polling - start polling rfkill
3810 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3813 * wiphy_rfkill_stop_polling - stop polling rfkill
3816 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3818 #ifdef CONFIG_NL80211_TESTMODE
3822 * Test mode is a set of utility functions to allow drivers to
3823 * interact with driver-specific tools to aid, for instance,
3824 * factory programming.
3826 * This chapter describes how drivers interact with it, for more
3827 * information see the nl80211 book's chapter on it.
3831 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3833 * @approxlen: an upper bound of the length of the data that will
3834 * be put into the skb
3836 * This function allocates and pre-fills an skb for a reply to
3837 * the testmode command. Since it is intended for a reply, calling
3838 * it outside of the @testmode_cmd operation is invalid.
3840 * The returned skb is pre-filled with the wiphy index and set up in
3841 * a way that any data that is put into the skb (with skb_put(),
3842 * nla_put() or similar) will end up being within the
3843 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
3844 * with the skb is adding data for the corresponding userspace tool
3845 * which can then read that data out of the testdata attribute. You
3846 * must not modify the skb in any other way.
3848 * When done, call cfg80211_testmode_reply() with the skb and return
3849 * its error code as the result of the @testmode_cmd operation.
3851 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3853 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
3857 * cfg80211_testmode_reply - send the reply skb
3858 * @skb: The skb, must have been allocated with
3859 * cfg80211_testmode_alloc_reply_skb()
3861 * Since calling this function will usually be the last thing
3862 * before returning from the @testmode_cmd you should return
3863 * the error code. Note that this function consumes the skb
3864 * regardless of the return value.
3866 * Return: An error code or 0 on success.
3868 int cfg80211_testmode_reply(struct sk_buff *skb);
3871 * cfg80211_testmode_alloc_event_skb - allocate testmode event
3873 * @approxlen: an upper bound of the length of the data that will
3874 * be put into the skb
3875 * @gfp: allocation flags
3877 * This function allocates and pre-fills an skb for an event on the
3878 * testmode multicast group.
3880 * The returned skb is set up in the same way as with
3881 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
3882 * there, you should simply add data to it that will then end up in the
3883 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
3886 * When done filling the skb, call cfg80211_testmode_event() with the
3887 * skb to send the event.
3889 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3891 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
3892 int approxlen, gfp_t gfp);
3895 * cfg80211_testmode_event - send the event
3896 * @skb: The skb, must have been allocated with
3897 * cfg80211_testmode_alloc_event_skb()
3898 * @gfp: allocation flags
3900 * This function sends the given @skb, which must have been allocated
3901 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3904 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3906 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3907 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3909 #define CFG80211_TESTMODE_CMD(cmd)
3910 #define CFG80211_TESTMODE_DUMP(cmd)
3914 * cfg80211_connect_result - notify cfg80211 of connection result
3916 * @dev: network device
3917 * @bssid: the BSSID of the AP
3918 * @req_ie: association request IEs (maybe be %NULL)
3919 * @req_ie_len: association request IEs length
3920 * @resp_ie: association response IEs (may be %NULL)
3921 * @resp_ie_len: assoc response IEs length
3922 * @status: status code, 0 for successful connection, use
3923 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3924 * the real status code for failures.
3925 * @gfp: allocation flags
3927 * It should be called by the underlying driver whenever connect() has
3930 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3931 const u8 *req_ie, size_t req_ie_len,
3932 const u8 *resp_ie, size_t resp_ie_len,
3933 u16 status, gfp_t gfp);
3936 * cfg80211_roamed - notify cfg80211 of roaming
3938 * @dev: network device
3939 * @channel: the channel of the new AP
3940 * @bssid: the BSSID of the new AP
3941 * @req_ie: association request IEs (maybe be %NULL)
3942 * @req_ie_len: association request IEs length
3943 * @resp_ie: association response IEs (may be %NULL)
3944 * @resp_ie_len: assoc response IEs length
3945 * @gfp: allocation flags
3947 * It should be called by the underlying driver whenever it roamed
3948 * from one AP to another while connected.
3950 void cfg80211_roamed(struct net_device *dev,
3951 struct ieee80211_channel *channel,
3953 const u8 *req_ie, size_t req_ie_len,
3954 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3957 * cfg80211_roamed_bss - notify cfg80211 of roaming
3959 * @dev: network device
3960 * @bss: entry of bss to which STA got roamed
3961 * @req_ie: association request IEs (maybe be %NULL)
3962 * @req_ie_len: association request IEs length
3963 * @resp_ie: association response IEs (may be %NULL)
3964 * @resp_ie_len: assoc response IEs length
3965 * @gfp: allocation flags
3967 * This is just a wrapper to notify cfg80211 of roaming event with driver
3968 * passing bss to avoid a race in timeout of the bss entry. It should be
3969 * called by the underlying driver whenever it roamed from one AP to another
3970 * while connected. Drivers which have roaming implemented in firmware
3971 * may use this function to avoid a race in bss entry timeout where the bss
3972 * entry of the new AP is seen in the driver, but gets timed out by the time
3973 * it is accessed in __cfg80211_roamed() due to delay in scheduling
3974 * rdev->event_work. In case of any failures, the reference is released
3975 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3976 * it will be released while diconneting from the current bss.
3978 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3979 const u8 *req_ie, size_t req_ie_len,
3980 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3983 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3985 * @dev: network device
3986 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3987 * @ie_len: length of IEs
3988 * @reason: reason code for the disconnection, set it to 0 if unknown
3989 * @gfp: allocation flags
3991 * After it calls this function, the driver should enter an idle state
3992 * and not try to connect to any AP any more.
3994 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3995 u8 *ie, size_t ie_len, gfp_t gfp);
3998 * cfg80211_ready_on_channel - notification of remain_on_channel start
3999 * @wdev: wireless device
4000 * @cookie: the request cookie
4001 * @chan: The current channel (from remain_on_channel request)
4002 * @duration: Duration in milliseconds that the driver intents to remain on the
4004 * @gfp: allocation flags
4006 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4007 struct ieee80211_channel *chan,
4008 unsigned int duration, gfp_t gfp);
4011 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4012 * @wdev: wireless device
4013 * @cookie: the request cookie
4014 * @chan: The current channel (from remain_on_channel request)
4015 * @gfp: allocation flags
4017 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4018 struct ieee80211_channel *chan,
4023 * cfg80211_new_sta - notify userspace about station
4026 * @mac_addr: the station's address
4027 * @sinfo: the station information
4028 * @gfp: allocation flags
4030 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4031 struct station_info *sinfo, gfp_t gfp);
4034 * cfg80211_del_sta - notify userspace about deletion of a station
4037 * @mac_addr: the station's address
4038 * @gfp: allocation flags
4040 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
4043 * cfg80211_conn_failed - connection request failed notification
4046 * @mac_addr: the station's address
4047 * @reason: the reason for connection failure
4048 * @gfp: allocation flags
4050 * Whenever a station tries to connect to an AP and if the station
4051 * could not connect to the AP as the AP has rejected the connection
4052 * for some reasons, this function is called.
4054 * The reason for connection failure can be any of the value from
4055 * nl80211_connect_failed_reason enum
4057 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4058 enum nl80211_connect_failed_reason reason,
4062 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4063 * @wdev: wireless device receiving the frame
4064 * @freq: Frequency on which the frame was received in MHz
4065 * @sig_dbm: signal strength in mBm, or 0 if unknown
4066 * @buf: Management frame (header + body)
4067 * @len: length of the frame data
4068 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4069 * @gfp: context flags
4071 * This function is called whenever an Action frame is received for a station
4072 * mode interface, but is not processed in kernel.
4074 * Return: %true if a user space application has registered for this frame.
4075 * For action frames, that makes it responsible for rejecting unrecognized
4076 * action frames; %false otherwise, in which case for action frames the
4077 * driver is responsible for rejecting the frame.
4079 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4080 const u8 *buf, size_t len, u32 flags, gfp_t gfp);
4083 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4084 * @wdev: wireless device receiving the frame
4085 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4086 * @buf: Management frame (header + body)
4087 * @len: length of the frame data
4088 * @ack: Whether frame was acknowledged
4089 * @gfp: context flags
4091 * This function is called whenever a management frame was requested to be
4092 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4093 * transmission attempt.
4095 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4096 const u8 *buf, size_t len, bool ack, gfp_t gfp);
4100 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4101 * @dev: network device
4102 * @rssi_event: the triggered RSSI event
4103 * @gfp: context flags
4105 * This function is called when a configured connection quality monitoring
4106 * rssi threshold reached event occurs.
4108 void cfg80211_cqm_rssi_notify(struct net_device *dev,
4109 enum nl80211_cqm_rssi_threshold_event rssi_event,
4113 * cfg80211_radar_event - radar detection event
4115 * @chandef: chandef for the current channel
4116 * @gfp: context flags
4118 * This function is called when a radar is detected on the current chanenl.
4120 void cfg80211_radar_event(struct wiphy *wiphy,
4121 struct cfg80211_chan_def *chandef, gfp_t gfp);
4124 * cfg80211_cac_event - Channel availability check (CAC) event
4125 * @netdev: network device
4126 * @event: type of event
4127 * @gfp: context flags
4129 * This function is called when a Channel availability check (CAC) is finished
4130 * or aborted. This must be called to notify the completion of a CAC process,
4131 * also by full-MAC drivers.
4133 void cfg80211_cac_event(struct net_device *netdev,
4134 enum nl80211_radar_event event, gfp_t gfp);
4138 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4139 * @dev: network device
4140 * @peer: peer's MAC address
4141 * @num_packets: how many packets were lost -- should be a fixed threshold
4142 * but probably no less than maybe 50, or maybe a throughput dependent
4143 * threshold (to account for temporary interference)
4144 * @gfp: context flags
4146 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
4147 const u8 *peer, u32 num_packets, gfp_t gfp);
4150 * cfg80211_cqm_txe_notify - TX error rate event
4151 * @dev: network device
4152 * @peer: peer's MAC address
4153 * @num_packets: how many packets were lost
4154 * @rate: % of packets which failed transmission
4155 * @intvl: interval (in s) over which the TX failure threshold was breached.
4156 * @gfp: context flags
4158 * Notify userspace when configured % TX failures over number of packets in a
4159 * given interval is exceeded.
4161 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
4162 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
4165 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
4166 * @dev: network device
4167 * @bssid: BSSID of AP (to avoid races)
4168 * @replay_ctr: new replay counter
4169 * @gfp: allocation flags
4171 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
4172 const u8 *replay_ctr, gfp_t gfp);
4175 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
4176 * @dev: network device
4177 * @index: candidate index (the smaller the index, the higher the priority)
4178 * @bssid: BSSID of AP
4179 * @preauth: Whether AP advertises support for RSN pre-authentication
4180 * @gfp: allocation flags
4182 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
4183 const u8 *bssid, bool preauth, gfp_t gfp);
4186 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
4187 * @dev: The device the frame matched to
4188 * @addr: the transmitter address
4189 * @gfp: context flags
4191 * This function is used in AP mode (only!) to inform userspace that
4192 * a spurious class 3 frame was received, to be able to deauth the
4194 * Return: %true if the frame was passed to userspace (or this failed
4195 * for a reason other than not having a subscription.)
4197 bool cfg80211_rx_spurious_frame(struct net_device *dev,
4198 const u8 *addr, gfp_t gfp);
4201 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
4202 * @dev: The device the frame matched to
4203 * @addr: the transmitter address
4204 * @gfp: context flags
4206 * This function is used in AP mode (only!) to inform userspace that
4207 * an associated station sent a 4addr frame but that wasn't expected.
4208 * It is allowed and desirable to send this event only once for each
4209 * station to avoid event flooding.
4210 * Return: %true if the frame was passed to userspace (or this failed
4211 * for a reason other than not having a subscription.)
4213 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
4214 const u8 *addr, gfp_t gfp);
4217 * cfg80211_probe_status - notify userspace about probe status
4218 * @dev: the device the probe was sent on
4219 * @addr: the address of the peer
4220 * @cookie: the cookie filled in @probe_client previously
4221 * @acked: indicates whether probe was acked or not
4222 * @gfp: allocation flags
4224 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
4225 u64 cookie, bool acked, gfp_t gfp);
4228 * cfg80211_report_obss_beacon - report beacon from other APs
4229 * @wiphy: The wiphy that received the beacon
4231 * @len: length of the frame
4232 * @freq: frequency the frame was received on
4233 * @sig_dbm: signal strength in mBm, or 0 if unknown
4235 * Use this function to report to userspace when a beacon was
4236 * received. It is not useful to call this when there is no
4237 * netdev that is in AP/GO mode.
4239 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
4240 const u8 *frame, size_t len,
4241 int freq, int sig_dbm);
4244 * cfg80211_reg_can_beacon - check if beaconing is allowed
4246 * @chandef: the channel definition
4248 * Return: %true if there is no secondary channel or the secondary channel(s)
4249 * can be used for beaconing (i.e. is not a radar channel etc.)
4251 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
4252 struct cfg80211_chan_def *chandef);
4255 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
4256 * @dev: the device which switched channels
4257 * @chandef: the new channel definition
4259 * Acquires wdev_lock, so must only be called from sleepable driver context!
4261 void cfg80211_ch_switch_notify(struct net_device *dev,
4262 struct cfg80211_chan_def *chandef);
4265 * ieee80211_operating_class_to_band - convert operating class to band
4267 * @operating_class: the operating class to convert
4268 * @band: band pointer to fill
4270 * Returns %true if the conversion was successful, %false otherwise.
4272 bool ieee80211_operating_class_to_band(u8 operating_class,
4273 enum ieee80211_band *band);
4276 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
4277 * @dev: the device on which the operation is requested
4278 * @peer: the MAC address of the peer device
4279 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
4280 * NL80211_TDLS_TEARDOWN)
4281 * @reason_code: the reason code for teardown request
4282 * @gfp: allocation flags
4284 * This function is used to request userspace to perform TDLS operation that
4285 * requires knowledge of keys, i.e., link setup or teardown when the AP
4286 * connection uses encryption. This is optional mechanism for the driver to use
4287 * if it can automatically determine when a TDLS link could be useful (e.g.,
4288 * based on traffic and signal strength for a peer).
4290 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
4291 enum nl80211_tdls_operation oper,
4292 u16 reason_code, gfp_t gfp);
4295 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
4296 * @rate: given rate_info to calculate bitrate from
4298 * return 0 if MCS index >= 32
4300 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
4303 * cfg80211_unregister_wdev - remove the given wdev
4304 * @wdev: struct wireless_dev to remove
4306 * Call this function only for wdevs that have no netdev assigned,
4307 * e.g. P2P Devices. It removes the device from the list so that
4308 * it can no longer be used. It is necessary to call this function
4309 * even when cfg80211 requests the removal of the interface by
4310 * calling the del_virtual_intf() callback. The function must also
4311 * be called when the driver wishes to unregister the wdev, e.g.
4312 * when the device is unbound from the driver.
4314 * Requires the RTNL to be held.
4316 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
4319 * struct cfg80211_ft_event - FT Information Elements
4321 * @ies_len: length of the FT IE in bytes
4322 * @target_ap: target AP's MAC address
4324 * @ric_ies_len: length of the RIC IE in bytes
4326 struct cfg80211_ft_event_params {
4329 const u8 *target_ap;
4335 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
4336 * @netdev: network device
4337 * @ft_event: IE information
4339 void cfg80211_ft_event(struct net_device *netdev,
4340 struct cfg80211_ft_event_params *ft_event);
4343 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
4344 * @ies: the input IE buffer
4345 * @len: the input length
4346 * @attr: the attribute ID to find
4347 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
4348 * if the function is only called to get the needed buffer size
4349 * @bufsize: size of the output buffer
4351 * The function finds a given P2P attribute in the (vendor) IEs and
4352 * copies its contents to the given buffer.
4354 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
4355 * malformed or the attribute can't be found (respectively), or the
4356 * length of the found attribute (which can be zero).
4358 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
4359 enum ieee80211_p2p_attr_id attr,
4360 u8 *buf, unsigned int bufsize);
4363 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
4364 * @wdev: the wireless device reporting the wakeup
4365 * @wakeup: the wakeup report
4366 * @gfp: allocation flags
4368 * This function reports that the given device woke up. If it
4369 * caused the wakeup, report the reason(s), otherwise you may
4370 * pass %NULL as the @wakeup parameter to advertise that something
4371 * else caused the wakeup.
4373 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
4374 struct cfg80211_wowlan_wakeup *wakeup,
4378 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
4380 * @wdev: the wireless device for which critical protocol is stopped.
4381 * @gfp: allocation flags
4383 * This function can be called by the driver to indicate it has reverted
4384 * operation back to normal. One reason could be that the duration given
4385 * by .crit_proto_start() has expired.
4387 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
4389 /* Logging, debugging and troubleshooting/diagnostic helpers. */
4391 /* wiphy_printk helpers, similar to dev_printk */
4393 #define wiphy_printk(level, wiphy, format, args...) \
4394 dev_printk(level, &(wiphy)->dev, format, ##args)
4395 #define wiphy_emerg(wiphy, format, args...) \
4396 dev_emerg(&(wiphy)->dev, format, ##args)
4397 #define wiphy_alert(wiphy, format, args...) \
4398 dev_alert(&(wiphy)->dev, format, ##args)
4399 #define wiphy_crit(wiphy, format, args...) \
4400 dev_crit(&(wiphy)->dev, format, ##args)
4401 #define wiphy_err(wiphy, format, args...) \
4402 dev_err(&(wiphy)->dev, format, ##args)
4403 #define wiphy_warn(wiphy, format, args...) \
4404 dev_warn(&(wiphy)->dev, format, ##args)
4405 #define wiphy_notice(wiphy, format, args...) \
4406 dev_notice(&(wiphy)->dev, format, ##args)
4407 #define wiphy_info(wiphy, format, args...) \
4408 dev_info(&(wiphy)->dev, format, ##args)
4410 #define wiphy_debug(wiphy, format, args...) \
4411 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
4413 #define wiphy_dbg(wiphy, format, args...) \
4414 dev_dbg(&(wiphy)->dev, format, ##args)
4416 #if defined(VERBOSE_DEBUG)
4417 #define wiphy_vdbg wiphy_dbg
4419 #define wiphy_vdbg(wiphy, format, args...) \
4422 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
4428 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
4429 * of using a WARN/WARN_ON to get the message out, including the
4430 * file/line information and a backtrace.
4432 #define wiphy_WARN(wiphy, format, args...) \
4433 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
4435 #endif /* __NET_CFG80211_H */