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