mac80211.h revision e1781ed33a8809c58ad6c3b6d432d656446efa43
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/cfg80211.h> 23 24/** 25 * DOC: Introduction 26 * 27 * mac80211 is the Linux stack for 802.11 hardware that implements 28 * only partial functionality in hard- or firmware. This document 29 * defines the interface between mac80211 and low-level hardware 30 * drivers. 31 */ 32 33/** 34 * DOC: Calling mac80211 from interrupts 35 * 36 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be 37 * called in hardware interrupt context. The low-level driver must not call any 38 * other functions in hardware interrupt context. If there is a need for such 39 * call, the low-level driver should first ACK the interrupt and perform the 40 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even 41 * tasklet function. 42 * 43 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also 44 * use the non-IRQ-safe functions! 45 */ 46 47/** 48 * DOC: Warning 49 * 50 * If you're reading this document and not the header file itself, it will 51 * be incomplete because not all documentation has been converted yet. 52 */ 53 54/** 55 * DOC: Frame format 56 * 57 * As a general rule, when frames are passed between mac80211 and the driver, 58 * they start with the IEEE 802.11 header and include the same octets that are 59 * sent over the air except for the FCS which should be calculated by the 60 * hardware. 61 * 62 * There are, however, various exceptions to this rule for advanced features: 63 * 64 * The first exception is for hardware encryption and decryption offload 65 * where the IV/ICV may or may not be generated in hardware. 66 * 67 * Secondly, when the hardware handles fragmentation, the frame handed to 68 * the driver from mac80211 is the MSDU, not the MPDU. 69 * 70 * Finally, for received frames, the driver is able to indicate that it has 71 * filled a radiotap header and put that in front of the frame; if it does 72 * not do so then mac80211 may add this under certain circumstances. 73 */ 74 75/** 76 * DOC: mac80211 workqueue 77 * 78 * mac80211 provides its own workqueue for drivers and internal mac80211 use. 79 * The workqueue is a single threaded workqueue and can only be accessed by 80 * helpers for sanity checking. Drivers must ensure all work added onto the 81 * mac80211 workqueue should be cancelled on the driver stop() callback. 82 * 83 * mac80211 will flushed the workqueue upon interface removal and during 84 * suspend. 85 * 86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock. 87 * 88 */ 89 90/** 91 * enum ieee80211_max_queues - maximum number of queues 92 * 93 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues. 94 */ 95enum ieee80211_max_queues { 96 IEEE80211_MAX_QUEUES = 4, 97}; 98 99/** 100 * struct ieee80211_tx_queue_params - transmit queue configuration 101 * 102 * The information provided in this structure is required for QoS 103 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29. 104 * 105 * @aifs: arbitration interframe space [0..255] 106 * @cw_min: minimum contention window [a value of the form 107 * 2^n-1 in the range 1..32767] 108 * @cw_max: maximum contention window [like @cw_min] 109 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled 110 */ 111struct ieee80211_tx_queue_params { 112 u16 txop; 113 u16 cw_min; 114 u16 cw_max; 115 u8 aifs; 116}; 117 118/** 119 * struct ieee80211_tx_queue_stats - transmit queue statistics 120 * 121 * @len: number of packets in queue 122 * @limit: queue length limit 123 * @count: number of frames sent 124 */ 125struct ieee80211_tx_queue_stats { 126 unsigned int len; 127 unsigned int limit; 128 unsigned int count; 129}; 130 131struct ieee80211_low_level_stats { 132 unsigned int dot11ACKFailureCount; 133 unsigned int dot11RTSFailureCount; 134 unsigned int dot11FCSErrorCount; 135 unsigned int dot11RTSSuccessCount; 136}; 137 138/** 139 * enum ieee80211_bss_change - BSS change notification flags 140 * 141 * These flags are used with the bss_info_changed() callback 142 * to indicate which BSS parameter changed. 143 * 144 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated), 145 * also implies a change in the AID. 146 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed 147 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed 148 * @BSS_CHANGED_ERP_SLOT: slot timing changed 149 * @BSS_CHANGED_HT: 802.11n parameters changed 150 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed 151 * @BSS_CHANGED_BEACON_INT: Beacon interval changed 152 * @BSS_CHANGED_BSSID: BSSID changed, for whatever 153 * reason (IBSS and managed mode) 154 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve 155 * new beacon (beaconing modes) 156 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be 157 * enabled/disabled (beaconing modes) 158 */ 159enum ieee80211_bss_change { 160 BSS_CHANGED_ASSOC = 1<<0, 161 BSS_CHANGED_ERP_CTS_PROT = 1<<1, 162 BSS_CHANGED_ERP_PREAMBLE = 1<<2, 163 BSS_CHANGED_ERP_SLOT = 1<<3, 164 BSS_CHANGED_HT = 1<<4, 165 BSS_CHANGED_BASIC_RATES = 1<<5, 166 BSS_CHANGED_BEACON_INT = 1<<6, 167 BSS_CHANGED_BSSID = 1<<7, 168 BSS_CHANGED_BEACON = 1<<8, 169 BSS_CHANGED_BEACON_ENABLED = 1<<9, 170}; 171 172/** 173 * struct ieee80211_bss_conf - holds the BSS's changing parameters 174 * 175 * This structure keeps information about a BSS (and an association 176 * to that BSS) that can change during the lifetime of the BSS. 177 * 178 * @assoc: association status 179 * @aid: association ID number, valid only when @assoc is true 180 * @use_cts_prot: use CTS protection 181 * @use_short_preamble: use 802.11b short preamble; 182 * if the hardware cannot handle this it must set the 183 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag 184 * @use_short_slot: use short slot time (only relevant for ERP); 185 * if the hardware cannot handle this it must set the 186 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag 187 * @dtim_period: num of beacons before the next DTIM, for PSM 188 * @timestamp: beacon timestamp 189 * @beacon_int: beacon interval 190 * @assoc_capability: capabilities taken from assoc resp 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 * @bssid: The BSSID for this BSS 195 * @enable_beacon: whether beaconing should be enabled or not 196 * @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info). 197 * This field is only valid when the channel type is one of the HT types. 198 */ 199struct ieee80211_bss_conf { 200 const u8 *bssid; 201 /* association related data */ 202 bool assoc; 203 u16 aid; 204 /* erp related data */ 205 bool use_cts_prot; 206 bool use_short_preamble; 207 bool use_short_slot; 208 bool enable_beacon; 209 u8 dtim_period; 210 u16 beacon_int; 211 u16 assoc_capability; 212 u64 timestamp; 213 u32 basic_rates; 214 u16 ht_operation_mode; 215}; 216 217/** 218 * enum mac80211_tx_control_flags - flags to describe transmission information/status 219 * 220 * These flags are used with the @flags member of &ieee80211_tx_info. 221 * 222 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame. 223 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence 224 * number to this frame, taking care of not overwriting the fragment 225 * number and increasing the sequence number only when the 226 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly 227 * assign sequence numbers to QoS-data frames but cannot do so correctly 228 * for non-QoS-data and management frames because beacons need them from 229 * that counter as well and mac80211 cannot guarantee proper sequencing. 230 * If this flag is set, the driver should instruct the hardware to 231 * assign a sequence number to the frame or assign one itself. Cf. IEEE 232 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for 233 * beacons and always be clear for frames without a sequence number field. 234 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack 235 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination 236 * station 237 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame 238 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon 239 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU 240 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211. 241 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted 242 * because the destination STA was in powersave mode. Note that to 243 * avoid race conditions, the filter must be set by the hardware or 244 * firmware upon receiving a frame that indicates that the station 245 * went to sleep (must be done on device to filter frames already on 246 * the queue) and may only be unset after mac80211 gives the OK for 247 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above), 248 * since only then is it guaranteed that no more frames are in the 249 * hardware queue. 250 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged 251 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status 252 * is for the whole aggregation. 253 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned, 254 * so consider using block ack request (BAR). 255 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be 256 * set by rate control algorithms to indicate probe rate, will 257 * be cleared for fragmented frames (except on the last fragment) 258 * @IEEE80211_TX_INTFL_RCALGO: mac80211 internal flag, do not test or 259 * set this flag in the driver; indicates that the rate control 260 * algorithm was used and should be notified of TX status 261 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211, 262 * used to indicate that a pending frame requires TX processing before 263 * it can be sent out. 264 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211, 265 * used to indicate that a frame was already retried due to PS 266 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211, 267 * used to indicate frame should not be encrypted 268 * @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?) 269 * This frame is a response to a PS-poll frame and should be sent 270 * although the station is in powersave mode. 271 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the 272 * transmit function after the current frame, this can be used 273 * by drivers to kick the DMA queue only if unset or when the 274 * queue gets full. 275 */ 276enum mac80211_tx_control_flags { 277 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0), 278 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1), 279 IEEE80211_TX_CTL_NO_ACK = BIT(2), 280 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3), 281 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4), 282 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5), 283 IEEE80211_TX_CTL_AMPDU = BIT(6), 284 IEEE80211_TX_CTL_INJECTED = BIT(7), 285 IEEE80211_TX_STAT_TX_FILTERED = BIT(8), 286 IEEE80211_TX_STAT_ACK = BIT(9), 287 IEEE80211_TX_STAT_AMPDU = BIT(10), 288 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11), 289 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12), 290 IEEE80211_TX_INTFL_RCALGO = BIT(13), 291 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14), 292 IEEE80211_TX_INTFL_RETRIED = BIT(15), 293 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16), 294 IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17), 295 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18), 296}; 297 298/** 299 * enum mac80211_rate_control_flags - per-rate flags set by the 300 * Rate Control algorithm. 301 * 302 * These flags are set by the Rate control algorithm for each rate during tx, 303 * in the @flags member of struct ieee80211_tx_rate. 304 * 305 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate. 306 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required. 307 * This is set if the current BSS requires ERP protection. 308 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble. 309 * @IEEE80211_TX_RC_MCS: HT rate. 310 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in 311 * Greenfield mode. 312 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz. 313 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the 314 * adjacent 20 MHz channels, if the current channel type is 315 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS. 316 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate. 317 */ 318enum mac80211_rate_control_flags { 319 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0), 320 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1), 321 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2), 322 323 /* rate index is an MCS rate number instead of an index */ 324 IEEE80211_TX_RC_MCS = BIT(3), 325 IEEE80211_TX_RC_GREEN_FIELD = BIT(4), 326 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5), 327 IEEE80211_TX_RC_DUP_DATA = BIT(6), 328 IEEE80211_TX_RC_SHORT_GI = BIT(7), 329}; 330 331 332/* there are 40 bytes if you don't need the rateset to be kept */ 333#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40 334 335/* if you do need the rateset, then you have less space */ 336#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24 337 338/* maximum number of rate stages */ 339#define IEEE80211_TX_MAX_RATES 5 340 341/** 342 * struct ieee80211_tx_rate - rate selection/status 343 * 344 * @idx: rate index to attempt to send with 345 * @flags: rate control flags (&enum mac80211_rate_control_flags) 346 * @count: number of tries in this rate before going to the next rate 347 * 348 * A value of -1 for @idx indicates an invalid rate and, if used 349 * in an array of retry rates, that no more rates should be tried. 350 * 351 * When used for transmit status reporting, the driver should 352 * always report the rate along with the flags it used. 353 * 354 * &struct ieee80211_tx_info contains an array of these structs 355 * in the control information, and it will be filled by the rate 356 * control algorithm according to what should be sent. For example, 357 * if this array contains, in the format { <idx>, <count> } the 358 * information 359 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 } 360 * then this means that the frame should be transmitted 361 * up to twice at rate 3, up to twice at rate 2, and up to four 362 * times at rate 1 if it doesn't get acknowledged. Say it gets 363 * acknowledged by the peer after the fifth attempt, the status 364 * information should then contain 365 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ... 366 * since it was transmitted twice at rate 3, twice at rate 2 367 * and once at rate 1 after which we received an acknowledgement. 368 */ 369struct ieee80211_tx_rate { 370 s8 idx; 371 u8 count; 372 u8 flags; 373} __attribute__((packed)); 374 375/** 376 * struct ieee80211_tx_info - skb transmit information 377 * 378 * This structure is placed in skb->cb for three uses: 379 * (1) mac80211 TX control - mac80211 tells the driver what to do 380 * (2) driver internal use (if applicable) 381 * (3) TX status information - driver tells mac80211 what happened 382 * 383 * The TX control's sta pointer is only valid during the ->tx call, 384 * it may be NULL. 385 * 386 * @flags: transmit info flags, defined above 387 * @band: the band to transmit on (use for checking for races) 388 * @antenna_sel_tx: antenna to use, 0 for automatic diversity 389 * @pad: padding, ignore 390 * @control: union for control data 391 * @status: union for status data 392 * @driver_data: array of driver_data pointers 393 * @ampdu_ack_len: number of acked aggregated frames. 394 * relevant only if IEEE80211_TX_STATUS_AMPDU was set. 395 * @ampdu_ack_map: block ack bit map for the aggregation. 396 * relevant only if IEEE80211_TX_STATUS_AMPDU was set. 397 * @ampdu_len: number of aggregated frames. 398 * relevant only if IEEE80211_TX_STATUS_AMPDU was set. 399 * @ack_signal: signal strength of the ACK frame 400 */ 401struct ieee80211_tx_info { 402 /* common information */ 403 u32 flags; 404 u8 band; 405 406 u8 antenna_sel_tx; 407 408 /* 2 byte hole */ 409 u8 pad[2]; 410 411 union { 412 struct { 413 union { 414 /* rate control */ 415 struct { 416 struct ieee80211_tx_rate rates[ 417 IEEE80211_TX_MAX_RATES]; 418 s8 rts_cts_rate_idx; 419 }; 420 /* only needed before rate control */ 421 unsigned long jiffies; 422 }; 423 /* NB: vif can be NULL for injected frames */ 424 struct ieee80211_vif *vif; 425 struct ieee80211_key_conf *hw_key; 426 struct ieee80211_sta *sta; 427 } control; 428 struct { 429 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES]; 430 u8 ampdu_ack_len; 431 u64 ampdu_ack_map; 432 int ack_signal; 433 u8 ampdu_len; 434 /* 7 bytes free */ 435 } status; 436 struct { 437 struct ieee80211_tx_rate driver_rates[ 438 IEEE80211_TX_MAX_RATES]; 439 void *rate_driver_data[ 440 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)]; 441 }; 442 void *driver_data[ 443 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)]; 444 }; 445}; 446 447static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb) 448{ 449 return (struct ieee80211_tx_info *)skb->cb; 450} 451 452static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb) 453{ 454 return (struct ieee80211_rx_status *)skb->cb; 455} 456 457/** 458 * ieee80211_tx_info_clear_status - clear TX status 459 * 460 * @info: The &struct ieee80211_tx_info to be cleared. 461 * 462 * When the driver passes an skb back to mac80211, it must report 463 * a number of things in TX status. This function clears everything 464 * in the TX status but the rate control information (it does clear 465 * the count since you need to fill that in anyway). 466 * 467 * NOTE: You can only use this function if you do NOT use 468 * info->driver_data! Use info->rate_driver_data 469 * instead if you need only the less space that allows. 470 */ 471static inline void 472ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info) 473{ 474 int i; 475 476 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 477 offsetof(struct ieee80211_tx_info, control.rates)); 478 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 479 offsetof(struct ieee80211_tx_info, driver_rates)); 480 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8); 481 /* clear the rate counts */ 482 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) 483 info->status.rates[i].count = 0; 484 485 BUILD_BUG_ON( 486 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23); 487 memset(&info->status.ampdu_ack_len, 0, 488 sizeof(struct ieee80211_tx_info) - 489 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len)); 490} 491 492 493/** 494 * enum mac80211_rx_flags - receive flags 495 * 496 * These flags are used with the @flag member of &struct ieee80211_rx_status. 497 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. 498 * Use together with %RX_FLAG_MMIC_STRIPPED. 499 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. 500 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, 501 * verification has been done by the hardware. 502 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame. 503 * If this flag is set, the stack cannot do any replay detection 504 * hence the driver or hardware will have to do that. 505 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on 506 * the frame. 507 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on 508 * the frame. 509 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field) 510 * is valid. This is useful in monitor mode and necessary for beacon frames 511 * to enable IBSS merging. 512 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame 513 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index 514 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used 515 * @RX_FLAG_SHORT_GI: Short guard interval was used 516 * @RX_FLAG_INTERNAL_CMTR: set internally after frame was reported 517 * on cooked monitor to avoid double-reporting it for multiple 518 * virtual interfaces 519 */ 520enum mac80211_rx_flags { 521 RX_FLAG_MMIC_ERROR = 1<<0, 522 RX_FLAG_DECRYPTED = 1<<1, 523 RX_FLAG_MMIC_STRIPPED = 1<<3, 524 RX_FLAG_IV_STRIPPED = 1<<4, 525 RX_FLAG_FAILED_FCS_CRC = 1<<5, 526 RX_FLAG_FAILED_PLCP_CRC = 1<<6, 527 RX_FLAG_TSFT = 1<<7, 528 RX_FLAG_SHORTPRE = 1<<8, 529 RX_FLAG_HT = 1<<9, 530 RX_FLAG_40MHZ = 1<<10, 531 RX_FLAG_SHORT_GI = 1<<11, 532 RX_FLAG_INTERNAL_CMTR = 1<<12, 533}; 534 535/** 536 * struct ieee80211_rx_status - receive status 537 * 538 * The low-level driver should provide this information (the subset 539 * supported by hardware) to the 802.11 code with each received 540 * frame, in the skb's control buffer (cb). 541 * 542 * @mactime: value in microseconds of the 64-bit Time Synchronization Function 543 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware. 544 * @band: the active band when this frame was received 545 * @freq: frequency the radio was tuned to when receiving this frame, in MHz 546 * @signal: signal strength when receiving this frame, either in dBm, in dB or 547 * unspecified depending on the hardware capabilities flags 548 * @IEEE80211_HW_SIGNAL_* 549 * @noise: noise when receiving this frame, in dBm. 550 * @qual: overall signal quality indication, in percent (0-100). 551 * @antenna: antenna used 552 * @rate_idx: index of data rate into band's supported rates or MCS index if 553 * HT rates are use (RX_FLAG_HT) 554 * @flag: %RX_FLAG_* 555 */ 556struct ieee80211_rx_status { 557 u64 mactime; 558 enum ieee80211_band band; 559 int freq; 560 int signal; 561 int noise; 562 int __deprecated qual; 563 int antenna; 564 int rate_idx; 565 int flag; 566}; 567 568/** 569 * enum ieee80211_conf_flags - configuration flags 570 * 571 * Flags to define PHY configuration options 572 * 573 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this 574 * to determine for example whether to calculate timestamps for packets 575 * or not, do not use instead of filter flags! 576 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only) 577 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set 578 * the driver should be prepared to handle configuration requests but 579 * may turn the device off as much as possible. Typically, this flag will 580 * be set when an interface is set UP but not associated or scanning, but 581 * it can also be unset in that case when monitor interfaces are active. 582 */ 583enum ieee80211_conf_flags { 584 IEEE80211_CONF_MONITOR = (1<<0), 585 IEEE80211_CONF_PS = (1<<1), 586 IEEE80211_CONF_IDLE = (1<<2), 587}; 588 589 590/** 591 * enum ieee80211_conf_changed - denotes which configuration changed 592 * 593 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed 594 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed 595 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed 596 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed 597 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed 598 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed 599 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed 600 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed 601 */ 602enum ieee80211_conf_changed { 603 IEEE80211_CONF_CHANGE_SMPS = BIT(1), 604 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2), 605 IEEE80211_CONF_CHANGE_MONITOR = BIT(3), 606 IEEE80211_CONF_CHANGE_PS = BIT(4), 607 IEEE80211_CONF_CHANGE_POWER = BIT(5), 608 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6), 609 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7), 610 IEEE80211_CONF_CHANGE_IDLE = BIT(8), 611}; 612 613/** 614 * enum ieee80211_smps_mode - spatial multiplexing power save mode 615 * 616 * @ 617 */ 618enum ieee80211_smps_mode { 619 IEEE80211_SMPS_AUTOMATIC, 620 IEEE80211_SMPS_OFF, 621 IEEE80211_SMPS_STATIC, 622 IEEE80211_SMPS_DYNAMIC, 623 624 /* keep last */ 625 IEEE80211_SMPS_NUM_MODES, 626}; 627 628/** 629 * struct ieee80211_conf - configuration of the device 630 * 631 * This struct indicates how the driver shall configure the hardware. 632 * 633 * @flags: configuration flags defined above 634 * 635 * @listen_interval: listen interval in units of beacon interval 636 * @max_sleep_period: the maximum number of beacon intervals to sleep for 637 * before checking the beacon for a TIM bit (managed mode only); this 638 * value will be only achievable between DTIM frames, the hardware 639 * needs to check for the multicast traffic bit in DTIM beacons. 640 * This variable is valid only when the CONF_PS flag is set. 641 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the 642 * powersave documentation below. This variable is valid only when 643 * the CONF_PS flag is set. 644 * 645 * @power_level: requested transmit power (in dBm) 646 * 647 * @channel: the channel to tune to 648 * @channel_type: the channel (HT) type 649 * 650 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame 651 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11, 652 * but actually means the number of transmissions not the number of retries 653 * @short_frame_max_tx_count: Maximum number of transmissions for a "short" 654 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the 655 * number of transmissions not the number of retries 656 * 657 * @smps_mode: spatial multiplexing powersave mode; note that 658 * %IEEE80211_SMPS_STATIC is used when the device is not 659 * configured for an HT channel 660 */ 661struct ieee80211_conf { 662 u32 flags; 663 int power_level, dynamic_ps_timeout; 664 int max_sleep_period; 665 666 u16 listen_interval; 667 668 u8 long_frame_max_tx_count, short_frame_max_tx_count; 669 670 struct ieee80211_channel *channel; 671 enum nl80211_channel_type channel_type; 672 enum ieee80211_smps_mode smps_mode; 673}; 674 675/** 676 * struct ieee80211_vif - per-interface data 677 * 678 * Data in this structure is continually present for driver 679 * use during the life of a virtual interface. 680 * 681 * @type: type of this virtual interface 682 * @bss_conf: BSS configuration for this interface, either our own 683 * or the BSS we're associated to 684 * @addr: address of this interface 685 * @drv_priv: data area for driver use, will always be aligned to 686 * sizeof(void *). 687 */ 688struct ieee80211_vif { 689 enum nl80211_iftype type; 690 struct ieee80211_bss_conf bss_conf; 691 u8 addr[ETH_ALEN]; 692 /* must be last */ 693 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); 694}; 695 696static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif) 697{ 698#ifdef CONFIG_MAC80211_MESH 699 return vif->type == NL80211_IFTYPE_MESH_POINT; 700#endif 701 return false; 702} 703 704/** 705 * enum ieee80211_key_alg - key algorithm 706 * @ALG_WEP: WEP40 or WEP104 707 * @ALG_TKIP: TKIP 708 * @ALG_CCMP: CCMP (AES) 709 * @ALG_AES_CMAC: AES-128-CMAC 710 */ 711enum ieee80211_key_alg { 712 ALG_WEP, 713 ALG_TKIP, 714 ALG_CCMP, 715 ALG_AES_CMAC, 716}; 717 718/** 719 * enum ieee80211_key_flags - key flags 720 * 721 * These flags are used for communication about keys between the driver 722 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. 723 * 724 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates 725 * that the STA this key will be used with could be using QoS. 726 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the 727 * driver to indicate that it requires IV generation for this 728 * particular key. 729 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by 730 * the driver for a TKIP key if it requires Michael MIC 731 * generation in software. 732 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates 733 * that the key is pairwise rather then a shared key. 734 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a 735 * CCMP key if it requires CCMP encryption of management frames (MFP) to 736 * be done in software. 737 */ 738enum ieee80211_key_flags { 739 IEEE80211_KEY_FLAG_WMM_STA = 1<<0, 740 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1, 741 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2, 742 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3, 743 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4, 744}; 745 746/** 747 * struct ieee80211_key_conf - key information 748 * 749 * This key information is given by mac80211 to the driver by 750 * the set_key() callback in &struct ieee80211_ops. 751 * 752 * @hw_key_idx: To be set by the driver, this is the key index the driver 753 * wants to be given when a frame is transmitted and needs to be 754 * encrypted in hardware. 755 * @alg: The key algorithm. 756 * @flags: key flags, see &enum ieee80211_key_flags. 757 * @keyidx: the key index (0-3) 758 * @keylen: key material length 759 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte) 760 * data block: 761 * - Temporal Encryption Key (128 bits) 762 * - Temporal Authenticator Tx MIC Key (64 bits) 763 * - Temporal Authenticator Rx MIC Key (64 bits) 764 * @icv_len: The ICV length for this key type 765 * @iv_len: The IV length for this key type 766 */ 767struct ieee80211_key_conf { 768 enum ieee80211_key_alg alg; 769 u8 icv_len; 770 u8 iv_len; 771 u8 hw_key_idx; 772 u8 flags; 773 s8 keyidx; 774 u8 keylen; 775 u8 key[0]; 776}; 777 778/** 779 * enum set_key_cmd - key command 780 * 781 * Used with the set_key() callback in &struct ieee80211_ops, this 782 * indicates whether a key is being removed or added. 783 * 784 * @SET_KEY: a key is set 785 * @DISABLE_KEY: a key must be disabled 786 */ 787enum set_key_cmd { 788 SET_KEY, DISABLE_KEY, 789}; 790 791/** 792 * struct ieee80211_sta - station table entry 793 * 794 * A station table entry represents a station we are possibly 795 * communicating with. Since stations are RCU-managed in 796 * mac80211, any ieee80211_sta pointer you get access to must 797 * either be protected by rcu_read_lock() explicitly or implicitly, 798 * or you must take good care to not use such a pointer after a 799 * call to your sta_notify callback that removed it. 800 * 801 * @addr: MAC address 802 * @aid: AID we assigned to the station if we're an AP 803 * @supp_rates: Bitmap of supported rates (per band) 804 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities 805 * @drv_priv: data area for driver use, will always be aligned to 806 * sizeof(void *), size is determined in hw information. 807 */ 808struct ieee80211_sta { 809 u32 supp_rates[IEEE80211_NUM_BANDS]; 810 u8 addr[ETH_ALEN]; 811 u16 aid; 812 struct ieee80211_sta_ht_cap ht_cap; 813 814 /* must be last */ 815 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); 816}; 817 818/** 819 * enum sta_notify_cmd - sta notify command 820 * 821 * Used with the sta_notify() callback in &struct ieee80211_ops, this 822 * indicates addition and removal of a station to station table, 823 * or if a associated station made a power state transition. 824 * 825 * @STA_NOTIFY_ADD: a station was added to the station table 826 * @STA_NOTIFY_REMOVE: a station being removed from the station table 827 * @STA_NOTIFY_SLEEP: a station is now sleeping 828 * @STA_NOTIFY_AWAKE: a sleeping station woke up 829 */ 830enum sta_notify_cmd { 831 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE, 832 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE, 833}; 834 835/** 836 * enum ieee80211_tkip_key_type - get tkip key 837 * 838 * Used by drivers which need to get a tkip key for skb. Some drivers need a 839 * phase 1 key, others need a phase 2 key. A single function allows the driver 840 * to get the key, this enum indicates what type of key is required. 841 * 842 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key 843 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key 844 */ 845enum ieee80211_tkip_key_type { 846 IEEE80211_TKIP_P1_KEY, 847 IEEE80211_TKIP_P2_KEY, 848}; 849 850/** 851 * enum ieee80211_hw_flags - hardware flags 852 * 853 * These flags are used to indicate hardware capabilities to 854 * the stack. Generally, flags here should have their meaning 855 * done in a way that the simplest hardware doesn't need setting 856 * any particular flags. There are some exceptions to this rule, 857 * however, so you are advised to review these flags carefully. 858 * 859 * @IEEE80211_HW_HAS_RATE_CONTROL: 860 * The hardware or firmware includes rate control, and cannot be 861 * controlled by the stack. As such, no rate control algorithm 862 * should be instantiated, and the TX rate reported to userspace 863 * will be taken from the TX status instead of the rate control 864 * algorithm. 865 * Note that this requires that the driver implement a number of 866 * callbacks so it has the correct information, it needs to have 867 * the @set_rts_threshold callback and must look at the BSS config 868 * @use_cts_prot for G/N protection, @use_short_slot for slot 869 * timing in 2.4 GHz and @use_short_preamble for preambles for 870 * CCK frames. 871 * 872 * @IEEE80211_HW_RX_INCLUDES_FCS: 873 * Indicates that received frames passed to the stack include 874 * the FCS at the end. 875 * 876 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 877 * Some wireless LAN chipsets buffer broadcast/multicast frames 878 * for power saving stations in the hardware/firmware and others 879 * rely on the host system for such buffering. This option is used 880 * to configure the IEEE 802.11 upper layer to buffer broadcast and 881 * multicast frames when there are power saving stations so that 882 * the driver can fetch them with ieee80211_get_buffered_bc(). 883 * 884 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE: 885 * Hardware is not capable of short slot operation on the 2.4 GHz band. 886 * 887 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE: 888 * Hardware is not capable of receiving frames with short preamble on 889 * the 2.4 GHz band. 890 * 891 * @IEEE80211_HW_SIGNAL_UNSPEC: 892 * Hardware can provide signal values but we don't know its units. We 893 * expect values between 0 and @max_signal. 894 * If possible please provide dB or dBm instead. 895 * 896 * @IEEE80211_HW_SIGNAL_DBM: 897 * Hardware gives signal values in dBm, decibel difference from 898 * one milliwatt. This is the preferred method since it is standardized 899 * between different devices. @max_signal does not need to be set. 900 * 901 * @IEEE80211_HW_NOISE_DBM: 902 * Hardware can provide noise (radio interference) values in units dBm, 903 * decibel difference from one milliwatt. 904 * 905 * @IEEE80211_HW_SPECTRUM_MGMT: 906 * Hardware supports spectrum management defined in 802.11h 907 * Measurement, Channel Switch, Quieting, TPC 908 * 909 * @IEEE80211_HW_AMPDU_AGGREGATION: 910 * Hardware supports 11n A-MPDU aggregation. 911 * 912 * @IEEE80211_HW_SUPPORTS_PS: 913 * Hardware has power save support (i.e. can go to sleep). 914 * 915 * @IEEE80211_HW_PS_NULLFUNC_STACK: 916 * Hardware requires nullfunc frame handling in stack, implies 917 * stack support for dynamic PS. 918 * 919 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS: 920 * Hardware has support for dynamic PS. 921 * 922 * @IEEE80211_HW_MFP_CAPABLE: 923 * Hardware supports management frame protection (MFP, IEEE 802.11w). 924 * 925 * @IEEE80211_HW_BEACON_FILTER: 926 * Hardware supports dropping of irrelevant beacon frames to 927 * avoid waking up cpu. 928 * 929 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS: 930 * Hardware supports static spatial multiplexing powersave, 931 * ie. can turn off all but one chain even on HT connections 932 * that should be using more chains. 933 * 934 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS: 935 * Hardware supports dynamic spatial multiplexing powersave, 936 * ie. can turn off all but one chain and then wake the rest 937 * up as required after, for example, rts/cts handshake. 938 */ 939enum ieee80211_hw_flags { 940 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0, 941 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, 942 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, 943 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3, 944 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4, 945 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5, 946 IEEE80211_HW_SIGNAL_DBM = 1<<6, 947 IEEE80211_HW_NOISE_DBM = 1<<7, 948 IEEE80211_HW_SPECTRUM_MGMT = 1<<8, 949 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9, 950 IEEE80211_HW_SUPPORTS_PS = 1<<10, 951 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11, 952 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12, 953 IEEE80211_HW_MFP_CAPABLE = 1<<13, 954 IEEE80211_HW_BEACON_FILTER = 1<<14, 955 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15, 956 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16, 957}; 958 959/** 960 * struct ieee80211_hw - hardware information and state 961 * 962 * This structure contains the configuration and hardware 963 * information for an 802.11 PHY. 964 * 965 * @wiphy: This points to the &struct wiphy allocated for this 966 * 802.11 PHY. You must fill in the @perm_addr and @dev 967 * members of this structure using SET_IEEE80211_DEV() 968 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported 969 * bands (with channels, bitrates) are registered here. 970 * 971 * @conf: &struct ieee80211_conf, device configuration, don't use. 972 * 973 * @priv: pointer to private area that was allocated for driver use 974 * along with this structure. 975 * 976 * @flags: hardware flags, see &enum ieee80211_hw_flags. 977 * 978 * @extra_tx_headroom: headroom to reserve in each transmit skb 979 * for use by the driver (e.g. for transmit headers.) 980 * 981 * @channel_change_time: time (in microseconds) it takes to change channels. 982 * 983 * @max_signal: Maximum value for signal (rssi) in RX information, used 984 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB 985 * 986 * @max_listen_interval: max listen interval in units of beacon interval 987 * that HW supports 988 * 989 * @queues: number of available hardware transmit queues for 990 * data packets. WMM/QoS requires at least four, these 991 * queues need to have configurable access parameters. 992 * 993 * @rate_control_algorithm: rate control algorithm for this hardware. 994 * If unset (NULL), the default algorithm will be used. Must be 995 * set before calling ieee80211_register_hw(). 996 * 997 * @vif_data_size: size (in bytes) of the drv_priv data area 998 * within &struct ieee80211_vif. 999 * @sta_data_size: size (in bytes) of the drv_priv data area 1000 * within &struct ieee80211_sta. 1001 * 1002 * @max_rates: maximum number of alternate rate retry stages 1003 * @max_rate_tries: maximum number of tries for each stage 1004 */ 1005struct ieee80211_hw { 1006 struct ieee80211_conf conf; 1007 struct wiphy *wiphy; 1008 const char *rate_control_algorithm; 1009 void *priv; 1010 u32 flags; 1011 unsigned int extra_tx_headroom; 1012 int channel_change_time; 1013 int vif_data_size; 1014 int sta_data_size; 1015 u16 queues; 1016 u16 max_listen_interval; 1017 s8 max_signal; 1018 u8 max_rates; 1019 u8 max_rate_tries; 1020}; 1021 1022/** 1023 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy 1024 * 1025 * @wiphy: the &struct wiphy which we want to query 1026 * 1027 * mac80211 drivers can use this to get to their respective 1028 * &struct ieee80211_hw. Drivers wishing to get to their own private 1029 * structure can then access it via hw->priv. Note that mac802111 drivers should 1030 * not use wiphy_priv() to try to get their private driver structure as this 1031 * is already used internally by mac80211. 1032 */ 1033struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy); 1034 1035/** 1036 * SET_IEEE80211_DEV - set device for 802.11 hardware 1037 * 1038 * @hw: the &struct ieee80211_hw to set the device for 1039 * @dev: the &struct device of this 802.11 device 1040 */ 1041static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 1042{ 1043 set_wiphy_dev(hw->wiphy, dev); 1044} 1045 1046/** 1047 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware 1048 * 1049 * @hw: the &struct ieee80211_hw to set the MAC address for 1050 * @addr: the address to set 1051 */ 1052static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 1053{ 1054 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 1055} 1056 1057static inline struct ieee80211_rate * 1058ieee80211_get_tx_rate(const struct ieee80211_hw *hw, 1059 const struct ieee80211_tx_info *c) 1060{ 1061 if (WARN_ON(c->control.rates[0].idx < 0)) 1062 return NULL; 1063 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx]; 1064} 1065 1066static inline struct ieee80211_rate * 1067ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw, 1068 const struct ieee80211_tx_info *c) 1069{ 1070 if (c->control.rts_cts_rate_idx < 0) 1071 return NULL; 1072 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx]; 1073} 1074 1075static inline struct ieee80211_rate * 1076ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw, 1077 const struct ieee80211_tx_info *c, int idx) 1078{ 1079 if (c->control.rates[idx + 1].idx < 0) 1080 return NULL; 1081 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx]; 1082} 1083 1084/** 1085 * DOC: Hardware crypto acceleration 1086 * 1087 * mac80211 is capable of taking advantage of many hardware 1088 * acceleration designs for encryption and decryption operations. 1089 * 1090 * The set_key() callback in the &struct ieee80211_ops for a given 1091 * device is called to enable hardware acceleration of encryption and 1092 * decryption. The callback takes a @sta parameter that will be NULL 1093 * for default keys or keys used for transmission only, or point to 1094 * the station information for the peer for individual keys. 1095 * Multiple transmission keys with the same key index may be used when 1096 * VLANs are configured for an access point. 1097 * 1098 * When transmitting, the TX control data will use the @hw_key_idx 1099 * selected by the driver by modifying the &struct ieee80211_key_conf 1100 * pointed to by the @key parameter to the set_key() function. 1101 * 1102 * The set_key() call for the %SET_KEY command should return 0 if 1103 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 1104 * added; if you return 0 then hw_key_idx must be assigned to the 1105 * hardware key index, you are free to use the full u8 range. 1106 * 1107 * When the cmd is %DISABLE_KEY then it must succeed. 1108 * 1109 * Note that it is permissible to not decrypt a frame even if a key 1110 * for it has been uploaded to hardware, the stack will not make any 1111 * decision based on whether a key has been uploaded or not but rather 1112 * based on the receive flags. 1113 * 1114 * The &struct ieee80211_key_conf structure pointed to by the @key 1115 * parameter is guaranteed to be valid until another call to set_key() 1116 * removes it, but it can only be used as a cookie to differentiate 1117 * keys. 1118 * 1119 * In TKIP some HW need to be provided a phase 1 key, for RX decryption 1120 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key 1121 * handler. 1122 * The update_tkip_key() call updates the driver with the new phase 1 key. 1123 * This happens everytime the iv16 wraps around (every 65536 packets). The 1124 * set_key() call will happen only once for each key (unless the AP did 1125 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is 1126 * provided by update_tkip_key only. The trigger that makes mac80211 call this 1127 * handler is software decryption with wrap around of iv16. 1128 */ 1129 1130/** 1131 * DOC: Powersave support 1132 * 1133 * mac80211 has support for various powersave implementations. 1134 * 1135 * First, it can support hardware that handles all powersaving by 1136 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS 1137 * hardware flag. In that case, it will be told about the desired 1138 * powersave mode depending on the association status, and the driver 1139 * must take care of sending nullfunc frames when necessary, i.e. when 1140 * entering and leaving powersave mode. The driver is required to look at 1141 * the AID in beacons and signal to the AP that it woke up when it finds 1142 * traffic directed to it. This mode supports dynamic PS by simply 1143 * enabling/disabling PS. 1144 * 1145 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS 1146 * flag to indicate that it can support dynamic PS mode itself (see below). 1147 * 1148 * Other hardware designs cannot send nullfunc frames by themselves and also 1149 * need software support for parsing the TIM bitmap. This is also supported 1150 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and 1151 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still 1152 * required to pass up beacons. The hardware is still required to handle 1153 * waking up for multicast traffic; if it cannot the driver must handle that 1154 * as best as it can, mac80211 is too slow. 1155 * 1156 * Dynamic powersave mode is an extension to normal powersave mode in which 1157 * the hardware stays awake for a user-specified period of time after sending 1158 * a frame so that reply frames need not be buffered and therefore delayed 1159 * to the next wakeup. This can either be supported by hardware, in which case 1160 * the driver needs to look at the @dynamic_ps_timeout hardware configuration 1161 * value, or by the stack if all nullfunc handling is in the stack. 1162 */ 1163 1164/** 1165 * DOC: Beacon filter support 1166 * 1167 * Some hardware have beacon filter support to reduce host cpu wakeups 1168 * which will reduce system power consumption. It usuallly works so that 1169 * the firmware creates a checksum of the beacon but omits all constantly 1170 * changing elements (TSF, TIM etc). Whenever the checksum changes the 1171 * beacon is forwarded to the host, otherwise it will be just dropped. That 1172 * way the host will only receive beacons where some relevant information 1173 * (for example ERP protection or WMM settings) have changed. 1174 * 1175 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER 1176 * hardware capability. The driver needs to enable beacon filter support 1177 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When 1178 * power save is enabled, the stack will not check for beacon loss and the 1179 * driver needs to notify about loss of beacons with ieee80211_beacon_loss(). 1180 * 1181 * The time (or number of beacons missed) until the firmware notifies the 1182 * driver of a beacon loss event (which in turn causes the driver to call 1183 * ieee80211_beacon_loss()) should be configurable and will be controlled 1184 * by mac80211 and the roaming algorithm in the future. 1185 * 1186 * Since there may be constantly changing information elements that nothing 1187 * in the software stack cares about, we will, in the future, have mac80211 1188 * tell the driver which information elements are interesting in the sense 1189 * that we want to see changes in them. This will include 1190 * - a list of information element IDs 1191 * - a list of OUIs for the vendor information element 1192 * 1193 * Ideally, the hardware would filter out any beacons without changes in the 1194 * requested elements, but if it cannot support that it may, at the expense 1195 * of some efficiency, filter out only a subset. For example, if the device 1196 * doesn't support checking for OUIs it should pass up all changes in all 1197 * vendor information elements. 1198 * 1199 * Note that change, for the sake of simplification, also includes information 1200 * elements appearing or disappearing from the beacon. 1201 * 1202 * Some hardware supports an "ignore list" instead, just make sure nothing 1203 * that was requested is on the ignore list, and include commonly changing 1204 * information element IDs in the ignore list, for example 11 (BSS load) and 1205 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136, 1206 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility 1207 * it could also include some currently unused IDs. 1208 * 1209 * 1210 * In addition to these capabilities, hardware should support notifying the 1211 * host of changes in the beacon RSSI. This is relevant to implement roaming 1212 * when no traffic is flowing (when traffic is flowing we see the RSSI of 1213 * the received data packets). This can consist in notifying the host when 1214 * the RSSI changes significantly or when it drops below or rises above 1215 * configurable thresholds. In the future these thresholds will also be 1216 * configured by mac80211 (which gets them from userspace) to implement 1217 * them as the roaming algorithm requires. 1218 * 1219 * If the hardware cannot implement this, the driver should ask it to 1220 * periodically pass beacon frames to the host so that software can do the 1221 * signal strength threshold checking. 1222 */ 1223 1224/** 1225 * DOC: Spatial multiplexing power save 1226 * 1227 * SMPS (Spatial multiplexing power save) is a mechanism to conserve 1228 * power in an 802.11n implementation. For details on the mechanism 1229 * and rationale, please refer to 802.11 (as amended by 802.11n-2009) 1230 * "11.2.3 SM power save". 1231 * 1232 * The mac80211 implementation is capable of sending action frames 1233 * to update the AP about the station's SMPS mode, and will instruct 1234 * the driver to enter the specific mode. It will also announce the 1235 * requested SMPS mode during the association handshake. Hardware 1236 * support for this feature is required, and can be indicated by 1237 * hardware flags. 1238 * 1239 * The default mode will be "automatic", which nl80211/cfg80211 1240 * defines to be dynamic SMPS in (regular) powersave, and SMPS 1241 * turned off otherwise. 1242 * 1243 * To support this feature, the driver must set the appropriate 1244 * hardware support flags, and handle the SMPS flag to the config() 1245 * operation. It will then with this mechanism be instructed to 1246 * enter the requested SMPS mode while associated to an HT AP. 1247 */ 1248 1249/** 1250 * DOC: Frame filtering 1251 * 1252 * mac80211 requires to see many management frames for proper 1253 * operation, and users may want to see many more frames when 1254 * in monitor mode. However, for best CPU usage and power consumption, 1255 * having as few frames as possible percolate through the stack is 1256 * desirable. Hence, the hardware should filter as much as possible. 1257 * 1258 * To achieve this, mac80211 uses filter flags (see below) to tell 1259 * the driver's configure_filter() function which frames should be 1260 * passed to mac80211 and which should be filtered out. 1261 * 1262 * Before configure_filter() is invoked, the prepare_multicast() 1263 * callback is invoked with the parameters @mc_count and @mc_list 1264 * for the combined multicast address list of all virtual interfaces. 1265 * It's use is optional, and it returns a u64 that is passed to 1266 * configure_filter(). Additionally, configure_filter() has the 1267 * arguments @changed_flags telling which flags were changed and 1268 * @total_flags with the new flag states. 1269 * 1270 * If your device has no multicast address filters your driver will 1271 * need to check both the %FIF_ALLMULTI flag and the @mc_count 1272 * parameter to see whether multicast frames should be accepted 1273 * or dropped. 1274 * 1275 * All unsupported flags in @total_flags must be cleared. 1276 * Hardware does not support a flag if it is incapable of _passing_ 1277 * the frame to the stack. Otherwise the driver must ignore 1278 * the flag, but not clear it. 1279 * You must _only_ clear the flag (announce no support for the 1280 * flag to mac80211) if you are not able to pass the packet type 1281 * to the stack (so the hardware always filters it). 1282 * So for example, you should clear @FIF_CONTROL, if your hardware 1283 * always filters control frames. If your hardware always passes 1284 * control frames to the kernel and is incapable of filtering them, 1285 * you do _not_ clear the @FIF_CONTROL flag. 1286 * This rule applies to all other FIF flags as well. 1287 */ 1288 1289/** 1290 * enum ieee80211_filter_flags - hardware filter flags 1291 * 1292 * These flags determine what the filter in hardware should be 1293 * programmed to let through and what should not be passed to the 1294 * stack. It is always safe to pass more frames than requested, 1295 * but this has negative impact on power consumption. 1296 * 1297 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, 1298 * think of the BSS as your network segment and then this corresponds 1299 * to the regular ethernet device promiscuous mode. 1300 * 1301 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 1302 * by the user or if the hardware is not capable of filtering by 1303 * multicast address. 1304 * 1305 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 1306 * %RX_FLAG_FAILED_FCS_CRC for them) 1307 * 1308 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 1309 * the %RX_FLAG_FAILED_PLCP_CRC for them 1310 * 1311 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 1312 * to the hardware that it should not filter beacons or probe responses 1313 * by BSSID. Filtering them can greatly reduce the amount of processing 1314 * mac80211 needs to do and the amount of CPU wakeups, so you should 1315 * honour this flag if possible. 1316 * 1317 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS 1318 * is not set then only those addressed to this station. 1319 * 1320 * @FIF_OTHER_BSS: pass frames destined to other BSSes 1321 * 1322 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only 1323 * those addressed to this station. 1324 */ 1325enum ieee80211_filter_flags { 1326 FIF_PROMISC_IN_BSS = 1<<0, 1327 FIF_ALLMULTI = 1<<1, 1328 FIF_FCSFAIL = 1<<2, 1329 FIF_PLCPFAIL = 1<<3, 1330 FIF_BCN_PRBRESP_PROMISC = 1<<4, 1331 FIF_CONTROL = 1<<5, 1332 FIF_OTHER_BSS = 1<<6, 1333 FIF_PSPOLL = 1<<7, 1334}; 1335 1336/** 1337 * enum ieee80211_ampdu_mlme_action - A-MPDU actions 1338 * 1339 * These flags are used with the ampdu_action() callback in 1340 * &struct ieee80211_ops to indicate which action is needed. 1341 * 1342 * Note that drivers MUST be able to deal with a TX aggregation 1343 * session being stopped even before they OK'ed starting it by 1344 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer 1345 * might receive the addBA frame and send a delBA right away! 1346 * 1347 * @IEEE80211_AMPDU_RX_START: start Rx aggregation 1348 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation 1349 * @IEEE80211_AMPDU_TX_START: start Tx aggregation 1350 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation 1351 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational 1352 */ 1353enum ieee80211_ampdu_mlme_action { 1354 IEEE80211_AMPDU_RX_START, 1355 IEEE80211_AMPDU_RX_STOP, 1356 IEEE80211_AMPDU_TX_START, 1357 IEEE80211_AMPDU_TX_STOP, 1358 IEEE80211_AMPDU_TX_OPERATIONAL, 1359}; 1360 1361/** 1362 * struct ieee80211_ops - callbacks from mac80211 to the driver 1363 * 1364 * This structure contains various callbacks that the driver may 1365 * handle or, in some cases, must handle, for example to configure 1366 * the hardware to a new channel or to transmit a frame. 1367 * 1368 * @tx: Handler that 802.11 module calls for each transmitted frame. 1369 * skb contains the buffer starting from the IEEE 802.11 header. 1370 * The low-level driver should send the frame out based on 1371 * configuration in the TX control data. This handler should, 1372 * preferably, never fail and stop queues appropriately, more 1373 * importantly, however, it must never fail for A-MPDU-queues. 1374 * This function should return NETDEV_TX_OK except in very 1375 * limited cases. 1376 * Must be implemented and atomic. 1377 * 1378 * @start: Called before the first netdevice attached to the hardware 1379 * is enabled. This should turn on the hardware and must turn on 1380 * frame reception (for possibly enabled monitor interfaces.) 1381 * Returns negative error codes, these may be seen in userspace, 1382 * or zero. 1383 * When the device is started it should not have a MAC address 1384 * to avoid acknowledging frames before a non-monitor device 1385 * is added. 1386 * Must be implemented and can sleep. 1387 * 1388 * @stop: Called after last netdevice attached to the hardware 1389 * is disabled. This should turn off the hardware (at least 1390 * it must turn off frame reception.) 1391 * May be called right after add_interface if that rejects 1392 * an interface. If you added any work onto the mac80211 workqueue 1393 * you should ensure to cancel it on this callback. 1394 * Must be implemented and can sleep. 1395 * 1396 * @add_interface: Called when a netdevice attached to the hardware is 1397 * enabled. Because it is not called for monitor mode devices, @start 1398 * and @stop must be implemented. 1399 * The driver should perform any initialization it needs before 1400 * the device can be enabled. The initial configuration for the 1401 * interface is given in the conf parameter. 1402 * The callback may refuse to add an interface by returning a 1403 * negative error code (which will be seen in userspace.) 1404 * Must be implemented and can sleep. 1405 * 1406 * @remove_interface: Notifies a driver that an interface is going down. 1407 * The @stop callback is called after this if it is the last interface 1408 * and no monitor interfaces are present. 1409 * When all interfaces are removed, the MAC address in the hardware 1410 * must be cleared so the device no longer acknowledges packets, 1411 * the mac_addr member of the conf structure is, however, set to the 1412 * MAC address of the device going away. 1413 * Hence, this callback must be implemented. It can sleep. 1414 * 1415 * @config: Handler for configuration requests. IEEE 802.11 code calls this 1416 * function to change hardware configuration, e.g., channel. 1417 * This function should never fail but returns a negative error code 1418 * if it does. The callback can sleep. 1419 * 1420 * @bss_info_changed: Handler for configuration requests related to BSS 1421 * parameters that may vary during BSS's lifespan, and may affect low 1422 * level driver (e.g. assoc/disassoc status, erp parameters). 1423 * This function should not be used if no BSS has been set, unless 1424 * for association indication. The @changed parameter indicates which 1425 * of the bss parameters has changed when a call is made. The callback 1426 * can sleep. 1427 * 1428 * @prepare_multicast: Prepare for multicast filter configuration. 1429 * This callback is optional, and its return value is passed 1430 * to configure_filter(). This callback must be atomic. 1431 * 1432 * @configure_filter: Configure the device's RX filter. 1433 * See the section "Frame filtering" for more information. 1434 * This callback must be implemented and can sleep. 1435 * 1436 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit 1437 * must be set or cleared for a given STA. Must be atomic. 1438 * 1439 * @set_key: See the section "Hardware crypto acceleration" 1440 * This callback is only called between add_interface and 1441 * remove_interface calls, i.e. while the given virtual interface 1442 * is enabled. 1443 * Returns a negative error code if the key can't be added. 1444 * The callback can sleep. 1445 * 1446 * @update_tkip_key: See the section "Hardware crypto acceleration" 1447 * This callback will be called in the context of Rx. Called for drivers 1448 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY. 1449 * The callback can sleep. 1450 * 1451 * @hw_scan: Ask the hardware to service the scan request, no need to start 1452 * the scan state machine in stack. The scan must honour the channel 1453 * configuration done by the regulatory agent in the wiphy's 1454 * registered bands. The hardware (or the driver) needs to make sure 1455 * that power save is disabled. 1456 * The @req ie/ie_len members are rewritten by mac80211 to contain the 1457 * entire IEs after the SSID, so that drivers need not look at these 1458 * at all but just send them after the SSID -- mac80211 includes the 1459 * (extended) supported rates and HT information (where applicable). 1460 * When the scan finishes, ieee80211_scan_completed() must be called; 1461 * note that it also must be called when the scan cannot finish due to 1462 * any error unless this callback returned a negative error code. 1463 * The callback can sleep. 1464 * 1465 * @sw_scan_start: Notifier function that is called just before a software scan 1466 * is started. Can be NULL, if the driver doesn't need this notification. 1467 * The callback can sleep. 1468 * 1469 * @sw_scan_complete: Notifier function that is called just after a 1470 * software scan finished. Can be NULL, if the driver doesn't need 1471 * this notification. 1472 * The callback can sleep. 1473 * 1474 * @get_stats: Return low-level statistics. 1475 * Returns zero if statistics are available. 1476 * The callback can sleep. 1477 * 1478 * @get_tkip_seq: If your device implements TKIP encryption in hardware this 1479 * callback should be provided to read the TKIP transmit IVs (both IV32 1480 * and IV16) for the given key from hardware. 1481 * The callback must be atomic. 1482 * 1483 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 1484 * The callback can sleep. 1485 * 1486 * @sta_notify: Notifies low level driver about addition, removal or power 1487 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc. 1488 * Must be atomic. 1489 * 1490 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 1491 * bursting) for a hardware TX queue. 1492 * Returns a negative error code on failure. 1493 * The callback can sleep. 1494 * 1495 * @get_tx_stats: Get statistics of the current TX queue status. This is used 1496 * to get number of currently queued packets (queue length), maximum queue 1497 * size (limit), and total number of packets sent using each TX queue 1498 * (count). The 'stats' pointer points to an array that has hw->queues 1499 * items. 1500 * The callback must be atomic. 1501 * 1502 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 1503 * this is only used for IBSS mode BSSID merging and debugging. Is not a 1504 * required function. 1505 * The callback can sleep. 1506 * 1507 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware. 1508 * Currently, this is only used for IBSS mode debugging. Is not a 1509 * required function. 1510 * The callback can sleep. 1511 * 1512 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 1513 * with other STAs in the IBSS. This is only used in IBSS mode. This 1514 * function is optional if the firmware/hardware takes full care of 1515 * TSF synchronization. 1516 * The callback can sleep. 1517 * 1518 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 1519 * This is needed only for IBSS mode and the result of this function is 1520 * used to determine whether to reply to Probe Requests. 1521 * Returns non-zero if this device sent the last beacon. 1522 * The callback can sleep. 1523 * 1524 * @ampdu_action: Perform a certain A-MPDU action 1525 * The RA/TID combination determines the destination and TID we want 1526 * the ampdu action to be performed for. The action is defined through 1527 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn) 1528 * is the first frame we expect to perform the action on. Notice 1529 * that TX/RX_STOP can pass NULL for this parameter. 1530 * Returns a negative error code on failure. 1531 * The callback must be atomic. 1532 * 1533 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also 1534 * need to set wiphy->rfkill_poll to %true before registration, 1535 * and need to call wiphy_rfkill_set_hw_state() in the callback. 1536 * The callback can sleep. 1537 * 1538 * @testmode_cmd: Implement a cfg80211 test mode command. 1539 * The callback can sleep. 1540 * 1541 * @flush: Flush all pending frames from the hardware queue, making sure 1542 * that the hardware queues are empty. If the parameter @drop is set 1543 * to %true, pending frames may be dropped. The callback can sleep. 1544 */ 1545struct ieee80211_ops { 1546 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb); 1547 int (*start)(struct ieee80211_hw *hw); 1548 void (*stop)(struct ieee80211_hw *hw); 1549 int (*add_interface)(struct ieee80211_hw *hw, 1550 struct ieee80211_vif *vif); 1551 void (*remove_interface)(struct ieee80211_hw *hw, 1552 struct ieee80211_vif *vif); 1553 int (*config)(struct ieee80211_hw *hw, u32 changed); 1554 void (*bss_info_changed)(struct ieee80211_hw *hw, 1555 struct ieee80211_vif *vif, 1556 struct ieee80211_bss_conf *info, 1557 u32 changed); 1558 u64 (*prepare_multicast)(struct ieee80211_hw *hw, 1559 int mc_count, struct dev_addr_list *mc_list); 1560 void (*configure_filter)(struct ieee80211_hw *hw, 1561 unsigned int changed_flags, 1562 unsigned int *total_flags, 1563 u64 multicast); 1564 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 1565 bool set); 1566 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, 1567 struct ieee80211_vif *vif, struct ieee80211_sta *sta, 1568 struct ieee80211_key_conf *key); 1569 void (*update_tkip_key)(struct ieee80211_hw *hw, 1570 struct ieee80211_key_conf *conf, const u8 *address, 1571 u32 iv32, u16 *phase1key); 1572 int (*hw_scan)(struct ieee80211_hw *hw, 1573 struct cfg80211_scan_request *req); 1574 void (*sw_scan_start)(struct ieee80211_hw *hw); 1575 void (*sw_scan_complete)(struct ieee80211_hw *hw); 1576 int (*get_stats)(struct ieee80211_hw *hw, 1577 struct ieee80211_low_level_stats *stats); 1578 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx, 1579 u32 *iv32, u16 *iv16); 1580 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 1581 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1582 enum sta_notify_cmd, struct ieee80211_sta *sta); 1583 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue, 1584 const struct ieee80211_tx_queue_params *params); 1585 int (*get_tx_stats)(struct ieee80211_hw *hw, 1586 struct ieee80211_tx_queue_stats *stats); 1587 u64 (*get_tsf)(struct ieee80211_hw *hw); 1588 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf); 1589 void (*reset_tsf)(struct ieee80211_hw *hw); 1590 int (*tx_last_beacon)(struct ieee80211_hw *hw); 1591 int (*ampdu_action)(struct ieee80211_hw *hw, 1592 struct ieee80211_vif *vif, 1593 enum ieee80211_ampdu_mlme_action action, 1594 struct ieee80211_sta *sta, u16 tid, u16 *ssn); 1595 1596 void (*rfkill_poll)(struct ieee80211_hw *hw); 1597#ifdef CONFIG_NL80211_TESTMODE 1598 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len); 1599#endif 1600 void (*flush)(struct ieee80211_hw *hw, bool drop); 1601}; 1602 1603/** 1604 * ieee80211_alloc_hw - Allocate a new hardware device 1605 * 1606 * This must be called once for each hardware device. The returned pointer 1607 * must be used to refer to this device when calling other functions. 1608 * mac80211 allocates a private data area for the driver pointed to by 1609 * @priv in &struct ieee80211_hw, the size of this area is given as 1610 * @priv_data_len. 1611 * 1612 * @priv_data_len: length of private data 1613 * @ops: callbacks for this device 1614 */ 1615struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 1616 const struct ieee80211_ops *ops); 1617 1618/** 1619 * ieee80211_register_hw - Register hardware device 1620 * 1621 * You must call this function before any other functions in 1622 * mac80211. Note that before a hardware can be registered, you 1623 * need to fill the contained wiphy's information. 1624 * 1625 * @hw: the device to register as returned by ieee80211_alloc_hw() 1626 */ 1627int ieee80211_register_hw(struct ieee80211_hw *hw); 1628 1629#ifdef CONFIG_MAC80211_LEDS 1630extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 1631extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 1632extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); 1633extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw); 1634#endif 1635/** 1636 * ieee80211_get_tx_led_name - get name of TX LED 1637 * 1638 * mac80211 creates a transmit LED trigger for each wireless hardware 1639 * that can be used to drive LEDs if your driver registers a LED device. 1640 * This function returns the name (or %NULL if not configured for LEDs) 1641 * of the trigger so you can automatically link the LED device. 1642 * 1643 * @hw: the hardware to get the LED trigger name for 1644 */ 1645static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 1646{ 1647#ifdef CONFIG_MAC80211_LEDS 1648 return __ieee80211_get_tx_led_name(hw); 1649#else 1650 return NULL; 1651#endif 1652} 1653 1654/** 1655 * ieee80211_get_rx_led_name - get name of RX LED 1656 * 1657 * mac80211 creates a receive LED trigger for each wireless hardware 1658 * that can be used to drive LEDs if your driver registers a LED device. 1659 * This function returns the name (or %NULL if not configured for LEDs) 1660 * of the trigger so you can automatically link the LED device. 1661 * 1662 * @hw: the hardware to get the LED trigger name for 1663 */ 1664static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 1665{ 1666#ifdef CONFIG_MAC80211_LEDS 1667 return __ieee80211_get_rx_led_name(hw); 1668#else 1669 return NULL; 1670#endif 1671} 1672 1673/** 1674 * ieee80211_get_assoc_led_name - get name of association LED 1675 * 1676 * mac80211 creates a association LED trigger for each wireless hardware 1677 * that can be used to drive LEDs if your driver registers a LED device. 1678 * This function returns the name (or %NULL if not configured for LEDs) 1679 * of the trigger so you can automatically link the LED device. 1680 * 1681 * @hw: the hardware to get the LED trigger name for 1682 */ 1683static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) 1684{ 1685#ifdef CONFIG_MAC80211_LEDS 1686 return __ieee80211_get_assoc_led_name(hw); 1687#else 1688 return NULL; 1689#endif 1690} 1691 1692/** 1693 * ieee80211_get_radio_led_name - get name of radio LED 1694 * 1695 * mac80211 creates a radio change LED trigger for each wireless hardware 1696 * that can be used to drive LEDs if your driver registers a LED device. 1697 * This function returns the name (or %NULL if not configured for LEDs) 1698 * of the trigger so you can automatically link the LED device. 1699 * 1700 * @hw: the hardware to get the LED trigger name for 1701 */ 1702static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) 1703{ 1704#ifdef CONFIG_MAC80211_LEDS 1705 return __ieee80211_get_radio_led_name(hw); 1706#else 1707 return NULL; 1708#endif 1709} 1710 1711/** 1712 * ieee80211_unregister_hw - Unregister a hardware device 1713 * 1714 * This function instructs mac80211 to free allocated resources 1715 * and unregister netdevices from the networking subsystem. 1716 * 1717 * @hw: the hardware to unregister 1718 */ 1719void ieee80211_unregister_hw(struct ieee80211_hw *hw); 1720 1721/** 1722 * ieee80211_free_hw - free hardware descriptor 1723 * 1724 * This function frees everything that was allocated, including the 1725 * private data for the driver. You must call ieee80211_unregister_hw() 1726 * before calling this function. 1727 * 1728 * @hw: the hardware to free 1729 */ 1730void ieee80211_free_hw(struct ieee80211_hw *hw); 1731 1732/** 1733 * ieee80211_restart_hw - restart hardware completely 1734 * 1735 * Call this function when the hardware was restarted for some reason 1736 * (hardware error, ...) and the driver is unable to restore its state 1737 * by itself. mac80211 assumes that at this point the driver/hardware 1738 * is completely uninitialised and stopped, it starts the process by 1739 * calling the ->start() operation. The driver will need to reset all 1740 * internal state that it has prior to calling this function. 1741 * 1742 * @hw: the hardware to restart 1743 */ 1744void ieee80211_restart_hw(struct ieee80211_hw *hw); 1745 1746/** 1747 * ieee80211_rx - receive frame 1748 * 1749 * Use this function to hand received frames to mac80211. The receive 1750 * buffer in @skb must start with an IEEE 802.11 header. 1751 * 1752 * This function may not be called in IRQ context. Calls to this function 1753 * for a single hardware must be synchronized against each other. Calls to 1754 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be 1755 * mixed for a single hardware. 1756 * 1757 * In process context use instead ieee80211_rx_ni(). 1758 * 1759 * @hw: the hardware this frame came in on 1760 * @skb: the buffer to receive, owned by mac80211 after this call 1761 */ 1762void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb); 1763 1764/** 1765 * ieee80211_rx_irqsafe - receive frame 1766 * 1767 * Like ieee80211_rx() but can be called in IRQ context 1768 * (internally defers to a tasklet.) 1769 * 1770 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not 1771 * be mixed for a single hardware. 1772 * 1773 * @hw: the hardware this frame came in on 1774 * @skb: the buffer to receive, owned by mac80211 after this call 1775 */ 1776void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb); 1777 1778/** 1779 * ieee80211_rx_ni - receive frame (in process context) 1780 * 1781 * Like ieee80211_rx() but can be called in process context 1782 * (internally disables bottom halves). 1783 * 1784 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may 1785 * not be mixed for a single hardware. 1786 * 1787 * @hw: the hardware this frame came in on 1788 * @skb: the buffer to receive, owned by mac80211 after this call 1789 */ 1790static inline void ieee80211_rx_ni(struct ieee80211_hw *hw, 1791 struct sk_buff *skb) 1792{ 1793 local_bh_disable(); 1794 ieee80211_rx(hw, skb); 1795 local_bh_enable(); 1796} 1797 1798/* 1799 * The TX headroom reserved by mac80211 for its own tx_status functions. 1800 * This is enough for the radiotap header. 1801 */ 1802#define IEEE80211_TX_STATUS_HEADROOM 13 1803 1804/** 1805 * ieee80211_tx_status - transmit status callback 1806 * 1807 * Call this function for all transmitted frames after they have been 1808 * transmitted. It is permissible to not call this function for 1809 * multicast frames but this can affect statistics. 1810 * 1811 * This function may not be called in IRQ context. Calls to this function 1812 * for a single hardware must be synchronized against each other. Calls 1813 * to this function and ieee80211_tx_status_irqsafe() may not be mixed 1814 * for a single hardware. 1815 * 1816 * @hw: the hardware the frame was transmitted by 1817 * @skb: the frame that was transmitted, owned by mac80211 after this call 1818 */ 1819void ieee80211_tx_status(struct ieee80211_hw *hw, 1820 struct sk_buff *skb); 1821 1822/** 1823 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback 1824 * 1825 * Like ieee80211_tx_status() but can be called in IRQ context 1826 * (internally defers to a tasklet.) 1827 * 1828 * Calls to this function and ieee80211_tx_status() may not be mixed for a 1829 * single hardware. 1830 * 1831 * @hw: the hardware the frame was transmitted by 1832 * @skb: the frame that was transmitted, owned by mac80211 after this call 1833 */ 1834void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 1835 struct sk_buff *skb); 1836 1837/** 1838 * ieee80211_beacon_get_tim - beacon generation function 1839 * @hw: pointer obtained from ieee80211_alloc_hw(). 1840 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 1841 * @tim_offset: pointer to variable that will receive the TIM IE offset. 1842 * Set to 0 if invalid (in non-AP modes). 1843 * @tim_length: pointer to variable that will receive the TIM IE length, 1844 * (including the ID and length bytes!). 1845 * Set to 0 if invalid (in non-AP modes). 1846 * 1847 * If the driver implements beaconing modes, it must use this function to 1848 * obtain the beacon frame/template. 1849 * 1850 * If the beacon frames are generated by the host system (i.e., not in 1851 * hardware/firmware), the driver uses this function to get each beacon 1852 * frame from mac80211 -- it is responsible for calling this function 1853 * before the beacon is needed (e.g. based on hardware interrupt). 1854 * 1855 * If the beacon frames are generated by the device, then the driver 1856 * must use the returned beacon as the template and change the TIM IE 1857 * according to the current DTIM parameters/TIM bitmap. 1858 * 1859 * The driver is responsible for freeing the returned skb. 1860 */ 1861struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw, 1862 struct ieee80211_vif *vif, 1863 u16 *tim_offset, u16 *tim_length); 1864 1865/** 1866 * ieee80211_beacon_get - beacon generation function 1867 * @hw: pointer obtained from ieee80211_alloc_hw(). 1868 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 1869 * 1870 * See ieee80211_beacon_get_tim(). 1871 */ 1872static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 1873 struct ieee80211_vif *vif) 1874{ 1875 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL); 1876} 1877 1878/** 1879 * ieee80211_rts_get - RTS frame generation function 1880 * @hw: pointer obtained from ieee80211_alloc_hw(). 1881 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 1882 * @frame: pointer to the frame that is going to be protected by the RTS. 1883 * @frame_len: the frame length (in octets). 1884 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1885 * @rts: The buffer where to store the RTS frame. 1886 * 1887 * If the RTS frames are generated by the host system (i.e., not in 1888 * hardware/firmware), the low-level driver uses this function to receive 1889 * the next RTS frame from the 802.11 code. The low-level is responsible 1890 * for calling this function before and RTS frame is needed. 1891 */ 1892void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1893 const void *frame, size_t frame_len, 1894 const struct ieee80211_tx_info *frame_txctl, 1895 struct ieee80211_rts *rts); 1896 1897/** 1898 * ieee80211_rts_duration - Get the duration field for an RTS frame 1899 * @hw: pointer obtained from ieee80211_alloc_hw(). 1900 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 1901 * @frame_len: the length of the frame that is going to be protected by the RTS. 1902 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1903 * 1904 * If the RTS is generated in firmware, but the host system must provide 1905 * the duration field, the low-level driver uses this function to receive 1906 * the duration field value in little-endian byteorder. 1907 */ 1908__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, 1909 struct ieee80211_vif *vif, size_t frame_len, 1910 const struct ieee80211_tx_info *frame_txctl); 1911 1912/** 1913 * ieee80211_ctstoself_get - CTS-to-self frame generation function 1914 * @hw: pointer obtained from ieee80211_alloc_hw(). 1915 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 1916 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 1917 * @frame_len: the frame length (in octets). 1918 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1919 * @cts: The buffer where to store the CTS-to-self frame. 1920 * 1921 * If the CTS-to-self frames are generated by the host system (i.e., not in 1922 * hardware/firmware), the low-level driver uses this function to receive 1923 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 1924 * for calling this function before and CTS-to-self frame is needed. 1925 */ 1926void ieee80211_ctstoself_get(struct ieee80211_hw *hw, 1927 struct ieee80211_vif *vif, 1928 const void *frame, size_t frame_len, 1929 const struct ieee80211_tx_info *frame_txctl, 1930 struct ieee80211_cts *cts); 1931 1932/** 1933 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 1934 * @hw: pointer obtained from ieee80211_alloc_hw(). 1935 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 1936 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 1937 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1938 * 1939 * If the CTS-to-self is generated in firmware, but the host system must provide 1940 * the duration field, the low-level driver uses this function to receive 1941 * the duration field value in little-endian byteorder. 1942 */ 1943__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, 1944 struct ieee80211_vif *vif, 1945 size_t frame_len, 1946 const struct ieee80211_tx_info *frame_txctl); 1947 1948/** 1949 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 1950 * @hw: pointer obtained from ieee80211_alloc_hw(). 1951 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 1952 * @frame_len: the length of the frame. 1953 * @rate: the rate at which the frame is going to be transmitted. 1954 * 1955 * Calculate the duration field of some generic frame, given its 1956 * length and transmission rate (in 100kbps). 1957 */ 1958__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, 1959 struct ieee80211_vif *vif, 1960 size_t frame_len, 1961 struct ieee80211_rate *rate); 1962 1963/** 1964 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 1965 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1966 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 1967 * 1968 * Function for accessing buffered broadcast and multicast frames. If 1969 * hardware/firmware does not implement buffering of broadcast/multicast 1970 * frames when power saving is used, 802.11 code buffers them in the host 1971 * memory. The low-level driver uses this function to fetch next buffered 1972 * frame. In most cases, this is used when generating beacon frame. This 1973 * function returns a pointer to the next buffered skb or NULL if no more 1974 * buffered frames are available. 1975 * 1976 * Note: buffered frames are returned only after DTIM beacon frame was 1977 * generated with ieee80211_beacon_get() and the low-level driver must thus 1978 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 1979 * NULL if the previous generated beacon was not DTIM, so the low-level driver 1980 * does not need to check for DTIM beacons separately and should be able to 1981 * use common code for all beacons. 1982 */ 1983struct sk_buff * 1984ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 1985 1986/** 1987 * ieee80211_get_tkip_key - get a TKIP rc4 for skb 1988 * 1989 * This function computes a TKIP rc4 key for an skb. It computes 1990 * a phase 1 key if needed (iv16 wraps around). This function is to 1991 * be used by drivers which can do HW encryption but need to compute 1992 * to phase 1/2 key in SW. 1993 * 1994 * @keyconf: the parameter passed with the set key 1995 * @skb: the skb for which the key is needed 1996 * @type: TBD 1997 * @key: a buffer to which the key will be written 1998 */ 1999void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf, 2000 struct sk_buff *skb, 2001 enum ieee80211_tkip_key_type type, u8 *key); 2002/** 2003 * ieee80211_wake_queue - wake specific queue 2004 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2005 * @queue: queue number (counted from zero). 2006 * 2007 * Drivers should use this function instead of netif_wake_queue. 2008 */ 2009void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 2010 2011/** 2012 * ieee80211_stop_queue - stop specific queue 2013 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2014 * @queue: queue number (counted from zero). 2015 * 2016 * Drivers should use this function instead of netif_stop_queue. 2017 */ 2018void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 2019 2020/** 2021 * ieee80211_queue_stopped - test status of the queue 2022 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2023 * @queue: queue number (counted from zero). 2024 * 2025 * Drivers should use this function instead of netif_stop_queue. 2026 */ 2027 2028int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); 2029 2030/** 2031 * ieee80211_stop_queues - stop all queues 2032 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2033 * 2034 * Drivers should use this function instead of netif_stop_queue. 2035 */ 2036void ieee80211_stop_queues(struct ieee80211_hw *hw); 2037 2038/** 2039 * ieee80211_wake_queues - wake all queues 2040 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2041 * 2042 * Drivers should use this function instead of netif_wake_queue. 2043 */ 2044void ieee80211_wake_queues(struct ieee80211_hw *hw); 2045 2046/** 2047 * ieee80211_scan_completed - completed hardware scan 2048 * 2049 * When hardware scan offload is used (i.e. the hw_scan() callback is 2050 * assigned) this function needs to be called by the driver to notify 2051 * mac80211 that the scan finished. 2052 * 2053 * @hw: the hardware that finished the scan 2054 * @aborted: set to true if scan was aborted 2055 */ 2056void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted); 2057 2058/** 2059 * ieee80211_iterate_active_interfaces - iterate active interfaces 2060 * 2061 * This function iterates over the interfaces associated with a given 2062 * hardware that are currently active and calls the callback for them. 2063 * This function allows the iterator function to sleep, when the iterator 2064 * function is atomic @ieee80211_iterate_active_interfaces_atomic can 2065 * be used. 2066 * 2067 * @hw: the hardware struct of which the interfaces should be iterated over 2068 * @iterator: the iterator function to call 2069 * @data: first argument of the iterator function 2070 */ 2071void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, 2072 void (*iterator)(void *data, u8 *mac, 2073 struct ieee80211_vif *vif), 2074 void *data); 2075 2076/** 2077 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces 2078 * 2079 * This function iterates over the interfaces associated with a given 2080 * hardware that are currently active and calls the callback for them. 2081 * This function requires the iterator callback function to be atomic, 2082 * if that is not desired, use @ieee80211_iterate_active_interfaces instead. 2083 * 2084 * @hw: the hardware struct of which the interfaces should be iterated over 2085 * @iterator: the iterator function to call, cannot sleep 2086 * @data: first argument of the iterator function 2087 */ 2088void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw, 2089 void (*iterator)(void *data, 2090 u8 *mac, 2091 struct ieee80211_vif *vif), 2092 void *data); 2093 2094/** 2095 * ieee80211_queue_work - add work onto the mac80211 workqueue 2096 * 2097 * Drivers and mac80211 use this to add work onto the mac80211 workqueue. 2098 * This helper ensures drivers are not queueing work when they should not be. 2099 * 2100 * @hw: the hardware struct for the interface we are adding work for 2101 * @work: the work we want to add onto the mac80211 workqueue 2102 */ 2103void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work); 2104 2105/** 2106 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue 2107 * 2108 * Drivers and mac80211 use this to queue delayed work onto the mac80211 2109 * workqueue. 2110 * 2111 * @hw: the hardware struct for the interface we are adding work for 2112 * @dwork: delayable work to queue onto the mac80211 workqueue 2113 * @delay: number of jiffies to wait before queueing 2114 */ 2115void ieee80211_queue_delayed_work(struct ieee80211_hw *hw, 2116 struct delayed_work *dwork, 2117 unsigned long delay); 2118 2119/** 2120 * ieee80211_start_tx_ba_session - Start a tx Block Ack session. 2121 * @sta: the station for which to start a BA session 2122 * @tid: the TID to BA on. 2123 * 2124 * Return: success if addBA request was sent, failure otherwise 2125 * 2126 * Although mac80211/low level driver/user space application can estimate 2127 * the need to start aggregation on a certain RA/TID, the session level 2128 * will be managed by the mac80211. 2129 */ 2130int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid); 2131 2132/** 2133 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate. 2134 * @vif: &struct ieee80211_vif pointer from the add_interface callback 2135 * @ra: receiver address of the BA session recipient. 2136 * @tid: the TID to BA on. 2137 * 2138 * This function must be called by low level driver once it has 2139 * finished with preparations for the BA session. 2140 */ 2141void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid); 2142 2143/** 2144 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate. 2145 * @vif: &struct ieee80211_vif pointer from the add_interface callback 2146 * @ra: receiver address of the BA session recipient. 2147 * @tid: the TID to BA on. 2148 * 2149 * This function must be called by low level driver once it has 2150 * finished with preparations for the BA session. 2151 * This version of the function is IRQ-safe. 2152 */ 2153void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, 2154 u16 tid); 2155 2156/** 2157 * ieee80211_stop_tx_ba_session - Stop a Block Ack session. 2158 * @sta: the station whose BA session to stop 2159 * @tid: the TID to stop BA. 2160 * @initiator: if indicates initiator DELBA frame will be sent. 2161 * 2162 * Return: error if no sta with matching da found, success otherwise 2163 * 2164 * Although mac80211/low level driver/user space application can estimate 2165 * the need to stop aggregation on a certain RA/TID, the session level 2166 * will be managed by the mac80211. 2167 */ 2168int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid, 2169 enum ieee80211_back_parties initiator); 2170 2171/** 2172 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate. 2173 * @vif: &struct ieee80211_vif pointer from the add_interface callback 2174 * @ra: receiver address of the BA session recipient. 2175 * @tid: the desired TID to BA on. 2176 * 2177 * This function must be called by low level driver once it has 2178 * finished with preparations for the BA session tear down. 2179 */ 2180void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid); 2181 2182/** 2183 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate. 2184 * @vif: &struct ieee80211_vif pointer from the add_interface callback 2185 * @ra: receiver address of the BA session recipient. 2186 * @tid: the desired TID to BA on. 2187 * 2188 * This function must be called by low level driver once it has 2189 * finished with preparations for the BA session tear down. 2190 * This version of the function is IRQ-safe. 2191 */ 2192void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, 2193 u16 tid); 2194 2195/** 2196 * ieee80211_find_sta - find a station 2197 * 2198 * @vif: virtual interface to look for station on 2199 * @addr: station's address 2200 * 2201 * This function must be called under RCU lock and the 2202 * resulting pointer is only valid under RCU lock as well. 2203 */ 2204struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif, 2205 const u8 *addr); 2206 2207/** 2208 * ieee80211_find_sta_by_hw - find a station on hardware 2209 * 2210 * @hw: pointer as obtained from ieee80211_alloc_hw() 2211 * @addr: station's address 2212 * 2213 * This function must be called under RCU lock and the 2214 * resulting pointer is only valid under RCU lock as well. 2215 * 2216 * NOTE: This function should not be used! When mac80211 is converted 2217 * internally to properly keep track of stations on multiple 2218 * virtual interfaces, it will not always know which station to 2219 * return here since a single address might be used by multiple 2220 * logical stations (e.g. consider a station connecting to another 2221 * BSSID on the same AP hardware without disconnecting first). 2222 * 2223 * DO NOT USE THIS FUNCTION. 2224 */ 2225struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw, 2226 const u8 *addr); 2227 2228/** 2229 * ieee80211_sta_block_awake - block station from waking up 2230 * @hw: the hardware 2231 * @pubsta: the station 2232 * @block: whether to block or unblock 2233 * 2234 * Some devices require that all frames that are on the queues 2235 * for a specific station that went to sleep are flushed before 2236 * a poll response or frames after the station woke up can be 2237 * delivered to that it. Note that such frames must be rejected 2238 * by the driver as filtered, with the appropriate status flag. 2239 * 2240 * This function allows implementing this mode in a race-free 2241 * manner. 2242 * 2243 * To do this, a driver must keep track of the number of frames 2244 * still enqueued for a specific station. If this number is not 2245 * zero when the station goes to sleep, the driver must call 2246 * this function to force mac80211 to consider the station to 2247 * be asleep regardless of the station's actual state. Once the 2248 * number of outstanding frames reaches zero, the driver must 2249 * call this function again to unblock the station. That will 2250 * cause mac80211 to be able to send ps-poll responses, and if 2251 * the station queried in the meantime then frames will also 2252 * be sent out as a result of this. Additionally, the driver 2253 * will be notified that the station woke up some time after 2254 * it is unblocked, regardless of whether the station actually 2255 * woke up while blocked or not. 2256 */ 2257void ieee80211_sta_block_awake(struct ieee80211_hw *hw, 2258 struct ieee80211_sta *pubsta, bool block); 2259 2260/** 2261 * ieee80211_beacon_loss - inform hardware does not receive beacons 2262 * 2263 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2264 * 2265 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and 2266 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the 2267 * hardware is not receiving beacons with this function. 2268 */ 2269void ieee80211_beacon_loss(struct ieee80211_vif *vif); 2270 2271/* Rate control API */ 2272 2273/** 2274 * enum rate_control_changed - flags to indicate which parameter changed 2275 * 2276 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have 2277 * changed, rate control algorithm can update its internal state if needed. 2278 */ 2279enum rate_control_changed { 2280 IEEE80211_RC_HT_CHANGED = BIT(0) 2281}; 2282 2283/** 2284 * struct ieee80211_tx_rate_control - rate control information for/from RC algo 2285 * 2286 * @hw: The hardware the algorithm is invoked for. 2287 * @sband: The band this frame is being transmitted on. 2288 * @bss_conf: the current BSS configuration 2289 * @reported_rate: The rate control algorithm can fill this in to indicate 2290 * which rate should be reported to userspace as the current rate and 2291 * used for rate calculations in the mesh network. 2292 * @rts: whether RTS will be used for this frame because it is longer than the 2293 * RTS threshold 2294 * @short_preamble: whether mac80211 will request short-preamble transmission 2295 * if the selected rate supports it 2296 * @max_rate_idx: user-requested maximum rate (not MCS for now) 2297 * @skb: the skb that will be transmitted, the control information in it needs 2298 * to be filled in 2299 */ 2300struct ieee80211_tx_rate_control { 2301 struct ieee80211_hw *hw; 2302 struct ieee80211_supported_band *sband; 2303 struct ieee80211_bss_conf *bss_conf; 2304 struct sk_buff *skb; 2305 struct ieee80211_tx_rate reported_rate; 2306 bool rts, short_preamble; 2307 u8 max_rate_idx; 2308}; 2309 2310struct rate_control_ops { 2311 struct module *module; 2312 const char *name; 2313 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir); 2314 void (*free)(void *priv); 2315 2316 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp); 2317 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband, 2318 struct ieee80211_sta *sta, void *priv_sta); 2319 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband, 2320 struct ieee80211_sta *sta, 2321 void *priv_sta, u32 changed); 2322 void (*free_sta)(void *priv, struct ieee80211_sta *sta, 2323 void *priv_sta); 2324 2325 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband, 2326 struct ieee80211_sta *sta, void *priv_sta, 2327 struct sk_buff *skb); 2328 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta, 2329 struct ieee80211_tx_rate_control *txrc); 2330 2331 void (*add_sta_debugfs)(void *priv, void *priv_sta, 2332 struct dentry *dir); 2333 void (*remove_sta_debugfs)(void *priv, void *priv_sta); 2334}; 2335 2336static inline int rate_supported(struct ieee80211_sta *sta, 2337 enum ieee80211_band band, 2338 int index) 2339{ 2340 return (sta == NULL || sta->supp_rates[band] & BIT(index)); 2341} 2342 2343/** 2344 * rate_control_send_low - helper for drivers for management/no-ack frames 2345 * 2346 * Rate control algorithms that agree to use the lowest rate to 2347 * send management frames and NO_ACK data with the respective hw 2348 * retries should use this in the beginning of their mac80211 get_rate 2349 * callback. If true is returned the rate control can simply return. 2350 * If false is returned we guarantee that sta and sta and priv_sta is 2351 * not null. 2352 * 2353 * Rate control algorithms wishing to do more intelligent selection of 2354 * rate for multicast/broadcast frames may choose to not use this. 2355 * 2356 * @sta: &struct ieee80211_sta pointer to the target destination. Note 2357 * that this may be null. 2358 * @priv_sta: private rate control structure. This may be null. 2359 * @txrc: rate control information we sholud populate for mac80211. 2360 */ 2361bool rate_control_send_low(struct ieee80211_sta *sta, 2362 void *priv_sta, 2363 struct ieee80211_tx_rate_control *txrc); 2364 2365 2366static inline s8 2367rate_lowest_index(struct ieee80211_supported_band *sband, 2368 struct ieee80211_sta *sta) 2369{ 2370 int i; 2371 2372 for (i = 0; i < sband->n_bitrates; i++) 2373 if (rate_supported(sta, sband->band, i)) 2374 return i; 2375 2376 /* warn when we cannot find a rate. */ 2377 WARN_ON(1); 2378 2379 return 0; 2380} 2381 2382static inline 2383bool rate_usable_index_exists(struct ieee80211_supported_band *sband, 2384 struct ieee80211_sta *sta) 2385{ 2386 unsigned int i; 2387 2388 for (i = 0; i < sband->n_bitrates; i++) 2389 if (rate_supported(sta, sband->band, i)) 2390 return true; 2391 return false; 2392} 2393 2394int ieee80211_rate_control_register(struct rate_control_ops *ops); 2395void ieee80211_rate_control_unregister(struct rate_control_ops *ops); 2396 2397static inline bool 2398conf_is_ht20(struct ieee80211_conf *conf) 2399{ 2400 return conf->channel_type == NL80211_CHAN_HT20; 2401} 2402 2403static inline bool 2404conf_is_ht40_minus(struct ieee80211_conf *conf) 2405{ 2406 return conf->channel_type == NL80211_CHAN_HT40MINUS; 2407} 2408 2409static inline bool 2410conf_is_ht40_plus(struct ieee80211_conf *conf) 2411{ 2412 return conf->channel_type == NL80211_CHAN_HT40PLUS; 2413} 2414 2415static inline bool 2416conf_is_ht40(struct ieee80211_conf *conf) 2417{ 2418 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf); 2419} 2420 2421static inline bool 2422conf_is_ht(struct ieee80211_conf *conf) 2423{ 2424 return conf->channel_type != NL80211_CHAN_NO_HT; 2425} 2426 2427#endif /* MAC80211_H */ 2428