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 */
101 /* 802.11g is backwards-compatible with 802.11b, so a wlan card can
102 * actually be both in 11b and 11g modes at the same time. */
103 enum ieee80211_phymode {
104 MODE_IEEE80211A, /* IEEE 802.11a */
105 MODE_IEEE80211B, /* IEEE 802.11b only */
106 MODE_IEEE80211G, /* IEEE 802.11g (and 802.11b compatibility) */
112 struct ieee80211_hw_mode {
113 int mode; /* MODE_IEEE80211... */
114 int num_channels; /* Number of channels (below) */
115 struct ieee80211_channel *channels; /* Array of supported channels */
116 int num_rates; /* Number of rates (below) */
117 struct ieee80211_rate *rates; /* Array of supported rates */
119 struct list_head list; /* Internal, don't touch */
122 struct ieee80211_tx_queue_params {
123 int aifs; /* 0 .. 255; -1 = use default */
124 int cw_min; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */
125 int cw_max; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */
126 int burst_time; /* maximum burst time in 0.1 ms (i.e., 10 = 1 ms);
130 struct ieee80211_tx_queue_stats_data {
131 unsigned int len; /* num packets in queue */
132 unsigned int limit; /* queue len (soft) limit */
133 unsigned int count; /* total num frames sent */
137 IEEE80211_TX_QUEUE_DATA0,
138 IEEE80211_TX_QUEUE_DATA1,
139 IEEE80211_TX_QUEUE_DATA2,
140 IEEE80211_TX_QUEUE_DATA3,
141 IEEE80211_TX_QUEUE_DATA4,
142 IEEE80211_TX_QUEUE_SVP,
146 /* due to stupidity in the sub-ioctl userspace interface, the items in
147 * this struct need to have fixed values. As soon as it is removed, we can
148 * fix these entries. */
149 IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
150 IEEE80211_TX_QUEUE_BEACON = 7
153 struct ieee80211_tx_queue_stats {
154 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES];
157 struct ieee80211_low_level_stats {
158 unsigned int dot11ACKFailureCount;
159 unsigned int dot11RTSFailureCount;
160 unsigned int dot11FCSErrorCount;
161 unsigned int dot11RTSSuccessCount;
164 /* Transmit control fields. This data structure is passed to low-level driver
165 * with each TX frame. The low-level driver is responsible for configuring
166 * the hardware to use given values (depending on what is supported). */
167 #define HW_KEY_IDX_INVALID -1
169 struct ieee80211_tx_control {
170 int tx_rate; /* Transmit rate, given as the hw specific value for the
171 * rate (from struct ieee80211_rate) */
172 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw
173 * specific value for the rate (from
174 * struct ieee80211_rate) */
176 #define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for
178 #define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without
179 * encryption; e.g., for EAPOL
181 #define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending
183 #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the
184 * frame (e.g., for combined
185 * 802.11g / 802.11b networks) */
186 #define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to
188 #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5)
189 #define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6)
190 #define IEEE80211_TXCTL_REQUEUE (1<<7)
191 #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of
193 #define IEEE80211_TXCTL_TKIP_NEW_PHASE1_KEY (1<<9)
194 #define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
196 * set_retry_limit configured
197 * long retry value */
198 u32 flags; /* tx control flags defined
200 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, ..
201 * This could be used when set_retry_limit
202 * is not implemented by the driver */
203 u8 power_level; /* per-packet transmit power level, in dBm */
204 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
205 s8 key_idx; /* HW_KEY_IDX_INVALID = do not encrypt,
206 * other values: keyidx from hw->set_key() */
207 u8 icv_len; /* length of the ICV/MIC field in octets */
208 u8 iv_len; /* length of the IV field in octets */
209 u8 tkip_key[16]; /* generated phase2/phase1 key for hw TKIP */
210 u8 queue; /* hardware queue to use for this frame;
211 * 0 = highest, hw->queues-1 = lowest */
212 u8 sw_retry_attempt; /* number of times hw has tried to
213 * transmit frame (not incl. hw retries) */
215 struct ieee80211_rate *rate; /* internal 80211.o rate */
216 struct ieee80211_rate *rts_rate; /* internal 80211.o rate
218 int alt_retry_rate; /* retry rate for the last retries, given as the
219 * hw specific value for the rate (from
220 * struct ieee80211_rate). To be used to limit
221 * packet dropping when probing higher rates, if hw
222 * supports multiple retry rates. -1 = not used */
223 int type; /* internal */
224 int ifindex; /* internal */
229 * enum mac80211_rx_flags - receive flags
231 * These flags are used with the @flag member of &struct ieee80211_rx_status.
232 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
233 * Use together with %RX_FLAG_MMIC_STRIPPED.
234 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
235 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
236 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
237 * verification has been done by the hardware.
238 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
239 * If this flag is set, the stack cannot do any replay detection
240 * hence the driver or hardware will have to do that.
242 enum mac80211_rx_flags {
243 RX_FLAG_MMIC_ERROR = 1<<0,
244 RX_FLAG_DECRYPTED = 1<<1,
245 RX_FLAG_RADIOTAP = 1<<2,
246 RX_FLAG_MMIC_STRIPPED = 1<<3,
247 RX_FLAG_IV_STRIPPED = 1<<4,
251 * struct ieee80211_rx_status - receive status
253 * The low-level driver should provide this information (the subset
254 * supported by hardware) to the 802.11 code with each received
256 * @mactime: MAC timestamp as defined by 802.11
257 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
258 * @channel: channel the radio was tuned to
259 * @phymode: active PHY mode
260 * @ssi: signal strength when receiving this frame
261 * @signal: used as 'qual' in statistics reporting
262 * @noise: PHY noise when receiving this frame
263 * @antenna: antenna used
267 struct ieee80211_rx_status {
280 /* Transmit status. The low-level driver should provide this information
281 * (the subset supported by hardware) to the 802.11 code for each transmit
283 struct ieee80211_tx_status {
284 /* copied ieee80211_tx_control structure */
285 struct ieee80211_tx_control control;
287 #define IEEE80211_TX_STATUS_TX_FILTERED (1<<0)
288 #define IEEE80211_TX_STATUS_ACK (1<<1) /* whether the TX frame was ACKed */
289 u32 flags; /* tx staus flags defined above */
291 int ack_signal; /* measured signal strength of the ACK frame */
292 int excessive_retries;
295 int queue_length; /* information about TX queue */
301 * struct ieee80211_conf - configuration of the device
303 * This struct indicates how the driver shall configure the hardware.
305 * @radio_enabled: when zero, driver is required to switch off the radio.
307 struct ieee80211_conf {
308 int channel; /* IEEE 802.11 channel number */
310 int channel_val; /* hw specific value for the channel */
312 int phymode; /* MODE_IEEE80211A, .. */
313 struct ieee80211_channel *chan;
314 struct ieee80211_hw_mode *mode;
315 unsigned int regulatory_domain;
320 #define IEEE80211_CONF_SHORT_SLOT_TIME (1<<0) /* use IEEE 802.11g Short Slot
322 #define IEEE80211_CONF_SSID_HIDDEN (1<<1) /* do not broadcast the ssid */
323 #define IEEE80211_CONF_RADIOTAP (1<<2) /* use radiotap if supported
324 check this bit at RX time */
325 u32 flags; /* configuration flags defined above */
327 u8 power_level; /* transmit power limit for current
328 * regulatory domain; in dBm */
329 u8 antenna_max; /* maximum antenna gain */
331 /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
337 * enum ieee80211_if_types - types of 802.11 network interfaces
339 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
340 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
341 * daemon. Drivers should never see this type.
342 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
343 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
344 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
345 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
346 * @IEEE80211_IF_TYPE_VLAN: not used.
348 enum ieee80211_if_types {
349 IEEE80211_IF_TYPE_AP = 0x00000000,
350 IEEE80211_IF_TYPE_MGMT = 0x00000001,
351 IEEE80211_IF_TYPE_STA = 0x00000002,
352 IEEE80211_IF_TYPE_IBSS = 0x00000003,
353 IEEE80211_IF_TYPE_MNTR = 0x00000004,
354 IEEE80211_IF_TYPE_WDS = 0x5A580211,
355 IEEE80211_IF_TYPE_VLAN = 0x00080211,
359 * struct ieee80211_if_init_conf - initial configuration of an interface
361 * @if_id: internal interface ID. This number has no particular meaning to
362 * drivers and the only allowed usage is to pass it to
363 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions.
364 * This field is not valid for monitor interfaces
365 * (interfaces of %IEEE80211_IF_TYPE_MNTR type).
366 * @type: one of &enum ieee80211_if_types constants. Determines the type of
367 * added/removed interface.
368 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
369 * until the interface is removed (i.e. it cannot be used after
370 * remove_interface() callback was called for this interface).
371 * This pointer will be %NULL for monitor interfaces, be careful.
373 * This structure is used in add_interface() and remove_interface()
374 * callbacks of &struct ieee80211_hw.
376 * When you allow multiple interfaces to be added to your PHY, take care
377 * that the hardware can actually handle multiple MAC addresses. However,
378 * also take care that when there's no interface left with mac_addr != %NULL
379 * you remove the MAC address from the device to avoid acknowledging packets
380 * in pure monitor mode.
382 struct ieee80211_if_init_conf {
389 * struct ieee80211_if_conf - configuration of an interface
391 * @type: type of the interface. This is always the same as was specified in
392 * &struct ieee80211_if_init_conf. The type of an interface never changes
393 * during the life of the interface; this field is present only for
395 * @bssid: BSSID of the network we are associated to/creating.
396 * @ssid: used (together with @ssid_len) by drivers for hardware that
397 * generate beacons independently. The pointer is valid only during the
398 * config_interface() call, so copy the value somewhere if you need
400 * @ssid_len: length of the @ssid field.
401 * @generic_elem: used (together with @generic_elem_len) by drivers for
402 * hardware that generate beacons independently. The pointer is valid
403 * only during the config_interface() call, so copy the value somewhere
405 * @generic_elem_len: length of the generic element.
406 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
407 * &struct ieee80211_hw is set. The driver is responsible of freeing
409 * @beacon_control: tx_control for the beacon template, this field is only
410 * valid when the @beacon field was set.
412 * This structure is passed to the config_interface() callback of
413 * &struct ieee80211_hw.
415 struct ieee80211_if_conf {
421 size_t generic_elem_len;
422 struct sk_buff *beacon;
423 struct ieee80211_tx_control *beacon_control;
427 * enum ieee80211_key_alg - key algorithm
428 * @ALG_NONE: Unset key algorithm, will never be passed to the driver
429 * @ALG_WEP: WEP40 or WEP104
431 * @ALG_CCMP: CCMP (AES)
433 typedef enum ieee80211_key_alg {
442 * enum ieee80211_key_flags - key flags
444 * These flags are used for communication about keys between the driver
445 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
447 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
448 * that the STA this key will be used with could be using QoS.
449 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
450 * driver to indicate that it requires IV generation for this
452 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
453 * the driver for a TKIP key if it requires Michael MIC
454 * generation in software.
456 enum ieee80211_key_flags {
457 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
458 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
459 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
463 * struct ieee80211_key_conf - key information
465 * This key information is given by mac80211 to the driver by
466 * the set_key() callback in &struct ieee80211_ops.
468 * @hw_key_idx: To be set by the driver, this is the key index the driver
469 * wants to be given when a frame is transmitted and needs to be
470 * encrypted in hardware. It defaults to %HW_KEY_IDX_INVALID which
471 * the driver may not use.
472 * @alg: The key algorithm.
473 * @flags: key flags, see &enum ieee80211_key_flags.
474 * @keyidx: the key index (0-3)
475 * @keylen: key material length
478 struct ieee80211_key_conf {
480 ieee80211_key_alg alg;
487 #define IEEE80211_SEQ_COUNTER_RX 0
488 #define IEEE80211_SEQ_COUNTER_TX 1
491 * enum set_key_cmd - key command
493 * Used with the set_key() callback in &struct ieee80211_ops, this
494 * indicates whether a key is being removed or added.
496 * @SET_KEY: a key is set
497 * @DISABLE_KEY: a key must be disabled
499 typedef enum set_key_cmd {
500 SET_KEY, DISABLE_KEY,
504 * struct ieee80211_hw - hardware information and state
505 * TODO: move documentation into kernel-doc format
507 struct ieee80211_hw {
508 /* points to the cfg80211 wiphy for this piece. Note
509 * that you must fill in the perm_addr and dev fields
510 * of this structure, use the macros provided below. */
513 /* assigned by mac80211, don't write */
514 struct ieee80211_conf conf;
516 /* Single thread workqueue available for driver use
517 * Allocated by mac80211 on registration */
518 struct workqueue_struct *workqueue;
520 /* Pointer to the private area that was
521 * allocated with this struct for you. */
524 /* The rest is information about your hardware */
526 /* TODO: frame_type 802.11/802.3, sw_encryption requirements */
531 * The device only needs to be supplied with a beacon template.
532 * If you need the host to generate each beacon then don't use
533 * this flag and use ieee80211_beacon_get().
535 #define IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE (1<<1)
539 /* Whether RX frames passed to ieee80211_rx() include FCS in the end */
540 #define IEEE80211_HW_RX_INCLUDES_FCS (1<<3)
542 /* Some wireless LAN chipsets buffer broadcast/multicast frames for
543 * power saving stations in the hardware/firmware and others rely on
544 * the host system for such buffering. This option is used to
545 * configure the IEEE 802.11 upper layer to buffer broadcast/multicast
546 * frames when there are power saving stations so that low-level driver
547 * can fetch them with ieee80211_get_buffered_bc(). */
548 #define IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING (1<<4)
558 /* Device is capable of performing full monitor mode even during
559 * normal operation. */
560 #define IEEE80211_HW_MONITOR_DURING_OPER (1<<9)
562 /* Device does not need BSSID filter set to broadcast in order to
563 * receive all probe responses while scanning */
564 #define IEEE80211_HW_NO_PROBE_FILTERING (1<<10)
566 /* Channels are already configured to the default regulatory domain
567 * specified in the device's EEPROM */
568 #define IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED (1<<11)
570 /* Do TKIP phase1 key mixing in stack to support cards only do
571 * phase2 key mixing when doing hwcrypto */
572 #define IEEE80211_HW_TKIP_REQ_PHASE1_KEY (1<<13)
573 /* Do TKIP phase1 and phase2 key mixing in stack and send the generated
574 * per-packet RC4 key with each TX frame when doing hwcrypto */
575 #define IEEE80211_HW_TKIP_REQ_PHASE2_KEY (1<<14)
577 u32 flags; /* hardware flags defined above */
579 /* Set to the size of a needed device specific skb headroom for TX skbs. */
580 unsigned int extra_tx_headroom;
582 /* This is the time in us to change channels
584 int channel_change_time;
585 /* Maximum values for various statistics.
586 * Leave at 0 to indicate no support. Use negative numbers for dBm. */
591 /* Number of available hardware TX queues for data packets.
592 * WMM requires at least four queues. */
596 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
598 set_wiphy_dev(hw->wiphy, dev);
601 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
603 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
606 /* Configuration block used by the low-level driver to tell the 802.11 code
607 * about supported hardware features and to pass function pointers to callback
609 struct ieee80211_ops {
610 /* Handler that 802.11 module calls for each transmitted frame.
611 * skb contains the buffer starting from the IEEE 802.11 header.
612 * The low-level driver should send the frame out based on
613 * configuration in the TX control data.
615 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
616 struct ieee80211_tx_control *control);
618 /* Handler that is called when any netdevice attached to the hardware
619 * device is set UP for the first time. This can be used, e.g., to
620 * enable interrupts and beacon sending. */
621 int (*open)(struct ieee80211_hw *hw);
623 /* Handler that is called when the last netdevice attached to the
624 * hardware device is set DOWN. This can be used, e.g., to disable
625 * interrupts and beacon sending. */
626 int (*stop)(struct ieee80211_hw *hw);
628 /* Handler for asking a driver if a new interface can be added (or,
629 * more exactly, set UP). If the handler returns zero, the interface
630 * is added. Driver should perform any initialization it needs prior
631 * to returning zero. By returning non-zero addition of the interface
632 * is inhibited. Unless monitor_during_oper is set, it is guaranteed
633 * that monitor interfaces and normal interfaces are mutually
634 * exclusive. If assigned, the open() handler is called after
635 * add_interface() if this is the first device added. The
636 * add_interface() callback has to be assigned because it is the only
637 * way to obtain the requested MAC address for any interface.
639 int (*add_interface)(struct ieee80211_hw *hw,
640 struct ieee80211_if_init_conf *conf);
642 /* Notify a driver that an interface is going down. The stop() handler
643 * is called prior to this if this is a last interface. */
644 void (*remove_interface)(struct ieee80211_hw *hw,
645 struct ieee80211_if_init_conf *conf);
647 /* Handler for configuration requests. IEEE 802.11 code calls this
648 * function to change hardware configuration, e.g., channel. */
649 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
651 /* Handler for configuration requests related to interfaces (e.g.
653 int (*config_interface)(struct ieee80211_hw *hw,
654 int if_id, struct ieee80211_if_conf *conf);
656 /* ieee80211 drivers do not have access to the &struct net_device
657 * that is (are) connected with their device. Hence (and because
658 * we need to combine the multicast lists and flags for multiple
659 * virtual interfaces), they cannot assign set_multicast_list.
660 * The parameters here replace dev->flags and dev->mc_count,
661 * dev->mc_list is replaced by calling ieee80211_get_mc_list_item.
663 void (*set_multicast_list)(struct ieee80211_hw *hw,
664 unsigned short flags, int mc_count);
666 /* Set TIM bit handler. If the hardware/firmware takes care of beacon
667 * generation, IEEE 802.11 code uses this function to tell the
668 * low-level to set (or clear if set==0) TIM bit for the given aid. If
669 * host system is used to generate beacons, this handler is not used
670 * and low-level driver should set it to NULL.
672 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
675 * Set encryption key.
677 * This is called to enable hardware acceleration of encryption and
678 * decryption. The address will be the broadcast address for default
679 * keys, the other station's hardware address for individual keys or
680 * the zero address for keys that will be used only for transmission.
682 * The local_address parameter will always be set to our own address,
683 * this is only relevant if you support multiple local addresses.
685 * When transmitting, the TX control data will use the hw_key_idx
686 * selected by the low-level driver.
688 * Return 0 if the key is now in use, -EOPNOTSUPP or -ENOSPC if it
689 * couldn't be added; if you return 0 then hw_key_idx must be
690 * assigned to something other than HW_KEY_IDX_INVALID. When the cmd
691 * is DISABLE_KEY then it must succeed.
693 * Note that it is permissible to not decrypt a frame even if a key
694 * for it has been uploaded to hardware, the stack will not make any
695 * decision based on whether a key has been uploaded or not but rather
696 * based on the receive flags.
698 * This callback can sleep, and is only called between add_interface
699 * and remove_interface calls, i.e. while the interface with the
700 * given local_address is enabled.
702 * The ieee80211_key_conf structure pointed to by the key parameter
703 * is guaranteed to be valid until another call to set_key removes
704 * it, but it can only be used as a cookie to differentiate keys.
706 int (*set_key)(struct ieee80211_hw *hw, set_key_cmd cmd,
707 const u8 *local_address, const u8 *address,
708 struct ieee80211_key_conf *key);
710 /* Enable/disable IEEE 802.1X. This item requests wlan card to pass
711 * unencrypted EAPOL-Key frames even when encryption is configured.
712 * If the wlan card does not require such a configuration, this
713 * function pointer can be set to NULL. */
714 int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x);
716 /* Set port authorization state (IEEE 802.1X PAE) to be authorized
717 * (authorized=1) or unauthorized (authorized=0). This function can be
718 * used if the wlan hardware or low-level driver implements PAE.
719 * 80211.o module will anyway filter frames based on authorization
720 * state, so this function pointer can be NULL if low-level driver does
721 * not require event notification about port state changes.
722 * Currently unused. */
723 int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr,
726 /* Ask the hardware to service the scan request, no need to start
727 * the scan state machine in stack. */
728 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
730 /* return low-level statistics */
731 int (*get_stats)(struct ieee80211_hw *hw,
732 struct ieee80211_low_level_stats *stats);
734 /* For devices that generate their own beacons and probe response
735 * or association responses this updates the state of privacy_invoked
736 * returns 0 for success or an error number */
737 int (*set_privacy_invoked)(struct ieee80211_hw *hw,
738 int privacy_invoked);
740 /* For devices that have internal sequence counters, allow 802.11
741 * code to access the current value of a counter */
742 int (*get_sequence_counter)(struct ieee80211_hw *hw,
743 u8* addr, u8 keyidx, u8 txrx,
744 u32* iv32, u16* iv16);
746 /* Configuration of RTS threshold (if device needs it) */
747 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
749 /* Configuration of fragmentation threshold.
750 * Assign this if the device does fragmentation by itself,
751 * if this method is assigned then the stack will not do
753 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
755 /* Configuration of retry limits (if device needs it) */
756 int (*set_retry_limit)(struct ieee80211_hw *hw,
757 u32 short_retry, u32 long_retr);
759 /* Number of STAs in STA table notification (NULL = disabled).
761 void (*sta_table_notification)(struct ieee80211_hw *hw,
764 /* Handle ERP IE change notifications. Must be atomic. */
765 void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes,
766 int cts_protection, int preamble);
768 /* Flags for the erp_ie_changed changes parameter */
769 #define IEEE80211_ERP_CHANGE_PROTECTION (1<<0) /* protection flag changed */
770 #define IEEE80211_ERP_CHANGE_PREAMBLE (1<<1) /* barker preamble mode changed */
772 /* Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
773 * bursting) for a hardware TX queue.
774 * queue = IEEE80211_TX_QUEUE_*.
776 int (*conf_tx)(struct ieee80211_hw *hw, int queue,
777 const struct ieee80211_tx_queue_params *params);
779 /* Get statistics of the current TX queue status. This is used to get
780 * number of currently queued packets (queue length), maximum queue
781 * size (limit), and total number of packets sent using each TX queue
783 * Currently unused. */
784 int (*get_tx_stats)(struct ieee80211_hw *hw,
785 struct ieee80211_tx_queue_stats *stats);
787 /* Get the current TSF timer value from firmware/hardware. Currently,
788 * this is only used for IBSS mode debugging and, as such, is not a
791 u64 (*get_tsf)(struct ieee80211_hw *hw);
793 /* Reset the TSF timer and allow firmware/hardware to synchronize with
794 * other STAs in the IBSS. This is only used in IBSS mode. This
795 * function is optional if the firmware/hardware takes full care of
796 * TSF synchronization. */
797 void (*reset_tsf)(struct ieee80211_hw *hw);
799 /* Setup beacon data for IBSS beacons. Unlike access point (Master),
800 * IBSS uses a fixed beacon frame which is configured using this
801 * function. This handler is required only for IBSS mode. */
802 int (*beacon_update)(struct ieee80211_hw *hw,
804 struct ieee80211_tx_control *control);
806 /* Determine whether the last IBSS beacon was sent by us. This is
807 * needed only for IBSS mode and the result of this function is used to
808 * determine whether to reply to Probe Requests. */
809 int (*tx_last_beacon)(struct ieee80211_hw *hw);
812 /* Allocate a new hardware device. This must be called once for each
813 * hardware device. The returned pointer must be used to refer to this
814 * device when calling other functions. 802.11 code allocates a private data
815 * area for the low-level driver. The size of this area is given as
818 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
819 const struct ieee80211_ops *ops);
821 /* Register hardware device to the IEEE 802.11 code and kernel. Low-level
822 * drivers must call this function before using any other IEEE 802.11
823 * function except ieee80211_register_hwmode. */
824 int ieee80211_register_hw(struct ieee80211_hw *hw);
826 /* driver can use this and ieee80211_get_rx_led_name to get the
827 * name of the registered LEDs after ieee80211_register_hw
829 * This is useful to set the default trigger on the LED class
830 * device that your driver should export for each LED the device
831 * has, that way the default behaviour will be as expected but
832 * the user can still change it/turn off the LED etc.
834 #ifdef CONFIG_MAC80211_LEDS
835 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
836 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
838 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
840 #ifdef CONFIG_MAC80211_LEDS
841 return __ieee80211_get_tx_led_name(hw);
847 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
849 #ifdef CONFIG_MAC80211_LEDS
850 return __ieee80211_get_rx_led_name(hw);
856 /* Register a new hardware PHYMODE capability to the stack. */
857 int ieee80211_register_hwmode(struct ieee80211_hw *hw,
858 struct ieee80211_hw_mode *mode);
860 /* Unregister a hardware device. This function instructs 802.11 code to free
861 * allocated resources and unregister netdevices from the kernel. */
862 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
864 /* Free everything that was allocated including private data of a driver. */
865 void ieee80211_free_hw(struct ieee80211_hw *hw);
867 /* Receive frame callback function. The low-level driver uses this function to
868 * send received frames to the IEEE 802.11 code. Receive buffer (skb) must
869 * start with IEEE 802.11 header. */
870 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
871 struct ieee80211_rx_status *status);
872 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
874 struct ieee80211_rx_status *status);
876 /* Transmit status callback function. The low-level driver must call this
877 * function to report transmit status for all the TX frames that had
878 * req_tx_status set in the transmit control fields. In addition, this should
879 * be called at least for all unicast frames to provide information for TX rate
880 * control algorithm. In order to maintain all statistics, this function is
881 * recommended to be called after each frame, including multicast/broadcast, is
883 void ieee80211_tx_status(struct ieee80211_hw *hw,
885 struct ieee80211_tx_status *status);
886 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
888 struct ieee80211_tx_status *status);
891 * ieee80211_beacon_get - beacon generation function
892 * @hw: pointer obtained from ieee80211_alloc_hw().
893 * @if_id: interface ID from &struct ieee80211_if_init_conf.
894 * @control: will be filled with information needed to send this beacon.
896 * If the beacon frames are generated by the host system (i.e., not in
897 * hardware/firmware), the low-level driver uses this function to receive
898 * the next beacon frame from the 802.11 code. The low-level is responsible
899 * for calling this function before beacon data is needed (e.g., based on
900 * hardware interrupt). Returned skb is used only once and low-level driver
901 * is responsible of freeing it.
903 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
905 struct ieee80211_tx_control *control);
908 * ieee80211_rts_get - RTS frame generation function
909 * @hw: pointer obtained from ieee80211_alloc_hw().
910 * @if_id: interface ID from &struct ieee80211_if_init_conf.
911 * @frame: pointer to the frame that is going to be protected by the RTS.
912 * @frame_len: the frame length (in octets).
913 * @frame_txctl: &struct ieee80211_tx_control of the frame.
914 * @rts: The buffer where to store the RTS frame.
916 * If the RTS frames are generated by the host system (i.e., not in
917 * hardware/firmware), the low-level driver uses this function to receive
918 * the next RTS frame from the 802.11 code. The low-level is responsible
919 * for calling this function before and RTS frame is needed.
921 void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id,
922 const void *frame, size_t frame_len,
923 const struct ieee80211_tx_control *frame_txctl,
924 struct ieee80211_rts *rts);
927 * ieee80211_rts_duration - Get the duration field for an RTS frame
928 * @hw: pointer obtained from ieee80211_alloc_hw().
929 * @if_id: interface ID from &struct ieee80211_if_init_conf.
930 * @frame_len: the length of the frame that is going to be protected by the RTS.
931 * @frame_txctl: &struct ieee80211_tx_control of the frame.
933 * If the RTS is generated in firmware, but the host system must provide
934 * the duration field, the low-level driver uses this function to receive
935 * the duration field value in little-endian byteorder.
937 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id,
939 const struct ieee80211_tx_control *frame_txctl);
942 * ieee80211_ctstoself_get - CTS-to-self frame generation function
943 * @hw: pointer obtained from ieee80211_alloc_hw().
944 * @if_id: interface ID from &struct ieee80211_if_init_conf.
945 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
946 * @frame_len: the frame length (in octets).
947 * @frame_txctl: &struct ieee80211_tx_control of the frame.
948 * @cts: The buffer where to store the CTS-to-self frame.
950 * If the CTS-to-self frames are generated by the host system (i.e., not in
951 * hardware/firmware), the low-level driver uses this function to receive
952 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
953 * for calling this function before and CTS-to-self frame is needed.
955 void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id,
956 const void *frame, size_t frame_len,
957 const struct ieee80211_tx_control *frame_txctl,
958 struct ieee80211_cts *cts);
961 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
962 * @hw: pointer obtained from ieee80211_alloc_hw().
963 * @if_id: interface ID from &struct ieee80211_if_init_conf.
964 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
965 * @frame_txctl: &struct ieee80211_tx_control of the frame.
967 * If the CTS-to-self is generated in firmware, but the host system must provide
968 * the duration field, the low-level driver uses this function to receive
969 * the duration field value in little-endian byteorder.
971 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id,
973 const struct ieee80211_tx_control *frame_txctl);
976 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
977 * @hw: pointer obtained from ieee80211_alloc_hw().
978 * @if_id: interface ID from &struct ieee80211_if_init_conf.
979 * @frame_len: the length of the frame.
980 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
982 * Calculate the duration field of some generic frame, given its
983 * length and transmission rate (in 100kbps).
985 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id,
990 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
991 * @hw: pointer as obtained from ieee80211_alloc_hw().
992 * @if_id: interface ID from &struct ieee80211_if_init_conf.
993 * @control: will be filled with information needed to send returned frame.
995 * Function for accessing buffered broadcast and multicast frames. If
996 * hardware/firmware does not implement buffering of broadcast/multicast
997 * frames when power saving is used, 802.11 code buffers them in the host
998 * memory. The low-level driver uses this function to fetch next buffered
999 * frame. In most cases, this is used when generating beacon frame. This
1000 * function returns a pointer to the next buffered skb or NULL if no more
1001 * buffered frames are available.
1003 * Note: buffered frames are returned only after DTIM beacon frame was
1004 * generated with ieee80211_beacon_get() and the low-level driver must thus
1005 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1006 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1007 * does not need to check for DTIM beacons separately and should be able to
1008 * use common code for all beacons.
1011 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id,
1012 struct ieee80211_tx_control *control);
1014 /* Given an sk_buff with a raw 802.11 header at the data pointer this function
1015 * returns the 802.11 header length in bytes (not including encryption
1016 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1017 * header the function returns 0.
1019 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1021 /* Like ieee80211_get_hdrlen_from_skb() but takes a FC in CPU order. */
1022 int ieee80211_get_hdrlen(u16 fc);
1025 * ieee80211_wake_queue - wake specific queue
1026 * @hw: pointer as obtained from ieee80211_alloc_hw().
1027 * @queue: queue number (counted from zero).
1029 * Drivers should use this function instead of netif_wake_queue.
1031 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1034 * ieee80211_stop_queue - stop specific queue
1035 * @hw: pointer as obtained from ieee80211_alloc_hw().
1036 * @queue: queue number (counted from zero).
1038 * Drivers should use this function instead of netif_stop_queue.
1040 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1043 * ieee80211_start_queues - start all queues
1044 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1046 * Drivers should use this function instead of netif_start_queue.
1048 void ieee80211_start_queues(struct ieee80211_hw *hw);
1051 * ieee80211_stop_queues - stop all queues
1052 * @hw: pointer as obtained from ieee80211_alloc_hw().
1054 * Drivers should use this function instead of netif_stop_queue.
1056 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1059 * ieee80211_wake_queues - wake all queues
1060 * @hw: pointer as obtained from ieee80211_alloc_hw().
1062 * Drivers should use this function instead of netif_wake_queue.
1064 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1067 * ieee80211_get_mc_list_item - iteration over items in multicast list
1068 * @hw: pointer as obtained from ieee80211_alloc_hw().
1069 * @prev: value returned by previous call to ieee80211_get_mc_list_item() or
1070 * NULL to start a new iteration.
1071 * @ptr: pointer to buffer of void * type for internal usage of
1072 * ieee80211_get_mc_list_item().
1074 * Iterates over items in multicast list of given device. To get the first
1075 * item, pass NULL in @prev and in *@ptr. In subsequent calls, pass the
1076 * value returned by previous call in @prev. Don't alter *@ptr during
1077 * iteration. When there are no more items, NULL is returned.
1079 struct dev_mc_list *
1080 ieee80211_get_mc_list_item(struct ieee80211_hw *hw,
1081 struct dev_mc_list *prev,
1084 /* called by driver to notify scan status completed */
1085 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1087 /* return a pointer to the source address (SA) */
1088 static inline u8 *ieee80211_get_SA(struct ieee80211_hdr *hdr)
1090 u8 *raw = (u8 *) hdr;
1091 u8 tofrom = (*(raw+1)) & 3; /* get the TODS and FROMDS bits */
1102 /* return a pointer to the destination address (DA) */
1103 static inline u8 *ieee80211_get_DA(struct ieee80211_hdr *hdr)
1105 u8 *raw = (u8 *) hdr;
1106 u8 to_ds = (*(raw+1)) & 1; /* get the TODS bit */
1113 static inline int ieee80211_get_morefrag(struct ieee80211_hdr *hdr)
1115 return (le16_to_cpu(hdr->frame_control) &
1116 IEEE80211_FCTL_MOREFRAGS) != 0;
1119 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
1120 #define MAC_ARG(x) ((u8*)(x))[0], ((u8*)(x))[1], ((u8*)(x))[2], \
1121 ((u8*)(x))[3], ((u8*)(x))[4], ((u8*)(x))[5]
1123 #endif /* MAC80211_H */