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