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