mac80211.h 144 KB
Newer Older
1
/*
2 3
 * mac80211 <-> driver interface
 *
4 5
 * Copyright 2002-2005, Devicescape Software, Inc.
 * Copyright 2006-2007	Jiri Benc <jbenc@suse.cz>
6
 * Copyright 2007-2010	Johannes Berg <johannes@sipsolutions.net>
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * 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.
 */

#ifndef MAC80211_H
#define MAC80211_H

#include <linux/kernel.h>
#include <linux/if_ether.h>
#include <linux/skbuff.h>
#include <linux/device.h>
#include <linux/ieee80211.h>
#include <net/cfg80211.h>
22
#include <asm/unaligned.h>
23

24 25 26 27 28 29 30 31 32 33 34 35 36
/**
 * DOC: Introduction
 *
 * mac80211 is the Linux stack for 802.11 hardware that implements
 * only partial functionality in hard- or firmware. This document
 * defines the interface between mac80211 and low-level hardware
 * drivers.
 */

/**
 * DOC: Calling mac80211 from interrupts
 *
 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37 38 39
 * called in hardware interrupt context. The low-level driver must not call any
 * other functions in hardware interrupt context. If there is a need for such
 * call, the low-level driver should first ACK the interrupt and perform the
40 41 42 43
 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
 * tasklet function.
 *
 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44
 *	 use the non-IRQ-safe functions!
45 46
 */

47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
/**
 * DOC: Warning
 *
 * If you're reading this document and not the header file itself, it will
 * be incomplete because not all documentation has been converted yet.
 */

/**
 * DOC: Frame format
 *
 * As a general rule, when frames are passed between mac80211 and the driver,
 * they start with the IEEE 802.11 header and include the same octets that are
 * sent over the air except for the FCS which should be calculated by the
 * hardware.
 *
 * There are, however, various exceptions to this rule for advanced features:
 *
 * The first exception is for hardware encryption and decryption offload
 * where the IV/ICV may or may not be generated in hardware.
 *
 * Secondly, when the hardware handles fragmentation, the frame handed to
 * the driver from mac80211 is the MSDU, not the MPDU.
 *
 * Finally, for received frames, the driver is able to indicate that it has
 * filled a radiotap header and put that in front of the frame; if it does
 * not do so then mac80211 may add this under certain circumstances.
73 74
 */

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
/**
 * DOC: mac80211 workqueue
 *
 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
 * The workqueue is a single threaded workqueue and can only be accessed by
 * helpers for sanity checking. Drivers must ensure all work added onto the
 * mac80211 workqueue should be cancelled on the driver stop() callback.
 *
 * mac80211 will flushed the workqueue upon interface removal and during
 * suspend.
 *
 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
 *
 */

Johannes Berg's avatar
Johannes Berg committed
90 91 92 93 94 95
/**
 * enum ieee80211_max_queues - maximum number of queues
 *
 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
 */
enum ieee80211_max_queues {
96
	IEEE80211_MAX_QUEUES =		4,
Johannes Berg's avatar
Johannes Berg committed
97 98
};

99 100 101 102 103 104 105 106 107 108 109 110 111
/**
 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
 * @IEEE80211_AC_VO: voice
 * @IEEE80211_AC_VI: video
 * @IEEE80211_AC_BE: best effort
 * @IEEE80211_AC_BK: background
 */
enum ieee80211_ac_numbers {
	IEEE80211_AC_VO		= 0,
	IEEE80211_AC_VI		= 1,
	IEEE80211_AC_BE		= 2,
	IEEE80211_AC_BK		= 3,
};
112
#define IEEE80211_NUM_ACS	4
113

114 115 116 117
/**
 * struct ieee80211_tx_queue_params - transmit queue configuration
 *
 * The information provided in this structure is required for QoS
118
 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
119
 *
120
 * @aifs: arbitration interframe space [0..255]
121 122
 * @cw_min: minimum contention window [a value of the form
 *	2^n-1 in the range 1..32767]
123
 * @cw_max: maximum contention window [like @cw_min]
124
 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
125
 * @uapsd: is U-APSD mode enabled for the queue
126
 */
127
struct ieee80211_tx_queue_params {
128
	u16 txop;
129 130
	u16 cw_min;
	u16 cw_max;
131
	u8 aifs;
132
	bool uapsd;
133 134 135 136 137 138 139 140 141
};

struct ieee80211_low_level_stats {
	unsigned int dot11ACKFailureCount;
	unsigned int dot11RTSFailureCount;
	unsigned int dot11FCSErrorCount;
	unsigned int dot11RTSSuccessCount;
};

142 143 144 145 146 147 148 149 150 151
/**
 * enum ieee80211_bss_change - BSS change notification flags
 *
 * These flags are used with the bss_info_changed() callback
 * to indicate which BSS parameter changed.
 *
 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
 *	also implies a change in the AID.
 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
152
 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler's avatar
Tomas Winkler committed
153
 * @BSS_CHANGED_HT: 802.11n parameters changed
154
 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
155
 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
156 157 158 159 160 161
 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
 *	reason (IBSS and managed mode)
 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
 *	new beacon (beaconing modes)
 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
 *	enabled/disabled (beaconing modes)
162
 * @BSS_CHANGED_CQM: Connection quality monitor config changed
163
 * @BSS_CHANGED_IBSS: IBSS join status changed
164
 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
165 166
 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
 *	that it is only ever disabled for station mode.
167
 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
168
 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
169
 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
170 171 172 173 174
 */
enum ieee80211_bss_change {
	BSS_CHANGED_ASSOC		= 1<<0,
	BSS_CHANGED_ERP_CTS_PROT	= 1<<1,
	BSS_CHANGED_ERP_PREAMBLE	= 1<<2,
175
	BSS_CHANGED_ERP_SLOT		= 1<<3,
Alexander Simon's avatar
Alexander Simon committed
176
	BSS_CHANGED_HT			= 1<<4,
177
	BSS_CHANGED_BASIC_RATES		= 1<<5,
178
	BSS_CHANGED_BEACON_INT		= 1<<6,
179 180 181
	BSS_CHANGED_BSSID		= 1<<7,
	BSS_CHANGED_BEACON		= 1<<8,
	BSS_CHANGED_BEACON_ENABLED	= 1<<9,
182
	BSS_CHANGED_CQM			= 1<<10,
183
	BSS_CHANGED_IBSS		= 1<<11,
184
	BSS_CHANGED_ARP_FILTER		= 1<<12,
185
	BSS_CHANGED_QOS			= 1<<13,
186
	BSS_CHANGED_IDLE		= 1<<14,
187
	BSS_CHANGED_SSID		= 1<<15,
188
	BSS_CHANGED_AP_PROBE_RESP	= 1<<16,
189 190

	/* when adding here, make sure to change ieee80211_reconfig */
191 192
};

193 194 195 196 197 198 199
/*
 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
 * of addresses for an interface increase beyond this value, hardware ARP
 * filtering will be disabled.
 */
#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4

200 201 202 203 204 205 206 207 208 209 210
/**
 * enum ieee80211_rssi_event - RSSI threshold event
 * An indicator for when RSSI goes below/above a certain threshold.
 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
 */
enum ieee80211_rssi_event {
	RSSI_EVENT_HIGH,
	RSSI_EVENT_LOW,
};

211 212 213 214 215 216 217
/**
 * struct ieee80211_bss_conf - holds the BSS's changing parameters
 *
 * This structure keeps information about a BSS (and an association
 * to that BSS) that can change during the lifetime of the BSS.
 *
 * @assoc: association status
218 219
 * @ibss_joined: indicates whether this station is part of an IBSS
 *	or not
220 221
 * @aid: association ID number, valid only when @assoc is true
 * @use_cts_prot: use CTS protection
222 223 224 225 226 227
 * @use_short_preamble: use 802.11b short preamble;
 *	if the hardware cannot handle this it must set the
 *	IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
 * @use_short_slot: use short slot time (only relevant for ERP);
 *	if the hardware cannot handle this it must set the
 *	IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
228
 * @dtim_period: num of beacons before the next DTIM, for beaconing,
229 230 231
 *	valid in station mode only while @assoc is true and if also
 *	requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
 *	@ps_dtim_period)
232 233
 * @timestamp: beacon timestamp
 * @beacon_int: beacon interval
234
 * @assoc_capability: capabilities taken from assoc resp
235 236 237
 * @basic_rates: bitmap of basic rates, each bit stands for an
 *	index into the rate table configured by the driver in
 *	the current band.
238
 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
239 240
 * @bssid: The BSSID for this BSS
 * @enable_beacon: whether beaconing should be enabled or not
241 242 243
 * @channel_type: Channel type for this BSS -- the hardware might be
 *	configured for HT40+ while this BSS only uses no-HT, for
 *	example.
244 245
 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
 *	This field is only valid when the channel type is one of the HT types.
246 247 248
 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
 *	implies disabled
 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
249 250 251 252 253 254 255 256 257
 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
 *	may filter ARP queries targeted for other addresses than listed here.
 *	The driver must allow ARP queries targeted for all address listed here
 *	to pass through. An empty list implies no ARP queries need to pass.
 * @arp_addr_cnt: Number of addresses currently on the list.
 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
 *	filter ARP queries based on the @arp_addr_list, if disabled, the
 *	hardware must not perform any ARP filtering. Note, that the filter will
 *	be enabled also in promiscuous mode.
258
 * @qos: This is a QoS-enabled BSS.
259 260 261
 * @idle: This interface is idle. There's also a global idle flag in the
 *	hardware config which may be more appropriate depending on what
 *	your driver/device needs to do.
262 263 264
 * @ssid: The SSID of the current vif. Only valid in AP-mode.
 * @ssid_len: Length of SSID given in @ssid.
 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
265 266
 */
struct ieee80211_bss_conf {
267
	const u8 *bssid;
268
	/* association related data */
269
	bool assoc, ibss_joined;
270 271 272 273
	u16 aid;
	/* erp related data */
	bool use_cts_prot;
	bool use_short_preamble;
274
	bool use_short_slot;
275
	bool enable_beacon;
276
	u8 dtim_period;
277 278 279
	u16 beacon_int;
	u16 assoc_capability;
	u64 timestamp;
280
	u32 basic_rates;
281
	int mcast_rate[IEEE80211_NUM_BANDS];
282
	u16 ht_operation_mode;
283 284
	s32 cqm_rssi_thold;
	u32 cqm_rssi_hyst;
285
	enum nl80211_channel_type channel_type;
286 287 288
	__be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
	u8 arp_addr_cnt;
	bool arp_filter_enabled;
289
	bool qos;
290
	bool idle;
291 292 293
	u8 ssid[IEEE80211_MAX_SSID_LEN];
	size_t ssid_len;
	bool hidden_ssid;
294 295
};

296
/**
297
 * enum mac80211_tx_control_flags - flags to describe transmission information/status
298
 *
299
 * These flags are used with the @flags member of &ieee80211_tx_info.
300
 *
301
 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
302 303 304 305 306 307 308 309 310 311 312
 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
 *	number to this frame, taking care of not overwriting the fragment
 *	number and increasing the sequence number only when the
 *	IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
 *	assign sequence numbers to QoS-data frames but cannot do so correctly
 *	for non-QoS-data and management frames because beacons need them from
 *	that counter as well and mac80211 cannot guarantee proper sequencing.
 *	If this flag is set, the driver should instruct the hardware to
 *	assign a sequence number to the frame or assign one itself. Cf. IEEE
 *	802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
 *	beacons and always be clear for frames without a sequence number field.
313 314 315 316 317 318
 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
 *	station
 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
319
 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
320
 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
321 322 323 324 325 326 327 328
 *	because the destination STA was in powersave mode. Note that to
 *	avoid race conditions, the filter must be set by the hardware or
 *	firmware upon receiving a frame that indicates that the station
 *	went to sleep (must be done on device to filter frames already on
 *	the queue) and may only be unset after mac80211 gives the OK for
 *	that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
 *	since only then is it guaranteed that no more frames are in the
 *	hardware queue.
329 330 331
 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
 * 	is for the whole aggregation.
332 333
 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
 * 	so consider using block ack request (BAR).
334 335 336
 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
 *	set by rate control algorithms to indicate probe rate, will
 *	be cleared for fragmented frames (except on the last fragment)
337 338 339
 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
 *	used to indicate that a pending frame requires TX processing before
 *	it can be sent out.
340 341
 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
 *	used to indicate that a frame was already retried due to PS
Johannes Berg's avatar
Johannes Berg committed
342 343
 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
 *	used to indicate frame should not be encrypted
Johannes Berg's avatar
Johannes Berg committed
344 345 346
 * @IEEE80211_TX_CTL_POLL_RESPONSE: This frame is a response to a poll
 *	frame (PS-Poll or uAPSD) and should be sent although the station
 *	is in powersave mode.
347 348 349 350
 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
 *	transmit function after the current frame, this can be used
 *	by drivers to kick the DMA queue only if unset or when the
 *	queue gets full.
351 352 353
 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
 *	after TX status because the destination was asleep, it must not
 *	be modified again (no seqno assignment, crypto, etc.)
354 355 356
 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
 *	MLME command (internal to mac80211 to figure out whether to send TX
 *	status to user space)
357
 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
358 359
 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
 *	frame and selects the maximum number of streams that it can use.
360 361 362 363
 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
 *	the off-channel channel when a remain-on-channel offload is done
 *	in hardware -- normal packets still flow and are expected to be
 *	handled properly by the device.
364 365 366
 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
 *	testing. It will be sent out with incorrect Michael MIC key to allow
 *	TKIP countermeasures to be tested.
367 368 369
 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
 *	This flag is actually used for management frame especially for P2P
 *	frames not being sent at CCK rate in 2GHz band.
Johannes Berg's avatar
Johannes Berg committed
370 371 372
 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
 *	when its status is reported the service period ends. For frames in
 *	an SP that mac80211 transmits, it is already set; for driver frames
373 374
 *	the driver may set this flag. It is also used to do the same for
 *	PS-Poll responses.
375 376 377
 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
 *	This flag is used to send nullfunc frame at minimum rate when
 *	the nullfunc is used for connection monitoring purpose.
378 379 380
 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
 *	would be fragmented by size (this is optional, only used for
 *	monitor injection).
381 382 383
 *
 * Note: If you have to add new flags to the enumeration, then don't
 *	 forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
384 385
 */
enum mac80211_tx_control_flags {
386
	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(0),
387 388 389 390 391 392 393 394 395 396 397 398
	IEEE80211_TX_CTL_ASSIGN_SEQ		= BIT(1),
	IEEE80211_TX_CTL_NO_ACK			= BIT(2),
	IEEE80211_TX_CTL_CLEAR_PS_FILT		= BIT(3),
	IEEE80211_TX_CTL_FIRST_FRAGMENT		= BIT(4),
	IEEE80211_TX_CTL_SEND_AFTER_DTIM	= BIT(5),
	IEEE80211_TX_CTL_AMPDU			= BIT(6),
	IEEE80211_TX_CTL_INJECTED		= BIT(7),
	IEEE80211_TX_STAT_TX_FILTERED		= BIT(8),
	IEEE80211_TX_STAT_ACK			= BIT(9),
	IEEE80211_TX_STAT_AMPDU			= BIT(10),
	IEEE80211_TX_STAT_AMPDU_NO_BACK		= BIT(11),
	IEEE80211_TX_CTL_RATE_CTRL_PROBE	= BIT(12),
399
	IEEE80211_TX_INTFL_NEED_TXPROCESSING	= BIT(14),
400
	IEEE80211_TX_INTFL_RETRIED		= BIT(15),
Johannes Berg's avatar
Johannes Berg committed
401
	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(16),
Johannes Berg's avatar
Johannes Berg committed
402
	IEEE80211_TX_CTL_POLL_RESPONSE		= BIT(17),
403
	IEEE80211_TX_CTL_MORE_FRAMES		= BIT(18),
404
	IEEE80211_TX_INTFL_RETRANSMISSION	= BIT(19),
405
	/* hole at 20, use later */
406
	IEEE80211_TX_INTFL_NL80211_FRAME_TX	= BIT(21),
407
	IEEE80211_TX_CTL_LDPC			= BIT(22),
408
	IEEE80211_TX_CTL_STBC			= BIT(23) | BIT(24),
409
	IEEE80211_TX_CTL_TX_OFFCHAN		= BIT(25),
410
	IEEE80211_TX_INTFL_TKIP_MIC_FAILURE	= BIT(26),
411
	IEEE80211_TX_CTL_NO_CCK_RATE		= BIT(27),
Johannes Berg's avatar
Johannes Berg committed
412
	IEEE80211_TX_STATUS_EOSP		= BIT(28),
413
	IEEE80211_TX_CTL_USE_MINRATE		= BIT(29),
414
	IEEE80211_TX_CTL_DONTFRAG		= BIT(30),
415 416
};

Johannes Berg's avatar
Johannes Berg committed
417 418
#define IEEE80211_TX_CTL_STBC_SHIFT		23

419 420 421 422 423 424 425 426 427
/*
 * This definition is used as a mask to clear all temporary flags, which are
 * set by the tx handlers for each transmission attempt by the mac80211 stack.
 */
#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK |		      \
	IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT |    \
	IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU |	      \
	IEEE80211_TX_STAT_TX_FILTERED |	IEEE80211_TX_STAT_ACK |		      \
	IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK |	      \
Johannes Berg's avatar
Johannes Berg committed
428
	IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_POLL_RESPONSE |   \
429
	IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC |		      \
Johannes Berg's avatar
Johannes Berg committed
430
	IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
431

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
/**
 * enum mac80211_rate_control_flags - per-rate flags set by the
 *	Rate Control algorithm.
 *
 * These flags are set by the Rate control algorithm for each rate during tx,
 * in the @flags member of struct ieee80211_tx_rate.
 *
 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
 *	This is set if the current BSS requires ERP protection.
 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
 * @IEEE80211_TX_RC_MCS: HT rate.
 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
 *	Greenfield mode.
 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
 *	adjacent 20 MHz channels, if the current channel type is
 *	NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
 */
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
enum mac80211_rate_control_flags {
	IEEE80211_TX_RC_USE_RTS_CTS		= BIT(0),
	IEEE80211_TX_RC_USE_CTS_PROTECT		= BIT(1),
	IEEE80211_TX_RC_USE_SHORT_PREAMBLE	= BIT(2),

	/* rate index is an MCS rate number instead of an index */
	IEEE80211_TX_RC_MCS			= BIT(3),
	IEEE80211_TX_RC_GREEN_FIELD		= BIT(4),
	IEEE80211_TX_RC_40_MHZ_WIDTH		= BIT(5),
	IEEE80211_TX_RC_DUP_DATA		= BIT(6),
	IEEE80211_TX_RC_SHORT_GI		= BIT(7),
};


/* there are 40 bytes if you don't need the rateset to be kept */
#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
468

469 470
/* if you do need the rateset, then you have less space */
#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
471

472 473
/* maximum number of rate stages */
#define IEEE80211_TX_MAX_RATES	5
474 475

/**
476
 * struct ieee80211_tx_rate - rate selection/status
477
 *
478 479
 * @idx: rate index to attempt to send with
 * @flags: rate control flags (&enum mac80211_rate_control_flags)
480
 * @count: number of tries in this rate before going to the next rate
481 482 483 484 485 486
 *
 * A value of -1 for @idx indicates an invalid rate and, if used
 * in an array of retry rates, that no more rates should be tried.
 *
 * When used for transmit status reporting, the driver should
 * always report the rate along with the flags it used.
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
 *
 * &struct ieee80211_tx_info contains an array of these structs
 * in the control information, and it will be filled by the rate
 * control algorithm according to what should be sent. For example,
 * if this array contains, in the format { <idx>, <count> } the
 * information
 *    { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
 * then this means that the frame should be transmitted
 * up to twice at rate 3, up to twice at rate 2, and up to four
 * times at rate 1 if it doesn't get acknowledged. Say it gets
 * acknowledged by the peer after the fifth attempt, the status
 * information should then contain
 *   { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
 * since it was transmitted twice at rate 3, twice at rate 2
 * and once at rate 1 after which we received an acknowledgement.
502
 */
503 504 505 506
struct ieee80211_tx_rate {
	s8 idx;
	u8 count;
	u8 flags;
507
} __packed;
508

509 510 511 512 513 514 515 516
/**
 * struct ieee80211_tx_info - skb transmit information
 *
 * This structure is placed in skb->cb for three uses:
 *  (1) mac80211 TX control - mac80211 tells the driver what to do
 *  (2) driver internal use (if applicable)
 *  (3) TX status information - driver tells mac80211 what happened
 *
517 518 519
 * The TX control's sta pointer is only valid during the ->tx call,
 * it may be NULL.
 *
520
 * @flags: transmit info flags, defined above
521
 * @band: the band to transmit on (use for checking for races)
522
 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
523
 * @ack_frame_id: internal frame ID for TX status, used internally
524 525 526
 * @control: union for control data
 * @status: union for status data
 * @driver_data: array of driver_data pointers
527
 * @ampdu_ack_len: number of acked aggregated frames.
528
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
529
 * @ampdu_len: number of aggregated frames.
530
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
531
 * @ack_signal: signal strength of the ACK frame
532
 */
533 534 535 536
struct ieee80211_tx_info {
	/* common information */
	u32 flags;
	u8 band;
537

538
	u8 antenna_sel_tx;
539

540
	u16 ack_frame_id;
541 542 543

	union {
		struct {
544 545 546 547 548 549 550 551 552 553
			union {
				/* rate control */
				struct {
					struct ieee80211_tx_rate rates[
						IEEE80211_TX_MAX_RATES];
					s8 rts_cts_rate_idx;
				};
				/* only needed before rate control */
				unsigned long jiffies;
			};
554
			/* NB: vif can be NULL for injected frames */
555 556
			struct ieee80211_vif *vif;
			struct ieee80211_key_conf *hw_key;
557
			struct ieee80211_sta *sta;
558 559
		} control;
		struct {
560 561
			struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
			u8 ampdu_ack_len;
562
			int ack_signal;
563
			u8 ampdu_len;
564
			/* 15 bytes free */
565
		} status;
566 567 568 569 570 571 572 573
		struct {
			struct ieee80211_tx_rate driver_rates[
				IEEE80211_TX_MAX_RATES];
			void *rate_driver_data[
				IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
		};
		void *driver_data[
			IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
574
	};
575 576
};

577
/**
578
 * struct ieee80211_sched_scan_ies - scheduled scan IEs
579 580 581 582 583 584 585 586 587 588 589 590 591
 *
 * This structure is used to pass the appropriate IEs to be used in scheduled
 * scans for all bands.  It contains both the IEs passed from the userspace
 * and the ones generated by mac80211.
 *
 * @ie: array with the IEs for each supported band
 * @len: array with the total length of the IEs for each band
 */
struct ieee80211_sched_scan_ies {
	u8 *ie[IEEE80211_NUM_BANDS];
	size_t len[IEEE80211_NUM_BANDS];
};

592 593 594 595
static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
{
	return (struct ieee80211_tx_info *)skb->cb;
}
596

597 598 599 600 601
static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
{
	return (struct ieee80211_rx_status *)skb->cb;
}

602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
/**
 * ieee80211_tx_info_clear_status - clear TX status
 *
 * @info: The &struct ieee80211_tx_info to be cleared.
 *
 * When the driver passes an skb back to mac80211, it must report
 * a number of things in TX status. This function clears everything
 * in the TX status but the rate control information (it does clear
 * the count since you need to fill that in anyway).
 *
 * NOTE: You can only use this function if you do NOT use
 *	 info->driver_data! Use info->rate_driver_data
 *	 instead if you need only the less space that allows.
 */
static inline void
ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
{
	int i;

	BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
		     offsetof(struct ieee80211_tx_info, control.rates));
	BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
		     offsetof(struct ieee80211_tx_info, driver_rates));
	BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
	/* clear the rate counts */
	for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
		info->status.rates[i].count = 0;

	BUILD_BUG_ON(
	    offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
	memset(&info->status.ampdu_ack_len, 0,
	       sizeof(struct ieee80211_tx_info) -
	       offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
}

637 638 639 640 641 642 643 644 645 646 647 648 649

/**
 * enum mac80211_rx_flags - receive flags
 *
 * These flags are used with the @flag member of &struct ieee80211_rx_status.
 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
 *	Use together with %RX_FLAG_MMIC_STRIPPED.
 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
 *	verification has been done by the hardware.
 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
 *	If this flag is set, the stack cannot do any replay detection
 *	hence the driver or hardware will have to do that.
650 651 652 653
 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
 *	the frame.
 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
 *	the frame.
Johannes Berg's avatar
Johannes Berg committed
654 655 656 657
 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
 *	field) is valid and contains the time the first symbol of the MPDU
 *	was received. This is useful in monitor mode and for proper IBSS
 *	merging.
658
 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
659 660 661
 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
 * @RX_FLAG_SHORT_GI: Short guard interval was used
662 663 664 665 666 667
 */
enum mac80211_rx_flags {
	RX_FLAG_MMIC_ERROR	= 1<<0,
	RX_FLAG_DECRYPTED	= 1<<1,
	RX_FLAG_MMIC_STRIPPED	= 1<<3,
	RX_FLAG_IV_STRIPPED	= 1<<4,
668 669
	RX_FLAG_FAILED_FCS_CRC	= 1<<5,
	RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Berg's avatar
Johannes Berg committed
670
	RX_FLAG_MACTIME_MPDU	= 1<<7,
671 672 673 674
	RX_FLAG_SHORTPRE	= 1<<8,
	RX_FLAG_HT		= 1<<9,
	RX_FLAG_40MHZ		= 1<<10,
	RX_FLAG_SHORT_GI	= 1<<11,
675 676 677 678 679 680 681
};

/**
 * struct ieee80211_rx_status - receive status
 *
 * The low-level driver should provide this information (the subset
 * supported by hardware) to the 802.11 code with each received
682
 * frame, in the skb's control buffer (cb).
683
 *
684 685
 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
 * 	(TSF) timer when the first data symbol (MPDU) arrived at the hardware.
686
 * @band: the active band when this frame was received
687
 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
688 689 690
 * @signal: signal strength when receiving this frame, either in dBm, in dB or
 *	unspecified depending on the hardware capabilities flags
 *	@IEEE80211_HW_SIGNAL_*
691
 * @antenna: antenna used
692 693
 * @rate_idx: index of data rate into band's supported rates or MCS index if
 *	HT rates are use (RX_FLAG_HT)
694
 * @flag: %RX_FLAG_*
695
 * @rx_flags: internal RX flags for mac80211
696
 */
697 698
struct ieee80211_rx_status {
	u64 mactime;
699
	enum ieee80211_band band;
700 701
	int freq;
	int signal;
702
	int antenna;
703
	int rate_idx;
704
	int flag;
705
	unsigned int rx_flags;
706 707
};

708 709 710 711 712
/**
 * enum ieee80211_conf_flags - configuration flags
 *
 * Flags to define PHY configuration options
 *
713 714 715
 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
 *	to determine for example whether to calculate timestamps for packets
 *	or not, do not use instead of filter flags!
716 717 718 719 720 721 722
 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
 *	This is the power save mode defined by IEEE 802.11-2007 section 11.2,
 *	meaning that the hardware still wakes up for beacons, is able to
 *	transmit frames and receive the possible acknowledgment frames.
 *	Not to be confused with hardware specific wakeup/sleep states,
 *	driver is responsible for that. See the section "Powersave support"
 *	for more.
723 724 725 726 727
 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
 *	the driver should be prepared to handle configuration requests but
 *	may turn the device off as much as possible. Typically, this flag will
 *	be set when an interface is set UP but not associated or scanning, but
 *	it can also be unset in that case when monitor interfaces are active.
728 729
 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
 *	operating channel.
730 731
 */
enum ieee80211_conf_flags {
732
	IEEE80211_CONF_MONITOR		= (1<<0),
Johannes Berg's avatar
Johannes Berg committed
733
	IEEE80211_CONF_PS		= (1<<1),
734
	IEEE80211_CONF_IDLE		= (1<<2),
735
	IEEE80211_CONF_OFFCHANNEL	= (1<<3),
736
};
737

738

739 740 741 742
/**
 * enum ieee80211_conf_changed - denotes which configuration changed
 *
 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
743
 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
744
 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
745
 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
746
 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
747
 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
748
 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
749
 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
750 751
 */
enum ieee80211_conf_changed {
752
	IEEE80211_CONF_CHANGE_SMPS		= BIT(1),
753
	IEEE80211_CONF_CHANGE_LISTEN_INTERVAL	= BIT(2),
754
	IEEE80211_CONF_CHANGE_MONITOR		= BIT(3),
755
	IEEE80211_CONF_CHANGE_PS		= BIT(4),
756 757 758
	IEEE80211_CONF_CHANGE_POWER		= BIT(5),
	IEEE80211_CONF_CHANGE_CHANNEL		= BIT(6),
	IEEE80211_CONF_CHANGE_RETRY_LIMITS	= BIT(7),
759
	IEEE80211_CONF_CHANGE_IDLE		= BIT(8),
760 761
};

762 763 764
/**
 * enum ieee80211_smps_mode - spatial multiplexing power save mode
 *
765 766 767 768 769
 * @IEEE80211_SMPS_AUTOMATIC: automatic
 * @IEEE80211_SMPS_OFF: off
 * @IEEE80211_SMPS_STATIC: static
 * @IEEE80211_SMPS_DYNAMIC: dynamic
 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
770 771 772 773 774 775 776 777 778 779 780
 */
enum ieee80211_smps_mode {
	IEEE80211_SMPS_AUTOMATIC,
	IEEE80211_SMPS_OFF,
	IEEE80211_SMPS_STATIC,
	IEEE80211_SMPS_DYNAMIC,

	/* keep last */
	IEEE80211_SMPS_NUM_MODES,
};

781 782 783 784 785
/**
 * struct ieee80211_conf - configuration of the device
 *
 * This struct indicates how the driver shall configure the hardware.
 *
786 787
 * @flags: configuration flags defined above
 *
788
 * @listen_interval: listen interval in units of beacon interval
789
 * @max_sleep_period: the maximum number of beacon intervals to sleep for
790 791 792 793
 *	before checking the beacon for a TIM bit (managed mode only); this
 *	value will be only achievable between DTIM frames, the hardware
 *	needs to check for the multicast traffic bit in DTIM beacons.
 *	This variable is valid only when the CONF_PS flag is set.
794 795 796
 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
 *	in power saving. Power saving will not be enabled until a beacon
 *	has been received and the DTIM period is known.
797 798 799 800
 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
 *	powersave documentation below. This variable is valid only when
 *	the CONF_PS flag is set.
 *
801
 * @power_level: requested transmit power (in dBm)
802
 *
803
 * @channel: the channel to tune to
804
 * @channel_type: the channel (HT) type
805
 *
806 807 808 809 810 811
 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
 *    (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
 *    but actually means the number of transmissions not the number of retries
 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
 *    frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
 *    number of transmissions not the number of retries
812 813 814 815
 *
 * @smps_mode: spatial multiplexing powersave mode; note that
 *	%IEEE80211_SMPS_STATIC is used when the device is not
 *	configured for an HT channel
816 817
 */
struct ieee80211_conf {
818
	u32 flags;
819
	int power_level, dynamic_ps_timeout;
820
	int max_sleep_period;
821

822
	u16 listen_interval;
823
	u8 ps_dtim_period;
824

825 826
	u8 long_frame_max_tx_count, short_frame_max_tx_count;

827
	struct ieee80211_channel *channel;
828
	enum nl80211_channel_type channel_type;
829
	enum ieee80211_smps_mode smps_mode;
830 831
};

832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
/**
 * struct ieee80211_channel_switch - holds the channel switch data
 *
 * The information provided in this structure is required for channel switch
 * operation.
 *
 * @timestamp: value in microseconds of the 64-bit Time Synchronization
 *	Function (TSF) timer when the frame containing the channel switch
 *	announcement was received. This is simply the rx.mactime parameter
 *	the driver passed into mac80211.
 * @block_tx: Indicates whether transmission must be blocked before the
 *	scheduled channel switch, as indicated by the AP.
 * @channel: the new channel to switch to
 * @count: the number of TBTT's until the channel switch event
 */
struct ieee80211_channel_switch {
	u64 timestamp;
	bool block_tx;
	struct ieee80211_channel *channel;
	u8 count;
};

854 855 856 857 858 859
/**
 * struct ieee80211_vif - per-interface data
 *
 * Data in this structure is continually present for driver
 * use during the life of a virtual interface.
 *
860
 * @type: type of this virtual interface
861 862
 * @bss_conf: BSS configuration for this interface, either our own
 *	or the BSS we're associated to
863
 * @addr: address of this interface
864 865
 * @p2p: indicates whether this AP or STA interface is a p2p
 *	interface, i.e. a GO or p2p-sta respectively
866 867 868 869
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *).
 */
struct ieee80211_vif {
870
	enum nl80211_iftype type;
871
	struct ieee80211_bss_conf bss_conf;
872
	u8 addr[ETH_ALEN];
873
	bool p2p;
874 875 876 877
	/* must be last */
	u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
};

Johannes Berg's avatar
Johannes Berg committed
878 879 880
static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
{
#ifdef CONFIG_MAC80211_MESH
881
	return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg's avatar
Johannes Berg committed
882 883 884 885
#endif
	return false;
}

886 887 888 889 890 891 892 893 894 895 896 897 898 899
/**
 * enum ieee80211_key_flags - key flags
 *
 * These flags are used for communication about keys between the driver
 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
 *
 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
 *	that the STA this key will be used with could be using QoS.
 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
 *	driver to indicate that it requires IV generation for this
 *	particular key.
 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
 *	the driver for a TKIP key if it requires Michael MIC
 *	generation in software.
900 901
 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
 *	that the key is pairwise rather then a shared key.
902 903 904
 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
 *	CCMP key if it requires CCMP encryption of management frames (MFP) to
 *	be done in software.
905 906 907 908
 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
 *	for a CCMP key if space should be prepared for the IV, but the IV
 *	itself should not be generated. Do not set together with
 *	@IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
909
 */
910 911 912 913
enum ieee80211_key_flags {
	IEEE80211_KEY_FLAG_WMM_STA	= 1<<0,
	IEEE80211_KEY_FLAG_GENERATE_IV	= 1<<1,
	IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
914
	IEEE80211_KEY_FLAG_PAIRWISE	= 1<<3,
915
	IEEE80211_KEY_FLAG_SW_MGMT	= 1<<4,
916
	IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
917
};
918

919 920 921 922 923 924 925 926
/**
 * struct ieee80211_key_conf - key information
 *
 * This key information is given by mac80211 to the driver by
 * the set_key() callback in &struct ieee80211_ops.
 *
 * @hw_key_idx: To be set by the driver, this is the key index the driver
 *	wants to be given when a frame is transmitted and needs to be
927
 *	encrypted in hardware.
928
 * @cipher: The key's cipher suite selector.
929 930 931
 * @flags: key flags, see &enum ieee80211_key_flags.
 * @keyidx: the key index (0-3)
 * @keylen: key material length
932 933 934 935 936
 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
 * 	data block:
 * 	- Temporal Encryption Key (128 bits)
 * 	- Temporal Authenticator Tx MIC Key (64 bits)
 * 	- Temporal Authenticator Rx MIC Key (64 bits)
937 938
 * @icv_len: The ICV length for this key type
 * @iv_len: The IV length for this key type
939
 */
940
struct ieee80211_key_conf {
941
	u32 cipher;
942 943
	u8 icv_len;
	u8 iv_len;
944
	u8 hw_key_idx;
945 946 947
	u8 flags;
	s8 keyidx;
	u8 keylen;
948 949 950
	u8 key[0];
};

951 952 953 954 955 956 957 958 959
/**
 * enum set_key_cmd - key command
 *
 * Used with the set_key() callback in &struct ieee80211_ops, this
 * indicates whether a key is being removed or added.
 *
 * @SET_KEY: a key is set
 * @DISABLE_KEY: a key must be disabled
 */
960
enum set_key_cmd {
961
	SET_KEY, DISABLE_KEY,
962
};
963

964 965 966 967 968 969 970 971
/**
 * struct ieee80211_sta - station table entry
 *
 * A station table entry represents a station we are possibly
 * communicating with. Since stations are RCU-managed in
 * mac80211, any ieee80211_sta pointer you get access to must
 * either be protected by rcu_read_lock() explicitly or implicitly,
 * or you must take good care to not use such a pointer after a
972
 * call to your sta_remove callback that removed it.
973 974 975
 *
 * @addr: MAC address
 * @aid: AID we assigned to the station if we're an AP
976
 * @supp_rates: Bitmap of supported rates (per band)
Johannes Berg's avatar
Johannes Berg committed
977
 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
978
 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
979 980
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *), size is determined in hw information.
981 982 983
 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
 *	if wme is supported.
 * @max_sp: max Service Period. Only valid if wme is supported.
984 985
 */
struct ieee80211_sta {
986
	u32 supp_rates[IEEE80211_NUM_BANDS];
987 988
	u8 addr[ETH_ALEN];
	u16 aid;
989
	struct ieee80211_sta_ht_cap ht_cap;
990
	bool wme;
991 992
	u8 uapsd_queues;
	u8 max_sp;
993 994 995 996 997

	/* must be last */
	u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
};

998 999 1000 1001
/**
 * enum sta_notify_cmd - sta notify command
 *
 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1002
 * indicates if an associated station made a power state transition.
1003
 *
1004 1005 1006
 * @STA_NOTIFY_SLEEP: a station is now sleeping
 * @STA_NOTIFY_AWAKE: a sleeping station woke up
 */
1007
enum sta_notify_cmd {
1008 1009 1010
	STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
};

1011