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