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/bug.h>
17 #include <linux/netlink.h>
18 #include <linux/skbuff.h>
19 #include <linux/nl80211.h>
20 #include <linux/if_ether.h>
21 #include <linux/ieee80211.h>
22 #include <net/regulatory.h>
27 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
28 * userspace and drivers, and offers some utility functionality associated
29 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
30 * by all modern wireless drivers in Linux, so that they offer a consistent
31 * API through nl80211. For backward compatibility, cfg80211 also offers
32 * wireless extensions to userspace, but hides them from drivers completely.
34 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
40 * DOC: Device registration
42 * In order for a driver to use cfg80211, it must register the hardware device
43 * with cfg80211. This happens through a number of hardware capability structs
46 * The fundamental structure for each device is the 'wiphy', of which each
47 * instance describes a physical wireless device connected to the system. Each
48 * such wiphy can have zero, one, or many virtual interfaces associated with
49 * it, which need to be identified as such by pointing the network interface's
50 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
51 * the wireless part of the interface, normally this struct is embedded in the
52 * network interface's private data area. Drivers can optionally allow creating
53 * or destroying virtual interfaces on the fly, but without at least one or the
54 * ability to create some the wireless device isn't useful.
56 * Each wiphy structure contains device capability information, and also has
57 * a pointer to the various operations the driver offers. The definitions and
58 * structures here describe these capabilities in detail.
62 * wireless hardware capability structures
66 * enum ieee80211_band - supported frequency bands
68 * The bands are assigned this way because the supported
69 * bitrates differ in these bands.
71 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
72 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
73 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
74 * @IEEE80211_NUM_BANDS: number of defined bands
77 IEEE80211_BAND_2GHZ
= NL80211_BAND_2GHZ
,
78 IEEE80211_BAND_5GHZ
= NL80211_BAND_5GHZ
,
79 IEEE80211_BAND_60GHZ
= NL80211_BAND_60GHZ
,
86 * enum ieee80211_channel_flags - channel flags
88 * Channel flags set by the regulatory control code.
90 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
91 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
93 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
94 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
95 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
97 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
99 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
101 enum ieee80211_channel_flags
{
102 IEEE80211_CHAN_DISABLED
= 1<<0,
103 IEEE80211_CHAN_PASSIVE_SCAN
= 1<<1,
104 IEEE80211_CHAN_NO_IBSS
= 1<<2,
105 IEEE80211_CHAN_RADAR
= 1<<3,
106 IEEE80211_CHAN_NO_HT40PLUS
= 1<<4,
107 IEEE80211_CHAN_NO_HT40MINUS
= 1<<5,
108 IEEE80211_CHAN_NO_OFDM
= 1<<6,
111 #define IEEE80211_CHAN_NO_HT40 \
112 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
115 * struct ieee80211_channel - channel definition
117 * This structure describes a single channel for use
120 * @center_freq: center frequency in MHz
121 * @hw_value: hardware-specific value for the channel
122 * @flags: channel flags from &enum ieee80211_channel_flags.
123 * @orig_flags: channel flags at registration time, used by regulatory
124 * code to support devices with additional restrictions
125 * @band: band this channel belongs to.
126 * @max_antenna_gain: maximum antenna gain in dBi
127 * @max_power: maximum transmission power (in dBm)
128 * @max_reg_power: maximum regulatory transmission power (in dBm)
129 * @beacon_found: helper to regulatory code to indicate when a beacon
130 * has been found on this channel. Use regulatory_hint_found_beacon()
131 * to enable this, this is useful only on 5 GHz band.
132 * @orig_mag: internal use
133 * @orig_mpwr: internal use
135 struct ieee80211_channel
{
136 enum ieee80211_band band
;
140 int max_antenna_gain
;
145 int orig_mag
, orig_mpwr
;
149 * enum ieee80211_rate_flags - rate flags
151 * Hardware/specification flags for rates. These are structured
152 * in a way that allows using the same bitrate structure for
153 * different bands/PHY modes.
155 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
156 * preamble on this bitrate; only relevant in 2.4GHz band and
158 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
159 * when used with 802.11a (on the 5 GHz band); filled by the
160 * core code when registering the wiphy.
161 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
162 * when used with 802.11b (on the 2.4 GHz band); filled by the
163 * core code when registering the wiphy.
164 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
165 * when used with 802.11g (on the 2.4 GHz band); filled by the
166 * core code when registering the wiphy.
167 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
169 enum ieee80211_rate_flags
{
170 IEEE80211_RATE_SHORT_PREAMBLE
= 1<<0,
171 IEEE80211_RATE_MANDATORY_A
= 1<<1,
172 IEEE80211_RATE_MANDATORY_B
= 1<<2,
173 IEEE80211_RATE_MANDATORY_G
= 1<<3,
174 IEEE80211_RATE_ERP_G
= 1<<4,
178 * struct ieee80211_rate - bitrate definition
180 * This structure describes a bitrate that an 802.11 PHY can
181 * operate with. The two values @hw_value and @hw_value_short
182 * are only for driver use when pointers to this structure are
185 * @flags: rate-specific flags
186 * @bitrate: bitrate in units of 100 Kbps
187 * @hw_value: driver/hardware value for this rate
188 * @hw_value_short: driver/hardware value for this rate when
189 * short preamble is used
191 struct ieee80211_rate
{
194 u16 hw_value
, hw_value_short
;
198 * struct ieee80211_sta_ht_cap - STA's HT capabilities
200 * This structure describes most essential parameters needed
201 * to describe 802.11n HT capabilities for an STA.
203 * @ht_supported: is HT supported by the STA
204 * @cap: HT capabilities map as described in 802.11n spec
205 * @ampdu_factor: Maximum A-MPDU length factor
206 * @ampdu_density: Minimum A-MPDU spacing
207 * @mcs: Supported MCS rates
209 struct ieee80211_sta_ht_cap
{
210 u16 cap
; /* use IEEE80211_HT_CAP_ */
214 struct ieee80211_mcs_info mcs
;
218 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
220 * This structure describes most essential parameters needed
221 * to describe 802.11ac VHT capabilities for an STA.
223 * @vht_supported: is VHT supported by the STA
224 * @cap: VHT capabilities map as described in 802.11ac spec
225 * @vht_mcs: Supported VHT MCS rates
227 struct ieee80211_sta_vht_cap
{
229 u32 cap
; /* use IEEE80211_VHT_CAP_ */
230 struct ieee80211_vht_mcs_info vht_mcs
;
234 * struct ieee80211_supported_band - frequency band definition
236 * This structure describes a frequency band a wiphy
237 * is able to operate in.
239 * @channels: Array of channels the hardware can operate in
241 * @band: the band this structure represents
242 * @n_channels: Number of channels in @channels
243 * @bitrates: Array of bitrates the hardware can operate with
244 * in this band. Must be sorted to give a valid "supported
245 * rates" IE, i.e. CCK rates first, then OFDM.
246 * @n_bitrates: Number of bitrates in @bitrates
247 * @ht_cap: HT capabilities in this band
248 * @vht_cap: VHT capabilities in this band
250 struct ieee80211_supported_band
{
251 struct ieee80211_channel
*channels
;
252 struct ieee80211_rate
*bitrates
;
253 enum ieee80211_band band
;
256 struct ieee80211_sta_ht_cap ht_cap
;
257 struct ieee80211_sta_vht_cap vht_cap
;
261 * Wireless hardware/device configuration structures and methods
265 * DOC: Actions and configuration
267 * Each wireless device and each virtual interface offer a set of configuration
268 * operations and other actions that are invoked by userspace. Each of these
269 * actions is described in the operations structure, and the parameters these
270 * operations use are described separately.
272 * Additionally, some operations are asynchronous and expect to get status
273 * information via some functions that drivers need to call.
275 * Scanning and BSS list handling with its associated functionality is described
276 * in a separate chapter.
280 * struct vif_params - describes virtual interface parameters
281 * @use_4addr: use 4-address frames
288 * struct key_params - key information
290 * Information about a key
293 * @key_len: length of key material
294 * @cipher: cipher suite selector
295 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
296 * with the get_key() callback, must be in little endian,
297 * length given by @seq_len.
298 * @seq_len: length of @seq.
309 * enum survey_info_flags - survey information flags
311 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
312 * @SURVEY_INFO_IN_USE: channel is currently being used
313 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
314 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
315 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
316 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
317 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
319 * Used by the driver to indicate which info in &struct survey_info
320 * it has filled in during the get_survey().
322 enum survey_info_flags
{
323 SURVEY_INFO_NOISE_DBM
= 1<<0,
324 SURVEY_INFO_IN_USE
= 1<<1,
325 SURVEY_INFO_CHANNEL_TIME
= 1<<2,
326 SURVEY_INFO_CHANNEL_TIME_BUSY
= 1<<3,
327 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY
= 1<<4,
328 SURVEY_INFO_CHANNEL_TIME_RX
= 1<<5,
329 SURVEY_INFO_CHANNEL_TIME_TX
= 1<<6,
333 * struct survey_info - channel survey response
335 * @channel: the channel this survey record reports, mandatory
336 * @filled: bitflag of flags from &enum survey_info_flags
337 * @noise: channel noise in dBm. This and all following fields are
339 * @channel_time: amount of time in ms the radio spent on the channel
340 * @channel_time_busy: amount of time the primary channel was sensed busy
341 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
342 * @channel_time_rx: amount of time the radio spent receiving data
343 * @channel_time_tx: amount of time the radio spent transmitting data
345 * Used by dump_survey() to report back per-channel survey information.
347 * This structure can later be expanded with things like
348 * channel duty cycle etc.
351 struct ieee80211_channel
*channel
;
353 u64 channel_time_busy
;
354 u64 channel_time_ext_busy
;
362 * struct cfg80211_crypto_settings - Crypto settings
363 * @wpa_versions: indicates which, if any, WPA versions are enabled
364 * (from enum nl80211_wpa_versions)
365 * @cipher_group: group key cipher suite (or 0 if unset)
366 * @n_ciphers_pairwise: number of AP supported unicast ciphers
367 * @ciphers_pairwise: unicast key cipher suites
368 * @n_akm_suites: number of AKM suites
369 * @akm_suites: AKM suites
370 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
371 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
372 * required to assume that the port is unauthorized until authorized by
373 * user space. Otherwise, port is marked authorized by default.
374 * @control_port_ethertype: the control port protocol that should be
375 * allowed through even on unauthorized ports
376 * @control_port_no_encrypt: TRUE to prevent encryption of control port
379 struct cfg80211_crypto_settings
{
382 int n_ciphers_pairwise
;
383 u32 ciphers_pairwise
[NL80211_MAX_NR_CIPHER_SUITES
];
385 u32 akm_suites
[NL80211_MAX_NR_AKM_SUITES
];
387 __be16 control_port_ethertype
;
388 bool control_port_no_encrypt
;
392 * struct cfg80211_beacon_data - beacon data
393 * @head: head portion of beacon (before TIM IE)
394 * or %NULL if not changed
395 * @tail: tail portion of beacon (after TIM IE)
396 * or %NULL if not changed
397 * @head_len: length of @head
398 * @tail_len: length of @tail
399 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
400 * @beacon_ies_len: length of beacon_ies in octets
401 * @proberesp_ies: extra information element(s) to add into Probe Response
403 * @proberesp_ies_len: length of proberesp_ies in octets
404 * @assocresp_ies: extra information element(s) to add into (Re)Association
405 * Response frames or %NULL
406 * @assocresp_ies_len: length of assocresp_ies in octets
407 * @probe_resp_len: length of probe response template (@probe_resp)
408 * @probe_resp: probe response template (AP mode only)
410 struct cfg80211_beacon_data
{
411 const u8
*head
, *tail
;
412 const u8
*beacon_ies
;
413 const u8
*proberesp_ies
;
414 const u8
*assocresp_ies
;
415 const u8
*probe_resp
;
417 size_t head_len
, tail_len
;
418 size_t beacon_ies_len
;
419 size_t proberesp_ies_len
;
420 size_t assocresp_ies_len
;
421 size_t probe_resp_len
;
425 * struct cfg80211_ap_settings - AP configuration
427 * Used to configure an AP interface.
429 * @channel: the channel to start the AP on
430 * @channel_type: the channel type to use
431 * @beacon: beacon data
432 * @beacon_interval: beacon interval
433 * @dtim_period: DTIM period
434 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
436 * @ssid_len: length of @ssid
437 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
438 * @crypto: crypto settings
439 * @privacy: the BSS uses privacy
440 * @auth_type: Authentication type (algorithm)
441 * @inactivity_timeout: time in seconds to determine station's inactivity.
443 struct cfg80211_ap_settings
{
444 struct ieee80211_channel
*channel
;
445 enum nl80211_channel_type channel_type
;
447 struct cfg80211_beacon_data beacon
;
449 int beacon_interval
, dtim_period
;
452 enum nl80211_hidden_ssid hidden_ssid
;
453 struct cfg80211_crypto_settings crypto
;
455 enum nl80211_auth_type auth_type
;
456 int inactivity_timeout
;
460 * enum plink_action - actions to perform in mesh peers
462 * @PLINK_ACTION_INVALID: action 0 is reserved
463 * @PLINK_ACTION_OPEN: start mesh peer link establishment
464 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
467 PLINK_ACTION_INVALID
,
473 * enum station_parameters_apply_mask - station parameter values to apply
474 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
476 * Not all station parameters have in-band "no change" signalling,
477 * for those that don't these flags will are used.
479 enum station_parameters_apply_mask
{
480 STATION_PARAM_APPLY_UAPSD
= BIT(0),
484 * struct station_parameters - station parameters
486 * Used to change and create a new station.
488 * @vlan: vlan interface station should belong to
489 * @supported_rates: supported rates in IEEE 802.11 format
490 * (or NULL for no change)
491 * @supported_rates_len: number of supported rates
492 * @sta_flags_mask: station flags that changed
493 * (bitmask of BIT(NL80211_STA_FLAG_...))
494 * @sta_flags_set: station flags values
495 * (bitmask of BIT(NL80211_STA_FLAG_...))
496 * @listen_interval: listen interval or -1 for no change
497 * @aid: AID or zero for no change
498 * @plink_action: plink action to take
499 * @plink_state: set the peer link state for a station
500 * @ht_capa: HT capabilities of station
501 * @vht_capa: VHT capabilities of station
502 * @uapsd_queues: bitmap of queues configured for uapsd. same format
503 * as the AC bitmap in the QoS info field
504 * @max_sp: max Service Period. same format as the MAX_SP in the
505 * QoS info field (but already shifted down)
506 * @sta_modify_mask: bitmap indicating which parameters changed
507 * (for those that don't have a natural "no change" value),
508 * see &enum station_parameters_apply_mask
510 struct station_parameters
{
512 struct net_device
*vlan
;
513 u32 sta_flags_mask
, sta_flags_set
;
517 u8 supported_rates_len
;
520 struct ieee80211_ht_cap
*ht_capa
;
521 struct ieee80211_vht_cap
*vht_capa
;
527 * enum station_info_flags - station information flags
529 * Used by the driver to indicate which info in &struct station_info
530 * it has filled in during get_station() or dump_station().
532 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
533 * @STATION_INFO_RX_BYTES: @rx_bytes filled
534 * @STATION_INFO_TX_BYTES: @tx_bytes filled
535 * @STATION_INFO_LLID: @llid filled
536 * @STATION_INFO_PLID: @plid filled
537 * @STATION_INFO_PLINK_STATE: @plink_state filled
538 * @STATION_INFO_SIGNAL: @signal filled
539 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
540 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
541 * @STATION_INFO_RX_PACKETS: @rx_packets filled
542 * @STATION_INFO_TX_PACKETS: @tx_packets filled
543 * @STATION_INFO_TX_RETRIES: @tx_retries filled
544 * @STATION_INFO_TX_FAILED: @tx_failed filled
545 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
546 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
547 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
548 * @STATION_INFO_BSS_PARAM: @bss_param filled
549 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
550 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
551 * @STATION_INFO_STA_FLAGS: @sta_flags filled
552 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
553 * @STATION_INFO_T_OFFSET: @t_offset filled
555 enum station_info_flags
{
556 STATION_INFO_INACTIVE_TIME
= 1<<0,
557 STATION_INFO_RX_BYTES
= 1<<1,
558 STATION_INFO_TX_BYTES
= 1<<2,
559 STATION_INFO_LLID
= 1<<3,
560 STATION_INFO_PLID
= 1<<4,
561 STATION_INFO_PLINK_STATE
= 1<<5,
562 STATION_INFO_SIGNAL
= 1<<6,
563 STATION_INFO_TX_BITRATE
= 1<<7,
564 STATION_INFO_RX_PACKETS
= 1<<8,
565 STATION_INFO_TX_PACKETS
= 1<<9,
566 STATION_INFO_TX_RETRIES
= 1<<10,
567 STATION_INFO_TX_FAILED
= 1<<11,
568 STATION_INFO_RX_DROP_MISC
= 1<<12,
569 STATION_INFO_SIGNAL_AVG
= 1<<13,
570 STATION_INFO_RX_BITRATE
= 1<<14,
571 STATION_INFO_BSS_PARAM
= 1<<15,
572 STATION_INFO_CONNECTED_TIME
= 1<<16,
573 STATION_INFO_ASSOC_REQ_IES
= 1<<17,
574 STATION_INFO_STA_FLAGS
= 1<<18,
575 STATION_INFO_BEACON_LOSS_COUNT
= 1<<19,
576 STATION_INFO_T_OFFSET
= 1<<20,
580 * enum station_info_rate_flags - bitrate info flags
582 * Used by the driver to indicate the specific rate transmission
583 * type for 802.11n transmissions.
585 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
586 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
587 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
588 * @RATE_INFO_FLAGS_60G: 60gHz MCS
590 enum rate_info_flags
{
591 RATE_INFO_FLAGS_MCS
= 1<<0,
592 RATE_INFO_FLAGS_40_MHZ_WIDTH
= 1<<1,
593 RATE_INFO_FLAGS_SHORT_GI
= 1<<2,
594 RATE_INFO_FLAGS_60G
= 1<<3,
598 * struct rate_info - bitrate information
600 * Information about a receiving or transmitting bitrate
602 * @flags: bitflag of flags from &enum rate_info_flags
603 * @mcs: mcs index if struct describes a 802.11n bitrate
604 * @legacy: bitrate in 100kbit/s for 802.11abg
613 * enum station_info_rate_flags - bitrate info flags
615 * Used by the driver to indicate the specific rate transmission
616 * type for 802.11n transmissions.
618 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
619 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
620 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
622 enum bss_param_flags
{
623 BSS_PARAM_FLAGS_CTS_PROT
= 1<<0,
624 BSS_PARAM_FLAGS_SHORT_PREAMBLE
= 1<<1,
625 BSS_PARAM_FLAGS_SHORT_SLOT_TIME
= 1<<2,
629 * struct sta_bss_parameters - BSS parameters for the attached station
631 * Information about the currently associated BSS
633 * @flags: bitflag of flags from &enum bss_param_flags
634 * @dtim_period: DTIM period for the BSS
635 * @beacon_interval: beacon interval
637 struct sta_bss_parameters
{
644 * struct station_info - station information
646 * Station information filled by driver for get_station() and dump_station.
648 * @filled: bitflag of flags from &enum station_info_flags
649 * @connected_time: time(in secs) since a station is last connected
650 * @inactive_time: time since last station activity (tx/rx) in milliseconds
651 * @rx_bytes: bytes received from this station
652 * @tx_bytes: bytes transmitted to this station
653 * @llid: mesh local link id
654 * @plid: mesh peer link id
655 * @plink_state: mesh peer link state
656 * @signal: The signal strength, type depends on the wiphy's signal_type.
657 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
658 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
659 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
660 * @txrate: current unicast bitrate from this station
661 * @rxrate: current unicast bitrate to this station
662 * @rx_packets: packets received from this station
663 * @tx_packets: packets transmitted to this station
664 * @tx_retries: cumulative retry counts
665 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
666 * @rx_dropped_misc: Dropped for un-specified reason.
667 * @bss_param: current BSS parameters
668 * @generation: generation number for nl80211 dumps.
669 * This number should increase every time the list of stations
670 * changes, i.e. when a station is added or removed, so that
671 * userspace can tell whether it got a consistent snapshot.
672 * @assoc_req_ies: IEs from (Re)Association Request.
673 * This is used only when in AP mode with drivers that do not use
674 * user space MLME/SME implementation. The information is provided for
675 * the cfg80211_new_sta() calls to notify user space of the IEs.
676 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
677 * @sta_flags: station flags mask & values
678 * @beacon_loss_count: Number of times beacon loss event has triggered.
679 * @t_offset: Time offset of the station relative to this host.
681 struct station_info
{
692 struct rate_info txrate
;
693 struct rate_info rxrate
;
699 struct sta_bss_parameters bss_param
;
700 struct nl80211_sta_flag_update sta_flags
;
704 const u8
*assoc_req_ies
;
705 size_t assoc_req_ies_len
;
707 u32 beacon_loss_count
;
711 * Note: Add a new enum station_info_flags value for each new field and
712 * use it to check which fields are initialized.
717 * enum monitor_flags - monitor flags
719 * Monitor interface configuration flags. Note that these must be the bits
720 * according to the nl80211 flags.
722 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
723 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
724 * @MONITOR_FLAG_CONTROL: pass control frames
725 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
726 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
729 MONITOR_FLAG_FCSFAIL
= 1<<NL80211_MNTR_FLAG_FCSFAIL
,
730 MONITOR_FLAG_PLCPFAIL
= 1<<NL80211_MNTR_FLAG_PLCPFAIL
,
731 MONITOR_FLAG_CONTROL
= 1<<NL80211_MNTR_FLAG_CONTROL
,
732 MONITOR_FLAG_OTHER_BSS
= 1<<NL80211_MNTR_FLAG_OTHER_BSS
,
733 MONITOR_FLAG_COOK_FRAMES
= 1<<NL80211_MNTR_FLAG_COOK_FRAMES
,
737 * enum mpath_info_flags - mesh path information flags
739 * Used by the driver to indicate which info in &struct mpath_info it has filled
740 * in during get_station() or dump_station().
742 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
743 * @MPATH_INFO_SN: @sn filled
744 * @MPATH_INFO_METRIC: @metric filled
745 * @MPATH_INFO_EXPTIME: @exptime filled
746 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
747 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
748 * @MPATH_INFO_FLAGS: @flags filled
750 enum mpath_info_flags
{
751 MPATH_INFO_FRAME_QLEN
= BIT(0),
752 MPATH_INFO_SN
= BIT(1),
753 MPATH_INFO_METRIC
= BIT(2),
754 MPATH_INFO_EXPTIME
= BIT(3),
755 MPATH_INFO_DISCOVERY_TIMEOUT
= BIT(4),
756 MPATH_INFO_DISCOVERY_RETRIES
= BIT(5),
757 MPATH_INFO_FLAGS
= BIT(6),
761 * struct mpath_info - mesh path information
763 * Mesh path information filled by driver for get_mpath() and dump_mpath().
765 * @filled: bitfield of flags from &enum mpath_info_flags
766 * @frame_qlen: number of queued frames for this destination
767 * @sn: target sequence number
768 * @metric: metric (cost) of this mesh path
769 * @exptime: expiration time for the mesh path from now, in msecs
770 * @flags: mesh path flags
771 * @discovery_timeout: total mesh path discovery timeout, in msecs
772 * @discovery_retries: mesh path discovery retries
773 * @generation: generation number for nl80211 dumps.
774 * This number should increase every time the list of mesh paths
775 * changes, i.e. when a station is added or removed, so that
776 * userspace can tell whether it got a consistent snapshot.
784 u32 discovery_timeout
;
785 u8 discovery_retries
;
792 * struct bss_parameters - BSS parameters
794 * Used to change BSS parameters (mainly for AP mode).
796 * @use_cts_prot: Whether to use CTS protection
797 * (0 = no, 1 = yes, -1 = do not change)
798 * @use_short_preamble: Whether the use of short preambles is allowed
799 * (0 = no, 1 = yes, -1 = do not change)
800 * @use_short_slot_time: Whether the use of short slot time is allowed
801 * (0 = no, 1 = yes, -1 = do not change)
802 * @basic_rates: basic rates in IEEE 802.11 format
803 * (or NULL for no change)
804 * @basic_rates_len: number of basic rates
805 * @ap_isolate: do not forward packets between connected stations
806 * @ht_opmode: HT Operation mode
807 * (u16 = opmode, -1 = do not change)
809 struct bss_parameters
{
811 int use_short_preamble
;
812 int use_short_slot_time
;
820 * struct mesh_config - 802.11s mesh configuration
822 * These parameters can be changed while the mesh is active.
824 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
825 * by the Mesh Peering Open message
826 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
827 * used by the Mesh Peering Open message
828 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
829 * the mesh peering management to close a mesh peering
830 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
832 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
833 * be sent to establish a new peer link instance in a mesh
834 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
835 * @element_ttl: the value of TTL field set at a mesh STA for path selection
837 * @auto_open_plinks: whether we should automatically open peer links when we
838 * detect compatible mesh peers
839 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
840 * synchronize to for 11s default synchronization method
841 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
842 * that an originator mesh STA can send to a particular path target
843 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
844 * @min_discovery_timeout: the minimum length of time to wait until giving up on
845 * a path discovery in milliseconds
846 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
847 * receiving a PREQ shall consider the forwarding information from the
848 * root to be valid. (TU = time unit)
849 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
850 * which a mesh STA can send only one action frame containing a PREQ
852 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
853 * which a mesh STA can send only one Action frame containing a PERR
855 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
856 * it takes for an HWMP information element to propagate across the mesh
857 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
858 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
859 * announcements are transmitted
860 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
861 * station has access to a broader network beyond the MBSS. (This is
862 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
863 * only means that the station will announce others it's a mesh gate, but
864 * not necessarily using the gate announcement protocol. Still keeping the
865 * same nomenclature to be in sync with the spec)
866 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
867 * entity (default is TRUE - forwarding entity)
868 * @rssi_threshold: the threshold for average signal strength of candidate
869 * station to establish a peer link
870 * @ht_opmode: mesh HT protection mode
872 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
873 * receiving a proactive PREQ shall consider the forwarding information to
874 * the root mesh STA to be valid.
876 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
877 * PREQs are transmitted.
878 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
879 * during which a mesh STA can send only one Action frame containing
880 * a PREQ element for root path confirmation.
883 u16 dot11MeshRetryTimeout
;
884 u16 dot11MeshConfirmTimeout
;
885 u16 dot11MeshHoldingTimeout
;
886 u16 dot11MeshMaxPeerLinks
;
887 u8 dot11MeshMaxRetries
;
890 bool auto_open_plinks
;
891 u32 dot11MeshNbrOffsetMaxNeighbor
;
892 u8 dot11MeshHWMPmaxPREQretries
;
893 u32 path_refresh_time
;
894 u16 min_discovery_timeout
;
895 u32 dot11MeshHWMPactivePathTimeout
;
896 u16 dot11MeshHWMPpreqMinInterval
;
897 u16 dot11MeshHWMPperrMinInterval
;
898 u16 dot11MeshHWMPnetDiameterTraversalTime
;
899 u8 dot11MeshHWMPRootMode
;
900 u16 dot11MeshHWMPRannInterval
;
901 bool dot11MeshGateAnnouncementProtocol
;
902 bool dot11MeshForwarding
;
905 u32 dot11MeshHWMPactivePathToRootTimeout
;
906 u16 dot11MeshHWMProotInterval
;
907 u16 dot11MeshHWMPconfirmationInterval
;
911 * struct mesh_setup - 802.11s mesh setup configuration
912 * @channel: the channel to start the mesh network on
913 * @channel_type: the channel type to use
914 * @mesh_id: the mesh ID
915 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
916 * @sync_method: which synchronization method to use
917 * @path_sel_proto: which path selection protocol to use
918 * @path_metric: which metric to use
919 * @ie: vendor information elements (optional)
920 * @ie_len: length of vendor information elements
921 * @is_authenticated: this mesh requires authentication
922 * @is_secure: this mesh uses security
923 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
925 * These parameters are fixed when the mesh is created.
928 struct ieee80211_channel
*channel
;
929 enum nl80211_channel_type channel_type
;
937 bool is_authenticated
;
939 int mcast_rate
[IEEE80211_NUM_BANDS
];
943 * struct ieee80211_txq_params - TX queue parameters
945 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
946 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
948 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
950 * @aifs: Arbitration interframe space [0..255]
952 struct ieee80211_txq_params
{
960 /* from net/wireless.h */
964 * DOC: Scanning and BSS list handling
966 * The scanning process itself is fairly simple, but cfg80211 offers quite
967 * a bit of helper functionality. To start a scan, the scan operation will
968 * be invoked with a scan definition. This scan definition contains the
969 * channels to scan, and the SSIDs to send probe requests for (including the
970 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
971 * probe. Additionally, a scan request may contain extra information elements
972 * that should be added to the probe request. The IEs are guaranteed to be
973 * well-formed, and will not exceed the maximum length the driver advertised
974 * in the wiphy structure.
976 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
977 * it is responsible for maintaining the BSS list; the driver should not
978 * maintain a list itself. For this notification, various functions exist.
980 * Since drivers do not maintain a BSS list, there are also a number of
981 * functions to search for a BSS and obtain information about it from the
982 * BSS structure cfg80211 maintains. The BSS list is also made available
987 * struct cfg80211_ssid - SSID description
989 * @ssid_len: length of the ssid
991 struct cfg80211_ssid
{
992 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
997 * struct cfg80211_scan_request - scan request description
999 * @ssids: SSIDs to scan for (active scan only)
1000 * @n_ssids: number of SSIDs
1001 * @channels: channels to scan on.
1002 * @n_channels: total number of channels to scan
1003 * @ie: optional information element(s) to add into Probe Request or %NULL
1004 * @ie_len: length of ie in octets
1005 * @flags: bit field of flags controlling operation
1006 * @rates: bitmap of rates to advertise for each band
1007 * @wiphy: the wiphy this was for
1008 * @scan_start: time (in jiffies) when the scan started
1009 * @wdev: the wireless device to scan for
1010 * @aborted: (internal) scan request was notified as aborted
1011 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1013 struct cfg80211_scan_request
{
1014 struct cfg80211_ssid
*ssids
;
1021 u32 rates
[IEEE80211_NUM_BANDS
];
1023 struct wireless_dev
*wdev
;
1026 struct wiphy
*wiphy
;
1027 unsigned long scan_start
;
1032 struct ieee80211_channel
*channels
[0];
1036 * struct cfg80211_match_set - sets of attributes to match
1038 * @ssid: SSID to be matched
1040 struct cfg80211_match_set
{
1041 struct cfg80211_ssid ssid
;
1045 * struct cfg80211_sched_scan_request - scheduled scan request description
1047 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1048 * @n_ssids: number of SSIDs
1049 * @n_channels: total number of channels to scan
1050 * @interval: interval between each scheduled scan cycle
1051 * @ie: optional information element(s) to add into Probe Request or %NULL
1052 * @ie_len: length of ie in octets
1053 * @flags: bit field of flags controlling operation
1054 * @match_sets: sets of parameters to be matched for a scan result
1055 * entry to be considered valid and to be passed to the host
1056 * (others are filtered out).
1057 * If ommited, all results are passed.
1058 * @n_match_sets: number of match sets
1059 * @wiphy: the wiphy this was for
1060 * @dev: the interface
1061 * @channels: channels to scan
1062 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1064 struct cfg80211_sched_scan_request
{
1065 struct cfg80211_ssid
*ssids
;
1072 struct cfg80211_match_set
*match_sets
;
1077 struct wiphy
*wiphy
;
1078 struct net_device
*dev
;
1079 unsigned long scan_start
;
1082 struct ieee80211_channel
*channels
[0];
1086 * enum cfg80211_signal_type - signal type
1088 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1089 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1090 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1092 enum cfg80211_signal_type
{
1093 CFG80211_SIGNAL_TYPE_NONE
,
1094 CFG80211_SIGNAL_TYPE_MBM
,
1095 CFG80211_SIGNAL_TYPE_UNSPEC
,
1099 * struct cfg80211_bss - BSS description
1101 * This structure describes a BSS (which may also be a mesh network)
1102 * for use in scan results and similar.
1104 * @channel: channel this BSS is on
1105 * @bssid: BSSID of the BSS
1106 * @tsf: timestamp of last received update
1107 * @beacon_interval: the beacon interval as from the frame
1108 * @capability: the capability field in host byte order
1109 * @information_elements: the information elements (Note that there
1110 * is no guarantee that these are well-formed!); this is a pointer to
1111 * either the beacon_ies or proberesp_ies depending on whether Probe
1112 * Response frame has been received
1113 * @len_information_elements: total length of the information elements
1114 * @beacon_ies: the information elements from the last Beacon frame
1115 * @len_beacon_ies: total length of the beacon_ies
1116 * @proberesp_ies: the information elements from the last Probe Response frame
1117 * @len_proberesp_ies: total length of the proberesp_ies
1118 * @signal: signal strength value (type depends on the wiphy's signal_type)
1119 * @free_priv: function pointer to free private data
1120 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1122 struct cfg80211_bss
{
1123 struct ieee80211_channel
*channel
;
1127 u16 beacon_interval
;
1129 u8
*information_elements
;
1130 size_t len_information_elements
;
1132 size_t len_beacon_ies
;
1134 size_t len_proberesp_ies
;
1138 void (*free_priv
)(struct cfg80211_bss
*bss
);
1139 u8 priv
[0] __attribute__((__aligned__(sizeof(void *))));
1143 * ieee80211_bss_get_ie - find IE with given ID
1144 * @bss: the bss to search
1146 * Returns %NULL if not found.
1148 const u8
*ieee80211_bss_get_ie(struct cfg80211_bss
*bss
, u8 ie
);
1152 * struct cfg80211_auth_request - Authentication request data
1154 * This structure provides information needed to complete IEEE 802.11
1157 * @bss: The BSS to authenticate with.
1158 * @auth_type: Authentication type (algorithm)
1159 * @ie: Extra IEs to add to Authentication frame or %NULL
1160 * @ie_len: Length of ie buffer in octets
1161 * @key_len: length of WEP key for shared key authentication
1162 * @key_idx: index of WEP key for shared key authentication
1163 * @key: WEP key for shared key authentication
1164 * @sae_data: Non-IE data to use with SAE or %NULL. This starts with
1165 * Authentication transaction sequence number field.
1166 * @sae_data_len: Length of sae_data buffer in octets
1168 struct cfg80211_auth_request
{
1169 struct cfg80211_bss
*bss
;
1172 enum nl80211_auth_type auth_type
;
1174 u8 key_len
, key_idx
;
1176 size_t sae_data_len
;
1180 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1182 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1184 enum cfg80211_assoc_req_flags
{
1185 ASSOC_REQ_DISABLE_HT
= BIT(0),
1189 * struct cfg80211_assoc_request - (Re)Association request data
1191 * This structure provides information needed to complete IEEE 802.11
1193 * @bss: The BSS to associate with. If the call is successful the driver
1194 * is given a reference that it must release, normally via a call to
1195 * cfg80211_send_rx_assoc(), or, if association timed out, with a
1196 * call to cfg80211_put_bss() (in addition to calling
1197 * cfg80211_send_assoc_timeout())
1198 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1199 * @ie_len: Length of ie buffer in octets
1200 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1201 * @crypto: crypto settings
1202 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1203 * @flags: See &enum cfg80211_assoc_req_flags
1204 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1205 * will be used in ht_capa. Un-supported values will be ignored.
1206 * @ht_capa_mask: The bits of ht_capa which are to be used.
1208 struct cfg80211_assoc_request
{
1209 struct cfg80211_bss
*bss
;
1210 const u8
*ie
, *prev_bssid
;
1212 struct cfg80211_crypto_settings crypto
;
1215 struct ieee80211_ht_cap ht_capa
;
1216 struct ieee80211_ht_cap ht_capa_mask
;
1220 * struct cfg80211_deauth_request - Deauthentication request data
1222 * This structure provides information needed to complete IEEE 802.11
1225 * @bssid: the BSSID of the BSS to deauthenticate from
1226 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1227 * @ie_len: Length of ie buffer in octets
1228 * @reason_code: The reason code for the deauthentication
1230 struct cfg80211_deauth_request
{
1235 bool local_state_change
;
1239 * struct cfg80211_disassoc_request - Disassociation request data
1241 * This structure provides information needed to complete IEEE 802.11
1244 * @bss: the BSS to disassociate from
1245 * @ie: Extra IEs to add to Disassociation frame or %NULL
1246 * @ie_len: Length of ie buffer in octets
1247 * @reason_code: The reason code for the disassociation
1248 * @local_state_change: This is a request for a local state only, i.e., no
1249 * Disassociation frame is to be transmitted.
1251 struct cfg80211_disassoc_request
{
1252 struct cfg80211_bss
*bss
;
1256 bool local_state_change
;
1260 * struct cfg80211_ibss_params - IBSS parameters
1262 * This structure defines the IBSS parameters for the join_ibss()
1265 * @ssid: The SSID, will always be non-null.
1266 * @ssid_len: The length of the SSID, will always be non-zero.
1267 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1268 * search for IBSSs with a different BSSID.
1269 * @channel: The channel to use if no IBSS can be found to join.
1270 * @channel_type: channel type (HT mode)
1271 * @channel_fixed: The channel should be fixed -- do not search for
1272 * IBSSs to join on other channels.
1273 * @ie: information element(s) to include in the beacon
1274 * @ie_len: length of that
1275 * @beacon_interval: beacon interval to use
1276 * @privacy: this is a protected network, keys will be configured
1278 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1279 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1280 * required to assume that the port is unauthorized until authorized by
1281 * user space. Otherwise, port is marked authorized by default.
1282 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1283 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1285 struct cfg80211_ibss_params
{
1288 struct ieee80211_channel
*channel
;
1289 enum nl80211_channel_type channel_type
;
1291 u8 ssid_len
, ie_len
;
1292 u16 beacon_interval
;
1297 int mcast_rate
[IEEE80211_NUM_BANDS
];
1301 * struct cfg80211_connect_params - Connection parameters
1303 * This structure provides information needed to complete IEEE 802.11
1304 * authentication and association.
1306 * @channel: The channel to use or %NULL if not specified (auto-select based
1308 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1311 * @ssid_len: Length of ssid in octets
1312 * @auth_type: Authentication type (algorithm)
1313 * @ie: IEs for association request
1314 * @ie_len: Length of assoc_ie in octets
1315 * @privacy: indicates whether privacy-enabled APs should be used
1316 * @crypto: crypto settings
1317 * @key_len: length of WEP key for shared key authentication
1318 * @key_idx: index of WEP key for shared key authentication
1319 * @key: WEP key for shared key authentication
1320 * @flags: See &enum cfg80211_assoc_req_flags
1321 * @bg_scan_period: Background scan period in seconds
1322 * or -1 to indicate that default value is to be used.
1323 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1324 * will be used in ht_capa. Un-supported values will be ignored.
1325 * @ht_capa_mask: The bits of ht_capa which are to be used.
1327 struct cfg80211_connect_params
{
1328 struct ieee80211_channel
*channel
;
1332 enum nl80211_auth_type auth_type
;
1336 struct cfg80211_crypto_settings crypto
;
1338 u8 key_len
, key_idx
;
1341 struct ieee80211_ht_cap ht_capa
;
1342 struct ieee80211_ht_cap ht_capa_mask
;
1346 * enum wiphy_params_flags - set_wiphy_params bitfield values
1347 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1348 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1349 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1350 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1351 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1353 enum wiphy_params_flags
{
1354 WIPHY_PARAM_RETRY_SHORT
= 1 << 0,
1355 WIPHY_PARAM_RETRY_LONG
= 1 << 1,
1356 WIPHY_PARAM_FRAG_THRESHOLD
= 1 << 2,
1357 WIPHY_PARAM_RTS_THRESHOLD
= 1 << 3,
1358 WIPHY_PARAM_COVERAGE_CLASS
= 1 << 4,
1362 * cfg80211_bitrate_mask - masks for bitrate control
1364 struct cfg80211_bitrate_mask
{
1367 u8 mcs
[IEEE80211_HT_MCS_MASK_LEN
];
1368 } control
[IEEE80211_NUM_BANDS
];
1371 * struct cfg80211_pmksa - PMK Security Association
1373 * This structure is passed to the set/del_pmksa() method for PMKSA
1376 * @bssid: The AP's BSSID.
1377 * @pmkid: The PMK material itself.
1379 struct cfg80211_pmksa
{
1385 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1386 * @mask: bitmask where to match pattern and where to ignore bytes,
1387 * one bit per byte, in same format as nl80211
1388 * @pattern: bytes to match where bitmask is 1
1389 * @pattern_len: length of pattern (in bytes)
1391 * Internal note: @mask and @pattern are allocated in one chunk of
1392 * memory, free @mask only!
1394 struct cfg80211_wowlan_trig_pkt_pattern
{
1400 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1402 * This structure defines the enabled WoWLAN triggers for the device.
1403 * @any: wake up on any activity -- special trigger if device continues
1404 * operating as normal during suspend
1405 * @disconnect: wake up if getting disconnected
1406 * @magic_pkt: wake up on receiving magic packet
1407 * @patterns: wake up on receiving packet matching a pattern
1408 * @n_patterns: number of patterns
1409 * @gtk_rekey_failure: wake up on GTK rekey failure
1410 * @eap_identity_req: wake up on EAP identity request packet
1411 * @four_way_handshake: wake up on 4-way handshake
1412 * @rfkill_release: wake up when rfkill is released
1414 struct cfg80211_wowlan
{
1415 bool any
, disconnect
, magic_pkt
, gtk_rekey_failure
,
1416 eap_identity_req
, four_way_handshake
,
1418 struct cfg80211_wowlan_trig_pkt_pattern
*patterns
;
1423 * struct cfg80211_gtk_rekey_data - rekey data
1424 * @kek: key encryption key
1425 * @kck: key confirmation key
1426 * @replay_ctr: replay counter
1428 struct cfg80211_gtk_rekey_data
{
1429 u8 kek
[NL80211_KEK_LEN
];
1430 u8 kck
[NL80211_KCK_LEN
];
1431 u8 replay_ctr
[NL80211_REPLAY_CTR_LEN
];
1435 * struct cfg80211_ops - backend description for wireless configuration
1437 * This struct is registered by fullmac card drivers and/or wireless stacks
1438 * in order to handle configuration requests on their interfaces.
1440 * All callbacks except where otherwise noted should return 0
1441 * on success or a negative error code.
1443 * All operations are currently invoked under rtnl for consistency with the
1444 * wireless extensions but this is subject to reevaluation as soon as this
1445 * code is used more widely and we have a first user without wext.
1447 * @suspend: wiphy device needs to be suspended. The variable @wow will
1448 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1449 * configured for the device.
1450 * @resume: wiphy device needs to be resumed
1451 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
1452 * to call device_set_wakeup_enable() to enable/disable wakeup from
1455 * @add_virtual_intf: create a new virtual interface with the given name,
1456 * must set the struct wireless_dev's iftype. Beware: You must create
1457 * the new netdev in the wiphy's network namespace! Returns the struct
1458 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
1459 * also set the address member in the wdev.
1461 * @del_virtual_intf: remove the virtual interface
1463 * @change_virtual_intf: change type/configuration of virtual interface,
1464 * keep the struct wireless_dev's iftype updated.
1466 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1467 * when adding a group key.
1469 * @get_key: get information about the key with the given parameters.
1470 * @mac_addr will be %NULL when requesting information for a group
1471 * key. All pointers given to the @callback function need not be valid
1472 * after it returns. This function should return an error if it is
1473 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1475 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1476 * and @key_index, return -ENOENT if the key doesn't exist.
1478 * @set_default_key: set the default key on an interface
1480 * @set_default_mgmt_key: set the default management frame key on an interface
1482 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1484 * @start_ap: Start acting in AP mode defined by the parameters.
1485 * @change_beacon: Change the beacon parameters for an access point mode
1486 * interface. This should reject the call when AP mode wasn't started.
1487 * @stop_ap: Stop being an AP, including stopping beaconing.
1489 * @add_station: Add a new station.
1490 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1491 * @change_station: Modify a given station. Note that flags changes are not much
1492 * validated in cfg80211, in particular the auth/assoc/authorized flags
1493 * might come to the driver in invalid combinations -- make sure to check
1494 * them, also against the existing state! Also, supported_rates changes are
1495 * not checked in station mode -- drivers need to reject (or ignore) them
1496 * for anything but TDLS peers.
1497 * @get_station: get station information for the station identified by @mac
1498 * @dump_station: dump station callback -- resume dump at index @idx
1500 * @add_mpath: add a fixed mesh path
1501 * @del_mpath: delete a given mesh path
1502 * @change_mpath: change a given mesh path
1503 * @get_mpath: get a mesh path for the given parameters
1504 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1505 * @join_mesh: join the mesh network with the specified parameters
1506 * @leave_mesh: leave the current mesh network
1508 * @get_mesh_config: Get the current mesh configuration
1510 * @update_mesh_config: Update mesh parameters on a running mesh.
1511 * The mask is a bitfield which tells us which parameters to
1512 * set, and which to leave alone.
1514 * @change_bss: Modify parameters for a given BSS.
1516 * @set_txq_params: Set TX queue parameters
1518 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
1519 * as it doesn't implement join_mesh and needs to set the channel to
1520 * join the mesh instead.
1522 * @set_monitor_channel: Set the monitor mode channel for the device. If other
1523 * interfaces are active this callback should reject the configuration.
1524 * If no interfaces are active or the device is down, the channel should
1525 * be stored for when a monitor interface becomes active.
1527 * @scan: Request to do a scan. If returning zero, the scan request is given
1528 * the driver, and will be valid until passed to cfg80211_scan_done().
1529 * For scan results, call cfg80211_inform_bss(); you can call this outside
1530 * the scan/scan_done bracket too.
1532 * @auth: Request to authenticate with the specified peer
1533 * @assoc: Request to (re)associate with the specified peer
1534 * @deauth: Request to deauthenticate from the specified peer
1535 * @disassoc: Request to disassociate from the specified peer
1537 * @connect: Connect to the ESS with the specified parameters. When connected,
1538 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1539 * If the connection fails for some reason, call cfg80211_connect_result()
1540 * with the status from the AP.
1541 * @disconnect: Disconnect from the BSS/ESS.
1543 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1544 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1546 * @leave_ibss: Leave the IBSS.
1548 * @set_wiphy_params: Notify that wiphy parameters have changed;
1549 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1550 * have changed. The actual parameter values are available in
1551 * struct wiphy. If returning an error, no value should be changed.
1553 * @set_tx_power: set the transmit power according to the parameters,
1554 * the power passed is in mBm, to get dBm use MBM_TO_DBM().
1555 * @get_tx_power: store the current TX power into the dbm variable;
1556 * return 0 if successful
1558 * @set_wds_peer: set the WDS peer for a WDS interface
1560 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1561 * functions to adjust rfkill hw state
1563 * @dump_survey: get site survey information.
1565 * @remain_on_channel: Request the driver to remain awake on the specified
1566 * channel for the specified duration to complete an off-channel
1567 * operation (e.g., public action frame exchange). When the driver is
1568 * ready on the requested channel, it must indicate this with an event
1569 * notification by calling cfg80211_ready_on_channel().
1570 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1571 * This allows the operation to be terminated prior to timeout based on
1572 * the duration value.
1573 * @mgmt_tx: Transmit a management frame.
1574 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1575 * frame on another channel
1577 * @testmode_cmd: run a test mode command
1578 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1579 * used by the function, but 0 and 1 must not be touched. Additionally,
1580 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1581 * dump and return to userspace with an error, so be careful. If any data
1582 * was passed in from userspace then the data/len arguments will be present
1583 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1585 * @set_bitrate_mask: set the bitrate mask configuration
1587 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1588 * devices running firmwares capable of generating the (re) association
1589 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1590 * @del_pmksa: Delete a cached PMKID.
1591 * @flush_pmksa: Flush all cached PMKIDs.
1592 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1593 * allows the driver to adjust the dynamic ps timeout value.
1594 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1595 * @set_cqm_txe_config: Configure connection quality monitor TX error
1597 * @sched_scan_start: Tell the driver to start a scheduled scan.
1598 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan.
1600 * @mgmt_frame_register: Notify driver that a management frame type was
1601 * registered. Note that this callback may not sleep, and cannot run
1602 * concurrently with itself.
1604 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1605 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1606 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1607 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1609 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1611 * @set_ringparam: Set tx and rx ring sizes.
1613 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1615 * @tdls_mgmt: Transmit a TDLS management frame.
1616 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1618 * @probe_client: probe an associated client, must return a cookie that it
1619 * later passes to cfg80211_probe_status().
1621 * @set_noack_map: Set the NoAck Map for the TIDs.
1623 * @get_et_sset_count: Ethtool API to get string-set count.
1624 * See @ethtool_ops.get_sset_count
1626 * @get_et_stats: Ethtool API to get a set of u64 stats.
1627 * See @ethtool_ops.get_ethtool_stats
1629 * @get_et_strings: Ethtool API to get a set of strings to describe stats
1630 * and perhaps other supported types of ethtool data-sets.
1631 * See @ethtool_ops.get_strings
1633 * @get_channel: Get the current operating channel for the virtual interface.
1634 * For monitor interfaces, it should return %NULL unless there's a single
1635 * current monitoring channel.
1637 * @start_p2p_device: Start the given P2P device.
1638 * @stop_p2p_device: Stop the given P2P device.
1640 struct cfg80211_ops
{
1641 int (*suspend
)(struct wiphy
*wiphy
, struct cfg80211_wowlan
*wow
);
1642 int (*resume
)(struct wiphy
*wiphy
);
1643 void (*set_wakeup
)(struct wiphy
*wiphy
, bool enabled
);
1645 struct wireless_dev
* (*add_virtual_intf
)(struct wiphy
*wiphy
,
1647 enum nl80211_iftype type
,
1649 struct vif_params
*params
);
1650 int (*del_virtual_intf
)(struct wiphy
*wiphy
,
1651 struct wireless_dev
*wdev
);
1652 int (*change_virtual_intf
)(struct wiphy
*wiphy
,
1653 struct net_device
*dev
,
1654 enum nl80211_iftype type
, u32
*flags
,
1655 struct vif_params
*params
);
1657 int (*add_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1658 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
1659 struct key_params
*params
);
1660 int (*get_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1661 u8 key_index
, bool pairwise
, const u8
*mac_addr
,
1663 void (*callback
)(void *cookie
, struct key_params
*));
1664 int (*del_key
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1665 u8 key_index
, bool pairwise
, const u8
*mac_addr
);
1666 int (*set_default_key
)(struct wiphy
*wiphy
,
1667 struct net_device
*netdev
,
1668 u8 key_index
, bool unicast
, bool multicast
);
1669 int (*set_default_mgmt_key
)(struct wiphy
*wiphy
,
1670 struct net_device
*netdev
,
1673 int (*start_ap
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1674 struct cfg80211_ap_settings
*settings
);
1675 int (*change_beacon
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1676 struct cfg80211_beacon_data
*info
);
1677 int (*stop_ap
)(struct wiphy
*wiphy
, struct net_device
*dev
);
1680 int (*add_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1681 u8
*mac
, struct station_parameters
*params
);
1682 int (*del_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1684 int (*change_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1685 u8
*mac
, struct station_parameters
*params
);
1686 int (*get_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1687 u8
*mac
, struct station_info
*sinfo
);
1688 int (*dump_station
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1689 int idx
, u8
*mac
, struct station_info
*sinfo
);
1691 int (*add_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1692 u8
*dst
, u8
*next_hop
);
1693 int (*del_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1695 int (*change_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1696 u8
*dst
, u8
*next_hop
);
1697 int (*get_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1698 u8
*dst
, u8
*next_hop
,
1699 struct mpath_info
*pinfo
);
1700 int (*dump_mpath
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1701 int idx
, u8
*dst
, u8
*next_hop
,
1702 struct mpath_info
*pinfo
);
1703 int (*get_mesh_config
)(struct wiphy
*wiphy
,
1704 struct net_device
*dev
,
1705 struct mesh_config
*conf
);
1706 int (*update_mesh_config
)(struct wiphy
*wiphy
,
1707 struct net_device
*dev
, u32 mask
,
1708 const struct mesh_config
*nconf
);
1709 int (*join_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1710 const struct mesh_config
*conf
,
1711 const struct mesh_setup
*setup
);
1712 int (*leave_mesh
)(struct wiphy
*wiphy
, struct net_device
*dev
);
1714 int (*change_bss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1715 struct bss_parameters
*params
);
1717 int (*set_txq_params
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1718 struct ieee80211_txq_params
*params
);
1720 int (*libertas_set_mesh_channel
)(struct wiphy
*wiphy
,
1721 struct net_device
*dev
,
1722 struct ieee80211_channel
*chan
);
1724 int (*set_monitor_channel
)(struct wiphy
*wiphy
,
1725 struct ieee80211_channel
*chan
,
1726 enum nl80211_channel_type channel_type
);
1728 int (*scan
)(struct wiphy
*wiphy
,
1729 struct cfg80211_scan_request
*request
);
1731 int (*auth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1732 struct cfg80211_auth_request
*req
);
1733 int (*assoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1734 struct cfg80211_assoc_request
*req
);
1735 int (*deauth
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1736 struct cfg80211_deauth_request
*req
);
1737 int (*disassoc
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1738 struct cfg80211_disassoc_request
*req
);
1740 int (*connect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1741 struct cfg80211_connect_params
*sme
);
1742 int (*disconnect
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1745 int (*join_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1746 struct cfg80211_ibss_params
*params
);
1747 int (*leave_ibss
)(struct wiphy
*wiphy
, struct net_device
*dev
);
1749 int (*set_wiphy_params
)(struct wiphy
*wiphy
, u32 changed
);
1751 int (*set_tx_power
)(struct wiphy
*wiphy
,
1752 enum nl80211_tx_power_setting type
, int mbm
);
1753 int (*get_tx_power
)(struct wiphy
*wiphy
, int *dbm
);
1755 int (*set_wds_peer
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1758 void (*rfkill_poll
)(struct wiphy
*wiphy
);
1760 #ifdef CONFIG_NL80211_TESTMODE
1761 int (*testmode_cmd
)(struct wiphy
*wiphy
, void *data
, int len
);
1762 int (*testmode_dump
)(struct wiphy
*wiphy
, struct sk_buff
*skb
,
1763 struct netlink_callback
*cb
,
1764 void *data
, int len
);
1767 int (*set_bitrate_mask
)(struct wiphy
*wiphy
,
1768 struct net_device
*dev
,
1770 const struct cfg80211_bitrate_mask
*mask
);
1772 int (*dump_survey
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1773 int idx
, struct survey_info
*info
);
1775 int (*set_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1776 struct cfg80211_pmksa
*pmksa
);
1777 int (*del_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
,
1778 struct cfg80211_pmksa
*pmksa
);
1779 int (*flush_pmksa
)(struct wiphy
*wiphy
, struct net_device
*netdev
);
1781 int (*remain_on_channel
)(struct wiphy
*wiphy
,
1782 struct wireless_dev
*wdev
,
1783 struct ieee80211_channel
*chan
,
1784 enum nl80211_channel_type channel_type
,
1785 unsigned int duration
,
1787 int (*cancel_remain_on_channel
)(struct wiphy
*wiphy
,
1788 struct wireless_dev
*wdev
,
1791 int (*mgmt_tx
)(struct wiphy
*wiphy
, struct wireless_dev
*wdev
,
1792 struct ieee80211_channel
*chan
, bool offchan
,
1793 enum nl80211_channel_type channel_type
,
1794 bool channel_type_valid
, unsigned int wait
,
1795 const u8
*buf
, size_t len
, bool no_cck
,
1796 bool dont_wait_for_ack
, u64
*cookie
);
1797 int (*mgmt_tx_cancel_wait
)(struct wiphy
*wiphy
,
1798 struct wireless_dev
*wdev
,
1801 int (*set_power_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1802 bool enabled
, int timeout
);
1804 int (*set_cqm_rssi_config
)(struct wiphy
*wiphy
,
1805 struct net_device
*dev
,
1806 s32 rssi_thold
, u32 rssi_hyst
);
1808 int (*set_cqm_txe_config
)(struct wiphy
*wiphy
,
1809 struct net_device
*dev
,
1810 u32 rate
, u32 pkts
, u32 intvl
);
1812 void (*mgmt_frame_register
)(struct wiphy
*wiphy
,
1813 struct wireless_dev
*wdev
,
1814 u16 frame_type
, bool reg
);
1816 int (*set_antenna
)(struct wiphy
*wiphy
, u32 tx_ant
, u32 rx_ant
);
1817 int (*get_antenna
)(struct wiphy
*wiphy
, u32
*tx_ant
, u32
*rx_ant
);
1819 int (*set_ringparam
)(struct wiphy
*wiphy
, u32 tx
, u32 rx
);
1820 void (*get_ringparam
)(struct wiphy
*wiphy
,
1821 u32
*tx
, u32
*tx_max
, u32
*rx
, u32
*rx_max
);
1823 int (*sched_scan_start
)(struct wiphy
*wiphy
,
1824 struct net_device
*dev
,
1825 struct cfg80211_sched_scan_request
*request
);
1826 int (*sched_scan_stop
)(struct wiphy
*wiphy
, struct net_device
*dev
);
1828 int (*set_rekey_data
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1829 struct cfg80211_gtk_rekey_data
*data
);
1831 int (*tdls_mgmt
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1832 u8
*peer
, u8 action_code
, u8 dialog_token
,
1833 u16 status_code
, const u8
*buf
, size_t len
);
1834 int (*tdls_oper
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1835 u8
*peer
, enum nl80211_tdls_operation oper
);
1837 int (*probe_client
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1838 const u8
*peer
, u64
*cookie
);
1840 int (*set_noack_map
)(struct wiphy
*wiphy
,
1841 struct net_device
*dev
,
1844 int (*get_et_sset_count
)(struct wiphy
*wiphy
,
1845 struct net_device
*dev
, int sset
);
1846 void (*get_et_stats
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1847 struct ethtool_stats
*stats
, u64
*data
);
1848 void (*get_et_strings
)(struct wiphy
*wiphy
, struct net_device
*dev
,
1849 u32 sset
, u8
*data
);
1851 struct ieee80211_channel
*
1852 (*get_channel
)(struct wiphy
*wiphy
,
1853 struct wireless_dev
*wdev
,
1854 enum nl80211_channel_type
*type
);
1856 int (*start_p2p_device
)(struct wiphy
*wiphy
,
1857 struct wireless_dev
*wdev
);
1858 void (*stop_p2p_device
)(struct wiphy
*wiphy
,
1859 struct wireless_dev
*wdev
);
1863 * wireless hardware and networking interfaces structures
1864 * and registration/helper functions
1868 * enum wiphy_flags - wiphy capability flags
1870 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1871 * has its own custom regulatory domain and cannot identify the
1872 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1873 * we will disregard the first regulatory hint (when the
1874 * initiator is %REGDOM_SET_BY_CORE).
1875 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1876 * ignore regulatory domain settings until it gets its own regulatory
1877 * domain via its regulatory_hint() unless the regulatory hint is
1878 * from a country IE. After its gets its own regulatory domain it will
1879 * only allow further regulatory domain settings to further enhance
1880 * compliance. For example if channel 13 and 14 are disabled by this
1881 * regulatory domain no user regulatory domain can enable these channels
1882 * at a later time. This can be used for devices which do not have
1883 * calibration information guaranteed for frequencies or settings
1884 * outside of its regulatory domain. If used in combination with
1885 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
1887 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1888 * that passive scan flags and beaconing flags may not be lifted by
1889 * cfg80211 due to regulatory beacon hints. For more information on beacon
1890 * hints read the documenation for regulatory_hint_found_beacon()
1891 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1893 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1894 * by default -- this flag will be set depending on the kernel's default
1895 * on wiphy_new(), but can be changed by the driver if it has a good
1896 * reason to override the default
1897 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1898 * on a VLAN interface)
1899 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1900 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1901 * control port protocol ethertype. The device also honours the
1902 * control_port_no_encrypt flag.
1903 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1904 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1905 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1906 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
1907 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
1909 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
1910 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
1911 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
1912 * link setup/discovery operations internally. Setup, discovery and
1913 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
1914 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
1915 * used for asking the driver/firmware to perform a TDLS operation.
1916 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
1917 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
1918 * when there are virtual interfaces in AP mode by calling
1919 * cfg80211_report_obss_beacon().
1920 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
1921 * responds to probe-requests in hardware.
1922 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
1923 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
1926 WIPHY_FLAG_CUSTOM_REGULATORY
= BIT(0),
1927 WIPHY_FLAG_STRICT_REGULATORY
= BIT(1),
1928 WIPHY_FLAG_DISABLE_BEACON_HINTS
= BIT(2),
1929 WIPHY_FLAG_NETNS_OK
= BIT(3),
1930 WIPHY_FLAG_PS_ON_BY_DEFAULT
= BIT(4),
1931 WIPHY_FLAG_4ADDR_AP
= BIT(5),
1932 WIPHY_FLAG_4ADDR_STATION
= BIT(6),
1933 WIPHY_FLAG_CONTROL_PORT_PROTOCOL
= BIT(7),
1934 WIPHY_FLAG_IBSS_RSN
= BIT(8),
1935 WIPHY_FLAG_MESH_AUTH
= BIT(10),
1936 WIPHY_FLAG_SUPPORTS_SCHED_SCAN
= BIT(11),
1937 /* use hole at 12 */
1938 WIPHY_FLAG_SUPPORTS_FW_ROAM
= BIT(13),
1939 WIPHY_FLAG_AP_UAPSD
= BIT(14),
1940 WIPHY_FLAG_SUPPORTS_TDLS
= BIT(15),
1941 WIPHY_FLAG_TDLS_EXTERNAL_SETUP
= BIT(16),
1942 WIPHY_FLAG_HAVE_AP_SME
= BIT(17),
1943 WIPHY_FLAG_REPORTS_OBSS
= BIT(18),
1944 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD
= BIT(19),
1945 WIPHY_FLAG_OFFCHAN_TX
= BIT(20),
1946 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL
= BIT(21),
1950 * struct ieee80211_iface_limit - limit on certain interface types
1951 * @max: maximum number of interfaces of these types
1952 * @types: interface types (bits)
1954 struct ieee80211_iface_limit
{
1960 * struct ieee80211_iface_combination - possible interface combination
1961 * @limits: limits for the given interface types
1962 * @n_limits: number of limitations
1963 * @num_different_channels: can use up to this many different channels
1964 * @max_interfaces: maximum number of interfaces in total allowed in this
1966 * @beacon_int_infra_match: In this combination, the beacon intervals
1967 * between infrastructure and AP types must match. This is required
1968 * only in special cases.
1970 * These examples can be expressed as follows:
1972 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
1974 * struct ieee80211_iface_limit limits1[] = {
1975 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1976 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
1978 * struct ieee80211_iface_combination combination1 = {
1979 * .limits = limits1,
1980 * .n_limits = ARRAY_SIZE(limits1),
1981 * .max_interfaces = 2,
1982 * .beacon_int_infra_match = true,
1986 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
1988 * struct ieee80211_iface_limit limits2[] = {
1989 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
1990 * BIT(NL80211_IFTYPE_P2P_GO), },
1992 * struct ieee80211_iface_combination combination2 = {
1993 * .limits = limits2,
1994 * .n_limits = ARRAY_SIZE(limits2),
1995 * .max_interfaces = 8,
1996 * .num_different_channels = 1,
2000 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
2001 * This allows for an infrastructure connection and three P2P connections.
2003 * struct ieee80211_iface_limit limits3[] = {
2004 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
2005 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
2006 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
2008 * struct ieee80211_iface_combination combination3 = {
2009 * .limits = limits3,
2010 * .n_limits = ARRAY_SIZE(limits3),
2011 * .max_interfaces = 4,
2012 * .num_different_channels = 2,
2015 struct ieee80211_iface_combination
{
2016 const struct ieee80211_iface_limit
*limits
;
2017 u32 num_different_channels
;
2020 bool beacon_int_infra_match
;
2023 struct mac_address
{
2027 struct ieee80211_txrx_stypes
{
2032 * enum wiphy_wowlan_support_flags - WoWLAN support flags
2033 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
2034 * trigger that keeps the device operating as-is and
2035 * wakes up the host on any activity, for example a
2036 * received packet that passed filtering; note that the
2037 * packet should be preserved in that case
2038 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
2040 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
2041 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
2042 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
2043 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
2044 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
2045 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
2047 enum wiphy_wowlan_support_flags
{
2048 WIPHY_WOWLAN_ANY
= BIT(0),
2049 WIPHY_WOWLAN_MAGIC_PKT
= BIT(1),
2050 WIPHY_WOWLAN_DISCONNECT
= BIT(2),
2051 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY
= BIT(3),
2052 WIPHY_WOWLAN_GTK_REKEY_FAILURE
= BIT(4),
2053 WIPHY_WOWLAN_EAP_IDENTITY_REQ
= BIT(5),
2054 WIPHY_WOWLAN_4WAY_HANDSHAKE
= BIT(6),
2055 WIPHY_WOWLAN_RFKILL_RELEASE
= BIT(7),
2059 * struct wiphy_wowlan_support - WoWLAN support data
2060 * @flags: see &enum wiphy_wowlan_support_flags
2061 * @n_patterns: number of supported wakeup patterns
2062 * (see nl80211.h for the pattern definition)
2063 * @pattern_max_len: maximum length of each pattern
2064 * @pattern_min_len: minimum length of each pattern
2066 struct wiphy_wowlan_support
{
2069 int pattern_max_len
;
2070 int pattern_min_len
;
2074 * struct wiphy - wireless hardware description
2075 * @reg_notifier: the driver's regulatory notification callback,
2076 * note that if your driver uses wiphy_apply_custom_regulatory()
2077 * the reg_notifier's request can be passed as NULL
2078 * @regd: the driver's regulatory domain, if one was requested via
2079 * the regulatory_hint() API. This can be used by the driver
2080 * on the reg_notifier() if it chooses to ignore future
2081 * regulatory domain changes caused by other drivers.
2082 * @signal_type: signal type reported in &struct cfg80211_bss.
2083 * @cipher_suites: supported cipher suites
2084 * @n_cipher_suites: number of supported cipher suites
2085 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
2086 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
2087 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
2088 * -1 = fragmentation disabled, only odd values >= 256 used
2089 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
2090 * @_net: the network namespace this wiphy currently lives in
2091 * @perm_addr: permanent MAC address of this device
2092 * @addr_mask: If the device supports multiple MAC addresses by masking,
2093 * set this to a mask with variable bits set to 1, e.g. if the last
2094 * four bits are variable then set it to 00:...:00:0f. The actual
2095 * variable bits shall be determined by the interfaces added, with
2096 * interfaces not matching the mask being rejected to be brought up.
2097 * @n_addresses: number of addresses in @addresses.
2098 * @addresses: If the device has more than one address, set this pointer
2099 * to a list of addresses (6 bytes each). The first one will be used
2100 * by default for perm_addr. In this case, the mask should be set to
2101 * all-zeroes. In this case it is assumed that the device can handle
2102 * the same number of arbitrary MAC addresses.
2103 * @registered: protects ->resume and ->suspend sysfs callbacks against
2104 * unregister hardware
2105 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
2106 * automatically on wiphy renames
2107 * @dev: (virtual) struct device for this wiphy
2108 * @registered: helps synchronize suspend/resume with wiphy unregister
2109 * @wext: wireless extension handlers
2110 * @priv: driver private data (sized according to wiphy_new() parameter)
2111 * @interface_modes: bitmask of interfaces types valid for this wiphy,
2112 * must be set by driver
2113 * @iface_combinations: Valid interface combinations array, should not
2114 * list single interface types.
2115 * @n_iface_combinations: number of entries in @iface_combinations array.
2116 * @software_iftypes: bitmask of software interface types, these are not
2117 * subject to any restrictions since they are purely managed in SW.
2118 * @flags: wiphy flags, see &enum wiphy_flags
2119 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
2120 * @bss_priv_size: each BSS struct has private data allocated with it,
2121 * this variable determines its size
2122 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
2124 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
2125 * for in any given scheduled scan
2126 * @max_match_sets: maximum number of match sets the device can handle
2127 * when performing a scheduled scan, 0 if filtering is not
2129 * @max_scan_ie_len: maximum length of user-controlled IEs device can
2130 * add to probe request frames transmitted during a scan, must not
2131 * include fixed IEs like supported rates
2132 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
2134 * @coverage_class: current coverage class
2135 * @fw_version: firmware version for ethtool reporting
2136 * @hw_version: hardware version for ethtool reporting
2137 * @max_num_pmkids: maximum number of PMKIDs supported by device
2138 * @privid: a pointer that drivers can use to identify if an arbitrary
2139 * wiphy is theirs, e.g. in global notifiers
2140 * @bands: information about bands/channels supported by this device
2142 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
2143 * transmitted through nl80211, points to an array indexed by interface
2146 * @available_antennas_tx: bitmap of antennas which are available to be
2147 * configured as TX antennas. Antenna configuration commands will be
2148 * rejected unless this or @available_antennas_rx is set.
2150 * @available_antennas_rx: bitmap of antennas which are available to be
2151 * configured as RX antennas. Antenna configuration commands will be
2152 * rejected unless this or @available_antennas_tx is set.
2154 * @probe_resp_offload:
2155 * Bitmap of supported protocols for probe response offloading.
2156 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2157 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2159 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2160 * may request, if implemented.
2162 * @wowlan: WoWLAN support information
2164 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2165 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2166 * If null, then none can be over-ridden.
2169 /* assign these fields before you register the wiphy */
2171 /* permanent MAC address(es) */
2172 u8 perm_addr
[ETH_ALEN
];
2173 u8 addr_mask
[ETH_ALEN
];
2175 struct mac_address
*addresses
;
2177 const struct ieee80211_txrx_stypes
*mgmt_stypes
;
2179 const struct ieee80211_iface_combination
*iface_combinations
;
2180 int n_iface_combinations
;
2181 u16 software_iftypes
;
2185 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2186 u16 interface_modes
;
2188 u32 flags
, features
;
2192 enum cfg80211_signal_type signal_type
;
2196 u8 max_sched_scan_ssids
;
2198 u16 max_scan_ie_len
;
2199 u16 max_sched_scan_ie_len
;
2201 int n_cipher_suites
;
2202 const u32
*cipher_suites
;
2210 char fw_version
[ETHTOOL_BUSINFO_LEN
];
2214 struct wiphy_wowlan_support wowlan
;
2217 u16 max_remain_on_channel_duration
;
2221 u32 available_antennas_tx
;
2222 u32 available_antennas_rx
;
2225 * Bitmap of supported protocols for probe response offloading
2226 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2227 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2229 u32 probe_resp_offload
;
2231 /* If multiple wiphys are registered and you're handed e.g.
2232 * a regular netdev with assigned ieee80211_ptr, you won't
2233 * know whether it points to a wiphy your driver has registered
2234 * or not. Assign this to something global to your driver to
2235 * help determine whether you own this wiphy or not. */
2238 struct ieee80211_supported_band
*bands
[IEEE80211_NUM_BANDS
];
2240 /* Lets us get back the wiphy on the callback */
2241 int (*reg_notifier
)(struct wiphy
*wiphy
,
2242 struct regulatory_request
*request
);
2244 /* fields below are read-only, assigned by cfg80211 */
2246 const struct ieee80211_regdomain
*regd
;
2248 /* the item in /sys/class/ieee80211/ points to this,
2249 * you need use set_wiphy_dev() (see below) */
2252 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2255 /* dir in debugfs: ieee80211/<wiphyname> */
2256 struct dentry
*debugfsdir
;
2258 const struct ieee80211_ht_cap
*ht_capa_mod_mask
;
2260 #ifdef CONFIG_NET_NS
2261 /* the network namespace this phy lives in currently */
2265 #ifdef CONFIG_CFG80211_WEXT
2266 const struct iw_handler_def
*wext
;
2269 char priv
[0] __attribute__((__aligned__(NETDEV_ALIGN
)));
2272 static inline struct net
*wiphy_net(struct wiphy
*wiphy
)
2274 return read_pnet(&wiphy
->_net
);
2277 static inline void wiphy_net_set(struct wiphy
*wiphy
, struct net
*net
)
2279 write_pnet(&wiphy
->_net
, net
);
2283 * wiphy_priv - return priv from wiphy
2285 * @wiphy: the wiphy whose priv pointer to return
2287 static inline void *wiphy_priv(struct wiphy
*wiphy
)
2290 return &wiphy
->priv
;
2294 * priv_to_wiphy - return the wiphy containing the priv
2296 * @priv: a pointer previously returned by wiphy_priv
2298 static inline struct wiphy
*priv_to_wiphy(void *priv
)
2301 return container_of(priv
, struct wiphy
, priv
);
2305 * set_wiphy_dev - set device pointer for wiphy
2307 * @wiphy: The wiphy whose device to bind
2308 * @dev: The device to parent it to
2310 static inline void set_wiphy_dev(struct wiphy
*wiphy
, struct device
*dev
)
2312 wiphy
->dev
.parent
= dev
;
2316 * wiphy_dev - get wiphy dev pointer
2318 * @wiphy: The wiphy whose device struct to look up
2320 static inline struct device
*wiphy_dev(struct wiphy
*wiphy
)
2322 return wiphy
->dev
.parent
;
2326 * wiphy_name - get wiphy name
2328 * @wiphy: The wiphy whose name to return
2330 static inline const char *wiphy_name(const struct wiphy
*wiphy
)
2332 return dev_name(&wiphy
->dev
);
2336 * wiphy_new - create a new wiphy for use with cfg80211
2338 * @ops: The configuration operations for this device
2339 * @sizeof_priv: The size of the private area to allocate
2341 * Create a new wiphy and associate the given operations with it.
2342 * @sizeof_priv bytes are allocated for private use.
2344 * The returned pointer must be assigned to each netdev's
2345 * ieee80211_ptr for proper operation.
2347 struct wiphy
*wiphy_new(const struct cfg80211_ops
*ops
, int sizeof_priv
);
2350 * wiphy_register - register a wiphy with cfg80211
2352 * @wiphy: The wiphy to register.
2354 * Returns a non-negative wiphy index or a negative error code.
2356 extern int wiphy_register(struct wiphy
*wiphy
);
2359 * wiphy_unregister - deregister a wiphy from cfg80211
2361 * @wiphy: The wiphy to unregister.
2363 * After this call, no more requests can be made with this priv
2364 * pointer, but the call may sleep to wait for an outstanding
2365 * request that is being handled.
2367 extern void wiphy_unregister(struct wiphy
*wiphy
);
2370 * wiphy_free - free wiphy
2372 * @wiphy: The wiphy to free
2374 extern void wiphy_free(struct wiphy
*wiphy
);
2376 /* internal structs */
2377 struct cfg80211_conn
;
2378 struct cfg80211_internal_bss
;
2379 struct cfg80211_cached_keys
;
2382 * struct wireless_dev - wireless device state
2384 * For netdevs, this structure must be allocated by the driver
2385 * that uses the ieee80211_ptr field in struct net_device (this
2386 * is intentional so it can be allocated along with the netdev.)
2387 * It need not be registered then as netdev registration will
2388 * be intercepted by cfg80211 to see the new wireless device.
2390 * For non-netdev uses, it must also be allocated by the driver
2391 * in response to the cfg80211 callbacks that require it, as
2392 * there's no netdev registration in that case it may not be
2393 * allocated outside of callback operations that return it.
2395 * @wiphy: pointer to hardware description
2396 * @iftype: interface type
2397 * @list: (private) Used to collect the interfaces
2398 * @netdev: (private) Used to reference back to the netdev, may be %NULL
2399 * @identifier: (private) Identifier used in nl80211 to identify this
2400 * wireless device if it has no netdev
2401 * @current_bss: (private) Used by the internal configuration code
2402 * @channel: (private) Used by the internal configuration code to track
2403 * the user-set AP, monitor and WDS channel
2404 * @preset_chan: (private) Used by the internal configuration code to
2405 * track the channel to be used for AP later
2406 * @preset_chantype: (private) the corresponding channel type
2407 * @bssid: (private) Used by the internal configuration code
2408 * @ssid: (private) Used by the internal configuration code
2409 * @ssid_len: (private) Used by the internal configuration code
2410 * @mesh_id_len: (private) Used by the internal configuration code
2411 * @mesh_id_up_len: (private) Used by the internal configuration code
2412 * @wext: (private) Used by the internal wireless extensions compat code
2413 * @use_4addr: indicates 4addr mode is used on this interface, must be
2414 * set by driver (if supported) on add_interface BEFORE registering the
2415 * netdev and may otherwise be used by driver read-only, will be update
2416 * by cfg80211 on change_interface
2417 * @mgmt_registrations: list of registrations for management frames
2418 * @mgmt_registrations_lock: lock for the list
2419 * @mtx: mutex used to lock data in this struct
2420 * @cleanup_work: work struct used for cleanup that can't be done directly
2421 * @beacon_interval: beacon interval used on this device for transmitting
2422 * beacons, 0 when not valid
2423 * @address: The address for this device, valid only if @netdev is %NULL
2424 * @p2p_started: true if this is a P2P Device that has been started
2426 struct wireless_dev
{
2427 struct wiphy
*wiphy
;
2428 enum nl80211_iftype iftype
;
2430 /* the remainder of this struct should be private to cfg80211 */
2431 struct list_head list
;
2432 struct net_device
*netdev
;
2436 struct list_head mgmt_registrations
;
2437 spinlock_t mgmt_registrations_lock
;
2441 struct work_struct cleanup_work
;
2443 bool use_4addr
, p2p_started
;
2445 u8 address
[ETH_ALEN
] __aligned(sizeof(u16
));
2447 /* currently used for IBSS and SME - might be rearranged later */
2448 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
2449 u8 ssid_len
, mesh_id_len
, mesh_id_up_len
;
2452 CFG80211_SME_CONNECTING
,
2453 CFG80211_SME_CONNECTED
,
2455 struct cfg80211_conn
*conn
;
2456 struct cfg80211_cached_keys
*connect_keys
;
2458 struct list_head event_list
;
2459 spinlock_t event_lock
;
2461 struct cfg80211_internal_bss
*current_bss
; /* associated / joined */
2462 struct ieee80211_channel
*preset_chan
;
2463 enum nl80211_channel_type preset_chantype
;
2465 /* for AP and mesh channel tracking */
2466 struct ieee80211_channel
*channel
;
2473 int beacon_interval
;
2475 u32 ap_unexpected_nlportid
;
2477 #ifdef CONFIG_CFG80211_WEXT
2480 struct cfg80211_ibss_params ibss
;
2481 struct cfg80211_connect_params connect
;
2482 struct cfg80211_cached_keys
*keys
;
2485 u8 bssid
[ETH_ALEN
], prev_bssid
[ETH_ALEN
];
2486 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
2487 s8 default_key
, default_mgmt_key
;
2488 bool prev_bssid_valid
;
2493 static inline u8
*wdev_address(struct wireless_dev
*wdev
)
2496 return wdev
->netdev
->dev_addr
;
2497 return wdev
->address
;
2501 * wdev_priv - return wiphy priv from wireless_dev
2503 * @wdev: The wireless device whose wiphy's priv pointer to return
2505 static inline void *wdev_priv(struct wireless_dev
*wdev
)
2508 return wiphy_priv(wdev
->wiphy
);
2512 * DOC: Utility functions
2514 * cfg80211 offers a number of utility functions that can be useful.
2518 * ieee80211_channel_to_frequency - convert channel number to frequency
2519 * @chan: channel number
2520 * @band: band, necessary due to channel number overlap
2522 extern int ieee80211_channel_to_frequency(int chan
, enum ieee80211_band band
);
2525 * ieee80211_frequency_to_channel - convert frequency to channel number
2526 * @freq: center frequency
2528 extern int ieee80211_frequency_to_channel(int freq
);
2531 * Name indirection necessary because the ieee80211 code also has
2532 * a function named "ieee80211_get_channel", so if you include
2533 * cfg80211's header file you get cfg80211's version, if you try
2534 * to include both header files you'll (rightfully!) get a symbol
2537 extern struct ieee80211_channel
*__ieee80211_get_channel(struct wiphy
*wiphy
,
2540 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2541 * @wiphy: the struct wiphy to get the channel for
2542 * @freq: the center frequency of the channel
2544 static inline struct ieee80211_channel
*
2545 ieee80211_get_channel(struct wiphy
*wiphy
, int freq
)
2547 return __ieee80211_get_channel(wiphy
, freq
);
2551 * ieee80211_get_response_rate - get basic rate for a given rate
2553 * @sband: the band to look for rates in
2554 * @basic_rates: bitmap of basic rates
2555 * @bitrate: the bitrate for which to find the basic rate
2557 * This function returns the basic rate corresponding to a given
2558 * bitrate, that is the next lower bitrate contained in the basic
2559 * rate map, which is, for this function, given as a bitmap of
2560 * indices of rates in the band's bitrate table.
2562 struct ieee80211_rate
*
2563 ieee80211_get_response_rate(struct ieee80211_supported_band
*sband
,
2564 u32 basic_rates
, int bitrate
);
2567 * Radiotap parsing functions -- for controlled injection support
2569 * Implemented in net/wireless/radiotap.c
2570 * Documentation in Documentation/networking/radiotap-headers.txt
2573 struct radiotap_align_size
{
2574 uint8_t align
:4, size
:4;
2577 struct ieee80211_radiotap_namespace
{
2578 const struct radiotap_align_size
*align_size
;
2584 struct ieee80211_radiotap_vendor_namespaces
{
2585 const struct ieee80211_radiotap_namespace
*ns
;
2590 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2591 * @this_arg_index: index of current arg, valid after each successful call
2592 * to ieee80211_radiotap_iterator_next()
2593 * @this_arg: pointer to current radiotap arg; it is valid after each
2594 * call to ieee80211_radiotap_iterator_next() but also after
2595 * ieee80211_radiotap_iterator_init() where it will point to
2596 * the beginning of the actual data portion
2597 * @this_arg_size: length of the current arg, for convenience
2598 * @current_namespace: pointer to the current namespace definition
2599 * (or internally %NULL if the current namespace is unknown)
2600 * @is_radiotap_ns: indicates whether the current namespace is the default
2601 * radiotap namespace or not
2603 * @_rtheader: pointer to the radiotap header we are walking through
2604 * @_max_length: length of radiotap header in cpu byte ordering
2605 * @_arg_index: next argument index
2606 * @_arg: next argument pointer
2607 * @_next_bitmap: internal pointer to next present u32
2608 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2609 * @_vns: vendor namespace definitions
2610 * @_next_ns_data: beginning of the next namespace's data
2611 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2614 * Describes the radiotap parser state. Fields prefixed with an underscore
2615 * must not be used by users of the parser, only by the parser internally.
2618 struct ieee80211_radiotap_iterator
{
2619 struct ieee80211_radiotap_header
*_rtheader
;
2620 const struct ieee80211_radiotap_vendor_namespaces
*_vns
;
2621 const struct ieee80211_radiotap_namespace
*current_namespace
;
2623 unsigned char *_arg
, *_next_ns_data
;
2624 __le32
*_next_bitmap
;
2626 unsigned char *this_arg
;
2634 uint32_t _bitmap_shifter
;
2638 extern int ieee80211_radiotap_iterator_init(
2639 struct ieee80211_radiotap_iterator
*iterator
,
2640 struct ieee80211_radiotap_header
*radiotap_header
,
2641 int max_length
, const struct ieee80211_radiotap_vendor_namespaces
*vns
);
2643 extern int ieee80211_radiotap_iterator_next(
2644 struct ieee80211_radiotap_iterator
*iterator
);
2647 extern const unsigned char rfc1042_header
[6];
2648 extern const unsigned char bridge_tunnel_header
[6];
2651 * ieee80211_get_hdrlen_from_skb - get header length from data
2653 * Given an skb with a raw 802.11 header at the data pointer this function
2654 * returns the 802.11 header length in bytes (not including encryption
2655 * headers). If the data in the sk_buff is too short to contain a valid 802.11
2656 * header the function returns 0.
2660 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff
*skb
);
2663 * ieee80211_hdrlen - get header length in bytes from frame control
2664 * @fc: frame control field in little-endian format
2666 unsigned int __attribute_const__
ieee80211_hdrlen(__le16 fc
);
2669 * DOC: Data path helpers
2671 * In addition to generic utilities, cfg80211 also offers
2672 * functions that help implement the data path for devices
2673 * that do not do the 802.11/802.3 conversion on the device.
2677 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2678 * @skb: the 802.11 data frame
2679 * @addr: the device MAC address
2680 * @iftype: the virtual interface type
2682 int ieee80211_data_to_8023(struct sk_buff
*skb
, const u8
*addr
,
2683 enum nl80211_iftype iftype
);
2686 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2687 * @skb: the 802.3 frame
2688 * @addr: the device MAC address
2689 * @iftype: the virtual interface type
2690 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2691 * @qos: build 802.11 QoS data frame
2693 int ieee80211_data_from_8023(struct sk_buff
*skb
, const u8
*addr
,
2694 enum nl80211_iftype iftype
, u8
*bssid
, bool qos
);
2697 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2699 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2700 * 802.3 frames. The @list will be empty if the decode fails. The
2701 * @skb is consumed after the function returns.
2703 * @skb: The input IEEE 802.11n A-MSDU frame.
2704 * @list: The output list of 802.3 frames. It must be allocated and
2705 * initialized by by the caller.
2706 * @addr: The device MAC address.
2707 * @iftype: The device interface type.
2708 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2709 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2711 void ieee80211_amsdu_to_8023s(struct sk_buff
*skb
, struct sk_buff_head
*list
,
2712 const u8
*addr
, enum nl80211_iftype iftype
,
2713 const unsigned int extra_headroom
,
2714 bool has_80211_header
);
2717 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2718 * @skb: the data frame
2720 unsigned int cfg80211_classify8021d(struct sk_buff
*skb
);
2723 * cfg80211_find_ie - find information element in data
2726 * @ies: data consisting of IEs
2727 * @len: length of data
2729 * This function will return %NULL if the element ID could
2730 * not be found or if the element is invalid (claims to be
2731 * longer than the given data), or a pointer to the first byte
2732 * of the requested element, that is the byte containing the
2733 * element ID. There are no checks on the element length
2734 * other than having to fit into the given data.
2736 const u8
*cfg80211_find_ie(u8 eid
, const u8
*ies
, int len
);
2739 * cfg80211_find_vendor_ie - find vendor specific information element in data
2742 * @oui_type: vendor-specific OUI type
2743 * @ies: data consisting of IEs
2744 * @len: length of data
2746 * This function will return %NULL if the vendor specific element ID
2747 * could not be found or if the element is invalid (claims to be
2748 * longer than the given data), or a pointer to the first byte
2749 * of the requested element, that is the byte containing the
2750 * element ID. There are no checks on the element length
2751 * other than having to fit into the given data.
2753 const u8
*cfg80211_find_vendor_ie(unsigned int oui
, u8 oui_type
,
2754 const u8
*ies
, int len
);
2757 * DOC: Regulatory enforcement infrastructure
2763 * regulatory_hint - driver hint to the wireless core a regulatory domain
2764 * @wiphy: the wireless device giving the hint (used only for reporting
2766 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2767 * should be in. If @rd is set this should be NULL. Note that if you
2768 * set this to NULL you should still set rd->alpha2 to some accepted
2771 * Wireless drivers can use this function to hint to the wireless core
2772 * what it believes should be the current regulatory domain by
2773 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2774 * domain should be in or by providing a completely build regulatory domain.
2775 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2776 * for a regulatory domain structure for the respective country.
2778 * The wiphy must have been registered to cfg80211 prior to this call.
2779 * For cfg80211 drivers this means you must first use wiphy_register(),
2780 * for mac80211 drivers you must first use ieee80211_register_hw().
2782 * Drivers should check the return value, its possible you can get
2785 extern int regulatory_hint(struct wiphy
*wiphy
, const char *alpha2
);
2788 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2789 * @wiphy: the wireless device we want to process the regulatory domain on
2790 * @regd: the custom regulatory domain to use for this wiphy
2792 * Drivers can sometimes have custom regulatory domains which do not apply
2793 * to a specific country. Drivers can use this to apply such custom regulatory
2794 * domains. This routine must be called prior to wiphy registration. The
2795 * custom regulatory domain will be trusted completely and as such previous
2796 * default channel settings will be disregarded. If no rule is found for a
2797 * channel on the regulatory domain the channel will be disabled.
2799 extern void wiphy_apply_custom_regulatory(
2800 struct wiphy
*wiphy
,
2801 const struct ieee80211_regdomain
*regd
);
2804 * freq_reg_info - get regulatory information for the given frequency
2805 * @wiphy: the wiphy for which we want to process this rule for
2806 * @center_freq: Frequency in KHz for which we want regulatory information for
2807 * @desired_bw_khz: the desired max bandwidth you want to use per
2808 * channel. Note that this is still 20 MHz if you want to use HT40
2809 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2810 * If set to 0 we'll assume you want the standard 20 MHz.
2811 * @reg_rule: the regulatory rule which we have for this frequency
2813 * Use this function to get the regulatory rule for a specific frequency on
2814 * a given wireless device. If the device has a specific regulatory domain
2815 * it wants to follow we respect that unless a country IE has been received
2816 * and processed already.
2818 * Returns 0 if it was able to find a valid regulatory rule which does
2819 * apply to the given center_freq otherwise it returns non-zero. It will
2820 * also return -ERANGE if we determine the given center_freq does not even have
2821 * a regulatory rule for a frequency range in the center_freq's band. See
2822 * freq_in_rule_band() for our current definition of a band -- this is purely
2823 * subjective and right now its 802.11 specific.
2825 extern int freq_reg_info(struct wiphy
*wiphy
,
2828 const struct ieee80211_reg_rule
**reg_rule
);
2831 * callbacks for asynchronous cfg80211 methods, notification
2832 * functions and BSS handling helpers
2836 * cfg80211_scan_done - notify that scan finished
2838 * @request: the corresponding scan request
2839 * @aborted: set to true if the scan was aborted for any reason,
2840 * userspace will be notified of that
2842 void cfg80211_scan_done(struct cfg80211_scan_request
*request
, bool aborted
);
2845 * cfg80211_sched_scan_results - notify that new scan results are available
2847 * @wiphy: the wiphy which got scheduled scan results
2849 void cfg80211_sched_scan_results(struct wiphy
*wiphy
);
2852 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
2854 * @wiphy: the wiphy on which the scheduled scan stopped
2856 * The driver can call this function to inform cfg80211 that the
2857 * scheduled scan had to be stopped, for whatever reason. The driver
2858 * is then called back via the sched_scan_stop operation when done.
2860 void cfg80211_sched_scan_stopped(struct wiphy
*wiphy
);
2863 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2865 * @wiphy: the wiphy reporting the BSS
2866 * @channel: The channel the frame was received on
2867 * @mgmt: the management frame (probe response or beacon)
2868 * @len: length of the management frame
2869 * @signal: the signal strength, type depends on the wiphy's signal_type
2870 * @gfp: context flags
2872 * This informs cfg80211 that BSS information was found and
2873 * the BSS should be updated/added.
2875 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2877 struct cfg80211_bss
* __must_check
2878 cfg80211_inform_bss_frame(struct wiphy
*wiphy
,
2879 struct ieee80211_channel
*channel
,
2880 struct ieee80211_mgmt
*mgmt
, size_t len
,
2881 s32 signal
, gfp_t gfp
);
2884 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2886 * @wiphy: the wiphy reporting the BSS
2887 * @channel: The channel the frame was received on
2888 * @bssid: the BSSID of the BSS
2889 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
2890 * @capability: the capability field sent by the peer
2891 * @beacon_interval: the beacon interval announced by the peer
2892 * @ie: additional IEs sent by the peer
2893 * @ielen: length of the additional IEs
2894 * @signal: the signal strength, type depends on the wiphy's signal_type
2895 * @gfp: context flags
2897 * This informs cfg80211 that BSS information was found and
2898 * the BSS should be updated/added.
2900 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2902 struct cfg80211_bss
* __must_check
2903 cfg80211_inform_bss(struct wiphy
*wiphy
,
2904 struct ieee80211_channel
*channel
,
2905 const u8
*bssid
, u64 tsf
, u16 capability
,
2906 u16 beacon_interval
, const u8
*ie
, size_t ielen
,
2907 s32 signal
, gfp_t gfp
);
2909 struct cfg80211_bss
*cfg80211_get_bss(struct wiphy
*wiphy
,
2910 struct ieee80211_channel
*channel
,
2912 const u8
*ssid
, size_t ssid_len
,
2913 u16 capa_mask
, u16 capa_val
);
2914 static inline struct cfg80211_bss
*
2915 cfg80211_get_ibss(struct wiphy
*wiphy
,
2916 struct ieee80211_channel
*channel
,
2917 const u8
*ssid
, size_t ssid_len
)
2919 return cfg80211_get_bss(wiphy
, channel
, NULL
, ssid
, ssid_len
,
2920 WLAN_CAPABILITY_IBSS
, WLAN_CAPABILITY_IBSS
);
2923 struct cfg80211_bss
*cfg80211_get_mesh(struct wiphy
*wiphy
,
2924 struct ieee80211_channel
*channel
,
2925 const u8
*meshid
, size_t meshidlen
,
2928 * cfg80211_ref_bss - reference BSS struct
2929 * @bss: the BSS struct to reference
2931 * Increments the refcount of the given BSS struct.
2933 void cfg80211_ref_bss(struct cfg80211_bss
*bss
);
2936 * cfg80211_put_bss - unref BSS struct
2937 * @bss: the BSS struct
2939 * Decrements the refcount of the given BSS struct.
2941 void cfg80211_put_bss(struct cfg80211_bss
*bss
);
2944 * cfg80211_unlink_bss - unlink BSS from internal data structures
2946 * @bss: the bss to remove
2948 * This function removes the given BSS from the internal data structures
2949 * thereby making it no longer show up in scan results etc. Use this
2950 * function when you detect a BSS is gone. Normally BSSes will also time
2951 * out, so it is not necessary to use this function at all.
2953 void cfg80211_unlink_bss(struct wiphy
*wiphy
, struct cfg80211_bss
*bss
);
2956 * cfg80211_send_rx_auth - notification of processed authentication
2957 * @dev: network device
2958 * @buf: authentication frame (header + body)
2959 * @len: length of the frame data
2961 * This function is called whenever an authentication has been processed in
2962 * station mode. The driver is required to call either this function or
2963 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2964 * call. This function may sleep.
2966 void cfg80211_send_rx_auth(struct net_device
*dev
, const u8
*buf
, size_t len
);
2969 * cfg80211_send_auth_timeout - notification of timed out authentication
2970 * @dev: network device
2971 * @addr: The MAC address of the device with which the authentication timed out
2973 * This function may sleep.
2975 void cfg80211_send_auth_timeout(struct net_device
*dev
, const u8
*addr
);
2978 * cfg80211_send_rx_assoc - notification of processed association
2979 * @dev: network device
2980 * @bss: the BSS struct association was requested for, the struct reference
2981 * is owned by cfg80211 after this call
2982 * @buf: (re)association response frame (header + body)
2983 * @len: length of the frame data
2985 * This function is called whenever a (re)association response has been
2986 * processed in station mode. The driver is required to call either this
2987 * function or cfg80211_send_assoc_timeout() to indicate the result of
2988 * cfg80211_ops::assoc() call. This function may sleep.
2990 void cfg80211_send_rx_assoc(struct net_device
*dev
, struct cfg80211_bss
*bss
,
2991 const u8
*buf
, size_t len
);
2994 * cfg80211_send_assoc_timeout - notification of timed out association
2995 * @dev: network device
2996 * @addr: The MAC address of the device with which the association timed out
2998 * This function may sleep.
3000 void cfg80211_send_assoc_timeout(struct net_device
*dev
, const u8
*addr
);
3003 * cfg80211_send_deauth - notification of processed deauthentication
3004 * @dev: network device
3005 * @buf: deauthentication frame (header + body)
3006 * @len: length of the frame data
3008 * This function is called whenever deauthentication has been processed in
3009 * station mode. This includes both received deauthentication frames and
3010 * locally generated ones. This function may sleep.
3012 void cfg80211_send_deauth(struct net_device
*dev
, const u8
*buf
, size_t len
);
3015 * __cfg80211_send_deauth - notification of processed deauthentication
3016 * @dev: network device
3017 * @buf: deauthentication frame (header + body)
3018 * @len: length of the frame data
3020 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
3022 void __cfg80211_send_deauth(struct net_device
*dev
, const u8
*buf
, size_t len
);
3025 * cfg80211_send_disassoc - notification of processed disassociation
3026 * @dev: network device
3027 * @buf: disassociation response frame (header + body)
3028 * @len: length of the frame data
3030 * This function is called whenever disassociation has been processed in
3031 * station mode. This includes both received disassociation frames and locally
3032 * generated ones. This function may sleep.
3034 void cfg80211_send_disassoc(struct net_device
*dev
, const u8
*buf
, size_t len
);
3037 * __cfg80211_send_disassoc - notification of processed disassociation
3038 * @dev: network device
3039 * @buf: disassociation response frame (header + body)
3040 * @len: length of the frame data
3042 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
3044 void __cfg80211_send_disassoc(struct net_device
*dev
, const u8
*buf
,
3048 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
3049 * @dev: network device
3050 * @buf: deauthentication frame (header + body)
3051 * @len: length of the frame data
3053 * This function is called whenever a received Deauthentication frame has been
3054 * dropped in station mode because of MFP being used but the Deauthentication
3055 * frame was not protected. This function may sleep.
3057 void cfg80211_send_unprot_deauth(struct net_device
*dev
, const u8
*buf
,
3061 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
3062 * @dev: network device
3063 * @buf: disassociation frame (header + body)
3064 * @len: length of the frame data
3066 * This function is called whenever a received Disassociation frame has been
3067 * dropped in station mode because of MFP being used but the Disassociation
3068 * frame was not protected. This function may sleep.
3070 void cfg80211_send_unprot_disassoc(struct net_device
*dev
, const u8
*buf
,
3074 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
3075 * @dev: network device
3076 * @addr: The source MAC address of the frame
3077 * @key_type: The key type that the received frame used
3078 * @key_id: Key identifier (0..3). Can be -1 if missing.
3079 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
3080 * @gfp: allocation flags
3082 * This function is called whenever the local MAC detects a MIC failure in a
3083 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
3086 void cfg80211_michael_mic_failure(struct net_device
*dev
, const u8
*addr
,
3087 enum nl80211_key_type key_type
, int key_id
,
3088 const u8
*tsc
, gfp_t gfp
);
3091 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
3093 * @dev: network device
3094 * @bssid: the BSSID of the IBSS joined
3095 * @gfp: allocation flags
3097 * This function notifies cfg80211 that the device joined an IBSS or
3098 * switched to a different BSSID. Before this function can be called,
3099 * either a beacon has to have been received from the IBSS, or one of
3100 * the cfg80211_inform_bss{,_frame} functions must have been called
3101 * with the locally generated beacon -- this guarantees that there is
3102 * always a scan result for this IBSS. cfg80211 will handle the rest.
3104 void cfg80211_ibss_joined(struct net_device
*dev
, const u8
*bssid
, gfp_t gfp
);
3107 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
3109 * @dev: network device
3110 * @macaddr: the MAC address of the new candidate
3111 * @ie: information elements advertised by the peer candidate
3112 * @ie_len: lenght of the information elements buffer
3113 * @gfp: allocation flags
3115 * This function notifies cfg80211 that the mesh peer candidate has been
3116 * detected, most likely via a beacon or, less likely, via a probe response.
3117 * cfg80211 then sends a notification to userspace.
3119 void cfg80211_notify_new_peer_candidate(struct net_device
*dev
,
3120 const u8
*macaddr
, const u8
*ie
, u8 ie_len
, gfp_t gfp
);
3123 * DOC: RFkill integration
3125 * RFkill integration in cfg80211 is almost invisible to drivers,
3126 * as cfg80211 automatically registers an rfkill instance for each
3127 * wireless device it knows about. Soft kill is also translated
3128 * into disconnecting and turning all interfaces off, drivers are
3129 * expected to turn off the device when all interfaces are down.
3131 * However, devices may have a hard RFkill line, in which case they
3132 * also need to interact with the rfkill subsystem, via cfg80211.
3133 * They can do this with a few helper functions documented here.
3137 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
3139 * @blocked: block status
3141 void wiphy_rfkill_set_hw_state(struct wiphy
*wiphy
, bool blocked
);
3144 * wiphy_rfkill_start_polling - start polling rfkill
3147 void wiphy_rfkill_start_polling(struct wiphy
*wiphy
);
3150 * wiphy_rfkill_stop_polling - stop polling rfkill
3153 void wiphy_rfkill_stop_polling(struct wiphy
*wiphy
);
3155 #ifdef CONFIG_NL80211_TESTMODE
3159 * Test mode is a set of utility functions to allow drivers to
3160 * interact with driver-specific tools to aid, for instance,
3161 * factory programming.
3163 * This chapter describes how drivers interact with it, for more
3164 * information see the nl80211 book's chapter on it.
3168 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
3170 * @approxlen: an upper bound of the length of the data that will
3171 * be put into the skb
3173 * This function allocates and pre-fills an skb for a reply to
3174 * the testmode command. Since it is intended for a reply, calling
3175 * it outside of the @testmode_cmd operation is invalid.
3177 * The returned skb (or %NULL if any errors happen) is pre-filled
3178 * with the wiphy index and set up in a way that any data that is
3179 * put into the skb (with skb_put(), nla_put() or similar) will end
3180 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
3181 * needs to be done with the skb is adding data for the corresponding
3182 * userspace tool which can then read that data out of the testdata
3183 * attribute. You must not modify the skb in any other way.
3185 * When done, call cfg80211_testmode_reply() with the skb and return
3186 * its error code as the result of the @testmode_cmd operation.
3188 struct sk_buff
*cfg80211_testmode_alloc_reply_skb(struct wiphy
*wiphy
,
3192 * cfg80211_testmode_reply - send the reply skb
3193 * @skb: The skb, must have been allocated with
3194 * cfg80211_testmode_alloc_reply_skb()
3196 * Returns an error code or 0 on success, since calling this
3197 * function will usually be the last thing before returning
3198 * from the @testmode_cmd you should return the error code.
3199 * Note that this function consumes the skb regardless of the
3202 int cfg80211_testmode_reply(struct sk_buff
*skb
);
3205 * cfg80211_testmode_alloc_event_skb - allocate testmode event
3207 * @approxlen: an upper bound of the length of the data that will
3208 * be put into the skb
3209 * @gfp: allocation flags
3211 * This function allocates and pre-fills an skb for an event on the
3212 * testmode multicast group.
3214 * The returned skb (or %NULL if any errors happen) is set up in the
3215 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
3216 * for an event. As there, you should simply add data to it that will
3217 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
3218 * not modify the skb in any other way.
3220 * When done filling the skb, call cfg80211_testmode_event() with the
3221 * skb to send the event.
3223 struct sk_buff
*cfg80211_testmode_alloc_event_skb(struct wiphy
*wiphy
,
3224 int approxlen
, gfp_t gfp
);
3227 * cfg80211_testmode_event - send the event
3228 * @skb: The skb, must have been allocated with
3229 * cfg80211_testmode_alloc_event_skb()
3230 * @gfp: allocation flags
3232 * This function sends the given @skb, which must have been allocated
3233 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3236 void cfg80211_testmode_event(struct sk_buff
*skb
, gfp_t gfp
);
3238 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3239 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3241 #define CFG80211_TESTMODE_CMD(cmd)
3242 #define CFG80211_TESTMODE_DUMP(cmd)
3246 * cfg80211_connect_result - notify cfg80211 of connection result
3248 * @dev: network device
3249 * @bssid: the BSSID of the AP
3250 * @req_ie: association request IEs (maybe be %NULL)
3251 * @req_ie_len: association request IEs length
3252 * @resp_ie: association response IEs (may be %NULL)
3253 * @resp_ie_len: assoc response IEs length
3254 * @status: status code, 0 for successful connection, use
3255 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3256 * the real status code for failures.
3257 * @gfp: allocation flags
3259 * It should be called by the underlying driver whenever connect() has
3262 void cfg80211_connect_result(struct net_device
*dev
, const u8
*bssid
,
3263 const u8
*req_ie
, size_t req_ie_len
,
3264 const u8
*resp_ie
, size_t resp_ie_len
,
3265 u16 status
, gfp_t gfp
);
3268 * cfg80211_roamed - notify cfg80211 of roaming
3270 * @dev: network device
3271 * @channel: the channel of the new AP
3272 * @bssid: the BSSID of the new AP
3273 * @req_ie: association request IEs (maybe be %NULL)
3274 * @req_ie_len: association request IEs length
3275 * @resp_ie: association response IEs (may be %NULL)
3276 * @resp_ie_len: assoc response IEs length
3277 * @gfp: allocation flags
3279 * It should be called by the underlying driver whenever it roamed
3280 * from one AP to another while connected.
3282 void cfg80211_roamed(struct net_device
*dev
,
3283 struct ieee80211_channel
*channel
,
3285 const u8
*req_ie
, size_t req_ie_len
,
3286 const u8
*resp_ie
, size_t resp_ie_len
, gfp_t gfp
);
3289 * cfg80211_roamed_bss - notify cfg80211 of roaming
3291 * @dev: network device
3292 * @bss: entry of bss to which STA got roamed
3293 * @req_ie: association request IEs (maybe be %NULL)
3294 * @req_ie_len: association request IEs length
3295 * @resp_ie: association response IEs (may be %NULL)
3296 * @resp_ie_len: assoc response IEs length
3297 * @gfp: allocation flags
3299 * This is just a wrapper to notify cfg80211 of roaming event with driver
3300 * passing bss to avoid a race in timeout of the bss entry. It should be
3301 * called by the underlying driver whenever it roamed from one AP to another
3302 * while connected. Drivers which have roaming implemented in firmware
3303 * may use this function to avoid a race in bss entry timeout where the bss
3304 * entry of the new AP is seen in the driver, but gets timed out by the time
3305 * it is accessed in __cfg80211_roamed() due to delay in scheduling
3306 * rdev->event_work. In case of any failures, the reference is released
3307 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3308 * it will be released while diconneting from the current bss.
3310 void cfg80211_roamed_bss(struct net_device
*dev
, struct cfg80211_bss
*bss
,
3311 const u8
*req_ie
, size_t req_ie_len
,
3312 const u8
*resp_ie
, size_t resp_ie_len
, gfp_t gfp
);
3315 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3317 * @dev: network device
3318 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3319 * @ie_len: length of IEs
3320 * @reason: reason code for the disconnection, set it to 0 if unknown
3321 * @gfp: allocation flags
3323 * After it calls this function, the driver should enter an idle state
3324 * and not try to connect to any AP any more.
3326 void cfg80211_disconnected(struct net_device
*dev
, u16 reason
,
3327 u8
*ie
, size_t ie_len
, gfp_t gfp
);
3330 * cfg80211_ready_on_channel - notification of remain_on_channel start
3331 * @wdev: wireless device
3332 * @cookie: the request cookie
3333 * @chan: The current channel (from remain_on_channel request)
3334 * @channel_type: Channel type
3335 * @duration: Duration in milliseconds that the driver intents to remain on the
3337 * @gfp: allocation flags
3339 void cfg80211_ready_on_channel(struct wireless_dev
*wdev
, u64 cookie
,
3340 struct ieee80211_channel
*chan
,
3341 enum nl80211_channel_type channel_type
,
3342 unsigned int duration
, gfp_t gfp
);
3345 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3346 * @wdev: wireless device
3347 * @cookie: the request cookie
3348 * @chan: The current channel (from remain_on_channel request)
3349 * @channel_type: Channel type
3350 * @gfp: allocation flags
3352 void cfg80211_remain_on_channel_expired(struct wireless_dev
*wdev
, u64 cookie
,
3353 struct ieee80211_channel
*chan
,
3354 enum nl80211_channel_type channel_type
,
3359 * cfg80211_new_sta - notify userspace about station
3362 * @mac_addr: the station's address
3363 * @sinfo: the station information
3364 * @gfp: allocation flags
3366 void cfg80211_new_sta(struct net_device
*dev
, const u8
*mac_addr
,
3367 struct station_info
*sinfo
, gfp_t gfp
);
3370 * cfg80211_del_sta - notify userspace about deletion of a station
3373 * @mac_addr: the station's address
3374 * @gfp: allocation flags
3376 void cfg80211_del_sta(struct net_device
*dev
, const u8
*mac_addr
, gfp_t gfp
);
3379 * cfg80211_conn_failed - connection request failed notification
3382 * @mac_addr: the station's address
3383 * @reason: the reason for connection failure
3384 * @gfp: allocation flags
3386 * Whenever a station tries to connect to an AP and if the station
3387 * could not connect to the AP as the AP has rejected the connection
3388 * for some reasons, this function is called.
3390 * The reason for connection failure can be any of the value from
3391 * nl80211_connect_failed_reason enum
3393 void cfg80211_conn_failed(struct net_device
*dev
, const u8
*mac_addr
,
3394 enum nl80211_connect_failed_reason reason
,
3398 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3399 * @wdev: wireless device receiving the frame
3400 * @freq: Frequency on which the frame was received in MHz
3401 * @sig_dbm: signal strength in mBm, or 0 if unknown
3402 * @buf: Management frame (header + body)
3403 * @len: length of the frame data
3404 * @gfp: context flags
3406 * Returns %true if a user space application has registered for this frame.
3407 * For action frames, that makes it responsible for rejecting unrecognized
3408 * action frames; %false otherwise, in which case for action frames the
3409 * driver is responsible for rejecting the frame.
3411 * This function is called whenever an Action frame is received for a station
3412 * mode interface, but is not processed in kernel.
3414 bool cfg80211_rx_mgmt(struct wireless_dev
*wdev
, int freq
, int sig_dbm
,
3415 const u8
*buf
, size_t len
, gfp_t gfp
);
3418 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3419 * @wdev: wireless device receiving the frame
3420 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3421 * @buf: Management frame (header + body)
3422 * @len: length of the frame data
3423 * @ack: Whether frame was acknowledged
3424 * @gfp: context flags
3426 * This function is called whenever a management frame was requested to be
3427 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3428 * transmission attempt.
3430 void cfg80211_mgmt_tx_status(struct wireless_dev
*wdev
, u64 cookie
,
3431 const u8
*buf
, size_t len
, bool ack
, gfp_t gfp
);
3435 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3436 * @dev: network device
3437 * @rssi_event: the triggered RSSI event
3438 * @gfp: context flags
3440 * This function is called when a configured connection quality monitoring
3441 * rssi threshold reached event occurs.
3443 void cfg80211_cqm_rssi_notify(struct net_device
*dev
,
3444 enum nl80211_cqm_rssi_threshold_event rssi_event
,
3448 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3449 * @dev: network device
3450 * @peer: peer's MAC address
3451 * @num_packets: how many packets were lost -- should be a fixed threshold
3452 * but probably no less than maybe 50, or maybe a throughput dependent
3453 * threshold (to account for temporary interference)
3454 * @gfp: context flags
3456 void cfg80211_cqm_pktloss_notify(struct net_device
*dev
,
3457 const u8
*peer
, u32 num_packets
, gfp_t gfp
);
3460 * cfg80211_cqm_txe_notify - TX error rate event
3461 * @dev: network device
3462 * @peer: peer's MAC address
3463 * @num_packets: how many packets were lost
3464 * @rate: % of packets which failed transmission
3465 * @intvl: interval (in s) over which the TX failure threshold was breached.
3466 * @gfp: context flags
3468 * Notify userspace when configured % TX failures over number of packets in a
3469 * given interval is exceeded.
3471 void cfg80211_cqm_txe_notify(struct net_device
*dev
, const u8
*peer
,
3472 u32 num_packets
, u32 rate
, u32 intvl
, gfp_t gfp
);
3475 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3476 * @dev: network device
3477 * @bssid: BSSID of AP (to avoid races)
3478 * @replay_ctr: new replay counter
3479 * @gfp: allocation flags
3481 void cfg80211_gtk_rekey_notify(struct net_device
*dev
, const u8
*bssid
,
3482 const u8
*replay_ctr
, gfp_t gfp
);
3485 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3486 * @dev: network device
3487 * @index: candidate index (the smaller the index, the higher the priority)
3488 * @bssid: BSSID of AP
3489 * @preauth: Whether AP advertises support for RSN pre-authentication
3490 * @gfp: allocation flags
3492 void cfg80211_pmksa_candidate_notify(struct net_device
*dev
, int index
,
3493 const u8
*bssid
, bool preauth
, gfp_t gfp
);
3496 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3497 * @dev: The device the frame matched to
3498 * @addr: the transmitter address
3499 * @gfp: context flags
3501 * This function is used in AP mode (only!) to inform userspace that
3502 * a spurious class 3 frame was received, to be able to deauth the
3504 * Returns %true if the frame was passed to userspace (or this failed
3505 * for a reason other than not having a subscription.)
3507 bool cfg80211_rx_spurious_frame(struct net_device
*dev
,
3508 const u8
*addr
, gfp_t gfp
);
3511 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3512 * @dev: The device the frame matched to
3513 * @addr: the transmitter address
3514 * @gfp: context flags
3516 * This function is used in AP mode (only!) to inform userspace that
3517 * an associated station sent a 4addr frame but that wasn't expected.
3518 * It is allowed and desirable to send this event only once for each
3519 * station to avoid event flooding.
3520 * Returns %true if the frame was passed to userspace (or this failed
3521 * for a reason other than not having a subscription.)
3523 bool cfg80211_rx_unexpected_4addr_frame(struct net_device
*dev
,
3524 const u8
*addr
, gfp_t gfp
);
3527 * cfg80211_probe_status - notify userspace about probe status
3528 * @dev: the device the probe was sent on
3529 * @addr: the address of the peer
3530 * @cookie: the cookie filled in @probe_client previously
3531 * @acked: indicates whether probe was acked or not
3532 * @gfp: allocation flags
3534 void cfg80211_probe_status(struct net_device
*dev
, const u8
*addr
,
3535 u64 cookie
, bool acked
, gfp_t gfp
);
3538 * cfg80211_report_obss_beacon - report beacon from other APs
3539 * @wiphy: The wiphy that received the beacon
3541 * @len: length of the frame
3542 * @freq: frequency the frame was received on
3543 * @sig_dbm: signal strength in mBm, or 0 if unknown
3544 * @gfp: allocation flags
3546 * Use this function to report to userspace when a beacon was
3547 * received. It is not useful to call this when there is no
3548 * netdev that is in AP/GO mode.
3550 void cfg80211_report_obss_beacon(struct wiphy
*wiphy
,
3551 const u8
*frame
, size_t len
,
3552 int freq
, int sig_dbm
, gfp_t gfp
);
3555 * cfg80211_can_beacon_sec_chan - test if ht40 on extension channel can be used
3557 * @chan: main channel
3558 * @channel_type: HT mode
3560 * This function returns true if there is no secondary channel or the secondary
3561 * channel can be used for beaconing (i.e. is not a radar channel etc.)
3563 bool cfg80211_can_beacon_sec_chan(struct wiphy
*wiphy
,
3564 struct ieee80211_channel
*chan
,
3565 enum nl80211_channel_type channel_type
);
3568 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
3569 * @dev: the device which switched channels
3570 * @freq: new channel frequency (in MHz)
3571 * @type: channel type
3573 * Acquires wdev_lock, so must only be called from sleepable driver context!
3575 void cfg80211_ch_switch_notify(struct net_device
*dev
, int freq
,
3576 enum nl80211_channel_type type
);
3579 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
3580 * @rate: given rate_info to calculate bitrate from
3582 * return 0 if MCS index >= 32
3584 u32
cfg80211_calculate_bitrate(struct rate_info
*rate
);
3587 * cfg80211_unregister_wdev - remove the given wdev
3588 * @wdev: struct wireless_dev to remove
3590 * Call this function only for wdevs that have no netdev assigned,
3591 * e.g. P2P Devices. It removes the device from the list so that
3592 * it can no longer be used. It is necessary to call this function
3593 * even when cfg80211 requests the removal of the interface by
3594 * calling the del_virtual_intf() callback. The function must also
3595 * be called when the driver wishes to unregister the wdev, e.g.
3596 * when the device is unbound from the driver.
3598 * Requires the RTNL to be held.
3600 void cfg80211_unregister_wdev(struct wireless_dev
*wdev
);
3602 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3604 /* wiphy_printk helpers, similar to dev_printk */
3606 #define wiphy_printk(level, wiphy, format, args...) \
3607 dev_printk(level, &(wiphy)->dev, format, ##args)
3608 #define wiphy_emerg(wiphy, format, args...) \
3609 dev_emerg(&(wiphy)->dev, format, ##args)
3610 #define wiphy_alert(wiphy, format, args...) \
3611 dev_alert(&(wiphy)->dev, format, ##args)
3612 #define wiphy_crit(wiphy, format, args...) \
3613 dev_crit(&(wiphy)->dev, format, ##args)
3614 #define wiphy_err(wiphy, format, args...) \
3615 dev_err(&(wiphy)->dev, format, ##args)
3616 #define wiphy_warn(wiphy, format, args...) \
3617 dev_warn(&(wiphy)->dev, format, ##args)
3618 #define wiphy_notice(wiphy, format, args...) \
3619 dev_notice(&(wiphy)->dev, format, ##args)
3620 #define wiphy_info(wiphy, format, args...) \
3621 dev_info(&(wiphy)->dev, format, ##args)
3623 #define wiphy_debug(wiphy, format, args...) \
3624 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3626 #define wiphy_dbg(wiphy, format, args...) \
3627 dev_dbg(&(wiphy)->dev, format, ##args)
3629 #if defined(VERBOSE_DEBUG)
3630 #define wiphy_vdbg wiphy_dbg
3632 #define wiphy_vdbg(wiphy, format, args...) \
3635 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3641 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3642 * of using a WARN/WARN_ON to get the message out, including the
3643 * file/line information and a backtrace.
3645 #define wiphy_WARN(wiphy, format, args...) \
3646 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3648 #endif /* __NET_CFG80211_H */