05f102197cfe7c6fa538daa3034a44b7a2b137d0
[linux-2.6.git] / include / net / 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  *
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/device.h>
20 #include <linux/ieee80211.h>
21 #include <net/cfg80211.h>
22 #include <asm/unaligned.h>
23
24 /**
25  * DOC: Introduction
26  *
27  * mac80211 is the Linux stack for 802.11 hardware that implements
28  * only partial functionality in hard- or firmware. This document
29  * defines the interface between mac80211 and low-level hardware
30  * drivers.
31  */
32
33 /**
34  * DOC: Calling mac80211 from interrupts
35  *
36  * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37  * called in hardware interrupt context. The low-level driver must not call any
38  * other functions in hardware interrupt context. If there is a need for such
39  * call, the low-level driver should first ACK the interrupt and perform the
40  * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
41  * tasklet function.
42  *
43  * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44  *       use the non-IRQ-safe functions!
45  */
46
47 /**
48  * DOC: Warning
49  *
50  * If you're reading this document and not the header file itself, it will
51  * be incomplete because not all documentation has been converted yet.
52  */
53
54 /**
55  * DOC: Frame format
56  *
57  * As a general rule, when frames are passed between mac80211 and the driver,
58  * they start with the IEEE 802.11 header and include the same octets that are
59  * sent over the air except for the FCS which should be calculated by the
60  * hardware.
61  *
62  * There are, however, various exceptions to this rule for advanced features:
63  *
64  * The first exception is for hardware encryption and decryption offload
65  * where the IV/ICV may or may not be generated in hardware.
66  *
67  * Secondly, when the hardware handles fragmentation, the frame handed to
68  * the driver from mac80211 is the MSDU, not the MPDU.
69  *
70  * Finally, for received frames, the driver is able to indicate that it has
71  * filled a radiotap header and put that in front of the frame; if it does
72  * not do so then mac80211 may add this under certain circumstances.
73  */
74
75 /**
76  * DOC: mac80211 workqueue
77  *
78  * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79  * The workqueue is a single threaded workqueue and can only be accessed by
80  * helpers for sanity checking. Drivers must ensure all work added onto the
81  * mac80211 workqueue should be cancelled on the driver stop() callback.
82  *
83  * mac80211 will flushed the workqueue upon interface removal and during
84  * suspend.
85  *
86  * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
87  *
88  */
89
90 /**
91  * enum ieee80211_max_queues - maximum number of queues
92  *
93  * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
94  */
95 enum ieee80211_max_queues {
96         IEEE80211_MAX_QUEUES =          4,
97 };
98
99 /**
100  * enum ieee80211_ac_numbers - AC numbers as used in mac80211
101  * @IEEE80211_AC_VO: voice
102  * @IEEE80211_AC_VI: video
103  * @IEEE80211_AC_BE: best effort
104  * @IEEE80211_AC_BK: background
105  */
106 enum ieee80211_ac_numbers {
107         IEEE80211_AC_VO         = 0,
108         IEEE80211_AC_VI         = 1,
109         IEEE80211_AC_BE         = 2,
110         IEEE80211_AC_BK         = 3,
111 };
112 #define IEEE80211_NUM_ACS       4
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  */
127 struct ieee80211_tx_queue_params {
128         u16 txop;
129         u16 cw_min;
130         u16 cw_max;
131         u8 aifs;
132         bool uapsd;
133 };
134
135 struct 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  * @BSS_CHANGED_SSID: SSID changed for this BSS (AP mode)
169  */
170 enum ieee80211_bss_change {
171         BSS_CHANGED_ASSOC               = 1<<0,
172         BSS_CHANGED_ERP_CTS_PROT        = 1<<1,
173         BSS_CHANGED_ERP_PREAMBLE        = 1<<2,
174         BSS_CHANGED_ERP_SLOT            = 1<<3,
175         BSS_CHANGED_HT                  = 1<<4,
176         BSS_CHANGED_BASIC_RATES         = 1<<5,
177         BSS_CHANGED_BEACON_INT          = 1<<6,
178         BSS_CHANGED_BSSID               = 1<<7,
179         BSS_CHANGED_BEACON              = 1<<8,
180         BSS_CHANGED_BEACON_ENABLED      = 1<<9,
181         BSS_CHANGED_CQM                 = 1<<10,
182         BSS_CHANGED_IBSS                = 1<<11,
183         BSS_CHANGED_ARP_FILTER          = 1<<12,
184         BSS_CHANGED_QOS                 = 1<<13,
185         BSS_CHANGED_IDLE                = 1<<14,
186         BSS_CHANGED_SSID                = 1<<15,
187
188         /* when adding here, make sure to change ieee80211_reconfig */
189 };
190
191 /*
192  * The maximum number of IPv4 addresses listed for ARP filtering. If the number
193  * of addresses for an interface increase beyond this value, hardware ARP
194  * filtering will be disabled.
195  */
196 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
197
198 /**
199  * enum ieee80211_rssi_event - RSSI threshold event
200  * An indicator for when RSSI goes below/above a certain threshold.
201  * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver.
202  * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver.
203  */
204 enum ieee80211_rssi_event {
205         RSSI_EVENT_HIGH,
206         RSSI_EVENT_LOW,
207 };
208
209 /**
210  * struct ieee80211_bss_conf - holds the BSS's changing parameters
211  *
212  * This structure keeps information about a BSS (and an association
213  * to that BSS) that can change during the lifetime of the BSS.
214  *
215  * @assoc: association status
216  * @ibss_joined: indicates whether this station is part of an IBSS
217  *      or not
218  * @aid: association ID number, valid only when @assoc is true
219  * @use_cts_prot: use CTS protection
220  * @use_short_preamble: use 802.11b short preamble;
221  *      if the hardware cannot handle this it must set the
222  *      IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
223  * @use_short_slot: use short slot time (only relevant for ERP);
224  *      if the hardware cannot handle this it must set the
225  *      IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
226  * @dtim_period: num of beacons before the next DTIM, for beaconing,
227  *      valid in station mode only while @assoc is true and if also
228  *      requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
229  *      @ps_dtim_period)
230  * @timestamp: beacon timestamp
231  * @beacon_int: beacon interval
232  * @assoc_capability: capabilities taken from assoc resp
233  * @basic_rates: bitmap of basic rates, each bit stands for an
234  *      index into the rate table configured by the driver in
235  *      the current band.
236  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
237  * @bssid: The BSSID for this BSS
238  * @enable_beacon: whether beaconing should be enabled or not
239  * @channel_type: Channel type for this BSS -- the hardware might be
240  *      configured for HT40+ while this BSS only uses no-HT, for
241  *      example.
242  * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
243  *      This field is only valid when the channel type is one of the HT types.
244  * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
245  *      implies disabled
246  * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
247  * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
248  *      may filter ARP queries targeted for other addresses than listed here.
249  *      The driver must allow ARP queries targeted for all address listed here
250  *      to pass through. An empty list implies no ARP queries need to pass.
251  * @arp_addr_cnt: Number of addresses currently on the list.
252  * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
253  *      filter ARP queries based on the @arp_addr_list, if disabled, the
254  *      hardware must not perform any ARP filtering. Note, that the filter will
255  *      be enabled also in promiscuous mode.
256  * @qos: This is a QoS-enabled BSS.
257  * @idle: This interface is idle. There's also a global idle flag in the
258  *      hardware config which may be more appropriate depending on what
259  *      your driver/device needs to do.
260  * @ssid: The SSID of the current vif. Only valid in AP-mode.
261  * @ssid_len: Length of SSID given in @ssid.
262  * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
263  */
264 struct ieee80211_bss_conf {
265         const u8 *bssid;
266         /* association related data */
267         bool assoc, ibss_joined;
268         u16 aid;
269         /* erp related data */
270         bool use_cts_prot;
271         bool use_short_preamble;
272         bool use_short_slot;
273         bool enable_beacon;
274         u8 dtim_period;
275         u16 beacon_int;
276         u16 assoc_capability;
277         u64 timestamp;
278         u32 basic_rates;
279         int mcast_rate[IEEE80211_NUM_BANDS];
280         u16 ht_operation_mode;
281         s32 cqm_rssi_thold;
282         u32 cqm_rssi_hyst;
283         enum nl80211_channel_type channel_type;
284         __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
285         u8 arp_addr_cnt;
286         bool arp_filter_enabled;
287         bool qos;
288         bool idle;
289         u8 ssid[IEEE80211_MAX_SSID_LEN];
290         size_t ssid_len;
291         bool hidden_ssid;
292 };
293
294 /**
295  * enum mac80211_tx_control_flags - flags to describe transmission information/status
296  *
297  * These flags are used with the @flags member of &ieee80211_tx_info.
298  *
299  * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
300  * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
301  *      number to this frame, taking care of not overwriting the fragment
302  *      number and increasing the sequence number only when the
303  *      IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
304  *      assign sequence numbers to QoS-data frames but cannot do so correctly
305  *      for non-QoS-data and management frames because beacons need them from
306  *      that counter as well and mac80211 cannot guarantee proper sequencing.
307  *      If this flag is set, the driver should instruct the hardware to
308  *      assign a sequence number to the frame or assign one itself. Cf. IEEE
309  *      802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
310  *      beacons and always be clear for frames without a sequence number field.
311  * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
312  * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
313  *      station
314  * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
315  * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
316  * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
317  * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
318  * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
319  *      because the destination STA was in powersave mode. Note that to
320  *      avoid race conditions, the filter must be set by the hardware or
321  *      firmware upon receiving a frame that indicates that the station
322  *      went to sleep (must be done on device to filter frames already on
323  *      the queue) and may only be unset after mac80211 gives the OK for
324  *      that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
325  *      since only then is it guaranteed that no more frames are in the
326  *      hardware queue.
327  * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
328  * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
329  *      is for the whole aggregation.
330  * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
331  *      so consider using block ack request (BAR).
332  * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
333  *      set by rate control algorithms to indicate probe rate, will
334  *      be cleared for fragmented frames (except on the last fragment)
335  * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
336  *      used to indicate that a pending frame requires TX processing before
337  *      it can be sent out.
338  * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
339  *      used to indicate that a frame was already retried due to PS
340  * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
341  *      used to indicate frame should not be encrypted
342  * @IEEE80211_TX_CTL_POLL_RESPONSE: This frame is a response to a poll
343  *      frame (PS-Poll or uAPSD) and should be sent although the station
344  *      is in powersave mode.
345  * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
346  *      transmit function after the current frame, this can be used
347  *      by drivers to kick the DMA queue only if unset or when the
348  *      queue gets full.
349  * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
350  *      after TX status because the destination was asleep, it must not
351  *      be modified again (no seqno assignment, crypto, etc.)
352  * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
353  *      has a radiotap header at skb->data.
354  * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
355  *      MLME command (internal to mac80211 to figure out whether to send TX
356  *      status to user space)
357  * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
358  * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
359  *      frame and selects the maximum number of streams that it can use.
360  * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
361  *      the off-channel channel when a remain-on-channel offload is done
362  *      in hardware -- normal packets still flow and are expected to be
363  *      handled properly by the device.
364  * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
365  *      testing. It will be sent out with incorrect Michael MIC key to allow
366  *      TKIP countermeasures to be tested.
367  * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
368  *      This flag is actually used for management frame especially for P2P
369  *      frames not being sent at CCK rate in 2GHz band.
370  * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
371  *      when its status is reported the service period ends. For frames in
372  *      an SP that mac80211 transmits, it is already set; for driver frames
373  *      the driver may set this flag. It is also used to do the same for
374  *      PS-Poll responses.
375  * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
376  *      This flag is used to send nullfunc frame at minimum rate when
377  *      the nullfunc is used for connection monitoring purpose.
378  * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
379  *      would be fragmented by size (this is optional, only used for
380  *      monitor injection).
381  *
382  * Note: If you have to add new flags to the enumeration, then don't
383  *       forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
384  */
385 enum mac80211_tx_control_flags {
386         IEEE80211_TX_CTL_REQ_TX_STATUS          = BIT(0),
387         IEEE80211_TX_CTL_ASSIGN_SEQ             = BIT(1),
388         IEEE80211_TX_CTL_NO_ACK                 = BIT(2),
389         IEEE80211_TX_CTL_CLEAR_PS_FILT          = BIT(3),
390         IEEE80211_TX_CTL_FIRST_FRAGMENT         = BIT(4),
391         IEEE80211_TX_CTL_SEND_AFTER_DTIM        = BIT(5),
392         IEEE80211_TX_CTL_AMPDU                  = BIT(6),
393         IEEE80211_TX_CTL_INJECTED               = BIT(7),
394         IEEE80211_TX_STAT_TX_FILTERED           = BIT(8),
395         IEEE80211_TX_STAT_ACK                   = BIT(9),
396         IEEE80211_TX_STAT_AMPDU                 = BIT(10),
397         IEEE80211_TX_STAT_AMPDU_NO_BACK         = BIT(11),
398         IEEE80211_TX_CTL_RATE_CTRL_PROBE        = BIT(12),
399         IEEE80211_TX_INTFL_NEED_TXPROCESSING    = BIT(14),
400         IEEE80211_TX_INTFL_RETRIED              = BIT(15),
401         IEEE80211_TX_INTFL_DONT_ENCRYPT         = BIT(16),
402         IEEE80211_TX_CTL_POLL_RESPONSE          = BIT(17),
403         IEEE80211_TX_CTL_MORE_FRAMES            = BIT(18),
404         IEEE80211_TX_INTFL_RETRANSMISSION       = BIT(19),
405         IEEE80211_TX_INTFL_HAS_RADIOTAP         = BIT(20),
406         IEEE80211_TX_INTFL_NL80211_FRAME_TX     = BIT(21),
407         IEEE80211_TX_CTL_LDPC                   = BIT(22),
408         IEEE80211_TX_CTL_STBC                   = BIT(23) | BIT(24),
409         IEEE80211_TX_CTL_TX_OFFCHAN             = BIT(25),
410         IEEE80211_TX_INTFL_TKIP_MIC_FAILURE     = BIT(26),
411         IEEE80211_TX_CTL_NO_CCK_RATE            = BIT(27),
412         IEEE80211_TX_STATUS_EOSP                = BIT(28),
413         IEEE80211_TX_CTL_USE_MINRATE            = BIT(29),
414         IEEE80211_TX_CTL_DONTFRAG               = BIT(30),
415 };
416
417 #define IEEE80211_TX_CTL_STBC_SHIFT             23
418
419 /*
420  * This definition is used as a mask to clear all temporary flags, which are
421  * set by the tx handlers for each transmission attempt by the mac80211 stack.
422  */
423 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK |               \
424         IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT |    \
425         IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU |           \
426         IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK |               \
427         IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK |           \
428         IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_POLL_RESPONSE |   \
429         IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC |                \
430         IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
431
432 /**
433  * enum mac80211_rate_control_flags - per-rate flags set by the
434  *      Rate Control algorithm.
435  *
436  * These flags are set by the Rate control algorithm for each rate during tx,
437  * in the @flags member of struct ieee80211_tx_rate.
438  *
439  * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
440  * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
441  *      This is set if the current BSS requires ERP protection.
442  * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
443  * @IEEE80211_TX_RC_MCS: HT rate.
444  * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
445  *      Greenfield mode.
446  * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
447  * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
448  *      adjacent 20 MHz channels, if the current channel type is
449  *      NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
450  * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
451  */
452 enum mac80211_rate_control_flags {
453         IEEE80211_TX_RC_USE_RTS_CTS             = BIT(0),
454         IEEE80211_TX_RC_USE_CTS_PROTECT         = BIT(1),
455         IEEE80211_TX_RC_USE_SHORT_PREAMBLE      = BIT(2),
456
457         /* rate index is an MCS rate number instead of an index */
458         IEEE80211_TX_RC_MCS                     = BIT(3),
459         IEEE80211_TX_RC_GREEN_FIELD             = BIT(4),
460         IEEE80211_TX_RC_40_MHZ_WIDTH            = BIT(5),
461         IEEE80211_TX_RC_DUP_DATA                = BIT(6),
462         IEEE80211_TX_RC_SHORT_GI                = BIT(7),
463 };
464
465
466 /* there are 40 bytes if you don't need the rateset to be kept */
467 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
468
469 /* if you do need the rateset, then you have less space */
470 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
471
472 /* maximum number of rate stages */
473 #define IEEE80211_TX_MAX_RATES  5
474
475 /**
476  * struct ieee80211_tx_rate - rate selection/status
477  *
478  * @idx: rate index to attempt to send with
479  * @flags: rate control flags (&enum mac80211_rate_control_flags)
480  * @count: number of tries in this rate before going to the next rate
481  *
482  * A value of -1 for @idx indicates an invalid rate and, if used
483  * in an array of retry rates, that no more rates should be tried.
484  *
485  * When used for transmit status reporting, the driver should
486  * always report the rate along with the flags it used.
487  *
488  * &struct ieee80211_tx_info contains an array of these structs
489  * in the control information, and it will be filled by the rate
490  * control algorithm according to what should be sent. For example,
491  * if this array contains, in the format { <idx>, <count> } the
492  * information
493  *    { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
494  * then this means that the frame should be transmitted
495  * up to twice at rate 3, up to twice at rate 2, and up to four
496  * times at rate 1 if it doesn't get acknowledged. Say it gets
497  * acknowledged by the peer after the fifth attempt, the status
498  * information should then contain
499  *   { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
500  * since it was transmitted twice at rate 3, twice at rate 2
501  * and once at rate 1 after which we received an acknowledgement.
502  */
503 struct ieee80211_tx_rate {
504         s8 idx;
505         u8 count;
506         u8 flags;
507 } __packed;
508
509 /**
510  * struct ieee80211_tx_info - skb transmit information
511  *
512  * This structure is placed in skb->cb for three uses:
513  *  (1) mac80211 TX control - mac80211 tells the driver what to do
514  *  (2) driver internal use (if applicable)
515  *  (3) TX status information - driver tells mac80211 what happened
516  *
517  * The TX control's sta pointer is only valid during the ->tx call,
518  * it may be NULL.
519  *
520  * @flags: transmit info flags, defined above
521  * @band: the band to transmit on (use for checking for races)
522  * @antenna_sel_tx: antenna to use, 0 for automatic diversity
523  * @pad: padding, ignore
524  * @control: union for control data
525  * @status: union for status data
526  * @driver_data: array of driver_data pointers
527  * @ampdu_ack_len: number of acked aggregated frames.
528  *      relevant only if IEEE80211_TX_STAT_AMPDU was set.
529  * @ampdu_len: number of aggregated frames.
530  *      relevant only if IEEE80211_TX_STAT_AMPDU was set.
531  * @ack_signal: signal strength of the ACK frame
532  */
533 struct ieee80211_tx_info {
534         /* common information */
535         u32 flags;
536         u8 band;
537
538         u8 antenna_sel_tx;
539
540         /* 2 byte hole */
541         u8 pad[2];
542
543         union {
544                 struct {
545                         union {
546                                 /* rate control */
547                                 struct {
548                                         struct ieee80211_tx_rate rates[
549                                                 IEEE80211_TX_MAX_RATES];
550                                         s8 rts_cts_rate_idx;
551                                 };
552                                 /* only needed before rate control */
553                                 unsigned long jiffies;
554                         };
555                         /* NB: vif can be NULL for injected frames */
556                         struct ieee80211_vif *vif;
557                         struct ieee80211_key_conf *hw_key;
558                         struct ieee80211_sta *sta;
559                 } control;
560                 struct {
561                         struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
562                         u8 ampdu_ack_len;
563                         int ack_signal;
564                         u8 ampdu_len;
565                         /* 15 bytes free */
566                 } status;
567                 struct {
568                         struct ieee80211_tx_rate driver_rates[
569                                 IEEE80211_TX_MAX_RATES];
570                         void *rate_driver_data[
571                                 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
572                 };
573                 void *driver_data[
574                         IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
575         };
576 };
577
578 /**
579  * struct ieee80211_sched_scan_ies - scheduled scan IEs
580  *
581  * This structure is used to pass the appropriate IEs to be used in scheduled
582  * scans for all bands.  It contains both the IEs passed from the userspace
583  * and the ones generated by mac80211.
584  *
585  * @ie: array with the IEs for each supported band
586  * @len: array with the total length of the IEs for each band
587  */
588 struct ieee80211_sched_scan_ies {
589         u8 *ie[IEEE80211_NUM_BANDS];
590         size_t len[IEEE80211_NUM_BANDS];
591 };
592
593 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
594 {
595         return (struct ieee80211_tx_info *)skb->cb;
596 }
597
598 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
599 {
600         return (struct ieee80211_rx_status *)skb->cb;
601 }
602
603 /**
604  * ieee80211_tx_info_clear_status - clear TX status
605  *
606  * @info: The &struct ieee80211_tx_info to be cleared.
607  *
608  * When the driver passes an skb back to mac80211, it must report
609  * a number of things in TX status. This function clears everything
610  * in the TX status but the rate control information (it does clear
611  * the count since you need to fill that in anyway).
612  *
613  * NOTE: You can only use this function if you do NOT use
614  *       info->driver_data! Use info->rate_driver_data
615  *       instead if you need only the less space that allows.
616  */
617 static inline void
618 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
619 {
620         int i;
621
622         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
623                      offsetof(struct ieee80211_tx_info, control.rates));
624         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
625                      offsetof(struct ieee80211_tx_info, driver_rates));
626         BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
627         /* clear the rate counts */
628         for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
629                 info->status.rates[i].count = 0;
630
631         BUILD_BUG_ON(
632             offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
633         memset(&info->status.ampdu_ack_len, 0,
634                sizeof(struct ieee80211_tx_info) -
635                offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
636 }
637
638
639 /**
640  * enum mac80211_rx_flags - receive flags
641  *
642  * These flags are used with the @flag member of &struct ieee80211_rx_status.
643  * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
644  *      Use together with %RX_FLAG_MMIC_STRIPPED.
645  * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
646  * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
647  *      verification has been done by the hardware.
648  * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
649  *      If this flag is set, the stack cannot do any replay detection
650  *      hence the driver or hardware will have to do that.
651  * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
652  *      the frame.
653  * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
654  *      the frame.
655  * @RX_FLAG_MACTIME_MPDU: The timestamp passed in the RX status (@mactime
656  *      field) is valid and contains the time the first symbol of the MPDU
657  *      was received. This is useful in monitor mode and for proper IBSS
658  *      merging.
659  * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
660  * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
661  * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
662  * @RX_FLAG_SHORT_GI: Short guard interval was used
663  */
664 enum mac80211_rx_flags {
665         RX_FLAG_MMIC_ERROR      = 1<<0,
666         RX_FLAG_DECRYPTED       = 1<<1,
667         RX_FLAG_MMIC_STRIPPED   = 1<<3,
668         RX_FLAG_IV_STRIPPED     = 1<<4,
669         RX_FLAG_FAILED_FCS_CRC  = 1<<5,
670         RX_FLAG_FAILED_PLCP_CRC = 1<<6,
671         RX_FLAG_MACTIME_MPDU    = 1<<7,
672         RX_FLAG_SHORTPRE        = 1<<8,
673         RX_FLAG_HT              = 1<<9,
674         RX_FLAG_40MHZ           = 1<<10,
675         RX_FLAG_SHORT_GI        = 1<<11,
676 };
677
678 /**
679  * struct ieee80211_rx_status - receive status
680  *
681  * The low-level driver should provide this information (the subset
682  * supported by hardware) to the 802.11 code with each received
683  * frame, in the skb's control buffer (cb).
684  *
685  * @mactime: value in microseconds of the 64-bit Time Synchronization Function
686  *      (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
687  * @band: the active band when this frame was received
688  * @freq: frequency the radio was tuned to when receiving this frame, in MHz
689  * @signal: signal strength when receiving this frame, either in dBm, in dB or
690  *      unspecified depending on the hardware capabilities flags
691  *      @IEEE80211_HW_SIGNAL_*
692  * @antenna: antenna used
693  * @rate_idx: index of data rate into band's supported rates or MCS index if
694  *      HT rates are use (RX_FLAG_HT)
695  * @flag: %RX_FLAG_*
696  * @rx_flags: internal RX flags for mac80211
697  */
698 struct ieee80211_rx_status {
699         u64 mactime;
700         enum ieee80211_band band;
701         int freq;
702         int signal;
703         int antenna;
704         int rate_idx;
705         int flag;
706         unsigned int rx_flags;
707 };
708
709 /**
710  * enum ieee80211_conf_flags - configuration flags
711  *
712  * Flags to define PHY configuration options
713  *
714  * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
715  *      to determine for example whether to calculate timestamps for packets
716  *      or not, do not use instead of filter flags!
717  * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
718  *      This is the power save mode defined by IEEE 802.11-2007 section 11.2,
719  *      meaning that the hardware still wakes up for beacons, is able to
720  *      transmit frames and receive the possible acknowledgment frames.
721  *      Not to be confused with hardware specific wakeup/sleep states,
722  *      driver is responsible for that. See the section "Powersave support"
723  *      for more.
724  * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
725  *      the driver should be prepared to handle configuration requests but
726  *      may turn the device off as much as possible. Typically, this flag will
727  *      be set when an interface is set UP but not associated or scanning, but
728  *      it can also be unset in that case when monitor interfaces are active.
729  * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
730  *      operating channel.
731  */
732 enum ieee80211_conf_flags {
733         IEEE80211_CONF_MONITOR          = (1<<0),
734         IEEE80211_CONF_PS               = (1<<1),
735         IEEE80211_CONF_IDLE             = (1<<2),
736         IEEE80211_CONF_OFFCHANNEL       = (1<<3),
737 };
738
739
740 /**
741  * enum ieee80211_conf_changed - denotes which configuration changed
742  *
743  * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
744  * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
745  * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
746  * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
747  * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
748  * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
749  * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
750  * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
751  */
752 enum ieee80211_conf_changed {
753         IEEE80211_CONF_CHANGE_SMPS              = BIT(1),
754         IEEE80211_CONF_CHANGE_LISTEN_INTERVAL   = BIT(2),
755         IEEE80211_CONF_CHANGE_MONITOR           = BIT(3),
756         IEEE80211_CONF_CHANGE_PS                = BIT(4),
757         IEEE80211_CONF_CHANGE_POWER             = BIT(5),
758         IEEE80211_CONF_CHANGE_CHANNEL           = BIT(6),
759         IEEE80211_CONF_CHANGE_RETRY_LIMITS      = BIT(7),
760         IEEE80211_CONF_CHANGE_IDLE              = BIT(8),
761 };
762
763 /**
764  * enum ieee80211_smps_mode - spatial multiplexing power save mode
765  *
766  * @IEEE80211_SMPS_AUTOMATIC: automatic
767  * @IEEE80211_SMPS_OFF: off
768  * @IEEE80211_SMPS_STATIC: static
769  * @IEEE80211_SMPS_DYNAMIC: dynamic
770  * @IEEE80211_SMPS_NUM_MODES: internal, don't use
771  */
772 enum ieee80211_smps_mode {
773         IEEE80211_SMPS_AUTOMATIC,
774         IEEE80211_SMPS_OFF,
775         IEEE80211_SMPS_STATIC,
776         IEEE80211_SMPS_DYNAMIC,
777
778         /* keep last */
779         IEEE80211_SMPS_NUM_MODES,
780 };
781
782 /**
783  * struct ieee80211_conf - configuration of the device
784  *
785  * This struct indicates how the driver shall configure the hardware.
786  *
787  * @flags: configuration flags defined above
788  *
789  * @listen_interval: listen interval in units of beacon interval
790  * @max_sleep_period: the maximum number of beacon intervals to sleep for
791  *      before checking the beacon for a TIM bit (managed mode only); this
792  *      value will be only achievable between DTIM frames, the hardware
793  *      needs to check for the multicast traffic bit in DTIM beacons.
794  *      This variable is valid only when the CONF_PS flag is set.
795  * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
796  *      in power saving. Power saving will not be enabled until a beacon
797  *      has been received and the DTIM period is known.
798  * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
799  *      powersave documentation below. This variable is valid only when
800  *      the CONF_PS flag is set.
801  *
802  * @power_level: requested transmit power (in dBm)
803  *
804  * @channel: the channel to tune to
805  * @channel_type: the channel (HT) type
806  *
807  * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
808  *    (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
809  *    but actually means the number of transmissions not the number of retries
810  * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
811  *    frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
812  *    number of transmissions not the number of retries
813  *
814  * @smps_mode: spatial multiplexing powersave mode; note that
815  *      %IEEE80211_SMPS_STATIC is used when the device is not
816  *      configured for an HT channel
817  */
818 struct ieee80211_conf {
819         u32 flags;
820         int power_level, dynamic_ps_timeout;
821         int max_sleep_period;
822
823         u16 listen_interval;
824         u8 ps_dtim_period;
825
826         u8 long_frame_max_tx_count, short_frame_max_tx_count;
827
828         struct ieee80211_channel *channel;
829         enum nl80211_channel_type channel_type;
830         enum ieee80211_smps_mode smps_mode;
831 };
832
833 /**
834  * struct ieee80211_channel_switch - holds the channel switch data
835  *
836  * The information provided in this structure is required for channel switch
837  * operation.
838  *
839  * @timestamp: value in microseconds of the 64-bit Time Synchronization
840  *      Function (TSF) timer when the frame containing the channel switch
841  *      announcement was received. This is simply the rx.mactime parameter
842  *      the driver passed into mac80211.
843  * @block_tx: Indicates whether transmission must be blocked before the
844  *      scheduled channel switch, as indicated by the AP.
845  * @channel: the new channel to switch to
846  * @count: the number of TBTT's until the channel switch event
847  */
848 struct ieee80211_channel_switch {
849         u64 timestamp;
850         bool block_tx;
851         struct ieee80211_channel *channel;
852         u8 count;
853 };
854
855 /**
856  * struct ieee80211_vif - per-interface data
857  *
858  * Data in this structure is continually present for driver
859  * use during the life of a virtual interface.
860  *
861  * @type: type of this virtual interface
862  * @bss_conf: BSS configuration for this interface, either our own
863  *      or the BSS we're associated to
864  * @addr: address of this interface
865  * @p2p: indicates whether this AP or STA interface is a p2p
866  *      interface, i.e. a GO or p2p-sta respectively
867  * @drv_priv: data area for driver use, will always be aligned to
868  *      sizeof(void *).
869  */
870 struct ieee80211_vif {
871         enum nl80211_iftype type;
872         struct ieee80211_bss_conf bss_conf;
873         u8 addr[ETH_ALEN];
874         bool p2p;
875         /* must be last */
876         u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
877 };
878
879 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
880 {
881 #ifdef CONFIG_MAC80211_MESH
882         return vif->type == NL80211_IFTYPE_MESH_POINT;
883 #endif
884         return false;
885 }
886
887 /**
888  * enum ieee80211_key_flags - key flags
889  *
890  * These flags are used for communication about keys between the driver
891  * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
892  *
893  * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
894  *      that the STA this key will be used with could be using QoS.
895  * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
896  *      driver to indicate that it requires IV generation for this
897  *      particular key.
898  * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
899  *      the driver for a TKIP key if it requires Michael MIC
900  *      generation in software.
901  * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
902  *      that the key is pairwise rather then a shared key.
903  * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
904  *      CCMP key if it requires CCMP encryption of management frames (MFP) to
905  *      be done in software.
906  */
907 enum ieee80211_key_flags {
908         IEEE80211_KEY_FLAG_WMM_STA      = 1<<0,
909         IEEE80211_KEY_FLAG_GENERATE_IV  = 1<<1,
910         IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
911         IEEE80211_KEY_FLAG_PAIRWISE     = 1<<3,
912         IEEE80211_KEY_FLAG_SW_MGMT      = 1<<4,
913 };
914
915 /**
916  * struct ieee80211_key_conf - key information
917  *
918  * This key information is given by mac80211 to the driver by
919  * the set_key() callback in &struct ieee80211_ops.
920  *
921  * @hw_key_idx: To be set by the driver, this is the key index the driver
922  *      wants to be given when a frame is transmitted and needs to be
923  *      encrypted in hardware.
924  * @cipher: The key's cipher suite selector.
925  * @flags: key flags, see &enum ieee80211_key_flags.
926  * @keyidx: the key index (0-3)
927  * @keylen: key material length
928  * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
929  *      data block:
930  *      - Temporal Encryption Key (128 bits)
931  *      - Temporal Authenticator Tx MIC Key (64 bits)
932  *      - Temporal Authenticator Rx MIC Key (64 bits)
933  * @icv_len: The ICV length for this key type
934  * @iv_len: The IV length for this key type
935  */
936 struct ieee80211_key_conf {
937         u32 cipher;
938         u8 icv_len;
939         u8 iv_len;
940         u8 hw_key_idx;
941         u8 flags;
942         s8 keyidx;
943         u8 keylen;
944         u8 key[0];
945 };
946
947 /**
948  * enum set_key_cmd - key command
949  *
950  * Used with the set_key() callback in &struct ieee80211_ops, this
951  * indicates whether a key is being removed or added.
952  *
953  * @SET_KEY: a key is set
954  * @DISABLE_KEY: a key must be disabled
955  */
956 enum set_key_cmd {
957         SET_KEY, DISABLE_KEY,
958 };
959
960 /**
961  * struct ieee80211_sta - station table entry
962  *
963  * A station table entry represents a station we are possibly
964  * communicating with. Since stations are RCU-managed in
965  * mac80211, any ieee80211_sta pointer you get access to must
966  * either be protected by rcu_read_lock() explicitly or implicitly,
967  * or you must take good care to not use such a pointer after a
968  * call to your sta_remove callback that removed it.
969  *
970  * @addr: MAC address
971  * @aid: AID we assigned to the station if we're an AP
972  * @supp_rates: Bitmap of supported rates (per band)
973  * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
974  * @wme: indicates whether the STA supports WME. Only valid during AP-mode.
975  * @drv_priv: data area for driver use, will always be aligned to
976  *      sizeof(void *), size is determined in hw information.
977  * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
978  *      if wme is supported.
979  * @max_sp: max Service Period. Only valid if wme is supported.
980  */
981 struct ieee80211_sta {
982         u32 supp_rates[IEEE80211_NUM_BANDS];
983         u8 addr[ETH_ALEN];
984         u16 aid;
985         struct ieee80211_sta_ht_cap ht_cap;
986         bool wme;
987         u8 uapsd_queues;
988         u8 max_sp;
989
990         /* must be last */
991         u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
992 };
993
994 /**
995  * enum sta_notify_cmd - sta notify command
996  *
997  * Used with the sta_notify() callback in &struct ieee80211_ops, this
998  * indicates if an associated station made a power state transition.
999  *
1000  * @STA_NOTIFY_SLEEP: a station is now sleeping
1001  * @STA_NOTIFY_AWAKE: a sleeping station woke up
1002  */
1003 enum sta_notify_cmd {
1004         STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1005 };
1006
1007 /**
1008  * enum ieee80211_hw_flags - hardware flags
1009  *
1010  * These flags are used to indicate hardware capabilities to
1011  * the stack. Generally, flags here should have their meaning
1012  * done in a way that the simplest hardware doesn't need setting
1013  * any particular flags. There are some exceptions to this rule,
1014  * however, so you are advised to review these flags carefully.
1015  *
1016  * @IEEE80211_HW_HAS_RATE_CONTROL:
1017  *      The hardware or firmware includes rate control, and cannot be
1018  *      controlled by the stack. As such, no rate control algorithm
1019  *      should be instantiated, and the TX rate reported to userspace
1020  *      will be taken from the TX status instead of the rate control
1021  *      algorithm.
1022  *      Note that this requires that the driver implement a number of
1023  *      callbacks so it has the correct information, it needs to have
1024  *      the @set_rts_threshold callback and must look at the BSS config
1025  *      @use_cts_prot for G/N protection, @use_short_slot for slot
1026  *      timing in 2.4 GHz and @use_short_preamble for preambles for
1027  *      CCK frames.
1028  *
1029  * @IEEE80211_HW_RX_INCLUDES_FCS:
1030  *      Indicates that received frames passed to the stack include
1031  *      the FCS at the end.
1032  *
1033  * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1034  *      Some wireless LAN chipsets buffer broadcast/multicast frames
1035  *      for power saving stations in the hardware/firmware and others
1036  *      rely on the host system for such buffering. This option is used
1037  *      to configure the IEEE 802.11 upper layer to buffer broadcast and
1038  *      multicast frames when there are power saving stations so that
1039  *      the driver can fetch them with ieee80211_get_buffered_bc().
1040  *
1041  * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
1042  *      Hardware is not capable of short slot operation on the 2.4 GHz band.
1043  *
1044  * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
1045  *      Hardware is not capable of receiving frames with short preamble on
1046  *      the 2.4 GHz band.
1047  *
1048  * @IEEE80211_HW_SIGNAL_UNSPEC:
1049  *      Hardware can provide signal values but we don't know its units. We
1050  *      expect values between 0 and @max_signal.
1051  *      If possible please provide dB or dBm instead.
1052  *
1053  * @IEEE80211_HW_SIGNAL_DBM:
1054  *      Hardware gives signal values in dBm, decibel difference from
1055  *      one milliwatt. This is the preferred method since it is standardized
1056  *      between different devices. @max_signal does not need to be set.
1057  *
1058  * @IEEE80211_HW_SPECTRUM_MGMT:
1059  *      Hardware supports spectrum management defined in 802.11h
1060  *      Measurement, Channel Switch, Quieting, TPC
1061  *
1062  * @IEEE80211_HW_AMPDU_AGGREGATION:
1063  *      Hardware supports 11n A-MPDU aggregation.
1064  *
1065  * @IEEE80211_HW_SUPPORTS_PS:
1066  *      Hardware has power save support (i.e. can go to sleep).
1067  *
1068  * @IEEE80211_HW_PS_NULLFUNC_STACK:
1069  *      Hardware requires nullfunc frame handling in stack, implies
1070  *      stack support for dynamic PS.
1071  *
1072  * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1073  *      Hardware has support for dynamic PS.
1074  *
1075  * @IEEE80211_HW_MFP_CAPABLE:
1076  *      Hardware supports management frame protection (MFP, IEEE 802.11w).
1077  *
1078  * @IEEE80211_HW_BEACON_FILTER:
1079  *      Hardware supports dropping of irrelevant beacon frames to
1080  *      avoid waking up cpu.
1081  *
1082  * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1083  *      Hardware supports static spatial multiplexing powersave,
1084  *      ie. can turn off all but one chain even on HT connections
1085  *      that should be using more chains.
1086  *
1087  * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1088  *      Hardware supports dynamic spatial multiplexing powersave,
1089  *      ie. can turn off all but one chain and then wake the rest
1090  *      up as required after, for example, rts/cts handshake.
1091  *
1092  * @IEEE80211_HW_SUPPORTS_UAPSD:
1093  *      Hardware supports Unscheduled Automatic Power Save Delivery
1094  *      (U-APSD) in managed mode. The mode is configured with
1095  *      conf_tx() operation.
1096  *
1097  * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1098  *      Hardware can provide ack status reports of Tx frames to
1099  *      the stack.
1100  *
1101  * @IEEE80211_HW_CONNECTION_MONITOR:
1102  *      The hardware performs its own connection monitoring, including
1103  *      periodic keep-alives to the AP and probing the AP on beacon loss.
1104  *      When this flag is set, signaling beacon-loss will cause an immediate
1105  *      change to disassociated state.
1106  *
1107  * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1108  *      Hardware can do connection quality monitoring - i.e. it can monitor
1109  *      connection quality related parameters, such as the RSSI level and
1110  *      provide notifications if configured trigger levels are reached.
1111  *
1112  * @IEEE80211_HW_NEED_DTIM_PERIOD:
1113  *      This device needs to know the DTIM period for the BSS before
1114  *      associating.
1115  *
1116  * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1117  *      per-station GTKs as used by IBSS RSN or during fast transition. If
1118  *      the device doesn't support per-station GTKs, but can be asked not
1119  *      to decrypt group addressed frames, then IBSS RSN support is still
1120  *      possible but software crypto will be used. Advertise the wiphy flag
1121  *      only in that case.
1122  *
1123  * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1124  *      autonomously manages the PS status of connected stations. When
1125  *      this flag is set mac80211 will not trigger PS mode for connected
1126  *      stations based on the PM bit of incoming frames.
1127  *      Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1128  *      the PS mode of connected stations.
1129  *
1130  * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1131  *      setup strictly in HW. mac80211 should not attempt to do this in
1132  *      software.
1133  */
1134 enum ieee80211_hw_flags {
1135         IEEE80211_HW_HAS_RATE_CONTROL                   = 1<<0,
1136         IEEE80211_HW_RX_INCLUDES_FCS                    = 1<<1,
1137         IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING        = 1<<2,
1138         IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE          = 1<<3,
1139         IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE      = 1<<4,
1140         IEEE80211_HW_SIGNAL_UNSPEC                      = 1<<5,
1141         IEEE80211_HW_SIGNAL_DBM                         = 1<<6,
1142         IEEE80211_HW_NEED_DTIM_PERIOD                   = 1<<7,
1143         IEEE80211_HW_SPECTRUM_MGMT                      = 1<<8,
1144         IEEE80211_HW_AMPDU_AGGREGATION                  = 1<<9,
1145         IEEE80211_HW_SUPPORTS_PS                        = 1<<10,
1146         IEEE80211_HW_PS_NULLFUNC_STACK                  = 1<<11,
1147         IEEE80211_HW_SUPPORTS_DYNAMIC_PS                = 1<<12,
1148         IEEE80211_HW_MFP_CAPABLE                        = 1<<13,
1149         IEEE80211_HW_BEACON_FILTER                      = 1<<14,
1150         IEEE80211_HW_SUPPORTS_STATIC_SMPS               = 1<<15,
1151         IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS              = 1<<16,
1152         IEEE80211_HW_SUPPORTS_UAPSD                     = 1<<17,
1153         IEEE80211_HW_REPORTS_TX_ACK_STATUS              = 1<<18,
1154         IEEE80211_HW_CONNECTION_MONITOR                 = 1<<19,
1155         IEEE80211_HW_SUPPORTS_CQM_RSSI                  = 1<<20,
1156         IEEE80211_HW_SUPPORTS_PER_STA_GTK               = 1<<21,
1157         IEEE80211_HW_AP_LINK_PS                         = 1<<22,
1158         IEEE80211_HW_TX_AMPDU_SETUP_IN_HW               = 1<<23,
1159 };
1160
1161 /**
1162  * struct ieee80211_hw - hardware information and state
1163  *
1164  * This structure contains the configuration and hardware
1165  * information for an 802.11 PHY.
1166  *
1167  * @wiphy: This points to the &struct wiphy allocated for this
1168  *      802.11 PHY. You must fill in the @perm_addr and @dev
1169  *      members of this structure using SET_IEEE80211_DEV()
1170  *      and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1171  *      bands (with channels, bitrates) are registered here.
1172  *
1173  * @conf: &struct ieee80211_conf, device configuration, don't use.
1174  *
1175  * @priv: pointer to private area that was allocated for driver use
1176  *      along with this structure.
1177  *
1178  * @flags: hardware flags, see &enum ieee80211_hw_flags.
1179  *
1180  * @extra_tx_headroom: headroom to reserve in each transmit skb
1181  *      for use by the driver (e.g. for transmit headers.)
1182  *
1183  * @channel_change_time: time (in microseconds) it takes to change channels.
1184  *
1185  * @max_signal: Maximum value for signal (rssi) in RX information, used
1186  *     only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1187  *
1188  * @max_listen_interval: max listen interval in units of beacon interval
1189  *     that HW supports
1190  *
1191  * @queues: number of available hardware transmit queues for
1192  *      data packets. WMM/QoS requires at least four, these
1193  *      queues need to have configurable access parameters.
1194  *
1195  * @rate_control_algorithm: rate control algorithm for this hardware.
1196  *      If unset (NULL), the default algorithm will be used. Must be
1197  *      set before calling ieee80211_register_hw().
1198  *
1199  * @vif_data_size: size (in bytes) of the drv_priv data area
1200  *      within &struct ieee80211_vif.
1201  * @sta_data_size: size (in bytes) of the drv_priv data area
1202  *      within &struct ieee80211_sta.
1203  *
1204  * @max_rates: maximum number of alternate rate retry stages the hw
1205  *      can handle.
1206  * @max_report_rates: maximum number of alternate rate retry stages
1207  *      the hw can report back.
1208  * @max_rate_tries: maximum number of tries for each stage
1209  *
1210  * @napi_weight: weight used for NAPI polling.  You must specify an
1211  *      appropriate value here if a napi_poll operation is provided
1212  *      by your driver.
1213  *
1214  * @max_rx_aggregation_subframes: maximum buffer size (number of
1215  *      sub-frames) to be used for A-MPDU block ack receiver
1216  *      aggregation.
1217  *      This is only relevant if the device has restrictions on the
1218  *      number of subframes, if it relies on mac80211 to do reordering
1219  *      it shouldn't be set.
1220  *
1221  * @max_tx_aggregation_subframes: maximum number of subframes in an
1222  *      aggregate an HT driver will transmit, used by the peer as a
1223  *      hint to size its reorder buffer.
1224  */
1225 struct ieee80211_hw {
1226         struct ieee80211_conf conf;
1227         struct wiphy *wiphy;
1228         const char *rate_control_algorithm;
1229         void *priv;
1230         u32 flags;
1231         unsigned int extra_tx_headroom;
1232         int channel_change_time;
1233         int vif_data_size;
1234         int sta_data_size;
1235         int napi_weight;
1236         u16 queues;
1237         u16 max_listen_interval;
1238         s8 max_signal;
1239         u8 max_rates;
1240         u8 max_report_rates;
1241         u8 max_rate_tries;
1242         u8 max_rx_aggregation_subframes;
1243         u8 max_tx_aggregation_subframes;
1244 };
1245
1246 /**
1247  * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1248  *
1249  * @wiphy: the &struct wiphy which we want to query
1250  *
1251  * mac80211 drivers can use this to get to their respective
1252  * &struct ieee80211_hw. Drivers wishing to get to their own private
1253  * structure can then access it via hw->priv. Note that mac802111 drivers should
1254  * not use wiphy_priv() to try to get their private driver structure as this
1255  * is already used internally by mac80211.
1256  */
1257 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1258
1259 /**
1260  * SET_IEEE80211_DEV - set device for 802.11 hardware
1261  *
1262  * @hw: the &struct ieee80211_hw to set the device for
1263  * @dev: the &struct device of this 802.11 device
1264  */
1265 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1266 {
1267         set_wiphy_dev(hw->wiphy, dev);
1268 }
1269
1270 /**
1271  * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1272  *
1273  * @hw: the &struct ieee80211_hw to set the MAC address for
1274  * @addr: the address to set
1275  */
1276 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1277 {
1278         memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1279 }
1280
1281 static inline struct ieee80211_rate *
1282 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1283                       const struct ieee80211_tx_info *c)
1284 {
1285         if (WARN_ON(c->control.rates[0].idx < 0))
1286                 return NULL;
1287         return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1288 }
1289
1290 static inline struct ieee80211_rate *
1291 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1292                            const struct ieee80211_tx_info *c)
1293 {
1294         if (c->control.rts_cts_rate_idx < 0)
1295                 return NULL;
1296         return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1297 }
1298
1299 static inline struct ieee80211_rate *
1300 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1301                              const struct ieee80211_tx_info *c, int idx)
1302 {
1303         if (c->control.rates[idx + 1].idx < 0)
1304                 return NULL;
1305         return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1306 }
1307
1308 /**
1309  * DOC: Hardware crypto acceleration
1310  *
1311  * mac80211 is capable of taking advantage of many hardware
1312  * acceleration designs for encryption and decryption operations.
1313  *
1314  * The set_key() callback in the &struct ieee80211_ops for a given
1315  * device is called to enable hardware acceleration of encryption and
1316  * decryption. The callback takes a @sta parameter that will be NULL
1317  * for default keys or keys used for transmission only, or point to
1318  * the station information for the peer for individual keys.
1319  * Multiple transmission keys with the same key index may be used when
1320  * VLANs are configured for an access point.
1321  *
1322  * When transmitting, the TX control data will use the @hw_key_idx
1323  * selected by the driver by modifying the &struct ieee80211_key_conf
1324  * pointed to by the @key parameter to the set_key() function.
1325  *
1326  * The set_key() call for the %SET_KEY command should return 0 if
1327  * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1328  * added; if you return 0 then hw_key_idx must be assigned to the
1329  * hardware key index, you are free to use the full u8 range.
1330  *
1331  * When the cmd is %DISABLE_KEY then it must succeed.
1332  *
1333  * Note that it is permissible to not decrypt a frame even if a key
1334  * for it has been uploaded to hardware, the stack will not make any
1335  * decision based on whether a key has been uploaded or not but rather
1336  * based on the receive flags.
1337  *
1338  * The &struct ieee80211_key_conf structure pointed to by the @key
1339  * parameter is guaranteed to be valid until another call to set_key()
1340  * removes it, but it can only be used as a cookie to differentiate
1341  * keys.
1342  *
1343  * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1344  * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1345  * handler.
1346  * The update_tkip_key() call updates the driver with the new phase 1 key.
1347  * This happens every time the iv16 wraps around (every 65536 packets). The
1348  * set_key() call will happen only once for each key (unless the AP did
1349  * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1350  * provided by update_tkip_key only. The trigger that makes mac80211 call this
1351  * handler is software decryption with wrap around of iv16.
1352  */
1353
1354 /**
1355  * DOC: Powersave support
1356  *
1357  * mac80211 has support for various powersave implementations.
1358  *
1359  * First, it can support hardware that handles all powersaving by itself,
1360  * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1361  * flag. In that case, it will be told about the desired powersave mode
1362  * with the %IEEE80211_CONF_PS flag depending on the association status.
1363  * The hardware must take care of sending nullfunc frames when necessary,
1364  * i.e. when entering and leaving powersave mode. The hardware is required
1365  * to look at the AID in beacons and signal to the AP that it woke up when
1366  * it finds traffic directed to it.
1367  *
1368  * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1369  * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1370  * with hardware wakeup and sleep states. Driver is responsible for waking
1371  * up the hardware before issuing commands to the hardware and putting it
1372  * back to sleep at appropriate times.
1373  *
1374  * When PS is enabled, hardware needs to wakeup for beacons and receive the
1375  * buffered multicast/broadcast frames after the beacon. Also it must be
1376  * possible to send frames and receive the acknowledment frame.
1377  *
1378  * Other hardware designs cannot send nullfunc frames by themselves and also
1379  * need software support for parsing the TIM bitmap. This is also supported
1380  * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1381  * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1382  * required to pass up beacons. The hardware is still required to handle
1383  * waking up for multicast traffic; if it cannot the driver must handle that
1384  * as best as it can, mac80211 is too slow to do that.
1385  *
1386  * Dynamic powersave is an extension to normal powersave in which the
1387  * hardware stays awake for a user-specified period of time after sending a
1388  * frame so that reply frames need not be buffered and therefore delayed to
1389  * the next wakeup. It's compromise of getting good enough latency when
1390  * there's data traffic and still saving significantly power in idle
1391  * periods.
1392  *
1393  * Dynamic powersave is simply supported by mac80211 enabling and disabling
1394  * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1395  * flag and mac80211 will handle everything automatically. Additionally,
1396  * hardware having support for the dynamic PS feature may set the
1397  * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1398  * dynamic PS mode itself. The driver needs to look at the
1399  * @dynamic_ps_timeout hardware configuration value and use it that value
1400  * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1401  * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1402  * enabled whenever user has enabled powersave.
1403  *
1404  * Some hardware need to toggle a single shared antenna between WLAN and
1405  * Bluetooth to facilitate co-existence. These types of hardware set
1406  * limitations on the use of host controlled dynamic powersave whenever there
1407  * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1408  * driver may request temporarily going into full power save, in order to
1409  * enable toggling the antenna between BT and WLAN. If the driver requests
1410  * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1411  * temporarily set to zero until the driver re-enables dynamic powersave.
1412  *
1413  * Driver informs U-APSD client support by enabling
1414  * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1415  * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1416  * Nullfunc frames and stay awake until the service period has ended. To
1417  * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1418  * from that AC are transmitted with powersave enabled.
1419  *
1420  * Note: U-APSD client mode is not yet supported with
1421  * %IEEE80211_HW_PS_NULLFUNC_STACK.
1422  */
1423
1424 /**
1425  * DOC: Beacon filter support
1426  *
1427  * Some hardware have beacon filter support to reduce host cpu wakeups
1428  * which will reduce system power consumption. It usuallly works so that
1429  * the firmware creates a checksum of the beacon but omits all constantly
1430  * changing elements (TSF, TIM etc). Whenever the checksum changes the
1431  * beacon is forwarded to the host, otherwise it will be just dropped. That
1432  * way the host will only receive beacons where some relevant information
1433  * (for example ERP protection or WMM settings) have changed.
1434  *
1435  * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1436  * hardware capability. The driver needs to enable beacon filter support
1437  * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1438  * power save is enabled, the stack will not check for beacon loss and the
1439  * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1440  *
1441  * The time (or number of beacons missed) until the firmware notifies the
1442  * driver of a beacon loss event (which in turn causes the driver to call
1443  * ieee80211_beacon_loss()) should be configurable and will be controlled
1444  * by mac80211 and the roaming algorithm in the future.
1445  *
1446  * Since there may be constantly changing information elements that nothing
1447  * in the software stack cares about, we will, in the future, have mac80211
1448  * tell the driver which information elements are interesting in the sense
1449  * that we want to see changes in them. This will include
1450  *  - a list of information element IDs
1451  *  - a list of OUIs for the vendor information element
1452  *
1453  * Ideally, the hardware would filter out any beacons without changes in the
1454  * requested elements, but if it cannot support that it may, at the expense
1455  * of some efficiency, filter out only a subset. For example, if the device
1456  * doesn't support checking for OUIs it should pass up all changes in all
1457  * vendor information elements.
1458  *
1459  * Note that change, for the sake of simplification, also includes information
1460  * elements appearing or disappearing from the beacon.
1461  *
1462  * Some hardware supports an "ignore list" instead, just make sure nothing
1463  * that was requested is on the ignore list, and include commonly changing
1464  * information element IDs in the ignore list, for example 11 (BSS load) and
1465  * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1466  * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1467  * it could also include some currently unused IDs.
1468  *
1469  *
1470  * In addition to these capabilities, hardware should support notifying the
1471  * host of changes in the beacon RSSI. This is relevant to implement roaming
1472  * when no traffic is flowing (when traffic is flowing we see the RSSI of
1473  * the received data packets). This can consist in notifying the host when
1474  * the RSSI changes significantly or when it drops below or rises above
1475  * configurable thresholds. In the future these thresholds will also be
1476  * configured by mac80211 (which gets them from userspace) to implement
1477  * them as the roaming algorithm requires.
1478  *
1479  * If the hardware cannot implement this, the driver should ask it to
1480  * periodically pass beacon frames to the host so that software can do the
1481  * signal strength threshold checking.
1482  */
1483
1484 /**
1485  * DOC: Spatial multiplexing power save
1486  *
1487  * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1488  * power in an 802.11n implementation. For details on the mechanism
1489  * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1490  * "11.2.3 SM power save".
1491  *
1492  * The mac80211 implementation is capable of sending action frames
1493  * to update the AP about the station's SMPS mode, and will instruct
1494  * the driver to enter the specific mode. It will also announce the
1495  * requested SMPS mode during the association handshake. Hardware
1496  * support for this feature is required, and can be indicated by
1497  * hardware flags.
1498  *
1499  * The default mode will be "automatic", which nl80211/cfg80211
1500  * defines to be dynamic SMPS in (regular) powersave, and SMPS
1501  * turned off otherwise.
1502  *
1503  * To support this feature, the driver must set the appropriate
1504  * hardware support flags, and handle the SMPS flag to the config()
1505  * operation. It will then with this mechanism be instructed to
1506  * enter the requested SMPS mode while associated to an HT AP.
1507  */
1508
1509 /**
1510  * DOC: Frame filtering
1511  *
1512  * mac80211 requires to see many management frames for proper
1513  * operation, and users may want to see many more frames when
1514  * in monitor mode. However, for best CPU usage and power consumption,
1515  * having as few frames as possible percolate through the stack is
1516  * desirable. Hence, the hardware should filter as much as possible.
1517  *
1518  * To achieve this, mac80211 uses filter flags (see below) to tell
1519  * the driver's configure_filter() function which frames should be
1520  * passed to mac80211 and which should be filtered out.
1521  *
1522  * Before configure_filter() is invoked, the prepare_multicast()
1523  * callback is invoked with the parameters @mc_count and @mc_list
1524  * for the combined multicast address list of all virtual interfaces.
1525  * It's use is optional, and it returns a u64 that is passed to
1526  * configure_filter(). Additionally, configure_filter() has the
1527  * arguments @changed_flags telling which flags were changed and
1528  * @total_flags with the new flag states.
1529  *
1530  * If your device has no multicast address filters your driver will
1531  * need to check both the %FIF_ALLMULTI flag and the @mc_count
1532  * parameter to see whether multicast frames should be accepted
1533  * or dropped.
1534  *
1535  * All unsupported flags in @total_flags must be cleared.
1536  * Hardware does not support a flag if it is incapable of _passing_
1537  * the frame to the stack. Otherwise the driver must ignore
1538  * the flag, but not clear it.
1539  * You must _only_ clear the flag (announce no support for the
1540  * flag to mac80211) if you are not able to pass the packet type
1541  * to the stack (so the hardware always filters it).
1542  * So for example, you should clear @FIF_CONTROL, if your hardware
1543  * always filters control frames. If your hardware always passes
1544  * control frames to the kernel and is incapable of filtering them,
1545  * you do _not_ clear the @FIF_CONTROL flag.
1546  * This rule applies to all other FIF flags as well.
1547  */
1548
1549 /**
1550  * DOC: AP support for powersaving clients
1551  *
1552  * In order to implement AP and P2P GO modes, mac80211 has support for
1553  * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
1554  * There currently is no support for sAPSD.
1555  *
1556  * There is one assumption that mac80211 makes, namely that a client
1557  * will not poll with PS-Poll and trigger with uAPSD at the same time.
1558  * Both are supported, and both can be used by the same client, but
1559  * they can't be used concurrently by the same client. This simplifies
1560  * the driver code.
1561  *
1562  * The first thing to keep in mind is that there is a flag for complete
1563  * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
1564  * mac80211 expects the driver to handle most of the state machine for
1565  * powersaving clients and will ignore the PM bit in incoming frames.
1566  * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
1567  * stations' powersave transitions. In this mode, mac80211 also doesn't
1568  * handle PS-Poll/uAPSD.
1569  *
1570  * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
1571  * PM bit in incoming frames for client powersave transitions. When a
1572  * station goes to sleep, we will stop transmitting to it. There is,
1573  * however, a race condition: a station might go to sleep while there is
1574  * data buffered on hardware queues. If the device has support for this
1575  * it will reject frames, and the driver should give the frames back to
1576  * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
1577  * cause mac80211 to retry the frame when the station wakes up. The
1578  * driver is also notified of powersave transitions by calling its
1579  * @sta_notify callback.
1580  *
1581  * When the station is asleep, it has three choices: it can wake up,
1582  * it can PS-Poll, or it can possibly start a uAPSD service period.
1583  * Waking up is implemented by simply transmitting all buffered (and
1584  * filtered) frames to the station. This is the easiest case. When
1585  * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
1586  * will inform the driver of this with the @allow_buffered_frames
1587  * callback; this callback is optional. mac80211 will then transmit
1588  * the frames as usual and set the %IEEE80211_TX_CTL_POLL_RESPONSE
1589  * on each frame. The last frame in the service period (or the only
1590  * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
1591  * indicate that it ends the service period; as this frame must have
1592  * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
1593  * When TX status is reported for this frame, the service period is
1594  * marked has having ended and a new one can be started by the peer.
1595  *
1596  * Another race condition can happen on some devices like iwlwifi
1597  * when there are frames queued for the station and it wakes up
1598  * or polls; the frames that are already queued could end up being
1599  * transmitted first instead, causing reordering and/or wrong
1600  * processing of the EOSP. The cause is that allowing frames to be
1601  * transmitted to a certain station is out-of-band communication to
1602  * the device. To allow this problem to be solved, the driver can
1603  * call ieee80211_sta_block_awake() if frames are buffered when it
1604  * is notified that the station went to sleep. When all these frames
1605  * have been filtered (see above), it must call the function again
1606  * to indicate that the station is no longer blocked.
1607  *
1608  * If the driver buffers frames in the driver for aggregation in any
1609  * way, it must use the ieee80211_sta_set_buffered() call when it is
1610  * notified of the station going to sleep to inform mac80211 of any
1611  * TIDs that have frames buffered. Note that when a station wakes up
1612  * this information is reset (hence the requirement to call it when
1613  * informed of the station going to sleep). Then, when a service
1614  * period starts for any reason, @release_buffered_frames is called
1615  * with the number of frames to be released and which TIDs they are
1616  * to come from. In this case, the driver is responsible for setting
1617  * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
1618  * to help the @more_data paramter is passed to tell the driver if
1619  * there is more data on other TIDs -- the TIDs to release frames
1620  * from are ignored since mac80211 doesn't know how many frames the
1621  * buffers for those TIDs contain.
1622  *
1623  * If the driver also implement GO mode, where absence periods may
1624  * shorten service periods (or abort PS-Poll responses), it must
1625  * filter those response frames except in the case of frames that
1626  * are buffered in the driver -- those must remain buffered to avoid
1627  * reordering. Because it is possible that no frames are released
1628  * in this case, the driver must call ieee80211_sta_eosp_irqsafe()
1629  * to indicate to mac80211 that the service period ended anyway.
1630  *
1631  * Finally, if frames from multiple TIDs are released from mac80211
1632  * but the driver might reorder them, it must clear & set the flags
1633  * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
1634  * and also take care of the EOSP and MORE_DATA bits in the frame.
1635  * The driver may also use ieee80211_sta_eosp_irqsafe() in this case.
1636  */
1637
1638 /**
1639  * enum ieee80211_filter_flags - hardware filter flags
1640  *
1641  * These flags determine what the filter in hardware should be
1642  * programmed to let through and what should not be passed to the
1643  * stack. It is always safe to pass more frames than requested,
1644  * but this has negative impact on power consumption.
1645  *
1646  * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1647  *      think of the BSS as your network segment and then this corresponds
1648  *      to the regular ethernet device promiscuous mode.
1649  *
1650  * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1651  *      by the user or if the hardware is not capable of filtering by
1652  *      multicast address.
1653  *
1654  * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1655  *      %RX_FLAG_FAILED_FCS_CRC for them)
1656  *
1657  * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1658  *      the %RX_FLAG_FAILED_PLCP_CRC for them
1659  *
1660  * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1661  *      to the hardware that it should not filter beacons or probe responses
1662  *      by BSSID. Filtering them can greatly reduce the amount of processing
1663  *      mac80211 needs to do and the amount of CPU wakeups, so you should
1664  *      honour this flag if possible.
1665  *
1666  * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1667  *      is not set then only those addressed to this station.
1668  *
1669  * @FIF_OTHER_BSS: pass frames destined to other BSSes
1670  *
1671  * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1672  *      those addressed to this station.
1673  *
1674  * @FIF_PROBE_REQ: pass probe request frames
1675  */
1676 enum ieee80211_filter_flags {
1677         FIF_PROMISC_IN_BSS      = 1<<0,
1678         FIF_ALLMULTI            = 1<<1,
1679         FIF_FCSFAIL             = 1<<2,
1680         FIF_PLCPFAIL            = 1<<3,
1681         FIF_BCN_PRBRESP_PROMISC = 1<<4,
1682         FIF_CONTROL             = 1<<5,
1683         FIF_OTHER_BSS           = 1<<6,
1684         FIF_PSPOLL              = 1<<7,
1685         FIF_PROBE_REQ           = 1<<8,
1686 };
1687
1688 /**
1689  * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1690  *
1691  * These flags are used with the ampdu_action() callback in
1692  * &struct ieee80211_ops to indicate which action is needed.
1693  *
1694  * Note that drivers MUST be able to deal with a TX aggregation
1695  * session being stopped even before they OK'ed starting it by
1696  * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1697  * might receive the addBA frame and send a delBA right away!
1698  *
1699  * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1700  * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1701  * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1702  * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1703  * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1704  */
1705 enum ieee80211_ampdu_mlme_action {
1706         IEEE80211_AMPDU_RX_START,
1707         IEEE80211_AMPDU_RX_STOP,
1708         IEEE80211_AMPDU_TX_START,
1709         IEEE80211_AMPDU_TX_STOP,
1710         IEEE80211_AMPDU_TX_OPERATIONAL,
1711 };
1712
1713 /**
1714  * enum ieee80211_tx_sync_type - TX sync type
1715  * @IEEE80211_TX_SYNC_AUTH: sync TX for authentication
1716  *      (and possibly also before direct probe)
1717  * @IEEE80211_TX_SYNC_ASSOC: sync TX for association
1718  * @IEEE80211_TX_SYNC_ACTION: sync TX for action frame
1719  *      (not implemented yet)
1720  */
1721 enum ieee80211_tx_sync_type {
1722         IEEE80211_TX_SYNC_AUTH,
1723         IEEE80211_TX_SYNC_ASSOC,
1724         IEEE80211_TX_SYNC_ACTION,
1725 };
1726
1727 /**
1728  * enum ieee80211_frame_release_type - frame release reason
1729  * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
1730  * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
1731  *      frame received on trigger-enabled AC
1732  */
1733 enum ieee80211_frame_release_type {
1734         IEEE80211_FRAME_RELEASE_PSPOLL,
1735         IEEE80211_FRAME_RELEASE_UAPSD,
1736 };
1737
1738 /**
1739  * struct ieee80211_ops - callbacks from mac80211 to the driver
1740  *
1741  * This structure contains various callbacks that the driver may
1742  * handle or, in some cases, must handle, for example to configure
1743  * the hardware to a new channel or to transmit a frame.
1744  *
1745  * @tx: Handler that 802.11 module calls for each transmitted frame.
1746  *      skb contains the buffer starting from the IEEE 802.11 header.
1747  *      The low-level driver should send the frame out based on
1748  *      configuration in the TX control data. This handler should,
1749  *      preferably, never fail and stop queues appropriately, more
1750  *      importantly, however, it must never fail for A-MPDU-queues.
1751  *      This function should return NETDEV_TX_OK except in very
1752  *      limited cases.
1753  *      Must be implemented and atomic.
1754  *
1755  * @start: Called before the first netdevice attached to the hardware
1756  *      is enabled. This should turn on the hardware and must turn on
1757  *      frame reception (for possibly enabled monitor interfaces.)
1758  *      Returns negative error codes, these may be seen in userspace,
1759  *      or zero.
1760  *      When the device is started it should not have a MAC address
1761  *      to avoid acknowledging frames before a non-monitor device
1762  *      is added.
1763  *      Must be implemented and can sleep.
1764  *
1765  * @stop: Called after last netdevice attached to the hardware
1766  *      is disabled. This should turn off the hardware (at least
1767  *      it must turn off frame reception.)
1768  *      May be called right after add_interface if that rejects
1769  *      an interface. If you added any work onto the mac80211 workqueue
1770  *      you should ensure to cancel it on this callback.
1771  *      Must be implemented and can sleep.
1772  *
1773  * @suspend: Suspend the device; mac80211 itself will quiesce before and
1774  *      stop transmitting and doing any other configuration, and then
1775  *      ask the device to suspend. This is only invoked when WoWLAN is
1776  *      configured, otherwise the device is deconfigured completely and
1777  *      reconfigured at resume time.
1778  *      The driver may also impose special conditions under which it
1779  *      wants to use the "normal" suspend (deconfigure), say if it only
1780  *      supports WoWLAN when the device is associated. In this case, it
1781  *      must return 1 from this function.
1782  *
1783  * @resume: If WoWLAN was configured, this indicates that mac80211 is
1784  *      now resuming its operation, after this the device must be fully
1785  *      functional again. If this returns an error, the only way out is
1786  *      to also unregister the device. If it returns 1, then mac80211
1787  *      will also go through the regular complete restart on resume.
1788  *
1789  * @add_interface: Called when a netdevice attached to the hardware is
1790  *      enabled. Because it is not called for monitor mode devices, @start
1791  *      and @stop must be implemented.
1792  *      The driver should perform any initialization it needs before
1793  *      the device can be enabled. The initial configuration for the
1794  *      interface is given in the conf parameter.
1795  *      The callback may refuse to add an interface by returning a
1796  *      negative error code (which will be seen in userspace.)
1797  *      Must be implemented and can sleep.
1798  *
1799  * @change_interface: Called when a netdevice changes type. This callback
1800  *      is optional, but only if it is supported can interface types be
1801  *      switched while the interface is UP. The callback may sleep.
1802  *      Note that while an interface is being switched, it will not be
1803  *      found by the interface iteration callbacks.
1804  *
1805  * @remove_interface: Notifies a driver that an interface is going down.
1806  *      The @stop callback is called after this if it is the last interface
1807  *      and no monitor interfaces are present.
1808  *      When all interfaces are removed, the MAC address in the hardware
1809  *      must be cleared so the device no longer acknowledges packets,
1810  *      the mac_addr member of the conf structure is, however, set to the
1811  *      MAC address of the device going away.
1812  *      Hence, this callback must be implemented. It can sleep.
1813  *
1814  * @config: Handler for configuration requests. IEEE 802.11 code calls this
1815  *      function to change hardware configuration, e.g., channel.
1816  *      This function should never fail but returns a negative error code
1817  *      if it does. The callback can sleep.
1818  *
1819  * @bss_info_changed: Handler for configuration requests related to BSS
1820  *      parameters that may vary during BSS's lifespan, and may affect low
1821  *      level driver (e.g. assoc/disassoc status, erp parameters).
1822  *      This function should not be used if no BSS has been set, unless
1823  *      for association indication. The @changed parameter indicates which
1824  *      of the bss parameters has changed when a call is made. The callback
1825  *      can sleep.
1826  *
1827  * @tx_sync: Called before a frame is sent to an AP/GO. In the GO case, the
1828  *      driver should sync with the GO's powersaving so the device doesn't
1829  *      transmit the frame while the GO is asleep. In the regular AP case
1830  *      it may be used by drivers for devices implementing other restrictions
1831  *      on talking to APs, e.g. due to regulatory enforcement or just HW
1832  *      restrictions.
1833  *      This function is called for every authentication, association and
1834  *      action frame separately since applications might attempt to auth
1835  *      with multiple APs before chosing one to associate to. If it returns
1836  *      an error, the corresponding authentication, association or frame
1837  *      transmission is aborted and reported as having failed. It is always
1838  *      called after tuning to the correct channel.
1839  *      The callback might be called multiple times before @finish_tx_sync
1840  *      (but @finish_tx_sync will be called once for each) but in practice
1841  *      this is unlikely to happen. It can also refuse in that case if the
1842  *      driver cannot handle that situation.
1843  *      This callback can sleep.
1844  * @finish_tx_sync: Called as a counterpart to @tx_sync, unless that returned
1845  *      an error. This callback can sleep.
1846  *
1847  * @prepare_multicast: Prepare for multicast filter configuration.
1848  *      This callback is optional, and its return value is passed
1849  *      to configure_filter(). This callback must be atomic.
1850  *
1851  * @configure_filter: Configure the device's RX filter.
1852  *      See the section "Frame filtering" for more information.
1853  *      This callback must be implemented and can sleep.
1854  *
1855  * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1856  *      must be set or cleared for a given STA. Must be atomic.
1857  *
1858  * @set_key: See the section "Hardware crypto acceleration"
1859  *      This callback is only called between add_interface and
1860  *      remove_interface calls, i.e. while the given virtual interface
1861  *      is enabled.
1862  *      Returns a negative error code if the key can't be added.
1863  *      The callback can sleep.
1864  *
1865  * @update_tkip_key: See the section "Hardware crypto acceleration"
1866  *      This callback will be called in the context of Rx. Called for drivers
1867  *      which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1868  *      The callback must be atomic.
1869  *
1870  * @set_rekey_data: If the device supports GTK rekeying, for example while the
1871  *      host is suspended, it can assign this callback to retrieve the data
1872  *      necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
1873  *      After rekeying was done it should (for example during resume) notify
1874  *      userspace of the new replay counter using ieee80211_gtk_rekey_notify().
1875  *
1876  * @hw_scan: Ask the hardware to service the scan request, no need to start
1877  *      the scan state machine in stack. The scan must honour the channel
1878  *      configuration done by the regulatory agent in the wiphy's
1879  *      registered bands. The hardware (or the driver) needs to make sure
1880  *      that power save is disabled.
1881  *      The @req ie/ie_len members are rewritten by mac80211 to contain the
1882  *      entire IEs after the SSID, so that drivers need not look at these
1883  *      at all but just send them after the SSID -- mac80211 includes the
1884  *      (extended) supported rates and HT information (where applicable).
1885  *      When the scan finishes, ieee80211_scan_completed() must be called;
1886  *      note that it also must be called when the scan cannot finish due to
1887  *      any error unless this callback returned a negative error code.
1888  *      The callback can sleep.
1889  *
1890  * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
1891  *      The driver should ask the hardware to cancel the scan (if possible),
1892  *      but the scan will be completed only after the driver will call
1893  *      ieee80211_scan_completed().
1894  *      This callback is needed for wowlan, to prevent enqueueing a new
1895  *      scan_work after the low-level driver was already suspended.
1896  *      The callback can sleep.
1897  *
1898  * @sched_scan_start: Ask the hardware to start scanning repeatedly at
1899  *      specific intervals.  The driver must call the
1900  *      ieee80211_sched_scan_results() function whenever it finds results.
1901  *      This process will continue until sched_scan_stop is called.
1902  *
1903  * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
1904  *
1905  * @sw_scan_start: Notifier function that is called just before a software scan
1906  *      is started. Can be NULL, if the driver doesn't need this notification.
1907  *      The callback can sleep.
1908  *
1909  * @sw_scan_complete: Notifier function that is called just after a
1910  *      software scan finished. Can be NULL, if the driver doesn't need
1911  *      this notification.
1912  *      The callback can sleep.
1913  *
1914  * @get_stats: Return low-level statistics.
1915  *      Returns zero if statistics are available.
1916  *      The callback can sleep.
1917  *
1918  * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1919  *      callback should be provided to read the TKIP transmit IVs (both IV32
1920  *      and IV16) for the given key from hardware.
1921  *      The callback must be atomic.
1922  *
1923  * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1924  *      if the device does fragmentation by itself; if this callback is
1925  *      implemented then the stack will not do fragmentation.
1926  *      The callback can sleep.
1927  *
1928  * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1929  *      The callback can sleep.
1930  *
1931  * @sta_add: Notifies low level driver about addition of an associated station,
1932  *      AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1933  *
1934  * @sta_remove: Notifies low level driver about removal of an associated
1935  *      station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1936  *
1937  * @sta_notify: Notifies low level driver about power state transition of an
1938  *      associated station, AP,  IBSS/WDS/mesh peer etc. For a VIF operating
1939  *      in AP mode, this callback will not be called when the flag
1940  *      %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
1941  *
1942  * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1943  *      bursting) for a hardware TX queue.
1944  *      Returns a negative error code on failure.
1945  *      The callback can sleep.
1946  *
1947  * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1948  *      this is only used for IBSS mode BSSID merging and debugging. Is not a
1949  *      required function.
1950  *      The callback can sleep.
1951  *
1952  * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1953  *      Currently, this is only used for IBSS mode debugging. Is not a
1954  *      required function.
1955  *      The callback can sleep.
1956  *
1957  * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1958  *      with other STAs in the IBSS. This is only used in IBSS mode. This
1959  *      function is optional if the firmware/hardware takes full care of
1960  *      TSF synchronization.
1961  *      The callback can sleep.
1962  *
1963  * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1964  *      This is needed only for IBSS mode and the result of this function is
1965  *      used to determine whether to reply to Probe Requests.
1966  *      Returns non-zero if this device sent the last beacon.
1967  *      The callback can sleep.
1968  *
1969  * @ampdu_action: Perform a certain A-MPDU action
1970  *      The RA/TID combination determines the destination and TID we want
1971  *      the ampdu action to be performed for. The action is defined through
1972  *      ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1973  *      is the first frame we expect to perform the action on. Notice
1974  *      that TX/RX_STOP can pass NULL for this parameter.
1975  *      The @buf_size parameter is only valid when the action is set to
1976  *      %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder
1977  *      buffer size (number of subframes) for this session -- the driver
1978  *      may neither send aggregates containing more subframes than this
1979  *      nor send aggregates in a way that lost frames would exceed the
1980  *      buffer size. If just limiting the aggregate size, this would be
1981  *      possible with a buf_size of 8:
1982  *       - TX: 1.....7
1983  *       - RX:  2....7 (lost frame #1)
1984  *       - TX:        8..1...
1985  *      which is invalid since #1 was now re-transmitted well past the
1986  *      buffer size of 8. Correct ways to retransmit #1 would be:
1987  *       - TX:       1 or 18 or 81
1988  *      Even "189" would be wrong since 1 could be lost again.
1989  *
1990  *      Returns a negative error code on failure.
1991  *      The callback can sleep.
1992  *
1993  * @get_survey: Return per-channel survey information
1994  *
1995  * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1996  *      need to set wiphy->rfkill_poll to %true before registration,
1997  *      and need to call wiphy_rfkill_set_hw_state() in the callback.
1998  *      The callback can sleep.
1999  *
2000  * @set_coverage_class: Set slot time for given coverage class as specified
2001  *      in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
2002  *      accordingly. This callback is not required and may sleep.
2003  *
2004  * @testmode_cmd: Implement a cfg80211 test mode command.
2005  *      The callback can sleep.
2006  * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
2007  *
2008  * @flush: Flush all pending frames from the hardware queue, making sure
2009  *      that the hardware queues are empty. If the parameter @drop is set
2010  *      to %true, pending frames may be dropped. The callback can sleep.
2011  *
2012  * @channel_switch: Drivers that need (or want) to offload the channel
2013  *      switch operation for CSAs received from the AP may implement this
2014  *      callback. They must then call ieee80211_chswitch_done() to indicate
2015  *      completion of the channel switch.
2016  *
2017  * @napi_poll: Poll Rx queue for incoming data frames.
2018  *
2019  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2020  *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2021  *      reject TX/RX mask combinations they cannot support by returning -EINVAL
2022  *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2023  *
2024  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
2025  *
2026  * @remain_on_channel: Starts an off-channel period on the given channel, must
2027  *      call back to ieee80211_ready_on_channel() when on that channel. Note
2028  *      that normal channel traffic is not stopped as this is intended for hw
2029  *      offload. Frames to transmit on the off-channel channel are transmitted
2030  *      normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
2031  *      duration (which will always be non-zero) expires, the driver must call
2032  *      ieee80211_remain_on_channel_expired(). This callback may sleep.
2033  * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
2034  *      aborted before it expires. This callback may sleep.
2035  *
2036  * @set_ringparam: Set tx and rx ring sizes.
2037  *
2038  * @get_ringparam: Get tx and rx ring current and maximum sizes.
2039  *
2040  * @tx_frames_pending: Check if there is any pending frame in the hardware
2041  *      queues before entering power save.
2042  *
2043  * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
2044  *      when transmitting a frame. Currently only legacy rates are handled.
2045  *      The callback can sleep.
2046  * @rssi_callback: Notify driver when the average RSSI goes above/below
2047  *      thresholds that were registered previously. The callback can sleep.
2048  *
2049  * @release_buffered_frames: Release buffered frames according to the given
2050  *      parameters. In the case where the driver buffers some frames for
2051  *      sleeping stations mac80211 will use this callback to tell the driver
2052  *      to release some frames, either for PS-poll or uAPSD.
2053  *      Note that if the @more_data paramter is %false the driver must check
2054  *      if there are more frames on the given TIDs, and if there are more than
2055  *      the frames being released then it must still set the more-data bit in
2056  *      the frame. If the @more_data parameter is %true, then of course the
2057  *      more-data bit must always be set.
2058  *      The @tids parameter tells the driver which TIDs to release frames
2059  *      from, for PS-poll it will always have only a single bit set.
2060  *      In the case this is used for a PS-poll initiated release, the
2061  *      @num_frames parameter will always be 1 so code can be shared. In
2062  *      this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
2063  *      on the TX status (and must report TX status) so that the PS-poll
2064  *      period is properly ended. This is used to avoid sending multiple
2065  *      responses for a retried PS-poll frame.
2066  *      In the case this is used for uAPSD, the @num_frames parameter may be
2067  *      bigger than one, but the driver may send fewer frames (it must send
2068  *      at least one, however). In this case it is also responsible for
2069  *      setting the EOSP flag in the QoS header of the frames. Also, when the
2070  *      service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
2071  *      on the last frame in the SP. Alternatively, it may call the function
2072  *      ieee80211_sta_eosp_irqsafe() to inform mac80211 of the end of the SP.
2073  *      This callback must be atomic.
2074  * @allow_buffered_frames: Prepare device to allow the given number of frames
2075  *      to go out to the given station. The frames will be sent by mac80211
2076  *      via the usual TX path after this call. The TX information for frames
2077  *      released will also have the %IEEE80211_TX_CTL_POLL_RESPONSE flag set
2078  *      and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
2079  *      frames from multiple TIDs are released and the driver might reorder
2080  *      them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
2081  *      on the last frame and clear it on all others and also handle the EOSP
2082  *      bit in the QoS header correctly. Alternatively, it can also call the
2083  *      ieee80211_sta_eosp_irqsafe() function.
2084  *      The @tids parameter is a bitmap and tells the driver which TIDs the
2085  *      frames will be on; it will at most have two bits set.
2086  *      This callback must be atomic.
2087  */
2088 struct ieee80211_ops {
2089         void (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
2090         int (*start)(struct ieee80211_hw *hw);
2091         void (*stop)(struct ieee80211_hw *hw);
2092 #ifdef CONFIG_PM
2093         int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
2094         int (*resume)(struct ieee80211_hw *hw);
2095 #endif
2096         int (*add_interface)(struct ieee80211_hw *hw,
2097                              struct ieee80211_vif *vif);
2098         int (*change_interface)(struct ieee80211_hw *hw,
2099                                 struct ieee80211_vif *vif,
2100                                 enum nl80211_iftype new_type, bool p2p);
2101         void (*remove_interface)(struct ieee80211_hw *hw,
2102                                  struct ieee80211_vif *vif);
2103         int (*config)(struct ieee80211_hw *hw, u32 changed);
2104         void (*bss_info_changed)(struct ieee80211_hw *hw,
2105                                  struct ieee80211_vif *vif,
2106                                  struct ieee80211_bss_conf *info,
2107                                  u32 changed);
2108
2109         int (*tx_sync)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2110                        const u8 *bssid, enum ieee80211_tx_sync_type type);
2111         void (*finish_tx_sync)(struct ieee80211_hw *hw,
2112                                struct ieee80211_vif *vif,
2113                                const u8 *bssid,
2114                                enum ieee80211_tx_sync_type type);
2115
2116         u64 (*prepare_multicast)(struct ieee80211_hw *hw,
2117                                  struct netdev_hw_addr_list *mc_list);
2118         void (*configure_filter)(struct ieee80211_hw *hw,
2119                                  unsigned int changed_flags,
2120                                  unsigned int *total_flags,
2121                                  u64 multicast);
2122         int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
2123                        bool set);
2124         int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
2125                        struct ieee80211_vif *vif, struct ieee80211_sta *sta,
2126                        struct ieee80211_key_conf *key);
2127         void (*update_tkip_key)(struct ieee80211_hw *hw,
2128                                 struct ieee80211_vif *vif,
2129                                 struct ieee80211_key_conf *conf,
2130                                 struct ieee80211_sta *sta,
2131                                 u32 iv32, u16 *phase1key);
2132         void (*set_rekey_data)(struct ieee80211_hw *hw,
2133                                struct ieee80211_vif *vif,
2134                                struct cfg80211_gtk_rekey_data *data);
2135         int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2136                        struct cfg80211_scan_request *req);
2137         void (*cancel_hw_scan)(struct ieee80211_hw *hw,
2138                                struct ieee80211_vif *vif);
2139         int (*sched_scan_start)(struct ieee80211_hw *hw,
2140                                 struct ieee80211_vif *vif,
2141                                 struct cfg80211_sched_scan_request *req,
2142                                 struct ieee80211_sched_scan_ies *ies);
2143         void (*sched_scan_stop)(struct ieee80211_hw *hw,
2144                                struct ieee80211_vif *vif);
2145         void (*sw_scan_start)(struct ieee80211_hw *hw);
2146         void (*sw_scan_complete)(struct ieee80211_hw *hw);
2147         int (*get_stats)(struct ieee80211_hw *hw,
2148                          struct ieee80211_low_level_stats *stats);
2149         void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
2150                              u32 *iv32, u16 *iv16);
2151         int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
2152         int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
2153         int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2154                        struct ieee80211_sta *sta);
2155         int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2156                           struct ieee80211_sta *sta);
2157         void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2158                         enum sta_notify_cmd, struct ieee80211_sta *sta);
2159         int (*conf_tx)(struct ieee80211_hw *hw,
2160                        struct ieee80211_vif *vif, u16 queue,
2161                        const struct ieee80211_tx_queue_params *params);
2162         u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2163         void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2164                         u64 tsf);
2165         void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2166         int (*tx_last_beacon)(struct ieee80211_hw *hw);
2167         int (*ampdu_action)(struct ieee80211_hw *hw,
2168                             struct ieee80211_vif *vif,
2169                             enum ieee80211_ampdu_mlme_action action,
2170                             struct ieee80211_sta *sta, u16 tid, u16 *ssn,
2171                             u8 buf_size);
2172         int (*get_survey)(struct ieee80211_hw *hw, int idx,
2173                 struct survey_info *survey);
2174         void (*rfkill_poll)(struct ieee80211_hw *hw);
2175         void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
2176 #ifdef CONFIG_NL80211_TESTMODE
2177         int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
2178         int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
2179                              struct netlink_callback *cb,
2180                              void *data, int len);
2181 #endif
2182         void (*flush)(struct ieee80211_hw *hw, bool drop);
2183         void (*channel_switch)(struct ieee80211_hw *hw,
2184                                struct ieee80211_channel_switch *ch_switch);
2185         int (*napi_poll)(struct ieee80211_hw *hw, int budget);
2186         int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
2187         int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
2188
2189         int (*remain_on_channel)(struct ieee80211_hw *hw,
2190                                  struct ieee80211_channel *chan,
2191                                  enum nl80211_channel_type channel_type,
2192                                  int duration);
2193         int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
2194         int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
2195         void (*get_ringparam)(struct ieee80211_hw *hw,
2196                               u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
2197         bool (*tx_frames_pending)(struct ieee80211_hw *hw);
2198         int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2199                                 const struct cfg80211_bitrate_mask *mask);
2200         void (*rssi_callback)(struct ieee80211_hw *hw,
2201                               enum ieee80211_rssi_event rssi_event);
2202
2203         void (*allow_buffered_frames)(struct ieee80211_hw *hw,
2204                                       struct ieee80211_sta *sta,
2205                                       u16 tids, int num_frames,
2206                                       enum ieee80211_frame_release_type reason,
2207                                       bool more_data);
2208         void (*release_buffered_frames)(struct ieee80211_hw *hw,
2209                                         struct ieee80211_sta *sta,
2210                                         u16 tids, int num_frames,
2211                                         enum ieee80211_frame_release_type reason,
2212                                         bool more_data);
2213 };
2214
2215 /**
2216  * ieee80211_alloc_hw -  Allocate a new hardware device
2217  *
2218  * This must be called once for each hardware device. The returned pointer
2219  * must be used to refer to this device when calling other functions.
2220  * mac80211 allocates a private data area for the driver pointed to by
2221  * @priv in &struct ieee80211_hw, the size of this area is given as
2222  * @priv_data_len.
2223  *
2224  * @priv_data_len: length of private data
2225  * @ops: callbacks for this device
2226  */
2227 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
2228                                         const struct ieee80211_ops *ops);
2229
2230 /**
2231  * ieee80211_register_hw - Register hardware device
2232  *
2233  * You must call this function before any other functions in
2234  * mac80211. Note that before a hardware can be registered, you
2235  * need to fill the contained wiphy's information.
2236  *
2237  * @hw: the device to register as returned by ieee80211_alloc_hw()
2238  */
2239 int ieee80211_register_hw(struct ieee80211_hw *hw);
2240
2241 /**
2242  * struct ieee80211_tpt_blink - throughput blink description
2243  * @throughput: throughput in Kbit/sec
2244  * @blink_time: blink time in milliseconds
2245  *      (full cycle, ie. one off + one on period)
2246  */
2247 struct ieee80211_tpt_blink {
2248         int throughput;
2249         int blink_time;
2250 };
2251
2252 /**
2253  * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
2254  * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
2255  * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
2256  * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
2257  *      interface is connected in some way, including being an AP
2258  */
2259 enum ieee80211_tpt_led_trigger_flags {
2260         IEEE80211_TPT_LEDTRIG_FL_RADIO          = BIT(0),
2261         IEEE80211_TPT_LEDTRIG_FL_WORK           = BIT(1),
2262         IEEE80211_TPT_LEDTRIG_FL_CONNECTED      = BIT(2),
2263 };
2264
2265 #ifdef CONFIG_MAC80211_LEDS
2266 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
2267 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
2268 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
2269 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
2270 extern char *__ieee80211_create_tpt_led_trigger(
2271                                 struct ieee80211_hw *hw, unsigned int flags,
2272                                 const struct ieee80211_tpt_blink *blink_table,
2273                                 unsigned int blink_table_len);
2274 #endif
2275 /**
2276  * ieee80211_get_tx_led_name - get name of TX LED
2277  *
2278  * mac80211 creates a transmit LED trigger for each wireless hardware
2279  * that can be used to drive LEDs if your driver registers a LED device.
2280  * This function returns the name (or %NULL if not configured for LEDs)
2281  * of the trigger so you can automatically link the LED device.
2282  *
2283  * @hw: the hardware to get the LED trigger name for
2284  */
2285 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
2286 {
2287 #ifdef CONFIG_MAC80211_LEDS
2288         return __ieee80211_get_tx_led_name(hw);
2289 #else
2290         return NULL;
2291 #endif
2292 }
2293
2294 /**
2295  * ieee80211_get_rx_led_name - get name of RX LED
2296  *
2297  * mac80211 creates a receive LED trigger for each wireless hardware
2298  * that can be used to drive LEDs if your driver registers a LED device.
2299  * This function returns the name (or %NULL if not configured for LEDs)
2300  * of the trigger so you can automatically link the LED device.
2301  *
2302  * @hw: the hardware to get the LED trigger name for
2303  */
2304 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
2305 {
2306 #ifdef CONFIG_MAC80211_LEDS
2307         return __ieee80211_get_rx_led_name(hw);
2308 #else
2309         return NULL;
2310 #endif
2311 }
2312
2313 /**
2314  * ieee80211_get_assoc_led_name - get name of association LED
2315  *
2316  * mac80211 creates a association LED trigger for each wireless hardware
2317  * that can be used to drive LEDs if your driver registers a LED device.
2318  * This function returns the name (or %NULL if not configured for LEDs)
2319  * of the trigger so you can automatically link the LED device.
2320  *
2321  * @hw: the hardware to get the LED trigger name for
2322  */
2323 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
2324 {
2325 #ifdef CONFIG_MAC80211_LEDS
2326         return __ieee80211_get_assoc_led_name(hw);
2327 #else
2328         return NULL;
2329 #endif
2330 }
2331
2332 /**
2333  * ieee80211_get_radio_led_name - get name of radio LED
2334  *
2335  * mac80211 creates a radio change LED trigger for each wireless hardware
2336  * that can be used to drive LEDs if your driver registers a LED device.
2337  * This function returns the name (or %NULL if not configured for LEDs)
2338  * of the trigger so you can automatically link the LED device.
2339  *
2340  * @hw: the hardware to get the LED trigger name for
2341  */
2342 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
2343 {
2344 #ifdef CONFIG_MAC80211_LEDS
2345         return __ieee80211_get_radio_led_name(hw);
2346 #else
2347         return NULL;
2348 #endif
2349 }
2350
2351 /**
2352  * ieee80211_create_tpt_led_trigger - create throughput LED trigger
2353  * @hw: the hardware to create the trigger for
2354  * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
2355  * @blink_table: the blink table -- needs to be ordered by throughput
2356  * @blink_table_len: size of the blink table
2357  *
2358  * This function returns %NULL (in case of error, or if no LED
2359  * triggers are configured) or the name of the new trigger.
2360  * This function must be called before ieee80211_register_hw().
2361  */
2362 static inline char *
2363 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
2364                                  const struct ieee80211_tpt_blink *blink_table,
2365                                  unsigned int blink_table_len)
2366 {
2367 #ifdef CONFIG_MAC80211_LEDS
2368         return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
2369                                                   blink_table_len);
2370 #else
2371         return NULL;
2372 #endif
2373 }
2374
2375 /**
2376  * ieee80211_unregister_hw - Unregister a hardware device
2377  *
2378  * This function instructs mac80211 to free allocated resources
2379  * and unregister netdevices from the networking subsystem.
2380  *
2381  * @hw: the hardware to unregister
2382  */
2383 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2384
2385 /**
2386  * ieee80211_free_hw - free hardware descriptor
2387  *
2388  * This function frees everything that was allocated, including the
2389  * private data for the driver. You must call ieee80211_unregister_hw()
2390  * before calling this function.
2391  *
2392  * @hw: the hardware to free
2393  */
2394 void ieee80211_free_hw(struct ieee80211_hw *hw);
2395
2396 /**
2397  * ieee80211_restart_hw - restart hardware completely
2398  *
2399  * Call this function when the hardware was restarted for some reason
2400  * (hardware error, ...) and the driver is unable to restore its state
2401  * by itself. mac80211 assumes that at this point the driver/hardware
2402  * is completely uninitialised and stopped, it starts the process by
2403  * calling the ->start() operation. The driver will need to reset all
2404  * internal state that it has prior to calling this function.
2405  *
2406  * @hw: the hardware to restart
2407  */
2408 void ieee80211_restart_hw(struct ieee80211_hw *hw);
2409
2410 /** ieee80211_napi_schedule - schedule NAPI poll
2411  *
2412  * Use this function to schedule NAPI polling on a device.
2413  *
2414  * @hw: the hardware to start polling
2415  */
2416 void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2417
2418 /** ieee80211_napi_complete - complete NAPI polling
2419  *
2420  * Use this function to finish NAPI polling on a device.
2421  *
2422  * @hw: the hardware to stop polling
2423  */
2424 void ieee80211_napi_complete(struct ieee80211_hw *hw);
2425
2426 /**
2427  * ieee80211_rx - receive frame
2428  *
2429  * Use this function to hand received frames to mac80211. The receive
2430  * buffer in @skb must start with an IEEE 802.11 header. In case of a
2431  * paged @skb is used, the driver is recommended to put the ieee80211
2432  * header of the frame on the linear part of the @skb to avoid memory
2433  * allocation and/or memcpy by the stack.
2434  *
2435  * This function may not be called in IRQ context. Calls to this function
2436  * for a single hardware must be synchronized against each other. Calls to
2437  * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2438  * mixed for a single hardware.
2439  *
2440  * In process context use instead ieee80211_rx_ni().
2441  *
2442  * @hw: the hardware this frame came in on
2443  * @skb: the buffer to receive, owned by mac80211 after this call
2444  */
2445 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
2446
2447 /**
2448  * ieee80211_rx_irqsafe - receive frame
2449  *
2450  * Like ieee80211_rx() but can be called in IRQ context
2451  * (internally defers to a tasklet.)
2452  *
2453  * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2454  * be mixed for a single hardware.
2455  *
2456  * @hw: the hardware this frame came in on
2457  * @skb: the buffer to receive, owned by mac80211 after this call
2458  */
2459 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
2460
2461 /**
2462  * ieee80211_rx_ni - receive frame (in process context)
2463  *
2464  * Like ieee80211_rx() but can be called in process context
2465  * (internally disables bottom halves).
2466  *
2467  * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2468  * not be mixed for a single hardware.
2469  *
2470  * @hw: the hardware this frame came in on
2471  * @skb: the buffer to receive, owned by mac80211 after this call
2472  */
2473 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2474                                    struct sk_buff *skb)
2475 {
2476         local_bh_disable();
2477         ieee80211_rx(hw, skb);
2478         local_bh_enable();
2479 }
2480
2481 /**
2482  * ieee80211_sta_ps_transition - PS transition for connected sta
2483  *
2484  * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
2485  * flag set, use this function to inform mac80211 about a connected station
2486  * entering/leaving PS mode.
2487  *
2488  * This function may not be called in IRQ context or with softirqs enabled.
2489  *
2490  * Calls to this function for a single hardware must be synchronized against
2491  * each other.
2492  *
2493  * The function returns -EINVAL when the requested PS mode is already set.
2494  *
2495  * @sta: currently connected sta
2496  * @start: start or stop PS
2497  */
2498 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
2499
2500 /**
2501  * ieee80211_sta_ps_transition_ni - PS transition for connected sta
2502  *                                  (in process context)
2503  *
2504  * Like ieee80211_sta_ps_transition() but can be called in process context
2505  * (internally disables bottom halves). Concurrent call restriction still
2506  * applies.
2507  *
2508  * @sta: currently connected sta
2509  * @start: start or stop PS
2510  */
2511 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
2512                                                   bool start)
2513 {
2514         int ret;
2515
2516         local_bh_disable();
2517         ret = ieee80211_sta_ps_transition(sta, start);
2518         local_bh_enable();
2519
2520         return ret;
2521 }
2522
2523 /*
2524  * The TX headroom reserved by mac80211 for its own tx_status functions.
2525  * This is enough for the radiotap header.
2526  */
2527 #define IEEE80211_TX_STATUS_HEADROOM    13
2528
2529 /**
2530  * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
2531  * @sta: &struct ieee80211_sta pointer for the sleeping station
2532  * @tid: the TID that has buffered frames
2533  * @buffered: indicates whether or not frames are buffered for this TID
2534  *
2535  * If a driver buffers frames for a powersave station instead of passing
2536  * them back to mac80211 for retransmission, the station may still need
2537  * to be told that there are buffered frames via the TIM bit.
2538  *
2539  * This function informs mac80211 whether or not there are frames that are
2540  * buffered in the driver for a given TID; mac80211 can then use this data
2541  * to set the TIM bit (NOTE: This may call back into the driver's set_tim
2542  * call! Beware of the locking!)
2543  *
2544  * If all frames are released to the station (due to PS-poll or uAPSD)
2545  * then the driver needs to inform mac80211 that there no longer are
2546  * frames buffered. However, when the station wakes up mac80211 assumes
2547  * that all buffered frames will be transmitted and clears this data,
2548  * drivers need to make sure they inform mac80211 about all buffered
2549  * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
2550  *
2551  * Note that technically mac80211 only needs to know this per AC, not per
2552  * TID, but since driver buffering will inevitably happen per TID (since
2553  * it is related to aggregation) it is easier to make mac80211 map the
2554  * TID to the AC as required instead of keeping track in all drivers that
2555  * use this API.
2556  */
2557 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
2558                                 u8 tid, bool buffered);
2559
2560 /**
2561  * ieee80211_tx_status - transmit status callback
2562  *
2563  * Call this function for all transmitted frames after they have been
2564  * transmitted. It is permissible to not call this function for
2565  * multicast frames but this can affect statistics.
2566  *
2567  * This function may not be called in IRQ context. Calls to this function
2568  * for a single hardware must be synchronized against each other. Calls
2569  * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2570  * may not be mixed for a single hardware.
2571  *
2572  * @hw: the hardware the frame was transmitted by
2573  * @skb: the frame that was transmitted, owned by mac80211 after this call
2574  */
2575 void ieee80211_tx_status(struct ieee80211_hw *hw,
2576                          struct sk_buff *skb);
2577
2578 /**
2579  * ieee80211_tx_status_ni - transmit status callback (in process context)
2580  *
2581  * Like ieee80211_tx_status() but can be called in process context.
2582  *
2583  * Calls to this function, ieee80211_tx_status() and
2584  * ieee80211_tx_status_irqsafe() may not be mixed
2585  * for a single hardware.
2586  *
2587  * @hw: the hardware the frame was transmitted by
2588  * @skb: the frame that was transmitted, owned by mac80211 after this call
2589  */
2590 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2591                                           struct sk_buff *skb)
2592 {
2593         local_bh_disable();
2594         ieee80211_tx_status(hw, skb);
2595         local_bh_enable();
2596 }
2597
2598 /**
2599  * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2600  *
2601  * Like ieee80211_tx_status() but can be called in IRQ context
2602  * (internally defers to a tasklet.)
2603  *
2604  * Calls to this function, ieee80211_tx_status() and
2605  * ieee80211_tx_status_ni() may not be mixed for a single hardware.
2606  *
2607  * @hw: the hardware the frame was transmitted by
2608  * @skb: the frame that was transmitted, owned by mac80211 after this call
2609  */
2610 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
2611                                  struct sk_buff *skb);
2612
2613 /**
2614  * ieee80211_report_low_ack - report non-responding station
2615  *
2616  * When operating in AP-mode, call this function to report a non-responding
2617  * connected STA.
2618  *
2619  * @sta: the non-responding connected sta
2620  * @num_packets: number of packets sent to @sta without a response
2621  */
2622 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
2623
2624 /**
2625  * ieee80211_beacon_get_tim - beacon generation function
2626  * @hw: pointer obtained from ieee80211_alloc_hw().
2627  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2628  * @tim_offset: pointer to variable that will receive the TIM IE offset.
2629  *      Set to 0 if invalid (in non-AP modes).
2630  * @tim_length: pointer to variable that will receive the TIM IE length,
2631  *      (including the ID and length bytes!).
2632  *      Set to 0 if invalid (in non-AP modes).
2633  *
2634  * If the driver implements beaconing modes, it must use this function to
2635  * obtain the beacon frame/template.
2636  *
2637  * If the beacon frames are generated by the host system (i.e., not in
2638  * hardware/firmware), the driver uses this function to get each beacon
2639  * frame from mac80211 -- it is responsible for calling this function
2640  * before the beacon is needed (e.g. based on hardware interrupt).
2641  *
2642  * If the beacon frames are generated by the device, then the driver
2643  * must use the returned beacon as the template and change the TIM IE
2644  * according to the current DTIM parameters/TIM bitmap.
2645  *
2646  * The driver is responsible for freeing the returned skb.
2647  */
2648 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2649                                          struct ieee80211_vif *vif,
2650                                          u16 *tim_offset, u16 *tim_length);
2651
2652 /**
2653  * ieee80211_beacon_get - beacon generation function
2654  * @hw: pointer obtained from ieee80211_alloc_hw().
2655  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2656  *
2657  * See ieee80211_beacon_get_tim().
2658  */
2659 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2660                                                    struct ieee80211_vif *vif)
2661 {
2662         return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2663 }
2664
2665 /**
2666  * ieee80211_pspoll_get - retrieve a PS Poll template
2667  * @hw: pointer obtained from ieee80211_alloc_hw().
2668  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2669  *
2670  * Creates a PS Poll a template which can, for example, uploaded to
2671  * hardware. The template must be updated after association so that correct
2672  * AID, BSSID and MAC address is used.
2673  *
2674  * Note: Caller (or hardware) is responsible for setting the
2675  * &IEEE80211_FCTL_PM bit.
2676  */
2677 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2678                                      struct ieee80211_vif *vif);
2679
2680 /**
2681  * ieee80211_nullfunc_get - retrieve a nullfunc template
2682  * @hw: pointer obtained from ieee80211_alloc_hw().
2683  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2684  *
2685  * Creates a Nullfunc template which can, for example, uploaded to
2686  * hardware. The template must be updated after association so that correct
2687  * BSSID and address is used.
2688  *
2689  * Note: Caller (or hardware) is responsible for setting the
2690  * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2691  */
2692 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2693                                        struct ieee80211_vif *vif);
2694
2695 /**
2696  * ieee80211_probereq_get - retrieve a Probe Request template
2697  * @hw: pointer obtained from ieee80211_alloc_hw().
2698  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2699  * @ssid: SSID buffer
2700  * @ssid_len: length of SSID
2701  * @ie: buffer containing all IEs except SSID for the template
2702  * @ie_len: length of the IE buffer
2703  *
2704  * Creates a Probe Request template which can, for example, be uploaded to
2705  * hardware.
2706  */
2707 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2708                                        struct ieee80211_vif *vif,
2709                                        const u8 *ssid, size_t ssid_len,
2710                                        const u8 *ie, size_t ie_len);
2711
2712 /**
2713  * ieee80211_rts_get - RTS frame generation function
2714  * @hw: pointer obtained from ieee80211_alloc_hw().
2715  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2716  * @frame: pointer to the frame that is going to be protected by the RTS.
2717  * @frame_len: the frame length (in octets).
2718  * @frame_txctl: &struct ieee80211_tx_info of the frame.
2719  * @rts: The buffer where to store the RTS frame.
2720  *
2721  * If the RTS frames are generated by the host system (i.e., not in
2722  * hardware/firmware), the low-level driver uses this function to receive
2723  * the next RTS frame from the 802.11 code. The low-level is responsible
2724  * for calling this function before and RTS frame is needed.
2725  */
2726 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2727                        const void *frame, size_t frame_len,
2728                        const struct ieee80211_tx_info *frame_txctl,
2729                        struct ieee80211_rts *rts);
2730
2731 /**
2732  * ieee80211_rts_duration - Get the duration field for an RTS frame
2733  * @hw: pointer obtained from ieee80211_alloc_hw().
2734  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2735  * @frame_len: the length of the frame that is going to be protected by the RTS.
2736  * @frame_txctl: &struct ieee80211_tx_info of the frame.
2737  *
2738  * If the RTS is generated in firmware, but the host system must provide
2739  * the duration field, the low-level driver uses this function to receive
2740  * the duration field value in little-endian byteorder.
2741  */
2742 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2743                               struct ieee80211_vif *vif, size_t frame_len,
2744                               const struct ieee80211_tx_info *frame_txctl);
2745
2746 /**
2747  * ieee80211_ctstoself_get - CTS-to-self frame generation function
2748  * @hw: pointer obtained from ieee80211_alloc_hw().
2749  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2750  * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2751  * @frame_len: the frame length (in octets).
2752  * @frame_txctl: &struct ieee80211_tx_info of the frame.
2753  * @cts: The buffer where to store the CTS-to-self frame.
2754  *
2755  * If the CTS-to-self frames are generated by the host system (i.e., not in
2756  * hardware/firmware), the low-level driver uses this function to receive
2757  * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2758  * for calling this function before and CTS-to-self frame is needed.
2759  */
2760 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2761                              struct ieee80211_vif *vif,
2762                              const void *frame, size_t frame_len,
2763                              const struct ieee80211_tx_info *frame_txctl,
2764                              struct ieee80211_cts *cts);
2765
2766 /**
2767  * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2768  * @hw: pointer obtained from ieee80211_alloc_hw().
2769  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2770  * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2771  * @frame_txctl: &struct ieee80211_tx_info of the frame.
2772  *
2773  * If the CTS-to-self is generated in firmware, but the host system must provide
2774  * the duration field, the low-level driver uses this function to receive
2775  * the duration field value in little-endian byteorder.
2776  */
2777 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2778                                     struct ieee80211_vif *vif,
2779                                     size_t frame_len,
2780                                     const struct ieee80211_tx_info *frame_txctl);
2781
2782 /**
2783  * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2784  * @hw: pointer obtained from ieee80211_alloc_hw().
2785  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2786  * @frame_len: the length of the frame.
2787  * @rate: the rate at which the frame is going to be transmitted.
2788  *
2789  * Calculate the duration field of some generic frame, given its
2790  * length and transmission rate (in 100kbps).
2791  */
2792 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2793                                         struct ieee80211_vif *vif,
2794                                         size_t frame_len,
2795                                         struct ieee80211_rate *rate);
2796
2797 /**
2798  * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2799  * @hw: pointer as obtained from ieee80211_alloc_hw().
2800  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2801  *
2802  * Function for accessing buffered broadcast and multicast frames. If
2803  * hardware/firmware does not implement buffering of broadcast/multicast
2804  * frames when power saving is used, 802.11 code buffers them in the host
2805  * memory. The low-level driver uses this function to fetch next buffered
2806  * frame. In most cases, this is used when generating beacon frame. This
2807  * function returns a pointer to the next buffered skb or NULL if no more
2808  * buffered frames are available.
2809  *
2810  * Note: buffered frames are returned only after DTIM beacon frame was
2811  * generated with ieee80211_beacon_get() and the low-level driver must thus
2812  * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2813  * NULL if the previous generated beacon was not DTIM, so the low-level driver
2814  * does not need to check for DTIM beacons separately and should be able to
2815  * use common code for all beacons.
2816  */
2817 struct sk_buff *
2818 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2819
2820 /**
2821  * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
2822  *
2823  * This function returns the TKIP phase 1 key for the given IV32.
2824  *
2825  * @keyconf: the parameter passed with the set key
2826  * @iv32: IV32 to get the P1K for
2827  * @p1k: a buffer to which the key will be written, as 5 u16 values
2828  */
2829 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
2830                                u32 iv32, u16 *p1k);
2831
2832 /**
2833  * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
2834  *
2835  * This function returns the TKIP phase 1 key for the IV32 taken
2836  * from the given packet.
2837  *
2838  * @keyconf: the parameter passed with the set key
2839  * @skb: the packet to take the IV32 value from that will be encrypted
2840  *      with this P1K
2841  * @p1k: a buffer to which the key will be written, as 5 u16 values
2842  */
2843 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
2844                                           struct sk_buff *skb, u16 *p1k)
2845 {
2846         struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
2847         const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
2848         u32 iv32 = get_unaligned_le32(&data[4]);
2849
2850         ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
2851 }
2852
2853 /**
2854  * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
2855  *
2856  * This function returns the TKIP phase 1 key for the given IV32
2857  * and transmitter address.
2858  *
2859  * @keyconf: the parameter passed with the set key
2860  * @ta: TA that will be used with the key
2861  * @iv32: IV32 to get the P1K for
2862  * @p1k: a buffer to which the key will be written, as 5 u16 values
2863  */
2864 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
2865                                const u8 *ta, u32 iv32, u16 *p1k);
2866
2867 /**
2868  * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
2869  *
2870  * This function computes the TKIP RC4 key for the IV values
2871  * in the packet.
2872  *
2873  * @keyconf: the parameter passed with the set key
2874  * @skb: the packet to take the IV32/IV16 values from that will be
2875  *      encrypted with this key
2876  * @p2k: a buffer to which the key will be written, 16 bytes
2877  */
2878 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
2879                             struct sk_buff *skb, u8 *p2k);
2880
2881 /**
2882  * struct ieee80211_key_seq - key sequence counter
2883  *
2884  * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2885  * @ccmp: PN data, most significant byte first (big endian,
2886  *      reverse order than in packet)
2887  * @aes_cmac: PN data, most significant byte first (big endian,
2888  *      reverse order than in packet)
2889  */
2890 struct ieee80211_key_seq {
2891         union {
2892                 struct {
2893                         u32 iv32;
2894                         u16 iv16;
2895                 } tkip;
2896                 struct {
2897                         u8 pn[6];
2898                 } ccmp;
2899                 struct {
2900                         u8 pn[6];
2901                 } aes_cmac;
2902         };
2903 };
2904
2905 /**
2906  * ieee80211_get_key_tx_seq - get key TX sequence counter
2907  *
2908  * @keyconf: the parameter passed with the set key
2909  * @seq: buffer to receive the sequence data
2910  *
2911  * This function allows a driver to retrieve the current TX IV/PN
2912  * for the given key. It must not be called if IV generation is
2913  * offloaded to the device.
2914  *
2915  * Note that this function may only be called when no TX processing
2916  * can be done concurrently, for example when queues are stopped
2917  * and the stop has been synchronized.
2918  */
2919 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf,
2920                               struct ieee80211_key_seq *seq);
2921
2922 /**
2923  * ieee80211_get_key_rx_seq - get key RX sequence counter
2924  *
2925  * @keyconf: the parameter passed with the set key
2926  * @tid: The TID, or -1 for the management frame value (CCMP only);
2927  *      the value on TID 0 is also used for non-QoS frames. For
2928  *      CMAC, only TID 0 is valid.
2929  * @seq: buffer to receive the sequence data
2930  *
2931  * This function allows a driver to retrieve the current RX IV/PNs
2932  * for the given key. It must not be called if IV checking is done
2933  * by the device and not by mac80211.
2934  *
2935  * Note that this function may only be called when no RX processing
2936  * can be done concurrently.
2937  */
2938 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
2939                               int tid, struct ieee80211_key_seq *seq);
2940
2941 /**
2942  * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
2943  * @vif: virtual interface the rekeying was done on
2944  * @bssid: The BSSID of the AP, for checking association
2945  * @replay_ctr: the new replay counter after GTK rekeying
2946  * @gfp: allocation flags
2947  */
2948 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
2949                                 const u8 *replay_ctr, gfp_t gfp);
2950
2951 /**
2952  * ieee80211_wake_queue - wake specific queue
2953  * @hw: pointer as obtained from ieee80211_alloc_hw().
2954  * @queue: queue number (counted from zero).
2955  *
2956  * Drivers should use this function instead of netif_wake_queue.
2957  */
2958 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2959
2960 /**
2961  * ieee80211_stop_queue - stop specific queue
2962  * @hw: pointer as obtained from ieee80211_alloc_hw().
2963  * @queue: queue number (counted from zero).
2964  *
2965  * Drivers should use this function instead of netif_stop_queue.
2966  */
2967 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2968
2969 /**
2970  * ieee80211_queue_stopped - test status of the queue
2971  * @hw: pointer as obtained from ieee80211_alloc_hw().
2972  * @queue: queue number (counted from zero).
2973  *
2974  * Drivers should use this function instead of netif_stop_queue.
2975  */
2976
2977 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2978
2979 /**
2980  * ieee80211_stop_queues - stop all queues
2981  * @hw: pointer as obtained from ieee80211_alloc_hw().
2982  *
2983  * Drivers should use this function instead of netif_stop_queue.
2984  */
2985 void ieee80211_stop_queues(struct ieee80211_hw *hw);
2986
2987 /**
2988  * ieee80211_wake_queues - wake all queues
2989  * @hw: pointer as obtained from ieee80211_alloc_hw().
2990  *
2991  * Drivers should use this function instead of netif_wake_queue.
2992  */
2993 void ieee80211_wake_queues(struct ieee80211_hw *hw);
2994
2995 /**
2996  * ieee80211_scan_completed - completed hardware scan
2997  *
2998  * When hardware scan offload is used (i.e. the hw_scan() callback is
2999  * assigned) this function needs to be called by the driver to notify
3000  * mac80211 that the scan finished. This function can be called from
3001  * any context, including hardirq context.
3002  *
3003  * @hw: the hardware that finished the scan
3004  * @aborted: set to true if scan was aborted
3005  */
3006 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
3007
3008 /**
3009  * ieee80211_sched_scan_results - got results from scheduled scan
3010  *
3011  * When a scheduled scan is running, this function needs to be called by the
3012  * driver whenever there are new scan results available.
3013  *
3014  * @hw: the hardware that is performing scheduled scans
3015  */
3016 void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
3017
3018 /**
3019  * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
3020  *
3021  * When a scheduled scan is running, this function can be called by
3022  * the driver if it needs to stop the scan to perform another task.
3023  * Usual scenarios are drivers that cannot continue the scheduled scan
3024  * while associating, for instance.
3025  *
3026  * @hw: the hardware that is performing scheduled scans
3027  */
3028 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
3029
3030 /**
3031  * ieee80211_iterate_active_interfaces - iterate active interfaces
3032  *
3033  * This function iterates over the interfaces associated with a given
3034  * hardware that are currently active and calls the callback for them.
3035  * This function allows the iterator function to sleep, when the iterator
3036  * function is atomic @ieee80211_iterate_active_interfaces_atomic can
3037  * be used.
3038  * Does not iterate over a new interface during add_interface()
3039  *
3040  * @hw: the hardware struct of which the interfaces should be iterated over
3041  * @iterator: the iterator function to call
3042  * @data: first argument of the iterator function
3043  */
3044 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
3045                                          void (*iterator)(void *data, u8 *mac,
3046                                                 struct ieee80211_vif *vif),
3047                                          void *data);
3048
3049 /**
3050  * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
3051  *
3052  * This function iterates over the interfaces associated with a given
3053  * hardware that are currently active and calls the callback for them.
3054  * This function requires the iterator callback function to be atomic,
3055  * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
3056  * Does not iterate over a new interface during add_interface()
3057  *
3058  * @hw: the hardware struct of which the interfaces should be iterated over
3059  * @iterator: the iterator function to call, cannot sleep
3060  * @data: first argument of the iterator function
3061  */
3062 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
3063                                                 void (*iterator)(void *data,
3064                                                     u8 *mac,
3065                                                     struct ieee80211_vif *vif),
3066                                                 void *data);
3067
3068 /**
3069  * ieee80211_queue_work - add work onto the mac80211 workqueue
3070  *
3071  * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
3072  * This helper ensures drivers are not queueing work when they should not be.
3073  *
3074  * @hw: the hardware struct for the interface we are adding work for
3075  * @work: the work we want to add onto the mac80211 workqueue
3076  */
3077 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
3078
3079 /**
3080  * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
3081  *
3082  * Drivers and mac80211 use this to queue delayed work onto the mac80211
3083  * workqueue.
3084  *
3085  * @hw: the hardware struct for the interface we are adding work for
3086  * @dwork: delayable work to queue onto the mac80211 workqueue
3087  * @delay: number of jiffies to wait before queueing
3088  */
3089 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
3090                                   struct delayed_work *dwork,
3091                                   unsigned long delay);
3092
3093 /**
3094  * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
3095  * @sta: the station for which to start a BA session
3096  * @tid: the TID to BA on.
3097  * @timeout: session timeout value (in TUs)
3098  *
3099  * Return: success if addBA request was sent, failure otherwise
3100  *
3101  * Although mac80211/low level driver/user space application can estimate
3102  * the need to start aggregation on a certain RA/TID, the session level
3103  * will be managed by the mac80211.
3104  */
3105 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
3106                                   u16 timeout);
3107
3108 /**
3109  * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
3110  * @vif: &struct ieee80211_vif pointer from the add_interface callback
3111  * @ra: receiver address of the BA session recipient.
3112  * @tid: the TID to BA on.
3113  *
3114  * This function must be called by low level driver once it has
3115  * finished with preparations for the BA session. It can be called
3116  * from any context.
3117  */
3118 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3119                                       u16 tid);
3120
3121 /**
3122  * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
3123  * @sta: the station whose BA session to stop
3124  * @tid: the TID to stop BA.
3125  *
3126  * Return: negative error if the TID is invalid, or no aggregation active
3127  *
3128  * Although mac80211/low level driver/user space application can estimate
3129  * the need to stop aggregation on a certain RA/TID, the session level
3130  * will be managed by the mac80211.
3131  */
3132 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
3133
3134 /**
3135  * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
3136  * @vif: &struct ieee80211_vif pointer from the add_interface callback
3137  * @ra: receiver address of the BA session recipient.
3138  * @tid: the desired TID to BA on.
3139  *
3140  * This function must be called by low level driver once it has
3141  * finished with preparations for the BA session tear down. It
3142  * can be called from any context.
3143  */
3144 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
3145                                      u16 tid);
3146
3147 /**
3148  * ieee80211_find_sta - find a station
3149  *
3150  * @vif: virtual interface to look for station on
3151  * @addr: station's address
3152  *
3153  * This function must be called under RCU lock and the
3154  * resulting pointer is only valid under RCU lock as well.
3155  */
3156 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
3157                                          const u8 *addr);
3158
3159 /**
3160  * ieee80211_find_sta_by_ifaddr - find a station on hardware
3161  *
3162  * @hw: pointer as obtained from ieee80211_alloc_hw()
3163  * @addr: remote station's address
3164  * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
3165  *
3166  * This function must be called under RCU lock and the
3167  * resulting pointer is only valid under RCU lock as well.
3168  *
3169  * NOTE: You may pass NULL for localaddr, but then you will just get
3170  *      the first STA that matches the remote address 'addr'.
3171  *      We can have multiple STA associated with multiple
3172  *      logical stations (e.g. consider a station connecting to another
3173  *      BSSID on the same AP hardware without disconnecting first).
3174  *      In this case, the result of this method with localaddr NULL
3175  *      is not reliable.
3176  *
3177  * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
3178  */
3179 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
3180                                                const u8 *addr,
3181                                                const u8 *localaddr);
3182
3183 /**
3184  * ieee80211_sta_block_awake - block station from waking up
3185  * @hw: the hardware
3186  * @pubsta: the station
3187  * @block: whether to block or unblock
3188  *
3189  * Some devices require that all frames that are on the queues
3190  * for a specific station that went to sleep are flushed before
3191  * a poll response or frames after the station woke up can be
3192  * delivered to that it. Note that such frames must be rejected
3193  * by the driver as filtered, with the appropriate status flag.
3194  *
3195  * This function allows implementing this mode in a race-free
3196  * manner.
3197  *
3198  * To do this, a driver must keep track of the number of frames
3199  * still enqueued for a specific station. If this number is not
3200  * zero when the station goes to sleep, the driver must call
3201  * this function to force mac80211 to consider the station to
3202  * be asleep regardless of the station's actual state. Once the
3203  * number of outstanding frames reaches zero, the driver must
3204  * call this function again to unblock the station. That will
3205  * cause mac80211 to be able to send ps-poll responses, and if
3206  * the station queried in the meantime then frames will also
3207  * be sent out as a result of this. Additionally, the driver
3208  * will be notified that the station woke up some time after
3209  * it is unblocked, regardless of whether the station actually
3210  * woke up while blocked or not.
3211  */
3212 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
3213                                struct ieee80211_sta *pubsta, bool block);
3214
3215 /**
3216  * ieee80211_sta_eosp - notify mac80211 about end of SP
3217  * @pubsta: the station
3218  *
3219  * When a device transmits frames in a way that it can't tell
3220  * mac80211 in the TX status about the EOSP, it must clear the
3221  * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
3222  * This applies for PS-Poll as well as uAPSD.
3223  *
3224  * Note that there is no non-_irqsafe version right now as
3225  * it wasn't needed, but just like _tx_status() and _rx()
3226  * must not be mixed in irqsafe/non-irqsafe versions, this
3227  * function must not be mixed with those either. Use the
3228  * all irqsafe, or all non-irqsafe, don't mix! If you need
3229  * the non-irqsafe version of this, you need to add it.
3230  */
3231 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta);
3232
3233 /**
3234  * ieee80211_iter_keys - iterate keys programmed into the device
3235  * @hw: pointer obtained from ieee80211_alloc_hw()
3236  * @vif: virtual interface to iterate, may be %NULL for all
3237  * @iter: iterator function that will be called for each key
3238  * @iter_data: custom data to pass to the iterator function
3239  *
3240  * This function can be used to iterate all the keys known to
3241  * mac80211, even those that weren't previously programmed into
3242  * the device. This is intended for use in WoWLAN if the device
3243  * needs reprogramming of the keys during suspend. Note that due
3244  * to locking reasons, it is also only safe to call this at few
3245  * spots since it must hold the RTNL and be able to sleep.
3246  *
3247  * The order in which the keys are iterated matches the order
3248  * in which they were originally installed and handed to the
3249  * set_key callback.
3250  */
3251 void ieee80211_iter_keys(struct ieee80211_hw *hw,
3252                          struct ieee80211_vif *vif,
3253                          void (*iter)(struct ieee80211_hw *hw,
3254                                       struct ieee80211_vif *vif,
3255                                       struct ieee80211_sta *sta,
3256                                       struct ieee80211_key_conf *key,
3257                                       void *data),
3258                          void *iter_data);
3259
3260 /**
3261  * ieee80211_ap_probereq_get - retrieve a Probe Request template
3262  * @hw: pointer obtained from ieee80211_alloc_hw().
3263  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3264  *
3265  * Creates a Probe Request template which can, for example, be uploaded to
3266  * hardware. The template is filled with bssid, ssid and supported rate
3267  * information. This function must only be called from within the
3268  * .bss_info_changed callback function and only in managed mode. The function
3269  * is only useful when the interface is associated, otherwise it will return
3270  * NULL.
3271  */
3272 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
3273                                           struct ieee80211_vif *vif);
3274
3275 /**
3276  * ieee80211_beacon_loss - inform hardware does not receive beacons
3277  *
3278  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3279  *
3280  * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
3281  * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
3282  * hardware is not receiving beacons with this function.
3283  */
3284 void ieee80211_beacon_loss(struct ieee80211_vif *vif);
3285
3286 /**
3287  * ieee80211_connection_loss - inform hardware has lost connection to the AP
3288  *
3289  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3290  *
3291  * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
3292  * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
3293  * needs to inform if the connection to the AP has been lost.
3294  *
3295  * This function will cause immediate change to disassociated state,
3296  * without connection recovery attempts.
3297  */
3298 void ieee80211_connection_loss(struct ieee80211_vif *vif);
3299
3300 /**
3301  * ieee80211_resume_disconnect - disconnect from AP after resume
3302  *
3303  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3304  *
3305  * Instructs mac80211 to disconnect from the AP after resume.
3306  * Drivers can use this after WoWLAN if they know that the
3307  * connection cannot be kept up, for example because keys were
3308  * used while the device was asleep but the replay counters or
3309  * similar cannot be retrieved from the device during resume.
3310  *
3311  * Note that due to implementation issues, if the driver uses
3312  * the reconfiguration functionality during resume the interface
3313  * will still be added as associated first during resume and then
3314  * disconnect normally later.
3315  *
3316  * This function can only be called from the resume callback and
3317  * the driver must not be holding any of its own locks while it
3318  * calls this function, or at least not any locks it needs in the
3319  * key configuration paths (if it supports HW crypto).
3320  */
3321 void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
3322
3323 /**
3324  * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
3325  *
3326  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3327  *
3328  * Some hardware require full power save to manage simultaneous BT traffic
3329  * on the WLAN frequency. Full PSM is required periodically, whenever there are
3330  * burst of BT traffic. The hardware gets information of BT traffic via
3331  * hardware co-existence lines, and consequentially requests mac80211 to
3332  * (temporarily) enter full psm.
3333  * This function will only temporarily disable dynamic PS, not enable PSM if
3334  * it was not already enabled.
3335  * The driver must make sure to re-enable dynamic PS using
3336  * ieee80211_enable_dyn_ps() if the driver has disabled it.
3337  *
3338  */
3339 void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
3340
3341 /**
3342  * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
3343  *
3344  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3345  *
3346  * This function restores dynamic PS after being temporarily disabled via
3347  * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
3348  * be coupled with an eventual call to this function.
3349  *
3350  */
3351 void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
3352
3353 /**
3354  * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
3355  *      rssi threshold triggered
3356  *
3357  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3358  * @rssi_event: the RSSI trigger event type
3359  * @gfp: context flags
3360  *
3361  * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
3362  * monitoring is configured with an rssi threshold, the driver will inform
3363  * whenever the rssi level reaches the threshold.
3364  */
3365 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
3366                                enum nl80211_cqm_rssi_threshold_event rssi_event,
3367                                gfp_t gfp);
3368
3369 /**
3370  * ieee80211_get_operstate - get the operstate of the vif
3371  *
3372  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3373  *
3374  * The driver might need to know the operstate of the net_device
3375  * (specifically, whether the link is IF_OPER_UP after resume)
3376  */
3377 unsigned char ieee80211_get_operstate(struct ieee80211_vif *vif);
3378
3379 /**
3380  * ieee80211_chswitch_done - Complete channel switch process
3381  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3382  * @success: make the channel switch successful or not
3383  *
3384  * Complete the channel switch post-process: set the new operational channel
3385  * and wake up the suspended queues.
3386  */
3387 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
3388
3389 /**
3390  * ieee80211_request_smps - request SM PS transition
3391  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3392  * @smps_mode: new SM PS mode
3393  *
3394  * This allows the driver to request an SM PS transition in managed
3395  * mode. This is useful when the driver has more information than
3396  * the stack about possible interference, for example by bluetooth.
3397  */
3398 void ieee80211_request_smps(struct ieee80211_vif *vif,
3399                             enum ieee80211_smps_mode smps_mode);
3400
3401 /**
3402  * ieee80211_key_removed - disable hw acceleration for key
3403  * @key_conf: The key hw acceleration should be disabled for
3404  *
3405  * This allows drivers to indicate that the given key has been
3406  * removed from hardware acceleration, due to a new key that
3407  * was added. Don't use this if the key can continue to be used
3408  * for TX, if the key restriction is on RX only it is permitted
3409  * to keep the key for TX only and not call this function.
3410  *
3411  * Due to locking constraints, it may only be called during
3412  * @set_key. This function must be allowed to sleep, and the
3413  * key it tries to disable may still be used until it returns.
3414  */
3415 void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
3416
3417 /**
3418  * ieee80211_ready_on_channel - notification of remain-on-channel start
3419  * @hw: pointer as obtained from ieee80211_alloc_hw()
3420  */
3421 void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
3422
3423 /**
3424  * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
3425  * @hw: pointer as obtained from ieee80211_alloc_hw()
3426  */
3427 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
3428
3429 /**
3430  * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
3431  *
3432  * in order not to harm the system performance and user experience, the device
3433  * may request not to allow any rx ba session and tear down existing rx ba
3434  * sessions based on system constraints such as periodic BT activity that needs
3435  * to limit wlan activity (eg.sco or a2dp)."
3436  * in such cases, the intention is to limit the duration of the rx ppdu and
3437  * therefore prevent the peer device to use a-mpdu aggregation.
3438  *
3439  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3440  * @ba_rx_bitmap: Bit map of open rx ba per tid
3441  * @addr: & to bssid mac address
3442  */
3443 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
3444                                   const u8 *addr);
3445
3446 /**
3447  * ieee80211_send_bar - send a BlockAckReq frame
3448  *
3449  * can be used to flush pending frames from the peer's aggregation reorder
3450  * buffer.
3451  *
3452  * @vif: &struct ieee80211_vif pointer from the add_interface callback.
3453  * @ra: the peer's destination address
3454  * @tid: the TID of the aggregation session
3455  * @ssn: the new starting sequence number for the receiver
3456  */
3457 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
3458
3459 /* Rate control API */
3460
3461 /**
3462  * enum rate_control_changed - flags to indicate which parameter changed
3463  *
3464  * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
3465  *      changed, rate control algorithm can update its internal state if needed.
3466  */
3467 enum rate_control_changed {
3468         IEEE80211_RC_HT_CHANGED = BIT(0)
3469 };
3470
3471 /**
3472  * struct ieee80211_tx_rate_control - rate control information for/from RC algo
3473  *
3474  * @hw: The hardware the algorithm is invoked for.
3475  * @sband: The band this frame is being transmitted on.
3476  * @bss_conf: the current BSS configuration
3477  * @reported_rate: The rate control algorithm can fill this in to indicate
3478  *      which rate should be reported to userspace as the current rate and
3479  *      used for rate calculations in the mesh network.
3480  * @rts: whether RTS will be used for this frame because it is longer than the
3481  *      RTS threshold
3482  * @short_preamble: whether mac80211 will request short-preamble transmission
3483  *      if the selected rate supports it
3484  * @max_rate_idx: user-requested maximum rate (not MCS for now)
3485  *      (deprecated; this will be removed once drivers get updated to use
3486  *      rate_idx_mask)
3487  * @rate_idx_mask: user-requested rate mask (not MCS for now)
3488  * @skb: the skb that will be transmitted, the control information in it needs
3489  *      to be filled in
3490  * @bss: whether this frame is sent out in AP or IBSS mode
3491  */
3492 struct ieee80211_tx_rate_control {
3493         struct ieee80211_hw *hw;
3494         struct ieee80211_supported_band *sband;
3495         struct ieee80211_bss_conf *bss_conf;
3496         struct sk_buff *skb;
3497         struct ieee80211_tx_rate reported_rate;
3498         bool rts, short_preamble;
3499         u8 max_rate_idx;
3500         u32 rate_idx_mask;
3501         bool bss;
3502 };
3503
3504 struct rate_control_ops {
3505         struct module *module;
3506         const char *name;
3507         void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
3508         void (*free)(void *priv);
3509
3510         void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
3511         void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
3512                           struct ieee80211_sta *sta, void *priv_sta);
3513         void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
3514                             struct ieee80211_sta *sta,
3515                             void *priv_sta, u32 changed,
3516                             enum nl80211_channel_type oper_chan_type);
3517         void (*free_sta)(void *priv, struct ieee80211_sta *sta,
3518                          void *priv_sta);
3519
3520         void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
3521                           struct ieee80211_sta *sta, void *priv_sta,
3522                           struct sk_buff *skb);
3523         void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
3524                          struct ieee80211_tx_rate_control *txrc);
3525
3526         void (*add_sta_debugfs)(void *priv, void *priv_sta,
3527                                 struct dentry *dir);
3528         void (*remove_sta_debugfs)(void *priv, void *priv_sta);
3529 };
3530
3531 static inline int rate_supported(struct ieee80211_sta *sta,
3532                                  enum ieee80211_band band,
3533                                  int index)
3534 {
3535         return (sta == NULL || sta->supp_rates[band] & BIT(index));
3536 }
3537
3538 /**
3539  * rate_control_send_low - helper for drivers for management/no-ack frames
3540  *
3541  * Rate control algorithms that agree to use the lowest rate to
3542  * send management frames and NO_ACK data with the respective hw
3543  * retries should use this in the beginning of their mac80211 get_rate
3544  * callback. If true is returned the rate control can simply return.
3545  * If false is returned we guarantee that sta and sta and priv_sta is
3546  * not null.
3547  *
3548  * Rate control algorithms wishing to do more intelligent selection of
3549  * rate for multicast/broadcast frames may choose to not use this.
3550  *
3551  * @sta: &struct ieee80211_sta pointer to the target destination. Note
3552  *      that this may be null.
3553  * @priv_sta: private rate control structure. This may be null.
3554  * @txrc: rate control information we sholud populate for mac80211.
3555  */
3556 bool rate_control_send_low(struct ieee80211_sta *sta,
3557                            void *priv_sta,
3558                            struct ieee80211_tx_rate_control *txrc);
3559
3560
3561 static inline s8
3562 rate_lowest_index(struct ieee80211_supported_band *sband,
3563                   struct ieee80211_sta *sta)
3564 {
3565         int i;
3566
3567         for (i = 0; i < sband->n_bitrates; i++)
3568                 if (rate_supported(sta, sband->band, i))
3569                         return i;
3570
3571         /* warn when we cannot find a rate. */
3572         WARN_ON(1);
3573
3574         return 0;
3575 }
3576
3577 static inline
3578 bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
3579                               struct ieee80211_sta *sta)
3580 {
3581         unsigned int i;
3582
3583         for (i = 0; i < sband->n_bitrates; i++)
3584                 if (rate_supported(sta, sband->band, i))
3585                         return true;
3586         return false;
3587 }
3588
3589 int ieee80211_rate_control_register(struct rate_control_ops *ops);
3590 void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
3591
3592 static inline bool
3593 conf_is_ht20(struct ieee80211_conf *conf)
3594 {
3595         return conf->channel_type == NL80211_CHAN_HT20;
3596 }
3597
3598 static inline bool
3599 conf_is_ht40_minus(struct ieee80211_conf *conf)
3600 {
3601         return conf->channel_type == NL80211_CHAN_HT40MINUS;
3602 }
3603
3604 static inline bool
3605 conf_is_ht40_plus(struct ieee80211_conf *conf)
3606 {
3607         return conf->channel_type == NL80211_CHAN_HT40PLUS;
3608 }
3609
3610 static inline bool
3611 conf_is_ht40(struct ieee80211_conf *conf)
3612 {
3613         return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
3614 }
3615
3616 static inline bool
3617 conf_is_ht(struct ieee80211_conf *conf)
3618 {
3619         return conf->channel_type != NL80211_CHAN_NO_HT;
3620 }
3621
3622 static inline enum nl80211_iftype
3623 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
3624 {
3625         if (p2p) {
3626                 switch (type) {
3627                 case NL80211_IFTYPE_STATION:
3628                         return NL80211_IFTYPE_P2P_CLIENT;
3629                 case NL80211_IFTYPE_AP:
3630                         return NL80211_IFTYPE_P2P_GO;
3631                 default:
3632                         break;
3633                 }
3634         }
3635         return type;
3636 }
3637
3638 static inline enum nl80211_iftype
3639 ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
3640 {
3641         return ieee80211_iftype_p2p(vif->type, vif->p2p);
3642 }
3643
3644 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
3645                                    int rssi_min_thold,
3646                                    int rssi_max_thold);
3647
3648 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
3649
3650 int ieee80211_add_srates_ie(struct ieee80211_vif *vif, struct sk_buff *skb);
3651
3652 int ieee80211_add_ext_srates_ie(struct ieee80211_vif *vif,
3653                                 struct sk_buff *skb);
3654 #endif /* MAC80211_H */