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