mac80211.h 91.5 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>
J
Johannes Berg 已提交
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
R
Randy Dunlap 已提交
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.
 *
 */

J
Johannes Berg 已提交
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,
J
Johannes Berg 已提交
97 98
};

J
Johannes Berg 已提交
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.
J
Johannes Berg 已提交
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]
J
Johannes Berg 已提交
108
 * @cw_max: maximum contention window [like @cw_min]
109
 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
J
Johannes Berg 已提交
110
 */
111
struct ieee80211_tx_queue_params {
112
	u16 txop;
113 114
	u16 cw_min;
	u16 cw_max;
115
	u8 aifs;
116 117
};

J
Johannes Berg 已提交
118
/**
119
 * struct ieee80211_tx_queue_stats - transmit queue statistics
J
Johannes Berg 已提交
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 {
J
Johannes Berg 已提交
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
T
Tomas Winkler 已提交
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,
T
Tomas Winkler 已提交
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
J
Johannes Berg 已提交
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
/**
R
Randy Dunlap 已提交
218
 * enum mac80211_tx_control_flags - flags to describe transmission information/status
219
 *
R
Randy Dunlap 已提交
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
J
Johannes Berg 已提交
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.
J
Johannes Berg 已提交
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),
J
Johannes Berg 已提交
289
	IEEE80211_TX_INTFL_DONT_ENCRYPT		= BIT(16),
290
	IEEE80211_TX_CTL_PSPOLL_RESPONSE	= BIT(17),
J
Johannes Berg 已提交
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
R
Randy Dunlap 已提交
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)
B
Bruno Randolf 已提交
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;
};

J
Johannes Berg 已提交
562 563 564 565 566
/**
 * enum ieee80211_conf_flags - configuration flags
 *
 * Flags to define PHY configuration options
 *
J
Johannes Berg 已提交
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)
J
Johannes Berg 已提交
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.
J
Johannes Berg 已提交
576 577
 */
enum ieee80211_conf_flags {
J
Johannes Berg 已提交
578
	IEEE80211_CONF_MONITOR		= (1<<0),
J
Johannes Berg 已提交
579
	IEEE80211_CONF_PS		= (1<<1),
J
Johannes Berg 已提交
580
	IEEE80211_CONF_IDLE		= (1<<2),
J
Johannes Berg 已提交
581
};
582

J
Johannes Berg 已提交
583

584 585 586 587
/**
 * enum ieee80211_conf_changed - denotes which configuration changed
 *
 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
J
Johannes Berg 已提交
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
J
Johannes Berg 已提交
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),
J
Johannes Berg 已提交
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),
J
Johannes Berg 已提交
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 {
J
Johannes Berg 已提交
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
J
Johannes Berg 已提交
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;
J
Johannes Berg 已提交
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 *))));
};

J
Johannes Berg 已提交
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;
J
Johannes Berg 已提交
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
};
J
Johannes Berg 已提交
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;
J
Johannes Berg 已提交
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 {
J
Johannes Berg 已提交
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
J
Johannes Berg 已提交
797
 * @supp_rates: Bitmap of supported rates (per band)
J
Johannes Berg 已提交
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;
J
Johannes Berg 已提交
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
S
Sujith 已提交
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,
J
Johannes Berg 已提交
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
J
Johannes Berg 已提交
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,
1071
			     const struct ieee80211_tx_info *c, int idx)
1072
{
1073
	if (c->control.rates[idx + 1].idx < 0)
1074
		return NULL;
1075
	return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1076 1077
}

1078 1079 1080 1081 1082 1083 1084 1085
/**
 * DOC: Hardware crypto acceleration
 *
 * mac80211 is capable of taking advantage of many hardware
 * acceleration designs for encryption and decryption operations.
 *
 * The set_key() callback in the &struct ieee80211_ops for a given
 * device is called to enable hardware acceleration of encryption and
1086 1087 1088
 * decryption. The callback takes a @sta parameter that will be NULL
 * for default keys or keys used for transmission only, or point to
 * the station information for the peer for individual keys.
1089 1090
 * Multiple transmission keys with the same key index may be used when
 * VLANs are configured for an access point.
1091
 *
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
 * When transmitting, the TX control data will use the @hw_key_idx
 * selected by the driver by modifying the &struct ieee80211_key_conf
 * pointed to by the @key parameter to the set_key() function.
 *
 * The set_key() call for the %SET_KEY command should return 0 if
 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
 * added; if you return 0 then hw_key_idx must be assigned to the
 * hardware key index, you are free to use the full u8 range.
 *
 * When the cmd is %DISABLE_KEY then it must succeed.
 *
 * Note that it is permissible to not decrypt a frame even if a key
 * for it has been uploaded to hardware, the stack will not make any
 * decision based on whether a key has been uploaded or not but rather
 * based on the receive flags.
 *
 * The &struct ieee80211_key_conf structure pointed to by the @key
 * parameter is guaranteed to be valid until another call to set_key()
 * removes it, but it can only be used as a cookie to differentiate
 * keys.
1112 1113 1114 1115 1116 1117 1118 1119
 *
 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
 * handler.
 * The update_tkip_key() call updates the driver with the new phase 1 key.
 * This happens everytime the iv16 wraps around (every 65536 packets). The
 * set_key() call will happen only once for each key (unless the AP did
 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1120
 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1121
 * handler is software decryption with wrap around of iv16.
1122
 */
1123

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
/**
 * DOC: Powersave support
 *
 * mac80211 has support for various powersave implementations.
 *
 * First, it can support hardware that handles all powersaving by
 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
 * hardware flag. In that case, it will be told about the desired
 * powersave mode depending on the association status, and the driver
 * must take care of sending nullfunc frames when necessary, i.e. when
 * entering and leaving powersave mode. The driver is required to look at
 * the AID in beacons and signal to the AP that it woke up when it finds
 * traffic directed to it. This mode supports dynamic PS by simply
 * enabling/disabling PS.
 *
 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
 * flag to indicate that it can support dynamic PS mode itself (see below).
 *
 * Other hardware designs cannot send nullfunc frames by themselves and also
 * need software support for parsing the TIM bitmap. This is also supported
 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1146 1147 1148
 * required to pass up beacons. The hardware is still required to handle
 * waking up for multicast traffic; if it cannot the driver must handle that
 * as best as it can, mac80211 is too slow.
1149 1150 1151 1152 1153 1154 1155 1156 1157
 *
 * Dynamic powersave mode is an extension to normal powersave mode in which
 * the hardware stays awake for a user-specified period of time after sending
 * a frame so that reply frames need not be buffered and therefore delayed
 * to the next wakeup. This can either be supported by hardware, in which case
 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
 * value, or by the stack if all nullfunc handling is in the stack.
 */

1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
/**
 * DOC: Beacon filter support
 *
 * Some hardware have beacon filter support to reduce host cpu wakeups
 * which will reduce system power consumption. It usuallly works so that
 * the firmware creates a checksum of the beacon but omits all constantly
 * changing elements (TSF, TIM etc). Whenever the checksum changes the
 * beacon is forwarded to the host, otherwise it will be just dropped. That
 * way the host will only receive beacons where some relevant information
 * (for example ERP protection or WMM settings) have changed.
 *
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
 * hardware capability. The driver needs to enable beacon filter support
 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
 * power save is enabled, the stack will not check for beacon loss and the
 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
 *
 * The time (or number of beacons missed) until the firmware notifies the
 * driver of a beacon loss event (which in turn causes the driver to call
 * ieee80211_beacon_loss()) should be configurable and will be controlled
 * by mac80211 and the roaming algorithm in the future.
 *
 * Since there may be constantly changing information elements that nothing
 * in the software stack cares about, we will, in the future, have mac80211
 * tell the driver which information elements are interesting in the sense
 * that we want to see changes in them. This will include
 *  - a list of information element IDs
 *  - a list of OUIs for the vendor information element
 *
 * Ideally, the hardware would filter out any beacons without changes in the
 * requested elements, but if it cannot support that it may, at the expense
 * of some efficiency, filter out only a subset. For example, if the device
 * doesn't support checking for OUIs it should pass up all changes in all
 * vendor information elements.
 *
 * Note that change, for the sake of simplification, also includes information
 * elements appearing or disappearing from the beacon.
 *
 * Some hardware supports an "ignore list" instead, just make sure nothing
 * that was requested is on the ignore list, and include commonly changing
 * information element IDs in the ignore list, for example 11 (BSS load) and
 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
 * it could also include some currently unused IDs.
 *
 *
 * In addition to these capabilities, hardware should support notifying the
 * host of changes in the beacon RSSI. This is relevant to implement roaming
 * when no traffic is flowing (when traffic is flowing we see the RSSI of
 * the received data packets). This can consist in notifying the host when
 * the RSSI changes significantly or when it drops below or rises above
 * configurable thresholds. In the future these thresholds will also be
 * configured by mac80211 (which gets them from userspace) to implement
 * them as the roaming algorithm requires.
 *
 * If the hardware cannot implement this, the driver should ask it to
 * periodically pass beacon frames to the host so that software can do the
 * signal strength threshold checking.
1216 1217
 */

1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
/**
 * DOC: Spatial multiplexing power save
 *
 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
 * power in an 802.11n implementation. For details on the mechanism
 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
 * "11.2.3 SM power save".
 *
 * The mac80211 implementation is capable of sending action frames
 * to update the AP about the station's SMPS mode, and will instruct
 * the driver to enter the specific mode. It will also announce the
 * requested SMPS mode during the association handshake. Hardware
 * support for this feature is required, and can be indicated by
 * hardware flags.
 *
 * The default mode will be "automatic", which nl80211/cfg80211
 * defines to be dynamic SMPS in (regular) powersave, and SMPS
 * turned off otherwise.
 *
 * To support this feature, the driver must set the appropriate
 * hardware support flags, and handle the SMPS flag to the config()
 * operation. It will then with this mechanism be instructed to
 * enter the requested SMPS mode while associated to an HT AP.
 */

1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255
/**
 * DOC: Frame filtering
 *
 * mac80211 requires to see many management frames for proper
 * operation, and users may want to see many more frames when
 * in monitor mode. However, for best CPU usage and power consumption,
 * having as few frames as possible percolate through the stack is
 * desirable. Hence, the hardware should filter as much as possible.
 *
 * To achieve this, mac80211 uses filter flags (see below) to tell
 * the driver's configure_filter() function which frames should be
 * passed to mac80211 and which should be filtered out.
 *
1256 1257 1258 1259 1260 1261 1262
 * Before configure_filter() is invoked, the prepare_multicast()
 * callback is invoked with the parameters @mc_count and @mc_list
 * for the combined multicast address list of all virtual interfaces.
 * It's use is optional, and it returns a u64 that is passed to
 * configure_filter(). Additionally, configure_filter() has the
 * arguments @changed_flags telling which flags were changed and
 * @total_flags with the new flag states.
1263 1264 1265 1266 1267 1268
 *
 * If your device has no multicast address filters your driver will
 * need to check both the %FIF_ALLMULTI flag and the @mc_count
 * parameter to see whether multicast frames should be accepted
 * or dropped.
 *
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
 * All unsupported flags in @total_flags must be cleared.
 * Hardware does not support a flag if it is incapable of _passing_
 * the frame to the stack. Otherwise the driver must ignore
 * the flag, but not clear it.
 * You must _only_ clear the flag (announce no support for the
 * flag to mac80211) if you are not able to pass the packet type
 * to the stack (so the hardware always filters it).
 * So for example, you should clear @FIF_CONTROL, if your hardware
 * always filters control frames. If your hardware always passes
 * control frames to the kernel and is incapable of filtering them,
 * you do _not_ clear the @FIF_CONTROL flag.
 * This rule applies to all other FIF flags as well.
1281
 */
1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310

/**
 * enum ieee80211_filter_flags - hardware filter flags
 *
 * These flags determine what the filter in hardware should be
 * programmed to let through and what should not be passed to the
 * stack. It is always safe to pass more frames than requested,
 * but this has negative impact on power consumption.
 *
 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
 *	think of the BSS as your network segment and then this corresponds
 *	to the regular ethernet device promiscuous mode.
 *
 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
 *	by the user or if the hardware is not capable of filtering by
 *	multicast address.
 *
 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
 *	%RX_FLAG_FAILED_FCS_CRC for them)
 *
 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
 *	the %RX_FLAG_FAILED_PLCP_CRC for them
 *
 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
 *	to the hardware that it should not filter beacons or probe responses
 *	by BSSID. Filtering them can greatly reduce the amount of processing
 *	mac80211 needs to do and the amount of CPU wakeups, so you should
 *	honour this flag if possible.
 *
I
Igor Perminov 已提交
1311 1312
 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
 *  is not set then only those addressed to this station.
1313 1314
 *
 * @FIF_OTHER_BSS: pass frames destined to other BSSes
I
Igor Perminov 已提交
1315 1316 1317
 *
 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS  is not set then only
 *  those addressed to this station.
1318
 */
1319 1320 1321 1322 1323 1324 1325 1326
enum ieee80211_filter_flags {
	FIF_PROMISC_IN_BSS	= 1<<0,
	FIF_ALLMULTI		= 1<<1,
	FIF_FCSFAIL		= 1<<2,
	FIF_PLCPFAIL		= 1<<3,
	FIF_BCN_PRBRESP_PROMISC	= 1<<4,
	FIF_CONTROL		= 1<<5,
	FIF_OTHER_BSS		= 1<<6,
I
Igor Perminov 已提交
1327
	FIF_PSPOLL		= 1<<7,
1328 1329
};

1330 1331 1332 1333 1334
/**
 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
 *
 * These flags are used with the ampdu_action() callback in
 * &struct ieee80211_ops to indicate which action is needed.
1335 1336 1337 1338 1339 1340
 *
 * Note that drivers MUST be able to deal with a TX aggregation
 * session being stopped even before they OK'ed starting it by
 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer
 * might receive the addBA frame and send a delBA right away!
 *
1341 1342
 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1343 1344
 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1345
 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1346 1347 1348 1349
 */
enum ieee80211_ampdu_mlme_action {
	IEEE80211_AMPDU_RX_START,
	IEEE80211_AMPDU_RX_STOP,
1350 1351
	IEEE80211_AMPDU_TX_START,
	IEEE80211_AMPDU_TX_STOP,
1352
	IEEE80211_AMPDU_TX_OPERATIONAL,
1353
};
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364

/**
 * struct ieee80211_ops - callbacks from mac80211 to the driver
 *
 * This structure contains various callbacks that the driver may
 * handle or, in some cases, must handle, for example to configure
 * the hardware to a new channel or to transmit a frame.
 *
 * @tx: Handler that 802.11 module calls for each transmitted frame.
 *	skb contains the buffer starting from the IEEE 802.11 header.
 *	The low-level driver should send the frame out based on
1365 1366 1367
 *	configuration in the TX control data. This handler should,
 *	preferably, never fail and stop queues appropriately, more
 *	importantly, however, it must never fail for A-MPDU-queues.
1368 1369
 *	This function should return NETDEV_TX_OK except in very
 *	limited cases.
1370
 *	Must be implemented and atomic.
1371 1372 1373 1374 1375 1376 1377 1378 1379
 *
 * @start: Called before the first netdevice attached to the hardware
 *	is enabled. This should turn on the hardware and must turn on
 *	frame reception (for possibly enabled monitor interfaces.)
 *	Returns negative error codes, these may be seen in userspace,
 *	or zero.
 *	When the device is started it should not have a MAC address
 *	to avoid acknowledging frames before a non-monitor device
 *	is added.
1380
 *	Must be implemented and can sleep.
1381 1382 1383 1384 1385
 *
 * @stop: Called after last netdevice attached to the hardware
 *	is disabled. This should turn off the hardware (at least
 *	it must turn off frame reception.)
 *	May be called right after add_interface if that rejects
1386 1387
 *	an interface. If you added any work onto the mac80211 workqueue
 *	you should ensure to cancel it on this callback.
1388
 *	Must be implemented and can sleep.
1389 1390
 *
 * @add_interface: Called when a netdevice attached to the hardware is
1391
 *	enabled. Because it is not called for monitor mode devices, @start
1392 1393 1394 1395 1396 1397
 *	and @stop must be implemented.
 *	The driver should perform any initialization it needs before
 *	the device can be enabled. The initial configuration for the
 *	interface is given in the conf parameter.
 *	The callback may refuse to add an interface by returning a
 *	negative error code (which will be seen in userspace.)
1398
 *	Must be implemented and can sleep.
1399 1400 1401 1402 1403 1404 1405 1406
 *
 * @remove_interface: Notifies a driver that an interface is going down.
 *	The @stop callback is called after this if it is the last interface
 *	and no monitor interfaces are present.
 *	When all interfaces are removed, the MAC address in the hardware
 *	must be cleared so the device no longer acknowledges packets,
 *	the mac_addr member of the conf structure is, however, set to the
 *	MAC address of the device going away.
1407
 *	Hence, this callback must be implemented. It can sleep.
1408 1409 1410
 *
 * @config: Handler for configuration requests. IEEE 802.11 code calls this
 *	function to change hardware configuration, e.g., channel.
1411
 *	This function should never fail but returns a negative error code
1412
 *	if it does. The callback can sleep.
1413
 *
1414 1415 1416 1417 1418
 * @bss_info_changed: Handler for configuration requests related to BSS
 *	parameters that may vary during BSS's lifespan, and may affect low
 *	level driver (e.g. assoc/disassoc status, erp parameters).
 *	This function should not be used if no BSS has been set, unless
 *	for association indication. The @changed parameter indicates which
1419 1420
 *	of the bss parameters has changed when a call is made. The callback
 *	can sleep.
1421
 *
1422 1423 1424 1425
 * @prepare_multicast: Prepare for multicast filter configuration.
 *	This callback is optional, and its return value is passed
 *	to configure_filter(). This callback must be atomic.
 *
1426 1427
 * @configure_filter: Configure the device's RX filter.
 *	See the section "Frame filtering" for more information.
1428
 *	This callback must be implemented and can sleep.
1429
 *
1430
 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1431
 * 	must be set or cleared for a given STA. Must be atomic.
1432 1433
 *
 * @set_key: See the section "Hardware crypto acceleration"
1434 1435
 *	This callback is only called between add_interface and
 *	remove_interface calls, i.e. while the given virtual interface
1436
 *	is enabled.
1437
 *	Returns a negative error code if the key can't be added.
1438
 *	The callback can sleep.
1439
 *
1440 1441 1442
 * @update_tkip_key: See the section "Hardware crypto acceleration"
 * 	This callback will be called in the context of Rx. Called for drivers
 * 	which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1443
 *	The callback can sleep.
1444
 *
1445
 * @hw_scan: Ask the hardware to service the scan request, no need to start
1446
 *	the scan state machine in stack. The scan must honour the channel
1447 1448
 *	configuration done by the regulatory agent in the wiphy's
 *	registered bands. The hardware (or the driver) needs to make sure
1449 1450 1451 1452 1453 1454 1455 1456
 *	that power save is disabled.
 *	The @req ie/ie_len members are rewritten by mac80211 to contain the
 *	entire IEs after the SSID, so that drivers need not look at these
 *	at all but just send them after the SSID -- mac80211 includes the
 *	(extended) supported rates and HT information (where applicable).
 *	When the scan finishes, ieee80211_scan_completed() must be called;
 *	note that it also must be called when the scan cannot finish due to
 *	any error unless this callback returned a negative error code.
1457
 *	The callback can sleep.
1458
 *
1459 1460
 * @sw_scan_start: Notifier function that is called just before a software scan
 *	is started. Can be NULL, if the driver doesn't need this notification.
1461
 *	The callback can sleep.
1462
 *
1463 1464 1465 1466
 * @sw_scan_complete: Notifier function that is called just after a
 *	software scan finished. Can be NULL, if the driver doesn't need
 *	this notification.
 *	The callback can sleep.
1467
 *
1468 1469
 * @get_stats: Return low-level statistics.
 * 	Returns zero if statistics are available.
1470
 *	The callback can sleep.
1471
 *
1472 1473 1474
 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
 *	callback should be provided to read the TKIP transmit IVs (both IV32
 *	and IV16) for the given key from hardware.
1475
 *	The callback must be atomic.
1476 1477
 *
 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1478
 *	The callback can sleep.
1479
 *
1480 1481 1482
 * @sta_notify: Notifies low level driver about addition, removal or power
 *	state transition of an associated station, AP,  IBSS/WDS/mesh peer etc.
 *	Must be atomic.
1483
 *
1484
 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1485
 *	bursting) for a hardware TX queue.
1486
 *	Returns a negative error code on failure.
1487
 *	The callback can sleep.
1488 1489 1490 1491
 *
 * @get_tx_stats: Get statistics of the current TX queue status. This is used
 *	to get number of currently queued packets (queue length), maximum queue
 *	size (limit), and total number of packets sent using each TX queue
1492 1493
 *	(count). The 'stats' pointer points to an array that has hw->queues
 *	items.
1494
 *	The callback must be atomic.
1495 1496
 *
 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1497
 *	this is only used for IBSS mode BSSID merging and debugging. Is not a
1498
 *	required function.
1499
 *	The callback can sleep.
1500 1501 1502
 *
 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
 *      Currently, this is only used for IBSS mode debugging. Is not a
1503
 *	required function.
1504
 *	The callback can sleep.
1505 1506 1507 1508 1509
 *
 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
 *	with other STAs in the IBSS. This is only used in IBSS mode. This
 *	function is optional if the firmware/hardware takes full care of
 *	TSF synchronization.
1510
 *	The callback can sleep.
1511 1512 1513 1514
 *
 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
 *	This is needed only for IBSS mode and the result of this function is
 *	used to determine whether to reply to Probe Requests.
1515
 *	Returns non-zero if this device sent the last beacon.
1516
 *	The callback can sleep.
1517
 *
1518 1519 1520 1521
 * @ampdu_action: Perform a certain A-MPDU action
 * 	The RA/TID combination determines the destination and TID we want
 * 	the ampdu action to be performed for. The action is defined through
 * 	ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1522
 * 	is the first frame we expect to perform the action on. Notice
1523
 * 	that TX/RX_STOP can pass NULL for this parameter.
1524
 *	Returns a negative error code on failure.
1525
 *	The callback must be atomic.
J
Johannes Berg 已提交
1526 1527 1528 1529
 *
 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
 *	need to set wiphy->rfkill_poll to %true before registration,
 *	and need to call wiphy_rfkill_set_hw_state() in the callback.
1530
 *	The callback can sleep.
1531
 *
1532 1533 1534 1535
 * @set_coverage_class: Set slot time for given coverage class as specified
 *	in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
 *	accordingly. This callback is not required and may sleep.
 *
1536
 * @testmode_cmd: Implement a cfg80211 test mode command.
1537
 *	The callback can sleep.
1538 1539 1540
 *
 * @flush: Flush all pending frames from the hardware queue, making sure
 *	that the hardware queues are empty. If the parameter @drop is set
1541
 *	to %true, pending frames may be dropped. The callback can sleep.
1542
 */
1543
struct ieee80211_ops {
1544
	int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1545 1546
	int (*start)(struct ieee80211_hw *hw);
	void (*stop)(struct ieee80211_hw *hw);
1547
	int (*add_interface)(struct ieee80211_hw *hw,
1548
			     struct ieee80211_vif *vif);
1549
	void (*remove_interface)(struct ieee80211_hw *hw,
1550
				 struct ieee80211_vif *vif);
1551
	int (*config)(struct ieee80211_hw *hw, u32 changed);
1552 1553 1554 1555
	void (*bss_info_changed)(struct ieee80211_hw *hw,
				 struct ieee80211_vif *vif,
				 struct ieee80211_bss_conf *info,
				 u32 changed);
1556 1557
	u64 (*prepare_multicast)(struct ieee80211_hw *hw,
				 int mc_count, struct dev_addr_list *mc_list);
1558 1559 1560
	void (*configure_filter)(struct ieee80211_hw *hw,
				 unsigned int changed_flags,
				 unsigned int *total_flags,
1561
				 u64 multicast);
1562 1563
	int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
		       bool set);
1564
	int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1565
		       struct ieee80211_vif *vif, struct ieee80211_sta *sta,
J
Johannes Berg 已提交
1566
		       struct ieee80211_key_conf *key);
1567 1568 1569
	void (*update_tkip_key)(struct ieee80211_hw *hw,
			struct ieee80211_key_conf *conf, const u8 *address,
			u32 iv32, u16 *phase1key);
1570 1571
	int (*hw_scan)(struct ieee80211_hw *hw,
		       struct cfg80211_scan_request *req);
1572 1573
	void (*sw_scan_start)(struct ieee80211_hw *hw);
	void (*sw_scan_complete)(struct ieee80211_hw *hw);
1574 1575
	int (*get_stats)(struct ieee80211_hw *hw,
			 struct ieee80211_low_level_stats *stats);
1576 1577
	void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
			     u32 *iv32, u16 *iv16);
1578
	int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1579
	void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1580
			enum sta_notify_cmd, struct ieee80211_sta *sta);
J
Johannes Berg 已提交
1581
	int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1582 1583 1584 1585
		       const struct ieee80211_tx_queue_params *params);
	int (*get_tx_stats)(struct ieee80211_hw *hw,
			    struct ieee80211_tx_queue_stats *stats);
	u64 (*get_tsf)(struct ieee80211_hw *hw);
1586
	void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1587 1588
	void (*reset_tsf)(struct ieee80211_hw *hw);
	int (*tx_last_beacon)(struct ieee80211_hw *hw);
1589
	int (*ampdu_action)(struct ieee80211_hw *hw,
1590
			    struct ieee80211_vif *vif,
1591
			    enum ieee80211_ampdu_mlme_action action,
1592
			    struct ieee80211_sta *sta, u16 tid, u16 *ssn);
J
Johannes Berg 已提交
1593 1594

	void (*rfkill_poll)(struct ieee80211_hw *hw);
1595
	void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
1596 1597 1598
#ifdef CONFIG_NL80211_TESTMODE
	int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
#endif
1599
	void (*flush)(struct ieee80211_hw *hw, bool drop);
1600 1601
};

1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
/**
 * ieee80211_alloc_hw -  Allocate a new hardware device
 *
 * This must be called once for each hardware device. The returned pointer
 * must be used to refer to this device when calling other functions.
 * mac80211 allocates a private data area for the driver pointed to by
 * @priv in &struct ieee80211_hw, the size of this area is given as
 * @priv_data_len.
 *
 * @priv_data_len: length of private data
 * @ops: callbacks for this device
1613 1614 1615 1616
 */
struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
					const struct ieee80211_ops *ops);

1617 1618 1619
/**
 * ieee80211_register_hw - Register hardware device
 *
J
Johannes Berg 已提交
1620 1621 1622
 * You must call this function before any other functions in
 * mac80211. Note that before a hardware can be registered, you
 * need to fill the contained wiphy's information.
1623 1624 1625
 *
 * @hw: the device to register as returned by ieee80211_alloc_hw()
 */
1626 1627 1628 1629 1630
int ieee80211_register_hw(struct ieee80211_hw *hw);

#ifdef CONFIG_MAC80211_LEDS
extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1631
extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
I
Ivo van Doorn 已提交
1632
extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1633
#endif
1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
/**
 * ieee80211_get_tx_led_name - get name of TX LED
 *
 * mac80211 creates a transmit LED trigger for each wireless hardware
 * that can be used to drive LEDs if your driver registers a LED device.
 * This function returns the name (or %NULL if not configured for LEDs)
 * of the trigger so you can automatically link the LED device.
 *
 * @hw: the hardware to get the LED trigger name for
 */
1644 1645 1646 1647 1648 1649 1650 1651 1652
static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
{
#ifdef CONFIG_MAC80211_LEDS
	return __ieee80211_get_tx_led_name(hw);
#else
	return NULL;
#endif
}

1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
/**
 * ieee80211_get_rx_led_name - get name of RX LED
 *
 * mac80211 creates a receive LED trigger for each wireless hardware
 * that can be used to drive LEDs if your driver registers a LED device.
 * This function returns the name (or %NULL if not configured for LEDs)
 * of the trigger so you can automatically link the LED device.
 *
 * @hw: the hardware to get the LED trigger name for
 */
1663 1664 1665 1666 1667 1668 1669 1670 1671
static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
{
#ifdef CONFIG_MAC80211_LEDS
	return __ieee80211_get_rx_led_name(hw);
#else
	return NULL;
#endif
}

I
Ivo van Doorn 已提交
1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
/**
 * ieee80211_get_assoc_led_name - get name of association LED
 *
 * mac80211 creates a association LED trigger for each wireless hardware
 * that can be used to drive LEDs if your driver registers a LED device.
 * This function returns the name (or %NULL if not configured for LEDs)
 * of the trigger so you can automatically link the LED device.
 *
 * @hw: the hardware to get the LED trigger name for
 */
1682 1683 1684 1685 1686 1687 1688 1689 1690
static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
{
#ifdef CONFIG_MAC80211_LEDS
	return __ieee80211_get_assoc_led_name(hw);
#else
	return NULL;
#endif
}

I
Ivo van Doorn 已提交
1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
/**
 * ieee80211_get_radio_led_name - get name of radio LED
 *
 * mac80211 creates a radio change LED trigger for each wireless hardware
 * that can be used to drive LEDs if your driver registers a LED device.
 * This function returns the name (or %NULL if not configured for LEDs)
 * of the trigger so you can automatically link the LED device.
 *
 * @hw: the hardware to get the LED trigger name for
 */
static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
{
#ifdef CONFIG_MAC80211_LEDS
	return __ieee80211_get_radio_led_name(hw);
#else
	return NULL;
#endif
}
1709

1710 1711 1712 1713 1714 1715 1716 1717
/**
 * ieee80211_unregister_hw - Unregister a hardware device
 *
 * This function instructs mac80211 to free allocated resources
 * and unregister netdevices from the networking subsystem.
 *
 * @hw: the hardware to unregister
 */
1718 1719
void ieee80211_unregister_hw(struct ieee80211_hw *hw);

1720 1721 1722 1723 1724
/**
 * ieee80211_free_hw - free hardware descriptor
 *
 * This function frees everything that was allocated, including the
 * private data for the driver. You must call ieee80211_unregister_hw()
R
Randy Dunlap 已提交
1725
 * before calling this function.
1726 1727 1728
 *
 * @hw: the hardware to free
 */
1729 1730
void ieee80211_free_hw(struct ieee80211_hw *hw);

1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744
/**
 * ieee80211_restart_hw - restart hardware completely
 *
 * Call this function when the hardware was restarted for some reason
 * (hardware error, ...) and the driver is unable to restore its state
 * by itself. mac80211 assumes that at this point the driver/hardware
 * is completely uninitialised and stopped, it starts the process by
 * calling the ->start() operation. The driver will need to reset all
 * internal state that it has prior to calling this function.
 *
 * @hw: the hardware to restart
 */
void ieee80211_restart_hw(struct ieee80211_hw *hw);

1745 1746 1747 1748
/**
 * ieee80211_rx - receive frame
 *
 * Use this function to hand received frames to mac80211. The receive
J
Johannes Berg 已提交
1749
 * buffer in @skb must start with an IEEE 802.11 header.
1750
 *
1751
 * This function may not be called in IRQ context. Calls to this function
K
Kalle Valo 已提交
1752 1753 1754
 * for a single hardware must be synchronized against each other. Calls to
 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
 * mixed for a single hardware.
1755
 *
K
Kalle Valo 已提交
1756
 * In process context use instead ieee80211_rx_ni().
1757
 *
1758 1759 1760
 * @hw: the hardware this frame came in on
 * @skb: the buffer to receive, owned by mac80211 after this call
 */
1761
void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
1762 1763 1764 1765 1766

/**
 * ieee80211_rx_irqsafe - receive frame
 *
 * Like ieee80211_rx() but can be called in IRQ context
1767 1768
 * (internally defers to a tasklet.)
 *
K
Kalle Valo 已提交
1769 1770
 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
 * be mixed for a single hardware.
1771 1772 1773 1774
 *
 * @hw: the hardware this frame came in on
 * @skb: the buffer to receive, owned by mac80211 after this call
 */
1775
void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
1776

K
Kalle Valo 已提交
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796
/**
 * ieee80211_rx_ni - receive frame (in process context)
 *
 * Like ieee80211_rx() but can be called in process context
 * (internally disables bottom halves).
 *
 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
 * not be mixed for a single hardware.
 *
 * @hw: the hardware this frame came in on
 * @skb: the buffer to receive, owned by mac80211 after this call
 */
static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
				   struct sk_buff *skb)
{
	local_bh_disable();
	ieee80211_rx(hw, skb);
	local_bh_enable();
}

1797 1798 1799 1800 1801 1802
/*
 * The TX headroom reserved by mac80211 for its own tx_status functions.
 * This is enough for the radiotap header.
 */
#define IEEE80211_TX_STATUS_HEADROOM	13

1803 1804 1805 1806 1807 1808 1809
/**
 * ieee80211_tx_status - transmit status callback
 *
 * Call this function for all transmitted frames after they have been
 * transmitted. It is permissible to not call this function for
 * multicast frames but this can affect statistics.
 *
1810 1811 1812 1813 1814
 * This function may not be called in IRQ context. Calls to this function
 * for a single hardware must be synchronized against each other. Calls
 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
 * for a single hardware.
 *
1815 1816 1817
 * @hw: the hardware the frame was transmitted by
 * @skb: the frame that was transmitted, owned by mac80211 after this call
 */
1818
void ieee80211_tx_status(struct ieee80211_hw *hw,
1819
			 struct sk_buff *skb);
1820 1821

/**
R
Randy Dunlap 已提交
1822
 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1823 1824 1825 1826 1827 1828 1829 1830 1831 1832
 *
 * Like ieee80211_tx_status() but can be called in IRQ context
 * (internally defers to a tasklet.)
 *
 * Calls to this function and ieee80211_tx_status() may not be mixed for a
 * single hardware.
 *
 * @hw: the hardware the frame was transmitted by
 * @skb: the frame that was transmitted, owned by mac80211 after this call
 */
1833
void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1834
				 struct sk_buff *skb);
1835 1836

/**
1837
 * ieee80211_beacon_get_tim - beacon generation function
1838
 * @hw: pointer obtained from ieee80211_alloc_hw().
1839
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1840 1841 1842 1843 1844 1845 1846 1847
 * @tim_offset: pointer to variable that will receive the TIM IE offset.
 *	Set to 0 if invalid (in non-AP modes).
 * @tim_length: pointer to variable that will receive the TIM IE length,
 *	(including the ID and length bytes!).
 *	Set to 0 if invalid (in non-AP modes).
 *
 * If the driver implements beaconing modes, it must use this function to
 * obtain the beacon frame/template.
1848 1849
 *
 * If the beacon frames are generated by the host system (i.e., not in
1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866
 * hardware/firmware), the driver uses this function to get each beacon
 * frame from mac80211 -- it is responsible for calling this function
 * before the beacon is needed (e.g. based on hardware interrupt).
 *
 * If the beacon frames are generated by the device, then the driver
 * must use the returned beacon as the template and change the TIM IE
 * according to the current DTIM parameters/TIM bitmap.
 *
 * The driver is responsible for freeing the returned skb.
 */
struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
					 struct ieee80211_vif *vif,
					 u16 *tim_offset, u16 *tim_length);

/**
 * ieee80211_beacon_get - beacon generation function
 * @hw: pointer obtained from ieee80211_alloc_hw().
1867
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1868 1869
 *
 * See ieee80211_beacon_get_tim().
1870
 */
1871 1872 1873 1874 1875
static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
						   struct ieee80211_vif *vif)
{
	return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
}
1876

1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906
/**
 * ieee80211_pspoll_get - retrieve a PS Poll template
 * @hw: pointer obtained from ieee80211_alloc_hw().
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
 *
 * Creates a PS Poll a template which can, for example, uploaded to
 * hardware. The template must be updated after association so that correct
 * AID, BSSID and MAC address is used.
 *
 * Note: Caller (or hardware) is responsible for setting the
 * &IEEE80211_FCTL_PM bit.
 */
struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
				     struct ieee80211_vif *vif);

/**
 * ieee80211_nullfunc_get - retrieve a nullfunc template
 * @hw: pointer obtained from ieee80211_alloc_hw().
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
 *
 * Creates a Nullfunc template which can, for example, uploaded to
 * hardware. The template must be updated after association so that correct
 * BSSID and address is used.
 *
 * Note: Caller (or hardware) is responsible for setting the
 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
 */
struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
				       struct ieee80211_vif *vif);

1907 1908 1909
/**
 * ieee80211_rts_get - RTS frame generation function
 * @hw: pointer obtained from ieee80211_alloc_hw().
1910
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1911 1912
 * @frame: pointer to the frame that is going to be protected by the RTS.
 * @frame_len: the frame length (in octets).
1913
 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1914 1915 1916 1917 1918 1919 1920
 * @rts: The buffer where to store the RTS frame.
 *
 * If the RTS frames are generated by the host system (i.e., not in
 * hardware/firmware), the low-level driver uses this function to receive
 * the next RTS frame from the 802.11 code. The low-level is responsible
 * for calling this function before and RTS frame is needed.
 */
1921
void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1922
		       const void *frame, size_t frame_len,
1923
		       const struct ieee80211_tx_info *frame_txctl,
1924 1925 1926 1927 1928
		       struct ieee80211_rts *rts);

/**
 * ieee80211_rts_duration - Get the duration field for an RTS frame
 * @hw: pointer obtained from ieee80211_alloc_hw().
1929
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1930
 * @frame_len: the length of the frame that is going to be protected by the RTS.
1931
 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1932 1933 1934 1935 1936
 *
 * If the RTS is generated in firmware, but the host system must provide
 * the duration field, the low-level driver uses this function to receive
 * the duration field value in little-endian byteorder.
 */
1937 1938
__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
			      struct ieee80211_vif *vif, size_t frame_len,
1939
			      const struct ieee80211_tx_info *frame_txctl);
1940 1941 1942 1943

/**
 * ieee80211_ctstoself_get - CTS-to-self frame generation function
 * @hw: pointer obtained from ieee80211_alloc_hw().
1944
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1945 1946
 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
 * @frame_len: the frame length (in octets).
1947
 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1948 1949 1950 1951 1952 1953 1954
 * @cts: The buffer where to store the CTS-to-self frame.
 *
 * If the CTS-to-self frames are generated by the host system (i.e., not in
 * hardware/firmware), the low-level driver uses this function to receive
 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
 * for calling this function before and CTS-to-self frame is needed.
 */
1955 1956
void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
			     struct ieee80211_vif *vif,
1957
			     const void *frame, size_t frame_len,
1958
			     const struct ieee80211_tx_info *frame_txctl,
1959 1960 1961 1962 1963
			     struct ieee80211_cts *cts);

/**
 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
 * @hw: pointer obtained from ieee80211_alloc_hw().
1964
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1965
 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1966
 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1967 1968 1969 1970 1971
 *
 * If the CTS-to-self is generated in firmware, but the host system must provide
 * the duration field, the low-level driver uses this function to receive
 * the duration field value in little-endian byteorder.
 */
1972 1973
__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
				    struct ieee80211_vif *vif,
1974
				    size_t frame_len,
1975
				    const struct ieee80211_tx_info *frame_txctl);
1976 1977 1978 1979

/**
 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
 * @hw: pointer obtained from ieee80211_alloc_hw().
1980
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1981
 * @frame_len: the length of the frame.
1982
 * @rate: the rate at which the frame is going to be transmitted.
1983 1984 1985 1986
 *
 * Calculate the duration field of some generic frame, given its
 * length and transmission rate (in 100kbps).
 */
1987 1988
__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
					struct ieee80211_vif *vif,
1989
					size_t frame_len,
1990
					struct ieee80211_rate *rate);
1991 1992 1993 1994

/**
 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
 * @hw: pointer as obtained from ieee80211_alloc_hw().
1995
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012
 *
 * Function for accessing buffered broadcast and multicast frames. If
 * hardware/firmware does not implement buffering of broadcast/multicast
 * frames when power saving is used, 802.11 code buffers them in the host
 * memory. The low-level driver uses this function to fetch next buffered
 * frame. In most cases, this is used when generating beacon frame. This
 * function returns a pointer to the next buffered skb or NULL if no more
 * buffered frames are available.
 *
 * Note: buffered frames are returned only after DTIM beacon frame was
 * generated with ieee80211_beacon_get() and the low-level driver must thus
 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
 * NULL if the previous generated beacon was not DTIM, so the low-level driver
 * does not need to check for DTIM beacons separately and should be able to
 * use common code for all beacons.
 */
struct sk_buff *
2013
ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2014

2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
/**
 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
 *
 * This function computes a TKIP rc4 key for an skb. It computes
 * a phase 1 key if needed (iv16 wraps around). This function is to
 * be used by drivers which can do HW encryption but need to compute
 * to phase 1/2 key in SW.
 *
 * @keyconf: the parameter passed with the set key
 * @skb: the skb for which the key is needed
R
Randy Dunlap 已提交
2025
 * @type: TBD
R
Randy Dunlap 已提交
2026
 * @key: a buffer to which the key will be written
2027 2028 2029 2030
 */
void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
				struct sk_buff *skb,
				enum ieee80211_tkip_key_type type, u8 *key);
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048
/**
 * ieee80211_wake_queue - wake specific queue
 * @hw: pointer as obtained from ieee80211_alloc_hw().
 * @queue: queue number (counted from zero).
 *
 * Drivers should use this function instead of netif_wake_queue.
 */
void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);

/**
 * ieee80211_stop_queue - stop specific queue
 * @hw: pointer as obtained from ieee80211_alloc_hw().
 * @queue: queue number (counted from zero).
 *
 * Drivers should use this function instead of netif_stop_queue.
 */
void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);

2049 2050 2051 2052 2053 2054 2055 2056 2057 2058
/**
 * ieee80211_queue_stopped - test status of the queue
 * @hw: pointer as obtained from ieee80211_alloc_hw().
 * @queue: queue number (counted from zero).
 *
 * Drivers should use this function instead of netif_stop_queue.
 */

int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);

2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074
/**
 * ieee80211_stop_queues - stop all queues
 * @hw: pointer as obtained from ieee80211_alloc_hw().
 *
 * Drivers should use this function instead of netif_stop_queue.
 */
void ieee80211_stop_queues(struct ieee80211_hw *hw);

/**
 * ieee80211_wake_queues - wake all queues
 * @hw: pointer as obtained from ieee80211_alloc_hw().
 *
 * Drivers should use this function instead of netif_wake_queue.
 */
void ieee80211_wake_queues(struct ieee80211_hw *hw);

2075 2076 2077 2078 2079 2080 2081 2082
/**
 * ieee80211_scan_completed - completed hardware scan
 *
 * When hardware scan offload is used (i.e. the hw_scan() callback is
 * assigned) this function needs to be called by the driver to notify
 * mac80211 that the scan finished.
 *
 * @hw: the hardware that finished the scan
2083
 * @aborted: set to true if scan was aborted
2084
 */
2085
void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2086

2087
/**
R
Randy Dunlap 已提交
2088
 * ieee80211_iterate_active_interfaces - iterate active interfaces
2089 2090 2091
 *
 * This function iterates over the interfaces associated with a given
 * hardware that are currently active and calls the callback for them.
2092 2093 2094
 * This function allows the iterator function to sleep, when the iterator
 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
 * be used.
2095 2096
 *
 * @hw: the hardware struct of which the interfaces should be iterated over
2097
 * @iterator: the iterator function to call
2098 2099 2100 2101
 * @data: first argument of the iterator function
 */
void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
					 void (*iterator)(void *data, u8 *mac,
2102
						struct ieee80211_vif *vif),
2103 2104
					 void *data);

2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122
/**
 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
 *
 * This function iterates over the interfaces associated with a given
 * hardware that are currently active and calls the callback for them.
 * This function requires the iterator callback function to be atomic,
 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
 *
 * @hw: the hardware struct of which the interfaces should be iterated over
 * @iterator: the iterator function to call, cannot sleep
 * @data: first argument of the iterator function
 */
void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
						void (*iterator)(void *data,
						    u8 *mac,
						    struct ieee80211_vif *vif),
						void *data);

2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147
/**
 * ieee80211_queue_work - add work onto the mac80211 workqueue
 *
 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
 * This helper ensures drivers are not queueing work when they should not be.
 *
 * @hw: the hardware struct for the interface we are adding work for
 * @work: the work we want to add onto the mac80211 workqueue
 */
void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);

/**
 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
 *
 * Drivers and mac80211 use this to queue delayed work onto the mac80211
 * workqueue.
 *
 * @hw: the hardware struct for the interface we are adding work for
 * @dwork: delayable work to queue onto the mac80211 workqueue
 * @delay: number of jiffies to wait before queueing
 */
void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
				  struct delayed_work *dwork,
				  unsigned long delay);

2148 2149
/**
 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2150
 * @sta: the station for which to start a BA session
2151
 * @tid: the TID to BA on.
R
Randy Dunlap 已提交
2152 2153
 *
 * Return: success if addBA request was sent, failure otherwise
2154 2155 2156 2157 2158
 *
 * Although mac80211/low level driver/user space application can estimate
 * the need to start aggregation on a certain RA/TID, the session level
 * will be managed by the mac80211.
 */
2159
int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2160 2161 2162

/**
 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
2163
 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2164 2165 2166 2167 2168 2169
 * @ra: receiver address of the BA session recipient.
 * @tid: the TID to BA on.
 *
 * This function must be called by low level driver once it has
 * finished with preparations for the BA session.
 */
2170
void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid);
2171 2172 2173

/**
 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2174
 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2175 2176 2177 2178 2179
 * @ra: receiver address of the BA session recipient.
 * @tid: the TID to BA on.
 *
 * This function must be called by low level driver once it has
 * finished with preparations for the BA session.
R
Randy Dunlap 已提交
2180
 * This version of the function is IRQ-safe.
2181
 */
2182
void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2183 2184 2185 2186
				      u16 tid);

/**
 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2187
 * @sta: the station whose BA session to stop
2188 2189
 * @tid: the TID to stop BA.
 * @initiator: if indicates initiator DELBA frame will be sent.
R
Randy Dunlap 已提交
2190 2191
 *
 * Return: error if no sta with matching da found, success otherwise
2192 2193 2194 2195 2196
 *
 * Although mac80211/low level driver/user space application can estimate
 * the need to stop aggregation on a certain RA/TID, the session level
 * will be managed by the mac80211.
 */
2197
int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2198 2199 2200 2201
				 enum ieee80211_back_parties initiator);

/**
 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
2202
 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2203 2204 2205 2206 2207 2208
 * @ra: receiver address of the BA session recipient.
 * @tid: the desired TID to BA on.
 *
 * This function must be called by low level driver once it has
 * finished with preparations for the BA session tear down.
 */
2209
void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid);
2210 2211 2212

/**
 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2213
 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2214 2215 2216 2217 2218
 * @ra: receiver address of the BA session recipient.
 * @tid: the desired TID to BA on.
 *
 * This function must be called by low level driver once it has
 * finished with preparations for the BA session tear down.
R
Randy Dunlap 已提交
2219
 * This version of the function is IRQ-safe.
2220
 */
2221
void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2222 2223
				     u16 tid);

2224 2225 2226
/**
 * ieee80211_find_sta - find a station
 *
2227
 * @vif: virtual interface to look for station on
2228 2229 2230 2231 2232
 * @addr: station's address
 *
 * This function must be called under RCU lock and the
 * resulting pointer is only valid under RCU lock as well.
 */
2233
struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
2234 2235
					 const u8 *addr);

2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256
/**
 * ieee80211_find_sta_by_hw - find a station on hardware
 *
 * @hw: pointer as obtained from ieee80211_alloc_hw()
 * @addr: station's address
 *
 * This function must be called under RCU lock and the
 * resulting pointer is only valid under RCU lock as well.
 *
 * NOTE: This function should not be used! When mac80211 is converted
 *	 internally to properly keep track of stations on multiple
 *	 virtual interfaces, it will not always know which station to
 *	 return here since a single address might be used by multiple
 *	 logical stations (e.g. consider a station connecting to another
 *	 BSSID on the same AP hardware without disconnecting first).
 *
 * DO NOT USE THIS FUNCTION.
 */
struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
					       const u8 *addr);

2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288
/**
 * ieee80211_sta_block_awake - block station from waking up
 * @hw: the hardware
 * @pubsta: the station
 * @block: whether to block or unblock
 *
 * Some devices require that all frames that are on the queues
 * for a specific station that went to sleep are flushed before
 * a poll response or frames after the station woke up can be
 * delivered to that it. Note that such frames must be rejected
 * by the driver as filtered, with the appropriate status flag.
 *
 * This function allows implementing this mode in a race-free
 * manner.
 *
 * To do this, a driver must keep track of the number of frames
 * still enqueued for a specific station. If this number is not
 * zero when the station goes to sleep, the driver must call
 * this function to force mac80211 to consider the station to
 * be asleep regardless of the station's actual state. Once the
 * number of outstanding frames reaches zero, the driver must
 * call this function again to unblock the station. That will
 * cause mac80211 to be able to send ps-poll responses, and if
 * the station queried in the meantime then frames will also
 * be sent out as a result of this. Additionally, the driver
 * will be notified that the station woke up some time after
 * it is unblocked, regardless of whether the station actually
 * woke up while blocked or not.
 */
void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
			       struct ieee80211_sta *pubsta, bool block);

2289 2290 2291
/**
 * ieee80211_beacon_loss - inform hardware does not receive beacons
 *
2292
 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2293 2294 2295 2296 2297 2298
 *
 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
 * hardware is not receiving beacons with this function.
 */
void ieee80211_beacon_loss(struct ieee80211_vif *vif);
2299 2300

/* Rate control API */
2301

2302 2303 2304 2305 2306 2307 2308 2309 2310 2311
/**
 * enum rate_control_changed - flags to indicate which parameter changed
 *
 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
 *	changed, rate control algorithm can update its internal state if needed.
 */
enum rate_control_changed {
	IEEE80211_RC_HT_CHANGED = BIT(0)
};

2312
/**
2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325
 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
 *
 * @hw: The hardware the algorithm is invoked for.
 * @sband: The band this frame is being transmitted on.
 * @bss_conf: the current BSS configuration
 * @reported_rate: The rate control algorithm can fill this in to indicate
 *	which rate should be reported to userspace as the current rate and
 *	used for rate calculations in the mesh network.
 * @rts: whether RTS will be used for this frame because it is longer than the
 *	RTS threshold
 * @short_preamble: whether mac80211 will request short-preamble transmission
 *	if the selected rate supports it
 * @max_rate_idx: user-requested maximum rate (not MCS for now)
2326 2327 2328
 *	(deprecated; this will be removed once drivers get updated to use
 *	rate_idx_mask)
 * @rate_idx_mask: user-requested rate mask (not MCS for now)
2329 2330
 * @skb: the skb that will be transmitted, the control information in it needs
 *	to be filled in
2331
 * @ap: whether this frame is sent out in AP mode
2332 2333 2334 2335 2336 2337 2338 2339 2340
 */
struct ieee80211_tx_rate_control {
	struct ieee80211_hw *hw;
	struct ieee80211_supported_band *sband;
	struct ieee80211_bss_conf *bss_conf;
	struct sk_buff *skb;
	struct ieee80211_tx_rate reported_rate;
	bool rts, short_preamble;
	u8 max_rate_idx;
2341
	u32 rate_idx_mask;
2342
	bool ap;
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353
};

struct rate_control_ops {
	struct module *module;
	const char *name;
	void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
	void (*free)(void *priv);

	void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
	void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
			  struct ieee80211_sta *sta, void *priv_sta);
2354 2355 2356
	void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
			    struct ieee80211_sta *sta,
			    void *priv_sta, u32 changed);
2357 2358 2359 2360 2361 2362
	void (*free_sta)(void *priv, struct ieee80211_sta *sta,
			 void *priv_sta);

	void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
			  struct ieee80211_sta *sta, void *priv_sta,
			  struct sk_buff *skb);
2363 2364
	void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
			 struct ieee80211_tx_rate_control *txrc);
2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377

	void (*add_sta_debugfs)(void *priv, void *priv_sta,
				struct dentry *dir);
	void (*remove_sta_debugfs)(void *priv, void *priv_sta);
};

static inline int rate_supported(struct ieee80211_sta *sta,
				 enum ieee80211_band band,
				 int index)
{
	return (sta == NULL || sta->supp_rates[band] & BIT(index));
}

2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400
/**
 * rate_control_send_low - helper for drivers for management/no-ack frames
 *
 * Rate control algorithms that agree to use the lowest rate to
 * send management frames and NO_ACK data with the respective hw
 * retries should use this in the beginning of their mac80211 get_rate
 * callback. If true is returned the rate control can simply return.
 * If false is returned we guarantee that sta and sta and priv_sta is
 * not null.
 *
 * Rate control algorithms wishing to do more intelligent selection of
 * rate for multicast/broadcast frames may choose to not use this.
 *
 * @sta: &struct ieee80211_sta pointer to the target destination. Note
 * 	that this may be null.
 * @priv_sta: private rate control structure. This may be null.
 * @txrc: rate control information we sholud populate for mac80211.
 */
bool rate_control_send_low(struct ieee80211_sta *sta,
			   void *priv_sta,
			   struct ieee80211_tx_rate_control *txrc);


2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416
static inline s8
rate_lowest_index(struct ieee80211_supported_band *sband,
		  struct ieee80211_sta *sta)
{
	int i;

	for (i = 0; i < sband->n_bitrates; i++)
		if (rate_supported(sta, sband->band, i))
			return i;

	/* warn when we cannot find a rate. */
	WARN_ON(1);

	return 0;
}

2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427
static inline
bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
			      struct ieee80211_sta *sta)
{
	unsigned int i;

	for (i = 0; i < sband->n_bitrates; i++)
		if (rate_supported(sta, sband->band, i))
			return true;
	return false;
}
2428 2429 2430 2431

int ieee80211_rate_control_register(struct rate_control_ops *ops);
void ieee80211_rate_control_unregister(struct rate_control_ops *ops);

2432 2433 2434
static inline bool
conf_is_ht20(struct ieee80211_conf *conf)
{
2435
	return conf->channel_type == NL80211_CHAN_HT20;
2436 2437 2438 2439 2440
}

static inline bool
conf_is_ht40_minus(struct ieee80211_conf *conf)
{
2441
	return conf->channel_type == NL80211_CHAN_HT40MINUS;
2442 2443 2444 2445 2446
}

static inline bool
conf_is_ht40_plus(struct ieee80211_conf *conf)
{
2447
	return conf->channel_type == NL80211_CHAN_HT40PLUS;
2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458
}

static inline bool
conf_is_ht40(struct ieee80211_conf *conf)
{
	return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
}

static inline bool
conf_is_ht(struct ieee80211_conf *conf)
{
2459
	return conf->channel_type != NL80211_CHAN_NO_HT;
2460 2461
}

2462
#endif /* MAC80211_H */