2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007 Johannes Berg <johannes@sipsolutions.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
16 #include <linux/kernel.h>
17 #include <linux/if_ether.h>
18 #include <linux/skbuff.h>
19 #include <linux/wireless.h>
20 #include <linux/device.h>
21 #include <linux/ieee80211.h>
22 #include <net/wireless.h>
23 #include <net/cfg80211.h>
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
35 * DOC: Calling mac80211 from interrupts
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-irqsafe functions!
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
63 * There are, however, various exceptions to this rule for advanced features:
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
71 * Finally, for received frames, the driver is able to indicate that it has
72 * filled a radiotap header and put that in front of the frame; if it does
73 * not do so then mac80211 may add this under certain circumstances.
77 * enum ieee80211_notification_type - Low level driver notification
78 * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence
80 enum ieee80211_notification_types {
81 IEEE80211_NOTIFY_RE_ASSOC,
85 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
87 * This structure describes most essential parameters needed
88 * to describe 802.11n HT characteristics in a BSS
90 * @primary_channel: channel number of primery channel
91 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
92 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
94 struct ieee80211_ht_bss_info {
96 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
97 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
101 * struct ieee80211_tx_queue_params - transmit queue configuration
103 * The information provided in this structure is required for QoS
104 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
106 * @aifs: arbitration interface space [0..255, -1: use default]
107 * @cw_min: minimum contention window [will be a value of the form
108 * 2^n-1 in the range 1..1023; 0: use default]
109 * @cw_max: maximum contention window [like @cw_min]
110 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
112 struct ieee80211_tx_queue_params {
120 * struct ieee80211_tx_queue_stats_data - transmit queue statistics
122 * @len: number of packets in queue
123 * @limit: queue length limit
124 * @count: number of frames sent
126 struct ieee80211_tx_queue_stats_data {
133 * enum ieee80211_tx_queue - transmit queue number
135 * These constants are used with some callbacks that take a
136 * queue number to set parameters for a queue.
138 * @IEEE80211_TX_QUEUE_DATA0: data queue 0
139 * @IEEE80211_TX_QUEUE_DATA1: data queue 1
140 * @IEEE80211_TX_QUEUE_DATA2: data queue 2
141 * @IEEE80211_TX_QUEUE_DATA3: data queue 3
142 * @IEEE80211_TX_QUEUE_DATA4: data queue 4
143 * @IEEE80211_TX_QUEUE_SVP: ??
144 * @NUM_TX_DATA_QUEUES: number of data queues
145 * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be
146 * sent after a beacon
147 * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames
148 * @NUM_TX_DATA_QUEUES_AMPDU: adding more queues for A-MPDU
150 enum ieee80211_tx_queue {
151 IEEE80211_TX_QUEUE_DATA0,
152 IEEE80211_TX_QUEUE_DATA1,
153 IEEE80211_TX_QUEUE_DATA2,
154 IEEE80211_TX_QUEUE_DATA3,
155 IEEE80211_TX_QUEUE_DATA4,
156 IEEE80211_TX_QUEUE_SVP,
160 /* due to stupidity in the sub-ioctl userspace interface, the items in
161 * this struct need to have fixed values. As soon as it is removed, we can
162 * fix these entries. */
163 IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
164 IEEE80211_TX_QUEUE_BEACON = 7,
165 NUM_TX_DATA_QUEUES_AMPDU = 16
168 struct ieee80211_tx_queue_stats {
169 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES_AMPDU];
172 struct ieee80211_low_level_stats {
173 unsigned int dot11ACKFailureCount;
174 unsigned int dot11RTSFailureCount;
175 unsigned int dot11FCSErrorCount;
176 unsigned int dot11RTSSuccessCount;
180 * enum ieee80211_bss_change - BSS change notification flags
182 * These flags are used with the bss_info_changed() callback
183 * to indicate which BSS parameter changed.
185 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
186 * also implies a change in the AID.
187 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
188 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
189 * @BSS_CHANGED_HT: 802.11n parameters changed
191 enum ieee80211_bss_change {
192 BSS_CHANGED_ASSOC = 1<<0,
193 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
194 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
195 BSS_CHANGED_HT = 1<<4,
199 * struct ieee80211_bss_conf - holds the BSS's changing parameters
201 * This structure keeps information about a BSS (and an association
202 * to that BSS) that can change during the lifetime of the BSS.
204 * @assoc: association status
205 * @aid: association ID number, valid only when @assoc is true
206 * @use_cts_prot: use CTS protection
207 * @use_short_preamble: use 802.11b short preamble
208 * @timestamp: beacon timestamp
209 * @beacon_int: beacon interval
210 * @assoc_capability: capabbilities taken from assoc resp
211 * @assoc_ht: association in HT mode
212 * @ht_conf: ht capabilities
213 * @ht_bss_conf: ht extended capabilities
215 struct ieee80211_bss_conf {
216 /* association related data */
219 /* erp related data */
221 bool use_short_preamble;
223 u16 assoc_capability;
225 /* ht related data */
227 struct ieee80211_ht_info *ht_conf;
228 struct ieee80211_ht_bss_info *ht_bss_conf;
232 * enum mac80211_tx_control_flags - flags to describe Tx configuration for
235 * These flags are used with the @flags member of &ieee80211_tx_control
237 * @IEEE80211_TXCTL_REQ_TX_STATUS: request TX status callback for this frame.
238 * @IEEE80211_TXCTL_DO_NOT_ENCRYPT: send this frame without encryption;
239 * e.g., for EAPOL frame
240 * @IEEE80211_TXCTL_USE_RTS_CTS: use RTS-CTS before sending frame
241 * @IEEE80211_TXCTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
242 * for combined 802.11g / 802.11b networks)
243 * @IEEE80211_TXCTL_NO_ACK: tell the low level not to wait for an ack
244 * @IEEE80211_TXCTL_RATE_CTRL_PROBE
245 * @EEE80211_TXCTL_CLEAR_PS_FILT: clear powersave filter
246 * for destination station
247 * @IEEE80211_TXCTL_REQUEUE:
248 * @IEEE80211_TXCTL_FIRST_FRAGMENT: this is a first fragment of the frame
249 * @IEEE80211_TXCTL_LONG_RETRY_LIMIT: this frame should be send using the
250 * through set_retry_limit configured long
252 * @IEEE80211_TXCTL_EAPOL_FRAME: internal to mac80211
253 * @IEEE80211_TXCTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
254 * @IEEE80211_TXCTL_AMPDU: this frame should be sent as part of an A-MPDU
255 * @IEEE80211_TXCTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
256 * of streams when this flag is on can be extracted
257 * from antenna_sel_tx, so if 1 antenna is marked
258 * use SISO, 2 antennas marked use MIMO, n antennas
260 * @IEEE80211_TXCTL_GREEN_FIELD: use green field protection for this frame
261 * @IEEE80211_TXCTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
262 * @IEEE80211_TXCTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
263 * @IEEE80211_TXCTL_SHORT_GI: send this frame using short guard interval
265 enum mac80211_tx_control_flags {
266 IEEE80211_TXCTL_REQ_TX_STATUS = (1<<0),
267 IEEE80211_TXCTL_DO_NOT_ENCRYPT = (1<<1),
268 IEEE80211_TXCTL_USE_RTS_CTS = (1<<2),
269 IEEE80211_TXCTL_USE_CTS_PROTECT = (1<<3),
270 IEEE80211_TXCTL_NO_ACK = (1<<4),
271 IEEE80211_TXCTL_RATE_CTRL_PROBE = (1<<5),
272 IEEE80211_TXCTL_CLEAR_PS_FILT = (1<<6),
273 IEEE80211_TXCTL_REQUEUE = (1<<7),
274 IEEE80211_TXCTL_FIRST_FRAGMENT = (1<<8),
275 IEEE80211_TXCTL_SHORT_PREAMBLE = (1<<9),
276 IEEE80211_TXCTL_LONG_RETRY_LIMIT = (1<<10),
277 IEEE80211_TXCTL_EAPOL_FRAME = (1<<11),
278 IEEE80211_TXCTL_SEND_AFTER_DTIM = (1<<12),
279 IEEE80211_TXCTL_AMPDU = (1<<13),
280 IEEE80211_TXCTL_OFDM_HT = (1<<14),
281 IEEE80211_TXCTL_GREEN_FIELD = (1<<15),
282 IEEE80211_TXCTL_40_MHZ_WIDTH = (1<<16),
283 IEEE80211_TXCTL_DUP_DATA = (1<<17),
284 IEEE80211_TXCTL_SHORT_GI = (1<<18),
287 /* Transmit control fields. This data structure is passed to low-level driver
288 * with each TX frame. The low-level driver is responsible for configuring
289 * the hardware to use given values (depending on what is supported). */
291 struct ieee80211_tx_control {
292 struct ieee80211_vif *vif;
293 struct ieee80211_rate *tx_rate;
295 /* Transmit rate for RTS/CTS frame */
296 struct ieee80211_rate *rts_cts_rate;
298 /* retry rate for the last retries */
299 struct ieee80211_rate *alt_retry_rate;
301 u32 flags; /* tx control flags defined above */
302 u8 key_idx; /* keyidx from hw->set_key(), undefined if
303 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */
304 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, ..
305 * This could be used when set_retry_limit
306 * is not implemented by the driver */
307 u8 antenna_sel_tx; /* 0 = default/diversity, otherwise bit
308 * position represents antenna number used */
309 u8 icv_len; /* length of the ICV/MIC field in octets */
310 u8 iv_len; /* length of the IV field in octets */
311 u8 queue; /* hardware queue to use for this frame;
312 * 0 = highest, hw->queues-1 = lowest */
313 u16 aid; /* Station AID */
314 int type; /* internal */
319 * enum mac80211_rx_flags - receive flags
321 * These flags are used with the @flag member of &struct ieee80211_rx_status.
322 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
323 * Use together with %RX_FLAG_MMIC_STRIPPED.
324 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
325 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
326 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
327 * verification has been done by the hardware.
328 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
329 * If this flag is set, the stack cannot do any replay detection
330 * hence the driver or hardware will have to do that.
331 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
333 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
335 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
336 * is valid. This is useful in monitor mode and necessary for beacon frames
337 * to enable IBSS merging.
339 enum mac80211_rx_flags {
340 RX_FLAG_MMIC_ERROR = 1<<0,
341 RX_FLAG_DECRYPTED = 1<<1,
342 RX_FLAG_RADIOTAP = 1<<2,
343 RX_FLAG_MMIC_STRIPPED = 1<<3,
344 RX_FLAG_IV_STRIPPED = 1<<4,
345 RX_FLAG_FAILED_FCS_CRC = 1<<5,
346 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
351 * struct ieee80211_rx_status - receive status
353 * The low-level driver should provide this information (the subset
354 * supported by hardware) to the 802.11 code with each received
356 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
357 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
358 * @band: the active band when this frame was received
359 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
360 * @ssi: signal strength when receiving this frame
361 * @signal: used as 'qual' in statistics reporting
362 * @noise: PHY noise when receiving this frame
363 * @antenna: antenna used
364 * @rate_idx: index of data rate into band's supported rates
367 struct ieee80211_rx_status {
369 enum ieee80211_band band;
380 * enum ieee80211_tx_status_flags - transmit status flags
382 * Status flags to indicate various transmit conditions.
384 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted
385 * because the destination STA was in powersave mode.
386 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged
387 * @IEEE80211_TX_STATUS_AMPDU: The frame was aggregated, so status
388 * is for the whole aggregation.
390 enum ieee80211_tx_status_flags {
391 IEEE80211_TX_STATUS_TX_FILTERED = 1<<0,
392 IEEE80211_TX_STATUS_ACK = 1<<1,
393 IEEE80211_TX_STATUS_AMPDU = 1<<2,
397 * struct ieee80211_tx_status - transmit status
399 * As much information as possible should be provided for each transmitted
400 * frame with ieee80211_tx_status().
402 * @control: a copy of the &struct ieee80211_tx_control passed to the driver
403 * in the tx() callback.
404 * @flags: transmit status flags, defined above
405 * @retry_count: number of retries
406 * @excessive_retries: set to 1 if the frame was retried many times
407 * but not acknowledged
408 * @ampdu_ack_len: number of aggregated frames.
409 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
410 * @ampdu_ack_map: block ack bit map for the aggregation.
411 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
412 * @ack_signal: signal strength of the ACK frame
413 * @queue_length: ?? REMOVE
414 * @queue_number: ?? REMOVE
416 struct ieee80211_tx_status {
417 struct ieee80211_tx_control control;
420 bool excessive_retries;
429 * enum ieee80211_conf_flags - configuration flags
431 * Flags to define PHY configuration options
433 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
434 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
435 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
437 enum ieee80211_conf_flags {
438 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
439 IEEE80211_CONF_RADIOTAP = (1<<1),
440 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
444 * struct ieee80211_conf - configuration of the device
446 * This struct indicates how the driver shall configure the hardware.
448 * @radio_enabled: when zero, driver is required to switch off the radio.
450 * @beacon_int: beacon interval (TODO make interface config)
451 * @flags: configuration flags defined above
452 * @power_level: requested transmit power (in dBm)
453 * @max_antenna_gain: maximum antenna gain (in dBi)
454 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
456 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
457 * @ht_conf: describes current self configuration of 802.11n HT capabilies
458 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
459 * @channel: the channel to tune to
461 struct ieee80211_conf {
467 int max_antenna_gain;
471 struct ieee80211_channel *channel;
473 struct ieee80211_ht_info ht_conf;
474 struct ieee80211_ht_bss_info ht_bss_conf;
478 * enum ieee80211_if_types - types of 802.11 network interfaces
480 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
482 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
483 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
484 * daemon. Drivers should never see this type.
485 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
486 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
487 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
488 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
489 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
490 * will never see this type.
491 * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
493 enum ieee80211_if_types {
494 IEEE80211_IF_TYPE_INVALID,
495 IEEE80211_IF_TYPE_AP,
496 IEEE80211_IF_TYPE_STA,
497 IEEE80211_IF_TYPE_IBSS,
498 IEEE80211_IF_TYPE_MESH_POINT,
499 IEEE80211_IF_TYPE_MNTR,
500 IEEE80211_IF_TYPE_WDS,
501 IEEE80211_IF_TYPE_VLAN,
505 * struct ieee80211_vif - per-interface data
507 * Data in this structure is continually present for driver
508 * use during the life of a virtual interface.
510 * @type: type of this virtual interface
511 * @drv_priv: data area for driver use, will always be aligned to
514 struct ieee80211_vif {
515 enum ieee80211_if_types type;
517 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
520 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
522 #ifdef CONFIG_MAC80211_MESH
523 return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
529 * struct ieee80211_if_init_conf - initial configuration of an interface
531 * @vif: pointer to a driver-use per-interface structure. The pointer
532 * itself is also used for various functions including
533 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
534 * @type: one of &enum ieee80211_if_types constants. Determines the type of
535 * added/removed interface.
536 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
537 * until the interface is removed (i.e. it cannot be used after
538 * remove_interface() callback was called for this interface).
540 * This structure is used in add_interface() and remove_interface()
541 * callbacks of &struct ieee80211_hw.
543 * When you allow multiple interfaces to be added to your PHY, take care
544 * that the hardware can actually handle multiple MAC addresses. However,
545 * also take care that when there's no interface left with mac_addr != %NULL
546 * you remove the MAC address from the device to avoid acknowledging packets
547 * in pure monitor mode.
549 struct ieee80211_if_init_conf {
550 enum ieee80211_if_types type;
551 struct ieee80211_vif *vif;
556 * struct ieee80211_if_conf - configuration of an interface
558 * @type: type of the interface. This is always the same as was specified in
559 * &struct ieee80211_if_init_conf. The type of an interface never changes
560 * during the life of the interface; this field is present only for
562 * @bssid: BSSID of the network we are associated to/creating.
563 * @ssid: used (together with @ssid_len) by drivers for hardware that
564 * generate beacons independently. The pointer is valid only during the
565 * config_interface() call, so copy the value somewhere if you need
567 * @ssid_len: length of the @ssid field.
568 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
569 * &struct ieee80211_hw is set. The driver is responsible of freeing
571 * @beacon_control: tx_control for the beacon template, this field is only
572 * valid when the @beacon field was set.
574 * This structure is passed to the config_interface() callback of
575 * &struct ieee80211_hw.
577 struct ieee80211_if_conf {
582 struct sk_buff *beacon;
583 struct ieee80211_tx_control *beacon_control;
587 * enum ieee80211_key_alg - key algorithm
588 * @ALG_WEP: WEP40 or WEP104
590 * @ALG_CCMP: CCMP (AES)
592 enum ieee80211_key_alg {
600 * enum ieee80211_key_flags - key flags
602 * These flags are used for communication about keys between the driver
603 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
605 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
606 * that the STA this key will be used with could be using QoS.
607 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
608 * driver to indicate that it requires IV generation for this
610 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
611 * the driver for a TKIP key if it requires Michael MIC
612 * generation in software.
614 enum ieee80211_key_flags {
615 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
616 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
617 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
621 * struct ieee80211_key_conf - key information
623 * This key information is given by mac80211 to the driver by
624 * the set_key() callback in &struct ieee80211_ops.
626 * @hw_key_idx: To be set by the driver, this is the key index the driver
627 * wants to be given when a frame is transmitted and needs to be
628 * encrypted in hardware.
629 * @alg: The key algorithm.
630 * @flags: key flags, see &enum ieee80211_key_flags.
631 * @keyidx: the key index (0-3)
632 * @keylen: key material length
635 struct ieee80211_key_conf {
636 enum ieee80211_key_alg alg;
645 * enum set_key_cmd - key command
647 * Used with the set_key() callback in &struct ieee80211_ops, this
648 * indicates whether a key is being removed or added.
650 * @SET_KEY: a key is set
651 * @DISABLE_KEY: a key must be disabled
654 SET_KEY, DISABLE_KEY,
658 * enum sta_notify_cmd - sta notify command
660 * Used with the sta_notify() callback in &struct ieee80211_ops, this
661 * indicates addition and removal of a station to station table
663 * @STA_NOTIFY_ADD: a station was added to the station table
664 * @STA_NOTIFY_REMOVE: a station being removed from the station table
666 enum sta_notify_cmd {
667 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
671 * enum ieee80211_tkip_key_type - get tkip key
673 * Used by drivers which need to get a tkip key for skb. Some drivers need a
674 * phase 1 key, others need a phase 2 key. A single function allows the driver
675 * to get the key, this enum indicates what type of key is required.
677 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
678 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
680 enum ieee80211_tkip_key_type {
681 IEEE80211_TKIP_P1_KEY,
682 IEEE80211_TKIP_P2_KEY,
686 * enum ieee80211_hw_flags - hardware flags
688 * These flags are used to indicate hardware capabilities to
689 * the stack. Generally, flags here should have their meaning
690 * done in a way that the simplest hardware doesn't need setting
691 * any particular flags. There are some exceptions to this rule,
692 * however, so you are advised to review these flags carefully.
694 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
695 * The device only needs to be supplied with a beacon template.
696 * If you need the host to generate each beacon then don't use
697 * this flag and call ieee80211_beacon_get() when you need the
698 * next beacon frame. Note that if you set this flag, you must
699 * implement the set_tim() callback for powersave mode to work
701 * This flag is only relevant for access-point mode.
703 * @IEEE80211_HW_RX_INCLUDES_FCS:
704 * Indicates that received frames passed to the stack include
705 * the FCS at the end.
707 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
708 * Some wireless LAN chipsets buffer broadcast/multicast frames
709 * for power saving stations in the hardware/firmware and others
710 * rely on the host system for such buffering. This option is used
711 * to configure the IEEE 802.11 upper layer to buffer broadcast and
712 * multicast frames when there are power saving stations so that
713 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
714 * that not setting this flag works properly only when the
715 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
716 * otherwise the stack will not know when the DTIM beacon was sent.
718 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
719 * Hardware is not capable of short slot operation on the 2.4 GHz band.
721 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
722 * Hardware is not capable of receiving frames with short preamble on
725 enum ieee80211_hw_flags {
726 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0,
727 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
728 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
729 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
730 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
734 * struct ieee80211_hw - hardware information and state
736 * This structure contains the configuration and hardware
737 * information for an 802.11 PHY.
739 * @wiphy: This points to the &struct wiphy allocated for this
740 * 802.11 PHY. You must fill in the @perm_addr and @dev
741 * members of this structure using SET_IEEE80211_DEV()
742 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
743 * bands (with channels, bitrates) are registered here.
745 * @conf: &struct ieee80211_conf, device configuration, don't use.
747 * @workqueue: single threaded workqueue available for driver use,
748 * allocated by mac80211 on registration and flushed on
751 * @priv: pointer to private area that was allocated for driver use
752 * along with this structure.
754 * @flags: hardware flags, see &enum ieee80211_hw_flags.
756 * @extra_tx_headroom: headroom to reserve in each transmit skb
757 * for use by the driver (e.g. for transmit headers.)
759 * @channel_change_time: time (in microseconds) it takes to change channels.
761 * @max_rssi: Maximum value for ssi in RX information, use
762 * negative numbers for dBm and 0 to indicate no support.
764 * @max_signal: like @max_rssi, but for the signal value.
766 * @max_noise: like @max_rssi, but for the noise value.
768 * @queues: number of available hardware transmit queues for
769 * data packets. WMM/QoS requires at least four.
771 * @rate_control_algorithm: rate control algorithm for this hardware.
772 * If unset (NULL), the default algorithm will be used. Must be
773 * set before calling ieee80211_register_hw().
775 * @vif_data_size: size (in bytes) of the drv_priv data area
776 * within &struct ieee80211_vif.
778 struct ieee80211_hw {
779 struct ieee80211_conf conf;
781 struct workqueue_struct *workqueue;
782 const char *rate_control_algorithm;
785 unsigned int extra_tx_headroom;
786 int channel_change_time;
795 * SET_IEEE80211_DEV - set device for 802.11 hardware
797 * @hw: the &struct ieee80211_hw to set the device for
798 * @dev: the &struct device of this 802.11 device
800 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
802 set_wiphy_dev(hw->wiphy, dev);
806 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
808 * @hw: the &struct ieee80211_hw to set the MAC address for
809 * @addr: the address to set
811 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
813 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
817 * DOC: Hardware crypto acceleration
819 * mac80211 is capable of taking advantage of many hardware
820 * acceleration designs for encryption and decryption operations.
822 * The set_key() callback in the &struct ieee80211_ops for a given
823 * device is called to enable hardware acceleration of encryption and
824 * decryption. The callback takes an @address parameter that will be
825 * the broadcast address for default keys, the other station's hardware
826 * address for individual keys or the zero address for keys that will
827 * be used only for transmission.
828 * Multiple transmission keys with the same key index may be used when
829 * VLANs are configured for an access point.
831 * The @local_address parameter will always be set to our own address,
832 * this is only relevant if you support multiple local addresses.
834 * When transmitting, the TX control data will use the @hw_key_idx
835 * selected by the driver by modifying the &struct ieee80211_key_conf
836 * pointed to by the @key parameter to the set_key() function.
838 * The set_key() call for the %SET_KEY command should return 0 if
839 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
840 * added; if you return 0 then hw_key_idx must be assigned to the
841 * hardware key index, you are free to use the full u8 range.
843 * When the cmd is %DISABLE_KEY then it must succeed.
845 * Note that it is permissible to not decrypt a frame even if a key
846 * for it has been uploaded to hardware, the stack will not make any
847 * decision based on whether a key has been uploaded or not but rather
848 * based on the receive flags.
850 * The &struct ieee80211_key_conf structure pointed to by the @key
851 * parameter is guaranteed to be valid until another call to set_key()
852 * removes it, but it can only be used as a cookie to differentiate
855 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
856 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
858 * The update_tkip_key() call updates the driver with the new phase 1 key.
859 * This happens everytime the iv16 wraps around (every 65536 packets). The
860 * set_key() call will happen only once for each key (unless the AP did
861 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
862 * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
863 * handler is software decryption with wrap around of iv16.
867 * DOC: Frame filtering
869 * mac80211 requires to see many management frames for proper
870 * operation, and users may want to see many more frames when
871 * in monitor mode. However, for best CPU usage and power consumption,
872 * having as few frames as possible percolate through the stack is
873 * desirable. Hence, the hardware should filter as much as possible.
875 * To achieve this, mac80211 uses filter flags (see below) to tell
876 * the driver's configure_filter() function which frames should be
877 * passed to mac80211 and which should be filtered out.
879 * The configure_filter() callback is invoked with the parameters
880 * @mc_count and @mc_list for the combined multicast address list
881 * of all virtual interfaces, @changed_flags telling which flags
882 * were changed and @total_flags with the new flag states.
884 * If your device has no multicast address filters your driver will
885 * need to check both the %FIF_ALLMULTI flag and the @mc_count
886 * parameter to see whether multicast frames should be accepted
889 * All unsupported flags in @total_flags must be cleared.
890 * Hardware does not support a flag if it is incapable of _passing_
891 * the frame to the stack. Otherwise the driver must ignore
892 * the flag, but not clear it.
893 * You must _only_ clear the flag (announce no support for the
894 * flag to mac80211) if you are not able to pass the packet type
895 * to the stack (so the hardware always filters it).
896 * So for example, you should clear @FIF_CONTROL, if your hardware
897 * always filters control frames. If your hardware always passes
898 * control frames to the kernel and is incapable of filtering them,
899 * you do _not_ clear the @FIF_CONTROL flag.
900 * This rule applies to all other FIF flags as well.
904 * enum ieee80211_filter_flags - hardware filter flags
906 * These flags determine what the filter in hardware should be
907 * programmed to let through and what should not be passed to the
908 * stack. It is always safe to pass more frames than requested,
909 * but this has negative impact on power consumption.
911 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
912 * think of the BSS as your network segment and then this corresponds
913 * to the regular ethernet device promiscuous mode.
915 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
916 * by the user or if the hardware is not capable of filtering by
919 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
920 * %RX_FLAG_FAILED_FCS_CRC for them)
922 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
923 * the %RX_FLAG_FAILED_PLCP_CRC for them
925 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
926 * to the hardware that it should not filter beacons or probe responses
927 * by BSSID. Filtering them can greatly reduce the amount of processing
928 * mac80211 needs to do and the amount of CPU wakeups, so you should
929 * honour this flag if possible.
931 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
932 * only those addressed to this station
934 * @FIF_OTHER_BSS: pass frames destined to other BSSes
936 enum ieee80211_filter_flags {
937 FIF_PROMISC_IN_BSS = 1<<0,
941 FIF_BCN_PRBRESP_PROMISC = 1<<4,
943 FIF_OTHER_BSS = 1<<6,
947 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
949 * These flags are used with the ampdu_action() callback in
950 * &struct ieee80211_ops to indicate which action is needed.
951 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
952 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
953 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
954 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
956 enum ieee80211_ampdu_mlme_action {
957 IEEE80211_AMPDU_RX_START,
958 IEEE80211_AMPDU_RX_STOP,
959 IEEE80211_AMPDU_TX_START,
960 IEEE80211_AMPDU_TX_STOP,
964 * struct ieee80211_ops - callbacks from mac80211 to the driver
966 * This structure contains various callbacks that the driver may
967 * handle or, in some cases, must handle, for example to configure
968 * the hardware to a new channel or to transmit a frame.
970 * @tx: Handler that 802.11 module calls for each transmitted frame.
971 * skb contains the buffer starting from the IEEE 802.11 header.
972 * The low-level driver should send the frame out based on
973 * configuration in the TX control data. Must be implemented and
976 * @start: Called before the first netdevice attached to the hardware
977 * is enabled. This should turn on the hardware and must turn on
978 * frame reception (for possibly enabled monitor interfaces.)
979 * Returns negative error codes, these may be seen in userspace,
981 * When the device is started it should not have a MAC address
982 * to avoid acknowledging frames before a non-monitor device
984 * Must be implemented.
986 * @stop: Called after last netdevice attached to the hardware
987 * is disabled. This should turn off the hardware (at least
988 * it must turn off frame reception.)
989 * May be called right after add_interface if that rejects
991 * Must be implemented.
993 * @add_interface: Called when a netdevice attached to the hardware is
994 * enabled. Because it is not called for monitor mode devices, @open
995 * and @stop must be implemented.
996 * The driver should perform any initialization it needs before
997 * the device can be enabled. The initial configuration for the
998 * interface is given in the conf parameter.
999 * The callback may refuse to add an interface by returning a
1000 * negative error code (which will be seen in userspace.)
1001 * Must be implemented.
1003 * @remove_interface: Notifies a driver that an interface is going down.
1004 * The @stop callback is called after this if it is the last interface
1005 * and no monitor interfaces are present.
1006 * When all interfaces are removed, the MAC address in the hardware
1007 * must be cleared so the device no longer acknowledges packets,
1008 * the mac_addr member of the conf structure is, however, set to the
1009 * MAC address of the device going away.
1010 * Hence, this callback must be implemented.
1012 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1013 * function to change hardware configuration, e.g., channel.
1015 * @config_interface: Handler for configuration requests related to interfaces
1016 * (e.g. BSSID changes.)
1018 * @bss_info_changed: Handler for configuration requests related to BSS
1019 * parameters that may vary during BSS's lifespan, and may affect low
1020 * level driver (e.g. assoc/disassoc status, erp parameters).
1021 * This function should not be used if no BSS has been set, unless
1022 * for association indication. The @changed parameter indicates which
1023 * of the bss parameters has changed when a call is made. This callback
1026 * @configure_filter: Configure the device's RX filter.
1027 * See the section "Frame filtering" for more information.
1028 * This callback must be implemented and atomic.
1030 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
1031 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
1032 * mac80211 calls this function when a TIM bit must be set or cleared
1033 * for a given AID. Must be atomic.
1035 * @set_key: See the section "Hardware crypto acceleration"
1036 * This callback can sleep, and is only called between add_interface
1037 * and remove_interface calls, i.e. while the interface with the
1038 * given local_address is enabled.
1040 * @update_tkip_key: See the section "Hardware crypto acceleration"
1041 * This callback will be called in the context of Rx. Called for drivers
1042 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1044 * @hw_scan: Ask the hardware to service the scan request, no need to start
1045 * the scan state machine in stack. The scan must honour the channel
1046 * configuration done by the regulatory agent in the wiphy's registered
1049 * @get_stats: return low-level statistics
1051 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1052 * callback should be provided to read the TKIP transmit IVs (both IV32
1053 * and IV16) for the given key from hardware.
1055 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1057 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1058 * the device does fragmentation by itself; if this method is assigned then
1059 * the stack will not do fragmentation.
1061 * @set_retry_limit: Configuration of retry limits (if device needs it)
1063 * @sta_notify: Notifies low level driver about addition or removal
1064 * of assocaited station or AP.
1066 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1067 * bursting) for a hardware TX queue. The @queue parameter uses the
1068 * %IEEE80211_TX_QUEUE_* constants. Must be atomic.
1070 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1071 * to get number of currently queued packets (queue length), maximum queue
1072 * size (limit), and total number of packets sent using each TX queue
1073 * (count). This information is used for WMM to find out which TX
1074 * queues have room for more packets and by hostapd to provide
1075 * statistics about the current queueing state to external programs.
1077 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1078 * this is only used for IBSS mode debugging and, as such, is not a
1079 * required function. Must be atomic.
1081 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1082 * with other STAs in the IBSS. This is only used in IBSS mode. This
1083 * function is optional if the firmware/hardware takes full care of
1084 * TSF synchronization.
1086 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
1087 * IBSS uses a fixed beacon frame which is configured using this
1089 * If the driver returns success (0) from this callback, it owns
1090 * the skb. That means the driver is responsible to kfree_skb() it.
1091 * The control structure is not dynamically allocated. That means the
1092 * driver does not own the pointer and if it needs it somewhere
1093 * outside of the context of this function, it must copy it
1095 * This handler is required only for IBSS mode.
1097 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1098 * This is needed only for IBSS mode and the result of this function is
1099 * used to determine whether to reply to Probe Requests.
1101 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1103 * @ampdu_action: Perform a certain A-MPDU action
1104 * The RA/TID combination determines the destination and TID we want
1105 * the ampdu action to be performed for. The action is defined through
1106 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1107 * is the first frame we expect to perform the action on. notice
1108 * that TX/RX_STOP can pass NULL for this parameter.
1110 struct ieee80211_ops {
1111 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
1112 struct ieee80211_tx_control *control);
1113 int (*start)(struct ieee80211_hw *hw);
1114 void (*stop)(struct ieee80211_hw *hw);
1115 int (*add_interface)(struct ieee80211_hw *hw,
1116 struct ieee80211_if_init_conf *conf);
1117 void (*remove_interface)(struct ieee80211_hw *hw,
1118 struct ieee80211_if_init_conf *conf);
1119 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1120 int (*config_interface)(struct ieee80211_hw *hw,
1121 struct ieee80211_vif *vif,
1122 struct ieee80211_if_conf *conf);
1123 void (*bss_info_changed)(struct ieee80211_hw *hw,
1124 struct ieee80211_vif *vif,
1125 struct ieee80211_bss_conf *info,
1127 void (*configure_filter)(struct ieee80211_hw *hw,
1128 unsigned int changed_flags,
1129 unsigned int *total_flags,
1130 int mc_count, struct dev_addr_list *mc_list);
1131 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1132 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1133 const u8 *local_address, const u8 *address,
1134 struct ieee80211_key_conf *key);
1135 void (*update_tkip_key)(struct ieee80211_hw *hw,
1136 struct ieee80211_key_conf *conf, const u8 *address,
1137 u32 iv32, u16 *phase1key);
1138 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1139 int (*get_stats)(struct ieee80211_hw *hw,
1140 struct ieee80211_low_level_stats *stats);
1141 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1142 u32 *iv32, u16 *iv16);
1143 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1144 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1145 int (*set_retry_limit)(struct ieee80211_hw *hw,
1146 u32 short_retry, u32 long_retr);
1147 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1148 enum sta_notify_cmd, const u8 *addr);
1149 int (*conf_tx)(struct ieee80211_hw *hw, int queue,
1150 const struct ieee80211_tx_queue_params *params);
1151 int (*get_tx_stats)(struct ieee80211_hw *hw,
1152 struct ieee80211_tx_queue_stats *stats);
1153 u64 (*get_tsf)(struct ieee80211_hw *hw);
1154 void (*reset_tsf)(struct ieee80211_hw *hw);
1155 int (*beacon_update)(struct ieee80211_hw *hw,
1156 struct sk_buff *skb,
1157 struct ieee80211_tx_control *control);
1158 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1159 int (*ampdu_action)(struct ieee80211_hw *hw,
1160 enum ieee80211_ampdu_mlme_action action,
1161 const u8 *addr, u16 tid, u16 *ssn);
1165 * ieee80211_alloc_hw - Allocate a new hardware device
1167 * This must be called once for each hardware device. The returned pointer
1168 * must be used to refer to this device when calling other functions.
1169 * mac80211 allocates a private data area for the driver pointed to by
1170 * @priv in &struct ieee80211_hw, the size of this area is given as
1173 * @priv_data_len: length of private data
1174 * @ops: callbacks for this device
1176 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1177 const struct ieee80211_ops *ops);
1180 * ieee80211_register_hw - Register hardware device
1182 * You must call this function before any other functions in
1183 * mac80211. Note that before a hardware can be registered, you
1184 * need to fill the contained wiphy's information.
1186 * @hw: the device to register as returned by ieee80211_alloc_hw()
1188 int ieee80211_register_hw(struct ieee80211_hw *hw);
1190 #ifdef CONFIG_MAC80211_LEDS
1191 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1192 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1193 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1194 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1197 * ieee80211_get_tx_led_name - get name of TX LED
1199 * mac80211 creates a transmit LED trigger for each wireless hardware
1200 * that can be used to drive LEDs if your driver registers a LED device.
1201 * This function returns the name (or %NULL if not configured for LEDs)
1202 * of the trigger so you can automatically link the LED device.
1204 * @hw: the hardware to get the LED trigger name for
1206 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1208 #ifdef CONFIG_MAC80211_LEDS
1209 return __ieee80211_get_tx_led_name(hw);
1216 * ieee80211_get_rx_led_name - get name of RX LED
1218 * mac80211 creates a receive LED trigger for each wireless hardware
1219 * that can be used to drive LEDs if your driver registers a LED device.
1220 * This function returns the name (or %NULL if not configured for LEDs)
1221 * of the trigger so you can automatically link the LED device.
1223 * @hw: the hardware to get the LED trigger name for
1225 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1227 #ifdef CONFIG_MAC80211_LEDS
1228 return __ieee80211_get_rx_led_name(hw);
1235 * ieee80211_get_assoc_led_name - get name of association LED
1237 * mac80211 creates a association LED trigger for each wireless hardware
1238 * that can be used to drive LEDs if your driver registers a LED device.
1239 * This function returns the name (or %NULL if not configured for LEDs)
1240 * of the trigger so you can automatically link the LED device.
1242 * @hw: the hardware to get the LED trigger name for
1244 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1246 #ifdef CONFIG_MAC80211_LEDS
1247 return __ieee80211_get_assoc_led_name(hw);
1254 * ieee80211_get_radio_led_name - get name of radio LED
1256 * mac80211 creates a radio change LED trigger for each wireless hardware
1257 * that can be used to drive LEDs if your driver registers a LED device.
1258 * This function returns the name (or %NULL if not configured for LEDs)
1259 * of the trigger so you can automatically link the LED device.
1261 * @hw: the hardware to get the LED trigger name for
1263 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1265 #ifdef CONFIG_MAC80211_LEDS
1266 return __ieee80211_get_radio_led_name(hw);
1273 * ieee80211_unregister_hw - Unregister a hardware device
1275 * This function instructs mac80211 to free allocated resources
1276 * and unregister netdevices from the networking subsystem.
1278 * @hw: the hardware to unregister
1280 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1283 * ieee80211_free_hw - free hardware descriptor
1285 * This function frees everything that was allocated, including the
1286 * private data for the driver. You must call ieee80211_unregister_hw()
1287 * before calling this function
1289 * @hw: the hardware to free
1291 void ieee80211_free_hw(struct ieee80211_hw *hw);
1293 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1294 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1295 struct ieee80211_rx_status *status);
1298 * ieee80211_rx - receive frame
1300 * Use this function to hand received frames to mac80211. The receive
1301 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1302 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1304 * This function may not be called in IRQ context. Calls to this function
1305 * for a single hardware must be synchronized against each other. Calls
1306 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1309 * @hw: the hardware this frame came in on
1310 * @skb: the buffer to receive, owned by mac80211 after this call
1311 * @status: status of this frame; the status pointer need not be valid
1312 * after this function returns
1314 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1315 struct ieee80211_rx_status *status)
1317 __ieee80211_rx(hw, skb, status);
1321 * ieee80211_rx_irqsafe - receive frame
1323 * Like ieee80211_rx() but can be called in IRQ context
1324 * (internally defers to a tasklet.)
1326 * Calls to this function and ieee80211_rx() may not be mixed for a
1329 * @hw: the hardware this frame came in on
1330 * @skb: the buffer to receive, owned by mac80211 after this call
1331 * @status: status of this frame; the status pointer need not be valid
1332 * after this function returns and is not freed by mac80211,
1333 * it is recommended that it points to a stack area
1335 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1336 struct sk_buff *skb,
1337 struct ieee80211_rx_status *status);
1340 * ieee80211_tx_status - transmit status callback
1342 * Call this function for all transmitted frames after they have been
1343 * transmitted. It is permissible to not call this function for
1344 * multicast frames but this can affect statistics.
1346 * This function may not be called in IRQ context. Calls to this function
1347 * for a single hardware must be synchronized against each other. Calls
1348 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1349 * for a single hardware.
1351 * @hw: the hardware the frame was transmitted by
1352 * @skb: the frame that was transmitted, owned by mac80211 after this call
1353 * @status: status information for this frame; the status pointer need not
1354 * be valid after this function returns and is not freed by mac80211,
1355 * it is recommended that it points to a stack area
1357 void ieee80211_tx_status(struct ieee80211_hw *hw,
1358 struct sk_buff *skb,
1359 struct ieee80211_tx_status *status);
1362 * ieee80211_tx_status_irqsafe - irq-safe transmit status callback
1364 * Like ieee80211_tx_status() but can be called in IRQ context
1365 * (internally defers to a tasklet.)
1367 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1370 * @hw: the hardware the frame was transmitted by
1371 * @skb: the frame that was transmitted, owned by mac80211 after this call
1372 * @status: status information for this frame; the status pointer need not
1373 * be valid after this function returns and is not freed by mac80211,
1374 * it is recommended that it points to a stack area
1376 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1377 struct sk_buff *skb,
1378 struct ieee80211_tx_status *status);
1381 * ieee80211_beacon_get - beacon generation function
1382 * @hw: pointer obtained from ieee80211_alloc_hw().
1383 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1384 * @control: will be filled with information needed to send this beacon.
1386 * If the beacon frames are generated by the host system (i.e., not in
1387 * hardware/firmware), the low-level driver uses this function to receive
1388 * the next beacon frame from the 802.11 code. The low-level is responsible
1389 * for calling this function before beacon data is needed (e.g., based on
1390 * hardware interrupt). Returned skb is used only once and low-level driver
1391 * is responsible of freeing it.
1393 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1394 struct ieee80211_vif *vif,
1395 struct ieee80211_tx_control *control);
1398 * ieee80211_rts_get - RTS frame generation function
1399 * @hw: pointer obtained from ieee80211_alloc_hw().
1400 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1401 * @frame: pointer to the frame that is going to be protected by the RTS.
1402 * @frame_len: the frame length (in octets).
1403 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1404 * @rts: The buffer where to store the RTS frame.
1406 * If the RTS frames are generated by the host system (i.e., not in
1407 * hardware/firmware), the low-level driver uses this function to receive
1408 * the next RTS frame from the 802.11 code. The low-level is responsible
1409 * for calling this function before and RTS frame is needed.
1411 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1412 const void *frame, size_t frame_len,
1413 const struct ieee80211_tx_control *frame_txctl,
1414 struct ieee80211_rts *rts);
1417 * ieee80211_rts_duration - Get the duration field for an RTS frame
1418 * @hw: pointer obtained from ieee80211_alloc_hw().
1419 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1420 * @frame_len: the length of the frame that is going to be protected by the RTS.
1421 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1423 * If the RTS is generated in firmware, but the host system must provide
1424 * the duration field, the low-level driver uses this function to receive
1425 * the duration field value in little-endian byteorder.
1427 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1428 struct ieee80211_vif *vif, size_t frame_len,
1429 const struct ieee80211_tx_control *frame_txctl);
1432 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1433 * @hw: pointer obtained from ieee80211_alloc_hw().
1434 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1435 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1436 * @frame_len: the frame length (in octets).
1437 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1438 * @cts: The buffer where to store the CTS-to-self frame.
1440 * If the CTS-to-self frames are generated by the host system (i.e., not in
1441 * hardware/firmware), the low-level driver uses this function to receive
1442 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1443 * for calling this function before and CTS-to-self frame is needed.
1445 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1446 struct ieee80211_vif *vif,
1447 const void *frame, size_t frame_len,
1448 const struct ieee80211_tx_control *frame_txctl,
1449 struct ieee80211_cts *cts);
1452 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1453 * @hw: pointer obtained from ieee80211_alloc_hw().
1454 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1455 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1456 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1458 * If the CTS-to-self is generated in firmware, but the host system must provide
1459 * the duration field, the low-level driver uses this function to receive
1460 * the duration field value in little-endian byteorder.
1462 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1463 struct ieee80211_vif *vif,
1465 const struct ieee80211_tx_control *frame_txctl);
1468 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1469 * @hw: pointer obtained from ieee80211_alloc_hw().
1470 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1471 * @frame_len: the length of the frame.
1472 * @rate: the rate at which the frame is going to be transmitted.
1474 * Calculate the duration field of some generic frame, given its
1475 * length and transmission rate (in 100kbps).
1477 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1478 struct ieee80211_vif *vif,
1480 struct ieee80211_rate *rate);
1483 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1484 * @hw: pointer as obtained from ieee80211_alloc_hw().
1485 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1486 * @control: will be filled with information needed to send returned frame.
1488 * Function for accessing buffered broadcast and multicast frames. If
1489 * hardware/firmware does not implement buffering of broadcast/multicast
1490 * frames when power saving is used, 802.11 code buffers them in the host
1491 * memory. The low-level driver uses this function to fetch next buffered
1492 * frame. In most cases, this is used when generating beacon frame. This
1493 * function returns a pointer to the next buffered skb or NULL if no more
1494 * buffered frames are available.
1496 * Note: buffered frames are returned only after DTIM beacon frame was
1497 * generated with ieee80211_beacon_get() and the low-level driver must thus
1498 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1499 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1500 * does not need to check for DTIM beacons separately and should be able to
1501 * use common code for all beacons.
1504 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1505 struct ieee80211_tx_control *control);
1508 * ieee80211_get_hdrlen_from_skb - get header length from data
1510 * Given an skb with a raw 802.11 header at the data pointer this function
1511 * returns the 802.11 header length in bytes (not including encryption
1512 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1513 * header the function returns 0.
1517 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1520 * ieee80211_get_hdrlen - get header length from frame control
1522 * This function returns the 802.11 header length in bytes (not including
1523 * encryption headers.)
1525 * @fc: the frame control field (in CPU endianness)
1527 int ieee80211_get_hdrlen(u16 fc);
1530 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1532 * This function computes a TKIP rc4 key for an skb. It computes
1533 * a phase 1 key if needed (iv16 wraps around). This function is to
1534 * be used by drivers which can do HW encryption but need to compute
1535 * to phase 1/2 key in SW.
1537 * @keyconf: the parameter passed with the set key
1538 * @skb: the skb for which the key is needed
1539 * @rc4key: a buffer to which the key will be written
1541 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1542 struct sk_buff *skb,
1543 enum ieee80211_tkip_key_type type, u8 *key);
1545 * ieee80211_wake_queue - wake specific queue
1546 * @hw: pointer as obtained from ieee80211_alloc_hw().
1547 * @queue: queue number (counted from zero).
1549 * Drivers should use this function instead of netif_wake_queue.
1551 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1554 * ieee80211_stop_queue - stop specific queue
1555 * @hw: pointer as obtained from ieee80211_alloc_hw().
1556 * @queue: queue number (counted from zero).
1558 * Drivers should use this function instead of netif_stop_queue.
1560 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1563 * ieee80211_start_queues - start all queues
1564 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1566 * Drivers should use this function instead of netif_start_queue.
1568 void ieee80211_start_queues(struct ieee80211_hw *hw);
1571 * ieee80211_stop_queues - stop all queues
1572 * @hw: pointer as obtained from ieee80211_alloc_hw().
1574 * Drivers should use this function instead of netif_stop_queue.
1576 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1579 * ieee80211_wake_queues - wake all queues
1580 * @hw: pointer as obtained from ieee80211_alloc_hw().
1582 * Drivers should use this function instead of netif_wake_queue.
1584 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1587 * ieee80211_scan_completed - completed hardware scan
1589 * When hardware scan offload is used (i.e. the hw_scan() callback is
1590 * assigned) this function needs to be called by the driver to notify
1591 * mac80211 that the scan finished.
1593 * @hw: the hardware that finished the scan
1595 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1598 * ieee80211_iterate_active_interfaces - iterate active interfaces
1600 * This function iterates over the interfaces associated with a given
1601 * hardware that are currently active and calls the callback for them.
1603 * @hw: the hardware struct of which the interfaces should be iterated over
1604 * @iterator: the iterator function to call, cannot sleep
1605 * @data: first argument of the iterator function
1607 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1608 void (*iterator)(void *data, u8 *mac,
1609 struct ieee80211_vif *vif),
1613 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1614 * @hw: pointer as obtained from ieee80211_alloc_hw().
1615 * @ra: receiver address of the BA session recipient
1616 * @tid: the TID to BA on.
1617 * @return: success if addBA request was sent, failure otherwise
1619 * Although mac80211/low level driver/user space application can estimate
1620 * the need to start aggregation on a certain RA/TID, the session level
1621 * will be managed by the mac80211.
1623 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1626 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1627 * @hw: pointer as obtained from ieee80211_alloc_hw().
1628 * @ra: receiver address of the BA session recipient.
1629 * @tid: the TID to BA on.
1631 * This function must be called by low level driver once it has
1632 * finished with preparations for the BA session.
1634 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1637 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1638 * @hw: pointer as obtained from ieee80211_alloc_hw().
1639 * @ra: receiver address of the BA session recipient.
1640 * @tid: the TID to BA on.
1642 * This function must be called by low level driver once it has
1643 * finished with preparations for the BA session.
1644 * This version of the function is irq safe.
1646 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1650 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1651 * @hw: pointer as obtained from ieee80211_alloc_hw().
1652 * @ra: receiver address of the BA session recipient
1653 * @tid: the TID to stop BA.
1654 * @initiator: if indicates initiator DELBA frame will be sent.
1655 * @return: error if no sta with matching da found, success otherwise
1657 * Although mac80211/low level driver/user space application can estimate
1658 * the need to stop aggregation on a certain RA/TID, the session level
1659 * will be managed by the mac80211.
1661 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1663 enum ieee80211_back_parties initiator);
1666 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1667 * @hw: pointer as obtained from ieee80211_alloc_hw().
1668 * @ra: receiver address of the BA session recipient.
1669 * @tid: the desired TID to BA on.
1671 * This function must be called by low level driver once it has
1672 * finished with preparations for the BA session tear down.
1674 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1677 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1678 * @hw: pointer as obtained from ieee80211_alloc_hw().
1679 * @ra: receiver address of the BA session recipient.
1680 * @tid: the desired TID to BA on.
1682 * This function must be called by low level driver once it has
1683 * finished with preparations for the BA session tear down.
1684 * This version of the function is irq safe.
1686 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1690 * ieee80211_notify_mac - low level driver notification
1691 * @hw: pointer as obtained from ieee80211_alloc_hw().
1692 * @notification_types: enum ieee80211_notification_types
1694 * This function must be called by low level driver to inform mac80211 of
1695 * low level driver status change or force mac80211 to re-assoc for low
1696 * level driver internal error that require re-assoc.
1698 void ieee80211_notify_mac(struct ieee80211_hw *hw,
1699 enum ieee80211_notification_types notif_type);
1700 #endif /* MAC80211_H */