mac80211.h revision 38a6cc7538d3c44b76f9dcea607a171adcc0208e
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 if an associated station made a power state transition. 883 * 884 * @STA_NOTIFY_SLEEP: a station is now sleeping 885 * @STA_NOTIFY_AWAKE: a sleeping station woke up 886 */ 887enum sta_notify_cmd { 888 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE, 889}; 890 891/** 892 * enum ieee80211_tkip_key_type - get tkip key 893 * 894 * Used by drivers which need to get a tkip key for skb. Some drivers need a 895 * phase 1 key, others need a phase 2 key. A single function allows the driver 896 * to get the key, this enum indicates what type of key is required. 897 * 898 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key 899 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key 900 */ 901enum ieee80211_tkip_key_type { 902 IEEE80211_TKIP_P1_KEY, 903 IEEE80211_TKIP_P2_KEY, 904}; 905 906/** 907 * enum ieee80211_hw_flags - hardware flags 908 * 909 * These flags are used to indicate hardware capabilities to 910 * the stack. Generally, flags here should have their meaning 911 * done in a way that the simplest hardware doesn't need setting 912 * any particular flags. There are some exceptions to this rule, 913 * however, so you are advised to review these flags carefully. 914 * 915 * @IEEE80211_HW_HAS_RATE_CONTROL: 916 * The hardware or firmware includes rate control, and cannot be 917 * controlled by the stack. As such, no rate control algorithm 918 * should be instantiated, and the TX rate reported to userspace 919 * will be taken from the TX status instead of the rate control 920 * algorithm. 921 * Note that this requires that the driver implement a number of 922 * callbacks so it has the correct information, it needs to have 923 * the @set_rts_threshold callback and must look at the BSS config 924 * @use_cts_prot for G/N protection, @use_short_slot for slot 925 * timing in 2.4 GHz and @use_short_preamble for preambles for 926 * CCK frames. 927 * 928 * @IEEE80211_HW_RX_INCLUDES_FCS: 929 * Indicates that received frames passed to the stack include 930 * the FCS at the end. 931 * 932 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 933 * Some wireless LAN chipsets buffer broadcast/multicast frames 934 * for power saving stations in the hardware/firmware and others 935 * rely on the host system for such buffering. This option is used 936 * to configure the IEEE 802.11 upper layer to buffer broadcast and 937 * multicast frames when there are power saving stations so that 938 * the driver can fetch them with ieee80211_get_buffered_bc(). 939 * 940 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE: 941 * Hardware is not capable of short slot operation on the 2.4 GHz band. 942 * 943 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE: 944 * Hardware is not capable of receiving frames with short preamble on 945 * the 2.4 GHz band. 946 * 947 * @IEEE80211_HW_SIGNAL_UNSPEC: 948 * Hardware can provide signal values but we don't know its units. We 949 * expect values between 0 and @max_signal. 950 * If possible please provide dB or dBm instead. 951 * 952 * @IEEE80211_HW_SIGNAL_DBM: 953 * Hardware gives signal values in dBm, decibel difference from 954 * one milliwatt. This is the preferred method since it is standardized 955 * between different devices. @max_signal does not need to be set. 956 * 957 * @IEEE80211_HW_SPECTRUM_MGMT: 958 * Hardware supports spectrum management defined in 802.11h 959 * Measurement, Channel Switch, Quieting, TPC 960 * 961 * @IEEE80211_HW_AMPDU_AGGREGATION: 962 * Hardware supports 11n A-MPDU aggregation. 963 * 964 * @IEEE80211_HW_SUPPORTS_PS: 965 * Hardware has power save support (i.e. can go to sleep). 966 * 967 * @IEEE80211_HW_PS_NULLFUNC_STACK: 968 * Hardware requires nullfunc frame handling in stack, implies 969 * stack support for dynamic PS. 970 * 971 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS: 972 * Hardware has support for dynamic PS. 973 * 974 * @IEEE80211_HW_MFP_CAPABLE: 975 * Hardware supports management frame protection (MFP, IEEE 802.11w). 976 * 977 * @IEEE80211_HW_BEACON_FILTER: 978 * Hardware supports dropping of irrelevant beacon frames to 979 * avoid waking up cpu. 980 * 981 * @IEEE80211_HW_SUPPORTS_STATIC_SMPS: 982 * Hardware supports static spatial multiplexing powersave, 983 * ie. can turn off all but one chain even on HT connections 984 * that should be using more chains. 985 * 986 * @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS: 987 * Hardware supports dynamic spatial multiplexing powersave, 988 * ie. can turn off all but one chain and then wake the rest 989 * up as required after, for example, rts/cts handshake. 990 * 991 * @IEEE80211_HW_SUPPORTS_UAPSD: 992 * Hardware supports Unscheduled Automatic Power Save Delivery 993 * (U-APSD) in managed mode. The mode is configured with 994 * conf_tx() operation. 995 * 996 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS: 997 * Hardware can provide ack status reports of Tx frames to 998 * the stack. 999 * 1000 * @IEEE80211_HW_CONNECTION_MONITOR: 1001 * The hardware performs its own connection monitoring, including 1002 * periodic keep-alives to the AP and probing the AP on beacon loss. 1003 * When this flag is set, signaling beacon-loss will cause an immediate 1004 * change to disassociated state. 1005 * 1006 * @IEEE80211_HW_SUPPORTS_CQM_RSSI: 1007 * Hardware can do connection quality monitoring - i.e. it can monitor 1008 * connection quality related parameters, such as the RSSI level and 1009 * provide notifications if configured trigger levels are reached. 1010 * 1011 */ 1012enum ieee80211_hw_flags { 1013 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0, 1014 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, 1015 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, 1016 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3, 1017 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4, 1018 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5, 1019 IEEE80211_HW_SIGNAL_DBM = 1<<6, 1020 /* use this hole */ 1021 IEEE80211_HW_SPECTRUM_MGMT = 1<<8, 1022 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9, 1023 IEEE80211_HW_SUPPORTS_PS = 1<<10, 1024 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11, 1025 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12, 1026 IEEE80211_HW_MFP_CAPABLE = 1<<13, 1027 IEEE80211_HW_BEACON_FILTER = 1<<14, 1028 IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15, 1029 IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16, 1030 IEEE80211_HW_SUPPORTS_UAPSD = 1<<17, 1031 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18, 1032 IEEE80211_HW_CONNECTION_MONITOR = 1<<19, 1033 IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20, 1034}; 1035 1036/** 1037 * struct ieee80211_hw - hardware information and state 1038 * 1039 * This structure contains the configuration and hardware 1040 * information for an 802.11 PHY. 1041 * 1042 * @wiphy: This points to the &struct wiphy allocated for this 1043 * 802.11 PHY. You must fill in the @perm_addr and @dev 1044 * members of this structure using SET_IEEE80211_DEV() 1045 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported 1046 * bands (with channels, bitrates) are registered here. 1047 * 1048 * @conf: &struct ieee80211_conf, device configuration, don't use. 1049 * 1050 * @priv: pointer to private area that was allocated for driver use 1051 * along with this structure. 1052 * 1053 * @flags: hardware flags, see &enum ieee80211_hw_flags. 1054 * 1055 * @extra_tx_headroom: headroom to reserve in each transmit skb 1056 * for use by the driver (e.g. for transmit headers.) 1057 * 1058 * @channel_change_time: time (in microseconds) it takes to change channels. 1059 * 1060 * @max_signal: Maximum value for signal (rssi) in RX information, used 1061 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB 1062 * 1063 * @max_listen_interval: max listen interval in units of beacon interval 1064 * that HW supports 1065 * 1066 * @queues: number of available hardware transmit queues for 1067 * data packets. WMM/QoS requires at least four, these 1068 * queues need to have configurable access parameters. 1069 * 1070 * @rate_control_algorithm: rate control algorithm for this hardware. 1071 * If unset (NULL), the default algorithm will be used. Must be 1072 * set before calling ieee80211_register_hw(). 1073 * 1074 * @vif_data_size: size (in bytes) of the drv_priv data area 1075 * within &struct ieee80211_vif. 1076 * @sta_data_size: size (in bytes) of the drv_priv data area 1077 * within &struct ieee80211_sta. 1078 * 1079 * @max_rates: maximum number of alternate rate retry stages 1080 * @max_rate_tries: maximum number of tries for each stage 1081 */ 1082struct ieee80211_hw { 1083 struct ieee80211_conf conf; 1084 struct wiphy *wiphy; 1085 const char *rate_control_algorithm; 1086 void *priv; 1087 u32 flags; 1088 unsigned int extra_tx_headroom; 1089 int channel_change_time; 1090 int vif_data_size; 1091 int sta_data_size; 1092 u16 queues; 1093 u16 max_listen_interval; 1094 s8 max_signal; 1095 u8 max_rates; 1096 u8 max_rate_tries; 1097}; 1098 1099/** 1100 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy 1101 * 1102 * @wiphy: the &struct wiphy which we want to query 1103 * 1104 * mac80211 drivers can use this to get to their respective 1105 * &struct ieee80211_hw. Drivers wishing to get to their own private 1106 * structure can then access it via hw->priv. Note that mac802111 drivers should 1107 * not use wiphy_priv() to try to get their private driver structure as this 1108 * is already used internally by mac80211. 1109 */ 1110struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy); 1111 1112/** 1113 * SET_IEEE80211_DEV - set device for 802.11 hardware 1114 * 1115 * @hw: the &struct ieee80211_hw to set the device for 1116 * @dev: the &struct device of this 802.11 device 1117 */ 1118static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 1119{ 1120 set_wiphy_dev(hw->wiphy, dev); 1121} 1122 1123/** 1124 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware 1125 * 1126 * @hw: the &struct ieee80211_hw to set the MAC address for 1127 * @addr: the address to set 1128 */ 1129static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 1130{ 1131 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 1132} 1133 1134static inline struct ieee80211_rate * 1135ieee80211_get_tx_rate(const struct ieee80211_hw *hw, 1136 const struct ieee80211_tx_info *c) 1137{ 1138 if (WARN_ON(c->control.rates[0].idx < 0)) 1139 return NULL; 1140 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx]; 1141} 1142 1143static inline struct ieee80211_rate * 1144ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw, 1145 const struct ieee80211_tx_info *c) 1146{ 1147 if (c->control.rts_cts_rate_idx < 0) 1148 return NULL; 1149 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx]; 1150} 1151 1152static inline struct ieee80211_rate * 1153ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw, 1154 const struct ieee80211_tx_info *c, int idx) 1155{ 1156 if (c->control.rates[idx + 1].idx < 0) 1157 return NULL; 1158 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx]; 1159} 1160 1161/** 1162 * DOC: Hardware crypto acceleration 1163 * 1164 * mac80211 is capable of taking advantage of many hardware 1165 * acceleration designs for encryption and decryption operations. 1166 * 1167 * The set_key() callback in the &struct ieee80211_ops for a given 1168 * device is called to enable hardware acceleration of encryption and 1169 * decryption. The callback takes a @sta parameter that will be NULL 1170 * for default keys or keys used for transmission only, or point to 1171 * the station information for the peer for individual keys. 1172 * Multiple transmission keys with the same key index may be used when 1173 * VLANs are configured for an access point. 1174 * 1175 * When transmitting, the TX control data will use the @hw_key_idx 1176 * selected by the driver by modifying the &struct ieee80211_key_conf 1177 * pointed to by the @key parameter to the set_key() function. 1178 * 1179 * The set_key() call for the %SET_KEY command should return 0 if 1180 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 1181 * added; if you return 0 then hw_key_idx must be assigned to the 1182 * hardware key index, you are free to use the full u8 range. 1183 * 1184 * When the cmd is %DISABLE_KEY then it must succeed. 1185 * 1186 * Note that it is permissible to not decrypt a frame even if a key 1187 * for it has been uploaded to hardware, the stack will not make any 1188 * decision based on whether a key has been uploaded or not but rather 1189 * based on the receive flags. 1190 * 1191 * The &struct ieee80211_key_conf structure pointed to by the @key 1192 * parameter is guaranteed to be valid until another call to set_key() 1193 * removes it, but it can only be used as a cookie to differentiate 1194 * keys. 1195 * 1196 * In TKIP some HW need to be provided a phase 1 key, for RX decryption 1197 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key 1198 * handler. 1199 * The update_tkip_key() call updates the driver with the new phase 1 key. 1200 * This happens everytime the iv16 wraps around (every 65536 packets). The 1201 * set_key() call will happen only once for each key (unless the AP did 1202 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is 1203 * provided by update_tkip_key only. The trigger that makes mac80211 call this 1204 * handler is software decryption with wrap around of iv16. 1205 */ 1206 1207/** 1208 * DOC: Powersave support 1209 * 1210 * mac80211 has support for various powersave implementations. 1211 * 1212 * First, it can support hardware that handles all powersaving by itself, 1213 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware 1214 * flag. In that case, it will be told about the desired powersave mode 1215 * with the %IEEE80211_CONF_PS flag depending on the association status. 1216 * The hardware must take care of sending nullfunc frames when necessary, 1217 * i.e. when entering and leaving powersave mode. The hardware is required 1218 * to look at the AID in beacons and signal to the AP that it woke up when 1219 * it finds traffic directed to it. 1220 * 1221 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in 1222 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused 1223 * with hardware wakeup and sleep states. Driver is responsible for waking 1224 * up the hardware before issueing commands to the hardware and putting it 1225 * back to sleep at approriate times. 1226 * 1227 * When PS is enabled, hardware needs to wakeup for beacons and receive the 1228 * buffered multicast/broadcast frames after the beacon. Also it must be 1229 * possible to send frames and receive the acknowledment frame. 1230 * 1231 * Other hardware designs cannot send nullfunc frames by themselves and also 1232 * need software support for parsing the TIM bitmap. This is also supported 1233 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and 1234 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still 1235 * required to pass up beacons. The hardware is still required to handle 1236 * waking up for multicast traffic; if it cannot the driver must handle that 1237 * as best as it can, mac80211 is too slow to do that. 1238 * 1239 * Dynamic powersave is an extension to normal powersave in which the 1240 * hardware stays awake for a user-specified period of time after sending a 1241 * frame so that reply frames need not be buffered and therefore delayed to 1242 * the next wakeup. It's compromise of getting good enough latency when 1243 * there's data traffic and still saving significantly power in idle 1244 * periods. 1245 * 1246 * Dynamic powersave is supported by simply mac80211 enabling and disabling 1247 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS 1248 * flag and mac80211 will handle everything automatically. Additionally, 1249 * hardware having support for the dynamic PS feature may set the 1250 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support 1251 * dynamic PS mode itself. The driver needs to look at the 1252 * @dynamic_ps_timeout hardware configuration value and use it that value 1253 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable 1254 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS 1255 * enabled whenever user has enabled powersave. 1256 * 1257 * Driver informs U-APSD client support by enabling 1258 * %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the 1259 * uapsd paramater in conf_tx() operation. Hardware needs to send the QoS 1260 * Nullfunc frames and stay awake until the service period has ended. To 1261 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames 1262 * from that AC are transmitted with powersave enabled. 1263 * 1264 * Note: U-APSD client mode is not yet supported with 1265 * %IEEE80211_HW_PS_NULLFUNC_STACK. 1266 */ 1267 1268/** 1269 * DOC: Beacon filter support 1270 * 1271 * Some hardware have beacon filter support to reduce host cpu wakeups 1272 * which will reduce system power consumption. It usuallly works so that 1273 * the firmware creates a checksum of the beacon but omits all constantly 1274 * changing elements (TSF, TIM etc). Whenever the checksum changes the 1275 * beacon is forwarded to the host, otherwise it will be just dropped. That 1276 * way the host will only receive beacons where some relevant information 1277 * (for example ERP protection or WMM settings) have changed. 1278 * 1279 * Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER 1280 * hardware capability. The driver needs to enable beacon filter support 1281 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When 1282 * power save is enabled, the stack will not check for beacon loss and the 1283 * driver needs to notify about loss of beacons with ieee80211_beacon_loss(). 1284 * 1285 * The time (or number of beacons missed) until the firmware notifies the 1286 * driver of a beacon loss event (which in turn causes the driver to call 1287 * ieee80211_beacon_loss()) should be configurable and will be controlled 1288 * by mac80211 and the roaming algorithm in the future. 1289 * 1290 * Since there may be constantly changing information elements that nothing 1291 * in the software stack cares about, we will, in the future, have mac80211 1292 * tell the driver which information elements are interesting in the sense 1293 * that we want to see changes in them. This will include 1294 * - a list of information element IDs 1295 * - a list of OUIs for the vendor information element 1296 * 1297 * Ideally, the hardware would filter out any beacons without changes in the 1298 * requested elements, but if it cannot support that it may, at the expense 1299 * of some efficiency, filter out only a subset. For example, if the device 1300 * doesn't support checking for OUIs it should pass up all changes in all 1301 * vendor information elements. 1302 * 1303 * Note that change, for the sake of simplification, also includes information 1304 * elements appearing or disappearing from the beacon. 1305 * 1306 * Some hardware supports an "ignore list" instead, just make sure nothing 1307 * that was requested is on the ignore list, and include commonly changing 1308 * information element IDs in the ignore list, for example 11 (BSS load) and 1309 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136, 1310 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility 1311 * it could also include some currently unused IDs. 1312 * 1313 * 1314 * In addition to these capabilities, hardware should support notifying the 1315 * host of changes in the beacon RSSI. This is relevant to implement roaming 1316 * when no traffic is flowing (when traffic is flowing we see the RSSI of 1317 * the received data packets). This can consist in notifying the host when 1318 * the RSSI changes significantly or when it drops below or rises above 1319 * configurable thresholds. In the future these thresholds will also be 1320 * configured by mac80211 (which gets them from userspace) to implement 1321 * them as the roaming algorithm requires. 1322 * 1323 * If the hardware cannot implement this, the driver should ask it to 1324 * periodically pass beacon frames to the host so that software can do the 1325 * signal strength threshold checking. 1326 */ 1327 1328/** 1329 * DOC: Spatial multiplexing power save 1330 * 1331 * SMPS (Spatial multiplexing power save) is a mechanism to conserve 1332 * power in an 802.11n implementation. For details on the mechanism 1333 * and rationale, please refer to 802.11 (as amended by 802.11n-2009) 1334 * "11.2.3 SM power save". 1335 * 1336 * The mac80211 implementation is capable of sending action frames 1337 * to update the AP about the station's SMPS mode, and will instruct 1338 * the driver to enter the specific mode. It will also announce the 1339 * requested SMPS mode during the association handshake. Hardware 1340 * support for this feature is required, and can be indicated by 1341 * hardware flags. 1342 * 1343 * The default mode will be "automatic", which nl80211/cfg80211 1344 * defines to be dynamic SMPS in (regular) powersave, and SMPS 1345 * turned off otherwise. 1346 * 1347 * To support this feature, the driver must set the appropriate 1348 * hardware support flags, and handle the SMPS flag to the config() 1349 * operation. It will then with this mechanism be instructed to 1350 * enter the requested SMPS mode while associated to an HT AP. 1351 */ 1352 1353/** 1354 * DOC: Frame filtering 1355 * 1356 * mac80211 requires to see many management frames for proper 1357 * operation, and users may want to see many more frames when 1358 * in monitor mode. However, for best CPU usage and power consumption, 1359 * having as few frames as possible percolate through the stack is 1360 * desirable. Hence, the hardware should filter as much as possible. 1361 * 1362 * To achieve this, mac80211 uses filter flags (see below) to tell 1363 * the driver's configure_filter() function which frames should be 1364 * passed to mac80211 and which should be filtered out. 1365 * 1366 * Before configure_filter() is invoked, the prepare_multicast() 1367 * callback is invoked with the parameters @mc_count and @mc_list 1368 * for the combined multicast address list of all virtual interfaces. 1369 * It's use is optional, and it returns a u64 that is passed to 1370 * configure_filter(). Additionally, configure_filter() has the 1371 * arguments @changed_flags telling which flags were changed and 1372 * @total_flags with the new flag states. 1373 * 1374 * If your device has no multicast address filters your driver will 1375 * need to check both the %FIF_ALLMULTI flag and the @mc_count 1376 * parameter to see whether multicast frames should be accepted 1377 * or dropped. 1378 * 1379 * All unsupported flags in @total_flags must be cleared. 1380 * Hardware does not support a flag if it is incapable of _passing_ 1381 * the frame to the stack. Otherwise the driver must ignore 1382 * the flag, but not clear it. 1383 * You must _only_ clear the flag (announce no support for the 1384 * flag to mac80211) if you are not able to pass the packet type 1385 * to the stack (so the hardware always filters it). 1386 * So for example, you should clear @FIF_CONTROL, if your hardware 1387 * always filters control frames. If your hardware always passes 1388 * control frames to the kernel and is incapable of filtering them, 1389 * you do _not_ clear the @FIF_CONTROL flag. 1390 * This rule applies to all other FIF flags as well. 1391 */ 1392 1393/** 1394 * enum ieee80211_filter_flags - hardware filter flags 1395 * 1396 * These flags determine what the filter in hardware should be 1397 * programmed to let through and what should not be passed to the 1398 * stack. It is always safe to pass more frames than requested, 1399 * but this has negative impact on power consumption. 1400 * 1401 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, 1402 * think of the BSS as your network segment and then this corresponds 1403 * to the regular ethernet device promiscuous mode. 1404 * 1405 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 1406 * by the user or if the hardware is not capable of filtering by 1407 * multicast address. 1408 * 1409 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 1410 * %RX_FLAG_FAILED_FCS_CRC for them) 1411 * 1412 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 1413 * the %RX_FLAG_FAILED_PLCP_CRC for them 1414 * 1415 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 1416 * to the hardware that it should not filter beacons or probe responses 1417 * by BSSID. Filtering them can greatly reduce the amount of processing 1418 * mac80211 needs to do and the amount of CPU wakeups, so you should 1419 * honour this flag if possible. 1420 * 1421 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS 1422 * is not set then only those addressed to this station. 1423 * 1424 * @FIF_OTHER_BSS: pass frames destined to other BSSes 1425 * 1426 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only 1427 * those addressed to this station. 1428 */ 1429enum ieee80211_filter_flags { 1430 FIF_PROMISC_IN_BSS = 1<<0, 1431 FIF_ALLMULTI = 1<<1, 1432 FIF_FCSFAIL = 1<<2, 1433 FIF_PLCPFAIL = 1<<3, 1434 FIF_BCN_PRBRESP_PROMISC = 1<<4, 1435 FIF_CONTROL = 1<<5, 1436 FIF_OTHER_BSS = 1<<6, 1437 FIF_PSPOLL = 1<<7, 1438}; 1439 1440/** 1441 * enum ieee80211_ampdu_mlme_action - A-MPDU actions 1442 * 1443 * These flags are used with the ampdu_action() callback in 1444 * &struct ieee80211_ops to indicate which action is needed. 1445 * 1446 * Note that drivers MUST be able to deal with a TX aggregation 1447 * session being stopped even before they OK'ed starting it by 1448 * calling ieee80211_start_tx_ba_cb(_irqsafe), because the peer 1449 * might receive the addBA frame and send a delBA right away! 1450 * 1451 * @IEEE80211_AMPDU_RX_START: start Rx aggregation 1452 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation 1453 * @IEEE80211_AMPDU_TX_START: start Tx aggregation 1454 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation 1455 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational 1456 */ 1457enum ieee80211_ampdu_mlme_action { 1458 IEEE80211_AMPDU_RX_START, 1459 IEEE80211_AMPDU_RX_STOP, 1460 IEEE80211_AMPDU_TX_START, 1461 IEEE80211_AMPDU_TX_STOP, 1462 IEEE80211_AMPDU_TX_OPERATIONAL, 1463}; 1464 1465/** 1466 * struct ieee80211_ops - callbacks from mac80211 to the driver 1467 * 1468 * This structure contains various callbacks that the driver may 1469 * handle or, in some cases, must handle, for example to configure 1470 * the hardware to a new channel or to transmit a frame. 1471 * 1472 * @tx: Handler that 802.11 module calls for each transmitted frame. 1473 * skb contains the buffer starting from the IEEE 802.11 header. 1474 * The low-level driver should send the frame out based on 1475 * configuration in the TX control data. This handler should, 1476 * preferably, never fail and stop queues appropriately, more 1477 * importantly, however, it must never fail for A-MPDU-queues. 1478 * This function should return NETDEV_TX_OK except in very 1479 * limited cases. 1480 * Must be implemented and atomic. 1481 * 1482 * @start: Called before the first netdevice attached to the hardware 1483 * is enabled. This should turn on the hardware and must turn on 1484 * frame reception (for possibly enabled monitor interfaces.) 1485 * Returns negative error codes, these may be seen in userspace, 1486 * or zero. 1487 * When the device is started it should not have a MAC address 1488 * to avoid acknowledging frames before a non-monitor device 1489 * is added. 1490 * Must be implemented and can sleep. 1491 * 1492 * @stop: Called after last netdevice attached to the hardware 1493 * is disabled. This should turn off the hardware (at least 1494 * it must turn off frame reception.) 1495 * May be called right after add_interface if that rejects 1496 * an interface. If you added any work onto the mac80211 workqueue 1497 * you should ensure to cancel it on this callback. 1498 * Must be implemented and can sleep. 1499 * 1500 * @add_interface: Called when a netdevice attached to the hardware is 1501 * enabled. Because it is not called for monitor mode devices, @start 1502 * and @stop must be implemented. 1503 * The driver should perform any initialization it needs before 1504 * the device can be enabled. The initial configuration for the 1505 * interface is given in the conf parameter. 1506 * The callback may refuse to add an interface by returning a 1507 * negative error code (which will be seen in userspace.) 1508 * Must be implemented and can sleep. 1509 * 1510 * @remove_interface: Notifies a driver that an interface is going down. 1511 * The @stop callback is called after this if it is the last interface 1512 * and no monitor interfaces are present. 1513 * When all interfaces are removed, the MAC address in the hardware 1514 * must be cleared so the device no longer acknowledges packets, 1515 * the mac_addr member of the conf structure is, however, set to the 1516 * MAC address of the device going away. 1517 * Hence, this callback must be implemented. It can sleep. 1518 * 1519 * @config: Handler for configuration requests. IEEE 802.11 code calls this 1520 * function to change hardware configuration, e.g., channel. 1521 * This function should never fail but returns a negative error code 1522 * if it does. The callback can sleep. 1523 * 1524 * @bss_info_changed: Handler for configuration requests related to BSS 1525 * parameters that may vary during BSS's lifespan, and may affect low 1526 * level driver (e.g. assoc/disassoc status, erp parameters). 1527 * This function should not be used if no BSS has been set, unless 1528 * for association indication. The @changed parameter indicates which 1529 * of the bss parameters has changed when a call is made. The callback 1530 * can sleep. 1531 * 1532 * @configure_arp_filter: Configuration function for hardware ARP query filter. 1533 * This function is called with all the IP addresses configured to the 1534 * interface as argument - all ARP queries targeted to any of these 1535 * addresses must pass through. If the hardware filter does not support 1536 * enought addresses, hardware filtering must be disabled. The ifa_list 1537 * argument may be NULL, indicating that filtering must be disabled. 1538 * This function is called upon association complete with current 1539 * address(es), and while associated whenever the IP address(es) change. 1540 * The callback can sleep. 1541 * 1542 * @prepare_multicast: Prepare for multicast filter configuration. 1543 * This callback is optional, and its return value is passed 1544 * to configure_filter(). This callback must be atomic. 1545 * 1546 * @configure_filter: Configure the device's RX filter. 1547 * See the section "Frame filtering" for more information. 1548 * This callback must be implemented and can sleep. 1549 * 1550 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit 1551 * must be set or cleared for a given STA. Must be atomic. 1552 * 1553 * @set_key: See the section "Hardware crypto acceleration" 1554 * This callback is only called between add_interface and 1555 * remove_interface calls, i.e. while the given virtual interface 1556 * is enabled. 1557 * Returns a negative error code if the key can't be added. 1558 * The callback can sleep. 1559 * 1560 * @update_tkip_key: See the section "Hardware crypto acceleration" 1561 * This callback will be called in the context of Rx. Called for drivers 1562 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY. 1563 * The callback must be atomic. 1564 * 1565 * @hw_scan: Ask the hardware to service the scan request, no need to start 1566 * the scan state machine in stack. The scan must honour the channel 1567 * configuration done by the regulatory agent in the wiphy's 1568 * registered bands. The hardware (or the driver) needs to make sure 1569 * that power save is disabled. 1570 * The @req ie/ie_len members are rewritten by mac80211 to contain the 1571 * entire IEs after the SSID, so that drivers need not look at these 1572 * at all but just send them after the SSID -- mac80211 includes the 1573 * (extended) supported rates and HT information (where applicable). 1574 * When the scan finishes, ieee80211_scan_completed() must be called; 1575 * note that it also must be called when the scan cannot finish due to 1576 * any error unless this callback returned a negative error code. 1577 * The callback can sleep. 1578 * 1579 * @sw_scan_start: Notifier function that is called just before a software scan 1580 * is started. Can be NULL, if the driver doesn't need this notification. 1581 * The callback can sleep. 1582 * 1583 * @sw_scan_complete: Notifier function that is called just after a 1584 * software scan finished. Can be NULL, if the driver doesn't need 1585 * this notification. 1586 * The callback can sleep. 1587 * 1588 * @get_stats: Return low-level statistics. 1589 * Returns zero if statistics are available. 1590 * The callback can sleep. 1591 * 1592 * @get_tkip_seq: If your device implements TKIP encryption in hardware this 1593 * callback should be provided to read the TKIP transmit IVs (both IV32 1594 * and IV16) for the given key from hardware. 1595 * The callback must be atomic. 1596 * 1597 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 1598 * The callback can sleep. 1599 * 1600 * @sta_add: Notifies low level driver about addition of an associated station, 1601 * AP, IBSS/WDS/mesh peer etc. This callback can sleep. 1602 * 1603 * @sta_remove: Notifies low level driver about removal of an associated 1604 * station, AP, IBSS/WDS/mesh peer etc. This callback can sleep. 1605 * 1606 * @sta_notify: Notifies low level driver about power state transition of an 1607 * associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic. 1608 * 1609 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 1610 * bursting) for a hardware TX queue. 1611 * Returns a negative error code on failure. 1612 * The callback can sleep. 1613 * 1614 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 1615 * this is only used for IBSS mode BSSID merging and debugging. Is not a 1616 * required function. 1617 * The callback can sleep. 1618 * 1619 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware. 1620 * Currently, this is only used for IBSS mode debugging. Is not a 1621 * required function. 1622 * The callback can sleep. 1623 * 1624 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 1625 * with other STAs in the IBSS. This is only used in IBSS mode. This 1626 * function is optional if the firmware/hardware takes full care of 1627 * TSF synchronization. 1628 * The callback can sleep. 1629 * 1630 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 1631 * This is needed only for IBSS mode and the result of this function is 1632 * used to determine whether to reply to Probe Requests. 1633 * Returns non-zero if this device sent the last beacon. 1634 * The callback can sleep. 1635 * 1636 * @ampdu_action: Perform a certain A-MPDU action 1637 * The RA/TID combination determines the destination and TID we want 1638 * the ampdu action to be performed for. The action is defined through 1639 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn) 1640 * is the first frame we expect to perform the action on. Notice 1641 * that TX/RX_STOP can pass NULL for this parameter. 1642 * Returns a negative error code on failure. 1643 * The callback must be atomic. 1644 * 1645 * @get_survey: Return per-channel survey information 1646 * 1647 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also 1648 * need to set wiphy->rfkill_poll to %true before registration, 1649 * and need to call wiphy_rfkill_set_hw_state() in the callback. 1650 * The callback can sleep. 1651 * 1652 * @set_coverage_class: Set slot time for given coverage class as specified 1653 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout 1654 * accordingly. This callback is not required and may sleep. 1655 * 1656 * @testmode_cmd: Implement a cfg80211 test mode command. 1657 * The callback can sleep. 1658 * 1659 * @flush: Flush all pending frames from the hardware queue, making sure 1660 * that the hardware queues are empty. If the parameter @drop is set 1661 * to %true, pending frames may be dropped. The callback can sleep. 1662 * 1663 * @channel_switch: Drivers that need (or want) to offload the channel 1664 * switch operation for CSAs received from the AP may implement this 1665 * callback. They must then call ieee80211_chswitch_done() to indicate 1666 * completion of the channel switch. 1667 */ 1668struct ieee80211_ops { 1669 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb); 1670 int (*start)(struct ieee80211_hw *hw); 1671 void (*stop)(struct ieee80211_hw *hw); 1672 int (*add_interface)(struct ieee80211_hw *hw, 1673 struct ieee80211_vif *vif); 1674 void (*remove_interface)(struct ieee80211_hw *hw, 1675 struct ieee80211_vif *vif); 1676 int (*config)(struct ieee80211_hw *hw, u32 changed); 1677 void (*bss_info_changed)(struct ieee80211_hw *hw, 1678 struct ieee80211_vif *vif, 1679 struct ieee80211_bss_conf *info, 1680 u32 changed); 1681 int (*configure_arp_filter)(struct ieee80211_hw *hw, 1682 struct ieee80211_vif *vif, 1683 struct in_ifaddr *ifa_list); 1684 u64 (*prepare_multicast)(struct ieee80211_hw *hw, 1685 struct netdev_hw_addr_list *mc_list); 1686 void (*configure_filter)(struct ieee80211_hw *hw, 1687 unsigned int changed_flags, 1688 unsigned int *total_flags, 1689 u64 multicast); 1690 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 1691 bool set); 1692 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, 1693 struct ieee80211_vif *vif, struct ieee80211_sta *sta, 1694 struct ieee80211_key_conf *key); 1695 void (*update_tkip_key)(struct ieee80211_hw *hw, 1696 struct ieee80211_vif *vif, 1697 struct ieee80211_key_conf *conf, 1698 struct ieee80211_sta *sta, 1699 u32 iv32, u16 *phase1key); 1700 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1701 struct cfg80211_scan_request *req); 1702 void (*sw_scan_start)(struct ieee80211_hw *hw); 1703 void (*sw_scan_complete)(struct ieee80211_hw *hw); 1704 int (*get_stats)(struct ieee80211_hw *hw, 1705 struct ieee80211_low_level_stats *stats); 1706 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx, 1707 u32 *iv32, u16 *iv16); 1708 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 1709 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1710 struct ieee80211_sta *sta); 1711 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1712 struct ieee80211_sta *sta); 1713 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1714 enum sta_notify_cmd, struct ieee80211_sta *sta); 1715 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue, 1716 const struct ieee80211_tx_queue_params *params); 1717 u64 (*get_tsf)(struct ieee80211_hw *hw); 1718 void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf); 1719 void (*reset_tsf)(struct ieee80211_hw *hw); 1720 int (*tx_last_beacon)(struct ieee80211_hw *hw); 1721 int (*ampdu_action)(struct ieee80211_hw *hw, 1722 struct ieee80211_vif *vif, 1723 enum ieee80211_ampdu_mlme_action action, 1724 struct ieee80211_sta *sta, u16 tid, u16 *ssn); 1725 int (*get_survey)(struct ieee80211_hw *hw, int idx, 1726 struct survey_info *survey); 1727 void (*rfkill_poll)(struct ieee80211_hw *hw); 1728 void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class); 1729#ifdef CONFIG_NL80211_TESTMODE 1730 int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len); 1731#endif 1732 void (*flush)(struct ieee80211_hw *hw, bool drop); 1733 void (*channel_switch)(struct ieee80211_hw *hw, 1734 struct ieee80211_channel_switch *ch_switch); 1735}; 1736 1737/** 1738 * ieee80211_alloc_hw - Allocate a new hardware device 1739 * 1740 * This must be called once for each hardware device. The returned pointer 1741 * must be used to refer to this device when calling other functions. 1742 * mac80211 allocates a private data area for the driver pointed to by 1743 * @priv in &struct ieee80211_hw, the size of this area is given as 1744 * @priv_data_len. 1745 * 1746 * @priv_data_len: length of private data 1747 * @ops: callbacks for this device 1748 */ 1749struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 1750 const struct ieee80211_ops *ops); 1751 1752/** 1753 * ieee80211_register_hw - Register hardware device 1754 * 1755 * You must call this function before any other functions in 1756 * mac80211. Note that before a hardware can be registered, you 1757 * need to fill the contained wiphy's information. 1758 * 1759 * @hw: the device to register as returned by ieee80211_alloc_hw() 1760 */ 1761int ieee80211_register_hw(struct ieee80211_hw *hw); 1762 1763#ifdef CONFIG_MAC80211_LEDS 1764extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 1765extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 1766extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); 1767extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw); 1768#endif 1769/** 1770 * ieee80211_get_tx_led_name - get name of TX LED 1771 * 1772 * mac80211 creates a transmit LED trigger for each wireless hardware 1773 * that can be used to drive LEDs if your driver registers a LED device. 1774 * This function returns the name (or %NULL if not configured for LEDs) 1775 * of the trigger so you can automatically link the LED device. 1776 * 1777 * @hw: the hardware to get the LED trigger name for 1778 */ 1779static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 1780{ 1781#ifdef CONFIG_MAC80211_LEDS 1782 return __ieee80211_get_tx_led_name(hw); 1783#else 1784 return NULL; 1785#endif 1786} 1787 1788/** 1789 * ieee80211_get_rx_led_name - get name of RX LED 1790 * 1791 * mac80211 creates a receive LED trigger for each wireless hardware 1792 * that can be used to drive LEDs if your driver registers a LED device. 1793 * This function returns the name (or %NULL if not configured for LEDs) 1794 * of the trigger so you can automatically link the LED device. 1795 * 1796 * @hw: the hardware to get the LED trigger name for 1797 */ 1798static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 1799{ 1800#ifdef CONFIG_MAC80211_LEDS 1801 return __ieee80211_get_rx_led_name(hw); 1802#else 1803 return NULL; 1804#endif 1805} 1806 1807/** 1808 * ieee80211_get_assoc_led_name - get name of association LED 1809 * 1810 * mac80211 creates a association LED trigger for each wireless hardware 1811 * that can be used to drive LEDs if your driver registers a LED device. 1812 * This function returns the name (or %NULL if not configured for LEDs) 1813 * of the trigger so you can automatically link the LED device. 1814 * 1815 * @hw: the hardware to get the LED trigger name for 1816 */ 1817static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) 1818{ 1819#ifdef CONFIG_MAC80211_LEDS 1820 return __ieee80211_get_assoc_led_name(hw); 1821#else 1822 return NULL; 1823#endif 1824} 1825 1826/** 1827 * ieee80211_get_radio_led_name - get name of radio LED 1828 * 1829 * mac80211 creates a radio change LED trigger for each wireless hardware 1830 * that can be used to drive LEDs if your driver registers a LED device. 1831 * This function returns the name (or %NULL if not configured for LEDs) 1832 * of the trigger so you can automatically link the LED device. 1833 * 1834 * @hw: the hardware to get the LED trigger name for 1835 */ 1836static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) 1837{ 1838#ifdef CONFIG_MAC80211_LEDS 1839 return __ieee80211_get_radio_led_name(hw); 1840#else 1841 return NULL; 1842#endif 1843} 1844 1845/** 1846 * ieee80211_unregister_hw - Unregister a hardware device 1847 * 1848 * This function instructs mac80211 to free allocated resources 1849 * and unregister netdevices from the networking subsystem. 1850 * 1851 * @hw: the hardware to unregister 1852 */ 1853void ieee80211_unregister_hw(struct ieee80211_hw *hw); 1854 1855/** 1856 * ieee80211_free_hw - free hardware descriptor 1857 * 1858 * This function frees everything that was allocated, including the 1859 * private data for the driver. You must call ieee80211_unregister_hw() 1860 * before calling this function. 1861 * 1862 * @hw: the hardware to free 1863 */ 1864void ieee80211_free_hw(struct ieee80211_hw *hw); 1865 1866/** 1867 * ieee80211_restart_hw - restart hardware completely 1868 * 1869 * Call this function when the hardware was restarted for some reason 1870 * (hardware error, ...) and the driver is unable to restore its state 1871 * by itself. mac80211 assumes that at this point the driver/hardware 1872 * is completely uninitialised and stopped, it starts the process by 1873 * calling the ->start() operation. The driver will need to reset all 1874 * internal state that it has prior to calling this function. 1875 * 1876 * @hw: the hardware to restart 1877 */ 1878void ieee80211_restart_hw(struct ieee80211_hw *hw); 1879 1880/** 1881 * ieee80211_rx - receive frame 1882 * 1883 * Use this function to hand received frames to mac80211. The receive 1884 * buffer in @skb must start with an IEEE 802.11 header. In case of a 1885 * paged @skb is used, the driver is recommended to put the ieee80211 1886 * header of the frame on the linear part of the @skb to avoid memory 1887 * allocation and/or memcpy by the stack. 1888 * 1889 * This function may not be called in IRQ context. Calls to this function 1890 * for a single hardware must be synchronized against each other. Calls to 1891 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be 1892 * mixed for a single hardware. 1893 * 1894 * In process context use instead ieee80211_rx_ni(). 1895 * 1896 * @hw: the hardware this frame came in on 1897 * @skb: the buffer to receive, owned by mac80211 after this call 1898 */ 1899void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb); 1900 1901/** 1902 * ieee80211_rx_irqsafe - receive frame 1903 * 1904 * Like ieee80211_rx() but can be called in IRQ context 1905 * (internally defers to a tasklet.) 1906 * 1907 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not 1908 * be mixed for a single hardware. 1909 * 1910 * @hw: the hardware this frame came in on 1911 * @skb: the buffer to receive, owned by mac80211 after this call 1912 */ 1913void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb); 1914 1915/** 1916 * ieee80211_rx_ni - receive frame (in process context) 1917 * 1918 * Like ieee80211_rx() but can be called in process context 1919 * (internally disables bottom halves). 1920 * 1921 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may 1922 * not be mixed for a single hardware. 1923 * 1924 * @hw: the hardware this frame came in on 1925 * @skb: the buffer to receive, owned by mac80211 after this call 1926 */ 1927static inline void ieee80211_rx_ni(struct ieee80211_hw *hw, 1928 struct sk_buff *skb) 1929{ 1930 local_bh_disable(); 1931 ieee80211_rx(hw, skb); 1932 local_bh_enable(); 1933} 1934 1935/* 1936 * The TX headroom reserved by mac80211 for its own tx_status functions. 1937 * This is enough for the radiotap header. 1938 */ 1939#define IEEE80211_TX_STATUS_HEADROOM 13 1940 1941/** 1942 * ieee80211_tx_status - transmit status callback 1943 * 1944 * Call this function for all transmitted frames after they have been 1945 * transmitted. It is permissible to not call this function for 1946 * multicast frames but this can affect statistics. 1947 * 1948 * This function may not be called in IRQ context. Calls to this function 1949 * for a single hardware must be synchronized against each other. Calls 1950 * to this function and ieee80211_tx_status_irqsafe() may not be mixed 1951 * for a single hardware. 1952 * 1953 * @hw: the hardware the frame was transmitted by 1954 * @skb: the frame that was transmitted, owned by mac80211 after this call 1955 */ 1956void ieee80211_tx_status(struct ieee80211_hw *hw, 1957 struct sk_buff *skb); 1958 1959/** 1960 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback 1961 * 1962 * Like ieee80211_tx_status() but can be called in IRQ context 1963 * (internally defers to a tasklet.) 1964 * 1965 * Calls to this function and ieee80211_tx_status() may not be mixed for a 1966 * single hardware. 1967 * 1968 * @hw: the hardware the frame was transmitted by 1969 * @skb: the frame that was transmitted, owned by mac80211 after this call 1970 */ 1971void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 1972 struct sk_buff *skb); 1973 1974/** 1975 * ieee80211_beacon_get_tim - beacon generation function 1976 * @hw: pointer obtained from ieee80211_alloc_hw(). 1977 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 1978 * @tim_offset: pointer to variable that will receive the TIM IE offset. 1979 * Set to 0 if invalid (in non-AP modes). 1980 * @tim_length: pointer to variable that will receive the TIM IE length, 1981 * (including the ID and length bytes!). 1982 * Set to 0 if invalid (in non-AP modes). 1983 * 1984 * If the driver implements beaconing modes, it must use this function to 1985 * obtain the beacon frame/template. 1986 * 1987 * If the beacon frames are generated by the host system (i.e., not in 1988 * hardware/firmware), the driver uses this function to get each beacon 1989 * frame from mac80211 -- it is responsible for calling this function 1990 * before the beacon is needed (e.g. based on hardware interrupt). 1991 * 1992 * If the beacon frames are generated by the device, then the driver 1993 * must use the returned beacon as the template and change the TIM IE 1994 * according to the current DTIM parameters/TIM bitmap. 1995 * 1996 * The driver is responsible for freeing the returned skb. 1997 */ 1998struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw, 1999 struct ieee80211_vif *vif, 2000 u16 *tim_offset, u16 *tim_length); 2001 2002/** 2003 * ieee80211_beacon_get - beacon generation function 2004 * @hw: pointer obtained from ieee80211_alloc_hw(). 2005 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2006 * 2007 * See ieee80211_beacon_get_tim(). 2008 */ 2009static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 2010 struct ieee80211_vif *vif) 2011{ 2012 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL); 2013} 2014 2015/** 2016 * ieee80211_pspoll_get - retrieve a PS Poll template 2017 * @hw: pointer obtained from ieee80211_alloc_hw(). 2018 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2019 * 2020 * Creates a PS Poll a template which can, for example, uploaded to 2021 * hardware. The template must be updated after association so that correct 2022 * AID, BSSID and MAC address is used. 2023 * 2024 * Note: Caller (or hardware) is responsible for setting the 2025 * &IEEE80211_FCTL_PM bit. 2026 */ 2027struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw, 2028 struct ieee80211_vif *vif); 2029 2030/** 2031 * ieee80211_nullfunc_get - retrieve a nullfunc template 2032 * @hw: pointer obtained from ieee80211_alloc_hw(). 2033 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2034 * 2035 * Creates a Nullfunc template which can, for example, uploaded to 2036 * hardware. The template must be updated after association so that correct 2037 * BSSID and address is used. 2038 * 2039 * Note: Caller (or hardware) is responsible for setting the 2040 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields. 2041 */ 2042struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw, 2043 struct ieee80211_vif *vif); 2044 2045/** 2046 * ieee80211_probereq_get - retrieve a Probe Request template 2047 * @hw: pointer obtained from ieee80211_alloc_hw(). 2048 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2049 * @ssid: SSID buffer 2050 * @ssid_len: length of SSID 2051 * @ie: buffer containing all IEs except SSID for the template 2052 * @ie_len: length of the IE buffer 2053 * 2054 * Creates a Probe Request template which can, for example, be uploaded to 2055 * hardware. 2056 */ 2057struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw, 2058 struct ieee80211_vif *vif, 2059 const u8 *ssid, size_t ssid_len, 2060 const u8 *ie, size_t ie_len); 2061 2062/** 2063 * ieee80211_rts_get - RTS frame generation function 2064 * @hw: pointer obtained from ieee80211_alloc_hw(). 2065 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2066 * @frame: pointer to the frame that is going to be protected by the RTS. 2067 * @frame_len: the frame length (in octets). 2068 * @frame_txctl: &struct ieee80211_tx_info of the frame. 2069 * @rts: The buffer where to store the RTS frame. 2070 * 2071 * If the RTS frames are generated by the host system (i.e., not in 2072 * hardware/firmware), the low-level driver uses this function to receive 2073 * the next RTS frame from the 802.11 code. The low-level is responsible 2074 * for calling this function before and RTS frame is needed. 2075 */ 2076void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 2077 const void *frame, size_t frame_len, 2078 const struct ieee80211_tx_info *frame_txctl, 2079 struct ieee80211_rts *rts); 2080 2081/** 2082 * ieee80211_rts_duration - Get the duration field for an RTS frame 2083 * @hw: pointer obtained from ieee80211_alloc_hw(). 2084 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2085 * @frame_len: the length of the frame that is going to be protected by the RTS. 2086 * @frame_txctl: &struct ieee80211_tx_info of the frame. 2087 * 2088 * If the RTS is generated in firmware, but the host system must provide 2089 * the duration field, the low-level driver uses this function to receive 2090 * the duration field value in little-endian byteorder. 2091 */ 2092__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, 2093 struct ieee80211_vif *vif, size_t frame_len, 2094 const struct ieee80211_tx_info *frame_txctl); 2095 2096/** 2097 * ieee80211_ctstoself_get - CTS-to-self frame generation function 2098 * @hw: pointer obtained from ieee80211_alloc_hw(). 2099 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2100 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 2101 * @frame_len: the frame length (in octets). 2102 * @frame_txctl: &struct ieee80211_tx_info of the frame. 2103 * @cts: The buffer where to store the CTS-to-self frame. 2104 * 2105 * If the CTS-to-self frames are generated by the host system (i.e., not in 2106 * hardware/firmware), the low-level driver uses this function to receive 2107 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 2108 * for calling this function before and CTS-to-self frame is needed. 2109 */ 2110void ieee80211_ctstoself_get(struct ieee80211_hw *hw, 2111 struct ieee80211_vif *vif, 2112 const void *frame, size_t frame_len, 2113 const struct ieee80211_tx_info *frame_txctl, 2114 struct ieee80211_cts *cts); 2115 2116/** 2117 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 2118 * @hw: pointer obtained from ieee80211_alloc_hw(). 2119 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2120 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 2121 * @frame_txctl: &struct ieee80211_tx_info of the frame. 2122 * 2123 * If the CTS-to-self is generated in firmware, but the host system must provide 2124 * the duration field, the low-level driver uses this function to receive 2125 * the duration field value in little-endian byteorder. 2126 */ 2127__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, 2128 struct ieee80211_vif *vif, 2129 size_t frame_len, 2130 const struct ieee80211_tx_info *frame_txctl); 2131 2132/** 2133 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 2134 * @hw: pointer obtained from ieee80211_alloc_hw(). 2135 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2136 * @frame_len: the length of the frame. 2137 * @rate: the rate at which the frame is going to be transmitted. 2138 * 2139 * Calculate the duration field of some generic frame, given its 2140 * length and transmission rate (in 100kbps). 2141 */ 2142__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, 2143 struct ieee80211_vif *vif, 2144 size_t frame_len, 2145 struct ieee80211_rate *rate); 2146 2147/** 2148 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 2149 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2150 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2151 * 2152 * Function for accessing buffered broadcast and multicast frames. If 2153 * hardware/firmware does not implement buffering of broadcast/multicast 2154 * frames when power saving is used, 802.11 code buffers them in the host 2155 * memory. The low-level driver uses this function to fetch next buffered 2156 * frame. In most cases, this is used when generating beacon frame. This 2157 * function returns a pointer to the next buffered skb or NULL if no more 2158 * buffered frames are available. 2159 * 2160 * Note: buffered frames are returned only after DTIM beacon frame was 2161 * generated with ieee80211_beacon_get() and the low-level driver must thus 2162 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 2163 * NULL if the previous generated beacon was not DTIM, so the low-level driver 2164 * does not need to check for DTIM beacons separately and should be able to 2165 * use common code for all beacons. 2166 */ 2167struct sk_buff * 2168ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 2169 2170/** 2171 * ieee80211_get_tkip_key - get a TKIP rc4 for skb 2172 * 2173 * This function computes a TKIP rc4 key for an skb. It computes 2174 * a phase 1 key if needed (iv16 wraps around). This function is to 2175 * be used by drivers which can do HW encryption but need to compute 2176 * to phase 1/2 key in SW. 2177 * 2178 * @keyconf: the parameter passed with the set key 2179 * @skb: the skb for which the key is needed 2180 * @type: TBD 2181 * @key: a buffer to which the key will be written 2182 */ 2183void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf, 2184 struct sk_buff *skb, 2185 enum ieee80211_tkip_key_type type, u8 *key); 2186/** 2187 * ieee80211_wake_queue - wake specific queue 2188 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2189 * @queue: queue number (counted from zero). 2190 * 2191 * Drivers should use this function instead of netif_wake_queue. 2192 */ 2193void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 2194 2195/** 2196 * ieee80211_stop_queue - stop specific queue 2197 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2198 * @queue: queue number (counted from zero). 2199 * 2200 * Drivers should use this function instead of netif_stop_queue. 2201 */ 2202void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 2203 2204/** 2205 * ieee80211_queue_stopped - test status of the queue 2206 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2207 * @queue: queue number (counted from zero). 2208 * 2209 * Drivers should use this function instead of netif_stop_queue. 2210 */ 2211 2212int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); 2213 2214/** 2215 * ieee80211_stop_queues - stop all queues 2216 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2217 * 2218 * Drivers should use this function instead of netif_stop_queue. 2219 */ 2220void ieee80211_stop_queues(struct ieee80211_hw *hw); 2221 2222/** 2223 * ieee80211_wake_queues - wake all queues 2224 * @hw: pointer as obtained from ieee80211_alloc_hw(). 2225 * 2226 * Drivers should use this function instead of netif_wake_queue. 2227 */ 2228void ieee80211_wake_queues(struct ieee80211_hw *hw); 2229 2230/** 2231 * ieee80211_scan_completed - completed hardware scan 2232 * 2233 * When hardware scan offload is used (i.e. the hw_scan() callback is 2234 * assigned) this function needs to be called by the driver to notify 2235 * mac80211 that the scan finished. 2236 * 2237 * @hw: the hardware that finished the scan 2238 * @aborted: set to true if scan was aborted 2239 */ 2240void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted); 2241 2242/** 2243 * ieee80211_iterate_active_interfaces - iterate active interfaces 2244 * 2245 * This function iterates over the interfaces associated with a given 2246 * hardware that are currently active and calls the callback for them. 2247 * This function allows the iterator function to sleep, when the iterator 2248 * function is atomic @ieee80211_iterate_active_interfaces_atomic can 2249 * be used. 2250 * 2251 * @hw: the hardware struct of which the interfaces should be iterated over 2252 * @iterator: the iterator function to call 2253 * @data: first argument of the iterator function 2254 */ 2255void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, 2256 void (*iterator)(void *data, u8 *mac, 2257 struct ieee80211_vif *vif), 2258 void *data); 2259 2260/** 2261 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces 2262 * 2263 * This function iterates over the interfaces associated with a given 2264 * hardware that are currently active and calls the callback for them. 2265 * This function requires the iterator callback function to be atomic, 2266 * if that is not desired, use @ieee80211_iterate_active_interfaces instead. 2267 * 2268 * @hw: the hardware struct of which the interfaces should be iterated over 2269 * @iterator: the iterator function to call, cannot sleep 2270 * @data: first argument of the iterator function 2271 */ 2272void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw, 2273 void (*iterator)(void *data, 2274 u8 *mac, 2275 struct ieee80211_vif *vif), 2276 void *data); 2277 2278/** 2279 * ieee80211_queue_work - add work onto the mac80211 workqueue 2280 * 2281 * Drivers and mac80211 use this to add work onto the mac80211 workqueue. 2282 * This helper ensures drivers are not queueing work when they should not be. 2283 * 2284 * @hw: the hardware struct for the interface we are adding work for 2285 * @work: the work we want to add onto the mac80211 workqueue 2286 */ 2287void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work); 2288 2289/** 2290 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue 2291 * 2292 * Drivers and mac80211 use this to queue delayed work onto the mac80211 2293 * workqueue. 2294 * 2295 * @hw: the hardware struct for the interface we are adding work for 2296 * @dwork: delayable work to queue onto the mac80211 workqueue 2297 * @delay: number of jiffies to wait before queueing 2298 */ 2299void ieee80211_queue_delayed_work(struct ieee80211_hw *hw, 2300 struct delayed_work *dwork, 2301 unsigned long delay); 2302 2303/** 2304 * ieee80211_start_tx_ba_session - Start a tx Block Ack session. 2305 * @sta: the station for which to start a BA session 2306 * @tid: the TID to BA on. 2307 * 2308 * Return: success if addBA request was sent, failure otherwise 2309 * 2310 * Although mac80211/low level driver/user space application can estimate 2311 * the need to start aggregation on a certain RA/TID, the session level 2312 * will be managed by the mac80211. 2313 */ 2314int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid); 2315 2316/** 2317 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate. 2318 * @vif: &struct ieee80211_vif pointer from the add_interface callback 2319 * @ra: receiver address of the BA session recipient. 2320 * @tid: the TID to BA on. 2321 * 2322 * This function must be called by low level driver once it has 2323 * finished with preparations for the BA session. 2324 */ 2325void ieee80211_start_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u16 tid); 2326 2327/** 2328 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate. 2329 * @vif: &struct ieee80211_vif pointer from the add_interface callback 2330 * @ra: receiver address of the BA session recipient. 2331 * @tid: the TID to BA on. 2332 * 2333 * This function must be called by low level driver once it has 2334 * finished with preparations for the BA session. 2335 * This version of the function is IRQ-safe. 2336 */ 2337void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, 2338 u16 tid); 2339 2340/** 2341 * ieee80211_stop_tx_ba_session - Stop a Block Ack session. 2342 * @sta: the station whose BA session to stop 2343 * @tid: the TID to stop BA. 2344 * 2345 * Return: negative error if the TID is invalid, or no aggregation active 2346 * 2347 * Although mac80211/low level driver/user space application can estimate 2348 * the need to stop aggregation on a certain RA/TID, the session level 2349 * will be managed by the mac80211. 2350 */ 2351int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid); 2352 2353/** 2354 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate. 2355 * @vif: &struct ieee80211_vif pointer from the add_interface callback 2356 * @ra: receiver address of the BA session recipient. 2357 * @tid: the desired TID to BA on. 2358 * 2359 * This function must be called by low level driver once it has 2360 * finished with preparations for the BA session tear down. 2361 */ 2362void ieee80211_stop_tx_ba_cb(struct ieee80211_vif *vif, u8 *ra, u8 tid); 2363 2364/** 2365 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate. 2366 * @vif: &struct ieee80211_vif pointer from the add_interface callback 2367 * @ra: receiver address of the BA session recipient. 2368 * @tid: the desired TID to BA on. 2369 * 2370 * This function must be called by low level driver once it has 2371 * finished with preparations for the BA session tear down. 2372 * This version of the function is IRQ-safe. 2373 */ 2374void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, 2375 u16 tid); 2376 2377/** 2378 * ieee80211_find_sta - find a station 2379 * 2380 * @vif: virtual interface to look for station on 2381 * @addr: station's address 2382 * 2383 * This function must be called under RCU lock and the 2384 * resulting pointer is only valid under RCU lock as well. 2385 */ 2386struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif, 2387 const u8 *addr); 2388 2389/** 2390 * ieee80211_find_sta_by_hw - find a station on hardware 2391 * 2392 * @hw: pointer as obtained from ieee80211_alloc_hw() 2393 * @addr: station's address 2394 * 2395 * This function must be called under RCU lock and the 2396 * resulting pointer is only valid under RCU lock as well. 2397 * 2398 * NOTE: This function should not be used! When mac80211 is converted 2399 * internally to properly keep track of stations on multiple 2400 * virtual interfaces, it will not always know which station to 2401 * return here since a single address might be used by multiple 2402 * logical stations (e.g. consider a station connecting to another 2403 * BSSID on the same AP hardware without disconnecting first). 2404 * 2405 * DO NOT USE THIS FUNCTION. 2406 */ 2407struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw, 2408 const u8 *addr); 2409 2410/** 2411 * ieee80211_sta_block_awake - block station from waking up 2412 * @hw: the hardware 2413 * @pubsta: the station 2414 * @block: whether to block or unblock 2415 * 2416 * Some devices require that all frames that are on the queues 2417 * for a specific station that went to sleep are flushed before 2418 * a poll response or frames after the station woke up can be 2419 * delivered to that it. Note that such frames must be rejected 2420 * by the driver as filtered, with the appropriate status flag. 2421 * 2422 * This function allows implementing this mode in a race-free 2423 * manner. 2424 * 2425 * To do this, a driver must keep track of the number of frames 2426 * still enqueued for a specific station. If this number is not 2427 * zero when the station goes to sleep, the driver must call 2428 * this function to force mac80211 to consider the station to 2429 * be asleep regardless of the station's actual state. Once the 2430 * number of outstanding frames reaches zero, the driver must 2431 * call this function again to unblock the station. That will 2432 * cause mac80211 to be able to send ps-poll responses, and if 2433 * the station queried in the meantime then frames will also 2434 * be sent out as a result of this. Additionally, the driver 2435 * will be notified that the station woke up some time after 2436 * it is unblocked, regardless of whether the station actually 2437 * woke up while blocked or not. 2438 */ 2439void ieee80211_sta_block_awake(struct ieee80211_hw *hw, 2440 struct ieee80211_sta *pubsta, bool block); 2441 2442/** 2443 * ieee80211_beacon_loss - inform hardware does not receive beacons 2444 * 2445 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2446 * 2447 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING and 2448 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the 2449 * hardware is not receiving beacons with this function. 2450 */ 2451void ieee80211_beacon_loss(struct ieee80211_vif *vif); 2452 2453/** 2454 * ieee80211_connection_loss - inform hardware has lost connection to the AP 2455 * 2456 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2457 * 2458 * When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTERING, and 2459 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver 2460 * needs to inform if the connection to the AP has been lost. 2461 * 2462 * This function will cause immediate change to disassociated state, 2463 * without connection recovery attempts. 2464 */ 2465void ieee80211_connection_loss(struct ieee80211_vif *vif); 2466 2467/** 2468 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring 2469 * rssi threshold triggered 2470 * 2471 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2472 * @rssi_event: the RSSI trigger event type 2473 * @gfp: context flags 2474 * 2475 * When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality 2476 * monitoring is configured with an rssi threshold, the driver will inform 2477 * whenever the rssi level reaches the threshold. 2478 */ 2479void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif, 2480 enum nl80211_cqm_rssi_threshold_event rssi_event, 2481 gfp_t gfp); 2482 2483/** 2484 * ieee80211_chswitch_done - Complete channel switch process 2485 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2486 * @success: make the channel switch successful or not 2487 * 2488 * Complete the channel switch post-process: set the new operational channel 2489 * and wake up the suspended queues. 2490 */ 2491void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success); 2492 2493/* Rate control API */ 2494 2495/** 2496 * enum rate_control_changed - flags to indicate which parameter changed 2497 * 2498 * @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have 2499 * changed, rate control algorithm can update its internal state if needed. 2500 */ 2501enum rate_control_changed { 2502 IEEE80211_RC_HT_CHANGED = BIT(0) 2503}; 2504 2505/** 2506 * struct ieee80211_tx_rate_control - rate control information for/from RC algo 2507 * 2508 * @hw: The hardware the algorithm is invoked for. 2509 * @sband: The band this frame is being transmitted on. 2510 * @bss_conf: the current BSS configuration 2511 * @reported_rate: The rate control algorithm can fill this in to indicate 2512 * which rate should be reported to userspace as the current rate and 2513 * used for rate calculations in the mesh network. 2514 * @rts: whether RTS will be used for this frame because it is longer than the 2515 * RTS threshold 2516 * @short_preamble: whether mac80211 will request short-preamble transmission 2517 * if the selected rate supports it 2518 * @max_rate_idx: user-requested maximum rate (not MCS for now) 2519 * (deprecated; this will be removed once drivers get updated to use 2520 * rate_idx_mask) 2521 * @rate_idx_mask: user-requested rate mask (not MCS for now) 2522 * @skb: the skb that will be transmitted, the control information in it needs 2523 * to be filled in 2524 * @ap: whether this frame is sent out in AP mode 2525 */ 2526struct ieee80211_tx_rate_control { 2527 struct ieee80211_hw *hw; 2528 struct ieee80211_supported_band *sband; 2529 struct ieee80211_bss_conf *bss_conf; 2530 struct sk_buff *skb; 2531 struct ieee80211_tx_rate reported_rate; 2532 bool rts, short_preamble; 2533 u8 max_rate_idx; 2534 u32 rate_idx_mask; 2535 bool ap; 2536}; 2537 2538struct rate_control_ops { 2539 struct module *module; 2540 const char *name; 2541 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir); 2542 void (*free)(void *priv); 2543 2544 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp); 2545 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband, 2546 struct ieee80211_sta *sta, void *priv_sta); 2547 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband, 2548 struct ieee80211_sta *sta, 2549 void *priv_sta, u32 changed, 2550 enum nl80211_channel_type oper_chan_type); 2551 void (*free_sta)(void *priv, struct ieee80211_sta *sta, 2552 void *priv_sta); 2553 2554 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband, 2555 struct ieee80211_sta *sta, void *priv_sta, 2556 struct sk_buff *skb); 2557 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta, 2558 struct ieee80211_tx_rate_control *txrc); 2559 2560 void (*add_sta_debugfs)(void *priv, void *priv_sta, 2561 struct dentry *dir); 2562 void (*remove_sta_debugfs)(void *priv, void *priv_sta); 2563}; 2564 2565static inline int rate_supported(struct ieee80211_sta *sta, 2566 enum ieee80211_band band, 2567 int index) 2568{ 2569 return (sta == NULL || sta->supp_rates[band] & BIT(index)); 2570} 2571 2572/** 2573 * rate_control_send_low - helper for drivers for management/no-ack frames 2574 * 2575 * Rate control algorithms that agree to use the lowest rate to 2576 * send management frames and NO_ACK data with the respective hw 2577 * retries should use this in the beginning of their mac80211 get_rate 2578 * callback. If true is returned the rate control can simply return. 2579 * If false is returned we guarantee that sta and sta and priv_sta is 2580 * not null. 2581 * 2582 * Rate control algorithms wishing to do more intelligent selection of 2583 * rate for multicast/broadcast frames may choose to not use this. 2584 * 2585 * @sta: &struct ieee80211_sta pointer to the target destination. Note 2586 * that this may be null. 2587 * @priv_sta: private rate control structure. This may be null. 2588 * @txrc: rate control information we sholud populate for mac80211. 2589 */ 2590bool rate_control_send_low(struct ieee80211_sta *sta, 2591 void *priv_sta, 2592 struct ieee80211_tx_rate_control *txrc); 2593 2594 2595static inline s8 2596rate_lowest_index(struct ieee80211_supported_band *sband, 2597 struct ieee80211_sta *sta) 2598{ 2599 int i; 2600 2601 for (i = 0; i < sband->n_bitrates; i++) 2602 if (rate_supported(sta, sband->band, i)) 2603 return i; 2604 2605 /* warn when we cannot find a rate. */ 2606 WARN_ON(1); 2607 2608 return 0; 2609} 2610 2611static inline 2612bool rate_usable_index_exists(struct ieee80211_supported_band *sband, 2613 struct ieee80211_sta *sta) 2614{ 2615 unsigned int i; 2616 2617 for (i = 0; i < sband->n_bitrates; i++) 2618 if (rate_supported(sta, sband->band, i)) 2619 return true; 2620 return false; 2621} 2622 2623int ieee80211_rate_control_register(struct rate_control_ops *ops); 2624void ieee80211_rate_control_unregister(struct rate_control_ops *ops); 2625 2626static inline bool 2627conf_is_ht20(struct ieee80211_conf *conf) 2628{ 2629 return conf->channel_type == NL80211_CHAN_HT20; 2630} 2631 2632static inline bool 2633conf_is_ht40_minus(struct ieee80211_conf *conf) 2634{ 2635 return conf->channel_type == NL80211_CHAN_HT40MINUS; 2636} 2637 2638static inline bool 2639conf_is_ht40_plus(struct ieee80211_conf *conf) 2640{ 2641 return conf->channel_type == NL80211_CHAN_HT40PLUS; 2642} 2643 2644static inline bool 2645conf_is_ht40(struct ieee80211_conf *conf) 2646{ 2647 return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf); 2648} 2649 2650static inline bool 2651conf_is_ht(struct ieee80211_conf *conf) 2652{ 2653 return conf->channel_type != NL80211_CHAN_NO_HT; 2654} 2655 2656#endif /* MAC80211_H */ 2657