cfg80211.h 174 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>
7
 * Copyright 2013-2014 Intel Mobile Communications GmbH
Johannes Berg's avatar
Johannes Berg committed
8 9 10 11 12
 *
 * 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.
 */
13

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

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 62
/**
 * 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.
 */

63 64
struct wiphy;

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

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

	/* keep last */
	IEEE80211_NUM_BANDS
};
88

89
/**
Johannes Berg's avatar
Johannes Berg committed
90 91 92 93 94
 * enum ieee80211_channel_flags - channel flags
 *
 * Channel flags set by the regulatory control code.
 *
 * @IEEE80211_CHAN_DISABLED: This channel is disabled.
95 96
 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
 * 	sending probe requests or beaconing.
Johannes Berg's avatar
Johannes Berg committed
97
 * @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 114
 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
 * @IEEE80211_CHAN_GO_CONCURRENT: see %NL80211_FREQUENCY_ATTR_GO_CONCURRENT
115 116 117 118
 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
 *	on this channel.
 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
 *	on this channel.
119
 *
120
 */
Johannes Berg's avatar
Johannes Berg committed
121 122
enum ieee80211_channel_flags {
	IEEE80211_CHAN_DISABLED		= 1<<0,
123 124
	IEEE80211_CHAN_NO_IR		= 1<<1,
	/* hole at 1<<2 */
Johannes Berg's avatar
Johannes Berg committed
125
	IEEE80211_CHAN_RADAR		= 1<<3,
126 127
	IEEE80211_CHAN_NO_HT40PLUS	= 1<<4,
	IEEE80211_CHAN_NO_HT40MINUS	= 1<<5,
128
	IEEE80211_CHAN_NO_OFDM		= 1<<6,
129 130
	IEEE80211_CHAN_NO_80MHZ		= 1<<7,
	IEEE80211_CHAN_NO_160MHZ	= 1<<8,
131 132
	IEEE80211_CHAN_INDOOR_ONLY	= 1<<9,
	IEEE80211_CHAN_GO_CONCURRENT	= 1<<10,
133 134
	IEEE80211_CHAN_NO_20MHZ		= 1<<11,
	IEEE80211_CHAN_NO_10MHZ		= 1<<12,
135 136
};

137
#define IEEE80211_CHAN_NO_HT40 \
138
	(IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
139

140 141 142
#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
143 144 145 146 147 148 149 150 151 152 153 154 155 156
/**
 * 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)
157
 * @max_reg_power: maximum regulatory transmission power (in dBm)
Johannes Berg's avatar
Johannes Berg committed
158 159
 * @beacon_found: helper to regulatory code to indicate when a beacon
 *	has been found on this channel. Use regulatory_hint_found_beacon()
160
 *	to enable this, this is useful only on 5 GHz band.
Johannes Berg's avatar
Johannes Berg committed
161 162
 * @orig_mag: internal use
 * @orig_mpwr: internal use
163 164 165
 * @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.
166
 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
Andy Green's avatar
Andy Green committed
167
 */
Johannes Berg's avatar
Johannes Berg committed
168 169 170 171 172 173 174
struct ieee80211_channel {
	enum ieee80211_band band;
	u16 center_freq;
	u16 hw_value;
	u32 flags;
	int max_antenna_gain;
	int max_power;
175
	int max_reg_power;
Johannes Berg's avatar
Johannes Berg committed
176 177 178
	bool beacon_found;
	u32 orig_flags;
	int orig_mag, orig_mpwr;
179 180
	enum nl80211_dfs_state dfs_state;
	unsigned long dfs_state_entered;
181
	unsigned int dfs_cac_ms;
Johannes Berg's avatar
Johannes Berg committed
182 183
};

Andy Green's avatar
Andy Green committed
184
/**
Johannes Berg's avatar
Johannes Berg committed
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
 * 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.
204 205
 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
Andy Green's avatar
Andy Green committed
206
 */
Johannes Berg's avatar
Johannes Berg committed
207 208 209 210 211 212
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,
213 214
	IEEE80211_RATE_SUPPORTS_5MHZ	= 1<<5,
	IEEE80211_RATE_SUPPORTS_10MHZ	= 1<<6,
Johannes Berg's avatar
Johannes Berg committed
215
};
Andy Green's avatar
Andy Green committed
216

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

Johannes Berg's avatar
Johannes Berg committed
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
/**
 * 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
255 256
};

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
/**
 * 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
273 274 275 276 277 278 279 280 281 282 283 284 285 286
/**
 * 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
287
 * @ht_cap: HT capabilities in this band
288
 * @vht_cap: VHT capabilities in this band
Johannes Berg's avatar
Johannes Berg committed
289 290 291 292 293 294 295 296
 */
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;
297
	struct ieee80211_sta_vht_cap vht_cap;
Johannes Berg's avatar
Johannes Berg committed
298
};
Andy Green's avatar
Andy Green committed
299

Johannes Berg's avatar
Johannes Berg committed
300 301 302
/*
 * Wireless hardware/device configuration structures and methods
 */
Andy Green's avatar
Andy Green committed
303

304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
/**
 * 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
319 320
/**
 * struct vif_params - describes virtual interface parameters
321
 * @use_4addr: use 4-address frames
322 323 324
 * @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
325 326
 */
struct vif_params {
327
       int use_4addr;
328
       u8 macaddr[ETH_ALEN];
Johannes Berg's avatar
Johannes Berg committed
329
};
Andy Green's avatar
Andy Green committed
330

Johannes Berg's avatar
Johannes Berg committed
331
/**
332 333 334 335 336 337 338 339 340 341
 * 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
342
 * @seq_len: length of @seq.
343 344
 */
struct key_params {
345 346
	const u8 *key;
	const u8 *seq;
347 348 349 350 351
	int key_len;
	int seq_len;
	u32 cipher;
};

352 353 354
/**
 * struct cfg80211_chan_def - channel definition
 * @chan: the (control) channel
355 356 357 358
 * @width: channel width
 * @center_freq1: center frequency of first segment
 * @center_freq2: center frequency of second segment
 *	(only with 80+80 MHz)
359 360 361
 */
struct cfg80211_chan_def {
	struct ieee80211_channel *chan;
362 363 364
	enum nl80211_chan_width width;
	u32 center_freq1;
	u32 center_freq2;
365 366
};

367 368 369 370
/**
 * cfg80211_get_chandef_type - return old channel type from chandef
 * @chandef: the channel definition
 *
371
 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
372 373
 * chandef, which must have a bandwidth allowing this conversion.
 */
374 375 376
static inline enum nl80211_channel_type
cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
{
377 378 379 380 381 382 383 384 385 386 387 388 389
	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;
	}
390 391
}

392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
/**
 * 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
 *
409
 * Return: %true if the channels defined by the channel definitions are
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
 * 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
 *
427
 * Return: %NULL if the given channel definitions are incompatible,
428 429 430 431 432 433
 * chandef1 or chandef2 otherwise.
 */
const struct cfg80211_chan_def *
cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
			    const struct cfg80211_chan_def *chandef2);

434 435 436
/**
 * cfg80211_chandef_valid - check if a channel definition is valid
 * @chandef: the channel definition to check
437
 * Return: %true if the channel definition is valid. %false otherwise.
438 439 440 441 442 443 444
 */
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
445 446
 * @prohibited_flags: the regulatory channel flags that must not be set
 * Return: %true if secondary channels are usable. %false otherwise.
447 448 449 450 451
 */
bool cfg80211_chandef_usable(struct wiphy *wiphy,
			     const struct cfg80211_chan_def *chandef,
			     u32 prohibited_flags);

452 453 454 455
/**
 * cfg80211_chandef_dfs_required - checks if radar detection is required
 * @wiphy: the wiphy to validate against
 * @chandef: the channel definition to check
456 457 458
 * @iftype: the interface type as specified in &enum nl80211_iftype
 * Returns:
 *	1 if radar detection is required, 0 if it is not, < 0 on error
459 460
 */
int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
461
				  const struct cfg80211_chan_def *chandef,
Luciano Coelho's avatar
Luciano Coelho committed
462
				  enum nl80211_iftype iftype);
463

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
/**
 * ieee80211_chandef_rate_flags - returns rate flags for a channel
 *
 * In some channel types, not all rates may be used - for example CCK
 * rates may not be used in 5/10 MHz channels.
 *
 * @chandef: channel definition for the channel
 *
 * Returns: rate flags which apply for this channel
 */
static inline enum ieee80211_rate_flags
ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
{
	switch (chandef->width) {
	case NL80211_CHAN_WIDTH_5:
		return IEEE80211_RATE_SUPPORTS_5MHZ;
	case NL80211_CHAN_WIDTH_10:
		return IEEE80211_RATE_SUPPORTS_10MHZ;
	default:
		break;
	}
	return 0;
}

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
/**
 * ieee80211_chandef_max_power - maximum transmission power for the chandef
 *
 * In some regulations, the transmit power may depend on the configured channel
 * bandwidth which may be defined as dBm/MHz. This function returns the actual
 * max_power for non-standard (20 MHz) channels.
 *
 * @chandef: channel definition for the channel
 *
 * Returns: maximum allowed transmission power in dBm for the chandef
 */
static inline int
ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
{
	switch (chandef->width) {
	case NL80211_CHAN_WIDTH_5:
		return min(chandef->chan->max_reg_power - 6,
			   chandef->chan->max_power);
	case NL80211_CHAN_WIDTH_10:
		return min(chandef->chan->max_reg_power - 3,
			   chandef->chan->max_power);
	default:
		break;
	}
	return chandef->chan->max_power;
}

515 516 517
/**
 * enum survey_info_flags - survey information flags
 *
Johannes Berg's avatar
Johannes Berg committed
518
 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
519
 * @SURVEY_INFO_IN_USE: channel is currently being used
520 521 522 523 524
 * @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
525
 *
526 527 528 529 530
 * 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,
531
	SURVEY_INFO_IN_USE = 1<<1,
532 533 534 535 536
	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,
537 538 539 540 541 542 543 544
};

/**
 * 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
545
 *	optional
546 547 548 549 550
 * @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
551
 *
Johannes Berg's avatar
Johannes Berg committed
552 553
 * Used by dump_survey() to report back per-channel survey information.
 *
554 555 556 557 558
 * This structure can later be expanded with things like
 * channel duty cycle etc.
 */
struct survey_info {
	struct ieee80211_channel *channel;
559 560 561 562 563
	u64 channel_time;
	u64 channel_time_busy;
	u64 channel_time_ext_busy;
	u64 channel_time_rx;
	u64 channel_time_tx;
564 565 566 567
	u32 filled;
	s8 noise;
};

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
/**
 * 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;
};

598
/**
599
 * struct cfg80211_beacon_data - beacon data
600
 * @head: head portion of beacon (before TIM IE)
601
 *	or %NULL if not changed
602
 * @tail: tail portion of beacon (after TIM IE)
603
 *	or %NULL if not changed
604 605
 * @head_len: length of @head
 * @tail_len: length of @tail
606 607 608 609 610 611 612 613
 * @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
614 615
 * @probe_resp_len: length of probe response template (@probe_resp)
 * @probe_resp: probe response template (AP mode only)
616
 */
617 618 619 620 621 622 623 624 625 626 627 628 629 630
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;
};

631 632 633 634
struct mac_address {
	u8 addr[ETH_ALEN];
};

635 636 637 638
/**
 * 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
639
 *	entry specified by mac_addr
640 641 642 643 644 645 646 647 648 649 650
 * @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[];
};

651 652 653 654 655
/**
 * struct cfg80211_ap_settings - AP configuration
 *
 * Used to configure an AP interface.
 *
656
 * @chandef: defines the channel to use
657 658 659 660 661 662 663 664 665 666
 * @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)
667
 * @smps_mode: SMPS mode
668
 * @inactivity_timeout: time in seconds to determine station's inactivity.
669 670
 * @p2p_ctwindow: P2P CT Window
 * @p2p_opp_ps: P2P opportunistic PS
671 672
 * @acl: ACL configuration used by the drivers which has support for
 *	MAC address based access control
673 674
 */
struct cfg80211_ap_settings {
675
	struct cfg80211_chan_def chandef;
676

677 678 679
	struct cfg80211_beacon_data beacon;

	int beacon_interval, dtim_period;
680 681 682
	const u8 *ssid;
	size_t ssid_len;
	enum nl80211_hidden_ssid hidden_ssid;
683 684 685
	struct cfg80211_crypto_settings crypto;
	bool privacy;
	enum nl80211_auth_type auth_type;
686
	enum nl80211_smps_mode smps_mode;
687
	int inactivity_timeout;
688 689
	u8 p2p_ctwindow;
	bool p2p_opp_ps;
690
	const struct cfg80211_acl_data *acl;
691 692
};

693 694 695 696 697 698 699
/**
 * struct cfg80211_csa_settings - channel switch settings
 *
 * Used for channel switch
 *
 * @chandef: defines the channel to use after the switch
 * @beacon_csa: beacon data while performing the switch
700 701 702 703
 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
 * @counter_offsets_presp: offsets of the counters within the probe response
 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
 * @n_counter_offsets_presp: number of csa counters in the probe response
704 705 706 707 708 709 710 711
 * @beacon_after: beacon data to be used on the new channel
 * @radar_required: whether radar detection is required on the new channel
 * @block_tx: whether transmissions should be blocked while changing
 * @count: number of beacons until switch
 */
struct cfg80211_csa_settings {
	struct cfg80211_chan_def chandef;
	struct cfg80211_beacon_data beacon_csa;
712 713 714 715
	const u16 *counter_offsets_beacon;
	const u16 *counter_offsets_presp;
	unsigned int n_counter_offsets_beacon;
	unsigned int n_counter_offsets_presp;
716 717 718 719 720 721
	struct cfg80211_beacon_data beacon_after;
	bool radar_required;
	bool block_tx;
	u8 count;
};

722 723 724
/**
 * enum station_parameters_apply_mask - station parameter values to apply
 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
725
 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
726
 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
727 728 729 730 731 732
 *
 * 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),
733
	STATION_PARAM_APPLY_CAPABILITY = BIT(1),
734
	STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
735 736
};

737 738 739 740 741 742 743 744 745
/**
 * 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
746 747 748 749
 * @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_...))
750 751
 * @listen_interval: listen interval or -1 for no change
 * @aid: AID or zero for no change
Johannes Berg's avatar
Johannes Berg committed
752
 * @plink_action: plink action to take
753
 * @plink_state: set the peer link state for a station
Johannes Berg's avatar
Johannes Berg committed
754
 * @ht_capa: HT capabilities of station
755
 * @vht_capa: VHT capabilities of station
756 757 758 759
 * @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)
760 761 762
 * @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
763 764
 * @local_pm: local link-specific mesh power save mode (no change when set
 *	to unknown)
765 766 767
 * @capability: station capability
 * @ext_capab: extended capabilities of the station
 * @ext_capab_len: number of extended capabilities
768 769 770 771
 * @supported_channels: supported channels in IEEE 802.11 format
 * @supported_channels_len: number of supported channels
 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
 * @supported_oper_classes_len: number of supported operating classes
772 773
 * @opmode_notif: operating mode field from Operating Mode Notification
 * @opmode_notif_used: information if operating mode field is used
774 775
 */
struct station_parameters {
776
	const u8 *supported_rates;
777
	struct net_device *vlan;
778
	u32 sta_flags_mask, sta_flags_set;
779
	u32 sta_modify_mask;
780 781 782
	int listen_interval;
	u16 aid;
	u8 supported_rates_len;
783
	u8 plink_action;
784
	u8 plink_state;
785 786
	const struct ieee80211_ht_cap *ht_capa;
	const struct ieee80211_vht_cap *vht_capa;
787 788
	u8 uapsd_queues;
	u8 max_sp;
789
	enum nl80211_mesh_power_mode local_pm;
790
	u16 capability;
791
	const u8 *ext_capab;
792
	u8 ext_capab_len;
793 794 795 796
	const u8 *supported_channels;
	u8 supported_channels_len;
	const u8 *supported_oper_classes;
	u8 supported_oper_classes_len;
797 798
	u8 opmode_notif;
	bool opmode_notif_used;
799 800
};

801 802 803 804 805 806
/**
 * struct station_del_parameters - station deletion parameters
 *
 * Used to delete a station entry (or all stations).
 *
 * @mac: MAC address of the station to remove or NULL to remove all stations
807 808 809
 * @subtype: Management frame subtype to use for indicating removal
 *	(10 = Disassociation, 12 = Deauthentication)
 * @reason_code: Reason code for the Disassociation/Deauthentication frame
810 811 812
 */
struct station_del_parameters {
	const u8 *mac;
813 814
	u8 subtype;
	u16 reason_code;
815 816
};

817 818 819 820 821 822 823 824 825 826 827 828 829
/**
 * 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)
830 831
 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
832 833 834 835 836 837 838 839
 */
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,
840 841
	CFG80211_STA_MESH_PEER_KERNEL,
	CFG80211_STA_MESH_PEER_USER,
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
};

/**
 * 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);

860
/**
861
 * enum station_info_flags - station information flags
862
 *
863 864
 * Used by the driver to indicate which info in &struct station_info
 * it has filled in during get_station() or dump_station().
865
 *
866 867 868
 * @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
869 870
 * @STATION_INFO_RX_BYTES64: @rx_bytes filled with 64-bit value
 * @STATION_INFO_TX_BYTES64: @tx_bytes filled with 64-bit value
871 872 873
 * @STATION_INFO_LLID: @llid filled
 * @STATION_INFO_PLID: @plid filled
 * @STATION_INFO_PLINK_STATE: @plink_state filled
874
 * @STATION_INFO_SIGNAL: @signal filled
875
 * @STATION_INFO_TX_BITRATE: @txrate fields are filled
876
 *	(tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs)
877 878
 * @STATION_INFO_RX_PACKETS: @rx_packets filled with 32-bit value
 * @STATION_INFO_TX_PACKETS: @tx_packets filled with 32-bit value
879 880
 * @STATION_INFO_TX_RETRIES: @tx_retries filled
 * @STATION_INFO_TX_FAILED: @tx_failed filled
881
 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled
882
 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled
883
 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled
884
 * @STATION_INFO_BSS_PARAM: @bss_param filled
885
 * @STATION_INFO_CONNECTED_TIME: @connected_time filled
886
 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled
887
 * @STATION_INFO_STA_FLAGS: @sta_flags filled
888
 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled
889
 * @STATION_INFO_T_OFFSET: @t_offset filled
890 891 892
 * @STATION_INFO_LOCAL_PM: @local_pm filled
 * @STATION_INFO_PEER_PM: @peer_pm filled
 * @STATION_INFO_NONPEER_PM: @nonpeer_pm filled
893 894
 * @STATION_INFO_CHAIN_SIGNAL: @chain_signal filled
 * @STATION_INFO_CHAIN_SIGNAL_AVG: @chain_signal_avg filled
895
 * @STATION_INFO_EXPECTED_THROUGHPUT: @expected_throughput filled
896
 */
897
enum station_info_flags {
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
	STATION_INFO_INACTIVE_TIME		= BIT(0),
	STATION_INFO_RX_BYTES			= BIT(1),
	STATION_INFO_TX_BYTES			= BIT(2),
	STATION_INFO_LLID			= BIT(3),
	STATION_INFO_PLID			= BIT(4),
	STATION_INFO_PLINK_STATE		= BIT(5),
	STATION_INFO_SIGNAL			= BIT(6),
	STATION_INFO_TX_BITRATE			= BIT(7),
	STATION_INFO_RX_PACKETS			= BIT(8),
	STATION_INFO_TX_PACKETS			= BIT(9),
	STATION_INFO_TX_RETRIES			= BIT(10),
	STATION_INFO_TX_FAILED			= BIT(11),
	STATION_INFO_RX_DROP_MISC		= BIT(12),
	STATION_INFO_SIGNAL_AVG			= BIT(13),
	STATION_INFO_RX_BITRATE			= BIT(14),
	STATION_INFO_BSS_PARAM			= BIT(15),
	STATION_INFO_CONNECTED_TIME		= BIT(16),
	STATION_INFO_ASSOC_REQ_IES		= BIT(17),
	STATION_INFO_STA_FLAGS			= BIT(18),
	STATION_INFO_BEACON_LOSS_COUNT		= BIT(19),
	STATION_INFO_T_OFFSET			= BIT(20),
	STATION_INFO_LOCAL_PM			= BIT(21),
	STATION_INFO_PEER_PM			= BIT(22),
	STATION_INFO_NONPEER_PM			= BIT(23),
	STATION_INFO_RX_BYTES64			= BIT(24),
	STATION_INFO_TX_BYTES64			= BIT(25),
	STATION_INFO_CHAIN_SIGNAL		= BIT(26),
	STATION_INFO_CHAIN_SIGNAL_AVG		= BIT(27),
	STATION_INFO_EXPECTED_THROUGHPUT	= BIT(28),
927 928 929 930 931 932 933 934
};

/**
 * enum station_info_rate_flags - bitrate info flags
 *
 * Used by the driver to indicate the specific rate transmission
 * type for 802.11n transmissions.
 *
935 936 937 938 939 940
 * @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
941
 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
942
 * @RATE_INFO_FLAGS_60G: 60GHz MCS
943 944
 */
enum rate_info_flags {
945 946 947 948 949 950 951 952
	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),
953 954 955 956 957 958 959 960 961 962
};

/**
 * 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
963
 * @nss: number of streams (VHT only)
964 965 966 967 968
 */
struct rate_info {
	u8 flags;
	u8 mcs;
	u16 legacy;
969
	u8 nss;
970 971
};

972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
/**
 * 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;
};

1003 1004
#define IEEE80211_MAX_CHAINS	4

1005
/**
1006
 * struct station_info - station information
1007
 *
1008
 * Station information filled by driver for get_station() and dump_station.
1009
 *
1010
 * @filled: bitflag of flags from &enum station_info_flags
1011
 * @connected_time: time(in secs) since a station is last connected
1012 1013 1014
 * @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
1015 1016 1017
 * @llid: mesh local link id
 * @plid: mesh peer link id
 * @plink_state: mesh peer link state
1018 1019 1020 1021
 * @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_.
1022 1023 1024
 * @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
1025 1026
 * @txrate: current unicast bitrate from this station
 * @rxrate: current unicast bitrate to this station
1027 1028
 * @rx_packets: packets received from this station
 * @tx_packets: packets transmitted to this station
1029 1030
 * @tx_retries: cumulative retry counts
 * @tx_failed: number of failed transmissions (retries exceeded, no ACK)
1031
 * @rx_dropped_misc:  Dropped for un-specified reason.
1032
 * @bss_param: current BSS parameters
1033 1034 1035 1036
 * @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.
1037 1038 1039 1040 1041
 * @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.
1042
 * @sta_flags: station flags mask & values
1043
 * @beacon_loss_count: Number of times beacon loss event has triggered.
1044
 * @t_offset: Time offset of the station relative to this host.
1045 1046 1047
 * @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
1048 1049
 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
 *	towards this station.
1050
 */
1051
struct station_info {
1052
	u32 filled;
1053
	u32 connected_time;
1054
	u32 inactive_time;
1055 1056
	u64 rx_bytes;
	u64 tx_bytes;
1057 1058 1059
	u16 llid;
	u16 plid;
	u8 plink_state;
1060
	s8 signal;
1061
	s8 signal_avg;
1062 1063 1064 1065 1066

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

1067
	struct rate_info txrate;
1068
	struct rate_info rxrate;
1069 1070
	u32 rx_packets;
	u32 tx_packets;
1071 1072
	u32 tx_retries;
	u32 tx_failed;
1073
	u32 rx_dropped_misc;
1074
	struct sta_bss_parameters bss_param;
1075
	struct nl80211_sta_flag_update sta_flags;
1076 1077

	int generation;
1078 1079 1080

	const u8 *assoc_req_ies;
	size_t assoc_req_ies_len;
1081

1082
	u32 beacon_loss_count;
1083
	s64 t_offset;
1084 1085 1086
	enum nl80211_mesh_power_mode local_pm;
	enum nl80211_mesh_power_mode peer_pm;
	enum nl80211_mesh_power_mode nonpeer_pm;
1087

1088 1089
	u32 expected_throughput;

1090 1091 1092 1093
	/*
	 * Note: Add a new enum station_info_flags value for each new field and
	 * use it to check which fields are initialized.
	 */
1094 1095
};

1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
/**
 * cfg80211_get_station - retrieve information about a given station
 * @dev: the device where the station is supposed to be connected to
 * @mac_addr: the mac address of the station of interest
 * @sinfo: pointer to the structure to fill with the information
 *
 * Returns 0 on success and sinfo is filled with the available information
 * otherwise returns a negative error code and the content of sinfo has to be
 * considered undefined.
 */
int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
			 struct station_info *sinfo);

1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
/**
 * 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
1120
 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1121 1122 1123 1124 1125 1126 1127
 */
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,
1128
	MONITOR_FLAG_ACTIVE		= 1<<NL80211_MNTR_FLAG_ACTIVE,
1129 1130
};

1131 1132 1133 1134 1135 1136
/**
 * 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
1137 1138 1139 1140 1141 1142 1143
 * @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
1144 1145 1146
 */
enum mpath_info_flags {
	MPATH_INFO_FRAME_QLEN		= BIT(0),
1147
	MPATH_INFO_SN			= BIT(1),
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
	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
1162
 * @sn: target sequence number
1163 1164 1165 1166 1167
 * @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
1168 1169 1170 1171
 * @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.
1172 1173 1174 1175
 */
struct mpath_info {
	u32 filled;
	u32 frame_qlen;
1176
	u32 sn;
1177 1178 1179 1180 1181
	u32 metric;
	u32 exptime;
	u32 discovery_timeout;
	u8 discovery_retries;
	u8 flags;
1182 1183

	int generation;
1184 1185
};

1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
/**
 * 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)
1197 1198 1199
 * @basic_rates: basic rates in IEEE 802.11 format
 *	(or NULL for no change)
 * @basic_rates_len: number of basic rates
1200
 * @ap_isolate: do not forward packets between connected stations
1201 1202
 * @ht_opmode: HT Operation mode
 * 	(u16 = opmode, -1 = do not change)
1203 1204
 * @p2p_ctwindow: P2P CT Window (-1 = no change)
 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1205 1206 1207 1208 1209
 */
struct bss_parameters {
	int use_cts_prot;
	int use_short_preamble;
	int use_short_slot_time;
1210
	const u8 *basic_rates;
1211
	u8 basic_rates_len;
1212
	int ap_isolate;
1213
	int ht_opmode;
1214
	s8 p2p_ctwindow, p2p_opp_ps;
1215
};
1216

1217
/**
1218 1219 1220
 * struct mesh_config - 802.11s mesh configuration
 *
 * These parameters can be changed while the mesh is active.
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261