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