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