cfg80211.h 96.3 KB
Newer Older
1 2
#ifndef __NET_CFG80211_H
#define __NET_CFG80211_H
Johannes Berg's avatar
Johannes Berg committed
3 4 5
/*
 * 802.11 device and configuration interface
 *
6
 * Copyright 2006-2010	Johannes Berg <johannes@sipsolutions.net>
Johannes Berg's avatar
Johannes Berg committed
7 8 9 10 11
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
12

Johannes Berg's avatar
Johannes Berg committed
13 14 15
#include <linux/netdevice.h>
#include <linux/debugfs.h>
#include <linux/list.h>
16 17
#include <linux/netlink.h>
#include <linux/skbuff.h>
18
#include <linux/nl80211.h>
19 20
#include <linux/if_ether.h>
#include <linux/ieee80211.h>
Johannes Berg's avatar
Johannes Berg committed
21 22
#include <net/regulatory.h>

Johannes Berg's avatar
Johannes Berg committed
23
/* remove once we remove the wext stuff */
Johannes Berg's avatar
Johannes Berg committed
24 25 26
#include <net/iw_handler.h>
#include <linux/wireless.h>

27

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
/**
 * DOC: Introduction
 *
 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
 * userspace and drivers, and offers some utility functionality associated
 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
 * by all modern wireless drivers in Linux, so that they offer a consistent
 * API through nl80211. For backward compatibility, cfg80211 also offers
 * wireless extensions to userspace, but hides them from drivers completely.
 *
 * Additionally, cfg80211 contains code to help enforce regulatory spectrum
 * use restrictions.
 */


/**
 * DOC: Device registration
 *
 * In order for a driver to use cfg80211, it must register the hardware device
 * with cfg80211. This happens through a number of hardware capability structs
 * described below.
 *
 * The fundamental structure for each device is the 'wiphy', of which each
 * instance describes a physical wireless device connected to the system. Each
 * such wiphy can have zero, one, or many virtual interfaces associated with
 * it, which need to be identified as such by pointing the network interface's
 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
 * the wireless part of the interface, normally this struct is embedded in the
 * network interface's private data area. Drivers can optionally allow creating
 * or destroying virtual interfaces on the fly, but without at least one or the
 * ability to create some the wireless device isn't useful.
 *
 * Each wiphy structure contains device capability information, and also has
 * a pointer to the various operations the driver offers. The definitions and
 * structures here describe these capabilities in detail.
 */

65
/*
Johannes Berg's avatar
Johannes Berg committed
66 67 68 69 70 71 72 73
 * wireless hardware capability structures
 */

/**
 * enum ieee80211_band - supported frequency bands
 *
 * The bands are assigned this way because the supported
 * bitrates differ in these bands.
74
 *
Johannes Berg's avatar
Johannes Berg committed
75 76
 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
Johannes Berg's avatar
Johannes Berg committed
77
 * @IEEE80211_NUM_BANDS: number of defined bands
78
 */
Johannes Berg's avatar
Johannes Berg committed
79
enum ieee80211_band {
80 81
	IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ,
	IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ,
Johannes Berg's avatar
Johannes Berg committed
82 83 84 85

	/* keep last */
	IEEE80211_NUM_BANDS
};
86

87
/**
Johannes Berg's avatar
Johannes Berg committed
88 89 90 91 92 93 94 95 96
 * enum ieee80211_channel_flags - channel flags
 *
 * Channel flags set by the regulatory control code.
 *
 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted
 *	on this channel.
 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel.
 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
97
 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
Johannes Berg's avatar
Johannes Berg committed
98
 * 	is not permitted.
99
 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
Johannes Berg's avatar
Johannes Berg committed
100
 * 	is not permitted.
101
 */
Johannes Berg's avatar
Johannes Berg committed
102 103 104 105 106
enum ieee80211_channel_flags {
	IEEE80211_CHAN_DISABLED		= 1<<0,
	IEEE80211_CHAN_PASSIVE_SCAN	= 1<<1,
	IEEE80211_CHAN_NO_IBSS		= 1<<2,
	IEEE80211_CHAN_RADAR		= 1<<3,
107 108
	IEEE80211_CHAN_NO_HT40PLUS	= 1<<4,
	IEEE80211_CHAN_NO_HT40MINUS	= 1<<5,
109 110
};

111
#define IEEE80211_CHAN_NO_HT40 \
112
	(IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
113

Johannes Berg's avatar
Johannes Berg committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
/**
 * struct ieee80211_channel - channel definition
 *
 * This structure describes a single channel for use
 * with cfg80211.
 *
 * @center_freq: center frequency in MHz
 * @hw_value: hardware-specific value for the channel
 * @flags: channel flags from &enum ieee80211_channel_flags.
 * @orig_flags: channel flags at registration time, used by regulatory
 *	code to support devices with additional restrictions
 * @band: band this channel belongs to.
 * @max_antenna_gain: maximum antenna gain in dBi
 * @max_power: maximum transmission power (in dBm)
 * @beacon_found: helper to regulatory code to indicate when a beacon
 *	has been found on this channel. Use regulatory_hint_found_beacon()
130
 *	to enable this, this is useful only on 5 GHz band.
Johannes Berg's avatar
Johannes Berg committed
131 132
 * @orig_mag: internal use
 * @orig_mpwr: internal use
Andy Green's avatar
Andy Green committed
133
 */
Johannes Berg's avatar
Johannes Berg committed
134 135 136 137 138 139 140 141 142 143 144 145
struct ieee80211_channel {
	enum ieee80211_band band;
	u16 center_freq;
	u16 hw_value;
	u32 flags;
	int max_antenna_gain;
	int max_power;
	bool beacon_found;
	u32 orig_flags;
	int orig_mag, orig_mpwr;
};

Andy Green's avatar
Andy Green committed
146
/**
Johannes Berg's avatar
Johannes Berg committed
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
 * enum ieee80211_rate_flags - rate flags
 *
 * Hardware/specification flags for rates. These are structured
 * in a way that allows using the same bitrate structure for
 * different bands/PHY modes.
 *
 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
 *	preamble on this bitrate; only relevant in 2.4GHz band and
 *	with CCK rates.
 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
 *	when used with 802.11a (on the 5 GHz band); filled by the
 *	core code when registering the wiphy.
 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
 *	when used with 802.11b (on the 2.4 GHz band); filled by the
 *	core code when registering the wiphy.
 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
 *	when used with 802.11g (on the 2.4 GHz band); filled by the
 *	core code when registering the wiphy.
 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
Andy Green's avatar
Andy Green committed
166
 */
Johannes Berg's avatar
Johannes Berg committed
167 168 169 170 171 172 173
enum ieee80211_rate_flags {
	IEEE80211_RATE_SHORT_PREAMBLE	= 1<<0,
	IEEE80211_RATE_MANDATORY_A	= 1<<1,
	IEEE80211_RATE_MANDATORY_B	= 1<<2,
	IEEE80211_RATE_MANDATORY_G	= 1<<3,
	IEEE80211_RATE_ERP_G		= 1<<4,
};
Andy Green's avatar
Andy Green committed
174

Johannes Berg's avatar
Johannes Berg committed
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
/**
 * struct ieee80211_rate - bitrate definition
 *
 * This structure describes a bitrate that an 802.11 PHY can
 * operate with. The two values @hw_value and @hw_value_short
 * are only for driver use when pointers to this structure are
 * passed around.
 *
 * @flags: rate-specific flags
 * @bitrate: bitrate in units of 100 Kbps
 * @hw_value: driver/hardware value for this rate
 * @hw_value_short: driver/hardware value for this rate when
 *	short preamble is used
 */
struct ieee80211_rate {
	u32 flags;
	u16 bitrate;
	u16 hw_value, hw_value_short;
};
Andy Green's avatar
Andy Green committed
194

Johannes Berg's avatar
Johannes Berg committed
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
/**
 * struct ieee80211_sta_ht_cap - STA's HT capabilities
 *
 * This structure describes most essential parameters needed
 * to describe 802.11n HT capabilities for an STA.
 *
 * @ht_supported: is HT supported by the STA
 * @cap: HT capabilities map as described in 802.11n spec
 * @ampdu_factor: Maximum A-MPDU length factor
 * @ampdu_density: Minimum A-MPDU spacing
 * @mcs: Supported MCS rates
 */
struct ieee80211_sta_ht_cap {
	u16 cap; /* use IEEE80211_HT_CAP_ */
	bool ht_supported;
	u8 ampdu_factor;
	u8 ampdu_density;
	struct ieee80211_mcs_info mcs;
Andy Green's avatar
Andy Green committed
213 214
};

Johannes Berg's avatar
Johannes Berg committed
215 216 217 218 219 220 221 222 223 224 225 226 227 228
/**
 * struct ieee80211_supported_band - frequency band definition
 *
 * This structure describes a frequency band a wiphy
 * is able to operate in.
 *
 * @channels: Array of channels the hardware can operate in
 *	in this band.
 * @band: the band this structure represents
 * @n_channels: Number of channels in @channels
 * @bitrates: Array of bitrates the hardware can operate with
 *	in this band. Must be sorted to give a valid "supported
 *	rates" IE, i.e. CCK rates first, then OFDM.
 * @n_bitrates: Number of bitrates in @bitrates
Johannes Berg's avatar
Johannes Berg committed
229
 * @ht_cap: HT capabilities in this band
Johannes Berg's avatar
Johannes Berg committed
230 231 232 233 234 235 236 237 238
 */
struct ieee80211_supported_band {
	struct ieee80211_channel *channels;
	struct ieee80211_rate *bitrates;
	enum ieee80211_band band;
	int n_channels;
	int n_bitrates;
	struct ieee80211_sta_ht_cap ht_cap;
};
Andy Green's avatar
Andy Green committed
239

Johannes Berg's avatar
Johannes Berg committed
240 241 242
/*
 * Wireless hardware/device configuration structures and methods
 */
Andy Green's avatar
Andy Green committed
243

244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
/**
 * DOC: Actions and configuration
 *
 * Each wireless device and each virtual interface offer a set of configuration
 * operations and other actions that are invoked by userspace. Each of these
 * actions is described in the operations structure, and the parameters these
 * operations use are described separately.
 *
 * Additionally, some operations are asynchronous and expect to get status
 * information via some functions that drivers need to call.
 *
 * Scanning and BSS list handling with its associated functionality is described
 * in a separate chapter.
 */

Johannes Berg's avatar
Johannes Berg committed
259 260
/**
 * struct vif_params - describes virtual interface parameters
261
 * @use_4addr: use 4-address frames
Johannes Berg's avatar
Johannes Berg committed
262 263
 */
struct vif_params {
264
       int use_4addr;
Johannes Berg's avatar
Johannes Berg committed
265
};
Andy Green's avatar
Andy Green committed
266

Johannes Berg's avatar
Johannes Berg committed
267
/**
268 269 270 271 272 273 274 275 276 277
 * struct key_params - key information
 *
 * Information about a key
 *
 * @key: key material
 * @key_len: length of key material
 * @cipher: cipher suite selector
 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
 *	with the get_key() callback, must be in little endian,
 *	length given by @seq_len.
Johannes Berg's avatar
Johannes Berg committed
278
 * @seq_len: length of @seq.
279 280 281 282 283 284 285 286 287
 */
struct key_params {
	u8 *key;
	u8 *seq;
	int key_len;
	int seq_len;
	u32 cipher;
};

288 289 290
/**
 * enum survey_info_flags - survey information flags
 *
Johannes Berg's avatar
Johannes Berg committed
291
 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
292
 * @SURVEY_INFO_IN_USE: channel is currently being used
293 294 295 296 297
 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in
 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in
 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in
 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in
 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in
Johannes Berg's avatar
Johannes Berg committed
298
 *
299 300 301 302 303
 * Used by the driver to indicate which info in &struct survey_info
 * it has filled in during the get_survey().
 */
enum survey_info_flags {
	SURVEY_INFO_NOISE_DBM = 1<<0,
304
	SURVEY_INFO_IN_USE = 1<<1,
305 306 307 308 309
	SURVEY_INFO_CHANNEL_TIME = 1<<2,
	SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3,
	SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4,
	SURVEY_INFO_CHANNEL_TIME_RX = 1<<5,
	SURVEY_INFO_CHANNEL_TIME_TX = 1<<6,
310 311 312 313 314 315 316 317 318
};

/**
 * struct survey_info - channel survey response
 *
 * @channel: the channel this survey record reports, mandatory
 * @filled: bitflag of flags from &enum survey_info_flags
 * @noise: channel noise in dBm. This and all following fields are
 *     optional
319 320 321 322 323
 * @channel_time: amount of time in ms the radio spent on the channel
 * @channel_time_busy: amount of time the primary channel was sensed busy
 * @channel_time_ext_busy: amount of time the extension channel was sensed busy
 * @channel_time_rx: amount of time the radio spent receiving data
 * @channel_time_tx: amount of time the radio spent transmitting data
324
 *
Johannes Berg's avatar
Johannes Berg committed
325 326
 * Used by dump_survey() to report back per-channel survey information.
 *
327 328 329 330 331
 * This structure can later be expanded with things like
 * channel duty cycle etc.
 */
struct survey_info {
	struct ieee80211_channel *channel;
332 333 334 335 336
	u64 channel_time;
	u64 channel_time_busy;
	u64 channel_time_ext_busy;
	u64 channel_time_rx;
	u64 channel_time_tx;
337 338 339 340
	u32 filled;
	s8 noise;
};

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
/**
 * struct beacon_parameters - beacon parameters
 *
 * Used to configure the beacon for an interface.
 *
 * @head: head portion of beacon (before TIM IE)
 *     or %NULL if not changed
 * @tail: tail portion of beacon (after TIM IE)
 *     or %NULL if not changed
 * @interval: beacon interval or zero if not changed
 * @dtim_period: DTIM period or zero if not changed
 * @head_len: length of @head
 * @tail_len: length of @tail
 */
struct beacon_parameters {
	u8 *head, *tail;
	int interval, dtim_period;
	int head_len, tail_len;
};

361 362 363 364 365
/**
 * enum plink_action - actions to perform in mesh peers
 *
 * @PLINK_ACTION_INVALID: action 0 is reserved
 * @PLINK_ACTION_OPEN: start mesh peer link establishment
Johannes Berg's avatar
Johannes Berg committed
366
 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
367 368 369 370 371 372 373
 */
enum plink_actions {
	PLINK_ACTION_INVALID,
	PLINK_ACTION_OPEN,
	PLINK_ACTION_BLOCK,
};

374 375 376 377 378 379 380 381 382
/**
 * struct station_parameters - station parameters
 *
 * Used to change and create a new station.
 *
 * @vlan: vlan interface station should belong to
 * @supported_rates: supported rates in IEEE 802.11 format
 *	(or NULL for no change)
 * @supported_rates_len: number of supported rates
383 384 385 386
 * @sta_flags_mask: station flags that changed
 *	(bitmask of BIT(NL80211_STA_FLAG_...))
 * @sta_flags_set: station flags values
 *	(bitmask of BIT(NL80211_STA_FLAG_...))
387 388
 * @listen_interval: listen interval or -1 for no change
 * @aid: AID or zero for no change
Johannes Berg's avatar
Johannes Berg committed
389 390
 * @plink_action: plink action to take
 * @ht_capa: HT capabilities of station
391 392 393 394
 */
struct station_parameters {
	u8 *supported_rates;
	struct net_device *vlan;
395
	u32 sta_flags_mask, sta_flags_set;
396 397 398
	int listen_interval;
	u16 aid;
	u8 supported_rates_len;
399
	u8 plink_action;
400
	struct ieee80211_ht_cap *ht_capa;
401 402
};

403
/**
404
 * enum station_info_flags - station information flags
405
 *
406 407
 * Used by the driver to indicate which info in &struct station_info
 * it has filled in during get_station() or dump_station().
408
 *
409 410 411 412 413 414
 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
 * @STATION_INFO_RX_BYTES: @rx_bytes filled
 * @STATION_INFO_TX_BYTES: @tx_bytes filled
 * @STATION_INFO_LLID: @llid filled
 * @STATION_INFO_PLID: @plid filled
 * @STATION_INFO_PLINK_STATE: @plink_state filled
415
 * @STATION_INFO_SIGNAL: @signal filled
416
 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
417
 *  (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
418 419
 * @STATION_INFO_RX_PACKETS: @rx_packets filled
 * @STATION_INFO_TX_PACKETS: @tx_packets filled
420 421
 * @STATION_INFO_TX_RETRIES: @tx_retries filled
 * @STATION_INFO_TX_FAILED: @tx_failed filled
422
 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
423
 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
424
 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
425
 * @STATION_INFO_BSS_PARAM: @bss_param filled
426
 */
427 428 429 430 431 432 433
enum station_info_flags {
	STATION_INFO_INACTIVE_TIME	= 1<<0,
	STATION_INFO_RX_BYTES		= 1<<1,
	STATION_INFO_TX_BYTES		= 1<<2,
	STATION_INFO_LLID		= 1<<3,
	STATION_INFO_PLID		= 1<<4,
	STATION_INFO_PLINK_STATE	= 1<<5,
434 435
	STATION_INFO_SIGNAL		= 1<<6,
	STATION_INFO_TX_BITRATE		= 1<<7,
436 437
	STATION_INFO_RX_PACKETS		= 1<<8,
	STATION_INFO_TX_PACKETS		= 1<<9,
438 439
	STATION_INFO_TX_RETRIES		= 1<<10,
	STATION_INFO_TX_FAILED		= 1<<11,
440
	STATION_INFO_RX_DROP_MISC	= 1<<12,
441
	STATION_INFO_SIGNAL_AVG		= 1<<13,
442
	STATION_INFO_RX_BITRATE		= 1<<14,
443
	STATION_INFO_BSS_PARAM          = 1<<15,
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
};

/**
 * enum station_info_rate_flags - bitrate info flags
 *
 * Used by the driver to indicate the specific rate transmission
 * type for 802.11n transmissions.
 *
 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled
 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission
 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
 */
enum rate_info_flags {
	RATE_INFO_FLAGS_MCS		= 1<<0,
	RATE_INFO_FLAGS_40_MHZ_WIDTH	= 1<<1,
	RATE_INFO_FLAGS_SHORT_GI	= 1<<2,
};

/**
 * struct rate_info - bitrate information
 *
 * Information about a receiving or transmitting bitrate
 *
 * @flags: bitflag of flags from &enum rate_info_flags
 * @mcs: mcs index if struct describes a 802.11n bitrate
 * @legacy: bitrate in 100kbit/s for 802.11abg
 */
struct rate_info {
	u8 flags;
	u8 mcs;
	u16 legacy;
475 476
};

477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
/**
 * enum station_info_rate_flags - bitrate info flags
 *
 * Used by the driver to indicate the specific rate transmission
 * type for 802.11n transmissions.
 *
 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
 */
enum bss_param_flags {
	BSS_PARAM_FLAGS_CTS_PROT	= 1<<0,
	BSS_PARAM_FLAGS_SHORT_PREAMBLE	= 1<<1,
	BSS_PARAM_FLAGS_SHORT_SLOT_TIME	= 1<<2,
};

/**
 * struct sta_bss_parameters - BSS parameters for the attached station
 *
 * Information about the currently associated BSS
 *
 * @flags: bitflag of flags from &enum bss_param_flags
 * @dtim_period: DTIM period for the BSS
 * @beacon_interval: beacon interval
 */
struct sta_bss_parameters {
	u8 flags;
	u8 dtim_period;
	u16 beacon_interval;
};

508
/**
509
 * struct station_info - station information
510
 *
511
 * Station information filled by driver for get_station() and dump_station.
512
 *
513
 * @filled: bitflag of flags from &enum station_info_flags
514 515 516
 * @inactive_time: time since last station activity (tx/rx) in milliseconds
 * @rx_bytes: bytes received from this station
 * @tx_bytes: bytes transmitted to this station
517 518 519
 * @llid: mesh local link id
 * @plid: mesh peer link id
 * @plink_state: mesh peer link state
520
 * @signal: signal strength of last received packet in dBm
521
 * @signal_avg: signal strength average in dBm
522 523
 * @txrate: current unicast bitrate from this station
 * @rxrate: current unicast bitrate to this station
524 525
 * @rx_packets: packets received from this station
 * @tx_packets: packets transmitted to this station
526 527
 * @tx_retries: cumulative retry counts
 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
528
 * @rx_dropped_misc:  Dropped for un-specified reason.
529 530 531 532
 * @generation: generation number for nl80211 dumps.
 *	This number should increase every time the list of stations
 *	changes, i.e. when a station is added or removed, so that
 *	userspace can tell whether it got a consistent snapshot.
533
 */
534
struct station_info {
535 536 537 538
	u32 filled;
	u32 inactive_time;
	u32 rx_bytes;
	u32 tx_bytes;
539 540 541
	u16 llid;
	u16 plid;
	u8 plink_state;
542
	s8 signal;
543
	s8 signal_avg;
544
	struct rate_info txrate;
545
	struct rate_info rxrate;
546 547
	u32 rx_packets;
	u32 tx_packets;
548 549
	u32 tx_retries;
	u32 tx_failed;
550
	u32 rx_dropped_misc;
551
	struct sta_bss_parameters bss_param;
552 553

	int generation;
554 555
};

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
/**
 * enum monitor_flags - monitor flags
 *
 * Monitor interface configuration flags. Note that these must be the bits
 * according to the nl80211 flags.
 *
 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
 * @MONITOR_FLAG_CONTROL: pass control frames
 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
 */
enum monitor_flags {
	MONITOR_FLAG_FCSFAIL		= 1<<NL80211_MNTR_FLAG_FCSFAIL,
	MONITOR_FLAG_PLCPFAIL		= 1<<NL80211_MNTR_FLAG_PLCPFAIL,
	MONITOR_FLAG_CONTROL		= 1<<NL80211_MNTR_FLAG_CONTROL,
	MONITOR_FLAG_OTHER_BSS		= 1<<NL80211_MNTR_FLAG_OTHER_BSS,
	MONITOR_FLAG_COOK_FRAMES	= 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
};

576 577 578 579 580 581
/**
 * enum mpath_info_flags -  mesh path information flags
 *
 * Used by the driver to indicate which info in &struct mpath_info it has filled
 * in during get_station() or dump_station().
 *
Johannes Berg's avatar
Johannes Berg committed
582 583 584 585 586 587 588
 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
 * @MPATH_INFO_SN: @sn filled
 * @MPATH_INFO_METRIC: @metric filled
 * @MPATH_INFO_EXPTIME: @exptime filled
 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
 * @MPATH_INFO_FLAGS: @flags filled
589 590 591
 */
enum mpath_info_flags {
	MPATH_INFO_FRAME_QLEN		= BIT(0),
592
	MPATH_INFO_SN			= BIT(1),
593 594 595 596 597 598 599 600 601 602 603 604 605 606
	MPATH_INFO_METRIC		= BIT(2),
	MPATH_INFO_EXPTIME		= BIT(3),
	MPATH_INFO_DISCOVERY_TIMEOUT	= BIT(4),
	MPATH_INFO_DISCOVERY_RETRIES	= BIT(5),
	MPATH_INFO_FLAGS		= BIT(6),
};

/**
 * struct mpath_info - mesh path information
 *
 * Mesh path information filled by driver for get_mpath() and dump_mpath().
 *
 * @filled: bitfield of flags from &enum mpath_info_flags
 * @frame_qlen: number of queued frames for this destination
607
 * @sn: target sequence number
608 609 610 611 612
 * @metric: metric (cost) of this mesh path
 * @exptime: expiration time for the mesh path from now, in msecs
 * @flags: mesh path flags
 * @discovery_timeout: total mesh path discovery timeout, in msecs
 * @discovery_retries: mesh path discovery retries
613 614 615 616
 * @generation: generation number for nl80211 dumps.
 *	This number should increase every time the list of mesh paths
 *	changes, i.e. when a station is added or removed, so that
 *	userspace can tell whether it got a consistent snapshot.
617 618 619 620
 */
struct mpath_info {
	u32 filled;
	u32 frame_qlen;
621
	u32 sn;
622 623 624 625 626
	u32 metric;
	u32 exptime;
	u32 discovery_timeout;
	u8 discovery_retries;
	u8 flags;
627 628

	int generation;
629 630
};

631 632 633 634 635 636 637 638 639 640 641
/**
 * struct bss_parameters - BSS parameters
 *
 * Used to change BSS parameters (mainly for AP mode).
 *
 * @use_cts_prot: Whether to use CTS protection
 *	(0 = no, 1 = yes, -1 = do not change)
 * @use_short_preamble: Whether the use of short preambles is allowed
 *	(0 = no, 1 = yes, -1 = do not change)
 * @use_short_slot_time: Whether the use of short slot time is allowed
 *	(0 = no, 1 = yes, -1 = do not change)
642 643 644
 * @basic_rates: basic rates in IEEE 802.11 format
 *	(or NULL for no change)
 * @basic_rates_len: number of basic rates
645
 * @ap_isolate: do not forward packets between connected stations
646 647
 * @ht_opmode: HT Operation mode
 * 	(u16 = opmode, -1 = do not change)
648 649 650 651 652
 */
struct bss_parameters {
	int use_cts_prot;
	int use_short_preamble;
	int use_short_slot_time;
653 654
	u8 *basic_rates;
	u8 basic_rates_len;
655
	int ap_isolate;
656
	int ht_opmode;
657
};
658

659 660 661 662 663
/*
 * struct mesh_config - 802.11s mesh configuration
 *
 * These parameters can be changed while the mesh is active.
 */
664 665 666 667 668 669 670 671 672
struct mesh_config {
	/* Timeouts in ms */
	/* Mesh plink management parameters */
	u16 dot11MeshRetryTimeout;
	u16 dot11MeshConfirmTimeout;
	u16 dot11MeshHoldingTimeout;
	u16 dot11MeshMaxPeerLinks;
	u8  dot11MeshMaxRetries;
	u8  dot11MeshTTL;
673 674
	/* ttl used in path selection information elements */
	u8  element_ttl;
675 676 677 678 679 680 681 682
	bool auto_open_plinks;
	/* HWMP parameters */
	u8  dot11MeshHWMPmaxPREQretries;
	u32 path_refresh_time;
	u16 min_discovery_timeout;
	u32 dot11MeshHWMPactivePathTimeout;
	u16 dot11MeshHWMPpreqMinInterval;
	u16 dot11MeshHWMPnetDiameterTraversalTime;
683
	u8  dot11MeshHWMPRootMode;
684 685
};

686 687 688 689
/**
 * struct mesh_setup - 802.11s mesh setup configuration
 * @mesh_id: the mesh ID
 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
690 691
 * @path_sel_proto: which path selection protocol to use
 * @path_metric: which metric to use
692 693
 * @ie: vendor information elements (optional)
 * @ie_len: length of vendor information elements
694
 * @is_secure: or not
695 696 697 698 699 700
 *
 * These parameters are fixed when the mesh is created.
 */
struct mesh_setup {
	const u8 *mesh_id;
	u8 mesh_id_len;
701 702
	u8  path_sel_proto;
	u8  path_metric;
703 704
	const u8 *ie;
	u8 ie_len;
705
	bool is_secure;
706 707
};

708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
/**
 * struct ieee80211_txq_params - TX queue parameters
 * @queue: TX queue identifier (NL80211_TXQ_Q_*)
 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
 *	1..32767]
 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
 *	1..32767]
 * @aifs: Arbitration interframe space [0..255]
 */
struct ieee80211_txq_params {
	enum nl80211_txq_q queue;
	u16 txop;
	u16 cwmin;
	u16 cwmax;
	u8 aifs;
};

726 727 728
/* from net/wireless.h */
struct wiphy;

729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
/**
 * DOC: Scanning and BSS list handling
 *
 * The scanning process itself is fairly simple, but cfg80211 offers quite
 * a bit of helper functionality. To start a scan, the scan operation will
 * be invoked with a scan definition. This scan definition contains the
 * channels to scan, and the SSIDs to send probe requests for (including the
 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
 * probe. Additionally, a scan request may contain extra information elements
 * that should be added to the probe request. The IEs are guaranteed to be
 * well-formed, and will not exceed the maximum length the driver advertised
 * in the wiphy structure.
 *
 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
 * it is responsible for maintaining the BSS list; the driver should not
 * maintain a list itself. For this notification, various functions exist.
 *
 * Since drivers do not maintain a BSS list, there are also a number of
 * functions to search for a BSS and obtain information about it from the
 * BSS structure cfg80211 maintains. The BSS list is also made available
 * to userspace.
 */
751

752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
/**
 * struct cfg80211_ssid - SSID description
 * @ssid: the SSID
 * @ssid_len: length of the ssid
 */
struct cfg80211_ssid {
	u8 ssid[IEEE80211_MAX_SSID_LEN];
	u8 ssid_len;
};

/**
 * struct cfg80211_scan_request - scan request description
 *
 * @ssids: SSIDs to scan for (active scan only)
 * @n_ssids: number of SSIDs
 * @channels: channels to scan on.
768
 * @n_channels: total number of channels to scan
769 770
 * @ie: optional information element(s) to add into Probe Request or %NULL
 * @ie_len: length of ie in octets
771
 * @wiphy: the wiphy this was for
772
 * @dev: the interface
Johannes Berg's avatar
Johannes Berg committed
773
 * @aborted: (internal) scan request was notified as aborted
774 775 776 777 778
 */
struct cfg80211_scan_request {
	struct cfg80211_ssid *ssids;
	int n_ssids;
	u32 n_channels;
779
	const u8 *ie;
780
	size_t ie_len;
781 782 783

	/* internal */
	struct wiphy *wiphy;
784
	struct net_device *dev;
Johannes Berg's avatar
Johannes Berg committed
785
	bool aborted;
786 787 788

	/* keep last */
	struct ieee80211_channel *channels[0];
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
};

/**
 * enum cfg80211_signal_type - signal type
 *
 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
 */
enum cfg80211_signal_type {
	CFG80211_SIGNAL_TYPE_NONE,
	CFG80211_SIGNAL_TYPE_MBM,
	CFG80211_SIGNAL_TYPE_UNSPEC,
};

/**
 * struct cfg80211_bss - BSS description
 *
 * This structure describes a BSS (which may also be a mesh network)
 * for use in scan results and similar.
 *
Johannes Berg's avatar
Johannes Berg committed
810
 * @channel: channel this BSS is on
811 812 813 814 815
 * @bssid: BSSID of the BSS
 * @tsf: timestamp of last received update
 * @beacon_interval: the beacon interval as from the frame
 * @capability: the capability field in host byte order
 * @information_elements: the information elements (Note that there
816 817 818
 *	is no guarantee that these are well-formed!); this is a pointer to
 *	either the beacon_ies or proberesp_ies depending on whether Probe
 *	Response frame has been received
819
 * @len_information_elements: total length of the information elements
820 821 822 823
 * @beacon_ies: the information elements from the last Beacon frame
 * @len_beacon_ies: total length of the beacon_ies
 * @proberesp_ies: the information elements from the last Probe Response frame
 * @len_proberesp_ies: total length of the proberesp_ies
Johannes Berg's avatar
Johannes Berg committed
824
 * @signal: signal strength value (type depends on the wiphy's signal_type)
825
 * @free_priv: function pointer to free private data
826 827 828 829 830 831 832 833 834 835 836
 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
 */
struct cfg80211_bss {
	struct ieee80211_channel *channel;

	u8 bssid[ETH_ALEN];
	u64 tsf;
	u16 beacon_interval;
	u16 capability;
	u8 *information_elements;
	size_t len_information_elements;
837 838 839 840
	u8 *beacon_ies;
	size_t len_beacon_ies;
	u8 *proberesp_ies;
	size_t len_proberesp_ies;
841 842 843

	s32 signal;

844
	void (*free_priv)(struct cfg80211_bss *bss);
845 846 847
	u8 priv[0] __attribute__((__aligned__(sizeof(void *))));
};

848 849 850 851 852 853 854 855 856
/**
 * ieee80211_bss_get_ie - find IE with given ID
 * @bss: the bss to search
 * @ie: the IE ID
 * Returns %NULL if not found.
 */
const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);


857 858 859 860 861 862 863 864 865 866 867 868 869
/**
 * struct cfg80211_crypto_settings - Crypto settings
 * @wpa_versions: indicates which, if any, WPA versions are enabled
 *	(from enum nl80211_wpa_versions)
 * @cipher_group: group key cipher suite (or 0 if unset)
 * @n_ciphers_pairwise: number of AP supported unicast ciphers
 * @ciphers_pairwise: unicast key cipher suites
 * @n_akm_suites: number of AKM suites
 * @akm_suites: AKM suites
 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
 *	sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
 *	required to assume that the port is unauthorized until authorized by
 *	user space. Otherwise, port is marked authorized by default.
870 871 872 873
 * @control_port_ethertype: the control port protocol that should be
 *	allowed through even on unauthorized ports
 * @control_port_no_encrypt: TRUE to prevent encryption of control port
 *	protocol frames.
874 875 876 877 878 879 880 881 882
 */
struct cfg80211_crypto_settings {
	u32 wpa_versions;
	u32 cipher_group;
	int n_ciphers_pairwise;
	u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
	int n_akm_suites;
	u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
	bool control_port;
883 884
	__be16 control_port_ethertype;
	bool control_port_no_encrypt;
885 886
};

887 888 889 890 891
/**
 * struct cfg80211_auth_request - Authentication request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * authentication.
Johannes Berg's avatar
Johannes Berg committed
892 893
 *
 * @bss: The BSS to authenticate with.
894 895 896
 * @auth_type: Authentication type (algorithm)
 * @ie: Extra IEs to add to Authentication frame or %NULL
 * @ie_len: Length of ie buffer in octets
Johannes Berg's avatar
Johannes Berg committed
897 898 899
 * @key_len: length of WEP key for shared key authentication
 * @key_idx: index of WEP key for shared key authentication
 * @key: WEP key for shared key authentication
900 901 902 903
 * @local_state_change: This is a request for a local state only, i.e., no
 *	Authentication frame is to be transmitted and authentication state is
 *	to be changed without having to wait for a response from the peer STA
 *	(AP).
904 905
 */
struct cfg80211_auth_request {
Johannes Berg's avatar
Johannes Berg committed
906
	struct cfg80211_bss *bss;
907 908
	const u8 *ie;
	size_t ie_len;
Johannes Berg's avatar
Johannes Berg committed
909
	enum nl80211_auth_type auth_type;
Johannes Berg's avatar
Johannes Berg committed
910 911
	const u8 *key;
	u8 key_len, key_idx;
912
	bool local_state_change;
913 914 915 916 917 918 919
};

/**
 * struct cfg80211_assoc_request - (Re)Association request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * (re)association.
Johannes Berg's avatar
Johannes Berg committed
920
 * @bss: The BSS to associate with.
921 922
 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
 * @ie_len: Length of ie buffer in octets
923
 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
924
 * @crypto: crypto settings
925
 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame
926 927
 */
struct cfg80211_assoc_request {
Johannes Berg's avatar
Johannes Berg committed
928
	struct cfg80211_bss *bss;
929
	const u8 *ie, *prev_bssid;
930
	size_t ie_len;
931
	struct cfg80211_crypto_settings crypto;
Johannes Berg's avatar
Johannes Berg committed
932
	bool use_mfp;
933 934 935 936 937 938 939 940
};

/**
 * struct cfg80211_deauth_request - Deauthentication request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * deauthentication.
 *
Johannes Berg's avatar
Johannes Berg committed
941
 * @bss: the BSS to deauthenticate from
942 943
 * @ie: Extra IEs to add to Deauthentication frame or %NULL
 * @ie_len: Length of ie buffer in octets
Johannes Berg's avatar
Johannes Berg committed
944
 * @reason_code: The reason code for the deauthentication
945 946
 * @local_state_change: This is a request for a local state only, i.e., no
 *	Deauthentication frame is to be transmitted.
947 948
 */
struct cfg80211_deauth_request {
Johannes Berg's avatar
Johannes Berg committed
949
	struct cfg80211_bss *bss;
950 951
	const u8 *ie;
	size_t ie_len;
Johannes Berg's avatar
Johannes Berg committed
952
	u16 reason_code;
953
	bool local_state_change;
954 955 956 957 958 959 960 961
};

/**
 * struct cfg80211_disassoc_request - Disassociation request data
 *
 * This structure provides information needed to complete IEEE 802.11
 * disassocation.
 *
Johannes Berg's avatar
Johannes Berg committed
962
 * @bss: the BSS to disassociate from
963 964
 * @ie: Extra IEs to add to Disassociation frame or %NULL
 * @ie_len: Length of ie buffer in octets
Johannes Berg's avatar
Johannes Berg committed
965
 * @reason_code: The reason code for the disassociation
966 967
 * @local_state_change: This is a request for a local state only, i.e., no
 *	Disassociation frame is to be transmitted.
968 969
 */
struct cfg80211_disassoc_request {
Johannes Berg's avatar
Johannes Berg committed
970
	struct cfg80211_bss *bss;
971 972
	const u8 *ie;
	size_t ie_len;
Johannes Berg's avatar
Johannes Berg committed
973
	u16 reason_code;
974
	bool local_state_change;
975 976
};

Johannes Berg's avatar
Johannes Berg committed
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
/**
 * struct cfg80211_ibss_params - IBSS parameters
 *
 * This structure defines the IBSS parameters for the join_ibss()
 * method.
 *
 * @ssid: The SSID, will always be non-null.
 * @ssid_len: The length of the SSID, will always be non-zero.
 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
 *	search for IBSSs with a different BSSID.
 * @channel: The channel to use if no IBSS can be found to join.
 * @channel_fixed: The channel should be fixed -- do not search for
 *	IBSSs to join on other channels.
 * @ie: information element(s) to include in the beacon
 * @ie_len: length of that
992
 * @beacon_interval: beacon interval to use
Johannes Berg's avatar
Johannes Berg committed
993 994
 * @privacy: this is a protected network, keys will be configured
 *	after joining
995
 * @basic_rates: bitmap of basic rates to use when creating the IBSS
996
 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
Johannes Berg's avatar
Johannes Berg committed
997 998 999 1000 1001 1002 1003
 */
struct cfg80211_ibss_params {
	u8 *ssid;
	u8 *bssid;
	struct ieee80211_channel *channel;
	u8 *ie;
	u8 ssid_len, ie_len;
1004
	u16 beacon_interval;
1005
	u32 basic_rates;
Johannes Berg's avatar
Johannes Berg committed
1006
	bool channel_fixed;
Johannes Berg's avatar
Johannes Berg committed
1007
	bool privacy;
1008
	int mcast_rate[IEEE80211_NUM_BANDS];
Johannes Berg's avatar
Johannes Berg committed
1009 1010
};

1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
/**
 * struct cfg80211_connect_params - Connection parameters
 *
 * This structure provides information needed to complete IEEE 802.11
 * authentication and association.
 *
 * @channel: The channel to use or %NULL if not specified (auto-select based
 *	on scan results)
 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
 *	results)
 * @ssid: SSID
 * @ssid_len: Length of ssid in octets
 * @auth_type: Authentication type (algorithm)
Johannes Berg's avatar
Johannes Berg committed
1024 1025
 * @ie: IEs for association request
 * @ie_len: Length of assoc_ie in octets
1026 1027
 * @privacy: indicates whether privacy-enabled APs should be used
 * @crypto: crypto settings
Johannes Berg's avatar
Johannes Berg committed
1028 1029 1030
 * @key_len: length of WEP key for shared key authentication
 * @key_idx: index of WEP key for shared key authentication
 * @key: WEP key for shared key authentication
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
 */
struct cfg80211_connect_params {
	struct ieee80211_channel *channel;
	u8 *bssid;
	u8 *ssid;
	size_t ssid_len;
	enum nl80211_auth_type auth_type;
	u8 *ie;
	size_t ie_len;
	bool privacy;
	struct cfg80211_crypto_settings crypto;
Johannes Berg's avatar
Johannes Berg committed
1042 1043
	const u8 *key;
	u8 key_len, key_idx;
1044 1045
};

1046 1047
/**
 * enum wiphy_params_flags - set_wiphy_params bitfield values
Johannes Berg's avatar
Johannes Berg committed
1048 1049 1050 1051 1052
 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
1053 1054 1055 1056 1057 1058
 */
enum wiphy_params_flags {
	WIPHY_PARAM_RETRY_SHORT		= 1 << 0,
	WIPHY_PARAM_RETRY_LONG		= 1 << 1,
	WIPHY_PARAM_FRAG_THRESHOLD	= 1 << 2,
	WIPHY_PARAM_RTS_THRESHOLD	= 1 << 3,
1059
	WIPHY_PARAM_COVERAGE_CLASS	= 1 << 4,
1060 1061
};

Johannes Berg's avatar
Johannes Berg committed
1062 1063 1064 1065 1066 1067
/*
 * cfg80211_bitrate_mask - masks for bitrate control
 */
struct cfg80211_bitrate_mask {
	struct {
		u32 legacy;
1068 1069
		/* TODO: add support for masking MCS rates; e.g.: */
		/* u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; */
Johannes Berg's avatar
Johannes Berg committed
1070 1071
	} control[IEEE80211_NUM_BANDS];
};
Samuel Ortiz's avatar
Samuel Ortiz committed
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
/**
 * struct cfg80211_pmksa - PMK Security Association
 *
 * This structure is passed to the set/del_pmksa() method for PMKSA
 * caching.
 *
 * @bssid: The AP's BSSID.
 * @pmkid: The PMK material itself.
 */
struct cfg80211_pmksa {
	u8 *bssid;
	u8 *pmkid;
};
Johannes Berg's avatar
Johannes Berg committed
1085

1086 1087 1088 1089 1090 1091 1092 1093 1094
/**
 * struct cfg80211_ops - backend description for wireless configuration
 *
 * This struct is registered by fullmac card drivers and/or wireless stacks
 * in order to handle configuration requests on their interfaces.
 *
 * All callbacks except where otherwise noted should return 0
 * on success or a negative error code.
 *
1095 1096 1097 1098
 * All operations are currently invoked under rtnl for consistency with the
 * wireless extensions but this is subject to reevaluation as soon as this
 * code is used more widely and we have a first user without wext.
 *
Johannes Berg's avatar
Johannes Berg committed
1099 1100 1101
 * @suspend: wiphy device needs to be suspended
 * @resume: wiphy device needs to be resumed
 *
Johannes Berg's avatar
Johannes Berg committed
1102
 * @add_virtual_intf: create a new virtual interface with the given name,
1103
 *	must set the struct wireless_dev's iftype. Beware: You must create
1104 1105
 *	the new netdev in the wiphy's network namespace! Returns the netdev,
 *	or an ERR_PTR.
1106 1107
 *
 * @del_virtual_intf: remove the virtual interface determined by ifindex.
1108
 *
Johannes Berg's avatar
Johannes Berg committed
1109 1110
 * @change_virtual_intf: change type/configuration of virtual interface,
 *	keep the struct wireless_dev's iftype updated.
1111
 *
1112 1113 1114 1115 1116 1117
 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
 *	when adding a group key.
 *
 * @get_key: get information about the key with the given parameters.
 *	@mac_addr will be %NULL when requesting information for a group
 *	key. All pointers given to the @callback function need not be valid
1118 1119
 *	after it returns. This function should return an error if it is
 *	not possible to retrieve the key, -ENOENT if it doesn't exist.
1120 1121
 *
 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
1122
 *	and @key_index, return -ENOENT if the key doesn't exist.
1123 1124
 *
 * @set_default_key: set the default key on an interface
1125
 *
1126 1127
 * @set_default_mgmt_key: set the default management frame key on an interface
 *
1128 1129 1130 1131 1132 1133
 * @add_beacon: Add a beacon with given parameters, @head, @interval
 *	and @dtim_period will be valid, @tail is optional.
 * @set_beacon: Change the beacon parameters for an access point mode
 *	interface. This should reject the call when no beacon has been
 *	configured.
 * @del_beacon: Remove beacon configuration and stop sending the beacon.
1134 1135 1136 1137
 *
 * @add_station: Add a new station.
 * @del_station: Remove a station; @mac may be NULL to remove all stations.
 * @change_station: Modify a given station.
Johannes Berg's avatar
Johannes Berg committed
1138 1139 1140 1141 1142 1143 1144 1145
 * @get_station: get station information for the station identified by @mac
 * @dump_station: dump station callback -- resume dump at index @idx
 *
 * @add_mpath: add a fixed mesh path
 * @del_mpath: delete a given mesh path
 * @change_mpath: change a given mesh path
 * @get_mpath: get a mesh path for the given parameters
 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
1146 1147
 * @join_mesh: join the mesh network with the specified parameters
 * @leave_mesh: leave the current mesh network
1148
 *
1149
 * @get_mesh_config: Get the current mesh configuration
1150
 *
1151
 * @update_mesh_config: Update mesh parameters on a running mesh.
1152 1153 1154
 *	The mask is a bitfield which tells us which parameters to
 *	set, and which to leave alone.
 *
1155
 * @change_bss: Modify parameters for a given BSS.
1156 1157
 *
 * @set_txq_params: Set TX queue parameters
1158
 *
1159 1160 1161 1162 1163
 * @set_channel: Set channel for a given wireless interface. Some devices
 *	may support multi-channel operation (by channel hopping) so cfg80211
 *	doesn't verify much. Note, however, that the passed netdev may be
 *	%NULL as well if the user requested changing the channel for the
 *	device itself, or for a monitor interface.
1164
 *
1165 1166 1167 1168
 * @scan: Request to do a scan. If returning zero, the scan request is given
 *	the driver, and will be valid until passed to cfg80211_scan_done().
 *	For scan results, call cfg80211_inform_bss(); you can call this outside
 *	the scan/scan_done bracket too.
1169 1170 1171 1172 1173
 *
 * @auth: Request to authenticate with the specified peer
 * @assoc: Request to (re)associate with the specified peer
 * @deauth: Request to deauthenticate from the specified peer
 * @disassoc: Request to disassociate from the specified peer
Johannes Berg's avatar
Johannes Berg committed
1174
 *
1175 1176 1177 1178 1179 1180
 * @connect: Connect to the ESS with the specified parameters. When connected,
 *	call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS.
 *	If the connection fails for some reason, call cfg80211_connect_result()
 *	with the status from the AP.
 * @disconnect: Disconnect from the BSS/ESS.
 *
Johannes Berg's avatar
Johannes Berg committed
1181 1182 1183 1184
 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
 *	cfg80211_ibss_joined(), also call that function when changing BSSID due
 *	to a merge.
 * @leave_ibss: Leave the IBSS.
1185 1186 1187 1188 1189
 *
 * @set_wiphy_params: Notify that wiphy parameters have changed;
 *	@changed bitfield (see &enum wiphy_params_flags) describes which values
 *	have changed. The actual parameter values are available in
 *	struct wiphy. If returning an error, no value should be changed.
1190 1191 1192
 *
 * @set_tx_power: set the transmit power according to the parameters
 * @get_tx_power: store the current TX power into the dbm variable;
Johannes Berg's avatar
Johannes Berg committed
1193 1194
 *	return 0 if successful
 *
Johannes Berg's avatar
Johannes Berg committed
1195 1196
 * @set_wds_peer: set the WDS peer for a WDS interface
 *
Johannes Berg's avatar
Johannes Berg committed
1197 1198
 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
 *	functions to adjust rfkill hw state
1199
 *
1200 1201
 * @dump_survey: get site survey information.
 *
1202 1203 1204 1205 1206 1207 1208 1209
 * @remain_on_channel: Request the driver to remain awake on the specified
 *	channel for the specified duration to complete an off-channel
 *	operation (e.g., public action frame exchange). When the driver is
 *	ready on the requested channel, it must indicate this with an event
 *	notification by calling cfg80211_ready_on_channel().
 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
 *	This allows the operation to be terminated prior to timeout based on
 *	the duration value.
1210 1211 1212
 * @mgmt_tx: Transmit a management frame.
 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
 *	frame on another channel
1213
 *
1214
 * @testmode_cmd: run a test mode command
Samuel Ortiz's avatar
Samuel Ortiz committed
1215
 *
Johannes Berg's avatar
Johannes Berg committed
1216 1217
 * @set_bitrate_mask: set the bitrate mask configuration
 *
Samuel Ortiz's avatar
Samuel Ortiz committed
1218 1219 1220 1221 1222
 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
 *	devices running firmwares capable of generating the (re) association
 *	RSN IE. It allows for faster roaming between WPA2 BSSIDs.
 * @del_pmksa: Delete a cached PMKID.
 * @flush_pmksa: Flush all cached PMKIDs.
1223 1224
 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
 *	allows the driver to adjust the dynamic ps timeout value.
1225
 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
Samuel Ortiz's avatar
Samuel Ortiz committed
1226
 *
1227 1228 1229
 * @mgmt_frame_register: Notify driver that a management frame type was
 *	registered. Note that this callback may not sleep, and cannot run
 *	concurrently with itself.
1230 1231 1232 1233 1234 1235 1236
 *
 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
 *	Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
 *	reject TX/RX mask combinations they cannot support by returning -EINVAL
 *	(also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
 *
 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1237 1238 1239 1240
 *
 * @set_ringparam: Set tx and rx ring sizes.
 *
 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1241 1242
 */
struct cfg80211_ops {
Johannes Berg's avatar
Johannes Berg committed
1243 1244 1245
	int	(*suspend)(struct wiphy *wiphy);
	int	(*resume)(struct wiphy *wiphy);

1246 1247 1248 1249 1250
	struct net_device * (*add_virtual_intf)(struct wiphy *wiphy,
						char *name,
						enum nl80211_iftype type,
						u32 *flags,
						struct vif_params *params);
1251
	int	(*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev);
1252 1253
	int	(*change_virtual_intf)(struct wiphy *wiphy,
				       struct net_device *dev,
1254 1255
				       enum nl80211_iftype type, u32 *flags,
				       struct vif_params *params);
1256 1257

	int	(*add_key)(struct wiphy *wiphy, struct net_device *netdev,
1258
			   u8 key_index, bool pairwise, const u8 *mac_addr,