cfg80211.h 139 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
#include <linux/bug.h>
17 18
#include <linux/netlink.h>
#include <linux/skbuff.h>
19
#include <linux/nl80211.h>
20 21
#include <linux/if_ether.h>
#include <linux/ieee80211.h>
22
#include <linux/net.h>
Johannes Berg's avatar
Johannes Berg committed
23 24
#include <net/regulatory.h>

25 26 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
/**
 * 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.
 */

62 63
struct wiphy;

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

/**
 * enum ieee80211_band - supported frequency bands
 *
 * The bands are assigned this way because the supported
 * bitrates differ in these bands.
73
 *
Johannes Berg's avatar
Johannes Berg committed
74 75
 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band
 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7)
76
 * @IEEE80211_BAND_60GHZ: around 60 GHz band (58.32 - 64.80 GHz)
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,
82
	IEEE80211_BAND_60GHZ = NL80211_BAND_60GHZ,
Johannes Berg's avatar
Johannes Berg committed
83 84 85 86

	/* keep last */
	IEEE80211_NUM_BANDS
};
87

88
/**
Johannes Berg's avatar
Johannes Berg committed
89 90 91 92 93 94 95 96 97
 * 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.
98
 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
Johannes Berg's avatar
Johannes Berg committed
99
 * 	is not permitted.
100
 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
Johannes Berg's avatar
Johannes Berg committed
101
 * 	is not permitted.
102
 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
103
 */
Johannes Berg's avatar
Johannes Berg committed
104 105 106 107 108
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,
109 110
	IEEE80211_CHAN_NO_HT40PLUS	= 1<<4,
	IEEE80211_CHAN_NO_HT40MINUS	= 1<<5,
111
	IEEE80211_CHAN_NO_OFDM		= 1<<6,
112 113
};

114
#define IEEE80211_CHAN_NO_HT40 \
115
	(IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
116

Johannes Berg's avatar
Johannes Berg committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130
/**
 * 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)
131
 * @max_reg_power: maximum regulatory transmission power (in dBm)
Johannes Berg's avatar
Johannes Berg committed
132 133
 * @beacon_found: helper to regulatory code to indicate when a beacon
 *	has been found on this channel. Use regulatory_hint_found_beacon()
134
 *	to enable this, this is useful only on 5 GHz band.
Johannes Berg's avatar
Johannes Berg committed
135 136
 * @orig_mag: internal use
 * @orig_mpwr: internal use
Andy Green's avatar
Andy Green committed
137
 */
Johannes Berg's avatar
Johannes Berg committed
138 139 140 141 142 143 144
struct ieee80211_channel {
	enum ieee80211_band band;
	u16 center_freq;
	u16 hw_value;
	u32 flags;
	int max_antenna_gain;
	int max_power;
145
	int max_reg_power;
Johannes Berg's avatar
Johannes Berg committed
146 147 148 149 150
	bool beacon_found;
	u32 orig_flags;
	int orig_mag, orig_mpwr;
};

Andy Green's avatar
Andy Green committed
151
/**
Johannes Berg's avatar
Johannes Berg committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
 * 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
171
 */
Johannes Berg's avatar
Johannes Berg committed
172 173 174 175 176 177 178
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
179

Johannes Berg's avatar
Johannes Berg committed
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
/**
 * 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
199

Johannes Berg's avatar
Johannes Berg committed
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
/**
 * 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
218 219
};

220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
/**
 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
 *
 * This structure describes most essential parameters needed
 * to describe 802.11ac VHT capabilities for an STA.
 *
 * @vht_supported: is VHT supported by the STA
 * @cap: VHT capabilities map as described in 802.11ac spec
 * @vht_mcs: Supported VHT MCS rates
 */
struct ieee80211_sta_vht_cap {
	bool vht_supported;
	u32 cap; /* use IEEE80211_VHT_CAP_ */
	struct ieee80211_vht_mcs_info vht_mcs;
};

Johannes Berg's avatar
Johannes Berg committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249
/**
 * 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
250
 * @ht_cap: HT capabilities in this band
251
 * @vht_cap: VHT capabilities in this band
Johannes Berg's avatar
Johannes Berg committed
252 253 254 255 256 257 258 259
 */
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;
260
	struct ieee80211_sta_vht_cap vht_cap;
Johannes Berg's avatar
Johannes Berg committed
261
};
Andy Green's avatar
Andy Green committed
262

Johannes Berg's avatar
Johannes Berg committed
263 264 265
/*
 * Wireless hardware/device configuration structures and methods
 */
Andy Green's avatar
Andy Green committed
266

267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
/**
 * 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
282 283
/**
 * struct vif_params - describes virtual interface parameters
284
 * @use_4addr: use 4-address frames
285 286 287
 * @macaddr: address to use for this virtual interface. This will only
 * 	be used for non-netdevice interfaces. If this parameter is set
 * 	to zero address the driver may determine the address as needed.
Johannes Berg's avatar
Johannes Berg committed
288 289
 */
struct vif_params {
290
       int use_4addr;
291
       u8 macaddr[ETH_ALEN];
Johannes Berg's avatar
Johannes Berg committed
292
};
Andy Green's avatar
Andy Green committed
293

Johannes Berg's avatar
Johannes Berg committed
294
/**
295 296 297 298 299 300 301 302 303 304
 * 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
305
 * @seq_len: length of @seq.
306 307 308 309 310 311 312 313 314
 */
struct key_params {
	u8 *key;
	u8 *seq;
	int key_len;
	int seq_len;
	u32 cipher;
};

315 316 317
/**
 * struct cfg80211_chan_def - channel definition
 * @chan: the (control) channel
318 319 320 321
 * @width: channel width
 * @center_freq1: center frequency of first segment
 * @center_freq2: center frequency of second segment
 *	(only with 80+80 MHz)
322 323 324
 */
struct cfg80211_chan_def {
	struct ieee80211_channel *chan;
325 326 327
	enum nl80211_chan_width width;
	u32 center_freq1;
	u32 center_freq2;
328 329
};

330 331 332 333
/**
 * cfg80211_get_chandef_type - return old channel type from chandef
 * @chandef: the channel definition
 *
334
 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
335 336
 * chandef, which must have a bandwidth allowing this conversion.
 */
337 338 339
static inline enum nl80211_channel_type
cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
{
340 341 342 343 344 345 346 347 348 349 350 351 352
	switch (chandef->width) {
	case NL80211_CHAN_WIDTH_20_NOHT:
		return NL80211_CHAN_NO_HT;
	case NL80211_CHAN_WIDTH_20:
		return NL80211_CHAN_HT20;
	case NL80211_CHAN_WIDTH_40:
		if (chandef->center_freq1 > chandef->chan->center_freq)
			return NL80211_CHAN_HT40PLUS;
		return NL80211_CHAN_HT40MINUS;
	default:
		WARN_ON(1);
		return NL80211_CHAN_NO_HT;
	}
353 354
}

355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
/**
 * cfg80211_chandef_create - create channel definition using channel type
 * @chandef: the channel definition struct to fill
 * @channel: the control channel
 * @chantype: the channel type
 *
 * Given a channel type, create a channel definition.
 */
void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
			     struct ieee80211_channel *channel,
			     enum nl80211_channel_type chantype);

/**
 * cfg80211_chandef_identical - check if two channel definitions are identical
 * @chandef1: first channel definition
 * @chandef2: second channel definition
 *
372
 * Return: %true if the channels defined by the channel definitions are
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
 * identical, %false otherwise.
 */
static inline bool
cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
			   const struct cfg80211_chan_def *chandef2)
{
	return (chandef1->chan == chandef2->chan &&
		chandef1->width == chandef2->width &&
		chandef1->center_freq1 == chandef2->center_freq1 &&
		chandef1->center_freq2 == chandef2->center_freq2);
}

/**
 * cfg80211_chandef_compatible - check if two channel definitions are compatible
 * @chandef1: first channel definition
 * @chandef2: second channel definition
 *
390
 * Return: %NULL if the given channel definitions are incompatible,
391 392 393 394 395 396
 * chandef1 or chandef2 otherwise.
 */
const struct cfg80211_chan_def *
cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
			    const struct cfg80211_chan_def *chandef2);

397 398 399
/**
 * cfg80211_chandef_valid - check if a channel definition is valid
 * @chandef: the channel definition to check
400
 * Return: %true if the channel definition is valid. %false otherwise.
401 402 403 404 405 406 407
 */
bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);

/**
 * cfg80211_chandef_usable - check if secondary channels can be used
 * @wiphy: the wiphy to validate against
 * @chandef: the channel definition to check
408 409
 * @prohibited_flags: the regulatory channel flags that must not be set
 * Return: %true if secondary channels are usable. %false otherwise.
410 411 412 413 414
 */
bool cfg80211_chandef_usable(struct wiphy *wiphy,
			     const struct cfg80211_chan_def *chandef,
			     u32 prohibited_flags);

415 416 417
/**
 * enum survey_info_flags - survey information flags
 *
Johannes Berg's avatar
Johannes Berg committed
418
 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
419
 * @SURVEY_INFO_IN_USE: channel is currently being used
420 421 422 423 424
 * @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
425
 *
426 427 428 429 430
 * 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,
431
	SURVEY_INFO_IN_USE = 1<<1,
432 433 434 435 436
	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,
437 438 439 440 441 442 443 444 445
};

/**
 * 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
446 447 448 449 450
 * @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
451
 *
Johannes Berg's avatar
Johannes Berg committed
452 453
 * Used by dump_survey() to report back per-channel survey information.
 *
454 455 456 457 458
 * This structure can later be expanded with things like
 * channel duty cycle etc.
 */
struct survey_info {
	struct ieee80211_channel *channel;
459 460 461 462 463
	u64 channel_time;
	u64 channel_time_busy;
	u64 channel_time_ext_busy;
	u64 channel_time_rx;
	u64 channel_time_tx;
464 465 466 467
	u32 filled;
	s8 noise;
};

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
/**
 * 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.
 * @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.
 */
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;
	__be16 control_port_ethertype;
	bool control_port_no_encrypt;
};

498
/**
499
 * struct cfg80211_beacon_data - beacon data
500 501 502 503 504 505
 * @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
 * @head_len: length of @head
 * @tail_len: length of @tail
506 507 508 509 510 511 512 513
 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
 * @beacon_ies_len: length of beacon_ies in octets
 * @proberesp_ies: extra information element(s) to add into Probe Response
 *	frames or %NULL
 * @proberesp_ies_len: length of proberesp_ies in octets
 * @assocresp_ies: extra information element(s) to add into (Re)Association
 *	Response frames or %NULL
 * @assocresp_ies_len: length of assocresp_ies in octets
514 515
 * @probe_resp_len: length of probe response template (@probe_resp)
 * @probe_resp: probe response template (AP mode only)
516
 */
517 518 519 520 521 522 523 524 525 526 527 528 529 530
struct cfg80211_beacon_data {
	const u8 *head, *tail;
	const u8 *beacon_ies;
	const u8 *proberesp_ies;
	const u8 *assocresp_ies;
	const u8 *probe_resp;

	size_t head_len, tail_len;
	size_t beacon_ies_len;
	size_t proberesp_ies_len;
	size_t assocresp_ies_len;
	size_t probe_resp_len;
};

531 532 533 534
struct mac_address {
	u8 addr[ETH_ALEN];
};

535 536 537 538
/**
 * struct cfg80211_acl_data - Access control list data
 *
 * @acl_policy: ACL policy to be applied on the station's
Johannes Berg's avatar
Johannes Berg committed
539
 *	entry specified by mac_addr
540 541 542 543 544 545 546 547 548 549 550
 * @n_acl_entries: Number of MAC address entries passed
 * @mac_addrs: List of MAC addresses of stations to be used for ACL
 */
struct cfg80211_acl_data {
	enum nl80211_acl_policy acl_policy;
	int n_acl_entries;

	/* Keep it last */
	struct mac_address mac_addrs[];
};

551 552 553 554 555
/**
 * struct cfg80211_ap_settings - AP configuration
 *
 * Used to configure an AP interface.
 *
556
 * @chandef: defines the channel to use
557 558 559 560 561 562 563 564 565 566
 * @beacon: beacon data
 * @beacon_interval: beacon interval
 * @dtim_period: DTIM period
 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
 *	user space)
 * @ssid_len: length of @ssid
 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
 * @crypto: crypto settings
 * @privacy: the BSS uses privacy
 * @auth_type: Authentication type (algorithm)
567
 * @inactivity_timeout: time in seconds to determine station's inactivity.
568 569
 * @p2p_ctwindow: P2P CT Window
 * @p2p_opp_ps: P2P opportunistic PS
570 571
 * @acl: ACL configuration used by the drivers which has support for
 *	MAC address based access control
572 573
 */
struct cfg80211_ap_settings {
574
	struct cfg80211_chan_def chandef;
575

576 577 578
	struct cfg80211_beacon_data beacon;

	int beacon_interval, dtim_period;
579 580 581
	const u8 *ssid;
	size_t ssid_len;
	enum nl80211_hidden_ssid hidden_ssid;
582 583 584
	struct cfg80211_crypto_settings crypto;
	bool privacy;
	enum nl80211_auth_type auth_type;
585
	int inactivity_timeout;
586 587
	u8 p2p_ctwindow;
	bool p2p_opp_ps;
588
	const struct cfg80211_acl_data *acl;
589 590
};

591 592 593 594 595
/**
 * 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
596
 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer
597 598 599 600 601 602 603
 */
enum plink_actions {
	PLINK_ACTION_INVALID,
	PLINK_ACTION_OPEN,
	PLINK_ACTION_BLOCK,
};

604 605 606 607 608 609 610 611 612 613 614
/**
 * enum station_parameters_apply_mask - station parameter values to apply
 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
 *
 * Not all station parameters have in-band "no change" signalling,
 * for those that don't these flags will are used.
 */
enum station_parameters_apply_mask {
	STATION_PARAM_APPLY_UAPSD = BIT(0),
};

615 616 617 618 619 620 621 622 623
/**
 * 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
624 625 626 627
 * @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_...))
628 629
 * @listen_interval: listen interval or -1 for no change
 * @aid: AID or zero for no change
Johannes Berg's avatar
Johannes Berg committed
630
 * @plink_action: plink action to take
631
 * @plink_state: set the peer link state for a station
Johannes Berg's avatar
Johannes Berg committed
632
 * @ht_capa: HT capabilities of station
633
 * @vht_capa: VHT capabilities of station
634 635 636 637
 * @uapsd_queues: bitmap of queues configured for uapsd. same format
 *	as the AC bitmap in the QoS info field
 * @max_sp: max Service Period. same format as the MAX_SP in the
 *	QoS info field (but already shifted down)
638 639 640
 * @sta_modify_mask: bitmap indicating which parameters changed
 *	(for those that don't have a natural "no change" value),
 *	see &enum station_parameters_apply_mask
641 642
 * @local_pm: local link-specific mesh power save mode (no change when set
 *	to unknown)
643 644 645 646
 */
struct station_parameters {
	u8 *supported_rates;
	struct net_device *vlan;
647
	u32 sta_flags_mask, sta_flags_set;
648
	u32 sta_modify_mask;
649 650 651
	int listen_interval;
	u16 aid;
	u8 supported_rates_len;
652
	u8 plink_action;
653
	u8 plink_state;
654
	struct ieee80211_ht_cap *ht_capa;
655
	struct ieee80211_vht_cap *vht_capa;
656 657
	u8 uapsd_queues;
	u8 max_sp;
658
	enum nl80211_mesh_power_mode local_pm;
659 660
};

661
/**
662
 * enum station_info_flags - station information flags
663
 *
664 665
 * Used by the driver to indicate which info in &struct station_info
 * it has filled in during get_station() or dump_station().
666
 *
667 668 669
 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled
 * @STATION_INFO_RX_BYTES: @rx_bytes filled
 * @STATION_INFO_TX_BYTES: @tx_bytes filled
Johannes Berg's avatar
Johannes Berg committed
670 671
 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
672 673 674
 * @STATION_INFO_LLID: @llid filled
 * @STATION_INFO_PLID: @plid filled
 * @STATION_INFO_PLINK_STATE: @plink_state filled
675
 * @STATION_INFO_SIGNAL: @signal filled
676
 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
677
 *  (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
678 679
 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
680 681
 * @STATION_INFO_TX_RETRIES: @tx_retries filled
 * @STATION_INFO_TX_FAILED: @tx_failed filled
682
 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
683
 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
684
 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
685
 * @STATION_INFO_BSS_PARAM: @bss_param filled
686
 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
687
 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
688
 * @STATION_INFO_STA_FLAGS: @sta_flags filled
689
 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
690
 * @STATION_INFO_T_OFFSET: @t_offset filled
691 692 693
 * @STATION_INFO_LOCAL_PM: @local_pm filled
 * @STATION_INFO_PEER_PM: @peer_pm filled
 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
694
 */
695 696 697 698 699 700 701
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,
702 703
	STATION_INFO_SIGNAL		= 1<<6,
	STATION_INFO_TX_BITRATE		= 1<<7,
704 705
	STATION_INFO_RX_PACKETS		= 1<<8,
	STATION_INFO_TX_PACKETS		= 1<<9,
706 707
	STATION_INFO_TX_RETRIES		= 1<<10,
	STATION_INFO_TX_FAILED		= 1<<11,
708
	STATION_INFO_RX_DROP_MISC	= 1<<12,
709
	STATION_INFO_SIGNAL_AVG		= 1<<13,
710
	STATION_INFO_RX_BITRATE		= 1<<14,
711
	STATION_INFO_BSS_PARAM          = 1<<15,
712
	STATION_INFO_CONNECTED_TIME	= 1<<16,
713
	STATION_INFO_ASSOC_REQ_IES	= 1<<17,
714
	STATION_INFO_STA_FLAGS		= 1<<18,
715 716
	STATION_INFO_BEACON_LOSS_COUNT	= 1<<19,
	STATION_INFO_T_OFFSET		= 1<<20,
717 718 719
	STATION_INFO_LOCAL_PM		= 1<<21,
	STATION_INFO_PEER_PM		= 1<<22,
	STATION_INFO_NONPEER_PM		= 1<<23,
720 721
	STATION_INFO_RX_BYTES64		= 1<<24,
	STATION_INFO_TX_BYTES64		= 1<<25,
722 723 724 725 726 727 728 729
};

/**
 * enum station_info_rate_flags - bitrate info flags
 *
 * Used by the driver to indicate the specific rate transmission
 * type for 802.11n transmissions.
 *
730 731 732 733 734 735
 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 MHz width transmission
 * @RATE_INFO_FLAGS_80_MHZ_WIDTH: 80 MHz width transmission
 * @RATE_INFO_FLAGS_80P80_MHZ_WIDTH: 80+80 MHz width transmission
 * @RATE_INFO_FLAGS_160_MHZ_WIDTH: 160 MHz width transmission
736
 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
737
 * @RATE_INFO_FLAGS_60G: 60GHz MCS
738 739
 */
enum rate_info_flags {
740 741 742 743 744 745 746 747
	RATE_INFO_FLAGS_MCS			= BIT(0),
	RATE_INFO_FLAGS_VHT_MCS			= BIT(1),
	RATE_INFO_FLAGS_40_MHZ_WIDTH		= BIT(2),
	RATE_INFO_FLAGS_80_MHZ_WIDTH		= BIT(3),
	RATE_INFO_FLAGS_80P80_MHZ_WIDTH		= BIT(4),
	RATE_INFO_FLAGS_160_MHZ_WIDTH		= BIT(5),
	RATE_INFO_FLAGS_SHORT_GI		= BIT(6),
	RATE_INFO_FLAGS_60G			= BIT(7),
748 749 750 751 752 753 754 755 756 757
};

/**
 * 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
758
 * @nss: number of streams (VHT only)
759 760 761 762 763
 */
struct rate_info {
	u8 flags;
	u8 mcs;
	u16 legacy;
764
	u8 nss;
765 766
};

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
/**
 * 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;
};

798
/**
799
 * struct station_info - station information
800
 *
801
 * Station information filled by driver for get_station() and dump_station.
802
 *
803
 * @filled: bitflag of flags from &enum station_info_flags
804
 * @connected_time: time(in secs) since a station is last connected
805 806 807
 * @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
808 809 810
 * @llid: mesh local link id
 * @plid: mesh peer link id
 * @plink_state: mesh peer link state
811 812 813 814
 * @signal: The signal strength, type depends on the wiphy's signal_type.
 *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
 *	For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
815 816
 * @txrate: current unicast bitrate from this station
 * @rxrate: current unicast bitrate to this station
817 818
 * @rx_packets: packets received from this station
 * @tx_packets: packets transmitted to this station
819 820
 * @tx_retries: cumulative retry counts
 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
821
 * @rx_dropped_misc:  Dropped for un-specified reason.
822
 * @bss_param: current BSS parameters
823 824 825 826
 * @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.
827 828 829 830 831
 * @assoc_req_ies: IEs from (Re)Association Request.
 *	This is used only when in AP mode with drivers that do not use
 *	user space MLME/SME implementation. The information is provided for
 *	the cfg80211_new_sta() calls to notify user space of the IEs.
 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
832
 * @sta_flags: station flags mask & values
833
 * @beacon_loss_count: Number of times beacon loss event has triggered.
834
 * @t_offset: Time offset of the station relative to this host.
835 836 837
 * @local_pm: local mesh STA power save mode
 * @peer_pm: peer mesh STA power save mode
 * @nonpeer_pm: non-peer mesh STA power save mode
838
 */
839
struct station_info {
840
	u32 filled;
841
	u32 connected_time;
842
	u32 inactive_time;
843 844
	u64 rx_bytes;
	u64 tx_bytes;
845 846 847
	u16 llid;
	u16 plid;
	u8 plink_state;
848
	s8 signal;
849
	s8 signal_avg;
850
	struct rate_info txrate;
851
	struct rate_info rxrate;
852 853
	u32 rx_packets;
	u32 tx_packets;
854 855
	u32 tx_retries;
	u32 tx_failed;
856
	u32 rx_dropped_misc;
857
	struct sta_bss_parameters bss_param;
858
	struct nl80211_sta_flag_update sta_flags;
859 860

	int generation;
861 862 863

	const u8 *assoc_req_ies;
	size_t assoc_req_ies_len;
864

865
	u32 beacon_loss_count;
866
	s64 t_offset;
867 868 869
	enum nl80211_mesh_power_mode local_pm;
	enum nl80211_mesh_power_mode peer_pm;
	enum nl80211_mesh_power_mode nonpeer_pm;
870

871 872 873 874
	/*
	 * Note: Add a new enum station_info_flags value for each new field and
	 * use it to check which fields are initialized.
	 */
875 876
};

877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
/**
 * 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,
};

897 898 899 900 901 902
/**
 * 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
903 904 905 906 907 908 909
 * @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
910 911 912
 */
enum mpath_info_flags {
	MPATH_INFO_FRAME_QLEN		= BIT(0),
913
	MPATH_INFO_SN			= BIT(1),
914 915 916 917 918 919 920 921 922 923 924 925 926 927
	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
928
 * @sn: target sequence number
929 930 931 932 933
 * @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
934 935 936 937
 * @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.
938 939 940 941
 */
struct mpath_info {
	u32 filled;
	u32 frame_qlen;
942
	u32 sn;
943 944 945 946 947
	u32 metric;
	u32 exptime;
	u32 discovery_timeout;
	u8 discovery_retries;
	u8 flags;
948 949

	int generation;
950 951
};

952 953 954 955 956 957 958 959 960 961 962
/**
 * 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)
963 964 965
 * @basic_rates: basic rates in IEEE 802.11 format
 *	(or NULL for no change)
 * @basic_rates_len: number of basic rates
966
 * @ap_isolate: do not forward packets between connected stations
967 968
 * @ht_opmode: HT Operation mode
 * 	(u16 = opmode, -1 = do not change)
969 970
 * @p2p_ctwindow: P2P CT Window (-1 = no change)
 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
971 972 973 974 975
 */
struct bss_parameters {
	int use_cts_prot;
	int use_short_preamble;
	int use_short_slot_time;
976 977
	u8 *basic_rates;
	u8 basic_rates_len;
978
	int ap_isolate;
979
	int ht_opmode;
980
	s8 p2p_ctwindow, p2p_opp_ps;
981
};
982

983
/**
984 985 986
 * struct mesh_config - 802.11s mesh configuration
 *
 * These parameters can be changed while the mesh is active.
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
 *
 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
 *	by the Mesh Peering Open message
 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
 *	used by the Mesh Peering Open message
 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
 *	the mesh peering management to close a mesh peering
 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
 *	mesh interface
 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
 *	be sent to establish a new peer link instance in a mesh
 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
 * @element_ttl: the value of TTL field set at a mesh STA for path selection
 *	elements
 * @auto_open_plinks: whether we should automatically open peer links when we
 *	detect compatible mesh peers
 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
 *	synchronize to for 11s default synchronization method
 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
 *	that an originator mesh STA can send to a particular path target
 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
 * @min_discovery_timeout: the minimum length of time to wait until giving up on
 *	a path discovery in milliseconds
 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
 *	receiving a PREQ shall consider the forwarding information from the
 *	root to be valid. (TU = time unit)
 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
 *	which a mesh STA can send only one action frame containing a PREQ
 *	element
 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
 *	which a mesh STA can send only one Action frame containing a PERR
 *	element
 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
 *	it takes for an HWMP information element to propagate across the mesh
 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
 *	announcements are transmitted
 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
 *	station has access to a broader network beyond the MBSS. (This is
 *	missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
 *	only means that the station will announce others it's a mesh gate, but
 *	not necessarily using the gate announcement protocol. Still keeping the
 *	same nomenclature to be in sync with the spec)
 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
 *	entity (default is TRUE - forwarding entity)
 * @rssi_threshold: the threshold for average signal strength of candidate
 *	station to establish a peer link
 * @ht_opmode: mesh HT protection mode
1035 1036 1037 1038 1039 1040 1041
 *
 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
 *	receiving a proactive PREQ shall consider the forwarding information to
 *	the root mesh STA to be valid.
 *
 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
 *	PREQs are transmitted.
1042 1043 1044
 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
 *	during which a mesh STA can send only one Action frame containing
 *	a PREQ element for root path confirmation.
1045 1046 1047 1048
 * @power_mode: The default mesh power save mode which will be the initial
 *	setting for new peer links.
 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
 *	after transmitting its beacon.
1049
 */
1050 1051 1052 1053 1054
struct mesh_config {
	u16 dot11MeshRetryTimeout;
	u16 dot11MeshConfirmTimeout;
	u16 dot11MeshHoldingTimeout;
	u16 dot11MeshMaxPeerLinks;
1055 1056 1057
	u8 dot11MeshMaxRetries;
	u8 dot11MeshTTL;
	u8 element_ttl;
1058
	bool auto_open_plinks;
1059
	u32 dot11MeshNbrOffsetMaxNeighbor;
1060
	u8 dot11MeshHWMPmaxPREQretries;
1061 1062 1063 1064
	u32 path_refresh_time;
	u16 min_discovery_timeout;
	u32 dot11MeshHWMPactivePathTimeout;
	u16 dot11MeshHWMPpreqMinInterval;
1065
	u16 dot11MeshHWMPperrMinInterval;
1066
	u16 dot11MeshHWMPnetDiameterTraversalTime;
1067
	u8 dot11MeshHWMPRootMode;
1068
	u16 dot11MeshHWMPRannInterval;
1069
	bool dot11MeshGateAnnouncementProtocol;
1070
	bool dot11MeshForwarding;
1071
	s32 rssi_threshold;
1072
	u16 ht_opmode;
1073 1074
	u32 dot11MeshHWMPactivePathToRootTimeout;
	u16 dot11MeshHWMProotInterval;
1075
	u16 dot11MeshHWMPconfirmationInterval;
1076 1077
	enum nl80211_mesh_power_mode power_mode;
	u16 dot11MeshAwakeWindowDuration;
1078 1079
};

1080 1081
/**
 * struct mesh_setup - 802.11s mesh setup configuration
1082
 * @chandef: defines the channel to use
1083 1084
 * @mesh_id: the mesh ID
 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1085
 * @sync_method: which synchronization method to use
1086 1087
 * @path_sel_proto: which path selection protocol to use
 * @path_metric: which metric to use
1088 1089
 * @ie: vendor information elements (optional)
 * @ie_len: length of vendor information elements
1090 1091
 * @is_authenticated: this mesh requires authentication
 * @is_secure: this mesh uses security
1092 1093
 * @dtim_period: DTIM period to use
 * @beacon_interval: beacon interval to use
1094
 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1095 1096 1097 1098
 *
 * These parameters are fixed when the mesh is created.
 */
struct mesh_setup {
1099
	struct cfg80211_chan_def chandef;
1100 1101
	const u8 *mesh_id;
	u8 mesh_id_len;
1102 1103 1104
	u8 sync_method;
	u8 path_sel_proto;
	u8 path_metric;
1105 1106
	const u8 *ie;
	u8 ie_len;
1107
	bool is_authenticated;
1108
	bool is_secure;
1109 1110
	u8 dtim_period;
	u16 beacon_interval;
1111
	int mcast_rate[IEEE80211_NUM_BANDS];
1112 1113
};

1114 1115
/**
 * struct ieee80211_txq_params - TX queue parameters
1116
 * @ac: AC identifier
1117 1118 1119 1120 1121 1122 1123 1124
 * @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 {
1125
	enum nl80211_ac ac;
1126 1127 1128 1129 1130 1131
	u16 txop;
	u16 cwmin;
	u16 cwmax;
	u8 aifs;
};

1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
/**
 * 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.
 */
1154

1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
/**
 * 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.
1171
 * @n_channels: total number of channels to scan
1172 1173
 * @ie: optional information element(s) to add into Probe Request or %NULL
 * @ie_len: length of ie in octets
1174
 * @flags: bit field of flags controlling operation
1175
 * @rates: bitmap of rates to advertise for each band
1176
 * @wiphy: the wiphy this was for
1177
 * @scan_start: time (in jiffies) when the scan started
Johannes Berg's avatar
Johannes Berg committed
1178
 * @wdev: the wireless device to scan for
Johannes Berg's avatar
Johannes Berg committed
1179
 * @aborted: (internal) scan request was notified as aborted
1180
 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1181 1182 1183 1184 1185
 */
struct cfg80211_scan_request {
	struct cfg80211_ssid *ssids;
	int n_ssids;
	u32 n_channels;
1186
	const u8 *ie;
1187
	size_t ie_len;
1188
	u32 flags;
1189

1190 1191
	u32 rates[IEEE80211_NUM_BANDS];

Johannes Berg's avatar
Johannes Berg committed
1192 1193
	struct wireless_dev *wdev;

1194 1195
	/* internal */
	struct wiphy *wiphy;
1196
	unsigned long scan_start;
Johannes Berg's avatar
Johannes Berg committed
1197
	bool aborted;
1198
	bool no_cck;
1199 1200 1201

	/* keep last */
	struct ieee80211_channel *channels[0];
1202 1203
};

1204 1205 1206 1207 1208 1209 1210 1211 1212
/**
 * struct cfg80211_match_set - sets of attributes to match
 *
 * @ssid: SSID to be matched
 */
struct cfg80211_match_set {
	struct cfg80211_ssid ssid;
};

1213 1214 1215 1216 1217 1218
/**
 * struct cfg80211_sched_scan_request - scheduled scan request description
 *
 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
 * @n_ssids: number of SSIDs
 * @n_channels: total number of channels to scan
1219
 * @interval: interval between each scheduled scan cycle
1220