2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007 Johannes Berg <johannes@sipsolutions.net>
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.
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>
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
35 * DOC: Calling mac80211 from interrupts
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * 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
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-irqsafe functions!
51 * 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.
58 * 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
63 * There are, however, various exceptions to this rule for advanced features:
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
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.
77 * enum ieee80211_notification_type - Low level driver notification
78 * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence
80 enum ieee80211_notification_types {
81 IEEE80211_NOTIFY_RE_ASSOC,
85 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
87 * This structure describes most essential parameters needed
88 * to describe 802.11n HT characteristics in a BSS
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)
94 struct ieee80211_ht_bss_info {
96 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
97 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
101 * struct ieee80211_tx_queue_params - transmit queue configuration
103 * The information provided in this structure is required for QoS
104 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
106 * @aifs: arbitration interface space [0..255, -1: use default]
107 * @cw_min: minimum contention window [will be a value of the form
108 * 2^n-1 in the range 1..1023; 0: use default]
109 * @cw_max: maximum contention window [like @cw_min]
110 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
112 struct ieee80211_tx_queue_params {
120 * struct ieee80211_tx_queue_stats_data - transmit queue statistics
122 * @len: number of packets in queue
123 * @limit: queue length limit
124 * @count: number of frames sent
126 struct ieee80211_tx_queue_stats_data {
133 * enum ieee80211_tx_queue - transmit queue number
135 * These constants are used with some callbacks that take a
136 * queue number to set parameters for a queue.
138 * @IEEE80211_TX_QUEUE_DATA0: data queue 0
139 * @IEEE80211_TX_QUEUE_DATA1: data queue 1
140 * @IEEE80211_TX_QUEUE_DATA2: data queue 2
141 * @IEEE80211_TX_QUEUE_DATA3: data queue 3
142 * @IEEE80211_TX_QUEUE_DATA4: data queue 4
143 * @IEEE80211_TX_QUEUE_SVP: ??
144 * @NUM_TX_DATA_QUEUES: number of data queues
145 * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be
146 * sent after a beacon
147 * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames
148 * @NUM_TX_DATA_QUEUES_AMPDU: adding more queues for A-MPDU
150 enum ieee80211_tx_queue {
151 IEEE80211_TX_QUEUE_DATA0,
152 IEEE80211_TX_QUEUE_DATA1,
153 IEEE80211_TX_QUEUE_DATA2,
154 IEEE80211_TX_QUEUE_DATA3,
155 IEEE80211_TX_QUEUE_DATA4,
156 IEEE80211_TX_QUEUE_SVP,
160 /* due to stupidity in the sub-ioctl userspace interface, the items in
161 * this struct need to have fixed values. As soon as it is removed, we can
162 * fix these entries. */
163 IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
164 IEEE80211_TX_QUEUE_BEACON = 7,
165 NUM_TX_DATA_QUEUES_AMPDU = 16
168 struct ieee80211_tx_queue_stats {
169 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES_AMPDU];
172 struct ieee80211_low_level_stats {
173 unsigned int dot11ACKFailureCount;
174 unsigned int dot11RTSFailureCount;
175 unsigned int dot11FCSErrorCount;
176 unsigned int dot11RTSSuccessCount;
180 * enum ieee80211_bss_change - BSS change notification flags
182 * These flags are used with the bss_info_changed() callback
183 * to indicate which BSS parameter changed.
185 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
186 * also implies a change in the AID.
187 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
188 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
189 * @BSS_CHANGED_HT: 802.11n parameters changed
191 enum ieee80211_bss_change {
192 BSS_CHANGED_ASSOC = 1<<0,
193 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
194 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
195 BSS_CHANGED_HT = 1<<4,
199 * struct ieee80211_bss_conf - holds the BSS's changing parameters
201 * This structure keeps information about a BSS (and an association
202 * to that BSS) that can change during the lifetime of the BSS.
204 * @assoc: association status
205 * @aid: association ID number, valid only when @assoc is true
206 * @use_cts_prot: use CTS protection
207 * @use_short_preamble: use 802.11b short preamble
208 * @timestamp: beacon timestamp
209 * @beacon_int: beacon interval
210 * @assoc_capability: capabbilities taken from assoc resp
211 * @assoc_ht: association in HT mode
212 * @ht_conf: ht capabilities
213 * @ht_bss_conf: ht extended capabilities
215 struct ieee80211_bss_conf {
216 /* association related data */
219 /* erp related data */
221 bool use_short_preamble;
223 u16 assoc_capability;
225 /* ht related data */
227 struct ieee80211_ht_info *ht_conf;
228 struct ieee80211_ht_bss_info *ht_bss_conf;
232 * enum mac80211_tx_control_flags - flags to describe Tx configuration for
235 * These flags are used with the @flags member of &ieee80211_tx_control
237 * @IEEE80211_TXCTL_REQ_TX_STATUS: request TX status callback for this frame.
238 * @IEEE80211_TXCTL_DO_NOT_ENCRYPT: send this frame without encryption;
239 * e.g., for EAPOL frame
240 * @IEEE80211_TXCTL_USE_RTS_CTS: use RTS-CTS before sending frame
241 * @IEEE80211_TXCTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
242 * for combined 802.11g / 802.11b networks)
243 * @IEEE80211_TXCTL_NO_ACK: tell the low level not to wait for an ack
244 * @IEEE80211_TXCTL_RATE_CTRL_PROBE
245 * @EEE80211_TXCTL_CLEAR_PS_FILT: clear powersave filter
246 * for destination station
247 * @IEEE80211_TXCTL_REQUEUE:
248 * @IEEE80211_TXCTL_FIRST_FRAGMENT: this is a first fragment of the frame
249 * @IEEE80211_TXCTL_LONG_RETRY_LIMIT: this frame should be send using the
250 * through set_retry_limit configured long
252 * @IEEE80211_TXCTL_EAPOL_FRAME: internal to mac80211
253 * @IEEE80211_TXCTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
254 * @IEEE80211_TXCTL_AMPDU: this frame should be sent as part of an A-MPDU
255 * @IEEE80211_TXCTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
256 * of streams when this flag is on can be extracted
257 * from antenna_sel_tx, so if 1 antenna is marked
258 * use SISO, 2 antennas marked use MIMO, n antennas
260 * @IEEE80211_TXCTL_GREEN_FIELD: use green field protection for this frame
261 * @IEEE80211_TXCTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
262 * @IEEE80211_TXCTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
263 * @IEEE80211_TXCTL_SHORT_GI: send this frame using short guard interval
265 enum mac80211_tx_control_flags {
266 IEEE80211_TXCTL_REQ_TX_STATUS = (1<<0),
267 IEEE80211_TXCTL_DO_NOT_ENCRYPT = (1<<1),
268 IEEE80211_TXCTL_USE_RTS_CTS = (1<<2),
269 IEEE80211_TXCTL_USE_CTS_PROTECT = (1<<3),
270 IEEE80211_TXCTL_NO_ACK = (1<<4),
271 IEEE80211_TXCTL_RATE_CTRL_PROBE = (1<<5),
272 IEEE80211_TXCTL_CLEAR_PS_FILT = (1<<6),
273 IEEE80211_TXCTL_REQUEUE = (1<<7),
274 IEEE80211_TXCTL_FIRST_FRAGMENT = (1<<8),
275 IEEE80211_TXCTL_SHORT_PREAMBLE = (1<<9),
276 IEEE80211_TXCTL_LONG_RETRY_LIMIT = (1<<10),
277 IEEE80211_TXCTL_EAPOL_FRAME = (1<<11),
278 IEEE80211_TXCTL_SEND_AFTER_DTIM = (1<<12),
279 IEEE80211_TXCTL_AMPDU = (1<<13),
280 IEEE80211_TXCTL_OFDM_HT = (1<<14),
281 IEEE80211_TXCTL_GREEN_FIELD = (1<<15),
282 IEEE80211_TXCTL_40_MHZ_WIDTH = (1<<16),
283 IEEE80211_TXCTL_DUP_DATA = (1<<17),
284 IEEE80211_TXCTL_SHORT_GI = (1<<18),
287 /* Transmit control fields. This data structure is passed to low-level driver
288 * with each TX frame. The low-level driver is responsible for configuring
289 * the hardware to use given values (depending on what is supported).
291 * NOTE: Be careful with using the pointers outside of the ieee80211_ops->tx()
292 * context (i.e. when defering the work to a workqueue).
293 * The vif pointer is valid until the it has been removed with the
294 * ieee80211_ops->remove_interface() callback funtion.
295 * The hw_key pointer is valid until it has been removed with the
296 * ieee80211_ops->set_key() callback function.
297 * The tx_rate and alt_retry_rate pointers are valid until the phy is
300 struct ieee80211_tx_control {
301 struct ieee80211_vif *vif;
302 struct ieee80211_rate *tx_rate;
304 /* Transmit rate for RTS/CTS frame */
305 struct ieee80211_rate *rts_cts_rate;
307 /* retry rate for the last retries */
308 struct ieee80211_rate *alt_retry_rate;
310 /* Key used for hardware encryption
311 * NULL if IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */
312 struct ieee80211_key_conf *hw_key;
314 u32 flags; /* tx control flags defined above */
315 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, ..
316 * This could be used when set_retry_limit
317 * is not implemented by the driver */
318 u8 antenna_sel_tx; /* 0 = default/diversity, otherwise bit
319 * position represents antenna number used */
320 u8 icv_len; /* length of the ICV/MIC field in octets */
321 u8 iv_len; /* length of the IV field in octets */
322 u8 queue; /* hardware queue to use for this frame;
323 * 0 = highest, hw->queues-1 = lowest */
324 u16 aid; /* Station AID */
325 int type; /* internal */
330 * enum mac80211_rx_flags - receive flags
332 * These flags are used with the @flag member of &struct ieee80211_rx_status.
333 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
334 * Use together with %RX_FLAG_MMIC_STRIPPED.
335 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
336 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
337 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
338 * verification has been done by the hardware.
339 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
340 * If this flag is set, the stack cannot do any replay detection
341 * hence the driver or hardware will have to do that.
342 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
344 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
346 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
347 * is valid. This is useful in monitor mode and necessary for beacon frames
348 * to enable IBSS merging.
350 enum mac80211_rx_flags {
351 RX_FLAG_MMIC_ERROR = 1<<0,
352 RX_FLAG_DECRYPTED = 1<<1,
353 RX_FLAG_RADIOTAP = 1<<2,
354 RX_FLAG_MMIC_STRIPPED = 1<<3,
355 RX_FLAG_IV_STRIPPED = 1<<4,
356 RX_FLAG_FAILED_FCS_CRC = 1<<5,
357 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
362 * struct ieee80211_rx_status - receive status
364 * The low-level driver should provide this information (the subset
365 * supported by hardware) to the 802.11 code with each received
367 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
368 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
369 * @band: the active band when this frame was received
370 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
371 * @ssi: signal strength when receiving this frame
372 * @signal: used as 'qual' in statistics reporting
373 * @noise: PHY noise when receiving this frame
374 * @antenna: antenna used
375 * @rate_idx: index of data rate into band's supported rates
378 struct ieee80211_rx_status {
380 enum ieee80211_band band;
391 * enum ieee80211_tx_status_flags - transmit status flags
393 * Status flags to indicate various transmit conditions.
395 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted
396 * because the destination STA was in powersave mode.
397 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged
398 * @IEEE80211_TX_STATUS_AMPDU: The frame was aggregated, so status
399 * is for the whole aggregation.
401 enum ieee80211_tx_status_flags {
402 IEEE80211_TX_STATUS_TX_FILTERED = 1<<0,
403 IEEE80211_TX_STATUS_ACK = 1<<1,
404 IEEE80211_TX_STATUS_AMPDU = 1<<2,
408 * struct ieee80211_tx_status - transmit status
410 * As much information as possible should be provided for each transmitted
411 * frame with ieee80211_tx_status().
413 * @control: a copy of the &struct ieee80211_tx_control passed to the driver
414 * in the tx() callback.
415 * @flags: transmit status flags, defined above
416 * @retry_count: number of retries
417 * @excessive_retries: set to 1 if the frame was retried many times
418 * but not acknowledged
419 * @ampdu_ack_len: number of aggregated frames.
420 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
421 * @ampdu_ack_map: block ack bit map for the aggregation.
422 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
423 * @ack_signal: signal strength of the ACK frame
424 * @queue_length: ?? REMOVE
425 * @queue_number: ?? REMOVE
427 struct ieee80211_tx_status {
428 struct ieee80211_tx_control control;
431 bool excessive_retries;
440 * enum ieee80211_conf_flags - configuration flags
442 * Flags to define PHY configuration options
444 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
445 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
446 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
448 enum ieee80211_conf_flags {
449 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
450 IEEE80211_CONF_RADIOTAP = (1<<1),
451 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
455 * struct ieee80211_conf - configuration of the device
457 * This struct indicates how the driver shall configure the hardware.
459 * @radio_enabled: when zero, driver is required to switch off the radio.
461 * @beacon_int: beacon interval (TODO make interface config)
462 * @flags: configuration flags defined above
463 * @power_level: requested transmit power (in dBm)
464 * @max_antenna_gain: maximum antenna gain (in dBi)
465 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
467 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
468 * @ht_conf: describes current self configuration of 802.11n HT capabilies
469 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
470 * @channel: the channel to tune to
472 struct ieee80211_conf {
478 int max_antenna_gain;
482 struct ieee80211_channel *channel;
484 struct ieee80211_ht_info ht_conf;
485 struct ieee80211_ht_bss_info ht_bss_conf;
489 * enum ieee80211_if_types - types of 802.11 network interfaces
491 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
493 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
494 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
495 * daemon. Drivers should never see this type.
496 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
497 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
498 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
499 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
500 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
501 * will never see this type.
502 * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
504 enum ieee80211_if_types {
505 IEEE80211_IF_TYPE_INVALID,
506 IEEE80211_IF_TYPE_AP,
507 IEEE80211_IF_TYPE_STA,
508 IEEE80211_IF_TYPE_IBSS,
509 IEEE80211_IF_TYPE_MESH_POINT,
510 IEEE80211_IF_TYPE_MNTR,
511 IEEE80211_IF_TYPE_WDS,
512 IEEE80211_IF_TYPE_VLAN,
516 * struct ieee80211_vif - per-interface data
518 * Data in this structure is continually present for driver
519 * use during the life of a virtual interface.
521 * @type: type of this virtual interface
522 * @drv_priv: data area for driver use, will always be aligned to
525 struct ieee80211_vif {
526 enum ieee80211_if_types type;
528 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
531 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
533 #ifdef CONFIG_MAC80211_MESH
534 return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
540 * struct ieee80211_if_init_conf - initial configuration of an interface
542 * @vif: pointer to a driver-use per-interface structure. The pointer
543 * itself is also used for various functions including
544 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
545 * @type: one of &enum ieee80211_if_types constants. Determines the type of
546 * added/removed interface.
547 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
548 * until the interface is removed (i.e. it cannot be used after
549 * remove_interface() callback was called for this interface).
551 * This structure is used in add_interface() and remove_interface()
552 * callbacks of &struct ieee80211_hw.
554 * When you allow multiple interfaces to be added to your PHY, take care
555 * that the hardware can actually handle multiple MAC addresses. However,
556 * also take care that when there's no interface left with mac_addr != %NULL
557 * you remove the MAC address from the device to avoid acknowledging packets
558 * in pure monitor mode.
560 struct ieee80211_if_init_conf {
561 enum ieee80211_if_types type;
562 struct ieee80211_vif *vif;
567 * struct ieee80211_if_conf - configuration of an interface
569 * @type: type of the interface. This is always the same as was specified in
570 * &struct ieee80211_if_init_conf. The type of an interface never changes
571 * during the life of the interface; this field is present only for
573 * @bssid: BSSID of the network we are associated to/creating.
574 * @ssid: used (together with @ssid_len) by drivers for hardware that
575 * generate beacons independently. The pointer is valid only during the
576 * config_interface() call, so copy the value somewhere if you need
578 * @ssid_len: length of the @ssid field.
579 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
580 * &struct ieee80211_hw is set. The driver is responsible of freeing
582 * @beacon_control: tx_control for the beacon template, this field is only
583 * valid when the @beacon field was set.
585 * This structure is passed to the config_interface() callback of
586 * &struct ieee80211_hw.
588 struct ieee80211_if_conf {
593 struct sk_buff *beacon;
594 struct ieee80211_tx_control *beacon_control;
598 * enum ieee80211_key_alg - key algorithm
599 * @ALG_WEP: WEP40 or WEP104
601 * @ALG_CCMP: CCMP (AES)
603 enum ieee80211_key_alg {
611 * enum ieee80211_key_flags - key flags
613 * These flags are used for communication about keys between the driver
614 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
616 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
617 * that the STA this key will be used with could be using QoS.
618 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
619 * driver to indicate that it requires IV generation for this
621 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
622 * the driver for a TKIP key if it requires Michael MIC
623 * generation in software.
625 enum ieee80211_key_flags {
626 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
627 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
628 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
632 * struct ieee80211_key_conf - key information
634 * This key information is given by mac80211 to the driver by
635 * the set_key() callback in &struct ieee80211_ops.
637 * @hw_key_idx: To be set by the driver, this is the key index the driver
638 * wants to be given when a frame is transmitted and needs to be
639 * encrypted in hardware.
640 * @alg: The key algorithm.
641 * @flags: key flags, see &enum ieee80211_key_flags.
642 * @keyidx: the key index (0-3)
643 * @keylen: key material length
646 struct ieee80211_key_conf {
647 enum ieee80211_key_alg alg;
656 * enum set_key_cmd - key command
658 * Used with the set_key() callback in &struct ieee80211_ops, this
659 * indicates whether a key is being removed or added.
661 * @SET_KEY: a key is set
662 * @DISABLE_KEY: a key must be disabled
665 SET_KEY, DISABLE_KEY,
669 * enum sta_notify_cmd - sta notify command
671 * Used with the sta_notify() callback in &struct ieee80211_ops, this
672 * indicates addition and removal of a station to station table
674 * @STA_NOTIFY_ADD: a station was added to the station table
675 * @STA_NOTIFY_REMOVE: a station being removed from the station table
677 enum sta_notify_cmd {
678 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
682 * enum ieee80211_tkip_key_type - get tkip key
684 * Used by drivers which need to get a tkip key for skb. Some drivers need a
685 * phase 1 key, others need a phase 2 key. A single function allows the driver
686 * to get the key, this enum indicates what type of key is required.
688 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
689 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
691 enum ieee80211_tkip_key_type {
692 IEEE80211_TKIP_P1_KEY,
693 IEEE80211_TKIP_P2_KEY,
697 * enum ieee80211_hw_flags - hardware flags
699 * These flags are used to indicate hardware capabilities to
700 * the stack. Generally, flags here should have their meaning
701 * done in a way that the simplest hardware doesn't need setting
702 * any particular flags. There are some exceptions to this rule,
703 * however, so you are advised to review these flags carefully.
705 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
706 * The device only needs to be supplied with a beacon template.
707 * If you need the host to generate each beacon then don't use
708 * this flag and call ieee80211_beacon_get() when you need the
709 * next beacon frame. Note that if you set this flag, you must
710 * implement the set_tim() callback for powersave mode to work
712 * This flag is only relevant for access-point mode.
714 * @IEEE80211_HW_RX_INCLUDES_FCS:
715 * Indicates that received frames passed to the stack include
716 * the FCS at the end.
718 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
719 * Some wireless LAN chipsets buffer broadcast/multicast frames
720 * for power saving stations in the hardware/firmware and others
721 * rely on the host system for such buffering. This option is used
722 * to configure the IEEE 802.11 upper layer to buffer broadcast and
723 * multicast frames when there are power saving stations so that
724 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
725 * that not setting this flag works properly only when the
726 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
727 * otherwise the stack will not know when the DTIM beacon was sent.
729 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
730 * Hardware is not capable of short slot operation on the 2.4 GHz band.
732 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
733 * Hardware is not capable of receiving frames with short preamble on
736 enum ieee80211_hw_flags {
737 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0,
738 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
739 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
740 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
741 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
745 * struct ieee80211_hw - hardware information and state
747 * This structure contains the configuration and hardware
748 * information for an 802.11 PHY.
750 * @wiphy: This points to the &struct wiphy allocated for this
751 * 802.11 PHY. You must fill in the @perm_addr and @dev
752 * members of this structure using SET_IEEE80211_DEV()
753 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
754 * bands (with channels, bitrates) are registered here.
756 * @conf: &struct ieee80211_conf, device configuration, don't use.
758 * @workqueue: single threaded workqueue available for driver use,
759 * allocated by mac80211 on registration and flushed on
762 * @priv: pointer to private area that was allocated for driver use
763 * along with this structure.
765 * @flags: hardware flags, see &enum ieee80211_hw_flags.
767 * @extra_tx_headroom: headroom to reserve in each transmit skb
768 * for use by the driver (e.g. for transmit headers.)
770 * @channel_change_time: time (in microseconds) it takes to change channels.
772 * @max_rssi: Maximum value for ssi in RX information, use
773 * negative numbers for dBm and 0 to indicate no support.
775 * @max_signal: like @max_rssi, but for the signal value.
777 * @max_noise: like @max_rssi, but for the noise value.
779 * @queues: number of available hardware transmit queues for
780 * data packets. WMM/QoS requires at least four.
782 * @rate_control_algorithm: rate control algorithm for this hardware.
783 * If unset (NULL), the default algorithm will be used. Must be
784 * set before calling ieee80211_register_hw().
786 * @vif_data_size: size (in bytes) of the drv_priv data area
787 * within &struct ieee80211_vif.
789 struct ieee80211_hw {
790 struct ieee80211_conf conf;
792 struct workqueue_struct *workqueue;
793 const char *rate_control_algorithm;
796 unsigned int extra_tx_headroom;
797 int channel_change_time;
806 * SET_IEEE80211_DEV - set device for 802.11 hardware
808 * @hw: the &struct ieee80211_hw to set the device for
809 * @dev: the &struct device of this 802.11 device
811 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
813 set_wiphy_dev(hw->wiphy, dev);
817 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
819 * @hw: the &struct ieee80211_hw to set the MAC address for
820 * @addr: the address to set
822 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
824 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
828 * DOC: Hardware crypto acceleration
830 * mac80211 is capable of taking advantage of many hardware
831 * acceleration designs for encryption and decryption operations.
833 * The set_key() callback in the &struct ieee80211_ops for a given
834 * device is called to enable hardware acceleration of encryption and
835 * decryption. The callback takes an @address parameter that will be
836 * the broadcast address for default keys, the other station's hardware
837 * address for individual keys or the zero address for keys that will
838 * be used only for transmission.
839 * Multiple transmission keys with the same key index may be used when
840 * VLANs are configured for an access point.
842 * The @local_address parameter will always be set to our own address,
843 * this is only relevant if you support multiple local addresses.
845 * When transmitting, the TX control data will use the @hw_key_idx
846 * selected by the driver by modifying the &struct ieee80211_key_conf
847 * pointed to by the @key parameter to the set_key() function.
849 * The set_key() call for the %SET_KEY command should return 0 if
850 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
851 * added; if you return 0 then hw_key_idx must be assigned to the
852 * hardware key index, you are free to use the full u8 range.
854 * When the cmd is %DISABLE_KEY then it must succeed.
856 * Note that it is permissible to not decrypt a frame even if a key
857 * for it has been uploaded to hardware, the stack will not make any
858 * decision based on whether a key has been uploaded or not but rather
859 * based on the receive flags.
861 * The &struct ieee80211_key_conf structure pointed to by the @key
862 * parameter is guaranteed to be valid until another call to set_key()
863 * removes it, but it can only be used as a cookie to differentiate
866 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
867 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
869 * The update_tkip_key() call updates the driver with the new phase 1 key.
870 * This happens everytime the iv16 wraps around (every 65536 packets). The
871 * set_key() call will happen only once for each key (unless the AP did
872 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
873 * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
874 * handler is software decryption with wrap around of iv16.
878 * DOC: Frame filtering
880 * mac80211 requires to see many management frames for proper
881 * operation, and users may want to see many more frames when
882 * in monitor mode. However, for best CPU usage and power consumption,
883 * having as few frames as possible percolate through the stack is
884 * desirable. Hence, the hardware should filter as much as possible.
886 * To achieve this, mac80211 uses filter flags (see below) to tell
887 * the driver's configure_filter() function which frames should be
888 * passed to mac80211 and which should be filtered out.
890 * The configure_filter() callback is invoked with the parameters
891 * @mc_count and @mc_list for the combined multicast address list
892 * of all virtual interfaces, @changed_flags telling which flags
893 * were changed and @total_flags with the new flag states.
895 * If your device has no multicast address filters your driver will
896 * need to check both the %FIF_ALLMULTI flag and the @mc_count
897 * parameter to see whether multicast frames should be accepted
900 * All unsupported flags in @total_flags must be cleared.
901 * Hardware does not support a flag if it is incapable of _passing_
902 * the frame to the stack. Otherwise the driver must ignore
903 * the flag, but not clear it.
904 * You must _only_ clear the flag (announce no support for the
905 * flag to mac80211) if you are not able to pass the packet type
906 * to the stack (so the hardware always filters it).
907 * So for example, you should clear @FIF_CONTROL, if your hardware
908 * always filters control frames. If your hardware always passes
909 * control frames to the kernel and is incapable of filtering them,
910 * you do _not_ clear the @FIF_CONTROL flag.
911 * This rule applies to all other FIF flags as well.
915 * enum ieee80211_filter_flags - hardware filter flags
917 * These flags determine what the filter in hardware should be
918 * programmed to let through and what should not be passed to the
919 * stack. It is always safe to pass more frames than requested,
920 * but this has negative impact on power consumption.
922 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
923 * think of the BSS as your network segment and then this corresponds
924 * to the regular ethernet device promiscuous mode.
926 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
927 * by the user or if the hardware is not capable of filtering by
930 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
931 * %RX_FLAG_FAILED_FCS_CRC for them)
933 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
934 * the %RX_FLAG_FAILED_PLCP_CRC for them
936 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
937 * to the hardware that it should not filter beacons or probe responses
938 * by BSSID. Filtering them can greatly reduce the amount of processing
939 * mac80211 needs to do and the amount of CPU wakeups, so you should
940 * honour this flag if possible.
942 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
943 * only those addressed to this station
945 * @FIF_OTHER_BSS: pass frames destined to other BSSes
947 enum ieee80211_filter_flags {
948 FIF_PROMISC_IN_BSS = 1<<0,
952 FIF_BCN_PRBRESP_PROMISC = 1<<4,
954 FIF_OTHER_BSS = 1<<6,
958 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
960 * These flags are used with the ampdu_action() callback in
961 * &struct ieee80211_ops to indicate which action is needed.
962 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
963 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
964 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
965 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
967 enum ieee80211_ampdu_mlme_action {
968 IEEE80211_AMPDU_RX_START,
969 IEEE80211_AMPDU_RX_STOP,
970 IEEE80211_AMPDU_TX_START,
971 IEEE80211_AMPDU_TX_STOP,
975 * struct ieee80211_ops - callbacks from mac80211 to the driver
977 * This structure contains various callbacks that the driver may
978 * handle or, in some cases, must handle, for example to configure
979 * the hardware to a new channel or to transmit a frame.
981 * @tx: Handler that 802.11 module calls for each transmitted frame.
982 * skb contains the buffer starting from the IEEE 802.11 header.
983 * The low-level driver should send the frame out based on
984 * configuration in the TX control data. Must be implemented and
987 * @start: Called before the first netdevice attached to the hardware
988 * is enabled. This should turn on the hardware and must turn on
989 * frame reception (for possibly enabled monitor interfaces.)
990 * Returns negative error codes, these may be seen in userspace,
992 * When the device is started it should not have a MAC address
993 * to avoid acknowledging frames before a non-monitor device
995 * Must be implemented.
997 * @stop: Called after last netdevice attached to the hardware
998 * is disabled. This should turn off the hardware (at least
999 * it must turn off frame reception.)
1000 * May be called right after add_interface if that rejects
1002 * Must be implemented.
1004 * @add_interface: Called when a netdevice attached to the hardware is
1005 * enabled. Because it is not called for monitor mode devices, @open
1006 * and @stop must be implemented.
1007 * The driver should perform any initialization it needs before
1008 * the device can be enabled. The initial configuration for the
1009 * interface is given in the conf parameter.
1010 * The callback may refuse to add an interface by returning a
1011 * negative error code (which will be seen in userspace.)
1012 * Must be implemented.
1014 * @remove_interface: Notifies a driver that an interface is going down.
1015 * The @stop callback is called after this if it is the last interface
1016 * and no monitor interfaces are present.
1017 * When all interfaces are removed, the MAC address in the hardware
1018 * must be cleared so the device no longer acknowledges packets,
1019 * the mac_addr member of the conf structure is, however, set to the
1020 * MAC address of the device going away.
1021 * Hence, this callback must be implemented.
1023 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1024 * function to change hardware configuration, e.g., channel.
1026 * @config_interface: Handler for configuration requests related to interfaces
1027 * (e.g. BSSID changes.)
1029 * @bss_info_changed: Handler for configuration requests related to BSS
1030 * parameters that may vary during BSS's lifespan, and may affect low
1031 * level driver (e.g. assoc/disassoc status, erp parameters).
1032 * This function should not be used if no BSS has been set, unless
1033 * for association indication. The @changed parameter indicates which
1034 * of the bss parameters has changed when a call is made.
1036 * @configure_filter: Configure the device's RX filter.
1037 * See the section "Frame filtering" for more information.
1038 * This callback must be implemented and atomic.
1040 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
1041 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
1042 * mac80211 calls this function when a TIM bit must be set or cleared
1043 * for a given AID. Must be atomic.
1045 * @set_key: See the section "Hardware crypto acceleration"
1046 * This callback can sleep, and is only called between add_interface
1047 * and remove_interface calls, i.e. while the interface with the
1048 * given local_address is enabled.
1050 * @update_tkip_key: See the section "Hardware crypto acceleration"
1051 * This callback will be called in the context of Rx. Called for drivers
1052 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1054 * @hw_scan: Ask the hardware to service the scan request, no need to start
1055 * the scan state machine in stack. The scan must honour the channel
1056 * configuration done by the regulatory agent in the wiphy's registered
1059 * @get_stats: return low-level statistics
1061 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1062 * callback should be provided to read the TKIP transmit IVs (both IV32
1063 * and IV16) for the given key from hardware.
1065 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1067 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1068 * the device does fragmentation by itself; if this method is assigned then
1069 * the stack will not do fragmentation.
1071 * @set_retry_limit: Configuration of retry limits (if device needs it)
1073 * @sta_notify: Notifies low level driver about addition or removal
1074 * of assocaited station or AP.
1076 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1077 * bursting) for a hardware TX queue. The @queue parameter uses the
1078 * %IEEE80211_TX_QUEUE_* constants. Must be atomic.
1080 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1081 * to get number of currently queued packets (queue length), maximum queue
1082 * size (limit), and total number of packets sent using each TX queue
1083 * (count). This information is used for WMM to find out which TX
1084 * queues have room for more packets and by hostapd to provide
1085 * statistics about the current queueing state to external programs.
1087 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1088 * this is only used for IBSS mode debugging and, as such, is not a
1089 * required function. Must be atomic.
1091 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1092 * with other STAs in the IBSS. This is only used in IBSS mode. This
1093 * function is optional if the firmware/hardware takes full care of
1094 * TSF synchronization.
1096 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
1097 * IBSS uses a fixed beacon frame which is configured using this
1099 * If the driver returns success (0) from this callback, it owns
1100 * the skb. That means the driver is responsible to kfree_skb() it.
1101 * The control structure is not dynamically allocated. That means the
1102 * driver does not own the pointer and if it needs it somewhere
1103 * outside of the context of this function, it must copy it
1105 * This handler is required only for IBSS mode.
1107 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1108 * This is needed only for IBSS mode and the result of this function is
1109 * used to determine whether to reply to Probe Requests.
1111 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1113 * @ampdu_action: Perform a certain A-MPDU action
1114 * The RA/TID combination determines the destination and TID we want
1115 * the ampdu action to be performed for. The action is defined through
1116 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1117 * is the first frame we expect to perform the action on. notice
1118 * that TX/RX_STOP can pass NULL for this parameter.
1120 struct ieee80211_ops {
1121 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
1122 struct ieee80211_tx_control *control);
1123 int (*start)(struct ieee80211_hw *hw);
1124 void (*stop)(struct ieee80211_hw *hw);
1125 int (*add_interface)(struct ieee80211_hw *hw,
1126 struct ieee80211_if_init_conf *conf);
1127 void (*remove_interface)(struct ieee80211_hw *hw,
1128 struct ieee80211_if_init_conf *conf);
1129 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1130 int (*config_interface)(struct ieee80211_hw *hw,
1131 struct ieee80211_vif *vif,
1132 struct ieee80211_if_conf *conf);
1133 void (*bss_info_changed)(struct ieee80211_hw *hw,
1134 struct ieee80211_vif *vif,
1135 struct ieee80211_bss_conf *info,
1137 void (*configure_filter)(struct ieee80211_hw *hw,
1138 unsigned int changed_flags,
1139 unsigned int *total_flags,
1140 int mc_count, struct dev_addr_list *mc_list);
1141 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1142 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1143 const u8 *local_address, const u8 *address,
1144 struct ieee80211_key_conf *key);
1145 void (*update_tkip_key)(struct ieee80211_hw *hw,
1146 struct ieee80211_key_conf *conf, const u8 *address,
1147 u32 iv32, u16 *phase1key);
1148 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1149 int (*get_stats)(struct ieee80211_hw *hw,
1150 struct ieee80211_low_level_stats *stats);
1151 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1152 u32 *iv32, u16 *iv16);
1153 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1154 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1155 int (*set_retry_limit)(struct ieee80211_hw *hw,
1156 u32 short_retry, u32 long_retr);
1157 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1158 enum sta_notify_cmd, const u8 *addr);
1159 int (*conf_tx)(struct ieee80211_hw *hw, int queue,
1160 const struct ieee80211_tx_queue_params *params);
1161 int (*get_tx_stats)(struct ieee80211_hw *hw,
1162 struct ieee80211_tx_queue_stats *stats);
1163 u64 (*get_tsf)(struct ieee80211_hw *hw);
1164 void (*reset_tsf)(struct ieee80211_hw *hw);
1165 int (*beacon_update)(struct ieee80211_hw *hw,
1166 struct sk_buff *skb,
1167 struct ieee80211_tx_control *control);
1168 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1169 int (*ampdu_action)(struct ieee80211_hw *hw,
1170 enum ieee80211_ampdu_mlme_action action,
1171 const u8 *addr, u16 tid, u16 *ssn);
1175 * ieee80211_alloc_hw - Allocate a new hardware device
1177 * This must be called once for each hardware device. The returned pointer
1178 * must be used to refer to this device when calling other functions.
1179 * mac80211 allocates a private data area for the driver pointed to by
1180 * @priv in &struct ieee80211_hw, the size of this area is given as
1183 * @priv_data_len: length of private data
1184 * @ops: callbacks for this device
1186 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1187 const struct ieee80211_ops *ops);
1190 * ieee80211_register_hw - Register hardware device
1192 * You must call this function before any other functions in
1193 * mac80211. Note that before a hardware can be registered, you
1194 * need to fill the contained wiphy's information.
1196 * @hw: the device to register as returned by ieee80211_alloc_hw()
1198 int ieee80211_register_hw(struct ieee80211_hw *hw);
1200 #ifdef CONFIG_MAC80211_LEDS
1201 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1202 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1203 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1204 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1207 * ieee80211_get_tx_led_name - get name of TX LED
1209 * mac80211 creates a transmit LED trigger for each wireless hardware
1210 * that can be used to drive LEDs if your driver registers a LED device.
1211 * This function returns the name (or %NULL if not configured for LEDs)
1212 * of the trigger so you can automatically link the LED device.
1214 * @hw: the hardware to get the LED trigger name for
1216 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1218 #ifdef CONFIG_MAC80211_LEDS
1219 return __ieee80211_get_tx_led_name(hw);
1226 * ieee80211_get_rx_led_name - get name of RX LED
1228 * mac80211 creates a receive LED trigger for each wireless hardware
1229 * that can be used to drive LEDs if your driver registers a LED device.
1230 * This function returns the name (or %NULL if not configured for LEDs)
1231 * of the trigger so you can automatically link the LED device.
1233 * @hw: the hardware to get the LED trigger name for
1235 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1237 #ifdef CONFIG_MAC80211_LEDS
1238 return __ieee80211_get_rx_led_name(hw);
1245 * ieee80211_get_assoc_led_name - get name of association LED
1247 * mac80211 creates a association LED trigger for each wireless hardware
1248 * that can be used to drive LEDs if your driver registers a LED device.
1249 * This function returns the name (or %NULL if not configured for LEDs)
1250 * of the trigger so you can automatically link the LED device.
1252 * @hw: the hardware to get the LED trigger name for
1254 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1256 #ifdef CONFIG_MAC80211_LEDS
1257 return __ieee80211_get_assoc_led_name(hw);
1264 * ieee80211_get_radio_led_name - get name of radio LED
1266 * mac80211 creates a radio change LED trigger for each wireless hardware
1267 * that can be used to drive LEDs if your driver registers a LED device.
1268 * This function returns the name (or %NULL if not configured for LEDs)
1269 * of the trigger so you can automatically link the LED device.
1271 * @hw: the hardware to get the LED trigger name for
1273 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1275 #ifdef CONFIG_MAC80211_LEDS
1276 return __ieee80211_get_radio_led_name(hw);
1283 * ieee80211_unregister_hw - Unregister a hardware device
1285 * This function instructs mac80211 to free allocated resources
1286 * and unregister netdevices from the networking subsystem.
1288 * @hw: the hardware to unregister
1290 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1293 * ieee80211_free_hw - free hardware descriptor
1295 * This function frees everything that was allocated, including the
1296 * private data for the driver. You must call ieee80211_unregister_hw()
1297 * before calling this function
1299 * @hw: the hardware to free
1301 void ieee80211_free_hw(struct ieee80211_hw *hw);
1303 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1304 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1305 struct ieee80211_rx_status *status);
1308 * ieee80211_rx - receive frame
1310 * Use this function to hand received frames to mac80211. The receive
1311 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1312 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1314 * This function may not be called in IRQ context. Calls to this function
1315 * for a single hardware must be synchronized against each other. Calls
1316 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1319 * @hw: the hardware this frame came in on
1320 * @skb: the buffer to receive, owned by mac80211 after this call
1321 * @status: status of this frame; the status pointer need not be valid
1322 * after this function returns
1324 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1325 struct ieee80211_rx_status *status)
1327 __ieee80211_rx(hw, skb, status);
1331 * ieee80211_rx_irqsafe - receive frame
1333 * Like ieee80211_rx() but can be called in IRQ context
1334 * (internally defers to a tasklet.)
1336 * Calls to this function and ieee80211_rx() may not be mixed for a
1339 * @hw: the hardware this frame came in on
1340 * @skb: the buffer to receive, owned by mac80211 after this call
1341 * @status: status of this frame; the status pointer need not be valid
1342 * after this function returns and is not freed by mac80211,
1343 * it is recommended that it points to a stack area
1345 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1346 struct sk_buff *skb,
1347 struct ieee80211_rx_status *status);
1350 * ieee80211_tx_status - transmit status callback
1352 * Call this function for all transmitted frames after they have been
1353 * transmitted. It is permissible to not call this function for
1354 * multicast frames but this can affect statistics.
1356 * This function may not be called in IRQ context. Calls to this function
1357 * for a single hardware must be synchronized against each other. Calls
1358 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1359 * for a single hardware.
1361 * @hw: the hardware the frame was transmitted by
1362 * @skb: the frame that was transmitted, owned by mac80211 after this call
1363 * @status: status information for this frame; the status pointer need not
1364 * be valid after this function returns and is not freed by mac80211,
1365 * it is recommended that it points to a stack area
1367 void ieee80211_tx_status(struct ieee80211_hw *hw,
1368 struct sk_buff *skb,
1369 struct ieee80211_tx_status *status);
1372 * ieee80211_tx_status_irqsafe - irq-safe transmit status callback
1374 * Like ieee80211_tx_status() but can be called in IRQ context
1375 * (internally defers to a tasklet.)
1377 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1380 * @hw: the hardware the frame was transmitted by
1381 * @skb: the frame that was transmitted, owned by mac80211 after this call
1382 * @status: status information for this frame; the status pointer need not
1383 * be valid after this function returns and is not freed by mac80211,
1384 * it is recommended that it points to a stack area
1386 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1387 struct sk_buff *skb,
1388 struct ieee80211_tx_status *status);
1391 * ieee80211_beacon_get - beacon generation function
1392 * @hw: pointer obtained from ieee80211_alloc_hw().
1393 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1394 * @control: will be filled with information needed to send this beacon.
1396 * If the beacon frames are generated by the host system (i.e., not in
1397 * hardware/firmware), the low-level driver uses this function to receive
1398 * the next beacon frame from the 802.11 code. The low-level is responsible
1399 * for calling this function before beacon data is needed (e.g., based on
1400 * hardware interrupt). Returned skb is used only once and low-level driver
1401 * is responsible of freeing it.
1403 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1404 struct ieee80211_vif *vif,
1405 struct ieee80211_tx_control *control);
1408 * ieee80211_rts_get - RTS frame generation function
1409 * @hw: pointer obtained from ieee80211_alloc_hw().
1410 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1411 * @frame: pointer to the frame that is going to be protected by the RTS.
1412 * @frame_len: the frame length (in octets).
1413 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1414 * @rts: The buffer where to store the RTS frame.
1416 * If the RTS frames are generated by the host system (i.e., not in
1417 * hardware/firmware), the low-level driver uses this function to receive
1418 * the next RTS frame from the 802.11 code. The low-level is responsible
1419 * for calling this function before and RTS frame is needed.
1421 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1422 const void *frame, size_t frame_len,
1423 const struct ieee80211_tx_control *frame_txctl,
1424 struct ieee80211_rts *rts);
1427 * ieee80211_rts_duration - Get the duration field for an RTS frame
1428 * @hw: pointer obtained from ieee80211_alloc_hw().
1429 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1430 * @frame_len: the length of the frame that is going to be protected by the RTS.
1431 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1433 * If the RTS is generated in firmware, but the host system must provide
1434 * the duration field, the low-level driver uses this function to receive
1435 * the duration field value in little-endian byteorder.
1437 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1438 struct ieee80211_vif *vif, size_t frame_len,
1439 const struct ieee80211_tx_control *frame_txctl);
1442 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1443 * @hw: pointer obtained from ieee80211_alloc_hw().
1444 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1445 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1446 * @frame_len: the frame length (in octets).
1447 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1448 * @cts: The buffer where to store the CTS-to-self frame.
1450 * If the CTS-to-self frames are generated by the host system (i.e., not in
1451 * hardware/firmware), the low-level driver uses this function to receive
1452 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1453 * for calling this function before and CTS-to-self frame is needed.
1455 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1456 struct ieee80211_vif *vif,
1457 const void *frame, size_t frame_len,
1458 const struct ieee80211_tx_control *frame_txctl,
1459 struct ieee80211_cts *cts);
1462 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1463 * @hw: pointer obtained from ieee80211_alloc_hw().
1464 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1465 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1466 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1468 * If the CTS-to-self is generated in firmware, but the host system must provide
1469 * the duration field, the low-level driver uses this function to receive
1470 * the duration field value in little-endian byteorder.
1472 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1473 struct ieee80211_vif *vif,
1475 const struct ieee80211_tx_control *frame_txctl);
1478 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1479 * @hw: pointer obtained from ieee80211_alloc_hw().
1480 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1481 * @frame_len: the length of the frame.
1482 * @rate: the rate at which the frame is going to be transmitted.
1484 * Calculate the duration field of some generic frame, given its
1485 * length and transmission rate (in 100kbps).
1487 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1488 struct ieee80211_vif *vif,
1490 struct ieee80211_rate *rate);
1493 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1494 * @hw: pointer as obtained from ieee80211_alloc_hw().
1495 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1496 * @control: will be filled with information needed to send returned frame.
1498 * Function for accessing buffered broadcast and multicast frames. If
1499 * hardware/firmware does not implement buffering of broadcast/multicast
1500 * frames when power saving is used, 802.11 code buffers them in the host
1501 * memory. The low-level driver uses this function to fetch next buffered
1502 * frame. In most cases, this is used when generating beacon frame. This
1503 * function returns a pointer to the next buffered skb or NULL if no more
1504 * buffered frames are available.
1506 * Note: buffered frames are returned only after DTIM beacon frame was
1507 * generated with ieee80211_beacon_get() and the low-level driver must thus
1508 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1509 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1510 * does not need to check for DTIM beacons separately and should be able to
1511 * use common code for all beacons.
1514 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1515 struct ieee80211_tx_control *control);
1518 * ieee80211_get_hdrlen_from_skb - get header length from data
1520 * Given an skb with a raw 802.11 header at the data pointer this function
1521 * returns the 802.11 header length in bytes (not including encryption
1522 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1523 * header the function returns 0.
1527 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1530 * ieee80211_get_hdrlen - get header length from frame control
1532 * This function returns the 802.11 header length in bytes (not including
1533 * encryption headers.)
1535 * @fc: the frame control field (in CPU endianness)
1537 int ieee80211_get_hdrlen(u16 fc);
1540 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1542 * This function computes a TKIP rc4 key for an skb. It computes
1543 * a phase 1 key if needed (iv16 wraps around). This function is to
1544 * be used by drivers which can do HW encryption but need to compute
1545 * to phase 1/2 key in SW.
1547 * @keyconf: the parameter passed with the set key
1548 * @skb: the skb for which the key is needed
1549 * @rc4key: a buffer to which the key will be written
1551 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1552 struct sk_buff *skb,
1553 enum ieee80211_tkip_key_type type, u8 *key);
1555 * ieee80211_wake_queue - wake specific queue
1556 * @hw: pointer as obtained from ieee80211_alloc_hw().
1557 * @queue: queue number (counted from zero).
1559 * Drivers should use this function instead of netif_wake_queue.
1561 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1564 * ieee80211_stop_queue - stop specific queue
1565 * @hw: pointer as obtained from ieee80211_alloc_hw().
1566 * @queue: queue number (counted from zero).
1568 * Drivers should use this function instead of netif_stop_queue.
1570 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1573 * ieee80211_start_queues - start all queues
1574 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1576 * Drivers should use this function instead of netif_start_queue.
1578 void ieee80211_start_queues(struct ieee80211_hw *hw);
1581 * ieee80211_stop_queues - stop all queues
1582 * @hw: pointer as obtained from ieee80211_alloc_hw().
1584 * Drivers should use this function instead of netif_stop_queue.
1586 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1589 * ieee80211_wake_queues - wake all queues
1590 * @hw: pointer as obtained from ieee80211_alloc_hw().
1592 * Drivers should use this function instead of netif_wake_queue.
1594 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1597 * ieee80211_scan_completed - completed hardware scan
1599 * When hardware scan offload is used (i.e. the hw_scan() callback is
1600 * assigned) this function needs to be called by the driver to notify
1601 * mac80211 that the scan finished.
1603 * @hw: the hardware that finished the scan
1605 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1608 * ieee80211_iterate_active_interfaces - iterate active interfaces
1610 * This function iterates over the interfaces associated with a given
1611 * hardware that are currently active and calls the callback for them.
1613 * @hw: the hardware struct of which the interfaces should be iterated over
1614 * @iterator: the iterator function to call, cannot sleep
1615 * @data: first argument of the iterator function
1617 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1618 void (*iterator)(void *data, u8 *mac,
1619 struct ieee80211_vif *vif),
1623 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1624 * @hw: pointer as obtained from ieee80211_alloc_hw().
1625 * @ra: receiver address of the BA session recipient
1626 * @tid: the TID to BA on.
1627 * @return: success if addBA request was sent, failure otherwise
1629 * Although mac80211/low level driver/user space application can estimate
1630 * the need to start aggregation on a certain RA/TID, the session level
1631 * will be managed by the mac80211.
1633 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1636 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1637 * @hw: pointer as obtained from ieee80211_alloc_hw().
1638 * @ra: receiver address of the BA session recipient.
1639 * @tid: the TID to BA on.
1641 * This function must be called by low level driver once it has
1642 * finished with preparations for the BA session.
1644 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1647 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1648 * @hw: pointer as obtained from ieee80211_alloc_hw().
1649 * @ra: receiver address of the BA session recipient.
1650 * @tid: the TID to BA on.
1652 * This function must be called by low level driver once it has
1653 * finished with preparations for the BA session.
1654 * This version of the function is irq safe.
1656 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1660 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1661 * @hw: pointer as obtained from ieee80211_alloc_hw().
1662 * @ra: receiver address of the BA session recipient
1663 * @tid: the TID to stop BA.
1664 * @initiator: if indicates initiator DELBA frame will be sent.
1665 * @return: error if no sta with matching da found, success otherwise
1667 * Although mac80211/low level driver/user space application can estimate
1668 * the need to stop aggregation on a certain RA/TID, the session level
1669 * will be managed by the mac80211.
1671 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1673 enum ieee80211_back_parties initiator);
1676 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1677 * @hw: pointer as obtained from ieee80211_alloc_hw().
1678 * @ra: receiver address of the BA session recipient.
1679 * @tid: the desired TID to BA on.
1681 * This function must be called by low level driver once it has
1682 * finished with preparations for the BA session tear down.
1684 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1687 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1688 * @hw: pointer as obtained from ieee80211_alloc_hw().
1689 * @ra: receiver address of the BA session recipient.
1690 * @tid: the desired TID to BA on.
1692 * This function must be called by low level driver once it has
1693 * finished with preparations for the BA session tear down.
1694 * This version of the function is irq safe.
1696 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1700 * ieee80211_notify_mac - low level driver notification
1701 * @hw: pointer as obtained from ieee80211_alloc_hw().
1702 * @notification_types: enum ieee80211_notification_types
1704 * This function must be called by low level driver to inform mac80211 of
1705 * low level driver status change or force mac80211 to re-assoc for low
1706 * level driver internal error that require re-assoc.
1708 void ieee80211_notify_mac(struct ieee80211_hw *hw,
1709 enum ieee80211_notification_types notif_type);
1710 #endif /* MAC80211_H */