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