1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
4 * 802.11 device and configuration interface
6 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/netdevice.h>
14 #include <linux/debugfs.h>
15 #include <linux/list.h>
16 #include <linux/netlink.h>
17 #include <linux/skbuff.h>
18 #include <linux/nl80211.h>
19 #include <linux/if_ether.h>
20 #include <linux/ieee80211.h>
21 #include <net/regulatory.h>
26 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
27 * userspace and drivers, and offers some utility functionality associated
28 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
29 * by all modern wireless drivers in Linux, so that they offer a consistent
30 * API through nl80211. For backward compatibility, cfg80211 also offers
31 * wireless extensions to userspace, but hides them from drivers completely.
33 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
39 * DOC: Device registration
41 * In order for a driver to use cfg80211, it must register the hardware device
42 * with cfg80211. This happens through a number of hardware capability structs
45 * The fundamental structure for each device is the 'wiphy', of which each
46 * instance describes a physical wireless device connected to the system. Each
47 * such wiphy can have zero, one, or many virtual interfaces associated with
48 * it, which need to be identified as such by pointing the network interface's
49 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
50 * the wireless part of the interface, normally this struct is embedded in the
51 * network interface's private data area. Drivers can optionally allow creating
52 * or destroying virtual interfaces on the fly, but without at least one or the
53 * ability to create some the wireless device isn't useful.
55 * Each wiphy structure contains device capability information, and also has
56 * a pointer to the various operations the driver offers. The definitions and
57 * structures here describe these capabilities in detail.
61 * wireless hardware capability structures
65 * enum ieee80211_band - supported frequency bands
67 * The bands are assigned this way because the supported
68 * bitrates differ in these bands.
70 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
71 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
72 * @IEEE80211_NUM_BANDS: number of defined bands
75 IEEE80211_BAND_2GHZ
= NL80211_BAND_2GHZ
,
76 IEEE80211_BAND_5GHZ
= NL80211_BAND_5GHZ
,
83 * enum ieee80211_channel_flags - channel flags
85 * Channel flags set by the regulatory control code.
87 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
88 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
90 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
91 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
92 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
94 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
97 enum ieee80211_channel_flags
{
98 IEEE80211_CHAN_DISABLED
= 1<<0,
99 IEEE80211_CHAN_PASSIVE_SCAN
= 1<<1,
100 IEEE80211_CHAN_NO_IBSS
= 1<<2,
101 IEEE80211_CHAN_RADAR
= 1<<3,
102 IEEE80211_CHAN_NO_HT40PLUS
= 1<<4,
103 IEEE80211_CHAN_NO_HT40MINUS
= 1<<5,
106 #define IEEE80211_CHAN_NO_HT40 \
107 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
110 * struct ieee80211_channel - channel definition
112 * This structure describes a single channel for use
115 * @center_freq: center frequency in MHz
116 * @hw_value: hardware-specific value for the channel
117 * @flags: channel flags from &enum ieee80211_channel_flags.
118 * @orig_flags: channel flags at registration time, used by regulatory
119 * code to support devices with additional restrictions
120 * @band: band this channel belongs to.
121 * @max_antenna_gain: maximum antenna gain in dBi
122 * @max_power: maximum transmission power (in dBm)
123 * @beacon_found: helper to regulatory code to indicate when a beacon
124 * has been found on this channel. Use regulatory_hint_found_beacon()
125 * to enable this, this is useful only on 5 GHz band.
126 * @orig_mag: internal use
127 * @orig_mpwr: internal use
129 struct ieee80211_channel
{
130 enum ieee80211_band band
;
134 int max_antenna_gain
;
138 int orig_mag
, orig_mpwr
;
142 * enum ieee80211_rate_flags - rate flags
144 * Hardware/specification flags for rates. These are structured
145 * in a way that allows using the same bitrate structure for
146 * different bands/PHY modes.
148 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
149 * preamble on this bitrate; only relevant in 2.4GHz band and
151 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
152 * when used with 802.11a (on the 5 GHz band); filled by the
153 * core code when registering the wiphy.
154 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
155 * when used with 802.11b (on the 2.4 GHz band); filled by the
156 * core code when registering the wiphy.
157 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
158 * when used with 802.11g (on the 2.4 GHz band); filled by the
159 * core code when registering the wiphy.
160 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
162 enum ieee80211_rate_flags
{
163 IEEE80211_RATE_SHORT_PREAMBLE
= 1<<0,
164 IEEE80211_RATE_MANDATORY_A
= 1<<1,
165 IEEE80211_RATE_MANDATORY_B
= 1<<2,
166 IEEE80211_RATE_MANDATORY_G
= 1<<3,
167 IEEE80211_RATE_ERP_G
= 1<<4,
171 * struct ieee80211_rate - bitrate definition
173 * This structure describes a bitrate that an 802.11 PHY can
174 * operate with. The two values @hw_value and @hw_value_short
175 * are only for driver use when pointers to this structure are
178 * @flags: rate-specific flags
179 * @bitrate: bitrate in units of 100 Kbps
180 * @hw_value: driver/hardware value for this rate
181 * @hw_value_short: driver/hardware value for this rate when
182 * short preamble is used
184 struct ieee80211_rate
{
187 u16 hw_value
, hw_value_short
;
191 * struct ieee80211_sta_ht_cap - STA's HT capabilities
193 * This structure describes most essential parameters needed
194 * to describe 802.11n HT capabilities for an STA.
196 * @ht_supported: is HT supported by the STA
197 * @cap: HT capabilities map as described in 802.11n spec
198 * @ampdu_factor: Maximum A-MPDU length factor
199 * @ampdu_density: Minimum A-MPDU spacing
200 * @mcs: Supported MCS rates
202 struct ieee80211_sta_ht_cap
{
203 u16 cap
; /* use IEEE80211_HT_CAP_ */
207 struct ieee80211_mcs_info mcs
;
211 * struct ieee80211_supported_band - frequency band definition
213 * This structure describes a frequency band a wiphy
214 * is able to operate in.
216 * @channels: Array of channels the hardware can operate in
218 * @band: the band this structure represents
219 * @n_channels: Number of channels in @channels
220 * @bitrates: Array of bitrates the hardware can operate with
221 * in this band. Must be sorted to give a valid "supported
222 * rates" IE, i.e. CCK rates first, then OFDM.
223 * @n_bitrates: Number of bitrates in @bitrates
224 * @ht_cap: HT capabilities in this band
226 struct ieee80211_supported_band
{
227 struct ieee80211_channel
*channels
;
228 struct ieee80211_rate
*bitrates
;
229 enum ieee80211_band band
;
232 struct ieee80211_sta_ht_cap ht_cap
;
236 * Wireless hardware/device configuration structures and methods
240 * DOC: Actions and configuration
242 * Each wireless device and each virtual interface offer a set of configuration
243 * operations and other actions that are invoked by userspace. Each of these
244 * actions is described in the operations structure, and the parameters these
245 * operations use are described separately.
247 * Additionally, some operations are asynchronous and expect to get status
248 * information via some functions that drivers need to call.
250 * Scanning and BSS list handling with its associated functionality is described
251 * in a separate chapter.
255 * struct vif_params - describes virtual interface parameters
256 * @use_4addr: use 4-address frames
263 * struct key_params - key information
265 * Information about a key
268 * @key_len: length of key material
269 * @cipher: cipher suite selector
270 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
271 * with the get_key() callback, must be in little endian,
272 * length given by @seq_len.
273 * @seq_len: length of @seq.
284 * enum survey_info_flags - survey information flags
286 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
287 * @SURVEY_INFO_IN_USE: channel is currently being used
288 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
289 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
290 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
291 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
292 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
294 * Used by the driver to indicate which info in &struct survey_info
295 * it has filled in during the get_survey().
297 enum survey_info_flags
{
298 SURVEY_INFO_NOISE_DBM
= 1<<0,
299 SURVEY_INFO_IN_USE
= 1<<1,
300 SURVEY_INFO_CHANNEL_TIME
= 1<<2,
301 SURVEY_INFO_CHANNEL_TIME_BUSY
= 1<<3,
302 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY
= 1<<4,
303 SURVEY_INFO_CHANNEL_TIME_RX
= 1<<5,
304 SURVEY_INFO_CHANNEL_TIME_TX
= 1<<6,
308 * struct survey_info - channel survey response
310 * @channel: the channel this survey record reports, mandatory
311 * @filled: bitflag of flags from &enum survey_info_flags
312 * @noise: channel noise in dBm. This and all following fields are
314 * @channel_time: amount of time in ms the radio spent on the channel
315 * @channel_time_busy: amount of time the primary channel was sensed busy
316 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
317 * @channel_time_rx: amount of time the radio spent receiving data
318 * @channel_time_tx: amount of time the radio spent transmitting data
320 * Used by dump_survey() to report back per-channel survey information.
322 * This structure can later be expanded with things like
323 * channel duty cycle etc.
326 struct ieee80211_channel
*channel
;
328 u64 channel_time_busy
;
329 u64 channel_time_ext_busy
;
337 * struct cfg80211_crypto_settings - Crypto settings
338 * @wpa_versions: indicates which, if any, WPA versions are enabled
339 * (from enum nl80211_wpa_versions)
340 * @cipher_group: group key cipher suite (or 0 if unset)
341 * @n_ciphers_pairwise: number of AP supported unicast ciphers
342 * @ciphers_pairwise: unicast key cipher suites
343 * @n_akm_suites: number of AKM suites
344 * @akm_suites: AKM suites
345 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
346 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
347 * required to assume that the port is unauthorized until authorized by
348 * user space. Otherwise, port is marked authorized by default.
349 * @control_port_ethertype: the control port protocol that should be
350 * allowed through even on unauthorized ports
351 * @control_port_no_encrypt: TRUE to prevent encryption of control port
354 struct cfg80211_crypto_settings
{
357 int n_ciphers_pairwise
;
358 u32 ciphers_pairwise
[NL80211_MAX_NR_CIPHER_SUITES
];
360 u32 akm_suites
[NL80211_MAX_NR_AKM_SUITES
];
362 __be16 control_port_ethertype
;
363 bool control_port_no_encrypt
;
367 * struct beacon_parameters - beacon parameters
369 * Used to configure the beacon for an interface.
371 * @head: head portion of beacon (before TIM IE)
372 * or %NULL if not changed
373 * @tail: tail portion of beacon (after TIM IE)
374 * or %NULL if not changed
375 * @interval: beacon interval or zero if not changed
376 * @dtim_period: DTIM period or zero if not changed
377 * @head_len: length of @head
378 * @tail_len: length of @tail
379 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
381 * @ssid_len: length of @ssid
382 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
383 * @crypto: crypto settings
384 * @privacy: the BSS uses privacy
385 * @auth_type: Authentication type (algorithm)
386 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
387 * @beacon_ies_len: length of beacon_ies in octets
388 * @proberesp_ies: extra information element(s) to add into Probe Response
390 * @proberesp_ies_len: length of proberesp_ies in octets
391 * @assocresp_ies: extra information element(s) to add into (Re)Association
392 * Response frames or %NULL
393 * @assocresp_ies_len: length of assocresp_ies in octets
395 struct beacon_parameters
{
397 int interval
, dtim_period
;
398 int head_len
, tail_len
;
401 enum nl80211_hidden_ssid hidden_ssid
;
402 struct cfg80211_crypto_settings crypto
;
404 enum nl80211_auth_type auth_type
;
405 const u8
*beacon_ies
;
406 size_t beacon_ies_len
;
407 const u8
*proberesp_ies
;
408 size_t proberesp_ies_len
;
409 const u8
*assocresp_ies
;
410 size_t assocresp_ies_len
;
414 * enum plink_action - actions to perform in mesh peers
416 * @PLINK_ACTION_INVALID: action 0 is reserved
417 * @PLINK_ACTION_OPEN: start mesh peer link establishment
418 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
421 PLINK_ACTION_INVALID
,
427 * enum station_parameters_apply_mask - station parameter values to apply
428 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
430 * Not all station parameters have in-band "no change" signalling,
431 * for those that don't these flags will are used.
433 enum station_parameters_apply_mask
{
434 STATION_PARAM_APPLY_UAPSD
= BIT(0),
438 * struct station_parameters - station parameters
440 * Used to change and create a new station.
442 * @vlan: vlan interface station should belong to
443 * @supported_rates: supported rates in IEEE 802.11 format
444 * (or NULL for no change)
445 * @supported_rates_len: number of supported rates
446 * @sta_flags_mask: station flags that changed
447 * (bitmask of BIT(NL80211_STA_FLAG_...))
448 * @sta_flags_set: station flags values
449 * (bitmask of BIT(NL80211_STA_FLAG_...))
450 * @listen_interval: listen interval or -1 for no change
451 * @aid: AID or zero for no change
452 * @plink_action: plink action to take
453 * @plink_state: set the peer link state for a station
454 * @ht_capa: HT capabilities of station
455 * @uapsd_queues: bitmap of queues configured for uapsd. same format
456 * as the AC bitmap in the QoS info field
457 * @max_sp: max Service Period. same format as the MAX_SP in the
458 * QoS info field (but already shifted down)
460 struct station_parameters
{
462 struct net_device
*vlan
;
463 u32 sta_flags_mask
, sta_flags_set
;
467 u8 supported_rates_len
;
470 struct ieee80211_ht_cap
*ht_capa
;
476 * enum station_info_flags - station information flags
478 * Used by the driver to indicate which info in &struct station_info
479 * it has filled in during get_station() or dump_station().
481 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
482 * @STATION_INFO_RX_BYTES: @rx_bytes filled
483 * @STATION_INFO_TX_BYTES: @tx_bytes filled
484 * @STATION_INFO_LLID: @llid filled
485 * @STATION_INFO_PLID: @plid filled
486 * @STATION_INFO_PLINK_STATE: @plink_state filled
487 * @STATION_INFO_SIGNAL: @signal filled
488 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
489 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
490 * @STATION_INFO_RX_PACKETS: @rx_packets filled
491 * @STATION_INFO_TX_PACKETS: @tx_packets filled
492 * @STATION_INFO_TX_RETRIES: @tx_retries filled
493 * @STATION_INFO_TX_FAILED: @tx_failed filled
494 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
495 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
496 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
497 * @STATION_INFO_BSS_PARAM: @bss_param filled
498 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
499 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
500 * @STATION_INFO_STA_FLAGS: @sta_flags filled
502 enum station_info_flags
{
503 STATION_INFO_INACTIVE_TIME
= 1<<0,
504 STATION_INFO_RX_BYTES
= 1<<1,
505 STATION_INFO_TX_BYTES
= 1<<2,
506 STATION_INFO_LLID
= 1<<3,
507 STATION_INFO_PLID
= 1<<4,
508 STATION_INFO_PLINK_STATE
= 1<<5,
509 STATION_INFO_SIGNAL
= 1<<6,
510 STATION_INFO_TX_BITRATE
= 1<<7,
511 STATION_INFO_RX_PACKETS
= 1<<8,
512 STATION_INFO_TX_PACKETS
= 1<<9,
513 STATION_INFO_TX_RETRIES
= 1<<10,
514 STATION_INFO_TX_FAILED
= 1<<11,
515 STATION_INFO_RX_DROP_MISC
= 1<<12,
516 STATION_INFO_SIGNAL_AVG
= 1<<13,
517 STATION_INFO_RX_BITRATE
= 1<<14,
518 STATION_INFO_BSS_PARAM
= 1<<15,
519 STATION_INFO_CONNECTED_TIME
= 1<<16,
520 STATION_INFO_ASSOC_REQ_IES
= 1<<17,
521 STATION_INFO_STA_FLAGS
= 1<<18
525 * enum station_info_rate_flags - bitrate info flags
527 * Used by the driver to indicate the specific rate transmission
528 * type for 802.11n transmissions.
530 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
531 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
532 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
534 enum rate_info_flags
{
535 RATE_INFO_FLAGS_MCS
= 1<<0,
536 RATE_INFO_FLAGS_40_MHZ_WIDTH
= 1<<1,
537 RATE_INFO_FLAGS_SHORT_GI
= 1<<2,
541 * struct rate_info - bitrate information
543 * Information about a receiving or transmitting bitrate
545 * @flags: bitflag of flags from &enum rate_info_flags
546 * @mcs: mcs index if struct describes a 802.11n bitrate
547 * @legacy: bitrate in 100kbit/s for 802.11abg
556 * enum station_info_rate_flags - bitrate info flags
558 * Used by the driver to indicate the specific rate transmission
559 * type for 802.11n transmissions.
561 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
562 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
563 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
565 enum bss_param_flags
{
566 BSS_PARAM_FLAGS_CTS_PROT
= 1<<0,
567 BSS_PARAM_FLAGS_SHORT_PREAMBLE
= 1<<1,
568 BSS_PARAM_FLAGS_SHORT_SLOT_TIME
= 1<<2,
572 * struct sta_bss_parameters - BSS parameters for the attached station
574 * Information about the currently associated BSS
576 * @flags: bitflag of flags from &enum bss_param_flags
577 * @dtim_period: DTIM period for the BSS
578 * @beacon_interval: beacon interval
580 struct sta_bss_parameters
{
587 * struct station_info - station information
589 * Station information filled by driver for get_station() and dump_station.
591 * @filled: bitflag of flags from &enum station_info_flags
592 * @connected_time: time(in secs) since a station is last connected
593 * @inactive_time: time since last station activity (tx/rx) in milliseconds
594 * @rx_bytes: bytes received from this station
595 * @tx_bytes: bytes transmitted to this station
596 * @llid: mesh local link id
597 * @plid: mesh peer link id
598 * @plink_state: mesh peer link state
599 * @signal: signal strength of last received packet in dBm
600 * @signal_avg: signal strength average in dBm
601 * @txrate: current unicast bitrate from this station
602 * @rxrate: current unicast bitrate to this station
603 * @rx_packets: packets received from this station
604 * @tx_packets: packets transmitted to this station
605 * @tx_retries: cumulative retry counts
606 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
607 * @rx_dropped_misc: Dropped for un-specified reason.
608 * @bss_param: current BSS parameters
609 * @generation: generation number for nl80211 dumps.
610 * This number should increase every time the list of stations
611 * changes, i.e. when a station is added or removed, so that
612 * userspace can tell whether it got a consistent snapshot.
613 * @assoc_req_ies: IEs from (Re)Association Request.
614 * This is used only when in AP mode with drivers that do not use
615 * user space MLME/SME implementation. The information is provided for
616 * the cfg80211_new_sta() calls to notify user space of the IEs.
617 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
619 struct station_info
{
630 struct rate_info txrate
;
631 struct rate_info rxrate
;
637 struct sta_bss_parameters bss_param
;
638 struct nl80211_sta_flag_update sta_flags
;
642 const u8
*assoc_req_ies
;
643 size_t assoc_req_ies_len
;
646 * Note: Add a new enum station_info_flags value for each new field and
647 * use it to check which fields are initialized.
652 * enum monitor_flags - monitor flags
654 * Monitor interface configuration flags. Note that these must be the bits
655 * according to the nl80211 flags.
657 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
658 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
659 * @MONITOR_FLAG_CONTROL: pass control frames
660 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
661 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
664 MONITOR_FLAG_FCSFAIL
= 1<<NL80211_MNTR_FLAG_FCSFAIL
,
665 MONITOR_FLAG_PLCPFAIL
= 1<<NL80211_MNTR_FLAG_PLCPFAIL
,
666 MONITOR_FLAG_CONTROL
= 1<<NL80211_MNTR_FLAG_CONTROL
,
667 MONITOR_FLAG_OTHER_BSS
= 1<<NL80211_MNTR_FLAG_OTHER_BSS
,
668 MONITOR_FLAG_COOK_FRAMES
= 1<<NL80211_MNTR_FLAG_COOK_FRAMES
,
672 * enum mpath_info_flags - mesh path information flags
674 * Used by the driver to indicate which info in &struct mpath_info it has filled
675 * in during get_station() or dump_station().
677 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
678 * @MPATH_INFO_SN: @sn filled
679 * @MPATH_INFO_METRIC: @metric filled
680 * @MPATH_INFO_EXPTIME: @exptime filled
681 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
682 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
683 * @MPATH_INFO_FLAGS: @flags filled
685 enum mpath_info_flags
{
686 MPATH_INFO_FRAME_QLEN
= BIT(0),
687 MPATH_INFO_SN
= BIT(1),
688 MPATH_INFO_METRIC
= BIT(2),
689 MPATH_INFO_EXPTIME
= BIT(3),
690 MPATH_INFO_DISCOVERY_TIMEOUT
= BIT(4),
691 MPATH_INFO_DISCOVERY_RETRIES
= BIT(5),
692 MPATH_INFO_FLAGS
= BIT(6),
696 * struct mpath_info - mesh path information
698 * Mesh path information filled by driver for get_mpath() and dump_mpath().
700 * @filled: bitfield of flags from &enum mpath_info_flags
701 * @frame_qlen: number of queued frames for this destination
702 * @sn: target sequence number
703 * @metric: metric (cost) of this mesh path
704 * @exptime: expiration time for the mesh path from now, in msecs
705 * @flags: mesh path flags
706 * @discovery_timeout: total mesh path discovery timeout, in msecs
707 * @discovery_retries: mesh path discovery retries
708 * @generation: generation number for nl80211 dumps.
709 * This number should increase every time the list of mesh paths
710 * changes, i.e. when a station is added or removed, so that
711 * userspace can tell whether it got a consistent snapshot.
719 u32 discovery_timeout
;
720 u8 discovery_retries
;
727 * struct bss_parameters - BSS parameters
729 * Used to change BSS parameters (mainly for AP mode).
731 * @use_cts_prot: Whether to use CTS protection
732 * (0 = no, 1 = yes, -1 = do not change)
733 * @use_short_preamble: Whether the use of short preambles is allowed
734 * (0 = no, 1 = yes, -1 = do not change)
735 * @use_short_slot_time: Whether the use of short slot time is allowed
736 * (0 = no, 1 = yes, -1 = do not change)
737 * @basic_rates: basic rates in IEEE 802.11 format
738 * (or NULL for no change)
739 * @basic_rates_len: number of basic rates
740 * @ap_isolate: do not forward packets between connected stations
741 * @ht_opmode: HT Operation mode
742 * (u16 = opmode, -1 = do not change)
744 struct bss_parameters
{
746 int use_short_preamble
;
747 int use_short_slot_time
;
755 * struct mesh_config - 802.11s mesh configuration
757 * These parameters can be changed while the mesh is active.
761 /* Mesh plink management parameters */
762 u16 dot11MeshRetryTimeout
;
763 u16 dot11MeshConfirmTimeout
;
764 u16 dot11MeshHoldingTimeout
;
765 u16 dot11MeshMaxPeerLinks
;
766 u8 dot11MeshMaxRetries
;
768 /* ttl used in path selection information elements */
770 bool auto_open_plinks
;
771 /* HWMP parameters */
772 u8 dot11MeshHWMPmaxPREQretries
;
773 u32 path_refresh_time
;
774 u16 min_discovery_timeout
;
775 u32 dot11MeshHWMPactivePathTimeout
;
776 u16 dot11MeshHWMPpreqMinInterval
;
777 u16 dot11MeshHWMPnetDiameterTraversalTime
;
778 u8 dot11MeshHWMPRootMode
;
779 u16 dot11MeshHWMPRannInterval
;
780 /* This is missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol
781 * set to true only means that the station will announce others it's a
782 * mesh gate, but not necessarily using the gate announcement protocol.
783 * Still keeping the same nomenclature to be in sync with the spec. */
784 bool dot11MeshGateAnnouncementProtocol
;
788 * struct mesh_setup - 802.11s mesh setup configuration
789 * @mesh_id: the mesh ID
790 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
791 * @path_sel_proto: which path selection protocol to use
792 * @path_metric: which metric to use
793 * @ie: vendor information elements (optional)
794 * @ie_len: length of vendor information elements
795 * @is_authenticated: this mesh requires authentication
796 * @is_secure: this mesh uses security
798 * These parameters are fixed when the mesh is created.
807 bool is_authenticated
;
812 * struct ieee80211_txq_params - TX queue parameters
813 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
814 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
815 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
817 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
819 * @aifs: Arbitration interframe space [0..255]
821 struct ieee80211_txq_params
{
822 enum nl80211_txq_q queue
;
829 /* from net/wireless.h */
833 * DOC: Scanning and BSS list handling
835 * The scanning process itself is fairly simple, but cfg80211 offers quite
836 * a bit of helper functionality. To start a scan, the scan operation will
837 * be invoked with a scan definition. This scan definition contains the
838 * channels to scan, and the SSIDs to send probe requests for (including the
839 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
840 * probe. Additionally, a scan request may contain extra information elements
841 * that should be added to the probe request. The IEs are guaranteed to be
842 * well-formed, and will not exceed the maximum length the driver advertised
843 * in the wiphy structure.
845 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
846 * it is responsible for maintaining the BSS list; the driver should not
847 * maintain a list itself. For this notification, various functions exist.
849 * Since drivers do not maintain a BSS list, there are also a number of
850 * functions to search for a BSS and obtain information about it from the
851 * BSS structure cfg80211 maintains. The BSS list is also made available
856 * struct cfg80211_ssid - SSID description
858 * @ssid_len: length of the ssid
860 struct cfg80211_ssid
{
861 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
866 * struct cfg80211_scan_request - scan request description
868 * @ssids: SSIDs to scan for (active scan only)
869 * @n_ssids: number of SSIDs
870 * @channels: channels to scan on.
871 * @n_channels: total number of channels to scan
872 * @ie: optional information element(s) to add into Probe Request or %NULL
873 * @ie_len: length of ie in octets
874 * @rates: bitmap of rates to advertise for each band
875 * @wiphy: the wiphy this was for
876 * @dev: the interface
877 * @aborted: (internal) scan request was notified as aborted
878 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
880 struct cfg80211_scan_request
{
881 struct cfg80211_ssid
*ssids
;
887 u32 rates
[IEEE80211_NUM_BANDS
];
891 struct net_device
*dev
;
896 struct ieee80211_channel
*channels
[0];
900 * struct cfg80211_match_set - sets of attributes to match
902 * @ssid: SSID to be matched
904 struct cfg80211_match_set
{
905 struct cfg80211_ssid ssid
;
909 * struct cfg80211_sched_scan_request - scheduled scan request description
911 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
912 * @n_ssids: number of SSIDs
913 * @n_channels: total number of channels to scan
914 * @interval: interval between each scheduled scan cycle
915 * @ie: optional information element(s) to add into Probe Request or %NULL
916 * @ie_len: length of ie in octets
917 * @match_sets: sets of parameters to be matched for a scan result
918 * entry to be considered valid and to be passed to the host
919 * (others are filtered out).
920 * If ommited, all results are passed.
921 * @n_match_sets: number of match sets
922 * @wiphy: the wiphy this was for
923 * @dev: the interface
924 * @channels: channels to scan
926 struct cfg80211_sched_scan_request
{
927 struct cfg80211_ssid
*ssids
;
933 struct cfg80211_match_set
*match_sets
;
938 struct net_device
*dev
;
941 struct ieee80211_channel
*channels
[0];
945 * enum cfg80211_signal_type - signal type
947 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
948 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
949 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
951 enum cfg80211_signal_type
{
952 CFG80211_SIGNAL_TYPE_NONE
,
953 CFG80211_SIGNAL_TYPE_MBM
,
954 CFG80211_SIGNAL_TYPE_UNSPEC
,
958 * struct cfg80211_bss - BSS description
960 * This structure describes a BSS (which may also be a mesh network)
961 * for use in scan results and similar.
963 * @channel: channel this BSS is on
964 * @bssid: BSSID of the BSS
965 * @tsf: timestamp of last received update
966 * @beacon_interval: the beacon interval as from the frame
967 * @capability: the capability field in host byte order
968 * @information_elements: the information elements (Note that there
969 * is no guarantee that these are well-formed!); this is a pointer to
970 * either the beacon_ies or proberesp_ies depending on whether Probe
971 * Response frame has been received
972 * @len_information_elements: total length of the information elements
973 * @beacon_ies: the information elements from the last Beacon frame
974 * @len_beacon_ies: total length of the beacon_ies
975 * @proberesp_ies: the information elements from the last Probe Response frame
976 * @len_proberesp_ies: total length of the proberesp_ies
977 * @signal: signal strength value (type depends on the wiphy's signal_type)
978 * @free_priv: function pointer to free private data
979 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
981 struct cfg80211_bss
{
982 struct ieee80211_channel
*channel
;
988 u8
*information_elements
;
989 size_t len_information_elements
;
991 size_t len_beacon_ies
;
993 size_t len_proberesp_ies
;
997 void (*free_priv
)(struct cfg80211_bss
*bss
);
998 u8 priv
[0] __attribute__((__aligned__(sizeof(void *))));
1002 * ieee80211_bss_get_ie - find IE with given ID
1003 * @bss: the bss to search
1005 * Returns %NULL if not found.
1007 const u8
*ieee80211_bss_get_ie(struct cfg80211_bss
*bss
, u8 ie
);
1011 * struct cfg80211_auth_request - Authentication request data
1013 * This structure provides information needed to complete IEEE 802.11
1016 * @bss: The BSS to authenticate with.
1017 * @auth_type: Authentication type (algorithm)
1018 * @ie: Extra IEs to add to Authentication frame or %NULL
1019 * @ie_len: Length of ie buffer in octets
1020 * @key_len: length of WEP key for shared key authentication
1021 * @key_idx: index of WEP key for shared key authentication
1022 * @key: WEP key for shared key authentication
1023 * @local_state_change: This is a request for a local state only, i.e., no
1024 * Authentication frame is to be transmitted and authentication state is
1025 * to be changed without having to wait for a response from the peer STA
1028 struct cfg80211_auth_request
{
1029 struct cfg80211_bss
*bss
;
1032 enum nl80211_auth_type auth_type
;
1034 u8 key_len
, key_idx
;
1035 bool local_state_change
;
1039 * struct cfg80211_assoc_request - (Re)Association request data
1041 * This structure provides information needed to complete IEEE 802.11
1043 * @bss: The BSS to associate with.
1044 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1045 * @ie_len: Length of ie buffer in octets
1046 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1047 * @crypto: crypto settings
1048 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1050 struct cfg80211_assoc_request
{
1051 struct cfg80211_bss
*bss
;
1052 const u8
*ie
, *prev_bssid
;
1054 struct cfg80211_crypto_settings crypto
;
1059 * struct cfg80211_deauth_request - Deauthentication request data
1061 * This structure provides information needed to complete IEEE 802.11
1064 * @bss: the BSS to deauthenticate from
1065 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1066 * @ie_len: Length of ie buffer in octets
1067 * @reason_code: The reason code for the deauthentication
1068 * @local_state_change: This is a request for a local state only, i.e., no
1069 * Deauthentication frame is to be transmitted.
1071 struct cfg80211_deauth_request
{
1072 struct cfg80211_bss
*bss
;
1076 bool local_state_change
;
1080 * struct cfg80211_disassoc_request - Disassociation request data
1082 * This structure provides information needed to complete IEEE 802.11
1085 * @bss: the BSS to disassociate from
1086 * @ie: Extra IEs to add to Disassociation frame or %NULL
1087 * @ie_len: Length of ie buffer in octets
1088 * @reason_code: The reason code for the disassociation
1089 * @local_state_change: This is a request for a local state only, i.e., no
1090 * Disassociation frame is to be transmitted.
1092 struct cfg80211_disassoc_request
{
1093 struct cfg80211_bss
*bss
;
1097 bool local_state_change
;
1101 * struct cfg80211_ibss_params - IBSS parameters
1103 * This structure defines the IBSS parameters for the join_ibss()
1106 * @ssid: The SSID, will always be non-null.
1107 * @ssid_len: The length of the SSID, will always be non-zero.
1108 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1109 * search for IBSSs with a different BSSID.
1110 * @channel: The channel to use if no IBSS can be found to join.
1111 * @channel_fixed: The channel should be fixed -- do not search for
1112 * IBSSs to join on other channels.
1113 * @ie: information element(s) to include in the beacon
1114 * @ie_len: length of that
1115 * @beacon_interval: beacon interval to use
1116 * @privacy: this is a protected network, keys will be configured
1118 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1119 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1121 struct cfg80211_ibss_params
{
1124 struct ieee80211_channel
*channel
;
1126 u8 ssid_len
, ie_len
;
1127 u16 beacon_interval
;
1131 int mcast_rate
[IEEE80211_NUM_BANDS
];
1135 * struct cfg80211_connect_params - Connection parameters
1137 * This structure provides information needed to complete IEEE 802.11
1138 * authentication and association.
1140 * @channel: The channel to use or %NULL if not specified (auto-select based
1142 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1145 * @ssid_len: Length of ssid in octets
1146 * @auth_type: Authentication type (algorithm)
1147 * @ie: IEs for association request
1148 * @ie_len: Length of assoc_ie in octets
1149 * @privacy: indicates whether privacy-enabled APs should be used
1150 * @crypto: crypto settings
1151 * @key_len: length of WEP key for shared key authentication
1152 * @key_idx: index of WEP key for shared key authentication
1153 * @key: WEP key for shared key authentication
1155 struct cfg80211_connect_params
{
1156 struct ieee80211_channel
*channel
;
1160 enum nl80211_auth_type auth_type
;
1164 struct cfg80211_crypto_settings crypto
;
1166 u8 key_len
, key_idx
;
1170 * enum wiphy_params_flags - set_wiphy_params bitfield values
1171 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1172 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1173 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1174 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1175 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1177 enum wiphy_params_flags
{
1178 WIPHY_PARAM_RETRY_SHORT
= 1 << 0,
1179 WIPHY_PARAM_RETRY_LONG
= 1 << 1,
1180 WIPHY_PARAM_FRAG_THRESHOLD
= 1 << 2,
1181 WIPHY_PARAM_RTS_THRESHOLD
= 1 << 3,
1182 WIPHY_PARAM_COVERAGE_CLASS
= 1 << 4,
1186 * cfg80211_bitrate_mask - masks for bitrate control
1188 struct cfg80211_bitrate_mask
{
1191 /* TODO: add support for masking MCS rates; e.g.: */
1192 /* u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; */
1193 } control
[IEEE80211_NUM_BANDS
];
1196 * struct cfg80211_pmksa - PMK Security Association
1198 * This structure is passed to the set/del_pmksa() method for PMKSA
1201 * @bssid: The AP's BSSID.
1202 * @pmkid: The PMK material itself.
1204 struct cfg80211_pmksa
{
1210 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1211 * @mask: bitmask where to match pattern and where to ignore bytes,
1212 * one bit per byte, in same format as nl80211
1213 * @pattern: bytes to match where bitmask is 1
1214 * @pattern_len: length of pattern (in bytes)
1216 * Internal note: @mask and @pattern are allocated in one chunk of
1217 * memory, free @mask only!
1219 struct cfg80211_wowlan_trig_pkt_pattern
{
1225 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1227 * This structure defines the enabled WoWLAN triggers for the device.
1228 * @any: wake up on any activity -- special trigger if device continues
1229 * operating as normal during suspend
1230 * @disconnect: wake up if getting disconnected
1231 * @magic_pkt: wake up on receiving magic packet
1232 * @patterns: wake up on receiving packet matching a pattern
1233 * @n_patterns: number of patterns
1234 * @gtk_rekey_failure: wake up on GTK rekey failure
1235 * @eap_identity_req: wake up on EAP identity request packet
1236 * @four_way_handshake: wake up on 4-way handshake
1237 * @rfkill_release: wake up when rfkill is released
1239 struct cfg80211_wowlan
{
1240 bool any
, disconnect
, magic_pkt
, gtk_rekey_failure
,
1241 eap_identity_req
, four_way_handshake
,
1243 struct cfg80211_wowlan_trig_pkt_pattern
*patterns
;
1248 * struct cfg80211_gtk_rekey_data - rekey data
1249 * @kek: key encryption key
1250 * @kck: key confirmation key
1251 * @replay_ctr: replay counter
1253 struct cfg80211_gtk_rekey_data
{
1254 u8 kek
[NL80211_KEK_LEN
];
1255 u8 kck
[NL80211_KCK_LEN
];
1256 u8 replay_ctr
[NL80211_REPLAY_CTR_LEN
];
1260 * struct cfg80211_ops - backend description for wireless configuration
1262 * This struct is registered by fullmac card drivers and/or wireless stacks
1263 * in order to handle configuration requests on their interfaces.
1265 * All callbacks except where otherwise noted should return 0
1266 * on success or a negative error code.
1268 * All operations are currently invoked under rtnl for consistency with the
1269 * wireless extensions but this is subject to reevaluation as soon as this
1270 * code is used more widely and we have a first user without wext.
1272 * @suspend: wiphy device needs to be suspended. The variable @wow will
1273 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1274 * configured for the device.
1275 * @resume: wiphy device needs to be resumed
1277 * @add_virtual_intf: create a new virtual interface with the given name,
1278 * must set the struct wireless_dev's iftype. Beware: You must create
1279 * the new netdev in the wiphy's network namespace! Returns the netdev,
1282 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1284 * @change_virtual_intf: change type/configuration of virtual interface,
1285 * keep the struct wireless_dev's iftype updated.
1287 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1288 * when adding a group key.
1290 * @get_key: get information about the key with the given parameters.
1291 * @mac_addr will be %NULL when requesting information for a group
1292 * key. All pointers given to the @callback function need not be valid
1293 * after it returns. This function should return an error if it is
1294 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1296 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1297 * and @key_index, return -ENOENT if the key doesn't exist.
1299 * @set_default_key: set the default key on an interface
1301 * @set_default_mgmt_key: set the default management frame key on an interface
1303 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1305 * @add_beacon: Add a beacon with given parameters, @head, @interval
1306 * and @dtim_period will be valid, @tail is optional.
1307 * @set_beacon: Change the beacon parameters for an access point mode
1308 * interface. This should reject the call when no beacon has been
1310 * @del_beacon: Remove beacon configuration and stop sending the beacon.
1312 * @add_station: Add a new station.
1313 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1314 * @change_station: Modify a given station.
1315 * @get_station: get station information for the station identified by @mac
1316 * @dump_station: dump station callback -- resume dump at index @idx
1318 * @add_mpath: add a fixed mesh path
1319 * @del_mpath: delete a given mesh path
1320 * @change_mpath: change a given mesh path
1321 * @get_mpath: get a mesh path for the given parameters
1322 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1323 * @join_mesh: join the mesh network with the specified parameters
1324 * @leave_mesh: leave the current mesh network
1326 * @get_mesh_config: Get the current mesh configuration
1328 * @update_mesh_config: Update mesh parameters on a running mesh.
1329 * The mask is a bitfield which tells us which parameters to
1330 * set, and which to leave alone.
1332 * @change_bss: Modify parameters for a given BSS.
1334 * @set_txq_params: Set TX queue parameters
1336 * @set_channel: Set channel for a given wireless interface. Some devices
1337 * may support multi-channel operation (by channel hopping) so cfg80211
1338 * doesn't verify much. Note, however, that the passed netdev may be
1339 * %NULL as well if the user requested changing the channel for the
1340 * device itself, or for a monitor interface.
1342 * @scan: Request to do a scan. If returning zero, the scan request is given
1343 * the driver, and will be valid until passed to cfg80211_scan_done().
1344 * For scan results, call cfg80211_inform_bss(); you can call this outside
1345 * the scan/scan_done bracket too.
1347 * @auth: Request to authenticate with the specified peer
1348 * @assoc: Request to (re)associate with the specified peer
1349 * @deauth: Request to deauthenticate from the specified peer
1350 * @disassoc: Request to disassociate from the specified peer
1352 * @connect: Connect to the ESS with the specified parameters. When connected,
1353 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1354 * If the connection fails for some reason, call cfg80211_connect_result()
1355 * with the status from the AP.
1356 * @disconnect: Disconnect from the BSS/ESS.
1358 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1359 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1361 * @leave_ibss: Leave the IBSS.
1363 * @set_wiphy_params: Notify that wiphy parameters have changed;
1364 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1365 * have changed. The actual parameter values are available in
1366 * struct wiphy. If returning an error, no value should be changed.
1368 * @set_tx_power: set the transmit power according to the parameters
1369 * @get_tx_power: store the current TX power into the dbm variable;
1370 * return 0 if successful
1372 * @set_wds_peer: set the WDS peer for a WDS interface
1374 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1375 * functions to adjust rfkill hw state
1377 * @dump_survey: get site survey information.
1379 * @remain_on_channel: Request the driver to remain awake on the specified
1380 * channel for the specified duration to complete an off-channel
1381 * operation (e.g., public action frame exchange). When the driver is
1382 * ready on the requested channel, it must indicate this with an event
1383 * notification by calling cfg80211_ready_on_channel().
1384 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1385 * This allows the operation to be terminated prior to timeout based on
1386 * the duration value.
1387 * @mgmt_tx: Transmit a management frame.
1388 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1389 * frame on another channel
1391 * @testmode_cmd: run a test mode command
1392 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1393 * used by the function, but 0 and 1 must not be touched. Additionally,
1394 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1395 * dump and return to userspace with an error, so be careful. If any data
1396 * was passed in from userspace then the data/len arguments will be present
1397 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1399 * @set_bitrate_mask: set the bitrate mask configuration
1401 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1402 * devices running firmwares capable of generating the (re) association
1403 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1404 * @del_pmksa: Delete a cached PMKID.
1405 * @flush_pmksa: Flush all cached PMKIDs.
1406 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1407 * allows the driver to adjust the dynamic ps timeout value.
1408 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1409 * @sched_scan_start: Tell the driver to start a scheduled scan.
1410 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled
1411 * scan. The driver_initiated flag specifies whether the driver
1412 * itself has informed that the scan has stopped.
1414 * @mgmt_frame_register: Notify driver that a management frame type was
1415 * registered. Note that this callback may not sleep, and cannot run
1416 * concurrently with itself.
1418 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1419 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1420 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1421 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1423 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1425 * @set_ringparam: Set tx and rx ring sizes.
1427 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1429 * @tdls_mgmt: Transmit a TDLS management frame.
1430 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1432 struct cfg80211_ops
{
1433 int (*suspend
)(struct wiphy
*wiphy
, struct cfg80211_wowlan
*wow
);
1434 int (*resume
)(struct wiphy
*wiphy
);
1436 struct net_device
* (*add_virtual_intf
)(struct wiphy
*wiphy
,
1438 enum nl80211_iftype type
,
1440 struct vif_params
*params
);
1441 int (*del_virtual_intf
)(struct wiphy
*wiphy
, struct net_device
*dev
);
1442 int (*change_virtual_intf
)(struct wiphy
*wiphy
,
1443 struct net_device
*dev
,
1444 enum nl80211_iftype type
, u32
*flags
,
1445 struct vif_params
*params
);
1447 int (*add_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1448 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
1449 struct key_params
*params
);
1450 int (*get_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1451 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
1453 void (*callback
)(void *cookie
, struct key_params
*));
1454 int (*del_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1455 u8 key_index
, bool pairwise
, const u8
*mac_addr
);
1456 int (*set_default_key
)(struct wiphy
*wiphy
,
1457 struct net_device
*netdev
,
1458 u8 key_index
, bool unicast
, bool multicast
);
1459 int (*set_default_mgmt_key
)(struct wiphy
*wiphy
,
1460 struct net_device
*netdev
,
1463 int (*add_beacon
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1464 struct beacon_parameters
*info
);
1465 int (*set_beacon
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1466 struct beacon_parameters
*info
);
1467 int (*del_beacon
)(struct wiphy
*wiphy
, struct net_device
*dev
);
1470 int (*add_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1471 u8
*mac
, struct station_parameters
*params
);
1472 int (*del_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1474 int (*change_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1475 u8
*mac
, struct station_parameters
*params
);
1476 int (*get_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1477 u8
*mac
, struct station_info
*sinfo
);
1478 int (*dump_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1479 int idx
, u8
*mac
, struct station_info
*sinfo
);
1481 int (*add_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1482 u8
*dst
, u8
*next_hop
);
1483 int (*del_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1485 int (*change_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1486 u8
*dst
, u8
*next_hop
);
1487 int (*get_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1488 u8
*dst
, u8
*next_hop
,
1489 struct mpath_info
*pinfo
);
1490 int (*dump_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1491 int idx
, u8
*dst
, u8
*next_hop
,
1492 struct mpath_info
*pinfo
);
1493 int (*get_mesh_config
)(struct wiphy
*wiphy
,
1494 struct net_device
*dev
,
1495 struct mesh_config
*conf
);
1496 int (*update_mesh_config
)(struct wiphy
*wiphy
,
1497 struct net_device
*dev
, u32 mask
,
1498 const struct mesh_config
*nconf
);
1499 int (*join_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1500 const struct mesh_config
*conf
,
1501 const struct mesh_setup
*setup
);
1502 int (*leave_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
);
1504 int (*change_bss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1505 struct bss_parameters
*params
);
1507 int (*set_txq_params
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1508 struct ieee80211_txq_params
*params
);
1510 int (*set_channel
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1511 struct ieee80211_channel
*chan
,
1512 enum nl80211_channel_type channel_type
);
1514 int (*scan
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1515 struct cfg80211_scan_request
*request
);
1517 int (*auth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1518 struct cfg80211_auth_request
*req
);
1519 int (*assoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1520 struct cfg80211_assoc_request
*req
);
1521 int (*deauth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1522 struct cfg80211_deauth_request
*req
,
1524 int (*disassoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1525 struct cfg80211_disassoc_request
*req
,
1528 int (*connect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1529 struct cfg80211_connect_params
*sme
);
1530 int (*disconnect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1533 int (*join_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1534 struct cfg80211_ibss_params
*params
);
1535 int (*leave_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
);
1537 int (*set_wiphy_params
)(struct wiphy
*wiphy
, u32 changed
);
1539 int (*set_tx_power
)(struct wiphy
*wiphy
,
1540 enum nl80211_tx_power_setting type
, int mbm
);
1541 int (*get_tx_power
)(struct wiphy
*wiphy
, int *dbm
);
1543 int (*set_wds_peer
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1546 void (*rfkill_poll
)(struct wiphy
*wiphy
);
1548 #ifdef CONFIG_NL80211_TESTMODE
1549 int (*testmode_cmd
)(struct wiphy
*wiphy
, void *data
, int len
);
1550 int (*testmode_dump
)(struct wiphy
*wiphy
, struct sk_buff
*skb
,
1551 struct netlink_callback
*cb
,
1552 void *data
, int len
);
1555 int (*set_bitrate_mask
)(struct wiphy
*wiphy
,
1556 struct net_device
*dev
,
1558 const struct cfg80211_bitrate_mask
*mask
);
1560 int (*dump_survey
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1561 int idx
, struct survey_info
*info
);
1563 int (*set_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1564 struct cfg80211_pmksa
*pmksa
);
1565 int (*del_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1566 struct cfg80211_pmksa
*pmksa
);
1567 int (*flush_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
);
1569 int (*remain_on_channel
)(struct wiphy
*wiphy
,
1570 struct net_device
*dev
,
1571 struct ieee80211_channel
*chan
,
1572 enum nl80211_channel_type channel_type
,
1573 unsigned int duration
,
1575 int (*cancel_remain_on_channel
)(struct wiphy
*wiphy
,
1576 struct net_device
*dev
,
1579 int (*mgmt_tx
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1580 struct ieee80211_channel
*chan
, bool offchan
,
1581 enum nl80211_channel_type channel_type
,
1582 bool channel_type_valid
, unsigned int wait
,
1583 const u8
*buf
, size_t len
, bool no_cck
,
1585 int (*mgmt_tx_cancel_wait
)(struct wiphy
*wiphy
,
1586 struct net_device
*dev
,
1589 int (*set_power_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1590 bool enabled
, int timeout
);
1592 int (*set_cqm_rssi_config
)(struct wiphy
*wiphy
,
1593 struct net_device
*dev
,
1594 s32 rssi_thold
, u32 rssi_hyst
);
1596 void (*mgmt_frame_register
)(struct wiphy
*wiphy
,
1597 struct net_device
*dev
,
1598 u16 frame_type
, bool reg
);
1600 int (*set_antenna
)(struct wiphy
*wiphy
, u32 tx_ant
, u32 rx_ant
);
1601 int (*get_antenna
)(struct wiphy
*wiphy
, u32
*tx_ant
, u32
*rx_ant
);
1603 int (*set_ringparam
)(struct wiphy
*wiphy
, u32 tx
, u32 rx
);
1604 void (*get_ringparam
)(struct wiphy
*wiphy
,
1605 u32
*tx
, u32
*tx_max
, u32
*rx
, u32
*rx_max
);
1607 int (*sched_scan_start
)(struct wiphy
*wiphy
,
1608 struct net_device
*dev
,
1609 struct cfg80211_sched_scan_request
*request
);
1610 int (*sched_scan_stop
)(struct wiphy
*wiphy
, struct net_device
*dev
);
1612 int (*set_rekey_data
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1613 struct cfg80211_gtk_rekey_data
*data
);
1615 int (*tdls_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1616 u8
*peer
, u8 action_code
, u8 dialog_token
,
1617 u16 status_code
, const u8
*buf
, size_t len
);
1618 int (*tdls_oper
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1619 u8
*peer
, enum nl80211_tdls_operation oper
);
1623 * wireless hardware and networking interfaces structures
1624 * and registration/helper functions
1628 * enum wiphy_flags - wiphy capability flags
1630 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1631 * has its own custom regulatory domain and cannot identify the
1632 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1633 * we will disregard the first regulatory hint (when the
1634 * initiator is %REGDOM_SET_BY_CORE).
1635 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1636 * ignore regulatory domain settings until it gets its own regulatory
1637 * domain via its regulatory_hint() unless the regulatory hint is
1638 * from a country IE. After its gets its own regulatory domain it will
1639 * only allow further regulatory domain settings to further enhance
1640 * compliance. For example if channel 13 and 14 are disabled by this
1641 * regulatory domain no user regulatory domain can enable these channels
1642 * at a later time. This can be used for devices which do not have
1643 * calibration information guaranteed for frequencies or settings
1644 * outside of its regulatory domain.
1645 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1646 * that passive scan flags and beaconing flags may not be lifted by
1647 * cfg80211 due to regulatory beacon hints. For more information on beacon
1648 * hints read the documenation for regulatory_hint_found_beacon()
1649 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1651 * @WIPHY_FLAG_ENFORCE_COMBINATIONS: Set this flag to enforce interface
1652 * combinations for this device. This flag is used for backward
1653 * compatibility only until all drivers advertise combinations and
1654 * they will always be enforced.
1655 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1656 * by default -- this flag will be set depending on the kernel's default
1657 * on wiphy_new(), but can be changed by the driver if it has a good
1658 * reason to override the default
1659 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1660 * on a VLAN interface)
1661 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1662 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1663 * control port protocol ethertype. The device also honours the
1664 * control_port_no_encrypt flag.
1665 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1666 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1667 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1668 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
1669 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
1671 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
1672 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
1673 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
1674 * link setup/discovery operations internally. Setup, discovery and
1675 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
1676 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
1677 * used for asking the driver/firmware to perform a TDLS operation.
1680 WIPHY_FLAG_CUSTOM_REGULATORY
= BIT(0),
1681 WIPHY_FLAG_STRICT_REGULATORY
= BIT(1),
1682 WIPHY_FLAG_DISABLE_BEACON_HINTS
= BIT(2),
1683 WIPHY_FLAG_NETNS_OK
= BIT(3),
1684 WIPHY_FLAG_PS_ON_BY_DEFAULT
= BIT(4),
1685 WIPHY_FLAG_4ADDR_AP
= BIT(5),
1686 WIPHY_FLAG_4ADDR_STATION
= BIT(6),
1687 WIPHY_FLAG_CONTROL_PORT_PROTOCOL
= BIT(7),
1688 WIPHY_FLAG_IBSS_RSN
= BIT(8),
1689 WIPHY_FLAG_MESH_AUTH
= BIT(10),
1690 WIPHY_FLAG_SUPPORTS_SCHED_SCAN
= BIT(11),
1691 WIPHY_FLAG_ENFORCE_COMBINATIONS
= BIT(12),
1692 WIPHY_FLAG_SUPPORTS_FW_ROAM
= BIT(13),
1693 WIPHY_FLAG_AP_UAPSD
= BIT(14),
1694 WIPHY_FLAG_SUPPORTS_TDLS
= BIT(15),
1695 WIPHY_FLAG_TDLS_EXTERNAL_SETUP
= BIT(16),
1699 * struct ieee80211_iface_limit - limit on certain interface types
1700 * @max: maximum number of interfaces of these types
1701 * @types: interface types (bits)
1703 struct ieee80211_iface_limit
{
1709 * struct ieee80211_iface_combination - possible interface combination
1710 * @limits: limits for the given interface types
1711 * @n_limits: number of limitations
1712 * @num_different_channels: can use up to this many different channels
1713 * @max_interfaces: maximum number of interfaces in total allowed in this
1715 * @beacon_int_infra_match: In this combination, the beacon intervals
1716 * between infrastructure and AP types must match. This is required
1717 * only in special cases.
1719 * These examples can be expressed as follows:
1721 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
1723 * struct ieee80211_iface_limit limits1[] = {
1724 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1725 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
1727 * struct ieee80211_iface_combination combination1 = {
1728 * .limits = limits1,
1729 * .n_limits = ARRAY_SIZE(limits1),
1730 * .max_interfaces = 2,
1731 * .beacon_int_infra_match = true,
1735 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
1737 * struct ieee80211_iface_limit limits2[] = {
1738 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
1739 * BIT(NL80211_IFTYPE_P2P_GO), },
1741 * struct ieee80211_iface_combination combination2 = {
1742 * .limits = limits2,
1743 * .n_limits = ARRAY_SIZE(limits2),
1744 * .max_interfaces = 8,
1745 * .num_different_channels = 1,
1749 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
1750 * This allows for an infrastructure connection and three P2P connections.
1752 * struct ieee80211_iface_limit limits3[] = {
1753 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1754 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
1755 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
1757 * struct ieee80211_iface_combination combination3 = {
1758 * .limits = limits3,
1759 * .n_limits = ARRAY_SIZE(limits3),
1760 * .max_interfaces = 4,
1761 * .num_different_channels = 2,
1764 struct ieee80211_iface_combination
{
1765 const struct ieee80211_iface_limit
*limits
;
1766 u32 num_different_channels
;
1769 bool beacon_int_infra_match
;
1772 struct mac_address
{
1776 struct ieee80211_txrx_stypes
{
1781 * enum wiphy_wowlan_support_flags - WoWLAN support flags
1782 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
1783 * trigger that keeps the device operating as-is and
1784 * wakes up the host on any activity, for example a
1785 * received packet that passed filtering; note that the
1786 * packet should be preserved in that case
1787 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
1789 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
1790 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
1791 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
1792 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
1793 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
1794 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
1796 enum wiphy_wowlan_support_flags
{
1797 WIPHY_WOWLAN_ANY
= BIT(0),
1798 WIPHY_WOWLAN_MAGIC_PKT
= BIT(1),
1799 WIPHY_WOWLAN_DISCONNECT
= BIT(2),
1800 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY
= BIT(3),
1801 WIPHY_WOWLAN_GTK_REKEY_FAILURE
= BIT(4),
1802 WIPHY_WOWLAN_EAP_IDENTITY_REQ
= BIT(5),
1803 WIPHY_WOWLAN_4WAY_HANDSHAKE
= BIT(6),
1804 WIPHY_WOWLAN_RFKILL_RELEASE
= BIT(7),
1808 * struct wiphy_wowlan_support - WoWLAN support data
1809 * @flags: see &enum wiphy_wowlan_support_flags
1810 * @n_patterns: number of supported wakeup patterns
1811 * (see nl80211.h for the pattern definition)
1812 * @pattern_max_len: maximum length of each pattern
1813 * @pattern_min_len: minimum length of each pattern
1815 struct wiphy_wowlan_support
{
1818 int pattern_max_len
;
1819 int pattern_min_len
;
1823 * struct wiphy - wireless hardware description
1824 * @reg_notifier: the driver's regulatory notification callback,
1825 * note that if your driver uses wiphy_apply_custom_regulatory()
1826 * the reg_notifier's request can be passed as NULL
1827 * @regd: the driver's regulatory domain, if one was requested via
1828 * the regulatory_hint() API. This can be used by the driver
1829 * on the reg_notifier() if it chooses to ignore future
1830 * regulatory domain changes caused by other drivers.
1831 * @signal_type: signal type reported in &struct cfg80211_bss.
1832 * @cipher_suites: supported cipher suites
1833 * @n_cipher_suites: number of supported cipher suites
1834 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1835 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1836 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1837 * -1 = fragmentation disabled, only odd values >= 256 used
1838 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1839 * @_net: the network namespace this wiphy currently lives in
1840 * @perm_addr: permanent MAC address of this device
1841 * @addr_mask: If the device supports multiple MAC addresses by masking,
1842 * set this to a mask with variable bits set to 1, e.g. if the last
1843 * four bits are variable then set it to 00:...:00:0f. The actual
1844 * variable bits shall be determined by the interfaces added, with
1845 * interfaces not matching the mask being rejected to be brought up.
1846 * @n_addresses: number of addresses in @addresses.
1847 * @addresses: If the device has more than one address, set this pointer
1848 * to a list of addresses (6 bytes each). The first one will be used
1849 * by default for perm_addr. In this case, the mask should be set to
1850 * all-zeroes. In this case it is assumed that the device can handle
1851 * the same number of arbitrary MAC addresses.
1852 * @registered: protects ->resume and ->suspend sysfs callbacks against
1853 * unregister hardware
1854 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
1855 * automatically on wiphy renames
1856 * @dev: (virtual) struct device for this wiphy
1857 * @registered: helps synchronize suspend/resume with wiphy unregister
1858 * @wext: wireless extension handlers
1859 * @priv: driver private data (sized according to wiphy_new() parameter)
1860 * @interface_modes: bitmask of interfaces types valid for this wiphy,
1861 * must be set by driver
1862 * @iface_combinations: Valid interface combinations array, should not
1863 * list single interface types.
1864 * @n_iface_combinations: number of entries in @iface_combinations array.
1865 * @software_iftypes: bitmask of software interface types, these are not
1866 * subject to any restrictions since they are purely managed in SW.
1867 * @flags: wiphy flags, see &enum wiphy_flags
1868 * @bss_priv_size: each BSS struct has private data allocated with it,
1869 * this variable determines its size
1870 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
1872 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
1873 * for in any given scheduled scan
1874 * @max_match_sets: maximum number of match sets the device can handle
1875 * when performing a scheduled scan, 0 if filtering is not
1877 * @max_scan_ie_len: maximum length of user-controlled IEs device can
1878 * add to probe request frames transmitted during a scan, must not
1879 * include fixed IEs like supported rates
1880 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
1882 * @coverage_class: current coverage class
1883 * @fw_version: firmware version for ethtool reporting
1884 * @hw_version: hardware version for ethtool reporting
1885 * @max_num_pmkids: maximum number of PMKIDs supported by device
1886 * @privid: a pointer that drivers can use to identify if an arbitrary
1887 * wiphy is theirs, e.g. in global notifiers
1888 * @bands: information about bands/channels supported by this device
1890 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
1891 * transmitted through nl80211, points to an array indexed by interface
1894 * @available_antennas_tx: bitmap of antennas which are available to be
1895 * configured as TX antennas. Antenna configuration commands will be
1896 * rejected unless this or @available_antennas_rx is set.
1898 * @available_antennas_rx: bitmap of antennas which are available to be
1899 * configured as RX antennas. Antenna configuration commands will be
1900 * rejected unless this or @available_antennas_tx is set.
1902 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
1903 * may request, if implemented.
1905 * @wowlan: WoWLAN support information
1908 /* assign these fields before you register the wiphy */
1910 /* permanent MAC address(es) */
1911 u8 perm_addr
[ETH_ALEN
];
1912 u8 addr_mask
[ETH_ALEN
];
1914 struct mac_address
*addresses
;
1916 const struct ieee80211_txrx_stypes
*mgmt_stypes
;
1918 const struct ieee80211_iface_combination
*iface_combinations
;
1919 int n_iface_combinations
;
1920 u16 software_iftypes
;
1924 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
1925 u16 interface_modes
;
1929 enum cfg80211_signal_type signal_type
;
1933 u8 max_sched_scan_ssids
;
1935 u16 max_scan_ie_len
;
1936 u16 max_sched_scan_ie_len
;
1938 int n_cipher_suites
;
1939 const u32
*cipher_suites
;
1947 char fw_version
[ETHTOOL_BUSINFO_LEN
];
1950 struct wiphy_wowlan_support wowlan
;
1952 u16 max_remain_on_channel_duration
;
1956 u32 available_antennas_tx
;
1957 u32 available_antennas_rx
;
1959 /* If multiple wiphys are registered and you're handed e.g.
1960 * a regular netdev with assigned ieee80211_ptr, you won't
1961 * know whether it points to a wiphy your driver has registered
1962 * or not. Assign this to something global to your driver to
1963 * help determine whether you own this wiphy or not. */
1966 struct ieee80211_supported_band
*bands
[IEEE80211_NUM_BANDS
];
1968 /* Lets us get back the wiphy on the callback */
1969 int (*reg_notifier
)(struct wiphy
*wiphy
,
1970 struct regulatory_request
*request
);
1972 /* fields below are read-only, assigned by cfg80211 */
1974 const struct ieee80211_regdomain
*regd
;
1976 /* the item in /sys/class/ieee80211/ points to this,
1977 * you need use set_wiphy_dev() (see below) */
1980 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
1983 /* dir in debugfs: ieee80211/<wiphyname> */
1984 struct dentry
*debugfsdir
;
1986 #ifdef CONFIG_NET_NS
1987 /* the network namespace this phy lives in currently */
1991 #ifdef CONFIG_CFG80211_WEXT
1992 const struct iw_handler_def
*wext
;
1995 char priv
[0] __attribute__((__aligned__(NETDEV_ALIGN
)));
1998 static inline struct net
*wiphy_net(struct wiphy
*wiphy
)
2000 return read_pnet(&wiphy
->_net
);
2003 static inline void wiphy_net_set(struct wiphy
*wiphy
, struct net
*net
)
2005 write_pnet(&wiphy
->_net
, net
);
2009 * wiphy_priv - return priv from wiphy
2011 * @wiphy: the wiphy whose priv pointer to return
2013 static inline void *wiphy_priv(struct wiphy
*wiphy
)
2016 return &wiphy
->priv
;
2020 * priv_to_wiphy - return the wiphy containing the priv
2022 * @priv: a pointer previously returned by wiphy_priv
2024 static inline struct wiphy
*priv_to_wiphy(void *priv
)
2027 return container_of(priv
, struct wiphy
, priv
);
2031 * set_wiphy_dev - set device pointer for wiphy
2033 * @wiphy: The wiphy whose device to bind
2034 * @dev: The device to parent it to
2036 static inline void set_wiphy_dev(struct wiphy
*wiphy
, struct device
*dev
)
2038 wiphy
->dev
.parent
= dev
;
2042 * wiphy_dev - get wiphy dev pointer
2044 * @wiphy: The wiphy whose device struct to look up
2046 static inline struct device
*wiphy_dev(struct wiphy
*wiphy
)
2048 return wiphy
->dev
.parent
;
2052 * wiphy_name - get wiphy name
2054 * @wiphy: The wiphy whose name to return
2056 static inline const char *wiphy_name(const struct wiphy
*wiphy
)
2058 return dev_name(&wiphy
->dev
);
2062 * wiphy_new - create a new wiphy for use with cfg80211
2064 * @ops: The configuration operations for this device
2065 * @sizeof_priv: The size of the private area to allocate
2067 * Create a new wiphy and associate the given operations with it.
2068 * @sizeof_priv bytes are allocated for private use.
2070 * The returned pointer must be assigned to each netdev's
2071 * ieee80211_ptr for proper operation.
2073 struct wiphy
*wiphy_new(const struct cfg80211_ops
*ops
, int sizeof_priv
);
2076 * wiphy_register - register a wiphy with cfg80211
2078 * @wiphy: The wiphy to register.
2080 * Returns a non-negative wiphy index or a negative error code.
2082 extern int wiphy_register(struct wiphy
*wiphy
);
2085 * wiphy_unregister - deregister a wiphy from cfg80211
2087 * @wiphy: The wiphy to unregister.
2089 * After this call, no more requests can be made with this priv
2090 * pointer, but the call may sleep to wait for an outstanding
2091 * request that is being handled.
2093 extern void wiphy_unregister(struct wiphy
*wiphy
);
2096 * wiphy_free - free wiphy
2098 * @wiphy: The wiphy to free
2100 extern void wiphy_free(struct wiphy
*wiphy
);
2102 /* internal structs */
2103 struct cfg80211_conn
;
2104 struct cfg80211_internal_bss
;
2105 struct cfg80211_cached_keys
;
2107 #define MAX_AUTH_BSSES 4
2110 * struct wireless_dev - wireless per-netdev state
2112 * This structure must be allocated by the driver/stack
2113 * that uses the ieee80211_ptr field in struct net_device
2114 * (this is intentional so it can be allocated along with
2117 * @wiphy: pointer to hardware description
2118 * @iftype: interface type
2119 * @list: (private) Used to collect the interfaces
2120 * @netdev: (private) Used to reference back to the netdev
2121 * @current_bss: (private) Used by the internal configuration code
2122 * @channel: (private) Used by the internal configuration code to track
2123 * user-set AP, monitor and WDS channels for wireless extensions
2124 * @bssid: (private) Used by the internal configuration code
2125 * @ssid: (private) Used by the internal configuration code
2126 * @ssid_len: (private) Used by the internal configuration code
2127 * @mesh_id_len: (private) Used by the internal configuration code
2128 * @mesh_id_up_len: (private) Used by the internal configuration code
2129 * @wext: (private) Used by the internal wireless extensions compat code
2130 * @use_4addr: indicates 4addr mode is used on this interface, must be
2131 * set by driver (if supported) on add_interface BEFORE registering the
2132 * netdev and may otherwise be used by driver read-only, will be update
2133 * by cfg80211 on change_interface
2134 * @mgmt_registrations: list of registrations for management frames
2135 * @mgmt_registrations_lock: lock for the list
2136 * @mtx: mutex used to lock data in this struct
2137 * @cleanup_work: work struct used for cleanup that can't be done directly
2138 * @beacon_interval: beacon interval used on this device for transmitting
2139 * beacons, 0 when not valid
2141 struct wireless_dev
{
2142 struct wiphy
*wiphy
;
2143 enum nl80211_iftype iftype
;
2145 /* the remainder of this struct should be private to cfg80211 */
2146 struct list_head list
;
2147 struct net_device
*netdev
;
2149 struct list_head mgmt_registrations
;
2150 spinlock_t mgmt_registrations_lock
;
2154 struct work_struct cleanup_work
;
2158 /* currently used for IBSS and SME - might be rearranged later */
2159 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
2160 u8 ssid_len
, mesh_id_len
, mesh_id_up_len
;
2163 CFG80211_SME_CONNECTING
,
2164 CFG80211_SME_CONNECTED
,
2166 struct cfg80211_conn
*conn
;
2167 struct cfg80211_cached_keys
*connect_keys
;
2169 struct list_head event_list
;
2170 spinlock_t event_lock
;
2172 struct cfg80211_internal_bss
*authtry_bsses
[MAX_AUTH_BSSES
];
2173 struct cfg80211_internal_bss
*auth_bsses
[MAX_AUTH_BSSES
];
2174 struct cfg80211_internal_bss
*current_bss
; /* associated / joined */
2175 struct ieee80211_channel
*channel
;
2180 int beacon_interval
;
2182 #ifdef CONFIG_CFG80211_WEXT
2185 struct cfg80211_ibss_params ibss
;
2186 struct cfg80211_connect_params connect
;
2187 struct cfg80211_cached_keys
*keys
;
2190 u8 bssid
[ETH_ALEN
], prev_bssid
[ETH_ALEN
];
2191 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
2192 s8 default_key
, default_mgmt_key
;
2193 bool prev_bssid_valid
;
2199 * wdev_priv - return wiphy priv from wireless_dev
2201 * @wdev: The wireless device whose wiphy's priv pointer to return
2203 static inline void *wdev_priv(struct wireless_dev
*wdev
)
2206 return wiphy_priv(wdev
->wiphy
);
2210 * DOC: Utility functions
2212 * cfg80211 offers a number of utility functions that can be useful.
2216 * ieee80211_channel_to_frequency - convert channel number to frequency
2217 * @chan: channel number
2218 * @band: band, necessary due to channel number overlap
2220 extern int ieee80211_channel_to_frequency(int chan
, enum ieee80211_band band
);
2223 * ieee80211_frequency_to_channel - convert frequency to channel number
2224 * @freq: center frequency
2226 extern int ieee80211_frequency_to_channel(int freq
);
2229 * Name indirection necessary because the ieee80211 code also has
2230 * a function named "ieee80211_get_channel", so if you include
2231 * cfg80211's header file you get cfg80211's version, if you try
2232 * to include both header files you'll (rightfully!) get a symbol
2235 extern struct ieee80211_channel
*__ieee80211_get_channel(struct wiphy
*wiphy
,
2238 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2239 * @wiphy: the struct wiphy to get the channel for
2240 * @freq: the center frequency of the channel
2242 static inline struct ieee80211_channel
*
2243 ieee80211_get_channel(struct wiphy
*wiphy
, int freq
)
2245 return __ieee80211_get_channel(wiphy
, freq
);
2249 * ieee80211_get_response_rate - get basic rate for a given rate
2251 * @sband: the band to look for rates in
2252 * @basic_rates: bitmap of basic rates
2253 * @bitrate: the bitrate for which to find the basic rate
2255 * This function returns the basic rate corresponding to a given
2256 * bitrate, that is the next lower bitrate contained in the basic
2257 * rate map, which is, for this function, given as a bitmap of
2258 * indices of rates in the band's bitrate table.
2260 struct ieee80211_rate
*
2261 ieee80211_get_response_rate(struct ieee80211_supported_band
*sband
,
2262 u32 basic_rates
, int bitrate
);
2265 * Radiotap parsing functions -- for controlled injection support
2267 * Implemented in net/wireless/radiotap.c
2268 * Documentation in Documentation/networking/radiotap-headers.txt
2271 struct radiotap_align_size
{
2272 uint8_t align
:4, size
:4;
2275 struct ieee80211_radiotap_namespace
{
2276 const struct radiotap_align_size
*align_size
;
2282 struct ieee80211_radiotap_vendor_namespaces
{
2283 const struct ieee80211_radiotap_namespace
*ns
;
2288 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2289 * @this_arg_index: index of current arg, valid after each successful call
2290 * to ieee80211_radiotap_iterator_next()
2291 * @this_arg: pointer to current radiotap arg; it is valid after each
2292 * call to ieee80211_radiotap_iterator_next() but also after
2293 * ieee80211_radiotap_iterator_init() where it will point to
2294 * the beginning of the actual data portion
2295 * @this_arg_size: length of the current arg, for convenience
2296 * @current_namespace: pointer to the current namespace definition
2297 * (or internally %NULL if the current namespace is unknown)
2298 * @is_radiotap_ns: indicates whether the current namespace is the default
2299 * radiotap namespace or not
2301 * @_rtheader: pointer to the radiotap header we are walking through
2302 * @_max_length: length of radiotap header in cpu byte ordering
2303 * @_arg_index: next argument index
2304 * @_arg: next argument pointer
2305 * @_next_bitmap: internal pointer to next present u32
2306 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2307 * @_vns: vendor namespace definitions
2308 * @_next_ns_data: beginning of the next namespace's data
2309 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2312 * Describes the radiotap parser state. Fields prefixed with an underscore
2313 * must not be used by users of the parser, only by the parser internally.
2316 struct ieee80211_radiotap_iterator
{
2317 struct ieee80211_radiotap_header
*_rtheader
;
2318 const struct ieee80211_radiotap_vendor_namespaces
*_vns
;
2319 const struct ieee80211_radiotap_namespace
*current_namespace
;
2321 unsigned char *_arg
, *_next_ns_data
;
2322 __le32
*_next_bitmap
;
2324 unsigned char *this_arg
;
2332 uint32_t _bitmap_shifter
;
2336 extern int ieee80211_radiotap_iterator_init(
2337 struct ieee80211_radiotap_iterator
*iterator
,
2338 struct ieee80211_radiotap_header
*radiotap_header
,
2339 int max_length
, const struct ieee80211_radiotap_vendor_namespaces
*vns
);
2341 extern int ieee80211_radiotap_iterator_next(
2342 struct ieee80211_radiotap_iterator
*iterator
);
2345 extern const unsigned char rfc1042_header
[6];
2346 extern const unsigned char bridge_tunnel_header
[6];
2348 /* Parsed Information Elements */
2349 struct ieee802_11_elems
{
2353 /* pointers to IEs */
2359 struct ieee80211_tim_ie
*tim
;
2368 struct ieee80211_ht_cap
*ht_cap_elem
;
2369 struct ieee80211_ht_info
*ht_info_elem
;
2370 struct ieee80211_meshconf_ie
*mesh_config
;
2376 struct ieee80211_rann_ie
*rann
;
2379 u8
*pwr_constr_elem
;
2380 u8
*quiet_elem
; /* first quite element */
2383 /* length of them, respectively */
2395 u8 ext_supp_rates_len
;
2403 u8 ch_switch_elem_len
;
2404 u8 country_elem_len
;
2405 u8 pwr_constr_elem_len
;
2407 u8 num_of_quiet_elem
; /* can be more the one */
2412 * ieee80211_get_hdrlen_from_skb - get header length from data
2414 * Given an skb with a raw 802.11 header at the data pointer this function
2415 * returns the 802.11 header length in bytes (not including encryption
2416 * headers). If the data in the sk_buff is too short to contain a valid 802.11
2417 * header the function returns 0.
2421 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff
*skb
);
2424 * ieee80211_hdrlen - get header length in bytes from frame control
2425 * @fc: frame control field in little-endian format
2427 unsigned int __attribute_const__
ieee80211_hdrlen(__le16 fc
);
2430 * DOC: Data path helpers
2432 * In addition to generic utilities, cfg80211 also offers
2433 * functions that help implement the data path for devices
2434 * that do not do the 802.11/802.3 conversion on the device.
2438 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2439 * @skb: the 802.11 data frame
2440 * @addr: the device MAC address
2441 * @iftype: the virtual interface type
2443 int ieee80211_data_to_8023(struct sk_buff
*skb
, const u8
*addr
,
2444 enum nl80211_iftype iftype
);
2447 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2448 * @skb: the 802.3 frame
2449 * @addr: the device MAC address
2450 * @iftype: the virtual interface type
2451 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2452 * @qos: build 802.11 QoS data frame
2454 int ieee80211_data_from_8023(struct sk_buff
*skb
, const u8
*addr
,
2455 enum nl80211_iftype iftype
, u8
*bssid
, bool qos
);
2458 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2460 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2461 * 802.3 frames. The @list will be empty if the decode fails. The
2462 * @skb is consumed after the function returns.
2464 * @skb: The input IEEE 802.11n A-MSDU frame.
2465 * @list: The output list of 802.3 frames. It must be allocated and
2466 * initialized by by the caller.
2467 * @addr: The device MAC address.
2468 * @iftype: The device interface type.
2469 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2470 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2472 void ieee80211_amsdu_to_8023s(struct sk_buff
*skb
, struct sk_buff_head
*list
,
2473 const u8
*addr
, enum nl80211_iftype iftype
,
2474 const unsigned int extra_headroom
,
2475 bool has_80211_header
);
2478 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2479 * @skb: the data frame
2481 unsigned int cfg80211_classify8021d(struct sk_buff
*skb
);
2484 * cfg80211_find_ie - find information element in data
2487 * @ies: data consisting of IEs
2488 * @len: length of data
2490 * This function will return %NULL if the element ID could
2491 * not be found or if the element is invalid (claims to be
2492 * longer than the given data), or a pointer to the first byte
2493 * of the requested element, that is the byte containing the
2494 * element ID. There are no checks on the element length
2495 * other than having to fit into the given data.
2497 const u8
*cfg80211_find_ie(u8 eid
, const u8
*ies
, int len
);
2500 * cfg80211_find_vendor_ie - find vendor specific information element in data
2503 * @oui_type: vendor-specific OUI type
2504 * @ies: data consisting of IEs
2505 * @len: length of data
2507 * This function will return %NULL if the vendor specific element ID
2508 * could not be found or if the element is invalid (claims to be
2509 * longer than the given data), or a pointer to the first byte
2510 * of the requested element, that is the byte containing the
2511 * element ID. There are no checks on the element length
2512 * other than having to fit into the given data.
2514 const u8
*cfg80211_find_vendor_ie(unsigned int oui
, u8 oui_type
,
2515 const u8
*ies
, int len
);
2518 * DOC: Regulatory enforcement infrastructure
2524 * regulatory_hint - driver hint to the wireless core a regulatory domain
2525 * @wiphy: the wireless device giving the hint (used only for reporting
2527 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2528 * should be in. If @rd is set this should be NULL. Note that if you
2529 * set this to NULL you should still set rd->alpha2 to some accepted
2532 * Wireless drivers can use this function to hint to the wireless core
2533 * what it believes should be the current regulatory domain by
2534 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2535 * domain should be in or by providing a completely build regulatory domain.
2536 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2537 * for a regulatory domain structure for the respective country.
2539 * The wiphy must have been registered to cfg80211 prior to this call.
2540 * For cfg80211 drivers this means you must first use wiphy_register(),
2541 * for mac80211 drivers you must first use ieee80211_register_hw().
2543 * Drivers should check the return value, its possible you can get
2546 extern int regulatory_hint(struct wiphy
*wiphy
, const char *alpha2
);
2549 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2550 * @wiphy: the wireless device we want to process the regulatory domain on
2551 * @regd: the custom regulatory domain to use for this wiphy
2553 * Drivers can sometimes have custom regulatory domains which do not apply
2554 * to a specific country. Drivers can use this to apply such custom regulatory
2555 * domains. This routine must be called prior to wiphy registration. The
2556 * custom regulatory domain will be trusted completely and as such previous
2557 * default channel settings will be disregarded. If no rule is found for a
2558 * channel on the regulatory domain the channel will be disabled.
2560 extern void wiphy_apply_custom_regulatory(
2561 struct wiphy
*wiphy
,
2562 const struct ieee80211_regdomain
*regd
);
2565 * freq_reg_info - get regulatory information for the given frequency
2566 * @wiphy: the wiphy for which we want to process this rule for
2567 * @center_freq: Frequency in KHz for which we want regulatory information for
2568 * @desired_bw_khz: the desired max bandwidth you want to use per
2569 * channel. Note that this is still 20 MHz if you want to use HT40
2570 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2571 * If set to 0 we'll assume you want the standard 20 MHz.
2572 * @reg_rule: the regulatory rule which we have for this frequency
2574 * Use this function to get the regulatory rule for a specific frequency on
2575 * a given wireless device. If the device has a specific regulatory domain
2576 * it wants to follow we respect that unless a country IE has been received
2577 * and processed already.
2579 * Returns 0 if it was able to find a valid regulatory rule which does
2580 * apply to the given center_freq otherwise it returns non-zero. It will
2581 * also return -ERANGE if we determine the given center_freq does not even have
2582 * a regulatory rule for a frequency range in the center_freq's band. See
2583 * freq_in_rule_band() for our current definition of a band -- this is purely
2584 * subjective and right now its 802.11 specific.
2586 extern int freq_reg_info(struct wiphy
*wiphy
,
2589 const struct ieee80211_reg_rule
**reg_rule
);
2592 * callbacks for asynchronous cfg80211 methods, notification
2593 * functions and BSS handling helpers
2597 * cfg80211_scan_done - notify that scan finished
2599 * @request: the corresponding scan request
2600 * @aborted: set to true if the scan was aborted for any reason,
2601 * userspace will be notified of that
2603 void cfg80211_scan_done(struct cfg80211_scan_request
*request
, bool aborted
);
2606 * cfg80211_sched_scan_results - notify that new scan results are available
2608 * @wiphy: the wiphy which got scheduled scan results
2610 void cfg80211_sched_scan_results(struct wiphy
*wiphy
);
2613 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
2615 * @wiphy: the wiphy on which the scheduled scan stopped
2617 * The driver can call this function to inform cfg80211 that the
2618 * scheduled scan had to be stopped, for whatever reason. The driver
2619 * is then called back via the sched_scan_stop operation when done.
2621 void cfg80211_sched_scan_stopped(struct wiphy
*wiphy
);
2624 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2626 * @wiphy: the wiphy reporting the BSS
2627 * @channel: The channel the frame was received on
2628 * @mgmt: the management frame (probe response or beacon)
2629 * @len: length of the management frame
2630 * @signal: the signal strength, type depends on the wiphy's signal_type
2631 * @gfp: context flags
2633 * This informs cfg80211 that BSS information was found and
2634 * the BSS should be updated/added.
2636 struct cfg80211_bss
*
2637 cfg80211_inform_bss_frame(struct wiphy
*wiphy
,
2638 struct ieee80211_channel
*channel
,
2639 struct ieee80211_mgmt
*mgmt
, size_t len
,
2640 s32 signal
, gfp_t gfp
);
2643 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2645 * @wiphy: the wiphy reporting the BSS
2646 * @channel: The channel the frame was received on
2647 * @bssid: the BSSID of the BSS
2648 * @timestamp: the TSF timestamp sent by the peer
2649 * @capability: the capability field sent by the peer
2650 * @beacon_interval: the beacon interval announced by the peer
2651 * @ie: additional IEs sent by the peer
2652 * @ielen: length of the additional IEs
2653 * @signal: the signal strength, type depends on the wiphy's signal_type
2654 * @gfp: context flags
2656 * This informs cfg80211 that BSS information was found and
2657 * the BSS should be updated/added.
2659 struct cfg80211_bss
*
2660 cfg80211_inform_bss(struct wiphy
*wiphy
,
2661 struct ieee80211_channel
*channel
,
2663 u64 timestamp
, u16 capability
, u16 beacon_interval
,
2664 const u8
*ie
, size_t ielen
,
2665 s32 signal
, gfp_t gfp
);
2667 struct cfg80211_bss
*cfg80211_get_bss(struct wiphy
*wiphy
,
2668 struct ieee80211_channel
*channel
,
2670 const u8
*ssid
, size_t ssid_len
,
2671 u16 capa_mask
, u16 capa_val
);
2672 static inline struct cfg80211_bss
*
2673 cfg80211_get_ibss(struct wiphy
*wiphy
,
2674 struct ieee80211_channel
*channel
,
2675 const u8
*ssid
, size_t ssid_len
)
2677 return cfg80211_get_bss(wiphy
, channel
, NULL
, ssid
, ssid_len
,
2678 WLAN_CAPABILITY_IBSS
, WLAN_CAPABILITY_IBSS
);
2681 struct cfg80211_bss
*cfg80211_get_mesh(struct wiphy
*wiphy
,
2682 struct ieee80211_channel
*channel
,
2683 const u8
*meshid
, size_t meshidlen
,
2685 void cfg80211_put_bss(struct cfg80211_bss
*bss
);
2688 * cfg80211_unlink_bss - unlink BSS from internal data structures
2690 * @bss: the bss to remove
2692 * This function removes the given BSS from the internal data structures
2693 * thereby making it no longer show up in scan results etc. Use this
2694 * function when you detect a BSS is gone. Normally BSSes will also time
2695 * out, so it is not necessary to use this function at all.
2697 void cfg80211_unlink_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
2700 * cfg80211_send_rx_auth - notification of processed authentication
2701 * @dev: network device
2702 * @buf: authentication frame (header + body)
2703 * @len: length of the frame data
2705 * This function is called whenever an authentication has been processed in
2706 * station mode. The driver is required to call either this function or
2707 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2708 * call. This function may sleep.
2710 void cfg80211_send_rx_auth(struct net_device
*dev
, const u8
*buf
, size_t len
);
2713 * cfg80211_send_auth_timeout - notification of timed out authentication
2714 * @dev: network device
2715 * @addr: The MAC address of the device with which the authentication timed out
2717 * This function may sleep.
2719 void cfg80211_send_auth_timeout(struct net_device
*dev
, const u8
*addr
);
2722 * __cfg80211_auth_canceled - notify cfg80211 that authentication was canceled
2723 * @dev: network device
2724 * @addr: The MAC address of the device with which the authentication timed out
2726 * When a pending authentication had no action yet, the driver may decide
2727 * to not send a deauth frame, but in that case must calls this function
2728 * to tell cfg80211 about this decision. It is only valid to call this
2729 * function within the deauth() callback.
2731 void __cfg80211_auth_canceled(struct net_device
*dev
, const u8
*addr
);
2734 * cfg80211_send_rx_assoc - notification of processed association
2735 * @dev: network device
2736 * @buf: (re)association response frame (header + body)
2737 * @len: length of the frame data
2739 * This function is called whenever a (re)association response has been
2740 * processed in station mode. The driver is required to call either this
2741 * function or cfg80211_send_assoc_timeout() to indicate the result of
2742 * cfg80211_ops::assoc() call. This function may sleep.
2744 void cfg80211_send_rx_assoc(struct net_device
*dev
, const u8
*buf
, size_t len
);
2747 * cfg80211_send_assoc_timeout - notification of timed out association
2748 * @dev: network device
2749 * @addr: The MAC address of the device with which the association timed out
2751 * This function may sleep.
2753 void cfg80211_send_assoc_timeout(struct net_device
*dev
, const u8
*addr
);
2756 * cfg80211_send_deauth - notification of processed deauthentication
2757 * @dev: network device
2758 * @buf: deauthentication frame (header + body)
2759 * @len: length of the frame data
2761 * This function is called whenever deauthentication has been processed in
2762 * station mode. This includes both received deauthentication frames and
2763 * locally generated ones. This function may sleep.
2765 void cfg80211_send_deauth(struct net_device
*dev
, const u8
*buf
, size_t len
);
2768 * __cfg80211_send_deauth - notification of processed deauthentication
2769 * @dev: network device
2770 * @buf: deauthentication frame (header + body)
2771 * @len: length of the frame data
2773 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2775 void __cfg80211_send_deauth(struct net_device
*dev
, const u8
*buf
, size_t len
);
2778 * cfg80211_send_disassoc - notification of processed disassociation
2779 * @dev: network device
2780 * @buf: disassociation response frame (header + body)
2781 * @len: length of the frame data
2783 * This function is called whenever disassociation has been processed in
2784 * station mode. This includes both received disassociation frames and locally
2785 * generated ones. This function may sleep.
2787 void cfg80211_send_disassoc(struct net_device
*dev
, const u8
*buf
, size_t len
);
2790 * __cfg80211_send_disassoc - notification of processed disassociation
2791 * @dev: network device
2792 * @buf: disassociation response frame (header + body)
2793 * @len: length of the frame data
2795 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2797 void __cfg80211_send_disassoc(struct net_device
*dev
, const u8
*buf
,
2801 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
2802 * @dev: network device
2803 * @buf: deauthentication frame (header + body)
2804 * @len: length of the frame data
2806 * This function is called whenever a received Deauthentication frame has been
2807 * dropped in station mode because of MFP being used but the Deauthentication
2808 * frame was not protected. This function may sleep.
2810 void cfg80211_send_unprot_deauth(struct net_device
*dev
, const u8
*buf
,
2814 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
2815 * @dev: network device
2816 * @buf: disassociation frame (header + body)
2817 * @len: length of the frame data
2819 * This function is called whenever a received Disassociation frame has been
2820 * dropped in station mode because of MFP being used but the Disassociation
2821 * frame was not protected. This function may sleep.
2823 void cfg80211_send_unprot_disassoc(struct net_device
*dev
, const u8
*buf
,
2827 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
2828 * @dev: network device
2829 * @addr: The source MAC address of the frame
2830 * @key_type: The key type that the received frame used
2831 * @key_id: Key identifier (0..3). Can be -1 if missing.
2832 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
2833 * @gfp: allocation flags
2835 * This function is called whenever the local MAC detects a MIC failure in a
2836 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
2839 void cfg80211_michael_mic_failure(struct net_device
*dev
, const u8
*addr
,
2840 enum nl80211_key_type key_type
, int key_id
,
2841 const u8
*tsc
, gfp_t gfp
);
2844 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
2846 * @dev: network device
2847 * @bssid: the BSSID of the IBSS joined
2848 * @gfp: allocation flags
2850 * This function notifies cfg80211 that the device joined an IBSS or
2851 * switched to a different BSSID. Before this function can be called,
2852 * either a beacon has to have been received from the IBSS, or one of
2853 * the cfg80211_inform_bss{,_frame} functions must have been called
2854 * with the locally generated beacon -- this guarantees that there is
2855 * always a scan result for this IBSS. cfg80211 will handle the rest.
2857 void cfg80211_ibss_joined(struct net_device
*dev
, const u8
*bssid
, gfp_t gfp
);
2860 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
2862 * @dev: network device
2863 * @macaddr: the MAC address of the new candidate
2864 * @ie: information elements advertised by the peer candidate
2865 * @ie_len: lenght of the information elements buffer
2866 * @gfp: allocation flags
2868 * This function notifies cfg80211 that the mesh peer candidate has been
2869 * detected, most likely via a beacon or, less likely, via a probe response.
2870 * cfg80211 then sends a notification to userspace.
2872 void cfg80211_notify_new_peer_candidate(struct net_device
*dev
,
2873 const u8
*macaddr
, const u8
*ie
, u8 ie_len
, gfp_t gfp
);
2876 * DOC: RFkill integration
2878 * RFkill integration in cfg80211 is almost invisible to drivers,
2879 * as cfg80211 automatically registers an rfkill instance for each
2880 * wireless device it knows about. Soft kill is also translated
2881 * into disconnecting and turning all interfaces off, drivers are
2882 * expected to turn off the device when all interfaces are down.
2884 * However, devices may have a hard RFkill line, in which case they
2885 * also need to interact with the rfkill subsystem, via cfg80211.
2886 * They can do this with a few helper functions documented here.
2890 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
2892 * @blocked: block status
2894 void wiphy_rfkill_set_hw_state(struct wiphy
*wiphy
, bool blocked
);
2897 * wiphy_rfkill_start_polling - start polling rfkill
2900 void wiphy_rfkill_start_polling(struct wiphy
*wiphy
);
2903 * wiphy_rfkill_stop_polling - stop polling rfkill
2906 void wiphy_rfkill_stop_polling(struct wiphy
*wiphy
);
2908 #ifdef CONFIG_NL80211_TESTMODE
2912 * Test mode is a set of utility functions to allow drivers to
2913 * interact with driver-specific tools to aid, for instance,
2914 * factory programming.
2916 * This chapter describes how drivers interact with it, for more
2917 * information see the nl80211 book's chapter on it.
2921 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
2923 * @approxlen: an upper bound of the length of the data that will
2924 * be put into the skb
2926 * This function allocates and pre-fills an skb for a reply to
2927 * the testmode command. Since it is intended for a reply, calling
2928 * it outside of the @testmode_cmd operation is invalid.
2930 * The returned skb (or %NULL if any errors happen) is pre-filled
2931 * with the wiphy index and set up in a way that any data that is
2932 * put into the skb (with skb_put(), nla_put() or similar) will end
2933 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
2934 * needs to be done with the skb is adding data for the corresponding
2935 * userspace tool which can then read that data out of the testdata
2936 * attribute. You must not modify the skb in any other way.
2938 * When done, call cfg80211_testmode_reply() with the skb and return
2939 * its error code as the result of the @testmode_cmd operation.
2941 struct sk_buff
*cfg80211_testmode_alloc_reply_skb(struct wiphy
*wiphy
,
2945 * cfg80211_testmode_reply - send the reply skb
2946 * @skb: The skb, must have been allocated with
2947 * cfg80211_testmode_alloc_reply_skb()
2949 * Returns an error code or 0 on success, since calling this
2950 * function will usually be the last thing before returning
2951 * from the @testmode_cmd you should return the error code.
2952 * Note that this function consumes the skb regardless of the
2955 int cfg80211_testmode_reply(struct sk_buff
*skb
);
2958 * cfg80211_testmode_alloc_event_skb - allocate testmode event
2960 * @approxlen: an upper bound of the length of the data that will
2961 * be put into the skb
2962 * @gfp: allocation flags
2964 * This function allocates and pre-fills an skb for an event on the
2965 * testmode multicast group.
2967 * The returned skb (or %NULL if any errors happen) is set up in the
2968 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
2969 * for an event. As there, you should simply add data to it that will
2970 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
2971 * not modify the skb in any other way.
2973 * When done filling the skb, call cfg80211_testmode_event() with the
2974 * skb to send the event.
2976 struct sk_buff
*cfg80211_testmode_alloc_event_skb(struct wiphy
*wiphy
,
2977 int approxlen
, gfp_t gfp
);
2980 * cfg80211_testmode_event - send the event
2981 * @skb: The skb, must have been allocated with
2982 * cfg80211_testmode_alloc_event_skb()
2983 * @gfp: allocation flags
2985 * This function sends the given @skb, which must have been allocated
2986 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
2989 void cfg80211_testmode_event(struct sk_buff
*skb
, gfp_t gfp
);
2991 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
2992 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
2994 #define CFG80211_TESTMODE_CMD(cmd)
2995 #define CFG80211_TESTMODE_DUMP(cmd)
2999 * cfg80211_connect_result - notify cfg80211 of connection result
3001 * @dev: network device
3002 * @bssid: the BSSID of the AP
3003 * @req_ie: association request IEs (maybe be %NULL)
3004 * @req_ie_len: association request IEs length
3005 * @resp_ie: association response IEs (may be %NULL)
3006 * @resp_ie_len: assoc response IEs length
3007 * @status: status code, 0 for successful connection, use
3008 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3009 * the real status code for failures.
3010 * @gfp: allocation flags
3012 * It should be called by the underlying driver whenever connect() has
3015 void cfg80211_connect_result(struct net_device
*dev
, const u8
*bssid
,
3016 const u8
*req_ie
, size_t req_ie_len
,
3017 const u8
*resp_ie
, size_t resp_ie_len
,
3018 u16 status
, gfp_t gfp
);
3021 * cfg80211_roamed - notify cfg80211 of roaming
3023 * @dev: network device
3024 * @channel: the channel of the new AP
3025 * @bssid: the BSSID of the new AP
3026 * @req_ie: association request IEs (maybe be %NULL)
3027 * @req_ie_len: association request IEs length
3028 * @resp_ie: association response IEs (may be %NULL)
3029 * @resp_ie_len: assoc response IEs length
3030 * @gfp: allocation flags
3032 * It should be called by the underlying driver whenever it roamed
3033 * from one AP to another while connected.
3035 void cfg80211_roamed(struct net_device
*dev
,
3036 struct ieee80211_channel
*channel
,
3038 const u8
*req_ie
, size_t req_ie_len
,
3039 const u8
*resp_ie
, size_t resp_ie_len
, gfp_t gfp
);
3042 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3044 * @dev: network device
3045 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3046 * @ie_len: length of IEs
3047 * @reason: reason code for the disconnection, set it to 0 if unknown
3048 * @gfp: allocation flags
3050 * After it calls this function, the driver should enter an idle state
3051 * and not try to connect to any AP any more.
3053 void cfg80211_disconnected(struct net_device
*dev
, u16 reason
,
3054 u8
*ie
, size_t ie_len
, gfp_t gfp
);
3057 * cfg80211_ready_on_channel - notification of remain_on_channel start
3058 * @dev: network device
3059 * @cookie: the request cookie
3060 * @chan: The current channel (from remain_on_channel request)
3061 * @channel_type: Channel type
3062 * @duration: Duration in milliseconds that the driver intents to remain on the
3064 * @gfp: allocation flags
3066 void cfg80211_ready_on_channel(struct net_device
*dev
, u64 cookie
,
3067 struct ieee80211_channel
*chan
,
3068 enum nl80211_channel_type channel_type
,
3069 unsigned int duration
, gfp_t gfp
);
3072 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3073 * @dev: network device
3074 * @cookie: the request cookie
3075 * @chan: The current channel (from remain_on_channel request)
3076 * @channel_type: Channel type
3077 * @gfp: allocation flags
3079 void cfg80211_remain_on_channel_expired(struct net_device
*dev
,
3081 struct ieee80211_channel
*chan
,
3082 enum nl80211_channel_type channel_type
,
3087 * cfg80211_new_sta - notify userspace about station
3090 * @mac_addr: the station's address
3091 * @sinfo: the station information
3092 * @gfp: allocation flags
3094 void cfg80211_new_sta(struct net_device
*dev
, const u8
*mac_addr
,
3095 struct station_info
*sinfo
, gfp_t gfp
);
3098 * cfg80211_del_sta - notify userspace about deletion of a station
3101 * @mac_addr: the station's address
3102 * @gfp: allocation flags
3104 void cfg80211_del_sta(struct net_device
*dev
, const u8
*mac_addr
, gfp_t gfp
);
3107 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3108 * @dev: network device
3109 * @freq: Frequency on which the frame was received in MHz
3110 * @buf: Management frame (header + body)
3111 * @len: length of the frame data
3112 * @gfp: context flags
3114 * Returns %true if a user space application has registered for this frame.
3115 * For action frames, that makes it responsible for rejecting unrecognized
3116 * action frames; %false otherwise, in which case for action frames the
3117 * driver is responsible for rejecting the frame.
3119 * This function is called whenever an Action frame is received for a station
3120 * mode interface, but is not processed in kernel.
3122 bool cfg80211_rx_mgmt(struct net_device
*dev
, int freq
, const u8
*buf
,
3123 size_t len
, gfp_t gfp
);
3126 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3127 * @dev: network device
3128 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3129 * @buf: Management frame (header + body)
3130 * @len: length of the frame data
3131 * @ack: Whether frame was acknowledged
3132 * @gfp: context flags
3134 * This function is called whenever a management frame was requested to be
3135 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3136 * transmission attempt.
3138 void cfg80211_mgmt_tx_status(struct net_device
*dev
, u64 cookie
,
3139 const u8
*buf
, size_t len
, bool ack
, gfp_t gfp
);
3143 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3144 * @dev: network device
3145 * @rssi_event: the triggered RSSI event
3146 * @gfp: context flags
3148 * This function is called when a configured connection quality monitoring
3149 * rssi threshold reached event occurs.
3151 void cfg80211_cqm_rssi_notify(struct net_device
*dev
,
3152 enum nl80211_cqm_rssi_threshold_event rssi_event
,
3156 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3157 * @dev: network device
3158 * @peer: peer's MAC address
3159 * @num_packets: how many packets were lost -- should be a fixed threshold
3160 * but probably no less than maybe 50, or maybe a throughput dependent
3161 * threshold (to account for temporary interference)
3162 * @gfp: context flags
3164 void cfg80211_cqm_pktloss_notify(struct net_device
*dev
,
3165 const u8
*peer
, u32 num_packets
, gfp_t gfp
);
3168 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3169 * @dev: network device
3170 * @bssid: BSSID of AP (to avoid races)
3171 * @replay_ctr: new replay counter
3172 * @gfp: allocation flags
3174 void cfg80211_gtk_rekey_notify(struct net_device
*dev
, const u8
*bssid
,
3175 const u8
*replay_ctr
, gfp_t gfp
);
3178 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3179 * @dev: network device
3180 * @index: candidate index (the smaller the index, the higher the priority)
3181 * @bssid: BSSID of AP
3182 * @preauth: Whether AP advertises support for RSN pre-authentication
3183 * @gfp: allocation flags
3185 void cfg80211_pmksa_candidate_notify(struct net_device
*dev
, int index
,
3186 const u8
*bssid
, bool preauth
, gfp_t gfp
);
3188 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3190 /* wiphy_printk helpers, similar to dev_printk */
3192 #define wiphy_printk(level, wiphy, format, args...) \
3193 dev_printk(level, &(wiphy)->dev, format, ##args)
3194 #define wiphy_emerg(wiphy, format, args...) \
3195 dev_emerg(&(wiphy)->dev, format, ##args)
3196 #define wiphy_alert(wiphy, format, args...) \
3197 dev_alert(&(wiphy)->dev, format, ##args)
3198 #define wiphy_crit(wiphy, format, args...) \
3199 dev_crit(&(wiphy)->dev, format, ##args)
3200 #define wiphy_err(wiphy, format, args...) \
3201 dev_err(&(wiphy)->dev, format, ##args)
3202 #define wiphy_warn(wiphy, format, args...) \
3203 dev_warn(&(wiphy)->dev, format, ##args)
3204 #define wiphy_notice(wiphy, format, args...) \
3205 dev_notice(&(wiphy)->dev, format, ##args)
3206 #define wiphy_info(wiphy, format, args...) \
3207 dev_info(&(wiphy)->dev, format, ##args)
3209 #define wiphy_debug(wiphy, format, args...) \
3210 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3212 #define wiphy_dbg(wiphy, format, args...) \
3213 dev_dbg(&(wiphy)->dev, format, ##args)
3215 #if defined(VERBOSE_DEBUG)
3216 #define wiphy_vdbg wiphy_dbg
3218 #define wiphy_vdbg(wiphy, format, args...) \
3221 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3227 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3228 * of using a WARN/WARN_ON to get the message out, including the
3229 * file/line information and a backtrace.
3231 #define wiphy_WARN(wiphy, format, args...) \
3232 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3234 #endif /* __NET_CFG80211_H */