mac80211.h 100 KB
Newer Older
1
/*
2
3
 * mac80211 <-> driver interface
 *
4
5
 * Copyright 2002-2005, Devicescape Software, Inc.
 * Copyright 2006-2007	Jiri Benc <jbenc@suse.cz>
6
 * Copyright 2007-2010	Johannes Berg <johannes@sipsolutions.net>
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef MAC80211_H
#define MAC80211_H

#include <linux/kernel.h>
#include <linux/if_ether.h>
#include <linux/skbuff.h>
#include <linux/wireless.h>
#include <linux/device.h>
#include <linux/ieee80211.h>
#include <net/cfg80211.h>

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

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

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

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

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

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

99
100
101
102
/**
 * struct ieee80211_tx_queue_params - transmit queue configuration
 *
 * The information provided in this structure is required for QoS
103
 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
104
 *
105
 * @aifs: arbitration interframe space [0..255]
106
107
 * @cw_min: minimum contention window [a value of the form
 *	2^n-1 in the range 1..32767]
108
 * @cw_max: maximum contention window [like @cw_min]
109
 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
110
 * @uapsd: is U-APSD mode enabled for the queue
111
 */
112
struct ieee80211_tx_queue_params {
113
	u16 txop;
114
115
	u16 cw_min;
	u16 cw_max;
116
	u8 aifs;
117
	bool uapsd;
118
119
120
121
122
123
124
125
126
};

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

127
128
129
130
131
132
133
134
135
136
/**
 * 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
137
 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler's avatar
Tomas Winkler committed
138
 * @BSS_CHANGED_HT: 802.11n parameters changed
139
 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
140
 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
141
142
143
144
145
146
 * @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)
147
 * @BSS_CHANGED_CQM: Connection quality monitor config changed
148
 * @BSS_CHANGED_IBSS: IBSS join status changed
149
150
151
152
153
 */
enum ieee80211_bss_change {
	BSS_CHANGED_ASSOC		= 1<<0,
	BSS_CHANGED_ERP_CTS_PROT	= 1<<1,
	BSS_CHANGED_ERP_PREAMBLE	= 1<<2,
154
	BSS_CHANGED_ERP_SLOT		= 1<<3,
Tomas Winkler's avatar
Tomas Winkler committed
155
	BSS_CHANGED_HT                  = 1<<4,
156
	BSS_CHANGED_BASIC_RATES		= 1<<5,
157
	BSS_CHANGED_BEACON_INT		= 1<<6,
158
159
160
	BSS_CHANGED_BSSID		= 1<<7,
	BSS_CHANGED_BEACON		= 1<<8,
	BSS_CHANGED_BEACON_ENABLED	= 1<<9,
161
	BSS_CHANGED_CQM			= 1<<10,
162
	BSS_CHANGED_IBSS		= 1<<11,
163
164

	/* when adding here, make sure to change ieee80211_reconfig */
165
166
167
168
169
170
171
172
173
};

/**
 * 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
174
175
 * @ibss_joined: indicates whether this station is part of an IBSS
 *	or not
176
177
 * @aid: association ID number, valid only when @assoc is true
 * @use_cts_prot: use CTS protection
178
179
180
181
182
183
 * @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
184
185
 * @dtim_period: num of beacons before the next DTIM, for beaconing,
 *	not valid in station mode (cf. hw conf ps_dtim_period)
186
187
 * @timestamp: beacon timestamp
 * @beacon_int: beacon interval
188
 * @assoc_capability: capabilities taken from assoc resp
189
190
191
 * @basic_rates: bitmap of basic rates, each bit stands for an
 *	index into the rate table configured by the driver in
 *	the current band.
192
193
 * @bssid: The BSSID for this BSS
 * @enable_beacon: whether beaconing should be enabled or not
194
195
196
 * @channel_type: Channel type for this BSS -- the hardware might be
 *	configured for HT40+ while this BSS only uses no-HT, for
 *	example.
197
198
 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
 *	This field is only valid when the channel type is one of the HT types.
199
200
201
 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
 *	implies disabled
 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
202
203
 */
struct ieee80211_bss_conf {
204
	const u8 *bssid;
205
	/* association related data */
206
	bool assoc, ibss_joined;
207
208
209
210
	u16 aid;
	/* erp related data */
	bool use_cts_prot;
	bool use_short_preamble;
211
	bool use_short_slot;
212
	bool enable_beacon;
213
	u8 dtim_period;
214
215
216
	u16 beacon_int;
	u16 assoc_capability;
	u64 timestamp;
217
	u32 basic_rates;
218
	u16 ht_operation_mode;
219
220
	s32 cqm_rssi_thold;
	u32 cqm_rssi_hyst;
221
	enum nl80211_channel_type channel_type;
222
223
};

224
/**
225
 * enum mac80211_tx_control_flags - flags to describe transmission information/status
226
 *
227
 * These flags are used with the @flags member of &ieee80211_tx_info.
228
 *
229
 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
230
231
232
233
234
235
236
237
238
239
240
 * @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.
241
242
243
244
245
246
 * @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
247
 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
248
 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
249
250
251
252
253
254
255
256
 *	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.
257
258
259
 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
 * 	is for the whole aggregation.
260
261
 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
 * 	so consider using block ack request (BAR).
262
263
264
 * @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)
265
266
267
 * @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.
268
269
 * @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
270
271
 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
 *	used to indicate frame should not be encrypted
272
273
274
 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
 *	This frame is a response to a PS-poll frame and should be sent
 *	although the station is in powersave mode.
275
276
277
278
 * @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.
279
280
281
 * @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.)
282
283
 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
 *	has a radiotap header at skb->data.
284
285
286
 * @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)
287
 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
288
289
 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
 *	frame and selects the maximum number of streams that it can use.
290
291
 */
enum mac80211_tx_control_flags {
292
	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(0),
293
294
295
296
297
298
299
300
301
302
303
304
	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),
305
	IEEE80211_TX_INTFL_NEED_TXPROCESSING	= BIT(14),
306
	IEEE80211_TX_INTFL_RETRIED		= BIT(15),
Johannes Berg's avatar
Johannes Berg committed
307
	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(16),
308
	IEEE80211_TX_CTL_PSPOLL_RESPONSE	= BIT(17),
309
	IEEE80211_TX_CTL_MORE_FRAMES		= BIT(18),
310
	IEEE80211_TX_INTFL_RETRANSMISSION	= BIT(19),
311
	IEEE80211_TX_INTFL_HAS_RADIOTAP		= BIT(20),
312
	IEEE80211_TX_INTFL_NL80211_FRAME_TX	= BIT(21),
313
	IEEE80211_TX_CTL_LDPC			= BIT(22),
314
315
	IEEE80211_TX_CTL_STBC			= BIT(23) | BIT(24),
#define IEEE80211_TX_CTL_STBC_SHIFT		23
316
317
};

318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
/**
 * 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.
 */
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
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
354

355
356
/* if you do need the rateset, then you have less space */
#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
357

358
359
/* maximum number of rate stages */
#define IEEE80211_TX_MAX_RATES	5
360
361

/**
362
 * struct ieee80211_tx_rate - rate selection/status
363
 *
364
365
 * @idx: rate index to attempt to send with
 * @flags: rate control flags (&enum mac80211_rate_control_flags)
366
 * @count: number of tries in this rate before going to the next rate
367
368
369
370
371
372
 *
 * 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.
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 *
 * &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.
388
 */
389
390
391
392
struct ieee80211_tx_rate {
	s8 idx;
	u8 count;
	u8 flags;
393
} __attribute__((packed));
394

395
396
397
398
399
400
401
402
/**
 * 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
 *
403
404
405
 * The TX control's sta pointer is only valid during the ->tx call,
 * it may be NULL.
 *
406
 * @flags: transmit info flags, defined above
407
 * @band: the band to transmit on (use for checking for races)
408
 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
409
 * @pad: padding, ignore
410
411
412
 * @control: union for control data
 * @status: union for status data
 * @driver_data: array of driver_data pointers
413
 * @ampdu_ack_len: number of acked aggregated frames.
414
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
415
 * @ampdu_len: number of aggregated frames.
416
 * 	relevant only if IEEE80211_TX_STAT_AMPDU was set.
417
 * @ack_signal: signal strength of the ACK frame
418
 */
419
420
421
422
struct ieee80211_tx_info {
	/* common information */
	u32 flags;
	u8 band;
423

424
	u8 antenna_sel_tx;
425

426
	/* 2 byte hole */
427
	u8 pad[2];
428
429
430

	union {
		struct {
431
432
433
434
435
436
437
438
439
440
			union {
				/* rate control */
				struct {
					struct ieee80211_tx_rate rates[
						IEEE80211_TX_MAX_RATES];
					s8 rts_cts_rate_idx;
				};
				/* only needed before rate control */
				unsigned long jiffies;
			};
441
			/* NB: vif can be NULL for injected frames */
442
443
			struct ieee80211_vif *vif;
			struct ieee80211_key_conf *hw_key;
444
			struct ieee80211_sta *sta;
445
446
		} control;
		struct {
447
448
			struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
			u8 ampdu_ack_len;
449
			int ack_signal;
450
			u8 ampdu_len;
451
			/* 15 bytes free */
452
		} status;
453
454
455
456
457
458
459
460
		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 *)];
461
	};
462
463
};

464
465
466
467
static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
{
	return (struct ieee80211_tx_info *)skb->cb;
}
468

469
470
471
472
473
static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
{
	return (struct ieee80211_rx_status *)skb->cb;
}

474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
/**
 * ieee80211_tx_info_clear_status - clear TX status
 *
 * @info: The &struct ieee80211_tx_info to be cleared.
 *
 * When the driver passes an skb back to mac80211, it must report
 * a number of things in TX status. This function clears everything
 * in the TX status but the rate control information (it does clear
 * the count since you need to fill that in anyway).
 *
 * NOTE: You can only use this function if you do NOT use
 *	 info->driver_data! Use info->rate_driver_data
 *	 instead if you need only the less space that allows.
 */
static inline void
ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
{
	int i;

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

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

509
510
511
512
513
514
515
516
517
518
519
520
521

/**
 * 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.
522
523
524
525
 * @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.
526
 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf's avatar
Bruno Randolf committed
527
528
 *	is valid. This is useful in monitor mode and necessary for beacon frames
 *	to enable IBSS merging.
529
 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
530
531
532
 * @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
533
534
535
 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
 *	on cooked monitor to avoid double-reporting it for multiple
 *	virtual interfaces
536
537
538
539
540
541
 */
enum mac80211_rx_flags {
	RX_FLAG_MMIC_ERROR	= 1<<0,
	RX_FLAG_DECRYPTED	= 1<<1,
	RX_FLAG_MMIC_STRIPPED	= 1<<3,
	RX_FLAG_IV_STRIPPED	= 1<<4,
542
543
	RX_FLAG_FAILED_FCS_CRC	= 1<<5,
	RX_FLAG_FAILED_PLCP_CRC = 1<<6,
544
	RX_FLAG_TSFT		= 1<<7,
545
546
547
548
	RX_FLAG_SHORTPRE	= 1<<8,
	RX_FLAG_HT		= 1<<9,
	RX_FLAG_40MHZ		= 1<<10,
	RX_FLAG_SHORT_GI	= 1<<11,
549
	RX_FLAG_INTERNAL_CMTR	= 1<<12,
550
551
552
553
554
555
556
};

/**
 * 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
557
 * frame, in the skb's control buffer (cb).
558
 *
559
560
 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
 * 	(TSF) timer when the first data symbol (MPDU) arrived at the hardware.
561
 * @band: the active band when this frame was received
562
 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
563
564
565
 * @signal: signal strength when receiving this frame, either in dBm, in dB or
 *	unspecified depending on the hardware capabilities flags
 *	@IEEE80211_HW_SIGNAL_*
566
 * @antenna: antenna used
567
568
 * @rate_idx: index of data rate into band's supported rates or MCS index if
 *	HT rates are use (RX_FLAG_HT)
569
570
 * @flag: %RX_FLAG_*
 */
571
572
struct ieee80211_rx_status {
	u64 mactime;
573
	enum ieee80211_band band;
574
575
	int freq;
	int signal;
576
	int antenna;
577
	int rate_idx;
578
579
580
	int flag;
};

581
582
583
584
585
/**
 * enum ieee80211_conf_flags - configuration flags
 *
 * Flags to define PHY configuration options
 *
586
587
588
 * @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!
589
590
591
592
593
594
595
 * @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.
596
597
598
599
600
 * @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.
601
602
603
 * @IEEE80211_CONF_QOS: Enable 802.11e QoS also know as WMM (Wireless
 *      Multimedia). On some drivers (iwlwifi is one of know) we have
 *      to enable/disable QoS explicitly.
604
605
 */
enum ieee80211_conf_flags {
606
	IEEE80211_CONF_MONITOR		= (1<<0),
Johannes Berg's avatar
Johannes Berg committed
607
	IEEE80211_CONF_PS		= (1<<1),
608
	IEEE80211_CONF_IDLE		= (1<<2),
609
	IEEE80211_CONF_QOS		= (1<<3),
610
};
611

612

613
614
615
616
/**
 * enum ieee80211_conf_changed - denotes which configuration changed
 *
 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
617
 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
618
 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
619
 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
620
 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
621
 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
622
 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
623
 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
624
 * @IEEE80211_CONF_CHANGE_QOS: Quality of service was enabled or disabled
625
626
 */
enum ieee80211_conf_changed {
627
	IEEE80211_CONF_CHANGE_SMPS		= BIT(1),
628
	IEEE80211_CONF_CHANGE_LISTEN_INTERVAL	= BIT(2),
629
	IEEE80211_CONF_CHANGE_MONITOR		= BIT(3),
630
	IEEE80211_CONF_CHANGE_PS		= BIT(4),
631
632
633
	IEEE80211_CONF_CHANGE_POWER		= BIT(5),
	IEEE80211_CONF_CHANGE_CHANNEL		= BIT(6),
	IEEE80211_CONF_CHANGE_RETRY_LIMITS	= BIT(7),
634
	IEEE80211_CONF_CHANGE_IDLE		= BIT(8),
635
	IEEE80211_CONF_CHANGE_QOS		= BIT(9),
636
637
};

638
639
640
/**
 * enum ieee80211_smps_mode - spatial multiplexing power save mode
 *
641
642
643
644
645
 * @IEEE80211_SMPS_AUTOMATIC: automatic
 * @IEEE80211_SMPS_OFF: off
 * @IEEE80211_SMPS_STATIC: static
 * @IEEE80211_SMPS_DYNAMIC: dynamic
 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
646
647
648
649
650
651
652
653
654
655
656
 */
enum ieee80211_smps_mode {
	IEEE80211_SMPS_AUTOMATIC,
	IEEE80211_SMPS_OFF,
	IEEE80211_SMPS_STATIC,
	IEEE80211_SMPS_DYNAMIC,

	/* keep last */
	IEEE80211_SMPS_NUM_MODES,
};

657
658
659
660
661
/**
 * struct ieee80211_conf - configuration of the device
 *
 * This struct indicates how the driver shall configure the hardware.
 *
662
663
 * @flags: configuration flags defined above
 *
664
 * @listen_interval: listen interval in units of beacon interval
665
 * @max_sleep_period: the maximum number of beacon intervals to sleep for
666
667
668
669
 *	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.
670
671
672
 * @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.
673
674
675
 * @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.
676
677
678
 * @dynamic_ps_forced_timeout: The dynamic powersave timeout (in ms) configured
 *	by cfg80211 (essentially, wext) If set, this value overrules the value
 *	chosen by mac80211 based on ps qos network latency.
679
 *
680
 * @power_level: requested transmit power (in dBm)
681
 *
682
 * @channel: the channel to tune to
683
 * @channel_type: the channel (HT) type
684
 *
685
686
687
688
689
690
 * @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
691
692
693
694
 *
 * @smps_mode: spatial multiplexing powersave mode; note that
 *	%IEEE80211_SMPS_STATIC is used when the device is not
 *	configured for an HT channel
695
696
 */
struct ieee80211_conf {
697
	u32 flags;
698
	int power_level, dynamic_ps_timeout, dynamic_ps_forced_timeout;
699
	int max_sleep_period;
700

701
	u16 listen_interval;
702
	u8 ps_dtim_period;
703

704
705
	u8 long_frame_max_tx_count, short_frame_max_tx_count;

706
	struct ieee80211_channel *channel;
707
	enum nl80211_channel_type channel_type;
708
	enum ieee80211_smps_mode smps_mode;
709
710
};

711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
/**
 * 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;
};

733
734
735
736
737
738
/**
 * struct ieee80211_vif - per-interface data
 *
 * Data in this structure is continually present for driver
 * use during the life of a virtual interface.
 *
739
 * @type: type of this virtual interface
740
741
 * @bss_conf: BSS configuration for this interface, either our own
 *	or the BSS we're associated to
742
 * @addr: address of this interface
743
744
745
746
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *).
 */
struct ieee80211_vif {
747
	enum nl80211_iftype type;
748
	struct ieee80211_bss_conf bss_conf;
749
	u8 addr[ETH_ALEN];
750
751
752
753
	/* must be last */
	u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
};

Johannes Berg's avatar
Johannes Berg committed
754
755
756
static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
{
#ifdef CONFIG_MAC80211_MESH
757
	return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg's avatar
Johannes Berg committed
758
759
760
761
#endif
	return false;
}

762
763
764
765
766
/**
 * enum ieee80211_key_alg - key algorithm
 * @ALG_WEP: WEP40 or WEP104
 * @ALG_TKIP: TKIP
 * @ALG_CCMP: CCMP (AES)
767
 * @ALG_AES_CMAC: AES-128-CMAC
768
 */
769
enum ieee80211_key_alg {
770
771
772
	ALG_WEP,
	ALG_TKIP,
	ALG_CCMP,
773
	ALG_AES_CMAC,
774
};
775

776
777
778
779
780
781
782
783
784
785
786
787
788
789
/**
 * 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.
790
791
 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
 *	that the key is pairwise rather then a shared key.
792
793
794
 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
 *	CCMP key if it requires CCMP encryption of management frames (MFP) to
 *	be done in software.
795
 */
796
797
798
799
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,
800
	IEEE80211_KEY_FLAG_PAIRWISE	= 1<<3,
801
	IEEE80211_KEY_FLAG_SW_MGMT	= 1<<4,
802
};
803

804
805
806
807
808
809
810
811
/**
 * 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
812
 *	encrypted in hardware.
813
814
 * @alg: The key algorithm.
 * @flags: key flags, see &enum ieee80211_key_flags.
815
 * @ap_addr: AP's MAC address
816
817
 * @keyidx: the key index (0-3)
 * @keylen: key material length
818
819
820
821
822
 * @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)
823
824
 * @icv_len: The ICV length for this key type
 * @iv_len: The IV length for this key type
825
 */
826
struct ieee80211_key_conf {
827
	enum ieee80211_key_alg alg;
828
829
	u8 icv_len;
	u8 iv_len;
830
	u8 hw_key_idx;
831
832
833
	u8 flags;
	s8 keyidx;
	u8 keylen;
834
835
836
	u8 key[0];
};

837
838
839
840
841
842
843
844
845
/**
 * 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
 */
846
enum set_key_cmd {
847
	SET_KEY, DISABLE_KEY,
848
};
849

850
851
852
853
854
855
856
857
/**
 * 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
858
 * call to your sta_remove callback that removed it.
859
860
861
 *
 * @addr: MAC address
 * @aid: AID we assigned to the station if we're an AP
862
 * @supp_rates: Bitmap of supported rates (per band)
Johannes Berg's avatar
Johannes Berg committed
863
 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
864
865
866
867
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *), size is determined in hw information.
 */
struct ieee80211_sta {
868
	u32 supp_rates[IEEE80211_NUM_BANDS];
869
870
	u8 addr[ETH_ALEN];
	u16 aid;
871
	struct ieee80211_sta_ht_cap ht_cap;
872
873
874
875
876

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

877
878
879
880
/**
 * enum sta_notify_cmd - sta notify command
 *
 * Used with the sta_notify() callback in &struct ieee80211_ops, this
881
882
 * indicates addition and removal of a station to station table,
 * or if a associated station made a power state transition.
883
 *
884
885
 * @STA_NOTIFY_ADD: (DEPRECATED) a station was added to the station table
 * @STA_NOTIFY_REMOVE: (DEPRECATED) a station being removed from the station table
886
887
888
 * @STA_NOTIFY_SLEEP: a station is now sleeping
 * @STA_NOTIFY_AWAKE: a sleeping station woke up
 */
889
890
enum sta_notify_cmd {
	STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
891
892
893
	STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
};

894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
/**
 * enum ieee80211_tkip_key_type - get tkip key
 *
 * Used by drivers which need to get a tkip key for skb. Some drivers need a
 * phase 1 key, others need a phase 2 key. A single function allows the driver
 * to get the key, this enum indicates what type of key is required.
 *
 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
 */
enum ieee80211_tkip_key_type {
	IEEE80211_TKIP_P1_KEY,
	IEEE80211_TKIP_P2_KEY,
};

909
910
911
912
913
914
915
916
917
/**
 * 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.
 *
918
919
920
921
922
923
924
925
926
927
928
929
930
 * @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.
 *
931
932
933
934
935
936
937
938
939
940
 * @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
941
 *	the driver can fetch them with ieee80211_get_buffered_bc().
942
 *
943
944
945
946
947
948
 * @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.
949
950
951
952
953
954
955
956
957
958
959
 *
 * @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.
 *
960
961
962
 * @IEEE80211_HW_SPECTRUM_MGMT:
 * 	Hardware supports spectrum management defined in 802.11h
 * 	Measurement, Channel Switch, Quieting, TPC
Sujith's avatar
Sujith committed
963
964
965
 *
 * @IEEE80211_HW_AMPDU_AGGREGATION:
 *	Hardware supports 11n A-MPDU aggregation.
966
 *
967
968
969
970
971
972
973
974
975
 * @IEEE80211_HW_SUPPORTS_PS:
 *	Hardware has power save support (i.e. can go to sleep).
 *
 * @IEEE80211_HW_PS_NULLFUNC_STACK:
 *	Hardware requires nullfunc frame handling in stack, implies
 *	stack support for dynamic PS.
 *
 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
 *	Hardware has support for dynamic PS.
976
977
978
 *
 * @IEEE80211_HW_MFP_CAPABLE:
 *	Hardware supports management frame protection (MFP, IEEE 802.11w).
979
980
981
982
 *
 * @IEEE80211_HW_BEACON_FILTER:
 *	Hardware supports dropping of irrelevant beacon frames to
 *	avoid waking up cpu.
983
984
985
986
987
988
989
990
991
992
 *
 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
 *	Hardware supports static spatial multiplexing powersave,
 *	ie. can turn off all but one chain even on HT connections
 *	that should be using more chains.
 *
 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
 *	Hardware supports dynamic spatial multiplexing powersave,
 *	ie. can turn off all but one chain and then wake the rest
 *	up as required after, for example, rts/cts handshake.
993
994
995
996
997
 *
 * @IEEE80211_HW_SUPPORTS_UAPSD:
 *	Hardware supports Unscheduled Automatic Power Save Delivery
 *	(U-APSD) in managed mode. The mode is configured with
 *	conf_tx() operation.
998
999
1000
1001
1002
 *
 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
 *	Hardware can provide ack status reports of Tx frames to
 *	the stack.
 *
1003
1004
1005
1006
1007
 * @IEEE80211_HW_CONNECTION_MONITOR:
 *      The hardware performs its own connection monitoring, including
 *      periodic keep-alives to the AP and probing the AP on beacon loss.
 *      When this flag is set, signaling beacon-loss will cause an immediate
 *      change to disassociated state.
1008
1009
1010
1011
1012
1013
 *
 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
 *	Hardware can do connection quality monitoring - i.e. it can monitor
 *	connection quality related parameters, such as the RSSI level and
 *	provide notifications if configured trigger levels are reached.
 *
1014
1015
 */
enum ieee80211_hw_flags {
1016
	IEEE80211_HW_HAS_RATE_CONTROL			= 1<<0,
1017
1018
	IEEE80211_HW_RX_INCLUDES_FCS			= 1<<1,
	IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING	= 1<<2,
1019
1020
	IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE		= 1<<3,
	IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE	= 1<<4,
1021
	IEEE80211_HW_SIGNAL_UNSPEC			= 1<<5,
Johannes Berg's avatar
Johannes Berg committed
1022
	IEEE80211_HW_SIGNAL_DBM				= 1<<6,
1023
	/* use this hole */
Johannes Berg's avatar
Johannes Berg committed
1024
1025
1026
1027
1028
1029
	IEEE80211_HW_SPECTRUM_MGMT			= 1<<8,
	IEEE80211_HW_AMPDU_AGGREGATION			= 1<<9,
	IEEE80211_HW_SUPPORTS_PS			= 1<<10,
	IEEE80211_HW_PS_NULLFUNC_STACK			= 1<<11,
	IEEE80211_HW_SUPPORTS_DYNAMIC_PS		= 1<<12,
	IEEE80211_HW_MFP_CAPABLE			= 1<<13,
1030
	IEEE80211_HW_BEACON_FILTER			= 1<<14,
1031
1032
	IEEE80211_HW_SUPPORTS_STATIC_SMPS		= 1<<15,
	IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS		= 1<<16,
1033
	IEEE80211_HW_SUPPORTS_UAPSD			= 1<<17,
1034
	IEEE80211_HW_REPORTS_TX_ACK_STATUS		= 1<<18,
1035
	IEEE80211_HW_CONNECTION_MONITOR			= 1<<19,
1036
	IEEE80211_HW_SUPPORTS_CQM_RSSI			= 1<<20,
1037
1038
};

1039
1040
/**
 * struct ieee80211_hw - hardware information and state
1041
1042
1043
1044
1045
1046
1047
 *
 * This structure contains the configuration and hardware
 * information for an 802.11 PHY.
 *
 * @wiphy: This points to the &struct wiphy allocated for this
 *	802.11 PHY. You must fill in the @perm_addr and @dev
 *	members of this structure using SET_IEEE80211_DEV()
1048
1049
 *	and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
 *	bands (with channels, bitrates) are registered here.
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 *
 * @conf: &struct ieee80211_conf, device configuration, don't use.
 *
 * @priv: pointer to private area that was allocated for driver use
 *	along with this structure.
 *
 * @flags: hardware flags, see &enum ieee80211_hw_flags.
 *
 * @extra_tx_headroom: headroom to reserve in each transmit skb
 *	for use by the driver (e.g. for transmit headers.)
 *
 * @channel_change_time: time (in microseconds) it takes to change channels.
 *
1063
1064
 * @max_signal: Maximum value for signal (rssi) in RX information, used
 *     only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1065
 *
1066
1067
1068
 * @max_listen_interval: max listen interval in units of beacon interval
 *     that HW supports
 *
1069
 * @queues: number of available hardware transmit queues for
Johannes Berg's avatar
Johannes Berg committed
1070
1071
1072
 *	data packets. WMM/QoS requires at least four, these
 *	queues need to have configurable access parameters.
 *
1073
1074
1075
 * @rate_control_algorithm: rate control algorithm for this hardware.
 *	If unset (NULL), the default algorithm will be used. Must be
 *	set before calling ieee80211_register_hw().
1076
1077
1078
 *
 * @vif_data_size: size (in bytes) of the drv_priv data area
 *	within &struct ieee80211_vif.
1079
1080
 * @sta_data_size: size (in bytes) of the drv_priv data area
 *	within &struct ieee80211_sta.
1081
 *
1082
1083
 * @max_rates: maximum number of alternate rate retry stages
 * @max_rate_tries: maximum number of tries for each stage
1084
 */
1085
1086
struct ieee80211_hw {
	struct ieee80211_conf conf;
1087
	struct wiphy *wiphy;
1088
	const char *rate_control_algorithm;
1089
	void *priv;
1090
	u32 flags;
1091
1092
	unsigned int extra_tx_headroom;
	int channel_change_time;
1093
	int vif_data_size;
1094
	int sta_data_size;
1095
1096
	u16 queues;
	u16 max_listen_interval;
1097
	s8 max_signal;
1098
1099
	u8 max_rates;
	u8 max_rate_tries;
1100
1101
};

1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
/**
 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
 *
 * @wiphy: the &struct wiphy which we want to query
 *
 * mac80211 drivers can use this to get to their respective
 * &struct ieee80211_hw. Drivers wishing to get to their own private
 * structure can then access it via hw->priv. Note that mac802111 drivers should
 * not use wiphy_priv() to try to get their private driver structure as this
 * is already used internally by mac80211.
 */
struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);

1115
1116
1117
1118
1119
1120
/**
 * SET_IEEE80211_DEV - set device for 802.11 hardware
 *
 * @hw: the &struct ieee80211_hw to set the device for
 * @dev: the &struct device of this 802.11 device
 */
1121
1122
1123
1124
1125
static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
{
	set_wiphy_dev(hw->wiphy, dev);
}

1126
/**
1127
 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1128
1129
1130
1131
 *
 * @hw: the &struct ieee80211_hw to set the MAC address for
 * @addr: the address to set
 */
1132
1133
1134
1135
1136
static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
{
	memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
}

1137
1138
static inline struct ieee80211_rate *
ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1139
		      const struct ieee80211_tx_info *c)
1140
{
1141
	if (WARN_ON(c->control.rates[0].idx < 0))
1142
		return NULL;
1143
	return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1144
1145
1146
1147
}

static inline struct ieee80211_rate *
ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1148
			   const struct ieee80211_tx_info *c)
Johannes Berg's avatar