blob: 94ff3eface499a35d50f7d39de44d4a610f8dd57 [file] [log] [blame]
Jiri Bencf0706e822007-05-05 11:45:53 -07001/*
Johannes Berg3017b802007-08-28 17:01:53 -04002 * mac80211 <-> driver interface
3 *
Jiri Bencf0706e822007-05-05 11:45:53 -07004 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
Johannes Berg3017b802007-08-28 17:01:53 -04006 * Copyright 2007 Johannes Berg <johannes@sipsolutions.net>
Jiri Bencf0706e822007-05-05 11:45:53 -07007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
16#include <linux/kernel.h>
17#include <linux/if_ether.h>
18#include <linux/skbuff.h>
19#include <linux/wireless.h>
20#include <linux/device.h>
21#include <linux/ieee80211.h>
22#include <net/wireless.h>
23#include <net/cfg80211.h>
24
Johannes Berg75a5f0c2007-09-18 17:29:20 -040025/**
26 * DOC: Introduction
27 *
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
31 * drivers.
32 */
33
34/**
35 * DOC: Calling mac80211 from interrupts
36 *
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
Jiri Bencf0706e822007-05-05 11:45:53 -070038 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
Johannes Berg2485f712008-02-25 16:27:41 +010041 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
42 * tasklet function.
43 *
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
Randy Dunlap6ef307b2008-07-03 13:52:18 -070045 * use the non-IRQ-safe functions!
Jiri Bencf0706e822007-05-05 11:45:53 -070046 */
47
Johannes Berg75a5f0c2007-09-18 17:29:20 -040048/**
49 * DOC: Warning
Jiri Bencf0706e822007-05-05 11:45:53 -070050 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040051 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
53 */
54
55/**
56 * DOC: Frame format
Jiri Bencf0706e822007-05-05 11:45:53 -070057 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -040058 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
61 * hardware.
62 *
63 * There are, however, various exceptions to this rule for advanced features:
64 *
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
67 *
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
70 *
71 * Finally, for received frames, the driver is able to indicate that it has
72 * filled a radiotap header and put that in front of the frame; if it does
73 * not do so then mac80211 may add this under certain circumstances.
Jiri Bencf0706e822007-05-05 11:45:53 -070074 */
75
Ron Rindjunsky10816d42007-11-26 16:14:30 +020076/**
Mohamed Abbas84363e62008-04-04 16:59:58 -070077 * enum ieee80211_notification_type - Low level driver notification
78 * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence
79 */
80enum ieee80211_notification_types {
81 IEEE80211_NOTIFY_RE_ASSOC,
82};
83
84/**
Ron Rindjunsky10816d42007-11-26 16:14:30 +020085 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
86 *
87 * This structure describes most essential parameters needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -070088 * to describe 802.11n HT characteristics in a BSS.
Ron Rindjunsky10816d42007-11-26 16:14:30 +020089 *
90 * @primary_channel: channel number of primery channel
91 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
92 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
93 */
94struct ieee80211_ht_bss_info {
95 u8 primary_channel;
96 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
97 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
98};
99
100/**
Johannes Berge100bb62008-04-30 18:51:21 +0200101 * enum ieee80211_max_queues - maximum number of queues
102 *
103 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
104 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
105 * for A-MPDU operation.
106 */
107enum ieee80211_max_queues {
108 IEEE80211_MAX_QUEUES = 16,
109 IEEE80211_MAX_AMPDU_QUEUES = 16,
110};
111
112/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400113 * struct ieee80211_tx_queue_params - transmit queue configuration
114 *
115 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +0100116 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400117 *
Johannes Bergf434b2d2008-07-10 11:22:31 +0200118 * @aifs: arbitration interface space [0..255]
119 * @cw_min: minimum contention window [a value of the form
120 * 2^n-1 in the range 1..32767]
Johannes Berg6b301cd2007-09-18 17:29:20 -0400121 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100122 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Johannes Berg6b301cd2007-09-18 17:29:20 -0400123 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700124struct ieee80211_tx_queue_params {
Johannes Bergf434b2d2008-07-10 11:22:31 +0200125 u16 txop;
Johannes Berg3330d7b2008-02-10 16:49:38 +0100126 u16 cw_min;
127 u16 cw_max;
Johannes Bergf434b2d2008-07-10 11:22:31 +0200128 u8 aifs;
Jiri Bencf0706e822007-05-05 11:45:53 -0700129};
130
Johannes Berg6b301cd2007-09-18 17:29:20 -0400131/**
Johannes Berg57ffc582008-04-29 17:18:59 +0200132 * struct ieee80211_tx_queue_stats - transmit queue statistics
Johannes Berg6b301cd2007-09-18 17:29:20 -0400133 *
134 * @len: number of packets in queue
135 * @limit: queue length limit
136 * @count: number of frames sent
137 */
Johannes Berg57ffc582008-04-29 17:18:59 +0200138struct ieee80211_tx_queue_stats {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400139 unsigned int len;
140 unsigned int limit;
141 unsigned int count;
Jiri Bencf0706e822007-05-05 11:45:53 -0700142};
143
Jiri Bencf0706e822007-05-05 11:45:53 -0700144struct ieee80211_low_level_stats {
145 unsigned int dot11ACKFailureCount;
146 unsigned int dot11RTSFailureCount;
147 unsigned int dot11FCSErrorCount;
148 unsigned int dot11RTSSuccessCount;
149};
150
Johannes Berg471b3ef2007-12-28 14:32:58 +0100151/**
152 * enum ieee80211_bss_change - BSS change notification flags
153 *
154 * These flags are used with the bss_info_changed() callback
155 * to indicate which BSS parameter changed.
156 *
157 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
158 * also implies a change in the AID.
159 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
160 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300161 * @BSS_CHANGED_ERP_SLOT: slot timing changed
Tomas Winkler38668c02008-03-28 16:33:32 -0700162 * @BSS_CHANGED_HT: 802.11n parameters changed
Johannes Berg96dd22a2008-09-11 00:01:57 +0200163 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
Johannes Berg471b3ef2007-12-28 14:32:58 +0100164 */
165enum ieee80211_bss_change {
166 BSS_CHANGED_ASSOC = 1<<0,
167 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
168 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300169 BSS_CHANGED_ERP_SLOT = 1<<3,
Tomas Winkler38668c02008-03-28 16:33:32 -0700170 BSS_CHANGED_HT = 1<<4,
Johannes Berg96dd22a2008-09-11 00:01:57 +0200171 BSS_CHANGED_BASIC_RATES = 1<<5,
Johannes Berg471b3ef2007-12-28 14:32:58 +0100172};
173
174/**
175 * struct ieee80211_bss_conf - holds the BSS's changing parameters
176 *
177 * This structure keeps information about a BSS (and an association
178 * to that BSS) that can change during the lifetime of the BSS.
179 *
180 * @assoc: association status
181 * @aid: association ID number, valid only when @assoc is true
182 * @use_cts_prot: use CTS protection
Johannes Berg7a5158e2008-10-08 10:59:33 +0200183 * @use_short_preamble: use 802.11b short preamble;
184 * if the hardware cannot handle this it must set the
185 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
186 * @use_short_slot: use short slot time (only relevant for ERP);
187 * if the hardware cannot handle this it must set the
188 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800189 * @dtim_period: num of beacons before the next DTIM, for PSM
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700190 * @timestamp: beacon timestamp
191 * @beacon_int: beacon interval
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800192 * @assoc_capability: capabilities taken from assoc resp
Tomas Winkler38668c02008-03-28 16:33:32 -0700193 * @assoc_ht: association in HT mode
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200194 * @ht_cap: ht capabilities
Tomas Winkler38668c02008-03-28 16:33:32 -0700195 * @ht_bss_conf: ht extended capabilities
Johannes Berg96dd22a2008-09-11 00:01:57 +0200196 * @basic_rates: bitmap of basic rates, each bit stands for an
197 * index into the rate table configured by the driver in
198 * the current band.
Johannes Berg471b3ef2007-12-28 14:32:58 +0100199 */
200struct ieee80211_bss_conf {
201 /* association related data */
202 bool assoc;
203 u16 aid;
204 /* erp related data */
205 bool use_cts_prot;
206 bool use_short_preamble;
Jouni Malinen9f1ba902008-08-07 20:07:01 +0300207 bool use_short_slot;
Emmanuel Grumbach98f7dfd2008-07-18 13:52:59 +0800208 u8 dtim_period;
Tomas Winkler21c0cbe2008-03-28 16:33:34 -0700209 u16 beacon_int;
210 u16 assoc_capability;
211 u64 timestamp;
Johannes Berg96dd22a2008-09-11 00:01:57 +0200212 u64 basic_rates;
Tomas Winkler38668c02008-03-28 16:33:32 -0700213 /* ht related data */
214 bool assoc_ht;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200215 struct ieee80211_sta_ht_cap *ht_cap;
Tomas Winkler38668c02008-03-28 16:33:32 -0700216 struct ieee80211_ht_bss_info *ht_bss_conf;
Johannes Berg471b3ef2007-12-28 14:32:58 +0100217};
218
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800219/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700220 * enum mac80211_tx_control_flags - flags to describe transmission information/status
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800221 *
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700222 * These flags are used with the @flags member of &ieee80211_tx_info.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800223 *
Johannes Berge039fa42008-05-15 12:55:29 +0200224 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
Johannes Berge039fa42008-05-15 12:55:29 +0200225 * @IEEE80211_TX_CTL_USE_RTS_CTS: use RTS-CTS before sending frame
226 * @IEEE80211_TX_CTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
227 * for combined 802.11g / 802.11b networks)
228 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700229 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200230 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
231 * station
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700232 * @IEEE80211_TX_CTL_REQUEUE: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200233 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700234 * @IEEE80211_TX_CTL_SHORT_PREAMBLE: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200235 * @IEEE80211_TX_CTL_LONG_RETRY_LIMIT: this frame should be send using the
236 * through set_retry_limit configured long retry value
Johannes Berge039fa42008-05-15 12:55:29 +0200237 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
238 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
239 * @IEEE80211_TX_CTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
240 * of streams when this flag is on can be extracted from antenna_sel_tx,
241 * so if 1 antenna is marked use SISO, 2 antennas marked use MIMO, n
242 * antennas marked use MIMO_n.
243 * @IEEE80211_TX_CTL_GREEN_FIELD: use green field protection for this frame
244 * @IEEE80211_TX_CTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
245 * @IEEE80211_TX_CTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
246 * @IEEE80211_TX_CTL_SHORT_GI: send this frame using short guard interval
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700247 * @IEEE80211_TX_CTL_INJECTED: TBD
Johannes Berge039fa42008-05-15 12:55:29 +0200248 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
249 * because the destination STA was in powersave mode.
250 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
251 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
252 * is for the whole aggregation.
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300253 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
254 * so consider using block ack request (BAR).
Johannes Bergf591fa52008-07-10 11:21:26 +0200255 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
256 * number to this frame, taking care of not overwriting the fragment
257 * number and increasing the sequence number only when the
258 * IEEE80211_TX_CTL_FIRST_FRAGMENT flags is set. mac80211 will properly
259 * assign sequence numbers to QoS-data frames but cannot do so correctly
260 * for non-QoS-data and management frames because beacons need them from
261 * that counter as well and mac80211 cannot guarantee proper sequencing.
262 * If this flag is set, the driver should instruct the hardware to
263 * assign a sequence number to the frame or assign one itself. Cf. IEEE
264 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
265 * beacons always be clear for frames without a sequence number field.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800266 */
267enum mac80211_tx_control_flags {
Johannes Berge039fa42008-05-15 12:55:29 +0200268 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
Johannes Berge039fa42008-05-15 12:55:29 +0200269 IEEE80211_TX_CTL_USE_RTS_CTS = BIT(2),
270 IEEE80211_TX_CTL_USE_CTS_PROTECT = BIT(3),
271 IEEE80211_TX_CTL_NO_ACK = BIT(4),
272 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(5),
273 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(6),
274 IEEE80211_TX_CTL_REQUEUE = BIT(7),
275 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(8),
276 IEEE80211_TX_CTL_SHORT_PREAMBLE = BIT(9),
277 IEEE80211_TX_CTL_LONG_RETRY_LIMIT = BIT(10),
Johannes Berge039fa42008-05-15 12:55:29 +0200278 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(12),
279 IEEE80211_TX_CTL_AMPDU = BIT(13),
280 IEEE80211_TX_CTL_OFDM_HT = BIT(14),
281 IEEE80211_TX_CTL_GREEN_FIELD = BIT(15),
282 IEEE80211_TX_CTL_40_MHZ_WIDTH = BIT(16),
283 IEEE80211_TX_CTL_DUP_DATA = BIT(17),
284 IEEE80211_TX_CTL_SHORT_GI = BIT(18),
285 IEEE80211_TX_CTL_INJECTED = BIT(19),
286 IEEE80211_TX_STAT_TX_FILTERED = BIT(20),
287 IEEE80211_TX_STAT_ACK = BIT(21),
288 IEEE80211_TX_STAT_AMPDU = BIT(22),
Ron Rindjunsky429a3802008-07-01 14:16:03 +0300289 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(23),
Johannes Bergf591fa52008-07-10 11:21:26 +0200290 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(24),
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800291};
292
Johannes Berge039fa42008-05-15 12:55:29 +0200293
294#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE \
295 (sizeof(((struct sk_buff *)0)->cb) - 8)
296#define IEEE80211_TX_INFO_DRIVER_DATA_PTRS \
297 (IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *))
298
Felix Fietkau870abdf2008-10-05 18:04:24 +0200299/* maximum number of alternate rate retry stages */
300#define IEEE80211_TX_MAX_ALTRATE 3
301
302/**
303 * struct ieee80211_tx_altrate - alternate rate selection/status
304 *
305 * @rate_idx: rate index to attempt to send with
306 * @limit: number of retries before fallback
307 */
308struct ieee80211_tx_altrate {
309 s8 rate_idx;
310 u8 limit;
311};
312
Johannes Berge039fa42008-05-15 12:55:29 +0200313/**
314 * struct ieee80211_tx_info - skb transmit information
Ivo van Doorn1c014422008-04-17 19:41:02 +0200315 *
Johannes Berge039fa42008-05-15 12:55:29 +0200316 * This structure is placed in skb->cb for three uses:
317 * (1) mac80211 TX control - mac80211 tells the driver what to do
318 * (2) driver internal use (if applicable)
319 * (3) TX status information - driver tells mac80211 what happened
320 *
Johannes Berg17741cd2008-09-11 00:02:02 +0200321 * The TX control's sta pointer is only valid during the ->tx call,
322 * it may be NULL.
323 *
Johannes Berge039fa42008-05-15 12:55:29 +0200324 * @flags: transmit info flags, defined above
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700325 * @band: TBD
326 * @tx_rate_idx: TBD
Johannes Berg0f4ac382008-10-09 12:18:04 +0200327 * @antenna_sel_tx: antenna to use, 0 for automatic diversity
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700328 * @control: union for control data
329 * @status: union for status data
330 * @driver_data: array of driver_data pointers
Johannes Berge039fa42008-05-15 12:55:29 +0200331 * @retry_count: number of retries
332 * @excessive_retries: set to 1 if the frame was retried many times
333 * but not acknowledged
334 * @ampdu_ack_len: number of aggregated frames.
335 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
336 * @ampdu_ack_map: block ack bit map for the aggregation.
337 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
338 * @ack_signal: signal strength of the ACK frame
Ivo van Doorn1c014422008-04-17 19:41:02 +0200339 */
Johannes Berge039fa42008-05-15 12:55:29 +0200340struct ieee80211_tx_info {
341 /* common information */
342 u32 flags;
343 u8 band;
344 s8 tx_rate_idx;
345 u8 antenna_sel_tx;
Johannes Berg8318d782008-01-24 19:38:38 +0100346
Johannes Berge2530082008-05-17 00:57:14 +0200347 /* 1 byte hole */
Johannes Berg8318d782008-01-24 19:38:38 +0100348
Johannes Berge039fa42008-05-15 12:55:29 +0200349 union {
350 struct {
Johannes Berg25d834e2008-09-12 22:52:47 +0200351 /* NB: vif can be NULL for injected frames */
Johannes Berge039fa42008-05-15 12:55:29 +0200352 struct ieee80211_vif *vif;
353 struct ieee80211_key_conf *hw_key;
Johannes Berg17741cd2008-09-11 00:02:02 +0200354 struct ieee80211_sta *sta;
Johannes Berge039fa42008-05-15 12:55:29 +0200355 unsigned long jiffies;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200356 s8 rts_cts_rate_idx;
Johannes Berge039fa42008-05-15 12:55:29 +0200357 u8 retry_limit;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200358 struct ieee80211_tx_altrate retries[IEEE80211_TX_MAX_ALTRATE];
Johannes Berge039fa42008-05-15 12:55:29 +0200359 } control;
360 struct {
361 u64 ampdu_ack_map;
362 int ack_signal;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200363 struct ieee80211_tx_altrate retries[IEEE80211_TX_MAX_ALTRATE + 1];
Johannes Berge039fa42008-05-15 12:55:29 +0200364 u8 retry_count;
365 bool excessive_retries;
366 u8 ampdu_ack_len;
367 } status;
368 void *driver_data[IEEE80211_TX_INFO_DRIVER_DATA_PTRS];
369 };
Jiri Bencf0706e822007-05-05 11:45:53 -0700370};
371
Johannes Berge039fa42008-05-15 12:55:29 +0200372static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
373{
374 return (struct ieee80211_tx_info *)skb->cb;
375}
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400376
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400377
378/**
379 * enum mac80211_rx_flags - receive flags
380 *
381 * These flags are used with the @flag member of &struct ieee80211_rx_status.
382 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
383 * Use together with %RX_FLAG_MMIC_STRIPPED.
384 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
385 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
386 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
387 * verification has been done by the hardware.
388 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
389 * If this flag is set, the stack cannot do any replay detection
390 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400391 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
392 * the frame.
393 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
394 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100395 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900396 * is valid. This is useful in monitor mode and necessary for beacon frames
397 * to enable IBSS merging.
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200398 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400399 */
400enum mac80211_rx_flags {
401 RX_FLAG_MMIC_ERROR = 1<<0,
402 RX_FLAG_DECRYPTED = 1<<1,
403 RX_FLAG_RADIOTAP = 1<<2,
404 RX_FLAG_MMIC_STRIPPED = 1<<3,
405 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400406 RX_FLAG_FAILED_FCS_CRC = 1<<5,
407 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100408 RX_FLAG_TSFT = 1<<7,
Bruno Randolfb4f28bb2008-07-30 17:19:55 +0200409 RX_FLAG_SHORTPRE = 1<<8
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400410};
411
412/**
413 * struct ieee80211_rx_status - receive status
414 *
415 * The low-level driver should provide this information (the subset
416 * supported by hardware) to the 802.11 code with each received
417 * frame.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200418 *
Bruno Randolfc132bec2008-02-18 11:20:51 +0900419 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
420 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100421 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400422 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Bruno Randolf566bfe52008-05-08 19:15:40 +0200423 * @signal: signal strength when receiving this frame, either in dBm, in dB or
424 * unspecified depending on the hardware capabilities flags
425 * @IEEE80211_HW_SIGNAL_*
426 * @noise: noise when receiving this frame, in dBm.
427 * @qual: overall signal quality indication, in percent (0-100).
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400428 * @antenna: antenna used
Johannes Berg8318d782008-01-24 19:38:38 +0100429 * @rate_idx: index of data rate into band's supported rates
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400430 * @flag: %RX_FLAG_*
431 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700432struct ieee80211_rx_status {
433 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100434 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400435 int freq;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400436 int signal;
Jiri Bencf0706e822007-05-05 11:45:53 -0700437 int noise;
Bruno Randolf566bfe52008-05-08 19:15:40 +0200438 int qual;
Jiri Bencf0706e822007-05-05 11:45:53 -0700439 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100440 int rate_idx;
Jiri Bencf0706e822007-05-05 11:45:53 -0700441 int flag;
442};
443
Johannes Berg6b301cd2007-09-18 17:29:20 -0400444/**
Johannes Berg6b301cd2007-09-18 17:29:20 -0400445 * enum ieee80211_conf_flags - configuration flags
446 *
447 * Flags to define PHY configuration options
448 *
Johannes Berg6b301cd2007-09-18 17:29:20 -0400449 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200450 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
Samuel Ortiz49292d52008-07-04 10:49:31 +0200451 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
Johannes Berg6b301cd2007-09-18 17:29:20 -0400452 */
453enum ieee80211_conf_flags {
Johannes Berg7a5158e2008-10-08 10:59:33 +0200454 IEEE80211_CONF_RADIOTAP = (1<<0),
455 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<1),
456 IEEE80211_CONF_PS = (1<<2),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400457};
Jiri Bencf0706e822007-05-05 11:45:53 -0700458
Johannes Berg7a5158e2008-10-08 10:59:33 +0200459/* XXX: remove all this once drivers stop trying to use it */
460static inline int __deprecated __IEEE80211_CONF_SHORT_SLOT_TIME(void)
461{
462 return 0;
463}
464#define IEEE80211_CONF_SHORT_SLOT_TIME (__IEEE80211_CONF_SHORT_SLOT_TIME())
465
Jiri Bencf0706e822007-05-05 11:45:53 -0700466/**
Johannes Berge8975582008-10-09 12:18:51 +0200467 * enum ieee80211_conf_changed - denotes which configuration changed
468 *
469 * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed
470 * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed
471 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
472 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed
473 * @IEEE80211_CONF_CHANGE_PS: the PS flag changed
474 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
475 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel changed
Johannes Berg9124b072008-10-14 19:17:54 +0200476 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
Johannes Berge8975582008-10-09 12:18:51 +0200477 */
478enum ieee80211_conf_changed {
479 IEEE80211_CONF_CHANGE_RADIO_ENABLED = BIT(0),
480 IEEE80211_CONF_CHANGE_BEACON_INTERVAL = BIT(1),
481 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
482 IEEE80211_CONF_CHANGE_RADIOTAP = BIT(3),
483 IEEE80211_CONF_CHANGE_PS = BIT(4),
484 IEEE80211_CONF_CHANGE_POWER = BIT(5),
485 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
Johannes Berg9124b072008-10-14 19:17:54 +0200486 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
Johannes Berge8975582008-10-09 12:18:51 +0200487};
488
489/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700490 * struct ieee80211_conf - configuration of the device
491 *
492 * This struct indicates how the driver shall configure the hardware.
493 *
494 * @radio_enabled: when zero, driver is required to switch off the radio.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400495 * @beacon_int: beacon interval (TODO make interface config)
Tomas Winklerea95bba2008-07-18 13:53:00 +0800496 * @listen_interval: listen interval in units of beacon interval
Johannes Berg6b301cd2007-09-18 17:29:20 -0400497 * @flags: configuration flags defined above
Johannes Berg8318d782008-01-24 19:38:38 +0100498 * @power_level: requested transmit power (in dBm)
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200499 * @ht_cap: describes current self configuration of 802.11n HT capabilities
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200500 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
Johannes Berg8318d782008-01-24 19:38:38 +0100501 * @channel: the channel to tune to
Johannes Berg9124b072008-10-14 19:17:54 +0200502 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
503 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
504 * but actually means the number of transmissions not the number of retries
505 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
506 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
507 * number of transmissions not the number of retries
Jiri Bencf0706e822007-05-05 11:45:53 -0700508 */
509struct ieee80211_conf {
Jiri Bencf0706e822007-05-05 11:45:53 -0700510 int beacon_int;
Johannes Berg6b301cd2007-09-18 17:29:20 -0400511 u32 flags;
Johannes Berg8318d782008-01-24 19:38:38 +0100512 int power_level;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200513
Johannes Berge8975582008-10-09 12:18:51 +0200514 u16 listen_interval;
515 bool radio_enabled;
516
Johannes Berg9124b072008-10-14 19:17:54 +0200517 u8 long_frame_max_tx_count, short_frame_max_tx_count;
518
Johannes Berg8318d782008-01-24 19:38:38 +0100519 struct ieee80211_channel *channel;
520
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200521 struct ieee80211_sta_ht_cap ht_cap;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200522 struct ieee80211_ht_bss_info ht_bss_conf;
Jiri Bencf0706e822007-05-05 11:45:53 -0700523};
524
525/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100526 * struct ieee80211_vif - per-interface data
527 *
528 * Data in this structure is continually present for driver
529 * use during the life of a virtual interface.
530 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100531 * @type: type of this virtual interface
Johannes Bergbda39332008-10-11 01:51:51 +0200532 * @bss_conf: BSS configuration for this interface, either our own
533 * or the BSS we're associated to
Johannes Berg32bfd352007-12-19 01:31:26 +0100534 * @drv_priv: data area for driver use, will always be aligned to
535 * sizeof(void *).
536 */
537struct ieee80211_vif {
Johannes Berg05c914f2008-09-11 00:01:58 +0200538 enum nl80211_iftype type;
Johannes Bergbda39332008-10-11 01:51:51 +0200539 struct ieee80211_bss_conf bss_conf;
Johannes Berg32bfd352007-12-19 01:31:26 +0100540 /* must be last */
541 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
542};
543
Johannes Berg902acc72008-02-23 15:17:19 +0100544static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
545{
546#ifdef CONFIG_MAC80211_MESH
Johannes Berg05c914f2008-09-11 00:01:58 +0200547 return vif->type == NL80211_IFTYPE_MESH_POINT;
Johannes Berg902acc72008-02-23 15:17:19 +0100548#endif
549 return false;
550}
551
Johannes Berg32bfd352007-12-19 01:31:26 +0100552/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700553 * struct ieee80211_if_init_conf - initial configuration of an interface
554 *
Johannes Berg32bfd352007-12-19 01:31:26 +0100555 * @vif: pointer to a driver-use per-interface structure. The pointer
556 * itself is also used for various functions including
557 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
Johannes Berg05c914f2008-09-11 00:01:58 +0200558 * @type: one of &enum nl80211_iftype constants. Determines the type of
Jiri Bencf0706e822007-05-05 11:45:53 -0700559 * added/removed interface.
560 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
561 * until the interface is removed (i.e. it cannot be used after
562 * remove_interface() callback was called for this interface).
563 *
564 * This structure is used in add_interface() and remove_interface()
565 * callbacks of &struct ieee80211_hw.
Johannes Berg4480f15c2007-07-10 19:32:10 +0200566 *
567 * When you allow multiple interfaces to be added to your PHY, take care
568 * that the hardware can actually handle multiple MAC addresses. However,
569 * also take care that when there's no interface left with mac_addr != %NULL
570 * you remove the MAC address from the device to avoid acknowledging packets
571 * in pure monitor mode.
Jiri Bencf0706e822007-05-05 11:45:53 -0700572 */
573struct ieee80211_if_init_conf {
Johannes Berg05c914f2008-09-11 00:01:58 +0200574 enum nl80211_iftype type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100575 struct ieee80211_vif *vif;
Jiri Bencf0706e822007-05-05 11:45:53 -0700576 void *mac_addr;
577};
578
579/**
Johannes Berg9d139c82008-07-09 14:40:37 +0200580 * enum ieee80211_if_conf_change - interface config change flags
581 *
582 * @IEEE80211_IFCC_BSSID: The BSSID changed.
583 * @IEEE80211_IFCC_SSID: The SSID changed.
584 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
585 * (currently AP and MESH only), use ieee80211_beacon_get().
586 */
587enum ieee80211_if_conf_change {
588 IEEE80211_IFCC_BSSID = BIT(0),
589 IEEE80211_IFCC_SSID = BIT(1),
590 IEEE80211_IFCC_BEACON = BIT(2),
591};
592
593/**
Jiri Bencf0706e822007-05-05 11:45:53 -0700594 * struct ieee80211_if_conf - configuration of an interface
595 *
Johannes Berg9d139c82008-07-09 14:40:37 +0200596 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
Jiri Bencf0706e822007-05-05 11:45:53 -0700597 * @bssid: BSSID of the network we are associated to/creating.
598 * @ssid: used (together with @ssid_len) by drivers for hardware that
599 * generate beacons independently. The pointer is valid only during the
600 * config_interface() call, so copy the value somewhere if you need
601 * it.
602 * @ssid_len: length of the @ssid field.
Jiri Bencf0706e822007-05-05 11:45:53 -0700603 *
604 * This structure is passed to the config_interface() callback of
605 * &struct ieee80211_hw.
606 */
607struct ieee80211_if_conf {
Johannes Berg9d139c82008-07-09 14:40:37 +0200608 u32 changed;
Jiri Bencf0706e822007-05-05 11:45:53 -0700609 u8 *bssid;
610 u8 *ssid;
611 size_t ssid_len;
Jiri Bencf0706e822007-05-05 11:45:53 -0700612};
613
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400614/**
615 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400616 * @ALG_WEP: WEP40 or WEP104
617 * @ALG_TKIP: TKIP
618 * @ALG_CCMP: CCMP (AES)
619 */
Johannes Bergea49c352007-09-18 17:29:21 -0400620enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400621 ALG_WEP,
622 ALG_TKIP,
623 ALG_CCMP,
Johannes Bergea49c352007-09-18 17:29:21 -0400624};
Jiri Bencf0706e822007-05-05 11:45:53 -0700625
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300626/**
627 * enum ieee80211_key_len - key length
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700628 * @LEN_WEP40: WEP 5-byte long key
629 * @LEN_WEP104: WEP 13-byte long key
Emmanuel Grumbach23976ef2008-06-28 02:50:13 +0300630 */
631enum ieee80211_key_len {
632 LEN_WEP40 = 5,
633 LEN_WEP104 = 13,
634};
Johannes Berg11a843b2007-08-28 17:01:55 -0400635
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400636/**
637 * enum ieee80211_key_flags - key flags
638 *
639 * These flags are used for communication about keys between the driver
640 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
641 *
642 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
643 * that the STA this key will be used with could be using QoS.
644 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
645 * driver to indicate that it requires IV generation for this
646 * particular key.
647 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
648 * the driver for a TKIP key if it requires Michael MIC
649 * generation in software.
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200650 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
651 * that the key is pairwise rather then a shared key.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400652 */
653enum ieee80211_key_flags {
654 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
655 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
656 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
Ivo van Doornc6adbd22008-04-17 21:11:18 +0200657 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400658};
659
660/**
661 * struct ieee80211_key_conf - key information
662 *
663 * This key information is given by mac80211 to the driver by
664 * the set_key() callback in &struct ieee80211_ops.
665 *
666 * @hw_key_idx: To be set by the driver, this is the key index the driver
667 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400668 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400669 * @alg: The key algorithm.
670 * @flags: key flags, see &enum ieee80211_key_flags.
671 * @keyidx: the key index (0-3)
672 * @keylen: key material length
Luis R. Rodriguezffd78912008-06-21 10:02:46 -0400673 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
674 * data block:
675 * - Temporal Encryption Key (128 bits)
676 * - Temporal Authenticator Tx MIC Key (64 bits)
677 * - Temporal Authenticator Rx MIC Key (64 bits)
Randy Dunlape1a65b52008-10-13 09:15:01 -0700678 * @icv_len: FIXME
679 * @iv_len: FIXME
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400680 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700681struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400682 enum ieee80211_key_alg alg;
Felix Fietkau76708de2008-10-05 18:02:48 +0200683 u8 icv_len;
684 u8 iv_len;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400685 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400686 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400687 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400688 u8 keylen;
Jiri Bencf0706e822007-05-05 11:45:53 -0700689 u8 key[0];
690};
691
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400692/**
693 * enum set_key_cmd - key command
694 *
695 * Used with the set_key() callback in &struct ieee80211_ops, this
696 * indicates whether a key is being removed or added.
697 *
698 * @SET_KEY: a key is set
699 * @DISABLE_KEY: a key must be disabled
700 */
Johannes Bergea49c352007-09-18 17:29:21 -0400701enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400702 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400703};
Jiri Bencf0706e822007-05-05 11:45:53 -0700704
Tomas Winkler478f8d22007-09-30 13:52:37 +0200705/**
Johannes Berg17741cd2008-09-11 00:02:02 +0200706 * struct ieee80211_sta - station table entry
707 *
708 * A station table entry represents a station we are possibly
709 * communicating with. Since stations are RCU-managed in
710 * mac80211, any ieee80211_sta pointer you get access to must
711 * either be protected by rcu_read_lock() explicitly or implicitly,
712 * or you must take good care to not use such a pointer after a
713 * call to your sta_notify callback that removed it.
714 *
715 * @addr: MAC address
716 * @aid: AID we assigned to the station if we're an AP
Johannes Berg323ce792008-09-11 02:45:11 +0200717 * @supp_rates: Bitmap of supported rates (per band)
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200718 * @ht_cap: HT capabilities of this STA
Johannes Berg17741cd2008-09-11 00:02:02 +0200719 * @drv_priv: data area for driver use, will always be aligned to
720 * sizeof(void *), size is determined in hw information.
721 */
722struct ieee80211_sta {
Johannes Berg323ce792008-09-11 02:45:11 +0200723 u64 supp_rates[IEEE80211_NUM_BANDS];
Johannes Berg17741cd2008-09-11 00:02:02 +0200724 u8 addr[ETH_ALEN];
725 u16 aid;
Johannes Bergd9fe60d2008-10-09 12:13:49 +0200726 struct ieee80211_sta_ht_cap ht_cap;
Johannes Berg17741cd2008-09-11 00:02:02 +0200727
728 /* must be last */
729 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
730};
731
732/**
Tomas Winkler478f8d22007-09-30 13:52:37 +0200733 * enum sta_notify_cmd - sta notify command
734 *
735 * Used with the sta_notify() callback in &struct ieee80211_ops, this
Randy Dunlap6ef307b2008-07-03 13:52:18 -0700736 * indicates addition and removal of a station to station table.
Tomas Winkler478f8d22007-09-30 13:52:37 +0200737 *
738 * @STA_NOTIFY_ADD: a station was added to the station table
739 * @STA_NOTIFY_REMOVE: a station being removed from the station table
740 */
741enum sta_notify_cmd {
742 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
743};
Johannes Berg1bc08262007-09-18 17:29:15 -0400744
745/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +0200746 * enum ieee80211_tkip_key_type - get tkip key
747 *
748 * Used by drivers which need to get a tkip key for skb. Some drivers need a
749 * phase 1 key, others need a phase 2 key. A single function allows the driver
750 * to get the key, this enum indicates what type of key is required.
751 *
752 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
753 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
754 */
755enum ieee80211_tkip_key_type {
756 IEEE80211_TKIP_P1_KEY,
757 IEEE80211_TKIP_P2_KEY,
758};
759
760/**
Johannes Berg1bc08262007-09-18 17:29:15 -0400761 * enum ieee80211_hw_flags - hardware flags
762 *
763 * These flags are used to indicate hardware capabilities to
764 * the stack. Generally, flags here should have their meaning
765 * done in a way that the simplest hardware doesn't need setting
766 * any particular flags. There are some exceptions to this rule,
767 * however, so you are advised to review these flags carefully.
768 *
Johannes Berg1bc08262007-09-18 17:29:15 -0400769 * @IEEE80211_HW_RX_INCLUDES_FCS:
770 * Indicates that received frames passed to the stack include
771 * the FCS at the end.
772 *
773 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
774 * Some wireless LAN chipsets buffer broadcast/multicast frames
775 * for power saving stations in the hardware/firmware and others
776 * rely on the host system for such buffering. This option is used
777 * to configure the IEEE 802.11 upper layer to buffer broadcast and
778 * multicast frames when there are power saving stations so that
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -0700779 * the driver can fetch them with ieee80211_get_buffered_bc().
Johannes Berg1bc08262007-09-18 17:29:15 -0400780 *
Johannes Berg8318d782008-01-24 19:38:38 +0100781 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
782 * Hardware is not capable of short slot operation on the 2.4 GHz band.
783 *
784 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
785 * Hardware is not capable of receiving frames with short preamble on
786 * the 2.4 GHz band.
Bruno Randolf566bfe52008-05-08 19:15:40 +0200787 *
788 * @IEEE80211_HW_SIGNAL_UNSPEC:
789 * Hardware can provide signal values but we don't know its units. We
790 * expect values between 0 and @max_signal.
791 * If possible please provide dB or dBm instead.
792 *
793 * @IEEE80211_HW_SIGNAL_DB:
794 * Hardware gives signal values in dB, decibel difference from an
795 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
796 * If possible please provide dBm instead.
797 *
798 * @IEEE80211_HW_SIGNAL_DBM:
799 * Hardware gives signal values in dBm, decibel difference from
800 * one milliwatt. This is the preferred method since it is standardized
801 * between different devices. @max_signal does not need to be set.
802 *
803 * @IEEE80211_HW_NOISE_DBM:
804 * Hardware can provide noise (radio interference) values in units dBm,
805 * decibel difference from one milliwatt.
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300806 *
807 * @IEEE80211_HW_SPECTRUM_MGMT:
808 * Hardware supports spectrum management defined in 802.11h
809 * Measurement, Channel Switch, Quieting, TPC
Johannes Berg1bc08262007-09-18 17:29:15 -0400810 */
811enum ieee80211_hw_flags {
Johannes Berg1bc08262007-09-18 17:29:15 -0400812 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
813 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +0100814 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
815 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Bruno Randolf566bfe52008-05-08 19:15:40 +0200816 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
817 IEEE80211_HW_SIGNAL_DB = 1<<6,
818 IEEE80211_HW_SIGNAL_DBM = 1<<7,
819 IEEE80211_HW_NOISE_DBM = 1<<8,
Tomas Winkler06ff47b2008-06-18 17:53:44 +0300820 IEEE80211_HW_SPECTRUM_MGMT = 1<<9,
Johannes Berg1bc08262007-09-18 17:29:15 -0400821};
822
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400823/**
824 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400825 *
826 * This structure contains the configuration and hardware
827 * information for an 802.11 PHY.
828 *
829 * @wiphy: This points to the &struct wiphy allocated for this
830 * 802.11 PHY. You must fill in the @perm_addr and @dev
831 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +0100832 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
833 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400834 *
835 * @conf: &struct ieee80211_conf, device configuration, don't use.
836 *
837 * @workqueue: single threaded workqueue available for driver use,
Ivo van Doorn428da762008-06-24 19:23:36 +0200838 * allocated by mac80211 on registration and flushed when an
839 * interface is removed.
840 * NOTICE: All work performed on this workqueue should NEVER
841 * acquire the RTNL lock (i.e. Don't use the function
842 * ieee80211_iterate_active_interfaces())
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400843 *
844 * @priv: pointer to private area that was allocated for driver use
845 * along with this structure.
846 *
847 * @flags: hardware flags, see &enum ieee80211_hw_flags.
848 *
849 * @extra_tx_headroom: headroom to reserve in each transmit skb
850 * for use by the driver (e.g. for transmit headers.)
851 *
852 * @channel_change_time: time (in microseconds) it takes to change channels.
853 *
Bruno Randolf566bfe52008-05-08 19:15:40 +0200854 * @max_signal: Maximum value for signal (rssi) in RX information, used
855 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400856 *
Tomas Winklerea95bba2008-07-18 13:53:00 +0800857 * @max_listen_interval: max listen interval in units of beacon interval
858 * that HW supports
859 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400860 * @queues: number of available hardware transmit queues for
Johannes Berge100bb62008-04-30 18:51:21 +0200861 * data packets. WMM/QoS requires at least four, these
862 * queues need to have configurable access parameters.
863 *
864 * @ampdu_queues: number of available hardware transmit queues
865 * for A-MPDU packets, these have no access parameters
866 * because they're used only for A-MPDU frames. Note that
867 * mac80211 will not currently use any of the regular queues
868 * for aggregation.
Johannes Berg830f9032007-10-28 14:51:05 +0100869 *
870 * @rate_control_algorithm: rate control algorithm for this hardware.
871 * If unset (NULL), the default algorithm will be used. Must be
872 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +0100873 *
874 * @vif_data_size: size (in bytes) of the drv_priv data area
875 * within &struct ieee80211_vif.
Johannes Berg17741cd2008-09-11 00:02:02 +0200876 * @sta_data_size: size (in bytes) of the drv_priv data area
877 * within &struct ieee80211_sta.
Felix Fietkau870abdf2008-10-05 18:04:24 +0200878 *
879 * @max_altrates: maximum number of alternate rate retry stages
880 * @max_altrate_tries: maximum number of tries for each stage
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400881 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700882struct ieee80211_hw {
Jiri Bencf0706e822007-05-05 11:45:53 -0700883 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400884 struct wiphy *wiphy;
Jiri Bencf0706e822007-05-05 11:45:53 -0700885 struct workqueue_struct *workqueue;
Johannes Berg830f9032007-10-28 14:51:05 +0100886 const char *rate_control_algorithm;
Jiri Bencf0706e822007-05-05 11:45:53 -0700887 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400888 u32 flags;
Jiri Bencf0706e822007-05-05 11:45:53 -0700889 unsigned int extra_tx_headroom;
Jiri Bencf0706e822007-05-05 11:45:53 -0700890 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +0100891 int vif_data_size;
Johannes Berg17741cd2008-09-11 00:02:02 +0200892 int sta_data_size;
Tomas Winklerea95bba2008-07-18 13:53:00 +0800893 u16 queues;
894 u16 ampdu_queues;
895 u16 max_listen_interval;
Jiri Bencf0706e822007-05-05 11:45:53 -0700896 s8 max_signal;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200897 u8 max_altrates;
898 u8 max_altrate_tries;
Jiri Bencf0706e822007-05-05 11:45:53 -0700899};
900
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400901/**
902 * SET_IEEE80211_DEV - set device for 802.11 hardware
903 *
904 * @hw: the &struct ieee80211_hw to set the device for
905 * @dev: the &struct device of this 802.11 device
906 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700907static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
908{
909 set_wiphy_dev(hw->wiphy, dev);
910}
911
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400912/**
913 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
914 *
915 * @hw: the &struct ieee80211_hw to set the MAC address for
916 * @addr: the address to set
917 */
Jiri Bencf0706e822007-05-05 11:45:53 -0700918static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
919{
920 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
921}
922
Johannes Berge2530082008-05-17 00:57:14 +0200923static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
924{
Johannes Berge2530082008-05-17 00:57:14 +0200925 return hw->queues;
Johannes Berge2530082008-05-17 00:57:14 +0200926}
927
928static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
929{
Johannes Berge2530082008-05-17 00:57:14 +0200930 return hw->queues + hw->ampdu_queues;
Johannes Berge2530082008-05-17 00:57:14 +0200931}
932
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200933static inline struct ieee80211_rate *
934ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +0200935 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200936{
937 if (WARN_ON(c->tx_rate_idx < 0))
938 return NULL;
939 return &hw->wiphy->bands[c->band]->bitrates[c->tx_rate_idx];
940}
941
942static inline struct ieee80211_rate *
943ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +0200944 const struct ieee80211_tx_info *c)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200945{
Johannes Berge039fa42008-05-15 12:55:29 +0200946 if (c->control.rts_cts_rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200947 return NULL;
Johannes Berge039fa42008-05-15 12:55:29 +0200948 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200949}
950
951static inline struct ieee80211_rate *
952ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
Felix Fietkau870abdf2008-10-05 18:04:24 +0200953 const struct ieee80211_tx_info *c, int idx)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200954{
Felix Fietkau870abdf2008-10-05 18:04:24 +0200955 if (c->control.retries[idx].rate_idx < 0)
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200956 return NULL;
Felix Fietkau870abdf2008-10-05 18:04:24 +0200957 return &hw->wiphy->bands[c->band]->bitrates[c->control.retries[idx].rate_idx];
Johannes Berg2e92e6f2008-05-15 12:55:27 +0200958}
959
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400960/**
961 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -0400962 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400963 * mac80211 is capable of taking advantage of many hardware
964 * acceleration designs for encryption and decryption operations.
965 *
966 * The set_key() callback in the &struct ieee80211_ops for a given
967 * device is called to enable hardware acceleration of encryption and
968 * decryption. The callback takes an @address parameter that will be
969 * the broadcast address for default keys, the other station's hardware
970 * address for individual keys or the zero address for keys that will
971 * be used only for transmission.
972 * Multiple transmission keys with the same key index may be used when
973 * VLANs are configured for an access point.
974 *
975 * The @local_address parameter will always be set to our own address,
976 * this is only relevant if you support multiple local addresses.
977 *
978 * When transmitting, the TX control data will use the @hw_key_idx
979 * selected by the driver by modifying the &struct ieee80211_key_conf
980 * pointed to by the @key parameter to the set_key() function.
981 *
982 * The set_key() call for the %SET_KEY command should return 0 if
983 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
984 * added; if you return 0 then hw_key_idx must be assigned to the
985 * hardware key index, you are free to use the full u8 range.
986 *
987 * When the cmd is %DISABLE_KEY then it must succeed.
988 *
989 * Note that it is permissible to not decrypt a frame even if a key
990 * for it has been uploaded to hardware, the stack will not make any
991 * decision based on whether a key has been uploaded or not but rather
992 * based on the receive flags.
993 *
994 * The &struct ieee80211_key_conf structure pointed to by the @key
995 * parameter is guaranteed to be valid until another call to set_key()
996 * removes it, but it can only be used as a cookie to differentiate
997 * keys.
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +0200998 *
999 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
1000 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1001 * handler.
1002 * The update_tkip_key() call updates the driver with the new phase 1 key.
1003 * This happens everytime the iv16 wraps around (every 65536 packets). The
1004 * set_key() call will happen only once for each key (unless the AP did
1005 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1006 * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
1007 * handler is software decryption with wrap around of iv16.
Johannes Berg4150c572007-09-17 01:29:23 -04001008 */
Johannes Berg4150c572007-09-17 01:29:23 -04001009
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001010/**
1011 * DOC: Frame filtering
1012 *
1013 * mac80211 requires to see many management frames for proper
1014 * operation, and users may want to see many more frames when
1015 * in monitor mode. However, for best CPU usage and power consumption,
1016 * having as few frames as possible percolate through the stack is
1017 * desirable. Hence, the hardware should filter as much as possible.
1018 *
1019 * To achieve this, mac80211 uses filter flags (see below) to tell
1020 * the driver's configure_filter() function which frames should be
1021 * passed to mac80211 and which should be filtered out.
1022 *
1023 * The configure_filter() callback is invoked with the parameters
1024 * @mc_count and @mc_list for the combined multicast address list
1025 * of all virtual interfaces, @changed_flags telling which flags
1026 * were changed and @total_flags with the new flag states.
1027 *
1028 * If your device has no multicast address filters your driver will
1029 * need to check both the %FIF_ALLMULTI flag and the @mc_count
1030 * parameter to see whether multicast frames should be accepted
1031 * or dropped.
1032 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +01001033 * All unsupported flags in @total_flags must be cleared.
1034 * Hardware does not support a flag if it is incapable of _passing_
1035 * the frame to the stack. Otherwise the driver must ignore
1036 * the flag, but not clear it.
1037 * You must _only_ clear the flag (announce no support for the
1038 * flag to mac80211) if you are not able to pass the packet type
1039 * to the stack (so the hardware always filters it).
1040 * So for example, you should clear @FIF_CONTROL, if your hardware
1041 * always filters control frames. If your hardware always passes
1042 * control frames to the kernel and is incapable of filtering them,
1043 * you do _not_ clear the @FIF_CONTROL flag.
1044 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001045 */
1046
1047/**
1048 * enum ieee80211_filter_flags - hardware filter flags
1049 *
1050 * These flags determine what the filter in hardware should be
1051 * programmed to let through and what should not be passed to the
1052 * stack. It is always safe to pass more frames than requested,
1053 * but this has negative impact on power consumption.
1054 *
1055 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1056 * think of the BSS as your network segment and then this corresponds
1057 * to the regular ethernet device promiscuous mode.
1058 *
1059 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1060 * by the user or if the hardware is not capable of filtering by
1061 * multicast address.
1062 *
1063 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1064 * %RX_FLAG_FAILED_FCS_CRC for them)
1065 *
1066 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1067 * the %RX_FLAG_FAILED_PLCP_CRC for them
1068 *
1069 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1070 * to the hardware that it should not filter beacons or probe responses
1071 * by BSSID. Filtering them can greatly reduce the amount of processing
1072 * mac80211 needs to do and the amount of CPU wakeups, so you should
1073 * honour this flag if possible.
1074 *
1075 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1076 * only those addressed to this station
1077 *
1078 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1079 */
1080enum ieee80211_filter_flags {
1081 FIF_PROMISC_IN_BSS = 1<<0,
1082 FIF_ALLMULTI = 1<<1,
1083 FIF_FCSFAIL = 1<<2,
1084 FIF_PLCPFAIL = 1<<3,
1085 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1086 FIF_CONTROL = 1<<5,
1087 FIF_OTHER_BSS = 1<<6,
1088};
1089
1090/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001091 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1092 *
1093 * These flags are used with the ampdu_action() callback in
1094 * &struct ieee80211_ops to indicate which action is needed.
1095 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1096 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001097 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1098 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001099 */
1100enum ieee80211_ampdu_mlme_action {
1101 IEEE80211_AMPDU_RX_START,
1102 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001103 IEEE80211_AMPDU_TX_START,
1104 IEEE80211_AMPDU_TX_STOP,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001105};
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001106
1107/**
1108 * struct ieee80211_ops - callbacks from mac80211 to the driver
1109 *
1110 * This structure contains various callbacks that the driver may
1111 * handle or, in some cases, must handle, for example to configure
1112 * the hardware to a new channel or to transmit a frame.
1113 *
1114 * @tx: Handler that 802.11 module calls for each transmitted frame.
1115 * skb contains the buffer starting from the IEEE 802.11 header.
1116 * The low-level driver should send the frame out based on
Johannes Bergeefce912008-05-17 00:57:13 +02001117 * configuration in the TX control data. This handler should,
1118 * preferably, never fail and stop queues appropriately, more
1119 * importantly, however, it must never fail for A-MPDU-queues.
1120 * Must be implemented and atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001121 *
1122 * @start: Called before the first netdevice attached to the hardware
1123 * is enabled. This should turn on the hardware and must turn on
1124 * frame reception (for possibly enabled monitor interfaces.)
1125 * Returns negative error codes, these may be seen in userspace,
1126 * or zero.
1127 * When the device is started it should not have a MAC address
1128 * to avoid acknowledging frames before a non-monitor device
1129 * is added.
1130 * Must be implemented.
1131 *
1132 * @stop: Called after last netdevice attached to the hardware
1133 * is disabled. This should turn off the hardware (at least
1134 * it must turn off frame reception.)
1135 * May be called right after add_interface if that rejects
1136 * an interface.
1137 * Must be implemented.
1138 *
1139 * @add_interface: Called when a netdevice attached to the hardware is
1140 * enabled. Because it is not called for monitor mode devices, @open
1141 * and @stop must be implemented.
1142 * The driver should perform any initialization it needs before
1143 * the device can be enabled. The initial configuration for the
1144 * interface is given in the conf parameter.
1145 * The callback may refuse to add an interface by returning a
1146 * negative error code (which will be seen in userspace.)
1147 * Must be implemented.
1148 *
1149 * @remove_interface: Notifies a driver that an interface is going down.
1150 * The @stop callback is called after this if it is the last interface
1151 * and no monitor interfaces are present.
1152 * When all interfaces are removed, the MAC address in the hardware
1153 * must be cleared so the device no longer acknowledges packets,
1154 * the mac_addr member of the conf structure is, however, set to the
1155 * MAC address of the device going away.
1156 * Hence, this callback must be implemented.
1157 *
1158 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1159 * function to change hardware configuration, e.g., channel.
1160 *
1161 * @config_interface: Handler for configuration requests related to interfaces
1162 * (e.g. BSSID changes.)
1163 *
Johannes Berg471b3ef2007-12-28 14:32:58 +01001164 * @bss_info_changed: Handler for configuration requests related to BSS
1165 * parameters that may vary during BSS's lifespan, and may affect low
1166 * level driver (e.g. assoc/disassoc status, erp parameters).
1167 * This function should not be used if no BSS has been set, unless
1168 * for association indication. The @changed parameter indicates which
Reinette Chatred18ef292008-04-09 16:56:15 -07001169 * of the bss parameters has changed when a call is made.
Johannes Berg471b3ef2007-12-28 14:32:58 +01001170 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001171 * @configure_filter: Configure the device's RX filter.
1172 * See the section "Frame filtering" for more information.
1173 * This callback must be implemented and atomic.
1174 *
Luis R. Rodriguez546c80c2008-08-14 11:43:20 -07001175 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
Johannes Berg17741cd2008-09-11 00:02:02 +02001176 * must be set or cleared for a given STA. Must be atomic.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001177 *
1178 * @set_key: See the section "Hardware crypto acceleration"
1179 * This callback can sleep, and is only called between add_interface
1180 * and remove_interface calls, i.e. while the interface with the
1181 * given local_address is enabled.
1182 *
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001183 * @update_tkip_key: See the section "Hardware crypto acceleration"
1184 * This callback will be called in the context of Rx. Called for drivers
1185 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1186 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001187 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +01001188 * the scan state machine in stack. The scan must honour the channel
1189 * configuration done by the regulatory agent in the wiphy's registered
Johannes Berg5bc75722008-09-11 00:01:51 +02001190 * bands. When the scan finishes, ieee80211_scan_completed() must be
1191 * called; note that it also must be called when the scan cannot finish
1192 * because the hardware is turned off! Anything else is a bug!
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001193 *
1194 * @get_stats: return low-level statistics
1195 *
Johannes Berg62da92f2007-12-19 02:03:31 +01001196 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1197 * callback should be provided to read the TKIP transmit IVs (both IV32
1198 * and IV16) for the given key from hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001199 *
1200 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1201 *
1202 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1203 * the device does fragmentation by itself; if this method is assigned then
1204 * the stack will not do fragmentation.
1205 *
Tomas Winkler478f8d22007-09-30 13:52:37 +02001206 * @sta_notify: Notifies low level driver about addition or removal
1207 * of assocaited station or AP.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001208 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001209 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
Johannes Bergfe3fa822008-09-08 11:05:09 +02001210 * bursting) for a hardware TX queue.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001211 *
1212 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1213 * to get number of currently queued packets (queue length), maximum queue
1214 * size (limit), and total number of packets sent using each TX queue
Johannes Berg57ffc582008-04-29 17:18:59 +02001215 * (count). The 'stats' pointer points to an array that has hw->queues +
1216 * hw->ampdu_queues items.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001217 *
1218 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1219 * this is only used for IBSS mode debugging and, as such, is not a
1220 * required function. Must be atomic.
1221 *
1222 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1223 * with other STAs in the IBSS. This is only used in IBSS mode. This
1224 * function is optional if the firmware/hardware takes full care of
1225 * TSF synchronization.
1226 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001227 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1228 * This is needed only for IBSS mode and the result of this function is
1229 * used to determine whether to reply to Probe Requests.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001230 *
1231 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001232 *
1233 * @ampdu_action: Perform a certain A-MPDU action
1234 * The RA/TID combination determines the destination and TID we want
1235 * the ampdu action to be performed for. The action is defined through
1236 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001237 * is the first frame we expect to perform the action on. notice
1238 * that TX/RX_STOP can pass NULL for this parameter.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001239 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001240struct ieee80211_ops {
Johannes Berge039fa42008-05-15 12:55:29 +02001241 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
Johannes Berg4150c572007-09-17 01:29:23 -04001242 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001243 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001244 int (*add_interface)(struct ieee80211_hw *hw,
1245 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e822007-05-05 11:45:53 -07001246 void (*remove_interface)(struct ieee80211_hw *hw,
1247 struct ieee80211_if_init_conf *conf);
Johannes Berge8975582008-10-09 12:18:51 +02001248 int (*config)(struct ieee80211_hw *hw, u32 changed);
Jiri Bencf0706e822007-05-05 11:45:53 -07001249 int (*config_interface)(struct ieee80211_hw *hw,
Johannes Berg32bfd352007-12-19 01:31:26 +01001250 struct ieee80211_vif *vif,
1251 struct ieee80211_if_conf *conf);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001252 void (*bss_info_changed)(struct ieee80211_hw *hw,
1253 struct ieee80211_vif *vif,
1254 struct ieee80211_bss_conf *info,
1255 u32 changed);
Johannes Berg4150c572007-09-17 01:29:23 -04001256 void (*configure_filter)(struct ieee80211_hw *hw,
1257 unsigned int changed_flags,
1258 unsigned int *total_flags,
1259 int mc_count, struct dev_addr_list *mc_list);
Johannes Berg17741cd2008-09-11 00:02:02 +02001260 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1261 bool set);
Johannes Bergea49c352007-09-18 17:29:21 -04001262 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Berg11a843b2007-08-28 17:01:55 -04001263 const u8 *local_address, const u8 *address,
1264 struct ieee80211_key_conf *key);
Emmanuel Grumbach9ae4fda2008-03-20 15:06:42 +02001265 void (*update_tkip_key)(struct ieee80211_hw *hw,
1266 struct ieee80211_key_conf *conf, const u8 *address,
1267 u32 iv32, u16 *phase1key);
Jiri Bencf0706e822007-05-05 11:45:53 -07001268 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
Jiri Bencf0706e822007-05-05 11:45:53 -07001269 int (*get_stats)(struct ieee80211_hw *hw,
1270 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001271 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1272 u32 *iv32, u16 *iv16);
Jiri Bencf0706e822007-05-05 11:45:53 -07001273 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e822007-05-05 11:45:53 -07001274 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Johannes Berg32bfd352007-12-19 01:31:26 +01001275 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Johannes Berg17741cd2008-09-11 00:02:02 +02001276 enum sta_notify_cmd, struct ieee80211_sta *sta);
Johannes Berge100bb62008-04-30 18:51:21 +02001277 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
Jiri Bencf0706e822007-05-05 11:45:53 -07001278 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e822007-05-05 11:45:53 -07001279 int (*get_tx_stats)(struct ieee80211_hw *hw,
1280 struct ieee80211_tx_queue_stats *stats);
Jiri Bencf0706e822007-05-05 11:45:53 -07001281 u64 (*get_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001282 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001283 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001284 int (*ampdu_action)(struct ieee80211_hw *hw,
1285 enum ieee80211_ampdu_mlme_action action,
Johannes Berg17741cd2008-09-11 00:02:02 +02001286 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
Jiri Bencf0706e822007-05-05 11:45:53 -07001287};
1288
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001289/**
1290 * ieee80211_alloc_hw - Allocate a new hardware device
1291 *
1292 * This must be called once for each hardware device. The returned pointer
1293 * must be used to refer to this device when calling other functions.
1294 * mac80211 allocates a private data area for the driver pointed to by
1295 * @priv in &struct ieee80211_hw, the size of this area is given as
1296 * @priv_data_len.
1297 *
1298 * @priv_data_len: length of private data
1299 * @ops: callbacks for this device
Jiri Bencf0706e822007-05-05 11:45:53 -07001300 */
1301struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1302 const struct ieee80211_ops *ops);
1303
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001304/**
1305 * ieee80211_register_hw - Register hardware device
1306 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001307 * You must call this function before any other functions in
1308 * mac80211. Note that before a hardware can be registered, you
1309 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001310 *
1311 * @hw: the device to register as returned by ieee80211_alloc_hw()
1312 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001313int ieee80211_register_hw(struct ieee80211_hw *hw);
1314
Jiri Bencf0706e822007-05-05 11:45:53 -07001315#ifdef CONFIG_MAC80211_LEDS
1316extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1317extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001318extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001319extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e822007-05-05 11:45:53 -07001320#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001321/**
1322 * ieee80211_get_tx_led_name - get name of TX LED
1323 *
1324 * mac80211 creates a transmit LED trigger for each wireless hardware
1325 * that can be used to drive LEDs if your driver registers a LED device.
1326 * This function returns the name (or %NULL if not configured for LEDs)
1327 * of the trigger so you can automatically link the LED device.
1328 *
1329 * @hw: the hardware to get the LED trigger name for
1330 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001331static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1332{
1333#ifdef CONFIG_MAC80211_LEDS
1334 return __ieee80211_get_tx_led_name(hw);
1335#else
1336 return NULL;
1337#endif
1338}
1339
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001340/**
1341 * ieee80211_get_rx_led_name - get name of RX LED
1342 *
1343 * mac80211 creates a receive LED trigger for each wireless hardware
1344 * that can be used to drive LEDs if your driver registers a LED device.
1345 * This function returns the name (or %NULL if not configured for LEDs)
1346 * of the trigger so you can automatically link the LED device.
1347 *
1348 * @hw: the hardware to get the LED trigger name for
1349 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001350static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1351{
1352#ifdef CONFIG_MAC80211_LEDS
1353 return __ieee80211_get_rx_led_name(hw);
1354#else
1355 return NULL;
1356#endif
1357}
1358
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001359/**
1360 * ieee80211_get_assoc_led_name - get name of association LED
1361 *
1362 * mac80211 creates a association LED trigger for each wireless hardware
1363 * that can be used to drive LEDs if your driver registers a LED device.
1364 * This function returns the name (or %NULL if not configured for LEDs)
1365 * of the trigger so you can automatically link the LED device.
1366 *
1367 * @hw: the hardware to get the LED trigger name for
1368 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001369static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1370{
1371#ifdef CONFIG_MAC80211_LEDS
1372 return __ieee80211_get_assoc_led_name(hw);
1373#else
1374 return NULL;
1375#endif
1376}
1377
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001378/**
1379 * ieee80211_get_radio_led_name - get name of radio LED
1380 *
1381 * mac80211 creates a radio change LED trigger for each wireless hardware
1382 * that can be used to drive LEDs if your driver registers a LED device.
1383 * This function returns the name (or %NULL if not configured for LEDs)
1384 * of the trigger so you can automatically link the LED device.
1385 *
1386 * @hw: the hardware to get the LED trigger name for
1387 */
1388static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1389{
1390#ifdef CONFIG_MAC80211_LEDS
1391 return __ieee80211_get_radio_led_name(hw);
1392#else
1393 return NULL;
1394#endif
1395}
Michael Buesch47f0c502007-09-27 15:10:44 +02001396
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001397/**
1398 * ieee80211_unregister_hw - Unregister a hardware device
1399 *
1400 * This function instructs mac80211 to free allocated resources
1401 * and unregister netdevices from the networking subsystem.
1402 *
1403 * @hw: the hardware to unregister
1404 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001405void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1406
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001407/**
1408 * ieee80211_free_hw - free hardware descriptor
1409 *
1410 * This function frees everything that was allocated, including the
1411 * private data for the driver. You must call ieee80211_unregister_hw()
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001412 * before calling this function.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001413 *
1414 * @hw: the hardware to free
1415 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001416void ieee80211_free_hw(struct ieee80211_hw *hw);
1417
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001418/* trick to avoid symbol clashes with the ieee80211 subsystem */
Jiri Bencf0706e822007-05-05 11:45:53 -07001419void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1420 struct ieee80211_rx_status *status);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001421
1422/**
1423 * ieee80211_rx - receive frame
1424 *
1425 * Use this function to hand received frames to mac80211. The receive
1426 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1427 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1428 *
Johannes Berg2485f712008-02-25 16:27:41 +01001429 * This function may not be called in IRQ context. Calls to this function
1430 * for a single hardware must be synchronized against each other. Calls
1431 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1432 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001433 *
1434 * @hw: the hardware this frame came in on
1435 * @skb: the buffer to receive, owned by mac80211 after this call
1436 * @status: status of this frame; the status pointer need not be valid
1437 * after this function returns
1438 */
1439static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1440 struct ieee80211_rx_status *status)
1441{
1442 __ieee80211_rx(hw, skb, status);
1443}
1444
1445/**
1446 * ieee80211_rx_irqsafe - receive frame
1447 *
1448 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001449 * (internally defers to a tasklet.)
1450 *
1451 * Calls to this function and ieee80211_rx() may not be mixed for a
1452 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001453 *
1454 * @hw: the hardware this frame came in on
1455 * @skb: the buffer to receive, owned by mac80211 after this call
1456 * @status: status of this frame; the status pointer need not be valid
1457 * after this function returns and is not freed by mac80211,
1458 * it is recommended that it points to a stack area
1459 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001460void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1461 struct sk_buff *skb,
1462 struct ieee80211_rx_status *status);
1463
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001464/**
1465 * ieee80211_tx_status - transmit status callback
1466 *
1467 * Call this function for all transmitted frames after they have been
1468 * transmitted. It is permissible to not call this function for
1469 * multicast frames but this can affect statistics.
1470 *
Johannes Berg2485f712008-02-25 16:27:41 +01001471 * This function may not be called in IRQ context. Calls to this function
1472 * for a single hardware must be synchronized against each other. Calls
1473 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1474 * for a single hardware.
1475 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001476 * @hw: the hardware the frame was transmitted by
1477 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001478 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001479void ieee80211_tx_status(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001480 struct sk_buff *skb);
Johannes Berg2485f712008-02-25 16:27:41 +01001481
1482/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001483 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
Johannes Berg2485f712008-02-25 16:27:41 +01001484 *
1485 * Like ieee80211_tx_status() but can be called in IRQ context
1486 * (internally defers to a tasklet.)
1487 *
1488 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1489 * single hardware.
1490 *
1491 * @hw: the hardware the frame was transmitted by
1492 * @skb: the frame that was transmitted, owned by mac80211 after this call
Johannes Berg2485f712008-02-25 16:27:41 +01001493 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001494void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001495 struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07001496
1497/**
1498 * ieee80211_beacon_get - beacon generation function
1499 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001500 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001501 *
1502 * If the beacon frames are generated by the host system (i.e., not in
1503 * hardware/firmware), the low-level driver uses this function to receive
1504 * the next beacon frame from the 802.11 code. The low-level is responsible
1505 * for calling this function before beacon data is needed (e.g., based on
1506 * hardware interrupt). Returned skb is used only once and low-level driver
1507 * is responsible of freeing it.
1508 */
1509struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
Johannes Berge039fa42008-05-15 12:55:29 +02001510 struct ieee80211_vif *vif);
Jiri Bencf0706e822007-05-05 11:45:53 -07001511
1512/**
1513 * ieee80211_rts_get - RTS frame generation function
1514 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001515 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001516 * @frame: pointer to the frame that is going to be protected by the RTS.
1517 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001518 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001519 * @rts: The buffer where to store the RTS frame.
1520 *
1521 * If the RTS frames are generated by the host system (i.e., not in
1522 * hardware/firmware), the low-level driver uses this function to receive
1523 * the next RTS frame from the 802.11 code. The low-level is responsible
1524 * for calling this function before and RTS frame is needed.
1525 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001526void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001527 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001528 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07001529 struct ieee80211_rts *rts);
1530
1531/**
1532 * ieee80211_rts_duration - Get the duration field for an RTS frame
1533 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001534 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001535 * @frame_len: the length of the frame that is going to be protected by the RTS.
Johannes Berge039fa42008-05-15 12:55:29 +02001536 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001537 *
1538 * If the RTS is generated in firmware, but the host system must provide
1539 * the duration field, the low-level driver uses this function to receive
1540 * the duration field value in little-endian byteorder.
1541 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001542__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1543 struct ieee80211_vif *vif, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001544 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07001545
1546/**
1547 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1548 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001549 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001550 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1551 * @frame_len: the frame length (in octets).
Johannes Berge039fa42008-05-15 12:55:29 +02001552 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001553 * @cts: The buffer where to store the CTS-to-self frame.
1554 *
1555 * If the CTS-to-self frames are generated by the host system (i.e., not in
1556 * hardware/firmware), the low-level driver uses this function to receive
1557 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1558 * for calling this function before and CTS-to-self frame is needed.
1559 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001560void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1561 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001562 const void *frame, size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001563 const struct ieee80211_tx_info *frame_txctl,
Jiri Bencf0706e822007-05-05 11:45:53 -07001564 struct ieee80211_cts *cts);
1565
1566/**
1567 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1568 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001569 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001570 * @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 +02001571 * @frame_txctl: &struct ieee80211_tx_info of the frame.
Jiri Bencf0706e822007-05-05 11:45:53 -07001572 *
1573 * If the CTS-to-self is generated in firmware, but the host system must provide
1574 * the duration field, the low-level driver uses this function to receive
1575 * the duration field value in little-endian byteorder.
1576 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001577__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1578 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001579 size_t frame_len,
Johannes Berge039fa42008-05-15 12:55:29 +02001580 const struct ieee80211_tx_info *frame_txctl);
Jiri Bencf0706e822007-05-05 11:45:53 -07001581
1582/**
1583 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1584 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001585 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001586 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01001587 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e822007-05-05 11:45:53 -07001588 *
1589 * Calculate the duration field of some generic frame, given its
1590 * length and transmission rate (in 100kbps).
1591 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001592__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1593 struct ieee80211_vif *vif,
Jiri Bencf0706e822007-05-05 11:45:53 -07001594 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01001595 struct ieee80211_rate *rate);
Jiri Bencf0706e822007-05-05 11:45:53 -07001596
1597/**
1598 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1599 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001600 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e822007-05-05 11:45:53 -07001601 *
1602 * Function for accessing buffered broadcast and multicast frames. If
1603 * hardware/firmware does not implement buffering of broadcast/multicast
1604 * frames when power saving is used, 802.11 code buffers them in the host
1605 * memory. The low-level driver uses this function to fetch next buffered
1606 * frame. In most cases, this is used when generating beacon frame. This
1607 * function returns a pointer to the next buffered skb or NULL if no more
1608 * buffered frames are available.
1609 *
1610 * Note: buffered frames are returned only after DTIM beacon frame was
1611 * generated with ieee80211_beacon_get() and the low-level driver must thus
1612 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1613 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1614 * does not need to check for DTIM beacons separately and should be able to
1615 * use common code for all beacons.
1616 */
1617struct sk_buff *
Johannes Berge039fa42008-05-15 12:55:29 +02001618ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
Jiri Bencf0706e822007-05-05 11:45:53 -07001619
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001620/**
1621 * ieee80211_get_hdrlen_from_skb - get header length from data
1622 *
1623 * Given an skb with a raw 802.11 header at the data pointer this function
Jiri Bencf0706e822007-05-05 11:45:53 -07001624 * returns the 802.11 header length in bytes (not including encryption
1625 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1626 * header the function returns 0.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001627 *
1628 * @skb: the frame
Jiri Bencf0706e822007-05-05 11:45:53 -07001629 */
Harvey Harrisonc9c69502008-06-11 14:21:57 -07001630unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
Jiri Bencf0706e822007-05-05 11:45:53 -07001631
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001632/**
Harvey Harrison6693be72008-06-11 14:21:57 -07001633 * ieee80211_hdrlen - get header length in bytes from frame control
1634 * @fc: frame control field in little-endian format
1635 */
1636unsigned int ieee80211_hdrlen(__le16 fc);
1637
1638/**
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001639 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1640 *
1641 * This function computes a TKIP rc4 key for an skb. It computes
1642 * a phase 1 key if needed (iv16 wraps around). This function is to
1643 * be used by drivers which can do HW encryption but need to compute
1644 * to phase 1/2 key in SW.
1645 *
1646 * @keyconf: the parameter passed with the set key
1647 * @skb: the skb for which the key is needed
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001648 * @type: TBD
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001649 * @key: a buffer to which the key will be written
Emmanuel Grumbach5d2cdcd2008-03-20 15:06:41 +02001650 */
1651void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1652 struct sk_buff *skb,
1653 enum ieee80211_tkip_key_type type, u8 *key);
1654/**
Jiri Bencf0706e822007-05-05 11:45:53 -07001655 * ieee80211_wake_queue - wake specific queue
1656 * @hw: pointer as obtained from ieee80211_alloc_hw().
1657 * @queue: queue number (counted from zero).
1658 *
1659 * Drivers should use this function instead of netif_wake_queue.
1660 */
1661void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1662
1663/**
1664 * ieee80211_stop_queue - stop specific queue
1665 * @hw: pointer as obtained from ieee80211_alloc_hw().
1666 * @queue: queue number (counted from zero).
1667 *
1668 * Drivers should use this function instead of netif_stop_queue.
1669 */
1670void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1671
1672/**
Tomas Winkler92ab8532008-07-24 21:02:04 +03001673 * ieee80211_queue_stopped - test status of the queue
1674 * @hw: pointer as obtained from ieee80211_alloc_hw().
1675 * @queue: queue number (counted from zero).
1676 *
1677 * Drivers should use this function instead of netif_stop_queue.
1678 */
1679
1680int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1681
1682/**
Jiri Bencf0706e822007-05-05 11:45:53 -07001683 * ieee80211_stop_queues - stop all queues
1684 * @hw: pointer as obtained from ieee80211_alloc_hw().
1685 *
1686 * Drivers should use this function instead of netif_stop_queue.
1687 */
1688void ieee80211_stop_queues(struct ieee80211_hw *hw);
1689
1690/**
1691 * ieee80211_wake_queues - wake all queues
1692 * @hw: pointer as obtained from ieee80211_alloc_hw().
1693 *
1694 * Drivers should use this function instead of netif_wake_queue.
1695 */
1696void ieee80211_wake_queues(struct ieee80211_hw *hw);
1697
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001698/**
1699 * ieee80211_scan_completed - completed hardware scan
1700 *
1701 * When hardware scan offload is used (i.e. the hw_scan() callback is
1702 * assigned) this function needs to be called by the driver to notify
1703 * mac80211 that the scan finished.
1704 *
1705 * @hw: the hardware that finished the scan
1706 */
Jiri Bencf0706e822007-05-05 11:45:53 -07001707void ieee80211_scan_completed(struct ieee80211_hw *hw);
1708
Johannes Bergdabeb342007-11-09 01:57:29 +01001709/**
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001710 * ieee80211_iterate_active_interfaces - iterate active interfaces
Johannes Bergdabeb342007-11-09 01:57:29 +01001711 *
1712 * This function iterates over the interfaces associated with a given
1713 * hardware that are currently active and calls the callback for them.
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001714 * This function allows the iterator function to sleep, when the iterator
1715 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1716 * be used.
Johannes Bergdabeb342007-11-09 01:57:29 +01001717 *
1718 * @hw: the hardware struct of which the interfaces should be iterated over
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001719 * @iterator: the iterator function to call
Johannes Bergdabeb342007-11-09 01:57:29 +01001720 * @data: first argument of the iterator function
1721 */
1722void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1723 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01001724 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01001725 void *data);
1726
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001727/**
Ivo van Doorn2f561fe2008-05-10 13:40:49 +02001728 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1729 *
1730 * This function iterates over the interfaces associated with a given
1731 * hardware that are currently active and calls the callback for them.
1732 * This function requires the iterator callback function to be atomic,
1733 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1734 *
1735 * @hw: the hardware struct of which the interfaces should be iterated over
1736 * @iterator: the iterator function to call, cannot sleep
1737 * @data: first argument of the iterator function
1738 */
1739void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1740 void (*iterator)(void *data,
1741 u8 *mac,
1742 struct ieee80211_vif *vif),
1743 void *data);
1744
1745/**
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001746 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1747 * @hw: pointer as obtained from ieee80211_alloc_hw().
1748 * @ra: receiver address of the BA session recipient
1749 * @tid: the TID to BA on.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001750 *
1751 * Return: success if addBA request was sent, failure otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001752 *
1753 * Although mac80211/low level driver/user space application can estimate
1754 * the need to start aggregation on a certain RA/TID, the session level
1755 * will be managed by the mac80211.
1756 */
1757int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1758
1759/**
1760 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1761 * @hw: pointer as obtained from ieee80211_alloc_hw().
1762 * @ra: receiver address of the BA session recipient.
1763 * @tid: the TID to BA on.
1764 *
1765 * This function must be called by low level driver once it has
1766 * finished with preparations for the BA session.
1767 */
1768void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1769
1770/**
1771 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1772 * @hw: pointer as obtained from ieee80211_alloc_hw().
1773 * @ra: receiver address of the BA session recipient.
1774 * @tid: the TID to BA on.
1775 *
1776 * This function must be called by low level driver once it has
1777 * finished with preparations for the BA session.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001778 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001779 */
1780void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1781 u16 tid);
1782
1783/**
1784 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1785 * @hw: pointer as obtained from ieee80211_alloc_hw().
1786 * @ra: receiver address of the BA session recipient
1787 * @tid: the TID to stop BA.
1788 * @initiator: if indicates initiator DELBA frame will be sent.
Randy Dunlapea2d8b52008-10-27 09:47:03 -07001789 *
1790 * Return: error if no sta with matching da found, success otherwise
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001791 *
1792 * Although mac80211/low level driver/user space application can estimate
1793 * the need to stop aggregation on a certain RA/TID, the session level
1794 * will be managed by the mac80211.
1795 */
1796int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1797 u8 *ra, u16 tid,
1798 enum ieee80211_back_parties initiator);
1799
1800/**
1801 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1802 * @hw: pointer as obtained from ieee80211_alloc_hw().
1803 * @ra: receiver address of the BA session recipient.
1804 * @tid: the desired TID to BA on.
1805 *
1806 * This function must be called by low level driver once it has
1807 * finished with preparations for the BA session tear down.
1808 */
1809void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1810
1811/**
1812 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1813 * @hw: pointer as obtained from ieee80211_alloc_hw().
1814 * @ra: receiver address of the BA session recipient.
1815 * @tid: the desired TID to BA on.
1816 *
1817 * This function must be called by low level driver once it has
1818 * finished with preparations for the BA session tear down.
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001819 * This version of the function is IRQ-safe.
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001820 */
1821void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1822 u16 tid);
1823
Mohamed Abbas84363e62008-04-04 16:59:58 -07001824/**
1825 * ieee80211_notify_mac - low level driver notification
1826 * @hw: pointer as obtained from ieee80211_alloc_hw().
Randy Dunlap6ef307b2008-07-03 13:52:18 -07001827 * @notif_type: enum ieee80211_notification_types
Mohamed Abbas84363e62008-04-04 16:59:58 -07001828 *
1829 * This function must be called by low level driver to inform mac80211 of
1830 * low level driver status change or force mac80211 to re-assoc for low
1831 * level driver internal error that require re-assoc.
1832 */
1833void ieee80211_notify_mac(struct ieee80211_hw *hw,
1834 enum ieee80211_notification_types notif_type);
Johannes Berg17741cd2008-09-11 00:02:02 +02001835
1836/**
1837 * ieee80211_find_sta - find a station
1838 *
1839 * @hw: pointer as obtained from ieee80211_alloc_hw()
1840 * @addr: station's address
1841 *
1842 * This function must be called under RCU lock and the
1843 * resulting pointer is only valid under RCU lock as well.
1844 */
1845struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
1846 const u8 *addr);
1847
Johannes Berg4b7679a2008-09-18 18:14:18 +02001848
1849/* Rate control API */
1850/**
1851 * struct rate_selection - rate information for/from rate control algorithms
1852 *
1853 * @rate_idx: selected transmission rate index
1854 * @nonerp_idx: Non-ERP rate to use instead if ERP cannot be used
1855 * @probe_idx: rate for probing (or -1)
1856 * @max_rate_idx: maximum rate index that can be used, this is
1857 * input to the algorithm and will be enforced
1858 */
1859struct rate_selection {
1860 s8 rate_idx, nonerp_idx, probe_idx, max_rate_idx;
1861};
1862
1863struct rate_control_ops {
1864 struct module *module;
1865 const char *name;
1866 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
1867 void (*clear)(void *priv);
1868 void (*free)(void *priv);
1869
1870 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
1871 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
1872 struct ieee80211_sta *sta, void *priv_sta);
1873 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
1874 void *priv_sta);
1875
1876 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
1877 struct ieee80211_sta *sta, void *priv_sta,
1878 struct sk_buff *skb);
1879 void (*get_rate)(void *priv, struct ieee80211_supported_band *sband,
1880 struct ieee80211_sta *sta, void *priv_sta,
1881 struct sk_buff *skb,
1882 struct rate_selection *sel);
1883
1884 void (*add_sta_debugfs)(void *priv, void *priv_sta,
1885 struct dentry *dir);
1886 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
1887};
1888
1889static inline int rate_supported(struct ieee80211_sta *sta,
1890 enum ieee80211_band band,
1891 int index)
1892{
1893 return (sta == NULL || sta->supp_rates[band] & BIT(index));
1894}
1895
1896static inline s8
1897rate_lowest_index(struct ieee80211_supported_band *sband,
1898 struct ieee80211_sta *sta)
1899{
1900 int i;
1901
1902 for (i = 0; i < sband->n_bitrates; i++)
1903 if (rate_supported(sta, sband->band, i))
1904 return i;
1905
1906 /* warn when we cannot find a rate. */
1907 WARN_ON(1);
1908
1909 return 0;
1910}
1911
1912
1913int ieee80211_rate_control_register(struct rate_control_ops *ops);
1914void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
1915
Jiri Bencf0706e822007-05-05 11:45:53 -07001916#endif /* MAC80211_H */