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