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