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