mac80211.h revision 82f716056fb1c214289fe6c284b0316858c1b70c
1/* 2 * Low-level hardware driver -- IEEE 802.11 driver (80211.o) interface 3 * Copyright 2002-2005, Devicescape Software, Inc. 4 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz> 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License version 2 as 8 * published by the Free Software Foundation. 9 */ 10 11#ifndef MAC80211_H 12#define MAC80211_H 13 14#include <linux/kernel.h> 15#include <linux/if_ether.h> 16#include <linux/skbuff.h> 17#include <linux/wireless.h> 18#include <linux/device.h> 19#include <linux/ieee80211.h> 20#include <net/wireless.h> 21#include <net/cfg80211.h> 22 23/* Note! Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be 24 * called in hardware interrupt context. The low-level driver must not call any 25 * other functions in hardware interrupt context. If there is a need for such 26 * call, the low-level driver should first ACK the interrupt and perform the 27 * IEEE 802.11 code call after this, e.g., from a scheduled tasklet (in 28 * software interrupt context). 29 */ 30 31/* 32 * Frame format used when passing frame between low-level hardware drivers 33 * and IEEE 802.11 driver the same as used in the wireless media, i.e., 34 * buffers start with IEEE 802.11 header and include the same octets that 35 * are sent over air. 36 * 37 * If hardware uses IEEE 802.3 headers (and perform 802.3 <-> 802.11 38 * conversion in firmware), upper layer 802.11 code needs to be changed to 39 * support this. 40 * 41 * If the receive frame format is not the same as the real frame sent 42 * on the wireless media (e.g., due to padding etc.), upper layer 802.11 code 43 * could be updated to provide support for such format assuming this would 44 * optimize the performance, e.g., by removing need to re-allocation and 45 * copying of the data. 46 */ 47 48#define IEEE80211_CHAN_W_SCAN 0x00000001 49#define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002 50#define IEEE80211_CHAN_W_IBSS 0x00000004 51 52/* Channel information structure. Low-level driver is expected to fill in chan, 53 * freq, and val fields. Other fields will be filled in by 80211.o based on 54 * hostapd information and low-level driver does not need to use them. The 55 * limits for each channel will be provided in 'struct ieee80211_conf' when 56 * configuring the low-level driver with hw->config callback. If a device has 57 * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED 58 * can be set to let the driver configure all fields */ 59struct ieee80211_channel { 60 short chan; /* channel number (IEEE 802.11) */ 61 short freq; /* frequency in MHz */ 62 int val; /* hw specific value for the channel */ 63 int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */ 64 unsigned char power_level; 65 unsigned char antenna_max; 66}; 67 68#define IEEE80211_RATE_ERP 0x00000001 69#define IEEE80211_RATE_BASIC 0x00000002 70#define IEEE80211_RATE_PREAMBLE2 0x00000004 71#define IEEE80211_RATE_SUPPORTED 0x00000010 72#define IEEE80211_RATE_OFDM 0x00000020 73#define IEEE80211_RATE_CCK 0x00000040 74#define IEEE80211_RATE_TURBO 0x00000080 75#define IEEE80211_RATE_MANDATORY 0x00000100 76 77#define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2) 78#define IEEE80211_RATE_MODULATION(f) \ 79 (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM)) 80 81/* Low-level driver should set PREAMBLE2, OFDM, CCK, and TURBO flags. 82 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the 83 * configuration. */ 84struct ieee80211_rate { 85 int rate; /* rate in 100 kbps */ 86 int val; /* hw specific value for the rate */ 87 int flags; /* IEEE80211_RATE_ flags */ 88 int val2; /* hw specific value for the rate when using short preamble 89 * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for 90 * 2, 5.5, and 11 Mbps) */ 91 signed char min_rssi_ack; 92 unsigned char min_rssi_ack_delta; 93 94 /* following fields are set by 80211.o and need not be filled by the 95 * low-level driver */ 96 int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for 97 * optimizing channel utilization estimates */ 98}; 99 100/* 802.11g is backwards-compatible with 802.11b, so a wlan card can 101 * actually be both in 11b and 11g modes at the same time. */ 102enum { 103 MODE_IEEE80211A, /* IEEE 802.11a */ 104 MODE_IEEE80211B, /* IEEE 802.11b only */ 105 MODE_ATHEROS_TURBO, /* Atheros Turbo mode (2x.11a at 5 GHz) */ 106 MODE_IEEE80211G, /* IEEE 802.11g (and 802.11b compatibility) */ 107 MODE_ATHEROS_TURBOG, /* Atheros Turbo mode (2x.11g at 2.4 GHz) */ 108 109 /* keep last */ 110 NUM_IEEE80211_MODES 111}; 112 113struct ieee80211_hw_mode { 114 int mode; /* MODE_IEEE80211... */ 115 int num_channels; /* Number of channels (below) */ 116 struct ieee80211_channel *channels; /* Array of supported channels */ 117 int num_rates; /* Number of rates (below) */ 118 struct ieee80211_rate *rates; /* Array of supported rates */ 119 120 struct list_head list; /* Internal, don't touch */ 121}; 122 123struct ieee80211_tx_queue_params { 124 int aifs; /* 0 .. 255; -1 = use default */ 125 int cw_min; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */ 126 int cw_max; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */ 127 int burst_time; /* maximum burst time in 0.1 ms (i.e., 10 = 1 ms); 128 * 0 = disabled */ 129}; 130 131struct ieee80211_tx_queue_stats_data { 132 unsigned int len; /* num packets in queue */ 133 unsigned int limit; /* queue len (soft) limit */ 134 unsigned int count; /* total num frames sent */ 135}; 136 137enum { 138 IEEE80211_TX_QUEUE_DATA0, 139 IEEE80211_TX_QUEUE_DATA1, 140 IEEE80211_TX_QUEUE_DATA2, 141 IEEE80211_TX_QUEUE_DATA3, 142 IEEE80211_TX_QUEUE_DATA4, 143 IEEE80211_TX_QUEUE_SVP, 144 145 NUM_TX_DATA_QUEUES, 146 147/* due to stupidity in the sub-ioctl userspace interface, the items in 148 * this struct need to have fixed values. As soon as it is removed, we can 149 * fix these entries. */ 150 IEEE80211_TX_QUEUE_AFTER_BEACON = 6, 151 IEEE80211_TX_QUEUE_BEACON = 7 152}; 153 154struct ieee80211_tx_queue_stats { 155 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES]; 156}; 157 158struct ieee80211_low_level_stats { 159 unsigned int dot11ACKFailureCount; 160 unsigned int dot11RTSFailureCount; 161 unsigned int dot11FCSErrorCount; 162 unsigned int dot11RTSSuccessCount; 163}; 164 165/* Transmit control fields. This data structure is passed to low-level driver 166 * with each TX frame. The low-level driver is responsible for configuring 167 * the hardware to use given values (depending on what is supported). */ 168#define HW_KEY_IDX_INVALID -1 169 170struct ieee80211_tx_control { 171 int tx_rate; /* Transmit rate, given as the hw specific value for the 172 * rate (from struct ieee80211_rate) */ 173 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw 174 * specific value for the rate (from 175 * struct ieee80211_rate) */ 176 177#define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for 178 * this frame */ 179#define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without 180 * encryption; e.g., for EAPOL 181 * frames */ 182#define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending 183 * frame */ 184#define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the 185 * frame (e.g., for combined 186 * 802.11g / 802.11b networks) */ 187#define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to 188 * wait for an ack */ 189#define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5) 190#define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6) 191#define IEEE80211_TXCTL_REQUEUE (1<<7) 192#define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of 193 * the frame */ 194#define IEEE80211_TXCTL_TKIP_NEW_PHASE1_KEY (1<<9) 195#define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send 196 * using the through 197 * set_retry_limit configured 198 * long retry value */ 199 u32 flags; /* tx control flags defined 200 * above */ 201 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, .. 202 * This could be used when set_retry_limit 203 * is not implemented by the driver */ 204 u8 power_level; /* per-packet transmit power level, in dBm */ 205 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */ 206 s8 key_idx; /* -1 = do not encrypt, >= 0 keyidx from 207 * hw->set_key() */ 208 u8 icv_len; /* length of the ICV/MIC field in octets */ 209 u8 iv_len; /* length of the IV field in octets */ 210 u8 tkip_key[16]; /* generated phase2/phase1 key for hw TKIP */ 211 u8 queue; /* hardware queue to use for this frame; 212 * 0 = highest, hw->queues-1 = lowest */ 213 u8 sw_retry_attempt; /* number of times hw has tried to 214 * transmit frame (not incl. hw retries) */ 215 216 struct ieee80211_rate *rate; /* internal 80211.o rate */ 217 struct ieee80211_rate *rts_rate; /* internal 80211.o rate 218 * for RTS/CTS */ 219 int alt_retry_rate; /* retry rate for the last retries, given as the 220 * hw specific value for the rate (from 221 * struct ieee80211_rate). To be used to limit 222 * packet dropping when probing higher rates, if hw 223 * supports multiple retry rates. -1 = not used */ 224 int type; /* internal */ 225 int ifindex; /* internal */ 226}; 227 228/* Receive status. The low-level driver should provide this information 229 * (the subset supported by hardware) to the 802.11 code with each received 230 * frame. */ 231struct ieee80211_rx_status { 232 u64 mactime; 233 int freq; /* receive frequency in Mhz */ 234 int channel; 235 int phymode; 236 int ssi; 237 int signal; /* used as qual in statistics reporting */ 238 int noise; 239 int antenna; 240 int rate; 241#define RX_FLAG_MMIC_ERROR (1<<0) 242#define RX_FLAG_DECRYPTED (1<<1) 243#define RX_FLAG_RADIOTAP (1<<2) 244 int flag; 245}; 246 247/* Transmit status. The low-level driver should provide this information 248 * (the subset supported by hardware) to the 802.11 code for each transmit 249 * frame. */ 250struct ieee80211_tx_status { 251 /* copied ieee80211_tx_control structure */ 252 struct ieee80211_tx_control control; 253 254#define IEEE80211_TX_STATUS_TX_FILTERED (1<<0) 255#define IEEE80211_TX_STATUS_ACK (1<<1) /* whether the TX frame was ACKed */ 256 u32 flags; /* tx staus flags defined above */ 257 258 int ack_signal; /* measured signal strength of the ACK frame */ 259 int excessive_retries; 260 int retry_count; 261 262 int queue_length; /* information about TX queue */ 263 int queue_number; 264}; 265 266 267/** 268 * struct ieee80211_conf - configuration of the device 269 * 270 * This struct indicates how the driver shall configure the hardware. 271 * 272 * @radio_enabled: when zero, driver is required to switch off the radio. 273 */ 274struct ieee80211_conf { 275 int channel; /* IEEE 802.11 channel number */ 276 int freq; /* MHz */ 277 int channel_val; /* hw specific value for the channel */ 278 279 int phymode; /* MODE_IEEE80211A, .. */ 280 struct ieee80211_channel *chan; 281 struct ieee80211_hw_mode *mode; 282 unsigned int regulatory_domain; 283 int radio_enabled; 284 285 int beacon_int; 286 287#define IEEE80211_CONF_SHORT_SLOT_TIME (1<<0) /* use IEEE 802.11g Short Slot 288 * Time */ 289#define IEEE80211_CONF_SSID_HIDDEN (1<<1) /* do not broadcast the ssid */ 290#define IEEE80211_CONF_RADIOTAP (1<<2) /* use radiotap if supported 291 check this bit at RX time */ 292 u32 flags; /* configuration flags defined above */ 293 294 u8 power_level; /* transmit power limit for current 295 * regulatory domain; in dBm */ 296 u8 antenna_max; /* maximum antenna gain */ 297 short tx_power_reduction; /* in 0.1 dBm */ 298 299 /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */ 300 u8 antenna_sel_tx; 301 u8 antenna_sel_rx; 302 303 int antenna_def; 304 int antenna_mode; 305 306 /* Following five fields are used for IEEE 802.11H */ 307 unsigned int radar_detect; 308 unsigned int spect_mgmt; 309 /* All following fields are currently unused. */ 310 unsigned int quiet_duration; /* duration of quiet period */ 311 unsigned int quiet_offset; /* how far into the beacon is the quiet 312 * period */ 313 unsigned int quiet_period; 314 u8 radar_firpwr_threshold; 315 u8 radar_rssi_threshold; 316 u8 pulse_height_threshold; 317 u8 pulse_rssi_threshold; 318 u8 pulse_inband_threshold; 319}; 320 321/** 322 * enum ieee80211_if_types - types of 802.11 network interfaces 323 * 324 * @IEEE80211_IF_TYPE_AP: interface in AP mode. 325 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap 326 * daemon. Drivers should never see this type. 327 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode. 328 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode. 329 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode. 330 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode. 331 * @IEEE80211_IF_TYPE_VLAN: not used. 332 */ 333enum ieee80211_if_types { 334 IEEE80211_IF_TYPE_AP = 0x00000000, 335 IEEE80211_IF_TYPE_MGMT = 0x00000001, 336 IEEE80211_IF_TYPE_STA = 0x00000002, 337 IEEE80211_IF_TYPE_IBSS = 0x00000003, 338 IEEE80211_IF_TYPE_MNTR = 0x00000004, 339 IEEE80211_IF_TYPE_WDS = 0x5A580211, 340 IEEE80211_IF_TYPE_VLAN = 0x00080211, 341}; 342 343/** 344 * struct ieee80211_if_init_conf - initial configuration of an interface 345 * 346 * @if_id: internal interface ID. This number has no particular meaning to 347 * drivers and the only allowed usage is to pass it to 348 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions. 349 * This field is not valid for monitor interfaces 350 * (interfaces of %IEEE80211_IF_TYPE_MNTR type). 351 * @type: one of &enum ieee80211_if_types constants. Determines the type of 352 * added/removed interface. 353 * @mac_addr: pointer to MAC address of the interface. This pointer is valid 354 * until the interface is removed (i.e. it cannot be used after 355 * remove_interface() callback was called for this interface). 356 * This pointer will be %NULL for monitor interfaces, be careful. 357 * 358 * This structure is used in add_interface() and remove_interface() 359 * callbacks of &struct ieee80211_hw. 360 * 361 * When you allow multiple interfaces to be added to your PHY, take care 362 * that the hardware can actually handle multiple MAC addresses. However, 363 * also take care that when there's no interface left with mac_addr != %NULL 364 * you remove the MAC address from the device to avoid acknowledging packets 365 * in pure monitor mode. 366 */ 367struct ieee80211_if_init_conf { 368 int if_id; 369 int type; 370 void *mac_addr; 371}; 372 373/** 374 * struct ieee80211_if_conf - configuration of an interface 375 * 376 * @type: type of the interface. This is always the same as was specified in 377 * &struct ieee80211_if_init_conf. The type of an interface never changes 378 * during the life of the interface; this field is present only for 379 * convenience. 380 * @bssid: BSSID of the network we are associated to/creating. 381 * @ssid: used (together with @ssid_len) by drivers for hardware that 382 * generate beacons independently. The pointer is valid only during the 383 * config_interface() call, so copy the value somewhere if you need 384 * it. 385 * @ssid_len: length of the @ssid field. 386 * @generic_elem: used (together with @generic_elem_len) by drivers for 387 * hardware that generate beacons independently. The pointer is valid 388 * only during the config_interface() call, so copy the value somewhere 389 * if you need it. 390 * @generic_elem_len: length of the generic element. 391 * @beacon: beacon template. Valid only if @host_gen_beacon_template in 392 * &struct ieee80211_hw is set. The driver is responsible of freeing 393 * the sk_buff. 394 * @beacon_control: tx_control for the beacon template, this field is only 395 * valid when the @beacon field was set. 396 * 397 * This structure is passed to the config_interface() callback of 398 * &struct ieee80211_hw. 399 */ 400struct ieee80211_if_conf { 401 int type; 402 u8 *bssid; 403 u8 *ssid; 404 size_t ssid_len; 405 u8 *generic_elem; 406 size_t generic_elem_len; 407 struct sk_buff *beacon; 408 struct ieee80211_tx_control *beacon_control; 409}; 410 411typedef enum { ALG_NONE, ALG_WEP, ALG_TKIP, ALG_CCMP, ALG_NULL } 412ieee80211_key_alg; 413 414 415struct ieee80211_key_conf { 416 417 int hw_key_idx; /* filled + used by low-level driver */ 418 ieee80211_key_alg alg; 419 int keylen; 420 421#define IEEE80211_KEY_FORCE_SW_ENCRYPT (1<<0) /* to be cleared by low-level 422 driver */ 423#define IEEE80211_KEY_DEFAULT_TX_KEY (1<<1) /* This key is the new default TX 424 key (used only for broadcast 425 keys). */ 426#define IEEE80211_KEY_DEFAULT_WEP_ONLY (1<<2) /* static WEP is the only 427 configured security policy; 428 this allows some low-level 429 drivers to determine when 430 hwaccel can be used */ 431 u32 flags; /* key configuration flags defined above */ 432 433 s8 keyidx; /* WEP key index */ 434 u8 key[0]; 435}; 436 437#define IEEE80211_SEQ_COUNTER_RX 0 438#define IEEE80211_SEQ_COUNTER_TX 1 439 440typedef enum { 441 SET_KEY, DISABLE_KEY, REMOVE_ALL_KEYS, 442} set_key_cmd; 443 444/* This is driver-visible part of the per-hw state the stack keeps. */ 445struct ieee80211_hw { 446 /* points to the cfg80211 wiphy for this piece. Note 447 * that you must fill in the perm_addr and dev fields 448 * of this structure, use the macros provided below. */ 449 struct wiphy *wiphy; 450 451 /* assigned by mac80211, don't write */ 452 struct ieee80211_conf conf; 453 454 /* Single thread workqueue available for driver use 455 * Allocated by mac80211 on registration */ 456 struct workqueue_struct *workqueue; 457 458 /* Pointer to the private area that was 459 * allocated with this struct for you. */ 460 void *priv; 461 462 /* The rest is information about your hardware */ 463 464 /* TODO: frame_type 802.11/802.3, sw_encryption requirements */ 465 466/* hole at 0 */ 467 468 /* 469 * The device only needs to be supplied with a beacon template. 470 * If you need the host to generate each beacon then don't use 471 * this flag and use ieee80211_beacon_get(). 472 */ 473#define IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE (1<<1) 474 475 /* Some devices handle decryption internally and do not 476 * indicate whether the frame was encrypted (unencrypted frames 477 * will be dropped by the hardware, unless specifically allowed 478 * through) */ 479#define IEEE80211_HW_DEVICE_HIDES_WEP (1<<2) 480 481 /* Whether RX frames passed to ieee80211_rx() include FCS in the end */ 482#define IEEE80211_HW_RX_INCLUDES_FCS (1<<3) 483 484 /* Some wireless LAN chipsets buffer broadcast/multicast frames for 485 * power saving stations in the hardware/firmware and others rely on 486 * the host system for such buffering. This option is used to 487 * configure the IEEE 802.11 upper layer to buffer broadcast/multicast 488 * frames when there are power saving stations so that low-level driver 489 * can fetch them with ieee80211_get_buffered_bc(). */ 490#define IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING (1<<4) 491 492#define IEEE80211_HW_WEP_INCLUDE_IV (1<<5) 493 494/* hole at 6 */ 495 496 /* Force software encryption for TKIP packets if WMM is enabled. */ 497#define IEEE80211_HW_NO_TKIP_WMM_HWACCEL (1<<7) 498 499 /* Some devices handle Michael MIC internally and do not include MIC in 500 * the received packets passed up. device_strips_mic must be set 501 * for such devices. The 'encryption' frame control bit is expected to 502 * be still set in the IEEE 802.11 header with this option unlike with 503 * the device_hides_wep configuration option. 504 */ 505#define IEEE80211_HW_DEVICE_STRIPS_MIC (1<<8) 506 507 /* Device is capable of performing full monitor mode even during 508 * normal operation. */ 509#define IEEE80211_HW_MONITOR_DURING_OPER (1<<9) 510 511 /* Device does not need BSSID filter set to broadcast in order to 512 * receive all probe responses while scanning */ 513#define IEEE80211_HW_NO_PROBE_FILTERING (1<<10) 514 515 /* Channels are already configured to the default regulatory domain 516 * specified in the device's EEPROM */ 517#define IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED (1<<11) 518 519 /* calculate Michael MIC for an MSDU when doing hwcrypto */ 520#define IEEE80211_HW_TKIP_INCLUDE_MMIC (1<<12) 521 /* Do TKIP phase1 key mixing in stack to support cards only do 522 * phase2 key mixing when doing hwcrypto */ 523#define IEEE80211_HW_TKIP_REQ_PHASE1_KEY (1<<13) 524 /* Do TKIP phase1 and phase2 key mixing in stack and send the generated 525 * per-packet RC4 key with each TX frame when doing hwcrypto */ 526#define IEEE80211_HW_TKIP_REQ_PHASE2_KEY (1<<14) 527 528 u32 flags; /* hardware flags defined above */ 529 530 /* Set to the size of a needed device specific skb headroom for TX skbs. */ 531 unsigned int extra_tx_headroom; 532 533 /* This is the time in us to change channels 534 */ 535 int channel_change_time; 536 /* Maximum values for various statistics. 537 * Leave at 0 to indicate no support. Use negative numbers for dBm. */ 538 s8 max_rssi; 539 s8 max_signal; 540 s8 max_noise; 541 542 /* Number of available hardware TX queues for data packets. 543 * WMM requires at least four queues. */ 544 int queues; 545}; 546 547static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 548{ 549 set_wiphy_dev(hw->wiphy, dev); 550} 551 552static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 553{ 554 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 555} 556 557/* Configuration block used by the low-level driver to tell the 802.11 code 558 * about supported hardware features and to pass function pointers to callback 559 * functions. */ 560struct ieee80211_ops { 561 /* Handler that 802.11 module calls for each transmitted frame. 562 * skb contains the buffer starting from the IEEE 802.11 header. 563 * The low-level driver should send the frame out based on 564 * configuration in the TX control data. 565 * Must be atomic. */ 566 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb, 567 struct ieee80211_tx_control *control); 568 569 /* Handler that is called when any netdevice attached to the hardware 570 * device is set UP for the first time. This can be used, e.g., to 571 * enable interrupts and beacon sending. */ 572 int (*open)(struct ieee80211_hw *hw); 573 574 /* Handler that is called when the last netdevice attached to the 575 * hardware device is set DOWN. This can be used, e.g., to disable 576 * interrupts and beacon sending. */ 577 int (*stop)(struct ieee80211_hw *hw); 578 579 /* Handler for asking a driver if a new interface can be added (or, 580 * more exactly, set UP). If the handler returns zero, the interface 581 * is added. Driver should perform any initialization it needs prior 582 * to returning zero. By returning non-zero addition of the interface 583 * is inhibited. Unless monitor_during_oper is set, it is guaranteed 584 * that monitor interfaces and normal interfaces are mutually 585 * exclusive. If assigned, the open() handler is called after 586 * add_interface() if this is the first device added. The 587 * add_interface() callback has to be assigned because it is the only 588 * way to obtain the requested MAC address for any interface. 589 */ 590 int (*add_interface)(struct ieee80211_hw *hw, 591 struct ieee80211_if_init_conf *conf); 592 593 /* Notify a driver that an interface is going down. The stop() handler 594 * is called prior to this if this is a last interface. */ 595 void (*remove_interface)(struct ieee80211_hw *hw, 596 struct ieee80211_if_init_conf *conf); 597 598 /* Handler for configuration requests. IEEE 802.11 code calls this 599 * function to change hardware configuration, e.g., channel. */ 600 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf); 601 602 /* Handler for configuration requests related to interfaces (e.g. 603 * BSSID). */ 604 int (*config_interface)(struct ieee80211_hw *hw, 605 int if_id, struct ieee80211_if_conf *conf); 606 607 /* ieee80211 drivers do not have access to the &struct net_device 608 * that is (are) connected with their device. Hence (and because 609 * we need to combine the multicast lists and flags for multiple 610 * virtual interfaces), they cannot assign set_multicast_list. 611 * The parameters here replace dev->flags and dev->mc_count, 612 * dev->mc_list is replaced by calling ieee80211_get_mc_list_item. 613 * Must be atomic. */ 614 void (*set_multicast_list)(struct ieee80211_hw *hw, 615 unsigned short flags, int mc_count); 616 617 /* Set TIM bit handler. If the hardware/firmware takes care of beacon 618 * generation, IEEE 802.11 code uses this function to tell the 619 * low-level to set (or clear if set==0) TIM bit for the given aid. If 620 * host system is used to generate beacons, this handler is not used 621 * and low-level driver should set it to NULL. 622 * Must be atomic. */ 623 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set); 624 625 /* Set encryption key. IEEE 802.11 module calls this function to set 626 * encryption keys. addr is ff:ff:ff:ff:ff:ff for default keys and 627 * station hwaddr for individual keys. aid of the station is given 628 * to help low-level driver in selecting which key->hw_key_idx to use 629 * for this key. TX control data will use the hw_key_idx selected by 630 * the low-level driver. */ 631 int (*set_key)(struct ieee80211_hw *hw, set_key_cmd cmd, 632 u8 *addr, struct ieee80211_key_conf *key, int aid); 633 634 /* Set TX key index for default/broadcast keys. This is needed in cases 635 * where wlan card is doing full WEP/TKIP encapsulation (wep_include_iv 636 * is not set), in other cases, this function pointer can be set to 637 * NULL since the IEEE 802. 11 module takes care of selecting the key 638 * index for each TX frame. */ 639 int (*set_key_idx)(struct ieee80211_hw *hw, int idx); 640 641 /* Enable/disable IEEE 802.1X. This item requests wlan card to pass 642 * unencrypted EAPOL-Key frames even when encryption is configured. 643 * If the wlan card does not require such a configuration, this 644 * function pointer can be set to NULL. */ 645 int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x); 646 647 /* Set port authorization state (IEEE 802.1X PAE) to be authorized 648 * (authorized=1) or unauthorized (authorized=0). This function can be 649 * used if the wlan hardware or low-level driver implements PAE. 650 * 80211.o module will anyway filter frames based on authorization 651 * state, so this function pointer can be NULL if low-level driver does 652 * not require event notification about port state changes. 653 * Currently unused. */ 654 int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr, 655 int authorized); 656 657 /* Ask the hardware to service the scan request, no need to start 658 * the scan state machine in stack. */ 659 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len); 660 661 /* return low-level statistics */ 662 int (*get_stats)(struct ieee80211_hw *hw, 663 struct ieee80211_low_level_stats *stats); 664 665 /* For devices that generate their own beacons and probe response 666 * or association responses this updates the state of privacy_invoked 667 * returns 0 for success or an error number */ 668 int (*set_privacy_invoked)(struct ieee80211_hw *hw, 669 int privacy_invoked); 670 671 /* For devices that have internal sequence counters, allow 802.11 672 * code to access the current value of a counter */ 673 int (*get_sequence_counter)(struct ieee80211_hw *hw, 674 u8* addr, u8 keyidx, u8 txrx, 675 u32* iv32, u16* iv16); 676 677 /* Configuration of RTS threshold (if device needs it) */ 678 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 679 680 /* Configuration of fragmentation threshold. 681 * Assign this if the device does fragmentation by itself, 682 * if this method is assigned then the stack will not do 683 * fragmentation. */ 684 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); 685 686 /* Configuration of retry limits (if device needs it) */ 687 int (*set_retry_limit)(struct ieee80211_hw *hw, 688 u32 short_retry, u32 long_retr); 689 690 /* Number of STAs in STA table notification (NULL = disabled). 691 * Must be atomic. */ 692 void (*sta_table_notification)(struct ieee80211_hw *hw, 693 int num_sta); 694 695 /* Handle ERP IE change notifications. Must be atomic. */ 696 void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes, 697 int cts_protection, int preamble); 698 699 /* Flags for the erp_ie_changed changes parameter */ 700#define IEEE80211_ERP_CHANGE_PROTECTION (1<<0) /* protection flag changed */ 701#define IEEE80211_ERP_CHANGE_PREAMBLE (1<<1) /* barker preamble mode changed */ 702 703 /* Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 704 * bursting) for a hardware TX queue. 705 * queue = IEEE80211_TX_QUEUE_*. 706 * Must be atomic. */ 707 int (*conf_tx)(struct ieee80211_hw *hw, int queue, 708 const struct ieee80211_tx_queue_params *params); 709 710 /* Get statistics of the current TX queue status. This is used to get 711 * number of currently queued packets (queue length), maximum queue 712 * size (limit), and total number of packets sent using each TX queue 713 * (count). 714 * Currently unused. */ 715 int (*get_tx_stats)(struct ieee80211_hw *hw, 716 struct ieee80211_tx_queue_stats *stats); 717 718 /* Get the current TSF timer value from firmware/hardware. Currently, 719 * this is only used for IBSS mode debugging and, as such, is not a 720 * required function. 721 * Must be atomic. */ 722 u64 (*get_tsf)(struct ieee80211_hw *hw); 723 724 /* Reset the TSF timer and allow firmware/hardware to synchronize with 725 * other STAs in the IBSS. This is only used in IBSS mode. This 726 * function is optional if the firmware/hardware takes full care of 727 * TSF synchronization. */ 728 void (*reset_tsf)(struct ieee80211_hw *hw); 729 730 /* Setup beacon data for IBSS beacons. Unlike access point (Master), 731 * IBSS uses a fixed beacon frame which is configured using this 732 * function. This handler is required only for IBSS mode. */ 733 int (*beacon_update)(struct ieee80211_hw *hw, 734 struct sk_buff *skb, 735 struct ieee80211_tx_control *control); 736 737 /* Determine whether the last IBSS beacon was sent by us. This is 738 * needed only for IBSS mode and the result of this function is used to 739 * determine whether to reply to Probe Requests. */ 740 int (*tx_last_beacon)(struct ieee80211_hw *hw); 741}; 742 743/* Allocate a new hardware device. This must be called once for each 744 * hardware device. The returned pointer must be used to refer to this 745 * device when calling other functions. 802.11 code allocates a private data 746 * area for the low-level driver. The size of this area is given as 747 * priv_data_len. 748 */ 749struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 750 const struct ieee80211_ops *ops); 751 752/* Register hardware device to the IEEE 802.11 code and kernel. Low-level 753 * drivers must call this function before using any other IEEE 802.11 754 * function except ieee80211_register_hwmode. */ 755int ieee80211_register_hw(struct ieee80211_hw *hw); 756 757/* driver can use this and ieee80211_get_rx_led_name to get the 758 * name of the registered LEDs after ieee80211_register_hw 759 * was called. 760 * This is useful to set the default trigger on the LED class 761 * device that your driver should export for each LED the device 762 * has, that way the default behaviour will be as expected but 763 * the user can still change it/turn off the LED etc. 764 */ 765#ifdef CONFIG_MAC80211_LEDS 766extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 767extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 768#endif 769static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 770{ 771#ifdef CONFIG_MAC80211_LEDS 772 return __ieee80211_get_tx_led_name(hw); 773#else 774 return NULL; 775#endif 776} 777 778static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 779{ 780#ifdef CONFIG_MAC80211_LEDS 781 return __ieee80211_get_rx_led_name(hw); 782#else 783 return NULL; 784#endif 785} 786 787/* Register a new hardware PHYMODE capability to the stack. */ 788int ieee80211_register_hwmode(struct ieee80211_hw *hw, 789 struct ieee80211_hw_mode *mode); 790 791/* Unregister a hardware device. This function instructs 802.11 code to free 792 * allocated resources and unregister netdevices from the kernel. */ 793void ieee80211_unregister_hw(struct ieee80211_hw *hw); 794 795/* Free everything that was allocated including private data of a driver. */ 796void ieee80211_free_hw(struct ieee80211_hw *hw); 797 798/* Receive frame callback function. The low-level driver uses this function to 799 * send received frames to the IEEE 802.11 code. Receive buffer (skb) must 800 * start with IEEE 802.11 header. */ 801void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 802 struct ieee80211_rx_status *status); 803void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, 804 struct sk_buff *skb, 805 struct ieee80211_rx_status *status); 806 807/* Transmit status callback function. The low-level driver must call this 808 * function to report transmit status for all the TX frames that had 809 * req_tx_status set in the transmit control fields. In addition, this should 810 * be called at least for all unicast frames to provide information for TX rate 811 * control algorithm. In order to maintain all statistics, this function is 812 * recommended to be called after each frame, including multicast/broadcast, is 813 * sent. */ 814void ieee80211_tx_status(struct ieee80211_hw *hw, 815 struct sk_buff *skb, 816 struct ieee80211_tx_status *status); 817void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 818 struct sk_buff *skb, 819 struct ieee80211_tx_status *status); 820 821/** 822 * ieee80211_beacon_get - beacon generation function 823 * @hw: pointer obtained from ieee80211_alloc_hw(). 824 * @if_id: interface ID from &struct ieee80211_if_init_conf. 825 * @control: will be filled with information needed to send this beacon. 826 * 827 * If the beacon frames are generated by the host system (i.e., not in 828 * hardware/firmware), the low-level driver uses this function to receive 829 * the next beacon frame from the 802.11 code. The low-level is responsible 830 * for calling this function before beacon data is needed (e.g., based on 831 * hardware interrupt). Returned skb is used only once and low-level driver 832 * is responsible of freeing it. 833 */ 834struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 835 int if_id, 836 struct ieee80211_tx_control *control); 837 838/** 839 * ieee80211_rts_get - RTS frame generation function 840 * @hw: pointer obtained from ieee80211_alloc_hw(). 841 * @if_id: interface ID from &struct ieee80211_if_init_conf. 842 * @frame: pointer to the frame that is going to be protected by the RTS. 843 * @frame_len: the frame length (in octets). 844 * @frame_txctl: &struct ieee80211_tx_control of the frame. 845 * @rts: The buffer where to store the RTS frame. 846 * 847 * If the RTS frames are generated by the host system (i.e., not in 848 * hardware/firmware), the low-level driver uses this function to receive 849 * the next RTS frame from the 802.11 code. The low-level is responsible 850 * for calling this function before and RTS frame is needed. 851 */ 852void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id, 853 const void *frame, size_t frame_len, 854 const struct ieee80211_tx_control *frame_txctl, 855 struct ieee80211_rts *rts); 856 857/** 858 * ieee80211_rts_duration - Get the duration field for an RTS frame 859 * @hw: pointer obtained from ieee80211_alloc_hw(). 860 * @if_id: interface ID from &struct ieee80211_if_init_conf. 861 * @frame_len: the length of the frame that is going to be protected by the RTS. 862 * @frame_txctl: &struct ieee80211_tx_control of the frame. 863 * 864 * If the RTS is generated in firmware, but the host system must provide 865 * the duration field, the low-level driver uses this function to receive 866 * the duration field value in little-endian byteorder. 867 */ 868__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id, 869 size_t frame_len, 870 const struct ieee80211_tx_control *frame_txctl); 871 872/** 873 * ieee80211_ctstoself_get - CTS-to-self frame generation function 874 * @hw: pointer obtained from ieee80211_alloc_hw(). 875 * @if_id: interface ID from &struct ieee80211_if_init_conf. 876 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 877 * @frame_len: the frame length (in octets). 878 * @frame_txctl: &struct ieee80211_tx_control of the frame. 879 * @cts: The buffer where to store the CTS-to-self frame. 880 * 881 * If the CTS-to-self frames are generated by the host system (i.e., not in 882 * hardware/firmware), the low-level driver uses this function to receive 883 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 884 * for calling this function before and CTS-to-self frame is needed. 885 */ 886void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id, 887 const void *frame, size_t frame_len, 888 const struct ieee80211_tx_control *frame_txctl, 889 struct ieee80211_cts *cts); 890 891/** 892 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 893 * @hw: pointer obtained from ieee80211_alloc_hw(). 894 * @if_id: interface ID from &struct ieee80211_if_init_conf. 895 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 896 * @frame_txctl: &struct ieee80211_tx_control of the frame. 897 * 898 * If the CTS-to-self is generated in firmware, but the host system must provide 899 * the duration field, the low-level driver uses this function to receive 900 * the duration field value in little-endian byteorder. 901 */ 902__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id, 903 size_t frame_len, 904 const struct ieee80211_tx_control *frame_txctl); 905 906/** 907 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 908 * @hw: pointer obtained from ieee80211_alloc_hw(). 909 * @if_id: interface ID from &struct ieee80211_if_init_conf. 910 * @frame_len: the length of the frame. 911 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted. 912 * 913 * Calculate the duration field of some generic frame, given its 914 * length and transmission rate (in 100kbps). 915 */ 916__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id, 917 size_t frame_len, 918 int rate); 919 920/** 921 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 922 * @hw: pointer as obtained from ieee80211_alloc_hw(). 923 * @if_id: interface ID from &struct ieee80211_if_init_conf. 924 * @control: will be filled with information needed to send returned frame. 925 * 926 * Function for accessing buffered broadcast and multicast frames. If 927 * hardware/firmware does not implement buffering of broadcast/multicast 928 * frames when power saving is used, 802.11 code buffers them in the host 929 * memory. The low-level driver uses this function to fetch next buffered 930 * frame. In most cases, this is used when generating beacon frame. This 931 * function returns a pointer to the next buffered skb or NULL if no more 932 * buffered frames are available. 933 * 934 * Note: buffered frames are returned only after DTIM beacon frame was 935 * generated with ieee80211_beacon_get() and the low-level driver must thus 936 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 937 * NULL if the previous generated beacon was not DTIM, so the low-level driver 938 * does not need to check for DTIM beacons separately and should be able to 939 * use common code for all beacons. 940 */ 941struct sk_buff * 942ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id, 943 struct ieee80211_tx_control *control); 944 945/* Given an sk_buff with a raw 802.11 header at the data pointer this function 946 * returns the 802.11 header length in bytes (not including encryption 947 * headers). If the data in the sk_buff is too short to contain a valid 802.11 948 * header the function returns 0. 949 */ 950int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); 951 952/* Like ieee80211_get_hdrlen_from_skb() but takes a FC in CPU order. */ 953int ieee80211_get_hdrlen(u16 fc); 954 955/** 956 * ieee80211_wake_queue - wake specific queue 957 * @hw: pointer as obtained from ieee80211_alloc_hw(). 958 * @queue: queue number (counted from zero). 959 * 960 * Drivers should use this function instead of netif_wake_queue. 961 */ 962void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 963 964/** 965 * ieee80211_stop_queue - stop specific queue 966 * @hw: pointer as obtained from ieee80211_alloc_hw(). 967 * @queue: queue number (counted from zero). 968 * 969 * Drivers should use this function instead of netif_stop_queue. 970 */ 971void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 972 973/** 974 * ieee80211_start_queues - start all queues 975 * @hw: pointer to as obtained from ieee80211_alloc_hw(). 976 * 977 * Drivers should use this function instead of netif_start_queue. 978 */ 979void ieee80211_start_queues(struct ieee80211_hw *hw); 980 981/** 982 * ieee80211_stop_queues - stop all queues 983 * @hw: pointer as obtained from ieee80211_alloc_hw(). 984 * 985 * Drivers should use this function instead of netif_stop_queue. 986 */ 987void ieee80211_stop_queues(struct ieee80211_hw *hw); 988 989/** 990 * ieee80211_wake_queues - wake all queues 991 * @hw: pointer as obtained from ieee80211_alloc_hw(). 992 * 993 * Drivers should use this function instead of netif_wake_queue. 994 */ 995void ieee80211_wake_queues(struct ieee80211_hw *hw); 996 997/** 998 * ieee80211_get_mc_list_item - iteration over items in multicast list 999 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1000 * @prev: value returned by previous call to ieee80211_get_mc_list_item() or 1001 * NULL to start a new iteration. 1002 * @ptr: pointer to buffer of void * type for internal usage of 1003 * ieee80211_get_mc_list_item(). 1004 * 1005 * Iterates over items in multicast list of given device. To get the first 1006 * item, pass NULL in @prev and in *@ptr. In subsequent calls, pass the 1007 * value returned by previous call in @prev. Don't alter *@ptr during 1008 * iteration. When there are no more items, NULL is returned. 1009 */ 1010struct dev_mc_list * 1011ieee80211_get_mc_list_item(struct ieee80211_hw *hw, 1012 struct dev_mc_list *prev, 1013 void **ptr); 1014 1015/* called by driver to notify scan status completed */ 1016void ieee80211_scan_completed(struct ieee80211_hw *hw); 1017 1018/* return a pointer to the source address (SA) */ 1019static inline u8 *ieee80211_get_SA(struct ieee80211_hdr *hdr) 1020{ 1021 u8 *raw = (u8 *) hdr; 1022 u8 tofrom = (*(raw+1)) & 3; /* get the TODS and FROMDS bits */ 1023 1024 switch (tofrom) { 1025 case 2: 1026 return hdr->addr3; 1027 case 3: 1028 return hdr->addr4; 1029 } 1030 return hdr->addr2; 1031} 1032 1033/* return a pointer to the destination address (DA) */ 1034static inline u8 *ieee80211_get_DA(struct ieee80211_hdr *hdr) 1035{ 1036 u8 *raw = (u8 *) hdr; 1037 u8 to_ds = (*(raw+1)) & 1; /* get the TODS bit */ 1038 1039 if (to_ds) 1040 return hdr->addr3; 1041 return hdr->addr1; 1042} 1043 1044static inline int ieee80211_get_morefrag(struct ieee80211_hdr *hdr) 1045{ 1046 return (le16_to_cpu(hdr->frame_control) & 1047 IEEE80211_FCTL_MOREFRAGS) != 0; 1048} 1049 1050#define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x" 1051#define MAC_ARG(x) ((u8*)(x))[0], ((u8*)(x))[1], ((u8*)(x))[2], \ 1052 ((u8*)(x))[3], ((u8*)(x))[4], ((u8*)(x))[5] 1053 1054#endif /* MAC80211_H */ 1055