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