blob: c061044769737f72a54bb1afe8e70c6d77ca38a7 [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>
Johannes Bergae5eb022008-10-14 16:58:37 +02006 * Copyright 2007-2008 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/**
Johannes Berge100bb62008-04-30 18:51:21 +020076 * enum ieee80211_max_queues - maximum number of queues
77 *
78 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
Johannes Berge100bb62008-04-30 18:51:21 +020079 */
80enum ieee80211_max_queues {
Johannes Berg51b38142009-03-12 11:16:48 +010081 IEEE80211_MAX_QUEUES = 4,
Johannes Berge100bb62008-04-30 18:51:21 +020082};
83
84/**
Johannes Berg6b301cd2007-09-18 17:29:20 -040085 * struct ieee80211_tx_queue_params - transmit queue configuration
86 *
87 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +010088 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -040089 *
Bob Copelande37d4df2008-10-20 21:20:27 -040090 * @aifs: arbitration interframe space [0..255]
Johannes Bergf434b2d2008-07-10 11:22:31 +020091 * @cw_min: minimum contention window [a value of the form
92 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -040093 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +010094 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Johannes Berg6b301cd2007-09-18 17:29:20 -040095 */
Jiri Bencf0706e82007-05-05 11:45:53 -070096struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +020097 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +010098 u16 cw_min;
99 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200100 u8 aifs;
Jiri Bencf0706e82007-05-05 11:45:53 -0700101};
102
Johannes Berg6b301cd2007-09-18 17:29:20 -0400103/**
Johannes Berg57ffc582008-04-29 17:18:59 +0200104 * struct ieee80211_tx_queue_stats - transmit queue statistics
Johannes Berg6b301cd2007-09-18 17:29:20 -0400105 *
106 * @len: number of packets in queue
107 * @limit: queue length limit
108 * @count: number of frames sent
109 */
Johannes Berg57ffc582008-04-29 17:18:59 +0200110struct ieee80211_tx_queue_stats {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400111 unsigned int len;
112 unsigned int limit;
113 unsigned int count;
Jiri Bencf0706e82007-05-05 11:45:53 -0700114};
115
Jiri Bencf0706e82007-05-05 11:45:53 -0700116struct ieee80211_low_level_stats {
117 unsigned int dot11ACKFailureCount;
118 unsigned int dot11RTSFailureCount;
119 unsigned int dot11FCSErrorCount;
120 unsigned int dot11RTSSuccessCount;
121};
122
Johannes Berg471b3ef2007-12-28 14:32:58 +0100123/**
124 * enum ieee80211_bss_change - BSS change notification flags
125 *
126 * These flags are used with the bss_info_changed() callback
127 * to indicate which BSS parameter changed.
128 *
129 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
130 * also implies a change in the AID.
131 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
132 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300133 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700134 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200135 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200136 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200137 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
138 * reason (IBSS and managed mode)
139 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
140 * new beacon (beaconing modes)
141 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
142 * enabled/disabled (beaconing modes)
Johannes Berg471b3ef2007-12-28 14:32:58 +0100143 */
144enum ieee80211_bss_change {
145 BSS_CHANGED_ASSOC = 1<<0,
146 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
147 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300148 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700149 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200150 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg57c4d7b2009-04-23 16:10:04 +0200151 BSS_CHANGED_BEACON_INT = 1<<6,
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200152 BSS_CHANGED_BSSID = 1<<7,
153 BSS_CHANGED_BEACON = 1<<8,
154 BSS_CHANGED_BEACON_ENABLED = 1<<9,
Johannes Berg471b3ef2007-12-28 14:32:58 +0100155};
156
157/**
158 * struct ieee80211_bss_conf - holds the BSS's changing parameters
159 *
160 * This structure keeps information about a BSS (and an association
161 * to that BSS) that can change during the lifetime of the BSS.
162 *
163 * @assoc: association status
164 * @aid: association ID number, valid only when @assoc is true
165 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200166 * @use_short_preamble: use 802.11b short preamble;
167 * if the hardware cannot handle this it must set the
168 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
169 * @use_short_slot: use short slot time (only relevant for ERP);
170 * if the hardware cannot handle this it must set the
171 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800172 * @dtim_period: num of beacons before the next DTIM, for PSM
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700173 * @timestamp: beacon timestamp
174 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800175 * @assoc_capability: capabilities taken from assoc resp
Johannes Berg96dd22a2008-09-11 00:01:57 +0200176 * @basic_rates: bitmap of basic rates, each bit stands for an
177 * index into the rate table configured by the driver in
178 * the current band.
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200179 * @bssid: The BSSID for this BSS
180 * @enable_beacon: whether beaconing should be enabled or not
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200181 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
182 * This field is only valid when the channel type is one of the HT types.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100183 */
184struct ieee80211_bss_conf {
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200185 const u8 *bssid;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100186 /* association related data */
187 bool assoc;
188 u16 aid;
189 /* erp related data */
190 bool use_cts_prot;
191 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300192 bool use_short_slot;
Johannes Berg2d0ddec2009-04-23 16:13:26 +0200193 bool enable_beacon;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800194 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700195 u16 beacon_int;
196 u16 assoc_capability;
197 u64 timestamp;
Johannes Berg881d9482009-01-21 15:13:48 +0100198 u32 basic_rates;
Johannes Berg9ed6bcc2009-05-08 20:47:39 +0200199 u16 ht_operation_mode;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100200};
201
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800202/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700203 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800204 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700205 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800206 *
Johannes Berge039fa42008-05-15 12:55:29 +0200207 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
Johannes Berge6a98542008-10-21 12:40:02 +0200208 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
209 * number to this frame, taking care of not overwriting the fragment
210 * number and increasing the sequence number only when the
211 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
212 * assign sequence numbers to QoS-data frames but cannot do so correctly
213 * for non-QoS-data and management frames because beacons need them from
214 * that counter as well and mac80211 cannot guarantee proper sequencing.
215 * If this flag is set, the driver should instruct the hardware to
216 * assign a sequence number to the frame or assign one itself. Cf. IEEE
217 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
218 * beacons and always be clear for frames without a sequence number field.
Johannes Berge039fa42008-05-15 12:55:29 +0200219 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Johannes Berge039fa42008-05-15 12:55:29 +0200220 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
221 * station
Johannes Berge039fa42008-05-15 12:55:29 +0200222 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Johannes Berge039fa42008-05-15 12:55:29 +0200223 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
224 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
Johannes Berge6a98542008-10-21 12:40:02 +0200225 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
Johannes Berge039fa42008-05-15 12:55:29 +0200226 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
227 * because the destination STA was in powersave mode.
228 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
229 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
230 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300231 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
232 * so consider using block ack request (BAR).
Johannes Berge6a98542008-10-21 12:40:02 +0200233 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
234 * set by rate control algorithms to indicate probe rate, will
235 * be cleared for fragmented frames (except on the last fragment)
Johannes Berg2b874e82009-03-23 14:10:22 +0100236 * @IEEE80211_TX_INTFL_RCALGO: mac80211 internal flag, do not test or
237 * set this flag in the driver; indicates that the rate control
238 * algorithm was used and should be notified of TX status
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100239 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
240 * used to indicate that a pending frame requires TX processing before
241 * it can be sent out.
Johannes Berg8f77f382009-06-07 21:58:37 +0200242 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
243 * used to indicate that a frame was already retried due to PS
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800244 */
245enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200246 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge6a98542008-10-21 12:40:02 +0200247 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
248 IEEE80211_TX_CTL_NO_ACK = BIT(2),
249 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
250 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
251 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
252 IEEE80211_TX_CTL_AMPDU = BIT(6),
253 IEEE80211_TX_CTL_INJECTED = BIT(7),
254 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
255 IEEE80211_TX_STAT_ACK = BIT(9),
256 IEEE80211_TX_STAT_AMPDU = BIT(10),
257 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
258 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
Johannes Berg2b874e82009-03-23 14:10:22 +0100259 IEEE80211_TX_INTFL_RCALGO = BIT(13),
Johannes Bergcd8ffc82009-03-23 17:28:41 +0100260 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
Johannes Berg8f77f382009-06-07 21:58:37 +0200261 IEEE80211_TX_INTFL_RETRIED = BIT(15),
Johannes Berge6a98542008-10-21 12:40:02 +0200262};
263
Sujith2134e7e2009-01-22 09:00:52 +0530264/**
265 * enum mac80211_rate_control_flags - per-rate flags set by the
266 * Rate Control algorithm.
267 *
268 * These flags are set by the Rate control algorithm for each rate during tx,
269 * in the @flags member of struct ieee80211_tx_rate.
270 *
271 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
272 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
273 * This is set if the current BSS requires ERP protection.
274 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
275 * @IEEE80211_TX_RC_MCS: HT rate.
276 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
277 * Greenfield mode.
278 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
279 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
280 * adjacent 20 MHz channels, if the current channel type is
281 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
282 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
283 */
Johannes Berge6a98542008-10-21 12:40:02 +0200284enum mac80211_rate_control_flags {
285 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
286 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
287 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
288
289 /* rate index is an MCS rate number instead of an index */
290 IEEE80211_TX_RC_MCS = BIT(3),
291 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
292 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
293 IEEE80211_TX_RC_DUP_DATA = BIT(6),
294 IEEE80211_TX_RC_SHORT_GI = BIT(7),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800295};
296
Johannes Berge039fa42008-05-15 12:55:29 +0200297
Johannes Berge6a98542008-10-21 12:40:02 +0200298/* there are 40 bytes if you don't need the rateset to be kept */
299#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
Johannes Berge039fa42008-05-15 12:55:29 +0200300
Johannes Berge6a98542008-10-21 12:40:02 +0200301/* if you do need the rateset, then you have less space */
302#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
303
304/* maximum number of rate stages */
305#define IEEE80211_TX_MAX_RATES 5
Felix Fietkau870abdf2008-10-05 18:04:24 +0200306
307/**
Johannes Berge6a98542008-10-21 12:40:02 +0200308 * struct ieee80211_tx_rate - rate selection/status
Felix Fietkau870abdf2008-10-05 18:04:24 +0200309 *
Johannes Berge6a98542008-10-21 12:40:02 +0200310 * @idx: rate index to attempt to send with
311 * @flags: rate control flags (&enum mac80211_rate_control_flags)
Johannes Berge25cf4a2008-10-23 08:51:20 +0200312 * @count: number of tries in this rate before going to the next rate
Johannes Berge6a98542008-10-21 12:40:02 +0200313 *
314 * A value of -1 for @idx indicates an invalid rate and, if used
315 * in an array of retry rates, that no more rates should be tried.
316 *
317 * When used for transmit status reporting, the driver should
318 * always report the rate along with the flags it used.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200319 */
Johannes Berge6a98542008-10-21 12:40:02 +0200320struct ieee80211_tx_rate {
321 s8 idx;
322 u8 count;
323 u8 flags;
Felix Fietkau48212772008-11-03 21:05:01 +0100324} __attribute__((packed));
Felix Fietkau870abdf2008-10-05 18:04:24 +0200325
Johannes Berge039fa42008-05-15 12:55:29 +0200326/**
327 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200328 *
Johannes Berge039fa42008-05-15 12:55:29 +0200329 * This structure is placed in skb->cb for three uses:
330 * (1) mac80211 TX control - mac80211 tells the driver what to do
331 * (2) driver internal use (if applicable)
332 * (3) TX status information - driver tells mac80211 what happened
333 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200334 * The TX control's sta pointer is only valid during the ->tx call,
335 * it may be NULL.
336 *
Johannes Berge039fa42008-05-15 12:55:29 +0200337 * @flags: transmit info flags, defined above
Johannes Berge6a98542008-10-21 12:40:02 +0200338 * @band: the band to transmit on (use for checking for races)
Johannes Berg0f4ac382008-10-09 12:18:04 +0200339 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Kalle Valo8bef7a12008-11-30 20:56:28 +0200340 * @pad: padding, ignore
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700341 * @control: union for control data
342 * @status: union for status data
343 * @driver_data: array of driver_data pointers
Johannes Berge039fa42008-05-15 12:55:29 +0200344 * @ampdu_ack_len: number of aggregated frames.
345 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
346 * @ampdu_ack_map: block ack bit map for the aggregation.
347 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
348 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200349 */
Johannes Berge039fa42008-05-15 12:55:29 +0200350struct ieee80211_tx_info {
351 /* common information */
352 u32 flags;
353 u8 band;
Johannes Berge6a98542008-10-21 12:40:02 +0200354
Johannes Berge039fa42008-05-15 12:55:29 +0200355 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100356
Johannes Berge6a98542008-10-21 12:40:02 +0200357 /* 2 byte hole */
John W. Linville62727102008-11-12 10:01:41 -0500358 u8 pad[2];
Johannes Berg8318d782008-01-24 19:38:38 +0100359
Johannes Berge039fa42008-05-15 12:55:29 +0200360 union {
361 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200362 union {
363 /* rate control */
364 struct {
365 struct ieee80211_tx_rate rates[
366 IEEE80211_TX_MAX_RATES];
367 s8 rts_cts_rate_idx;
368 };
369 /* only needed before rate control */
370 unsigned long jiffies;
371 };
Johannes Berg25d834e2008-09-12 22:52:47 +0200372 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200373 struct ieee80211_vif *vif;
374 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200375 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200376 } control;
377 struct {
Johannes Berge6a98542008-10-21 12:40:02 +0200378 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
379 u8 ampdu_ack_len;
Johannes Berge039fa42008-05-15 12:55:29 +0200380 u64 ampdu_ack_map;
381 int ack_signal;
Johannes Berge6a98542008-10-21 12:40:02 +0200382 /* 8 bytes free */
Johannes Berge039fa42008-05-15 12:55:29 +0200383 } status;
Johannes Berge6a98542008-10-21 12:40:02 +0200384 struct {
385 struct ieee80211_tx_rate driver_rates[
386 IEEE80211_TX_MAX_RATES];
387 void *rate_driver_data[
388 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
389 };
390 void *driver_data[
391 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
Johannes Berge039fa42008-05-15 12:55:29 +0200392 };
Jiri Bencf0706e82007-05-05 11:45:53 -0700393};
394
Johannes Berge039fa42008-05-15 12:55:29 +0200395static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
396{
397 return (struct ieee80211_tx_info *)skb->cb;
398}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400399
Johannes Berge6a98542008-10-21 12:40:02 +0200400/**
401 * ieee80211_tx_info_clear_status - clear TX status
402 *
403 * @info: The &struct ieee80211_tx_info to be cleared.
404 *
405 * When the driver passes an skb back to mac80211, it must report
406 * a number of things in TX status. This function clears everything
407 * in the TX status but the rate control information (it does clear
408 * the count since you need to fill that in anyway).
409 *
410 * NOTE: You can only use this function if you do NOT use
411 * info->driver_data! Use info->rate_driver_data
412 * instead if you need only the less space that allows.
413 */
414static inline void
415ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
416{
417 int i;
418
419 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
420 offsetof(struct ieee80211_tx_info, control.rates));
421 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
422 offsetof(struct ieee80211_tx_info, driver_rates));
423 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
424 /* clear the rate counts */
425 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
426 info->status.rates[i].count = 0;
427
428 BUILD_BUG_ON(
429 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
430 memset(&info->status.ampdu_ack_len, 0,
431 sizeof(struct ieee80211_tx_info) -
432 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
433}
434
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400435
436/**
437 * enum mac80211_rx_flags - receive flags
438 *
439 * These flags are used with the @flag member of &struct ieee80211_rx_status.
440 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
441 * Use together with %RX_FLAG_MMIC_STRIPPED.
442 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
443 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
444 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
445 * verification has been done by the hardware.
446 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
447 * If this flag is set, the stack cannot do any replay detection
448 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400449 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
450 * the frame.
451 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
452 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100453 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900454 * is valid. This is useful in monitor mode and necessary for beacon frames
455 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200456 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200457 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
458 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used
459 * @RX_FLAG_SHORT_GI: Short guard interval was used
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400460 */
461enum mac80211_rx_flags {
462 RX_FLAG_MMIC_ERROR = 1<<0,
463 RX_FLAG_DECRYPTED = 1<<1,
464 RX_FLAG_RADIOTAP = 1<<2,
465 RX_FLAG_MMIC_STRIPPED = 1<<3,
466 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400467 RX_FLAG_FAILED_FCS_CRC = 1<<5,
468 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100469 RX_FLAG_TSFT = 1<<7,
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200470 RX_FLAG_SHORTPRE = 1<<8,
471 RX_FLAG_HT = 1<<9,
472 RX_FLAG_40MHZ = 1<<10,
473 RX_FLAG_SHORT_GI = 1<<11,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400474};
475
476/**
477 * struct ieee80211_rx_status - receive status
478 *
479 * The low-level driver should provide this information (the subset
480 * supported by hardware) to the 802.11 code with each received
481 * frame.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200482 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900483 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
484 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100485 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400486 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200487 * @signal: signal strength when receiving this frame, either in dBm, in dB or
488 * unspecified depending on the hardware capabilities flags
489 * @IEEE80211_HW_SIGNAL_*
490 * @noise: noise when receiving this frame, in dBm.
491 * @qual: overall signal quality indication, in percent (0-100).
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400492 * @antenna: antenna used
Jouni Malinen0fb8ca42008-12-12 14:38:33 +0200493 * @rate_idx: index of data rate into band's supported rates or MCS index if
494 * HT rates are use (RX_FLAG_HT)
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400495 * @flag: %RX_FLAG_*
496 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700497struct ieee80211_rx_status {
498 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100499 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400500 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400501 int signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700502 int noise;
Bruno Randolf566bfe52008-05-08 19:15:40 +0200503 int qual;
Jiri Bencf0706e82007-05-05 11:45:53 -0700504 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100505 int rate_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700506 int flag;
507};
508
Johannes Berg6b301cd2007-09-18 17:29:20 -0400509/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400510 * enum ieee80211_conf_flags - configuration flags
511 *
512 * Flags to define PHY configuration options
513 *
Johannes Berg6b301cd2007-09-18 17:29:20 -0400514 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
Johannes Berg04fe2032009-04-22 18:44:37 +0200515 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only)
Johannes Berg5cff20e2009-04-29 12:26:17 +0200516 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
517 * the driver should be prepared to handle configuration requests but
518 * may turn the device off as much as possible. Typically, this flag will
519 * be set when an interface is set UP but not associated or scanning, but
520 * it can also be unset in that case when monitor interfaces are active.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400521 */
522enum ieee80211_conf_flags {
Johannes Berg7a5158e2008-10-08 10:59:33 +0200523 IEEE80211_CONF_RADIOTAP = (1<<0),
Johannes Bergae5eb022008-10-14 16:58:37 +0200524 IEEE80211_CONF_PS = (1<<1),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200525 IEEE80211_CONF_IDLE = (1<<2),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400526};
Jiri Bencf0706e82007-05-05 11:45:53 -0700527
Johannes Berg7a5158e2008-10-08 10:59:33 +0200528
Jiri Bencf0706e82007-05-05 11:45:53 -0700529/**
Johannes Berge8975582008-10-09 12:18:51 +0200530 * enum ieee80211_conf_changed - denotes which configuration changed
531 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +0200532 * @_IEEE80211_CONF_CHANGE_RADIO_ENABLED: DEPRECATED
Johannes Berge8975582008-10-09 12:18:51 +0200533 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
534 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
Johannes Berge255d5e2009-04-22 12:40:07 +0200535 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
Johannes Berge8975582008-10-09 12:18:51 +0200536 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
Johannes Berg47979382009-01-07 10:13:27 +0100537 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
Johannes Berg9124b072008-10-14 19:17:54 +0200538 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berg5cff20e2009-04-29 12:26:17 +0200539 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
Johannes Berge8975582008-10-09 12:18:51 +0200540 */
541enum ieee80211_conf_changed {
Johannes Berg1f87f7d2009-06-02 13:01:41 +0200542 _IEEE80211_CONF_CHANGE_RADIO_ENABLED = BIT(0),
Johannes Berge8975582008-10-09 12:18:51 +0200543 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
544 IEEE80211_CONF_CHANGE_RADIOTAP = BIT(3),
545 IEEE80211_CONF_CHANGE_PS = BIT(4),
Johannes Berge255d5e2009-04-22 12:40:07 +0200546 IEEE80211_CONF_CHANGE_POWER = BIT(5),
547 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
548 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berg5cff20e2009-04-29 12:26:17 +0200549 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
Johannes Berge8975582008-10-09 12:18:51 +0200550};
551
Johannes Berg1f87f7d2009-06-02 13:01:41 +0200552static inline __deprecated enum ieee80211_conf_changed
553__IEEE80211_CONF_CHANGE_RADIO_ENABLED(void)
554{
555 return _IEEE80211_CONF_CHANGE_RADIO_ENABLED;
556}
557#define IEEE80211_CONF_CHANGE_RADIO_ENABLED \
558 __IEEE80211_CONF_CHANGE_RADIO_ENABLED()
559
Johannes Berge8975582008-10-09 12:18:51 +0200560/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700561 * struct ieee80211_conf - configuration of the device
562 *
563 * This struct indicates how the driver shall configure the hardware.
564 *
Johannes Berg04fe2032009-04-22 18:44:37 +0200565 * @flags: configuration flags defined above
566 *
Jiri Bencf0706e82007-05-05 11:45:53 -0700567 * @radio_enabled: when zero, driver is required to switch off the radio.
Johannes Berge535c752009-05-23 11:18:45 +0200568 * @beacon_int: DEPRECATED, DO NOT USE
Johannes Berg04fe2032009-04-22 18:44:37 +0200569 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800570 * @listen_interval: listen interval in units of beacon interval
Johannes Berg9ccebe62009-04-23 10:32:36 +0200571 * @max_sleep_period: the maximum number of beacon intervals to sleep for
Johannes Berg04fe2032009-04-22 18:44:37 +0200572 * before checking the beacon for a TIM bit (managed mode only); this
573 * value will be only achievable between DTIM frames, the hardware
574 * needs to check for the multicast traffic bit in DTIM beacons.
575 * This variable is valid only when the CONF_PS flag is set.
576 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
577 * powersave documentation below. This variable is valid only when
578 * the CONF_PS flag is set.
579 *
Johannes Berg8318d782008-01-24 19:38:38 +0100580 * @power_level: requested transmit power (in dBm)
Johannes Berg04fe2032009-04-22 18:44:37 +0200581 *
Johannes Berg8318d782008-01-24 19:38:38 +0100582 * @channel: the channel to tune to
Johannes Berg47979382009-01-07 10:13:27 +0100583 * @channel_type: the channel (HT) type
Johannes Berg04fe2032009-04-22 18:44:37 +0200584 *
Johannes Berg9124b072008-10-14 19:17:54 +0200585 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
586 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
587 * but actually means the number of transmissions not the number of retries
588 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
589 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
590 * number of transmissions not the number of retries
Jiri Bencf0706e82007-05-05 11:45:53 -0700591 */
592struct ieee80211_conf {
Johannes Berge535c752009-05-23 11:18:45 +0200593 int __deprecated beacon_int;
Johannes Berg6b301cd2007-09-18 17:29:20 -0400594 u32 flags;
Johannes Berg46f2c4b2009-01-06 18:13:18 +0100595 int power_level, dynamic_ps_timeout;
Johannes Berg9ccebe62009-04-23 10:32:36 +0200596 int max_sleep_period;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200597
Johannes Berge8975582008-10-09 12:18:51 +0200598 u16 listen_interval;
Johannes Berg1f87f7d2009-06-02 13:01:41 +0200599 bool __deprecated radio_enabled;
Johannes Berge8975582008-10-09 12:18:51 +0200600
Johannes Berg9124b072008-10-14 19:17:54 +0200601 u8 long_frame_max_tx_count, short_frame_max_tx_count;
602
Johannes Berg8318d782008-01-24 19:38:38 +0100603 struct ieee80211_channel *channel;
Johannes Berg47979382009-01-07 10:13:27 +0100604 enum nl80211_channel_type channel_type;
Jiri Bencf0706e82007-05-05 11:45:53 -0700605};
606
607/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100608 * struct ieee80211_vif - per-interface data
609 *
610 * Data in this structure is continually present for driver
611 * use during the life of a virtual interface.
612 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100613 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200614 * @bss_conf: BSS configuration for this interface, either our own
615 * or the BSS we're associated to
Johannes Berg32bfd352007-12-19 01:31:26 +0100616 * @drv_priv: data area for driver use, will always be aligned to
617 * sizeof(void *).
618 */
619struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200620 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200621 struct ieee80211_bss_conf bss_conf;
Johannes Berg32bfd352007-12-19 01:31:26 +0100622 /* must be last */
623 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
624};
625
Johannes Berg902acc72008-02-23 15:17:19 +0100626static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
627{
628#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200629 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100630#endif
631 return false;
632}
633
Johannes Berg32bfd352007-12-19 01:31:26 +0100634/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700635 * struct ieee80211_if_init_conf - initial configuration of an interface
636 *
Johannes Berg32bfd352007-12-19 01:31:26 +0100637 * @vif: pointer to a driver-use per-interface structure. The pointer
638 * itself is also used for various functions including
639 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
Johannes Berg05c914f2008-09-11 00:01:58 +0200640 * @type: one of &enum nl80211_iftype constants. Determines the type of
Jiri Bencf0706e82007-05-05 11:45:53 -0700641 * added/removed interface.
642 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
643 * until the interface is removed (i.e. it cannot be used after
644 * remove_interface() callback was called for this interface).
645 *
646 * This structure is used in add_interface() and remove_interface()
647 * callbacks of &struct ieee80211_hw.
Johannes Berg4480f15c2007-07-10 19:32:10 +0200648 *
649 * When you allow multiple interfaces to be added to your PHY, take care
650 * that the hardware can actually handle multiple MAC addresses. However,
651 * also take care that when there's no interface left with mac_addr != %NULL
652 * you remove the MAC address from the device to avoid acknowledging packets
653 * in pure monitor mode.
Jiri Bencf0706e82007-05-05 11:45:53 -0700654 */
655struct ieee80211_if_init_conf {
Johannes Berg05c914f2008-09-11 00:01:58 +0200656 enum nl80211_iftype type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100657 struct ieee80211_vif *vif;
Jiri Bencf0706e82007-05-05 11:45:53 -0700658 void *mac_addr;
659};
660
661/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400662 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400663 * @ALG_WEP: WEP40 or WEP104
664 * @ALG_TKIP: TKIP
665 * @ALG_CCMP: CCMP (AES)
Jouni Malinen3cfcf6ac2009-01-08 13:32:02 +0200666 * @ALG_AES_CMAC: AES-128-CMAC
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400667 */
Johannes Bergea49c352007-09-18 17:29:21 -0400668enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400669 ALG_WEP,
670 ALG_TKIP,
671 ALG_CCMP,
Jouni Malinen3cfcf6ac2009-01-08 13:32:02 +0200672 ALG_AES_CMAC,
Johannes Bergea49c352007-09-18 17:29:21 -0400673};
Jiri Bencf0706e82007-05-05 11:45:53 -0700674
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300675/**
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400676 * enum ieee80211_key_flags - key flags
677 *
678 * These flags are used for communication about keys between the driver
679 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
680 *
681 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
682 * that the STA this key will be used with could be using QoS.
683 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
684 * driver to indicate that it requires IV generation for this
685 * particular key.
686 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
687 * the driver for a TKIP key if it requires Michael MIC
688 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200689 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
690 * that the key is pairwise rather then a shared key.
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200691 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
692 * CCMP key if it requires CCMP encryption of management frames (MFP) to
693 * be done in software.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400694 */
695enum ieee80211_key_flags {
696 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
697 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
698 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200699 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Jouni Malinen1f7d77a2009-01-08 13:32:10 +0200700 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400701};
702
703/**
704 * struct ieee80211_key_conf - key information
705 *
706 * This key information is given by mac80211 to the driver by
707 * the set_key() callback in &struct ieee80211_ops.
708 *
709 * @hw_key_idx: To be set by the driver, this is the key index the driver
710 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400711 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400712 * @alg: The key algorithm.
713 * @flags: key flags, see &enum ieee80211_key_flags.
714 * @keyidx: the key index (0-3)
715 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400716 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
717 * data block:
718 * - Temporal Encryption Key (128 bits)
719 * - Temporal Authenticator Tx MIC Key (64 bits)
720 * - Temporal Authenticator Rx MIC Key (64 bits)
Johannes Bergdc822b52008-12-29 12:55:09 +0100721 * @icv_len: The ICV length for this key type
722 * @iv_len: The IV length for this key type
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400723 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700724struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400725 enum ieee80211_key_alg alg;
Felix Fietkau76708de2008-10-05 18:02:48 +0200726 u8 icv_len;
727 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400728 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400729 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400730 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400731 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -0700732 u8 key[0];
733};
734
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400735/**
736 * enum set_key_cmd - key command
737 *
738 * Used with the set_key() callback in &struct ieee80211_ops, this
739 * indicates whether a key is being removed or added.
740 *
741 * @SET_KEY: a key is set
742 * @DISABLE_KEY: a key must be disabled
743 */
Johannes Bergea49c352007-09-18 17:29:21 -0400744enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400745 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400746};
Jiri Bencf0706e82007-05-05 11:45:53 -0700747
Tomas Winkler478f8d22007-09-30 13:52:37 +0200748/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200749 * struct ieee80211_sta - station table entry
750 *
751 * A station table entry represents a station we are possibly
752 * communicating with. Since stations are RCU-managed in
753 * mac80211, any ieee80211_sta pointer you get access to must
754 * either be protected by rcu_read_lock() explicitly or implicitly,
755 * or you must take good care to not use such a pointer after a
756 * call to your sta_notify callback that removed it.
757 *
758 * @addr: MAC address
759 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200760 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergae5eb022008-10-14 16:58:37 +0200761 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
Johannes Berg17741cd2008-09-11 00:02:02 +0200762 * @drv_priv: data area for driver use, will always be aligned to
763 * sizeof(void *), size is determined in hw information.
764 */
765struct ieee80211_sta {
Johannes Berg881d9482009-01-21 15:13:48 +0100766 u32 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200767 u8 addr[ETH_ALEN];
768 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200769 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200770
771 /* must be last */
772 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
773};
774
775/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200776 * enum sta_notify_cmd - sta notify command
777 *
778 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Christian Lamparter89fad572008-12-09 16:28:06 +0100779 * indicates addition and removal of a station to station table,
780 * or if a associated station made a power state transition.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200781 *
782 * @STA_NOTIFY_ADD: a station was added to the station table
783 * @STA_NOTIFY_REMOVE: a station being removed from the station table
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100784 * @STA_NOTIFY_SLEEP: a station is now sleeping
785 * @STA_NOTIFY_AWAKE: a sleeping station woke up
786 */
Christian Lamparter89fad572008-12-09 16:28:06 +0100787enum sta_notify_cmd {
788 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE,
Christian Lamparter4571d3b2008-11-30 00:48:41 +0100789 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
790};
791
792/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200793 * enum ieee80211_tkip_key_type - get tkip key
794 *
795 * Used by drivers which need to get a tkip key for skb. Some drivers need a
796 * phase 1 key, others need a phase 2 key. A single function allows the driver
797 * to get the key, this enum indicates what type of key is required.
798 *
799 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
800 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
801 */
802enum ieee80211_tkip_key_type {
803 IEEE80211_TKIP_P1_KEY,
804 IEEE80211_TKIP_P2_KEY,
805};
806
807/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400808 * enum ieee80211_hw_flags - hardware flags
809 *
810 * These flags are used to indicate hardware capabilities to
811 * the stack. Generally, flags here should have their meaning
812 * done in a way that the simplest hardware doesn't need setting
813 * any particular flags. There are some exceptions to this rule,
814 * however, so you are advised to review these flags carefully.
815 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400816 * @IEEE80211_HW_RX_INCLUDES_FCS:
817 * Indicates that received frames passed to the stack include
818 * the FCS at the end.
819 *
820 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
821 * Some wireless LAN chipsets buffer broadcast/multicast frames
822 * for power saving stations in the hardware/firmware and others
823 * rely on the host system for such buffering. This option is used
824 * to configure the IEEE 802.11 upper layer to buffer broadcast and
825 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -0700826 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400827 *
Johannes Berg8318d782008-01-24 19:38:38 +0100828 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
829 * Hardware is not capable of short slot operation on the 2.4 GHz band.
830 *
831 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
832 * Hardware is not capable of receiving frames with short preamble on
833 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200834 *
835 * @IEEE80211_HW_SIGNAL_UNSPEC:
836 * Hardware can provide signal values but we don't know its units. We
837 * expect values between 0 and @max_signal.
838 * If possible please provide dB or dBm instead.
839 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200840 * @IEEE80211_HW_SIGNAL_DBM:
841 * Hardware gives signal values in dBm, decibel difference from
842 * one milliwatt. This is the preferred method since it is standardized
843 * between different devices. @max_signal does not need to be set.
844 *
845 * @IEEE80211_HW_NOISE_DBM:
846 * Hardware can provide noise (radio interference) values in units dBm,
847 * decibel difference from one milliwatt.
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300848 *
849 * @IEEE80211_HW_SPECTRUM_MGMT:
850 * Hardware supports spectrum management defined in 802.11h
851 * Measurement, Channel Switch, Quieting, TPC
Sujith8b30b1f2008-10-24 09:55:27 +0530852 *
853 * @IEEE80211_HW_AMPDU_AGGREGATION:
854 * Hardware supports 11n A-MPDU aggregation.
Kalle Valo520eb822008-12-18 23:35:27 +0200855 *
Johannes Berg4be8c382009-01-07 18:28:20 +0100856 * @IEEE80211_HW_SUPPORTS_PS:
857 * Hardware has power save support (i.e. can go to sleep).
858 *
859 * @IEEE80211_HW_PS_NULLFUNC_STACK:
860 * Hardware requires nullfunc frame handling in stack, implies
861 * stack support for dynamic PS.
862 *
863 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
864 * Hardware has support for dynamic PS.
Jouni Malinen4375d082009-01-08 13:32:11 +0200865 *
866 * @IEEE80211_HW_MFP_CAPABLE:
867 * Hardware supports management frame protection (MFP, IEEE 802.11w).
Kalle Valo04de8382009-03-22 21:57:35 +0200868 *
869 * @IEEE80211_HW_BEACON_FILTER:
870 * Hardware supports dropping of irrelevant beacon frames to
871 * avoid waking up cpu.
Johannes Berg1bc08262007-09-18 17:29:15 -0400872 */
873enum ieee80211_hw_flags {
Johannes Berg1bc08262007-09-18 17:29:15 -0400874 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
875 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +0100876 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
877 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +0200878 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
Johannes Berg7fee5372009-01-30 11:13:06 +0100879 IEEE80211_HW_SIGNAL_DBM = 1<<6,
880 IEEE80211_HW_NOISE_DBM = 1<<7,
881 IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
882 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
883 IEEE80211_HW_SUPPORTS_PS = 1<<10,
884 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
885 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
886 IEEE80211_HW_MFP_CAPABLE = 1<<13,
Kalle Valo04de8382009-03-22 21:57:35 +0200887 IEEE80211_HW_BEACON_FILTER = 1<<14,
Johannes Berg1bc08262007-09-18 17:29:15 -0400888};
889
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400890/**
891 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400892 *
893 * This structure contains the configuration and hardware
894 * information for an 802.11 PHY.
895 *
896 * @wiphy: This points to the &struct wiphy allocated for this
897 * 802.11 PHY. You must fill in the @perm_addr and @dev
898 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +0100899 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
900 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400901 *
902 * @conf: &struct ieee80211_conf, device configuration, don't use.
903 *
904 * @workqueue: single threaded workqueue available for driver use,
Ivo van Doorn428da762008-06-24 19:23:36 +0200905 * allocated by mac80211 on registration and flushed when an
906 * interface is removed.
Johannes Bergc771c9d2009-01-23 22:54:03 +0100907 * NOTICE: All work performed on this workqueue must not
908 * acquire the RTNL lock.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400909 *
910 * @priv: pointer to private area that was allocated for driver use
911 * along with this structure.
912 *
913 * @flags: hardware flags, see &enum ieee80211_hw_flags.
914 *
915 * @extra_tx_headroom: headroom to reserve in each transmit skb
916 * for use by the driver (e.g. for transmit headers.)
917 *
918 * @channel_change_time: time (in microseconds) it takes to change channels.
919 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200920 * @max_signal: Maximum value for signal (rssi) in RX information, used
921 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400922 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800923 * @max_listen_interval: max listen interval in units of beacon interval
924 * that HW supports
925 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400926 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +0200927 * data packets. WMM/QoS requires at least four, these
928 * queues need to have configurable access parameters.
929 *
Johannes Berg830f9032007-10-28 14:51:05 +0100930 * @rate_control_algorithm: rate control algorithm for this hardware.
931 * If unset (NULL), the default algorithm will be used. Must be
932 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +0100933 *
934 * @vif_data_size: size (in bytes) of the drv_priv data area
935 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +0200936 * @sta_data_size: size (in bytes) of the drv_priv data area
937 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200938 *
Johannes Berge6a98542008-10-21 12:40:02 +0200939 * @max_rates: maximum number of alternate rate retry stages
940 * @max_rate_tries: maximum number of tries for each stage
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400941 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700942struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -0700943 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400944 struct wiphy *wiphy;
Jiri Bencf0706e82007-05-05 11:45:53 -0700945 struct workqueue_struct *workqueue;
Johannes Berg830f9032007-10-28 14:51:05 +0100946 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -0700947 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400948 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -0700949 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -0700950 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +0100951 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +0200952 int sta_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +0800953 u16 queues;
Tomas Winklerea95bba2008-07-18 13:53:00 +0800954 u16 max_listen_interval;
Jiri Bencf0706e82007-05-05 11:45:53 -0700955 s8 max_signal;
Johannes Berge6a98542008-10-21 12:40:02 +0200956 u8 max_rates;
957 u8 max_rate_tries;
Jiri Bencf0706e82007-05-05 11:45:53 -0700958};
959
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400960/**
Luis R. Rodriguez9a953712009-01-22 15:05:53 -0800961 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
962 *
963 * @wiphy: the &struct wiphy which we want to query
964 *
965 * mac80211 drivers can use this to get to their respective
966 * &struct ieee80211_hw. Drivers wishing to get to their own private
967 * structure can then access it via hw->priv. Note that mac802111 drivers should
968 * not use wiphy_priv() to try to get their private driver structure as this
969 * is already used internally by mac80211.
970 */
971struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
972
973/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400974 * SET_IEEE80211_DEV - set device for 802.11 hardware
975 *
976 * @hw: the &struct ieee80211_hw to set the device for
977 * @dev: the &struct device of this 802.11 device
978 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700979static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
980{
981 set_wiphy_dev(hw->wiphy, dev);
982}
983
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400984/**
Bob Copelande37d4df2008-10-20 21:20:27 -0400985 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400986 *
987 * @hw: the &struct ieee80211_hw to set the MAC address for
988 * @addr: the address to set
989 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700990static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
991{
992 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
993}
994
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200995static inline struct ieee80211_rate *
996ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +0200997 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200998{
Johannes Berge6a98542008-10-21 12:40:02 +0200999 if (WARN_ON(c->control.rates[0].idx < 0))
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001000 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001001 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001002}
1003
1004static inline struct ieee80211_rate *
1005ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001006 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001007{
Johannes Berge039fa42008-05-15 12:55:29 +02001008 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001009 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +02001010 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001011}
1012
1013static inline struct ieee80211_rate *
1014ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +02001015 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001016{
Johannes Berge6a98542008-10-21 12:40:02 +02001017 if (c->control.rates[idx + 1].idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001018 return NULL;
Johannes Berge6a98542008-10-21 12:40:02 +02001019 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +02001020}
1021
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001022/**
1023 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -04001024 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001025 * mac80211 is capable of taking advantage of many hardware
1026 * acceleration designs for encryption and decryption operations.
1027 *
1028 * The set_key() callback in the &struct ieee80211_ops for a given
1029 * device is called to enable hardware acceleration of encryption and
Johannes Bergdc822b52008-12-29 12:55:09 +01001030 * decryption. The callback takes a @sta parameter that will be NULL
1031 * for default keys or keys used for transmission only, or point to
1032 * the station information for the peer for individual keys.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001033 * Multiple transmission keys with the same key index may be used when
1034 * VLANs are configured for an access point.
1035 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001036 * When transmitting, the TX control data will use the @hw_key_idx
1037 * selected by the driver by modifying the &struct ieee80211_key_conf
1038 * pointed to by the @key parameter to the set_key() function.
1039 *
1040 * The set_key() call for the %SET_KEY command should return 0 if
1041 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1042 * added; if you return 0 then hw_key_idx must be assigned to the
1043 * hardware key index, you are free to use the full u8 range.
1044 *
1045 * When the cmd is %DISABLE_KEY then it must succeed.
1046 *
1047 * Note that it is permissible to not decrypt a frame even if a key
1048 * for it has been uploaded to hardware, the stack will not make any
1049 * decision based on whether a key has been uploaded or not but rather
1050 * based on the receive flags.
1051 *
1052 * The &struct ieee80211_key_conf structure pointed to by the @key
1053 * parameter is guaranteed to be valid until another call to set_key()
1054 * removes it, but it can only be used as a cookie to differentiate
1055 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001056 *
1057 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1058 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1059 * handler.
1060 * The update_tkip_key() call updates the driver with the new phase 1 key.
1061 * This happens everytime the iv16 wraps around (every 65536 packets). The
1062 * set_key() call will happen only once for each key (unless the AP did
1063 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
Bob Copelande37d4df2008-10-20 21:20:27 -04001064 * provided by update_tkip_key only. The trigger that makes mac80211 call this
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001065 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001066 */
Johannes Berg4150c572007-09-17 01:29:23 -04001067
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001068/**
Johannes Berg4be8c382009-01-07 18:28:20 +01001069 * DOC: Powersave support
1070 *
1071 * mac80211 has support for various powersave implementations.
1072 *
1073 * First, it can support hardware that handles all powersaving by
1074 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS
1075 * hardware flag. In that case, it will be told about the desired
1076 * powersave mode depending on the association status, and the driver
1077 * must take care of sending nullfunc frames when necessary, i.e. when
1078 * entering and leaving powersave mode. The driver is required to look at
1079 * the AID in beacons and signal to the AP that it woke up when it finds
1080 * traffic directed to it. This mode supports dynamic PS by simply
1081 * enabling/disabling PS.
1082 *
1083 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS
1084 * flag to indicate that it can support dynamic PS mode itself (see below).
1085 *
1086 * Other hardware designs cannot send nullfunc frames by themselves and also
1087 * need software support for parsing the TIM bitmap. This is also supported
1088 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1089 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
Johannes Berg955394c2009-04-16 17:04:25 +02001090 * required to pass up beacons. The hardware is still required to handle
1091 * waking up for multicast traffic; if it cannot the driver must handle that
1092 * as best as it can, mac80211 is too slow.
Johannes Berg4be8c382009-01-07 18:28:20 +01001093 *
1094 * Dynamic powersave mode is an extension to normal powersave mode in which
1095 * the hardware stays awake for a user-specified period of time after sending
1096 * a frame so that reply frames need not be buffered and therefore delayed
1097 * to the next wakeup. This can either be supported by hardware, in which case
1098 * the driver needs to look at the @dynamic_ps_timeout hardware configuration
1099 * value, or by the stack if all nullfunc handling is in the stack.
1100 */
1101
1102/**
Kalle Valo04de8382009-03-22 21:57:35 +02001103 * DOC: Beacon filter support
1104 *
1105 * Some hardware have beacon filter support to reduce host cpu wakeups
1106 * which will reduce system power consumption. It usuallly works so that
1107 * the firmware creates a checksum of the beacon but omits all constantly
1108 * changing elements (TSF, TIM etc). Whenever the checksum changes the
1109 * beacon is forwarded to the host, otherwise it will be just dropped. That
1110 * way the host will only receive beacons where some relevant information
1111 * (for example ERP protection or WMM settings) have changed.
1112 *
Johannes Berg955394c2009-04-16 17:04:25 +02001113 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1114 * hardware capability. The driver needs to enable beacon filter support
1115 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1116 * power save is enabled, the stack will not check for beacon loss and the
1117 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1118 *
1119 * The time (or number of beacons missed) until the firmware notifies the
1120 * driver of a beacon loss event (which in turn causes the driver to call
1121 * ieee80211_beacon_loss()) should be configurable and will be controlled
1122 * by mac80211 and the roaming algorithm in the future.
1123 *
1124 * Since there may be constantly changing information elements that nothing
1125 * in the software stack cares about, we will, in the future, have mac80211
1126 * tell the driver which information elements are interesting in the sense
1127 * that we want to see changes in them. This will include
1128 * - a list of information element IDs
1129 * - a list of OUIs for the vendor information element
1130 *
1131 * Ideally, the hardware would filter out any beacons without changes in the
1132 * requested elements, but if it cannot support that it may, at the expense
1133 * of some efficiency, filter out only a subset. For example, if the device
1134 * doesn't support checking for OUIs it should pass up all changes in all
1135 * vendor information elements.
1136 *
1137 * Note that change, for the sake of simplification, also includes information
1138 * elements appearing or disappearing from the beacon.
1139 *
1140 * Some hardware supports an "ignore list" instead, just make sure nothing
1141 * that was requested is on the ignore list, and include commonly changing
1142 * information element IDs in the ignore list, for example 11 (BSS load) and
1143 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1144 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1145 * it could also include some currently unused IDs.
1146 *
1147 *
1148 * In addition to these capabilities, hardware should support notifying the
1149 * host of changes in the beacon RSSI. This is relevant to implement roaming
1150 * when no traffic is flowing (when traffic is flowing we see the RSSI of
1151 * the received data packets). This can consist in notifying the host when
1152 * the RSSI changes significantly or when it drops below or rises above
1153 * configurable thresholds. In the future these thresholds will also be
1154 * configured by mac80211 (which gets them from userspace) to implement
1155 * them as the roaming algorithm requires.
1156 *
1157 * If the hardware cannot implement this, the driver should ask it to
1158 * periodically pass beacon frames to the host so that software can do the
1159 * signal strength threshold checking.
Kalle Valo04de8382009-03-22 21:57:35 +02001160 */
1161
1162/**
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001163 * DOC: Frame filtering
1164 *
1165 * mac80211 requires to see many management frames for proper
1166 * operation, and users may want to see many more frames when
1167 * in monitor mode. However, for best CPU usage and power consumption,
1168 * having as few frames as possible percolate through the stack is
1169 * desirable. Hence, the hardware should filter as much as possible.
1170 *
1171 * To achieve this, mac80211 uses filter flags (see below) to tell
1172 * the driver's configure_filter() function which frames should be
1173 * passed to mac80211 and which should be filtered out.
1174 *
1175 * The configure_filter() callback is invoked with the parameters
1176 * @mc_count and @mc_list for the combined multicast address list
1177 * of all virtual interfaces, @changed_flags telling which flags
1178 * were changed and @total_flags with the new flag states.
1179 *
1180 * If your device has no multicast address filters your driver will
1181 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1182 * parameter to see whether multicast frames should be accepted
1183 * or dropped.
1184 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001185 * All unsupported flags in @total_flags must be cleared.
1186 * Hardware does not support a flag if it is incapable of _passing_
1187 * the frame to the stack. Otherwise the driver must ignore
1188 * the flag, but not clear it.
1189 * You must _only_ clear the flag (announce no support for the
1190 * flag to mac80211) if you are not able to pass the packet type
1191 * to the stack (so the hardware always filters it).
1192 * So for example, you should clear @FIF_CONTROL, if your hardware
1193 * always filters control frames. If your hardware always passes
1194 * control frames to the kernel and is incapable of filtering them,
1195 * you do _not_ clear the @FIF_CONTROL flag.
1196 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001197 */
1198
1199/**
1200 * enum ieee80211_filter_flags - hardware filter flags
1201 *
1202 * These flags determine what the filter in hardware should be
1203 * programmed to let through and what should not be passed to the
1204 * stack. It is always safe to pass more frames than requested,
1205 * but this has negative impact on power consumption.
1206 *
1207 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1208 * think of the BSS as your network segment and then this corresponds
1209 * to the regular ethernet device promiscuous mode.
1210 *
1211 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1212 * by the user or if the hardware is not capable of filtering by
1213 * multicast address.
1214 *
1215 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1216 * %RX_FLAG_FAILED_FCS_CRC for them)
1217 *
1218 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1219 * the %RX_FLAG_FAILED_PLCP_CRC for them
1220 *
1221 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1222 * to the hardware that it should not filter beacons or probe responses
1223 * by BSSID. Filtering them can greatly reduce the amount of processing
1224 * mac80211 needs to do and the amount of CPU wakeups, so you should
1225 * honour this flag if possible.
1226 *
1227 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1228 * only those addressed to this station
1229 *
1230 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1231 */
1232enum ieee80211_filter_flags {
1233 FIF_PROMISC_IN_BSS = 1<<0,
1234 FIF_ALLMULTI = 1<<1,
1235 FIF_FCSFAIL = 1<<2,
1236 FIF_PLCPFAIL = 1<<3,
1237 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1238 FIF_CONTROL = 1<<5,
1239 FIF_OTHER_BSS = 1<<6,
1240};
1241
1242/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001243 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1244 *
1245 * These flags are used with the ampdu_action() callback in
1246 * &struct ieee80211_ops to indicate which action is needed.
1247 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1248 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001249 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1250 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Johannes Bergb1720232009-03-23 17:28:39 +01001251 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001252 */
1253enum ieee80211_ampdu_mlme_action {
1254 IEEE80211_AMPDU_RX_START,
1255 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001256 IEEE80211_AMPDU_TX_START,
1257 IEEE80211_AMPDU_TX_STOP,
Johannes Bergb1720232009-03-23 17:28:39 +01001258 IEEE80211_AMPDU_TX_OPERATIONAL,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001259};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001260
1261/**
1262 * struct ieee80211_ops - callbacks from mac80211 to the driver
1263 *
1264 * This structure contains various callbacks that the driver may
1265 * handle or, in some cases, must handle, for example to configure
1266 * the hardware to a new channel or to transmit a frame.
1267 *
1268 * @tx: Handler that 802.11 module calls for each transmitted frame.
1269 * skb contains the buffer starting from the IEEE 802.11 header.
1270 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001271 * configuration in the TX control data. This handler should,
1272 * preferably, never fail and stop queues appropriately, more
1273 * importantly, however, it must never fail for A-MPDU-queues.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001274 * This function should return NETDEV_TX_OK except in very
1275 * limited cases.
Johannes Bergeefce912008-05-17 00:57:13 +02001276 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001277 *
1278 * @start: Called before the first netdevice attached to the hardware
1279 * is enabled. This should turn on the hardware and must turn on
1280 * frame reception (for possibly enabled monitor interfaces.)
1281 * Returns negative error codes, these may be seen in userspace,
1282 * or zero.
1283 * When the device is started it should not have a MAC address
1284 * to avoid acknowledging frames before a non-monitor device
1285 * is added.
1286 * Must be implemented.
1287 *
1288 * @stop: Called after last netdevice attached to the hardware
1289 * is disabled. This should turn off the hardware (at least
1290 * it must turn off frame reception.)
1291 * May be called right after add_interface if that rejects
1292 * an interface.
1293 * Must be implemented.
1294 *
1295 * @add_interface: Called when a netdevice attached to the hardware is
Bob Copelande37d4df2008-10-20 21:20:27 -04001296 * enabled. Because it is not called for monitor mode devices, @start
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001297 * and @stop must be implemented.
1298 * The driver should perform any initialization it needs before
1299 * the device can be enabled. The initial configuration for the
1300 * interface is given in the conf parameter.
1301 * The callback may refuse to add an interface by returning a
1302 * negative error code (which will be seen in userspace.)
1303 * Must be implemented.
1304 *
1305 * @remove_interface: Notifies a driver that an interface is going down.
1306 * The @stop callback is called after this if it is the last interface
1307 * and no monitor interfaces are present.
1308 * When all interfaces are removed, the MAC address in the hardware
1309 * must be cleared so the device no longer acknowledges packets,
1310 * the mac_addr member of the conf structure is, however, set to the
1311 * MAC address of the device going away.
1312 * Hence, this callback must be implemented.
1313 *
1314 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1315 * function to change hardware configuration, e.g., channel.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001316 * This function should never fail but returns a negative error code
1317 * if it does.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001318 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001319 * @bss_info_changed: Handler for configuration requests related to BSS
1320 * parameters that may vary during BSS's lifespan, and may affect low
1321 * level driver (e.g. assoc/disassoc status, erp parameters).
1322 * This function should not be used if no BSS has been set, unless
1323 * for association indication. The @changed parameter indicates which
Reinette Chatred18ef292008-04-09 16:56:15 -07001324 * of the bss parameters has changed when a call is made.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001325 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001326 * @configure_filter: Configure the device's RX filter.
1327 * See the section "Frame filtering" for more information.
1328 * This callback must be implemented and atomic.
1329 *
Luis R. Rodriguez546c80c92008-08-14 11:43:20 -07001330 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001331 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001332 *
1333 * @set_key: See the section "Hardware crypto acceleration"
1334 * This callback can sleep, and is only called between add_interface
Johannes Bergdc822b52008-12-29 12:55:09 +01001335 * and remove_interface calls, i.e. while the given virtual interface
1336 * is enabled.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001337 * Returns a negative error code if the key can't be added.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001338 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001339 * @update_tkip_key: See the section "Hardware crypto acceleration"
1340 * This callback will be called in the context of Rx. Called for drivers
1341 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1342 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001343 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001344 * the scan state machine in stack. The scan must honour the channel
Kalle Valo9050bdd2009-03-22 21:57:21 +02001345 * configuration done by the regulatory agent in the wiphy's
1346 * registered bands. The hardware (or the driver) needs to make sure
Johannes Bergde95a542009-04-01 11:58:36 +02001347 * that power save is disabled.
1348 * The @req ie/ie_len members are rewritten by mac80211 to contain the
1349 * entire IEs after the SSID, so that drivers need not look at these
1350 * at all but just send them after the SSID -- mac80211 includes the
1351 * (extended) supported rates and HT information (where applicable).
1352 * When the scan finishes, ieee80211_scan_completed() must be called;
1353 * note that it also must be called when the scan cannot finish due to
1354 * any error unless this callback returned a negative error code.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001355 *
Michael Buesch80e775b2009-02-20 15:37:03 +01001356 * @sw_scan_start: Notifier function that is called just before a software scan
1357 * is started. Can be NULL, if the driver doesn't need this notification.
1358 *
1359 * @sw_scan_complete: Notifier function that is called just after a software scan
1360 * finished. Can be NULL, if the driver doesn't need this notification.
1361 *
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001362 * @get_stats: Return low-level statistics.
1363 * Returns zero if statistics are available.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001364 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001365 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1366 * callback should be provided to read the TKIP transmit IVs (both IV32
1367 * and IV16) for the given key from hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001368 *
1369 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1370 *
Christian Lamparter89fad572008-12-09 16:28:06 +01001371 * @sta_notify: Notifies low level driver about addition, removal or power
1372 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc.
1373 * Must be atomic.
Christian Lamparter4571d3b2008-11-30 00:48:41 +01001374 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001375 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001376 * bursting) for a hardware TX queue.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001377 * Returns a negative error code on failure.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001378 *
1379 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1380 * to get number of currently queued packets (queue length), maximum queue
1381 * size (limit), and total number of packets sent using each TX queue
Johannes Berge4e72fb2009-03-23 17:28:42 +01001382 * (count). The 'stats' pointer points to an array that has hw->queues
1383 * items.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001384 *
1385 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001386 * this is only used for IBSS mode BSSID merging and debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001387 * required function.
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001388 *
1389 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1390 * Currently, this is only used for IBSS mode debugging. Is not a
Alina Friedrichsen7b08b3b2009-02-05 17:58:34 +01001391 * required function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001392 *
1393 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1394 * with other STAs in the IBSS. This is only used in IBSS mode. This
1395 * function is optional if the firmware/hardware takes full care of
1396 * TSF synchronization.
1397 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001398 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1399 * This is needed only for IBSS mode and the result of this function is
1400 * used to determine whether to reply to Probe Requests.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001401 * Returns non-zero if this device sent the last beacon.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001402 *
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001403 * @ampdu_action: Perform a certain A-MPDU action
1404 * The RA/TID combination determines the destination and TID we want
1405 * the ampdu action to be performed for. The action is defined through
1406 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001407 * is the first frame we expect to perform the action on. Notice
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001408 * that TX/RX_STOP can pass NULL for this parameter.
Bob Copeland6dd1bf32009-01-08 21:00:34 -05001409 * Returns a negative error code on failure.
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001410 *
1411 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1412 * need to set wiphy->rfkill_poll to %true before registration,
1413 * and need to call wiphy_rfkill_set_hw_state() in the callback.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001414 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001415struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001416 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001417 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001418 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001419 int (*add_interface)(struct ieee80211_hw *hw,
1420 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001421 void (*remove_interface)(struct ieee80211_hw *hw,
1422 struct ieee80211_if_init_conf *conf);
Johannes Berge8975582008-10-09 12:18:51 +02001423 int (*config)(struct ieee80211_hw *hw, u32 changed);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001424 void (*bss_info_changed)(struct ieee80211_hw *hw,
1425 struct ieee80211_vif *vif,
1426 struct ieee80211_bss_conf *info,
1427 u32 changed);
Johannes Berg4150c572007-09-17 01:29:23 -04001428 void (*configure_filter)(struct ieee80211_hw *hw,
1429 unsigned int changed_flags,
1430 unsigned int *total_flags,
1431 int mc_count, struct dev_addr_list *mc_list);
Johannes Berg17741cd2008-09-11 00:02:02 +02001432 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1433 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001434 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Bergdc822b52008-12-29 12:55:09 +01001435 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
Johannes Berg11a843b2007-08-28 17:01:55 -04001436 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001437 void (*update_tkip_key)(struct ieee80211_hw *hw,
1438 struct ieee80211_key_conf *conf, const u8 *address,
1439 u32 iv32, u16 *phase1key);
Johannes Berg2a519312009-02-10 21:25:55 +01001440 int (*hw_scan)(struct ieee80211_hw *hw,
1441 struct cfg80211_scan_request *req);
Michael Buesch80e775b2009-02-20 15:37:03 +01001442 void (*sw_scan_start)(struct ieee80211_hw *hw);
1443 void (*sw_scan_complete)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001444 int (*get_stats)(struct ieee80211_hw *hw,
1445 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001446 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1447 u32 *iv32, u16 *iv16);
Jiri Bencf0706e82007-05-05 11:45:53 -07001448 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg32bfd352007-12-19 01:31:26 +01001449 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001450 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001451 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e82007-05-05 11:45:53 -07001452 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e82007-05-05 11:45:53 -07001453 int (*get_tx_stats)(struct ieee80211_hw *hw,
1454 struct ieee80211_tx_queue_stats *stats);
Jiri Bencf0706e82007-05-05 11:45:53 -07001455 u64 (*get_tsf)(struct ieee80211_hw *hw);
Alina Friedrichsen3b5d6652009-01-24 07:09:59 +01001456 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001457 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001458 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001459 int (*ampdu_action)(struct ieee80211_hw *hw,
1460 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001461 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02001462
1463 void (*rfkill_poll)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001464};
1465
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001466/**
1467 * ieee80211_alloc_hw - Allocate a new hardware device
1468 *
1469 * This must be called once for each hardware device. The returned pointer
1470 * must be used to refer to this device when calling other functions.
1471 * mac80211 allocates a private data area for the driver pointed to by
1472 * @priv in &struct ieee80211_hw, the size of this area is given as
1473 * @priv_data_len.
1474 *
1475 * @priv_data_len: length of private data
1476 * @ops: callbacks for this device
Jiri Bencf0706e82007-05-05 11:45:53 -07001477 */
1478struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1479 const struct ieee80211_ops *ops);
1480
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001481/**
1482 * ieee80211_register_hw - Register hardware device
1483 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001484 * You must call this function before any other functions in
1485 * mac80211. Note that before a hardware can be registered, you
1486 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001487 *
1488 * @hw: the device to register as returned by ieee80211_alloc_hw()
1489 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001490int ieee80211_register_hw(struct ieee80211_hw *hw);
1491
Jiri Bencf0706e82007-05-05 11:45:53 -07001492#ifdef CONFIG_MAC80211_LEDS
1493extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1494extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001495extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001496extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001497#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001498/**
1499 * ieee80211_get_tx_led_name - get name of TX LED
1500 *
1501 * mac80211 creates a transmit LED trigger for each wireless hardware
1502 * that can be used to drive LEDs if your driver registers a LED device.
1503 * This function returns the name (or %NULL if not configured for LEDs)
1504 * of the trigger so you can automatically link the LED device.
1505 *
1506 * @hw: the hardware to get the LED trigger name for
1507 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001508static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1509{
1510#ifdef CONFIG_MAC80211_LEDS
1511 return __ieee80211_get_tx_led_name(hw);
1512#else
1513 return NULL;
1514#endif
1515}
1516
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001517/**
1518 * ieee80211_get_rx_led_name - get name of RX LED
1519 *
1520 * mac80211 creates a receive LED trigger for each wireless hardware
1521 * that can be used to drive LEDs if your driver registers a LED device.
1522 * This function returns the name (or %NULL if not configured for LEDs)
1523 * of the trigger so you can automatically link the LED device.
1524 *
1525 * @hw: the hardware to get the LED trigger name for
1526 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001527static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1528{
1529#ifdef CONFIG_MAC80211_LEDS
1530 return __ieee80211_get_rx_led_name(hw);
1531#else
1532 return NULL;
1533#endif
1534}
1535
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001536/**
1537 * ieee80211_get_assoc_led_name - get name of association LED
1538 *
1539 * mac80211 creates a association LED trigger for each wireless hardware
1540 * that can be used to drive LEDs if your driver registers a LED device.
1541 * This function returns the name (or %NULL if not configured for LEDs)
1542 * of the trigger so you can automatically link the LED device.
1543 *
1544 * @hw: the hardware to get the LED trigger name for
1545 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001546static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1547{
1548#ifdef CONFIG_MAC80211_LEDS
1549 return __ieee80211_get_assoc_led_name(hw);
1550#else
1551 return NULL;
1552#endif
1553}
1554
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001555/**
1556 * ieee80211_get_radio_led_name - get name of radio LED
1557 *
1558 * mac80211 creates a radio change LED trigger for each wireless hardware
1559 * that can be used to drive LEDs if your driver registers a LED device.
1560 * This function returns the name (or %NULL if not configured for LEDs)
1561 * of the trigger so you can automatically link the LED device.
1562 *
1563 * @hw: the hardware to get the LED trigger name for
1564 */
1565static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1566{
1567#ifdef CONFIG_MAC80211_LEDS
1568 return __ieee80211_get_radio_led_name(hw);
1569#else
1570 return NULL;
1571#endif
1572}
Michael Buesch47f0c502007-09-27 15:10:44 +02001573
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001574/**
1575 * ieee80211_unregister_hw - Unregister a hardware device
1576 *
1577 * This function instructs mac80211 to free allocated resources
1578 * and unregister netdevices from the networking subsystem.
1579 *
1580 * @hw: the hardware to unregister
1581 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001582void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1583
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001584/**
1585 * ieee80211_free_hw - free hardware descriptor
1586 *
1587 * This function frees everything that was allocated, including the
1588 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001589 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001590 *
1591 * @hw: the hardware to free
1592 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001593void ieee80211_free_hw(struct ieee80211_hw *hw);
1594
Johannes Bergf2753dd2009-04-14 10:09:24 +02001595/**
1596 * ieee80211_restart_hw - restart hardware completely
1597 *
1598 * Call this function when the hardware was restarted for some reason
1599 * (hardware error, ...) and the driver is unable to restore its state
1600 * by itself. mac80211 assumes that at this point the driver/hardware
1601 * is completely uninitialised and stopped, it starts the process by
1602 * calling the ->start() operation. The driver will need to reset all
1603 * internal state that it has prior to calling this function.
1604 *
1605 * @hw: the hardware to restart
1606 */
1607void ieee80211_restart_hw(struct ieee80211_hw *hw);
1608
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001609/* trick to avoid symbol clashes with the ieee80211 subsystem */
Jiri Bencf0706e82007-05-05 11:45:53 -07001610void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1611 struct ieee80211_rx_status *status);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001612
1613/**
1614 * ieee80211_rx - receive frame
1615 *
1616 * Use this function to hand received frames to mac80211. The receive
1617 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1618 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1619 *
Johannes Berg2485f712008-02-25 16:27:41 +01001620 * This function may not be called in IRQ context. Calls to this function
1621 * for a single hardware must be synchronized against each other. Calls
1622 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1623 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001624 *
1625 * @hw: the hardware this frame came in on
1626 * @skb: the buffer to receive, owned by mac80211 after this call
1627 * @status: status of this frame; the status pointer need not be valid
1628 * after this function returns
1629 */
1630static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1631 struct ieee80211_rx_status *status)
1632{
1633 __ieee80211_rx(hw, skb, status);
1634}
1635
1636/**
1637 * ieee80211_rx_irqsafe - receive frame
1638 *
1639 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001640 * (internally defers to a tasklet.)
1641 *
1642 * Calls to this function and ieee80211_rx() may not be mixed for a
1643 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001644 *
1645 * @hw: the hardware this frame came in on
1646 * @skb: the buffer to receive, owned by mac80211 after this call
1647 * @status: status of this frame; the status pointer need not be valid
1648 * after this function returns and is not freed by mac80211,
1649 * it is recommended that it points to a stack area
1650 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001651void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1652 struct sk_buff *skb,
1653 struct ieee80211_rx_status *status);
1654
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001655/**
1656 * ieee80211_tx_status - transmit status callback
1657 *
1658 * Call this function for all transmitted frames after they have been
1659 * transmitted. It is permissible to not call this function for
1660 * multicast frames but this can affect statistics.
1661 *
Johannes Berg2485f712008-02-25 16:27:41 +01001662 * This function may not be called in IRQ context. Calls to this function
1663 * for a single hardware must be synchronized against each other. Calls
1664 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1665 * for a single hardware.
1666 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001667 * @hw: the hardware the frame was transmitted by
1668 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001669 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001670void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001671 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01001672
1673/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001674 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01001675 *
1676 * Like ieee80211_tx_status() but can be called in IRQ context
1677 * (internally defers to a tasklet.)
1678 *
1679 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1680 * single hardware.
1681 *
1682 * @hw: the hardware the frame was transmitted by
1683 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01001684 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001685void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001686 struct sk_buff *skb);
Jiri Bencf0706e82007-05-05 11:45:53 -07001687
1688/**
1689 * ieee80211_beacon_get - beacon generation function
1690 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001691 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001692 *
1693 * If the beacon frames are generated by the host system (i.e., not in
1694 * hardware/firmware), the low-level driver uses this function to receive
1695 * the next beacon frame from the 802.11 code. The low-level is responsible
1696 * for calling this function before beacon data is needed (e.g., based on
1697 * hardware interrupt). Returned skb is used only once and low-level driver
Bob Copelande37d4df2008-10-20 21:20:27 -04001698 * is responsible for freeing it.
Jiri Bencf0706e82007-05-05 11:45:53 -07001699 */
1700struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001701 struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07001702
1703/**
1704 * ieee80211_rts_get - RTS frame generation function
1705 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001706 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001707 * @frame: pointer to the frame that is going to be protected by the RTS.
1708 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001709 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001710 * @rts: The buffer where to store the RTS frame.
1711 *
1712 * If the RTS frames are generated by the host system (i.e., not in
1713 * hardware/firmware), the low-level driver uses this function to receive
1714 * the next RTS frame from the 802.11 code. The low-level is responsible
1715 * for calling this function before and RTS frame is needed.
1716 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001717void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001718 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001719 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07001720 struct ieee80211_rts *rts);
1721
1722/**
1723 * ieee80211_rts_duration - Get the duration field for an RTS frame
1724 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001725 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001726 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02001727 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001728 *
1729 * If the RTS is generated in firmware, but the host system must provide
1730 * the duration field, the low-level driver uses this function to receive
1731 * the duration field value in little-endian byteorder.
1732 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001733__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1734 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001735 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07001736
1737/**
1738 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1739 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001740 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001741 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1742 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001743 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001744 * @cts: The buffer where to store the CTS-to-self frame.
1745 *
1746 * If the CTS-to-self frames are generated by the host system (i.e., not in
1747 * hardware/firmware), the low-level driver uses this function to receive
1748 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1749 * for calling this function before and CTS-to-self frame is needed.
1750 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001751void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1752 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001753 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001754 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e82007-05-05 11:45:53 -07001755 struct ieee80211_cts *cts);
1756
1757/**
1758 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1759 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001760 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001761 * @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 +02001762 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e82007-05-05 11:45:53 -07001763 *
1764 * If the CTS-to-self is generated in firmware, but the host system must provide
1765 * the duration field, the low-level driver uses this function to receive
1766 * the duration field value in little-endian byteorder.
1767 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001768__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1769 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001770 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001771 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e82007-05-05 11:45:53 -07001772
1773/**
1774 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1775 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001776 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001777 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01001778 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07001779 *
1780 * Calculate the duration field of some generic frame, given its
1781 * length and transmission rate (in 100kbps).
1782 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001783__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1784 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001785 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01001786 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07001787
1788/**
1789 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1790 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001791 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001792 *
1793 * Function for accessing buffered broadcast and multicast frames. If
1794 * hardware/firmware does not implement buffering of broadcast/multicast
1795 * frames when power saving is used, 802.11 code buffers them in the host
1796 * memory. The low-level driver uses this function to fetch next buffered
1797 * frame. In most cases, this is used when generating beacon frame. This
1798 * function returns a pointer to the next buffered skb or NULL if no more
1799 * buffered frames are available.
1800 *
1801 * Note: buffered frames are returned only after DTIM beacon frame was
1802 * generated with ieee80211_beacon_get() and the low-level driver must thus
1803 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1804 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1805 * does not need to check for DTIM beacons separately and should be able to
1806 * use common code for all beacons.
1807 */
1808struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02001809ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e82007-05-05 11:45:53 -07001810
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001811/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001812 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1813 *
1814 * This function computes a TKIP rc4 key for an skb. It computes
1815 * a phase 1 key if needed (iv16 wraps around). This function is to
1816 * be used by drivers which can do HW encryption but need to compute
1817 * to phase 1/2 key in SW.
1818 *
1819 * @keyconf: the parameter passed with the set key
1820 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001821 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001822 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001823 */
1824void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1825 struct sk_buff *skb,
1826 enum ieee80211_tkip_key_type type, u8 *key);
1827/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001828 * ieee80211_wake_queue - wake specific queue
1829 * @hw: pointer as obtained from ieee80211_alloc_hw().
1830 * @queue: queue number (counted from zero).
1831 *
1832 * Drivers should use this function instead of netif_wake_queue.
1833 */
1834void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1835
1836/**
1837 * ieee80211_stop_queue - stop specific queue
1838 * @hw: pointer as obtained from ieee80211_alloc_hw().
1839 * @queue: queue number (counted from zero).
1840 *
1841 * Drivers should use this function instead of netif_stop_queue.
1842 */
1843void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1844
1845/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03001846 * ieee80211_queue_stopped - test status of the queue
1847 * @hw: pointer as obtained from ieee80211_alloc_hw().
1848 * @queue: queue number (counted from zero).
1849 *
1850 * Drivers should use this function instead of netif_stop_queue.
1851 */
1852
1853int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1854
1855/**
Jiri Bencf0706e82007-05-05 11:45:53 -07001856 * ieee80211_stop_queues - stop all queues
1857 * @hw: pointer as obtained from ieee80211_alloc_hw().
1858 *
1859 * Drivers should use this function instead of netif_stop_queue.
1860 */
1861void ieee80211_stop_queues(struct ieee80211_hw *hw);
1862
1863/**
1864 * ieee80211_wake_queues - wake all queues
1865 * @hw: pointer as obtained from ieee80211_alloc_hw().
1866 *
1867 * Drivers should use this function instead of netif_wake_queue.
1868 */
1869void ieee80211_wake_queues(struct ieee80211_hw *hw);
1870
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001871/**
1872 * ieee80211_scan_completed - completed hardware scan
1873 *
1874 * When hardware scan offload is used (i.e. the hw_scan() callback is
1875 * assigned) this function needs to be called by the driver to notify
1876 * mac80211 that the scan finished.
1877 *
1878 * @hw: the hardware that finished the scan
Johannes Berg2a519312009-02-10 21:25:55 +01001879 * @aborted: set to true if scan was aborted
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001880 */
Johannes Berg2a519312009-02-10 21:25:55 +01001881void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
Jiri Bencf0706e82007-05-05 11:45:53 -07001882
Johannes Bergdabeb342007-11-09 01:57:29 +01001883/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001884 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01001885 *
1886 * This function iterates over the interfaces associated with a given
1887 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001888 * This function allows the iterator function to sleep, when the iterator
1889 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1890 * be used.
Johannes Bergdabeb342007-11-09 01:57:29 +01001891 *
1892 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001893 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01001894 * @data: first argument of the iterator function
1895 */
1896void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1897 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01001898 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01001899 void *data);
1900
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001901/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001902 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1903 *
1904 * This function iterates over the interfaces associated with a given
1905 * hardware that are currently active and calls the callback for them.
1906 * This function requires the iterator callback function to be atomic,
1907 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1908 *
1909 * @hw: the hardware struct of which the interfaces should be iterated over
1910 * @iterator: the iterator function to call, cannot sleep
1911 * @data: first argument of the iterator function
1912 */
1913void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1914 void (*iterator)(void *data,
1915 u8 *mac,
1916 struct ieee80211_vif *vif),
1917 void *data);
1918
1919/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001920 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1921 * @hw: pointer as obtained from ieee80211_alloc_hw().
1922 * @ra: receiver address of the BA session recipient
1923 * @tid: the TID to BA on.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001924 *
1925 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001926 *
1927 * Although mac80211/low level driver/user space application can estimate
1928 * the need to start aggregation on a certain RA/TID, the session level
1929 * will be managed by the mac80211.
1930 */
1931int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1932
1933/**
1934 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1935 * @hw: pointer as obtained from ieee80211_alloc_hw().
1936 * @ra: receiver address of the BA session recipient.
1937 * @tid: the TID to BA on.
1938 *
1939 * This function must be called by low level driver once it has
1940 * finished with preparations for the BA session.
1941 */
1942void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1943
1944/**
1945 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1946 * @hw: pointer as obtained from ieee80211_alloc_hw().
1947 * @ra: receiver address of the BA session recipient.
1948 * @tid: the TID to BA on.
1949 *
1950 * This function must be called by low level driver once it has
1951 * finished with preparations for the BA session.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001952 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001953 */
1954void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1955 u16 tid);
1956
1957/**
1958 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1959 * @hw: pointer as obtained from ieee80211_alloc_hw().
1960 * @ra: receiver address of the BA session recipient
1961 * @tid: the TID to stop BA.
1962 * @initiator: if indicates initiator DELBA frame will be sent.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001963 *
1964 * Return: error if no sta with matching da found, success otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001965 *
1966 * Although mac80211/low level driver/user space application can estimate
1967 * the need to stop aggregation on a certain RA/TID, the session level
1968 * will be managed by the mac80211.
1969 */
1970int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1971 u8 *ra, u16 tid,
1972 enum ieee80211_back_parties initiator);
1973
1974/**
1975 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1976 * @hw: pointer as obtained from ieee80211_alloc_hw().
1977 * @ra: receiver address of the BA session recipient.
1978 * @tid: the desired TID to BA on.
1979 *
1980 * This function must be called by low level driver once it has
1981 * finished with preparations for the BA session tear down.
1982 */
1983void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1984
1985/**
1986 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1987 * @hw: pointer as obtained from ieee80211_alloc_hw().
1988 * @ra: receiver address of the BA session recipient.
1989 * @tid: the desired TID to BA on.
1990 *
1991 * This function must be called by low level driver once it has
1992 * finished with preparations for the BA session tear down.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001993 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001994 */
1995void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1996 u16 tid);
1997
Mohamed Abbas84363e62008-04-04 16:59:58 -07001998/**
Johannes Berg17741cd2008-09-11 00:02:02 +02001999 * ieee80211_find_sta - find a station
2000 *
2001 * @hw: pointer as obtained from ieee80211_alloc_hw()
2002 * @addr: station's address
2003 *
2004 * This function must be called under RCU lock and the
2005 * resulting pointer is only valid under RCU lock as well.
2006 */
2007struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
2008 const u8 *addr);
2009
Kalle Valo04de8382009-03-22 21:57:35 +02002010/**
2011 * ieee80211_beacon_loss - inform hardware does not receive beacons
2012 *
2013 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
2014 *
2015 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and
2016 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2017 * hardware is not receiving beacons with this function.
2018 */
2019void ieee80211_beacon_loss(struct ieee80211_vif *vif);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002020
2021/* Rate control API */
Johannes Berge6a98542008-10-21 12:40:02 +02002022
Johannes Berg4b7679a2008-09-18 18:14:18 +02002023/**
Sujith81cb7622009-02-12 11:38:37 +05302024 * enum rate_control_changed - flags to indicate which parameter changed
2025 *
2026 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2027 * changed, rate control algorithm can update its internal state if needed.
2028 */
2029enum rate_control_changed {
2030 IEEE80211_RC_HT_CHANGED = BIT(0)
2031};
2032
2033/**
Johannes Berge6a98542008-10-21 12:40:02 +02002034 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
Johannes Berg4b7679a2008-09-18 18:14:18 +02002035 *
Johannes Berge6a98542008-10-21 12:40:02 +02002036 * @hw: The hardware the algorithm is invoked for.
2037 * @sband: The band this frame is being transmitted on.
2038 * @bss_conf: the current BSS configuration
2039 * @reported_rate: The rate control algorithm can fill this in to indicate
2040 * which rate should be reported to userspace as the current rate and
2041 * used for rate calculations in the mesh network.
2042 * @rts: whether RTS will be used for this frame because it is longer than the
2043 * RTS threshold
2044 * @short_preamble: whether mac80211 will request short-preamble transmission
2045 * if the selected rate supports it
2046 * @max_rate_idx: user-requested maximum rate (not MCS for now)
Johannes Berge25cf4a2008-10-23 08:51:20 +02002047 * @skb: the skb that will be transmitted, the control information in it needs
2048 * to be filled in
Johannes Berg4b7679a2008-09-18 18:14:18 +02002049 */
Johannes Berge6a98542008-10-21 12:40:02 +02002050struct ieee80211_tx_rate_control {
2051 struct ieee80211_hw *hw;
2052 struct ieee80211_supported_band *sband;
2053 struct ieee80211_bss_conf *bss_conf;
2054 struct sk_buff *skb;
2055 struct ieee80211_tx_rate reported_rate;
2056 bool rts, short_preamble;
2057 u8 max_rate_idx;
Johannes Berg4b7679a2008-09-18 18:14:18 +02002058};
2059
2060struct rate_control_ops {
2061 struct module *module;
2062 const char *name;
2063 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002064 void (*free)(void *priv);
2065
2066 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2067 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2068 struct ieee80211_sta *sta, void *priv_sta);
Sujith81cb7622009-02-12 11:38:37 +05302069 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2070 struct ieee80211_sta *sta,
2071 void *priv_sta, u32 changed);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002072 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2073 void *priv_sta);
2074
2075 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2076 struct ieee80211_sta *sta, void *priv_sta,
2077 struct sk_buff *skb);
Johannes Berge6a98542008-10-21 12:40:02 +02002078 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2079 struct ieee80211_tx_rate_control *txrc);
Johannes Berg4b7679a2008-09-18 18:14:18 +02002080
2081 void (*add_sta_debugfs)(void *priv, void *priv_sta,
2082 struct dentry *dir);
2083 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2084};
2085
2086static inline int rate_supported(struct ieee80211_sta *sta,
2087 enum ieee80211_band band,
2088 int index)
2089{
2090 return (sta == NULL || sta->supp_rates[band] & BIT(index));
2091}
2092
2093static inline s8
2094rate_lowest_index(struct ieee80211_supported_band *sband,
2095 struct ieee80211_sta *sta)
2096{
2097 int i;
2098
2099 for (i = 0; i < sband->n_bitrates; i++)
2100 if (rate_supported(sta, sband->band, i))
2101 return i;
2102
2103 /* warn when we cannot find a rate. */
2104 WARN_ON(1);
2105
2106 return 0;
2107}
2108
2109
2110int ieee80211_rate_control_register(struct rate_control_ops *ops);
2111void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2112
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002113static inline bool
2114conf_is_ht20(struct ieee80211_conf *conf)
2115{
Johannes Berg47979382009-01-07 10:13:27 +01002116 return conf->channel_type == NL80211_CHAN_HT20;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002117}
2118
2119static inline bool
2120conf_is_ht40_minus(struct ieee80211_conf *conf)
2121{
Johannes Berg47979382009-01-07 10:13:27 +01002122 return conf->channel_type == NL80211_CHAN_HT40MINUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002123}
2124
2125static inline bool
2126conf_is_ht40_plus(struct ieee80211_conf *conf)
2127{
Johannes Berg47979382009-01-07 10:13:27 +01002128 return conf->channel_type == NL80211_CHAN_HT40PLUS;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002129}
2130
2131static inline bool
2132conf_is_ht40(struct ieee80211_conf *conf)
2133{
2134 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2135}
2136
2137static inline bool
2138conf_is_ht(struct ieee80211_conf *conf)
2139{
Johannes Berg47979382009-01-07 10:13:27 +01002140 return conf->channel_type != NL80211_CHAN_NO_HT;
Luis R. Rodriguez10c806b2008-12-23 15:58:36 -08002141}
2142
Jiri Bencf0706e82007-05-05 11:45:53 -07002143#endif /* MAC80211_H */