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