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