blob: 3ce8e1f70c06a5ae29d66f14c4768905948d7456 [file] [log] [blame]
Jiri Bencf0706e822007-05-05 11:45:53 -07001/*
Johannes Berg3017b802007-08-28 17:01:53 -04002 * mac80211 <-> driver interface
3 *
Jiri Bencf0706e822007-05-05 11:45:53 -07004 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
Jouni Malinen026331c2010-02-15 12:53:10 +02006 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
Jiri Bencf0706e822007-05-05 11:45:53 -07007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
16#include <linux/kernel.h>
17#include <linux/if_ether.h>
18#include <linux/skbuff.h>
19#include <linux/wireless.h>
20#include <linux/device.h>
21#include <linux/ieee80211.h>
Jiri Bencf0706e822007-05-05 11:45:53 -070022#include <net/cfg80211.h>
23
Johannes Berg75a5f0c2007-09-18 17:29:20 -040024/**
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
Jiri Bencf0706e822007-05-05 11:45:53 -070037 * 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
Johannes Berg2485f712008-02-25 16:27:41 +010040 * 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
Randy Dunlap6ef307b2008-07-03 13:52:18 -070044 * use the non-IRQ-safe functions!
Jiri Bencf0706e822007-05-05 11:45:53 -070045 */
46
Johannes Berg75a5f0c2007-09-18 17:29:20 -040047/**
48 * DOC: Warning
Jiri Bencf0706e822007-05-05 11:45:53 -070049 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040050 * 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
Jiri Bencf0706e822007-05-05 11:45:53 -070056 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040057 * 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.
Jiri Bencf0706e822007-05-05 11:45:53 -070073 */
74
Ron Rindjunsky10816d42007-11-26 16:14:30 +020075/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -040076 * 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/**
Johannes Berge100bb62008-04-30 18:51:21 +020091 * enum ieee80211_max_queues - maximum number of queues
92 *
93 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
Johannes Berge100bb62008-04-30 18:51:21 +020094 */
95enum ieee80211_max_queues {
Johannes Berg51b38142009-03-12 11:16:48 +010096 IEEE80211_MAX_QUEUES = 4,
Johannes Berge100bb62008-04-30 18:51:21 +020097};
98
99/**
Johannes Berg4bce22b2010-11-16 11:49:58 -0800100 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
101 * @IEEE80211_AC_VO: voice
102 * @IEEE80211_AC_VI: video
103 * @IEEE80211_AC_BE: best effort
104 * @IEEE80211_AC_BK: background
105 */
106enum ieee80211_ac_numbers {
107 IEEE80211_AC_VO = 0,
108 IEEE80211_AC_VI = 1,
109 IEEE80211_AC_BE = 2,
110 IEEE80211_AC_BK = 3,
111};
112
113/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400114 * struct ieee80211_tx_queue_params - transmit queue configuration
115 *
116 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100117 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400118 *
Bob Copelande37d4df2008-10-20 21:20:27 -0400119 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +0200120 * @cw_min: minimum contention window [a value of the form
121 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400122 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100123 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Kalle Valo9d173fc2010-01-14 13:09:14 +0200124 * @uapsd: is U-APSD mode enabled for the queue
Johannes Berg6b301cd2007-09-18 17:29:20 -0400125 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700126struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200127 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100128 u16 cw_min;
129 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200130 u8 aifs;
Kalle Valoab133152010-01-12 10:42:31 +0200131 bool uapsd;
Jiri Bencf0706e822007-05-05 11:45:53 -0700132};
133
Jiri Bencf0706e822007-05-05 11:45:53 -0700134struct ieee80211_low_level_stats {
135 unsigned int dot11ACKFailureCount;
136 unsigned int dot11RTSFailureCount;
137 unsigned int dot11FCSErrorCount;
138 unsigned int dot11RTSSuccessCount;
139};
140
Johannes Berg471b3ef2007-12-28 14:32:58 +0100141/**
142 * enum ieee80211_bss_change - BSS change notification flags
143 *
144 * These flags are used with the bss_info_changed() callback
145 * to indicate which BSS parameter changed.
146 *
147 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
148 * also implies a change in the AID.
149 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
150 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300151 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700152 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200153 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200154 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200155 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
156 * reason (IBSS and managed mode)
157 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
158 * new beacon (beaconing modes)
159 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
160 * enabled/disabled (beaconing modes)
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200161 * @BSS_CHANGED_CQM: Connection quality monitor config changed
Johannes Berg8fc214b2010-04-28 17:40:43 +0200162 * @BSS_CHANGED_IBSS: IBSS join status changed
Juuso Oikarinen68542962010-06-09 13:43:26 +0300163 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200164 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
165 * that it is only ever disabled for station mode.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200166 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100167 */
168enum ieee80211_bss_change {
169 BSS_CHANGED_ASSOC = 1<<0,
170 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
171 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300172 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700173 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200174 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200175 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200176 BSS_CHANGED_BSSID = 1<<7,
177 BSS_CHANGED_BEACON = 1<<8,
178 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200179 BSS_CHANGED_CQM = 1<<10,
Johannes Berg8fc214b2010-04-28 17:40:43 +0200180 BSS_CHANGED_IBSS = 1<<11,
Juuso Oikarinen68542962010-06-09 13:43:26 +0300181 BSS_CHANGED_ARP_FILTER = 1<<12,
Johannes Berg4ced3f72010-07-19 16:39:04 +0200182 BSS_CHANGED_QOS = 1<<13,
Johannes Berg7da7cc12010-08-05 17:02:38 +0200183 BSS_CHANGED_IDLE = 1<<14,
Johannes Bergac8dd502010-05-05 09:44:02 +0200184
185 /* when adding here, make sure to change ieee80211_reconfig */
Johannes Berg471b3ef2007-12-28 14:32:58 +0100186};
187
Juuso Oikarinen68542962010-06-09 13:43:26 +0300188/*
189 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
190 * of addresses for an interface increase beyond this value, hardware ARP
191 * filtering will be disabled.
192 */
193#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
194
Johannes Berg471b3ef2007-12-28 14:32:58 +0100195/**
196 * struct ieee80211_bss_conf - holds the BSS's changing parameters
197 *
198 * This structure keeps information about a BSS (and an association
199 * to that BSS) that can change during the lifetime of the BSS.
200 *
201 * @assoc: association status
Johannes Berg8fc214b2010-04-28 17:40:43 +0200202 * @ibss_joined: indicates whether this station is part of an IBSS
203 * or not
Johannes Berg471b3ef2007-12-28 14:32:58 +0100204 * @aid: association ID number, valid only when @assoc is true
205 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200206 * @use_short_preamble: use 802.11b short preamble;
207 * if the hardware cannot handle this it must set the
208 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
209 * @use_short_slot: use short slot time (only relevant for ERP);
210 * if the hardware cannot handle this it must set the
211 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Johannes Berg56007a02010-01-26 14:19:52 +0100212 * @dtim_period: num of beacons before the next DTIM, for beaconing,
Johannes Berge5b900d2010-07-29 16:08:55 +0200213 * valid in station mode only while @assoc is true and if also
214 * requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
215 * @ps_dtim_period)
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700216 * @timestamp: beacon timestamp
217 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800218 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200219 * @basic_rates: bitmap of basic rates, each bit stands for an
220 * index into the rate table configured by the driver in
221 * the current band.
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100222 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200223 * @bssid: The BSSID for this BSS
224 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg0aaffa92010-05-05 15:28:27 +0200225 * @channel_type: Channel type for this BSS -- the hardware might be
226 * configured for HT40+ while this BSS only uses no-HT, for
227 * example.
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200228 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
229 * This field is only valid when the channel type is one of the HT types.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200230 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
231 * implies disabled
232 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
Juuso Oikarinen68542962010-06-09 13:43:26 +0300233 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
234 * may filter ARP queries targeted for other addresses than listed here.
235 * The driver must allow ARP queries targeted for all address listed here
236 * to pass through. An empty list implies no ARP queries need to pass.
237 * @arp_addr_cnt: Number of addresses currently on the list.
238 * @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
239 * filter ARP queries based on the @arp_addr_list, if disabled, the
240 * hardware must not perform any ARP filtering. Note, that the filter will
241 * be enabled also in promiscuous mode.
Johannes Berg4ced3f72010-07-19 16:39:04 +0200242 * @qos: This is a QoS-enabled BSS.
Johannes Berg7da7cc12010-08-05 17:02:38 +0200243 * @idle: This interface is idle. There's also a global idle flag in the
244 * hardware config which may be more appropriate depending on what
245 * your driver/device needs to do.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100246 */
247struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200248 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100249 /* association related data */
Johannes Berg8fc214b2010-04-28 17:40:43 +0200250 bool assoc, ibss_joined;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100251 u16 aid;
252 /* erp related data */
253 bool use_cts_prot;
254 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300255 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200256 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800257 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700258 u16 beacon_int;
259 u16 assoc_capability;
260 u64 timestamp;
Johannes Berg881d9482009-01-21 15:13:48 +0100261 u32 basic_rates;
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +0100262 int mcast_rate[IEEE80211_NUM_BANDS];
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200263 u16 ht_operation_mode;
Juuso Oikarinena97c13c2010-03-23 09:02:34 +0200264 s32 cqm_rssi_thold;
265 u32 cqm_rssi_hyst;
Johannes Berg0aaffa92010-05-05 15:28:27 +0200266 enum nl80211_channel_type channel_type;
Juuso Oikarinen68542962010-06-09 13:43:26 +0300267 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
268 u8 arp_addr_cnt;
269 bool arp_filter_enabled;
Johannes Berg4ced3f72010-07-19 16:39:04 +0200270 bool qos;
Johannes Berg7da7cc12010-08-05 17:02:38 +0200271 bool idle;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100272};
273
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800274/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700275 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800276 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700277 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800278 *
Johannes Berg7351c6b2009-11-19 01:08:30 +0100279 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200280 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
281 * number to this frame, taking care of not overwriting the fragment
282 * number and increasing the sequence number only when the
283 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
284 * assign sequence numbers to QoS-data frames but cannot do so correctly
285 * for non-QoS-data and management frames because beacons need them from
286 * that counter as well and mac80211 cannot guarantee proper sequencing.
287 * If this flag is set, the driver should instruct the hardware to
288 * assign a sequence number to the frame or assign one itself. Cf. IEEE
289 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
290 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200291 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200292 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
293 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200294 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200295 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
296 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200297 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200298 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
Johannes Bergab5b5342009-08-07 16:28:09 +0200299 * because the destination STA was in powersave mode. Note that to
300 * avoid race conditions, the filter must be set by the hardware or
301 * firmware upon receiving a frame that indicates that the station
302 * went to sleep (must be done on device to filter frames already on
303 * the queue) and may only be unset after mac80211 gives the OK for
304 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
305 * since only then is it guaranteed that no more frames are in the
306 * hardware queue.
Johannes Berge039fa42008-05-15 12:55:29 +0200307 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
308 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
309 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300310 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
311 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200312 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
313 * set by rate control algorithms to indicate probe rate, will
314 * be cleared for fragmented frames (except on the last fragment)
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100315 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
316 * used to indicate that a pending frame requires TX processing before
317 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200318 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
319 * used to indicate that a frame was already retried due to PS
Johannes Berg3b8d81e2009-06-17 17:43:56 +0200320 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
321 * used to indicate frame should not be encrypted
Johannes Berg3fa52052009-07-24 13:23:09 +0200322 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
323 * This frame is a response to a PS-poll frame and should be sent
324 * although the station is in powersave mode.
Johannes Bergad5351d2009-08-07 16:42:15 +0200325 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
326 * transmit function after the current frame, this can be used
327 * by drivers to kick the DMA queue only if unset or when the
328 * queue gets full.
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100329 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
330 * after TX status because the destination was asleep, it must not
331 * be modified again (no seqno assignment, crypto, etc.)
Felix Fietkau17ad3532010-01-31 21:56:25 +0100332 * @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
333 * has a radiotap header at skb->data.
Jouni Malinen026331c2010-02-15 12:53:10 +0200334 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
335 * MLME command (internal to mac80211 to figure out whether to send TX
336 * status to user space)
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400337 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200338 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
339 * frame and selects the maximum number of streams that it can use.
Christian Lampartereb7d3062010-09-21 21:36:18 +0200340 *
341 * Note: If you have to add new flags to the enumeration, then don't
342 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800343 */
344enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200345 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200346 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
347 IEEE80211_TX_CTL_NO_ACK = BIT(2),
348 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
349 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
350 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
351 IEEE80211_TX_CTL_AMPDU = BIT(6),
352 IEEE80211_TX_CTL_INJECTED = BIT(7),
353 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
354 IEEE80211_TX_STAT_ACK = BIT(9),
355 IEEE80211_TX_STAT_AMPDU = BIT(10),
356 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
357 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100358 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200359 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e2009-06-17 17:43:56 +0200360 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg3fa52052009-07-24 13:23:09 +0200361 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200362 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100363 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Felix Fietkau17ad3532010-01-31 21:56:25 +0100364 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200365 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400366 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200367 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
Johannes Berg21f83582010-12-18 17:20:47 +0100368 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
Johannes Berge6a98542008-10-21 12:40:02 +0200369};
370
Johannes Bergabe37c42010-06-07 11:12:27 +0200371#define IEEE80211_TX_CTL_STBC_SHIFT 23
372
Christian Lampartereb7d3062010-09-21 21:36:18 +0200373/*
374 * This definition is used as a mask to clear all temporary flags, which are
375 * set by the tx handlers for each transmission attempt by the mac80211 stack.
376 */
377#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
378 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
379 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
380 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
381 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
382 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
383 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
384 IEEE80211_TX_CTL_STBC)
385
Sujith2134e7e2009-01-22 09:00:52 +0530386/**
387 * enum mac80211_rate_control_flags - per-rate flags set by the
388 * Rate Control algorithm.
389 *
390 * These flags are set by the Rate control algorithm for each rate during tx,
391 * in the @flags member of struct ieee80211_tx_rate.
392 *
393 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
394 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
395 * This is set if the current BSS requires ERP protection.
396 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
397 * @IEEE80211_TX_RC_MCS: HT rate.
398 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
399 * Greenfield mode.
400 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
401 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
402 * adjacent 20 MHz channels, if the current channel type is
403 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
404 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
405 */
Johannes Berge6a98542008-10-21 12:40:02 +0200406enum mac80211_rate_control_flags {
407 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
408 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
409 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
410
411 /* rate index is an MCS rate number instead of an index */
412 IEEE80211_TX_RC_MCS = BIT(3),
413 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
414 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
415 IEEE80211_TX_RC_DUP_DATA = BIT(6),
416 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800417};
418
Johannes Berge039fa42008-05-15 12:55:29 +0200419
Johannes Berge6a98542008-10-21 12:40:02 +0200420/* there are 40 bytes if you don't need the rateset to be kept */
421#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200422
Johannes Berge6a98542008-10-21 12:40:02 +0200423/* if you do need the rateset, then you have less space */
424#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
425
426/* maximum number of rate stages */
427#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200428
429/**
Johannes Berge6a98542008-10-21 12:40:02 +0200430 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200431 *
Johannes Berge6a98542008-10-21 12:40:02 +0200432 * @idx: rate index to attempt to send with
433 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200434 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200435 *
436 * A value of -1 for @idx indicates an invalid rate and, if used
437 * in an array of retry rates, that no more rates should be tried.
438 *
439 * When used for transmit status reporting, the driver should
440 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200441 *
442 * &struct ieee80211_tx_info contains an array of these structs
443 * in the control information, and it will be filled by the rate
444 * control algorithm according to what should be sent. For example,
445 * if this array contains, in the format { <idx>, <count> } the
446 * information
447 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
448 * then this means that the frame should be transmitted
449 * up to twice at rate 3, up to twice at rate 2, and up to four
450 * times at rate 1 if it doesn't get acknowledged. Say it gets
451 * acknowledged by the peer after the fifth attempt, the status
452 * information should then contain
453 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
454 * since it was transmitted twice at rate 3, twice at rate 2
455 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200456 */
Johannes Berge6a98542008-10-21 12:40:02 +0200457struct ieee80211_tx_rate {
458 s8 idx;
459 u8 count;
460 u8 flags;
Gustavo F. Padovan3f30fc12010-07-21 10:59:58 +0000461} __packed;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200462
Johannes Berge039fa42008-05-15 12:55:29 +0200463/**
464 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200465 *
Johannes Berge039fa42008-05-15 12:55:29 +0200466 * This structure is placed in skb->cb for three uses:
467 * (1) mac80211 TX control - mac80211 tells the driver what to do
468 * (2) driver internal use (if applicable)
469 * (3) TX status information - driver tells mac80211 what happened
470 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200471 * The TX control's sta pointer is only valid during the ->tx call,
472 * it may be NULL.
473 *
Johannes Berge039fa42008-05-15 12:55:29 +0200474 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200475 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200476 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200477 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700478 * @control: union for control data
479 * @status: union for status data
480 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100481 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700482 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100483 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700484 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200485 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200486 */
Johannes Berge039fa42008-05-15 12:55:29 +0200487struct ieee80211_tx_info {
488 /* common information */
489 u32 flags;
490 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200491
Johannes Berge039fa42008-05-15 12:55:29 +0200492 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100493
Johannes Berge6a98542008-10-21 12:40:02 +0200494 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500495 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100496
Johannes Berge039fa42008-05-15 12:55:29 +0200497 union {
498 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200499 union {
500 /* rate control */
501 struct {
502 struct ieee80211_tx_rate rates[
503 IEEE80211_TX_MAX_RATES];
504 s8 rts_cts_rate_idx;
505 };
506 /* only needed before rate control */
507 unsigned long jiffies;
508 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200509 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200510 struct ieee80211_vif *vif;
511 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200512 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200513 } control;
514 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200515 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
516 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200517 int ack_signal;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100518 u8 ampdu_len;
Johannes Berg095dfdb2010-05-26 17:19:25 +0200519 /* 15 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200520 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200521 struct {
522 struct ieee80211_tx_rate driver_rates[
523 IEEE80211_TX_MAX_RATES];
524 void *rate_driver_data[
525 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
526 };
527 void *driver_data[
528 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200529 };
Jiri Bencf0706e822007-05-05 11:45:53 -0700530};
531
Johannes Berge039fa42008-05-15 12:55:29 +0200532static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
533{
534 return (struct ieee80211_tx_info *)skb->cb;
535}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400536
Johannes Bergf1d58c22009-06-17 13:13:00 +0200537static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
538{
539 return (struct ieee80211_rx_status *)skb->cb;
540}
541
Johannes Berge6a98542008-10-21 12:40:02 +0200542/**
543 * ieee80211_tx_info_clear_status - clear TX status
544 *
545 * @info: The &struct ieee80211_tx_info to be cleared.
546 *
547 * When the driver passes an skb back to mac80211, it must report
548 * a number of things in TX status. This function clears everything
549 * in the TX status but the rate control information (it does clear
550 * the count since you need to fill that in anyway).
551 *
552 * NOTE: You can only use this function if you do NOT use
553 * info->driver_data! Use info->rate_driver_data
554 * instead if you need only the less space that allows.
555 */
556static inline void
557ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
558{
559 int i;
560
561 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
562 offsetof(struct ieee80211_tx_info, control.rates));
563 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
564 offsetof(struct ieee80211_tx_info, driver_rates));
565 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
566 /* clear the rate counts */
567 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
568 info->status.rates[i].count = 0;
569
570 BUILD_BUG_ON(
571 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
572 memset(&info->status.ampdu_ack_len, 0,
573 sizeof(struct ieee80211_tx_info) -
574 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
575}
576
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400577
578/**
579 * enum mac80211_rx_flags - receive flags
580 *
581 * These flags are used with the @flag member of &struct ieee80211_rx_status.
582 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
583 * Use together with %RX_FLAG_MMIC_STRIPPED.
584 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400585 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
586 * verification has been done by the hardware.
587 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
588 * If this flag is set, the stack cannot do any replay detection
589 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400590 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
591 * the frame.
592 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
593 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100594 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900595 * is valid. This is useful in monitor mode and necessary for beacon frames
596 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200597 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200598 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
599 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
600 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400601 */
602enum mac80211_rx_flags {
603 RX_FLAG_MMIC_ERROR = 1<<0,
604 RX_FLAG_DECRYPTED = 1<<1,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400605 RX_FLAG_MMIC_STRIPPED = 1<<3,
606 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400607 RX_FLAG_FAILED_FCS_CRC = 1<<5,
608 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100609 RX_FLAG_TSFT = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200610 RX_FLAG_SHORTPRE = 1<<8,
611 RX_FLAG_HT = 1<<9,
612 RX_FLAG_40MHZ = 1<<10,
613 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400614};
615
616/**
617 * struct ieee80211_rx_status - receive status
618 *
619 * The low-level driver should provide this information (the subset
620 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200621 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200622 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900623 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
624 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100625 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400626 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200627 * @signal: signal strength when receiving this frame, either in dBm, in dB or
628 * unspecified depending on the hardware capabilities flags
629 * @IEEE80211_HW_SIGNAL_*
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400630 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200631 * @rate_idx: index of data rate into band's supported rates or MCS index if
632 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400633 * @flag: %RX_FLAG_*
Johannes Berg554891e2010-09-24 12:38:25 +0200634 * @rx_flags: internal RX flags for mac80211
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400635 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700636struct ieee80211_rx_status {
637 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100638 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400639 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400640 int signal;
Jiri Bencf0706e822007-05-05 11:45:53 -0700641 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100642 int rate_idx;
Jiri Bencf0706e822007-05-05 11:45:53 -0700643 int flag;
Johannes Berg554891e2010-09-24 12:38:25 +0200644 unsigned int rx_flags;
Jiri Bencf0706e822007-05-05 11:45:53 -0700645};
646
Johannes Berg6b301cd2007-09-18 17:29:20 -0400647/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400648 * enum ieee80211_conf_flags - configuration flags
649 *
650 * Flags to define PHY configuration options
651 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100652 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
653 * to determine for example whether to calculate timestamps for packets
654 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200655 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
656 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
657 * meaning that the hardware still wakes up for beacons, is able to
658 * transmit frames and receive the possible acknowledgment frames.
659 * Not to be confused with hardware specific wakeup/sleep states,
660 * driver is responsible for that. See the section "Powersave support"
661 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200662 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
663 * the driver should be prepared to handle configuration requests but
664 * may turn the device off as much as possible. Typically, this flag will
665 * be set when an interface is set UP but not associated or scanning, but
666 * it can also be unset in that case when monitor interfaces are active.
Felix Fietkau45521242010-07-28 02:40:49 +0200667 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
668 * operating channel.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400669 */
670enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100671 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200672 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200673 IEEE80211_CONF_IDLE = (1<<2),
Felix Fietkau45521242010-07-28 02:40:49 +0200674 IEEE80211_CONF_OFFCHANNEL = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400675};
Jiri Bencf0706e822007-05-05 11:45:53 -0700676
Johannes Berg7a5158e2008-10-08 10:59:33 +0200677
Jiri Bencf0706e822007-05-05 11:45:53 -0700678/**
Johannes Berge8975582008-10-09 12:18:51 +0200679 * enum ieee80211_conf_changed - denotes which configuration changed
680 *
Johannes Berge8975582008-10-09 12:18:51 +0200681 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100682 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200683 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200684 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100685 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200686 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200687 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100688 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berge8975582008-10-09 12:18:51 +0200689 */
690enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100691 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200692 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100693 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200694 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200695 IEEE80211_CONF_CHANGE_POWER = BIT(5),
696 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
697 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200698 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200699};
700
701/**
Johannes Berg0f782312009-12-01 13:37:02 +0100702 * enum ieee80211_smps_mode - spatial multiplexing power save mode
703 *
Kalle Valo9d173fc2010-01-14 13:09:14 +0200704 * @IEEE80211_SMPS_AUTOMATIC: automatic
705 * @IEEE80211_SMPS_OFF: off
706 * @IEEE80211_SMPS_STATIC: static
707 * @IEEE80211_SMPS_DYNAMIC: dynamic
708 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +0100709 */
710enum ieee80211_smps_mode {
711 IEEE80211_SMPS_AUTOMATIC,
712 IEEE80211_SMPS_OFF,
713 IEEE80211_SMPS_STATIC,
714 IEEE80211_SMPS_DYNAMIC,
715
716 /* keep last */
717 IEEE80211_SMPS_NUM_MODES,
718};
719
720/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700721 * struct ieee80211_conf - configuration of the device
722 *
723 * This struct indicates how the driver shall configure the hardware.
724 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200725 * @flags: configuration flags defined above
726 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800727 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200728 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200729 * before checking the beacon for a TIM bit (managed mode only); this
730 * value will be only achievable between DTIM frames, the hardware
731 * needs to check for the multicast traffic bit in DTIM beacons.
732 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +0100733 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
734 * in power saving. Power saving will not be enabled until a beacon
735 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +0200736 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
737 * powersave documentation below. This variable is valid only when
738 * the CONF_PS flag is set.
739 *
Johannes Berg8318d782008-01-24 19:38:38 +0100740 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200741 *
Johannes Berg8318d782008-01-24 19:38:38 +0100742 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100743 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200744 *
Johannes Berg9124b072008-10-14 19:17:54 +0200745 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
746 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
747 * but actually means the number of transmissions not the number of retries
748 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
749 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
750 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +0100751 *
752 * @smps_mode: spatial multiplexing powersave mode; note that
753 * %IEEE80211_SMPS_STATIC is used when the device is not
754 * configured for an HT channel
Jiri Bencf0706e822007-05-05 11:45:53 -0700755 */
756struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400757 u32 flags;
Juuso Oikarinenff616382010-06-09 09:51:52 +0300758 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200759 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200760
Johannes Berge8975582008-10-09 12:18:51 +0200761 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +0100762 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +0200763
Johannes Berg9124b072008-10-14 19:17:54 +0200764 u8 long_frame_max_tx_count, short_frame_max_tx_count;
765
Johannes Berg8318d782008-01-24 19:38:38 +0100766 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100767 enum nl80211_channel_type channel_type;
Johannes Berg0f782312009-12-01 13:37:02 +0100768 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e822007-05-05 11:45:53 -0700769};
770
771/**
Johannes Berg5ce6e432010-05-11 16:20:57 +0200772 * struct ieee80211_channel_switch - holds the channel switch data
773 *
774 * The information provided in this structure is required for channel switch
775 * operation.
776 *
777 * @timestamp: value in microseconds of the 64-bit Time Synchronization
778 * Function (TSF) timer when the frame containing the channel switch
779 * announcement was received. This is simply the rx.mactime parameter
780 * the driver passed into mac80211.
781 * @block_tx: Indicates whether transmission must be blocked before the
782 * scheduled channel switch, as indicated by the AP.
783 * @channel: the new channel to switch to
784 * @count: the number of TBTT's until the channel switch event
785 */
786struct ieee80211_channel_switch {
787 u64 timestamp;
788 bool block_tx;
789 struct ieee80211_channel *channel;
790 u8 count;
791};
792
793/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100794 * struct ieee80211_vif - per-interface data
795 *
796 * Data in this structure is continually present for driver
797 * use during the life of a virtual interface.
798 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100799 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200800 * @bss_conf: BSS configuration for this interface, either our own
801 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +0100802 * @addr: address of this interface
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200803 * @p2p: indicates whether this AP or STA interface is a p2p
804 * interface, i.e. a GO or p2p-sta respectively
Johannes Berg32bfd352007-12-19 01:31:26 +0100805 * @drv_priv: data area for driver use, will always be aligned to
806 * sizeof(void *).
807 */
808struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200809 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200810 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +0100811 u8 addr[ETH_ALEN];
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200812 bool p2p;
Johannes Berg32bfd352007-12-19 01:31:26 +0100813 /* must be last */
814 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
815};
816
Johannes Berg902acc72008-02-23 15:17:19 +0100817static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
818{
819#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200820 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100821#endif
822 return false;
823}
824
Johannes Berg32bfd352007-12-19 01:31:26 +0100825/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400826 * enum ieee80211_key_flags - key flags
827 *
828 * These flags are used for communication about keys between the driver
829 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
830 *
831 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
832 * that the STA this key will be used with could be using QoS.
833 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
834 * driver to indicate that it requires IV generation for this
835 * particular key.
836 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
837 * the driver for a TKIP key if it requires Michael MIC
838 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200839 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
840 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200841 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
842 * CCMP key if it requires CCMP encryption of management frames (MFP) to
843 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400844 */
845enum ieee80211_key_flags {
846 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
847 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
848 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200849 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200850 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400851};
852
853/**
854 * struct ieee80211_key_conf - key information
855 *
856 * This key information is given by mac80211 to the driver by
857 * the set_key() callback in &struct ieee80211_ops.
858 *
859 * @hw_key_idx: To be set by the driver, this is the key index the driver
860 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400861 * encrypted in hardware.
Johannes Berg97359d12010-08-10 09:46:38 +0200862 * @cipher: The key's cipher suite selector.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400863 * @flags: key flags, see &enum ieee80211_key_flags.
864 * @keyidx: the key index (0-3)
865 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400866 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
867 * data block:
868 * - Temporal Encryption Key (128 bits)
869 * - Temporal Authenticator Tx MIC Key (64 bits)
870 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100871 * @icv_len: The ICV length for this key type
872 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400873 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700874struct ieee80211_key_conf {
Johannes Berg97359d12010-08-10 09:46:38 +0200875 u32 cipher;
Felix Fietkau76708de2008-10-05 18:02:48 +0200876 u8 icv_len;
877 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400878 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400879 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400880 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400881 u8 keylen;
Jiri Bencf0706e822007-05-05 11:45:53 -0700882 u8 key[0];
883};
884
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400885/**
886 * enum set_key_cmd - key command
887 *
888 * Used with the set_key() callback in &struct ieee80211_ops, this
889 * indicates whether a key is being removed or added.
890 *
891 * @SET_KEY: a key is set
892 * @DISABLE_KEY: a key must be disabled
893 */
Johannes Bergea49c352007-09-18 17:29:21 -0400894enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400895 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400896};
Jiri Bencf0706e822007-05-05 11:45:53 -0700897
Tomas Winkler478f8d22007-09-30 13:52:37 +0200898/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200899 * struct ieee80211_sta - station table entry
900 *
901 * A station table entry represents a station we are possibly
902 * communicating with. Since stations are RCU-managed in
903 * mac80211, any ieee80211_sta pointer you get access to must
904 * either be protected by rcu_read_lock() explicitly or implicitly,
905 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +0100906 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +0200907 *
908 * @addr: MAC address
909 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200910 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200911 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200912 * @drv_priv: data area for driver use, will always be aligned to
913 * sizeof(void *), size is determined in hw information.
914 */
915struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100916 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200917 u8 addr[ETH_ALEN];
918 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200919 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200920
921 /* must be last */
922 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
923};
924
925/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200926 * enum sta_notify_cmd - sta notify command
927 *
928 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Sujith38a6cc72010-05-19 11:32:30 +0530929 * indicates if an associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200930 *
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100931 * @STA_NOTIFY_SLEEP: a station is now sleeping
932 * @STA_NOTIFY_AWAKE: a sleeping station woke up
933 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100934enum sta_notify_cmd {
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100935 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
936};
937
938/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200939 * enum ieee80211_tkip_key_type - get tkip key
940 *
941 * Used by drivers which need to get a tkip key for skb. Some drivers need a
942 * phase 1 key, others need a phase 2 key. A single function allows the driver
943 * to get the key, this enum indicates what type of key is required.
944 *
945 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
946 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
947 */
948enum ieee80211_tkip_key_type {
949 IEEE80211_TKIP_P1_KEY,
950 IEEE80211_TKIP_P2_KEY,
951};
952
953/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400954 * enum ieee80211_hw_flags - hardware flags
955 *
956 * These flags are used to indicate hardware capabilities to
957 * the stack. Generally, flags here should have their meaning
958 * done in a way that the simplest hardware doesn't need setting
959 * any particular flags. There are some exceptions to this rule,
960 * however, so you are advised to review these flags carefully.
961 *
Johannes Bergaf65cd92009-11-17 18:18:36 +0100962 * @IEEE80211_HW_HAS_RATE_CONTROL:
963 * The hardware or firmware includes rate control, and cannot be
964 * controlled by the stack. As such, no rate control algorithm
965 * should be instantiated, and the TX rate reported to userspace
966 * will be taken from the TX status instead of the rate control
967 * algorithm.
968 * Note that this requires that the driver implement a number of
969 * callbacks so it has the correct information, it needs to have
970 * the @set_rts_threshold callback and must look at the BSS config
971 * @use_cts_prot for G/N protection, @use_short_slot for slot
972 * timing in 2.4 GHz and @use_short_preamble for preambles for
973 * CCK frames.
974 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400975 * @IEEE80211_HW_RX_INCLUDES_FCS:
976 * Indicates that received frames passed to the stack include
977 * the FCS at the end.
978 *
979 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
980 * Some wireless LAN chipsets buffer broadcast/multicast frames
981 * for power saving stations in the hardware/firmware and others
982 * rely on the host system for such buffering. This option is used
983 * to configure the IEEE 802.11 upper layer to buffer broadcast and
984 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -0700985 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400986 *
Johannes Berg8318d782008-01-24 19:38:38 +0100987 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
988 * Hardware is not capable of short slot operation on the 2.4 GHz band.
989 *
990 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
991 * Hardware is not capable of receiving frames with short preamble on
992 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200993 *
994 * @IEEE80211_HW_SIGNAL_UNSPEC:
995 * Hardware can provide signal values but we don't know its units. We
996 * expect values between 0 and @max_signal.
997 * If possible please provide dB or dBm instead.
998 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200999 * @IEEE80211_HW_SIGNAL_DBM:
1000 * Hardware gives signal values in dBm, decibel difference from
1001 * one milliwatt. This is the preferred method since it is standardized
1002 * between different devices. @max_signal does not need to be set.
1003 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +03001004 * @IEEE80211_HW_SPECTRUM_MGMT:
1005 * Hardware supports spectrum management defined in 802.11h
1006 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +05301007 *
1008 * @IEEE80211_HW_AMPDU_AGGREGATION:
1009 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +02001010 *
Johannes Berg4be8c382009-01-07 18:28:20 +01001011 * @IEEE80211_HW_SUPPORTS_PS:
1012 * Hardware has power save support (i.e. can go to sleep).
1013 *
1014 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1015 * Hardware requires nullfunc frame handling in stack, implies
1016 * stack support for dynamic PS.
1017 *
1018 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1019 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +02001020 *
1021 * @IEEE80211_HW_MFP_CAPABLE:
1022 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +02001023 *
1024 * @IEEE80211_HW_BEACON_FILTER:
1025 * Hardware supports dropping of irrelevant beacon frames to
1026 * avoid waking up cpu.
Johannes Berg0f782312009-12-01 13:37:02 +01001027 *
1028 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1029 * Hardware supports static spatial multiplexing powersave,
1030 * ie. can turn off all but one chain even on HT connections
1031 * that should be using more chains.
1032 *
1033 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1034 * Hardware supports dynamic spatial multiplexing powersave,
1035 * ie. can turn off all but one chain and then wake the rest
1036 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +02001037 *
1038 * @IEEE80211_HW_SUPPORTS_UAPSD:
1039 * Hardware supports Unscheduled Automatic Power Save Delivery
1040 * (U-APSD) in managed mode. The mode is configured with
1041 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +05301042 *
1043 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1044 * Hardware can provide ack status reports of Tx frames to
1045 * the stack.
1046 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001047 * @IEEE80211_HW_CONNECTION_MONITOR:
1048 * The hardware performs its own connection monitoring, including
1049 * periodic keep-alives to the AP and probing the AP on beacon loss.
1050 * When this flag is set, signaling beacon-loss will cause an immediate
1051 * change to disassociated state.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001052 *
1053 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1054 * Hardware can do connection quality monitoring - i.e. it can monitor
1055 * connection quality related parameters, such as the RSSI level and
1056 * provide notifications if configured trigger levels are reached.
1057 *
Johannes Berge5b900d2010-07-29 16:08:55 +02001058 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1059 * This device needs to know the DTIM period for the BSS before
1060 * associating.
Johannes Berge31b8212010-10-05 19:39:30 +02001061 *
1062 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1063 * per-station GTKs as used by IBSS RSN or during fast transition. If
1064 * the device doesn't support per-station GTKs, but can be asked not
1065 * to decrypt group addressed frames, then IBSS RSN support is still
1066 * possible but software crypto will be used. Advertise the wiphy flag
1067 * only in that case.
Johannes Berg1bc08262007-09-18 17:29:15 -04001068 */
1069enum ieee80211_hw_flags {
Johannes Bergaf65cd92009-11-17 18:18:36 +01001070 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -04001071 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1072 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +01001073 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1074 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +02001075 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +01001076 IEEE80211_HW_SIGNAL_DBM = 1<<6,
Johannes Berge5b900d2010-07-29 16:08:55 +02001077 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
Johannes Berg7fee5372009-01-30 11:13:06 +01001078 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1079 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1080 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1081 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1082 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1083 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +02001084 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +01001085 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1086 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +02001087 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +05301088 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001089 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001090 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
Johannes Berge31b8212010-10-05 19:39:30 +02001091 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
Johannes Berg1bc08262007-09-18 17:29:15 -04001092};
1093
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001094/**
1095 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001096 *
1097 * This structure contains the configuration and hardware
1098 * information for an 802.11 PHY.
1099 *
1100 * @wiphy: This points to the &struct wiphy allocated for this
1101 * 802.11 PHY. You must fill in the @perm_addr and @dev
1102 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01001103 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1104 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001105 *
1106 * @conf: &struct ieee80211_conf, device configuration, don't use.
1107 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001108 * @priv: pointer to private area that was allocated for driver use
1109 * along with this structure.
1110 *
1111 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1112 *
1113 * @extra_tx_headroom: headroom to reserve in each transmit skb
1114 * for use by the driver (e.g. for transmit headers.)
1115 *
1116 * @channel_change_time: time (in microseconds) it takes to change channels.
1117 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001118 * @max_signal: Maximum value for signal (rssi) in RX information, used
1119 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001120 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001121 * @max_listen_interval: max listen interval in units of beacon interval
1122 * that HW supports
1123 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001124 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001125 * data packets. WMM/QoS requires at least four, these
1126 * queues need to have configurable access parameters.
1127 *
Johannes Berg830f9032007-10-28 14:51:05 +01001128 * @rate_control_algorithm: rate control algorithm for this hardware.
1129 * If unset (NULL), the default algorithm will be used. Must be
1130 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001131 *
1132 * @vif_data_size: size (in bytes) of the drv_priv data area
1133 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001134 * @sta_data_size: size (in bytes) of the drv_priv data area
1135 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001136 *
Helmut Schaa78be49e2010-10-02 11:31:55 +02001137 * @max_rates: maximum number of alternate rate retry stages the hw
1138 * can handle.
1139 * @max_report_rates: maximum number of alternate rate retry stages
1140 * the hw can report back.
Johannes Berge6a98542008-10-21 12:40:02 +02001141 * @max_rate_tries: maximum number of tries for each stage
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001142 *
1143 * @napi_weight: weight used for NAPI polling. You must specify an
1144 * appropriate value here if a napi_poll operation is provided
1145 * by your driver.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001146 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001147struct ieee80211_hw {
Jiri Bencf0706e822007-05-05 11:45:53 -07001148 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001149 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001150 const char *rate_control_algorithm;
Jiri Bencf0706e822007-05-05 11:45:53 -07001151 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001152 u32 flags;
Jiri Bencf0706e822007-05-05 11:45:53 -07001153 unsigned int extra_tx_headroom;
Jiri Bencf0706e822007-05-05 11:45:53 -07001154 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001155 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001156 int sta_data_size;
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001157 int napi_weight;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001158 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001159 u16 max_listen_interval;
Jiri Bencf0706e822007-05-05 11:45:53 -07001160 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001161 u8 max_rates;
Helmut Schaa78be49e2010-10-02 11:31:55 +02001162 u8 max_report_rates;
Johannes Berge6a98542008-10-21 12:40:02 +02001163 u8 max_rate_tries;
Jiri Bencf0706e822007-05-05 11:45:53 -07001164};
1165
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001166/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001167 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1168 *
1169 * @wiphy: the &struct wiphy which we want to query
1170 *
1171 * mac80211 drivers can use this to get to their respective
1172 * &struct ieee80211_hw. Drivers wishing to get to their own private
1173 * structure can then access it via hw->priv. Note that mac802111 drivers should
1174 * not use wiphy_priv() to try to get their private driver structure as this
1175 * is already used internally by mac80211.
1176 */
1177struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1178
1179/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001180 * SET_IEEE80211_DEV - set device for 802.11 hardware
1181 *
1182 * @hw: the &struct ieee80211_hw to set the device for
1183 * @dev: the &struct device of this 802.11 device
1184 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001185static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1186{
1187 set_wiphy_dev(hw->wiphy, dev);
1188}
1189
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001190/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001191 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001192 *
1193 * @hw: the &struct ieee80211_hw to set the MAC address for
1194 * @addr: the address to set
1195 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001196static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1197{
1198 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1199}
1200
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001201static inline struct ieee80211_rate *
1202ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001203 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001204{
Johannes Berge6a98542008-10-21 12:40:02 +02001205 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001206 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001207 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001208}
1209
1210static inline struct ieee80211_rate *
1211ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001212 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001213{
Johannes Berge039fa42008-05-15 12:55:29 +02001214 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001215 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001216 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001217}
1218
1219static inline struct ieee80211_rate *
1220ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001221 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001222{
Johannes Berge6a98542008-10-21 12:40:02 +02001223 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001224 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001225 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001226}
1227
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001228/**
1229 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001230 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001231 * mac80211 is capable of taking advantage of many hardware
1232 * acceleration designs for encryption and decryption operations.
1233 *
1234 * The set_key() callback in the &struct ieee80211_ops for a given
1235 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001236 * decryption. The callback takes a @sta parameter that will be NULL
1237 * for default keys or keys used for transmission only, or point to
1238 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001239 * Multiple transmission keys with the same key index may be used when
1240 * VLANs are configured for an access point.
1241 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001242 * When transmitting, the TX control data will use the @hw_key_idx
1243 * selected by the driver by modifying the &struct ieee80211_key_conf
1244 * pointed to by the @key parameter to the set_key() function.
1245 *
1246 * The set_key() call for the %SET_KEY command should return 0 if
1247 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1248 * added; if you return 0 then hw_key_idx must be assigned to the
1249 * hardware key index, you are free to use the full u8 range.
1250 *
1251 * When the cmd is %DISABLE_KEY then it must succeed.
1252 *
1253 * Note that it is permissible to not decrypt a frame even if a key
1254 * for it has been uploaded to hardware, the stack will not make any
1255 * decision based on whether a key has been uploaded or not but rather
1256 * based on the receive flags.
1257 *
1258 * The &struct ieee80211_key_conf structure pointed to by the @key
1259 * parameter is guaranteed to be valid until another call to set_key()
1260 * removes it, but it can only be used as a cookie to differentiate
1261 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001262 *
1263 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1264 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1265 * handler.
1266 * The update_tkip_key() call updates the driver with the new phase 1 key.
1267 * This happens everytime the iv16 wraps around (every 65536 packets). The
1268 * set_key() call will happen only once for each key (unless the AP did
1269 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001270 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001271 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001272 */
Johannes Berg4150c572007-09-17 01:29:23 -04001273
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001274/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001275 * DOC: Powersave support
1276 *
1277 * mac80211 has support for various powersave implementations.
1278 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001279 * First, it can support hardware that handles all powersaving by itself,
1280 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1281 * flag. In that case, it will be told about the desired powersave mode
1282 * with the %IEEE80211_CONF_PS flag depending on the association status.
1283 * The hardware must take care of sending nullfunc frames when necessary,
1284 * i.e. when entering and leaving powersave mode. The hardware is required
1285 * to look at the AID in beacons and signal to the AP that it woke up when
1286 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001287 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001288 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1289 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1290 * with hardware wakeup and sleep states. Driver is responsible for waking
Bob Copeland2738bd62010-08-21 16:39:01 -04001291 * up the hardware before issuing commands to the hardware and putting it
1292 * back to sleep at appropriate times.
Kalle Valoc99445b2010-01-14 13:09:21 +02001293 *
1294 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1295 * buffered multicast/broadcast frames after the beacon. Also it must be
1296 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001297 *
1298 * Other hardware designs cannot send nullfunc frames by themselves and also
1299 * need software support for parsing the TIM bitmap. This is also supported
1300 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1301 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001302 * required to pass up beacons. The hardware is still required to handle
1303 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001304 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001305 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001306 * Dynamic powersave is an extension to normal powersave in which the
1307 * hardware stays awake for a user-specified period of time after sending a
1308 * frame so that reply frames need not be buffered and therefore delayed to
1309 * the next wakeup. It's compromise of getting good enough latency when
1310 * there's data traffic and still saving significantly power in idle
1311 * periods.
1312 *
Bob Copeland2738bd62010-08-21 16:39:01 -04001313 * Dynamic powersave is simply supported by mac80211 enabling and disabling
Kalle Valoc99445b2010-01-14 13:09:21 +02001314 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1315 * flag and mac80211 will handle everything automatically. Additionally,
1316 * hardware having support for the dynamic PS feature may set the
1317 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1318 * dynamic PS mode itself. The driver needs to look at the
1319 * @dynamic_ps_timeout hardware configuration value and use it that value
1320 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1321 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1322 * enabled whenever user has enabled powersave.
1323 *
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03001324 * Some hardware need to toggle a single shared antenna between WLAN and
1325 * Bluetooth to facilitate co-existence. These types of hardware set
1326 * limitations on the use of host controlled dynamic powersave whenever there
1327 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1328 * driver may request temporarily going into full power save, in order to
1329 * enable toggling the antenna between BT and WLAN. If the driver requests
1330 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1331 * temporarily set to zero until the driver re-enables dynamic powersave.
1332 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001333 * Driver informs U-APSD client support by enabling
1334 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1335 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1336 * Nullfunc frames and stay awake until the service period has ended. To
1337 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1338 * from that AC are transmitted with powersave enabled.
1339 *
1340 * Note: U-APSD client mode is not yet supported with
1341 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001342 */
1343
1344/**
Kalle Valo04de8382009-03-22 21:57:35 +02001345 * DOC: Beacon filter support
1346 *
1347 * Some hardware have beacon filter support to reduce host cpu wakeups
1348 * which will reduce system power consumption. It usuallly works so that
1349 * the firmware creates a checksum of the beacon but omits all constantly
1350 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1351 * beacon is forwarded to the host, otherwise it will be just dropped. That
1352 * way the host will only receive beacons where some relevant information
1353 * (for example ERP protection or WMM settings) have changed.
1354 *
Johannes Berg955394c2009-04-16 17:04:25 +02001355 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1356 * hardware capability. The driver needs to enable beacon filter support
1357 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1358 * power save is enabled, the stack will not check for beacon loss and the
1359 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1360 *
1361 * The time (or number of beacons missed) until the firmware notifies the
1362 * driver of a beacon loss event (which in turn causes the driver to call
1363 * ieee80211_beacon_loss()) should be configurable and will be controlled
1364 * by mac80211 and the roaming algorithm in the future.
1365 *
1366 * Since there may be constantly changing information elements that nothing
1367 * in the software stack cares about, we will, in the future, have mac80211
1368 * tell the driver which information elements are interesting in the sense
1369 * that we want to see changes in them. This will include
1370 * - a list of information element IDs
1371 * - a list of OUIs for the vendor information element
1372 *
1373 * Ideally, the hardware would filter out any beacons without changes in the
1374 * requested elements, but if it cannot support that it may, at the expense
1375 * of some efficiency, filter out only a subset. For example, if the device
1376 * doesn't support checking for OUIs it should pass up all changes in all
1377 * vendor information elements.
1378 *
1379 * Note that change, for the sake of simplification, also includes information
1380 * elements appearing or disappearing from the beacon.
1381 *
1382 * Some hardware supports an "ignore list" instead, just make sure nothing
1383 * that was requested is on the ignore list, and include commonly changing
1384 * information element IDs in the ignore list, for example 11 (BSS load) and
1385 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1386 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1387 * it could also include some currently unused IDs.
1388 *
1389 *
1390 * In addition to these capabilities, hardware should support notifying the
1391 * host of changes in the beacon RSSI. This is relevant to implement roaming
1392 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1393 * the received data packets). This can consist in notifying the host when
1394 * the RSSI changes significantly or when it drops below or rises above
1395 * configurable thresholds. In the future these thresholds will also be
1396 * configured by mac80211 (which gets them from userspace) to implement
1397 * them as the roaming algorithm requires.
1398 *
1399 * If the hardware cannot implement this, the driver should ask it to
1400 * periodically pass beacon frames to the host so that software can do the
1401 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001402 */
1403
1404/**
Johannes Berg0f782312009-12-01 13:37:02 +01001405 * DOC: Spatial multiplexing power save
1406 *
1407 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1408 * power in an 802.11n implementation. For details on the mechanism
1409 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1410 * "11.2.3 SM power save".
1411 *
1412 * The mac80211 implementation is capable of sending action frames
1413 * to update the AP about the station's SMPS mode, and will instruct
1414 * the driver to enter the specific mode. It will also announce the
1415 * requested SMPS mode during the association handshake. Hardware
1416 * support for this feature is required, and can be indicated by
1417 * hardware flags.
1418 *
1419 * The default mode will be "automatic", which nl80211/cfg80211
1420 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1421 * turned off otherwise.
1422 *
1423 * To support this feature, the driver must set the appropriate
1424 * hardware support flags, and handle the SMPS flag to the config()
1425 * operation. It will then with this mechanism be instructed to
1426 * enter the requested SMPS mode while associated to an HT AP.
1427 */
1428
1429/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001430 * DOC: Frame filtering
1431 *
1432 * mac80211 requires to see many management frames for proper
1433 * operation, and users may want to see many more frames when
1434 * in monitor mode. However, for best CPU usage and power consumption,
1435 * having as few frames as possible percolate through the stack is
1436 * desirable. Hence, the hardware should filter as much as possible.
1437 *
1438 * To achieve this, mac80211 uses filter flags (see below) to tell
1439 * the driver's configure_filter() function which frames should be
1440 * passed to mac80211 and which should be filtered out.
1441 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001442 * Before configure_filter() is invoked, the prepare_multicast()
1443 * callback is invoked with the parameters @mc_count and @mc_list
1444 * for the combined multicast address list of all virtual interfaces.
1445 * It's use is optional, and it returns a u64 that is passed to
1446 * configure_filter(). Additionally, configure_filter() has the
1447 * arguments @changed_flags telling which flags were changed and
1448 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001449 *
1450 * If your device has no multicast address filters your driver will
1451 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1452 * parameter to see whether multicast frames should be accepted
1453 * or dropped.
1454 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001455 * All unsupported flags in @total_flags must be cleared.
1456 * Hardware does not support a flag if it is incapable of _passing_
1457 * the frame to the stack. Otherwise the driver must ignore
1458 * the flag, but not clear it.
1459 * You must _only_ clear the flag (announce no support for the
1460 * flag to mac80211) if you are not able to pass the packet type
1461 * to the stack (so the hardware always filters it).
1462 * So for example, you should clear @FIF_CONTROL, if your hardware
1463 * always filters control frames. If your hardware always passes
1464 * control frames to the kernel and is incapable of filtering them,
1465 * you do _not_ clear the @FIF_CONTROL flag.
1466 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001467 */
1468
1469/**
1470 * enum ieee80211_filter_flags - hardware filter flags
1471 *
1472 * These flags determine what the filter in hardware should be
1473 * programmed to let through and what should not be passed to the
1474 * stack. It is always safe to pass more frames than requested,
1475 * but this has negative impact on power consumption.
1476 *
1477 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1478 * think of the BSS as your network segment and then this corresponds
1479 * to the regular ethernet device promiscuous mode.
1480 *
1481 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1482 * by the user or if the hardware is not capable of filtering by
1483 * multicast address.
1484 *
1485 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1486 * %RX_FLAG_FAILED_FCS_CRC for them)
1487 *
1488 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1489 * the %RX_FLAG_FAILED_PLCP_CRC for them
1490 *
1491 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1492 * to the hardware that it should not filter beacons or probe responses
1493 * by BSSID. Filtering them can greatly reduce the amount of processing
1494 * mac80211 needs to do and the amount of CPU wakeups, so you should
1495 * honour this flag if possible.
1496 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04001497 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
Johannes Berg7be50862010-10-13 12:06:24 +02001498 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001499 *
1500 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04001501 *
Johannes Berg7be50862010-10-13 12:06:24 +02001502 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1503 * those addressed to this station.
1504 *
1505 * @FIF_PROBE_REQ: pass probe request frames
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001506 */
1507enum ieee80211_filter_flags {
1508 FIF_PROMISC_IN_BSS = 1<<0,
1509 FIF_ALLMULTI = 1<<1,
1510 FIF_FCSFAIL = 1<<2,
1511 FIF_PLCPFAIL = 1<<3,
1512 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1513 FIF_CONTROL = 1<<5,
1514 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04001515 FIF_PSPOLL = 1<<7,
Johannes Berg7be50862010-10-13 12:06:24 +02001516 FIF_PROBE_REQ = 1<<8,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001517};
1518
1519/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001520 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1521 *
1522 * These flags are used with the ampdu_action() callback in
1523 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01001524 *
1525 * Note that drivers MUST be able to deal with a TX aggregation
1526 * session being stopped even before they OK'ed starting it by
Johannes Berg5d22c892010-06-10 10:21:40 +02001527 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
Johannes Berg827d42c2009-11-22 12:28:41 +01001528 * might receive the addBA frame and send a delBA right away!
1529 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001530 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1531 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001532 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1533 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001534 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001535 */
1536enum ieee80211_ampdu_mlme_action {
1537 IEEE80211_AMPDU_RX_START,
1538 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001539 IEEE80211_AMPDU_TX_START,
1540 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001541 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001542};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001543
1544/**
1545 * struct ieee80211_ops - callbacks from mac80211 to the driver
1546 *
1547 * This structure contains various callbacks that the driver may
1548 * handle or, in some cases, must handle, for example to configure
1549 * the hardware to a new channel or to transmit a frame.
1550 *
1551 * @tx: Handler that 802.11 module calls for each transmitted frame.
1552 * skb contains the buffer starting from the IEEE 802.11 header.
1553 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001554 * configuration in the TX control data. This handler should,
1555 * preferably, never fail and stop queues appropriately, more
1556 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001557 * This function should return NETDEV_TX_OK except in very
1558 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001559 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001560 *
1561 * @start: Called before the first netdevice attached to the hardware
1562 * is enabled. This should turn on the hardware and must turn on
1563 * frame reception (for possibly enabled monitor interfaces.)
1564 * Returns negative error codes, these may be seen in userspace,
1565 * or zero.
1566 * When the device is started it should not have a MAC address
1567 * to avoid acknowledging frames before a non-monitor device
1568 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001569 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001570 *
1571 * @stop: Called after last netdevice attached to the hardware
1572 * is disabled. This should turn off the hardware (at least
1573 * it must turn off frame reception.)
1574 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04001575 * an interface. If you added any work onto the mac80211 workqueue
1576 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001577 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001578 *
1579 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001580 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001581 * and @stop must be implemented.
1582 * The driver should perform any initialization it needs before
1583 * the device can be enabled. The initial configuration for the
1584 * interface is given in the conf parameter.
1585 * The callback may refuse to add an interface by returning a
1586 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001587 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001588 *
Johannes Berg34d4bc42010-08-27 12:35:58 +02001589 * @change_interface: Called when a netdevice changes type. This callback
1590 * is optional, but only if it is supported can interface types be
1591 * switched while the interface is UP. The callback may sleep.
1592 * Note that while an interface is being switched, it will not be
1593 * found by the interface iteration callbacks.
1594 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001595 * @remove_interface: Notifies a driver that an interface is going down.
1596 * The @stop callback is called after this if it is the last interface
1597 * and no monitor interfaces are present.
1598 * When all interfaces are removed, the MAC address in the hardware
1599 * must be cleared so the device no longer acknowledges packets,
1600 * the mac_addr member of the conf structure is, however, set to the
1601 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001602 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001603 *
1604 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1605 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001606 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01001607 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001608 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001609 * @bss_info_changed: Handler for configuration requests related to BSS
1610 * parameters that may vary during BSS's lifespan, and may affect low
1611 * level driver (e.g. assoc/disassoc status, erp parameters).
1612 * This function should not be used if no BSS has been set, unless
1613 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01001614 * of the bss parameters has changed when a call is made. The callback
1615 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001616 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001617 * @prepare_multicast: Prepare for multicast filter configuration.
1618 * This callback is optional, and its return value is passed
1619 * to configure_filter(). This callback must be atomic.
1620 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001621 * @configure_filter: Configure the device's RX filter.
1622 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001623 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001624 *
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -07001625 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001626 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001627 *
1628 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01001629 * This callback is only called between add_interface and
1630 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001631 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001632 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001633 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001634 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001635 * @update_tkip_key: See the section "Hardware crypto acceleration"
1636 * This callback will be called in the context of Rx. Called for drivers
1637 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02001638 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001639 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001640 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001641 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001642 * configuration done by the regulatory agent in the wiphy's
1643 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001644 * that power save is disabled.
1645 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1646 * entire IEs after the SSID, so that drivers need not look at these
1647 * at all but just send them after the SSID -- mac80211 includes the
1648 * (extended) supported rates and HT information (where applicable).
1649 * When the scan finishes, ieee80211_scan_completed() must be called;
1650 * note that it also must be called when the scan cannot finish due to
1651 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001652 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001653 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001654 * @sw_scan_start: Notifier function that is called just before a software scan
1655 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001656 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001657 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01001658 * @sw_scan_complete: Notifier function that is called just after a
1659 * software scan finished. Can be NULL, if the driver doesn't need
1660 * this notification.
1661 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001662 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001663 * @get_stats: Return low-level statistics.
1664 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001665 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001666 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001667 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1668 * callback should be provided to read the TKIP transmit IVs (both IV32
1669 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001670 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001671 *
Arik Nemtsovf23a4782010-11-08 11:51:06 +02001672 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1673 * if the device does fragmentation by itself; if this callback is
1674 * implemented then the stack will not do fragmentation.
1675 * The callback can sleep.
1676 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001677 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001678 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001679 *
Johannes Berg34e89502010-02-03 13:59:58 +01001680 * @sta_add: Notifies low level driver about addition of an associated station,
1681 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1682 *
1683 * @sta_remove: Notifies low level driver about removal of an associated
1684 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1685 *
1686 * @sta_notify: Notifies low level driver about power state transition of an
1687 * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001688 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001689 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001690 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001691 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001692 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001693 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001694 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001695 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001696 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001697 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001698 *
1699 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1700 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001701 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001702 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001703 *
1704 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1705 * with other STAs in the IBSS. This is only used in IBSS mode. This
1706 * function is optional if the firmware/hardware takes full care of
1707 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001708 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001709 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001710 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1711 * This is needed only for IBSS mode and the result of this function is
1712 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001713 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001714 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001715 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001716 * @ampdu_action: Perform a certain A-MPDU action
1717 * The RA/TID combination determines the destination and TID we want
1718 * the ampdu action to be performed for. The action is defined through
1719 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001720 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001721 * that TX/RX_STOP can pass NULL for this parameter.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001722 * Returns a negative error code on failure.
Johannes Berg85ad1812010-06-10 10:21:49 +02001723 * The callback can sleep.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001724 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07001725 * @get_survey: Return per-channel survey information
1726 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001727 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1728 * need to set wiphy->rfkill_poll to %true before registration,
1729 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001730 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02001731 *
Lukáš Turek310bc672009-12-21 22:50:48 +01001732 * @set_coverage_class: Set slot time for given coverage class as specified
1733 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1734 * accordingly. This callback is not required and may sleep.
1735 *
Johannes Bergaff89a92009-07-01 21:26:51 +02001736 * @testmode_cmd: Implement a cfg80211 test mode command.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001737 * The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01001738 *
1739 * @flush: Flush all pending frames from the hardware queue, making sure
1740 * that the hardware queues are empty. If the parameter @drop is set
Kalle Valoe1781ed2009-12-23 13:15:47 +01001741 * to %true, pending frames may be dropped. The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02001742 *
1743 * @channel_switch: Drivers that need (or want) to offload the channel
1744 * switch operation for CSAs received from the AP may implement this
1745 * callback. They must then call ieee80211_chswitch_done() to indicate
1746 * completion of the channel switch.
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001747 *
1748 * @napi_poll: Poll Rx queue for incoming data frames.
Bruno Randolf79b1c462010-11-24 14:34:41 +09001749 *
1750 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1751 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1752 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1753 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1754 *
1755 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
Johannes Berg4976b4e2011-01-04 13:02:32 +01001756 *
1757 * @remain_on_channel: Starts an off-channel period on the given channel, must
1758 * call back to ieee80211_ready_on_channel() when on that channel. Note
1759 * that normal channel traffic is not stopped as this is intended for hw
1760 * offload. Frames to transmit on the off-channel channel are transmitted
1761 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
1762 * duration (which will always be non-zero) expires, the driver must call
1763 * ieee80211_remain_on_channel_expired(). This callback may sleep.
1764 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
1765 * aborted before it expires. This callback may sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001766 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001767struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001768 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001769 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001770 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001771 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001772 struct ieee80211_vif *vif);
Johannes Berg34d4bc42010-08-27 12:35:58 +02001773 int (*change_interface)(struct ieee80211_hw *hw,
1774 struct ieee80211_vif *vif,
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001775 enum nl80211_iftype new_type, bool p2p);
Jiri Bencf0706e822007-05-05 11:45:53 -07001776 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001777 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02001778 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001779 void (*bss_info_changed)(struct ieee80211_hw *hw,
1780 struct ieee80211_vif *vif,
1781 struct ieee80211_bss_conf *info,
1782 u32 changed);
Johannes Berg3ac64be2009-08-17 16:16:53 +02001783 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad2010-04-01 21:22:57 +00001784 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04001785 void (*configure_filter)(struct ieee80211_hw *hw,
1786 unsigned int changed_flags,
1787 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02001788 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02001789 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1790 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001791 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001792 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001793 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001794 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01001795 struct ieee80211_vif *vif,
1796 struct ieee80211_key_conf *conf,
1797 struct ieee80211_sta *sta,
1798 u32 iv32, u16 *phase1key);
Johannes Berga060bbf2010-04-27 11:59:34 +02001799 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg2a519312009-02-10 21:25:55 +01001800 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001801 void (*sw_scan_start)(struct ieee80211_hw *hw);
1802 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001803 int (*get_stats)(struct ieee80211_hw *hw,
1804 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001805 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1806 u32 *iv32, u16 *iv16);
Arik Nemtsovf23a4782010-11-08 11:51:06 +02001807 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e822007-05-05 11:45:53 -07001808 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01001809 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1810 struct ieee80211_sta *sta);
1811 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1812 struct ieee80211_sta *sta);
Johannes Berg32bfd352007-12-19 01:31:26 +01001813 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001814 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001815 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e822007-05-05 11:45:53 -07001816 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e822007-05-05 11:45:53 -07001817 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001818 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e822007-05-05 11:45:53 -07001819 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001820 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001821 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01001822 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001823 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001824 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Holger Schurig12897232010-04-19 10:23:57 +02001825 int (*get_survey)(struct ieee80211_hw *hw, int idx,
1826 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001827 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01001828 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02001829#ifdef CONFIG_NL80211_TESTMODE
1830 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1831#endif
Johannes Berga80f7c02009-12-23 13:15:32 +01001832 void (*flush)(struct ieee80211_hw *hw, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02001833 void (*channel_switch)(struct ieee80211_hw *hw,
1834 struct ieee80211_channel_switch *ch_switch);
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001835 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
Bruno Randolf15d96752010-11-10 12:50:56 +09001836 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
1837 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
Johannes Berg21f83582010-12-18 17:20:47 +01001838
1839 int (*remain_on_channel)(struct ieee80211_hw *hw,
1840 struct ieee80211_channel *chan,
1841 enum nl80211_channel_type channel_type,
1842 int duration);
1843 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001844};
1845
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001846/**
1847 * ieee80211_alloc_hw - Allocate a new hardware device
1848 *
1849 * This must be called once for each hardware device. The returned pointer
1850 * must be used to refer to this device when calling other functions.
1851 * mac80211 allocates a private data area for the driver pointed to by
1852 * @priv in &struct ieee80211_hw, the size of this area is given as
1853 * @priv_data_len.
1854 *
1855 * @priv_data_len: length of private data
1856 * @ops: callbacks for this device
Jiri Bencf0706e822007-05-05 11:45:53 -07001857 */
1858struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1859 const struct ieee80211_ops *ops);
1860
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001861/**
1862 * ieee80211_register_hw - Register hardware device
1863 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001864 * You must call this function before any other functions in
1865 * mac80211. Note that before a hardware can be registered, you
1866 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001867 *
1868 * @hw: the device to register as returned by ieee80211_alloc_hw()
1869 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001870int ieee80211_register_hw(struct ieee80211_hw *hw);
1871
Johannes Berge1e54062010-11-30 08:58:45 +01001872/**
1873 * struct ieee80211_tpt_blink - throughput blink description
1874 * @throughput: throughput in Kbit/sec
1875 * @blink_time: blink time in milliseconds
1876 * (full cycle, ie. one off + one on period)
1877 */
1878struct ieee80211_tpt_blink {
1879 int throughput;
1880 int blink_time;
1881};
1882
Johannes Berg67408c82010-11-30 08:59:23 +01001883/**
1884 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
1885 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
1886 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
1887 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
1888 * interface is connected in some way, including being an AP
1889 */
1890enum ieee80211_tpt_led_trigger_flags {
1891 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
1892 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
1893 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
1894};
1895
Jiri Bencf0706e822007-05-05 11:45:53 -07001896#ifdef CONFIG_MAC80211_LEDS
1897extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1898extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001899extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001900extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Johannes Berge1e54062010-11-30 08:58:45 +01001901extern char *__ieee80211_create_tpt_led_trigger(
Johannes Berg67408c82010-11-30 08:59:23 +01001902 struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01001903 const struct ieee80211_tpt_blink *blink_table,
1904 unsigned int blink_table_len);
Jiri Bencf0706e822007-05-05 11:45:53 -07001905#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001906/**
1907 * ieee80211_get_tx_led_name - get name of TX LED
1908 *
1909 * mac80211 creates a transmit LED trigger for each wireless hardware
1910 * that can be used to drive LEDs if your driver registers a LED device.
1911 * This function returns the name (or %NULL if not configured for LEDs)
1912 * of the trigger so you can automatically link the LED device.
1913 *
1914 * @hw: the hardware to get the LED trigger name for
1915 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001916static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1917{
1918#ifdef CONFIG_MAC80211_LEDS
1919 return __ieee80211_get_tx_led_name(hw);
1920#else
1921 return NULL;
1922#endif
1923}
1924
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001925/**
1926 * ieee80211_get_rx_led_name - get name of RX LED
1927 *
1928 * mac80211 creates a receive LED trigger for each wireless hardware
1929 * that can be used to drive LEDs if your driver registers a LED device.
1930 * This function returns the name (or %NULL if not configured for LEDs)
1931 * of the trigger so you can automatically link the LED device.
1932 *
1933 * @hw: the hardware to get the LED trigger name for
1934 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001935static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1936{
1937#ifdef CONFIG_MAC80211_LEDS
1938 return __ieee80211_get_rx_led_name(hw);
1939#else
1940 return NULL;
1941#endif
1942}
1943
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001944/**
1945 * ieee80211_get_assoc_led_name - get name of association LED
1946 *
1947 * mac80211 creates a association LED trigger for each wireless hardware
1948 * that can be used to drive LEDs if your driver registers a LED device.
1949 * This function returns the name (or %NULL if not configured for LEDs)
1950 * of the trigger so you can automatically link the LED device.
1951 *
1952 * @hw: the hardware to get the LED trigger name for
1953 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001954static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1955{
1956#ifdef CONFIG_MAC80211_LEDS
1957 return __ieee80211_get_assoc_led_name(hw);
1958#else
1959 return NULL;
1960#endif
1961}
1962
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001963/**
1964 * ieee80211_get_radio_led_name - get name of radio LED
1965 *
1966 * mac80211 creates a radio change LED trigger for each wireless hardware
1967 * that can be used to drive LEDs if your driver registers a LED device.
1968 * This function returns the name (or %NULL if not configured for LEDs)
1969 * of the trigger so you can automatically link the LED device.
1970 *
1971 * @hw: the hardware to get the LED trigger name for
1972 */
1973static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1974{
1975#ifdef CONFIG_MAC80211_LEDS
1976 return __ieee80211_get_radio_led_name(hw);
1977#else
1978 return NULL;
1979#endif
1980}
Michael Buesch47f0c502007-09-27 15:10:44 +02001981
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001982/**
Johannes Berge1e54062010-11-30 08:58:45 +01001983 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
1984 * @hw: the hardware to create the trigger for
Johannes Berg67408c82010-11-30 08:59:23 +01001985 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
Johannes Berge1e54062010-11-30 08:58:45 +01001986 * @blink_table: the blink table -- needs to be ordered by throughput
1987 * @blink_table_len: size of the blink table
1988 *
1989 * This function returns %NULL (in case of error, or if no LED
1990 * triggers are configured) or the name of the new trigger.
1991 * This function must be called before ieee80211_register_hw().
1992 */
1993static inline char *
Johannes Berg67408c82010-11-30 08:59:23 +01001994ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01001995 const struct ieee80211_tpt_blink *blink_table,
1996 unsigned int blink_table_len)
1997{
1998#ifdef CONFIG_MAC80211_LEDS
Johannes Berg67408c82010-11-30 08:59:23 +01001999 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
Johannes Berge1e54062010-11-30 08:58:45 +01002000 blink_table_len);
2001#else
2002 return NULL;
2003#endif
2004}
2005
2006/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002007 * ieee80211_unregister_hw - Unregister a hardware device
2008 *
2009 * This function instructs mac80211 to free allocated resources
2010 * and unregister netdevices from the networking subsystem.
2011 *
2012 * @hw: the hardware to unregister
2013 */
Jiri Bencf0706e822007-05-05 11:45:53 -07002014void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2015
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002016/**
2017 * ieee80211_free_hw - free hardware descriptor
2018 *
2019 * This function frees everything that was allocated, including the
2020 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002021 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002022 *
2023 * @hw: the hardware to free
2024 */
Jiri Bencf0706e822007-05-05 11:45:53 -07002025void ieee80211_free_hw(struct ieee80211_hw *hw);
2026
Johannes Bergf2753dd2009-04-14 10:09:24 +02002027/**
2028 * ieee80211_restart_hw - restart hardware completely
2029 *
2030 * Call this function when the hardware was restarted for some reason
2031 * (hardware error, ...) and the driver is unable to restore its state
2032 * by itself. mac80211 assumes that at this point the driver/hardware
2033 * is completely uninitialised and stopped, it starts the process by
2034 * calling the ->start() operation. The driver will need to reset all
2035 * internal state that it has prior to calling this function.
2036 *
2037 * @hw: the hardware to restart
2038 */
2039void ieee80211_restart_hw(struct ieee80211_hw *hw);
2040
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002041/** ieee80211_napi_schedule - schedule NAPI poll
2042 *
2043 * Use this function to schedule NAPI polling on a device.
2044 *
2045 * @hw: the hardware to start polling
2046 */
2047void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2048
2049/** ieee80211_napi_complete - complete NAPI polling
2050 *
2051 * Use this function to finish NAPI polling on a device.
2052 *
2053 * @hw: the hardware to stop polling
2054 */
2055void ieee80211_napi_complete(struct ieee80211_hw *hw);
2056
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002057/**
2058 * ieee80211_rx - receive frame
2059 *
2060 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b32010-03-29 17:35:07 +08002061 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2062 * paged @skb is used, the driver is recommended to put the ieee80211
2063 * header of the frame on the linear part of the @skb to avoid memory
2064 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002065 *
Johannes Berg2485f712008-02-25 16:27:41 +01002066 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03002067 * for a single hardware must be synchronized against each other. Calls to
2068 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2069 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002070 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03002071 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02002072 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002073 * @hw: the hardware this frame came in on
2074 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002075 */
John W. Linville103bf9f2009-08-20 16:34:15 -04002076void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002077
2078/**
2079 * ieee80211_rx_irqsafe - receive frame
2080 *
2081 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01002082 * (internally defers to a tasklet.)
2083 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03002084 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2085 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002086 *
2087 * @hw: the hardware this frame came in on
2088 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002089 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02002090void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07002091
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002092/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03002093 * ieee80211_rx_ni - receive frame (in process context)
2094 *
2095 * Like ieee80211_rx() but can be called in process context
2096 * (internally disables bottom halves).
2097 *
2098 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2099 * not be mixed for a single hardware.
2100 *
2101 * @hw: the hardware this frame came in on
2102 * @skb: the buffer to receive, owned by mac80211 after this call
2103 */
2104static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2105 struct sk_buff *skb)
2106{
2107 local_bh_disable();
2108 ieee80211_rx(hw, skb);
2109 local_bh_enable();
2110}
2111
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01002112/*
2113 * The TX headroom reserved by mac80211 for its own tx_status functions.
2114 * This is enough for the radiotap header.
2115 */
2116#define IEEE80211_TX_STATUS_HEADROOM 13
2117
Kalle Valoe36e49f2009-10-13 20:33:13 +03002118/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002119 * ieee80211_tx_status - transmit status callback
2120 *
2121 * Call this function for all transmitted frames after they have been
2122 * transmitted. It is permissible to not call this function for
2123 * multicast frames but this can affect statistics.
2124 *
Johannes Berg2485f712008-02-25 16:27:41 +01002125 * This function may not be called in IRQ context. Calls to this function
2126 * for a single hardware must be synchronized against each other. Calls
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002127 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2128 * may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01002129 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002130 * @hw: the hardware the frame was transmitted by
2131 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002132 */
Jiri Bencf0706e822007-05-05 11:45:53 -07002133void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002134 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01002135
2136/**
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002137 * ieee80211_tx_status_ni - transmit status callback (in process context)
2138 *
2139 * Like ieee80211_tx_status() but can be called in process context.
2140 *
2141 * Calls to this function, ieee80211_tx_status() and
2142 * ieee80211_tx_status_irqsafe() may not be mixed
2143 * for a single hardware.
2144 *
2145 * @hw: the hardware the frame was transmitted by
2146 * @skb: the frame that was transmitted, owned by mac80211 after this call
2147 */
2148static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2149 struct sk_buff *skb)
2150{
2151 local_bh_disable();
2152 ieee80211_tx_status(hw, skb);
2153 local_bh_enable();
2154}
2155
2156/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002157 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01002158 *
2159 * Like ieee80211_tx_status() but can be called in IRQ context
2160 * (internally defers to a tasklet.)
2161 *
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002162 * Calls to this function, ieee80211_tx_status() and
2163 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01002164 *
2165 * @hw: the hardware the frame was transmitted by
2166 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01002167 */
Jiri Bencf0706e822007-05-05 11:45:53 -07002168void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002169 struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07002170
2171/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01002172 * ieee80211_beacon_get_tim - beacon generation function
2173 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002174 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01002175 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2176 * Set to 0 if invalid (in non-AP modes).
2177 * @tim_length: pointer to variable that will receive the TIM IE length,
2178 * (including the ID and length bytes!).
2179 * Set to 0 if invalid (in non-AP modes).
2180 *
2181 * If the driver implements beaconing modes, it must use this function to
2182 * obtain the beacon frame/template.
2183 *
2184 * If the beacon frames are generated by the host system (i.e., not in
2185 * hardware/firmware), the driver uses this function to get each beacon
2186 * frame from mac80211 -- it is responsible for calling this function
2187 * before the beacon is needed (e.g. based on hardware interrupt).
2188 *
2189 * If the beacon frames are generated by the device, then the driver
2190 * must use the returned beacon as the template and change the TIM IE
2191 * according to the current DTIM parameters/TIM bitmap.
2192 *
2193 * The driver is responsible for freeing the returned skb.
2194 */
2195struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2196 struct ieee80211_vif *vif,
2197 u16 *tim_offset, u16 *tim_length);
2198
2199/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002200 * ieee80211_beacon_get - beacon generation function
2201 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002202 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002203 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01002204 * See ieee80211_beacon_get_tim().
Jiri Bencf0706e822007-05-05 11:45:53 -07002205 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01002206static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2207 struct ieee80211_vif *vif)
2208{
2209 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2210}
Jiri Bencf0706e822007-05-05 11:45:53 -07002211
2212/**
Kalle Valo7044cc52010-01-05 20:16:19 +02002213 * ieee80211_pspoll_get - retrieve a PS Poll template
2214 * @hw: pointer obtained from ieee80211_alloc_hw().
2215 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2216 *
2217 * Creates a PS Poll a template which can, for example, uploaded to
2218 * hardware. The template must be updated after association so that correct
2219 * AID, BSSID and MAC address is used.
2220 *
2221 * Note: Caller (or hardware) is responsible for setting the
2222 * &IEEE80211_FCTL_PM bit.
2223 */
2224struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2225 struct ieee80211_vif *vif);
2226
2227/**
2228 * ieee80211_nullfunc_get - retrieve a nullfunc template
2229 * @hw: pointer obtained from ieee80211_alloc_hw().
2230 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2231 *
2232 * Creates a Nullfunc template which can, for example, uploaded to
2233 * hardware. The template must be updated after association so that correct
2234 * BSSID and address is used.
2235 *
2236 * Note: Caller (or hardware) is responsible for setting the
2237 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2238 */
2239struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2240 struct ieee80211_vif *vif);
2241
2242/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02002243 * ieee80211_probereq_get - retrieve a Probe Request template
2244 * @hw: pointer obtained from ieee80211_alloc_hw().
2245 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2246 * @ssid: SSID buffer
2247 * @ssid_len: length of SSID
2248 * @ie: buffer containing all IEs except SSID for the template
2249 * @ie_len: length of the IE buffer
2250 *
2251 * Creates a Probe Request template which can, for example, be uploaded to
2252 * hardware.
2253 */
2254struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2255 struct ieee80211_vif *vif,
2256 const u8 *ssid, size_t ssid_len,
2257 const u8 *ie, size_t ie_len);
2258
2259/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002260 * ieee80211_rts_get - RTS frame generation function
2261 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002262 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002263 * @frame: pointer to the frame that is going to be protected by the RTS.
2264 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002265 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002266 * @rts: The buffer where to store the RTS frame.
2267 *
2268 * If the RTS frames are generated by the host system (i.e., not in
2269 * hardware/firmware), the low-level driver uses this function to receive
2270 * the next RTS frame from the 802.11 code. The low-level is responsible
2271 * for calling this function before and RTS frame is needed.
2272 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002273void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002274 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002275 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07002276 struct ieee80211_rts *rts);
2277
2278/**
2279 * ieee80211_rts_duration - Get the duration field for an RTS frame
2280 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002281 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002282 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02002283 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002284 *
2285 * If the RTS is generated in firmware, but the host system must provide
2286 * the duration field, the low-level driver uses this function to receive
2287 * the duration field value in little-endian byteorder.
2288 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002289__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2290 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002291 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07002292
2293/**
2294 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2295 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002296 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002297 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2298 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002299 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002300 * @cts: The buffer where to store the CTS-to-self frame.
2301 *
2302 * If the CTS-to-self frames are generated by the host system (i.e., not in
2303 * hardware/firmware), the low-level driver uses this function to receive
2304 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2305 * for calling this function before and CTS-to-self frame is needed.
2306 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002307void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2308 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002309 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002310 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07002311 struct ieee80211_cts *cts);
2312
2313/**
2314 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2315 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002316 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002317 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
Johannes Berge039fa42008-05-15 12:55:29 +02002318 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07002319 *
2320 * If the CTS-to-self is generated in firmware, but the host system must provide
2321 * the duration field, the low-level driver uses this function to receive
2322 * the duration field value in little-endian byteorder.
2323 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002324__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2325 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002326 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002327 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07002328
2329/**
2330 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2331 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002332 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002333 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01002334 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e822007-05-05 11:45:53 -07002335 *
2336 * Calculate the duration field of some generic frame, given its
2337 * length and transmission rate (in 100kbps).
2338 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002339__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2340 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07002341 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01002342 struct ieee80211_rate *rate);
Jiri Bencf0706e822007-05-05 11:45:53 -07002343
2344/**
2345 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2346 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002347 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e822007-05-05 11:45:53 -07002348 *
2349 * Function for accessing buffered broadcast and multicast frames. If
2350 * hardware/firmware does not implement buffering of broadcast/multicast
2351 * frames when power saving is used, 802.11 code buffers them in the host
2352 * memory. The low-level driver uses this function to fetch next buffered
2353 * frame. In most cases, this is used when generating beacon frame. This
2354 * function returns a pointer to the next buffered skb or NULL if no more
2355 * buffered frames are available.
2356 *
2357 * Note: buffered frames are returned only after DTIM beacon frame was
2358 * generated with ieee80211_beacon_get() and the low-level driver must thus
2359 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2360 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2361 * does not need to check for DTIM beacons separately and should be able to
2362 * use common code for all beacons.
2363 */
2364struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02002365ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e822007-05-05 11:45:53 -07002366
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002367/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002368 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2369 *
2370 * This function computes a TKIP rc4 key for an skb. It computes
2371 * a phase 1 key if needed (iv16 wraps around). This function is to
2372 * be used by drivers which can do HW encryption but need to compute
2373 * to phase 1/2 key in SW.
2374 *
2375 * @keyconf: the parameter passed with the set key
2376 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002377 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002378 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002379 */
2380void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2381 struct sk_buff *skb,
2382 enum ieee80211_tkip_key_type type, u8 *key);
2383/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002384 * ieee80211_wake_queue - wake specific queue
2385 * @hw: pointer as obtained from ieee80211_alloc_hw().
2386 * @queue: queue number (counted from zero).
2387 *
2388 * Drivers should use this function instead of netif_wake_queue.
2389 */
2390void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2391
2392/**
2393 * ieee80211_stop_queue - stop specific queue
2394 * @hw: pointer as obtained from ieee80211_alloc_hw().
2395 * @queue: queue number (counted from zero).
2396 *
2397 * Drivers should use this function instead of netif_stop_queue.
2398 */
2399void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2400
2401/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03002402 * ieee80211_queue_stopped - test status of the queue
2403 * @hw: pointer as obtained from ieee80211_alloc_hw().
2404 * @queue: queue number (counted from zero).
2405 *
2406 * Drivers should use this function instead of netif_stop_queue.
2407 */
2408
2409int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2410
2411/**
Jiri Bencf0706e822007-05-05 11:45:53 -07002412 * ieee80211_stop_queues - stop all queues
2413 * @hw: pointer as obtained from ieee80211_alloc_hw().
2414 *
2415 * Drivers should use this function instead of netif_stop_queue.
2416 */
2417void ieee80211_stop_queues(struct ieee80211_hw *hw);
2418
2419/**
2420 * ieee80211_wake_queues - wake all queues
2421 * @hw: pointer as obtained from ieee80211_alloc_hw().
2422 *
2423 * Drivers should use this function instead of netif_wake_queue.
2424 */
2425void ieee80211_wake_queues(struct ieee80211_hw *hw);
2426
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002427/**
2428 * ieee80211_scan_completed - completed hardware scan
2429 *
2430 * When hardware scan offload is used (i.e. the hw_scan() callback is
2431 * assigned) this function needs to be called by the driver to notify
Johannes Berg8789d452010-08-26 13:30:26 +02002432 * mac80211 that the scan finished. This function can be called from
2433 * any context, including hardirq context.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002434 *
2435 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01002436 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002437 */
Johannes Berg2a519312009-02-10 21:25:55 +01002438void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e822007-05-05 11:45:53 -07002439
Johannes Bergdabeb342007-11-09 01:57:29 +01002440/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002441 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01002442 *
2443 * This function iterates over the interfaces associated with a given
2444 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002445 * This function allows the iterator function to sleep, when the iterator
2446 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2447 * be used.
Felix Fietkau2944f452010-09-14 18:37:20 +02002448 * Does not iterate over a new interface during add_interface()
Johannes Bergdabeb342007-11-09 01:57:29 +01002449 *
2450 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002451 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01002452 * @data: first argument of the iterator function
2453 */
2454void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2455 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01002456 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01002457 void *data);
2458
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002459/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002460 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2461 *
2462 * This function iterates over the interfaces associated with a given
2463 * hardware that are currently active and calls the callback for them.
2464 * This function requires the iterator callback function to be atomic,
2465 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
Felix Fietkau2944f452010-09-14 18:37:20 +02002466 * Does not iterate over a new interface during add_interface()
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002467 *
2468 * @hw: the hardware struct of which the interfaces should be iterated over
2469 * @iterator: the iterator function to call, cannot sleep
2470 * @data: first argument of the iterator function
2471 */
2472void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2473 void (*iterator)(void *data,
2474 u8 *mac,
2475 struct ieee80211_vif *vif),
2476 void *data);
2477
2478/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002479 * ieee80211_queue_work - add work onto the mac80211 workqueue
2480 *
2481 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2482 * This helper ensures drivers are not queueing work when they should not be.
2483 *
2484 * @hw: the hardware struct for the interface we are adding work for
2485 * @work: the work we want to add onto the mac80211 workqueue
2486 */
2487void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2488
2489/**
2490 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2491 *
2492 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2493 * workqueue.
2494 *
2495 * @hw: the hardware struct for the interface we are adding work for
2496 * @dwork: delayable work to queue onto the mac80211 workqueue
2497 * @delay: number of jiffies to wait before queueing
2498 */
2499void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2500 struct delayed_work *dwork,
2501 unsigned long delay);
2502
2503/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002504 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002505 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002506 * @tid: the TID to BA on.
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05302507 * @timeout: session timeout value (in TUs)
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002508 *
2509 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002510 *
2511 * Although mac80211/low level driver/user space application can estimate
2512 * the need to start aggregation on a certain RA/TID, the session level
2513 * will be managed by the mac80211.
2514 */
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05302515int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2516 u16 timeout);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002517
2518/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002519 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002520 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002521 * @ra: receiver address of the BA session recipient.
2522 * @tid: the TID to BA on.
2523 *
2524 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02002525 * finished with preparations for the BA session. It can be called
2526 * from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002527 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002528void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002529 u16 tid);
2530
2531/**
2532 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002533 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002534 * @tid: the TID to stop BA.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002535 *
Johannes Berg6a8579d2010-05-27 14:41:07 +02002536 * Return: negative error if the TID is invalid, or no aggregation active
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002537 *
2538 * Although mac80211/low level driver/user space application can estimate
2539 * the need to stop aggregation on a certain RA/TID, the session level
2540 * will be managed by the mac80211.
2541 */
Johannes Berg6a8579d2010-05-27 14:41:07 +02002542int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002543
2544/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002545 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002546 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002547 * @ra: receiver address of the BA session recipient.
2548 * @tid: the desired TID to BA on.
2549 *
2550 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02002551 * finished with preparations for the BA session tear down. It
2552 * can be called from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002553 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002554void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002555 u16 tid);
2556
Mohamed Abbas84363e62008-04-04 16:59:58 -07002557/**
Johannes Berg17741cd2008-09-11 00:02:02 +02002558 * ieee80211_find_sta - find a station
2559 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01002560 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02002561 * @addr: station's address
2562 *
2563 * This function must be called under RCU lock and the
2564 * resulting pointer is only valid under RCU lock as well.
2565 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01002566struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002567 const u8 *addr);
2568
Kalle Valo04de8382009-03-22 21:57:35 +02002569/**
Ben Greear686b9cb2010-09-23 09:44:36 -07002570 * ieee80211_find_sta_by_ifaddr - find a station on hardware
Johannes Berg5ed176e2009-11-04 14:42:28 +01002571 *
2572 * @hw: pointer as obtained from ieee80211_alloc_hw()
Ben Greear686b9cb2010-09-23 09:44:36 -07002573 * @addr: remote station's address
2574 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002575 *
2576 * This function must be called under RCU lock and the
2577 * resulting pointer is only valid under RCU lock as well.
2578 *
Ben Greear686b9cb2010-09-23 09:44:36 -07002579 * NOTE: You may pass NULL for localaddr, but then you will just get
2580 * the first STA that matches the remote address 'addr'.
2581 * We can have multiple STA associated with multiple
2582 * logical stations (e.g. consider a station connecting to another
2583 * BSSID on the same AP hardware without disconnecting first).
2584 * In this case, the result of this method with localaddr NULL
2585 * is not reliable.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002586 *
Ben Greear686b9cb2010-09-23 09:44:36 -07002587 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002588 */
Ben Greear686b9cb2010-09-23 09:44:36 -07002589struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
2590 const u8 *addr,
2591 const u8 *localaddr);
Johannes Berg5ed176e2009-11-04 14:42:28 +01002592
2593/**
Johannes Bergaf818582009-11-06 11:35:50 +01002594 * ieee80211_sta_block_awake - block station from waking up
2595 * @hw: the hardware
2596 * @pubsta: the station
2597 * @block: whether to block or unblock
2598 *
2599 * Some devices require that all frames that are on the queues
2600 * for a specific station that went to sleep are flushed before
2601 * a poll response or frames after the station woke up can be
2602 * delivered to that it. Note that such frames must be rejected
2603 * by the driver as filtered, with the appropriate status flag.
2604 *
2605 * This function allows implementing this mode in a race-free
2606 * manner.
2607 *
2608 * To do this, a driver must keep track of the number of frames
2609 * still enqueued for a specific station. If this number is not
2610 * zero when the station goes to sleep, the driver must call
2611 * this function to force mac80211 to consider the station to
2612 * be asleep regardless of the station's actual state. Once the
2613 * number of outstanding frames reaches zero, the driver must
2614 * call this function again to unblock the station. That will
2615 * cause mac80211 to be able to send ps-poll responses, and if
2616 * the station queried in the meantime then frames will also
2617 * be sent out as a result of this. Additionally, the driver
2618 * will be notified that the station woke up some time after
2619 * it is unblocked, regardless of whether the station actually
2620 * woke up while blocked or not.
2621 */
2622void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2623 struct ieee80211_sta *pubsta, bool block);
2624
2625/**
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02002626 * ieee80211_ap_probereq_get - retrieve a Probe Request template
2627 * @hw: pointer obtained from ieee80211_alloc_hw().
2628 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2629 *
2630 * Creates a Probe Request template which can, for example, be uploaded to
2631 * hardware. The template is filled with bssid, ssid and supported rate
2632 * information. This function must only be called from within the
2633 * .bss_info_changed callback function and only in managed mode. The function
2634 * is only useful when the interface is associated, otherwise it will return
2635 * NULL.
2636 */
2637struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
2638 struct ieee80211_vif *vif);
2639
2640/**
Kalle Valo04de8382009-03-22 21:57:35 +02002641 * ieee80211_beacon_loss - inform hardware does not receive beacons
2642 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01002643 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02002644 *
Bob Copeland2738bd62010-08-21 16:39:01 -04002645 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002646 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02002647 * hardware is not receiving beacons with this function.
2648 */
2649void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002650
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002651/**
2652 * ieee80211_connection_loss - inform hardware has lost connection to the AP
2653 *
2654 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2655 *
Bob Copeland2738bd62010-08-21 16:39:01 -04002656 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002657 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2658 * needs to inform if the connection to the AP has been lost.
2659 *
2660 * This function will cause immediate change to disassociated state,
2661 * without connection recovery attempts.
2662 */
2663void ieee80211_connection_loss(struct ieee80211_vif *vif);
2664
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02002665/**
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03002666 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
2667 *
2668 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2669 *
2670 * Some hardware require full power save to manage simultaneous BT traffic
2671 * on the WLAN frequency. Full PSM is required periodically, whenever there are
2672 * burst of BT traffic. The hardware gets information of BT traffic via
2673 * hardware co-existence lines, and consequentially requests mac80211 to
2674 * (temporarily) enter full psm.
2675 * This function will only temporarily disable dynamic PS, not enable PSM if
2676 * it was not already enabled.
2677 * The driver must make sure to re-enable dynamic PS using
2678 * ieee80211_enable_dyn_ps() if the driver has disabled it.
2679 *
2680 */
2681void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
2682
2683/**
2684 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
2685 *
2686 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2687 *
2688 * This function restores dynamic PS after being temporarily disabled via
2689 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
2690 * be coupled with an eventual call to this function.
2691 *
2692 */
2693void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
2694
2695/**
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02002696 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
2697 * rssi threshold triggered
2698 *
2699 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2700 * @rssi_event: the RSSI trigger event type
2701 * @gfp: context flags
2702 *
2703 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
2704 * monitoring is configured with an rssi threshold, the driver will inform
2705 * whenever the rssi level reaches the threshold.
2706 */
2707void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
2708 enum nl80211_cqm_rssi_threshold_event rssi_event,
2709 gfp_t gfp);
2710
Johannes Berg5ce6e432010-05-11 16:20:57 +02002711/**
2712 * ieee80211_chswitch_done - Complete channel switch process
2713 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2714 * @success: make the channel switch successful or not
2715 *
2716 * Complete the channel switch post-process: set the new operational channel
2717 * and wake up the suspended queues.
2718 */
2719void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
2720
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02002721/**
2722 * ieee80211_request_smps - request SM PS transition
2723 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg633dd1e2010-08-18 15:01:23 +02002724 * @smps_mode: new SM PS mode
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02002725 *
2726 * This allows the driver to request an SM PS transition in managed
2727 * mode. This is useful when the driver has more information than
2728 * the stack about possible interference, for example by bluetooth.
2729 */
2730void ieee80211_request_smps(struct ieee80211_vif *vif,
2731 enum ieee80211_smps_mode smps_mode);
2732
Johannes Berge31b8212010-10-05 19:39:30 +02002733/**
2734 * ieee80211_key_removed - disable hw acceleration for key
2735 * @key_conf: The key hw acceleration should be disabled for
2736 *
2737 * This allows drivers to indicate that the given key has been
2738 * removed from hardware acceleration, due to a new key that
2739 * was added. Don't use this if the key can continue to be used
2740 * for TX, if the key restriction is on RX only it is permitted
2741 * to keep the key for TX only and not call this function.
2742 *
2743 * Due to locking constraints, it may only be called during
2744 * @set_key. This function must be allowed to sleep, and the
2745 * key it tries to disable may still be used until it returns.
2746 */
2747void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
2748
Johannes Berg21f83582010-12-18 17:20:47 +01002749/**
2750 * ieee80211_ready_on_channel - notification of remain-on-channel start
2751 * @hw: pointer as obtained from ieee80211_alloc_hw()
2752 */
2753void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
2754
2755/**
2756 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
2757 * @hw: pointer as obtained from ieee80211_alloc_hw()
2758 */
2759void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
2760
Johannes Berg4b7679a2008-09-18 18:14:18 +02002761/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002762
Johannes Berg4b7679a2008-09-18 18:14:18 +02002763/**
Sujith81cb7622009-02-12 11:38:37 +05302764 * enum rate_control_changed - flags to indicate which parameter changed
2765 *
2766 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2767 * changed, rate control algorithm can update its internal state if needed.
2768 */
2769enum rate_control_changed {
2770 IEEE80211_RC_HT_CHANGED = BIT(0)
2771};
2772
2773/**
Johannes Berge6a98542008-10-21 12:40:02 +02002774 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002775 *
Johannes Berge6a98542008-10-21 12:40:02 +02002776 * @hw: The hardware the algorithm is invoked for.
2777 * @sband: The band this frame is being transmitted on.
2778 * @bss_conf: the current BSS configuration
2779 * @reported_rate: The rate control algorithm can fill this in to indicate
2780 * which rate should be reported to userspace as the current rate and
2781 * used for rate calculations in the mesh network.
2782 * @rts: whether RTS will be used for this frame because it is longer than the
2783 * RTS threshold
2784 * @short_preamble: whether mac80211 will request short-preamble transmission
2785 * if the selected rate supports it
2786 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002787 * (deprecated; this will be removed once drivers get updated to use
2788 * rate_idx_mask)
2789 * @rate_idx_mask: user-requested rate mask (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002790 * @skb: the skb that will be transmitted, the control information in it needs
2791 * to be filled in
Felix Fietkau8f0729b2010-11-11 15:07:23 +01002792 * @bss: whether this frame is sent out in AP or IBSS mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02002793 */
Johannes Berge6a98542008-10-21 12:40:02 +02002794struct ieee80211_tx_rate_control {
2795 struct ieee80211_hw *hw;
2796 struct ieee80211_supported_band *sband;
2797 struct ieee80211_bss_conf *bss_conf;
2798 struct sk_buff *skb;
2799 struct ieee80211_tx_rate reported_rate;
2800 bool rts, short_preamble;
2801 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002802 u32 rate_idx_mask;
Felix Fietkau8f0729b2010-11-11 15:07:23 +01002803 bool bss;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002804};
2805
2806struct rate_control_ops {
2807 struct module *module;
2808 const char *name;
2809 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002810 void (*free)(void *priv);
2811
2812 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2813 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2814 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302815 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2816 struct ieee80211_sta *sta,
Sujith4fa00432010-03-01 14:42:57 +05302817 void *priv_sta, u32 changed,
2818 enum nl80211_channel_type oper_chan_type);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002819 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2820 void *priv_sta);
2821
2822 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2823 struct ieee80211_sta *sta, void *priv_sta,
2824 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002825 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2826 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002827
2828 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2829 struct dentry *dir);
2830 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2831};
2832
2833static inline int rate_supported(struct ieee80211_sta *sta,
2834 enum ieee80211_band band,
2835 int index)
2836{
2837 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2838}
2839
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07002840/**
2841 * rate_control_send_low - helper for drivers for management/no-ack frames
2842 *
2843 * Rate control algorithms that agree to use the lowest rate to
2844 * send management frames and NO_ACK data with the respective hw
2845 * retries should use this in the beginning of their mac80211 get_rate
2846 * callback. If true is returned the rate control can simply return.
2847 * If false is returned we guarantee that sta and sta and priv_sta is
2848 * not null.
2849 *
2850 * Rate control algorithms wishing to do more intelligent selection of
2851 * rate for multicast/broadcast frames may choose to not use this.
2852 *
2853 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2854 * that this may be null.
2855 * @priv_sta: private rate control structure. This may be null.
2856 * @txrc: rate control information we sholud populate for mac80211.
2857 */
2858bool rate_control_send_low(struct ieee80211_sta *sta,
2859 void *priv_sta,
2860 struct ieee80211_tx_rate_control *txrc);
2861
2862
Johannes Berg4b7679a2008-09-18 18:14:18 +02002863static inline s8
2864rate_lowest_index(struct ieee80211_supported_band *sband,
2865 struct ieee80211_sta *sta)
2866{
2867 int i;
2868
2869 for (i = 0; i < sband->n_bitrates; i++)
2870 if (rate_supported(sta, sband->band, i))
2871 return i;
2872
2873 /* warn when we cannot find a rate. */
2874 WARN_ON(1);
2875
2876 return 0;
2877}
2878
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07002879static inline
2880bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2881 struct ieee80211_sta *sta)
2882{
2883 unsigned int i;
2884
2885 for (i = 0; i < sband->n_bitrates; i++)
2886 if (rate_supported(sta, sband->band, i))
2887 return true;
2888 return false;
2889}
Johannes Berg4b7679a2008-09-18 18:14:18 +02002890
2891int ieee80211_rate_control_register(struct rate_control_ops *ops);
2892void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2893
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002894static inline bool
2895conf_is_ht20(struct ieee80211_conf *conf)
2896{
Johannes Berg47979382009-01-07 10:13:27 +01002897 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002898}
2899
2900static inline bool
2901conf_is_ht40_minus(struct ieee80211_conf *conf)
2902{
Johannes Berg47979382009-01-07 10:13:27 +01002903 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002904}
2905
2906static inline bool
2907conf_is_ht40_plus(struct ieee80211_conf *conf)
2908{
Johannes Berg47979382009-01-07 10:13:27 +01002909 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002910}
2911
2912static inline bool
2913conf_is_ht40(struct ieee80211_conf *conf)
2914{
2915 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2916}
2917
2918static inline bool
2919conf_is_ht(struct ieee80211_conf *conf)
2920{
Johannes Berg47979382009-01-07 10:13:27 +01002921 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002922}
2923
Johannes Berg2ca27bc2010-09-16 14:58:23 +02002924static inline enum nl80211_iftype
2925ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
2926{
2927 if (p2p) {
2928 switch (type) {
2929 case NL80211_IFTYPE_STATION:
2930 return NL80211_IFTYPE_P2P_CLIENT;
2931 case NL80211_IFTYPE_AP:
2932 return NL80211_IFTYPE_P2P_GO;
2933 default:
2934 break;
2935 }
2936 }
2937 return type;
2938}
2939
2940static inline enum nl80211_iftype
2941ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
2942{
2943 return ieee80211_iftype_p2p(vif->type, vif->p2p);
2944}
2945
Jiri Bencf0706e822007-05-05 11:45:53 -07002946#endif /* MAC80211_H */