blob: 62c0ce2d1dc874a4480ad07a91639795b2c70f64 [file] [log] [blame]
Jiri Bencf0706e82007-05-05 11:45:53 -07001/*
Johannes Berg3017b802007-08-28 17:01:53 -04002 * mac80211 <-> driver interface
3 *
Jiri Bencf0706e82007-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 Bencf0706e82007-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 Bencf0706e82007-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 Bencf0706e82007-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 Bencf0706e82007-05-05 11:45:53 -070045 */
46
Johannes Berg75a5f0c2007-09-18 17:29:20 -040047/**
48 * DOC: Warning
Jiri Bencf0706e82007-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 Bencf0706e82007-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 Bencf0706e82007-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 Bencf0706e82007-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 Bencf0706e82007-05-05 11:45:53 -0700132};
133
Jiri Bencf0706e82007-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 Berg3b8d81e02009-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.
Johannes Berg610dbc92011-01-06 22:36:44 +0100340 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
341 * the off-channel channel when a remain-on-channel offload is done
342 * in hardware -- normal packets still flow and are expected to be
343 * handled properly by the device.
Christian Lampartereb7d3062010-09-21 21:36:18 +0200344 *
345 * Note: If you have to add new flags to the enumeration, then don't
346 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800347 */
348enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200349 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200350 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
351 IEEE80211_TX_CTL_NO_ACK = BIT(2),
352 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
353 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
354 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
355 IEEE80211_TX_CTL_AMPDU = BIT(6),
356 IEEE80211_TX_CTL_INJECTED = BIT(7),
357 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
358 IEEE80211_TX_STAT_ACK = BIT(9),
359 IEEE80211_TX_STAT_AMPDU = BIT(10),
360 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
361 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100362 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200363 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berg3b8d81e02009-06-17 17:43:56 +0200364 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
Johannes Berg3fa52052009-07-24 13:23:09 +0200365 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
Johannes Bergad5351d2009-08-07 16:42:15 +0200366 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
Johannes Bergc6fcf6b2010-01-17 01:47:59 +0100367 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
Felix Fietkau17ad3532010-01-31 21:56:25 +0100368 IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
Jouni Malinen026331c2010-02-15 12:53:10 +0200369 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
Luis R. Rodriguez0a56bd02010-04-15 17:39:37 -0400370 IEEE80211_TX_CTL_LDPC = BIT(22),
Felix Fietkauf79d9ba2010-04-19 19:57:35 +0200371 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
Johannes Berg21f83582010-12-18 17:20:47 +0100372 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
Johannes Berge6a98542008-10-21 12:40:02 +0200373};
374
Johannes Bergabe37c42010-06-07 11:12:27 +0200375#define IEEE80211_TX_CTL_STBC_SHIFT 23
376
Christian Lampartereb7d3062010-09-21 21:36:18 +0200377/*
378 * This definition is used as a mask to clear all temporary flags, which are
379 * set by the tx handlers for each transmission attempt by the mac80211 stack.
380 */
381#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
382 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
383 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
384 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
385 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
386 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
387 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
388 IEEE80211_TX_CTL_STBC)
389
Sujith2134e7e2009-01-22 09:00:52 +0530390/**
391 * enum mac80211_rate_control_flags - per-rate flags set by the
392 * Rate Control algorithm.
393 *
394 * These flags are set by the Rate control algorithm for each rate during tx,
395 * in the @flags member of struct ieee80211_tx_rate.
396 *
397 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
398 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
399 * This is set if the current BSS requires ERP protection.
400 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
401 * @IEEE80211_TX_RC_MCS: HT rate.
402 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
403 * Greenfield mode.
404 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
405 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
406 * adjacent 20 MHz channels, if the current channel type is
407 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
408 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
409 */
Johannes Berge6a98542008-10-21 12:40:02 +0200410enum mac80211_rate_control_flags {
411 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
412 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
413 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
414
415 /* rate index is an MCS rate number instead of an index */
416 IEEE80211_TX_RC_MCS = BIT(3),
417 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
418 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
419 IEEE80211_TX_RC_DUP_DATA = BIT(6),
420 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800421};
422
Johannes Berge039fa42008-05-15 12:55:29 +0200423
Johannes Berge6a98542008-10-21 12:40:02 +0200424/* there are 40 bytes if you don't need the rateset to be kept */
425#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200426
Johannes Berge6a98542008-10-21 12:40:02 +0200427/* if you do need the rateset, then you have less space */
428#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
429
430/* maximum number of rate stages */
431#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200432
433/**
Johannes Berge6a98542008-10-21 12:40:02 +0200434 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200435 *
Johannes Berge6a98542008-10-21 12:40:02 +0200436 * @idx: rate index to attempt to send with
437 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200438 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200439 *
440 * A value of -1 for @idx indicates an invalid rate and, if used
441 * in an array of retry rates, that no more rates should be tried.
442 *
443 * When used for transmit status reporting, the driver should
444 * always report the rate along with the flags it used.
Johannes Bergc555b9b2009-08-07 16:23:43 +0200445 *
446 * &struct ieee80211_tx_info contains an array of these structs
447 * in the control information, and it will be filled by the rate
448 * control algorithm according to what should be sent. For example,
449 * if this array contains, in the format { <idx>, <count> } the
450 * information
451 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
452 * then this means that the frame should be transmitted
453 * up to twice at rate 3, up to twice at rate 2, and up to four
454 * times at rate 1 if it doesn't get acknowledged. Say it gets
455 * acknowledged by the peer after the fifth attempt, the status
456 * information should then contain
457 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
458 * since it was transmitted twice at rate 3, twice at rate 2
459 * and once at rate 1 after which we received an acknowledgement.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200460 */
Johannes Berge6a98542008-10-21 12:40:02 +0200461struct ieee80211_tx_rate {
462 s8 idx;
463 u8 count;
464 u8 flags;
Gustavo F. Padovan3f30fc12010-07-21 10:59:58 +0000465} __packed;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200466
Johannes Berge039fa42008-05-15 12:55:29 +0200467/**
468 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200469 *
Johannes Berge039fa42008-05-15 12:55:29 +0200470 * This structure is placed in skb->cb for three uses:
471 * (1) mac80211 TX control - mac80211 tells the driver what to do
472 * (2) driver internal use (if applicable)
473 * (3) TX status information - driver tells mac80211 what happened
474 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200475 * The TX control's sta pointer is only valid during the ->tx call,
476 * it may be NULL.
477 *
Johannes Berge039fa42008-05-15 12:55:29 +0200478 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200479 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200480 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200481 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700482 * @control: union for control data
483 * @status: union for status data
484 * @driver_data: array of driver_data pointers
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100485 * @ampdu_ack_len: number of acked aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700486 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100487 * @ampdu_len: number of aggregated frames.
Daniel Halperin93d95b12010-04-18 09:28:18 -0700488 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
Johannes Berge039fa42008-05-15 12:55:29 +0200489 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200490 */
Johannes Berge039fa42008-05-15 12:55:29 +0200491struct ieee80211_tx_info {
492 /* common information */
493 u32 flags;
494 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200495
Johannes Berge039fa42008-05-15 12:55:29 +0200496 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100497
Johannes Berge6a98542008-10-21 12:40:02 +0200498 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500499 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100500
Johannes Berge039fa42008-05-15 12:55:29 +0200501 union {
502 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200503 union {
504 /* rate control */
505 struct {
506 struct ieee80211_tx_rate rates[
507 IEEE80211_TX_MAX_RATES];
508 s8 rts_cts_rate_idx;
509 };
510 /* only needed before rate control */
511 unsigned long jiffies;
512 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200513 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200514 struct ieee80211_vif *vif;
515 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200516 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200517 } control;
518 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200519 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
520 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200521 int ack_signal;
Felix Fietkau599bf6a2009-11-15 23:07:30 +0100522 u8 ampdu_len;
Johannes Berg095dfdb2010-05-26 17:19:25 +0200523 /* 15 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200524 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200525 struct {
526 struct ieee80211_tx_rate driver_rates[
527 IEEE80211_TX_MAX_RATES];
528 void *rate_driver_data[
529 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
530 };
531 void *driver_data[
532 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200533 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700534};
535
Johannes Berge039fa42008-05-15 12:55:29 +0200536static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
537{
538 return (struct ieee80211_tx_info *)skb->cb;
539}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400540
Johannes Bergf1d58c22009-06-17 13:13:00 +0200541static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
542{
543 return (struct ieee80211_rx_status *)skb->cb;
544}
545
Johannes Berge6a98542008-10-21 12:40:02 +0200546/**
547 * ieee80211_tx_info_clear_status - clear TX status
548 *
549 * @info: The &struct ieee80211_tx_info to be cleared.
550 *
551 * When the driver passes an skb back to mac80211, it must report
552 * a number of things in TX status. This function clears everything
553 * in the TX status but the rate control information (it does clear
554 * the count since you need to fill that in anyway).
555 *
556 * NOTE: You can only use this function if you do NOT use
557 * info->driver_data! Use info->rate_driver_data
558 * instead if you need only the less space that allows.
559 */
560static inline void
561ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
562{
563 int i;
564
565 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
566 offsetof(struct ieee80211_tx_info, control.rates));
567 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
568 offsetof(struct ieee80211_tx_info, driver_rates));
569 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
570 /* clear the rate counts */
571 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
572 info->status.rates[i].count = 0;
573
574 BUILD_BUG_ON(
575 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
576 memset(&info->status.ampdu_ack_len, 0,
577 sizeof(struct ieee80211_tx_info) -
578 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
579}
580
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400581
582/**
583 * enum mac80211_rx_flags - receive flags
584 *
585 * These flags are used with the @flag member of &struct ieee80211_rx_status.
586 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
587 * Use together with %RX_FLAG_MMIC_STRIPPED.
588 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400589 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
590 * verification has been done by the hardware.
591 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
592 * If this flag is set, the stack cannot do any replay detection
593 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400594 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
595 * the frame.
596 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
597 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100598 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900599 * is valid. This is useful in monitor mode and necessary for beacon frames
600 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200601 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200602 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
603 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
604 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400605 */
606enum mac80211_rx_flags {
607 RX_FLAG_MMIC_ERROR = 1<<0,
608 RX_FLAG_DECRYPTED = 1<<1,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400609 RX_FLAG_MMIC_STRIPPED = 1<<3,
610 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400611 RX_FLAG_FAILED_FCS_CRC = 1<<5,
612 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100613 RX_FLAG_TSFT = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200614 RX_FLAG_SHORTPRE = 1<<8,
615 RX_FLAG_HT = 1<<9,
616 RX_FLAG_40MHZ = 1<<10,
617 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400618};
619
620/**
621 * struct ieee80211_rx_status - receive status
622 *
623 * The low-level driver should provide this information (the subset
624 * supported by hardware) to the 802.11 code with each received
Johannes Bergf1d58c22009-06-17 13:13:00 +0200625 * frame, in the skb's control buffer (cb).
Bruno Randolf566bfe52008-05-08 19:15:40 +0200626 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900627 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
628 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100629 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400630 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200631 * @signal: signal strength when receiving this frame, either in dBm, in dB or
632 * unspecified depending on the hardware capabilities flags
633 * @IEEE80211_HW_SIGNAL_*
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400634 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200635 * @rate_idx: index of data rate into band's supported rates or MCS index if
636 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400637 * @flag: %RX_FLAG_*
Johannes Berg554891e2010-09-24 12:38:25 +0200638 * @rx_flags: internal RX flags for mac80211
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400639 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700640struct ieee80211_rx_status {
641 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100642 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400643 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400644 int signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700645 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100646 int rate_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700647 int flag;
Johannes Berg554891e2010-09-24 12:38:25 +0200648 unsigned int rx_flags;
Jiri Bencf0706e82007-05-05 11:45:53 -0700649};
650
Johannes Berg6b301cd2007-09-18 17:29:20 -0400651/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400652 * enum ieee80211_conf_flags - configuration flags
653 *
654 * Flags to define PHY configuration options
655 *
Johannes Berg0869aea2009-10-28 10:03:35 +0100656 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
657 * to determine for example whether to calculate timestamps for packets
658 * or not, do not use instead of filter flags!
Kalle Valoc99445b2010-01-14 13:09:21 +0200659 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
660 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
661 * meaning that the hardware still wakes up for beacons, is able to
662 * transmit frames and receive the possible acknowledgment frames.
663 * Not to be confused with hardware specific wakeup/sleep states,
664 * driver is responsible for that. See the section "Powersave support"
665 * for more.
Johannes Berg5cff20e2009-04-29 12:26:17 +0200666 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
667 * the driver should be prepared to handle configuration requests but
668 * may turn the device off as much as possible. Typically, this flag will
669 * be set when an interface is set UP but not associated or scanning, but
670 * it can also be unset in that case when monitor interfaces are active.
Felix Fietkau45521242010-07-28 02:40:49 +0200671 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
672 * operating channel.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400673 */
674enum ieee80211_conf_flags {
Johannes Berg0869aea2009-10-28 10:03:35 +0100675 IEEE80211_CONF_MONITOR = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200676 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200677 IEEE80211_CONF_IDLE = (1<<2),
Felix Fietkau45521242010-07-28 02:40:49 +0200678 IEEE80211_CONF_OFFCHANNEL = (1<<3),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400679};
Jiri Bencf0706e82007-05-05 11:45:53 -0700680
Johannes Berg7a5158e2008-10-08 10:59:33 +0200681
Jiri Bencf0706e82007-05-05 11:45:53 -0700682/**
Johannes Berge8975582008-10-09 12:18:51 +0200683 * enum ieee80211_conf_changed - denotes which configuration changed
684 *
Johannes Berge8975582008-10-09 12:18:51 +0200685 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
Johannes Berg0869aea2009-10-28 10:03:35 +0100686 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200687 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200688 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100689 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200690 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200691 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berg0f782312009-12-01 13:37:02 +0100692 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
Johannes Berge8975582008-10-09 12:18:51 +0200693 */
694enum ieee80211_conf_changed {
Johannes Berg0f782312009-12-01 13:37:02 +0100695 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
Johannes Berge8975582008-10-09 12:18:51 +0200696 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
Johannes Berg0869aea2009-10-28 10:03:35 +0100697 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
Johannes Berge8975582008-10-09 12:18:51 +0200698 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200699 IEEE80211_CONF_CHANGE_POWER = BIT(5),
700 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
701 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200702 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200703};
704
705/**
Johannes Berg0f782312009-12-01 13:37:02 +0100706 * enum ieee80211_smps_mode - spatial multiplexing power save mode
707 *
Kalle Valo9d173fc2010-01-14 13:09:14 +0200708 * @IEEE80211_SMPS_AUTOMATIC: automatic
709 * @IEEE80211_SMPS_OFF: off
710 * @IEEE80211_SMPS_STATIC: static
711 * @IEEE80211_SMPS_DYNAMIC: dynamic
712 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
Johannes Berg0f782312009-12-01 13:37:02 +0100713 */
714enum ieee80211_smps_mode {
715 IEEE80211_SMPS_AUTOMATIC,
716 IEEE80211_SMPS_OFF,
717 IEEE80211_SMPS_STATIC,
718 IEEE80211_SMPS_DYNAMIC,
719
720 /* keep last */
721 IEEE80211_SMPS_NUM_MODES,
722};
723
724/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700725 * struct ieee80211_conf - configuration of the device
726 *
727 * This struct indicates how the driver shall configure the hardware.
728 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200729 * @flags: configuration flags defined above
730 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800731 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200732 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200733 * before checking the beacon for a TIM bit (managed mode only); this
734 * value will be only achievable between DTIM frames, the hardware
735 * needs to check for the multicast traffic bit in DTIM beacons.
736 * This variable is valid only when the CONF_PS flag is set.
Johannes Berg56007a02010-01-26 14:19:52 +0100737 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
738 * in power saving. Power saving will not be enabled until a beacon
739 * has been received and the DTIM period is known.
Johannes Berg04fe2032009-04-22 18:44:37 +0200740 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
741 * powersave documentation below. This variable is valid only when
742 * the CONF_PS flag is set.
743 *
Johannes Berg8318d782008-01-24 19:38:38 +0100744 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200745 *
Johannes Berg8318d782008-01-24 19:38:38 +0100746 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100747 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200748 *
Johannes Berg9124b072008-10-14 19:17:54 +0200749 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
750 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
751 * but actually means the number of transmissions not the number of retries
752 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
753 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
754 * number of transmissions not the number of retries
Johannes Berg0f782312009-12-01 13:37:02 +0100755 *
756 * @smps_mode: spatial multiplexing powersave mode; note that
757 * %IEEE80211_SMPS_STATIC is used when the device is not
758 * configured for an HT channel
Jiri Bencf0706e82007-05-05 11:45:53 -0700759 */
760struct ieee80211_conf {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400761 u32 flags;
Juuso Oikarinenff616382010-06-09 09:51:52 +0300762 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200763 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200764
Johannes Berge8975582008-10-09 12:18:51 +0200765 u16 listen_interval;
Johannes Berg56007a02010-01-26 14:19:52 +0100766 u8 ps_dtim_period;
Johannes Berge8975582008-10-09 12:18:51 +0200767
Johannes Berg9124b072008-10-14 19:17:54 +0200768 u8 long_frame_max_tx_count, short_frame_max_tx_count;
769
Johannes Berg8318d782008-01-24 19:38:38 +0100770 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100771 enum nl80211_channel_type channel_type;
Johannes Berg0f782312009-12-01 13:37:02 +0100772 enum ieee80211_smps_mode smps_mode;
Jiri Bencf0706e82007-05-05 11:45:53 -0700773};
774
775/**
Johannes Berg5ce6e432010-05-11 16:20:57 +0200776 * struct ieee80211_channel_switch - holds the channel switch data
777 *
778 * The information provided in this structure is required for channel switch
779 * operation.
780 *
781 * @timestamp: value in microseconds of the 64-bit Time Synchronization
782 * Function (TSF) timer when the frame containing the channel switch
783 * announcement was received. This is simply the rx.mactime parameter
784 * the driver passed into mac80211.
785 * @block_tx: Indicates whether transmission must be blocked before the
786 * scheduled channel switch, as indicated by the AP.
787 * @channel: the new channel to switch to
788 * @count: the number of TBTT's until the channel switch event
789 */
790struct ieee80211_channel_switch {
791 u64 timestamp;
792 bool block_tx;
793 struct ieee80211_channel *channel;
794 u8 count;
795};
796
797/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100798 * struct ieee80211_vif - per-interface data
799 *
800 * Data in this structure is continually present for driver
801 * use during the life of a virtual interface.
802 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100803 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200804 * @bss_conf: BSS configuration for this interface, either our own
805 * or the BSS we're associated to
Johannes Berg47846c92009-11-25 17:46:19 +0100806 * @addr: address of this interface
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200807 * @p2p: indicates whether this AP or STA interface is a p2p
808 * interface, i.e. a GO or p2p-sta respectively
Johannes Berg32bfd352007-12-19 01:31:26 +0100809 * @drv_priv: data area for driver use, will always be aligned to
810 * sizeof(void *).
811 */
812struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200813 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200814 struct ieee80211_bss_conf bss_conf;
Johannes Berg47846c92009-11-25 17:46:19 +0100815 u8 addr[ETH_ALEN];
Johannes Berg2ca27bc2010-09-16 14:58:23 +0200816 bool p2p;
Johannes Berg32bfd352007-12-19 01:31:26 +0100817 /* must be last */
818 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
819};
820
Johannes Berg902acc72008-02-23 15:17:19 +0100821static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
822{
823#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200824 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100825#endif
826 return false;
827}
828
Johannes Berg32bfd352007-12-19 01:31:26 +0100829/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400830 * enum ieee80211_key_flags - key flags
831 *
832 * These flags are used for communication about keys between the driver
833 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
834 *
835 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
836 * that the STA this key will be used with could be using QoS.
837 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
838 * driver to indicate that it requires IV generation for this
839 * particular key.
840 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
841 * the driver for a TKIP key if it requires Michael MIC
842 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200843 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
844 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200845 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
846 * CCMP key if it requires CCMP encryption of management frames (MFP) to
847 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400848 */
849enum ieee80211_key_flags {
850 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
851 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
852 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200853 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200854 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400855};
856
857/**
858 * struct ieee80211_key_conf - key information
859 *
860 * This key information is given by mac80211 to the driver by
861 * the set_key() callback in &struct ieee80211_ops.
862 *
863 * @hw_key_idx: To be set by the driver, this is the key index the driver
864 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400865 * encrypted in hardware.
Johannes Berg97359d12010-08-10 09:46:38 +0200866 * @cipher: The key's cipher suite selector.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400867 * @flags: key flags, see &enum ieee80211_key_flags.
868 * @keyidx: the key index (0-3)
869 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400870 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
871 * data block:
872 * - Temporal Encryption Key (128 bits)
873 * - Temporal Authenticator Tx MIC Key (64 bits)
874 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100875 * @icv_len: The ICV length for this key type
876 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400877 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700878struct ieee80211_key_conf {
Johannes Berg97359d12010-08-10 09:46:38 +0200879 u32 cipher;
Felix Fietkau76708de2008-10-05 18:02:48 +0200880 u8 icv_len;
881 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400882 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400883 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400884 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400885 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -0700886 u8 key[0];
887};
888
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400889/**
890 * enum set_key_cmd - key command
891 *
892 * Used with the set_key() callback in &struct ieee80211_ops, this
893 * indicates whether a key is being removed or added.
894 *
895 * @SET_KEY: a key is set
896 * @DISABLE_KEY: a key must be disabled
897 */
Johannes Bergea49c352007-09-18 17:29:21 -0400898enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400899 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400900};
Jiri Bencf0706e82007-05-05 11:45:53 -0700901
Tomas Winkler478f8d22007-09-30 13:52:37 +0200902/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200903 * struct ieee80211_sta - station table entry
904 *
905 * A station table entry represents a station we are possibly
906 * communicating with. Since stations are RCU-managed in
907 * mac80211, any ieee80211_sta pointer you get access to must
908 * either be protected by rcu_read_lock() explicitly or implicitly,
909 * or you must take good care to not use such a pointer after a
Johannes Berg34e89502010-02-03 13:59:58 +0100910 * call to your sta_remove callback that removed it.
Johannes Berg17741cd2008-09-11 00:02:02 +0200911 *
912 * @addr: MAC address
913 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200914 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200915 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200916 * @drv_priv: data area for driver use, will always be aligned to
917 * sizeof(void *), size is determined in hw information.
918 */
919struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100920 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200921 u8 addr[ETH_ALEN];
922 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200923 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200924
925 /* must be last */
926 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
927};
928
929/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200930 * enum sta_notify_cmd - sta notify command
931 *
932 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Sujith38a6cc72010-05-19 11:32:30 +0530933 * indicates if an associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200934 *
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100935 * @STA_NOTIFY_SLEEP: a station is now sleeping
936 * @STA_NOTIFY_AWAKE: a sleeping station woke up
937 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100938enum sta_notify_cmd {
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100939 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
940};
941
942/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200943 * enum ieee80211_tkip_key_type - get tkip key
944 *
945 * Used by drivers which need to get a tkip key for skb. Some drivers need a
946 * phase 1 key, others need a phase 2 key. A single function allows the driver
947 * to get the key, this enum indicates what type of key is required.
948 *
949 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
950 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
951 */
952enum ieee80211_tkip_key_type {
953 IEEE80211_TKIP_P1_KEY,
954 IEEE80211_TKIP_P2_KEY,
955};
956
957/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400958 * enum ieee80211_hw_flags - hardware flags
959 *
960 * These flags are used to indicate hardware capabilities to
961 * the stack. Generally, flags here should have their meaning
962 * done in a way that the simplest hardware doesn't need setting
963 * any particular flags. There are some exceptions to this rule,
964 * however, so you are advised to review these flags carefully.
965 *
Johannes Bergaf65cd962009-11-17 18:18:36 +0100966 * @IEEE80211_HW_HAS_RATE_CONTROL:
967 * The hardware or firmware includes rate control, and cannot be
968 * controlled by the stack. As such, no rate control algorithm
969 * should be instantiated, and the TX rate reported to userspace
970 * will be taken from the TX status instead of the rate control
971 * algorithm.
972 * Note that this requires that the driver implement a number of
973 * callbacks so it has the correct information, it needs to have
974 * the @set_rts_threshold callback and must look at the BSS config
975 * @use_cts_prot for G/N protection, @use_short_slot for slot
976 * timing in 2.4 GHz and @use_short_preamble for preambles for
977 * CCK frames.
978 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400979 * @IEEE80211_HW_RX_INCLUDES_FCS:
980 * Indicates that received frames passed to the stack include
981 * the FCS at the end.
982 *
983 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
984 * Some wireless LAN chipsets buffer broadcast/multicast frames
985 * for power saving stations in the hardware/firmware and others
986 * rely on the host system for such buffering. This option is used
987 * to configure the IEEE 802.11 upper layer to buffer broadcast and
988 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -0700989 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400990 *
Johannes Berg8318d782008-01-24 19:38:38 +0100991 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
992 * Hardware is not capable of short slot operation on the 2.4 GHz band.
993 *
994 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
995 * Hardware is not capable of receiving frames with short preamble on
996 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200997 *
998 * @IEEE80211_HW_SIGNAL_UNSPEC:
999 * Hardware can provide signal values but we don't know its units. We
1000 * expect values between 0 and @max_signal.
1001 * If possible please provide dB or dBm instead.
1002 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001003 * @IEEE80211_HW_SIGNAL_DBM:
1004 * Hardware gives signal values in dBm, decibel difference from
1005 * one milliwatt. This is the preferred method since it is standardized
1006 * between different devices. @max_signal does not need to be set.
1007 *
Tomas Winkler06ff47b2008-06-18 17:53:44 +03001008 * @IEEE80211_HW_SPECTRUM_MGMT:
1009 * Hardware supports spectrum management defined in 802.11h
1010 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +05301011 *
1012 * @IEEE80211_HW_AMPDU_AGGREGATION:
1013 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +02001014 *
Johannes Berg4be8c382009-01-07 18:28:20 +01001015 * @IEEE80211_HW_SUPPORTS_PS:
1016 * Hardware has power save support (i.e. can go to sleep).
1017 *
1018 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1019 * Hardware requires nullfunc frame handling in stack, implies
1020 * stack support for dynamic PS.
1021 *
1022 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1023 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +02001024 *
1025 * @IEEE80211_HW_MFP_CAPABLE:
1026 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +02001027 *
1028 * @IEEE80211_HW_BEACON_FILTER:
1029 * Hardware supports dropping of irrelevant beacon frames to
1030 * avoid waking up cpu.
Johannes Berg0f782312009-12-01 13:37:02 +01001031 *
1032 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1033 * Hardware supports static spatial multiplexing powersave,
1034 * ie. can turn off all but one chain even on HT connections
1035 * that should be using more chains.
1036 *
1037 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1038 * Hardware supports dynamic spatial multiplexing powersave,
1039 * ie. can turn off all but one chain and then wake the rest
1040 * up as required after, for example, rts/cts handshake.
Kalle Valoab133152010-01-12 10:42:31 +02001041 *
1042 * @IEEE80211_HW_SUPPORTS_UAPSD:
1043 * Hardware supports Unscheduled Automatic Power Save Delivery
1044 * (U-APSD) in managed mode. The mode is configured with
1045 * conf_tx() operation.
Vivek Natarajan375177b2010-02-09 14:50:28 +05301046 *
1047 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1048 * Hardware can provide ack status reports of Tx frames to
1049 * the stack.
1050 *
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001051 * @IEEE80211_HW_CONNECTION_MONITOR:
1052 * The hardware performs its own connection monitoring, including
1053 * periodic keep-alives to the AP and probing the AP on beacon loss.
1054 * When this flag is set, signaling beacon-loss will cause an immediate
1055 * change to disassociated state.
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001056 *
1057 * @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1058 * Hardware can do connection quality monitoring - i.e. it can monitor
1059 * connection quality related parameters, such as the RSSI level and
1060 * provide notifications if configured trigger levels are reached.
1061 *
Johannes Berge5b900d2010-07-29 16:08:55 +02001062 * @IEEE80211_HW_NEED_DTIM_PERIOD:
1063 * This device needs to know the DTIM period for the BSS before
1064 * associating.
Johannes Berge31b8212010-10-05 19:39:30 +02001065 *
1066 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1067 * per-station GTKs as used by IBSS RSN or during fast transition. If
1068 * the device doesn't support per-station GTKs, but can be asked not
1069 * to decrypt group addressed frames, then IBSS RSN support is still
1070 * possible but software crypto will be used. Advertise the wiphy flag
1071 * only in that case.
Johannes Berg1bc08262007-09-18 17:29:15 -04001072 */
1073enum ieee80211_hw_flags {
Johannes Bergaf65cd962009-11-17 18:18:36 +01001074 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
Johannes Berg1bc08262007-09-18 17:29:15 -04001075 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1076 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +01001077 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1078 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +02001079 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +01001080 IEEE80211_HW_SIGNAL_DBM = 1<<6,
Johannes Berge5b900d2010-07-29 16:08:55 +02001081 IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
Johannes Berg7fee5372009-01-30 11:13:06 +01001082 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1083 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1084 IEEE80211_HW_SUPPORTS_PS = 1<<10,
1085 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1086 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1087 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +02001088 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg0f782312009-12-01 13:37:02 +01001089 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1090 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
Kalle Valoab133152010-01-12 10:42:31 +02001091 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
Vivek Natarajan375177b2010-02-09 14:50:28 +05301092 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02001093 IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02001094 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
Johannes Berge31b8212010-10-05 19:39:30 +02001095 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
Johannes Berg1bc08262007-09-18 17:29:15 -04001096};
1097
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001098/**
1099 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001100 *
1101 * This structure contains the configuration and hardware
1102 * information for an 802.11 PHY.
1103 *
1104 * @wiphy: This points to the &struct wiphy allocated for this
1105 * 802.11 PHY. You must fill in the @perm_addr and @dev
1106 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +01001107 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1108 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001109 *
1110 * @conf: &struct ieee80211_conf, device configuration, don't use.
1111 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001112 * @priv: pointer to private area that was allocated for driver use
1113 * along with this structure.
1114 *
1115 * @flags: hardware flags, see &enum ieee80211_hw_flags.
1116 *
1117 * @extra_tx_headroom: headroom to reserve in each transmit skb
1118 * for use by the driver (e.g. for transmit headers.)
1119 *
1120 * @channel_change_time: time (in microseconds) it takes to change channels.
1121 *
Bruno Randolf566bfe52008-05-08 19:15:40 +02001122 * @max_signal: Maximum value for signal (rssi) in RX information, used
1123 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001124 *
Tomas Winklerea95bba2008-07-18 13:53:00 +08001125 * @max_listen_interval: max listen interval in units of beacon interval
1126 * that HW supports
1127 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001128 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +02001129 * data packets. WMM/QoS requires at least four, these
1130 * queues need to have configurable access parameters.
1131 *
Johannes Berg830f9032007-10-28 14:51:05 +01001132 * @rate_control_algorithm: rate control algorithm for this hardware.
1133 * If unset (NULL), the default algorithm will be used. Must be
1134 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001135 *
1136 * @vif_data_size: size (in bytes) of the drv_priv data area
1137 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +02001138 * @sta_data_size: size (in bytes) of the drv_priv data area
1139 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +02001140 *
Helmut Schaa78be49e2010-10-02 11:31:55 +02001141 * @max_rates: maximum number of alternate rate retry stages the hw
1142 * can handle.
1143 * @max_report_rates: maximum number of alternate rate retry stages
1144 * the hw can report back.
Johannes Berge6a98542008-10-21 12:40:02 +02001145 * @max_rate_tries: maximum number of tries for each stage
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001146 *
1147 * @napi_weight: weight used for NAPI polling. You must specify an
1148 * appropriate value here if a napi_poll operation is provided
1149 * by your driver.
Johannes Berg7ac1bd62007-09-14 11:10:25 -04001150 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001151struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -07001152 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001153 struct wiphy *wiphy;
Johannes Berg830f9032007-10-28 14:51:05 +01001154 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -07001155 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001156 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -07001157 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -07001158 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +01001159 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +02001160 int sta_data_size;
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001161 int napi_weight;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001162 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +08001163 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -07001164 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +02001165 u8 max_rates;
Helmut Schaa78be49e2010-10-02 11:31:55 +02001166 u8 max_report_rates;
Johannes Berge6a98542008-10-21 12:40:02 +02001167 u8 max_rate_tries;
Jiri Bencf0706e82007-05-05 11:45:53 -07001168};
1169
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001170/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -08001171 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1172 *
1173 * @wiphy: the &struct wiphy which we want to query
1174 *
1175 * mac80211 drivers can use this to get to their respective
1176 * &struct ieee80211_hw. Drivers wishing to get to their own private
1177 * structure can then access it via hw->priv. Note that mac802111 drivers should
1178 * not use wiphy_priv() to try to get their private driver structure as this
1179 * is already used internally by mac80211.
1180 */
1181struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1182
1183/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001184 * SET_IEEE80211_DEV - set device for 802.11 hardware
1185 *
1186 * @hw: the &struct ieee80211_hw to set the device for
1187 * @dev: the &struct device of this 802.11 device
1188 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001189static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1190{
1191 set_wiphy_dev(hw->wiphy, dev);
1192}
1193
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001194/**
Bob Copelande37d4df2008-10-20 21:20:27 -04001195 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001196 *
1197 * @hw: the &struct ieee80211_hw to set the MAC address for
1198 * @addr: the address to set
1199 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001200static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1201{
1202 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1203}
1204
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001205static inline struct ieee80211_rate *
1206ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001207 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001208{
Johannes Berge6a98542008-10-21 12:40:02 +02001209 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001210 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001211 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001212}
1213
1214static inline struct ieee80211_rate *
1215ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001216 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001217{
Johannes Berge039fa42008-05-15 12:55:29 +02001218 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001219 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001220 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001221}
1222
1223static inline struct ieee80211_rate *
1224ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001225 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001226{
Johannes Berge6a98542008-10-21 12:40:02 +02001227 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001228 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001229 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001230}
1231
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001232/**
1233 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001234 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001235 * mac80211 is capable of taking advantage of many hardware
1236 * acceleration designs for encryption and decryption operations.
1237 *
1238 * The set_key() callback in the &struct ieee80211_ops for a given
1239 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001240 * decryption. The callback takes a @sta parameter that will be NULL
1241 * for default keys or keys used for transmission only, or point to
1242 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001243 * Multiple transmission keys with the same key index may be used when
1244 * VLANs are configured for an access point.
1245 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001246 * When transmitting, the TX control data will use the @hw_key_idx
1247 * selected by the driver by modifying the &struct ieee80211_key_conf
1248 * pointed to by the @key parameter to the set_key() function.
1249 *
1250 * The set_key() call for the %SET_KEY command should return 0 if
1251 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1252 * added; if you return 0 then hw_key_idx must be assigned to the
1253 * hardware key index, you are free to use the full u8 range.
1254 *
1255 * When the cmd is %DISABLE_KEY then it must succeed.
1256 *
1257 * Note that it is permissible to not decrypt a frame even if a key
1258 * for it has been uploaded to hardware, the stack will not make any
1259 * decision based on whether a key has been uploaded or not but rather
1260 * based on the receive flags.
1261 *
1262 * The &struct ieee80211_key_conf structure pointed to by the @key
1263 * parameter is guaranteed to be valid until another call to set_key()
1264 * removes it, but it can only be used as a cookie to differentiate
1265 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001266 *
1267 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1268 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1269 * handler.
1270 * The update_tkip_key() call updates the driver with the new phase 1 key.
1271 * This happens everytime the iv16 wraps around (every 65536 packets). The
1272 * set_key() call will happen only once for each key (unless the AP did
1273 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001274 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001275 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001276 */
Johannes Berg4150c572007-09-17 01:29:23 -04001277
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001278/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001279 * DOC: Powersave support
1280 *
1281 * mac80211 has support for various powersave implementations.
1282 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001283 * First, it can support hardware that handles all powersaving by itself,
1284 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1285 * flag. In that case, it will be told about the desired powersave mode
1286 * with the %IEEE80211_CONF_PS flag depending on the association status.
1287 * The hardware must take care of sending nullfunc frames when necessary,
1288 * i.e. when entering and leaving powersave mode. The hardware is required
1289 * to look at the AID in beacons and signal to the AP that it woke up when
1290 * it finds traffic directed to it.
Johannes Berg4be8c382009-01-07 18:28:20 +01001291 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001292 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1293 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1294 * with hardware wakeup and sleep states. Driver is responsible for waking
Bob Copeland2738bd62010-08-21 16:39:01 -04001295 * up the hardware before issuing commands to the hardware and putting it
1296 * back to sleep at appropriate times.
Kalle Valoc99445b2010-01-14 13:09:21 +02001297 *
1298 * When PS is enabled, hardware needs to wakeup for beacons and receive the
1299 * buffered multicast/broadcast frames after the beacon. Also it must be
1300 * possible to send frames and receive the acknowledment frame.
Johannes Berg4be8c382009-01-07 18:28:20 +01001301 *
1302 * Other hardware designs cannot send nullfunc frames by themselves and also
1303 * need software support for parsing the TIM bitmap. This is also supported
1304 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1305 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001306 * required to pass up beacons. The hardware is still required to handle
1307 * waking up for multicast traffic; if it cannot the driver must handle that
Kalle Valoc99445b2010-01-14 13:09:21 +02001308 * as best as it can, mac80211 is too slow to do that.
Johannes Berg4be8c382009-01-07 18:28:20 +01001309 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001310 * Dynamic powersave is an extension to normal powersave in which the
1311 * hardware stays awake for a user-specified period of time after sending a
1312 * frame so that reply frames need not be buffered and therefore delayed to
1313 * the next wakeup. It's compromise of getting good enough latency when
1314 * there's data traffic and still saving significantly power in idle
1315 * periods.
1316 *
Bob Copeland2738bd62010-08-21 16:39:01 -04001317 * Dynamic powersave is simply supported by mac80211 enabling and disabling
Kalle Valoc99445b2010-01-14 13:09:21 +02001318 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1319 * flag and mac80211 will handle everything automatically. Additionally,
1320 * hardware having support for the dynamic PS feature may set the
1321 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1322 * dynamic PS mode itself. The driver needs to look at the
1323 * @dynamic_ps_timeout hardware configuration value and use it that value
1324 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1325 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1326 * enabled whenever user has enabled powersave.
1327 *
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03001328 * Some hardware need to toggle a single shared antenna between WLAN and
1329 * Bluetooth to facilitate co-existence. These types of hardware set
1330 * limitations on the use of host controlled dynamic powersave whenever there
1331 * is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1332 * driver may request temporarily going into full power save, in order to
1333 * enable toggling the antenna between BT and WLAN. If the driver requests
1334 * disabling dynamic powersave, the @dynamic_ps_timeout value will be
1335 * temporarily set to zero until the driver re-enables dynamic powersave.
1336 *
Kalle Valoc99445b2010-01-14 13:09:21 +02001337 * Driver informs U-APSD client support by enabling
1338 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1339 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1340 * Nullfunc frames and stay awake until the service period has ended. To
1341 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1342 * from that AC are transmitted with powersave enabled.
1343 *
1344 * Note: U-APSD client mode is not yet supported with
1345 * %IEEE80211_HW_PS_NULLFUNC_STACK.
Johannes Berg4be8c382009-01-07 18:28:20 +01001346 */
1347
1348/**
Kalle Valo04de8382009-03-22 21:57:35 +02001349 * DOC: Beacon filter support
1350 *
1351 * Some hardware have beacon filter support to reduce host cpu wakeups
1352 * which will reduce system power consumption. It usuallly works so that
1353 * the firmware creates a checksum of the beacon but omits all constantly
1354 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1355 * beacon is forwarded to the host, otherwise it will be just dropped. That
1356 * way the host will only receive beacons where some relevant information
1357 * (for example ERP protection or WMM settings) have changed.
1358 *
Johannes Berg955394c2009-04-16 17:04:25 +02001359 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1360 * hardware capability. The driver needs to enable beacon filter support
1361 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1362 * power save is enabled, the stack will not check for beacon loss and the
1363 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1364 *
1365 * The time (or number of beacons missed) until the firmware notifies the
1366 * driver of a beacon loss event (which in turn causes the driver to call
1367 * ieee80211_beacon_loss()) should be configurable and will be controlled
1368 * by mac80211 and the roaming algorithm in the future.
1369 *
1370 * Since there may be constantly changing information elements that nothing
1371 * in the software stack cares about, we will, in the future, have mac80211
1372 * tell the driver which information elements are interesting in the sense
1373 * that we want to see changes in them. This will include
1374 * - a list of information element IDs
1375 * - a list of OUIs for the vendor information element
1376 *
1377 * Ideally, the hardware would filter out any beacons without changes in the
1378 * requested elements, but if it cannot support that it may, at the expense
1379 * of some efficiency, filter out only a subset. For example, if the device
1380 * doesn't support checking for OUIs it should pass up all changes in all
1381 * vendor information elements.
1382 *
1383 * Note that change, for the sake of simplification, also includes information
1384 * elements appearing or disappearing from the beacon.
1385 *
1386 * Some hardware supports an "ignore list" instead, just make sure nothing
1387 * that was requested is on the ignore list, and include commonly changing
1388 * information element IDs in the ignore list, for example 11 (BSS load) and
1389 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1390 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1391 * it could also include some currently unused IDs.
1392 *
1393 *
1394 * In addition to these capabilities, hardware should support notifying the
1395 * host of changes in the beacon RSSI. This is relevant to implement roaming
1396 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1397 * the received data packets). This can consist in notifying the host when
1398 * the RSSI changes significantly or when it drops below or rises above
1399 * configurable thresholds. In the future these thresholds will also be
1400 * configured by mac80211 (which gets them from userspace) to implement
1401 * them as the roaming algorithm requires.
1402 *
1403 * If the hardware cannot implement this, the driver should ask it to
1404 * periodically pass beacon frames to the host so that software can do the
1405 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001406 */
1407
1408/**
Johannes Berg0f782312009-12-01 13:37:02 +01001409 * DOC: Spatial multiplexing power save
1410 *
1411 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
1412 * power in an 802.11n implementation. For details on the mechanism
1413 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1414 * "11.2.3 SM power save".
1415 *
1416 * The mac80211 implementation is capable of sending action frames
1417 * to update the AP about the station's SMPS mode, and will instruct
1418 * the driver to enter the specific mode. It will also announce the
1419 * requested SMPS mode during the association handshake. Hardware
1420 * support for this feature is required, and can be indicated by
1421 * hardware flags.
1422 *
1423 * The default mode will be "automatic", which nl80211/cfg80211
1424 * defines to be dynamic SMPS in (regular) powersave, and SMPS
1425 * turned off otherwise.
1426 *
1427 * To support this feature, the driver must set the appropriate
1428 * hardware support flags, and handle the SMPS flag to the config()
1429 * operation. It will then with this mechanism be instructed to
1430 * enter the requested SMPS mode while associated to an HT AP.
1431 */
1432
1433/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001434 * DOC: Frame filtering
1435 *
1436 * mac80211 requires to see many management frames for proper
1437 * operation, and users may want to see many more frames when
1438 * in monitor mode. However, for best CPU usage and power consumption,
1439 * having as few frames as possible percolate through the stack is
1440 * desirable. Hence, the hardware should filter as much as possible.
1441 *
1442 * To achieve this, mac80211 uses filter flags (see below) to tell
1443 * the driver's configure_filter() function which frames should be
1444 * passed to mac80211 and which should be filtered out.
1445 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001446 * Before configure_filter() is invoked, the prepare_multicast()
1447 * callback is invoked with the parameters @mc_count and @mc_list
1448 * for the combined multicast address list of all virtual interfaces.
1449 * It's use is optional, and it returns a u64 that is passed to
1450 * configure_filter(). Additionally, configure_filter() has the
1451 * arguments @changed_flags telling which flags were changed and
1452 * @total_flags with the new flag states.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001453 *
1454 * If your device has no multicast address filters your driver will
1455 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1456 * parameter to see whether multicast frames should be accepted
1457 * or dropped.
1458 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001459 * All unsupported flags in @total_flags must be cleared.
1460 * Hardware does not support a flag if it is incapable of _passing_
1461 * the frame to the stack. Otherwise the driver must ignore
1462 * the flag, but not clear it.
1463 * You must _only_ clear the flag (announce no support for the
1464 * flag to mac80211) if you are not able to pass the packet type
1465 * to the stack (so the hardware always filters it).
1466 * So for example, you should clear @FIF_CONTROL, if your hardware
1467 * always filters control frames. If your hardware always passes
1468 * control frames to the kernel and is incapable of filtering them,
1469 * you do _not_ clear the @FIF_CONTROL flag.
1470 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001471 */
1472
1473/**
1474 * enum ieee80211_filter_flags - hardware filter flags
1475 *
1476 * These flags determine what the filter in hardware should be
1477 * programmed to let through and what should not be passed to the
1478 * stack. It is always safe to pass more frames than requested,
1479 * but this has negative impact on power consumption.
1480 *
1481 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1482 * think of the BSS as your network segment and then this corresponds
1483 * to the regular ethernet device promiscuous mode.
1484 *
1485 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1486 * by the user or if the hardware is not capable of filtering by
1487 * multicast address.
1488 *
1489 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1490 * %RX_FLAG_FAILED_FCS_CRC for them)
1491 *
1492 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1493 * the %RX_FLAG_FAILED_PLCP_CRC for them
1494 *
1495 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1496 * to the hardware that it should not filter beacons or probe responses
1497 * by BSSID. Filtering them can greatly reduce the amount of processing
1498 * mac80211 needs to do and the amount of CPU wakeups, so you should
1499 * honour this flag if possible.
1500 *
Igor Perminove3b90ca2009-08-04 16:48:51 +04001501 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
Johannes Berg7be50862010-10-13 12:06:24 +02001502 * is not set then only those addressed to this station.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001503 *
1504 * @FIF_OTHER_BSS: pass frames destined to other BSSes
Igor Perminove3b90ca2009-08-04 16:48:51 +04001505 *
Johannes Berg7be50862010-10-13 12:06:24 +02001506 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1507 * those addressed to this station.
1508 *
1509 * @FIF_PROBE_REQ: pass probe request frames
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001510 */
1511enum ieee80211_filter_flags {
1512 FIF_PROMISC_IN_BSS = 1<<0,
1513 FIF_ALLMULTI = 1<<1,
1514 FIF_FCSFAIL = 1<<2,
1515 FIF_PLCPFAIL = 1<<3,
1516 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1517 FIF_CONTROL = 1<<5,
1518 FIF_OTHER_BSS = 1<<6,
Igor Perminove3b90ca2009-08-04 16:48:51 +04001519 FIF_PSPOLL = 1<<7,
Johannes Berg7be50862010-10-13 12:06:24 +02001520 FIF_PROBE_REQ = 1<<8,
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001521};
1522
1523/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001524 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1525 *
1526 * These flags are used with the ampdu_action() callback in
1527 * &struct ieee80211_ops to indicate which action is needed.
Johannes Berg827d42c2009-11-22 12:28:41 +01001528 *
1529 * Note that drivers MUST be able to deal with a TX aggregation
1530 * session being stopped even before they OK'ed starting it by
Johannes Berg5d22c892010-06-10 10:21:40 +02001531 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
Johannes Berg827d42c2009-11-22 12:28:41 +01001532 * might receive the addBA frame and send a delBA right away!
1533 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001534 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1535 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001536 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1537 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001538 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001539 */
1540enum ieee80211_ampdu_mlme_action {
1541 IEEE80211_AMPDU_RX_START,
1542 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001543 IEEE80211_AMPDU_TX_START,
1544 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001545 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001546};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001547
1548/**
1549 * struct ieee80211_ops - callbacks from mac80211 to the driver
1550 *
1551 * This structure contains various callbacks that the driver may
1552 * handle or, in some cases, must handle, for example to configure
1553 * the hardware to a new channel or to transmit a frame.
1554 *
1555 * @tx: Handler that 802.11 module calls for each transmitted frame.
1556 * skb contains the buffer starting from the IEEE 802.11 header.
1557 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001558 * configuration in the TX control data. This handler should,
1559 * preferably, never fail and stop queues appropriately, more
1560 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001561 * This function should return NETDEV_TX_OK except in very
1562 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001563 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001564 *
1565 * @start: Called before the first netdevice attached to the hardware
1566 * is enabled. This should turn on the hardware and must turn on
1567 * frame reception (for possibly enabled monitor interfaces.)
1568 * Returns negative error codes, these may be seen in userspace,
1569 * or zero.
1570 * When the device is started it should not have a MAC address
1571 * to avoid acknowledging frames before a non-monitor device
1572 * is added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001573 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001574 *
1575 * @stop: Called after last netdevice attached to the hardware
1576 * is disabled. This should turn off the hardware (at least
1577 * it must turn off frame reception.)
1578 * May be called right after add_interface if that rejects
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04001579 * an interface. If you added any work onto the mac80211 workqueue
1580 * you should ensure to cancel it on this callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001581 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001582 *
1583 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001584 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001585 * and @stop must be implemented.
1586 * The driver should perform any initialization it needs before
1587 * the device can be enabled. The initial configuration for the
1588 * interface is given in the conf parameter.
1589 * The callback may refuse to add an interface by returning a
1590 * negative error code (which will be seen in userspace.)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001591 * Must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001592 *
Johannes Berg34d4bc42010-08-27 12:35:58 +02001593 * @change_interface: Called when a netdevice changes type. This callback
1594 * is optional, but only if it is supported can interface types be
1595 * switched while the interface is UP. The callback may sleep.
1596 * Note that while an interface is being switched, it will not be
1597 * found by the interface iteration callbacks.
1598 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001599 * @remove_interface: Notifies a driver that an interface is going down.
1600 * The @stop callback is called after this if it is the last interface
1601 * and no monitor interfaces are present.
1602 * When all interfaces are removed, the MAC address in the hardware
1603 * must be cleared so the device no longer acknowledges packets,
1604 * the mac_addr member of the conf structure is, however, set to the
1605 * MAC address of the device going away.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001606 * Hence, this callback must be implemented. It can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001607 *
1608 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1609 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001610 * This function should never fail but returns a negative error code
Kalle Valoe1781ed2009-12-23 13:15:47 +01001611 * if it does. The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001612 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001613 * @bss_info_changed: Handler for configuration requests related to BSS
1614 * parameters that may vary during BSS's lifespan, and may affect low
1615 * level driver (e.g. assoc/disassoc status, erp parameters).
1616 * This function should not be used if no BSS has been set, unless
1617 * for association indication. The @changed parameter indicates which
Kalle Valoe1781ed2009-12-23 13:15:47 +01001618 * of the bss parameters has changed when a call is made. The callback
1619 * can sleep.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001620 *
Johannes Berg3ac64be2009-08-17 16:16:53 +02001621 * @prepare_multicast: Prepare for multicast filter configuration.
1622 * This callback is optional, and its return value is passed
1623 * to configure_filter(). This callback must be atomic.
1624 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001625 * @configure_filter: Configure the device's RX filter.
1626 * See the section "Frame filtering" for more information.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001627 * This callback must be implemented and can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001628 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001629 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001630 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001631 *
1632 * @set_key: See the section "Hardware crypto acceleration"
Kalle Valoe1781ed2009-12-23 13:15:47 +01001633 * This callback is only called between add_interface and
1634 * remove_interface calls, i.e. while the given virtual interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001635 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001636 * Returns a negative error code if the key can't be added.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001637 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001638 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001639 * @update_tkip_key: See the section "Hardware crypto acceleration"
1640 * This callback will be called in the context of Rx. Called for drivers
1641 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
Kalle Valoeb807fb2010-01-24 14:55:12 +02001642 * The callback must be atomic.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001643 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001644 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001645 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001646 * configuration done by the regulatory agent in the wiphy's
1647 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001648 * that power save is disabled.
1649 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1650 * entire IEs after the SSID, so that drivers need not look at these
1651 * at all but just send them after the SSID -- mac80211 includes the
1652 * (extended) supported rates and HT information (where applicable).
1653 * When the scan finishes, ieee80211_scan_completed() must be called;
1654 * note that it also must be called when the scan cannot finish due to
1655 * any error unless this callback returned a negative error code.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001656 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001657 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001658 * @sw_scan_start: Notifier function that is called just before a software scan
1659 * is started. Can be NULL, if the driver doesn't need this notification.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001660 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001661 *
Kalle Valoe1781ed2009-12-23 13:15:47 +01001662 * @sw_scan_complete: Notifier function that is called just after a
1663 * software scan finished. Can be NULL, if the driver doesn't need
1664 * this notification.
1665 * The callback can sleep.
Michael Buesch80e775b2009-02-20 15:37:03 +01001666 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001667 * @get_stats: Return low-level statistics.
1668 * Returns zero if statistics are available.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001669 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001670 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001671 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1672 * callback should be provided to read the TKIP transmit IVs (both IV32
1673 * and IV16) for the given key from hardware.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001674 * The callback must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001675 *
Arik Nemtsovf23a4782010-11-08 11:51:06 +02001676 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
1677 * if the device does fragmentation by itself; if this callback is
1678 * implemented then the stack will not do fragmentation.
1679 * The callback can sleep.
1680 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001681 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
Kalle Valoe1781ed2009-12-23 13:15:47 +01001682 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001683 *
Johannes Berg34e89502010-02-03 13:59:58 +01001684 * @sta_add: Notifies low level driver about addition of an associated station,
1685 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1686 *
1687 * @sta_remove: Notifies low level driver about removal of an associated
1688 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1689 *
1690 * @sta_notify: Notifies low level driver about power state transition of an
1691 * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001692 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001693 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001694 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001695 * Returns a negative error code on failure.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001696 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001697 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001698 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001699 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001700 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001701 * The callback can sleep.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001702 *
1703 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1704 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001705 * required function.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001706 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001707 *
1708 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1709 * with other STAs in the IBSS. This is only used in IBSS mode. This
1710 * function is optional if the firmware/hardware takes full care of
1711 * TSF synchronization.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001712 * The callback can sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001713 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001714 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1715 * This is needed only for IBSS mode and the result of this function is
1716 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001717 * Returns non-zero if this device sent the last beacon.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001718 * The callback can sleep.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001719 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001720 * @ampdu_action: Perform a certain A-MPDU action
1721 * The RA/TID combination determines the destination and TID we want
1722 * the ampdu action to be performed for. The action is defined through
1723 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001724 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001725 * that TX/RX_STOP can pass NULL for this parameter.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001726 * Returns a negative error code on failure.
Johannes Berg85ad1812010-06-10 10:21:49 +02001727 * The callback can sleep.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001728 *
Randy Dunlap4e8998f2010-05-21 11:28:33 -07001729 * @get_survey: Return per-channel survey information
1730 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001731 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1732 * need to set wiphy->rfkill_poll to %true before registration,
1733 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001734 * The callback can sleep.
Johannes Bergaff89a92009-07-01 21:26:51 +02001735 *
Lukáš Turek310bc672009-12-21 22:50:48 +01001736 * @set_coverage_class: Set slot time for given coverage class as specified
1737 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1738 * accordingly. This callback is not required and may sleep.
1739 *
Johannes Bergaff89a92009-07-01 21:26:51 +02001740 * @testmode_cmd: Implement a cfg80211 test mode command.
Kalle Valoe1781ed2009-12-23 13:15:47 +01001741 * The callback can sleep.
Johannes Berga80f7c02009-12-23 13:15:32 +01001742 *
1743 * @flush: Flush all pending frames from the hardware queue, making sure
1744 * that the hardware queues are empty. If the parameter @drop is set
Kalle Valoe1781ed2009-12-23 13:15:47 +01001745 * to %true, pending frames may be dropped. The callback can sleep.
Johannes Berg5ce6e432010-05-11 16:20:57 +02001746 *
1747 * @channel_switch: Drivers that need (or want) to offload the channel
1748 * switch operation for CSAs received from the AP may implement this
1749 * callback. They must then call ieee80211_chswitch_done() to indicate
1750 * completion of the channel switch.
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001751 *
1752 * @napi_poll: Poll Rx queue for incoming data frames.
Bruno Randolf79b1c462010-11-24 14:34:41 +09001753 *
1754 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
1755 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
1756 * reject TX/RX mask combinations they cannot support by returning -EINVAL
1757 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
1758 *
1759 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
Johannes Berg4976b4e2011-01-04 13:02:32 +01001760 *
1761 * @remain_on_channel: Starts an off-channel period on the given channel, must
1762 * call back to ieee80211_ready_on_channel() when on that channel. Note
1763 * that normal channel traffic is not stopped as this is intended for hw
1764 * offload. Frames to transmit on the off-channel channel are transmitted
1765 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
1766 * duration (which will always be non-zero) expires, the driver must call
1767 * ieee80211_remain_on_channel_expired(). This callback may sleep.
1768 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
1769 * aborted before it expires. This callback may sleep.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001770 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001771struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001772 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001773 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001774 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001775 int (*add_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001776 struct ieee80211_vif *vif);
Johannes Berg34d4bc42010-08-27 12:35:58 +02001777 int (*change_interface)(struct ieee80211_hw *hw,
1778 struct ieee80211_vif *vif,
Johannes Berg2ca27bc2010-09-16 14:58:23 +02001779 enum nl80211_iftype new_type, bool p2p);
Jiri Bencf0706e82007-05-05 11:45:53 -07001780 void (*remove_interface)(struct ieee80211_hw *hw,
Johannes Berg1ed32e42009-12-23 13:15:45 +01001781 struct ieee80211_vif *vif);
Johannes Berge8975582008-10-09 12:18:51 +02001782 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001783 void (*bss_info_changed)(struct ieee80211_hw *hw,
1784 struct ieee80211_vif *vif,
1785 struct ieee80211_bss_conf *info,
1786 u32 changed);
Johannes Berg3ac64be2009-08-17 16:16:53 +02001787 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
Jiri Pirko22bedad32010-04-01 21:22:57 +00001788 struct netdev_hw_addr_list *mc_list);
Johannes Berg4150c572007-09-17 01:29:23 -04001789 void (*configure_filter)(struct ieee80211_hw *hw,
1790 unsigned int changed_flags,
1791 unsigned int *total_flags,
Johannes Berg3ac64be2009-08-17 16:16:53 +02001792 u64 multicast);
Johannes Berg17741cd2008-09-11 00:02:02 +02001793 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1794 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001795 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001796 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001797 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001798 void (*update_tkip_key)(struct ieee80211_hw *hw,
Johannes Bergb3fbdcf2010-01-21 11:40:47 +01001799 struct ieee80211_vif *vif,
1800 struct ieee80211_key_conf *conf,
1801 struct ieee80211_sta *sta,
1802 u32 iv32, u16 *phase1key);
Johannes Berga060bbf2010-04-27 11:59:34 +02001803 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg2a519312009-02-10 21:25:55 +01001804 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001805 void (*sw_scan_start)(struct ieee80211_hw *hw);
1806 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001807 int (*get_stats)(struct ieee80211_hw *hw,
1808 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001809 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1810 u32 *iv32, u16 *iv16);
Arik Nemtsovf23a4782010-11-08 11:51:06 +02001811 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07001812 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg34e89502010-02-03 13:59:58 +01001813 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1814 struct ieee80211_sta *sta);
1815 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1816 struct ieee80211_sta *sta);
Johannes Berg32bfd352007-12-19 01:31:26 +01001817 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001818 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001819 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e82007-05-05 11:45:53 -07001820 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e82007-05-05 11:45:53 -07001821 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001822 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001823 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001824 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001825 int (*ampdu_action)(struct ieee80211_hw *hw,
Johannes Bergc951ad32009-11-16 12:00:38 +01001826 struct ieee80211_vif *vif,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001827 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001828 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Holger Schurig12897232010-04-19 10:23:57 +02001829 int (*get_survey)(struct ieee80211_hw *hw, int idx,
1830 struct survey_info *survey);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001831 void (*rfkill_poll)(struct ieee80211_hw *hw);
Lukáš Turek310bc672009-12-21 22:50:48 +01001832 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
Johannes Bergaff89a92009-07-01 21:26:51 +02001833#ifdef CONFIG_NL80211_TESTMODE
1834 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1835#endif
Johannes Berga80f7c02009-12-23 13:15:32 +01001836 void (*flush)(struct ieee80211_hw *hw, bool drop);
Johannes Berg5ce6e432010-05-11 16:20:57 +02001837 void (*channel_switch)(struct ieee80211_hw *hw,
1838 struct ieee80211_channel_switch *ch_switch);
John W. Linville4e6cbfd2010-07-29 16:14:13 -04001839 int (*napi_poll)(struct ieee80211_hw *hw, int budget);
Bruno Randolf15d96752010-11-10 12:50:56 +09001840 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
1841 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
Johannes Berg21f83582010-12-18 17:20:47 +01001842
1843 int (*remain_on_channel)(struct ieee80211_hw *hw,
1844 struct ieee80211_channel *chan,
1845 enum nl80211_channel_type channel_type,
1846 int duration);
1847 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001848};
1849
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001850/**
1851 * ieee80211_alloc_hw - Allocate a new hardware device
1852 *
1853 * This must be called once for each hardware device. The returned pointer
1854 * must be used to refer to this device when calling other functions.
1855 * mac80211 allocates a private data area for the driver pointed to by
1856 * @priv in &struct ieee80211_hw, the size of this area is given as
1857 * @priv_data_len.
1858 *
1859 * @priv_data_len: length of private data
1860 * @ops: callbacks for this device
Jiri Bencf0706e82007-05-05 11:45:53 -07001861 */
1862struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1863 const struct ieee80211_ops *ops);
1864
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001865/**
1866 * ieee80211_register_hw - Register hardware device
1867 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001868 * You must call this function before any other functions in
1869 * mac80211. Note that before a hardware can be registered, you
1870 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001871 *
1872 * @hw: the device to register as returned by ieee80211_alloc_hw()
1873 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001874int ieee80211_register_hw(struct ieee80211_hw *hw);
1875
Johannes Berge1e54062010-11-30 08:58:45 +01001876/**
1877 * struct ieee80211_tpt_blink - throughput blink description
1878 * @throughput: throughput in Kbit/sec
1879 * @blink_time: blink time in milliseconds
1880 * (full cycle, ie. one off + one on period)
1881 */
1882struct ieee80211_tpt_blink {
1883 int throughput;
1884 int blink_time;
1885};
1886
Johannes Berg67408c82010-11-30 08:59:23 +01001887/**
1888 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
1889 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
1890 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
1891 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
1892 * interface is connected in some way, including being an AP
1893 */
1894enum ieee80211_tpt_led_trigger_flags {
1895 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
1896 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
1897 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
1898};
1899
Jiri Bencf0706e82007-05-05 11:45:53 -07001900#ifdef CONFIG_MAC80211_LEDS
1901extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1902extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001903extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001904extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Johannes Berge1e54062010-11-30 08:58:45 +01001905extern char *__ieee80211_create_tpt_led_trigger(
Johannes Berg67408c82010-11-30 08:59:23 +01001906 struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01001907 const struct ieee80211_tpt_blink *blink_table,
1908 unsigned int blink_table_len);
Jiri Bencf0706e82007-05-05 11:45:53 -07001909#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001910/**
1911 * ieee80211_get_tx_led_name - get name of TX LED
1912 *
1913 * mac80211 creates a transmit LED trigger for each wireless hardware
1914 * that can be used to drive LEDs if your driver registers a LED device.
1915 * This function returns the name (or %NULL if not configured for LEDs)
1916 * of the trigger so you can automatically link the LED device.
1917 *
1918 * @hw: the hardware to get the LED trigger name for
1919 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001920static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1921{
1922#ifdef CONFIG_MAC80211_LEDS
1923 return __ieee80211_get_tx_led_name(hw);
1924#else
1925 return NULL;
1926#endif
1927}
1928
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001929/**
1930 * ieee80211_get_rx_led_name - get name of RX LED
1931 *
1932 * mac80211 creates a receive LED trigger for each wireless hardware
1933 * that can be used to drive LEDs if your driver registers a LED device.
1934 * This function returns the name (or %NULL if not configured for LEDs)
1935 * of the trigger so you can automatically link the LED device.
1936 *
1937 * @hw: the hardware to get the LED trigger name for
1938 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001939static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1940{
1941#ifdef CONFIG_MAC80211_LEDS
1942 return __ieee80211_get_rx_led_name(hw);
1943#else
1944 return NULL;
1945#endif
1946}
1947
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001948/**
1949 * ieee80211_get_assoc_led_name - get name of association LED
1950 *
1951 * mac80211 creates a association LED trigger for each wireless hardware
1952 * that can be used to drive LEDs if your driver registers a LED device.
1953 * This function returns the name (or %NULL if not configured for LEDs)
1954 * of the trigger so you can automatically link the LED device.
1955 *
1956 * @hw: the hardware to get the LED trigger name for
1957 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001958static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1959{
1960#ifdef CONFIG_MAC80211_LEDS
1961 return __ieee80211_get_assoc_led_name(hw);
1962#else
1963 return NULL;
1964#endif
1965}
1966
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001967/**
1968 * ieee80211_get_radio_led_name - get name of radio LED
1969 *
1970 * mac80211 creates a radio change LED trigger for each wireless hardware
1971 * that can be used to drive LEDs if your driver registers a LED device.
1972 * This function returns the name (or %NULL if not configured for LEDs)
1973 * of the trigger so you can automatically link the LED device.
1974 *
1975 * @hw: the hardware to get the LED trigger name for
1976 */
1977static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1978{
1979#ifdef CONFIG_MAC80211_LEDS
1980 return __ieee80211_get_radio_led_name(hw);
1981#else
1982 return NULL;
1983#endif
1984}
Michael Buesch47f0c502007-09-27 15:10:44 +02001985
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001986/**
Johannes Berge1e54062010-11-30 08:58:45 +01001987 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
1988 * @hw: the hardware to create the trigger for
Johannes Berg67408c82010-11-30 08:59:23 +01001989 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
Johannes Berge1e54062010-11-30 08:58:45 +01001990 * @blink_table: the blink table -- needs to be ordered by throughput
1991 * @blink_table_len: size of the blink table
1992 *
1993 * This function returns %NULL (in case of error, or if no LED
1994 * triggers are configured) or the name of the new trigger.
1995 * This function must be called before ieee80211_register_hw().
1996 */
1997static inline char *
Johannes Berg67408c82010-11-30 08:59:23 +01001998ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
Johannes Berge1e54062010-11-30 08:58:45 +01001999 const struct ieee80211_tpt_blink *blink_table,
2000 unsigned int blink_table_len)
2001{
2002#ifdef CONFIG_MAC80211_LEDS
Johannes Berg67408c82010-11-30 08:59:23 +01002003 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
Johannes Berge1e54062010-11-30 08:58:45 +01002004 blink_table_len);
2005#else
2006 return NULL;
2007#endif
2008}
2009
2010/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002011 * ieee80211_unregister_hw - Unregister a hardware device
2012 *
2013 * This function instructs mac80211 to free allocated resources
2014 * and unregister netdevices from the networking subsystem.
2015 *
2016 * @hw: the hardware to unregister
2017 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002018void ieee80211_unregister_hw(struct ieee80211_hw *hw);
2019
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002020/**
2021 * ieee80211_free_hw - free hardware descriptor
2022 *
2023 * This function frees everything that was allocated, including the
2024 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002025 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002026 *
2027 * @hw: the hardware to free
2028 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002029void ieee80211_free_hw(struct ieee80211_hw *hw);
2030
Johannes Bergf2753dd2009-04-14 10:09:24 +02002031/**
2032 * ieee80211_restart_hw - restart hardware completely
2033 *
2034 * Call this function when the hardware was restarted for some reason
2035 * (hardware error, ...) and the driver is unable to restore its state
2036 * by itself. mac80211 assumes that at this point the driver/hardware
2037 * is completely uninitialised and stopped, it starts the process by
2038 * calling the ->start() operation. The driver will need to reset all
2039 * internal state that it has prior to calling this function.
2040 *
2041 * @hw: the hardware to restart
2042 */
2043void ieee80211_restart_hw(struct ieee80211_hw *hw);
2044
John W. Linville4e6cbfd2010-07-29 16:14:13 -04002045/** ieee80211_napi_schedule - schedule NAPI poll
2046 *
2047 * Use this function to schedule NAPI polling on a device.
2048 *
2049 * @hw: the hardware to start polling
2050 */
2051void ieee80211_napi_schedule(struct ieee80211_hw *hw);
2052
2053/** ieee80211_napi_complete - complete NAPI polling
2054 *
2055 * Use this function to finish NAPI polling on a device.
2056 *
2057 * @hw: the hardware to stop polling
2058 */
2059void ieee80211_napi_complete(struct ieee80211_hw *hw);
2060
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002061/**
2062 * ieee80211_rx - receive frame
2063 *
2064 * Use this function to hand received frames to mac80211. The receive
Zhu Yie3cf8b32010-03-29 17:35:07 +08002065 * buffer in @skb must start with an IEEE 802.11 header. In case of a
2066 * paged @skb is used, the driver is recommended to put the ieee80211
2067 * header of the frame on the linear part of the @skb to avoid memory
2068 * allocation and/or memcpy by the stack.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002069 *
Johannes Berg2485f712008-02-25 16:27:41 +01002070 * This function may not be called in IRQ context. Calls to this function
Kalle Valoe36e49f2009-10-13 20:33:13 +03002071 * for a single hardware must be synchronized against each other. Calls to
2072 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
2073 * mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002074 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03002075 * In process context use instead ieee80211_rx_ni().
Johannes Bergd20ef632009-10-11 15:10:40 +02002076 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002077 * @hw: the hardware this frame came in on
2078 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002079 */
John W. Linville103bf9f2009-08-20 16:34:15 -04002080void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002081
2082/**
2083 * ieee80211_rx_irqsafe - receive frame
2084 *
2085 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01002086 * (internally defers to a tasklet.)
2087 *
Kalle Valoe36e49f2009-10-13 20:33:13 +03002088 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
2089 * be mixed for a single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002090 *
2091 * @hw: the hardware this frame came in on
2092 * @skb: the buffer to receive, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002093 */
Johannes Bergf1d58c22009-06-17 13:13:00 +02002094void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07002095
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002096/**
Kalle Valoe36e49f2009-10-13 20:33:13 +03002097 * ieee80211_rx_ni - receive frame (in process context)
2098 *
2099 * Like ieee80211_rx() but can be called in process context
2100 * (internally disables bottom halves).
2101 *
2102 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2103 * not be mixed for a single hardware.
2104 *
2105 * @hw: the hardware this frame came in on
2106 * @skb: the buffer to receive, owned by mac80211 after this call
2107 */
2108static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2109 struct sk_buff *skb)
2110{
2111 local_bh_disable();
2112 ieee80211_rx(hw, skb);
2113 local_bh_enable();
2114}
2115
Gertjan van Wingerded24deb22009-12-04 23:46:54 +01002116/*
2117 * The TX headroom reserved by mac80211 for its own tx_status functions.
2118 * This is enough for the radiotap header.
2119 */
2120#define IEEE80211_TX_STATUS_HEADROOM 13
2121
Kalle Valoe36e49f2009-10-13 20:33:13 +03002122/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002123 * ieee80211_tx_status - transmit status callback
2124 *
2125 * Call this function for all transmitted frames after they have been
2126 * transmitted. It is permissible to not call this function for
2127 * multicast frames but this can affect statistics.
2128 *
Johannes Berg2485f712008-02-25 16:27:41 +01002129 * This function may not be called in IRQ context. Calls to this function
2130 * for a single hardware must be synchronized against each other. Calls
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002131 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2132 * may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01002133 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002134 * @hw: the hardware the frame was transmitted by
2135 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002136 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002137void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002138 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01002139
2140/**
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002141 * ieee80211_tx_status_ni - transmit status callback (in process context)
2142 *
2143 * Like ieee80211_tx_status() but can be called in process context.
2144 *
2145 * Calls to this function, ieee80211_tx_status() and
2146 * ieee80211_tx_status_irqsafe() may not be mixed
2147 * for a single hardware.
2148 *
2149 * @hw: the hardware the frame was transmitted by
2150 * @skb: the frame that was transmitted, owned by mac80211 after this call
2151 */
2152static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2153 struct sk_buff *skb)
2154{
2155 local_bh_disable();
2156 ieee80211_tx_status(hw, skb);
2157 local_bh_enable();
2158}
2159
2160/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002161 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01002162 *
2163 * Like ieee80211_tx_status() but can be called in IRQ context
2164 * (internally defers to a tasklet.)
2165 *
Johannes Stezenbach20ed3162010-11-30 16:49:23 +01002166 * Calls to this function, ieee80211_tx_status() and
2167 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
Johannes Berg2485f712008-02-25 16:27:41 +01002168 *
2169 * @hw: the hardware the frame was transmitted by
2170 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01002171 */
Jiri Bencf0706e82007-05-05 11:45:53 -07002172void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02002173 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07002174
2175/**
Johannes Bergeddcbb92009-10-29 08:30:35 +01002176 * ieee80211_beacon_get_tim - beacon generation function
2177 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002178 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Bergeddcbb92009-10-29 08:30:35 +01002179 * @tim_offset: pointer to variable that will receive the TIM IE offset.
2180 * Set to 0 if invalid (in non-AP modes).
2181 * @tim_length: pointer to variable that will receive the TIM IE length,
2182 * (including the ID and length bytes!).
2183 * Set to 0 if invalid (in non-AP modes).
2184 *
2185 * If the driver implements beaconing modes, it must use this function to
2186 * obtain the beacon frame/template.
2187 *
2188 * If the beacon frames are generated by the host system (i.e., not in
2189 * hardware/firmware), the driver uses this function to get each beacon
2190 * frame from mac80211 -- it is responsible for calling this function
2191 * before the beacon is needed (e.g. based on hardware interrupt).
2192 *
2193 * If the beacon frames are generated by the device, then the driver
2194 * must use the returned beacon as the template and change the TIM IE
2195 * according to the current DTIM parameters/TIM bitmap.
2196 *
2197 * The driver is responsible for freeing the returned skb.
2198 */
2199struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2200 struct ieee80211_vif *vif,
2201 u16 *tim_offset, u16 *tim_length);
2202
2203/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002204 * ieee80211_beacon_get - beacon generation function
2205 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002206 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002207 *
Johannes Bergeddcbb92009-10-29 08:30:35 +01002208 * See ieee80211_beacon_get_tim().
Jiri Bencf0706e82007-05-05 11:45:53 -07002209 */
Johannes Bergeddcbb92009-10-29 08:30:35 +01002210static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2211 struct ieee80211_vif *vif)
2212{
2213 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2214}
Jiri Bencf0706e82007-05-05 11:45:53 -07002215
2216/**
Kalle Valo7044cc52010-01-05 20:16:19 +02002217 * ieee80211_pspoll_get - retrieve a PS Poll template
2218 * @hw: pointer obtained from ieee80211_alloc_hw().
2219 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2220 *
2221 * Creates a PS Poll a template which can, for example, uploaded to
2222 * hardware. The template must be updated after association so that correct
2223 * AID, BSSID and MAC address is used.
2224 *
2225 * Note: Caller (or hardware) is responsible for setting the
2226 * &IEEE80211_FCTL_PM bit.
2227 */
2228struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2229 struct ieee80211_vif *vif);
2230
2231/**
2232 * ieee80211_nullfunc_get - retrieve a nullfunc template
2233 * @hw: pointer obtained from ieee80211_alloc_hw().
2234 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2235 *
2236 * Creates a Nullfunc template which can, for example, uploaded to
2237 * hardware. The template must be updated after association so that correct
2238 * BSSID and address is used.
2239 *
2240 * Note: Caller (or hardware) is responsible for setting the
2241 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2242 */
2243struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2244 struct ieee80211_vif *vif);
2245
2246/**
Kalle Valo05e54ea2010-01-05 20:16:38 +02002247 * ieee80211_probereq_get - retrieve a Probe Request template
2248 * @hw: pointer obtained from ieee80211_alloc_hw().
2249 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2250 * @ssid: SSID buffer
2251 * @ssid_len: length of SSID
2252 * @ie: buffer containing all IEs except SSID for the template
2253 * @ie_len: length of the IE buffer
2254 *
2255 * Creates a Probe Request template which can, for example, be uploaded to
2256 * hardware.
2257 */
2258struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2259 struct ieee80211_vif *vif,
2260 const u8 *ssid, size_t ssid_len,
2261 const u8 *ie, size_t ie_len);
2262
2263/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002264 * ieee80211_rts_get - RTS frame generation function
2265 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002266 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002267 * @frame: pointer to the frame that is going to be protected by the RTS.
2268 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002269 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002270 * @rts: The buffer where to store the RTS frame.
2271 *
2272 * If the RTS frames are generated by the host system (i.e., not in
2273 * hardware/firmware), the low-level driver uses this function to receive
2274 * the next RTS frame from the 802.11 code. The low-level is responsible
2275 * for calling this function before and RTS frame is needed.
2276 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002277void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002278 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002279 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07002280 struct ieee80211_rts *rts);
2281
2282/**
2283 * ieee80211_rts_duration - Get the duration field for an RTS frame
2284 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002285 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002286 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02002287 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002288 *
2289 * If the RTS is generated in firmware, but the host system must provide
2290 * the duration field, the low-level driver uses this function to receive
2291 * the duration field value in little-endian byteorder.
2292 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002293__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2294 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002295 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07002296
2297/**
2298 * ieee80211_ctstoself_get - CTS-to-self frame generation function
2299 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002300 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002301 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2302 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02002303 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002304 * @cts: The buffer where to store the CTS-to-self frame.
2305 *
2306 * If the CTS-to-self frames are generated by the host system (i.e., not in
2307 * hardware/firmware), the low-level driver uses this function to receive
2308 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2309 * for calling this function before and CTS-to-self frame is needed.
2310 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002311void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2312 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002313 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002314 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07002315 struct ieee80211_cts *cts);
2316
2317/**
2318 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2319 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002320 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002321 * @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 +02002322 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07002323 *
2324 * If the CTS-to-self is generated in firmware, but the host system must provide
2325 * the duration field, the low-level driver uses this function to receive
2326 * the duration field value in little-endian byteorder.
2327 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002328__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2329 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002330 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02002331 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07002332
2333/**
2334 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
2335 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002336 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002337 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01002338 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07002339 *
2340 * Calculate the duration field of some generic frame, given its
2341 * length and transmission rate (in 100kbps).
2342 */
Johannes Berg32bfd352007-12-19 01:31:26 +01002343__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2344 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07002345 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01002346 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07002347
2348/**
2349 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2350 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg1ed32e42009-12-23 13:15:45 +01002351 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Jiri Bencf0706e82007-05-05 11:45:53 -07002352 *
2353 * Function for accessing buffered broadcast and multicast frames. If
2354 * hardware/firmware does not implement buffering of broadcast/multicast
2355 * frames when power saving is used, 802.11 code buffers them in the host
2356 * memory. The low-level driver uses this function to fetch next buffered
2357 * frame. In most cases, this is used when generating beacon frame. This
2358 * function returns a pointer to the next buffered skb or NULL if no more
2359 * buffered frames are available.
2360 *
2361 * Note: buffered frames are returned only after DTIM beacon frame was
2362 * generated with ieee80211_beacon_get() and the low-level driver must thus
2363 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2364 * NULL if the previous generated beacon was not DTIM, so the low-level driver
2365 * does not need to check for DTIM beacons separately and should be able to
2366 * use common code for all beacons.
2367 */
2368struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02002369ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07002370
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002371/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002372 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
2373 *
2374 * This function computes a TKIP rc4 key for an skb. It computes
2375 * a phase 1 key if needed (iv16 wraps around). This function is to
2376 * be used by drivers which can do HW encryption but need to compute
2377 * to phase 1/2 key in SW.
2378 *
2379 * @keyconf: the parameter passed with the set key
2380 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002381 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002382 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02002383 */
2384void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2385 struct sk_buff *skb,
2386 enum ieee80211_tkip_key_type type, u8 *key);
2387/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002388 * ieee80211_wake_queue - wake specific queue
2389 * @hw: pointer as obtained from ieee80211_alloc_hw().
2390 * @queue: queue number (counted from zero).
2391 *
2392 * Drivers should use this function instead of netif_wake_queue.
2393 */
2394void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2395
2396/**
2397 * ieee80211_stop_queue - stop specific queue
2398 * @hw: pointer as obtained from ieee80211_alloc_hw().
2399 * @queue: queue number (counted from zero).
2400 *
2401 * Drivers should use this function instead of netif_stop_queue.
2402 */
2403void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2404
2405/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03002406 * ieee80211_queue_stopped - test status of the queue
2407 * @hw: pointer as obtained from ieee80211_alloc_hw().
2408 * @queue: queue number (counted from zero).
2409 *
2410 * Drivers should use this function instead of netif_stop_queue.
2411 */
2412
2413int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2414
2415/**
Jiri Bencf0706e82007-05-05 11:45:53 -07002416 * ieee80211_stop_queues - stop all queues
2417 * @hw: pointer as obtained from ieee80211_alloc_hw().
2418 *
2419 * Drivers should use this function instead of netif_stop_queue.
2420 */
2421void ieee80211_stop_queues(struct ieee80211_hw *hw);
2422
2423/**
2424 * ieee80211_wake_queues - wake all queues
2425 * @hw: pointer as obtained from ieee80211_alloc_hw().
2426 *
2427 * Drivers should use this function instead of netif_wake_queue.
2428 */
2429void ieee80211_wake_queues(struct ieee80211_hw *hw);
2430
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002431/**
2432 * ieee80211_scan_completed - completed hardware scan
2433 *
2434 * When hardware scan offload is used (i.e. the hw_scan() callback is
2435 * assigned) this function needs to be called by the driver to notify
Johannes Berg8789d452010-08-26 13:30:26 +02002436 * mac80211 that the scan finished. This function can be called from
2437 * any context, including hardirq context.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002438 *
2439 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01002440 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04002441 */
Johannes Berg2a519312009-02-10 21:25:55 +01002442void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e82007-05-05 11:45:53 -07002443
Johannes Bergdabeb342007-11-09 01:57:29 +01002444/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07002445 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01002446 *
2447 * This function iterates over the interfaces associated with a given
2448 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002449 * This function allows the iterator function to sleep, when the iterator
2450 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
2451 * be used.
Felix Fietkau2944f452010-09-14 18:37:20 +02002452 * Does not iterate over a new interface during add_interface()
Johannes Bergdabeb342007-11-09 01:57:29 +01002453 *
2454 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002455 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01002456 * @data: first argument of the iterator function
2457 */
2458void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2459 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01002460 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01002461 void *data);
2462
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002463/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002464 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2465 *
2466 * This function iterates over the interfaces associated with a given
2467 * hardware that are currently active and calls the callback for them.
2468 * This function requires the iterator callback function to be atomic,
2469 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
Felix Fietkau2944f452010-09-14 18:37:20 +02002470 * Does not iterate over a new interface during add_interface()
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02002471 *
2472 * @hw: the hardware struct of which the interfaces should be iterated over
2473 * @iterator: the iterator function to call, cannot sleep
2474 * @data: first argument of the iterator function
2475 */
2476void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2477 void (*iterator)(void *data,
2478 u8 *mac,
2479 struct ieee80211_vif *vif),
2480 void *data);
2481
2482/**
Luis R. Rodriguez42935ec2009-07-29 20:08:07 -04002483 * ieee80211_queue_work - add work onto the mac80211 workqueue
2484 *
2485 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2486 * This helper ensures drivers are not queueing work when they should not be.
2487 *
2488 * @hw: the hardware struct for the interface we are adding work for
2489 * @work: the work we want to add onto the mac80211 workqueue
2490 */
2491void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2492
2493/**
2494 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2495 *
2496 * Drivers and mac80211 use this to queue delayed work onto the mac80211
2497 * workqueue.
2498 *
2499 * @hw: the hardware struct for the interface we are adding work for
2500 * @dwork: delayable work to queue onto the mac80211 workqueue
2501 * @delay: number of jiffies to wait before queueing
2502 */
2503void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2504 struct delayed_work *dwork,
2505 unsigned long delay);
2506
2507/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002508 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002509 * @sta: the station for which to start a BA session
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002510 * @tid: the TID to BA on.
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05302511 * @timeout: session timeout value (in TUs)
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002512 *
2513 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002514 *
2515 * Although mac80211/low level driver/user space application can estimate
2516 * the need to start aggregation on a certain RA/TID, the session level
2517 * will be managed by the mac80211.
2518 */
Sujith Manoharanbd2ce6e2010-12-15 07:47:10 +05302519int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
2520 u16 timeout);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002521
2522/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002523 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002524 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002525 * @ra: receiver address of the BA session recipient.
2526 * @tid: the TID to BA on.
2527 *
2528 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02002529 * finished with preparations for the BA session. It can be called
2530 * from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002531 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002532void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002533 u16 tid);
2534
2535/**
2536 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
Johannes Bergc951ad32009-11-16 12:00:38 +01002537 * @sta: the station whose BA session to stop
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002538 * @tid: the TID to stop BA.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07002539 *
Johannes Berg6a8579d2010-05-27 14:41:07 +02002540 * Return: negative error if the TID is invalid, or no aggregation active
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002541 *
2542 * Although mac80211/low level driver/user space application can estimate
2543 * the need to stop aggregation on a certain RA/TID, the session level
2544 * will be managed by the mac80211.
2545 */
Johannes Berg6a8579d2010-05-27 14:41:07 +02002546int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002547
2548/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002549 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
Johannes Berg1ed32e42009-12-23 13:15:45 +01002550 * @vif: &struct ieee80211_vif pointer from the add_interface callback
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002551 * @ra: receiver address of the BA session recipient.
2552 * @tid: the desired TID to BA on.
2553 *
2554 * This function must be called by low level driver once it has
Johannes Berg5d22c892010-06-10 10:21:40 +02002555 * finished with preparations for the BA session tear down. It
2556 * can be called from any context.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002557 */
Johannes Bergc951ad32009-11-16 12:00:38 +01002558void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02002559 u16 tid);
2560
Mohamed Abbas84363e62008-04-04 16:59:58 -07002561/**
Johannes Berg17741cd2008-09-11 00:02:02 +02002562 * ieee80211_find_sta - find a station
2563 *
Johannes Berg5ed176e2009-11-04 14:42:28 +01002564 * @vif: virtual interface to look for station on
Johannes Berg17741cd2008-09-11 00:02:02 +02002565 * @addr: station's address
2566 *
2567 * This function must be called under RCU lock and the
2568 * resulting pointer is only valid under RCU lock as well.
2569 */
Johannes Berg5ed176e2009-11-04 14:42:28 +01002570struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02002571 const u8 *addr);
2572
Kalle Valo04de8382009-03-22 21:57:35 +02002573/**
Ben Greear686b9cb2010-09-23 09:44:36 -07002574 * ieee80211_find_sta_by_ifaddr - find a station on hardware
Johannes Berg5ed176e2009-11-04 14:42:28 +01002575 *
2576 * @hw: pointer as obtained from ieee80211_alloc_hw()
Ben Greear686b9cb2010-09-23 09:44:36 -07002577 * @addr: remote station's address
2578 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002579 *
2580 * This function must be called under RCU lock and the
2581 * resulting pointer is only valid under RCU lock as well.
2582 *
Ben Greear686b9cb2010-09-23 09:44:36 -07002583 * NOTE: You may pass NULL for localaddr, but then you will just get
2584 * the first STA that matches the remote address 'addr'.
2585 * We can have multiple STA associated with multiple
2586 * logical stations (e.g. consider a station connecting to another
2587 * BSSID on the same AP hardware without disconnecting first).
2588 * In this case, the result of this method with localaddr NULL
2589 * is not reliable.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002590 *
Ben Greear686b9cb2010-09-23 09:44:36 -07002591 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
Johannes Berg5ed176e2009-11-04 14:42:28 +01002592 */
Ben Greear686b9cb2010-09-23 09:44:36 -07002593struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
2594 const u8 *addr,
2595 const u8 *localaddr);
Johannes Berg5ed176e2009-11-04 14:42:28 +01002596
2597/**
Johannes Bergaf818582009-11-06 11:35:50 +01002598 * ieee80211_sta_block_awake - block station from waking up
2599 * @hw: the hardware
2600 * @pubsta: the station
2601 * @block: whether to block or unblock
2602 *
2603 * Some devices require that all frames that are on the queues
2604 * for a specific station that went to sleep are flushed before
2605 * a poll response or frames after the station woke up can be
2606 * delivered to that it. Note that such frames must be rejected
2607 * by the driver as filtered, with the appropriate status flag.
2608 *
2609 * This function allows implementing this mode in a race-free
2610 * manner.
2611 *
2612 * To do this, a driver must keep track of the number of frames
2613 * still enqueued for a specific station. If this number is not
2614 * zero when the station goes to sleep, the driver must call
2615 * this function to force mac80211 to consider the station to
2616 * be asleep regardless of the station's actual state. Once the
2617 * number of outstanding frames reaches zero, the driver must
2618 * call this function again to unblock the station. That will
2619 * cause mac80211 to be able to send ps-poll responses, and if
2620 * the station queried in the meantime then frames will also
2621 * be sent out as a result of this. Additionally, the driver
2622 * will be notified that the station woke up some time after
2623 * it is unblocked, regardless of whether the station actually
2624 * woke up while blocked or not.
2625 */
2626void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2627 struct ieee80211_sta *pubsta, bool block);
2628
2629/**
Juuso Oikarinena619a4c2010-11-11 08:50:18 +02002630 * ieee80211_ap_probereq_get - retrieve a Probe Request template
2631 * @hw: pointer obtained from ieee80211_alloc_hw().
2632 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2633 *
2634 * Creates a Probe Request template which can, for example, be uploaded to
2635 * hardware. The template is filled with bssid, ssid and supported rate
2636 * information. This function must only be called from within the
2637 * .bss_info_changed callback function and only in managed mode. The function
2638 * is only useful when the interface is associated, otherwise it will return
2639 * NULL.
2640 */
2641struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
2642 struct ieee80211_vif *vif);
2643
2644/**
Kalle Valo04de8382009-03-22 21:57:35 +02002645 * ieee80211_beacon_loss - inform hardware does not receive beacons
2646 *
Johannes Berg1ed32e42009-12-23 13:15:45 +01002647 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Kalle Valo04de8382009-03-22 21:57:35 +02002648 *
Bob Copeland2738bd62010-08-21 16:39:01 -04002649 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002650 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
Kalle Valo04de8382009-03-22 21:57:35 +02002651 * hardware is not receiving beacons with this function.
2652 */
2653void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002654
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002655/**
2656 * ieee80211_connection_loss - inform hardware has lost connection to the AP
2657 *
2658 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2659 *
Bob Copeland2738bd62010-08-21 16:39:01 -04002660 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
Juuso Oikarinen1e4dcd02010-03-19 07:14:53 +02002661 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2662 * needs to inform if the connection to the AP has been lost.
2663 *
2664 * This function will cause immediate change to disassociated state,
2665 * without connection recovery attempts.
2666 */
2667void ieee80211_connection_loss(struct ieee80211_vif *vif);
2668
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02002669/**
Juuso Oikarinenf90754c2010-06-21 08:59:39 +03002670 * ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
2671 *
2672 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2673 *
2674 * Some hardware require full power save to manage simultaneous BT traffic
2675 * on the WLAN frequency. Full PSM is required periodically, whenever there are
2676 * burst of BT traffic. The hardware gets information of BT traffic via
2677 * hardware co-existence lines, and consequentially requests mac80211 to
2678 * (temporarily) enter full psm.
2679 * This function will only temporarily disable dynamic PS, not enable PSM if
2680 * it was not already enabled.
2681 * The driver must make sure to re-enable dynamic PS using
2682 * ieee80211_enable_dyn_ps() if the driver has disabled it.
2683 *
2684 */
2685void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
2686
2687/**
2688 * ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
2689 *
2690 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2691 *
2692 * This function restores dynamic PS after being temporarily disabled via
2693 * ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
2694 * be coupled with an eventual call to this function.
2695 *
2696 */
2697void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
2698
2699/**
Juuso Oikarinena97c13c2010-03-23 09:02:34 +02002700 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
2701 * rssi threshold triggered
2702 *
2703 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2704 * @rssi_event: the RSSI trigger event type
2705 * @gfp: context flags
2706 *
2707 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
2708 * monitoring is configured with an rssi threshold, the driver will inform
2709 * whenever the rssi level reaches the threshold.
2710 */
2711void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
2712 enum nl80211_cqm_rssi_threshold_event rssi_event,
2713 gfp_t gfp);
2714
Johannes Berg5ce6e432010-05-11 16:20:57 +02002715/**
2716 * ieee80211_chswitch_done - Complete channel switch process
2717 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2718 * @success: make the channel switch successful or not
2719 *
2720 * Complete the channel switch post-process: set the new operational channel
2721 * and wake up the suspended queues.
2722 */
2723void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
2724
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02002725/**
2726 * ieee80211_request_smps - request SM PS transition
2727 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
Johannes Berg633dd1e2010-08-18 15:01:23 +02002728 * @smps_mode: new SM PS mode
Johannes Bergd1f5b7a2010-08-05 17:05:55 +02002729 *
2730 * This allows the driver to request an SM PS transition in managed
2731 * mode. This is useful when the driver has more information than
2732 * the stack about possible interference, for example by bluetooth.
2733 */
2734void ieee80211_request_smps(struct ieee80211_vif *vif,
2735 enum ieee80211_smps_mode smps_mode);
2736
Johannes Berge31b8212010-10-05 19:39:30 +02002737/**
2738 * ieee80211_key_removed - disable hw acceleration for key
2739 * @key_conf: The key hw acceleration should be disabled for
2740 *
2741 * This allows drivers to indicate that the given key has been
2742 * removed from hardware acceleration, due to a new key that
2743 * was added. Don't use this if the key can continue to be used
2744 * for TX, if the key restriction is on RX only it is permitted
2745 * to keep the key for TX only and not call this function.
2746 *
2747 * Due to locking constraints, it may only be called during
2748 * @set_key. This function must be allowed to sleep, and the
2749 * key it tries to disable may still be used until it returns.
2750 */
2751void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
2752
Johannes Berg21f83582010-12-18 17:20:47 +01002753/**
2754 * ieee80211_ready_on_channel - notification of remain-on-channel start
2755 * @hw: pointer as obtained from ieee80211_alloc_hw()
2756 */
2757void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
2758
2759/**
2760 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
2761 * @hw: pointer as obtained from ieee80211_alloc_hw()
2762 */
2763void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
2764
Johannes Berg4b7679a2008-09-18 18:14:18 +02002765/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002766
Johannes Berg4b7679a2008-09-18 18:14:18 +02002767/**
Sujith81cb7622009-02-12 11:38:37 +05302768 * enum rate_control_changed - flags to indicate which parameter changed
2769 *
2770 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2771 * changed, rate control algorithm can update its internal state if needed.
2772 */
2773enum rate_control_changed {
2774 IEEE80211_RC_HT_CHANGED = BIT(0)
2775};
2776
2777/**
Johannes Berge6a98542008-10-21 12:40:02 +02002778 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002779 *
Johannes Berge6a98542008-10-21 12:40:02 +02002780 * @hw: The hardware the algorithm is invoked for.
2781 * @sband: The band this frame is being transmitted on.
2782 * @bss_conf: the current BSS configuration
2783 * @reported_rate: The rate control algorithm can fill this in to indicate
2784 * which rate should be reported to userspace as the current rate and
2785 * used for rate calculations in the mesh network.
2786 * @rts: whether RTS will be used for this frame because it is longer than the
2787 * RTS threshold
2788 * @short_preamble: whether mac80211 will request short-preamble transmission
2789 * if the selected rate supports it
2790 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002791 * (deprecated; this will be removed once drivers get updated to use
2792 * rate_idx_mask)
2793 * @rate_idx_mask: user-requested rate mask (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002794 * @skb: the skb that will be transmitted, the control information in it needs
2795 * to be filled in
Felix Fietkau8f0729b2010-11-11 15:07:23 +01002796 * @bss: whether this frame is sent out in AP or IBSS mode
Johannes Berg4b7679a2008-09-18 18:14:18 +02002797 */
Johannes Berge6a98542008-10-21 12:40:02 +02002798struct ieee80211_tx_rate_control {
2799 struct ieee80211_hw *hw;
2800 struct ieee80211_supported_band *sband;
2801 struct ieee80211_bss_conf *bss_conf;
2802 struct sk_buff *skb;
2803 struct ieee80211_tx_rate reported_rate;
2804 bool rts, short_preamble;
2805 u8 max_rate_idx;
Jouni Malinen37eb0b12010-01-06 13:09:08 +02002806 u32 rate_idx_mask;
Felix Fietkau8f0729b2010-11-11 15:07:23 +01002807 bool bss;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002808};
2809
2810struct rate_control_ops {
2811 struct module *module;
2812 const char *name;
2813 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002814 void (*free)(void *priv);
2815
2816 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2817 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2818 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302819 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2820 struct ieee80211_sta *sta,
Sujith4fa00432010-03-01 14:42:57 +05302821 void *priv_sta, u32 changed,
2822 enum nl80211_channel_type oper_chan_type);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002823 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2824 void *priv_sta);
2825
2826 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2827 struct ieee80211_sta *sta, void *priv_sta,
2828 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002829 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2830 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002831
2832 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2833 struct dentry *dir);
2834 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2835};
2836
2837static inline int rate_supported(struct ieee80211_sta *sta,
2838 enum ieee80211_band band,
2839 int index)
2840{
2841 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2842}
2843
Luis R. Rodriguez4c6d4f52009-07-16 10:05:41 -07002844/**
2845 * rate_control_send_low - helper for drivers for management/no-ack frames
2846 *
2847 * Rate control algorithms that agree to use the lowest rate to
2848 * send management frames and NO_ACK data with the respective hw
2849 * retries should use this in the beginning of their mac80211 get_rate
2850 * callback. If true is returned the rate control can simply return.
2851 * If false is returned we guarantee that sta and sta and priv_sta is
2852 * not null.
2853 *
2854 * Rate control algorithms wishing to do more intelligent selection of
2855 * rate for multicast/broadcast frames may choose to not use this.
2856 *
2857 * @sta: &struct ieee80211_sta pointer to the target destination. Note
2858 * that this may be null.
2859 * @priv_sta: private rate control structure. This may be null.
2860 * @txrc: rate control information we sholud populate for mac80211.
2861 */
2862bool rate_control_send_low(struct ieee80211_sta *sta,
2863 void *priv_sta,
2864 struct ieee80211_tx_rate_control *txrc);
2865
2866
Johannes Berg4b7679a2008-09-18 18:14:18 +02002867static inline s8
2868rate_lowest_index(struct ieee80211_supported_band *sband,
2869 struct ieee80211_sta *sta)
2870{
2871 int i;
2872
2873 for (i = 0; i < sband->n_bitrates; i++)
2874 if (rate_supported(sta, sband->band, i))
2875 return i;
2876
2877 /* warn when we cannot find a rate. */
2878 WARN_ON(1);
2879
2880 return 0;
2881}
2882
Luis R. Rodriguezb770b432009-07-16 10:15:09 -07002883static inline
2884bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2885 struct ieee80211_sta *sta)
2886{
2887 unsigned int i;
2888
2889 for (i = 0; i < sband->n_bitrates; i++)
2890 if (rate_supported(sta, sband->band, i))
2891 return true;
2892 return false;
2893}
Johannes Berg4b7679a2008-09-18 18:14:18 +02002894
2895int ieee80211_rate_control_register(struct rate_control_ops *ops);
2896void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2897
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002898static inline bool
2899conf_is_ht20(struct ieee80211_conf *conf)
2900{
Johannes Berg47979382009-01-07 10:13:27 +01002901 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002902}
2903
2904static inline bool
2905conf_is_ht40_minus(struct ieee80211_conf *conf)
2906{
Johannes Berg47979382009-01-07 10:13:27 +01002907 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002908}
2909
2910static inline bool
2911conf_is_ht40_plus(struct ieee80211_conf *conf)
2912{
Johannes Berg47979382009-01-07 10:13:27 +01002913 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002914}
2915
2916static inline bool
2917conf_is_ht40(struct ieee80211_conf *conf)
2918{
2919 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2920}
2921
2922static inline bool
2923conf_is_ht(struct ieee80211_conf *conf)
2924{
Johannes Berg47979382009-01-07 10:13:27 +01002925 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002926}
2927
Johannes Berg2ca27bc2010-09-16 14:58:23 +02002928static inline enum nl80211_iftype
2929ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
2930{
2931 if (p2p) {
2932 switch (type) {
2933 case NL80211_IFTYPE_STATION:
2934 return NL80211_IFTYPE_P2P_CLIENT;
2935 case NL80211_IFTYPE_AP:
2936 return NL80211_IFTYPE_P2P_GO;
2937 default:
2938 break;
2939 }
2940 }
2941 return type;
2942}
2943
2944static inline enum nl80211_iftype
2945ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
2946{
2947 return ieee80211_iftype_p2p(vif->type, vif->p2p);
2948}
2949
Jiri Bencf0706e82007-05-05 11:45:53 -07002950#endif /* MAC80211_H */