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