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