mac80211.h 92.2 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>
Johannes Berg's avatar
Johannes Berg committed
6
 * Copyright 2007-2008	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
 */
111
struct ieee80211_tx_queue_params {
112
	u16 txop;
113 114
	u16 cw_min;
	u16 cw_max;
115
	u8 aifs;
116 117
};

118
/**
119
 * struct ieee80211_tx_queue_stats - transmit queue statistics
120 121 122 123 124
 *
 * @len: number of packets in queue
 * @limit: queue length limit
 * @count: number of frames sent
 */
125
struct ieee80211_tx_queue_stats {
126 127 128
	unsigned int len;
	unsigned int limit;
	unsigned int count;
129 130 131 132 133 134 135 136 137
};

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

138 139 140 141 142 143 144 145 146 147
/**
 * 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
148
 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler's avatar
Tomas Winkler committed
149
 * @BSS_CHANGED_HT: 802.11n parameters changed
150
 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
151
 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
152 153 154 155 156 157
 * @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)
158 159 160 161 162
 */
enum ieee80211_bss_change {
	BSS_CHANGED_ASSOC		= 1<<0,
	BSS_CHANGED_ERP_CTS_PROT	= 1<<1,
	BSS_CHANGED_ERP_PREAMBLE	= 1<<2,
163
	BSS_CHANGED_ERP_SLOT		= 1<<3,
Tomas Winkler's avatar
Tomas Winkler committed
164
	BSS_CHANGED_HT                  = 1<<4,
165
	BSS_CHANGED_BASIC_RATES		= 1<<5,
166
	BSS_CHANGED_BEACON_INT		= 1<<6,
167 168 169
	BSS_CHANGED_BSSID		= 1<<7,
	BSS_CHANGED_BEACON		= 1<<8,
	BSS_CHANGED_BEACON_ENABLED	= 1<<9,
170 171 172 173 174 175 176 177 178 179 180
};

/**
 * 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
 * @aid: association ID number, valid only when @assoc is true
 * @use_cts_prot: use CTS protection
181 182 183 184 185 186
 * @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
187
 * @dtim_period: num of beacons before the next DTIM, for PSM
188 189
 * @timestamp: beacon timestamp
 * @beacon_int: beacon interval
190
 * @assoc_capability: capabilities taken from assoc resp
191 192 193
 * @basic_rates: bitmap of basic rates, each bit stands for an
 *	index into the rate table configured by the driver in
 *	the current band.
194 195
 * @bssid: The BSSID for this BSS
 * @enable_beacon: whether beaconing should be enabled or not
196 197
 * @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.
198 199
 */
struct ieee80211_bss_conf {
200
	const u8 *bssid;
201 202 203 204 205 206
	/* association related data */
	bool assoc;
	u16 aid;
	/* erp related data */
	bool use_cts_prot;
	bool use_short_preamble;
207
	bool use_short_slot;
208
	bool enable_beacon;
209
	u8 dtim_period;
210 211 212
	u16 beacon_int;
	u16 assoc_capability;
	u64 timestamp;
213
	u32 basic_rates;
214
	u16 ht_operation_mode;
215 216
};

217
/**
218
 * enum mac80211_tx_control_flags - flags to describe transmission information/status
219
 *
220
 * These flags are used with the @flags member of &ieee80211_tx_info.
221
 *
222
 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
223 224 225 226 227 228 229 230 231 232 233
 * @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.
234 235 236 237 238 239
 * @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
240
 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
241
 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
242 243 244 245 246 247 248 249
 *	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.
250 251 252
 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
 * 	is for the whole aggregation.
253 254
 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
 * 	so consider using block ack request (BAR).
255 256 257
 * @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)
258 259 260
 * @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.
261 262
 * @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
263 264
 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
 *	used to indicate frame should not be encrypted
265 266 267
 * @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.
268 269 270 271
 * @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.
272 273
 */
enum mac80211_tx_control_flags {
274
	IEEE80211_TX_CTL_REQ_TX_STATUS		= BIT(0),
275 276 277 278 279 280 281 282 283 284 285 286
	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),
287
	IEEE80211_TX_INTFL_NEED_TXPROCESSING	= BIT(14),
288
	IEEE80211_TX_INTFL_RETRIED		= BIT(15),
Johannes Berg's avatar
Johannes Berg committed
289
	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(16),
290
	IEEE80211_TX_CTL_PSPOLL_RESPONSE	= BIT(17),
291
	IEEE80211_TX_CTL_MORE_FRAMES		= BIT(18),
292 293
};

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
/**
 * 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.
 */
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
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
330

331 332
/* if you do need the rateset, then you have less space */
#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
333

334 335
/* maximum number of rate stages */
#define IEEE80211_TX_MAX_RATES	5
336 337

/**
338
 * struct ieee80211_tx_rate - rate selection/status
339
 *
340 341
 * @idx: rate index to attempt to send with
 * @flags: rate control flags (&enum mac80211_rate_control_flags)
342
 * @count: number of tries in this rate before going to the next rate
343 344 345 346 347 348
 *
 * 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.
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
 *
 * &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.
364
 */
365 366 367 368
struct ieee80211_tx_rate {
	s8 idx;
	u8 count;
	u8 flags;
369
} __attribute__((packed));
370

371 372 373 374 375 376 377 378
/**
 * 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
 *
379 380 381
 * The TX control's sta pointer is only valid during the ->tx call,
 * it may be NULL.
 *
382
 * @flags: transmit info flags, defined above
383
 * @band: the band to transmit on (use for checking for races)
384
 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
385
 * @pad: padding, ignore
386 387 388
 * @control: union for control data
 * @status: union for status data
 * @driver_data: array of driver_data pointers
389
 * @ampdu_ack_len: number of acked aggregated frames.
390 391 392
 * 	relevant only if IEEE80211_TX_STATUS_AMPDU was set.
 * @ampdu_ack_map: block ack bit map for the aggregation.
 * 	relevant only if IEEE80211_TX_STATUS_AMPDU was set.
393 394
 * @ampdu_len: number of aggregated frames.
 * 	relevant only if IEEE80211_TX_STATUS_AMPDU was set.
395
 * @ack_signal: signal strength of the ACK frame
396
 */
397 398 399 400
struct ieee80211_tx_info {
	/* common information */
	u32 flags;
	u8 band;
401

402
	u8 antenna_sel_tx;
403

404
	/* 2 byte hole */
405
	u8 pad[2];
406 407 408

	union {
		struct {
409 410 411 412 413 414 415 416 417 418
			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;
			};
419
			/* NB: vif can be NULL for injected frames */
420 421
			struct ieee80211_vif *vif;
			struct ieee80211_key_conf *hw_key;
422
			struct ieee80211_sta *sta;
423 424
		} control;
		struct {
425 426
			struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
			u8 ampdu_ack_len;
427 428
			u64 ampdu_ack_map;
			int ack_signal;
429 430
			u8 ampdu_len;
			/* 7 bytes free */
431
		} status;
432 433 434 435 436 437 438 439
		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 *)];
440
	};
441 442
};

443 444 445 446
static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
{
	return (struct ieee80211_tx_info *)skb->cb;
}
447

448 449 450 451 452
static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
{
	return (struct ieee80211_rx_status *)skb->cb;
}

453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
/**
 * ieee80211_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));
}

488 489 490 491 492 493 494 495 496 497 498 499 500

/**
 * 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.
501 502 503 504
 * @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.
505
 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf's avatar
Bruno Randolf committed
506 507
 *	is valid. This is useful in monitor mode and necessary for beacon frames
 *	to enable IBSS merging.
508
 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
509 510 511
 * @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
512 513 514
 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported
 *	on cooked monitor to avoid double-reporting it for multiple
 *	virtual interfaces
515 516 517 518 519 520
 */
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,
521 522
	RX_FLAG_FAILED_FCS_CRC	= 1<<5,
	RX_FLAG_FAILED_PLCP_CRC = 1<<6,
523
	RX_FLAG_TSFT		= 1<<7,
524 525 526 527
	RX_FLAG_SHORTPRE	= 1<<8,
	RX_FLAG_HT		= 1<<9,
	RX_FLAG_40MHZ		= 1<<10,
	RX_FLAG_SHORT_GI	= 1<<11,
528
	RX_FLAG_INTERNAL_CMTR	= 1<<12,
529 530 531 532 533 534 535
};

/**
 * 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
536
 * frame, in the skb's control buffer (cb).
537
 *
538 539
 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
 * 	(TSF) timer when the first data symbol (MPDU) arrived at the hardware.
540
 * @band: the active band when this frame was received
541
 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
542 543 544 545
 * @signal: signal strength when receiving this frame, either in dBm, in dB or
 *	unspecified depending on the hardware capabilities flags
 *	@IEEE80211_HW_SIGNAL_*
 * @noise: noise when receiving this frame, in dBm.
546
 * @antenna: antenna used
547 548
 * @rate_idx: index of data rate into band's supported rates or MCS index if
 *	HT rates are use (RX_FLAG_HT)
549 550
 * @flag: %RX_FLAG_*
 */
551 552
struct ieee80211_rx_status {
	u64 mactime;
553
	enum ieee80211_band band;
554 555
	int freq;
	int signal;
556 557
	int noise;
	int antenna;
558
	int rate_idx;
559 560 561
	int flag;
};

562 563 564 565 566
/**
 * enum ieee80211_conf_flags - configuration flags
 *
 * Flags to define PHY configuration options
 *
567 568 569
 * @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!
570
 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only)
571 572 573 574 575
 * @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.
576 577
 */
enum ieee80211_conf_flags {
578
	IEEE80211_CONF_MONITOR		= (1<<0),
Johannes Berg's avatar
Johannes Berg committed
579
	IEEE80211_CONF_PS		= (1<<1),
580
	IEEE80211_CONF_IDLE		= (1<<2),
581
};
582

583

584 585 586 587
/**
 * enum ieee80211_conf_changed - denotes which configuration changed
 *
 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
588
 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
589
 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
590
 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
591
 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
592
 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
593
 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
594
 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
595 596
 */
enum ieee80211_conf_changed {
597
	IEEE80211_CONF_CHANGE_SMPS		= BIT(1),
598
	IEEE80211_CONF_CHANGE_LISTEN_INTERVAL	= BIT(2),
599
	IEEE80211_CONF_CHANGE_MONITOR		= BIT(3),
600
	IEEE80211_CONF_CHANGE_PS		= BIT(4),
601 602 603
	IEEE80211_CONF_CHANGE_POWER		= BIT(5),
	IEEE80211_CONF_CHANGE_CHANNEL		= BIT(6),
	IEEE80211_CONF_CHANGE_RETRY_LIMITS	= BIT(7),
604
	IEEE80211_CONF_CHANGE_IDLE		= BIT(8),
605 606
};

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
/**
 * enum ieee80211_smps_mode - spatial multiplexing power save mode
 *
 * @
 */
enum ieee80211_smps_mode {
	IEEE80211_SMPS_AUTOMATIC,
	IEEE80211_SMPS_OFF,
	IEEE80211_SMPS_STATIC,
	IEEE80211_SMPS_DYNAMIC,

	/* keep last */
	IEEE80211_SMPS_NUM_MODES,
};

622 623 624 625 626
/**
 * struct ieee80211_conf - configuration of the device
 *
 * This struct indicates how the driver shall configure the hardware.
 *
627 628
 * @flags: configuration flags defined above
 *
629
 * @listen_interval: listen interval in units of beacon interval
630
 * @max_sleep_period: the maximum number of beacon intervals to sleep for
631 632 633 634 635 636 637 638
 *	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.
 * @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.
 *
639
 * @power_level: requested transmit power (in dBm)
640
 *
641
 * @channel: the channel to tune to
642
 * @channel_type: the channel (HT) type
643
 *
644 645 646 647 648 649
 * @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
650 651 652 653
 *
 * @smps_mode: spatial multiplexing powersave mode; note that
 *	%IEEE80211_SMPS_STATIC is used when the device is not
 *	configured for an HT channel
654 655
 */
struct ieee80211_conf {
656
	u32 flags;
657
	int power_level, dynamic_ps_timeout;
658
	int max_sleep_period;
659

660 661
	u16 listen_interval;

662 663
	u8 long_frame_max_tx_count, short_frame_max_tx_count;

664
	struct ieee80211_channel *channel;
665
	enum nl80211_channel_type channel_type;
666
	enum ieee80211_smps_mode smps_mode;
667 668
};

669 670 671 672 673 674
/**
 * struct ieee80211_vif - per-interface data
 *
 * Data in this structure is continually present for driver
 * use during the life of a virtual interface.
 *
675
 * @type: type of this virtual interface
676 677
 * @bss_conf: BSS configuration for this interface, either our own
 *	or the BSS we're associated to
678
 * @addr: address of this interface
679 680 681 682
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *).
 */
struct ieee80211_vif {
683
	enum nl80211_iftype type;
684
	struct ieee80211_bss_conf bss_conf;
685
	u8 addr[ETH_ALEN];
686 687 688 689
	/* must be last */
	u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
};

Johannes Berg's avatar
Johannes Berg committed
690 691 692
static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
{
#ifdef CONFIG_MAC80211_MESH
693
	return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg's avatar
Johannes Berg committed
694 695 696 697
#endif
	return false;
}

698 699 700 701 702
/**
 * enum ieee80211_key_alg - key algorithm
 * @ALG_WEP: WEP40 or WEP104
 * @ALG_TKIP: TKIP
 * @ALG_CCMP: CCMP (AES)
703
 * @ALG_AES_CMAC: AES-128-CMAC
704
 */
705
enum ieee80211_key_alg {
706 707 708
	ALG_WEP,
	ALG_TKIP,
	ALG_CCMP,
709
	ALG_AES_CMAC,
710
};
711

712 713 714 715 716 717 718 719 720 721 722 723 724 725
/**
 * 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.
726 727
 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
 *	that the key is pairwise rather then a shared key.
728 729 730
 * @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.
731
 */
732 733 734 735
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,
736
	IEEE80211_KEY_FLAG_PAIRWISE	= 1<<3,
737
	IEEE80211_KEY_FLAG_SW_MGMT	= 1<<4,
738
};
739

740 741 742 743 744 745 746 747
/**
 * 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
748
 *	encrypted in hardware.
749 750 751 752
 * @alg: The key algorithm.
 * @flags: key flags, see &enum ieee80211_key_flags.
 * @keyidx: the key index (0-3)
 * @keylen: key material length
753 754 755 756 757
 * @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)
758 759
 * @icv_len: The ICV length for this key type
 * @iv_len: The IV length for this key type
760
 */
761
struct ieee80211_key_conf {
762
	enum ieee80211_key_alg alg;
763 764
	u8 icv_len;
	u8 iv_len;
765
	u8 hw_key_idx;
766 767 768
	u8 flags;
	s8 keyidx;
	u8 keylen;
769 770 771
	u8 key[0];
};

772 773 774 775 776 777 778 779 780
/**
 * 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
 */
781
enum set_key_cmd {
782
	SET_KEY, DISABLE_KEY,
783
};
784

785 786 787 788 789 790 791 792 793 794 795 796
/**
 * 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
 * call to your sta_notify callback that removed it.
 *
 * @addr: MAC address
 * @aid: AID we assigned to the station if we're an AP
797
 * @supp_rates: Bitmap of supported rates (per band)
Johannes Berg's avatar
Johannes Berg committed
798
 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
799 800 801 802
 * @drv_priv: data area for driver use, will always be aligned to
 *	sizeof(void *), size is determined in hw information.
 */
struct ieee80211_sta {
803
	u32 supp_rates[IEEE80211_NUM_BANDS];
804 805
	u8 addr[ETH_ALEN];
	u16 aid;
806
	struct ieee80211_sta_ht_cap ht_cap;
807 808 809 810 811

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

812 813 814 815
/**
 * enum sta_notify_cmd - sta notify command
 *
 * Used with the sta_notify() callback in &struct ieee80211_ops, this
816 817
 * indicates addition and removal of a station to station table,
 * or if a associated station made a power state transition.
818 819 820
 *
 * @STA_NOTIFY_ADD: a station was added to the station table
 * @STA_NOTIFY_REMOVE: a station being removed from the station table
821 822 823
 * @STA_NOTIFY_SLEEP: a station is now sleeping
 * @STA_NOTIFY_AWAKE: a sleeping station woke up
 */
824 825
enum sta_notify_cmd {
	STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
826 827 828
	STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
};

829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
/**
 * 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,
};

844 845 846 847 848 849 850 851 852
/**
 * 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.
 *
853 854 855 856 857 858 859 860 861 862 863 864 865
 * @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.
 *
866 867 868 869 870 871 872 873 874 875
 * @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
876
 *	the driver can fetch them with ieee80211_get_buffered_bc().
877
 *
878 879 880 881 882 883
 * @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.
884 885 886 887 888 889 890 891 892 893 894 895 896 897
 *
 * @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.
 *
 * @IEEE80211_HW_NOISE_DBM:
 *	Hardware can provide noise (radio interference) values in units dBm,
 *      decibel difference from one milliwatt.
898 899 900 901
 *
 * @IEEE80211_HW_SPECTRUM_MGMT:
 * 	Hardware supports spectrum management defined in 802.11h
 * 	Measurement, Channel Switch, Quieting, TPC
Sujith's avatar
Sujith committed
902 903 904
 *
 * @IEEE80211_HW_AMPDU_AGGREGATION:
 *	Hardware supports 11n A-MPDU aggregation.
905
 *
906 907 908 909 910 911 912 913 914
 * @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.
915 916 917
 *
 * @IEEE80211_HW_MFP_CAPABLE:
 *	Hardware supports management frame protection (MFP, IEEE 802.11w).
918 919 920 921
 *
 * @IEEE80211_HW_BEACON_FILTER:
 *	Hardware supports dropping of irrelevant beacon frames to
 *	avoid waking up cpu.
922 923 924 925 926 927 928 929 930 931
 *
 * @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.
932 933
 */
enum ieee80211_hw_flags {
934
	IEEE80211_HW_HAS_RATE_CONTROL			= 1<<0,
935 936
	IEEE80211_HW_RX_INCLUDES_FCS			= 1<<1,
	IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING	= 1<<2,
937 938
	IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE		= 1<<3,
	IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE	= 1<<4,
939
	IEEE80211_HW_SIGNAL_UNSPEC			= 1<<5,
Johannes Berg's avatar
Johannes Berg committed
940 941 942 943 944 945 946 947
	IEEE80211_HW_SIGNAL_DBM				= 1<<6,
	IEEE80211_HW_NOISE_DBM				= 1<<7,
	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,
948
	IEEE80211_HW_BEACON_FILTER			= 1<<14,
949 950
	IEEE80211_HW_SUPPORTS_STATIC_SMPS		= 1<<15,
	IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS		= 1<<16,
951 952
};

953 954
/**
 * struct ieee80211_hw - hardware information and state
955 956 957 958 959 960 961
 *
 * 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()
962 963
 *	and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
 *	bands (with channels, bitrates) are registered here.
964 965 966 967 968 969 970 971 972 973 974 975 976
 *
 * @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.
 *
977 978
 * @max_signal: Maximum value for signal (rssi) in RX information, used
 *     only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
979
 *
980 981 982
 * @max_listen_interval: max listen interval in units of beacon interval
 *     that HW supports
 *
983
 * @queues: number of available hardware transmit queues for
Johannes Berg's avatar
Johannes Berg committed
984 985 986
 *	data packets. WMM/QoS requires at least four, these
 *	queues need to have configurable access parameters.
 *
987 988 989
 * @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().
990 991 992
 *
 * @vif_data_size: size (in bytes) of the drv_priv data area
 *	within &struct ieee80211_vif.
993 994
 * @sta_data_size: size (in bytes) of the drv_priv data area
 *	within &struct ieee80211_sta.
995
 *
996 997
 * @max_rates: maximum number of alternate rate retry stages
 * @max_rate_tries: maximum number of tries for each stage
998
 */
999 1000
struct ieee80211_hw {
	struct ieee80211_conf conf;
1001
	struct wiphy *wiphy;
1002
	const char *rate_control_algorithm;
1003
	void *priv;
1004
	u32 flags;
1005 1006
	unsigned int extra_tx_headroom;
	int channel_change_time;
1007
	int vif_data_size;
1008
	int sta_data_size;
1009 1010
	u16 queues;
	u16 max_listen_interval;
1011
	s8 max_signal;
1012 1013
	u8 max_rates;
	u8 max_rate_tries;
1014 1015
};

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
/**
 * 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);

1029 1030 1031 1032 1033 1034
/**
 * 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
 */
1035 1036 1037 1038 1039
static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
{
	set_wiphy_dev(hw->wiphy, dev);
}

1040
/**
1041
 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1042 1043 1044 1045
 *
 * @hw: the &struct ieee80211_hw to set the MAC address for
 * @addr: the address to set
 */
1046 1047 1048 1049 1050
static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
{
	memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
}

1051 1052
static inline struct ieee80211_rate *
ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1053
		      const struct ieee80211_tx_info *c)
1054
{
1055
	if (WARN_ON(c->control.rates[0].idx < 0))
1056
		return NULL;
1057
	return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1058 1059 1060 1061
}

static inline struct ieee80211_rate *
ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1062
			   const struct ieee80211_tx_info *c)
1063
{
1064
	if (c->control.rts_cts_rate_idx < 0)
1065
		return NULL;
1066
	return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1067 1068 1069 1070
}

static inline struct ieee80211_rate *
ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,