mac80211.h revision 5ecc2a5d3e3c39535d2cc10dad15853e9e9b072d
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_INVALID: invalid interface type, not used 461 * by mac80211 itself 462 * @IEEE80211_IF_TYPE_AP: interface in AP mode. 463 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap 464 * daemon. Drivers should never see this type. 465 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode. 466 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode. 467 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode. 468 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode. 469 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers 470 * will never see this type. 471 */ 472enum ieee80211_if_types { 473 IEEE80211_IF_TYPE_INVALID, 474 IEEE80211_IF_TYPE_AP, 475 IEEE80211_IF_TYPE_STA, 476 IEEE80211_IF_TYPE_IBSS, 477 IEEE80211_IF_TYPE_MNTR, 478 IEEE80211_IF_TYPE_WDS, 479 IEEE80211_IF_TYPE_VLAN, 480}; 481 482/** 483 * struct ieee80211_if_init_conf - initial configuration of an interface 484 * 485 * @if_id: internal interface ID. This number has no particular meaning to 486 * drivers and the only allowed usage is to pass it to 487 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions. 488 * This field is not valid for monitor interfaces 489 * (interfaces of %IEEE80211_IF_TYPE_MNTR type). 490 * @type: one of &enum ieee80211_if_types constants. Determines the type of 491 * added/removed interface. 492 * @mac_addr: pointer to MAC address of the interface. This pointer is valid 493 * until the interface is removed (i.e. it cannot be used after 494 * remove_interface() callback was called for this interface). 495 * 496 * This structure is used in add_interface() and remove_interface() 497 * callbacks of &struct ieee80211_hw. 498 * 499 * When you allow multiple interfaces to be added to your PHY, take care 500 * that the hardware can actually handle multiple MAC addresses. However, 501 * also take care that when there's no interface left with mac_addr != %NULL 502 * you remove the MAC address from the device to avoid acknowledging packets 503 * in pure monitor mode. 504 */ 505struct ieee80211_if_init_conf { 506 int if_id; 507 enum ieee80211_if_types type; 508 void *mac_addr; 509}; 510 511/** 512 * struct ieee80211_if_conf - configuration of an interface 513 * 514 * @type: type of the interface. This is always the same as was specified in 515 * &struct ieee80211_if_init_conf. The type of an interface never changes 516 * during the life of the interface; this field is present only for 517 * convenience. 518 * @bssid: BSSID of the network we are associated to/creating. 519 * @ssid: used (together with @ssid_len) by drivers for hardware that 520 * generate beacons independently. The pointer is valid only during the 521 * config_interface() call, so copy the value somewhere if you need 522 * it. 523 * @ssid_len: length of the @ssid field. 524 * @beacon: beacon template. Valid only if @host_gen_beacon_template in 525 * &struct ieee80211_hw is set. The driver is responsible of freeing 526 * the sk_buff. 527 * @beacon_control: tx_control for the beacon template, this field is only 528 * valid when the @beacon field was set. 529 * 530 * This structure is passed to the config_interface() callback of 531 * &struct ieee80211_hw. 532 */ 533struct ieee80211_if_conf { 534 int type; 535 u8 *bssid; 536 u8 *ssid; 537 size_t ssid_len; 538 struct sk_buff *beacon; 539 struct ieee80211_tx_control *beacon_control; 540}; 541 542/** 543 * enum ieee80211_key_alg - key algorithm 544 * @ALG_WEP: WEP40 or WEP104 545 * @ALG_TKIP: TKIP 546 * @ALG_CCMP: CCMP (AES) 547 */ 548enum ieee80211_key_alg { 549 ALG_WEP, 550 ALG_TKIP, 551 ALG_CCMP, 552}; 553 554 555/** 556 * enum ieee80211_key_flags - key flags 557 * 558 * These flags are used for communication about keys between the driver 559 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. 560 * 561 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates 562 * that the STA this key will be used with could be using QoS. 563 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the 564 * driver to indicate that it requires IV generation for this 565 * particular key. 566 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by 567 * the driver for a TKIP key if it requires Michael MIC 568 * generation in software. 569 */ 570enum ieee80211_key_flags { 571 IEEE80211_KEY_FLAG_WMM_STA = 1<<0, 572 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1, 573 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2, 574}; 575 576/** 577 * struct ieee80211_key_conf - key information 578 * 579 * This key information is given by mac80211 to the driver by 580 * the set_key() callback in &struct ieee80211_ops. 581 * 582 * @hw_key_idx: To be set by the driver, this is the key index the driver 583 * wants to be given when a frame is transmitted and needs to be 584 * encrypted in hardware. 585 * @alg: The key algorithm. 586 * @flags: key flags, see &enum ieee80211_key_flags. 587 * @keyidx: the key index (0-3) 588 * @keylen: key material length 589 * @key: key material 590 */ 591struct ieee80211_key_conf { 592 enum ieee80211_key_alg alg; 593 u8 hw_key_idx; 594 u8 flags; 595 s8 keyidx; 596 u8 keylen; 597 u8 key[0]; 598}; 599 600#define IEEE80211_SEQ_COUNTER_RX 0 601#define IEEE80211_SEQ_COUNTER_TX 1 602 603/** 604 * enum set_key_cmd - key command 605 * 606 * Used with the set_key() callback in &struct ieee80211_ops, this 607 * indicates whether a key is being removed or added. 608 * 609 * @SET_KEY: a key is set 610 * @DISABLE_KEY: a key must be disabled 611 */ 612enum set_key_cmd { 613 SET_KEY, DISABLE_KEY, 614}; 615 616/** 617 * enum sta_notify_cmd - sta notify command 618 * 619 * Used with the sta_notify() callback in &struct ieee80211_ops, this 620 * indicates addition and removal of a station to station table 621 * 622 * @STA_NOTIFY_ADD: a station was added to the station table 623 * @STA_NOTIFY_REMOVE: a station being removed from the station table 624 */ 625enum sta_notify_cmd { 626 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE 627}; 628 629/** 630 * enum ieee80211_hw_flags - hardware flags 631 * 632 * These flags are used to indicate hardware capabilities to 633 * the stack. Generally, flags here should have their meaning 634 * done in a way that the simplest hardware doesn't need setting 635 * any particular flags. There are some exceptions to this rule, 636 * however, so you are advised to review these flags carefully. 637 * 638 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE: 639 * The device only needs to be supplied with a beacon template. 640 * If you need the host to generate each beacon then don't use 641 * this flag and call ieee80211_beacon_get() when you need the 642 * next beacon frame. Note that if you set this flag, you must 643 * implement the set_tim() callback for powersave mode to work 644 * properly. 645 * This flag is only relevant for access-point mode. 646 * 647 * @IEEE80211_HW_RX_INCLUDES_FCS: 648 * Indicates that received frames passed to the stack include 649 * the FCS at the end. 650 * 651 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 652 * Some wireless LAN chipsets buffer broadcast/multicast frames 653 * for power saving stations in the hardware/firmware and others 654 * rely on the host system for such buffering. This option is used 655 * to configure the IEEE 802.11 upper layer to buffer broadcast and 656 * multicast frames when there are power saving stations so that 657 * the driver can fetch them with ieee80211_get_buffered_bc(). Note 658 * that not setting this flag works properly only when the 659 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because 660 * otherwise the stack will not know when the DTIM beacon was sent. 661 * 662 * @IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED: 663 * Channels are already configured to the default regulatory domain 664 * specified in the device's EEPROM 665 */ 666enum ieee80211_hw_flags { 667 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0, 668 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, 669 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, 670 IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED = 1<<3, 671}; 672 673/** 674 * struct ieee80211_hw - hardware information and state 675 * 676 * This structure contains the configuration and hardware 677 * information for an 802.11 PHY. 678 * 679 * @wiphy: This points to the &struct wiphy allocated for this 680 * 802.11 PHY. You must fill in the @perm_addr and @dev 681 * members of this structure using SET_IEEE80211_DEV() 682 * and SET_IEEE80211_PERM_ADDR(). 683 * 684 * @conf: &struct ieee80211_conf, device configuration, don't use. 685 * 686 * @workqueue: single threaded workqueue available for driver use, 687 * allocated by mac80211 on registration and flushed on 688 * unregistration. 689 * 690 * @priv: pointer to private area that was allocated for driver use 691 * along with this structure. 692 * 693 * @flags: hardware flags, see &enum ieee80211_hw_flags. 694 * 695 * @extra_tx_headroom: headroom to reserve in each transmit skb 696 * for use by the driver (e.g. for transmit headers.) 697 * 698 * @channel_change_time: time (in microseconds) it takes to change channels. 699 * 700 * @max_rssi: Maximum value for ssi in RX information, use 701 * negative numbers for dBm and 0 to indicate no support. 702 * 703 * @max_signal: like @max_rssi, but for the signal value. 704 * 705 * @max_noise: like @max_rssi, but for the noise value. 706 * 707 * @queues: number of available hardware transmit queues for 708 * data packets. WMM/QoS requires at least four. 709 */ 710struct ieee80211_hw { 711 struct ieee80211_conf conf; 712 struct wiphy *wiphy; 713 struct workqueue_struct *workqueue; 714 void *priv; 715 u32 flags; 716 unsigned int extra_tx_headroom; 717 int channel_change_time; 718 u8 queues; 719 s8 max_rssi; 720 s8 max_signal; 721 s8 max_noise; 722}; 723 724/** 725 * SET_IEEE80211_DEV - set device for 802.11 hardware 726 * 727 * @hw: the &struct ieee80211_hw to set the device for 728 * @dev: the &struct device of this 802.11 device 729 */ 730static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 731{ 732 set_wiphy_dev(hw->wiphy, dev); 733} 734 735/** 736 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware 737 * 738 * @hw: the &struct ieee80211_hw to set the MAC address for 739 * @addr: the address to set 740 */ 741static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 742{ 743 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 744} 745 746/** 747 * DOC: Hardware crypto acceleration 748 * 749 * mac80211 is capable of taking advantage of many hardware 750 * acceleration designs for encryption and decryption operations. 751 * 752 * The set_key() callback in the &struct ieee80211_ops for a given 753 * device is called to enable hardware acceleration of encryption and 754 * decryption. The callback takes an @address parameter that will be 755 * the broadcast address for default keys, the other station's hardware 756 * address for individual keys or the zero address for keys that will 757 * be used only for transmission. 758 * Multiple transmission keys with the same key index may be used when 759 * VLANs are configured for an access point. 760 * 761 * The @local_address parameter will always be set to our own address, 762 * this is only relevant if you support multiple local addresses. 763 * 764 * When transmitting, the TX control data will use the @hw_key_idx 765 * selected by the driver by modifying the &struct ieee80211_key_conf 766 * pointed to by the @key parameter to the set_key() function. 767 * 768 * The set_key() call for the %SET_KEY command should return 0 if 769 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 770 * added; if you return 0 then hw_key_idx must be assigned to the 771 * hardware key index, you are free to use the full u8 range. 772 * 773 * When the cmd is %DISABLE_KEY then it must succeed. 774 * 775 * Note that it is permissible to not decrypt a frame even if a key 776 * for it has been uploaded to hardware, the stack will not make any 777 * decision based on whether a key has been uploaded or not but rather 778 * based on the receive flags. 779 * 780 * The &struct ieee80211_key_conf structure pointed to by the @key 781 * parameter is guaranteed to be valid until another call to set_key() 782 * removes it, but it can only be used as a cookie to differentiate 783 * keys. 784 */ 785 786/** 787 * DOC: Frame filtering 788 * 789 * mac80211 requires to see many management frames for proper 790 * operation, and users may want to see many more frames when 791 * in monitor mode. However, for best CPU usage and power consumption, 792 * having as few frames as possible percolate through the stack is 793 * desirable. Hence, the hardware should filter as much as possible. 794 * 795 * To achieve this, mac80211 uses filter flags (see below) to tell 796 * the driver's configure_filter() function which frames should be 797 * passed to mac80211 and which should be filtered out. 798 * 799 * The configure_filter() callback is invoked with the parameters 800 * @mc_count and @mc_list for the combined multicast address list 801 * of all virtual interfaces, @changed_flags telling which flags 802 * were changed and @total_flags with the new flag states. 803 * 804 * If your device has no multicast address filters your driver will 805 * need to check both the %FIF_ALLMULTI flag and the @mc_count 806 * parameter to see whether multicast frames should be accepted 807 * or dropped. 808 * 809 * All unsupported flags in @total_flags must be cleared, i.e. you 810 * should clear all bits except those you honoured. 811 */ 812 813/** 814 * enum ieee80211_filter_flags - hardware filter flags 815 * 816 * These flags determine what the filter in hardware should be 817 * programmed to let through and what should not be passed to the 818 * stack. It is always safe to pass more frames than requested, 819 * but this has negative impact on power consumption. 820 * 821 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, 822 * think of the BSS as your network segment and then this corresponds 823 * to the regular ethernet device promiscuous mode. 824 * 825 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 826 * by the user or if the hardware is not capable of filtering by 827 * multicast address. 828 * 829 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 830 * %RX_FLAG_FAILED_FCS_CRC for them) 831 * 832 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 833 * the %RX_FLAG_FAILED_PLCP_CRC for them 834 * 835 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 836 * to the hardware that it should not filter beacons or probe responses 837 * by BSSID. Filtering them can greatly reduce the amount of processing 838 * mac80211 needs to do and the amount of CPU wakeups, so you should 839 * honour this flag if possible. 840 * 841 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then 842 * only those addressed to this station 843 * 844 * @FIF_OTHER_BSS: pass frames destined to other BSSes 845 */ 846enum ieee80211_filter_flags { 847 FIF_PROMISC_IN_BSS = 1<<0, 848 FIF_ALLMULTI = 1<<1, 849 FIF_FCSFAIL = 1<<2, 850 FIF_PLCPFAIL = 1<<3, 851 FIF_BCN_PRBRESP_PROMISC = 1<<4, 852 FIF_CONTROL = 1<<5, 853 FIF_OTHER_BSS = 1<<6, 854}; 855 856/** 857 * enum ieee80211_erp_change_flags - erp change flags 858 * 859 * These flags are used with the erp_ie_changed() callback in 860 * &struct ieee80211_ops to indicate which parameter(s) changed. 861 * @IEEE80211_ERP_CHANGE_PROTECTION: protection changed 862 * @IEEE80211_ERP_CHANGE_PREAMBLE: barker preamble mode changed 863 */ 864enum ieee80211_erp_change_flags { 865 IEEE80211_ERP_CHANGE_PROTECTION = 1<<0, 866 IEEE80211_ERP_CHANGE_PREAMBLE = 1<<1, 867}; 868 869 870/** 871 * struct ieee80211_ops - callbacks from mac80211 to the driver 872 * 873 * This structure contains various callbacks that the driver may 874 * handle or, in some cases, must handle, for example to configure 875 * the hardware to a new channel or to transmit a frame. 876 * 877 * @tx: Handler that 802.11 module calls for each transmitted frame. 878 * skb contains the buffer starting from the IEEE 802.11 header. 879 * The low-level driver should send the frame out based on 880 * configuration in the TX control data. Must be implemented and 881 * atomic. 882 * 883 * @start: Called before the first netdevice attached to the hardware 884 * is enabled. This should turn on the hardware and must turn on 885 * frame reception (for possibly enabled monitor interfaces.) 886 * Returns negative error codes, these may be seen in userspace, 887 * or zero. 888 * When the device is started it should not have a MAC address 889 * to avoid acknowledging frames before a non-monitor device 890 * is added. 891 * Must be implemented. 892 * 893 * @stop: Called after last netdevice attached to the hardware 894 * is disabled. This should turn off the hardware (at least 895 * it must turn off frame reception.) 896 * May be called right after add_interface if that rejects 897 * an interface. 898 * Must be implemented. 899 * 900 * @add_interface: Called when a netdevice attached to the hardware is 901 * enabled. Because it is not called for monitor mode devices, @open 902 * and @stop must be implemented. 903 * The driver should perform any initialization it needs before 904 * the device can be enabled. The initial configuration for the 905 * interface is given in the conf parameter. 906 * The callback may refuse to add an interface by returning a 907 * negative error code (which will be seen in userspace.) 908 * Must be implemented. 909 * 910 * @remove_interface: Notifies a driver that an interface is going down. 911 * The @stop callback is called after this if it is the last interface 912 * and no monitor interfaces are present. 913 * When all interfaces are removed, the MAC address in the hardware 914 * must be cleared so the device no longer acknowledges packets, 915 * the mac_addr member of the conf structure is, however, set to the 916 * MAC address of the device going away. 917 * Hence, this callback must be implemented. 918 * 919 * @config: Handler for configuration requests. IEEE 802.11 code calls this 920 * function to change hardware configuration, e.g., channel. 921 * 922 * @config_interface: Handler for configuration requests related to interfaces 923 * (e.g. BSSID changes.) 924 * 925 * @configure_filter: Configure the device's RX filter. 926 * See the section "Frame filtering" for more information. 927 * This callback must be implemented and atomic. 928 * 929 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon 930 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set) 931 * mac80211 calls this function when a TIM bit must be set or cleared 932 * for a given AID. Must be atomic. 933 * 934 * @set_key: See the section "Hardware crypto acceleration" 935 * This callback can sleep, and is only called between add_interface 936 * and remove_interface calls, i.e. while the interface with the 937 * given local_address is enabled. 938 * 939 * @set_ieee8021x: Enable/disable IEEE 802.1X. This item requests wlan card 940 * to pass unencrypted EAPOL-Key frames even when encryption is 941 * configured. If the wlan card does not require such a configuration, 942 * this function pointer can be set to NULL. 943 * 944 * @set_port_auth: Set port authorization state (IEEE 802.1X PAE) to be 945 * authorized (@authorized=1) or unauthorized (=0). This function can be 946 * used if the wlan hardware or low-level driver implements PAE. 947 * mac80211 will filter frames based on authorization state in any case, 948 * so this function pointer can be NULL if low-level driver does not 949 * require event notification about port state changes. 950 * 951 * @hw_scan: Ask the hardware to service the scan request, no need to start 952 * the scan state machine in stack. 953 * 954 * @get_stats: return low-level statistics 955 * 956 * @set_privacy_invoked: For devices that generate their own beacons and probe 957 * response or association responses this updates the state of privacy_invoked 958 * returns 0 for success or an error number. 959 * 960 * @get_sequence_counter: For devices that have internal sequence counters this 961 * callback allows mac80211 to access the current value of a counter. 962 * This callback seems not well-defined, tell us if you need it. 963 * 964 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 965 * 966 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if 967 * the device does fragmentation by itself; if this method is assigned then 968 * the stack will not do fragmentation. 969 * 970 * @set_retry_limit: Configuration of retry limits (if device needs it) 971 * 972 * @sta_notify: Notifies low level driver about addition or removal 973 * of assocaited station or AP. 974 * 975 * @erp_ie_changed: Handle ERP IE change notifications. Must be atomic. 976 * 977 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 978 * bursting) for a hardware TX queue. The @queue parameter uses the 979 * %IEEE80211_TX_QUEUE_* constants. Must be atomic. 980 * 981 * @get_tx_stats: Get statistics of the current TX queue status. This is used 982 * to get number of currently queued packets (queue length), maximum queue 983 * size (limit), and total number of packets sent using each TX queue 984 * (count). This information is used for WMM to find out which TX 985 * queues have room for more packets and by hostapd to provide 986 * statistics about the current queueing state to external programs. 987 * 988 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 989 * this is only used for IBSS mode debugging and, as such, is not a 990 * required function. Must be atomic. 991 * 992 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 993 * with other STAs in the IBSS. This is only used in IBSS mode. This 994 * function is optional if the firmware/hardware takes full care of 995 * TSF synchronization. 996 * 997 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point, 998 * IBSS uses a fixed beacon frame which is configured using this 999 * function. 1000 * If the driver returns success (0) from this callback, it owns 1001 * the skb. That means the driver is responsible to kfree_skb() it. 1002 * The control structure is not dynamically allocated. That means the 1003 * driver does not own the pointer and if it needs it somewhere 1004 * outside of the context of this function, it must copy it 1005 * somewhere else. 1006 * This handler is required only for IBSS mode. 1007 * 1008 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 1009 * This is needed only for IBSS mode and the result of this function is 1010 * used to determine whether to reply to Probe Requests. 1011 */ 1012struct ieee80211_ops { 1013 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb, 1014 struct ieee80211_tx_control *control); 1015 int (*start)(struct ieee80211_hw *hw); 1016 void (*stop)(struct ieee80211_hw *hw); 1017 int (*add_interface)(struct ieee80211_hw *hw, 1018 struct ieee80211_if_init_conf *conf); 1019 void (*remove_interface)(struct ieee80211_hw *hw, 1020 struct ieee80211_if_init_conf *conf); 1021 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf); 1022 int (*config_interface)(struct ieee80211_hw *hw, 1023 int if_id, struct ieee80211_if_conf *conf); 1024 void (*configure_filter)(struct ieee80211_hw *hw, 1025 unsigned int changed_flags, 1026 unsigned int *total_flags, 1027 int mc_count, struct dev_addr_list *mc_list); 1028 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set); 1029 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, 1030 const u8 *local_address, const u8 *address, 1031 struct ieee80211_key_conf *key); 1032 int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x); 1033 int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr, 1034 int authorized); 1035 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len); 1036 int (*get_stats)(struct ieee80211_hw *hw, 1037 struct ieee80211_low_level_stats *stats); 1038 int (*set_privacy_invoked)(struct ieee80211_hw *hw, 1039 int privacy_invoked); 1040 int (*get_sequence_counter)(struct ieee80211_hw *hw, 1041 u8* addr, u8 keyidx, u8 txrx, 1042 u32* iv32, u16* iv16); 1043 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 1044 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); 1045 int (*set_retry_limit)(struct ieee80211_hw *hw, 1046 u32 short_retry, u32 long_retr); 1047 void (*sta_notify)(struct ieee80211_hw *hw, int if_id, 1048 enum sta_notify_cmd, const u8 *addr); 1049 void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes, 1050 int cts_protection, int preamble); 1051 int (*conf_tx)(struct ieee80211_hw *hw, int queue, 1052 const struct ieee80211_tx_queue_params *params); 1053 int (*get_tx_stats)(struct ieee80211_hw *hw, 1054 struct ieee80211_tx_queue_stats *stats); 1055 u64 (*get_tsf)(struct ieee80211_hw *hw); 1056 void (*reset_tsf)(struct ieee80211_hw *hw); 1057 int (*beacon_update)(struct ieee80211_hw *hw, 1058 struct sk_buff *skb, 1059 struct ieee80211_tx_control *control); 1060 int (*tx_last_beacon)(struct ieee80211_hw *hw); 1061}; 1062 1063/** 1064 * ieee80211_alloc_hw - Allocate a new hardware device 1065 * 1066 * This must be called once for each hardware device. The returned pointer 1067 * must be used to refer to this device when calling other functions. 1068 * mac80211 allocates a private data area for the driver pointed to by 1069 * @priv in &struct ieee80211_hw, the size of this area is given as 1070 * @priv_data_len. 1071 * 1072 * @priv_data_len: length of private data 1073 * @ops: callbacks for this device 1074 */ 1075struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 1076 const struct ieee80211_ops *ops); 1077 1078/** 1079 * ieee80211_register_hw - Register hardware device 1080 * 1081 * You must call this function before any other functions 1082 * except ieee80211_register_hwmode. 1083 * 1084 * @hw: the device to register as returned by ieee80211_alloc_hw() 1085 */ 1086int ieee80211_register_hw(struct ieee80211_hw *hw); 1087 1088#ifdef CONFIG_MAC80211_LEDS 1089extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 1090extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 1091extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); 1092#endif 1093/** 1094 * ieee80211_get_tx_led_name - get name of TX LED 1095 * 1096 * mac80211 creates a transmit LED trigger for each wireless hardware 1097 * that can be used to drive LEDs if your driver registers a LED device. 1098 * This function returns the name (or %NULL if not configured for LEDs) 1099 * of the trigger so you can automatically link the LED device. 1100 * 1101 * @hw: the hardware to get the LED trigger name for 1102 */ 1103static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 1104{ 1105#ifdef CONFIG_MAC80211_LEDS 1106 return __ieee80211_get_tx_led_name(hw); 1107#else 1108 return NULL; 1109#endif 1110} 1111 1112/** 1113 * ieee80211_get_rx_led_name - get name of RX LED 1114 * 1115 * mac80211 creates a receive LED trigger for each wireless hardware 1116 * that can be used to drive LEDs if your driver registers a LED device. 1117 * This function returns the name (or %NULL if not configured for LEDs) 1118 * of the trigger so you can automatically link the LED device. 1119 * 1120 * @hw: the hardware to get the LED trigger name for 1121 */ 1122static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 1123{ 1124#ifdef CONFIG_MAC80211_LEDS 1125 return __ieee80211_get_rx_led_name(hw); 1126#else 1127 return NULL; 1128#endif 1129} 1130 1131static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) 1132{ 1133#ifdef CONFIG_MAC80211_LEDS 1134 return __ieee80211_get_assoc_led_name(hw); 1135#else 1136 return NULL; 1137#endif 1138} 1139 1140 1141/* Register a new hardware PHYMODE capability to the stack. */ 1142int ieee80211_register_hwmode(struct ieee80211_hw *hw, 1143 struct ieee80211_hw_mode *mode); 1144 1145/** 1146 * ieee80211_unregister_hw - Unregister a hardware device 1147 * 1148 * This function instructs mac80211 to free allocated resources 1149 * and unregister netdevices from the networking subsystem. 1150 * 1151 * @hw: the hardware to unregister 1152 */ 1153void ieee80211_unregister_hw(struct ieee80211_hw *hw); 1154 1155/** 1156 * ieee80211_free_hw - free hardware descriptor 1157 * 1158 * This function frees everything that was allocated, including the 1159 * private data for the driver. You must call ieee80211_unregister_hw() 1160 * before calling this function 1161 * 1162 * @hw: the hardware to free 1163 */ 1164void ieee80211_free_hw(struct ieee80211_hw *hw); 1165 1166/* trick to avoid symbol clashes with the ieee80211 subsystem */ 1167void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1168 struct ieee80211_rx_status *status); 1169 1170/** 1171 * ieee80211_rx - receive frame 1172 * 1173 * Use this function to hand received frames to mac80211. The receive 1174 * buffer in @skb must start with an IEEE 802.11 header or a radiotap 1175 * header if %RX_FLAG_RADIOTAP is set in the @status flags. 1176 * 1177 * This function may not be called in IRQ context. 1178 * 1179 * @hw: the hardware this frame came in on 1180 * @skb: the buffer to receive, owned by mac80211 after this call 1181 * @status: status of this frame; the status pointer need not be valid 1182 * after this function returns 1183 */ 1184static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1185 struct ieee80211_rx_status *status) 1186{ 1187 __ieee80211_rx(hw, skb, status); 1188} 1189 1190/** 1191 * ieee80211_rx_irqsafe - receive frame 1192 * 1193 * Like ieee80211_rx() but can be called in IRQ context 1194 * (internally defers to a workqueue.) 1195 * 1196 * @hw: the hardware this frame came in on 1197 * @skb: the buffer to receive, owned by mac80211 after this call 1198 * @status: status of this frame; the status pointer need not be valid 1199 * after this function returns and is not freed by mac80211, 1200 * it is recommended that it points to a stack area 1201 */ 1202void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, 1203 struct sk_buff *skb, 1204 struct ieee80211_rx_status *status); 1205 1206/** 1207 * ieee80211_tx_status - transmit status callback 1208 * 1209 * Call this function for all transmitted frames after they have been 1210 * transmitted. It is permissible to not call this function for 1211 * multicast frames but this can affect statistics. 1212 * 1213 * @hw: the hardware the frame was transmitted by 1214 * @skb: the frame that was transmitted, owned by mac80211 after this call 1215 * @status: status information for this frame; the status pointer need not 1216 * be valid after this function returns and is not freed by mac80211, 1217 * it is recommended that it points to a stack area 1218 */ 1219void ieee80211_tx_status(struct ieee80211_hw *hw, 1220 struct sk_buff *skb, 1221 struct ieee80211_tx_status *status); 1222void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 1223 struct sk_buff *skb, 1224 struct ieee80211_tx_status *status); 1225 1226/** 1227 * ieee80211_beacon_get - beacon generation function 1228 * @hw: pointer obtained from ieee80211_alloc_hw(). 1229 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1230 * @control: will be filled with information needed to send this beacon. 1231 * 1232 * If the beacon frames are generated by the host system (i.e., not in 1233 * hardware/firmware), the low-level driver uses this function to receive 1234 * the next beacon frame from the 802.11 code. The low-level is responsible 1235 * for calling this function before beacon data is needed (e.g., based on 1236 * hardware interrupt). Returned skb is used only once and low-level driver 1237 * is responsible of freeing it. 1238 */ 1239struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 1240 int if_id, 1241 struct ieee80211_tx_control *control); 1242 1243/** 1244 * ieee80211_rts_get - RTS frame generation function 1245 * @hw: pointer obtained from ieee80211_alloc_hw(). 1246 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1247 * @frame: pointer to the frame that is going to be protected by the RTS. 1248 * @frame_len: the frame length (in octets). 1249 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1250 * @rts: The buffer where to store the RTS frame. 1251 * 1252 * If the RTS frames are generated by the host system (i.e., not in 1253 * hardware/firmware), the low-level driver uses this function to receive 1254 * the next RTS frame from the 802.11 code. The low-level is responsible 1255 * for calling this function before and RTS frame is needed. 1256 */ 1257void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id, 1258 const void *frame, size_t frame_len, 1259 const struct ieee80211_tx_control *frame_txctl, 1260 struct ieee80211_rts *rts); 1261 1262/** 1263 * ieee80211_rts_duration - Get the duration field for an RTS frame 1264 * @hw: pointer obtained from ieee80211_alloc_hw(). 1265 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1266 * @frame_len: the length of the frame that is going to be protected by the RTS. 1267 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1268 * 1269 * If the RTS is generated in firmware, but the host system must provide 1270 * the duration field, the low-level driver uses this function to receive 1271 * the duration field value in little-endian byteorder. 1272 */ 1273__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id, 1274 size_t frame_len, 1275 const struct ieee80211_tx_control *frame_txctl); 1276 1277/** 1278 * ieee80211_ctstoself_get - CTS-to-self frame generation function 1279 * @hw: pointer obtained from ieee80211_alloc_hw(). 1280 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1281 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 1282 * @frame_len: the frame length (in octets). 1283 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1284 * @cts: The buffer where to store the CTS-to-self frame. 1285 * 1286 * If the CTS-to-self frames are generated by the host system (i.e., not in 1287 * hardware/firmware), the low-level driver uses this function to receive 1288 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 1289 * for calling this function before and CTS-to-self frame is needed. 1290 */ 1291void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id, 1292 const void *frame, size_t frame_len, 1293 const struct ieee80211_tx_control *frame_txctl, 1294 struct ieee80211_cts *cts); 1295 1296/** 1297 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 1298 * @hw: pointer obtained from ieee80211_alloc_hw(). 1299 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1300 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 1301 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1302 * 1303 * If the CTS-to-self is generated in firmware, but the host system must provide 1304 * the duration field, the low-level driver uses this function to receive 1305 * the duration field value in little-endian byteorder. 1306 */ 1307__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id, 1308 size_t frame_len, 1309 const struct ieee80211_tx_control *frame_txctl); 1310 1311/** 1312 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 1313 * @hw: pointer obtained from ieee80211_alloc_hw(). 1314 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1315 * @frame_len: the length of the frame. 1316 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted. 1317 * 1318 * Calculate the duration field of some generic frame, given its 1319 * length and transmission rate (in 100kbps). 1320 */ 1321__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id, 1322 size_t frame_len, 1323 int rate); 1324 1325/** 1326 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 1327 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1328 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1329 * @control: will be filled with information needed to send returned frame. 1330 * 1331 * Function for accessing buffered broadcast and multicast frames. If 1332 * hardware/firmware does not implement buffering of broadcast/multicast 1333 * frames when power saving is used, 802.11 code buffers them in the host 1334 * memory. The low-level driver uses this function to fetch next buffered 1335 * frame. In most cases, this is used when generating beacon frame. This 1336 * function returns a pointer to the next buffered skb or NULL if no more 1337 * buffered frames are available. 1338 * 1339 * Note: buffered frames are returned only after DTIM beacon frame was 1340 * generated with ieee80211_beacon_get() and the low-level driver must thus 1341 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 1342 * NULL if the previous generated beacon was not DTIM, so the low-level driver 1343 * does not need to check for DTIM beacons separately and should be able to 1344 * use common code for all beacons. 1345 */ 1346struct sk_buff * 1347ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id, 1348 struct ieee80211_tx_control *control); 1349 1350/** 1351 * ieee80211_get_hdrlen_from_skb - get header length from data 1352 * 1353 * Given an skb with a raw 802.11 header at the data pointer this function 1354 * returns the 802.11 header length in bytes (not including encryption 1355 * headers). If the data in the sk_buff is too short to contain a valid 802.11 1356 * header the function returns 0. 1357 * 1358 * @skb: the frame 1359 */ 1360int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); 1361 1362/** 1363 * ieee80211_get_hdrlen - get header length from frame control 1364 * 1365 * This function returns the 802.11 header length in bytes (not including 1366 * encryption headers.) 1367 * 1368 * @fc: the frame control field (in CPU endianness) 1369 */ 1370int ieee80211_get_hdrlen(u16 fc); 1371 1372/** 1373 * ieee80211_wake_queue - wake specific queue 1374 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1375 * @queue: queue number (counted from zero). 1376 * 1377 * Drivers should use this function instead of netif_wake_queue. 1378 */ 1379void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 1380 1381/** 1382 * ieee80211_stop_queue - stop specific queue 1383 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1384 * @queue: queue number (counted from zero). 1385 * 1386 * Drivers should use this function instead of netif_stop_queue. 1387 */ 1388void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 1389 1390/** 1391 * ieee80211_start_queues - start all queues 1392 * @hw: pointer to as obtained from ieee80211_alloc_hw(). 1393 * 1394 * Drivers should use this function instead of netif_start_queue. 1395 */ 1396void ieee80211_start_queues(struct ieee80211_hw *hw); 1397 1398/** 1399 * ieee80211_stop_queues - stop all queues 1400 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1401 * 1402 * Drivers should use this function instead of netif_stop_queue. 1403 */ 1404void ieee80211_stop_queues(struct ieee80211_hw *hw); 1405 1406/** 1407 * ieee80211_wake_queues - wake all queues 1408 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1409 * 1410 * Drivers should use this function instead of netif_wake_queue. 1411 */ 1412void ieee80211_wake_queues(struct ieee80211_hw *hw); 1413 1414/** 1415 * ieee80211_scan_completed - completed hardware scan 1416 * 1417 * When hardware scan offload is used (i.e. the hw_scan() callback is 1418 * assigned) this function needs to be called by the driver to notify 1419 * mac80211 that the scan finished. 1420 * 1421 * @hw: the hardware that finished the scan 1422 */ 1423void ieee80211_scan_completed(struct ieee80211_hw *hw); 1424 1425#endif /* MAC80211_H */ 1426