mac80211.h revision 47846c9b0c10808d9337d2e7d09361f3e0a0a71a
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 */ 601enum ieee80211_conf_changed { 602 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2), 603 IEEE80211_CONF_CHANGE_MONITOR = BIT(3), 604 IEEE80211_CONF_CHANGE_PS = BIT(4), 605 IEEE80211_CONF_CHANGE_POWER = BIT(5), 606 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6), 607 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7), 608 IEEE80211_CONF_CHANGE_IDLE = BIT(8), 609}; 610 611/** 612 * struct ieee80211_conf - configuration of the device 613 * 614 * This struct indicates how the driver shall configure the hardware. 615 * 616 * @flags: configuration flags defined above 617 * 618 * @listen_interval: listen interval in units of beacon interval 619 * @max_sleep_period: the maximum number of beacon intervals to sleep for 620 * before checking the beacon for a TIM bit (managed mode only); this 621 * value will be only achievable between DTIM frames, the hardware 622 * needs to check for the multicast traffic bit in DTIM beacons. 623 * This variable is valid only when the CONF_PS flag is set. 624 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the 625 * powersave documentation below. This variable is valid only when 626 * the CONF_PS flag is set. 627 * 628 * @power_level: requested transmit power (in dBm) 629 * 630 * @channel: the channel to tune to 631 * @channel_type: the channel (HT) type 632 * 633 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame 634 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11, 635 * but actually means the number of transmissions not the number of retries 636 * @short_frame_max_tx_count: Maximum number of transmissions for a "short" 637 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the 638 * number of transmissions not the number of retries 639 */ 640struct ieee80211_conf { 641 u32 flags; 642 int power_level, dynamic_ps_timeout; 643 int max_sleep_period; 644 645 u16 listen_interval; 646 647 u8 long_frame_max_tx_count, short_frame_max_tx_count; 648 649 struct ieee80211_channel *channel; 650 enum nl80211_channel_type channel_type; 651}; 652 653/** 654 * struct ieee80211_vif - per-interface data 655 * 656 * Data in this structure is continually present for driver 657 * use during the life of a virtual interface. 658 * 659 * @type: type of this virtual interface 660 * @bss_conf: BSS configuration for this interface, either our own 661 * or the BSS we're associated to 662 * @addr: address of this interface 663 * @drv_priv: data area for driver use, will always be aligned to 664 * sizeof(void *). 665 */ 666struct ieee80211_vif { 667 enum nl80211_iftype type; 668 struct ieee80211_bss_conf bss_conf; 669 u8 addr[ETH_ALEN]; 670 /* must be last */ 671 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); 672}; 673 674static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif) 675{ 676#ifdef CONFIG_MAC80211_MESH 677 return vif->type == NL80211_IFTYPE_MESH_POINT; 678#endif 679 return false; 680} 681 682/** 683 * struct ieee80211_if_init_conf - initial configuration of an interface 684 * 685 * @vif: pointer to a driver-use per-interface structure. The pointer 686 * itself is also used for various functions including 687 * ieee80211_beacon_get() and ieee80211_get_buffered_bc(). 688 * @type: one of &enum nl80211_iftype constants. Determines the type of 689 * added/removed interface. 690 * @mac_addr: pointer to MAC address of the interface. This pointer is valid 691 * until the interface is removed (i.e. it cannot be used after 692 * remove_interface() callback was called for this interface). 693 * 694 * This structure is used in add_interface() and remove_interface() 695 * callbacks of &struct ieee80211_hw. 696 * 697 * When you allow multiple interfaces to be added to your PHY, take care 698 * that the hardware can actually handle multiple MAC addresses. However, 699 * also take care that when there's no interface left with mac_addr != %NULL 700 * you remove the MAC address from the device to avoid acknowledging packets 701 * in pure monitor mode. 702 */ 703struct ieee80211_if_init_conf { 704 enum nl80211_iftype type; 705 struct ieee80211_vif *vif; 706 void *mac_addr; 707}; 708 709/** 710 * enum ieee80211_key_alg - key algorithm 711 * @ALG_WEP: WEP40 or WEP104 712 * @ALG_TKIP: TKIP 713 * @ALG_CCMP: CCMP (AES) 714 * @ALG_AES_CMAC: AES-128-CMAC 715 */ 716enum ieee80211_key_alg { 717 ALG_WEP, 718 ALG_TKIP, 719 ALG_CCMP, 720 ALG_AES_CMAC, 721}; 722 723/** 724 * enum ieee80211_key_flags - key flags 725 * 726 * These flags are used for communication about keys between the driver 727 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. 728 * 729 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates 730 * that the STA this key will be used with could be using QoS. 731 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the 732 * driver to indicate that it requires IV generation for this 733 * particular key. 734 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by 735 * the driver for a TKIP key if it requires Michael MIC 736 * generation in software. 737 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates 738 * that the key is pairwise rather then a shared key. 739 * @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a 740 * CCMP key if it requires CCMP encryption of management frames (MFP) to 741 * be done in software. 742 */ 743enum ieee80211_key_flags { 744 IEEE80211_KEY_FLAG_WMM_STA = 1<<0, 745 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1, 746 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2, 747 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3, 748 IEEE80211_KEY_FLAG_SW_MGMT = 1<<4, 749}; 750 751/** 752 * struct ieee80211_key_conf - key information 753 * 754 * This key information is given by mac80211 to the driver by 755 * the set_key() callback in &struct ieee80211_ops. 756 * 757 * @hw_key_idx: To be set by the driver, this is the key index the driver 758 * wants to be given when a frame is transmitted and needs to be 759 * encrypted in hardware. 760 * @alg: The key algorithm. 761 * @flags: key flags, see &enum ieee80211_key_flags. 762 * @keyidx: the key index (0-3) 763 * @keylen: key material length 764 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte) 765 * data block: 766 * - Temporal Encryption Key (128 bits) 767 * - Temporal Authenticator Tx MIC Key (64 bits) 768 * - Temporal Authenticator Rx MIC Key (64 bits) 769 * @icv_len: The ICV length for this key type 770 * @iv_len: The IV length for this key type 771 */ 772struct ieee80211_key_conf { 773 enum ieee80211_key_alg alg; 774 u8 icv_len; 775 u8 iv_len; 776 u8 hw_key_idx; 777 u8 flags; 778 s8 keyidx; 779 u8 keylen; 780 u8 key[0]; 781}; 782 783/** 784 * enum set_key_cmd - key command 785 * 786 * Used with the set_key() callback in &struct ieee80211_ops, this 787 * indicates whether a key is being removed or added. 788 * 789 * @SET_KEY: a key is set 790 * @DISABLE_KEY: a key must be disabled 791 */ 792enum set_key_cmd { 793 SET_KEY, DISABLE_KEY, 794}; 795 796/** 797 * struct ieee80211_sta - station table entry 798 * 799 * A station table entry represents a station we are possibly 800 * communicating with. Since stations are RCU-managed in 801 * mac80211, any ieee80211_sta pointer you get access to must 802 * either be protected by rcu_read_lock() explicitly or implicitly, 803 * or you must take good care to not use such a pointer after a 804 * call to your sta_notify callback that removed it. 805 * 806 * @addr: MAC address 807 * @aid: AID we assigned to the station if we're an AP 808 * @supp_rates: Bitmap of supported rates (per band) 809 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities 810 * @drv_priv: data area for driver use, will always be aligned to 811 * sizeof(void *), size is determined in hw information. 812 */ 813struct ieee80211_sta { 814 u32 supp_rates[IEEE80211_NUM_BANDS]; 815 u8 addr[ETH_ALEN]; 816 u16 aid; 817 struct ieee80211_sta_ht_cap ht_cap; 818 819 /* must be last */ 820 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); 821}; 822 823/** 824 * enum sta_notify_cmd - sta notify command 825 * 826 * Used with the sta_notify() callback in &struct ieee80211_ops, this 827 * indicates addition and removal of a station to station table, 828 * or if a associated station made a power state transition. 829 * 830 * @STA_NOTIFY_ADD: a station was added to the station table 831 * @STA_NOTIFY_REMOVE: a station being removed from the station table 832 * @STA_NOTIFY_SLEEP: a station is now sleeping 833 * @STA_NOTIFY_AWAKE: a sleeping station woke up 834 */ 835enum sta_notify_cmd { 836 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE, 837 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE, 838}; 839 840/** 841 * enum ieee80211_tkip_key_type - get tkip key 842 * 843 * Used by drivers which need to get a tkip key for skb. Some drivers need a 844 * phase 1 key, others need a phase 2 key. A single function allows the driver 845 * to get the key, this enum indicates what type of key is required. 846 * 847 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key 848 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key 849 */ 850enum ieee80211_tkip_key_type { 851 IEEE80211_TKIP_P1_KEY, 852 IEEE80211_TKIP_P2_KEY, 853}; 854 855/** 856 * enum ieee80211_hw_flags - hardware flags 857 * 858 * These flags are used to indicate hardware capabilities to 859 * the stack. Generally, flags here should have their meaning 860 * done in a way that the simplest hardware doesn't need setting 861 * any particular flags. There are some exceptions to this rule, 862 * however, so you are advised to review these flags carefully. 863 * 864 * @IEEE80211_HW_HAS_RATE_CONTROL: 865 * The hardware or firmware includes rate control, and cannot be 866 * controlled by the stack. As such, no rate control algorithm 867 * should be instantiated, and the TX rate reported to userspace 868 * will be taken from the TX status instead of the rate control 869 * algorithm. 870 * Note that this requires that the driver implement a number of 871 * callbacks so it has the correct information, it needs to have 872 * the @set_rts_threshold callback and must look at the BSS config 873 * @use_cts_prot for G/N protection, @use_short_slot for slot 874 * timing in 2.4 GHz and @use_short_preamble for preambles for 875 * CCK frames. 876 * 877 * @IEEE80211_HW_RX_INCLUDES_FCS: 878 * Indicates that received frames passed to the stack include 879 * the FCS at the end. 880 * 881 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 882 * Some wireless LAN chipsets buffer broadcast/multicast frames 883 * for power saving stations in the hardware/firmware and others 884 * rely on the host system for such buffering. This option is used 885 * to configure the IEEE 802.11 upper layer to buffer broadcast and 886 * multicast frames when there are power saving stations so that 887 * the driver can fetch them with ieee80211_get_buffered_bc(). 888 * 889 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE: 890 * Hardware is not capable of short slot operation on the 2.4 GHz band. 891 * 892 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE: 893 * Hardware is not capable of receiving frames with short preamble on 894 * the 2.4 GHz band. 895 * 896 * @IEEE80211_HW_SIGNAL_UNSPEC: 897 * Hardware can provide signal values but we don't know its units. We 898 * expect values between 0 and @max_signal. 899 * If possible please provide dB or dBm instead. 900 * 901 * @IEEE80211_HW_SIGNAL_DBM: 902 * Hardware gives signal values in dBm, decibel difference from 903 * one milliwatt. This is the preferred method since it is standardized 904 * between different devices. @max_signal does not need to be set. 905 * 906 * @IEEE80211_HW_NOISE_DBM: 907 * Hardware can provide noise (radio interference) values in units dBm, 908 * decibel difference from one milliwatt. 909 * 910 * @IEEE80211_HW_SPECTRUM_MGMT: 911 * Hardware supports spectrum management defined in 802.11h 912 * Measurement, Channel Switch, Quieting, TPC 913 * 914 * @IEEE80211_HW_AMPDU_AGGREGATION: 915 * Hardware supports 11n A-MPDU aggregation. 916 * 917 * @IEEE80211_HW_SUPPORTS_PS: 918 * Hardware has power save support (i.e. can go to sleep). 919 * 920 * @IEEE80211_HW_PS_NULLFUNC_STACK: 921 * Hardware requires nullfunc frame handling in stack, implies 922 * stack support for dynamic PS. 923 * 924 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS: 925 * Hardware has support for dynamic PS. 926 * 927 * @IEEE80211_HW_MFP_CAPABLE: 928 * Hardware supports management frame protection (MFP, IEEE 802.11w). 929 * 930 * @IEEE80211_HW_BEACON_FILTER: 931 * Hardware supports dropping of irrelevant beacon frames to 932 * avoid waking up cpu. 933 */ 934enum ieee80211_hw_flags { 935 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0, 936 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, 937 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, 938 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3, 939 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4, 940 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5, 941 IEEE80211_HW_SIGNAL_DBM = 1<<6, 942 IEEE80211_HW_NOISE_DBM = 1<<7, 943 IEEE80211_HW_SPECTRUM_MGMT = 1<<8, 944 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9, 945 IEEE80211_HW_SUPPORTS_PS = 1<<10, 946 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11, 947 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12, 948 IEEE80211_HW_MFP_CAPABLE = 1<<13, 949 IEEE80211_HW_BEACON_FILTER = 1<<14, 950}; 951 952/** 953 * struct ieee80211_hw - hardware information and state 954 * 955 * This structure contains the configuration and hardware 956 * information for an 802.11 PHY. 957 * 958 * @wiphy: This points to the &struct wiphy allocated for this 959 * 802.11 PHY. You must fill in the @perm_addr and @dev 960 * members of this structure using SET_IEEE80211_DEV() 961 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported 962 * bands (with channels, bitrates) are registered here. 963 * 964 * @conf: &struct ieee80211_conf, device configuration, don't use. 965 * 966 * @priv: pointer to private area that was allocated for driver use 967 * along with this structure. 968 * 969 * @flags: hardware flags, see &enum ieee80211_hw_flags. 970 * 971 * @extra_tx_headroom: headroom to reserve in each transmit skb 972 * for use by the driver (e.g. for transmit headers.) 973 * 974 * @channel_change_time: time (in microseconds) it takes to change channels. 975 * 976 * @max_signal: Maximum value for signal (rssi) in RX information, used 977 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB 978 * 979 * @max_listen_interval: max listen interval in units of beacon interval 980 * that HW supports 981 * 982 * @queues: number of available hardware transmit queues for 983 * data packets. WMM/QoS requires at least four, these 984 * queues need to have configurable access parameters. 985 * 986 * @rate_control_algorithm: rate control algorithm for this hardware. 987 * If unset (NULL), the default algorithm will be used. Must be 988 * set before calling ieee80211_register_hw(). 989 * 990 * @vif_data_size: size (in bytes) of the drv_priv data area 991 * within &struct ieee80211_vif. 992 * @sta_data_size: size (in bytes) of the drv_priv data area 993 * within &struct ieee80211_sta. 994 * 995 * @max_rates: maximum number of alternate rate retry stages 996 * @max_rate_tries: maximum number of tries for each stage 997 */ 998struct ieee80211_hw { 999 struct ieee80211_conf conf; 1000 struct wiphy *wiphy; 1001 const char *rate_control_algorithm; 1002 void *priv; 1003 u32 flags; 1004 unsigned int extra_tx_headroom; 1005 int channel_change_time; 1006 int vif_data_size; 1007 int sta_data_size; 1008 u16 queues; 1009 u16 max_listen_interval; 1010 s8 max_signal; 1011 u8 max_rates; 1012 u8 max_rate_tries; 1013}; 1014 1015/** 1016 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy 1017 * 1018 * @wiphy: the &struct wiphy which we want to query 1019 * 1020 * mac80211 drivers can use this to get to their respective 1021 * &struct ieee80211_hw. Drivers wishing to get to their own private 1022 * structure can then access it via hw->priv. Note that mac802111 drivers should 1023 * not use wiphy_priv() to try to get their private driver structure as this 1024 * is already used internally by mac80211. 1025 */ 1026struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy); 1027 1028/** 1029 * SET_IEEE80211_DEV - set device for 802.11 hardware 1030 * 1031 * @hw: the &struct ieee80211_hw to set the device for 1032 * @dev: the &struct device of this 802.11 device 1033 */ 1034static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 1035{ 1036 set_wiphy_dev(hw->wiphy, dev); 1037} 1038 1039/** 1040 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware 1041 * 1042 * @hw: the &struct ieee80211_hw to set the MAC address for 1043 * @addr: the address to set 1044 */ 1045static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 1046{ 1047 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 1048} 1049 1050static inline struct ieee80211_rate * 1051ieee80211_get_tx_rate(const struct ieee80211_hw *hw, 1052 const struct ieee80211_tx_info *c) 1053{ 1054 if (WARN_ON(c->control.rates[0].idx < 0)) 1055 return NULL; 1056 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx]; 1057} 1058 1059static inline struct ieee80211_rate * 1060ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw, 1061 const struct ieee80211_tx_info *c) 1062{ 1063 if (c->control.rts_cts_rate_idx < 0) 1064 return NULL; 1065 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx]; 1066} 1067 1068static inline struct ieee80211_rate * 1069ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw, 1070 const struct ieee80211_tx_info *c, int idx) 1071{ 1072 if (c->control.rates[idx + 1].idx < 0) 1073 return NULL; 1074 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx]; 1075} 1076 1077/** 1078 * DOC: Hardware crypto acceleration 1079 * 1080 * mac80211 is capable of taking advantage of many hardware 1081 * acceleration designs for encryption and decryption operations. 1082 * 1083 * The set_key() callback in the &struct ieee80211_ops for a given 1084 * device is called to enable hardware acceleration of encryption and 1085 * decryption. The callback takes a @sta parameter that will be NULL 1086 * for default keys or keys used for transmission only, or point to 1087 * the station information for the peer for individual keys. 1088 * Multiple transmission keys with the same key index may be used when 1089 * VLANs are configured for an access point. 1090 * 1091 * When transmitting, the TX control data will use the @hw_key_idx 1092 * selected by the driver by modifying the &struct ieee80211_key_conf 1093 * pointed to by the @key parameter to the set_key() function. 1094 * 1095 * The set_key() call for the %SET_KEY command should return 0 if 1096 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 1097 * added; if you return 0 then hw_key_idx must be assigned to the 1098 * hardware key index, you are free to use the full u8 range. 1099 * 1100 * When the cmd is %DISABLE_KEY then it must succeed. 1101 * 1102 * Note that it is permissible to not decrypt a frame even if a key 1103 * for it has been uploaded to hardware, the stack will not make any 1104 * decision based on whether a key has been uploaded or not but rather 1105 * based on the receive flags. 1106 * 1107 * The &struct ieee80211_key_conf structure pointed to by the @key 1108 * parameter is guaranteed to be valid until another call to set_key() 1109 * removes it, but it can only be used as a cookie to differentiate 1110 * keys. 1111 * 1112 * In TKIP some HW need to be provided a phase 1 key, for RX decryption 1113 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key 1114 * handler. 1115 * The update_tkip_key() call updates the driver with the new phase 1 key. 1116 * This happens everytime the iv16 wraps around (every 65536 packets). The 1117 * set_key() call will happen only once for each key (unless the AP did 1118 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is 1119 * provided by update_tkip_key only. The trigger that makes mac80211 call this 1120 * handler is software decryption with wrap around of iv16. 1121 */ 1122 1123/** 1124 * DOC: Powersave support 1125 * 1126 * mac80211 has support for various powersave implementations. 1127 * 1128 * First, it can support hardware that handles all powersaving by 1129 * itself, such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS 1130 * hardware flag. In that case, it will be told about the desired 1131 * powersave mode depending on the association status, and the driver 1132 * must take care of sending nullfunc frames when necessary, i.e. when 1133 * entering and leaving powersave mode. The driver is required to look at 1134 * the AID in beacons and signal to the AP that it woke up when it finds 1135 * traffic directed to it. This mode supports dynamic PS by simply 1136 * enabling/disabling PS. 1137 * 1138 * Additionally, such hardware may set the %IEEE80211_HW_SUPPORTS_DYNAMIC_PS 1139 * flag to indicate that it can support dynamic PS mode itself (see below). 1140 * 1141 * Other hardware designs cannot send nullfunc frames by themselves and also 1142 * need software support for parsing the TIM bitmap. This is also supported 1143 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and 1144 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still 1145 * required to pass up beacons. The hardware is still required to handle 1146 * waking up for multicast traffic; if it cannot the driver must handle that 1147 * as best as it can, mac80211 is too slow. 1148 * 1149 * Dynamic powersave mode is an extension to normal powersave mode in which 1150 * the hardware stays awake for a user-specified period of time after sending 1151 * a frame so that reply frames need not be buffered and therefore delayed 1152 * to the next wakeup. This can either be supported by hardware, in which case 1153 * the driver needs to look at the @dynamic_ps_timeout hardware configuration 1154 * value, or by the stack if all nullfunc handling is in the stack. 1155 */ 1156 1157/** 1158 * DOC: Beacon filter support 1159 * 1160 * Some hardware have beacon filter support to reduce host cpu wakeups 1161 * which will reduce system power consumption. It usuallly works so that 1162 * the firmware creates a checksum of the beacon but omits all constantly 1163 * changing elements (TSF, TIM etc). Whenever the checksum changes the 1164 * beacon is forwarded to the host, otherwise it will be just dropped. That 1165 * way the host will only receive beacons where some relevant information 1166 * (for example ERP protection or WMM settings) have changed. 1167 * 1168 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER 1169 * hardware capability. The driver needs to enable beacon filter support 1170 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When 1171 * power save is enabled, the stack will not check for beacon loss and the 1172 * driver needs to notify about loss of beacons with ieee80211_beacon_loss(). 1173 * 1174 * The time (or number of beacons missed) until the firmware notifies the 1175 * driver of a beacon loss event (which in turn causes the driver to call 1176 * ieee80211_beacon_loss()) should be configurable and will be controlled 1177 * by mac80211 and the roaming algorithm in the future. 1178 * 1179 * Since there may be constantly changing information elements that nothing 1180 * in the software stack cares about, we will, in the future, have mac80211 1181 * tell the driver which information elements are interesting in the sense 1182 * that we want to see changes in them. This will include 1183 * - a list of information element IDs 1184 * - a list of OUIs for the vendor information element 1185 * 1186 * Ideally, the hardware would filter out any beacons without changes in the 1187 * requested elements, but if it cannot support that it may, at the expense 1188 * of some efficiency, filter out only a subset. For example, if the device 1189 * doesn't support checking for OUIs it should pass up all changes in all 1190 * vendor information elements. 1191 * 1192 * Note that change, for the sake of simplification, also includes information 1193 * elements appearing or disappearing from the beacon. 1194 * 1195 * Some hardware supports an "ignore list" instead, just make sure nothing 1196 * that was requested is on the ignore list, and include commonly changing 1197 * information element IDs in the ignore list, for example 11 (BSS load) and 1198 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136, 1199 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility 1200 * it could also include some currently unused IDs. 1201 * 1202 * 1203 * In addition to these capabilities, hardware should support notifying the 1204 * host of changes in the beacon RSSI. This is relevant to implement roaming 1205 * when no traffic is flowing (when traffic is flowing we see the RSSI of 1206 * the received data packets). This can consist in notifying the host when 1207 * the RSSI changes significantly or when it drops below or rises above 1208 * configurable thresholds. In the future these thresholds will also be 1209 * configured by mac80211 (which gets them from userspace) to implement 1210 * them as the roaming algorithm requires. 1211 * 1212 * If the hardware cannot implement this, the driver should ask it to 1213 * periodically pass beacon frames to the host so that software can do the 1214 * signal strength threshold checking. 1215 */ 1216 1217/** 1218 * DOC: Frame filtering 1219 * 1220 * mac80211 requires to see many management frames for proper 1221 * operation, and users may want to see many more frames when 1222 * in monitor mode. However, for best CPU usage and power consumption, 1223 * having as few frames as possible percolate through the stack is 1224 * desirable. Hence, the hardware should filter as much as possible. 1225 * 1226 * To achieve this, mac80211 uses filter flags (see below) to tell 1227 * the driver's configure_filter() function which frames should be 1228 * passed to mac80211 and which should be filtered out. 1229 * 1230 * Before configure_filter() is invoked, the prepare_multicast() 1231 * callback is invoked with the parameters @mc_count and @mc_list 1232 * for the combined multicast address list of all virtual interfaces. 1233 * It's use is optional, and it returns a u64 that is passed to 1234 * configure_filter(). Additionally, configure_filter() has the 1235 * arguments @changed_flags telling which flags were changed and 1236 * @total_flags with the new flag states. 1237 * 1238 * If your device has no multicast address filters your driver will 1239 * need to check both the %FIF_ALLMULTI flag and the @mc_count 1240 * parameter to see whether multicast frames should be accepted 1241 * or dropped. 1242 * 1243 * All unsupported flags in @total_flags must be cleared. 1244 * Hardware does not support a flag if it is incapable of _passing_ 1245 * the frame to the stack. Otherwise the driver must ignore 1246 * the flag, but not clear it. 1247 * You must _only_ clear the flag (announce no support for the 1248 * flag to mac80211) if you are not able to pass the packet type 1249 * to the stack (so the hardware always filters it). 1250 * So for example, you should clear @FIF_CONTROL, if your hardware 1251 * always filters control frames. If your hardware always passes 1252 * control frames to the kernel and is incapable of filtering them, 1253 * you do _not_ clear the @FIF_CONTROL flag. 1254 * This rule applies to all other FIF flags as well. 1255 */ 1256 1257/** 1258 * enum ieee80211_filter_flags - hardware filter flags 1259 * 1260 * These flags determine what the filter in hardware should be 1261 * programmed to let through and what should not be passed to the 1262 * stack. It is always safe to pass more frames than requested, 1263 * but this has negative impact on power consumption. 1264 * 1265 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, 1266 * think of the BSS as your network segment and then this corresponds 1267 * to the regular ethernet device promiscuous mode. 1268 * 1269 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 1270 * by the user or if the hardware is not capable of filtering by 1271 * multicast address. 1272 * 1273 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 1274 * %RX_FLAG_FAILED_FCS_CRC for them) 1275 * 1276 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 1277 * the %RX_FLAG_FAILED_PLCP_CRC for them 1278 * 1279 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 1280 * to the hardware that it should not filter beacons or probe responses 1281 * by BSSID. Filtering them can greatly reduce the amount of processing 1282 * mac80211 needs to do and the amount of CPU wakeups, so you should 1283 * honour this flag if possible. 1284 * 1285 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS 1286 * is not set then only those addressed to this station. 1287 * 1288 * @FIF_OTHER_BSS: pass frames destined to other BSSes 1289 * 1290 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only 1291 * those addressed to this station. 1292 */ 1293enum ieee80211_filter_flags { 1294 FIF_PROMISC_IN_BSS = 1<<0, 1295 FIF_ALLMULTI = 1<<1, 1296 FIF_FCSFAIL = 1<<2, 1297 FIF_PLCPFAIL = 1<<3, 1298 FIF_BCN_PRBRESP_PROMISC = 1<<4, 1299 FIF_CONTROL = 1<<5, 1300 FIF_OTHER_BSS = 1<<6, 1301 FIF_PSPOLL = 1<<7, 1302}; 1303 1304/** 1305 * enum ieee80211_ampdu_mlme_action - A-MPDU actions 1306 * 1307 * These flags are used with the ampdu_action() callback in 1308 * &struct ieee80211_ops to indicate which action is needed. 1309 * 1310 * Note that drivers MUST be able to deal with a TX aggregation 1311 * session being stopped even before they OK'ed starting it by 1312 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer 1313 * might receive the addBA frame and send a delBA right away! 1314 * 1315 * @IEEE80211_AMPDU_RX_START: start Rx aggregation 1316 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation 1317 * @IEEE80211_AMPDU_TX_START: start Tx aggregation 1318 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation 1319 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational 1320 */ 1321enum ieee80211_ampdu_mlme_action { 1322 IEEE80211_AMPDU_RX_START, 1323 IEEE80211_AMPDU_RX_STOP, 1324 IEEE80211_AMPDU_TX_START, 1325 IEEE80211_AMPDU_TX_STOP, 1326 IEEE80211_AMPDU_TX_OPERATIONAL, 1327}; 1328 1329/** 1330 * struct ieee80211_ops - callbacks from mac80211 to the driver 1331 * 1332 * This structure contains various callbacks that the driver may 1333 * handle or, in some cases, must handle, for example to configure 1334 * the hardware to a new channel or to transmit a frame. 1335 * 1336 * @tx: Handler that 802.11 module calls for each transmitted frame. 1337 * skb contains the buffer starting from the IEEE 802.11 header. 1338 * The low-level driver should send the frame out based on 1339 * configuration in the TX control data. This handler should, 1340 * preferably, never fail and stop queues appropriately, more 1341 * importantly, however, it must never fail for A-MPDU-queues. 1342 * This function should return NETDEV_TX_OK except in very 1343 * limited cases. 1344 * Must be implemented and atomic. 1345 * 1346 * @start: Called before the first netdevice attached to the hardware 1347 * is enabled. This should turn on the hardware and must turn on 1348 * frame reception (for possibly enabled monitor interfaces.) 1349 * Returns negative error codes, these may be seen in userspace, 1350 * or zero. 1351 * When the device is started it should not have a MAC address 1352 * to avoid acknowledging frames before a non-monitor device 1353 * is added. 1354 * Must be implemented. 1355 * 1356 * @stop: Called after last netdevice attached to the hardware 1357 * is disabled. This should turn off the hardware (at least 1358 * it must turn off frame reception.) 1359 * May be called right after add_interface if that rejects 1360 * an interface. If you added any work onto the mac80211 workqueue 1361 * you should ensure to cancel it on this callback. 1362 * Must be implemented. 1363 * 1364 * @add_interface: Called when a netdevice attached to the hardware is 1365 * enabled. Because it is not called for monitor mode devices, @start 1366 * and @stop must be implemented. 1367 * The driver should perform any initialization it needs before 1368 * the device can be enabled. The initial configuration for the 1369 * interface is given in the conf parameter. 1370 * The callback may refuse to add an interface by returning a 1371 * negative error code (which will be seen in userspace.) 1372 * Must be implemented. 1373 * 1374 * @remove_interface: Notifies a driver that an interface is going down. 1375 * The @stop callback is called after this if it is the last interface 1376 * and no monitor interfaces are present. 1377 * When all interfaces are removed, the MAC address in the hardware 1378 * must be cleared so the device no longer acknowledges packets, 1379 * the mac_addr member of the conf structure is, however, set to the 1380 * MAC address of the device going away. 1381 * Hence, this callback must be implemented. 1382 * 1383 * @config: Handler for configuration requests. IEEE 802.11 code calls this 1384 * function to change hardware configuration, e.g., channel. 1385 * This function should never fail but returns a negative error code 1386 * if it does. 1387 * 1388 * @bss_info_changed: Handler for configuration requests related to BSS 1389 * parameters that may vary during BSS's lifespan, and may affect low 1390 * level driver (e.g. assoc/disassoc status, erp parameters). 1391 * This function should not be used if no BSS has been set, unless 1392 * for association indication. The @changed parameter indicates which 1393 * of the bss parameters has changed when a call is made. 1394 * 1395 * @prepare_multicast: Prepare for multicast filter configuration. 1396 * This callback is optional, and its return value is passed 1397 * to configure_filter(). This callback must be atomic. 1398 * 1399 * @configure_filter: Configure the device's RX filter. 1400 * See the section "Frame filtering" for more information. 1401 * This callback must be implemented. 1402 * 1403 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit 1404 * must be set or cleared for a given STA. Must be atomic. 1405 * 1406 * @set_key: See the section "Hardware crypto acceleration" 1407 * This callback can sleep, and is only called between add_interface 1408 * and remove_interface calls, i.e. while the given virtual interface 1409 * is enabled. 1410 * Returns a negative error code if the key can't be added. 1411 * 1412 * @update_tkip_key: See the section "Hardware crypto acceleration" 1413 * This callback will be called in the context of Rx. Called for drivers 1414 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY. 1415 * 1416 * @hw_scan: Ask the hardware to service the scan request, no need to start 1417 * the scan state machine in stack. The scan must honour the channel 1418 * configuration done by the regulatory agent in the wiphy's 1419 * registered bands. The hardware (or the driver) needs to make sure 1420 * that power save is disabled. 1421 * The @req ie/ie_len members are rewritten by mac80211 to contain the 1422 * entire IEs after the SSID, so that drivers need not look at these 1423 * at all but just send them after the SSID -- mac80211 includes the 1424 * (extended) supported rates and HT information (where applicable). 1425 * When the scan finishes, ieee80211_scan_completed() must be called; 1426 * note that it also must be called when the scan cannot finish due to 1427 * any error unless this callback returned a negative error code. 1428 * 1429 * @sw_scan_start: Notifier function that is called just before a software scan 1430 * is started. Can be NULL, if the driver doesn't need this notification. 1431 * 1432 * @sw_scan_complete: Notifier function that is called just after a software scan 1433 * finished. Can be NULL, if the driver doesn't need this notification. 1434 * 1435 * @get_stats: Return low-level statistics. 1436 * Returns zero if statistics are available. 1437 * 1438 * @get_tkip_seq: If your device implements TKIP encryption in hardware this 1439 * callback should be provided to read the TKIP transmit IVs (both IV32 1440 * and IV16) for the given key from hardware. 1441 * 1442 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 1443 * 1444 * @sta_notify: Notifies low level driver about addition, removal or power 1445 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc. 1446 * Must be atomic. 1447 * 1448 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 1449 * bursting) for a hardware TX queue. 1450 * Returns a negative error code on failure. 1451 * 1452 * @get_tx_stats: Get statistics of the current TX queue status. This is used 1453 * to get number of currently queued packets (queue length), maximum queue 1454 * size (limit), and total number of packets sent using each TX queue 1455 * (count). The 'stats' pointer points to an array that has hw->queues 1456 * items. 1457 * 1458 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 1459 * this is only used for IBSS mode BSSID merging and debugging. Is not a 1460 * required function. 1461 * 1462 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware. 1463 * Currently, this is only used for IBSS mode debugging. Is not a 1464 * required function. 1465 * 1466 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 1467 * with other STAs in the IBSS. This is only used in IBSS mode. This 1468 * function is optional if the firmware/hardware takes full care of 1469 * TSF synchronization. 1470 * 1471 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 1472 * This is needed only for IBSS mode and the result of this function is 1473 * used to determine whether to reply to Probe Requests. 1474 * Returns non-zero if this device sent the last beacon. 1475 * 1476 * @ampdu_action: Perform a certain A-MPDU action 1477 * The RA/TID combination determines the destination and TID we want 1478 * the ampdu action to be performed for. The action is defined through 1479 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn) 1480 * is the first frame we expect to perform the action on. Notice 1481 * that TX/RX_STOP can pass NULL for this parameter. 1482 * Returns a negative error code on failure. 1483 * 1484 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also 1485 * need to set wiphy->rfkill_poll to %true before registration, 1486 * and need to call wiphy_rfkill_set_hw_state() in the callback. 1487 * 1488 * @testmode_cmd: Implement a cfg80211 test mode command. 1489 */ 1490struct ieee80211_ops { 1491 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb); 1492 int (*start)(struct ieee80211_hw *hw); 1493 void (*stop)(struct ieee80211_hw *hw); 1494 int (*add_interface)(struct ieee80211_hw *hw, 1495 struct ieee80211_if_init_conf *conf); 1496 void (*remove_interface)(struct ieee80211_hw *hw, 1497 struct ieee80211_if_init_conf *conf); 1498 int (*config)(struct ieee80211_hw *hw, u32 changed); 1499 void (*bss_info_changed)(struct ieee80211_hw *hw, 1500 struct ieee80211_vif *vif, 1501 struct ieee80211_bss_conf *info, 1502 u32 changed); 1503 u64 (*prepare_multicast)(struct ieee80211_hw *hw, 1504 int mc_count, struct dev_addr_list *mc_list); 1505 void (*configure_filter)(struct ieee80211_hw *hw, 1506 unsigned int changed_flags, 1507 unsigned int *total_flags, 1508 u64 multicast); 1509 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 1510 bool set); 1511 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, 1512 struct ieee80211_vif *vif, struct ieee80211_sta *sta, 1513 struct ieee80211_key_conf *key); 1514 void (*update_tkip_key)(struct ieee80211_hw *hw, 1515 struct ieee80211_key_conf *conf, const u8 *address, 1516 u32 iv32, u16 *phase1key); 1517 int (*hw_scan)(struct ieee80211_hw *hw, 1518 struct cfg80211_scan_request *req); 1519 void (*sw_scan_start)(struct ieee80211_hw *hw); 1520 void (*sw_scan_complete)(struct ieee80211_hw *hw); 1521 int (*get_stats)(struct ieee80211_hw *hw, 1522 struct ieee80211_low_level_stats *stats); 1523 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx, 1524 u32 *iv32, u16 *iv16); 1525 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 1526 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1527 enum sta_notify_cmd, struct ieee80211_sta *sta); 1528 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue, 1529 const struct ieee80211_tx_queue_params *params); 1530 int (*get_tx_stats)(struct ieee80211_hw *hw, 1531 struct ieee80211_tx_queue_stats *stats); 1532 u64 (*get_tsf)(struct ieee80211_hw *hw); 1533 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf); 1534 void (*reset_tsf)(struct ieee80211_hw *hw); 1535 int (*tx_last_beacon)(struct ieee80211_hw *hw); 1536 int (*ampdu_action)(struct ieee80211_hw *hw, 1537 struct ieee80211_vif *vif, 1538 enum ieee80211_ampdu_mlme_action action, 1539 struct ieee80211_sta *sta, u16 tid, u16 *ssn); 1540 1541 void (*rfkill_poll)(struct ieee80211_hw *hw); 1542#ifdef CONFIG_NL80211_TESTMODE 1543 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len); 1544#endif 1545}; 1546 1547/** 1548 * ieee80211_alloc_hw - Allocate a new hardware device 1549 * 1550 * This must be called once for each hardware device. The returned pointer 1551 * must be used to refer to this device when calling other functions. 1552 * mac80211 allocates a private data area for the driver pointed to by 1553 * @priv in &struct ieee80211_hw, the size of this area is given as 1554 * @priv_data_len. 1555 * 1556 * @priv_data_len: length of private data 1557 * @ops: callbacks for this device 1558 */ 1559struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 1560 const struct ieee80211_ops *ops); 1561 1562/** 1563 * ieee80211_register_hw - Register hardware device 1564 * 1565 * You must call this function before any other functions in 1566 * mac80211. Note that before a hardware can be registered, you 1567 * need to fill the contained wiphy's information. 1568 * 1569 * @hw: the device to register as returned by ieee80211_alloc_hw() 1570 */ 1571int ieee80211_register_hw(struct ieee80211_hw *hw); 1572 1573#ifdef CONFIG_MAC80211_LEDS 1574extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 1575extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 1576extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); 1577extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw); 1578#endif 1579/** 1580 * ieee80211_get_tx_led_name - get name of TX LED 1581 * 1582 * mac80211 creates a transmit LED trigger for each wireless hardware 1583 * that can be used to drive LEDs if your driver registers a LED device. 1584 * This function returns the name (or %NULL if not configured for LEDs) 1585 * of the trigger so you can automatically link the LED device. 1586 * 1587 * @hw: the hardware to get the LED trigger name for 1588 */ 1589static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 1590{ 1591#ifdef CONFIG_MAC80211_LEDS 1592 return __ieee80211_get_tx_led_name(hw); 1593#else 1594 return NULL; 1595#endif 1596} 1597 1598/** 1599 * ieee80211_get_rx_led_name - get name of RX LED 1600 * 1601 * mac80211 creates a receive LED trigger for each wireless hardware 1602 * that can be used to drive LEDs if your driver registers a LED device. 1603 * This function returns the name (or %NULL if not configured for LEDs) 1604 * of the trigger so you can automatically link the LED device. 1605 * 1606 * @hw: the hardware to get the LED trigger name for 1607 */ 1608static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 1609{ 1610#ifdef CONFIG_MAC80211_LEDS 1611 return __ieee80211_get_rx_led_name(hw); 1612#else 1613 return NULL; 1614#endif 1615} 1616 1617/** 1618 * ieee80211_get_assoc_led_name - get name of association LED 1619 * 1620 * mac80211 creates a association LED trigger for each wireless hardware 1621 * that can be used to drive LEDs if your driver registers a LED device. 1622 * This function returns the name (or %NULL if not configured for LEDs) 1623 * of the trigger so you can automatically link the LED device. 1624 * 1625 * @hw: the hardware to get the LED trigger name for 1626 */ 1627static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) 1628{ 1629#ifdef CONFIG_MAC80211_LEDS 1630 return __ieee80211_get_assoc_led_name(hw); 1631#else 1632 return NULL; 1633#endif 1634} 1635 1636/** 1637 * ieee80211_get_radio_led_name - get name of radio LED 1638 * 1639 * mac80211 creates a radio change LED trigger for each wireless hardware 1640 * that can be used to drive LEDs if your driver registers a LED device. 1641 * This function returns the name (or %NULL if not configured for LEDs) 1642 * of the trigger so you can automatically link the LED device. 1643 * 1644 * @hw: the hardware to get the LED trigger name for 1645 */ 1646static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) 1647{ 1648#ifdef CONFIG_MAC80211_LEDS 1649 return __ieee80211_get_radio_led_name(hw); 1650#else 1651 return NULL; 1652#endif 1653} 1654 1655/** 1656 * ieee80211_unregister_hw - Unregister a hardware device 1657 * 1658 * This function instructs mac80211 to free allocated resources 1659 * and unregister netdevices from the networking subsystem. 1660 * 1661 * @hw: the hardware to unregister 1662 */ 1663void ieee80211_unregister_hw(struct ieee80211_hw *hw); 1664 1665/** 1666 * ieee80211_free_hw - free hardware descriptor 1667 * 1668 * This function frees everything that was allocated, including the 1669 * private data for the driver. You must call ieee80211_unregister_hw() 1670 * before calling this function. 1671 * 1672 * @hw: the hardware to free 1673 */ 1674void ieee80211_free_hw(struct ieee80211_hw *hw); 1675 1676/** 1677 * ieee80211_restart_hw - restart hardware completely 1678 * 1679 * Call this function when the hardware was restarted for some reason 1680 * (hardware error, ...) and the driver is unable to restore its state 1681 * by itself. mac80211 assumes that at this point the driver/hardware 1682 * is completely uninitialised and stopped, it starts the process by 1683 * calling the ->start() operation. The driver will need to reset all 1684 * internal state that it has prior to calling this function. 1685 * 1686 * @hw: the hardware to restart 1687 */ 1688void ieee80211_restart_hw(struct ieee80211_hw *hw); 1689 1690/** 1691 * ieee80211_rx - receive frame 1692 * 1693 * Use this function to hand received frames to mac80211. The receive 1694 * buffer in @skb must start with an IEEE 802.11 header. 1695 * 1696 * This function may not be called in IRQ context. Calls to this function 1697 * for a single hardware must be synchronized against each other. Calls to 1698 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be 1699 * mixed for a single hardware. 1700 * 1701 * In process context use instead ieee80211_rx_ni(). 1702 * 1703 * @hw: the hardware this frame came in on 1704 * @skb: the buffer to receive, owned by mac80211 after this call 1705 */ 1706void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb); 1707 1708/** 1709 * ieee80211_rx_irqsafe - receive frame 1710 * 1711 * Like ieee80211_rx() but can be called in IRQ context 1712 * (internally defers to a tasklet.) 1713 * 1714 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not 1715 * be mixed for a single hardware. 1716 * 1717 * @hw: the hardware this frame came in on 1718 * @skb: the buffer to receive, owned by mac80211 after this call 1719 */ 1720void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb); 1721 1722/** 1723 * ieee80211_rx_ni - receive frame (in process context) 1724 * 1725 * Like ieee80211_rx() but can be called in process context 1726 * (internally disables bottom halves). 1727 * 1728 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may 1729 * not be mixed for a single hardware. 1730 * 1731 * @hw: the hardware this frame came in on 1732 * @skb: the buffer to receive, owned by mac80211 after this call 1733 */ 1734static inline void ieee80211_rx_ni(struct ieee80211_hw *hw, 1735 struct sk_buff *skb) 1736{ 1737 local_bh_disable(); 1738 ieee80211_rx(hw, skb); 1739 local_bh_enable(); 1740} 1741 1742/** 1743 * ieee80211_tx_status - transmit status callback 1744 * 1745 * Call this function for all transmitted frames after they have been 1746 * transmitted. It is permissible to not call this function for 1747 * multicast frames but this can affect statistics. 1748 * 1749 * This function may not be called in IRQ context. Calls to this function 1750 * for a single hardware must be synchronized against each other. Calls 1751 * to this function and ieee80211_tx_status_irqsafe() may not be mixed 1752 * for a single hardware. 1753 * 1754 * @hw: the hardware the frame was transmitted by 1755 * @skb: the frame that was transmitted, owned by mac80211 after this call 1756 */ 1757void ieee80211_tx_status(struct ieee80211_hw *hw, 1758 struct sk_buff *skb); 1759 1760/** 1761 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback 1762 * 1763 * Like ieee80211_tx_status() but can be called in IRQ context 1764 * (internally defers to a tasklet.) 1765 * 1766 * Calls to this function and ieee80211_tx_status() may not be mixed for a 1767 * single hardware. 1768 * 1769 * @hw: the hardware the frame was transmitted by 1770 * @skb: the frame that was transmitted, owned by mac80211 after this call 1771 */ 1772void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 1773 struct sk_buff *skb); 1774 1775/** 1776 * ieee80211_beacon_get_tim - beacon generation function 1777 * @hw: pointer obtained from ieee80211_alloc_hw(). 1778 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1779 * @tim_offset: pointer to variable that will receive the TIM IE offset. 1780 * Set to 0 if invalid (in non-AP modes). 1781 * @tim_length: pointer to variable that will receive the TIM IE length, 1782 * (including the ID and length bytes!). 1783 * Set to 0 if invalid (in non-AP modes). 1784 * 1785 * If the driver implements beaconing modes, it must use this function to 1786 * obtain the beacon frame/template. 1787 * 1788 * If the beacon frames are generated by the host system (i.e., not in 1789 * hardware/firmware), the driver uses this function to get each beacon 1790 * frame from mac80211 -- it is responsible for calling this function 1791 * before the beacon is needed (e.g. based on hardware interrupt). 1792 * 1793 * If the beacon frames are generated by the device, then the driver 1794 * must use the returned beacon as the template and change the TIM IE 1795 * according to the current DTIM parameters/TIM bitmap. 1796 * 1797 * The driver is responsible for freeing the returned skb. 1798 */ 1799struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw, 1800 struct ieee80211_vif *vif, 1801 u16 *tim_offset, u16 *tim_length); 1802 1803/** 1804 * ieee80211_beacon_get - beacon generation function 1805 * @hw: pointer obtained from ieee80211_alloc_hw(). 1806 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1807 * 1808 * See ieee80211_beacon_get_tim(). 1809 */ 1810static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 1811 struct ieee80211_vif *vif) 1812{ 1813 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL); 1814} 1815 1816/** 1817 * ieee80211_rts_get - RTS frame generation function 1818 * @hw: pointer obtained from ieee80211_alloc_hw(). 1819 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1820 * @frame: pointer to the frame that is going to be protected by the RTS. 1821 * @frame_len: the frame length (in octets). 1822 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1823 * @rts: The buffer where to store the RTS frame. 1824 * 1825 * If the RTS frames are generated by the host system (i.e., not in 1826 * hardware/firmware), the low-level driver uses this function to receive 1827 * the next RTS frame from the 802.11 code. The low-level is responsible 1828 * for calling this function before and RTS frame is needed. 1829 */ 1830void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1831 const void *frame, size_t frame_len, 1832 const struct ieee80211_tx_info *frame_txctl, 1833 struct ieee80211_rts *rts); 1834 1835/** 1836 * ieee80211_rts_duration - Get the duration field for an RTS frame 1837 * @hw: pointer obtained from ieee80211_alloc_hw(). 1838 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1839 * @frame_len: the length of the frame that is going to be protected by the RTS. 1840 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1841 * 1842 * If the RTS is generated in firmware, but the host system must provide 1843 * the duration field, the low-level driver uses this function to receive 1844 * the duration field value in little-endian byteorder. 1845 */ 1846__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, 1847 struct ieee80211_vif *vif, size_t frame_len, 1848 const struct ieee80211_tx_info *frame_txctl); 1849 1850/** 1851 * ieee80211_ctstoself_get - CTS-to-self frame generation function 1852 * @hw: pointer obtained from ieee80211_alloc_hw(). 1853 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1854 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 1855 * @frame_len: the frame length (in octets). 1856 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1857 * @cts: The buffer where to store the CTS-to-self frame. 1858 * 1859 * If the CTS-to-self frames are generated by the host system (i.e., not in 1860 * hardware/firmware), the low-level driver uses this function to receive 1861 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 1862 * for calling this function before and CTS-to-self frame is needed. 1863 */ 1864void ieee80211_ctstoself_get(struct ieee80211_hw *hw, 1865 struct ieee80211_vif *vif, 1866 const void *frame, size_t frame_len, 1867 const struct ieee80211_tx_info *frame_txctl, 1868 struct ieee80211_cts *cts); 1869 1870/** 1871 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 1872 * @hw: pointer obtained from ieee80211_alloc_hw(). 1873 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1874 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 1875 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1876 * 1877 * If the CTS-to-self is generated in firmware, but the host system must provide 1878 * the duration field, the low-level driver uses this function to receive 1879 * the duration field value in little-endian byteorder. 1880 */ 1881__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, 1882 struct ieee80211_vif *vif, 1883 size_t frame_len, 1884 const struct ieee80211_tx_info *frame_txctl); 1885 1886/** 1887 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 1888 * @hw: pointer obtained from ieee80211_alloc_hw(). 1889 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1890 * @frame_len: the length of the frame. 1891 * @rate: the rate at which the frame is going to be transmitted. 1892 * 1893 * Calculate the duration field of some generic frame, given its 1894 * length and transmission rate (in 100kbps). 1895 */ 1896__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, 1897 struct ieee80211_vif *vif, 1898 size_t frame_len, 1899 struct ieee80211_rate *rate); 1900 1901/** 1902 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 1903 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1904 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1905 * 1906 * Function for accessing buffered broadcast and multicast frames. If 1907 * hardware/firmware does not implement buffering of broadcast/multicast 1908 * frames when power saving is used, 802.11 code buffers them in the host 1909 * memory. The low-level driver uses this function to fetch next buffered 1910 * frame. In most cases, this is used when generating beacon frame. This 1911 * function returns a pointer to the next buffered skb or NULL if no more 1912 * buffered frames are available. 1913 * 1914 * Note: buffered frames are returned only after DTIM beacon frame was 1915 * generated with ieee80211_beacon_get() and the low-level driver must thus 1916 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 1917 * NULL if the previous generated beacon was not DTIM, so the low-level driver 1918 * does not need to check for DTIM beacons separately and should be able to 1919 * use common code for all beacons. 1920 */ 1921struct sk_buff * 1922ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 1923 1924/** 1925 * ieee80211_get_tkip_key - get a TKIP rc4 for skb 1926 * 1927 * This function computes a TKIP rc4 key for an skb. It computes 1928 * a phase 1 key if needed (iv16 wraps around). This function is to 1929 * be used by drivers which can do HW encryption but need to compute 1930 * to phase 1/2 key in SW. 1931 * 1932 * @keyconf: the parameter passed with the set key 1933 * @skb: the skb for which the key is needed 1934 * @type: TBD 1935 * @key: a buffer to which the key will be written 1936 */ 1937void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf, 1938 struct sk_buff *skb, 1939 enum ieee80211_tkip_key_type type, u8 *key); 1940/** 1941 * ieee80211_wake_queue - wake specific queue 1942 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1943 * @queue: queue number (counted from zero). 1944 * 1945 * Drivers should use this function instead of netif_wake_queue. 1946 */ 1947void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 1948 1949/** 1950 * ieee80211_stop_queue - stop specific queue 1951 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1952 * @queue: queue number (counted from zero). 1953 * 1954 * Drivers should use this function instead of netif_stop_queue. 1955 */ 1956void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 1957 1958/** 1959 * ieee80211_queue_stopped - test status of the queue 1960 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1961 * @queue: queue number (counted from zero). 1962 * 1963 * Drivers should use this function instead of netif_stop_queue. 1964 */ 1965 1966int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); 1967 1968/** 1969 * ieee80211_stop_queues - stop all queues 1970 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1971 * 1972 * Drivers should use this function instead of netif_stop_queue. 1973 */ 1974void ieee80211_stop_queues(struct ieee80211_hw *hw); 1975 1976/** 1977 * ieee80211_wake_queues - wake all queues 1978 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1979 * 1980 * Drivers should use this function instead of netif_wake_queue. 1981 */ 1982void ieee80211_wake_queues(struct ieee80211_hw *hw); 1983 1984/** 1985 * ieee80211_scan_completed - completed hardware scan 1986 * 1987 * When hardware scan offload is used (i.e. the hw_scan() callback is 1988 * assigned) this function needs to be called by the driver to notify 1989 * mac80211 that the scan finished. 1990 * 1991 * @hw: the hardware that finished the scan 1992 * @aborted: set to true if scan was aborted 1993 */ 1994void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted); 1995 1996/** 1997 * ieee80211_iterate_active_interfaces - iterate active interfaces 1998 * 1999 * This function iterates over the interfaces associated with a given 2000 * hardware that are currently active and calls the callback for them. 2001 * This function allows the iterator function to sleep, when the iterator 2002 * function is atomic @ieee80211_iterate_active_interfaces_atomic can 2003 * be used. 2004 * 2005 * @hw: the hardware struct of which the interfaces should be iterated over 2006 * @iterator: the iterator function to call 2007 * @data: first argument of the iterator function 2008 */ 2009void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, 2010 void (*iterator)(void *data, u8 *mac, 2011 struct ieee80211_vif *vif), 2012 void *data); 2013 2014/** 2015 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces 2016 * 2017 * This function iterates over the interfaces associated with a given 2018 * hardware that are currently active and calls the callback for them. 2019 * This function requires the iterator callback function to be atomic, 2020 * if that is not desired, use @ieee80211_iterate_active_interfaces instead. 2021 * 2022 * @hw: the hardware struct of which the interfaces should be iterated over 2023 * @iterator: the iterator function to call, cannot sleep 2024 * @data: first argument of the iterator function 2025 */ 2026void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw, 2027 void (*iterator)(void *data, 2028 u8 *mac, 2029 struct ieee80211_vif *vif), 2030 void *data); 2031 2032/** 2033 * ieee80211_queue_work - add work onto the mac80211 workqueue 2034 * 2035 * Drivers and mac80211 use this to add work onto the mac80211 workqueue. 2036 * This helper ensures drivers are not queueing work when they should not be. 2037 * 2038 * @hw: the hardware struct for the interface we are adding work for 2039 * @work: the work we want to add onto the mac80211 workqueue 2040 */ 2041void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work); 2042 2043/** 2044 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue 2045 * 2046 * Drivers and mac80211 use this to queue delayed work onto the mac80211 2047 * workqueue. 2048 * 2049 * @hw: the hardware struct for the interface we are adding work for 2050 * @dwork: delayable work to queue onto the mac80211 workqueue 2051 * @delay: number of jiffies to wait before queueing 2052 */ 2053void ieee80211_queue_delayed_work(struct ieee80211_hw *hw, 2054 struct delayed_work *dwork, 2055 unsigned long delay); 2056 2057/** 2058 * ieee80211_start_tx_ba_session - Start a tx Block Ack session. 2059 * @sta: the station for which to start a BA session 2060 * @tid: the TID to BA on. 2061 * 2062 * Return: success if addBA request was sent, failure otherwise 2063 * 2064 * Although mac80211/low level driver/user space application can estimate 2065 * the need to start aggregation on a certain RA/TID, the session level 2066 * will be managed by the mac80211. 2067 */ 2068int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid); 2069 2070/** 2071 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate. 2072 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf 2073 * @ra: receiver address of the BA session recipient. 2074 * @tid: the TID to BA on. 2075 * 2076 * This function must be called by low level driver once it has 2077 * finished with preparations for the BA session. 2078 */ 2079void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid); 2080 2081/** 2082 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate. 2083 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf 2084 * @ra: receiver address of the BA session recipient. 2085 * @tid: the TID to BA on. 2086 * 2087 * This function must be called by low level driver once it has 2088 * finished with preparations for the BA session. 2089 * This version of the function is IRQ-safe. 2090 */ 2091void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, 2092 u16 tid); 2093 2094/** 2095 * ieee80211_stop_tx_ba_session - Stop a Block Ack session. 2096 * @sta: the station whose BA session to stop 2097 * @tid: the TID to stop BA. 2098 * @initiator: if indicates initiator DELBA frame will be sent. 2099 * 2100 * Return: error if no sta with matching da found, success otherwise 2101 * 2102 * Although mac80211/low level driver/user space application can estimate 2103 * the need to stop aggregation on a certain RA/TID, the session level 2104 * will be managed by the mac80211. 2105 */ 2106int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid, 2107 enum ieee80211_back_parties initiator); 2108 2109/** 2110 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate. 2111 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf 2112 * @ra: receiver address of the BA session recipient. 2113 * @tid: the desired TID to BA on. 2114 * 2115 * This function must be called by low level driver once it has 2116 * finished with preparations for the BA session tear down. 2117 */ 2118void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid); 2119 2120/** 2121 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate. 2122 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf 2123 * @ra: receiver address of the BA session recipient. 2124 * @tid: the desired TID to BA on. 2125 * 2126 * This function must be called by low level driver once it has 2127 * finished with preparations for the BA session tear down. 2128 * This version of the function is IRQ-safe. 2129 */ 2130void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, 2131 u16 tid); 2132 2133/** 2134 * ieee80211_find_sta - find a station 2135 * 2136 * @vif: virtual interface to look for station on 2137 * @addr: station's address 2138 * 2139 * This function must be called under RCU lock and the 2140 * resulting pointer is only valid under RCU lock as well. 2141 */ 2142struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif, 2143 const u8 *addr); 2144 2145/** 2146 * ieee80211_find_sta_by_hw - find a station on hardware 2147 * 2148 * @hw: pointer as obtained from ieee80211_alloc_hw() 2149 * @addr: station's address 2150 * 2151 * This function must be called under RCU lock and the 2152 * resulting pointer is only valid under RCU lock as well. 2153 * 2154 * NOTE: This function should not be used! When mac80211 is converted 2155 * internally to properly keep track of stations on multiple 2156 * virtual interfaces, it will not always know which station to 2157 * return here since a single address might be used by multiple 2158 * logical stations (e.g. consider a station connecting to another 2159 * BSSID on the same AP hardware without disconnecting first). 2160 * 2161 * DO NOT USE THIS FUNCTION. 2162 */ 2163struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw, 2164 const u8 *addr); 2165 2166/** 2167 * ieee80211_sta_block_awake - block station from waking up 2168 * @hw: the hardware 2169 * @pubsta: the station 2170 * @block: whether to block or unblock 2171 * 2172 * Some devices require that all frames that are on the queues 2173 * for a specific station that went to sleep are flushed before 2174 * a poll response or frames after the station woke up can be 2175 * delivered to that it. Note that such frames must be rejected 2176 * by the driver as filtered, with the appropriate status flag. 2177 * 2178 * This function allows implementing this mode in a race-free 2179 * manner. 2180 * 2181 * To do this, a driver must keep track of the number of frames 2182 * still enqueued for a specific station. If this number is not 2183 * zero when the station goes to sleep, the driver must call 2184 * this function to force mac80211 to consider the station to 2185 * be asleep regardless of the station's actual state. Once the 2186 * number of outstanding frames reaches zero, the driver must 2187 * call this function again to unblock the station. That will 2188 * cause mac80211 to be able to send ps-poll responses, and if 2189 * the station queried in the meantime then frames will also 2190 * be sent out as a result of this. Additionally, the driver 2191 * will be notified that the station woke up some time after 2192 * it is unblocked, regardless of whether the station actually 2193 * woke up while blocked or not. 2194 */ 2195void ieee80211_sta_block_awake(struct ieee80211_hw *hw, 2196 struct ieee80211_sta *pubsta, bool block); 2197 2198/** 2199 * ieee80211_beacon_loss - inform hardware does not receive beacons 2200 * 2201 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 2202 * 2203 * When beacon filtering is enabled with IEEE80211_HW_BEACON_FILTERING and 2204 * IEEE80211_CONF_PS is set, the driver needs to inform whenever the 2205 * hardware is not receiving beacons with this function. 2206 */ 2207void ieee80211_beacon_loss(struct ieee80211_vif *vif); 2208 2209/* Rate control API */ 2210 2211/** 2212 * enum rate_control_changed - flags to indicate which parameter changed 2213 * 2214 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have 2215 * changed, rate control algorithm can update its internal state if needed. 2216 */ 2217enum rate_control_changed { 2218 IEEE80211_RC_HT_CHANGED = BIT(0) 2219}; 2220 2221/** 2222 * struct ieee80211_tx_rate_control - rate control information for/from RC algo 2223 * 2224 * @hw: The hardware the algorithm is invoked for. 2225 * @sband: The band this frame is being transmitted on. 2226 * @bss_conf: the current BSS configuration 2227 * @reported_rate: The rate control algorithm can fill this in to indicate 2228 * which rate should be reported to userspace as the current rate and 2229 * used for rate calculations in the mesh network. 2230 * @rts: whether RTS will be used for this frame because it is longer than the 2231 * RTS threshold 2232 * @short_preamble: whether mac80211 will request short-preamble transmission 2233 * if the selected rate supports it 2234 * @max_rate_idx: user-requested maximum rate (not MCS for now) 2235 * @skb: the skb that will be transmitted, the control information in it needs 2236 * to be filled in 2237 */ 2238struct ieee80211_tx_rate_control { 2239 struct ieee80211_hw *hw; 2240 struct ieee80211_supported_band *sband; 2241 struct ieee80211_bss_conf *bss_conf; 2242 struct sk_buff *skb; 2243 struct ieee80211_tx_rate reported_rate; 2244 bool rts, short_preamble; 2245 u8 max_rate_idx; 2246}; 2247 2248struct rate_control_ops { 2249 struct module *module; 2250 const char *name; 2251 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir); 2252 void (*free)(void *priv); 2253 2254 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp); 2255 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband, 2256 struct ieee80211_sta *sta, void *priv_sta); 2257 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband, 2258 struct ieee80211_sta *sta, 2259 void *priv_sta, u32 changed); 2260 void (*free_sta)(void *priv, struct ieee80211_sta *sta, 2261 void *priv_sta); 2262 2263 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband, 2264 struct ieee80211_sta *sta, void *priv_sta, 2265 struct sk_buff *skb); 2266 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta, 2267 struct ieee80211_tx_rate_control *txrc); 2268 2269 void (*add_sta_debugfs)(void *priv, void *priv_sta, 2270 struct dentry *dir); 2271 void (*remove_sta_debugfs)(void *priv, void *priv_sta); 2272}; 2273 2274static inline int rate_supported(struct ieee80211_sta *sta, 2275 enum ieee80211_band band, 2276 int index) 2277{ 2278 return (sta == NULL || sta->supp_rates[band] & BIT(index)); 2279} 2280 2281/** 2282 * rate_control_send_low - helper for drivers for management/no-ack frames 2283 * 2284 * Rate control algorithms that agree to use the lowest rate to 2285 * send management frames and NO_ACK data with the respective hw 2286 * retries should use this in the beginning of their mac80211 get_rate 2287 * callback. If true is returned the rate control can simply return. 2288 * If false is returned we guarantee that sta and sta and priv_sta is 2289 * not null. 2290 * 2291 * Rate control algorithms wishing to do more intelligent selection of 2292 * rate for multicast/broadcast frames may choose to not use this. 2293 * 2294 * @sta: &struct ieee80211_sta pointer to the target destination. Note 2295 * that this may be null. 2296 * @priv_sta: private rate control structure. This may be null. 2297 * @txrc: rate control information we sholud populate for mac80211. 2298 */ 2299bool rate_control_send_low(struct ieee80211_sta *sta, 2300 void *priv_sta, 2301 struct ieee80211_tx_rate_control *txrc); 2302 2303 2304static inline s8 2305rate_lowest_index(struct ieee80211_supported_band *sband, 2306 struct ieee80211_sta *sta) 2307{ 2308 int i; 2309 2310 for (i = 0; i < sband->n_bitrates; i++) 2311 if (rate_supported(sta, sband->band, i)) 2312 return i; 2313 2314 /* warn when we cannot find a rate. */ 2315 WARN_ON(1); 2316 2317 return 0; 2318} 2319 2320static inline 2321bool rate_usable_index_exists(struct ieee80211_supported_band *sband, 2322 struct ieee80211_sta *sta) 2323{ 2324 unsigned int i; 2325 2326 for (i = 0; i < sband->n_bitrates; i++) 2327 if (rate_supported(sta, sband->band, i)) 2328 return true; 2329 return false; 2330} 2331 2332int ieee80211_rate_control_register(struct rate_control_ops *ops); 2333void ieee80211_rate_control_unregister(struct rate_control_ops *ops); 2334 2335static inline bool 2336conf_is_ht20(struct ieee80211_conf *conf) 2337{ 2338 return conf->channel_type == NL80211_CHAN_HT20; 2339} 2340 2341static inline bool 2342conf_is_ht40_minus(struct ieee80211_conf *conf) 2343{ 2344 return conf->channel_type == NL80211_CHAN_HT40MINUS; 2345} 2346 2347static inline bool 2348conf_is_ht40_plus(struct ieee80211_conf *conf) 2349{ 2350 return conf->channel_type == NL80211_CHAN_HT40PLUS; 2351} 2352 2353static inline bool 2354conf_is_ht40(struct ieee80211_conf *conf) 2355{ 2356 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf); 2357} 2358 2359static inline bool 2360conf_is_ht(struct ieee80211_conf *conf) 2361{ 2362 return conf->channel_type != NL80211_CHAN_NO_HT; 2363} 2364 2365#endif /* MAC80211_H */ 2366