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