Loading...
1/*
2 * mac80211 <-> driver interface
3 *
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
16#include <linux/kernel.h>
17#include <linux/if_ether.h>
18#include <linux/skbuff.h>
19#include <linux/wireless.h>
20#include <linux/device.h>
21#include <linux/ieee80211.h>
22#include <net/cfg80211.h>
23#include <asm/unaligned.h>
24
25/**
26 * DOC: Introduction
27 *
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
31 * drivers.
32 */
33
34/**
35 * DOC: Calling mac80211 from interrupts
36 *
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
42 * tasklet function.
43 *
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-IRQ-safe functions!
46 */
47
48/**
49 * DOC: Warning
50 *
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
53 */
54
55/**
56 * DOC: Frame format
57 *
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
61 * hardware.
62 *
63 * There are, however, various exceptions to this rule for advanced features:
64 *
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
67 *
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
70 *
71 * Finally, for received frames, the driver is able to indicate that it has
72 * filled a radiotap header and put that in front of the frame; if it does
73 * not do so then mac80211 may add this under certain circumstances.
74 */
75
76/**
77 * DOC: mac80211 workqueue
78 *
79 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
80 * The workqueue is a single threaded workqueue and can only be accessed by
81 * helpers for sanity checking. Drivers must ensure all work added onto the
82 * mac80211 workqueue should be cancelled on the driver stop() callback.
83 *
84 * mac80211 will flushed the workqueue upon interface removal and during
85 * suspend.
86 *
87 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
88 *
89 */
90
91/**
92 * enum ieee80211_max_queues - maximum number of queues
93 *
94 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
95 */
96enum ieee80211_max_queues {
97 IEEE80211_MAX_QUEUES = 4,
98};
99
100/**
101 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
102 * @IEEE80211_AC_VO: voice
103 * @IEEE80211_AC_VI: video
104 * @IEEE80211_AC_BE: best effort
105 * @IEEE80211_AC_BK: background
106 */
107enum ieee80211_ac_numbers {
108 IEEE80211_AC_VO = 0,
109 IEEE80211_AC_VI = 1,
110 IEEE80211_AC_BE = 2,
111 IEEE80211_AC_BK = 3,
112};
113
114/**
115 * struct ieee80211_tx_queue_params - transmit queue configuration
116 *
117 * The information provided in this structure is required for QoS
118 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
119 *
120 * @aifs: arbitration interframe space [0..255]
121 * @cw_min: minimum contention window [a value of the form
122 * 2^n-1 in the range 1..32767]
123 * @cw_max: maximum contention window [like @cw_min]
124 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
125 * @uapsd: is U-APSD mode enabled for the queue
126 */
127struct ieee80211_tx_queue_params {
128 u16 txop;
129 u16 cw_min;
130 u16 cw_max;
131 u8 aifs;
132 bool uapsd;
133};
134
135struct ieee80211_low_level_stats {
136 unsigned int dot11ACKFailureCount;
137 unsigned int dot11RTSFailureCount;
138 unsigned int dot11FCSErrorCount;
139 unsigned int dot11RTSSuccessCount;
140};
141
142/**
143 * enum ieee80211_bss_change - BSS change notification flags
144 *
145 * These flags are used with the bss_info_changed() callback
146 * to indicate which BSS parameter changed.
147 *
148 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
149 * also implies a change in the AID.
150 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
151 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
152 * @BSS_CHANGED_ERP_SLOT: slot timing changed
153 * @BSS_CHANGED_HT: 802.11n parameters changed
154 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
155 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
156 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
157 * reason (IBSS and managed mode)
158 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
159 * new beacon (beaconing modes)
160 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
161 * enabled/disabled (beaconing modes)
162 * @BSS_CHANGED_CQM: Connection quality monitor config changed
163 * @BSS_CHANGED_IBSS: IBSS join status changed
164 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
165 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
166 * that it is only ever disabled for station mode.
167 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
168 */
169enum ieee80211_bss_change {
170 BSS_CHANGED_ASSOC = 1<<0,
171 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
172 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
173 BSS_CHANGED_ERP_SLOT = 1<<3,
174 BSS_CHANGED_HT = 1<<4,
175 BSS_CHANGED_BASIC_RATES = 1<<5,
176 BSS_CHANGED_BEACON_INT = 1<<6,
177 BSS_CHANGED_BSSID = 1<<7,
178 BSS_CHANGED_BEACON = 1<<8,
179 BSS_CHANGED_BEACON_ENABLED = 1<<9,
180 BSS_CHANGED_CQM = 1<<10,
181 BSS_CHANGED_IBSS = 1<<11,
182 BSS_CHANGED_ARP_FILTER = 1<<12,
183 BSS_CHANGED_QOS = 1<<13,
184 BSS_CHANGED_IDLE = 1<<14,
185
186 /* when adding here, make sure to change ieee80211_reconfig */
187};
188
189/*
190 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
191 * of addresses for an interface increase beyond this value, hardware ARP
192 * filtering will be disabled.
193 */
194#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
195
196/**
197 * enum ieee80211_rssi_event - RSSI threshold event
198 * An indicator for when RSSI goes below/above a certain threshold.
199 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
200 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
201 */
202enum ieee80211_rssi_event {
203 RSSI_EVENT_HIGH,
204 RSSI_EVENT_LOW,
205};
206
207/**
208 * struct ieee80211_bss_conf - holds the BSS's changing parameters
209 *
210 * This structure keeps information about a BSS (and an association
211 * to that BSS) that can change during the lifetime of the BSS.
212 *
213 * @assoc: association status
214 * @ibss_joined: indicates whether this station is part of an IBSS
215 * or not
216 * @aid: association ID number, valid only when @assoc is true
217 * @use_cts_prot: use CTS protection
218 * @use_short_preamble: use 802.11b short preamble;
219 * if the hardware cannot handle this it must set the
220 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
221 * @use_short_slot: use short slot time (only relevant for ERP);
222 * if the hardware cannot handle this it must set the
223 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
224 * @dtim_period: num of beacons before the next DTIM, for beaconing,
225 * valid in station mode only while @assoc is true and if also
226 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
227 * @ps_dtim_period)
228 * @timestamp: beacon timestamp
229 * @beacon_int: beacon interval
230 * @assoc_capability: capabilities taken from assoc resp
231 * @basic_rates: bitmap of basic rates, each bit stands for an
232 * index into the rate table configured by the driver in
233 * the current band.
234 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
235 * @bssid: The BSSID for this BSS
236 * @enable_beacon: whether beaconing should be enabled or not
237 * @channel_type: Channel type for this BSS -- the hardware might be
238 * configured for HT40+ while this BSS only uses no-HT, for
239 * example.
240 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
241 * This field is only valid when the channel type is one of the HT types.
242 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
243 * implies disabled
244 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
245 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
246 * may filter ARP queries targeted for other addresses than listed here.
247 * The driver must allow ARP queries targeted for all address listed here
248 * to pass through. An empty list implies no ARP queries need to pass.
249 * @arp_addr_cnt: Number of addresses currently on the list.
250 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
251 * filter ARP queries based on the @arp_addr_list, if disabled, the
252 * hardware must not perform any ARP filtering. Note, that the filter will
253 * be enabled also in promiscuous mode.
254 * @qos: This is a QoS-enabled BSS.
255 * @idle: This interface is idle. There's also a global idle flag in the
256 * hardware config which may be more appropriate depending on what
257 * your driver/device needs to do.
258 */
259struct ieee80211_bss_conf {
260 const u8 *bssid;
261 /* association related data */
262 bool assoc, ibss_joined;
263 u16 aid;
264 /* erp related data */
265 bool use_cts_prot;
266 bool use_short_preamble;
267 bool use_short_slot;
268 bool enable_beacon;
269 u8 dtim_period;
270 u16 beacon_int;
271 u16 assoc_capability;
272 u64 timestamp;
273 u32 basic_rates;
274 int mcast_rate[IEEE80211_NUM_BANDS];
275 u16 ht_operation_mode;
276 s32 cqm_rssi_thold;
277 u32 cqm_rssi_hyst;
278 enum nl80211_channel_type channel_type;
279 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
280 u8 arp_addr_cnt;
281 bool arp_filter_enabled;
282 bool qos;
283 bool idle;
284};
285
286/**
287 * enum mac80211_tx_control_flags - flags to describe transmission information/status
288 *
289 * These flags are used with the @flags member of &ieee80211_tx_info.
290 *
291 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
292 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
293 * number to this frame, taking care of not overwriting the fragment
294 * number and increasing the sequence number only when the
295 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
296 * assign sequence numbers to QoS-data frames but cannot do so correctly
297 * for non-QoS-data and management frames because beacons need them from
298 * that counter as well and mac80211 cannot guarantee proper sequencing.
299 * If this flag is set, the driver should instruct the hardware to
300 * assign a sequence number to the frame or assign one itself. Cf. IEEE
301 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
302 * beacons and always be clear for frames without a sequence number field.
303 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
304 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
305 * station
306 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
307 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
308 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
309 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
310 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
311 * because the destination STA was in powersave mode. Note that to
312 * avoid race conditions, the filter must be set by the hardware or
313 * firmware upon receiving a frame that indicates that the station
314 * went to sleep (must be done on device to filter frames already on
315 * the queue) and may only be unset after mac80211 gives the OK for
316 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
317 * since only then is it guaranteed that no more frames are in the
318 * hardware queue.
319 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
320 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
321 * is for the whole aggregation.
322 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
323 * so consider using block ack request (BAR).
324 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
325 * set by rate control algorithms to indicate probe rate, will
326 * be cleared for fragmented frames (except on the last fragment)
327 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
328 * used to indicate that a pending frame requires TX processing before
329 * it can be sent out.
330 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
331 * used to indicate that a frame was already retried due to PS
332 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
333 * used to indicate frame should not be encrypted
334 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
335 * This frame is a response to a PS-poll frame and should be sent
336 * although the station is in powersave mode.
337 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
338 * transmit function after the current frame, this can be used
339 * by drivers to kick the DMA queue only if unset or when the
340 * queue gets full.
341 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
342 * after TX status because the destination was asleep, it must not
343 * be modified again (no seqno assignment, crypto, etc.)
344 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
345 * has a radiotap header at skb->data.
346 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
347 * MLME command (internal to mac80211 to figure out whether to send TX
348 * status to user space)
349 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
350 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
351 * frame and selects the maximum number of streams that it can use.
352 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
353 * the off-channel channel when a remain-on-channel offload is done
354 * in hardware -- normal packets still flow and are expected to be
355 * handled properly by the device.
356 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
357 * testing. It will be sent out with incorrect Michael MIC key to allow
358 * TKIP countermeasures to be tested.
359 *
360 * Note: If you have to add new flags to the enumeration, then don't
361 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
362 */
363enum mac80211_tx_control_flags {
364 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
365 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
366 IEEE80211_TX_CTL_NO_ACK = BIT(2),
367 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
368 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
369 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
370 IEEE80211_TX_CTL_AMPDU = BIT(6),
371 IEEE80211_TX_CTL_INJECTED = BIT(7),
372 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
373 IEEE80211_TX_STAT_ACK = BIT(9),
374 IEEE80211_TX_STAT_AMPDU = BIT(10),
375 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
376 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
377 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
378 IEEE80211_TX_INTFL_RETRIED = BIT(15),
379 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
380 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
381 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
382 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
383 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
384 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
385 IEEE80211_TX_CTL_LDPC = BIT(22),
386 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
387 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
388 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
389};
390
391#define IEEE80211_TX_CTL_STBC_SHIFT 23
392
393/*
394 * This definition is used as a mask to clear all temporary flags, which are
395 * set by the tx handlers for each transmission attempt by the mac80211 stack.
396 */
397#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
398 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
399 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
400 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
401 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
402 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
403 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
404 IEEE80211_TX_CTL_STBC)
405
406/**
407 * enum mac80211_rate_control_flags - per-rate flags set by the
408 * Rate Control algorithm.
409 *
410 * These flags are set by the Rate control algorithm for each rate during tx,
411 * in the @flags member of struct ieee80211_tx_rate.
412 *
413 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
414 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
415 * This is set if the current BSS requires ERP protection.
416 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
417 * @IEEE80211_TX_RC_MCS: HT rate.
418 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
419 * Greenfield mode.
420 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
421 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
422 * adjacent 20 MHz channels, if the current channel type is
423 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
424 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
425 */
426enum mac80211_rate_control_flags {
427 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
428 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
429 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
430
431 /* rate index is an MCS rate number instead of an index */
432 IEEE80211_TX_RC_MCS = BIT(3),
433 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
434 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
435 IEEE80211_TX_RC_DUP_DATA = BIT(6),
436 IEEE80211_TX_RC_SHORT_GI = BIT(7),
437};
438
439
440/* there are 40 bytes if you don't need the rateset to be kept */
441#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
442
443/* if you do need the rateset, then you have less space */
444#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
445
446/* maximum number of rate stages */
447#define IEEE80211_TX_MAX_RATES 5
448
449/**
450 * struct ieee80211_tx_rate - rate selection/status
451 *
452 * @idx: rate index to attempt to send with
453 * @flags: rate control flags (&enum mac80211_rate_control_flags)
454 * @count: number of tries in this rate before going to the next rate
455 *
456 * A value of -1 for @idx indicates an invalid rate and, if used
457 * in an array of retry rates, that no more rates should be tried.
458 *
459 * When used for transmit status reporting, the driver should
460 * always report the rate along with the flags it used.
461 *
462 * &struct ieee80211_tx_info contains an array of these structs
463 * in the control information, and it will be filled by the rate
464 * control algorithm according to what should be sent. For example,
465 * if this array contains, in the format { <idx>, <count> } the
466 * information
467 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
468 * then this means that the frame should be transmitted
469 * up to twice at rate 3, up to twice at rate 2, and up to four
470 * times at rate 1 if it doesn't get acknowledged. Say it gets
471 * acknowledged by the peer after the fifth attempt, the status
472 * information should then contain
473 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
474 * since it was transmitted twice at rate 3, twice at rate 2
475 * and once at rate 1 after which we received an acknowledgement.
476 */
477struct ieee80211_tx_rate {
478 s8 idx;
479 u8 count;
480 u8 flags;
481} __packed;
482
483/**
484 * struct ieee80211_tx_info - skb transmit information
485 *
486 * This structure is placed in skb->cb for three uses:
487 * (1) mac80211 TX control - mac80211 tells the driver what to do
488 * (2) driver internal use (if applicable)
489 * (3) TX status information - driver tells mac80211 what happened
490 *
491 * The TX control's sta pointer is only valid during the ->tx call,
492 * it may be NULL.
493 *
494 * @flags: transmit info flags, defined above
495 * @band: the band to transmit on (use for checking for races)
496 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
497 * @pad: padding, ignore
498 * @control: union for control data
499 * @status: union for status data
500 * @driver_data: array of driver_data pointers
501 * @ampdu_ack_len: number of acked aggregated frames.
502 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
503 * @ampdu_len: number of aggregated frames.
504 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
505 * @ack_signal: signal strength of the ACK frame
506 */
507struct ieee80211_tx_info {
508 /* common information */
509 u32 flags;
510 u8 band;
511
512 u8 antenna_sel_tx;
513
514 /* 2 byte hole */
515 u8 pad[2];
516
517 union {
518 struct {
519 union {
520 /* rate control */
521 struct {
522 struct ieee80211_tx_rate rates[
523 IEEE80211_TX_MAX_RATES];
524 s8 rts_cts_rate_idx;
525 };
526 /* only needed before rate control */
527 unsigned long jiffies;
528 };
529 /* NB: vif can be NULL for injected frames */
530 struct ieee80211_vif *vif;
531 struct ieee80211_key_conf *hw_key;
532 struct ieee80211_sta *sta;
533 } control;
534 struct {
535 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
536 u8 ampdu_ack_len;
537 int ack_signal;
538 u8 ampdu_len;
539 /* 15 bytes free */
540 } status;
541 struct {
542 struct ieee80211_tx_rate driver_rates[
543 IEEE80211_TX_MAX_RATES];
544 void *rate_driver_data[
545 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
546 };
547 void *driver_data[
548 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
549 };
550};
551
552/**
553 * struct ieee80211_sched_scan_ies - scheduled scan IEs
554 *
555 * This structure is used to pass the appropriate IEs to be used in scheduled
556 * scans for all bands. It contains both the IEs passed from the userspace
557 * and the ones generated by mac80211.
558 *
559 * @ie: array with the IEs for each supported band
560 * @len: array with the total length of the IEs for each band
561 */
562struct ieee80211_sched_scan_ies {
563 u8 *ie[IEEE80211_NUM_BANDS];
564 size_t len[IEEE80211_NUM_BANDS];
565};
566
567static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
568{
569 return (struct ieee80211_tx_info *)skb->cb;
570}
571
572static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
573{
574 return (struct ieee80211_rx_status *)skb->cb;
575}
576
577/**
578 * ieee80211_tx_info_clear_status - clear TX status
579 *
580 * @info: The &struct ieee80211_tx_info to be cleared.
581 *
582 * When the driver passes an skb back to mac80211, it must report
583 * a number of things in TX status. This function clears everything
584 * in the TX status but the rate control information (it does clear
585 * the count since you need to fill that in anyway).
586 *
587 * NOTE: You can only use this function if you do NOT use
588 * info->driver_data! Use info->rate_driver_data
589 * instead if you need only the less space that allows.
590 */
591static inline void
592ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
593{
594 int i;
595
596 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
597 offsetof(struct ieee80211_tx_info, control.rates));
598 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
599 offsetof(struct ieee80211_tx_info, driver_rates));
600 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
601 /* clear the rate counts */
602 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
603 info->status.rates[i].count = 0;
604
605 BUILD_BUG_ON(
606 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
607 memset(&info->status.ampdu_ack_len, 0,
608 sizeof(struct ieee80211_tx_info) -
609 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
610}
611
612
613/**
614 * enum mac80211_rx_flags - receive flags
615 *
616 * These flags are used with the @flag member of &struct ieee80211_rx_status.
617 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
618 * Use together with %RX_FLAG_MMIC_STRIPPED.
619 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
620 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
621 * verification has been done by the hardware.
622 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
623 * If this flag is set, the stack cannot do any replay detection
624 * hence the driver or hardware will have to do that.
625 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
626 * the frame.
627 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
628 * the frame.
629 * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
630 * field) is valid and contains the time the first symbol of the MPDU
631 * was received. This is useful in monitor mode and for proper IBSS
632 * merging.
633 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
634 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
635 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
636 * @RX_FLAG_SHORT_GI: Short guard interval was used
637 */
638enum mac80211_rx_flags {
639 RX_FLAG_MMIC_ERROR = 1<<0,
640 RX_FLAG_DECRYPTED = 1<<1,
641 RX_FLAG_MMIC_STRIPPED = 1<<3,
642 RX_FLAG_IV_STRIPPED = 1<<4,
643 RX_FLAG_FAILED_FCS_CRC = 1<<5,
644 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
645 RX_FLAG_MACTIME_MPDU = 1<<7,
646 RX_FLAG_SHORTPRE = 1<<8,
647 RX_FLAG_HT = 1<<9,
648 RX_FLAG_40MHZ = 1<<10,
649 RX_FLAG_SHORT_GI = 1<<11,
650};
651
652/**
653 * struct ieee80211_rx_status - receive status
654 *
655 * The low-level driver should provide this information (the subset
656 * supported by hardware) to the 802.11 code with each received
657 * frame, in the skb's control buffer (cb).
658 *
659 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
660 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
661 * @band: the active band when this frame was received
662 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
663 * @signal: signal strength when receiving this frame, either in dBm, in dB or
664 * unspecified depending on the hardware capabilities flags
665 * @IEEE80211_HW_SIGNAL_*
666 * @antenna: antenna used
667 * @rate_idx: index of data rate into band's supported rates or MCS index if
668 * HT rates are use (RX_FLAG_HT)
669 * @flag: %RX_FLAG_*
670 * @rx_flags: internal RX flags for mac80211
671 */
672struct ieee80211_rx_status {
673 u64 mactime;
674 enum ieee80211_band band;
675 int freq;
676 int signal;
677 int antenna;
678 int rate_idx;
679 int flag;
680 unsigned int rx_flags;
681};
682
683/**
684 * enum ieee80211_conf_flags - configuration flags
685 *
686 * Flags to define PHY configuration options
687 *
688 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
689 * to determine for example whether to calculate timestamps for packets
690 * or not, do not use instead of filter flags!
691 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
692 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
693 * meaning that the hardware still wakes up for beacons, is able to
694 * transmit frames and receive the possible acknowledgment frames.
695 * Not to be confused with hardware specific wakeup/sleep states,
696 * driver is responsible for that. See the section "Powersave support"
697 * for more.
698 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
699 * the driver should be prepared to handle configuration requests but
700 * may turn the device off as much as possible. Typically, this flag will
701 * be set when an interface is set UP but not associated or scanning, but
702 * it can also be unset in that case when monitor interfaces are active.
703 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
704 * operating channel.
705 */
706enum ieee80211_conf_flags {
707 IEEE80211_CONF_MONITOR = (1<<0),
708 IEEE80211_CONF_PS = (1<<1),
709 IEEE80211_CONF_IDLE = (1<<2),
710 IEEE80211_CONF_OFFCHANNEL = (1<<3),
711};
712
713
714/**
715 * enum ieee80211_conf_changed - denotes which configuration changed
716 *
717 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
718 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
719 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
720 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
721 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
722 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
723 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
724 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
725 */
726enum ieee80211_conf_changed {
727 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
728 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
729 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
730 IEEE80211_CONF_CHANGE_PS = BIT(4),
731 IEEE80211_CONF_CHANGE_POWER = BIT(5),
732 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
733 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
734 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
735};
736
737/**
738 * enum ieee80211_smps_mode - spatial multiplexing power save mode
739 *
740 * @IEEE80211_SMPS_AUTOMATIC: automatic
741 * @IEEE80211_SMPS_OFF: off
742 * @IEEE80211_SMPS_STATIC: static
743 * @IEEE80211_SMPS_DYNAMIC: dynamic
744 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
745 */
746enum ieee80211_smps_mode {
747 IEEE80211_SMPS_AUTOMATIC,
748 IEEE80211_SMPS_OFF,
749 IEEE80211_SMPS_STATIC,
750 IEEE80211_SMPS_DYNAMIC,
751
752 /* keep last */
753 IEEE80211_SMPS_NUM_MODES,
754};
755
756/**
757 * struct ieee80211_conf - configuration of the device
758 *
759 * This struct indicates how the driver shall configure the hardware.
760 *
761 * @flags: configuration flags defined above
762 *
763 * @listen_interval: listen interval in units of beacon interval
764 * @max_sleep_period: the maximum number of beacon intervals to sleep for
765 * before checking the beacon for a TIM bit (managed mode only); this
766 * value will be only achievable between DTIM frames, the hardware
767 * needs to check for the multicast traffic bit in DTIM beacons.
768 * This variable is valid only when the CONF_PS flag is set.
769 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
770 * in power saving. Power saving will not be enabled until a beacon
771 * has been received and the DTIM period is known.
772 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
773 * powersave documentation below. This variable is valid only when
774 * the CONF_PS flag is set.
775 *
776 * @power_level: requested transmit power (in dBm)
777 *
778 * @channel: the channel to tune to
779 * @channel_type: the channel (HT) type
780 *
781 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
782 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
783 * but actually means the number of transmissions not the number of retries
784 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
785 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
786 * number of transmissions not the number of retries
787 *
788 * @smps_mode: spatial multiplexing powersave mode; note that
789 * %IEEE80211_SMPS_STATIC is used when the device is not
790 * configured for an HT channel
791 */
792struct ieee80211_conf {
793 u32 flags;
794 int power_level, dynamic_ps_timeout;
795 int max_sleep_period;
796
797 u16 listen_interval;
798 u8 ps_dtim_period;
799
800 u8 long_frame_max_tx_count, short_frame_max_tx_count;
801
802 struct ieee80211_channel *channel;
803 enum nl80211_channel_type channel_type;
804 enum ieee80211_smps_mode smps_mode;
805};
806
807/**
808 * struct ieee80211_channel_switch - holds the channel switch data
809 *
810 * The information provided in this structure is required for channel switch
811 * operation.
812 *
813 * @timestamp: value in microseconds of the 64-bit Time Synchronization
814 * Function (TSF) timer when the frame containing the channel switch
815 * announcement was received. This is simply the rx.mactime parameter
816 * the driver passed into mac80211.
817 * @block_tx: Indicates whether transmission must be blocked before the
818 * scheduled channel switch, as indicated by the AP.
819 * @channel: the new channel to switch to
820 * @count: the number of TBTT's until the channel switch event
821 */
822struct ieee80211_channel_switch {
823 u64 timestamp;
824 bool block_tx;
825 struct ieee80211_channel *channel;
826 u8 count;
827};
828
829/**
830 * struct ieee80211_vif - per-interface data
831 *
832 * Data in this structure is continually present for driver
833 * use during the life of a virtual interface.
834 *
835 * @type: type of this virtual interface
836 * @bss_conf: BSS configuration for this interface, either our own
837 * or the BSS we're associated to
838 * @addr: address of this interface
839 * @p2p: indicates whether this AP or STA interface is a p2p
840 * interface, i.e. a GO or p2p-sta respectively
841 * @drv_priv: data area for driver use, will always be aligned to
842 * sizeof(void *).
843 */
844struct ieee80211_vif {
845 enum nl80211_iftype type;
846 struct ieee80211_bss_conf bss_conf;
847 u8 addr[ETH_ALEN];
848 bool p2p;
849 /* must be last */
850 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
851};
852
853static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
854{
855#ifdef CONFIG_MAC80211_MESH
856 return vif->type == NL80211_IFTYPE_MESH_POINT;
857#endif
858 return false;
859}
860
861/**
862 * enum ieee80211_key_flags - key flags
863 *
864 * These flags are used for communication about keys between the driver
865 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
866 *
867 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
868 * that the STA this key will be used with could be using QoS.
869 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
870 * driver to indicate that it requires IV generation for this
871 * particular key.
872 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
873 * the driver for a TKIP key if it requires Michael MIC
874 * generation in software.
875 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
876 * that the key is pairwise rather then a shared key.
877 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
878 * CCMP key if it requires CCMP encryption of management frames (MFP) to
879 * be done in software.
880 */
881enum ieee80211_key_flags {
882 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
883 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
884 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
885 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
886 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
887};
888
889/**
890 * struct ieee80211_key_conf - key information
891 *
892 * This key information is given by mac80211 to the driver by
893 * the set_key() callback in &struct ieee80211_ops.
894 *
895 * @hw_key_idx: To be set by the driver, this is the key index the driver
896 * wants to be given when a frame is transmitted and needs to be
897 * encrypted in hardware.
898 * @cipher: The key's cipher suite selector.
899 * @flags: key flags, see &enum ieee80211_key_flags.
900 * @keyidx: the key index (0-3)
901 * @keylen: key material length
902 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
903 * data block:
904 * - Temporal Encryption Key (128 bits)
905 * - Temporal Authenticator Tx MIC Key (64 bits)
906 * - Temporal Authenticator Rx MIC Key (64 bits)
907 * @icv_len: The ICV length for this key type
908 * @iv_len: The IV length for this key type
909 */
910struct ieee80211_key_conf {
911 u32 cipher;
912 u8 icv_len;
913 u8 iv_len;
914 u8 hw_key_idx;
915 u8 flags;
916 s8 keyidx;
917 u8 keylen;
918 u8 key[0];
919};
920
921/**
922 * enum set_key_cmd - key command
923 *
924 * Used with the set_key() callback in &struct ieee80211_ops, this
925 * indicates whether a key is being removed or added.
926 *
927 * @SET_KEY: a key is set
928 * @DISABLE_KEY: a key must be disabled
929 */
930enum set_key_cmd {
931 SET_KEY, DISABLE_KEY,
932};
933
934/**
935 * struct ieee80211_sta - station table entry
936 *
937 * A station table entry represents a station we are possibly
938 * communicating with. Since stations are RCU-managed in
939 * mac80211, any ieee80211_sta pointer you get access to must
940 * either be protected by rcu_read_lock() explicitly or implicitly,
941 * or you must take good care to not use such a pointer after a
942 * call to your sta_remove callback that removed it.
943 *
944 * @addr: MAC address
945 * @aid: AID we assigned to the station if we're an AP
946 * @supp_rates: Bitmap of supported rates (per band)
947 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
948 * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
949 * @drv_priv: data area for driver use, will always be aligned to
950 * sizeof(void *), size is determined in hw information.
951 */
952struct ieee80211_sta {
953 u32 supp_rates[IEEE80211_NUM_BANDS];
954 u8 addr[ETH_ALEN];
955 u16 aid;
956 struct ieee80211_sta_ht_cap ht_cap;
957 bool wme;
958
959 /* must be last */
960 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
961};
962
963/**
964 * enum sta_notify_cmd - sta notify command
965 *
966 * Used with the sta_notify() callback in &struct ieee80211_ops, this
967 * indicates if an associated station made a power state transition.
968 *
969 * @STA_NOTIFY_SLEEP: a station is now sleeping
970 * @STA_NOTIFY_AWAKE: a sleeping station woke up
971 */
972enum sta_notify_cmd {
973 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
974};
975
976/**
977 * enum ieee80211_hw_flags - hardware flags
978 *
979 * These flags are used to indicate hardware capabilities to
980 * the stack. Generally, flags here should have their meaning
981 * done in a way that the simplest hardware doesn't need setting
982 * any particular flags. There are some exceptions to this rule,
983 * however, so you are advised to review these flags carefully.
984 *
985 * @IEEE80211_HW_HAS_RATE_CONTROL:
986 * The hardware or firmware includes rate control, and cannot be
987 * controlled by the stack. As such, no rate control algorithm
988 * should be instantiated, and the TX rate reported to userspace
989 * will be taken from the TX status instead of the rate control
990 * algorithm.
991 * Note that this requires that the driver implement a number of
992 * callbacks so it has the correct information, it needs to have
993 * the @set_rts_threshold callback and must look at the BSS config
994 * @use_cts_prot for G/N protection, @use_short_slot for slot
995 * timing in 2.4 GHz and @use_short_preamble for preambles for
996 * CCK frames.
997 *
998 * @IEEE80211_HW_RX_INCLUDES_FCS:
999 * Indicates that received frames passed to the stack include
1000 * the FCS at the end.
1001 *
1002 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1003 * Some wireless LAN chipsets buffer broadcast/multicast frames
1004 * for power saving stations in the hardware/firmware and others
1005 * rely on the host system for such buffering. This option is used
1006 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1007 * multicast frames when there are power saving stations so that
1008 * the driver can fetch them with ieee80211_get_buffered_bc().
1009 *
1010 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1011 * Hardware is not capable of short slot operation on the 2.4 GHz band.
1012 *
1013 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1014 * Hardware is not capable of receiving frames with short preamble on
1015 * the 2.4 GHz band.
1016 *
1017 * @IEEE80211_HW_SIGNAL_UNSPEC:
1018 * Hardware can provide signal values but we don't know its units. We
1019 * expect values between 0 and @max_signal.
1020 * If possible please provide dB or dBm instead.
1021 *
1022 * @IEEE80211_HW_SIGNAL_DBM:
1023 * Hardware gives signal values in dBm, decibel difference from
1024 * one milliwatt. This is the preferred method since it is standardized
1025 * between different devices. @max_signal does not need to be set.
1026 *
1027 * @IEEE80211_HW_SPECTRUM_MGMT:
1028 * Hardware supports spectrum management defined in 802.11h
1029 * Measurement, Channel Switch, Quieting, TPC
1030 *
1031 * @IEEE80211_HW_AMPDU_AGGREGATION:
1032 * Hardware supports 11n A-MPDU aggregation.
1033 *
1034 * @IEEE80211_HW_SUPPORTS_PS:
1035 * Hardware has power save support (i.e. can go to sleep).
1036 *
1037 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1038 * Hardware requires nullfunc frame handling in stack, implies
1039 * stack support for dynamic PS.
1040 *
1041 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1042 * Hardware has support for dynamic PS.
1043 *
1044 * @IEEE80211_HW_MFP_CAPABLE:
1045 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1046 *
1047 * @IEEE80211_HW_BEACON_FILTER:
1048 * Hardware supports dropping of irrelevant beacon frames to
1049 * avoid waking up cpu.
1050 *
1051 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1052 * Hardware supports static spatial multiplexing powersave,
1053 * ie. can turn off all but one chain even on HT connections
1054 * that should be using more chains.
1055 *
1056 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1057 * Hardware supports dynamic spatial multiplexing powersave,
1058 * ie. can turn off all but one chain and then wake the rest
1059 * up as required after, for example, rts/cts handshake.
1060 *
1061 * @IEEE80211_HW_SUPPORTS_UAPSD:
1062 * Hardware supports Unscheduled Automatic Power Save Delivery
1063 * (U-APSD) in managed mode. The mode is configured with
1064 * conf_tx() operation.
1065 *
1066 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1067 * Hardware can provide ack status reports of Tx frames to
1068 * the stack.
1069 *
1070 * @IEEE80211_HW_CONNECTION_MONITOR:
1071 * The hardware performs its own connection monitoring, including
1072 * periodic keep-alives to the AP and probing the AP on beacon loss.
1073 * When this flag is set, signaling beacon-loss will cause an immediate
1074 * change to disassociated state.
1075 *
1076 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1077 * Hardware can do connection quality monitoring - i.e. it can monitor
1078 * connection quality related parameters, such as the RSSI level and
1079 * provide notifications if configured trigger levels are reached.
1080 *
1081 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1082 * This device needs to know the DTIM period for the BSS before
1083 * associating.
1084 *
1085 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1086 * per-station GTKs as used by IBSS RSN or during fast transition. If
1087 * the device doesn't support per-station GTKs, but can be asked not
1088 * to decrypt group addressed frames, then IBSS RSN support is still
1089 * possible but software crypto will be used. Advertise the wiphy flag
1090 * only in that case.
1091 *
1092 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1093 * autonomously manages the PS status of connected stations. When
1094 * this flag is set mac80211 will not trigger PS mode for connected
1095 * stations based on the PM bit of incoming frames.
1096 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1097 * the PS mode of connected stations.
1098 */
1099enum ieee80211_hw_flags {
1100 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1101 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1102 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1103 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1104 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1105 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1106 IEEE80211_HW_SIGNAL_DBM = 1<<6,
1107 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
1108 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1109 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1110 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1111 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1112 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1113 IEEE80211_HW_MFP_CAPABLE = 1<<13,
1114 IEEE80211_HW_BEACON_FILTER = 1<<14,
1115 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1116 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1117 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1118 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1119 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1120 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
1121 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1122 IEEE80211_HW_AP_LINK_PS = 1<<22,
1123};
1124
1125/**
1126 * struct ieee80211_hw - hardware information and state
1127 *
1128 * This structure contains the configuration and hardware
1129 * information for an 802.11 PHY.
1130 *
1131 * @wiphy: This points to the &struct wiphy allocated for this
1132 * 802.11 PHY. You must fill in the @perm_addr and @dev
1133 * members of this structure using SET_IEEE80211_DEV()
1134 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1135 * bands (with channels, bitrates) are registered here.
1136 *
1137 * @conf: &struct ieee80211_conf, device configuration, don't use.
1138 *
1139 * @priv: pointer to private area that was allocated for driver use
1140 * along with this structure.
1141 *
1142 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1143 *
1144 * @extra_tx_headroom: headroom to reserve in each transmit skb
1145 * for use by the driver (e.g. for transmit headers.)
1146 *
1147 * @channel_change_time: time (in microseconds) it takes to change channels.
1148 *
1149 * @max_signal: Maximum value for signal (rssi) in RX information, used
1150 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1151 *
1152 * @max_listen_interval: max listen interval in units of beacon interval
1153 * that HW supports
1154 *
1155 * @queues: number of available hardware transmit queues for
1156 * data packets. WMM/QoS requires at least four, these
1157 * queues need to have configurable access parameters.
1158 *
1159 * @rate_control_algorithm: rate control algorithm for this hardware.
1160 * If unset (NULL), the default algorithm will be used. Must be
1161 * set before calling ieee80211_register_hw().
1162 *
1163 * @vif_data_size: size (in bytes) of the drv_priv data area
1164 * within &struct ieee80211_vif.
1165 * @sta_data_size: size (in bytes) of the drv_priv data area
1166 * within &struct ieee80211_sta.
1167 *
1168 * @max_rates: maximum number of alternate rate retry stages the hw
1169 * can handle.
1170 * @max_report_rates: maximum number of alternate rate retry stages
1171 * the hw can report back.
1172 * @max_rate_tries: maximum number of tries for each stage
1173 *
1174 * @napi_weight: weight used for NAPI polling. You must specify an
1175 * appropriate value here if a napi_poll operation is provided
1176 * by your driver.
1177 *
1178 * @max_rx_aggregation_subframes: maximum buffer size (number of
1179 * sub-frames) to be used for A-MPDU block ack receiver
1180 * aggregation.
1181 * This is only relevant if the device has restrictions on the
1182 * number of subframes, if it relies on mac80211 to do reordering
1183 * it shouldn't be set.
1184 *
1185 * @max_tx_aggregation_subframes: maximum number of subframes in an
1186 * aggregate an HT driver will transmit, used by the peer as a
1187 * hint to size its reorder buffer.
1188 */
1189struct ieee80211_hw {
1190 struct ieee80211_conf conf;
1191 struct wiphy *wiphy;
1192 const char *rate_control_algorithm;
1193 void *priv;
1194 u32 flags;
1195 unsigned int extra_tx_headroom;
1196 int channel_change_time;
1197 int vif_data_size;
1198 int sta_data_size;
1199 int napi_weight;
1200 u16 queues;
1201 u16 max_listen_interval;
1202 s8 max_signal;
1203 u8 max_rates;
1204 u8 max_report_rates;
1205 u8 max_rate_tries;
1206 u8 max_rx_aggregation_subframes;
1207 u8 max_tx_aggregation_subframes;
1208};
1209
1210/**
1211 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1212 *
1213 * @wiphy: the &struct wiphy which we want to query
1214 *
1215 * mac80211 drivers can use this to get to their respective
1216 * &struct ieee80211_hw. Drivers wishing to get to their own private
1217 * structure can then access it via hw->priv. Note that mac802111 drivers should
1218 * not use wiphy_priv() to try to get their private driver structure as this
1219 * is already used internally by mac80211.
1220 */
1221struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1222
1223/**
1224 * SET_IEEE80211_DEV - set device for 802.11 hardware
1225 *
1226 * @hw: the &struct ieee80211_hw to set the device for
1227 * @dev: the &struct device of this 802.11 device
1228 */
1229static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1230{
1231 set_wiphy_dev(hw->wiphy, dev);
1232}
1233
1234/**
1235 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1236 *
1237 * @hw: the &struct ieee80211_hw to set the MAC address for
1238 * @addr: the address to set
1239 */
1240static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1241{
1242 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1243}
1244
1245static inline struct ieee80211_rate *
1246ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1247 const struct ieee80211_tx_info *c)
1248{
1249 if (WARN_ON(c->control.rates[0].idx < 0))
1250 return NULL;
1251 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1252}
1253
1254static inline struct ieee80211_rate *
1255ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1256 const struct ieee80211_tx_info *c)
1257{
1258 if (c->control.rts_cts_rate_idx < 0)
1259 return NULL;
1260 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1261}
1262
1263static inline struct ieee80211_rate *
1264ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1265 const struct ieee80211_tx_info *c, int idx)
1266{
1267 if (c->control.rates[idx + 1].idx < 0)
1268 return NULL;
1269 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1270}
1271
1272/**
1273 * DOC: Hardware crypto acceleration
1274 *
1275 * mac80211 is capable of taking advantage of many hardware
1276 * acceleration designs for encryption and decryption operations.
1277 *
1278 * The set_key() callback in the &struct ieee80211_ops for a given
1279 * device is called to enable hardware acceleration of encryption and
1280 * decryption. The callback takes a @sta parameter that will be NULL
1281 * for default keys or keys used for transmission only, or point to
1282 * the station information for the peer for individual keys.
1283 * Multiple transmission keys with the same key index may be used when
1284 * VLANs are configured for an access point.
1285 *
1286 * When transmitting, the TX control data will use the @hw_key_idx
1287 * selected by the driver by modifying the &struct ieee80211_key_conf
1288 * pointed to by the @key parameter to the set_key() function.
1289 *
1290 * The set_key() call for the %SET_KEY command should return 0 if
1291 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1292 * added; if you return 0 then hw_key_idx must be assigned to the
1293 * hardware key index, you are free to use the full u8 range.
1294 *
1295 * When the cmd is %DISABLE_KEY then it must succeed.
1296 *
1297 * Note that it is permissible to not decrypt a frame even if a key
1298 * for it has been uploaded to hardware, the stack will not make any
1299 * decision based on whether a key has been uploaded or not but rather
1300 * based on the receive flags.
1301 *
1302 * The &struct ieee80211_key_conf structure pointed to by the @key
1303 * parameter is guaranteed to be valid until another call to set_key()
1304 * removes it, but it can only be used as a cookie to differentiate
1305 * keys.
1306 *
1307 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1308 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1309 * handler.
1310 * The update_tkip_key() call updates the driver with the new phase 1 key.
1311 * This happens every time the iv16 wraps around (every 65536 packets). The
1312 * set_key() call will happen only once for each key (unless the AP did
1313 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1314 * provided by update_tkip_key only. The trigger that makes mac80211 call this
1315 * handler is software decryption with wrap around of iv16.
1316 */
1317
1318/**
1319 * DOC: Powersave support
1320 *
1321 * mac80211 has support for various powersave implementations.
1322 *
1323 * First, it can support hardware that handles all powersaving by itself,
1324 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1325 * flag. In that case, it will be told about the desired powersave mode
1326 * with the %IEEE80211_CONF_PS flag depending on the association status.
1327 * The hardware must take care of sending nullfunc frames when necessary,
1328 * i.e. when entering and leaving powersave mode. The hardware is required
1329 * to look at the AID in beacons and signal to the AP that it woke up when
1330 * it finds traffic directed to it.
1331 *
1332 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1333 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1334 * with hardware wakeup and sleep states. Driver is responsible for waking
1335 * up the hardware before issuing commands to the hardware and putting it
1336 * back to sleep at appropriate times.
1337 *
1338 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1339 * buffered multicast/broadcast frames after the beacon. Also it must be
1340 * possible to send frames and receive the acknowledment frame.
1341 *
1342 * Other hardware designs cannot send nullfunc frames by themselves and also
1343 * need software support for parsing the TIM bitmap. This is also supported
1344 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1345 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1346 * required to pass up beacons. The hardware is still required to handle
1347 * waking up for multicast traffic; if it cannot the driver must handle that
1348 * as best as it can, mac80211 is too slow to do that.
1349 *
1350 * Dynamic powersave is an extension to normal powersave in which the
1351 * hardware stays awake for a user-specified period of time after sending a
1352 * frame so that reply frames need not be buffered and therefore delayed to
1353 * the next wakeup. It's compromise of getting good enough latency when
1354 * there's data traffic and still saving significantly power in idle
1355 * periods.
1356 *
1357 * Dynamic powersave is simply supported by mac80211 enabling and disabling
1358 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1359 * flag and mac80211 will handle everything automatically. Additionally,
1360 * hardware having support for the dynamic PS feature may set the
1361 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1362 * dynamic PS mode itself. The driver needs to look at the
1363 * @dynamic_ps_timeout hardware configuration value and use it that value
1364 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1365 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1366 * enabled whenever user has enabled powersave.
1367 *
1368 * Some hardware need to toggle a single shared antenna between WLAN and
1369 * Bluetooth to facilitate co-existence. These types of hardware set
1370 * limitations on the use of host controlled dynamic powersave whenever there
1371 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1372 * driver may request temporarily going into full power save, in order to
1373 * enable toggling the antenna between BT and WLAN. If the driver requests
1374 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1375 * temporarily set to zero until the driver re-enables dynamic powersave.
1376 *
1377 * Driver informs U-APSD client support by enabling
1378 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1379 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1380 * Nullfunc frames and stay awake until the service period has ended. To
1381 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1382 * from that AC are transmitted with powersave enabled.
1383 *
1384 * Note: U-APSD client mode is not yet supported with
1385 * %IEEE80211_HW_PS_NULLFUNC_STACK.
1386 */
1387
1388/**
1389 * DOC: Beacon filter support
1390 *
1391 * Some hardware have beacon filter support to reduce host cpu wakeups
1392 * which will reduce system power consumption. It usuallly works so that
1393 * the firmware creates a checksum of the beacon but omits all constantly
1394 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1395 * beacon is forwarded to the host, otherwise it will be just dropped. That
1396 * way the host will only receive beacons where some relevant information
1397 * (for example ERP protection or WMM settings) have changed.
1398 *
1399 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1400 * hardware capability. The driver needs to enable beacon filter support
1401 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1402 * power save is enabled, the stack will not check for beacon loss and the
1403 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1404 *
1405 * The time (or number of beacons missed) until the firmware notifies the
1406 * driver of a beacon loss event (which in turn causes the driver to call
1407 * ieee80211_beacon_loss()) should be configurable and will be controlled
1408 * by mac80211 and the roaming algorithm in the future.
1409 *
1410 * Since there may be constantly changing information elements that nothing
1411 * in the software stack cares about, we will, in the future, have mac80211
1412 * tell the driver which information elements are interesting in the sense
1413 * that we want to see changes in them. This will include
1414 * - a list of information element IDs
1415 * - a list of OUIs for the vendor information element
1416 *
1417 * Ideally, the hardware would filter out any beacons without changes in the
1418 * requested elements, but if it cannot support that it may, at the expense
1419 * of some efficiency, filter out only a subset. For example, if the device
1420 * doesn't support checking for OUIs it should pass up all changes in all
1421 * vendor information elements.
1422 *
1423 * Note that change, for the sake of simplification, also includes information
1424 * elements appearing or disappearing from the beacon.
1425 *
1426 * Some hardware supports an "ignore list" instead, just make sure nothing
1427 * that was requested is on the ignore list, and include commonly changing
1428 * information element IDs in the ignore list, for example 11 (BSS load) and
1429 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1430 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1431 * it could also include some currently unused IDs.
1432 *
1433 *
1434 * In addition to these capabilities, hardware should support notifying the
1435 * host of changes in the beacon RSSI. This is relevant to implement roaming
1436 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1437 * the received data packets). This can consist in notifying the host when
1438 * the RSSI changes significantly or when it drops below or rises above
1439 * configurable thresholds. In the future these thresholds will also be
1440 * configured by mac80211 (which gets them from userspace) to implement
1441 * them as the roaming algorithm requires.
1442 *
1443 * If the hardware cannot implement this, the driver should ask it to
1444 * periodically pass beacon frames to the host so that software can do the
1445 * signal strength threshold checking.
1446 */
1447
1448/**
1449 * DOC: Spatial multiplexing power save
1450 *
1451 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1452 * power in an 802.11n implementation. For details on the mechanism
1453 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1454 * "11.2.3 SM power save".
1455 *
1456 * The mac80211 implementation is capable of sending action frames
1457 * to update the AP about the station's SMPS mode, and will instruct
1458 * the driver to enter the specific mode. It will also announce the
1459 * requested SMPS mode during the association handshake. Hardware
1460 * support for this feature is required, and can be indicated by
1461 * hardware flags.
1462 *
1463 * The default mode will be "automatic", which nl80211/cfg80211
1464 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1465 * turned off otherwise.
1466 *
1467 * To support this feature, the driver must set the appropriate
1468 * hardware support flags, and handle the SMPS flag to the config()
1469 * operation. It will then with this mechanism be instructed to
1470 * enter the requested SMPS mode while associated to an HT AP.
1471 */
1472
1473/**
1474 * DOC: Frame filtering
1475 *
1476 * mac80211 requires to see many management frames for proper
1477 * operation, and users may want to see many more frames when
1478 * in monitor mode. However, for best CPU usage and power consumption,
1479 * having as few frames as possible percolate through the stack is
1480 * desirable. Hence, the hardware should filter as much as possible.
1481 *
1482 * To achieve this, mac80211 uses filter flags (see below) to tell
1483 * the driver's configure_filter() function which frames should be
1484 * passed to mac80211 and which should be filtered out.
1485 *
1486 * Before configure_filter() is invoked, the prepare_multicast()
1487 * callback is invoked with the parameters @mc_count and @mc_list
1488 * for the combined multicast address list of all virtual interfaces.
1489 * It's use is optional, and it returns a u64 that is passed to
1490 * configure_filter(). Additionally, configure_filter() has the
1491 * arguments @changed_flags telling which flags were changed and
1492 * @total_flags with the new flag states.
1493 *
1494 * If your device has no multicast address filters your driver will
1495 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1496 * parameter to see whether multicast frames should be accepted
1497 * or dropped.
1498 *
1499 * All unsupported flags in @total_flags must be cleared.
1500 * Hardware does not support a flag if it is incapable of _passing_
1501 * the frame to the stack. Otherwise the driver must ignore
1502 * the flag, but not clear it.
1503 * You must _only_ clear the flag (announce no support for the
1504 * flag to mac80211) if you are not able to pass the packet type
1505 * to the stack (so the hardware always filters it).
1506 * So for example, you should clear @FIF_CONTROL, if your hardware
1507 * always filters control frames. If your hardware always passes
1508 * control frames to the kernel and is incapable of filtering them,
1509 * you do _not_ clear the @FIF_CONTROL flag.
1510 * This rule applies to all other FIF flags as well.
1511 */
1512
1513/**
1514 * enum ieee80211_filter_flags - hardware filter flags
1515 *
1516 * These flags determine what the filter in hardware should be
1517 * programmed to let through and what should not be passed to the
1518 * stack. It is always safe to pass more frames than requested,
1519 * but this has negative impact on power consumption.
1520 *
1521 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1522 * think of the BSS as your network segment and then this corresponds
1523 * to the regular ethernet device promiscuous mode.
1524 *
1525 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1526 * by the user or if the hardware is not capable of filtering by
1527 * multicast address.
1528 *
1529 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1530 * %RX_FLAG_FAILED_FCS_CRC for them)
1531 *
1532 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1533 * the %RX_FLAG_FAILED_PLCP_CRC for them
1534 *
1535 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1536 * to the hardware that it should not filter beacons or probe responses
1537 * by BSSID. Filtering them can greatly reduce the amount of processing
1538 * mac80211 needs to do and the amount of CPU wakeups, so you should
1539 * honour this flag if possible.
1540 *
1541 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1542 * is not set then only those addressed to this station.
1543 *
1544 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1545 *
1546 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1547 * those addressed to this station.
1548 *
1549 * @FIF_PROBE_REQ: pass probe request frames
1550 */
1551enum ieee80211_filter_flags {
1552 FIF_PROMISC_IN_BSS = 1<<0,
1553 FIF_ALLMULTI = 1<<1,
1554 FIF_FCSFAIL = 1<<2,
1555 FIF_PLCPFAIL = 1<<3,
1556 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1557 FIF_CONTROL = 1<<5,
1558 FIF_OTHER_BSS = 1<<6,
1559 FIF_PSPOLL = 1<<7,
1560 FIF_PROBE_REQ = 1<<8,
1561};
1562
1563/**
1564 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1565 *
1566 * These flags are used with the ampdu_action() callback in
1567 * &struct ieee80211_ops to indicate which action is needed.
1568 *
1569 * Note that drivers MUST be able to deal with a TX aggregation
1570 * session being stopped even before they OK'ed starting it by
1571 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1572 * might receive the addBA frame and send a delBA right away!
1573 *
1574 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1575 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1576 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1577 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1578 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1579 */
1580enum ieee80211_ampdu_mlme_action {
1581 IEEE80211_AMPDU_RX_START,
1582 IEEE80211_AMPDU_RX_STOP,
1583 IEEE80211_AMPDU_TX_START,
1584 IEEE80211_AMPDU_TX_STOP,
1585 IEEE80211_AMPDU_TX_OPERATIONAL,
1586};
1587
1588/**
1589 * enum ieee80211_tx_sync_type - TX sync type
1590 * @IEEE80211_TX_SYNC_AUTH: sync TX for authentication
1591 * (and possibly also before direct probe)
1592 * @IEEE80211_TX_SYNC_ASSOC: sync TX for association
1593 * @IEEE80211_TX_SYNC_ACTION: sync TX for action frame
1594 * (not implemented yet)
1595 */
1596enum ieee80211_tx_sync_type {
1597 IEEE80211_TX_SYNC_AUTH,
1598 IEEE80211_TX_SYNC_ASSOC,
1599 IEEE80211_TX_SYNC_ACTION,
1600};
1601
1602/**
1603 * struct ieee80211_ops - callbacks from mac80211 to the driver
1604 *
1605 * This structure contains various callbacks that the driver may
1606 * handle or, in some cases, must handle, for example to configure
1607 * the hardware to a new channel or to transmit a frame.
1608 *
1609 * @tx: Handler that 802.11 module calls for each transmitted frame.
1610 * skb contains the buffer starting from the IEEE 802.11 header.
1611 * The low-level driver should send the frame out based on
1612 * configuration in the TX control data. This handler should,
1613 * preferably, never fail and stop queues appropriately, more
1614 * importantly, however, it must never fail for A-MPDU-queues.
1615 * This function should return NETDEV_TX_OK except in very
1616 * limited cases.
1617 * Must be implemented and atomic.
1618 *
1619 * @start: Called before the first netdevice attached to the hardware
1620 * is enabled. This should turn on the hardware and must turn on
1621 * frame reception (for possibly enabled monitor interfaces.)
1622 * Returns negative error codes, these may be seen in userspace,
1623 * or zero.
1624 * When the device is started it should not have a MAC address
1625 * to avoid acknowledging frames before a non-monitor device
1626 * is added.
1627 * Must be implemented and can sleep.
1628 *
1629 * @stop: Called after last netdevice attached to the hardware
1630 * is disabled. This should turn off the hardware (at least
1631 * it must turn off frame reception.)
1632 * May be called right after add_interface if that rejects
1633 * an interface. If you added any work onto the mac80211 workqueue
1634 * you should ensure to cancel it on this callback.
1635 * Must be implemented and can sleep.
1636 *
1637 * @suspend: Suspend the device; mac80211 itself will quiesce before and
1638 * stop transmitting and doing any other configuration, and then
1639 * ask the device to suspend. This is only invoked when WoWLAN is
1640 * configured, otherwise the device is deconfigured completely and
1641 * reconfigured at resume time.
1642 * The driver may also impose special conditions under which it
1643 * wants to use the "normal" suspend (deconfigure), say if it only
1644 * supports WoWLAN when the device is associated. In this case, it
1645 * must return 1 from this function.
1646 *
1647 * @resume: If WoWLAN was configured, this indicates that mac80211 is
1648 * now resuming its operation, after this the device must be fully
1649 * functional again. If this returns an error, the only way out is
1650 * to also unregister the device. If it returns 1, then mac80211
1651 * will also go through the regular complete restart on resume.
1652 *
1653 * @add_interface: Called when a netdevice attached to the hardware is
1654 * enabled. Because it is not called for monitor mode devices, @start
1655 * and @stop must be implemented.
1656 * The driver should perform any initialization it needs before
1657 * the device can be enabled. The initial configuration for the
1658 * interface is given in the conf parameter.
1659 * The callback may refuse to add an interface by returning a
1660 * negative error code (which will be seen in userspace.)
1661 * Must be implemented and can sleep.
1662 *
1663 * @change_interface: Called when a netdevice changes type. This callback
1664 * is optional, but only if it is supported can interface types be
1665 * switched while the interface is UP. The callback may sleep.
1666 * Note that while an interface is being switched, it will not be
1667 * found by the interface iteration callbacks.
1668 *
1669 * @remove_interface: Notifies a driver that an interface is going down.
1670 * The @stop callback is called after this if it is the last interface
1671 * and no monitor interfaces are present.
1672 * When all interfaces are removed, the MAC address in the hardware
1673 * must be cleared so the device no longer acknowledges packets,
1674 * the mac_addr member of the conf structure is, however, set to the
1675 * MAC address of the device going away.
1676 * Hence, this callback must be implemented. It can sleep.
1677 *
1678 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1679 * function to change hardware configuration, e.g., channel.
1680 * This function should never fail but returns a negative error code
1681 * if it does. The callback can sleep.
1682 *
1683 * @bss_info_changed: Handler for configuration requests related to BSS
1684 * parameters that may vary during BSS's lifespan, and may affect low
1685 * level driver (e.g. assoc/disassoc status, erp parameters).
1686 * This function should not be used if no BSS has been set, unless
1687 * for association indication. The @changed parameter indicates which
1688 * of the bss parameters has changed when a call is made. The callback
1689 * can sleep.
1690 *
1691 * @tx_sync: Called before a frame is sent to an AP/GO. In the GO case, the
1692 * driver should sync with the GO's powersaving so the device doesn't
1693 * transmit the frame while the GO is asleep. In the regular AP case
1694 * it may be used by drivers for devices implementing other restrictions
1695 * on talking to APs, e.g. due to regulatory enforcement or just HW
1696 * restrictions.
1697 * This function is called for every authentication, association and
1698 * action frame separately since applications might attempt to auth
1699 * with multiple APs before chosing one to associate to. If it returns
1700 * an error, the corresponding authentication, association or frame
1701 * transmission is aborted and reported as having failed. It is always
1702 * called after tuning to the correct channel.
1703 * The callback might be called multiple times before @finish_tx_sync
1704 * (but @finish_tx_sync will be called once for each) but in practice
1705 * this is unlikely to happen. It can also refuse in that case if the
1706 * driver cannot handle that situation.
1707 * This callback can sleep.
1708 * @finish_tx_sync: Called as a counterpart to @tx_sync, unless that returned
1709 * an error. This callback can sleep.
1710 *
1711 * @prepare_multicast: Prepare for multicast filter configuration.
1712 * This callback is optional, and its return value is passed
1713 * to configure_filter(). This callback must be atomic.
1714 *
1715 * @configure_filter: Configure the device's RX filter.
1716 * See the section "Frame filtering" for more information.
1717 * This callback must be implemented and can sleep.
1718 *
1719 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1720 * must be set or cleared for a given STA. Must be atomic.
1721 *
1722 * @set_key: See the section "Hardware crypto acceleration"
1723 * This callback is only called between add_interface and
1724 * remove_interface calls, i.e. while the given virtual interface
1725 * is enabled.
1726 * Returns a negative error code if the key can't be added.
1727 * The callback can sleep.
1728 *
1729 * @update_tkip_key: See the section "Hardware crypto acceleration"
1730 * This callback will be called in the context of Rx. Called for drivers
1731 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1732 * The callback must be atomic.
1733 *
1734 * @set_rekey_data: If the device supports GTK rekeying, for example while the
1735 * host is suspended, it can assign this callback to retrieve the data
1736 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
1737 * After rekeying was done it should (for example during resume) notify
1738 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
1739 *
1740 * @hw_scan: Ask the hardware to service the scan request, no need to start
1741 * the scan state machine in stack. The scan must honour the channel
1742 * configuration done by the regulatory agent in the wiphy's
1743 * registered bands. The hardware (or the driver) needs to make sure
1744 * that power save is disabled.
1745 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1746 * entire IEs after the SSID, so that drivers need not look at these
1747 * at all but just send them after the SSID -- mac80211 includes the
1748 * (extended) supported rates and HT information (where applicable).
1749 * When the scan finishes, ieee80211_scan_completed() must be called;
1750 * note that it also must be called when the scan cannot finish due to
1751 * any error unless this callback returned a negative error code.
1752 * The callback can sleep.
1753 *
1754 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
1755 * The driver should ask the hardware to cancel the scan (if possible),
1756 * but the scan will be completed only after the driver will call
1757 * ieee80211_scan_completed().
1758 * This callback is needed for wowlan, to prevent enqueueing a new
1759 * scan_work after the low-level driver was already suspended.
1760 * The callback can sleep.
1761 *
1762 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
1763 * specific intervals. The driver must call the
1764 * ieee80211_sched_scan_results() function whenever it finds results.
1765 * This process will continue until sched_scan_stop is called.
1766 *
1767 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
1768 *
1769 * @sw_scan_start: Notifier function that is called just before a software scan
1770 * is started. Can be NULL, if the driver doesn't need this notification.
1771 * The callback can sleep.
1772 *
1773 * @sw_scan_complete: Notifier function that is called just after a
1774 * software scan finished. Can be NULL, if the driver doesn't need
1775 * this notification.
1776 * The callback can sleep.
1777 *
1778 * @get_stats: Return low-level statistics.
1779 * Returns zero if statistics are available.
1780 * The callback can sleep.
1781 *
1782 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1783 * callback should be provided to read the TKIP transmit IVs (both IV32
1784 * and IV16) for the given key from hardware.
1785 * The callback must be atomic.
1786 *
1787 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1788 * if the device does fragmentation by itself; if this callback is
1789 * implemented then the stack will not do fragmentation.
1790 * The callback can sleep.
1791 *
1792 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1793 * The callback can sleep.
1794 *
1795 * @sta_add: Notifies low level driver about addition of an associated station,
1796 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1797 *
1798 * @sta_remove: Notifies low level driver about removal of an associated
1799 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1800 *
1801 * @sta_notify: Notifies low level driver about power state transition of an
1802 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
1803 * in AP mode, this callback will not be called when the flag
1804 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
1805 *
1806 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1807 * bursting) for a hardware TX queue.
1808 * Returns a negative error code on failure.
1809 * The callback can sleep.
1810 *
1811 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1812 * this is only used for IBSS mode BSSID merging and debugging. Is not a
1813 * required function.
1814 * The callback can sleep.
1815 *
1816 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1817 * Currently, this is only used for IBSS mode debugging. Is not a
1818 * required function.
1819 * The callback can sleep.
1820 *
1821 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1822 * with other STAs in the IBSS. This is only used in IBSS mode. This
1823 * function is optional if the firmware/hardware takes full care of
1824 * TSF synchronization.
1825 * The callback can sleep.
1826 *
1827 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1828 * This is needed only for IBSS mode and the result of this function is
1829 * used to determine whether to reply to Probe Requests.
1830 * Returns non-zero if this device sent the last beacon.
1831 * The callback can sleep.
1832 *
1833 * @ampdu_action: Perform a certain A-MPDU action
1834 * The RA/TID combination determines the destination and TID we want
1835 * the ampdu action to be performed for. The action is defined through
1836 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1837 * is the first frame we expect to perform the action on. Notice
1838 * that TX/RX_STOP can pass NULL for this parameter.
1839 * The @buf_size parameter is only valid when the action is set to
1840 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
1841 * buffer size (number of subframes) for this session -- the driver
1842 * may neither send aggregates containing more subframes than this
1843 * nor send aggregates in a way that lost frames would exceed the
1844 * buffer size. If just limiting the aggregate size, this would be
1845 * possible with a buf_size of 8:
1846 * - TX: 1.....7
1847 * - RX: 2....7 (lost frame #1)
1848 * - TX: 8..1...
1849 * which is invalid since #1 was now re-transmitted well past the
1850 * buffer size of 8. Correct ways to retransmit #1 would be:
1851 * - TX: 1 or 18 or 81
1852 * Even "189" would be wrong since 1 could be lost again.
1853 *
1854 * Returns a negative error code on failure.
1855 * The callback can sleep.
1856 *
1857 * @get_survey: Return per-channel survey information
1858 *
1859 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1860 * need to set wiphy->rfkill_poll to %true before registration,
1861 * and need to call wiphy_rfkill_set_hw_state() in the callback.
1862 * The callback can sleep.
1863 *
1864 * @set_coverage_class: Set slot time for given coverage class as specified
1865 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1866 * accordingly. This callback is not required and may sleep.
1867 *
1868 * @testmode_cmd: Implement a cfg80211 test mode command.
1869 * The callback can sleep.
1870 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
1871 *
1872 * @flush: Flush all pending frames from the hardware queue, making sure
1873 * that the hardware queues are empty. If the parameter @drop is set
1874 * to %true, pending frames may be dropped. The callback can sleep.
1875 *
1876 * @channel_switch: Drivers that need (or want) to offload the channel
1877 * switch operation for CSAs received from the AP may implement this
1878 * callback. They must then call ieee80211_chswitch_done() to indicate
1879 * completion of the channel switch.
1880 *
1881 * @napi_poll: Poll Rx queue for incoming data frames.
1882 *
1883 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1884 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1885 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1886 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1887 *
1888 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
1889 *
1890 * @remain_on_channel: Starts an off-channel period on the given channel, must
1891 * call back to ieee80211_ready_on_channel() when on that channel. Note
1892 * that normal channel traffic is not stopped as this is intended for hw
1893 * offload. Frames to transmit on the off-channel channel are transmitted
1894 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
1895 * duration (which will always be non-zero) expires, the driver must call
1896 * ieee80211_remain_on_channel_expired(). This callback may sleep.
1897 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
1898 * aborted before it expires. This callback may sleep.
1899 * @offchannel_tx: Transmit frame on another channel, wait for a response
1900 * and return. Reliable TX status must be reported for the frame. If the
1901 * return value is 1, then the @remain_on_channel will be used with a
1902 * regular transmission (if supported.)
1903 * @offchannel_tx_cancel_wait: cancel wait associated with offchannel TX
1904 *
1905 * @set_ringparam: Set tx and rx ring sizes.
1906 *
1907 * @get_ringparam: Get tx and rx ring current and maximum sizes.
1908 *
1909 * @tx_frames_pending: Check if there is any pending frame in the hardware
1910 * queues before entering power save.
1911 *
1912 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
1913 * when transmitting a frame. Currently only legacy rates are handled.
1914 * The callback can sleep.
1915 * @rssi_callback: Notify driver when the average RSSI goes above/below
1916 * thresholds that were registered previously. The callback can sleep.
1917 */
1918struct ieee80211_ops {
1919 void (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1920 int (*start)(struct ieee80211_hw *hw);
1921 void (*stop)(struct ieee80211_hw *hw);
1922#ifdef CONFIG_PM
1923 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
1924 int (*resume)(struct ieee80211_hw *hw);
1925#endif
1926 int (*add_interface)(struct ieee80211_hw *hw,
1927 struct ieee80211_vif *vif);
1928 int (*change_interface)(struct ieee80211_hw *hw,
1929 struct ieee80211_vif *vif,
1930 enum nl80211_iftype new_type, bool p2p);
1931 void (*remove_interface)(struct ieee80211_hw *hw,
1932 struct ieee80211_vif *vif);
1933 int (*config)(struct ieee80211_hw *hw, u32 changed);
1934 void (*bss_info_changed)(struct ieee80211_hw *hw,
1935 struct ieee80211_vif *vif,
1936 struct ieee80211_bss_conf *info,
1937 u32 changed);
1938
1939 int (*tx_sync)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1940 const u8 *bssid, enum ieee80211_tx_sync_type type);
1941 void (*finish_tx_sync)(struct ieee80211_hw *hw,
1942 struct ieee80211_vif *vif,
1943 const u8 *bssid,
1944 enum ieee80211_tx_sync_type type);
1945
1946 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1947 struct netdev_hw_addr_list *mc_list);
1948 void (*configure_filter)(struct ieee80211_hw *hw,
1949 unsigned int changed_flags,
1950 unsigned int *total_flags,
1951 u64 multicast);
1952 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1953 bool set);
1954 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1955 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1956 struct ieee80211_key_conf *key);
1957 void (*update_tkip_key)(struct ieee80211_hw *hw,
1958 struct ieee80211_vif *vif,
1959 struct ieee80211_key_conf *conf,
1960 struct ieee80211_sta *sta,
1961 u32 iv32, u16 *phase1key);
1962 void (*set_rekey_data)(struct ieee80211_hw *hw,
1963 struct ieee80211_vif *vif,
1964 struct cfg80211_gtk_rekey_data *data);
1965 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1966 struct cfg80211_scan_request *req);
1967 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
1968 struct ieee80211_vif *vif);
1969 int (*sched_scan_start)(struct ieee80211_hw *hw,
1970 struct ieee80211_vif *vif,
1971 struct cfg80211_sched_scan_request *req,
1972 struct ieee80211_sched_scan_ies *ies);
1973 void (*sched_scan_stop)(struct ieee80211_hw *hw,
1974 struct ieee80211_vif *vif);
1975 void (*sw_scan_start)(struct ieee80211_hw *hw);
1976 void (*sw_scan_complete)(struct ieee80211_hw *hw);
1977 int (*get_stats)(struct ieee80211_hw *hw,
1978 struct ieee80211_low_level_stats *stats);
1979 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1980 u32 *iv32, u16 *iv16);
1981 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1982 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1983 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1984 struct ieee80211_sta *sta);
1985 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1986 struct ieee80211_sta *sta);
1987 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1988 enum sta_notify_cmd, struct ieee80211_sta *sta);
1989 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1990 const struct ieee80211_tx_queue_params *params);
1991 u64 (*get_tsf)(struct ieee80211_hw *hw);
1992 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1993 void (*reset_tsf)(struct ieee80211_hw *hw);
1994 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1995 int (*ampdu_action)(struct ieee80211_hw *hw,
1996 struct ieee80211_vif *vif,
1997 enum ieee80211_ampdu_mlme_action action,
1998 struct ieee80211_sta *sta, u16 tid, u16 *ssn,
1999 u8 buf_size);
2000 int (*get_survey)(struct ieee80211_hw *hw, int idx,
2001 struct survey_info *survey);
2002 void (*rfkill_poll)(struct ieee80211_hw *hw);
2003 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2004#ifdef CONFIG_NL80211_TESTMODE
2005 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2006 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2007 struct netlink_callback *cb,
2008 void *data, int len);
2009#endif
2010 void (*flush)(struct ieee80211_hw *hw, bool drop);
2011 void (*channel_switch)(struct ieee80211_hw *hw,
2012 struct ieee80211_channel_switch *ch_switch);
2013 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2014 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2015 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2016
2017 int (*remain_on_channel)(struct ieee80211_hw *hw,
2018 struct ieee80211_channel *chan,
2019 enum nl80211_channel_type channel_type,
2020 int duration);
2021 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2022 int (*offchannel_tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
2023 struct ieee80211_channel *chan,
2024 enum nl80211_channel_type channel_type,
2025 unsigned int wait);
2026 int (*offchannel_tx_cancel_wait)(struct ieee80211_hw *hw);
2027 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2028 void (*get_ringparam)(struct ieee80211_hw *hw,
2029 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2030 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2031 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2032 const struct cfg80211_bitrate_mask *mask);
2033 void (*rssi_callback)(struct ieee80211_hw *hw,
2034 enum ieee80211_rssi_event rssi_event);
2035};
2036
2037/**
2038 * ieee80211_alloc_hw - Allocate a new hardware device
2039 *
2040 * This must be called once for each hardware device. The returned pointer
2041 * must be used to refer to this device when calling other functions.
2042 * mac80211 allocates a private data area for the driver pointed to by
2043 * @priv in &struct ieee80211_hw, the size of this area is given as
2044 * @priv_data_len.
2045 *
2046 * @priv_data_len: length of private data
2047 * @ops: callbacks for this device
2048 */
2049struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2050 const struct ieee80211_ops *ops);
2051
2052/**
2053 * ieee80211_register_hw - Register hardware device
2054 *
2055 * You must call this function before any other functions in
2056 * mac80211. Note that before a hardware can be registered, you
2057 * need to fill the contained wiphy's information.
2058 *
2059 * @hw: the device to register as returned by ieee80211_alloc_hw()
2060 */
2061int ieee80211_register_hw(struct ieee80211_hw *hw);
2062
2063/**
2064 * struct ieee80211_tpt_blink - throughput blink description
2065 * @throughput: throughput in Kbit/sec
2066 * @blink_time: blink time in milliseconds
2067 * (full cycle, ie. one off + one on period)
2068 */
2069struct ieee80211_tpt_blink {
2070 int throughput;
2071 int blink_time;
2072};
2073
2074/**
2075 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2076 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2077 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2078 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2079 * interface is connected in some way, including being an AP
2080 */
2081enum ieee80211_tpt_led_trigger_flags {
2082 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
2083 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
2084 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
2085};
2086
2087#ifdef CONFIG_MAC80211_LEDS
2088extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2089extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2090extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2091extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2092extern char *__ieee80211_create_tpt_led_trigger(
2093 struct ieee80211_hw *hw, unsigned int flags,
2094 const struct ieee80211_tpt_blink *blink_table,
2095 unsigned int blink_table_len);
2096#endif
2097/**
2098 * ieee80211_get_tx_led_name - get name of TX LED
2099 *
2100 * mac80211 creates a transmit LED trigger for each wireless hardware
2101 * that can be used to drive LEDs if your driver registers a LED device.
2102 * This function returns the name (or %NULL if not configured for LEDs)
2103 * of the trigger so you can automatically link the LED device.
2104 *
2105 * @hw: the hardware to get the LED trigger name for
2106 */
2107static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2108{
2109#ifdef CONFIG_MAC80211_LEDS
2110 return __ieee80211_get_tx_led_name(hw);
2111#else
2112 return NULL;
2113#endif
2114}
2115
2116/**
2117 * ieee80211_get_rx_led_name - get name of RX LED
2118 *
2119 * mac80211 creates a receive LED trigger for each wireless hardware
2120 * that can be used to drive LEDs if your driver registers a LED device.
2121 * This function returns the name (or %NULL if not configured for LEDs)
2122 * of the trigger so you can automatically link the LED device.
2123 *
2124 * @hw: the hardware to get the LED trigger name for
2125 */
2126static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2127{
2128#ifdef CONFIG_MAC80211_LEDS
2129 return __ieee80211_get_rx_led_name(hw);
2130#else
2131 return NULL;
2132#endif
2133}
2134
2135/**
2136 * ieee80211_get_assoc_led_name - get name of association LED
2137 *
2138 * mac80211 creates a association LED trigger for each wireless hardware
2139 * that can be used to drive LEDs if your driver registers a LED device.
2140 * This function returns the name (or %NULL if not configured for LEDs)
2141 * of the trigger so you can automatically link the LED device.
2142 *
2143 * @hw: the hardware to get the LED trigger name for
2144 */
2145static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2146{
2147#ifdef CONFIG_MAC80211_LEDS
2148 return __ieee80211_get_assoc_led_name(hw);
2149#else
2150 return NULL;
2151#endif
2152}
2153
2154/**
2155 * ieee80211_get_radio_led_name - get name of radio LED
2156 *
2157 * mac80211 creates a radio change LED trigger for each wireless hardware
2158 * that can be used to drive LEDs if your driver registers a LED device.
2159 * This function returns the name (or %NULL if not configured for LEDs)
2160 * of the trigger so you can automatically link the LED device.
2161 *
2162 * @hw: the hardware to get the LED trigger name for
2163 */
2164static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2165{
2166#ifdef CONFIG_MAC80211_LEDS
2167 return __ieee80211_get_radio_led_name(hw);
2168#else
2169 return NULL;
2170#endif
2171}
2172
2173/**
2174 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2175 * @hw: the hardware to create the trigger for
2176 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2177 * @blink_table: the blink table -- needs to be ordered by throughput
2178 * @blink_table_len: size of the blink table
2179 *
2180 * This function returns %NULL (in case of error, or if no LED
2181 * triggers are configured) or the name of the new trigger.
2182 * This function must be called before ieee80211_register_hw().
2183 */
2184static inline char *
2185ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
2186 const struct ieee80211_tpt_blink *blink_table,
2187 unsigned int blink_table_len)
2188{
2189#ifdef CONFIG_MAC80211_LEDS
2190 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
2191 blink_table_len);
2192#else
2193 return NULL;
2194#endif
2195}
2196
2197/**
2198 * ieee80211_unregister_hw - Unregister a hardware device
2199 *
2200 * This function instructs mac80211 to free allocated resources
2201 * and unregister netdevices from the networking subsystem.
2202 *
2203 * @hw: the hardware to unregister
2204 */
2205void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2206
2207/**
2208 * ieee80211_free_hw - free hardware descriptor
2209 *
2210 * This function frees everything that was allocated, including the
2211 * private data for the driver. You must call ieee80211_unregister_hw()
2212 * before calling this function.
2213 *
2214 * @hw: the hardware to free
2215 */
2216void ieee80211_free_hw(struct ieee80211_hw *hw);
2217
2218/**
2219 * ieee80211_restart_hw - restart hardware completely
2220 *
2221 * Call this function when the hardware was restarted for some reason
2222 * (hardware error, ...) and the driver is unable to restore its state
2223 * by itself. mac80211 assumes that at this point the driver/hardware
2224 * is completely uninitialised and stopped, it starts the process by
2225 * calling the ->start() operation. The driver will need to reset all
2226 * internal state that it has prior to calling this function.
2227 *
2228 * @hw: the hardware to restart
2229 */
2230void ieee80211_restart_hw(struct ieee80211_hw *hw);
2231
2232/** ieee80211_napi_schedule - schedule NAPI poll
2233 *
2234 * Use this function to schedule NAPI polling on a device.
2235 *
2236 * @hw: the hardware to start polling
2237 */
2238void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2239
2240/** ieee80211_napi_complete - complete NAPI polling
2241 *
2242 * Use this function to finish NAPI polling on a device.
2243 *
2244 * @hw: the hardware to stop polling
2245 */
2246void ieee80211_napi_complete(struct ieee80211_hw *hw);
2247
2248/**
2249 * ieee80211_rx - receive frame
2250 *
2251 * Use this function to hand received frames to mac80211. The receive
2252 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2253 * paged @skb is used, the driver is recommended to put the ieee80211
2254 * header of the frame on the linear part of the @skb to avoid memory
2255 * allocation and/or memcpy by the stack.
2256 *
2257 * This function may not be called in IRQ context. Calls to this function
2258 * for a single hardware must be synchronized against each other. Calls to
2259 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2260 * mixed for a single hardware.
2261 *
2262 * In process context use instead ieee80211_rx_ni().
2263 *
2264 * @hw: the hardware this frame came in on
2265 * @skb: the buffer to receive, owned by mac80211 after this call
2266 */
2267void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
2268
2269/**
2270 * ieee80211_rx_irqsafe - receive frame
2271 *
2272 * Like ieee80211_rx() but can be called in IRQ context
2273 * (internally defers to a tasklet.)
2274 *
2275 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2276 * be mixed for a single hardware.
2277 *
2278 * @hw: the hardware this frame came in on
2279 * @skb: the buffer to receive, owned by mac80211 after this call
2280 */
2281void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
2282
2283/**
2284 * ieee80211_rx_ni - receive frame (in process context)
2285 *
2286 * Like ieee80211_rx() but can be called in process context
2287 * (internally disables bottom halves).
2288 *
2289 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2290 * not be mixed for a single hardware.
2291 *
2292 * @hw: the hardware this frame came in on
2293 * @skb: the buffer to receive, owned by mac80211 after this call
2294 */
2295static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2296 struct sk_buff *skb)
2297{
2298 local_bh_disable();
2299 ieee80211_rx(hw, skb);
2300 local_bh_enable();
2301}
2302
2303/**
2304 * ieee80211_sta_ps_transition - PS transition for connected sta
2305 *
2306 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2307 * flag set, use this function to inform mac80211 about a connected station
2308 * entering/leaving PS mode.
2309 *
2310 * This function may not be called in IRQ context or with softirqs enabled.
2311 *
2312 * Calls to this function for a single hardware must be synchronized against
2313 * each other.
2314 *
2315 * The function returns -EINVAL when the requested PS mode is already set.
2316 *
2317 * @sta: currently connected sta
2318 * @start: start or stop PS
2319 */
2320int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2321
2322/**
2323 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2324 * (in process context)
2325 *
2326 * Like ieee80211_sta_ps_transition() but can be called in process context
2327 * (internally disables bottom halves). Concurrent call restriction still
2328 * applies.
2329 *
2330 * @sta: currently connected sta
2331 * @start: start or stop PS
2332 */
2333static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2334 bool start)
2335{
2336 int ret;
2337
2338 local_bh_disable();
2339 ret = ieee80211_sta_ps_transition(sta, start);
2340 local_bh_enable();
2341
2342 return ret;
2343}
2344
2345/*
2346 * The TX headroom reserved by mac80211 for its own tx_status functions.
2347 * This is enough for the radiotap header.
2348 */
2349#define IEEE80211_TX_STATUS_HEADROOM 13
2350
2351/**
2352 * ieee80211_sta_set_tim - set the TIM bit for a sleeping station
2353 * @sta: &struct ieee80211_sta pointer for the sleeping station
2354 *
2355 * If a driver buffers frames for a powersave station instead of passing
2356 * them back to mac80211 for retransmission, the station needs to be told
2357 * to wake up using the TIM bitmap in the beacon.
2358 *
2359 * This function sets the station's TIM bit - it will be cleared when the
2360 * station wakes up.
2361 */
2362void ieee80211_sta_set_tim(struct ieee80211_sta *sta);
2363
2364/**
2365 * ieee80211_tx_status - transmit status callback
2366 *
2367 * Call this function for all transmitted frames after they have been
2368 * transmitted. It is permissible to not call this function for
2369 * multicast frames but this can affect statistics.
2370 *
2371 * This function may not be called in IRQ context. Calls to this function
2372 * for a single hardware must be synchronized against each other. Calls
2373 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2374 * may not be mixed for a single hardware.
2375 *
2376 * @hw: the hardware the frame was transmitted by
2377 * @skb: the frame that was transmitted, owned by mac80211 after this call
2378 */
2379void ieee80211_tx_status(struct ieee80211_hw *hw,
2380 struct sk_buff *skb);
2381
2382/**
2383 * ieee80211_tx_status_ni - transmit status callback (in process context)
2384 *
2385 * Like ieee80211_tx_status() but can be called in process context.
2386 *
2387 * Calls to this function, ieee80211_tx_status() and
2388 * ieee80211_tx_status_irqsafe() may not be mixed
2389 * for a single hardware.
2390 *
2391 * @hw: the hardware the frame was transmitted by
2392 * @skb: the frame that was transmitted, owned by mac80211 after this call
2393 */
2394static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2395 struct sk_buff *skb)
2396{
2397 local_bh_disable();
2398 ieee80211_tx_status(hw, skb);
2399 local_bh_enable();
2400}
2401
2402/**
2403 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2404 *
2405 * Like ieee80211_tx_status() but can be called in IRQ context
2406 * (internally defers to a tasklet.)
2407 *
2408 * Calls to this function, ieee80211_tx_status() and
2409 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2410 *
2411 * @hw: the hardware the frame was transmitted by
2412 * @skb: the frame that was transmitted, owned by mac80211 after this call
2413 */
2414void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
2415 struct sk_buff *skb);
2416
2417/**
2418 * ieee80211_report_low_ack - report non-responding station
2419 *
2420 * When operating in AP-mode, call this function to report a non-responding
2421 * connected STA.
2422 *
2423 * @sta: the non-responding connected sta
2424 * @num_packets: number of packets sent to @sta without a response
2425 */
2426void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
2427
2428/**
2429 * ieee80211_beacon_get_tim - beacon generation function
2430 * @hw: pointer obtained from ieee80211_alloc_hw().
2431 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2432 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2433 * Set to 0 if invalid (in non-AP modes).
2434 * @tim_length: pointer to variable that will receive the TIM IE length,
2435 * (including the ID and length bytes!).
2436 * Set to 0 if invalid (in non-AP modes).
2437 *
2438 * If the driver implements beaconing modes, it must use this function to
2439 * obtain the beacon frame/template.
2440 *
2441 * If the beacon frames are generated by the host system (i.e., not in
2442 * hardware/firmware), the driver uses this function to get each beacon
2443 * frame from mac80211 -- it is responsible for calling this function
2444 * before the beacon is needed (e.g. based on hardware interrupt).
2445 *
2446 * If the beacon frames are generated by the device, then the driver
2447 * must use the returned beacon as the template and change the TIM IE
2448 * according to the current DTIM parameters/TIM bitmap.
2449 *
2450 * The driver is responsible for freeing the returned skb.
2451 */
2452struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2453 struct ieee80211_vif *vif,
2454 u16 *tim_offset, u16 *tim_length);
2455
2456/**
2457 * ieee80211_beacon_get - beacon generation function
2458 * @hw: pointer obtained from ieee80211_alloc_hw().
2459 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2460 *
2461 * See ieee80211_beacon_get_tim().
2462 */
2463static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2464 struct ieee80211_vif *vif)
2465{
2466 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2467}
2468
2469/**
2470 * ieee80211_pspoll_get - retrieve a PS Poll template
2471 * @hw: pointer obtained from ieee80211_alloc_hw().
2472 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2473 *
2474 * Creates a PS Poll a template which can, for example, uploaded to
2475 * hardware. The template must be updated after association so that correct
2476 * AID, BSSID and MAC address is used.
2477 *
2478 * Note: Caller (or hardware) is responsible for setting the
2479 * &IEEE80211_FCTL_PM bit.
2480 */
2481struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2482 struct ieee80211_vif *vif);
2483
2484/**
2485 * ieee80211_nullfunc_get - retrieve a nullfunc template
2486 * @hw: pointer obtained from ieee80211_alloc_hw().
2487 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2488 *
2489 * Creates a Nullfunc template which can, for example, uploaded to
2490 * hardware. The template must be updated after association so that correct
2491 * BSSID and address is used.
2492 *
2493 * Note: Caller (or hardware) is responsible for setting the
2494 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2495 */
2496struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2497 struct ieee80211_vif *vif);
2498
2499/**
2500 * ieee80211_probereq_get - retrieve a Probe Request template
2501 * @hw: pointer obtained from ieee80211_alloc_hw().
2502 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2503 * @ssid: SSID buffer
2504 * @ssid_len: length of SSID
2505 * @ie: buffer containing all IEs except SSID for the template
2506 * @ie_len: length of the IE buffer
2507 *
2508 * Creates a Probe Request template which can, for example, be uploaded to
2509 * hardware.
2510 */
2511struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2512 struct ieee80211_vif *vif,
2513 const u8 *ssid, size_t ssid_len,
2514 const u8 *ie, size_t ie_len);
2515
2516/**
2517 * ieee80211_rts_get - RTS frame generation function
2518 * @hw: pointer obtained from ieee80211_alloc_hw().
2519 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2520 * @frame: pointer to the frame that is going to be protected by the RTS.
2521 * @frame_len: the frame length (in octets).
2522 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2523 * @rts: The buffer where to store the RTS frame.
2524 *
2525 * If the RTS frames are generated by the host system (i.e., not in
2526 * hardware/firmware), the low-level driver uses this function to receive
2527 * the next RTS frame from the 802.11 code. The low-level is responsible
2528 * for calling this function before and RTS frame is needed.
2529 */
2530void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2531 const void *frame, size_t frame_len,
2532 const struct ieee80211_tx_info *frame_txctl,
2533 struct ieee80211_rts *rts);
2534
2535/**
2536 * ieee80211_rts_duration - Get the duration field for an RTS frame
2537 * @hw: pointer obtained from ieee80211_alloc_hw().
2538 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2539 * @frame_len: the length of the frame that is going to be protected by the RTS.
2540 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2541 *
2542 * If the RTS is generated in firmware, but the host system must provide
2543 * the duration field, the low-level driver uses this function to receive
2544 * the duration field value in little-endian byteorder.
2545 */
2546__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2547 struct ieee80211_vif *vif, size_t frame_len,
2548 const struct ieee80211_tx_info *frame_txctl);
2549
2550/**
2551 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2552 * @hw: pointer obtained from ieee80211_alloc_hw().
2553 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2554 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2555 * @frame_len: the frame length (in octets).
2556 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2557 * @cts: The buffer where to store the CTS-to-self frame.
2558 *
2559 * If the CTS-to-self frames are generated by the host system (i.e., not in
2560 * hardware/firmware), the low-level driver uses this function to receive
2561 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2562 * for calling this function before and CTS-to-self frame is needed.
2563 */
2564void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2565 struct ieee80211_vif *vif,
2566 const void *frame, size_t frame_len,
2567 const struct ieee80211_tx_info *frame_txctl,
2568 struct ieee80211_cts *cts);
2569
2570/**
2571 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2572 * @hw: pointer obtained from ieee80211_alloc_hw().
2573 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2574 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2575 * @frame_txctl: &struct ieee80211_tx_info of the frame.
2576 *
2577 * If the CTS-to-self is generated in firmware, but the host system must provide
2578 * the duration field, the low-level driver uses this function to receive
2579 * the duration field value in little-endian byteorder.
2580 */
2581__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2582 struct ieee80211_vif *vif,
2583 size_t frame_len,
2584 const struct ieee80211_tx_info *frame_txctl);
2585
2586/**
2587 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2588 * @hw: pointer obtained from ieee80211_alloc_hw().
2589 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2590 * @frame_len: the length of the frame.
2591 * @rate: the rate at which the frame is going to be transmitted.
2592 *
2593 * Calculate the duration field of some generic frame, given its
2594 * length and transmission rate (in 100kbps).
2595 */
2596__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2597 struct ieee80211_vif *vif,
2598 size_t frame_len,
2599 struct ieee80211_rate *rate);
2600
2601/**
2602 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2603 * @hw: pointer as obtained from ieee80211_alloc_hw().
2604 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2605 *
2606 * Function for accessing buffered broadcast and multicast frames. If
2607 * hardware/firmware does not implement buffering of broadcast/multicast
2608 * frames when power saving is used, 802.11 code buffers them in the host
2609 * memory. The low-level driver uses this function to fetch next buffered
2610 * frame. In most cases, this is used when generating beacon frame. This
2611 * function returns a pointer to the next buffered skb or NULL if no more
2612 * buffered frames are available.
2613 *
2614 * Note: buffered frames are returned only after DTIM beacon frame was
2615 * generated with ieee80211_beacon_get() and the low-level driver must thus
2616 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2617 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2618 * does not need to check for DTIM beacons separately and should be able to
2619 * use common code for all beacons.
2620 */
2621struct sk_buff *
2622ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2623
2624/**
2625 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
2626 *
2627 * This function returns the TKIP phase 1 key for the given IV32.
2628 *
2629 * @keyconf: the parameter passed with the set key
2630 * @iv32: IV32 to get the P1K for
2631 * @p1k: a buffer to which the key will be written, as 5 u16 values
2632 */
2633void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
2634 u32 iv32, u16 *p1k);
2635
2636/**
2637 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
2638 *
2639 * This function returns the TKIP phase 1 key for the IV32 taken
2640 * from the given packet.
2641 *
2642 * @keyconf: the parameter passed with the set key
2643 * @skb: the packet to take the IV32 value from that will be encrypted
2644 * with this P1K
2645 * @p1k: a buffer to which the key will be written, as 5 u16 values
2646 */
2647static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
2648 struct sk_buff *skb, u16 *p1k)
2649{
2650 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
2651 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
2652 u32 iv32 = get_unaligned_le32(&data[4]);
2653
2654 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
2655}
2656
2657/**
2658 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
2659 *
2660 * This function returns the TKIP phase 1 key for the given IV32
2661 * and transmitter address.
2662 *
2663 * @keyconf: the parameter passed with the set key
2664 * @ta: TA that will be used with the key
2665 * @iv32: IV32 to get the P1K for
2666 * @p1k: a buffer to which the key will be written, as 5 u16 values
2667 */
2668void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
2669 const u8 *ta, u32 iv32, u16 *p1k);
2670
2671/**
2672 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
2673 *
2674 * This function computes the TKIP RC4 key for the IV values
2675 * in the packet.
2676 *
2677 * @keyconf: the parameter passed with the set key
2678 * @skb: the packet to take the IV32/IV16 values from that will be
2679 * encrypted with this key
2680 * @p2k: a buffer to which the key will be written, 16 bytes
2681 */
2682void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
2683 struct sk_buff *skb, u8 *p2k);
2684
2685/**
2686 * struct ieee80211_key_seq - key sequence counter
2687 *
2688 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2689 * @ccmp: PN data, most significant byte first (big endian,
2690 * reverse order than in packet)
2691 * @aes_cmac: PN data, most significant byte first (big endian,
2692 * reverse order than in packet)
2693 */
2694struct ieee80211_key_seq {
2695 union {
2696 struct {
2697 u32 iv32;
2698 u16 iv16;
2699 } tkip;
2700 struct {
2701 u8 pn[6];
2702 } ccmp;
2703 struct {
2704 u8 pn[6];
2705 } aes_cmac;
2706 };
2707};
2708
2709/**
2710 * ieee80211_get_key_tx_seq - get key TX sequence counter
2711 *
2712 * @keyconf: the parameter passed with the set key
2713 * @seq: buffer to receive the sequence data
2714 *
2715 * This function allows a driver to retrieve the current TX IV/PN
2716 * for the given key. It must not be called if IV generation is
2717 * offloaded to the device.
2718 *
2719 * Note that this function may only be called when no TX processing
2720 * can be done concurrently, for example when queues are stopped
2721 * and the stop has been synchronized.
2722 */
2723void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
2724 struct ieee80211_key_seq *seq);
2725
2726/**
2727 * ieee80211_get_key_rx_seq - get key RX sequence counter
2728 *
2729 * @keyconf: the parameter passed with the set key
2730 * @tid: The TID, or -1 for the management frame value (CCMP only);
2731 * the value on TID 0 is also used for non-QoS frames. For
2732 * CMAC, only TID 0 is valid.
2733 * @seq: buffer to receive the sequence data
2734 *
2735 * This function allows a driver to retrieve the current RX IV/PNs
2736 * for the given key. It must not be called if IV checking is done
2737 * by the device and not by mac80211.
2738 *
2739 * Note that this function may only be called when no RX processing
2740 * can be done concurrently.
2741 */
2742void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
2743 int tid, struct ieee80211_key_seq *seq);
2744
2745/**
2746 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
2747 * @vif: virtual interface the rekeying was done on
2748 * @bssid: The BSSID of the AP, for checking association
2749 * @replay_ctr: the new replay counter after GTK rekeying
2750 * @gfp: allocation flags
2751 */
2752void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
2753 const u8 *replay_ctr, gfp_t gfp);
2754
2755/**
2756 * ieee80211_wake_queue - wake specific queue
2757 * @hw: pointer as obtained from ieee80211_alloc_hw().
2758 * @queue: queue number (counted from zero).
2759 *
2760 * Drivers should use this function instead of netif_wake_queue.
2761 */
2762void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2763
2764/**
2765 * ieee80211_stop_queue - stop specific queue
2766 * @hw: pointer as obtained from ieee80211_alloc_hw().
2767 * @queue: queue number (counted from zero).
2768 *
2769 * Drivers should use this function instead of netif_stop_queue.
2770 */
2771void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2772
2773/**
2774 * ieee80211_queue_stopped - test status of the queue
2775 * @hw: pointer as obtained from ieee80211_alloc_hw().
2776 * @queue: queue number (counted from zero).
2777 *
2778 * Drivers should use this function instead of netif_stop_queue.
2779 */
2780
2781int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2782
2783/**
2784 * ieee80211_stop_queues - stop all queues
2785 * @hw: pointer as obtained from ieee80211_alloc_hw().
2786 *
2787 * Drivers should use this function instead of netif_stop_queue.
2788 */
2789void ieee80211_stop_queues(struct ieee80211_hw *hw);
2790
2791/**
2792 * ieee80211_wake_queues - wake all queues
2793 * @hw: pointer as obtained from ieee80211_alloc_hw().
2794 *
2795 * Drivers should use this function instead of netif_wake_queue.
2796 */
2797void ieee80211_wake_queues(struct ieee80211_hw *hw);
2798
2799/**
2800 * ieee80211_scan_completed - completed hardware scan
2801 *
2802 * When hardware scan offload is used (i.e. the hw_scan() callback is
2803 * assigned) this function needs to be called by the driver to notify
2804 * mac80211 that the scan finished. This function can be called from
2805 * any context, including hardirq context.
2806 *
2807 * @hw: the hardware that finished the scan
2808 * @aborted: set to true if scan was aborted
2809 */
2810void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2811
2812/**
2813 * ieee80211_sched_scan_results - got results from scheduled scan
2814 *
2815 * When a scheduled scan is running, this function needs to be called by the
2816 * driver whenever there are new scan results available.
2817 *
2818 * @hw: the hardware that is performing scheduled scans
2819 */
2820void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
2821
2822/**
2823 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
2824 *
2825 * When a scheduled scan is running, this function can be called by
2826 * the driver if it needs to stop the scan to perform another task.
2827 * Usual scenarios are drivers that cannot continue the scheduled scan
2828 * while associating, for instance.
2829 *
2830 * @hw: the hardware that is performing scheduled scans
2831 */
2832void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
2833
2834/**
2835 * ieee80211_iterate_active_interfaces - iterate active interfaces
2836 *
2837 * This function iterates over the interfaces associated with a given
2838 * hardware that are currently active and calls the callback for them.
2839 * This function allows the iterator function to sleep, when the iterator
2840 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2841 * be used.
2842 * Does not iterate over a new interface during add_interface()
2843 *
2844 * @hw: the hardware struct of which the interfaces should be iterated over
2845 * @iterator: the iterator function to call
2846 * @data: first argument of the iterator function
2847 */
2848void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2849 void (*iterator)(void *data, u8 *mac,
2850 struct ieee80211_vif *vif),
2851 void *data);
2852
2853/**
2854 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2855 *
2856 * This function iterates over the interfaces associated with a given
2857 * hardware that are currently active and calls the callback for them.
2858 * This function requires the iterator callback function to be atomic,
2859 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2860 * Does not iterate over a new interface during add_interface()
2861 *
2862 * @hw: the hardware struct of which the interfaces should be iterated over
2863 * @iterator: the iterator function to call, cannot sleep
2864 * @data: first argument of the iterator function
2865 */
2866void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2867 void (*iterator)(void *data,
2868 u8 *mac,
2869 struct ieee80211_vif *vif),
2870 void *data);
2871
2872/**
2873 * ieee80211_queue_work - add work onto the mac80211 workqueue
2874 *
2875 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2876 * This helper ensures drivers are not queueing work when they should not be.
2877 *
2878 * @hw: the hardware struct for the interface we are adding work for
2879 * @work: the work we want to add onto the mac80211 workqueue
2880 */
2881void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2882
2883/**
2884 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2885 *
2886 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2887 * workqueue.
2888 *
2889 * @hw: the hardware struct for the interface we are adding work for
2890 * @dwork: delayable work to queue onto the mac80211 workqueue
2891 * @delay: number of jiffies to wait before queueing
2892 */
2893void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2894 struct delayed_work *dwork,
2895 unsigned long delay);
2896
2897/**
2898 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2899 * @sta: the station for which to start a BA session
2900 * @tid: the TID to BA on.
2901 * @timeout: session timeout value (in TUs)
2902 *
2903 * Return: success if addBA request was sent, failure otherwise
2904 *
2905 * Although mac80211/low level driver/user space application can estimate
2906 * the need to start aggregation on a certain RA/TID, the session level
2907 * will be managed by the mac80211.
2908 */
2909int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2910 u16 timeout);
2911
2912/**
2913 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2914 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2915 * @ra: receiver address of the BA session recipient.
2916 * @tid: the TID to BA on.
2917 *
2918 * This function must be called by low level driver once it has
2919 * finished with preparations for the BA session. It can be called
2920 * from any context.
2921 */
2922void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2923 u16 tid);
2924
2925/**
2926 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2927 * @sta: the station whose BA session to stop
2928 * @tid: the TID to stop BA.
2929 *
2930 * Return: negative error if the TID is invalid, or no aggregation active
2931 *
2932 * Although mac80211/low level driver/user space application can estimate
2933 * the need to stop aggregation on a certain RA/TID, the session level
2934 * will be managed by the mac80211.
2935 */
2936int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2937
2938/**
2939 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2940 * @vif: &struct ieee80211_vif pointer from the add_interface callback
2941 * @ra: receiver address of the BA session recipient.
2942 * @tid: the desired TID to BA on.
2943 *
2944 * This function must be called by low level driver once it has
2945 * finished with preparations for the BA session tear down. It
2946 * can be called from any context.
2947 */
2948void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2949 u16 tid);
2950
2951/**
2952 * ieee80211_find_sta - find a station
2953 *
2954 * @vif: virtual interface to look for station on
2955 * @addr: station's address
2956 *
2957 * This function must be called under RCU lock and the
2958 * resulting pointer is only valid under RCU lock as well.
2959 */
2960struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
2961 const u8 *addr);
2962
2963/**
2964 * ieee80211_find_sta_by_ifaddr - find a station on hardware
2965 *
2966 * @hw: pointer as obtained from ieee80211_alloc_hw()
2967 * @addr: remote station's address
2968 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
2969 *
2970 * This function must be called under RCU lock and the
2971 * resulting pointer is only valid under RCU lock as well.
2972 *
2973 * NOTE: You may pass NULL for localaddr, but then you will just get
2974 * the first STA that matches the remote address 'addr'.
2975 * We can have multiple STA associated with multiple
2976 * logical stations (e.g. consider a station connecting to another
2977 * BSSID on the same AP hardware without disconnecting first).
2978 * In this case, the result of this method with localaddr NULL
2979 * is not reliable.
2980 *
2981 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
2982 */
2983struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
2984 const u8 *addr,
2985 const u8 *localaddr);
2986
2987/**
2988 * ieee80211_sta_block_awake - block station from waking up
2989 * @hw: the hardware
2990 * @pubsta: the station
2991 * @block: whether to block or unblock
2992 *
2993 * Some devices require that all frames that are on the queues
2994 * for a specific station that went to sleep are flushed before
2995 * a poll response or frames after the station woke up can be
2996 * delivered to that it. Note that such frames must be rejected
2997 * by the driver as filtered, with the appropriate status flag.
2998 *
2999 * This function allows implementing this mode in a race-free
3000 * manner.
3001 *
3002 * To do this, a driver must keep track of the number of frames
3003 * still enqueued for a specific station. If this number is not
3004 * zero when the station goes to sleep, the driver must call
3005 * this function to force mac80211 to consider the station to
3006 * be asleep regardless of the station's actual state. Once the
3007 * number of outstanding frames reaches zero, the driver must
3008 * call this function again to unblock the station. That will
3009 * cause mac80211 to be able to send ps-poll responses, and if
3010 * the station queried in the meantime then frames will also
3011 * be sent out as a result of this. Additionally, the driver
3012 * will be notified that the station woke up some time after
3013 * it is unblocked, regardless of whether the station actually
3014 * woke up while blocked or not.
3015 */
3016void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3017 struct ieee80211_sta *pubsta, bool block);
3018
3019/**
3020 * ieee80211_iter_keys - iterate keys programmed into the device
3021 * @hw: pointer obtained from ieee80211_alloc_hw()
3022 * @vif: virtual interface to iterate, may be %NULL for all
3023 * @iter: iterator function that will be called for each key
3024 * @iter_data: custom data to pass to the iterator function
3025 *
3026 * This function can be used to iterate all the keys known to
3027 * mac80211, even those that weren't previously programmed into
3028 * the device. This is intended for use in WoWLAN if the device
3029 * needs reprogramming of the keys during suspend. Note that due
3030 * to locking reasons, it is also only safe to call this at few
3031 * spots since it must hold the RTNL and be able to sleep.
3032 *
3033 * The order in which the keys are iterated matches the order
3034 * in which they were originally installed and handed to the
3035 * set_key callback.
3036 */
3037void ieee80211_iter_keys(struct ieee80211_hw *hw,
3038 struct ieee80211_vif *vif,
3039 void (*iter)(struct ieee80211_hw *hw,
3040 struct ieee80211_vif *vif,
3041 struct ieee80211_sta *sta,
3042 struct ieee80211_key_conf *key,
3043 void *data),
3044 void *iter_data);
3045
3046/**
3047 * ieee80211_ap_probereq_get - retrieve a Probe Request template
3048 * @hw: pointer obtained from ieee80211_alloc_hw().
3049 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3050 *
3051 * Creates a Probe Request template which can, for example, be uploaded to
3052 * hardware. The template is filled with bssid, ssid and supported rate
3053 * information. This function must only be called from within the
3054 * .bss_info_changed callback function and only in managed mode. The function
3055 * is only useful when the interface is associated, otherwise it will return
3056 * NULL.
3057 */
3058struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3059 struct ieee80211_vif *vif);
3060
3061/**
3062 * ieee80211_beacon_loss - inform hardware does not receive beacons
3063 *
3064 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3065 *
3066 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
3067 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3068 * hardware is not receiving beacons with this function.
3069 */
3070void ieee80211_beacon_loss(struct ieee80211_vif *vif);
3071
3072/**
3073 * ieee80211_connection_loss - inform hardware has lost connection to the AP
3074 *
3075 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3076 *
3077 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
3078 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3079 * needs to inform if the connection to the AP has been lost.
3080 *
3081 * This function will cause immediate change to disassociated state,
3082 * without connection recovery attempts.
3083 */
3084void ieee80211_connection_loss(struct ieee80211_vif *vif);
3085
3086/**
3087 * ieee80211_resume_disconnect - disconnect from AP after resume
3088 *
3089 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3090 *
3091 * Instructs mac80211 to disconnect from the AP after resume.
3092 * Drivers can use this after WoWLAN if they know that the
3093 * connection cannot be kept up, for example because keys were
3094 * used while the device was asleep but the replay counters or
3095 * similar cannot be retrieved from the device during resume.
3096 *
3097 * Note that due to implementation issues, if the driver uses
3098 * the reconfiguration functionality during resume the interface
3099 * will still be added as associated first during resume and then
3100 * disconnect normally later.
3101 *
3102 * This function can only be called from the resume callback and
3103 * the driver must not be holding any of its own locks while it
3104 * calls this function, or at least not any locks it needs in the
3105 * key configuration paths (if it supports HW crypto).
3106 */
3107void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3108
3109/**
3110 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3111 *
3112 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3113 *
3114 * Some hardware require full power save to manage simultaneous BT traffic
3115 * on the WLAN frequency. Full PSM is required periodically, whenever there are
3116 * burst of BT traffic. The hardware gets information of BT traffic via
3117 * hardware co-existence lines, and consequentially requests mac80211 to
3118 * (temporarily) enter full psm.
3119 * This function will only temporarily disable dynamic PS, not enable PSM if
3120 * it was not already enabled.
3121 * The driver must make sure to re-enable dynamic PS using
3122 * ieee80211_enable_dyn_ps() if the driver has disabled it.
3123 *
3124 */
3125void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3126
3127/**
3128 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3129 *
3130 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3131 *
3132 * This function restores dynamic PS after being temporarily disabled via
3133 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3134 * be coupled with an eventual call to this function.
3135 *
3136 */
3137void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3138
3139/**
3140 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3141 * rssi threshold triggered
3142 *
3143 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3144 * @rssi_event: the RSSI trigger event type
3145 * @gfp: context flags
3146 *
3147 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
3148 * monitoring is configured with an rssi threshold, the driver will inform
3149 * whenever the rssi level reaches the threshold.
3150 */
3151void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3152 enum nl80211_cqm_rssi_threshold_event rssi_event,
3153 gfp_t gfp);
3154
3155/**
3156 * ieee80211_get_operstate - get the operstate of the vif
3157 *
3158 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3159 *
3160 * The driver might need to know the operstate of the net_device
3161 * (specifically, whether the link is IF_OPER_UP after resume)
3162 */
3163unsigned char ieee80211_get_operstate(struct ieee80211_vif *vif);
3164
3165/**
3166 * ieee80211_chswitch_done - Complete channel switch process
3167 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3168 * @success: make the channel switch successful or not
3169 *
3170 * Complete the channel switch post-process: set the new operational channel
3171 * and wake up the suspended queues.
3172 */
3173void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3174
3175/**
3176 * ieee80211_request_smps - request SM PS transition
3177 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3178 * @smps_mode: new SM PS mode
3179 *
3180 * This allows the driver to request an SM PS transition in managed
3181 * mode. This is useful when the driver has more information than
3182 * the stack about possible interference, for example by bluetooth.
3183 */
3184void ieee80211_request_smps(struct ieee80211_vif *vif,
3185 enum ieee80211_smps_mode smps_mode);
3186
3187/**
3188 * ieee80211_key_removed - disable hw acceleration for key
3189 * @key_conf: The key hw acceleration should be disabled for
3190 *
3191 * This allows drivers to indicate that the given key has been
3192 * removed from hardware acceleration, due to a new key that
3193 * was added. Don't use this if the key can continue to be used
3194 * for TX, if the key restriction is on RX only it is permitted
3195 * to keep the key for TX only and not call this function.
3196 *
3197 * Due to locking constraints, it may only be called during
3198 * @set_key. This function must be allowed to sleep, and the
3199 * key it tries to disable may still be used until it returns.
3200 */
3201void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
3202
3203/**
3204 * ieee80211_ready_on_channel - notification of remain-on-channel start
3205 * @hw: pointer as obtained from ieee80211_alloc_hw()
3206 */
3207void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3208
3209/**
3210 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3211 * @hw: pointer as obtained from ieee80211_alloc_hw()
3212 */
3213void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3214
3215/**
3216 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3217 *
3218 * in order not to harm the system performance and user experience, the device
3219 * may request not to allow any rx ba session and tear down existing rx ba
3220 * sessions based on system constraints such as periodic BT activity that needs
3221 * to limit wlan activity (eg.sco or a2dp)."
3222 * in such cases, the intention is to limit the duration of the rx ppdu and
3223 * therefore prevent the peer device to use a-mpdu aggregation.
3224 *
3225 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3226 * @ba_rx_bitmap: Bit map of open rx ba per tid
3227 * @addr: & to bssid mac address
3228 */
3229void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3230 const u8 *addr);
3231
3232/* Rate control API */
3233
3234/**
3235 * enum rate_control_changed - flags to indicate which parameter changed
3236 *
3237 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
3238 * changed, rate control algorithm can update its internal state if needed.
3239 */
3240enum rate_control_changed {
3241 IEEE80211_RC_HT_CHANGED = BIT(0)
3242};
3243
3244/**
3245 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3246 *
3247 * @hw: The hardware the algorithm is invoked for.
3248 * @sband: The band this frame is being transmitted on.
3249 * @bss_conf: the current BSS configuration
3250 * @reported_rate: The rate control algorithm can fill this in to indicate
3251 * which rate should be reported to userspace as the current rate and
3252 * used for rate calculations in the mesh network.
3253 * @rts: whether RTS will be used for this frame because it is longer than the
3254 * RTS threshold
3255 * @short_preamble: whether mac80211 will request short-preamble transmission
3256 * if the selected rate supports it
3257 * @max_rate_idx: user-requested maximum rate (not MCS for now)
3258 * (deprecated; this will be removed once drivers get updated to use
3259 * rate_idx_mask)
3260 * @rate_idx_mask: user-requested rate mask (not MCS for now)
3261 * @skb: the skb that will be transmitted, the control information in it needs
3262 * to be filled in
3263 * @bss: whether this frame is sent out in AP or IBSS mode
3264 */
3265struct ieee80211_tx_rate_control {
3266 struct ieee80211_hw *hw;
3267 struct ieee80211_supported_band *sband;
3268 struct ieee80211_bss_conf *bss_conf;
3269 struct sk_buff *skb;
3270 struct ieee80211_tx_rate reported_rate;
3271 bool rts, short_preamble;
3272 u8 max_rate_idx;
3273 u32 rate_idx_mask;
3274 bool bss;
3275};
3276
3277struct rate_control_ops {
3278 struct module *module;
3279 const char *name;
3280 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
3281 void (*free)(void *priv);
3282
3283 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3284 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3285 struct ieee80211_sta *sta, void *priv_sta);
3286 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3287 struct ieee80211_sta *sta,
3288 void *priv_sta, u32 changed,
3289 enum nl80211_channel_type oper_chan_type);
3290 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3291 void *priv_sta);
3292
3293 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3294 struct ieee80211_sta *sta, void *priv_sta,
3295 struct sk_buff *skb);
3296 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3297 struct ieee80211_tx_rate_control *txrc);
3298
3299 void (*add_sta_debugfs)(void *priv, void *priv_sta,
3300 struct dentry *dir);
3301 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3302};
3303
3304static inline int rate_supported(struct ieee80211_sta *sta,
3305 enum ieee80211_band band,
3306 int index)
3307{
3308 return (sta == NULL || sta->supp_rates[band] & BIT(index));
3309}
3310
3311/**
3312 * rate_control_send_low - helper for drivers for management/no-ack frames
3313 *
3314 * Rate control algorithms that agree to use the lowest rate to
3315 * send management frames and NO_ACK data with the respective hw
3316 * retries should use this in the beginning of their mac80211 get_rate
3317 * callback. If true is returned the rate control can simply return.
3318 * If false is returned we guarantee that sta and sta and priv_sta is
3319 * not null.
3320 *
3321 * Rate control algorithms wishing to do more intelligent selection of
3322 * rate for multicast/broadcast frames may choose to not use this.
3323 *
3324 * @sta: &struct ieee80211_sta pointer to the target destination. Note
3325 * that this may be null.
3326 * @priv_sta: private rate control structure. This may be null.
3327 * @txrc: rate control information we sholud populate for mac80211.
3328 */
3329bool rate_control_send_low(struct ieee80211_sta *sta,
3330 void *priv_sta,
3331 struct ieee80211_tx_rate_control *txrc);
3332
3333
3334static inline s8
3335rate_lowest_index(struct ieee80211_supported_band *sband,
3336 struct ieee80211_sta *sta)
3337{
3338 int i;
3339
3340 for (i = 0; i < sband->n_bitrates; i++)
3341 if (rate_supported(sta, sband->band, i))
3342 return i;
3343
3344 /* warn when we cannot find a rate. */
3345 WARN_ON(1);
3346
3347 return 0;
3348}
3349
3350static inline
3351bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
3352 struct ieee80211_sta *sta)
3353{
3354 unsigned int i;
3355
3356 for (i = 0; i < sband->n_bitrates; i++)
3357 if (rate_supported(sta, sband->band, i))
3358 return true;
3359 return false;
3360}
3361
3362int ieee80211_rate_control_register(struct rate_control_ops *ops);
3363void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
3364
3365static inline bool
3366conf_is_ht20(struct ieee80211_conf *conf)
3367{
3368 return conf->channel_type == NL80211_CHAN_HT20;
3369}
3370
3371static inline bool
3372conf_is_ht40_minus(struct ieee80211_conf *conf)
3373{
3374 return conf->channel_type == NL80211_CHAN_HT40MINUS;
3375}
3376
3377static inline bool
3378conf_is_ht40_plus(struct ieee80211_conf *conf)
3379{
3380 return conf->channel_type == NL80211_CHAN_HT40PLUS;
3381}
3382
3383static inline bool
3384conf_is_ht40(struct ieee80211_conf *conf)
3385{
3386 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3387}
3388
3389static inline bool
3390conf_is_ht(struct ieee80211_conf *conf)
3391{
3392 return conf->channel_type != NL80211_CHAN_NO_HT;
3393}
3394
3395static inline enum nl80211_iftype
3396ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3397{
3398 if (p2p) {
3399 switch (type) {
3400 case NL80211_IFTYPE_STATION:
3401 return NL80211_IFTYPE_P2P_CLIENT;
3402 case NL80211_IFTYPE_AP:
3403 return NL80211_IFTYPE_P2P_GO;
3404 default:
3405 break;
3406 }
3407 }
3408 return type;
3409}
3410
3411static inline enum nl80211_iftype
3412ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3413{
3414 return ieee80211_iftype_p2p(vif->type, vif->p2p);
3415}
3416
3417void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
3418 int rssi_min_thold,
3419 int rssi_max_thold);
3420
3421void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
3422#endif /* MAC80211_H */
1/*
2 * mac80211 <-> driver interface
3 *
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright (C) 2015 - 2016 Intel Deutschland GmbH
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
13 */
14
15#ifndef MAC80211_H
16#define MAC80211_H
17
18#include <linux/bug.h>
19#include <linux/kernel.h>
20#include <linux/if_ether.h>
21#include <linux/skbuff.h>
22#include <linux/ieee80211.h>
23#include <net/cfg80211.h>
24#include <asm/unaligned.h>
25
26/**
27 * DOC: Introduction
28 *
29 * mac80211 is the Linux stack for 802.11 hardware that implements
30 * only partial functionality in hard- or firmware. This document
31 * defines the interface between mac80211 and low-level hardware
32 * drivers.
33 */
34
35/**
36 * DOC: Calling mac80211 from interrupts
37 *
38 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
39 * called in hardware interrupt context. The low-level driver must not call any
40 * other functions in hardware interrupt context. If there is a need for such
41 * call, the low-level driver should first ACK the interrupt and perform the
42 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43 * tasklet function.
44 *
45 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
46 * use the non-IRQ-safe functions!
47 */
48
49/**
50 * DOC: Warning
51 *
52 * If you're reading this document and not the header file itself, it will
53 * be incomplete because not all documentation has been converted yet.
54 */
55
56/**
57 * DOC: Frame format
58 *
59 * As a general rule, when frames are passed between mac80211 and the driver,
60 * they start with the IEEE 802.11 header and include the same octets that are
61 * sent over the air except for the FCS which should be calculated by the
62 * hardware.
63 *
64 * There are, however, various exceptions to this rule for advanced features:
65 *
66 * The first exception is for hardware encryption and decryption offload
67 * where the IV/ICV may or may not be generated in hardware.
68 *
69 * Secondly, when the hardware handles fragmentation, the frame handed to
70 * the driver from mac80211 is the MSDU, not the MPDU.
71 */
72
73/**
74 * DOC: mac80211 workqueue
75 *
76 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
77 * The workqueue is a single threaded workqueue and can only be accessed by
78 * helpers for sanity checking. Drivers must ensure all work added onto the
79 * mac80211 workqueue should be cancelled on the driver stop() callback.
80 *
81 * mac80211 will flushed the workqueue upon interface removal and during
82 * suspend.
83 *
84 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
85 *
86 */
87
88/**
89 * DOC: mac80211 software tx queueing
90 *
91 * mac80211 provides an optional intermediate queueing implementation designed
92 * to allow the driver to keep hardware queues short and provide some fairness
93 * between different stations/interfaces.
94 * In this model, the driver pulls data frames from the mac80211 queue instead
95 * of letting mac80211 push them via drv_tx().
96 * Other frames (e.g. control or management) are still pushed using drv_tx().
97 *
98 * Drivers indicate that they use this model by implementing the .wake_tx_queue
99 * driver operation.
100 *
101 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a
102 * single per-vif queue for multicast data frames.
103 *
104 * The driver is expected to initialize its private per-queue data for stations
105 * and interfaces in the .add_interface and .sta_add ops.
106 *
107 * The driver can't access the queue directly. To dequeue a frame, it calls
108 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
109 * calls the .wake_tx_queue driver op.
110 *
111 * For AP powersave TIM handling, the driver only needs to indicate if it has
112 * buffered packets in the driver specific data structures by calling
113 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
114 * struct, mac80211 sets the appropriate TIM PVB bits and calls
115 * .release_buffered_frames().
116 * In that callback the driver is therefore expected to release its own
117 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
118 * via the usual ieee80211_tx_dequeue).
119 */
120
121struct device;
122
123/**
124 * enum ieee80211_max_queues - maximum number of queues
125 *
126 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
127 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
128 */
129enum ieee80211_max_queues {
130 IEEE80211_MAX_QUEUES = 16,
131 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
132};
133
134#define IEEE80211_INVAL_HW_QUEUE 0xff
135
136/**
137 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
138 * @IEEE80211_AC_VO: voice
139 * @IEEE80211_AC_VI: video
140 * @IEEE80211_AC_BE: best effort
141 * @IEEE80211_AC_BK: background
142 */
143enum ieee80211_ac_numbers {
144 IEEE80211_AC_VO = 0,
145 IEEE80211_AC_VI = 1,
146 IEEE80211_AC_BE = 2,
147 IEEE80211_AC_BK = 3,
148};
149#define IEEE80211_NUM_ACS 4
150
151/**
152 * struct ieee80211_tx_queue_params - transmit queue configuration
153 *
154 * The information provided in this structure is required for QoS
155 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
156 *
157 * @aifs: arbitration interframe space [0..255]
158 * @cw_min: minimum contention window [a value of the form
159 * 2^n-1 in the range 1..32767]
160 * @cw_max: maximum contention window [like @cw_min]
161 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
162 * @acm: is mandatory admission control required for the access category
163 * @uapsd: is U-APSD mode enabled for the queue
164 */
165struct ieee80211_tx_queue_params {
166 u16 txop;
167 u16 cw_min;
168 u16 cw_max;
169 u8 aifs;
170 bool acm;
171 bool uapsd;
172};
173
174struct ieee80211_low_level_stats {
175 unsigned int dot11ACKFailureCount;
176 unsigned int dot11RTSFailureCount;
177 unsigned int dot11FCSErrorCount;
178 unsigned int dot11RTSSuccessCount;
179};
180
181/**
182 * enum ieee80211_chanctx_change - change flag for channel context
183 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
184 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
185 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
186 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
187 * this is used only with channel switching with CSA
188 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
189 */
190enum ieee80211_chanctx_change {
191 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
192 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
193 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
194 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
195 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
196};
197
198/**
199 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
200 *
201 * This is the driver-visible part. The ieee80211_chanctx
202 * that contains it is visible in mac80211 only.
203 *
204 * @def: the channel definition
205 * @min_def: the minimum channel definition currently required.
206 * @rx_chains_static: The number of RX chains that must always be
207 * active on the channel to receive MIMO transmissions
208 * @rx_chains_dynamic: The number of RX chains that must be enabled
209 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
210 * this will always be >= @rx_chains_static.
211 * @radar_enabled: whether radar detection is enabled on this channel.
212 * @drv_priv: data area for driver use, will always be aligned to
213 * sizeof(void *), size is determined in hw information.
214 */
215struct ieee80211_chanctx_conf {
216 struct cfg80211_chan_def def;
217 struct cfg80211_chan_def min_def;
218
219 u8 rx_chains_static, rx_chains_dynamic;
220
221 bool radar_enabled;
222
223 u8 drv_priv[0] __aligned(sizeof(void *));
224};
225
226/**
227 * enum ieee80211_chanctx_switch_mode - channel context switch mode
228 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
229 * exist (and will continue to exist), but the virtual interface
230 * needs to be switched from one to the other.
231 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
232 * to exist with this call, the new context doesn't exist but
233 * will be active after this call, the virtual interface switches
234 * from the old to the new (note that the driver may of course
235 * implement this as an on-the-fly chandef switch of the existing
236 * hardware context, but the mac80211 pointer for the old context
237 * will cease to exist and only the new one will later be used
238 * for changes/removal.)
239 */
240enum ieee80211_chanctx_switch_mode {
241 CHANCTX_SWMODE_REASSIGN_VIF,
242 CHANCTX_SWMODE_SWAP_CONTEXTS,
243};
244
245/**
246 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
247 *
248 * This is structure is used to pass information about a vif that
249 * needs to switch from one chanctx to another. The
250 * &ieee80211_chanctx_switch_mode defines how the switch should be
251 * done.
252 *
253 * @vif: the vif that should be switched from old_ctx to new_ctx
254 * @old_ctx: the old context to which the vif was assigned
255 * @new_ctx: the new context to which the vif must be assigned
256 */
257struct ieee80211_vif_chanctx_switch {
258 struct ieee80211_vif *vif;
259 struct ieee80211_chanctx_conf *old_ctx;
260 struct ieee80211_chanctx_conf *new_ctx;
261};
262
263/**
264 * enum ieee80211_bss_change - BSS change notification flags
265 *
266 * These flags are used with the bss_info_changed() callback
267 * to indicate which BSS parameter changed.
268 *
269 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
270 * also implies a change in the AID.
271 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
272 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
273 * @BSS_CHANGED_ERP_SLOT: slot timing changed
274 * @BSS_CHANGED_HT: 802.11n parameters changed
275 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
276 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
277 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
278 * reason (IBSS and managed mode)
279 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
280 * new beacon (beaconing modes)
281 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
282 * enabled/disabled (beaconing modes)
283 * @BSS_CHANGED_CQM: Connection quality monitor config changed
284 * @BSS_CHANGED_IBSS: IBSS join status changed
285 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
286 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
287 * that it is only ever disabled for station mode.
288 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
289 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
290 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
291 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
292 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
293 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
294 * changed (currently only in P2P client mode, GO mode will be later)
295 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
296 * currently dtim_period only is under consideration.
297 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
298 * note that this is only called when it changes after the channel
299 * context had been assigned.
300 * @BSS_CHANGED_OCB: OCB join status changed
301 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
302 */
303enum ieee80211_bss_change {
304 BSS_CHANGED_ASSOC = 1<<0,
305 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
306 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
307 BSS_CHANGED_ERP_SLOT = 1<<3,
308 BSS_CHANGED_HT = 1<<4,
309 BSS_CHANGED_BASIC_RATES = 1<<5,
310 BSS_CHANGED_BEACON_INT = 1<<6,
311 BSS_CHANGED_BSSID = 1<<7,
312 BSS_CHANGED_BEACON = 1<<8,
313 BSS_CHANGED_BEACON_ENABLED = 1<<9,
314 BSS_CHANGED_CQM = 1<<10,
315 BSS_CHANGED_IBSS = 1<<11,
316 BSS_CHANGED_ARP_FILTER = 1<<12,
317 BSS_CHANGED_QOS = 1<<13,
318 BSS_CHANGED_IDLE = 1<<14,
319 BSS_CHANGED_SSID = 1<<15,
320 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
321 BSS_CHANGED_PS = 1<<17,
322 BSS_CHANGED_TXPOWER = 1<<18,
323 BSS_CHANGED_P2P_PS = 1<<19,
324 BSS_CHANGED_BEACON_INFO = 1<<20,
325 BSS_CHANGED_BANDWIDTH = 1<<21,
326 BSS_CHANGED_OCB = 1<<22,
327 BSS_CHANGED_MU_GROUPS = 1<<23,
328
329 /* when adding here, make sure to change ieee80211_reconfig */
330};
331
332/*
333 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
334 * of addresses for an interface increase beyond this value, hardware ARP
335 * filtering will be disabled.
336 */
337#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
338
339/**
340 * enum ieee80211_event_type - event to be notified to the low level driver
341 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
342 * @MLME_EVENT: event related to MLME
343 * @BAR_RX_EVENT: a BAR was received
344 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
345 * they timed out. This won't be called for each frame released, but only
346 * once each time the timeout triggers.
347 */
348enum ieee80211_event_type {
349 RSSI_EVENT,
350 MLME_EVENT,
351 BAR_RX_EVENT,
352 BA_FRAME_TIMEOUT,
353};
354
355/**
356 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
357 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
358 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
359 */
360enum ieee80211_rssi_event_data {
361 RSSI_EVENT_HIGH,
362 RSSI_EVENT_LOW,
363};
364
365/**
366 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
367 * @data: See &enum ieee80211_rssi_event_data
368 */
369struct ieee80211_rssi_event {
370 enum ieee80211_rssi_event_data data;
371};
372
373/**
374 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
375 * @AUTH_EVENT: the MLME operation is authentication
376 * @ASSOC_EVENT: the MLME operation is association
377 * @DEAUTH_RX_EVENT: deauth received..
378 * @DEAUTH_TX_EVENT: deauth sent.
379 */
380enum ieee80211_mlme_event_data {
381 AUTH_EVENT,
382 ASSOC_EVENT,
383 DEAUTH_RX_EVENT,
384 DEAUTH_TX_EVENT,
385};
386
387/**
388 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
389 * @MLME_SUCCESS: the MLME operation completed successfully.
390 * @MLME_DENIED: the MLME operation was denied by the peer.
391 * @MLME_TIMEOUT: the MLME operation timed out.
392 */
393enum ieee80211_mlme_event_status {
394 MLME_SUCCESS,
395 MLME_DENIED,
396 MLME_TIMEOUT,
397};
398
399/**
400 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
401 * @data: See &enum ieee80211_mlme_event_data
402 * @status: See &enum ieee80211_mlme_event_status
403 * @reason: the reason code if applicable
404 */
405struct ieee80211_mlme_event {
406 enum ieee80211_mlme_event_data data;
407 enum ieee80211_mlme_event_status status;
408 u16 reason;
409};
410
411/**
412 * struct ieee80211_ba_event - data attached for BlockAck related events
413 * @sta: pointer to the &ieee80211_sta to which this event relates
414 * @tid: the tid
415 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
416 */
417struct ieee80211_ba_event {
418 struct ieee80211_sta *sta;
419 u16 tid;
420 u16 ssn;
421};
422
423/**
424 * struct ieee80211_event - event to be sent to the driver
425 * @type: The event itself. See &enum ieee80211_event_type.
426 * @rssi: relevant if &type is %RSSI_EVENT
427 * @mlme: relevant if &type is %AUTH_EVENT
428 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
429 * @u:union holding the fields above
430 */
431struct ieee80211_event {
432 enum ieee80211_event_type type;
433 union {
434 struct ieee80211_rssi_event rssi;
435 struct ieee80211_mlme_event mlme;
436 struct ieee80211_ba_event ba;
437 } u;
438};
439
440/**
441 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
442 *
443 * This structure describes the group id data of VHT MU-MIMO
444 *
445 * @membership: 64 bits array - a bit is set if station is member of the group
446 * @position: 2 bits per group id indicating the position in the group
447 */
448struct ieee80211_mu_group_data {
449 u8 membership[WLAN_MEMBERSHIP_LEN];
450 u8 position[WLAN_USER_POSITION_LEN];
451};
452
453/**
454 * struct ieee80211_bss_conf - holds the BSS's changing parameters
455 *
456 * This structure keeps information about a BSS (and an association
457 * to that BSS) that can change during the lifetime of the BSS.
458 *
459 * @assoc: association status
460 * @ibss_joined: indicates whether this station is part of an IBSS
461 * or not
462 * @ibss_creator: indicates if a new IBSS network is being created
463 * @aid: association ID number, valid only when @assoc is true
464 * @use_cts_prot: use CTS protection
465 * @use_short_preamble: use 802.11b short preamble
466 * @use_short_slot: use short slot time (only relevant for ERP)
467 * @dtim_period: num of beacons before the next DTIM, for beaconing,
468 * valid in station mode only if after the driver was notified
469 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
470 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
471 * as it may have been received during scanning long ago). If the
472 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
473 * only come from a beacon, but might not become valid until after
474 * association when a beacon is received (which is notified with the
475 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
476 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
477 * the driver/device can use this to calculate synchronisation
478 * (see @sync_tsf). See also sync_dtim_count important notice.
479 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
480 * is requested, see @sync_tsf/@sync_device_ts.
481 * IMPORTANT: These three sync_* parameters would possibly be out of sync
482 * by the time the driver will use them. The synchronized view is currently
483 * guaranteed only in certain callbacks.
484 * @beacon_int: beacon interval
485 * @assoc_capability: capabilities taken from assoc resp
486 * @basic_rates: bitmap of basic rates, each bit stands for an
487 * index into the rate table configured by the driver in
488 * the current band.
489 * @beacon_rate: associated AP's beacon TX rate
490 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
491 * @bssid: The BSSID for this BSS
492 * @enable_beacon: whether beaconing should be enabled or not
493 * @chandef: Channel definition for this BSS -- the hardware might be
494 * configured a higher bandwidth than this BSS uses, for example.
495 * @mu_group: VHT MU-MIMO group membership data
496 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
497 * This field is only valid when the channel is a wide HT/VHT channel.
498 * Note that with TDLS this can be the case (channel is HT, protection must
499 * be used from this field) even when the BSS association isn't using HT.
500 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
501 * implies disabled. As with the cfg80211 callback, a change here should
502 * cause an event to be sent indicating where the current value is in
503 * relation to the newly configured threshold.
504 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
505 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
506 * may filter ARP queries targeted for other addresses than listed here.
507 * The driver must allow ARP queries targeted for all address listed here
508 * to pass through. An empty list implies no ARP queries need to pass.
509 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
510 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
511 * array size), it's up to the driver what to do in that case.
512 * @qos: This is a QoS-enabled BSS.
513 * @idle: This interface is idle. There's also a global idle flag in the
514 * hardware config which may be more appropriate depending on what
515 * your driver/device needs to do.
516 * @ps: power-save mode (STA only). This flag is NOT affected by
517 * offchannel/dynamic_ps operations.
518 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
519 * @ssid_len: Length of SSID given in @ssid.
520 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
521 * @txpower: TX power in dBm
522 * @txpower_type: TX power adjustment used to control per packet Transmit
523 * Power Control (TPC) in lower driver for the current vif. In particular
524 * TPC is enabled if value passed in %txpower_type is
525 * NL80211_TX_POWER_LIMITED (allow using less than specified from
526 * userspace), whereas TPC is disabled if %txpower_type is set to
527 * NL80211_TX_POWER_FIXED (use value configured from userspace)
528 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
529 */
530struct ieee80211_bss_conf {
531 const u8 *bssid;
532 /* association related data */
533 bool assoc, ibss_joined;
534 bool ibss_creator;
535 u16 aid;
536 /* erp related data */
537 bool use_cts_prot;
538 bool use_short_preamble;
539 bool use_short_slot;
540 bool enable_beacon;
541 u8 dtim_period;
542 u16 beacon_int;
543 u16 assoc_capability;
544 u64 sync_tsf;
545 u32 sync_device_ts;
546 u8 sync_dtim_count;
547 u32 basic_rates;
548 struct ieee80211_rate *beacon_rate;
549 int mcast_rate[IEEE80211_NUM_BANDS];
550 u16 ht_operation_mode;
551 s32 cqm_rssi_thold;
552 u32 cqm_rssi_hyst;
553 struct cfg80211_chan_def chandef;
554 struct ieee80211_mu_group_data mu_group;
555 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
556 int arp_addr_cnt;
557 bool qos;
558 bool idle;
559 bool ps;
560 u8 ssid[IEEE80211_MAX_SSID_LEN];
561 size_t ssid_len;
562 bool hidden_ssid;
563 int txpower;
564 enum nl80211_tx_power_setting txpower_type;
565 struct ieee80211_p2p_noa_attr p2p_noa_attr;
566};
567
568/**
569 * enum mac80211_tx_info_flags - flags to describe transmission information/status
570 *
571 * These flags are used with the @flags member of &ieee80211_tx_info.
572 *
573 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
574 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
575 * number to this frame, taking care of not overwriting the fragment
576 * number and increasing the sequence number only when the
577 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
578 * assign sequence numbers to QoS-data frames but cannot do so correctly
579 * for non-QoS-data and management frames because beacons need them from
580 * that counter as well and mac80211 cannot guarantee proper sequencing.
581 * If this flag is set, the driver should instruct the hardware to
582 * assign a sequence number to the frame or assign one itself. Cf. IEEE
583 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
584 * beacons and always be clear for frames without a sequence number field.
585 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
586 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
587 * station
588 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
589 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
590 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
591 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
592 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
593 * because the destination STA was in powersave mode. Note that to
594 * avoid race conditions, the filter must be set by the hardware or
595 * firmware upon receiving a frame that indicates that the station
596 * went to sleep (must be done on device to filter frames already on
597 * the queue) and may only be unset after mac80211 gives the OK for
598 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
599 * since only then is it guaranteed that no more frames are in the
600 * hardware queue.
601 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
602 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
603 * is for the whole aggregation.
604 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
605 * so consider using block ack request (BAR).
606 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
607 * set by rate control algorithms to indicate probe rate, will
608 * be cleared for fragmented frames (except on the last fragment)
609 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
610 * that a frame can be transmitted while the queues are stopped for
611 * off-channel operation.
612 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
613 * used to indicate that a pending frame requires TX processing before
614 * it can be sent out.
615 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
616 * used to indicate that a frame was already retried due to PS
617 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
618 * used to indicate frame should not be encrypted
619 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
620 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
621 * be sent although the station is in powersave mode.
622 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
623 * transmit function after the current frame, this can be used
624 * by drivers to kick the DMA queue only if unset or when the
625 * queue gets full.
626 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
627 * after TX status because the destination was asleep, it must not
628 * be modified again (no seqno assignment, crypto, etc.)
629 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
630 * code for connection establishment, this indicates that its status
631 * should kick the MLME state machine.
632 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
633 * MLME command (internal to mac80211 to figure out whether to send TX
634 * status to user space)
635 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
636 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
637 * frame and selects the maximum number of streams that it can use.
638 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
639 * the off-channel channel when a remain-on-channel offload is done
640 * in hardware -- normal packets still flow and are expected to be
641 * handled properly by the device.
642 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
643 * testing. It will be sent out with incorrect Michael MIC key to allow
644 * TKIP countermeasures to be tested.
645 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
646 * This flag is actually used for management frame especially for P2P
647 * frames not being sent at CCK rate in 2GHz band.
648 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
649 * when its status is reported the service period ends. For frames in
650 * an SP that mac80211 transmits, it is already set; for driver frames
651 * the driver may set this flag. It is also used to do the same for
652 * PS-Poll responses.
653 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
654 * This flag is used to send nullfunc frame at minimum rate when
655 * the nullfunc is used for connection monitoring purpose.
656 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
657 * would be fragmented by size (this is optional, only used for
658 * monitor injection).
659 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
660 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
661 * any errors (like issues specific to the driver/HW).
662 * This flag must not be set for frames that don't request no-ack
663 * behaviour with IEEE80211_TX_CTL_NO_ACK.
664 *
665 * Note: If you have to add new flags to the enumeration, then don't
666 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
667 */
668enum mac80211_tx_info_flags {
669 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
670 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
671 IEEE80211_TX_CTL_NO_ACK = BIT(2),
672 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
673 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
674 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
675 IEEE80211_TX_CTL_AMPDU = BIT(6),
676 IEEE80211_TX_CTL_INJECTED = BIT(7),
677 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
678 IEEE80211_TX_STAT_ACK = BIT(9),
679 IEEE80211_TX_STAT_AMPDU = BIT(10),
680 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
681 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
682 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
683 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
684 IEEE80211_TX_INTFL_RETRIED = BIT(15),
685 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
686 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
687 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
688 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
689 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
690 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
691 IEEE80211_TX_CTL_LDPC = BIT(22),
692 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
693 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
694 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
695 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
696 IEEE80211_TX_STATUS_EOSP = BIT(28),
697 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
698 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
699 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
700};
701
702#define IEEE80211_TX_CTL_STBC_SHIFT 23
703
704/**
705 * enum mac80211_tx_control_flags - flags to describe transmit control
706 *
707 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
708 * protocol frame (e.g. EAP)
709 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
710 * frame (PS-Poll or uAPSD).
711 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
712 *
713 * These flags are used in tx_info->control.flags.
714 */
715enum mac80211_tx_control_flags {
716 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
717 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
718 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
719};
720
721/*
722 * This definition is used as a mask to clear all temporary flags, which are
723 * set by the tx handlers for each transmission attempt by the mac80211 stack.
724 */
725#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
726 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
727 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
728 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
729 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
730 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
731 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
732 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
733
734/**
735 * enum mac80211_rate_control_flags - per-rate flags set by the
736 * Rate Control algorithm.
737 *
738 * These flags are set by the Rate control algorithm for each rate during tx,
739 * in the @flags member of struct ieee80211_tx_rate.
740 *
741 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
742 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
743 * This is set if the current BSS requires ERP protection.
744 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
745 * @IEEE80211_TX_RC_MCS: HT rate.
746 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
747 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
748 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
749 * Greenfield mode.
750 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
751 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
752 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
753 * (80+80 isn't supported yet)
754 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
755 * adjacent 20 MHz channels, if the current channel type is
756 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
757 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
758 */
759enum mac80211_rate_control_flags {
760 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
761 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
762 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
763
764 /* rate index is an HT/VHT MCS instead of an index */
765 IEEE80211_TX_RC_MCS = BIT(3),
766 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
767 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
768 IEEE80211_TX_RC_DUP_DATA = BIT(6),
769 IEEE80211_TX_RC_SHORT_GI = BIT(7),
770 IEEE80211_TX_RC_VHT_MCS = BIT(8),
771 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
772 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
773};
774
775
776/* there are 40 bytes if you don't need the rateset to be kept */
777#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
778
779/* if you do need the rateset, then you have less space */
780#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
781
782/* maximum number of rate stages */
783#define IEEE80211_TX_MAX_RATES 4
784
785/* maximum number of rate table entries */
786#define IEEE80211_TX_RATE_TABLE_SIZE 4
787
788/**
789 * struct ieee80211_tx_rate - rate selection/status
790 *
791 * @idx: rate index to attempt to send with
792 * @flags: rate control flags (&enum mac80211_rate_control_flags)
793 * @count: number of tries in this rate before going to the next rate
794 *
795 * A value of -1 for @idx indicates an invalid rate and, if used
796 * in an array of retry rates, that no more rates should be tried.
797 *
798 * When used for transmit status reporting, the driver should
799 * always report the rate along with the flags it used.
800 *
801 * &struct ieee80211_tx_info contains an array of these structs
802 * in the control information, and it will be filled by the rate
803 * control algorithm according to what should be sent. For example,
804 * if this array contains, in the format { <idx>, <count> } the
805 * information
806 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
807 * then this means that the frame should be transmitted
808 * up to twice at rate 3, up to twice at rate 2, and up to four
809 * times at rate 1 if it doesn't get acknowledged. Say it gets
810 * acknowledged by the peer after the fifth attempt, the status
811 * information should then contain
812 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
813 * since it was transmitted twice at rate 3, twice at rate 2
814 * and once at rate 1 after which we received an acknowledgement.
815 */
816struct ieee80211_tx_rate {
817 s8 idx;
818 u16 count:5,
819 flags:11;
820} __packed;
821
822#define IEEE80211_MAX_TX_RETRY 31
823
824static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
825 u8 mcs, u8 nss)
826{
827 WARN_ON(mcs & ~0xF);
828 WARN_ON((nss - 1) & ~0x7);
829 rate->idx = ((nss - 1) << 4) | mcs;
830}
831
832static inline u8
833ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
834{
835 return rate->idx & 0xF;
836}
837
838static inline u8
839ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
840{
841 return (rate->idx >> 4) + 1;
842}
843
844/**
845 * struct ieee80211_tx_info - skb transmit information
846 *
847 * This structure is placed in skb->cb for three uses:
848 * (1) mac80211 TX control - mac80211 tells the driver what to do
849 * (2) driver internal use (if applicable)
850 * (3) TX status information - driver tells mac80211 what happened
851 *
852 * @flags: transmit info flags, defined above
853 * @band: the band to transmit on (use for checking for races)
854 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
855 * @ack_frame_id: internal frame ID for TX status, used internally
856 * @control: union for control data
857 * @status: union for status data
858 * @driver_data: array of driver_data pointers
859 * @ampdu_ack_len: number of acked aggregated frames.
860 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
861 * @ampdu_len: number of aggregated frames.
862 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
863 * @ack_signal: signal strength of the ACK frame
864 */
865struct ieee80211_tx_info {
866 /* common information */
867 u32 flags;
868 u8 band;
869
870 u8 hw_queue;
871
872 u16 ack_frame_id;
873
874 union {
875 struct {
876 union {
877 /* rate control */
878 struct {
879 struct ieee80211_tx_rate rates[
880 IEEE80211_TX_MAX_RATES];
881 s8 rts_cts_rate_idx;
882 u8 use_rts:1;
883 u8 use_cts_prot:1;
884 u8 short_preamble:1;
885 u8 skip_table:1;
886 /* 2 bytes free */
887 };
888 /* only needed before rate control */
889 unsigned long jiffies;
890 };
891 /* NB: vif can be NULL for injected frames */
892 struct ieee80211_vif *vif;
893 struct ieee80211_key_conf *hw_key;
894 u32 flags;
895 /* 4 bytes free */
896 } control;
897 struct {
898 u64 cookie;
899 } ack;
900 struct {
901 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
902 s32 ack_signal;
903 u8 ampdu_ack_len;
904 u8 ampdu_len;
905 u8 antenna;
906 u16 tx_time;
907 void *status_driver_data[19 / sizeof(void *)];
908 } status;
909 struct {
910 struct ieee80211_tx_rate driver_rates[
911 IEEE80211_TX_MAX_RATES];
912 u8 pad[4];
913
914 void *rate_driver_data[
915 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
916 };
917 void *driver_data[
918 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
919 };
920};
921
922/**
923 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
924 *
925 * This structure is used to point to different blocks of IEs in HW scan
926 * and scheduled scan. These blocks contain the IEs passed by userspace
927 * and the ones generated by mac80211.
928 *
929 * @ies: pointers to band specific IEs.
930 * @len: lengths of band_specific IEs.
931 * @common_ies: IEs for all bands (especially vendor specific ones)
932 * @common_ie_len: length of the common_ies
933 */
934struct ieee80211_scan_ies {
935 const u8 *ies[IEEE80211_NUM_BANDS];
936 size_t len[IEEE80211_NUM_BANDS];
937 const u8 *common_ies;
938 size_t common_ie_len;
939};
940
941
942static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
943{
944 return (struct ieee80211_tx_info *)skb->cb;
945}
946
947static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
948{
949 return (struct ieee80211_rx_status *)skb->cb;
950}
951
952/**
953 * ieee80211_tx_info_clear_status - clear TX status
954 *
955 * @info: The &struct ieee80211_tx_info to be cleared.
956 *
957 * When the driver passes an skb back to mac80211, it must report
958 * a number of things in TX status. This function clears everything
959 * in the TX status but the rate control information (it does clear
960 * the count since you need to fill that in anyway).
961 *
962 * NOTE: You can only use this function if you do NOT use
963 * info->driver_data! Use info->rate_driver_data
964 * instead if you need only the less space that allows.
965 */
966static inline void
967ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
968{
969 int i;
970
971 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
972 offsetof(struct ieee80211_tx_info, control.rates));
973 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
974 offsetof(struct ieee80211_tx_info, driver_rates));
975 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
976 /* clear the rate counts */
977 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
978 info->status.rates[i].count = 0;
979
980 BUILD_BUG_ON(
981 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
982 memset(&info->status.ampdu_ack_len, 0,
983 sizeof(struct ieee80211_tx_info) -
984 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
985}
986
987
988/**
989 * enum mac80211_rx_flags - receive flags
990 *
991 * These flags are used with the @flag member of &struct ieee80211_rx_status.
992 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
993 * Use together with %RX_FLAG_MMIC_STRIPPED.
994 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
995 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
996 * verification has been done by the hardware.
997 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
998 * If this flag is set, the stack cannot do any replay detection
999 * hence the driver or hardware will have to do that.
1000 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1001 * flag indicates that the PN was verified for replay protection.
1002 * Note that this flag is also currently only supported when a frame
1003 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1004 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1005 * de-duplication by itself.
1006 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1007 * the frame.
1008 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1009 * the frame.
1010 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1011 * field) is valid and contains the time the first symbol of the MPDU
1012 * was received. This is useful in monitor mode and for proper IBSS
1013 * merging.
1014 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1015 * field) is valid and contains the time the last symbol of the MPDU
1016 * (including FCS) was received.
1017 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1018 * field) is valid and contains the time the SYNC preamble was received.
1019 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
1020 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
1021 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index
1022 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
1023 * @RX_FLAG_SHORT_GI: Short guard interval was used
1024 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1025 * Valid only for data frames (mainly A-MPDU)
1026 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if
1027 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1028 * to hw.radiotap_mcs_details to advertise that fact
1029 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1030 * number (@ampdu_reference) must be populated and be a distinct number for
1031 * each A-MPDU
1032 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1033 * subframes of a single A-MPDU
1034 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1035 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1036 * on this subframe
1037 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1038 * is stored in the @ampdu_delimiter_crc field)
1039 * @RX_FLAG_LDPC: LDPC was used
1040 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1041 * processing it in any regular way.
1042 * This is useful if drivers offload some frames but still want to report
1043 * them for sniffing purposes.
1044 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1045 * monitor interfaces.
1046 * This is useful if drivers offload some frames but still want to report
1047 * them for sniffing purposes.
1048 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1049 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used
1050 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used
1051 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1052 * subframes instead of a one huge frame for performance reasons.
1053 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1054 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1055 * the 3rd (last) one must not have this flag set. The flag is used to
1056 * deal with retransmission/duplication recovery properly since A-MSDU
1057 * subframes share the same sequence number. Reported subframes can be
1058 * either regular MSDU or singly A-MSDUs. Subframes must not be
1059 * interleaved with other frames.
1060 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1061 * radiotap data in the skb->data (before the frame) as described by
1062 * the &struct ieee80211_vendor_radiotap.
1063 */
1064enum mac80211_rx_flags {
1065 RX_FLAG_MMIC_ERROR = BIT(0),
1066 RX_FLAG_DECRYPTED = BIT(1),
1067 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1068 RX_FLAG_MMIC_STRIPPED = BIT(3),
1069 RX_FLAG_IV_STRIPPED = BIT(4),
1070 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1071 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1072 RX_FLAG_MACTIME_START = BIT(7),
1073 RX_FLAG_SHORTPRE = BIT(8),
1074 RX_FLAG_HT = BIT(9),
1075 RX_FLAG_40MHZ = BIT(10),
1076 RX_FLAG_SHORT_GI = BIT(11),
1077 RX_FLAG_NO_SIGNAL_VAL = BIT(12),
1078 RX_FLAG_HT_GF = BIT(13),
1079 RX_FLAG_AMPDU_DETAILS = BIT(14),
1080 RX_FLAG_PN_VALIDATED = BIT(15),
1081 RX_FLAG_DUP_VALIDATED = BIT(16),
1082 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17),
1083 RX_FLAG_AMPDU_IS_LAST = BIT(18),
1084 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19),
1085 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20),
1086 RX_FLAG_MACTIME_END = BIT(21),
1087 RX_FLAG_VHT = BIT(22),
1088 RX_FLAG_LDPC = BIT(23),
1089 RX_FLAG_ONLY_MONITOR = BIT(24),
1090 RX_FLAG_SKIP_MONITOR = BIT(25),
1091 RX_FLAG_STBC_MASK = BIT(26) | BIT(27),
1092 RX_FLAG_10MHZ = BIT(28),
1093 RX_FLAG_5MHZ = BIT(29),
1094 RX_FLAG_AMSDU_MORE = BIT(30),
1095 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31),
1096};
1097
1098#define RX_FLAG_STBC_SHIFT 26
1099
1100/**
1101 * enum mac80211_rx_vht_flags - receive VHT flags
1102 *
1103 * These flags are used with the @vht_flag member of
1104 * &struct ieee80211_rx_status.
1105 * @RX_VHT_FLAG_80MHZ: 80 MHz was used
1106 * @RX_VHT_FLAG_160MHZ: 160 MHz was used
1107 * @RX_VHT_FLAG_BF: packet was beamformed
1108 */
1109
1110enum mac80211_rx_vht_flags {
1111 RX_VHT_FLAG_80MHZ = BIT(0),
1112 RX_VHT_FLAG_160MHZ = BIT(1),
1113 RX_VHT_FLAG_BF = BIT(2),
1114};
1115
1116/**
1117 * struct ieee80211_rx_status - receive status
1118 *
1119 * The low-level driver should provide this information (the subset
1120 * supported by hardware) to the 802.11 code with each received
1121 * frame, in the skb's control buffer (cb).
1122 *
1123 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1124 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1125 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1126 * it but can store it and pass it back to the driver for synchronisation
1127 * @band: the active band when this frame was received
1128 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1129 * This field must be set for management frames, but isn't strictly needed
1130 * for data (other) frames - for those it only affects radiotap reporting.
1131 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1132 * unspecified depending on the hardware capabilities flags
1133 * @IEEE80211_HW_SIGNAL_*
1134 * @chains: bitmask of receive chains for which separate signal strength
1135 * values were filled.
1136 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1137 * support dB or unspecified units)
1138 * @antenna: antenna used
1139 * @rate_idx: index of data rate into band's supported rates or MCS index if
1140 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1141 * @vht_nss: number of streams (VHT only)
1142 * @flag: %RX_FLAG_*
1143 * @vht_flag: %RX_VHT_FLAG_*
1144 * @rx_flags: internal RX flags for mac80211
1145 * @ampdu_reference: A-MPDU reference number, must be a different value for
1146 * each A-MPDU but the same for each subframe within one A-MPDU
1147 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1148 */
1149struct ieee80211_rx_status {
1150 u64 mactime;
1151 u32 device_timestamp;
1152 u32 ampdu_reference;
1153 u32 flag;
1154 u16 freq;
1155 u8 vht_flag;
1156 u8 rate_idx;
1157 u8 vht_nss;
1158 u8 rx_flags;
1159 u8 band;
1160 u8 antenna;
1161 s8 signal;
1162 u8 chains;
1163 s8 chain_signal[IEEE80211_MAX_CHAINS];
1164 u8 ampdu_delimiter_crc;
1165};
1166
1167/**
1168 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1169 * @present: presence bitmap for this vendor namespace
1170 * (this could be extended in the future if any vendor needs more
1171 * bits, the radiotap spec does allow for that)
1172 * @align: radiotap vendor namespace alignment. This defines the needed
1173 * alignment for the @data field below, not for the vendor namespace
1174 * description itself (which has a fixed 2-byte alignment)
1175 * Must be a power of two, and be set to at least 1!
1176 * @oui: radiotap vendor namespace OUI
1177 * @subns: radiotap vendor sub namespace
1178 * @len: radiotap vendor sub namespace skip length, if alignment is done
1179 * then that's added to this, i.e. this is only the length of the
1180 * @data field.
1181 * @pad: number of bytes of padding after the @data, this exists so that
1182 * the skb data alignment can be preserved even if the data has odd
1183 * length
1184 * @data: the actual vendor namespace data
1185 *
1186 * This struct, including the vendor data, goes into the skb->data before
1187 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1188 * data.
1189 */
1190struct ieee80211_vendor_radiotap {
1191 u32 present;
1192 u8 align;
1193 u8 oui[3];
1194 u8 subns;
1195 u8 pad;
1196 u16 len;
1197 u8 data[];
1198} __packed;
1199
1200/**
1201 * enum ieee80211_conf_flags - configuration flags
1202 *
1203 * Flags to define PHY configuration options
1204 *
1205 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1206 * to determine for example whether to calculate timestamps for packets
1207 * or not, do not use instead of filter flags!
1208 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1209 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1210 * meaning that the hardware still wakes up for beacons, is able to
1211 * transmit frames and receive the possible acknowledgment frames.
1212 * Not to be confused with hardware specific wakeup/sleep states,
1213 * driver is responsible for that. See the section "Powersave support"
1214 * for more.
1215 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1216 * the driver should be prepared to handle configuration requests but
1217 * may turn the device off as much as possible. Typically, this flag will
1218 * be set when an interface is set UP but not associated or scanning, but
1219 * it can also be unset in that case when monitor interfaces are active.
1220 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1221 * operating channel.
1222 */
1223enum ieee80211_conf_flags {
1224 IEEE80211_CONF_MONITOR = (1<<0),
1225 IEEE80211_CONF_PS = (1<<1),
1226 IEEE80211_CONF_IDLE = (1<<2),
1227 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1228};
1229
1230
1231/**
1232 * enum ieee80211_conf_changed - denotes which configuration changed
1233 *
1234 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1235 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1236 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1237 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1238 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1239 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1240 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1241 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1242 * Note that this is only valid if channel contexts are not used,
1243 * otherwise each channel context has the number of chains listed.
1244 */
1245enum ieee80211_conf_changed {
1246 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1247 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1248 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1249 IEEE80211_CONF_CHANGE_PS = BIT(4),
1250 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1251 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1252 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1253 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1254};
1255
1256/**
1257 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1258 *
1259 * @IEEE80211_SMPS_AUTOMATIC: automatic
1260 * @IEEE80211_SMPS_OFF: off
1261 * @IEEE80211_SMPS_STATIC: static
1262 * @IEEE80211_SMPS_DYNAMIC: dynamic
1263 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1264 */
1265enum ieee80211_smps_mode {
1266 IEEE80211_SMPS_AUTOMATIC,
1267 IEEE80211_SMPS_OFF,
1268 IEEE80211_SMPS_STATIC,
1269 IEEE80211_SMPS_DYNAMIC,
1270
1271 /* keep last */
1272 IEEE80211_SMPS_NUM_MODES,
1273};
1274
1275/**
1276 * struct ieee80211_conf - configuration of the device
1277 *
1278 * This struct indicates how the driver shall configure the hardware.
1279 *
1280 * @flags: configuration flags defined above
1281 *
1282 * @listen_interval: listen interval in units of beacon interval
1283 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1284 * in power saving. Power saving will not be enabled until a beacon
1285 * has been received and the DTIM period is known.
1286 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1287 * powersave documentation below. This variable is valid only when
1288 * the CONF_PS flag is set.
1289 *
1290 * @power_level: requested transmit power (in dBm), backward compatibility
1291 * value only that is set to the minimum of all interfaces
1292 *
1293 * @chandef: the channel definition to tune to
1294 * @radar_enabled: whether radar detection is enabled
1295 *
1296 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1297 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1298 * but actually means the number of transmissions not the number of retries
1299 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1300 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1301 * number of transmissions not the number of retries
1302 *
1303 * @smps_mode: spatial multiplexing powersave mode; note that
1304 * %IEEE80211_SMPS_STATIC is used when the device is not
1305 * configured for an HT channel.
1306 * Note that this is only valid if channel contexts are not used,
1307 * otherwise each channel context has the number of chains listed.
1308 */
1309struct ieee80211_conf {
1310 u32 flags;
1311 int power_level, dynamic_ps_timeout;
1312
1313 u16 listen_interval;
1314 u8 ps_dtim_period;
1315
1316 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1317
1318 struct cfg80211_chan_def chandef;
1319 bool radar_enabled;
1320 enum ieee80211_smps_mode smps_mode;
1321};
1322
1323/**
1324 * struct ieee80211_channel_switch - holds the channel switch data
1325 *
1326 * The information provided in this structure is required for channel switch
1327 * operation.
1328 *
1329 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1330 * Function (TSF) timer when the frame containing the channel switch
1331 * announcement was received. This is simply the rx.mactime parameter
1332 * the driver passed into mac80211.
1333 * @device_timestamp: arbitrary timestamp for the device, this is the
1334 * rx.device_timestamp parameter the driver passed to mac80211.
1335 * @block_tx: Indicates whether transmission must be blocked before the
1336 * scheduled channel switch, as indicated by the AP.
1337 * @chandef: the new channel to switch to
1338 * @count: the number of TBTT's until the channel switch event
1339 */
1340struct ieee80211_channel_switch {
1341 u64 timestamp;
1342 u32 device_timestamp;
1343 bool block_tx;
1344 struct cfg80211_chan_def chandef;
1345 u8 count;
1346};
1347
1348/**
1349 * enum ieee80211_vif_flags - virtual interface flags
1350 *
1351 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1352 * on this virtual interface to avoid unnecessary CPU wakeups
1353 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1354 * monitoring on this virtual interface -- i.e. it can monitor
1355 * connection quality related parameters, such as the RSSI level and
1356 * provide notifications if configured trigger levels are reached.
1357 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1358 * interface. This flag should be set during interface addition,
1359 * but may be set/cleared as late as authentication to an AP. It is
1360 * only valid for managed/station mode interfaces.
1361 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1362 * and send P2P_PS notification to the driver if NOA changed, even
1363 * this is not pure P2P vif.
1364 */
1365enum ieee80211_vif_flags {
1366 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1367 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1368 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1369 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1370};
1371
1372/**
1373 * struct ieee80211_vif - per-interface data
1374 *
1375 * Data in this structure is continually present for driver
1376 * use during the life of a virtual interface.
1377 *
1378 * @type: type of this virtual interface
1379 * @bss_conf: BSS configuration for this interface, either our own
1380 * or the BSS we're associated to
1381 * @addr: address of this interface
1382 * @p2p: indicates whether this AP or STA interface is a p2p
1383 * interface, i.e. a GO or p2p-sta respectively
1384 * @csa_active: marks whether a channel switch is going on. Internally it is
1385 * write-protected by sdata_lock and local->mtx so holding either is fine
1386 * for read access.
1387 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1388 * @driver_flags: flags/capabilities the driver has for this interface,
1389 * these need to be set (or cleared) when the interface is added
1390 * or, if supported by the driver, the interface type is changed
1391 * at runtime, mac80211 will never touch this field
1392 * @hw_queue: hardware queue for each AC
1393 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1394 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1395 * when it is not assigned. This pointer is RCU-protected due to the TX
1396 * path needing to access it; even though the netdev carrier will always
1397 * be off when it is %NULL there can still be races and packets could be
1398 * processed after it switches back to %NULL.
1399 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1400 * interface debug files. Note that it will be NULL for the virtual
1401 * monitor interface (if that is requested.)
1402 * @probe_req_reg: probe requests should be reported to mac80211 for this
1403 * interface.
1404 * @drv_priv: data area for driver use, will always be aligned to
1405 * sizeof(void *).
1406 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1407 */
1408struct ieee80211_vif {
1409 enum nl80211_iftype type;
1410 struct ieee80211_bss_conf bss_conf;
1411 u8 addr[ETH_ALEN];
1412 bool p2p;
1413 bool csa_active;
1414 bool mu_mimo_owner;
1415
1416 u8 cab_queue;
1417 u8 hw_queue[IEEE80211_NUM_ACS];
1418
1419 struct ieee80211_txq *txq;
1420
1421 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1422
1423 u32 driver_flags;
1424
1425#ifdef CONFIG_MAC80211_DEBUGFS
1426 struct dentry *debugfs_dir;
1427#endif
1428
1429 unsigned int probe_req_reg;
1430
1431 /* must be last */
1432 u8 drv_priv[0] __aligned(sizeof(void *));
1433};
1434
1435static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1436{
1437#ifdef CONFIG_MAC80211_MESH
1438 return vif->type == NL80211_IFTYPE_MESH_POINT;
1439#endif
1440 return false;
1441}
1442
1443/**
1444 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1445 * @wdev: the wdev to get the vif for
1446 *
1447 * This can be used by mac80211 drivers with direct cfg80211 APIs
1448 * (like the vendor commands) that get a wdev.
1449 *
1450 * Note that this function may return %NULL if the given wdev isn't
1451 * associated with a vif that the driver knows about (e.g. monitor
1452 * or AP_VLAN interfaces.)
1453 */
1454struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1455
1456/**
1457 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1458 * @vif: the vif to get the wdev for
1459 *
1460 * This can be used by mac80211 drivers with direct cfg80211 APIs
1461 * (like the vendor commands) that needs to get the wdev for a vif.
1462 *
1463 * Note that this function may return %NULL if the given wdev isn't
1464 * associated with a vif that the driver knows about (e.g. monitor
1465 * or AP_VLAN interfaces.)
1466 */
1467struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1468
1469/**
1470 * enum ieee80211_key_flags - key flags
1471 *
1472 * These flags are used for communication about keys between the driver
1473 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1474 *
1475 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1476 * driver to indicate that it requires IV generation for this
1477 * particular key. Setting this flag does not necessarily mean that SKBs
1478 * will have sufficient tailroom for ICV or MIC.
1479 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1480 * the driver for a TKIP key if it requires Michael MIC
1481 * generation in software.
1482 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1483 * that the key is pairwise rather then a shared key.
1484 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1485 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1486 * (MFP) to be done in software.
1487 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1488 * if space should be prepared for the IV, but the IV
1489 * itself should not be generated. Do not set together with
1490 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1491 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1492 * MIC.
1493 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1494 * management frames. The flag can help drivers that have a hardware
1495 * crypto implementation that doesn't deal with management frames
1496 * properly by allowing them to not upload the keys to hardware and
1497 * fall back to software crypto. Note that this flag deals only with
1498 * RX, if your crypto engine can't deal with TX you can also set the
1499 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1500 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1501 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1502 * only for managment frames (MFP).
1503 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1504 * driver for a key to indicate that sufficient tailroom must always
1505 * be reserved for ICV or MIC, even when HW encryption is enabled.
1506 */
1507enum ieee80211_key_flags {
1508 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1509 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1510 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1511 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1512 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1513 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1514 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1515 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1516};
1517
1518/**
1519 * struct ieee80211_key_conf - key information
1520 *
1521 * This key information is given by mac80211 to the driver by
1522 * the set_key() callback in &struct ieee80211_ops.
1523 *
1524 * @hw_key_idx: To be set by the driver, this is the key index the driver
1525 * wants to be given when a frame is transmitted and needs to be
1526 * encrypted in hardware.
1527 * @cipher: The key's cipher suite selector.
1528 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1529 * needs to do software PN assignment by itself (e.g. due to TSO)
1530 * @flags: key flags, see &enum ieee80211_key_flags.
1531 * @keyidx: the key index (0-3)
1532 * @keylen: key material length
1533 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1534 * data block:
1535 * - Temporal Encryption Key (128 bits)
1536 * - Temporal Authenticator Tx MIC Key (64 bits)
1537 * - Temporal Authenticator Rx MIC Key (64 bits)
1538 * @icv_len: The ICV length for this key type
1539 * @iv_len: The IV length for this key type
1540 */
1541struct ieee80211_key_conf {
1542 atomic64_t tx_pn;
1543 u32 cipher;
1544 u8 icv_len;
1545 u8 iv_len;
1546 u8 hw_key_idx;
1547 u8 flags;
1548 s8 keyidx;
1549 u8 keylen;
1550 u8 key[0];
1551};
1552
1553#define IEEE80211_MAX_PN_LEN 16
1554
1555#define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1556#define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1557
1558/**
1559 * struct ieee80211_key_seq - key sequence counter
1560 *
1561 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1562 * @ccmp: PN data, most significant byte first (big endian,
1563 * reverse order than in packet)
1564 * @aes_cmac: PN data, most significant byte first (big endian,
1565 * reverse order than in packet)
1566 * @aes_gmac: PN data, most significant byte first (big endian,
1567 * reverse order than in packet)
1568 * @gcmp: PN data, most significant byte first (big endian,
1569 * reverse order than in packet)
1570 * @hw: data for HW-only (e.g. cipher scheme) keys
1571 */
1572struct ieee80211_key_seq {
1573 union {
1574 struct {
1575 u32 iv32;
1576 u16 iv16;
1577 } tkip;
1578 struct {
1579 u8 pn[6];
1580 } ccmp;
1581 struct {
1582 u8 pn[6];
1583 } aes_cmac;
1584 struct {
1585 u8 pn[6];
1586 } aes_gmac;
1587 struct {
1588 u8 pn[6];
1589 } gcmp;
1590 struct {
1591 u8 seq[IEEE80211_MAX_PN_LEN];
1592 u8 seq_len;
1593 } hw;
1594 };
1595};
1596
1597/**
1598 * struct ieee80211_cipher_scheme - cipher scheme
1599 *
1600 * This structure contains a cipher scheme information defining
1601 * the secure packet crypto handling.
1602 *
1603 * @cipher: a cipher suite selector
1604 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1605 * @hdr_len: a length of a security header used the cipher
1606 * @pn_len: a length of a packet number in the security header
1607 * @pn_off: an offset of pn from the beginning of the security header
1608 * @key_idx_off: an offset of key index byte in the security header
1609 * @key_idx_mask: a bit mask of key_idx bits
1610 * @key_idx_shift: a bit shift needed to get key_idx
1611 * key_idx value calculation:
1612 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1613 * @mic_len: a mic length in bytes
1614 */
1615struct ieee80211_cipher_scheme {
1616 u32 cipher;
1617 u16 iftype;
1618 u8 hdr_len;
1619 u8 pn_len;
1620 u8 pn_off;
1621 u8 key_idx_off;
1622 u8 key_idx_mask;
1623 u8 key_idx_shift;
1624 u8 mic_len;
1625};
1626
1627/**
1628 * enum set_key_cmd - key command
1629 *
1630 * Used with the set_key() callback in &struct ieee80211_ops, this
1631 * indicates whether a key is being removed or added.
1632 *
1633 * @SET_KEY: a key is set
1634 * @DISABLE_KEY: a key must be disabled
1635 */
1636enum set_key_cmd {
1637 SET_KEY, DISABLE_KEY,
1638};
1639
1640/**
1641 * enum ieee80211_sta_state - station state
1642 *
1643 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1644 * this is a special state for add/remove transitions
1645 * @IEEE80211_STA_NONE: station exists without special state
1646 * @IEEE80211_STA_AUTH: station is authenticated
1647 * @IEEE80211_STA_ASSOC: station is associated
1648 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1649 */
1650enum ieee80211_sta_state {
1651 /* NOTE: These need to be ordered correctly! */
1652 IEEE80211_STA_NOTEXIST,
1653 IEEE80211_STA_NONE,
1654 IEEE80211_STA_AUTH,
1655 IEEE80211_STA_ASSOC,
1656 IEEE80211_STA_AUTHORIZED,
1657};
1658
1659/**
1660 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1661 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1662 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1663 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1664 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1665 * (including 80+80 MHz)
1666 *
1667 * Implementation note: 20 must be zero to be initialized
1668 * correctly, the values must be sorted.
1669 */
1670enum ieee80211_sta_rx_bandwidth {
1671 IEEE80211_STA_RX_BW_20 = 0,
1672 IEEE80211_STA_RX_BW_40,
1673 IEEE80211_STA_RX_BW_80,
1674 IEEE80211_STA_RX_BW_160,
1675};
1676
1677/**
1678 * struct ieee80211_sta_rates - station rate selection table
1679 *
1680 * @rcu_head: RCU head used for freeing the table on update
1681 * @rate: transmit rates/flags to be used by default.
1682 * Overriding entries per-packet is possible by using cb tx control.
1683 */
1684struct ieee80211_sta_rates {
1685 struct rcu_head rcu_head;
1686 struct {
1687 s8 idx;
1688 u8 count;
1689 u8 count_cts;
1690 u8 count_rts;
1691 u16 flags;
1692 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1693};
1694
1695/**
1696 * struct ieee80211_sta - station table entry
1697 *
1698 * A station table entry represents a station we are possibly
1699 * communicating with. Since stations are RCU-managed in
1700 * mac80211, any ieee80211_sta pointer you get access to must
1701 * either be protected by rcu_read_lock() explicitly or implicitly,
1702 * or you must take good care to not use such a pointer after a
1703 * call to your sta_remove callback that removed it.
1704 *
1705 * @addr: MAC address
1706 * @aid: AID we assigned to the station if we're an AP
1707 * @supp_rates: Bitmap of supported rates (per band)
1708 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1709 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1710 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1711 * otherwise always false)
1712 * @drv_priv: data area for driver use, will always be aligned to
1713 * sizeof(void *), size is determined in hw information.
1714 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1715 * if wme is supported.
1716 * @max_sp: max Service Period. Only valid if wme is supported.
1717 * @bandwidth: current bandwidth the station can receive with
1718 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1719 * station can receive at the moment, changed by operating mode
1720 * notifications and capabilities. The value is only valid after
1721 * the station moves to associated state.
1722 * @smps_mode: current SMPS mode (off, static or dynamic)
1723 * @rates: rate control selection table
1724 * @tdls: indicates whether the STA is a TDLS peer
1725 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1726 * valid if the STA is a TDLS peer in the first place.
1727 * @mfp: indicates whether the STA uses management frame protection or not.
1728 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1729 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1730 * unlimited.
1731 * @max_amsdu_len: indicates the maximal length of an A-MSDU in bytes. This
1732 * field is always valid for packets with a VHT preamble. For packets
1733 * with a HT preamble, additional limits apply:
1734 * + If the skb is transmitted as part of a BA agreement, the
1735 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1736 * + If the skb is not part of a BA aggreement, the A-MSDU maximal
1737 * size is min(max_amsdu_len, 7935) bytes.
1738 * Both additional HT limits must be enforced by the low level driver.
1739 * This is defined by the spec (IEEE 802.11-2012 section 8.3.2.2 NOTE 2).
1740 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1741 */
1742struct ieee80211_sta {
1743 u32 supp_rates[IEEE80211_NUM_BANDS];
1744 u8 addr[ETH_ALEN];
1745 u16 aid;
1746 struct ieee80211_sta_ht_cap ht_cap;
1747 struct ieee80211_sta_vht_cap vht_cap;
1748 bool wme;
1749 u8 uapsd_queues;
1750 u8 max_sp;
1751 u8 rx_nss;
1752 enum ieee80211_sta_rx_bandwidth bandwidth;
1753 enum ieee80211_smps_mode smps_mode;
1754 struct ieee80211_sta_rates __rcu *rates;
1755 bool tdls;
1756 bool tdls_initiator;
1757 bool mfp;
1758 u8 max_amsdu_subframes;
1759 u16 max_amsdu_len;
1760
1761 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1762
1763 /* must be last */
1764 u8 drv_priv[0] __aligned(sizeof(void *));
1765};
1766
1767/**
1768 * enum sta_notify_cmd - sta notify command
1769 *
1770 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1771 * indicates if an associated station made a power state transition.
1772 *
1773 * @STA_NOTIFY_SLEEP: a station is now sleeping
1774 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1775 */
1776enum sta_notify_cmd {
1777 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1778};
1779
1780/**
1781 * struct ieee80211_tx_control - TX control data
1782 *
1783 * @sta: station table entry, this sta pointer may be NULL and
1784 * it is not allowed to copy the pointer, due to RCU.
1785 */
1786struct ieee80211_tx_control {
1787 struct ieee80211_sta *sta;
1788};
1789
1790/**
1791 * struct ieee80211_txq - Software intermediate tx queue
1792 *
1793 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1794 * @sta: station table entry, %NULL for per-vif queue
1795 * @tid: the TID for this queue (unused for per-vif queue)
1796 * @ac: the AC for this queue
1797 * @drv_priv: driver private area, sized by hw->txq_data_size
1798 *
1799 * The driver can obtain packets from this queue by calling
1800 * ieee80211_tx_dequeue().
1801 */
1802struct ieee80211_txq {
1803 struct ieee80211_vif *vif;
1804 struct ieee80211_sta *sta;
1805 u8 tid;
1806 u8 ac;
1807
1808 /* must be last */
1809 u8 drv_priv[0] __aligned(sizeof(void *));
1810};
1811
1812/**
1813 * enum ieee80211_hw_flags - hardware flags
1814 *
1815 * These flags are used to indicate hardware capabilities to
1816 * the stack. Generally, flags here should have their meaning
1817 * done in a way that the simplest hardware doesn't need setting
1818 * any particular flags. There are some exceptions to this rule,
1819 * however, so you are advised to review these flags carefully.
1820 *
1821 * @IEEE80211_HW_HAS_RATE_CONTROL:
1822 * The hardware or firmware includes rate control, and cannot be
1823 * controlled by the stack. As such, no rate control algorithm
1824 * should be instantiated, and the TX rate reported to userspace
1825 * will be taken from the TX status instead of the rate control
1826 * algorithm.
1827 * Note that this requires that the driver implement a number of
1828 * callbacks so it has the correct information, it needs to have
1829 * the @set_rts_threshold callback and must look at the BSS config
1830 * @use_cts_prot for G/N protection, @use_short_slot for slot
1831 * timing in 2.4 GHz and @use_short_preamble for preambles for
1832 * CCK frames.
1833 *
1834 * @IEEE80211_HW_RX_INCLUDES_FCS:
1835 * Indicates that received frames passed to the stack include
1836 * the FCS at the end.
1837 *
1838 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1839 * Some wireless LAN chipsets buffer broadcast/multicast frames
1840 * for power saving stations in the hardware/firmware and others
1841 * rely on the host system for such buffering. This option is used
1842 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1843 * multicast frames when there are power saving stations so that
1844 * the driver can fetch them with ieee80211_get_buffered_bc().
1845 *
1846 * @IEEE80211_HW_SIGNAL_UNSPEC:
1847 * Hardware can provide signal values but we don't know its units. We
1848 * expect values between 0 and @max_signal.
1849 * If possible please provide dB or dBm instead.
1850 *
1851 * @IEEE80211_HW_SIGNAL_DBM:
1852 * Hardware gives signal values in dBm, decibel difference from
1853 * one milliwatt. This is the preferred method since it is standardized
1854 * between different devices. @max_signal does not need to be set.
1855 *
1856 * @IEEE80211_HW_SPECTRUM_MGMT:
1857 * Hardware supports spectrum management defined in 802.11h
1858 * Measurement, Channel Switch, Quieting, TPC
1859 *
1860 * @IEEE80211_HW_AMPDU_AGGREGATION:
1861 * Hardware supports 11n A-MPDU aggregation.
1862 *
1863 * @IEEE80211_HW_SUPPORTS_PS:
1864 * Hardware has power save support (i.e. can go to sleep).
1865 *
1866 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1867 * Hardware requires nullfunc frame handling in stack, implies
1868 * stack support for dynamic PS.
1869 *
1870 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1871 * Hardware has support for dynamic PS.
1872 *
1873 * @IEEE80211_HW_MFP_CAPABLE:
1874 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1875 *
1876 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1877 * Hardware can provide ack status reports of Tx frames to
1878 * the stack.
1879 *
1880 * @IEEE80211_HW_CONNECTION_MONITOR:
1881 * The hardware performs its own connection monitoring, including
1882 * periodic keep-alives to the AP and probing the AP on beacon loss.
1883 *
1884 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1885 * This device needs to get data from beacon before association (i.e.
1886 * dtim_period).
1887 *
1888 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1889 * per-station GTKs as used by IBSS RSN or during fast transition. If
1890 * the device doesn't support per-station GTKs, but can be asked not
1891 * to decrypt group addressed frames, then IBSS RSN support is still
1892 * possible but software crypto will be used. Advertise the wiphy flag
1893 * only in that case.
1894 *
1895 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1896 * autonomously manages the PS status of connected stations. When
1897 * this flag is set mac80211 will not trigger PS mode for connected
1898 * stations based on the PM bit of incoming frames.
1899 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1900 * the PS mode of connected stations.
1901 *
1902 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1903 * setup strictly in HW. mac80211 should not attempt to do this in
1904 * software.
1905 *
1906 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1907 * a virtual monitor interface when monitor interfaces are the only
1908 * active interfaces.
1909 *
1910 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1911 * be created. It is expected user-space will create vifs as
1912 * desired (and thus have them named as desired).
1913 *
1914 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1915 * crypto algorithms can be done in software - so don't automatically
1916 * try to fall back to it if hardware crypto fails, but do so only if
1917 * the driver returns 1. This also forces the driver to advertise its
1918 * supported cipher suites.
1919 *
1920 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
1921 * this currently requires only the ability to calculate the duration
1922 * for frames.
1923 *
1924 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
1925 * queue mapping in order to use different queues (not just one per AC)
1926 * for different virtual interfaces. See the doc section on HW queue
1927 * control for more details.
1928 *
1929 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
1930 * selection table provided by the rate control algorithm.
1931 *
1932 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
1933 * P2P Interface. This will be honoured even if more than one interface
1934 * is supported.
1935 *
1936 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
1937 * only, to allow getting TBTT of a DTIM beacon.
1938 *
1939 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
1940 * and can cope with CCK rates in an aggregation session (e.g. by not
1941 * using aggregation for such frames.)
1942 *
1943 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
1944 * for a single active channel while using channel contexts. When support
1945 * is not enabled the default action is to disconnect when getting the
1946 * CSA frame.
1947 *
1948 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
1949 * or tailroom of TX skbs without copying them first.
1950 *
1951 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
1952 * in one command, mac80211 doesn't have to run separate scans per band.
1953 *
1954 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
1955 * than then BSS bandwidth for a TDLS link on the base channel.
1956 *
1957 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
1958 * within A-MPDU.
1959 *
1960 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
1961 * for sent beacons.
1962 *
1963 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
1964 * station has a unique address, i.e. each station entry can be identified
1965 * by just its MAC address; this prevents, for example, the same station
1966 * from connecting to two virtual AP interfaces at the same time.
1967 *
1968 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
1969 * reordering buffer internally, guaranteeing mac80211 receives frames in
1970 * order and does not need to manage its own reorder buffer or BA session
1971 * timeout.
1972 *
1973 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
1974 */
1975enum ieee80211_hw_flags {
1976 IEEE80211_HW_HAS_RATE_CONTROL,
1977 IEEE80211_HW_RX_INCLUDES_FCS,
1978 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
1979 IEEE80211_HW_SIGNAL_UNSPEC,
1980 IEEE80211_HW_SIGNAL_DBM,
1981 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
1982 IEEE80211_HW_SPECTRUM_MGMT,
1983 IEEE80211_HW_AMPDU_AGGREGATION,
1984 IEEE80211_HW_SUPPORTS_PS,
1985 IEEE80211_HW_PS_NULLFUNC_STACK,
1986 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
1987 IEEE80211_HW_MFP_CAPABLE,
1988 IEEE80211_HW_WANT_MONITOR_VIF,
1989 IEEE80211_HW_NO_AUTO_VIF,
1990 IEEE80211_HW_SW_CRYPTO_CONTROL,
1991 IEEE80211_HW_SUPPORT_FAST_XMIT,
1992 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
1993 IEEE80211_HW_CONNECTION_MONITOR,
1994 IEEE80211_HW_QUEUE_CONTROL,
1995 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
1996 IEEE80211_HW_AP_LINK_PS,
1997 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
1998 IEEE80211_HW_SUPPORTS_RC_TABLE,
1999 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2000 IEEE80211_HW_TIMING_BEACON_ONLY,
2001 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2002 IEEE80211_HW_CHANCTX_STA_CSA,
2003 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2004 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2005 IEEE80211_HW_TDLS_WIDER_BW,
2006 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2007 IEEE80211_HW_BEACON_TX_STATUS,
2008 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2009 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2010
2011 /* keep last, obviously */
2012 NUM_IEEE80211_HW_FLAGS
2013};
2014
2015/**
2016 * struct ieee80211_hw - hardware information and state
2017 *
2018 * This structure contains the configuration and hardware
2019 * information for an 802.11 PHY.
2020 *
2021 * @wiphy: This points to the &struct wiphy allocated for this
2022 * 802.11 PHY. You must fill in the @perm_addr and @dev
2023 * members of this structure using SET_IEEE80211_DEV()
2024 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2025 * bands (with channels, bitrates) are registered here.
2026 *
2027 * @conf: &struct ieee80211_conf, device configuration, don't use.
2028 *
2029 * @priv: pointer to private area that was allocated for driver use
2030 * along with this structure.
2031 *
2032 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2033 *
2034 * @extra_tx_headroom: headroom to reserve in each transmit skb
2035 * for use by the driver (e.g. for transmit headers.)
2036 *
2037 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2038 * Can be used by drivers to add extra IEs.
2039 *
2040 * @max_signal: Maximum value for signal (rssi) in RX information, used
2041 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2042 *
2043 * @max_listen_interval: max listen interval in units of beacon interval
2044 * that HW supports
2045 *
2046 * @queues: number of available hardware transmit queues for
2047 * data packets. WMM/QoS requires at least four, these
2048 * queues need to have configurable access parameters.
2049 *
2050 * @rate_control_algorithm: rate control algorithm for this hardware.
2051 * If unset (NULL), the default algorithm will be used. Must be
2052 * set before calling ieee80211_register_hw().
2053 *
2054 * @vif_data_size: size (in bytes) of the drv_priv data area
2055 * within &struct ieee80211_vif.
2056 * @sta_data_size: size (in bytes) of the drv_priv data area
2057 * within &struct ieee80211_sta.
2058 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2059 * within &struct ieee80211_chanctx_conf.
2060 * @txq_data_size: size (in bytes) of the drv_priv data area
2061 * within @struct ieee80211_txq.
2062 *
2063 * @max_rates: maximum number of alternate rate retry stages the hw
2064 * can handle.
2065 * @max_report_rates: maximum number of alternate rate retry stages
2066 * the hw can report back.
2067 * @max_rate_tries: maximum number of tries for each stage
2068 *
2069 * @max_rx_aggregation_subframes: maximum buffer size (number of
2070 * sub-frames) to be used for A-MPDU block ack receiver
2071 * aggregation.
2072 * This is only relevant if the device has restrictions on the
2073 * number of subframes, if it relies on mac80211 to do reordering
2074 * it shouldn't be set.
2075 *
2076 * @max_tx_aggregation_subframes: maximum number of subframes in an
2077 * aggregate an HT driver will transmit. Though ADDBA will advertise
2078 * a constant value of 64 as some older APs can crash if the window
2079 * size is smaller (an example is LinkSys WRT120N with FW v1.0.07
2080 * build 002 Jun 18 2012).
2081 *
2082 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2083 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2084 *
2085 * @radiotap_mcs_details: lists which MCS information can the HW
2086 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2087 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only
2088 * adding _BW is supported today.
2089 *
2090 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2091 * the default is _GI | _BANDWIDTH.
2092 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values.
2093 *
2094 * @netdev_features: netdev features to be set in each netdev created
2095 * from this HW. Note that not all features are usable with mac80211,
2096 * other features will be rejected during HW registration.
2097 *
2098 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2099 * for each access category if it is uAPSD trigger-enabled and delivery-
2100 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2101 * Each bit corresponds to different AC. Value '1' in specific bit means
2102 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2103 * neither enabled.
2104 *
2105 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2106 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2107 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2108 *
2109 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2110 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2111 * supported by HW.
2112 *
2113 * @txq_ac_max_pending: maximum number of frames per AC pending in all txq
2114 * entries for a vif.
2115 */
2116struct ieee80211_hw {
2117 struct ieee80211_conf conf;
2118 struct wiphy *wiphy;
2119 const char *rate_control_algorithm;
2120 void *priv;
2121 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2122 unsigned int extra_tx_headroom;
2123 unsigned int extra_beacon_tailroom;
2124 int vif_data_size;
2125 int sta_data_size;
2126 int chanctx_data_size;
2127 int txq_data_size;
2128 u16 queues;
2129 u16 max_listen_interval;
2130 s8 max_signal;
2131 u8 max_rates;
2132 u8 max_report_rates;
2133 u8 max_rate_tries;
2134 u8 max_rx_aggregation_subframes;
2135 u8 max_tx_aggregation_subframes;
2136 u8 offchannel_tx_hw_queue;
2137 u8 radiotap_mcs_details;
2138 u16 radiotap_vht_details;
2139 netdev_features_t netdev_features;
2140 u8 uapsd_queues;
2141 u8 uapsd_max_sp_len;
2142 u8 n_cipher_schemes;
2143 const struct ieee80211_cipher_scheme *cipher_schemes;
2144 int txq_ac_max_pending;
2145};
2146
2147static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2148 enum ieee80211_hw_flags flg)
2149{
2150 return test_bit(flg, hw->flags);
2151}
2152#define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2153
2154static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2155 enum ieee80211_hw_flags flg)
2156{
2157 return __set_bit(flg, hw->flags);
2158}
2159#define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2160
2161/**
2162 * struct ieee80211_scan_request - hw scan request
2163 *
2164 * @ies: pointers different parts of IEs (in req.ie)
2165 * @req: cfg80211 request.
2166 */
2167struct ieee80211_scan_request {
2168 struct ieee80211_scan_ies ies;
2169
2170 /* Keep last */
2171 struct cfg80211_scan_request req;
2172};
2173
2174/**
2175 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2176 *
2177 * @sta: peer this TDLS channel-switch request/response came from
2178 * @chandef: channel referenced in a TDLS channel-switch request
2179 * @action_code: see &enum ieee80211_tdls_actioncode
2180 * @status: channel-switch response status
2181 * @timestamp: time at which the frame was received
2182 * @switch_time: switch-timing parameter received in the frame
2183 * @switch_timeout: switch-timing parameter received in the frame
2184 * @tmpl_skb: TDLS switch-channel response template
2185 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2186 */
2187struct ieee80211_tdls_ch_sw_params {
2188 struct ieee80211_sta *sta;
2189 struct cfg80211_chan_def *chandef;
2190 u8 action_code;
2191 u32 status;
2192 u32 timestamp;
2193 u16 switch_time;
2194 u16 switch_timeout;
2195 struct sk_buff *tmpl_skb;
2196 u32 ch_sw_tm_ie;
2197};
2198
2199/**
2200 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2201 *
2202 * @wiphy: the &struct wiphy which we want to query
2203 *
2204 * mac80211 drivers can use this to get to their respective
2205 * &struct ieee80211_hw. Drivers wishing to get to their own private
2206 * structure can then access it via hw->priv. Note that mac802111 drivers should
2207 * not use wiphy_priv() to try to get their private driver structure as this
2208 * is already used internally by mac80211.
2209 *
2210 * Return: The mac80211 driver hw struct of @wiphy.
2211 */
2212struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2213
2214/**
2215 * SET_IEEE80211_DEV - set device for 802.11 hardware
2216 *
2217 * @hw: the &struct ieee80211_hw to set the device for
2218 * @dev: the &struct device of this 802.11 device
2219 */
2220static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2221{
2222 set_wiphy_dev(hw->wiphy, dev);
2223}
2224
2225/**
2226 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2227 *
2228 * @hw: the &struct ieee80211_hw to set the MAC address for
2229 * @addr: the address to set
2230 */
2231static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2232{
2233 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2234}
2235
2236static inline struct ieee80211_rate *
2237ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2238 const struct ieee80211_tx_info *c)
2239{
2240 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2241 return NULL;
2242 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2243}
2244
2245static inline struct ieee80211_rate *
2246ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2247 const struct ieee80211_tx_info *c)
2248{
2249 if (c->control.rts_cts_rate_idx < 0)
2250 return NULL;
2251 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2252}
2253
2254static inline struct ieee80211_rate *
2255ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2256 const struct ieee80211_tx_info *c, int idx)
2257{
2258 if (c->control.rates[idx + 1].idx < 0)
2259 return NULL;
2260 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2261}
2262
2263/**
2264 * ieee80211_free_txskb - free TX skb
2265 * @hw: the hardware
2266 * @skb: the skb
2267 *
2268 * Free a transmit skb. Use this funtion when some failure
2269 * to transmit happened and thus status cannot be reported.
2270 */
2271void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2272
2273/**
2274 * DOC: Hardware crypto acceleration
2275 *
2276 * mac80211 is capable of taking advantage of many hardware
2277 * acceleration designs for encryption and decryption operations.
2278 *
2279 * The set_key() callback in the &struct ieee80211_ops for a given
2280 * device is called to enable hardware acceleration of encryption and
2281 * decryption. The callback takes a @sta parameter that will be NULL
2282 * for default keys or keys used for transmission only, or point to
2283 * the station information for the peer for individual keys.
2284 * Multiple transmission keys with the same key index may be used when
2285 * VLANs are configured for an access point.
2286 *
2287 * When transmitting, the TX control data will use the @hw_key_idx
2288 * selected by the driver by modifying the &struct ieee80211_key_conf
2289 * pointed to by the @key parameter to the set_key() function.
2290 *
2291 * The set_key() call for the %SET_KEY command should return 0 if
2292 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2293 * added; if you return 0 then hw_key_idx must be assigned to the
2294 * hardware key index, you are free to use the full u8 range.
2295 *
2296 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2297 * set, mac80211 will not automatically fall back to software crypto if
2298 * enabling hardware crypto failed. The set_key() call may also return the
2299 * value 1 to permit this specific key/algorithm to be done in software.
2300 *
2301 * When the cmd is %DISABLE_KEY then it must succeed.
2302 *
2303 * Note that it is permissible to not decrypt a frame even if a key
2304 * for it has been uploaded to hardware, the stack will not make any
2305 * decision based on whether a key has been uploaded or not but rather
2306 * based on the receive flags.
2307 *
2308 * The &struct ieee80211_key_conf structure pointed to by the @key
2309 * parameter is guaranteed to be valid until another call to set_key()
2310 * removes it, but it can only be used as a cookie to differentiate
2311 * keys.
2312 *
2313 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2314 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2315 * handler.
2316 * The update_tkip_key() call updates the driver with the new phase 1 key.
2317 * This happens every time the iv16 wraps around (every 65536 packets). The
2318 * set_key() call will happen only once for each key (unless the AP did
2319 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2320 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2321 * handler is software decryption with wrap around of iv16.
2322 *
2323 * The set_default_unicast_key() call updates the default WEP key index
2324 * configured to the hardware for WEP encryption type. This is required
2325 * for devices that support offload of data packets (e.g. ARP responses).
2326 */
2327
2328/**
2329 * DOC: Powersave support
2330 *
2331 * mac80211 has support for various powersave implementations.
2332 *
2333 * First, it can support hardware that handles all powersaving by itself,
2334 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2335 * flag. In that case, it will be told about the desired powersave mode
2336 * with the %IEEE80211_CONF_PS flag depending on the association status.
2337 * The hardware must take care of sending nullfunc frames when necessary,
2338 * i.e. when entering and leaving powersave mode. The hardware is required
2339 * to look at the AID in beacons and signal to the AP that it woke up when
2340 * it finds traffic directed to it.
2341 *
2342 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2343 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2344 * with hardware wakeup and sleep states. Driver is responsible for waking
2345 * up the hardware before issuing commands to the hardware and putting it
2346 * back to sleep at appropriate times.
2347 *
2348 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2349 * buffered multicast/broadcast frames after the beacon. Also it must be
2350 * possible to send frames and receive the acknowledment frame.
2351 *
2352 * Other hardware designs cannot send nullfunc frames by themselves and also
2353 * need software support for parsing the TIM bitmap. This is also supported
2354 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2355 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2356 * required to pass up beacons. The hardware is still required to handle
2357 * waking up for multicast traffic; if it cannot the driver must handle that
2358 * as best as it can, mac80211 is too slow to do that.
2359 *
2360 * Dynamic powersave is an extension to normal powersave in which the
2361 * hardware stays awake for a user-specified period of time after sending a
2362 * frame so that reply frames need not be buffered and therefore delayed to
2363 * the next wakeup. It's compromise of getting good enough latency when
2364 * there's data traffic and still saving significantly power in idle
2365 * periods.
2366 *
2367 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2368 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2369 * flag and mac80211 will handle everything automatically. Additionally,
2370 * hardware having support for the dynamic PS feature may set the
2371 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2372 * dynamic PS mode itself. The driver needs to look at the
2373 * @dynamic_ps_timeout hardware configuration value and use it that value
2374 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2375 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2376 * enabled whenever user has enabled powersave.
2377 *
2378 * Driver informs U-APSD client support by enabling
2379 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2380 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2381 * Nullfunc frames and stay awake until the service period has ended. To
2382 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2383 * from that AC are transmitted with powersave enabled.
2384 *
2385 * Note: U-APSD client mode is not yet supported with
2386 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2387 */
2388
2389/**
2390 * DOC: Beacon filter support
2391 *
2392 * Some hardware have beacon filter support to reduce host cpu wakeups
2393 * which will reduce system power consumption. It usually works so that
2394 * the firmware creates a checksum of the beacon but omits all constantly
2395 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2396 * beacon is forwarded to the host, otherwise it will be just dropped. That
2397 * way the host will only receive beacons where some relevant information
2398 * (for example ERP protection or WMM settings) have changed.
2399 *
2400 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2401 * interface capability. The driver needs to enable beacon filter support
2402 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2403 * power save is enabled, the stack will not check for beacon loss and the
2404 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2405 *
2406 * The time (or number of beacons missed) until the firmware notifies the
2407 * driver of a beacon loss event (which in turn causes the driver to call
2408 * ieee80211_beacon_loss()) should be configurable and will be controlled
2409 * by mac80211 and the roaming algorithm in the future.
2410 *
2411 * Since there may be constantly changing information elements that nothing
2412 * in the software stack cares about, we will, in the future, have mac80211
2413 * tell the driver which information elements are interesting in the sense
2414 * that we want to see changes in them. This will include
2415 * - a list of information element IDs
2416 * - a list of OUIs for the vendor information element
2417 *
2418 * Ideally, the hardware would filter out any beacons without changes in the
2419 * requested elements, but if it cannot support that it may, at the expense
2420 * of some efficiency, filter out only a subset. For example, if the device
2421 * doesn't support checking for OUIs it should pass up all changes in all
2422 * vendor information elements.
2423 *
2424 * Note that change, for the sake of simplification, also includes information
2425 * elements appearing or disappearing from the beacon.
2426 *
2427 * Some hardware supports an "ignore list" instead, just make sure nothing
2428 * that was requested is on the ignore list, and include commonly changing
2429 * information element IDs in the ignore list, for example 11 (BSS load) and
2430 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2431 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2432 * it could also include some currently unused IDs.
2433 *
2434 *
2435 * In addition to these capabilities, hardware should support notifying the
2436 * host of changes in the beacon RSSI. This is relevant to implement roaming
2437 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2438 * the received data packets). This can consist in notifying the host when
2439 * the RSSI changes significantly or when it drops below or rises above
2440 * configurable thresholds. In the future these thresholds will also be
2441 * configured by mac80211 (which gets them from userspace) to implement
2442 * them as the roaming algorithm requires.
2443 *
2444 * If the hardware cannot implement this, the driver should ask it to
2445 * periodically pass beacon frames to the host so that software can do the
2446 * signal strength threshold checking.
2447 */
2448
2449/**
2450 * DOC: Spatial multiplexing power save
2451 *
2452 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2453 * power in an 802.11n implementation. For details on the mechanism
2454 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2455 * "11.2.3 SM power save".
2456 *
2457 * The mac80211 implementation is capable of sending action frames
2458 * to update the AP about the station's SMPS mode, and will instruct
2459 * the driver to enter the specific mode. It will also announce the
2460 * requested SMPS mode during the association handshake. Hardware
2461 * support for this feature is required, and can be indicated by
2462 * hardware flags.
2463 *
2464 * The default mode will be "automatic", which nl80211/cfg80211
2465 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2466 * turned off otherwise.
2467 *
2468 * To support this feature, the driver must set the appropriate
2469 * hardware support flags, and handle the SMPS flag to the config()
2470 * operation. It will then with this mechanism be instructed to
2471 * enter the requested SMPS mode while associated to an HT AP.
2472 */
2473
2474/**
2475 * DOC: Frame filtering
2476 *
2477 * mac80211 requires to see many management frames for proper
2478 * operation, and users may want to see many more frames when
2479 * in monitor mode. However, for best CPU usage and power consumption,
2480 * having as few frames as possible percolate through the stack is
2481 * desirable. Hence, the hardware should filter as much as possible.
2482 *
2483 * To achieve this, mac80211 uses filter flags (see below) to tell
2484 * the driver's configure_filter() function which frames should be
2485 * passed to mac80211 and which should be filtered out.
2486 *
2487 * Before configure_filter() is invoked, the prepare_multicast()
2488 * callback is invoked with the parameters @mc_count and @mc_list
2489 * for the combined multicast address list of all virtual interfaces.
2490 * It's use is optional, and it returns a u64 that is passed to
2491 * configure_filter(). Additionally, configure_filter() has the
2492 * arguments @changed_flags telling which flags were changed and
2493 * @total_flags with the new flag states.
2494 *
2495 * If your device has no multicast address filters your driver will
2496 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2497 * parameter to see whether multicast frames should be accepted
2498 * or dropped.
2499 *
2500 * All unsupported flags in @total_flags must be cleared.
2501 * Hardware does not support a flag if it is incapable of _passing_
2502 * the frame to the stack. Otherwise the driver must ignore
2503 * the flag, but not clear it.
2504 * You must _only_ clear the flag (announce no support for the
2505 * flag to mac80211) if you are not able to pass the packet type
2506 * to the stack (so the hardware always filters it).
2507 * So for example, you should clear @FIF_CONTROL, if your hardware
2508 * always filters control frames. If your hardware always passes
2509 * control frames to the kernel and is incapable of filtering them,
2510 * you do _not_ clear the @FIF_CONTROL flag.
2511 * This rule applies to all other FIF flags as well.
2512 */
2513
2514/**
2515 * DOC: AP support for powersaving clients
2516 *
2517 * In order to implement AP and P2P GO modes, mac80211 has support for
2518 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2519 * There currently is no support for sAPSD.
2520 *
2521 * There is one assumption that mac80211 makes, namely that a client
2522 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2523 * Both are supported, and both can be used by the same client, but
2524 * they can't be used concurrently by the same client. This simplifies
2525 * the driver code.
2526 *
2527 * The first thing to keep in mind is that there is a flag for complete
2528 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2529 * mac80211 expects the driver to handle most of the state machine for
2530 * powersaving clients and will ignore the PM bit in incoming frames.
2531 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2532 * stations' powersave transitions. In this mode, mac80211 also doesn't
2533 * handle PS-Poll/uAPSD.
2534 *
2535 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2536 * PM bit in incoming frames for client powersave transitions. When a
2537 * station goes to sleep, we will stop transmitting to it. There is,
2538 * however, a race condition: a station might go to sleep while there is
2539 * data buffered on hardware queues. If the device has support for this
2540 * it will reject frames, and the driver should give the frames back to
2541 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2542 * cause mac80211 to retry the frame when the station wakes up. The
2543 * driver is also notified of powersave transitions by calling its
2544 * @sta_notify callback.
2545 *
2546 * When the station is asleep, it has three choices: it can wake up,
2547 * it can PS-Poll, or it can possibly start a uAPSD service period.
2548 * Waking up is implemented by simply transmitting all buffered (and
2549 * filtered) frames to the station. This is the easiest case. When
2550 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2551 * will inform the driver of this with the @allow_buffered_frames
2552 * callback; this callback is optional. mac80211 will then transmit
2553 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2554 * on each frame. The last frame in the service period (or the only
2555 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2556 * indicate that it ends the service period; as this frame must have
2557 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2558 * When TX status is reported for this frame, the service period is
2559 * marked has having ended and a new one can be started by the peer.
2560 *
2561 * Additionally, non-bufferable MMPDUs can also be transmitted by
2562 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2563 *
2564 * Another race condition can happen on some devices like iwlwifi
2565 * when there are frames queued for the station and it wakes up
2566 * or polls; the frames that are already queued could end up being
2567 * transmitted first instead, causing reordering and/or wrong
2568 * processing of the EOSP. The cause is that allowing frames to be
2569 * transmitted to a certain station is out-of-band communication to
2570 * the device. To allow this problem to be solved, the driver can
2571 * call ieee80211_sta_block_awake() if frames are buffered when it
2572 * is notified that the station went to sleep. When all these frames
2573 * have been filtered (see above), it must call the function again
2574 * to indicate that the station is no longer blocked.
2575 *
2576 * If the driver buffers frames in the driver for aggregation in any
2577 * way, it must use the ieee80211_sta_set_buffered() call when it is
2578 * notified of the station going to sleep to inform mac80211 of any
2579 * TIDs that have frames buffered. Note that when a station wakes up
2580 * this information is reset (hence the requirement to call it when
2581 * informed of the station going to sleep). Then, when a service
2582 * period starts for any reason, @release_buffered_frames is called
2583 * with the number of frames to be released and which TIDs they are
2584 * to come from. In this case, the driver is responsible for setting
2585 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2586 * to help the @more_data parameter is passed to tell the driver if
2587 * there is more data on other TIDs -- the TIDs to release frames
2588 * from are ignored since mac80211 doesn't know how many frames the
2589 * buffers for those TIDs contain.
2590 *
2591 * If the driver also implement GO mode, where absence periods may
2592 * shorten service periods (or abort PS-Poll responses), it must
2593 * filter those response frames except in the case of frames that
2594 * are buffered in the driver -- those must remain buffered to avoid
2595 * reordering. Because it is possible that no frames are released
2596 * in this case, the driver must call ieee80211_sta_eosp()
2597 * to indicate to mac80211 that the service period ended anyway.
2598 *
2599 * Finally, if frames from multiple TIDs are released from mac80211
2600 * but the driver might reorder them, it must clear & set the flags
2601 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2602 * and also take care of the EOSP and MORE_DATA bits in the frame.
2603 * The driver may also use ieee80211_sta_eosp() in this case.
2604 *
2605 * Note that if the driver ever buffers frames other than QoS-data
2606 * frames, it must take care to never send a non-QoS-data frame as
2607 * the last frame in a service period, adding a QoS-nulldata frame
2608 * after a non-QoS-data frame if needed.
2609 */
2610
2611/**
2612 * DOC: HW queue control
2613 *
2614 * Before HW queue control was introduced, mac80211 only had a single static
2615 * assignment of per-interface AC software queues to hardware queues. This
2616 * was problematic for a few reasons:
2617 * 1) off-channel transmissions might get stuck behind other frames
2618 * 2) multiple virtual interfaces couldn't be handled correctly
2619 * 3) after-DTIM frames could get stuck behind other frames
2620 *
2621 * To solve this, hardware typically uses multiple different queues for all
2622 * the different usages, and this needs to be propagated into mac80211 so it
2623 * won't have the same problem with the software queues.
2624 *
2625 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2626 * flag that tells it that the driver implements its own queue control. To do
2627 * so, the driver will set up the various queues in each &struct ieee80211_vif
2628 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2629 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2630 * if necessary will queue the frame on the right software queue that mirrors
2631 * the hardware queue.
2632 * Additionally, the driver has to then use these HW queue IDs for the queue
2633 * management functions (ieee80211_stop_queue() et al.)
2634 *
2635 * The driver is free to set up the queue mappings as needed, multiple virtual
2636 * interfaces may map to the same hardware queues if needed. The setup has to
2637 * happen during add_interface or change_interface callbacks. For example, a
2638 * driver supporting station+station and station+AP modes might decide to have
2639 * 10 hardware queues to handle different scenarios:
2640 *
2641 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2642 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2643 * after-DTIM queue for AP: 8
2644 * off-channel queue: 9
2645 *
2646 * It would then set up the hardware like this:
2647 * hw.offchannel_tx_hw_queue = 9
2648 *
2649 * and the first virtual interface that is added as follows:
2650 * vif.hw_queue[IEEE80211_AC_VO] = 0
2651 * vif.hw_queue[IEEE80211_AC_VI] = 1
2652 * vif.hw_queue[IEEE80211_AC_BE] = 2
2653 * vif.hw_queue[IEEE80211_AC_BK] = 3
2654 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2655 * and the second virtual interface with 4-7.
2656 *
2657 * If queue 6 gets full, for example, mac80211 would only stop the second
2658 * virtual interface's BE queue since virtual interface queues are per AC.
2659 *
2660 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2661 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2662 * queue could potentially be shared since mac80211 will look at cab_queue when
2663 * a queue is stopped/woken even if the interface is not in AP mode.
2664 */
2665
2666/**
2667 * enum ieee80211_filter_flags - hardware filter flags
2668 *
2669 * These flags determine what the filter in hardware should be
2670 * programmed to let through and what should not be passed to the
2671 * stack. It is always safe to pass more frames than requested,
2672 * but this has negative impact on power consumption.
2673 *
2674 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2675 * by the user or if the hardware is not capable of filtering by
2676 * multicast address.
2677 *
2678 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2679 * %RX_FLAG_FAILED_FCS_CRC for them)
2680 *
2681 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2682 * the %RX_FLAG_FAILED_PLCP_CRC for them
2683 *
2684 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2685 * to the hardware that it should not filter beacons or probe responses
2686 * by BSSID. Filtering them can greatly reduce the amount of processing
2687 * mac80211 needs to do and the amount of CPU wakeups, so you should
2688 * honour this flag if possible.
2689 *
2690 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2691 * station
2692 *
2693 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2694 *
2695 * @FIF_PSPOLL: pass PS Poll frames
2696 *
2697 * @FIF_PROBE_REQ: pass probe request frames
2698 */
2699enum ieee80211_filter_flags {
2700 FIF_ALLMULTI = 1<<1,
2701 FIF_FCSFAIL = 1<<2,
2702 FIF_PLCPFAIL = 1<<3,
2703 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2704 FIF_CONTROL = 1<<5,
2705 FIF_OTHER_BSS = 1<<6,
2706 FIF_PSPOLL = 1<<7,
2707 FIF_PROBE_REQ = 1<<8,
2708};
2709
2710/**
2711 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2712 *
2713 * These flags are used with the ampdu_action() callback in
2714 * &struct ieee80211_ops to indicate which action is needed.
2715 *
2716 * Note that drivers MUST be able to deal with a TX aggregation
2717 * session being stopped even before they OK'ed starting it by
2718 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2719 * might receive the addBA frame and send a delBA right away!
2720 *
2721 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2722 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2723 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2724 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2725 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2726 * queued packets, now unaggregated. After all packets are transmitted the
2727 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2728 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2729 * called when the station is removed. There's no need or reason to call
2730 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2731 * session is gone and removes the station.
2732 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2733 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2734 * now the connection is dropped and the station will be removed. Drivers
2735 * should clean up and drop remaining packets when this is called.
2736 */
2737enum ieee80211_ampdu_mlme_action {
2738 IEEE80211_AMPDU_RX_START,
2739 IEEE80211_AMPDU_RX_STOP,
2740 IEEE80211_AMPDU_TX_START,
2741 IEEE80211_AMPDU_TX_STOP_CONT,
2742 IEEE80211_AMPDU_TX_STOP_FLUSH,
2743 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2744 IEEE80211_AMPDU_TX_OPERATIONAL,
2745};
2746
2747/**
2748 * struct ieee80211_ampdu_params - AMPDU action parameters
2749 *
2750 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
2751 * @sta: peer of this AMPDU session
2752 * @tid: tid of the BA session
2753 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
2754 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
2755 * actual ssn value used to start the session and writes the value here.
2756 * @buf_size: reorder buffer size (number of subframes). Valid only when the
2757 * action is set to %IEEE80211_AMPDU_RX_START or
2758 * %IEEE80211_AMPDU_TX_OPERATIONAL
2759 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
2760 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
2761 * @timeout: BA session timeout. Valid only when the action is set to
2762 * %IEEE80211_AMPDU_RX_START
2763 */
2764struct ieee80211_ampdu_params {
2765 enum ieee80211_ampdu_mlme_action action;
2766 struct ieee80211_sta *sta;
2767 u16 tid;
2768 u16 ssn;
2769 u8 buf_size;
2770 bool amsdu;
2771 u16 timeout;
2772};
2773
2774/**
2775 * enum ieee80211_frame_release_type - frame release reason
2776 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2777 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2778 * frame received on trigger-enabled AC
2779 */
2780enum ieee80211_frame_release_type {
2781 IEEE80211_FRAME_RELEASE_PSPOLL,
2782 IEEE80211_FRAME_RELEASE_UAPSD,
2783};
2784
2785/**
2786 * enum ieee80211_rate_control_changed - flags to indicate what changed
2787 *
2788 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2789 * to this station changed. The actual bandwidth is in the station
2790 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2791 * flag changes, for HT and VHT the bandwidth field changes.
2792 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2793 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2794 * changed (in IBSS mode) due to discovering more information about
2795 * the peer.
2796 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2797 * by the peer
2798 */
2799enum ieee80211_rate_control_changed {
2800 IEEE80211_RC_BW_CHANGED = BIT(0),
2801 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2802 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2803 IEEE80211_RC_NSS_CHANGED = BIT(3),
2804};
2805
2806/**
2807 * enum ieee80211_roc_type - remain on channel type
2808 *
2809 * With the support for multi channel contexts and multi channel operations,
2810 * remain on channel operations might be limited/deferred/aborted by other
2811 * flows/operations which have higher priority (and vise versa).
2812 * Specifying the ROC type can be used by devices to prioritize the ROC
2813 * operations compared to other operations/flows.
2814 *
2815 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2816 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2817 * for sending managment frames offchannel.
2818 */
2819enum ieee80211_roc_type {
2820 IEEE80211_ROC_TYPE_NORMAL = 0,
2821 IEEE80211_ROC_TYPE_MGMT_TX,
2822};
2823
2824/**
2825 * enum ieee80211_reconfig_complete_type - reconfig type
2826 *
2827 * This enum is used by the reconfig_complete() callback to indicate what
2828 * reconfiguration type was completed.
2829 *
2830 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2831 * (also due to resume() callback returning 1)
2832 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2833 * of wowlan configuration)
2834 */
2835enum ieee80211_reconfig_type {
2836 IEEE80211_RECONFIG_TYPE_RESTART,
2837 IEEE80211_RECONFIG_TYPE_SUSPEND,
2838};
2839
2840/**
2841 * struct ieee80211_ops - callbacks from mac80211 to the driver
2842 *
2843 * This structure contains various callbacks that the driver may
2844 * handle or, in some cases, must handle, for example to configure
2845 * the hardware to a new channel or to transmit a frame.
2846 *
2847 * @tx: Handler that 802.11 module calls for each transmitted frame.
2848 * skb contains the buffer starting from the IEEE 802.11 header.
2849 * The low-level driver should send the frame out based on
2850 * configuration in the TX control data. This handler should,
2851 * preferably, never fail and stop queues appropriately.
2852 * Must be atomic.
2853 *
2854 * @start: Called before the first netdevice attached to the hardware
2855 * is enabled. This should turn on the hardware and must turn on
2856 * frame reception (for possibly enabled monitor interfaces.)
2857 * Returns negative error codes, these may be seen in userspace,
2858 * or zero.
2859 * When the device is started it should not have a MAC address
2860 * to avoid acknowledging frames before a non-monitor device
2861 * is added.
2862 * Must be implemented and can sleep.
2863 *
2864 * @stop: Called after last netdevice attached to the hardware
2865 * is disabled. This should turn off the hardware (at least
2866 * it must turn off frame reception.)
2867 * May be called right after add_interface if that rejects
2868 * an interface. If you added any work onto the mac80211 workqueue
2869 * you should ensure to cancel it on this callback.
2870 * Must be implemented and can sleep.
2871 *
2872 * @suspend: Suspend the device; mac80211 itself will quiesce before and
2873 * stop transmitting and doing any other configuration, and then
2874 * ask the device to suspend. This is only invoked when WoWLAN is
2875 * configured, otherwise the device is deconfigured completely and
2876 * reconfigured at resume time.
2877 * The driver may also impose special conditions under which it
2878 * wants to use the "normal" suspend (deconfigure), say if it only
2879 * supports WoWLAN when the device is associated. In this case, it
2880 * must return 1 from this function.
2881 *
2882 * @resume: If WoWLAN was configured, this indicates that mac80211 is
2883 * now resuming its operation, after this the device must be fully
2884 * functional again. If this returns an error, the only way out is
2885 * to also unregister the device. If it returns 1, then mac80211
2886 * will also go through the regular complete restart on resume.
2887 *
2888 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
2889 * modified. The reason is that device_set_wakeup_enable() is
2890 * supposed to be called when the configuration changes, not only
2891 * in suspend().
2892 *
2893 * @add_interface: Called when a netdevice attached to the hardware is
2894 * enabled. Because it is not called for monitor mode devices, @start
2895 * and @stop must be implemented.
2896 * The driver should perform any initialization it needs before
2897 * the device can be enabled. The initial configuration for the
2898 * interface is given in the conf parameter.
2899 * The callback may refuse to add an interface by returning a
2900 * negative error code (which will be seen in userspace.)
2901 * Must be implemented and can sleep.
2902 *
2903 * @change_interface: Called when a netdevice changes type. This callback
2904 * is optional, but only if it is supported can interface types be
2905 * switched while the interface is UP. The callback may sleep.
2906 * Note that while an interface is being switched, it will not be
2907 * found by the interface iteration callbacks.
2908 *
2909 * @remove_interface: Notifies a driver that an interface is going down.
2910 * The @stop callback is called after this if it is the last interface
2911 * and no monitor interfaces are present.
2912 * When all interfaces are removed, the MAC address in the hardware
2913 * must be cleared so the device no longer acknowledges packets,
2914 * the mac_addr member of the conf structure is, however, set to the
2915 * MAC address of the device going away.
2916 * Hence, this callback must be implemented. It can sleep.
2917 *
2918 * @config: Handler for configuration requests. IEEE 802.11 code calls this
2919 * function to change hardware configuration, e.g., channel.
2920 * This function should never fail but returns a negative error code
2921 * if it does. The callback can sleep.
2922 *
2923 * @bss_info_changed: Handler for configuration requests related to BSS
2924 * parameters that may vary during BSS's lifespan, and may affect low
2925 * level driver (e.g. assoc/disassoc status, erp parameters).
2926 * This function should not be used if no BSS has been set, unless
2927 * for association indication. The @changed parameter indicates which
2928 * of the bss parameters has changed when a call is made. The callback
2929 * can sleep.
2930 *
2931 * @prepare_multicast: Prepare for multicast filter configuration.
2932 * This callback is optional, and its return value is passed
2933 * to configure_filter(). This callback must be atomic.
2934 *
2935 * @configure_filter: Configure the device's RX filter.
2936 * See the section "Frame filtering" for more information.
2937 * This callback must be implemented and can sleep.
2938 *
2939 * @config_iface_filter: Configure the interface's RX filter.
2940 * This callback is optional and is used to configure which frames
2941 * should be passed to mac80211. The filter_flags is the combination
2942 * of FIF_* flags. The changed_flags is a bit mask that indicates
2943 * which flags are changed.
2944 * This callback can sleep.
2945 *
2946 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
2947 * must be set or cleared for a given STA. Must be atomic.
2948 *
2949 * @set_key: See the section "Hardware crypto acceleration"
2950 * This callback is only called between add_interface and
2951 * remove_interface calls, i.e. while the given virtual interface
2952 * is enabled.
2953 * Returns a negative error code if the key can't be added.
2954 * The callback can sleep.
2955 *
2956 * @update_tkip_key: See the section "Hardware crypto acceleration"
2957 * This callback will be called in the context of Rx. Called for drivers
2958 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
2959 * The callback must be atomic.
2960 *
2961 * @set_rekey_data: If the device supports GTK rekeying, for example while the
2962 * host is suspended, it can assign this callback to retrieve the data
2963 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
2964 * After rekeying was done it should (for example during resume) notify
2965 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
2966 *
2967 * @set_default_unicast_key: Set the default (unicast) key index, useful for
2968 * WEP when the device sends data packets autonomously, e.g. for ARP
2969 * offloading. The index can be 0-3, or -1 for unsetting it.
2970 *
2971 * @hw_scan: Ask the hardware to service the scan request, no need to start
2972 * the scan state machine in stack. The scan must honour the channel
2973 * configuration done by the regulatory agent in the wiphy's
2974 * registered bands. The hardware (or the driver) needs to make sure
2975 * that power save is disabled.
2976 * The @req ie/ie_len members are rewritten by mac80211 to contain the
2977 * entire IEs after the SSID, so that drivers need not look at these
2978 * at all but just send them after the SSID -- mac80211 includes the
2979 * (extended) supported rates and HT information (where applicable).
2980 * When the scan finishes, ieee80211_scan_completed() must be called;
2981 * note that it also must be called when the scan cannot finish due to
2982 * any error unless this callback returned a negative error code.
2983 * The callback can sleep.
2984 *
2985 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
2986 * The driver should ask the hardware to cancel the scan (if possible),
2987 * but the scan will be completed only after the driver will call
2988 * ieee80211_scan_completed().
2989 * This callback is needed for wowlan, to prevent enqueueing a new
2990 * scan_work after the low-level driver was already suspended.
2991 * The callback can sleep.
2992 *
2993 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
2994 * specific intervals. The driver must call the
2995 * ieee80211_sched_scan_results() function whenever it finds results.
2996 * This process will continue until sched_scan_stop is called.
2997 *
2998 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
2999 * In this case, ieee80211_sched_scan_stopped() must not be called.
3000 *
3001 * @sw_scan_start: Notifier function that is called just before a software scan
3002 * is started. Can be NULL, if the driver doesn't need this notification.
3003 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3004 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3005 * can use this parameter. The callback can sleep.
3006 *
3007 * @sw_scan_complete: Notifier function that is called just after a
3008 * software scan finished. Can be NULL, if the driver doesn't need
3009 * this notification.
3010 * The callback can sleep.
3011 *
3012 * @get_stats: Return low-level statistics.
3013 * Returns zero if statistics are available.
3014 * The callback can sleep.
3015 *
3016 * @get_key_seq: If your device implements encryption in hardware and does
3017 * IV/PN assignment then this callback should be provided to read the
3018 * IV/PN for the given key from hardware.
3019 * The callback must be atomic.
3020 *
3021 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3022 * if the device does fragmentation by itself; if this callback is
3023 * implemented then the stack will not do fragmentation.
3024 * The callback can sleep.
3025 *
3026 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3027 * The callback can sleep.
3028 *
3029 * @sta_add: Notifies low level driver about addition of an associated station,
3030 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3031 *
3032 * @sta_remove: Notifies low level driver about removal of an associated
3033 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3034 * returns it isn't safe to use the pointer, not even RCU protected;
3035 * no RCU grace period is guaranteed between returning here and freeing
3036 * the station. See @sta_pre_rcu_remove if needed.
3037 * This callback can sleep.
3038 *
3039 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3040 * when a station is added to mac80211's station list. This callback
3041 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS
3042 * conditional. This callback can sleep.
3043 *
3044 * @sta_remove_debugfs: Remove the debugfs files which were added using
3045 * @sta_add_debugfs. This callback can sleep.
3046 *
3047 * @sta_notify: Notifies low level driver about power state transition of an
3048 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3049 * in AP mode, this callback will not be called when the flag
3050 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3051 *
3052 * @sta_state: Notifies low level driver about state transition of a
3053 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3054 * This callback is mutually exclusive with @sta_add/@sta_remove.
3055 * It must not fail for down transitions but may fail for transitions
3056 * up the list of states. Also note that after the callback returns it
3057 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3058 * period is guaranteed between returning here and freeing the station.
3059 * See @sta_pre_rcu_remove if needed.
3060 * The callback can sleep.
3061 *
3062 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3063 * synchronisation. This is useful if a driver needs to have station
3064 * pointers protected using RCU, it can then use this call to clear
3065 * the pointers instead of waiting for an RCU grace period to elapse
3066 * in @sta_state.
3067 * The callback can sleep.
3068 *
3069 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3070 * used to transmit to the station. The changes are advertised with bits
3071 * from &enum ieee80211_rate_control_changed and the values are reflected
3072 * in the station data. This callback should only be used when the driver
3073 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3074 * otherwise the rate control algorithm is notified directly.
3075 * Must be atomic.
3076 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3077 * is only used if the configured rate control algorithm actually uses
3078 * the new rate table API, and is therefore optional. Must be atomic.
3079 *
3080 * @sta_statistics: Get statistics for this station. For example with beacon
3081 * filtering, the statistics kept by mac80211 might not be accurate, so
3082 * let the driver pre-fill the statistics. The driver can fill most of
3083 * the values (indicating which by setting the filled bitmap), but not
3084 * all of them make sense - see the source for which ones are possible.
3085 * Statistics that the driver doesn't fill will be filled by mac80211.
3086 * The callback can sleep.
3087 *
3088 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3089 * bursting) for a hardware TX queue.
3090 * Returns a negative error code on failure.
3091 * The callback can sleep.
3092 *
3093 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3094 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3095 * required function.
3096 * The callback can sleep.
3097 *
3098 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3099 * Currently, this is only used for IBSS mode debugging. Is not a
3100 * required function.
3101 * The callback can sleep.
3102 *
3103 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3104 * with other STAs in the IBSS. This is only used in IBSS mode. This
3105 * function is optional if the firmware/hardware takes full care of
3106 * TSF synchronization.
3107 * The callback can sleep.
3108 *
3109 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3110 * This is needed only for IBSS mode and the result of this function is
3111 * used to determine whether to reply to Probe Requests.
3112 * Returns non-zero if this device sent the last beacon.
3113 * The callback can sleep.
3114 *
3115 * @ampdu_action: Perform a certain A-MPDU action
3116 * The RA/TID combination determines the destination and TID we want
3117 * the ampdu action to be performed for. The action is defined through
3118 * ieee80211_ampdu_mlme_action.
3119 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3120 * may neither send aggregates containing more subframes than @buf_size
3121 * nor send aggregates in a way that lost frames would exceed the
3122 * buffer size. If just limiting the aggregate size, this would be
3123 * possible with a buf_size of 8:
3124 * - TX: 1.....7
3125 * - RX: 2....7 (lost frame #1)
3126 * - TX: 8..1...
3127 * which is invalid since #1 was now re-transmitted well past the
3128 * buffer size of 8. Correct ways to retransmit #1 would be:
3129 * - TX: 1 or 18 or 81
3130 * Even "189" would be wrong since 1 could be lost again.
3131 *
3132 * Returns a negative error code on failure.
3133 * The callback can sleep.
3134 *
3135 * @get_survey: Return per-channel survey information
3136 *
3137 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3138 * need to set wiphy->rfkill_poll to %true before registration,
3139 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3140 * The callback can sleep.
3141 *
3142 * @set_coverage_class: Set slot time for given coverage class as specified
3143 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3144 * accordingly; coverage class equals to -1 to enable ACK timeout
3145 * estimation algorithm (dynack). To disable dynack set valid value for
3146 * coverage class. This callback is not required and may sleep.
3147 *
3148 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3149 * be %NULL. The callback can sleep.
3150 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3151 *
3152 * @flush: Flush all pending frames from the hardware queue, making sure
3153 * that the hardware queues are empty. The @queues parameter is a bitmap
3154 * of queues to flush, which is useful if different virtual interfaces
3155 * use different hardware queues; it may also indicate all queues.
3156 * If the parameter @drop is set to %true, pending frames may be dropped.
3157 * Note that vif can be NULL.
3158 * The callback can sleep.
3159 *
3160 * @channel_switch: Drivers that need (or want) to offload the channel
3161 * switch operation for CSAs received from the AP may implement this
3162 * callback. They must then call ieee80211_chswitch_done() to indicate
3163 * completion of the channel switch.
3164 *
3165 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3166 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3167 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3168 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3169 *
3170 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3171 *
3172 * @remain_on_channel: Starts an off-channel period on the given channel, must
3173 * call back to ieee80211_ready_on_channel() when on that channel. Note
3174 * that normal channel traffic is not stopped as this is intended for hw
3175 * offload. Frames to transmit on the off-channel channel are transmitted
3176 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3177 * duration (which will always be non-zero) expires, the driver must call
3178 * ieee80211_remain_on_channel_expired().
3179 * Note that this callback may be called while the device is in IDLE and
3180 * must be accepted in this case.
3181 * This callback may sleep.
3182 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3183 * aborted before it expires. This callback may sleep.
3184 *
3185 * @set_ringparam: Set tx and rx ring sizes.
3186 *
3187 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3188 *
3189 * @tx_frames_pending: Check if there is any pending frame in the hardware
3190 * queues before entering power save.
3191 *
3192 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3193 * when transmitting a frame. Currently only legacy rates are handled.
3194 * The callback can sleep.
3195 * @event_callback: Notify driver about any event in mac80211. See
3196 * &enum ieee80211_event_type for the different types.
3197 * The callback must be atomic.
3198 *
3199 * @release_buffered_frames: Release buffered frames according to the given
3200 * parameters. In the case where the driver buffers some frames for
3201 * sleeping stations mac80211 will use this callback to tell the driver
3202 * to release some frames, either for PS-poll or uAPSD.
3203 * Note that if the @more_data parameter is %false the driver must check
3204 * if there are more frames on the given TIDs, and if there are more than
3205 * the frames being released then it must still set the more-data bit in
3206 * the frame. If the @more_data parameter is %true, then of course the
3207 * more-data bit must always be set.
3208 * The @tids parameter tells the driver which TIDs to release frames
3209 * from, for PS-poll it will always have only a single bit set.
3210 * In the case this is used for a PS-poll initiated release, the
3211 * @num_frames parameter will always be 1 so code can be shared. In
3212 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3213 * on the TX status (and must report TX status) so that the PS-poll
3214 * period is properly ended. This is used to avoid sending multiple
3215 * responses for a retried PS-poll frame.
3216 * In the case this is used for uAPSD, the @num_frames parameter may be
3217 * bigger than one, but the driver may send fewer frames (it must send
3218 * at least one, however). In this case it is also responsible for
3219 * setting the EOSP flag in the QoS header of the frames. Also, when the
3220 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3221 * on the last frame in the SP. Alternatively, it may call the function
3222 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3223 * This callback must be atomic.
3224 * @allow_buffered_frames: Prepare device to allow the given number of frames
3225 * to go out to the given station. The frames will be sent by mac80211
3226 * via the usual TX path after this call. The TX information for frames
3227 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3228 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3229 * frames from multiple TIDs are released and the driver might reorder
3230 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3231 * on the last frame and clear it on all others and also handle the EOSP
3232 * bit in the QoS header correctly. Alternatively, it can also call the
3233 * ieee80211_sta_eosp() function.
3234 * The @tids parameter is a bitmap and tells the driver which TIDs the
3235 * frames will be on; it will at most have two bits set.
3236 * This callback must be atomic.
3237 *
3238 * @get_et_sset_count: Ethtool API to get string-set count.
3239 *
3240 * @get_et_stats: Ethtool API to get a set of u64 stats.
3241 *
3242 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3243 * and perhaps other supported types of ethtool data-sets.
3244 *
3245 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3246 * before associated. In multi-channel scenarios, a virtual interface is
3247 * bound to a channel before it is associated, but as it isn't associated
3248 * yet it need not necessarily be given airtime, in particular since any
3249 * transmission to a P2P GO needs to be synchronized against the GO's
3250 * powersave state. mac80211 will call this function before transmitting a
3251 * management frame prior to having successfully associated to allow the
3252 * driver to give it channel time for the transmission, to get a response
3253 * and to be able to synchronize with the GO.
3254 * The callback will be called before each transmission and upon return
3255 * mac80211 will transmit the frame right away.
3256 * The callback is optional and can (should!) sleep.
3257 *
3258 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3259 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3260 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3261 * setup-response is a direct packet not buffered by the AP.
3262 * mac80211 will call this function just before the transmission of a TDLS
3263 * discovery-request. The recommended period of protection is at least
3264 * 2 * (DTIM period).
3265 * The callback is optional and can sleep.
3266 *
3267 * @add_chanctx: Notifies device driver about new channel context creation.
3268 * This callback may sleep.
3269 * @remove_chanctx: Notifies device driver about channel context destruction.
3270 * This callback may sleep.
3271 * @change_chanctx: Notifies device driver about channel context changes that
3272 * may happen when combining different virtual interfaces on the same
3273 * channel context with different settings
3274 * This callback may sleep.
3275 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3276 * to vif. Possible use is for hw queue remapping.
3277 * This callback may sleep.
3278 * @unassign_vif_chanctx: Notifies device driver about channel context being
3279 * unbound from vif.
3280 * This callback may sleep.
3281 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3282 * another, as specified in the list of
3283 * @ieee80211_vif_chanctx_switch passed to the driver, according
3284 * to the mode defined in &ieee80211_chanctx_switch_mode.
3285 * This callback may sleep.
3286 *
3287 * @start_ap: Start operation on the AP interface, this is called after all the
3288 * information in bss_conf is set and beacon can be retrieved. A channel
3289 * context is bound before this is called. Note that if the driver uses
3290 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3291 * just "paused" for scanning/ROC, which is indicated by the beacon being
3292 * disabled/enabled via @bss_info_changed.
3293 * @stop_ap: Stop operation on the AP interface.
3294 *
3295 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3296 * during resume, when the reconfiguration has completed.
3297 * This can help the driver implement the reconfiguration step (and
3298 * indicate mac80211 is ready to receive frames).
3299 * This callback may sleep.
3300 *
3301 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3302 * Currently, this is only called for managed or P2P client interfaces.
3303 * This callback is optional; it must not sleep.
3304 *
3305 * @channel_switch_beacon: Starts a channel switch to a new channel.
3306 * Beacons are modified to include CSA or ECSA IEs before calling this
3307 * function. The corresponding count fields in these IEs must be
3308 * decremented, and when they reach 1 the driver must call
3309 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3310 * get the csa counter decremented by mac80211, but must check if it is
3311 * 1 using ieee80211_csa_is_complete() after the beacon has been
3312 * transmitted and then call ieee80211_csa_finish().
3313 * If the CSA count starts as zero or 1, this function will not be called,
3314 * since there won't be any time to beacon before the switch anyway.
3315 * @pre_channel_switch: This is an optional callback that is called
3316 * before a channel switch procedure is started (ie. when a STA
3317 * gets a CSA or an userspace initiated channel-switch), allowing
3318 * the driver to prepare for the channel switch.
3319 * @post_channel_switch: This is an optional callback that is called
3320 * after a channel switch procedure is completed, allowing the
3321 * driver to go back to a normal configuration.
3322 *
3323 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3324 * information in bss_conf is set up and the beacon can be retrieved. A
3325 * channel context is bound before this is called.
3326 * @leave_ibss: Leave the IBSS again.
3327 *
3328 * @get_expected_throughput: extract the expected throughput towards the
3329 * specified station. The returned value is expressed in Kbps. It returns 0
3330 * if the RC algorithm does not have proper data to provide.
3331 *
3332 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3333 * and hardware limits.
3334 *
3335 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3336 * is responsible for continually initiating channel-switching operations
3337 * and returning to the base channel for communication with the AP. The
3338 * driver receives a channel-switch request template and the location of
3339 * the switch-timing IE within the template as part of the invocation.
3340 * The template is valid only within the call, and the driver can
3341 * optionally copy the skb for further re-use.
3342 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3343 * peers must be on the base channel when the call completes.
3344 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3345 * response) has been received from a remote peer. The driver gets
3346 * parameters parsed from the incoming frame and may use them to continue
3347 * an ongoing channel-switch operation. In addition, a channel-switch
3348 * response template is provided, together with the location of the
3349 * switch-timing IE within the template. The skb can only be used within
3350 * the function call.
3351 *
3352 * @wake_tx_queue: Called when new packets have been added to the queue.
3353 */
3354struct ieee80211_ops {
3355 void (*tx)(struct ieee80211_hw *hw,
3356 struct ieee80211_tx_control *control,
3357 struct sk_buff *skb);
3358 int (*start)(struct ieee80211_hw *hw);
3359 void (*stop)(struct ieee80211_hw *hw);
3360#ifdef CONFIG_PM
3361 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3362 int (*resume)(struct ieee80211_hw *hw);
3363 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3364#endif
3365 int (*add_interface)(struct ieee80211_hw *hw,
3366 struct ieee80211_vif *vif);
3367 int (*change_interface)(struct ieee80211_hw *hw,
3368 struct ieee80211_vif *vif,
3369 enum nl80211_iftype new_type, bool p2p);
3370 void (*remove_interface)(struct ieee80211_hw *hw,
3371 struct ieee80211_vif *vif);
3372 int (*config)(struct ieee80211_hw *hw, u32 changed);
3373 void (*bss_info_changed)(struct ieee80211_hw *hw,
3374 struct ieee80211_vif *vif,
3375 struct ieee80211_bss_conf *info,
3376 u32 changed);
3377
3378 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3379 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3380
3381 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3382 struct netdev_hw_addr_list *mc_list);
3383 void (*configure_filter)(struct ieee80211_hw *hw,
3384 unsigned int changed_flags,
3385 unsigned int *total_flags,
3386 u64 multicast);
3387 void (*config_iface_filter)(struct ieee80211_hw *hw,
3388 struct ieee80211_vif *vif,
3389 unsigned int filter_flags,
3390 unsigned int changed_flags);
3391 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3392 bool set);
3393 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3394 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3395 struct ieee80211_key_conf *key);
3396 void (*update_tkip_key)(struct ieee80211_hw *hw,
3397 struct ieee80211_vif *vif,
3398 struct ieee80211_key_conf *conf,
3399 struct ieee80211_sta *sta,
3400 u32 iv32, u16 *phase1key);
3401 void (*set_rekey_data)(struct ieee80211_hw *hw,
3402 struct ieee80211_vif *vif,
3403 struct cfg80211_gtk_rekey_data *data);
3404 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3405 struct ieee80211_vif *vif, int idx);
3406 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3407 struct ieee80211_scan_request *req);
3408 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3409 struct ieee80211_vif *vif);
3410 int (*sched_scan_start)(struct ieee80211_hw *hw,
3411 struct ieee80211_vif *vif,
3412 struct cfg80211_sched_scan_request *req,
3413 struct ieee80211_scan_ies *ies);
3414 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3415 struct ieee80211_vif *vif);
3416 void (*sw_scan_start)(struct ieee80211_hw *hw,
3417 struct ieee80211_vif *vif,
3418 const u8 *mac_addr);
3419 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3420 struct ieee80211_vif *vif);
3421 int (*get_stats)(struct ieee80211_hw *hw,
3422 struct ieee80211_low_level_stats *stats);
3423 void (*get_key_seq)(struct ieee80211_hw *hw,
3424 struct ieee80211_key_conf *key,
3425 struct ieee80211_key_seq *seq);
3426 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3427 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3428 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3429 struct ieee80211_sta *sta);
3430 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3431 struct ieee80211_sta *sta);
3432#ifdef CONFIG_MAC80211_DEBUGFS
3433 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3434 struct ieee80211_vif *vif,
3435 struct ieee80211_sta *sta,
3436 struct dentry *dir);
3437 void (*sta_remove_debugfs)(struct ieee80211_hw *hw,
3438 struct ieee80211_vif *vif,
3439 struct ieee80211_sta *sta,
3440 struct dentry *dir);
3441#endif
3442 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3443 enum sta_notify_cmd, struct ieee80211_sta *sta);
3444 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3445 struct ieee80211_sta *sta,
3446 enum ieee80211_sta_state old_state,
3447 enum ieee80211_sta_state new_state);
3448 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3449 struct ieee80211_vif *vif,
3450 struct ieee80211_sta *sta);
3451 void (*sta_rc_update)(struct ieee80211_hw *hw,
3452 struct ieee80211_vif *vif,
3453 struct ieee80211_sta *sta,
3454 u32 changed);
3455 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3456 struct ieee80211_vif *vif,
3457 struct ieee80211_sta *sta);
3458 void (*sta_statistics)(struct ieee80211_hw *hw,
3459 struct ieee80211_vif *vif,
3460 struct ieee80211_sta *sta,
3461 struct station_info *sinfo);
3462 int (*conf_tx)(struct ieee80211_hw *hw,
3463 struct ieee80211_vif *vif, u16 ac,
3464 const struct ieee80211_tx_queue_params *params);
3465 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3466 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3467 u64 tsf);
3468 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3469 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3470 int (*ampdu_action)(struct ieee80211_hw *hw,
3471 struct ieee80211_vif *vif,
3472 struct ieee80211_ampdu_params *params);
3473 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3474 struct survey_info *survey);
3475 void (*rfkill_poll)(struct ieee80211_hw *hw);
3476 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3477#ifdef CONFIG_NL80211_TESTMODE
3478 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3479 void *data, int len);
3480 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3481 struct netlink_callback *cb,
3482 void *data, int len);
3483#endif
3484 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3485 u32 queues, bool drop);
3486 void (*channel_switch)(struct ieee80211_hw *hw,
3487 struct ieee80211_vif *vif,
3488 struct ieee80211_channel_switch *ch_switch);
3489 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3490 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3491
3492 int (*remain_on_channel)(struct ieee80211_hw *hw,
3493 struct ieee80211_vif *vif,
3494 struct ieee80211_channel *chan,
3495 int duration,
3496 enum ieee80211_roc_type type);
3497 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3498 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3499 void (*get_ringparam)(struct ieee80211_hw *hw,
3500 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3501 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3502 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3503 const struct cfg80211_bitrate_mask *mask);
3504 void (*event_callback)(struct ieee80211_hw *hw,
3505 struct ieee80211_vif *vif,
3506 const struct ieee80211_event *event);
3507
3508 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3509 struct ieee80211_sta *sta,
3510 u16 tids, int num_frames,
3511 enum ieee80211_frame_release_type reason,
3512 bool more_data);
3513 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3514 struct ieee80211_sta *sta,
3515 u16 tids, int num_frames,
3516 enum ieee80211_frame_release_type reason,
3517 bool more_data);
3518
3519 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3520 struct ieee80211_vif *vif, int sset);
3521 void (*get_et_stats)(struct ieee80211_hw *hw,
3522 struct ieee80211_vif *vif,
3523 struct ethtool_stats *stats, u64 *data);
3524 void (*get_et_strings)(struct ieee80211_hw *hw,
3525 struct ieee80211_vif *vif,
3526 u32 sset, u8 *data);
3527
3528 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3529 struct ieee80211_vif *vif);
3530
3531 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3532 struct ieee80211_vif *vif);
3533
3534 int (*add_chanctx)(struct ieee80211_hw *hw,
3535 struct ieee80211_chanctx_conf *ctx);
3536 void (*remove_chanctx)(struct ieee80211_hw *hw,
3537 struct ieee80211_chanctx_conf *ctx);
3538 void (*change_chanctx)(struct ieee80211_hw *hw,
3539 struct ieee80211_chanctx_conf *ctx,
3540 u32 changed);
3541 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3542 struct ieee80211_vif *vif,
3543 struct ieee80211_chanctx_conf *ctx);
3544 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3545 struct ieee80211_vif *vif,
3546 struct ieee80211_chanctx_conf *ctx);
3547 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3548 struct ieee80211_vif_chanctx_switch *vifs,
3549 int n_vifs,
3550 enum ieee80211_chanctx_switch_mode mode);
3551
3552 void (*reconfig_complete)(struct ieee80211_hw *hw,
3553 enum ieee80211_reconfig_type reconfig_type);
3554
3555#if IS_ENABLED(CONFIG_IPV6)
3556 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3557 struct ieee80211_vif *vif,
3558 struct inet6_dev *idev);
3559#endif
3560 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3561 struct ieee80211_vif *vif,
3562 struct cfg80211_chan_def *chandef);
3563 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3564 struct ieee80211_vif *vif,
3565 struct ieee80211_channel_switch *ch_switch);
3566
3567 int (*post_channel_switch)(struct ieee80211_hw *hw,
3568 struct ieee80211_vif *vif);
3569
3570 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3571 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3572 u32 (*get_expected_throughput)(struct ieee80211_sta *sta);
3573 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3574 int *dbm);
3575
3576 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3577 struct ieee80211_vif *vif,
3578 struct ieee80211_sta *sta, u8 oper_class,
3579 struct cfg80211_chan_def *chandef,
3580 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3581 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3582 struct ieee80211_vif *vif,
3583 struct ieee80211_sta *sta);
3584 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3585 struct ieee80211_vif *vif,
3586 struct ieee80211_tdls_ch_sw_params *params);
3587
3588 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3589 struct ieee80211_txq *txq);
3590};
3591
3592/**
3593 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3594 *
3595 * This must be called once for each hardware device. The returned pointer
3596 * must be used to refer to this device when calling other functions.
3597 * mac80211 allocates a private data area for the driver pointed to by
3598 * @priv in &struct ieee80211_hw, the size of this area is given as
3599 * @priv_data_len.
3600 *
3601 * @priv_data_len: length of private data
3602 * @ops: callbacks for this device
3603 * @requested_name: Requested name for this device.
3604 * NULL is valid value, and means use the default naming (phy%d)
3605 *
3606 * Return: A pointer to the new hardware device, or %NULL on error.
3607 */
3608struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3609 const struct ieee80211_ops *ops,
3610 const char *requested_name);
3611
3612/**
3613 * ieee80211_alloc_hw - Allocate a new hardware device
3614 *
3615 * This must be called once for each hardware device. The returned pointer
3616 * must be used to refer to this device when calling other functions.
3617 * mac80211 allocates a private data area for the driver pointed to by
3618 * @priv in &struct ieee80211_hw, the size of this area is given as
3619 * @priv_data_len.
3620 *
3621 * @priv_data_len: length of private data
3622 * @ops: callbacks for this device
3623 *
3624 * Return: A pointer to the new hardware device, or %NULL on error.
3625 */
3626static inline
3627struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3628 const struct ieee80211_ops *ops)
3629{
3630 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3631}
3632
3633/**
3634 * ieee80211_register_hw - Register hardware device
3635 *
3636 * You must call this function before any other functions in
3637 * mac80211. Note that before a hardware can be registered, you
3638 * need to fill the contained wiphy's information.
3639 *
3640 * @hw: the device to register as returned by ieee80211_alloc_hw()
3641 *
3642 * Return: 0 on success. An error code otherwise.
3643 */
3644int ieee80211_register_hw(struct ieee80211_hw *hw);
3645
3646/**
3647 * struct ieee80211_tpt_blink - throughput blink description
3648 * @throughput: throughput in Kbit/sec
3649 * @blink_time: blink time in milliseconds
3650 * (full cycle, ie. one off + one on period)
3651 */
3652struct ieee80211_tpt_blink {
3653 int throughput;
3654 int blink_time;
3655};
3656
3657/**
3658 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3659 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3660 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3661 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3662 * interface is connected in some way, including being an AP
3663 */
3664enum ieee80211_tpt_led_trigger_flags {
3665 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3666 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3667 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3668};
3669
3670#ifdef CONFIG_MAC80211_LEDS
3671const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3672const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3673const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3674const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3675const char *
3676__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3677 unsigned int flags,
3678 const struct ieee80211_tpt_blink *blink_table,
3679 unsigned int blink_table_len);
3680#endif
3681/**
3682 * ieee80211_get_tx_led_name - get name of TX LED
3683 *
3684 * mac80211 creates a transmit LED trigger for each wireless hardware
3685 * that can be used to drive LEDs if your driver registers a LED device.
3686 * This function returns the name (or %NULL if not configured for LEDs)
3687 * of the trigger so you can automatically link the LED device.
3688 *
3689 * @hw: the hardware to get the LED trigger name for
3690 *
3691 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3692 */
3693static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3694{
3695#ifdef CONFIG_MAC80211_LEDS
3696 return __ieee80211_get_tx_led_name(hw);
3697#else
3698 return NULL;
3699#endif
3700}
3701
3702/**
3703 * ieee80211_get_rx_led_name - get name of RX LED
3704 *
3705 * mac80211 creates a receive LED trigger for each wireless hardware
3706 * that can be used to drive LEDs if your driver registers a LED device.
3707 * This function returns the name (or %NULL if not configured for LEDs)
3708 * of the trigger so you can automatically link the LED device.
3709 *
3710 * @hw: the hardware to get the LED trigger name for
3711 *
3712 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3713 */
3714static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3715{
3716#ifdef CONFIG_MAC80211_LEDS
3717 return __ieee80211_get_rx_led_name(hw);
3718#else
3719 return NULL;
3720#endif
3721}
3722
3723/**
3724 * ieee80211_get_assoc_led_name - get name of association LED
3725 *
3726 * mac80211 creates a association LED trigger for each wireless hardware
3727 * that can be used to drive LEDs if your driver registers a LED device.
3728 * This function returns the name (or %NULL if not configured for LEDs)
3729 * of the trigger so you can automatically link the LED device.
3730 *
3731 * @hw: the hardware to get the LED trigger name for
3732 *
3733 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3734 */
3735static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3736{
3737#ifdef CONFIG_MAC80211_LEDS
3738 return __ieee80211_get_assoc_led_name(hw);
3739#else
3740 return NULL;
3741#endif
3742}
3743
3744/**
3745 * ieee80211_get_radio_led_name - get name of radio LED
3746 *
3747 * mac80211 creates a radio change LED trigger for each wireless hardware
3748 * that can be used to drive LEDs if your driver registers a LED device.
3749 * This function returns the name (or %NULL if not configured for LEDs)
3750 * of the trigger so you can automatically link the LED device.
3751 *
3752 * @hw: the hardware to get the LED trigger name for
3753 *
3754 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3755 */
3756static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3757{
3758#ifdef CONFIG_MAC80211_LEDS
3759 return __ieee80211_get_radio_led_name(hw);
3760#else
3761 return NULL;
3762#endif
3763}
3764
3765/**
3766 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3767 * @hw: the hardware to create the trigger for
3768 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3769 * @blink_table: the blink table -- needs to be ordered by throughput
3770 * @blink_table_len: size of the blink table
3771 *
3772 * Return: %NULL (in case of error, or if no LED triggers are
3773 * configured) or the name of the new trigger.
3774 *
3775 * Note: This function must be called before ieee80211_register_hw().
3776 */
3777static inline const char *
3778ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3779 const struct ieee80211_tpt_blink *blink_table,
3780 unsigned int blink_table_len)
3781{
3782#ifdef CONFIG_MAC80211_LEDS
3783 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3784 blink_table_len);
3785#else
3786 return NULL;
3787#endif
3788}
3789
3790/**
3791 * ieee80211_unregister_hw - Unregister a hardware device
3792 *
3793 * This function instructs mac80211 to free allocated resources
3794 * and unregister netdevices from the networking subsystem.
3795 *
3796 * @hw: the hardware to unregister
3797 */
3798void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3799
3800/**
3801 * ieee80211_free_hw - free hardware descriptor
3802 *
3803 * This function frees everything that was allocated, including the
3804 * private data for the driver. You must call ieee80211_unregister_hw()
3805 * before calling this function.
3806 *
3807 * @hw: the hardware to free
3808 */
3809void ieee80211_free_hw(struct ieee80211_hw *hw);
3810
3811/**
3812 * ieee80211_restart_hw - restart hardware completely
3813 *
3814 * Call this function when the hardware was restarted for some reason
3815 * (hardware error, ...) and the driver is unable to restore its state
3816 * by itself. mac80211 assumes that at this point the driver/hardware
3817 * is completely uninitialised and stopped, it starts the process by
3818 * calling the ->start() operation. The driver will need to reset all
3819 * internal state that it has prior to calling this function.
3820 *
3821 * @hw: the hardware to restart
3822 */
3823void ieee80211_restart_hw(struct ieee80211_hw *hw);
3824
3825/**
3826 * ieee80211_rx_napi - receive frame from NAPI context
3827 *
3828 * Use this function to hand received frames to mac80211. The receive
3829 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3830 * paged @skb is used, the driver is recommended to put the ieee80211
3831 * header of the frame on the linear part of the @skb to avoid memory
3832 * allocation and/or memcpy by the stack.
3833 *
3834 * This function may not be called in IRQ context. Calls to this function
3835 * for a single hardware must be synchronized against each other. Calls to
3836 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3837 * mixed for a single hardware. Must not run concurrently with
3838 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3839 *
3840 * This function must be called with BHs disabled.
3841 *
3842 * @hw: the hardware this frame came in on
3843 * @skb: the buffer to receive, owned by mac80211 after this call
3844 * @napi: the NAPI context
3845 */
3846void ieee80211_rx_napi(struct ieee80211_hw *hw, struct sk_buff *skb,
3847 struct napi_struct *napi);
3848
3849/**
3850 * ieee80211_rx - receive frame
3851 *
3852 * Use this function to hand received frames to mac80211. The receive
3853 * buffer in @skb must start with an IEEE 802.11 header. In case of a
3854 * paged @skb is used, the driver is recommended to put the ieee80211
3855 * header of the frame on the linear part of the @skb to avoid memory
3856 * allocation and/or memcpy by the stack.
3857 *
3858 * This function may not be called in IRQ context. Calls to this function
3859 * for a single hardware must be synchronized against each other. Calls to
3860 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
3861 * mixed for a single hardware. Must not run concurrently with
3862 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3863 *
3864 * In process context use instead ieee80211_rx_ni().
3865 *
3866 * @hw: the hardware this frame came in on
3867 * @skb: the buffer to receive, owned by mac80211 after this call
3868 */
3869static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
3870{
3871 ieee80211_rx_napi(hw, skb, NULL);
3872}
3873
3874/**
3875 * ieee80211_rx_irqsafe - receive frame
3876 *
3877 * Like ieee80211_rx() but can be called in IRQ context
3878 * (internally defers to a tasklet.)
3879 *
3880 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
3881 * be mixed for a single hardware.Must not run concurrently with
3882 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3883 *
3884 * @hw: the hardware this frame came in on
3885 * @skb: the buffer to receive, owned by mac80211 after this call
3886 */
3887void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
3888
3889/**
3890 * ieee80211_rx_ni - receive frame (in process context)
3891 *
3892 * Like ieee80211_rx() but can be called in process context
3893 * (internally disables bottom halves).
3894 *
3895 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
3896 * not be mixed for a single hardware. Must not run concurrently with
3897 * ieee80211_tx_status() or ieee80211_tx_status_ni().
3898 *
3899 * @hw: the hardware this frame came in on
3900 * @skb: the buffer to receive, owned by mac80211 after this call
3901 */
3902static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
3903 struct sk_buff *skb)
3904{
3905 local_bh_disable();
3906 ieee80211_rx(hw, skb);
3907 local_bh_enable();
3908}
3909
3910/**
3911 * ieee80211_sta_ps_transition - PS transition for connected sta
3912 *
3913 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
3914 * flag set, use this function to inform mac80211 about a connected station
3915 * entering/leaving PS mode.
3916 *
3917 * This function may not be called in IRQ context or with softirqs enabled.
3918 *
3919 * Calls to this function for a single hardware must be synchronized against
3920 * each other.
3921 *
3922 * @sta: currently connected sta
3923 * @start: start or stop PS
3924 *
3925 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
3926 */
3927int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
3928
3929/**
3930 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
3931 * (in process context)
3932 *
3933 * Like ieee80211_sta_ps_transition() but can be called in process context
3934 * (internally disables bottom halves). Concurrent call restriction still
3935 * applies.
3936 *
3937 * @sta: currently connected sta
3938 * @start: start or stop PS
3939 *
3940 * Return: Like ieee80211_sta_ps_transition().
3941 */
3942static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
3943 bool start)
3944{
3945 int ret;
3946
3947 local_bh_disable();
3948 ret = ieee80211_sta_ps_transition(sta, start);
3949 local_bh_enable();
3950
3951 return ret;
3952}
3953
3954/*
3955 * The TX headroom reserved by mac80211 for its own tx_status functions.
3956 * This is enough for the radiotap header.
3957 */
3958#define IEEE80211_TX_STATUS_HEADROOM 14
3959
3960/**
3961 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
3962 * @sta: &struct ieee80211_sta pointer for the sleeping station
3963 * @tid: the TID that has buffered frames
3964 * @buffered: indicates whether or not frames are buffered for this TID
3965 *
3966 * If a driver buffers frames for a powersave station instead of passing
3967 * them back to mac80211 for retransmission, the station may still need
3968 * to be told that there are buffered frames via the TIM bit.
3969 *
3970 * This function informs mac80211 whether or not there are frames that are
3971 * buffered in the driver for a given TID; mac80211 can then use this data
3972 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
3973 * call! Beware of the locking!)
3974 *
3975 * If all frames are released to the station (due to PS-poll or uAPSD)
3976 * then the driver needs to inform mac80211 that there no longer are
3977 * frames buffered. However, when the station wakes up mac80211 assumes
3978 * that all buffered frames will be transmitted and clears this data,
3979 * drivers need to make sure they inform mac80211 about all buffered
3980 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
3981 *
3982 * Note that technically mac80211 only needs to know this per AC, not per
3983 * TID, but since driver buffering will inevitably happen per TID (since
3984 * it is related to aggregation) it is easier to make mac80211 map the
3985 * TID to the AC as required instead of keeping track in all drivers that
3986 * use this API.
3987 */
3988void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
3989 u8 tid, bool buffered);
3990
3991/**
3992 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
3993 *
3994 * Call this function in a driver with per-packet rate selection support
3995 * to combine the rate info in the packet tx info with the most recent
3996 * rate selection table for the station entry.
3997 *
3998 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3999 * @sta: the receiver station to which this packet is sent.
4000 * @skb: the frame to be transmitted.
4001 * @dest: buffer for extracted rate/retry information
4002 * @max_rates: maximum number of rates to fetch
4003 */
4004void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4005 struct ieee80211_sta *sta,
4006 struct sk_buff *skb,
4007 struct ieee80211_tx_rate *dest,
4008 int max_rates);
4009
4010/**
4011 * ieee80211_tx_status - transmit status callback
4012 *
4013 * Call this function for all transmitted frames after they have been
4014 * transmitted. It is permissible to not call this function for
4015 * multicast frames but this can affect statistics.
4016 *
4017 * This function may not be called in IRQ context. Calls to this function
4018 * for a single hardware must be synchronized against each other. Calls
4019 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4020 * may not be mixed for a single hardware. Must not run concurrently with
4021 * ieee80211_rx() or ieee80211_rx_ni().
4022 *
4023 * @hw: the hardware the frame was transmitted by
4024 * @skb: the frame that was transmitted, owned by mac80211 after this call
4025 */
4026void ieee80211_tx_status(struct ieee80211_hw *hw,
4027 struct sk_buff *skb);
4028
4029/**
4030 * ieee80211_tx_status_noskb - transmit status callback without skb
4031 *
4032 * This function can be used as a replacement for ieee80211_tx_status
4033 * in drivers that cannot reliably map tx status information back to
4034 * specific skbs.
4035 *
4036 * Calls to this function for a single hardware must be synchronized
4037 * against each other. Calls to this function, ieee80211_tx_status_ni()
4038 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4039 *
4040 * @hw: the hardware the frame was transmitted by
4041 * @sta: the receiver station to which this packet is sent
4042 * (NULL for multicast packets)
4043 * @info: tx status information
4044 */
4045void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4046 struct ieee80211_sta *sta,
4047 struct ieee80211_tx_info *info);
4048
4049/**
4050 * ieee80211_tx_status_ni - transmit status callback (in process context)
4051 *
4052 * Like ieee80211_tx_status() but can be called in process context.
4053 *
4054 * Calls to this function, ieee80211_tx_status() and
4055 * ieee80211_tx_status_irqsafe() may not be mixed
4056 * for a single hardware.
4057 *
4058 * @hw: the hardware the frame was transmitted by
4059 * @skb: the frame that was transmitted, owned by mac80211 after this call
4060 */
4061static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4062 struct sk_buff *skb)
4063{
4064 local_bh_disable();
4065 ieee80211_tx_status(hw, skb);
4066 local_bh_enable();
4067}
4068
4069/**
4070 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4071 *
4072 * Like ieee80211_tx_status() but can be called in IRQ context
4073 * (internally defers to a tasklet.)
4074 *
4075 * Calls to this function, ieee80211_tx_status() and
4076 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4077 *
4078 * @hw: the hardware the frame was transmitted by
4079 * @skb: the frame that was transmitted, owned by mac80211 after this call
4080 */
4081void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4082 struct sk_buff *skb);
4083
4084/**
4085 * ieee80211_report_low_ack - report non-responding station
4086 *
4087 * When operating in AP-mode, call this function to report a non-responding
4088 * connected STA.
4089 *
4090 * @sta: the non-responding connected sta
4091 * @num_packets: number of packets sent to @sta without a response
4092 */
4093void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4094
4095#define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4096
4097/**
4098 * struct ieee80211_mutable_offsets - mutable beacon offsets
4099 * @tim_offset: position of TIM element
4100 * @tim_length: size of TIM element
4101 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4102 * to CSA counters. This array can contain zero values which
4103 * should be ignored.
4104 */
4105struct ieee80211_mutable_offsets {
4106 u16 tim_offset;
4107 u16 tim_length;
4108
4109 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4110};
4111
4112/**
4113 * ieee80211_beacon_get_template - beacon template generation function
4114 * @hw: pointer obtained from ieee80211_alloc_hw().
4115 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4116 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4117 * receive the offsets that may be updated by the driver.
4118 *
4119 * If the driver implements beaconing modes, it must use this function to
4120 * obtain the beacon template.
4121 *
4122 * This function should be used if the beacon frames are generated by the
4123 * device, and then the driver must use the returned beacon as the template
4124 * The driver or the device are responsible to update the DTIM and, when
4125 * applicable, the CSA count.
4126 *
4127 * The driver is responsible for freeing the returned skb.
4128 *
4129 * Return: The beacon template. %NULL on error.
4130 */
4131struct sk_buff *
4132ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4133 struct ieee80211_vif *vif,
4134 struct ieee80211_mutable_offsets *offs);
4135
4136/**
4137 * ieee80211_beacon_get_tim - beacon generation function
4138 * @hw: pointer obtained from ieee80211_alloc_hw().
4139 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4140 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4141 * Set to 0 if invalid (in non-AP modes).
4142 * @tim_length: pointer to variable that will receive the TIM IE length,
4143 * (including the ID and length bytes!).
4144 * Set to 0 if invalid (in non-AP modes).
4145 *
4146 * If the driver implements beaconing modes, it must use this function to
4147 * obtain the beacon frame.
4148 *
4149 * If the beacon frames are generated by the host system (i.e., not in
4150 * hardware/firmware), the driver uses this function to get each beacon
4151 * frame from mac80211 -- it is responsible for calling this function exactly
4152 * once before the beacon is needed (e.g. based on hardware interrupt).
4153 *
4154 * The driver is responsible for freeing the returned skb.
4155 *
4156 * Return: The beacon template. %NULL on error.
4157 */
4158struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4159 struct ieee80211_vif *vif,
4160 u16 *tim_offset, u16 *tim_length);
4161
4162/**
4163 * ieee80211_beacon_get - beacon generation function
4164 * @hw: pointer obtained from ieee80211_alloc_hw().
4165 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4166 *
4167 * See ieee80211_beacon_get_tim().
4168 *
4169 * Return: See ieee80211_beacon_get_tim().
4170 */
4171static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4172 struct ieee80211_vif *vif)
4173{
4174 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4175}
4176
4177/**
4178 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4179 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4180 *
4181 * The csa counter should be updated after each beacon transmission.
4182 * This function is called implicitly when
4183 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4184 * beacon frames are generated by the device, the driver should call this
4185 * function after each beacon transmission to sync mac80211's csa counters.
4186 *
4187 * Return: new csa counter value
4188 */
4189u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4190
4191/**
4192 * ieee80211_csa_finish - notify mac80211 about channel switch
4193 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4194 *
4195 * After a channel switch announcement was scheduled and the counter in this
4196 * announcement hits 1, this function must be called by the driver to
4197 * notify mac80211 that the channel can be changed.
4198 */
4199void ieee80211_csa_finish(struct ieee80211_vif *vif);
4200
4201/**
4202 * ieee80211_csa_is_complete - find out if counters reached 1
4203 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4204 *
4205 * This function returns whether the channel switch counters reached zero.
4206 */
4207bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4208
4209
4210/**
4211 * ieee80211_proberesp_get - retrieve a Probe Response template
4212 * @hw: pointer obtained from ieee80211_alloc_hw().
4213 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4214 *
4215 * Creates a Probe Response template which can, for example, be uploaded to
4216 * hardware. The destination address should be set by the caller.
4217 *
4218 * Can only be called in AP mode.
4219 *
4220 * Return: The Probe Response template. %NULL on error.
4221 */
4222struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4223 struct ieee80211_vif *vif);
4224
4225/**
4226 * ieee80211_pspoll_get - retrieve a PS Poll template
4227 * @hw: pointer obtained from ieee80211_alloc_hw().
4228 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4229 *
4230 * Creates a PS Poll a template which can, for example, uploaded to
4231 * hardware. The template must be updated after association so that correct
4232 * AID, BSSID and MAC address is used.
4233 *
4234 * Note: Caller (or hardware) is responsible for setting the
4235 * &IEEE80211_FCTL_PM bit.
4236 *
4237 * Return: The PS Poll template. %NULL on error.
4238 */
4239struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4240 struct ieee80211_vif *vif);
4241
4242/**
4243 * ieee80211_nullfunc_get - retrieve a nullfunc template
4244 * @hw: pointer obtained from ieee80211_alloc_hw().
4245 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4246 *
4247 * Creates a Nullfunc template which can, for example, uploaded to
4248 * hardware. The template must be updated after association so that correct
4249 * BSSID and address is used.
4250 *
4251 * Note: Caller (or hardware) is responsible for setting the
4252 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4253 *
4254 * Return: The nullfunc template. %NULL on error.
4255 */
4256struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4257 struct ieee80211_vif *vif);
4258
4259/**
4260 * ieee80211_probereq_get - retrieve a Probe Request template
4261 * @hw: pointer obtained from ieee80211_alloc_hw().
4262 * @src_addr: source MAC address
4263 * @ssid: SSID buffer
4264 * @ssid_len: length of SSID
4265 * @tailroom: tailroom to reserve at end of SKB for IEs
4266 *
4267 * Creates a Probe Request template which can, for example, be uploaded to
4268 * hardware.
4269 *
4270 * Return: The Probe Request template. %NULL on error.
4271 */
4272struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4273 const u8 *src_addr,
4274 const u8 *ssid, size_t ssid_len,
4275 size_t tailroom);
4276
4277/**
4278 * ieee80211_rts_get - RTS frame generation function
4279 * @hw: pointer obtained from ieee80211_alloc_hw().
4280 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4281 * @frame: pointer to the frame that is going to be protected by the RTS.
4282 * @frame_len: the frame length (in octets).
4283 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4284 * @rts: The buffer where to store the RTS frame.
4285 *
4286 * If the RTS frames are generated by the host system (i.e., not in
4287 * hardware/firmware), the low-level driver uses this function to receive
4288 * the next RTS frame from the 802.11 code. The low-level is responsible
4289 * for calling this function before and RTS frame is needed.
4290 */
4291void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4292 const void *frame, size_t frame_len,
4293 const struct ieee80211_tx_info *frame_txctl,
4294 struct ieee80211_rts *rts);
4295
4296/**
4297 * ieee80211_rts_duration - Get the duration field for an RTS frame
4298 * @hw: pointer obtained from ieee80211_alloc_hw().
4299 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4300 * @frame_len: the length of the frame that is going to be protected by the RTS.
4301 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4302 *
4303 * If the RTS is generated in firmware, but the host system must provide
4304 * the duration field, the low-level driver uses this function to receive
4305 * the duration field value in little-endian byteorder.
4306 *
4307 * Return: The duration.
4308 */
4309__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4310 struct ieee80211_vif *vif, size_t frame_len,
4311 const struct ieee80211_tx_info *frame_txctl);
4312
4313/**
4314 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4315 * @hw: pointer obtained from ieee80211_alloc_hw().
4316 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4317 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4318 * @frame_len: the frame length (in octets).
4319 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4320 * @cts: The buffer where to store the CTS-to-self frame.
4321 *
4322 * If the CTS-to-self frames are generated by the host system (i.e., not in
4323 * hardware/firmware), the low-level driver uses this function to receive
4324 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4325 * for calling this function before and CTS-to-self frame is needed.
4326 */
4327void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4328 struct ieee80211_vif *vif,
4329 const void *frame, size_t frame_len,
4330 const struct ieee80211_tx_info *frame_txctl,
4331 struct ieee80211_cts *cts);
4332
4333/**
4334 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4335 * @hw: pointer obtained from ieee80211_alloc_hw().
4336 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4337 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4338 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4339 *
4340 * If the CTS-to-self is generated in firmware, but the host system must provide
4341 * the duration field, the low-level driver uses this function to receive
4342 * the duration field value in little-endian byteorder.
4343 *
4344 * Return: The duration.
4345 */
4346__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4347 struct ieee80211_vif *vif,
4348 size_t frame_len,
4349 const struct ieee80211_tx_info *frame_txctl);
4350
4351/**
4352 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4353 * @hw: pointer obtained from ieee80211_alloc_hw().
4354 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4355 * @band: the band to calculate the frame duration on
4356 * @frame_len: the length of the frame.
4357 * @rate: the rate at which the frame is going to be transmitted.
4358 *
4359 * Calculate the duration field of some generic frame, given its
4360 * length and transmission rate (in 100kbps).
4361 *
4362 * Return: The duration.
4363 */
4364__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4365 struct ieee80211_vif *vif,
4366 enum ieee80211_band band,
4367 size_t frame_len,
4368 struct ieee80211_rate *rate);
4369
4370/**
4371 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4372 * @hw: pointer as obtained from ieee80211_alloc_hw().
4373 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4374 *
4375 * Function for accessing buffered broadcast and multicast frames. If
4376 * hardware/firmware does not implement buffering of broadcast/multicast
4377 * frames when power saving is used, 802.11 code buffers them in the host
4378 * memory. The low-level driver uses this function to fetch next buffered
4379 * frame. In most cases, this is used when generating beacon frame.
4380 *
4381 * Return: A pointer to the next buffered skb or NULL if no more buffered
4382 * frames are available.
4383 *
4384 * Note: buffered frames are returned only after DTIM beacon frame was
4385 * generated with ieee80211_beacon_get() and the low-level driver must thus
4386 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4387 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4388 * does not need to check for DTIM beacons separately and should be able to
4389 * use common code for all beacons.
4390 */
4391struct sk_buff *
4392ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4393
4394/**
4395 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4396 *
4397 * This function returns the TKIP phase 1 key for the given IV32.
4398 *
4399 * @keyconf: the parameter passed with the set key
4400 * @iv32: IV32 to get the P1K for
4401 * @p1k: a buffer to which the key will be written, as 5 u16 values
4402 */
4403void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4404 u32 iv32, u16 *p1k);
4405
4406/**
4407 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4408 *
4409 * This function returns the TKIP phase 1 key for the IV32 taken
4410 * from the given packet.
4411 *
4412 * @keyconf: the parameter passed with the set key
4413 * @skb: the packet to take the IV32 value from that will be encrypted
4414 * with this P1K
4415 * @p1k: a buffer to which the key will be written, as 5 u16 values
4416 */
4417static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4418 struct sk_buff *skb, u16 *p1k)
4419{
4420 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4421 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4422 u32 iv32 = get_unaligned_le32(&data[4]);
4423
4424 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4425}
4426
4427/**
4428 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4429 *
4430 * This function returns the TKIP phase 1 key for the given IV32
4431 * and transmitter address.
4432 *
4433 * @keyconf: the parameter passed with the set key
4434 * @ta: TA that will be used with the key
4435 * @iv32: IV32 to get the P1K for
4436 * @p1k: a buffer to which the key will be written, as 5 u16 values
4437 */
4438void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4439 const u8 *ta, u32 iv32, u16 *p1k);
4440
4441/**
4442 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4443 *
4444 * This function computes the TKIP RC4 key for the IV values
4445 * in the packet.
4446 *
4447 * @keyconf: the parameter passed with the set key
4448 * @skb: the packet to take the IV32/IV16 values from that will be
4449 * encrypted with this key
4450 * @p2k: a buffer to which the key will be written, 16 bytes
4451 */
4452void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4453 struct sk_buff *skb, u8 *p2k);
4454
4455/**
4456 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
4457 *
4458 * @pos: start of crypto header
4459 * @keyconf: the parameter passed with the set key
4460 * @pn: PN to add
4461 *
4462 * Returns: pointer to the octet following IVs (i.e. beginning of
4463 * the packet payload)
4464 *
4465 * This function writes the tkip IV value to pos (which should
4466 * point to the crypto header)
4467 */
4468u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
4469
4470/**
4471 * ieee80211_get_key_rx_seq - get key RX sequence counter
4472 *
4473 * @keyconf: the parameter passed with the set key
4474 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4475 * the value on TID 0 is also used for non-QoS frames. For
4476 * CMAC, only TID 0 is valid.
4477 * @seq: buffer to receive the sequence data
4478 *
4479 * This function allows a driver to retrieve the current RX IV/PNs
4480 * for the given key. It must not be called if IV checking is done
4481 * by the device and not by mac80211.
4482 *
4483 * Note that this function may only be called when no RX processing
4484 * can be done concurrently.
4485 */
4486void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4487 int tid, struct ieee80211_key_seq *seq);
4488
4489/**
4490 * ieee80211_set_key_rx_seq - set key RX sequence counter
4491 *
4492 * @keyconf: the parameter passed with the set key
4493 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4494 * the value on TID 0 is also used for non-QoS frames. For
4495 * CMAC, only TID 0 is valid.
4496 * @seq: new sequence data
4497 *
4498 * This function allows a driver to set the current RX IV/PNs for the
4499 * given key. This is useful when resuming from WoWLAN sleep and GTK
4500 * rekey may have been done while suspended. It should not be called
4501 * if IV checking is done by the device and not by mac80211.
4502 *
4503 * Note that this function may only be called when no RX processing
4504 * can be done concurrently.
4505 */
4506void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4507 int tid, struct ieee80211_key_seq *seq);
4508
4509/**
4510 * ieee80211_remove_key - remove the given key
4511 * @keyconf: the parameter passed with the set key
4512 *
4513 * Remove the given key. If the key was uploaded to the hardware at the
4514 * time this function is called, it is not deleted in the hardware but
4515 * instead assumed to have been removed already.
4516 *
4517 * Note that due to locking considerations this function can (currently)
4518 * only be called during key iteration (ieee80211_iter_keys().)
4519 */
4520void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4521
4522/**
4523 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4524 * @vif: the virtual interface to add the key on
4525 * @keyconf: new key data
4526 *
4527 * When GTK rekeying was done while the system was suspended, (a) new
4528 * key(s) will be available. These will be needed by mac80211 for proper
4529 * RX processing, so this function allows setting them.
4530 *
4531 * The function returns the newly allocated key structure, which will
4532 * have similar contents to the passed key configuration but point to
4533 * mac80211-owned memory. In case of errors, the function returns an
4534 * ERR_PTR(), use IS_ERR() etc.
4535 *
4536 * Note that this function assumes the key isn't added to hardware
4537 * acceleration, so no TX will be done with the key. Since it's a GTK
4538 * on managed (station) networks, this is true anyway. If the driver
4539 * calls this function from the resume callback and subsequently uses
4540 * the return code 1 to reconfigure the device, this key will be part
4541 * of the reconfiguration.
4542 *
4543 * Note that the driver should also call ieee80211_set_key_rx_seq()
4544 * for the new key for each TID to set up sequence counters properly.
4545 *
4546 * IMPORTANT: If this replaces a key that is present in the hardware,
4547 * then it will attempt to remove it during this call. In many cases
4548 * this isn't what you want, so call ieee80211_remove_key() first for
4549 * the key that's being replaced.
4550 */
4551struct ieee80211_key_conf *
4552ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4553 struct ieee80211_key_conf *keyconf);
4554
4555/**
4556 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4557 * @vif: virtual interface the rekeying was done on
4558 * @bssid: The BSSID of the AP, for checking association
4559 * @replay_ctr: the new replay counter after GTK rekeying
4560 * @gfp: allocation flags
4561 */
4562void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4563 const u8 *replay_ctr, gfp_t gfp);
4564
4565/**
4566 * ieee80211_wake_queue - wake specific queue
4567 * @hw: pointer as obtained from ieee80211_alloc_hw().
4568 * @queue: queue number (counted from zero).
4569 *
4570 * Drivers should use this function instead of netif_wake_queue.
4571 */
4572void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4573
4574/**
4575 * ieee80211_stop_queue - stop specific queue
4576 * @hw: pointer as obtained from ieee80211_alloc_hw().
4577 * @queue: queue number (counted from zero).
4578 *
4579 * Drivers should use this function instead of netif_stop_queue.
4580 */
4581void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4582
4583/**
4584 * ieee80211_queue_stopped - test status of the queue
4585 * @hw: pointer as obtained from ieee80211_alloc_hw().
4586 * @queue: queue number (counted from zero).
4587 *
4588 * Drivers should use this function instead of netif_stop_queue.
4589 *
4590 * Return: %true if the queue is stopped. %false otherwise.
4591 */
4592
4593int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4594
4595/**
4596 * ieee80211_stop_queues - stop all queues
4597 * @hw: pointer as obtained from ieee80211_alloc_hw().
4598 *
4599 * Drivers should use this function instead of netif_stop_queue.
4600 */
4601void ieee80211_stop_queues(struct ieee80211_hw *hw);
4602
4603/**
4604 * ieee80211_wake_queues - wake all queues
4605 * @hw: pointer as obtained from ieee80211_alloc_hw().
4606 *
4607 * Drivers should use this function instead of netif_wake_queue.
4608 */
4609void ieee80211_wake_queues(struct ieee80211_hw *hw);
4610
4611/**
4612 * ieee80211_scan_completed - completed hardware scan
4613 *
4614 * When hardware scan offload is used (i.e. the hw_scan() callback is
4615 * assigned) this function needs to be called by the driver to notify
4616 * mac80211 that the scan finished. This function can be called from
4617 * any context, including hardirq context.
4618 *
4619 * @hw: the hardware that finished the scan
4620 * @aborted: set to true if scan was aborted
4621 */
4622void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
4623
4624/**
4625 * ieee80211_sched_scan_results - got results from scheduled scan
4626 *
4627 * When a scheduled scan is running, this function needs to be called by the
4628 * driver whenever there are new scan results available.
4629 *
4630 * @hw: the hardware that is performing scheduled scans
4631 */
4632void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4633
4634/**
4635 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4636 *
4637 * When a scheduled scan is running, this function can be called by
4638 * the driver if it needs to stop the scan to perform another task.
4639 * Usual scenarios are drivers that cannot continue the scheduled scan
4640 * while associating, for instance.
4641 *
4642 * @hw: the hardware that is performing scheduled scans
4643 */
4644void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4645
4646/**
4647 * enum ieee80211_interface_iteration_flags - interface iteration flags
4648 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4649 * been added to the driver; However, note that during hardware
4650 * reconfiguration (after restart_hw) it will iterate over a new
4651 * interface and over all the existing interfaces even if they
4652 * haven't been re-added to the driver yet.
4653 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4654 * interfaces, even if they haven't been re-added to the driver yet.
4655 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4656 */
4657enum ieee80211_interface_iteration_flags {
4658 IEEE80211_IFACE_ITER_NORMAL = 0,
4659 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4660 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4661};
4662
4663/**
4664 * ieee80211_iterate_interfaces - iterate interfaces
4665 *
4666 * This function iterates over the interfaces associated with a given
4667 * hardware and calls the callback for them. This includes active as well as
4668 * inactive interfaces. This function allows the iterator function to sleep.
4669 * Will iterate over a new interface during add_interface().
4670 *
4671 * @hw: the hardware struct of which the interfaces should be iterated over
4672 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4673 * @iterator: the iterator function to call
4674 * @data: first argument of the iterator function
4675 */
4676void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4677 void (*iterator)(void *data, u8 *mac,
4678 struct ieee80211_vif *vif),
4679 void *data);
4680
4681/**
4682 * ieee80211_iterate_active_interfaces - iterate active interfaces
4683 *
4684 * This function iterates over the interfaces associated with a given
4685 * hardware that are currently active and calls the callback for them.
4686 * This function allows the iterator function to sleep, when the iterator
4687 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4688 * be used.
4689 * Does not iterate over a new interface during add_interface().
4690 *
4691 * @hw: the hardware struct of which the interfaces should be iterated over
4692 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4693 * @iterator: the iterator function to call
4694 * @data: first argument of the iterator function
4695 */
4696static inline void
4697ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4698 void (*iterator)(void *data, u8 *mac,
4699 struct ieee80211_vif *vif),
4700 void *data)
4701{
4702 ieee80211_iterate_interfaces(hw,
4703 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4704 iterator, data);
4705}
4706
4707/**
4708 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4709 *
4710 * This function iterates over the interfaces associated with a given
4711 * hardware that are currently active and calls the callback for them.
4712 * This function requires the iterator callback function to be atomic,
4713 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4714 * Does not iterate over a new interface during add_interface().
4715 *
4716 * @hw: the hardware struct of which the interfaces should be iterated over
4717 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4718 * @iterator: the iterator function to call, cannot sleep
4719 * @data: first argument of the iterator function
4720 */
4721void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4722 u32 iter_flags,
4723 void (*iterator)(void *data,
4724 u8 *mac,
4725 struct ieee80211_vif *vif),
4726 void *data);
4727
4728/**
4729 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4730 *
4731 * This function iterates over the interfaces associated with a given
4732 * hardware that are currently active and calls the callback for them.
4733 * This version can only be used while holding the RTNL.
4734 *
4735 * @hw: the hardware struct of which the interfaces should be iterated over
4736 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4737 * @iterator: the iterator function to call, cannot sleep
4738 * @data: first argument of the iterator function
4739 */
4740void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
4741 u32 iter_flags,
4742 void (*iterator)(void *data,
4743 u8 *mac,
4744 struct ieee80211_vif *vif),
4745 void *data);
4746
4747/**
4748 * ieee80211_iterate_stations_atomic - iterate stations
4749 *
4750 * This function iterates over all stations associated with a given
4751 * hardware that are currently uploaded to the driver and calls the callback
4752 * function for them.
4753 * This function requires the iterator callback function to be atomic,
4754 *
4755 * @hw: the hardware struct of which the interfaces should be iterated over
4756 * @iterator: the iterator function to call, cannot sleep
4757 * @data: first argument of the iterator function
4758 */
4759void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
4760 void (*iterator)(void *data,
4761 struct ieee80211_sta *sta),
4762 void *data);
4763/**
4764 * ieee80211_queue_work - add work onto the mac80211 workqueue
4765 *
4766 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
4767 * This helper ensures drivers are not queueing work when they should not be.
4768 *
4769 * @hw: the hardware struct for the interface we are adding work for
4770 * @work: the work we want to add onto the mac80211 workqueue
4771 */
4772void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
4773
4774/**
4775 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
4776 *
4777 * Drivers and mac80211 use this to queue delayed work onto the mac80211
4778 * workqueue.
4779 *
4780 * @hw: the hardware struct for the interface we are adding work for
4781 * @dwork: delayable work to queue onto the mac80211 workqueue
4782 * @delay: number of jiffies to wait before queueing
4783 */
4784void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
4785 struct delayed_work *dwork,
4786 unsigned long delay);
4787
4788/**
4789 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
4790 * @sta: the station for which to start a BA session
4791 * @tid: the TID to BA on.
4792 * @timeout: session timeout value (in TUs)
4793 *
4794 * Return: success if addBA request was sent, failure otherwise
4795 *
4796 * Although mac80211/low level driver/user space application can estimate
4797 * the need to start aggregation on a certain RA/TID, the session level
4798 * will be managed by the mac80211.
4799 */
4800int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
4801 u16 timeout);
4802
4803/**
4804 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
4805 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4806 * @ra: receiver address of the BA session recipient.
4807 * @tid: the TID to BA on.
4808 *
4809 * This function must be called by low level driver once it has
4810 * finished with preparations for the BA session. It can be called
4811 * from any context.
4812 */
4813void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4814 u16 tid);
4815
4816/**
4817 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
4818 * @sta: the station whose BA session to stop
4819 * @tid: the TID to stop BA.
4820 *
4821 * Return: negative error if the TID is invalid, or no aggregation active
4822 *
4823 * Although mac80211/low level driver/user space application can estimate
4824 * the need to stop aggregation on a certain RA/TID, the session level
4825 * will be managed by the mac80211.
4826 */
4827int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
4828
4829/**
4830 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
4831 * @vif: &struct ieee80211_vif pointer from the add_interface callback
4832 * @ra: receiver address of the BA session recipient.
4833 * @tid: the desired TID to BA on.
4834 *
4835 * This function must be called by low level driver once it has
4836 * finished with preparations for the BA session tear down. It
4837 * can be called from any context.
4838 */
4839void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
4840 u16 tid);
4841
4842/**
4843 * ieee80211_find_sta - find a station
4844 *
4845 * @vif: virtual interface to look for station on
4846 * @addr: station's address
4847 *
4848 * Return: The station, if found. %NULL otherwise.
4849 *
4850 * Note: This function must be called under RCU lock and the
4851 * resulting pointer is only valid under RCU lock as well.
4852 */
4853struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
4854 const u8 *addr);
4855
4856/**
4857 * ieee80211_find_sta_by_ifaddr - find a station on hardware
4858 *
4859 * @hw: pointer as obtained from ieee80211_alloc_hw()
4860 * @addr: remote station's address
4861 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
4862 *
4863 * Return: The station, if found. %NULL otherwise.
4864 *
4865 * Note: This function must be called under RCU lock and the
4866 * resulting pointer is only valid under RCU lock as well.
4867 *
4868 * NOTE: You may pass NULL for localaddr, but then you will just get
4869 * the first STA that matches the remote address 'addr'.
4870 * We can have multiple STA associated with multiple
4871 * logical stations (e.g. consider a station connecting to another
4872 * BSSID on the same AP hardware without disconnecting first).
4873 * In this case, the result of this method with localaddr NULL
4874 * is not reliable.
4875 *
4876 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
4877 */
4878struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
4879 const u8 *addr,
4880 const u8 *localaddr);
4881
4882/**
4883 * ieee80211_sta_block_awake - block station from waking up
4884 * @hw: the hardware
4885 * @pubsta: the station
4886 * @block: whether to block or unblock
4887 *
4888 * Some devices require that all frames that are on the queues
4889 * for a specific station that went to sleep are flushed before
4890 * a poll response or frames after the station woke up can be
4891 * delivered to that it. Note that such frames must be rejected
4892 * by the driver as filtered, with the appropriate status flag.
4893 *
4894 * This function allows implementing this mode in a race-free
4895 * manner.
4896 *
4897 * To do this, a driver must keep track of the number of frames
4898 * still enqueued for a specific station. If this number is not
4899 * zero when the station goes to sleep, the driver must call
4900 * this function to force mac80211 to consider the station to
4901 * be asleep regardless of the station's actual state. Once the
4902 * number of outstanding frames reaches zero, the driver must
4903 * call this function again to unblock the station. That will
4904 * cause mac80211 to be able to send ps-poll responses, and if
4905 * the station queried in the meantime then frames will also
4906 * be sent out as a result of this. Additionally, the driver
4907 * will be notified that the station woke up some time after
4908 * it is unblocked, regardless of whether the station actually
4909 * woke up while blocked or not.
4910 */
4911void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
4912 struct ieee80211_sta *pubsta, bool block);
4913
4914/**
4915 * ieee80211_sta_eosp - notify mac80211 about end of SP
4916 * @pubsta: the station
4917 *
4918 * When a device transmits frames in a way that it can't tell
4919 * mac80211 in the TX status about the EOSP, it must clear the
4920 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
4921 * This applies for PS-Poll as well as uAPSD.
4922 *
4923 * Note that just like with _tx_status() and _rx() drivers must
4924 * not mix calls to irqsafe/non-irqsafe versions, this function
4925 * must not be mixed with those either. Use the all irqsafe, or
4926 * all non-irqsafe, don't mix!
4927 *
4928 * NB: the _irqsafe version of this function doesn't exist, no
4929 * driver needs it right now. Don't call this function if
4930 * you'd need the _irqsafe version, look at the git history
4931 * and restore the _irqsafe version!
4932 */
4933void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
4934
4935/**
4936 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
4937 * @pubsta: the station
4938 * @tid: the tid of the NDP
4939 *
4940 * Sometimes the device understands that it needs to close
4941 * the Service Period unexpectedly. This can happen when
4942 * sending frames that are filling holes in the BA window.
4943 * In this case, the device can ask mac80211 to send a
4944 * Nullfunc frame with EOSP set. When that happens, the
4945 * driver must have called ieee80211_sta_set_buffered() to
4946 * let mac80211 know that there are no buffered frames any
4947 * more, otherwise mac80211 will get the more_data bit wrong.
4948 * The low level driver must have made sure that the frame
4949 * will be sent despite the station being in power-save.
4950 * Mac80211 won't call allow_buffered_frames().
4951 * Note that calling this function, doesn't exempt the driver
4952 * from closing the EOSP properly, it will still have to call
4953 * ieee80211_sta_eosp when the NDP is sent.
4954 */
4955void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
4956
4957/**
4958 * ieee80211_iter_keys - iterate keys programmed into the device
4959 * @hw: pointer obtained from ieee80211_alloc_hw()
4960 * @vif: virtual interface to iterate, may be %NULL for all
4961 * @iter: iterator function that will be called for each key
4962 * @iter_data: custom data to pass to the iterator function
4963 *
4964 * This function can be used to iterate all the keys known to
4965 * mac80211, even those that weren't previously programmed into
4966 * the device. This is intended for use in WoWLAN if the device
4967 * needs reprogramming of the keys during suspend. Note that due
4968 * to locking reasons, it is also only safe to call this at few
4969 * spots since it must hold the RTNL and be able to sleep.
4970 *
4971 * The order in which the keys are iterated matches the order
4972 * in which they were originally installed and handed to the
4973 * set_key callback.
4974 */
4975void ieee80211_iter_keys(struct ieee80211_hw *hw,
4976 struct ieee80211_vif *vif,
4977 void (*iter)(struct ieee80211_hw *hw,
4978 struct ieee80211_vif *vif,
4979 struct ieee80211_sta *sta,
4980 struct ieee80211_key_conf *key,
4981 void *data),
4982 void *iter_data);
4983
4984/**
4985 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
4986 * @hw: pointer obtained from ieee80211_alloc_hw()
4987 * @vif: virtual interface to iterate, may be %NULL for all
4988 * @iter: iterator function that will be called for each key
4989 * @iter_data: custom data to pass to the iterator function
4990 *
4991 * This function can be used to iterate all the keys known to
4992 * mac80211, even those that weren't previously programmed into
4993 * the device. Note that due to locking reasons, keys of station
4994 * in removal process will be skipped.
4995 *
4996 * This function requires being called in an RCU critical section,
4997 * and thus iter must be atomic.
4998 */
4999void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5000 struct ieee80211_vif *vif,
5001 void (*iter)(struct ieee80211_hw *hw,
5002 struct ieee80211_vif *vif,
5003 struct ieee80211_sta *sta,
5004 struct ieee80211_key_conf *key,
5005 void *data),
5006 void *iter_data);
5007
5008/**
5009 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5010 * @hw: pointre obtained from ieee80211_alloc_hw().
5011 * @iter: iterator function
5012 * @iter_data: data passed to iterator function
5013 *
5014 * Iterate all active channel contexts. This function is atomic and
5015 * doesn't acquire any locks internally that might be held in other
5016 * places while calling into the driver.
5017 *
5018 * The iterator will not find a context that's being added (during
5019 * the driver callback to add it) but will find it while it's being
5020 * removed.
5021 *
5022 * Note that during hardware restart, all contexts that existed
5023 * before the restart are considered already present so will be
5024 * found while iterating, whether they've been re-added already
5025 * or not.
5026 */
5027void ieee80211_iter_chan_contexts_atomic(
5028 struct ieee80211_hw *hw,
5029 void (*iter)(struct ieee80211_hw *hw,
5030 struct ieee80211_chanctx_conf *chanctx_conf,
5031 void *data),
5032 void *iter_data);
5033
5034/**
5035 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5036 * @hw: pointer obtained from ieee80211_alloc_hw().
5037 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5038 *
5039 * Creates a Probe Request template which can, for example, be uploaded to
5040 * hardware. The template is filled with bssid, ssid and supported rate
5041 * information. This function must only be called from within the
5042 * .bss_info_changed callback function and only in managed mode. The function
5043 * is only useful when the interface is associated, otherwise it will return
5044 * %NULL.
5045 *
5046 * Return: The Probe Request template. %NULL on error.
5047 */
5048struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5049 struct ieee80211_vif *vif);
5050
5051/**
5052 * ieee80211_beacon_loss - inform hardware does not receive beacons
5053 *
5054 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5055 *
5056 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5057 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5058 * hardware is not receiving beacons with this function.
5059 */
5060void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5061
5062/**
5063 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5064 *
5065 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5066 *
5067 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5068 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5069 * needs to inform if the connection to the AP has been lost.
5070 * The function may also be called if the connection needs to be terminated
5071 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5072 *
5073 * This function will cause immediate change to disassociated state,
5074 * without connection recovery attempts.
5075 */
5076void ieee80211_connection_loss(struct ieee80211_vif *vif);
5077
5078/**
5079 * ieee80211_resume_disconnect - disconnect from AP after resume
5080 *
5081 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5082 *
5083 * Instructs mac80211 to disconnect from the AP after resume.
5084 * Drivers can use this after WoWLAN if they know that the
5085 * connection cannot be kept up, for example because keys were
5086 * used while the device was asleep but the replay counters or
5087 * similar cannot be retrieved from the device during resume.
5088 *
5089 * Note that due to implementation issues, if the driver uses
5090 * the reconfiguration functionality during resume the interface
5091 * will still be added as associated first during resume and then
5092 * disconnect normally later.
5093 *
5094 * This function can only be called from the resume callback and
5095 * the driver must not be holding any of its own locks while it
5096 * calls this function, or at least not any locks it needs in the
5097 * key configuration paths (if it supports HW crypto).
5098 */
5099void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5100
5101/**
5102 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5103 * rssi threshold triggered
5104 *
5105 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5106 * @rssi_event: the RSSI trigger event type
5107 * @gfp: context flags
5108 *
5109 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5110 * monitoring is configured with an rssi threshold, the driver will inform
5111 * whenever the rssi level reaches the threshold.
5112 */
5113void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5114 enum nl80211_cqm_rssi_threshold_event rssi_event,
5115 gfp_t gfp);
5116
5117/**
5118 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5119 *
5120 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5121 * @gfp: context flags
5122 */
5123void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5124
5125/**
5126 * ieee80211_radar_detected - inform that a radar was detected
5127 *
5128 * @hw: pointer as obtained from ieee80211_alloc_hw()
5129 */
5130void ieee80211_radar_detected(struct ieee80211_hw *hw);
5131
5132/**
5133 * ieee80211_chswitch_done - Complete channel switch process
5134 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5135 * @success: make the channel switch successful or not
5136 *
5137 * Complete the channel switch post-process: set the new operational channel
5138 * and wake up the suspended queues.
5139 */
5140void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5141
5142/**
5143 * ieee80211_request_smps - request SM PS transition
5144 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5145 * @smps_mode: new SM PS mode
5146 *
5147 * This allows the driver to request an SM PS transition in managed
5148 * mode. This is useful when the driver has more information than
5149 * the stack about possible interference, for example by bluetooth.
5150 */
5151void ieee80211_request_smps(struct ieee80211_vif *vif,
5152 enum ieee80211_smps_mode smps_mode);
5153
5154/**
5155 * ieee80211_ready_on_channel - notification of remain-on-channel start
5156 * @hw: pointer as obtained from ieee80211_alloc_hw()
5157 */
5158void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5159
5160/**
5161 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5162 * @hw: pointer as obtained from ieee80211_alloc_hw()
5163 */
5164void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5165
5166/**
5167 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5168 *
5169 * in order not to harm the system performance and user experience, the device
5170 * may request not to allow any rx ba session and tear down existing rx ba
5171 * sessions based on system constraints such as periodic BT activity that needs
5172 * to limit wlan activity (eg.sco or a2dp)."
5173 * in such cases, the intention is to limit the duration of the rx ppdu and
5174 * therefore prevent the peer device to use a-mpdu aggregation.
5175 *
5176 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5177 * @ba_rx_bitmap: Bit map of open rx ba per tid
5178 * @addr: & to bssid mac address
5179 */
5180void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5181 const u8 *addr);
5182
5183/**
5184 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5185 * @pubsta: station struct
5186 * @tid: the session's TID
5187 * @ssn: starting sequence number of the bitmap, all frames before this are
5188 * assumed to be out of the window after the call
5189 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5190 * @received_mpdus: number of received mpdus in firmware
5191 *
5192 * This function moves the BA window and releases all frames before @ssn, and
5193 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5194 * checks if any frames in the window starting from @ssn can now be released
5195 * (in case they were only waiting for frames that were filtered.)
5196 */
5197void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
5198 u16 ssn, u64 filtered,
5199 u16 received_mpdus);
5200
5201/**
5202 * ieee80211_send_bar - send a BlockAckReq frame
5203 *
5204 * can be used to flush pending frames from the peer's aggregation reorder
5205 * buffer.
5206 *
5207 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5208 * @ra: the peer's destination address
5209 * @tid: the TID of the aggregation session
5210 * @ssn: the new starting sequence number for the receiver
5211 */
5212void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5213
5214/**
5215 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5216 *
5217 * Some device drivers may offload part of the Rx aggregation flow including
5218 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5219 * reordering.
5220 *
5221 * Create structures responsible for reordering so device drivers may call here
5222 * when they complete AddBa negotiation.
5223 *
5224 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5225 * @addr: station mac address
5226 * @tid: the rx tid
5227 */
5228void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5229 const u8 *addr, u16 tid);
5230
5231/**
5232 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5233 *
5234 * Some device drivers may offload part of the Rx aggregation flow including
5235 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5236 * reordering.
5237 *
5238 * Destroy structures responsible for reordering so device drivers may call here
5239 * when they complete DelBa negotiation.
5240 *
5241 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5242 * @addr: station mac address
5243 * @tid: the rx tid
5244 */
5245void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5246 const u8 *addr, u16 tid);
5247
5248/* Rate control API */
5249
5250/**
5251 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5252 *
5253 * @hw: The hardware the algorithm is invoked for.
5254 * @sband: The band this frame is being transmitted on.
5255 * @bss_conf: the current BSS configuration
5256 * @skb: the skb that will be transmitted, the control information in it needs
5257 * to be filled in
5258 * @reported_rate: The rate control algorithm can fill this in to indicate
5259 * which rate should be reported to userspace as the current rate and
5260 * used for rate calculations in the mesh network.
5261 * @rts: whether RTS will be used for this frame because it is longer than the
5262 * RTS threshold
5263 * @short_preamble: whether mac80211 will request short-preamble transmission
5264 * if the selected rate supports it
5265 * @max_rate_idx: user-requested maximum (legacy) rate
5266 * (deprecated; this will be removed once drivers get updated to use
5267 * rate_idx_mask)
5268 * @rate_idx_mask: user-requested (legacy) rate mask
5269 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5270 * @bss: whether this frame is sent out in AP or IBSS mode
5271 */
5272struct ieee80211_tx_rate_control {
5273 struct ieee80211_hw *hw;
5274 struct ieee80211_supported_band *sband;
5275 struct ieee80211_bss_conf *bss_conf;
5276 struct sk_buff *skb;
5277 struct ieee80211_tx_rate reported_rate;
5278 bool rts, short_preamble;
5279 u8 max_rate_idx;
5280 u32 rate_idx_mask;
5281 u8 *rate_idx_mcs_mask;
5282 bool bss;
5283};
5284
5285struct rate_control_ops {
5286 const char *name;
5287 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5288 void (*free)(void *priv);
5289
5290 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5291 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5292 struct cfg80211_chan_def *chandef,
5293 struct ieee80211_sta *sta, void *priv_sta);
5294 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5295 struct cfg80211_chan_def *chandef,
5296 struct ieee80211_sta *sta, void *priv_sta,
5297 u32 changed);
5298 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5299 void *priv_sta);
5300
5301 void (*tx_status_noskb)(void *priv,
5302 struct ieee80211_supported_band *sband,
5303 struct ieee80211_sta *sta, void *priv_sta,
5304 struct ieee80211_tx_info *info);
5305 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5306 struct ieee80211_sta *sta, void *priv_sta,
5307 struct sk_buff *skb);
5308 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5309 struct ieee80211_tx_rate_control *txrc);
5310
5311 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5312 struct dentry *dir);
5313 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5314
5315 u32 (*get_expected_throughput)(void *priv_sta);
5316};
5317
5318static inline int rate_supported(struct ieee80211_sta *sta,
5319 enum ieee80211_band band,
5320 int index)
5321{
5322 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5323}
5324
5325/**
5326 * rate_control_send_low - helper for drivers for management/no-ack frames
5327 *
5328 * Rate control algorithms that agree to use the lowest rate to
5329 * send management frames and NO_ACK data with the respective hw
5330 * retries should use this in the beginning of their mac80211 get_rate
5331 * callback. If true is returned the rate control can simply return.
5332 * If false is returned we guarantee that sta and sta and priv_sta is
5333 * not null.
5334 *
5335 * Rate control algorithms wishing to do more intelligent selection of
5336 * rate for multicast/broadcast frames may choose to not use this.
5337 *
5338 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5339 * that this may be null.
5340 * @priv_sta: private rate control structure. This may be null.
5341 * @txrc: rate control information we sholud populate for mac80211.
5342 */
5343bool rate_control_send_low(struct ieee80211_sta *sta,
5344 void *priv_sta,
5345 struct ieee80211_tx_rate_control *txrc);
5346
5347
5348static inline s8
5349rate_lowest_index(struct ieee80211_supported_band *sband,
5350 struct ieee80211_sta *sta)
5351{
5352 int i;
5353
5354 for (i = 0; i < sband->n_bitrates; i++)
5355 if (rate_supported(sta, sband->band, i))
5356 return i;
5357
5358 /* warn when we cannot find a rate. */
5359 WARN_ON_ONCE(1);
5360
5361 /* and return 0 (the lowest index) */
5362 return 0;
5363}
5364
5365static inline
5366bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5367 struct ieee80211_sta *sta)
5368{
5369 unsigned int i;
5370
5371 for (i = 0; i < sband->n_bitrates; i++)
5372 if (rate_supported(sta, sband->band, i))
5373 return true;
5374 return false;
5375}
5376
5377/**
5378 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5379 *
5380 * When not doing a rate control probe to test rates, rate control should pass
5381 * its rate selection to mac80211. If the driver supports receiving a station
5382 * rate table, it will use it to ensure that frames are always sent based on
5383 * the most recent rate control module decision.
5384 *
5385 * @hw: pointer as obtained from ieee80211_alloc_hw()
5386 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5387 * @rates: new tx rate set to be used for this station.
5388 */
5389int rate_control_set_rates(struct ieee80211_hw *hw,
5390 struct ieee80211_sta *pubsta,
5391 struct ieee80211_sta_rates *rates);
5392
5393int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5394void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5395
5396static inline bool
5397conf_is_ht20(struct ieee80211_conf *conf)
5398{
5399 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5400}
5401
5402static inline bool
5403conf_is_ht40_minus(struct ieee80211_conf *conf)
5404{
5405 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5406 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5407}
5408
5409static inline bool
5410conf_is_ht40_plus(struct ieee80211_conf *conf)
5411{
5412 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5413 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5414}
5415
5416static inline bool
5417conf_is_ht40(struct ieee80211_conf *conf)
5418{
5419 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5420}
5421
5422static inline bool
5423conf_is_ht(struct ieee80211_conf *conf)
5424{
5425 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5426 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5427 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5428}
5429
5430static inline enum nl80211_iftype
5431ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5432{
5433 if (p2p) {
5434 switch (type) {
5435 case NL80211_IFTYPE_STATION:
5436 return NL80211_IFTYPE_P2P_CLIENT;
5437 case NL80211_IFTYPE_AP:
5438 return NL80211_IFTYPE_P2P_GO;
5439 default:
5440 break;
5441 }
5442 }
5443 return type;
5444}
5445
5446static inline enum nl80211_iftype
5447ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5448{
5449 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5450}
5451
5452/**
5453 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
5454 *
5455 * @vif: the specified virtual interface
5456 * @membership: 64 bits array - a bit is set if station is member of the group
5457 * @position: 2 bits per group id indicating the position in the group
5458 *
5459 * Note: This function assumes that the given vif is valid and the position and
5460 * membership data is of the correct size and are in the same byte order as the
5461 * matching GroupId management frame.
5462 * Calls to this function need to be serialized with RX path.
5463 */
5464void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
5465 const u8 *membership, const u8 *position);
5466
5467void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5468 int rssi_min_thold,
5469 int rssi_max_thold);
5470
5471void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5472
5473/**
5474 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5475 *
5476 * @vif: the specified virtual interface
5477 *
5478 * Note: This function assumes that the given vif is valid.
5479 *
5480 * Return: The average RSSI value for the requested interface, or 0 if not
5481 * applicable.
5482 */
5483int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5484
5485/**
5486 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5487 * @vif: virtual interface
5488 * @wakeup: wakeup reason(s)
5489 * @gfp: allocation flags
5490 *
5491 * See cfg80211_report_wowlan_wakeup().
5492 */
5493void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5494 struct cfg80211_wowlan_wakeup *wakeup,
5495 gfp_t gfp);
5496
5497/**
5498 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5499 * @hw: pointer as obtained from ieee80211_alloc_hw()
5500 * @vif: virtual interface
5501 * @skb: frame to be sent from within the driver
5502 * @band: the band to transmit on
5503 * @sta: optional pointer to get the station to send the frame to
5504 *
5505 * Note: must be called under RCU lock
5506 */
5507bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5508 struct ieee80211_vif *vif, struct sk_buff *skb,
5509 int band, struct ieee80211_sta **sta);
5510
5511/**
5512 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5513 *
5514 * @next_tsf: TSF timestamp of the next absent state change
5515 * @has_next_tsf: next absent state change event pending
5516 *
5517 * @absent: descriptor bitmask, set if GO is currently absent
5518 *
5519 * private:
5520 *
5521 * @count: count fields from the NoA descriptors
5522 * @desc: adjusted data from the NoA
5523 */
5524struct ieee80211_noa_data {
5525 u32 next_tsf;
5526 bool has_next_tsf;
5527
5528 u8 absent;
5529
5530 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5531 struct {
5532 u32 start;
5533 u32 duration;
5534 u32 interval;
5535 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5536};
5537
5538/**
5539 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5540 *
5541 * @attr: P2P NoA IE
5542 * @data: NoA tracking data
5543 * @tsf: current TSF timestamp
5544 *
5545 * Return: number of successfully parsed descriptors
5546 */
5547int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5548 struct ieee80211_noa_data *data, u32 tsf);
5549
5550/**
5551 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5552 *
5553 * @data: NoA tracking data
5554 * @tsf: current TSF timestamp
5555 */
5556void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5557
5558/**
5559 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5560 * @vif: virtual interface
5561 * @peer: the peer's destination address
5562 * @oper: the requested TDLS operation
5563 * @reason_code: reason code for the operation, valid for TDLS teardown
5564 * @gfp: allocation flags
5565 *
5566 * See cfg80211_tdls_oper_request().
5567 */
5568void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5569 enum nl80211_tdls_operation oper,
5570 u16 reason_code, gfp_t gfp);
5571
5572/**
5573 * ieee80211_reserve_tid - request to reserve a specific TID
5574 *
5575 * There is sometimes a need (such as in TDLS) for blocking the driver from
5576 * using a specific TID so that the FW can use it for certain operations such
5577 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5578 * this function must be called as it flushes out packets on this TID and marks
5579 * it as blocked, so that any transmit for the station on this TID will be
5580 * redirected to the alternative TID in the same AC.
5581 *
5582 * Note that this function blocks and may call back into the driver, so it
5583 * should be called without driver locks held. Also note this function should
5584 * only be called from the driver's @sta_state callback.
5585 *
5586 * @sta: the station to reserve the TID for
5587 * @tid: the TID to reserve
5588 *
5589 * Returns: 0 on success, else on failure
5590 */
5591int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5592
5593/**
5594 * ieee80211_unreserve_tid - request to unreserve a specific TID
5595 *
5596 * Once there is no longer any need for reserving a certain TID, this function
5597 * should be called, and no longer will packets have their TID modified for
5598 * preventing use of this TID in the driver.
5599 *
5600 * Note that this function blocks and acquires a lock, so it should be called
5601 * without driver locks held. Also note this function should only be called
5602 * from the driver's @sta_state callback.
5603 *
5604 * @sta: the station
5605 * @tid: the TID to unreserve
5606 */
5607void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5608
5609/**
5610 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5611 *
5612 * @hw: pointer as obtained from ieee80211_alloc_hw()
5613 * @txq: pointer obtained from station or virtual interface
5614 *
5615 * Returns the skb if successful, %NULL if no frame was available.
5616 */
5617struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5618 struct ieee80211_txq *txq);
5619
5620/**
5621 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
5622 *
5623 * The values are not guaranteed to be coherent with regard to each other, i.e.
5624 * txq state can change half-way of this function and the caller may end up
5625 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
5626 *
5627 * @txq: pointer obtained from station or virtual interface
5628 * @frame_cnt: pointer to store frame count
5629 * @byte_cnt: pointer to store byte count
5630 */
5631void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
5632 unsigned long *frame_cnt,
5633 unsigned long *byte_cnt);
5634#endif /* MAC80211_H */