mac80211.h revision e37d4dffdffb7f834bd28d4ae8e3dcdf07fce508
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-2008 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-IRQ-safe 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 * enum ieee80211_notification_type - Low level driver notification 78 * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence 79 */ 80enum ieee80211_notification_types { 81 IEEE80211_NOTIFY_RE_ASSOC, 82}; 83 84/** 85 * enum ieee80211_max_queues - maximum number of queues 86 * 87 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues. 88 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable 89 * for A-MPDU operation. 90 */ 91enum ieee80211_max_queues { 92 IEEE80211_MAX_QUEUES = 16, 93 IEEE80211_MAX_AMPDU_QUEUES = 16, 94}; 95 96/** 97 * struct ieee80211_tx_queue_params - transmit queue configuration 98 * 99 * The information provided in this structure is required for QoS 100 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29. 101 * 102 * @aifs: arbitration interframe space [0..255] 103 * @cw_min: minimum contention window [a value of the form 104 * 2^n-1 in the range 1..32767] 105 * @cw_max: maximum contention window [like @cw_min] 106 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled 107 */ 108struct ieee80211_tx_queue_params { 109 u16 txop; 110 u16 cw_min; 111 u16 cw_max; 112 u8 aifs; 113}; 114 115/** 116 * struct ieee80211_tx_queue_stats - transmit queue statistics 117 * 118 * @len: number of packets in queue 119 * @limit: queue length limit 120 * @count: number of frames sent 121 */ 122struct ieee80211_tx_queue_stats { 123 unsigned int len; 124 unsigned int limit; 125 unsigned int count; 126}; 127 128struct ieee80211_low_level_stats { 129 unsigned int dot11ACKFailureCount; 130 unsigned int dot11RTSFailureCount; 131 unsigned int dot11FCSErrorCount; 132 unsigned int dot11RTSSuccessCount; 133}; 134 135/** 136 * enum ieee80211_bss_change - BSS change notification flags 137 * 138 * These flags are used with the bss_info_changed() callback 139 * to indicate which BSS parameter changed. 140 * 141 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated), 142 * also implies a change in the AID. 143 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed 144 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed 145 * @BSS_CHANGED_ERP_SLOT: slot timing changed 146 * @BSS_CHANGED_HT: 802.11n parameters changed 147 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed 148 */ 149enum ieee80211_bss_change { 150 BSS_CHANGED_ASSOC = 1<<0, 151 BSS_CHANGED_ERP_CTS_PROT = 1<<1, 152 BSS_CHANGED_ERP_PREAMBLE = 1<<2, 153 BSS_CHANGED_ERP_SLOT = 1<<3, 154 BSS_CHANGED_HT = 1<<4, 155 BSS_CHANGED_BASIC_RATES = 1<<5, 156}; 157 158/** 159 * struct ieee80211_bss_ht_conf - BSS's changing HT configuration 160 * @secondary_channel_offset: secondary channel offset, uses 161 * %IEEE80211_HT_PARAM_CHA_SEC_ values 162 * @width_40_ok: indicates that 40 MHz bandwidth may be used for TX 163 * @operation_mode: HT operation mode (like in &struct ieee80211_ht_info) 164 */ 165struct ieee80211_bss_ht_conf { 166 u8 secondary_channel_offset; 167 bool width_40_ok; 168 u16 operation_mode; 169}; 170 171/** 172 * struct ieee80211_bss_conf - holds the BSS's changing parameters 173 * 174 * This structure keeps information about a BSS (and an association 175 * to that BSS) that can change during the lifetime of the BSS. 176 * 177 * @assoc: association status 178 * @aid: association ID number, valid only when @assoc is true 179 * @use_cts_prot: use CTS protection 180 * @use_short_preamble: use 802.11b short preamble; 181 * if the hardware cannot handle this it must set the 182 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag 183 * @use_short_slot: use short slot time (only relevant for ERP); 184 * if the hardware cannot handle this it must set the 185 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag 186 * @dtim_period: num of beacons before the next DTIM, for PSM 187 * @timestamp: beacon timestamp 188 * @beacon_int: beacon interval 189 * @assoc_capability: capabilities taken from assoc resp 190 * @ht: BSS's HT configuration 191 * @basic_rates: bitmap of basic rates, each bit stands for an 192 * index into the rate table configured by the driver in 193 * the current band. 194 */ 195struct ieee80211_bss_conf { 196 /* association related data */ 197 bool assoc; 198 u16 aid; 199 /* erp related data */ 200 bool use_cts_prot; 201 bool use_short_preamble; 202 bool use_short_slot; 203 u8 dtim_period; 204 u16 beacon_int; 205 u16 assoc_capability; 206 u64 timestamp; 207 u64 basic_rates; 208 struct ieee80211_bss_ht_conf ht; 209}; 210 211/** 212 * enum mac80211_tx_control_flags - flags to describe transmission information/status 213 * 214 * These flags are used with the @flags member of &ieee80211_tx_info. 215 * 216 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame. 217 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence 218 * number to this frame, taking care of not overwriting the fragment 219 * number and increasing the sequence number only when the 220 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly 221 * assign sequence numbers to QoS-data frames but cannot do so correctly 222 * for non-QoS-data and management frames because beacons need them from 223 * that counter as well and mac80211 cannot guarantee proper sequencing. 224 * If this flag is set, the driver should instruct the hardware to 225 * assign a sequence number to the frame or assign one itself. Cf. IEEE 226 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for 227 * beacons and always be clear for frames without a sequence number field. 228 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack 229 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination 230 * station 231 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame 232 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon 233 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU 234 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211. 235 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted 236 * because the destination STA was in powersave mode. 237 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged 238 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status 239 * is for the whole aggregation. 240 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned, 241 * so consider using block ack request (BAR). 242 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be 243 * set by rate control algorithms to indicate probe rate, will 244 * be cleared for fragmented frames (except on the last fragment) 245 * @IEEE80211_TX_CTL_REQUEUE: REMOVE THIS 246 */ 247enum mac80211_tx_control_flags { 248 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0), 249 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1), 250 IEEE80211_TX_CTL_NO_ACK = BIT(2), 251 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3), 252 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4), 253 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5), 254 IEEE80211_TX_CTL_AMPDU = BIT(6), 255 IEEE80211_TX_CTL_INJECTED = BIT(7), 256 IEEE80211_TX_STAT_TX_FILTERED = BIT(8), 257 IEEE80211_TX_STAT_ACK = BIT(9), 258 IEEE80211_TX_STAT_AMPDU = BIT(10), 259 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11), 260 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12), 261 262 /* XXX: remove this */ 263 IEEE80211_TX_CTL_REQUEUE = BIT(13), 264}; 265 266enum mac80211_rate_control_flags { 267 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0), 268 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1), 269 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2), 270 271 /* rate index is an MCS rate number instead of an index */ 272 IEEE80211_TX_RC_MCS = BIT(3), 273 IEEE80211_TX_RC_GREEN_FIELD = BIT(4), 274 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5), 275 IEEE80211_TX_RC_DUP_DATA = BIT(6), 276 IEEE80211_TX_RC_SHORT_GI = BIT(7), 277}; 278 279 280/* there are 40 bytes if you don't need the rateset to be kept */ 281#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40 282 283/* if you do need the rateset, then you have less space */ 284#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24 285 286/* maximum number of rate stages */ 287#define IEEE80211_TX_MAX_RATES 5 288 289/** 290 * struct ieee80211_tx_rate - rate selection/status 291 * 292 * @idx: rate index to attempt to send with 293 * @flags: rate control flags (&enum mac80211_rate_control_flags) 294 * @limit: number of retries before fallback 295 * 296 * A value of -1 for @idx indicates an invalid rate and, if used 297 * in an array of retry rates, that no more rates should be tried. 298 * 299 * When used for transmit status reporting, the driver should 300 * always report the rate along with the flags it used. 301 */ 302struct ieee80211_tx_rate { 303 s8 idx; 304 u8 count; 305 u8 flags; 306}; 307 308/** 309 * struct ieee80211_tx_info - skb transmit information 310 * 311 * This structure is placed in skb->cb for three uses: 312 * (1) mac80211 TX control - mac80211 tells the driver what to do 313 * (2) driver internal use (if applicable) 314 * (3) TX status information - driver tells mac80211 what happened 315 * 316 * The TX control's sta pointer is only valid during the ->tx call, 317 * it may be NULL. 318 * 319 * @flags: transmit info flags, defined above 320 * @band: the band to transmit on (use for checking for races) 321 * @antenna_sel_tx: antenna to use, 0 for automatic diversity 322 * @control: union for control data 323 * @status: union for status data 324 * @driver_data: array of driver_data pointers 325 * @retry_count: number of retries 326 * @ampdu_ack_len: number of aggregated frames. 327 * relevant only if IEEE80211_TX_STATUS_AMPDU was set. 328 * @ampdu_ack_map: block ack bit map for the aggregation. 329 * relevant only if IEEE80211_TX_STATUS_AMPDU was set. 330 * @ack_signal: signal strength of the ACK frame 331 */ 332struct ieee80211_tx_info { 333 /* common information */ 334 u32 flags; 335 u8 band; 336 337 u8 antenna_sel_tx; 338 339 /* 2 byte hole */ 340 341 union { 342 struct { 343 union { 344 /* rate control */ 345 struct { 346 struct ieee80211_tx_rate rates[ 347 IEEE80211_TX_MAX_RATES]; 348 s8 rts_cts_rate_idx; 349 }; 350 /* only needed before rate control */ 351 unsigned long jiffies; 352 }; 353 /* NB: vif can be NULL for injected frames */ 354 struct ieee80211_vif *vif; 355 struct ieee80211_key_conf *hw_key; 356 struct ieee80211_sta *sta; 357 } control; 358 struct { 359 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES]; 360 u8 ampdu_ack_len; 361 u64 ampdu_ack_map; 362 int ack_signal; 363 /* 8 bytes free */ 364 } status; 365 struct { 366 struct ieee80211_tx_rate driver_rates[ 367 IEEE80211_TX_MAX_RATES]; 368 void *rate_driver_data[ 369 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)]; 370 }; 371 void *driver_data[ 372 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)]; 373 }; 374}; 375 376static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb) 377{ 378 return (struct ieee80211_tx_info *)skb->cb; 379} 380 381/** 382 * ieee80211_tx_info_clear_status - clear TX status 383 * 384 * @info: The &struct ieee80211_tx_info to be cleared. 385 * 386 * When the driver passes an skb back to mac80211, it must report 387 * a number of things in TX status. This function clears everything 388 * in the TX status but the rate control information (it does clear 389 * the count since you need to fill that in anyway). 390 * 391 * NOTE: You can only use this function if you do NOT use 392 * info->driver_data! Use info->rate_driver_data 393 * instead if you need only the less space that allows. 394 */ 395static inline void 396ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info) 397{ 398 int i; 399 400 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 401 offsetof(struct ieee80211_tx_info, control.rates)); 402 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 403 offsetof(struct ieee80211_tx_info, driver_rates)); 404 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8); 405 /* clear the rate counts */ 406 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) 407 info->status.rates[i].count = 0; 408 409 BUILD_BUG_ON( 410 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23); 411 memset(&info->status.ampdu_ack_len, 0, 412 sizeof(struct ieee80211_tx_info) - 413 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len)); 414} 415 416 417/** 418 * enum mac80211_rx_flags - receive flags 419 * 420 * These flags are used with the @flag member of &struct ieee80211_rx_status. 421 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. 422 * Use together with %RX_FLAG_MMIC_STRIPPED. 423 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. 424 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header. 425 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, 426 * verification has been done by the hardware. 427 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame. 428 * If this flag is set, the stack cannot do any replay detection 429 * hence the driver or hardware will have to do that. 430 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on 431 * the frame. 432 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on 433 * the frame. 434 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field) 435 * is valid. This is useful in monitor mode and necessary for beacon frames 436 * to enable IBSS merging. 437 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame 438 */ 439enum mac80211_rx_flags { 440 RX_FLAG_MMIC_ERROR = 1<<0, 441 RX_FLAG_DECRYPTED = 1<<1, 442 RX_FLAG_RADIOTAP = 1<<2, 443 RX_FLAG_MMIC_STRIPPED = 1<<3, 444 RX_FLAG_IV_STRIPPED = 1<<4, 445 RX_FLAG_FAILED_FCS_CRC = 1<<5, 446 RX_FLAG_FAILED_PLCP_CRC = 1<<6, 447 RX_FLAG_TSFT = 1<<7, 448 RX_FLAG_SHORTPRE = 1<<8 449}; 450 451/** 452 * struct ieee80211_rx_status - receive status 453 * 454 * The low-level driver should provide this information (the subset 455 * supported by hardware) to the 802.11 code with each received 456 * frame. 457 * 458 * @mactime: value in microseconds of the 64-bit Time Synchronization Function 459 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware. 460 * @band: the active band when this frame was received 461 * @freq: frequency the radio was tuned to when receiving this frame, in MHz 462 * @signal: signal strength when receiving this frame, either in dBm, in dB or 463 * unspecified depending on the hardware capabilities flags 464 * @IEEE80211_HW_SIGNAL_* 465 * @noise: noise when receiving this frame, in dBm. 466 * @qual: overall signal quality indication, in percent (0-100). 467 * @antenna: antenna used 468 * @rate_idx: index of data rate into band's supported rates 469 * @flag: %RX_FLAG_* 470 */ 471struct ieee80211_rx_status { 472 u64 mactime; 473 enum ieee80211_band band; 474 int freq; 475 int signal; 476 int noise; 477 int qual; 478 int antenna; 479 int rate_idx; 480 int flag; 481}; 482 483/** 484 * enum ieee80211_conf_flags - configuration flags 485 * 486 * Flags to define PHY configuration options 487 * 488 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported) 489 * @IEEE80211_CONF_PS: Enable 802.11 power save mode 490 */ 491enum ieee80211_conf_flags { 492 IEEE80211_CONF_RADIOTAP = (1<<0), 493 IEEE80211_CONF_PS = (1<<1), 494}; 495 496/* XXX: remove all this once drivers stop trying to use it */ 497static inline int __deprecated __IEEE80211_CONF_SHORT_SLOT_TIME(void) 498{ 499 return 0; 500} 501#define IEEE80211_CONF_SHORT_SLOT_TIME (__IEEE80211_CONF_SHORT_SLOT_TIME()) 502 503struct ieee80211_ht_conf { 504 bool enabled; 505}; 506 507/** 508 * enum ieee80211_conf_changed - denotes which configuration changed 509 * 510 * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed 511 * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed 512 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed 513 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed 514 * @IEEE80211_CONF_CHANGE_PS: the PS flag changed 515 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed 516 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel changed 517 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed 518 * @IEEE80211_CONF_CHANGE_HT: HT configuration changed 519 */ 520enum ieee80211_conf_changed { 521 IEEE80211_CONF_CHANGE_RADIO_ENABLED = BIT(0), 522 IEEE80211_CONF_CHANGE_BEACON_INTERVAL = BIT(1), 523 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2), 524 IEEE80211_CONF_CHANGE_RADIOTAP = BIT(3), 525 IEEE80211_CONF_CHANGE_PS = BIT(4), 526 IEEE80211_CONF_CHANGE_POWER = BIT(5), 527 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6), 528 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7), 529 IEEE80211_CONF_CHANGE_HT = BIT(8), 530}; 531 532/** 533 * struct ieee80211_conf - configuration of the device 534 * 535 * This struct indicates how the driver shall configure the hardware. 536 * 537 * @radio_enabled: when zero, driver is required to switch off the radio. 538 * @beacon_int: beacon interval (TODO make interface config) 539 * @listen_interval: listen interval in units of beacon interval 540 * @flags: configuration flags defined above 541 * @power_level: requested transmit power (in dBm) 542 * @channel: the channel to tune to 543 * @ht: the HT configuration for the device 544 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame 545 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11, 546 * but actually means the number of transmissions not the number of retries 547 * @short_frame_max_tx_count: Maximum number of transmissions for a "short" 548 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the 549 * number of transmissions not the number of retries 550 */ 551struct ieee80211_conf { 552 int beacon_int; 553 u32 flags; 554 int power_level; 555 556 u16 listen_interval; 557 bool radio_enabled; 558 559 u8 long_frame_max_tx_count, short_frame_max_tx_count; 560 561 struct ieee80211_channel *channel; 562 struct ieee80211_ht_conf ht; 563}; 564 565/** 566 * struct ieee80211_vif - per-interface data 567 * 568 * Data in this structure is continually present for driver 569 * use during the life of a virtual interface. 570 * 571 * @type: type of this virtual interface 572 * @bss_conf: BSS configuration for this interface, either our own 573 * or the BSS we're associated to 574 * @drv_priv: data area for driver use, will always be aligned to 575 * sizeof(void *). 576 */ 577struct ieee80211_vif { 578 enum nl80211_iftype type; 579 struct ieee80211_bss_conf bss_conf; 580 /* must be last */ 581 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); 582}; 583 584static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif) 585{ 586#ifdef CONFIG_MAC80211_MESH 587 return vif->type == NL80211_IFTYPE_MESH_POINT; 588#endif 589 return false; 590} 591 592/** 593 * struct ieee80211_if_init_conf - initial configuration of an interface 594 * 595 * @vif: pointer to a driver-use per-interface structure. The pointer 596 * itself is also used for various functions including 597 * ieee80211_beacon_get() and ieee80211_get_buffered_bc(). 598 * @type: one of &enum nl80211_iftype constants. Determines the type of 599 * added/removed interface. 600 * @mac_addr: pointer to MAC address of the interface. This pointer is valid 601 * until the interface is removed (i.e. it cannot be used after 602 * remove_interface() callback was called for this interface). 603 * 604 * This structure is used in add_interface() and remove_interface() 605 * callbacks of &struct ieee80211_hw. 606 * 607 * When you allow multiple interfaces to be added to your PHY, take care 608 * that the hardware can actually handle multiple MAC addresses. However, 609 * also take care that when there's no interface left with mac_addr != %NULL 610 * you remove the MAC address from the device to avoid acknowledging packets 611 * in pure monitor mode. 612 */ 613struct ieee80211_if_init_conf { 614 enum nl80211_iftype type; 615 struct ieee80211_vif *vif; 616 void *mac_addr; 617}; 618 619/** 620 * enum ieee80211_if_conf_change - interface config change flags 621 * 622 * @IEEE80211_IFCC_BSSID: The BSSID changed. 623 * @IEEE80211_IFCC_SSID: The SSID changed. 624 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed 625 * (currently AP and MESH only), use ieee80211_beacon_get(). 626 */ 627enum ieee80211_if_conf_change { 628 IEEE80211_IFCC_BSSID = BIT(0), 629 IEEE80211_IFCC_SSID = BIT(1), 630 IEEE80211_IFCC_BEACON = BIT(2), 631}; 632 633/** 634 * struct ieee80211_if_conf - configuration of an interface 635 * 636 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change. 637 * @bssid: BSSID of the network we are associated to/creating. 638 * @ssid: used (together with @ssid_len) by drivers for hardware that 639 * generate beacons independently. The pointer is valid only during the 640 * config_interface() call, so copy the value somewhere if you need 641 * it. 642 * @ssid_len: length of the @ssid field. 643 * 644 * This structure is passed to the config_interface() callback of 645 * &struct ieee80211_hw. 646 */ 647struct ieee80211_if_conf { 648 u32 changed; 649 u8 *bssid; 650 u8 *ssid; 651 size_t ssid_len; 652}; 653 654/** 655 * enum ieee80211_key_alg - key algorithm 656 * @ALG_WEP: WEP40 or WEP104 657 * @ALG_TKIP: TKIP 658 * @ALG_CCMP: CCMP (AES) 659 */ 660enum ieee80211_key_alg { 661 ALG_WEP, 662 ALG_TKIP, 663 ALG_CCMP, 664}; 665 666/** 667 * enum ieee80211_key_len - key length 668 * @LEN_WEP40: WEP 5-byte long key 669 * @LEN_WEP104: WEP 13-byte long key 670 */ 671enum ieee80211_key_len { 672 LEN_WEP40 = 5, 673 LEN_WEP104 = 13, 674}; 675 676/** 677 * enum ieee80211_key_flags - key flags 678 * 679 * These flags are used for communication about keys between the driver 680 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. 681 * 682 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates 683 * that the STA this key will be used with could be using QoS. 684 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the 685 * driver to indicate that it requires IV generation for this 686 * particular key. 687 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by 688 * the driver for a TKIP key if it requires Michael MIC 689 * generation in software. 690 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates 691 * that the key is pairwise rather then a shared key. 692 */ 693enum ieee80211_key_flags { 694 IEEE80211_KEY_FLAG_WMM_STA = 1<<0, 695 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1, 696 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2, 697 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3, 698}; 699 700/** 701 * struct ieee80211_key_conf - key information 702 * 703 * This key information is given by mac80211 to the driver by 704 * the set_key() callback in &struct ieee80211_ops. 705 * 706 * @hw_key_idx: To be set by the driver, this is the key index the driver 707 * wants to be given when a frame is transmitted and needs to be 708 * encrypted in hardware. 709 * @alg: The key algorithm. 710 * @flags: key flags, see &enum ieee80211_key_flags. 711 * @keyidx: the key index (0-3) 712 * @keylen: key material length 713 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte) 714 * data block: 715 * - Temporal Encryption Key (128 bits) 716 * - Temporal Authenticator Tx MIC Key (64 bits) 717 * - Temporal Authenticator Rx MIC Key (64 bits) 718 * @icv_len: FIXME 719 * @iv_len: FIXME 720 */ 721struct ieee80211_key_conf { 722 enum ieee80211_key_alg alg; 723 u8 icv_len; 724 u8 iv_len; 725 u8 hw_key_idx; 726 u8 flags; 727 s8 keyidx; 728 u8 keylen; 729 u8 key[0]; 730}; 731 732/** 733 * enum set_key_cmd - key command 734 * 735 * Used with the set_key() callback in &struct ieee80211_ops, this 736 * indicates whether a key is being removed or added. 737 * 738 * @SET_KEY: a key is set 739 * @DISABLE_KEY: a key must be disabled 740 */ 741enum set_key_cmd { 742 SET_KEY, DISABLE_KEY, 743}; 744 745/** 746 * struct ieee80211_sta - station table entry 747 * 748 * A station table entry represents a station we are possibly 749 * communicating with. Since stations are RCU-managed in 750 * mac80211, any ieee80211_sta pointer you get access to must 751 * either be protected by rcu_read_lock() explicitly or implicitly, 752 * or you must take good care to not use such a pointer after a 753 * call to your sta_notify callback that removed it. 754 * 755 * @addr: MAC address 756 * @aid: AID we assigned to the station if we're an AP 757 * @supp_rates: Bitmap of supported rates (per band) 758 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities 759 * @drv_priv: data area for driver use, will always be aligned to 760 * sizeof(void *), size is determined in hw information. 761 */ 762struct ieee80211_sta { 763 u64 supp_rates[IEEE80211_NUM_BANDS]; 764 u8 addr[ETH_ALEN]; 765 u16 aid; 766 struct ieee80211_sta_ht_cap ht_cap; 767 768 /* must be last */ 769 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); 770}; 771 772/** 773 * enum sta_notify_cmd - sta notify command 774 * 775 * Used with the sta_notify() callback in &struct ieee80211_ops, this 776 * indicates addition and removal of a station to station table. 777 * 778 * @STA_NOTIFY_ADD: a station was added to the station table 779 * @STA_NOTIFY_REMOVE: a station being removed from the station table 780 */ 781enum sta_notify_cmd { 782 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE 783}; 784 785/** 786 * enum ieee80211_tkip_key_type - get tkip key 787 * 788 * Used by drivers which need to get a tkip key for skb. Some drivers need a 789 * phase 1 key, others need a phase 2 key. A single function allows the driver 790 * to get the key, this enum indicates what type of key is required. 791 * 792 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key 793 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key 794 */ 795enum ieee80211_tkip_key_type { 796 IEEE80211_TKIP_P1_KEY, 797 IEEE80211_TKIP_P2_KEY, 798}; 799 800/** 801 * enum ieee80211_hw_flags - hardware flags 802 * 803 * These flags are used to indicate hardware capabilities to 804 * the stack. Generally, flags here should have their meaning 805 * done in a way that the simplest hardware doesn't need setting 806 * any particular flags. There are some exceptions to this rule, 807 * however, so you are advised to review these flags carefully. 808 * 809 * @IEEE80211_HW_RX_INCLUDES_FCS: 810 * Indicates that received frames passed to the stack include 811 * the FCS at the end. 812 * 813 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 814 * Some wireless LAN chipsets buffer broadcast/multicast frames 815 * for power saving stations in the hardware/firmware and others 816 * rely on the host system for such buffering. This option is used 817 * to configure the IEEE 802.11 upper layer to buffer broadcast and 818 * multicast frames when there are power saving stations so that 819 * the driver can fetch them with ieee80211_get_buffered_bc(). 820 * 821 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE: 822 * Hardware is not capable of short slot operation on the 2.4 GHz band. 823 * 824 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE: 825 * Hardware is not capable of receiving frames with short preamble on 826 * the 2.4 GHz band. 827 * 828 * @IEEE80211_HW_SIGNAL_UNSPEC: 829 * Hardware can provide signal values but we don't know its units. We 830 * expect values between 0 and @max_signal. 831 * If possible please provide dB or dBm instead. 832 * 833 * @IEEE80211_HW_SIGNAL_DB: 834 * Hardware gives signal values in dB, decibel difference from an 835 * arbitrary, fixed reference. We expect values between 0 and @max_signal. 836 * If possible please provide dBm instead. 837 * 838 * @IEEE80211_HW_SIGNAL_DBM: 839 * Hardware gives signal values in dBm, decibel difference from 840 * one milliwatt. This is the preferred method since it is standardized 841 * between different devices. @max_signal does not need to be set. 842 * 843 * @IEEE80211_HW_NOISE_DBM: 844 * Hardware can provide noise (radio interference) values in units dBm, 845 * decibel difference from one milliwatt. 846 * 847 * @IEEE80211_HW_SPECTRUM_MGMT: 848 * Hardware supports spectrum management defined in 802.11h 849 * Measurement, Channel Switch, Quieting, TPC 850 */ 851enum ieee80211_hw_flags { 852 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, 853 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, 854 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3, 855 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4, 856 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5, 857 IEEE80211_HW_SIGNAL_DB = 1<<6, 858 IEEE80211_HW_SIGNAL_DBM = 1<<7, 859 IEEE80211_HW_NOISE_DBM = 1<<8, 860 IEEE80211_HW_SPECTRUM_MGMT = 1<<9, 861}; 862 863/** 864 * struct ieee80211_hw - hardware information and state 865 * 866 * This structure contains the configuration and hardware 867 * information for an 802.11 PHY. 868 * 869 * @wiphy: This points to the &struct wiphy allocated for this 870 * 802.11 PHY. You must fill in the @perm_addr and @dev 871 * members of this structure using SET_IEEE80211_DEV() 872 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported 873 * bands (with channels, bitrates) are registered here. 874 * 875 * @conf: &struct ieee80211_conf, device configuration, don't use. 876 * 877 * @workqueue: single threaded workqueue available for driver use, 878 * allocated by mac80211 on registration and flushed when an 879 * interface is removed. 880 * NOTICE: All work performed on this workqueue should NEVER 881 * acquire the RTNL lock (i.e. Don't use the function 882 * ieee80211_iterate_active_interfaces()) 883 * 884 * @priv: pointer to private area that was allocated for driver use 885 * along with this structure. 886 * 887 * @flags: hardware flags, see &enum ieee80211_hw_flags. 888 * 889 * @extra_tx_headroom: headroom to reserve in each transmit skb 890 * for use by the driver (e.g. for transmit headers.) 891 * 892 * @channel_change_time: time (in microseconds) it takes to change channels. 893 * 894 * @max_signal: Maximum value for signal (rssi) in RX information, used 895 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB 896 * 897 * @max_listen_interval: max listen interval in units of beacon interval 898 * that HW supports 899 * 900 * @queues: number of available hardware transmit queues for 901 * data packets. WMM/QoS requires at least four, these 902 * queues need to have configurable access parameters. 903 * 904 * @ampdu_queues: number of available hardware transmit queues 905 * for A-MPDU packets, these have no access parameters 906 * because they're used only for A-MPDU frames. Note that 907 * mac80211 will not currently use any of the regular queues 908 * for aggregation. 909 * 910 * @rate_control_algorithm: rate control algorithm for this hardware. 911 * If unset (NULL), the default algorithm will be used. Must be 912 * set before calling ieee80211_register_hw(). 913 * 914 * @vif_data_size: size (in bytes) of the drv_priv data area 915 * within &struct ieee80211_vif. 916 * @sta_data_size: size (in bytes) of the drv_priv data area 917 * within &struct ieee80211_sta. 918 * 919 * @max_rates: maximum number of alternate rate retry stages 920 * @max_rate_tries: maximum number of tries for each stage 921 */ 922struct ieee80211_hw { 923 struct ieee80211_conf conf; 924 struct wiphy *wiphy; 925 struct workqueue_struct *workqueue; 926 const char *rate_control_algorithm; 927 void *priv; 928 u32 flags; 929 unsigned int extra_tx_headroom; 930 int channel_change_time; 931 int vif_data_size; 932 int sta_data_size; 933 u16 queues; 934 u16 ampdu_queues; 935 u16 max_listen_interval; 936 s8 max_signal; 937 u8 max_rates; 938 u8 max_rate_tries; 939}; 940 941/** 942 * SET_IEEE80211_DEV - set device for 802.11 hardware 943 * 944 * @hw: the &struct ieee80211_hw to set the device for 945 * @dev: the &struct device of this 802.11 device 946 */ 947static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 948{ 949 set_wiphy_dev(hw->wiphy, dev); 950} 951 952/** 953 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware 954 * 955 * @hw: the &struct ieee80211_hw to set the MAC address for 956 * @addr: the address to set 957 */ 958static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 959{ 960 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 961} 962 963static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw) 964{ 965 return hw->queues; 966} 967 968static inline int ieee80211_num_queues(struct ieee80211_hw *hw) 969{ 970 return hw->queues + hw->ampdu_queues; 971} 972 973static inline struct ieee80211_rate * 974ieee80211_get_tx_rate(const struct ieee80211_hw *hw, 975 const struct ieee80211_tx_info *c) 976{ 977 if (WARN_ON(c->control.rates[0].idx < 0)) 978 return NULL; 979 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx]; 980} 981 982static inline struct ieee80211_rate * 983ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw, 984 const struct ieee80211_tx_info *c) 985{ 986 if (c->control.rts_cts_rate_idx < 0) 987 return NULL; 988 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx]; 989} 990 991static inline struct ieee80211_rate * 992ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw, 993 const struct ieee80211_tx_info *c, int idx) 994{ 995 if (c->control.rates[idx + 1].idx < 0) 996 return NULL; 997 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx]; 998} 999 1000/** 1001 * DOC: Hardware crypto acceleration 1002 * 1003 * mac80211 is capable of taking advantage of many hardware 1004 * acceleration designs for encryption and decryption operations. 1005 * 1006 * The set_key() callback in the &struct ieee80211_ops for a given 1007 * device is called to enable hardware acceleration of encryption and 1008 * decryption. The callback takes an @address parameter that will be 1009 * the broadcast address for default keys, the other station's hardware 1010 * address for individual keys or the zero address for keys that will 1011 * be used only for transmission. 1012 * Multiple transmission keys with the same key index may be used when 1013 * VLANs are configured for an access point. 1014 * 1015 * The @local_address parameter will always be set to our own address, 1016 * this is only relevant if you support multiple local addresses. 1017 * 1018 * When transmitting, the TX control data will use the @hw_key_idx 1019 * selected by the driver by modifying the &struct ieee80211_key_conf 1020 * pointed to by the @key parameter to the set_key() function. 1021 * 1022 * The set_key() call for the %SET_KEY command should return 0 if 1023 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 1024 * added; if you return 0 then hw_key_idx must be assigned to the 1025 * hardware key index, you are free to use the full u8 range. 1026 * 1027 * When the cmd is %DISABLE_KEY then it must succeed. 1028 * 1029 * Note that it is permissible to not decrypt a frame even if a key 1030 * for it has been uploaded to hardware, the stack will not make any 1031 * decision based on whether a key has been uploaded or not but rather 1032 * based on the receive flags. 1033 * 1034 * The &struct ieee80211_key_conf structure pointed to by the @key 1035 * parameter is guaranteed to be valid until another call to set_key() 1036 * removes it, but it can only be used as a cookie to differentiate 1037 * keys. 1038 * 1039 * In TKIP some HW need to be provided a phase 1 key, for RX decryption 1040 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key 1041 * handler. 1042 * The update_tkip_key() call updates the driver with the new phase 1 key. 1043 * This happens everytime the iv16 wraps around (every 65536 packets). The 1044 * set_key() call will happen only once for each key (unless the AP did 1045 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is 1046 * provided by update_tkip_key only. The trigger that makes mac80211 call this 1047 * handler is software decryption with wrap around of iv16. 1048 */ 1049 1050/** 1051 * DOC: Frame filtering 1052 * 1053 * mac80211 requires to see many management frames for proper 1054 * operation, and users may want to see many more frames when 1055 * in monitor mode. However, for best CPU usage and power consumption, 1056 * having as few frames as possible percolate through the stack is 1057 * desirable. Hence, the hardware should filter as much as possible. 1058 * 1059 * To achieve this, mac80211 uses filter flags (see below) to tell 1060 * the driver's configure_filter() function which frames should be 1061 * passed to mac80211 and which should be filtered out. 1062 * 1063 * The configure_filter() callback is invoked with the parameters 1064 * @mc_count and @mc_list for the combined multicast address list 1065 * of all virtual interfaces, @changed_flags telling which flags 1066 * were changed and @total_flags with the new flag states. 1067 * 1068 * If your device has no multicast address filters your driver will 1069 * need to check both the %FIF_ALLMULTI flag and the @mc_count 1070 * parameter to see whether multicast frames should be accepted 1071 * or dropped. 1072 * 1073 * All unsupported flags in @total_flags must be cleared. 1074 * Hardware does not support a flag if it is incapable of _passing_ 1075 * the frame to the stack. Otherwise the driver must ignore 1076 * the flag, but not clear it. 1077 * You must _only_ clear the flag (announce no support for the 1078 * flag to mac80211) if you are not able to pass the packet type 1079 * to the stack (so the hardware always filters it). 1080 * So for example, you should clear @FIF_CONTROL, if your hardware 1081 * always filters control frames. If your hardware always passes 1082 * control frames to the kernel and is incapable of filtering them, 1083 * you do _not_ clear the @FIF_CONTROL flag. 1084 * This rule applies to all other FIF flags as well. 1085 */ 1086 1087/** 1088 * enum ieee80211_filter_flags - hardware filter flags 1089 * 1090 * These flags determine what the filter in hardware should be 1091 * programmed to let through and what should not be passed to the 1092 * stack. It is always safe to pass more frames than requested, 1093 * but this has negative impact on power consumption. 1094 * 1095 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, 1096 * think of the BSS as your network segment and then this corresponds 1097 * to the regular ethernet device promiscuous mode. 1098 * 1099 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 1100 * by the user or if the hardware is not capable of filtering by 1101 * multicast address. 1102 * 1103 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 1104 * %RX_FLAG_FAILED_FCS_CRC for them) 1105 * 1106 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 1107 * the %RX_FLAG_FAILED_PLCP_CRC for them 1108 * 1109 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 1110 * to the hardware that it should not filter beacons or probe responses 1111 * by BSSID. Filtering them can greatly reduce the amount of processing 1112 * mac80211 needs to do and the amount of CPU wakeups, so you should 1113 * honour this flag if possible. 1114 * 1115 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then 1116 * only those addressed to this station 1117 * 1118 * @FIF_OTHER_BSS: pass frames destined to other BSSes 1119 */ 1120enum ieee80211_filter_flags { 1121 FIF_PROMISC_IN_BSS = 1<<0, 1122 FIF_ALLMULTI = 1<<1, 1123 FIF_FCSFAIL = 1<<2, 1124 FIF_PLCPFAIL = 1<<3, 1125 FIF_BCN_PRBRESP_PROMISC = 1<<4, 1126 FIF_CONTROL = 1<<5, 1127 FIF_OTHER_BSS = 1<<6, 1128}; 1129 1130/** 1131 * enum ieee80211_ampdu_mlme_action - A-MPDU actions 1132 * 1133 * These flags are used with the ampdu_action() callback in 1134 * &struct ieee80211_ops to indicate which action is needed. 1135 * @IEEE80211_AMPDU_RX_START: start Rx aggregation 1136 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation 1137 * @IEEE80211_AMPDU_TX_START: start Tx aggregation 1138 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation 1139 */ 1140enum ieee80211_ampdu_mlme_action { 1141 IEEE80211_AMPDU_RX_START, 1142 IEEE80211_AMPDU_RX_STOP, 1143 IEEE80211_AMPDU_TX_START, 1144 IEEE80211_AMPDU_TX_STOP, 1145}; 1146 1147/** 1148 * struct ieee80211_ops - callbacks from mac80211 to the driver 1149 * 1150 * This structure contains various callbacks that the driver may 1151 * handle or, in some cases, must handle, for example to configure 1152 * the hardware to a new channel or to transmit a frame. 1153 * 1154 * @tx: Handler that 802.11 module calls for each transmitted frame. 1155 * skb contains the buffer starting from the IEEE 802.11 header. 1156 * The low-level driver should send the frame out based on 1157 * configuration in the TX control data. This handler should, 1158 * preferably, never fail and stop queues appropriately, more 1159 * importantly, however, it must never fail for A-MPDU-queues. 1160 * Must be implemented and atomic. 1161 * 1162 * @start: Called before the first netdevice attached to the hardware 1163 * is enabled. This should turn on the hardware and must turn on 1164 * frame reception (for possibly enabled monitor interfaces.) 1165 * Returns negative error codes, these may be seen in userspace, 1166 * or zero. 1167 * When the device is started it should not have a MAC address 1168 * to avoid acknowledging frames before a non-monitor device 1169 * is added. 1170 * Must be implemented. 1171 * 1172 * @stop: Called after last netdevice attached to the hardware 1173 * is disabled. This should turn off the hardware (at least 1174 * it must turn off frame reception.) 1175 * May be called right after add_interface if that rejects 1176 * an interface. 1177 * Must be implemented. 1178 * 1179 * @add_interface: Called when a netdevice attached to the hardware is 1180 * enabled. Because it is not called for monitor mode devices, @start 1181 * and @stop must be implemented. 1182 * The driver should perform any initialization it needs before 1183 * the device can be enabled. The initial configuration for the 1184 * interface is given in the conf parameter. 1185 * The callback may refuse to add an interface by returning a 1186 * negative error code (which will be seen in userspace.) 1187 * Must be implemented. 1188 * 1189 * @remove_interface: Notifies a driver that an interface is going down. 1190 * The @stop callback is called after this if it is the last interface 1191 * and no monitor interfaces are present. 1192 * When all interfaces are removed, the MAC address in the hardware 1193 * must be cleared so the device no longer acknowledges packets, 1194 * the mac_addr member of the conf structure is, however, set to the 1195 * MAC address of the device going away. 1196 * Hence, this callback must be implemented. 1197 * 1198 * @config: Handler for configuration requests. IEEE 802.11 code calls this 1199 * function to change hardware configuration, e.g., channel. 1200 * 1201 * @config_interface: Handler for configuration requests related to interfaces 1202 * (e.g. BSSID changes.) 1203 * 1204 * @bss_info_changed: Handler for configuration requests related to BSS 1205 * parameters that may vary during BSS's lifespan, and may affect low 1206 * level driver (e.g. assoc/disassoc status, erp parameters). 1207 * This function should not be used if no BSS has been set, unless 1208 * for association indication. The @changed parameter indicates which 1209 * of the bss parameters has changed when a call is made. 1210 * 1211 * @configure_filter: Configure the device's RX filter. 1212 * See the section "Frame filtering" for more information. 1213 * This callback must be implemented and atomic. 1214 * 1215 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit 1216 * must be set or cleared for a given STA. Must be atomic. 1217 * 1218 * @set_key: See the section "Hardware crypto acceleration" 1219 * This callback can sleep, and is only called between add_interface 1220 * and remove_interface calls, i.e. while the interface with the 1221 * given local_address is enabled. 1222 * 1223 * @update_tkip_key: See the section "Hardware crypto acceleration" 1224 * This callback will be called in the context of Rx. Called for drivers 1225 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY. 1226 * 1227 * @hw_scan: Ask the hardware to service the scan request, no need to start 1228 * the scan state machine in stack. The scan must honour the channel 1229 * configuration done by the regulatory agent in the wiphy's registered 1230 * bands. When the scan finishes, ieee80211_scan_completed() must be 1231 * called; note that it also must be called when the scan cannot finish 1232 * because the hardware is turned off! Anything else is a bug! 1233 * 1234 * @get_stats: return low-level statistics 1235 * 1236 * @get_tkip_seq: If your device implements TKIP encryption in hardware this 1237 * callback should be provided to read the TKIP transmit IVs (both IV32 1238 * and IV16) for the given key from hardware. 1239 * 1240 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 1241 * 1242 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if 1243 * the device does fragmentation by itself; if this method is assigned then 1244 * the stack will not do fragmentation. 1245 * 1246 * @sta_notify: Notifies low level driver about addition or removal 1247 * of associated station or AP. 1248 * 1249 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 1250 * bursting) for a hardware TX queue. 1251 * 1252 * @get_tx_stats: Get statistics of the current TX queue status. This is used 1253 * to get number of currently queued packets (queue length), maximum queue 1254 * size (limit), and total number of packets sent using each TX queue 1255 * (count). The 'stats' pointer points to an array that has hw->queues + 1256 * hw->ampdu_queues items. 1257 * 1258 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 1259 * this is only used for IBSS mode debugging and, as such, is not a 1260 * required function. Must be atomic. 1261 * 1262 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 1263 * with other STAs in the IBSS. This is only used in IBSS mode. This 1264 * function is optional if the firmware/hardware takes full care of 1265 * TSF synchronization. 1266 * 1267 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 1268 * This is needed only for IBSS mode and the result of this function is 1269 * used to determine whether to reply to Probe Requests. 1270 * 1271 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic. 1272 * 1273 * @ampdu_action: Perform a certain A-MPDU action 1274 * The RA/TID combination determines the destination and TID we want 1275 * the ampdu action to be performed for. The action is defined through 1276 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn) 1277 * is the first frame we expect to perform the action on. notice 1278 * that TX/RX_STOP can pass NULL for this parameter. 1279 */ 1280struct ieee80211_ops { 1281 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb); 1282 int (*start)(struct ieee80211_hw *hw); 1283 void (*stop)(struct ieee80211_hw *hw); 1284 int (*add_interface)(struct ieee80211_hw *hw, 1285 struct ieee80211_if_init_conf *conf); 1286 void (*remove_interface)(struct ieee80211_hw *hw, 1287 struct ieee80211_if_init_conf *conf); 1288 int (*config)(struct ieee80211_hw *hw, u32 changed); 1289 int (*config_interface)(struct ieee80211_hw *hw, 1290 struct ieee80211_vif *vif, 1291 struct ieee80211_if_conf *conf); 1292 void (*bss_info_changed)(struct ieee80211_hw *hw, 1293 struct ieee80211_vif *vif, 1294 struct ieee80211_bss_conf *info, 1295 u32 changed); 1296 void (*configure_filter)(struct ieee80211_hw *hw, 1297 unsigned int changed_flags, 1298 unsigned int *total_flags, 1299 int mc_count, struct dev_addr_list *mc_list); 1300 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 1301 bool set); 1302 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, 1303 const u8 *local_address, const u8 *address, 1304 struct ieee80211_key_conf *key); 1305 void (*update_tkip_key)(struct ieee80211_hw *hw, 1306 struct ieee80211_key_conf *conf, const u8 *address, 1307 u32 iv32, u16 *phase1key); 1308 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len); 1309 int (*get_stats)(struct ieee80211_hw *hw, 1310 struct ieee80211_low_level_stats *stats); 1311 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx, 1312 u32 *iv32, u16 *iv16); 1313 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 1314 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); 1315 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1316 enum sta_notify_cmd, struct ieee80211_sta *sta); 1317 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue, 1318 const struct ieee80211_tx_queue_params *params); 1319 int (*get_tx_stats)(struct ieee80211_hw *hw, 1320 struct ieee80211_tx_queue_stats *stats); 1321 u64 (*get_tsf)(struct ieee80211_hw *hw); 1322 void (*reset_tsf)(struct ieee80211_hw *hw); 1323 int (*tx_last_beacon)(struct ieee80211_hw *hw); 1324 int (*ampdu_action)(struct ieee80211_hw *hw, 1325 enum ieee80211_ampdu_mlme_action action, 1326 struct ieee80211_sta *sta, u16 tid, u16 *ssn); 1327}; 1328 1329/** 1330 * ieee80211_alloc_hw - Allocate a new hardware device 1331 * 1332 * This must be called once for each hardware device. The returned pointer 1333 * must be used to refer to this device when calling other functions. 1334 * mac80211 allocates a private data area for the driver pointed to by 1335 * @priv in &struct ieee80211_hw, the size of this area is given as 1336 * @priv_data_len. 1337 * 1338 * @priv_data_len: length of private data 1339 * @ops: callbacks for this device 1340 */ 1341struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 1342 const struct ieee80211_ops *ops); 1343 1344/** 1345 * ieee80211_register_hw - Register hardware device 1346 * 1347 * You must call this function before any other functions in 1348 * mac80211. Note that before a hardware can be registered, you 1349 * need to fill the contained wiphy's information. 1350 * 1351 * @hw: the device to register as returned by ieee80211_alloc_hw() 1352 */ 1353int ieee80211_register_hw(struct ieee80211_hw *hw); 1354 1355#ifdef CONFIG_MAC80211_LEDS 1356extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 1357extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 1358extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); 1359extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw); 1360#endif 1361/** 1362 * ieee80211_get_tx_led_name - get name of TX LED 1363 * 1364 * mac80211 creates a transmit LED trigger for each wireless hardware 1365 * that can be used to drive LEDs if your driver registers a LED device. 1366 * This function returns the name (or %NULL if not configured for LEDs) 1367 * of the trigger so you can automatically link the LED device. 1368 * 1369 * @hw: the hardware to get the LED trigger name for 1370 */ 1371static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 1372{ 1373#ifdef CONFIG_MAC80211_LEDS 1374 return __ieee80211_get_tx_led_name(hw); 1375#else 1376 return NULL; 1377#endif 1378} 1379 1380/** 1381 * ieee80211_get_rx_led_name - get name of RX LED 1382 * 1383 * mac80211 creates a receive LED trigger for each wireless hardware 1384 * that can be used to drive LEDs if your driver registers a LED device. 1385 * This function returns the name (or %NULL if not configured for LEDs) 1386 * of the trigger so you can automatically link the LED device. 1387 * 1388 * @hw: the hardware to get the LED trigger name for 1389 */ 1390static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 1391{ 1392#ifdef CONFIG_MAC80211_LEDS 1393 return __ieee80211_get_rx_led_name(hw); 1394#else 1395 return NULL; 1396#endif 1397} 1398 1399/** 1400 * ieee80211_get_assoc_led_name - get name of association LED 1401 * 1402 * mac80211 creates a association LED trigger for each wireless hardware 1403 * that can be used to drive LEDs if your driver registers a LED device. 1404 * This function returns the name (or %NULL if not configured for LEDs) 1405 * of the trigger so you can automatically link the LED device. 1406 * 1407 * @hw: the hardware to get the LED trigger name for 1408 */ 1409static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) 1410{ 1411#ifdef CONFIG_MAC80211_LEDS 1412 return __ieee80211_get_assoc_led_name(hw); 1413#else 1414 return NULL; 1415#endif 1416} 1417 1418/** 1419 * ieee80211_get_radio_led_name - get name of radio LED 1420 * 1421 * mac80211 creates a radio change LED trigger for each wireless hardware 1422 * that can be used to drive LEDs if your driver registers a LED device. 1423 * This function returns the name (or %NULL if not configured for LEDs) 1424 * of the trigger so you can automatically link the LED device. 1425 * 1426 * @hw: the hardware to get the LED trigger name for 1427 */ 1428static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) 1429{ 1430#ifdef CONFIG_MAC80211_LEDS 1431 return __ieee80211_get_radio_led_name(hw); 1432#else 1433 return NULL; 1434#endif 1435} 1436 1437/** 1438 * ieee80211_unregister_hw - Unregister a hardware device 1439 * 1440 * This function instructs mac80211 to free allocated resources 1441 * and unregister netdevices from the networking subsystem. 1442 * 1443 * @hw: the hardware to unregister 1444 */ 1445void ieee80211_unregister_hw(struct ieee80211_hw *hw); 1446 1447/** 1448 * ieee80211_free_hw - free hardware descriptor 1449 * 1450 * This function frees everything that was allocated, including the 1451 * private data for the driver. You must call ieee80211_unregister_hw() 1452 * before calling this function. 1453 * 1454 * @hw: the hardware to free 1455 */ 1456void ieee80211_free_hw(struct ieee80211_hw *hw); 1457 1458/* trick to avoid symbol clashes with the ieee80211 subsystem */ 1459void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1460 struct ieee80211_rx_status *status); 1461 1462/** 1463 * ieee80211_rx - receive frame 1464 * 1465 * Use this function to hand received frames to mac80211. The receive 1466 * buffer in @skb must start with an IEEE 802.11 header or a radiotap 1467 * header if %RX_FLAG_RADIOTAP is set in the @status flags. 1468 * 1469 * This function may not be called in IRQ context. Calls to this function 1470 * for a single hardware must be synchronized against each other. Calls 1471 * to this function and ieee80211_rx_irqsafe() may not be mixed for a 1472 * single hardware. 1473 * 1474 * @hw: the hardware this frame came in on 1475 * @skb: the buffer to receive, owned by mac80211 after this call 1476 * @status: status of this frame; the status pointer need not be valid 1477 * after this function returns 1478 */ 1479static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1480 struct ieee80211_rx_status *status) 1481{ 1482 __ieee80211_rx(hw, skb, status); 1483} 1484 1485/** 1486 * ieee80211_rx_irqsafe - receive frame 1487 * 1488 * Like ieee80211_rx() but can be called in IRQ context 1489 * (internally defers to a tasklet.) 1490 * 1491 * Calls to this function and ieee80211_rx() may not be mixed for a 1492 * single hardware. 1493 * 1494 * @hw: the hardware this frame came in on 1495 * @skb: the buffer to receive, owned by mac80211 after this call 1496 * @status: status of this frame; the status pointer need not be valid 1497 * after this function returns and is not freed by mac80211, 1498 * it is recommended that it points to a stack area 1499 */ 1500void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, 1501 struct sk_buff *skb, 1502 struct ieee80211_rx_status *status); 1503 1504/** 1505 * ieee80211_tx_status - transmit status callback 1506 * 1507 * Call this function for all transmitted frames after they have been 1508 * transmitted. It is permissible to not call this function for 1509 * multicast frames but this can affect statistics. 1510 * 1511 * This function may not be called in IRQ context. Calls to this function 1512 * for a single hardware must be synchronized against each other. Calls 1513 * to this function and ieee80211_tx_status_irqsafe() may not be mixed 1514 * for a single hardware. 1515 * 1516 * @hw: the hardware the frame was transmitted by 1517 * @skb: the frame that was transmitted, owned by mac80211 after this call 1518 */ 1519void ieee80211_tx_status(struct ieee80211_hw *hw, 1520 struct sk_buff *skb); 1521 1522/** 1523 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback 1524 * 1525 * Like ieee80211_tx_status() but can be called in IRQ context 1526 * (internally defers to a tasklet.) 1527 * 1528 * Calls to this function and ieee80211_tx_status() may not be mixed for a 1529 * single hardware. 1530 * 1531 * @hw: the hardware the frame was transmitted by 1532 * @skb: the frame that was transmitted, owned by mac80211 after this call 1533 */ 1534void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 1535 struct sk_buff *skb); 1536 1537/** 1538 * ieee80211_beacon_get - beacon generation function 1539 * @hw: pointer obtained from ieee80211_alloc_hw(). 1540 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1541 * 1542 * If the beacon frames are generated by the host system (i.e., not in 1543 * hardware/firmware), the low-level driver uses this function to receive 1544 * the next beacon frame from the 802.11 code. The low-level is responsible 1545 * for calling this function before beacon data is needed (e.g., based on 1546 * hardware interrupt). Returned skb is used only once and low-level driver 1547 * is responsible for freeing it. 1548 */ 1549struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 1550 struct ieee80211_vif *vif); 1551 1552/** 1553 * ieee80211_rts_get - RTS frame generation function 1554 * @hw: pointer obtained from ieee80211_alloc_hw(). 1555 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1556 * @frame: pointer to the frame that is going to be protected by the RTS. 1557 * @frame_len: the frame length (in octets). 1558 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1559 * @rts: The buffer where to store the RTS frame. 1560 * 1561 * If the RTS frames are generated by the host system (i.e., not in 1562 * hardware/firmware), the low-level driver uses this function to receive 1563 * the next RTS frame from the 802.11 code. The low-level is responsible 1564 * for calling this function before and RTS frame is needed. 1565 */ 1566void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1567 const void *frame, size_t frame_len, 1568 const struct ieee80211_tx_info *frame_txctl, 1569 struct ieee80211_rts *rts); 1570 1571/** 1572 * ieee80211_rts_duration - Get the duration field for an RTS frame 1573 * @hw: pointer obtained from ieee80211_alloc_hw(). 1574 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1575 * @frame_len: the length of the frame that is going to be protected by the RTS. 1576 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1577 * 1578 * If the RTS is generated in firmware, but the host system must provide 1579 * the duration field, the low-level driver uses this function to receive 1580 * the duration field value in little-endian byteorder. 1581 */ 1582__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, 1583 struct ieee80211_vif *vif, size_t frame_len, 1584 const struct ieee80211_tx_info *frame_txctl); 1585 1586/** 1587 * ieee80211_ctstoself_get - CTS-to-self frame generation function 1588 * @hw: pointer obtained from ieee80211_alloc_hw(). 1589 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1590 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 1591 * @frame_len: the frame length (in octets). 1592 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1593 * @cts: The buffer where to store the CTS-to-self frame. 1594 * 1595 * If the CTS-to-self frames are generated by the host system (i.e., not in 1596 * hardware/firmware), the low-level driver uses this function to receive 1597 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 1598 * for calling this function before and CTS-to-self frame is needed. 1599 */ 1600void ieee80211_ctstoself_get(struct ieee80211_hw *hw, 1601 struct ieee80211_vif *vif, 1602 const void *frame, size_t frame_len, 1603 const struct ieee80211_tx_info *frame_txctl, 1604 struct ieee80211_cts *cts); 1605 1606/** 1607 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 1608 * @hw: pointer obtained from ieee80211_alloc_hw(). 1609 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1610 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 1611 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1612 * 1613 * If the CTS-to-self is generated in firmware, but the host system must provide 1614 * the duration field, the low-level driver uses this function to receive 1615 * the duration field value in little-endian byteorder. 1616 */ 1617__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, 1618 struct ieee80211_vif *vif, 1619 size_t frame_len, 1620 const struct ieee80211_tx_info *frame_txctl); 1621 1622/** 1623 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 1624 * @hw: pointer obtained from ieee80211_alloc_hw(). 1625 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1626 * @frame_len: the length of the frame. 1627 * @rate: the rate at which the frame is going to be transmitted. 1628 * 1629 * Calculate the duration field of some generic frame, given its 1630 * length and transmission rate (in 100kbps). 1631 */ 1632__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, 1633 struct ieee80211_vif *vif, 1634 size_t frame_len, 1635 struct ieee80211_rate *rate); 1636 1637/** 1638 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 1639 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1640 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1641 * 1642 * Function for accessing buffered broadcast and multicast frames. If 1643 * hardware/firmware does not implement buffering of broadcast/multicast 1644 * frames when power saving is used, 802.11 code buffers them in the host 1645 * memory. The low-level driver uses this function to fetch next buffered 1646 * frame. In most cases, this is used when generating beacon frame. This 1647 * function returns a pointer to the next buffered skb or NULL if no more 1648 * buffered frames are available. 1649 * 1650 * Note: buffered frames are returned only after DTIM beacon frame was 1651 * generated with ieee80211_beacon_get() and the low-level driver must thus 1652 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 1653 * NULL if the previous generated beacon was not DTIM, so the low-level driver 1654 * does not need to check for DTIM beacons separately and should be able to 1655 * use common code for all beacons. 1656 */ 1657struct sk_buff * 1658ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 1659 1660/** 1661 * ieee80211_get_hdrlen_from_skb - get header length from data 1662 * 1663 * Given an skb with a raw 802.11 header at the data pointer this function 1664 * returns the 802.11 header length in bytes (not including encryption 1665 * headers). If the data in the sk_buff is too short to contain a valid 802.11 1666 * header the function returns 0. 1667 * 1668 * @skb: the frame 1669 */ 1670unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); 1671 1672/** 1673 * ieee80211_hdrlen - get header length in bytes from frame control 1674 * @fc: frame control field in little-endian format 1675 */ 1676unsigned int ieee80211_hdrlen(__le16 fc); 1677 1678/** 1679 * ieee80211_get_tkip_key - get a TKIP rc4 for skb 1680 * 1681 * This function computes a TKIP rc4 key for an skb. It computes 1682 * a phase 1 key if needed (iv16 wraps around). This function is to 1683 * be used by drivers which can do HW encryption but need to compute 1684 * to phase 1/2 key in SW. 1685 * 1686 * @keyconf: the parameter passed with the set key 1687 * @skb: the skb for which the key is needed 1688 * @type: TBD 1689 * @key: a buffer to which the key will be written 1690 */ 1691void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf, 1692 struct sk_buff *skb, 1693 enum ieee80211_tkip_key_type type, u8 *key); 1694/** 1695 * ieee80211_wake_queue - wake specific queue 1696 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1697 * @queue: queue number (counted from zero). 1698 * 1699 * Drivers should use this function instead of netif_wake_queue. 1700 */ 1701void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 1702 1703/** 1704 * ieee80211_stop_queue - stop specific queue 1705 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1706 * @queue: queue number (counted from zero). 1707 * 1708 * Drivers should use this function instead of netif_stop_queue. 1709 */ 1710void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 1711 1712/** 1713 * ieee80211_queue_stopped - test status of the queue 1714 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1715 * @queue: queue number (counted from zero). 1716 * 1717 * Drivers should use this function instead of netif_stop_queue. 1718 */ 1719 1720int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); 1721 1722/** 1723 * ieee80211_stop_queues - stop all queues 1724 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1725 * 1726 * Drivers should use this function instead of netif_stop_queue. 1727 */ 1728void ieee80211_stop_queues(struct ieee80211_hw *hw); 1729 1730/** 1731 * ieee80211_wake_queues - wake all queues 1732 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1733 * 1734 * Drivers should use this function instead of netif_wake_queue. 1735 */ 1736void ieee80211_wake_queues(struct ieee80211_hw *hw); 1737 1738/** 1739 * ieee80211_scan_completed - completed hardware scan 1740 * 1741 * When hardware scan offload is used (i.e. the hw_scan() callback is 1742 * assigned) this function needs to be called by the driver to notify 1743 * mac80211 that the scan finished. 1744 * 1745 * @hw: the hardware that finished the scan 1746 */ 1747void ieee80211_scan_completed(struct ieee80211_hw *hw); 1748 1749/** 1750 * ieee80211_iterate_active_interfaces - iterate active interfaces 1751 * 1752 * This function iterates over the interfaces associated with a given 1753 * hardware that are currently active and calls the callback for them. 1754 * This function allows the iterator function to sleep, when the iterator 1755 * function is atomic @ieee80211_iterate_active_interfaces_atomic can 1756 * be used. 1757 * 1758 * @hw: the hardware struct of which the interfaces should be iterated over 1759 * @iterator: the iterator function to call 1760 * @data: first argument of the iterator function 1761 */ 1762void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, 1763 void (*iterator)(void *data, u8 *mac, 1764 struct ieee80211_vif *vif), 1765 void *data); 1766 1767/** 1768 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces 1769 * 1770 * This function iterates over the interfaces associated with a given 1771 * hardware that are currently active and calls the callback for them. 1772 * This function requires the iterator callback function to be atomic, 1773 * if that is not desired, use @ieee80211_iterate_active_interfaces instead. 1774 * 1775 * @hw: the hardware struct of which the interfaces should be iterated over 1776 * @iterator: the iterator function to call, cannot sleep 1777 * @data: first argument of the iterator function 1778 */ 1779void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw, 1780 void (*iterator)(void *data, 1781 u8 *mac, 1782 struct ieee80211_vif *vif), 1783 void *data); 1784 1785/** 1786 * ieee80211_start_tx_ba_session - Start a tx Block Ack session. 1787 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1788 * @ra: receiver address of the BA session recipient 1789 * @tid: the TID to BA on. 1790 * 1791 * Return: success if addBA request was sent, failure otherwise 1792 * 1793 * Although mac80211/low level driver/user space application can estimate 1794 * the need to start aggregation on a certain RA/TID, the session level 1795 * will be managed by the mac80211. 1796 */ 1797int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid); 1798 1799/** 1800 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate. 1801 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1802 * @ra: receiver address of the BA session recipient. 1803 * @tid: the TID to BA on. 1804 * 1805 * This function must be called by low level driver once it has 1806 * finished with preparations for the BA session. 1807 */ 1808void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid); 1809 1810/** 1811 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate. 1812 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1813 * @ra: receiver address of the BA session recipient. 1814 * @tid: the TID to BA on. 1815 * 1816 * This function must be called by low level driver once it has 1817 * finished with preparations for the BA session. 1818 * This version of the function is IRQ-safe. 1819 */ 1820void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra, 1821 u16 tid); 1822 1823/** 1824 * ieee80211_stop_tx_ba_session - Stop a Block Ack session. 1825 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1826 * @ra: receiver address of the BA session recipient 1827 * @tid: the TID to stop BA. 1828 * @initiator: if indicates initiator DELBA frame will be sent. 1829 * 1830 * Return: error if no sta with matching da found, success otherwise 1831 * 1832 * Although mac80211/low level driver/user space application can estimate 1833 * the need to stop aggregation on a certain RA/TID, the session level 1834 * will be managed by the mac80211. 1835 */ 1836int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw, 1837 u8 *ra, u16 tid, 1838 enum ieee80211_back_parties initiator); 1839 1840/** 1841 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate. 1842 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1843 * @ra: receiver address of the BA session recipient. 1844 * @tid: the desired TID to BA on. 1845 * 1846 * This function must be called by low level driver once it has 1847 * finished with preparations for the BA session tear down. 1848 */ 1849void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid); 1850 1851/** 1852 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate. 1853 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1854 * @ra: receiver address of the BA session recipient. 1855 * @tid: the desired TID to BA on. 1856 * 1857 * This function must be called by low level driver once it has 1858 * finished with preparations for the BA session tear down. 1859 * This version of the function is IRQ-safe. 1860 */ 1861void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra, 1862 u16 tid); 1863 1864/** 1865 * ieee80211_notify_mac - low level driver notification 1866 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1867 * @notif_type: enum ieee80211_notification_types 1868 * 1869 * This function must be called by low level driver to inform mac80211 of 1870 * low level driver status change or force mac80211 to re-assoc for low 1871 * level driver internal error that require re-assoc. 1872 */ 1873void ieee80211_notify_mac(struct ieee80211_hw *hw, 1874 enum ieee80211_notification_types notif_type); 1875 1876/** 1877 * ieee80211_find_sta - find a station 1878 * 1879 * @hw: pointer as obtained from ieee80211_alloc_hw() 1880 * @addr: station's address 1881 * 1882 * This function must be called under RCU lock and the 1883 * resulting pointer is only valid under RCU lock as well. 1884 */ 1885struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw, 1886 const u8 *addr); 1887 1888 1889/* Rate control API */ 1890 1891/** 1892 * struct ieee80211_tx_rate_control - rate control information for/from RC algo 1893 * 1894 * @hw: The hardware the algorithm is invoked for. 1895 * @sband: The band this frame is being transmitted on. 1896 * @bss_conf: the current BSS configuration 1897 * @reported_rate: The rate control algorithm can fill this in to indicate 1898 * which rate should be reported to userspace as the current rate and 1899 * used for rate calculations in the mesh network. 1900 * @rts: whether RTS will be used for this frame because it is longer than the 1901 * RTS threshold 1902 * @short_preamble: whether mac80211 will request short-preamble transmission 1903 * if the selected rate supports it 1904 * @max_rate_idx: user-requested maximum rate (not MCS for now) 1905 */ 1906struct ieee80211_tx_rate_control { 1907 struct ieee80211_hw *hw; 1908 struct ieee80211_supported_band *sband; 1909 struct ieee80211_bss_conf *bss_conf; 1910 struct sk_buff *skb; 1911 struct ieee80211_tx_rate reported_rate; 1912 bool rts, short_preamble; 1913 u8 max_rate_idx; 1914}; 1915 1916struct rate_control_ops { 1917 struct module *module; 1918 const char *name; 1919 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir); 1920 void (*free)(void *priv); 1921 1922 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp); 1923 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband, 1924 struct ieee80211_sta *sta, void *priv_sta); 1925 void (*free_sta)(void *priv, struct ieee80211_sta *sta, 1926 void *priv_sta); 1927 1928 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband, 1929 struct ieee80211_sta *sta, void *priv_sta, 1930 struct sk_buff *skb); 1931 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta, 1932 struct ieee80211_tx_rate_control *txrc); 1933 1934 void (*add_sta_debugfs)(void *priv, void *priv_sta, 1935 struct dentry *dir); 1936 void (*remove_sta_debugfs)(void *priv, void *priv_sta); 1937}; 1938 1939static inline int rate_supported(struct ieee80211_sta *sta, 1940 enum ieee80211_band band, 1941 int index) 1942{ 1943 return (sta == NULL || sta->supp_rates[band] & BIT(index)); 1944} 1945 1946static inline s8 1947rate_lowest_index(struct ieee80211_supported_band *sband, 1948 struct ieee80211_sta *sta) 1949{ 1950 int i; 1951 1952 for (i = 0; i < sband->n_bitrates; i++) 1953 if (rate_supported(sta, sband->band, i)) 1954 return i; 1955 1956 /* warn when we cannot find a rate. */ 1957 WARN_ON(1); 1958 1959 return 0; 1960} 1961 1962 1963int ieee80211_rate_control_register(struct rate_control_ops *ops); 1964void ieee80211_rate_control_unregister(struct rate_control_ops *ops); 1965 1966#endif /* MAC80211_H */ 1967