percpu: use KERN_CONT in pcpu_dump_alloc_info()
[linux-2.6.git] / include / net / cfg80211.h
blob248fb05feb639aef5ae8d099a3e651d129ea2d14
1 #ifndef __NET_CFG80211_H
2 #define __NET_CFG80211_H
3 /*
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>
24 /**
25 * DOC: Introduction
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
35 * use restrictions.
39 /**
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
44 * described below.
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
65 /**
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_NUM_BANDS: number of defined bands
75 enum ieee80211_band {
76 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
77 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
79 /* keep last */
80 IEEE80211_NUM_BANDS
83 /**
84 * enum ieee80211_channel_flags - channel flags
86 * Channel flags set by the regulatory control code.
88 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
89 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
90 * on this channel.
91 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
92 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
93 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
94 * is not permitted.
95 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
96 * is not permitted.
98 enum ieee80211_channel_flags {
99 IEEE80211_CHAN_DISABLED = 1<<0,
100 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1,
101 IEEE80211_CHAN_NO_IBSS = 1<<2,
102 IEEE80211_CHAN_RADAR = 1<<3,
103 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
104 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
107 #define IEEE80211_CHAN_NO_HT40 \
108 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
111 * struct ieee80211_channel - channel definition
113 * This structure describes a single channel for use
114 * with cfg80211.
116 * @center_freq: center frequency in MHz
117 * @hw_value: hardware-specific value for the channel
118 * @flags: channel flags from &enum ieee80211_channel_flags.
119 * @orig_flags: channel flags at registration time, used by regulatory
120 * code to support devices with additional restrictions
121 * @band: band this channel belongs to.
122 * @max_antenna_gain: maximum antenna gain in dBi
123 * @max_power: maximum transmission power (in dBm)
124 * @max_reg_power: maximum regulatory transmission power (in dBm)
125 * @beacon_found: helper to regulatory code to indicate when a beacon
126 * has been found on this channel. Use regulatory_hint_found_beacon()
127 * to enable this, this is useful only on 5 GHz band.
128 * @orig_mag: internal use
129 * @orig_mpwr: internal use
131 struct ieee80211_channel {
132 enum ieee80211_band band;
133 u16 center_freq;
134 u16 hw_value;
135 u32 flags;
136 int max_antenna_gain;
137 int max_power;
138 int max_reg_power;
139 bool beacon_found;
140 u32 orig_flags;
141 int orig_mag, orig_mpwr;
145 * enum ieee80211_rate_flags - rate flags
147 * Hardware/specification flags for rates. These are structured
148 * in a way that allows using the same bitrate structure for
149 * different bands/PHY modes.
151 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
152 * preamble on this bitrate; only relevant in 2.4GHz band and
153 * with CCK rates.
154 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
155 * when used with 802.11a (on the 5 GHz band); filled by the
156 * core code when registering the wiphy.
157 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
158 * when used with 802.11b (on the 2.4 GHz band); filled by the
159 * core code when registering the wiphy.
160 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
161 * when used with 802.11g (on the 2.4 GHz band); filled by the
162 * core code when registering the wiphy.
163 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
165 enum ieee80211_rate_flags {
166 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
167 IEEE80211_RATE_MANDATORY_A = 1<<1,
168 IEEE80211_RATE_MANDATORY_B = 1<<2,
169 IEEE80211_RATE_MANDATORY_G = 1<<3,
170 IEEE80211_RATE_ERP_G = 1<<4,
174 * struct ieee80211_rate - bitrate definition
176 * This structure describes a bitrate that an 802.11 PHY can
177 * operate with. The two values @hw_value and @hw_value_short
178 * are only for driver use when pointers to this structure are
179 * passed around.
181 * @flags: rate-specific flags
182 * @bitrate: bitrate in units of 100 Kbps
183 * @hw_value: driver/hardware value for this rate
184 * @hw_value_short: driver/hardware value for this rate when
185 * short preamble is used
187 struct ieee80211_rate {
188 u32 flags;
189 u16 bitrate;
190 u16 hw_value, hw_value_short;
194 * struct ieee80211_sta_ht_cap - STA's HT capabilities
196 * This structure describes most essential parameters needed
197 * to describe 802.11n HT capabilities for an STA.
199 * @ht_supported: is HT supported by the STA
200 * @cap: HT capabilities map as described in 802.11n spec
201 * @ampdu_factor: Maximum A-MPDU length factor
202 * @ampdu_density: Minimum A-MPDU spacing
203 * @mcs: Supported MCS rates
205 struct ieee80211_sta_ht_cap {
206 u16 cap; /* use IEEE80211_HT_CAP_ */
207 bool ht_supported;
208 u8 ampdu_factor;
209 u8 ampdu_density;
210 struct ieee80211_mcs_info mcs;
214 * struct ieee80211_supported_band - frequency band definition
216 * This structure describes a frequency band a wiphy
217 * is able to operate in.
219 * @channels: Array of channels the hardware can operate in
220 * in this band.
221 * @band: the band this structure represents
222 * @n_channels: Number of channels in @channels
223 * @bitrates: Array of bitrates the hardware can operate with
224 * in this band. Must be sorted to give a valid "supported
225 * rates" IE, i.e. CCK rates first, then OFDM.
226 * @n_bitrates: Number of bitrates in @bitrates
227 * @ht_cap: HT capabilities in this band
229 struct ieee80211_supported_band {
230 struct ieee80211_channel *channels;
231 struct ieee80211_rate *bitrates;
232 enum ieee80211_band band;
233 int n_channels;
234 int n_bitrates;
235 struct ieee80211_sta_ht_cap ht_cap;
239 * Wireless hardware/device configuration structures and methods
243 * DOC: Actions and configuration
245 * Each wireless device and each virtual interface offer a set of configuration
246 * operations and other actions that are invoked by userspace. Each of these
247 * actions is described in the operations structure, and the parameters these
248 * operations use are described separately.
250 * Additionally, some operations are asynchronous and expect to get status
251 * information via some functions that drivers need to call.
253 * Scanning and BSS list handling with its associated functionality is described
254 * in a separate chapter.
258 * struct vif_params - describes virtual interface parameters
259 * @use_4addr: use 4-address frames
261 struct vif_params {
262 int use_4addr;
266 * struct key_params - key information
268 * Information about a key
270 * @key: key material
271 * @key_len: length of key material
272 * @cipher: cipher suite selector
273 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
274 * with the get_key() callback, must be in little endian,
275 * length given by @seq_len.
276 * @seq_len: length of @seq.
278 struct key_params {
279 u8 *key;
280 u8 *seq;
281 int key_len;
282 int seq_len;
283 u32 cipher;
287 * enum survey_info_flags - survey information flags
289 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
290 * @SURVEY_INFO_IN_USE: channel is currently being used
291 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
292 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
293 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
294 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
295 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
297 * Used by the driver to indicate which info in &struct survey_info
298 * it has filled in during the get_survey().
300 enum survey_info_flags {
301 SURVEY_INFO_NOISE_DBM = 1<<0,
302 SURVEY_INFO_IN_USE = 1<<1,
303 SURVEY_INFO_CHANNEL_TIME = 1<<2,
304 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
305 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
306 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
307 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
311 * struct survey_info - channel survey response
313 * @channel: the channel this survey record reports, mandatory
314 * @filled: bitflag of flags from &enum survey_info_flags
315 * @noise: channel noise in dBm. This and all following fields are
316 * optional
317 * @channel_time: amount of time in ms the radio spent on the channel
318 * @channel_time_busy: amount of time the primary channel was sensed busy
319 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
320 * @channel_time_rx: amount of time the radio spent receiving data
321 * @channel_time_tx: amount of time the radio spent transmitting data
323 * Used by dump_survey() to report back per-channel survey information.
325 * This structure can later be expanded with things like
326 * channel duty cycle etc.
328 struct survey_info {
329 struct ieee80211_channel *channel;
330 u64 channel_time;
331 u64 channel_time_busy;
332 u64 channel_time_ext_busy;
333 u64 channel_time_rx;
334 u64 channel_time_tx;
335 u32 filled;
336 s8 noise;
340 * struct cfg80211_crypto_settings - Crypto settings
341 * @wpa_versions: indicates which, if any, WPA versions are enabled
342 * (from enum nl80211_wpa_versions)
343 * @cipher_group: group key cipher suite (or 0 if unset)
344 * @n_ciphers_pairwise: number of AP supported unicast ciphers
345 * @ciphers_pairwise: unicast key cipher suites
346 * @n_akm_suites: number of AKM suites
347 * @akm_suites: AKM suites
348 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
349 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
350 * required to assume that the port is unauthorized until authorized by
351 * user space. Otherwise, port is marked authorized by default.
352 * @control_port_ethertype: the control port protocol that should be
353 * allowed through even on unauthorized ports
354 * @control_port_no_encrypt: TRUE to prevent encryption of control port
355 * protocol frames.
357 struct cfg80211_crypto_settings {
358 u32 wpa_versions;
359 u32 cipher_group;
360 int n_ciphers_pairwise;
361 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
362 int n_akm_suites;
363 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
364 bool control_port;
365 __be16 control_port_ethertype;
366 bool control_port_no_encrypt;
370 * struct cfg80211_beacon_data - beacon data
371 * @head: head portion of beacon (before TIM IE)
372 * or %NULL if not changed
373 * @tail: tail portion of beacon (after TIM IE)
374 * or %NULL if not changed
375 * @head_len: length of @head
376 * @tail_len: length of @tail
377 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
378 * @beacon_ies_len: length of beacon_ies in octets
379 * @proberesp_ies: extra information element(s) to add into Probe Response
380 * frames or %NULL
381 * @proberesp_ies_len: length of proberesp_ies in octets
382 * @assocresp_ies: extra information element(s) to add into (Re)Association
383 * Response frames or %NULL
384 * @assocresp_ies_len: length of assocresp_ies in octets
385 * @probe_resp_len: length of probe response template (@probe_resp)
386 * @probe_resp: probe response template (AP mode only)
388 struct cfg80211_beacon_data {
389 const u8 *head, *tail;
390 const u8 *beacon_ies;
391 const u8 *proberesp_ies;
392 const u8 *assocresp_ies;
393 const u8 *probe_resp;
395 size_t head_len, tail_len;
396 size_t beacon_ies_len;
397 size_t proberesp_ies_len;
398 size_t assocresp_ies_len;
399 size_t probe_resp_len;
403 * struct cfg80211_ap_settings - AP configuration
405 * Used to configure an AP interface.
407 * @beacon: beacon data
408 * @beacon_interval: beacon interval
409 * @dtim_period: DTIM period
410 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
411 * user space)
412 * @ssid_len: length of @ssid
413 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
414 * @crypto: crypto settings
415 * @privacy: the BSS uses privacy
416 * @auth_type: Authentication type (algorithm)
417 * @inactivity_timeout: time in seconds to determine station's inactivity.
419 struct cfg80211_ap_settings {
420 struct cfg80211_beacon_data beacon;
422 int beacon_interval, dtim_period;
423 const u8 *ssid;
424 size_t ssid_len;
425 enum nl80211_hidden_ssid hidden_ssid;
426 struct cfg80211_crypto_settings crypto;
427 bool privacy;
428 enum nl80211_auth_type auth_type;
429 int inactivity_timeout;
433 * enum plink_action - actions to perform in mesh peers
435 * @PLINK_ACTION_INVALID: action 0 is reserved
436 * @PLINK_ACTION_OPEN: start mesh peer link establishment
437 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
439 enum plink_actions {
440 PLINK_ACTION_INVALID,
441 PLINK_ACTION_OPEN,
442 PLINK_ACTION_BLOCK,
446 * enum station_parameters_apply_mask - station parameter values to apply
447 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
449 * Not all station parameters have in-band "no change" signalling,
450 * for those that don't these flags will are used.
452 enum station_parameters_apply_mask {
453 STATION_PARAM_APPLY_UAPSD = BIT(0),
457 * struct station_parameters - station parameters
459 * Used to change and create a new station.
461 * @vlan: vlan interface station should belong to
462 * @supported_rates: supported rates in IEEE 802.11 format
463 * (or NULL for no change)
464 * @supported_rates_len: number of supported rates
465 * @sta_flags_mask: station flags that changed
466 * (bitmask of BIT(NL80211_STA_FLAG_...))
467 * @sta_flags_set: station flags values
468 * (bitmask of BIT(NL80211_STA_FLAG_...))
469 * @listen_interval: listen interval or -1 for no change
470 * @aid: AID or zero for no change
471 * @plink_action: plink action to take
472 * @plink_state: set the peer link state for a station
473 * @ht_capa: HT capabilities of station
474 * @uapsd_queues: bitmap of queues configured for uapsd. same format
475 * as the AC bitmap in the QoS info field
476 * @max_sp: max Service Period. same format as the MAX_SP in the
477 * QoS info field (but already shifted down)
478 * @sta_modify_mask: bitmap indicating which parameters changed
479 * (for those that don't have a natural "no change" value),
480 * see &enum station_parameters_apply_mask
482 struct station_parameters {
483 u8 *supported_rates;
484 struct net_device *vlan;
485 u32 sta_flags_mask, sta_flags_set;
486 u32 sta_modify_mask;
487 int listen_interval;
488 u16 aid;
489 u8 supported_rates_len;
490 u8 plink_action;
491 u8 plink_state;
492 struct ieee80211_ht_cap *ht_capa;
493 u8 uapsd_queues;
494 u8 max_sp;
498 * enum station_info_flags - station information flags
500 * Used by the driver to indicate which info in &struct station_info
501 * it has filled in during get_station() or dump_station().
503 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
504 * @STATION_INFO_RX_BYTES: @rx_bytes filled
505 * @STATION_INFO_TX_BYTES: @tx_bytes filled
506 * @STATION_INFO_LLID: @llid filled
507 * @STATION_INFO_PLID: @plid filled
508 * @STATION_INFO_PLINK_STATE: @plink_state filled
509 * @STATION_INFO_SIGNAL: @signal filled
510 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
511 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
512 * @STATION_INFO_RX_PACKETS: @rx_packets filled
513 * @STATION_INFO_TX_PACKETS: @tx_packets filled
514 * @STATION_INFO_TX_RETRIES: @tx_retries filled
515 * @STATION_INFO_TX_FAILED: @tx_failed filled
516 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
517 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
518 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
519 * @STATION_INFO_BSS_PARAM: @bss_param filled
520 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
521 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
522 * @STATION_INFO_STA_FLAGS: @sta_flags filled
523 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
525 enum station_info_flags {
526 STATION_INFO_INACTIVE_TIME = 1<<0,
527 STATION_INFO_RX_BYTES = 1<<1,
528 STATION_INFO_TX_BYTES = 1<<2,
529 STATION_INFO_LLID = 1<<3,
530 STATION_INFO_PLID = 1<<4,
531 STATION_INFO_PLINK_STATE = 1<<5,
532 STATION_INFO_SIGNAL = 1<<6,
533 STATION_INFO_TX_BITRATE = 1<<7,
534 STATION_INFO_RX_PACKETS = 1<<8,
535 STATION_INFO_TX_PACKETS = 1<<9,
536 STATION_INFO_TX_RETRIES = 1<<10,
537 STATION_INFO_TX_FAILED = 1<<11,
538 STATION_INFO_RX_DROP_MISC = 1<<12,
539 STATION_INFO_SIGNAL_AVG = 1<<13,
540 STATION_INFO_RX_BITRATE = 1<<14,
541 STATION_INFO_BSS_PARAM = 1<<15,
542 STATION_INFO_CONNECTED_TIME = 1<<16,
543 STATION_INFO_ASSOC_REQ_IES = 1<<17,
544 STATION_INFO_STA_FLAGS = 1<<18,
545 STATION_INFO_BEACON_LOSS_COUNT = 1<<19
549 * enum station_info_rate_flags - bitrate info flags
551 * Used by the driver to indicate the specific rate transmission
552 * type for 802.11n transmissions.
554 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
555 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
556 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
558 enum rate_info_flags {
559 RATE_INFO_FLAGS_MCS = 1<<0,
560 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1,
561 RATE_INFO_FLAGS_SHORT_GI = 1<<2,
565 * struct rate_info - bitrate information
567 * Information about a receiving or transmitting bitrate
569 * @flags: bitflag of flags from &enum rate_info_flags
570 * @mcs: mcs index if struct describes a 802.11n bitrate
571 * @legacy: bitrate in 100kbit/s for 802.11abg
573 struct rate_info {
574 u8 flags;
575 u8 mcs;
576 u16 legacy;
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 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
586 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
587 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
589 enum bss_param_flags {
590 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
591 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
592 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
596 * struct sta_bss_parameters - BSS parameters for the attached station
598 * Information about the currently associated BSS
600 * @flags: bitflag of flags from &enum bss_param_flags
601 * @dtim_period: DTIM period for the BSS
602 * @beacon_interval: beacon interval
604 struct sta_bss_parameters {
605 u8 flags;
606 u8 dtim_period;
607 u16 beacon_interval;
611 * struct station_info - station information
613 * Station information filled by driver for get_station() and dump_station.
615 * @filled: bitflag of flags from &enum station_info_flags
616 * @connected_time: time(in secs) since a station is last connected
617 * @inactive_time: time since last station activity (tx/rx) in milliseconds
618 * @rx_bytes: bytes received from this station
619 * @tx_bytes: bytes transmitted to this station
620 * @llid: mesh local link id
621 * @plid: mesh peer link id
622 * @plink_state: mesh peer link state
623 * @signal: signal strength of last received packet in dBm
624 * @signal_avg: signal strength average in dBm
625 * @txrate: current unicast bitrate from this station
626 * @rxrate: current unicast bitrate to this station
627 * @rx_packets: packets received from this station
628 * @tx_packets: packets transmitted to this station
629 * @tx_retries: cumulative retry counts
630 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
631 * @rx_dropped_misc: Dropped for un-specified reason.
632 * @bss_param: current BSS parameters
633 * @generation: generation number for nl80211 dumps.
634 * This number should increase every time the list of stations
635 * changes, i.e. when a station is added or removed, so that
636 * userspace can tell whether it got a consistent snapshot.
637 * @assoc_req_ies: IEs from (Re)Association Request.
638 * This is used only when in AP mode with drivers that do not use
639 * user space MLME/SME implementation. The information is provided for
640 * the cfg80211_new_sta() calls to notify user space of the IEs.
641 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
642 * @sta_flags: station flags mask & values
643 * @beacon_loss_count: Number of times beacon loss event has triggered.
645 struct station_info {
646 u32 filled;
647 u32 connected_time;
648 u32 inactive_time;
649 u32 rx_bytes;
650 u32 tx_bytes;
651 u16 llid;
652 u16 plid;
653 u8 plink_state;
654 s8 signal;
655 s8 signal_avg;
656 struct rate_info txrate;
657 struct rate_info rxrate;
658 u32 rx_packets;
659 u32 tx_packets;
660 u32 tx_retries;
661 u32 tx_failed;
662 u32 rx_dropped_misc;
663 struct sta_bss_parameters bss_param;
664 struct nl80211_sta_flag_update sta_flags;
666 int generation;
668 const u8 *assoc_req_ies;
669 size_t assoc_req_ies_len;
671 u32 beacon_loss_count;
674 * Note: Add a new enum station_info_flags value for each new field and
675 * use it to check which fields are initialized.
680 * enum monitor_flags - monitor flags
682 * Monitor interface configuration flags. Note that these must be the bits
683 * according to the nl80211 flags.
685 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
686 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
687 * @MONITOR_FLAG_CONTROL: pass control frames
688 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
689 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
691 enum monitor_flags {
692 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
693 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
694 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
695 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
696 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
700 * enum mpath_info_flags - mesh path information flags
702 * Used by the driver to indicate which info in &struct mpath_info it has filled
703 * in during get_station() or dump_station().
705 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
706 * @MPATH_INFO_SN: @sn filled
707 * @MPATH_INFO_METRIC: @metric filled
708 * @MPATH_INFO_EXPTIME: @exptime filled
709 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
710 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
711 * @MPATH_INFO_FLAGS: @flags filled
713 enum mpath_info_flags {
714 MPATH_INFO_FRAME_QLEN = BIT(0),
715 MPATH_INFO_SN = BIT(1),
716 MPATH_INFO_METRIC = BIT(2),
717 MPATH_INFO_EXPTIME = BIT(3),
718 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
719 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
720 MPATH_INFO_FLAGS = BIT(6),
724 * struct mpath_info - mesh path information
726 * Mesh path information filled by driver for get_mpath() and dump_mpath().
728 * @filled: bitfield of flags from &enum mpath_info_flags
729 * @frame_qlen: number of queued frames for this destination
730 * @sn: target sequence number
731 * @metric: metric (cost) of this mesh path
732 * @exptime: expiration time for the mesh path from now, in msecs
733 * @flags: mesh path flags
734 * @discovery_timeout: total mesh path discovery timeout, in msecs
735 * @discovery_retries: mesh path discovery retries
736 * @generation: generation number for nl80211 dumps.
737 * This number should increase every time the list of mesh paths
738 * changes, i.e. when a station is added or removed, so that
739 * userspace can tell whether it got a consistent snapshot.
741 struct mpath_info {
742 u32 filled;
743 u32 frame_qlen;
744 u32 sn;
745 u32 metric;
746 u32 exptime;
747 u32 discovery_timeout;
748 u8 discovery_retries;
749 u8 flags;
751 int generation;
755 * struct bss_parameters - BSS parameters
757 * Used to change BSS parameters (mainly for AP mode).
759 * @use_cts_prot: Whether to use CTS protection
760 * (0 = no, 1 = yes, -1 = do not change)
761 * @use_short_preamble: Whether the use of short preambles is allowed
762 * (0 = no, 1 = yes, -1 = do not change)
763 * @use_short_slot_time: Whether the use of short slot time is allowed
764 * (0 = no, 1 = yes, -1 = do not change)
765 * @basic_rates: basic rates in IEEE 802.11 format
766 * (or NULL for no change)
767 * @basic_rates_len: number of basic rates
768 * @ap_isolate: do not forward packets between connected stations
769 * @ht_opmode: HT Operation mode
770 * (u16 = opmode, -1 = do not change)
772 struct bss_parameters {
773 int use_cts_prot;
774 int use_short_preamble;
775 int use_short_slot_time;
776 u8 *basic_rates;
777 u8 basic_rates_len;
778 int ap_isolate;
779 int ht_opmode;
783 * struct mesh_config - 802.11s mesh configuration
785 * These parameters can be changed while the mesh is active.
787 struct mesh_config {
788 /* Timeouts in ms */
789 /* Mesh plink management parameters */
790 u16 dot11MeshRetryTimeout;
791 u16 dot11MeshConfirmTimeout;
792 u16 dot11MeshHoldingTimeout;
793 u16 dot11MeshMaxPeerLinks;
794 u8 dot11MeshMaxRetries;
795 u8 dot11MeshTTL;
796 /* ttl used in path selection information elements */
797 u8 element_ttl;
798 bool auto_open_plinks;
799 /* HWMP parameters */
800 u8 dot11MeshHWMPmaxPREQretries;
801 u32 path_refresh_time;
802 u16 min_discovery_timeout;
803 u32 dot11MeshHWMPactivePathTimeout;
804 u16 dot11MeshHWMPpreqMinInterval;
805 u16 dot11MeshHWMPperrMinInterval;
806 u16 dot11MeshHWMPnetDiameterTraversalTime;
807 u8 dot11MeshHWMPRootMode;
808 u16 dot11MeshHWMPRannInterval;
809 /* This is missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol
810 * set to true only means that the station will announce others it's a
811 * mesh gate, but not necessarily using the gate announcement protocol.
812 * Still keeping the same nomenclature to be in sync with the spec. */
813 bool dot11MeshGateAnnouncementProtocol;
814 bool dot11MeshForwarding;
815 s32 rssi_threshold;
819 * struct mesh_setup - 802.11s mesh setup configuration
820 * @mesh_id: the mesh ID
821 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
822 * @path_sel_proto: which path selection protocol to use
823 * @path_metric: which metric to use
824 * @ie: vendor information elements (optional)
825 * @ie_len: length of vendor information elements
826 * @is_authenticated: this mesh requires authentication
827 * @is_secure: this mesh uses security
828 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
830 * These parameters are fixed when the mesh is created.
832 struct mesh_setup {
833 const u8 *mesh_id;
834 u8 mesh_id_len;
835 u8 path_sel_proto;
836 u8 path_metric;
837 const u8 *ie;
838 u8 ie_len;
839 bool is_authenticated;
840 bool is_secure;
841 int mcast_rate[IEEE80211_NUM_BANDS];
845 * struct ieee80211_txq_params - TX queue parameters
846 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
847 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
848 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
849 * 1..32767]
850 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
851 * 1..32767]
852 * @aifs: Arbitration interframe space [0..255]
854 struct ieee80211_txq_params {
855 enum nl80211_txq_q queue;
856 u16 txop;
857 u16 cwmin;
858 u16 cwmax;
859 u8 aifs;
862 /* from net/wireless.h */
863 struct wiphy;
866 * DOC: Scanning and BSS list handling
868 * The scanning process itself is fairly simple, but cfg80211 offers quite
869 * a bit of helper functionality. To start a scan, the scan operation will
870 * be invoked with a scan definition. This scan definition contains the
871 * channels to scan, and the SSIDs to send probe requests for (including the
872 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
873 * probe. Additionally, a scan request may contain extra information elements
874 * that should be added to the probe request. The IEs are guaranteed to be
875 * well-formed, and will not exceed the maximum length the driver advertised
876 * in the wiphy structure.
878 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
879 * it is responsible for maintaining the BSS list; the driver should not
880 * maintain a list itself. For this notification, various functions exist.
882 * Since drivers do not maintain a BSS list, there are also a number of
883 * functions to search for a BSS and obtain information about it from the
884 * BSS structure cfg80211 maintains. The BSS list is also made available
885 * to userspace.
889 * struct cfg80211_ssid - SSID description
890 * @ssid: the SSID
891 * @ssid_len: length of the ssid
893 struct cfg80211_ssid {
894 u8 ssid[IEEE80211_MAX_SSID_LEN];
895 u8 ssid_len;
899 * struct cfg80211_scan_request - scan request description
901 * @ssids: SSIDs to scan for (active scan only)
902 * @n_ssids: number of SSIDs
903 * @channels: channels to scan on.
904 * @n_channels: total number of channels to scan
905 * @ie: optional information element(s) to add into Probe Request or %NULL
906 * @ie_len: length of ie in octets
907 * @rates: bitmap of rates to advertise for each band
908 * @wiphy: the wiphy this was for
909 * @dev: the interface
910 * @aborted: (internal) scan request was notified as aborted
911 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
913 struct cfg80211_scan_request {
914 struct cfg80211_ssid *ssids;
915 int n_ssids;
916 u32 n_channels;
917 const u8 *ie;
918 size_t ie_len;
920 u32 rates[IEEE80211_NUM_BANDS];
922 /* internal */
923 struct wiphy *wiphy;
924 struct net_device *dev;
925 bool aborted;
926 bool no_cck;
928 /* keep last */
929 struct ieee80211_channel *channels[0];
933 * struct cfg80211_match_set - sets of attributes to match
935 * @ssid: SSID to be matched
937 struct cfg80211_match_set {
938 struct cfg80211_ssid ssid;
942 * struct cfg80211_sched_scan_request - scheduled scan request description
944 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
945 * @n_ssids: number of SSIDs
946 * @n_channels: total number of channels to scan
947 * @interval: interval between each scheduled scan cycle
948 * @ie: optional information element(s) to add into Probe Request or %NULL
949 * @ie_len: length of ie in octets
950 * @match_sets: sets of parameters to be matched for a scan result
951 * entry to be considered valid and to be passed to the host
952 * (others are filtered out).
953 * If ommited, all results are passed.
954 * @n_match_sets: number of match sets
955 * @wiphy: the wiphy this was for
956 * @dev: the interface
957 * @channels: channels to scan
959 struct cfg80211_sched_scan_request {
960 struct cfg80211_ssid *ssids;
961 int n_ssids;
962 u32 n_channels;
963 u32 interval;
964 const u8 *ie;
965 size_t ie_len;
966 struct cfg80211_match_set *match_sets;
967 int n_match_sets;
969 /* internal */
970 struct wiphy *wiphy;
971 struct net_device *dev;
973 /* keep last */
974 struct ieee80211_channel *channels[0];
978 * enum cfg80211_signal_type - signal type
980 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
981 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
982 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
984 enum cfg80211_signal_type {
985 CFG80211_SIGNAL_TYPE_NONE,
986 CFG80211_SIGNAL_TYPE_MBM,
987 CFG80211_SIGNAL_TYPE_UNSPEC,
991 * struct cfg80211_bss - BSS description
993 * This structure describes a BSS (which may also be a mesh network)
994 * for use in scan results and similar.
996 * @channel: channel this BSS is on
997 * @bssid: BSSID of the BSS
998 * @tsf: timestamp of last received update
999 * @beacon_interval: the beacon interval as from the frame
1000 * @capability: the capability field in host byte order
1001 * @information_elements: the information elements (Note that there
1002 * is no guarantee that these are well-formed!); this is a pointer to
1003 * either the beacon_ies or proberesp_ies depending on whether Probe
1004 * Response frame has been received
1005 * @len_information_elements: total length of the information elements
1006 * @beacon_ies: the information elements from the last Beacon frame
1007 * @len_beacon_ies: total length of the beacon_ies
1008 * @proberesp_ies: the information elements from the last Probe Response frame
1009 * @len_proberesp_ies: total length of the proberesp_ies
1010 * @signal: signal strength value (type depends on the wiphy's signal_type)
1011 * @free_priv: function pointer to free private data
1012 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1014 struct cfg80211_bss {
1015 struct ieee80211_channel *channel;
1017 u8 bssid[ETH_ALEN];
1018 u64 tsf;
1019 u16 beacon_interval;
1020 u16 capability;
1021 u8 *information_elements;
1022 size_t len_information_elements;
1023 u8 *beacon_ies;
1024 size_t len_beacon_ies;
1025 u8 *proberesp_ies;
1026 size_t len_proberesp_ies;
1028 s32 signal;
1030 void (*free_priv)(struct cfg80211_bss *bss);
1031 u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
1035 * ieee80211_bss_get_ie - find IE with given ID
1036 * @bss: the bss to search
1037 * @ie: the IE ID
1038 * Returns %NULL if not found.
1040 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1044 * struct cfg80211_auth_request - Authentication request data
1046 * This structure provides information needed to complete IEEE 802.11
1047 * authentication.
1049 * @bss: The BSS to authenticate with.
1050 * @auth_type: Authentication type (algorithm)
1051 * @ie: Extra IEs to add to Authentication frame or %NULL
1052 * @ie_len: Length of ie buffer in octets
1053 * @key_len: length of WEP key for shared key authentication
1054 * @key_idx: index of WEP key for shared key authentication
1055 * @key: WEP key for shared key authentication
1057 struct cfg80211_auth_request {
1058 struct cfg80211_bss *bss;
1059 const u8 *ie;
1060 size_t ie_len;
1061 enum nl80211_auth_type auth_type;
1062 const u8 *key;
1063 u8 key_len, key_idx;
1067 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1069 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
1071 enum cfg80211_assoc_req_flags {
1072 ASSOC_REQ_DISABLE_HT = BIT(0),
1076 * struct cfg80211_assoc_request - (Re)Association request data
1078 * This structure provides information needed to complete IEEE 802.11
1079 * (re)association.
1080 * @bss: The BSS to associate with. If the call is successful the driver
1081 * is given a reference that it must release, normally via a call to
1082 * cfg80211_send_rx_assoc(), or, if association timed out, with a
1083 * call to cfg80211_put_bss() (in addition to calling
1084 * cfg80211_send_assoc_timeout())
1085 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1086 * @ie_len: Length of ie buffer in octets
1087 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
1088 * @crypto: crypto settings
1089 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
1090 * @flags: See &enum cfg80211_assoc_req_flags
1091 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1092 * will be used in ht_capa. Un-supported values will be ignored.
1093 * @ht_capa_mask: The bits of ht_capa which are to be used.
1095 struct cfg80211_assoc_request {
1096 struct cfg80211_bss *bss;
1097 const u8 *ie, *prev_bssid;
1098 size_t ie_len;
1099 struct cfg80211_crypto_settings crypto;
1100 bool use_mfp;
1101 u32 flags;
1102 struct ieee80211_ht_cap ht_capa;
1103 struct ieee80211_ht_cap ht_capa_mask;
1107 * struct cfg80211_deauth_request - Deauthentication request data
1109 * This structure provides information needed to complete IEEE 802.11
1110 * deauthentication.
1112 * @bssid: the BSSID of the BSS to deauthenticate from
1113 * @ie: Extra IEs to add to Deauthentication frame or %NULL
1114 * @ie_len: Length of ie buffer in octets
1115 * @reason_code: The reason code for the deauthentication
1117 struct cfg80211_deauth_request {
1118 const u8 *bssid;
1119 const u8 *ie;
1120 size_t ie_len;
1121 u16 reason_code;
1125 * struct cfg80211_disassoc_request - Disassociation request data
1127 * This structure provides information needed to complete IEEE 802.11
1128 * disassocation.
1130 * @bss: the BSS to disassociate from
1131 * @ie: Extra IEs to add to Disassociation frame or %NULL
1132 * @ie_len: Length of ie buffer in octets
1133 * @reason_code: The reason code for the disassociation
1134 * @local_state_change: This is a request for a local state only, i.e., no
1135 * Disassociation frame is to be transmitted.
1137 struct cfg80211_disassoc_request {
1138 struct cfg80211_bss *bss;
1139 const u8 *ie;
1140 size_t ie_len;
1141 u16 reason_code;
1142 bool local_state_change;
1146 * struct cfg80211_ibss_params - IBSS parameters
1148 * This structure defines the IBSS parameters for the join_ibss()
1149 * method.
1151 * @ssid: The SSID, will always be non-null.
1152 * @ssid_len: The length of the SSID, will always be non-zero.
1153 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
1154 * search for IBSSs with a different BSSID.
1155 * @channel: The channel to use if no IBSS can be found to join.
1156 * @channel_type: channel type (HT mode)
1157 * @channel_fixed: The channel should be fixed -- do not search for
1158 * IBSSs to join on other channels.
1159 * @ie: information element(s) to include in the beacon
1160 * @ie_len: length of that
1161 * @beacon_interval: beacon interval to use
1162 * @privacy: this is a protected network, keys will be configured
1163 * after joining
1164 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
1165 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
1166 * required to assume that the port is unauthorized until authorized by
1167 * user space. Otherwise, port is marked authorized by default.
1168 * @basic_rates: bitmap of basic rates to use when creating the IBSS
1169 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
1171 struct cfg80211_ibss_params {
1172 u8 *ssid;
1173 u8 *bssid;
1174 struct ieee80211_channel *channel;
1175 enum nl80211_channel_type channel_type;
1176 u8 *ie;
1177 u8 ssid_len, ie_len;
1178 u16 beacon_interval;
1179 u32 basic_rates;
1180 bool channel_fixed;
1181 bool privacy;
1182 bool control_port;
1183 int mcast_rate[IEEE80211_NUM_BANDS];
1187 * struct cfg80211_connect_params - Connection parameters
1189 * This structure provides information needed to complete IEEE 802.11
1190 * authentication and association.
1192 * @channel: The channel to use or %NULL if not specified (auto-select based
1193 * on scan results)
1194 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
1195 * results)
1196 * @ssid: SSID
1197 * @ssid_len: Length of ssid in octets
1198 * @auth_type: Authentication type (algorithm)
1199 * @ie: IEs for association request
1200 * @ie_len: Length of assoc_ie in octets
1201 * @privacy: indicates whether privacy-enabled APs should be used
1202 * @crypto: crypto settings
1203 * @key_len: length of WEP key for shared key authentication
1204 * @key_idx: index of WEP key for shared key authentication
1205 * @key: WEP key for shared key authentication
1206 * @flags: See &enum cfg80211_assoc_req_flags
1207 * @bg_scan_period: Background scan period in seconds
1208 * or -1 to indicate that default value is to be used.
1209 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
1210 * will be used in ht_capa. Un-supported values will be ignored.
1211 * @ht_capa_mask: The bits of ht_capa which are to be used.
1213 struct cfg80211_connect_params {
1214 struct ieee80211_channel *channel;
1215 u8 *bssid;
1216 u8 *ssid;
1217 size_t ssid_len;
1218 enum nl80211_auth_type auth_type;
1219 u8 *ie;
1220 size_t ie_len;
1221 bool privacy;
1222 struct cfg80211_crypto_settings crypto;
1223 const u8 *key;
1224 u8 key_len, key_idx;
1225 u32 flags;
1226 int bg_scan_period;
1227 struct ieee80211_ht_cap ht_capa;
1228 struct ieee80211_ht_cap ht_capa_mask;
1232 * enum wiphy_params_flags - set_wiphy_params bitfield values
1233 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
1234 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
1235 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
1236 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
1237 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1239 enum wiphy_params_flags {
1240 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
1241 WIPHY_PARAM_RETRY_LONG = 1 << 1,
1242 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
1243 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
1244 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
1248 * cfg80211_bitrate_mask - masks for bitrate control
1250 struct cfg80211_bitrate_mask {
1251 struct {
1252 u32 legacy;
1253 u8 mcs[IEEE80211_HT_MCS_MASK_LEN];
1254 } control[IEEE80211_NUM_BANDS];
1257 * struct cfg80211_pmksa - PMK Security Association
1259 * This structure is passed to the set/del_pmksa() method for PMKSA
1260 * caching.
1262 * @bssid: The AP's BSSID.
1263 * @pmkid: The PMK material itself.
1265 struct cfg80211_pmksa {
1266 u8 *bssid;
1267 u8 *pmkid;
1271 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern
1272 * @mask: bitmask where to match pattern and where to ignore bytes,
1273 * one bit per byte, in same format as nl80211
1274 * @pattern: bytes to match where bitmask is 1
1275 * @pattern_len: length of pattern (in bytes)
1277 * Internal note: @mask and @pattern are allocated in one chunk of
1278 * memory, free @mask only!
1280 struct cfg80211_wowlan_trig_pkt_pattern {
1281 u8 *mask, *pattern;
1282 int pattern_len;
1286 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
1288 * This structure defines the enabled WoWLAN triggers for the device.
1289 * @any: wake up on any activity -- special trigger if device continues
1290 * operating as normal during suspend
1291 * @disconnect: wake up if getting disconnected
1292 * @magic_pkt: wake up on receiving magic packet
1293 * @patterns: wake up on receiving packet matching a pattern
1294 * @n_patterns: number of patterns
1295 * @gtk_rekey_failure: wake up on GTK rekey failure
1296 * @eap_identity_req: wake up on EAP identity request packet
1297 * @four_way_handshake: wake up on 4-way handshake
1298 * @rfkill_release: wake up when rfkill is released
1300 struct cfg80211_wowlan {
1301 bool any, disconnect, magic_pkt, gtk_rekey_failure,
1302 eap_identity_req, four_way_handshake,
1303 rfkill_release;
1304 struct cfg80211_wowlan_trig_pkt_pattern *patterns;
1305 int n_patterns;
1309 * struct cfg80211_gtk_rekey_data - rekey data
1310 * @kek: key encryption key
1311 * @kck: key confirmation key
1312 * @replay_ctr: replay counter
1314 struct cfg80211_gtk_rekey_data {
1315 u8 kek[NL80211_KEK_LEN];
1316 u8 kck[NL80211_KCK_LEN];
1317 u8 replay_ctr[NL80211_REPLAY_CTR_LEN];
1321 * struct cfg80211_ops - backend description for wireless configuration
1323 * This struct is registered by fullmac card drivers and/or wireless stacks
1324 * in order to handle configuration requests on their interfaces.
1326 * All callbacks except where otherwise noted should return 0
1327 * on success or a negative error code.
1329 * All operations are currently invoked under rtnl for consistency with the
1330 * wireless extensions but this is subject to reevaluation as soon as this
1331 * code is used more widely and we have a first user without wext.
1333 * @suspend: wiphy device needs to be suspended. The variable @wow will
1334 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
1335 * configured for the device.
1336 * @resume: wiphy device needs to be resumed
1338 * @add_virtual_intf: create a new virtual interface with the given name,
1339 * must set the struct wireless_dev's iftype. Beware: You must create
1340 * the new netdev in the wiphy's network namespace! Returns the netdev,
1341 * or an ERR_PTR.
1343 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1345 * @change_virtual_intf: change type/configuration of virtual interface,
1346 * keep the struct wireless_dev's iftype updated.
1348 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
1349 * when adding a group key.
1351 * @get_key: get information about the key with the given parameters.
1352 * @mac_addr will be %NULL when requesting information for a group
1353 * key. All pointers given to the @callback function need not be valid
1354 * after it returns. This function should return an error if it is
1355 * not possible to retrieve the key, -ENOENT if it doesn't exist.
1357 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1358 * and @key_index, return -ENOENT if the key doesn't exist.
1360 * @set_default_key: set the default key on an interface
1362 * @set_default_mgmt_key: set the default management frame key on an interface
1364 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
1366 * @start_ap: Start acting in AP mode defined by the parameters.
1367 * @change_beacon: Change the beacon parameters for an access point mode
1368 * interface. This should reject the call when AP mode wasn't started.
1369 * @stop_ap: Stop being an AP, including stopping beaconing.
1371 * @add_station: Add a new station.
1372 * @del_station: Remove a station; @mac may be NULL to remove all stations.
1373 * @change_station: Modify a given station. Note that flags changes are not much
1374 * validated in cfg80211, in particular the auth/assoc/authorized flags
1375 * might come to the driver in invalid combinations -- make sure to check
1376 * them, also against the existing state! Also, supported_rates changes are
1377 * not checked in station mode -- drivers need to reject (or ignore) them
1378 * for anything but TDLS peers.
1379 * @get_station: get station information for the station identified by @mac
1380 * @dump_station: dump station callback -- resume dump at index @idx
1382 * @add_mpath: add a fixed mesh path
1383 * @del_mpath: delete a given mesh path
1384 * @change_mpath: change a given mesh path
1385 * @get_mpath: get a mesh path for the given parameters
1386 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1387 * @join_mesh: join the mesh network with the specified parameters
1388 * @leave_mesh: leave the current mesh network
1390 * @get_mesh_config: Get the current mesh configuration
1392 * @update_mesh_config: Update mesh parameters on a running mesh.
1393 * The mask is a bitfield which tells us which parameters to
1394 * set, and which to leave alone.
1396 * @change_bss: Modify parameters for a given BSS.
1398 * @set_txq_params: Set TX queue parameters
1400 * @set_channel: Set channel for a given wireless interface. Some devices
1401 * may support multi-channel operation (by channel hopping) so cfg80211
1402 * doesn't verify much. Note, however, that the passed netdev may be
1403 * %NULL as well if the user requested changing the channel for the
1404 * device itself, or for a monitor interface.
1405 * @get_channel: Get the current operating channel, should return %NULL if
1406 * there's no single defined operating channel if for example the
1407 * device implements channel hopping for multi-channel virtual interfaces.
1409 * @scan: Request to do a scan. If returning zero, the scan request is given
1410 * the driver, and will be valid until passed to cfg80211_scan_done().
1411 * For scan results, call cfg80211_inform_bss(); you can call this outside
1412 * the scan/scan_done bracket too.
1414 * @auth: Request to authenticate with the specified peer
1415 * @assoc: Request to (re)associate with the specified peer
1416 * @deauth: Request to deauthenticate from the specified peer
1417 * @disassoc: Request to disassociate from the specified peer
1419 * @connect: Connect to the ESS with the specified parameters. When connected,
1420 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
1421 * If the connection fails for some reason, call cfg80211_connect_result()
1422 * with the status from the AP.
1423 * @disconnect: Disconnect from the BSS/ESS.
1425 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
1426 * cfg80211_ibss_joined(), also call that function when changing BSSID due
1427 * to a merge.
1428 * @leave_ibss: Leave the IBSS.
1430 * @set_wiphy_params: Notify that wiphy parameters have changed;
1431 * @changed bitfield (see &enum wiphy_params_flags) describes which values
1432 * have changed. The actual parameter values are available in
1433 * struct wiphy. If returning an error, no value should be changed.
1435 * @set_tx_power: set the transmit power according to the parameters,
1436 * the power passed is in mBm, to get dBm use MBM_TO_DBM().
1437 * @get_tx_power: store the current TX power into the dbm variable;
1438 * return 0 if successful
1440 * @set_wds_peer: set the WDS peer for a WDS interface
1442 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
1443 * functions to adjust rfkill hw state
1445 * @dump_survey: get site survey information.
1447 * @remain_on_channel: Request the driver to remain awake on the specified
1448 * channel for the specified duration to complete an off-channel
1449 * operation (e.g., public action frame exchange). When the driver is
1450 * ready on the requested channel, it must indicate this with an event
1451 * notification by calling cfg80211_ready_on_channel().
1452 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
1453 * This allows the operation to be terminated prior to timeout based on
1454 * the duration value.
1455 * @mgmt_tx: Transmit a management frame.
1456 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
1457 * frame on another channel
1459 * @testmode_cmd: run a test mode command
1460 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
1461 * used by the function, but 0 and 1 must not be touched. Additionally,
1462 * return error codes other than -ENOBUFS and -ENOENT will terminate the
1463 * dump and return to userspace with an error, so be careful. If any data
1464 * was passed in from userspace then the data/len arguments will be present
1465 * and point to the data contained in %NL80211_ATTR_TESTDATA.
1467 * @set_bitrate_mask: set the bitrate mask configuration
1469 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
1470 * devices running firmwares capable of generating the (re) association
1471 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
1472 * @del_pmksa: Delete a cached PMKID.
1473 * @flush_pmksa: Flush all cached PMKIDs.
1474 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
1475 * allows the driver to adjust the dynamic ps timeout value.
1476 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
1477 * @sched_scan_start: Tell the driver to start a scheduled scan.
1478 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled
1479 * scan. The driver_initiated flag specifies whether the driver
1480 * itself has informed that the scan has stopped.
1482 * @mgmt_frame_register: Notify driver that a management frame type was
1483 * registered. Note that this callback may not sleep, and cannot run
1484 * concurrently with itself.
1486 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1487 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1488 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1489 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1491 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1493 * @set_ringparam: Set tx and rx ring sizes.
1495 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1497 * @tdls_mgmt: Transmit a TDLS management frame.
1498 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
1500 * @probe_client: probe an associated client, must return a cookie that it
1501 * later passes to cfg80211_probe_status().
1503 * @set_noack_map: Set the NoAck Map for the TIDs.
1505 struct cfg80211_ops {
1506 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
1507 int (*resume)(struct wiphy *wiphy);
1509 struct net_device * (*add_virtual_intf)(struct wiphy *wiphy,
1510 char *name,
1511 enum nl80211_iftype type,
1512 u32 *flags,
1513 struct vif_params *params);
1514 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
1515 int (*change_virtual_intf)(struct wiphy *wiphy,
1516 struct net_device *dev,
1517 enum nl80211_iftype type, u32 *flags,
1518 struct vif_params *params);
1520 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1521 u8 key_index, bool pairwise, const u8 *mac_addr,
1522 struct key_params *params);
1523 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
1524 u8 key_index, bool pairwise, const u8 *mac_addr,
1525 void *cookie,
1526 void (*callback)(void *cookie, struct key_params*));
1527 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
1528 u8 key_index, bool pairwise, const u8 *mac_addr);
1529 int (*set_default_key)(struct wiphy *wiphy,
1530 struct net_device *netdev,
1531 u8 key_index, bool unicast, bool multicast);
1532 int (*set_default_mgmt_key)(struct wiphy *wiphy,
1533 struct net_device *netdev,
1534 u8 key_index);
1536 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
1537 struct cfg80211_ap_settings *settings);
1538 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
1539 struct cfg80211_beacon_data *info);
1540 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
1543 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
1544 u8 *mac, struct station_parameters *params);
1545 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
1546 u8 *mac);
1547 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
1548 u8 *mac, struct station_parameters *params);
1549 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
1550 u8 *mac, struct station_info *sinfo);
1551 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
1552 int idx, u8 *mac, struct station_info *sinfo);
1554 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
1555 u8 *dst, u8 *next_hop);
1556 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
1557 u8 *dst);
1558 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
1559 u8 *dst, u8 *next_hop);
1560 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
1561 u8 *dst, u8 *next_hop,
1562 struct mpath_info *pinfo);
1563 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
1564 int idx, u8 *dst, u8 *next_hop,
1565 struct mpath_info *pinfo);
1566 int (*get_mesh_config)(struct wiphy *wiphy,
1567 struct net_device *dev,
1568 struct mesh_config *conf);
1569 int (*update_mesh_config)(struct wiphy *wiphy,
1570 struct net_device *dev, u32 mask,
1571 const struct mesh_config *nconf);
1572 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
1573 const struct mesh_config *conf,
1574 const struct mesh_setup *setup);
1575 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
1577 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
1578 struct bss_parameters *params);
1580 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
1581 struct ieee80211_txq_params *params);
1583 int (*set_channel)(struct wiphy *wiphy, struct net_device *dev,
1584 struct ieee80211_channel *chan,
1585 enum nl80211_channel_type channel_type);
1587 int (*scan)(struct wiphy *wiphy, struct net_device *dev,
1588 struct cfg80211_scan_request *request);
1590 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
1591 struct cfg80211_auth_request *req);
1592 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
1593 struct cfg80211_assoc_request *req);
1594 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
1595 struct cfg80211_deauth_request *req);
1596 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
1597 struct cfg80211_disassoc_request *req);
1599 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
1600 struct cfg80211_connect_params *sme);
1601 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
1602 u16 reason_code);
1604 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
1605 struct cfg80211_ibss_params *params);
1606 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
1608 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
1610 int (*set_tx_power)(struct wiphy *wiphy,
1611 enum nl80211_tx_power_setting type, int mbm);
1612 int (*get_tx_power)(struct wiphy *wiphy, int *dbm);
1614 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
1615 const u8 *addr);
1617 void (*rfkill_poll)(struct wiphy *wiphy);
1619 #ifdef CONFIG_NL80211_TESTMODE
1620 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len);
1621 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
1622 struct netlink_callback *cb,
1623 void *data, int len);
1624 #endif
1626 int (*set_bitrate_mask)(struct wiphy *wiphy,
1627 struct net_device *dev,
1628 const u8 *peer,
1629 const struct cfg80211_bitrate_mask *mask);
1631 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
1632 int idx, struct survey_info *info);
1634 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1635 struct cfg80211_pmksa *pmksa);
1636 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
1637 struct cfg80211_pmksa *pmksa);
1638 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
1640 int (*remain_on_channel)(struct wiphy *wiphy,
1641 struct net_device *dev,
1642 struct ieee80211_channel *chan,
1643 enum nl80211_channel_type channel_type,
1644 unsigned int duration,
1645 u64 *cookie);
1646 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
1647 struct net_device *dev,
1648 u64 cookie);
1650 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev,
1651 struct ieee80211_channel *chan, bool offchan,
1652 enum nl80211_channel_type channel_type,
1653 bool channel_type_valid, unsigned int wait,
1654 const u8 *buf, size_t len, bool no_cck,
1655 bool dont_wait_for_ack, u64 *cookie);
1656 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
1657 struct net_device *dev,
1658 u64 cookie);
1660 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1661 bool enabled, int timeout);
1663 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
1664 struct net_device *dev,
1665 s32 rssi_thold, u32 rssi_hyst);
1667 void (*mgmt_frame_register)(struct wiphy *wiphy,
1668 struct net_device *dev,
1669 u16 frame_type, bool reg);
1671 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
1672 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
1674 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx);
1675 void (*get_ringparam)(struct wiphy *wiphy,
1676 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
1678 int (*sched_scan_start)(struct wiphy *wiphy,
1679 struct net_device *dev,
1680 struct cfg80211_sched_scan_request *request);
1681 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev);
1683 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
1684 struct cfg80211_gtk_rekey_data *data);
1686 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
1687 u8 *peer, u8 action_code, u8 dialog_token,
1688 u16 status_code, const u8 *buf, size_t len);
1689 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
1690 u8 *peer, enum nl80211_tdls_operation oper);
1692 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
1693 const u8 *peer, u64 *cookie);
1695 int (*set_noack_map)(struct wiphy *wiphy,
1696 struct net_device *dev,
1697 u16 noack_map);
1699 struct ieee80211_channel *(*get_channel)(struct wiphy *wiphy);
1703 * wireless hardware and networking interfaces structures
1704 * and registration/helper functions
1708 * enum wiphy_flags - wiphy capability flags
1710 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device
1711 * has its own custom regulatory domain and cannot identify the
1712 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled
1713 * we will disregard the first regulatory hint (when the
1714 * initiator is %REGDOM_SET_BY_CORE).
1715 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will
1716 * ignore regulatory domain settings until it gets its own regulatory
1717 * domain via its regulatory_hint() unless the regulatory hint is
1718 * from a country IE. After its gets its own regulatory domain it will
1719 * only allow further regulatory domain settings to further enhance
1720 * compliance. For example if channel 13 and 14 are disabled by this
1721 * regulatory domain no user regulatory domain can enable these channels
1722 * at a later time. This can be used for devices which do not have
1723 * calibration information guaranteed for frequencies or settings
1724 * outside of its regulatory domain. If used in combination with
1725 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings
1726 * will be followed.
1727 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure
1728 * that passive scan flags and beaconing flags may not be lifted by
1729 * cfg80211 due to regulatory beacon hints. For more information on beacon
1730 * hints read the documenation for regulatory_hint_found_beacon()
1731 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
1732 * wiphy at all
1733 * @WIPHY_FLAG_ENFORCE_COMBINATIONS: Set this flag to enforce interface
1734 * combinations for this device. This flag is used for backward
1735 * compatibility only until all drivers advertise combinations and
1736 * they will always be enforced.
1737 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
1738 * by default -- this flag will be set depending on the kernel's default
1739 * on wiphy_new(), but can be changed by the driver if it has a good
1740 * reason to override the default
1741 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
1742 * on a VLAN interface)
1743 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
1744 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
1745 * control port protocol ethertype. The device also honours the
1746 * control_port_no_encrypt flag.
1747 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
1748 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
1749 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
1750 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans.
1751 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
1752 * firmware.
1753 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
1754 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
1755 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
1756 * link setup/discovery operations internally. Setup, discovery and
1757 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
1758 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
1759 * used for asking the driver/firmware to perform a TDLS operation.
1760 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
1761 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
1762 * when there are virtual interfaces in AP mode by calling
1763 * cfg80211_report_obss_beacon().
1764 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
1765 * responds to probe-requests in hardware.
1766 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
1767 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
1769 enum wiphy_flags {
1770 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0),
1771 WIPHY_FLAG_STRICT_REGULATORY = BIT(1),
1772 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2),
1773 WIPHY_FLAG_NETNS_OK = BIT(3),
1774 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
1775 WIPHY_FLAG_4ADDR_AP = BIT(5),
1776 WIPHY_FLAG_4ADDR_STATION = BIT(6),
1777 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
1778 WIPHY_FLAG_IBSS_RSN = BIT(8),
1779 WIPHY_FLAG_MESH_AUTH = BIT(10),
1780 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11),
1781 WIPHY_FLAG_ENFORCE_COMBINATIONS = BIT(12),
1782 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
1783 WIPHY_FLAG_AP_UAPSD = BIT(14),
1784 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
1785 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
1786 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
1787 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
1788 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
1789 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
1790 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
1794 * struct ieee80211_iface_limit - limit on certain interface types
1795 * @max: maximum number of interfaces of these types
1796 * @types: interface types (bits)
1798 struct ieee80211_iface_limit {
1799 u16 max;
1800 u16 types;
1804 * struct ieee80211_iface_combination - possible interface combination
1805 * @limits: limits for the given interface types
1806 * @n_limits: number of limitations
1807 * @num_different_channels: can use up to this many different channels
1808 * @max_interfaces: maximum number of interfaces in total allowed in this
1809 * group
1810 * @beacon_int_infra_match: In this combination, the beacon intervals
1811 * between infrastructure and AP types must match. This is required
1812 * only in special cases.
1814 * These examples can be expressed as follows:
1816 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
1818 * struct ieee80211_iface_limit limits1[] = {
1819 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1820 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
1821 * };
1822 * struct ieee80211_iface_combination combination1 = {
1823 * .limits = limits1,
1824 * .n_limits = ARRAY_SIZE(limits1),
1825 * .max_interfaces = 2,
1826 * .beacon_int_infra_match = true,
1827 * };
1830 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
1832 * struct ieee80211_iface_limit limits2[] = {
1833 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
1834 * BIT(NL80211_IFTYPE_P2P_GO), },
1835 * };
1836 * struct ieee80211_iface_combination combination2 = {
1837 * .limits = limits2,
1838 * .n_limits = ARRAY_SIZE(limits2),
1839 * .max_interfaces = 8,
1840 * .num_different_channels = 1,
1841 * };
1844 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
1845 * This allows for an infrastructure connection and three P2P connections.
1847 * struct ieee80211_iface_limit limits3[] = {
1848 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
1849 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
1850 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
1851 * };
1852 * struct ieee80211_iface_combination combination3 = {
1853 * .limits = limits3,
1854 * .n_limits = ARRAY_SIZE(limits3),
1855 * .max_interfaces = 4,
1856 * .num_different_channels = 2,
1857 * };
1859 struct ieee80211_iface_combination {
1860 const struct ieee80211_iface_limit *limits;
1861 u32 num_different_channels;
1862 u16 max_interfaces;
1863 u8 n_limits;
1864 bool beacon_int_infra_match;
1867 struct mac_address {
1868 u8 addr[ETH_ALEN];
1871 struct ieee80211_txrx_stypes {
1872 u16 tx, rx;
1876 * enum wiphy_wowlan_support_flags - WoWLAN support flags
1877 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
1878 * trigger that keeps the device operating as-is and
1879 * wakes up the host on any activity, for example a
1880 * received packet that passed filtering; note that the
1881 * packet should be preserved in that case
1882 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
1883 * (see nl80211.h)
1884 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
1885 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
1886 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
1887 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
1888 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
1889 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
1891 enum wiphy_wowlan_support_flags {
1892 WIPHY_WOWLAN_ANY = BIT(0),
1893 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
1894 WIPHY_WOWLAN_DISCONNECT = BIT(2),
1895 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
1896 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
1897 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
1898 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
1899 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
1903 * struct wiphy_wowlan_support - WoWLAN support data
1904 * @flags: see &enum wiphy_wowlan_support_flags
1905 * @n_patterns: number of supported wakeup patterns
1906 * (see nl80211.h for the pattern definition)
1907 * @pattern_max_len: maximum length of each pattern
1908 * @pattern_min_len: minimum length of each pattern
1910 struct wiphy_wowlan_support {
1911 u32 flags;
1912 int n_patterns;
1913 int pattern_max_len;
1914 int pattern_min_len;
1918 * struct wiphy - wireless hardware description
1919 * @reg_notifier: the driver's regulatory notification callback,
1920 * note that if your driver uses wiphy_apply_custom_regulatory()
1921 * the reg_notifier's request can be passed as NULL
1922 * @regd: the driver's regulatory domain, if one was requested via
1923 * the regulatory_hint() API. This can be used by the driver
1924 * on the reg_notifier() if it chooses to ignore future
1925 * regulatory domain changes caused by other drivers.
1926 * @signal_type: signal type reported in &struct cfg80211_bss.
1927 * @cipher_suites: supported cipher suites
1928 * @n_cipher_suites: number of supported cipher suites
1929 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
1930 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
1931 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
1932 * -1 = fragmentation disabled, only odd values >= 256 used
1933 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
1934 * @_net: the network namespace this wiphy currently lives in
1935 * @perm_addr: permanent MAC address of this device
1936 * @addr_mask: If the device supports multiple MAC addresses by masking,
1937 * set this to a mask with variable bits set to 1, e.g. if the last
1938 * four bits are variable then set it to 00:...:00:0f. The actual
1939 * variable bits shall be determined by the interfaces added, with
1940 * interfaces not matching the mask being rejected to be brought up.
1941 * @n_addresses: number of addresses in @addresses.
1942 * @addresses: If the device has more than one address, set this pointer
1943 * to a list of addresses (6 bytes each). The first one will be used
1944 * by default for perm_addr. In this case, the mask should be set to
1945 * all-zeroes. In this case it is assumed that the device can handle
1946 * the same number of arbitrary MAC addresses.
1947 * @registered: protects ->resume and ->suspend sysfs callbacks against
1948 * unregister hardware
1949 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
1950 * automatically on wiphy renames
1951 * @dev: (virtual) struct device for this wiphy
1952 * @registered: helps synchronize suspend/resume with wiphy unregister
1953 * @wext: wireless extension handlers
1954 * @priv: driver private data (sized according to wiphy_new() parameter)
1955 * @interface_modes: bitmask of interfaces types valid for this wiphy,
1956 * must be set by driver
1957 * @iface_combinations: Valid interface combinations array, should not
1958 * list single interface types.
1959 * @n_iface_combinations: number of entries in @iface_combinations array.
1960 * @software_iftypes: bitmask of software interface types, these are not
1961 * subject to any restrictions since they are purely managed in SW.
1962 * @flags: wiphy flags, see &enum wiphy_flags
1963 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
1964 * @bss_priv_size: each BSS struct has private data allocated with it,
1965 * this variable determines its size
1966 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
1967 * any given scan
1968 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
1969 * for in any given scheduled scan
1970 * @max_match_sets: maximum number of match sets the device can handle
1971 * when performing a scheduled scan, 0 if filtering is not
1972 * supported.
1973 * @max_scan_ie_len: maximum length of user-controlled IEs device can
1974 * add to probe request frames transmitted during a scan, must not
1975 * include fixed IEs like supported rates
1976 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
1977 * scans
1978 * @coverage_class: current coverage class
1979 * @fw_version: firmware version for ethtool reporting
1980 * @hw_version: hardware version for ethtool reporting
1981 * @max_num_pmkids: maximum number of PMKIDs supported by device
1982 * @privid: a pointer that drivers can use to identify if an arbitrary
1983 * wiphy is theirs, e.g. in global notifiers
1984 * @bands: information about bands/channels supported by this device
1986 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
1987 * transmitted through nl80211, points to an array indexed by interface
1988 * type
1990 * @available_antennas_tx: bitmap of antennas which are available to be
1991 * configured as TX antennas. Antenna configuration commands will be
1992 * rejected unless this or @available_antennas_rx is set.
1994 * @available_antennas_rx: bitmap of antennas which are available to be
1995 * configured as RX antennas. Antenna configuration commands will be
1996 * rejected unless this or @available_antennas_tx is set.
1998 * @probe_resp_offload:
1999 * Bitmap of supported protocols for probe response offloading.
2000 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
2001 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2003 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
2004 * may request, if implemented.
2006 * @wowlan: WoWLAN support information
2008 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
2009 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
2010 * If null, then none can be over-ridden.
2012 struct wiphy {
2013 /* assign these fields before you register the wiphy */
2015 /* permanent MAC address(es) */
2016 u8 perm_addr[ETH_ALEN];
2017 u8 addr_mask[ETH_ALEN];
2019 struct mac_address *addresses;
2021 const struct ieee80211_txrx_stypes *mgmt_stypes;
2023 const struct ieee80211_iface_combination *iface_combinations;
2024 int n_iface_combinations;
2025 u16 software_iftypes;
2027 u16 n_addresses;
2029 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
2030 u16 interface_modes;
2032 u32 flags, features;
2034 u32 ap_sme_capa;
2036 enum cfg80211_signal_type signal_type;
2038 int bss_priv_size;
2039 u8 max_scan_ssids;
2040 u8 max_sched_scan_ssids;
2041 u8 max_match_sets;
2042 u16 max_scan_ie_len;
2043 u16 max_sched_scan_ie_len;
2045 int n_cipher_suites;
2046 const u32 *cipher_suites;
2048 u8 retry_short;
2049 u8 retry_long;
2050 u32 frag_threshold;
2051 u32 rts_threshold;
2052 u8 coverage_class;
2054 char fw_version[ETHTOOL_BUSINFO_LEN];
2055 u32 hw_version;
2057 struct wiphy_wowlan_support wowlan;
2059 u16 max_remain_on_channel_duration;
2061 u8 max_num_pmkids;
2063 u32 available_antennas_tx;
2064 u32 available_antennas_rx;
2067 * Bitmap of supported protocols for probe response offloading
2068 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
2069 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
2071 u32 probe_resp_offload;
2073 /* If multiple wiphys are registered and you're handed e.g.
2074 * a regular netdev with assigned ieee80211_ptr, you won't
2075 * know whether it points to a wiphy your driver has registered
2076 * or not. Assign this to something global to your driver to
2077 * help determine whether you own this wiphy or not. */
2078 const void *privid;
2080 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS];
2082 /* Lets us get back the wiphy on the callback */
2083 int (*reg_notifier)(struct wiphy *wiphy,
2084 struct regulatory_request *request);
2086 /* fields below are read-only, assigned by cfg80211 */
2088 const struct ieee80211_regdomain *regd;
2090 /* the item in /sys/class/ieee80211/ points to this,
2091 * you need use set_wiphy_dev() (see below) */
2092 struct device dev;
2094 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
2095 bool registered;
2097 /* dir in debugfs: ieee80211/<wiphyname> */
2098 struct dentry *debugfsdir;
2100 const struct ieee80211_ht_cap *ht_capa_mod_mask;
2102 #ifdef CONFIG_NET_NS
2103 /* the network namespace this phy lives in currently */
2104 struct net *_net;
2105 #endif
2107 #ifdef CONFIG_CFG80211_WEXT
2108 const struct iw_handler_def *wext;
2109 #endif
2111 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN)));
2114 static inline struct net *wiphy_net(struct wiphy *wiphy)
2116 return read_pnet(&wiphy->_net);
2119 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
2121 write_pnet(&wiphy->_net, net);
2125 * wiphy_priv - return priv from wiphy
2127 * @wiphy: the wiphy whose priv pointer to return
2129 static inline void *wiphy_priv(struct wiphy *wiphy)
2131 BUG_ON(!wiphy);
2132 return &wiphy->priv;
2136 * priv_to_wiphy - return the wiphy containing the priv
2138 * @priv: a pointer previously returned by wiphy_priv
2140 static inline struct wiphy *priv_to_wiphy(void *priv)
2142 BUG_ON(!priv);
2143 return container_of(priv, struct wiphy, priv);
2147 * set_wiphy_dev - set device pointer for wiphy
2149 * @wiphy: The wiphy whose device to bind
2150 * @dev: The device to parent it to
2152 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
2154 wiphy->dev.parent = dev;
2158 * wiphy_dev - get wiphy dev pointer
2160 * @wiphy: The wiphy whose device struct to look up
2162 static inline struct device *wiphy_dev(struct wiphy *wiphy)
2164 return wiphy->dev.parent;
2168 * wiphy_name - get wiphy name
2170 * @wiphy: The wiphy whose name to return
2172 static inline const char *wiphy_name(const struct wiphy *wiphy)
2174 return dev_name(&wiphy->dev);
2178 * wiphy_new - create a new wiphy for use with cfg80211
2180 * @ops: The configuration operations for this device
2181 * @sizeof_priv: The size of the private area to allocate
2183 * Create a new wiphy and associate the given operations with it.
2184 * @sizeof_priv bytes are allocated for private use.
2186 * The returned pointer must be assigned to each netdev's
2187 * ieee80211_ptr for proper operation.
2189 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv);
2192 * wiphy_register - register a wiphy with cfg80211
2194 * @wiphy: The wiphy to register.
2196 * Returns a non-negative wiphy index or a negative error code.
2198 extern int wiphy_register(struct wiphy *wiphy);
2201 * wiphy_unregister - deregister a wiphy from cfg80211
2203 * @wiphy: The wiphy to unregister.
2205 * After this call, no more requests can be made with this priv
2206 * pointer, but the call may sleep to wait for an outstanding
2207 * request that is being handled.
2209 extern void wiphy_unregister(struct wiphy *wiphy);
2212 * wiphy_free - free wiphy
2214 * @wiphy: The wiphy to free
2216 extern void wiphy_free(struct wiphy *wiphy);
2218 /* internal structs */
2219 struct cfg80211_conn;
2220 struct cfg80211_internal_bss;
2221 struct cfg80211_cached_keys;
2224 * struct wireless_dev - wireless per-netdev state
2226 * This structure must be allocated by the driver/stack
2227 * that uses the ieee80211_ptr field in struct net_device
2228 * (this is intentional so it can be allocated along with
2229 * the netdev.)
2231 * @wiphy: pointer to hardware description
2232 * @iftype: interface type
2233 * @list: (private) Used to collect the interfaces
2234 * @netdev: (private) Used to reference back to the netdev
2235 * @current_bss: (private) Used by the internal configuration code
2236 * @channel: (private) Used by the internal configuration code to track
2237 * user-set AP, monitor and WDS channels for wireless extensions
2238 * @bssid: (private) Used by the internal configuration code
2239 * @ssid: (private) Used by the internal configuration code
2240 * @ssid_len: (private) Used by the internal configuration code
2241 * @mesh_id_len: (private) Used by the internal configuration code
2242 * @mesh_id_up_len: (private) Used by the internal configuration code
2243 * @wext: (private) Used by the internal wireless extensions compat code
2244 * @use_4addr: indicates 4addr mode is used on this interface, must be
2245 * set by driver (if supported) on add_interface BEFORE registering the
2246 * netdev and may otherwise be used by driver read-only, will be update
2247 * by cfg80211 on change_interface
2248 * @mgmt_registrations: list of registrations for management frames
2249 * @mgmt_registrations_lock: lock for the list
2250 * @mtx: mutex used to lock data in this struct
2251 * @cleanup_work: work struct used for cleanup that can't be done directly
2252 * @beacon_interval: beacon interval used on this device for transmitting
2253 * beacons, 0 when not valid
2255 struct wireless_dev {
2256 struct wiphy *wiphy;
2257 enum nl80211_iftype iftype;
2259 /* the remainder of this struct should be private to cfg80211 */
2260 struct list_head list;
2261 struct net_device *netdev;
2263 struct list_head mgmt_registrations;
2264 spinlock_t mgmt_registrations_lock;
2266 struct mutex mtx;
2268 struct work_struct cleanup_work;
2270 bool use_4addr;
2272 /* currently used for IBSS and SME - might be rearranged later */
2273 u8 ssid[IEEE80211_MAX_SSID_LEN];
2274 u8 ssid_len, mesh_id_len, mesh_id_up_len;
2275 enum {
2276 CFG80211_SME_IDLE,
2277 CFG80211_SME_CONNECTING,
2278 CFG80211_SME_CONNECTED,
2279 } sme_state;
2280 struct cfg80211_conn *conn;
2281 struct cfg80211_cached_keys *connect_keys;
2283 struct list_head event_list;
2284 spinlock_t event_lock;
2286 struct cfg80211_internal_bss *current_bss; /* associated / joined */
2287 struct ieee80211_channel *channel;
2289 bool ps;
2290 int ps_timeout;
2292 int beacon_interval;
2294 u32 ap_unexpected_nlpid;
2296 #ifdef CONFIG_CFG80211_WEXT
2297 /* wext data */
2298 struct {
2299 struct cfg80211_ibss_params ibss;
2300 struct cfg80211_connect_params connect;
2301 struct cfg80211_cached_keys *keys;
2302 u8 *ie;
2303 size_t ie_len;
2304 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
2305 u8 ssid[IEEE80211_MAX_SSID_LEN];
2306 s8 default_key, default_mgmt_key;
2307 bool prev_bssid_valid;
2308 } wext;
2309 #endif
2313 * wdev_priv - return wiphy priv from wireless_dev
2315 * @wdev: The wireless device whose wiphy's priv pointer to return
2317 static inline void *wdev_priv(struct wireless_dev *wdev)
2319 BUG_ON(!wdev);
2320 return wiphy_priv(wdev->wiphy);
2324 * DOC: Utility functions
2326 * cfg80211 offers a number of utility functions that can be useful.
2330 * ieee80211_channel_to_frequency - convert channel number to frequency
2331 * @chan: channel number
2332 * @band: band, necessary due to channel number overlap
2334 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band);
2337 * ieee80211_frequency_to_channel - convert frequency to channel number
2338 * @freq: center frequency
2340 extern int ieee80211_frequency_to_channel(int freq);
2343 * Name indirection necessary because the ieee80211 code also has
2344 * a function named "ieee80211_get_channel", so if you include
2345 * cfg80211's header file you get cfg80211's version, if you try
2346 * to include both header files you'll (rightfully!) get a symbol
2347 * clash.
2349 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy,
2350 int freq);
2352 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
2353 * @wiphy: the struct wiphy to get the channel for
2354 * @freq: the center frequency of the channel
2356 static inline struct ieee80211_channel *
2357 ieee80211_get_channel(struct wiphy *wiphy, int freq)
2359 return __ieee80211_get_channel(wiphy, freq);
2363 * ieee80211_get_response_rate - get basic rate for a given rate
2365 * @sband: the band to look for rates in
2366 * @basic_rates: bitmap of basic rates
2367 * @bitrate: the bitrate for which to find the basic rate
2369 * This function returns the basic rate corresponding to a given
2370 * bitrate, that is the next lower bitrate contained in the basic
2371 * rate map, which is, for this function, given as a bitmap of
2372 * indices of rates in the band's bitrate table.
2374 struct ieee80211_rate *
2375 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
2376 u32 basic_rates, int bitrate);
2379 * Radiotap parsing functions -- for controlled injection support
2381 * Implemented in net/wireless/radiotap.c
2382 * Documentation in Documentation/networking/radiotap-headers.txt
2385 struct radiotap_align_size {
2386 uint8_t align:4, size:4;
2389 struct ieee80211_radiotap_namespace {
2390 const struct radiotap_align_size *align_size;
2391 int n_bits;
2392 uint32_t oui;
2393 uint8_t subns;
2396 struct ieee80211_radiotap_vendor_namespaces {
2397 const struct ieee80211_radiotap_namespace *ns;
2398 int n_ns;
2402 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
2403 * @this_arg_index: index of current arg, valid after each successful call
2404 * to ieee80211_radiotap_iterator_next()
2405 * @this_arg: pointer to current radiotap arg; it is valid after each
2406 * call to ieee80211_radiotap_iterator_next() but also after
2407 * ieee80211_radiotap_iterator_init() where it will point to
2408 * the beginning of the actual data portion
2409 * @this_arg_size: length of the current arg, for convenience
2410 * @current_namespace: pointer to the current namespace definition
2411 * (or internally %NULL if the current namespace is unknown)
2412 * @is_radiotap_ns: indicates whether the current namespace is the default
2413 * radiotap namespace or not
2415 * @_rtheader: pointer to the radiotap header we are walking through
2416 * @_max_length: length of radiotap header in cpu byte ordering
2417 * @_arg_index: next argument index
2418 * @_arg: next argument pointer
2419 * @_next_bitmap: internal pointer to next present u32
2420 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
2421 * @_vns: vendor namespace definitions
2422 * @_next_ns_data: beginning of the next namespace's data
2423 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
2424 * next bitmap word
2426 * Describes the radiotap parser state. Fields prefixed with an underscore
2427 * must not be used by users of the parser, only by the parser internally.
2430 struct ieee80211_radiotap_iterator {
2431 struct ieee80211_radiotap_header *_rtheader;
2432 const struct ieee80211_radiotap_vendor_namespaces *_vns;
2433 const struct ieee80211_radiotap_namespace *current_namespace;
2435 unsigned char *_arg, *_next_ns_data;
2436 __le32 *_next_bitmap;
2438 unsigned char *this_arg;
2439 int this_arg_index;
2440 int this_arg_size;
2442 int is_radiotap_ns;
2444 int _max_length;
2445 int _arg_index;
2446 uint32_t _bitmap_shifter;
2447 int _reset_on_ext;
2450 extern int ieee80211_radiotap_iterator_init(
2451 struct ieee80211_radiotap_iterator *iterator,
2452 struct ieee80211_radiotap_header *radiotap_header,
2453 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns);
2455 extern int ieee80211_radiotap_iterator_next(
2456 struct ieee80211_radiotap_iterator *iterator);
2459 extern const unsigned char rfc1042_header[6];
2460 extern const unsigned char bridge_tunnel_header[6];
2463 * ieee80211_get_hdrlen_from_skb - get header length from data
2465 * Given an skb with a raw 802.11 header at the data pointer this function
2466 * returns the 802.11 header length in bytes (not including encryption
2467 * headers). If the data in the sk_buff is too short to contain a valid 802.11
2468 * header the function returns 0.
2470 * @skb: the frame
2472 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
2475 * ieee80211_hdrlen - get header length in bytes from frame control
2476 * @fc: frame control field in little-endian format
2478 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
2481 * DOC: Data path helpers
2483 * In addition to generic utilities, cfg80211 also offers
2484 * functions that help implement the data path for devices
2485 * that do not do the 802.11/802.3 conversion on the device.
2489 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
2490 * @skb: the 802.11 data frame
2491 * @addr: the device MAC address
2492 * @iftype: the virtual interface type
2494 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
2495 enum nl80211_iftype iftype);
2498 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11
2499 * @skb: the 802.3 frame
2500 * @addr: the device MAC address
2501 * @iftype: the virtual interface type
2502 * @bssid: the network bssid (used only for iftype STATION and ADHOC)
2503 * @qos: build 802.11 QoS data frame
2505 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr,
2506 enum nl80211_iftype iftype, u8 *bssid, bool qos);
2509 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
2511 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of
2512 * 802.3 frames. The @list will be empty if the decode fails. The
2513 * @skb is consumed after the function returns.
2515 * @skb: The input IEEE 802.11n A-MSDU frame.
2516 * @list: The output list of 802.3 frames. It must be allocated and
2517 * initialized by by the caller.
2518 * @addr: The device MAC address.
2519 * @iftype: The device interface type.
2520 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
2521 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header.
2523 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
2524 const u8 *addr, enum nl80211_iftype iftype,
2525 const unsigned int extra_headroom,
2526 bool has_80211_header);
2529 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
2530 * @skb: the data frame
2532 unsigned int cfg80211_classify8021d(struct sk_buff *skb);
2535 * cfg80211_find_ie - find information element in data
2537 * @eid: element ID
2538 * @ies: data consisting of IEs
2539 * @len: length of data
2541 * This function will return %NULL if the element ID could
2542 * not be found or if the element is invalid (claims to be
2543 * longer than the given data), or a pointer to the first byte
2544 * of the requested element, that is the byte containing the
2545 * element ID. There are no checks on the element length
2546 * other than having to fit into the given data.
2548 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len);
2551 * cfg80211_find_vendor_ie - find vendor specific information element in data
2553 * @oui: vendor OUI
2554 * @oui_type: vendor-specific OUI type
2555 * @ies: data consisting of IEs
2556 * @len: length of data
2558 * This function will return %NULL if the vendor specific element ID
2559 * could not be found or if the element is invalid (claims to be
2560 * longer than the given data), or a pointer to the first byte
2561 * of the requested element, that is the byte containing the
2562 * element ID. There are no checks on the element length
2563 * other than having to fit into the given data.
2565 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type,
2566 const u8 *ies, int len);
2569 * DOC: Regulatory enforcement infrastructure
2571 * TODO
2575 * regulatory_hint - driver hint to the wireless core a regulatory domain
2576 * @wiphy: the wireless device giving the hint (used only for reporting
2577 * conflicts)
2578 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
2579 * should be in. If @rd is set this should be NULL. Note that if you
2580 * set this to NULL you should still set rd->alpha2 to some accepted
2581 * alpha2.
2583 * Wireless drivers can use this function to hint to the wireless core
2584 * what it believes should be the current regulatory domain by
2585 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
2586 * domain should be in or by providing a completely build regulatory domain.
2587 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
2588 * for a regulatory domain structure for the respective country.
2590 * The wiphy must have been registered to cfg80211 prior to this call.
2591 * For cfg80211 drivers this means you must first use wiphy_register(),
2592 * for mac80211 drivers you must first use ieee80211_register_hw().
2594 * Drivers should check the return value, its possible you can get
2595 * an -ENOMEM.
2597 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
2600 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
2601 * @wiphy: the wireless device we want to process the regulatory domain on
2602 * @regd: the custom regulatory domain to use for this wiphy
2604 * Drivers can sometimes have custom regulatory domains which do not apply
2605 * to a specific country. Drivers can use this to apply such custom regulatory
2606 * domains. This routine must be called prior to wiphy registration. The
2607 * custom regulatory domain will be trusted completely and as such previous
2608 * default channel settings will be disregarded. If no rule is found for a
2609 * channel on the regulatory domain the channel will be disabled.
2611 extern void wiphy_apply_custom_regulatory(
2612 struct wiphy *wiphy,
2613 const struct ieee80211_regdomain *regd);
2616 * freq_reg_info - get regulatory information for the given frequency
2617 * @wiphy: the wiphy for which we want to process this rule for
2618 * @center_freq: Frequency in KHz for which we want regulatory information for
2619 * @desired_bw_khz: the desired max bandwidth you want to use per
2620 * channel. Note that this is still 20 MHz if you want to use HT40
2621 * as HT40 makes use of two channels for its 40 MHz width bandwidth.
2622 * If set to 0 we'll assume you want the standard 20 MHz.
2623 * @reg_rule: the regulatory rule which we have for this frequency
2625 * Use this function to get the regulatory rule for a specific frequency on
2626 * a given wireless device. If the device has a specific regulatory domain
2627 * it wants to follow we respect that unless a country IE has been received
2628 * and processed already.
2630 * Returns 0 if it was able to find a valid regulatory rule which does
2631 * apply to the given center_freq otherwise it returns non-zero. It will
2632 * also return -ERANGE if we determine the given center_freq does not even have
2633 * a regulatory rule for a frequency range in the center_freq's band. See
2634 * freq_in_rule_band() for our current definition of a band -- this is purely
2635 * subjective and right now its 802.11 specific.
2637 extern int freq_reg_info(struct wiphy *wiphy,
2638 u32 center_freq,
2639 u32 desired_bw_khz,
2640 const struct ieee80211_reg_rule **reg_rule);
2643 * callbacks for asynchronous cfg80211 methods, notification
2644 * functions and BSS handling helpers
2648 * cfg80211_scan_done - notify that scan finished
2650 * @request: the corresponding scan request
2651 * @aborted: set to true if the scan was aborted for any reason,
2652 * userspace will be notified of that
2654 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted);
2657 * cfg80211_sched_scan_results - notify that new scan results are available
2659 * @wiphy: the wiphy which got scheduled scan results
2661 void cfg80211_sched_scan_results(struct wiphy *wiphy);
2664 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
2666 * @wiphy: the wiphy on which the scheduled scan stopped
2668 * The driver can call this function to inform cfg80211 that the
2669 * scheduled scan had to be stopped, for whatever reason. The driver
2670 * is then called back via the sched_scan_stop operation when done.
2672 void cfg80211_sched_scan_stopped(struct wiphy *wiphy);
2675 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame
2677 * @wiphy: the wiphy reporting the BSS
2678 * @channel: The channel the frame was received on
2679 * @mgmt: the management frame (probe response or beacon)
2680 * @len: length of the management frame
2681 * @signal: the signal strength, type depends on the wiphy's signal_type
2682 * @gfp: context flags
2684 * This informs cfg80211 that BSS information was found and
2685 * the BSS should be updated/added.
2687 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2689 struct cfg80211_bss * __must_check
2690 cfg80211_inform_bss_frame(struct wiphy *wiphy,
2691 struct ieee80211_channel *channel,
2692 struct ieee80211_mgmt *mgmt, size_t len,
2693 s32 signal, gfp_t gfp);
2696 * cfg80211_inform_bss - inform cfg80211 of a new BSS
2698 * @wiphy: the wiphy reporting the BSS
2699 * @channel: The channel the frame was received on
2700 * @bssid: the BSSID of the BSS
2701 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
2702 * @capability: the capability field sent by the peer
2703 * @beacon_interval: the beacon interval announced by the peer
2704 * @ie: additional IEs sent by the peer
2705 * @ielen: length of the additional IEs
2706 * @signal: the signal strength, type depends on the wiphy's signal_type
2707 * @gfp: context flags
2709 * This informs cfg80211 that BSS information was found and
2710 * the BSS should be updated/added.
2712 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()!
2714 struct cfg80211_bss * __must_check
2715 cfg80211_inform_bss(struct wiphy *wiphy,
2716 struct ieee80211_channel *channel,
2717 const u8 *bssid, u64 tsf, u16 capability,
2718 u16 beacon_interval, const u8 *ie, size_t ielen,
2719 s32 signal, gfp_t gfp);
2721 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
2722 struct ieee80211_channel *channel,
2723 const u8 *bssid,
2724 const u8 *ssid, size_t ssid_len,
2725 u16 capa_mask, u16 capa_val);
2726 static inline struct cfg80211_bss *
2727 cfg80211_get_ibss(struct wiphy *wiphy,
2728 struct ieee80211_channel *channel,
2729 const u8 *ssid, size_t ssid_len)
2731 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
2732 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS);
2735 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy,
2736 struct ieee80211_channel *channel,
2737 const u8 *meshid, size_t meshidlen,
2738 const u8 *meshcfg);
2740 * cfg80211_ref_bss - reference BSS struct
2741 * @bss: the BSS struct to reference
2743 * Increments the refcount of the given BSS struct.
2745 void cfg80211_ref_bss(struct cfg80211_bss *bss);
2748 * cfg80211_put_bss - unref BSS struct
2749 * @bss: the BSS struct
2751 * Decrements the refcount of the given BSS struct.
2753 void cfg80211_put_bss(struct cfg80211_bss *bss);
2756 * cfg80211_unlink_bss - unlink BSS from internal data structures
2757 * @wiphy: the wiphy
2758 * @bss: the bss to remove
2760 * This function removes the given BSS from the internal data structures
2761 * thereby making it no longer show up in scan results etc. Use this
2762 * function when you detect a BSS is gone. Normally BSSes will also time
2763 * out, so it is not necessary to use this function at all.
2765 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
2768 * cfg80211_send_rx_auth - notification of processed authentication
2769 * @dev: network device
2770 * @buf: authentication frame (header + body)
2771 * @len: length of the frame data
2773 * This function is called whenever an authentication has been processed in
2774 * station mode. The driver is required to call either this function or
2775 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth()
2776 * call. This function may sleep.
2778 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len);
2781 * cfg80211_send_auth_timeout - notification of timed out authentication
2782 * @dev: network device
2783 * @addr: The MAC address of the device with which the authentication timed out
2785 * This function may sleep.
2787 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr);
2790 * cfg80211_send_rx_assoc - notification of processed association
2791 * @dev: network device
2792 * @bss: the BSS struct association was requested for, the struct reference
2793 * is owned by cfg80211 after this call
2794 * @buf: (re)association response frame (header + body)
2795 * @len: length of the frame data
2797 * This function is called whenever a (re)association response has been
2798 * processed in station mode. The driver is required to call either this
2799 * function or cfg80211_send_assoc_timeout() to indicate the result of
2800 * cfg80211_ops::assoc() call. This function may sleep.
2802 void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss,
2803 const u8 *buf, size_t len);
2806 * cfg80211_send_assoc_timeout - notification of timed out association
2807 * @dev: network device
2808 * @addr: The MAC address of the device with which the association timed out
2810 * This function may sleep.
2812 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr);
2815 * cfg80211_send_deauth - notification of processed deauthentication
2816 * @dev: network device
2817 * @buf: deauthentication frame (header + body)
2818 * @len: length of the frame data
2820 * This function is called whenever deauthentication has been processed in
2821 * station mode. This includes both received deauthentication frames and
2822 * locally generated ones. This function may sleep.
2824 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2827 * __cfg80211_send_deauth - notification of processed deauthentication
2828 * @dev: network device
2829 * @buf: deauthentication frame (header + body)
2830 * @len: length of the frame data
2832 * Like cfg80211_send_deauth(), but doesn't take the wdev lock.
2834 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len);
2837 * cfg80211_send_disassoc - notification of processed disassociation
2838 * @dev: network device
2839 * @buf: disassociation response frame (header + body)
2840 * @len: length of the frame data
2842 * This function is called whenever disassociation has been processed in
2843 * station mode. This includes both received disassociation frames and locally
2844 * generated ones. This function may sleep.
2846 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len);
2849 * __cfg80211_send_disassoc - notification of processed disassociation
2850 * @dev: network device
2851 * @buf: disassociation response frame (header + body)
2852 * @len: length of the frame data
2854 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock.
2856 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf,
2857 size_t len);
2860 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication
2861 * @dev: network device
2862 * @buf: deauthentication frame (header + body)
2863 * @len: length of the frame data
2865 * This function is called whenever a received Deauthentication frame has been
2866 * dropped in station mode because of MFP being used but the Deauthentication
2867 * frame was not protected. This function may sleep.
2869 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf,
2870 size_t len);
2873 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation
2874 * @dev: network device
2875 * @buf: disassociation frame (header + body)
2876 * @len: length of the frame data
2878 * This function is called whenever a received Disassociation frame has been
2879 * dropped in station mode because of MFP being used but the Disassociation
2880 * frame was not protected. This function may sleep.
2882 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf,
2883 size_t len);
2886 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
2887 * @dev: network device
2888 * @addr: The source MAC address of the frame
2889 * @key_type: The key type that the received frame used
2890 * @key_id: Key identifier (0..3). Can be -1 if missing.
2891 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
2892 * @gfp: allocation flags
2894 * This function is called whenever the local MAC detects a MIC failure in a
2895 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
2896 * primitive.
2898 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
2899 enum nl80211_key_type key_type, int key_id,
2900 const u8 *tsc, gfp_t gfp);
2903 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
2905 * @dev: network device
2906 * @bssid: the BSSID of the IBSS joined
2907 * @gfp: allocation flags
2909 * This function notifies cfg80211 that the device joined an IBSS or
2910 * switched to a different BSSID. Before this function can be called,
2911 * either a beacon has to have been received from the IBSS, or one of
2912 * the cfg80211_inform_bss{,_frame} functions must have been called
2913 * with the locally generated beacon -- this guarantees that there is
2914 * always a scan result for this IBSS. cfg80211 will handle the rest.
2916 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp);
2919 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
2921 * @dev: network device
2922 * @macaddr: the MAC address of the new candidate
2923 * @ie: information elements advertised by the peer candidate
2924 * @ie_len: lenght of the information elements buffer
2925 * @gfp: allocation flags
2927 * This function notifies cfg80211 that the mesh peer candidate has been
2928 * detected, most likely via a beacon or, less likely, via a probe response.
2929 * cfg80211 then sends a notification to userspace.
2931 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
2932 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
2935 * DOC: RFkill integration
2937 * RFkill integration in cfg80211 is almost invisible to drivers,
2938 * as cfg80211 automatically registers an rfkill instance for each
2939 * wireless device it knows about. Soft kill is also translated
2940 * into disconnecting and turning all interfaces off, drivers are
2941 * expected to turn off the device when all interfaces are down.
2943 * However, devices may have a hard RFkill line, in which case they
2944 * also need to interact with the rfkill subsystem, via cfg80211.
2945 * They can do this with a few helper functions documented here.
2949 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
2950 * @wiphy: the wiphy
2951 * @blocked: block status
2953 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
2956 * wiphy_rfkill_start_polling - start polling rfkill
2957 * @wiphy: the wiphy
2959 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
2962 * wiphy_rfkill_stop_polling - stop polling rfkill
2963 * @wiphy: the wiphy
2965 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
2967 #ifdef CONFIG_NL80211_TESTMODE
2969 * DOC: Test mode
2971 * Test mode is a set of utility functions to allow drivers to
2972 * interact with driver-specific tools to aid, for instance,
2973 * factory programming.
2975 * This chapter describes how drivers interact with it, for more
2976 * information see the nl80211 book's chapter on it.
2980 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
2981 * @wiphy: the wiphy
2982 * @approxlen: an upper bound of the length of the data that will
2983 * be put into the skb
2985 * This function allocates and pre-fills an skb for a reply to
2986 * the testmode command. Since it is intended for a reply, calling
2987 * it outside of the @testmode_cmd operation is invalid.
2989 * The returned skb (or %NULL if any errors happen) is pre-filled
2990 * with the wiphy index and set up in a way that any data that is
2991 * put into the skb (with skb_put(), nla_put() or similar) will end
2992 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that
2993 * needs to be done with the skb is adding data for the corresponding
2994 * userspace tool which can then read that data out of the testdata
2995 * attribute. You must not modify the skb in any other way.
2997 * When done, call cfg80211_testmode_reply() with the skb and return
2998 * its error code as the result of the @testmode_cmd operation.
3000 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy,
3001 int approxlen);
3004 * cfg80211_testmode_reply - send the reply skb
3005 * @skb: The skb, must have been allocated with
3006 * cfg80211_testmode_alloc_reply_skb()
3008 * Returns an error code or 0 on success, since calling this
3009 * function will usually be the last thing before returning
3010 * from the @testmode_cmd you should return the error code.
3011 * Note that this function consumes the skb regardless of the
3012 * return value.
3014 int cfg80211_testmode_reply(struct sk_buff *skb);
3017 * cfg80211_testmode_alloc_event_skb - allocate testmode event
3018 * @wiphy: the wiphy
3019 * @approxlen: an upper bound of the length of the data that will
3020 * be put into the skb
3021 * @gfp: allocation flags
3023 * This function allocates and pre-fills an skb for an event on the
3024 * testmode multicast group.
3026 * The returned skb (or %NULL if any errors happen) is set up in the
3027 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared
3028 * for an event. As there, you should simply add data to it that will
3029 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must
3030 * not modify the skb in any other way.
3032 * When done filling the skb, call cfg80211_testmode_event() with the
3033 * skb to send the event.
3035 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy,
3036 int approxlen, gfp_t gfp);
3039 * cfg80211_testmode_event - send the event
3040 * @skb: The skb, must have been allocated with
3041 * cfg80211_testmode_alloc_event_skb()
3042 * @gfp: allocation flags
3044 * This function sends the given @skb, which must have been allocated
3045 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
3046 * consumes it.
3048 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp);
3050 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
3051 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
3052 #else
3053 #define CFG80211_TESTMODE_CMD(cmd)
3054 #define CFG80211_TESTMODE_DUMP(cmd)
3055 #endif
3058 * cfg80211_connect_result - notify cfg80211 of connection result
3060 * @dev: network device
3061 * @bssid: the BSSID of the AP
3062 * @req_ie: association request IEs (maybe be %NULL)
3063 * @req_ie_len: association request IEs length
3064 * @resp_ie: association response IEs (may be %NULL)
3065 * @resp_ie_len: assoc response IEs length
3066 * @status: status code, 0 for successful connection, use
3067 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
3068 * the real status code for failures.
3069 * @gfp: allocation flags
3071 * It should be called by the underlying driver whenever connect() has
3072 * succeeded.
3074 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
3075 const u8 *req_ie, size_t req_ie_len,
3076 const u8 *resp_ie, size_t resp_ie_len,
3077 u16 status, gfp_t gfp);
3080 * cfg80211_roamed - notify cfg80211 of roaming
3082 * @dev: network device
3083 * @channel: the channel of the new AP
3084 * @bssid: the BSSID of the new AP
3085 * @req_ie: association request IEs (maybe be %NULL)
3086 * @req_ie_len: association request IEs length
3087 * @resp_ie: association response IEs (may be %NULL)
3088 * @resp_ie_len: assoc response IEs length
3089 * @gfp: allocation flags
3091 * It should be called by the underlying driver whenever it roamed
3092 * from one AP to another while connected.
3094 void cfg80211_roamed(struct net_device *dev,
3095 struct ieee80211_channel *channel,
3096 const u8 *bssid,
3097 const u8 *req_ie, size_t req_ie_len,
3098 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3101 * cfg80211_roamed_bss - notify cfg80211 of roaming
3103 * @dev: network device
3104 * @bss: entry of bss to which STA got roamed
3105 * @req_ie: association request IEs (maybe be %NULL)
3106 * @req_ie_len: association request IEs length
3107 * @resp_ie: association response IEs (may be %NULL)
3108 * @resp_ie_len: assoc response IEs length
3109 * @gfp: allocation flags
3111 * This is just a wrapper to notify cfg80211 of roaming event with driver
3112 * passing bss to avoid a race in timeout of the bss entry. It should be
3113 * called by the underlying driver whenever it roamed from one AP to another
3114 * while connected. Drivers which have roaming implemented in firmware
3115 * may use this function to avoid a race in bss entry timeout where the bss
3116 * entry of the new AP is seen in the driver, but gets timed out by the time
3117 * it is accessed in __cfg80211_roamed() due to delay in scheduling
3118 * rdev->event_work. In case of any failures, the reference is released
3119 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise,
3120 * it will be released while diconneting from the current bss.
3122 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss,
3123 const u8 *req_ie, size_t req_ie_len,
3124 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp);
3127 * cfg80211_disconnected - notify cfg80211 that connection was dropped
3129 * @dev: network device
3130 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
3131 * @ie_len: length of IEs
3132 * @reason: reason code for the disconnection, set it to 0 if unknown
3133 * @gfp: allocation flags
3135 * After it calls this function, the driver should enter an idle state
3136 * and not try to connect to any AP any more.
3138 void cfg80211_disconnected(struct net_device *dev, u16 reason,
3139 u8 *ie, size_t ie_len, gfp_t gfp);
3142 * cfg80211_ready_on_channel - notification of remain_on_channel start
3143 * @dev: network device
3144 * @cookie: the request cookie
3145 * @chan: The current channel (from remain_on_channel request)
3146 * @channel_type: Channel type
3147 * @duration: Duration in milliseconds that the driver intents to remain on the
3148 * channel
3149 * @gfp: allocation flags
3151 void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie,
3152 struct ieee80211_channel *chan,
3153 enum nl80211_channel_type channel_type,
3154 unsigned int duration, gfp_t gfp);
3157 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
3158 * @dev: network device
3159 * @cookie: the request cookie
3160 * @chan: The current channel (from remain_on_channel request)
3161 * @channel_type: Channel type
3162 * @gfp: allocation flags
3164 void cfg80211_remain_on_channel_expired(struct net_device *dev,
3165 u64 cookie,
3166 struct ieee80211_channel *chan,
3167 enum nl80211_channel_type channel_type,
3168 gfp_t gfp);
3172 * cfg80211_new_sta - notify userspace about station
3174 * @dev: the netdev
3175 * @mac_addr: the station's address
3176 * @sinfo: the station information
3177 * @gfp: allocation flags
3179 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
3180 struct station_info *sinfo, gfp_t gfp);
3183 * cfg80211_del_sta - notify userspace about deletion of a station
3185 * @dev: the netdev
3186 * @mac_addr: the station's address
3187 * @gfp: allocation flags
3189 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp);
3192 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
3193 * @dev: network device
3194 * @freq: Frequency on which the frame was received in MHz
3195 * @sig_dbm: signal strength in mBm, or 0 if unknown
3196 * @buf: Management frame (header + body)
3197 * @len: length of the frame data
3198 * @gfp: context flags
3200 * Returns %true if a user space application has registered for this frame.
3201 * For action frames, that makes it responsible for rejecting unrecognized
3202 * action frames; %false otherwise, in which case for action frames the
3203 * driver is responsible for rejecting the frame.
3205 * This function is called whenever an Action frame is received for a station
3206 * mode interface, but is not processed in kernel.
3208 bool cfg80211_rx_mgmt(struct net_device *dev, int freq, int sig_dbm,
3209 const u8 *buf, size_t len, gfp_t gfp);
3212 * cfg80211_mgmt_tx_status - notification of TX status for management frame
3213 * @dev: network device
3214 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
3215 * @buf: Management frame (header + body)
3216 * @len: length of the frame data
3217 * @ack: Whether frame was acknowledged
3218 * @gfp: context flags
3220 * This function is called whenever a management frame was requested to be
3221 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
3222 * transmission attempt.
3224 void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie,
3225 const u8 *buf, size_t len, bool ack, gfp_t gfp);
3229 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
3230 * @dev: network device
3231 * @rssi_event: the triggered RSSI event
3232 * @gfp: context flags
3234 * This function is called when a configured connection quality monitoring
3235 * rssi threshold reached event occurs.
3237 void cfg80211_cqm_rssi_notify(struct net_device *dev,
3238 enum nl80211_cqm_rssi_threshold_event rssi_event,
3239 gfp_t gfp);
3242 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
3243 * @dev: network device
3244 * @peer: peer's MAC address
3245 * @num_packets: how many packets were lost -- should be a fixed threshold
3246 * but probably no less than maybe 50, or maybe a throughput dependent
3247 * threshold (to account for temporary interference)
3248 * @gfp: context flags
3250 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
3251 const u8 *peer, u32 num_packets, gfp_t gfp);
3254 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
3255 * @dev: network device
3256 * @bssid: BSSID of AP (to avoid races)
3257 * @replay_ctr: new replay counter
3258 * @gfp: allocation flags
3260 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
3261 const u8 *replay_ctr, gfp_t gfp);
3264 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
3265 * @dev: network device
3266 * @index: candidate index (the smaller the index, the higher the priority)
3267 * @bssid: BSSID of AP
3268 * @preauth: Whether AP advertises support for RSN pre-authentication
3269 * @gfp: allocation flags
3271 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
3272 const u8 *bssid, bool preauth, gfp_t gfp);
3275 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
3276 * @dev: The device the frame matched to
3277 * @addr: the transmitter address
3278 * @gfp: context flags
3280 * This function is used in AP mode (only!) to inform userspace that
3281 * a spurious class 3 frame was received, to be able to deauth the
3282 * sender.
3283 * Returns %true if the frame was passed to userspace (or this failed
3284 * for a reason other than not having a subscription.)
3286 bool cfg80211_rx_spurious_frame(struct net_device *dev,
3287 const u8 *addr, gfp_t gfp);
3290 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
3291 * @dev: The device the frame matched to
3292 * @addr: the transmitter address
3293 * @gfp: context flags
3295 * This function is used in AP mode (only!) to inform userspace that
3296 * an associated station sent a 4addr frame but that wasn't expected.
3297 * It is allowed and desirable to send this event only once for each
3298 * station to avoid event flooding.
3299 * Returns %true if the frame was passed to userspace (or this failed
3300 * for a reason other than not having a subscription.)
3302 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
3303 const u8 *addr, gfp_t gfp);
3306 * cfg80211_probe_status - notify userspace about probe status
3307 * @dev: the device the probe was sent on
3308 * @addr: the address of the peer
3309 * @cookie: the cookie filled in @probe_client previously
3310 * @acked: indicates whether probe was acked or not
3311 * @gfp: allocation flags
3313 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
3314 u64 cookie, bool acked, gfp_t gfp);
3317 * cfg80211_report_obss_beacon - report beacon from other APs
3318 * @wiphy: The wiphy that received the beacon
3319 * @frame: the frame
3320 * @len: length of the frame
3321 * @freq: frequency the frame was received on
3322 * @sig_dbm: signal strength in mBm, or 0 if unknown
3323 * @gfp: allocation flags
3325 * Use this function to report to userspace when a beacon was
3326 * received. It is not useful to call this when there is no
3327 * netdev that is in AP/GO mode.
3329 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
3330 const u8 *frame, size_t len,
3331 int freq, int sig_dbm, gfp_t gfp);
3334 * cfg80211_can_beacon_sec_chan - test if ht40 on extension channel can be used
3335 * @wiphy: the wiphy
3336 * @chan: main channel
3337 * @channel_type: HT mode
3339 int cfg80211_can_beacon_sec_chan(struct wiphy *wiphy,
3340 struct ieee80211_channel *chan,
3341 enum nl80211_channel_type channel_type);
3344 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
3345 * @rate: given rate_info to calculate bitrate from
3347 * return 0 if MCS index >= 32
3349 u16 cfg80211_calculate_bitrate(struct rate_info *rate);
3351 /* Logging, debugging and troubleshooting/diagnostic helpers. */
3353 /* wiphy_printk helpers, similar to dev_printk */
3355 #define wiphy_printk(level, wiphy, format, args...) \
3356 dev_printk(level, &(wiphy)->dev, format, ##args)
3357 #define wiphy_emerg(wiphy, format, args...) \
3358 dev_emerg(&(wiphy)->dev, format, ##args)
3359 #define wiphy_alert(wiphy, format, args...) \
3360 dev_alert(&(wiphy)->dev, format, ##args)
3361 #define wiphy_crit(wiphy, format, args...) \
3362 dev_crit(&(wiphy)->dev, format, ##args)
3363 #define wiphy_err(wiphy, format, args...) \
3364 dev_err(&(wiphy)->dev, format, ##args)
3365 #define wiphy_warn(wiphy, format, args...) \
3366 dev_warn(&(wiphy)->dev, format, ##args)
3367 #define wiphy_notice(wiphy, format, args...) \
3368 dev_notice(&(wiphy)->dev, format, ##args)
3369 #define wiphy_info(wiphy, format, args...) \
3370 dev_info(&(wiphy)->dev, format, ##args)
3372 #define wiphy_debug(wiphy, format, args...) \
3373 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
3375 #define wiphy_dbg(wiphy, format, args...) \
3376 dev_dbg(&(wiphy)->dev, format, ##args)
3378 #if defined(VERBOSE_DEBUG)
3379 #define wiphy_vdbg wiphy_dbg
3380 #else
3381 #define wiphy_vdbg(wiphy, format, args...) \
3382 ({ \
3383 if (0) \
3384 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
3385 0; \
3387 #endif
3390 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
3391 * of using a WARN/WARN_ON to get the message out, including the
3392 * file/line information and a backtrace.
3394 #define wiphy_WARN(wiphy, format, args...) \
3395 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
3397 #endif /* __NET_CFG80211_H */