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