1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
4 * 802.11 device and configuration interface
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <linux/net.h>
23 #include <net/regulatory.h>
28 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
29 * userspace and drivers, and offers some utility functionality associated
30 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
31 * by all modern wireless drivers in Linux, so that they offer a consistent
32 * API through nl80211. For backward compatibility, cfg80211 also offers
33 * wireless extensions to userspace, but hides them from drivers completely.
35 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
41 * DOC: Device registration
43 * In order for a driver to use cfg80211, it must register the hardware device
44 * with cfg80211. This happens through a number of hardware capability structs
47 * The fundamental structure for each device is the 'wiphy', of which each
48 * instance describes a physical wireless device connected to the system. Each
49 * such wiphy can have zero, one, or many virtual interfaces associated with
50 * it, which need to be identified as such by pointing the network interface's
51 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
52 * the wireless part of the interface, normally this struct is embedded in the
53 * network interface's private data area. Drivers can optionally allow creating
54 * or destroying virtual interfaces on the fly, but without at least one or the
55 * ability to create some the wireless device isn't useful.
57 * Each wiphy structure contains device capability information, and also has
58 * a pointer to the various operations the driver offers. The definitions and
59 * structures here describe these capabilities in detail.
65 * wireless hardware capability structures
69 * enum ieee80211_band - supported frequency bands
71 * The bands are assigned this way because the supported
72 * bitrates differ in these bands.
74 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
75 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
76 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
77 * @IEEE80211_NUM_BANDS: number of defined bands
80 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
81 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
82 IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
89 * enum ieee80211_channel_flags - channel flags
91 * Channel flags set by the regulatory control code.
93 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
94 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
96 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
97 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
98 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
100 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
102 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
103 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
104 * this flag indicates that an 80 MHz channel cannot use this
105 * channel as the control or any of the secondary channels.
106 * This may be due to the driver or due to regulatory bandwidth
108 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
109 * this flag indicates that an 160 MHz channel cannot use this
110 * channel as the control or any of the secondary channels.
111 * This may be due to the driver or due to regulatory bandwidth
114 enum ieee80211_channel_flags {
115 IEEE80211_CHAN_DISABLED = 1<<0,
116 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
117 IEEE80211_CHAN_NO_IBSS = 1<<2,
118 IEEE80211_CHAN_RADAR = 1<<3,
119 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
120 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
121 IEEE80211_CHAN_NO_OFDM = 1<<6,
122 IEEE80211_CHAN_NO_80MHZ = 1<<7,
123 IEEE80211_CHAN_NO_160MHZ = 1<<8,
126 #define IEEE80211_CHAN_NO_HT40 \
127 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
129 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
130 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
133 * struct ieee80211_channel - channel definition
135 * This structure describes a single channel for use
138 * @center_freq: center frequency in MHz
139 * @hw_value: hardware-specific value for the channel
140 * @flags: channel flags from &enum ieee80211_channel_flags.
141 * @orig_flags: channel flags at registration time, used by regulatory
142 * code to support devices with additional restrictions
143 * @band: band this channel belongs to.
144 * @max_antenna_gain: maximum antenna gain in dBi
145 * @max_power: maximum transmission power (in dBm)
146 * @max_reg_power: maximum regulatory transmission power (in dBm)
147 * @beacon_found: helper to regulatory code to indicate when a beacon
148 * has been found on this channel. Use regulatory_hint_found_beacon()
149 * to enable this, this is useful only on 5 GHz band.
150 * @orig_mag: internal use
151 * @orig_mpwr: internal use
152 * @dfs_state: current state of this channel. Only relevant if radar is required
154 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
156 struct ieee80211_channel {
157 enum ieee80211_band band;
161 int max_antenna_gain;
166 int orig_mag, orig_mpwr;
167 enum nl80211_dfs_state dfs_state;
168 unsigned long dfs_state_entered;
172 * enum ieee80211_rate_flags - rate flags
174 * Hardware/specification flags for rates. These are structured
175 * in a way that allows using the same bitrate structure for
176 * different bands/PHY modes.
178 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
179 * preamble on this bitrate; only relevant in 2.4GHz band and
181 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
182 * when used with 802.11a (on the 5 GHz band); filled by the
183 * core code when registering the wiphy.
184 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
185 * when used with 802.11b (on the 2.4 GHz band); filled by the
186 * core code when registering the wiphy.
187 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
188 * when used with 802.11g (on the 2.4 GHz band); filled by the
189 * core code when registering the wiphy.
190 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
192 enum ieee80211_rate_flags {
193 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
194 IEEE80211_RATE_MANDATORY_A = 1<<1,
195 IEEE80211_RATE_MANDATORY_B = 1<<2,
196 IEEE80211_RATE_MANDATORY_G = 1<<3,
197 IEEE80211_RATE_ERP_G = 1<<4,
201 * struct ieee80211_rate - bitrate definition
203 * This structure describes a bitrate that an 802.11 PHY can
204 * operate with. The two values @hw_value and @hw_value_short
205 * are only for driver use when pointers to this structure are
208 * @flags: rate-specific flags
209 * @bitrate: bitrate in units of 100 Kbps
210 * @hw_value: driver/hardware value for this rate
211 * @hw_value_short: driver/hardware value for this rate when
212 * short preamble is used
214 struct ieee80211_rate {
217 u16 hw_value, hw_value_short;
221 * struct ieee80211_sta_ht_cap - STA's HT capabilities
223 * This structure describes most essential parameters needed
224 * to describe 802.11n HT capabilities for an STA.
226 * @ht_supported: is HT supported by the STA
227 * @cap: HT capabilities map as described in 802.11n spec
228 * @ampdu_factor: Maximum A-MPDU length factor
229 * @ampdu_density: Minimum A-MPDU spacing
230 * @mcs: Supported MCS rates
232 struct ieee80211_sta_ht_cap {
233 u16 cap; /* use IEEE80211_HT_CAP_ */
237 struct ieee80211_mcs_info mcs;
241 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
243 * This structure describes most essential parameters needed
244 * to describe 802.11ac VHT capabilities for an STA.
246 * @vht_supported: is VHT supported by the STA
247 * @cap: VHT capabilities map as described in 802.11ac spec
248 * @vht_mcs: Supported VHT MCS rates
250 struct ieee80211_sta_vht_cap {
252 u32 cap; /* use IEEE80211_VHT_CAP_ */
253 struct ieee80211_vht_mcs_info vht_mcs;
257 * struct ieee80211_supported_band - frequency band definition
259 * This structure describes a frequency band a wiphy
260 * is able to operate in.
262 * @channels: Array of channels the hardware can operate in
264 * @band: the band this structure represents
265 * @n_channels: Number of channels in @channels
266 * @bitrates: Array of bitrates the hardware can operate with
267 * in this band. Must be sorted to give a valid "supported
268 * rates" IE, i.e. CCK rates first, then OFDM.
269 * @n_bitrates: Number of bitrates in @bitrates
270 * @ht_cap: HT capabilities in this band
271 * @vht_cap: VHT capabilities in this band
273 struct ieee80211_supported_band {
274 struct ieee80211_channel *channels;
275 struct ieee80211_rate *bitrates;
276 enum ieee80211_band band;
279 struct ieee80211_sta_ht_cap ht_cap;
280 struct ieee80211_sta_vht_cap vht_cap;
284 * Wireless hardware/device configuration structures and methods
288 * DOC: Actions and configuration
290 * Each wireless device and each virtual interface offer a set of configuration
291 * operations and other actions that are invoked by userspace. Each of these
292 * actions is described in the operations structure, and the parameters these
293 * operations use are described separately.
295 * Additionally, some operations are asynchronous and expect to get status
296 * information via some functions that drivers need to call.
298 * Scanning and BSS list handling with its associated functionality is described
299 * in a separate chapter.
303 * struct vif_params - describes virtual interface parameters
304 * @use_4addr: use 4-address frames
305 * @macaddr: address to use for this virtual interface. This will only
306 * be used for non-netdevice interfaces. If this parameter is set
307 * to zero address the driver may determine the address as needed.
311 u8 macaddr[ETH_ALEN];
315 * struct key_params - key information
317 * Information about a key
320 * @key_len: length of key material
321 * @cipher: cipher suite selector
322 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
323 * with the get_key() callback, must be in little endian,
324 * length given by @seq_len.
325 * @seq_len: length of @seq.
336 * struct cfg80211_chan_def - channel definition
337 * @chan: the (control) channel
338 * @width: channel width
339 * @center_freq1: center frequency of first segment
340 * @center_freq2: center frequency of second segment
341 * (only with 80+80 MHz)
343 struct cfg80211_chan_def {
344 struct ieee80211_channel *chan;
345 enum nl80211_chan_width width;
351 * cfg80211_get_chandef_type - return old channel type from chandef
352 * @chandef: the channel definition
354 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
355 * chandef, which must have a bandwidth allowing this conversion.
357 static inline enum nl80211_channel_type
358 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
360 switch (chandef->width) {
361 case NL80211_CHAN_WIDTH_20_NOHT:
362 return NL80211_CHAN_NO_HT;
363 case NL80211_CHAN_WIDTH_20:
364 return NL80211_CHAN_HT20;
365 case NL80211_CHAN_WIDTH_40:
366 if (chandef->center_freq1 > chandef->chan->center_freq)
367 return NL80211_CHAN_HT40PLUS;
368 return NL80211_CHAN_HT40MINUS;
371 return NL80211_CHAN_NO_HT;
376 * cfg80211_chandef_create - create channel definition using channel type
377 * @chandef: the channel definition struct to fill
378 * @channel: the control channel
379 * @chantype: the channel type
381 * Given a channel type, create a channel definition.
383 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
384 struct ieee80211_channel *channel,
385 enum nl80211_channel_type chantype);
388 * cfg80211_chandef_identical - check if two channel definitions are identical
389 * @chandef1: first channel definition
390 * @chandef2: second channel definition
392 * Return: %true if the channels defined by the channel definitions are
393 * identical, %false otherwise.
396 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
397 const struct cfg80211_chan_def *chandef2)
399 return (chandef1->chan == chandef2->chan &&
400 chandef1->width == chandef2->width &&
401 chandef1->center_freq1 == chandef2->center_freq1 &&
402 chandef1->center_freq2 == chandef2->center_freq2);
406 * cfg80211_chandef_compatible - check if two channel definitions are compatible
407 * @chandef1: first channel definition
408 * @chandef2: second channel definition
410 * Return: %NULL if the given channel definitions are incompatible,
411 * chandef1 or chandef2 otherwise.
413 const struct cfg80211_chan_def *
414 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
415 const struct cfg80211_chan_def *chandef2);
418 * cfg80211_chandef_valid - check if a channel definition is valid
419 * @chandef: the channel definition to check
420 * Return: %true if the channel definition is valid. %false otherwise.
422 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
425 * cfg80211_chandef_usable - check if secondary channels can be used
426 * @wiphy: the wiphy to validate against
427 * @chandef: the channel definition to check
428 * @prohibited_flags: the regulatory channel flags that must not be set
429 * Return: %true if secondary channels are usable. %false otherwise.
431 bool cfg80211_chandef_usable(struct wiphy *wiphy,
432 const struct cfg80211_chan_def *chandef,
433 u32 prohibited_flags);
436 * enum survey_info_flags - survey information flags
438 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
439 * @SURVEY_INFO_IN_USE: channel is currently being used
440 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
441 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
442 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
443 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
444 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
446 * Used by the driver to indicate which info in &struct survey_info
447 * it has filled in during the get_survey().
449 enum survey_info_flags {
450 SURVEY_INFO_NOISE_DBM = 1<<0,
451 SURVEY_INFO_IN_USE = 1<<1,
452 SURVEY_INFO_CHANNEL_TIME = 1<<2,
453 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
454 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
455 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
456 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
460 * struct survey_info - channel survey response
462 * @channel: the channel this survey record reports, mandatory
463 * @filled: bitflag of flags from &enum survey_info_flags
464 * @noise: channel noise in dBm. This and all following fields are
466 * @channel_time: amount of time in ms the radio spent on the channel
467 * @channel_time_busy: amount of time the primary channel was sensed busy
468 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
469 * @channel_time_rx: amount of time the radio spent receiving data
470 * @channel_time_tx: amount of time the radio spent transmitting data
472 * Used by dump_survey() to report back per-channel survey information.
474 * This structure can later be expanded with things like
475 * channel duty cycle etc.
478 struct ieee80211_channel *channel;
480 u64 channel_time_busy;
481 u64 channel_time_ext_busy;
489 * struct cfg80211_crypto_settings - Crypto settings
490 * @wpa_versions: indicates which, if any, WPA versions are enabled
491 * (from enum nl80211_wpa_versions)
492 * @cipher_group: group key cipher suite (or 0 if unset)
493 * @n_ciphers_pairwise: number of AP supported unicast ciphers
494 * @ciphers_pairwise: unicast key cipher suites
495 * @n_akm_suites: number of AKM suites
496 * @akm_suites: AKM suites
497 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
498 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
499 * required to assume that the port is unauthorized until authorized by
500 * user space. Otherwise, port is marked authorized by default.
501 * @control_port_ethertype: the control port protocol that should be
502 * allowed through even on unauthorized ports
503 * @control_port_no_encrypt: TRUE to prevent encryption of control port
506 struct cfg80211_crypto_settings {
509 int n_ciphers_pairwise;
510 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
512 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
514 __be16 control_port_ethertype;
515 bool control_port_no_encrypt;
519 * struct cfg80211_beacon_data - beacon data
520 * @head: head portion of beacon (before TIM IE)
521 * or %NULL if not changed
522 * @tail: tail portion of beacon (after TIM IE)
523 * or %NULL if not changed
524 * @head_len: length of @head
525 * @tail_len: length of @tail
526 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
527 * @beacon_ies_len: length of beacon_ies in octets
528 * @proberesp_ies: extra information element(s) to add into Probe Response
530 * @proberesp_ies_len: length of proberesp_ies in octets
531 * @assocresp_ies: extra information element(s) to add into (Re)Association
532 * Response frames or %NULL
533 * @assocresp_ies_len: length of assocresp_ies in octets
534 * @probe_resp_len: length of probe response template (@probe_resp)
535 * @probe_resp: probe response template (AP mode only)
537 struct cfg80211_beacon_data {
538 const u8 *head, *tail;
539 const u8 *beacon_ies;
540 const u8 *proberesp_ies;
541 const u8 *assocresp_ies;
542 const u8 *probe_resp;
544 size_t head_len, tail_len;
545 size_t beacon_ies_len;
546 size_t proberesp_ies_len;
547 size_t assocresp_ies_len;
548 size_t probe_resp_len;
556 * struct cfg80211_acl_data - Access control list data
558 * @acl_policy: ACL policy to be applied on the station's
559 * entry specified by mac_addr
560 * @n_acl_entries: Number of MAC address entries passed
561 * @mac_addrs: List of MAC addresses of stations to be used for ACL
563 struct cfg80211_acl_data {
564 enum nl80211_acl_policy acl_policy;
568 struct mac_address mac_addrs[];
572 * struct cfg80211_ap_settings - AP configuration
574 * Used to configure an AP interface.
576 * @chandef: defines the channel to use
577 * @beacon: beacon data
578 * @beacon_interval: beacon interval
579 * @dtim_period: DTIM period
580 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
582 * @ssid_len: length of @ssid
583 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
584 * @crypto: crypto settings
585 * @privacy: the BSS uses privacy
586 * @auth_type: Authentication type (algorithm)
587 * @inactivity_timeout: time in seconds to determine station's inactivity.
588 * @p2p_ctwindow: P2P CT Window
589 * @p2p_opp_ps: P2P opportunistic PS
590 * @acl: ACL configuration used by the drivers which has support for
591 * MAC address based access control
592 * @radar_required: set if radar detection is required
594 struct cfg80211_ap_settings {
595 struct cfg80211_chan_def chandef;
597 struct cfg80211_beacon_data beacon;
599 int beacon_interval, dtim_period;
602 enum nl80211_hidden_ssid hidden_ssid;
603 struct cfg80211_crypto_settings crypto;
605 enum nl80211_auth_type auth_type;
606 int inactivity_timeout;
609 const struct cfg80211_acl_data *acl;
614 * enum station_parameters_apply_mask - station parameter values to apply
615 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
616 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
617 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
619 * Not all station parameters have in-band "no change" signalling,
620 * for those that don't these flags will are used.
622 enum station_parameters_apply_mask {
623 STATION_PARAM_APPLY_UAPSD = BIT(0),
624 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
625 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
629 * struct station_parameters - station parameters
631 * Used to change and create a new station.
633 * @vlan: vlan interface station should belong to
634 * @supported_rates: supported rates in IEEE 802.11 format
635 * (or NULL for no change)
636 * @supported_rates_len: number of supported rates
637 * @sta_flags_mask: station flags that changed
638 * (bitmask of BIT(NL80211_STA_FLAG_...))
639 * @sta_flags_set: station flags values
640 * (bitmask of BIT(NL80211_STA_FLAG_...))
641 * @listen_interval: listen interval or -1 for no change
642 * @aid: AID or zero for no change
643 * @plink_action: plink action to take
644 * @plink_state: set the peer link state for a station
645 * @ht_capa: HT capabilities of station
646 * @vht_capa: VHT capabilities of station
647 * @uapsd_queues: bitmap of queues configured for uapsd. same format
648 * as the AC bitmap in the QoS info field
649 * @max_sp: max Service Period. same format as the MAX_SP in the
650 * QoS info field (but already shifted down)
651 * @sta_modify_mask: bitmap indicating which parameters changed
652 * (for those that don't have a natural "no change" value),
653 * see &enum station_parameters_apply_mask
654 * @local_pm: local link-specific mesh power save mode (no change when set
656 * @capability: station capability
657 * @ext_capab: extended capabilities of the station
658 * @ext_capab_len: number of extended capabilities
660 struct station_parameters {
661 const u8 *supported_rates;
662 struct net_device *vlan;
663 u32 sta_flags_mask, sta_flags_set;
667 u8 supported_rates_len;
670 const struct ieee80211_ht_cap *ht_capa;
671 const struct ieee80211_vht_cap *vht_capa;
674 enum nl80211_mesh_power_mode local_pm;
681 * enum cfg80211_station_type - the type of station being modified
682 * @CFG80211_STA_AP_CLIENT: client of an AP interface
683 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
684 * the AP MLME in the device
685 * @CFG80211_STA_AP_STA: AP station on managed interface
686 * @CFG80211_STA_IBSS: IBSS station
687 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
688 * while TDLS setup is in progress, it moves out of this state when
689 * being marked authorized; use this only if TDLS with external setup is
691 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
692 * entry that is operating, has been marked authorized by userspace)
693 * @CFG80211_STA_MESH_PEER_NONSEC: peer on mesh interface (non-secured)
694 * @CFG80211_STA_MESH_PEER_SECURE: peer on mesh interface (secured)
696 enum cfg80211_station_type {
697 CFG80211_STA_AP_CLIENT,
698 CFG80211_STA_AP_MLME_CLIENT,
701 CFG80211_STA_TDLS_PEER_SETUP,
702 CFG80211_STA_TDLS_PEER_ACTIVE,
703 CFG80211_STA_MESH_PEER_NONSEC,
704 CFG80211_STA_MESH_PEER_SECURE,
708 * cfg80211_check_station_change - validate parameter changes
709 * @wiphy: the wiphy this operates on
710 * @params: the new parameters for a station
711 * @statype: the type of station being modified
713 * Utility function for the @change_station driver method. Call this function
714 * with the appropriate station type looking up the station (and checking that
715 * it exists). It will verify whether the station change is acceptable, and if
716 * not will return an error code. Note that it may modify the parameters for
717 * backward compatibility reasons, so don't use them before calling this.
719 int cfg80211_check_station_change(struct wiphy *wiphy,
720 struct station_parameters *params,
721 enum cfg80211_station_type statype);
724 * enum station_info_flags - station information flags
726 * Used by the driver to indicate which info in &struct station_info
727 * it has filled in during get_station() or dump_station().
729 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
730 * @STATION_INFO_RX_BYTES: @rx_bytes filled
731 * @STATION_INFO_TX_BYTES: @tx_bytes filled
732 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
733 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
734 * @STATION_INFO_LLID: @llid filled
735 * @STATION_INFO_PLID: @plid filled
736 * @STATION_INFO_PLINK_STATE: @plink_state filled
737 * @STATION_INFO_SIGNAL: @signal filled
738 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
739 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
740 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
741 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
742 * @STATION_INFO_TX_RETRIES: @tx_retries filled
743 * @STATION_INFO_TX_FAILED: @tx_failed filled
744 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
745 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
746 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
747 * @STATION_INFO_BSS_PARAM: @bss_param filled
748 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
749 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
750 * @STATION_INFO_STA_FLAGS: @sta_flags filled
751 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
752 * @STATION_INFO_T_OFFSET: @t_offset filled
753 * @STATION_INFO_LOCAL_PM: @local_pm filled
754 * @STATION_INFO_PEER_PM: @peer_pm filled
755 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
757 enum station_info_flags {
758 STATION_INFO_INACTIVE_TIME = 1<<0,
759 STATION_INFO_RX_BYTES = 1<<1,
760 STATION_INFO_TX_BYTES = 1<<2,
761 STATION_INFO_LLID = 1<<3,
762 STATION_INFO_PLID = 1<<4,
763 STATION_INFO_PLINK_STATE = 1<<5,
764 STATION_INFO_SIGNAL = 1<<6,
765 STATION_INFO_TX_BITRATE = 1<<7,
766 STATION_INFO_RX_PACKETS = 1<<8,
767 STATION_INFO_TX_PACKETS = 1<<9,
768 STATION_INFO_TX_RETRIES = 1<<10,
769 STATION_INFO_TX_FAILED = 1<<11,
770 STATION_INFO_RX_DROP_MISC = 1<<12,
771 STATION_INFO_SIGNAL_AVG = 1<<13,
772 STATION_INFO_RX_BITRATE = 1<<14,
773 STATION_INFO_BSS_PARAM = 1<<15,
774 STATION_INFO_CONNECTED_TIME = 1<<16,
775 STATION_INFO_ASSOC_REQ_IES = 1<<17,
776 STATION_INFO_STA_FLAGS = 1<<18,
777 STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
778 STATION_INFO_T_OFFSET = 1<<20,
779 STATION_INFO_LOCAL_PM = 1<<21,
780 STATION_INFO_PEER_PM = 1<<22,
781 STATION_INFO_NONPEER_PM = 1<<23,
782 STATION_INFO_RX_BYTES64 = 1<<24,
783 STATION_INFO_TX_BYTES64 = 1<<25,
787 * enum station_info_rate_flags - bitrate info flags
789 * Used by the driver to indicate the specific rate transmission
790 * type for 802.11n transmissions.
792 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
793 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
794 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
795 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
796 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
797 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
798 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
799 * @RATE_INFO_FLAGS_60G: 60GHz MCS
801 enum rate_info_flags {
802 RATE_INFO_FLAGS_MCS = BIT(0),
803 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
804 RATE_INFO_FLAGS_40_MHZ_WIDTH = BIT(2),
805 RATE_INFO_FLAGS_80_MHZ_WIDTH = BIT(3),
806 RATE_INFO_FLAGS_80P80_MHZ_WIDTH = BIT(4),
807 RATE_INFO_FLAGS_160_MHZ_WIDTH = BIT(5),
808 RATE_INFO_FLAGS_SHORT_GI = BIT(6),
809 RATE_INFO_FLAGS_60G = BIT(7),
813 * struct rate_info - bitrate information
815 * Information about a receiving or transmitting bitrate
817 * @flags: bitflag of flags from &enum rate_info_flags
818 * @mcs: mcs index if struct describes a 802.11n bitrate
819 * @legacy: bitrate in 100kbit/s for 802.11abg
820 * @nss: number of streams (VHT only)
830 * enum station_info_rate_flags - bitrate info flags
832 * Used by the driver to indicate the specific rate transmission
833 * type for 802.11n transmissions.
835 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
836 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
837 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
839 enum bss_param_flags {
840 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
841 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
842 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
846 * struct sta_bss_parameters - BSS parameters for the attached station
848 * Information about the currently associated BSS
850 * @flags: bitflag of flags from &enum bss_param_flags
851 * @dtim_period: DTIM period for the BSS
852 * @beacon_interval: beacon interval
854 struct sta_bss_parameters {
861 * struct station_info - station information
863 * Station information filled by driver for get_station() and dump_station.
865 * @filled: bitflag of flags from &enum station_info_flags
866 * @connected_time: time(in secs) since a station is last connected
867 * @inactive_time: time since last station activity (tx/rx) in milliseconds
868 * @rx_bytes: bytes received from this station
869 * @tx_bytes: bytes transmitted to this station
870 * @llid: mesh local link id
871 * @plid: mesh peer link id
872 * @plink_state: mesh peer link state
873 * @signal: The signal strength, type depends on the wiphy's signal_type.
874 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
875 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
876 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
877 * @txrate: current unicast bitrate from this station
878 * @rxrate: current unicast bitrate to this station
879 * @rx_packets: packets received from this station
880 * @tx_packets: packets transmitted to this station
881 * @tx_retries: cumulative retry counts
882 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
883 * @rx_dropped_misc: Dropped for un-specified reason.
884 * @bss_param: current BSS parameters
885 * @generation: generation number for nl80211 dumps.
886 * This number should increase every time the list of stations
887 * changes, i.e. when a station is added or removed, so that
888 * userspace can tell whether it got a consistent snapshot.
889 * @assoc_req_ies: IEs from (Re)Association Request.
890 * This is used only when in AP mode with drivers that do not use
891 * user space MLME/SME implementation. The information is provided for
892 * the cfg80211_new_sta() calls to notify user space of the IEs.
893 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
894 * @sta_flags: station flags mask & values
895 * @beacon_loss_count: Number of times beacon loss event has triggered.
896 * @t_offset: Time offset of the station relative to this host.
897 * @local_pm: local mesh STA power save mode
898 * @peer_pm: peer mesh STA power save mode
899 * @nonpeer_pm: non-peer mesh STA power save mode
901 struct station_info {
912 struct rate_info txrate;
913 struct rate_info rxrate;
919 struct sta_bss_parameters bss_param;
920 struct nl80211_sta_flag_update sta_flags;
924 const u8 *assoc_req_ies;
925 size_t assoc_req_ies_len;
927 u32 beacon_loss_count;
929 enum nl80211_mesh_power_mode local_pm;
930 enum nl80211_mesh_power_mode peer_pm;
931 enum nl80211_mesh_power_mode nonpeer_pm;
934 * Note: Add a new enum station_info_flags value for each new field and
935 * use it to check which fields are initialized.
940 * enum monitor_flags - monitor flags
942 * Monitor interface configuration flags. Note that these must be the bits
943 * according to the nl80211 flags.
945 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
946 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
947 * @MONITOR_FLAG_CONTROL: pass control frames
948 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
949 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
952 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
953 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
954 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
955 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
956 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
960 * enum mpath_info_flags - mesh path information flags
962 * Used by the driver to indicate which info in &struct mpath_info it has filled
963 * in during get_station() or dump_station().
965 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
966 * @MPATH_INFO_SN: @sn filled
967 * @MPATH_INFO_METRIC: @metric filled
968 * @MPATH_INFO_EXPTIME: @exptime filled
969 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
970 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
971 * @MPATH_INFO_FLAGS: @flags filled
973 enum mpath_info_flags {
974 MPATH_INFO_FRAME_QLEN = BIT(0),
975 MPATH_INFO_SN = BIT(1),
976 MPATH_INFO_METRIC = BIT(2),
977 MPATH_INFO_EXPTIME = BIT(3),
978 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
979 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
980 MPATH_INFO_FLAGS = BIT(6),
984 * struct mpath_info - mesh path information
986 * Mesh path information filled by driver for get_mpath() and dump_mpath().
988 * @filled: bitfield of flags from &enum mpath_info_flags
989 * @frame_qlen: number of queued frames for this destination
990 * @sn: target sequence number
991 * @metric: metric (cost) of this mesh path
992 * @exptime: expiration time for the mesh path from now, in msecs
993 * @flags: mesh path flags
994 * @discovery_timeout: total mesh path discovery timeout, in msecs
995 * @discovery_retries: mesh path discovery retries
996 * @generation: generation number for nl80211 dumps.
997 * This number should increase every time the list of mesh paths
998 * changes, i.e. when a station is added or removed, so that
999 * userspace can tell whether it got a consistent snapshot.
1007 u32 discovery_timeout;
1008 u8 discovery_retries;
1015 * struct bss_parameters - BSS parameters
1017 * Used to change BSS parameters (mainly for AP mode).
1019 * @use_cts_prot: Whether to use CTS protection
1020 * (0 = no, 1 = yes, -1 = do not change)
1021 * @use_short_preamble: Whether the use of short preambles is allowed
1022 * (0 = no, 1 = yes, -1 = do not change)
1023 * @use_short_slot_time: Whether the use of short slot time is allowed
1024 * (0 = no, 1 = yes, -1 = do not change)
1025 * @basic_rates: basic rates in IEEE 802.11 format
1026 * (or NULL for no change)
1027 * @basic_rates_len: number of basic rates
1028 * @ap_isolate: do not forward packets between connected stations
1029 * @ht_opmode: HT Operation mode
1030 * (u16 = opmode, -1 = do not change)
1031 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1032 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1034 struct bss_parameters {
1036 int use_short_preamble;
1037 int use_short_slot_time;
1042 s8 p2p_ctwindow, p2p_opp_ps;
1046 * struct mesh_config - 802.11s mesh configuration
1048 * These parameters can be changed while the mesh is active.
1050 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1051 * by the Mesh Peering Open message
1052 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1053 * used by the Mesh Peering Open message
1054 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1055 * the mesh peering management to close a mesh peering
1056 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1058 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1059 * be sent to establish a new peer link instance in a mesh
1060 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1061 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1063 * @auto_open_plinks: whether we should automatically open peer links when we
1064 * detect compatible mesh peers
1065 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1066 * synchronize to for 11s default synchronization method
1067 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1068 * that an originator mesh STA can send to a particular path target
1069 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1070 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1071 * a path discovery in milliseconds
1072 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1073 * receiving a PREQ shall consider the forwarding information from the
1074 * root to be valid. (TU = time unit)
1075 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1076 * which a mesh STA can send only one action frame containing a PREQ
1078 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1079 * which a mesh STA can send only one Action frame containing a PERR
1081 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1082 * it takes for an HWMP information element to propagate across the mesh
1083 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1084 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1085 * announcements are transmitted
1086 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1087 * station has access to a broader network beyond the MBSS. (This is
1088 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1089 * only means that the station will announce others it's a mesh gate, but
1090 * not necessarily using the gate announcement protocol. Still keeping the
1091 * same nomenclature to be in sync with the spec)
1092 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1093 * entity (default is TRUE - forwarding entity)
1094 * @rssi_threshold: the threshold for average signal strength of candidate
1095 * station to establish a peer link
1096 * @ht_opmode: mesh HT protection mode
1098 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1099 * receiving a proactive PREQ shall consider the forwarding information to
1100 * the root mesh STA to be valid.
1102 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1103 * PREQs are transmitted.
1104 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1105 * during which a mesh STA can send only one Action frame containing
1106 * a PREQ element for root path confirmation.
1107 * @power_mode: The default mesh power save mode which will be the initial
1108 * setting for new peer links.
1109 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1110 * after transmitting its beacon.
1112 struct mesh_config {
1113 u16 dot11MeshRetryTimeout;
1114 u16 dot11MeshConfirmTimeout;
1115 u16 dot11MeshHoldingTimeout;
1116 u16 dot11MeshMaxPeerLinks;
1117 u8 dot11MeshMaxRetries;
1120 bool auto_open_plinks;
1121 u32 dot11MeshNbrOffsetMaxNeighbor;
1122 u8 dot11MeshHWMPmaxPREQretries;
1123 u32 path_refresh_time;
1124 u16 min_discovery_timeout;
1125 u32 dot11MeshHWMPactivePathTimeout;
1126 u16 dot11MeshHWMPpreqMinInterval;
1127 u16 dot11MeshHWMPperrMinInterval;
1128 u16 dot11MeshHWMPnetDiameterTraversalTime;
1129 u8 dot11MeshHWMPRootMode;
1130 u16 dot11MeshHWMPRannInterval;
1131 bool dot11MeshGateAnnouncementProtocol;
1132 bool dot11MeshForwarding;
1135 u32 dot11MeshHWMPactivePathToRootTimeout;
1136 u16 dot11MeshHWMProotInterval;
1137 u16 dot11MeshHWMPconfirmationInterval;
1138 enum nl80211_mesh_power_mode power_mode;
1139 u16 dot11MeshAwakeWindowDuration;
1143 * struct mesh_setup - 802.11s mesh setup configuration
1144 * @chandef: defines the channel to use
1145 * @mesh_id: the mesh ID
1146 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1147 * @sync_method: which synchronization method to use
1148 * @path_sel_proto: which path selection protocol to use
1149 * @path_metric: which metric to use
1150 * @ie: vendor information elements (optional)
1151 * @ie_len: length of vendor information elements
1152 * @is_authenticated: this mesh requires authentication
1153 * @is_secure: this mesh uses security
1154 * @dtim_period: DTIM period to use
1155 * @beacon_interval: beacon interval to use
1156 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1158 * These parameters are fixed when the mesh is created.
1161 struct cfg80211_chan_def chandef;
1169 bool is_authenticated;
1172 u16 beacon_interval;
1173 int mcast_rate[IEEE80211_NUM_BANDS];
1177 * struct ieee80211_txq_params - TX queue parameters
1178 * @ac: AC identifier
1179 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1180 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1182 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1184 * @aifs: Arbitration interframe space [0..255]
1186 struct ieee80211_txq_params {
1195 * DOC: Scanning and BSS list handling
1197 * The scanning process itself is fairly simple, but cfg80211 offers quite
1198 * a bit of helper functionality. To start a scan, the scan operation will
1199 * be invoked with a scan definition. This scan definition contains the
1200 * channels to scan, and the SSIDs to send probe requests for (including the
1201 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1202 * probe. Additionally, a scan request may contain extra information elements
1203 * that should be added to the probe request. The IEs are guaranteed to be
1204 * well-formed, and will not exceed the maximum length the driver advertised
1205 * in the wiphy structure.
1207 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1208 * it is responsible for maintaining the BSS list; the driver should not
1209 * maintain a list itself. For this notification, various functions exist.
1211 * Since drivers do not maintain a BSS list, there are also a number of
1212 * functions to search for a BSS and obtain information about it from the
1213 * BSS structure cfg80211 maintains. The BSS list is also made available
1218 * struct cfg80211_ssid - SSID description
1220 * @ssid_len: length of the ssid
1222 struct cfg80211_ssid {
1223 u8 ssid[IEEE80211_MAX_SSID_LEN];
1228 * struct cfg80211_scan_request - scan request description
1230 * @ssids: SSIDs to scan for (active scan only)
1231 * @n_ssids: number of SSIDs
1232 * @channels: channels to scan on.
1233 * @n_channels: total number of channels to scan
1234 * @ie: optional information element(s) to add into Probe Request or %NULL
1235 * @ie_len: length of ie in octets
1236 * @flags: bit field of flags controlling operation
1237 * @rates: bitmap of rates to advertise for each band
1238 * @wiphy: the wiphy this was for
1239 * @scan_start: time (in jiffies) when the scan started
1240 * @wdev: the wireless device to scan for
1241 * @aborted: (internal) scan request was notified as aborted
1242 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1244 struct cfg80211_scan_request {
1245 struct cfg80211_ssid *ssids;
1252 u32 rates[IEEE80211_NUM_BANDS];
1254 struct wireless_dev *wdev;
1257 struct wiphy *wiphy;
1258 unsigned long scan_start;
1263 struct ieee80211_channel *channels[0];
1267 * struct cfg80211_match_set - sets of attributes to match
1269 * @ssid: SSID to be matched
1271 struct cfg80211_match_set {
1272 struct cfg80211_ssid ssid;
1276 * struct cfg80211_sched_scan_request - scheduled scan request description
1278 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1279 * @n_ssids: number of SSIDs
1280 * @n_channels: total number of channels to scan
1281 * @interval: interval between each scheduled scan cycle
1282 * @ie: optional information element(s) to add into Probe Request or %NULL
1283 * @ie_len: length of ie in octets
1284 * @flags: bit field of flags controlling operation
1285 * @match_sets: sets of parameters to be matched for a scan result
1286 * entry to be considered valid and to be passed to the host
1287 * (others are filtered out).
1288 * If ommited, all results are passed.
1289 * @n_match_sets: number of match sets
1290 * @wiphy: the wiphy this was for
1291 * @dev: the interface
1292 * @scan_start: start time of the scheduled scan
1293 * @channels: channels to scan
1294 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1296 struct cfg80211_sched_scan_request {
1297 struct cfg80211_ssid *ssids;
1304 struct cfg80211_match_set *match_sets;
1309 struct wiphy *wiphy;
1310 struct net_device *dev;
1311 unsigned long scan_start;
1314 struct ieee80211_channel *channels[0];
1318 * enum cfg80211_signal_type - signal type
1320 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1321 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1322 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1324 enum cfg80211_signal_type {
1325 CFG80211_SIGNAL_TYPE_NONE,
1326 CFG80211_SIGNAL_TYPE_MBM,
1327 CFG80211_SIGNAL_TYPE_UNSPEC,
1331 * struct cfg80211_bss_ie_data - BSS entry IE data
1332 * @tsf: TSF contained in the frame that carried these IEs
1333 * @rcu_head: internal use, for freeing
1334 * @len: length of the IEs
1337 struct cfg80211_bss_ies {
1339 struct rcu_head rcu_head;
1345 * struct cfg80211_bss - BSS description
1347 * This structure describes a BSS (which may also be a mesh network)
1348 * for use in scan results and similar.
1350 * @channel: channel this BSS is on
1351 * @bssid: BSSID of the BSS
1352 * @beacon_interval: the beacon interval as from the frame
1353 * @capability: the capability field in host byte order
1354 * @ies: the information elements (Note that there is no guarantee that these
1355 * are well-formed!); this is a pointer to either the beacon_ies or
1356 * proberesp_ies depending on whether Probe Response frame has been
1357 * received. It is always non-%NULL.
1358 * @beacon_ies: the information elements from the last Beacon frame
1359 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1360 * own the beacon_ies, but they're just pointers to the ones from the
1361 * @hidden_beacon_bss struct)
1362 * @proberesp_ies: the information elements from the last Probe Response frame
1363 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1364 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1365 * that holds the beacon data. @beacon_ies is still valid, of course, and
1366 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
1367 * @signal: signal strength value (type depends on the wiphy's signal_type)
1368 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1370 struct cfg80211_bss {
1371 struct ieee80211_channel *channel;
1373 const struct cfg80211_bss_ies __rcu *ies;
1374 const struct cfg80211_bss_ies __rcu *beacon_ies;
1375 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1377 struct cfg80211_bss *hidden_beacon_bss;
1381 u16 beacon_interval;
1386 u8 priv[0] __aligned(sizeof(void *));
1390 * ieee80211_bss_get_ie - find IE with given ID
1391 * @bss: the bss to search
1394 * Note that the return value is an RCU-protected pointer, so
1395 * rcu_read_lock() must be held when calling this function.
1396 * Return: %NULL if not found.
1398 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1402 * struct cfg80211_auth_request - Authentication request data
1404 * This structure provides information needed to complete IEEE 802.11
1407 * @bss: The BSS to authenticate with.
1408 * @auth_type: Authentication type (algorithm)
1409 * @ie: Extra IEs to add to Authentication frame or %NULL
1410 * @ie_len: Length of ie buffer in octets
1411 * @key_len: length of WEP key for shared key authentication
1412 * @key_idx: index of WEP key for shared key authentication
1413 * @key: WEP key for shared key authentication
1414 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1415 * Authentication transaction sequence number field.
1416 * @sae_data_len: Length of sae_data buffer in octets
1418 struct cfg80211_auth_request {
1419 struct cfg80211_bss *bss;
1422 enum nl80211_auth_type auth_type;
1424 u8 key_len, key_idx;
1426 size_t sae_data_len;
1430 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1432 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1433 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
1435 enum cfg80211_assoc_req_flags {
1436 ASSOC_REQ_DISABLE_HT = BIT(0),
1437 ASSOC_REQ_DISABLE_VHT = BIT(1),
1441 * struct cfg80211_assoc_request - (Re)Association request data
1443 * This structure provides information needed to complete IEEE 802.11
1445 * @bss: The BSS to associate with. If the call is successful the driver
1446 * is given a reference that it must release, normally via a call to
1447 * cfg80211_send_rx_assoc(), or, if association timed out, with a
1448 * call to cfg80211_put_bss() (in addition to calling
1449 * cfg80211_send_assoc_timeout())
1450 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1451 * @ie_len: Length of ie buffer in octets
1452 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1453 * @crypto: crypto settings
1454 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1455 * @flags: See &enum cfg80211_assoc_req_flags
1456 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1457 * will be used in ht_capa. Un-supported values will be ignored.
1458 * @ht_capa_mask: The bits of ht_capa which are to be used.
1459 * @vht_capa: VHT capability override
1460 * @vht_capa_mask: VHT capability mask indicating which fields to use
1462 struct cfg80211_assoc_request {
1463 struct cfg80211_bss *bss;
1464 const u8 *ie, *prev_bssid;
1466 struct cfg80211_crypto_settings crypto;
1469 struct ieee80211_ht_cap ht_capa;
1470 struct ieee80211_ht_cap ht_capa_mask;
1471 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
1475 * struct cfg80211_deauth_request - Deauthentication request data
1477 * This structure provides information needed to complete IEEE 802.11
1480 * @bssid: the BSSID of the BSS to deauthenticate from
1481 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1482 * @ie_len: Length of ie buffer in octets
1483 * @reason_code: The reason code for the deauthentication
1484 * @local_state_change: if set, change local state only and
1485 * do not set a deauth frame
1487 struct cfg80211_deauth_request {
1492 bool local_state_change;
1496 * struct cfg80211_disassoc_request - Disassociation request data
1498 * This structure provides information needed to complete IEEE 802.11
1501 * @bss: the BSS to disassociate from
1502 * @ie: Extra IEs to add to Disassociation frame or %NULL
1503 * @ie_len: Length of ie buffer in octets
1504 * @reason_code: The reason code for the disassociation
1505 * @local_state_change: This is a request for a local state only, i.e., no
1506 * Disassociation frame is to be transmitted.
1508 struct cfg80211_disassoc_request {
1509 struct cfg80211_bss *bss;
1513 bool local_state_change;
1517 * struct cfg80211_ibss_params - IBSS parameters
1519 * This structure defines the IBSS parameters for the join_ibss()
1522 * @ssid: The SSID, will always be non-null.
1523 * @ssid_len: The length of the SSID, will always be non-zero.
1524 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1525 * search for IBSSs with a different BSSID.
1526 * @chandef: defines the channel to use if no other IBSS to join can be found
1527 * @channel_fixed: The channel should be fixed -- do not search for
1528 * IBSSs to join on other channels.
1529 * @ie: information element(s) to include in the beacon
1530 * @ie_len: length of that
1531 * @beacon_interval: beacon interval to use
1532 * @privacy: this is a protected network, keys will be configured
1534 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1535 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1536 * required to assume that the port is unauthorized until authorized by
1537 * user space. Otherwise, port is marked authorized by default.
1538 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1539 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1541 struct cfg80211_ibss_params {
1544 struct cfg80211_chan_def chandef;
1546 u8 ssid_len, ie_len;
1547 u16 beacon_interval;
1552 int mcast_rate[IEEE80211_NUM_BANDS];
1556 * struct cfg80211_connect_params - Connection parameters
1558 * This structure provides information needed to complete IEEE 802.11
1559 * authentication and association.
1561 * @channel: The channel to use or %NULL if not specified (auto-select based
1563 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1566 * @ssid_len: Length of ssid in octets
1567 * @auth_type: Authentication type (algorithm)
1568 * @ie: IEs for association request
1569 * @ie_len: Length of assoc_ie in octets
1570 * @privacy: indicates whether privacy-enabled APs should be used
1571 * @mfp: indicate whether management frame protection is used
1572 * @crypto: crypto settings
1573 * @key_len: length of WEP key for shared key authentication
1574 * @key_idx: index of WEP key for shared key authentication
1575 * @key: WEP key for shared key authentication
1576 * @flags: See &enum cfg80211_assoc_req_flags
1577 * @bg_scan_period: Background scan period in seconds
1578 * or -1 to indicate that default value is to be used.
1579 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1580 * will be used in ht_capa. Un-supported values will be ignored.
1581 * @ht_capa_mask: The bits of ht_capa which are to be used.
1582 * @vht_capa: VHT Capability overrides
1583 * @vht_capa_mask: The bits of vht_capa which are to be used.
1585 struct cfg80211_connect_params {
1586 struct ieee80211_channel *channel;
1590 enum nl80211_auth_type auth_type;
1594 enum nl80211_mfp mfp;
1595 struct cfg80211_crypto_settings crypto;
1597 u8 key_len, key_idx;
1600 struct ieee80211_ht_cap ht_capa;
1601 struct ieee80211_ht_cap ht_capa_mask;
1602 struct ieee80211_vht_cap vht_capa;
1603 struct ieee80211_vht_cap vht_capa_mask;
1607 * enum wiphy_params_flags - set_wiphy_params bitfield values
1608 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1609 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1610 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1611 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1612 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1614 enum wiphy_params_flags {
1615 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1616 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1617 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1618 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1619 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1623 * cfg80211_bitrate_mask - masks for bitrate control
1625 struct cfg80211_bitrate_mask {
1628 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1629 } control[IEEE80211_NUM_BANDS];
1632 * struct cfg80211_pmksa - PMK Security Association
1634 * This structure is passed to the set/del_pmksa() method for PMKSA
1637 * @bssid: The AP's BSSID.
1638 * @pmkid: The PMK material itself.
1640 struct cfg80211_pmksa {
1646 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1647 * @mask: bitmask where to match pattern and where to ignore bytes,
1648 * one bit per byte, in same format as nl80211
1649 * @pattern: bytes to match where bitmask is 1
1650 * @pattern_len: length of pattern (in bytes)
1651 * @pkt_offset: packet offset (in bytes)
1653 * Internal note: @mask and @pattern are allocated in one chunk of
1654 * memory, free @mask only!
1656 struct cfg80211_wowlan_trig_pkt_pattern {
1663 * struct cfg80211_wowlan_tcp - TCP connection parameters
1665 * @sock: (internal) socket for source port allocation
1666 * @src: source IP address
1667 * @dst: destination IP address
1668 * @dst_mac: destination MAC address
1669 * @src_port: source port
1670 * @dst_port: destination port
1671 * @payload_len: data payload length
1672 * @payload: data payload buffer
1673 * @payload_seq: payload sequence stamping configuration
1674 * @data_interval: interval at which to send data packets
1675 * @wake_len: wakeup payload match length
1676 * @wake_data: wakeup payload match data
1677 * @wake_mask: wakeup payload match mask
1678 * @tokens_size: length of the tokens buffer
1679 * @payload_tok: payload token usage configuration
1681 struct cfg80211_wowlan_tcp {
1682 struct socket *sock;
1684 u16 src_port, dst_port;
1685 u8 dst_mac[ETH_ALEN];
1688 struct nl80211_wowlan_tcp_data_seq payload_seq;
1691 const u8 *wake_data, *wake_mask;
1693 /* must be last, variable member */
1694 struct nl80211_wowlan_tcp_data_token payload_tok;
1698 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1700 * This structure defines the enabled WoWLAN triggers for the device.
1701 * @any: wake up on any activity -- special trigger if device continues
1702 * operating as normal during suspend
1703 * @disconnect: wake up if getting disconnected
1704 * @magic_pkt: wake up on receiving magic packet
1705 * @patterns: wake up on receiving packet matching a pattern
1706 * @n_patterns: number of patterns
1707 * @gtk_rekey_failure: wake up on GTK rekey failure
1708 * @eap_identity_req: wake up on EAP identity request packet
1709 * @four_way_handshake: wake up on 4-way handshake
1710 * @rfkill_release: wake up when rfkill is released
1711 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
1712 * NULL if not configured.
1714 struct cfg80211_wowlan {
1715 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1716 eap_identity_req, four_way_handshake,
1718 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1719 struct cfg80211_wowlan_tcp *tcp;
1724 * struct cfg80211_wowlan_wakeup - wakeup report
1725 * @disconnect: woke up by getting disconnected
1726 * @magic_pkt: woke up by receiving magic packet
1727 * @gtk_rekey_failure: woke up by GTK rekey failure
1728 * @eap_identity_req: woke up by EAP identity request packet
1729 * @four_way_handshake: woke up by 4-way handshake
1730 * @rfkill_release: woke up by rfkill being released
1731 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
1732 * @packet_present_len: copied wakeup packet data
1733 * @packet_len: original wakeup packet length
1734 * @packet: The packet causing the wakeup, if any.
1735 * @packet_80211: For pattern match, magic packet and other data
1736 * frame triggers an 802.3 frame should be reported, for
1737 * disconnect due to deauth 802.11 frame. This indicates which
1739 * @tcp_match: TCP wakeup packet received
1740 * @tcp_connlost: TCP connection lost or failed to establish
1741 * @tcp_nomoretokens: TCP data ran out of tokens
1743 struct cfg80211_wowlan_wakeup {
1744 bool disconnect, magic_pkt, gtk_rekey_failure,
1745 eap_identity_req, four_way_handshake,
1746 rfkill_release, packet_80211,
1747 tcp_match, tcp_connlost, tcp_nomoretokens;
1749 u32 packet_present_len, packet_len;
1754 * struct cfg80211_gtk_rekey_data - rekey data
1755 * @kek: key encryption key
1756 * @kck: key confirmation key
1757 * @replay_ctr: replay counter
1759 struct cfg80211_gtk_rekey_data {
1760 u8 kek[NL80211_KEK_LEN];
1761 u8 kck[NL80211_KCK_LEN];
1762 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1766 * struct cfg80211_ops - backend description for wireless configuration
1768 * This struct is registered by fullmac card drivers and/or wireless stacks
1769 * in order to handle configuration requests on their interfaces.
1771 * All callbacks except where otherwise noted should return 0
1772 * on success or a negative error code.
1774 * All operations are currently invoked under rtnl for consistency with the
1775 * wireless extensions but this is subject to reevaluation as soon as this
1776 * code is used more widely and we have a first user without wext.
1778 * @suspend: wiphy device needs to be suspended. The variable @wow will
1779 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1780 * configured for the device.
1781 * @resume: wiphy device needs to be resumed
1782 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1783 * to call device_set_wakeup_enable() to enable/disable wakeup from
1786 * @add_virtual_intf: create a new virtual interface with the given name,
1787 * must set the struct wireless_dev's iftype. Beware: You must create
1788 * the new netdev in the wiphy's network namespace! Returns the struct
1789 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
1790 * also set the address member in the wdev.
1792 * @del_virtual_intf: remove the virtual interface
1794 * @change_virtual_intf: change type/configuration of virtual interface,
1795 * keep the struct wireless_dev's iftype updated.
1797 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1798 * when adding a group key.
1800 * @get_key: get information about the key with the given parameters.
1801 * @mac_addr will be %NULL when requesting information for a group
1802 * key. All pointers given to the @callback function need not be valid
1803 * after it returns. This function should return an error if it is
1804 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1806 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1807 * and @key_index, return -ENOENT if the key doesn't exist.
1809 * @set_default_key: set the default key on an interface
1811 * @set_default_mgmt_key: set the default management frame key on an interface
1813 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1815 * @start_ap: Start acting in AP mode defined by the parameters.
1816 * @change_beacon: Change the beacon parameters for an access point mode
1817 * interface. This should reject the call when AP mode wasn't started.
1818 * @stop_ap: Stop being an AP, including stopping beaconing.
1820 * @add_station: Add a new station.
1821 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1822 * @change_station: Modify a given station. Note that flags changes are not much
1823 * validated in cfg80211, in particular the auth/assoc/authorized flags
1824 * might come to the driver in invalid combinations -- make sure to check
1825 * them, also against the existing state! Drivers must call
1826 * cfg80211_check_station_change() to validate the information.
1827 * @get_station: get station information for the station identified by @mac
1828 * @dump_station: dump station callback -- resume dump at index @idx
1830 * @add_mpath: add a fixed mesh path
1831 * @del_mpath: delete a given mesh path
1832 * @change_mpath: change a given mesh path
1833 * @get_mpath: get a mesh path for the given parameters
1834 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1835 * @join_mesh: join the mesh network with the specified parameters
1836 * @leave_mesh: leave the current mesh network
1838 * @get_mesh_config: Get the current mesh configuration
1840 * @update_mesh_config: Update mesh parameters on a running mesh.
1841 * The mask is a bitfield which tells us which parameters to
1842 * set, and which to leave alone.
1844 * @change_bss: Modify parameters for a given BSS.
1846 * @set_txq_params: Set TX queue parameters
1848 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
1849 * as it doesn't implement join_mesh and needs to set the channel to
1850 * join the mesh instead.
1852 * @set_monitor_channel: Set the monitor mode channel for the device. If other
1853 * interfaces are active this callback should reject the configuration.
1854 * If no interfaces are active or the device is down, the channel should
1855 * be stored for when a monitor interface becomes active.
1857 * @scan: Request to do a scan. If returning zero, the scan request is given
1858 * the driver, and will be valid until passed to cfg80211_scan_done().
1859 * For scan results, call cfg80211_inform_bss(); you can call this outside
1860 * the scan/scan_done bracket too.
1862 * @auth: Request to authenticate with the specified peer
1863 * @assoc: Request to (re)associate with the specified peer
1864 * @deauth: Request to deauthenticate from the specified peer
1865 * @disassoc: Request to disassociate from the specified peer
1867 * @connect: Connect to the ESS with the specified parameters. When connected,
1868 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1869 * If the connection fails for some reason, call cfg80211_connect_result()
1870 * with the status from the AP.
1871 * @disconnect: Disconnect from the BSS/ESS.
1873 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1874 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1876 * @leave_ibss: Leave the IBSS.
1878 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
1881 * @set_wiphy_params: Notify that wiphy parameters have changed;
1882 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1883 * have changed. The actual parameter values are available in
1884 * struct wiphy. If returning an error, no value should be changed.
1886 * @set_tx_power: set the transmit power according to the parameters,
1887 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
1888 * wdev may be %NULL if power was set for the wiphy, and will
1889 * always be %NULL unless the driver supports per-vif TX power
1890 * (as advertised by the nl80211 feature flag.)
1891 * @get_tx_power: store the current TX power into the dbm variable;
1892 * return 0 if successful
1894 * @set_wds_peer: set the WDS peer for a WDS interface
1896 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1897 * functions to adjust rfkill hw state
1899 * @dump_survey: get site survey information.
1901 * @remain_on_channel: Request the driver to remain awake on the specified
1902 * channel for the specified duration to complete an off-channel
1903 * operation (e.g., public action frame exchange). When the driver is
1904 * ready on the requested channel, it must indicate this with an event
1905 * notification by calling cfg80211_ready_on_channel().
1906 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1907 * This allows the operation to be terminated prior to timeout based on
1908 * the duration value.
1909 * @mgmt_tx: Transmit a management frame.
1910 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1911 * frame on another channel
1913 * @testmode_cmd: run a test mode command
1914 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1915 * used by the function, but 0 and 1 must not be touched. Additionally,
1916 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1917 * dump and return to userspace with an error, so be careful. If any data
1918 * was passed in from userspace then the data/len arguments will be present
1919 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1921 * @set_bitrate_mask: set the bitrate mask configuration
1923 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1924 * devices running firmwares capable of generating the (re) association
1925 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1926 * @del_pmksa: Delete a cached PMKID.
1927 * @flush_pmksa: Flush all cached PMKIDs.
1928 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1929 * allows the driver to adjust the dynamic ps timeout value.
1930 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1931 * @set_cqm_txe_config: Configure connection quality monitor TX error
1933 * @sched_scan_start: Tell the driver to start a scheduled scan.
1934 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan.
1936 * @mgmt_frame_register: Notify driver that a management frame type was
1937 * registered. Note that this callback may not sleep, and cannot run
1938 * concurrently with itself.
1940 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1941 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1942 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1943 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1945 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1947 * @set_ringparam: Set tx and rx ring sizes.
1949 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1951 * @tdls_mgmt: Transmit a TDLS management frame.
1952 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1954 * @probe_client: probe an associated client, must return a cookie that it
1955 * later passes to cfg80211_probe_status().
1957 * @set_noack_map: Set the NoAck Map for the TIDs.
1959 * @get_et_sset_count: Ethtool API to get string-set count.
1960 * See @ethtool_ops.get_sset_count
1962 * @get_et_stats: Ethtool API to get a set of u64 stats.
1963 * See @ethtool_ops.get_ethtool_stats
1965 * @get_et_strings: Ethtool API to get a set of strings to describe stats
1966 * and perhaps other supported types of ethtool data-sets.
1967 * See @ethtool_ops.get_strings
1969 * @get_channel: Get the current operating channel for the virtual interface.
1970 * For monitor interfaces, it should return %NULL unless there's a single
1971 * current monitoring channel.
1973 * @start_p2p_device: Start the given P2P device.
1974 * @stop_p2p_device: Stop the given P2P device.
1976 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
1977 * Parameters include ACL policy, an array of MAC address of stations
1978 * and the number of MAC addresses. If there is already a list in driver
1979 * this new list replaces the existing one. Driver has to clear its ACL
1980 * when number of MAC addresses entries is passed as 0. Drivers which
1981 * advertise the support for MAC based ACL have to implement this callback.
1983 * @start_radar_detection: Start radar detection in the driver.
1985 struct cfg80211_ops {
1986 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1987 int (*resume)(struct wiphy *wiphy);
1988 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
1990 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
1992 enum nl80211_iftype type,
1994 struct vif_params *params);
1995 int (*del_virtual_intf)(struct wiphy *wiphy,
1996 struct wireless_dev *wdev);
1997 int (*change_virtual_intf)(struct wiphy *wiphy,
1998 struct net_device *dev,
1999 enum nl80211_iftype type, u32 *flags,
2000 struct vif_params *params);
2002 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
2003 u8 key_index, bool pairwise, const u8 *mac_addr,
2004 struct key_params *params);
2005 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
2006 u8 key_index, bool pairwise, const u8 *mac_addr,
2008 void (*callback)(void *cookie, struct key_params*));
2009 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
2010 u8 key_index, bool pairwise, const u8 *mac_addr);
2011 int (*set_default_key)(struct wiphy *wiphy,
2012 struct net_device *netdev,
2013 u8 key_index, bool unicast, bool multicast);
2014 int (*set_default_mgmt_key)(struct wiphy *wiphy,
2015 struct net_device *netdev,
2018 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
2019 struct cfg80211_ap_settings *settings);
2020 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
2021 struct cfg80211_beacon_data *info);
2022 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
2025 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
2026 u8 *mac, struct station_parameters *params);
2027 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
2029 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
2030 u8 *mac, struct station_parameters *params);
2031 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
2032 u8 *mac, struct station_info *sinfo);
2033 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
2034 int idx, u8 *mac, struct station_info *sinfo);
2036 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
2037 u8 *dst, u8 *next_hop);
2038 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
2040 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
2041 u8 *dst, u8 *next_hop);
2042 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
2043 u8 *dst, u8 *next_hop,
2044 struct mpath_info *pinfo);
2045 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
2046 int idx, u8 *dst, u8 *next_hop,
2047 struct mpath_info *pinfo);
2048 int (*get_mesh_config)(struct wiphy *wiphy,
2049 struct net_device *dev,
2050 struct mesh_config *conf);
2051 int (*update_mesh_config)(struct wiphy *wiphy,
2052 struct net_device *dev, u32 mask,
2053 const struct mesh_config *nconf);
2054 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
2055 const struct mesh_config *conf,
2056 const struct mesh_setup *setup);
2057 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
2059 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
2060 struct bss_parameters *params);
2062 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
2063 struct ieee80211_txq_params *params);
2065 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
2066 struct net_device *dev,
2067 struct ieee80211_channel *chan);
2069 int (*set_monitor_channel)(struct wiphy *wiphy,
2070 struct cfg80211_chan_def *chandef);
2072 int (*scan)(struct wiphy *wiphy,
2073 struct cfg80211_scan_request *request);
2075 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
2076 struct cfg80211_auth_request *req);
2077 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
2078 struct cfg80211_assoc_request *req);
2079 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
2080 struct cfg80211_deauth_request *req);
2081 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
2082 struct cfg80211_disassoc_request *req);
2084 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
2085 struct cfg80211_connect_params *sme);
2086 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
2089 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
2090 struct cfg80211_ibss_params *params);
2091 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
2093 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
2094 int rate[IEEE80211_NUM_BANDS]);
2096 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
2098 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2099 enum nl80211_tx_power_setting type, int mbm);
2100 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
2103 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
2106 void (*rfkill_poll)(struct wiphy *wiphy);
2108 #ifdef CONFIG_NL80211_TESTMODE
2109 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
2110 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
2111 struct netlink_callback *cb,
2112 void *data, int len);
2115 int (*set_bitrate_mask)(struct wiphy *wiphy,
2116 struct net_device *dev,
2118 const struct cfg80211_bitrate_mask *mask);
2120 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
2121 int idx, struct survey_info *info);
2123 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2124 struct cfg80211_pmksa *pmksa);
2125 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
2126 struct cfg80211_pmksa *pmksa);
2127 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
2129 int (*remain_on_channel)(struct wiphy *wiphy,
2130 struct wireless_dev *wdev,
2131 struct ieee80211_channel *chan,
2132 unsigned int duration,
2134 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
2135 struct wireless_dev *wdev,
2138 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
2139 struct ieee80211_channel *chan, bool offchan,
2140 unsigned int wait, const u8 *buf, size_t len,
2141 bool no_cck, bool dont_wait_for_ack, u64 *cookie);
2142 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
2143 struct wireless_dev *wdev,
2146 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2147 bool enabled, int timeout);
2149 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
2150 struct net_device *dev,
2151 s32 rssi_thold, u32 rssi_hyst);
2153 int (*set_cqm_txe_config)(struct wiphy *wiphy,
2154 struct net_device *dev,
2155 u32 rate, u32 pkts, u32 intvl);
2157 void (*mgmt_frame_register)(struct wiphy *wiphy,
2158 struct wireless_dev *wdev,
2159 u16 frame_type, bool reg);
2161 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
2162 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
2164 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
2165 void (*get_ringparam)(struct wiphy *wiphy,
2166 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2168 int (*sched_scan_start)(struct wiphy *wiphy,
2169 struct net_device *dev,
2170 struct cfg80211_sched_scan_request *request);
2171 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
2173 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
2174 struct cfg80211_gtk_rekey_data *data);
2176 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
2177 u8 *peer, u8 action_code, u8 dialog_token,
2178 u16 status_code, const u8 *buf, size_t len);
2179 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
2180 u8 *peer, enum nl80211_tdls_operation oper);
2182 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
2183 const u8 *peer, u64 *cookie);
2185 int (*set_noack_map)(struct wiphy *wiphy,
2186 struct net_device *dev,
2189 int (*get_et_sset_count)(struct wiphy *wiphy,
2190 struct net_device *dev, int sset);
2191 void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
2192 struct ethtool_stats *stats, u64 *data);
2193 void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
2194 u32 sset, u8 *data);
2196 int (*get_channel)(struct wiphy *wiphy,
2197 struct wireless_dev *wdev,
2198 struct cfg80211_chan_def *chandef);
2200 int (*start_p2p_device)(struct wiphy *wiphy,
2201 struct wireless_dev *wdev);
2202 void (*stop_p2p_device)(struct wiphy *wiphy,
2203 struct wireless_dev *wdev);
2205 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
2206 const struct cfg80211_acl_data *params);
2208 int (*start_radar_detection)(struct wiphy *wiphy,
2209 struct net_device *dev,
2210 struct cfg80211_chan_def *chandef);
2214 * wireless hardware and networking interfaces structures
2215 * and registration/helper functions
2219 * enum wiphy_flags - wiphy capability flags
2221 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
2222 * has its own custom regulatory domain and cannot identify the
2223 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
2224 * we will disregard the first regulatory hint (when the
2225 * initiator is %REGDOM_SET_BY_CORE).
2226 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
2227 * ignore regulatory domain settings until it gets its own regulatory
2228 * domain via its regulatory_hint() unless the regulatory hint is
2229 * from a country IE. After its gets its own regulatory domain it will
2230 * only allow further regulatory domain settings to further enhance
2231 * compliance. For example if channel 13 and 14 are disabled by this
2232 * regulatory domain no user regulatory domain can enable these channels
2233 * at a later time. This can be used for devices which do not have
2234 * calibration information guaranteed for frequencies or settings
2235 * outside of its regulatory domain. If used in combination with
2236 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
2238 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
2239 * that passive scan flags and beaconing flags may not be lifted by
2240 * cfg80211 due to regulatory beacon hints. For more information on beacon
2241 * hints read the documenation for regulatory_hint_found_beacon()
2242 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
2244 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
2245 * by default -- this flag will be set depending on the kernel's default
2246 * on wiphy_new(), but can be changed by the driver if it has a good
2247 * reason to override the default
2248 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
2249 * on a VLAN interface)
2250 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
2251 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
2252 * control port protocol ethertype. The device also honours the
2253 * control_port_no_encrypt flag.
2254 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
2255 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
2256 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
2257 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
2258 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
2260 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
2261 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
2262 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
2263 * link setup/discovery operations internally. Setup, discovery and
2264 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
2265 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
2266 * used for asking the driver/firmware to perform a TDLS operation.
2267 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
2268 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
2269 * when there are virtual interfaces in AP mode by calling
2270 * cfg80211_report_obss_beacon().
2271 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
2272 * responds to probe-requests in hardware.
2273 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
2274 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
2277 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
2278 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
2279 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
2280 WIPHY_FLAG_NETNS_OK = BIT(3),
2281 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
2282 WIPHY_FLAG_4ADDR_AP = BIT(5),
2283 WIPHY_FLAG_4ADDR_STATION = BIT(6),
2284 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
2285 WIPHY_FLAG_IBSS_RSN = BIT(8),
2286 WIPHY_FLAG_MESH_AUTH = BIT(10),
2287 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
2288 /* use hole at 12 */
2289 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
2290 WIPHY_FLAG_AP_UAPSD = BIT(14),
2291 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
2292 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
2293 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
2294 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
2295 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
2296 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
2297 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
2301 * struct ieee80211_iface_limit - limit on certain interface types
2302 * @max: maximum number of interfaces of these types
2303 * @types: interface types (bits)
2305 struct ieee80211_iface_limit {
2311 * struct ieee80211_iface_combination - possible interface combination
2312 * @limits: limits for the given interface types
2313 * @n_limits: number of limitations
2314 * @num_different_channels: can use up to this many different channels
2315 * @max_interfaces: maximum number of interfaces in total allowed in this
2317 * @beacon_int_infra_match: In this combination, the beacon intervals
2318 * between infrastructure and AP types must match. This is required
2319 * only in special cases.
2320 * @radar_detect_widths: bitmap of channel widths supported for radar detection
2322 * These examples can be expressed as follows:
2324 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
2326 * struct ieee80211_iface_limit limits1[] = {
2327 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2328 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
2330 * struct ieee80211_iface_combination combination1 = {
2331 * .limits = limits1,
2332 * .n_limits = ARRAY_SIZE(limits1),
2333 * .max_interfaces = 2,
2334 * .beacon_int_infra_match = true,
2338 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
2340 * struct ieee80211_iface_limit limits2[] = {
2341 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
2342 * BIT(NL80211_IFTYPE_P2P_GO), },
2344 * struct ieee80211_iface_combination combination2 = {
2345 * .limits = limits2,
2346 * .n_limits = ARRAY_SIZE(limits2),
2347 * .max_interfaces = 8,
2348 * .num_different_channels = 1,
2352 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2353 * This allows for an infrastructure connection and three P2P connections.
2355 * struct ieee80211_iface_limit limits3[] = {
2356 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2357 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2358 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2360 * struct ieee80211_iface_combination combination3 = {
2361 * .limits = limits3,
2362 * .n_limits = ARRAY_SIZE(limits3),
2363 * .max_interfaces = 4,
2364 * .num_different_channels = 2,
2367 struct ieee80211_iface_combination {
2368 const struct ieee80211_iface_limit *limits;
2369 u32 num_different_channels;
2372 bool beacon_int_infra_match;
2373 u8 radar_detect_widths;
2376 struct ieee80211_txrx_stypes {
2381 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2382 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2383 * trigger that keeps the device operating as-is and
2384 * wakes up the host on any activity, for example a
2385 * received packet that passed filtering; note that the
2386 * packet should be preserved in that case
2387 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2389 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2390 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2391 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2392 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2393 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2394 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2396 enum wiphy_wowlan_support_flags {
2397 WIPHY_WOWLAN_ANY = BIT(0),
2398 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2399 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2400 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2401 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2402 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2403 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2404 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2407 struct wiphy_wowlan_tcp_support {
2408 const struct nl80211_wowlan_tcp_data_token_feature *tok;
2409 u32 data_payload_max;
2410 u32 data_interval_max;
2411 u32 wake_payload_max;
2416 * struct wiphy_wowlan_support - WoWLAN support data
2417 * @flags: see &enum wiphy_wowlan_support_flags
2418 * @n_patterns: number of supported wakeup patterns
2419 * (see nl80211.h for the pattern definition)
2420 * @pattern_max_len: maximum length of each pattern
2421 * @pattern_min_len: minimum length of each pattern
2422 * @max_pkt_offset: maximum Rx packet offset
2423 * @tcp: TCP wakeup support information
2425 struct wiphy_wowlan_support {
2428 int pattern_max_len;
2429 int pattern_min_len;
2431 const struct wiphy_wowlan_tcp_support *tcp;
2435 * struct wiphy - wireless hardware description
2436 * @reg_notifier: the driver's regulatory notification callback,
2437 * note that if your driver uses wiphy_apply_custom_regulatory()
2438 * the reg_notifier's request can be passed as NULL
2439 * @regd: the driver's regulatory domain, if one was requested via
2440 * the regulatory_hint() API. This can be used by the driver
2441 * on the reg_notifier() if it chooses to ignore future
2442 * regulatory domain changes caused by other drivers.
2443 * @signal_type: signal type reported in &struct cfg80211_bss.
2444 * @cipher_suites: supported cipher suites
2445 * @n_cipher_suites: number of supported cipher suites
2446 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2447 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2448 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2449 * -1 = fragmentation disabled, only odd values >= 256 used
2450 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2451 * @_net: the network namespace this wiphy currently lives in
2452 * @perm_addr: permanent MAC address of this device
2453 * @addr_mask: If the device supports multiple MAC addresses by masking,
2454 * set this to a mask with variable bits set to 1, e.g. if the last
2455 * four bits are variable then set it to 00:...:00:0f. The actual
2456 * variable bits shall be determined by the interfaces added, with
2457 * interfaces not matching the mask being rejected to be brought up.
2458 * @n_addresses: number of addresses in @addresses.
2459 * @addresses: If the device has more than one address, set this pointer
2460 * to a list of addresses (6 bytes each). The first one will be used
2461 * by default for perm_addr. In this case, the mask should be set to
2462 * all-zeroes. In this case it is assumed that the device can handle
2463 * the same number of arbitrary MAC addresses.
2464 * @registered: protects ->resume and ->suspend sysfs callbacks against
2465 * unregister hardware
2466 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2467 * automatically on wiphy renames
2468 * @dev: (virtual) struct device for this wiphy
2469 * @registered: helps synchronize suspend/resume with wiphy unregister
2470 * @wext: wireless extension handlers
2471 * @priv: driver private data (sized according to wiphy_new() parameter)
2472 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2473 * must be set by driver
2474 * @iface_combinations: Valid interface combinations array, should not
2475 * list single interface types.
2476 * @n_iface_combinations: number of entries in @iface_combinations array.
2477 * @software_iftypes: bitmask of software interface types, these are not
2478 * subject to any restrictions since they are purely managed in SW.
2479 * @flags: wiphy flags, see &enum wiphy_flags
2480 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2481 * @bss_priv_size: each BSS struct has private data allocated with it,
2482 * this variable determines its size
2483 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2485 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2486 * for in any given scheduled scan
2487 * @max_match_sets: maximum number of match sets the device can handle
2488 * when performing a scheduled scan, 0 if filtering is not
2490 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2491 * add to probe request frames transmitted during a scan, must not
2492 * include fixed IEs like supported rates
2493 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2495 * @coverage_class: current coverage class
2496 * @fw_version: firmware version for ethtool reporting
2497 * @hw_version: hardware version for ethtool reporting
2498 * @max_num_pmkids: maximum number of PMKIDs supported by device
2499 * @privid: a pointer that drivers can use to identify if an arbitrary
2500 * wiphy is theirs, e.g. in global notifiers
2501 * @bands: information about bands/channels supported by this device
2503 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2504 * transmitted through nl80211, points to an array indexed by interface
2507 * @available_antennas_tx: bitmap of antennas which are available to be
2508 * configured as TX antennas. Antenna configuration commands will be
2509 * rejected unless this or @available_antennas_rx is set.
2511 * @available_antennas_rx: bitmap of antennas which are available to be
2512 * configured as RX antennas. Antenna configuration commands will be
2513 * rejected unless this or @available_antennas_tx is set.
2515 * @probe_resp_offload:
2516 * Bitmap of supported protocols for probe response offloading.
2517 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2518 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2520 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2521 * may request, if implemented.
2523 * @wowlan: WoWLAN support information
2525 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2526 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2527 * If null, then none can be over-ridden.
2528 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
2529 * If null, then none can be over-ridden.
2531 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
2534 * @extended_capabilities: extended capabilities supported by the driver,
2535 * additional capabilities might be supported by userspace; these are
2536 * the 802.11 extended capabilities ("Extended Capabilities element")
2537 * and are in the same format as in the information element. See
2538 * 802.11-2012 8.4.2.29 for the defined fields.
2539 * @extended_capabilities_mask: mask of the valid values
2540 * @extended_capabilities_len: length of the extended capabilities
2543 /* assign these fields before you register the wiphy */
2545 /* permanent MAC address(es) */
2546 u8 perm_addr[ETH_ALEN];
2547 u8 addr_mask[ETH_ALEN];
2549 struct mac_address *addresses;
2551 const struct ieee80211_txrx_stypes *mgmt_stypes;
2553 const struct ieee80211_iface_combination *iface_combinations;
2554 int n_iface_combinations;
2555 u16 software_iftypes;
2559 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2560 u16 interface_modes;
2562 u16 max_acl_mac_addrs;
2564 u32 flags, features;
2568 enum cfg80211_signal_type signal_type;
2572 u8 max_sched_scan_ssids;
2574 u16 max_scan_ie_len;
2575 u16 max_sched_scan_ie_len;
2577 int n_cipher_suites;
2578 const u32 *cipher_suites;
2586 char fw_version[ETHTOOL_FWVERS_LEN];
2590 struct wiphy_wowlan_support wowlan;
2593 u16 max_remain_on_channel_duration;
2597 u32 available_antennas_tx;
2598 u32 available_antennas_rx;
2601 * Bitmap of supported protocols for probe response offloading
2602 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2603 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2605 u32 probe_resp_offload;
2607 const u8 *extended_capabilities, *extended_capabilities_mask;
2608 u8 extended_capabilities_len;
2610 /* If multiple wiphys are registered and you're handed e.g.
2611 * a regular netdev with assigned ieee80211_ptr, you won't
2612 * know whether it points to a wiphy your driver has registered
2613 * or not. Assign this to something global to your driver to
2614 * help determine whether you own this wiphy or not. */
2617 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2619 /* Lets us get back the wiphy on the callback */
2620 void (*reg_notifier)(struct wiphy *wiphy,
2621 struct regulatory_request *request);
2623 /* fields below are read-only, assigned by cfg80211 */
2625 const struct ieee80211_regdomain __rcu *regd;
2627 /* the item in /sys/class/ieee80211/ points to this,
2628 * you need use set_wiphy_dev() (see below) */
2631 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2634 /* dir in debugfs: ieee80211/<wiphyname> */
2635 struct dentry *debugfsdir;
2637 const struct ieee80211_ht_cap *ht_capa_mod_mask;
2638 const struct ieee80211_vht_cap *vht_capa_mod_mask;
2640 #ifdef CONFIG_NET_NS
2641 /* the network namespace this phy lives in currently */
2645 #ifdef CONFIG_CFG80211_WEXT
2646 const struct iw_handler_def *wext;
2649 char priv[0] __aligned(NETDEV_ALIGN);
2652 static inline struct net *wiphy_net(struct wiphy *wiphy)
2654 return read_pnet(&wiphy->_net);
2657 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2659 write_pnet(&wiphy->_net, net);
2663 * wiphy_priv - return priv from wiphy
2665 * @wiphy: the wiphy whose priv pointer to return
2666 * Return: The priv of @wiphy.
2668 static inline void *wiphy_priv(struct wiphy *wiphy)
2671 return &wiphy->priv;
2675 * priv_to_wiphy - return the wiphy containing the priv
2677 * @priv: a pointer previously returned by wiphy_priv
2678 * Return: The wiphy of @priv.
2680 static inline struct wiphy *priv_to_wiphy(void *priv)
2683 return container_of(priv, struct wiphy, priv);
2687 * set_wiphy_dev - set device pointer for wiphy
2689 * @wiphy: The wiphy whose device to bind
2690 * @dev: The device to parent it to
2692 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2694 wiphy->dev.parent = dev;
2698 * wiphy_dev - get wiphy dev pointer
2700 * @wiphy: The wiphy whose device struct to look up
2701 * Return: The dev of @wiphy.
2703 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2705 return wiphy->dev.parent;
2709 * wiphy_name - get wiphy name
2711 * @wiphy: The wiphy whose name to return
2712 * Return: The name of @wiphy.
2714 static inline const char *wiphy_name(const struct wiphy *wiphy)
2716 return dev_name(&wiphy->dev);
2720 * wiphy_new - create a new wiphy for use with cfg80211
2722 * @ops: The configuration operations for this device
2723 * @sizeof_priv: The size of the private area to allocate
2725 * Create a new wiphy and associate the given operations with it.
2726 * @sizeof_priv bytes are allocated for private use.
2728 * Return: A pointer to the new wiphy. This pointer must be
2729 * assigned to each netdev's ieee80211_ptr for proper operation.
2731 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2734 * wiphy_register - register a wiphy with cfg80211
2736 * @wiphy: The wiphy to register.
2738 * Return: A non-negative wiphy index or a negative error code.
2740 extern int wiphy_register(struct wiphy *wiphy);
2743 * wiphy_unregister - deregister a wiphy from cfg80211
2745 * @wiphy: The wiphy to unregister.
2747 * After this call, no more requests can be made with this priv
2748 * pointer, but the call may sleep to wait for an outstanding
2749 * request that is being handled.
2751 extern void wiphy_unregister(struct wiphy *wiphy);
2754 * wiphy_free - free wiphy
2756 * @wiphy: The wiphy to free
2758 extern void wiphy_free(struct wiphy *wiphy);
2760 /* internal structs */
2761 struct cfg80211_conn;
2762 struct cfg80211_internal_bss;
2763 struct cfg80211_cached_keys;
2766 * struct wireless_dev - wireless device state
2768 * For netdevs, this structure must be allocated by the driver
2769 * that uses the ieee80211_ptr field in struct net_device (this
2770 * is intentional so it can be allocated along with the netdev.)
2771 * It need not be registered then as netdev registration will
2772 * be intercepted by cfg80211 to see the new wireless device.
2774 * For non-netdev uses, it must also be allocated by the driver
2775 * in response to the cfg80211 callbacks that require it, as
2776 * there's no netdev registration in that case it may not be
2777 * allocated outside of callback operations that return it.
2779 * @wiphy: pointer to hardware description
2780 * @iftype: interface type
2781 * @list: (private) Used to collect the interfaces
2782 * @netdev: (private) Used to reference back to the netdev, may be %NULL
2783 * @identifier: (private) Identifier used in nl80211 to identify this
2784 * wireless device if it has no netdev
2785 * @current_bss: (private) Used by the internal configuration code
2786 * @channel: (private) Used by the internal configuration code to track
2787 * the user-set AP, monitor and WDS channel
2788 * @preset_chan: (private) Used by the internal configuration code to
2789 * track the channel to be used for AP later
2790 * @bssid: (private) Used by the internal configuration code
2791 * @ssid: (private) Used by the internal configuration code
2792 * @ssid_len: (private) Used by the internal configuration code
2793 * @mesh_id_len: (private) Used by the internal configuration code
2794 * @mesh_id_up_len: (private) Used by the internal configuration code
2795 * @wext: (private) Used by the internal wireless extensions compat code
2796 * @use_4addr: indicates 4addr mode is used on this interface, must be
2797 * set by driver (if supported) on add_interface BEFORE registering the
2798 * netdev and may otherwise be used by driver read-only, will be update
2799 * by cfg80211 on change_interface
2800 * @mgmt_registrations: list of registrations for management frames
2801 * @mgmt_registrations_lock: lock for the list
2802 * @mtx: mutex used to lock data in this struct
2803 * @cleanup_work: work struct used for cleanup that can't be done directly
2804 * @beacon_interval: beacon interval used on this device for transmitting
2805 * beacons, 0 when not valid
2806 * @address: The address for this device, valid only if @netdev is %NULL
2807 * @p2p_started: true if this is a P2P Device that has been started
2808 * @cac_started: true if DFS channel availability check has been started
2809 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
2811 struct wireless_dev {
2812 struct wiphy *wiphy;
2813 enum nl80211_iftype iftype;
2815 /* the remainder of this struct should be private to cfg80211 */
2816 struct list_head list;
2817 struct net_device *netdev;
2821 struct list_head mgmt_registrations;
2822 spinlock_t mgmt_registrations_lock;
2826 struct work_struct cleanup_work;
2828 bool use_4addr, p2p_started;
2830 u8 address[ETH_ALEN] __aligned(sizeof(u16));
2832 /* currently used for IBSS and SME - might be rearranged later */
2833 u8 ssid[IEEE80211_MAX_SSID_LEN];
2834 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2837 CFG80211_SME_CONNECTING,
2838 CFG80211_SME_CONNECTED,
2840 struct cfg80211_conn *conn;
2841 struct cfg80211_cached_keys *connect_keys;
2843 struct list_head event_list;
2844 spinlock_t event_lock;
2846 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2847 struct cfg80211_chan_def preset_chandef;
2849 /* for AP and mesh channel tracking */
2850 struct ieee80211_channel *channel;
2857 int beacon_interval;
2859 u32 ap_unexpected_nlportid;
2862 unsigned long cac_start_time;
2864 #ifdef CONFIG_CFG80211_WEXT
2867 struct cfg80211_ibss_params ibss;
2868 struct cfg80211_connect_params connect;
2869 struct cfg80211_cached_keys *keys;
2872 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2873 u8 ssid[IEEE80211_MAX_SSID_LEN];
2874 s8 default_key, default_mgmt_key;
2875 bool prev_bssid_valid;
2880 static inline u8 *wdev_address(struct wireless_dev *wdev)
2883 return wdev->netdev->dev_addr;
2884 return wdev->address;
2888 * wdev_priv - return wiphy priv from wireless_dev
2890 * @wdev: The wireless device whose wiphy's priv pointer to return
2891 * Return: The wiphy priv of @wdev.
2893 static inline void *wdev_priv(struct wireless_dev *wdev)
2896 return wiphy_priv(wdev->wiphy);
2900 * DOC: Utility functions
2902 * cfg80211 offers a number of utility functions that can be useful.
2906 * ieee80211_channel_to_frequency - convert channel number to frequency
2907 * @chan: channel number
2908 * @band: band, necessary due to channel number overlap
2909 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
2911 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2914 * ieee80211_frequency_to_channel - convert frequency to channel number
2915 * @freq: center frequency
2916 * Return: The corresponding channel, or 0 if the conversion failed.
2918 extern int ieee80211_frequency_to_channel(int freq);
2921 * Name indirection necessary because the ieee80211 code also has
2922 * a function named "ieee80211_get_channel", so if you include
2923 * cfg80211's header file you get cfg80211's version, if you try
2924 * to include both header files you'll (rightfully!) get a symbol
2927 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2930 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2931 * @wiphy: the struct wiphy to get the channel for
2932 * @freq: the center frequency of the channel
2933 * Return: The channel struct from @wiphy at @freq.
2935 static inline struct ieee80211_channel *
2936 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2938 return __ieee80211_get_channel(wiphy, freq);
2942 * ieee80211_get_response_rate - get basic rate for a given rate
2944 * @sband: the band to look for rates in
2945 * @basic_rates: bitmap of basic rates
2946 * @bitrate: the bitrate for which to find the basic rate
2948 * Return: The basic rate corresponding to a given bitrate, that
2949 * is the next lower bitrate contained in the basic rate map,
2950 * which is, for this function, given as a bitmap of indices of
2951 * rates in the band's bitrate table.
2953 struct ieee80211_rate *
2954 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2955 u32 basic_rates, int bitrate);
2958 * Radiotap parsing functions -- for controlled injection support
2960 * Implemented in net/wireless/radiotap.c
2961 * Documentation in Documentation/networking/radiotap-headers.txt
2964 struct radiotap_align_size {
2965 uint8_t align:4, size:4;
2968 struct ieee80211_radiotap_namespace {
2969 const struct radiotap_align_size *align_size;
2975 struct ieee80211_radiotap_vendor_namespaces {
2976 const struct ieee80211_radiotap_namespace *ns;
2981 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2982 * @this_arg_index: index of current arg, valid after each successful call
2983 * to ieee80211_radiotap_iterator_next()
2984 * @this_arg: pointer to current radiotap arg; it is valid after each
2985 * call to ieee80211_radiotap_iterator_next() but also after
2986 * ieee80211_radiotap_iterator_init() where it will point to
2987 * the beginning of the actual data portion
2988 * @this_arg_size: length of the current arg, for convenience
2989 * @current_namespace: pointer to the current namespace definition
2990 * (or internally %NULL if the current namespace is unknown)
2991 * @is_radiotap_ns: indicates whether the current namespace is the default
2992 * radiotap namespace or not
2994 * @_rtheader: pointer to the radiotap header we are walking through
2995 * @_max_length: length of radiotap header in cpu byte ordering
2996 * @_arg_index: next argument index
2997 * @_arg: next argument pointer
2998 * @_next_bitmap: internal pointer to next present u32
2999 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
3000 * @_vns: vendor namespace definitions
3001 * @_next_ns_data: beginning of the next namespace's data
3002 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
3005 * Describes the radiotap parser state. Fields prefixed with an underscore
3006 * must not be used by users of the parser, only by the parser internally.
3009 struct ieee80211_radiotap_iterator {
3010 struct ieee80211_radiotap_header *_rtheader;
3011 const struct ieee80211_radiotap_vendor_namespaces *_vns;
3012 const struct ieee80211_radiotap_namespace *current_namespace;
3014 unsigned char *_arg, *_next_ns_data;
3015 __le32 *_next_bitmap;
3017 unsigned char *this_arg;
3025 uint32_t _bitmap_shifter;
3029 extern int ieee80211_radiotap_iterator_init(
3030 struct ieee80211_radiotap_iterator *iterator,
3031 struct ieee80211_radiotap_header *radiotap_header,
3032 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
3034 extern int ieee80211_radiotap_iterator_next(
3035 struct ieee80211_radiotap_iterator *iterator);
3038 extern const unsigned char rfc1042_header[6];
3039 extern const unsigned char bridge_tunnel_header[6];
3042 * ieee80211_get_hdrlen_from_skb - get header length from data
3046 * Given an skb with a raw 802.11 header at the data pointer this function
3047 * returns the 802.11 header length.
3049 * Return: The 802.11 header length in bytes (not including encryption
3050 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
3053 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
3056 * ieee80211_hdrlen - get header length in bytes from frame control
3057 * @fc: frame control field in little-endian format
3058 * Return: The header length in bytes.
3060 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
3063 * ieee80211_get_mesh_hdrlen - get mesh extension header length
3064 * @meshhdr: the mesh extension header, only the flags field
3065 * (first byte) will be accessed
3066 * Return: The length of the extension header, which is always at
3067 * least 6 bytes and at most 18 if address 5 and 6 are present.
3069 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
3072 * DOC: Data path helpers
3074 * In addition to generic utilities, cfg80211 also offers
3075 * functions that help implement the data path for devices
3076 * that do not do the 802.11/802.3 conversion on the device.
3080 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
3081 * @skb: the 802.11 data frame
3082 * @addr: the device MAC address
3083 * @iftype: the virtual interface type
3084 * Return: 0 on success. Non-zero on error.
3086 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
3087 enum nl80211_iftype iftype);
3090 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
3091 * @skb: the 802.3 frame
3092 * @addr: the device MAC address
3093 * @iftype: the virtual interface type
3094 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
3095 * @qos: build 802.11 QoS data frame
3096 * Return: 0 on success, or a negative error code.
3098 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
3099 enum nl80211_iftype iftype, u8 *bssid, bool qos);
3102 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
3104 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
3105 * 802.3 frames. The @list will be empty if the decode fails. The
3106 * @skb is consumed after the function returns.
3108 * @skb: The input IEEE 802.11n A-MSDU frame.
3109 * @list: The output list of 802.3 frames. It must be allocated and
3110 * initialized by by the caller.
3111 * @addr: The device MAC address.
3112 * @iftype: The device interface type.
3113 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
3114 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
3116 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
3117 const u8 *addr, enum nl80211_iftype iftype,
3118 const unsigned int extra_headroom,
3119 bool has_80211_header);
3122 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
3123 * @skb: the data frame
3124 * Return: The 802.1p/1d tag.
3126 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
3129 * cfg80211_find_ie - find information element in data
3132 * @ies: data consisting of IEs
3133 * @len: length of data
3135 * Return: %NULL if the element ID could not be found or if
3136 * the element is invalid (claims to be longer than the given
3137 * data), or a pointer to the first byte of the requested
3138 * element, that is the byte containing the element ID.
3140 * Note: There are no checks on the element length other than
3141 * having to fit into the given data.
3143 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
3146 * cfg80211_find_vendor_ie - find vendor specific information element in data
3149 * @oui_type: vendor-specific OUI type
3150 * @ies: data consisting of IEs
3151 * @len: length of data
3153 * Return: %NULL if the vendor specific element ID could not be found or if the
3154 * element is invalid (claims to be longer than the given data), or a pointer to
3155 * the first byte of the requested element, that is the byte containing the
3158 * Note: There are no checks on the element length other than having to fit into
3161 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
3162 const u8 *ies, int len);
3165 * DOC: Regulatory enforcement infrastructure
3171 * regulatory_hint - driver hint to the wireless core a regulatory domain
3172 * @wiphy: the wireless device giving the hint (used only for reporting
3174 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
3175 * should be in. If @rd is set this should be NULL. Note that if you
3176 * set this to NULL you should still set rd->alpha2 to some accepted
3179 * Wireless drivers can use this function to hint to the wireless core
3180 * what it believes should be the current regulatory domain by
3181 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
3182 * domain should be in or by providing a completely build regulatory domain.
3183 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
3184 * for a regulatory domain structure for the respective country.
3186 * The wiphy must have been registered to cfg80211 prior to this call.
3187 * For cfg80211 drivers this means you must first use wiphy_register(),
3188 * for mac80211 drivers you must first use ieee80211_register_hw().
3190 * Drivers should check the return value, its possible you can get
3193 * Return: 0 on success. -ENOMEM.
3195 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
3198 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
3199 * @wiphy: the wireless device we want to process the regulatory domain on
3200 * @regd: the custom regulatory domain to use for this wiphy
3202 * Drivers can sometimes have custom regulatory domains which do not apply
3203 * to a specific country. Drivers can use this to apply such custom regulatory
3204 * domains. This routine must be called prior to wiphy registration. The
3205 * custom regulatory domain will be trusted completely and as such previous
3206 * default channel settings will be disregarded. If no rule is found for a
3207 * channel on the regulatory domain the channel will be disabled.
3209 extern void wiphy_apply_custom_regulatory(
3210 struct wiphy *wiphy,
3211 const struct ieee80211_regdomain *regd);
3214 * freq_reg_info - get regulatory information for the given frequency
3215 * @wiphy: the wiphy for which we want to process this rule for
3216 * @center_freq: Frequency in KHz for which we want regulatory information for
3218 * Use this function to get the regulatory rule for a specific frequency on
3219 * a given wireless device. If the device has a specific regulatory domain
3220 * it wants to follow we respect that unless a country IE has been received
3221 * and processed already.
3223 * Return: A valid pointer, or, when an error occurs, for example if no rule
3224 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
3225 * check and PTR_ERR() to obtain the numeric return value. The numeric return
3226 * value will be -ERANGE if we determine the given center_freq does not even
3227 * have a regulatory rule for a frequency range in the center_freq's band.
3228 * See freq_in_rule_band() for our current definition of a band -- this is
3229 * purely subjective and right now it's 802.11 specific.
3231 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
3235 * callbacks for asynchronous cfg80211 methods, notification
3236 * functions and BSS handling helpers
3240 * cfg80211_scan_done - notify that scan finished
3242 * @request: the corresponding scan request
3243 * @aborted: set to true if the scan was aborted for any reason,
3244 * userspace will be notified of that
3246 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
3249 * cfg80211_sched_scan_results - notify that new scan results are available
3251 * @wiphy: the wiphy which got scheduled scan results
3253 void cfg80211_sched_scan_results(struct wiphy *wiphy);
3256 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
3258 * @wiphy: the wiphy on which the scheduled scan stopped
3260 * The driver can call this function to inform cfg80211 that the
3261 * scheduled scan had to be stopped, for whatever reason. The driver
3262 * is then called back via the sched_scan_stop operation when done.
3264 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
3267 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
3269 * @wiphy: the wiphy reporting the BSS
3270 * @channel: The channel the frame was received on
3271 * @mgmt: the management frame (probe response or beacon)
3272 * @len: length of the management frame
3273 * @signal: the signal strength, type depends on the wiphy's signal_type
3274 * @gfp: context flags
3276 * This informs cfg80211 that BSS information was found and
3277 * the BSS should be updated/added.
3279 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3280 * Or %NULL on error.
3282 struct cfg80211_bss * __must_check
3283 cfg80211_inform_bss_frame(struct wiphy *wiphy,
3284 struct ieee80211_channel *channel,
3285 struct ieee80211_mgmt *mgmt, size_t len,
3286 s32 signal, gfp_t gfp);
3289 * cfg80211_inform_bss - inform cfg80211 of a new BSS
3291 * @wiphy: the wiphy reporting the BSS
3292 * @channel: The channel the frame was received on
3293 * @bssid: the BSSID of the BSS
3294 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
3295 * @capability: the capability field sent by the peer
3296 * @beacon_interval: the beacon interval announced by the peer
3297 * @ie: additional IEs sent by the peer
3298 * @ielen: length of the additional IEs
3299 * @signal: the signal strength, type depends on the wiphy's signal_type
3300 * @gfp: context flags
3302 * This informs cfg80211 that BSS information was found and
3303 * the BSS should be updated/added.
3305 * Return: A referenced struct, must be released with cfg80211_put_bss()!
3306 * Or %NULL on error.
3308 struct cfg80211_bss * __must_check
3309 cfg80211_inform_bss(struct wiphy *wiphy,
3310 struct ieee80211_channel *channel,
3311 const u8 *bssid, u64 tsf, u16 capability,
3312 u16 beacon_interval, const u8 *ie, size_t ielen,
3313 s32 signal, gfp_t gfp);
3315 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
3316 struct ieee80211_channel *channel,
3318 const u8 *ssid, size_t ssid_len,
3319 u16 capa_mask, u16 capa_val);
3320 static inline struct cfg80211_bss *
3321 cfg80211_get_ibss(struct wiphy *wiphy,
3322 struct ieee80211_channel *channel,
3323 const u8 *ssid, size_t ssid_len)
3325 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
3326 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
3330 * cfg80211_ref_bss - reference BSS struct
3331 * @wiphy: the wiphy this BSS struct belongs to
3332 * @bss: the BSS struct to reference
3334 * Increments the refcount of the given BSS struct.
3336 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3339 * cfg80211_put_bss - unref BSS struct
3340 * @wiphy: the wiphy this BSS struct belongs to
3341 * @bss: the BSS struct
3343 * Decrements the refcount of the given BSS struct.
3345 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3348 * cfg80211_unlink_bss - unlink BSS from internal data structures
3350 * @bss: the bss to remove
3352 * This function removes the given BSS from the internal data structures
3353 * thereby making it no longer show up in scan results etc. Use this
3354 * function when you detect a BSS is gone. Normally BSSes will also time
3355 * out, so it is not necessary to use this function at all.
3357 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
3360 * cfg80211_send_rx_auth - notification of processed authentication
3361 * @dev: network device
3362 * @buf: authentication frame (header + body)
3363 * @len: length of the frame data
3365 * This function is called whenever an authentication has been processed in
3366 * station mode. The driver is required to call either this function or
3367 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
3368 * call. This function may sleep.
3370 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
3373 * cfg80211_send_auth_timeout - notification of timed out authentication
3374 * @dev: network device
3375 * @addr: The MAC address of the device with which the authentication timed out
3377 * This function may sleep.
3379 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
3382 * cfg80211_send_rx_assoc - notification of processed association
3383 * @dev: network device
3384 * @bss: the BSS struct association was requested for, the struct reference
3385 * is owned by cfg80211 after this call
3386 * @buf: (re)association response frame (header + body)
3387 * @len: length of the frame data
3389 * This function is called whenever a (re)association response has been
3390 * processed in station mode. The driver is required to call either this
3391 * function or cfg80211_send_assoc_timeout() to indicate the result of
3392 * cfg80211_ops::assoc() call. This function may sleep.
3394 void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
3395 const u8 *buf, size_t len);
3398 * cfg80211_send_assoc_timeout - notification of timed out association
3399 * @dev: network device
3400 * @addr: The MAC address of the device with which the association timed out
3402 * This function may sleep.
3404 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
3407 * cfg80211_send_deauth - notification of processed deauthentication
3408 * @dev: network device
3409 * @buf: deauthentication frame (header + body)
3410 * @len: length of the frame data
3412 * This function is called whenever deauthentication has been processed in
3413 * station mode. This includes both received deauthentication frames and
3414 * locally generated ones. This function may sleep.
3416 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3419 * __cfg80211_send_deauth - notification of processed deauthentication
3420 * @dev: network device
3421 * @buf: deauthentication frame (header + body)
3422 * @len: length of the frame data
3424 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
3426 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
3429 * cfg80211_send_disassoc - notification of processed disassociation
3430 * @dev: network device
3431 * @buf: disassociation response frame (header + body)
3432 * @len: length of the frame data
3434 * This function is called whenever disassociation has been processed in
3435 * station mode. This includes both received disassociation frames and locally
3436 * generated ones. This function may sleep.
3438 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
3441 * __cfg80211_send_disassoc - notification of processed disassociation
3442 * @dev: network device
3443 * @buf: disassociation response frame (header + body)
3444 * @len: length of the frame data
3446 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
3448 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
3452 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
3453 * @dev: network device
3454 * @buf: deauthentication frame (header + body)
3455 * @len: length of the frame data
3457 * This function is called whenever a received Deauthentication frame has been
3458 * dropped in station mode because of MFP being used but the Deauthentication
3459 * frame was not protected. This function may sleep.
3461 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
3465 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
3466 * @dev: network device
3467 * @buf: disassociation frame (header + body)
3468 * @len: length of the frame data
3470 * This function is called whenever a received Disassociation frame has been
3471 * dropped in station mode because of MFP being used but the Disassociation
3472 * frame was not protected. This function may sleep.
3474 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
3478 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3479 * @dev: network device
3480 * @addr: The source MAC address of the frame
3481 * @key_type: The key type that the received frame used
3482 * @key_id: Key identifier (0..3). Can be -1 if missing.
3483 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3484 * @gfp: allocation flags
3486 * This function is called whenever the local MAC detects a MIC failure in a
3487 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3490 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3491 enum nl80211_key_type key_type, int key_id,
3492 const u8 *tsc, gfp_t gfp);
3495 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3497 * @dev: network device
3498 * @bssid: the BSSID of the IBSS joined
3499 * @gfp: allocation flags
3501 * This function notifies cfg80211 that the device joined an IBSS or
3502 * switched to a different BSSID. Before this function can be called,
3503 * either a beacon has to have been received from the IBSS, or one of
3504 * the cfg80211_inform_bss{,_frame} functions must have been called
3505 * with the locally generated beacon -- this guarantees that there is
3506 * always a scan result for this IBSS. cfg80211 will handle the rest.
3508 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
3511 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3513 * @dev: network device
3514 * @macaddr: the MAC address of the new candidate
3515 * @ie: information elements advertised by the peer candidate
3516 * @ie_len: lenght of the information elements buffer
3517 * @gfp: allocation flags
3519 * This function notifies cfg80211 that the mesh peer candidate has been
3520 * detected, most likely via a beacon or, less likely, via a probe response.
3521 * cfg80211 then sends a notification to userspace.
3523 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3524 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3527 * DOC: RFkill integration
3529 * RFkill integration in cfg80211 is almost invisible to drivers,
3530 * as cfg80211 automatically registers an rfkill instance for each
3531 * wireless device it knows about. Soft kill is also translated
3532 * into disconnecting and turning all interfaces off, drivers are
3533 * expected to turn off the device when all interfaces are down.
3535 * However, devices may have a hard RFkill line, in which case they
3536 * also need to interact with the rfkill subsystem, via cfg80211.
3537 * They can do this with a few helper functions documented here.
3541 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3543 * @blocked: block status
3545 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3548 * wiphy_rfkill_start_polling - start polling rfkill
3551 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3554 * wiphy_rfkill_stop_polling - stop polling rfkill
3557 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3559 #ifdef CONFIG_NL80211_TESTMODE
3563 * Test mode is a set of utility functions to allow drivers to
3564 * interact with driver-specific tools to aid, for instance,
3565 * factory programming.
3567 * This chapter describes how drivers interact with it, for more
3568 * information see the nl80211 book's chapter on it.
3572 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3574 * @approxlen: an upper bound of the length of the data that will
3575 * be put into the skb
3577 * This function allocates and pre-fills an skb for a reply to
3578 * the testmode command. Since it is intended for a reply, calling
3579 * it outside of the @testmode_cmd operation is invalid.
3581 * The returned skb is pre-filled with the wiphy index and set up in
3582 * a way that any data that is put into the skb (with skb_put(),
3583 * nla_put() or similar) will end up being within the
3584 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
3585 * with the skb is adding data for the corresponding userspace tool
3586 * which can then read that data out of the testdata attribute. You
3587 * must not modify the skb in any other way.
3589 * When done, call cfg80211_testmode_reply() with the skb and return
3590 * its error code as the result of the @testmode_cmd operation.
3592 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3594 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
3598 * cfg80211_testmode_reply - send the reply skb
3599 * @skb: The skb, must have been allocated with
3600 * cfg80211_testmode_alloc_reply_skb()
3602 * Since calling this function will usually be the last thing
3603 * before returning from the @testmode_cmd you should return
3604 * the error code. Note that this function consumes the skb
3605 * regardless of the return value.
3607 * Return: An error code or 0 on success.
3609 int cfg80211_testmode_reply(struct sk_buff *skb);
3612 * cfg80211_testmode_alloc_event_skb - allocate testmode event
3614 * @approxlen: an upper bound of the length of the data that will
3615 * be put into the skb
3616 * @gfp: allocation flags
3618 * This function allocates and pre-fills an skb for an event on the
3619 * testmode multicast group.
3621 * The returned skb is set up in the same way as with
3622 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
3623 * there, you should simply add data to it that will then end up in the
3624 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
3627 * When done filling the skb, call cfg80211_testmode_event() with the
3628 * skb to send the event.
3630 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
3632 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
3633 int approxlen, gfp_t gfp);
3636 * cfg80211_testmode_event - send the event
3637 * @skb: The skb, must have been allocated with
3638 * cfg80211_testmode_alloc_event_skb()
3639 * @gfp: allocation flags
3641 * This function sends the given @skb, which must have been allocated
3642 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3645 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3647 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3648 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3650 #define CFG80211_TESTMODE_CMD(cmd)
3651 #define CFG80211_TESTMODE_DUMP(cmd)
3655 * cfg80211_connect_result - notify cfg80211 of connection result
3657 * @dev: network device
3658 * @bssid: the BSSID of the AP
3659 * @req_ie: association request IEs (maybe be %NULL)
3660 * @req_ie_len: association request IEs length
3661 * @resp_ie: association response IEs (may be %NULL)
3662 * @resp_ie_len: assoc response IEs length
3663 * @status: status code, 0 for successful connection, use
3664 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3665 * the real status code for failures.
3666 * @gfp: allocation flags
3668 * It should be called by the underlying driver whenever connect() has
3671 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3672 const u8 *req_ie, size_t req_ie_len,
3673 const u8 *resp_ie, size_t resp_ie_len,
3674 u16 status, gfp_t gfp);
3677 * cfg80211_roamed - notify cfg80211 of roaming
3679 * @dev: network device
3680 * @channel: the channel of the new AP
3681 * @bssid: the BSSID of the new AP
3682 * @req_ie: association request IEs (maybe be %NULL)
3683 * @req_ie_len: association request IEs length
3684 * @resp_ie: association response IEs (may be %NULL)
3685 * @resp_ie_len: assoc response IEs length
3686 * @gfp: allocation flags
3688 * It should be called by the underlying driver whenever it roamed
3689 * from one AP to another while connected.
3691 void cfg80211_roamed(struct net_device *dev,
3692 struct ieee80211_channel *channel,
3694 const u8 *req_ie, size_t req_ie_len,
3695 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3698 * cfg80211_roamed_bss - notify cfg80211 of roaming
3700 * @dev: network device
3701 * @bss: entry of bss to which STA got roamed
3702 * @req_ie: association request IEs (maybe be %NULL)
3703 * @req_ie_len: association request IEs length
3704 * @resp_ie: association response IEs (may be %NULL)
3705 * @resp_ie_len: assoc response IEs length
3706 * @gfp: allocation flags
3708 * This is just a wrapper to notify cfg80211 of roaming event with driver
3709 * passing bss to avoid a race in timeout of the bss entry. It should be
3710 * called by the underlying driver whenever it roamed from one AP to another
3711 * while connected. Drivers which have roaming implemented in firmware
3712 * may use this function to avoid a race in bss entry timeout where the bss
3713 * entry of the new AP is seen in the driver, but gets timed out by the time
3714 * it is accessed in __cfg80211_roamed() due to delay in scheduling
3715 * rdev->event_work. In case of any failures, the reference is released
3716 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3717 * it will be released while diconneting from the current bss.
3719 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3720 const u8 *req_ie, size_t req_ie_len,
3721 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3724 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3726 * @dev: network device
3727 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3728 * @ie_len: length of IEs
3729 * @reason: reason code for the disconnection, set it to 0 if unknown
3730 * @gfp: allocation flags
3732 * After it calls this function, the driver should enter an idle state
3733 * and not try to connect to any AP any more.
3735 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3736 u8 *ie, size_t ie_len, gfp_t gfp);
3739 * cfg80211_ready_on_channel - notification of remain_on_channel start
3740 * @wdev: wireless device
3741 * @cookie: the request cookie
3742 * @chan: The current channel (from remain_on_channel request)
3743 * @duration: Duration in milliseconds that the driver intents to remain on the
3745 * @gfp: allocation flags
3747 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
3748 struct ieee80211_channel *chan,
3749 unsigned int duration, gfp_t gfp);
3752 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3753 * @wdev: wireless device
3754 * @cookie: the request cookie
3755 * @chan: The current channel (from remain_on_channel request)
3756 * @gfp: allocation flags
3758 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
3759 struct ieee80211_channel *chan,
3764 * cfg80211_new_sta - notify userspace about station
3767 * @mac_addr: the station's address
3768 * @sinfo: the station information
3769 * @gfp: allocation flags
3771 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3772 struct station_info *sinfo, gfp_t gfp);
3775 * cfg80211_del_sta - notify userspace about deletion of a station
3778 * @mac_addr: the station's address
3779 * @gfp: allocation flags
3781 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3784 * cfg80211_conn_failed - connection request failed notification
3787 * @mac_addr: the station's address
3788 * @reason: the reason for connection failure
3789 * @gfp: allocation flags
3791 * Whenever a station tries to connect to an AP and if the station
3792 * could not connect to the AP as the AP has rejected the connection
3793 * for some reasons, this function is called.
3795 * The reason for connection failure can be any of the value from
3796 * nl80211_connect_failed_reason enum
3798 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
3799 enum nl80211_connect_failed_reason reason,
3803 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3804 * @wdev: wireless device receiving the frame
3805 * @freq: Frequency on which the frame was received in MHz
3806 * @sig_dbm: signal strength in mBm, or 0 if unknown
3807 * @buf: Management frame (header + body)
3808 * @len: length of the frame data
3809 * @gfp: context flags
3811 * This function is called whenever an Action frame is received for a station
3812 * mode interface, but is not processed in kernel.
3814 * Return: %true if a user space application has registered for this frame.
3815 * For action frames, that makes it responsible for rejecting unrecognized
3816 * action frames; %false otherwise, in which case for action frames the
3817 * driver is responsible for rejecting the frame.
3819 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
3820 const u8 *buf, size_t len, gfp_t gfp);
3823 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3824 * @wdev: wireless device receiving the frame
3825 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3826 * @buf: Management frame (header + body)
3827 * @len: length of the frame data
3828 * @ack: Whether frame was acknowledged
3829 * @gfp: context flags
3831 * This function is called whenever a management frame was requested to be
3832 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3833 * transmission attempt.
3835 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
3836 const u8 *buf, size_t len, bool ack, gfp_t gfp);
3840 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3841 * @dev: network device
3842 * @rssi_event: the triggered RSSI event
3843 * @gfp: context flags
3845 * This function is called when a configured connection quality monitoring
3846 * rssi threshold reached event occurs.
3848 void cfg80211_cqm_rssi_notify(struct net_device *dev,
3849 enum nl80211_cqm_rssi_threshold_event rssi_event,
3853 * cfg80211_radar_event - radar detection event
3855 * @chandef: chandef for the current channel
3856 * @gfp: context flags
3858 * This function is called when a radar is detected on the current chanenl.
3860 void cfg80211_radar_event(struct wiphy *wiphy,
3861 struct cfg80211_chan_def *chandef, gfp_t gfp);
3864 * cfg80211_cac_event - Channel availability check (CAC) event
3865 * @netdev: network device
3866 * @event: type of event
3867 * @gfp: context flags
3869 * This function is called when a Channel availability check (CAC) is finished
3870 * or aborted. This must be called to notify the completion of a CAC process,
3871 * also by full-MAC drivers.
3873 void cfg80211_cac_event(struct net_device *netdev,
3874 enum nl80211_radar_event event, gfp_t gfp);
3878 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3879 * @dev: network device
3880 * @peer: peer's MAC address
3881 * @num_packets: how many packets were lost -- should be a fixed threshold
3882 * but probably no less than maybe 50, or maybe a throughput dependent
3883 * threshold (to account for temporary interference)
3884 * @gfp: context flags
3886 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3887 const u8 *peer, u32 num_packets, gfp_t gfp);
3890 * cfg80211_cqm_txe_notify - TX error rate event
3891 * @dev: network device
3892 * @peer: peer's MAC address
3893 * @num_packets: how many packets were lost
3894 * @rate: % of packets which failed transmission
3895 * @intvl: interval (in s) over which the TX failure threshold was breached.
3896 * @gfp: context flags
3898 * Notify userspace when configured % TX failures over number of packets in a
3899 * given interval is exceeded.
3901 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
3902 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
3905 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3906 * @dev: network device
3907 * @bssid: BSSID of AP (to avoid races)
3908 * @replay_ctr: new replay counter
3909 * @gfp: allocation flags
3911 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
3912 const u8 *replay_ctr, gfp_t gfp);
3915 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3916 * @dev: network device
3917 * @index: candidate index (the smaller the index, the higher the priority)
3918 * @bssid: BSSID of AP
3919 * @preauth: Whether AP advertises support for RSN pre-authentication
3920 * @gfp: allocation flags
3922 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
3923 const u8 *bssid, bool preauth, gfp_t gfp);
3926 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3927 * @dev: The device the frame matched to
3928 * @addr: the transmitter address
3929 * @gfp: context flags
3931 * This function is used in AP mode (only!) to inform userspace that
3932 * a spurious class 3 frame was received, to be able to deauth the
3934 * Return: %true if the frame was passed to userspace (or this failed
3935 * for a reason other than not having a subscription.)
3937 bool cfg80211_rx_spurious_frame(struct net_device *dev,
3938 const u8 *addr, gfp_t gfp);
3941 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3942 * @dev: The device the frame matched to
3943 * @addr: the transmitter address
3944 * @gfp: context flags
3946 * This function is used in AP mode (only!) to inform userspace that
3947 * an associated station sent a 4addr frame but that wasn't expected.
3948 * It is allowed and desirable to send this event only once for each
3949 * station to avoid event flooding.
3950 * Return: %true if the frame was passed to userspace (or this failed
3951 * for a reason other than not having a subscription.)
3953 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
3954 const u8 *addr, gfp_t gfp);
3957 * cfg80211_probe_status - notify userspace about probe status
3958 * @dev: the device the probe was sent on
3959 * @addr: the address of the peer
3960 * @cookie: the cookie filled in @probe_client previously
3961 * @acked: indicates whether probe was acked or not
3962 * @gfp: allocation flags
3964 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
3965 u64 cookie, bool acked, gfp_t gfp);
3968 * cfg80211_report_obss_beacon - report beacon from other APs
3969 * @wiphy: The wiphy that received the beacon
3971 * @len: length of the frame
3972 * @freq: frequency the frame was received on
3973 * @sig_dbm: signal strength in mBm, or 0 if unknown
3975 * Use this function to report to userspace when a beacon was
3976 * received. It is not useful to call this when there is no
3977 * netdev that is in AP/GO mode.
3979 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
3980 const u8 *frame, size_t len,
3981 int freq, int sig_dbm);
3984 * cfg80211_reg_can_beacon - check if beaconing is allowed
3986 * @chandef: the channel definition
3988 * Return: %true if there is no secondary channel or the secondary channel(s)
3989 * can be used for beaconing (i.e. is not a radar channel etc.)
3991 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
3992 struct cfg80211_chan_def *chandef);
3995 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
3996 * @dev: the device which switched channels
3997 * @chandef: the new channel definition
3999 * Acquires wdev_lock, so must only be called from sleepable driver context!
4001 void cfg80211_ch_switch_notify(struct net_device *dev,
4002 struct cfg80211_chan_def *chandef);
4005 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
4006 * @dev: the device on which the operation is requested
4007 * @peer: the MAC address of the peer device
4008 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
4009 * NL80211_TDLS_TEARDOWN)
4010 * @reason_code: the reason code for teardown request
4011 * @gfp: allocation flags
4013 * This function is used to request userspace to perform TDLS operation that
4014 * requires knowledge of keys, i.e., link setup or teardown when the AP
4015 * connection uses encryption. This is optional mechanism for the driver to use
4016 * if it can automatically determine when a TDLS link could be useful (e.g.,
4017 * based on traffic and signal strength for a peer).
4019 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
4020 enum nl80211_tdls_operation oper,
4021 u16 reason_code, gfp_t gfp);
4024 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
4025 * @rate: given rate_info to calculate bitrate from
4027 * return 0 if MCS index >= 32
4029 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
4032 * cfg80211_unregister_wdev - remove the given wdev
4033 * @wdev: struct wireless_dev to remove
4035 * Call this function only for wdevs that have no netdev assigned,
4036 * e.g. P2P Devices. It removes the device from the list so that
4037 * it can no longer be used. It is necessary to call this function
4038 * even when cfg80211 requests the removal of the interface by
4039 * calling the del_virtual_intf() callback. The function must also
4040 * be called when the driver wishes to unregister the wdev, e.g.
4041 * when the device is unbound from the driver.
4043 * Requires the RTNL to be held.
4045 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
4048 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
4049 * @ies: the input IE buffer
4050 * @len: the input length
4051 * @attr: the attribute ID to find
4052 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
4053 * if the function is only called to get the needed buffer size
4054 * @bufsize: size of the output buffer
4056 * The function finds a given P2P attribute in the (vendor) IEs and
4057 * copies its contents to the given buffer.
4059 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
4060 * malformed or the attribute can't be found (respectively), or the
4061 * length of the found attribute (which can be zero).
4063 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
4064 enum ieee80211_p2p_attr_id attr,
4065 u8 *buf, unsigned int bufsize);
4068 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
4069 * @wdev: the wireless device reporting the wakeup
4070 * @wakeup: the wakeup report
4071 * @gfp: allocation flags
4073 * This function reports that the given device woke up. If it
4074 * caused the wakeup, report the reason(s), otherwise you may
4075 * pass %NULL as the @wakeup parameter to advertise that something
4076 * else caused the wakeup.
4078 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
4079 struct cfg80211_wowlan_wakeup *wakeup,
4082 /* Logging, debugging and troubleshooting/diagnostic helpers. */
4084 /* wiphy_printk helpers, similar to dev_printk */
4086 #define wiphy_printk(level, wiphy, format, args...) \
4087 dev_printk(level, &(wiphy)->dev, format, ##args)
4088 #define wiphy_emerg(wiphy, format, args...) \
4089 dev_emerg(&(wiphy)->dev, format, ##args)
4090 #define wiphy_alert(wiphy, format, args...) \
4091 dev_alert(&(wiphy)->dev, format, ##args)
4092 #define wiphy_crit(wiphy, format, args...) \
4093 dev_crit(&(wiphy)->dev, format, ##args)
4094 #define wiphy_err(wiphy, format, args...) \
4095 dev_err(&(wiphy)->dev, format, ##args)
4096 #define wiphy_warn(wiphy, format, args...) \
4097 dev_warn(&(wiphy)->dev, format, ##args)
4098 #define wiphy_notice(wiphy, format, args...) \
4099 dev_notice(&(wiphy)->dev, format, ##args)
4100 #define wiphy_info(wiphy, format, args...) \
4101 dev_info(&(wiphy)->dev, format, ##args)
4103 #define wiphy_debug(wiphy, format, args...) \
4104 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
4106 #define wiphy_dbg(wiphy, format, args...) \
4107 dev_dbg(&(wiphy)->dev, format, ##args)
4109 #if defined(VERBOSE_DEBUG)
4110 #define wiphy_vdbg wiphy_dbg
4112 #define wiphy_vdbg(wiphy, format, args...) \
4115 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
4121 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
4122 * of using a WARN/WARN_ON to get the message out, including the
4123 * file/line information and a backtrace.
4125 #define wiphy_WARN(wiphy, format, args...) \
4126 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
4128 #endif /* __NET_CFG80211_H */