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>
26 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
27 * userspace and drivers, and offers some utility functionality associated
28 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
29 * by all modern wireless drivers in Linux, so that they offer a consistent
30 * API through nl80211. For backward compatibility, cfg80211 also offers
31 * wireless extensions to userspace, but hides them from drivers completely.
33 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
39 * DOC: Device registration
41 * In order for a driver to use cfg80211, it must register the hardware device
42 * with cfg80211. This happens through a number of hardware capability structs
45 * The fundamental structure for each device is the 'wiphy', of which each
46 * instance describes a physical wireless device connected to the system. Each
47 * such wiphy can have zero, one, or many virtual interfaces associated with
48 * it, which need to be identified as such by pointing the network interface's
49 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
50 * the wireless part of the interface, normally this struct is embedded in the
51 * network interface's private data area. Drivers can optionally allow creating
52 * or destroying virtual interfaces on the fly, but without at least one or the
53 * ability to create some the wireless device isn't useful.
55 * Each wiphy structure contains device capability information, and also has
56 * a pointer to the various operations the driver offers. The definitions and
57 * structures here describe these capabilities in detail.
61 * wireless hardware capability structures
65 * enum ieee80211_band - supported frequency bands
67 * The bands are assigned this way because the supported
68 * bitrates differ in these bands.
70 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
71 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
72 * @IEEE80211_NUM_BANDS: number of defined bands
75 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
76 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
83 * enum ieee80211_channel_flags - channel flags
85 * Channel flags set by the regulatory control code.
87 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
88 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
90 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
91 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
92 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
94 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
97 enum ieee80211_channel_flags {
98 IEEE80211_CHAN_DISABLED = 1<<0,
99 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
100 IEEE80211_CHAN_NO_IBSS = 1<<2,
101 IEEE80211_CHAN_RADAR = 1<<3,
102 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
103 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
106 #define IEEE80211_CHAN_NO_HT40 \
107 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
110 * struct ieee80211_channel - channel definition
112 * This structure describes a single channel for use
115 * @center_freq: center frequency in MHz
116 * @hw_value: hardware-specific value for the channel
117 * @flags: channel flags from &enum ieee80211_channel_flags.
118 * @orig_flags: channel flags at registration time, used by regulatory
119 * code to support devices with additional restrictions
120 * @band: band this channel belongs to.
121 * @max_antenna_gain: maximum antenna gain in dBi
122 * @max_power: maximum transmission power (in dBm)
123 * @beacon_found: helper to regulatory code to indicate when a beacon
124 * has been found on this channel. Use regulatory_hint_found_beacon()
125 * to enable this, this is useful only on 5 GHz band.
126 * @orig_mag: internal use
127 * @orig_mpwr: internal use
129 struct ieee80211_channel {
130 enum ieee80211_band band;
134 int max_antenna_gain;
138 int orig_mag, orig_mpwr;
142 * enum ieee80211_rate_flags - rate flags
144 * Hardware/specification flags for rates. These are structured
145 * in a way that allows using the same bitrate structure for
146 * different bands/PHY modes.
148 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
149 * preamble on this bitrate; only relevant in 2.4GHz band and
151 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
152 * when used with 802.11a (on the 5 GHz band); filled by the
153 * core code when registering the wiphy.
154 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
155 * when used with 802.11b (on the 2.4 GHz band); filled by the
156 * core code when registering the wiphy.
157 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
158 * when used with 802.11g (on the 2.4 GHz band); filled by the
159 * core code when registering the wiphy.
160 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
162 enum ieee80211_rate_flags {
163 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
164 IEEE80211_RATE_MANDATORY_A = 1<<1,
165 IEEE80211_RATE_MANDATORY_B = 1<<2,
166 IEEE80211_RATE_MANDATORY_G = 1<<3,
167 IEEE80211_RATE_ERP_G = 1<<4,
171 * struct ieee80211_rate - bitrate definition
173 * This structure describes a bitrate that an 802.11 PHY can
174 * operate with. The two values @hw_value and @hw_value_short
175 * are only for driver use when pointers to this structure are
178 * @flags: rate-specific flags
179 * @bitrate: bitrate in units of 100 Kbps
180 * @hw_value: driver/hardware value for this rate
181 * @hw_value_short: driver/hardware value for this rate when
182 * short preamble is used
184 struct ieee80211_rate {
187 u16 hw_value, hw_value_short;
191 * struct ieee80211_sta_ht_cap - STA's HT capabilities
193 * This structure describes most essential parameters needed
194 * to describe 802.11n HT capabilities for an STA.
196 * @ht_supported: is HT supported by the STA
197 * @cap: HT capabilities map as described in 802.11n spec
198 * @ampdu_factor: Maximum A-MPDU length factor
199 * @ampdu_density: Minimum A-MPDU spacing
200 * @mcs: Supported MCS rates
202 struct ieee80211_sta_ht_cap {
203 u16 cap; /* use IEEE80211_HT_CAP_ */
207 struct ieee80211_mcs_info mcs;
211 * struct ieee80211_supported_band - frequency band definition
213 * This structure describes a frequency band a wiphy
214 * is able to operate in.
216 * @channels: Array of channels the hardware can operate in
218 * @band: the band this structure represents
219 * @n_channels: Number of channels in @channels
220 * @bitrates: Array of bitrates the hardware can operate with
221 * in this band. Must be sorted to give a valid "supported
222 * rates" IE, i.e. CCK rates first, then OFDM.
223 * @n_bitrates: Number of bitrates in @bitrates
224 * @ht_cap: HT capabilities in this band
226 struct ieee80211_supported_band {
227 struct ieee80211_channel *channels;
228 struct ieee80211_rate *bitrates;
229 enum ieee80211_band band;
232 struct ieee80211_sta_ht_cap ht_cap;
236 * Wireless hardware/device configuration structures and methods
240 * DOC: Actions and configuration
242 * Each wireless device and each virtual interface offer a set of configuration
243 * operations and other actions that are invoked by userspace. Each of these
244 * actions is described in the operations structure, and the parameters these
245 * operations use are described separately.
247 * Additionally, some operations are asynchronous and expect to get status
248 * information via some functions that drivers need to call.
250 * Scanning and BSS list handling with its associated functionality is described
251 * in a separate chapter.
255 * struct vif_params - describes virtual interface parameters
256 * @use_4addr: use 4-address frames
263 * struct key_params - key information
265 * Information about a key
268 * @key_len: length of key material
269 * @cipher: cipher suite selector
270 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
271 * with the get_key() callback, must be in little endian,
272 * length given by @seq_len.
273 * @seq_len: length of @seq.
284 * enum survey_info_flags - survey information flags
286 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
287 * @SURVEY_INFO_IN_USE: channel is currently being used
288 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
289 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
290 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
291 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
292 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
294 * Used by the driver to indicate which info in &struct survey_info
295 * it has filled in during the get_survey().
297 enum survey_info_flags {
298 SURVEY_INFO_NOISE_DBM = 1<<0,
299 SURVEY_INFO_IN_USE = 1<<1,
300 SURVEY_INFO_CHANNEL_TIME = 1<<2,
301 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
302 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
303 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
304 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
308 * struct survey_info - channel survey response
310 * @channel: the channel this survey record reports, mandatory
311 * @filled: bitflag of flags from &enum survey_info_flags
312 * @noise: channel noise in dBm. This and all following fields are
314 * @channel_time: amount of time in ms the radio spent on the channel
315 * @channel_time_busy: amount of time the primary channel was sensed busy
316 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
317 * @channel_time_rx: amount of time the radio spent receiving data
318 * @channel_time_tx: amount of time the radio spent transmitting data
320 * Used by dump_survey() to report back per-channel survey information.
322 * This structure can later be expanded with things like
323 * channel duty cycle etc.
326 struct ieee80211_channel *channel;
328 u64 channel_time_busy;
329 u64 channel_time_ext_busy;
337 * struct beacon_parameters - beacon parameters
339 * Used to configure the beacon for an interface.
341 * @head: head portion of beacon (before TIM IE)
342 * or %NULL if not changed
343 * @tail: tail portion of beacon (after TIM IE)
344 * or %NULL if not changed
345 * @interval: beacon interval or zero if not changed
346 * @dtim_period: DTIM period or zero if not changed
347 * @head_len: length of @head
348 * @tail_len: length of @tail
350 struct beacon_parameters {
352 int interval, dtim_period;
353 int head_len, tail_len;
357 * enum plink_action - actions to perform in mesh peers
359 * @PLINK_ACTION_INVALID: action 0 is reserved
360 * @PLINK_ACTION_OPEN: start mesh peer link establishment
361 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
364 PLINK_ACTION_INVALID,
370 * struct station_parameters - station parameters
372 * Used to change and create a new station.
374 * @vlan: vlan interface station should belong to
375 * @supported_rates: supported rates in IEEE 802.11 format
376 * (or NULL for no change)
377 * @supported_rates_len: number of supported rates
378 * @sta_flags_mask: station flags that changed
379 * (bitmask of BIT(NL80211_STA_FLAG_...))
380 * @sta_flags_set: station flags values
381 * (bitmask of BIT(NL80211_STA_FLAG_...))
382 * @listen_interval: listen interval or -1 for no change
383 * @aid: AID or zero for no change
384 * @plink_action: plink action to take
385 * @plink_state: set the peer link state for a station
386 * @ht_capa: HT capabilities of station
388 struct station_parameters {
390 struct net_device *vlan;
391 u32 sta_flags_mask, sta_flags_set;
394 u8 supported_rates_len;
397 struct ieee80211_ht_cap *ht_capa;
401 * enum station_info_flags - station information flags
403 * Used by the driver to indicate which info in &struct station_info
404 * it has filled in during get_station() or dump_station().
406 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
407 * @STATION_INFO_RX_BYTES: @rx_bytes filled
408 * @STATION_INFO_TX_BYTES: @tx_bytes filled
409 * @STATION_INFO_LLID: @llid filled
410 * @STATION_INFO_PLID: @plid filled
411 * @STATION_INFO_PLINK_STATE: @plink_state filled
412 * @STATION_INFO_SIGNAL: @signal filled
413 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
414 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
415 * @STATION_INFO_RX_PACKETS: @rx_packets filled
416 * @STATION_INFO_TX_PACKETS: @tx_packets filled
417 * @STATION_INFO_TX_RETRIES: @tx_retries filled
418 * @STATION_INFO_TX_FAILED: @tx_failed filled
419 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
420 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
421 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
422 * @STATION_INFO_BSS_PARAM: @bss_param filled
423 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
425 enum station_info_flags {
426 STATION_INFO_INACTIVE_TIME = 1<<0,
427 STATION_INFO_RX_BYTES = 1<<1,
428 STATION_INFO_TX_BYTES = 1<<2,
429 STATION_INFO_LLID = 1<<3,
430 STATION_INFO_PLID = 1<<4,
431 STATION_INFO_PLINK_STATE = 1<<5,
432 STATION_INFO_SIGNAL = 1<<6,
433 STATION_INFO_TX_BITRATE = 1<<7,
434 STATION_INFO_RX_PACKETS = 1<<8,
435 STATION_INFO_TX_PACKETS = 1<<9,
436 STATION_INFO_TX_RETRIES = 1<<10,
437 STATION_INFO_TX_FAILED = 1<<11,
438 STATION_INFO_RX_DROP_MISC = 1<<12,
439 STATION_INFO_SIGNAL_AVG = 1<<13,
440 STATION_INFO_RX_BITRATE = 1<<14,
441 STATION_INFO_BSS_PARAM = 1<<15,
442 STATION_INFO_CONNECTED_TIME = 1<<16
446 * enum station_info_rate_flags - bitrate info flags
448 * Used by the driver to indicate the specific rate transmission
449 * type for 802.11n transmissions.
451 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
452 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
453 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
455 enum rate_info_flags {
456 RATE_INFO_FLAGS_MCS = 1<<0,
457 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
458 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
462 * struct rate_info - bitrate information
464 * Information about a receiving or transmitting bitrate
466 * @flags: bitflag of flags from &enum rate_info_flags
467 * @mcs: mcs index if struct describes a 802.11n bitrate
468 * @legacy: bitrate in 100kbit/s for 802.11abg
477 * enum station_info_rate_flags - bitrate info flags
479 * Used by the driver to indicate the specific rate transmission
480 * type for 802.11n transmissions.
482 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
483 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
484 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
486 enum bss_param_flags {
487 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
488 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
489 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
493 * struct sta_bss_parameters - BSS parameters for the attached station
495 * Information about the currently associated BSS
497 * @flags: bitflag of flags from &enum bss_param_flags
498 * @dtim_period: DTIM period for the BSS
499 * @beacon_interval: beacon interval
501 struct sta_bss_parameters {
508 * struct station_info - station information
510 * Station information filled by driver for get_station() and dump_station.
512 * @filled: bitflag of flags from &enum station_info_flags
513 * @connected_time: time(in secs) since a station is last connected
514 * @inactive_time: time since last station activity (tx/rx) in milliseconds
515 * @rx_bytes: bytes received from this station
516 * @tx_bytes: bytes transmitted to this station
517 * @llid: mesh local link id
518 * @plid: mesh peer link id
519 * @plink_state: mesh peer link state
520 * @signal: signal strength of last received packet in dBm
521 * @signal_avg: signal strength average in dBm
522 * @txrate: current unicast bitrate from this station
523 * @rxrate: current unicast bitrate to this station
524 * @rx_packets: packets received from this station
525 * @tx_packets: packets transmitted to this station
526 * @tx_retries: cumulative retry counts
527 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
528 * @rx_dropped_misc: Dropped for un-specified reason.
529 * @bss_param: current BSS parameters
530 * @generation: generation number for nl80211 dumps.
531 * This number should increase every time the list of stations
532 * changes, i.e. when a station is added or removed, so that
533 * userspace can tell whether it got a consistent snapshot.
534 * @assoc_req_ies: IEs from (Re)Association Request.
535 * This is used only when in AP mode with drivers that do not use
536 * user space MLME/SME implementation. The information is provided for
537 * the cfg80211_new_sta() calls to notify user space of the IEs.
538 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
540 struct station_info {
551 struct rate_info txrate;
552 struct rate_info rxrate;
558 struct sta_bss_parameters bss_param;
562 const u8 *assoc_req_ies;
563 size_t assoc_req_ies_len;
567 * enum monitor_flags - monitor flags
569 * Monitor interface configuration flags. Note that these must be the bits
570 * according to the nl80211 flags.
572 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
573 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
574 * @MONITOR_FLAG_CONTROL: pass control frames
575 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
576 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
579 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
580 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
581 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
582 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
583 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
587 * enum mpath_info_flags - mesh path information flags
589 * Used by the driver to indicate which info in &struct mpath_info it has filled
590 * in during get_station() or dump_station().
592 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
593 * @MPATH_INFO_SN: @sn filled
594 * @MPATH_INFO_METRIC: @metric filled
595 * @MPATH_INFO_EXPTIME: @exptime filled
596 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
597 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
598 * @MPATH_INFO_FLAGS: @flags filled
600 enum mpath_info_flags {
601 MPATH_INFO_FRAME_QLEN = BIT(0),
602 MPATH_INFO_SN = BIT(1),
603 MPATH_INFO_METRIC = BIT(2),
604 MPATH_INFO_EXPTIME = BIT(3),
605 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
606 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
607 MPATH_INFO_FLAGS = BIT(6),
611 * struct mpath_info - mesh path information
613 * Mesh path information filled by driver for get_mpath() and dump_mpath().
615 * @filled: bitfield of flags from &enum mpath_info_flags
616 * @frame_qlen: number of queued frames for this destination
617 * @sn: target sequence number
618 * @metric: metric (cost) of this mesh path
619 * @exptime: expiration time for the mesh path from now, in msecs
620 * @flags: mesh path flags
621 * @discovery_timeout: total mesh path discovery timeout, in msecs
622 * @discovery_retries: mesh path discovery retries
623 * @generation: generation number for nl80211 dumps.
624 * This number should increase every time the list of mesh paths
625 * changes, i.e. when a station is added or removed, so that
626 * userspace can tell whether it got a consistent snapshot.
634 u32 discovery_timeout;
635 u8 discovery_retries;
642 * struct bss_parameters - BSS parameters
644 * Used to change BSS parameters (mainly for AP mode).
646 * @use_cts_prot: Whether to use CTS protection
647 * (0 = no, 1 = yes, -1 = do not change)
648 * @use_short_preamble: Whether the use of short preambles is allowed
649 * (0 = no, 1 = yes, -1 = do not change)
650 * @use_short_slot_time: Whether the use of short slot time is allowed
651 * (0 = no, 1 = yes, -1 = do not change)
652 * @basic_rates: basic rates in IEEE 802.11 format
653 * (or NULL for no change)
654 * @basic_rates_len: number of basic rates
655 * @ap_isolate: do not forward packets between connected stations
656 * @ht_opmode: HT Operation mode
657 * (u16 = opmode, -1 = do not change)
659 struct bss_parameters {
661 int use_short_preamble;
662 int use_short_slot_time;
670 * struct mesh_config - 802.11s mesh configuration
672 * These parameters can be changed while the mesh is active.
676 /* Mesh plink management parameters */
677 u16 dot11MeshRetryTimeout;
678 u16 dot11MeshConfirmTimeout;
679 u16 dot11MeshHoldingTimeout;
680 u16 dot11MeshMaxPeerLinks;
681 u8 dot11MeshMaxRetries;
683 /* ttl used in path selection information elements */
685 bool auto_open_plinks;
686 /* HWMP parameters */
687 u8 dot11MeshHWMPmaxPREQretries;
688 u32 path_refresh_time;
689 u16 min_discovery_timeout;
690 u32 dot11MeshHWMPactivePathTimeout;
691 u16 dot11MeshHWMPpreqMinInterval;
692 u16 dot11MeshHWMPnetDiameterTraversalTime;
693 u8 dot11MeshHWMPRootMode;
697 * struct mesh_setup - 802.11s mesh setup configuration
698 * @mesh_id: the mesh ID
699 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
700 * @path_sel_proto: which path selection protocol to use
701 * @path_metric: which metric to use
702 * @ie: vendor information elements (optional)
703 * @ie_len: length of vendor information elements
704 * @is_authenticated: this mesh requires authentication
705 * @is_secure: this mesh uses security
707 * These parameters are fixed when the mesh is created.
716 bool is_authenticated;
721 * struct ieee80211_txq_params - TX queue parameters
722 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
723 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
724 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
726 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
728 * @aifs: Arbitration interframe space [0..255]
730 struct ieee80211_txq_params {
731 enum nl80211_txq_q queue;
738 /* from net/wireless.h */
742 * DOC: Scanning and BSS list handling
744 * The scanning process itself is fairly simple, but cfg80211 offers quite
745 * a bit of helper functionality. To start a scan, the scan operation will
746 * be invoked with a scan definition. This scan definition contains the
747 * channels to scan, and the SSIDs to send probe requests for (including the
748 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
749 * probe. Additionally, a scan request may contain extra information elements
750 * that should be added to the probe request. The IEs are guaranteed to be
751 * well-formed, and will not exceed the maximum length the driver advertised
752 * in the wiphy structure.
754 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
755 * it is responsible for maintaining the BSS list; the driver should not
756 * maintain a list itself. For this notification, various functions exist.
758 * Since drivers do not maintain a BSS list, there are also a number of
759 * functions to search for a BSS and obtain information about it from the
760 * BSS structure cfg80211 maintains. The BSS list is also made available
765 * struct cfg80211_ssid - SSID description
767 * @ssid_len: length of the ssid
769 struct cfg80211_ssid {
770 u8 ssid[IEEE80211_MAX_SSID_LEN];
775 * struct cfg80211_scan_request - scan request description
777 * @ssids: SSIDs to scan for (active scan only)
778 * @n_ssids: number of SSIDs
779 * @channels: channels to scan on.
780 * @n_channels: total number of channels to scan
781 * @ie: optional information element(s) to add into Probe Request or %NULL
782 * @ie_len: length of ie in octets
783 * @rates: bitmap of rates to advertise for each band
784 * @wiphy: the wiphy this was for
785 * @dev: the interface
786 * @aborted: (internal) scan request was notified as aborted
788 struct cfg80211_scan_request {
789 struct cfg80211_ssid *ssids;
795 u32 rates[IEEE80211_NUM_BANDS];
799 struct net_device *dev;
803 struct ieee80211_channel *channels[0];
807 * struct cfg80211_sched_scan_request - scheduled scan request description
809 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
810 * @n_ssids: number of SSIDs
811 * @n_channels: total number of channels to scan
812 * @interval: interval between each scheduled scan cycle
813 * @ie: optional information element(s) to add into Probe Request or %NULL
814 * @ie_len: length of ie in octets
815 * @wiphy: the wiphy this was for
816 * @dev: the interface
817 * @channels: channels to scan
819 struct cfg80211_sched_scan_request {
820 struct cfg80211_ssid *ssids;
829 struct net_device *dev;
832 struct ieee80211_channel *channels[0];
836 * enum cfg80211_signal_type - signal type
838 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
839 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
840 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
842 enum cfg80211_signal_type {
843 CFG80211_SIGNAL_TYPE_NONE,
844 CFG80211_SIGNAL_TYPE_MBM,
845 CFG80211_SIGNAL_TYPE_UNSPEC,
849 * struct cfg80211_bss - BSS description
851 * This structure describes a BSS (which may also be a mesh network)
852 * for use in scan results and similar.
854 * @channel: channel this BSS is on
855 * @bssid: BSSID of the BSS
856 * @tsf: timestamp of last received update
857 * @beacon_interval: the beacon interval as from the frame
858 * @capability: the capability field in host byte order
859 * @information_elements: the information elements (Note that there
860 * is no guarantee that these are well-formed!); this is a pointer to
861 * either the beacon_ies or proberesp_ies depending on whether Probe
862 * Response frame has been received
863 * @len_information_elements: total length of the information elements
864 * @beacon_ies: the information elements from the last Beacon frame
865 * @len_beacon_ies: total length of the beacon_ies
866 * @proberesp_ies: the information elements from the last Probe Response frame
867 * @len_proberesp_ies: total length of the proberesp_ies
868 * @signal: signal strength value (type depends on the wiphy's signal_type)
869 * @free_priv: function pointer to free private data
870 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
872 struct cfg80211_bss {
873 struct ieee80211_channel *channel;
879 u8 *information_elements;
880 size_t len_information_elements;
882 size_t len_beacon_ies;
884 size_t len_proberesp_ies;
888 void (*free_priv)(struct cfg80211_bss *bss);
889 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
893 * ieee80211_bss_get_ie - find IE with given ID
894 * @bss: the bss to search
896 * Returns %NULL if not found.
898 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
902 * struct cfg80211_crypto_settings - Crypto settings
903 * @wpa_versions: indicates which, if any, WPA versions are enabled
904 * (from enum nl80211_wpa_versions)
905 * @cipher_group: group key cipher suite (or 0 if unset)
906 * @n_ciphers_pairwise: number of AP supported unicast ciphers
907 * @ciphers_pairwise: unicast key cipher suites
908 * @n_akm_suites: number of AKM suites
909 * @akm_suites: AKM suites
910 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
911 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
912 * required to assume that the port is unauthorized until authorized by
913 * user space. Otherwise, port is marked authorized by default.
914 * @control_port_ethertype: the control port protocol that should be
915 * allowed through even on unauthorized ports
916 * @control_port_no_encrypt: TRUE to prevent encryption of control port
919 struct cfg80211_crypto_settings {
922 int n_ciphers_pairwise;
923 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
925 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
927 __be16 control_port_ethertype;
928 bool control_port_no_encrypt;
932 * struct cfg80211_auth_request - Authentication request data
934 * This structure provides information needed to complete IEEE 802.11
937 * @bss: The BSS to authenticate with.
938 * @auth_type: Authentication type (algorithm)
939 * @ie: Extra IEs to add to Authentication frame or %NULL
940 * @ie_len: Length of ie buffer in octets
941 * @key_len: length of WEP key for shared key authentication
942 * @key_idx: index of WEP key for shared key authentication
943 * @key: WEP key for shared key authentication
944 * @local_state_change: This is a request for a local state only, i.e., no
945 * Authentication frame is to be transmitted and authentication state is
946 * to be changed without having to wait for a response from the peer STA
949 struct cfg80211_auth_request {
950 struct cfg80211_bss *bss;
953 enum nl80211_auth_type auth_type;
956 bool local_state_change;
960 * struct cfg80211_assoc_request - (Re)Association request data
962 * This structure provides information needed to complete IEEE 802.11
964 * @bss: The BSS to associate with.
965 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
966 * @ie_len: Length of ie buffer in octets
967 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
968 * @crypto: crypto settings
969 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
971 struct cfg80211_assoc_request {
972 struct cfg80211_bss *bss;
973 const u8 *ie, *prev_bssid;
975 struct cfg80211_crypto_settings crypto;
980 * struct cfg80211_deauth_request - Deauthentication request data
982 * This structure provides information needed to complete IEEE 802.11
985 * @bss: the BSS to deauthenticate from
986 * @ie: Extra IEs to add to Deauthentication frame or %NULL
987 * @ie_len: Length of ie buffer in octets
988 * @reason_code: The reason code for the deauthentication
989 * @local_state_change: This is a request for a local state only, i.e., no
990 * Deauthentication frame is to be transmitted.
992 struct cfg80211_deauth_request {
993 struct cfg80211_bss *bss;
997 bool local_state_change;
1001 * struct cfg80211_disassoc_request - Disassociation request data
1003 * This structure provides information needed to complete IEEE 802.11
1006 * @bss: the BSS to disassociate from
1007 * @ie: Extra IEs to add to Disassociation frame or %NULL
1008 * @ie_len: Length of ie buffer in octets
1009 * @reason_code: The reason code for the disassociation
1010 * @local_state_change: This is a request for a local state only, i.e., no
1011 * Disassociation frame is to be transmitted.
1013 struct cfg80211_disassoc_request {
1014 struct cfg80211_bss *bss;
1018 bool local_state_change;
1022 * struct cfg80211_ibss_params - IBSS parameters
1024 * This structure defines the IBSS parameters for the join_ibss()
1027 * @ssid: The SSID, will always be non-null.
1028 * @ssid_len: The length of the SSID, will always be non-zero.
1029 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1030 * search for IBSSs with a different BSSID.
1031 * @channel: The channel to use if no IBSS can be found to join.
1032 * @channel_fixed: The channel should be fixed -- do not search for
1033 * IBSSs to join on other channels.
1034 * @ie: information element(s) to include in the beacon
1035 * @ie_len: length of that
1036 * @beacon_interval: beacon interval to use
1037 * @privacy: this is a protected network, keys will be configured
1039 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1040 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1042 struct cfg80211_ibss_params {
1045 struct ieee80211_channel *channel;
1047 u8 ssid_len, ie_len;
1048 u16 beacon_interval;
1052 int mcast_rate[IEEE80211_NUM_BANDS];
1056 * struct cfg80211_connect_params - Connection parameters
1058 * This structure provides information needed to complete IEEE 802.11
1059 * authentication and association.
1061 * @channel: The channel to use or %NULL if not specified (auto-select based
1063 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1066 * @ssid_len: Length of ssid in octets
1067 * @auth_type: Authentication type (algorithm)
1068 * @ie: IEs for association request
1069 * @ie_len: Length of assoc_ie in octets
1070 * @privacy: indicates whether privacy-enabled APs should be used
1071 * @crypto: crypto settings
1072 * @key_len: length of WEP key for shared key authentication
1073 * @key_idx: index of WEP key for shared key authentication
1074 * @key: WEP key for shared key authentication
1076 struct cfg80211_connect_params {
1077 struct ieee80211_channel *channel;
1081 enum nl80211_auth_type auth_type;
1085 struct cfg80211_crypto_settings crypto;
1087 u8 key_len, key_idx;
1091 * enum wiphy_params_flags - set_wiphy_params bitfield values
1092 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1093 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1094 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1095 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1096 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1098 enum wiphy_params_flags {
1099 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1100 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1101 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1102 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1103 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1107 * cfg80211_bitrate_mask - masks for bitrate control
1109 struct cfg80211_bitrate_mask {
1112 /* TODO: add support for masking MCS rates; e.g.: */
1113 /* u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; */
1114 } control[IEEE80211_NUM_BANDS];
1117 * struct cfg80211_pmksa - PMK Security Association
1119 * This structure is passed to the set/del_pmksa() method for PMKSA
1122 * @bssid: The AP's BSSID.
1123 * @pmkid: The PMK material itself.
1125 struct cfg80211_pmksa {
1131 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1132 * @mask: bitmask where to match pattern and where to ignore bytes,
1133 * one bit per byte, in same format as nl80211
1134 * @pattern: bytes to match where bitmask is 1
1135 * @pattern_len: length of pattern (in bytes)
1137 * Internal note: @mask and @pattern are allocated in one chunk of
1138 * memory, free @mask only!
1140 struct cfg80211_wowlan_trig_pkt_pattern {
1146 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1148 * This structure defines the enabled WoWLAN triggers for the device.
1149 * @any: wake up on any activity -- special trigger if device continues
1150 * operating as normal during suspend
1151 * @disconnect: wake up if getting disconnected
1152 * @magic_pkt: wake up on receiving magic packet
1153 * @patterns: wake up on receiving packet matching a pattern
1154 * @n_patterns: number of patterns
1155 * @gtk_rekey_failure: wake up on GTK rekey failure
1156 * @eap_identity_req: wake up on EAP identity request packet
1157 * @four_way_handshake: wake up on 4-way handshake
1158 * @rfkill_release: wake up when rfkill is released
1160 struct cfg80211_wowlan {
1161 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1162 eap_identity_req, four_way_handshake,
1164 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1169 * struct cfg80211_gtk_rekey_data - rekey data
1170 * @kek: key encryption key
1171 * @kck: key confirmation key
1172 * @replay_ctr: replay counter
1174 struct cfg80211_gtk_rekey_data {
1175 u8 kek[NL80211_KEK_LEN];
1176 u8 kck[NL80211_KCK_LEN];
1177 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1181 * struct cfg80211_ops - backend description for wireless configuration
1183 * This struct is registered by fullmac card drivers and/or wireless stacks
1184 * in order to handle configuration requests on their interfaces.
1186 * All callbacks except where otherwise noted should return 0
1187 * on success or a negative error code.
1189 * All operations are currently invoked under rtnl for consistency with the
1190 * wireless extensions but this is subject to reevaluation as soon as this
1191 * code is used more widely and we have a first user without wext.
1193 * @suspend: wiphy device needs to be suspended. The variable @wow will
1194 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1195 * configured for the device.
1196 * @resume: wiphy device needs to be resumed
1198 * @add_virtual_intf: create a new virtual interface with the given name,
1199 * must set the struct wireless_dev's iftype. Beware: You must create
1200 * the new netdev in the wiphy's network namespace! Returns the netdev,
1203 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1205 * @change_virtual_intf: change type/configuration of virtual interface,
1206 * keep the struct wireless_dev's iftype updated.
1208 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1209 * when adding a group key.
1211 * @get_key: get information about the key with the given parameters.
1212 * @mac_addr will be %NULL when requesting information for a group
1213 * key. All pointers given to the @callback function need not be valid
1214 * after it returns. This function should return an error if it is
1215 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1217 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1218 * and @key_index, return -ENOENT if the key doesn't exist.
1220 * @set_default_key: set the default key on an interface
1222 * @set_default_mgmt_key: set the default management frame key on an interface
1224 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1226 * @add_beacon: Add a beacon with given parameters, @head, @interval
1227 * and @dtim_period will be valid, @tail is optional.
1228 * @set_beacon: Change the beacon parameters for an access point mode
1229 * interface. This should reject the call when no beacon has been
1231 * @del_beacon: Remove beacon configuration and stop sending the beacon.
1233 * @add_station: Add a new station.
1234 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1235 * @change_station: Modify a given station.
1236 * @get_station: get station information for the station identified by @mac
1237 * @dump_station: dump station callback -- resume dump at index @idx
1239 * @add_mpath: add a fixed mesh path
1240 * @del_mpath: delete a given mesh path
1241 * @change_mpath: change a given mesh path
1242 * @get_mpath: get a mesh path for the given parameters
1243 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1244 * @join_mesh: join the mesh network with the specified parameters
1245 * @leave_mesh: leave the current mesh network
1247 * @get_mesh_config: Get the current mesh configuration
1249 * @update_mesh_config: Update mesh parameters on a running mesh.
1250 * The mask is a bitfield which tells us which parameters to
1251 * set, and which to leave alone.
1253 * @change_bss: Modify parameters for a given BSS.
1255 * @set_txq_params: Set TX queue parameters
1257 * @set_channel: Set channel for a given wireless interface. Some devices
1258 * may support multi-channel operation (by channel hopping) so cfg80211
1259 * doesn't verify much. Note, however, that the passed netdev may be
1260 * %NULL as well if the user requested changing the channel for the
1261 * device itself, or for a monitor interface.
1263 * @scan: Request to do a scan. If returning zero, the scan request is given
1264 * the driver, and will be valid until passed to cfg80211_scan_done().
1265 * For scan results, call cfg80211_inform_bss(); you can call this outside
1266 * the scan/scan_done bracket too.
1268 * @auth: Request to authenticate with the specified peer
1269 * @assoc: Request to (re)associate with the specified peer
1270 * @deauth: Request to deauthenticate from the specified peer
1271 * @disassoc: Request to disassociate from the specified peer
1273 * @connect: Connect to the ESS with the specified parameters. When connected,
1274 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1275 * If the connection fails for some reason, call cfg80211_connect_result()
1276 * with the status from the AP.
1277 * @disconnect: Disconnect from the BSS/ESS.
1279 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1280 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1282 * @leave_ibss: Leave the IBSS.
1284 * @set_wiphy_params: Notify that wiphy parameters have changed;
1285 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1286 * have changed. The actual parameter values are available in
1287 * struct wiphy. If returning an error, no value should be changed.
1289 * @set_tx_power: set the transmit power according to the parameters
1290 * @get_tx_power: store the current TX power into the dbm variable;
1291 * return 0 if successful
1293 * @set_wds_peer: set the WDS peer for a WDS interface
1295 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1296 * functions to adjust rfkill hw state
1298 * @dump_survey: get site survey information.
1300 * @remain_on_channel: Request the driver to remain awake on the specified
1301 * channel for the specified duration to complete an off-channel
1302 * operation (e.g., public action frame exchange). When the driver is
1303 * ready on the requested channel, it must indicate this with an event
1304 * notification by calling cfg80211_ready_on_channel().
1305 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1306 * This allows the operation to be terminated prior to timeout based on
1307 * the duration value.
1308 * @mgmt_tx: Transmit a management frame.
1309 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1310 * frame on another channel
1312 * @testmode_cmd: run a test mode command
1313 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1314 * used by the function, but 0 and 1 must not be touched. Additionally,
1315 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1316 * dump and return to userspace with an error, so be careful. If any data
1317 * was passed in from userspace then the data/len arguments will be present
1318 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1320 * @set_bitrate_mask: set the bitrate mask configuration
1322 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1323 * devices running firmwares capable of generating the (re) association
1324 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1325 * @del_pmksa: Delete a cached PMKID.
1326 * @flush_pmksa: Flush all cached PMKIDs.
1327 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1328 * allows the driver to adjust the dynamic ps timeout value.
1329 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1330 * @sched_scan_start: Tell the driver to start a scheduled scan.
1331 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled
1332 * scan. The driver_initiated flag specifies whether the driver
1333 * itself has informed that the scan has stopped.
1335 * @mgmt_frame_register: Notify driver that a management frame type was
1336 * registered. Note that this callback may not sleep, and cannot run
1337 * concurrently with itself.
1339 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1340 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1341 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1342 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1344 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1346 * @set_ringparam: Set tx and rx ring sizes.
1348 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1350 struct cfg80211_ops {
1351 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1352 int (*resume)(struct wiphy *wiphy);
1354 struct net_device * (*add_virtual_intf)(struct wiphy *wiphy,
1356 enum nl80211_iftype type,
1358 struct vif_params *params);
1359 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
1360 int (*change_virtual_intf)(struct wiphy *wiphy,
1361 struct net_device *dev,
1362 enum nl80211_iftype type, u32 *flags,
1363 struct vif_params *params);
1365 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1366 u8 key_index, bool pairwise, const u8 *mac_addr,
1367 struct key_params *params);
1368 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1369 u8 key_index, bool pairwise, const u8 *mac_addr,
1371 void (*callback)(void *cookie, struct key_params*));
1372 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1373 u8 key_index, bool pairwise, const u8 *mac_addr);
1374 int (*set_default_key)(struct wiphy *wiphy,
1375 struct net_device *netdev,
1376 u8 key_index, bool unicast, bool multicast);
1377 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1378 struct net_device *netdev,
1381 int (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
1382 struct beacon_parameters *info);
1383 int (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
1384 struct beacon_parameters *info);
1385 int (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
1388 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1389 u8 *mac, struct station_parameters *params);
1390 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1392 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1393 u8 *mac, struct station_parameters *params);
1394 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1395 u8 *mac, struct station_info *sinfo);
1396 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1397 int idx, u8 *mac, struct station_info *sinfo);
1399 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1400 u8 *dst, u8 *next_hop);
1401 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1403 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1404 u8 *dst, u8 *next_hop);
1405 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1406 u8 *dst, u8 *next_hop,
1407 struct mpath_info *pinfo);
1408 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1409 int idx, u8 *dst, u8 *next_hop,
1410 struct mpath_info *pinfo);
1411 int (*get_mesh_config)(struct wiphy *wiphy,
1412 struct net_device *dev,
1413 struct mesh_config *conf);
1414 int (*update_mesh_config)(struct wiphy *wiphy,
1415 struct net_device *dev, u32 mask,
1416 const struct mesh_config *nconf);
1417 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1418 const struct mesh_config *conf,
1419 const struct mesh_setup *setup);
1420 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1422 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1423 struct bss_parameters *params);
1425 int (*set_txq_params)(struct wiphy *wiphy,
1426 struct ieee80211_txq_params *params);
1428 int (*set_channel)(struct wiphy *wiphy, struct net_device *dev,
1429 struct ieee80211_channel *chan,
1430 enum nl80211_channel_type channel_type);
1432 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
1433 struct cfg80211_scan_request *request);
1435 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1436 struct cfg80211_auth_request *req);
1437 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1438 struct cfg80211_assoc_request *req);
1439 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1440 struct cfg80211_deauth_request *req,
1442 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1443 struct cfg80211_disassoc_request *req,
1446 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1447 struct cfg80211_connect_params *sme);
1448 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1451 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1452 struct cfg80211_ibss_params *params);
1453 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1455 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1457 int (*set_tx_power)(struct wiphy *wiphy,
1458 enum nl80211_tx_power_setting type, int mbm);
1459 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1461 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1464 void (*rfkill_poll)(struct wiphy *wiphy);
1466 #ifdef CONFIG_NL80211_TESTMODE
1467 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1468 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
1469 struct netlink_callback *cb,
1470 void *data, int len);
1473 int (*set_bitrate_mask)(struct wiphy *wiphy,
1474 struct net_device *dev,
1476 const struct cfg80211_bitrate_mask *mask);
1478 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1479 int idx, struct survey_info *info);
1481 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1482 struct cfg80211_pmksa *pmksa);
1483 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1484 struct cfg80211_pmksa *pmksa);
1485 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1487 int (*remain_on_channel)(struct wiphy *wiphy,
1488 struct net_device *dev,
1489 struct ieee80211_channel *chan,
1490 enum nl80211_channel_type channel_type,
1491 unsigned int duration,
1493 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1494 struct net_device *dev,
1497 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
1498 struct ieee80211_channel *chan, bool offchan,
1499 enum nl80211_channel_type channel_type,
1500 bool channel_type_valid, unsigned int wait,
1501 const u8 *buf, size_t len, u64 *cookie);
1502 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1503 struct net_device *dev,
1506 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1507 bool enabled, int timeout);
1509 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1510 struct net_device *dev,
1511 s32 rssi_thold, u32 rssi_hyst);
1513 void (*mgmt_frame_register)(struct wiphy *wiphy,
1514 struct net_device *dev,
1515 u16 frame_type, bool reg);
1517 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1518 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1520 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1521 void (*get_ringparam)(struct wiphy *wiphy,
1522 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1524 int (*sched_scan_start)(struct wiphy *wiphy,
1525 struct net_device *dev,
1526 struct cfg80211_sched_scan_request *request);
1527 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
1529 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
1530 struct cfg80211_gtk_rekey_data *data);
1534 * wireless hardware and networking interfaces structures
1535 * and registration/helper functions
1539 * enum wiphy_flags - wiphy capability flags
1541 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1542 * has its own custom regulatory domain and cannot identify the
1543 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1544 * we will disregard the first regulatory hint (when the
1545 * initiator is %REGDOM_SET_BY_CORE).
1546 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1547 * ignore regulatory domain settings until it gets its own regulatory
1548 * domain via its regulatory_hint() unless the regulatory hint is
1549 * from a country IE. After its gets its own regulatory domain it will
1550 * only allow further regulatory domain settings to further enhance
1551 * compliance. For example if channel 13 and 14 are disabled by this
1552 * regulatory domain no user regulatory domain can enable these channels
1553 * at a later time. This can be used for devices which do not have
1554 * calibration information guaranteed for frequencies or settings
1555 * outside of its regulatory domain.
1556 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1557 * that passive scan flags and beaconing flags may not be lifted by
1558 * cfg80211 due to regulatory beacon hints. For more information on beacon
1559 * hints read the documenation for regulatory_hint_found_beacon()
1560 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1562 * @WIPHY_FLAG_ENFORCE_COMBINATIONS: Set this flag to enforce interface
1563 * combinations for this device. This flag is used for backward
1564 * compatibility only until all drivers advertise combinations and
1565 * they will always be enforced.
1566 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1567 * by default -- this flag will be set depending on the kernel's default
1568 * on wiphy_new(), but can be changed by the driver if it has a good
1569 * reason to override the default
1570 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1571 * on a VLAN interface)
1572 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1573 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1574 * control port protocol ethertype. The device also honours the
1575 * control_port_no_encrypt flag.
1576 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1577 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1578 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1579 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
1582 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1583 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1584 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1585 WIPHY_FLAG_NETNS_OK = BIT(3),
1586 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1587 WIPHY_FLAG_4ADDR_AP = BIT(5),
1588 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1589 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
1590 WIPHY_FLAG_IBSS_RSN = BIT(8),
1591 WIPHY_FLAG_MESH_AUTH = BIT(10),
1592 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
1593 WIPHY_FLAG_ENFORCE_COMBINATIONS = BIT(12),
1597 * struct ieee80211_iface_limit - limit on certain interface types
1598 * @max: maximum number of interfaces of these types
1599 * @types: interface types (bits)
1601 struct ieee80211_iface_limit {
1607 * struct ieee80211_iface_combination - possible interface combination
1608 * @limits: limits for the given interface types
1609 * @n_limits: number of limitations
1610 * @num_different_channels: can use up to this many different channels
1611 * @max_interfaces: maximum number of interfaces in total allowed in this
1613 * @beacon_int_infra_match: In this combination, the beacon intervals
1614 * between infrastructure and AP types must match. This is required
1615 * only in special cases.
1617 * These examples can be expressed as follows:
1619 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
1621 * struct ieee80211_iface_limit limits1[] = {
1622 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1623 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
1625 * struct ieee80211_iface_combination combination1 = {
1626 * .limits = limits1,
1627 * .n_limits = ARRAY_SIZE(limits1),
1628 * .max_interfaces = 2,
1629 * .beacon_int_infra_match = true,
1633 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
1635 * struct ieee80211_iface_limit limits2[] = {
1636 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
1637 * BIT(NL80211_IFTYPE_P2P_GO), },
1639 * struct ieee80211_iface_combination combination2 = {
1640 * .limits = limits2,
1641 * .n_limits = ARRAY_SIZE(limits2),
1642 * .max_interfaces = 8,
1643 * .num_different_channels = 1,
1647 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
1648 * This allows for an infrastructure connection and three P2P connections.
1650 * struct ieee80211_iface_limit limits3[] = {
1651 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1652 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
1653 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
1655 * struct ieee80211_iface_combination combination3 = {
1656 * .limits = limits3,
1657 * .n_limits = ARRAY_SIZE(limits3),
1658 * .max_interfaces = 4,
1659 * .num_different_channels = 2,
1662 struct ieee80211_iface_combination {
1663 const struct ieee80211_iface_limit *limits;
1664 u32 num_different_channels;
1667 bool beacon_int_infra_match;
1670 struct mac_address {
1674 struct ieee80211_txrx_stypes {
1679 * enum wiphy_wowlan_support_flags - WoWLAN support flags
1680 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
1681 * trigger that keeps the device operating as-is and
1682 * wakes up the host on any activity, for example a
1683 * received packet that passed filtering; note that the
1684 * packet should be preserved in that case
1685 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
1687 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
1688 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
1689 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
1690 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
1691 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
1692 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
1694 enum wiphy_wowlan_support_flags {
1695 WIPHY_WOWLAN_ANY = BIT(0),
1696 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
1697 WIPHY_WOWLAN_DISCONNECT = BIT(2),
1698 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
1699 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
1700 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
1701 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
1702 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
1706 * struct wiphy_wowlan_support - WoWLAN support data
1707 * @flags: see &enum wiphy_wowlan_support_flags
1708 * @n_patterns: number of supported wakeup patterns
1709 * (see nl80211.h for the pattern definition)
1710 * @pattern_max_len: maximum length of each pattern
1711 * @pattern_min_len: minimum length of each pattern
1713 struct wiphy_wowlan_support {
1716 int pattern_max_len;
1717 int pattern_min_len;
1721 * struct wiphy - wireless hardware description
1722 * @reg_notifier: the driver's regulatory notification callback,
1723 * note that if your driver uses wiphy_apply_custom_regulatory()
1724 * the reg_notifier's request can be passed as NULL
1725 * @regd: the driver's regulatory domain, if one was requested via
1726 * the regulatory_hint() API. This can be used by the driver
1727 * on the reg_notifier() if it chooses to ignore future
1728 * regulatory domain changes caused by other drivers.
1729 * @signal_type: signal type reported in &struct cfg80211_bss.
1730 * @cipher_suites: supported cipher suites
1731 * @n_cipher_suites: number of supported cipher suites
1732 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1733 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1734 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1735 * -1 = fragmentation disabled, only odd values >= 256 used
1736 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1737 * @_net: the network namespace this wiphy currently lives in
1738 * @perm_addr: permanent MAC address of this device
1739 * @addr_mask: If the device supports multiple MAC addresses by masking,
1740 * set this to a mask with variable bits set to 1, e.g. if the last
1741 * four bits are variable then set it to 00:...:00:0f. The actual
1742 * variable bits shall be determined by the interfaces added, with
1743 * interfaces not matching the mask being rejected to be brought up.
1744 * @n_addresses: number of addresses in @addresses.
1745 * @addresses: If the device has more than one address, set this pointer
1746 * to a list of addresses (6 bytes each). The first one will be used
1747 * by default for perm_addr. In this case, the mask should be set to
1748 * all-zeroes. In this case it is assumed that the device can handle
1749 * the same number of arbitrary MAC addresses.
1750 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
1751 * automatically on wiphy renames
1752 * @dev: (virtual) struct device for this wiphy
1753 * @wext: wireless extension handlers
1754 * @priv: driver private data (sized according to wiphy_new() parameter)
1755 * @interface_modes: bitmask of interfaces types valid for this wiphy,
1756 * must be set by driver
1757 * @iface_combinations: Valid interface combinations array, should not
1758 * list single interface types.
1759 * @n_iface_combinations: number of entries in @iface_combinations array.
1760 * @software_iftypes: bitmask of software interface types, these are not
1761 * subject to any restrictions since they are purely managed in SW.
1762 * @flags: wiphy flags, see &enum wiphy_flags
1763 * @bss_priv_size: each BSS struct has private data allocated with it,
1764 * this variable determines its size
1765 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
1767 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
1768 * for in any given scheduled scan
1769 * @max_scan_ie_len: maximum length of user-controlled IEs device can
1770 * add to probe request frames transmitted during a scan, must not
1771 * include fixed IEs like supported rates
1772 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
1774 * @coverage_class: current coverage class
1775 * @fw_version: firmware version for ethtool reporting
1776 * @hw_version: hardware version for ethtool reporting
1777 * @max_num_pmkids: maximum number of PMKIDs supported by device
1778 * @privid: a pointer that drivers can use to identify if an arbitrary
1779 * wiphy is theirs, e.g. in global notifiers
1780 * @bands: information about bands/channels supported by this device
1782 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
1783 * transmitted through nl80211, points to an array indexed by interface
1786 * @available_antennas_tx: bitmap of antennas which are available to be
1787 * configured as TX antennas. Antenna configuration commands will be
1788 * rejected unless this or @available_antennas_rx is set.
1790 * @available_antennas_rx: bitmap of antennas which are available to be
1791 * configured as RX antennas. Antenna configuration commands will be
1792 * rejected unless this or @available_antennas_tx is set.
1794 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
1795 * may request, if implemented.
1797 * @wowlan: WoWLAN support information
1800 /* assign these fields before you register the wiphy */
1802 /* permanent MAC address(es) */
1803 u8 perm_addr[ETH_ALEN];
1804 u8 addr_mask[ETH_ALEN];
1806 struct mac_address *addresses;
1808 const struct ieee80211_txrx_stypes *mgmt_stypes;
1810 const struct ieee80211_iface_combination *iface_combinations;
1811 int n_iface_combinations;
1812 u16 software_iftypes;
1816 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1817 u16 interface_modes;
1821 enum cfg80211_signal_type signal_type;
1825 u8 max_sched_scan_ssids;
1826 u16 max_scan_ie_len;
1827 u16 max_sched_scan_ie_len;
1829 int n_cipher_suites;
1830 const u32 *cipher_suites;
1838 char fw_version[ETHTOOL_BUSINFO_LEN];
1841 struct wiphy_wowlan_support wowlan;
1843 u16 max_remain_on_channel_duration;
1847 u32 available_antennas_tx;
1848 u32 available_antennas_rx;
1850 /* If multiple wiphys are registered and you're handed e.g.
1851 * a regular netdev with assigned ieee80211_ptr, you won't
1852 * know whether it points to a wiphy your driver has registered
1853 * or not. Assign this to something global to your driver to
1854 * help determine whether you own this wiphy or not. */
1857 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
1859 /* Lets us get back the wiphy on the callback */
1860 int (*reg_notifier)(struct wiphy *wiphy,
1861 struct regulatory_request *request);
1863 /* fields below are read-only, assigned by cfg80211 */
1865 const struct ieee80211_regdomain *regd;
1867 /* the item in /sys/class/ieee80211/ points to this,
1868 * you need use set_wiphy_dev() (see below) */
1871 /* dir in debugfs: ieee80211/<wiphyname> */
1872 struct dentry *debugfsdir;
1874 #ifdef CONFIG_NET_NS
1875 /* the network namespace this phy lives in currently */
1879 #ifdef CONFIG_CFG80211_WEXT
1880 const struct iw_handler_def *wext;
1883 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1886 static inline struct net *wiphy_net(struct wiphy *wiphy)
1888 return read_pnet(&wiphy->_net);
1891 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
1893 write_pnet(&wiphy->_net, net);
1897 * wiphy_priv - return priv from wiphy
1899 * @wiphy: the wiphy whose priv pointer to return
1901 static inline void *wiphy_priv(struct wiphy *wiphy)
1904 return &wiphy->priv;
1908 * priv_to_wiphy - return the wiphy containing the priv
1910 * @priv: a pointer previously returned by wiphy_priv
1912 static inline struct wiphy *priv_to_wiphy(void *priv)
1915 return container_of(priv, struct wiphy, priv);
1919 * set_wiphy_dev - set device pointer for wiphy
1921 * @wiphy: The wiphy whose device to bind
1922 * @dev: The device to parent it to
1924 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1926 wiphy->dev.parent = dev;
1930 * wiphy_dev - get wiphy dev pointer
1932 * @wiphy: The wiphy whose device struct to look up
1934 static inline struct device *wiphy_dev(struct wiphy *wiphy)
1936 return wiphy->dev.parent;
1940 * wiphy_name - get wiphy name
1942 * @wiphy: The wiphy whose name to return
1944 static inline const char *wiphy_name(const struct wiphy *wiphy)
1946 return dev_name(&wiphy->dev);
1950 * wiphy_new - create a new wiphy for use with cfg80211
1952 * @ops: The configuration operations for this device
1953 * @sizeof_priv: The size of the private area to allocate
1955 * Create a new wiphy and associate the given operations with it.
1956 * @sizeof_priv bytes are allocated for private use.
1958 * The returned pointer must be assigned to each netdev's
1959 * ieee80211_ptr for proper operation.
1961 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
1964 * wiphy_register - register a wiphy with cfg80211
1966 * @wiphy: The wiphy to register.
1968 * Returns a non-negative wiphy index or a negative error code.
1970 extern int wiphy_register(struct wiphy *wiphy);
1973 * wiphy_unregister - deregister a wiphy from cfg80211
1975 * @wiphy: The wiphy to unregister.
1977 * After this call, no more requests can be made with this priv
1978 * pointer, but the call may sleep to wait for an outstanding
1979 * request that is being handled.
1981 extern void wiphy_unregister(struct wiphy *wiphy);
1984 * wiphy_free - free wiphy
1986 * @wiphy: The wiphy to free
1988 extern void wiphy_free(struct wiphy *wiphy);
1990 /* internal structs */
1991 struct cfg80211_conn;
1992 struct cfg80211_internal_bss;
1993 struct cfg80211_cached_keys;
1995 #define MAX_AUTH_BSSES 4
1998 * struct wireless_dev - wireless per-netdev state
2000 * This structure must be allocated by the driver/stack
2001 * that uses the ieee80211_ptr field in struct net_device
2002 * (this is intentional so it can be allocated along with
2005 * @wiphy: pointer to hardware description
2006 * @iftype: interface type
2007 * @list: (private) Used to collect the interfaces
2008 * @netdev: (private) Used to reference back to the netdev
2009 * @current_bss: (private) Used by the internal configuration code
2010 * @channel: (private) Used by the internal configuration code to track
2011 * user-set AP, monitor and WDS channels for wireless extensions
2012 * @bssid: (private) Used by the internal configuration code
2013 * @ssid: (private) Used by the internal configuration code
2014 * @ssid_len: (private) Used by the internal configuration code
2015 * @mesh_id_len: (private) Used by the internal configuration code
2016 * @mesh_id_up_len: (private) Used by the internal configuration code
2017 * @wext: (private) Used by the internal wireless extensions compat code
2018 * @use_4addr: indicates 4addr mode is used on this interface, must be
2019 * set by driver (if supported) on add_interface BEFORE registering the
2020 * netdev and may otherwise be used by driver read-only, will be update
2021 * by cfg80211 on change_interface
2022 * @mgmt_registrations: list of registrations for management frames
2023 * @mgmt_registrations_lock: lock for the list
2024 * @mtx: mutex used to lock data in this struct
2025 * @cleanup_work: work struct used for cleanup that can't be done directly
2026 * @beacon_interval: beacon interval used on this device for transmitting
2027 * beacons, 0 when not valid
2029 struct wireless_dev {
2030 struct wiphy *wiphy;
2031 enum nl80211_iftype iftype;
2033 /* the remainder of this struct should be private to cfg80211 */
2034 struct list_head list;
2035 struct net_device *netdev;
2037 struct list_head mgmt_registrations;
2038 spinlock_t mgmt_registrations_lock;
2042 struct work_struct cleanup_work;
2046 /* currently used for IBSS and SME - might be rearranged later */
2047 u8 ssid[IEEE80211_MAX_SSID_LEN];
2048 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2051 CFG80211_SME_CONNECTING,
2052 CFG80211_SME_CONNECTED,
2054 struct cfg80211_conn *conn;
2055 struct cfg80211_cached_keys *connect_keys;
2057 struct list_head event_list;
2058 spinlock_t event_lock;
2060 struct cfg80211_internal_bss *authtry_bsses[MAX_AUTH_BSSES];
2061 struct cfg80211_internal_bss *auth_bsses[MAX_AUTH_BSSES];
2062 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2063 struct ieee80211_channel *channel;
2068 int beacon_interval;
2070 #ifdef CONFIG_CFG80211_WEXT
2073 struct cfg80211_ibss_params ibss;
2074 struct cfg80211_connect_params connect;
2075 struct cfg80211_cached_keys *keys;
2078 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2079 u8 ssid[IEEE80211_MAX_SSID_LEN];
2080 s8 default_key, default_mgmt_key;
2081 bool prev_bssid_valid;
2087 * wdev_priv - return wiphy priv from wireless_dev
2089 * @wdev: The wireless device whose wiphy's priv pointer to return
2091 static inline void *wdev_priv(struct wireless_dev *wdev)
2094 return wiphy_priv(wdev->wiphy);
2098 * DOC: Utility functions
2100 * cfg80211 offers a number of utility functions that can be useful.
2104 * ieee80211_channel_to_frequency - convert channel number to frequency
2105 * @chan: channel number
2106 * @band: band, necessary due to channel number overlap
2108 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2111 * ieee80211_frequency_to_channel - convert frequency to channel number
2112 * @freq: center frequency
2114 extern int ieee80211_frequency_to_channel(int freq);
2117 * Name indirection necessary because the ieee80211 code also has
2118 * a function named "ieee80211_get_channel", so if you include
2119 * cfg80211's header file you get cfg80211's version, if you try
2120 * to include both header files you'll (rightfully!) get a symbol
2123 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2126 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2127 * @wiphy: the struct wiphy to get the channel for
2128 * @freq: the center frequency of the channel
2130 static inline struct ieee80211_channel *
2131 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2133 return __ieee80211_get_channel(wiphy, freq);
2137 * ieee80211_get_response_rate - get basic rate for a given rate
2139 * @sband: the band to look for rates in
2140 * @basic_rates: bitmap of basic rates
2141 * @bitrate: the bitrate for which to find the basic rate
2143 * This function returns the basic rate corresponding to a given
2144 * bitrate, that is the next lower bitrate contained in the basic
2145 * rate map, which is, for this function, given as a bitmap of
2146 * indices of rates in the band's bitrate table.
2148 struct ieee80211_rate *
2149 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2150 u32 basic_rates, int bitrate);
2153 * Radiotap parsing functions -- for controlled injection support
2155 * Implemented in net/wireless/radiotap.c
2156 * Documentation in Documentation/networking/radiotap-headers.txt
2159 struct radiotap_align_size {
2160 uint8_t align:4, size:4;
2163 struct ieee80211_radiotap_namespace {
2164 const struct radiotap_align_size *align_size;
2170 struct ieee80211_radiotap_vendor_namespaces {
2171 const struct ieee80211_radiotap_namespace *ns;
2176 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2177 * @this_arg_index: index of current arg, valid after each successful call
2178 * to ieee80211_radiotap_iterator_next()
2179 * @this_arg: pointer to current radiotap arg; it is valid after each
2180 * call to ieee80211_radiotap_iterator_next() but also after
2181 * ieee80211_radiotap_iterator_init() where it will point to
2182 * the beginning of the actual data portion
2183 * @this_arg_size: length of the current arg, for convenience
2184 * @current_namespace: pointer to the current namespace definition
2185 * (or internally %NULL if the current namespace is unknown)
2186 * @is_radiotap_ns: indicates whether the current namespace is the default
2187 * radiotap namespace or not
2189 * @_rtheader: pointer to the radiotap header we are walking through
2190 * @_max_length: length of radiotap header in cpu byte ordering
2191 * @_arg_index: next argument index
2192 * @_arg: next argument pointer
2193 * @_next_bitmap: internal pointer to next present u32
2194 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2195 * @_vns: vendor namespace definitions
2196 * @_next_ns_data: beginning of the next namespace's data
2197 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2200 * Describes the radiotap parser state. Fields prefixed with an underscore
2201 * must not be used by users of the parser, only by the parser internally.
2204 struct ieee80211_radiotap_iterator {
2205 struct ieee80211_radiotap_header *_rtheader;
2206 const struct ieee80211_radiotap_vendor_namespaces *_vns;
2207 const struct ieee80211_radiotap_namespace *current_namespace;
2209 unsigned char *_arg, *_next_ns_data;
2210 __le32 *_next_bitmap;
2212 unsigned char *this_arg;
2220 uint32_t _bitmap_shifter;
2224 extern int ieee80211_radiotap_iterator_init(
2225 struct ieee80211_radiotap_iterator *iterator,
2226 struct ieee80211_radiotap_header *radiotap_header,
2227 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
2229 extern int ieee80211_radiotap_iterator_next(
2230 struct ieee80211_radiotap_iterator *iterator);
2233 extern const unsigned char rfc1042_header[6];
2234 extern const unsigned char bridge_tunnel_header[6];
2237 * ieee80211_get_hdrlen_from_skb - get header length from data
2239 * Given an skb with a raw 802.11 header at the data pointer this function
2240 * returns the 802.11 header length in bytes (not including encryption
2241 * headers). If the data in the sk_buff is too short to contain a valid 802.11
2242 * header the function returns 0.
2246 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
2249 * ieee80211_hdrlen - get header length in bytes from frame control
2250 * @fc: frame control field in little-endian format
2252 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2255 * DOC: Data path helpers
2257 * In addition to generic utilities, cfg80211 also offers
2258 * functions that help implement the data path for devices
2259 * that do not do the 802.11/802.3 conversion on the device.
2263 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2264 * @skb: the 802.11 data frame
2265 * @addr: the device MAC address
2266 * @iftype: the virtual interface type
2268 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2269 enum nl80211_iftype iftype);
2272 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2273 * @skb: the 802.3 frame
2274 * @addr: the device MAC address
2275 * @iftype: the virtual interface type
2276 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2277 * @qos: build 802.11 QoS data frame
2279 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2280 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2283 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2285 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2286 * 802.3 frames. The @list will be empty if the decode fails. The
2287 * @skb is consumed after the function returns.
2289 * @skb: The input IEEE 802.11n A-MSDU frame.
2290 * @list: The output list of 802.3 frames. It must be allocated and
2291 * initialized by by the caller.
2292 * @addr: The device MAC address.
2293 * @iftype: The device interface type.
2294 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2295 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2297 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2298 const u8 *addr, enum nl80211_iftype iftype,
2299 const unsigned int extra_headroom,
2300 bool has_80211_header);
2303 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2304 * @skb: the data frame
2306 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2309 * cfg80211_find_ie - find information element in data
2312 * @ies: data consisting of IEs
2313 * @len: length of data
2315 * This function will return %NULL if the element ID could
2316 * not be found or if the element is invalid (claims to be
2317 * longer than the given data), or a pointer to the first byte
2318 * of the requested element, that is the byte containing the
2319 * element ID. There are no checks on the element length
2320 * other than having to fit into the given data.
2322 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2325 * DOC: Regulatory enforcement infrastructure
2331 * regulatory_hint - driver hint to the wireless core a regulatory domain
2332 * @wiphy: the wireless device giving the hint (used only for reporting
2334 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2335 * should be in. If @rd is set this should be NULL. Note that if you
2336 * set this to NULL you should still set rd->alpha2 to some accepted
2339 * Wireless drivers can use this function to hint to the wireless core
2340 * what it believes should be the current regulatory domain by
2341 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2342 * domain should be in or by providing a completely build regulatory domain.
2343 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2344 * for a regulatory domain structure for the respective country.
2346 * The wiphy must have been registered to cfg80211 prior to this call.
2347 * For cfg80211 drivers this means you must first use wiphy_register(),
2348 * for mac80211 drivers you must first use ieee80211_register_hw().
2350 * Drivers should check the return value, its possible you can get
2353 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2356 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2357 * @wiphy: the wireless device we want to process the regulatory domain on
2358 * @regd: the custom regulatory domain to use for this wiphy
2360 * Drivers can sometimes have custom regulatory domains which do not apply
2361 * to a specific country. Drivers can use this to apply such custom regulatory
2362 * domains. This routine must be called prior to wiphy registration. The
2363 * custom regulatory domain will be trusted completely and as such previous
2364 * default channel settings will be disregarded. If no rule is found for a
2365 * channel on the regulatory domain the channel will be disabled.
2367 extern void wiphy_apply_custom_regulatory(
2368 struct wiphy *wiphy,
2369 const struct ieee80211_regdomain *regd);
2372 * freq_reg_info - get regulatory information for the given frequency
2373 * @wiphy: the wiphy for which we want to process this rule for
2374 * @center_freq: Frequency in KHz for which we want regulatory information for
2375 * @desired_bw_khz: the desired max bandwidth you want to use per
2376 * channel. Note that this is still 20 MHz if you want to use HT40
2377 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2378 * If set to 0 we'll assume you want the standard 20 MHz.
2379 * @reg_rule: the regulatory rule which we have for this frequency
2381 * Use this function to get the regulatory rule for a specific frequency on
2382 * a given wireless device. If the device has a specific regulatory domain
2383 * it wants to follow we respect that unless a country IE has been received
2384 * and processed already.
2386 * Returns 0 if it was able to find a valid regulatory rule which does
2387 * apply to the given center_freq otherwise it returns non-zero. It will
2388 * also return -ERANGE if we determine the given center_freq does not even have
2389 * a regulatory rule for a frequency range in the center_freq's band. See
2390 * freq_in_rule_band() for our current definition of a band -- this is purely
2391 * subjective and right now its 802.11 specific.
2393 extern int freq_reg_info(struct wiphy *wiphy,
2396 const struct ieee80211_reg_rule **reg_rule);
2399 * callbacks for asynchronous cfg80211 methods, notification
2400 * functions and BSS handling helpers
2404 * cfg80211_scan_done - notify that scan finished
2406 * @request: the corresponding scan request
2407 * @aborted: set to true if the scan was aborted for any reason,
2408 * userspace will be notified of that
2410 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2413 * cfg80211_sched_scan_results - notify that new scan results are available
2415 * @wiphy: the wiphy which got scheduled scan results
2417 void cfg80211_sched_scan_results(struct wiphy *wiphy);
2420 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
2422 * @wiphy: the wiphy on which the scheduled scan stopped
2424 * The driver can call this function to inform cfg80211 that the
2425 * scheduled scan had to be stopped, for whatever reason. The driver
2426 * is then called back via the sched_scan_stop operation when done.
2428 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
2431 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2433 * @wiphy: the wiphy reporting the BSS
2434 * @channel: The channel the frame was received on
2435 * @mgmt: the management frame (probe response or beacon)
2436 * @len: length of the management frame
2437 * @signal: the signal strength, type depends on the wiphy's signal_type
2438 * @gfp: context flags
2440 * This informs cfg80211 that BSS information was found and
2441 * the BSS should be updated/added.
2443 struct cfg80211_bss*
2444 cfg80211_inform_bss_frame(struct wiphy *wiphy,
2445 struct ieee80211_channel *channel,
2446 struct ieee80211_mgmt *mgmt, size_t len,
2447 s32 signal, gfp_t gfp);
2450 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2452 * @wiphy: the wiphy reporting the BSS
2453 * @channel: The channel the frame was received on
2454 * @bssid: the BSSID of the BSS
2455 * @timestamp: the TSF timestamp sent by the peer
2456 * @capability: the capability field sent by the peer
2457 * @beacon_interval: the beacon interval announced by the peer
2458 * @ie: additional IEs sent by the peer
2459 * @ielen: length of the additional IEs
2460 * @signal: the signal strength, type depends on the wiphy's signal_type
2461 * @gfp: context flags
2463 * This informs cfg80211 that BSS information was found and
2464 * the BSS should be updated/added.
2466 struct cfg80211_bss*
2467 cfg80211_inform_bss(struct wiphy *wiphy,
2468 struct ieee80211_channel *channel,
2470 u64 timestamp, u16 capability, u16 beacon_interval,
2471 const u8 *ie, size_t ielen,
2472 s32 signal, gfp_t gfp);
2474 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2475 struct ieee80211_channel *channel,
2477 const u8 *ssid, size_t ssid_len,
2478 u16 capa_mask, u16 capa_val);
2479 static inline struct cfg80211_bss *
2480 cfg80211_get_ibss(struct wiphy *wiphy,
2481 struct ieee80211_channel *channel,
2482 const u8 *ssid, size_t ssid_len)
2484 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2485 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2488 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2489 struct ieee80211_channel *channel,
2490 const u8 *meshid, size_t meshidlen,
2492 void cfg80211_put_bss(struct cfg80211_bss *bss);
2495 * cfg80211_unlink_bss - unlink BSS from internal data structures
2497 * @bss: the bss to remove
2499 * This function removes the given BSS from the internal data structures
2500 * thereby making it no longer show up in scan results etc. Use this
2501 * function when you detect a BSS is gone. Normally BSSes will also time
2502 * out, so it is not necessary to use this function at all.
2504 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
2507 * cfg80211_send_rx_auth - notification of processed authentication
2508 * @dev: network device
2509 * @buf: authentication frame (header + body)
2510 * @len: length of the frame data
2512 * This function is called whenever an authentication has been processed in
2513 * station mode. The driver is required to call either this function or
2514 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2515 * call. This function may sleep.
2517 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
2520 * cfg80211_send_auth_timeout - notification of timed out authentication
2521 * @dev: network device
2522 * @addr: The MAC address of the device with which the authentication timed out
2524 * This function may sleep.
2526 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
2529 * __cfg80211_auth_canceled - notify cfg80211 that authentication was canceled
2530 * @dev: network device
2531 * @addr: The MAC address of the device with which the authentication timed out
2533 * When a pending authentication had no action yet, the driver may decide
2534 * to not send a deauth frame, but in that case must calls this function
2535 * to tell cfg80211 about this decision. It is only valid to call this
2536 * function within the deauth() callback.
2538 void __cfg80211_auth_canceled(struct net_device *dev, const u8 *addr);
2541 * cfg80211_send_rx_assoc - notification of processed association
2542 * @dev: network device
2543 * @buf: (re)association response frame (header + body)
2544 * @len: length of the frame data
2546 * This function is called whenever a (re)association response has been
2547 * processed in station mode. The driver is required to call either this
2548 * function or cfg80211_send_assoc_timeout() to indicate the result of
2549 * cfg80211_ops::assoc() call. This function may sleep.
2551 void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
2554 * cfg80211_send_assoc_timeout - notification of timed out association
2555 * @dev: network device
2556 * @addr: The MAC address of the device with which the association timed out
2558 * This function may sleep.
2560 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
2563 * cfg80211_send_deauth - notification of processed deauthentication
2564 * @dev: network device
2565 * @buf: deauthentication frame (header + body)
2566 * @len: length of the frame data
2568 * This function is called whenever deauthentication has been processed in
2569 * station mode. This includes both received deauthentication frames and
2570 * locally generated ones. This function may sleep.
2572 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2575 * __cfg80211_send_deauth - notification of processed deauthentication
2576 * @dev: network device
2577 * @buf: deauthentication frame (header + body)
2578 * @len: length of the frame data
2580 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2582 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2585 * cfg80211_send_disassoc - notification of processed disassociation
2586 * @dev: network device
2587 * @buf: disassociation response frame (header + body)
2588 * @len: length of the frame data
2590 * This function is called whenever disassociation has been processed in
2591 * station mode. This includes both received disassociation frames and locally
2592 * generated ones. This function may sleep.
2594 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
2597 * __cfg80211_send_disassoc - notification of processed disassociation
2598 * @dev: network device
2599 * @buf: disassociation response frame (header + body)
2600 * @len: length of the frame data
2602 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2604 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
2608 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
2609 * @dev: network device
2610 * @buf: deauthentication frame (header + body)
2611 * @len: length of the frame data
2613 * This function is called whenever a received Deauthentication frame has been
2614 * dropped in station mode because of MFP being used but the Deauthentication
2615 * frame was not protected. This function may sleep.
2617 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
2621 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
2622 * @dev: network device
2623 * @buf: disassociation frame (header + body)
2624 * @len: length of the frame data
2626 * This function is called whenever a received Disassociation frame has been
2627 * dropped in station mode because of MFP being used but the Disassociation
2628 * frame was not protected. This function may sleep.
2630 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
2634 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
2635 * @dev: network device
2636 * @addr: The source MAC address of the frame
2637 * @key_type: The key type that the received frame used
2638 * @key_id: Key identifier (0..3). Can be -1 if missing.
2639 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
2640 * @gfp: allocation flags
2642 * This function is called whenever the local MAC detects a MIC failure in a
2643 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
2646 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
2647 enum nl80211_key_type key_type, int key_id,
2648 const u8 *tsc, gfp_t gfp);
2651 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
2653 * @dev: network device
2654 * @bssid: the BSSID of the IBSS joined
2655 * @gfp: allocation flags
2657 * This function notifies cfg80211 that the device joined an IBSS or
2658 * switched to a different BSSID. Before this function can be called,
2659 * either a beacon has to have been received from the IBSS, or one of
2660 * the cfg80211_inform_bss{,_frame} functions must have been called
2661 * with the locally generated beacon -- this guarantees that there is
2662 * always a scan result for this IBSS. cfg80211 will handle the rest.
2664 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
2667 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
2669 * @dev: network device
2670 * @macaddr: the MAC address of the new candidate
2671 * @ie: information elements advertised by the peer candidate
2672 * @ie_len: lenght of the information elements buffer
2673 * @gfp: allocation flags
2675 * This function notifies cfg80211 that the mesh peer candidate has been
2676 * detected, most likely via a beacon or, less likely, via a probe response.
2677 * cfg80211 then sends a notification to userspace.
2679 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
2680 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
2683 * DOC: RFkill integration
2685 * RFkill integration in cfg80211 is almost invisible to drivers,
2686 * as cfg80211 automatically registers an rfkill instance for each
2687 * wireless device it knows about. Soft kill is also translated
2688 * into disconnecting and turning all interfaces off, drivers are
2689 * expected to turn off the device when all interfaces are down.
2691 * However, devices may have a hard RFkill line, in which case they
2692 * also need to interact with the rfkill subsystem, via cfg80211.
2693 * They can do this with a few helper functions documented here.
2697 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
2699 * @blocked: block status
2701 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
2704 * wiphy_rfkill_start_polling - start polling rfkill
2707 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
2710 * wiphy_rfkill_stop_polling - stop polling rfkill
2713 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
2715 #ifdef CONFIG_NL80211_TESTMODE
2719 * Test mode is a set of utility functions to allow drivers to
2720 * interact with driver-specific tools to aid, for instance,
2721 * factory programming.
2723 * This chapter describes how drivers interact with it, for more
2724 * information see the nl80211 book's chapter on it.
2728 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
2730 * @approxlen: an upper bound of the length of the data that will
2731 * be put into the skb
2733 * This function allocates and pre-fills an skb for a reply to
2734 * the testmode command. Since it is intended for a reply, calling
2735 * it outside of the @testmode_cmd operation is invalid.
2737 * The returned skb (or %NULL if any errors happen) is pre-filled
2738 * with the wiphy index and set up in a way that any data that is
2739 * put into the skb (with skb_put(), nla_put() or similar) will end
2740 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
2741 * needs to be done with the skb is adding data for the corresponding
2742 * userspace tool which can then read that data out of the testdata
2743 * attribute. You must not modify the skb in any other way.
2745 * When done, call cfg80211_testmode_reply() with the skb and return
2746 * its error code as the result of the @testmode_cmd operation.
2748 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
2752 * cfg80211_testmode_reply - send the reply skb
2753 * @skb: The skb, must have been allocated with
2754 * cfg80211_testmode_alloc_reply_skb()
2756 * Returns an error code or 0 on success, since calling this
2757 * function will usually be the last thing before returning
2758 * from the @testmode_cmd you should return the error code.
2759 * Note that this function consumes the skb regardless of the
2762 int cfg80211_testmode_reply(struct sk_buff *skb);
2765 * cfg80211_testmode_alloc_event_skb - allocate testmode event
2767 * @approxlen: an upper bound of the length of the data that will
2768 * be put into the skb
2769 * @gfp: allocation flags
2771 * This function allocates and pre-fills an skb for an event on the
2772 * testmode multicast group.
2774 * The returned skb (or %NULL if any errors happen) is set up in the
2775 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
2776 * for an event. As there, you should simply add data to it that will
2777 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
2778 * not modify the skb in any other way.
2780 * When done filling the skb, call cfg80211_testmode_event() with the
2781 * skb to send the event.
2783 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
2784 int approxlen, gfp_t gfp);
2787 * cfg80211_testmode_event - send the event
2788 * @skb: The skb, must have been allocated with
2789 * cfg80211_testmode_alloc_event_skb()
2790 * @gfp: allocation flags
2792 * This function sends the given @skb, which must have been allocated
2793 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
2796 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
2798 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
2799 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
2801 #define CFG80211_TESTMODE_CMD(cmd)
2802 #define CFG80211_TESTMODE_DUMP(cmd)
2806 * cfg80211_connect_result - notify cfg80211 of connection result
2808 * @dev: network device
2809 * @bssid: the BSSID of the AP
2810 * @req_ie: association request IEs (maybe be %NULL)
2811 * @req_ie_len: association request IEs length
2812 * @resp_ie: association response IEs (may be %NULL)
2813 * @resp_ie_len: assoc response IEs length
2814 * @status: status code, 0 for successful connection, use
2815 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
2816 * the real status code for failures.
2817 * @gfp: allocation flags
2819 * It should be called by the underlying driver whenever connect() has
2822 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
2823 const u8 *req_ie, size_t req_ie_len,
2824 const u8 *resp_ie, size_t resp_ie_len,
2825 u16 status, gfp_t gfp);
2828 * cfg80211_roamed - notify cfg80211 of roaming
2830 * @dev: network device
2831 * @channel: the channel of the new AP
2832 * @bssid: the BSSID of the new AP
2833 * @req_ie: association request IEs (maybe be %NULL)
2834 * @req_ie_len: association request IEs length
2835 * @resp_ie: association response IEs (may be %NULL)
2836 * @resp_ie_len: assoc response IEs length
2837 * @gfp: allocation flags
2839 * It should be called by the underlying driver whenever it roamed
2840 * from one AP to another while connected.
2842 void cfg80211_roamed(struct net_device *dev,
2843 struct ieee80211_channel *channel,
2845 const u8 *req_ie, size_t req_ie_len,
2846 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
2849 * cfg80211_disconnected - notify cfg80211 that connection was dropped
2851 * @dev: network device
2852 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
2853 * @ie_len: length of IEs
2854 * @reason: reason code for the disconnection, set it to 0 if unknown
2855 * @gfp: allocation flags
2857 * After it calls this function, the driver should enter an idle state
2858 * and not try to connect to any AP any more.
2860 void cfg80211_disconnected(struct net_device *dev, u16 reason,
2861 u8 *ie, size_t ie_len, gfp_t gfp);
2864 * cfg80211_ready_on_channel - notification of remain_on_channel start
2865 * @dev: network device
2866 * @cookie: the request cookie
2867 * @chan: The current channel (from remain_on_channel request)
2868 * @channel_type: Channel type
2869 * @duration: Duration in milliseconds that the driver intents to remain on the
2871 * @gfp: allocation flags
2873 void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
2874 struct ieee80211_channel *chan,
2875 enum nl80211_channel_type channel_type,
2876 unsigned int duration, gfp_t gfp);
2879 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
2880 * @dev: network device
2881 * @cookie: the request cookie
2882 * @chan: The current channel (from remain_on_channel request)
2883 * @channel_type: Channel type
2884 * @gfp: allocation flags
2886 void cfg80211_remain_on_channel_expired(struct net_device *dev,
2888 struct ieee80211_channel *chan,
2889 enum nl80211_channel_type channel_type,
2894 * cfg80211_new_sta - notify userspace about station
2897 * @mac_addr: the station's address
2898 * @sinfo: the station information
2899 * @gfp: allocation flags
2901 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
2902 struct station_info *sinfo, gfp_t gfp);
2905 * cfg80211_del_sta - notify userspace about deletion of a station
2908 * @mac_addr: the station's address
2909 * @gfp: allocation flags
2911 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
2914 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
2915 * @dev: network device
2916 * @freq: Frequency on which the frame was received in MHz
2917 * @buf: Management frame (header + body)
2918 * @len: length of the frame data
2919 * @gfp: context flags
2921 * Returns %true if a user space application has registered for this frame.
2922 * For action frames, that makes it responsible for rejecting unrecognized
2923 * action frames; %false otherwise, in which case for action frames the
2924 * driver is responsible for rejecting the frame.
2926 * This function is called whenever an Action frame is received for a station
2927 * mode interface, but is not processed in kernel.
2929 bool cfg80211_rx_mgmt(struct net_device *dev, int freq, const u8 *buf,
2930 size_t len, gfp_t gfp);
2933 * cfg80211_mgmt_tx_status - notification of TX status for management frame
2934 * @dev: network device
2935 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
2936 * @buf: Management frame (header + body)
2937 * @len: length of the frame data
2938 * @ack: Whether frame was acknowledged
2939 * @gfp: context flags
2941 * This function is called whenever a management frame was requested to be
2942 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
2943 * transmission attempt.
2945 void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
2946 const u8 *buf, size_t len, bool ack, gfp_t gfp);
2950 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
2951 * @dev: network device
2952 * @rssi_event: the triggered RSSI event
2953 * @gfp: context flags
2955 * This function is called when a configured connection quality monitoring
2956 * rssi threshold reached event occurs.
2958 void cfg80211_cqm_rssi_notify(struct net_device *dev,
2959 enum nl80211_cqm_rssi_threshold_event rssi_event,
2963 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
2964 * @dev: network device
2965 * @peer: peer's MAC address
2966 * @num_packets: how many packets were lost -- should be a fixed threshold
2967 * but probably no less than maybe 50, or maybe a throughput dependent
2968 * threshold (to account for temporary interference)
2969 * @gfp: context flags
2971 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
2972 const u8 *peer, u32 num_packets, gfp_t gfp);
2975 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
2976 * @dev: network device
2977 * @bssid: BSSID of AP (to avoid races)
2978 * @replay_ctr: new replay counter
2979 * @gfp: allocation flags
2981 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
2982 const u8 *replay_ctr, gfp_t gfp);
2984 /* Logging, debugging and troubleshooting/diagnostic helpers. */
2986 /* wiphy_printk helpers, similar to dev_printk */
2988 #define wiphy_printk(level, wiphy, format, args...) \
2989 dev_printk(level, &(wiphy)->dev, format, ##args)
2990 #define wiphy_emerg(wiphy, format, args...) \
2991 dev_emerg(&(wiphy)->dev, format, ##args)
2992 #define wiphy_alert(wiphy, format, args...) \
2993 dev_alert(&(wiphy)->dev, format, ##args)
2994 #define wiphy_crit(wiphy, format, args...) \
2995 dev_crit(&(wiphy)->dev, format, ##args)
2996 #define wiphy_err(wiphy, format, args...) \
2997 dev_err(&(wiphy)->dev, format, ##args)
2998 #define wiphy_warn(wiphy, format, args...) \
2999 dev_warn(&(wiphy)->dev, format, ##args)
3000 #define wiphy_notice(wiphy, format, args...) \
3001 dev_notice(&(wiphy)->dev, format, ##args)
3002 #define wiphy_info(wiphy, format, args...) \
3003 dev_info(&(wiphy)->dev, format, ##args)
3005 #define wiphy_debug(wiphy, format, args...) \
3006 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3008 #define wiphy_dbg(wiphy, format, args...) \
3009 dev_dbg(&(wiphy)->dev, format, ##args)
3011 #if defined(VERBOSE_DEBUG)
3012 #define wiphy_vdbg wiphy_dbg
3014 #define wiphy_vdbg(wiphy, format, args...) \
3017 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3023 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3024 * of using a WARN/WARN_ON to get the message out, including the
3025 * file/line information and a backtrace.
3027 #define wiphy_WARN(wiphy, format, args...) \
3028 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3030 #endif /* __NET_CFG80211_H */