1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
4 * 802.11 device and configuration interface
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright 2015 Intel Deutschland GmbH
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #include <linux/netdevice.h>
16 #include <linux/debugfs.h>
17 #include <linux/list.h>
18 #include <linux/bug.h>
19 #include <linux/netlink.h>
20 #include <linux/skbuff.h>
21 #include <linux/nl80211.h>
22 #include <linux/if_ether.h>
23 #include <linux/ieee80211.h>
24 #include <linux/net.h>
25 #include <net/regulatory.h>
30 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
31 * userspace and drivers, and offers some utility functionality associated
32 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
33 * by all modern wireless drivers in Linux, so that they offer a consistent
34 * API through nl80211. For backward compatibility, cfg80211 also offers
35 * wireless extensions to userspace, but hides them from drivers completely.
37 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
43 * DOC: Device registration
45 * In order for a driver to use cfg80211, it must register the hardware device
46 * with cfg80211. This happens through a number of hardware capability structs
49 * The fundamental structure for each device is the 'wiphy', of which each
50 * instance describes a physical wireless device connected to the system. Each
51 * such wiphy can have zero, one, or many virtual interfaces associated with
52 * it, which need to be identified as such by pointing the network interface's
53 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
54 * the wireless part of the interface, normally this struct is embedded in the
55 * network interface's private data area. Drivers can optionally allow creating
56 * or destroying virtual interfaces on the fly, but without at least one or the
57 * ability to create some the wireless device isn't useful.
59 * Each wiphy structure contains device capability information, and also has
60 * a pointer to the various operations the driver offers. The definitions and
61 * structures here describe these capabilities in detail.
67 * wireless hardware capability structures
71 * enum ieee80211_channel_flags - channel flags
73 * Channel flags set by the regulatory control code.
75 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
76 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
77 * sending probe requests or beaconing.
78 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
79 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
81 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
83 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
84 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
85 * this flag indicates that an 80 MHz channel cannot use this
86 * channel as the control or any of the secondary channels.
87 * This may be due to the driver or due to regulatory bandwidth
89 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
90 * this flag indicates that an 160 MHz channel cannot use this
91 * channel as the control or any of the secondary channels.
92 * This may be due to the driver or due to regulatory bandwidth
94 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
95 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
96 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
98 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
102 enum ieee80211_channel_flags {
103 IEEE80211_CHAN_DISABLED = 1<<0,
104 IEEE80211_CHAN_NO_IR = 1<<1,
106 IEEE80211_CHAN_RADAR = 1<<3,
107 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
108 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
109 IEEE80211_CHAN_NO_OFDM = 1<<6,
110 IEEE80211_CHAN_NO_80MHZ = 1<<7,
111 IEEE80211_CHAN_NO_160MHZ = 1<<8,
112 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
113 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
114 IEEE80211_CHAN_NO_20MHZ = 1<<11,
115 IEEE80211_CHAN_NO_10MHZ = 1<<12,
118 #define IEEE80211_CHAN_NO_HT40 \
119 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
121 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
122 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
125 * struct ieee80211_channel - channel definition
127 * This structure describes a single channel for use
130 * @center_freq: center frequency in MHz
131 * @hw_value: hardware-specific value for the channel
132 * @flags: channel flags from &enum ieee80211_channel_flags.
133 * @orig_flags: channel flags at registration time, used by regulatory
134 * code to support devices with additional restrictions
135 * @band: band this channel belongs to.
136 * @max_antenna_gain: maximum antenna gain in dBi
137 * @max_power: maximum transmission power (in dBm)
138 * @max_reg_power: maximum regulatory transmission power (in dBm)
139 * @beacon_found: helper to regulatory code to indicate when a beacon
140 * has been found on this channel. Use regulatory_hint_found_beacon()
141 * to enable this, this is useful only on 5 GHz band.
142 * @orig_mag: internal use
143 * @orig_mpwr: internal use
144 * @dfs_state: current state of this channel. Only relevant if radar is required
146 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
147 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
149 struct ieee80211_channel {
150 enum nl80211_band band;
154 int max_antenna_gain;
159 int orig_mag, orig_mpwr;
160 enum nl80211_dfs_state dfs_state;
161 unsigned long dfs_state_entered;
162 unsigned int dfs_cac_ms;
166 * enum ieee80211_rate_flags - rate flags
168 * Hardware/specification flags for rates. These are structured
169 * in a way that allows using the same bitrate structure for
170 * different bands/PHY modes.
172 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
173 * preamble on this bitrate; only relevant in 2.4GHz band and
175 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
176 * when used with 802.11a (on the 5 GHz band); filled by the
177 * core code when registering the wiphy.
178 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
179 * when used with 802.11b (on the 2.4 GHz band); filled by the
180 * core code when registering the wiphy.
181 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
182 * when used with 802.11g (on the 2.4 GHz band); filled by the
183 * core code when registering the wiphy.
184 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
185 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
186 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
188 enum ieee80211_rate_flags {
189 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
190 IEEE80211_RATE_MANDATORY_A = 1<<1,
191 IEEE80211_RATE_MANDATORY_B = 1<<2,
192 IEEE80211_RATE_MANDATORY_G = 1<<3,
193 IEEE80211_RATE_ERP_G = 1<<4,
194 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
195 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
199 * enum ieee80211_bss_type - BSS type filter
201 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
202 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
203 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
204 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
205 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
207 enum ieee80211_bss_type {
208 IEEE80211_BSS_TYPE_ESS,
209 IEEE80211_BSS_TYPE_PBSS,
210 IEEE80211_BSS_TYPE_IBSS,
211 IEEE80211_BSS_TYPE_MBSS,
212 IEEE80211_BSS_TYPE_ANY
216 * enum ieee80211_privacy - BSS privacy filter
218 * @IEEE80211_PRIVACY_ON: privacy bit set
219 * @IEEE80211_PRIVACY_OFF: privacy bit clear
220 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
222 enum ieee80211_privacy {
223 IEEE80211_PRIVACY_ON,
224 IEEE80211_PRIVACY_OFF,
225 IEEE80211_PRIVACY_ANY
228 #define IEEE80211_PRIVACY(x) \
229 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
232 * struct ieee80211_rate - bitrate definition
234 * This structure describes a bitrate that an 802.11 PHY can
235 * operate with. The two values @hw_value and @hw_value_short
236 * are only for driver use when pointers to this structure are
239 * @flags: rate-specific flags
240 * @bitrate: bitrate in units of 100 Kbps
241 * @hw_value: driver/hardware value for this rate
242 * @hw_value_short: driver/hardware value for this rate when
243 * short preamble is used
245 struct ieee80211_rate {
248 u16 hw_value, hw_value_short;
252 * struct ieee80211_sta_ht_cap - STA's HT capabilities
254 * This structure describes most essential parameters needed
255 * to describe 802.11n HT capabilities for an STA.
257 * @ht_supported: is HT supported by the STA
258 * @cap: HT capabilities map as described in 802.11n spec
259 * @ampdu_factor: Maximum A-MPDU length factor
260 * @ampdu_density: Minimum A-MPDU spacing
261 * @mcs: Supported MCS rates
263 struct ieee80211_sta_ht_cap {
264 u16 cap; /* use IEEE80211_HT_CAP_ */
268 struct ieee80211_mcs_info mcs;
272 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
274 * This structure describes most essential parameters needed
275 * to describe 802.11ac VHT capabilities for an STA.
277 * @vht_supported: is VHT supported by the STA
278 * @cap: VHT capabilities map as described in 802.11ac spec
279 * @vht_mcs: Supported VHT MCS rates
281 struct ieee80211_sta_vht_cap {
283 u32 cap; /* use IEEE80211_VHT_CAP_ */
284 struct ieee80211_vht_mcs_info vht_mcs;
288 * struct ieee80211_supported_band - frequency band definition
290 * This structure describes a frequency band a wiphy
291 * is able to operate in.
293 * @channels: Array of channels the hardware can operate in
295 * @band: the band this structure represents
296 * @n_channels: Number of channels in @channels
297 * @bitrates: Array of bitrates the hardware can operate with
298 * in this band. Must be sorted to give a valid "supported
299 * rates" IE, i.e. CCK rates first, then OFDM.
300 * @n_bitrates: Number of bitrates in @bitrates
301 * @ht_cap: HT capabilities in this band
302 * @vht_cap: VHT capabilities in this band
304 struct ieee80211_supported_band {
305 struct ieee80211_channel *channels;
306 struct ieee80211_rate *bitrates;
307 enum nl80211_band band;
310 struct ieee80211_sta_ht_cap ht_cap;
311 struct ieee80211_sta_vht_cap vht_cap;
315 * Wireless hardware/device configuration structures and methods
319 * DOC: Actions and configuration
321 * Each wireless device and each virtual interface offer a set of configuration
322 * operations and other actions that are invoked by userspace. Each of these
323 * actions is described in the operations structure, and the parameters these
324 * operations use are described separately.
326 * Additionally, some operations are asynchronous and expect to get status
327 * information via some functions that drivers need to call.
329 * Scanning and BSS list handling with its associated functionality is described
330 * in a separate chapter.
333 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
334 WLAN_USER_POSITION_LEN)
337 * struct vif_params - describes virtual interface parameters
338 * @use_4addr: use 4-address frames
339 * @macaddr: address to use for this virtual interface.
340 * If this parameter is set to zero address the driver may
341 * determine the address as needed.
342 * This feature is only fully supported by drivers that enable the
343 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
344 ** only p2p devices with specified MAC.
345 * @vht_mumimo_groups: MU-MIMO groupID. used for monitoring only
346 * packets belonging to that MU-MIMO groupID.
350 u8 macaddr[ETH_ALEN];
351 u8 vht_mumimo_groups[VHT_MUMIMO_GROUPS_DATA_LEN];
355 * struct key_params - key information
357 * Information about a key
360 * @key_len: length of key material
361 * @cipher: cipher suite selector
362 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
363 * with the get_key() callback, must be in little endian,
364 * length given by @seq_len.
365 * @seq_len: length of @seq.
376 * struct cfg80211_chan_def - channel definition
377 * @chan: the (control) channel
378 * @width: channel width
379 * @center_freq1: center frequency of first segment
380 * @center_freq2: center frequency of second segment
381 * (only with 80+80 MHz)
383 struct cfg80211_chan_def {
384 struct ieee80211_channel *chan;
385 enum nl80211_chan_width width;
391 * cfg80211_get_chandef_type - return old channel type from chandef
392 * @chandef: the channel definition
394 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
395 * chandef, which must have a bandwidth allowing this conversion.
397 static inline enum nl80211_channel_type
398 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
400 switch (chandef->width) {
401 case NL80211_CHAN_WIDTH_20_NOHT:
402 return NL80211_CHAN_NO_HT;
403 case NL80211_CHAN_WIDTH_20:
404 return NL80211_CHAN_HT20;
405 case NL80211_CHAN_WIDTH_40:
406 if (chandef->center_freq1 > chandef->chan->center_freq)
407 return NL80211_CHAN_HT40PLUS;
408 return NL80211_CHAN_HT40MINUS;
411 return NL80211_CHAN_NO_HT;
416 * cfg80211_chandef_create - create channel definition using channel type
417 * @chandef: the channel definition struct to fill
418 * @channel: the control channel
419 * @chantype: the channel type
421 * Given a channel type, create a channel definition.
423 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
424 struct ieee80211_channel *channel,
425 enum nl80211_channel_type chantype);
428 * cfg80211_chandef_identical - check if two channel definitions are identical
429 * @chandef1: first channel definition
430 * @chandef2: second channel definition
432 * Return: %true if the channels defined by the channel definitions are
433 * identical, %false otherwise.
436 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
437 const struct cfg80211_chan_def *chandef2)
439 return (chandef1->chan == chandef2->chan &&
440 chandef1->width == chandef2->width &&
441 chandef1->center_freq1 == chandef2->center_freq1 &&
442 chandef1->center_freq2 == chandef2->center_freq2);
446 * cfg80211_chandef_compatible - check if two channel definitions are compatible
447 * @chandef1: first channel definition
448 * @chandef2: second channel definition
450 * Return: %NULL if the given channel definitions are incompatible,
451 * chandef1 or chandef2 otherwise.
453 const struct cfg80211_chan_def *
454 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
455 const struct cfg80211_chan_def *chandef2);
458 * cfg80211_chandef_valid - check if a channel definition is valid
459 * @chandef: the channel definition to check
460 * Return: %true if the channel definition is valid. %false otherwise.
462 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
465 * cfg80211_chandef_usable - check if secondary channels can be used
466 * @wiphy: the wiphy to validate against
467 * @chandef: the channel definition to check
468 * @prohibited_flags: the regulatory channel flags that must not be set
469 * Return: %true if secondary channels are usable. %false otherwise.
471 bool cfg80211_chandef_usable(struct wiphy *wiphy,
472 const struct cfg80211_chan_def *chandef,
473 u32 prohibited_flags);
476 * cfg80211_chandef_dfs_required - checks if radar detection is required
477 * @wiphy: the wiphy to validate against
478 * @chandef: the channel definition to check
479 * @iftype: the interface type as specified in &enum nl80211_iftype
481 * 1 if radar detection is required, 0 if it is not, < 0 on error
483 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
484 const struct cfg80211_chan_def *chandef,
485 enum nl80211_iftype iftype);
488 * ieee80211_chandef_rate_flags - returns rate flags for a channel
490 * In some channel types, not all rates may be used - for example CCK
491 * rates may not be used in 5/10 MHz channels.
493 * @chandef: channel definition for the channel
495 * Returns: rate flags which apply for this channel
497 static inline enum ieee80211_rate_flags
498 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
500 switch (chandef->width) {
501 case NL80211_CHAN_WIDTH_5:
502 return IEEE80211_RATE_SUPPORTS_5MHZ;
503 case NL80211_CHAN_WIDTH_10:
504 return IEEE80211_RATE_SUPPORTS_10MHZ;
512 * ieee80211_chandef_max_power - maximum transmission power for the chandef
514 * In some regulations, the transmit power may depend on the configured channel
515 * bandwidth which may be defined as dBm/MHz. This function returns the actual
516 * max_power for non-standard (20 MHz) channels.
518 * @chandef: channel definition for the channel
520 * Returns: maximum allowed transmission power in dBm for the chandef
523 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
525 switch (chandef->width) {
526 case NL80211_CHAN_WIDTH_5:
527 return min(chandef->chan->max_reg_power - 6,
528 chandef->chan->max_power);
529 case NL80211_CHAN_WIDTH_10:
530 return min(chandef->chan->max_reg_power - 3,
531 chandef->chan->max_power);
535 return chandef->chan->max_power;
539 * enum survey_info_flags - survey information flags
541 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
542 * @SURVEY_INFO_IN_USE: channel is currently being used
543 * @SURVEY_INFO_TIME: active time (in ms) was filled in
544 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
545 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
546 * @SURVEY_INFO_TIME_RX: receive time was filled in
547 * @SURVEY_INFO_TIME_TX: transmit time was filled in
548 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
550 * Used by the driver to indicate which info in &struct survey_info
551 * it has filled in during the get_survey().
553 enum survey_info_flags {
554 SURVEY_INFO_NOISE_DBM = BIT(0),
555 SURVEY_INFO_IN_USE = BIT(1),
556 SURVEY_INFO_TIME = BIT(2),
557 SURVEY_INFO_TIME_BUSY = BIT(3),
558 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
559 SURVEY_INFO_TIME_RX = BIT(5),
560 SURVEY_INFO_TIME_TX = BIT(6),
561 SURVEY_INFO_TIME_SCAN = BIT(7),
565 * struct survey_info - channel survey response
567 * @channel: the channel this survey record reports, may be %NULL for a single
568 * record to report global statistics
569 * @filled: bitflag of flags from &enum survey_info_flags
570 * @noise: channel noise in dBm. This and all following fields are
572 * @time: amount of time in ms the radio was turn on (on the channel)
573 * @time_busy: amount of time the primary channel was sensed busy
574 * @time_ext_busy: amount of time the extension channel was sensed busy
575 * @time_rx: amount of time the radio spent receiving data
576 * @time_tx: amount of time the radio spent transmitting data
577 * @time_scan: amount of time the radio spent for scanning
579 * Used by dump_survey() to report back per-channel survey information.
581 * This structure can later be expanded with things like
582 * channel duty cycle etc.
585 struct ieee80211_channel *channel;
597 * struct cfg80211_crypto_settings - Crypto settings
598 * @wpa_versions: indicates which, if any, WPA versions are enabled
599 * (from enum nl80211_wpa_versions)
600 * @cipher_group: group key cipher suite (or 0 if unset)
601 * @n_ciphers_pairwise: number of AP supported unicast ciphers
602 * @ciphers_pairwise: unicast key cipher suites
603 * @n_akm_suites: number of AKM suites
604 * @akm_suites: AKM suites
605 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
606 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
607 * required to assume that the port is unauthorized until authorized by
608 * user space. Otherwise, port is marked authorized by default.
609 * @control_port_ethertype: the control port protocol that should be
610 * allowed through even on unauthorized ports
611 * @control_port_no_encrypt: TRUE to prevent encryption of control port
614 struct cfg80211_crypto_settings {
617 int n_ciphers_pairwise;
618 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
620 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
622 __be16 control_port_ethertype;
623 bool control_port_no_encrypt;
627 * struct cfg80211_beacon_data - beacon data
628 * @head: head portion of beacon (before TIM IE)
629 * or %NULL if not changed
630 * @tail: tail portion of beacon (after TIM IE)
631 * or %NULL if not changed
632 * @head_len: length of @head
633 * @tail_len: length of @tail
634 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
635 * @beacon_ies_len: length of beacon_ies in octets
636 * @proberesp_ies: extra information element(s) to add into Probe Response
638 * @proberesp_ies_len: length of proberesp_ies in octets
639 * @assocresp_ies: extra information element(s) to add into (Re)Association
640 * Response frames or %NULL
641 * @assocresp_ies_len: length of assocresp_ies in octets
642 * @probe_resp_len: length of probe response template (@probe_resp)
643 * @probe_resp: probe response template (AP mode only)
645 struct cfg80211_beacon_data {
646 const u8 *head, *tail;
647 const u8 *beacon_ies;
648 const u8 *proberesp_ies;
649 const u8 *assocresp_ies;
650 const u8 *probe_resp;
652 size_t head_len, tail_len;
653 size_t beacon_ies_len;
654 size_t proberesp_ies_len;
655 size_t assocresp_ies_len;
656 size_t probe_resp_len;
664 * struct cfg80211_acl_data - Access control list data
666 * @acl_policy: ACL policy to be applied on the station's
667 * entry specified by mac_addr
668 * @n_acl_entries: Number of MAC address entries passed
669 * @mac_addrs: List of MAC addresses of stations to be used for ACL
671 struct cfg80211_acl_data {
672 enum nl80211_acl_policy acl_policy;
676 struct mac_address mac_addrs[];
680 * struct cfg80211_ap_settings - AP configuration
682 * Used to configure an AP interface.
684 * @chandef: defines the channel to use
685 * @beacon: beacon data
686 * @beacon_interval: beacon interval
687 * @dtim_period: DTIM period
688 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
690 * @ssid_len: length of @ssid
691 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
692 * @crypto: crypto settings
693 * @privacy: the BSS uses privacy
694 * @auth_type: Authentication type (algorithm)
695 * @smps_mode: SMPS mode
696 * @inactivity_timeout: time in seconds to determine station's inactivity.
697 * @p2p_ctwindow: P2P CT Window
698 * @p2p_opp_ps: P2P opportunistic PS
699 * @acl: ACL configuration used by the drivers which has support for
700 * MAC address based access control
701 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
704 struct cfg80211_ap_settings {
705 struct cfg80211_chan_def chandef;
707 struct cfg80211_beacon_data beacon;
709 int beacon_interval, dtim_period;
712 enum nl80211_hidden_ssid hidden_ssid;
713 struct cfg80211_crypto_settings crypto;
715 enum nl80211_auth_type auth_type;
716 enum nl80211_smps_mode smps_mode;
717 int inactivity_timeout;
720 const struct cfg80211_acl_data *acl;
725 * struct cfg80211_csa_settings - channel switch settings
727 * Used for channel switch
729 * @chandef: defines the channel to use after the switch
730 * @beacon_csa: beacon data while performing the switch
731 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
732 * @counter_offsets_presp: offsets of the counters within the probe response
733 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
734 * @n_counter_offsets_presp: number of csa counters in the probe response
735 * @beacon_after: beacon data to be used on the new channel
736 * @radar_required: whether radar detection is required on the new channel
737 * @block_tx: whether transmissions should be blocked while changing
738 * @count: number of beacons until switch
740 struct cfg80211_csa_settings {
741 struct cfg80211_chan_def chandef;
742 struct cfg80211_beacon_data beacon_csa;
743 const u16 *counter_offsets_beacon;
744 const u16 *counter_offsets_presp;
745 unsigned int n_counter_offsets_beacon;
746 unsigned int n_counter_offsets_presp;
747 struct cfg80211_beacon_data beacon_after;
754 * enum station_parameters_apply_mask - station parameter values to apply
755 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
756 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
757 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
759 * Not all station parameters have in-band "no change" signalling,
760 * for those that don't these flags will are used.
762 enum station_parameters_apply_mask {
763 STATION_PARAM_APPLY_UAPSD = BIT(0),
764 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
765 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
769 * struct station_parameters - station parameters
771 * Used to change and create a new station.
773 * @vlan: vlan interface station should belong to
774 * @supported_rates: supported rates in IEEE 802.11 format
775 * (or NULL for no change)
776 * @supported_rates_len: number of supported rates
777 * @sta_flags_mask: station flags that changed
778 * (bitmask of BIT(NL80211_STA_FLAG_...))
779 * @sta_flags_set: station flags values
780 * (bitmask of BIT(NL80211_STA_FLAG_...))
781 * @listen_interval: listen interval or -1 for no change
782 * @aid: AID or zero for no change
783 * @peer_aid: mesh peer AID or zero for no change
784 * @plink_action: plink action to take
785 * @plink_state: set the peer link state for a station
786 * @ht_capa: HT capabilities of station
787 * @vht_capa: VHT capabilities of station
788 * @uapsd_queues: bitmap of queues configured for uapsd. same format
789 * as the AC bitmap in the QoS info field
790 * @max_sp: max Service Period. same format as the MAX_SP in the
791 * QoS info field (but already shifted down)
792 * @sta_modify_mask: bitmap indicating which parameters changed
793 * (for those that don't have a natural "no change" value),
794 * see &enum station_parameters_apply_mask
795 * @local_pm: local link-specific mesh power save mode (no change when set
797 * @capability: station capability
798 * @ext_capab: extended capabilities of the station
799 * @ext_capab_len: number of extended capabilities
800 * @supported_channels: supported channels in IEEE 802.11 format
801 * @supported_channels_len: number of supported channels
802 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
803 * @supported_oper_classes_len: number of supported operating classes
804 * @opmode_notif: operating mode field from Operating Mode Notification
805 * @opmode_notif_used: information if operating mode field is used
806 * @support_p2p_ps: information if station supports P2P PS mechanism
808 struct station_parameters {
809 const u8 *supported_rates;
810 struct net_device *vlan;
811 u32 sta_flags_mask, sta_flags_set;
816 u8 supported_rates_len;
819 const struct ieee80211_ht_cap *ht_capa;
820 const struct ieee80211_vht_cap *vht_capa;
823 enum nl80211_mesh_power_mode local_pm;
827 const u8 *supported_channels;
828 u8 supported_channels_len;
829 const u8 *supported_oper_classes;
830 u8 supported_oper_classes_len;
832 bool opmode_notif_used;
837 * struct station_del_parameters - station deletion parameters
839 * Used to delete a station entry (or all stations).
841 * @mac: MAC address of the station to remove or NULL to remove all stations
842 * @subtype: Management frame subtype to use for indicating removal
843 * (10 = Disassociation, 12 = Deauthentication)
844 * @reason_code: Reason code for the Disassociation/Deauthentication frame
846 struct station_del_parameters {
853 * enum cfg80211_station_type - the type of station being modified
854 * @CFG80211_STA_AP_CLIENT: client of an AP interface
855 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
856 * unassociated (update properties for this type of client is permitted)
857 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
858 * the AP MLME in the device
859 * @CFG80211_STA_AP_STA: AP station on managed interface
860 * @CFG80211_STA_IBSS: IBSS station
861 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
862 * while TDLS setup is in progress, it moves out of this state when
863 * being marked authorized; use this only if TDLS with external setup is
865 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
866 * entry that is operating, has been marked authorized by userspace)
867 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
868 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
870 enum cfg80211_station_type {
871 CFG80211_STA_AP_CLIENT,
872 CFG80211_STA_AP_CLIENT_UNASSOC,
873 CFG80211_STA_AP_MLME_CLIENT,
876 CFG80211_STA_TDLS_PEER_SETUP,
877 CFG80211_STA_TDLS_PEER_ACTIVE,
878 CFG80211_STA_MESH_PEER_KERNEL,
879 CFG80211_STA_MESH_PEER_USER,
883 * cfg80211_check_station_change - validate parameter changes
884 * @wiphy: the wiphy this operates on
885 * @params: the new parameters for a station
886 * @statype: the type of station being modified
888 * Utility function for the @change_station driver method. Call this function
889 * with the appropriate station type looking up the station (and checking that
890 * it exists). It will verify whether the station change is acceptable, and if
891 * not will return an error code. Note that it may modify the parameters for
892 * backward compatibility reasons, so don't use them before calling this.
894 int cfg80211_check_station_change(struct wiphy *wiphy,
895 struct station_parameters *params,
896 enum cfg80211_station_type statype);
899 * enum station_info_rate_flags - bitrate info flags
901 * Used by the driver to indicate the specific rate transmission
902 * type for 802.11n transmissions.
904 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
905 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
906 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
907 * @RATE_INFO_FLAGS_60G: 60GHz MCS
909 enum rate_info_flags {
910 RATE_INFO_FLAGS_MCS = BIT(0),
911 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
912 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
913 RATE_INFO_FLAGS_60G = BIT(3),
917 * enum rate_info_bw - rate bandwidth information
919 * Used by the driver to indicate the rate bandwidth.
921 * @RATE_INFO_BW_5: 5 MHz bandwidth
922 * @RATE_INFO_BW_10: 10 MHz bandwidth
923 * @RATE_INFO_BW_20: 20 MHz bandwidth
924 * @RATE_INFO_BW_40: 40 MHz bandwidth
925 * @RATE_INFO_BW_80: 80 MHz bandwidth
926 * @RATE_INFO_BW_160: 160 MHz bandwidth
938 * struct rate_info - bitrate information
940 * Information about a receiving or transmitting bitrate
942 * @flags: bitflag of flags from &enum rate_info_flags
943 * @mcs: mcs index if struct describes a 802.11n bitrate
944 * @legacy: bitrate in 100kbit/s for 802.11abg
945 * @nss: number of streams (VHT only)
946 * @bw: bandwidth (from &enum rate_info_bw)
957 * enum station_info_rate_flags - bitrate info flags
959 * Used by the driver to indicate the specific rate transmission
960 * type for 802.11n transmissions.
962 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
963 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
964 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
966 enum bss_param_flags {
967 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
968 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
969 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
973 * struct sta_bss_parameters - BSS parameters for the attached station
975 * Information about the currently associated BSS
977 * @flags: bitflag of flags from &enum bss_param_flags
978 * @dtim_period: DTIM period for the BSS
979 * @beacon_interval: beacon interval
981 struct sta_bss_parameters {
988 * struct cfg80211_tid_stats - per-TID statistics
989 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
990 * indicate the relevant values in this struct are filled
991 * @rx_msdu: number of received MSDUs
992 * @tx_msdu: number of (attempted) transmitted MSDUs
993 * @tx_msdu_retries: number of retries (not counting the first) for
995 * @tx_msdu_failed: number of failed transmitted MSDUs
997 struct cfg80211_tid_stats {
1001 u64 tx_msdu_retries;
1005 #define IEEE80211_MAX_CHAINS 4
1008 * struct station_info - station information
1010 * Station information filled by driver for get_station() and dump_station.
1012 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1013 * indicate the relevant values in this struct for them
1014 * @connected_time: time(in secs) since a station is last connected
1015 * @inactive_time: time since last station activity (tx/rx) in milliseconds
1016 * @rx_bytes: bytes (size of MPDUs) received from this station
1017 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1018 * @llid: mesh local link id
1019 * @plid: mesh peer link id
1020 * @plink_state: mesh peer link state
1021 * @signal: The signal strength, type depends on the wiphy's signal_type.
1022 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1023 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1024 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1025 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1026 * @chain_signal: per-chain signal strength of last received packet in dBm
1027 * @chain_signal_avg: per-chain signal strength average in dBm
1028 * @txrate: current unicast bitrate from this station
1029 * @rxrate: current unicast bitrate to this station
1030 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1031 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1032 * @tx_retries: cumulative retry counts (MPDUs)
1033 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1034 * @rx_dropped_misc: Dropped for un-specified reason.
1035 * @bss_param: current BSS parameters
1036 * @generation: generation number for nl80211 dumps.
1037 * This number should increase every time the list of stations
1038 * changes, i.e. when a station is added or removed, so that
1039 * userspace can tell whether it got a consistent snapshot.
1040 * @assoc_req_ies: IEs from (Re)Association Request.
1041 * This is used only when in AP mode with drivers that do not use
1042 * user space MLME/SME implementation. The information is provided for
1043 * the cfg80211_new_sta() calls to notify user space of the IEs.
1044 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1045 * @sta_flags: station flags mask & values
1046 * @beacon_loss_count: Number of times beacon loss event has triggered.
1047 * @t_offset: Time offset of the station relative to this host.
1048 * @local_pm: local mesh STA power save mode
1049 * @peer_pm: peer mesh STA power save mode
1050 * @nonpeer_pm: non-peer mesh STA power save mode
1051 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1052 * towards this station.
1053 * @rx_beacon: number of beacons received from this peer
1054 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1056 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1057 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1058 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1060 struct station_info {
1073 s8 chain_signal[IEEE80211_MAX_CHAINS];
1074 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1076 struct rate_info txrate;
1077 struct rate_info rxrate;
1082 u32 rx_dropped_misc;
1083 struct sta_bss_parameters bss_param;
1084 struct nl80211_sta_flag_update sta_flags;
1088 const u8 *assoc_req_ies;
1089 size_t assoc_req_ies_len;
1091 u32 beacon_loss_count;
1093 enum nl80211_mesh_power_mode local_pm;
1094 enum nl80211_mesh_power_mode peer_pm;
1095 enum nl80211_mesh_power_mode nonpeer_pm;
1097 u32 expected_throughput;
1101 u8 rx_beacon_signal_avg;
1102 struct cfg80211_tid_stats pertid[IEEE80211_NUM_TIDS + 1];
1106 * cfg80211_get_station - retrieve information about a given station
1107 * @dev: the device where the station is supposed to be connected to
1108 * @mac_addr: the mac address of the station of interest
1109 * @sinfo: pointer to the structure to fill with the information
1111 * Returns 0 on success and sinfo is filled with the available information
1112 * otherwise returns a negative error code and the content of sinfo has to be
1113 * considered undefined.
1115 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1116 struct station_info *sinfo);
1119 * enum monitor_flags - monitor flags
1121 * Monitor interface configuration flags. Note that these must be the bits
1122 * according to the nl80211 flags.
1124 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1125 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1126 * @MONITOR_FLAG_CONTROL: pass control frames
1127 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1128 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1129 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1131 enum monitor_flags {
1132 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1133 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1134 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1135 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1136 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1137 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
1141 * enum mpath_info_flags - mesh path information flags
1143 * Used by the driver to indicate which info in &struct mpath_info it has filled
1144 * in during get_station() or dump_station().
1146 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1147 * @MPATH_INFO_SN: @sn filled
1148 * @MPATH_INFO_METRIC: @metric filled
1149 * @MPATH_INFO_EXPTIME: @exptime filled
1150 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1151 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1152 * @MPATH_INFO_FLAGS: @flags filled
1154 enum mpath_info_flags {
1155 MPATH_INFO_FRAME_QLEN = BIT(0),
1156 MPATH_INFO_SN = BIT(1),
1157 MPATH_INFO_METRIC = BIT(2),
1158 MPATH_INFO_EXPTIME = BIT(3),
1159 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1160 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1161 MPATH_INFO_FLAGS = BIT(6),
1165 * struct mpath_info - mesh path information
1167 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1169 * @filled: bitfield of flags from &enum mpath_info_flags
1170 * @frame_qlen: number of queued frames for this destination
1171 * @sn: target sequence number
1172 * @metric: metric (cost) of this mesh path
1173 * @exptime: expiration time for the mesh path from now, in msecs
1174 * @flags: mesh path flags
1175 * @discovery_timeout: total mesh path discovery timeout, in msecs
1176 * @discovery_retries: mesh path discovery retries
1177 * @generation: generation number for nl80211 dumps.
1178 * This number should increase every time the list of mesh paths
1179 * changes, i.e. when a station is added or removed, so that
1180 * userspace can tell whether it got a consistent snapshot.
1188 u32 discovery_timeout;
1189 u8 discovery_retries;
1196 * struct bss_parameters - BSS parameters
1198 * Used to change BSS parameters (mainly for AP mode).
1200 * @use_cts_prot: Whether to use CTS protection
1201 * (0 = no, 1 = yes, -1 = do not change)
1202 * @use_short_preamble: Whether the use of short preambles is allowed
1203 * (0 = no, 1 = yes, -1 = do not change)
1204 * @use_short_slot_time: Whether the use of short slot time is allowed
1205 * (0 = no, 1 = yes, -1 = do not change)
1206 * @basic_rates: basic rates in IEEE 802.11 format
1207 * (or NULL for no change)
1208 * @basic_rates_len: number of basic rates
1209 * @ap_isolate: do not forward packets between connected stations
1210 * @ht_opmode: HT Operation mode
1211 * (u16 = opmode, -1 = do not change)
1212 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1213 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1215 struct bss_parameters {
1217 int use_short_preamble;
1218 int use_short_slot_time;
1219 const u8 *basic_rates;
1223 s8 p2p_ctwindow, p2p_opp_ps;
1227 * struct mesh_config - 802.11s mesh configuration
1229 * These parameters can be changed while the mesh is active.
1231 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1232 * by the Mesh Peering Open message
1233 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1234 * used by the Mesh Peering Open message
1235 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1236 * the mesh peering management to close a mesh peering
1237 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1239 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1240 * be sent to establish a new peer link instance in a mesh
1241 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1242 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1244 * @auto_open_plinks: whether we should automatically open peer links when we
1245 * detect compatible mesh peers
1246 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1247 * synchronize to for 11s default synchronization method
1248 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1249 * that an originator mesh STA can send to a particular path target
1250 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1251 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1252 * a path discovery in milliseconds
1253 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1254 * receiving a PREQ shall consider the forwarding information from the
1255 * root to be valid. (TU = time unit)
1256 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1257 * which a mesh STA can send only one action frame containing a PREQ
1259 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1260 * which a mesh STA can send only one Action frame containing a PERR
1262 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1263 * it takes for an HWMP information element to propagate across the mesh
1264 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1265 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1266 * announcements are transmitted
1267 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1268 * station has access to a broader network beyond the MBSS. (This is
1269 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1270 * only means that the station will announce others it's a mesh gate, but
1271 * not necessarily using the gate announcement protocol. Still keeping the
1272 * same nomenclature to be in sync with the spec)
1273 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1274 * entity (default is TRUE - forwarding entity)
1275 * @rssi_threshold: the threshold for average signal strength of candidate
1276 * station to establish a peer link
1277 * @ht_opmode: mesh HT protection mode
1279 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1280 * receiving a proactive PREQ shall consider the forwarding information to
1281 * the root mesh STA to be valid.
1283 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1284 * PREQs are transmitted.
1285 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1286 * during which a mesh STA can send only one Action frame containing
1287 * a PREQ element for root path confirmation.
1288 * @power_mode: The default mesh power save mode which will be the initial
1289 * setting for new peer links.
1290 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1291 * after transmitting its beacon.
1292 * @plink_timeout: If no tx activity is seen from a STA we've established
1293 * peering with for longer than this time (in seconds), then remove it
1294 * from the STA's list of peers. Default is 30 minutes.
1296 struct mesh_config {
1297 u16 dot11MeshRetryTimeout;
1298 u16 dot11MeshConfirmTimeout;
1299 u16 dot11MeshHoldingTimeout;
1300 u16 dot11MeshMaxPeerLinks;
1301 u8 dot11MeshMaxRetries;
1304 bool auto_open_plinks;
1305 u32 dot11MeshNbrOffsetMaxNeighbor;
1306 u8 dot11MeshHWMPmaxPREQretries;
1307 u32 path_refresh_time;
1308 u16 min_discovery_timeout;
1309 u32 dot11MeshHWMPactivePathTimeout;
1310 u16 dot11MeshHWMPpreqMinInterval;
1311 u16 dot11MeshHWMPperrMinInterval;
1312 u16 dot11MeshHWMPnetDiameterTraversalTime;
1313 u8 dot11MeshHWMPRootMode;
1314 u16 dot11MeshHWMPRannInterval;
1315 bool dot11MeshGateAnnouncementProtocol;
1316 bool dot11MeshForwarding;
1319 u32 dot11MeshHWMPactivePathToRootTimeout;
1320 u16 dot11MeshHWMProotInterval;
1321 u16 dot11MeshHWMPconfirmationInterval;
1322 enum nl80211_mesh_power_mode power_mode;
1323 u16 dot11MeshAwakeWindowDuration;
1328 * struct mesh_setup - 802.11s mesh setup configuration
1329 * @chandef: defines the channel to use
1330 * @mesh_id: the mesh ID
1331 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1332 * @sync_method: which synchronization method to use
1333 * @path_sel_proto: which path selection protocol to use
1334 * @path_metric: which metric to use
1335 * @auth_id: which authentication method this mesh is using
1336 * @ie: vendor information elements (optional)
1337 * @ie_len: length of vendor information elements
1338 * @is_authenticated: this mesh requires authentication
1339 * @is_secure: this mesh uses security
1340 * @user_mpm: userspace handles all MPM functions
1341 * @dtim_period: DTIM period to use
1342 * @beacon_interval: beacon interval to use
1343 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1344 * @basic_rates: basic rates to use when creating the mesh
1346 * These parameters are fixed when the mesh is created.
1349 struct cfg80211_chan_def chandef;
1358 bool is_authenticated;
1362 u16 beacon_interval;
1363 int mcast_rate[NUM_NL80211_BANDS];
1368 * struct ocb_setup - 802.11p OCB mode setup configuration
1369 * @chandef: defines the channel to use
1371 * These parameters are fixed when connecting to the network
1374 struct cfg80211_chan_def chandef;
1378 * struct ieee80211_txq_params - TX queue parameters
1379 * @ac: AC identifier
1380 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1381 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1383 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1385 * @aifs: Arbitration interframe space [0..255]
1387 struct ieee80211_txq_params {
1396 * DOC: Scanning and BSS list handling
1398 * The scanning process itself is fairly simple, but cfg80211 offers quite
1399 * a bit of helper functionality. To start a scan, the scan operation will
1400 * be invoked with a scan definition. This scan definition contains the
1401 * channels to scan, and the SSIDs to send probe requests for (including the
1402 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1403 * probe. Additionally, a scan request may contain extra information elements
1404 * that should be added to the probe request. The IEs are guaranteed to be
1405 * well-formed, and will not exceed the maximum length the driver advertised
1406 * in the wiphy structure.
1408 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1409 * it is responsible for maintaining the BSS list; the driver should not
1410 * maintain a list itself. For this notification, various functions exist.
1412 * Since drivers do not maintain a BSS list, there are also a number of
1413 * functions to search for a BSS and obtain information about it from the
1414 * BSS structure cfg80211 maintains. The BSS list is also made available
1419 * struct cfg80211_ssid - SSID description
1421 * @ssid_len: length of the ssid
1423 struct cfg80211_ssid {
1424 u8 ssid[IEEE80211_MAX_SSID_LEN];
1429 * struct cfg80211_scan_info - information about completed scan
1430 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1431 * wireless device that requested the scan is connected to. If this
1432 * information is not available, this field is left zero.
1433 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1434 * @aborted: set to true if the scan was aborted for any reason,
1435 * userspace will be notified of that
1437 struct cfg80211_scan_info {
1439 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1444 * struct cfg80211_scan_request - scan request description
1446 * @ssids: SSIDs to scan for (active scan only)
1447 * @n_ssids: number of SSIDs
1448 * @channels: channels to scan on.
1449 * @n_channels: total number of channels to scan
1450 * @scan_width: channel width for scanning
1451 * @ie: optional information element(s) to add into Probe Request or %NULL
1452 * @ie_len: length of ie in octets
1453 * @duration: how long to listen on each channel, in TUs. If
1454 * %duration_mandatory is not set, this is the maximum dwell time and
1455 * the actual dwell time may be shorter.
1456 * @duration_mandatory: if set, the scan duration must be as specified by the
1458 * @flags: bit field of flags controlling operation
1459 * @rates: bitmap of rates to advertise for each band
1460 * @wiphy: the wiphy this was for
1461 * @scan_start: time (in jiffies) when the scan started
1462 * @wdev: the wireless device to scan for
1463 * @info: (internal) information about completed scan
1464 * @notified: (internal) scan request was notified as done or aborted
1465 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1466 * @mac_addr: MAC address used with randomisation
1467 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1468 * are 0 in the mask should be randomised, bits that are 1 should
1469 * be taken from the @mac_addr
1470 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1472 struct cfg80211_scan_request {
1473 struct cfg80211_ssid *ssids;
1476 enum nl80211_bss_scan_width scan_width;
1480 bool duration_mandatory;
1483 u32 rates[NUM_NL80211_BANDS];
1485 struct wireless_dev *wdev;
1487 u8 mac_addr[ETH_ALEN] __aligned(2);
1488 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1489 u8 bssid[ETH_ALEN] __aligned(2);
1492 struct wiphy *wiphy;
1493 unsigned long scan_start;
1494 struct cfg80211_scan_info info;
1499 struct ieee80211_channel *channels[0];
1502 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1506 get_random_bytes(buf, ETH_ALEN);
1507 for (i = 0; i < ETH_ALEN; i++) {
1509 buf[i] |= addr[i] & mask[i];
1514 * struct cfg80211_match_set - sets of attributes to match
1516 * @ssid: SSID to be matched; may be zero-length for no match (RSSI only)
1517 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1519 struct cfg80211_match_set {
1520 struct cfg80211_ssid ssid;
1525 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1527 * @interval: interval between scheduled scan iterations. In seconds.
1528 * @iterations: number of scan iterations in this scan plan. Zero means
1530 * The last scan plan will always have this parameter set to zero,
1531 * all other scan plans will have a finite number of iterations.
1533 struct cfg80211_sched_scan_plan {
1539 * struct cfg80211_sched_scan_request - scheduled scan request description
1541 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1542 * @n_ssids: number of SSIDs
1543 * @n_channels: total number of channels to scan
1544 * @scan_width: channel width for scanning
1545 * @ie: optional information element(s) to add into Probe Request or %NULL
1546 * @ie_len: length of ie in octets
1547 * @flags: bit field of flags controlling operation
1548 * @match_sets: sets of parameters to be matched for a scan result
1549 * entry to be considered valid and to be passed to the host
1550 * (others are filtered out).
1551 * If ommited, all results are passed.
1552 * @n_match_sets: number of match sets
1553 * @wiphy: the wiphy this was for
1554 * @dev: the interface
1555 * @scan_start: start time of the scheduled scan
1556 * @channels: channels to scan
1557 * @min_rssi_thold: for drivers only supporting a single threshold, this
1558 * contains the minimum over all matchsets
1559 * @mac_addr: MAC address used with randomisation
1560 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1561 * are 0 in the mask should be randomised, bits that are 1 should
1562 * be taken from the @mac_addr
1563 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1564 * index must be executed first.
1565 * @n_scan_plans: number of scan plans, at least 1.
1566 * @rcu_head: RCU callback used to free the struct
1567 * @owner_nlportid: netlink portid of owner (if this should is a request
1568 * owned by a particular socket)
1569 * @delay: delay in seconds to use before starting the first scan
1570 * cycle. The driver may ignore this parameter and start
1571 * immediately (or at any other time), if this feature is not
1574 struct cfg80211_sched_scan_request {
1575 struct cfg80211_ssid *ssids;
1578 enum nl80211_bss_scan_width scan_width;
1582 struct cfg80211_match_set *match_sets;
1586 struct cfg80211_sched_scan_plan *scan_plans;
1589 u8 mac_addr[ETH_ALEN] __aligned(2);
1590 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1593 struct wiphy *wiphy;
1594 struct net_device *dev;
1595 unsigned long scan_start;
1596 struct rcu_head rcu_head;
1600 struct ieee80211_channel *channels[0];
1604 * enum cfg80211_signal_type - signal type
1606 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1607 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1608 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1610 enum cfg80211_signal_type {
1611 CFG80211_SIGNAL_TYPE_NONE,
1612 CFG80211_SIGNAL_TYPE_MBM,
1613 CFG80211_SIGNAL_TYPE_UNSPEC,
1617 * struct cfg80211_inform_bss - BSS inform data
1618 * @chan: channel the frame was received on
1619 * @scan_width: scan width that was used
1620 * @signal: signal strength value, according to the wiphy's
1622 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1623 * received; should match the time when the frame was actually
1624 * received by the device (not just by the host, in case it was
1625 * buffered on the device) and be accurate to about 10ms.
1626 * If the frame isn't buffered, just passing the return value of
1627 * ktime_get_boot_ns() is likely appropriate.
1628 * @parent_tsf: the time at the start of reception of the first octet of the
1629 * timestamp field of the frame. The time is the TSF of the BSS specified
1631 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1632 * the BSS that requested the scan in which the beacon/probe was received.
1634 struct cfg80211_inform_bss {
1635 struct ieee80211_channel *chan;
1636 enum nl80211_bss_scan_width scan_width;
1640 u8 parent_bssid[ETH_ALEN] __aligned(2);
1644 * struct cfg80211_bss_ies - BSS entry IE data
1645 * @tsf: TSF contained in the frame that carried these IEs
1646 * @rcu_head: internal use, for freeing
1647 * @len: length of the IEs
1648 * @from_beacon: these IEs are known to come from a beacon
1651 struct cfg80211_bss_ies {
1653 struct rcu_head rcu_head;
1660 * struct cfg80211_bss - BSS description
1662 * This structure describes a BSS (which may also be a mesh network)
1663 * for use in scan results and similar.
1665 * @channel: channel this BSS is on
1666 * @scan_width: width of the control channel
1667 * @bssid: BSSID of the BSS
1668 * @beacon_interval: the beacon interval as from the frame
1669 * @capability: the capability field in host byte order
1670 * @ies: the information elements (Note that there is no guarantee that these
1671 * are well-formed!); this is a pointer to either the beacon_ies or
1672 * proberesp_ies depending on whether Probe Response frame has been
1673 * received. It is always non-%NULL.
1674 * @beacon_ies: the information elements from the last Beacon frame
1675 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1676 * own the beacon_ies, but they're just pointers to the ones from the
1677 * @hidden_beacon_bss struct)
1678 * @proberesp_ies: the information elements from the last Probe Response frame
1679 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1680 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1681 * that holds the beacon data. @beacon_ies is still valid, of course, and
1682 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1683 * @signal: signal strength value (type depends on the wiphy's signal_type)
1684 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1686 struct cfg80211_bss {
1687 struct ieee80211_channel *channel;
1688 enum nl80211_bss_scan_width scan_width;
1690 const struct cfg80211_bss_ies __rcu *ies;
1691 const struct cfg80211_bss_ies __rcu *beacon_ies;
1692 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1694 struct cfg80211_bss *hidden_beacon_bss;
1698 u16 beacon_interval;
1703 u8 priv[0] __aligned(sizeof(void *));
1707 * ieee80211_bss_get_ie - find IE with given ID
1708 * @bss: the bss to search
1711 * Note that the return value is an RCU-protected pointer, so
1712 * rcu_read_lock() must be held when calling this function.
1713 * Return: %NULL if not found.
1715 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1719 * struct cfg80211_auth_request - Authentication request data
1721 * This structure provides information needed to complete IEEE 802.11
1724 * @bss: The BSS to authenticate with, the callee must obtain a reference
1725 * to it if it needs to keep it.
1726 * @auth_type: Authentication type (algorithm)
1727 * @ie: Extra IEs to add to Authentication frame or %NULL
1728 * @ie_len: Length of ie buffer in octets
1729 * @key_len: length of WEP key for shared key authentication
1730 * @key_idx: index of WEP key for shared key authentication
1731 * @key: WEP key for shared key authentication
1732 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1733 * Authentication transaction sequence number field.
1734 * @sae_data_len: Length of sae_data buffer in octets
1736 struct cfg80211_auth_request {
1737 struct cfg80211_bss *bss;
1740 enum nl80211_auth_type auth_type;
1742 u8 key_len, key_idx;
1744 size_t sae_data_len;
1748 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1750 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1751 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1752 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
1754 enum cfg80211_assoc_req_flags {
1755 ASSOC_REQ_DISABLE_HT = BIT(0),
1756 ASSOC_REQ_DISABLE_VHT = BIT(1),
1757 ASSOC_REQ_USE_RRM = BIT(2),
1761 * struct cfg80211_assoc_request - (Re)Association request data
1763 * This structure provides information needed to complete IEEE 802.11
1765 * @bss: The BSS to associate with. If the call is successful the driver is
1766 * given a reference that it must give back to cfg80211_send_rx_assoc()
1767 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1768 * association requests while already associating must be rejected.
1769 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1770 * @ie_len: Length of ie buffer in octets
1771 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1772 * @crypto: crypto settings
1773 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1774 * to indicate a request to reassociate within the ESS instead of a request
1775 * do the initial association with the ESS. When included, this is set to
1776 * the BSSID of the current association, i.e., to the value that is
1777 * included in the Current AP address field of the Reassociation Request
1779 * @flags: See &enum cfg80211_assoc_req_flags
1780 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1781 * will be used in ht_capa. Un-supported values will be ignored.
1782 * @ht_capa_mask: The bits of ht_capa which are to be used.
1783 * @vht_capa: VHT capability override
1784 * @vht_capa_mask: VHT capability mask indicating which fields to use
1786 struct cfg80211_assoc_request {
1787 struct cfg80211_bss *bss;
1788 const u8 *ie, *prev_bssid;
1790 struct cfg80211_crypto_settings crypto;
1793 struct ieee80211_ht_cap ht_capa;
1794 struct ieee80211_ht_cap ht_capa_mask;
1795 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1799 * struct cfg80211_deauth_request - Deauthentication request data
1801 * This structure provides information needed to complete IEEE 802.11
1804 * @bssid: the BSSID of the BSS to deauthenticate from
1805 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1806 * @ie_len: Length of ie buffer in octets
1807 * @reason_code: The reason code for the deauthentication
1808 * @local_state_change: if set, change local state only and
1809 * do not set a deauth frame
1811 struct cfg80211_deauth_request {
1816 bool local_state_change;
1820 * struct cfg80211_disassoc_request - Disassociation request data
1822 * This structure provides information needed to complete IEEE 802.11
1825 * @bss: the BSS to disassociate from
1826 * @ie: Extra IEs to add to Disassociation frame or %NULL
1827 * @ie_len: Length of ie buffer in octets
1828 * @reason_code: The reason code for the disassociation
1829 * @local_state_change: This is a request for a local state only, i.e., no
1830 * Disassociation frame is to be transmitted.
1832 struct cfg80211_disassoc_request {
1833 struct cfg80211_bss *bss;
1837 bool local_state_change;
1841 * struct cfg80211_ibss_params - IBSS parameters
1843 * This structure defines the IBSS parameters for the join_ibss()
1846 * @ssid: The SSID, will always be non-null.
1847 * @ssid_len: The length of the SSID, will always be non-zero.
1848 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1849 * search for IBSSs with a different BSSID.
1850 * @chandef: defines the channel to use if no other IBSS to join can be found
1851 * @channel_fixed: The channel should be fixed -- do not search for
1852 * IBSSs to join on other channels.
1853 * @ie: information element(s) to include in the beacon
1854 * @ie_len: length of that
1855 * @beacon_interval: beacon interval to use
1856 * @privacy: this is a protected network, keys will be configured
1858 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1859 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1860 * required to assume that the port is unauthorized until authorized by
1861 * user space. Otherwise, port is marked authorized by default.
1862 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1863 * changes the channel when a radar is detected. This is required
1864 * to operate on DFS channels.
1865 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1866 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1867 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1868 * will be used in ht_capa. Un-supported values will be ignored.
1869 * @ht_capa_mask: The bits of ht_capa which are to be used.
1871 struct cfg80211_ibss_params {
1874 struct cfg80211_chan_def chandef;
1876 u8 ssid_len, ie_len;
1877 u16 beacon_interval;
1882 bool userspace_handles_dfs;
1883 int mcast_rate[NUM_NL80211_BANDS];
1884 struct ieee80211_ht_cap ht_capa;
1885 struct ieee80211_ht_cap ht_capa_mask;
1889 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1891 * @band: band of BSS which should match for RSSI level adjustment.
1892 * @delta: value of RSSI level adjustment.
1894 struct cfg80211_bss_select_adjust {
1895 enum nl80211_band band;
1900 * struct cfg80211_bss_selection - connection parameters for BSS selection.
1902 * @behaviour: requested BSS selection behaviour.
1903 * @param: parameters for requestion behaviour.
1904 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
1905 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
1907 struct cfg80211_bss_selection {
1908 enum nl80211_bss_select_attr behaviour;
1910 enum nl80211_band band_pref;
1911 struct cfg80211_bss_select_adjust adjust;
1916 * struct cfg80211_connect_params - Connection parameters
1918 * This structure provides information needed to complete IEEE 802.11
1919 * authentication and association.
1921 * @channel: The channel to use or %NULL if not specified (auto-select based
1923 * @channel_hint: The channel of the recommended BSS for initial connection or
1924 * %NULL if not specified
1925 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1927 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
1928 * %NULL if not specified. Unlike the @bssid parameter, the driver is
1929 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
1932 * @ssid_len: Length of ssid in octets
1933 * @auth_type: Authentication type (algorithm)
1934 * @ie: IEs for association request
1935 * @ie_len: Length of assoc_ie in octets
1936 * @privacy: indicates whether privacy-enabled APs should be used
1937 * @mfp: indicate whether management frame protection is used
1938 * @crypto: crypto settings
1939 * @key_len: length of WEP key for shared key authentication
1940 * @key_idx: index of WEP key for shared key authentication
1941 * @key: WEP key for shared key authentication
1942 * @flags: See &enum cfg80211_assoc_req_flags
1943 * @bg_scan_period: Background scan period in seconds
1944 * or -1 to indicate that default value is to be used.
1945 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1946 * will be used in ht_capa. Un-supported values will be ignored.
1947 * @ht_capa_mask: The bits of ht_capa which are to be used.
1948 * @vht_capa: VHT Capability overrides
1949 * @vht_capa_mask: The bits of vht_capa which are to be used.
1950 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
1952 * @bss_select: criteria to be used for BSS selection.
1953 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1954 * to indicate a request to reassociate within the ESS instead of a request
1955 * do the initial association with the ESS. When included, this is set to
1956 * the BSSID of the current association, i.e., to the value that is
1957 * included in the Current AP address field of the Reassociation Request
1960 struct cfg80211_connect_params {
1961 struct ieee80211_channel *channel;
1962 struct ieee80211_channel *channel_hint;
1964 const u8 *bssid_hint;
1967 enum nl80211_auth_type auth_type;
1971 enum nl80211_mfp mfp;
1972 struct cfg80211_crypto_settings crypto;
1974 u8 key_len, key_idx;
1977 struct ieee80211_ht_cap ht_capa;
1978 struct ieee80211_ht_cap ht_capa_mask;
1979 struct ieee80211_vht_cap vht_capa;
1980 struct ieee80211_vht_cap vht_capa_mask;
1982 struct cfg80211_bss_selection bss_select;
1983 const u8 *prev_bssid;
1987 * enum wiphy_params_flags - set_wiphy_params bitfield values
1988 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1989 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1990 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1991 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1992 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1993 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
1995 enum wiphy_params_flags {
1996 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1997 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1998 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1999 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
2000 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
2001 WIPHY_PARAM_DYN_ACK = 1 << 5,
2005 * cfg80211_bitrate_mask - masks for bitrate control
2007 struct cfg80211_bitrate_mask {
2010 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
2011 u16 vht_mcs[NL80211_VHT_NSS_MAX];
2012 enum nl80211_txrate_gi gi;
2013 } control[NUM_NL80211_BANDS];
2016 * struct cfg80211_pmksa - PMK Security Association
2018 * This structure is passed to the set/del_pmksa() method for PMKSA
2021 * @bssid: The AP's BSSID.
2022 * @pmkid: The PMK material itself.
2024 struct cfg80211_pmksa {
2030 * struct cfg80211_pkt_pattern - packet pattern
2031 * @mask: bitmask where to match pattern and where to ignore bytes,
2032 * one bit per byte, in same format as nl80211
2033 * @pattern: bytes to match where bitmask is 1
2034 * @pattern_len: length of pattern (in bytes)
2035 * @pkt_offset: packet offset (in bytes)
2037 * Internal note: @mask and @pattern are allocated in one chunk of
2038 * memory, free @mask only!
2040 struct cfg80211_pkt_pattern {
2041 const u8 *mask, *pattern;
2047 * struct cfg80211_wowlan_tcp - TCP connection parameters
2049 * @sock: (internal) socket for source port allocation
2050 * @src: source IP address
2051 * @dst: destination IP address
2052 * @dst_mac: destination MAC address
2053 * @src_port: source port
2054 * @dst_port: destination port
2055 * @payload_len: data payload length
2056 * @payload: data payload buffer
2057 * @payload_seq: payload sequence stamping configuration
2058 * @data_interval: interval at which to send data packets
2059 * @wake_len: wakeup payload match length
2060 * @wake_data: wakeup payload match data
2061 * @wake_mask: wakeup payload match mask
2062 * @tokens_size: length of the tokens buffer
2063 * @payload_tok: payload token usage configuration
2065 struct cfg80211_wowlan_tcp {
2066 struct socket *sock;
2068 u16 src_port, dst_port;
2069 u8 dst_mac[ETH_ALEN];
2072 struct nl80211_wowlan_tcp_data_seq payload_seq;
2075 const u8 *wake_data, *wake_mask;
2077 /* must be last, variable member */
2078 struct nl80211_wowlan_tcp_data_token payload_tok;
2082 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2084 * This structure defines the enabled WoWLAN triggers for the device.
2085 * @any: wake up on any activity -- special trigger if device continues
2086 * operating as normal during suspend
2087 * @disconnect: wake up if getting disconnected
2088 * @magic_pkt: wake up on receiving magic packet
2089 * @patterns: wake up on receiving packet matching a pattern
2090 * @n_patterns: number of patterns
2091 * @gtk_rekey_failure: wake up on GTK rekey failure
2092 * @eap_identity_req: wake up on EAP identity request packet
2093 * @four_way_handshake: wake up on 4-way handshake
2094 * @rfkill_release: wake up when rfkill is released
2095 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2096 * NULL if not configured.
2097 * @nd_config: configuration for the scan to be used for net detect wake.
2099 struct cfg80211_wowlan {
2100 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2101 eap_identity_req, four_way_handshake,
2103 struct cfg80211_pkt_pattern *patterns;
2104 struct cfg80211_wowlan_tcp *tcp;
2106 struct cfg80211_sched_scan_request *nd_config;
2110 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2112 * This structure defines coalesce rule for the device.
2113 * @delay: maximum coalescing delay in msecs.
2114 * @condition: condition for packet coalescence.
2115 * see &enum nl80211_coalesce_condition.
2116 * @patterns: array of packet patterns
2117 * @n_patterns: number of patterns
2119 struct cfg80211_coalesce_rules {
2121 enum nl80211_coalesce_condition condition;
2122 struct cfg80211_pkt_pattern *patterns;
2127 * struct cfg80211_coalesce - Packet coalescing settings
2129 * This structure defines coalescing settings.
2130 * @rules: array of coalesce rules
2131 * @n_rules: number of rules
2133 struct cfg80211_coalesce {
2134 struct cfg80211_coalesce_rules *rules;
2139 * struct cfg80211_wowlan_nd_match - information about the match
2141 * @ssid: SSID of the match that triggered the wake up
2142 * @n_channels: Number of channels where the match occurred. This
2143 * value may be zero if the driver can't report the channels.
2144 * @channels: center frequencies of the channels where a match
2147 struct cfg80211_wowlan_nd_match {
2148 struct cfg80211_ssid ssid;
2154 * struct cfg80211_wowlan_nd_info - net detect wake up information
2156 * @n_matches: Number of match information instances provided in
2157 * @matches. This value may be zero if the driver can't provide
2158 * match information.
2159 * @matches: Array of pointers to matches containing information about
2160 * the matches that triggered the wake up.
2162 struct cfg80211_wowlan_nd_info {
2164 struct cfg80211_wowlan_nd_match *matches[];
2168 * struct cfg80211_wowlan_wakeup - wakeup report
2169 * @disconnect: woke up by getting disconnected
2170 * @magic_pkt: woke up by receiving magic packet
2171 * @gtk_rekey_failure: woke up by GTK rekey failure
2172 * @eap_identity_req: woke up by EAP identity request packet
2173 * @four_way_handshake: woke up by 4-way handshake
2174 * @rfkill_release: woke up by rfkill being released
2175 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2176 * @packet_present_len: copied wakeup packet data
2177 * @packet_len: original wakeup packet length
2178 * @packet: The packet causing the wakeup, if any.
2179 * @packet_80211: For pattern match, magic packet and other data
2180 * frame triggers an 802.3 frame should be reported, for
2181 * disconnect due to deauth 802.11 frame. This indicates which
2183 * @tcp_match: TCP wakeup packet received
2184 * @tcp_connlost: TCP connection lost or failed to establish
2185 * @tcp_nomoretokens: TCP data ran out of tokens
2186 * @net_detect: if not %NULL, woke up because of net detect
2188 struct cfg80211_wowlan_wakeup {
2189 bool disconnect, magic_pkt, gtk_rekey_failure,
2190 eap_identity_req, four_way_handshake,
2191 rfkill_release, packet_80211,
2192 tcp_match, tcp_connlost, tcp_nomoretokens;
2194 u32 packet_present_len, packet_len;
2196 struct cfg80211_wowlan_nd_info *net_detect;
2200 * struct cfg80211_gtk_rekey_data - rekey data
2201 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2202 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2203 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2205 struct cfg80211_gtk_rekey_data {
2206 const u8 *kek, *kck, *replay_ctr;
2210 * struct cfg80211_update_ft_ies_params - FT IE Information
2212 * This structure provides information needed to update the fast transition IE
2214 * @md: The Mobility Domain ID, 2 Octet value
2215 * @ie: Fast Transition IEs
2216 * @ie_len: Length of ft_ie in octets
2218 struct cfg80211_update_ft_ies_params {
2225 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2227 * This structure provides information needed to transmit a mgmt frame
2229 * @chan: channel to use
2230 * @offchan: indicates wether off channel operation is required
2231 * @wait: duration for ROC
2232 * @buf: buffer to transmit
2233 * @len: buffer length
2234 * @no_cck: don't use cck rates for this frame
2235 * @dont_wait_for_ack: tells the low level not to wait for an ack
2236 * @n_csa_offsets: length of csa_offsets array
2237 * @csa_offsets: array of all the csa offsets in the frame
2239 struct cfg80211_mgmt_tx_params {
2240 struct ieee80211_channel *chan;
2246 bool dont_wait_for_ack;
2248 const u16 *csa_offsets;
2252 * struct cfg80211_dscp_exception - DSCP exception
2254 * @dscp: DSCP value that does not adhere to the user priority range definition
2255 * @up: user priority value to which the corresponding DSCP value belongs
2257 struct cfg80211_dscp_exception {
2263 * struct cfg80211_dscp_range - DSCP range definition for user priority
2265 * @low: lowest DSCP value of this user priority range, inclusive
2266 * @high: highest DSCP value of this user priority range, inclusive
2268 struct cfg80211_dscp_range {
2273 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2274 #define IEEE80211_QOS_MAP_MAX_EX 21
2275 #define IEEE80211_QOS_MAP_LEN_MIN 16
2276 #define IEEE80211_QOS_MAP_LEN_MAX \
2277 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2280 * struct cfg80211_qos_map - QoS Map Information
2282 * This struct defines the Interworking QoS map setting for DSCP values
2284 * @num_des: number of DSCP exceptions (0..21)
2285 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2286 * the user priority DSCP range definition
2287 * @up: DSCP range definition for a particular user priority
2289 struct cfg80211_qos_map {
2291 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2292 struct cfg80211_dscp_range up[8];
2296 * struct cfg80211_ops - backend description for wireless configuration
2298 * This struct is registered by fullmac card drivers and/or wireless stacks
2299 * in order to handle configuration requests on their interfaces.
2301 * All callbacks except where otherwise noted should return 0
2302 * on success or a negative error code.
2304 * All operations are currently invoked under rtnl for consistency with the
2305 * wireless extensions but this is subject to reevaluation as soon as this
2306 * code is used more widely and we have a first user without wext.
2308 * @suspend: wiphy device needs to be suspended. The variable @wow will
2309 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2310 * configured for the device.
2311 * @resume: wiphy device needs to be resumed
2312 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2313 * to call device_set_wakeup_enable() to enable/disable wakeup from
2316 * @add_virtual_intf: create a new virtual interface with the given name,
2317 * must set the struct wireless_dev's iftype. Beware: You must create
2318 * the new netdev in the wiphy's network namespace! Returns the struct
2319 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2320 * also set the address member in the wdev.
2322 * @del_virtual_intf: remove the virtual interface
2324 * @change_virtual_intf: change type/configuration of virtual interface,
2325 * keep the struct wireless_dev's iftype updated.
2327 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2328 * when adding a group key.
2330 * @get_key: get information about the key with the given parameters.
2331 * @mac_addr will be %NULL when requesting information for a group
2332 * key. All pointers given to the @callback function need not be valid
2333 * after it returns. This function should return an error if it is
2334 * not possible to retrieve the key, -ENOENT if it doesn't exist.
2336 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
2337 * and @key_index, return -ENOENT if the key doesn't exist.
2339 * @set_default_key: set the default key on an interface
2341 * @set_default_mgmt_key: set the default management frame key on an interface
2343 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2345 * @start_ap: Start acting in AP mode defined by the parameters.
2346 * @change_beacon: Change the beacon parameters for an access point mode
2347 * interface. This should reject the call when AP mode wasn't started.
2348 * @stop_ap: Stop being an AP, including stopping beaconing.
2350 * @add_station: Add a new station.
2351 * @del_station: Remove a station
2352 * @change_station: Modify a given station. Note that flags changes are not much
2353 * validated in cfg80211, in particular the auth/assoc/authorized flags
2354 * might come to the driver in invalid combinations -- make sure to check
2355 * them, also against the existing state! Drivers must call
2356 * cfg80211_check_station_change() to validate the information.
2357 * @get_station: get station information for the station identified by @mac
2358 * @dump_station: dump station callback -- resume dump at index @idx
2360 * @add_mpath: add a fixed mesh path
2361 * @del_mpath: delete a given mesh path
2362 * @change_mpath: change a given mesh path
2363 * @get_mpath: get a mesh path for the given parameters
2364 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
2365 * @get_mpp: get a mesh proxy path for the given parameters
2366 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
2367 * @join_mesh: join the mesh network with the specified parameters
2368 * (invoked with the wireless_dev mutex held)
2369 * @leave_mesh: leave the current mesh network
2370 * (invoked with the wireless_dev mutex held)
2372 * @get_mesh_config: Get the current mesh configuration
2374 * @update_mesh_config: Update mesh parameters on a running mesh.
2375 * The mask is a bitfield which tells us which parameters to
2376 * set, and which to leave alone.
2378 * @change_bss: Modify parameters for a given BSS.
2380 * @set_txq_params: Set TX queue parameters
2382 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2383 * as it doesn't implement join_mesh and needs to set the channel to
2384 * join the mesh instead.
2386 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2387 * interfaces are active this callback should reject the configuration.
2388 * If no interfaces are active or the device is down, the channel should
2389 * be stored for when a monitor interface becomes active.
2391 * @scan: Request to do a scan. If returning zero, the scan request is given
2392 * the driver, and will be valid until passed to cfg80211_scan_done().
2393 * For scan results, call cfg80211_inform_bss(); you can call this outside
2394 * the scan/scan_done bracket too.
2395 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2396 * indicate the status of the scan through cfg80211_scan_done().
2398 * @auth: Request to authenticate with the specified peer
2399 * (invoked with the wireless_dev mutex held)
2400 * @assoc: Request to (re)associate with the specified peer
2401 * (invoked with the wireless_dev mutex held)
2402 * @deauth: Request to deauthenticate from the specified peer
2403 * (invoked with the wireless_dev mutex held)
2404 * @disassoc: Request to disassociate from the specified peer
2405 * (invoked with the wireless_dev mutex held)
2407 * @connect: Connect to the ESS with the specified parameters. When connected,
2408 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2409 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2410 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2411 * from the AP or cfg80211_connect_timeout() if no frame with status code
2413 * The driver is allowed to roam to other BSSes within the ESS when the
2414 * other BSS matches the connect parameters. When such roaming is initiated
2415 * by the driver, the driver is expected to verify that the target matches
2416 * the configured security parameters and to use Reassociation Request
2417 * frame instead of Association Request frame.
2418 * The connect function can also be used to request the driver to perform a
2419 * specific roam when connected to an ESS. In that case, the prev_bssid
2420 * parameter is set to the BSSID of the currently associated BSS as an
2421 * indication of requesting reassociation.
2422 * In both the driver-initiated and new connect() call initiated roaming
2423 * cases, the result of roaming is indicated with a call to
2424 * cfg80211_roamed() or cfg80211_roamed_bss().
2425 * (invoked with the wireless_dev mutex held)
2426 * @disconnect: Disconnect from the BSS/ESS. Once done, call
2427 * cfg80211_disconnected().
2428 * (invoked with the wireless_dev mutex held)
2430 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2431 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2433 * (invoked with the wireless_dev mutex held)
2434 * @leave_ibss: Leave the IBSS.
2435 * (invoked with the wireless_dev mutex held)
2437 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2440 * @set_wiphy_params: Notify that wiphy parameters have changed;
2441 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2442 * have changed. The actual parameter values are available in
2443 * struct wiphy. If returning an error, no value should be changed.
2445 * @set_tx_power: set the transmit power according to the parameters,
2446 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2447 * wdev may be %NULL if power was set for the wiphy, and will
2448 * always be %NULL unless the driver supports per-vif TX power
2449 * (as advertised by the nl80211 feature flag.)
2450 * @get_tx_power: store the current TX power into the dbm variable;
2451 * return 0 if successful
2453 * @set_wds_peer: set the WDS peer for a WDS interface
2455 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2456 * functions to adjust rfkill hw state
2458 * @dump_survey: get site survey information.
2460 * @remain_on_channel: Request the driver to remain awake on the specified
2461 * channel for the specified duration to complete an off-channel
2462 * operation (e.g., public action frame exchange). When the driver is
2463 * ready on the requested channel, it must indicate this with an event
2464 * notification by calling cfg80211_ready_on_channel().
2465 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2466 * This allows the operation to be terminated prior to timeout based on
2467 * the duration value.
2468 * @mgmt_tx: Transmit a management frame.
2469 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2470 * frame on another channel
2472 * @testmode_cmd: run a test mode command; @wdev may be %NULL
2473 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2474 * used by the function, but 0 and 1 must not be touched. Additionally,
2475 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2476 * dump and return to userspace with an error, so be careful. If any data
2477 * was passed in from userspace then the data/len arguments will be present
2478 * and point to the data contained in %NL80211_ATTR_TESTDATA.
2480 * @set_bitrate_mask: set the bitrate mask configuration
2482 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2483 * devices running firmwares capable of generating the (re) association
2484 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2485 * @del_pmksa: Delete a cached PMKID.
2486 * @flush_pmksa: Flush all cached PMKIDs.
2487 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2488 * allows the driver to adjust the dynamic ps timeout value.
2489 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
2490 * After configuration, the driver should (soon) send an event indicating
2491 * the current level is above/below the configured threshold; this may
2492 * need some care when the configuration is changed (without first being
2494 * @set_cqm_txe_config: Configure connection quality monitor TX error
2496 * @sched_scan_start: Tell the driver to start a scheduled scan.
2497 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan. This
2498 * call must stop the scheduled scan and be ready for starting a new one
2499 * before it returns, i.e. @sched_scan_start may be called immediately
2500 * after that again and should not fail in that case. The driver should
2501 * not call cfg80211_sched_scan_stopped() for a requested stop (when this
2502 * method returns 0.)
2504 * @mgmt_frame_register: Notify driver that a management frame type was
2505 * registered. The callback is allowed to sleep.
2507 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2508 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2509 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2510 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2512 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2514 * @tdls_mgmt: Transmit a TDLS management frame.
2515 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
2517 * @probe_client: probe an associated client, must return a cookie that it
2518 * later passes to cfg80211_probe_status().
2520 * @set_noack_map: Set the NoAck Map for the TIDs.
2522 * @get_channel: Get the current operating channel for the virtual interface.
2523 * For monitor interfaces, it should return %NULL unless there's a single
2524 * current monitoring channel.
2526 * @start_p2p_device: Start the given P2P device.
2527 * @stop_p2p_device: Stop the given P2P device.
2529 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2530 * Parameters include ACL policy, an array of MAC address of stations
2531 * and the number of MAC addresses. If there is already a list in driver
2532 * this new list replaces the existing one. Driver has to clear its ACL
2533 * when number of MAC addresses entries is passed as 0. Drivers which
2534 * advertise the support for MAC based ACL have to implement this callback.
2536 * @start_radar_detection: Start radar detection in the driver.
2538 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2539 * driver. If the SME is in the driver/firmware, this information can be
2540 * used in building Authentication and Reassociation Request frames.
2542 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2543 * for a given duration (milliseconds). The protocol is provided so the
2544 * driver can take the most appropriate actions.
2545 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2546 * reliability. This operation can not fail.
2547 * @set_coalesce: Set coalesce parameters.
2549 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2550 * responsible for veryfing if the switch is possible. Since this is
2551 * inherently tricky driver may decide to disconnect an interface later
2552 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2553 * everything. It should do it's best to verify requests and reject them
2554 * as soon as possible.
2556 * @set_qos_map: Set QoS mapping information to the driver
2558 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2559 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2560 * changes during the lifetime of the BSS.
2562 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2563 * with the given parameters; action frame exchange has been handled by
2564 * userspace so this just has to modify the TX path to take the TS into
2566 * If the admitted time is 0 just validate the parameters to make sure
2567 * the session can be created at all; it is valid to just always return
2568 * success for that but that may result in inefficient behaviour (handshake
2569 * with the peer followed by immediate teardown when the addition is later
2571 * @del_tx_ts: remove an existing TX TS
2573 * @join_ocb: join the OCB network with the specified parameters
2574 * (invoked with the wireless_dev mutex held)
2575 * @leave_ocb: leave the current OCB network
2576 * (invoked with the wireless_dev mutex held)
2578 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2579 * is responsible for continually initiating channel-switching operations
2580 * and returning to the base channel for communication with the AP.
2581 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2582 * peers must be on the base channel when the call completes.
2584 struct cfg80211_ops {
2585 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
2586 int (*resume)(struct wiphy *wiphy);
2587 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
2589 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
2591 unsigned char name_assign_type,
2592 enum nl80211_iftype type,
2594 struct vif_params *params);
2595 int (*del_virtual_intf)(struct wiphy *wiphy,
2596 struct wireless_dev *wdev);
2597 int (*change_virtual_intf)(struct wiphy *wiphy,
2598 struct net_device *dev,
2599 enum nl80211_iftype type, u32 *flags,
2600 struct vif_params *params);
2602 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2603 u8 key_index, bool pairwise, const u8 *mac_addr,
2604 struct key_params *params);
2605 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2606 u8 key_index, bool pairwise, const u8 *mac_addr,
2608 void (*callback)(void *cookie, struct key_params*));
2609 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2610 u8 key_index, bool pairwise, const u8 *mac_addr);
2611 int (*set_default_key)(struct wiphy *wiphy,
2612 struct net_device *netdev,
2613 u8 key_index, bool unicast, bool multicast);
2614 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2615 struct net_device *netdev,
2618 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2619 struct cfg80211_ap_settings *settings);
2620 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2621 struct cfg80211_beacon_data *info);
2622 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2625 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2627 struct station_parameters *params);
2628 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2629 struct station_del_parameters *params);
2630 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2632 struct station_parameters *params);
2633 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2634 const u8 *mac, struct station_info *sinfo);
2635 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2636 int idx, u8 *mac, struct station_info *sinfo);
2638 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2639 const u8 *dst, const u8 *next_hop);
2640 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2642 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2643 const u8 *dst, const u8 *next_hop);
2644 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2645 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
2646 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2647 int idx, u8 *dst, u8 *next_hop,
2648 struct mpath_info *pinfo);
2649 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
2650 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
2651 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
2652 int idx, u8 *dst, u8 *mpp,
2653 struct mpath_info *pinfo);
2654 int (*get_mesh_config)(struct wiphy *wiphy,
2655 struct net_device *dev,
2656 struct mesh_config *conf);
2657 int (*update_mesh_config)(struct wiphy *wiphy,
2658 struct net_device *dev, u32 mask,
2659 const struct mesh_config *nconf);
2660 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2661 const struct mesh_config *conf,
2662 const struct mesh_setup *setup);
2663 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2665 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
2666 struct ocb_setup *setup);
2667 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
2669 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2670 struct bss_parameters *params);
2672 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2673 struct ieee80211_txq_params *params);
2675 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2676 struct net_device *dev,
2677 struct ieee80211_channel *chan);
2679 int (*set_monitor_channel)(struct wiphy *wiphy,
2680 struct cfg80211_chan_def *chandef);
2682 int (*scan)(struct wiphy *wiphy,
2683 struct cfg80211_scan_request *request);
2684 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
2686 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2687 struct cfg80211_auth_request *req);
2688 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2689 struct cfg80211_assoc_request *req);
2690 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2691 struct cfg80211_deauth_request *req);
2692 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2693 struct cfg80211_disassoc_request *req);
2695 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2696 struct cfg80211_connect_params *sme);
2697 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2700 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2701 struct cfg80211_ibss_params *params);
2702 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2704 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2705 int rate[NUM_NL80211_BANDS]);
2707 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2709 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2710 enum nl80211_tx_power_setting type, int mbm);
2711 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2714 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2717 void (*rfkill_poll)(struct wiphy *wiphy);
2719 #ifdef CONFIG_NL80211_TESTMODE
2720 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
2721 void *data, int len);
2722 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2723 struct netlink_callback *cb,
2724 void *data, int len);
2727 int (*set_bitrate_mask)(struct wiphy *wiphy,
2728 struct net_device *dev,
2730 const struct cfg80211_bitrate_mask *mask);
2732 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2733 int idx, struct survey_info *info);
2735 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2736 struct cfg80211_pmksa *pmksa);
2737 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2738 struct cfg80211_pmksa *pmksa);
2739 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2741 int (*remain_on_channel)(struct wiphy *wiphy,
2742 struct wireless_dev *wdev,
2743 struct ieee80211_channel *chan,
2744 unsigned int duration,
2746 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2747 struct wireless_dev *wdev,
2750 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2751 struct cfg80211_mgmt_tx_params *params,
2753 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2754 struct wireless_dev *wdev,
2757 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2758 bool enabled, int timeout);
2760 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2761 struct net_device *dev,
2762 s32 rssi_thold, u32 rssi_hyst);
2764 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2765 struct net_device *dev,
2766 u32 rate, u32 pkts, u32 intvl);
2768 void (*mgmt_frame_register)(struct wiphy *wiphy,
2769 struct wireless_dev *wdev,
2770 u16 frame_type, bool reg);
2772 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2773 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2775 int (*sched_scan_start)(struct wiphy *wiphy,
2776 struct net_device *dev,
2777 struct cfg80211_sched_scan_request *request);
2778 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2780 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2781 struct cfg80211_gtk_rekey_data *data);
2783 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2784 const u8 *peer, u8 action_code, u8 dialog_token,
2785 u16 status_code, u32 peer_capability,
2786 bool initiator, const u8 *buf, size_t len);
2787 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2788 const u8 *peer, enum nl80211_tdls_operation oper);
2790 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2791 const u8 *peer, u64 *cookie);
2793 int (*set_noack_map)(struct wiphy *wiphy,
2794 struct net_device *dev,
2797 int (*get_channel)(struct wiphy *wiphy,
2798 struct wireless_dev *wdev,
2799 struct cfg80211_chan_def *chandef);
2801 int (*start_p2p_device)(struct wiphy *wiphy,
2802 struct wireless_dev *wdev);
2803 void (*stop_p2p_device)(struct wiphy *wiphy,
2804 struct wireless_dev *wdev);
2806 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2807 const struct cfg80211_acl_data *params);
2809 int (*start_radar_detection)(struct wiphy *wiphy,
2810 struct net_device *dev,
2811 struct cfg80211_chan_def *chandef,
2813 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
2814 struct cfg80211_update_ft_ies_params *ftie);
2815 int (*crit_proto_start)(struct wiphy *wiphy,
2816 struct wireless_dev *wdev,
2817 enum nl80211_crit_proto_id protocol,
2819 void (*crit_proto_stop)(struct wiphy *wiphy,
2820 struct wireless_dev *wdev);
2821 int (*set_coalesce)(struct wiphy *wiphy,
2822 struct cfg80211_coalesce *coalesce);
2824 int (*channel_switch)(struct wiphy *wiphy,
2825 struct net_device *dev,
2826 struct cfg80211_csa_settings *params);
2828 int (*set_qos_map)(struct wiphy *wiphy,
2829 struct net_device *dev,
2830 struct cfg80211_qos_map *qos_map);
2832 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
2833 struct cfg80211_chan_def *chandef);
2835 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2836 u8 tsid, const u8 *peer, u8 user_prio,
2838 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
2839 u8 tsid, const u8 *peer);
2841 int (*tdls_channel_switch)(struct wiphy *wiphy,
2842 struct net_device *dev,
2843 const u8 *addr, u8 oper_class,
2844 struct cfg80211_chan_def *chandef);
2845 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
2846 struct net_device *dev,
2851 * wireless hardware and networking interfaces structures
2852 * and registration/helper functions
2856 * enum wiphy_flags - wiphy capability flags
2858 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2860 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2861 * by default -- this flag will be set depending on the kernel's default
2862 * on wiphy_new(), but can be changed by the driver if it has a good
2863 * reason to override the default
2864 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2865 * on a VLAN interface)
2866 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2867 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2868 * control port protocol ethertype. The device also honours the
2869 * control_port_no_encrypt flag.
2870 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2871 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2872 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2873 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2874 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2876 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2877 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2878 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2879 * link setup/discovery operations internally. Setup, discovery and
2880 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2881 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2882 * used for asking the driver/firmware to perform a TDLS operation.
2883 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2884 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2885 * when there are virtual interfaces in AP mode by calling
2886 * cfg80211_report_obss_beacon().
2887 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2888 * responds to probe-requests in hardware.
2889 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2890 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2891 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
2892 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
2893 * beaconing mode (AP, IBSS, Mesh, ...).
2899 WIPHY_FLAG_NETNS_OK = BIT(3),
2900 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2901 WIPHY_FLAG_4ADDR_AP = BIT(5),
2902 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2903 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2904 WIPHY_FLAG_IBSS_RSN = BIT(8),
2905 WIPHY_FLAG_MESH_AUTH = BIT(10),
2906 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2907 /* use hole at 12 */
2908 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2909 WIPHY_FLAG_AP_UAPSD = BIT(14),
2910 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2911 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2912 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2913 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2914 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2915 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2916 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2917 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
2918 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
2922 * struct ieee80211_iface_limit - limit on certain interface types
2923 * @max: maximum number of interfaces of these types
2924 * @types: interface types (bits)
2926 struct ieee80211_iface_limit {
2932 * struct ieee80211_iface_combination - possible interface combination
2933 * @limits: limits for the given interface types
2934 * @n_limits: number of limitations
2935 * @num_different_channels: can use up to this many different channels
2936 * @max_interfaces: maximum number of interfaces in total allowed in this
2938 * @beacon_int_infra_match: In this combination, the beacon intervals
2939 * between infrastructure and AP types must match. This is required
2940 * only in special cases.
2941 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2942 * @radar_detect_regions: bitmap of regions supported for radar detection
2944 * With this structure the driver can describe which interface
2945 * combinations it supports concurrently.
2949 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2951 * struct ieee80211_iface_limit limits1[] = {
2952 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2953 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2955 * struct ieee80211_iface_combination combination1 = {
2956 * .limits = limits1,
2957 * .n_limits = ARRAY_SIZE(limits1),
2958 * .max_interfaces = 2,
2959 * .beacon_int_infra_match = true,
2963 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2965 * struct ieee80211_iface_limit limits2[] = {
2966 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2967 * BIT(NL80211_IFTYPE_P2P_GO), },
2969 * struct ieee80211_iface_combination combination2 = {
2970 * .limits = limits2,
2971 * .n_limits = ARRAY_SIZE(limits2),
2972 * .max_interfaces = 8,
2973 * .num_different_channels = 1,
2977 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2979 * This allows for an infrastructure connection and three P2P connections.
2981 * struct ieee80211_iface_limit limits3[] = {
2982 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2983 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2984 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2986 * struct ieee80211_iface_combination combination3 = {
2987 * .limits = limits3,
2988 * .n_limits = ARRAY_SIZE(limits3),
2989 * .max_interfaces = 4,
2990 * .num_different_channels = 2,
2993 struct ieee80211_iface_combination {
2994 const struct ieee80211_iface_limit *limits;
2995 u32 num_different_channels;
2998 bool beacon_int_infra_match;
2999 u8 radar_detect_widths;
3000 u8 radar_detect_regions;
3003 struct ieee80211_txrx_stypes {
3008 * enum wiphy_wowlan_support_flags - WoWLAN support flags
3009 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3010 * trigger that keeps the device operating as-is and
3011 * wakes up the host on any activity, for example a
3012 * received packet that passed filtering; note that the
3013 * packet should be preserved in that case
3014 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3016 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
3017 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3018 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3019 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3020 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3021 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
3022 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
3024 enum wiphy_wowlan_support_flags {
3025 WIPHY_WOWLAN_ANY = BIT(0),
3026 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
3027 WIPHY_WOWLAN_DISCONNECT = BIT(2),
3028 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
3029 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
3030 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
3031 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
3032 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
3033 WIPHY_WOWLAN_NET_DETECT = BIT(8),
3036 struct wiphy_wowlan_tcp_support {
3037 const struct nl80211_wowlan_tcp_data_token_feature *tok;
3038 u32 data_payload_max;
3039 u32 data_interval_max;
3040 u32 wake_payload_max;
3045 * struct wiphy_wowlan_support - WoWLAN support data
3046 * @flags: see &enum wiphy_wowlan_support_flags
3047 * @n_patterns: number of supported wakeup patterns
3048 * (see nl80211.h for the pattern definition)
3049 * @pattern_max_len: maximum length of each pattern
3050 * @pattern_min_len: minimum length of each pattern
3051 * @max_pkt_offset: maximum Rx packet offset
3052 * @max_nd_match_sets: maximum number of matchsets for net-detect,
3053 * similar, but not necessarily identical, to max_match_sets for
3055 * See &struct cfg80211_sched_scan_request.@match_sets for more
3057 * @tcp: TCP wakeup support information
3059 struct wiphy_wowlan_support {
3062 int pattern_max_len;
3063 int pattern_min_len;
3065 int max_nd_match_sets;
3066 const struct wiphy_wowlan_tcp_support *tcp;
3070 * struct wiphy_coalesce_support - coalesce support data
3071 * @n_rules: maximum number of coalesce rules
3072 * @max_delay: maximum supported coalescing delay in msecs
3073 * @n_patterns: number of supported patterns in a rule
3074 * (see nl80211.h for the pattern definition)
3075 * @pattern_max_len: maximum length of each pattern
3076 * @pattern_min_len: minimum length of each pattern
3077 * @max_pkt_offset: maximum Rx packet offset
3079 struct wiphy_coalesce_support {
3083 int pattern_max_len;
3084 int pattern_min_len;
3089 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3090 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3091 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3092 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3093 * (must be combined with %_WDEV or %_NETDEV)
3095 enum wiphy_vendor_command_flags {
3096 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3097 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3098 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3102 * struct wiphy_vendor_command - vendor command definition
3103 * @info: vendor command identifying information, as used in nl80211
3104 * @flags: flags, see &enum wiphy_vendor_command_flags
3105 * @doit: callback for the operation, note that wdev is %NULL if the
3106 * flags didn't ask for a wdev and non-%NULL otherwise; the data
3107 * pointer may be %NULL if userspace provided no data at all
3108 * @dumpit: dump callback, for transferring bigger/multiple items. The
3109 * @storage points to cb->args[5], ie. is preserved over the multiple
3111 * It's recommended to not have the same sub command with both @doit and
3112 * @dumpit, so that userspace can assume certain ones are get and others
3113 * are used with dump requests.
3115 struct wiphy_vendor_command {
3116 struct nl80211_vendor_cmd_info info;
3118 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3119 const void *data, int data_len);
3120 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3121 struct sk_buff *skb, const void *data, int data_len,
3122 unsigned long *storage);
3126 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3127 * @iftype: interface type
3128 * @extended_capabilities: extended capabilities supported by the driver,
3129 * additional capabilities might be supported by userspace; these are the
3130 * 802.11 extended capabilities ("Extended Capabilities element") and are
3131 * in the same format as in the information element. See IEEE Std
3132 * 802.11-2012 8.4.2.29 for the defined fields.
3133 * @extended_capabilities_mask: mask of the valid values
3134 * @extended_capabilities_len: length of the extended capabilities
3136 struct wiphy_iftype_ext_capab {
3137 enum nl80211_iftype iftype;
3138 const u8 *extended_capabilities;
3139 const u8 *extended_capabilities_mask;
3140 u8 extended_capabilities_len;
3144 * struct wiphy - wireless hardware description
3145 * @reg_notifier: the driver's regulatory notification callback,
3146 * note that if your driver uses wiphy_apply_custom_regulatory()
3147 * the reg_notifier's request can be passed as NULL
3148 * @regd: the driver's regulatory domain, if one was requested via
3149 * the regulatory_hint() API. This can be used by the driver
3150 * on the reg_notifier() if it chooses to ignore future
3151 * regulatory domain changes caused by other drivers.
3152 * @signal_type: signal type reported in &struct cfg80211_bss.
3153 * @cipher_suites: supported cipher suites
3154 * @n_cipher_suites: number of supported cipher suites
3155 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3156 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3157 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3158 * -1 = fragmentation disabled, only odd values >= 256 used
3159 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
3160 * @_net: the network namespace this wiphy currently lives in
3161 * @perm_addr: permanent MAC address of this device
3162 * @addr_mask: If the device supports multiple MAC addresses by masking,
3163 * set this to a mask with variable bits set to 1, e.g. if the last
3164 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
3165 * variable bits shall be determined by the interfaces added, with
3166 * interfaces not matching the mask being rejected to be brought up.
3167 * @n_addresses: number of addresses in @addresses.
3168 * @addresses: If the device has more than one address, set this pointer
3169 * to a list of addresses (6 bytes each). The first one will be used
3170 * by default for perm_addr. In this case, the mask should be set to
3171 * all-zeroes. In this case it is assumed that the device can handle
3172 * the same number of arbitrary MAC addresses.
3173 * @registered: protects ->resume and ->suspend sysfs callbacks against
3174 * unregister hardware
3175 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3176 * automatically on wiphy renames
3177 * @dev: (virtual) struct device for this wiphy
3178 * @registered: helps synchronize suspend/resume with wiphy unregister
3179 * @wext: wireless extension handlers
3180 * @priv: driver private data (sized according to wiphy_new() parameter)
3181 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3182 * must be set by driver
3183 * @iface_combinations: Valid interface combinations array, should not
3184 * list single interface types.
3185 * @n_iface_combinations: number of entries in @iface_combinations array.
3186 * @software_iftypes: bitmask of software interface types, these are not
3187 * subject to any restrictions since they are purely managed in SW.
3188 * @flags: wiphy flags, see &enum wiphy_flags
3189 * @regulatory_flags: wiphy regulatory flags, see
3190 * &enum ieee80211_regulatory_flags
3191 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
3192 * @ext_features: extended features advertised to nl80211, see
3193 * &enum nl80211_ext_feature_index.
3194 * @bss_priv_size: each BSS struct has private data allocated with it,
3195 * this variable determines its size
3196 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3198 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3199 * for in any given scheduled scan
3200 * @max_match_sets: maximum number of match sets the device can handle
3201 * when performing a scheduled scan, 0 if filtering is not
3203 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3204 * add to probe request frames transmitted during a scan, must not
3205 * include fixed IEs like supported rates
3206 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3208 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3209 * of iterations) for scheduled scan supported by the device.
3210 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3211 * single scan plan supported by the device.
3212 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3213 * scan plan supported by the device.
3214 * @coverage_class: current coverage class
3215 * @fw_version: firmware version for ethtool reporting
3216 * @hw_version: hardware version for ethtool reporting
3217 * @max_num_pmkids: maximum number of PMKIDs supported by device
3218 * @privid: a pointer that drivers can use to identify if an arbitrary
3219 * wiphy is theirs, e.g. in global notifiers
3220 * @bands: information about bands/channels supported by this device
3222 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3223 * transmitted through nl80211, points to an array indexed by interface
3226 * @available_antennas_tx: bitmap of antennas which are available to be
3227 * configured as TX antennas. Antenna configuration commands will be
3228 * rejected unless this or @available_antennas_rx is set.
3230 * @available_antennas_rx: bitmap of antennas which are available to be
3231 * configured as RX antennas. Antenna configuration commands will be
3232 * rejected unless this or @available_antennas_tx is set.
3234 * @probe_resp_offload:
3235 * Bitmap of supported protocols for probe response offloading.
3236 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3237 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3239 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3240 * may request, if implemented.
3242 * @wowlan: WoWLAN support information
3243 * @wowlan_config: current WoWLAN configuration; this should usually not be
3244 * used since access to it is necessarily racy, use the parameter passed
3245 * to the suspend() operation instead.
3247 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
3248 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3249 * If null, then none can be over-ridden.
3250 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3251 * If null, then none can be over-ridden.
3253 * @wdev_list: the list of associated (virtual) interfaces; this list must
3254 * not be modified by the driver, but can be read with RTNL/RCU protection.
3256 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3259 * @extended_capabilities: extended capabilities supported by the driver,
3260 * additional capabilities might be supported by userspace; these are
3261 * the 802.11 extended capabilities ("Extended Capabilities element")
3262 * and are in the same format as in the information element. See
3263 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
3264 * extended capabilities to be used if the capabilities are not specified
3265 * for a specific interface type in iftype_ext_capab.
3266 * @extended_capabilities_mask: mask of the valid values
3267 * @extended_capabilities_len: length of the extended capabilities
3268 * @iftype_ext_capab: array of extended capabilities per interface type
3269 * @num_iftype_ext_capab: number of interface types for which extended
3270 * capabilities are specified separately.
3271 * @coalesce: packet coalescing support information
3273 * @vendor_commands: array of vendor commands supported by the hardware
3274 * @n_vendor_commands: number of vendor commands
3275 * @vendor_events: array of vendor events supported by the hardware
3276 * @n_vendor_events: number of vendor events
3278 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3279 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3280 * driver is allowed to advertise a theoretical limit that it can reach in
3281 * some cases, but may not always reach.
3283 * @max_num_csa_counters: Number of supported csa_counters in beacons
3284 * and probe responses. This value should be set if the driver
3285 * wishes to limit the number of csa counters. Default (0) means
3287 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3288 * frame was sent and the channel on which the frame was heard for which
3289 * the reported rssi is still valid. If a driver is able to compensate the
3290 * low rssi when a frame is heard on different channel, then it should set
3291 * this variable to the maximal offset for which it can compensate.
3292 * This value should be set in MHz.
3293 * @bss_select_support: bitmask indicating the BSS selection criteria supported
3294 * by the driver in the .connect() callback. The bit position maps to the
3295 * attribute indices defined in &enum nl80211_bss_select_attr.
3298 /* assign these fields before you register the wiphy */
3300 /* permanent MAC address(es) */
3301 u8 perm_addr[ETH_ALEN];
3302 u8 addr_mask[ETH_ALEN];
3304 struct mac_address *addresses;
3306 const struct ieee80211_txrx_stypes *mgmt_stypes;
3308 const struct ieee80211_iface_combination *iface_combinations;
3309 int n_iface_combinations;
3310 u16 software_iftypes;
3314 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3315 u16 interface_modes;
3317 u16 max_acl_mac_addrs;
3319 u32 flags, regulatory_flags, features;
3320 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
3324 enum cfg80211_signal_type signal_type;
3328 u8 max_sched_scan_ssids;
3330 u16 max_scan_ie_len;
3331 u16 max_sched_scan_ie_len;
3332 u32 max_sched_scan_plans;
3333 u32 max_sched_scan_plan_interval;
3334 u32 max_sched_scan_plan_iterations;
3336 int n_cipher_suites;
3337 const u32 *cipher_suites;
3345 char fw_version[ETHTOOL_FWVERS_LEN];
3349 const struct wiphy_wowlan_support *wowlan;
3350 struct cfg80211_wowlan *wowlan_config;
3353 u16 max_remain_on_channel_duration;
3357 u32 available_antennas_tx;
3358 u32 available_antennas_rx;
3361 * Bitmap of supported protocols for probe response offloading
3362 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3363 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3365 u32 probe_resp_offload;
3367 const u8 *extended_capabilities, *extended_capabilities_mask;
3368 u8 extended_capabilities_len;
3370 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
3371 unsigned int num_iftype_ext_capab;
3373 /* If multiple wiphys are registered and you're handed e.g.
3374 * a regular netdev with assigned ieee80211_ptr, you won't
3375 * know whether it points to a wiphy your driver has registered
3376 * or not. Assign this to something global to your driver to
3377 * help determine whether you own this wiphy or not. */
3380 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
3382 /* Lets us get back the wiphy on the callback */
3383 void (*reg_notifier)(struct wiphy *wiphy,
3384 struct regulatory_request *request);
3386 /* fields below are read-only, assigned by cfg80211 */
3388 const struct ieee80211_regdomain __rcu *regd;
3390 /* the item in /sys/class/ieee80211/ points to this,
3391 * you need use set_wiphy_dev() (see below) */
3394 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3397 /* dir in debugfs: ieee80211/<wiphyname> */
3398 struct dentry *debugfsdir;
3400 const struct ieee80211_ht_cap *ht_capa_mod_mask;
3401 const struct ieee80211_vht_cap *vht_capa_mod_mask;
3403 struct list_head wdev_list;
3405 /* the network namespace this phy lives in currently */
3406 possible_net_t _net;
3408 #ifdef CONFIG_CFG80211_WEXT
3409 const struct iw_handler_def *wext;
3412 const struct wiphy_coalesce_support *coalesce;
3414 const struct wiphy_vendor_command *vendor_commands;
3415 const struct nl80211_vendor_cmd_info *vendor_events;
3416 int n_vendor_commands, n_vendor_events;
3418 u16 max_ap_assoc_sta;
3420 u8 max_num_csa_counters;
3421 u8 max_adj_channel_rssi_comp;
3423 u32 bss_select_support;
3425 char priv[0] __aligned(NETDEV_ALIGN);
3428 static inline struct net *wiphy_net(struct wiphy *wiphy)
3430 return read_pnet(&wiphy->_net);
3433 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
3435 write_pnet(&wiphy->_net, net);
3439 * wiphy_priv - return priv from wiphy
3441 * @wiphy: the wiphy whose priv pointer to return
3442 * Return: The priv of @wiphy.
3444 static inline void *wiphy_priv(struct wiphy *wiphy)
3447 return &wiphy->priv;
3451 * priv_to_wiphy - return the wiphy containing the priv
3453 * @priv: a pointer previously returned by wiphy_priv
3454 * Return: The wiphy of @priv.
3456 static inline struct wiphy *priv_to_wiphy(void *priv)
3459 return container_of(priv, struct wiphy, priv);
3463 * set_wiphy_dev - set device pointer for wiphy
3465 * @wiphy: The wiphy whose device to bind
3466 * @dev: The device to parent it to
3468 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
3470 wiphy->dev.parent = dev;
3474 * wiphy_dev - get wiphy dev pointer
3476 * @wiphy: The wiphy whose device struct to look up
3477 * Return: The dev of @wiphy.
3479 static inline struct device *wiphy_dev(struct wiphy *wiphy)
3481 return wiphy->dev.parent;
3485 * wiphy_name - get wiphy name
3487 * @wiphy: The wiphy whose name to return
3488 * Return: The name of @wiphy.
3490 static inline const char *wiphy_name(const struct wiphy *wiphy)
3492 return dev_name(&wiphy->dev);
3496 * wiphy_new_nm - create a new wiphy for use with cfg80211
3498 * @ops: The configuration operations for this device
3499 * @sizeof_priv: The size of the private area to allocate
3500 * @requested_name: Request a particular name.
3501 * NULL is valid value, and means use the default phy%d naming.
3503 * Create a new wiphy and associate the given operations with it.
3504 * @sizeof_priv bytes are allocated for private use.
3506 * Return: A pointer to the new wiphy. This pointer must be
3507 * assigned to each netdev's ieee80211_ptr for proper operation.
3509 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
3510 const char *requested_name);
3513 * wiphy_new - create a new wiphy for use with cfg80211
3515 * @ops: The configuration operations for this device
3516 * @sizeof_priv: The size of the private area to allocate
3518 * Create a new wiphy and associate the given operations with it.
3519 * @sizeof_priv bytes are allocated for private use.
3521 * Return: A pointer to the new wiphy. This pointer must be
3522 * assigned to each netdev's ieee80211_ptr for proper operation.
3524 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
3527 return wiphy_new_nm(ops, sizeof_priv, NULL);
3531 * wiphy_register - register a wiphy with cfg80211
3533 * @wiphy: The wiphy to register.
3535 * Return: A non-negative wiphy index or a negative error code.
3537 int wiphy_register(struct wiphy *wiphy);
3540 * wiphy_unregister - deregister a wiphy from cfg80211
3542 * @wiphy: The wiphy to unregister.
3544 * After this call, no more requests can be made with this priv
3545 * pointer, but the call may sleep to wait for an outstanding
3546 * request that is being handled.
3548 void wiphy_unregister(struct wiphy *wiphy);
3551 * wiphy_free - free wiphy
3553 * @wiphy: The wiphy to free
3555 void wiphy_free(struct wiphy *wiphy);
3557 /* internal structs */
3558 struct cfg80211_conn;
3559 struct cfg80211_internal_bss;
3560 struct cfg80211_cached_keys;
3563 * struct wireless_dev - wireless device state
3565 * For netdevs, this structure must be allocated by the driver
3566 * that uses the ieee80211_ptr field in struct net_device (this
3567 * is intentional so it can be allocated along with the netdev.)
3568 * It need not be registered then as netdev registration will
3569 * be intercepted by cfg80211 to see the new wireless device.
3571 * For non-netdev uses, it must also be allocated by the driver
3572 * in response to the cfg80211 callbacks that require it, as
3573 * there's no netdev registration in that case it may not be
3574 * allocated outside of callback operations that return it.
3576 * @wiphy: pointer to hardware description
3577 * @iftype: interface type
3578 * @list: (private) Used to collect the interfaces
3579 * @netdev: (private) Used to reference back to the netdev, may be %NULL
3580 * @identifier: (private) Identifier used in nl80211 to identify this
3581 * wireless device if it has no netdev
3582 * @current_bss: (private) Used by the internal configuration code
3583 * @chandef: (private) Used by the internal configuration code to track
3584 * the user-set channel definition.
3585 * @preset_chandef: (private) Used by the internal configuration code to
3586 * track the channel to be used for AP later
3587 * @bssid: (private) Used by the internal configuration code
3588 * @ssid: (private) Used by the internal configuration code
3589 * @ssid_len: (private) Used by the internal configuration code
3590 * @mesh_id_len: (private) Used by the internal configuration code
3591 * @mesh_id_up_len: (private) Used by the internal configuration code
3592 * @wext: (private) Used by the internal wireless extensions compat code
3593 * @use_4addr: indicates 4addr mode is used on this interface, must be
3594 * set by driver (if supported) on add_interface BEFORE registering the
3595 * netdev and may otherwise be used by driver read-only, will be update
3596 * by cfg80211 on change_interface
3597 * @mgmt_registrations: list of registrations for management frames
3598 * @mgmt_registrations_lock: lock for the list
3599 * @mtx: mutex used to lock data in this struct, may be used by drivers
3600 * and some API functions require it held
3601 * @beacon_interval: beacon interval used on this device for transmitting
3602 * beacons, 0 when not valid
3603 * @address: The address for this device, valid only if @netdev is %NULL
3604 * @p2p_started: true if this is a P2P Device that has been started
3605 * @cac_started: true if DFS channel availability check has been started
3606 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
3607 * @cac_time_ms: CAC time in ms
3608 * @ps: powersave mode is enabled
3609 * @ps_timeout: dynamic powersave timeout
3610 * @ap_unexpected_nlportid: (private) netlink port ID of application
3611 * registered for unexpected class 3 frames (AP mode)
3612 * @conn: (private) cfg80211 software SME connection state machine data
3613 * @connect_keys: (private) keys to set after connection is established
3614 * @conn_bss_type: connecting/connected BSS type
3615 * @ibss_fixed: (private) IBSS is using fixed BSSID
3616 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
3617 * @event_list: (private) list for internal event processing
3618 * @event_lock: (private) lock for event list
3619 * @owner_nlportid: (private) owner socket port ID
3621 struct wireless_dev {
3622 struct wiphy *wiphy;
3623 enum nl80211_iftype iftype;
3625 /* the remainder of this struct should be private to cfg80211 */
3626 struct list_head list;
3627 struct net_device *netdev;
3631 struct list_head mgmt_registrations;
3632 spinlock_t mgmt_registrations_lock;
3636 bool use_4addr, p2p_started;
3638 u8 address[ETH_ALEN] __aligned(sizeof(u16));
3640 /* currently used for IBSS and SME - might be rearranged later */
3641 u8 ssid[IEEE80211_MAX_SSID_LEN];
3642 u8 ssid_len, mesh_id_len, mesh_id_up_len;
3643 struct cfg80211_conn *conn;
3644 struct cfg80211_cached_keys *connect_keys;
3645 enum ieee80211_bss_type conn_bss_type;
3647 struct list_head event_list;
3648 spinlock_t event_lock;
3650 struct cfg80211_internal_bss *current_bss; /* associated / joined */
3651 struct cfg80211_chan_def preset_chandef;
3652 struct cfg80211_chan_def chandef;
3655 bool ibss_dfs_possible;
3660 int beacon_interval;
3662 u32 ap_unexpected_nlportid;
3665 unsigned long cac_start_time;
3666 unsigned int cac_time_ms;
3670 #ifdef CONFIG_CFG80211_WEXT
3673 struct cfg80211_ibss_params ibss;
3674 struct cfg80211_connect_params connect;
3675 struct cfg80211_cached_keys *keys;
3678 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
3679 u8 ssid[IEEE80211_MAX_SSID_LEN];
3680 s8 default_key, default_mgmt_key;
3681 bool prev_bssid_valid;
3686 static inline u8 *wdev_address(struct wireless_dev *wdev)
3689 return wdev->netdev->dev_addr;
3690 return wdev->address;
3694 * wdev_priv - return wiphy priv from wireless_dev
3696 * @wdev: The wireless device whose wiphy's priv pointer to return
3697 * Return: The wiphy priv of @wdev.
3699 static inline void *wdev_priv(struct wireless_dev *wdev)
3702 return wiphy_priv(wdev->wiphy);
3706 * DOC: Utility functions
3708 * cfg80211 offers a number of utility functions that can be useful.
3712 * ieee80211_channel_to_frequency - convert channel number to frequency
3713 * @chan: channel number
3714 * @band: band, necessary due to channel number overlap
3715 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
3717 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
3720 * ieee80211_frequency_to_channel - convert frequency to channel number
3721 * @freq: center frequency
3722 * Return: The corresponding channel, or 0 if the conversion failed.
3724 int ieee80211_frequency_to_channel(int freq);
3727 * Name indirection necessary because the ieee80211 code also has
3728 * a function named "ieee80211_get_channel", so if you include
3729 * cfg80211's header file you get cfg80211's version, if you try
3730 * to include both header files you'll (rightfully!) get a symbol
3733 struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
3736 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
3737 * @wiphy: the struct wiphy to get the channel for
3738 * @freq: the center frequency of the channel
3739 * Return: The channel struct from @wiphy at @freq.
3741 static inline struct ieee80211_channel *
3742 ieee80211_get_channel(struct wiphy *wiphy, int freq)
3744 return __ieee80211_get_channel(wiphy, freq);
3748 * ieee80211_get_response_rate - get basic rate for a given rate
3750 * @sband: the band to look for rates in
3751 * @basic_rates: bitmap of basic rates
3752 * @bitrate: the bitrate for which to find the basic rate
3754 * Return: The basic rate corresponding to a given bitrate, that
3755 * is the next lower bitrate contained in the basic rate map,
3756 * which is, for this function, given as a bitmap of indices of
3757 * rates in the band's bitrate table.
3759 struct ieee80211_rate *
3760 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
3761 u32 basic_rates, int bitrate);
3764 * ieee80211_mandatory_rates - get mandatory rates for a given band
3765 * @sband: the band to look for rates in
3766 * @scan_width: width of the control channel
3768 * This function returns a bitmap of the mandatory rates for the given
3769 * band, bits are set according to the rate position in the bitrates array.
3771 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
3772 enum nl80211_bss_scan_width scan_width);
3775 * Radiotap parsing functions -- for controlled injection support
3777 * Implemented in net/wireless/radiotap.c
3778 * Documentation in Documentation/networking/radiotap-headers.txt
3781 struct radiotap_align_size {
3782 uint8_t align:4, size:4;
3785 struct ieee80211_radiotap_namespace {
3786 const struct radiotap_align_size *align_size;
3792 struct ieee80211_radiotap_vendor_namespaces {
3793 const struct ieee80211_radiotap_namespace *ns;
3798 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
3799 * @this_arg_index: index of current arg, valid after each successful call
3800 * to ieee80211_radiotap_iterator_next()
3801 * @this_arg: pointer to current radiotap arg; it is valid after each
3802 * call to ieee80211_radiotap_iterator_next() but also after
3803 * ieee80211_radiotap_iterator_init() where it will point to
3804 * the beginning of the actual data portion
3805 * @this_arg_size: length of the current arg, for convenience
3806 * @current_namespace: pointer to the current namespace definition
3807 * (or internally %NULL if the current namespace is unknown)
3808 * @is_radiotap_ns: indicates whether the current namespace is the default
3809 * radiotap namespace or not
3811 * @_rtheader: pointer to the radiotap header we are walking through
3812 * @_max_length: length of radiotap header in cpu byte ordering
3813 * @_arg_index: next argument index
3814 * @_arg: next argument pointer
3815 * @_next_bitmap: internal pointer to next present u32
3816 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3817 * @_vns: vendor namespace definitions
3818 * @_next_ns_data: beginning of the next namespace's data
3819 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3822 * Describes the radiotap parser state. Fields prefixed with an underscore
3823 * must not be used by users of the parser, only by the parser internally.
3826 struct ieee80211_radiotap_iterator {
3827 struct ieee80211_radiotap_header *_rtheader;
3828 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3829 const struct ieee80211_radiotap_namespace *current_namespace;
3831 unsigned char *_arg, *_next_ns_data;
3832 __le32 *_next_bitmap;
3834 unsigned char *this_arg;
3842 uint32_t _bitmap_shifter;
3847 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
3848 struct ieee80211_radiotap_header *radiotap_header,
3850 const struct ieee80211_radiotap_vendor_namespaces *vns);
3853 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
3856 extern const unsigned char rfc1042_header[6];
3857 extern const unsigned char bridge_tunnel_header[6];
3860 * ieee80211_get_hdrlen_from_skb - get header length from data
3864 * Given an skb with a raw 802.11 header at the data pointer this function
3865 * returns the 802.11 header length.
3867 * Return: The 802.11 header length in bytes (not including encryption
3868 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3871 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3874 * ieee80211_hdrlen - get header length in bytes from frame control
3875 * @fc: frame control field in little-endian format
3876 * Return: The header length in bytes.
3878 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3881 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3882 * @meshhdr: the mesh extension header, only the flags field
3883 * (first byte) will be accessed
3884 * Return: The length of the extension header, which is always at
3885 * least 6 bytes and at most 18 if address 5 and 6 are present.
3887 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3890 * DOC: Data path helpers
3892 * In addition to generic utilities, cfg80211 also offers
3893 * functions that help implement the data path for devices
3894 * that do not do the 802.11/802.3 conversion on the device.
3898 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3899 * @skb: the 802.11 data frame
3900 * @addr: the device MAC address
3901 * @iftype: the virtual interface type
3902 * Return: 0 on success. Non-zero on error.
3904 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3905 enum nl80211_iftype iftype);
3908 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3909 * @skb: the 802.3 frame
3910 * @addr: the device MAC address
3911 * @iftype: the virtual interface type
3912 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3913 * @qos: build 802.11 QoS data frame
3914 * Return: 0 on success, or a negative error code.
3916 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3917 enum nl80211_iftype iftype, const u8 *bssid,
3921 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3923 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3924 * 802.3 frames. The @list will be empty if the decode fails. The
3925 * @skb is consumed after the function returns.
3927 * @skb: The input IEEE 802.11n A-MSDU frame.
3928 * @list: The output list of 802.3 frames. It must be allocated and
3929 * initialized by by the caller.
3930 * @addr: The device MAC address.
3931 * @iftype: The device interface type.
3932 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3933 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3935 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3936 const u8 *addr, enum nl80211_iftype iftype,
3937 const unsigned int extra_headroom,
3938 bool has_80211_header);
3941 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3942 * @skb: the data frame
3943 * @qos_map: Interworking QoS mapping or %NULL if not in use
3944 * Return: The 802.1p/1d tag.
3946 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
3947 struct cfg80211_qos_map *qos_map);
3950 * cfg80211_find_ie - find information element in data
3953 * @ies: data consisting of IEs
3954 * @len: length of data
3956 * Return: %NULL if the element ID could not be found or if
3957 * the element is invalid (claims to be longer than the given
3958 * data), or a pointer to the first byte of the requested
3959 * element, that is the byte containing the element ID.
3961 * Note: There are no checks on the element length other than
3962 * having to fit into the given data.
3964 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3967 * cfg80211_find_vendor_ie - find vendor specific information element in data
3970 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
3971 * @ies: data consisting of IEs
3972 * @len: length of data
3974 * Return: %NULL if the vendor specific element ID could not be found or if the
3975 * element is invalid (claims to be longer than the given data), or a pointer to
3976 * the first byte of the requested element, that is the byte containing the
3979 * Note: There are no checks on the element length other than having to fit into
3982 const u8 *cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
3983 const u8 *ies, int len);
3986 * DOC: Regulatory enforcement infrastructure
3992 * regulatory_hint - driver hint to the wireless core a regulatory domain
3993 * @wiphy: the wireless device giving the hint (used only for reporting
3995 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3996 * should be in. If @rd is set this should be NULL. Note that if you
3997 * set this to NULL you should still set rd->alpha2 to some accepted
4000 * Wireless drivers can use this function to hint to the wireless core
4001 * what it believes should be the current regulatory domain by
4002 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4003 * domain should be in or by providing a completely build regulatory domain.
4004 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4005 * for a regulatory domain structure for the respective country.
4007 * The wiphy must have been registered to cfg80211 prior to this call.
4008 * For cfg80211 drivers this means you must first use wiphy_register(),
4009 * for mac80211 drivers you must first use ieee80211_register_hw().
4011 * Drivers should check the return value, its possible you can get
4014 * Return: 0 on success. -ENOMEM.
4016 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
4019 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4020 * @wiphy: the wireless device we want to process the regulatory domain on
4021 * @rd: the regulatory domain informatoin to use for this wiphy
4023 * Set the regulatory domain information for self-managed wiphys, only they
4024 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4027 * Return: 0 on success. -EINVAL, -EPERM
4029 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
4030 struct ieee80211_regdomain *rd);
4033 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4034 * @wiphy: the wireless device we want to process the regulatory domain on
4035 * @rd: the regulatory domain information to use for this wiphy
4037 * This functions requires the RTNL to be held and applies the new regdomain
4038 * synchronously to this wiphy. For more details see
4039 * regulatory_set_wiphy_regd().
4041 * Return: 0 on success. -EINVAL, -EPERM
4043 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
4044 struct ieee80211_regdomain *rd);
4047 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4048 * @wiphy: the wireless device we want to process the regulatory domain on
4049 * @regd: the custom regulatory domain to use for this wiphy
4051 * Drivers can sometimes have custom regulatory domains which do not apply
4052 * to a specific country. Drivers can use this to apply such custom regulatory
4053 * domains. This routine must be called prior to wiphy registration. The
4054 * custom regulatory domain will be trusted completely and as such previous
4055 * default channel settings will be disregarded. If no rule is found for a
4056 * channel on the regulatory domain the channel will be disabled.
4057 * Drivers using this for a wiphy should also set the wiphy flag
4058 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
4059 * that called this helper.
4061 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
4062 const struct ieee80211_regdomain *regd);
4065 * freq_reg_info - get regulatory information for the given frequency
4066 * @wiphy: the wiphy for which we want to process this rule for
4067 * @center_freq: Frequency in KHz for which we want regulatory information for
4069 * Use this function to get the regulatory rule for a specific frequency on
4070 * a given wireless device. If the device has a specific regulatory domain
4071 * it wants to follow we respect that unless a country IE has been received
4072 * and processed already.
4074 * Return: A valid pointer, or, when an error occurs, for example if no rule
4075 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4076 * check and PTR_ERR() to obtain the numeric return value. The numeric return
4077 * value will be -ERANGE if we determine the given center_freq does not even
4078 * have a regulatory rule for a frequency range in the center_freq's band.
4079 * See freq_in_rule_band() for our current definition of a band -- this is
4080 * purely subjective and right now it's 802.11 specific.
4082 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
4086 * reg_initiator_name - map regulatory request initiator enum to name
4087 * @initiator: the regulatory request initiator
4089 * You can use this to map the regulatory request initiator enum to a
4090 * proper string representation.
4092 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
4095 * callbacks for asynchronous cfg80211 methods, notification
4096 * functions and BSS handling helpers
4100 * cfg80211_scan_done - notify that scan finished
4102 * @request: the corresponding scan request
4103 * @info: information about the completed scan
4105 void cfg80211_scan_done(struct cfg80211_scan_request *request,
4106 struct cfg80211_scan_info *info);
4109 * cfg80211_sched_scan_results - notify that new scan results are available
4111 * @wiphy: the wiphy which got scheduled scan results
4113 void cfg80211_sched_scan_results(struct wiphy *wiphy);
4116 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4118 * @wiphy: the wiphy on which the scheduled scan stopped
4120 * The driver can call this function to inform cfg80211 that the
4121 * scheduled scan had to be stopped, for whatever reason. The driver
4122 * is then called back via the sched_scan_stop operation when done.
4124 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
4127 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4129 * @wiphy: the wiphy on which the scheduled scan stopped
4131 * The driver can call this function to inform cfg80211 that the
4132 * scheduled scan had to be stopped, for whatever reason. The driver
4133 * is then called back via the sched_scan_stop operation when done.
4134 * This function should be called with rtnl locked.
4136 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy);
4139 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
4140 * @wiphy: the wiphy reporting the BSS
4141 * @data: the BSS metadata
4142 * @mgmt: the management frame (probe response or beacon)
4143 * @len: length of the management frame
4144 * @gfp: context flags
4146 * This informs cfg80211 that BSS information was found and
4147 * the BSS should be updated/added.
4149 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4150 * Or %NULL on error.
4152 struct cfg80211_bss * __must_check
4153 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4154 struct cfg80211_inform_bss *data,
4155 struct ieee80211_mgmt *mgmt, size_t len,
4158 static inline struct cfg80211_bss * __must_check
4159 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
4160 struct ieee80211_channel *rx_channel,
4161 enum nl80211_bss_scan_width scan_width,
4162 struct ieee80211_mgmt *mgmt, size_t len,
4163 s32 signal, gfp_t gfp)
4165 struct cfg80211_inform_bss data = {
4167 .scan_width = scan_width,
4171 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4174 static inline struct cfg80211_bss * __must_check
4175 cfg80211_inform_bss_frame(struct wiphy *wiphy,
4176 struct ieee80211_channel *rx_channel,
4177 struct ieee80211_mgmt *mgmt, size_t len,
4178 s32 signal, gfp_t gfp)
4180 struct cfg80211_inform_bss data = {
4182 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4186 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4190 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4191 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4192 * from a beacon or probe response
4193 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4194 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4196 enum cfg80211_bss_frame_type {
4197 CFG80211_BSS_FTYPE_UNKNOWN,
4198 CFG80211_BSS_FTYPE_BEACON,
4199 CFG80211_BSS_FTYPE_PRESP,
4203 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
4205 * @wiphy: the wiphy reporting the BSS
4206 * @data: the BSS metadata
4207 * @ftype: frame type (if known)
4208 * @bssid: the BSSID of the BSS
4209 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
4210 * @capability: the capability field sent by the peer
4211 * @beacon_interval: the beacon interval announced by the peer
4212 * @ie: additional IEs sent by the peer
4213 * @ielen: length of the additional IEs
4214 * @gfp: context flags
4216 * This informs cfg80211 that BSS information was found and
4217 * the BSS should be updated/added.
4219 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4220 * Or %NULL on error.
4222 struct cfg80211_bss * __must_check
4223 cfg80211_inform_bss_data(struct wiphy *wiphy,
4224 struct cfg80211_inform_bss *data,
4225 enum cfg80211_bss_frame_type ftype,
4226 const u8 *bssid, u64 tsf, u16 capability,
4227 u16 beacon_interval, const u8 *ie, size_t ielen,
4230 static inline struct cfg80211_bss * __must_check
4231 cfg80211_inform_bss_width(struct wiphy *wiphy,
4232 struct ieee80211_channel *rx_channel,
4233 enum nl80211_bss_scan_width scan_width,
4234 enum cfg80211_bss_frame_type ftype,
4235 const u8 *bssid, u64 tsf, u16 capability,
4236 u16 beacon_interval, const u8 *ie, size_t ielen,
4237 s32 signal, gfp_t gfp)
4239 struct cfg80211_inform_bss data = {
4241 .scan_width = scan_width,
4245 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4246 capability, beacon_interval, ie, ielen,
4250 static inline struct cfg80211_bss * __must_check
4251 cfg80211_inform_bss(struct wiphy *wiphy,
4252 struct ieee80211_channel *rx_channel,
4253 enum cfg80211_bss_frame_type ftype,
4254 const u8 *bssid, u64 tsf, u16 capability,
4255 u16 beacon_interval, const u8 *ie, size_t ielen,
4256 s32 signal, gfp_t gfp)
4258 struct cfg80211_inform_bss data = {
4260 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4264 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4265 capability, beacon_interval, ie, ielen,
4269 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4270 struct ieee80211_channel *channel,
4272 const u8 *ssid, size_t ssid_len,
4273 enum ieee80211_bss_type bss_type,
4274 enum ieee80211_privacy);
4275 static inline struct cfg80211_bss *
4276 cfg80211_get_ibss(struct wiphy *wiphy,
4277 struct ieee80211_channel *channel,
4278 const u8 *ssid, size_t ssid_len)
4280 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
4281 IEEE80211_BSS_TYPE_IBSS,
4282 IEEE80211_PRIVACY_ANY);
4286 * cfg80211_ref_bss - reference BSS struct
4287 * @wiphy: the wiphy this BSS struct belongs to
4288 * @bss: the BSS struct to reference
4290 * Increments the refcount of the given BSS struct.
4292 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4295 * cfg80211_put_bss - unref BSS struct
4296 * @wiphy: the wiphy this BSS struct belongs to
4297 * @bss: the BSS struct
4299 * Decrements the refcount of the given BSS struct.
4301 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4304 * cfg80211_unlink_bss - unlink BSS from internal data structures
4306 * @bss: the bss to remove
4308 * This function removes the given BSS from the internal data structures
4309 * thereby making it no longer show up in scan results etc. Use this
4310 * function when you detect a BSS is gone. Normally BSSes will also time
4311 * out, so it is not necessary to use this function at all.
4313 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
4315 static inline enum nl80211_bss_scan_width
4316 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
4318 switch (chandef->width) {
4319 case NL80211_CHAN_WIDTH_5:
4320 return NL80211_BSS_CHAN_WIDTH_5;
4321 case NL80211_CHAN_WIDTH_10:
4322 return NL80211_BSS_CHAN_WIDTH_10;
4324 return NL80211_BSS_CHAN_WIDTH_20;
4329 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
4330 * @dev: network device
4331 * @buf: authentication frame (header + body)
4332 * @len: length of the frame data
4334 * This function is called whenever an authentication, disassociation or
4335 * deauthentication frame has been received and processed in station mode.
4336 * After being asked to authenticate via cfg80211_ops::auth() the driver must
4337 * call either this function or cfg80211_auth_timeout().
4338 * After being asked to associate via cfg80211_ops::assoc() the driver must
4339 * call either this function or cfg80211_auth_timeout().
4340 * While connected, the driver must calls this for received and processed
4341 * disassociation and deauthentication frames. If the frame couldn't be used
4342 * because it was unprotected, the driver must call the function
4343 * cfg80211_rx_unprot_mlme_mgmt() instead.
4345 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4347 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4350 * cfg80211_auth_timeout - notification of timed out authentication
4351 * @dev: network device
4352 * @addr: The MAC address of the device with which the authentication timed out
4354 * This function may sleep. The caller must hold the corresponding wdev's
4357 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
4360 * cfg80211_rx_assoc_resp - notification of processed association response
4361 * @dev: network device
4362 * @bss: the BSS that association was requested with, ownership of the pointer
4363 * moves to cfg80211 in this call
4364 * @buf: authentication frame (header + body)
4365 * @len: length of the frame data
4366 * @uapsd_queues: bitmap of ACs configured to uapsd. -1 if n/a.
4368 * After being asked to associate via cfg80211_ops::assoc() the driver must
4369 * call either this function or cfg80211_auth_timeout().
4371 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4373 void cfg80211_rx_assoc_resp(struct net_device *dev,
4374 struct cfg80211_bss *bss,
4375 const u8 *buf, size_t len,
4379 * cfg80211_assoc_timeout - notification of timed out association
4380 * @dev: network device
4381 * @bss: The BSS entry with which association timed out.
4383 * This function may sleep. The caller must hold the corresponding wdev's mutex.
4385 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
4388 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
4389 * @dev: network device
4390 * @buf: 802.11 frame (header + body)
4391 * @len: length of the frame data
4393 * This function is called whenever deauthentication has been processed in
4394 * station mode. This includes both received deauthentication frames and
4395 * locally generated ones. This function may sleep. The caller must hold the
4396 * corresponding wdev's mutex.
4398 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
4401 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
4402 * @dev: network device
4403 * @buf: deauthentication frame (header + body)
4404 * @len: length of the frame data
4406 * This function is called whenever a received deauthentication or dissassoc
4407 * frame has been dropped in station mode because of MFP being used but the
4408 * frame was not protected. This function may sleep.
4410 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
4411 const u8 *buf, size_t len);
4414 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
4415 * @dev: network device
4416 * @addr: The source MAC address of the frame
4417 * @key_type: The key type that the received frame used
4418 * @key_id: Key identifier (0..3). Can be -1 if missing.
4419 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
4420 * @gfp: allocation flags
4422 * This function is called whenever the local MAC detects a MIC failure in a
4423 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
4426 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
4427 enum nl80211_key_type key_type, int key_id,
4428 const u8 *tsc, gfp_t gfp);
4431 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
4433 * @dev: network device
4434 * @bssid: the BSSID of the IBSS joined
4435 * @channel: the channel of the IBSS joined
4436 * @gfp: allocation flags
4438 * This function notifies cfg80211 that the device joined an IBSS or
4439 * switched to a different BSSID. Before this function can be called,
4440 * either a beacon has to have been received from the IBSS, or one of
4441 * the cfg80211_inform_bss{,_frame} functions must have been called
4442 * with the locally generated beacon -- this guarantees that there is
4443 * always a scan result for this IBSS. cfg80211 will handle the rest.
4445 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
4446 struct ieee80211_channel *channel, gfp_t gfp);
4449 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
4451 * @dev: network device
4452 * @macaddr: the MAC address of the new candidate
4453 * @ie: information elements advertised by the peer candidate
4454 * @ie_len: lenght of the information elements buffer
4455 * @gfp: allocation flags
4457 * This function notifies cfg80211 that the mesh peer candidate has been
4458 * detected, most likely via a beacon or, less likely, via a probe response.
4459 * cfg80211 then sends a notification to userspace.
4461 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
4462 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
4465 * DOC: RFkill integration
4467 * RFkill integration in cfg80211 is almost invisible to drivers,
4468 * as cfg80211 automatically registers an rfkill instance for each
4469 * wireless device it knows about. Soft kill is also translated
4470 * into disconnecting and turning all interfaces off, drivers are
4471 * expected to turn off the device when all interfaces are down.
4473 * However, devices may have a hard RFkill line, in which case they
4474 * also need to interact with the rfkill subsystem, via cfg80211.
4475 * They can do this with a few helper functions documented here.
4479 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
4481 * @blocked: block status
4483 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
4486 * wiphy_rfkill_start_polling - start polling rfkill
4489 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
4492 * wiphy_rfkill_stop_polling - stop polling rfkill
4495 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
4498 * DOC: Vendor commands
4500 * Occasionally, there are special protocol or firmware features that
4501 * can't be implemented very openly. For this and similar cases, the
4502 * vendor command functionality allows implementing the features with
4503 * (typically closed-source) userspace and firmware, using nl80211 as
4504 * the configuration mechanism.
4506 * A driver supporting vendor commands must register them as an array
4507 * in struct wiphy, with handlers for each one, each command has an
4508 * OUI and sub command ID to identify it.
4510 * Note that this feature should not be (ab)used to implement protocol
4511 * features that could openly be shared across drivers. In particular,
4512 * it must never be required to use vendor commands to implement any
4513 * "normal" functionality that higher-level userspace like connection
4514 * managers etc. need.
4517 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
4518 enum nl80211_commands cmd,
4519 enum nl80211_attrs attr,
4522 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
4523 struct wireless_dev *wdev,
4524 enum nl80211_commands cmd,
4525 enum nl80211_attrs attr,
4526 int vendor_event_idx,
4527 int approxlen, gfp_t gfp);
4529 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
4532 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
4534 * @approxlen: an upper bound of the length of the data that will
4535 * be put into the skb
4537 * This function allocates and pre-fills an skb for a reply to
4538 * a vendor command. Since it is intended for a reply, calling
4539 * it outside of a vendor command's doit() operation is invalid.
4541 * The returned skb is pre-filled with some identifying data in
4542 * a way that any data that is put into the skb (with skb_put(),
4543 * nla_put() or similar) will end up being within the
4544 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
4545 * with the skb is adding data for the corresponding userspace tool
4546 * which can then read that data out of the vendor data attribute.
4547 * You must not modify the skb in any other way.
4549 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
4550 * its error code as the result of the doit() operation.
4552 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4554 static inline struct sk_buff *
4555 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4557 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
4558 NL80211_ATTR_VENDOR_DATA, approxlen);
4562 * cfg80211_vendor_cmd_reply - send the reply skb
4563 * @skb: The skb, must have been allocated with
4564 * cfg80211_vendor_cmd_alloc_reply_skb()
4566 * Since calling this function will usually be the last thing
4567 * before returning from the vendor command doit() you should
4568 * return the error code. Note that this function consumes the
4569 * skb regardless of the return value.
4571 * Return: An error code or 0 on success.
4573 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
4576 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
4578 * @wdev: the wireless device
4579 * @event_idx: index of the vendor event in the wiphy's vendor_events
4580 * @approxlen: an upper bound of the length of the data that will
4581 * be put into the skb
4582 * @gfp: allocation flags
4584 * This function allocates and pre-fills an skb for an event on the
4585 * vendor-specific multicast group.
4587 * If wdev != NULL, both the ifindex and identifier of the specified
4588 * wireless device are added to the event message before the vendor data
4591 * When done filling the skb, call cfg80211_vendor_event() with the
4592 * skb to send the event.
4594 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4596 static inline struct sk_buff *
4597 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
4598 int approxlen, int event_idx, gfp_t gfp)
4600 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
4601 NL80211_ATTR_VENDOR_DATA,
4602 event_idx, approxlen, gfp);
4606 * cfg80211_vendor_event - send the event
4607 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
4608 * @gfp: allocation flags
4610 * This function sends the given @skb, which must have been allocated
4611 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
4613 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
4615 __cfg80211_send_event_skb(skb, gfp);
4618 #ifdef CONFIG_NL80211_TESTMODE
4622 * Test mode is a set of utility functions to allow drivers to
4623 * interact with driver-specific tools to aid, for instance,
4624 * factory programming.
4626 * This chapter describes how drivers interact with it, for more
4627 * information see the nl80211 book's chapter on it.
4631 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
4633 * @approxlen: an upper bound of the length of the data that will
4634 * be put into the skb
4636 * This function allocates and pre-fills an skb for a reply to
4637 * the testmode command. Since it is intended for a reply, calling
4638 * it outside of the @testmode_cmd operation is invalid.
4640 * The returned skb is pre-filled with the wiphy index and set up in
4641 * a way that any data that is put into the skb (with skb_put(),
4642 * nla_put() or similar) will end up being within the
4643 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
4644 * with the skb is adding data for the corresponding userspace tool
4645 * which can then read that data out of the testdata attribute. You
4646 * must not modify the skb in any other way.
4648 * When done, call cfg80211_testmode_reply() with the skb and return
4649 * its error code as the result of the @testmode_cmd operation.
4651 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4653 static inline struct sk_buff *
4654 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
4656 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
4657 NL80211_ATTR_TESTDATA, approxlen);
4661 * cfg80211_testmode_reply - send the reply skb
4662 * @skb: The skb, must have been allocated with
4663 * cfg80211_testmode_alloc_reply_skb()
4665 * Since calling this function will usually be the last thing
4666 * before returning from the @testmode_cmd you should return
4667 * the error code. Note that this function consumes the skb
4668 * regardless of the return value.
4670 * Return: An error code or 0 on success.
4672 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
4674 return cfg80211_vendor_cmd_reply(skb);
4678 * cfg80211_testmode_alloc_event_skb - allocate testmode event
4680 * @approxlen: an upper bound of the length of the data that will
4681 * be put into the skb
4682 * @gfp: allocation flags
4684 * This function allocates and pre-fills an skb for an event on the
4685 * testmode multicast group.
4687 * The returned skb is set up in the same way as with
4688 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
4689 * there, you should simply add data to it that will then end up in the
4690 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
4693 * When done filling the skb, call cfg80211_testmode_event() with the
4694 * skb to send the event.
4696 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
4698 static inline struct sk_buff *
4699 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
4701 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
4702 NL80211_ATTR_TESTDATA, -1,
4707 * cfg80211_testmode_event - send the event
4708 * @skb: The skb, must have been allocated with
4709 * cfg80211_testmode_alloc_event_skb()
4710 * @gfp: allocation flags
4712 * This function sends the given @skb, which must have been allocated
4713 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
4716 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
4718 __cfg80211_send_event_skb(skb, gfp);
4721 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
4722 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
4724 #define CFG80211_TESTMODE_CMD(cmd)
4725 #define CFG80211_TESTMODE_DUMP(cmd)
4729 * cfg80211_connect_bss - notify cfg80211 of connection result
4731 * @dev: network device
4732 * @bssid: the BSSID of the AP
4733 * @bss: entry of bss to which STA got connected to, can be obtained
4734 * through cfg80211_get_bss (may be %NULL)
4735 * @req_ie: association request IEs (maybe be %NULL)
4736 * @req_ie_len: association request IEs length
4737 * @resp_ie: association response IEs (may be %NULL)
4738 * @resp_ie_len: assoc response IEs length
4739 * @status: status code, 0 for successful connection, use
4740 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4741 * the real status code for failures.
4742 * @gfp: allocation flags
4744 * It should be called by the underlying driver whenever connect() has
4745 * succeeded. This is similar to cfg80211_connect_result(), but with the
4746 * option of identifying the exact bss entry for the connection. Only one of
4747 * these functions should be called.
4749 void cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
4750 struct cfg80211_bss *bss, const u8 *req_ie,
4751 size_t req_ie_len, const u8 *resp_ie,
4752 size_t resp_ie_len, int status, gfp_t gfp);
4755 * cfg80211_connect_result - notify cfg80211 of connection result
4757 * @dev: network device
4758 * @bssid: the BSSID of the AP
4759 * @req_ie: association request IEs (maybe be %NULL)
4760 * @req_ie_len: association request IEs length
4761 * @resp_ie: association response IEs (may be %NULL)
4762 * @resp_ie_len: assoc response IEs length
4763 * @status: status code, 0 for successful connection, use
4764 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
4765 * the real status code for failures.
4766 * @gfp: allocation flags
4768 * It should be called by the underlying driver whenever connect() has
4772 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
4773 const u8 *req_ie, size_t req_ie_len,
4774 const u8 *resp_ie, size_t resp_ie_len,
4775 u16 status, gfp_t gfp)
4777 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
4778 resp_ie_len, status, gfp);
4782 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
4784 * @dev: network device
4785 * @bssid: the BSSID of the AP
4786 * @req_ie: association request IEs (maybe be %NULL)
4787 * @req_ie_len: association request IEs length
4788 * @gfp: allocation flags
4790 * It should be called by the underlying driver whenever connect() has failed
4791 * in a sequence where no explicit authentication/association rejection was
4792 * received from the AP. This could happen, e.g., due to not being able to send
4793 * out the Authentication or Association Request frame or timing out while
4794 * waiting for the response.
4797 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
4798 const u8 *req_ie, size_t req_ie_len, gfp_t gfp)
4800 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
4805 * cfg80211_roamed - notify cfg80211 of roaming
4807 * @dev: network device
4808 * @channel: the channel of the new AP
4809 * @bssid: the BSSID of the new AP
4810 * @req_ie: association request IEs (maybe be %NULL)
4811 * @req_ie_len: association request IEs length
4812 * @resp_ie: association response IEs (may be %NULL)
4813 * @resp_ie_len: assoc response IEs length
4814 * @gfp: allocation flags
4816 * It should be called by the underlying driver whenever it roamed
4817 * from one AP to another while connected.
4819 void cfg80211_roamed(struct net_device *dev,
4820 struct ieee80211_channel *channel,
4822 const u8 *req_ie, size_t req_ie_len,
4823 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4826 * cfg80211_roamed_bss - notify cfg80211 of roaming
4828 * @dev: network device
4829 * @bss: entry of bss to which STA got roamed
4830 * @req_ie: association request IEs (maybe be %NULL)
4831 * @req_ie_len: association request IEs length
4832 * @resp_ie: association response IEs (may be %NULL)
4833 * @resp_ie_len: assoc response IEs length
4834 * @gfp: allocation flags
4836 * This is just a wrapper to notify cfg80211 of roaming event with driver
4837 * passing bss to avoid a race in timeout of the bss entry. It should be
4838 * called by the underlying driver whenever it roamed from one AP to another
4839 * while connected. Drivers which have roaming implemented in firmware
4840 * may use this function to avoid a race in bss entry timeout where the bss
4841 * entry of the new AP is seen in the driver, but gets timed out by the time
4842 * it is accessed in __cfg80211_roamed() due to delay in scheduling
4843 * rdev->event_work. In case of any failures, the reference is released
4844 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
4845 * it will be released while diconneting from the current bss.
4847 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
4848 const u8 *req_ie, size_t req_ie_len,
4849 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
4852 * cfg80211_disconnected - notify cfg80211 that connection was dropped
4854 * @dev: network device
4855 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
4856 * @ie_len: length of IEs
4857 * @reason: reason code for the disconnection, set it to 0 if unknown
4858 * @locally_generated: disconnection was requested locally
4859 * @gfp: allocation flags
4861 * After it calls this function, the driver should enter an idle state
4862 * and not try to connect to any AP any more.
4864 void cfg80211_disconnected(struct net_device *dev, u16 reason,
4865 const u8 *ie, size_t ie_len,
4866 bool locally_generated, gfp_t gfp);
4869 * cfg80211_ready_on_channel - notification of remain_on_channel start
4870 * @wdev: wireless device
4871 * @cookie: the request cookie
4872 * @chan: The current channel (from remain_on_channel request)
4873 * @duration: Duration in milliseconds that the driver intents to remain on the
4875 * @gfp: allocation flags
4877 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
4878 struct ieee80211_channel *chan,
4879 unsigned int duration, gfp_t gfp);
4882 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
4883 * @wdev: wireless device
4884 * @cookie: the request cookie
4885 * @chan: The current channel (from remain_on_channel request)
4886 * @gfp: allocation flags
4888 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
4889 struct ieee80211_channel *chan,
4894 * cfg80211_new_sta - notify userspace about station
4897 * @mac_addr: the station's address
4898 * @sinfo: the station information
4899 * @gfp: allocation flags
4901 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
4902 struct station_info *sinfo, gfp_t gfp);
4905 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
4907 * @mac_addr: the station's address
4908 * @sinfo: the station information/statistics
4909 * @gfp: allocation flags
4911 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
4912 struct station_info *sinfo, gfp_t gfp);
4915 * cfg80211_del_sta - notify userspace about deletion of a station
4918 * @mac_addr: the station's address
4919 * @gfp: allocation flags
4921 static inline void cfg80211_del_sta(struct net_device *dev,
4922 const u8 *mac_addr, gfp_t gfp)
4924 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
4928 * cfg80211_conn_failed - connection request failed notification
4931 * @mac_addr: the station's address
4932 * @reason: the reason for connection failure
4933 * @gfp: allocation flags
4935 * Whenever a station tries to connect to an AP and if the station
4936 * could not connect to the AP as the AP has rejected the connection
4937 * for some reasons, this function is called.
4939 * The reason for connection failure can be any of the value from
4940 * nl80211_connect_failed_reason enum
4942 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
4943 enum nl80211_connect_failed_reason reason,
4947 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
4948 * @wdev: wireless device receiving the frame
4949 * @freq: Frequency on which the frame was received in MHz
4950 * @sig_dbm: signal strength in mBm, or 0 if unknown
4951 * @buf: Management frame (header + body)
4952 * @len: length of the frame data
4953 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
4955 * This function is called whenever an Action frame is received for a station
4956 * mode interface, but is not processed in kernel.
4958 * Return: %true if a user space application has registered for this frame.
4959 * For action frames, that makes it responsible for rejecting unrecognized
4960 * action frames; %false otherwise, in which case for action frames the
4961 * driver is responsible for rejecting the frame.
4963 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
4964 const u8 *buf, size_t len, u32 flags);
4967 * cfg80211_mgmt_tx_status - notification of TX status for management frame
4968 * @wdev: wireless device receiving the frame
4969 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
4970 * @buf: Management frame (header + body)
4971 * @len: length of the frame data
4972 * @ack: Whether frame was acknowledged
4973 * @gfp: context flags
4975 * This function is called whenever a management frame was requested to be
4976 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
4977 * transmission attempt.
4979 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
4980 const u8 *buf, size_t len, bool ack, gfp_t gfp);
4984 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
4985 * @dev: network device
4986 * @rssi_event: the triggered RSSI event
4987 * @gfp: context flags
4989 * This function is called when a configured connection quality monitoring
4990 * rssi threshold reached event occurs.
4992 void cfg80211_cqm_rssi_notify(struct net_device *dev,
4993 enum nl80211_cqm_rssi_threshold_event rssi_event,
4997 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
4998 * @dev: network device
4999 * @peer: peer's MAC address
5000 * @num_packets: how many packets were lost -- should be a fixed threshold
5001 * but probably no less than maybe 50, or maybe a throughput dependent
5002 * threshold (to account for temporary interference)
5003 * @gfp: context flags
5005 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
5006 const u8 *peer, u32 num_packets, gfp_t gfp);
5009 * cfg80211_cqm_txe_notify - TX error rate event
5010 * @dev: network device
5011 * @peer: peer's MAC address
5012 * @num_packets: how many packets were lost
5013 * @rate: % of packets which failed transmission
5014 * @intvl: interval (in s) over which the TX failure threshold was breached.
5015 * @gfp: context flags
5017 * Notify userspace when configured % TX failures over number of packets in a
5018 * given interval is exceeded.
5020 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
5021 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
5024 * cfg80211_cqm_beacon_loss_notify - beacon loss event
5025 * @dev: network device
5026 * @gfp: context flags
5028 * Notify userspace about beacon loss from the connected AP.
5030 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
5033 * cfg80211_radar_event - radar detection event
5035 * @chandef: chandef for the current channel
5036 * @gfp: context flags
5038 * This function is called when a radar is detected on the current chanenl.
5040 void cfg80211_radar_event(struct wiphy *wiphy,
5041 struct cfg80211_chan_def *chandef, gfp_t gfp);
5044 * cfg80211_cac_event - Channel availability check (CAC) event
5045 * @netdev: network device
5046 * @chandef: chandef for the current channel
5047 * @event: type of event
5048 * @gfp: context flags
5050 * This function is called when a Channel availability check (CAC) is finished
5051 * or aborted. This must be called to notify the completion of a CAC process,
5052 * also by full-MAC drivers.
5054 void cfg80211_cac_event(struct net_device *netdev,
5055 const struct cfg80211_chan_def *chandef,
5056 enum nl80211_radar_event event, gfp_t gfp);
5060 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5061 * @dev: network device
5062 * @bssid: BSSID of AP (to avoid races)
5063 * @replay_ctr: new replay counter
5064 * @gfp: allocation flags
5066 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
5067 const u8 *replay_ctr, gfp_t gfp);
5070 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5071 * @dev: network device
5072 * @index: candidate index (the smaller the index, the higher the priority)
5073 * @bssid: BSSID of AP
5074 * @preauth: Whether AP advertises support for RSN pre-authentication
5075 * @gfp: allocation flags
5077 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
5078 const u8 *bssid, bool preauth, gfp_t gfp);
5081 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5082 * @dev: The device the frame matched to
5083 * @addr: the transmitter address
5084 * @gfp: context flags
5086 * This function is used in AP mode (only!) to inform userspace that
5087 * a spurious class 3 frame was received, to be able to deauth the
5089 * Return: %true if the frame was passed to userspace (or this failed
5090 * for a reason other than not having a subscription.)
5092 bool cfg80211_rx_spurious_frame(struct net_device *dev,
5093 const u8 *addr, gfp_t gfp);
5096 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5097 * @dev: The device the frame matched to
5098 * @addr: the transmitter address
5099 * @gfp: context flags
5101 * This function is used in AP mode (only!) to inform userspace that
5102 * an associated station sent a 4addr frame but that wasn't expected.
5103 * It is allowed and desirable to send this event only once for each
5104 * station to avoid event flooding.
5105 * Return: %true if the frame was passed to userspace (or this failed
5106 * for a reason other than not having a subscription.)
5108 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
5109 const u8 *addr, gfp_t gfp);
5112 * cfg80211_probe_status - notify userspace about probe status
5113 * @dev: the device the probe was sent on
5114 * @addr: the address of the peer
5115 * @cookie: the cookie filled in @probe_client previously
5116 * @acked: indicates whether probe was acked or not
5117 * @gfp: allocation flags
5119 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
5120 u64 cookie, bool acked, gfp_t gfp);
5123 * cfg80211_report_obss_beacon - report beacon from other APs
5124 * @wiphy: The wiphy that received the beacon
5126 * @len: length of the frame
5127 * @freq: frequency the frame was received on
5128 * @sig_dbm: signal strength in mBm, or 0 if unknown
5130 * Use this function to report to userspace when a beacon was
5131 * received. It is not useful to call this when there is no
5132 * netdev that is in AP/GO mode.
5134 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
5135 const u8 *frame, size_t len,
5136 int freq, int sig_dbm);
5139 * cfg80211_reg_can_beacon - check if beaconing is allowed
5141 * @chandef: the channel definition
5142 * @iftype: interface type
5144 * Return: %true if there is no secondary channel or the secondary channel(s)
5145 * can be used for beaconing (i.e. is not a radar channel etc.)
5147 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
5148 struct cfg80211_chan_def *chandef,
5149 enum nl80211_iftype iftype);
5152 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
5154 * @chandef: the channel definition
5155 * @iftype: interface type
5157 * Return: %true if there is no secondary channel or the secondary channel(s)
5158 * can be used for beaconing (i.e. is not a radar channel etc.). This version
5159 * also checks if IR-relaxation conditions apply, to allow beaconing under
5160 * more permissive conditions.
5162 * Requires the RTNL to be held.
5164 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
5165 struct cfg80211_chan_def *chandef,
5166 enum nl80211_iftype iftype);
5169 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
5170 * @dev: the device which switched channels
5171 * @chandef: the new channel definition
5173 * Caller must acquire wdev_lock, therefore must only be called from sleepable
5176 void cfg80211_ch_switch_notify(struct net_device *dev,
5177 struct cfg80211_chan_def *chandef);
5180 * cfg80211_ch_switch_started_notify - notify channel switch start
5181 * @dev: the device on which the channel switch started
5182 * @chandef: the future channel definition
5183 * @count: the number of TBTTs until the channel switch happens
5185 * Inform the userspace about the channel switch that has just
5186 * started, so that it can take appropriate actions (eg. starting
5187 * channel switch on other vifs), if necessary.
5189 void cfg80211_ch_switch_started_notify(struct net_device *dev,
5190 struct cfg80211_chan_def *chandef,
5194 * ieee80211_operating_class_to_band - convert operating class to band
5196 * @operating_class: the operating class to convert
5197 * @band: band pointer to fill
5199 * Returns %true if the conversion was successful, %false otherwise.
5201 bool ieee80211_operating_class_to_band(u8 operating_class,
5202 enum nl80211_band *band);
5205 * ieee80211_chandef_to_operating_class - convert chandef to operation class
5207 * @chandef: the chandef to convert
5208 * @op_class: a pointer to the resulting operating class
5210 * Returns %true if the conversion was successful, %false otherwise.
5212 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
5216 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
5217 * @dev: the device on which the operation is requested
5218 * @peer: the MAC address of the peer device
5219 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
5220 * NL80211_TDLS_TEARDOWN)
5221 * @reason_code: the reason code for teardown request
5222 * @gfp: allocation flags
5224 * This function is used to request userspace to perform TDLS operation that
5225 * requires knowledge of keys, i.e., link setup or teardown when the AP
5226 * connection uses encryption. This is optional mechanism for the driver to use
5227 * if it can automatically determine when a TDLS link could be useful (e.g.,
5228 * based on traffic and signal strength for a peer).
5230 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
5231 enum nl80211_tdls_operation oper,
5232 u16 reason_code, gfp_t gfp);
5235 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
5236 * @rate: given rate_info to calculate bitrate from
5238 * return 0 if MCS index >= 32
5240 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
5243 * cfg80211_unregister_wdev - remove the given wdev
5244 * @wdev: struct wireless_dev to remove
5246 * Call this function only for wdevs that have no netdev assigned,
5247 * e.g. P2P Devices. It removes the device from the list so that
5248 * it can no longer be used. It is necessary to call this function
5249 * even when cfg80211 requests the removal of the interface by
5250 * calling the del_virtual_intf() callback. The function must also
5251 * be called when the driver wishes to unregister the wdev, e.g.
5252 * when the device is unbound from the driver.
5254 * Requires the RTNL to be held.
5256 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
5259 * struct cfg80211_ft_event - FT Information Elements
5261 * @ies_len: length of the FT IE in bytes
5262 * @target_ap: target AP's MAC address
5264 * @ric_ies_len: length of the RIC IE in bytes
5266 struct cfg80211_ft_event_params {
5269 const u8 *target_ap;
5275 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
5276 * @netdev: network device
5277 * @ft_event: IE information
5279 void cfg80211_ft_event(struct net_device *netdev,
5280 struct cfg80211_ft_event_params *ft_event);
5283 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
5284 * @ies: the input IE buffer
5285 * @len: the input length
5286 * @attr: the attribute ID to find
5287 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
5288 * if the function is only called to get the needed buffer size
5289 * @bufsize: size of the output buffer
5291 * The function finds a given P2P attribute in the (vendor) IEs and
5292 * copies its contents to the given buffer.
5294 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
5295 * malformed or the attribute can't be found (respectively), or the
5296 * length of the found attribute (which can be zero).
5298 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
5299 enum ieee80211_p2p_attr_id attr,
5300 u8 *buf, unsigned int bufsize);
5303 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
5304 * @ies: the IE buffer
5305 * @ielen: the length of the IE buffer
5306 * @ids: an array with element IDs that are allowed before
5308 * @n_ids: the size of the element ID array
5309 * @after_ric: array IE types that come after the RIC element
5310 * @n_after_ric: size of the @after_ric array
5311 * @offset: offset where to start splitting in the buffer
5313 * This function splits an IE buffer by updating the @offset
5314 * variable to point to the location where the buffer should be
5317 * It assumes that the given IE buffer is well-formed, this
5318 * has to be guaranteed by the caller!
5320 * It also assumes that the IEs in the buffer are ordered
5321 * correctly, if not the result of using this function will not
5322 * be ordered correctly either, i.e. it does no reordering.
5324 * The function returns the offset where the next part of the
5325 * buffer starts, which may be @ielen if the entire (remainder)
5326 * of the buffer should be used.
5328 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
5329 const u8 *ids, int n_ids,
5330 const u8 *after_ric, int n_after_ric,
5334 * ieee80211_ie_split - split an IE buffer according to ordering
5335 * @ies: the IE buffer
5336 * @ielen: the length of the IE buffer
5337 * @ids: an array with element IDs that are allowed before
5339 * @n_ids: the size of the element ID array
5340 * @offset: offset where to start splitting in the buffer
5342 * This function splits an IE buffer by updating the @offset
5343 * variable to point to the location where the buffer should be
5346 * It assumes that the given IE buffer is well-formed, this
5347 * has to be guaranteed by the caller!
5349 * It also assumes that the IEs in the buffer are ordered
5350 * correctly, if not the result of using this function will not
5351 * be ordered correctly either, i.e. it does no reordering.
5353 * The function returns the offset where the next part of the
5354 * buffer starts, which may be @ielen if the entire (remainder)
5355 * of the buffer should be used.
5357 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
5358 const u8 *ids, int n_ids, size_t offset)
5360 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
5364 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
5365 * @wdev: the wireless device reporting the wakeup
5366 * @wakeup: the wakeup report
5367 * @gfp: allocation flags
5369 * This function reports that the given device woke up. If it
5370 * caused the wakeup, report the reason(s), otherwise you may
5371 * pass %NULL as the @wakeup parameter to advertise that something
5372 * else caused the wakeup.
5374 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
5375 struct cfg80211_wowlan_wakeup *wakeup,
5379 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
5381 * @wdev: the wireless device for which critical protocol is stopped.
5382 * @gfp: allocation flags
5384 * This function can be called by the driver to indicate it has reverted
5385 * operation back to normal. One reason could be that the duration given
5386 * by .crit_proto_start() has expired.
5388 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
5391 * ieee80211_get_num_supported_channels - get number of channels device has
5394 * Return: the number of channels supported by the device.
5396 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
5399 * cfg80211_check_combinations - check interface combinations
5402 * @num_different_channels: the number of different channels we want
5403 * to use for verification
5404 * @radar_detect: a bitmap where each bit corresponds to a channel
5405 * width where radar detection is needed, as in the definition of
5406 * &struct ieee80211_iface_combination.@radar_detect_widths
5407 * @iftype_num: array with the numbers of interfaces of each interface
5408 * type. The index is the interface type as specified in &enum
5411 * This function can be called by the driver to check whether a
5412 * combination of interfaces and their types are allowed according to
5413 * the interface combinations.
5415 int cfg80211_check_combinations(struct wiphy *wiphy,
5416 const int num_different_channels,
5417 const u8 radar_detect,
5418 const int iftype_num[NUM_NL80211_IFTYPES]);
5421 * cfg80211_iter_combinations - iterate over matching combinations
5424 * @num_different_channels: the number of different channels we want
5425 * to use for verification
5426 * @radar_detect: a bitmap where each bit corresponds to a channel
5427 * width where radar detection is needed, as in the definition of
5428 * &struct ieee80211_iface_combination.@radar_detect_widths
5429 * @iftype_num: array with the numbers of interfaces of each interface
5430 * type. The index is the interface type as specified in &enum
5432 * @iter: function to call for each matching combination
5433 * @data: pointer to pass to iter function
5435 * This function can be called by the driver to check what possible
5436 * combinations it fits in at a given moment, e.g. for channel switching
5439 int cfg80211_iter_combinations(struct wiphy *wiphy,
5440 const int num_different_channels,
5441 const u8 radar_detect,
5442 const int iftype_num[NUM_NL80211_IFTYPES],
5443 void (*iter)(const struct ieee80211_iface_combination *c,
5448 * cfg80211_stop_iface - trigger interface disconnection
5451 * @wdev: wireless device
5452 * @gfp: context flags
5454 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
5457 * Note: This doesn't need any locks and is asynchronous.
5459 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
5463 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
5464 * @wiphy: the wiphy to shut down
5466 * This function shuts down all interfaces belonging to this wiphy by
5467 * calling dev_close() (and treating non-netdev interfaces as needed).
5468 * It shouldn't really be used unless there are some fatal device errors
5469 * that really can't be recovered in any other way.
5471 * Callers must hold the RTNL and be able to deal with callbacks into
5472 * the driver while the function is running.
5474 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
5477 * wiphy_ext_feature_set - set the extended feature flag
5479 * @wiphy: the wiphy to modify.
5480 * @ftidx: extended feature bit index.
5482 * The extended features are flagged in multiple bytes (see
5483 * &struct wiphy.@ext_features)
5485 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
5486 enum nl80211_ext_feature_index ftidx)
5490 ft_byte = &wiphy->ext_features[ftidx / 8];
5491 *ft_byte |= BIT(ftidx % 8);
5495 * wiphy_ext_feature_isset - check the extended feature flag
5497 * @wiphy: the wiphy to modify.
5498 * @ftidx: extended feature bit index.
5500 * The extended features are flagged in multiple bytes (see
5501 * &struct wiphy.@ext_features)
5504 wiphy_ext_feature_isset(struct wiphy *wiphy,
5505 enum nl80211_ext_feature_index ftidx)
5509 ft_byte = wiphy->ext_features[ftidx / 8];
5510 return (ft_byte & BIT(ftidx % 8)) != 0;
5513 /* ethtool helper */
5514 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
5516 /* Logging, debugging and troubleshooting/diagnostic helpers. */
5518 /* wiphy_printk helpers, similar to dev_printk */
5520 #define wiphy_printk(level, wiphy, format, args...) \
5521 dev_printk(level, &(wiphy)->dev, format, ##args)
5522 #define wiphy_emerg(wiphy, format, args...) \
5523 dev_emerg(&(wiphy)->dev, format, ##args)
5524 #define wiphy_alert(wiphy, format, args...) \
5525 dev_alert(&(wiphy)->dev, format, ##args)
5526 #define wiphy_crit(wiphy, format, args...) \
5527 dev_crit(&(wiphy)->dev, format, ##args)
5528 #define wiphy_err(wiphy, format, args...) \
5529 dev_err(&(wiphy)->dev, format, ##args)
5530 #define wiphy_warn(wiphy, format, args...) \
5531 dev_warn(&(wiphy)->dev, format, ##args)
5532 #define wiphy_notice(wiphy, format, args...) \
5533 dev_notice(&(wiphy)->dev, format, ##args)
5534 #define wiphy_info(wiphy, format, args...) \
5535 dev_info(&(wiphy)->dev, format, ##args)
5537 #define wiphy_debug(wiphy, format, args...) \
5538 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
5540 #define wiphy_dbg(wiphy, format, args...) \
5541 dev_dbg(&(wiphy)->dev, format, ##args)
5543 #if defined(VERBOSE_DEBUG)
5544 #define wiphy_vdbg wiphy_dbg
5546 #define wiphy_vdbg(wiphy, format, args...) \
5549 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
5555 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
5556 * of using a WARN/WARN_ON to get the message out, including the
5557 * file/line information and a backtrace.
5559 #define wiphy_WARN(wiphy, format, args...) \
5560 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
5562 #endif /* __NET_CFG80211_H */