mac80211.h 157 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
96
97
/**
 * enum ieee80211_max_queues - maximum number of queues
 *
 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
 */
enum ieee80211_max_queues {
98
	IEEE80211_MAX_QUEUES =		16,
Johannes Berg's avatar
Johannes Berg committed
99
100
};

101
102
#define IEEE80211_INVAL_HW_QUEUE	0xff

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

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

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

146
147
148
/**
 * enum ieee80211_chanctx_change - change flag for channel context
 * @IEEE80211_CHANCTX_CHANGE_CHANNEL_TYPE: The channel type was changed
149
 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
150
151
152
 */
enum ieee80211_chanctx_change {
	IEEE80211_CHANCTX_CHANGE_CHANNEL_TYPE	= BIT(0),
153
	IEEE80211_CHANCTX_CHANGE_RX_CHAINS	= BIT(1),
154
155
156
157
158
159
160
161
162
163
};

/**
 * 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.
 *
 * @channel: the channel to tune to
 * @channel_type: the channel (HT) type
164
165
166
167
168
 * @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;
 *	this will always be >= @rx_chains_always.
169
170
171
172
173
174
175
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *), size is determined in hw information.
 */
struct ieee80211_chanctx_conf {
	struct ieee80211_channel *channel;
	enum nl80211_channel_type channel_type;

176
177
	u8 rx_chains_static, rx_chains_dynamic;

178
179
180
	u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
};

181
182
183
184
185
186
187
188
189
190
/**
 * 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
191
 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler's avatar
Tomas Winkler committed
192
 * @BSS_CHANGED_HT: 802.11n parameters changed
193
 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
194
 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
195
196
197
198
199
200
 * @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)
201
 * @BSS_CHANGED_CQM: Connection quality monitor config changed
202
 * @BSS_CHANGED_IBSS: IBSS join status changed
203
 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
204
205
 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
 *	that it is only ever disabled for station mode.
206
 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
207
 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
208
 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
209
 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
210
211
212
213
214
 */
enum ieee80211_bss_change {
	BSS_CHANGED_ASSOC		= 1<<0,
	BSS_CHANGED_ERP_CTS_PROT	= 1<<1,
	BSS_CHANGED_ERP_PREAMBLE	= 1<<2,
215
	BSS_CHANGED_ERP_SLOT		= 1<<3,
Alexander Simon's avatar
Alexander Simon committed
216
	BSS_CHANGED_HT			= 1<<4,
217
	BSS_CHANGED_BASIC_RATES		= 1<<5,
218
	BSS_CHANGED_BEACON_INT		= 1<<6,
219
220
221
	BSS_CHANGED_BSSID		= 1<<7,
	BSS_CHANGED_BEACON		= 1<<8,
	BSS_CHANGED_BEACON_ENABLED	= 1<<9,
222
	BSS_CHANGED_CQM			= 1<<10,
223
	BSS_CHANGED_IBSS		= 1<<11,
224
	BSS_CHANGED_ARP_FILTER		= 1<<12,
225
	BSS_CHANGED_QOS			= 1<<13,
226
	BSS_CHANGED_IDLE		= 1<<14,
227
	BSS_CHANGED_SSID		= 1<<15,
228
	BSS_CHANGED_AP_PROBE_RESP	= 1<<16,
229
	BSS_CHANGED_PS			= 1<<17,
230
231

	/* when adding here, make sure to change ieee80211_reconfig */
232
233
};

234
235
236
237
238
239
240
/*
 * 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

241
242
243
244
245
246
247
248
249
250
251
/**
 * 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,
};

252
253
254
255
256
257
258
/**
 * 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
259
260
 * @ibss_joined: indicates whether this station is part of an IBSS
 *	or not
261
 * @ibss_creator: indicates if a new IBSS network is being created
262
263
 * @aid: association ID number, valid only when @assoc is true
 * @use_cts_prot: use CTS protection
264
265
266
267
268
269
 * @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
270
 * @dtim_period: num of beacons before the next DTIM, for beaconing,
271
272
273
 *	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)
274
 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
275
 *	as it may have been received during scanning long ago)
276
277
 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
 *	the driver/device can use this to calculate synchronisation
278
 * @beacon_int: beacon interval
279
 * @assoc_capability: capabilities taken from assoc resp
280
281
282
 * @basic_rates: bitmap of basic rates, each bit stands for an
 *	index into the rate table configured by the driver in
 *	the current band.
283
 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
284
285
 * @bssid: The BSSID for this BSS
 * @enable_beacon: whether beaconing should be enabled or not
286
287
288
 * @channel_type: Channel type for this BSS -- the hardware might be
 *	configured for HT40+ while this BSS only uses no-HT, for
 *	example.
289
 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
290
 *	This field is only valid when the channel type is one of the HT types.
291
292
293
 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
 *	implies disabled
 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
294
295
296
297
298
299
300
301
302
 * @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.
303
 * @qos: This is a QoS-enabled BSS.
304
305
306
 * @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.
307
308
 * @ps: power-save mode (STA only). This flag is NOT affected by
 *	offchannel/dynamic_ps operations.
309
310
311
 * @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.
312
313
 */
struct ieee80211_bss_conf {
314
	const u8 *bssid;
315
	/* association related data */
316
	bool assoc, ibss_joined;
317
	bool ibss_creator;
318
319
320
321
	u16 aid;
	/* erp related data */
	bool use_cts_prot;
	bool use_short_preamble;
322
	bool use_short_slot;
323
	bool enable_beacon;
324
	u8 dtim_period;
325
326
	u16 beacon_int;
	u16 assoc_capability;
327
328
	u64 sync_tsf;
	u32 sync_device_ts;
329
	u32 basic_rates;
330
	int mcast_rate[IEEE80211_NUM_BANDS];
331
	u16 ht_operation_mode;
332
333
	s32 cqm_rssi_thold;
	u32 cqm_rssi_hyst;
334
	enum nl80211_channel_type channel_type;
335
336
337
	__be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
	u8 arp_addr_cnt;
	bool arp_filter_enabled;
338
	bool qos;
339
	bool idle;
340
	bool ps;
341
342
343
	u8 ssid[IEEE80211_MAX_SSID_LEN];
	size_t ssid_len;
	bool hidden_ssid;
344
345
};

346
/**
347
 * enum mac80211_tx_control_flags - flags to describe transmission information/status
348
 *
349
 * These flags are used with the @flags member of &ieee80211_tx_info.
350
 *
351
 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
352
353
354
355
356
357
358
359
360
361
362
 * @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.
363
364
365
366
367
368
 * @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
369
 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
370
 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
371
372
373
374
375
376
377
378
 *	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.
379
380
381
 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
 * 	is for the whole aggregation.
382
383
 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
 * 	so consider using block ack request (BAR).
384
385
386
 * @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)
387
388
389
 * @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.
390
391
 * @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
392
393
 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
 *	used to indicate frame should not be encrypted
394
395
396
 * @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.
397
398
399
400
 * @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.
401
402
403
 * @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.)
404
405
406
 * @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)
407
 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
408
409
 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
 *	frame and selects the maximum number of streams that it can use.
410
411
412
413
 * @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.
414
415
416
 * @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.
417
418
419
 * @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
420
421
422
 * @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
423
424
 *	the driver may set this flag. It is also used to do the same for
 *	PS-Poll responses.
425
426
427
 * @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.
428
429
430
 * @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).
431
432
433
 *
 * Note: If you have to add new flags to the enumeration, then don't
 *	 forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
434
435
 */
enum mac80211_tx_control_flags {
436
	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(0),
437
438
439
440
441
442
443
444
445
446
447
448
	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),
449
	IEEE80211_TX_INTFL_NEED_TXPROCESSING	= BIT(14),
450
	IEEE80211_TX_INTFL_RETRIED		= BIT(15),
Johannes Berg's avatar
Johannes Berg committed
451
	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(16),
452
	IEEE80211_TX_CTL_NO_PS_BUFFER		= BIT(17),
453
	IEEE80211_TX_CTL_MORE_FRAMES		= BIT(18),
454
	IEEE80211_TX_INTFL_RETRANSMISSION	= BIT(19),
455
	/* hole at 20, use later */
456
	IEEE80211_TX_INTFL_NL80211_FRAME_TX	= BIT(21),
457
	IEEE80211_TX_CTL_LDPC			= BIT(22),
458
	IEEE80211_TX_CTL_STBC			= BIT(23) | BIT(24),
459
	IEEE80211_TX_CTL_TX_OFFCHAN		= BIT(25),
460
	IEEE80211_TX_INTFL_TKIP_MIC_FAILURE	= BIT(26),
461
	IEEE80211_TX_CTL_NO_CCK_RATE		= BIT(27),
Johannes Berg's avatar
Johannes Berg committed
462
	IEEE80211_TX_STATUS_EOSP		= BIT(28),
463
	IEEE80211_TX_CTL_USE_MINRATE		= BIT(29),
464
	IEEE80211_TX_CTL_DONTFRAG		= BIT(30),
465
466
};

Johannes Berg's avatar
Johannes Berg committed
467
468
#define IEEE80211_TX_CTL_STBC_SHIFT		23

469
470
471
472
473
474
475
476
477
/*
 * 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 |	      \
478
	IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER |    \
479
	IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC |		      \
Johannes Berg's avatar
Johannes Berg committed
480
	IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
481

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

519
520
/* if you do need the rateset, then you have less space */
#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
521

522
/* maximum number of rate stages */
523
#define IEEE80211_TX_MAX_RATES	4
524
525

/**
526
 * struct ieee80211_tx_rate - rate selection/status
527
 *
528
529
 * @idx: rate index to attempt to send with
 * @flags: rate control flags (&enum mac80211_rate_control_flags)
530
 * @count: number of tries in this rate before going to the next rate
531
532
533
534
535
536
 *
 * 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.
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 *
 * &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.
552
 */
553
554
555
556
struct ieee80211_tx_rate {
	s8 idx;
	u8 count;
	u8 flags;
557
} __packed;
558

559
560
561
562
563
564
565
566
567
/**
 * 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
568
 * @band: the band to transmit on (use for checking for races)
569
 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
570
 * @ack_frame_id: internal frame ID for TX status, used internally
571
572
573
 * @control: union for control data
 * @status: union for status data
 * @driver_data: array of driver_data pointers
574
 * @ampdu_ack_len: number of acked aggregated frames.
575
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
576
 * @ampdu_len: number of aggregated frames.
577
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
578
 * @ack_signal: signal strength of the ACK frame
579
 */
580
581
582
583
struct ieee80211_tx_info {
	/* common information */
	u32 flags;
	u8 band;
584

585
	u8 hw_queue;
586

587
	u16 ack_frame_id;
588
589
590

	union {
		struct {
591
592
593
594
595
596
			union {
				/* rate control */
				struct {
					struct ieee80211_tx_rate rates[
						IEEE80211_TX_MAX_RATES];
					s8 rts_cts_rate_idx;
597
					/* 3 bytes free */
598
599
600
601
				};
				/* only needed before rate control */
				unsigned long jiffies;
			};
602
			/* NB: vif can be NULL for injected frames */
603
604
			struct ieee80211_vif *vif;
			struct ieee80211_key_conf *hw_key;
605
			/* 8 bytes free */
606
607
		} control;
		struct {
608
			struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
609
			int ack_signal;
610
			u8 ampdu_ack_len;
611
			u8 ampdu_len;
612
			u8 antenna;
613
			/* 21 bytes free */
614
		} status;
615
616
617
618
619
620
621
622
		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 *)];
623
	};
624
625
};

626
/**
627
 * struct ieee80211_sched_scan_ies - scheduled scan IEs
628
629
630
631
632
633
634
635
636
637
638
639
640
 *
 * 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];
};

641
642
643
644
static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
{
	return (struct ieee80211_tx_info *)skb->cb;
}
645

646
647
648
649
650
static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
{
	return (struct ieee80211_rx_status *)skb->cb;
}

651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
/**
 * 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(
680
	    offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
681
682
683
684
685
	memset(&info->status.ampdu_ack_len, 0,
	       sizeof(struct ieee80211_tx_info) -
	       offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
}

686
687
688
689
690
691
692
693
694
695
696
697
698

/**
 * 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.
699
700
701
702
 * @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
703
704
705
706
 * @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.
707
 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
708
709
710
 * @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
711
712
 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
 *	Valid only for data frames (mainly A-MPDU)
713
714
715
 * @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
716
717
718
719
720
721
722
723
724
725
726
727
728
 * @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)
729
730
 */
enum mac80211_rx_flags {
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
	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),
	RX_FLAG_MACTIME_MPDU		= BIT(7),
	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),
751
752
753
754
755
756
757
};

/**
 * 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
758
 * frame, in the skb's control buffer (cb).
759
 *
760
761
 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
 * 	(TSF) timer when the first data symbol (MPDU) arrived at the hardware.
762
763
 * @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
764
 * @band: the active band when this frame was received
765
 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
766
767
768
 * @signal: signal strength when receiving this frame, either in dBm, in dB or
 *	unspecified depending on the hardware capabilities flags
 *	@IEEE80211_HW_SIGNAL_*
769
 * @antenna: antenna used
770
771
 * @rate_idx: index of data rate into band's supported rates or MCS index if
 *	HT rates are use (RX_FLAG_HT)
772
 * @flag: %RX_FLAG_*
773
 * @rx_flags: internal RX flags for mac80211
774
775
776
 * @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
777
 */
778
779
struct ieee80211_rx_status {
	u64 mactime;
780
	u32 device_timestamp;
781
782
	u32 ampdu_reference;
	u32 flag;
783
784
785
786
787
788
	u16 freq;
	u8 rate_idx;
	u8 rx_flags;
	u8 band;
	u8 antenna;
	s8 signal;
789
	u8 ampdu_delimiter_crc;
790
791
};

792
793
794
795
796
/**
 * enum ieee80211_conf_flags - configuration flags
 *
 * Flags to define PHY configuration options
 *
797
798
799
 * @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!
800
801
802
803
804
805
806
 * @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.
807
808
809
810
811
 * @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.
812
813
 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
 *	operating channel.
814
815
 */
enum ieee80211_conf_flags {
816
	IEEE80211_CONF_MONITOR		= (1<<0),
Johannes Berg's avatar
Johannes Berg committed
817
	IEEE80211_CONF_PS		= (1<<1),
818
	IEEE80211_CONF_IDLE		= (1<<2),
819
	IEEE80211_CONF_OFFCHANNEL	= (1<<3),
820
};
821

822

823
824
825
826
/**
 * enum ieee80211_conf_changed - denotes which configuration changed
 *
 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
827
 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
828
 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
829
 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
830
 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
831
 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
832
 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
833
 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
834
835
 *	Note that this is only valid if channel contexts are not used,
 *	otherwise each channel context has the number of chains listed.
836
837
 */
enum ieee80211_conf_changed {
838
	IEEE80211_CONF_CHANGE_SMPS		= BIT(1),
839
	IEEE80211_CONF_CHANGE_LISTEN_INTERVAL	= BIT(2),
840
	IEEE80211_CONF_CHANGE_MONITOR		= BIT(3),
841
	IEEE80211_CONF_CHANGE_PS		= BIT(4),
842
843
844
	IEEE80211_CONF_CHANGE_POWER		= BIT(5),
	IEEE80211_CONF_CHANGE_CHANNEL		= BIT(6),
	IEEE80211_CONF_CHANGE_RETRY_LIMITS	= BIT(7),
845
	IEEE80211_CONF_CHANGE_IDLE		= BIT(8),
846
847
};

848
849
850
/**
 * enum ieee80211_smps_mode - spatial multiplexing power save mode
 *
851
852
853
854
855
 * @IEEE80211_SMPS_AUTOMATIC: automatic
 * @IEEE80211_SMPS_OFF: off
 * @IEEE80211_SMPS_STATIC: static
 * @IEEE80211_SMPS_DYNAMIC: dynamic
 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
856
857
858
859
860
861
862
863
864
865
866
 */
enum ieee80211_smps_mode {
	IEEE80211_SMPS_AUTOMATIC,
	IEEE80211_SMPS_OFF,
	IEEE80211_SMPS_STATIC,
	IEEE80211_SMPS_DYNAMIC,

	/* keep last */
	IEEE80211_SMPS_NUM_MODES,
};

867
868
869
870
871
/**
 * struct ieee80211_conf - configuration of the device
 *
 * This struct indicates how the driver shall configure the hardware.
 *
872
873
 * @flags: configuration flags defined above
 *
874
 * @listen_interval: listen interval in units of beacon interval
875
 * @max_sleep_period: the maximum number of beacon intervals to sleep for
876
877
878
879
 *	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.
880
881
882
 * @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.
883
884
885
886
 * @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.
 *
887
 * @power_level: requested transmit power (in dBm)
888
 *
889
 * @channel: the channel to tune to
890
 * @channel_type: the channel (HT) type
891
 *
892
893
894
895
896
897
 * @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
898
899
900
 *
 * @smps_mode: spatial multiplexing powersave mode; note that
 *	%IEEE80211_SMPS_STATIC is used when the device is not
901
902
903
 *	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.
904
905
 */
struct ieee80211_conf {
906
	u32 flags;
907
	int power_level, dynamic_ps_timeout;
908
	int max_sleep_period;
909

910
	u16 listen_interval;
911
	u8 ps_dtim_period;
912

913
914
	u8 long_frame_max_tx_count, short_frame_max_tx_count;

915
	struct ieee80211_channel *channel;
916
	enum nl80211_channel_type channel_type;
917
	enum ieee80211_smps_mode smps_mode;
918
919
};

920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
/**
 * 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;
};

942
943
944
945
946
/**
 * 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
947
948
949
950
 * @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.
951
952
953
 */
enum ieee80211_vif_flags {
	IEEE80211_VIF_BEACON_FILTER		= BIT(0),
954
	IEEE80211_VIF_SUPPORTS_CQM_RSSI		= BIT(1),
955
956
};

957
958
959
960
961
962
/**
 * struct ieee80211_vif - per-interface data
 *
 * Data in this structure is continually present for driver
 * use during the life of a virtual interface.
 *
963
 * @type: type of this virtual interface
964
965
 * @bss_conf: BSS configuration for this interface, either our own
 *	or the BSS we're associated to
966
 * @addr: address of this interface
967
968
 * @p2p: indicates whether this AP or STA interface is a p2p
 *	interface, i.e. a GO or p2p-sta respectively
969
970
971
972
 * @driver_flags: flags/capabilities the driver has for this interface,
 *	these need to be set (or cleared) when the interface is added
 *	or, if supported by the driver, the interface type is changed
 *	at runtime, mac80211 will never touch this field
973
974
 * @hw_queue: hardware queue for each AC
 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
975
976
977
978
979
 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
 *	when it is not assigned. This pointer is RCU-protected due to the TX
 *	path needing to access it; even though the netdev carrier will always
 *	be off when it is %NULL there can still be races and packets could be
 *	processed after it switches back to %NULL.
980
981
982
983
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *).
 */
struct ieee80211_vif {
984
	enum nl80211_iftype type;
985
	struct ieee80211_bss_conf bss_conf;
986
	u8 addr[ETH_ALEN];
987
	bool p2p;
988
989
990
991

	u8 cab_queue;
	u8 hw_queue[IEEE80211_NUM_ACS];

992
993
	struct ieee80211_chanctx_conf __rcu *chanctx_conf;

994
	u32 driver_flags;
995

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

Johannes Berg's avatar
Johannes Berg committed
1000
1001
1002
static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
{
#ifdef CONFIG_MAC80211_MESH
1003
	return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg's avatar
Johannes Berg committed
1004
1005
1006
1007
#endif
	return false;
}

1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
/**
 * 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.
1022
1023
 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
 *	that the key is pairwise rather then a shared key.
1024
 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1025
1026
 *	CCMP key if it requires CCMP encryption of management frames (MFP) to
 *	be done in software.
1027
 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1028
 *	if space should be prepared for the IV, but the IV
1029
1030
 *	itself should not be generated. Do not set together with
 *	@IEEE80211_KEY_FLAG_GENERATE_IV on the same key.
1031
1032
1033
1034
1035
1036
1037
 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
 *	management frames. The flag can help drivers that have a hardware
 *	crypto implementation that doesn't deal with management frames
 *	properly by allowing them to not upload the keys to hardware and
 *	fall back to software crypto. Note that this flag deals only with
 *	RX, if your crypto engine can't deal with TX you can also set the
 *	%IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1038
 */
1039
1040
1041
1042
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,
1043
	IEEE80211_KEY_FLAG_PAIRWISE	= 1<<3,
1044
	IEEE80211_KEY_FLAG_SW_MGMT_TX	= 1<<4,
1045
	IEEE80211_KEY_FLAG_PUT_IV_SPACE = 1<<5,
1046
	IEEE80211_KEY_FLAG_RX_MGMT	= 1<<6,
1047
};
1048

1049
1050
1051
1052
1053
1054
1055
1056
/**
 * 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
1057
 *	encrypted in hardware.
1058
 * @cipher: The key's cipher suite selector.
1059
1060
1061
 * @flags: key flags, see &enum ieee80211_key_flags.
 * @keyidx: the key index (0-3)
 * @keylen: key material length
1062
1063
1064
1065
1066
 * @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)
1067
1068
 * @icv_len: The ICV length for this key type
 * @iv_len: The IV length for this key type
1069
 */
1070
struct ieee80211_key_conf {
1071
	u32 cipher;
1072
1073
	u8 icv_len;
	u8 iv_len;
1074
	u8 hw_key_idx;
1075
1076
1077
	u8 flags;
	s8 keyidx;
	u8 keylen;
1078
1079
1080
	u8 key[0];
};

1081
1082
1083
1084
1085
1086
1087
1088
1089
/**
 * 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
 */
1090
enum set_key_cmd {
1091
	SET_KEY, DISABLE_KEY,
1092
};
1093

1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
/**
 * enum ieee80211_sta_state - station state
 *
 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
 *	this is a special state for add/remove transitions
 * @IEEE80211_STA_NONE: station exists without special state
 * @IEEE80211_STA_AUTH: station is authenticated
 * @IEEE80211_STA_ASSOC: station is associated
 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
 */
enum ieee80211_sta_state {
	/* NOTE: These need to be ordered correctly! */
	IEEE80211_STA_NOTEXIST,
	IEEE80211_STA_NONE,
	IEEE80211_STA_AUTH,
	IEEE80211_STA_ASSOC,
	IEEE80211_STA_AUTHORIZED,
};

1113
1114
1115
1116
1117
1118
1119
1120
/**
 * 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
1121
 * call to your sta_remove callback that removed it.
1122
1123
1124
 *
 * @addr: MAC address
 * @aid: AID we assigned to the station if we're an AP
1125
 * @supp_rates: Bitmap of supported rates (per band)
Johannes Berg's avatar
Johannes Berg committed
1126
 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Mahesh Palivela's avatar
Mahesh Palivela committed
1127
1128
 * @vht_cap: VHT capabilities of this STA; Not restricting any capabilities
 * 	of remote STA. Taking as is.
1129
 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
1130
1131
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *), size is determined in hw information.
1132
1133
1134
 * @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.
1135
1136
 */
struct ieee80211_sta {
1137
	u32 supp_rates[IEEE80211_NUM_BANDS];
1138
1139
	u8 addr[ETH_ALEN];
	u16 aid;
1140
	struct ieee80211_sta_ht_cap ht_cap;
Mahesh Palivela's avatar
Mahesh Palivela committed
1141
	struct ieee80211_sta_vht_cap vht_cap;
1142
	bool wme;
1143
1144
	u8 uapsd_queues;
	u8 max_sp;
1145
1146
1147
1148
1149

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

1150
1151
1152
1153
/**
 * enum sta_notify_cmd - sta notify command
 *
 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1154
 * indicates if an associated station made a power state transition.
1155
 *
1156
1157
1158
 * @STA_NOTIFY_SLEEP: a station is now sleeping
 * @STA_NOTIFY_AWAKE: a sleeping station woke up
 */
1159
enum sta_notify_cmd {
1160
1161
1162
	STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
};

1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
/**
 * struct ieee80211_tx_control - TX control data
 *
 * @sta: station table entry, this sta pointer may be NULL and
 * 	it is not allowed to copy the pointer, due to RCU.
 */
struct ieee80211_tx_control {
	struct ieee80211_sta *sta;
};

1173
1174
1175
1176
1177
1178
1179
1180
1181
/**
 * enum ieee80211_hw_flags - hardware flags
 *
 * These flags are used to indicate hardware capabilities to
 * the stack. Generally, flags here should have their meaning
 * done in a way that the simplest hardware doesn't need setting
 * any particular flags. There are some exceptions to this rule,
 * however, so you are advised to review these flags carefully.
 *
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 * @IEEE80211_HW_HAS_RATE_CONTROL:
 *	The hardware or firmware includes rate control, and cannot be
 *	controlled by the stack. As such, no rate control algorithm
 *	should be instantiated, and the TX rate reported to userspace
 *	will be taken from the TX status instead of the rate control
 *	algorithm.
 *	Note that this requires that the driver implement a number of
 *	callbacks so it has the correct information, it needs to have
 *	the @set_rts_threshold callback and must look at the BSS config
 *	@use_cts_prot for G/N protection, @use_short_slot for slot
 *	timing in 2.4 GHz and @use_short_preamble for preambles for
 *	CCK frames.
 *
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
 * @IEEE80211_HW_RX_INCLUDES_FCS:
 *	Indicates that received frames passed to the stack include
 *	the FCS at the end.
 *
 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
 *	Some wireless LAN chipsets buffer broadcast/multicast frames
 *	for power saving stations in the hardware/firmware and others
 *	rely on the host system for such buffering. This option is used
 *	to configure the IEEE 802.11 upper layer to buffer broadcast and
 *	multicast frames when there are power saving stations so that
1205
 *	the driver can fetch them with ieee80211_get_buffered_bc().
1206
 *
1207
1208
1209
1210
1211
1212
 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
 *	Hardware is not capable of short slot operation on the 2.4 GHz band.
 *
 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
 *	Hardware is not capable of receiving frames with short preamble on
 *	the 2.4 GHz band.
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
 *
 * @IEEE80211_HW_SIGNAL_UNSPEC:
 *	Hardware can provide signal values but we don't know its units. We
 *	expect values between 0 and @max_signal.
 *	If possible please provide dB or dBm instead.
 *
 * @IEEE80211_HW_SIGNAL_DBM:
 *	Hardware gives signal values in dBm, decibel difference from
 *	one milliwatt. This is the preferred method since it is standardized
 *	between different devices. @max_signal does not need to be set.
 *
1224
1225
1226
 * @IEEE80211_HW_SPECTRUM_MGMT:
 * 	Hardware supports spectrum management defined in 802.11h
 * 	Measurement, Channel Switch, Quieting, TPC