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/netlink.h>
17 #include <linux/skbuff.h>
18 #include <linux/nl80211.h>
19 #include <linux/if_ether.h>
20 #include <linux/ieee80211.h>
21 #include <net/regulatory.h>
23 /* remove once we remove the wext stuff */
24 #include <net/iw_handler.h>
25 #include <linux/wireless.h>
31 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
32 * userspace and drivers, and offers some utility functionality associated
33 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
34 * by all modern wireless drivers in Linux, so that they offer a consistent
35 * API through nl80211. For backward compatibility, cfg80211 also offers
36 * wireless extensions to userspace, but hides them from drivers completely.
38 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
44 * DOC: Device registration
46 * In order for a driver to use cfg80211, it must register the hardware device
47 * with cfg80211. This happens through a number of hardware capability structs
50 * The fundamental structure for each device is the 'wiphy', of which each
51 * instance describes a physical wireless device connected to the system. Each
52 * such wiphy can have zero, one, or many virtual interfaces associated with
53 * it, which need to be identified as such by pointing the network interface's
54 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
55 * the wireless part of the interface, normally this struct is embedded in the
56 * network interface's private data area. Drivers can optionally allow creating
57 * or destroying virtual interfaces on the fly, but without at least one or the
58 * ability to create some the wireless device isn't useful.
60 * Each wiphy structure contains device capability information, and also has
61 * a pointer to the various operations the driver offers. The definitions and
62 * structures here describe these capabilities in detail.
66 * wireless hardware capability structures
70 * enum ieee80211_band - supported frequency bands
72 * The bands are assigned this way because the supported
73 * bitrates differ in these bands.
75 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
76 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
77 * @IEEE80211_NUM_BANDS: number of defined bands
80 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
81 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
88 * enum ieee80211_channel_flags - channel flags
90 * Channel flags set by the regulatory control code.
92 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
93 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
95 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
96 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
97 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
99 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
102 enum ieee80211_channel_flags {
103 IEEE80211_CHAN_DISABLED = 1<<0,
104 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
105 IEEE80211_CHAN_NO_IBSS = 1<<2,
106 IEEE80211_CHAN_RADAR = 1<<3,
107 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
108 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
111 #define IEEE80211_CHAN_NO_HT40 \
112 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
115 * struct ieee80211_channel - channel definition
117 * This structure describes a single channel for use
120 * @center_freq: center frequency in MHz
121 * @hw_value: hardware-specific value for the channel
122 * @flags: channel flags from &enum ieee80211_channel_flags.
123 * @orig_flags: channel flags at registration time, used by regulatory
124 * code to support devices with additional restrictions
125 * @band: band this channel belongs to.
126 * @max_antenna_gain: maximum antenna gain in dBi
127 * @max_power: maximum transmission power (in dBm)
128 * @beacon_found: helper to regulatory code to indicate when a beacon
129 * has been found on this channel. Use regulatory_hint_found_beacon()
130 * to enable this, this is useful only on 5 GHz band.
131 * @orig_mag: internal use
132 * @orig_mpwr: internal use
134 struct ieee80211_channel {
135 enum ieee80211_band band;
139 int max_antenna_gain;
143 int orig_mag, orig_mpwr;
147 * enum ieee80211_rate_flags - rate flags
149 * Hardware/specification flags for rates. These are structured
150 * in a way that allows using the same bitrate structure for
151 * different bands/PHY modes.
153 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
154 * preamble on this bitrate; only relevant in 2.4GHz band and
156 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
157 * when used with 802.11a (on the 5 GHz band); filled by the
158 * core code when registering the wiphy.
159 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
160 * when used with 802.11b (on the 2.4 GHz band); filled by the
161 * core code when registering the wiphy.
162 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
163 * when used with 802.11g (on the 2.4 GHz band); filled by the
164 * core code when registering the wiphy.
165 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
167 enum ieee80211_rate_flags {
168 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
169 IEEE80211_RATE_MANDATORY_A = 1<<1,
170 IEEE80211_RATE_MANDATORY_B = 1<<2,
171 IEEE80211_RATE_MANDATORY_G = 1<<3,
172 IEEE80211_RATE_ERP_G = 1<<4,
176 * struct ieee80211_rate - bitrate definition
178 * This structure describes a bitrate that an 802.11 PHY can
179 * operate with. The two values @hw_value and @hw_value_short
180 * are only for driver use when pointers to this structure are
183 * @flags: rate-specific flags
184 * @bitrate: bitrate in units of 100 Kbps
185 * @hw_value: driver/hardware value for this rate
186 * @hw_value_short: driver/hardware value for this rate when
187 * short preamble is used
189 struct ieee80211_rate {
192 u16 hw_value, hw_value_short;
196 * struct ieee80211_sta_ht_cap - STA's HT capabilities
198 * This structure describes most essential parameters needed
199 * to describe 802.11n HT capabilities for an STA.
201 * @ht_supported: is HT supported by the STA
202 * @cap: HT capabilities map as described in 802.11n spec
203 * @ampdu_factor: Maximum A-MPDU length factor
204 * @ampdu_density: Minimum A-MPDU spacing
205 * @mcs: Supported MCS rates
207 struct ieee80211_sta_ht_cap {
208 u16 cap; /* use IEEE80211_HT_CAP_ */
212 struct ieee80211_mcs_info mcs;
216 * struct ieee80211_supported_band - frequency band definition
218 * This structure describes a frequency band a wiphy
219 * is able to operate in.
221 * @channels: Array of channels the hardware can operate in
223 * @band: the band this structure represents
224 * @n_channels: Number of channels in @channels
225 * @bitrates: Array of bitrates the hardware can operate with
226 * in this band. Must be sorted to give a valid "supported
227 * rates" IE, i.e. CCK rates first, then OFDM.
228 * @n_bitrates: Number of bitrates in @bitrates
229 * @ht_cap: HT capabilities in this band
231 struct ieee80211_supported_band {
232 struct ieee80211_channel *channels;
233 struct ieee80211_rate *bitrates;
234 enum ieee80211_band band;
237 struct ieee80211_sta_ht_cap ht_cap;
241 * Wireless hardware/device configuration structures and methods
245 * DOC: Actions and configuration
247 * Each wireless device and each virtual interface offer a set of configuration
248 * operations and other actions that are invoked by userspace. Each of these
249 * actions is described in the operations structure, and the parameters these
250 * operations use are described separately.
252 * Additionally, some operations are asynchronous and expect to get status
253 * information via some functions that drivers need to call.
255 * Scanning and BSS list handling with its associated functionality is described
256 * in a separate chapter.
260 * struct vif_params - describes virtual interface parameters
261 * @mesh_id: mesh ID to use
262 * @mesh_id_len: length of the mesh ID
263 * @use_4addr: use 4-address frames
272 * struct key_params - key information
274 * Information about a key
277 * @key_len: length of key material
278 * @cipher: cipher suite selector
279 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
280 * with the get_key() callback, must be in little endian,
281 * length given by @seq_len.
282 * @seq_len: length of @seq.
293 * enum survey_info_flags - survey information flags
295 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
296 * @SURVEY_INFO_IN_USE: channel is currently being used
297 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
298 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
299 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
300 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
301 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
303 * Used by the driver to indicate which info in &struct survey_info
304 * it has filled in during the get_survey().
306 enum survey_info_flags {
307 SURVEY_INFO_NOISE_DBM = 1<<0,
308 SURVEY_INFO_IN_USE = 1<<1,
309 SURVEY_INFO_CHANNEL_TIME = 1<<2,
310 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
311 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
312 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
313 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
317 * struct survey_info - channel survey response
319 * @channel: the channel this survey record reports, mandatory
320 * @filled: bitflag of flags from &enum survey_info_flags
321 * @noise: channel noise in dBm. This and all following fields are
323 * @channel_time: amount of time in ms the radio spent on the channel
324 * @channel_time_busy: amount of time the primary channel was sensed busy
325 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
326 * @channel_time_rx: amount of time the radio spent receiving data
327 * @channel_time_tx: amount of time the radio spent transmitting data
329 * Used by dump_survey() to report back per-channel survey information.
331 * This structure can later be expanded with things like
332 * channel duty cycle etc.
335 struct ieee80211_channel *channel;
337 u64 channel_time_busy;
338 u64 channel_time_ext_busy;
346 * struct beacon_parameters - beacon parameters
348 * Used to configure the beacon for an interface.
350 * @head: head portion of beacon (before TIM IE)
351 * or %NULL if not changed
352 * @tail: tail portion of beacon (after TIM IE)
353 * or %NULL if not changed
354 * @interval: beacon interval or zero if not changed
355 * @dtim_period: DTIM period or zero if not changed
356 * @head_len: length of @head
357 * @tail_len: length of @tail
359 struct beacon_parameters {
361 int interval, dtim_period;
362 int head_len, tail_len;
366 * enum plink_action - actions to perform in mesh peers
368 * @PLINK_ACTION_INVALID: action 0 is reserved
369 * @PLINK_ACTION_OPEN: start mesh peer link establishment
370 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
373 PLINK_ACTION_INVALID,
379 * struct station_parameters - station parameters
381 * Used to change and create a new station.
383 * @vlan: vlan interface station should belong to
384 * @supported_rates: supported rates in IEEE 802.11 format
385 * (or NULL for no change)
386 * @supported_rates_len: number of supported rates
387 * @sta_flags_mask: station flags that changed
388 * (bitmask of BIT(NL80211_STA_FLAG_...))
389 * @sta_flags_set: station flags values
390 * (bitmask of BIT(NL80211_STA_FLAG_...))
391 * @listen_interval: listen interval or -1 for no change
392 * @aid: AID or zero for no change
393 * @plink_action: plink action to take
394 * @ht_capa: HT capabilities of station
396 struct station_parameters {
398 struct net_device *vlan;
399 u32 sta_flags_mask, sta_flags_set;
402 u8 supported_rates_len;
404 struct ieee80211_ht_cap *ht_capa;
408 * enum station_info_flags - station information flags
410 * Used by the driver to indicate which info in &struct station_info
411 * it has filled in during get_station() or dump_station().
413 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
414 * @STATION_INFO_RX_BYTES: @rx_bytes filled
415 * @STATION_INFO_TX_BYTES: @tx_bytes filled
416 * @STATION_INFO_LLID: @llid filled
417 * @STATION_INFO_PLID: @plid filled
418 * @STATION_INFO_PLINK_STATE: @plink_state filled
419 * @STATION_INFO_SIGNAL: @signal filled
420 * @STATION_INFO_TX_BITRATE: @tx_bitrate fields are filled
421 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
422 * @STATION_INFO_RX_PACKETS: @rx_packets filled
423 * @STATION_INFO_TX_PACKETS: @tx_packets filled
424 * @STATION_INFO_TX_RETRIES: @tx_retries filled
425 * @STATION_INFO_TX_FAILED: @tx_failed filled
426 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
428 enum station_info_flags {
429 STATION_INFO_INACTIVE_TIME = 1<<0,
430 STATION_INFO_RX_BYTES = 1<<1,
431 STATION_INFO_TX_BYTES = 1<<2,
432 STATION_INFO_LLID = 1<<3,
433 STATION_INFO_PLID = 1<<4,
434 STATION_INFO_PLINK_STATE = 1<<5,
435 STATION_INFO_SIGNAL = 1<<6,
436 STATION_INFO_TX_BITRATE = 1<<7,
437 STATION_INFO_RX_PACKETS = 1<<8,
438 STATION_INFO_TX_PACKETS = 1<<9,
439 STATION_INFO_TX_RETRIES = 1<<10,
440 STATION_INFO_TX_FAILED = 1<<11,
441 STATION_INFO_RX_DROP_MISC = 1<<12,
445 * enum station_info_rate_flags - bitrate info flags
447 * Used by the driver to indicate the specific rate transmission
448 * type for 802.11n transmissions.
450 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
451 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
452 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
454 enum rate_info_flags {
455 RATE_INFO_FLAGS_MCS = 1<<0,
456 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
457 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
461 * struct rate_info - bitrate information
463 * Information about a receiving or transmitting bitrate
465 * @flags: bitflag of flags from &enum rate_info_flags
466 * @mcs: mcs index if struct describes a 802.11n bitrate
467 * @legacy: bitrate in 100kbit/s for 802.11abg
476 * struct station_info - station information
478 * Station information filled by driver for get_station() and dump_station.
480 * @filled: bitflag of flags from &enum station_info_flags
481 * @inactive_time: time since last station activity (tx/rx) in milliseconds
482 * @rx_bytes: bytes received from this station
483 * @tx_bytes: bytes transmitted to this station
484 * @llid: mesh local link id
485 * @plid: mesh peer link id
486 * @plink_state: mesh peer link state
487 * @signal: signal strength of last received packet in dBm
488 * @txrate: current unicast bitrate to this station
489 * @rx_packets: packets received from this station
490 * @tx_packets: packets transmitted to this station
491 * @tx_retries: cumulative retry counts
492 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
493 * @rx_dropped_misc: Dropped for un-specified reason.
494 * @generation: generation number for nl80211 dumps.
495 * This number should increase every time the list of stations
496 * changes, i.e. when a station is added or removed, so that
497 * userspace can tell whether it got a consistent snapshot.
499 struct station_info {
508 struct rate_info txrate;
519 * enum monitor_flags - monitor flags
521 * Monitor interface configuration flags. Note that these must be the bits
522 * according to the nl80211 flags.
524 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
525 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
526 * @MONITOR_FLAG_CONTROL: pass control frames
527 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
528 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
531 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
532 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
533 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
534 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
535 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
539 * enum mpath_info_flags - mesh path information flags
541 * Used by the driver to indicate which info in &struct mpath_info it has filled
542 * in during get_station() or dump_station().
544 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
545 * @MPATH_INFO_SN: @sn filled
546 * @MPATH_INFO_METRIC: @metric filled
547 * @MPATH_INFO_EXPTIME: @exptime filled
548 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
549 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
550 * @MPATH_INFO_FLAGS: @flags filled
552 enum mpath_info_flags {
553 MPATH_INFO_FRAME_QLEN = BIT(0),
554 MPATH_INFO_SN = BIT(1),
555 MPATH_INFO_METRIC = BIT(2),
556 MPATH_INFO_EXPTIME = BIT(3),
557 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
558 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
559 MPATH_INFO_FLAGS = BIT(6),
563 * struct mpath_info - mesh path information
565 * Mesh path information filled by driver for get_mpath() and dump_mpath().
567 * @filled: bitfield of flags from &enum mpath_info_flags
568 * @frame_qlen: number of queued frames for this destination
569 * @sn: target sequence number
570 * @metric: metric (cost) of this mesh path
571 * @exptime: expiration time for the mesh path from now, in msecs
572 * @flags: mesh path flags
573 * @discovery_timeout: total mesh path discovery timeout, in msecs
574 * @discovery_retries: mesh path discovery retries
575 * @generation: generation number for nl80211 dumps.
576 * This number should increase every time the list of mesh paths
577 * changes, i.e. when a station is added or removed, so that
578 * userspace can tell whether it got a consistent snapshot.
586 u32 discovery_timeout;
587 u8 discovery_retries;
594 * struct bss_parameters - BSS parameters
596 * Used to change BSS parameters (mainly for AP mode).
598 * @use_cts_prot: Whether to use CTS protection
599 * (0 = no, 1 = yes, -1 = do not change)
600 * @use_short_preamble: Whether the use of short preambles is allowed
601 * (0 = no, 1 = yes, -1 = do not change)
602 * @use_short_slot_time: Whether the use of short slot time is allowed
603 * (0 = no, 1 = yes, -1 = do not change)
604 * @basic_rates: basic rates in IEEE 802.11 format
605 * (or NULL for no change)
606 * @basic_rates_len: number of basic rates
607 * @ap_isolate: do not forward packets between connected stations
609 struct bss_parameters {
611 int use_short_preamble;
612 int use_short_slot_time;
620 /* Mesh plink management parameters */
621 u16 dot11MeshRetryTimeout;
622 u16 dot11MeshConfirmTimeout;
623 u16 dot11MeshHoldingTimeout;
624 u16 dot11MeshMaxPeerLinks;
625 u8 dot11MeshMaxRetries;
627 bool auto_open_plinks;
628 /* HWMP parameters */
629 u8 dot11MeshHWMPmaxPREQretries;
630 u32 path_refresh_time;
631 u16 min_discovery_timeout;
632 u32 dot11MeshHWMPactivePathTimeout;
633 u16 dot11MeshHWMPpreqMinInterval;
634 u16 dot11MeshHWMPnetDiameterTraversalTime;
635 u8 dot11MeshHWMPRootMode;
639 * struct ieee80211_txq_params - TX queue parameters
640 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
641 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
642 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
644 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
646 * @aifs: Arbitration interframe space [0..255]
648 struct ieee80211_txq_params {
649 enum nl80211_txq_q queue;
656 /* from net/wireless.h */
660 * DOC: Scanning and BSS list handling
662 * The scanning process itself is fairly simple, but cfg80211 offers quite
663 * a bit of helper functionality. To start a scan, the scan operation will
664 * be invoked with a scan definition. This scan definition contains the
665 * channels to scan, and the SSIDs to send probe requests for (including the
666 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
667 * probe. Additionally, a scan request may contain extra information elements
668 * that should be added to the probe request. The IEs are guaranteed to be
669 * well-formed, and will not exceed the maximum length the driver advertised
670 * in the wiphy structure.
672 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
673 * it is responsible for maintaining the BSS list; the driver should not
674 * maintain a list itself. For this notification, various functions exist.
676 * Since drivers do not maintain a BSS list, there are also a number of
677 * functions to search for a BSS and obtain information about it from the
678 * BSS structure cfg80211 maintains. The BSS list is also made available
683 * struct cfg80211_ssid - SSID description
685 * @ssid_len: length of the ssid
687 struct cfg80211_ssid {
688 u8 ssid[IEEE80211_MAX_SSID_LEN];
693 * struct cfg80211_scan_request - scan request description
695 * @ssids: SSIDs to scan for (active scan only)
696 * @n_ssids: number of SSIDs
697 * @channels: channels to scan on.
698 * @n_channels: total number of channels to scan
699 * @ie: optional information element(s) to add into Probe Request or %NULL
700 * @ie_len: length of ie in octets
701 * @wiphy: the wiphy this was for
702 * @dev: the interface
703 * @aborted: (internal) scan request was notified as aborted
705 struct cfg80211_scan_request {
706 struct cfg80211_ssid *ssids;
714 struct net_device *dev;
718 struct ieee80211_channel *channels[0];
722 * enum cfg80211_signal_type - signal type
724 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
725 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
726 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
728 enum cfg80211_signal_type {
729 CFG80211_SIGNAL_TYPE_NONE,
730 CFG80211_SIGNAL_TYPE_MBM,
731 CFG80211_SIGNAL_TYPE_UNSPEC,
735 * struct cfg80211_bss - BSS description
737 * This structure describes a BSS (which may also be a mesh network)
738 * for use in scan results and similar.
740 * @channel: channel this BSS is on
741 * @bssid: BSSID of the BSS
742 * @tsf: timestamp of last received update
743 * @beacon_interval: the beacon interval as from the frame
744 * @capability: the capability field in host byte order
745 * @information_elements: the information elements (Note that there
746 * is no guarantee that these are well-formed!); this is a pointer to
747 * either the beacon_ies or proberesp_ies depending on whether Probe
748 * Response frame has been received
749 * @len_information_elements: total length of the information elements
750 * @beacon_ies: the information elements from the last Beacon frame
751 * @len_beacon_ies: total length of the beacon_ies
752 * @proberesp_ies: the information elements from the last Probe Response frame
753 * @len_proberesp_ies: total length of the proberesp_ies
754 * @signal: signal strength value (type depends on the wiphy's signal_type)
755 * @free_priv: function pointer to free private data
756 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
758 struct cfg80211_bss {
759 struct ieee80211_channel *channel;
765 u8 *information_elements;
766 size_t len_information_elements;
768 size_t len_beacon_ies;
770 size_t len_proberesp_ies;
774 void (*free_priv)(struct cfg80211_bss *bss);
775 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
779 * ieee80211_bss_get_ie - find IE with given ID
780 * @bss: the bss to search
782 * Returns %NULL if not found.
784 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
788 * struct cfg80211_crypto_settings - Crypto settings
789 * @wpa_versions: indicates which, if any, WPA versions are enabled
790 * (from enum nl80211_wpa_versions)
791 * @cipher_group: group key cipher suite (or 0 if unset)
792 * @n_ciphers_pairwise: number of AP supported unicast ciphers
793 * @ciphers_pairwise: unicast key cipher suites
794 * @n_akm_suites: number of AKM suites
795 * @akm_suites: AKM suites
796 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
797 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
798 * required to assume that the port is unauthorized until authorized by
799 * user space. Otherwise, port is marked authorized by default.
800 * @control_port_ethertype: the control port protocol that should be
801 * allowed through even on unauthorized ports
802 * @control_port_no_encrypt: TRUE to prevent encryption of control port
805 struct cfg80211_crypto_settings {
808 int n_ciphers_pairwise;
809 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
811 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
813 __be16 control_port_ethertype;
814 bool control_port_no_encrypt;
818 * struct cfg80211_auth_request - Authentication request data
820 * This structure provides information needed to complete IEEE 802.11
823 * @bss: The BSS to authenticate with.
824 * @auth_type: Authentication type (algorithm)
825 * @ie: Extra IEs to add to Authentication frame or %NULL
826 * @ie_len: Length of ie buffer in octets
827 * @key_len: length of WEP key for shared key authentication
828 * @key_idx: index of WEP key for shared key authentication
829 * @key: WEP key for shared key authentication
830 * @local_state_change: This is a request for a local state only, i.e., no
831 * Authentication frame is to be transmitted and authentication state is
832 * to be changed without having to wait for a response from the peer STA
835 struct cfg80211_auth_request {
836 struct cfg80211_bss *bss;
839 enum nl80211_auth_type auth_type;
842 bool local_state_change;
846 * struct cfg80211_assoc_request - (Re)Association request data
848 * This structure provides information needed to complete IEEE 802.11
850 * @bss: The BSS to associate with.
851 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
852 * @ie_len: Length of ie buffer in octets
853 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
854 * @crypto: crypto settings
855 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
857 struct cfg80211_assoc_request {
858 struct cfg80211_bss *bss;
859 const u8 *ie, *prev_bssid;
861 struct cfg80211_crypto_settings crypto;
866 * struct cfg80211_deauth_request - Deauthentication request data
868 * This structure provides information needed to complete IEEE 802.11
871 * @bss: the BSS to deauthenticate from
872 * @ie: Extra IEs to add to Deauthentication frame or %NULL
873 * @ie_len: Length of ie buffer in octets
874 * @reason_code: The reason code for the deauthentication
875 * @local_state_change: This is a request for a local state only, i.e., no
876 * Deauthentication frame is to be transmitted.
878 struct cfg80211_deauth_request {
879 struct cfg80211_bss *bss;
883 bool local_state_change;
887 * struct cfg80211_disassoc_request - Disassociation request data
889 * This structure provides information needed to complete IEEE 802.11
892 * @bss: the BSS to disassociate from
893 * @ie: Extra IEs to add to Disassociation frame or %NULL
894 * @ie_len: Length of ie buffer in octets
895 * @reason_code: The reason code for the disassociation
896 * @local_state_change: This is a request for a local state only, i.e., no
897 * Disassociation frame is to be transmitted.
899 struct cfg80211_disassoc_request {
900 struct cfg80211_bss *bss;
904 bool local_state_change;
908 * struct cfg80211_ibss_params - IBSS parameters
910 * This structure defines the IBSS parameters for the join_ibss()
913 * @ssid: The SSID, will always be non-null.
914 * @ssid_len: The length of the SSID, will always be non-zero.
915 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
916 * search for IBSSs with a different BSSID.
917 * @channel: The channel to use if no IBSS can be found to join.
918 * @channel_fixed: The channel should be fixed -- do not search for
919 * IBSSs to join on other channels.
920 * @ie: information element(s) to include in the beacon
921 * @ie_len: length of that
922 * @beacon_interval: beacon interval to use
923 * @privacy: this is a protected network, keys will be configured
925 * @basic_rates: bitmap of basic rates to use when creating the IBSS
926 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
928 struct cfg80211_ibss_params {
931 struct ieee80211_channel *channel;
938 int mcast_rate[IEEE80211_NUM_BANDS];
942 * struct cfg80211_connect_params - Connection parameters
944 * This structure provides information needed to complete IEEE 802.11
945 * authentication and association.
947 * @channel: The channel to use or %NULL if not specified (auto-select based
949 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
952 * @ssid_len: Length of ssid in octets
953 * @auth_type: Authentication type (algorithm)
954 * @ie: IEs for association request
955 * @ie_len: Length of assoc_ie in octets
956 * @privacy: indicates whether privacy-enabled APs should be used
957 * @crypto: crypto settings
958 * @key_len: length of WEP key for shared key authentication
959 * @key_idx: index of WEP key for shared key authentication
960 * @key: WEP key for shared key authentication
962 struct cfg80211_connect_params {
963 struct ieee80211_channel *channel;
967 enum nl80211_auth_type auth_type;
971 struct cfg80211_crypto_settings crypto;
977 * enum wiphy_params_flags - set_wiphy_params bitfield values
978 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
979 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
980 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
981 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
982 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
984 enum wiphy_params_flags {
985 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
986 WIPHY_PARAM_RETRY_LONG = 1 << 1,
987 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
988 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
989 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
993 * cfg80211_bitrate_mask - masks for bitrate control
995 struct cfg80211_bitrate_mask {
998 /* TODO: add support for masking MCS rates; e.g.: */
999 /* u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; */
1000 } control[IEEE80211_NUM_BANDS];
1003 * struct cfg80211_pmksa - PMK Security Association
1005 * This structure is passed to the set/del_pmksa() method for PMKSA
1008 * @bssid: The AP's BSSID.
1009 * @pmkid: The PMK material itself.
1011 struct cfg80211_pmksa {
1017 * struct cfg80211_ops - backend description for wireless configuration
1019 * This struct is registered by fullmac card drivers and/or wireless stacks
1020 * in order to handle configuration requests on their interfaces.
1022 * All callbacks except where otherwise noted should return 0
1023 * on success or a negative error code.
1025 * All operations are currently invoked under rtnl for consistency with the
1026 * wireless extensions but this is subject to reevaluation as soon as this
1027 * code is used more widely and we have a first user without wext.
1029 * @suspend: wiphy device needs to be suspended
1030 * @resume: wiphy device needs to be resumed
1032 * @add_virtual_intf: create a new virtual interface with the given name,
1033 * must set the struct wireless_dev's iftype. Beware: You must create
1034 * the new netdev in the wiphy's network namespace!
1036 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1038 * @change_virtual_intf: change type/configuration of virtual interface,
1039 * keep the struct wireless_dev's iftype updated.
1041 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1042 * when adding a group key.
1044 * @get_key: get information about the key with the given parameters.
1045 * @mac_addr will be %NULL when requesting information for a group
1046 * key. All pointers given to the @callback function need not be valid
1047 * after it returns. This function should return an error if it is
1048 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1050 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1051 * and @key_index, return -ENOENT if the key doesn't exist.
1053 * @set_default_key: set the default key on an interface
1055 * @set_default_mgmt_key: set the default management frame key on an interface
1057 * @add_beacon: Add a beacon with given parameters, @head, @interval
1058 * and @dtim_period will be valid, @tail is optional.
1059 * @set_beacon: Change the beacon parameters for an access point mode
1060 * interface. This should reject the call when no beacon has been
1062 * @del_beacon: Remove beacon configuration and stop sending the beacon.
1064 * @add_station: Add a new station.
1065 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1066 * @change_station: Modify a given station.
1067 * @get_station: get station information for the station identified by @mac
1068 * @dump_station: dump station callback -- resume dump at index @idx
1070 * @add_mpath: add a fixed mesh path
1071 * @del_mpath: delete a given mesh path
1072 * @change_mpath: change a given mesh path
1073 * @get_mpath: get a mesh path for the given parameters
1074 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1076 * @get_mesh_params: Put the current mesh parameters into *params
1078 * @set_mesh_params: Set mesh parameters.
1079 * The mask is a bitfield which tells us which parameters to
1080 * set, and which to leave alone.
1082 * @change_bss: Modify parameters for a given BSS.
1084 * @set_txq_params: Set TX queue parameters
1086 * @set_channel: Set channel for a given wireless interface. Some devices
1087 * may support multi-channel operation (by channel hopping) so cfg80211
1088 * doesn't verify much. Note, however, that the passed netdev may be
1089 * %NULL as well if the user requested changing the channel for the
1090 * device itself, or for a monitor interface.
1092 * @scan: Request to do a scan. If returning zero, the scan request is given
1093 * the driver, and will be valid until passed to cfg80211_scan_done().
1094 * For scan results, call cfg80211_inform_bss(); you can call this outside
1095 * the scan/scan_done bracket too.
1097 * @auth: Request to authenticate with the specified peer
1098 * @assoc: Request to (re)associate with the specified peer
1099 * @deauth: Request to deauthenticate from the specified peer
1100 * @disassoc: Request to disassociate from the specified peer
1102 * @connect: Connect to the ESS with the specified parameters. When connected,
1103 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1104 * If the connection fails for some reason, call cfg80211_connect_result()
1105 * with the status from the AP.
1106 * @disconnect: Disconnect from the BSS/ESS.
1108 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1109 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1111 * @leave_ibss: Leave the IBSS.
1113 * @set_wiphy_params: Notify that wiphy parameters have changed;
1114 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1115 * have changed. The actual parameter values are available in
1116 * struct wiphy. If returning an error, no value should be changed.
1118 * @set_tx_power: set the transmit power according to the parameters
1119 * @get_tx_power: store the current TX power into the dbm variable;
1120 * return 0 if successful
1122 * @set_wds_peer: set the WDS peer for a WDS interface
1124 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1125 * functions to adjust rfkill hw state
1127 * @dump_survey: get site survey information.
1129 * @remain_on_channel: Request the driver to remain awake on the specified
1130 * channel for the specified duration to complete an off-channel
1131 * operation (e.g., public action frame exchange). When the driver is
1132 * ready on the requested channel, it must indicate this with an event
1133 * notification by calling cfg80211_ready_on_channel().
1134 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1135 * This allows the operation to be terminated prior to timeout based on
1136 * the duration value.
1137 * @mgmt_tx: Transmit a management frame.
1138 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1139 * frame on another channel
1141 * @testmode_cmd: run a test mode command
1143 * @set_bitrate_mask: set the bitrate mask configuration
1145 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1146 * devices running firmwares capable of generating the (re) association
1147 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1148 * @del_pmksa: Delete a cached PMKID.
1149 * @flush_pmksa: Flush all cached PMKIDs.
1150 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1151 * allows the driver to adjust the dynamic ps timeout value.
1152 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1154 * @mgmt_frame_register: Notify driver that a management frame type was
1155 * registered. Note that this callback may not sleep, and cannot run
1156 * concurrently with itself.
1158 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1159 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1160 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1161 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1163 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1165 struct cfg80211_ops {
1166 int (*suspend)(struct wiphy *wiphy);
1167 int (*resume)(struct wiphy *wiphy);
1169 int (*add_virtual_intf)(struct wiphy *wiphy, char *name,
1170 enum nl80211_iftype type, u32 *flags,
1171 struct vif_params *params);
1172 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
1173 int (*change_virtual_intf)(struct wiphy *wiphy,
1174 struct net_device *dev,
1175 enum nl80211_iftype type, u32 *flags,
1176 struct vif_params *params);
1178 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1179 u8 key_index, bool pairwise, const u8 *mac_addr,
1180 struct key_params *params);
1181 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1182 u8 key_index, bool pairwise, const u8 *mac_addr,
1184 void (*callback)(void *cookie, struct key_params*));
1185 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1186 u8 key_index, bool pairwise, const u8 *mac_addr);
1187 int (*set_default_key)(struct wiphy *wiphy,
1188 struct net_device *netdev,
1190 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1191 struct net_device *netdev,
1194 int (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
1195 struct beacon_parameters *info);
1196 int (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
1197 struct beacon_parameters *info);
1198 int (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
1201 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1202 u8 *mac, struct station_parameters *params);
1203 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1205 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1206 u8 *mac, struct station_parameters *params);
1207 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1208 u8 *mac, struct station_info *sinfo);
1209 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1210 int idx, u8 *mac, struct station_info *sinfo);
1212 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1213 u8 *dst, u8 *next_hop);
1214 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1216 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1217 u8 *dst, u8 *next_hop);
1218 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1219 u8 *dst, u8 *next_hop,
1220 struct mpath_info *pinfo);
1221 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1222 int idx, u8 *dst, u8 *next_hop,
1223 struct mpath_info *pinfo);
1224 int (*get_mesh_params)(struct wiphy *wiphy,
1225 struct net_device *dev,
1226 struct mesh_config *conf);
1227 int (*set_mesh_params)(struct wiphy *wiphy,
1228 struct net_device *dev,
1229 const struct mesh_config *nconf, u32 mask);
1230 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1231 struct bss_parameters *params);
1233 int (*set_txq_params)(struct wiphy *wiphy,
1234 struct ieee80211_txq_params *params);
1236 int (*set_channel)(struct wiphy *wiphy, struct net_device *dev,
1237 struct ieee80211_channel *chan,
1238 enum nl80211_channel_type channel_type);
1240 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
1241 struct cfg80211_scan_request *request);
1243 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1244 struct cfg80211_auth_request *req);
1245 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1246 struct cfg80211_assoc_request *req);
1247 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1248 struct cfg80211_deauth_request *req,
1250 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1251 struct cfg80211_disassoc_request *req,
1254 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1255 struct cfg80211_connect_params *sme);
1256 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1259 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1260 struct cfg80211_ibss_params *params);
1261 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1263 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1265 int (*set_tx_power)(struct wiphy *wiphy,
1266 enum nl80211_tx_power_setting type, int mbm);
1267 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1269 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1272 void (*rfkill_poll)(struct wiphy *wiphy);
1274 #ifdef CONFIG_NL80211_TESTMODE
1275 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1278 int (*set_bitrate_mask)(struct wiphy *wiphy,
1279 struct net_device *dev,
1281 const struct cfg80211_bitrate_mask *mask);
1283 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1284 int idx, struct survey_info *info);
1286 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1287 struct cfg80211_pmksa *pmksa);
1288 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1289 struct cfg80211_pmksa *pmksa);
1290 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1292 int (*remain_on_channel)(struct wiphy *wiphy,
1293 struct net_device *dev,
1294 struct ieee80211_channel *chan,
1295 enum nl80211_channel_type channel_type,
1296 unsigned int duration,
1298 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1299 struct net_device *dev,
1302 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
1303 struct ieee80211_channel *chan, bool offchan,
1304 enum nl80211_channel_type channel_type,
1305 bool channel_type_valid, unsigned int wait,
1306 const u8 *buf, size_t len, u64 *cookie);
1307 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1308 struct net_device *dev,
1311 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1312 bool enabled, int timeout);
1314 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1315 struct net_device *dev,
1316 s32 rssi_thold, u32 rssi_hyst);
1318 void (*mgmt_frame_register)(struct wiphy *wiphy,
1319 struct net_device *dev,
1320 u16 frame_type, bool reg);
1322 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1323 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1327 * wireless hardware and networking interfaces structures
1328 * and registration/helper functions
1332 * enum wiphy_flags - wiphy capability flags
1334 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1335 * has its own custom regulatory domain and cannot identify the
1336 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1337 * we will disregard the first regulatory hint (when the
1338 * initiator is %REGDOM_SET_BY_CORE).
1339 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1340 * ignore regulatory domain settings until it gets its own regulatory
1341 * domain via its regulatory_hint() unless the regulatory hint is
1342 * from a country IE. After its gets its own regulatory domain it will
1343 * only allow further regulatory domain settings to further enhance
1344 * compliance. For example if channel 13 and 14 are disabled by this
1345 * regulatory domain no user regulatory domain can enable these channels
1346 * at a later time. This can be used for devices which do not have
1347 * calibration information guaranteed for frequencies or settings
1348 * outside of its regulatory domain.
1349 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1350 * that passive scan flags and beaconing flags may not be lifted by
1351 * cfg80211 due to regulatory beacon hints. For more information on beacon
1352 * hints read the documenation for regulatory_hint_found_beacon()
1353 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1355 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1356 * by default -- this flag will be set depending on the kernel's default
1357 * on wiphy_new(), but can be changed by the driver if it has a good
1358 * reason to override the default
1359 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1360 * on a VLAN interface)
1361 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1362 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1363 * control port protocol ethertype. The device also honours the
1364 * control_port_no_encrypt flag.
1365 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1368 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1369 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1370 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1371 WIPHY_FLAG_NETNS_OK = BIT(3),
1372 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1373 WIPHY_FLAG_4ADDR_AP = BIT(5),
1374 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1375 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
1376 WIPHY_FLAG_IBSS_RSN = BIT(8),
1379 struct mac_address {
1383 struct ieee80211_txrx_stypes {
1388 * struct wiphy - wireless hardware description
1389 * @reg_notifier: the driver's regulatory notification callback
1390 * @regd: the driver's regulatory domain, if one was requested via
1391 * the regulatory_hint() API. This can be used by the driver
1392 * on the reg_notifier() if it chooses to ignore future
1393 * regulatory domain changes caused by other drivers.
1394 * @signal_type: signal type reported in &struct cfg80211_bss.
1395 * @cipher_suites: supported cipher suites
1396 * @n_cipher_suites: number of supported cipher suites
1397 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1398 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1399 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1400 * -1 = fragmentation disabled, only odd values >= 256 used
1401 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1402 * @_net: the network namespace this wiphy currently lives in
1403 * @perm_addr: permanent MAC address of this device
1404 * @addr_mask: If the device supports multiple MAC addresses by masking,
1405 * set this to a mask with variable bits set to 1, e.g. if the last
1406 * four bits are variable then set it to 00:...:00:0f. The actual
1407 * variable bits shall be determined by the interfaces added, with
1408 * interfaces not matching the mask being rejected to be brought up.
1409 * @n_addresses: number of addresses in @addresses.
1410 * @addresses: If the device has more than one address, set this pointer
1411 * to a list of addresses (6 bytes each). The first one will be used
1412 * by default for perm_addr. In this case, the mask should be set to
1413 * all-zeroes. In this case it is assumed that the device can handle
1414 * the same number of arbitrary MAC addresses.
1415 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
1416 * automatically on wiphy renames
1417 * @dev: (virtual) struct device for this wiphy
1418 * @wext: wireless extension handlers
1419 * @priv: driver private data (sized according to wiphy_new() parameter)
1420 * @interface_modes: bitmask of interfaces types valid for this wiphy,
1421 * must be set by driver
1422 * @flags: wiphy flags, see &enum wiphy_flags
1423 * @bss_priv_size: each BSS struct has private data allocated with it,
1424 * this variable determines its size
1425 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
1427 * @max_scan_ie_len: maximum length of user-controlled IEs device can
1428 * add to probe request frames transmitted during a scan, must not
1429 * include fixed IEs like supported rates
1430 * @coverage_class: current coverage class
1431 * @fw_version: firmware version for ethtool reporting
1432 * @hw_version: hardware version for ethtool reporting
1433 * @max_num_pmkids: maximum number of PMKIDs supported by device
1434 * @privid: a pointer that drivers can use to identify if an arbitrary
1435 * wiphy is theirs, e.g. in global notifiers
1436 * @bands: information about bands/channels supported by this device
1438 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
1439 * transmitted through nl80211, points to an array indexed by interface
1443 /* assign these fields before you register the wiphy */
1445 /* permanent MAC address(es) */
1446 u8 perm_addr[ETH_ALEN];
1447 u8 addr_mask[ETH_ALEN];
1449 struct mac_address *addresses;
1451 const struct ieee80211_txrx_stypes *mgmt_stypes;
1455 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1456 u16 interface_modes;
1460 enum cfg80211_signal_type signal_type;
1464 u16 max_scan_ie_len;
1466 int n_cipher_suites;
1467 const u32 *cipher_suites;
1475 char fw_version[ETHTOOL_BUSINFO_LEN];
1480 /* If multiple wiphys are registered and you're handed e.g.
1481 * a regular netdev with assigned ieee80211_ptr, you won't
1482 * know whether it points to a wiphy your driver has registered
1483 * or not. Assign this to something global to your driver to
1484 * help determine whether you own this wiphy or not. */
1487 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
1489 /* Lets us get back the wiphy on the callback */
1490 int (*reg_notifier)(struct wiphy *wiphy,
1491 struct regulatory_request *request);
1493 /* fields below are read-only, assigned by cfg80211 */
1495 const struct ieee80211_regdomain *regd;
1497 /* the item in /sys/class/ieee80211/ points to this,
1498 * you need use set_wiphy_dev() (see below) */
1501 /* dir in debugfs: ieee80211/<wiphyname> */
1502 struct dentry *debugfsdir;
1504 #ifdef CONFIG_NET_NS
1505 /* the network namespace this phy lives in currently */
1509 #ifdef CONFIG_CFG80211_WEXT
1510 const struct iw_handler_def *wext;
1513 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1516 static inline struct net *wiphy_net(struct wiphy *wiphy)
1518 return read_pnet(&wiphy->_net);
1521 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
1523 write_pnet(&wiphy->_net, net);
1527 * wiphy_priv - return priv from wiphy
1529 * @wiphy: the wiphy whose priv pointer to return
1531 static inline void *wiphy_priv(struct wiphy *wiphy)
1534 return &wiphy->priv;
1538 * priv_to_wiphy - return the wiphy containing the priv
1540 * @priv: a pointer previously returned by wiphy_priv
1542 static inline struct wiphy *priv_to_wiphy(void *priv)
1545 return container_of(priv, struct wiphy, priv);
1549 * set_wiphy_dev - set device pointer for wiphy
1551 * @wiphy: The wiphy whose device to bind
1552 * @dev: The device to parent it to
1554 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1556 wiphy->dev.parent = dev;
1560 * wiphy_dev - get wiphy dev pointer
1562 * @wiphy: The wiphy whose device struct to look up
1564 static inline struct device *wiphy_dev(struct wiphy *wiphy)
1566 return wiphy->dev.parent;
1570 * wiphy_name - get wiphy name
1572 * @wiphy: The wiphy whose name to return
1574 static inline const char *wiphy_name(const struct wiphy *wiphy)
1576 return dev_name(&wiphy->dev);
1580 * wiphy_new - create a new wiphy for use with cfg80211
1582 * @ops: The configuration operations for this device
1583 * @sizeof_priv: The size of the private area to allocate
1585 * Create a new wiphy and associate the given operations with it.
1586 * @sizeof_priv bytes are allocated for private use.
1588 * The returned pointer must be assigned to each netdev's
1589 * ieee80211_ptr for proper operation.
1591 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
1594 * wiphy_register - register a wiphy with cfg80211
1596 * @wiphy: The wiphy to register.
1598 * Returns a non-negative wiphy index or a negative error code.
1600 extern int wiphy_register(struct wiphy *wiphy);
1603 * wiphy_unregister - deregister a wiphy from cfg80211
1605 * @wiphy: The wiphy to unregister.
1607 * After this call, no more requests can be made with this priv
1608 * pointer, but the call may sleep to wait for an outstanding
1609 * request that is being handled.
1611 extern void wiphy_unregister(struct wiphy *wiphy);
1614 * wiphy_free - free wiphy
1616 * @wiphy: The wiphy to free
1618 extern void wiphy_free(struct wiphy *wiphy);
1620 /* internal structs */
1621 struct cfg80211_conn;
1622 struct cfg80211_internal_bss;
1623 struct cfg80211_cached_keys;
1625 #define MAX_AUTH_BSSES 4
1628 * struct wireless_dev - wireless per-netdev state
1630 * This structure must be allocated by the driver/stack
1631 * that uses the ieee80211_ptr field in struct net_device
1632 * (this is intentional so it can be allocated along with
1635 * @wiphy: pointer to hardware description
1636 * @iftype: interface type
1637 * @list: (private) Used to collect the interfaces
1638 * @netdev: (private) Used to reference back to the netdev
1639 * @current_bss: (private) Used by the internal configuration code
1640 * @channel: (private) Used by the internal configuration code to track
1641 * user-set AP, monitor and WDS channels for wireless extensions
1642 * @bssid: (private) Used by the internal configuration code
1643 * @ssid: (private) Used by the internal configuration code
1644 * @ssid_len: (private) Used by the internal configuration code
1645 * @wext: (private) Used by the internal wireless extensions compat code
1646 * @use_4addr: indicates 4addr mode is used on this interface, must be
1647 * set by driver (if supported) on add_interface BEFORE registering the
1648 * netdev and may otherwise be used by driver read-only, will be update
1649 * by cfg80211 on change_interface
1650 * @mgmt_registrations: list of registrations for management frames
1651 * @mgmt_registrations_lock: lock for the list
1652 * @mtx: mutex used to lock data in this struct
1653 * @cleanup_work: work struct used for cleanup that can't be done directly
1655 struct wireless_dev {
1656 struct wiphy *wiphy;
1657 enum nl80211_iftype iftype;
1659 /* the remainder of this struct should be private to cfg80211 */
1660 struct list_head list;
1661 struct net_device *netdev;
1663 struct list_head mgmt_registrations;
1664 spinlock_t mgmt_registrations_lock;
1668 struct work_struct cleanup_work;
1672 /* currently used for IBSS and SME - might be rearranged later */
1673 u8 ssid[IEEE80211_MAX_SSID_LEN];
1677 CFG80211_SME_CONNECTING,
1678 CFG80211_SME_CONNECTED,
1680 struct cfg80211_conn *conn;
1681 struct cfg80211_cached_keys *connect_keys;
1683 struct list_head event_list;
1684 spinlock_t event_lock;
1686 struct cfg80211_internal_bss *authtry_bsses[MAX_AUTH_BSSES];
1687 struct cfg80211_internal_bss *auth_bsses[MAX_AUTH_BSSES];
1688 struct cfg80211_internal_bss *current_bss; /* associated / joined */
1689 struct ieee80211_channel *channel;
1694 #ifdef CONFIG_CFG80211_WEXT
1697 struct cfg80211_ibss_params ibss;
1698 struct cfg80211_connect_params connect;
1699 struct cfg80211_cached_keys *keys;
1702 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
1703 u8 ssid[IEEE80211_MAX_SSID_LEN];
1704 s8 default_key, default_mgmt_key;
1705 bool prev_bssid_valid;
1711 * wdev_priv - return wiphy priv from wireless_dev
1713 * @wdev: The wireless device whose wiphy's priv pointer to return
1715 static inline void *wdev_priv(struct wireless_dev *wdev)
1718 return wiphy_priv(wdev->wiphy);
1722 * DOC: Utility functions
1724 * cfg80211 offers a number of utility functions that can be useful.
1728 * ieee80211_channel_to_frequency - convert channel number to frequency
1729 * @chan: channel number
1731 extern int ieee80211_channel_to_frequency(int chan);
1734 * ieee80211_frequency_to_channel - convert frequency to channel number
1735 * @freq: center frequency
1737 extern int ieee80211_frequency_to_channel(int freq);
1740 * Name indirection necessary because the ieee80211 code also has
1741 * a function named "ieee80211_get_channel", so if you include
1742 * cfg80211's header file you get cfg80211's version, if you try
1743 * to include both header files you'll (rightfully!) get a symbol
1746 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
1749 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
1750 * @wiphy: the struct wiphy to get the channel for
1751 * @freq: the center frequency of the channel
1753 static inline struct ieee80211_channel *
1754 ieee80211_get_channel(struct wiphy *wiphy, int freq)
1756 return __ieee80211_get_channel(wiphy, freq);
1760 * ieee80211_get_response_rate - get basic rate for a given rate
1762 * @sband: the band to look for rates in
1763 * @basic_rates: bitmap of basic rates
1764 * @bitrate: the bitrate for which to find the basic rate
1766 * This function returns the basic rate corresponding to a given
1767 * bitrate, that is the next lower bitrate contained in the basic
1768 * rate map, which is, for this function, given as a bitmap of
1769 * indices of rates in the band's bitrate table.
1771 struct ieee80211_rate *
1772 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
1773 u32 basic_rates, int bitrate);
1776 * Radiotap parsing functions -- for controlled injection support
1778 * Implemented in net/wireless/radiotap.c
1779 * Documentation in Documentation/networking/radiotap-headers.txt
1782 struct radiotap_align_size {
1783 uint8_t align:4, size:4;
1786 struct ieee80211_radiotap_namespace {
1787 const struct radiotap_align_size *align_size;
1793 struct ieee80211_radiotap_vendor_namespaces {
1794 const struct ieee80211_radiotap_namespace *ns;
1799 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
1800 * @this_arg_index: index of current arg, valid after each successful call
1801 * to ieee80211_radiotap_iterator_next()
1802 * @this_arg: pointer to current radiotap arg; it is valid after each
1803 * call to ieee80211_radiotap_iterator_next() but also after
1804 * ieee80211_radiotap_iterator_init() where it will point to
1805 * the beginning of the actual data portion
1806 * @this_arg_size: length of the current arg, for convenience
1807 * @current_namespace: pointer to the current namespace definition
1808 * (or internally %NULL if the current namespace is unknown)
1809 * @is_radiotap_ns: indicates whether the current namespace is the default
1810 * radiotap namespace or not
1812 * @_rtheader: pointer to the radiotap header we are walking through
1813 * @_max_length: length of radiotap header in cpu byte ordering
1814 * @_arg_index: next argument index
1815 * @_arg: next argument pointer
1816 * @_next_bitmap: internal pointer to next present u32
1817 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
1818 * @_vns: vendor namespace definitions
1819 * @_next_ns_data: beginning of the next namespace's data
1820 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
1823 * Describes the radiotap parser state. Fields prefixed with an underscore
1824 * must not be used by users of the parser, only by the parser internally.
1827 struct ieee80211_radiotap_iterator {
1828 struct ieee80211_radiotap_header *_rtheader;
1829 const struct ieee80211_radiotap_vendor_namespaces *_vns;
1830 const struct ieee80211_radiotap_namespace *current_namespace;
1832 unsigned char *_arg, *_next_ns_data;
1833 __le32 *_next_bitmap;
1835 unsigned char *this_arg;
1843 uint32_t _bitmap_shifter;
1847 extern int ieee80211_radiotap_iterator_init(
1848 struct ieee80211_radiotap_iterator *iterator,
1849 struct ieee80211_radiotap_header *radiotap_header,
1850 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
1852 extern int ieee80211_radiotap_iterator_next(
1853 struct ieee80211_radiotap_iterator *iterator);
1856 extern const unsigned char rfc1042_header[6];
1857 extern const unsigned char bridge_tunnel_header[6];
1860 * ieee80211_get_hdrlen_from_skb - get header length from data
1862 * Given an skb with a raw 802.11 header at the data pointer this function
1863 * returns the 802.11 header length in bytes (not including encryption
1864 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1865 * header the function returns 0.
1869 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1872 * ieee80211_hdrlen - get header length in bytes from frame control
1873 * @fc: frame control field in little-endian format
1875 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
1878 * DOC: Data path helpers
1880 * In addition to generic utilities, cfg80211 also offers
1881 * functions that help implement the data path for devices
1882 * that do not do the 802.11/802.3 conversion on the device.
1886 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
1887 * @skb: the 802.11 data frame
1888 * @addr: the device MAC address
1889 * @iftype: the virtual interface type
1891 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
1892 enum nl80211_iftype iftype);
1895 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
1896 * @skb: the 802.3 frame
1897 * @addr: the device MAC address
1898 * @iftype: the virtual interface type
1899 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
1900 * @qos: build 802.11 QoS data frame
1902 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
1903 enum nl80211_iftype iftype, u8 *bssid, bool qos);
1906 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
1908 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
1909 * 802.3 frames. The @list will be empty if the decode fails. The
1910 * @skb is consumed after the function returns.
1912 * @skb: The input IEEE 802.11n A-MSDU frame.
1913 * @list: The output list of 802.3 frames. It must be allocated and
1914 * initialized by by the caller.
1915 * @addr: The device MAC address.
1916 * @iftype: The device interface type.
1917 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
1919 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
1920 const u8 *addr, enum nl80211_iftype iftype,
1921 const unsigned int extra_headroom);
1924 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
1925 * @skb: the data frame
1927 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
1930 * cfg80211_find_ie - find information element in data
1933 * @ies: data consisting of IEs
1934 * @len: length of data
1936 * This function will return %NULL if the element ID could
1937 * not be found or if the element is invalid (claims to be
1938 * longer than the given data), or a pointer to the first byte
1939 * of the requested element, that is the byte containing the
1940 * element ID. There are no checks on the element length
1941 * other than having to fit into the given data.
1943 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
1946 * DOC: Regulatory enforcement infrastructure
1952 * regulatory_hint - driver hint to the wireless core a regulatory domain
1953 * @wiphy: the wireless device giving the hint (used only for reporting
1955 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
1956 * should be in. If @rd is set this should be NULL. Note that if you
1957 * set this to NULL you should still set rd->alpha2 to some accepted
1960 * Wireless drivers can use this function to hint to the wireless core
1961 * what it believes should be the current regulatory domain by
1962 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
1963 * domain should be in or by providing a completely build regulatory domain.
1964 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
1965 * for a regulatory domain structure for the respective country.
1967 * The wiphy must have been registered to cfg80211 prior to this call.
1968 * For cfg80211 drivers this means you must first use wiphy_register(),
1969 * for mac80211 drivers you must first use ieee80211_register_hw().
1971 * Drivers should check the return value, its possible you can get
1974 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
1977 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
1978 * @wiphy: the wireless device we want to process the regulatory domain on
1979 * @regd: the custom regulatory domain to use for this wiphy
1981 * Drivers can sometimes have custom regulatory domains which do not apply
1982 * to a specific country. Drivers can use this to apply such custom regulatory
1983 * domains. This routine must be called prior to wiphy registration. The
1984 * custom regulatory domain will be trusted completely and as such previous
1985 * default channel settings will be disregarded. If no rule is found for a
1986 * channel on the regulatory domain the channel will be disabled.
1988 extern void wiphy_apply_custom_regulatory(
1989 struct wiphy *wiphy,
1990 const struct ieee80211_regdomain *regd);
1993 * freq_reg_info - get regulatory information for the given frequency
1994 * @wiphy: the wiphy for which we want to process this rule for
1995 * @center_freq: Frequency in KHz for which we want regulatory information for
1996 * @desired_bw_khz: the desired max bandwidth you want to use per
1997 * channel. Note that this is still 20 MHz if you want to use HT40
1998 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
1999 * If set to 0 we'll assume you want the standard 20 MHz.
2000 * @reg_rule: the regulatory rule which we have for this frequency
2002 * Use this function to get the regulatory rule for a specific frequency on
2003 * a given wireless device. If the device has a specific regulatory domain
2004 * it wants to follow we respect that unless a country IE has been received
2005 * and processed already.
2007 * Returns 0 if it was able to find a valid regulatory rule which does
2008 * apply to the given center_freq otherwise it returns non-zero. It will
2009 * also return -ERANGE if we determine the given center_freq does not even have
2010 * a regulatory rule for a frequency range in the center_freq's band. See
2011 * freq_in_rule_band() for our current definition of a band -- this is purely
2012 * subjective and right now its 802.11 specific.
2014 extern int freq_reg_info(struct wiphy *wiphy,
2017 const struct ieee80211_reg_rule **reg_rule);
2020 * Temporary wext handlers & helper functions
2022 * In the future cfg80211 will simply assign the entire wext handler
2023 * structure to netdevs it manages, but we're not there yet.
2025 int cfg80211_wext_giwname(struct net_device *dev,
2026 struct iw_request_info *info,
2027 char *name, char *extra);
2028 int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
2029 u32 *mode, char *extra);
2030 int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
2031 u32 *mode, char *extra);
2032 int cfg80211_wext_siwscan(struct net_device *dev,
2033 struct iw_request_info *info,
2034 union iwreq_data *wrqu, char *extra);
2035 int cfg80211_wext_giwscan(struct net_device *dev,
2036 struct iw_request_info *info,
2037 struct iw_point *data, char *extra);
2038 int cfg80211_wext_siwmlme(struct net_device *dev,
2039 struct iw_request_info *info,
2040 struct iw_point *data, char *extra);
2041 int cfg80211_wext_giwrange(struct net_device *dev,
2042 struct iw_request_info *info,
2043 struct iw_point *data, char *extra);
2044 int cfg80211_wext_siwgenie(struct net_device *dev,
2045 struct iw_request_info *info,
2046 struct iw_point *data, char *extra);
2047 int cfg80211_wext_siwauth(struct net_device *dev,
2048 struct iw_request_info *info,
2049 struct iw_param *data, char *extra);
2050 int cfg80211_wext_giwauth(struct net_device *dev,
2051 struct iw_request_info *info,
2052 struct iw_param *data, char *extra);
2054 int cfg80211_wext_siwfreq(struct net_device *dev,
2055 struct iw_request_info *info,
2056 struct iw_freq *freq, char *extra);
2057 int cfg80211_wext_giwfreq(struct net_device *dev,
2058 struct iw_request_info *info,
2059 struct iw_freq *freq, char *extra);
2060 int cfg80211_wext_siwessid(struct net_device *dev,
2061 struct iw_request_info *info,
2062 struct iw_point *data, char *ssid);
2063 int cfg80211_wext_giwessid(struct net_device *dev,
2064 struct iw_request_info *info,
2065 struct iw_point *data, char *ssid);
2066 int cfg80211_wext_siwrate(struct net_device *dev,
2067 struct iw_request_info *info,
2068 struct iw_param *rate, char *extra);
2069 int cfg80211_wext_giwrate(struct net_device *dev,
2070 struct iw_request_info *info,
2071 struct iw_param *rate, char *extra);
2073 int cfg80211_wext_siwrts(struct net_device *dev,
2074 struct iw_request_info *info,
2075 struct iw_param *rts, char *extra);
2076 int cfg80211_wext_giwrts(struct net_device *dev,
2077 struct iw_request_info *info,
2078 struct iw_param *rts, char *extra);
2079 int cfg80211_wext_siwfrag(struct net_device *dev,
2080 struct iw_request_info *info,
2081 struct iw_param *frag, char *extra);
2082 int cfg80211_wext_giwfrag(struct net_device *dev,
2083 struct iw_request_info *info,
2084 struct iw_param *frag, char *extra);
2085 int cfg80211_wext_siwretry(struct net_device *dev,
2086 struct iw_request_info *info,
2087 struct iw_param *retry, char *extra);
2088 int cfg80211_wext_giwretry(struct net_device *dev,
2089 struct iw_request_info *info,
2090 struct iw_param *retry, char *extra);
2091 int cfg80211_wext_siwencodeext(struct net_device *dev,
2092 struct iw_request_info *info,
2093 struct iw_point *erq, char *extra);
2094 int cfg80211_wext_siwencode(struct net_device *dev,
2095 struct iw_request_info *info,
2096 struct iw_point *erq, char *keybuf);
2097 int cfg80211_wext_giwencode(struct net_device *dev,
2098 struct iw_request_info *info,
2099 struct iw_point *erq, char *keybuf);
2100 int cfg80211_wext_siwtxpower(struct net_device *dev,
2101 struct iw_request_info *info,
2102 union iwreq_data *data, char *keybuf);
2103 int cfg80211_wext_giwtxpower(struct net_device *dev,
2104 struct iw_request_info *info,
2105 union iwreq_data *data, char *keybuf);
2106 struct iw_statistics *cfg80211_wireless_stats(struct net_device *dev);
2108 int cfg80211_wext_siwpower(struct net_device *dev,
2109 struct iw_request_info *info,
2110 struct iw_param *wrq, char *extra);
2111 int cfg80211_wext_giwpower(struct net_device *dev,
2112 struct iw_request_info *info,
2113 struct iw_param *wrq, char *extra);
2115 int cfg80211_wext_siwap(struct net_device *dev,
2116 struct iw_request_info *info,
2117 struct sockaddr *ap_addr, char *extra);
2118 int cfg80211_wext_giwap(struct net_device *dev,
2119 struct iw_request_info *info,
2120 struct sockaddr *ap_addr, char *extra);
2122 int cfg80211_wext_siwpmksa(struct net_device *dev,
2123 struct iw_request_info *info,
2124 struct iw_point *data, char *extra);
2127 * callbacks for asynchronous cfg80211 methods, notification
2128 * functions and BSS handling helpers
2132 * cfg80211_scan_done - notify that scan finished
2134 * @request: the corresponding scan request
2135 * @aborted: set to true if the scan was aborted for any reason,
2136 * userspace will be notified of that
2138 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2141 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2143 * @wiphy: the wiphy reporting the BSS
2144 * @channel: The channel the frame was received on
2145 * @mgmt: the management frame (probe response or beacon)
2146 * @len: length of the management frame
2147 * @signal: the signal strength, type depends on the wiphy's signal_type
2148 * @gfp: context flags
2150 * This informs cfg80211 that BSS information was found and
2151 * the BSS should be updated/added.
2153 struct cfg80211_bss*
2154 cfg80211_inform_bss_frame(struct wiphy *wiphy,
2155 struct ieee80211_channel *channel,
2156 struct ieee80211_mgmt *mgmt, size_t len,
2157 s32 signal, gfp_t gfp);
2160 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2162 * @wiphy: the wiphy reporting the BSS
2163 * @channel: The channel the frame was received on
2164 * @bssid: the BSSID of the BSS
2165 * @timestamp: the TSF timestamp sent by the peer
2166 * @capability: the capability field sent by the peer
2167 * @beacon_interval: the beacon interval announced by the peer
2168 * @ie: additional IEs sent by the peer
2169 * @ielen: length of the additional IEs
2170 * @signal: the signal strength, type depends on the wiphy's signal_type
2171 * @gfp: context flags
2173 * This informs cfg80211 that BSS information was found and
2174 * the BSS should be updated/added.
2176 struct cfg80211_bss*
2177 cfg80211_inform_bss(struct wiphy *wiphy,
2178 struct ieee80211_channel *channel,
2180 u64 timestamp, u16 capability, u16 beacon_interval,
2181 const u8 *ie, size_t ielen,
2182 s32 signal, gfp_t gfp);
2184 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2185 struct ieee80211_channel *channel,
2187 const u8 *ssid, size_t ssid_len,
2188 u16 capa_mask, u16 capa_val);
2189 static inline struct cfg80211_bss *
2190 cfg80211_get_ibss(struct wiphy *wiphy,
2191 struct ieee80211_channel *channel,
2192 const u8 *ssid, size_t ssid_len)
2194 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2195 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2198 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2199 struct ieee80211_channel *channel,
2200 const u8 *meshid, size_t meshidlen,
2202 void cfg80211_put_bss(struct cfg80211_bss *bss);
2205 * cfg80211_unlink_bss - unlink BSS from internal data structures
2207 * @bss: the bss to remove
2209 * This function removes the given BSS from the internal data structures
2210 * thereby making it no longer show up in scan results etc. Use this
2211 * function when you detect a BSS is gone. Normally BSSes will also time
2212 * out, so it is not necessary to use this function at all.
2214 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
2217 * cfg80211_send_rx_auth - notification of processed authentication
2218 * @dev: network device
2219 * @buf: authentication frame (header + body)
2220 * @len: length of the frame data
2222 * This function is called whenever an authentication has been processed in
2223 * station mode. The driver is required to call either this function or
2224 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2225 * call. This function may sleep.
2227 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
2230 * cfg80211_send_auth_timeout - notification of timed out authentication
2231 * @dev: network device
2232 * @addr: The MAC address of the device with which the authentication timed out
2234 * This function may sleep.
2236 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
2239 * __cfg80211_auth_canceled - notify cfg80211 that authentication was canceled
2240 * @dev: network device
2241 * @addr: The MAC address of the device with which the authentication timed out
2243 * When a pending authentication had no action yet, the driver may decide
2244 * to not send a deauth frame, but in that case must calls this function
2245 * to tell cfg80211 about this decision. It is only valid to call this
2246 * function within the deauth() callback.
2248 void __cfg80211_auth_canceled(struct net_device *dev, const u8 *addr);
2251 * cfg80211_send_rx_assoc - notification of processed association
2252 * @dev: network device
2253 * @buf: (re)association response frame (header + body)
2254 * @len: length of the frame data
2256 * This function is called whenever a (re)association response has been
2257 * processed in station mode. The driver is required to call either this
2258 * function or cfg80211_send_assoc_timeout() to indicate the result of
2259 * cfg80211_ops::assoc() call. This function may sleep.
2261 void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
2264 * cfg80211_send_assoc_timeout - notification of timed out association
2265 * @dev: network device
2266 * @addr: The MAC address of the device with which the association timed out
2268 * This function may sleep.
2270 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
2273 * cfg80211_send_deauth - notification of processed deauthentication
2274 * @dev: network device
2275 * @buf: deauthentication frame (header + body)
2276 * @len: length of the frame data
2278 * This function is called whenever deauthentication has been processed in
2279 * station mode. This includes both received deauthentication frames and
2280 * locally generated ones. This function may sleep.
2282 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2285 * __cfg80211_send_deauth - notification of processed deauthentication
2286 * @dev: network device
2287 * @buf: deauthentication frame (header + body)
2288 * @len: length of the frame data
2290 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2292 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2295 * cfg80211_send_disassoc - notification of processed disassociation
2296 * @dev: network device
2297 * @buf: disassociation response frame (header + body)
2298 * @len: length of the frame data
2300 * This function is called whenever disassociation has been processed in
2301 * station mode. This includes both received disassociation frames and locally
2302 * generated ones. This function may sleep.
2304 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
2307 * __cfg80211_send_disassoc - notification of processed disassociation
2308 * @dev: network device
2309 * @buf: disassociation response frame (header + body)
2310 * @len: length of the frame data
2312 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2314 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
2318 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
2319 * @dev: network device
2320 * @addr: The source MAC address of the frame
2321 * @key_type: The key type that the received frame used
2322 * @key_id: Key identifier (0..3)
2323 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
2324 * @gfp: allocation flags
2326 * This function is called whenever the local MAC detects a MIC failure in a
2327 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
2330 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
2331 enum nl80211_key_type key_type, int key_id,
2332 const u8 *tsc, gfp_t gfp);
2335 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
2337 * @dev: network device
2338 * @bssid: the BSSID of the IBSS joined
2339 * @gfp: allocation flags
2341 * This function notifies cfg80211 that the device joined an IBSS or
2342 * switched to a different BSSID. Before this function can be called,
2343 * either a beacon has to have been received from the IBSS, or one of
2344 * the cfg80211_inform_bss{,_frame} functions must have been called
2345 * with the locally generated beacon -- this guarantees that there is
2346 * always a scan result for this IBSS. cfg80211 will handle the rest.
2348 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
2351 * DOC: RFkill integration
2353 * RFkill integration in cfg80211 is almost invisible to drivers,
2354 * as cfg80211 automatically registers an rfkill instance for each
2355 * wireless device it knows about. Soft kill is also translated
2356 * into disconnecting and turning all interfaces off, drivers are
2357 * expected to turn off the device when all interfaces are down.
2359 * However, devices may have a hard RFkill line, in which case they
2360 * also need to interact with the rfkill subsystem, via cfg80211.
2361 * They can do this with a few helper functions documented here.
2365 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
2367 * @blocked: block status
2369 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
2372 * wiphy_rfkill_start_polling - start polling rfkill
2375 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
2378 * wiphy_rfkill_stop_polling - stop polling rfkill
2381 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
2383 #ifdef CONFIG_NL80211_TESTMODE
2387 * Test mode is a set of utility functions to allow drivers to
2388 * interact with driver-specific tools to aid, for instance,
2389 * factory programming.
2391 * This chapter describes how drivers interact with it, for more
2392 * information see the nl80211 book's chapter on it.
2396 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
2398 * @approxlen: an upper bound of the length of the data that will
2399 * be put into the skb
2401 * This function allocates and pre-fills an skb for a reply to
2402 * the testmode command. Since it is intended for a reply, calling
2403 * it outside of the @testmode_cmd operation is invalid.
2405 * The returned skb (or %NULL if any errors happen) is pre-filled
2406 * with the wiphy index and set up in a way that any data that is
2407 * put into the skb (with skb_put(), nla_put() or similar) will end
2408 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
2409 * needs to be done with the skb is adding data for the corresponding
2410 * userspace tool which can then read that data out of the testdata
2411 * attribute. You must not modify the skb in any other way.
2413 * When done, call cfg80211_testmode_reply() with the skb and return
2414 * its error code as the result of the @testmode_cmd operation.
2416 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
2420 * cfg80211_testmode_reply - send the reply skb
2421 * @skb: The skb, must have been allocated with
2422 * cfg80211_testmode_alloc_reply_skb()
2424 * Returns an error code or 0 on success, since calling this
2425 * function will usually be the last thing before returning
2426 * from the @testmode_cmd you should return the error code.
2427 * Note that this function consumes the skb regardless of the
2430 int cfg80211_testmode_reply(struct sk_buff *skb);
2433 * cfg80211_testmode_alloc_event_skb - allocate testmode event
2435 * @approxlen: an upper bound of the length of the data that will
2436 * be put into the skb
2437 * @gfp: allocation flags
2439 * This function allocates and pre-fills an skb for an event on the
2440 * testmode multicast group.
2442 * The returned skb (or %NULL if any errors happen) is set up in the
2443 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
2444 * for an event. As there, you should simply add data to it that will
2445 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
2446 * not modify the skb in any other way.
2448 * When done filling the skb, call cfg80211_testmode_event() with the
2449 * skb to send the event.
2451 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
2452 int approxlen, gfp_t gfp);
2455 * cfg80211_testmode_event - send the event
2456 * @skb: The skb, must have been allocated with
2457 * cfg80211_testmode_alloc_event_skb()
2458 * @gfp: allocation flags
2460 * This function sends the given @skb, which must have been allocated
2461 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
2464 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
2466 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
2468 #define CFG80211_TESTMODE_CMD(cmd)
2472 * cfg80211_connect_result - notify cfg80211 of connection result
2474 * @dev: network device
2475 * @bssid: the BSSID of the AP
2476 * @req_ie: association request IEs (maybe be %NULL)
2477 * @req_ie_len: association request IEs length
2478 * @resp_ie: association response IEs (may be %NULL)
2479 * @resp_ie_len: assoc response IEs length
2480 * @status: status code, 0 for successful connection, use
2481 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
2482 * the real status code for failures.
2483 * @gfp: allocation flags
2485 * It should be called by the underlying driver whenever connect() has
2488 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
2489 const u8 *req_ie, size_t req_ie_len,
2490 const u8 *resp_ie, size_t resp_ie_len,
2491 u16 status, gfp_t gfp);
2494 * cfg80211_roamed - notify cfg80211 of roaming
2496 * @dev: network device
2497 * @bssid: the BSSID of the new AP
2498 * @req_ie: association request IEs (maybe be %NULL)
2499 * @req_ie_len: association request IEs length
2500 * @resp_ie: association response IEs (may be %NULL)
2501 * @resp_ie_len: assoc response IEs length
2502 * @gfp: allocation flags
2504 * It should be called by the underlying driver whenever it roamed
2505 * from one AP to another while connected.
2507 void cfg80211_roamed(struct net_device *dev, const u8 *bssid,
2508 const u8 *req_ie, size_t req_ie_len,
2509 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
2512 * cfg80211_disconnected - notify cfg80211 that connection was dropped
2514 * @dev: network device
2515 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
2516 * @ie_len: length of IEs
2517 * @reason: reason code for the disconnection, set it to 0 if unknown
2518 * @gfp: allocation flags
2520 * After it calls this function, the driver should enter an idle state
2521 * and not try to connect to any AP any more.
2523 void cfg80211_disconnected(struct net_device *dev, u16 reason,
2524 u8 *ie, size_t ie_len, gfp_t gfp);
2527 * cfg80211_ready_on_channel - notification of remain_on_channel start
2528 * @dev: network device
2529 * @cookie: the request cookie
2530 * @chan: The current channel (from remain_on_channel request)
2531 * @channel_type: Channel type
2532 * @duration: Duration in milliseconds that the driver intents to remain on the
2534 * @gfp: allocation flags
2536 void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
2537 struct ieee80211_channel *chan,
2538 enum nl80211_channel_type channel_type,
2539 unsigned int duration, gfp_t gfp);
2542 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
2543 * @dev: network device
2544 * @cookie: the request cookie
2545 * @chan: The current channel (from remain_on_channel request)
2546 * @channel_type: Channel type
2547 * @gfp: allocation flags
2549 void cfg80211_remain_on_channel_expired(struct net_device *dev,
2551 struct ieee80211_channel *chan,
2552 enum nl80211_channel_type channel_type,
2557 * cfg80211_new_sta - notify userspace about station
2560 * @mac_addr: the station's address
2561 * @sinfo: the station information
2562 * @gfp: allocation flags
2564 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
2565 struct station_info *sinfo, gfp_t gfp);
2568 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
2569 * @dev: network device
2570 * @freq: Frequency on which the frame was received in MHz
2571 * @buf: Management frame (header + body)
2572 * @len: length of the frame data
2573 * @gfp: context flags
2575 * Returns %true if a user space application has registered for this frame.
2576 * For action frames, that makes it responsible for rejecting unrecognized
2577 * action frames; %false otherwise, in which case for action frames the
2578 * driver is responsible for rejecting the frame.
2580 * This function is called whenever an Action frame is received for a station
2581 * mode interface, but is not processed in kernel.
2583 bool cfg80211_rx_mgmt(struct net_device *dev, int freq, const u8 *buf,
2584 size_t len, gfp_t gfp);
2587 * cfg80211_mgmt_tx_status - notification of TX status for management frame
2588 * @dev: network device
2589 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
2590 * @buf: Management frame (header + body)
2591 * @len: length of the frame data
2592 * @ack: Whether frame was acknowledged
2593 * @gfp: context flags
2595 * This function is called whenever a management frame was requested to be
2596 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
2597 * transmission attempt.
2599 void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
2600 const u8 *buf, size_t len, bool ack, gfp_t gfp);
2604 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
2605 * @dev: network device
2606 * @rssi_event: the triggered RSSI event
2607 * @gfp: context flags
2609 * This function is called when a configured connection quality monitoring
2610 * rssi threshold reached event occurs.
2612 void cfg80211_cqm_rssi_notify(struct net_device *dev,
2613 enum nl80211_cqm_rssi_threshold_event rssi_event,
2617 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
2618 * @dev: network device
2619 * @peer: peer's MAC address
2620 * @num_packets: how many packets were lost -- should be a fixed threshold
2621 * but probably no less than maybe 50, or maybe a throughput dependent
2622 * threshold (to account for temporary interference)
2623 * @gfp: context flags
2625 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
2626 const u8 *peer, u32 num_packets, gfp_t gfp);
2628 /* Logging, debugging and troubleshooting/diagnostic helpers. */
2630 /* wiphy_printk helpers, similar to dev_printk */
2632 #define wiphy_printk(level, wiphy, format, args...) \
2633 dev_printk(level, &(wiphy)->dev, format, ##args)
2634 #define wiphy_emerg(wiphy, format, args...) \
2635 dev_emerg(&(wiphy)->dev, format, ##args)
2636 #define wiphy_alert(wiphy, format, args...) \
2637 dev_alert(&(wiphy)->dev, format, ##args)
2638 #define wiphy_crit(wiphy, format, args...) \
2639 dev_crit(&(wiphy)->dev, format, ##args)
2640 #define wiphy_err(wiphy, format, args...) \
2641 dev_err(&(wiphy)->dev, format, ##args)
2642 #define wiphy_warn(wiphy, format, args...) \
2643 dev_warn(&(wiphy)->dev, format, ##args)
2644 #define wiphy_notice(wiphy, format, args...) \
2645 dev_notice(&(wiphy)->dev, format, ##args)
2646 #define wiphy_info(wiphy, format, args...) \
2647 dev_info(&(wiphy)->dev, format, ##args)
2649 #define wiphy_debug(wiphy, format, args...) \
2650 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
2652 #define wiphy_dbg(wiphy, format, args...) \
2653 dev_dbg(&(wiphy)->dev, format, ##args)
2655 #if defined(VERBOSE_DEBUG)
2656 #define wiphy_vdbg wiphy_dbg
2658 #define wiphy_vdbg(wiphy, format, args...) \
2661 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
2667 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
2668 * of using a WARN/WARN_ON to get the message out, including the
2669 * file/line information and a backtrace.
2671 #define wiphy_WARN(wiphy, format, args...) \
2672 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
2674 #endif /* __NET_CFG80211_H */