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-IRQ-safe 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 * enum ieee80211_max_queues - maximum number of queues
103 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
104 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
105 * for A-MPDU operation.
107 enum ieee80211_max_queues {
108 IEEE80211_MAX_QUEUES = 16,
109 IEEE80211_MAX_AMPDU_QUEUES = 16,
113 * struct ieee80211_tx_queue_params - transmit queue configuration
115 * The information provided in this structure is required for QoS
116 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
118 * @aifs: arbitration interface space [0..255, -1: use default]
119 * @cw_min: minimum contention window [will be a value of the form
120 * 2^n-1 in the range 1..1023; 0: use default]
121 * @cw_max: maximum contention window [like @cw_min]
122 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
124 struct ieee80211_tx_queue_params {
132 * struct ieee80211_tx_queue_stats - transmit queue statistics
134 * @len: number of packets in queue
135 * @limit: queue length limit
136 * @count: number of frames sent
138 struct ieee80211_tx_queue_stats {
144 struct ieee80211_low_level_stats {
145 unsigned int dot11ACKFailureCount;
146 unsigned int dot11RTSFailureCount;
147 unsigned int dot11FCSErrorCount;
148 unsigned int dot11RTSSuccessCount;
152 * enum ieee80211_bss_change - BSS change notification flags
154 * These flags are used with the bss_info_changed() callback
155 * to indicate which BSS parameter changed.
157 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
158 * also implies a change in the AID.
159 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
160 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
161 * @BSS_CHANGED_HT: 802.11n parameters changed
163 enum ieee80211_bss_change {
164 BSS_CHANGED_ASSOC = 1<<0,
165 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
166 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
167 BSS_CHANGED_HT = 1<<4,
171 * struct ieee80211_bss_conf - holds the BSS's changing parameters
173 * This structure keeps information about a BSS (and an association
174 * to that BSS) that can change during the lifetime of the BSS.
176 * @assoc: association status
177 * @aid: association ID number, valid only when @assoc is true
178 * @use_cts_prot: use CTS protection
179 * @use_short_preamble: use 802.11b short preamble
180 * @timestamp: beacon timestamp
181 * @beacon_int: beacon interval
182 * @assoc_capability: capabbilities taken from assoc resp
183 * @assoc_ht: association in HT mode
184 * @ht_conf: ht capabilities
185 * @ht_bss_conf: ht extended capabilities
187 struct ieee80211_bss_conf {
188 /* association related data */
191 /* erp related data */
193 bool use_short_preamble;
195 u16 assoc_capability;
197 /* ht related data */
199 struct ieee80211_ht_info *ht_conf;
200 struct ieee80211_ht_bss_info *ht_bss_conf;
204 * enum mac80211_tx_control_flags - flags to describe transmission information/status
206 * These flags are used with the @flags member of &ieee80211_tx_info.
208 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
209 * @IEEE80211_TX_CTL_DO_NOT_ENCRYPT: send this frame without encryption;
210 * e.g., for EAPOL frame
211 * @IEEE80211_TX_CTL_USE_RTS_CTS: use RTS-CTS before sending frame
212 * @IEEE80211_TX_CTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
213 * for combined 802.11g / 802.11b networks)
214 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
215 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: TBD
216 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
218 * @IEEE80211_TX_CTL_REQUEUE: TBD
219 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
220 * @IEEE80211_TX_CTL_SHORT_PREAMBLE: TBD
221 * @IEEE80211_TX_CTL_LONG_RETRY_LIMIT: this frame should be send using the
222 * through set_retry_limit configured long retry value
223 * @IEEE80211_TX_CTL_EAPOL_FRAME: internal to mac80211
224 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
225 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
226 * @IEEE80211_TX_CTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
227 * of streams when this flag is on can be extracted from antenna_sel_tx,
228 * so if 1 antenna is marked use SISO, 2 antennas marked use MIMO, n
229 * antennas marked use MIMO_n.
230 * @IEEE80211_TX_CTL_GREEN_FIELD: use green field protection for this frame
231 * @IEEE80211_TX_CTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
232 * @IEEE80211_TX_CTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
233 * @IEEE80211_TX_CTL_SHORT_GI: send this frame using short guard interval
234 * @IEEE80211_TX_CTL_INJECTED: TBD
235 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
236 * because the destination STA was in powersave mode.
237 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
238 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
239 * is for the whole aggregation.
240 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
241 * so consider using block ack request (BAR).
243 enum mac80211_tx_control_flags {
244 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
245 IEEE80211_TX_CTL_DO_NOT_ENCRYPT = BIT(1),
246 IEEE80211_TX_CTL_USE_RTS_CTS = BIT(2),
247 IEEE80211_TX_CTL_USE_CTS_PROTECT = BIT(3),
248 IEEE80211_TX_CTL_NO_ACK = BIT(4),
249 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(5),
250 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(6),
251 IEEE80211_TX_CTL_REQUEUE = BIT(7),
252 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(8),
253 IEEE80211_TX_CTL_SHORT_PREAMBLE = BIT(9),
254 IEEE80211_TX_CTL_LONG_RETRY_LIMIT = BIT(10),
255 IEEE80211_TX_CTL_EAPOL_FRAME = BIT(11),
256 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(12),
257 IEEE80211_TX_CTL_AMPDU = BIT(13),
258 IEEE80211_TX_CTL_OFDM_HT = BIT(14),
259 IEEE80211_TX_CTL_GREEN_FIELD = BIT(15),
260 IEEE80211_TX_CTL_40_MHZ_WIDTH = BIT(16),
261 IEEE80211_TX_CTL_DUP_DATA = BIT(17),
262 IEEE80211_TX_CTL_SHORT_GI = BIT(18),
263 IEEE80211_TX_CTL_INJECTED = BIT(19),
264 IEEE80211_TX_STAT_TX_FILTERED = BIT(20),
265 IEEE80211_TX_STAT_ACK = BIT(21),
266 IEEE80211_TX_STAT_AMPDU = BIT(22),
267 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(23),
271 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE \
272 (sizeof(((struct sk_buff *)0)->cb) - 8)
273 #define IEEE80211_TX_INFO_DRIVER_DATA_PTRS \
274 (IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *))
277 * struct ieee80211_tx_info - skb transmit information
279 * This structure is placed in skb->cb for three uses:
280 * (1) mac80211 TX control - mac80211 tells the driver what to do
281 * (2) driver internal use (if applicable)
282 * (3) TX status information - driver tells mac80211 what happened
284 * @flags: transmit info flags, defined above
287 * @antenna_sel_tx: TBD
288 * @control: union for control data
289 * @status: union for status data
290 * @driver_data: array of driver_data pointers
291 * @retry_count: number of retries
292 * @excessive_retries: set to 1 if the frame was retried many times
293 * but not acknowledged
294 * @ampdu_ack_len: number of aggregated frames.
295 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
296 * @ampdu_ack_map: block ack bit map for the aggregation.
297 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
298 * @ack_signal: signal strength of the ACK frame
300 struct ieee80211_tx_info {
301 /* common information */
311 struct ieee80211_vif *vif;
312 struct ieee80211_key_conf *hw_key;
313 unsigned long jiffies;
316 s8 rts_cts_rate_idx, alt_retry_rate_idx;
325 bool excessive_retries;
328 void *driver_data[IEEE80211_TX_INFO_DRIVER_DATA_PTRS];
332 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
334 return (struct ieee80211_tx_info *)skb->cb;
339 * enum mac80211_rx_flags - receive flags
341 * These flags are used with the @flag member of &struct ieee80211_rx_status.
342 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
343 * Use together with %RX_FLAG_MMIC_STRIPPED.
344 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
345 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
346 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
347 * verification has been done by the hardware.
348 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
349 * If this flag is set, the stack cannot do any replay detection
350 * hence the driver or hardware will have to do that.
351 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
353 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
355 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
356 * is valid. This is useful in monitor mode and necessary for beacon frames
357 * to enable IBSS merging.
359 enum mac80211_rx_flags {
360 RX_FLAG_MMIC_ERROR = 1<<0,
361 RX_FLAG_DECRYPTED = 1<<1,
362 RX_FLAG_RADIOTAP = 1<<2,
363 RX_FLAG_MMIC_STRIPPED = 1<<3,
364 RX_FLAG_IV_STRIPPED = 1<<4,
365 RX_FLAG_FAILED_FCS_CRC = 1<<5,
366 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
371 * struct ieee80211_rx_status - receive status
373 * The low-level driver should provide this information (the subset
374 * supported by hardware) to the 802.11 code with each received
377 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
378 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
379 * @band: the active band when this frame was received
380 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
381 * @signal: signal strength when receiving this frame, either in dBm, in dB or
382 * unspecified depending on the hardware capabilities flags
383 * @IEEE80211_HW_SIGNAL_*
384 * @noise: noise when receiving this frame, in dBm.
385 * @qual: overall signal quality indication, in percent (0-100).
386 * @antenna: antenna used
387 * @rate_idx: index of data rate into band's supported rates
390 struct ieee80211_rx_status {
392 enum ieee80211_band band;
403 * enum ieee80211_conf_flags - configuration flags
405 * Flags to define PHY configuration options
407 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
408 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
409 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
410 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
412 enum ieee80211_conf_flags {
413 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
414 IEEE80211_CONF_RADIOTAP = (1<<1),
415 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
416 IEEE80211_CONF_PS = (1<<3),
420 * struct ieee80211_conf - configuration of the device
422 * This struct indicates how the driver shall configure the hardware.
424 * @radio_enabled: when zero, driver is required to switch off the radio.
426 * @beacon_int: beacon interval (TODO make interface config)
427 * @flags: configuration flags defined above
428 * @power_level: requested transmit power (in dBm)
429 * @max_antenna_gain: maximum antenna gain (in dBi)
430 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
432 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
433 * @ht_conf: describes current self configuration of 802.11n HT capabilies
434 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
435 * @channel: the channel to tune to
437 struct ieee80211_conf {
443 int max_antenna_gain;
447 struct ieee80211_channel *channel;
449 struct ieee80211_ht_info ht_conf;
450 struct ieee80211_ht_bss_info ht_bss_conf;
454 * enum ieee80211_if_types - types of 802.11 network interfaces
456 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
458 * @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.
465 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
466 * will never see this type.
467 * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
469 enum ieee80211_if_types {
470 IEEE80211_IF_TYPE_INVALID,
471 IEEE80211_IF_TYPE_AP,
472 IEEE80211_IF_TYPE_STA,
473 IEEE80211_IF_TYPE_IBSS,
474 IEEE80211_IF_TYPE_MESH_POINT,
475 IEEE80211_IF_TYPE_MNTR,
476 IEEE80211_IF_TYPE_WDS,
477 IEEE80211_IF_TYPE_VLAN,
481 * struct ieee80211_vif - per-interface data
483 * Data in this structure is continually present for driver
484 * use during the life of a virtual interface.
486 * @type: type of this virtual interface
487 * @drv_priv: data area for driver use, will always be aligned to
490 struct ieee80211_vif {
491 enum ieee80211_if_types type;
493 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
496 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
498 #ifdef CONFIG_MAC80211_MESH
499 return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
505 * struct ieee80211_if_init_conf - initial configuration of an interface
507 * @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().
510 * @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).
516 * This structure is used in add_interface() and remove_interface()
517 * callbacks of &struct ieee80211_hw.
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.
525 struct ieee80211_if_init_conf {
526 enum ieee80211_if_types type;
527 struct ieee80211_vif *vif;
532 * enum ieee80211_if_conf_change - interface config change flags
534 * @IEEE80211_IFCC_BSSID: The BSSID changed.
535 * @IEEE80211_IFCC_SSID: The SSID changed.
536 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
537 * (currently AP and MESH only), use ieee80211_beacon_get().
539 enum ieee80211_if_conf_change {
540 IEEE80211_IFCC_BSSID = BIT(0),
541 IEEE80211_IFCC_SSID = BIT(1),
542 IEEE80211_IFCC_BEACON = BIT(2),
546 * struct ieee80211_if_conf - configuration of an interface
548 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
549 * @bssid: BSSID of the network we are associated to/creating.
550 * @ssid: used (together with @ssid_len) by drivers for hardware that
551 * generate beacons independently. The pointer is valid only during the
552 * config_interface() call, so copy the value somewhere if you need
554 * @ssid_len: length of the @ssid field.
556 * This structure is passed to the config_interface() callback of
557 * &struct ieee80211_hw.
559 struct ieee80211_if_conf {
567 * enum ieee80211_key_alg - key algorithm
568 * @ALG_WEP: WEP40 or WEP104
570 * @ALG_CCMP: CCMP (AES)
572 enum ieee80211_key_alg {
579 * enum ieee80211_key_len - key length
580 * @LEN_WEP40: WEP 5-byte long key
581 * @LEN_WEP104: WEP 13-byte long key
583 enum ieee80211_key_len {
589 * enum ieee80211_key_flags - key flags
591 * These flags are used for communication about keys between the driver
592 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
594 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
595 * that the STA this key will be used with could be using QoS.
596 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
597 * driver to indicate that it requires IV generation for this
599 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
600 * the driver for a TKIP key if it requires Michael MIC
601 * generation in software.
602 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
603 * that the key is pairwise rather then a shared key.
605 enum ieee80211_key_flags {
606 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
607 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
608 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
609 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
613 * struct ieee80211_key_conf - key information
615 * This key information is given by mac80211 to the driver by
616 * the set_key() callback in &struct ieee80211_ops.
618 * @hw_key_idx: To be set by the driver, this is the key index the driver
619 * wants to be given when a frame is transmitted and needs to be
620 * encrypted in hardware.
621 * @alg: The key algorithm.
622 * @flags: key flags, see &enum ieee80211_key_flags.
623 * @keyidx: the key index (0-3)
624 * @keylen: key material length
625 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
627 * - Temporal Encryption Key (128 bits)
628 * - Temporal Authenticator Tx MIC Key (64 bits)
629 * - Temporal Authenticator Rx MIC Key (64 bits)
632 struct ieee80211_key_conf {
633 enum ieee80211_key_alg alg;
642 * enum set_key_cmd - key command
644 * Used with the set_key() callback in &struct ieee80211_ops, this
645 * indicates whether a key is being removed or added.
647 * @SET_KEY: a key is set
648 * @DISABLE_KEY: a key must be disabled
651 SET_KEY, DISABLE_KEY,
655 * enum sta_notify_cmd - sta notify command
657 * Used with the sta_notify() callback in &struct ieee80211_ops, this
658 * indicates addition and removal of a station to station table.
660 * @STA_NOTIFY_ADD: a station was added to the station table
661 * @STA_NOTIFY_REMOVE: a station being removed from the station table
663 enum sta_notify_cmd {
664 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
668 * enum ieee80211_tkip_key_type - get tkip key
670 * Used by drivers which need to get a tkip key for skb. Some drivers need a
671 * phase 1 key, others need a phase 2 key. A single function allows the driver
672 * to get the key, this enum indicates what type of key is required.
674 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
675 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
677 enum ieee80211_tkip_key_type {
678 IEEE80211_TKIP_P1_KEY,
679 IEEE80211_TKIP_P2_KEY,
683 * enum ieee80211_hw_flags - hardware flags
685 * These flags are used to indicate hardware capabilities to
686 * the stack. Generally, flags here should have their meaning
687 * done in a way that the simplest hardware doesn't need setting
688 * any particular flags. There are some exceptions to this rule,
689 * however, so you are advised to review these flags carefully.
691 * @IEEE80211_HW_RX_INCLUDES_FCS:
692 * Indicates that received frames passed to the stack include
693 * the FCS at the end.
695 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
696 * Some wireless LAN chipsets buffer broadcast/multicast frames
697 * for power saving stations in the hardware/firmware and others
698 * rely on the host system for such buffering. This option is used
699 * to configure the IEEE 802.11 upper layer to buffer broadcast and
700 * multicast frames when there are power saving stations so that
701 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
702 * that not setting this flag works properly only when the
703 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
704 * otherwise the stack will not know when the DTIM beacon was sent.
706 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
707 * Hardware is not capable of short slot operation on the 2.4 GHz band.
709 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
710 * Hardware is not capable of receiving frames with short preamble on
713 * @IEEE80211_HW_SIGNAL_UNSPEC:
714 * Hardware can provide signal values but we don't know its units. We
715 * expect values between 0 and @max_signal.
716 * If possible please provide dB or dBm instead.
718 * @IEEE80211_HW_SIGNAL_DB:
719 * Hardware gives signal values in dB, decibel difference from an
720 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
721 * If possible please provide dBm instead.
723 * @IEEE80211_HW_SIGNAL_DBM:
724 * Hardware gives signal values in dBm, decibel difference from
725 * one milliwatt. This is the preferred method since it is standardized
726 * between different devices. @max_signal does not need to be set.
728 * @IEEE80211_HW_NOISE_DBM:
729 * Hardware can provide noise (radio interference) values in units dBm,
730 * decibel difference from one milliwatt.
732 * @IEEE80211_HW_SPECTRUM_MGMT:
733 * Hardware supports spectrum management defined in 802.11h
734 * Measurement, Channel Switch, Quieting, TPC
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,
742 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
743 IEEE80211_HW_SIGNAL_DB = 1<<6,
744 IEEE80211_HW_SIGNAL_DBM = 1<<7,
745 IEEE80211_HW_NOISE_DBM = 1<<8,
746 IEEE80211_HW_SPECTRUM_MGMT = 1<<9,
750 * struct ieee80211_hw - hardware information and state
752 * This structure contains the configuration and hardware
753 * information for an 802.11 PHY.
755 * @wiphy: This points to the &struct wiphy allocated for this
756 * 802.11 PHY. You must fill in the @perm_addr and @dev
757 * members of this structure using SET_IEEE80211_DEV()
758 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
759 * bands (with channels, bitrates) are registered here.
761 * @conf: &struct ieee80211_conf, device configuration, don't use.
763 * @workqueue: single threaded workqueue available for driver use,
764 * allocated by mac80211 on registration and flushed when an
765 * interface is removed.
766 * NOTICE: All work performed on this workqueue should NEVER
767 * acquire the RTNL lock (i.e. Don't use the function
768 * ieee80211_iterate_active_interfaces())
770 * @priv: pointer to private area that was allocated for driver use
771 * along with this structure.
773 * @flags: hardware flags, see &enum ieee80211_hw_flags.
775 * @extra_tx_headroom: headroom to reserve in each transmit skb
776 * for use by the driver (e.g. for transmit headers.)
778 * @channel_change_time: time (in microseconds) it takes to change channels.
780 * @max_signal: Maximum value for signal (rssi) in RX information, used
781 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
783 * @queues: number of available hardware transmit queues for
784 * data packets. WMM/QoS requires at least four, these
785 * queues need to have configurable access parameters.
787 * @ampdu_queues: number of available hardware transmit queues
788 * for A-MPDU packets, these have no access parameters
789 * because they're used only for A-MPDU frames. Note that
790 * mac80211 will not currently use any of the regular queues
793 * @rate_control_algorithm: rate control algorithm for this hardware.
794 * If unset (NULL), the default algorithm will be used. Must be
795 * set before calling ieee80211_register_hw().
797 * @vif_data_size: size (in bytes) of the drv_priv data area
798 * within &struct ieee80211_vif.
800 struct ieee80211_hw {
801 struct ieee80211_conf conf;
803 struct workqueue_struct *workqueue;
804 const char *rate_control_algorithm;
807 unsigned int extra_tx_headroom;
808 int channel_change_time;
810 u16 queues, ampdu_queues;
815 * SET_IEEE80211_DEV - set device for 802.11 hardware
817 * @hw: the &struct ieee80211_hw to set the device for
818 * @dev: the &struct device of this 802.11 device
820 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
822 set_wiphy_dev(hw->wiphy, dev);
826 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
828 * @hw: the &struct ieee80211_hw to set the MAC address for
829 * @addr: the address to set
831 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
833 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
836 static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
838 #ifdef CONFIG_MAC80211_QOS
845 static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
847 #ifdef CONFIG_MAC80211_QOS
848 return hw->queues + hw->ampdu_queues;
854 static inline struct ieee80211_rate *
855 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
856 const struct ieee80211_tx_info *c)
858 if (WARN_ON(c->tx_rate_idx < 0))
860 return &hw->wiphy->bands[c->band]->bitrates[c->tx_rate_idx];
863 static inline struct ieee80211_rate *
864 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
865 const struct ieee80211_tx_info *c)
867 if (c->control.rts_cts_rate_idx < 0)
869 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
872 static inline struct ieee80211_rate *
873 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
874 const struct ieee80211_tx_info *c)
876 if (c->control.alt_retry_rate_idx < 0)
878 return &hw->wiphy->bands[c->band]->bitrates[c->control.alt_retry_rate_idx];
882 * DOC: Hardware crypto acceleration
884 * mac80211 is capable of taking advantage of many hardware
885 * acceleration designs for encryption and decryption operations.
887 * The set_key() callback in the &struct ieee80211_ops for a given
888 * device is called to enable hardware acceleration of encryption and
889 * decryption. The callback takes an @address parameter that will be
890 * the broadcast address for default keys, the other station's hardware
891 * address for individual keys or the zero address for keys that will
892 * be used only for transmission.
893 * Multiple transmission keys with the same key index may be used when
894 * VLANs are configured for an access point.
896 * The @local_address parameter will always be set to our own address,
897 * this is only relevant if you support multiple local addresses.
899 * When transmitting, the TX control data will use the @hw_key_idx
900 * selected by the driver by modifying the &struct ieee80211_key_conf
901 * pointed to by the @key parameter to the set_key() function.
903 * The set_key() call for the %SET_KEY command should return 0 if
904 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
905 * added; if you return 0 then hw_key_idx must be assigned to the
906 * hardware key index, you are free to use the full u8 range.
908 * When the cmd is %DISABLE_KEY then it must succeed.
910 * Note that it is permissible to not decrypt a frame even if a key
911 * for it has been uploaded to hardware, the stack will not make any
912 * decision based on whether a key has been uploaded or not but rather
913 * based on the receive flags.
915 * The &struct ieee80211_key_conf structure pointed to by the @key
916 * parameter is guaranteed to be valid until another call to set_key()
917 * removes it, but it can only be used as a cookie to differentiate
920 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
921 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
923 * The update_tkip_key() call updates the driver with the new phase 1 key.
924 * This happens everytime the iv16 wraps around (every 65536 packets). The
925 * set_key() call will happen only once for each key (unless the AP did
926 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
927 * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
928 * handler is software decryption with wrap around of iv16.
932 * DOC: Frame filtering
934 * mac80211 requires to see many management frames for proper
935 * operation, and users may want to see many more frames when
936 * in monitor mode. However, for best CPU usage and power consumption,
937 * having as few frames as possible percolate through the stack is
938 * desirable. Hence, the hardware should filter as much as possible.
940 * To achieve this, mac80211 uses filter flags (see below) to tell
941 * the driver's configure_filter() function which frames should be
942 * passed to mac80211 and which should be filtered out.
944 * The configure_filter() callback is invoked with the parameters
945 * @mc_count and @mc_list for the combined multicast address list
946 * of all virtual interfaces, @changed_flags telling which flags
947 * were changed and @total_flags with the new flag states.
949 * If your device has no multicast address filters your driver will
950 * need to check both the %FIF_ALLMULTI flag and the @mc_count
951 * parameter to see whether multicast frames should be accepted
954 * All unsupported flags in @total_flags must be cleared.
955 * Hardware does not support a flag if it is incapable of _passing_
956 * the frame to the stack. Otherwise the driver must ignore
957 * the flag, but not clear it.
958 * You must _only_ clear the flag (announce no support for the
959 * flag to mac80211) if you are not able to pass the packet type
960 * to the stack (so the hardware always filters it).
961 * So for example, you should clear @FIF_CONTROL, if your hardware
962 * always filters control frames. If your hardware always passes
963 * control frames to the kernel and is incapable of filtering them,
964 * you do _not_ clear the @FIF_CONTROL flag.
965 * This rule applies to all other FIF flags as well.
969 * enum ieee80211_filter_flags - hardware filter flags
971 * These flags determine what the filter in hardware should be
972 * programmed to let through and what should not be passed to the
973 * stack. It is always safe to pass more frames than requested,
974 * but this has negative impact on power consumption.
976 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
977 * think of the BSS as your network segment and then this corresponds
978 * to the regular ethernet device promiscuous mode.
980 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
981 * by the user or if the hardware is not capable of filtering by
984 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
985 * %RX_FLAG_FAILED_FCS_CRC for them)
987 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
988 * the %RX_FLAG_FAILED_PLCP_CRC for them
990 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
991 * to the hardware that it should not filter beacons or probe responses
992 * by BSSID. Filtering them can greatly reduce the amount of processing
993 * mac80211 needs to do and the amount of CPU wakeups, so you should
994 * honour this flag if possible.
996 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
997 * only those addressed to this station
999 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1001 enum ieee80211_filter_flags {
1002 FIF_PROMISC_IN_BSS = 1<<0,
1003 FIF_ALLMULTI = 1<<1,
1005 FIF_PLCPFAIL = 1<<3,
1006 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1008 FIF_OTHER_BSS = 1<<6,
1012 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1014 * These flags are used with the ampdu_action() callback in
1015 * &struct ieee80211_ops to indicate which action is needed.
1016 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1017 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1018 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1019 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1021 enum ieee80211_ampdu_mlme_action {
1022 IEEE80211_AMPDU_RX_START,
1023 IEEE80211_AMPDU_RX_STOP,
1024 IEEE80211_AMPDU_TX_START,
1025 IEEE80211_AMPDU_TX_STOP,
1029 * struct ieee80211_ops - callbacks from mac80211 to the driver
1031 * This structure contains various callbacks that the driver may
1032 * handle or, in some cases, must handle, for example to configure
1033 * the hardware to a new channel or to transmit a frame.
1035 * @tx: Handler that 802.11 module calls for each transmitted frame.
1036 * skb contains the buffer starting from the IEEE 802.11 header.
1037 * The low-level driver should send the frame out based on
1038 * configuration in the TX control data. This handler should,
1039 * preferably, never fail and stop queues appropriately, more
1040 * importantly, however, it must never fail for A-MPDU-queues.
1041 * Must be implemented and atomic.
1043 * @start: Called before the first netdevice attached to the hardware
1044 * is enabled. This should turn on the hardware and must turn on
1045 * frame reception (for possibly enabled monitor interfaces.)
1046 * Returns negative error codes, these may be seen in userspace,
1048 * When the device is started it should not have a MAC address
1049 * to avoid acknowledging frames before a non-monitor device
1051 * Must be implemented.
1053 * @stop: Called after last netdevice attached to the hardware
1054 * is disabled. This should turn off the hardware (at least
1055 * it must turn off frame reception.)
1056 * May be called right after add_interface if that rejects
1058 * Must be implemented.
1060 * @add_interface: Called when a netdevice attached to the hardware is
1061 * enabled. Because it is not called for monitor mode devices, @open
1062 * and @stop must be implemented.
1063 * The driver should perform any initialization it needs before
1064 * the device can be enabled. The initial configuration for the
1065 * interface is given in the conf parameter.
1066 * The callback may refuse to add an interface by returning a
1067 * negative error code (which will be seen in userspace.)
1068 * Must be implemented.
1070 * @remove_interface: Notifies a driver that an interface is going down.
1071 * The @stop callback is called after this if it is the last interface
1072 * and no monitor interfaces are present.
1073 * When all interfaces are removed, the MAC address in the hardware
1074 * must be cleared so the device no longer acknowledges packets,
1075 * the mac_addr member of the conf structure is, however, set to the
1076 * MAC address of the device going away.
1077 * Hence, this callback must be implemented.
1079 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1080 * function to change hardware configuration, e.g., channel.
1082 * @config_interface: Handler for configuration requests related to interfaces
1083 * (e.g. BSSID changes.)
1085 * @bss_info_changed: Handler for configuration requests related to BSS
1086 * parameters that may vary during BSS's lifespan, and may affect low
1087 * level driver (e.g. assoc/disassoc status, erp parameters).
1088 * This function should not be used if no BSS has been set, unless
1089 * for association indication. The @changed parameter indicates which
1090 * of the bss parameters has changed when a call is made.
1092 * @configure_filter: Configure the device's RX filter.
1093 * See the section "Frame filtering" for more information.
1094 * This callback must be implemented and atomic.
1096 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
1097 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
1098 * mac80211 calls this function when a TIM bit must be set or cleared
1099 * for a given AID. Must be atomic.
1101 * @set_key: See the section "Hardware crypto acceleration"
1102 * This callback can sleep, and is only called between add_interface
1103 * and remove_interface calls, i.e. while the interface with the
1104 * given local_address is enabled.
1106 * @update_tkip_key: See the section "Hardware crypto acceleration"
1107 * This callback will be called in the context of Rx. Called for drivers
1108 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1110 * @hw_scan: Ask the hardware to service the scan request, no need to start
1111 * the scan state machine in stack. The scan must honour the channel
1112 * configuration done by the regulatory agent in the wiphy's registered
1115 * @get_stats: return low-level statistics
1117 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1118 * callback should be provided to read the TKIP transmit IVs (both IV32
1119 * and IV16) for the given key from hardware.
1121 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1123 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1124 * the device does fragmentation by itself; if this method is assigned then
1125 * the stack will not do fragmentation.
1127 * @set_retry_limit: Configuration of retry limits (if device needs it)
1129 * @sta_notify: Notifies low level driver about addition or removal
1130 * of assocaited station or AP.
1132 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1133 * bursting) for a hardware TX queue. Must be atomic.
1135 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1136 * to get number of currently queued packets (queue length), maximum queue
1137 * size (limit), and total number of packets sent using each TX queue
1138 * (count). The 'stats' pointer points to an array that has hw->queues +
1139 * hw->ampdu_queues items.
1141 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1142 * this is only used for IBSS mode debugging and, as such, is not a
1143 * required function. Must be atomic.
1145 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1146 * with other STAs in the IBSS. This is only used in IBSS mode. This
1147 * function is optional if the firmware/hardware takes full care of
1148 * TSF synchronization.
1150 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1151 * This is needed only for IBSS mode and the result of this function is
1152 * used to determine whether to reply to Probe Requests.
1154 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1156 * @ampdu_action: Perform a certain A-MPDU action
1157 * The RA/TID combination determines the destination and TID we want
1158 * the ampdu action to be performed for. The action is defined through
1159 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1160 * is the first frame we expect to perform the action on. notice
1161 * that TX/RX_STOP can pass NULL for this parameter.
1163 struct ieee80211_ops {
1164 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1165 int (*start)(struct ieee80211_hw *hw);
1166 void (*stop)(struct ieee80211_hw *hw);
1167 int (*add_interface)(struct ieee80211_hw *hw,
1168 struct ieee80211_if_init_conf *conf);
1169 void (*remove_interface)(struct ieee80211_hw *hw,
1170 struct ieee80211_if_init_conf *conf);
1171 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1172 int (*config_interface)(struct ieee80211_hw *hw,
1173 struct ieee80211_vif *vif,
1174 struct ieee80211_if_conf *conf);
1175 void (*bss_info_changed)(struct ieee80211_hw *hw,
1176 struct ieee80211_vif *vif,
1177 struct ieee80211_bss_conf *info,
1179 void (*configure_filter)(struct ieee80211_hw *hw,
1180 unsigned int changed_flags,
1181 unsigned int *total_flags,
1182 int mc_count, struct dev_addr_list *mc_list);
1183 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1184 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1185 const u8 *local_address, const u8 *address,
1186 struct ieee80211_key_conf *key);
1187 void (*update_tkip_key)(struct ieee80211_hw *hw,
1188 struct ieee80211_key_conf *conf, const u8 *address,
1189 u32 iv32, u16 *phase1key);
1190 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1191 int (*get_stats)(struct ieee80211_hw *hw,
1192 struct ieee80211_low_level_stats *stats);
1193 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1194 u32 *iv32, u16 *iv16);
1195 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1196 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1197 int (*set_retry_limit)(struct ieee80211_hw *hw,
1198 u32 short_retry, u32 long_retr);
1199 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1200 enum sta_notify_cmd, const u8 *addr);
1201 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1202 const struct ieee80211_tx_queue_params *params);
1203 int (*get_tx_stats)(struct ieee80211_hw *hw,
1204 struct ieee80211_tx_queue_stats *stats);
1205 u64 (*get_tsf)(struct ieee80211_hw *hw);
1206 void (*reset_tsf)(struct ieee80211_hw *hw);
1207 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1208 int (*ampdu_action)(struct ieee80211_hw *hw,
1209 enum ieee80211_ampdu_mlme_action action,
1210 const u8 *addr, u16 tid, u16 *ssn);
1214 * ieee80211_alloc_hw - Allocate a new hardware device
1216 * This must be called once for each hardware device. The returned pointer
1217 * must be used to refer to this device when calling other functions.
1218 * mac80211 allocates a private data area for the driver pointed to by
1219 * @priv in &struct ieee80211_hw, the size of this area is given as
1222 * @priv_data_len: length of private data
1223 * @ops: callbacks for this device
1225 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1226 const struct ieee80211_ops *ops);
1229 * ieee80211_register_hw - Register hardware device
1231 * You must call this function before any other functions in
1232 * mac80211. Note that before a hardware can be registered, you
1233 * need to fill the contained wiphy's information.
1235 * @hw: the device to register as returned by ieee80211_alloc_hw()
1237 int ieee80211_register_hw(struct ieee80211_hw *hw);
1239 #ifdef CONFIG_MAC80211_LEDS
1240 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1241 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1242 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1243 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1246 * ieee80211_get_tx_led_name - get name of TX LED
1248 * mac80211 creates a transmit LED trigger for each wireless hardware
1249 * that can be used to drive LEDs if your driver registers a LED device.
1250 * This function returns the name (or %NULL if not configured for LEDs)
1251 * of the trigger so you can automatically link the LED device.
1253 * @hw: the hardware to get the LED trigger name for
1255 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1257 #ifdef CONFIG_MAC80211_LEDS
1258 return __ieee80211_get_tx_led_name(hw);
1265 * ieee80211_get_rx_led_name - get name of RX LED
1267 * mac80211 creates a receive LED trigger for each wireless hardware
1268 * that can be used to drive LEDs if your driver registers a LED device.
1269 * This function returns the name (or %NULL if not configured for LEDs)
1270 * of the trigger so you can automatically link the LED device.
1272 * @hw: the hardware to get the LED trigger name for
1274 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1276 #ifdef CONFIG_MAC80211_LEDS
1277 return __ieee80211_get_rx_led_name(hw);
1284 * ieee80211_get_assoc_led_name - get name of association LED
1286 * mac80211 creates a association LED trigger for each wireless hardware
1287 * that can be used to drive LEDs if your driver registers a LED device.
1288 * This function returns the name (or %NULL if not configured for LEDs)
1289 * of the trigger so you can automatically link the LED device.
1291 * @hw: the hardware to get the LED trigger name for
1293 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1295 #ifdef CONFIG_MAC80211_LEDS
1296 return __ieee80211_get_assoc_led_name(hw);
1303 * ieee80211_get_radio_led_name - get name of radio LED
1305 * mac80211 creates a radio change LED trigger for each wireless hardware
1306 * that can be used to drive LEDs if your driver registers a LED device.
1307 * This function returns the name (or %NULL if not configured for LEDs)
1308 * of the trigger so you can automatically link the LED device.
1310 * @hw: the hardware to get the LED trigger name for
1312 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1314 #ifdef CONFIG_MAC80211_LEDS
1315 return __ieee80211_get_radio_led_name(hw);
1322 * ieee80211_unregister_hw - Unregister a hardware device
1324 * This function instructs mac80211 to free allocated resources
1325 * and unregister netdevices from the networking subsystem.
1327 * @hw: the hardware to unregister
1329 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1332 * ieee80211_free_hw - free hardware descriptor
1334 * This function frees everything that was allocated, including the
1335 * private data for the driver. You must call ieee80211_unregister_hw()
1336 * before calling this function.
1338 * @hw: the hardware to free
1340 void ieee80211_free_hw(struct ieee80211_hw *hw);
1342 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1343 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1344 struct ieee80211_rx_status *status);
1347 * ieee80211_rx - receive frame
1349 * Use this function to hand received frames to mac80211. The receive
1350 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1351 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1353 * This function may not be called in IRQ context. Calls to this function
1354 * for a single hardware must be synchronized against each other. Calls
1355 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1358 * @hw: the hardware this frame came in on
1359 * @skb: the buffer to receive, owned by mac80211 after this call
1360 * @status: status of this frame; the status pointer need not be valid
1361 * after this function returns
1363 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1364 struct ieee80211_rx_status *status)
1366 __ieee80211_rx(hw, skb, status);
1370 * ieee80211_rx_irqsafe - receive frame
1372 * Like ieee80211_rx() but can be called in IRQ context
1373 * (internally defers to a tasklet.)
1375 * Calls to this function and ieee80211_rx() may not be mixed for a
1378 * @hw: the hardware this frame came in on
1379 * @skb: the buffer to receive, owned by mac80211 after this call
1380 * @status: status of this frame; the status pointer need not be valid
1381 * after this function returns and is not freed by mac80211,
1382 * it is recommended that it points to a stack area
1384 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1385 struct sk_buff *skb,
1386 struct ieee80211_rx_status *status);
1389 * ieee80211_tx_status - transmit status callback
1391 * Call this function for all transmitted frames after they have been
1392 * transmitted. It is permissible to not call this function for
1393 * multicast frames but this can affect statistics.
1395 * This function may not be called in IRQ context. Calls to this function
1396 * for a single hardware must be synchronized against each other. Calls
1397 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1398 * for a single hardware.
1400 * @hw: the hardware the frame was transmitted by
1401 * @skb: the frame that was transmitted, owned by mac80211 after this call
1403 void ieee80211_tx_status(struct ieee80211_hw *hw,
1404 struct sk_buff *skb);
1407 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1409 * Like ieee80211_tx_status() but can be called in IRQ context
1410 * (internally defers to a tasklet.)
1412 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1415 * @hw: the hardware the frame was transmitted by
1416 * @skb: the frame that was transmitted, owned by mac80211 after this call
1418 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1419 struct sk_buff *skb);
1422 * ieee80211_beacon_get - beacon generation function
1423 * @hw: pointer obtained from ieee80211_alloc_hw().
1424 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1425 * @control: will be filled with information needed to send this beacon.
1427 * If the beacon frames are generated by the host system (i.e., not in
1428 * hardware/firmware), the low-level driver uses this function to receive
1429 * the next beacon frame from the 802.11 code. The low-level is responsible
1430 * for calling this function before beacon data is needed (e.g., based on
1431 * hardware interrupt). Returned skb is used only once and low-level driver
1432 * is responsible of freeing it.
1434 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1435 struct ieee80211_vif *vif);
1438 * ieee80211_rts_get - RTS frame generation function
1439 * @hw: pointer obtained from ieee80211_alloc_hw().
1440 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1441 * @frame: pointer to the frame that is going to be protected by the RTS.
1442 * @frame_len: the frame length (in octets).
1443 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1444 * @rts: The buffer where to store the RTS frame.
1446 * If the RTS frames are generated by the host system (i.e., not in
1447 * hardware/firmware), the low-level driver uses this function to receive
1448 * the next RTS frame from the 802.11 code. The low-level is responsible
1449 * for calling this function before and RTS frame is needed.
1451 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1452 const void *frame, size_t frame_len,
1453 const struct ieee80211_tx_info *frame_txctl,
1454 struct ieee80211_rts *rts);
1457 * ieee80211_rts_duration - Get the duration field for an RTS frame
1458 * @hw: pointer obtained from ieee80211_alloc_hw().
1459 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1460 * @frame_len: the length of the frame that is going to be protected by the RTS.
1461 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1463 * If the RTS is generated in firmware, but the host system must provide
1464 * the duration field, the low-level driver uses this function to receive
1465 * the duration field value in little-endian byteorder.
1467 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1468 struct ieee80211_vif *vif, size_t frame_len,
1469 const struct ieee80211_tx_info *frame_txctl);
1472 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1473 * @hw: pointer obtained from ieee80211_alloc_hw().
1474 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1475 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1476 * @frame_len: the frame length (in octets).
1477 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1478 * @cts: The buffer where to store the CTS-to-self frame.
1480 * If the CTS-to-self frames are generated by the host system (i.e., not in
1481 * hardware/firmware), the low-level driver uses this function to receive
1482 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1483 * for calling this function before and CTS-to-self frame is needed.
1485 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1486 struct ieee80211_vif *vif,
1487 const void *frame, size_t frame_len,
1488 const struct ieee80211_tx_info *frame_txctl,
1489 struct ieee80211_cts *cts);
1492 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1493 * @hw: pointer obtained from ieee80211_alloc_hw().
1494 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1495 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1496 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1498 * If the CTS-to-self is generated in firmware, but the host system must provide
1499 * the duration field, the low-level driver uses this function to receive
1500 * the duration field value in little-endian byteorder.
1502 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1503 struct ieee80211_vif *vif,
1505 const struct ieee80211_tx_info *frame_txctl);
1508 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1509 * @hw: pointer obtained from ieee80211_alloc_hw().
1510 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1511 * @frame_len: the length of the frame.
1512 * @rate: the rate at which the frame is going to be transmitted.
1514 * Calculate the duration field of some generic frame, given its
1515 * length and transmission rate (in 100kbps).
1517 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1518 struct ieee80211_vif *vif,
1520 struct ieee80211_rate *rate);
1523 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1524 * @hw: pointer as obtained from ieee80211_alloc_hw().
1525 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1526 * @control: will be filled with information needed to send returned frame.
1528 * Function for accessing buffered broadcast and multicast frames. If
1529 * hardware/firmware does not implement buffering of broadcast/multicast
1530 * frames when power saving is used, 802.11 code buffers them in the host
1531 * memory. The low-level driver uses this function to fetch next buffered
1532 * frame. In most cases, this is used when generating beacon frame. This
1533 * function returns a pointer to the next buffered skb or NULL if no more
1534 * buffered frames are available.
1536 * Note: buffered frames are returned only after DTIM beacon frame was
1537 * generated with ieee80211_beacon_get() and the low-level driver must thus
1538 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1539 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1540 * does not need to check for DTIM beacons separately and should be able to
1541 * use common code for all beacons.
1544 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1547 * ieee80211_get_hdrlen_from_skb - get header length from data
1549 * Given an skb with a raw 802.11 header at the data pointer this function
1550 * returns the 802.11 header length in bytes (not including encryption
1551 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1552 * header the function returns 0.
1556 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1559 * ieee80211_get_hdrlen - get header length from frame control
1561 * This function returns the 802.11 header length in bytes (not including
1562 * encryption headers.)
1564 * @fc: the frame control field (in CPU endianness)
1566 int ieee80211_get_hdrlen(u16 fc);
1569 * ieee80211_hdrlen - get header length in bytes from frame control
1570 * @fc: frame control field in little-endian format
1572 unsigned int ieee80211_hdrlen(__le16 fc);
1575 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1577 * This function computes a TKIP rc4 key for an skb. It computes
1578 * a phase 1 key if needed (iv16 wraps around). This function is to
1579 * be used by drivers which can do HW encryption but need to compute
1580 * to phase 1/2 key in SW.
1582 * @keyconf: the parameter passed with the set key
1583 * @skb: the skb for which the key is needed
1584 * @rc4key: a buffer to which the key will be written
1588 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1589 struct sk_buff *skb,
1590 enum ieee80211_tkip_key_type type, u8 *key);
1592 * ieee80211_wake_queue - wake specific queue
1593 * @hw: pointer as obtained from ieee80211_alloc_hw().
1594 * @queue: queue number (counted from zero).
1596 * Drivers should use this function instead of netif_wake_queue.
1598 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1601 * ieee80211_stop_queue - stop specific queue
1602 * @hw: pointer as obtained from ieee80211_alloc_hw().
1603 * @queue: queue number (counted from zero).
1605 * Drivers should use this function instead of netif_stop_queue.
1607 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1610 * ieee80211_stop_queues - stop all queues
1611 * @hw: pointer as obtained from ieee80211_alloc_hw().
1613 * Drivers should use this function instead of netif_stop_queue.
1615 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1618 * ieee80211_wake_queues - wake all queues
1619 * @hw: pointer as obtained from ieee80211_alloc_hw().
1621 * Drivers should use this function instead of netif_wake_queue.
1623 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1626 * ieee80211_scan_completed - completed hardware scan
1628 * When hardware scan offload is used (i.e. the hw_scan() callback is
1629 * assigned) this function needs to be called by the driver to notify
1630 * mac80211 that the scan finished.
1632 * @hw: the hardware that finished the scan
1634 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1637 * ieee80211_iterate_active_interfaces - iterate active interfaces
1639 * This function iterates over the interfaces associated with a given
1640 * hardware that are currently active and calls the callback for them.
1641 * This function allows the iterator function to sleep, when the iterator
1642 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1645 * @hw: the hardware struct of which the interfaces should be iterated over
1646 * @iterator: the iterator function to call
1647 * @data: first argument of the iterator function
1649 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1650 void (*iterator)(void *data, u8 *mac,
1651 struct ieee80211_vif *vif),
1655 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1657 * This function iterates over the interfaces associated with a given
1658 * hardware that are currently active and calls the callback for them.
1659 * This function requires the iterator callback function to be atomic,
1660 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1662 * @hw: the hardware struct of which the interfaces should be iterated over
1663 * @iterator: the iterator function to call, cannot sleep
1664 * @data: first argument of the iterator function
1666 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1667 void (*iterator)(void *data,
1669 struct ieee80211_vif *vif),
1673 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1674 * @hw: pointer as obtained from ieee80211_alloc_hw().
1675 * @ra: receiver address of the BA session recipient
1676 * @tid: the TID to BA on.
1677 * @return: success if addBA request was sent, failure otherwise
1679 * Although mac80211/low level driver/user space application can estimate
1680 * the need to start aggregation on a certain RA/TID, the session level
1681 * will be managed by the mac80211.
1683 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1686 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1687 * @hw: pointer as obtained from ieee80211_alloc_hw().
1688 * @ra: receiver address of the BA session recipient.
1689 * @tid: the TID to BA on.
1691 * This function must be called by low level driver once it has
1692 * finished with preparations for the BA session.
1694 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1697 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1698 * @hw: pointer as obtained from ieee80211_alloc_hw().
1699 * @ra: receiver address of the BA session recipient.
1700 * @tid: the TID to BA on.
1702 * This function must be called by low level driver once it has
1703 * finished with preparations for the BA session.
1704 * This version of the function is IRQ-safe.
1706 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1710 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1711 * @hw: pointer as obtained from ieee80211_alloc_hw().
1712 * @ra: receiver address of the BA session recipient
1713 * @tid: the TID to stop BA.
1714 * @initiator: if indicates initiator DELBA frame will be sent.
1715 * @return: error if no sta with matching da found, success otherwise
1717 * Although mac80211/low level driver/user space application can estimate
1718 * the need to stop aggregation on a certain RA/TID, the session level
1719 * will be managed by the mac80211.
1721 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1723 enum ieee80211_back_parties initiator);
1726 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1727 * @hw: pointer as obtained from ieee80211_alloc_hw().
1728 * @ra: receiver address of the BA session recipient.
1729 * @tid: the desired TID to BA on.
1731 * This function must be called by low level driver once it has
1732 * finished with preparations for the BA session tear down.
1734 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1737 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1738 * @hw: pointer as obtained from ieee80211_alloc_hw().
1739 * @ra: receiver address of the BA session recipient.
1740 * @tid: the desired TID to BA on.
1742 * This function must be called by low level driver once it has
1743 * finished with preparations for the BA session tear down.
1744 * This version of the function is IRQ-safe.
1746 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1750 * ieee80211_notify_mac - low level driver notification
1751 * @hw: pointer as obtained from ieee80211_alloc_hw().
1752 * @notif_type: enum ieee80211_notification_types
1754 * This function must be called by low level driver to inform mac80211 of
1755 * low level driver status change or force mac80211 to re-assoc for low
1756 * level driver internal error that require re-assoc.
1758 void ieee80211_notify_mac(struct ieee80211_hw *hw,
1759 enum ieee80211_notification_types notif_type);
1760 #endif /* MAC80211_H */