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_TURBO 0x00000080
77 #define IEEE80211_RATE_MANDATORY 0x00000100
79 #define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2)
80 #define IEEE80211_RATE_MODULATION(f) \
81 (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM))
83 /* Low-level driver should set PREAMBLE2, OFDM, CCK, and TURBO flags.
84 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the
86 struct ieee80211_rate
{
87 int rate
; /* rate in 100 kbps */
88 int val
; /* hw specific value for the rate */
89 int flags
; /* IEEE80211_RATE_ flags */
90 int val2
; /* hw specific value for the rate when using short preamble
91 * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for
92 * 2, 5.5, and 11 Mbps) */
93 signed char min_rssi_ack
;
94 unsigned char min_rssi_ack_delta
;
96 /* following fields are set by 80211.o and need not be filled by the
98 int rate_inv
; /* inverse of the rate (LCM(all rates) / rate) for
99 * optimizing channel utilization estimates */
102 /* 802.11g is backwards-compatible with 802.11b, so a wlan card can
103 * actually be both in 11b and 11g modes at the same time. */
105 MODE_IEEE80211A
, /* IEEE 802.11a */
106 MODE_IEEE80211B
, /* IEEE 802.11b only */
107 MODE_ATHEROS_TURBO
, /* Atheros Turbo mode (2x.11a at 5 GHz) */
108 MODE_IEEE80211G
, /* IEEE 802.11g (and 802.11b compatibility) */
109 MODE_ATHEROS_TURBOG
, /* Atheros Turbo mode (2x.11g at 2.4 GHz) */
115 struct ieee80211_hw_mode
{
116 int mode
; /* MODE_IEEE80211... */
117 int num_channels
; /* Number of channels (below) */
118 struct ieee80211_channel
*channels
; /* Array of supported channels */
119 int num_rates
; /* Number of rates (below) */
120 struct ieee80211_rate
*rates
; /* Array of supported rates */
122 struct list_head list
; /* Internal, don't touch */
125 struct ieee80211_tx_queue_params
{
126 int aifs
; /* 0 .. 255; -1 = use default */
127 int cw_min
; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */
128 int cw_max
; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */
129 int burst_time
; /* maximum burst time in 0.1 ms (i.e., 10 = 1 ms);
133 struct ieee80211_tx_queue_stats_data
{
134 unsigned int len
; /* num packets in queue */
135 unsigned int limit
; /* queue len (soft) limit */
136 unsigned int count
; /* total num frames sent */
140 IEEE80211_TX_QUEUE_DATA0
,
141 IEEE80211_TX_QUEUE_DATA1
,
142 IEEE80211_TX_QUEUE_DATA2
,
143 IEEE80211_TX_QUEUE_DATA3
,
144 IEEE80211_TX_QUEUE_DATA4
,
145 IEEE80211_TX_QUEUE_SVP
,
149 /* due to stupidity in the sub-ioctl userspace interface, the items in
150 * this struct need to have fixed values. As soon as it is removed, we can
151 * fix these entries. */
152 IEEE80211_TX_QUEUE_AFTER_BEACON
= 6,
153 IEEE80211_TX_QUEUE_BEACON
= 7
156 struct ieee80211_tx_queue_stats
{
157 struct ieee80211_tx_queue_stats_data data
[NUM_TX_DATA_QUEUES
];
160 struct ieee80211_low_level_stats
{
161 unsigned int dot11ACKFailureCount
;
162 unsigned int dot11RTSFailureCount
;
163 unsigned int dot11FCSErrorCount
;
164 unsigned int dot11RTSSuccessCount
;
167 /* Transmit control fields. This data structure is passed to low-level driver
168 * with each TX frame. The low-level driver is responsible for configuring
169 * the hardware to use given values (depending on what is supported). */
170 #define HW_KEY_IDX_INVALID -1
172 struct ieee80211_tx_control
{
173 int tx_rate
; /* Transmit rate, given as the hw specific value for the
174 * rate (from struct ieee80211_rate) */
175 int rts_cts_rate
; /* Transmit rate for RTS/CTS frame, given as the hw
176 * specific value for the rate (from
177 * struct ieee80211_rate) */
179 #define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for
181 #define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without
182 * encryption; e.g., for EAPOL
184 #define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending
186 #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the
187 * frame (e.g., for combined
188 * 802.11g / 802.11b networks) */
189 #define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to
191 #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5)
192 #define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6)
193 #define IEEE80211_TXCTL_REQUEUE (1<<7)
194 #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of
196 #define IEEE80211_TXCTL_TKIP_NEW_PHASE1_KEY (1<<9)
197 #define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
199 * set_retry_limit configured
200 * long retry value */
201 u32 flags
; /* tx control flags defined
203 u8 retry_limit
; /* 1 = only first attempt, 2 = one retry, ..
204 * This could be used when set_retry_limit
205 * is not implemented by the driver */
206 u8 power_level
; /* per-packet transmit power level, in dBm */
207 u8 antenna_sel_tx
; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
208 s8 key_idx
; /* HW_KEY_IDX_INVALID = do not encrypt,
209 * other values: keyidx from hw->set_key() */
210 u8 icv_len
; /* length of the ICV/MIC field in octets */
211 u8 iv_len
; /* length of the IV field in octets */
212 u8 tkip_key
[16]; /* generated phase2/phase1 key for hw TKIP */
213 u8 queue
; /* hardware queue to use for this frame;
214 * 0 = highest, hw->queues-1 = lowest */
215 u8 sw_retry_attempt
; /* number of times hw has tried to
216 * transmit frame (not incl. hw retries) */
218 struct ieee80211_rate
*rate
; /* internal 80211.o rate */
219 struct ieee80211_rate
*rts_rate
; /* internal 80211.o rate
221 int alt_retry_rate
; /* retry rate for the last retries, given as the
222 * hw specific value for the rate (from
223 * struct ieee80211_rate). To be used to limit
224 * packet dropping when probing higher rates, if hw
225 * supports multiple retry rates. -1 = not used */
226 int type
; /* internal */
227 int ifindex
; /* internal */
230 /* Receive status. The low-level driver should provide this information
231 * (the subset supported by hardware) to the 802.11 code with each received
233 struct ieee80211_rx_status
{
235 int freq
; /* receive frequency in Mhz */
239 int signal
; /* used as qual in statistics reporting */
243 #define RX_FLAG_MMIC_ERROR (1<<0)
244 #define RX_FLAG_DECRYPTED (1<<1)
245 #define RX_FLAG_RADIOTAP (1<<2)
249 /* Transmit status. The low-level driver should provide this information
250 * (the subset supported by hardware) to the 802.11 code for each transmit
252 struct ieee80211_tx_status
{
253 /* copied ieee80211_tx_control structure */
254 struct ieee80211_tx_control control
;
256 #define IEEE80211_TX_STATUS_TX_FILTERED (1<<0)
257 #define IEEE80211_TX_STATUS_ACK (1<<1) /* whether the TX frame was ACKed */
258 u32 flags
; /* tx staus flags defined above */
260 int ack_signal
; /* measured signal strength of the ACK frame */
261 int excessive_retries
;
264 int queue_length
; /* information about TX queue */
270 * struct ieee80211_conf - configuration of the device
272 * This struct indicates how the driver shall configure the hardware.
274 * @radio_enabled: when zero, driver is required to switch off the radio.
276 struct ieee80211_conf
{
277 int channel
; /* IEEE 802.11 channel number */
279 int channel_val
; /* hw specific value for the channel */
281 int phymode
; /* MODE_IEEE80211A, .. */
282 struct ieee80211_channel
*chan
;
283 struct ieee80211_hw_mode
*mode
;
284 unsigned int regulatory_domain
;
289 #define IEEE80211_CONF_SHORT_SLOT_TIME (1<<0) /* use IEEE 802.11g Short Slot
291 #define IEEE80211_CONF_SSID_HIDDEN (1<<1) /* do not broadcast the ssid */
292 #define IEEE80211_CONF_RADIOTAP (1<<2) /* use radiotap if supported
293 check this bit at RX time */
294 u32 flags
; /* configuration flags defined above */
296 u8 power_level
; /* transmit power limit for current
297 * regulatory domain; in dBm */
298 u8 antenna_max
; /* maximum antenna gain */
300 /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
306 * enum ieee80211_if_types - types of 802.11 network interfaces
308 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
309 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
310 * daemon. Drivers should never see this type.
311 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
312 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
313 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
314 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
315 * @IEEE80211_IF_TYPE_VLAN: not used.
317 enum ieee80211_if_types
{
318 IEEE80211_IF_TYPE_AP
= 0x00000000,
319 IEEE80211_IF_TYPE_MGMT
= 0x00000001,
320 IEEE80211_IF_TYPE_STA
= 0x00000002,
321 IEEE80211_IF_TYPE_IBSS
= 0x00000003,
322 IEEE80211_IF_TYPE_MNTR
= 0x00000004,
323 IEEE80211_IF_TYPE_WDS
= 0x5A580211,
324 IEEE80211_IF_TYPE_VLAN
= 0x00080211,
328 * struct ieee80211_if_init_conf - initial configuration of an interface
330 * @if_id: internal interface ID. This number has no particular meaning to
331 * drivers and the only allowed usage is to pass it to
332 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions.
333 * This field is not valid for monitor interfaces
334 * (interfaces of %IEEE80211_IF_TYPE_MNTR type).
335 * @type: one of &enum ieee80211_if_types constants. Determines the type of
336 * added/removed interface.
337 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
338 * until the interface is removed (i.e. it cannot be used after
339 * remove_interface() callback was called for this interface).
340 * This pointer will be %NULL for monitor interfaces, be careful.
342 * This structure is used in add_interface() and remove_interface()
343 * callbacks of &struct ieee80211_hw.
345 * When you allow multiple interfaces to be added to your PHY, take care
346 * that the hardware can actually handle multiple MAC addresses. However,
347 * also take care that when there's no interface left with mac_addr != %NULL
348 * you remove the MAC address from the device to avoid acknowledging packets
349 * in pure monitor mode.
351 struct ieee80211_if_init_conf
{
358 * struct ieee80211_if_conf - configuration of an interface
360 * @type: type of the interface. This is always the same as was specified in
361 * &struct ieee80211_if_init_conf. The type of an interface never changes
362 * during the life of the interface; this field is present only for
364 * @bssid: BSSID of the network we are associated to/creating.
365 * @ssid: used (together with @ssid_len) by drivers for hardware that
366 * generate beacons independently. The pointer is valid only during the
367 * config_interface() call, so copy the value somewhere if you need
369 * @ssid_len: length of the @ssid field.
370 * @generic_elem: used (together with @generic_elem_len) by drivers for
371 * hardware that generate beacons independently. The pointer is valid
372 * only during the config_interface() call, so copy the value somewhere
374 * @generic_elem_len: length of the generic element.
375 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
376 * &struct ieee80211_hw is set. The driver is responsible of freeing
378 * @beacon_control: tx_control for the beacon template, this field is only
379 * valid when the @beacon field was set.
381 * This structure is passed to the config_interface() callback of
382 * &struct ieee80211_hw.
384 struct ieee80211_if_conf
{
390 size_t generic_elem_len
;
391 struct sk_buff
*beacon
;
392 struct ieee80211_tx_control
*beacon_control
;
403 * This flag indiciates that the station this key is being
404 * configured for may use QoS. If your hardware cannot handle
405 * that situation it should reject that key.
407 #define IEEE80211_KEY_FLAG_WMM_STA (1<<0)
409 struct ieee80211_key_conf
{
411 * To be set by the driver to the key index it would like to
412 * get in the ieee80211_tx_control.key_idx which defaults
413 * to HW_KEY_IDX_INVALID so that shouldn't be used.
417 /* key algorithm, ALG_NONE should never be seen by the driver */
418 ieee80211_key_alg alg
;
420 /* key flags, see above */
426 /* length of key material */
429 /* the key material */
433 #define IEEE80211_SEQ_COUNTER_RX 0
434 #define IEEE80211_SEQ_COUNTER_TX 1
437 SET_KEY
, DISABLE_KEY
,
440 /* This is driver-visible part of the per-hw state the stack keeps. */
441 struct ieee80211_hw
{
442 /* points to the cfg80211 wiphy for this piece. Note
443 * that you must fill in the perm_addr and dev fields
444 * of this structure, use the macros provided below. */
447 /* assigned by mac80211, don't write */
448 struct ieee80211_conf conf
;
450 /* Single thread workqueue available for driver use
451 * Allocated by mac80211 on registration */
452 struct workqueue_struct
*workqueue
;
454 /* Pointer to the private area that was
455 * allocated with this struct for you. */
458 /* The rest is information about your hardware */
460 /* TODO: frame_type 802.11/802.3, sw_encryption requirements */
465 * The device only needs to be supplied with a beacon template.
466 * If you need the host to generate each beacon then don't use
467 * this flag and use ieee80211_beacon_get().
469 #define IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE (1<<1)
472 * Some devices handle decryption internally and do not
473 * indicate whether the frame was encrypted (unencrypted frames
474 * will be dropped by the hardware, unless specifically allowed
476 * It is permissible to not handle all encrypted frames and fall
477 * back to software encryption; however, if this flag is set
478 * unencrypted frames must be dropped unless the driver is told
479 * otherwise via the set_ieee8021x() callback.
481 #define IEEE80211_HW_DEVICE_HIDES_WEP (1<<2)
483 /* Whether RX frames passed to ieee80211_rx() include FCS in the end */
484 #define IEEE80211_HW_RX_INCLUDES_FCS (1<<3)
486 /* Some wireless LAN chipsets buffer broadcast/multicast frames for
487 * power saving stations in the hardware/firmware and others rely on
488 * the host system for such buffering. This option is used to
489 * configure the IEEE 802.11 upper layer to buffer broadcast/multicast
490 * frames when there are power saving stations so that low-level driver
491 * can fetch them with ieee80211_get_buffered_bc(). */
492 #define IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING (1<<4)
495 * This flag is only relevant if hardware encryption is used.
496 * If set, it has two meanings:
497 * 1) the IV and ICV are present in received frames that have
498 * been decrypted (unless IEEE80211_HW_DEVICE_HIDES_WEP is
500 * 2) on transmission, the IV should be generated in software.
502 * Please let us know if you *don't* use this flag, the stack would
503 * really like to be able to get the IV to keep key statistics
506 #define IEEE80211_HW_WEP_INCLUDE_IV (1<<5)
513 * Some devices handle Michael MIC internally and do not include MIC in
514 * the received packets passed up. This flag must be set for such
515 * devices. The 'encryption' frame control bit is expected to be still
516 * set in the IEEE 802.11 header with this option unlike with the
517 * IEEE80211_HW_DEVICE_HIDES_WEP flag.
519 #define IEEE80211_HW_DEVICE_STRIPS_MIC (1<<8)
521 /* Device is capable of performing full monitor mode even during
522 * normal operation. */
523 #define IEEE80211_HW_MONITOR_DURING_OPER (1<<9)
525 /* Device does not need BSSID filter set to broadcast in order to
526 * receive all probe responses while scanning */
527 #define IEEE80211_HW_NO_PROBE_FILTERING (1<<10)
529 /* Channels are already configured to the default regulatory domain
530 * specified in the device's EEPROM */
531 #define IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED (1<<11)
533 /* calculate Michael MIC for an MSDU when doing hwcrypto */
534 #define IEEE80211_HW_TKIP_INCLUDE_MMIC (1<<12)
535 /* Do TKIP phase1 key mixing in stack to support cards only do
536 * phase2 key mixing when doing hwcrypto */
537 #define IEEE80211_HW_TKIP_REQ_PHASE1_KEY (1<<13)
538 /* Do TKIP phase1 and phase2 key mixing in stack and send the generated
539 * per-packet RC4 key with each TX frame when doing hwcrypto */
540 #define IEEE80211_HW_TKIP_REQ_PHASE2_KEY (1<<14)
542 u32 flags
; /* hardware flags defined above */
544 /* Set to the size of a needed device specific skb headroom for TX skbs. */
545 unsigned int extra_tx_headroom
;
547 /* This is the time in us to change channels
549 int channel_change_time
;
550 /* Maximum values for various statistics.
551 * Leave at 0 to indicate no support. Use negative numbers for dBm. */
556 /* Number of available hardware TX queues for data packets.
557 * WMM requires at least four queues. */
561 static inline void SET_IEEE80211_DEV(struct ieee80211_hw
*hw
, struct device
*dev
)
563 set_wiphy_dev(hw
->wiphy
, dev
);
566 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw
*hw
, u8
*addr
)
568 memcpy(hw
->wiphy
->perm_addr
, addr
, ETH_ALEN
);
571 /* Configuration block used by the low-level driver to tell the 802.11 code
572 * about supported hardware features and to pass function pointers to callback
574 struct ieee80211_ops
{
575 /* Handler that 802.11 module calls for each transmitted frame.
576 * skb contains the buffer starting from the IEEE 802.11 header.
577 * The low-level driver should send the frame out based on
578 * configuration in the TX control data.
580 int (*tx
)(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
581 struct ieee80211_tx_control
*control
);
583 /* Handler that is called when any netdevice attached to the hardware
584 * device is set UP for the first time. This can be used, e.g., to
585 * enable interrupts and beacon sending. */
586 int (*open
)(struct ieee80211_hw
*hw
);
588 /* Handler that is called when the last netdevice attached to the
589 * hardware device is set DOWN. This can be used, e.g., to disable
590 * interrupts and beacon sending. */
591 int (*stop
)(struct ieee80211_hw
*hw
);
593 /* Handler for asking a driver if a new interface can be added (or,
594 * more exactly, set UP). If the handler returns zero, the interface
595 * is added. Driver should perform any initialization it needs prior
596 * to returning zero. By returning non-zero addition of the interface
597 * is inhibited. Unless monitor_during_oper is set, it is guaranteed
598 * that monitor interfaces and normal interfaces are mutually
599 * exclusive. If assigned, the open() handler is called after
600 * add_interface() if this is the first device added. The
601 * add_interface() callback has to be assigned because it is the only
602 * way to obtain the requested MAC address for any interface.
604 int (*add_interface
)(struct ieee80211_hw
*hw
,
605 struct ieee80211_if_init_conf
*conf
);
607 /* Notify a driver that an interface is going down. The stop() handler
608 * is called prior to this if this is a last interface. */
609 void (*remove_interface
)(struct ieee80211_hw
*hw
,
610 struct ieee80211_if_init_conf
*conf
);
612 /* Handler for configuration requests. IEEE 802.11 code calls this
613 * function to change hardware configuration, e.g., channel. */
614 int (*config
)(struct ieee80211_hw
*hw
, struct ieee80211_conf
*conf
);
616 /* Handler for configuration requests related to interfaces (e.g.
618 int (*config_interface
)(struct ieee80211_hw
*hw
,
619 int if_id
, struct ieee80211_if_conf
*conf
);
621 /* ieee80211 drivers do not have access to the &struct net_device
622 * that is (are) connected with their device. Hence (and because
623 * we need to combine the multicast lists and flags for multiple
624 * virtual interfaces), they cannot assign set_multicast_list.
625 * The parameters here replace dev->flags and dev->mc_count,
626 * dev->mc_list is replaced by calling ieee80211_get_mc_list_item.
628 void (*set_multicast_list
)(struct ieee80211_hw
*hw
,
629 unsigned short flags
, int mc_count
);
631 /* Set TIM bit handler. If the hardware/firmware takes care of beacon
632 * generation, IEEE 802.11 code uses this function to tell the
633 * low-level to set (or clear if set==0) TIM bit for the given aid. If
634 * host system is used to generate beacons, this handler is not used
635 * and low-level driver should set it to NULL.
637 int (*set_tim
)(struct ieee80211_hw
*hw
, int aid
, int set
);
640 * Set encryption key.
642 * This is called to enable hardware acceleration of encryption and
643 * decryption. The address will be the broadcast address for default
644 * keys, the other station's hardware address for individual keys or
645 * the zero address for keys that will be used only for transmission.
647 * The local_address parameter will always be set to our own address,
648 * this is only relevant if you support multiple local addresses.
650 * When transmitting, the TX control data will use the hw_key_idx
651 * selected by the low-level driver.
653 * Return 0 if the key is now in use, -EOPNOTSUPP or -ENOSPC if it
654 * couldn't be added; if you return 0 then hw_key_idx must be
655 * assigned to something other than HW_KEY_IDX_INVALID. When the cmd
656 * is DISABLE_KEY then it must succeed.
658 * This callback can sleep, and is only called between add_interface
659 * and remove_interface calls, i.e. while the interface with the
660 * given local_address is enabled.
662 * The ieee80211_key_conf structure pointed to by the key parameter
663 * is guaranteed to be valid until another call to set_key removes
664 * it, but it can only be used as a cookie to differentiate keys.
666 int (*set_key
)(struct ieee80211_hw
*hw
, set_key_cmd cmd
,
667 const u8
*local_address
, const u8
*address
,
668 struct ieee80211_key_conf
*key
);
671 * Set TX key index for default/broadcast keys. This is needed in cases
672 * where wlan card is doing full WEP/TKIP encapsulation (wep_include_iv
673 * is not set), in other cases, this function pointer can be set to
674 * NULL since the IEEE 802.11 module takes care of selecting the key
675 * index for each TX frame.
677 * TODO: If you use this callback in your driver tell us if you need
678 * any other information from it to make it easier, like the
681 int (*set_key_idx
)(struct ieee80211_hw
*hw
, int idx
);
683 /* Enable/disable IEEE 802.1X. This item requests wlan card to pass
684 * unencrypted EAPOL-Key frames even when encryption is configured.
685 * If the wlan card does not require such a configuration, this
686 * function pointer can be set to NULL. */
687 int (*set_ieee8021x
)(struct ieee80211_hw
*hw
, int use_ieee8021x
);
689 /* Set port authorization state (IEEE 802.1X PAE) to be authorized
690 * (authorized=1) or unauthorized (authorized=0). This function can be
691 * used if the wlan hardware or low-level driver implements PAE.
692 * 80211.o module will anyway filter frames based on authorization
693 * state, so this function pointer can be NULL if low-level driver does
694 * not require event notification about port state changes.
695 * Currently unused. */
696 int (*set_port_auth
)(struct ieee80211_hw
*hw
, u8
*addr
,
699 /* Ask the hardware to service the scan request, no need to start
700 * the scan state machine in stack. */
701 int (*hw_scan
)(struct ieee80211_hw
*hw
, u8
*ssid
, size_t len
);
703 /* return low-level statistics */
704 int (*get_stats
)(struct ieee80211_hw
*hw
,
705 struct ieee80211_low_level_stats
*stats
);
707 /* For devices that generate their own beacons and probe response
708 * or association responses this updates the state of privacy_invoked
709 * returns 0 for success or an error number */
710 int (*set_privacy_invoked
)(struct ieee80211_hw
*hw
,
711 int privacy_invoked
);
713 /* For devices that have internal sequence counters, allow 802.11
714 * code to access the current value of a counter */
715 int (*get_sequence_counter
)(struct ieee80211_hw
*hw
,
716 u8
* addr
, u8 keyidx
, u8 txrx
,
717 u32
* iv32
, u16
* iv16
);
719 /* Configuration of RTS threshold (if device needs it) */
720 int (*set_rts_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
722 /* Configuration of fragmentation threshold.
723 * Assign this if the device does fragmentation by itself,
724 * if this method is assigned then the stack will not do
726 int (*set_frag_threshold
)(struct ieee80211_hw
*hw
, u32 value
);
728 /* Configuration of retry limits (if device needs it) */
729 int (*set_retry_limit
)(struct ieee80211_hw
*hw
,
730 u32 short_retry
, u32 long_retr
);
732 /* Number of STAs in STA table notification (NULL = disabled).
734 void (*sta_table_notification
)(struct ieee80211_hw
*hw
,
737 /* Handle ERP IE change notifications. Must be atomic. */
738 void (*erp_ie_changed
)(struct ieee80211_hw
*hw
, u8 changes
,
739 int cts_protection
, int preamble
);
741 /* Flags for the erp_ie_changed changes parameter */
742 #define IEEE80211_ERP_CHANGE_PROTECTION (1<<0) /* protection flag changed */
743 #define IEEE80211_ERP_CHANGE_PREAMBLE (1<<1) /* barker preamble mode changed */
745 /* Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
746 * bursting) for a hardware TX queue.
747 * queue = IEEE80211_TX_QUEUE_*.
749 int (*conf_tx
)(struct ieee80211_hw
*hw
, int queue
,
750 const struct ieee80211_tx_queue_params
*params
);
752 /* Get statistics of the current TX queue status. This is used to get
753 * number of currently queued packets (queue length), maximum queue
754 * size (limit), and total number of packets sent using each TX queue
756 * Currently unused. */
757 int (*get_tx_stats
)(struct ieee80211_hw
*hw
,
758 struct ieee80211_tx_queue_stats
*stats
);
760 /* Get the current TSF timer value from firmware/hardware. Currently,
761 * this is only used for IBSS mode debugging and, as such, is not a
764 u64 (*get_tsf
)(struct ieee80211_hw
*hw
);
766 /* Reset the TSF timer and allow firmware/hardware to synchronize with
767 * other STAs in the IBSS. This is only used in IBSS mode. This
768 * function is optional if the firmware/hardware takes full care of
769 * TSF synchronization. */
770 void (*reset_tsf
)(struct ieee80211_hw
*hw
);
772 /* Setup beacon data for IBSS beacons. Unlike access point (Master),
773 * IBSS uses a fixed beacon frame which is configured using this
774 * function. This handler is required only for IBSS mode. */
775 int (*beacon_update
)(struct ieee80211_hw
*hw
,
777 struct ieee80211_tx_control
*control
);
779 /* Determine whether the last IBSS beacon was sent by us. This is
780 * needed only for IBSS mode and the result of this function is used to
781 * determine whether to reply to Probe Requests. */
782 int (*tx_last_beacon
)(struct ieee80211_hw
*hw
);
785 /* Allocate a new hardware device. This must be called once for each
786 * hardware device. The returned pointer must be used to refer to this
787 * device when calling other functions. 802.11 code allocates a private data
788 * area for the low-level driver. The size of this area is given as
791 struct ieee80211_hw
*ieee80211_alloc_hw(size_t priv_data_len
,
792 const struct ieee80211_ops
*ops
);
794 /* Register hardware device to the IEEE 802.11 code and kernel. Low-level
795 * drivers must call this function before using any other IEEE 802.11
796 * function except ieee80211_register_hwmode. */
797 int ieee80211_register_hw(struct ieee80211_hw
*hw
);
799 /* driver can use this and ieee80211_get_rx_led_name to get the
800 * name of the registered LEDs after ieee80211_register_hw
802 * This is useful to set the default trigger on the LED class
803 * device that your driver should export for each LED the device
804 * has, that way the default behaviour will be as expected but
805 * the user can still change it/turn off the LED etc.
807 #ifdef CONFIG_MAC80211_LEDS
808 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
);
809 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
);
811 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw
*hw
)
813 #ifdef CONFIG_MAC80211_LEDS
814 return __ieee80211_get_tx_led_name(hw
);
820 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw
*hw
)
822 #ifdef CONFIG_MAC80211_LEDS
823 return __ieee80211_get_rx_led_name(hw
);
829 /* Register a new hardware PHYMODE capability to the stack. */
830 int ieee80211_register_hwmode(struct ieee80211_hw
*hw
,
831 struct ieee80211_hw_mode
*mode
);
833 /* Unregister a hardware device. This function instructs 802.11 code to free
834 * allocated resources and unregister netdevices from the kernel. */
835 void ieee80211_unregister_hw(struct ieee80211_hw
*hw
);
837 /* Free everything that was allocated including private data of a driver. */
838 void ieee80211_free_hw(struct ieee80211_hw
*hw
);
840 /* Receive frame callback function. The low-level driver uses this function to
841 * send received frames to the IEEE 802.11 code. Receive buffer (skb) must
842 * start with IEEE 802.11 header. */
843 void __ieee80211_rx(struct ieee80211_hw
*hw
, struct sk_buff
*skb
,
844 struct ieee80211_rx_status
*status
);
845 void ieee80211_rx_irqsafe(struct ieee80211_hw
*hw
,
847 struct ieee80211_rx_status
*status
);
849 /* Transmit status callback function. The low-level driver must call this
850 * function to report transmit status for all the TX frames that had
851 * req_tx_status set in the transmit control fields. In addition, this should
852 * be called at least for all unicast frames to provide information for TX rate
853 * control algorithm. In order to maintain all statistics, this function is
854 * recommended to be called after each frame, including multicast/broadcast, is
856 void ieee80211_tx_status(struct ieee80211_hw
*hw
,
858 struct ieee80211_tx_status
*status
);
859 void ieee80211_tx_status_irqsafe(struct ieee80211_hw
*hw
,
861 struct ieee80211_tx_status
*status
);
864 * ieee80211_beacon_get - beacon generation function
865 * @hw: pointer obtained from ieee80211_alloc_hw().
866 * @if_id: interface ID from &struct ieee80211_if_init_conf.
867 * @control: will be filled with information needed to send this beacon.
869 * If the beacon frames are generated by the host system (i.e., not in
870 * hardware/firmware), the low-level driver uses this function to receive
871 * the next beacon frame from the 802.11 code. The low-level is responsible
872 * for calling this function before beacon data is needed (e.g., based on
873 * hardware interrupt). Returned skb is used only once and low-level driver
874 * is responsible of freeing it.
876 struct sk_buff
*ieee80211_beacon_get(struct ieee80211_hw
*hw
,
878 struct ieee80211_tx_control
*control
);
881 * ieee80211_rts_get - RTS frame generation function
882 * @hw: pointer obtained from ieee80211_alloc_hw().
883 * @if_id: interface ID from &struct ieee80211_if_init_conf.
884 * @frame: pointer to the frame that is going to be protected by the RTS.
885 * @frame_len: the frame length (in octets).
886 * @frame_txctl: &struct ieee80211_tx_control of the frame.
887 * @rts: The buffer where to store the RTS frame.
889 * If the RTS frames are generated by the host system (i.e., not in
890 * hardware/firmware), the low-level driver uses this function to receive
891 * the next RTS frame from the 802.11 code. The low-level is responsible
892 * for calling this function before and RTS frame is needed.
894 void ieee80211_rts_get(struct ieee80211_hw
*hw
, int if_id
,
895 const void *frame
, size_t frame_len
,
896 const struct ieee80211_tx_control
*frame_txctl
,
897 struct ieee80211_rts
*rts
);
900 * ieee80211_rts_duration - Get the duration field for an RTS frame
901 * @hw: pointer obtained from ieee80211_alloc_hw().
902 * @if_id: interface ID from &struct ieee80211_if_init_conf.
903 * @frame_len: the length of the frame that is going to be protected by the RTS.
904 * @frame_txctl: &struct ieee80211_tx_control of the frame.
906 * If the RTS is generated in firmware, but the host system must provide
907 * the duration field, the low-level driver uses this function to receive
908 * the duration field value in little-endian byteorder.
910 __le16
ieee80211_rts_duration(struct ieee80211_hw
*hw
, int if_id
,
912 const struct ieee80211_tx_control
*frame_txctl
);
915 * ieee80211_ctstoself_get - CTS-to-self frame generation function
916 * @hw: pointer obtained from ieee80211_alloc_hw().
917 * @if_id: interface ID from &struct ieee80211_if_init_conf.
918 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
919 * @frame_len: the frame length (in octets).
920 * @frame_txctl: &struct ieee80211_tx_control of the frame.
921 * @cts: The buffer where to store the CTS-to-self frame.
923 * If the CTS-to-self frames are generated by the host system (i.e., not in
924 * hardware/firmware), the low-level driver uses this function to receive
925 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
926 * for calling this function before and CTS-to-self frame is needed.
928 void ieee80211_ctstoself_get(struct ieee80211_hw
*hw
, int if_id
,
929 const void *frame
, size_t frame_len
,
930 const struct ieee80211_tx_control
*frame_txctl
,
931 struct ieee80211_cts
*cts
);
934 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
935 * @hw: pointer obtained from ieee80211_alloc_hw().
936 * @if_id: interface ID from &struct ieee80211_if_init_conf.
937 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
938 * @frame_txctl: &struct ieee80211_tx_control of the frame.
940 * If the CTS-to-self is generated in firmware, but the host system must provide
941 * the duration field, the low-level driver uses this function to receive
942 * the duration field value in little-endian byteorder.
944 __le16
ieee80211_ctstoself_duration(struct ieee80211_hw
*hw
, int if_id
,
946 const struct ieee80211_tx_control
*frame_txctl
);
949 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
950 * @hw: pointer obtained from ieee80211_alloc_hw().
951 * @if_id: interface ID from &struct ieee80211_if_init_conf.
952 * @frame_len: the length of the frame.
953 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
955 * Calculate the duration field of some generic frame, given its
956 * length and transmission rate (in 100kbps).
958 __le16
ieee80211_generic_frame_duration(struct ieee80211_hw
*hw
, int if_id
,
963 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
964 * @hw: pointer as obtained from ieee80211_alloc_hw().
965 * @if_id: interface ID from &struct ieee80211_if_init_conf.
966 * @control: will be filled with information needed to send returned frame.
968 * Function for accessing buffered broadcast and multicast frames. If
969 * hardware/firmware does not implement buffering of broadcast/multicast
970 * frames when power saving is used, 802.11 code buffers them in the host
971 * memory. The low-level driver uses this function to fetch next buffered
972 * frame. In most cases, this is used when generating beacon frame. This
973 * function returns a pointer to the next buffered skb or NULL if no more
974 * buffered frames are available.
976 * Note: buffered frames are returned only after DTIM beacon frame was
977 * generated with ieee80211_beacon_get() and the low-level driver must thus
978 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
979 * NULL if the previous generated beacon was not DTIM, so the low-level driver
980 * does not need to check for DTIM beacons separately and should be able to
981 * use common code for all beacons.
984 ieee80211_get_buffered_bc(struct ieee80211_hw
*hw
, int if_id
,
985 struct ieee80211_tx_control
*control
);
987 /* Given an sk_buff with a raw 802.11 header at the data pointer this function
988 * returns the 802.11 header length in bytes (not including encryption
989 * headers). If the data in the sk_buff is too short to contain a valid 802.11
990 * header the function returns 0.
992 int ieee80211_get_hdrlen_from_skb(const struct sk_buff
*skb
);
994 /* Like ieee80211_get_hdrlen_from_skb() but takes a FC in CPU order. */
995 int ieee80211_get_hdrlen(u16 fc
);
998 * ieee80211_wake_queue - wake specific queue
999 * @hw: pointer as obtained from ieee80211_alloc_hw().
1000 * @queue: queue number (counted from zero).
1002 * Drivers should use this function instead of netif_wake_queue.
1004 void ieee80211_wake_queue(struct ieee80211_hw
*hw
, int queue
);
1007 * ieee80211_stop_queue - stop specific queue
1008 * @hw: pointer as obtained from ieee80211_alloc_hw().
1009 * @queue: queue number (counted from zero).
1011 * Drivers should use this function instead of netif_stop_queue.
1013 void ieee80211_stop_queue(struct ieee80211_hw
*hw
, int queue
);
1016 * ieee80211_start_queues - start all queues
1017 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1019 * Drivers should use this function instead of netif_start_queue.
1021 void ieee80211_start_queues(struct ieee80211_hw
*hw
);
1024 * ieee80211_stop_queues - stop all queues
1025 * @hw: pointer as obtained from ieee80211_alloc_hw().
1027 * Drivers should use this function instead of netif_stop_queue.
1029 void ieee80211_stop_queues(struct ieee80211_hw
*hw
);
1032 * ieee80211_wake_queues - wake all queues
1033 * @hw: pointer as obtained from ieee80211_alloc_hw().
1035 * Drivers should use this function instead of netif_wake_queue.
1037 void ieee80211_wake_queues(struct ieee80211_hw
*hw
);
1040 * ieee80211_get_mc_list_item - iteration over items in multicast list
1041 * @hw: pointer as obtained from ieee80211_alloc_hw().
1042 * @prev: value returned by previous call to ieee80211_get_mc_list_item() or
1043 * NULL to start a new iteration.
1044 * @ptr: pointer to buffer of void * type for internal usage of
1045 * ieee80211_get_mc_list_item().
1047 * Iterates over items in multicast list of given device. To get the first
1048 * item, pass NULL in @prev and in *@ptr. In subsequent calls, pass the
1049 * value returned by previous call in @prev. Don't alter *@ptr during
1050 * iteration. When there are no more items, NULL is returned.
1052 struct dev_mc_list
*
1053 ieee80211_get_mc_list_item(struct ieee80211_hw
*hw
,
1054 struct dev_mc_list
*prev
,
1057 /* called by driver to notify scan status completed */
1058 void ieee80211_scan_completed(struct ieee80211_hw
*hw
);
1060 /* return a pointer to the source address (SA) */
1061 static inline u8
*ieee80211_get_SA(struct ieee80211_hdr
*hdr
)
1063 u8
*raw
= (u8
*) hdr
;
1064 u8 tofrom
= (*(raw
+1)) & 3; /* get the TODS and FROMDS bits */
1075 /* return a pointer to the destination address (DA) */
1076 static inline u8
*ieee80211_get_DA(struct ieee80211_hdr
*hdr
)
1078 u8
*raw
= (u8
*) hdr
;
1079 u8 to_ds
= (*(raw
+1)) & 1; /* get the TODS bit */
1086 static inline int ieee80211_get_morefrag(struct ieee80211_hdr
*hdr
)
1088 return (le16_to_cpu(hdr
->frame_control
) &
1089 IEEE80211_FCTL_MOREFRAGS
) != 0;
1092 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
1093 #define MAC_ARG(x) ((u8*)(x))[0], ((u8*)(x))[1], ((u8*)(x))[2], \
1094 ((u8*)(x))[3], ((u8*)(x))[4], ((u8*)(x))[5]
1096 #endif /* MAC80211_H */