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