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