1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
4 * 802.11 device and configuration interface
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/netlink.h>
17 #include <linux/skbuff.h>
18 #include <linux/nl80211.h>
19 #include <linux/if_ether.h>
20 #include <linux/ieee80211.h>
21 #include <net/regulatory.h>
23 /* remove once we remove the wext stuff */
24 #include <net/iw_handler.h>
25 #include <linux/wireless.h>
31 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
32 * userspace and drivers, and offers some utility functionality associated
33 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
34 * by all modern wireless drivers in Linux, so that they offer a consistent
35 * API through nl80211. For backward compatibility, cfg80211 also offers
36 * wireless extensions to userspace, but hides them from drivers completely.
38 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
44 * DOC: Device registration
46 * In order for a driver to use cfg80211, it must register the hardware device
47 * with cfg80211. This happens through a number of hardware capability structs
50 * The fundamental structure for each device is the 'wiphy', of which each
51 * instance describes a physical wireless device connected to the system. Each
52 * such wiphy can have zero, one, or many virtual interfaces associated with
53 * it, which need to be identified as such by pointing the network interface's
54 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
55 * the wireless part of the interface, normally this struct is embedded in the
56 * network interface's private data area. Drivers can optionally allow creating
57 * or destroying virtual interfaces on the fly, but without at least one or the
58 * ability to create some the wireless device isn't useful.
60 * Each wiphy structure contains device capability information, and also has
61 * a pointer to the various operations the driver offers. The definitions and
62 * structures here describe these capabilities in detail.
66 * wireless hardware capability structures
70 * enum ieee80211_band - supported frequency bands
72 * The bands are assigned this way because the supported
73 * bitrates differ in these bands.
75 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
76 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
77 * @IEEE80211_NUM_BANDS: number of defined bands
80 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
81 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
88 * enum ieee80211_channel_flags - channel flags
90 * Channel flags set by the regulatory control code.
92 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
93 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
95 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
96 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
97 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
99 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
102 enum ieee80211_channel_flags {
103 IEEE80211_CHAN_DISABLED = 1<<0,
104 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
105 IEEE80211_CHAN_NO_IBSS = 1<<2,
106 IEEE80211_CHAN_RADAR = 1<<3,
107 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
108 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
111 #define IEEE80211_CHAN_NO_HT40 \
112 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
115 * struct ieee80211_channel - channel definition
117 * This structure describes a single channel for use
120 * @center_freq: center frequency in MHz
121 * @hw_value: hardware-specific value for the channel
122 * @flags: channel flags from &enum ieee80211_channel_flags.
123 * @orig_flags: channel flags at registration time, used by regulatory
124 * code to support devices with additional restrictions
125 * @band: band this channel belongs to.
126 * @max_antenna_gain: maximum antenna gain in dBi
127 * @max_power: maximum transmission power (in dBm)
128 * @beacon_found: helper to regulatory code to indicate when a beacon
129 * has been found on this channel. Use regulatory_hint_found_beacon()
130 * to enable this, this is useful only on 5 GHz band.
131 * @orig_mag: internal use
132 * @orig_mpwr: internal use
134 struct ieee80211_channel {
135 enum ieee80211_band band;
139 int max_antenna_gain;
143 int orig_mag, orig_mpwr;
147 * enum ieee80211_rate_flags - rate flags
149 * Hardware/specification flags for rates. These are structured
150 * in a way that allows using the same bitrate structure for
151 * different bands/PHY modes.
153 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
154 * preamble on this bitrate; only relevant in 2.4GHz band and
156 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
157 * when used with 802.11a (on the 5 GHz band); filled by the
158 * core code when registering the wiphy.
159 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
160 * when used with 802.11b (on the 2.4 GHz band); filled by the
161 * core code when registering the wiphy.
162 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
163 * when used with 802.11g (on the 2.4 GHz band); filled by the
164 * core code when registering the wiphy.
165 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
167 enum ieee80211_rate_flags {
168 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
169 IEEE80211_RATE_MANDATORY_A = 1<<1,
170 IEEE80211_RATE_MANDATORY_B = 1<<2,
171 IEEE80211_RATE_MANDATORY_G = 1<<3,
172 IEEE80211_RATE_ERP_G = 1<<4,
176 * struct ieee80211_rate - bitrate definition
178 * This structure describes a bitrate that an 802.11 PHY can
179 * operate with. The two values @hw_value and @hw_value_short
180 * are only for driver use when pointers to this structure are
183 * @flags: rate-specific flags
184 * @bitrate: bitrate in units of 100 Kbps
185 * @hw_value: driver/hardware value for this rate
186 * @hw_value_short: driver/hardware value for this rate when
187 * short preamble is used
189 struct ieee80211_rate {
192 u16 hw_value, hw_value_short;
196 * struct ieee80211_sta_ht_cap - STA's HT capabilities
198 * This structure describes most essential parameters needed
199 * to describe 802.11n HT capabilities for an STA.
201 * @ht_supported: is HT supported by the STA
202 * @cap: HT capabilities map as described in 802.11n spec
203 * @ampdu_factor: Maximum A-MPDU length factor
204 * @ampdu_density: Minimum A-MPDU spacing
205 * @mcs: Supported MCS rates
207 struct ieee80211_sta_ht_cap {
208 u16 cap; /* use IEEE80211_HT_CAP_ */
212 struct ieee80211_mcs_info mcs;
216 * struct ieee80211_supported_band - frequency band definition
218 * This structure describes a frequency band a wiphy
219 * is able to operate in.
221 * @channels: Array of channels the hardware can operate in
223 * @band: the band this structure represents
224 * @n_channels: Number of channels in @channels
225 * @bitrates: Array of bitrates the hardware can operate with
226 * in this band. Must be sorted to give a valid "supported
227 * rates" IE, i.e. CCK rates first, then OFDM.
228 * @n_bitrates: Number of bitrates in @bitrates
229 * @ht_cap: HT capabilities in this band
231 struct ieee80211_supported_band {
232 struct ieee80211_channel *channels;
233 struct ieee80211_rate *bitrates;
234 enum ieee80211_band band;
237 struct ieee80211_sta_ht_cap ht_cap;
241 * Wireless hardware/device configuration structures and methods
245 * DOC: Actions and configuration
247 * Each wireless device and each virtual interface offer a set of configuration
248 * operations and other actions that are invoked by userspace. Each of these
249 * actions is described in the operations structure, and the parameters these
250 * operations use are described separately.
252 * Additionally, some operations are asynchronous and expect to get status
253 * information via some functions that drivers need to call.
255 * Scanning and BSS list handling with its associated functionality is described
256 * in a separate chapter.
260 * struct vif_params - describes virtual interface parameters
261 * @use_4addr: use 4-address frames
268 * struct key_params - key information
270 * Information about a key
273 * @key_len: length of key material
274 * @cipher: cipher suite selector
275 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
276 * with the get_key() callback, must be in little endian,
277 * length given by @seq_len.
278 * @seq_len: length of @seq.
289 * enum survey_info_flags - survey information flags
291 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
292 * @SURVEY_INFO_IN_USE: channel is currently being used
293 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
294 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
295 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
296 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
297 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
299 * Used by the driver to indicate which info in &struct survey_info
300 * it has filled in during the get_survey().
302 enum survey_info_flags {
303 SURVEY_INFO_NOISE_DBM = 1<<0,
304 SURVEY_INFO_IN_USE = 1<<1,
305 SURVEY_INFO_CHANNEL_TIME = 1<<2,
306 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
307 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
308 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
309 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
313 * struct survey_info - channel survey response
315 * @channel: the channel this survey record reports, mandatory
316 * @filled: bitflag of flags from &enum survey_info_flags
317 * @noise: channel noise in dBm. This and all following fields are
319 * @channel_time: amount of time in ms the radio spent on the channel
320 * @channel_time_busy: amount of time the primary channel was sensed busy
321 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
322 * @channel_time_rx: amount of time the radio spent receiving data
323 * @channel_time_tx: amount of time the radio spent transmitting data
325 * Used by dump_survey() to report back per-channel survey information.
327 * This structure can later be expanded with things like
328 * channel duty cycle etc.
331 struct ieee80211_channel *channel;
333 u64 channel_time_busy;
334 u64 channel_time_ext_busy;
342 * struct beacon_parameters - beacon parameters
344 * Used to configure the beacon for an interface.
346 * @head: head portion of beacon (before TIM IE)
347 * or %NULL if not changed
348 * @tail: tail portion of beacon (after TIM IE)
349 * or %NULL if not changed
350 * @interval: beacon interval or zero if not changed
351 * @dtim_period: DTIM period or zero if not changed
352 * @head_len: length of @head
353 * @tail_len: length of @tail
355 struct beacon_parameters {
357 int interval, dtim_period;
358 int head_len, tail_len;
362 * enum plink_action - actions to perform in mesh peers
364 * @PLINK_ACTION_INVALID: action 0 is reserved
365 * @PLINK_ACTION_OPEN: start mesh peer link establishment
366 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
369 PLINK_ACTION_INVALID,
375 * struct station_parameters - station parameters
377 * Used to change and create a new station.
379 * @vlan: vlan interface station should belong to
380 * @supported_rates: supported rates in IEEE 802.11 format
381 * (or NULL for no change)
382 * @supported_rates_len: number of supported rates
383 * @sta_flags_mask: station flags that changed
384 * (bitmask of BIT(NL80211_STA_FLAG_...))
385 * @sta_flags_set: station flags values
386 * (bitmask of BIT(NL80211_STA_FLAG_...))
387 * @listen_interval: listen interval or -1 for no change
388 * @aid: AID or zero for no change
389 * @plink_action: plink action to take
390 * @plink_state: set the peer link state for a station
391 * @ht_capa: HT capabilities of station
393 struct station_parameters {
395 struct net_device *vlan;
396 u32 sta_flags_mask, sta_flags_set;
399 u8 supported_rates_len;
402 struct ieee80211_ht_cap *ht_capa;
406 * enum station_info_flags - station information flags
408 * Used by the driver to indicate which info in &struct station_info
409 * it has filled in during get_station() or dump_station().
411 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
412 * @STATION_INFO_RX_BYTES: @rx_bytes filled
413 * @STATION_INFO_TX_BYTES: @tx_bytes filled
414 * @STATION_INFO_LLID: @llid filled
415 * @STATION_INFO_PLID: @plid filled
416 * @STATION_INFO_PLINK_STATE: @plink_state filled
417 * @STATION_INFO_SIGNAL: @signal filled
418 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
419 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
420 * @STATION_INFO_RX_PACKETS: @rx_packets filled
421 * @STATION_INFO_TX_PACKETS: @tx_packets filled
422 * @STATION_INFO_TX_RETRIES: @tx_retries filled
423 * @STATION_INFO_TX_FAILED: @tx_failed filled
424 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
425 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
426 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
427 * @STATION_INFO_BSS_PARAM: @bss_param filled
428 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
430 enum station_info_flags {
431 STATION_INFO_INACTIVE_TIME = 1<<0,
432 STATION_INFO_RX_BYTES = 1<<1,
433 STATION_INFO_TX_BYTES = 1<<2,
434 STATION_INFO_LLID = 1<<3,
435 STATION_INFO_PLID = 1<<4,
436 STATION_INFO_PLINK_STATE = 1<<5,
437 STATION_INFO_SIGNAL = 1<<6,
438 STATION_INFO_TX_BITRATE = 1<<7,
439 STATION_INFO_RX_PACKETS = 1<<8,
440 STATION_INFO_TX_PACKETS = 1<<9,
441 STATION_INFO_TX_RETRIES = 1<<10,
442 STATION_INFO_TX_FAILED = 1<<11,
443 STATION_INFO_RX_DROP_MISC = 1<<12,
444 STATION_INFO_SIGNAL_AVG = 1<<13,
445 STATION_INFO_RX_BITRATE = 1<<14,
446 STATION_INFO_BSS_PARAM = 1<<15,
447 STATION_INFO_CONNECTED_TIME = 1<<16
451 * enum station_info_rate_flags - bitrate info flags
453 * Used by the driver to indicate the specific rate transmission
454 * type for 802.11n transmissions.
456 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
457 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
458 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
460 enum rate_info_flags {
461 RATE_INFO_FLAGS_MCS = 1<<0,
462 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
463 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
467 * struct rate_info - bitrate information
469 * Information about a receiving or transmitting bitrate
471 * @flags: bitflag of flags from &enum rate_info_flags
472 * @mcs: mcs index if struct describes a 802.11n bitrate
473 * @legacy: bitrate in 100kbit/s for 802.11abg
482 * enum station_info_rate_flags - bitrate info flags
484 * Used by the driver to indicate the specific rate transmission
485 * type for 802.11n transmissions.
487 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
488 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
489 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
491 enum bss_param_flags {
492 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
493 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
494 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
498 * struct sta_bss_parameters - BSS parameters for the attached station
500 * Information about the currently associated BSS
502 * @flags: bitflag of flags from &enum bss_param_flags
503 * @dtim_period: DTIM period for the BSS
504 * @beacon_interval: beacon interval
506 struct sta_bss_parameters {
513 * struct station_info - station information
515 * Station information filled by driver for get_station() and dump_station.
517 * @filled: bitflag of flags from &enum station_info_flags
518 * @connected_time: time(in secs) since a station is last connected
519 * @inactive_time: time since last station activity (tx/rx) in milliseconds
520 * @rx_bytes: bytes received from this station
521 * @tx_bytes: bytes transmitted to this station
522 * @llid: mesh local link id
523 * @plid: mesh peer link id
524 * @plink_state: mesh peer link state
525 * @signal: signal strength of last received packet in dBm
526 * @signal_avg: signal strength average in dBm
527 * @txrate: current unicast bitrate from this station
528 * @rxrate: current unicast bitrate to this station
529 * @rx_packets: packets received from this station
530 * @tx_packets: packets transmitted to this station
531 * @tx_retries: cumulative retry counts
532 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
533 * @rx_dropped_misc: Dropped for un-specified reason.
534 * @bss_param: current BSS parameters
535 * @generation: generation number for nl80211 dumps.
536 * This number should increase every time the list of stations
537 * changes, i.e. when a station is added or removed, so that
538 * userspace can tell whether it got a consistent snapshot.
539 * @assoc_req_ies: IEs from (Re)Association Request.
540 * This is used only when in AP mode with drivers that do not use
541 * user space MLME/SME implementation. The information is provided for
542 * the cfg80211_new_sta() calls to notify user space of the IEs.
543 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
545 struct station_info {
556 struct rate_info txrate;
557 struct rate_info rxrate;
563 struct sta_bss_parameters bss_param;
567 const u8 *assoc_req_ies;
568 size_t assoc_req_ies_len;
571 * Note: Add a new enum station_info_flags value for each new field and
572 * use it to check which fields are initialized.
577 * enum monitor_flags - monitor flags
579 * Monitor interface configuration flags. Note that these must be the bits
580 * according to the nl80211 flags.
582 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
583 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
584 * @MONITOR_FLAG_CONTROL: pass control frames
585 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
586 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
589 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
590 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
591 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
592 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
593 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
597 * enum mpath_info_flags - mesh path information flags
599 * Used by the driver to indicate which info in &struct mpath_info it has filled
600 * in during get_station() or dump_station().
602 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
603 * @MPATH_INFO_SN: @sn filled
604 * @MPATH_INFO_METRIC: @metric filled
605 * @MPATH_INFO_EXPTIME: @exptime filled
606 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
607 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
608 * @MPATH_INFO_FLAGS: @flags filled
610 enum mpath_info_flags {
611 MPATH_INFO_FRAME_QLEN = BIT(0),
612 MPATH_INFO_SN = BIT(1),
613 MPATH_INFO_METRIC = BIT(2),
614 MPATH_INFO_EXPTIME = BIT(3),
615 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
616 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
617 MPATH_INFO_FLAGS = BIT(6),
621 * struct mpath_info - mesh path information
623 * Mesh path information filled by driver for get_mpath() and dump_mpath().
625 * @filled: bitfield of flags from &enum mpath_info_flags
626 * @frame_qlen: number of queued frames for this destination
627 * @sn: target sequence number
628 * @metric: metric (cost) of this mesh path
629 * @exptime: expiration time for the mesh path from now, in msecs
630 * @flags: mesh path flags
631 * @discovery_timeout: total mesh path discovery timeout, in msecs
632 * @discovery_retries: mesh path discovery retries
633 * @generation: generation number for nl80211 dumps.
634 * This number should increase every time the list of mesh paths
635 * changes, i.e. when a station is added or removed, so that
636 * userspace can tell whether it got a consistent snapshot.
644 u32 discovery_timeout;
645 u8 discovery_retries;
652 * struct bss_parameters - BSS parameters
654 * Used to change BSS parameters (mainly for AP mode).
656 * @use_cts_prot: Whether to use CTS protection
657 * (0 = no, 1 = yes, -1 = do not change)
658 * @use_short_preamble: Whether the use of short preambles is allowed
659 * (0 = no, 1 = yes, -1 = do not change)
660 * @use_short_slot_time: Whether the use of short slot time is allowed
661 * (0 = no, 1 = yes, -1 = do not change)
662 * @basic_rates: basic rates in IEEE 802.11 format
663 * (or NULL for no change)
664 * @basic_rates_len: number of basic rates
665 * @ap_isolate: do not forward packets between connected stations
666 * @ht_opmode: HT Operation mode
667 * (u16 = opmode, -1 = do not change)
669 struct bss_parameters {
671 int use_short_preamble;
672 int use_short_slot_time;
680 * struct mesh_config - 802.11s mesh configuration
682 * These parameters can be changed while the mesh is active.
686 /* Mesh plink management parameters */
687 u16 dot11MeshRetryTimeout;
688 u16 dot11MeshConfirmTimeout;
689 u16 dot11MeshHoldingTimeout;
690 u16 dot11MeshMaxPeerLinks;
691 u8 dot11MeshMaxRetries;
693 /* ttl used in path selection information elements */
695 bool auto_open_plinks;
696 /* HWMP parameters */
697 u8 dot11MeshHWMPmaxPREQretries;
698 u32 path_refresh_time;
699 u16 min_discovery_timeout;
700 u32 dot11MeshHWMPactivePathTimeout;
701 u16 dot11MeshHWMPpreqMinInterval;
702 u16 dot11MeshHWMPnetDiameterTraversalTime;
703 u8 dot11MeshHWMPRootMode;
707 * struct mesh_setup - 802.11s mesh setup configuration
708 * @mesh_id: the mesh ID
709 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
710 * @path_sel_proto: which path selection protocol to use
711 * @path_metric: which metric to use
712 * @ie: vendor information elements (optional)
713 * @ie_len: length of vendor information elements
714 * @is_authenticated: this mesh requires authentication
715 * @is_secure: this mesh uses security
717 * These parameters are fixed when the mesh is created.
726 bool is_authenticated;
731 * struct ieee80211_txq_params - TX queue parameters
732 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
733 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
734 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
736 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
738 * @aifs: Arbitration interframe space [0..255]
740 struct ieee80211_txq_params {
741 enum nl80211_txq_q queue;
748 /* from net/wireless.h */
752 * DOC: Scanning and BSS list handling
754 * The scanning process itself is fairly simple, but cfg80211 offers quite
755 * a bit of helper functionality. To start a scan, the scan operation will
756 * be invoked with a scan definition. This scan definition contains the
757 * channels to scan, and the SSIDs to send probe requests for (including the
758 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
759 * probe. Additionally, a scan request may contain extra information elements
760 * that should be added to the probe request. The IEs are guaranteed to be
761 * well-formed, and will not exceed the maximum length the driver advertised
762 * in the wiphy structure.
764 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
765 * it is responsible for maintaining the BSS list; the driver should not
766 * maintain a list itself. For this notification, various functions exist.
768 * Since drivers do not maintain a BSS list, there are also a number of
769 * functions to search for a BSS and obtain information about it from the
770 * BSS structure cfg80211 maintains. The BSS list is also made available
775 * struct cfg80211_ssid - SSID description
777 * @ssid_len: length of the ssid
779 struct cfg80211_ssid {
780 u8 ssid[IEEE80211_MAX_SSID_LEN];
785 * struct cfg80211_scan_request - scan request description
787 * @ssids: SSIDs to scan for (active scan only)
788 * @n_ssids: number of SSIDs
789 * @channels: channels to scan on.
790 * @n_channels: total number of channels to scan
791 * @ie: optional information element(s) to add into Probe Request or %NULL
792 * @ie_len: length of ie in octets
793 * @wiphy: the wiphy this was for
794 * @dev: the interface
795 * @aborted: (internal) scan request was notified as aborted
797 struct cfg80211_scan_request {
798 struct cfg80211_ssid *ssids;
806 struct net_device *dev;
810 struct ieee80211_channel *channels[0];
814 * struct cfg80211_sched_scan_request - scheduled scan request description
816 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
817 * @n_ssids: number of SSIDs
818 * @n_channels: total number of channels to scan
819 * @interval: interval between each scheduled scan cycle
820 * @ie: optional information element(s) to add into Probe Request or %NULL
821 * @ie_len: length of ie in octets
822 * @wiphy: the wiphy this was for
823 * @dev: the interface
824 * @channels: channels to scan
826 struct cfg80211_sched_scan_request {
827 struct cfg80211_ssid *ssids;
836 struct net_device *dev;
839 struct ieee80211_channel *channels[0];
843 * enum cfg80211_signal_type - signal type
845 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
846 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
847 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
849 enum cfg80211_signal_type {
850 CFG80211_SIGNAL_TYPE_NONE,
851 CFG80211_SIGNAL_TYPE_MBM,
852 CFG80211_SIGNAL_TYPE_UNSPEC,
856 * struct cfg80211_bss - BSS description
858 * This structure describes a BSS (which may also be a mesh network)
859 * for use in scan results and similar.
861 * @channel: channel this BSS is on
862 * @bssid: BSSID of the BSS
863 * @tsf: timestamp of last received update
864 * @beacon_interval: the beacon interval as from the frame
865 * @capability: the capability field in host byte order
866 * @information_elements: the information elements (Note that there
867 * is no guarantee that these are well-formed!); this is a pointer to
868 * either the beacon_ies or proberesp_ies depending on whether Probe
869 * Response frame has been received
870 * @len_information_elements: total length of the information elements
871 * @beacon_ies: the information elements from the last Beacon frame
872 * @len_beacon_ies: total length of the beacon_ies
873 * @proberesp_ies: the information elements from the last Probe Response frame
874 * @len_proberesp_ies: total length of the proberesp_ies
875 * @signal: signal strength value (type depends on the wiphy's signal_type)
876 * @free_priv: function pointer to free private data
877 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
879 struct cfg80211_bss {
880 struct ieee80211_channel *channel;
886 u8 *information_elements;
887 size_t len_information_elements;
889 size_t len_beacon_ies;
891 size_t len_proberesp_ies;
895 void (*free_priv)(struct cfg80211_bss *bss);
896 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
900 * ieee80211_bss_get_ie - find IE with given ID
901 * @bss: the bss to search
903 * Returns %NULL if not found.
905 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
909 * struct cfg80211_crypto_settings - Crypto settings
910 * @wpa_versions: indicates which, if any, WPA versions are enabled
911 * (from enum nl80211_wpa_versions)
912 * @cipher_group: group key cipher suite (or 0 if unset)
913 * @n_ciphers_pairwise: number of AP supported unicast ciphers
914 * @ciphers_pairwise: unicast key cipher suites
915 * @n_akm_suites: number of AKM suites
916 * @akm_suites: AKM suites
917 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
918 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
919 * required to assume that the port is unauthorized until authorized by
920 * user space. Otherwise, port is marked authorized by default.
921 * @control_port_ethertype: the control port protocol that should be
922 * allowed through even on unauthorized ports
923 * @control_port_no_encrypt: TRUE to prevent encryption of control port
926 struct cfg80211_crypto_settings {
929 int n_ciphers_pairwise;
930 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
932 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
934 __be16 control_port_ethertype;
935 bool control_port_no_encrypt;
939 * struct cfg80211_auth_request - Authentication request data
941 * This structure provides information needed to complete IEEE 802.11
944 * @bss: The BSS to authenticate with.
945 * @auth_type: Authentication type (algorithm)
946 * @ie: Extra IEs to add to Authentication frame or %NULL
947 * @ie_len: Length of ie buffer in octets
948 * @key_len: length of WEP key for shared key authentication
949 * @key_idx: index of WEP key for shared key authentication
950 * @key: WEP key for shared key authentication
951 * @local_state_change: This is a request for a local state only, i.e., no
952 * Authentication frame is to be transmitted and authentication state is
953 * to be changed without having to wait for a response from the peer STA
956 struct cfg80211_auth_request {
957 struct cfg80211_bss *bss;
960 enum nl80211_auth_type auth_type;
963 bool local_state_change;
967 * struct cfg80211_assoc_request - (Re)Association request data
969 * This structure provides information needed to complete IEEE 802.11
971 * @bss: The BSS to associate with.
972 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
973 * @ie_len: Length of ie buffer in octets
974 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
975 * @crypto: crypto settings
976 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
978 struct cfg80211_assoc_request {
979 struct cfg80211_bss *bss;
980 const u8 *ie, *prev_bssid;
982 struct cfg80211_crypto_settings crypto;
987 * struct cfg80211_deauth_request - Deauthentication request data
989 * This structure provides information needed to complete IEEE 802.11
992 * @bss: the BSS to deauthenticate from
993 * @ie: Extra IEs to add to Deauthentication frame or %NULL
994 * @ie_len: Length of ie buffer in octets
995 * @reason_code: The reason code for the deauthentication
996 * @local_state_change: This is a request for a local state only, i.e., no
997 * Deauthentication frame is to be transmitted.
999 struct cfg80211_deauth_request {
1000 struct cfg80211_bss *bss;
1004 bool local_state_change;
1008 * struct cfg80211_disassoc_request - Disassociation request data
1010 * This structure provides information needed to complete IEEE 802.11
1013 * @bss: the BSS to disassociate from
1014 * @ie: Extra IEs to add to Disassociation frame or %NULL
1015 * @ie_len: Length of ie buffer in octets
1016 * @reason_code: The reason code for the disassociation
1017 * @local_state_change: This is a request for a local state only, i.e., no
1018 * Disassociation frame is to be transmitted.
1020 struct cfg80211_disassoc_request {
1021 struct cfg80211_bss *bss;
1025 bool local_state_change;
1029 * struct cfg80211_ibss_params - IBSS parameters
1031 * This structure defines the IBSS parameters for the join_ibss()
1034 * @ssid: The SSID, will always be non-null.
1035 * @ssid_len: The length of the SSID, will always be non-zero.
1036 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1037 * search for IBSSs with a different BSSID.
1038 * @channel: The channel to use if no IBSS can be found to join.
1039 * @channel_fixed: The channel should be fixed -- do not search for
1040 * IBSSs to join on other channels.
1041 * @ie: information element(s) to include in the beacon
1042 * @ie_len: length of that
1043 * @beacon_interval: beacon interval to use
1044 * @privacy: this is a protected network, keys will be configured
1046 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1047 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1049 struct cfg80211_ibss_params {
1052 struct ieee80211_channel *channel;
1054 u8 ssid_len, ie_len;
1055 u16 beacon_interval;
1059 int mcast_rate[IEEE80211_NUM_BANDS];
1063 * struct cfg80211_connect_params - Connection parameters
1065 * This structure provides information needed to complete IEEE 802.11
1066 * authentication and association.
1068 * @channel: The channel to use or %NULL if not specified (auto-select based
1070 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1073 * @ssid_len: Length of ssid in octets
1074 * @auth_type: Authentication type (algorithm)
1075 * @ie: IEs for association request
1076 * @ie_len: Length of assoc_ie in octets
1077 * @privacy: indicates whether privacy-enabled APs should be used
1078 * @crypto: crypto settings
1079 * @key_len: length of WEP key for shared key authentication
1080 * @key_idx: index of WEP key for shared key authentication
1081 * @key: WEP key for shared key authentication
1083 struct cfg80211_connect_params {
1084 struct ieee80211_channel *channel;
1088 enum nl80211_auth_type auth_type;
1092 struct cfg80211_crypto_settings crypto;
1094 u8 key_len, key_idx;
1098 * enum wiphy_params_flags - set_wiphy_params bitfield values
1099 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1100 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1101 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1102 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1103 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1105 enum wiphy_params_flags {
1106 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1107 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1108 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1109 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1110 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1114 * cfg80211_bitrate_mask - masks for bitrate control
1116 struct cfg80211_bitrate_mask {
1119 /* TODO: add support for masking MCS rates; e.g.: */
1120 /* u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; */
1121 } control[IEEE80211_NUM_BANDS];
1124 * struct cfg80211_pmksa - PMK Security Association
1126 * This structure is passed to the set/del_pmksa() method for PMKSA
1129 * @bssid: The AP's BSSID.
1130 * @pmkid: The PMK material itself.
1132 struct cfg80211_pmksa {
1138 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1139 * @mask: bitmask where to match pattern and where to ignore bytes,
1140 * one bit per byte, in same format as nl80211
1141 * @pattern: bytes to match where bitmask is 1
1142 * @pattern_len: length of pattern (in bytes)
1144 * Internal note: @mask and @pattern are allocated in one chunk of
1145 * memory, free @mask only!
1147 struct cfg80211_wowlan_trig_pkt_pattern {
1153 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1155 * This structure defines the enabled WoWLAN triggers for the device.
1156 * @any: wake up on any activity -- special trigger if device continues
1157 * operating as normal during suspend
1158 * @disconnect: wake up if getting disconnected
1159 * @magic_pkt: wake up on receiving magic packet
1160 * @patterns: wake up on receiving packet matching a pattern
1161 * @n_patterns: number of patterns
1163 struct cfg80211_wowlan {
1164 bool any, disconnect, magic_pkt;
1165 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1170 * struct cfg80211_ops - backend description for wireless configuration
1172 * This struct is registered by fullmac card drivers and/or wireless stacks
1173 * in order to handle configuration requests on their interfaces.
1175 * All callbacks except where otherwise noted should return 0
1176 * on success or a negative error code.
1178 * All operations are currently invoked under rtnl for consistency with the
1179 * wireless extensions but this is subject to reevaluation as soon as this
1180 * code is used more widely and we have a first user without wext.
1182 * @suspend: wiphy device needs to be suspended. The variable @wow will
1183 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1184 * configured for the device.
1185 * @resume: wiphy device needs to be resumed
1187 * @add_virtual_intf: create a new virtual interface with the given name,
1188 * must set the struct wireless_dev's iftype. Beware: You must create
1189 * the new netdev in the wiphy's network namespace! Returns the netdev,
1192 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1194 * @change_virtual_intf: change type/configuration of virtual interface,
1195 * keep the struct wireless_dev's iftype updated.
1197 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1198 * when adding a group key.
1200 * @get_key: get information about the key with the given parameters.
1201 * @mac_addr will be %NULL when requesting information for a group
1202 * key. All pointers given to the @callback function need not be valid
1203 * after it returns. This function should return an error if it is
1204 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1206 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1207 * and @key_index, return -ENOENT if the key doesn't exist.
1209 * @set_default_key: set the default key on an interface
1211 * @set_default_mgmt_key: set the default management frame key on an interface
1213 * @add_beacon: Add a beacon with given parameters, @head, @interval
1214 * and @dtim_period will be valid, @tail is optional.
1215 * @set_beacon: Change the beacon parameters for an access point mode
1216 * interface. This should reject the call when no beacon has been
1218 * @del_beacon: Remove beacon configuration and stop sending the beacon.
1220 * @add_station: Add a new station.
1221 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1222 * @change_station: Modify a given station.
1223 * @get_station: get station information for the station identified by @mac
1224 * @dump_station: dump station callback -- resume dump at index @idx
1226 * @add_mpath: add a fixed mesh path
1227 * @del_mpath: delete a given mesh path
1228 * @change_mpath: change a given mesh path
1229 * @get_mpath: get a mesh path for the given parameters
1230 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1231 * @join_mesh: join the mesh network with the specified parameters
1232 * @leave_mesh: leave the current mesh network
1234 * @get_mesh_config: Get the current mesh configuration
1236 * @update_mesh_config: Update mesh parameters on a running mesh.
1237 * The mask is a bitfield which tells us which parameters to
1238 * set, and which to leave alone.
1240 * @change_bss: Modify parameters for a given BSS.
1242 * @set_txq_params: Set TX queue parameters
1244 * @set_channel: Set channel for a given wireless interface. Some devices
1245 * may support multi-channel operation (by channel hopping) so cfg80211
1246 * doesn't verify much. Note, however, that the passed netdev may be
1247 * %NULL as well if the user requested changing the channel for the
1248 * device itself, or for a monitor interface.
1250 * @scan: Request to do a scan. If returning zero, the scan request is given
1251 * the driver, and will be valid until passed to cfg80211_scan_done().
1252 * For scan results, call cfg80211_inform_bss(); you can call this outside
1253 * the scan/scan_done bracket too.
1255 * @auth: Request to authenticate with the specified peer
1256 * @assoc: Request to (re)associate with the specified peer
1257 * @deauth: Request to deauthenticate from the specified peer
1258 * @disassoc: Request to disassociate from the specified peer
1260 * @connect: Connect to the ESS with the specified parameters. When connected,
1261 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1262 * If the connection fails for some reason, call cfg80211_connect_result()
1263 * with the status from the AP.
1264 * @disconnect: Disconnect from the BSS/ESS.
1266 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1267 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1269 * @leave_ibss: Leave the IBSS.
1271 * @set_wiphy_params: Notify that wiphy parameters have changed;
1272 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1273 * have changed. The actual parameter values are available in
1274 * struct wiphy. If returning an error, no value should be changed.
1276 * @set_tx_power: set the transmit power according to the parameters
1277 * @get_tx_power: store the current TX power into the dbm variable;
1278 * return 0 if successful
1280 * @set_wds_peer: set the WDS peer for a WDS interface
1282 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1283 * functions to adjust rfkill hw state
1285 * @dump_survey: get site survey information.
1287 * @remain_on_channel: Request the driver to remain awake on the specified
1288 * channel for the specified duration to complete an off-channel
1289 * operation (e.g., public action frame exchange). When the driver is
1290 * ready on the requested channel, it must indicate this with an event
1291 * notification by calling cfg80211_ready_on_channel().
1292 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1293 * This allows the operation to be terminated prior to timeout based on
1294 * the duration value.
1295 * @mgmt_tx: Transmit a management frame.
1296 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1297 * frame on another channel
1299 * @testmode_cmd: run a test mode command
1301 * @set_bitrate_mask: set the bitrate mask configuration
1303 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1304 * devices running firmwares capable of generating the (re) association
1305 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1306 * @del_pmksa: Delete a cached PMKID.
1307 * @flush_pmksa: Flush all cached PMKIDs.
1308 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1309 * allows the driver to adjust the dynamic ps timeout value.
1310 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1311 * @sched_scan_start: Tell the driver to start a scheduled scan.
1312 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled
1313 * scan. The driver_initiated flag specifies whether the driver
1314 * itself has informed that the scan has stopped.
1316 * @mgmt_frame_register: Notify driver that a management frame type was
1317 * registered. Note that this callback may not sleep, and cannot run
1318 * concurrently with itself.
1320 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1321 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1322 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1323 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1325 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1327 * @set_ringparam: Set tx and rx ring sizes.
1329 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1331 struct cfg80211_ops {
1332 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1333 int (*resume)(struct wiphy *wiphy);
1335 struct net_device * (*add_virtual_intf)(struct wiphy *wiphy,
1337 enum nl80211_iftype type,
1339 struct vif_params *params);
1340 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
1341 int (*change_virtual_intf)(struct wiphy *wiphy,
1342 struct net_device *dev,
1343 enum nl80211_iftype type, u32 *flags,
1344 struct vif_params *params);
1346 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1347 u8 key_index, bool pairwise, const u8 *mac_addr,
1348 struct key_params *params);
1349 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1350 u8 key_index, bool pairwise, const u8 *mac_addr,
1352 void (*callback)(void *cookie, struct key_params*));
1353 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1354 u8 key_index, bool pairwise, const u8 *mac_addr);
1355 int (*set_default_key)(struct wiphy *wiphy,
1356 struct net_device *netdev,
1357 u8 key_index, bool unicast, bool multicast);
1358 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1359 struct net_device *netdev,
1362 int (*add_beacon)(struct wiphy *wiphy, struct net_device *dev,
1363 struct beacon_parameters *info);
1364 int (*set_beacon)(struct wiphy *wiphy, struct net_device *dev,
1365 struct beacon_parameters *info);
1366 int (*del_beacon)(struct wiphy *wiphy, struct net_device *dev);
1369 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1370 u8 *mac, struct station_parameters *params);
1371 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1373 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1374 u8 *mac, struct station_parameters *params);
1375 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1376 u8 *mac, struct station_info *sinfo);
1377 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1378 int idx, u8 *mac, struct station_info *sinfo);
1380 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1381 u8 *dst, u8 *next_hop);
1382 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1384 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1385 u8 *dst, u8 *next_hop);
1386 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1387 u8 *dst, u8 *next_hop,
1388 struct mpath_info *pinfo);
1389 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1390 int idx, u8 *dst, u8 *next_hop,
1391 struct mpath_info *pinfo);
1392 int (*get_mesh_config)(struct wiphy *wiphy,
1393 struct net_device *dev,
1394 struct mesh_config *conf);
1395 int (*update_mesh_config)(struct wiphy *wiphy,
1396 struct net_device *dev, u32 mask,
1397 const struct mesh_config *nconf);
1398 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1399 const struct mesh_config *conf,
1400 const struct mesh_setup *setup);
1401 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1403 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1404 struct bss_parameters *params);
1406 int (*set_txq_params)(struct wiphy *wiphy,
1407 struct ieee80211_txq_params *params);
1409 int (*set_channel)(struct wiphy *wiphy, struct net_device *dev,
1410 struct ieee80211_channel *chan,
1411 enum nl80211_channel_type channel_type);
1413 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
1414 struct cfg80211_scan_request *request);
1416 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1417 struct cfg80211_auth_request *req);
1418 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1419 struct cfg80211_assoc_request *req);
1420 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1421 struct cfg80211_deauth_request *req,
1423 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1424 struct cfg80211_disassoc_request *req,
1427 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1428 struct cfg80211_connect_params *sme);
1429 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1432 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1433 struct cfg80211_ibss_params *params);
1434 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1436 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1438 int (*set_tx_power)(struct wiphy *wiphy,
1439 enum nl80211_tx_power_setting type, int mbm);
1440 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1442 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1445 void (*rfkill_poll)(struct wiphy *wiphy);
1447 #ifdef CONFIG_NL80211_TESTMODE
1448 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1451 int (*set_bitrate_mask)(struct wiphy *wiphy,
1452 struct net_device *dev,
1454 const struct cfg80211_bitrate_mask *mask);
1456 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1457 int idx, struct survey_info *info);
1459 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1460 struct cfg80211_pmksa *pmksa);
1461 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1462 struct cfg80211_pmksa *pmksa);
1463 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1465 int (*remain_on_channel)(struct wiphy *wiphy,
1466 struct net_device *dev,
1467 struct ieee80211_channel *chan,
1468 enum nl80211_channel_type channel_type,
1469 unsigned int duration,
1471 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1472 struct net_device *dev,
1475 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
1476 struct ieee80211_channel *chan, bool offchan,
1477 enum nl80211_channel_type channel_type,
1478 bool channel_type_valid, unsigned int wait,
1479 const u8 *buf, size_t len, u64 *cookie);
1480 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1481 struct net_device *dev,
1484 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1485 bool enabled, int timeout);
1487 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1488 struct net_device *dev,
1489 s32 rssi_thold, u32 rssi_hyst);
1491 void (*mgmt_frame_register)(struct wiphy *wiphy,
1492 struct net_device *dev,
1493 u16 frame_type, bool reg);
1495 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1496 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1498 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1499 void (*get_ringparam)(struct wiphy *wiphy,
1500 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1502 int (*sched_scan_start)(struct wiphy *wiphy,
1503 struct net_device *dev,
1504 struct cfg80211_sched_scan_request *request);
1505 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
1509 * wireless hardware and networking interfaces structures
1510 * and registration/helper functions
1514 * enum wiphy_flags - wiphy capability flags
1516 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1517 * has its own custom regulatory domain and cannot identify the
1518 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1519 * we will disregard the first regulatory hint (when the
1520 * initiator is %REGDOM_SET_BY_CORE).
1521 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1522 * ignore regulatory domain settings until it gets its own regulatory
1523 * domain via its regulatory_hint() unless the regulatory hint is
1524 * from a country IE. After its gets its own regulatory domain it will
1525 * only allow further regulatory domain settings to further enhance
1526 * compliance. For example if channel 13 and 14 are disabled by this
1527 * regulatory domain no user regulatory domain can enable these channels
1528 * at a later time. This can be used for devices which do not have
1529 * calibration information guaranteed for frequencies or settings
1530 * outside of its regulatory domain.
1531 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1532 * that passive scan flags and beaconing flags may not be lifted by
1533 * cfg80211 due to regulatory beacon hints. For more information on beacon
1534 * hints read the documenation for regulatory_hint_found_beacon()
1535 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1537 * @WIPHY_FLAG_ENFORCE_COMBINATIONS: Set this flag to enforce interface
1538 * combinations for this device. This flag is used for backward
1539 * compatibility only until all drivers advertise combinations and
1540 * they will always be enforced.
1541 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1542 * by default -- this flag will be set depending on the kernel's default
1543 * on wiphy_new(), but can be changed by the driver if it has a good
1544 * reason to override the default
1545 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1546 * on a VLAN interface)
1547 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1548 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1549 * control port protocol ethertype. The device also honours the
1550 * control_port_no_encrypt flag.
1551 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1552 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1553 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1554 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
1557 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1558 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1559 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1560 WIPHY_FLAG_NETNS_OK = BIT(3),
1561 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1562 WIPHY_FLAG_4ADDR_AP = BIT(5),
1563 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1564 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
1565 WIPHY_FLAG_IBSS_RSN = BIT(8),
1566 WIPHY_FLAG_MESH_AUTH = BIT(10),
1567 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
1568 WIPHY_FLAG_ENFORCE_COMBINATIONS = BIT(12),
1572 * struct ieee80211_iface_limit - limit on certain interface types
1573 * @max: maximum number of interfaces of these types
1574 * @types: interface types (bits)
1576 struct ieee80211_iface_limit {
1582 * struct ieee80211_iface_combination - possible interface combination
1583 * @limits: limits for the given interface types
1584 * @n_limits: number of limitations
1585 * @num_different_channels: can use up to this many different channels
1586 * @max_interfaces: maximum number of interfaces in total allowed in this
1588 * @beacon_int_infra_match: In this combination, the beacon intervals
1589 * between infrastructure and AP types must match. This is required
1590 * only in special cases.
1592 * These examples can be expressed as follows:
1594 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
1596 * struct ieee80211_iface_limit limits1[] = {
1597 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1598 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
1600 * struct ieee80211_iface_combination combination1 = {
1601 * .limits = limits1,
1602 * .n_limits = ARRAY_SIZE(limits1),
1603 * .max_interfaces = 2,
1604 * .beacon_int_infra_match = true,
1608 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
1610 * struct ieee80211_iface_limit limits2[] = {
1611 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
1612 * BIT(NL80211_IFTYPE_P2P_GO), },
1614 * struct ieee80211_iface_combination combination2 = {
1615 * .limits = limits2,
1616 * .n_limits = ARRAY_SIZE(limits2),
1617 * .max_interfaces = 8,
1618 * .num_different_channels = 1,
1622 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
1623 * This allows for an infrastructure connection and three P2P connections.
1625 * struct ieee80211_iface_limit limits3[] = {
1626 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1627 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
1628 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
1630 * struct ieee80211_iface_combination combination3 = {
1631 * .limits = limits3,
1632 * .n_limits = ARRAY_SIZE(limits3),
1633 * .max_interfaces = 4,
1634 * .num_different_channels = 2,
1637 struct ieee80211_iface_combination {
1638 const struct ieee80211_iface_limit *limits;
1639 u32 num_different_channels;
1642 bool beacon_int_infra_match;
1645 struct mac_address {
1649 struct ieee80211_txrx_stypes {
1654 * enum wiphy_wowlan_support_flags - WoWLAN support flags
1655 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
1656 * trigger that keeps the device operating as-is and
1657 * wakes up the host on any activity, for example a
1658 * received packet that passed filtering; note that the
1659 * packet should be preserved in that case
1660 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
1662 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
1664 enum wiphy_wowlan_support_flags {
1665 WIPHY_WOWLAN_ANY = BIT(0),
1666 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
1667 WIPHY_WOWLAN_DISCONNECT = BIT(2),
1671 * struct wiphy_wowlan_support - WoWLAN support data
1672 * @flags: see &enum wiphy_wowlan_support_flags
1673 * @n_patterns: number of supported wakeup patterns
1674 * (see nl80211.h for the pattern definition)
1675 * @pattern_max_len: maximum length of each pattern
1676 * @pattern_min_len: minimum length of each pattern
1678 struct wiphy_wowlan_support {
1681 int pattern_max_len;
1682 int pattern_min_len;
1686 * struct wiphy - wireless hardware description
1687 * @reg_notifier: the driver's regulatory notification callback,
1688 * note that if your driver uses wiphy_apply_custom_regulatory()
1689 * the reg_notifier's request can be passed as NULL
1690 * @regd: the driver's regulatory domain, if one was requested via
1691 * the regulatory_hint() API. This can be used by the driver
1692 * on the reg_notifier() if it chooses to ignore future
1693 * regulatory domain changes caused by other drivers.
1694 * @signal_type: signal type reported in &struct cfg80211_bss.
1695 * @cipher_suites: supported cipher suites
1696 * @n_cipher_suites: number of supported cipher suites
1697 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1698 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1699 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1700 * -1 = fragmentation disabled, only odd values >= 256 used
1701 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1702 * @_net: the network namespace this wiphy currently lives in
1703 * @perm_addr: permanent MAC address of this device
1704 * @addr_mask: If the device supports multiple MAC addresses by masking,
1705 * set this to a mask with variable bits set to 1, e.g. if the last
1706 * four bits are variable then set it to 00:...:00:0f. The actual
1707 * variable bits shall be determined by the interfaces added, with
1708 * interfaces not matching the mask being rejected to be brought up.
1709 * @n_addresses: number of addresses in @addresses.
1710 * @addresses: If the device has more than one address, set this pointer
1711 * to a list of addresses (6 bytes each). The first one will be used
1712 * by default for perm_addr. In this case, the mask should be set to
1713 * all-zeroes. In this case it is assumed that the device can handle
1714 * the same number of arbitrary MAC addresses.
1715 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
1716 * automatically on wiphy renames
1717 * @dev: (virtual) struct device for this wiphy
1718 * @wext: wireless extension handlers
1719 * @priv: driver private data (sized according to wiphy_new() parameter)
1720 * @interface_modes: bitmask of interfaces types valid for this wiphy,
1721 * must be set by driver
1722 * @iface_combinations: Valid interface combinations array, should not
1723 * list single interface types.
1724 * @n_iface_combinations: number of entries in @iface_combinations array.
1725 * @software_iftypes: bitmask of software interface types, these are not
1726 * subject to any restrictions since they are purely managed in SW.
1727 * @flags: wiphy flags, see &enum wiphy_flags
1728 * @bss_priv_size: each BSS struct has private data allocated with it,
1729 * this variable determines its size
1730 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
1732 * @max_scan_ie_len: maximum length of user-controlled IEs device can
1733 * add to probe request frames transmitted during a scan, must not
1734 * include fixed IEs like supported rates
1735 * @coverage_class: current coverage class
1736 * @fw_version: firmware version for ethtool reporting
1737 * @hw_version: hardware version for ethtool reporting
1738 * @max_num_pmkids: maximum number of PMKIDs supported by device
1739 * @privid: a pointer that drivers can use to identify if an arbitrary
1740 * wiphy is theirs, e.g. in global notifiers
1741 * @bands: information about bands/channels supported by this device
1743 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
1744 * transmitted through nl80211, points to an array indexed by interface
1747 * @available_antennas_tx: bitmap of antennas which are available to be
1748 * configured as TX antennas. Antenna configuration commands will be
1749 * rejected unless this or @available_antennas_rx is set.
1751 * @available_antennas_rx: bitmap of antennas which are available to be
1752 * configured as RX antennas. Antenna configuration commands will be
1753 * rejected unless this or @available_antennas_tx is set.
1755 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
1756 * may request, if implemented.
1758 * @wowlan: WoWLAN support information
1761 /* assign these fields before you register the wiphy */
1763 /* permanent MAC address(es) */
1764 u8 perm_addr[ETH_ALEN];
1765 u8 addr_mask[ETH_ALEN];
1767 struct mac_address *addresses;
1769 const struct ieee80211_txrx_stypes *mgmt_stypes;
1771 const struct ieee80211_iface_combination *iface_combinations;
1772 int n_iface_combinations;
1773 u16 software_iftypes;
1777 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1778 u16 interface_modes;
1782 enum cfg80211_signal_type signal_type;
1786 u16 max_scan_ie_len;
1788 int n_cipher_suites;
1789 const u32 *cipher_suites;
1797 char fw_version[ETHTOOL_BUSINFO_LEN];
1800 struct wiphy_wowlan_support wowlan;
1802 u16 max_remain_on_channel_duration;
1806 u32 available_antennas_tx;
1807 u32 available_antennas_rx;
1809 /* If multiple wiphys are registered and you're handed e.g.
1810 * a regular netdev with assigned ieee80211_ptr, you won't
1811 * know whether it points to a wiphy your driver has registered
1812 * or not. Assign this to something global to your driver to
1813 * help determine whether you own this wiphy or not. */
1816 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
1818 /* Lets us get back the wiphy on the callback */
1819 int (*reg_notifier)(struct wiphy *wiphy,
1820 struct regulatory_request *request);
1822 /* fields below are read-only, assigned by cfg80211 */
1824 const struct ieee80211_regdomain *regd;
1826 /* the item in /sys/class/ieee80211/ points to this,
1827 * you need use set_wiphy_dev() (see below) */
1830 /* dir in debugfs: ieee80211/<wiphyname> */
1831 struct dentry *debugfsdir;
1833 #ifdef CONFIG_NET_NS
1834 /* the network namespace this phy lives in currently */
1838 #ifdef CONFIG_CFG80211_WEXT
1839 const struct iw_handler_def *wext;
1842 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
1845 static inline struct net *wiphy_net(struct wiphy *wiphy)
1847 return read_pnet(&wiphy->_net);
1850 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
1852 write_pnet(&wiphy->_net, net);
1856 * wiphy_priv - return priv from wiphy
1858 * @wiphy: the wiphy whose priv pointer to return
1860 static inline void *wiphy_priv(struct wiphy *wiphy)
1863 return &wiphy->priv;
1867 * priv_to_wiphy - return the wiphy containing the priv
1869 * @priv: a pointer previously returned by wiphy_priv
1871 static inline struct wiphy *priv_to_wiphy(void *priv)
1874 return container_of(priv, struct wiphy, priv);
1878 * set_wiphy_dev - set device pointer for wiphy
1880 * @wiphy: The wiphy whose device to bind
1881 * @dev: The device to parent it to
1883 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
1885 wiphy->dev.parent = dev;
1889 * wiphy_dev - get wiphy dev pointer
1891 * @wiphy: The wiphy whose device struct to look up
1893 static inline struct device *wiphy_dev(struct wiphy *wiphy)
1895 return wiphy->dev.parent;
1899 * wiphy_name - get wiphy name
1901 * @wiphy: The wiphy whose name to return
1903 static inline const char *wiphy_name(const struct wiphy *wiphy)
1905 return dev_name(&wiphy->dev);
1909 * wiphy_new - create a new wiphy for use with cfg80211
1911 * @ops: The configuration operations for this device
1912 * @sizeof_priv: The size of the private area to allocate
1914 * Create a new wiphy and associate the given operations with it.
1915 * @sizeof_priv bytes are allocated for private use.
1917 * The returned pointer must be assigned to each netdev's
1918 * ieee80211_ptr for proper operation.
1920 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
1923 * wiphy_register - register a wiphy with cfg80211
1925 * @wiphy: The wiphy to register.
1927 * Returns a non-negative wiphy index or a negative error code.
1929 extern int wiphy_register(struct wiphy *wiphy);
1932 * wiphy_unregister - deregister a wiphy from cfg80211
1934 * @wiphy: The wiphy to unregister.
1936 * After this call, no more requests can be made with this priv
1937 * pointer, but the call may sleep to wait for an outstanding
1938 * request that is being handled.
1940 extern void wiphy_unregister(struct wiphy *wiphy);
1943 * wiphy_free - free wiphy
1945 * @wiphy: The wiphy to free
1947 extern void wiphy_free(struct wiphy *wiphy);
1949 /* internal structs */
1950 struct cfg80211_conn;
1951 struct cfg80211_internal_bss;
1952 struct cfg80211_cached_keys;
1954 #define MAX_AUTH_BSSES 4
1957 * struct wireless_dev - wireless per-netdev state
1959 * This structure must be allocated by the driver/stack
1960 * that uses the ieee80211_ptr field in struct net_device
1961 * (this is intentional so it can be allocated along with
1964 * @wiphy: pointer to hardware description
1965 * @iftype: interface type
1966 * @list: (private) Used to collect the interfaces
1967 * @netdev: (private) Used to reference back to the netdev
1968 * @current_bss: (private) Used by the internal configuration code
1969 * @channel: (private) Used by the internal configuration code to track
1970 * user-set AP, monitor and WDS channels for wireless extensions
1971 * @bssid: (private) Used by the internal configuration code
1972 * @ssid: (private) Used by the internal configuration code
1973 * @ssid_len: (private) Used by the internal configuration code
1974 * @mesh_id_len: (private) Used by the internal configuration code
1975 * @mesh_id_up_len: (private) Used by the internal configuration code
1976 * @wext: (private) Used by the internal wireless extensions compat code
1977 * @use_4addr: indicates 4addr mode is used on this interface, must be
1978 * set by driver (if supported) on add_interface BEFORE registering the
1979 * netdev and may otherwise be used by driver read-only, will be update
1980 * by cfg80211 on change_interface
1981 * @mgmt_registrations: list of registrations for management frames
1982 * @mgmt_registrations_lock: lock for the list
1983 * @mtx: mutex used to lock data in this struct
1984 * @cleanup_work: work struct used for cleanup that can't be done directly
1985 * @beacon_interval: beacon interval used on this device for transmitting
1986 * beacons, 0 when not valid
1988 struct wireless_dev {
1989 struct wiphy *wiphy;
1990 enum nl80211_iftype iftype;
1992 /* the remainder of this struct should be private to cfg80211 */
1993 struct list_head list;
1994 struct net_device *netdev;
1996 struct list_head mgmt_registrations;
1997 spinlock_t mgmt_registrations_lock;
2001 struct work_struct cleanup_work;
2005 /* currently used for IBSS and SME - might be rearranged later */
2006 u8 ssid[IEEE80211_MAX_SSID_LEN];
2007 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2010 CFG80211_SME_CONNECTING,
2011 CFG80211_SME_CONNECTED,
2013 struct cfg80211_conn *conn;
2014 struct cfg80211_cached_keys *connect_keys;
2016 struct list_head event_list;
2017 spinlock_t event_lock;
2019 struct cfg80211_internal_bss *authtry_bsses[MAX_AUTH_BSSES];
2020 struct cfg80211_internal_bss *auth_bsses[MAX_AUTH_BSSES];
2021 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2022 struct ieee80211_channel *channel;
2027 int beacon_interval;
2029 #ifdef CONFIG_CFG80211_WEXT
2032 struct cfg80211_ibss_params ibss;
2033 struct cfg80211_connect_params connect;
2034 struct cfg80211_cached_keys *keys;
2037 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2038 u8 ssid[IEEE80211_MAX_SSID_LEN];
2039 s8 default_key, default_mgmt_key;
2040 bool prev_bssid_valid;
2046 * wdev_priv - return wiphy priv from wireless_dev
2048 * @wdev: The wireless device whose wiphy's priv pointer to return
2050 static inline void *wdev_priv(struct wireless_dev *wdev)
2053 return wiphy_priv(wdev->wiphy);
2057 * DOC: Utility functions
2059 * cfg80211 offers a number of utility functions that can be useful.
2063 * ieee80211_channel_to_frequency - convert channel number to frequency
2064 * @chan: channel number
2065 * @band: band, necessary due to channel number overlap
2067 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2070 * ieee80211_frequency_to_channel - convert frequency to channel number
2071 * @freq: center frequency
2073 extern int ieee80211_frequency_to_channel(int freq);
2076 * Name indirection necessary because the ieee80211 code also has
2077 * a function named "ieee80211_get_channel", so if you include
2078 * cfg80211's header file you get cfg80211's version, if you try
2079 * to include both header files you'll (rightfully!) get a symbol
2082 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2085 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2086 * @wiphy: the struct wiphy to get the channel for
2087 * @freq: the center frequency of the channel
2089 static inline struct ieee80211_channel *
2090 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2092 return __ieee80211_get_channel(wiphy, freq);
2096 * ieee80211_get_response_rate - get basic rate for a given rate
2098 * @sband: the band to look for rates in
2099 * @basic_rates: bitmap of basic rates
2100 * @bitrate: the bitrate for which to find the basic rate
2102 * This function returns the basic rate corresponding to a given
2103 * bitrate, that is the next lower bitrate contained in the basic
2104 * rate map, which is, for this function, given as a bitmap of
2105 * indices of rates in the band's bitrate table.
2107 struct ieee80211_rate *
2108 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2109 u32 basic_rates, int bitrate);
2112 * Radiotap parsing functions -- for controlled injection support
2114 * Implemented in net/wireless/radiotap.c
2115 * Documentation in Documentation/networking/radiotap-headers.txt
2118 struct radiotap_align_size {
2119 uint8_t align:4, size:4;
2122 struct ieee80211_radiotap_namespace {
2123 const struct radiotap_align_size *align_size;
2129 struct ieee80211_radiotap_vendor_namespaces {
2130 const struct ieee80211_radiotap_namespace *ns;
2135 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2136 * @this_arg_index: index of current arg, valid after each successful call
2137 * to ieee80211_radiotap_iterator_next()
2138 * @this_arg: pointer to current radiotap arg; it is valid after each
2139 * call to ieee80211_radiotap_iterator_next() but also after
2140 * ieee80211_radiotap_iterator_init() where it will point to
2141 * the beginning of the actual data portion
2142 * @this_arg_size: length of the current arg, for convenience
2143 * @current_namespace: pointer to the current namespace definition
2144 * (or internally %NULL if the current namespace is unknown)
2145 * @is_radiotap_ns: indicates whether the current namespace is the default
2146 * radiotap namespace or not
2148 * @_rtheader: pointer to the radiotap header we are walking through
2149 * @_max_length: length of radiotap header in cpu byte ordering
2150 * @_arg_index: next argument index
2151 * @_arg: next argument pointer
2152 * @_next_bitmap: internal pointer to next present u32
2153 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2154 * @_vns: vendor namespace definitions
2155 * @_next_ns_data: beginning of the next namespace's data
2156 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2159 * Describes the radiotap parser state. Fields prefixed with an underscore
2160 * must not be used by users of the parser, only by the parser internally.
2163 struct ieee80211_radiotap_iterator {
2164 struct ieee80211_radiotap_header *_rtheader;
2165 const struct ieee80211_radiotap_vendor_namespaces *_vns;
2166 const struct ieee80211_radiotap_namespace *current_namespace;
2168 unsigned char *_arg, *_next_ns_data;
2169 __le32 *_next_bitmap;
2171 unsigned char *this_arg;
2179 uint32_t _bitmap_shifter;
2183 extern int ieee80211_radiotap_iterator_init(
2184 struct ieee80211_radiotap_iterator *iterator,
2185 struct ieee80211_radiotap_header *radiotap_header,
2186 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
2188 extern int ieee80211_radiotap_iterator_next(
2189 struct ieee80211_radiotap_iterator *iterator);
2192 extern const unsigned char rfc1042_header[6];
2193 extern const unsigned char bridge_tunnel_header[6];
2196 * ieee80211_get_hdrlen_from_skb - get header length from data
2198 * Given an skb with a raw 802.11 header at the data pointer this function
2199 * returns the 802.11 header length in bytes (not including encryption
2200 * headers). If the data in the sk_buff is too short to contain a valid 802.11
2201 * header the function returns 0.
2205 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
2208 * ieee80211_hdrlen - get header length in bytes from frame control
2209 * @fc: frame control field in little-endian format
2211 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2214 * DOC: Data path helpers
2216 * In addition to generic utilities, cfg80211 also offers
2217 * functions that help implement the data path for devices
2218 * that do not do the 802.11/802.3 conversion on the device.
2222 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2223 * @skb: the 802.11 data frame
2224 * @addr: the device MAC address
2225 * @iftype: the virtual interface type
2227 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2228 enum nl80211_iftype iftype);
2231 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2232 * @skb: the 802.3 frame
2233 * @addr: the device MAC address
2234 * @iftype: the virtual interface type
2235 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2236 * @qos: build 802.11 QoS data frame
2238 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2239 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2242 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2244 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2245 * 802.3 frames. The @list will be empty if the decode fails. The
2246 * @skb is consumed after the function returns.
2248 * @skb: The input IEEE 802.11n A-MSDU frame.
2249 * @list: The output list of 802.3 frames. It must be allocated and
2250 * initialized by by the caller.
2251 * @addr: The device MAC address.
2252 * @iftype: The device interface type.
2253 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2254 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2256 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2257 const u8 *addr, enum nl80211_iftype iftype,
2258 const unsigned int extra_headroom,
2259 bool has_80211_header);
2262 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2263 * @skb: the data frame
2265 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2268 * cfg80211_find_ie - find information element in data
2271 * @ies: data consisting of IEs
2272 * @len: length of data
2274 * This function will return %NULL if the element ID could
2275 * not be found or if the element is invalid (claims to be
2276 * longer than the given data), or a pointer to the first byte
2277 * of the requested element, that is the byte containing the
2278 * element ID. There are no checks on the element length
2279 * other than having to fit into the given data.
2281 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2284 * DOC: Regulatory enforcement infrastructure
2290 * regulatory_hint - driver hint to the wireless core a regulatory domain
2291 * @wiphy: the wireless device giving the hint (used only for reporting
2293 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2294 * should be in. If @rd is set this should be NULL. Note that if you
2295 * set this to NULL you should still set rd->alpha2 to some accepted
2298 * Wireless drivers can use this function to hint to the wireless core
2299 * what it believes should be the current regulatory domain by
2300 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2301 * domain should be in or by providing a completely build regulatory domain.
2302 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2303 * for a regulatory domain structure for the respective country.
2305 * The wiphy must have been registered to cfg80211 prior to this call.
2306 * For cfg80211 drivers this means you must first use wiphy_register(),
2307 * for mac80211 drivers you must first use ieee80211_register_hw().
2309 * Drivers should check the return value, its possible you can get
2312 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2315 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2316 * @wiphy: the wireless device we want to process the regulatory domain on
2317 * @regd: the custom regulatory domain to use for this wiphy
2319 * Drivers can sometimes have custom regulatory domains which do not apply
2320 * to a specific country. Drivers can use this to apply such custom regulatory
2321 * domains. This routine must be called prior to wiphy registration. The
2322 * custom regulatory domain will be trusted completely and as such previous
2323 * default channel settings will be disregarded. If no rule is found for a
2324 * channel on the regulatory domain the channel will be disabled.
2326 extern void wiphy_apply_custom_regulatory(
2327 struct wiphy *wiphy,
2328 const struct ieee80211_regdomain *regd);
2331 * freq_reg_info - get regulatory information for the given frequency
2332 * @wiphy: the wiphy for which we want to process this rule for
2333 * @center_freq: Frequency in KHz for which we want regulatory information for
2334 * @desired_bw_khz: the desired max bandwidth you want to use per
2335 * channel. Note that this is still 20 MHz if you want to use HT40
2336 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2337 * If set to 0 we'll assume you want the standard 20 MHz.
2338 * @reg_rule: the regulatory rule which we have for this frequency
2340 * Use this function to get the regulatory rule for a specific frequency on
2341 * a given wireless device. If the device has a specific regulatory domain
2342 * it wants to follow we respect that unless a country IE has been received
2343 * and processed already.
2345 * Returns 0 if it was able to find a valid regulatory rule which does
2346 * apply to the given center_freq otherwise it returns non-zero. It will
2347 * also return -ERANGE if we determine the given center_freq does not even have
2348 * a regulatory rule for a frequency range in the center_freq's band. See
2349 * freq_in_rule_band() for our current definition of a band -- this is purely
2350 * subjective and right now its 802.11 specific.
2352 extern int freq_reg_info(struct wiphy *wiphy,
2355 const struct ieee80211_reg_rule **reg_rule);
2358 * Temporary wext handlers & helper functions
2360 * In the future cfg80211 will simply assign the entire wext handler
2361 * structure to netdevs it manages, but we're not there yet.
2363 int cfg80211_wext_giwname(struct net_device *dev,
2364 struct iw_request_info *info,
2365 char *name, char *extra);
2366 int cfg80211_wext_siwmode(struct net_device *dev, struct iw_request_info *info,
2367 u32 *mode, char *extra);
2368 int cfg80211_wext_giwmode(struct net_device *dev, struct iw_request_info *info,
2369 u32 *mode, char *extra);
2370 int cfg80211_wext_siwscan(struct net_device *dev,
2371 struct iw_request_info *info,
2372 union iwreq_data *wrqu, char *extra);
2373 int cfg80211_wext_giwscan(struct net_device *dev,
2374 struct iw_request_info *info,
2375 struct iw_point *data, char *extra);
2376 int cfg80211_wext_siwmlme(struct net_device *dev,
2377 struct iw_request_info *info,
2378 struct iw_point *data, char *extra);
2379 int cfg80211_wext_giwrange(struct net_device *dev,
2380 struct iw_request_info *info,
2381 struct iw_point *data, char *extra);
2382 int cfg80211_wext_siwgenie(struct net_device *dev,
2383 struct iw_request_info *info,
2384 struct iw_point *data, char *extra);
2385 int cfg80211_wext_siwauth(struct net_device *dev,
2386 struct iw_request_info *info,
2387 struct iw_param *data, char *extra);
2388 int cfg80211_wext_giwauth(struct net_device *dev,
2389 struct iw_request_info *info,
2390 struct iw_param *data, char *extra);
2392 int cfg80211_wext_siwfreq(struct net_device *dev,
2393 struct iw_request_info *info,
2394 struct iw_freq *freq, char *extra);
2395 int cfg80211_wext_giwfreq(struct net_device *dev,
2396 struct iw_request_info *info,
2397 struct iw_freq *freq, char *extra);
2398 int cfg80211_wext_siwessid(struct net_device *dev,
2399 struct iw_request_info *info,
2400 struct iw_point *data, char *ssid);
2401 int cfg80211_wext_giwessid(struct net_device *dev,
2402 struct iw_request_info *info,
2403 struct iw_point *data, char *ssid);
2404 int cfg80211_wext_siwrate(struct net_device *dev,
2405 struct iw_request_info *info,
2406 struct iw_param *rate, char *extra);
2407 int cfg80211_wext_giwrate(struct net_device *dev,
2408 struct iw_request_info *info,
2409 struct iw_param *rate, char *extra);
2411 int cfg80211_wext_siwrts(struct net_device *dev,
2412 struct iw_request_info *info,
2413 struct iw_param *rts, char *extra);
2414 int cfg80211_wext_giwrts(struct net_device *dev,
2415 struct iw_request_info *info,
2416 struct iw_param *rts, char *extra);
2417 int cfg80211_wext_siwfrag(struct net_device *dev,
2418 struct iw_request_info *info,
2419 struct iw_param *frag, char *extra);
2420 int cfg80211_wext_giwfrag(struct net_device *dev,
2421 struct iw_request_info *info,
2422 struct iw_param *frag, char *extra);
2423 int cfg80211_wext_siwretry(struct net_device *dev,
2424 struct iw_request_info *info,
2425 struct iw_param *retry, char *extra);
2426 int cfg80211_wext_giwretry(struct net_device *dev,
2427 struct iw_request_info *info,
2428 struct iw_param *retry, char *extra);
2429 int cfg80211_wext_siwencodeext(struct net_device *dev,
2430 struct iw_request_info *info,
2431 struct iw_point *erq, char *extra);
2432 int cfg80211_wext_siwencode(struct net_device *dev,
2433 struct iw_request_info *info,
2434 struct iw_point *erq, char *keybuf);
2435 int cfg80211_wext_giwencode(struct net_device *dev,
2436 struct iw_request_info *info,
2437 struct iw_point *erq, char *keybuf);
2438 int cfg80211_wext_siwtxpower(struct net_device *dev,
2439 struct iw_request_info *info,
2440 union iwreq_data *data, char *keybuf);
2441 int cfg80211_wext_giwtxpower(struct net_device *dev,
2442 struct iw_request_info *info,
2443 union iwreq_data *data, char *keybuf);
2444 struct iw_statistics *cfg80211_wireless_stats(struct net_device *dev);
2446 int cfg80211_wext_siwpower(struct net_device *dev,
2447 struct iw_request_info *info,
2448 struct iw_param *wrq, char *extra);
2449 int cfg80211_wext_giwpower(struct net_device *dev,
2450 struct iw_request_info *info,
2451 struct iw_param *wrq, char *extra);
2453 int cfg80211_wext_siwap(struct net_device *dev,
2454 struct iw_request_info *info,
2455 struct sockaddr *ap_addr, char *extra);
2456 int cfg80211_wext_giwap(struct net_device *dev,
2457 struct iw_request_info *info,
2458 struct sockaddr *ap_addr, char *extra);
2460 int cfg80211_wext_siwpmksa(struct net_device *dev,
2461 struct iw_request_info *info,
2462 struct iw_point *data, char *extra);
2465 * callbacks for asynchronous cfg80211 methods, notification
2466 * functions and BSS handling helpers
2470 * cfg80211_scan_done - notify that scan finished
2472 * @request: the corresponding scan request
2473 * @aborted: set to true if the scan was aborted for any reason,
2474 * userspace will be notified of that
2476 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2479 * cfg80211_sched_scan_results - notify that new scan results are available
2481 * @wiphy: the wiphy which got scheduled scan results
2483 void cfg80211_sched_scan_results(struct wiphy *wiphy);
2486 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
2488 * @wiphy: the wiphy on which the scheduled scan stopped
2490 * The driver can call this function to inform cfg80211 that the
2491 * scheduled scan had to be stopped, for whatever reason. The driver
2492 * is then called back via the sched_scan_stop operation when done.
2494 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
2497 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2499 * @wiphy: the wiphy reporting the BSS
2500 * @channel: The channel the frame was received on
2501 * @mgmt: the management frame (probe response or beacon)
2502 * @len: length of the management frame
2503 * @signal: the signal strength, type depends on the wiphy's signal_type
2504 * @gfp: context flags
2506 * This informs cfg80211 that BSS information was found and
2507 * the BSS should be updated/added.
2509 struct cfg80211_bss*
2510 cfg80211_inform_bss_frame(struct wiphy *wiphy,
2511 struct ieee80211_channel *channel,
2512 struct ieee80211_mgmt *mgmt, size_t len,
2513 s32 signal, gfp_t gfp);
2516 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2518 * @wiphy: the wiphy reporting the BSS
2519 * @channel: The channel the frame was received on
2520 * @bssid: the BSSID of the BSS
2521 * @timestamp: the TSF timestamp sent by the peer
2522 * @capability: the capability field sent by the peer
2523 * @beacon_interval: the beacon interval announced by the peer
2524 * @ie: additional IEs sent by the peer
2525 * @ielen: length of the additional IEs
2526 * @signal: the signal strength, type depends on the wiphy's signal_type
2527 * @gfp: context flags
2529 * This informs cfg80211 that BSS information was found and
2530 * the BSS should be updated/added.
2532 struct cfg80211_bss*
2533 cfg80211_inform_bss(struct wiphy *wiphy,
2534 struct ieee80211_channel *channel,
2536 u64 timestamp, u16 capability, u16 beacon_interval,
2537 const u8 *ie, size_t ielen,
2538 s32 signal, gfp_t gfp);
2540 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2541 struct ieee80211_channel *channel,
2543 const u8 *ssid, size_t ssid_len,
2544 u16 capa_mask, u16 capa_val);
2545 static inline struct cfg80211_bss *
2546 cfg80211_get_ibss(struct wiphy *wiphy,
2547 struct ieee80211_channel *channel,
2548 const u8 *ssid, size_t ssid_len)
2550 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2551 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2554 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2555 struct ieee80211_channel *channel,
2556 const u8 *meshid, size_t meshidlen,
2558 void cfg80211_put_bss(struct cfg80211_bss *bss);
2561 * cfg80211_unlink_bss - unlink BSS from internal data structures
2563 * @bss: the bss to remove
2565 * This function removes the given BSS from the internal data structures
2566 * thereby making it no longer show up in scan results etc. Use this
2567 * function when you detect a BSS is gone. Normally BSSes will also time
2568 * out, so it is not necessary to use this function at all.
2570 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
2573 * cfg80211_send_rx_auth - notification of processed authentication
2574 * @dev: network device
2575 * @buf: authentication frame (header + body)
2576 * @len: length of the frame data
2578 * This function is called whenever an authentication has been processed in
2579 * station mode. The driver is required to call either this function or
2580 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2581 * call. This function may sleep.
2583 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
2586 * cfg80211_send_auth_timeout - notification of timed out authentication
2587 * @dev: network device
2588 * @addr: The MAC address of the device with which the authentication timed out
2590 * This function may sleep.
2592 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
2595 * __cfg80211_auth_canceled - notify cfg80211 that authentication was canceled
2596 * @dev: network device
2597 * @addr: The MAC address of the device with which the authentication timed out
2599 * When a pending authentication had no action yet, the driver may decide
2600 * to not send a deauth frame, but in that case must calls this function
2601 * to tell cfg80211 about this decision. It is only valid to call this
2602 * function within the deauth() callback.
2604 void __cfg80211_auth_canceled(struct net_device *dev, const u8 *addr);
2607 * cfg80211_send_rx_assoc - notification of processed association
2608 * @dev: network device
2609 * @buf: (re)association response frame (header + body)
2610 * @len: length of the frame data
2612 * This function is called whenever a (re)association response has been
2613 * processed in station mode. The driver is required to call either this
2614 * function or cfg80211_send_assoc_timeout() to indicate the result of
2615 * cfg80211_ops::assoc() call. This function may sleep.
2617 void cfg80211_send_rx_assoc(struct net_device *dev, const u8 *buf, size_t len);
2620 * cfg80211_send_assoc_timeout - notification of timed out association
2621 * @dev: network device
2622 * @addr: The MAC address of the device with which the association timed out
2624 * This function may sleep.
2626 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
2629 * cfg80211_send_deauth - notification of processed deauthentication
2630 * @dev: network device
2631 * @buf: deauthentication frame (header + body)
2632 * @len: length of the frame data
2634 * This function is called whenever deauthentication has been processed in
2635 * station mode. This includes both received deauthentication frames and
2636 * locally generated ones. This function may sleep.
2638 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2641 * __cfg80211_send_deauth - notification of processed deauthentication
2642 * @dev: network device
2643 * @buf: deauthentication frame (header + body)
2644 * @len: length of the frame data
2646 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2648 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2651 * cfg80211_send_disassoc - notification of processed disassociation
2652 * @dev: network device
2653 * @buf: disassociation response frame (header + body)
2654 * @len: length of the frame data
2656 * This function is called whenever disassociation has been processed in
2657 * station mode. This includes both received disassociation frames and locally
2658 * generated ones. This function may sleep.
2660 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
2663 * __cfg80211_send_disassoc - notification of processed disassociation
2664 * @dev: network device
2665 * @buf: disassociation response frame (header + body)
2666 * @len: length of the frame data
2668 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2670 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
2674 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
2675 * @dev: network device
2676 * @buf: deauthentication frame (header + body)
2677 * @len: length of the frame data
2679 * This function is called whenever a received Deauthentication frame has been
2680 * dropped in station mode because of MFP being used but the Deauthentication
2681 * frame was not protected. This function may sleep.
2683 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
2687 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
2688 * @dev: network device
2689 * @buf: disassociation frame (header + body)
2690 * @len: length of the frame data
2692 * This function is called whenever a received Disassociation frame has been
2693 * dropped in station mode because of MFP being used but the Disassociation
2694 * frame was not protected. This function may sleep.
2696 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
2700 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
2701 * @dev: network device
2702 * @addr: The source MAC address of the frame
2703 * @key_type: The key type that the received frame used
2704 * @key_id: Key identifier (0..3). Can be -1 if missing.
2705 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
2706 * @gfp: allocation flags
2708 * This function is called whenever the local MAC detects a MIC failure in a
2709 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
2712 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
2713 enum nl80211_key_type key_type, int key_id,
2714 const u8 *tsc, gfp_t gfp);
2717 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
2719 * @dev: network device
2720 * @bssid: the BSSID of the IBSS joined
2721 * @gfp: allocation flags
2723 * This function notifies cfg80211 that the device joined an IBSS or
2724 * switched to a different BSSID. Before this function can be called,
2725 * either a beacon has to have been received from the IBSS, or one of
2726 * the cfg80211_inform_bss{,_frame} functions must have been called
2727 * with the locally generated beacon -- this guarantees that there is
2728 * always a scan result for this IBSS. cfg80211 will handle the rest.
2730 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
2733 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
2735 * @dev: network device
2736 * @macaddr: the MAC address of the new candidate
2737 * @ie: information elements advertised by the peer candidate
2738 * @ie_len: lenght of the information elements buffer
2739 * @gfp: allocation flags
2741 * This function notifies cfg80211 that the mesh peer candidate has been
2742 * detected, most likely via a beacon or, less likely, via a probe response.
2743 * cfg80211 then sends a notification to userspace.
2745 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
2746 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
2749 * DOC: RFkill integration
2751 * RFkill integration in cfg80211 is almost invisible to drivers,
2752 * as cfg80211 automatically registers an rfkill instance for each
2753 * wireless device it knows about. Soft kill is also translated
2754 * into disconnecting and turning all interfaces off, drivers are
2755 * expected to turn off the device when all interfaces are down.
2757 * However, devices may have a hard RFkill line, in which case they
2758 * also need to interact with the rfkill subsystem, via cfg80211.
2759 * They can do this with a few helper functions documented here.
2763 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
2765 * @blocked: block status
2767 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
2770 * wiphy_rfkill_start_polling - start polling rfkill
2773 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
2776 * wiphy_rfkill_stop_polling - stop polling rfkill
2779 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
2781 #ifdef CONFIG_NL80211_TESTMODE
2785 * Test mode is a set of utility functions to allow drivers to
2786 * interact with driver-specific tools to aid, for instance,
2787 * factory programming.
2789 * This chapter describes how drivers interact with it, for more
2790 * information see the nl80211 book's chapter on it.
2794 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
2796 * @approxlen: an upper bound of the length of the data that will
2797 * be put into the skb
2799 * This function allocates and pre-fills an skb for a reply to
2800 * the testmode command. Since it is intended for a reply, calling
2801 * it outside of the @testmode_cmd operation is invalid.
2803 * The returned skb (or %NULL if any errors happen) is pre-filled
2804 * with the wiphy index and set up in a way that any data that is
2805 * put into the skb (with skb_put(), nla_put() or similar) will end
2806 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
2807 * needs to be done with the skb is adding data for the corresponding
2808 * userspace tool which can then read that data out of the testdata
2809 * attribute. You must not modify the skb in any other way.
2811 * When done, call cfg80211_testmode_reply() with the skb and return
2812 * its error code as the result of the @testmode_cmd operation.
2814 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
2818 * cfg80211_testmode_reply - send the reply skb
2819 * @skb: The skb, must have been allocated with
2820 * cfg80211_testmode_alloc_reply_skb()
2822 * Returns an error code or 0 on success, since calling this
2823 * function will usually be the last thing before returning
2824 * from the @testmode_cmd you should return the error code.
2825 * Note that this function consumes the skb regardless of the
2828 int cfg80211_testmode_reply(struct sk_buff *skb);
2831 * cfg80211_testmode_alloc_event_skb - allocate testmode event
2833 * @approxlen: an upper bound of the length of the data that will
2834 * be put into the skb
2835 * @gfp: allocation flags
2837 * This function allocates and pre-fills an skb for an event on the
2838 * testmode multicast group.
2840 * The returned skb (or %NULL if any errors happen) is set up in the
2841 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
2842 * for an event. As there, you should simply add data to it that will
2843 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
2844 * not modify the skb in any other way.
2846 * When done filling the skb, call cfg80211_testmode_event() with the
2847 * skb to send the event.
2849 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
2850 int approxlen, gfp_t gfp);
2853 * cfg80211_testmode_event - send the event
2854 * @skb: The skb, must have been allocated with
2855 * cfg80211_testmode_alloc_event_skb()
2856 * @gfp: allocation flags
2858 * This function sends the given @skb, which must have been allocated
2859 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
2862 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
2864 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
2866 #define CFG80211_TESTMODE_CMD(cmd)
2870 * cfg80211_connect_result - notify cfg80211 of connection result
2872 * @dev: network device
2873 * @bssid: the BSSID of the AP
2874 * @req_ie: association request IEs (maybe be %NULL)
2875 * @req_ie_len: association request IEs length
2876 * @resp_ie: association response IEs (may be %NULL)
2877 * @resp_ie_len: assoc response IEs length
2878 * @status: status code, 0 for successful connection, use
2879 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
2880 * the real status code for failures.
2881 * @gfp: allocation flags
2883 * It should be called by the underlying driver whenever connect() has
2886 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
2887 const u8 *req_ie, size_t req_ie_len,
2888 const u8 *resp_ie, size_t resp_ie_len,
2889 u16 status, gfp_t gfp);
2892 * cfg80211_roamed - notify cfg80211 of roaming
2894 * @dev: network device
2895 * @channel: the channel of the new AP
2896 * @bssid: the BSSID of the new AP
2897 * @req_ie: association request IEs (maybe be %NULL)
2898 * @req_ie_len: association request IEs length
2899 * @resp_ie: association response IEs (may be %NULL)
2900 * @resp_ie_len: assoc response IEs length
2901 * @gfp: allocation flags
2903 * It should be called by the underlying driver whenever it roamed
2904 * from one AP to another while connected.
2906 void cfg80211_roamed(struct net_device *dev,
2907 struct ieee80211_channel *channel,
2909 const u8 *req_ie, size_t req_ie_len,
2910 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
2913 * cfg80211_roamed_bss - notify cfg80211 of roaming
2915 * @dev: network device
2916 * @bss: entry of bss to which STA got roamed
2917 * @req_ie: association request IEs (maybe be %NULL)
2918 * @req_ie_len: association request IEs length
2919 * @resp_ie: association response IEs (may be %NULL)
2920 * @resp_ie_len: assoc response IEs length
2921 * @gfp: allocation flags
2923 * This is just a wrapper to notify cfg80211 of roaming event with driver
2924 * passing bss to avoid a race in timeout of the bss entry. It should be
2925 * called by the underlying driver whenever it roamed from one AP to another
2926 * while connected. Drivers which have roaming implemented in firmware
2927 * may use this function to avoid a race in bss entry timeout where the bss
2928 * entry of the new AP is seen in the driver, but gets timed out by the time
2929 * it is accessed in __cfg80211_roamed() due to delay in scheduling
2930 * rdev->event_work. In case of any failures, the reference is released
2931 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
2932 * it will be released while diconneting from the current bss.
2934 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
2935 const u8 *req_ie, size_t req_ie_len,
2936 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
2939 * cfg80211_disconnected - notify cfg80211 that connection was dropped
2941 * @dev: network device
2942 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
2943 * @ie_len: length of IEs
2944 * @reason: reason code for the disconnection, set it to 0 if unknown
2945 * @gfp: allocation flags
2947 * After it calls this function, the driver should enter an idle state
2948 * and not try to connect to any AP any more.
2950 void cfg80211_disconnected(struct net_device *dev, u16 reason,
2951 u8 *ie, size_t ie_len, gfp_t gfp);
2954 * cfg80211_ready_on_channel - notification of remain_on_channel start
2955 * @dev: network device
2956 * @cookie: the request cookie
2957 * @chan: The current channel (from remain_on_channel request)
2958 * @channel_type: Channel type
2959 * @duration: Duration in milliseconds that the driver intents to remain on the
2961 * @gfp: allocation flags
2963 void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
2964 struct ieee80211_channel *chan,
2965 enum nl80211_channel_type channel_type,
2966 unsigned int duration, gfp_t gfp);
2969 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
2970 * @dev: network device
2971 * @cookie: the request cookie
2972 * @chan: The current channel (from remain_on_channel request)
2973 * @channel_type: Channel type
2974 * @gfp: allocation flags
2976 void cfg80211_remain_on_channel_expired(struct net_device *dev,
2978 struct ieee80211_channel *chan,
2979 enum nl80211_channel_type channel_type,
2984 * cfg80211_new_sta - notify userspace about station
2987 * @mac_addr: the station's address
2988 * @sinfo: the station information
2989 * @gfp: allocation flags
2991 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
2992 struct station_info *sinfo, gfp_t gfp);
2995 * cfg80211_del_sta - notify userspace about deletion of a station
2998 * @mac_addr: the station's address
2999 * @gfp: allocation flags
3001 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3004 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3005 * @dev: network device
3006 * @freq: Frequency on which the frame was received in MHz
3007 * @buf: Management frame (header + body)
3008 * @len: length of the frame data
3009 * @gfp: context flags
3011 * Returns %true if a user space application has registered for this frame.
3012 * For action frames, that makes it responsible for rejecting unrecognized
3013 * action frames; %false otherwise, in which case for action frames the
3014 * driver is responsible for rejecting the frame.
3016 * This function is called whenever an Action frame is received for a station
3017 * mode interface, but is not processed in kernel.
3019 bool cfg80211_rx_mgmt(struct net_device *dev, int freq, const u8 *buf,
3020 size_t len, gfp_t gfp);
3023 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3024 * @dev: network device
3025 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3026 * @buf: Management frame (header + body)
3027 * @len: length of the frame data
3028 * @ack: Whether frame was acknowledged
3029 * @gfp: context flags
3031 * This function is called whenever a management frame was requested to be
3032 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3033 * transmission attempt.
3035 void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
3036 const u8 *buf, size_t len, bool ack, gfp_t gfp);
3040 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3041 * @dev: network device
3042 * @rssi_event: the triggered RSSI event
3043 * @gfp: context flags
3045 * This function is called when a configured connection quality monitoring
3046 * rssi threshold reached event occurs.
3048 void cfg80211_cqm_rssi_notify(struct net_device *dev,
3049 enum nl80211_cqm_rssi_threshold_event rssi_event,
3053 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3054 * @dev: network device
3055 * @peer: peer's MAC address
3056 * @num_packets: how many packets were lost -- should be a fixed threshold
3057 * but probably no less than maybe 50, or maybe a throughput dependent
3058 * threshold (to account for temporary interference)
3059 * @gfp: context flags
3061 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3062 const u8 *peer, u32 num_packets, gfp_t gfp);
3064 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3066 /* wiphy_printk helpers, similar to dev_printk */
3068 #define wiphy_printk(level, wiphy, format, args...) \
3069 dev_printk(level, &(wiphy)->dev, format, ##args)
3070 #define wiphy_emerg(wiphy, format, args...) \
3071 dev_emerg(&(wiphy)->dev, format, ##args)
3072 #define wiphy_alert(wiphy, format, args...) \
3073 dev_alert(&(wiphy)->dev, format, ##args)
3074 #define wiphy_crit(wiphy, format, args...) \
3075 dev_crit(&(wiphy)->dev, format, ##args)
3076 #define wiphy_err(wiphy, format, args...) \
3077 dev_err(&(wiphy)->dev, format, ##args)
3078 #define wiphy_warn(wiphy, format, args...) \
3079 dev_warn(&(wiphy)->dev, format, ##args)
3080 #define wiphy_notice(wiphy, format, args...) \
3081 dev_notice(&(wiphy)->dev, format, ##args)
3082 #define wiphy_info(wiphy, format, args...) \
3083 dev_info(&(wiphy)->dev, format, ##args)
3085 #define wiphy_debug(wiphy, format, args...) \
3086 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3088 #define wiphy_dbg(wiphy, format, args...) \
3089 dev_dbg(&(wiphy)->dev, format, ##args)
3091 #if defined(VERBOSE_DEBUG)
3092 #define wiphy_vdbg wiphy_dbg
3094 #define wiphy_vdbg(wiphy, format, args...) \
3097 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3103 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3104 * of using a WARN/WARN_ON to get the message out, including the
3105 * file/line information and a backtrace.
3107 #define wiphy_WARN(wiphy, format, args...) \
3108 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3110 #endif /* __NET_CFG80211_H */