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 function.
47 * If you're reading this document and not the header file itself, it will
48 * be incomplete because not all documentation has been converted yet.
54 * As a general rule, when frames are passed between mac80211 and the driver,
55 * they start with the IEEE 802.11 header and include the same octets that are
56 * sent over the air except for the FCS which should be calculated by the
59 * There are, however, various exceptions to this rule for advanced features:
61 * The first exception is for hardware encryption and decryption offload
62 * where the IV/ICV may or may not be generated in hardware.
64 * Secondly, when the hardware handles fragmentation, the frame handed to
65 * the driver from mac80211 is the MSDU, not the MPDU.
67 * Finally, for received frames, the driver is able to indicate that it has
68 * filled a radiotap header and put that in front of the frame; if it does
69 * not do so then mac80211 may add this under certain circumstances.
72 #define IEEE80211_CHAN_W_SCAN 0x00000001
73 #define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002
74 #define IEEE80211_CHAN_W_IBSS 0x00000004
76 /* Channel information structure. Low-level driver is expected to fill in chan,
77 * freq, and val fields. Other fields will be filled in by 80211.o based on
78 * hostapd information and low-level driver does not need to use them. The
79 * limits for each channel will be provided in 'struct ieee80211_conf' when
80 * configuring the low-level driver with hw->config callback. If a device has
81 * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED
82 * can be set to let the driver configure all fields */
83 struct ieee80211_channel {
84 short chan; /* channel number (IEEE 802.11) */
85 short freq; /* frequency in MHz */
86 int val; /* hw specific value for the channel */
87 int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */
88 unsigned char power_level;
89 unsigned char antenna_max;
92 #define IEEE80211_RATE_ERP 0x00000001
93 #define IEEE80211_RATE_BASIC 0x00000002
94 #define IEEE80211_RATE_PREAMBLE2 0x00000004
95 #define IEEE80211_RATE_SUPPORTED 0x00000010
96 #define IEEE80211_RATE_OFDM 0x00000020
97 #define IEEE80211_RATE_CCK 0x00000040
98 #define IEEE80211_RATE_MANDATORY 0x00000100
100 #define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2)
101 #define IEEE80211_RATE_MODULATION(f) \
102 (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM))
104 /* Low-level driver should set PREAMBLE2, OFDM and CCK flags.
105 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the
107 struct ieee80211_rate {
108 int rate; /* rate in 100 kbps */
109 int val; /* hw specific value for the rate */
110 int flags; /* IEEE80211_RATE_ flags */
111 int val2; /* hw specific value for the rate when using short preamble
112 * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for
113 * 2, 5.5, and 11 Mbps) */
114 signed char min_rssi_ack;
115 unsigned char min_rssi_ack_delta;
117 /* following fields are set by 80211.o and need not be filled by the
118 * low-level driver */
119 int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for
120 * optimizing channel utilization estimates */
124 * enum ieee80211_phymode - PHY modes
126 * @MODE_IEEE80211A: 5GHz as defined by 802.11a/802.11h
127 * @MODE_IEEE80211B: 2.4 GHz as defined by 802.11b
128 * @MODE_IEEE80211G: 2.4 GHz as defined by 802.11g (with OFDM),
129 * backwards compatible with 11b mode
130 * @NUM_IEEE80211_MODES: internal
132 enum ieee80211_phymode {
142 * struct ieee80211_ht_info - describing STA's HT capabilities
144 * This structure describes most essential parameters needed
145 * to describe 802.11n HT capabilities for an STA.
147 * @ht_supported: is HT supported by STA, 0: no, 1: yes
148 * @cap: HT capabilities map as described in 802.11n spec
149 * @ampdu_factor: Maximum A-MPDU length factor
150 * @ampdu_density: Minimum A-MPDU spacing
151 * @supp_mcs_set: Supported MCS set as described in 802.11n spec
153 struct ieee80211_ht_info {
155 u16 cap; /* use IEEE80211_HT_CAP_ */
162 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
164 * This structure describes most essential parameters needed
165 * to describe 802.11n HT characteristics in a BSS
167 * @primary_channel: channel number of primery channel
168 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
169 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
171 struct ieee80211_ht_bss_info {
173 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
174 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
178 * struct ieee80211_hw_mode - PHY mode definition
180 * This structure describes the capabilities supported by the device
181 * in a single PHY mode.
184 * @channels: pointer to array of supported channels
185 * @rates: pointer to array of supported bitrates
186 * @mode: the PHY mode for this definition
187 * @num_channels: number of supported channels
188 * @num_rates: number of supported bitrates
189 * @ht_info: PHY's 802.11n HT abilities for this mode
191 struct ieee80211_hw_mode {
192 struct list_head list;
193 struct ieee80211_channel *channels;
194 struct ieee80211_rate *rates;
195 enum ieee80211_phymode mode;
198 struct ieee80211_ht_info ht_info;
202 * struct ieee80211_tx_queue_params - transmit queue configuration
204 * The information provided in this structure is required for QoS
205 * transmit queue configuration.
207 * @aifs: arbitration interface space [0..255, -1: use default]
208 * @cw_min: minimum contention window [will be a value of the form
209 * 2^n-1 in the range 1..1023; 0: use default]
210 * @cw_max: maximum contention window [like @cw_min]
211 * @burst_time: maximum burst time in units of 0.1ms, 0 meaning disabled
213 struct ieee80211_tx_queue_params {
221 * struct ieee80211_tx_queue_stats_data - transmit queue statistics
223 * @len: number of packets in queue
224 * @limit: queue length limit
225 * @count: number of frames sent
227 struct ieee80211_tx_queue_stats_data {
234 * enum ieee80211_tx_queue - transmit queue number
236 * These constants are used with some callbacks that take a
237 * queue number to set parameters for a queue.
239 * @IEEE80211_TX_QUEUE_DATA0: data queue 0
240 * @IEEE80211_TX_QUEUE_DATA1: data queue 1
241 * @IEEE80211_TX_QUEUE_DATA2: data queue 2
242 * @IEEE80211_TX_QUEUE_DATA3: data queue 3
243 * @IEEE80211_TX_QUEUE_DATA4: data queue 4
244 * @IEEE80211_TX_QUEUE_SVP: ??
245 * @NUM_TX_DATA_QUEUES: number of data queues
246 * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be
247 * sent after a beacon
248 * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames
249 * @NUM_TX_DATA_QUEUES_AMPDU: adding more queues for A-MPDU
251 enum ieee80211_tx_queue {
252 IEEE80211_TX_QUEUE_DATA0,
253 IEEE80211_TX_QUEUE_DATA1,
254 IEEE80211_TX_QUEUE_DATA2,
255 IEEE80211_TX_QUEUE_DATA3,
256 IEEE80211_TX_QUEUE_DATA4,
257 IEEE80211_TX_QUEUE_SVP,
261 /* due to stupidity in the sub-ioctl userspace interface, the items in
262 * this struct need to have fixed values. As soon as it is removed, we can
263 * fix these entries. */
264 IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
265 IEEE80211_TX_QUEUE_BEACON = 7,
266 NUM_TX_DATA_QUEUES_AMPDU = 16
269 struct ieee80211_tx_queue_stats {
270 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES_AMPDU];
273 struct ieee80211_low_level_stats {
274 unsigned int dot11ACKFailureCount;
275 unsigned int dot11RTSFailureCount;
276 unsigned int dot11FCSErrorCount;
277 unsigned int dot11RTSSuccessCount;
281 * enum ieee80211_bss_change - BSS change notification flags
283 * These flags are used with the bss_info_changed() callback
284 * to indicate which BSS parameter changed.
286 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
287 * also implies a change in the AID.
288 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
289 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
291 enum ieee80211_bss_change {
292 BSS_CHANGED_ASSOC = 1<<0,
293 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
294 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
298 * struct ieee80211_bss_conf - holds the BSS's changing parameters
300 * This structure keeps information about a BSS (and an association
301 * to that BSS) that can change during the lifetime of the BSS.
303 * @assoc: association status
304 * @aid: association ID number, valid only when @assoc is true
305 * @use_cts_prot: use CTS protection
306 * @use_short_preamble: use 802.11b short preamble
308 struct ieee80211_bss_conf {
309 /* association related data */
312 /* erp related data */
314 bool use_short_preamble;
317 /* Transmit control fields. This data structure is passed to low-level driver
318 * with each TX frame. The low-level driver is responsible for configuring
319 * the hardware to use given values (depending on what is supported). */
321 struct ieee80211_tx_control {
322 struct ieee80211_vif *vif;
323 int tx_rate; /* Transmit rate, given as the hw specific value for the
324 * rate (from struct ieee80211_rate) */
325 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw
326 * specific value for the rate (from
327 * struct ieee80211_rate) */
329 #define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for
331 #define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without
332 * encryption; e.g., for EAPOL
334 #define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending
336 #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the
337 * frame (e.g., for combined
338 * 802.11g / 802.11b networks) */
339 #define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to
341 #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5)
342 #define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6)
343 #define IEEE80211_TXCTL_REQUEUE (1<<7)
344 #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of
346 #define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
348 * set_retry_limit configured
349 * long retry value */
350 #define IEEE80211_TXCTL_EAPOL_FRAME (1<<11) /* internal to mac80211 */
351 #define IEEE80211_TXCTL_SEND_AFTER_DTIM (1<<12) /* send this frame after DTIM
353 #define IEEE80211_TXCTL_AMPDU (1<<13) /* this frame should be sent
354 * as part of an A-MPDU */
355 u32 flags; /* tx control flags defined
357 u8 key_idx; /* keyidx from hw->set_key(), undefined if
358 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */
359 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, ..
360 * This could be used when set_retry_limit
361 * is not implemented by the driver */
362 u8 power_level; /* per-packet transmit power level, in dBm */
363 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
364 u8 icv_len; /* length of the ICV/MIC field in octets */
365 u8 iv_len; /* length of the IV field in octets */
366 u8 queue; /* hardware queue to use for this frame;
367 * 0 = highest, hw->queues-1 = lowest */
368 struct ieee80211_rate *rate; /* internal 80211.o rate */
369 struct ieee80211_rate *rts_rate; /* internal 80211.o rate
371 int alt_retry_rate; /* retry rate for the last retries, given as the
372 * hw specific value for the rate (from
373 * struct ieee80211_rate). To be used to limit
374 * packet dropping when probing higher rates, if hw
375 * supports multiple retry rates. -1 = not used */
376 int type; /* internal */
381 * enum mac80211_rx_flags - receive flags
383 * These flags are used with the @flag member of &struct ieee80211_rx_status.
384 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
385 * Use together with %RX_FLAG_MMIC_STRIPPED.
386 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
387 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
388 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
389 * verification has been done by the hardware.
390 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
391 * If this flag is set, the stack cannot do any replay detection
392 * hence the driver or hardware will have to do that.
393 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
395 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
397 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
400 enum mac80211_rx_flags {
401 RX_FLAG_MMIC_ERROR = 1<<0,
402 RX_FLAG_DECRYPTED = 1<<1,
403 RX_FLAG_RADIOTAP = 1<<2,
404 RX_FLAG_MMIC_STRIPPED = 1<<3,
405 RX_FLAG_IV_STRIPPED = 1<<4,
406 RX_FLAG_FAILED_FCS_CRC = 1<<5,
407 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
412 * struct ieee80211_rx_status - receive status
414 * The low-level driver should provide this information (the subset
415 * supported by hardware) to the 802.11 code with each received
417 * @mactime: MAC timestamp as defined by 802.11
418 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
419 * @channel: channel the radio was tuned to
420 * @phymode: active PHY mode
421 * @ssi: signal strength when receiving this frame
422 * @signal: used as 'qual' in statistics reporting
423 * @noise: PHY noise when receiving this frame
424 * @antenna: antenna used
428 struct ieee80211_rx_status {
432 enum ieee80211_phymode phymode;
442 * enum ieee80211_tx_status_flags - transmit status flags
444 * Status flags to indicate various transmit conditions.
446 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted
447 * because the destination STA was in powersave mode.
448 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged
449 * @IEEE80211_TX_STATUS_AMPDU: The frame was aggregated, so status
450 * is for the whole aggregation.
452 enum ieee80211_tx_status_flags {
453 IEEE80211_TX_STATUS_TX_FILTERED = 1<<0,
454 IEEE80211_TX_STATUS_ACK = 1<<1,
455 IEEE80211_TX_STATUS_AMPDU = 1<<2,
459 * struct ieee80211_tx_status - transmit status
461 * As much information as possible should be provided for each transmitted
462 * frame with ieee80211_tx_status().
464 * @control: a copy of the &struct ieee80211_tx_control passed to the driver
465 * in the tx() callback.
466 * @flags: transmit status flags, defined above
467 * @retry_count: number of retries
468 * @excessive_retries: set to 1 if the frame was retried many times
469 * but not acknowledged
470 * @ampdu_ack_len: number of aggregated frames.
471 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
472 * @ampdu_ack_map: block ack bit map for the aggregation.
473 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
474 * @ack_signal: signal strength of the ACK frame
475 * @queue_length: ?? REMOVE
476 * @queue_number: ?? REMOVE
478 struct ieee80211_tx_status {
479 struct ieee80211_tx_control control;
482 bool excessive_retries;
491 * enum ieee80211_conf_flags - configuration flags
493 * Flags to define PHY configuration options
495 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
496 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
497 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
499 enum ieee80211_conf_flags {
500 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
501 IEEE80211_CONF_RADIOTAP = (1<<1),
502 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
506 * struct ieee80211_conf - configuration of the device
508 * This struct indicates how the driver shall configure the hardware.
510 * @radio_enabled: when zero, driver is required to switch off the radio.
512 * @channel: IEEE 802.11 channel number
513 * @freq: frequency in MHz
514 * @channel_val: hardware specific channel value for the channel
515 * @phymode: PHY mode to activate (REMOVE)
516 * @chan: channel to switch to, pointer to the channel information
517 * @mode: pointer to mode definition
518 * @regulatory_domain: ??
519 * @beacon_int: beacon interval (TODO make interface config)
520 * @flags: configuration flags defined above
521 * @power_level: transmit power limit for current regulatory domain in dBm
522 * @antenna_max: maximum antenna gain
523 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
525 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
526 * @ht_conf: describes current self configuration of 802.11n HT capabilies
527 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
529 struct ieee80211_conf {
530 int channel; /* IEEE 802.11 channel number */
532 int channel_val; /* hw specific value for the channel */
534 enum ieee80211_phymode phymode;
535 struct ieee80211_channel *chan;
536 struct ieee80211_hw_mode *mode;
537 unsigned int regulatory_domain;
547 struct ieee80211_ht_info ht_conf;
548 struct ieee80211_ht_bss_info ht_bss_conf;
552 * enum ieee80211_if_types - types of 802.11 network interfaces
554 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
556 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
557 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
558 * daemon. Drivers should never see this type.
559 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
560 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
561 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
562 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
563 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
564 * will never see this type.
566 enum ieee80211_if_types {
567 IEEE80211_IF_TYPE_INVALID,
568 IEEE80211_IF_TYPE_AP,
569 IEEE80211_IF_TYPE_STA,
570 IEEE80211_IF_TYPE_IBSS,
571 IEEE80211_IF_TYPE_MNTR,
572 IEEE80211_IF_TYPE_WDS,
573 IEEE80211_IF_TYPE_VLAN,
577 * struct ieee80211_vif - per-interface data
579 * Data in this structure is continually present for driver
580 * use during the life of a virtual interface.
582 * @type: type of this virtual interface
583 * @drv_priv: data area for driver use, will always be aligned to
586 struct ieee80211_vif {
587 enum ieee80211_if_types type;
589 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
593 * struct ieee80211_if_init_conf - initial configuration of an interface
595 * @vif: pointer to a driver-use per-interface structure. The pointer
596 * itself is also used for various functions including
597 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
598 * @type: one of &enum ieee80211_if_types constants. Determines the type of
599 * added/removed interface.
600 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
601 * until the interface is removed (i.e. it cannot be used after
602 * remove_interface() callback was called for this interface).
604 * This structure is used in add_interface() and remove_interface()
605 * callbacks of &struct ieee80211_hw.
607 * When you allow multiple interfaces to be added to your PHY, take care
608 * that the hardware can actually handle multiple MAC addresses. However,
609 * also take care that when there's no interface left with mac_addr != %NULL
610 * you remove the MAC address from the device to avoid acknowledging packets
611 * in pure monitor mode.
613 struct ieee80211_if_init_conf {
614 enum ieee80211_if_types type;
615 struct ieee80211_vif *vif;
620 * struct ieee80211_if_conf - configuration of an interface
622 * @type: type of the interface. This is always the same as was specified in
623 * &struct ieee80211_if_init_conf. The type of an interface never changes
624 * during the life of the interface; this field is present only for
626 * @bssid: BSSID of the network we are associated to/creating.
627 * @ssid: used (together with @ssid_len) by drivers for hardware that
628 * generate beacons independently. The pointer is valid only during the
629 * config_interface() call, so copy the value somewhere if you need
631 * @ssid_len: length of the @ssid field.
632 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
633 * &struct ieee80211_hw is set. The driver is responsible of freeing
635 * @beacon_control: tx_control for the beacon template, this field is only
636 * valid when the @beacon field was set.
638 * This structure is passed to the config_interface() callback of
639 * &struct ieee80211_hw.
641 struct ieee80211_if_conf {
646 struct sk_buff *beacon;
647 struct ieee80211_tx_control *beacon_control;
651 * enum ieee80211_key_alg - key algorithm
652 * @ALG_WEP: WEP40 or WEP104
654 * @ALG_CCMP: CCMP (AES)
656 enum ieee80211_key_alg {
664 * enum ieee80211_key_flags - key flags
666 * These flags are used for communication about keys between the driver
667 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
669 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
670 * that the STA this key will be used with could be using QoS.
671 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
672 * driver to indicate that it requires IV generation for this
674 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
675 * the driver for a TKIP key if it requires Michael MIC
676 * generation in software.
678 enum ieee80211_key_flags {
679 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
680 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
681 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
685 * struct ieee80211_key_conf - key information
687 * This key information is given by mac80211 to the driver by
688 * the set_key() callback in &struct ieee80211_ops.
690 * @hw_key_idx: To be set by the driver, this is the key index the driver
691 * wants to be given when a frame is transmitted and needs to be
692 * encrypted in hardware.
693 * @alg: The key algorithm.
694 * @flags: key flags, see &enum ieee80211_key_flags.
695 * @keyidx: the key index (0-3)
696 * @keylen: key material length
699 struct ieee80211_key_conf {
700 enum ieee80211_key_alg alg;
709 * enum set_key_cmd - key command
711 * Used with the set_key() callback in &struct ieee80211_ops, this
712 * indicates whether a key is being removed or added.
714 * @SET_KEY: a key is set
715 * @DISABLE_KEY: a key must be disabled
718 SET_KEY, DISABLE_KEY,
722 * enum sta_notify_cmd - sta notify command
724 * Used with the sta_notify() callback in &struct ieee80211_ops, this
725 * indicates addition and removal of a station to station table
727 * @STA_NOTIFY_ADD: a station was added to the station table
728 * @STA_NOTIFY_REMOVE: a station being removed from the station table
730 enum sta_notify_cmd {
731 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
735 * enum ieee80211_hw_flags - hardware flags
737 * These flags are used to indicate hardware capabilities to
738 * the stack. Generally, flags here should have their meaning
739 * done in a way that the simplest hardware doesn't need setting
740 * any particular flags. There are some exceptions to this rule,
741 * however, so you are advised to review these flags carefully.
743 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
744 * The device only needs to be supplied with a beacon template.
745 * If you need the host to generate each beacon then don't use
746 * this flag and call ieee80211_beacon_get() when you need the
747 * next beacon frame. Note that if you set this flag, you must
748 * implement the set_tim() callback for powersave mode to work
750 * This flag is only relevant for access-point mode.
752 * @IEEE80211_HW_RX_INCLUDES_FCS:
753 * Indicates that received frames passed to the stack include
754 * the FCS at the end.
756 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
757 * Some wireless LAN chipsets buffer broadcast/multicast frames
758 * for power saving stations in the hardware/firmware and others
759 * rely on the host system for such buffering. This option is used
760 * to configure the IEEE 802.11 upper layer to buffer broadcast and
761 * multicast frames when there are power saving stations so that
762 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
763 * that not setting this flag works properly only when the
764 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
765 * otherwise the stack will not know when the DTIM beacon was sent.
767 * @IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED:
768 * Channels are already configured to the default regulatory domain
769 * specified in the device's EEPROM
771 enum ieee80211_hw_flags {
772 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0,
773 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
774 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
775 IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED = 1<<3,
779 * struct ieee80211_hw - hardware information and state
781 * This structure contains the configuration and hardware
782 * information for an 802.11 PHY.
784 * @wiphy: This points to the &struct wiphy allocated for this
785 * 802.11 PHY. You must fill in the @perm_addr and @dev
786 * members of this structure using SET_IEEE80211_DEV()
787 * and SET_IEEE80211_PERM_ADDR().
789 * @conf: &struct ieee80211_conf, device configuration, don't use.
791 * @workqueue: single threaded workqueue available for driver use,
792 * allocated by mac80211 on registration and flushed on
795 * @priv: pointer to private area that was allocated for driver use
796 * along with this structure.
798 * @flags: hardware flags, see &enum ieee80211_hw_flags.
800 * @extra_tx_headroom: headroom to reserve in each transmit skb
801 * for use by the driver (e.g. for transmit headers.)
803 * @channel_change_time: time (in microseconds) it takes to change channels.
805 * @max_rssi: Maximum value for ssi in RX information, use
806 * negative numbers for dBm and 0 to indicate no support.
808 * @max_signal: like @max_rssi, but for the signal value.
810 * @max_noise: like @max_rssi, but for the noise value.
812 * @queues: number of available hardware transmit queues for
813 * data packets. WMM/QoS requires at least four.
815 * @rate_control_algorithm: rate control algorithm for this hardware.
816 * If unset (NULL), the default algorithm will be used. Must be
817 * set before calling ieee80211_register_hw().
819 * @vif_data_size: size (in bytes) of the drv_priv data area
820 * within &struct ieee80211_vif.
822 struct ieee80211_hw {
823 struct ieee80211_conf conf;
825 struct workqueue_struct *workqueue;
826 const char *rate_control_algorithm;
829 unsigned int extra_tx_headroom;
830 int channel_change_time;
839 * SET_IEEE80211_DEV - set device for 802.11 hardware
841 * @hw: the &struct ieee80211_hw to set the device for
842 * @dev: the &struct device of this 802.11 device
844 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
846 set_wiphy_dev(hw->wiphy, dev);
850 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
852 * @hw: the &struct ieee80211_hw to set the MAC address for
853 * @addr: the address to set
855 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
857 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
861 * DOC: Hardware crypto acceleration
863 * mac80211 is capable of taking advantage of many hardware
864 * acceleration designs for encryption and decryption operations.
866 * The set_key() callback in the &struct ieee80211_ops for a given
867 * device is called to enable hardware acceleration of encryption and
868 * decryption. The callback takes an @address parameter that will be
869 * the broadcast address for default keys, the other station's hardware
870 * address for individual keys or the zero address for keys that will
871 * be used only for transmission.
872 * Multiple transmission keys with the same key index may be used when
873 * VLANs are configured for an access point.
875 * The @local_address parameter will always be set to our own address,
876 * this is only relevant if you support multiple local addresses.
878 * When transmitting, the TX control data will use the @hw_key_idx
879 * selected by the driver by modifying the &struct ieee80211_key_conf
880 * pointed to by the @key parameter to the set_key() function.
882 * The set_key() call for the %SET_KEY command should return 0 if
883 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
884 * added; if you return 0 then hw_key_idx must be assigned to the
885 * hardware key index, you are free to use the full u8 range.
887 * When the cmd is %DISABLE_KEY then it must succeed.
889 * Note that it is permissible to not decrypt a frame even if a key
890 * for it has been uploaded to hardware, the stack will not make any
891 * decision based on whether a key has been uploaded or not but rather
892 * based on the receive flags.
894 * The &struct ieee80211_key_conf structure pointed to by the @key
895 * parameter is guaranteed to be valid until another call to set_key()
896 * removes it, but it can only be used as a cookie to differentiate
901 * DOC: Frame filtering
903 * mac80211 requires to see many management frames for proper
904 * operation, and users may want to see many more frames when
905 * in monitor mode. However, for best CPU usage and power consumption,
906 * having as few frames as possible percolate through the stack is
907 * desirable. Hence, the hardware should filter as much as possible.
909 * To achieve this, mac80211 uses filter flags (see below) to tell
910 * the driver's configure_filter() function which frames should be
911 * passed to mac80211 and which should be filtered out.
913 * The configure_filter() callback is invoked with the parameters
914 * @mc_count and @mc_list for the combined multicast address list
915 * of all virtual interfaces, @changed_flags telling which flags
916 * were changed and @total_flags with the new flag states.
918 * If your device has no multicast address filters your driver will
919 * need to check both the %FIF_ALLMULTI flag and the @mc_count
920 * parameter to see whether multicast frames should be accepted
923 * All unsupported flags in @total_flags must be cleared, i.e. you
924 * should clear all bits except those you honoured.
928 * enum ieee80211_filter_flags - hardware filter flags
930 * These flags determine what the filter in hardware should be
931 * programmed to let through and what should not be passed to the
932 * stack. It is always safe to pass more frames than requested,
933 * but this has negative impact on power consumption.
935 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
936 * think of the BSS as your network segment and then this corresponds
937 * to the regular ethernet device promiscuous mode.
939 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
940 * by the user or if the hardware is not capable of filtering by
943 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
944 * %RX_FLAG_FAILED_FCS_CRC for them)
946 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
947 * the %RX_FLAG_FAILED_PLCP_CRC for them
949 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
950 * to the hardware that it should not filter beacons or probe responses
951 * by BSSID. Filtering them can greatly reduce the amount of processing
952 * mac80211 needs to do and the amount of CPU wakeups, so you should
953 * honour this flag if possible.
955 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
956 * only those addressed to this station
958 * @FIF_OTHER_BSS: pass frames destined to other BSSes
960 enum ieee80211_filter_flags {
961 FIF_PROMISC_IN_BSS = 1<<0,
965 FIF_BCN_PRBRESP_PROMISC = 1<<4,
967 FIF_OTHER_BSS = 1<<6,
971 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
973 * These flags are used with the ampdu_action() callback in
974 * &struct ieee80211_ops to indicate which action is needed.
975 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
976 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
977 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
978 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
980 enum ieee80211_ampdu_mlme_action {
981 IEEE80211_AMPDU_RX_START,
982 IEEE80211_AMPDU_RX_STOP,
983 IEEE80211_AMPDU_TX_START,
984 IEEE80211_AMPDU_TX_STOP,
988 * struct ieee80211_ops - callbacks from mac80211 to the driver
990 * This structure contains various callbacks that the driver may
991 * handle or, in some cases, must handle, for example to configure
992 * the hardware to a new channel or to transmit a frame.
994 * @tx: Handler that 802.11 module calls for each transmitted frame.
995 * skb contains the buffer starting from the IEEE 802.11 header.
996 * The low-level driver should send the frame out based on
997 * configuration in the TX control data. Must be implemented and
1000 * @start: Called before the first netdevice attached to the hardware
1001 * is enabled. This should turn on the hardware and must turn on
1002 * frame reception (for possibly enabled monitor interfaces.)
1003 * Returns negative error codes, these may be seen in userspace,
1005 * When the device is started it should not have a MAC address
1006 * to avoid acknowledging frames before a non-monitor device
1008 * Must be implemented.
1010 * @stop: Called after last netdevice attached to the hardware
1011 * is disabled. This should turn off the hardware (at least
1012 * it must turn off frame reception.)
1013 * May be called right after add_interface if that rejects
1015 * Must be implemented.
1017 * @add_interface: Called when a netdevice attached to the hardware is
1018 * enabled. Because it is not called for monitor mode devices, @open
1019 * and @stop must be implemented.
1020 * The driver should perform any initialization it needs before
1021 * the device can be enabled. The initial configuration for the
1022 * interface is given in the conf parameter.
1023 * The callback may refuse to add an interface by returning a
1024 * negative error code (which will be seen in userspace.)
1025 * Must be implemented.
1027 * @remove_interface: Notifies a driver that an interface is going down.
1028 * The @stop callback is called after this if it is the last interface
1029 * and no monitor interfaces are present.
1030 * When all interfaces are removed, the MAC address in the hardware
1031 * must be cleared so the device no longer acknowledges packets,
1032 * the mac_addr member of the conf structure is, however, set to the
1033 * MAC address of the device going away.
1034 * Hence, this callback must be implemented.
1036 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1037 * function to change hardware configuration, e.g., channel.
1039 * @config_interface: Handler for configuration requests related to interfaces
1040 * (e.g. BSSID changes.)
1042 * @bss_info_changed: Handler for configuration requests related to BSS
1043 * parameters that may vary during BSS's lifespan, and may affect low
1044 * level driver (e.g. assoc/disassoc status, erp parameters).
1045 * This function should not be used if no BSS has been set, unless
1046 * for association indication. The @changed parameter indicates which
1047 * of the bss parameters has changed when a call is made. This callback
1050 * @configure_filter: Configure the device's RX filter.
1051 * See the section "Frame filtering" for more information.
1052 * This callback must be implemented and atomic.
1054 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
1055 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
1056 * mac80211 calls this function when a TIM bit must be set or cleared
1057 * for a given AID. Must be atomic.
1059 * @set_key: See the section "Hardware crypto acceleration"
1060 * This callback can sleep, and is only called between add_interface
1061 * and remove_interface calls, i.e. while the interface with the
1062 * given local_address is enabled.
1064 * @hw_scan: Ask the hardware to service the scan request, no need to start
1065 * the scan state machine in stack.
1067 * @get_stats: return low-level statistics
1069 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1070 * callback should be provided to read the TKIP transmit IVs (both IV32
1071 * and IV16) for the given key from hardware.
1073 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1075 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1076 * the device does fragmentation by itself; if this method is assigned then
1077 * the stack will not do fragmentation.
1079 * @set_retry_limit: Configuration of retry limits (if device needs it)
1081 * @sta_notify: Notifies low level driver about addition or removal
1082 * of assocaited station or AP.
1084 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1085 * bursting) for a hardware TX queue. The @queue parameter uses the
1086 * %IEEE80211_TX_QUEUE_* constants. Must be atomic.
1088 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1089 * to get number of currently queued packets (queue length), maximum queue
1090 * size (limit), and total number of packets sent using each TX queue
1091 * (count). This information is used for WMM to find out which TX
1092 * queues have room for more packets and by hostapd to provide
1093 * statistics about the current queueing state to external programs.
1095 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1096 * this is only used for IBSS mode debugging and, as such, is not a
1097 * required function. Must be atomic.
1099 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1100 * with other STAs in the IBSS. This is only used in IBSS mode. This
1101 * function is optional if the firmware/hardware takes full care of
1102 * TSF synchronization.
1104 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
1105 * IBSS uses a fixed beacon frame which is configured using this
1107 * If the driver returns success (0) from this callback, it owns
1108 * the skb. That means the driver is responsible to kfree_skb() it.
1109 * The control structure is not dynamically allocated. That means the
1110 * driver does not own the pointer and if it needs it somewhere
1111 * outside of the context of this function, it must copy it
1113 * This handler is required only for IBSS mode.
1115 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1116 * This is needed only for IBSS mode and the result of this function is
1117 * used to determine whether to reply to Probe Requests.
1119 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1121 * @ampdu_action: Perform a certain A-MPDU action
1122 * The RA/TID combination determines the destination and TID we want
1123 * the ampdu action to be performed for. The action is defined through
1124 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1125 * is the first frame we expect to perform the action on. notice
1126 * that TX/RX_STOP can pass NULL for this parameter.
1128 struct ieee80211_ops {
1129 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
1130 struct ieee80211_tx_control *control);
1131 int (*start)(struct ieee80211_hw *hw);
1132 void (*stop)(struct ieee80211_hw *hw);
1133 int (*add_interface)(struct ieee80211_hw *hw,
1134 struct ieee80211_if_init_conf *conf);
1135 void (*remove_interface)(struct ieee80211_hw *hw,
1136 struct ieee80211_if_init_conf *conf);
1137 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1138 int (*config_interface)(struct ieee80211_hw *hw,
1139 struct ieee80211_vif *vif,
1140 struct ieee80211_if_conf *conf);
1141 void (*bss_info_changed)(struct ieee80211_hw *hw,
1142 struct ieee80211_vif *vif,
1143 struct ieee80211_bss_conf *info,
1145 void (*configure_filter)(struct ieee80211_hw *hw,
1146 unsigned int changed_flags,
1147 unsigned int *total_flags,
1148 int mc_count, struct dev_addr_list *mc_list);
1149 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1150 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1151 const u8 *local_address, const u8 *address,
1152 struct ieee80211_key_conf *key);
1153 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1154 int (*get_stats)(struct ieee80211_hw *hw,
1155 struct ieee80211_low_level_stats *stats);
1156 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1157 u32 *iv32, u16 *iv16);
1158 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1159 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1160 int (*set_retry_limit)(struct ieee80211_hw *hw,
1161 u32 short_retry, u32 long_retr);
1162 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1163 enum sta_notify_cmd, const u8 *addr);
1164 int (*conf_tx)(struct ieee80211_hw *hw, int queue,
1165 const struct ieee80211_tx_queue_params *params);
1166 int (*get_tx_stats)(struct ieee80211_hw *hw,
1167 struct ieee80211_tx_queue_stats *stats);
1168 u64 (*get_tsf)(struct ieee80211_hw *hw);
1169 void (*reset_tsf)(struct ieee80211_hw *hw);
1170 int (*beacon_update)(struct ieee80211_hw *hw,
1171 struct sk_buff *skb,
1172 struct ieee80211_tx_control *control);
1173 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1174 int (*conf_ht)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1175 int (*ampdu_action)(struct ieee80211_hw *hw,
1176 enum ieee80211_ampdu_mlme_action action,
1177 const u8 *addr, u16 tid, u16 *ssn);
1181 * ieee80211_alloc_hw - Allocate a new hardware device
1183 * This must be called once for each hardware device. The returned pointer
1184 * must be used to refer to this device when calling other functions.
1185 * mac80211 allocates a private data area for the driver pointed to by
1186 * @priv in &struct ieee80211_hw, the size of this area is given as
1189 * @priv_data_len: length of private data
1190 * @ops: callbacks for this device
1192 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1193 const struct ieee80211_ops *ops);
1196 * ieee80211_register_hw - Register hardware device
1198 * You must call this function before any other functions
1199 * except ieee80211_register_hwmode.
1201 * @hw: the device to register as returned by ieee80211_alloc_hw()
1203 int ieee80211_register_hw(struct ieee80211_hw *hw);
1205 #ifdef CONFIG_MAC80211_LEDS
1206 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1207 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1208 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1209 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1212 * ieee80211_get_tx_led_name - get name of TX LED
1214 * mac80211 creates a transmit LED trigger for each wireless hardware
1215 * that can be used to drive LEDs if your driver registers a LED device.
1216 * This function returns the name (or %NULL if not configured for LEDs)
1217 * of the trigger so you can automatically link the LED device.
1219 * @hw: the hardware to get the LED trigger name for
1221 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1223 #ifdef CONFIG_MAC80211_LEDS
1224 return __ieee80211_get_tx_led_name(hw);
1231 * ieee80211_get_rx_led_name - get name of RX LED
1233 * mac80211 creates a receive LED trigger for each wireless hardware
1234 * that can be used to drive LEDs if your driver registers a LED device.
1235 * This function returns the name (or %NULL if not configured for LEDs)
1236 * of the trigger so you can automatically link the LED device.
1238 * @hw: the hardware to get the LED trigger name for
1240 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1242 #ifdef CONFIG_MAC80211_LEDS
1243 return __ieee80211_get_rx_led_name(hw);
1250 * ieee80211_get_assoc_led_name - get name of association LED
1252 * mac80211 creates a association LED trigger for each wireless hardware
1253 * that can be used to drive LEDs if your driver registers a LED device.
1254 * This function returns the name (or %NULL if not configured for LEDs)
1255 * of the trigger so you can automatically link the LED device.
1257 * @hw: the hardware to get the LED trigger name for
1259 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1261 #ifdef CONFIG_MAC80211_LEDS
1262 return __ieee80211_get_assoc_led_name(hw);
1269 * ieee80211_get_radio_led_name - get name of radio LED
1271 * mac80211 creates a radio change LED trigger for each wireless hardware
1272 * that can be used to drive LEDs if your driver registers a LED device.
1273 * This function returns the name (or %NULL if not configured for LEDs)
1274 * of the trigger so you can automatically link the LED device.
1276 * @hw: the hardware to get the LED trigger name for
1278 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1280 #ifdef CONFIG_MAC80211_LEDS
1281 return __ieee80211_get_radio_led_name(hw);
1287 /* Register a new hardware PHYMODE capability to the stack. */
1288 int ieee80211_register_hwmode(struct ieee80211_hw *hw,
1289 struct ieee80211_hw_mode *mode);
1292 * ieee80211_unregister_hw - Unregister a hardware device
1294 * This function instructs mac80211 to free allocated resources
1295 * and unregister netdevices from the networking subsystem.
1297 * @hw: the hardware to unregister
1299 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1302 * ieee80211_free_hw - free hardware descriptor
1304 * This function frees everything that was allocated, including the
1305 * private data for the driver. You must call ieee80211_unregister_hw()
1306 * before calling this function
1308 * @hw: the hardware to free
1310 void ieee80211_free_hw(struct ieee80211_hw *hw);
1312 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1313 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1314 struct ieee80211_rx_status *status);
1317 * ieee80211_rx - receive frame
1319 * Use this function to hand received frames to mac80211. The receive
1320 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1321 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1323 * This function may not be called in IRQ context.
1325 * @hw: the hardware this frame came in on
1326 * @skb: the buffer to receive, owned by mac80211 after this call
1327 * @status: status of this frame; the status pointer need not be valid
1328 * after this function returns
1330 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1331 struct ieee80211_rx_status *status)
1333 __ieee80211_rx(hw, skb, status);
1337 * ieee80211_rx_irqsafe - receive frame
1339 * Like ieee80211_rx() but can be called in IRQ context
1340 * (internally defers to a workqueue.)
1342 * @hw: the hardware this frame came in on
1343 * @skb: the buffer to receive, owned by mac80211 after this call
1344 * @status: status of this frame; the status pointer need not be valid
1345 * after this function returns and is not freed by mac80211,
1346 * it is recommended that it points to a stack area
1348 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1349 struct sk_buff *skb,
1350 struct ieee80211_rx_status *status);
1353 * ieee80211_tx_status - transmit status callback
1355 * Call this function for all transmitted frames after they have been
1356 * transmitted. It is permissible to not call this function for
1357 * multicast frames but this can affect statistics.
1359 * @hw: the hardware the frame was transmitted by
1360 * @skb: the frame that was transmitted, owned by mac80211 after this call
1361 * @status: status information for this frame; the status pointer need not
1362 * be valid after this function returns and is not freed by mac80211,
1363 * it is recommended that it points to a stack area
1365 void ieee80211_tx_status(struct ieee80211_hw *hw,
1366 struct sk_buff *skb,
1367 struct ieee80211_tx_status *status);
1368 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1369 struct sk_buff *skb,
1370 struct ieee80211_tx_status *status);
1373 * ieee80211_beacon_get - beacon generation function
1374 * @hw: pointer obtained from ieee80211_alloc_hw().
1375 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1376 * @control: will be filled with information needed to send this beacon.
1378 * If the beacon frames are generated by the host system (i.e., not in
1379 * hardware/firmware), the low-level driver uses this function to receive
1380 * the next beacon frame from the 802.11 code. The low-level is responsible
1381 * for calling this function before beacon data is needed (e.g., based on
1382 * hardware interrupt). Returned skb is used only once and low-level driver
1383 * is responsible of freeing it.
1385 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1386 struct ieee80211_vif *vif,
1387 struct ieee80211_tx_control *control);
1390 * ieee80211_rts_get - RTS frame generation function
1391 * @hw: pointer obtained from ieee80211_alloc_hw().
1392 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1393 * @frame: pointer to the frame that is going to be protected by the RTS.
1394 * @frame_len: the frame length (in octets).
1395 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1396 * @rts: The buffer where to store the RTS frame.
1398 * If the RTS frames are generated by the host system (i.e., not in
1399 * hardware/firmware), the low-level driver uses this function to receive
1400 * the next RTS frame from the 802.11 code. The low-level is responsible
1401 * for calling this function before and RTS frame is needed.
1403 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1404 const void *frame, size_t frame_len,
1405 const struct ieee80211_tx_control *frame_txctl,
1406 struct ieee80211_rts *rts);
1409 * ieee80211_rts_duration - Get the duration field for an RTS frame
1410 * @hw: pointer obtained from ieee80211_alloc_hw().
1411 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1412 * @frame_len: the length of the frame that is going to be protected by the RTS.
1413 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1415 * If the RTS is generated in firmware, but the host system must provide
1416 * the duration field, the low-level driver uses this function to receive
1417 * the duration field value in little-endian byteorder.
1419 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1420 struct ieee80211_vif *vif, size_t frame_len,
1421 const struct ieee80211_tx_control *frame_txctl);
1424 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1425 * @hw: pointer obtained from ieee80211_alloc_hw().
1426 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1427 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1428 * @frame_len: the frame length (in octets).
1429 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1430 * @cts: The buffer where to store the CTS-to-self frame.
1432 * If the CTS-to-self frames are generated by the host system (i.e., not in
1433 * hardware/firmware), the low-level driver uses this function to receive
1434 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1435 * for calling this function before and CTS-to-self frame is needed.
1437 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1438 struct ieee80211_vif *vif,
1439 const void *frame, size_t frame_len,
1440 const struct ieee80211_tx_control *frame_txctl,
1441 struct ieee80211_cts *cts);
1444 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1445 * @hw: pointer obtained from ieee80211_alloc_hw().
1446 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1447 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1448 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1450 * If the CTS-to-self is generated in firmware, but the host system must provide
1451 * the duration field, the low-level driver uses this function to receive
1452 * the duration field value in little-endian byteorder.
1454 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1455 struct ieee80211_vif *vif,
1457 const struct ieee80211_tx_control *frame_txctl);
1460 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1461 * @hw: pointer obtained from ieee80211_alloc_hw().
1462 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1463 * @frame_len: the length of the frame.
1464 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
1466 * Calculate the duration field of some generic frame, given its
1467 * length and transmission rate (in 100kbps).
1469 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1470 struct ieee80211_vif *vif,
1475 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1476 * @hw: pointer as obtained from ieee80211_alloc_hw().
1477 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1478 * @control: will be filled with information needed to send returned frame.
1480 * Function for accessing buffered broadcast and multicast frames. If
1481 * hardware/firmware does not implement buffering of broadcast/multicast
1482 * frames when power saving is used, 802.11 code buffers them in the host
1483 * memory. The low-level driver uses this function to fetch next buffered
1484 * frame. In most cases, this is used when generating beacon frame. This
1485 * function returns a pointer to the next buffered skb or NULL if no more
1486 * buffered frames are available.
1488 * Note: buffered frames are returned only after DTIM beacon frame was
1489 * generated with ieee80211_beacon_get() and the low-level driver must thus
1490 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1491 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1492 * does not need to check for DTIM beacons separately and should be able to
1493 * use common code for all beacons.
1496 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1497 struct ieee80211_tx_control *control);
1500 * ieee80211_get_hdrlen_from_skb - get header length from data
1502 * Given an skb with a raw 802.11 header at the data pointer this function
1503 * returns the 802.11 header length in bytes (not including encryption
1504 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1505 * header the function returns 0.
1509 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1512 * ieee80211_get_hdrlen - get header length from frame control
1514 * This function returns the 802.11 header length in bytes (not including
1515 * encryption headers.)
1517 * @fc: the frame control field (in CPU endianness)
1519 int ieee80211_get_hdrlen(u16 fc);
1522 * ieee80211_wake_queue - wake specific queue
1523 * @hw: pointer as obtained from ieee80211_alloc_hw().
1524 * @queue: queue number (counted from zero).
1526 * Drivers should use this function instead of netif_wake_queue.
1528 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1531 * ieee80211_stop_queue - stop specific queue
1532 * @hw: pointer as obtained from ieee80211_alloc_hw().
1533 * @queue: queue number (counted from zero).
1535 * Drivers should use this function instead of netif_stop_queue.
1537 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1540 * ieee80211_start_queues - start all queues
1541 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1543 * Drivers should use this function instead of netif_start_queue.
1545 void ieee80211_start_queues(struct ieee80211_hw *hw);
1548 * ieee80211_stop_queues - stop all queues
1549 * @hw: pointer as obtained from ieee80211_alloc_hw().
1551 * Drivers should use this function instead of netif_stop_queue.
1553 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1556 * ieee80211_wake_queues - wake all queues
1557 * @hw: pointer as obtained from ieee80211_alloc_hw().
1559 * Drivers should use this function instead of netif_wake_queue.
1561 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1564 * ieee80211_scan_completed - completed hardware scan
1566 * When hardware scan offload is used (i.e. the hw_scan() callback is
1567 * assigned) this function needs to be called by the driver to notify
1568 * mac80211 that the scan finished.
1570 * @hw: the hardware that finished the scan
1572 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1575 * ieee80211_iterate_active_interfaces - iterate active interfaces
1577 * This function iterates over the interfaces associated with a given
1578 * hardware that are currently active and calls the callback for them.
1580 * @hw: the hardware struct of which the interfaces should be iterated over
1581 * @iterator: the iterator function to call, cannot sleep
1582 * @data: first argument of the iterator function
1584 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1585 void (*iterator)(void *data, u8 *mac,
1586 struct ieee80211_vif *vif),
1590 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1591 * @hw: pointer as obtained from ieee80211_alloc_hw().
1592 * @ra: receiver address of the BA session recipient
1593 * @tid: the TID to BA on.
1594 * @return: success if addBA request was sent, failure otherwise
1596 * Although mac80211/low level driver/user space application can estimate
1597 * the need to start aggregation on a certain RA/TID, the session level
1598 * will be managed by the mac80211.
1600 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1603 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1604 * @hw: pointer as obtained from ieee80211_alloc_hw().
1605 * @ra: receiver address of the BA session recipient.
1606 * @tid: the TID to BA on.
1608 * This function must be called by low level driver once it has
1609 * finished with preparations for the BA session.
1611 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1614 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1615 * @hw: pointer as obtained from ieee80211_alloc_hw().
1616 * @ra: receiver address of the BA session recipient.
1617 * @tid: the TID to BA on.
1619 * This function must be called by low level driver once it has
1620 * finished with preparations for the BA session.
1621 * This version of the function is irq safe.
1623 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1627 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1628 * @hw: pointer as obtained from ieee80211_alloc_hw().
1629 * @ra: receiver address of the BA session recipient
1630 * @tid: the TID to stop BA.
1631 * @initiator: if indicates initiator DELBA frame will be sent.
1632 * @return: error if no sta with matching da found, success otherwise
1634 * Although mac80211/low level driver/user space application can estimate
1635 * the need to stop aggregation on a certain RA/TID, the session level
1636 * will be managed by the mac80211.
1638 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1640 enum ieee80211_back_parties initiator);
1643 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1644 * @hw: pointer as obtained from ieee80211_alloc_hw().
1645 * @ra: receiver address of the BA session recipient.
1646 * @tid: the desired TID to BA on.
1648 * This function must be called by low level driver once it has
1649 * finished with preparations for the BA session tear down.
1651 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1654 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1655 * @hw: pointer as obtained from ieee80211_alloc_hw().
1656 * @ra: receiver address of the BA session recipient.
1657 * @tid: the desired TID to BA on.
1659 * This function must be called by low level driver once it has
1660 * finished with preparations for the BA session tear down.
1661 * This version of the function is irq safe.
1663 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1666 #endif /* MAC80211_H */