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