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