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>
25 /* Note! Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
26 * called in hardware interrupt context. The low-level driver must not call any
27 * other functions in hardware interrupt context. If there is a need for such
28 * call, the low-level driver should first ACK the interrupt and perform the
29 * IEEE 802.11 code call after this, e.g., from a scheduled tasklet (in
30 * software interrupt context).
34 * Frame format used when passing frame between low-level hardware drivers
35 * and IEEE 802.11 driver the same as used in the wireless media, i.e.,
36 * buffers start with IEEE 802.11 header and include the same octets that
39 * If hardware uses IEEE 802.3 headers (and perform 802.3 <-> 802.11
40 * conversion in firmware), upper layer 802.11 code needs to be changed to
43 * If the receive frame format is not the same as the real frame sent
44 * on the wireless media (e.g., due to padding etc.), upper layer 802.11 code
45 * could be updated to provide support for such format assuming this would
46 * optimize the performance, e.g., by removing need to re-allocation and
47 * copying of the data.
50 #define IEEE80211_CHAN_W_SCAN 0x00000001
51 #define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002
52 #define IEEE80211_CHAN_W_IBSS 0x00000004
54 /* Channel information structure. Low-level driver is expected to fill in chan,
55 * freq, and val fields. Other fields will be filled in by 80211.o based on
56 * hostapd information and low-level driver does not need to use them. The
57 * limits for each channel will be provided in 'struct ieee80211_conf' when
58 * configuring the low-level driver with hw->config callback. If a device has
59 * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED
60 * can be set to let the driver configure all fields */
61 struct ieee80211_channel {
62 short chan; /* channel number (IEEE 802.11) */
63 short freq; /* frequency in MHz */
64 int val; /* hw specific value for the channel */
65 int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */
66 unsigned char power_level;
67 unsigned char antenna_max;
70 #define IEEE80211_RATE_ERP 0x00000001
71 #define IEEE80211_RATE_BASIC 0x00000002
72 #define IEEE80211_RATE_PREAMBLE2 0x00000004
73 #define IEEE80211_RATE_SUPPORTED 0x00000010
74 #define IEEE80211_RATE_OFDM 0x00000020
75 #define IEEE80211_RATE_CCK 0x00000040
76 #define IEEE80211_RATE_MANDATORY 0x00000100
78 #define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2)
79 #define IEEE80211_RATE_MODULATION(f) \
80 (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM))
82 /* Low-level driver should set PREAMBLE2, OFDM and CCK flags.
83 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the
85 struct ieee80211_rate {
86 int rate; /* rate in 100 kbps */
87 int val; /* hw specific value for the rate */
88 int flags; /* IEEE80211_RATE_ flags */
89 int val2; /* hw specific value for the rate when using short preamble
90 * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for
91 * 2, 5.5, and 11 Mbps) */
92 signed char min_rssi_ack;
93 unsigned char min_rssi_ack_delta;
95 /* following fields are set by 80211.o and need not be filled by the
97 int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for
98 * optimizing channel utilization estimates */
102 * enum ieee80211_phymode - PHY modes
104 * @MODE_IEEE80211A: 5GHz as defined by 802.11a/802.11h
105 * @MODE_IEEE80211B: 2.4 GHz as defined by 802.11b
106 * @MODE_IEEE80211G: 2.4 GHz as defined by 802.11g (with OFDM),
107 * backwards compatible with 11b mode
108 * @NUM_IEEE80211_MODES: internal
110 enum ieee80211_phymode {
120 * struct ieee80211_hw_mode - PHY mode definition
122 * This structure describes the capabilities supported by the device
123 * in a single PHY mode.
125 * @mode: the PHY mode for this definition
126 * @num_channels: number of supported channels
127 * @channels: pointer to array of supported channels
128 * @num_rates: number of supported bitrates
129 * @rates: pointer to array of supported bitrates
132 struct ieee80211_hw_mode {
133 struct list_head list;
134 struct ieee80211_channel *channels;
135 struct ieee80211_rate *rates;
136 enum ieee80211_phymode mode;
142 * struct ieee80211_tx_queue_params - transmit queue configuration
144 * The information provided in this structure is required for QoS
145 * transmit queue configuration.
147 * @aifs: arbitration interface space [0..255, -1: use default]
148 * @cw_min: minimum contention window [will be a value of the form
149 * 2^n-1 in the range 1..1023; 0: use default]
150 * @cw_max: maximum contention window [like @cw_min]
151 * @burst_time: maximum burst time in units of 0.1ms, 0 meaning disabled
153 struct ieee80211_tx_queue_params {
161 * struct ieee80211_tx_queue_stats_data - transmit queue statistics
163 * @len: number of packets in queue
164 * @limit: queue length limit
165 * @count: number of frames sent
167 struct ieee80211_tx_queue_stats_data {
174 * enum ieee80211_tx_queue - transmit queue number
176 * These constants are used with some callbacks that take a
177 * queue number to set parameters for a queue.
179 * @IEEE80211_TX_QUEUE_DATA0: data queue 0
180 * @IEEE80211_TX_QUEUE_DATA1: data queue 1
181 * @IEEE80211_TX_QUEUE_DATA2: data queue 2
182 * @IEEE80211_TX_QUEUE_DATA3: data queue 3
183 * @IEEE80211_TX_QUEUE_DATA4: data queue 4
184 * @IEEE80211_TX_QUEUE_SVP: ??
185 * @NUM_TX_DATA_QUEUES: number of data queues
186 * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be
187 * sent after a beacon
188 * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames
190 enum ieee80211_tx_queue {
191 IEEE80211_TX_QUEUE_DATA0,
192 IEEE80211_TX_QUEUE_DATA1,
193 IEEE80211_TX_QUEUE_DATA2,
194 IEEE80211_TX_QUEUE_DATA3,
195 IEEE80211_TX_QUEUE_DATA4,
196 IEEE80211_TX_QUEUE_SVP,
200 /* due to stupidity in the sub-ioctl userspace interface, the items in
201 * this struct need to have fixed values. As soon as it is removed, we can
202 * fix these entries. */
203 IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
204 IEEE80211_TX_QUEUE_BEACON = 7
207 struct ieee80211_tx_queue_stats {
208 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES];
211 struct ieee80211_low_level_stats {
212 unsigned int dot11ACKFailureCount;
213 unsigned int dot11RTSFailureCount;
214 unsigned int dot11FCSErrorCount;
215 unsigned int dot11RTSSuccessCount;
218 /* Transmit control fields. This data structure is passed to low-level driver
219 * with each TX frame. The low-level driver is responsible for configuring
220 * the hardware to use given values (depending on what is supported). */
222 struct ieee80211_tx_control {
223 int tx_rate; /* Transmit rate, given as the hw specific value for the
224 * rate (from struct ieee80211_rate) */
225 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw
226 * specific value for the rate (from
227 * struct ieee80211_rate) */
229 #define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for
231 #define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without
232 * encryption; e.g., for EAPOL
234 #define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending
236 #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the
237 * frame (e.g., for combined
238 * 802.11g / 802.11b networks) */
239 #define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to
241 #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5)
242 #define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6)
243 #define IEEE80211_TXCTL_REQUEUE (1<<7)
244 #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of
246 #define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
248 * set_retry_limit configured
249 * long retry value */
250 u32 flags; /* tx control flags defined
252 u8 key_idx; /* keyidx from hw->set_key(), undefined if
253 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */
254 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, ..
255 * This could be used when set_retry_limit
256 * is not implemented by the driver */
257 u8 power_level; /* per-packet transmit power level, in dBm */
258 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
259 u8 icv_len; /* length of the ICV/MIC field in octets */
260 u8 iv_len; /* length of the IV field in octets */
261 u8 queue; /* hardware queue to use for this frame;
262 * 0 = highest, hw->queues-1 = lowest */
263 struct ieee80211_rate *rate; /* internal 80211.o rate */
264 struct ieee80211_rate *rts_rate; /* internal 80211.o rate
266 int alt_retry_rate; /* retry rate for the last retries, given as the
267 * hw specific value for the rate (from
268 * struct ieee80211_rate). To be used to limit
269 * packet dropping when probing higher rates, if hw
270 * supports multiple retry rates. -1 = not used */
271 int type; /* internal */
272 int ifindex; /* internal */
277 * enum mac80211_rx_flags - receive flags
279 * These flags are used with the @flag member of &struct ieee80211_rx_status.
280 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
281 * Use together with %RX_FLAG_MMIC_STRIPPED.
282 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
283 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
284 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
285 * verification has been done by the hardware.
286 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
287 * If this flag is set, the stack cannot do any replay detection
288 * hence the driver or hardware will have to do that.
289 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
291 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
294 enum mac80211_rx_flags {
295 RX_FLAG_MMIC_ERROR = 1<<0,
296 RX_FLAG_DECRYPTED = 1<<1,
297 RX_FLAG_RADIOTAP = 1<<2,
298 RX_FLAG_MMIC_STRIPPED = 1<<3,
299 RX_FLAG_IV_STRIPPED = 1<<4,
300 RX_FLAG_FAILED_FCS_CRC = 1<<5,
301 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
305 * struct ieee80211_rx_status - receive status
307 * The low-level driver should provide this information (the subset
308 * supported by hardware) to the 802.11 code with each received
310 * @mactime: MAC timestamp as defined by 802.11
311 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
312 * @channel: channel the radio was tuned to
313 * @phymode: active PHY mode
314 * @ssi: signal strength when receiving this frame
315 * @signal: used as 'qual' in statistics reporting
316 * @noise: PHY noise when receiving this frame
317 * @antenna: antenna used
321 struct ieee80211_rx_status {
325 enum ieee80211_phymode phymode;
335 * enum ieee80211_tx_status_flags - transmit status flags
337 * Status flags to indicate various transmit conditions.
339 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted
340 * because the destination STA was in powersave mode.
342 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged
344 enum ieee80211_tx_status_flags {
345 IEEE80211_TX_STATUS_TX_FILTERED = 1<<0,
346 IEEE80211_TX_STATUS_ACK = 1<<1,
350 * struct ieee80211_tx_status - transmit status
352 * As much information as possible should be provided for each transmitted
353 * frame with ieee80211_tx_status().
355 * @control: a copy of the &struct ieee80211_tx_control passed to the driver
356 * in the tx() callback.
358 * @flags: transmit status flags, defined above
360 * @ack_signal: signal strength of the ACK frame
362 * @excessive_retries: set to 1 if the frame was retried many times
363 * but not acknowledged
365 * @retry_count: number of retries
367 * @queue_length: ?? REMOVE
368 * @queue_number: ?? REMOVE
370 struct ieee80211_tx_status {
371 struct ieee80211_tx_control control;
373 bool excessive_retries;
381 * enum ieee80211_conf_flags - configuration flags
383 * Flags to define PHY configuration options
385 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
386 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
389 enum ieee80211_conf_flags {
390 IEEE80211_CONF_SHORT_SLOT_TIME = 1<<0,
391 IEEE80211_CONF_RADIOTAP = 1<<1,
395 * struct ieee80211_conf - configuration of the device
397 * This struct indicates how the driver shall configure the hardware.
399 * @radio_enabled: when zero, driver is required to switch off the radio.
401 * @channel: IEEE 802.11 channel number
402 * @freq: frequency in MHz
403 * @channel_val: hardware specific channel value for the channel
404 * @phymode: PHY mode to activate (REMOVE)
405 * @chan: channel to switch to, pointer to the channel information
406 * @mode: pointer to mode definition
407 * @regulatory_domain: ??
408 * @beacon_int: beacon interval (TODO make interface config)
409 * @flags: configuration flags defined above
410 * @power_level: transmit power limit for current regulatory domain in dBm
411 * @antenna_max: maximum antenna gain
412 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
414 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
416 struct ieee80211_conf {
417 int channel; /* IEEE 802.11 channel number */
419 int channel_val; /* hw specific value for the channel */
421 enum ieee80211_phymode phymode;
422 struct ieee80211_channel *chan;
423 struct ieee80211_hw_mode *mode;
424 unsigned int regulatory_domain;
436 * enum ieee80211_if_types - types of 802.11 network interfaces
438 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
439 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
440 * daemon. Drivers should never see this type.
441 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
442 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
443 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
444 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
445 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
446 * will never see this type.
448 enum ieee80211_if_types {
449 IEEE80211_IF_TYPE_AP,
450 IEEE80211_IF_TYPE_MGMT,
451 IEEE80211_IF_TYPE_STA,
452 IEEE80211_IF_TYPE_IBSS,
453 IEEE80211_IF_TYPE_MNTR,
454 IEEE80211_IF_TYPE_WDS,
455 IEEE80211_IF_TYPE_VLAN,
459 * struct ieee80211_if_init_conf - initial configuration of an interface
461 * @if_id: internal interface ID. This number has no particular meaning to
462 * drivers and the only allowed usage is to pass it to
463 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions.
464 * This field is not valid for monitor interfaces
465 * (interfaces of %IEEE80211_IF_TYPE_MNTR type).
466 * @type: one of &enum ieee80211_if_types constants. Determines the type of
467 * added/removed interface.
468 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
469 * until the interface is removed (i.e. it cannot be used after
470 * remove_interface() callback was called for this interface).
472 * This structure is used in add_interface() and remove_interface()
473 * callbacks of &struct ieee80211_hw.
475 * When you allow multiple interfaces to be added to your PHY, take care
476 * that the hardware can actually handle multiple MAC addresses. However,
477 * also take care that when there's no interface left with mac_addr != %NULL
478 * you remove the MAC address from the device to avoid acknowledging packets
479 * in pure monitor mode.
481 struct ieee80211_if_init_conf {
488 * struct ieee80211_if_conf - configuration of an interface
490 * @type: type of the interface. This is always the same as was specified in
491 * &struct ieee80211_if_init_conf. The type of an interface never changes
492 * during the life of the interface; this field is present only for
494 * @bssid: BSSID of the network we are associated to/creating.
495 * @ssid: used (together with @ssid_len) by drivers for hardware that
496 * generate beacons independently. The pointer is valid only during the
497 * config_interface() call, so copy the value somewhere if you need
499 * @ssid_len: length of the @ssid field.
500 * @generic_elem: used (together with @generic_elem_len) by drivers for
501 * hardware that generate beacons independently. The pointer is valid
502 * only during the config_interface() call, so copy the value somewhere
504 * @generic_elem_len: length of the generic element.
505 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
506 * &struct ieee80211_hw is set. The driver is responsible of freeing
508 * @beacon_control: tx_control for the beacon template, this field is only
509 * valid when the @beacon field was set.
511 * This structure is passed to the config_interface() callback of
512 * &struct ieee80211_hw.
514 struct ieee80211_if_conf {
520 size_t generic_elem_len;
521 struct sk_buff *beacon;
522 struct ieee80211_tx_control *beacon_control;
526 * enum ieee80211_key_alg - key algorithm
527 * @ALG_NONE: Unset key algorithm, will never be passed to the driver
528 * @ALG_WEP: WEP40 or WEP104
530 * @ALG_CCMP: CCMP (AES)
532 typedef enum ieee80211_key_alg {
541 * enum ieee80211_key_flags - key flags
543 * These flags are used for communication about keys between the driver
544 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
546 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
547 * that the STA this key will be used with could be using QoS.
548 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
549 * driver to indicate that it requires IV generation for this
551 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
552 * the driver for a TKIP key if it requires Michael MIC
553 * generation in software.
555 enum ieee80211_key_flags {
556 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
557 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
558 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
562 * struct ieee80211_key_conf - key information
564 * This key information is given by mac80211 to the driver by
565 * the set_key() callback in &struct ieee80211_ops.
567 * @hw_key_idx: To be set by the driver, this is the key index the driver
568 * wants to be given when a frame is transmitted and needs to be
569 * encrypted in hardware.
570 * @alg: The key algorithm.
571 * @flags: key flags, see &enum ieee80211_key_flags.
572 * @keyidx: the key index (0-3)
573 * @keylen: key material length
576 struct ieee80211_key_conf {
577 ieee80211_key_alg alg;
585 #define IEEE80211_SEQ_COUNTER_RX 0
586 #define IEEE80211_SEQ_COUNTER_TX 1
589 * enum set_key_cmd - key command
591 * Used with the set_key() callback in &struct ieee80211_ops, this
592 * indicates whether a key is being removed or added.
594 * @SET_KEY: a key is set
595 * @DISABLE_KEY: a key must be disabled
597 typedef enum set_key_cmd {
598 SET_KEY, DISABLE_KEY,
603 * enum ieee80211_hw_flags - hardware flags
605 * These flags are used to indicate hardware capabilities to
606 * the stack. Generally, flags here should have their meaning
607 * done in a way that the simplest hardware doesn't need setting
608 * any particular flags. There are some exceptions to this rule,
609 * however, so you are advised to review these flags carefully.
611 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
612 * The device only needs to be supplied with a beacon template.
613 * If you need the host to generate each beacon then don't use
614 * this flag and call ieee80211_beacon_get() when you need the
615 * next beacon frame. Note that if you set this flag, you must
616 * implement the set_tim() callback for powersave mode to work
618 * This flag is only relevant for access-point mode.
620 * @IEEE80211_HW_RX_INCLUDES_FCS:
621 * Indicates that received frames passed to the stack include
622 * the FCS at the end.
624 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
625 * Some wireless LAN chipsets buffer broadcast/multicast frames
626 * for power saving stations in the hardware/firmware and others
627 * rely on the host system for such buffering. This option is used
628 * to configure the IEEE 802.11 upper layer to buffer broadcast and
629 * multicast frames when there are power saving stations so that
630 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
631 * that not setting this flag works properly only when the
632 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
633 * otherwise the stack will not know when the DTIM beacon was sent.
635 * @IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED:
636 * Channels are already configured to the default regulatory domain
637 * specified in the device's EEPROM
639 enum ieee80211_hw_flags {
640 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0,
641 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
642 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
643 IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED = 1<<3,
647 * struct ieee80211_hw - hardware information and state
648 * TODO: move documentation into kernel-doc format
650 struct ieee80211_hw {
651 /* points to the cfg80211 wiphy for this piece. Note
652 * that you must fill in the perm_addr and dev fields
653 * of this structure, use the macros provided below. */
656 /* assigned by mac80211, don't write */
657 struct ieee80211_conf conf;
659 /* Single thread workqueue available for driver use
660 * Allocated by mac80211 on registration */
661 struct workqueue_struct *workqueue;
663 /* Pointer to the private area that was
664 * allocated with this struct for you. */
667 /* The rest is information about your hardware */
669 u32 flags; /* hardware flags defined above */
671 /* Set to the size of a needed device specific skb headroom for TX skbs. */
672 unsigned int extra_tx_headroom;
674 /* This is the time in us to change channels
676 int channel_change_time;
677 /* Maximum values for various statistics.
678 * Leave at 0 to indicate no support. Use negative numbers for dBm. */
683 /* Number of available hardware TX queues for data packets.
684 * WMM requires at least four queues. */
688 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
690 set_wiphy_dev(hw->wiphy, dev);
693 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
695 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
699 * flags for change_filter_flags()
701 * Note that e.g. if PROMISC_IN_BSS is unset then
702 * you should still do MAC address filtering if
703 * possible even if OTHER_BSS is set to indicate
704 * no BSSID filtering should be done.
707 * promiscuous mode within your BSS,
708 * think of the BSS as your network segment and then this corresponds
709 * to the regular ethernet device promiscuous mode
711 #define FIF_PROMISC_IN_BSS 0x01
712 /* show all multicast frames */
713 #define FIF_ALLMULTI 0x02
714 /* show frames with failed FCS, but set RX_FLAG_FAILED_FCS_CRC for them */
715 #define FIF_FCSFAIL 0x04
716 /* show frames with failed PLCP CRC, but set RX_FLAG_FAILED_PLCP_CRC for them */
717 #define FIF_PLCPFAIL 0x08
719 * This flag is set during scanning to indicate to the hardware
720 * that it should not filter beacons or probe responses by BSSID.
722 #define FIF_BCN_PRBRESP_PROMISC 0x10
724 * show control frames, if PROMISC_IN_BSS is not set then
725 * only those addressed to this station
727 #define FIF_CONTROL 0x20
728 /* show frames from other BSSes */
729 #define FIF_OTHER_BSS 0x40
731 /* Configuration block used by the low-level driver to tell the 802.11 code
732 * about supported hardware features and to pass function pointers to callback
734 struct ieee80211_ops {
735 /* Handler that 802.11 module calls for each transmitted frame.
736 * skb contains the buffer starting from the IEEE 802.11 header.
737 * The low-level driver should send the frame out based on
738 * configuration in the TX control data.
740 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
741 struct ieee80211_tx_control *control);
744 * Called before the first netdevice attached to the hardware
745 * is enabled. This should turn on the hardware and must turn on
746 * frame reception (for possibly enabled monitor interfaces.)
747 * Returns negative error codes, these may be seen in userspace,
749 * When the device is started it should not have a MAC address
750 * to avoid acknowledging frames before a non-monitor device
753 * Must be implemented.
755 int (*start)(struct ieee80211_hw *hw);
758 * Called after last netdevice attached to the hardware
759 * is disabled. This should turn off the hardware (at least
760 * it must turn off frame reception.)
761 * May be called right after add_interface if that rejects
764 * Must be implemented.
766 void (*stop)(struct ieee80211_hw *hw);
769 * Called when a netdevice attached to the hardware is enabled.
770 * Because it is not called for monitor mode devices, open()
771 * and stop() must be implemented.
772 * The driver should perform any initialization it needs before
773 * the device can be enabled. The initial configuration for the
774 * interface is given in the conf parameter.
776 * Must be implemented.
778 int (*add_interface)(struct ieee80211_hw *hw,
779 struct ieee80211_if_init_conf *conf);
782 * Notifies a driver that an interface is going down. The stop() handler
783 * is called after this if it is the last interface and no monitor
784 * interfaces are present.
785 * When all interfaces are removed, the MAC address in the hardware
786 * must be cleared so the device no longer acknowledges packets,
787 * the mac_addr member of the conf structure is, however, set to the
788 * MAC address of the device going away.
790 * Hence, this callback must be implemented.
792 void (*remove_interface)(struct ieee80211_hw *hw,
793 struct ieee80211_if_init_conf *conf);
795 /* Handler for configuration requests. IEEE 802.11 code calls this
796 * function to change hardware configuration, e.g., channel. */
797 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
799 /* Handler for configuration requests related to interfaces (e.g.
801 int (*config_interface)(struct ieee80211_hw *hw,
802 int if_id, struct ieee80211_if_conf *conf);
805 * Configure the device's RX filter.
807 * The multicast address filter must be changed if the hardware flags
808 * indicate that one is present.
810 * All unsupported flags in 'total_flags' must be cleared,
811 * clear all bits except those you honoured.
813 * The callback must be implemented and must be atomic.
815 void (*configure_filter)(struct ieee80211_hw *hw,
816 unsigned int changed_flags,
817 unsigned int *total_flags,
818 int mc_count, struct dev_addr_list *mc_list);
820 /* Set TIM bit handler. If the hardware/firmware takes care of beacon
821 * generation, IEEE 802.11 code uses this function to tell the
822 * low-level to set (or clear if set==0) TIM bit for the given aid. If
823 * host system is used to generate beacons, this handler is not used
824 * and low-level driver should set it to NULL.
826 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
829 * Set encryption key.
831 * This is called to enable hardware acceleration of encryption and
832 * decryption. The address will be the broadcast address for default
833 * keys, the other station's hardware address for individual keys or
834 * the zero address for keys that will be used only for transmission.
836 * The local_address parameter will always be set to our own address,
837 * this is only relevant if you support multiple local addresses.
839 * When transmitting, the TX control data will use the hw_key_idx
840 * selected by the low-level driver.
842 * Return 0 if the key is now in use, -EOPNOTSUPP or -ENOSPC if it
843 * couldn't be added; if you return 0 then hw_key_idx must be assigned
844 * to the hardware key index, you are free to use the full u8 range.
846 * When the cmd is DISABLE_KEY then it must succeed.
848 * Note that it is permissible to not decrypt a frame even if a key
849 * for it has been uploaded to hardware, the stack will not make any
850 * decision based on whether a key has been uploaded or not but rather
851 * based on the receive flags.
853 * This callback can sleep, and is only called between add_interface
854 * and remove_interface calls, i.e. while the interface with the
855 * given local_address is enabled.
857 * The ieee80211_key_conf structure pointed to by the key parameter
858 * is guaranteed to be valid until another call to set_key removes
859 * it, but it can only be used as a cookie to differentiate keys.
861 int (*set_key)(struct ieee80211_hw *hw, set_key_cmd cmd,
862 const u8 *local_address, const u8 *address,
863 struct ieee80211_key_conf *key);
865 /* Enable/disable IEEE 802.1X. This item requests wlan card to pass
866 * unencrypted EAPOL-Key frames even when encryption is configured.
867 * If the wlan card does not require such a configuration, this
868 * function pointer can be set to NULL. */
869 int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x);
871 /* Set port authorization state (IEEE 802.1X PAE) to be authorized
872 * (authorized=1) or unauthorized (authorized=0). This function can be
873 * used if the wlan hardware or low-level driver implements PAE.
874 * 80211.o module will anyway filter frames based on authorization
875 * state, so this function pointer can be NULL if low-level driver does
876 * not require event notification about port state changes.
877 * Currently unused. */
878 int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr,
881 /* Ask the hardware to service the scan request, no need to start
882 * the scan state machine in stack. */
883 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
885 /* return low-level statistics */
886 int (*get_stats)(struct ieee80211_hw *hw,
887 struct ieee80211_low_level_stats *stats);
889 /* For devices that generate their own beacons and probe response
890 * or association responses this updates the state of privacy_invoked
891 * returns 0 for success or an error number */
892 int (*set_privacy_invoked)(struct ieee80211_hw *hw,
893 int privacy_invoked);
895 /* For devices that have internal sequence counters, allow 802.11
896 * code to access the current value of a counter */
897 int (*get_sequence_counter)(struct ieee80211_hw *hw,
898 u8* addr, u8 keyidx, u8 txrx,
899 u32* iv32, u16* iv16);
901 /* Configuration of RTS threshold (if device needs it) */
902 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
904 /* Configuration of fragmentation threshold.
905 * Assign this if the device does fragmentation by itself,
906 * if this method is assigned then the stack will not do
908 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
910 /* Configuration of retry limits (if device needs it) */
911 int (*set_retry_limit)(struct ieee80211_hw *hw,
912 u32 short_retry, u32 long_retr);
914 /* Number of STAs in STA table notification (NULL = disabled).
916 void (*sta_table_notification)(struct ieee80211_hw *hw,
919 /* Handle ERP IE change notifications. Must be atomic. */
920 void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes,
921 int cts_protection, int preamble);
923 /* Flags for the erp_ie_changed changes parameter */
924 #define IEEE80211_ERP_CHANGE_PROTECTION (1<<0) /* protection flag changed */
925 #define IEEE80211_ERP_CHANGE_PREAMBLE (1<<1) /* barker preamble mode changed */
927 /* Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
928 * bursting) for a hardware TX queue.
929 * queue = IEEE80211_TX_QUEUE_*.
931 int (*conf_tx)(struct ieee80211_hw *hw, int queue,
932 const struct ieee80211_tx_queue_params *params);
934 /* Get statistics of the current TX queue status. This is used to get
935 * number of currently queued packets (queue length), maximum queue
936 * size (limit), and total number of packets sent using each TX queue
938 * Currently unused. */
939 int (*get_tx_stats)(struct ieee80211_hw *hw,
940 struct ieee80211_tx_queue_stats *stats);
942 /* Get the current TSF timer value from firmware/hardware. Currently,
943 * this is only used for IBSS mode debugging and, as such, is not a
946 u64 (*get_tsf)(struct ieee80211_hw *hw);
948 /* Reset the TSF timer and allow firmware/hardware to synchronize with
949 * other STAs in the IBSS. This is only used in IBSS mode. This
950 * function is optional if the firmware/hardware takes full care of
951 * TSF synchronization. */
952 void (*reset_tsf)(struct ieee80211_hw *hw);
954 /* Setup beacon data for IBSS beacons. Unlike access point (Master),
955 * IBSS uses a fixed beacon frame which is configured using this
956 * function. This handler is required only for IBSS mode. */
957 int (*beacon_update)(struct ieee80211_hw *hw,
959 struct ieee80211_tx_control *control);
961 /* Determine whether the last IBSS beacon was sent by us. This is
962 * needed only for IBSS mode and the result of this function is used to
963 * determine whether to reply to Probe Requests. */
964 int (*tx_last_beacon)(struct ieee80211_hw *hw);
967 /* Allocate a new hardware device. This must be called once for each
968 * hardware device. The returned pointer must be used to refer to this
969 * device when calling other functions. 802.11 code allocates a private data
970 * area for the low-level driver. The size of this area is given as
973 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
974 const struct ieee80211_ops *ops);
976 /* Register hardware device to the IEEE 802.11 code and kernel. Low-level
977 * drivers must call this function before using any other IEEE 802.11
978 * function except ieee80211_register_hwmode. */
979 int ieee80211_register_hw(struct ieee80211_hw *hw);
981 /* driver can use this and ieee80211_get_rx_led_name to get the
982 * name of the registered LEDs after ieee80211_register_hw
984 * This is useful to set the default trigger on the LED class
985 * device that your driver should export for each LED the device
986 * has, that way the default behaviour will be as expected but
987 * the user can still change it/turn off the LED etc.
989 #ifdef CONFIG_MAC80211_LEDS
990 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
991 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
993 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
995 #ifdef CONFIG_MAC80211_LEDS
996 return __ieee80211_get_tx_led_name(hw);
1002 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1004 #ifdef CONFIG_MAC80211_LEDS
1005 return __ieee80211_get_rx_led_name(hw);
1011 /* Register a new hardware PHYMODE capability to the stack. */
1012 int ieee80211_register_hwmode(struct ieee80211_hw *hw,
1013 struct ieee80211_hw_mode *mode);
1015 /* Unregister a hardware device. This function instructs 802.11 code to free
1016 * allocated resources and unregister netdevices from the kernel. */
1017 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1019 /* Free everything that was allocated including private data of a driver. */
1020 void ieee80211_free_hw(struct ieee80211_hw *hw);
1022 /* Receive frame callback function. The low-level driver uses this function to
1023 * send received frames to the IEEE 802.11 code. Receive buffer (skb) must
1024 * start with IEEE 802.11 header. */
1025 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1026 struct ieee80211_rx_status *status);
1027 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1028 struct sk_buff *skb,
1029 struct ieee80211_rx_status *status);
1031 /* Transmit status callback function. The low-level driver must call this
1032 * function to report transmit status for all the TX frames that had
1033 * req_tx_status set in the transmit control fields. In addition, this should
1034 * be called at least for all unicast frames to provide information for TX rate
1035 * control algorithm. In order to maintain all statistics, this function is
1036 * recommended to be called after each frame, including multicast/broadcast, is
1038 void ieee80211_tx_status(struct ieee80211_hw *hw,
1039 struct sk_buff *skb,
1040 struct ieee80211_tx_status *status);
1041 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1042 struct sk_buff *skb,
1043 struct ieee80211_tx_status *status);
1046 * ieee80211_beacon_get - beacon generation function
1047 * @hw: pointer obtained from ieee80211_alloc_hw().
1048 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1049 * @control: will be filled with information needed to send this beacon.
1051 * If the beacon frames are generated by the host system (i.e., not in
1052 * hardware/firmware), the low-level driver uses this function to receive
1053 * the next beacon frame from the 802.11 code. The low-level is responsible
1054 * for calling this function before beacon data is needed (e.g., based on
1055 * hardware interrupt). Returned skb is used only once and low-level driver
1056 * is responsible of freeing it.
1058 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1060 struct ieee80211_tx_control *control);
1063 * ieee80211_rts_get - RTS frame generation function
1064 * @hw: pointer obtained from ieee80211_alloc_hw().
1065 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1066 * @frame: pointer to the frame that is going to be protected by the RTS.
1067 * @frame_len: the frame length (in octets).
1068 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1069 * @rts: The buffer where to store the RTS frame.
1071 * If the RTS frames are generated by the host system (i.e., not in
1072 * hardware/firmware), the low-level driver uses this function to receive
1073 * the next RTS frame from the 802.11 code. The low-level is responsible
1074 * for calling this function before and RTS frame is needed.
1076 void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id,
1077 const void *frame, size_t frame_len,
1078 const struct ieee80211_tx_control *frame_txctl,
1079 struct ieee80211_rts *rts);
1082 * ieee80211_rts_duration - Get the duration field for an RTS frame
1083 * @hw: pointer obtained from ieee80211_alloc_hw().
1084 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1085 * @frame_len: the length of the frame that is going to be protected by the RTS.
1086 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1088 * If the RTS is generated in firmware, but the host system must provide
1089 * the duration field, the low-level driver uses this function to receive
1090 * the duration field value in little-endian byteorder.
1092 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id,
1094 const struct ieee80211_tx_control *frame_txctl);
1097 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1098 * @hw: pointer obtained from ieee80211_alloc_hw().
1099 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1100 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1101 * @frame_len: the frame length (in octets).
1102 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1103 * @cts: The buffer where to store the CTS-to-self frame.
1105 * If the CTS-to-self frames are generated by the host system (i.e., not in
1106 * hardware/firmware), the low-level driver uses this function to receive
1107 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1108 * for calling this function before and CTS-to-self frame is needed.
1110 void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id,
1111 const void *frame, size_t frame_len,
1112 const struct ieee80211_tx_control *frame_txctl,
1113 struct ieee80211_cts *cts);
1116 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1117 * @hw: pointer obtained from ieee80211_alloc_hw().
1118 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1119 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1120 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1122 * If the CTS-to-self is generated in firmware, but the host system must provide
1123 * the duration field, the low-level driver uses this function to receive
1124 * the duration field value in little-endian byteorder.
1126 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id,
1128 const struct ieee80211_tx_control *frame_txctl);
1131 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1132 * @hw: pointer obtained from ieee80211_alloc_hw().
1133 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1134 * @frame_len: the length of the frame.
1135 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
1137 * Calculate the duration field of some generic frame, given its
1138 * length and transmission rate (in 100kbps).
1140 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id,
1145 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1146 * @hw: pointer as obtained from ieee80211_alloc_hw().
1147 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1148 * @control: will be filled with information needed to send returned frame.
1150 * Function for accessing buffered broadcast and multicast frames. If
1151 * hardware/firmware does not implement buffering of broadcast/multicast
1152 * frames when power saving is used, 802.11 code buffers them in the host
1153 * memory. The low-level driver uses this function to fetch next buffered
1154 * frame. In most cases, this is used when generating beacon frame. This
1155 * function returns a pointer to the next buffered skb or NULL if no more
1156 * buffered frames are available.
1158 * Note: buffered frames are returned only after DTIM beacon frame was
1159 * generated with ieee80211_beacon_get() and the low-level driver must thus
1160 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1161 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1162 * does not need to check for DTIM beacons separately and should be able to
1163 * use common code for all beacons.
1166 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id,
1167 struct ieee80211_tx_control *control);
1169 /* Given an sk_buff with a raw 802.11 header at the data pointer this function
1170 * returns the 802.11 header length in bytes (not including encryption
1171 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1172 * header the function returns 0.
1174 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1176 /* Like ieee80211_get_hdrlen_from_skb() but takes a FC in CPU order. */
1177 int ieee80211_get_hdrlen(u16 fc);
1180 * ieee80211_wake_queue - wake specific queue
1181 * @hw: pointer as obtained from ieee80211_alloc_hw().
1182 * @queue: queue number (counted from zero).
1184 * Drivers should use this function instead of netif_wake_queue.
1186 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1189 * ieee80211_stop_queue - stop specific queue
1190 * @hw: pointer as obtained from ieee80211_alloc_hw().
1191 * @queue: queue number (counted from zero).
1193 * Drivers should use this function instead of netif_stop_queue.
1195 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1198 * ieee80211_start_queues - start all queues
1199 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1201 * Drivers should use this function instead of netif_start_queue.
1203 void ieee80211_start_queues(struct ieee80211_hw *hw);
1206 * ieee80211_stop_queues - stop all queues
1207 * @hw: pointer as obtained from ieee80211_alloc_hw().
1209 * Drivers should use this function instead of netif_stop_queue.
1211 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1214 * ieee80211_wake_queues - wake all queues
1215 * @hw: pointer as obtained from ieee80211_alloc_hw().
1217 * Drivers should use this function instead of netif_wake_queue.
1219 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1221 /* called by driver to notify scan status completed */
1222 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1224 /* return a pointer to the source address (SA) */
1225 static inline u8 *ieee80211_get_SA(struct ieee80211_hdr *hdr)
1227 u8 *raw = (u8 *) hdr;
1228 u8 tofrom = (*(raw+1)) & 3; /* get the TODS and FROMDS bits */
1239 /* return a pointer to the destination address (DA) */
1240 static inline u8 *ieee80211_get_DA(struct ieee80211_hdr *hdr)
1242 u8 *raw = (u8 *) hdr;
1243 u8 to_ds = (*(raw+1)) & 1; /* get the TODS bit */
1250 static inline int ieee80211_get_morefrag(struct ieee80211_hdr *hdr)
1252 return (le16_to_cpu(hdr->frame_control) &
1253 IEEE80211_FCTL_MOREFRAGS) != 0;
1256 #endif /* MAC80211_H */