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