1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
4 * 802.11 device and configuration interface
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <net/regulatory.h>
27 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
28 * userspace and drivers, and offers some utility functionality associated
29 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
30 * by all modern wireless drivers in Linux, so that they offer a consistent
31 * API through nl80211. For backward compatibility, cfg80211 also offers
32 * wireless extensions to userspace, but hides them from drivers completely.
34 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
40 * DOC: Device registration
42 * In order for a driver to use cfg80211, it must register the hardware device
43 * with cfg80211. This happens through a number of hardware capability structs
46 * The fundamental structure for each device is the 'wiphy', of which each
47 * instance describes a physical wireless device connected to the system. Each
48 * such wiphy can have zero, one, or many virtual interfaces associated with
49 * it, which need to be identified as such by pointing the network interface's
50 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
51 * the wireless part of the interface, normally this struct is embedded in the
52 * network interface's private data area. Drivers can optionally allow creating
53 * or destroying virtual interfaces on the fly, but without at least one or the
54 * ability to create some the wireless device isn't useful.
56 * Each wiphy structure contains device capability information, and also has
57 * a pointer to the various operations the driver offers. The definitions and
58 * structures here describe these capabilities in detail.
62 * wireless hardware capability structures
66 * enum ieee80211_band - supported frequency bands
68 * The bands are assigned this way because the supported
69 * bitrates differ in these bands.
71 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
72 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
73 * @IEEE80211_NUM_BANDS: number of defined bands
76 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
77 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
84 * enum ieee80211_channel_flags - channel flags
86 * Channel flags set by the regulatory control code.
88 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
89 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
91 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
92 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
93 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
95 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
98 enum ieee80211_channel_flags {
99 IEEE80211_CHAN_DISABLED = 1<<0,
100 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
101 IEEE80211_CHAN_NO_IBSS = 1<<2,
102 IEEE80211_CHAN_RADAR = 1<<3,
103 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
104 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
107 #define IEEE80211_CHAN_NO_HT40 \
108 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
111 * struct ieee80211_channel - channel definition
113 * This structure describes a single channel for use
116 * @center_freq: center frequency in MHz
117 * @hw_value: hardware-specific value for the channel
118 * @flags: channel flags from &enum ieee80211_channel_flags.
119 * @orig_flags: channel flags at registration time, used by regulatory
120 * code to support devices with additional restrictions
121 * @band: band this channel belongs to.
122 * @max_antenna_gain: maximum antenna gain in dBi
123 * @max_power: maximum transmission power (in dBm)
124 * @max_reg_power: maximum regulatory transmission power (in dBm)
125 * @beacon_found: helper to regulatory code to indicate when a beacon
126 * has been found on this channel. Use regulatory_hint_found_beacon()
127 * to enable this, this is useful only on 5 GHz band.
128 * @orig_mag: internal use
129 * @orig_mpwr: internal use
131 struct ieee80211_channel {
132 enum ieee80211_band band;
136 int max_antenna_gain;
141 int orig_mag, orig_mpwr;
145 * enum ieee80211_rate_flags - rate flags
147 * Hardware/specification flags for rates. These are structured
148 * in a way that allows using the same bitrate structure for
149 * different bands/PHY modes.
151 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
152 * preamble on this bitrate; only relevant in 2.4GHz band and
154 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
155 * when used with 802.11a (on the 5 GHz band); filled by the
156 * core code when registering the wiphy.
157 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
158 * when used with 802.11b (on the 2.4 GHz band); filled by the
159 * core code when registering the wiphy.
160 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
161 * when used with 802.11g (on the 2.4 GHz band); filled by the
162 * core code when registering the wiphy.
163 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
165 enum ieee80211_rate_flags {
166 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
167 IEEE80211_RATE_MANDATORY_A = 1<<1,
168 IEEE80211_RATE_MANDATORY_B = 1<<2,
169 IEEE80211_RATE_MANDATORY_G = 1<<3,
170 IEEE80211_RATE_ERP_G = 1<<4,
174 * struct ieee80211_rate - bitrate definition
176 * This structure describes a bitrate that an 802.11 PHY can
177 * operate with. The two values @hw_value and @hw_value_short
178 * are only for driver use when pointers to this structure are
181 * @flags: rate-specific flags
182 * @bitrate: bitrate in units of 100 Kbps
183 * @hw_value: driver/hardware value for this rate
184 * @hw_value_short: driver/hardware value for this rate when
185 * short preamble is used
187 struct ieee80211_rate {
190 u16 hw_value, hw_value_short;
194 * struct ieee80211_sta_ht_cap - STA's HT capabilities
196 * This structure describes most essential parameters needed
197 * to describe 802.11n HT capabilities for an STA.
199 * @ht_supported: is HT supported by the STA
200 * @cap: HT capabilities map as described in 802.11n spec
201 * @ampdu_factor: Maximum A-MPDU length factor
202 * @ampdu_density: Minimum A-MPDU spacing
203 * @mcs: Supported MCS rates
205 struct ieee80211_sta_ht_cap {
206 u16 cap; /* use IEEE80211_HT_CAP_ */
210 struct ieee80211_mcs_info mcs;
214 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
216 * This structure describes most essential parameters needed
217 * to describe 802.11ac VHT capabilities for an STA.
219 * @vht_supported: is VHT supported by the STA
220 * @cap: VHT capabilities map as described in 802.11ac spec
221 * @vht_mcs: Supported VHT MCS rates
223 struct ieee80211_sta_vht_cap {
225 u32 cap; /* use IEEE80211_VHT_CAP_ */
226 struct ieee80211_vht_mcs_info vht_mcs;
230 * struct ieee80211_supported_band - frequency band definition
232 * This structure describes a frequency band a wiphy
233 * is able to operate in.
235 * @channels: Array of channels the hardware can operate in
237 * @band: the band this structure represents
238 * @n_channels: Number of channels in @channels
239 * @bitrates: Array of bitrates the hardware can operate with
240 * in this band. Must be sorted to give a valid "supported
241 * rates" IE, i.e. CCK rates first, then OFDM.
242 * @n_bitrates: Number of bitrates in @bitrates
243 * @ht_cap: HT capabilities in this band
245 struct ieee80211_supported_band {
246 struct ieee80211_channel *channels;
247 struct ieee80211_rate *bitrates;
248 enum ieee80211_band band;
251 struct ieee80211_sta_ht_cap ht_cap;
252 struct ieee80211_sta_vht_cap vht_cap;
256 * Wireless hardware/device configuration structures and methods
260 * DOC: Actions and configuration
262 * Each wireless device and each virtual interface offer a set of configuration
263 * operations and other actions that are invoked by userspace. Each of these
264 * actions is described in the operations structure, and the parameters these
265 * operations use are described separately.
267 * Additionally, some operations are asynchronous and expect to get status
268 * information via some functions that drivers need to call.
270 * Scanning and BSS list handling with its associated functionality is described
271 * in a separate chapter.
275 * struct vif_params - describes virtual interface parameters
276 * @use_4addr: use 4-address frames
283 * struct key_params - key information
285 * Information about a key
288 * @key_len: length of key material
289 * @cipher: cipher suite selector
290 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
291 * with the get_key() callback, must be in little endian,
292 * length given by @seq_len.
293 * @seq_len: length of @seq.
304 * enum survey_info_flags - survey information flags
306 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
307 * @SURVEY_INFO_IN_USE: channel is currently being used
308 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
309 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
310 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
311 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
312 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
314 * Used by the driver to indicate which info in &struct survey_info
315 * it has filled in during the get_survey().
317 enum survey_info_flags {
318 SURVEY_INFO_NOISE_DBM = 1<<0,
319 SURVEY_INFO_IN_USE = 1<<1,
320 SURVEY_INFO_CHANNEL_TIME = 1<<2,
321 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
322 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
323 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
324 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
328 * struct survey_info - channel survey response
330 * @channel: the channel this survey record reports, mandatory
331 * @filled: bitflag of flags from &enum survey_info_flags
332 * @noise: channel noise in dBm. This and all following fields are
334 * @channel_time: amount of time in ms the radio spent on the channel
335 * @channel_time_busy: amount of time the primary channel was sensed busy
336 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
337 * @channel_time_rx: amount of time the radio spent receiving data
338 * @channel_time_tx: amount of time the radio spent transmitting data
340 * Used by dump_survey() to report back per-channel survey information.
342 * This structure can later be expanded with things like
343 * channel duty cycle etc.
346 struct ieee80211_channel *channel;
348 u64 channel_time_busy;
349 u64 channel_time_ext_busy;
357 * struct cfg80211_crypto_settings - Crypto settings
358 * @wpa_versions: indicates which, if any, WPA versions are enabled
359 * (from enum nl80211_wpa_versions)
360 * @cipher_group: group key cipher suite (or 0 if unset)
361 * @n_ciphers_pairwise: number of AP supported unicast ciphers
362 * @ciphers_pairwise: unicast key cipher suites
363 * @n_akm_suites: number of AKM suites
364 * @akm_suites: AKM suites
365 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
366 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
367 * required to assume that the port is unauthorized until authorized by
368 * user space. Otherwise, port is marked authorized by default.
369 * @control_port_ethertype: the control port protocol that should be
370 * allowed through even on unauthorized ports
371 * @control_port_no_encrypt: TRUE to prevent encryption of control port
374 struct cfg80211_crypto_settings {
377 int n_ciphers_pairwise;
378 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
380 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
382 __be16 control_port_ethertype;
383 bool control_port_no_encrypt;
387 * struct cfg80211_beacon_data - beacon data
388 * @head: head portion of beacon (before TIM IE)
389 * or %NULL if not changed
390 * @tail: tail portion of beacon (after TIM IE)
391 * or %NULL if not changed
392 * @head_len: length of @head
393 * @tail_len: length of @tail
394 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
395 * @beacon_ies_len: length of beacon_ies in octets
396 * @proberesp_ies: extra information element(s) to add into Probe Response
398 * @proberesp_ies_len: length of proberesp_ies in octets
399 * @assocresp_ies: extra information element(s) to add into (Re)Association
400 * Response frames or %NULL
401 * @assocresp_ies_len: length of assocresp_ies in octets
402 * @probe_resp_len: length of probe response template (@probe_resp)
403 * @probe_resp: probe response template (AP mode only)
405 struct cfg80211_beacon_data {
406 const u8 *head, *tail;
407 const u8 *beacon_ies;
408 const u8 *proberesp_ies;
409 const u8 *assocresp_ies;
410 const u8 *probe_resp;
412 size_t head_len, tail_len;
413 size_t beacon_ies_len;
414 size_t proberesp_ies_len;
415 size_t assocresp_ies_len;
416 size_t probe_resp_len;
420 * struct cfg80211_ap_settings - AP configuration
422 * Used to configure an AP interface.
424 * @channel: the channel to start the AP on
425 * @channel_type: the channel type to use
426 * @beacon: beacon data
427 * @beacon_interval: beacon interval
428 * @dtim_period: DTIM period
429 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
431 * @ssid_len: length of @ssid
432 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
433 * @crypto: crypto settings
434 * @privacy: the BSS uses privacy
435 * @auth_type: Authentication type (algorithm)
436 * @inactivity_timeout: time in seconds to determine station's inactivity.
438 struct cfg80211_ap_settings {
439 struct ieee80211_channel *channel;
440 enum nl80211_channel_type channel_type;
442 struct cfg80211_beacon_data beacon;
444 int beacon_interval, dtim_period;
447 enum nl80211_hidden_ssid hidden_ssid;
448 struct cfg80211_crypto_settings crypto;
450 enum nl80211_auth_type auth_type;
451 int inactivity_timeout;
455 * enum plink_action - actions to perform in mesh peers
457 * @PLINK_ACTION_INVALID: action 0 is reserved
458 * @PLINK_ACTION_OPEN: start mesh peer link establishment
459 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
462 PLINK_ACTION_INVALID,
468 * enum station_parameters_apply_mask - station parameter values to apply
469 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
471 * Not all station parameters have in-band "no change" signalling,
472 * for those that don't these flags will are used.
474 enum station_parameters_apply_mask {
475 STATION_PARAM_APPLY_UAPSD = BIT(0),
479 * struct station_parameters - station parameters
481 * Used to change and create a new station.
483 * @vlan: vlan interface station should belong to
484 * @supported_rates: supported rates in IEEE 802.11 format
485 * (or NULL for no change)
486 * @supported_rates_len: number of supported rates
487 * @sta_flags_mask: station flags that changed
488 * (bitmask of BIT(NL80211_STA_FLAG_...))
489 * @sta_flags_set: station flags values
490 * (bitmask of BIT(NL80211_STA_FLAG_...))
491 * @listen_interval: listen interval or -1 for no change
492 * @aid: AID or zero for no change
493 * @plink_action: plink action to take
494 * @plink_state: set the peer link state for a station
495 * @ht_capa: HT capabilities of station
496 * @uapsd_queues: bitmap of queues configured for uapsd. same format
497 * as the AC bitmap in the QoS info field
498 * @max_sp: max Service Period. same format as the MAX_SP in the
499 * QoS info field (but already shifted down)
500 * @sta_modify_mask: bitmap indicating which parameters changed
501 * (for those that don't have a natural "no change" value),
502 * see &enum station_parameters_apply_mask
504 struct station_parameters {
506 struct net_device *vlan;
507 u32 sta_flags_mask, sta_flags_set;
511 u8 supported_rates_len;
514 struct ieee80211_ht_cap *ht_capa;
520 * enum station_info_flags - station information flags
522 * Used by the driver to indicate which info in &struct station_info
523 * it has filled in during get_station() or dump_station().
525 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
526 * @STATION_INFO_RX_BYTES: @rx_bytes filled
527 * @STATION_INFO_TX_BYTES: @tx_bytes filled
528 * @STATION_INFO_LLID: @llid filled
529 * @STATION_INFO_PLID: @plid filled
530 * @STATION_INFO_PLINK_STATE: @plink_state filled
531 * @STATION_INFO_SIGNAL: @signal filled
532 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
533 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
534 * @STATION_INFO_RX_PACKETS: @rx_packets filled
535 * @STATION_INFO_TX_PACKETS: @tx_packets filled
536 * @STATION_INFO_TX_RETRIES: @tx_retries filled
537 * @STATION_INFO_TX_FAILED: @tx_failed filled
538 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
539 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
540 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
541 * @STATION_INFO_BSS_PARAM: @bss_param filled
542 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
543 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
544 * @STATION_INFO_STA_FLAGS: @sta_flags filled
545 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
546 * @STATION_INFO_T_OFFSET: @t_offset filled
548 enum station_info_flags {
549 STATION_INFO_INACTIVE_TIME = 1<<0,
550 STATION_INFO_RX_BYTES = 1<<1,
551 STATION_INFO_TX_BYTES = 1<<2,
552 STATION_INFO_LLID = 1<<3,
553 STATION_INFO_PLID = 1<<4,
554 STATION_INFO_PLINK_STATE = 1<<5,
555 STATION_INFO_SIGNAL = 1<<6,
556 STATION_INFO_TX_BITRATE = 1<<7,
557 STATION_INFO_RX_PACKETS = 1<<8,
558 STATION_INFO_TX_PACKETS = 1<<9,
559 STATION_INFO_TX_RETRIES = 1<<10,
560 STATION_INFO_TX_FAILED = 1<<11,
561 STATION_INFO_RX_DROP_MISC = 1<<12,
562 STATION_INFO_SIGNAL_AVG = 1<<13,
563 STATION_INFO_RX_BITRATE = 1<<14,
564 STATION_INFO_BSS_PARAM = 1<<15,
565 STATION_INFO_CONNECTED_TIME = 1<<16,
566 STATION_INFO_ASSOC_REQ_IES = 1<<17,
567 STATION_INFO_STA_FLAGS = 1<<18,
568 STATION_INFO_BEACON_LOSS_COUNT = 1<<19,
569 STATION_INFO_T_OFFSET = 1<<20,
573 * enum station_info_rate_flags - bitrate info flags
575 * Used by the driver to indicate the specific rate transmission
576 * type for 802.11n transmissions.
578 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
579 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
580 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
582 enum rate_info_flags {
583 RATE_INFO_FLAGS_MCS = 1<<0,
584 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
585 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
589 * struct rate_info - bitrate information
591 * Information about a receiving or transmitting bitrate
593 * @flags: bitflag of flags from &enum rate_info_flags
594 * @mcs: mcs index if struct describes a 802.11n bitrate
595 * @legacy: bitrate in 100kbit/s for 802.11abg
604 * enum station_info_rate_flags - bitrate info flags
606 * Used by the driver to indicate the specific rate transmission
607 * type for 802.11n transmissions.
609 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
610 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
611 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
613 enum bss_param_flags {
614 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
615 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
616 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
620 * struct sta_bss_parameters - BSS parameters for the attached station
622 * Information about the currently associated BSS
624 * @flags: bitflag of flags from &enum bss_param_flags
625 * @dtim_period: DTIM period for the BSS
626 * @beacon_interval: beacon interval
628 struct sta_bss_parameters {
635 * struct station_info - station information
637 * Station information filled by driver for get_station() and dump_station.
639 * @filled: bitflag of flags from &enum station_info_flags
640 * @connected_time: time(in secs) since a station is last connected
641 * @inactive_time: time since last station activity (tx/rx) in milliseconds
642 * @rx_bytes: bytes received from this station
643 * @tx_bytes: bytes transmitted to this station
644 * @llid: mesh local link id
645 * @plid: mesh peer link id
646 * @plink_state: mesh peer link state
647 * @signal: The signal strength, type depends on the wiphy's signal_type.
648 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
649 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
650 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
651 * @txrate: current unicast bitrate from this station
652 * @rxrate: current unicast bitrate to this station
653 * @rx_packets: packets received from this station
654 * @tx_packets: packets transmitted to this station
655 * @tx_retries: cumulative retry counts
656 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
657 * @rx_dropped_misc: Dropped for un-specified reason.
658 * @bss_param: current BSS parameters
659 * @generation: generation number for nl80211 dumps.
660 * This number should increase every time the list of stations
661 * changes, i.e. when a station is added or removed, so that
662 * userspace can tell whether it got a consistent snapshot.
663 * @assoc_req_ies: IEs from (Re)Association Request.
664 * This is used only when in AP mode with drivers that do not use
665 * user space MLME/SME implementation. The information is provided for
666 * the cfg80211_new_sta() calls to notify user space of the IEs.
667 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
668 * @sta_flags: station flags mask & values
669 * @beacon_loss_count: Number of times beacon loss event has triggered.
670 * @t_offset: Time offset of the station relative to this host.
672 struct station_info {
683 struct rate_info txrate;
684 struct rate_info rxrate;
690 struct sta_bss_parameters bss_param;
691 struct nl80211_sta_flag_update sta_flags;
695 const u8 *assoc_req_ies;
696 size_t assoc_req_ies_len;
698 u32 beacon_loss_count;
702 * Note: Add a new enum station_info_flags value for each new field and
703 * use it to check which fields are initialized.
708 * enum monitor_flags - monitor flags
710 * Monitor interface configuration flags. Note that these must be the bits
711 * according to the nl80211 flags.
713 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
714 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
715 * @MONITOR_FLAG_CONTROL: pass control frames
716 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
717 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
720 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
721 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
722 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
723 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
724 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
728 * enum mpath_info_flags - mesh path information flags
730 * Used by the driver to indicate which info in &struct mpath_info it has filled
731 * in during get_station() or dump_station().
733 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
734 * @MPATH_INFO_SN: @sn filled
735 * @MPATH_INFO_METRIC: @metric filled
736 * @MPATH_INFO_EXPTIME: @exptime filled
737 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
738 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
739 * @MPATH_INFO_FLAGS: @flags filled
741 enum mpath_info_flags {
742 MPATH_INFO_FRAME_QLEN = BIT(0),
743 MPATH_INFO_SN = BIT(1),
744 MPATH_INFO_METRIC = BIT(2),
745 MPATH_INFO_EXPTIME = BIT(3),
746 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
747 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
748 MPATH_INFO_FLAGS = BIT(6),
752 * struct mpath_info - mesh path information
754 * Mesh path information filled by driver for get_mpath() and dump_mpath().
756 * @filled: bitfield of flags from &enum mpath_info_flags
757 * @frame_qlen: number of queued frames for this destination
758 * @sn: target sequence number
759 * @metric: metric (cost) of this mesh path
760 * @exptime: expiration time for the mesh path from now, in msecs
761 * @flags: mesh path flags
762 * @discovery_timeout: total mesh path discovery timeout, in msecs
763 * @discovery_retries: mesh path discovery retries
764 * @generation: generation number for nl80211 dumps.
765 * This number should increase every time the list of mesh paths
766 * changes, i.e. when a station is added or removed, so that
767 * userspace can tell whether it got a consistent snapshot.
775 u32 discovery_timeout;
776 u8 discovery_retries;
783 * struct bss_parameters - BSS parameters
785 * Used to change BSS parameters (mainly for AP mode).
787 * @use_cts_prot: Whether to use CTS protection
788 * (0 = no, 1 = yes, -1 = do not change)
789 * @use_short_preamble: Whether the use of short preambles is allowed
790 * (0 = no, 1 = yes, -1 = do not change)
791 * @use_short_slot_time: Whether the use of short slot time is allowed
792 * (0 = no, 1 = yes, -1 = do not change)
793 * @basic_rates: basic rates in IEEE 802.11 format
794 * (or NULL for no change)
795 * @basic_rates_len: number of basic rates
796 * @ap_isolate: do not forward packets between connected stations
797 * @ht_opmode: HT Operation mode
798 * (u16 = opmode, -1 = do not change)
800 struct bss_parameters {
802 int use_short_preamble;
803 int use_short_slot_time;
811 * struct mesh_config - 802.11s mesh configuration
813 * These parameters can be changed while the mesh is active.
815 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
816 * by the Mesh Peering Open message
817 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
818 * used by the Mesh Peering Open message
819 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
820 * the mesh peering management to close a mesh peering
821 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
823 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
824 * be sent to establish a new peer link instance in a mesh
825 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
826 * @element_ttl: the value of TTL field set at a mesh STA for path selection
828 * @auto_open_plinks: whether we should automatically open peer links when we
829 * detect compatible mesh peers
830 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
831 * synchronize to for 11s default synchronization method
832 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
833 * that an originator mesh STA can send to a particular path target
834 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
835 * @min_discovery_timeout: the minimum length of time to wait until giving up on
836 * a path discovery in milliseconds
837 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
838 * receiving a PREQ shall consider the forwarding information from the
839 * root to be valid. (TU = time unit)
840 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
841 * which a mesh STA can send only one action frame containing a PREQ
843 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
844 * which a mesh STA can send only one Action frame containing a PERR
846 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
847 * it takes for an HWMP information element to propagate across the mesh
848 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
849 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
850 * announcements are transmitted
851 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
852 * station has access to a broader network beyond the MBSS. (This is
853 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
854 * only means that the station will announce others it's a mesh gate, but
855 * not necessarily using the gate announcement protocol. Still keeping the
856 * same nomenclature to be in sync with the spec)
857 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
858 * entity (default is TRUE - forwarding entity)
859 * @rssi_threshold: the threshold for average signal strength of candidate
860 * station to establish a peer link
861 * @ht_opmode: mesh HT protection mode
863 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
864 * receiving a proactive PREQ shall consider the forwarding information to
865 * the root mesh STA to be valid.
867 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
868 * PREQs are transmitted.
869 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
870 * during which a mesh STA can send only one Action frame containing
871 * a PREQ element for root path confirmation.
874 u16 dot11MeshRetryTimeout;
875 u16 dot11MeshConfirmTimeout;
876 u16 dot11MeshHoldingTimeout;
877 u16 dot11MeshMaxPeerLinks;
878 u8 dot11MeshMaxRetries;
881 bool auto_open_plinks;
882 u32 dot11MeshNbrOffsetMaxNeighbor;
883 u8 dot11MeshHWMPmaxPREQretries;
884 u32 path_refresh_time;
885 u16 min_discovery_timeout;
886 u32 dot11MeshHWMPactivePathTimeout;
887 u16 dot11MeshHWMPpreqMinInterval;
888 u16 dot11MeshHWMPperrMinInterval;
889 u16 dot11MeshHWMPnetDiameterTraversalTime;
890 u8 dot11MeshHWMPRootMode;
891 u16 dot11MeshHWMPRannInterval;
892 bool dot11MeshGateAnnouncementProtocol;
893 bool dot11MeshForwarding;
896 u32 dot11MeshHWMPactivePathToRootTimeout;
897 u16 dot11MeshHWMProotInterval;
898 u16 dot11MeshHWMPconfirmationInterval;
902 * struct mesh_setup - 802.11s mesh setup configuration
903 * @channel: the channel to start the mesh network on
904 * @channel_type: the channel type to use
905 * @mesh_id: the mesh ID
906 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
907 * @sync_method: which synchronization method to use
908 * @path_sel_proto: which path selection protocol to use
909 * @path_metric: which metric to use
910 * @ie: vendor information elements (optional)
911 * @ie_len: length of vendor information elements
912 * @is_authenticated: this mesh requires authentication
913 * @is_secure: this mesh uses security
914 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
916 * These parameters are fixed when the mesh is created.
919 struct ieee80211_channel *channel;
920 enum nl80211_channel_type channel_type;
928 bool is_authenticated;
930 int mcast_rate[IEEE80211_NUM_BANDS];
934 * struct ieee80211_txq_params - TX queue parameters
936 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
937 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
939 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
941 * @aifs: Arbitration interframe space [0..255]
943 struct ieee80211_txq_params {
951 /* from net/wireless.h */
955 * DOC: Scanning and BSS list handling
957 * The scanning process itself is fairly simple, but cfg80211 offers quite
958 * a bit of helper functionality. To start a scan, the scan operation will
959 * be invoked with a scan definition. This scan definition contains the
960 * channels to scan, and the SSIDs to send probe requests for (including the
961 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
962 * probe. Additionally, a scan request may contain extra information elements
963 * that should be added to the probe request. The IEs are guaranteed to be
964 * well-formed, and will not exceed the maximum length the driver advertised
965 * in the wiphy structure.
967 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
968 * it is responsible for maintaining the BSS list; the driver should not
969 * maintain a list itself. For this notification, various functions exist.
971 * Since drivers do not maintain a BSS list, there are also a number of
972 * functions to search for a BSS and obtain information about it from the
973 * BSS structure cfg80211 maintains. The BSS list is also made available
978 * struct cfg80211_ssid - SSID description
980 * @ssid_len: length of the ssid
982 struct cfg80211_ssid {
983 u8 ssid[IEEE80211_MAX_SSID_LEN];
988 * struct cfg80211_scan_request - scan request description
990 * @ssids: SSIDs to scan for (active scan only)
991 * @n_ssids: number of SSIDs
992 * @channels: channels to scan on.
993 * @n_channels: total number of channels to scan
994 * @ie: optional information element(s) to add into Probe Request or %NULL
995 * @ie_len: length of ie in octets
996 * @rates: bitmap of rates to advertise for each band
997 * @wiphy: the wiphy this was for
998 * @dev: the interface
999 * @aborted: (internal) scan request was notified as aborted
1000 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1002 struct cfg80211_scan_request {
1003 struct cfg80211_ssid *ssids;
1009 u32 rates[IEEE80211_NUM_BANDS];
1012 struct wiphy *wiphy;
1013 struct net_device *dev;
1018 struct ieee80211_channel *channels[0];
1022 * struct cfg80211_match_set - sets of attributes to match
1024 * @ssid: SSID to be matched
1026 struct cfg80211_match_set {
1027 struct cfg80211_ssid ssid;
1031 * struct cfg80211_sched_scan_request - scheduled scan request description
1033 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1034 * @n_ssids: number of SSIDs
1035 * @n_channels: total number of channels to scan
1036 * @interval: interval between each scheduled scan cycle
1037 * @ie: optional information element(s) to add into Probe Request or %NULL
1038 * @ie_len: length of ie in octets
1039 * @match_sets: sets of parameters to be matched for a scan result
1040 * entry to be considered valid and to be passed to the host
1041 * (others are filtered out).
1042 * If ommited, all results are passed.
1043 * @n_match_sets: number of match sets
1044 * @wiphy: the wiphy this was for
1045 * @dev: the interface
1046 * @channels: channels to scan
1047 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1049 struct cfg80211_sched_scan_request {
1050 struct cfg80211_ssid *ssids;
1056 struct cfg80211_match_set *match_sets;
1061 struct wiphy *wiphy;
1062 struct net_device *dev;
1065 struct ieee80211_channel *channels[0];
1069 * enum cfg80211_signal_type - signal type
1071 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1072 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1073 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1075 enum cfg80211_signal_type {
1076 CFG80211_SIGNAL_TYPE_NONE,
1077 CFG80211_SIGNAL_TYPE_MBM,
1078 CFG80211_SIGNAL_TYPE_UNSPEC,
1082 * struct cfg80211_bss - BSS description
1084 * This structure describes a BSS (which may also be a mesh network)
1085 * for use in scan results and similar.
1087 * @channel: channel this BSS is on
1088 * @bssid: BSSID of the BSS
1089 * @tsf: timestamp of last received update
1090 * @beacon_interval: the beacon interval as from the frame
1091 * @capability: the capability field in host byte order
1092 * @information_elements: the information elements (Note that there
1093 * is no guarantee that these are well-formed!); this is a pointer to
1094 * either the beacon_ies or proberesp_ies depending on whether Probe
1095 * Response frame has been received
1096 * @len_information_elements: total length of the information elements
1097 * @beacon_ies: the information elements from the last Beacon frame
1098 * @len_beacon_ies: total length of the beacon_ies
1099 * @proberesp_ies: the information elements from the last Probe Response frame
1100 * @len_proberesp_ies: total length of the proberesp_ies
1101 * @signal: signal strength value (type depends on the wiphy's signal_type)
1102 * @free_priv: function pointer to free private data
1103 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1105 struct cfg80211_bss {
1106 struct ieee80211_channel *channel;
1110 u16 beacon_interval;
1112 u8 *information_elements;
1113 size_t len_information_elements;
1115 size_t len_beacon_ies;
1117 size_t len_proberesp_ies;
1121 void (*free_priv)(struct cfg80211_bss *bss);
1122 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
1126 * ieee80211_bss_get_ie - find IE with given ID
1127 * @bss: the bss to search
1129 * Returns %NULL if not found.
1131 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1135 * struct cfg80211_auth_request - Authentication request data
1137 * This structure provides information needed to complete IEEE 802.11
1140 * @bss: The BSS to authenticate with.
1141 * @auth_type: Authentication type (algorithm)
1142 * @ie: Extra IEs to add to Authentication frame or %NULL
1143 * @ie_len: Length of ie buffer in octets
1144 * @key_len: length of WEP key for shared key authentication
1145 * @key_idx: index of WEP key for shared key authentication
1146 * @key: WEP key for shared key authentication
1148 struct cfg80211_auth_request {
1149 struct cfg80211_bss *bss;
1152 enum nl80211_auth_type auth_type;
1154 u8 key_len, key_idx;
1158 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1160 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1162 enum cfg80211_assoc_req_flags {
1163 ASSOC_REQ_DISABLE_HT = BIT(0),
1167 * struct cfg80211_assoc_request - (Re)Association request data
1169 * This structure provides information needed to complete IEEE 802.11
1171 * @bss: The BSS to associate with. If the call is successful the driver
1172 * is given a reference that it must release, normally via a call to
1173 * cfg80211_send_rx_assoc(), or, if association timed out, with a
1174 * call to cfg80211_put_bss() (in addition to calling
1175 * cfg80211_send_assoc_timeout())
1176 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1177 * @ie_len: Length of ie buffer in octets
1178 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1179 * @crypto: crypto settings
1180 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1181 * @flags: See &enum cfg80211_assoc_req_flags
1182 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1183 * will be used in ht_capa. Un-supported values will be ignored.
1184 * @ht_capa_mask: The bits of ht_capa which are to be used.
1186 struct cfg80211_assoc_request {
1187 struct cfg80211_bss *bss;
1188 const u8 *ie, *prev_bssid;
1190 struct cfg80211_crypto_settings crypto;
1193 struct ieee80211_ht_cap ht_capa;
1194 struct ieee80211_ht_cap ht_capa_mask;
1198 * struct cfg80211_deauth_request - Deauthentication request data
1200 * This structure provides information needed to complete IEEE 802.11
1203 * @bssid: the BSSID of the BSS to deauthenticate from
1204 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1205 * @ie_len: Length of ie buffer in octets
1206 * @reason_code: The reason code for the deauthentication
1208 struct cfg80211_deauth_request {
1216 * struct cfg80211_disassoc_request - Disassociation request data
1218 * This structure provides information needed to complete IEEE 802.11
1221 * @bss: the BSS to disassociate from
1222 * @ie: Extra IEs to add to Disassociation frame or %NULL
1223 * @ie_len: Length of ie buffer in octets
1224 * @reason_code: The reason code for the disassociation
1225 * @local_state_change: This is a request for a local state only, i.e., no
1226 * Disassociation frame is to be transmitted.
1228 struct cfg80211_disassoc_request {
1229 struct cfg80211_bss *bss;
1233 bool local_state_change;
1237 * struct cfg80211_ibss_params - IBSS parameters
1239 * This structure defines the IBSS parameters for the join_ibss()
1242 * @ssid: The SSID, will always be non-null.
1243 * @ssid_len: The length of the SSID, will always be non-zero.
1244 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1245 * search for IBSSs with a different BSSID.
1246 * @channel: The channel to use if no IBSS can be found to join.
1247 * @channel_type: channel type (HT mode)
1248 * @channel_fixed: The channel should be fixed -- do not search for
1249 * IBSSs to join on other channels.
1250 * @ie: information element(s) to include in the beacon
1251 * @ie_len: length of that
1252 * @beacon_interval: beacon interval to use
1253 * @privacy: this is a protected network, keys will be configured
1255 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1256 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1257 * required to assume that the port is unauthorized until authorized by
1258 * user space. Otherwise, port is marked authorized by default.
1259 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1260 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1262 struct cfg80211_ibss_params {
1265 struct ieee80211_channel *channel;
1266 enum nl80211_channel_type channel_type;
1268 u8 ssid_len, ie_len;
1269 u16 beacon_interval;
1274 int mcast_rate[IEEE80211_NUM_BANDS];
1278 * struct cfg80211_connect_params - Connection parameters
1280 * This structure provides information needed to complete IEEE 802.11
1281 * authentication and association.
1283 * @channel: The channel to use or %NULL if not specified (auto-select based
1285 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1288 * @ssid_len: Length of ssid in octets
1289 * @auth_type: Authentication type (algorithm)
1290 * @ie: IEs for association request
1291 * @ie_len: Length of assoc_ie in octets
1292 * @privacy: indicates whether privacy-enabled APs should be used
1293 * @crypto: crypto settings
1294 * @key_len: length of WEP key for shared key authentication
1295 * @key_idx: index of WEP key for shared key authentication
1296 * @key: WEP key for shared key authentication
1297 * @flags: See &enum cfg80211_assoc_req_flags
1298 * @bg_scan_period: Background scan period in seconds
1299 * or -1 to indicate that default value is to be used.
1300 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1301 * will be used in ht_capa. Un-supported values will be ignored.
1302 * @ht_capa_mask: The bits of ht_capa which are to be used.
1304 struct cfg80211_connect_params {
1305 struct ieee80211_channel *channel;
1309 enum nl80211_auth_type auth_type;
1313 struct cfg80211_crypto_settings crypto;
1315 u8 key_len, key_idx;
1318 struct ieee80211_ht_cap ht_capa;
1319 struct ieee80211_ht_cap ht_capa_mask;
1323 * enum wiphy_params_flags - set_wiphy_params bitfield values
1324 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1325 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1326 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1327 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1328 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1330 enum wiphy_params_flags {
1331 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1332 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1333 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1334 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1335 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1339 * cfg80211_bitrate_mask - masks for bitrate control
1341 struct cfg80211_bitrate_mask {
1344 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1345 } control[IEEE80211_NUM_BANDS];
1348 * struct cfg80211_pmksa - PMK Security Association
1350 * This structure is passed to the set/del_pmksa() method for PMKSA
1353 * @bssid: The AP's BSSID.
1354 * @pmkid: The PMK material itself.
1356 struct cfg80211_pmksa {
1362 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1363 * @mask: bitmask where to match pattern and where to ignore bytes,
1364 * one bit per byte, in same format as nl80211
1365 * @pattern: bytes to match where bitmask is 1
1366 * @pattern_len: length of pattern (in bytes)
1368 * Internal note: @mask and @pattern are allocated in one chunk of
1369 * memory, free @mask only!
1371 struct cfg80211_wowlan_trig_pkt_pattern {
1377 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1379 * This structure defines the enabled WoWLAN triggers for the device.
1380 * @any: wake up on any activity -- special trigger if device continues
1381 * operating as normal during suspend
1382 * @disconnect: wake up if getting disconnected
1383 * @magic_pkt: wake up on receiving magic packet
1384 * @patterns: wake up on receiving packet matching a pattern
1385 * @n_patterns: number of patterns
1386 * @gtk_rekey_failure: wake up on GTK rekey failure
1387 * @eap_identity_req: wake up on EAP identity request packet
1388 * @four_way_handshake: wake up on 4-way handshake
1389 * @rfkill_release: wake up when rfkill is released
1391 struct cfg80211_wowlan {
1392 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1393 eap_identity_req, four_way_handshake,
1395 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1400 * struct cfg80211_gtk_rekey_data - rekey data
1401 * @kek: key encryption key
1402 * @kck: key confirmation key
1403 * @replay_ctr: replay counter
1405 struct cfg80211_gtk_rekey_data {
1406 u8 kek[NL80211_KEK_LEN];
1407 u8 kck[NL80211_KCK_LEN];
1408 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1412 * struct cfg80211_ops - backend description for wireless configuration
1414 * This struct is registered by fullmac card drivers and/or wireless stacks
1415 * in order to handle configuration requests on their interfaces.
1417 * All callbacks except where otherwise noted should return 0
1418 * on success or a negative error code.
1420 * All operations are currently invoked under rtnl for consistency with the
1421 * wireless extensions but this is subject to reevaluation as soon as this
1422 * code is used more widely and we have a first user without wext.
1424 * @suspend: wiphy device needs to be suspended. The variable @wow will
1425 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1426 * configured for the device.
1427 * @resume: wiphy device needs to be resumed
1428 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1429 * to call device_set_wakeup_enable() to enable/disable wakeup from
1432 * @add_virtual_intf: create a new virtual interface with the given name,
1433 * must set the struct wireless_dev's iftype. Beware: You must create
1434 * the new netdev in the wiphy's network namespace! Returns the netdev,
1437 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1439 * @change_virtual_intf: change type/configuration of virtual interface,
1440 * keep the struct wireless_dev's iftype updated.
1442 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1443 * when adding a group key.
1445 * @get_key: get information about the key with the given parameters.
1446 * @mac_addr will be %NULL when requesting information for a group
1447 * key. All pointers given to the @callback function need not be valid
1448 * after it returns. This function should return an error if it is
1449 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1451 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1452 * and @key_index, return -ENOENT if the key doesn't exist.
1454 * @set_default_key: set the default key on an interface
1456 * @set_default_mgmt_key: set the default management frame key on an interface
1458 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1460 * @start_ap: Start acting in AP mode defined by the parameters.
1461 * @change_beacon: Change the beacon parameters for an access point mode
1462 * interface. This should reject the call when AP mode wasn't started.
1463 * @stop_ap: Stop being an AP, including stopping beaconing.
1465 * @add_station: Add a new station.
1466 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1467 * @change_station: Modify a given station. Note that flags changes are not much
1468 * validated in cfg80211, in particular the auth/assoc/authorized flags
1469 * might come to the driver in invalid combinations -- make sure to check
1470 * them, also against the existing state! Also, supported_rates changes are
1471 * not checked in station mode -- drivers need to reject (or ignore) them
1472 * for anything but TDLS peers.
1473 * @get_station: get station information for the station identified by @mac
1474 * @dump_station: dump station callback -- resume dump at index @idx
1476 * @add_mpath: add a fixed mesh path
1477 * @del_mpath: delete a given mesh path
1478 * @change_mpath: change a given mesh path
1479 * @get_mpath: get a mesh path for the given parameters
1480 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1481 * @join_mesh: join the mesh network with the specified parameters
1482 * @leave_mesh: leave the current mesh network
1484 * @get_mesh_config: Get the current mesh configuration
1486 * @update_mesh_config: Update mesh parameters on a running mesh.
1487 * The mask is a bitfield which tells us which parameters to
1488 * set, and which to leave alone.
1490 * @change_bss: Modify parameters for a given BSS.
1492 * @set_txq_params: Set TX queue parameters
1494 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
1495 * as it doesn't implement join_mesh and needs to set the channel to
1496 * join the mesh instead.
1498 * @set_monitor_channel: Set the monitor mode channel for the device. If other
1499 * interfaces are active this callback should reject the configuration.
1500 * If no interfaces are active or the device is down, the channel should
1501 * be stored for when a monitor interface becomes active.
1502 * @set_monitor_enabled: Notify driver that there are only monitor
1503 * interfaces running.
1505 * @scan: Request to do a scan. If returning zero, the scan request is given
1506 * the driver, and will be valid until passed to cfg80211_scan_done().
1507 * For scan results, call cfg80211_inform_bss(); you can call this outside
1508 * the scan/scan_done bracket too.
1510 * @auth: Request to authenticate with the specified peer
1511 * @assoc: Request to (re)associate with the specified peer
1512 * @deauth: Request to deauthenticate from the specified peer
1513 * @disassoc: Request to disassociate from the specified peer
1515 * @connect: Connect to the ESS with the specified parameters. When connected,
1516 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1517 * If the connection fails for some reason, call cfg80211_connect_result()
1518 * with the status from the AP.
1519 * @disconnect: Disconnect from the BSS/ESS.
1521 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1522 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1524 * @leave_ibss: Leave the IBSS.
1526 * @set_wiphy_params: Notify that wiphy parameters have changed;
1527 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1528 * have changed. The actual parameter values are available in
1529 * struct wiphy. If returning an error, no value should be changed.
1531 * @set_tx_power: set the transmit power according to the parameters,
1532 * the power passed is in mBm, to get dBm use MBM_TO_DBM().
1533 * @get_tx_power: store the current TX power into the dbm variable;
1534 * return 0 if successful
1536 * @set_wds_peer: set the WDS peer for a WDS interface
1538 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1539 * functions to adjust rfkill hw state
1541 * @dump_survey: get site survey information.
1543 * @remain_on_channel: Request the driver to remain awake on the specified
1544 * channel for the specified duration to complete an off-channel
1545 * operation (e.g., public action frame exchange). When the driver is
1546 * ready on the requested channel, it must indicate this with an event
1547 * notification by calling cfg80211_ready_on_channel().
1548 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1549 * This allows the operation to be terminated prior to timeout based on
1550 * the duration value.
1551 * @mgmt_tx: Transmit a management frame.
1552 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1553 * frame on another channel
1555 * @testmode_cmd: run a test mode command
1556 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1557 * used by the function, but 0 and 1 must not be touched. Additionally,
1558 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1559 * dump and return to userspace with an error, so be careful. If any data
1560 * was passed in from userspace then the data/len arguments will be present
1561 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1563 * @set_bitrate_mask: set the bitrate mask configuration
1565 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1566 * devices running firmwares capable of generating the (re) association
1567 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1568 * @del_pmksa: Delete a cached PMKID.
1569 * @flush_pmksa: Flush all cached PMKIDs.
1570 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1571 * allows the driver to adjust the dynamic ps timeout value.
1572 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1573 * @sched_scan_start: Tell the driver to start a scheduled scan.
1574 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled
1575 * scan. The driver_initiated flag specifies whether the driver
1576 * itself has informed that the scan has stopped.
1578 * @mgmt_frame_register: Notify driver that a management frame type was
1579 * registered. Note that this callback may not sleep, and cannot run
1580 * concurrently with itself.
1582 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1583 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1584 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1585 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1587 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1589 * @set_ringparam: Set tx and rx ring sizes.
1591 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1593 * @tdls_mgmt: Transmit a TDLS management frame.
1594 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1596 * @probe_client: probe an associated client, must return a cookie that it
1597 * later passes to cfg80211_probe_status().
1599 * @set_noack_map: Set the NoAck Map for the TIDs.
1601 * @get_et_sset_count: Ethtool API to get string-set count.
1602 * See @ethtool_ops.get_sset_count
1604 * @get_et_stats: Ethtool API to get a set of u64 stats.
1605 * See @ethtool_ops.get_ethtool_stats
1607 * @get_et_strings: Ethtool API to get a set of strings to describe stats
1608 * and perhaps other supported types of ethtool data-sets.
1609 * See @ethtool_ops.get_strings
1611 struct cfg80211_ops {
1612 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1613 int (*resume)(struct wiphy *wiphy);
1614 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
1616 struct net_device * (*add_virtual_intf)(struct wiphy *wiphy,
1618 enum nl80211_iftype type,
1620 struct vif_params *params);
1621 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
1622 int (*change_virtual_intf)(struct wiphy *wiphy,
1623 struct net_device *dev,
1624 enum nl80211_iftype type, u32 *flags,
1625 struct vif_params *params);
1627 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1628 u8 key_index, bool pairwise, const u8 *mac_addr,
1629 struct key_params *params);
1630 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1631 u8 key_index, bool pairwise, const u8 *mac_addr,
1633 void (*callback)(void *cookie, struct key_params*));
1634 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1635 u8 key_index, bool pairwise, const u8 *mac_addr);
1636 int (*set_default_key)(struct wiphy *wiphy,
1637 struct net_device *netdev,
1638 u8 key_index, bool unicast, bool multicast);
1639 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1640 struct net_device *netdev,
1643 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
1644 struct cfg80211_ap_settings *settings);
1645 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
1646 struct cfg80211_beacon_data *info);
1647 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
1650 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1651 u8 *mac, struct station_parameters *params);
1652 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1654 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1655 u8 *mac, struct station_parameters *params);
1656 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1657 u8 *mac, struct station_info *sinfo);
1658 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1659 int idx, u8 *mac, struct station_info *sinfo);
1661 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1662 u8 *dst, u8 *next_hop);
1663 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1665 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1666 u8 *dst, u8 *next_hop);
1667 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1668 u8 *dst, u8 *next_hop,
1669 struct mpath_info *pinfo);
1670 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1671 int idx, u8 *dst, u8 *next_hop,
1672 struct mpath_info *pinfo);
1673 int (*get_mesh_config)(struct wiphy *wiphy,
1674 struct net_device *dev,
1675 struct mesh_config *conf);
1676 int (*update_mesh_config)(struct wiphy *wiphy,
1677 struct net_device *dev, u32 mask,
1678 const struct mesh_config *nconf);
1679 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1680 const struct mesh_config *conf,
1681 const struct mesh_setup *setup);
1682 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1684 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1685 struct bss_parameters *params);
1687 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
1688 struct ieee80211_txq_params *params);
1690 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
1691 struct net_device *dev,
1692 struct ieee80211_channel *chan);
1694 int (*set_monitor_channel)(struct wiphy *wiphy,
1695 struct ieee80211_channel *chan,
1696 enum nl80211_channel_type channel_type);
1698 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
1699 struct cfg80211_scan_request *request);
1701 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1702 struct cfg80211_auth_request *req);
1703 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1704 struct cfg80211_assoc_request *req);
1705 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1706 struct cfg80211_deauth_request *req);
1707 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1708 struct cfg80211_disassoc_request *req);
1710 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1711 struct cfg80211_connect_params *sme);
1712 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1715 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1716 struct cfg80211_ibss_params *params);
1717 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1719 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1721 int (*set_tx_power)(struct wiphy *wiphy,
1722 enum nl80211_tx_power_setting type, int mbm);
1723 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1725 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1728 void (*rfkill_poll)(struct wiphy *wiphy);
1730 #ifdef CONFIG_NL80211_TESTMODE
1731 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1732 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
1733 struct netlink_callback *cb,
1734 void *data, int len);
1737 int (*set_bitrate_mask)(struct wiphy *wiphy,
1738 struct net_device *dev,
1740 const struct cfg80211_bitrate_mask *mask);
1742 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1743 int idx, struct survey_info *info);
1745 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1746 struct cfg80211_pmksa *pmksa);
1747 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1748 struct cfg80211_pmksa *pmksa);
1749 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1751 int (*remain_on_channel)(struct wiphy *wiphy,
1752 struct net_device *dev,
1753 struct ieee80211_channel *chan,
1754 enum nl80211_channel_type channel_type,
1755 unsigned int duration,
1757 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1758 struct net_device *dev,
1761 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
1762 struct ieee80211_channel *chan, bool offchan,
1763 enum nl80211_channel_type channel_type,
1764 bool channel_type_valid, unsigned int wait,
1765 const u8 *buf, size_t len, bool no_cck,
1766 bool dont_wait_for_ack, u64 *cookie);
1767 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1768 struct net_device *dev,
1771 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1772 bool enabled, int timeout);
1774 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1775 struct net_device *dev,
1776 s32 rssi_thold, u32 rssi_hyst);
1778 void (*mgmt_frame_register)(struct wiphy *wiphy,
1779 struct net_device *dev,
1780 u16 frame_type, bool reg);
1782 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1783 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1785 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1786 void (*get_ringparam)(struct wiphy *wiphy,
1787 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1789 int (*sched_scan_start)(struct wiphy *wiphy,
1790 struct net_device *dev,
1791 struct cfg80211_sched_scan_request *request);
1792 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
1794 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
1795 struct cfg80211_gtk_rekey_data *data);
1797 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1798 u8 *peer, u8 action_code, u8 dialog_token,
1799 u16 status_code, const u8 *buf, size_t len);
1800 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
1801 u8 *peer, enum nl80211_tdls_operation oper);
1803 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
1804 const u8 *peer, u64 *cookie);
1806 int (*set_noack_map)(struct wiphy *wiphy,
1807 struct net_device *dev,
1810 int (*get_et_sset_count)(struct wiphy *wiphy,
1811 struct net_device *dev, int sset);
1812 void (*get_et_stats)(struct wiphy *wiphy, struct net_device *dev,
1813 struct ethtool_stats *stats, u64 *data);
1814 void (*get_et_strings)(struct wiphy *wiphy, struct net_device *dev,
1815 u32 sset, u8 *data);
1817 void (*set_monitor_enabled)(struct wiphy *wiphy, bool enabled);
1821 * wireless hardware and networking interfaces structures
1822 * and registration/helper functions
1826 * enum wiphy_flags - wiphy capability flags
1828 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1829 * has its own custom regulatory domain and cannot identify the
1830 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1831 * we will disregard the first regulatory hint (when the
1832 * initiator is %REGDOM_SET_BY_CORE).
1833 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1834 * ignore regulatory domain settings until it gets its own regulatory
1835 * domain via its regulatory_hint() unless the regulatory hint is
1836 * from a country IE. After its gets its own regulatory domain it will
1837 * only allow further regulatory domain settings to further enhance
1838 * compliance. For example if channel 13 and 14 are disabled by this
1839 * regulatory domain no user regulatory domain can enable these channels
1840 * at a later time. This can be used for devices which do not have
1841 * calibration information guaranteed for frequencies or settings
1842 * outside of its regulatory domain. If used in combination with
1843 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
1845 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1846 * that passive scan flags and beaconing flags may not be lifted by
1847 * cfg80211 due to regulatory beacon hints. For more information on beacon
1848 * hints read the documenation for regulatory_hint_found_beacon()
1849 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1851 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1852 * by default -- this flag will be set depending on the kernel's default
1853 * on wiphy_new(), but can be changed by the driver if it has a good
1854 * reason to override the default
1855 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1856 * on a VLAN interface)
1857 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1858 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1859 * control port protocol ethertype. The device also honours the
1860 * control_port_no_encrypt flag.
1861 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1862 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1863 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1864 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
1865 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
1867 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
1868 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
1869 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
1870 * link setup/discovery operations internally. Setup, discovery and
1871 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
1872 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
1873 * used for asking the driver/firmware to perform a TDLS operation.
1874 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
1875 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
1876 * when there are virtual interfaces in AP mode by calling
1877 * cfg80211_report_obss_beacon().
1878 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
1879 * responds to probe-requests in hardware.
1880 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
1881 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
1884 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1885 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1886 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1887 WIPHY_FLAG_NETNS_OK = BIT(3),
1888 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1889 WIPHY_FLAG_4ADDR_AP = BIT(5),
1890 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1891 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
1892 WIPHY_FLAG_IBSS_RSN = BIT(8),
1893 WIPHY_FLAG_MESH_AUTH = BIT(10),
1894 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
1895 /* use hole at 12 */
1896 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
1897 WIPHY_FLAG_AP_UAPSD = BIT(14),
1898 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
1899 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
1900 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
1901 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
1902 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
1903 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
1904 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
1908 * struct ieee80211_iface_limit - limit on certain interface types
1909 * @max: maximum number of interfaces of these types
1910 * @types: interface types (bits)
1912 struct ieee80211_iface_limit {
1918 * struct ieee80211_iface_combination - possible interface combination
1919 * @limits: limits for the given interface types
1920 * @n_limits: number of limitations
1921 * @num_different_channels: can use up to this many different channels
1922 * @max_interfaces: maximum number of interfaces in total allowed in this
1924 * @beacon_int_infra_match: In this combination, the beacon intervals
1925 * between infrastructure and AP types must match. This is required
1926 * only in special cases.
1928 * These examples can be expressed as follows:
1930 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
1932 * struct ieee80211_iface_limit limits1[] = {
1933 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1934 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
1936 * struct ieee80211_iface_combination combination1 = {
1937 * .limits = limits1,
1938 * .n_limits = ARRAY_SIZE(limits1),
1939 * .max_interfaces = 2,
1940 * .beacon_int_infra_match = true,
1944 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
1946 * struct ieee80211_iface_limit limits2[] = {
1947 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
1948 * BIT(NL80211_IFTYPE_P2P_GO), },
1950 * struct ieee80211_iface_combination combination2 = {
1951 * .limits = limits2,
1952 * .n_limits = ARRAY_SIZE(limits2),
1953 * .max_interfaces = 8,
1954 * .num_different_channels = 1,
1958 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
1959 * This allows for an infrastructure connection and three P2P connections.
1961 * struct ieee80211_iface_limit limits3[] = {
1962 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1963 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
1964 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
1966 * struct ieee80211_iface_combination combination3 = {
1967 * .limits = limits3,
1968 * .n_limits = ARRAY_SIZE(limits3),
1969 * .max_interfaces = 4,
1970 * .num_different_channels = 2,
1973 struct ieee80211_iface_combination {
1974 const struct ieee80211_iface_limit *limits;
1975 u32 num_different_channels;
1978 bool beacon_int_infra_match;
1981 struct mac_address {
1985 struct ieee80211_txrx_stypes {
1990 * enum wiphy_wowlan_support_flags - WoWLAN support flags
1991 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
1992 * trigger that keeps the device operating as-is and
1993 * wakes up the host on any activity, for example a
1994 * received packet that passed filtering; note that the
1995 * packet should be preserved in that case
1996 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
1998 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
1999 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2000 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2001 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2002 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2003 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2005 enum wiphy_wowlan_support_flags {
2006 WIPHY_WOWLAN_ANY = BIT(0),
2007 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
2008 WIPHY_WOWLAN_DISCONNECT = BIT(2),
2009 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
2010 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
2011 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
2012 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
2013 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
2017 * struct wiphy_wowlan_support - WoWLAN support data
2018 * @flags: see &enum wiphy_wowlan_support_flags
2019 * @n_patterns: number of supported wakeup patterns
2020 * (see nl80211.h for the pattern definition)
2021 * @pattern_max_len: maximum length of each pattern
2022 * @pattern_min_len: minimum length of each pattern
2024 struct wiphy_wowlan_support {
2027 int pattern_max_len;
2028 int pattern_min_len;
2032 * struct wiphy - wireless hardware description
2033 * @reg_notifier: the driver's regulatory notification callback,
2034 * note that if your driver uses wiphy_apply_custom_regulatory()
2035 * the reg_notifier's request can be passed as NULL
2036 * @regd: the driver's regulatory domain, if one was requested via
2037 * the regulatory_hint() API. This can be used by the driver
2038 * on the reg_notifier() if it chooses to ignore future
2039 * regulatory domain changes caused by other drivers.
2040 * @signal_type: signal type reported in &struct cfg80211_bss.
2041 * @cipher_suites: supported cipher suites
2042 * @n_cipher_suites: number of supported cipher suites
2043 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2044 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2045 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2046 * -1 = fragmentation disabled, only odd values >= 256 used
2047 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2048 * @_net: the network namespace this wiphy currently lives in
2049 * @perm_addr: permanent MAC address of this device
2050 * @addr_mask: If the device supports multiple MAC addresses by masking,
2051 * set this to a mask with variable bits set to 1, e.g. if the last
2052 * four bits are variable then set it to 00:...:00:0f. The actual
2053 * variable bits shall be determined by the interfaces added, with
2054 * interfaces not matching the mask being rejected to be brought up.
2055 * @n_addresses: number of addresses in @addresses.
2056 * @addresses: If the device has more than one address, set this pointer
2057 * to a list of addresses (6 bytes each). The first one will be used
2058 * by default for perm_addr. In this case, the mask should be set to
2059 * all-zeroes. In this case it is assumed that the device can handle
2060 * the same number of arbitrary MAC addresses.
2061 * @registered: protects ->resume and ->suspend sysfs callbacks against
2062 * unregister hardware
2063 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2064 * automatically on wiphy renames
2065 * @dev: (virtual) struct device for this wiphy
2066 * @registered: helps synchronize suspend/resume with wiphy unregister
2067 * @wext: wireless extension handlers
2068 * @priv: driver private data (sized according to wiphy_new() parameter)
2069 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2070 * must be set by driver
2071 * @iface_combinations: Valid interface combinations array, should not
2072 * list single interface types.
2073 * @n_iface_combinations: number of entries in @iface_combinations array.
2074 * @software_iftypes: bitmask of software interface types, these are not
2075 * subject to any restrictions since they are purely managed in SW.
2076 * @flags: wiphy flags, see &enum wiphy_flags
2077 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2078 * @bss_priv_size: each BSS struct has private data allocated with it,
2079 * this variable determines its size
2080 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2082 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2083 * for in any given scheduled scan
2084 * @max_match_sets: maximum number of match sets the device can handle
2085 * when performing a scheduled scan, 0 if filtering is not
2087 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2088 * add to probe request frames transmitted during a scan, must not
2089 * include fixed IEs like supported rates
2090 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2092 * @coverage_class: current coverage class
2093 * @fw_version: firmware version for ethtool reporting
2094 * @hw_version: hardware version for ethtool reporting
2095 * @max_num_pmkids: maximum number of PMKIDs supported by device
2096 * @privid: a pointer that drivers can use to identify if an arbitrary
2097 * wiphy is theirs, e.g. in global notifiers
2098 * @bands: information about bands/channels supported by this device
2100 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2101 * transmitted through nl80211, points to an array indexed by interface
2104 * @available_antennas_tx: bitmap of antennas which are available to be
2105 * configured as TX antennas. Antenna configuration commands will be
2106 * rejected unless this or @available_antennas_rx is set.
2108 * @available_antennas_rx: bitmap of antennas which are available to be
2109 * configured as RX antennas. Antenna configuration commands will be
2110 * rejected unless this or @available_antennas_tx is set.
2112 * @probe_resp_offload:
2113 * Bitmap of supported protocols for probe response offloading.
2114 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2115 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2117 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2118 * may request, if implemented.
2120 * @wowlan: WoWLAN support information
2122 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2123 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2124 * If null, then none can be over-ridden.
2127 /* assign these fields before you register the wiphy */
2129 /* permanent MAC address(es) */
2130 u8 perm_addr[ETH_ALEN];
2131 u8 addr_mask[ETH_ALEN];
2133 struct mac_address *addresses;
2135 const struct ieee80211_txrx_stypes *mgmt_stypes;
2137 const struct ieee80211_iface_combination *iface_combinations;
2138 int n_iface_combinations;
2139 u16 software_iftypes;
2143 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2144 u16 interface_modes;
2146 u32 flags, features;
2150 enum cfg80211_signal_type signal_type;
2154 u8 max_sched_scan_ssids;
2156 u16 max_scan_ie_len;
2157 u16 max_sched_scan_ie_len;
2159 int n_cipher_suites;
2160 const u32 *cipher_suites;
2168 char fw_version[ETHTOOL_BUSINFO_LEN];
2172 struct wiphy_wowlan_support wowlan;
2175 u16 max_remain_on_channel_duration;
2179 u32 available_antennas_tx;
2180 u32 available_antennas_rx;
2183 * Bitmap of supported protocols for probe response offloading
2184 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2185 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2187 u32 probe_resp_offload;
2189 /* If multiple wiphys are registered and you're handed e.g.
2190 * a regular netdev with assigned ieee80211_ptr, you won't
2191 * know whether it points to a wiphy your driver has registered
2192 * or not. Assign this to something global to your driver to
2193 * help determine whether you own this wiphy or not. */
2196 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2198 /* Lets us get back the wiphy on the callback */
2199 int (*reg_notifier)(struct wiphy *wiphy,
2200 struct regulatory_request *request);
2202 /* fields below are read-only, assigned by cfg80211 */
2204 const struct ieee80211_regdomain *regd;
2206 /* the item in /sys/class/ieee80211/ points to this,
2207 * you need use set_wiphy_dev() (see below) */
2210 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2213 /* dir in debugfs: ieee80211/<wiphyname> */
2214 struct dentry *debugfsdir;
2216 const struct ieee80211_ht_cap *ht_capa_mod_mask;
2218 #ifdef CONFIG_NET_NS
2219 /* the network namespace this phy lives in currently */
2223 #ifdef CONFIG_CFG80211_WEXT
2224 const struct iw_handler_def *wext;
2227 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
2230 static inline struct net *wiphy_net(struct wiphy *wiphy)
2232 return read_pnet(&wiphy->_net);
2235 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2237 write_pnet(&wiphy->_net, net);
2241 * wiphy_priv - return priv from wiphy
2243 * @wiphy: the wiphy whose priv pointer to return
2245 static inline void *wiphy_priv(struct wiphy *wiphy)
2248 return &wiphy->priv;
2252 * priv_to_wiphy - return the wiphy containing the priv
2254 * @priv: a pointer previously returned by wiphy_priv
2256 static inline struct wiphy *priv_to_wiphy(void *priv)
2259 return container_of(priv, struct wiphy, priv);
2263 * set_wiphy_dev - set device pointer for wiphy
2265 * @wiphy: The wiphy whose device to bind
2266 * @dev: The device to parent it to
2268 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2270 wiphy->dev.parent = dev;
2274 * wiphy_dev - get wiphy dev pointer
2276 * @wiphy: The wiphy whose device struct to look up
2278 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2280 return wiphy->dev.parent;
2284 * wiphy_name - get wiphy name
2286 * @wiphy: The wiphy whose name to return
2288 static inline const char *wiphy_name(const struct wiphy *wiphy)
2290 return dev_name(&wiphy->dev);
2294 * wiphy_new - create a new wiphy for use with cfg80211
2296 * @ops: The configuration operations for this device
2297 * @sizeof_priv: The size of the private area to allocate
2299 * Create a new wiphy and associate the given operations with it.
2300 * @sizeof_priv bytes are allocated for private use.
2302 * The returned pointer must be assigned to each netdev's
2303 * ieee80211_ptr for proper operation.
2305 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2308 * wiphy_register - register a wiphy with cfg80211
2310 * @wiphy: The wiphy to register.
2312 * Returns a non-negative wiphy index or a negative error code.
2314 extern int wiphy_register(struct wiphy *wiphy);
2317 * wiphy_unregister - deregister a wiphy from cfg80211
2319 * @wiphy: The wiphy to unregister.
2321 * After this call, no more requests can be made with this priv
2322 * pointer, but the call may sleep to wait for an outstanding
2323 * request that is being handled.
2325 extern void wiphy_unregister(struct wiphy *wiphy);
2328 * wiphy_free - free wiphy
2330 * @wiphy: The wiphy to free
2332 extern void wiphy_free(struct wiphy *wiphy);
2334 /* internal structs */
2335 struct cfg80211_conn;
2336 struct cfg80211_internal_bss;
2337 struct cfg80211_cached_keys;
2340 * struct wireless_dev - wireless per-netdev state
2342 * This structure must be allocated by the driver/stack
2343 * that uses the ieee80211_ptr field in struct net_device
2344 * (this is intentional so it can be allocated along with
2347 * @wiphy: pointer to hardware description
2348 * @iftype: interface type
2349 * @list: (private) Used to collect the interfaces
2350 * @netdev: (private) Used to reference back to the netdev
2351 * @current_bss: (private) Used by the internal configuration code
2352 * @channel: (private) Used by the internal configuration code to track
2353 * the user-set AP, monitor and WDS channel
2354 * @preset_chan: (private) Used by the internal configuration code to
2355 * track the channel to be used for AP later
2356 * @preset_chantype: (private) the corresponding channel type
2357 * @bssid: (private) Used by the internal configuration code
2358 * @ssid: (private) Used by the internal configuration code
2359 * @ssid_len: (private) Used by the internal configuration code
2360 * @mesh_id_len: (private) Used by the internal configuration code
2361 * @mesh_id_up_len: (private) Used by the internal configuration code
2362 * @wext: (private) Used by the internal wireless extensions compat code
2363 * @use_4addr: indicates 4addr mode is used on this interface, must be
2364 * set by driver (if supported) on add_interface BEFORE registering the
2365 * netdev and may otherwise be used by driver read-only, will be update
2366 * by cfg80211 on change_interface
2367 * @mgmt_registrations: list of registrations for management frames
2368 * @mgmt_registrations_lock: lock for the list
2369 * @mtx: mutex used to lock data in this struct
2370 * @cleanup_work: work struct used for cleanup that can't be done directly
2371 * @beacon_interval: beacon interval used on this device for transmitting
2372 * beacons, 0 when not valid
2374 struct wireless_dev {
2375 struct wiphy *wiphy;
2376 enum nl80211_iftype iftype;
2378 /* the remainder of this struct should be private to cfg80211 */
2379 struct list_head list;
2380 struct net_device *netdev;
2382 struct list_head mgmt_registrations;
2383 spinlock_t mgmt_registrations_lock;
2387 struct work_struct cleanup_work;
2391 /* currently used for IBSS and SME - might be rearranged later */
2392 u8 ssid[IEEE80211_MAX_SSID_LEN];
2393 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2396 CFG80211_SME_CONNECTING,
2397 CFG80211_SME_CONNECTED,
2399 struct cfg80211_conn *conn;
2400 struct cfg80211_cached_keys *connect_keys;
2402 struct list_head event_list;
2403 spinlock_t event_lock;
2405 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2406 struct ieee80211_channel *preset_chan;
2407 enum nl80211_channel_type preset_chantype;
2409 /* for AP and mesh channel tracking */
2410 struct ieee80211_channel *channel;
2417 int beacon_interval;
2419 u32 ap_unexpected_nlpid;
2421 #ifdef CONFIG_CFG80211_WEXT
2424 struct cfg80211_ibss_params ibss;
2425 struct cfg80211_connect_params connect;
2426 struct cfg80211_cached_keys *keys;
2429 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2430 u8 ssid[IEEE80211_MAX_SSID_LEN];
2431 s8 default_key, default_mgmt_key;
2432 bool prev_bssid_valid;
2438 * wdev_priv - return wiphy priv from wireless_dev
2440 * @wdev: The wireless device whose wiphy's priv pointer to return
2442 static inline void *wdev_priv(struct wireless_dev *wdev)
2445 return wiphy_priv(wdev->wiphy);
2449 * DOC: Utility functions
2451 * cfg80211 offers a number of utility functions that can be useful.
2455 * ieee80211_channel_to_frequency - convert channel number to frequency
2456 * @chan: channel number
2457 * @band: band, necessary due to channel number overlap
2459 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2462 * ieee80211_frequency_to_channel - convert frequency to channel number
2463 * @freq: center frequency
2465 extern int ieee80211_frequency_to_channel(int freq);
2468 * Name indirection necessary because the ieee80211 code also has
2469 * a function named "ieee80211_get_channel", so if you include
2470 * cfg80211's header file you get cfg80211's version, if you try
2471 * to include both header files you'll (rightfully!) get a symbol
2474 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2477 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2478 * @wiphy: the struct wiphy to get the channel for
2479 * @freq: the center frequency of the channel
2481 static inline struct ieee80211_channel *
2482 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2484 return __ieee80211_get_channel(wiphy, freq);
2488 * ieee80211_get_response_rate - get basic rate for a given rate
2490 * @sband: the band to look for rates in
2491 * @basic_rates: bitmap of basic rates
2492 * @bitrate: the bitrate for which to find the basic rate
2494 * This function returns the basic rate corresponding to a given
2495 * bitrate, that is the next lower bitrate contained in the basic
2496 * rate map, which is, for this function, given as a bitmap of
2497 * indices of rates in the band's bitrate table.
2499 struct ieee80211_rate *
2500 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2501 u32 basic_rates, int bitrate);
2504 * Radiotap parsing functions -- for controlled injection support
2506 * Implemented in net/wireless/radiotap.c
2507 * Documentation in Documentation/networking/radiotap-headers.txt
2510 struct radiotap_align_size {
2511 uint8_t align:4, size:4;
2514 struct ieee80211_radiotap_namespace {
2515 const struct radiotap_align_size *align_size;
2521 struct ieee80211_radiotap_vendor_namespaces {
2522 const struct ieee80211_radiotap_namespace *ns;
2527 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2528 * @this_arg_index: index of current arg, valid after each successful call
2529 * to ieee80211_radiotap_iterator_next()
2530 * @this_arg: pointer to current radiotap arg; it is valid after each
2531 * call to ieee80211_radiotap_iterator_next() but also after
2532 * ieee80211_radiotap_iterator_init() where it will point to
2533 * the beginning of the actual data portion
2534 * @this_arg_size: length of the current arg, for convenience
2535 * @current_namespace: pointer to the current namespace definition
2536 * (or internally %NULL if the current namespace is unknown)
2537 * @is_radiotap_ns: indicates whether the current namespace is the default
2538 * radiotap namespace or not
2540 * @_rtheader: pointer to the radiotap header we are walking through
2541 * @_max_length: length of radiotap header in cpu byte ordering
2542 * @_arg_index: next argument index
2543 * @_arg: next argument pointer
2544 * @_next_bitmap: internal pointer to next present u32
2545 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2546 * @_vns: vendor namespace definitions
2547 * @_next_ns_data: beginning of the next namespace's data
2548 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2551 * Describes the radiotap parser state. Fields prefixed with an underscore
2552 * must not be used by users of the parser, only by the parser internally.
2555 struct ieee80211_radiotap_iterator {
2556 struct ieee80211_radiotap_header *_rtheader;
2557 const struct ieee80211_radiotap_vendor_namespaces *_vns;
2558 const struct ieee80211_radiotap_namespace *current_namespace;
2560 unsigned char *_arg, *_next_ns_data;
2561 __le32 *_next_bitmap;
2563 unsigned char *this_arg;
2571 uint32_t _bitmap_shifter;
2575 extern int ieee80211_radiotap_iterator_init(
2576 struct ieee80211_radiotap_iterator *iterator,
2577 struct ieee80211_radiotap_header *radiotap_header,
2578 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
2580 extern int ieee80211_radiotap_iterator_next(
2581 struct ieee80211_radiotap_iterator *iterator);
2584 extern const unsigned char rfc1042_header[6];
2585 extern const unsigned char bridge_tunnel_header[6];
2588 * ieee80211_get_hdrlen_from_skb - get header length from data
2590 * Given an skb with a raw 802.11 header at the data pointer this function
2591 * returns the 802.11 header length in bytes (not including encryption
2592 * headers). If the data in the sk_buff is too short to contain a valid 802.11
2593 * header the function returns 0.
2597 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
2600 * ieee80211_hdrlen - get header length in bytes from frame control
2601 * @fc: frame control field in little-endian format
2603 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2606 * DOC: Data path helpers
2608 * In addition to generic utilities, cfg80211 also offers
2609 * functions that help implement the data path for devices
2610 * that do not do the 802.11/802.3 conversion on the device.
2614 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2615 * @skb: the 802.11 data frame
2616 * @addr: the device MAC address
2617 * @iftype: the virtual interface type
2619 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2620 enum nl80211_iftype iftype);
2623 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2624 * @skb: the 802.3 frame
2625 * @addr: the device MAC address
2626 * @iftype: the virtual interface type
2627 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2628 * @qos: build 802.11 QoS data frame
2630 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2631 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2634 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2636 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2637 * 802.3 frames. The @list will be empty if the decode fails. The
2638 * @skb is consumed after the function returns.
2640 * @skb: The input IEEE 802.11n A-MSDU frame.
2641 * @list: The output list of 802.3 frames. It must be allocated and
2642 * initialized by by the caller.
2643 * @addr: The device MAC address.
2644 * @iftype: The device interface type.
2645 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2646 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2648 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2649 const u8 *addr, enum nl80211_iftype iftype,
2650 const unsigned int extra_headroom,
2651 bool has_80211_header);
2654 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2655 * @skb: the data frame
2657 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2660 * cfg80211_find_ie - find information element in data
2663 * @ies: data consisting of IEs
2664 * @len: length of data
2666 * This function will return %NULL if the element ID could
2667 * not be found or if the element is invalid (claims to be
2668 * longer than the given data), or a pointer to the first byte
2669 * of the requested element, that is the byte containing the
2670 * element ID. There are no checks on the element length
2671 * other than having to fit into the given data.
2673 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2676 * cfg80211_find_vendor_ie - find vendor specific information element in data
2679 * @oui_type: vendor-specific OUI type
2680 * @ies: data consisting of IEs
2681 * @len: length of data
2683 * This function will return %NULL if the vendor specific element ID
2684 * could not be found or if the element is invalid (claims to be
2685 * longer than the given data), or a pointer to the first byte
2686 * of the requested element, that is the byte containing the
2687 * element ID. There are no checks on the element length
2688 * other than having to fit into the given data.
2690 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
2691 const u8 *ies, int len);
2694 * DOC: Regulatory enforcement infrastructure
2700 * regulatory_hint - driver hint to the wireless core a regulatory domain
2701 * @wiphy: the wireless device giving the hint (used only for reporting
2703 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2704 * should be in. If @rd is set this should be NULL. Note that if you
2705 * set this to NULL you should still set rd->alpha2 to some accepted
2708 * Wireless drivers can use this function to hint to the wireless core
2709 * what it believes should be the current regulatory domain by
2710 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2711 * domain should be in or by providing a completely build regulatory domain.
2712 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2713 * for a regulatory domain structure for the respective country.
2715 * The wiphy must have been registered to cfg80211 prior to this call.
2716 * For cfg80211 drivers this means you must first use wiphy_register(),
2717 * for mac80211 drivers you must first use ieee80211_register_hw().
2719 * Drivers should check the return value, its possible you can get
2722 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2725 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2726 * @wiphy: the wireless device we want to process the regulatory domain on
2727 * @regd: the custom regulatory domain to use for this wiphy
2729 * Drivers can sometimes have custom regulatory domains which do not apply
2730 * to a specific country. Drivers can use this to apply such custom regulatory
2731 * domains. This routine must be called prior to wiphy registration. The
2732 * custom regulatory domain will be trusted completely and as such previous
2733 * default channel settings will be disregarded. If no rule is found for a
2734 * channel on the regulatory domain the channel will be disabled.
2736 extern void wiphy_apply_custom_regulatory(
2737 struct wiphy *wiphy,
2738 const struct ieee80211_regdomain *regd);
2741 * freq_reg_info - get regulatory information for the given frequency
2742 * @wiphy: the wiphy for which we want to process this rule for
2743 * @center_freq: Frequency in KHz for which we want regulatory information for
2744 * @desired_bw_khz: the desired max bandwidth you want to use per
2745 * channel. Note that this is still 20 MHz if you want to use HT40
2746 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2747 * If set to 0 we'll assume you want the standard 20 MHz.
2748 * @reg_rule: the regulatory rule which we have for this frequency
2750 * Use this function to get the regulatory rule for a specific frequency on
2751 * a given wireless device. If the device has a specific regulatory domain
2752 * it wants to follow we respect that unless a country IE has been received
2753 * and processed already.
2755 * Returns 0 if it was able to find a valid regulatory rule which does
2756 * apply to the given center_freq otherwise it returns non-zero. It will
2757 * also return -ERANGE if we determine the given center_freq does not even have
2758 * a regulatory rule for a frequency range in the center_freq's band. See
2759 * freq_in_rule_band() for our current definition of a band -- this is purely
2760 * subjective and right now its 802.11 specific.
2762 extern int freq_reg_info(struct wiphy *wiphy,
2765 const struct ieee80211_reg_rule **reg_rule);
2768 * callbacks for asynchronous cfg80211 methods, notification
2769 * functions and BSS handling helpers
2773 * cfg80211_scan_done - notify that scan finished
2775 * @request: the corresponding scan request
2776 * @aborted: set to true if the scan was aborted for any reason,
2777 * userspace will be notified of that
2779 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2782 * cfg80211_sched_scan_results - notify that new scan results are available
2784 * @wiphy: the wiphy which got scheduled scan results
2786 void cfg80211_sched_scan_results(struct wiphy *wiphy);
2789 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
2791 * @wiphy: the wiphy on which the scheduled scan stopped
2793 * The driver can call this function to inform cfg80211 that the
2794 * scheduled scan had to be stopped, for whatever reason. The driver
2795 * is then called back via the sched_scan_stop operation when done.
2797 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
2800 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2802 * @wiphy: the wiphy reporting the BSS
2803 * @channel: The channel the frame was received on
2804 * @mgmt: the management frame (probe response or beacon)
2805 * @len: length of the management frame
2806 * @signal: the signal strength, type depends on the wiphy's signal_type
2807 * @gfp: context flags
2809 * This informs cfg80211 that BSS information was found and
2810 * the BSS should be updated/added.
2812 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2814 struct cfg80211_bss * __must_check
2815 cfg80211_inform_bss_frame(struct wiphy *wiphy,
2816 struct ieee80211_channel *channel,
2817 struct ieee80211_mgmt *mgmt, size_t len,
2818 s32 signal, gfp_t gfp);
2821 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2823 * @wiphy: the wiphy reporting the BSS
2824 * @channel: The channel the frame was received on
2825 * @bssid: the BSSID of the BSS
2826 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
2827 * @capability: the capability field sent by the peer
2828 * @beacon_interval: the beacon interval announced by the peer
2829 * @ie: additional IEs sent by the peer
2830 * @ielen: length of the additional IEs
2831 * @signal: the signal strength, type depends on the wiphy's signal_type
2832 * @gfp: context flags
2834 * This informs cfg80211 that BSS information was found and
2835 * the BSS should be updated/added.
2837 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2839 struct cfg80211_bss * __must_check
2840 cfg80211_inform_bss(struct wiphy *wiphy,
2841 struct ieee80211_channel *channel,
2842 const u8 *bssid, u64 tsf, u16 capability,
2843 u16 beacon_interval, const u8 *ie, size_t ielen,
2844 s32 signal, gfp_t gfp);
2846 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2847 struct ieee80211_channel *channel,
2849 const u8 *ssid, size_t ssid_len,
2850 u16 capa_mask, u16 capa_val);
2851 static inline struct cfg80211_bss *
2852 cfg80211_get_ibss(struct wiphy *wiphy,
2853 struct ieee80211_channel *channel,
2854 const u8 *ssid, size_t ssid_len)
2856 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2857 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2860 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2861 struct ieee80211_channel *channel,
2862 const u8 *meshid, size_t meshidlen,
2865 * cfg80211_ref_bss - reference BSS struct
2866 * @bss: the BSS struct to reference
2868 * Increments the refcount of the given BSS struct.
2870 void cfg80211_ref_bss(struct cfg80211_bss *bss);
2873 * cfg80211_put_bss - unref BSS struct
2874 * @bss: the BSS struct
2876 * Decrements the refcount of the given BSS struct.
2878 void cfg80211_put_bss(struct cfg80211_bss *bss);
2881 * cfg80211_unlink_bss - unlink BSS from internal data structures
2883 * @bss: the bss to remove
2885 * This function removes the given BSS from the internal data structures
2886 * thereby making it no longer show up in scan results etc. Use this
2887 * function when you detect a BSS is gone. Normally BSSes will also time
2888 * out, so it is not necessary to use this function at all.
2890 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
2893 * cfg80211_send_rx_auth - notification of processed authentication
2894 * @dev: network device
2895 * @buf: authentication frame (header + body)
2896 * @len: length of the frame data
2898 * This function is called whenever an authentication has been processed in
2899 * station mode. The driver is required to call either this function or
2900 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2901 * call. This function may sleep.
2903 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
2906 * cfg80211_send_auth_timeout - notification of timed out authentication
2907 * @dev: network device
2908 * @addr: The MAC address of the device with which the authentication timed out
2910 * This function may sleep.
2912 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
2915 * cfg80211_send_rx_assoc - notification of processed association
2916 * @dev: network device
2917 * @bss: the BSS struct association was requested for, the struct reference
2918 * is owned by cfg80211 after this call
2919 * @buf: (re)association response frame (header + body)
2920 * @len: length of the frame data
2922 * This function is called whenever a (re)association response has been
2923 * processed in station mode. The driver is required to call either this
2924 * function or cfg80211_send_assoc_timeout() to indicate the result of
2925 * cfg80211_ops::assoc() call. This function may sleep.
2927 void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
2928 const u8 *buf, size_t len);
2931 * cfg80211_send_assoc_timeout - notification of timed out association
2932 * @dev: network device
2933 * @addr: The MAC address of the device with which the association timed out
2935 * This function may sleep.
2937 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
2940 * cfg80211_send_deauth - notification of processed deauthentication
2941 * @dev: network device
2942 * @buf: deauthentication frame (header + body)
2943 * @len: length of the frame data
2945 * This function is called whenever deauthentication has been processed in
2946 * station mode. This includes both received deauthentication frames and
2947 * locally generated ones. This function may sleep.
2949 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2952 * __cfg80211_send_deauth - notification of processed deauthentication
2953 * @dev: network device
2954 * @buf: deauthentication frame (header + body)
2955 * @len: length of the frame data
2957 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2959 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2962 * cfg80211_send_disassoc - notification of processed disassociation
2963 * @dev: network device
2964 * @buf: disassociation response frame (header + body)
2965 * @len: length of the frame data
2967 * This function is called whenever disassociation has been processed in
2968 * station mode. This includes both received disassociation frames and locally
2969 * generated ones. This function may sleep.
2971 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
2974 * __cfg80211_send_disassoc - notification of processed disassociation
2975 * @dev: network device
2976 * @buf: disassociation response frame (header + body)
2977 * @len: length of the frame data
2979 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2981 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
2985 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
2986 * @dev: network device
2987 * @buf: deauthentication frame (header + body)
2988 * @len: length of the frame data
2990 * This function is called whenever a received Deauthentication frame has been
2991 * dropped in station mode because of MFP being used but the Deauthentication
2992 * frame was not protected. This function may sleep.
2994 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
2998 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
2999 * @dev: network device
3000 * @buf: disassociation frame (header + body)
3001 * @len: length of the frame data
3003 * This function is called whenever a received Disassociation frame has been
3004 * dropped in station mode because of MFP being used but the Disassociation
3005 * frame was not protected. This function may sleep.
3007 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
3011 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3012 * @dev: network device
3013 * @addr: The source MAC address of the frame
3014 * @key_type: The key type that the received frame used
3015 * @key_id: Key identifier (0..3). Can be -1 if missing.
3016 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3017 * @gfp: allocation flags
3019 * This function is called whenever the local MAC detects a MIC failure in a
3020 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3023 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
3024 enum nl80211_key_type key_type, int key_id,
3025 const u8 *tsc, gfp_t gfp);
3028 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3030 * @dev: network device
3031 * @bssid: the BSSID of the IBSS joined
3032 * @gfp: allocation flags
3034 * This function notifies cfg80211 that the device joined an IBSS or
3035 * switched to a different BSSID. Before this function can be called,
3036 * either a beacon has to have been received from the IBSS, or one of
3037 * the cfg80211_inform_bss{,_frame} functions must have been called
3038 * with the locally generated beacon -- this guarantees that there is
3039 * always a scan result for this IBSS. cfg80211 will handle the rest.
3041 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
3044 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3046 * @dev: network device
3047 * @macaddr: the MAC address of the new candidate
3048 * @ie: information elements advertised by the peer candidate
3049 * @ie_len: lenght of the information elements buffer
3050 * @gfp: allocation flags
3052 * This function notifies cfg80211 that the mesh peer candidate has been
3053 * detected, most likely via a beacon or, less likely, via a probe response.
3054 * cfg80211 then sends a notification to userspace.
3056 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
3057 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
3060 * DOC: RFkill integration
3062 * RFkill integration in cfg80211 is almost invisible to drivers,
3063 * as cfg80211 automatically registers an rfkill instance for each
3064 * wireless device it knows about. Soft kill is also translated
3065 * into disconnecting and turning all interfaces off, drivers are
3066 * expected to turn off the device when all interfaces are down.
3068 * However, devices may have a hard RFkill line, in which case they
3069 * also need to interact with the rfkill subsystem, via cfg80211.
3070 * They can do this with a few helper functions documented here.
3074 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3076 * @blocked: block status
3078 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
3081 * wiphy_rfkill_start_polling - start polling rfkill
3084 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
3087 * wiphy_rfkill_stop_polling - stop polling rfkill
3090 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
3092 #ifdef CONFIG_NL80211_TESTMODE
3096 * Test mode is a set of utility functions to allow drivers to
3097 * interact with driver-specific tools to aid, for instance,
3098 * factory programming.
3100 * This chapter describes how drivers interact with it, for more
3101 * information see the nl80211 book's chapter on it.
3105 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3107 * @approxlen: an upper bound of the length of the data that will
3108 * be put into the skb
3110 * This function allocates and pre-fills an skb for a reply to
3111 * the testmode command. Since it is intended for a reply, calling
3112 * it outside of the @testmode_cmd operation is invalid.
3114 * The returned skb (or %NULL if any errors happen) is pre-filled
3115 * with the wiphy index and set up in a way that any data that is
3116 * put into the skb (with skb_put(), nla_put() or similar) will end
3117 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
3118 * needs to be done with the skb is adding data for the corresponding
3119 * userspace tool which can then read that data out of the testdata
3120 * attribute. You must not modify the skb in any other way.
3122 * When done, call cfg80211_testmode_reply() with the skb and return
3123 * its error code as the result of the @testmode_cmd operation.
3125 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
3129 * cfg80211_testmode_reply - send the reply skb
3130 * @skb: The skb, must have been allocated with
3131 * cfg80211_testmode_alloc_reply_skb()
3133 * Returns an error code or 0 on success, since calling this
3134 * function will usually be the last thing before returning
3135 * from the @testmode_cmd you should return the error code.
3136 * Note that this function consumes the skb regardless of the
3139 int cfg80211_testmode_reply(struct sk_buff *skb);
3142 * cfg80211_testmode_alloc_event_skb - allocate testmode event
3144 * @approxlen: an upper bound of the length of the data that will
3145 * be put into the skb
3146 * @gfp: allocation flags
3148 * This function allocates and pre-fills an skb for an event on the
3149 * testmode multicast group.
3151 * The returned skb (or %NULL if any errors happen) is set up in the
3152 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
3153 * for an event. As there, you should simply add data to it that will
3154 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
3155 * not modify the skb in any other way.
3157 * When done filling the skb, call cfg80211_testmode_event() with the
3158 * skb to send the event.
3160 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
3161 int approxlen, gfp_t gfp);
3164 * cfg80211_testmode_event - send the event
3165 * @skb: The skb, must have been allocated with
3166 * cfg80211_testmode_alloc_event_skb()
3167 * @gfp: allocation flags
3169 * This function sends the given @skb, which must have been allocated
3170 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3173 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3175 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3176 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3178 #define CFG80211_TESTMODE_CMD(cmd)
3179 #define CFG80211_TESTMODE_DUMP(cmd)
3183 * cfg80211_connect_result - notify cfg80211 of connection result
3185 * @dev: network device
3186 * @bssid: the BSSID of the AP
3187 * @req_ie: association request IEs (maybe be %NULL)
3188 * @req_ie_len: association request IEs length
3189 * @resp_ie: association response IEs (may be %NULL)
3190 * @resp_ie_len: assoc response IEs length
3191 * @status: status code, 0 for successful connection, use
3192 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3193 * the real status code for failures.
3194 * @gfp: allocation flags
3196 * It should be called by the underlying driver whenever connect() has
3199 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3200 const u8 *req_ie, size_t req_ie_len,
3201 const u8 *resp_ie, size_t resp_ie_len,
3202 u16 status, gfp_t gfp);
3205 * cfg80211_roamed - notify cfg80211 of roaming
3207 * @dev: network device
3208 * @channel: the channel of the new AP
3209 * @bssid: the BSSID of the new AP
3210 * @req_ie: association request IEs (maybe be %NULL)
3211 * @req_ie_len: association request IEs length
3212 * @resp_ie: association response IEs (may be %NULL)
3213 * @resp_ie_len: assoc response IEs length
3214 * @gfp: allocation flags
3216 * It should be called by the underlying driver whenever it roamed
3217 * from one AP to another while connected.
3219 void cfg80211_roamed(struct net_device *dev,
3220 struct ieee80211_channel *channel,
3222 const u8 *req_ie, size_t req_ie_len,
3223 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3226 * cfg80211_roamed_bss - notify cfg80211 of roaming
3228 * @dev: network device
3229 * @bss: entry of bss to which STA got roamed
3230 * @req_ie: association request IEs (maybe be %NULL)
3231 * @req_ie_len: association request IEs length
3232 * @resp_ie: association response IEs (may be %NULL)
3233 * @resp_ie_len: assoc response IEs length
3234 * @gfp: allocation flags
3236 * This is just a wrapper to notify cfg80211 of roaming event with driver
3237 * passing bss to avoid a race in timeout of the bss entry. It should be
3238 * called by the underlying driver whenever it roamed from one AP to another
3239 * while connected. Drivers which have roaming implemented in firmware
3240 * may use this function to avoid a race in bss entry timeout where the bss
3241 * entry of the new AP is seen in the driver, but gets timed out by the time
3242 * it is accessed in __cfg80211_roamed() due to delay in scheduling
3243 * rdev->event_work. In case of any failures, the reference is released
3244 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3245 * it will be released while diconneting from the current bss.
3247 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3248 const u8 *req_ie, size_t req_ie_len,
3249 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3252 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3254 * @dev: network device
3255 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3256 * @ie_len: length of IEs
3257 * @reason: reason code for the disconnection, set it to 0 if unknown
3258 * @gfp: allocation flags
3260 * After it calls this function, the driver should enter an idle state
3261 * and not try to connect to any AP any more.
3263 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3264 u8 *ie, size_t ie_len, gfp_t gfp);
3267 * cfg80211_ready_on_channel - notification of remain_on_channel start
3268 * @dev: network device
3269 * @cookie: the request cookie
3270 * @chan: The current channel (from remain_on_channel request)
3271 * @channel_type: Channel type
3272 * @duration: Duration in milliseconds that the driver intents to remain on the
3274 * @gfp: allocation flags
3276 void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
3277 struct ieee80211_channel *chan,
3278 enum nl80211_channel_type channel_type,
3279 unsigned int duration, gfp_t gfp);
3282 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3283 * @dev: network device
3284 * @cookie: the request cookie
3285 * @chan: The current channel (from remain_on_channel request)
3286 * @channel_type: Channel type
3287 * @gfp: allocation flags
3289 void cfg80211_remain_on_channel_expired(struct net_device *dev,
3291 struct ieee80211_channel *chan,
3292 enum nl80211_channel_type channel_type,
3297 * cfg80211_new_sta - notify userspace about station
3300 * @mac_addr: the station's address
3301 * @sinfo: the station information
3302 * @gfp: allocation flags
3304 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3305 struct station_info *sinfo, gfp_t gfp);
3308 * cfg80211_del_sta - notify userspace about deletion of a station
3311 * @mac_addr: the station's address
3312 * @gfp: allocation flags
3314 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3317 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3318 * @dev: network device
3319 * @freq: Frequency on which the frame was received in MHz
3320 * @sig_dbm: signal strength in mBm, or 0 if unknown
3321 * @buf: Management frame (header + body)
3322 * @len: length of the frame data
3323 * @gfp: context flags
3325 * Returns %true if a user space application has registered for this frame.
3326 * For action frames, that makes it responsible for rejecting unrecognized
3327 * action frames; %false otherwise, in which case for action frames the
3328 * driver is responsible for rejecting the frame.
3330 * This function is called whenever an Action frame is received for a station
3331 * mode interface, but is not processed in kernel.
3333 bool cfg80211_rx_mgmt(struct net_device *dev, int freq, int sig_dbm,
3334 const u8 *buf, size_t len, gfp_t gfp);
3337 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3338 * @dev: network device
3339 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3340 * @buf: Management frame (header + body)
3341 * @len: length of the frame data
3342 * @ack: Whether frame was acknowledged
3343 * @gfp: context flags
3345 * This function is called whenever a management frame was requested to be
3346 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3347 * transmission attempt.
3349 void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
3350 const u8 *buf, size_t len, bool ack, gfp_t gfp);
3354 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3355 * @dev: network device
3356 * @rssi_event: the triggered RSSI event
3357 * @gfp: context flags
3359 * This function is called when a configured connection quality monitoring
3360 * rssi threshold reached event occurs.
3362 void cfg80211_cqm_rssi_notify(struct net_device *dev,
3363 enum nl80211_cqm_rssi_threshold_event rssi_event,
3367 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3368 * @dev: network device
3369 * @peer: peer's MAC address
3370 * @num_packets: how many packets were lost -- should be a fixed threshold
3371 * but probably no less than maybe 50, or maybe a throughput dependent
3372 * threshold (to account for temporary interference)
3373 * @gfp: context flags
3375 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3376 const u8 *peer, u32 num_packets, gfp_t gfp);
3379 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3380 * @dev: network device
3381 * @bssid: BSSID of AP (to avoid races)
3382 * @replay_ctr: new replay counter
3383 * @gfp: allocation flags
3385 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
3386 const u8 *replay_ctr, gfp_t gfp);
3389 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3390 * @dev: network device
3391 * @index: candidate index (the smaller the index, the higher the priority)
3392 * @bssid: BSSID of AP
3393 * @preauth: Whether AP advertises support for RSN pre-authentication
3394 * @gfp: allocation flags
3396 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
3397 const u8 *bssid, bool preauth, gfp_t gfp);
3400 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3401 * @dev: The device the frame matched to
3402 * @addr: the transmitter address
3403 * @gfp: context flags
3405 * This function is used in AP mode (only!) to inform userspace that
3406 * a spurious class 3 frame was received, to be able to deauth the
3408 * Returns %true if the frame was passed to userspace (or this failed
3409 * for a reason other than not having a subscription.)
3411 bool cfg80211_rx_spurious_frame(struct net_device *dev,
3412 const u8 *addr, gfp_t gfp);
3415 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3416 * @dev: The device the frame matched to
3417 * @addr: the transmitter address
3418 * @gfp: context flags
3420 * This function is used in AP mode (only!) to inform userspace that
3421 * an associated station sent a 4addr frame but that wasn't expected.
3422 * It is allowed and desirable to send this event only once for each
3423 * station to avoid event flooding.
3424 * Returns %true if the frame was passed to userspace (or this failed
3425 * for a reason other than not having a subscription.)
3427 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
3428 const u8 *addr, gfp_t gfp);
3431 * cfg80211_probe_status - notify userspace about probe status
3432 * @dev: the device the probe was sent on
3433 * @addr: the address of the peer
3434 * @cookie: the cookie filled in @probe_client previously
3435 * @acked: indicates whether probe was acked or not
3436 * @gfp: allocation flags
3438 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
3439 u64 cookie, bool acked, gfp_t gfp);
3442 * cfg80211_report_obss_beacon - report beacon from other APs
3443 * @wiphy: The wiphy that received the beacon
3445 * @len: length of the frame
3446 * @freq: frequency the frame was received on
3447 * @sig_dbm: signal strength in mBm, or 0 if unknown
3448 * @gfp: allocation flags
3450 * Use this function to report to userspace when a beacon was
3451 * received. It is not useful to call this when there is no
3452 * netdev that is in AP/GO mode.
3454 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
3455 const u8 *frame, size_t len,
3456 int freq, int sig_dbm, gfp_t gfp);
3459 * cfg80211_can_beacon_sec_chan - test if ht40 on extension channel can be used
3461 * @chan: main channel
3462 * @channel_type: HT mode
3464 * This function returns true if there is no secondary channel or the secondary
3465 * channel can be used for beaconing (i.e. is not a radar channel etc.)
3467 bool cfg80211_can_beacon_sec_chan(struct wiphy *wiphy,
3468 struct ieee80211_channel *chan,
3469 enum nl80211_channel_type channel_type);
3472 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
3473 * @dev: the device which switched channels
3474 * @freq: new channel frequency (in MHz)
3475 * @type: channel type
3477 * Acquires wdev_lock, so must only be called from sleepable driver context!
3479 void cfg80211_ch_switch_notify(struct net_device *dev, int freq,
3480 enum nl80211_channel_type type);
3483 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
3484 * @rate: given rate_info to calculate bitrate from
3486 * return 0 if MCS index >= 32
3488 u16 cfg80211_calculate_bitrate(struct rate_info *rate);
3490 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3492 /* wiphy_printk helpers, similar to dev_printk */
3494 #define wiphy_printk(level, wiphy, format, args...) \
3495 dev_printk(level, &(wiphy)->dev, format, ##args)
3496 #define wiphy_emerg(wiphy, format, args...) \
3497 dev_emerg(&(wiphy)->dev, format, ##args)
3498 #define wiphy_alert(wiphy, format, args...) \
3499 dev_alert(&(wiphy)->dev, format, ##args)
3500 #define wiphy_crit(wiphy, format, args...) \
3501 dev_crit(&(wiphy)->dev, format, ##args)
3502 #define wiphy_err(wiphy, format, args...) \
3503 dev_err(&(wiphy)->dev, format, ##args)
3504 #define wiphy_warn(wiphy, format, args...) \
3505 dev_warn(&(wiphy)->dev, format, ##args)
3506 #define wiphy_notice(wiphy, format, args...) \
3507 dev_notice(&(wiphy)->dev, format, ##args)
3508 #define wiphy_info(wiphy, format, args...) \
3509 dev_info(&(wiphy)->dev, format, ##args)
3511 #define wiphy_debug(wiphy, format, args...) \
3512 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3514 #define wiphy_dbg(wiphy, format, args...) \
3515 dev_dbg(&(wiphy)->dev, format, ##args)
3517 #if defined(VERBOSE_DEBUG)
3518 #define wiphy_vdbg wiphy_dbg
3520 #define wiphy_vdbg(wiphy, format, args...) \
3523 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3529 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3530 * of using a WARN/WARN_ON to get the message out, including the
3531 * file/line information and a backtrace.
3533 #define wiphy_WARN(wiphy, format, args...) \
3534 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3536 #endif /* __NET_CFG80211_H */