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