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