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