blob: 5ab6a350ee6d9b95cbd27c8146b0a58349d529d1 [file] [log] [blame]
Jiri Bencf0706e82007-05-05 11:45:53 -07001/*
Johannes Berg3017b802007-08-28 17:01:53 -04002 * mac80211 <-> driver interface
3 *
Jiri Bencf0706e82007-05-05 11:45:53 -07004 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
Johannes Berg3017b802007-08-28 17:01:53 -04006 * Copyright 2007 Johannes Berg <johannes@sipsolutions.net>
Jiri Bencf0706e82007-05-05 11:45:53 -07007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#ifndef MAC80211_H
14#define MAC80211_H
15
16#include <linux/kernel.h>
17#include <linux/if_ether.h>
18#include <linux/skbuff.h>
19#include <linux/wireless.h>
20#include <linux/device.h>
21#include <linux/ieee80211.h>
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 Bencf0706e82007-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
45 * use the non-irqsafe functions!
Jiri Bencf0706e82007-05-05 11:45:53 -070046 */
47
Johannes Berg75a5f0c2007-09-18 17:29:20 -040048/**
49 * DOC: Warning
Jiri Bencf0706e82007-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 Bencf0706e82007-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 Bencf0706e82007-05-05 11:45:53 -070074 */
75
Ron Rindjunsky10816d42007-11-26 16:14:30 +020076/**
77 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
78 *
79 * This structure describes most essential parameters needed
80 * to describe 802.11n HT characteristics in a BSS
81 *
82 * @primary_channel: channel number of primery channel
83 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
84 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
85 */
86struct ieee80211_ht_bss_info {
87 u8 primary_channel;
88 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
89 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
90};
91
92/**
Johannes Berg6b301cd2007-09-18 17:29:20 -040093 * struct ieee80211_tx_queue_params - transmit queue configuration
94 *
95 * The information provided in this structure is required for QoS
Johannes Berg3330d7b2008-02-10 16:49:38 +010096 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
Johannes Berg6b301cd2007-09-18 17:29:20 -040097 *
98 * @aifs: arbitration interface space [0..255, -1: use default]
99 * @cw_min: minimum contention window [will be a value of the form
100 * 2^n-1 in the range 1..1023; 0: use default]
101 * @cw_max: maximum contention window [like @cw_min]
Johannes Berg3330d7b2008-02-10 16:49:38 +0100102 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
Johannes Berg6b301cd2007-09-18 17:29:20 -0400103 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700104struct ieee80211_tx_queue_params {
Johannes Berg3330d7b2008-02-10 16:49:38 +0100105 s16 aifs;
106 u16 cw_min;
107 u16 cw_max;
108 u16 txop;
Jiri Bencf0706e82007-05-05 11:45:53 -0700109};
110
Johannes Berg6b301cd2007-09-18 17:29:20 -0400111/**
112 * struct ieee80211_tx_queue_stats_data - transmit queue statistics
113 *
114 * @len: number of packets in queue
115 * @limit: queue length limit
116 * @count: number of frames sent
117 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700118struct ieee80211_tx_queue_stats_data {
Johannes Berg6b301cd2007-09-18 17:29:20 -0400119 unsigned int len;
120 unsigned int limit;
121 unsigned int count;
Jiri Bencf0706e82007-05-05 11:45:53 -0700122};
123
Johannes Berg6b301cd2007-09-18 17:29:20 -0400124/**
125 * enum ieee80211_tx_queue - transmit queue number
126 *
127 * These constants are used with some callbacks that take a
128 * queue number to set parameters for a queue.
129 *
130 * @IEEE80211_TX_QUEUE_DATA0: data queue 0
131 * @IEEE80211_TX_QUEUE_DATA1: data queue 1
132 * @IEEE80211_TX_QUEUE_DATA2: data queue 2
133 * @IEEE80211_TX_QUEUE_DATA3: data queue 3
134 * @IEEE80211_TX_QUEUE_DATA4: data queue 4
135 * @IEEE80211_TX_QUEUE_SVP: ??
136 * @NUM_TX_DATA_QUEUES: number of data queues
137 * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be
138 * sent after a beacon
139 * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames
Ron Rindjunsky9e723492008-01-28 14:07:18 +0200140 * @NUM_TX_DATA_QUEUES_AMPDU: adding more queues for A-MPDU
Johannes Berg6b301cd2007-09-18 17:29:20 -0400141 */
142enum ieee80211_tx_queue {
Jiri Bencf0706e82007-05-05 11:45:53 -0700143 IEEE80211_TX_QUEUE_DATA0,
144 IEEE80211_TX_QUEUE_DATA1,
145 IEEE80211_TX_QUEUE_DATA2,
146 IEEE80211_TX_QUEUE_DATA3,
147 IEEE80211_TX_QUEUE_DATA4,
148 IEEE80211_TX_QUEUE_SVP,
149
150 NUM_TX_DATA_QUEUES,
151
152/* due to stupidity in the sub-ioctl userspace interface, the items in
153 * this struct need to have fixed values. As soon as it is removed, we can
154 * fix these entries. */
155 IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
Ron Rindjunsky9e723492008-01-28 14:07:18 +0200156 IEEE80211_TX_QUEUE_BEACON = 7,
157 NUM_TX_DATA_QUEUES_AMPDU = 16
Jiri Bencf0706e82007-05-05 11:45:53 -0700158};
159
160struct ieee80211_tx_queue_stats {
Ron Rindjunsky9e723492008-01-28 14:07:18 +0200161 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES_AMPDU];
Jiri Bencf0706e82007-05-05 11:45:53 -0700162};
163
164struct ieee80211_low_level_stats {
165 unsigned int dot11ACKFailureCount;
166 unsigned int dot11RTSFailureCount;
167 unsigned int dot11FCSErrorCount;
168 unsigned int dot11RTSSuccessCount;
169};
170
Johannes Berg471b3ef2007-12-28 14:32:58 +0100171/**
172 * enum ieee80211_bss_change - BSS change notification flags
173 *
174 * These flags are used with the bss_info_changed() callback
175 * to indicate which BSS parameter changed.
176 *
177 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
178 * also implies a change in the AID.
179 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
180 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
181 */
182enum ieee80211_bss_change {
183 BSS_CHANGED_ASSOC = 1<<0,
184 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
185 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
186};
187
188/**
189 * struct ieee80211_bss_conf - holds the BSS's changing parameters
190 *
191 * This structure keeps information about a BSS (and an association
192 * to that BSS) that can change during the lifetime of the BSS.
193 *
194 * @assoc: association status
195 * @aid: association ID number, valid only when @assoc is true
196 * @use_cts_prot: use CTS protection
197 * @use_short_preamble: use 802.11b short preamble
198 */
199struct ieee80211_bss_conf {
200 /* association related data */
201 bool assoc;
202 u16 aid;
203 /* erp related data */
204 bool use_cts_prot;
205 bool use_short_preamble;
206};
207
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800208/**
209 * enum mac80211_tx_control_flags - flags to describe Tx configuration for
210 * the Tx frame
211 *
212 * These flags are used with the @flags member of &ieee80211_tx_control
213 *
214 * @IEEE80211_TXCTL_REQ_TX_STATUS: request TX status callback for this frame.
215 * @IEEE80211_TXCTL_DO_NOT_ENCRYPT: send this frame without encryption;
216 * e.g., for EAPOL frame
217 * @IEEE80211_TXCTL_USE_RTS_CTS: use RTS-CTS before sending frame
218 * @IEEE80211_TXCTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
219 * for combined 802.11g / 802.11b networks)
220 * @IEEE80211_TXCTL_NO_ACK: tell the low level not to wait for an ack
221 * @IEEE80211_TXCTL_RATE_CTRL_PROBE
222 * @EEE80211_TXCTL_CLEAR_PS_FILT: clear powersave filter
223 * for destination station
224 * @IEEE80211_TXCTL_REQUEUE:
225 * @IEEE80211_TXCTL_FIRST_FRAGMENT: this is a first fragment of the frame
226 * @IEEE80211_TXCTL_LONG_RETRY_LIMIT: this frame should be send using the
227 * through set_retry_limit configured long
228 * retry value
229 * @IEEE80211_TXCTL_EAPOL_FRAME: internal to mac80211
230 * @IEEE80211_TXCTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
231 * @IEEE80211_TXCTL_AMPDU: this frame should be sent as part of an A-MPDU
Ron Rindjunsky6c5ef8a2008-03-05 17:38:59 +0200232 * @IEEE80211_TXCTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
233 * of streams when this flag is on can be extracted
234 * from antenna_sel_tx, so if 1 antenna is marked
235 * use SISO, 2 antennas marked use MIMO, n antennas
236 * marked use MIMO_n.
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800237 * @IEEE80211_TXCTL_GREEN_FIELD: use green field protection for this frame
238 * @IEEE80211_TXCTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
239 * @IEEE80211_TXCTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
240 * @IEEE80211_TXCTL_SHORT_GI: send this frame using short guard interval
241 */
242enum mac80211_tx_control_flags {
243 IEEE80211_TXCTL_REQ_TX_STATUS = (1<<0),
244 IEEE80211_TXCTL_DO_NOT_ENCRYPT = (1<<1),
245 IEEE80211_TXCTL_USE_RTS_CTS = (1<<2),
246 IEEE80211_TXCTL_USE_CTS_PROTECT = (1<<3),
247 IEEE80211_TXCTL_NO_ACK = (1<<4),
248 IEEE80211_TXCTL_RATE_CTRL_PROBE = (1<<5),
249 IEEE80211_TXCTL_CLEAR_PS_FILT = (1<<6),
250 IEEE80211_TXCTL_REQUEUE = (1<<7),
251 IEEE80211_TXCTL_FIRST_FRAGMENT = (1<<8),
252 IEEE80211_TXCTL_SHORT_PREAMBLE = (1<<9),
253 IEEE80211_TXCTL_LONG_RETRY_LIMIT = (1<<10),
254 IEEE80211_TXCTL_EAPOL_FRAME = (1<<11),
255 IEEE80211_TXCTL_SEND_AFTER_DTIM = (1<<12),
256 IEEE80211_TXCTL_AMPDU = (1<<13),
257 IEEE80211_TXCTL_OFDM_HT = (1<<14),
258 IEEE80211_TXCTL_GREEN_FIELD = (1<<15),
259 IEEE80211_TXCTL_40_MHZ_WIDTH = (1<<16),
260 IEEE80211_TXCTL_DUP_DATA = (1<<17),
261 IEEE80211_TXCTL_SHORT_GI = (1<<18),
262};
263
Jiri Bencf0706e82007-05-05 11:45:53 -0700264/* Transmit control fields. This data structure is passed to low-level driver
265 * with each TX frame. The low-level driver is responsible for configuring
266 * the hardware to use given values (depending on what is supported). */
Jiri Bencf0706e82007-05-05 11:45:53 -0700267
268struct ieee80211_tx_control {
Johannes Berg32bfd352007-12-19 01:31:26 +0100269 struct ieee80211_vif *vif;
Johannes Berg8318d782008-01-24 19:38:38 +0100270 struct ieee80211_rate *tx_rate;
271
272 /* Transmit rate for RTS/CTS frame */
273 struct ieee80211_rate *rts_cts_rate;
274
275 /* retry rate for the last retries */
276 struct ieee80211_rate *alt_retry_rate;
Jiri Bencf0706e82007-05-05 11:45:53 -0700277
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800278 u32 flags; /* tx control flags defined above */
Johannes Berg6a7664d2007-09-14 11:10:25 -0400279 u8 key_idx; /* keyidx from hw->set_key(), undefined if
280 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */
Ivo van Doornd5d08de2007-07-27 15:43:23 +0200281 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, ..
282 * This could be used when set_retry_limit
283 * is not implemented by the driver */
Ron Rindjunsky11f4b1c2008-03-04 18:09:26 -0800284 u8 antenna_sel_tx; /* 0 = default/diversity, otherwise bit
285 * position represents antenna number used */
Jiri Bencf0706e82007-05-05 11:45:53 -0700286 u8 icv_len; /* length of the ICV/MIC field in octets */
287 u8 iv_len; /* length of the IV field in octets */
Jiri Bencf0706e82007-05-05 11:45:53 -0700288 u8 queue; /* hardware queue to use for this frame;
289 * 0 = highest, hw->queues-1 = lowest */
Jiri Bencf0706e82007-05-05 11:45:53 -0700290 int type; /* internal */
Jiri Bencf0706e82007-05-05 11:45:53 -0700291};
292
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400293
294/**
295 * enum mac80211_rx_flags - receive flags
296 *
297 * These flags are used with the @flag member of &struct ieee80211_rx_status.
298 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
299 * Use together with %RX_FLAG_MMIC_STRIPPED.
300 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
301 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
302 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
303 * verification has been done by the hardware.
304 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
305 * If this flag is set, the stack cannot do any replay detection
306 * hence the driver or hardware will have to do that.
Johannes Berg72abd812007-09-17 01:29:22 -0400307 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
308 * the frame.
309 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
310 * the frame.
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100311 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
Bruno Randolf9d9bf772008-02-18 11:21:36 +0900312 * is valid. This is useful in monitor mode and necessary for beacon frames
313 * to enable IBSS merging.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400314 */
315enum mac80211_rx_flags {
316 RX_FLAG_MMIC_ERROR = 1<<0,
317 RX_FLAG_DECRYPTED = 1<<1,
318 RX_FLAG_RADIOTAP = 1<<2,
319 RX_FLAG_MMIC_STRIPPED = 1<<3,
320 RX_FLAG_IV_STRIPPED = 1<<4,
Johannes Berg72abd812007-09-17 01:29:22 -0400321 RX_FLAG_FAILED_FCS_CRC = 1<<5,
322 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
Johannes Bergc49e5ea2007-12-11 21:33:42 +0100323 RX_FLAG_TSFT = 1<<7,
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400324};
325
326/**
327 * struct ieee80211_rx_status - receive status
328 *
329 * The low-level driver should provide this information (the subset
330 * supported by hardware) to the 802.11 code with each received
331 * frame.
Bruno Randolfc132bec2008-02-18 11:20:51 +0900332 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
333 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
Johannes Berg8318d782008-01-24 19:38:38 +0100334 * @band: the active band when this frame was received
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400335 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400336 * @ssi: signal strength when receiving this frame
337 * @signal: used as 'qual' in statistics reporting
338 * @noise: PHY noise when receiving this frame
339 * @antenna: antenna used
Johannes Berg8318d782008-01-24 19:38:38 +0100340 * @rate_idx: index of data rate into band's supported rates
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400341 * @flag: %RX_FLAG_*
342 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700343struct ieee80211_rx_status {
344 u64 mactime;
Johannes Berg8318d782008-01-24 19:38:38 +0100345 enum ieee80211_band band;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400346 int freq;
Jiri Bencf0706e82007-05-05 11:45:53 -0700347 int ssi;
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400348 int signal;
Jiri Bencf0706e82007-05-05 11:45:53 -0700349 int noise;
350 int antenna;
Johannes Berg8318d782008-01-24 19:38:38 +0100351 int rate_idx;
Jiri Bencf0706e82007-05-05 11:45:53 -0700352 int flag;
353};
354
Johannes Berg6b301cd2007-09-18 17:29:20 -0400355/**
356 * enum ieee80211_tx_status_flags - transmit status flags
357 *
358 * Status flags to indicate various transmit conditions.
359 *
360 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted
361 * because the destination STA was in powersave mode.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400362 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged
Ron Rindjunsky483fdcec2008-01-28 14:07:21 +0200363 * @IEEE80211_TX_STATUS_AMPDU: The frame was aggregated, so status
364 * is for the whole aggregation.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400365 */
366enum ieee80211_tx_status_flags {
367 IEEE80211_TX_STATUS_TX_FILTERED = 1<<0,
368 IEEE80211_TX_STATUS_ACK = 1<<1,
Ron Rindjunsky483fdcec2008-01-28 14:07:21 +0200369 IEEE80211_TX_STATUS_AMPDU = 1<<2,
Johannes Berg6b301cd2007-09-18 17:29:20 -0400370};
371
372/**
373 * struct ieee80211_tx_status - transmit status
374 *
375 * As much information as possible should be provided for each transmitted
376 * frame with ieee80211_tx_status().
377 *
378 * @control: a copy of the &struct ieee80211_tx_control passed to the driver
379 * in the tx() callback.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400380 * @flags: transmit status flags, defined above
Ron Rindjunsky483fdcec2008-01-28 14:07:21 +0200381 * @retry_count: number of retries
Johannes Berg6b301cd2007-09-18 17:29:20 -0400382 * @excessive_retries: set to 1 if the frame was retried many times
383 * but not acknowledged
Ron Rindjunsky483fdcec2008-01-28 14:07:21 +0200384 * @ampdu_ack_len: number of aggregated frames.
385 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
386 * @ampdu_ack_map: block ack bit map for the aggregation.
387 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
388 * @ack_signal: signal strength of the ACK frame
Johannes Berg6b301cd2007-09-18 17:29:20 -0400389 * @queue_length: ?? REMOVE
390 * @queue_number: ?? REMOVE
391 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700392struct ieee80211_tx_status {
Jiri Bencf0706e82007-05-05 11:45:53 -0700393 struct ieee80211_tx_control control;
Johannes Berg6b301cd2007-09-18 17:29:20 -0400394 u8 flags;
Johannes Berg6b301cd2007-09-18 17:29:20 -0400395 u8 retry_count;
Ron Rindjunsky483fdcec2008-01-28 14:07:21 +0200396 bool excessive_retries;
397 u8 ampdu_ack_len;
398 u64 ampdu_ack_map;
Johannes Berg6b301cd2007-09-18 17:29:20 -0400399 int ack_signal;
400 int queue_length;
Jiri Bencf0706e82007-05-05 11:45:53 -0700401 int queue_number;
402};
403
Johannes Berg6b301cd2007-09-18 17:29:20 -0400404/**
405 * enum ieee80211_conf_flags - configuration flags
406 *
407 * Flags to define PHY configuration options
408 *
409 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
410 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200411 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
Johannes Berg6b301cd2007-09-18 17:29:20 -0400412 */
413enum ieee80211_conf_flags {
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200414 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
415 IEEE80211_CONF_RADIOTAP = (1<<1),
416 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
Johannes Berg6b301cd2007-09-18 17:29:20 -0400417};
Jiri Bencf0706e82007-05-05 11:45:53 -0700418
419/**
420 * struct ieee80211_conf - configuration of the device
421 *
422 * This struct indicates how the driver shall configure the hardware.
423 *
424 * @radio_enabled: when zero, driver is required to switch off the radio.
Johannes Berg6b301cd2007-09-18 17:29:20 -0400425 * TODO make a flag
Johannes Berg6b301cd2007-09-18 17:29:20 -0400426 * @beacon_int: beacon interval (TODO make interface config)
427 * @flags: configuration flags defined above
Johannes Berg8318d782008-01-24 19:38:38 +0100428 * @power_level: requested transmit power (in dBm)
429 * @max_antenna_gain: maximum antenna gain (in dBi)
Johannes Berg6b301cd2007-09-18 17:29:20 -0400430 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
431 * 1/2: antenna 0/1
432 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200433 * @ht_conf: describes current self configuration of 802.11n HT capabilies
434 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
Johannes Berg8318d782008-01-24 19:38:38 +0100435 * @channel: the channel to tune to
Jiri Bencf0706e82007-05-05 11:45:53 -0700436 */
437struct ieee80211_conf {
Jiri Bencf0706e82007-05-05 11:45:53 -0700438 int radio_enabled;
439
440 int beacon_int;
Johannes Berg6b301cd2007-09-18 17:29:20 -0400441 u32 flags;
Johannes Berg8318d782008-01-24 19:38:38 +0100442 int power_level;
443 int max_antenna_gain;
Jiri Bencf0706e82007-05-05 11:45:53 -0700444 u8 antenna_sel_tx;
445 u8 antenna_sel_rx;
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200446
Johannes Berg8318d782008-01-24 19:38:38 +0100447 struct ieee80211_channel *channel;
448
Ron Rindjunsky10816d42007-11-26 16:14:30 +0200449 struct ieee80211_ht_info ht_conf;
450 struct ieee80211_ht_bss_info ht_bss_conf;
Jiri Bencf0706e82007-05-05 11:45:53 -0700451};
452
453/**
454 * enum ieee80211_if_types - types of 802.11 network interfaces
455 *
Johannes Berga2897552007-09-28 14:01:25 +0200456 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
457 * by mac80211 itself
Jiri Bencf0706e82007-05-05 11:45:53 -0700458 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
459 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
460 * daemon. Drivers should never see this type.
461 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
462 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
463 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
464 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400465 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
466 * will never see this type.
Johannes Bergdbbea672008-02-26 14:34:06 +0100467 * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
Jiri Bencf0706e82007-05-05 11:45:53 -0700468 */
469enum ieee80211_if_types {
Johannes Berga2897552007-09-28 14:01:25 +0200470 IEEE80211_IF_TYPE_INVALID,
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400471 IEEE80211_IF_TYPE_AP,
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400472 IEEE80211_IF_TYPE_STA,
473 IEEE80211_IF_TYPE_IBSS,
Johannes Berg6032f932008-02-23 15:17:07 +0100474 IEEE80211_IF_TYPE_MESH_POINT,
Johannes Berg0ec3ca42007-09-17 01:29:24 -0400475 IEEE80211_IF_TYPE_MNTR,
476 IEEE80211_IF_TYPE_WDS,
477 IEEE80211_IF_TYPE_VLAN,
Jiri Bencf0706e82007-05-05 11:45:53 -0700478};
479
480/**
Johannes Berg32bfd352007-12-19 01:31:26 +0100481 * struct ieee80211_vif - per-interface data
482 *
483 * Data in this structure is continually present for driver
484 * use during the life of a virtual interface.
485 *
Johannes Berg51fb61e2007-12-19 01:31:27 +0100486 * @type: type of this virtual interface
Johannes Berg32bfd352007-12-19 01:31:26 +0100487 * @drv_priv: data area for driver use, will always be aligned to
488 * sizeof(void *).
489 */
490struct ieee80211_vif {
Johannes Berg51fb61e2007-12-19 01:31:27 +0100491 enum ieee80211_if_types type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100492 /* must be last */
493 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
494};
495
Johannes Berg902acc72008-02-23 15:17:19 +0100496static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
497{
498#ifdef CONFIG_MAC80211_MESH
499 return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
500#endif
501 return false;
502}
503
Johannes Berg32bfd352007-12-19 01:31:26 +0100504/**
Jiri Bencf0706e82007-05-05 11:45:53 -0700505 * struct ieee80211_if_init_conf - initial configuration of an interface
506 *
Johannes Berg32bfd352007-12-19 01:31:26 +0100507 * @vif: pointer to a driver-use per-interface structure. The pointer
508 * itself is also used for various functions including
509 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
Jiri Bencf0706e82007-05-05 11:45:53 -0700510 * @type: one of &enum ieee80211_if_types constants. Determines the type of
511 * added/removed interface.
512 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
513 * until the interface is removed (i.e. it cannot be used after
514 * remove_interface() callback was called for this interface).
515 *
516 * This structure is used in add_interface() and remove_interface()
517 * callbacks of &struct ieee80211_hw.
Johannes Berg4480f15c2007-07-10 19:32:10 +0200518 *
519 * When you allow multiple interfaces to be added to your PHY, take care
520 * that the hardware can actually handle multiple MAC addresses. However,
521 * also take care that when there's no interface left with mac_addr != %NULL
522 * you remove the MAC address from the device to avoid acknowledging packets
523 * in pure monitor mode.
Jiri Bencf0706e82007-05-05 11:45:53 -0700524 */
525struct ieee80211_if_init_conf {
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400526 enum ieee80211_if_types type;
Johannes Berg32bfd352007-12-19 01:31:26 +0100527 struct ieee80211_vif *vif;
Jiri Bencf0706e82007-05-05 11:45:53 -0700528 void *mac_addr;
529};
530
531/**
532 * struct ieee80211_if_conf - configuration of an interface
533 *
534 * @type: type of the interface. This is always the same as was specified in
535 * &struct ieee80211_if_init_conf. The type of an interface never changes
536 * during the life of the interface; this field is present only for
537 * convenience.
538 * @bssid: BSSID of the network we are associated to/creating.
539 * @ssid: used (together with @ssid_len) by drivers for hardware that
540 * generate beacons independently. The pointer is valid only during the
541 * config_interface() call, so copy the value somewhere if you need
542 * it.
543 * @ssid_len: length of the @ssid field.
Jiri Bencf0706e82007-05-05 11:45:53 -0700544 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
545 * &struct ieee80211_hw is set. The driver is responsible of freeing
546 * the sk_buff.
547 * @beacon_control: tx_control for the beacon template, this field is only
548 * valid when the @beacon field was set.
549 *
550 * This structure is passed to the config_interface() callback of
551 * &struct ieee80211_hw.
552 */
553struct ieee80211_if_conf {
554 int type;
555 u8 *bssid;
556 u8 *ssid;
557 size_t ssid_len;
Jiri Bencf0706e82007-05-05 11:45:53 -0700558 struct sk_buff *beacon;
559 struct ieee80211_tx_control *beacon_control;
560};
561
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400562/**
563 * enum ieee80211_key_alg - key algorithm
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400564 * @ALG_WEP: WEP40 or WEP104
565 * @ALG_TKIP: TKIP
566 * @ALG_CCMP: CCMP (AES)
567 */
Johannes Bergea49c352007-09-18 17:29:21 -0400568enum ieee80211_key_alg {
Johannes Berg8f20fc22007-08-28 17:01:54 -0400569 ALG_WEP,
570 ALG_TKIP,
571 ALG_CCMP,
Johannes Bergea49c352007-09-18 17:29:21 -0400572};
Jiri Bencf0706e82007-05-05 11:45:53 -0700573
Johannes Berg11a843b2007-08-28 17:01:55 -0400574
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400575/**
576 * enum ieee80211_key_flags - key flags
577 *
578 * These flags are used for communication about keys between the driver
579 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
580 *
581 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
582 * that the STA this key will be used with could be using QoS.
583 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
584 * driver to indicate that it requires IV generation for this
585 * particular key.
586 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
587 * the driver for a TKIP key if it requires Michael MIC
588 * generation in software.
589 */
590enum ieee80211_key_flags {
591 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
592 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
593 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
594};
595
596/**
597 * struct ieee80211_key_conf - key information
598 *
599 * This key information is given by mac80211 to the driver by
600 * the set_key() callback in &struct ieee80211_ops.
601 *
602 * @hw_key_idx: To be set by the driver, this is the key index the driver
603 * wants to be given when a frame is transmitted and needs to be
Johannes Berg6a7664d2007-09-14 11:10:25 -0400604 * encrypted in hardware.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400605 * @alg: The key algorithm.
606 * @flags: key flags, see &enum ieee80211_key_flags.
607 * @keyidx: the key index (0-3)
608 * @keylen: key material length
609 * @key: key material
610 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700611struct ieee80211_key_conf {
Johannes Bergea49c352007-09-18 17:29:21 -0400612 enum ieee80211_key_alg alg;
Johannes Berg6a7664d2007-09-14 11:10:25 -0400613 u8 hw_key_idx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400614 u8 flags;
Johannes Berg11a843b2007-08-28 17:01:55 -0400615 s8 keyidx;
Johannes Berg11a843b2007-08-28 17:01:55 -0400616 u8 keylen;
Jiri Bencf0706e82007-05-05 11:45:53 -0700617 u8 key[0];
618};
619
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400620/**
621 * enum set_key_cmd - key command
622 *
623 * Used with the set_key() callback in &struct ieee80211_ops, this
624 * indicates whether a key is being removed or added.
625 *
626 * @SET_KEY: a key is set
627 * @DISABLE_KEY: a key must be disabled
628 */
Johannes Bergea49c352007-09-18 17:29:21 -0400629enum set_key_cmd {
Johannes Berg11a843b2007-08-28 17:01:55 -0400630 SET_KEY, DISABLE_KEY,
Johannes Bergea49c352007-09-18 17:29:21 -0400631};
Jiri Bencf0706e82007-05-05 11:45:53 -0700632
Tomas Winkler478f8d22007-09-30 13:52:37 +0200633/**
634 * enum sta_notify_cmd - sta notify command
635 *
636 * Used with the sta_notify() callback in &struct ieee80211_ops, this
637 * indicates addition and removal of a station to station table
638 *
639 * @STA_NOTIFY_ADD: a station was added to the station table
640 * @STA_NOTIFY_REMOVE: a station being removed from the station table
641 */
642enum sta_notify_cmd {
643 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
644};
Johannes Berg1bc08262007-09-18 17:29:15 -0400645
646/**
647 * enum ieee80211_hw_flags - hardware flags
648 *
649 * These flags are used to indicate hardware capabilities to
650 * the stack. Generally, flags here should have their meaning
651 * done in a way that the simplest hardware doesn't need setting
652 * any particular flags. There are some exceptions to this rule,
653 * however, so you are advised to review these flags carefully.
654 *
655 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
656 * The device only needs to be supplied with a beacon template.
657 * If you need the host to generate each beacon then don't use
658 * this flag and call ieee80211_beacon_get() when you need the
659 * next beacon frame. Note that if you set this flag, you must
660 * implement the set_tim() callback for powersave mode to work
661 * properly.
662 * This flag is only relevant for access-point mode.
663 *
664 * @IEEE80211_HW_RX_INCLUDES_FCS:
665 * Indicates that received frames passed to the stack include
666 * the FCS at the end.
667 *
668 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
669 * Some wireless LAN chipsets buffer broadcast/multicast frames
670 * for power saving stations in the hardware/firmware and others
671 * rely on the host system for such buffering. This option is used
672 * to configure the IEEE 802.11 upper layer to buffer broadcast and
673 * multicast frames when there are power saving stations so that
674 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
675 * that not setting this flag works properly only when the
676 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
677 * otherwise the stack will not know when the DTIM beacon was sent.
678 *
Johannes Berg8318d782008-01-24 19:38:38 +0100679 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
680 * Hardware is not capable of short slot operation on the 2.4 GHz band.
681 *
682 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
683 * Hardware is not capable of receiving frames with short preamble on
684 * the 2.4 GHz band.
Johannes Berg1bc08262007-09-18 17:29:15 -0400685 */
686enum ieee80211_hw_flags {
687 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0,
688 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
689 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
Johannes Berg8318d782008-01-24 19:38:38 +0100690 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
691 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
Johannes Berg1bc08262007-09-18 17:29:15 -0400692};
693
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400694/**
695 * struct ieee80211_hw - hardware information and state
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400696 *
697 * This structure contains the configuration and hardware
698 * information for an 802.11 PHY.
699 *
700 * @wiphy: This points to the &struct wiphy allocated for this
701 * 802.11 PHY. You must fill in the @perm_addr and @dev
702 * members of this structure using SET_IEEE80211_DEV()
Johannes Berg8318d782008-01-24 19:38:38 +0100703 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
704 * bands (with channels, bitrates) are registered here.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400705 *
706 * @conf: &struct ieee80211_conf, device configuration, don't use.
707 *
708 * @workqueue: single threaded workqueue available for driver use,
709 * allocated by mac80211 on registration and flushed on
710 * unregistration.
711 *
712 * @priv: pointer to private area that was allocated for driver use
713 * along with this structure.
714 *
715 * @flags: hardware flags, see &enum ieee80211_hw_flags.
716 *
717 * @extra_tx_headroom: headroom to reserve in each transmit skb
718 * for use by the driver (e.g. for transmit headers.)
719 *
720 * @channel_change_time: time (in microseconds) it takes to change channels.
721 *
722 * @max_rssi: Maximum value for ssi in RX information, use
723 * negative numbers for dBm and 0 to indicate no support.
724 *
725 * @max_signal: like @max_rssi, but for the signal value.
726 *
727 * @max_noise: like @max_rssi, but for the noise value.
728 *
729 * @queues: number of available hardware transmit queues for
730 * data packets. WMM/QoS requires at least four.
Johannes Berg830f9032007-10-28 14:51:05 +0100731 *
732 * @rate_control_algorithm: rate control algorithm for this hardware.
733 * If unset (NULL), the default algorithm will be used. Must be
734 * set before calling ieee80211_register_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +0100735 *
736 * @vif_data_size: size (in bytes) of the drv_priv data area
737 * within &struct ieee80211_vif.
Johannes Berg7ac1bd62007-09-14 11:10:25 -0400738 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700739struct ieee80211_hw {
Jiri Bencf0706e82007-05-05 11:45:53 -0700740 struct ieee80211_conf conf;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400741 struct wiphy *wiphy;
Jiri Bencf0706e82007-05-05 11:45:53 -0700742 struct workqueue_struct *workqueue;
Johannes Berg830f9032007-10-28 14:51:05 +0100743 const char *rate_control_algorithm;
Jiri Bencf0706e82007-05-05 11:45:53 -0700744 void *priv;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400745 u32 flags;
Jiri Bencf0706e82007-05-05 11:45:53 -0700746 unsigned int extra_tx_headroom;
Jiri Bencf0706e82007-05-05 11:45:53 -0700747 int channel_change_time;
Johannes Berg32bfd352007-12-19 01:31:26 +0100748 int vif_data_size;
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400749 u8 queues;
Jiri Bencf0706e82007-05-05 11:45:53 -0700750 s8 max_rssi;
751 s8 max_signal;
752 s8 max_noise;
Jiri Bencf0706e82007-05-05 11:45:53 -0700753};
754
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400755/**
756 * SET_IEEE80211_DEV - set device for 802.11 hardware
757 *
758 * @hw: the &struct ieee80211_hw to set the device for
759 * @dev: the &struct device of this 802.11 device
760 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700761static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
762{
763 set_wiphy_dev(hw->wiphy, dev);
764}
765
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400766/**
767 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
768 *
769 * @hw: the &struct ieee80211_hw to set the MAC address for
770 * @addr: the address to set
771 */
Jiri Bencf0706e82007-05-05 11:45:53 -0700772static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
773{
774 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
775}
776
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400777/**
778 * DOC: Hardware crypto acceleration
Johannes Berg4150c572007-09-17 01:29:23 -0400779 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400780 * mac80211 is capable of taking advantage of many hardware
781 * acceleration designs for encryption and decryption operations.
782 *
783 * The set_key() callback in the &struct ieee80211_ops for a given
784 * device is called to enable hardware acceleration of encryption and
785 * decryption. The callback takes an @address parameter that will be
786 * the broadcast address for default keys, the other station's hardware
787 * address for individual keys or the zero address for keys that will
788 * be used only for transmission.
789 * Multiple transmission keys with the same key index may be used when
790 * VLANs are configured for an access point.
791 *
792 * The @local_address parameter will always be set to our own address,
793 * this is only relevant if you support multiple local addresses.
794 *
795 * When transmitting, the TX control data will use the @hw_key_idx
796 * selected by the driver by modifying the &struct ieee80211_key_conf
797 * pointed to by the @key parameter to the set_key() function.
798 *
799 * The set_key() call for the %SET_KEY command should return 0 if
800 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
801 * added; if you return 0 then hw_key_idx must be assigned to the
802 * hardware key index, you are free to use the full u8 range.
803 *
804 * When the cmd is %DISABLE_KEY then it must succeed.
805 *
806 * Note that it is permissible to not decrypt a frame even if a key
807 * for it has been uploaded to hardware, the stack will not make any
808 * decision based on whether a key has been uploaded or not but rather
809 * based on the receive flags.
810 *
811 * The &struct ieee80211_key_conf structure pointed to by the @key
812 * parameter is guaranteed to be valid until another call to set_key()
813 * removes it, but it can only be used as a cookie to differentiate
814 * keys.
Johannes Berg4150c572007-09-17 01:29:23 -0400815 */
Johannes Berg4150c572007-09-17 01:29:23 -0400816
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400817/**
818 * DOC: Frame filtering
819 *
820 * mac80211 requires to see many management frames for proper
821 * operation, and users may want to see many more frames when
822 * in monitor mode. However, for best CPU usage and power consumption,
823 * having as few frames as possible percolate through the stack is
824 * desirable. Hence, the hardware should filter as much as possible.
825 *
826 * To achieve this, mac80211 uses filter flags (see below) to tell
827 * the driver's configure_filter() function which frames should be
828 * passed to mac80211 and which should be filtered out.
829 *
830 * The configure_filter() callback is invoked with the parameters
831 * @mc_count and @mc_list for the combined multicast address list
832 * of all virtual interfaces, @changed_flags telling which flags
833 * were changed and @total_flags with the new flag states.
834 *
835 * If your device has no multicast address filters your driver will
836 * need to check both the %FIF_ALLMULTI flag and the @mc_count
837 * parameter to see whether multicast frames should be accepted
838 * or dropped.
839 *
Michael Bueschd0f5afb2008-02-12 20:12:45 +0100840 * All unsupported flags in @total_flags must be cleared.
841 * Hardware does not support a flag if it is incapable of _passing_
842 * the frame to the stack. Otherwise the driver must ignore
843 * the flag, but not clear it.
844 * You must _only_ clear the flag (announce no support for the
845 * flag to mac80211) if you are not able to pass the packet type
846 * to the stack (so the hardware always filters it).
847 * So for example, you should clear @FIF_CONTROL, if your hardware
848 * always filters control frames. If your hardware always passes
849 * control frames to the kernel and is incapable of filtering them,
850 * you do _not_ clear the @FIF_CONTROL flag.
851 * This rule applies to all other FIF flags as well.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400852 */
853
854/**
855 * enum ieee80211_filter_flags - hardware filter flags
856 *
857 * These flags determine what the filter in hardware should be
858 * programmed to let through and what should not be passed to the
859 * stack. It is always safe to pass more frames than requested,
860 * but this has negative impact on power consumption.
861 *
862 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
863 * think of the BSS as your network segment and then this corresponds
864 * to the regular ethernet device promiscuous mode.
865 *
866 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
867 * by the user or if the hardware is not capable of filtering by
868 * multicast address.
869 *
870 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
871 * %RX_FLAG_FAILED_FCS_CRC for them)
872 *
873 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
874 * the %RX_FLAG_FAILED_PLCP_CRC for them
875 *
876 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
877 * to the hardware that it should not filter beacons or probe responses
878 * by BSSID. Filtering them can greatly reduce the amount of processing
879 * mac80211 needs to do and the amount of CPU wakeups, so you should
880 * honour this flag if possible.
881 *
882 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
883 * only those addressed to this station
884 *
885 * @FIF_OTHER_BSS: pass frames destined to other BSSes
886 */
887enum ieee80211_filter_flags {
888 FIF_PROMISC_IN_BSS = 1<<0,
889 FIF_ALLMULTI = 1<<1,
890 FIF_FCSFAIL = 1<<2,
891 FIF_PLCPFAIL = 1<<3,
892 FIF_BCN_PRBRESP_PROMISC = 1<<4,
893 FIF_CONTROL = 1<<5,
894 FIF_OTHER_BSS = 1<<6,
895};
896
897/**
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +0200898 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
899 *
900 * These flags are used with the ampdu_action() callback in
901 * &struct ieee80211_ops to indicate which action is needed.
902 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
903 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +0200904 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
905 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +0200906 */
907enum ieee80211_ampdu_mlme_action {
908 IEEE80211_AMPDU_RX_START,
909 IEEE80211_AMPDU_RX_STOP,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +0200910 IEEE80211_AMPDU_TX_START,
911 IEEE80211_AMPDU_TX_STOP,
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +0200912};
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400913
914/**
915 * struct ieee80211_ops - callbacks from mac80211 to the driver
916 *
917 * This structure contains various callbacks that the driver may
918 * handle or, in some cases, must handle, for example to configure
919 * the hardware to a new channel or to transmit a frame.
920 *
921 * @tx: Handler that 802.11 module calls for each transmitted frame.
922 * skb contains the buffer starting from the IEEE 802.11 header.
923 * The low-level driver should send the frame out based on
924 * configuration in the TX control data. Must be implemented and
925 * atomic.
926 *
927 * @start: Called before the first netdevice attached to the hardware
928 * is enabled. This should turn on the hardware and must turn on
929 * frame reception (for possibly enabled monitor interfaces.)
930 * Returns negative error codes, these may be seen in userspace,
931 * or zero.
932 * When the device is started it should not have a MAC address
933 * to avoid acknowledging frames before a non-monitor device
934 * is added.
935 * Must be implemented.
936 *
937 * @stop: Called after last netdevice attached to the hardware
938 * is disabled. This should turn off the hardware (at least
939 * it must turn off frame reception.)
940 * May be called right after add_interface if that rejects
941 * an interface.
942 * Must be implemented.
943 *
944 * @add_interface: Called when a netdevice attached to the hardware is
945 * enabled. Because it is not called for monitor mode devices, @open
946 * and @stop must be implemented.
947 * The driver should perform any initialization it needs before
948 * the device can be enabled. The initial configuration for the
949 * interface is given in the conf parameter.
950 * The callback may refuse to add an interface by returning a
951 * negative error code (which will be seen in userspace.)
952 * Must be implemented.
953 *
954 * @remove_interface: Notifies a driver that an interface is going down.
955 * The @stop callback is called after this if it is the last interface
956 * and no monitor interfaces are present.
957 * When all interfaces are removed, the MAC address in the hardware
958 * must be cleared so the device no longer acknowledges packets,
959 * the mac_addr member of the conf structure is, however, set to the
960 * MAC address of the device going away.
961 * Hence, this callback must be implemented.
962 *
963 * @config: Handler for configuration requests. IEEE 802.11 code calls this
964 * function to change hardware configuration, e.g., channel.
965 *
966 * @config_interface: Handler for configuration requests related to interfaces
967 * (e.g. BSSID changes.)
968 *
Johannes Berg471b3ef2007-12-28 14:32:58 +0100969 * @bss_info_changed: Handler for configuration requests related to BSS
970 * parameters that may vary during BSS's lifespan, and may affect low
971 * level driver (e.g. assoc/disassoc status, erp parameters).
972 * This function should not be used if no BSS has been set, unless
973 * for association indication. The @changed parameter indicates which
974 * of the bss parameters has changed when a call is made. This callback
975 * has to be atomic.
976 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400977 * @configure_filter: Configure the device's RX filter.
978 * See the section "Frame filtering" for more information.
979 * This callback must be implemented and atomic.
980 *
981 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
982 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
983 * mac80211 calls this function when a TIM bit must be set or cleared
984 * for a given AID. Must be atomic.
985 *
986 * @set_key: See the section "Hardware crypto acceleration"
987 * This callback can sleep, and is only called between add_interface
988 * and remove_interface calls, i.e. while the interface with the
989 * given local_address is enabled.
990 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400991 * @hw_scan: Ask the hardware to service the scan request, no need to start
Johannes Berg8318d782008-01-24 19:38:38 +0100992 * the scan state machine in stack. The scan must honour the channel
993 * configuration done by the regulatory agent in the wiphy's registered
994 * bands.
Johannes Berg75a5f0c2007-09-18 17:29:20 -0400995 *
996 * @get_stats: return low-level statistics
997 *
Johannes Berg62da92f2007-12-19 02:03:31 +0100998 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
999 * callback should be provided to read the TKIP transmit IVs (both IV32
1000 * and IV16) for the given key from hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001001 *
1002 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1003 *
1004 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1005 * the device does fragmentation by itself; if this method is assigned then
1006 * the stack will not do fragmentation.
1007 *
1008 * @set_retry_limit: Configuration of retry limits (if device needs it)
1009 *
Tomas Winkler478f8d22007-09-30 13:52:37 +02001010 * @sta_notify: Notifies low level driver about addition or removal
1011 * of assocaited station or AP.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001012 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001013 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1014 * bursting) for a hardware TX queue. The @queue parameter uses the
1015 * %IEEE80211_TX_QUEUE_* constants. Must be atomic.
1016 *
1017 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1018 * to get number of currently queued packets (queue length), maximum queue
1019 * size (limit), and total number of packets sent using each TX queue
1020 * (count). This information is used for WMM to find out which TX
1021 * queues have room for more packets and by hostapd to provide
1022 * statistics about the current queueing state to external programs.
1023 *
1024 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1025 * this is only used for IBSS mode debugging and, as such, is not a
1026 * required function. Must be atomic.
1027 *
1028 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1029 * with other STAs in the IBSS. This is only used in IBSS mode. This
1030 * function is optional if the firmware/hardware takes full care of
1031 * TSF synchronization.
1032 *
1033 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
1034 * IBSS uses a fixed beacon frame which is configured using this
Michael Buesch5ecc2a52007-10-02 12:17:56 +02001035 * function.
1036 * If the driver returns success (0) from this callback, it owns
1037 * the skb. That means the driver is responsible to kfree_skb() it.
1038 * The control structure is not dynamically allocated. That means the
1039 * driver does not own the pointer and if it needs it somewhere
1040 * outside of the context of this function, it must copy it
1041 * somewhere else.
1042 * This handler is required only for IBSS mode.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001043 *
1044 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1045 * This is needed only for IBSS mode and the result of this function is
1046 * used to determine whether to reply to Probe Requests.
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001047 *
1048 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001049 *
1050 * @ampdu_action: Perform a certain A-MPDU action
1051 * The RA/TID combination determines the destination and TID we want
1052 * the ampdu action to be performed for. The action is defined through
1053 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001054 * is the first frame we expect to perform the action on. notice
1055 * that TX/RX_STOP can pass NULL for this parameter.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001056 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001057struct ieee80211_ops {
Jiri Bencf0706e82007-05-05 11:45:53 -07001058 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
1059 struct ieee80211_tx_control *control);
Johannes Berg4150c572007-09-17 01:29:23 -04001060 int (*start)(struct ieee80211_hw *hw);
Johannes Berg4150c572007-09-17 01:29:23 -04001061 void (*stop)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001062 int (*add_interface)(struct ieee80211_hw *hw,
1063 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001064 void (*remove_interface)(struct ieee80211_hw *hw,
1065 struct ieee80211_if_init_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001066 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
Jiri Bencf0706e82007-05-05 11:45:53 -07001067 int (*config_interface)(struct ieee80211_hw *hw,
Johannes Berg32bfd352007-12-19 01:31:26 +01001068 struct ieee80211_vif *vif,
1069 struct ieee80211_if_conf *conf);
Johannes Berg471b3ef2007-12-28 14:32:58 +01001070 void (*bss_info_changed)(struct ieee80211_hw *hw,
1071 struct ieee80211_vif *vif,
1072 struct ieee80211_bss_conf *info,
1073 u32 changed);
Johannes Berg4150c572007-09-17 01:29:23 -04001074 void (*configure_filter)(struct ieee80211_hw *hw,
1075 unsigned int changed_flags,
1076 unsigned int *total_flags,
1077 int mc_count, struct dev_addr_list *mc_list);
Jiri Bencf0706e82007-05-05 11:45:53 -07001078 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
Johannes Bergea49c352007-09-18 17:29:21 -04001079 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
Johannes Berg11a843b2007-08-28 17:01:55 -04001080 const u8 *local_address, const u8 *address,
1081 struct ieee80211_key_conf *key);
Jiri Bencf0706e82007-05-05 11:45:53 -07001082 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
Jiri Bencf0706e82007-05-05 11:45:53 -07001083 int (*get_stats)(struct ieee80211_hw *hw,
1084 struct ieee80211_low_level_stats *stats);
Johannes Berg62da92f2007-12-19 02:03:31 +01001085 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1086 u32 *iv32, u16 *iv16);
Jiri Bencf0706e82007-05-05 11:45:53 -07001087 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07001088 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
Jiri Bencf0706e82007-05-05 11:45:53 -07001089 int (*set_retry_limit)(struct ieee80211_hw *hw,
1090 u32 short_retry, u32 long_retr);
Johannes Berg32bfd352007-12-19 01:31:26 +01001091 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Tomas Winkler478f8d22007-09-30 13:52:37 +02001092 enum sta_notify_cmd, const u8 *addr);
Jiri Bencf0706e82007-05-05 11:45:53 -07001093 int (*conf_tx)(struct ieee80211_hw *hw, int queue,
1094 const struct ieee80211_tx_queue_params *params);
Jiri Bencf0706e82007-05-05 11:45:53 -07001095 int (*get_tx_stats)(struct ieee80211_hw *hw,
1096 struct ieee80211_tx_queue_stats *stats);
Jiri Bencf0706e82007-05-05 11:45:53 -07001097 u64 (*get_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001098 void (*reset_tsf)(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001099 int (*beacon_update)(struct ieee80211_hw *hw,
1100 struct sk_buff *skb,
1101 struct ieee80211_tx_control *control);
Jiri Bencf0706e82007-05-05 11:45:53 -07001102 int (*tx_last_beacon)(struct ieee80211_hw *hw);
Ron Rindjunskyd3c990f2007-11-26 16:14:34 +02001103 int (*conf_ht)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
Ron Rindjunsky1b7d03a2007-12-25 17:00:31 +02001104 int (*ampdu_action)(struct ieee80211_hw *hw,
1105 enum ieee80211_ampdu_mlme_action action,
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001106 const u8 *addr, u16 tid, u16 *ssn);
Jiri Bencf0706e82007-05-05 11:45:53 -07001107};
1108
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001109/**
1110 * ieee80211_alloc_hw - Allocate a new hardware device
1111 *
1112 * This must be called once for each hardware device. The returned pointer
1113 * must be used to refer to this device when calling other functions.
1114 * mac80211 allocates a private data area for the driver pointed to by
1115 * @priv in &struct ieee80211_hw, the size of this area is given as
1116 * @priv_data_len.
1117 *
1118 * @priv_data_len: length of private data
1119 * @ops: callbacks for this device
Jiri Bencf0706e82007-05-05 11:45:53 -07001120 */
1121struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1122 const struct ieee80211_ops *ops);
1123
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001124/**
1125 * ieee80211_register_hw - Register hardware device
1126 *
Johannes Bergdbbea672008-02-26 14:34:06 +01001127 * You must call this function before any other functions in
1128 * mac80211. Note that before a hardware can be registered, you
1129 * need to fill the contained wiphy's information.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001130 *
1131 * @hw: the device to register as returned by ieee80211_alloc_hw()
1132 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001133int ieee80211_register_hw(struct ieee80211_hw *hw);
1134
Jiri Bencf0706e82007-05-05 11:45:53 -07001135#ifdef CONFIG_MAC80211_LEDS
1136extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1137extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
Michael Buesch47f0c502007-09-27 15:10:44 +02001138extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001139extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
Jiri Bencf0706e82007-05-05 11:45:53 -07001140#endif
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001141/**
1142 * ieee80211_get_tx_led_name - get name of TX LED
1143 *
1144 * mac80211 creates a transmit LED trigger for each wireless hardware
1145 * that can be used to drive LEDs if your driver registers a LED device.
1146 * This function returns the name (or %NULL if not configured for LEDs)
1147 * of the trigger so you can automatically link the LED device.
1148 *
1149 * @hw: the hardware to get the LED trigger name for
1150 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001151static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1152{
1153#ifdef CONFIG_MAC80211_LEDS
1154 return __ieee80211_get_tx_led_name(hw);
1155#else
1156 return NULL;
1157#endif
1158}
1159
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001160/**
1161 * ieee80211_get_rx_led_name - get name of RX LED
1162 *
1163 * mac80211 creates a receive LED trigger for each wireless hardware
1164 * that can be used to drive LEDs if your driver registers a LED device.
1165 * This function returns the name (or %NULL if not configured for LEDs)
1166 * of the trigger so you can automatically link the LED device.
1167 *
1168 * @hw: the hardware to get the LED trigger name for
1169 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001170static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1171{
1172#ifdef CONFIG_MAC80211_LEDS
1173 return __ieee80211_get_rx_led_name(hw);
1174#else
1175 return NULL;
1176#endif
1177}
1178
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001179/**
1180 * ieee80211_get_assoc_led_name - get name of association LED
1181 *
1182 * mac80211 creates a association LED trigger for each wireless hardware
1183 * that can be used to drive LEDs if your driver registers a LED device.
1184 * This function returns the name (or %NULL if not configured for LEDs)
1185 * of the trigger so you can automatically link the LED device.
1186 *
1187 * @hw: the hardware to get the LED trigger name for
1188 */
Michael Buesch47f0c502007-09-27 15:10:44 +02001189static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1190{
1191#ifdef CONFIG_MAC80211_LEDS
1192 return __ieee80211_get_assoc_led_name(hw);
1193#else
1194 return NULL;
1195#endif
1196}
1197
Ivo van Doorncdcb0062008-01-07 19:45:24 +01001198/**
1199 * ieee80211_get_radio_led_name - get name of radio LED
1200 *
1201 * mac80211 creates a radio change LED trigger for each wireless hardware
1202 * that can be used to drive LEDs if your driver registers a LED device.
1203 * This function returns the name (or %NULL if not configured for LEDs)
1204 * of the trigger so you can automatically link the LED device.
1205 *
1206 * @hw: the hardware to get the LED trigger name for
1207 */
1208static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1209{
1210#ifdef CONFIG_MAC80211_LEDS
1211 return __ieee80211_get_radio_led_name(hw);
1212#else
1213 return NULL;
1214#endif
1215}
Michael Buesch47f0c502007-09-27 15:10:44 +02001216
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001217/**
1218 * ieee80211_unregister_hw - Unregister a hardware device
1219 *
1220 * This function instructs mac80211 to free allocated resources
1221 * and unregister netdevices from the networking subsystem.
1222 *
1223 * @hw: the hardware to unregister
1224 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001225void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1226
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001227/**
1228 * ieee80211_free_hw - free hardware descriptor
1229 *
1230 * This function frees everything that was allocated, including the
1231 * private data for the driver. You must call ieee80211_unregister_hw()
1232 * before calling this function
1233 *
1234 * @hw: the hardware to free
1235 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001236void ieee80211_free_hw(struct ieee80211_hw *hw);
1237
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001238/* trick to avoid symbol clashes with the ieee80211 subsystem */
Jiri Bencf0706e82007-05-05 11:45:53 -07001239void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1240 struct ieee80211_rx_status *status);
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001241
1242/**
1243 * ieee80211_rx - receive frame
1244 *
1245 * Use this function to hand received frames to mac80211. The receive
1246 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1247 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1248 *
Johannes Berg2485f712008-02-25 16:27:41 +01001249 * This function may not be called in IRQ context. Calls to this function
1250 * for a single hardware must be synchronized against each other. Calls
1251 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1252 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001253 *
1254 * @hw: the hardware this frame came in on
1255 * @skb: the buffer to receive, owned by mac80211 after this call
1256 * @status: status of this frame; the status pointer need not be valid
1257 * after this function returns
1258 */
1259static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1260 struct ieee80211_rx_status *status)
1261{
1262 __ieee80211_rx(hw, skb, status);
1263}
1264
1265/**
1266 * ieee80211_rx_irqsafe - receive frame
1267 *
1268 * Like ieee80211_rx() but can be called in IRQ context
Johannes Berg2485f712008-02-25 16:27:41 +01001269 * (internally defers to a tasklet.)
1270 *
1271 * Calls to this function and ieee80211_rx() may not be mixed for a
1272 * single hardware.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001273 *
1274 * @hw: the hardware this frame came in on
1275 * @skb: the buffer to receive, owned by mac80211 after this call
1276 * @status: status of this frame; the status pointer need not be valid
1277 * after this function returns and is not freed by mac80211,
1278 * it is recommended that it points to a stack area
1279 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001280void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1281 struct sk_buff *skb,
1282 struct ieee80211_rx_status *status);
1283
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001284/**
1285 * ieee80211_tx_status - transmit status callback
1286 *
1287 * Call this function for all transmitted frames after they have been
1288 * transmitted. It is permissible to not call this function for
1289 * multicast frames but this can affect statistics.
1290 *
Johannes Berg2485f712008-02-25 16:27:41 +01001291 * This function may not be called in IRQ context. Calls to this function
1292 * for a single hardware must be synchronized against each other. Calls
1293 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1294 * for a single hardware.
1295 *
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001296 * @hw: the hardware the frame was transmitted by
1297 * @skb: the frame that was transmitted, owned by mac80211 after this call
1298 * @status: status information for this frame; the status pointer need not
1299 * be valid after this function returns and is not freed by mac80211,
1300 * it is recommended that it points to a stack area
1301 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001302void ieee80211_tx_status(struct ieee80211_hw *hw,
1303 struct sk_buff *skb,
1304 struct ieee80211_tx_status *status);
Johannes Berg2485f712008-02-25 16:27:41 +01001305
1306/**
1307 * ieee80211_tx_status_irqsafe - irq-safe transmit status callback
1308 *
1309 * Like ieee80211_tx_status() but can be called in IRQ context
1310 * (internally defers to a tasklet.)
1311 *
1312 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1313 * single hardware.
1314 *
1315 * @hw: the hardware the frame was transmitted by
1316 * @skb: the frame that was transmitted, owned by mac80211 after this call
1317 * @status: status information for this frame; the status pointer need not
1318 * be valid after this function returns and is not freed by mac80211,
1319 * it is recommended that it points to a stack area
1320 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001321void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1322 struct sk_buff *skb,
1323 struct ieee80211_tx_status *status);
1324
1325/**
1326 * ieee80211_beacon_get - beacon generation function
1327 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001328 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001329 * @control: will be filled with information needed to send this beacon.
1330 *
1331 * If the beacon frames are generated by the host system (i.e., not in
1332 * hardware/firmware), the low-level driver uses this function to receive
1333 * the next beacon frame from the 802.11 code. The low-level is responsible
1334 * for calling this function before beacon data is needed (e.g., based on
1335 * hardware interrupt). Returned skb is used only once and low-level driver
1336 * is responsible of freeing it.
1337 */
1338struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
Johannes Berg32bfd352007-12-19 01:31:26 +01001339 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001340 struct ieee80211_tx_control *control);
1341
1342/**
1343 * ieee80211_rts_get - RTS frame generation function
1344 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001345 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001346 * @frame: pointer to the frame that is going to be protected by the RTS.
1347 * @frame_len: the frame length (in octets).
1348 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1349 * @rts: The buffer where to store the RTS frame.
1350 *
1351 * If the RTS frames are generated by the host system (i.e., not in
1352 * hardware/firmware), the low-level driver uses this function to receive
1353 * the next RTS frame from the 802.11 code. The low-level is responsible
1354 * for calling this function before and RTS frame is needed.
1355 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001356void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001357 const void *frame, size_t frame_len,
1358 const struct ieee80211_tx_control *frame_txctl,
1359 struct ieee80211_rts *rts);
1360
1361/**
1362 * ieee80211_rts_duration - Get the duration field for an RTS frame
1363 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001364 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001365 * @frame_len: the length of the frame that is going to be protected by the RTS.
1366 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1367 *
1368 * If the RTS is generated in firmware, but the host system must provide
1369 * the duration field, the low-level driver uses this function to receive
1370 * the duration field value in little-endian byteorder.
1371 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001372__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1373 struct ieee80211_vif *vif, size_t frame_len,
Jiri Bencf0706e82007-05-05 11:45:53 -07001374 const struct ieee80211_tx_control *frame_txctl);
1375
1376/**
1377 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1378 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001379 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001380 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1381 * @frame_len: the frame length (in octets).
1382 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1383 * @cts: The buffer where to store the CTS-to-self frame.
1384 *
1385 * If the CTS-to-self frames are generated by the host system (i.e., not in
1386 * hardware/firmware), the low-level driver uses this function to receive
1387 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1388 * for calling this function before and CTS-to-self frame is needed.
1389 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001390void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1391 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001392 const void *frame, size_t frame_len,
1393 const struct ieee80211_tx_control *frame_txctl,
1394 struct ieee80211_cts *cts);
1395
1396/**
1397 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1398 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001399 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001400 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1401 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1402 *
1403 * If the CTS-to-self is generated in firmware, but the host system must provide
1404 * the duration field, the low-level driver uses this function to receive
1405 * the duration field value in little-endian byteorder.
1406 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001407__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1408 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001409 size_t frame_len,
1410 const struct ieee80211_tx_control *frame_txctl);
1411
1412/**
1413 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1414 * @hw: pointer obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001415 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001416 * @frame_len: the length of the frame.
Johannes Berg8318d782008-01-24 19:38:38 +01001417 * @rate: the rate at which the frame is going to be transmitted.
Jiri Bencf0706e82007-05-05 11:45:53 -07001418 *
1419 * Calculate the duration field of some generic frame, given its
1420 * length and transmission rate (in 100kbps).
1421 */
Johannes Berg32bfd352007-12-19 01:31:26 +01001422__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1423 struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001424 size_t frame_len,
Johannes Berg8318d782008-01-24 19:38:38 +01001425 struct ieee80211_rate *rate);
Jiri Bencf0706e82007-05-05 11:45:53 -07001426
1427/**
1428 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1429 * @hw: pointer as obtained from ieee80211_alloc_hw().
Johannes Berg32bfd352007-12-19 01:31:26 +01001430 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
Jiri Bencf0706e82007-05-05 11:45:53 -07001431 * @control: will be filled with information needed to send returned frame.
1432 *
1433 * Function for accessing buffered broadcast and multicast frames. If
1434 * hardware/firmware does not implement buffering of broadcast/multicast
1435 * frames when power saving is used, 802.11 code buffers them in the host
1436 * memory. The low-level driver uses this function to fetch next buffered
1437 * frame. In most cases, this is used when generating beacon frame. This
1438 * function returns a pointer to the next buffered skb or NULL if no more
1439 * buffered frames are available.
1440 *
1441 * Note: buffered frames are returned only after DTIM beacon frame was
1442 * generated with ieee80211_beacon_get() and the low-level driver must thus
1443 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1444 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1445 * does not need to check for DTIM beacons separately and should be able to
1446 * use common code for all beacons.
1447 */
1448struct sk_buff *
Johannes Berg32bfd352007-12-19 01:31:26 +01001449ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
Jiri Bencf0706e82007-05-05 11:45:53 -07001450 struct ieee80211_tx_control *control);
1451
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001452/**
1453 * ieee80211_get_hdrlen_from_skb - get header length from data
1454 *
1455 * Given an skb with a raw 802.11 header at the data pointer this function
Jiri Bencf0706e82007-05-05 11:45:53 -07001456 * returns the 802.11 header length in bytes (not including encryption
1457 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1458 * header the function returns 0.
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001459 *
1460 * @skb: the frame
Jiri Bencf0706e82007-05-05 11:45:53 -07001461 */
1462int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1463
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001464/**
1465 * ieee80211_get_hdrlen - get header length from frame control
1466 *
1467 * This function returns the 802.11 header length in bytes (not including
1468 * encryption headers.)
1469 *
1470 * @fc: the frame control field (in CPU endianness)
1471 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001472int ieee80211_get_hdrlen(u16 fc);
1473
1474/**
1475 * ieee80211_wake_queue - wake specific queue
1476 * @hw: pointer as obtained from ieee80211_alloc_hw().
1477 * @queue: queue number (counted from zero).
1478 *
1479 * Drivers should use this function instead of netif_wake_queue.
1480 */
1481void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1482
1483/**
1484 * ieee80211_stop_queue - stop specific queue
1485 * @hw: pointer as obtained from ieee80211_alloc_hw().
1486 * @queue: queue number (counted from zero).
1487 *
1488 * Drivers should use this function instead of netif_stop_queue.
1489 */
1490void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1491
1492/**
1493 * ieee80211_start_queues - start all queues
1494 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1495 *
1496 * Drivers should use this function instead of netif_start_queue.
1497 */
1498void ieee80211_start_queues(struct ieee80211_hw *hw);
1499
1500/**
1501 * ieee80211_stop_queues - stop all queues
1502 * @hw: pointer as obtained from ieee80211_alloc_hw().
1503 *
1504 * Drivers should use this function instead of netif_stop_queue.
1505 */
1506void ieee80211_stop_queues(struct ieee80211_hw *hw);
1507
1508/**
1509 * ieee80211_wake_queues - wake all queues
1510 * @hw: pointer as obtained from ieee80211_alloc_hw().
1511 *
1512 * Drivers should use this function instead of netif_wake_queue.
1513 */
1514void ieee80211_wake_queues(struct ieee80211_hw *hw);
1515
Johannes Berg75a5f0c2007-09-18 17:29:20 -04001516/**
1517 * ieee80211_scan_completed - completed hardware scan
1518 *
1519 * When hardware scan offload is used (i.e. the hw_scan() callback is
1520 * assigned) this function needs to be called by the driver to notify
1521 * mac80211 that the scan finished.
1522 *
1523 * @hw: the hardware that finished the scan
1524 */
Jiri Bencf0706e82007-05-05 11:45:53 -07001525void ieee80211_scan_completed(struct ieee80211_hw *hw);
1526
Johannes Bergdabeb342007-11-09 01:57:29 +01001527/**
1528 * ieee80211_iterate_active_interfaces - iterate active interfaces
1529 *
1530 * This function iterates over the interfaces associated with a given
1531 * hardware that are currently active and calls the callback for them.
Johannes Bergdabeb342007-11-09 01:57:29 +01001532 *
1533 * @hw: the hardware struct of which the interfaces should be iterated over
Johannes Berge38bad42007-11-28 10:55:32 +01001534 * @iterator: the iterator function to call, cannot sleep
Johannes Bergdabeb342007-11-09 01:57:29 +01001535 * @data: first argument of the iterator function
1536 */
1537void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1538 void (*iterator)(void *data, u8 *mac,
Johannes Berg32bfd352007-12-19 01:31:26 +01001539 struct ieee80211_vif *vif),
Johannes Bergdabeb342007-11-09 01:57:29 +01001540 void *data);
1541
Ron Rindjunsky0df3ef42008-01-28 14:07:15 +02001542/**
1543 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1544 * @hw: pointer as obtained from ieee80211_alloc_hw().
1545 * @ra: receiver address of the BA session recipient
1546 * @tid: the TID to BA on.
1547 * @return: success if addBA request was sent, failure otherwise
1548 *
1549 * Although mac80211/low level driver/user space application can estimate
1550 * the need to start aggregation on a certain RA/TID, the session level
1551 * will be managed by the mac80211.
1552 */
1553int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1554
1555/**
1556 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1557 * @hw: pointer as obtained from ieee80211_alloc_hw().
1558 * @ra: receiver address of the BA session recipient.
1559 * @tid: the TID to BA on.
1560 *
1561 * This function must be called by low level driver once it has
1562 * finished with preparations for the BA session.
1563 */
1564void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1565
1566/**
1567 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1568 * @hw: pointer as obtained from ieee80211_alloc_hw().
1569 * @ra: receiver address of the BA session recipient.
1570 * @tid: the TID to BA on.
1571 *
1572 * This function must be called by low level driver once it has
1573 * finished with preparations for the BA session.
1574 * This version of the function is irq safe.
1575 */
1576void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1577 u16 tid);
1578
1579/**
1580 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1581 * @hw: pointer as obtained from ieee80211_alloc_hw().
1582 * @ra: receiver address of the BA session recipient
1583 * @tid: the TID to stop BA.
1584 * @initiator: if indicates initiator DELBA frame will be sent.
1585 * @return: error if no sta with matching da found, success otherwise
1586 *
1587 * Although mac80211/low level driver/user space application can estimate
1588 * the need to stop aggregation on a certain RA/TID, the session level
1589 * will be managed by the mac80211.
1590 */
1591int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1592 u8 *ra, u16 tid,
1593 enum ieee80211_back_parties initiator);
1594
1595/**
1596 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1597 * @hw: pointer as obtained from ieee80211_alloc_hw().
1598 * @ra: receiver address of the BA session recipient.
1599 * @tid: the desired TID to BA on.
1600 *
1601 * This function must be called by low level driver once it has
1602 * finished with preparations for the BA session tear down.
1603 */
1604void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1605
1606/**
1607 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1608 * @hw: pointer as obtained from ieee80211_alloc_hw().
1609 * @ra: receiver address of the BA session recipient.
1610 * @tid: the desired TID to BA on.
1611 *
1612 * This function must be called by low level driver once it has
1613 * finished with preparations for the BA session tear down.
1614 * This version of the function is irq safe.
1615 */
1616void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1617 u16 tid);
1618
Jiri Bencf0706e82007-05-05 11:45:53 -07001619#endif /* MAC80211_H */