mac80211.h revision f97df02e23269c7650869f6192e809f8ac1a4b39
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/** 26 * DOC: Introduction 27 * 28 * mac80211 is the Linux stack for 802.11 hardware that implements 29 * only partial functionality in hard- or firmware. This document 30 * defines the interface between mac80211 and low-level hardware 31 * drivers. 32 */ 33 34/** 35 * DOC: Calling mac80211 from interrupts 36 * 37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be 38 * called in hardware interrupt context. The low-level driver must not call any 39 * other functions in hardware interrupt context. If there is a need for such 40 * call, the low-level driver should first ACK the interrupt and perform the 41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue function. 42 */ 43 44/** 45 * DOC: Warning 46 * 47 * If you're reading this document and not the header file itself, it will 48 * be incomplete because not all documentation has been converted yet. 49 */ 50 51/** 52 * DOC: Frame format 53 * 54 * As a general rule, when frames are passed between mac80211 and the driver, 55 * they start with the IEEE 802.11 header and include the same octets that are 56 * sent over the air except for the FCS which should be calculated by the 57 * hardware. 58 * 59 * There are, however, various exceptions to this rule for advanced features: 60 * 61 * The first exception is for hardware encryption and decryption offload 62 * where the IV/ICV may or may not be generated in hardware. 63 * 64 * Secondly, when the hardware handles fragmentation, the frame handed to 65 * the driver from mac80211 is the MSDU, not the MPDU. 66 * 67 * Finally, for received frames, the driver is able to indicate that it has 68 * filled a radiotap header and put that in front of the frame; if it does 69 * not do so then mac80211 may add this under certain circumstances. 70 */ 71 72#define IEEE80211_CHAN_W_SCAN 0x00000001 73#define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002 74#define IEEE80211_CHAN_W_IBSS 0x00000004 75 76/* Channel information structure. Low-level driver is expected to fill in chan, 77 * freq, and val fields. Other fields will be filled in by 80211.o based on 78 * hostapd information and low-level driver does not need to use them. The 79 * limits for each channel will be provided in 'struct ieee80211_conf' when 80 * configuring the low-level driver with hw->config callback. If a device has 81 * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED 82 * can be set to let the driver configure all fields */ 83struct ieee80211_channel { 84 short chan; /* channel number (IEEE 802.11) */ 85 short freq; /* frequency in MHz */ 86 int val; /* hw specific value for the channel */ 87 int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */ 88 unsigned char power_level; 89 unsigned char antenna_max; 90}; 91 92#define IEEE80211_RATE_ERP 0x00000001 93#define IEEE80211_RATE_BASIC 0x00000002 94#define IEEE80211_RATE_PREAMBLE2 0x00000004 95#define IEEE80211_RATE_SUPPORTED 0x00000010 96#define IEEE80211_RATE_OFDM 0x00000020 97#define IEEE80211_RATE_CCK 0x00000040 98#define IEEE80211_RATE_MANDATORY 0x00000100 99 100#define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2) 101#define IEEE80211_RATE_MODULATION(f) \ 102 (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM)) 103 104/* Low-level driver should set PREAMBLE2, OFDM and CCK flags. 105 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the 106 * configuration. */ 107struct ieee80211_rate { 108 int rate; /* rate in 100 kbps */ 109 int val; /* hw specific value for the rate */ 110 int flags; /* IEEE80211_RATE_ flags */ 111 int val2; /* hw specific value for the rate when using short preamble 112 * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for 113 * 2, 5.5, and 11 Mbps) */ 114 signed char min_rssi_ack; 115 unsigned char min_rssi_ack_delta; 116 117 /* following fields are set by 80211.o and need not be filled by the 118 * low-level driver */ 119 int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for 120 * optimizing channel utilization estimates */ 121}; 122 123/** 124 * enum ieee80211_phymode - PHY modes 125 * 126 * @MODE_IEEE80211A: 5GHz as defined by 802.11a/802.11h 127 * @MODE_IEEE80211B: 2.4 GHz as defined by 802.11b 128 * @MODE_IEEE80211G: 2.4 GHz as defined by 802.11g (with OFDM), 129 * backwards compatible with 11b mode 130 * @NUM_IEEE80211_MODES: internal 131 */ 132enum ieee80211_phymode { 133 MODE_IEEE80211A, 134 MODE_IEEE80211B, 135 MODE_IEEE80211G, 136 137 /* keep last */ 138 NUM_IEEE80211_MODES 139}; 140 141/** 142 * struct ieee80211_hw_mode - PHY mode definition 143 * 144 * This structure describes the capabilities supported by the device 145 * in a single PHY mode. 146 * 147 * @mode: the PHY mode for this definition 148 * @num_channels: number of supported channels 149 * @channels: pointer to array of supported channels 150 * @num_rates: number of supported bitrates 151 * @rates: pointer to array of supported bitrates 152 * @list: internal 153 */ 154struct ieee80211_hw_mode { 155 struct list_head list; 156 struct ieee80211_channel *channels; 157 struct ieee80211_rate *rates; 158 enum ieee80211_phymode mode; 159 int num_channels; 160 int num_rates; 161}; 162 163/** 164 * struct ieee80211_tx_queue_params - transmit queue configuration 165 * 166 * The information provided in this structure is required for QoS 167 * transmit queue configuration. 168 * 169 * @aifs: arbitration interface space [0..255, -1: use default] 170 * @cw_min: minimum contention window [will be a value of the form 171 * 2^n-1 in the range 1..1023; 0: use default] 172 * @cw_max: maximum contention window [like @cw_min] 173 * @burst_time: maximum burst time in units of 0.1ms, 0 meaning disabled 174 */ 175struct ieee80211_tx_queue_params { 176 int aifs; 177 int cw_min; 178 int cw_max; 179 int burst_time; 180}; 181 182/** 183 * struct ieee80211_tx_queue_stats_data - transmit queue statistics 184 * 185 * @len: number of packets in queue 186 * @limit: queue length limit 187 * @count: number of frames sent 188 */ 189struct ieee80211_tx_queue_stats_data { 190 unsigned int len; 191 unsigned int limit; 192 unsigned int count; 193}; 194 195/** 196 * enum ieee80211_tx_queue - transmit queue number 197 * 198 * These constants are used with some callbacks that take a 199 * queue number to set parameters for a queue. 200 * 201 * @IEEE80211_TX_QUEUE_DATA0: data queue 0 202 * @IEEE80211_TX_QUEUE_DATA1: data queue 1 203 * @IEEE80211_TX_QUEUE_DATA2: data queue 2 204 * @IEEE80211_TX_QUEUE_DATA3: data queue 3 205 * @IEEE80211_TX_QUEUE_DATA4: data queue 4 206 * @IEEE80211_TX_QUEUE_SVP: ?? 207 * @NUM_TX_DATA_QUEUES: number of data queues 208 * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be 209 * sent after a beacon 210 * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames 211 */ 212enum ieee80211_tx_queue { 213 IEEE80211_TX_QUEUE_DATA0, 214 IEEE80211_TX_QUEUE_DATA1, 215 IEEE80211_TX_QUEUE_DATA2, 216 IEEE80211_TX_QUEUE_DATA3, 217 IEEE80211_TX_QUEUE_DATA4, 218 IEEE80211_TX_QUEUE_SVP, 219 220 NUM_TX_DATA_QUEUES, 221 222/* due to stupidity in the sub-ioctl userspace interface, the items in 223 * this struct need to have fixed values. As soon as it is removed, we can 224 * fix these entries. */ 225 IEEE80211_TX_QUEUE_AFTER_BEACON = 6, 226 IEEE80211_TX_QUEUE_BEACON = 7 227}; 228 229struct ieee80211_tx_queue_stats { 230 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES]; 231}; 232 233struct ieee80211_low_level_stats { 234 unsigned int dot11ACKFailureCount; 235 unsigned int dot11RTSFailureCount; 236 unsigned int dot11FCSErrorCount; 237 unsigned int dot11RTSSuccessCount; 238}; 239 240/* Transmit control fields. This data structure is passed to low-level driver 241 * with each TX frame. The low-level driver is responsible for configuring 242 * the hardware to use given values (depending on what is supported). */ 243 244struct ieee80211_tx_control { 245 int tx_rate; /* Transmit rate, given as the hw specific value for the 246 * rate (from struct ieee80211_rate) */ 247 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw 248 * specific value for the rate (from 249 * struct ieee80211_rate) */ 250 251#define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for 252 * this frame */ 253#define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without 254 * encryption; e.g., for EAPOL 255 * frames */ 256#define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending 257 * frame */ 258#define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the 259 * frame (e.g., for combined 260 * 802.11g / 802.11b networks) */ 261#define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to 262 * wait for an ack */ 263#define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5) 264#define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6) 265#define IEEE80211_TXCTL_REQUEUE (1<<7) 266#define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of 267 * the frame */ 268#define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send 269 * using the through 270 * set_retry_limit configured 271 * long retry value */ 272 u32 flags; /* tx control flags defined 273 * above */ 274 u8 key_idx; /* keyidx from hw->set_key(), undefined if 275 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */ 276 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, .. 277 * This could be used when set_retry_limit 278 * is not implemented by the driver */ 279 u8 power_level; /* per-packet transmit power level, in dBm */ 280 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */ 281 u8 icv_len; /* length of the ICV/MIC field in octets */ 282 u8 iv_len; /* length of the IV field in octets */ 283 u8 queue; /* hardware queue to use for this frame; 284 * 0 = highest, hw->queues-1 = lowest */ 285 struct ieee80211_rate *rate; /* internal 80211.o rate */ 286 struct ieee80211_rate *rts_rate; /* internal 80211.o rate 287 * for RTS/CTS */ 288 int alt_retry_rate; /* retry rate for the last retries, given as the 289 * hw specific value for the rate (from 290 * struct ieee80211_rate). To be used to limit 291 * packet dropping when probing higher rates, if hw 292 * supports multiple retry rates. -1 = not used */ 293 int type; /* internal */ 294 int ifindex; /* internal */ 295}; 296 297 298/** 299 * enum mac80211_rx_flags - receive flags 300 * 301 * These flags are used with the @flag member of &struct ieee80211_rx_status. 302 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. 303 * Use together with %RX_FLAG_MMIC_STRIPPED. 304 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. 305 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header. 306 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, 307 * verification has been done by the hardware. 308 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame. 309 * If this flag is set, the stack cannot do any replay detection 310 * hence the driver or hardware will have to do that. 311 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on 312 * the frame. 313 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on 314 * the frame. 315 */ 316enum mac80211_rx_flags { 317 RX_FLAG_MMIC_ERROR = 1<<0, 318 RX_FLAG_DECRYPTED = 1<<1, 319 RX_FLAG_RADIOTAP = 1<<2, 320 RX_FLAG_MMIC_STRIPPED = 1<<3, 321 RX_FLAG_IV_STRIPPED = 1<<4, 322 RX_FLAG_FAILED_FCS_CRC = 1<<5, 323 RX_FLAG_FAILED_PLCP_CRC = 1<<6, 324}; 325 326/** 327 * struct ieee80211_rx_status - receive status 328 * 329 * The low-level driver should provide this information (the subset 330 * supported by hardware) to the 802.11 code with each received 331 * frame. 332 * @mactime: MAC timestamp as defined by 802.11 333 * @freq: frequency the radio was tuned to when receiving this frame, in MHz 334 * @channel: channel the radio was tuned to 335 * @phymode: active PHY mode 336 * @ssi: signal strength when receiving this frame 337 * @signal: used as 'qual' in statistics reporting 338 * @noise: PHY noise when receiving this frame 339 * @antenna: antenna used 340 * @rate: data rate 341 * @flag: %RX_FLAG_* 342 */ 343struct ieee80211_rx_status { 344 u64 mactime; 345 int freq; 346 int channel; 347 enum ieee80211_phymode phymode; 348 int ssi; 349 int signal; 350 int noise; 351 int antenna; 352 int rate; 353 int flag; 354}; 355 356/** 357 * enum ieee80211_tx_status_flags - transmit status flags 358 * 359 * Status flags to indicate various transmit conditions. 360 * 361 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted 362 * because the destination STA was in powersave mode. 363 * 364 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged 365 */ 366enum ieee80211_tx_status_flags { 367 IEEE80211_TX_STATUS_TX_FILTERED = 1<<0, 368 IEEE80211_TX_STATUS_ACK = 1<<1, 369}; 370 371/** 372 * struct ieee80211_tx_status - transmit status 373 * 374 * As much information as possible should be provided for each transmitted 375 * frame with ieee80211_tx_status(). 376 * 377 * @control: a copy of the &struct ieee80211_tx_control passed to the driver 378 * in the tx() callback. 379 * 380 * @flags: transmit status flags, defined above 381 * 382 * @ack_signal: signal strength of the ACK frame 383 * 384 * @excessive_retries: set to 1 if the frame was retried many times 385 * but not acknowledged 386 * 387 * @retry_count: number of retries 388 * 389 * @queue_length: ?? REMOVE 390 * @queue_number: ?? REMOVE 391 */ 392struct ieee80211_tx_status { 393 struct ieee80211_tx_control control; 394 u8 flags; 395 bool excessive_retries; 396 u8 retry_count; 397 int ack_signal; 398 int queue_length; 399 int queue_number; 400}; 401 402/** 403 * enum ieee80211_conf_flags - configuration flags 404 * 405 * Flags to define PHY configuration options 406 * 407 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time 408 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported) 409 * 410 */ 411enum ieee80211_conf_flags { 412 IEEE80211_CONF_SHORT_SLOT_TIME = 1<<0, 413 IEEE80211_CONF_RADIOTAP = 1<<1, 414}; 415 416/** 417 * struct ieee80211_conf - configuration of the device 418 * 419 * This struct indicates how the driver shall configure the hardware. 420 * 421 * @radio_enabled: when zero, driver is required to switch off the radio. 422 * TODO make a flag 423 * @channel: IEEE 802.11 channel number 424 * @freq: frequency in MHz 425 * @channel_val: hardware specific channel value for the channel 426 * @phymode: PHY mode to activate (REMOVE) 427 * @chan: channel to switch to, pointer to the channel information 428 * @mode: pointer to mode definition 429 * @regulatory_domain: ?? 430 * @beacon_int: beacon interval (TODO make interface config) 431 * @flags: configuration flags defined above 432 * @power_level: transmit power limit for current regulatory domain in dBm 433 * @antenna_max: maximum antenna gain 434 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity, 435 * 1/2: antenna 0/1 436 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx 437 */ 438struct ieee80211_conf { 439 int channel; /* IEEE 802.11 channel number */ 440 int freq; /* MHz */ 441 int channel_val; /* hw specific value for the channel */ 442 443 enum ieee80211_phymode phymode; 444 struct ieee80211_channel *chan; 445 struct ieee80211_hw_mode *mode; 446 unsigned int regulatory_domain; 447 int radio_enabled; 448 449 int beacon_int; 450 u32 flags; 451 u8 power_level; 452 u8 antenna_max; 453 u8 antenna_sel_tx; 454 u8 antenna_sel_rx; 455}; 456 457/** 458 * enum ieee80211_if_types - types of 802.11 network interfaces 459 * 460 * @IEEE80211_IF_TYPE_AP: interface in AP mode. 461 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap 462 * daemon. Drivers should never see this type. 463 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode. 464 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode. 465 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode. 466 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode. 467 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers 468 * will never see this type. 469 */ 470enum ieee80211_if_types { 471 IEEE80211_IF_TYPE_AP, 472 IEEE80211_IF_TYPE_MGMT, 473 IEEE80211_IF_TYPE_STA, 474 IEEE80211_IF_TYPE_IBSS, 475 IEEE80211_IF_TYPE_MNTR, 476 IEEE80211_IF_TYPE_WDS, 477 IEEE80211_IF_TYPE_VLAN, 478}; 479 480/** 481 * struct ieee80211_if_init_conf - initial configuration of an interface 482 * 483 * @if_id: internal interface ID. This number has no particular meaning to 484 * drivers and the only allowed usage is to pass it to 485 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions. 486 * This field is not valid for monitor interfaces 487 * (interfaces of %IEEE80211_IF_TYPE_MNTR type). 488 * @type: one of &enum ieee80211_if_types constants. Determines the type of 489 * added/removed interface. 490 * @mac_addr: pointer to MAC address of the interface. This pointer is valid 491 * until the interface is removed (i.e. it cannot be used after 492 * remove_interface() callback was called for this interface). 493 * 494 * This structure is used in add_interface() and remove_interface() 495 * callbacks of &struct ieee80211_hw. 496 * 497 * When you allow multiple interfaces to be added to your PHY, take care 498 * that the hardware can actually handle multiple MAC addresses. However, 499 * also take care that when there's no interface left with mac_addr != %NULL 500 * you remove the MAC address from the device to avoid acknowledging packets 501 * in pure monitor mode. 502 */ 503struct ieee80211_if_init_conf { 504 int if_id; 505 enum ieee80211_if_types type; 506 void *mac_addr; 507}; 508 509/** 510 * struct ieee80211_if_conf - configuration of an interface 511 * 512 * @type: type of the interface. This is always the same as was specified in 513 * &struct ieee80211_if_init_conf. The type of an interface never changes 514 * during the life of the interface; this field is present only for 515 * convenience. 516 * @bssid: BSSID of the network we are associated to/creating. 517 * @ssid: used (together with @ssid_len) by drivers for hardware that 518 * generate beacons independently. The pointer is valid only during the 519 * config_interface() call, so copy the value somewhere if you need 520 * it. 521 * @ssid_len: length of the @ssid field. 522 * @generic_elem: used (together with @generic_elem_len) by drivers for 523 * hardware that generate beacons independently. The pointer is valid 524 * only during the config_interface() call, so copy the value somewhere 525 * if you need it. 526 * @generic_elem_len: length of the generic element. 527 * @beacon: beacon template. Valid only if @host_gen_beacon_template in 528 * &struct ieee80211_hw is set. The driver is responsible of freeing 529 * the sk_buff. 530 * @beacon_control: tx_control for the beacon template, this field is only 531 * valid when the @beacon field was set. 532 * 533 * This structure is passed to the config_interface() callback of 534 * &struct ieee80211_hw. 535 */ 536struct ieee80211_if_conf { 537 int type; 538 u8 *bssid; 539 u8 *ssid; 540 size_t ssid_len; 541 u8 *generic_elem; 542 size_t generic_elem_len; 543 struct sk_buff *beacon; 544 struct ieee80211_tx_control *beacon_control; 545}; 546 547/** 548 * enum ieee80211_key_alg - key algorithm 549 * @ALG_NONE: Unset key algorithm, will never be passed to the driver 550 * @ALG_WEP: WEP40 or WEP104 551 * @ALG_TKIP: TKIP 552 * @ALG_CCMP: CCMP (AES) 553 */ 554typedef enum ieee80211_key_alg { 555 ALG_NONE, 556 ALG_WEP, 557 ALG_TKIP, 558 ALG_CCMP, 559} ieee80211_key_alg; 560 561 562/** 563 * enum ieee80211_key_flags - key flags 564 * 565 * These flags are used for communication about keys between the driver 566 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. 567 * 568 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates 569 * that the STA this key will be used with could be using QoS. 570 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the 571 * driver to indicate that it requires IV generation for this 572 * particular key. 573 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by 574 * the driver for a TKIP key if it requires Michael MIC 575 * generation in software. 576 */ 577enum ieee80211_key_flags { 578 IEEE80211_KEY_FLAG_WMM_STA = 1<<0, 579 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1, 580 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2, 581}; 582 583/** 584 * struct ieee80211_key_conf - key information 585 * 586 * This key information is given by mac80211 to the driver by 587 * the set_key() callback in &struct ieee80211_ops. 588 * 589 * @hw_key_idx: To be set by the driver, this is the key index the driver 590 * wants to be given when a frame is transmitted and needs to be 591 * encrypted in hardware. 592 * @alg: The key algorithm. 593 * @flags: key flags, see &enum ieee80211_key_flags. 594 * @keyidx: the key index (0-3) 595 * @keylen: key material length 596 * @key: key material 597 */ 598struct ieee80211_key_conf { 599 ieee80211_key_alg alg; 600 u8 hw_key_idx; 601 u8 flags; 602 s8 keyidx; 603 u8 keylen; 604 u8 key[0]; 605}; 606 607#define IEEE80211_SEQ_COUNTER_RX 0 608#define IEEE80211_SEQ_COUNTER_TX 1 609 610/** 611 * enum set_key_cmd - key command 612 * 613 * Used with the set_key() callback in &struct ieee80211_ops, this 614 * indicates whether a key is being removed or added. 615 * 616 * @SET_KEY: a key is set 617 * @DISABLE_KEY: a key must be disabled 618 */ 619typedef enum set_key_cmd { 620 SET_KEY, DISABLE_KEY, 621} set_key_cmd; 622 623 624/** 625 * enum ieee80211_hw_flags - hardware flags 626 * 627 * These flags are used to indicate hardware capabilities to 628 * the stack. Generally, flags here should have their meaning 629 * done in a way that the simplest hardware doesn't need setting 630 * any particular flags. There are some exceptions to this rule, 631 * however, so you are advised to review these flags carefully. 632 * 633 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE: 634 * The device only needs to be supplied with a beacon template. 635 * If you need the host to generate each beacon then don't use 636 * this flag and call ieee80211_beacon_get() when you need the 637 * next beacon frame. Note that if you set this flag, you must 638 * implement the set_tim() callback for powersave mode to work 639 * properly. 640 * This flag is only relevant for access-point mode. 641 * 642 * @IEEE80211_HW_RX_INCLUDES_FCS: 643 * Indicates that received frames passed to the stack include 644 * the FCS at the end. 645 * 646 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 647 * Some wireless LAN chipsets buffer broadcast/multicast frames 648 * for power saving stations in the hardware/firmware and others 649 * rely on the host system for such buffering. This option is used 650 * to configure the IEEE 802.11 upper layer to buffer broadcast and 651 * multicast frames when there are power saving stations so that 652 * the driver can fetch them with ieee80211_get_buffered_bc(). Note 653 * that not setting this flag works properly only when the 654 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because 655 * otherwise the stack will not know when the DTIM beacon was sent. 656 * 657 * @IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED: 658 * Channels are already configured to the default regulatory domain 659 * specified in the device's EEPROM 660 */ 661enum ieee80211_hw_flags { 662 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0, 663 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, 664 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, 665 IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED = 1<<3, 666}; 667 668/** 669 * struct ieee80211_hw - hardware information and state 670 * 671 * This structure contains the configuration and hardware 672 * information for an 802.11 PHY. 673 * 674 * @wiphy: This points to the &struct wiphy allocated for this 675 * 802.11 PHY. You must fill in the @perm_addr and @dev 676 * members of this structure using SET_IEEE80211_DEV() 677 * and SET_IEEE80211_PERM_ADDR(). 678 * 679 * @conf: &struct ieee80211_conf, device configuration, don't use. 680 * 681 * @workqueue: single threaded workqueue available for driver use, 682 * allocated by mac80211 on registration and flushed on 683 * unregistration. 684 * 685 * @priv: pointer to private area that was allocated for driver use 686 * along with this structure. 687 * 688 * @flags: hardware flags, see &enum ieee80211_hw_flags. 689 * 690 * @extra_tx_headroom: headroom to reserve in each transmit skb 691 * for use by the driver (e.g. for transmit headers.) 692 * 693 * @channel_change_time: time (in microseconds) it takes to change channels. 694 * 695 * @max_rssi: Maximum value for ssi in RX information, use 696 * negative numbers for dBm and 0 to indicate no support. 697 * 698 * @max_signal: like @max_rssi, but for the signal value. 699 * 700 * @max_noise: like @max_rssi, but for the noise value. 701 * 702 * @queues: number of available hardware transmit queues for 703 * data packets. WMM/QoS requires at least four. 704 */ 705struct ieee80211_hw { 706 struct ieee80211_conf conf; 707 struct wiphy *wiphy; 708 struct workqueue_struct *workqueue; 709 void *priv; 710 u32 flags; 711 unsigned int extra_tx_headroom; 712 int channel_change_time; 713 u8 queues; 714 s8 max_rssi; 715 s8 max_signal; 716 s8 max_noise; 717}; 718 719/** 720 * SET_IEEE80211_DEV - set device for 802.11 hardware 721 * 722 * @hw: the &struct ieee80211_hw to set the device for 723 * @dev: the &struct device of this 802.11 device 724 */ 725static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 726{ 727 set_wiphy_dev(hw->wiphy, dev); 728} 729 730/** 731 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware 732 * 733 * @hw: the &struct ieee80211_hw to set the MAC address for 734 * @addr: the address to set 735 */ 736static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 737{ 738 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 739} 740 741/** 742 * DOC: Hardware crypto acceleration 743 * 744 * mac80211 is capable of taking advantage of many hardware 745 * acceleration designs for encryption and decryption operations. 746 * 747 * The set_key() callback in the &struct ieee80211_ops for a given 748 * device is called to enable hardware acceleration of encryption and 749 * decryption. The callback takes an @address parameter that will be 750 * the broadcast address for default keys, the other station's hardware 751 * address for individual keys or the zero address for keys that will 752 * be used only for transmission. 753 * Multiple transmission keys with the same key index may be used when 754 * VLANs are configured for an access point. 755 * 756 * The @local_address parameter will always be set to our own address, 757 * this is only relevant if you support multiple local addresses. 758 * 759 * When transmitting, the TX control data will use the @hw_key_idx 760 * selected by the driver by modifying the &struct ieee80211_key_conf 761 * pointed to by the @key parameter to the set_key() function. 762 * 763 * The set_key() call for the %SET_KEY command should return 0 if 764 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 765 * added; if you return 0 then hw_key_idx must be assigned to the 766 * hardware key index, you are free to use the full u8 range. 767 * 768 * When the cmd is %DISABLE_KEY then it must succeed. 769 * 770 * Note that it is permissible to not decrypt a frame even if a key 771 * for it has been uploaded to hardware, the stack will not make any 772 * decision based on whether a key has been uploaded or not but rather 773 * based on the receive flags. 774 * 775 * The &struct ieee80211_key_conf structure pointed to by the @key 776 * parameter is guaranteed to be valid until another call to set_key() 777 * removes it, but it can only be used as a cookie to differentiate 778 * keys. 779 */ 780 781/** 782 * DOC: Frame filtering 783 * 784 * mac80211 requires to see many management frames for proper 785 * operation, and users may want to see many more frames when 786 * in monitor mode. However, for best CPU usage and power consumption, 787 * having as few frames as possible percolate through the stack is 788 * desirable. Hence, the hardware should filter as much as possible. 789 * 790 * To achieve this, mac80211 uses filter flags (see below) to tell 791 * the driver's configure_filter() function which frames should be 792 * passed to mac80211 and which should be filtered out. 793 * 794 * The configure_filter() callback is invoked with the parameters 795 * @mc_count and @mc_list for the combined multicast address list 796 * of all virtual interfaces, @changed_flags telling which flags 797 * were changed and @total_flags with the new flag states. 798 * 799 * If your device has no multicast address filters your driver will 800 * need to check both the %FIF_ALLMULTI flag and the @mc_count 801 * parameter to see whether multicast frames should be accepted 802 * or dropped. 803 * 804 * All unsupported flags in @total_flags must be cleared, i.e. you 805 * should clear all bits except those you honoured. 806 */ 807 808/** 809 * enum ieee80211_filter_flags - hardware filter flags 810 * 811 * These flags determine what the filter in hardware should be 812 * programmed to let through and what should not be passed to the 813 * stack. It is always safe to pass more frames than requested, 814 * but this has negative impact on power consumption. 815 * 816 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, 817 * think of the BSS as your network segment and then this corresponds 818 * to the regular ethernet device promiscuous mode. 819 * 820 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 821 * by the user or if the hardware is not capable of filtering by 822 * multicast address. 823 * 824 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 825 * %RX_FLAG_FAILED_FCS_CRC for them) 826 * 827 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 828 * the %RX_FLAG_FAILED_PLCP_CRC for them 829 * 830 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 831 * to the hardware that it should not filter beacons or probe responses 832 * by BSSID. Filtering them can greatly reduce the amount of processing 833 * mac80211 needs to do and the amount of CPU wakeups, so you should 834 * honour this flag if possible. 835 * 836 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then 837 * only those addressed to this station 838 * 839 * @FIF_OTHER_BSS: pass frames destined to other BSSes 840 */ 841enum ieee80211_filter_flags { 842 FIF_PROMISC_IN_BSS = 1<<0, 843 FIF_ALLMULTI = 1<<1, 844 FIF_FCSFAIL = 1<<2, 845 FIF_PLCPFAIL = 1<<3, 846 FIF_BCN_PRBRESP_PROMISC = 1<<4, 847 FIF_CONTROL = 1<<5, 848 FIF_OTHER_BSS = 1<<6, 849}; 850 851/** 852 * enum ieee80211_erp_change_flags - erp change flags 853 * 854 * These flags are used with the erp_ie_changed() callback in 855 * &struct ieee80211_ops to indicate which parameter(s) changed. 856 * @IEEE80211_ERP_CHANGE_PROTECTION: protection changed 857 * @IEEE80211_ERP_CHANGE_PREAMBLE: barker preamble mode changed 858 */ 859enum ieee80211_erp_change_flags { 860 IEEE80211_ERP_CHANGE_PROTECTION = 1<<0, 861 IEEE80211_ERP_CHANGE_PREAMBLE = 1<<1, 862}; 863 864 865/** 866 * struct ieee80211_ops - callbacks from mac80211 to the driver 867 * 868 * This structure contains various callbacks that the driver may 869 * handle or, in some cases, must handle, for example to configure 870 * the hardware to a new channel or to transmit a frame. 871 * 872 * @tx: Handler that 802.11 module calls for each transmitted frame. 873 * skb contains the buffer starting from the IEEE 802.11 header. 874 * The low-level driver should send the frame out based on 875 * configuration in the TX control data. Must be implemented and 876 * atomic. 877 * 878 * @start: Called before the first netdevice attached to the hardware 879 * is enabled. This should turn on the hardware and must turn on 880 * frame reception (for possibly enabled monitor interfaces.) 881 * Returns negative error codes, these may be seen in userspace, 882 * or zero. 883 * When the device is started it should not have a MAC address 884 * to avoid acknowledging frames before a non-monitor device 885 * is added. 886 * Must be implemented. 887 * 888 * @stop: Called after last netdevice attached to the hardware 889 * is disabled. This should turn off the hardware (at least 890 * it must turn off frame reception.) 891 * May be called right after add_interface if that rejects 892 * an interface. 893 * Must be implemented. 894 * 895 * @add_interface: Called when a netdevice attached to the hardware is 896 * enabled. Because it is not called for monitor mode devices, @open 897 * and @stop must be implemented. 898 * The driver should perform any initialization it needs before 899 * the device can be enabled. The initial configuration for the 900 * interface is given in the conf parameter. 901 * The callback may refuse to add an interface by returning a 902 * negative error code (which will be seen in userspace.) 903 * Must be implemented. 904 * 905 * @remove_interface: Notifies a driver that an interface is going down. 906 * The @stop callback is called after this if it is the last interface 907 * and no monitor interfaces are present. 908 * When all interfaces are removed, the MAC address in the hardware 909 * must be cleared so the device no longer acknowledges packets, 910 * the mac_addr member of the conf structure is, however, set to the 911 * MAC address of the device going away. 912 * Hence, this callback must be implemented. 913 * 914 * @config: Handler for configuration requests. IEEE 802.11 code calls this 915 * function to change hardware configuration, e.g., channel. 916 * 917 * @config_interface: Handler for configuration requests related to interfaces 918 * (e.g. BSSID changes.) 919 * 920 * @configure_filter: Configure the device's RX filter. 921 * See the section "Frame filtering" for more information. 922 * This callback must be implemented and atomic. 923 * 924 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon 925 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set) 926 * mac80211 calls this function when a TIM bit must be set or cleared 927 * for a given AID. Must be atomic. 928 * 929 * @set_key: See the section "Hardware crypto acceleration" 930 * This callback can sleep, and is only called between add_interface 931 * and remove_interface calls, i.e. while the interface with the 932 * given local_address is enabled. 933 * 934 * @set_ieee8021x: Enable/disable IEEE 802.1X. This item requests wlan card 935 * to pass unencrypted EAPOL-Key frames even when encryption is 936 * configured. If the wlan card does not require such a configuration, 937 * this function pointer can be set to NULL. 938 * 939 * @set_port_auth: Set port authorization state (IEEE 802.1X PAE) to be 940 * authorized (@authorized=1) or unauthorized (=0). This function can be 941 * used if the wlan hardware or low-level driver implements PAE. 942 * mac80211 will filter frames based on authorization state in any case, 943 * so this function pointer can be NULL if low-level driver does not 944 * require event notification about port state changes. 945 * 946 * @hw_scan: Ask the hardware to service the scan request, no need to start 947 * the scan state machine in stack. 948 * 949 * @get_stats: return low-level statistics 950 * 951 * @set_privacy_invoked: For devices that generate their own beacons and probe 952 * response or association responses this updates the state of privacy_invoked 953 * returns 0 for success or an error number. 954 * 955 * @get_sequence_counter: For devices that have internal sequence counters this 956 * callback allows mac80211 to access the current value of a counter. 957 * This callback seems not well-defined, tell us if you need it. 958 * 959 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 960 * 961 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if 962 * the device does fragmentation by itself; if this method is assigned then 963 * the stack will not do fragmentation. 964 * 965 * @set_retry_limit: Configuration of retry limits (if device needs it) 966 * 967 * @sta_table_notification: Number of STAs in STA table notification. Must 968 * be atomic. 969 * 970 * @erp_ie_changed: Handle ERP IE change notifications. Must be atomic. 971 * 972 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 973 * bursting) for a hardware TX queue. The @queue parameter uses the 974 * %IEEE80211_TX_QUEUE_* constants. Must be atomic. 975 * 976 * @get_tx_stats: Get statistics of the current TX queue status. This is used 977 * to get number of currently queued packets (queue length), maximum queue 978 * size (limit), and total number of packets sent using each TX queue 979 * (count). This information is used for WMM to find out which TX 980 * queues have room for more packets and by hostapd to provide 981 * statistics about the current queueing state to external programs. 982 * 983 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 984 * this is only used for IBSS mode debugging and, as such, is not a 985 * required function. Must be atomic. 986 * 987 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 988 * with other STAs in the IBSS. This is only used in IBSS mode. This 989 * function is optional if the firmware/hardware takes full care of 990 * TSF synchronization. 991 * 992 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point, 993 * IBSS uses a fixed beacon frame which is configured using this 994 * function. This handler is required only for IBSS mode. 995 * 996 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 997 * This is needed only for IBSS mode and the result of this function is 998 * used to determine whether to reply to Probe Requests. 999 */ 1000struct ieee80211_ops { 1001 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb, 1002 struct ieee80211_tx_control *control); 1003 int (*start)(struct ieee80211_hw *hw); 1004 void (*stop)(struct ieee80211_hw *hw); 1005 int (*add_interface)(struct ieee80211_hw *hw, 1006 struct ieee80211_if_init_conf *conf); 1007 void (*remove_interface)(struct ieee80211_hw *hw, 1008 struct ieee80211_if_init_conf *conf); 1009 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf); 1010 int (*config_interface)(struct ieee80211_hw *hw, 1011 int if_id, struct ieee80211_if_conf *conf); 1012 void (*configure_filter)(struct ieee80211_hw *hw, 1013 unsigned int changed_flags, 1014 unsigned int *total_flags, 1015 int mc_count, struct dev_addr_list *mc_list); 1016 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set); 1017 int (*set_key)(struct ieee80211_hw *hw, set_key_cmd cmd, 1018 const u8 *local_address, const u8 *address, 1019 struct ieee80211_key_conf *key); 1020 int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x); 1021 int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr, 1022 int authorized); 1023 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len); 1024 int (*get_stats)(struct ieee80211_hw *hw, 1025 struct ieee80211_low_level_stats *stats); 1026 int (*set_privacy_invoked)(struct ieee80211_hw *hw, 1027 int privacy_invoked); 1028 int (*get_sequence_counter)(struct ieee80211_hw *hw, 1029 u8* addr, u8 keyidx, u8 txrx, 1030 u32* iv32, u16* iv16); 1031 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 1032 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); 1033 int (*set_retry_limit)(struct ieee80211_hw *hw, 1034 u32 short_retry, u32 long_retr); 1035 void (*sta_table_notification)(struct ieee80211_hw *hw, 1036 int num_sta); 1037 void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes, 1038 int cts_protection, int preamble); 1039 int (*conf_tx)(struct ieee80211_hw *hw, int queue, 1040 const struct ieee80211_tx_queue_params *params); 1041 int (*get_tx_stats)(struct ieee80211_hw *hw, 1042 struct ieee80211_tx_queue_stats *stats); 1043 u64 (*get_tsf)(struct ieee80211_hw *hw); 1044 void (*reset_tsf)(struct ieee80211_hw *hw); 1045 int (*beacon_update)(struct ieee80211_hw *hw, 1046 struct sk_buff *skb, 1047 struct ieee80211_tx_control *control); 1048 int (*tx_last_beacon)(struct ieee80211_hw *hw); 1049}; 1050 1051/** 1052 * ieee80211_alloc_hw - Allocate a new hardware device 1053 * 1054 * This must be called once for each hardware device. The returned pointer 1055 * must be used to refer to this device when calling other functions. 1056 * mac80211 allocates a private data area for the driver pointed to by 1057 * @priv in &struct ieee80211_hw, the size of this area is given as 1058 * @priv_data_len. 1059 * 1060 * @priv_data_len: length of private data 1061 * @ops: callbacks for this device 1062 */ 1063struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 1064 const struct ieee80211_ops *ops); 1065 1066/** 1067 * ieee80211_register_hw - Register hardware device 1068 * 1069 * You must call this function before any other functions 1070 * except ieee80211_register_hwmode. 1071 * 1072 * @hw: the device to register as returned by ieee80211_alloc_hw() 1073 */ 1074int ieee80211_register_hw(struct ieee80211_hw *hw); 1075 1076#ifdef CONFIG_MAC80211_LEDS 1077extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 1078extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 1079#endif 1080/** 1081 * ieee80211_get_tx_led_name - get name of TX LED 1082 * 1083 * mac80211 creates a transmit LED trigger for each wireless hardware 1084 * that can be used to drive LEDs if your driver registers a LED device. 1085 * This function returns the name (or %NULL if not configured for LEDs) 1086 * of the trigger so you can automatically link the LED device. 1087 * 1088 * @hw: the hardware to get the LED trigger name for 1089 */ 1090static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 1091{ 1092#ifdef CONFIG_MAC80211_LEDS 1093 return __ieee80211_get_tx_led_name(hw); 1094#else 1095 return NULL; 1096#endif 1097} 1098 1099/** 1100 * ieee80211_get_rx_led_name - get name of RX LED 1101 * 1102 * mac80211 creates a receive LED trigger for each wireless hardware 1103 * that can be used to drive LEDs if your driver registers a LED device. 1104 * This function returns the name (or %NULL if not configured for LEDs) 1105 * of the trigger so you can automatically link the LED device. 1106 * 1107 * @hw: the hardware to get the LED trigger name for 1108 */ 1109static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 1110{ 1111#ifdef CONFIG_MAC80211_LEDS 1112 return __ieee80211_get_rx_led_name(hw); 1113#else 1114 return NULL; 1115#endif 1116} 1117 1118/* Register a new hardware PHYMODE capability to the stack. */ 1119int ieee80211_register_hwmode(struct ieee80211_hw *hw, 1120 struct ieee80211_hw_mode *mode); 1121 1122/** 1123 * ieee80211_unregister_hw - Unregister a hardware device 1124 * 1125 * This function instructs mac80211 to free allocated resources 1126 * and unregister netdevices from the networking subsystem. 1127 * 1128 * @hw: the hardware to unregister 1129 */ 1130void ieee80211_unregister_hw(struct ieee80211_hw *hw); 1131 1132/** 1133 * ieee80211_free_hw - free hardware descriptor 1134 * 1135 * This function frees everything that was allocated, including the 1136 * private data for the driver. You must call ieee80211_unregister_hw() 1137 * before calling this function 1138 * 1139 * @hw: the hardware to free 1140 */ 1141void ieee80211_free_hw(struct ieee80211_hw *hw); 1142 1143/* trick to avoid symbol clashes with the ieee80211 subsystem */ 1144void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1145 struct ieee80211_rx_status *status); 1146 1147/** 1148 * ieee80211_rx - receive frame 1149 * 1150 * Use this function to hand received frames to mac80211. The receive 1151 * buffer in @skb must start with an IEEE 802.11 header or a radiotap 1152 * header if %RX_FLAG_RADIOTAP is set in the @status flags. 1153 * 1154 * This function may not be called in IRQ context. 1155 * 1156 * @hw: the hardware this frame came in on 1157 * @skb: the buffer to receive, owned by mac80211 after this call 1158 * @status: status of this frame; the status pointer need not be valid 1159 * after this function returns 1160 */ 1161static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1162 struct ieee80211_rx_status *status) 1163{ 1164 __ieee80211_rx(hw, skb, status); 1165} 1166 1167/** 1168 * ieee80211_rx_irqsafe - receive frame 1169 * 1170 * Like ieee80211_rx() but can be called in IRQ context 1171 * (internally defers to a workqueue.) 1172 * 1173 * @hw: the hardware this frame came in on 1174 * @skb: the buffer to receive, owned by mac80211 after this call 1175 * @status: status of this frame; the status pointer need not be valid 1176 * after this function returns and is not freed by mac80211, 1177 * it is recommended that it points to a stack area 1178 */ 1179void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, 1180 struct sk_buff *skb, 1181 struct ieee80211_rx_status *status); 1182 1183/** 1184 * ieee80211_tx_status - transmit status callback 1185 * 1186 * Call this function for all transmitted frames after they have been 1187 * transmitted. It is permissible to not call this function for 1188 * multicast frames but this can affect statistics. 1189 * 1190 * @hw: the hardware the frame was transmitted by 1191 * @skb: the frame that was transmitted, owned by mac80211 after this call 1192 * @status: status information for this frame; the status pointer need not 1193 * be valid after this function returns and is not freed by mac80211, 1194 * it is recommended that it points to a stack area 1195 */ 1196void ieee80211_tx_status(struct ieee80211_hw *hw, 1197 struct sk_buff *skb, 1198 struct ieee80211_tx_status *status); 1199void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 1200 struct sk_buff *skb, 1201 struct ieee80211_tx_status *status); 1202 1203/** 1204 * ieee80211_beacon_get - beacon generation function 1205 * @hw: pointer obtained from ieee80211_alloc_hw(). 1206 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1207 * @control: will be filled with information needed to send this beacon. 1208 * 1209 * If the beacon frames are generated by the host system (i.e., not in 1210 * hardware/firmware), the low-level driver uses this function to receive 1211 * the next beacon frame from the 802.11 code. The low-level is responsible 1212 * for calling this function before beacon data is needed (e.g., based on 1213 * hardware interrupt). Returned skb is used only once and low-level driver 1214 * is responsible of freeing it. 1215 */ 1216struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 1217 int if_id, 1218 struct ieee80211_tx_control *control); 1219 1220/** 1221 * ieee80211_rts_get - RTS frame generation function 1222 * @hw: pointer obtained from ieee80211_alloc_hw(). 1223 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1224 * @frame: pointer to the frame that is going to be protected by the RTS. 1225 * @frame_len: the frame length (in octets). 1226 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1227 * @rts: The buffer where to store the RTS frame. 1228 * 1229 * If the RTS frames are generated by the host system (i.e., not in 1230 * hardware/firmware), the low-level driver uses this function to receive 1231 * the next RTS frame from the 802.11 code. The low-level is responsible 1232 * for calling this function before and RTS frame is needed. 1233 */ 1234void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id, 1235 const void *frame, size_t frame_len, 1236 const struct ieee80211_tx_control *frame_txctl, 1237 struct ieee80211_rts *rts); 1238 1239/** 1240 * ieee80211_rts_duration - Get the duration field for an RTS frame 1241 * @hw: pointer obtained from ieee80211_alloc_hw(). 1242 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1243 * @frame_len: the length of the frame that is going to be protected by the RTS. 1244 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1245 * 1246 * If the RTS is generated in firmware, but the host system must provide 1247 * the duration field, the low-level driver uses this function to receive 1248 * the duration field value in little-endian byteorder. 1249 */ 1250__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id, 1251 size_t frame_len, 1252 const struct ieee80211_tx_control *frame_txctl); 1253 1254/** 1255 * ieee80211_ctstoself_get - CTS-to-self frame generation function 1256 * @hw: pointer obtained from ieee80211_alloc_hw(). 1257 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1258 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 1259 * @frame_len: the frame length (in octets). 1260 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1261 * @cts: The buffer where to store the CTS-to-self frame. 1262 * 1263 * If the CTS-to-self frames are generated by the host system (i.e., not in 1264 * hardware/firmware), the low-level driver uses this function to receive 1265 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 1266 * for calling this function before and CTS-to-self frame is needed. 1267 */ 1268void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id, 1269 const void *frame, size_t frame_len, 1270 const struct ieee80211_tx_control *frame_txctl, 1271 struct ieee80211_cts *cts); 1272 1273/** 1274 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 1275 * @hw: pointer obtained from ieee80211_alloc_hw(). 1276 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1277 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 1278 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1279 * 1280 * If the CTS-to-self is generated in firmware, but the host system must provide 1281 * the duration field, the low-level driver uses this function to receive 1282 * the duration field value in little-endian byteorder. 1283 */ 1284__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id, 1285 size_t frame_len, 1286 const struct ieee80211_tx_control *frame_txctl); 1287 1288/** 1289 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 1290 * @hw: pointer obtained from ieee80211_alloc_hw(). 1291 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1292 * @frame_len: the length of the frame. 1293 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted. 1294 * 1295 * Calculate the duration field of some generic frame, given its 1296 * length and transmission rate (in 100kbps). 1297 */ 1298__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id, 1299 size_t frame_len, 1300 int rate); 1301 1302/** 1303 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 1304 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1305 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1306 * @control: will be filled with information needed to send returned frame. 1307 * 1308 * Function for accessing buffered broadcast and multicast frames. If 1309 * hardware/firmware does not implement buffering of broadcast/multicast 1310 * frames when power saving is used, 802.11 code buffers them in the host 1311 * memory. The low-level driver uses this function to fetch next buffered 1312 * frame. In most cases, this is used when generating beacon frame. This 1313 * function returns a pointer to the next buffered skb or NULL if no more 1314 * buffered frames are available. 1315 * 1316 * Note: buffered frames are returned only after DTIM beacon frame was 1317 * generated with ieee80211_beacon_get() and the low-level driver must thus 1318 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 1319 * NULL if the previous generated beacon was not DTIM, so the low-level driver 1320 * does not need to check for DTIM beacons separately and should be able to 1321 * use common code for all beacons. 1322 */ 1323struct sk_buff * 1324ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id, 1325 struct ieee80211_tx_control *control); 1326 1327/** 1328 * ieee80211_get_hdrlen_from_skb - get header length from data 1329 * 1330 * Given an skb with a raw 802.11 header at the data pointer this function 1331 * returns the 802.11 header length in bytes (not including encryption 1332 * headers). If the data in the sk_buff is too short to contain a valid 802.11 1333 * header the function returns 0. 1334 * 1335 * @skb: the frame 1336 */ 1337int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); 1338 1339/** 1340 * ieee80211_get_hdrlen - get header length from frame control 1341 * 1342 * This function returns the 802.11 header length in bytes (not including 1343 * encryption headers.) 1344 * 1345 * @fc: the frame control field (in CPU endianness) 1346 */ 1347int ieee80211_get_hdrlen(u16 fc); 1348 1349/** 1350 * ieee80211_wake_queue - wake specific queue 1351 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1352 * @queue: queue number (counted from zero). 1353 * 1354 * Drivers should use this function instead of netif_wake_queue. 1355 */ 1356void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 1357 1358/** 1359 * ieee80211_stop_queue - stop specific queue 1360 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1361 * @queue: queue number (counted from zero). 1362 * 1363 * Drivers should use this function instead of netif_stop_queue. 1364 */ 1365void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 1366 1367/** 1368 * ieee80211_start_queues - start all queues 1369 * @hw: pointer to as obtained from ieee80211_alloc_hw(). 1370 * 1371 * Drivers should use this function instead of netif_start_queue. 1372 */ 1373void ieee80211_start_queues(struct ieee80211_hw *hw); 1374 1375/** 1376 * ieee80211_stop_queues - stop all queues 1377 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1378 * 1379 * Drivers should use this function instead of netif_stop_queue. 1380 */ 1381void ieee80211_stop_queues(struct ieee80211_hw *hw); 1382 1383/** 1384 * ieee80211_wake_queues - wake all queues 1385 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1386 * 1387 * Drivers should use this function instead of netif_wake_queue. 1388 */ 1389void ieee80211_wake_queues(struct ieee80211_hw *hw); 1390 1391/** 1392 * ieee80211_scan_completed - completed hardware scan 1393 * 1394 * When hardware scan offload is used (i.e. the hw_scan() callback is 1395 * assigned) this function needs to be called by the driver to notify 1396 * mac80211 that the scan finished. 1397 * 1398 * @hw: the hardware that finished the scan 1399 */ 1400void ieee80211_scan_completed(struct ieee80211_hw *hw); 1401 1402#endif /* MAC80211_H */ 1403