mac80211.h 181 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
 *
 * 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

16
#include <linux/bug.h>
17
18
19
20
21
#include <linux/kernel.h>
#include <linux/if_ether.h>
#include <linux/skbuff.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.
 *
 */

90
91
struct device;

Johannes Berg's avatar
Johannes Berg committed
92
93
94
95
/**
 * enum ieee80211_max_queues - maximum number of queues
 *
 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
96
 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
Johannes Berg's avatar
Johannes Berg committed
97
98
 */
enum ieee80211_max_queues {
99
	IEEE80211_MAX_QUEUES =		16,
100
	IEEE80211_MAX_QUEUE_MAP =	BIT(IEEE80211_MAX_QUEUES) - 1,
Johannes Berg's avatar
Johannes Berg committed
101
102
};

103
104
#define IEEE80211_INVAL_HW_QUEUE	0xff

105
106
107
108
109
110
111
112
113
114
115
116
117
/**
 * 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,
};
118
#define IEEE80211_NUM_ACS	4
119

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

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

150
151
/**
 * enum ieee80211_chanctx_change - change flag for channel context
152
 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
153
 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
154
 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
155
156
 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
 *	this is used only with channel switching with CSA
157
 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
158
159
 */
enum ieee80211_chanctx_change {
160
	IEEE80211_CHANCTX_CHANGE_WIDTH		= BIT(0),
161
	IEEE80211_CHANCTX_CHANGE_RX_CHAINS	= BIT(1),
162
	IEEE80211_CHANCTX_CHANGE_RADAR		= BIT(2),
163
	IEEE80211_CHANCTX_CHANGE_CHANNEL	= BIT(3),
164
	IEEE80211_CHANCTX_CHANGE_MIN_WIDTH	= BIT(4),
165
166
167
168
169
170
171
172
};

/**
 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
 *
 * This is the driver-visible part. The ieee80211_chanctx
 * that contains it is visible in mac80211 only.
 *
173
 * @def: the channel definition
174
 * @min_def: the minimum channel definition currently required.
175
176
177
178
 * @rx_chains_static: The number of RX chains that must always be
 *	active on the channel to receive MIMO transmissions
 * @rx_chains_dynamic: The number of RX chains that must be enabled
 *	after RTS/CTS handshake to receive SMPS MIMO transmissions;
179
 *	this will always be >= @rx_chains_static.
180
 * @radar_enabled: whether radar detection is enabled on this channel.
181
182
183
184
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *), size is determined in hw information.
 */
struct ieee80211_chanctx_conf {
185
	struct cfg80211_chan_def def;
186
	struct cfg80211_chan_def min_def;
187

188
189
	u8 rx_chains_static, rx_chains_dynamic;

190
191
	bool radar_enabled;

Johannes Berg's avatar
Johannes Berg committed
192
	u8 drv_priv[0] __aligned(sizeof(void *));
193
194
};

195
196
197
198
199
200
201
202
203
204
/**
 * 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
205
 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler's avatar
Tomas Winkler committed
206
 * @BSS_CHANGED_HT: 802.11n parameters changed
207
 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
208
 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
209
210
211
212
213
214
 * @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)
215
 * @BSS_CHANGED_CQM: Connection quality monitor config changed
216
 * @BSS_CHANGED_IBSS: IBSS join status changed
217
 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
218
219
 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
 *	that it is only ever disabled for station mode.
220
 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
221
 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
222
 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
223
 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
224
 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
225
226
 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
 *	changed (currently only in P2P client mode, GO mode will be later)
227
228
 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
 *	currently dtim_period only is under consideration.
229
230
231
 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
 *	note that this is only called when it changes after the channel
 *	context had been assigned.
232
233
234
235
236
 */
enum ieee80211_bss_change {
	BSS_CHANGED_ASSOC		= 1<<0,
	BSS_CHANGED_ERP_CTS_PROT	= 1<<1,
	BSS_CHANGED_ERP_PREAMBLE	= 1<<2,
237
	BSS_CHANGED_ERP_SLOT		= 1<<3,
Alexander Simon's avatar
Alexander Simon committed
238
	BSS_CHANGED_HT			= 1<<4,
239
	BSS_CHANGED_BASIC_RATES		= 1<<5,
240
	BSS_CHANGED_BEACON_INT		= 1<<6,
241
242
243
	BSS_CHANGED_BSSID		= 1<<7,
	BSS_CHANGED_BEACON		= 1<<8,
	BSS_CHANGED_BEACON_ENABLED	= 1<<9,
244
	BSS_CHANGED_CQM			= 1<<10,
245
	BSS_CHANGED_IBSS		= 1<<11,
246
	BSS_CHANGED_ARP_FILTER		= 1<<12,
247
	BSS_CHANGED_QOS			= 1<<13,
248
	BSS_CHANGED_IDLE		= 1<<14,
249
	BSS_CHANGED_SSID		= 1<<15,
250
	BSS_CHANGED_AP_PROBE_RESP	= 1<<16,
251
	BSS_CHANGED_PS			= 1<<17,
252
	BSS_CHANGED_TXPOWER		= 1<<18,
253
	BSS_CHANGED_P2P_PS		= 1<<19,
254
	BSS_CHANGED_BEACON_INFO		= 1<<20,
255
	BSS_CHANGED_BANDWIDTH		= 1<<21,
256
257

	/* when adding here, make sure to change ieee80211_reconfig */
258
259
};

260
261
262
263
264
265
266
/*
 * 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

267
268
269
270
271
272
273
274
275
276
277
/**
 * 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,
};

278
279
280
281
282
283
284
/**
 * 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
285
286
 * @ibss_joined: indicates whether this station is part of an IBSS
 *	or not
287
 * @ibss_creator: indicates if a new IBSS network is being created
288
289
 * @aid: association ID number, valid only when @assoc is true
 * @use_cts_prot: use CTS protection
290
291
292
293
294
295
 * @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
296
 * @dtim_period: num of beacons before the next DTIM, for beaconing,
297
 *	valid in station mode only if after the driver was notified
298
 *	with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
299
 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
300
301
302
303
304
 *	as it may have been received during scanning long ago). If the
 *	HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
 *	only come from a beacon, but might not become valid until after
 *	association when a beacon is received (which is notified with the
 *	%BSS_CHANGED_DTIM flag.)
305
306
 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
 *	the driver/device can use this to calculate synchronisation
307
308
309
 *	(see @sync_tsf)
 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
 *	is requested, see @sync_tsf/@sync_device_ts.
310
 * @beacon_int: beacon interval
311
 * @assoc_capability: capabilities taken from assoc resp
312
313
314
 * @basic_rates: bitmap of basic rates, each bit stands for an
 *	index into the rate table configured by the driver in
 *	the current band.
315
 * @beacon_rate: associated AP's beacon TX rate
316
 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
317
318
 * @bssid: The BSSID for this BSS
 * @enable_beacon: whether beaconing should be enabled or not
319
320
 * @chandef: Channel definition for this BSS -- the hardware might be
 *	configured a higher bandwidth than this BSS uses, for example.
321
 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
322
 *	This field is only valid when the channel type is one of the HT types.
323
324
325
 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
 *	implies disabled
 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
326
327
328
329
 * @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.
330
331
332
 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
 *	may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
 *	array size), it's up to the driver what to do in that case.
333
 * @qos: This is a QoS-enabled BSS.
334
335
336
 * @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.
337
338
 * @ps: power-save mode (STA only). This flag is NOT affected by
 *	offchannel/dynamic_ps operations.
339
 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
340
341
 * @ssid_len: Length of SSID given in @ssid.
 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
342
 * @txpower: TX power in dBm
343
 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
344
345
 */
struct ieee80211_bss_conf {
346
	const u8 *bssid;
347
	/* association related data */
348
	bool assoc, ibss_joined;
349
	bool ibss_creator;
350
351
352
353
	u16 aid;
	/* erp related data */
	bool use_cts_prot;
	bool use_short_preamble;
354
	bool use_short_slot;
355
	bool enable_beacon;
356
	u8 dtim_period;
357
358
	u16 beacon_int;
	u16 assoc_capability;
359
360
	u64 sync_tsf;
	u32 sync_device_ts;
361
	u8 sync_dtim_count;
362
	u32 basic_rates;
363
	struct ieee80211_rate *beacon_rate;
364
	int mcast_rate[IEEE80211_NUM_BANDS];
365
	u16 ht_operation_mode;
366
367
	s32 cqm_rssi_thold;
	u32 cqm_rssi_hyst;
368
	struct cfg80211_chan_def chandef;
369
	__be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
370
	int arp_addr_cnt;
371
	bool qos;
372
	bool idle;
373
	bool ps;
374
375
376
	u8 ssid[IEEE80211_MAX_SSID_LEN];
	size_t ssid_len;
	bool hidden_ssid;
377
	int txpower;
378
	struct ieee80211_p2p_noa_attr p2p_noa_attr;
379
380
};

381
/**
382
 * enum mac80211_tx_info_flags - flags to describe transmission information/status
383
 *
384
 * These flags are used with the @flags member of &ieee80211_tx_info.
385
 *
386
 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
387
388
389
390
391
392
393
394
395
396
397
 * @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.
398
399
400
401
402
403
 * @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
404
 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
405
 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
406
407
408
409
410
411
412
413
 *	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.
414
415
416
 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
 * 	is for the whole aggregation.
417
418
 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
 * 	so consider using block ack request (BAR).
419
420
421
 * @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)
422
423
424
 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
 *	that a frame can be transmitted while the queues are stopped for
 *	off-channel operation.
425
426
427
 * @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.
428
429
 * @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
430
431
 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
 *	used to indicate frame should not be encrypted
432
433
434
 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
 *	frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
 *	be sent although the station is in powersave mode.
435
436
437
438
 * @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.
439
440
441
 * @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.)
442
443
444
 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
 *	code for connection establishment, this indicates that its status
 *	should kick the MLME state machine.
445
446
447
 * @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)
448
 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
449
450
 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
 *	frame and selects the maximum number of streams that it can use.
451
452
453
454
 * @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.
455
456
457
 * @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.
458
459
460
 * @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
461
462
463
 * @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
464
465
 *	the driver may set this flag. It is also used to do the same for
 *	PS-Poll responses.
466
467
468
 * @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.
469
470
471
 * @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).
472
473
 * @IEEE80211_TX_CTL_PS_RESPONSE: This frame is a response to a poll
 *	frame (PS-Poll or uAPSD).
474
475
476
 *
 * Note: If you have to add new flags to the enumeration, then don't
 *	 forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
477
 */
478
enum mac80211_tx_info_flags {
479
	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(0),
480
481
482
483
484
485
486
487
488
489
490
491
	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),
492
	IEEE80211_TX_INTFL_OFFCHAN_TX_OK	= BIT(13),
493
	IEEE80211_TX_INTFL_NEED_TXPROCESSING	= BIT(14),
494
	IEEE80211_TX_INTFL_RETRIED		= BIT(15),
Johannes Berg's avatar
Johannes Berg committed
495
	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(16),
496
	IEEE80211_TX_CTL_NO_PS_BUFFER		= BIT(17),
497
	IEEE80211_TX_CTL_MORE_FRAMES		= BIT(18),
498
	IEEE80211_TX_INTFL_RETRANSMISSION	= BIT(19),
499
	IEEE80211_TX_INTFL_MLME_CONN_TX		= BIT(20),
500
	IEEE80211_TX_INTFL_NL80211_FRAME_TX	= BIT(21),
501
	IEEE80211_TX_CTL_LDPC			= BIT(22),
502
	IEEE80211_TX_CTL_STBC			= BIT(23) | BIT(24),
503
	IEEE80211_TX_CTL_TX_OFFCHAN		= BIT(25),
504
	IEEE80211_TX_INTFL_TKIP_MIC_FAILURE	= BIT(26),
505
	IEEE80211_TX_CTL_NO_CCK_RATE		= BIT(27),
Johannes Berg's avatar
Johannes Berg committed
506
	IEEE80211_TX_STATUS_EOSP		= BIT(28),
507
	IEEE80211_TX_CTL_USE_MINRATE		= BIT(29),
508
	IEEE80211_TX_CTL_DONTFRAG		= BIT(30),
509
	IEEE80211_TX_CTL_PS_RESPONSE		= BIT(31),
510
511
};

Johannes Berg's avatar
Johannes Berg committed
512
513
#define IEEE80211_TX_CTL_STBC_SHIFT		23

514
515
516
517
518
519
520
521
522
523
524
525
/**
 * enum mac80211_tx_control_flags - flags to describe transmit control
 *
 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
 *	protocol frame (e.g. EAP)
 *
 * These flags are used in tx_info->control.flags.
 */
enum mac80211_tx_control_flags {
	IEEE80211_TX_CTRL_PORT_CTRL_PROTO	= BIT(0),
};

526
527
528
529
530
531
532
533
534
/*
 * 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 |	      \
535
	IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER |    \
536
	IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC |		      \
Johannes Berg's avatar
Johannes Berg committed
537
	IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
538

539
540
541
542
543
544
545
546
547
548
549
550
/**
 * 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.
551
552
 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
 *	into a higher 4 bits (Nss) and lower 4 bits (MCS number)
553
554
555
 * @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.
556
557
558
 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
 *	(80+80 isn't supported yet)
559
560
561
562
563
 * @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.
 */
564
565
566
567
568
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),

569
	/* rate index is an HT/VHT MCS instead of an index */
570
571
572
573
574
	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),
575
576
577
	IEEE80211_TX_RC_VHT_MCS			= BIT(8),
	IEEE80211_TX_RC_80_MHZ_WIDTH		= BIT(9),
	IEEE80211_TX_RC_160_MHZ_WIDTH		= BIT(10),
578
579
580
581
582
};


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

584
585
/* if you do need the rateset, then you have less space */
#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
586

587
/* maximum number of rate stages */
588
#define IEEE80211_TX_MAX_RATES	4
589

590
591
592
/* maximum number of rate table entries */
#define IEEE80211_TX_RATE_TABLE_SIZE	4

593
/**
594
 * struct ieee80211_tx_rate - rate selection/status
595
 *
596
597
 * @idx: rate index to attempt to send with
 * @flags: rate control flags (&enum mac80211_rate_control_flags)
598
 * @count: number of tries in this rate before going to the next rate
599
600
601
602
603
604
 *
 * 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.
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 *
 * &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.
620
 */
621
622
struct ieee80211_tx_rate {
	s8 idx;
623
624
	u16 count:5,
	    flags:11;
625
} __packed;
626

627
628
629
630
631
632
#define IEEE80211_MAX_TX_RETRY		31

static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
					  u8 mcs, u8 nss)
{
	WARN_ON(mcs & ~0xF);
Karl Beldan's avatar
Karl Beldan committed
633
634
	WARN_ON((nss - 1) & ~0x7);
	rate->idx = ((nss - 1) << 4) | mcs;
635
636
637
638
639
640
641
642
643
644
645
}

static inline u8
ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
{
	return rate->idx & 0xF;
}

static inline u8
ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
{
Karl Beldan's avatar
Karl Beldan committed
646
	return (rate->idx >> 4) + 1;
647
648
}

649
650
651
652
653
654
655
656
657
/**
 * 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
 *
 * @flags: transmit info flags, defined above
658
 * @band: the band to transmit on (use for checking for races)
659
 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
660
 * @ack_frame_id: internal frame ID for TX status, used internally
661
662
663
 * @control: union for control data
 * @status: union for status data
 * @driver_data: array of driver_data pointers
664
 * @ampdu_ack_len: number of acked aggregated frames.
665
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
666
 * @ampdu_len: number of aggregated frames.
667
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
668
 * @ack_signal: signal strength of the ACK frame
669
 */
670
671
672
673
struct ieee80211_tx_info {
	/* common information */
	u32 flags;
	u8 band;
674

675
	u8 hw_queue;
676

677
	u16 ack_frame_id;
678
679
680

	union {
		struct {
681
682
683
684
685
686
			union {
				/* rate control */
				struct {
					struct ieee80211_tx_rate rates[
						IEEE80211_TX_MAX_RATES];
					s8 rts_cts_rate_idx;
687
688
					u8 use_rts:1;
					u8 use_cts_prot:1;
689
690
					u8 short_preamble:1;
					u8 skip_table:1;
691
					/* 2 bytes free */
692
693
694
695
				};
				/* only needed before rate control */
				unsigned long jiffies;
			};
696
			/* NB: vif can be NULL for injected frames */
697
698
			struct ieee80211_vif *vif;
			struct ieee80211_key_conf *hw_key;
699
700
			u32 flags;
			/* 4 bytes free */
701
702
		} control;
		struct {
703
			struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
704
			int ack_signal;
705
			u8 ampdu_ack_len;
706
			u8 ampdu_len;
707
			u8 antenna;
708
			/* 21 bytes free */
709
		} status;
710
711
712
		struct {
			struct ieee80211_tx_rate driver_rates[
				IEEE80211_TX_MAX_RATES];
713
714
			u8 pad[4];

715
716
717
718
719
			void *rate_driver_data[
				IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
		};
		void *driver_data[
			IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
720
	};
721
722
};

723
/**
724
 * struct ieee80211_sched_scan_ies - scheduled scan IEs
725
726
727
728
729
730
731
732
733
734
735
736
737
 *
 * 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];
};

738
739
740
741
static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
{
	return (struct ieee80211_tx_info *)skb->cb;
}
742

743
744
745
746
747
static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
{
	return (struct ieee80211_rx_status *)skb->cb;
}

748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
/**
 * 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(
777
	    offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
778
779
780
781
782
	memset(&info->status.ampdu_ack_len, 0,
	       sizeof(struct ieee80211_tx_info) -
	       offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
}

783
784
785
786
787
788
789
790
791
792
793
794
795

/**
 * 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.
796
797
798
799
 * @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.
800
 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
Johannes Berg's avatar
Johannes Berg committed
801
802
803
 *	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.
804
805
806
 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
 *	field) is valid and contains the time the last symbol of the MPDU
 *	(including FCS) was received.
807
 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
808
 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
809
 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
810
 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
811
812
813
 * @RX_FLAG_80MHZ: 80 MHz was used
 * @RX_FLAG_80P80MHZ: 80+80 MHz was used
 * @RX_FLAG_160MHZ: 160 MHz was used
814
 * @RX_FLAG_SHORT_GI: Short guard interval was used
815
816
 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
 *	Valid only for data frames (mainly A-MPDU)
817
818
819
 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
 *	the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
 *	to hw.radiotap_mcs_details to advertise that fact
820
821
822
823
824
825
826
827
828
829
830
831
832
 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
 *	number (@ampdu_reference) must be populated and be a distinct number for
 *	each A-MPDU
 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes
 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for
 *	monitoring purposes only
 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
 *	subframes of a single A-MPDU
 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
 *	on this subframe
 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
 *	is stored in the @ampdu_delimiter_crc field)
833
 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
834
835
 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
836
837
838
839
840
841
842
843
844
 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
 *	subframes instead of a one huge frame for performance reasons.
 *	All, but the last MSDU from an A-MSDU should have this flag set. E.g.
 *	if an A-MSDU has 3 frames, the first 2 must have the flag set, while
 *	the 3rd (last) one must not have this flag set. The flag is used to
 *	deal with retransmission/duplication recovery properly since A-MSDU
 *	subframes share the same sequence number. Reported subframes can be
 *	either regular MSDU or singly A-MSDUs. Subframes must not be
 *	interleaved with other frames.
845
846
 */
enum mac80211_rx_flags {
847
848
849
850
851
852
	RX_FLAG_MMIC_ERROR		= BIT(0),
	RX_FLAG_DECRYPTED		= BIT(1),
	RX_FLAG_MMIC_STRIPPED		= BIT(3),
	RX_FLAG_IV_STRIPPED		= BIT(4),
	RX_FLAG_FAILED_FCS_CRC		= BIT(5),
	RX_FLAG_FAILED_PLCP_CRC 	= BIT(6),
853
	RX_FLAG_MACTIME_START		= BIT(7),
854
855
856
857
858
859
860
861
862
863
864
865
866
	RX_FLAG_SHORTPRE		= BIT(8),
	RX_FLAG_HT			= BIT(9),
	RX_FLAG_40MHZ			= BIT(10),
	RX_FLAG_SHORT_GI		= BIT(11),
	RX_FLAG_NO_SIGNAL_VAL		= BIT(12),
	RX_FLAG_HT_GF			= BIT(13),
	RX_FLAG_AMPDU_DETAILS		= BIT(14),
	RX_FLAG_AMPDU_REPORT_ZEROLEN	= BIT(15),
	RX_FLAG_AMPDU_IS_ZEROLEN	= BIT(16),
	RX_FLAG_AMPDU_LAST_KNOWN	= BIT(17),
	RX_FLAG_AMPDU_IS_LAST		= BIT(18),
	RX_FLAG_AMPDU_DELIM_CRC_ERROR	= BIT(19),
	RX_FLAG_AMPDU_DELIM_CRC_KNOWN	= BIT(20),
867
	RX_FLAG_MACTIME_END		= BIT(21),
868
869
870
871
	RX_FLAG_VHT			= BIT(22),
	RX_FLAG_80MHZ			= BIT(23),
	RX_FLAG_80P80MHZ		= BIT(24),
	RX_FLAG_160MHZ			= BIT(25),
872
	RX_FLAG_STBC_MASK		= BIT(26) | BIT(27),
873
874
	RX_FLAG_10MHZ			= BIT(28),
	RX_FLAG_5MHZ			= BIT(29),
875
	RX_FLAG_AMSDU_MORE		= BIT(30),
876
877
};

878
879
#define RX_FLAG_STBC_SHIFT		26

880
881
882
883
884
/**
 * 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
885
 * frame, in the skb's control buffer (cb).
886
 *
887
888
 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
 * 	(TSF) timer when the first data symbol (MPDU) arrived at the hardware.
889
890
 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
 *	it but can store it and pass it back to the driver for synchronisation
891
 * @band: the active band when this frame was received
892
 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
893
894
895
 * @signal: signal strength when receiving this frame, either in dBm, in dB or
 *	unspecified depending on the hardware capabilities flags
 *	@IEEE80211_HW_SIGNAL_*
896
897
898
899
 * @chains: bitmask of receive chains for which separate signal strength
 *	values were filled.
 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
 *	support dB or unspecified units)
900
 * @antenna: antenna used
901
 * @rate_idx: index of data rate into band's supported rates or MCS index if
902
903
 *	HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
 * @vht_nss: number of streams (VHT only)
904
 * @flag: %RX_FLAG_*
905
 * @rx_flags: internal RX flags for mac80211
906
907
908
 * @ampdu_reference: A-MPDU reference number, must be a different value for
 *	each A-MPDU but the same for each subframe within one A-MPDU
 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
909
910
911
912
913
914
915
 * @vendor_radiotap_bitmap: radiotap vendor namespace presence bitmap
 * @vendor_radiotap_len: radiotap vendor namespace length
 * @vendor_radiotap_align: radiotap vendor namespace alignment. Note
 *	that the actual data must be at the start of the SKB data
 *	already.
 * @vendor_radiotap_oui: radiotap vendor namespace OUI
 * @vendor_radiotap_subns: radiotap vendor sub namespace
916
 */
917
918
struct ieee80211_rx_status {
	u64 mactime;
919
	u32 device_timestamp;
920
921
	u32 ampdu_reference;
	u32 flag;
922
923
	u32 vendor_radiotap_bitmap;
	u16 vendor_radiotap_len;
924
925
	u16 freq;
	u8 rate_idx;
926
	u8 vht_nss;
927
928
929
930
	u8 rx_flags;
	u8 band;
	u8 antenna;
	s8 signal;
931
932
	u8 chains;
	s8 chain_signal[IEEE80211_MAX_CHAINS];
933
	u8 ampdu_delimiter_crc;
934
935
936
	u8 vendor_radiotap_align;
	u8 vendor_radiotap_oui[3];
	u8 vendor_radiotap_subns;
937
938
};

939
940
941
942
943
/**
 * enum ieee80211_conf_flags - configuration flags
 *
 * Flags to define PHY configuration options
 *
944
945
946
 * @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!
947
948
949
950
951
952
953
 * @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.
954
955
956
957
958
 * @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.
959
960
 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
 *	operating channel.
961
962
 */
enum ieee80211_conf_flags {
963
	IEEE80211_CONF_MONITOR		= (1<<0),
Johannes Berg's avatar
Johannes Berg committed
964
	IEEE80211_CONF_PS		= (1<<1),
965
	IEEE80211_CONF_IDLE		= (1<<2),
966
	IEEE80211_CONF_OFFCHANNEL	= (1<<3),
967
};
968

969

970
971
972
973
/**
 * enum ieee80211_conf_changed - denotes which configuration changed
 *
 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
974
 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
975
 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
976
 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
977
 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
978
 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
979
 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
980
 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
981
982
 *	Note that this is only valid if channel contexts are not used,
 *	otherwise each channel context has the number of chains listed.
983
984
 */
enum ieee80211_conf_changed {
985
	IEEE80211_CONF_CHANGE_SMPS		= BIT(1),
986
	IEEE80211_CONF_CHANGE_LISTEN_INTERVAL	= BIT(2),
987
	IEEE80211_CONF_CHANGE_MONITOR		= BIT(3),
988
	IEEE80211_CONF_CHANGE_PS		= BIT(4),
989
990
991
	IEEE80211_CONF_CHANGE_POWER		= BIT(5),
	IEEE80211_CONF_CHANGE_CHANNEL		= BIT(6),
	IEEE80211_CONF_CHANGE_RETRY_LIMITS	= BIT(7),
992
	IEEE80211_CONF_CHANGE_IDLE		= BIT(8),
993
994
};

995
996
997
/**
 * enum ieee80211_smps_mode - spatial multiplexing power save mode
 *
998
999
1000
1001
1002
 * @IEEE80211_SMPS_AUTOMATIC: automatic
 * @IEEE80211_SMPS_OFF: off
 * @IEEE80211_SMPS_STATIC: static
 * @IEEE80211_SMPS_DYNAMIC: dynamic
 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
 */
enum ieee80211_smps_mode {
	IEEE80211_SMPS_AUTOMATIC,
	IEEE80211_SMPS_OFF,
	IEEE80211_SMPS_STATIC,
	IEEE80211_SMPS_DYNAMIC,

	/* keep last */
	IEEE80211_SMPS_NUM_MODES,
};

1014
1015
1016
1017
1018
/**
 * struct ieee80211_conf - configuration of the device
 *
 * This struct indicates how the driver shall configure the hardware.
 *
1019
1020
 * @flags: configuration flags defined above
 *
1021
 * @listen_interval: listen interval in units of beacon interval
1022
 * @max_sleep_period: the maximum number of beacon intervals to sleep for
1023
1024
1025
1026
 *	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.
1027
1028
1029
 * @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.
1030
1031
1032
1033
 * @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.
 *
1034
1035
 * @power_level: requested transmit power (in dBm), backward compatibility
 *	value only that is set to the minimum of all interfaces
1036
 *
1037
 * @chandef: the channel definition to tune to
1038
 * @radar_enabled: whether radar detection is enabled
1039
 *
1040
 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1041
1042
 *	(a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
 *	but actually means the number of transmissions not the number of retries
1043
 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1044
1045
 *	frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
 *	number of transmissions not the number of retries
1046
1047
1048
 *
 * @smps_mode: spatial multiplexing powersave mode; note that
 *	%IEEE80211_SMPS_STATIC is used when the device is not
1049
1050
1051
 *	configured for an HT channel.
 *	Note that this is only valid if channel contexts are not used,
 *	otherwise each channel context has the number of chains listed.
1052
1053
 */
struct ieee80211_conf {
1054
	u32 flags;
1055
	int power_level, dynamic_ps_timeout;
1056
	int max_sleep_period;
1057

1058
	u16 listen_interval;
1059
	u8 ps_dtim_period;
1060

1061
1062
	u8 long_frame_max_tx_count, short_frame_max_tx_count;

1063
	struct cfg80211_chan_def chandef;
1064
	bool radar_enabled;
1065
	enum ieee80211_smps_mode smps_mode;
1066
1067
};

1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
/**
 * 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.
1080
 * @chandef: the new channel to switch to
1081
1082
1083
1084
1085
 * @count: the number of TBTT's until the channel switch event
 */
struct ieee80211_channel_switch {
	u64 timestamp;
	bool block_tx;
1086
	struct cfg80211_chan_def chandef;
1087
1088
1089
	u8 count;
};

1090
1091
1092
1093
1094
/**
 * enum ieee80211_vif_flags - virtual interface flags
 *
 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
 *	on this virtual interface to avoid unnecessary CPU wakeups
1095
1096
1097
1098
 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
 *	monitoring on this virtual interface -- i.e. it can monitor
 *	connection quality related parameters, such as the RSSI level and
 *	provide notifications if configured trigger levels are reached.
1099
1100
1101
 */
enum ieee80211_vif_flags {
	IEEE80211_VIF_BEACON_FILTER		= BIT(0),
1102
	IEEE80211_VIF_SUPPORTS_CQM_RSSI		= BIT(1),
1103
1104
};

1105
1106
1107
1108
1109
1110
/**
 * struct ieee80211_vif - per-interface data
 *
 * Data in this structure is continually present for driver
 * use during the life of a virtual interface.
 *
1111
 * @type: type of this virtual interface
1112
1113
 * @bss_conf: BSS configuration for this interface, either our own
 *	or the BSS we're associated to
1114
 * @addr: address of this interface
Johannes Berg's avatar