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 * 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_flags - flags to 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
216 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
218 * @IEEE80211_TX_CTL_REQUEUE:
219 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
220 * @IEEE80211_TX_CTL_LONG_RETRY_LIMIT: this frame should be send using the
221 * through set_retry_limit configured long retry value
222 * @IEEE80211_TX_CTL_EAPOL_FRAME: internal to mac80211
223 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
224 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
225 * @IEEE80211_TX_CTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
226 * of streams when this flag is on can be extracted from antenna_sel_tx,
227 * so if 1 antenna is marked use SISO, 2 antennas marked use MIMO, n
228 * antennas marked use MIMO_n.
229 * @IEEE80211_TX_CTL_GREEN_FIELD: use green field protection for this frame
230 * @IEEE80211_TX_CTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
231 * @IEEE80211_TX_CTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
232 * @IEEE80211_TX_CTL_SHORT_GI: send this frame using short guard interval
233 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
234 * because the destination STA was in powersave mode.
235 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
236 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
237 * is for the whole aggregation.
238 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
239 * so consider using block ack request (BAR).
241 enum mac80211_tx_control_flags {
242 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
243 IEEE80211_TX_CTL_DO_NOT_ENCRYPT = BIT(1),
244 IEEE80211_TX_CTL_USE_RTS_CTS = BIT(2),
245 IEEE80211_TX_CTL_USE_CTS_PROTECT = BIT(3),
246 IEEE80211_TX_CTL_NO_ACK = BIT(4),
247 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(5),
248 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(6),
249 IEEE80211_TX_CTL_REQUEUE = BIT(7),
250 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(8),
251 IEEE80211_TX_CTL_SHORT_PREAMBLE = BIT(9),
252 IEEE80211_TX_CTL_LONG_RETRY_LIMIT = BIT(10),
253 IEEE80211_TX_CTL_EAPOL_FRAME = BIT(11),
254 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(12),
255 IEEE80211_TX_CTL_AMPDU = BIT(13),
256 IEEE80211_TX_CTL_OFDM_HT = BIT(14),
257 IEEE80211_TX_CTL_GREEN_FIELD = BIT(15),
258 IEEE80211_TX_CTL_40_MHZ_WIDTH = BIT(16),
259 IEEE80211_TX_CTL_DUP_DATA = BIT(17),
260 IEEE80211_TX_CTL_SHORT_GI = BIT(18),
261 IEEE80211_TX_CTL_INJECTED = BIT(19),
262 IEEE80211_TX_STAT_TX_FILTERED = BIT(20),
263 IEEE80211_TX_STAT_ACK = BIT(21),
264 IEEE80211_TX_STAT_AMPDU = BIT(22),
265 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(23),
269 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE \
270 (sizeof(((struct sk_buff *)0)->cb) - 8)
271 #define IEEE80211_TX_INFO_DRIVER_DATA_PTRS \
272 (IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *))
275 * struct ieee80211_tx_info - skb transmit information
277 * This structure is placed in skb->cb for three uses:
278 * (1) mac80211 TX control - mac80211 tells the driver what to do
279 * (2) driver internal use (if applicable)
280 * (3) TX status information - driver tells mac80211 what happened
282 * @flags: transmit info flags, defined above
283 * @retry_count: number of retries
284 * @excessive_retries: set to 1 if the frame was retried many times
285 * but not acknowledged
286 * @ampdu_ack_len: number of aggregated frames.
287 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
288 * @ampdu_ack_map: block ack bit map for the aggregation.
289 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
290 * @ack_signal: signal strength of the ACK frame
292 struct ieee80211_tx_info {
293 /* common information */
303 struct ieee80211_vif *vif;
304 struct ieee80211_key_conf *hw_key;
305 unsigned long jiffies;
308 s8 rts_cts_rate_idx, alt_retry_rate_idx;
317 bool excessive_retries;
320 void *driver_data[IEEE80211_TX_INFO_DRIVER_DATA_PTRS];
324 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
326 return (struct ieee80211_tx_info *)skb->cb;
331 * enum mac80211_rx_flags - receive flags
333 * These flags are used with the @flag member of &struct ieee80211_rx_status.
334 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
335 * Use together with %RX_FLAG_MMIC_STRIPPED.
336 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
337 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
338 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
339 * verification has been done by the hardware.
340 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
341 * If this flag is set, the stack cannot do any replay detection
342 * hence the driver or hardware will have to do that.
343 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
345 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
347 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
348 * is valid. This is useful in monitor mode and necessary for beacon frames
349 * to enable IBSS merging.
351 enum mac80211_rx_flags {
352 RX_FLAG_MMIC_ERROR = 1<<0,
353 RX_FLAG_DECRYPTED = 1<<1,
354 RX_FLAG_RADIOTAP = 1<<2,
355 RX_FLAG_MMIC_STRIPPED = 1<<3,
356 RX_FLAG_IV_STRIPPED = 1<<4,
357 RX_FLAG_FAILED_FCS_CRC = 1<<5,
358 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
363 * struct ieee80211_rx_status - receive status
365 * The low-level driver should provide this information (the subset
366 * supported by hardware) to the 802.11 code with each received
369 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
370 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
371 * @band: the active band when this frame was received
372 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
373 * @signal: signal strength when receiving this frame, either in dBm, in dB or
374 * unspecified depending on the hardware capabilities flags
375 * @IEEE80211_HW_SIGNAL_*
376 * @noise: noise when receiving this frame, in dBm.
377 * @qual: overall signal quality indication, in percent (0-100).
378 * @antenna: antenna used
379 * @rate_idx: index of data rate into band's supported rates
382 struct ieee80211_rx_status {
384 enum ieee80211_band band;
395 * enum ieee80211_conf_flags - configuration flags
397 * Flags to define PHY configuration options
399 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
400 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
401 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
403 enum ieee80211_conf_flags {
404 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
405 IEEE80211_CONF_RADIOTAP = (1<<1),
406 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
410 * struct ieee80211_conf - configuration of the device
412 * This struct indicates how the driver shall configure the hardware.
414 * @radio_enabled: when zero, driver is required to switch off the radio.
416 * @beacon_int: beacon interval (TODO make interface config)
417 * @flags: configuration flags defined above
418 * @power_level: requested transmit power (in dBm)
419 * @max_antenna_gain: maximum antenna gain (in dBi)
420 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
422 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
423 * @ht_conf: describes current self configuration of 802.11n HT capabilies
424 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
425 * @channel: the channel to tune to
427 struct ieee80211_conf {
433 int max_antenna_gain;
437 struct ieee80211_channel *channel;
439 struct ieee80211_ht_info ht_conf;
440 struct ieee80211_ht_bss_info ht_bss_conf;
444 * enum ieee80211_if_types - types of 802.11 network interfaces
446 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
448 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
449 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
450 * daemon. Drivers should never see this type.
451 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
452 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
453 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
454 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
455 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
456 * will never see this type.
457 * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
459 enum ieee80211_if_types {
460 IEEE80211_IF_TYPE_INVALID,
461 IEEE80211_IF_TYPE_AP,
462 IEEE80211_IF_TYPE_STA,
463 IEEE80211_IF_TYPE_IBSS,
464 IEEE80211_IF_TYPE_MESH_POINT,
465 IEEE80211_IF_TYPE_MNTR,
466 IEEE80211_IF_TYPE_WDS,
467 IEEE80211_IF_TYPE_VLAN,
471 * struct ieee80211_vif - per-interface data
473 * Data in this structure is continually present for driver
474 * use during the life of a virtual interface.
476 * @type: type of this virtual interface
477 * @drv_priv: data area for driver use, will always be aligned to
480 struct ieee80211_vif {
481 enum ieee80211_if_types type;
483 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
486 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
488 #ifdef CONFIG_MAC80211_MESH
489 return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
495 * struct ieee80211_if_init_conf - initial configuration of an interface
497 * @vif: pointer to a driver-use per-interface structure. The pointer
498 * itself is also used for various functions including
499 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
500 * @type: one of &enum ieee80211_if_types constants. Determines the type of
501 * added/removed interface.
502 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
503 * until the interface is removed (i.e. it cannot be used after
504 * remove_interface() callback was called for this interface).
506 * This structure is used in add_interface() and remove_interface()
507 * callbacks of &struct ieee80211_hw.
509 * When you allow multiple interfaces to be added to your PHY, take care
510 * that the hardware can actually handle multiple MAC addresses. However,
511 * also take care that when there's no interface left with mac_addr != %NULL
512 * you remove the MAC address from the device to avoid acknowledging packets
513 * in pure monitor mode.
515 struct ieee80211_if_init_conf {
516 enum ieee80211_if_types type;
517 struct ieee80211_vif *vif;
522 * struct ieee80211_if_conf - configuration of an interface
524 * @type: type of the interface. This is always the same as was specified in
525 * &struct ieee80211_if_init_conf. The type of an interface never changes
526 * during the life of the interface; this field is present only for
528 * @bssid: BSSID of the network we are associated to/creating.
529 * @ssid: used (together with @ssid_len) by drivers for hardware that
530 * generate beacons independently. The pointer is valid only during the
531 * config_interface() call, so copy the value somewhere if you need
533 * @ssid_len: length of the @ssid field.
534 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
535 * &struct ieee80211_hw is set. The driver is responsible of freeing
537 * @beacon_control: tx_control for the beacon template, this field is only
538 * valid when the @beacon field was set.
540 * This structure is passed to the config_interface() callback of
541 * &struct ieee80211_hw.
543 struct ieee80211_if_conf {
548 struct sk_buff *beacon;
552 * enum ieee80211_key_alg - key algorithm
553 * @ALG_WEP: WEP40 or WEP104
555 * @ALG_CCMP: CCMP (AES)
557 enum ieee80211_key_alg {
564 * enum ieee80211_key_len - key length
565 * @WEP40: WEP 5 byte long key
566 * @WEP104: WEP 13 byte long key
568 enum ieee80211_key_len {
574 * enum ieee80211_key_flags - key flags
576 * These flags are used for communication about keys between the driver
577 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
579 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
580 * that the STA this key will be used with could be using QoS.
581 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
582 * driver to indicate that it requires IV generation for this
584 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
585 * the driver for a TKIP key if it requires Michael MIC
586 * generation in software.
587 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
588 * that the key is pairwise rather then a shared key.
590 enum ieee80211_key_flags {
591 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
592 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
593 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
594 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
598 * struct ieee80211_key_conf - key information
600 * This key information is given by mac80211 to the driver by
601 * the set_key() callback in &struct ieee80211_ops.
603 * @hw_key_idx: To be set by the driver, this is the key index the driver
604 * wants to be given when a frame is transmitted and needs to be
605 * encrypted in hardware.
606 * @alg: The key algorithm.
607 * @flags: key flags, see &enum ieee80211_key_flags.
608 * @keyidx: the key index (0-3)
609 * @keylen: key material length
610 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
612 * - Temporal Encryption Key (128 bits)
613 * - Temporal Authenticator Tx MIC Key (64 bits)
614 * - Temporal Authenticator Rx MIC Key (64 bits)
617 struct ieee80211_key_conf {
618 enum ieee80211_key_alg alg;
627 * enum set_key_cmd - key command
629 * Used with the set_key() callback in &struct ieee80211_ops, this
630 * indicates whether a key is being removed or added.
632 * @SET_KEY: a key is set
633 * @DISABLE_KEY: a key must be disabled
636 SET_KEY, DISABLE_KEY,
640 * enum sta_notify_cmd - sta notify command
642 * Used with the sta_notify() callback in &struct ieee80211_ops, this
643 * indicates addition and removal of a station to station table
645 * @STA_NOTIFY_ADD: a station was added to the station table
646 * @STA_NOTIFY_REMOVE: a station being removed from the station table
648 enum sta_notify_cmd {
649 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
653 * enum ieee80211_tkip_key_type - get tkip key
655 * Used by drivers which need to get a tkip key for skb. Some drivers need a
656 * phase 1 key, others need a phase 2 key. A single function allows the driver
657 * to get the key, this enum indicates what type of key is required.
659 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
660 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
662 enum ieee80211_tkip_key_type {
663 IEEE80211_TKIP_P1_KEY,
664 IEEE80211_TKIP_P2_KEY,
668 * enum ieee80211_hw_flags - hardware flags
670 * These flags are used to indicate hardware capabilities to
671 * the stack. Generally, flags here should have their meaning
672 * done in a way that the simplest hardware doesn't need setting
673 * any particular flags. There are some exceptions to this rule,
674 * however, so you are advised to review these flags carefully.
676 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
677 * The device only needs to be supplied with a beacon template.
678 * If you need the host to generate each beacon then don't use
679 * this flag and call ieee80211_beacon_get() when you need the
680 * next beacon frame. Note that if you set this flag, you must
681 * implement the set_tim() callback for powersave mode to work
683 * This flag is only relevant for access-point mode.
685 * @IEEE80211_HW_RX_INCLUDES_FCS:
686 * Indicates that received frames passed to the stack include
687 * the FCS at the end.
689 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
690 * Some wireless LAN chipsets buffer broadcast/multicast frames
691 * for power saving stations in the hardware/firmware and others
692 * rely on the host system for such buffering. This option is used
693 * to configure the IEEE 802.11 upper layer to buffer broadcast and
694 * multicast frames when there are power saving stations so that
695 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
696 * that not setting this flag works properly only when the
697 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
698 * otherwise the stack will not know when the DTIM beacon was sent.
700 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
701 * Hardware is not capable of short slot operation on the 2.4 GHz band.
703 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
704 * Hardware is not capable of receiving frames with short preamble on
707 * @IEEE80211_HW_SIGNAL_UNSPEC:
708 * Hardware can provide signal values but we don't know its units. We
709 * expect values between 0 and @max_signal.
710 * If possible please provide dB or dBm instead.
712 * @IEEE80211_HW_SIGNAL_DB:
713 * Hardware gives signal values in dB, decibel difference from an
714 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
715 * If possible please provide dBm instead.
717 * @IEEE80211_HW_SIGNAL_DBM:
718 * Hardware gives signal values in dBm, decibel difference from
719 * one milliwatt. This is the preferred method since it is standardized
720 * between different devices. @max_signal does not need to be set.
722 * @IEEE80211_HW_NOISE_DBM:
723 * Hardware can provide noise (radio interference) values in units dBm,
724 * decibel difference from one milliwatt.
726 * @IEEE80211_HW_SPECTRUM_MGMT:
727 * Hardware supports spectrum management defined in 802.11h
728 * Measurement, Channel Switch, Quieting, TPC
730 enum ieee80211_hw_flags {
731 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0,
732 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
733 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
734 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
735 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
736 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
737 IEEE80211_HW_SIGNAL_DB = 1<<6,
738 IEEE80211_HW_SIGNAL_DBM = 1<<7,
739 IEEE80211_HW_NOISE_DBM = 1<<8,
740 IEEE80211_HW_SPECTRUM_MGMT = 1<<9,
744 * struct ieee80211_hw - hardware information and state
746 * This structure contains the configuration and hardware
747 * information for an 802.11 PHY.
749 * @wiphy: This points to the &struct wiphy allocated for this
750 * 802.11 PHY. You must fill in the @perm_addr and @dev
751 * members of this structure using SET_IEEE80211_DEV()
752 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
753 * bands (with channels, bitrates) are registered here.
755 * @conf: &struct ieee80211_conf, device configuration, don't use.
757 * @workqueue: single threaded workqueue available for driver use,
758 * allocated by mac80211 on registration and flushed when an
759 * interface is removed.
760 * NOTICE: All work performed on this workqueue should NEVER
761 * acquire the RTNL lock (i.e. Don't use the function
762 * ieee80211_iterate_active_interfaces())
764 * @priv: pointer to private area that was allocated for driver use
765 * along with this structure.
767 * @flags: hardware flags, see &enum ieee80211_hw_flags.
769 * @extra_tx_headroom: headroom to reserve in each transmit skb
770 * for use by the driver (e.g. for transmit headers.)
772 * @channel_change_time: time (in microseconds) it takes to change channels.
774 * @max_signal: Maximum value for signal (rssi) in RX information, used
775 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
777 * @queues: number of available hardware transmit queues for
778 * data packets. WMM/QoS requires at least four, these
779 * queues need to have configurable access parameters.
781 * @ampdu_queues: number of available hardware transmit queues
782 * for A-MPDU packets, these have no access parameters
783 * because they're used only for A-MPDU frames. Note that
784 * mac80211 will not currently use any of the regular queues
787 * @rate_control_algorithm: rate control algorithm for this hardware.
788 * If unset (NULL), the default algorithm will be used. Must be
789 * set before calling ieee80211_register_hw().
791 * @vif_data_size: size (in bytes) of the drv_priv data area
792 * within &struct ieee80211_vif.
794 struct ieee80211_hw {
795 struct ieee80211_conf conf;
797 struct workqueue_struct *workqueue;
798 const char *rate_control_algorithm;
801 unsigned int extra_tx_headroom;
802 int channel_change_time;
804 u16 queues, ampdu_queues;
809 * SET_IEEE80211_DEV - set device for 802.11 hardware
811 * @hw: the &struct ieee80211_hw to set the device for
812 * @dev: the &struct device of this 802.11 device
814 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
816 set_wiphy_dev(hw->wiphy, dev);
820 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
822 * @hw: the &struct ieee80211_hw to set the MAC address for
823 * @addr: the address to set
825 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
827 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
830 static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
832 #ifdef CONFIG_MAC80211_QOS
839 static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
841 #ifdef CONFIG_MAC80211_QOS
842 return hw->queues + hw->ampdu_queues;
848 static inline struct ieee80211_rate *
849 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
850 const struct ieee80211_tx_info *c)
852 if (WARN_ON(c->tx_rate_idx < 0))
854 return &hw->wiphy->bands[c->band]->bitrates[c->tx_rate_idx];
857 static inline struct ieee80211_rate *
858 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
859 const struct ieee80211_tx_info *c)
861 if (c->control.rts_cts_rate_idx < 0)
863 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
866 static inline struct ieee80211_rate *
867 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
868 const struct ieee80211_tx_info *c)
870 if (c->control.alt_retry_rate_idx < 0)
872 return &hw->wiphy->bands[c->band]->bitrates[c->control.alt_retry_rate_idx];
876 * DOC: Hardware crypto acceleration
878 * mac80211 is capable of taking advantage of many hardware
879 * acceleration designs for encryption and decryption operations.
881 * The set_key() callback in the &struct ieee80211_ops for a given
882 * device is called to enable hardware acceleration of encryption and
883 * decryption. The callback takes an @address parameter that will be
884 * the broadcast address for default keys, the other station's hardware
885 * address for individual keys or the zero address for keys that will
886 * be used only for transmission.
887 * Multiple transmission keys with the same key index may be used when
888 * VLANs are configured for an access point.
890 * The @local_address parameter will always be set to our own address,
891 * this is only relevant if you support multiple local addresses.
893 * When transmitting, the TX control data will use the @hw_key_idx
894 * selected by the driver by modifying the &struct ieee80211_key_conf
895 * pointed to by the @key parameter to the set_key() function.
897 * The set_key() call for the %SET_KEY command should return 0 if
898 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
899 * added; if you return 0 then hw_key_idx must be assigned to the
900 * hardware key index, you are free to use the full u8 range.
902 * When the cmd is %DISABLE_KEY then it must succeed.
904 * Note that it is permissible to not decrypt a frame even if a key
905 * for it has been uploaded to hardware, the stack will not make any
906 * decision based on whether a key has been uploaded or not but rather
907 * based on the receive flags.
909 * The &struct ieee80211_key_conf structure pointed to by the @key
910 * parameter is guaranteed to be valid until another call to set_key()
911 * removes it, but it can only be used as a cookie to differentiate
914 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
915 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
917 * The update_tkip_key() call updates the driver with the new phase 1 key.
918 * This happens everytime the iv16 wraps around (every 65536 packets). The
919 * set_key() call will happen only once for each key (unless the AP did
920 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
921 * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
922 * handler is software decryption with wrap around of iv16.
926 * DOC: Frame filtering
928 * mac80211 requires to see many management frames for proper
929 * operation, and users may want to see many more frames when
930 * in monitor mode. However, for best CPU usage and power consumption,
931 * having as few frames as possible percolate through the stack is
932 * desirable. Hence, the hardware should filter as much as possible.
934 * To achieve this, mac80211 uses filter flags (see below) to tell
935 * the driver's configure_filter() function which frames should be
936 * passed to mac80211 and which should be filtered out.
938 * The configure_filter() callback is invoked with the parameters
939 * @mc_count and @mc_list for the combined multicast address list
940 * of all virtual interfaces, @changed_flags telling which flags
941 * were changed and @total_flags with the new flag states.
943 * If your device has no multicast address filters your driver will
944 * need to check both the %FIF_ALLMULTI flag and the @mc_count
945 * parameter to see whether multicast frames should be accepted
948 * All unsupported flags in @total_flags must be cleared.
949 * Hardware does not support a flag if it is incapable of _passing_
950 * the frame to the stack. Otherwise the driver must ignore
951 * the flag, but not clear it.
952 * You must _only_ clear the flag (announce no support for the
953 * flag to mac80211) if you are not able to pass the packet type
954 * to the stack (so the hardware always filters it).
955 * So for example, you should clear @FIF_CONTROL, if your hardware
956 * always filters control frames. If your hardware always passes
957 * control frames to the kernel and is incapable of filtering them,
958 * you do _not_ clear the @FIF_CONTROL flag.
959 * This rule applies to all other FIF flags as well.
963 * enum ieee80211_filter_flags - hardware filter flags
965 * These flags determine what the filter in hardware should be
966 * programmed to let through and what should not be passed to the
967 * stack. It is always safe to pass more frames than requested,
968 * but this has negative impact on power consumption.
970 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
971 * think of the BSS as your network segment and then this corresponds
972 * to the regular ethernet device promiscuous mode.
974 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
975 * by the user or if the hardware is not capable of filtering by
978 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
979 * %RX_FLAG_FAILED_FCS_CRC for them)
981 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
982 * the %RX_FLAG_FAILED_PLCP_CRC for them
984 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
985 * to the hardware that it should not filter beacons or probe responses
986 * by BSSID. Filtering them can greatly reduce the amount of processing
987 * mac80211 needs to do and the amount of CPU wakeups, so you should
988 * honour this flag if possible.
990 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
991 * only those addressed to this station
993 * @FIF_OTHER_BSS: pass frames destined to other BSSes
995 enum ieee80211_filter_flags {
996 FIF_PROMISC_IN_BSS = 1<<0,
1000 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1002 FIF_OTHER_BSS = 1<<6,
1006 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1008 * These flags are used with the ampdu_action() callback in
1009 * &struct ieee80211_ops to indicate which action is needed.
1010 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1011 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1012 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1013 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1015 enum ieee80211_ampdu_mlme_action {
1016 IEEE80211_AMPDU_RX_START,
1017 IEEE80211_AMPDU_RX_STOP,
1018 IEEE80211_AMPDU_TX_START,
1019 IEEE80211_AMPDU_TX_STOP,
1023 * struct ieee80211_ops - callbacks from mac80211 to the driver
1025 * This structure contains various callbacks that the driver may
1026 * handle or, in some cases, must handle, for example to configure
1027 * the hardware to a new channel or to transmit a frame.
1029 * @tx: Handler that 802.11 module calls for each transmitted frame.
1030 * skb contains the buffer starting from the IEEE 802.11 header.
1031 * The low-level driver should send the frame out based on
1032 * configuration in the TX control data. This handler should,
1033 * preferably, never fail and stop queues appropriately, more
1034 * importantly, however, it must never fail for A-MPDU-queues.
1035 * Must be implemented and atomic.
1037 * @start: Called before the first netdevice attached to the hardware
1038 * is enabled. This should turn on the hardware and must turn on
1039 * frame reception (for possibly enabled monitor interfaces.)
1040 * Returns negative error codes, these may be seen in userspace,
1042 * When the device is started it should not have a MAC address
1043 * to avoid acknowledging frames before a non-monitor device
1045 * Must be implemented.
1047 * @stop: Called after last netdevice attached to the hardware
1048 * is disabled. This should turn off the hardware (at least
1049 * it must turn off frame reception.)
1050 * May be called right after add_interface if that rejects
1052 * Must be implemented.
1054 * @add_interface: Called when a netdevice attached to the hardware is
1055 * enabled. Because it is not called for monitor mode devices, @open
1056 * and @stop must be implemented.
1057 * The driver should perform any initialization it needs before
1058 * the device can be enabled. The initial configuration for the
1059 * interface is given in the conf parameter.
1060 * The callback may refuse to add an interface by returning a
1061 * negative error code (which will be seen in userspace.)
1062 * Must be implemented.
1064 * @remove_interface: Notifies a driver that an interface is going down.
1065 * The @stop callback is called after this if it is the last interface
1066 * and no monitor interfaces are present.
1067 * When all interfaces are removed, the MAC address in the hardware
1068 * must be cleared so the device no longer acknowledges packets,
1069 * the mac_addr member of the conf structure is, however, set to the
1070 * MAC address of the device going away.
1071 * Hence, this callback must be implemented.
1073 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1074 * function to change hardware configuration, e.g., channel.
1076 * @config_interface: Handler for configuration requests related to interfaces
1077 * (e.g. BSSID changes.)
1079 * @bss_info_changed: Handler for configuration requests related to BSS
1080 * parameters that may vary during BSS's lifespan, and may affect low
1081 * level driver (e.g. assoc/disassoc status, erp parameters).
1082 * This function should not be used if no BSS has been set, unless
1083 * for association indication. The @changed parameter indicates which
1084 * of the bss parameters has changed when a call is made.
1086 * @configure_filter: Configure the device's RX filter.
1087 * See the section "Frame filtering" for more information.
1088 * This callback must be implemented and atomic.
1090 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
1091 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
1092 * mac80211 calls this function when a TIM bit must be set or cleared
1093 * for a given AID. Must be atomic.
1095 * @set_key: See the section "Hardware crypto acceleration"
1096 * This callback can sleep, and is only called between add_interface
1097 * and remove_interface calls, i.e. while the interface with the
1098 * given local_address is enabled.
1100 * @update_tkip_key: See the section "Hardware crypto acceleration"
1101 * This callback will be called in the context of Rx. Called for drivers
1102 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1104 * @hw_scan: Ask the hardware to service the scan request, no need to start
1105 * the scan state machine in stack. The scan must honour the channel
1106 * configuration done by the regulatory agent in the wiphy's registered
1109 * @get_stats: return low-level statistics
1111 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1112 * callback should be provided to read the TKIP transmit IVs (both IV32
1113 * and IV16) for the given key from hardware.
1115 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1117 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1118 * the device does fragmentation by itself; if this method is assigned then
1119 * the stack will not do fragmentation.
1121 * @set_retry_limit: Configuration of retry limits (if device needs it)
1123 * @sta_notify: Notifies low level driver about addition or removal
1124 * of assocaited station or AP.
1126 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1127 * bursting) for a hardware TX queue. Must be atomic.
1129 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1130 * to get number of currently queued packets (queue length), maximum queue
1131 * size (limit), and total number of packets sent using each TX queue
1132 * (count). The 'stats' pointer points to an array that has hw->queues +
1133 * hw->ampdu_queues items.
1135 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1136 * this is only used for IBSS mode debugging and, as such, is not a
1137 * required function. Must be atomic.
1139 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1140 * with other STAs in the IBSS. This is only used in IBSS mode. This
1141 * function is optional if the firmware/hardware takes full care of
1142 * TSF synchronization.
1144 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
1145 * IBSS uses a fixed beacon frame which is configured using this
1147 * If the driver returns success (0) from this callback, it owns
1148 * the skb. That means the driver is responsible to kfree_skb() it.
1149 * The control structure is not dynamically allocated. That means the
1150 * driver does not own the pointer and if it needs it somewhere
1151 * outside of the context of this function, it must copy it
1153 * This handler is required only for IBSS mode.
1155 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1156 * This is needed only for IBSS mode and the result of this function is
1157 * used to determine whether to reply to Probe Requests.
1159 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1161 * @ampdu_action: Perform a certain A-MPDU action
1162 * The RA/TID combination determines the destination and TID we want
1163 * the ampdu action to be performed for. The action is defined through
1164 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1165 * is the first frame we expect to perform the action on. notice
1166 * that TX/RX_STOP can pass NULL for this parameter.
1168 struct ieee80211_ops {
1169 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1170 int (*start)(struct ieee80211_hw *hw);
1171 void (*stop)(struct ieee80211_hw *hw);
1172 int (*add_interface)(struct ieee80211_hw *hw,
1173 struct ieee80211_if_init_conf *conf);
1174 void (*remove_interface)(struct ieee80211_hw *hw,
1175 struct ieee80211_if_init_conf *conf);
1176 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1177 int (*config_interface)(struct ieee80211_hw *hw,
1178 struct ieee80211_vif *vif,
1179 struct ieee80211_if_conf *conf);
1180 void (*bss_info_changed)(struct ieee80211_hw *hw,
1181 struct ieee80211_vif *vif,
1182 struct ieee80211_bss_conf *info,
1184 void (*configure_filter)(struct ieee80211_hw *hw,
1185 unsigned int changed_flags,
1186 unsigned int *total_flags,
1187 int mc_count, struct dev_addr_list *mc_list);
1188 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1189 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1190 const u8 *local_address, const u8 *address,
1191 struct ieee80211_key_conf *key);
1192 void (*update_tkip_key)(struct ieee80211_hw *hw,
1193 struct ieee80211_key_conf *conf, const u8 *address,
1194 u32 iv32, u16 *phase1key);
1195 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1196 int (*get_stats)(struct ieee80211_hw *hw,
1197 struct ieee80211_low_level_stats *stats);
1198 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1199 u32 *iv32, u16 *iv16);
1200 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1201 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1202 int (*set_retry_limit)(struct ieee80211_hw *hw,
1203 u32 short_retry, u32 long_retr);
1204 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1205 enum sta_notify_cmd, const u8 *addr);
1206 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1207 const struct ieee80211_tx_queue_params *params);
1208 int (*get_tx_stats)(struct ieee80211_hw *hw,
1209 struct ieee80211_tx_queue_stats *stats);
1210 u64 (*get_tsf)(struct ieee80211_hw *hw);
1211 void (*reset_tsf)(struct ieee80211_hw *hw);
1212 int (*beacon_update)(struct ieee80211_hw *hw,
1213 struct sk_buff *skb);
1214 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1215 int (*ampdu_action)(struct ieee80211_hw *hw,
1216 enum ieee80211_ampdu_mlme_action action,
1217 const u8 *addr, u16 tid, u16 *ssn);
1221 * ieee80211_alloc_hw - Allocate a new hardware device
1223 * This must be called once for each hardware device. The returned pointer
1224 * must be used to refer to this device when calling other functions.
1225 * mac80211 allocates a private data area for the driver pointed to by
1226 * @priv in &struct ieee80211_hw, the size of this area is given as
1229 * @priv_data_len: length of private data
1230 * @ops: callbacks for this device
1232 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1233 const struct ieee80211_ops *ops);
1236 * ieee80211_register_hw - Register hardware device
1238 * You must call this function before any other functions in
1239 * mac80211. Note that before a hardware can be registered, you
1240 * need to fill the contained wiphy's information.
1242 * @hw: the device to register as returned by ieee80211_alloc_hw()
1244 int ieee80211_register_hw(struct ieee80211_hw *hw);
1246 #ifdef CONFIG_MAC80211_LEDS
1247 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1248 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1249 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1250 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1253 * ieee80211_get_tx_led_name - get name of TX LED
1255 * mac80211 creates a transmit LED trigger for each wireless hardware
1256 * that can be used to drive LEDs if your driver registers a LED device.
1257 * This function returns the name (or %NULL if not configured for LEDs)
1258 * of the trigger so you can automatically link the LED device.
1260 * @hw: the hardware to get the LED trigger name for
1262 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1264 #ifdef CONFIG_MAC80211_LEDS
1265 return __ieee80211_get_tx_led_name(hw);
1272 * ieee80211_get_rx_led_name - get name of RX LED
1274 * mac80211 creates a receive LED trigger for each wireless hardware
1275 * that can be used to drive LEDs if your driver registers a LED device.
1276 * This function returns the name (or %NULL if not configured for LEDs)
1277 * of the trigger so you can automatically link the LED device.
1279 * @hw: the hardware to get the LED trigger name for
1281 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1283 #ifdef CONFIG_MAC80211_LEDS
1284 return __ieee80211_get_rx_led_name(hw);
1291 * ieee80211_get_assoc_led_name - get name of association LED
1293 * mac80211 creates a association LED trigger for each wireless hardware
1294 * that can be used to drive LEDs if your driver registers a LED device.
1295 * This function returns the name (or %NULL if not configured for LEDs)
1296 * of the trigger so you can automatically link the LED device.
1298 * @hw: the hardware to get the LED trigger name for
1300 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1302 #ifdef CONFIG_MAC80211_LEDS
1303 return __ieee80211_get_assoc_led_name(hw);
1310 * ieee80211_get_radio_led_name - get name of radio LED
1312 * mac80211 creates a radio change LED trigger for each wireless hardware
1313 * that can be used to drive LEDs if your driver registers a LED device.
1314 * This function returns the name (or %NULL if not configured for LEDs)
1315 * of the trigger so you can automatically link the LED device.
1317 * @hw: the hardware to get the LED trigger name for
1319 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1321 #ifdef CONFIG_MAC80211_LEDS
1322 return __ieee80211_get_radio_led_name(hw);
1329 * ieee80211_unregister_hw - Unregister a hardware device
1331 * This function instructs mac80211 to free allocated resources
1332 * and unregister netdevices from the networking subsystem.
1334 * @hw: the hardware to unregister
1336 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1339 * ieee80211_free_hw - free hardware descriptor
1341 * This function frees everything that was allocated, including the
1342 * private data for the driver. You must call ieee80211_unregister_hw()
1343 * before calling this function
1345 * @hw: the hardware to free
1347 void ieee80211_free_hw(struct ieee80211_hw *hw);
1349 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1350 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1351 struct ieee80211_rx_status *status);
1354 * ieee80211_rx - receive frame
1356 * Use this function to hand received frames to mac80211. The receive
1357 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1358 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1360 * This function may not be called in IRQ context. Calls to this function
1361 * for a single hardware must be synchronized against each other. Calls
1362 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1365 * @hw: the hardware this frame came in on
1366 * @skb: the buffer to receive, owned by mac80211 after this call
1367 * @status: status of this frame; the status pointer need not be valid
1368 * after this function returns
1370 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1371 struct ieee80211_rx_status *status)
1373 __ieee80211_rx(hw, skb, status);
1377 * ieee80211_rx_irqsafe - receive frame
1379 * Like ieee80211_rx() but can be called in IRQ context
1380 * (internally defers to a tasklet.)
1382 * Calls to this function and ieee80211_rx() may not be mixed for a
1385 * @hw: the hardware this frame came in on
1386 * @skb: the buffer to receive, owned by mac80211 after this call
1387 * @status: status of this frame; the status pointer need not be valid
1388 * after this function returns and is not freed by mac80211,
1389 * it is recommended that it points to a stack area
1391 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1392 struct sk_buff *skb,
1393 struct ieee80211_rx_status *status);
1396 * ieee80211_tx_status - transmit status callback
1398 * Call this function for all transmitted frames after they have been
1399 * transmitted. It is permissible to not call this function for
1400 * multicast frames but this can affect statistics.
1402 * This function may not be called in IRQ context. Calls to this function
1403 * for a single hardware must be synchronized against each other. Calls
1404 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1405 * for a single hardware.
1407 * @hw: the hardware the frame was transmitted by
1408 * @skb: the frame that was transmitted, owned by mac80211 after this call
1410 void ieee80211_tx_status(struct ieee80211_hw *hw,
1411 struct sk_buff *skb);
1414 * ieee80211_tx_status_irqsafe - irq-safe transmit status callback
1416 * Like ieee80211_tx_status() but can be called in IRQ context
1417 * (internally defers to a tasklet.)
1419 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1422 * @hw: the hardware the frame was transmitted by
1423 * @skb: the frame that was transmitted, owned by mac80211 after this call
1425 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1426 struct sk_buff *skb);
1429 * ieee80211_beacon_get - beacon generation function
1430 * @hw: pointer obtained from ieee80211_alloc_hw().
1431 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1432 * @control: will be filled with information needed to send this beacon.
1434 * If the beacon frames are generated by the host system (i.e., not in
1435 * hardware/firmware), the low-level driver uses this function to receive
1436 * the next beacon frame from the 802.11 code. The low-level is responsible
1437 * for calling this function before beacon data is needed (e.g., based on
1438 * hardware interrupt). Returned skb is used only once and low-level driver
1439 * is responsible of freeing it.
1441 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1442 struct ieee80211_vif *vif);
1445 * ieee80211_rts_get - RTS frame generation function
1446 * @hw: pointer obtained from ieee80211_alloc_hw().
1447 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1448 * @frame: pointer to the frame that is going to be protected by the RTS.
1449 * @frame_len: the frame length (in octets).
1450 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1451 * @rts: The buffer where to store the RTS frame.
1453 * If the RTS frames are generated by the host system (i.e., not in
1454 * hardware/firmware), the low-level driver uses this function to receive
1455 * the next RTS frame from the 802.11 code. The low-level is responsible
1456 * for calling this function before and RTS frame is needed.
1458 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1459 const void *frame, size_t frame_len,
1460 const struct ieee80211_tx_info *frame_txctl,
1461 struct ieee80211_rts *rts);
1464 * ieee80211_rts_duration - Get the duration field for an RTS frame
1465 * @hw: pointer obtained from ieee80211_alloc_hw().
1466 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1467 * @frame_len: the length of the frame that is going to be protected by the RTS.
1468 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1470 * If the RTS is generated in firmware, but the host system must provide
1471 * the duration field, the low-level driver uses this function to receive
1472 * the duration field value in little-endian byteorder.
1474 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1475 struct ieee80211_vif *vif, size_t frame_len,
1476 const struct ieee80211_tx_info *frame_txctl);
1479 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1480 * @hw: pointer obtained from ieee80211_alloc_hw().
1481 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1482 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1483 * @frame_len: the frame length (in octets).
1484 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1485 * @cts: The buffer where to store the CTS-to-self frame.
1487 * If the CTS-to-self frames are generated by the host system (i.e., not in
1488 * hardware/firmware), the low-level driver uses this function to receive
1489 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1490 * for calling this function before and CTS-to-self frame is needed.
1492 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1493 struct ieee80211_vif *vif,
1494 const void *frame, size_t frame_len,
1495 const struct ieee80211_tx_info *frame_txctl,
1496 struct ieee80211_cts *cts);
1499 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1500 * @hw: pointer obtained from ieee80211_alloc_hw().
1501 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1502 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1503 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1505 * If the CTS-to-self is generated in firmware, but the host system must provide
1506 * the duration field, the low-level driver uses this function to receive
1507 * the duration field value in little-endian byteorder.
1509 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1510 struct ieee80211_vif *vif,
1512 const struct ieee80211_tx_info *frame_txctl);
1515 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1516 * @hw: pointer obtained from ieee80211_alloc_hw().
1517 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1518 * @frame_len: the length of the frame.
1519 * @rate: the rate at which the frame is going to be transmitted.
1521 * Calculate the duration field of some generic frame, given its
1522 * length and transmission rate (in 100kbps).
1524 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1525 struct ieee80211_vif *vif,
1527 struct ieee80211_rate *rate);
1530 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1531 * @hw: pointer as obtained from ieee80211_alloc_hw().
1532 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1533 * @control: will be filled with information needed to send returned frame.
1535 * Function for accessing buffered broadcast and multicast frames. If
1536 * hardware/firmware does not implement buffering of broadcast/multicast
1537 * frames when power saving is used, 802.11 code buffers them in the host
1538 * memory. The low-level driver uses this function to fetch next buffered
1539 * frame. In most cases, this is used when generating beacon frame. This
1540 * function returns a pointer to the next buffered skb or NULL if no more
1541 * buffered frames are available.
1543 * Note: buffered frames are returned only after DTIM beacon frame was
1544 * generated with ieee80211_beacon_get() and the low-level driver must thus
1545 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1546 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1547 * does not need to check for DTIM beacons separately and should be able to
1548 * use common code for all beacons.
1551 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1554 * ieee80211_get_hdrlen_from_skb - get header length from data
1556 * Given an skb with a raw 802.11 header at the data pointer this function
1557 * returns the 802.11 header length in bytes (not including encryption
1558 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1559 * header the function returns 0.
1563 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1566 * ieee80211_get_hdrlen - get header length from frame control
1568 * This function returns the 802.11 header length in bytes (not including
1569 * encryption headers.)
1571 * @fc: the frame control field (in CPU endianness)
1573 int ieee80211_get_hdrlen(u16 fc);
1576 * ieee80211_hdrlen - get header length in bytes from frame control
1577 * @fc: frame control field in little-endian format
1579 unsigned int ieee80211_hdrlen(__le16 fc);
1582 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1584 * This function computes a TKIP rc4 key for an skb. It computes
1585 * a phase 1 key if needed (iv16 wraps around). This function is to
1586 * be used by drivers which can do HW encryption but need to compute
1587 * to phase 1/2 key in SW.
1589 * @keyconf: the parameter passed with the set key
1590 * @skb: the skb for which the key is needed
1591 * @rc4key: a buffer to which the key will be written
1593 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1594 struct sk_buff *skb,
1595 enum ieee80211_tkip_key_type type, u8 *key);
1597 * ieee80211_wake_queue - wake specific queue
1598 * @hw: pointer as obtained from ieee80211_alloc_hw().
1599 * @queue: queue number (counted from zero).
1601 * Drivers should use this function instead of netif_wake_queue.
1603 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1606 * ieee80211_stop_queue - stop specific queue
1607 * @hw: pointer as obtained from ieee80211_alloc_hw().
1608 * @queue: queue number (counted from zero).
1610 * Drivers should use this function instead of netif_stop_queue.
1612 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1615 * ieee80211_stop_queues - stop all queues
1616 * @hw: pointer as obtained from ieee80211_alloc_hw().
1618 * Drivers should use this function instead of netif_stop_queue.
1620 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1623 * ieee80211_wake_queues - wake all queues
1624 * @hw: pointer as obtained from ieee80211_alloc_hw().
1626 * Drivers should use this function instead of netif_wake_queue.
1628 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1631 * ieee80211_scan_completed - completed hardware scan
1633 * When hardware scan offload is used (i.e. the hw_scan() callback is
1634 * assigned) this function needs to be called by the driver to notify
1635 * mac80211 that the scan finished.
1637 * @hw: the hardware that finished the scan
1639 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1642 * ieee80211_iterate_active_interfaces- iterate active interfaces
1644 * This function iterates over the interfaces associated with a given
1645 * hardware that are currently active and calls the callback for them.
1646 * This function allows the iterator function to sleep, when the iterator
1647 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1650 * @hw: the hardware struct of which the interfaces should be iterated over
1651 * @iterator: the iterator function to call
1652 * @data: first argument of the iterator function
1654 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1655 void (*iterator)(void *data, u8 *mac,
1656 struct ieee80211_vif *vif),
1660 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1662 * This function iterates over the interfaces associated with a given
1663 * hardware that are currently active and calls the callback for them.
1664 * This function requires the iterator callback function to be atomic,
1665 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1667 * @hw: the hardware struct of which the interfaces should be iterated over
1668 * @iterator: the iterator function to call, cannot sleep
1669 * @data: first argument of the iterator function
1671 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1672 void (*iterator)(void *data,
1674 struct ieee80211_vif *vif),
1678 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1679 * @hw: pointer as obtained from ieee80211_alloc_hw().
1680 * @ra: receiver address of the BA session recipient
1681 * @tid: the TID to BA on.
1682 * @return: success if addBA request was sent, failure otherwise
1684 * Although mac80211/low level driver/user space application can estimate
1685 * the need to start aggregation on a certain RA/TID, the session level
1686 * will be managed by the mac80211.
1688 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1691 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1692 * @hw: pointer as obtained from ieee80211_alloc_hw().
1693 * @ra: receiver address of the BA session recipient.
1694 * @tid: the TID to BA on.
1696 * This function must be called by low level driver once it has
1697 * finished with preparations for the BA session.
1699 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1702 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1703 * @hw: pointer as obtained from ieee80211_alloc_hw().
1704 * @ra: receiver address of the BA session recipient.
1705 * @tid: the TID to BA on.
1707 * This function must be called by low level driver once it has
1708 * finished with preparations for the BA session.
1709 * This version of the function is irq safe.
1711 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1715 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1716 * @hw: pointer as obtained from ieee80211_alloc_hw().
1717 * @ra: receiver address of the BA session recipient
1718 * @tid: the TID to stop BA.
1719 * @initiator: if indicates initiator DELBA frame will be sent.
1720 * @return: error if no sta with matching da found, success otherwise
1722 * Although mac80211/low level driver/user space application can estimate
1723 * the need to stop aggregation on a certain RA/TID, the session level
1724 * will be managed by the mac80211.
1726 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1728 enum ieee80211_back_parties initiator);
1731 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1732 * @hw: pointer as obtained from ieee80211_alloc_hw().
1733 * @ra: receiver address of the BA session recipient.
1734 * @tid: the desired TID to BA on.
1736 * This function must be called by low level driver once it has
1737 * finished with preparations for the BA session tear down.
1739 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1742 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1743 * @hw: pointer as obtained from ieee80211_alloc_hw().
1744 * @ra: receiver address of the BA session recipient.
1745 * @tid: the desired TID to BA on.
1747 * This function must be called by low level driver once it has
1748 * finished with preparations for the BA session tear down.
1749 * This version of the function is irq safe.
1751 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1755 * ieee80211_notify_mac - low level driver notification
1756 * @hw: pointer as obtained from ieee80211_alloc_hw().
1757 * @notification_types: enum ieee80211_notification_types
1759 * This function must be called by low level driver to inform mac80211 of
1760 * low level driver status change or force mac80211 to re-assoc for low
1761 * level driver internal error that require re-assoc.
1763 void ieee80211_notify_mac(struct ieee80211_hw *hw,
1764 enum ieee80211_notification_types notif_type);
1765 #endif /* MAC80211_H */