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
298 * Used by the driver to indicate which info in &struct survey_info
299 * it has filled in during the get_survey().
301 enum survey_info_flags {
302 SURVEY_INFO_NOISE_DBM = 1<<0,
303 SURVEY_INFO_IN_USE = 1<<1,
307 * struct survey_info - channel survey response
309 * @channel: the channel this survey record reports, mandatory
310 * @filled: bitflag of flags from &enum survey_info_flags
311 * @noise: channel noise in dBm. This and all following fields are
314 * Used by dump_survey() to report back per-channel survey information.
316 * This structure can later be expanded with things like
317 * channel duty cycle etc.
320 struct ieee80211_channel *channel;
326 * struct beacon_parameters - beacon parameters
328 * Used to configure the beacon for an interface.
330 * @head: head portion of beacon (before TIM IE)
331 * or %NULL if not changed
332 * @tail: tail portion of beacon (after TIM IE)
333 * or %NULL if not changed
334 * @interval: beacon interval or zero if not changed
335 * @dtim_period: DTIM period or zero if not changed
336 * @head_len: length of @head
337 * @tail_len: length of @tail
339 struct beacon_parameters {
341 int interval, dtim_period;
342 int head_len, tail_len;
346 * enum plink_action - actions to perform in mesh peers
348 * @PLINK_ACTION_INVALID: action 0 is reserved
349 * @PLINK_ACTION_OPEN: start mesh peer link establishment
350 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
353 PLINK_ACTION_INVALID,
359 * struct station_parameters - station parameters
361 * Used to change and create a new station.
363 * @vlan: vlan interface station should belong to
364 * @supported_rates: supported rates in IEEE 802.11 format
365 * (or NULL for no change)
366 * @supported_rates_len: number of supported rates
367 * @sta_flags_mask: station flags that changed
368 * (bitmask of BIT(NL80211_STA_FLAG_...))
369 * @sta_flags_set: station flags values
370 * (bitmask of BIT(NL80211_STA_FLAG_...))
371 * @listen_interval: listen interval or -1 for no change
372 * @aid: AID or zero for no change
373 * @plink_action: plink action to take
374 * @ht_capa: HT capabilities of station
376 struct station_parameters {
378 struct net_device *vlan;
379 u32 sta_flags_mask, sta_flags_set;
382 u8 supported_rates_len;
384 struct ieee80211_ht_cap *ht_capa;
388 * enum station_info_flags - station information flags
390 * Used by the driver to indicate which info in &struct station_info
391 * it has filled in during get_station() or dump_station().
393 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
394 * @STATION_INFO_RX_BYTES: @rx_bytes filled
395 * @STATION_INFO_TX_BYTES: @tx_bytes filled
396 * @STATION_INFO_LLID: @llid filled
397 * @STATION_INFO_PLID: @plid filled
398 * @STATION_INFO_PLINK_STATE: @plink_state filled
399 * @STATION_INFO_SIGNAL: @signal filled
400 * @STATION_INFO_TX_BITRATE: @tx_bitrate fields are filled
401 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
402 * @STATION_INFO_RX_PACKETS: @rx_packets filled
403 * @STATION_INFO_TX_PACKETS: @tx_packets filled
404 * @STATION_INFO_TX_RETRIES: @tx_retries filled
405 * @STATION_INFO_TX_FAILED: @tx_failed filled
407 enum station_info_flags {
408 STATION_INFO_INACTIVE_TIME = 1<<0,
409 STATION_INFO_RX_BYTES = 1<<1,
410 STATION_INFO_TX_BYTES = 1<<2,
411 STATION_INFO_LLID = 1<<3,
412 STATION_INFO_PLID = 1<<4,
413 STATION_INFO_PLINK_STATE = 1<<5,
414 STATION_INFO_SIGNAL = 1<<6,
415 STATION_INFO_TX_BITRATE = 1<<7,
416 STATION_INFO_RX_PACKETS = 1<<8,
417 STATION_INFO_TX_PACKETS = 1<<9,
418 STATION_INFO_TX_RETRIES = 1<<10,
419 STATION_INFO_TX_FAILED = 1<<11,
423 * enum station_info_rate_flags - bitrate info flags
425 * Used by the driver to indicate the specific rate transmission
426 * type for 802.11n transmissions.
428 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
429 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
430 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
432 enum rate_info_flags {
433 RATE_INFO_FLAGS_MCS = 1<<0,
434 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
435 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
439 * struct rate_info - bitrate information
441 * Information about a receiving or transmitting bitrate
443 * @flags: bitflag of flags from &enum rate_info_flags
444 * @mcs: mcs index if struct describes a 802.11n bitrate
445 * @legacy: bitrate in 100kbit/s for 802.11abg
454 * struct station_info - station information
456 * Station information filled by driver for get_station() and dump_station.
458 * @filled: bitflag of flags from &enum station_info_flags
459 * @inactive_time: time since last station activity (tx/rx) in milliseconds
460 * @rx_bytes: bytes received from this station
461 * @tx_bytes: bytes transmitted to this station
462 * @llid: mesh local link id
463 * @plid: mesh peer link id
464 * @plink_state: mesh peer link state
465 * @signal: signal strength of last received packet in dBm
466 * @txrate: current unicast bitrate to this station
467 * @rx_packets: packets received from this station
468 * @tx_packets: packets transmitted to this station
469 * @tx_retries: cumulative retry counts
470 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
471 * @generation: generation number for nl80211 dumps.
472 * This number should increase every time the list of stations
473 * changes, i.e. when a station is added or removed, so that
474 * userspace can tell whether it got a consistent snapshot.
476 struct station_info {
485 struct rate_info txrate;
495 * enum monitor_flags - monitor flags
497 * Monitor interface configuration flags. Note that these must be the bits
498 * according to the nl80211 flags.
500 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
501 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
502 * @MONITOR_FLAG_CONTROL: pass control frames
503 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
504 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
507 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
508 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
509 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
510 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
511 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
515 * enum mpath_info_flags - mesh path information flags
517 * Used by the driver to indicate which info in &struct mpath_info it has filled
518 * in during get_station() or dump_station().
520 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
521 * @MPATH_INFO_SN: @sn filled
522 * @MPATH_INFO_METRIC: @metric filled
523 * @MPATH_INFO_EXPTIME: @exptime filled
524 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
525 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
526 * @MPATH_INFO_FLAGS: @flags filled
528 enum mpath_info_flags {
529 MPATH_INFO_FRAME_QLEN = BIT(0),
530 MPATH_INFO_SN = BIT(1),
531 MPATH_INFO_METRIC = BIT(2),
532 MPATH_INFO_EXPTIME = BIT(3),
533 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
534 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
535 MPATH_INFO_FLAGS = BIT(6),
539 * struct mpath_info - mesh path information
541 * Mesh path information filled by driver for get_mpath() and dump_mpath().
543 * @filled: bitfield of flags from &enum mpath_info_flags
544 * @frame_qlen: number of queued frames for this destination
545 * @sn: target sequence number
546 * @metric: metric (cost) of this mesh path
547 * @exptime: expiration time for the mesh path from now, in msecs
548 * @flags: mesh path flags
549 * @discovery_timeout: total mesh path discovery timeout, in msecs
550 * @discovery_retries: mesh path discovery retries
551 * @generation: generation number for nl80211 dumps.
552 * This number should increase every time the list of mesh paths
553 * changes, i.e. when a station is added or removed, so that
554 * userspace can tell whether it got a consistent snapshot.
562 u32 discovery_timeout;
563 u8 discovery_retries;
570 * struct bss_parameters - BSS parameters
572 * Used to change BSS parameters (mainly for AP mode).
574 * @use_cts_prot: Whether to use CTS protection
575 * (0 = no, 1 = yes, -1 = do not change)
576 * @use_short_preamble: Whether the use of short preambles is allowed
577 * (0 = no, 1 = yes, -1 = do not change)
578 * @use_short_slot_time: Whether the use of short slot time is allowed
579 * (0 = no, 1 = yes, -1 = do not change)
580 * @basic_rates: basic rates in IEEE 802.11 format
581 * (or NULL for no change)
582 * @basic_rates_len: number of basic rates
583 * @ap_isolate: do not forward packets between connected stations
585 struct bss_parameters {
587 int use_short_preamble;
588 int use_short_slot_time;
596 /* Mesh plink management parameters */
597 u16 dot11MeshRetryTimeout;
598 u16 dot11MeshConfirmTimeout;
599 u16 dot11MeshHoldingTimeout;
600 u16 dot11MeshMaxPeerLinks;
601 u8 dot11MeshMaxRetries;
603 bool auto_open_plinks;
604 /* HWMP parameters */
605 u8 dot11MeshHWMPmaxPREQretries;
606 u32 path_refresh_time;
607 u16 min_discovery_timeout;
608 u32 dot11MeshHWMPactivePathTimeout;
609 u16 dot11MeshHWMPpreqMinInterval;
610 u16 dot11MeshHWMPnetDiameterTraversalTime;
611 u8 dot11MeshHWMPRootMode;
615 * struct ieee80211_txq_params - TX queue parameters
616 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
617 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
618 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
620 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
622 * @aifs: Arbitration interframe space [0..255]
624 struct ieee80211_txq_params {
625 enum nl80211_txq_q queue;
632 /* from net/wireless.h */
636 * DOC: Scanning and BSS list handling
638 * The scanning process itself is fairly simple, but cfg80211 offers quite
639 * a bit of helper functionality. To start a scan, the scan operation will
640 * be invoked with a scan definition. This scan definition contains the
641 * channels to scan, and the SSIDs to send probe requests for (including the
642 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
643 * probe. Additionally, a scan request may contain extra information elements
644 * that should be added to the probe request. The IEs are guaranteed to be
645 * well-formed, and will not exceed the maximum length the driver advertised
646 * in the wiphy structure.
648 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
649 * it is responsible for maintaining the BSS list; the driver should not
650 * maintain a list itself. For this notification, various functions exist.
652 * Since drivers do not maintain a BSS list, there are also a number of
653 * functions to search for a BSS and obtain information about it from the
654 * BSS structure cfg80211 maintains. The BSS list is also made available
659 * struct cfg80211_ssid - SSID description
661 * @ssid_len: length of the ssid
663 struct cfg80211_ssid {
664 u8 ssid[IEEE80211_MAX_SSID_LEN];
669 * struct cfg80211_scan_request - scan request description
671 * @ssids: SSIDs to scan for (active scan only)
672 * @n_ssids: number of SSIDs
673 * @channels: channels to scan on.
674 * @n_channels: total number of channels to scan
675 * @ie: optional information element(s) to add into Probe Request or %NULL
676 * @ie_len: length of ie in octets
677 * @wiphy: the wiphy this was for
678 * @dev: the interface
679 * @aborted: (internal) scan request was notified as aborted
681 struct cfg80211_scan_request {
682 struct cfg80211_ssid *ssids;
690 struct net_device *dev;
694 struct ieee80211_channel *channels[0];
698 * enum cfg80211_signal_type - signal type
700 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
701 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
702 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
704 enum cfg80211_signal_type {
705 CFG80211_SIGNAL_TYPE_NONE,
706 CFG80211_SIGNAL_TYPE_MBM,
707 CFG80211_SIGNAL_TYPE_UNSPEC,
711 * struct cfg80211_bss - BSS description
713 * This structure describes a BSS (which may also be a mesh network)
714 * for use in scan results and similar.
716 * @channel: channel this BSS is on
717 * @bssid: BSSID of the BSS
718 * @tsf: timestamp of last received update
719 * @beacon_interval: the beacon interval as from the frame
720 * @capability: the capability field in host byte order
721 * @information_elements: the information elements (Note that there
722 * is no guarantee that these are well-formed!); this is a pointer to
723 * either the beacon_ies or proberesp_ies depending on whether Probe
724 * Response frame has been received
725 * @len_information_elements: total length of the information elements
726 * @beacon_ies: the information elements from the last Beacon frame
727 * @len_beacon_ies: total length of the beacon_ies
728 * @proberesp_ies: the information elements from the last Probe Response frame
729 * @len_proberesp_ies: total length of the proberesp_ies
730 * @signal: signal strength value (type depends on the wiphy's signal_type)
731 * @free_priv: function pointer to free private data
732 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
734 struct cfg80211_bss {
735 struct ieee80211_channel *channel;
741 u8 *information_elements;
742 size_t len_information_elements;
744 size_t len_beacon_ies;
746 size_t len_proberesp_ies;
750 void (*free_priv)(struct cfg80211_bss *bss);
751 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
755 * ieee80211_bss_get_ie - find IE with given ID
756 * @bss: the bss to search
758 * Returns %NULL if not found.
760 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
764 * struct cfg80211_crypto_settings - Crypto settings
765 * @wpa_versions: indicates which, if any, WPA versions are enabled
766 * (from enum nl80211_wpa_versions)
767 * @cipher_group: group key cipher suite (or 0 if unset)
768 * @n_ciphers_pairwise: number of AP supported unicast ciphers
769 * @ciphers_pairwise: unicast key cipher suites
770 * @n_akm_suites: number of AKM suites
771 * @akm_suites: AKM suites
772 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
773 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
774 * required to assume that the port is unauthorized until authorized by
775 * user space. Otherwise, port is marked authorized by default.
776 * @control_port_ethertype: the control port protocol that should be
777 * allowed through even on unauthorized ports
778 * @control_port_no_encrypt: TRUE to prevent encryption of control port
781 struct cfg80211_crypto_settings {
784 int n_ciphers_pairwise;
785 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
787 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
789 __be16 control_port_ethertype;
790 bool control_port_no_encrypt;
794 * struct cfg80211_auth_request - Authentication request data
796 * This structure provides information needed to complete IEEE 802.11
799 * @bss: The BSS to authenticate with.
800 * @auth_type: Authentication type (algorithm)
801 * @ie: Extra IEs to add to Authentication frame or %NULL
802 * @ie_len: Length of ie buffer in octets
803 * @key_len: length of WEP key for shared key authentication
804 * @key_idx: index of WEP key for shared key authentication
805 * @key: WEP key for shared key authentication
806 * @local_state_change: This is a request for a local state only, i.e., no
807 * Authentication frame is to be transmitted and authentication state is
808 * to be changed without having to wait for a response from the peer STA
811 struct cfg80211_auth_request {
812 struct cfg80211_bss *bss;
815 enum nl80211_auth_type auth_type;
818 bool local_state_change;
822 * struct cfg80211_assoc_request - (Re)Association request data
824 * This structure provides information needed to complete IEEE 802.11
826 * @bss: The BSS to associate with.
827 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
828 * @ie_len: Length of ie buffer in octets
829 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
830 * @crypto: crypto settings
831 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
833 struct cfg80211_assoc_request {
834 struct cfg80211_bss *bss;
835 const u8 *ie, *prev_bssid;
837 struct cfg80211_crypto_settings crypto;
842 * struct cfg80211_deauth_request - Deauthentication request data
844 * This structure provides information needed to complete IEEE 802.11
847 * @bss: the BSS to deauthenticate from
848 * @ie: Extra IEs to add to Deauthentication frame or %NULL
849 * @ie_len: Length of ie buffer in octets
850 * @reason_code: The reason code for the deauthentication
851 * @local_state_change: This is a request for a local state only, i.e., no
852 * Deauthentication frame is to be transmitted.
854 struct cfg80211_deauth_request {
855 struct cfg80211_bss *bss;
859 bool local_state_change;
863 * struct cfg80211_disassoc_request - Disassociation request data
865 * This structure provides information needed to complete IEEE 802.11
868 * @bss: the BSS to disassociate from
869 * @ie: Extra IEs to add to Disassociation frame or %NULL
870 * @ie_len: Length of ie buffer in octets
871 * @reason_code: The reason code for the disassociation
872 * @local_state_change: This is a request for a local state only, i.e., no
873 * Disassociation frame is to be transmitted.
875 struct cfg80211_disassoc_request {
876 struct cfg80211_bss *bss;
880 bool local_state_change;
884 * struct cfg80211_ibss_params - IBSS parameters
886 * This structure defines the IBSS parameters for the join_ibss()
889 * @ssid: The SSID, will always be non-null.
890 * @ssid_len: The length of the SSID, will always be non-zero.
891 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
892 * search for IBSSs with a different BSSID.
893 * @channel: The channel to use if no IBSS can be found to join.
894 * @channel_fixed: The channel should be fixed -- do not search for
895 * IBSSs to join on other channels.
896 * @ie: information element(s) to include in the beacon
897 * @ie_len: length of that
898 * @beacon_interval: beacon interval to use
899 * @privacy: this is a protected network, keys will be configured
901 * @basic_rates: bitmap of basic rates to use when creating the IBSS
903 struct cfg80211_ibss_params {
906 struct ieee80211_channel *channel;
916 * struct cfg80211_connect_params - Connection parameters
918 * This structure provides information needed to complete IEEE 802.11
919 * authentication and association.
921 * @channel: The channel to use or %NULL if not specified (auto-select based
923 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
926 * @ssid_len: Length of ssid in octets
927 * @auth_type: Authentication type (algorithm)
928 * @ie: IEs for association request
929 * @ie_len: Length of assoc_ie in octets
930 * @privacy: indicates whether privacy-enabled APs should be used
931 * @crypto: crypto settings
932 * @key_len: length of WEP key for shared key authentication
933 * @key_idx: index of WEP key for shared key authentication
934 * @key: WEP key for shared key authentication
936 struct cfg80211_connect_params {
937 struct ieee80211_channel *channel;
941 enum nl80211_auth_type auth_type;
945 struct cfg80211_crypto_settings crypto;
951 * enum wiphy_params_flags - set_wiphy_params bitfield values
952 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
953 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
954 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
955 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
956 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
958 enum wiphy_params_flags {
959 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
960 WIPHY_PARAM_RETRY_LONG = 1 << 1,
961 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
962 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
963 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
967 * cfg80211_bitrate_mask - masks for bitrate control
969 struct cfg80211_bitrate_mask {
972 /* TODO: add support for masking MCS rates; e.g.: */
973 /* u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; */
974 } control[IEEE80211_NUM_BANDS];
977 * struct cfg80211_pmksa - PMK Security Association
979 * This structure is passed to the set/del_pmksa() method for PMKSA
982 * @bssid: The AP's BSSID.
983 * @pmkid: The PMK material itself.
985 struct cfg80211_pmksa {
991 * struct cfg80211_ops - backend description for wireless configuration
993 * This struct is registered by fullmac card drivers and/or wireless stacks
994 * in order to handle configuration requests on their interfaces.
996 * All callbacks except where otherwise noted should return 0
997 * on success or a negative error code.
999 * All operations are currently invoked under rtnl for consistency with the
1000 * wireless extensions but this is subject to reevaluation as soon as this
1001 * code is used more widely and we have a first user without wext.
1003 * @suspend: wiphy device needs to be suspended
1004 * @resume: wiphy device needs to be resumed
1006 * @add_virtual_intf: create a new virtual interface with the given name,
1007 * must set the struct wireless_dev's iftype. Beware: You must create
1008 * the new netdev in the wiphy's network namespace!
1010 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1012 * @change_virtual_intf: change type/configuration of virtual interface,
1013 * keep the struct wireless_dev's iftype updated.
1015 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1016 * when adding a group key.
1018 * @get_key: get information about the key with the given parameters.
1019 * @mac_addr will be %NULL when requesting information for a group
1020 * key. All pointers given to the @callback function need not be valid
1021 * after it returns. This function should return an error if it is
1022 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1024 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1025 * and @key_index, return -ENOENT if the key doesn't exist.
1027 * @set_default_key: set the default key on an interface
1029 * @set_default_mgmt_key: set the default management frame key on an interface
1031 * @add_beacon: Add a beacon with given parameters, @head, @interval
1032 * and @dtim_period will be valid, @tail is optional.
1033 * @set_beacon: Change the beacon parameters for an access point mode
1034 * interface. This should reject the call when no beacon has been
1036 * @del_beacon: Remove beacon configuration and stop sending the beacon.
1038 * @add_station: Add a new station.
1039 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1040 * @change_station: Modify a given station.
1041 * @get_station: get station information for the station identified by @mac
1042 * @dump_station: dump station callback -- resume dump at index @idx
1044 * @add_mpath: add a fixed mesh path
1045 * @del_mpath: delete a given mesh path
1046 * @change_mpath: change a given mesh path
1047 * @get_mpath: get a mesh path for the given parameters
1048 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1050 * @get_mesh_params: Put the current mesh parameters into *params
1052 * @set_mesh_params: Set mesh parameters.
1053 * The mask is a bitfield which tells us which parameters to
1054 * set, and which to leave alone.
1056 * @change_bss: Modify parameters for a given BSS.
1058 * @set_txq_params: Set TX queue parameters
1060 * @set_channel: Set channel for a given wireless interface. Some devices
1061 * may support multi-channel operation (by channel hopping) so cfg80211
1062 * doesn't verify much. Note, however, that the passed netdev may be
1063 * %NULL as well if the user requested changing the channel for the
1064 * device itself, or for a monitor interface.
1066 * @scan: Request to do a scan. If returning zero, the scan request is given
1067 * the driver, and will be valid until passed to cfg80211_scan_done().
1068 * For scan results, call cfg80211_inform_bss(); you can call this outside
1069 * the scan/scan_done bracket too.
1071 * @auth: Request to authenticate with the specified peer
1072 * @assoc: Request to (re)associate with the specified peer
1073 * @deauth: Request to deauthenticate from the specified peer
1074 * @disassoc: Request to disassociate from the specified peer
1076 * @connect: Connect to the ESS with the specified parameters. When connected,
1077 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1078 * If the connection fails for some reason, call cfg80211_connect_result()
1079 * with the status from the AP.
1080 * @disconnect: Disconnect from the BSS/ESS.
1082 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1083 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1085 * @leave_ibss: Leave the IBSS.
1087 * @set_wiphy_params: Notify that wiphy parameters have changed;
1088 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1089 * have changed. The actual parameter values are available in
1090 * struct wiphy. If returning an error, no value should be changed.
1092 * @set_tx_power: set the transmit power according to the parameters
1093 * @get_tx_power: store the current TX power into the dbm variable;
1094 * return 0 if successful
1096 * @set_wds_peer: set the WDS peer for a WDS interface
1098 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1099 * functions to adjust rfkill hw state
1101 * @dump_survey: get site survey information.
1103 * @remain_on_channel: Request the driver to remain awake on the specified
1104 * channel for the specified duration to complete an off-channel
1105 * operation (e.g., public action frame exchange). When the driver is
1106 * ready on the requested channel, it must indicate this with an event
1107 * notification by calling cfg80211_ready_on_channel().
1108 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1109 * This allows the operation to be terminated prior to timeout based on
1110 * the duration value.
1111 * @mgmt_tx: Transmit a management frame
1113 * @testmode_cmd: run a test mode command
1115 * @set_bitrate_mask: set the bitrate mask configuration
1117 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1118 * devices running firmwares capable of generating the (re) association
1119 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1120 * @del_pmksa: Delete a cached PMKID.
1121 * @flush_pmksa: Flush all cached PMKIDs.
1122 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1123 * allows the driver to adjust the dynamic ps timeout value.
1124 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1127 struct cfg80211_ops {
1128 int (*suspend)(struct wiphy *wiphy);
1129 int (*resume)(struct wiphy *wiphy);
1131 int (*add_virtual_intf)(struct wiphy *wiphy, char *name,
1132 enum nl80211_iftype type, u32 *flags,
1133 struct vif_params *params);
1134 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
1135 int (*change_virtual_intf)(struct wiphy *wiphy,
1136 struct net_device *dev,
1137 enum nl80211_iftype type, u32 *flags,
1138 struct vif_params *params);
1140 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1141 u8 key_index, bool pairwise, const u8 *mac_addr,
1142 struct key_params *params);
1143 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1144 u8 key_index, bool pairwise, const u8 *mac_addr,
1146 void (*callback)(void *cookie, struct key_params*));
1147 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1148 u8 key_index, bool pairwise, const u8 *mac_addr);
1149 int (*set_default_key)(struct wiphy *wiphy,
1150 struct net_device *netdev,
1152 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1153 struct net_device *netdev,
1156 int (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
1157 struct beacon_parameters *info);
1158 int (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
1159 struct beacon_parameters *info);
1160 int (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
1163 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1164 u8 *mac, struct station_parameters *params);
1165 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1167 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1168 u8 *mac, struct station_parameters *params);
1169 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1170 u8 *mac, struct station_info *sinfo);
1171 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1172 int idx, u8 *mac, struct station_info *sinfo);
1174 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1175 u8 *dst, u8 *next_hop);
1176 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1178 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1179 u8 *dst, u8 *next_hop);
1180 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1181 u8 *dst, u8 *next_hop,
1182 struct mpath_info *pinfo);
1183 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1184 int idx, u8 *dst, u8 *next_hop,
1185 struct mpath_info *pinfo);
1186 int (*get_mesh_params)(struct wiphy *wiphy,
1187 struct net_device *dev,
1188 struct mesh_config *conf);
1189 int (*set_mesh_params)(struct wiphy *wiphy,
1190 struct net_device *dev,
1191 const struct mesh_config *nconf, u32 mask);
1192 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1193 struct bss_parameters *params);
1195 int (*set_txq_params)(struct wiphy *wiphy,
1196 struct ieee80211_txq_params *params);
1198 int (*set_channel)(struct wiphy *wiphy, struct net_device *dev,
1199 struct ieee80211_channel *chan,
1200 enum nl80211_channel_type channel_type);
1202 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
1203 struct cfg80211_scan_request *request);
1205 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1206 struct cfg80211_auth_request *req);
1207 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1208 struct cfg80211_assoc_request *req);
1209 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1210 struct cfg80211_deauth_request *req,
1212 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1213 struct cfg80211_disassoc_request *req,
1216 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1217 struct cfg80211_connect_params *sme);
1218 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1221 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1222 struct cfg80211_ibss_params *params);
1223 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1225 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1227 int (*set_tx_power)(struct wiphy *wiphy,
1228 enum nl80211_tx_power_setting type, int mbm);
1229 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1231 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1234 void (*rfkill_poll)(struct wiphy *wiphy);
1236 #ifdef CONFIG_NL80211_TESTMODE
1237 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1240 int (*set_bitrate_mask)(struct wiphy *wiphy,
1241 struct net_device *dev,
1243 const struct cfg80211_bitrate_mask *mask);
1245 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1246 int idx, struct survey_info *info);
1248 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1249 struct cfg80211_pmksa *pmksa);
1250 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1251 struct cfg80211_pmksa *pmksa);
1252 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1254 int (*remain_on_channel)(struct wiphy *wiphy,
1255 struct net_device *dev,
1256 struct ieee80211_channel *chan,
1257 enum nl80211_channel_type channel_type,
1258 unsigned int duration,
1260 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1261 struct net_device *dev,
1264 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
1265 struct ieee80211_channel *chan,
1266 enum nl80211_channel_type channel_type,
1267 bool channel_type_valid,
1268 const u8 *buf, size_t len, u64 *cookie);
1270 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1271 bool enabled, int timeout);
1273 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1274 struct net_device *dev,
1275 s32 rssi_thold, u32 rssi_hyst);
1279 * wireless hardware and networking interfaces structures
1280 * and registration/helper functions
1284 * enum wiphy_flags - wiphy capability flags
1286 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1287 * has its own custom regulatory domain and cannot identify the
1288 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1289 * we will disregard the first regulatory hint (when the
1290 * initiator is %REGDOM_SET_BY_CORE).
1291 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1292 * ignore regulatory domain settings until it gets its own regulatory
1293 * domain via its regulatory_hint(). After its gets its own regulatory
1294 * domain it will only allow further regulatory domain settings to
1295 * further enhance compliance. For example if channel 13 and 14 are
1296 * disabled by this regulatory domain no user regulatory domain can
1297 * enable these channels at a later time. This can be used for devices
1298 * which do not have calibration information gauranteed for frequencies
1299 * or settings outside of its regulatory domain.
1300 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1301 * that passive scan flags and beaconing flags may not be lifted by
1302 * cfg80211 due to regulatory beacon hints. For more information on beacon
1303 * hints read the documenation for regulatory_hint_found_beacon()
1304 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1306 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1307 * by default -- this flag will be set depending on the kernel's default
1308 * on wiphy_new(), but can be changed by the driver if it has a good
1309 * reason to override the default
1310 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1311 * on a VLAN interface)
1312 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1313 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1314 * control port protocol ethertype. The device also honours the
1315 * control_port_no_encrypt flag.
1316 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1319 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1320 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1321 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1322 WIPHY_FLAG_NETNS_OK = BIT(3),
1323 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1324 WIPHY_FLAG_4ADDR_AP = BIT(5),
1325 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1326 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
1327 WIPHY_FLAG_IBSS_RSN = BIT(7),
1330 struct mac_address {
1334 struct ieee80211_txrx_stypes {
1339 * struct wiphy - wireless hardware description
1340 * @reg_notifier: the driver's regulatory notification callback
1341 * @regd: the driver's regulatory domain, if one was requested via
1342 * the regulatory_hint() API. This can be used by the driver
1343 * on the reg_notifier() if it chooses to ignore future
1344 * regulatory domain changes caused by other drivers.
1345 * @signal_type: signal type reported in &struct cfg80211_bss.
1346 * @cipher_suites: supported cipher suites
1347 * @n_cipher_suites: number of supported cipher suites
1348 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1349 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1350 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1351 * -1 = fragmentation disabled, only odd values >= 256 used
1352 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1353 * @_net: the network namespace this wiphy currently lives in
1354 * @perm_addr: permanent MAC address of this device
1355 * @addr_mask: If the device supports multiple MAC addresses by masking,
1356 * set this to a mask with variable bits set to 1, e.g. if the last
1357 * four bits are variable then set it to 00:...:00:0f. The actual
1358 * variable bits shall be determined by the interfaces added, with
1359 * interfaces not matching the mask being rejected to be brought up.
1360 * @n_addresses: number of addresses in @addresses.
1361 * @addresses: If the device has more than one address, set this pointer
1362 * to a list of addresses (6 bytes each). The first one will be used
1363 * by default for perm_addr. In this case, the mask should be set to
1364 * all-zeroes. In this case it is assumed that the device can handle
1365 * the same number of arbitrary MAC addresses.
1366 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
1367 * automatically on wiphy renames
1368 * @dev: (virtual) struct device for this wiphy
1369 * @wext: wireless extension handlers
1370 * @priv: driver private data (sized according to wiphy_new() parameter)
1371 * @interface_modes: bitmask of interfaces types valid for this wiphy,
1372 * must be set by driver
1373 * @flags: wiphy flags, see &enum wiphy_flags
1374 * @bss_priv_size: each BSS struct has private data allocated with it,
1375 * this variable determines its size
1376 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
1378 * @max_scan_ie_len: maximum length of user-controlled IEs device can
1379 * add to probe request frames transmitted during a scan, must not
1380 * include fixed IEs like supported rates
1381 * @coverage_class: current coverage class
1382 * @fw_version: firmware version for ethtool reporting
1383 * @hw_version: hardware version for ethtool reporting
1384 * @max_num_pmkids: maximum number of PMKIDs supported by device
1385 * @privid: a pointer that drivers can use to identify if an arbitrary
1386 * wiphy is theirs, e.g. in global notifiers
1387 * @bands: information about bands/channels supported by this device
1389 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
1390 * transmitted through nl80211, points to an array indexed by interface
1394 /* assign these fields before you register the wiphy */
1396 /* permanent MAC address(es) */
1397 u8 perm_addr[ETH_ALEN];
1398 u8 addr_mask[ETH_ALEN];
1400 struct mac_address *addresses;
1402 const struct ieee80211_txrx_stypes *mgmt_stypes;
1406 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1407 u16 interface_modes;
1411 enum cfg80211_signal_type signal_type;
1415 u16 max_scan_ie_len;
1417 int n_cipher_suites;
1418 const u32 *cipher_suites;
1426 char fw_version[ETHTOOL_BUSINFO_LEN];
1431 /* If multiple wiphys are registered and you're handed e.g.
1432 * a regular netdev with assigned ieee80211_ptr, you won't
1433 * know whether it points to a wiphy your driver has registered
1434 * or not. Assign this to something global to your driver to
1435 * help determine whether you own this wiphy or not. */
1438 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
1440 /* Lets us get back the wiphy on the callback */
1441 int (*reg_notifier)(struct wiphy *wiphy,
1442 struct regulatory_request *request);
1444 /* fields below are read-only, assigned by cfg80211 */
1446 const struct ieee80211_regdomain *regd;
1448 /* the item in /sys/class/ieee80211/ points to this,
1449 * you need use set_wiphy_dev() (see below) */
1452 /* dir in debugfs: ieee80211/<wiphyname> */
1453 struct dentry *debugfsdir;
1455 #ifdef CONFIG_NET_NS
1456 /* the network namespace this phy lives in currently */
1460 #ifdef CONFIG_CFG80211_WEXT
1461 const struct iw_handler_def *wext;
1464 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1467 static inline struct net *wiphy_net(struct wiphy *wiphy)
1469 return read_pnet(&wiphy->_net);
1472 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
1474 write_pnet(&wiphy->_net, net);
1478 * wiphy_priv - return priv from wiphy
1480 * @wiphy: the wiphy whose priv pointer to return
1482 static inline void *wiphy_priv(struct wiphy *wiphy)
1485 return &wiphy->priv;
1489 * priv_to_wiphy - return the wiphy containing the priv
1491 * @priv: a pointer previously returned by wiphy_priv
1493 static inline struct wiphy *priv_to_wiphy(void *priv)
1496 return container_of(priv, struct wiphy, priv);
1500 * set_wiphy_dev - set device pointer for wiphy
1502 * @wiphy: The wiphy whose device to bind
1503 * @dev: The device to parent it to
1505 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1507 wiphy->dev.parent = dev;
1511 * wiphy_dev - get wiphy dev pointer
1513 * @wiphy: The wiphy whose device struct to look up
1515 static inline struct device *wiphy_dev(struct wiphy *wiphy)
1517 return wiphy->dev.parent;
1521 * wiphy_name - get wiphy name
1523 * @wiphy: The wiphy whose name to return
1525 static inline const char *wiphy_name(const struct wiphy *wiphy)
1527 return dev_name(&wiphy->dev);
1531 * wiphy_new - create a new wiphy for use with cfg80211
1533 * @ops: The configuration operations for this device
1534 * @sizeof_priv: The size of the private area to allocate
1536 * Create a new wiphy and associate the given operations with it.
1537 * @sizeof_priv bytes are allocated for private use.
1539 * The returned pointer must be assigned to each netdev's
1540 * ieee80211_ptr for proper operation.
1542 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
1545 * wiphy_register - register a wiphy with cfg80211
1547 * @wiphy: The wiphy to register.
1549 * Returns a non-negative wiphy index or a negative error code.
1551 extern int wiphy_register(struct wiphy *wiphy);
1554 * wiphy_unregister - deregister a wiphy from cfg80211
1556 * @wiphy: The wiphy to unregister.
1558 * After this call, no more requests can be made with this priv
1559 * pointer, but the call may sleep to wait for an outstanding
1560 * request that is being handled.
1562 extern void wiphy_unregister(struct wiphy *wiphy);
1565 * wiphy_free - free wiphy
1567 * @wiphy: The wiphy to free
1569 extern void wiphy_free(struct wiphy *wiphy);
1571 /* internal structs */
1572 struct cfg80211_conn;
1573 struct cfg80211_internal_bss;
1574 struct cfg80211_cached_keys;
1576 #define MAX_AUTH_BSSES 4
1579 * struct wireless_dev - wireless per-netdev state
1581 * This structure must be allocated by the driver/stack
1582 * that uses the ieee80211_ptr field in struct net_device
1583 * (this is intentional so it can be allocated along with
1586 * @wiphy: pointer to hardware description
1587 * @iftype: interface type
1588 * @list: (private) Used to collect the interfaces
1589 * @netdev: (private) Used to reference back to the netdev
1590 * @current_bss: (private) Used by the internal configuration code
1591 * @channel: (private) Used by the internal configuration code to track
1592 * user-set AP, monitor and WDS channels for wireless extensions
1593 * @bssid: (private) Used by the internal configuration code
1594 * @ssid: (private) Used by the internal configuration code
1595 * @ssid_len: (private) Used by the internal configuration code
1596 * @wext: (private) Used by the internal wireless extensions compat code
1597 * @use_4addr: indicates 4addr mode is used on this interface, must be
1598 * set by driver (if supported) on add_interface BEFORE registering the
1599 * netdev and may otherwise be used by driver read-only, will be update
1600 * by cfg80211 on change_interface
1601 * @mgmt_registrations: list of registrations for management frames
1602 * @mgmt_registrations_lock: lock for the list
1603 * @mtx: mutex used to lock data in this struct
1604 * @cleanup_work: work struct used for cleanup that can't be done directly
1606 struct wireless_dev {
1607 struct wiphy *wiphy;
1608 enum nl80211_iftype iftype;
1610 /* the remainder of this struct should be private to cfg80211 */
1611 struct list_head list;
1612 struct net_device *netdev;
1614 struct list_head mgmt_registrations;
1615 spinlock_t mgmt_registrations_lock;
1619 struct work_struct cleanup_work;
1623 /* currently used for IBSS and SME - might be rearranged later */
1624 u8 ssid[IEEE80211_MAX_SSID_LEN];
1628 CFG80211_SME_CONNECTING,
1629 CFG80211_SME_CONNECTED,
1631 struct cfg80211_conn *conn;
1632 struct cfg80211_cached_keys *connect_keys;
1634 struct list_head event_list;
1635 spinlock_t event_lock;
1637 struct cfg80211_internal_bss *authtry_bsses[MAX_AUTH_BSSES];
1638 struct cfg80211_internal_bss *auth_bsses[MAX_AUTH_BSSES];
1639 struct cfg80211_internal_bss *current_bss; /* associated / joined */
1640 struct ieee80211_channel *channel;
1645 #ifdef CONFIG_CFG80211_WEXT
1648 struct cfg80211_ibss_params ibss;
1649 struct cfg80211_connect_params connect;
1650 struct cfg80211_cached_keys *keys;
1653 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
1654 u8 ssid[IEEE80211_MAX_SSID_LEN];
1655 s8 default_key, default_mgmt_key;
1656 bool prev_bssid_valid;
1662 * wdev_priv - return wiphy priv from wireless_dev
1664 * @wdev: The wireless device whose wiphy's priv pointer to return
1666 static inline void *wdev_priv(struct wireless_dev *wdev)
1669 return wiphy_priv(wdev->wiphy);
1673 * DOC: Utility functions
1675 * cfg80211 offers a number of utility functions that can be useful.
1679 * ieee80211_channel_to_frequency - convert channel number to frequency
1680 * @chan: channel number
1682 extern int ieee80211_channel_to_frequency(int chan);
1685 * ieee80211_frequency_to_channel - convert frequency to channel number
1686 * @freq: center frequency
1688 extern int ieee80211_frequency_to_channel(int freq);
1691 * Name indirection necessary because the ieee80211 code also has
1692 * a function named "ieee80211_get_channel", so if you include
1693 * cfg80211's header file you get cfg80211's version, if you try
1694 * to include both header files you'll (rightfully!) get a symbol
1697 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
1700 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
1701 * @wiphy: the struct wiphy to get the channel for
1702 * @freq: the center frequency of the channel
1704 static inline struct ieee80211_channel *
1705 ieee80211_get_channel(struct wiphy *wiphy, int freq)
1707 return __ieee80211_get_channel(wiphy, freq);
1711 * ieee80211_get_response_rate - get basic rate for a given rate
1713 * @sband: the band to look for rates in
1714 * @basic_rates: bitmap of basic rates
1715 * @bitrate: the bitrate for which to find the basic rate
1717 * This function returns the basic rate corresponding to a given
1718 * bitrate, that is the next lower bitrate contained in the basic
1719 * rate map, which is, for this function, given as a bitmap of
1720 * indices of rates in the band's bitrate table.
1722 struct ieee80211_rate *
1723 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
1724 u32 basic_rates, int bitrate);
1727 * Radiotap parsing functions -- for controlled injection support
1729 * Implemented in net/wireless/radiotap.c
1730 * Documentation in Documentation/networking/radiotap-headers.txt
1733 struct radiotap_align_size {
1734 uint8_t align:4, size:4;
1737 struct ieee80211_radiotap_namespace {
1738 const struct radiotap_align_size *align_size;
1744 struct ieee80211_radiotap_vendor_namespaces {
1745 const struct ieee80211_radiotap_namespace *ns;
1750 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
1751 * @this_arg_index: index of current arg, valid after each successful call
1752 * to ieee80211_radiotap_iterator_next()
1753 * @this_arg: pointer to current radiotap arg; it is valid after each
1754 * call to ieee80211_radiotap_iterator_next() but also after
1755 * ieee80211_radiotap_iterator_init() where it will point to
1756 * the beginning of the actual data portion
1757 * @this_arg_size: length of the current arg, for convenience
1758 * @current_namespace: pointer to the current namespace definition
1759 * (or internally %NULL if the current namespace is unknown)
1760 * @is_radiotap_ns: indicates whether the current namespace is the default
1761 * radiotap namespace or not
1763 * @_rtheader: pointer to the radiotap header we are walking through
1764 * @_max_length: length of radiotap header in cpu byte ordering
1765 * @_arg_index: next argument index
1766 * @_arg: next argument pointer
1767 * @_next_bitmap: internal pointer to next present u32
1768 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
1769 * @_vns: vendor namespace definitions
1770 * @_next_ns_data: beginning of the next namespace's data
1771 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
1774 * Describes the radiotap parser state. Fields prefixed with an underscore
1775 * must not be used by users of the parser, only by the parser internally.
1778 struct ieee80211_radiotap_iterator {
1779 struct ieee80211_radiotap_header *_rtheader;
1780 const struct ieee80211_radiotap_vendor_namespaces *_vns;
1781 const struct ieee80211_radiotap_namespace *current_namespace;
1783 unsigned char *_arg, *_next_ns_data;
1784 __le32 *_next_bitmap;
1786 unsigned char *this_arg;
1794 uint32_t _bitmap_shifter;
1798 extern int ieee80211_radiotap_iterator_init(
1799 struct ieee80211_radiotap_iterator *iterator,
1800 struct ieee80211_radiotap_header *radiotap_header,
1801 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
1803 extern int ieee80211_radiotap_iterator_next(
1804 struct ieee80211_radiotap_iterator *iterator);
1807 extern const unsigned char rfc1042_header[6];
1808 extern const unsigned char bridge_tunnel_header[6];
1811 * ieee80211_get_hdrlen_from_skb - get header length from data
1813 * Given an skb with a raw 802.11 header at the data pointer this function
1814 * returns the 802.11 header length in bytes (not including encryption
1815 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1816 * header the function returns 0.
1820 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1823 * ieee80211_hdrlen - get header length in bytes from frame control
1824 * @fc: frame control field in little-endian format
1826 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
1829 * DOC: Data path helpers
1831 * In addition to generic utilities, cfg80211 also offers
1832 * functions that help implement the data path for devices
1833 * that do not do the 802.11/802.3 conversion on the device.
1837 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
1838 * @skb: the 802.11 data frame
1839 * @addr: the device MAC address
1840 * @iftype: the virtual interface type
1842 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
1843 enum nl80211_iftype iftype);
1846 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
1847 * @skb: the 802.3 frame
1848 * @addr: the device MAC address
1849 * @iftype: the virtual interface type
1850 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
1851 * @qos: build 802.11 QoS data frame
1853 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
1854 enum nl80211_iftype iftype, u8 *bssid, bool qos);
1857 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
1859 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
1860 * 802.3 frames. The @list will be empty if the decode fails. The
1861 * @skb is consumed after the function returns.
1863 * @skb: The input IEEE 802.11n A-MSDU frame.
1864 * @list: The output list of 802.3 frames. It must be allocated and
1865 * initialized by by the caller.
1866 * @addr: The device MAC address.
1867 * @iftype: The device interface type.
1868 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
1870 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
1871 const u8 *addr, enum nl80211_iftype iftype,
1872 const unsigned int extra_headroom);
1875 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
1876 * @skb: the data frame
1878 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
1881 * cfg80211_find_ie - find information element in data
1884 * @ies: data consisting of IEs
1885 * @len: length of data
1887 * This function will return %NULL if the element ID could
1888 * not be found or if the element is invalid (claims to be
1889 * longer than the given data), or a pointer to the first byte
1890 * of the requested element, that is the byte containing the
1891 * element ID. There are no checks on the element length
1892 * other than having to fit into the given data.
1894 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
1897 * DOC: Regulatory enforcement infrastructure
1903 * regulatory_hint - driver hint to the wireless core a regulatory domain
1904 * @wiphy: the wireless device giving the hint (used only for reporting
1906 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
1907 * should be in. If @rd is set this should be NULL. Note that if you
1908 * set this to NULL you should still set rd->alpha2 to some accepted
1911 * Wireless drivers can use this function to hint to the wireless core
1912 * what it believes should be the current regulatory domain by
1913 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
1914 * domain should be in or by providing a completely build regulatory domain.
1915 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
1916 * for a regulatory domain structure for the respective country.
1918 * The wiphy must have been registered to cfg80211 prior to this call.
1919 * For cfg80211 drivers this means you must first use wiphy_register(),
1920 * for mac80211 drivers you must first use ieee80211_register_hw().
1922 * Drivers should check the return value, its possible you can get
1925 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
1928 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
1929 * @wiphy: the wireless device we want to process the regulatory domain on
1930 * @regd: the custom regulatory domain to use for this wiphy
1932 * Drivers can sometimes have custom regulatory domains which do not apply
1933 * to a specific country. Drivers can use this to apply such custom regulatory
1934 * domains. This routine must be called prior to wiphy registration. The
1935 * custom regulatory domain will be trusted completely and as such previous
1936 * default channel settings will be disregarded. If no rule is found for a
1937 * channel on the regulatory domain the channel will be disabled.
1939 extern void wiphy_apply_custom_regulatory(
1940 struct wiphy *wiphy,
1941 const struct ieee80211_regdomain *regd);
1944 * freq_reg_info - get regulatory information for the given frequency
1945 * @wiphy: the wiphy for which we want to process this rule for
1946 * @center_freq: Frequency in KHz for which we want regulatory information for
1947 * @desired_bw_khz: the desired max bandwidth you want to use per
1948 * channel. Note that this is still 20 MHz if you want to use HT40
1949 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
1950 * If set to 0 we'll assume you want the standard 20 MHz.
1951 * @reg_rule: the regulatory rule which we have for this frequency
1953 * Use this function to get the regulatory rule for a specific frequency on
1954 * a given wireless device. If the device has a specific regulatory domain
1955 * it wants to follow we respect that unless a country IE has been received
1956 * and processed already.
1958 * Returns 0 if it was able to find a valid regulatory rule which does
1959 * apply to the given center_freq otherwise it returns non-zero. It will
1960 * also return -ERANGE if we determine the given center_freq does not even have
1961 * a regulatory rule for a frequency range in the center_freq's band. See
1962 * freq_in_rule_band() for our current definition of a band -- this is purely
1963 * subjective and right now its 802.11 specific.
1965 extern int freq_reg_info(struct wiphy *wiphy,
1968 const struct ieee80211_reg_rule **reg_rule);
1971 * Temporary wext handlers & helper functions
1973 * In the future cfg80211 will simply assign the entire wext handler
1974 * structure to netdevs it manages, but we're not there yet.
1976 int cfg80211_wext_giwname(struct net_device *dev,
1977 struct iw_request_info *info,
1978 char *name, char *extra);
1979 int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
1980 u32 *mode, char *extra);
1981 int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
1982 u32 *mode, char *extra);
1983 int cfg80211_wext_siwscan(struct net_device *dev,
1984 struct iw_request_info *info,
1985 union iwreq_data *wrqu, char *extra);
1986 int cfg80211_wext_giwscan(struct net_device *dev,
1987 struct iw_request_info *info,
1988 struct iw_point *data, char *extra);
1989 int cfg80211_wext_siwmlme(struct net_device *dev,
1990 struct iw_request_info *info,
1991 struct iw_point *data, char *extra);
1992 int cfg80211_wext_giwrange(struct net_device *dev,
1993 struct iw_request_info *info,
1994 struct iw_point *data, char *extra);
1995 int cfg80211_wext_siwgenie(struct net_device *dev,
1996 struct iw_request_info *info,
1997 struct iw_point *data, char *extra);
1998 int cfg80211_wext_siwauth(struct net_device *dev,
1999 struct iw_request_info *info,
2000 struct iw_param *data, char *extra);
2001 int cfg80211_wext_giwauth(struct net_device *dev,
2002 struct iw_request_info *info,
2003 struct iw_param *data, char *extra);
2005 int cfg80211_wext_siwfreq(struct net_device *dev,
2006 struct iw_request_info *info,
2007 struct iw_freq *freq, char *extra);
2008 int cfg80211_wext_giwfreq(struct net_device *dev,
2009 struct iw_request_info *info,
2010 struct iw_freq *freq, char *extra);
2011 int cfg80211_wext_siwessid(struct net_device *dev,
2012 struct iw_request_info *info,
2013 struct iw_point *data, char *ssid);
2014 int cfg80211_wext_giwessid(struct net_device *dev,
2015 struct iw_request_info *info,
2016 struct iw_point *data, char *ssid);
2017 int cfg80211_wext_siwrate(struct net_device *dev,
2018 struct iw_request_info *info,
2019 struct iw_param *rate, char *extra);
2020 int cfg80211_wext_giwrate(struct net_device *dev,
2021 struct iw_request_info *info,
2022 struct iw_param *rate, char *extra);
2024 int cfg80211_wext_siwrts(struct net_device *dev,
2025 struct iw_request_info *info,
2026 struct iw_param *rts, char *extra);
2027 int cfg80211_wext_giwrts(struct net_device *dev,
2028 struct iw_request_info *info,
2029 struct iw_param *rts, char *extra);
2030 int cfg80211_wext_siwfrag(struct net_device *dev,
2031 struct iw_request_info *info,
2032 struct iw_param *frag, char *extra);
2033 int cfg80211_wext_giwfrag(struct net_device *dev,
2034 struct iw_request_info *info,
2035 struct iw_param *frag, char *extra);
2036 int cfg80211_wext_siwretry(struct net_device *dev,
2037 struct iw_request_info *info,
2038 struct iw_param *retry, char *extra);
2039 int cfg80211_wext_giwretry(struct net_device *dev,
2040 struct iw_request_info *info,
2041 struct iw_param *retry, char *extra);
2042 int cfg80211_wext_siwencodeext(struct net_device *dev,
2043 struct iw_request_info *info,
2044 struct iw_point *erq, char *extra);
2045 int cfg80211_wext_siwencode(struct net_device *dev,
2046 struct iw_request_info *info,
2047 struct iw_point *erq, char *keybuf);
2048 int cfg80211_wext_giwencode(struct net_device *dev,
2049 struct iw_request_info *info,
2050 struct iw_point *erq, char *keybuf);
2051 int cfg80211_wext_siwtxpower(struct net_device *dev,
2052 struct iw_request_info *info,
2053 union iwreq_data *data, char *keybuf);
2054 int cfg80211_wext_giwtxpower(struct net_device *dev,
2055 struct iw_request_info *info,
2056 union iwreq_data *data, char *keybuf);
2057 struct iw_statistics *cfg80211_wireless_stats(struct net_device *dev);
2059 int cfg80211_wext_siwpower(struct net_device *dev,
2060 struct iw_request_info *info,
2061 struct iw_param *wrq, char *extra);
2062 int cfg80211_wext_giwpower(struct net_device *dev,
2063 struct iw_request_info *info,
2064 struct iw_param *wrq, char *extra);
2066 int cfg80211_wext_siwap(struct net_device *dev,
2067 struct iw_request_info *info,
2068 struct sockaddr *ap_addr, char *extra);
2069 int cfg80211_wext_giwap(struct net_device *dev,
2070 struct iw_request_info *info,
2071 struct sockaddr *ap_addr, char *extra);
2073 int cfg80211_wext_siwpmksa(struct net_device *dev,
2074 struct iw_request_info *info,
2075 struct iw_point *data, char *extra);
2078 * callbacks for asynchronous cfg80211 methods, notification
2079 * functions and BSS handling helpers
2083 * cfg80211_scan_done - notify that scan finished
2085 * @request: the corresponding scan request
2086 * @aborted: set to true if the scan was aborted for any reason,
2087 * userspace will be notified of that
2089 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2092 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2094 * @wiphy: the wiphy reporting the BSS
2095 * @channel: The channel the frame was received on
2096 * @mgmt: the management frame (probe response or beacon)
2097 * @len: length of the management frame
2098 * @signal: the signal strength, type depends on the wiphy's signal_type
2099 * @gfp: context flags
2101 * This informs cfg80211 that BSS information was found and
2102 * the BSS should be updated/added.
2104 struct cfg80211_bss*
2105 cfg80211_inform_bss_frame(struct wiphy *wiphy,
2106 struct ieee80211_channel *channel,
2107 struct ieee80211_mgmt *mgmt, size_t len,
2108 s32 signal, gfp_t gfp);
2111 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2113 * @wiphy: the wiphy reporting the BSS
2114 * @channel: The channel the frame was received on
2115 * @bssid: the BSSID of the BSS
2116 * @timestamp: the TSF timestamp sent by the peer
2117 * @capability: the capability field sent by the peer
2118 * @beacon_interval: the beacon interval announced by the peer
2119 * @ie: additional IEs sent by the peer
2120 * @ielen: length of the additional IEs
2121 * @signal: the signal strength, type depends on the wiphy's signal_type
2122 * @gfp: context flags
2124 * This informs cfg80211 that BSS information was found and
2125 * the BSS should be updated/added.
2127 struct cfg80211_bss*
2128 cfg80211_inform_bss(struct wiphy *wiphy,
2129 struct ieee80211_channel *channel,
2131 u64 timestamp, u16 capability, u16 beacon_interval,
2132 const u8 *ie, size_t ielen,
2133 s32 signal, gfp_t gfp);
2135 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2136 struct ieee80211_channel *channel,
2138 const u8 *ssid, size_t ssid_len,
2139 u16 capa_mask, u16 capa_val);
2140 static inline struct cfg80211_bss *
2141 cfg80211_get_ibss(struct wiphy *wiphy,
2142 struct ieee80211_channel *channel,
2143 const u8 *ssid, size_t ssid_len)
2145 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2146 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2149 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2150 struct ieee80211_channel *channel,
2151 const u8 *meshid, size_t meshidlen,
2153 void cfg80211_put_bss(struct cfg80211_bss *bss);
2156 * cfg80211_unlink_bss - unlink BSS from internal data structures
2158 * @bss: the bss to remove
2160 * This function removes the given BSS from the internal data structures
2161 * thereby making it no longer show up in scan results etc. Use this
2162 * function when you detect a BSS is gone. Normally BSSes will also time
2163 * out, so it is not necessary to use this function at all.
2165 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
2168 * cfg80211_send_rx_auth - notification of processed authentication
2169 * @dev: network device
2170 * @buf: authentication frame (header + body)
2171 * @len: length of the frame data
2173 * This function is called whenever an authentication has been processed in
2174 * station mode. The driver is required to call either this function or
2175 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2176 * call. This function may sleep.
2178 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
2181 * cfg80211_send_auth_timeout - notification of timed out authentication
2182 * @dev: network device
2183 * @addr: The MAC address of the device with which the authentication timed out
2185 * This function may sleep.
2187 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
2190 * __cfg80211_auth_canceled - notify cfg80211 that authentication was canceled
2191 * @dev: network device
2192 * @addr: The MAC address of the device with which the authentication timed out
2194 * When a pending authentication had no action yet, the driver may decide
2195 * to not send a deauth frame, but in that case must calls this function
2196 * to tell cfg80211 about this decision. It is only valid to call this
2197 * function within the deauth() callback.
2199 void __cfg80211_auth_canceled(struct net_device *dev, const u8 *addr);
2202 * cfg80211_send_rx_assoc - notification of processed association
2203 * @dev: network device
2204 * @buf: (re)association response frame (header + body)
2205 * @len: length of the frame data
2207 * This function is called whenever a (re)association response has been
2208 * processed in station mode. The driver is required to call either this
2209 * function or cfg80211_send_assoc_timeout() to indicate the result of
2210 * cfg80211_ops::assoc() call. This function may sleep.
2212 void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
2215 * cfg80211_send_assoc_timeout - notification of timed out association
2216 * @dev: network device
2217 * @addr: The MAC address of the device with which the association timed out
2219 * This function may sleep.
2221 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
2224 * cfg80211_send_deauth - notification of processed deauthentication
2225 * @dev: network device
2226 * @buf: deauthentication frame (header + body)
2227 * @len: length of the frame data
2229 * This function is called whenever deauthentication has been processed in
2230 * station mode. This includes both received deauthentication frames and
2231 * locally generated ones. This function may sleep.
2233 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2236 * __cfg80211_send_deauth - notification of processed deauthentication
2237 * @dev: network device
2238 * @buf: deauthentication frame (header + body)
2239 * @len: length of the frame data
2241 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2243 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2246 * cfg80211_send_disassoc - notification of processed disassociation
2247 * @dev: network device
2248 * @buf: disassociation response frame (header + body)
2249 * @len: length of the frame data
2251 * This function is called whenever disassociation has been processed in
2252 * station mode. This includes both received disassociation frames and locally
2253 * generated ones. This function may sleep.
2255 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
2258 * __cfg80211_send_disassoc - notification of processed disassociation
2259 * @dev: network device
2260 * @buf: disassociation response frame (header + body)
2261 * @len: length of the frame data
2263 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2265 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
2269 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
2270 * @dev: network device
2271 * @addr: The source MAC address of the frame
2272 * @key_type: The key type that the received frame used
2273 * @key_id: Key identifier (0..3)
2274 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
2275 * @gfp: allocation flags
2277 * This function is called whenever the local MAC detects a MIC failure in a
2278 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
2281 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
2282 enum nl80211_key_type key_type, int key_id,
2283 const u8 *tsc, gfp_t gfp);
2286 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
2288 * @dev: network device
2289 * @bssid: the BSSID of the IBSS joined
2290 * @gfp: allocation flags
2292 * This function notifies cfg80211 that the device joined an IBSS or
2293 * switched to a different BSSID. Before this function can be called,
2294 * either a beacon has to have been received from the IBSS, or one of
2295 * the cfg80211_inform_bss{,_frame} functions must have been called
2296 * with the locally generated beacon -- this guarantees that there is
2297 * always a scan result for this IBSS. cfg80211 will handle the rest.
2299 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
2302 * DOC: RFkill integration
2304 * RFkill integration in cfg80211 is almost invisible to drivers,
2305 * as cfg80211 automatically registers an rfkill instance for each
2306 * wireless device it knows about. Soft kill is also translated
2307 * into disconnecting and turning all interfaces off, drivers are
2308 * expected to turn off the device when all interfaces are down.
2310 * However, devices may have a hard RFkill line, in which case they
2311 * also need to interact with the rfkill subsystem, via cfg80211.
2312 * They can do this with a few helper functions documented here.
2316 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
2318 * @blocked: block status
2320 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
2323 * wiphy_rfkill_start_polling - start polling rfkill
2326 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
2329 * wiphy_rfkill_stop_polling - stop polling rfkill
2332 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
2334 #ifdef CONFIG_NL80211_TESTMODE
2338 * Test mode is a set of utility functions to allow drivers to
2339 * interact with driver-specific tools to aid, for instance,
2340 * factory programming.
2342 * This chapter describes how drivers interact with it, for more
2343 * information see the nl80211 book's chapter on it.
2347 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
2349 * @approxlen: an upper bound of the length of the data that will
2350 * be put into the skb
2352 * This function allocates and pre-fills an skb for a reply to
2353 * the testmode command. Since it is intended for a reply, calling
2354 * it outside of the @testmode_cmd operation is invalid.
2356 * The returned skb (or %NULL if any errors happen) is pre-filled
2357 * with the wiphy index and set up in a way that any data that is
2358 * put into the skb (with skb_put(), nla_put() or similar) will end
2359 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
2360 * needs to be done with the skb is adding data for the corresponding
2361 * userspace tool which can then read that data out of the testdata
2362 * attribute. You must not modify the skb in any other way.
2364 * When done, call cfg80211_testmode_reply() with the skb and return
2365 * its error code as the result of the @testmode_cmd operation.
2367 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
2371 * cfg80211_testmode_reply - send the reply skb
2372 * @skb: The skb, must have been allocated with
2373 * cfg80211_testmode_alloc_reply_skb()
2375 * Returns an error code or 0 on success, since calling this
2376 * function will usually be the last thing before returning
2377 * from the @testmode_cmd you should return the error code.
2378 * Note that this function consumes the skb regardless of the
2381 int cfg80211_testmode_reply(struct sk_buff *skb);
2384 * cfg80211_testmode_alloc_event_skb - allocate testmode event
2386 * @approxlen: an upper bound of the length of the data that will
2387 * be put into the skb
2388 * @gfp: allocation flags
2390 * This function allocates and pre-fills an skb for an event on the
2391 * testmode multicast group.
2393 * The returned skb (or %NULL if any errors happen) is set up in the
2394 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
2395 * for an event. As there, you should simply add data to it that will
2396 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
2397 * not modify the skb in any other way.
2399 * When done filling the skb, call cfg80211_testmode_event() with the
2400 * skb to send the event.
2402 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
2403 int approxlen, gfp_t gfp);
2406 * cfg80211_testmode_event - send the event
2407 * @skb: The skb, must have been allocated with
2408 * cfg80211_testmode_alloc_event_skb()
2409 * @gfp: allocation flags
2411 * This function sends the given @skb, which must have been allocated
2412 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
2415 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
2417 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
2419 #define CFG80211_TESTMODE_CMD(cmd)
2423 * cfg80211_connect_result - notify cfg80211 of connection result
2425 * @dev: network device
2426 * @bssid: the BSSID of the AP
2427 * @req_ie: association request IEs (maybe be %NULL)
2428 * @req_ie_len: association request IEs length
2429 * @resp_ie: association response IEs (may be %NULL)
2430 * @resp_ie_len: assoc response IEs length
2431 * @status: status code, 0 for successful connection, use
2432 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
2433 * the real status code for failures.
2434 * @gfp: allocation flags
2436 * It should be called by the underlying driver whenever connect() has
2439 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
2440 const u8 *req_ie, size_t req_ie_len,
2441 const u8 *resp_ie, size_t resp_ie_len,
2442 u16 status, gfp_t gfp);
2445 * cfg80211_roamed - notify cfg80211 of roaming
2447 * @dev: network device
2448 * @bssid: the BSSID of the new AP
2449 * @req_ie: association request IEs (maybe be %NULL)
2450 * @req_ie_len: association request IEs length
2451 * @resp_ie: association response IEs (may be %NULL)
2452 * @resp_ie_len: assoc response IEs length
2453 * @gfp: allocation flags
2455 * It should be called by the underlying driver whenever it roamed
2456 * from one AP to another while connected.
2458 void cfg80211_roamed(struct net_device *dev, const u8 *bssid,
2459 const u8 *req_ie, size_t req_ie_len,
2460 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
2463 * cfg80211_disconnected - notify cfg80211 that connection was dropped
2465 * @dev: network device
2466 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
2467 * @ie_len: length of IEs
2468 * @reason: reason code for the disconnection, set it to 0 if unknown
2469 * @gfp: allocation flags
2471 * After it calls this function, the driver should enter an idle state
2472 * and not try to connect to any AP any more.
2474 void cfg80211_disconnected(struct net_device *dev, u16 reason,
2475 u8 *ie, size_t ie_len, gfp_t gfp);
2478 * cfg80211_ready_on_channel - notification of remain_on_channel start
2479 * @dev: network device
2480 * @cookie: the request cookie
2481 * @chan: The current channel (from remain_on_channel request)
2482 * @channel_type: Channel type
2483 * @duration: Duration in milliseconds that the driver intents to remain on the
2485 * @gfp: allocation flags
2487 void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
2488 struct ieee80211_channel *chan,
2489 enum nl80211_channel_type channel_type,
2490 unsigned int duration, gfp_t gfp);
2493 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
2494 * @dev: network device
2495 * @cookie: the request cookie
2496 * @chan: The current channel (from remain_on_channel request)
2497 * @channel_type: Channel type
2498 * @gfp: allocation flags
2500 void cfg80211_remain_on_channel_expired(struct net_device *dev,
2502 struct ieee80211_channel *chan,
2503 enum nl80211_channel_type channel_type,
2508 * cfg80211_new_sta - notify userspace about station
2511 * @mac_addr: the station's address
2512 * @sinfo: the station information
2513 * @gfp: allocation flags
2515 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
2516 struct station_info *sinfo, gfp_t gfp);
2519 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
2520 * @dev: network device
2521 * @freq: Frequency on which the frame was received in MHz
2522 * @buf: Management frame (header + body)
2523 * @len: length of the frame data
2524 * @gfp: context flags
2526 * Returns %true if a user space application has registered for this frame.
2527 * For action frames, that makes it responsible for rejecting unrecognized
2528 * action frames; %false otherwise, in which case for action frames the
2529 * driver is responsible for rejecting the frame.
2531 * This function is called whenever an Action frame is received for a station
2532 * mode interface, but is not processed in kernel.
2534 bool cfg80211_rx_mgmt(struct net_device *dev, int freq, const u8 *buf,
2535 size_t len, gfp_t gfp);
2538 * cfg80211_mgmt_tx_status - notification of TX status for management frame
2539 * @dev: network device
2540 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
2541 * @buf: Management frame (header + body)
2542 * @len: length of the frame data
2543 * @ack: Whether frame was acknowledged
2544 * @gfp: context flags
2546 * This function is called whenever a management frame was requested to be
2547 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
2548 * transmission attempt.
2550 void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
2551 const u8 *buf, size_t len, bool ack, gfp_t gfp);
2555 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
2556 * @dev: network device
2557 * @rssi_event: the triggered RSSI event
2558 * @gfp: context flags
2560 * This function is called when a configured connection quality monitoring
2561 * rssi threshold reached event occurs.
2563 void cfg80211_cqm_rssi_notify(struct net_device *dev,
2564 enum nl80211_cqm_rssi_threshold_event rssi_event,
2567 /* Logging, debugging and troubleshooting/diagnostic helpers. */
2569 /* wiphy_printk helpers, similar to dev_printk */
2571 #define wiphy_printk(level, wiphy, format, args...) \
2572 dev_printk(level, &(wiphy)->dev, format, ##args)
2573 #define wiphy_emerg(wiphy, format, args...) \
2574 dev_emerg(&(wiphy)->dev, format, ##args)
2575 #define wiphy_alert(wiphy, format, args...) \
2576 dev_alert(&(wiphy)->dev, format, ##args)
2577 #define wiphy_crit(wiphy, format, args...) \
2578 dev_crit(&(wiphy)->dev, format, ##args)
2579 #define wiphy_err(wiphy, format, args...) \
2580 dev_err(&(wiphy)->dev, format, ##args)
2581 #define wiphy_warn(wiphy, format, args...) \
2582 dev_warn(&(wiphy)->dev, format, ##args)
2583 #define wiphy_notice(wiphy, format, args...) \
2584 dev_notice(&(wiphy)->dev, format, ##args)
2585 #define wiphy_info(wiphy, format, args...) \
2586 dev_info(&(wiphy)->dev, format, ##args)
2588 #define wiphy_debug(wiphy, format, args...) \
2589 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
2591 #define wiphy_dbg(wiphy, format, args...) \
2592 dev_dbg(&(wiphy)->dev, format, ##args)
2594 #if defined(VERBOSE_DEBUG)
2595 #define wiphy_vdbg wiphy_dbg
2597 #define wiphy_vdbg(wiphy, format, args...) \
2600 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
2606 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
2607 * of using a WARN/WARN_ON to get the message out, including the
2608 * file/line information and a backtrace.
2610 #define wiphy_WARN(wiphy, format, args...) \
2611 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
2613 #endif /* __NET_CFG80211_H */