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