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