cfg80211.h 149 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 104 105 106 107 108 109 110 111 112
 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
 *	this flag indicates that an 80 MHz channel cannot use this
 *	channel as the control or any of the secondary channels.
 *	This may be due to the driver or due to regulatory bandwidth
 *	restrictions.
 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
 *	this flag indicates that an 160 MHz channel cannot use this
 *	channel as the control or any of the secondary channels.
 *	This may be due to the driver or due to regulatory bandwidth
 *	restrictions.
113
 */
Johannes Berg's avatar
Johannes Berg committed
114 115 116 117 118
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,
119 120
	IEEE80211_CHAN_NO_HT40PLUS	= 1<<4,
	IEEE80211_CHAN_NO_HT40MINUS	= 1<<5,
121
	IEEE80211_CHAN_NO_OFDM		= 1<<6,
122 123
	IEEE80211_CHAN_NO_80MHZ		= 1<<7,
	IEEE80211_CHAN_NO_160MHZ	= 1<<8,
124 125
};

126
#define IEEE80211_CHAN_NO_HT40 \
127
	(IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
128

129 130 131
#define IEEE80211_DFS_MIN_CAC_TIME_MS		60000
#define IEEE80211_DFS_MIN_NOP_TIME_MS		(30 * 60 * 1000)

Johannes Berg's avatar
Johannes Berg committed
132 133 134 135 136 137 138 139 140 141 142 143 144 145
/**
 * 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)
146
 * @max_reg_power: maximum regulatory transmission power (in dBm)
Johannes Berg's avatar
Johannes Berg committed
147 148
 * @beacon_found: helper to regulatory code to indicate when a beacon
 *	has been found on this channel. Use regulatory_hint_found_beacon()
149
 *	to enable this, this is useful only on 5 GHz band.
Johannes Berg's avatar
Johannes Berg committed
150 151
 * @orig_mag: internal use
 * @orig_mpwr: internal use
152 153 154
 * @dfs_state: current state of this channel. Only relevant if radar is required
 *	on this channel.
 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
Andy Green's avatar
Andy Green committed
155
 */
Johannes Berg's avatar
Johannes Berg committed
156 157 158 159 160 161 162
struct ieee80211_channel {
	enum ieee80211_band band;
	u16 center_freq;
	u16 hw_value;
	u32 flags;
	int max_antenna_gain;
	int max_power;
163
	int max_reg_power;
Johannes Berg's avatar
Johannes Berg committed
164 165 166
	bool beacon_found;
	u32 orig_flags;
	int orig_mag, orig_mpwr;
167 168
	enum nl80211_dfs_state dfs_state;
	unsigned long dfs_state_entered;
Johannes Berg's avatar
Johannes Berg committed
169 170
};

Andy Green's avatar
Andy Green committed
171
/**
Johannes Berg's avatar
Johannes Berg committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
 * 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
191
 */
Johannes Berg's avatar
Johannes Berg committed
192 193 194 195 196 197 198
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
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 218
/**
 * 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
219

Johannes Berg's avatar
Johannes Berg committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
/**
 * 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
238 239
};

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
/**
 * 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
256 257 258 259 260 261 262 263 264 265 266 267 268 269
/**
 * 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
270
 * @ht_cap: HT capabilities in this band
271
 * @vht_cap: VHT capabilities in this band
Johannes Berg's avatar
Johannes Berg committed
272 273 274 275 276 277 278 279
 */
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;
280
	struct ieee80211_sta_vht_cap vht_cap;
Johannes Berg's avatar
Johannes Berg committed
281
};
Andy Green's avatar
Andy Green committed
282

Johannes Berg's avatar
Johannes Berg committed
283 284 285
/*
 * Wireless hardware/device configuration structures and methods
 */
Andy Green's avatar
Andy Green committed
286

287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
/**
 * 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
302 303
/**
 * struct vif_params - describes virtual interface parameters
304
 * @use_4addr: use 4-address frames
305 306 307
 * @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
308 309
 */
struct vif_params {
310
       int use_4addr;
311
       u8 macaddr[ETH_ALEN];
Johannes Berg's avatar
Johannes Berg committed
312
};
Andy Green's avatar
Andy Green committed
313

Johannes Berg's avatar
Johannes Berg committed
314
/**
315 316 317 318 319 320 321 322 323 324
 * 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
325
 * @seq_len: length of @seq.
326 327 328 329 330 331 332 333 334
 */
struct key_params {
	u8 *key;
	u8 *seq;
	int key_len;
	int seq_len;
	u32 cipher;
};

335 336 337
/**
 * struct cfg80211_chan_def - channel definition
 * @chan: the (control) channel
338 339 340 341
 * @width: channel width
 * @center_freq1: center frequency of first segment
 * @center_freq2: center frequency of second segment
 *	(only with 80+80 MHz)
342 343 344
 */
struct cfg80211_chan_def {
	struct ieee80211_channel *chan;
345 346 347
	enum nl80211_chan_width width;
	u32 center_freq1;
	u32 center_freq2;
348 349
};

350 351 352 353
/**
 * cfg80211_get_chandef_type - return old channel type from chandef
 * @chandef: the channel definition
 *
354
 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
355 356
 * chandef, which must have a bandwidth allowing this conversion.
 */
357 358 359
static inline enum nl80211_channel_type
cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
{
360 361 362 363 364 365 366 367 368 369 370 371 372
	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;
	}
373 374
}

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
/**
 * 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
 *
392
 * Return: %true if the channels defined by the channel definitions are
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
 * 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
 *
410
 * Return: %NULL if the given channel definitions are incompatible,
411 412 413 414 415 416
 * chandef1 or chandef2 otherwise.
 */
const struct cfg80211_chan_def *
cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
			    const struct cfg80211_chan_def *chandef2);

417 418 419
/**
 * cfg80211_chandef_valid - check if a channel definition is valid
 * @chandef: the channel definition to check
420
 * Return: %true if the channel definition is valid. %false otherwise.
421 422 423 424 425 426 427
 */
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
428 429
 * @prohibited_flags: the regulatory channel flags that must not be set
 * Return: %true if secondary channels are usable. %false otherwise.
430 431 432 433 434
 */
bool cfg80211_chandef_usable(struct wiphy *wiphy,
			     const struct cfg80211_chan_def *chandef,
			     u32 prohibited_flags);

435 436 437
/**
 * enum survey_info_flags - survey information flags
 *
Johannes Berg's avatar
Johannes Berg committed
438
 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
439
 * @SURVEY_INFO_IN_USE: channel is currently being used
440 441 442 443 444
 * @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
445
 *
446 447 448 449 450
 * 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,
451
	SURVEY_INFO_IN_USE = 1<<1,
452 453 454 455 456
	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,
457 458 459 460 461 462 463 464 465
};

/**
 * 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
466 467 468 469 470
 * @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
471
 *
Johannes Berg's avatar
Johannes Berg committed
472 473
 * Used by dump_survey() to report back per-channel survey information.
 *
474 475 476 477 478
 * This structure can later be expanded with things like
 * channel duty cycle etc.
 */
struct survey_info {
	struct ieee80211_channel *channel;
479 480 481 482 483
	u64 channel_time;
	u64 channel_time_busy;
	u64 channel_time_ext_busy;
	u64 channel_time_rx;
	u64 channel_time_tx;
484 485 486 487
	u32 filled;
	s8 noise;
};

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
/**
 * 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;
};

518
/**
519
 * struct cfg80211_beacon_data - beacon data
520 521 522 523 524 525
 * @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
526 527 528 529 530 531 532 533
 * @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
534 535
 * @probe_resp_len: length of probe response template (@probe_resp)
 * @probe_resp: probe response template (AP mode only)
536
 */
537 538 539 540 541 542 543 544 545 546 547 548 549 550
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;
};

551 552 553 554
struct mac_address {
	u8 addr[ETH_ALEN];
};

555 556 557 558
/**
 * 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
559
 *	entry specified by mac_addr
560 561 562 563 564 565 566 567 568 569 570
 * @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[];
};

571 572 573 574 575
/**
 * struct cfg80211_ap_settings - AP configuration
 *
 * Used to configure an AP interface.
 *
576
 * @chandef: defines the channel to use
577 578 579 580 581 582 583 584 585 586
 * @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)
587
 * @inactivity_timeout: time in seconds to determine station's inactivity.
588 589
 * @p2p_ctwindow: P2P CT Window
 * @p2p_opp_ps: P2P opportunistic PS
590 591
 * @acl: ACL configuration used by the drivers which has support for
 *	MAC address based access control
592
 * @radar_required: set if radar detection is required
593 594
 */
struct cfg80211_ap_settings {
595
	struct cfg80211_chan_def chandef;
596

597 598 599
	struct cfg80211_beacon_data beacon;

	int beacon_interval, dtim_period;
600 601 602
	const u8 *ssid;
	size_t ssid_len;
	enum nl80211_hidden_ssid hidden_ssid;
603 604 605
	struct cfg80211_crypto_settings crypto;
	bool privacy;
	enum nl80211_auth_type auth_type;
606
	int inactivity_timeout;
607 608
	u8 p2p_ctwindow;
	bool p2p_opp_ps;
609
	const struct cfg80211_acl_data *acl;
610
	bool radar_required;
611 612
};

613 614 615
/**
 * enum station_parameters_apply_mask - station parameter values to apply
 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
616
 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
617
 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
618 619 620 621 622 623
 *
 * 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),
624
	STATION_PARAM_APPLY_CAPABILITY = BIT(1),
625
	STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
626 627
};

628 629 630 631 632 633 634 635 636
/**
 * 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
637 638 639 640
 * @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_...))
641 642
 * @listen_interval: listen interval or -1 for no change
 * @aid: AID or zero for no change
Johannes Berg's avatar
Johannes Berg committed
643
 * @plink_action: plink action to take
644
 * @plink_state: set the peer link state for a station
Johannes Berg's avatar
Johannes Berg committed
645
 * @ht_capa: HT capabilities of station
646
 * @vht_capa: VHT capabilities of station
647 648 649 650
 * @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)
651 652 653
 * @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
654 655
 * @local_pm: local link-specific mesh power save mode (no change when set
 *	to unknown)
656 657 658
 * @capability: station capability
 * @ext_capab: extended capabilities of the station
 * @ext_capab_len: number of extended capabilities
659 660
 */
struct station_parameters {
661
	const u8 *supported_rates;
662
	struct net_device *vlan;
663
	u32 sta_flags_mask, sta_flags_set;
664
	u32 sta_modify_mask;
665 666 667
	int listen_interval;
	u16 aid;
	u8 supported_rates_len;
668
	u8 plink_action;
669
	u8 plink_state;
670 671
	const struct ieee80211_ht_cap *ht_capa;
	const struct ieee80211_vht_cap *vht_capa;
672 673
	u8 uapsd_queues;
	u8 max_sp;
674
	enum nl80211_mesh_power_mode local_pm;
675
	u16 capability;
676
	const u8 *ext_capab;
677
	u8 ext_capab_len;
678 679
};

680 681 682 683 684 685 686 687 688 689 690 691 692
/**
 * enum cfg80211_station_type - the type of station being modified
 * @CFG80211_STA_AP_CLIENT: client of an AP interface
 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
 *	the AP MLME in the device
 * @CFG80211_STA_AP_STA: AP station on managed interface
 * @CFG80211_STA_IBSS: IBSS station
 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
 *	while TDLS setup is in progress, it moves out of this state when
 *	being marked authorized; use this only if TDLS with external setup is
 *	supported/used)
 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
 *	entry that is operating, has been marked authorized by userspace)
693 694
 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
695 696 697 698 699 700 701 702
 */
enum cfg80211_station_type {
	CFG80211_STA_AP_CLIENT,
	CFG80211_STA_AP_MLME_CLIENT,
	CFG80211_STA_AP_STA,
	CFG80211_STA_IBSS,
	CFG80211_STA_TDLS_PEER_SETUP,
	CFG80211_STA_TDLS_PEER_ACTIVE,
703 704
	CFG80211_STA_MESH_PEER_KERNEL,
	CFG80211_STA_MESH_PEER_USER,
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
};

/**
 * cfg80211_check_station_change - validate parameter changes
 * @wiphy: the wiphy this operates on
 * @params: the new parameters for a station
 * @statype: the type of station being modified
 *
 * Utility function for the @change_station driver method. Call this function
 * with the appropriate station type looking up the station (and checking that
 * it exists). It will verify whether the station change is acceptable, and if
 * not will return an error code. Note that it may modify the parameters for
 * backward compatibility reasons, so don't use them before calling this.
 */
int cfg80211_check_station_change(struct wiphy *wiphy,
				  struct station_parameters *params,
				  enum cfg80211_station_type statype);

723
/**
724
 * enum station_info_flags - station information flags
725
 *
726 727
 * Used by the driver to indicate which info in &struct station_info
 * it has filled in during get_station() or dump_station().
728
 *
729 730 731
 * @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
732 733
 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
734 735 736
 * @STATION_INFO_LLID: @llid filled
 * @STATION_INFO_PLID: @plid filled
 * @STATION_INFO_PLINK_STATE: @plink_state filled
737
 * @STATION_INFO_SIGNAL: @signal filled
738
 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
739
 *  (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
740 741
 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
742 743
 * @STATION_INFO_TX_RETRIES: @tx_retries filled
 * @STATION_INFO_TX_FAILED: @tx_failed filled
744
 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
745
 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
746
 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
747
 * @STATION_INFO_BSS_PARAM: @bss_param filled
748
 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
749
 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
750
 * @STATION_INFO_STA_FLAGS: @sta_flags filled
751
 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
752
 * @STATION_INFO_T_OFFSET: @t_offset filled
753 754 755
 * @STATION_INFO_LOCAL_PM: @local_pm filled
 * @STATION_INFO_PEER_PM: @peer_pm filled
 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
756 757
 * @STATION_INFO_CHAIN_SIGNAL: @chain_signal filled
 * @STATION_INFO_CHAIN_SIGNAL_AVG: @chain_signal_avg filled
758
 */
759 760 761 762 763 764 765
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,
766 767
	STATION_INFO_SIGNAL		= 1<<6,
	STATION_INFO_TX_BITRATE		= 1<<7,
768 769
	STATION_INFO_RX_PACKETS		= 1<<8,
	STATION_INFO_TX_PACKETS		= 1<<9,
770 771
	STATION_INFO_TX_RETRIES		= 1<<10,
	STATION_INFO_TX_FAILED		= 1<<11,
772
	STATION_INFO_RX_DROP_MISC	= 1<<12,
773
	STATION_INFO_SIGNAL_AVG		= 1<<13,
774
	STATION_INFO_RX_BITRATE		= 1<<14,
775
	STATION_INFO_BSS_PARAM          = 1<<15,
776
	STATION_INFO_CONNECTED_TIME	= 1<<16,
777
	STATION_INFO_ASSOC_REQ_IES	= 1<<17,
778
	STATION_INFO_STA_FLAGS		= 1<<18,
779 780
	STATION_INFO_BEACON_LOSS_COUNT	= 1<<19,
	STATION_INFO_T_OFFSET		= 1<<20,
781 782 783
	STATION_INFO_LOCAL_PM		= 1<<21,
	STATION_INFO_PEER_PM		= 1<<22,
	STATION_INFO_NONPEER_PM		= 1<<23,
784 785
	STATION_INFO_RX_BYTES64		= 1<<24,
	STATION_INFO_TX_BYTES64		= 1<<25,
786 787
	STATION_INFO_CHAIN_SIGNAL	= 1<<26,
	STATION_INFO_CHAIN_SIGNAL_AVG	= 1<<27,
788 789 790 791 792 793 794 795
};

/**
 * enum station_info_rate_flags - bitrate info flags
 *
 * Used by the driver to indicate the specific rate transmission
 * type for 802.11n transmissions.
 *
796 797 798 799 800 801
 * @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
802
 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
803
 * @RATE_INFO_FLAGS_60G: 60GHz MCS
804 805
 */
enum rate_info_flags {
806 807 808 809 810 811 812 813
	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),
814 815 816 817 818 819 820 821 822 823
};

/**
 * 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
824
 * @nss: number of streams (VHT only)
825 826 827 828 829
 */
struct rate_info {
	u8 flags;
	u8 mcs;
	u16 legacy;
830
	u8 nss;
831 832
};

833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
/**
 * 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;
};

864 865
#define IEEE80211_MAX_CHAINS	4

866
/**
867
 * struct station_info - station information
868
 *
869
 * Station information filled by driver for get_station() and dump_station.
870
 *
871
 * @filled: bitflag of flags from &enum station_info_flags
872
 * @connected_time: time(in secs) since a station is last connected
873 874 875
 * @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
876 877 878
 * @llid: mesh local link id
 * @plid: mesh peer link id
 * @plink_state: mesh peer link state
879 880 881 882
 * @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_.
883 884 885
 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
 * @chain_signal: per-chain signal strength of last received packet in dBm
 * @chain_signal_avg: per-chain signal strength average in dBm
886 887
 * @txrate: current unicast bitrate from this station
 * @rxrate: current unicast bitrate to this station
888 889
 * @rx_packets: packets received from this station
 * @tx_packets: packets transmitted to this station
890 891
 * @tx_retries: cumulative retry counts
 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
892
 * @rx_dropped_misc:  Dropped for un-specified reason.
893
 * @bss_param: current BSS parameters
894 895 896 897
 * @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.
898 899 900 901 902
 * @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.
903
 * @sta_flags: station flags mask & values
904
 * @beacon_loss_count: Number of times beacon loss event has triggered.
905
 * @t_offset: Time offset of the station relative to this host.
906 907 908
 * @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
909
 */
910
struct station_info {
911
	u32 filled;
912
	u32 connected_time;
913
	u32 inactive_time;
914 915
	u64 rx_bytes;
	u64 tx_bytes;
916 917 918
	u16 llid;
	u16 plid;
	u8 plink_state;
919
	s8 signal;
920
	s8 signal_avg;
921 922 923 924 925

	u8 chains;
	s8 chain_signal[IEEE80211_MAX_CHAINS];
	s8 chain_signal_avg[IEEE80211_MAX_CHAINS];

926
	struct rate_info txrate;
927
	struct rate_info rxrate;
928 929
	u32 rx_packets;
	u32 tx_packets;
930 931
	u32 tx_retries;
	u32 tx_failed;
932
	u32 rx_dropped_misc;
933
	struct sta_bss_parameters bss_param;
934
	struct nl80211_sta_flag_update sta_flags;
935 936

	int generation;
937 938 939

	const u8 *assoc_req_ies;
	size_t assoc_req_ies_len;
940

941
	u32 beacon_loss_count;
942
	s64 t_offset;
943 944 945
	enum nl80211_mesh_power_mode local_pm;
	enum nl80211_mesh_power_mode peer_pm;
	enum nl80211_mesh_power_mode nonpeer_pm;
946

947 948 949 950
	/*
	 * Note: Add a new enum station_info_flags value for each new field and
	 * use it to check which fields are initialized.
	 */
951 952
};

953 954 955 956 957 958 959 960 961 962 963
/**
 * 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
964
 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
965 966 967 968 969 970 971
 */
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,
972
	MONITOR_FLAG_ACTIVE		= 1<<NL80211_MNTR_FLAG_ACTIVE,
973 974
};

975 976 977 978 979 980
/**
 * 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
981 982 983 984 985 986 987
 * @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
988 989 990
 */
enum mpath_info_flags {
	MPATH_INFO_FRAME_QLEN		= BIT(0),
991
	MPATH_INFO_SN			= BIT(1),
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
	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
1006
 * @sn: target sequence number
1007 1008 1009 1010 1011
 * @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
1012 1013 1014 1015
 * @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.
1016 1017 1018 1019
 */
struct mpath_info {
	u32 filled;
	u32 frame_qlen;
1020
	u32 sn;
1021 1022 1023 1024 1025
	u32 metric;
	u32 exptime;
	u32 discovery_timeout;
	u8 discovery_retries;
	u8 flags;
1026 1027

	int generation;
1028 1029
};

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
/**
 * 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)
1041 1042 1043
 * @basic_rates: basic rates in IEEE 802.11 format
 *	(or NULL for no change)
 * @basic_rates_len: number of basic rates
1044
 * @ap_isolate: do not forward packets between connected stations
1045 1046
 * @ht_opmode: HT Operation mode
 * 	(u16 = opmode, -1 = do not change)
1047 1048
 * @p2p_ctwindow: P2P CT Window (-1 = no change)
 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1049 1050 1051 1052 1053
 */
struct bss_parameters {
	int use_cts_prot;
	int use_short_preamble;
	int use_short_slot_time;
1054 1055
	u8 *basic_rates;
	u8 basic_rates_len;
1056
	int ap_isolate;
1057
	int ht_opmode;
1058
	s8 p2p_ctwindow, p2p_opp_ps;
1059
};
1060

1061
/**
1062 1063 1064
 * struct mesh_config - 802.11s mesh configuration
 *
 * These parameters can be changed while the mesh is active.
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
 *
 * @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
1113 1114 1115 1116 1117 1118 1119
 *
 * @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.
1120 1121 1122
 * @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.
1123 1124 1125 1126
 * @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.
1127 1128 1129
 * @plink_timeout: If no tx activity is seen from a STA we've established
 *	peering with for longer than this time (in seconds), then remove it
 *	from the STA's list of peers.  Default is 30 minutes.
1130
 */
1131 1132 1133 1134 1135
struct mesh_config {
	u16 dot11MeshRetryTimeout;
	u16 dot11MeshConfirmTimeout;
	u16 dot11MeshHoldingTimeout;
	u16 dot11MeshMaxPeerLinks;
1136 1137 1138
	u8 dot11MeshMaxRetries;
	u8 dot11MeshTTL;
	u8 element_ttl;
1139
	bool auto_open_plinks;
1140
	u32 dot11MeshNbrOffsetMaxNeighbor;
1141
	u8 dot11MeshHWMPmaxPREQretries;
1142 1143 1144 1145
	u32 path_refresh_time;
	u16 min_discovery_timeout;
	u32 dot11MeshHWMPactivePathTimeout;
	u16 dot11MeshHWMPpreqMinInterval;
1146
	u16 dot11MeshHWMPperrMinInterval;
1147
	u16 dot11MeshHWMPnetDiameterTraversalTime;
1148
	u8 dot11MeshHWMPRootMode;
1149
	u16 dot11MeshHWMPRannInterval;
1150
	bool dot11MeshGateAnnouncementProtocol;
1151
	bool dot11MeshForwarding;
1152
	s32 rssi_threshold;
1153
	u16 ht_opmode;
1154 1155
	u32 dot11MeshHWMPactivePathToRootTimeout;
	u16 dot11MeshHWMProotInterval;
1156
	u16 dot11MeshHWMPconfirmationInterval;
1157 1158
	enum nl80211_mesh_power_mode power_mode;
	u16 dot11MeshAwakeWindowDuration;
1159
	u32 plink_timeout;
1160 1161
};

1162 1163
/**
 * struct mesh_setup - 802.11s mesh setup configuration
1164
 * @chandef: defines the channel to use
1165 1166
 * @mesh_id: the mesh ID
 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1167
 * @sync_method: which synchronization method to use
1168 1169
 * @path_sel_proto: which path selection protocol to use
 * @path_metric: which metric to use
1170
 * @auth_id: which authentication method this mesh is using
1171 1172
 * @ie: vendor information elements (optional)
 * @ie_len: length of vendor information elements
1173 1174
 * @is_authenticated: this mesh requires authentication
 * @is_secure: this mesh uses security
1175
 * @user_mpm: userspace handles all MPM functions
1176 1177
 * @dtim_period: DTIM period to use
 * @beacon_interval: beacon interval to use
1178
 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1179
 * @basic_rates: basic rates to use when creating the mesh
1180 1181 1182 1183
 *
 * These parameters are fixed when the mesh is created.
 */
struct mesh_setup {
1184
	struct cfg80211_chan_def chandef;
1185 1186
	const u8 *mesh_id;
	u8 mesh_id_len;
1187 1188 1189
	u8 sync_method;
	u8 path_sel_proto;
	u8 path_metric;
1190
	u8 auth_id;
1191 1192
	const u8 *ie;
	u8 ie_len;
1193
	bool is_authenticated;
1194
	bool is_secure;
1195
	bool user_mpm;
1196 1197
	u8 dtim_period;
	u16 beacon_interval;
1198
	int mcast_rate[IEEE80211_NUM_BANDS];
1199
	u32 basic_rates;