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