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-2008 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/wireless.h> 23 #include <net/cfg80211.h> 24 25 /** 26 * DOC: Introduction 27 * 28 * mac80211 is the Linux stack for 802.11 hardware that implements 29 * only partial functionality in hard- or firmware. This document 30 * defines the interface between mac80211 and low-level hardware 31 * drivers. 32 */ 33 34 /** 35 * DOC: Calling mac80211 from interrupts 36 * 37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be 38 * called in hardware interrupt context. The low-level driver must not call any 39 * other functions in hardware interrupt context. If there is a need for such 40 * call, the low-level driver should first ACK the interrupt and perform the 41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even 42 * tasklet function. 43 * 44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also 45 * use the non-IRQ-safe functions! 46 */ 47 48 /** 49 * DOC: Warning 50 * 51 * If you're reading this document and not the header file itself, it will 52 * be incomplete because not all documentation has been converted yet. 53 */ 54 55 /** 56 * DOC: Frame format 57 * 58 * As a general rule, when frames are passed between mac80211 and the driver, 59 * they start with the IEEE 802.11 header and include the same octets that are 60 * sent over the air except for the FCS which should be calculated by the 61 * hardware. 62 * 63 * There are, however, various exceptions to this rule for advanced features: 64 * 65 * The first exception is for hardware encryption and decryption offload 66 * where the IV/ICV may or may not be generated in hardware. 67 * 68 * Secondly, when the hardware handles fragmentation, the frame handed to 69 * the driver from mac80211 is the MSDU, not the MPDU. 70 * 71 * Finally, for received frames, the driver is able to indicate that it has 72 * filled a radiotap header and put that in front of the frame; if it does 73 * not do so then mac80211 may add this under certain circumstances. 74 */ 75 76 /** 77 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics 78 * 79 * This structure describes most essential parameters needed 80 * to describe 802.11n HT characteristics in a BSS. 81 * 82 * @primary_channel: channel number of primery channel 83 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width) 84 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection) 85 */ 86 struct ieee80211_ht_bss_info { 87 u8 primary_channel; 88 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */ 89 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */ 90 }; 91 92 /** 93 * enum ieee80211_max_queues - maximum number of queues 94 * 95 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues. 96 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable 97 * for A-MPDU operation. 98 */ 99 enum ieee80211_max_queues { 100 IEEE80211_MAX_QUEUES = 16, 101 IEEE80211_MAX_AMPDU_QUEUES = 16, 102 }; 103 104 /** 105 * struct ieee80211_tx_queue_params - transmit queue configuration 106 * 107 * The information provided in this structure is required for QoS 108 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29. 109 * 110 * @aifs: arbitration interframe space [0..255] 111 * @cw_min: minimum contention window [a value of the form 112 * 2^n-1 in the range 1..32767] 113 * @cw_max: maximum contention window [like @cw_min] 114 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled 115 */ 116 struct ieee80211_tx_queue_params { 117 u16 txop; 118 u16 cw_min; 119 u16 cw_max; 120 u8 aifs; 121 }; 122 123 /** 124 * struct ieee80211_tx_queue_stats - transmit queue statistics 125 * 126 * @len: number of packets in queue 127 * @limit: queue length limit 128 * @count: number of frames sent 129 */ 130 struct ieee80211_tx_queue_stats { 131 unsigned int len; 132 unsigned int limit; 133 unsigned int count; 134 }; 135 136 struct ieee80211_low_level_stats { 137 unsigned int dot11ACKFailureCount; 138 unsigned int dot11RTSFailureCount; 139 unsigned int dot11FCSErrorCount; 140 unsigned int dot11RTSSuccessCount; 141 }; 142 143 /** 144 * enum ieee80211_bss_change - BSS change notification flags 145 * 146 * These flags are used with the bss_info_changed() callback 147 * to indicate which BSS parameter changed. 148 * 149 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated), 150 * also implies a change in the AID. 151 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed 152 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed 153 * @BSS_CHANGED_ERP_SLOT: slot timing changed 154 * @BSS_CHANGED_HT: 802.11n parameters changed 155 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed 156 */ 157 enum ieee80211_bss_change { 158 BSS_CHANGED_ASSOC = 1<<0, 159 BSS_CHANGED_ERP_CTS_PROT = 1<<1, 160 BSS_CHANGED_ERP_PREAMBLE = 1<<2, 161 BSS_CHANGED_ERP_SLOT = 1<<3, 162 BSS_CHANGED_HT = 1<<4, 163 BSS_CHANGED_BASIC_RATES = 1<<5, 164 }; 165 166 /** 167 * struct ieee80211_bss_ht_conf - BSS's changing HT configuration 168 * @operation_mode: HT operation mode (like in &struct ieee80211_ht_info) 169 */ 170 struct ieee80211_bss_ht_conf { 171 u16 operation_mode; 172 }; 173 174 /** 175 * struct ieee80211_bss_conf - holds the BSS's changing parameters 176 * 177 * This structure keeps information about a BSS (and an association 178 * to that BSS) that can change during the lifetime of the BSS. 179 * 180 * @assoc: association status 181 * @aid: association ID number, valid only when @assoc is true 182 * @use_cts_prot: use CTS protection 183 * @use_short_preamble: use 802.11b short preamble; 184 * if the hardware cannot handle this it must set the 185 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag 186 * @use_short_slot: use short slot time (only relevant for ERP); 187 * if the hardware cannot handle this it must set the 188 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag 189 * @dtim_period: num of beacons before the next DTIM, for PSM 190 * @timestamp: beacon timestamp 191 * @beacon_int: beacon interval 192 * @assoc_capability: capabilities taken from assoc resp 193 * @ht: BSS's HT configuration 194 * @basic_rates: bitmap of basic rates, each bit stands for an 195 * index into the rate table configured by the driver in 196 * the current band. 197 */ 198 struct ieee80211_bss_conf { 199 /* association related data */ 200 bool assoc; 201 u16 aid; 202 /* erp related data */ 203 bool use_cts_prot; 204 bool use_short_preamble; 205 bool use_short_slot; 206 u8 dtim_period; 207 u16 beacon_int; 208 u16 assoc_capability; 209 u64 timestamp; 210 u64 basic_rates; 211 struct ieee80211_bss_ht_conf ht; 212 }; 213 214 /** 215 * enum mac80211_tx_control_flags - flags to describe transmission information/status 216 * 217 * These flags are used with the @flags member of &ieee80211_tx_info. 218 * 219 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame. 220 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence 221 * number to this frame, taking care of not overwriting the fragment 222 * number and increasing the sequence number only when the 223 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly 224 * assign sequence numbers to QoS-data frames but cannot do so correctly 225 * for non-QoS-data and management frames because beacons need them from 226 * that counter as well and mac80211 cannot guarantee proper sequencing. 227 * If this flag is set, the driver should instruct the hardware to 228 * assign a sequence number to the frame or assign one itself. Cf. IEEE 229 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for 230 * beacons and always be clear for frames without a sequence number field. 231 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack 232 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination 233 * station 234 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame 235 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon 236 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU 237 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211. 238 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted 239 * because the destination STA was in powersave mode. 240 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged 241 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status 242 * is for the whole aggregation. 243 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned, 244 * so consider using block ack request (BAR). 245 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be 246 * set by rate control algorithms to indicate probe rate, will 247 * be cleared for fragmented frames (except on the last fragment) 248 */ 249 enum mac80211_tx_control_flags { 250 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0), 251 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1), 252 IEEE80211_TX_CTL_NO_ACK = BIT(2), 253 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3), 254 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4), 255 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5), 256 IEEE80211_TX_CTL_AMPDU = BIT(6), 257 IEEE80211_TX_CTL_INJECTED = BIT(7), 258 IEEE80211_TX_STAT_TX_FILTERED = BIT(8), 259 IEEE80211_TX_STAT_ACK = BIT(9), 260 IEEE80211_TX_STAT_AMPDU = BIT(10), 261 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11), 262 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12), 263 }; 264 265 enum mac80211_rate_control_flags { 266 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0), 267 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1), 268 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2), 269 270 /* rate index is an MCS rate number instead of an index */ 271 IEEE80211_TX_RC_MCS = BIT(3), 272 IEEE80211_TX_RC_GREEN_FIELD = BIT(4), 273 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5), 274 IEEE80211_TX_RC_DUP_DATA = BIT(6), 275 IEEE80211_TX_RC_SHORT_GI = BIT(7), 276 }; 277 278 279 /* there are 40 bytes if you don't need the rateset to be kept */ 280 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40 281 282 /* if you do need the rateset, then you have less space */ 283 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24 284 285 /* maximum number of rate stages */ 286 #define IEEE80211_TX_MAX_RATES 5 287 288 /** 289 * struct ieee80211_tx_rate - rate selection/status 290 * 291 * @idx: rate index to attempt to send with 292 * @flags: rate control flags (&enum mac80211_rate_control_flags) 293 * @count: number of tries in this rate before going to the next rate 294 * 295 * A value of -1 for @idx indicates an invalid rate and, if used 296 * in an array of retry rates, that no more rates should be tried. 297 * 298 * When used for transmit status reporting, the driver should 299 * always report the rate along with the flags it used. 300 */ 301 struct ieee80211_tx_rate { 302 s8 idx; 303 u8 count; 304 u8 flags; 305 } __attribute__((packed)); 306 307 /** 308 * struct ieee80211_tx_info - skb transmit information 309 * 310 * This structure is placed in skb->cb for three uses: 311 * (1) mac80211 TX control - mac80211 tells the driver what to do 312 * (2) driver internal use (if applicable) 313 * (3) TX status information - driver tells mac80211 what happened 314 * 315 * The TX control's sta pointer is only valid during the ->tx call, 316 * it may be NULL. 317 * 318 * @flags: transmit info flags, defined above 319 * @band: the band to transmit on (use for checking for races) 320 * @antenna_sel_tx: antenna to use, 0 for automatic diversity 321 * @pad: padding, ignore 322 * @control: union for control data 323 * @status: union for status data 324 * @driver_data: array of driver_data pointers 325 * @ampdu_ack_len: number of aggregated frames. 326 * relevant only if IEEE80211_TX_STATUS_AMPDU was set. 327 * @ampdu_ack_map: block ack bit map for the aggregation. 328 * relevant only if IEEE80211_TX_STATUS_AMPDU was set. 329 * @ack_signal: signal strength of the ACK frame 330 */ 331 struct ieee80211_tx_info { 332 /* common information */ 333 u32 flags; 334 u8 band; 335 336 u8 antenna_sel_tx; 337 338 /* 2 byte hole */ 339 u8 pad[2]; 340 341 union { 342 struct { 343 union { 344 /* rate control */ 345 struct { 346 struct ieee80211_tx_rate rates[ 347 IEEE80211_TX_MAX_RATES]; 348 s8 rts_cts_rate_idx; 349 }; 350 /* only needed before rate control */ 351 unsigned long jiffies; 352 }; 353 /* NB: vif can be NULL for injected frames */ 354 struct ieee80211_vif *vif; 355 struct ieee80211_key_conf *hw_key; 356 struct ieee80211_sta *sta; 357 } control; 358 struct { 359 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES]; 360 u8 ampdu_ack_len; 361 u64 ampdu_ack_map; 362 int ack_signal; 363 /* 8 bytes free */ 364 } status; 365 struct { 366 struct ieee80211_tx_rate driver_rates[ 367 IEEE80211_TX_MAX_RATES]; 368 void *rate_driver_data[ 369 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)]; 370 }; 371 void *driver_data[ 372 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)]; 373 }; 374 }; 375 376 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb) 377 { 378 return (struct ieee80211_tx_info *)skb->cb; 379 } 380 381 /** 382 * ieee80211_tx_info_clear_status - clear TX status 383 * 384 * @info: The &struct ieee80211_tx_info to be cleared. 385 * 386 * When the driver passes an skb back to mac80211, it must report 387 * a number of things in TX status. This function clears everything 388 * in the TX status but the rate control information (it does clear 389 * the count since you need to fill that in anyway). 390 * 391 * NOTE: You can only use this function if you do NOT use 392 * info->driver_data! Use info->rate_driver_data 393 * instead if you need only the less space that allows. 394 */ 395 static inline void 396 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info) 397 { 398 int i; 399 400 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 401 offsetof(struct ieee80211_tx_info, control.rates)); 402 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 403 offsetof(struct ieee80211_tx_info, driver_rates)); 404 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8); 405 /* clear the rate counts */ 406 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) 407 info->status.rates[i].count = 0; 408 409 BUILD_BUG_ON( 410 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23); 411 memset(&info->status.ampdu_ack_len, 0, 412 sizeof(struct ieee80211_tx_info) - 413 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len)); 414 } 415 416 417 /** 418 * enum mac80211_rx_flags - receive flags 419 * 420 * These flags are used with the @flag member of &struct ieee80211_rx_status. 421 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. 422 * Use together with %RX_FLAG_MMIC_STRIPPED. 423 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. 424 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header. 425 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, 426 * verification has been done by the hardware. 427 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame. 428 * If this flag is set, the stack cannot do any replay detection 429 * hence the driver or hardware will have to do that. 430 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on 431 * the frame. 432 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on 433 * the frame. 434 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field) 435 * is valid. This is useful in monitor mode and necessary for beacon frames 436 * to enable IBSS merging. 437 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame 438 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index 439 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used 440 * @RX_FLAG_SHORT_GI: Short guard interval was used 441 */ 442 enum mac80211_rx_flags { 443 RX_FLAG_MMIC_ERROR = 1<<0, 444 RX_FLAG_DECRYPTED = 1<<1, 445 RX_FLAG_RADIOTAP = 1<<2, 446 RX_FLAG_MMIC_STRIPPED = 1<<3, 447 RX_FLAG_IV_STRIPPED = 1<<4, 448 RX_FLAG_FAILED_FCS_CRC = 1<<5, 449 RX_FLAG_FAILED_PLCP_CRC = 1<<6, 450 RX_FLAG_TSFT = 1<<7, 451 RX_FLAG_SHORTPRE = 1<<8, 452 RX_FLAG_HT = 1<<9, 453 RX_FLAG_40MHZ = 1<<10, 454 RX_FLAG_SHORT_GI = 1<<11, 455 }; 456 457 /** 458 * struct ieee80211_rx_status - receive status 459 * 460 * The low-level driver should provide this information (the subset 461 * supported by hardware) to the 802.11 code with each received 462 * frame. 463 * 464 * @mactime: value in microseconds of the 64-bit Time Synchronization Function 465 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware. 466 * @band: the active band when this frame was received 467 * @freq: frequency the radio was tuned to when receiving this frame, in MHz 468 * @signal: signal strength when receiving this frame, either in dBm, in dB or 469 * unspecified depending on the hardware capabilities flags 470 * @IEEE80211_HW_SIGNAL_* 471 * @noise: noise when receiving this frame, in dBm. 472 * @qual: overall signal quality indication, in percent (0-100). 473 * @antenna: antenna used 474 * @rate_idx: index of data rate into band's supported rates or MCS index if 475 * HT rates are use (RX_FLAG_HT) 476 * @flag: %RX_FLAG_* 477 */ 478 struct ieee80211_rx_status { 479 u64 mactime; 480 enum ieee80211_band band; 481 int freq; 482 int signal; 483 int noise; 484 int qual; 485 int antenna; 486 int rate_idx; 487 int flag; 488 }; 489 490 /** 491 * enum ieee80211_conf_flags - configuration flags 492 * 493 * Flags to define PHY configuration options 494 * 495 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported) 496 * @IEEE80211_CONF_PS: Enable 802.11 power save mode 497 */ 498 enum ieee80211_conf_flags { 499 IEEE80211_CONF_RADIOTAP = (1<<0), 500 IEEE80211_CONF_PS = (1<<1), 501 }; 502 503 /* XXX: remove all this once drivers stop trying to use it */ 504 static inline int __deprecated __IEEE80211_CONF_SHORT_SLOT_TIME(void) 505 { 506 return 0; 507 } 508 #define IEEE80211_CONF_SHORT_SLOT_TIME (__IEEE80211_CONF_SHORT_SLOT_TIME()) 509 510 struct ieee80211_ht_conf { 511 bool enabled; 512 enum nl80211_channel_type channel_type; 513 }; 514 515 /** 516 * enum ieee80211_conf_changed - denotes which configuration changed 517 * 518 * @IEEE80211_CONF_CHANGE_RADIO_ENABLED: the value of radio_enabled changed 519 * @IEEE80211_CONF_CHANGE_BEACON_INTERVAL: the beacon interval changed 520 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed 521 * @IEEE80211_CONF_CHANGE_RADIOTAP: the radiotap flag changed 522 * @IEEE80211_CONF_CHANGE_PS: the PS flag changed 523 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed 524 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel changed 525 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed 526 * @IEEE80211_CONF_CHANGE_HT: HT configuration changed 527 */ 528 enum ieee80211_conf_changed { 529 IEEE80211_CONF_CHANGE_RADIO_ENABLED = BIT(0), 530 IEEE80211_CONF_CHANGE_BEACON_INTERVAL = BIT(1), 531 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2), 532 IEEE80211_CONF_CHANGE_RADIOTAP = BIT(3), 533 IEEE80211_CONF_CHANGE_PS = BIT(4), 534 IEEE80211_CONF_CHANGE_POWER = BIT(5), 535 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6), 536 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7), 537 IEEE80211_CONF_CHANGE_HT = BIT(8), 538 }; 539 540 /** 541 * struct ieee80211_conf - configuration of the device 542 * 543 * This struct indicates how the driver shall configure the hardware. 544 * 545 * @radio_enabled: when zero, driver is required to switch off the radio. 546 * @beacon_int: beacon interval (TODO make interface config) 547 * @listen_interval: listen interval in units of beacon interval 548 * @flags: configuration flags defined above 549 * @power_level: requested transmit power (in dBm) 550 * @channel: the channel to tune to 551 * @ht: the HT configuration for the device 552 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame 553 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11, 554 * but actually means the number of transmissions not the number of retries 555 * @short_frame_max_tx_count: Maximum number of transmissions for a "short" 556 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the 557 * number of transmissions not the number of retries 558 */ 559 struct ieee80211_conf { 560 int beacon_int; 561 u32 flags; 562 int power_level; 563 564 u16 listen_interval; 565 bool radio_enabled; 566 567 u8 long_frame_max_tx_count, short_frame_max_tx_count; 568 569 struct ieee80211_channel *channel; 570 struct ieee80211_ht_conf ht; 571 }; 572 573 /** 574 * struct ieee80211_vif - per-interface data 575 * 576 * Data in this structure is continually present for driver 577 * use during the life of a virtual interface. 578 * 579 * @type: type of this virtual interface 580 * @bss_conf: BSS configuration for this interface, either our own 581 * or the BSS we're associated to 582 * @drv_priv: data area for driver use, will always be aligned to 583 * sizeof(void *). 584 */ 585 struct ieee80211_vif { 586 enum nl80211_iftype type; 587 struct ieee80211_bss_conf bss_conf; 588 /* must be last */ 589 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); 590 }; 591 592 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif) 593 { 594 #ifdef CONFIG_MAC80211_MESH 595 return vif->type == NL80211_IFTYPE_MESH_POINT; 596 #endif 597 return false; 598 } 599 600 /** 601 * struct ieee80211_if_init_conf - initial configuration of an interface 602 * 603 * @vif: pointer to a driver-use per-interface structure. The pointer 604 * itself is also used for various functions including 605 * ieee80211_beacon_get() and ieee80211_get_buffered_bc(). 606 * @type: one of &enum nl80211_iftype constants. Determines the type of 607 * added/removed interface. 608 * @mac_addr: pointer to MAC address of the interface. This pointer is valid 609 * until the interface is removed (i.e. it cannot be used after 610 * remove_interface() callback was called for this interface). 611 * 612 * This structure is used in add_interface() and remove_interface() 613 * callbacks of &struct ieee80211_hw. 614 * 615 * When you allow multiple interfaces to be added to your PHY, take care 616 * that the hardware can actually handle multiple MAC addresses. However, 617 * also take care that when there's no interface left with mac_addr != %NULL 618 * you remove the MAC address from the device to avoid acknowledging packets 619 * in pure monitor mode. 620 */ 621 struct ieee80211_if_init_conf { 622 enum nl80211_iftype type; 623 struct ieee80211_vif *vif; 624 void *mac_addr; 625 }; 626 627 /** 628 * enum ieee80211_if_conf_change - interface config change flags 629 * 630 * @IEEE80211_IFCC_BSSID: The BSSID changed. 631 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed 632 * (currently AP and MESH only), use ieee80211_beacon_get(). 633 */ 634 enum ieee80211_if_conf_change { 635 IEEE80211_IFCC_BSSID = BIT(0), 636 IEEE80211_IFCC_BEACON = BIT(1), 637 }; 638 639 /** 640 * struct ieee80211_if_conf - configuration of an interface 641 * 642 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change. 643 * @bssid: BSSID of the network we are associated to/creating. 644 * 645 * This structure is passed to the config_interface() callback of 646 * &struct ieee80211_hw. 647 */ 648 struct ieee80211_if_conf { 649 u32 changed; 650 u8 *bssid; 651 }; 652 653 /** 654 * enum ieee80211_key_alg - key algorithm 655 * @ALG_WEP: WEP40 or WEP104 656 * @ALG_TKIP: TKIP 657 * @ALG_CCMP: CCMP (AES) 658 */ 659 enum ieee80211_key_alg { 660 ALG_WEP, 661 ALG_TKIP, 662 ALG_CCMP, 663 }; 664 665 /** 666 * enum ieee80211_key_len - key length 667 * @LEN_WEP40: WEP 5-byte long key 668 * @LEN_WEP104: WEP 13-byte long key 669 */ 670 enum ieee80211_key_len { 671 LEN_WEP40 = 5, 672 LEN_WEP104 = 13, 673 }; 674 675 /** 676 * enum ieee80211_key_flags - key flags 677 * 678 * These flags are used for communication about keys between the driver 679 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. 680 * 681 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates 682 * that the STA this key will be used with could be using QoS. 683 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the 684 * driver to indicate that it requires IV generation for this 685 * particular key. 686 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by 687 * the driver for a TKIP key if it requires Michael MIC 688 * generation in software. 689 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates 690 * that the key is pairwise rather then a shared key. 691 */ 692 enum ieee80211_key_flags { 693 IEEE80211_KEY_FLAG_WMM_STA = 1<<0, 694 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1, 695 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2, 696 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3, 697 }; 698 699 /** 700 * struct ieee80211_key_conf - key information 701 * 702 * This key information is given by mac80211 to the driver by 703 * the set_key() callback in &struct ieee80211_ops. 704 * 705 * @hw_key_idx: To be set by the driver, this is the key index the driver 706 * wants to be given when a frame is transmitted and needs to be 707 * encrypted in hardware. 708 * @alg: The key algorithm. 709 * @flags: key flags, see &enum ieee80211_key_flags. 710 * @keyidx: the key index (0-3) 711 * @keylen: key material length 712 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte) 713 * data block: 714 * - Temporal Encryption Key (128 bits) 715 * - Temporal Authenticator Tx MIC Key (64 bits) 716 * - Temporal Authenticator Rx MIC Key (64 bits) 717 * @icv_len: FIXME 718 * @iv_len: FIXME 719 */ 720 struct ieee80211_key_conf { 721 enum ieee80211_key_alg alg; 722 u8 icv_len; 723 u8 iv_len; 724 u8 hw_key_idx; 725 u8 flags; 726 s8 keyidx; 727 u8 keylen; 728 u8 key[0]; 729 }; 730 731 /** 732 * enum set_key_cmd - key command 733 * 734 * Used with the set_key() callback in &struct ieee80211_ops, this 735 * indicates whether a key is being removed or added. 736 * 737 * @SET_KEY: a key is set 738 * @DISABLE_KEY: a key must be disabled 739 */ 740 enum set_key_cmd { 741 SET_KEY, DISABLE_KEY, 742 }; 743 744 /** 745 * struct ieee80211_sta - station table entry 746 * 747 * A station table entry represents a station we are possibly 748 * communicating with. Since stations are RCU-managed in 749 * mac80211, any ieee80211_sta pointer you get access to must 750 * either be protected by rcu_read_lock() explicitly or implicitly, 751 * or you must take good care to not use such a pointer after a 752 * call to your sta_notify callback that removed it. 753 * 754 * @addr: MAC address 755 * @aid: AID we assigned to the station if we're an AP 756 * @supp_rates: Bitmap of supported rates (per band) 757 * @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities 758 * @drv_priv: data area for driver use, will always be aligned to 759 * sizeof(void *), size is determined in hw information. 760 */ 761 struct ieee80211_sta { 762 u64 supp_rates[IEEE80211_NUM_BANDS]; 763 u8 addr[ETH_ALEN]; 764 u16 aid; 765 struct ieee80211_sta_ht_cap ht_cap; 766 767 /* must be last */ 768 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); 769 }; 770 771 /** 772 * enum sta_notify_cmd - sta notify command 773 * 774 * Used with the sta_notify() callback in &struct ieee80211_ops, this 775 * indicates addition and removal of a station to station table, 776 * or if a associated station made a power state transition. 777 * 778 * @STA_NOTIFY_ADD: a station was added to the station table 779 * @STA_NOTIFY_REMOVE: a station being removed from the station table 780 * @STA_NOTIFY_SLEEP: a station is now sleeping 781 * @STA_NOTIFY_AWAKE: a sleeping station woke up 782 */ 783 enum sta_notify_cmd { 784 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE, 785 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE, 786 }; 787 788 /** 789 * enum ieee80211_tkip_key_type - get tkip key 790 * 791 * Used by drivers which need to get a tkip key for skb. Some drivers need a 792 * phase 1 key, others need a phase 2 key. A single function allows the driver 793 * to get the key, this enum indicates what type of key is required. 794 * 795 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key 796 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key 797 */ 798 enum ieee80211_tkip_key_type { 799 IEEE80211_TKIP_P1_KEY, 800 IEEE80211_TKIP_P2_KEY, 801 }; 802 803 /** 804 * enum ieee80211_hw_flags - hardware flags 805 * 806 * These flags are used to indicate hardware capabilities to 807 * the stack. Generally, flags here should have their meaning 808 * done in a way that the simplest hardware doesn't need setting 809 * any particular flags. There are some exceptions to this rule, 810 * however, so you are advised to review these flags carefully. 811 * 812 * @IEEE80211_HW_RX_INCLUDES_FCS: 813 * Indicates that received frames passed to the stack include 814 * the FCS at the end. 815 * 816 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 817 * Some wireless LAN chipsets buffer broadcast/multicast frames 818 * for power saving stations in the hardware/firmware and others 819 * rely on the host system for such buffering. This option is used 820 * to configure the IEEE 802.11 upper layer to buffer broadcast and 821 * multicast frames when there are power saving stations so that 822 * the driver can fetch them with ieee80211_get_buffered_bc(). 823 * 824 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE: 825 * Hardware is not capable of short slot operation on the 2.4 GHz band. 826 * 827 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE: 828 * Hardware is not capable of receiving frames with short preamble on 829 * the 2.4 GHz band. 830 * 831 * @IEEE80211_HW_SIGNAL_UNSPEC: 832 * Hardware can provide signal values but we don't know its units. We 833 * expect values between 0 and @max_signal. 834 * If possible please provide dB or dBm instead. 835 * 836 * @IEEE80211_HW_SIGNAL_DB: 837 * Hardware gives signal values in dB, decibel difference from an 838 * arbitrary, fixed reference. We expect values between 0 and @max_signal. 839 * If possible please provide dBm instead. 840 * 841 * @IEEE80211_HW_SIGNAL_DBM: 842 * Hardware gives signal values in dBm, decibel difference from 843 * one milliwatt. This is the preferred method since it is standardized 844 * between different devices. @max_signal does not need to be set. 845 * 846 * @IEEE80211_HW_NOISE_DBM: 847 * Hardware can provide noise (radio interference) values in units dBm, 848 * decibel difference from one milliwatt. 849 * 850 * @IEEE80211_HW_SPECTRUM_MGMT: 851 * Hardware supports spectrum management defined in 802.11h 852 * Measurement, Channel Switch, Quieting, TPC 853 * 854 * @IEEE80211_HW_AMPDU_AGGREGATION: 855 * Hardware supports 11n A-MPDU aggregation. 856 * 857 * @IEEE80211_HW_NO_STACK_DYNAMIC_PS: 858 * Hardware which has dynamic power save support, meaning 859 * that power save is enabled in idle periods, and don't need support 860 * from stack. 861 */ 862 enum ieee80211_hw_flags { 863 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, 864 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, 865 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3, 866 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4, 867 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5, 868 IEEE80211_HW_SIGNAL_DB = 1<<6, 869 IEEE80211_HW_SIGNAL_DBM = 1<<7, 870 IEEE80211_HW_NOISE_DBM = 1<<8, 871 IEEE80211_HW_SPECTRUM_MGMT = 1<<9, 872 IEEE80211_HW_AMPDU_AGGREGATION = 1<<10, 873 IEEE80211_HW_NO_STACK_DYNAMIC_PS = 1<<11, 874 }; 875 876 /** 877 * struct ieee80211_hw - hardware information and state 878 * 879 * This structure contains the configuration and hardware 880 * information for an 802.11 PHY. 881 * 882 * @wiphy: This points to the &struct wiphy allocated for this 883 * 802.11 PHY. You must fill in the @perm_addr and @dev 884 * members of this structure using SET_IEEE80211_DEV() 885 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported 886 * bands (with channels, bitrates) are registered here. 887 * 888 * @conf: &struct ieee80211_conf, device configuration, don't use. 889 * 890 * @workqueue: single threaded workqueue available for driver use, 891 * allocated by mac80211 on registration and flushed when an 892 * interface is removed. 893 * NOTICE: All work performed on this workqueue should NEVER 894 * acquire the RTNL lock (i.e. Don't use the function 895 * ieee80211_iterate_active_interfaces()) 896 * 897 * @priv: pointer to private area that was allocated for driver use 898 * along with this structure. 899 * 900 * @flags: hardware flags, see &enum ieee80211_hw_flags. 901 * 902 * @extra_tx_headroom: headroom to reserve in each transmit skb 903 * for use by the driver (e.g. for transmit headers.) 904 * 905 * @channel_change_time: time (in microseconds) it takes to change channels. 906 * 907 * @max_signal: Maximum value for signal (rssi) in RX information, used 908 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB 909 * 910 * @max_listen_interval: max listen interval in units of beacon interval 911 * that HW supports 912 * 913 * @queues: number of available hardware transmit queues for 914 * data packets. WMM/QoS requires at least four, these 915 * queues need to have configurable access parameters. 916 * 917 * @ampdu_queues: number of available hardware transmit queues 918 * for A-MPDU packets, these have no access parameters 919 * because they're used only for A-MPDU frames. Note that 920 * mac80211 will not currently use any of the regular queues 921 * for aggregation. 922 * 923 * @rate_control_algorithm: rate control algorithm for this hardware. 924 * If unset (NULL), the default algorithm will be used. Must be 925 * set before calling ieee80211_register_hw(). 926 * 927 * @vif_data_size: size (in bytes) of the drv_priv data area 928 * within &struct ieee80211_vif. 929 * @sta_data_size: size (in bytes) of the drv_priv data area 930 * within &struct ieee80211_sta. 931 * 932 * @max_rates: maximum number of alternate rate retry stages 933 * @max_rate_tries: maximum number of tries for each stage 934 */ 935 struct ieee80211_hw { 936 struct ieee80211_conf conf; 937 struct wiphy *wiphy; 938 struct workqueue_struct *workqueue; 939 const char *rate_control_algorithm; 940 void *priv; 941 u32 flags; 942 unsigned int extra_tx_headroom; 943 int channel_change_time; 944 int vif_data_size; 945 int sta_data_size; 946 u16 queues; 947 u16 ampdu_queues; 948 u16 max_listen_interval; 949 s8 max_signal; 950 u8 max_rates; 951 u8 max_rate_tries; 952 }; 953 954 /** 955 * SET_IEEE80211_DEV - set device for 802.11 hardware 956 * 957 * @hw: the &struct ieee80211_hw to set the device for 958 * @dev: the &struct device of this 802.11 device 959 */ 960 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 961 { 962 set_wiphy_dev(hw->wiphy, dev); 963 } 964 965 /** 966 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware 967 * 968 * @hw: the &struct ieee80211_hw to set the MAC address for 969 * @addr: the address to set 970 */ 971 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 972 { 973 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 974 } 975 976 static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw) 977 { 978 return hw->queues; 979 } 980 981 static inline int ieee80211_num_queues(struct ieee80211_hw *hw) 982 { 983 return hw->queues + hw->ampdu_queues; 984 } 985 986 static inline struct ieee80211_rate * 987 ieee80211_get_tx_rate(const struct ieee80211_hw *hw, 988 const struct ieee80211_tx_info *c) 989 { 990 if (WARN_ON(c->control.rates[0].idx < 0)) 991 return NULL; 992 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx]; 993 } 994 995 static inline struct ieee80211_rate * 996 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw, 997 const struct ieee80211_tx_info *c) 998 { 999 if (c->control.rts_cts_rate_idx < 0) 1000 return NULL; 1001 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx]; 1002 } 1003 1004 static inline struct ieee80211_rate * 1005 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw, 1006 const struct ieee80211_tx_info *c, int idx) 1007 { 1008 if (c->control.rates[idx + 1].idx < 0) 1009 return NULL; 1010 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx]; 1011 } 1012 1013 /** 1014 * DOC: Hardware crypto acceleration 1015 * 1016 * mac80211 is capable of taking advantage of many hardware 1017 * acceleration designs for encryption and decryption operations. 1018 * 1019 * The set_key() callback in the &struct ieee80211_ops for a given 1020 * device is called to enable hardware acceleration of encryption and 1021 * decryption. The callback takes an @address parameter that will be 1022 * the broadcast address for default keys, the other station's hardware 1023 * address for individual keys or the zero address for keys that will 1024 * be used only for transmission. 1025 * Multiple transmission keys with the same key index may be used when 1026 * VLANs are configured for an access point. 1027 * 1028 * The @local_address parameter will always be set to our own address, 1029 * this is only relevant if you support multiple local addresses. 1030 * 1031 * When transmitting, the TX control data will use the @hw_key_idx 1032 * selected by the driver by modifying the &struct ieee80211_key_conf 1033 * pointed to by the @key parameter to the set_key() function. 1034 * 1035 * The set_key() call for the %SET_KEY command should return 0 if 1036 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 1037 * added; if you return 0 then hw_key_idx must be assigned to the 1038 * hardware key index, you are free to use the full u8 range. 1039 * 1040 * When the cmd is %DISABLE_KEY then it must succeed. 1041 * 1042 * Note that it is permissible to not decrypt a frame even if a key 1043 * for it has been uploaded to hardware, the stack will not make any 1044 * decision based on whether a key has been uploaded or not but rather 1045 * based on the receive flags. 1046 * 1047 * The &struct ieee80211_key_conf structure pointed to by the @key 1048 * parameter is guaranteed to be valid until another call to set_key() 1049 * removes it, but it can only be used as a cookie to differentiate 1050 * keys. 1051 * 1052 * In TKIP some HW need to be provided a phase 1 key, for RX decryption 1053 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key 1054 * handler. 1055 * The update_tkip_key() call updates the driver with the new phase 1 key. 1056 * This happens everytime the iv16 wraps around (every 65536 packets). The 1057 * set_key() call will happen only once for each key (unless the AP did 1058 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is 1059 * provided by update_tkip_key only. The trigger that makes mac80211 call this 1060 * handler is software decryption with wrap around of iv16. 1061 */ 1062 1063 /** 1064 * DOC: Frame filtering 1065 * 1066 * mac80211 requires to see many management frames for proper 1067 * operation, and users may want to see many more frames when 1068 * in monitor mode. However, for best CPU usage and power consumption, 1069 * having as few frames as possible percolate through the stack is 1070 * desirable. Hence, the hardware should filter as much as possible. 1071 * 1072 * To achieve this, mac80211 uses filter flags (see below) to tell 1073 * the driver's configure_filter() function which frames should be 1074 * passed to mac80211 and which should be filtered out. 1075 * 1076 * The configure_filter() callback is invoked with the parameters 1077 * @mc_count and @mc_list for the combined multicast address list 1078 * of all virtual interfaces, @changed_flags telling which flags 1079 * were changed and @total_flags with the new flag states. 1080 * 1081 * If your device has no multicast address filters your driver will 1082 * need to check both the %FIF_ALLMULTI flag and the @mc_count 1083 * parameter to see whether multicast frames should be accepted 1084 * or dropped. 1085 * 1086 * All unsupported flags in @total_flags must be cleared. 1087 * Hardware does not support a flag if it is incapable of _passing_ 1088 * the frame to the stack. Otherwise the driver must ignore 1089 * the flag, but not clear it. 1090 * You must _only_ clear the flag (announce no support for the 1091 * flag to mac80211) if you are not able to pass the packet type 1092 * to the stack (so the hardware always filters it). 1093 * So for example, you should clear @FIF_CONTROL, if your hardware 1094 * always filters control frames. If your hardware always passes 1095 * control frames to the kernel and is incapable of filtering them, 1096 * you do _not_ clear the @FIF_CONTROL flag. 1097 * This rule applies to all other FIF flags as well. 1098 */ 1099 1100 /** 1101 * enum ieee80211_filter_flags - hardware filter flags 1102 * 1103 * These flags determine what the filter in hardware should be 1104 * programmed to let through and what should not be passed to the 1105 * stack. It is always safe to pass more frames than requested, 1106 * but this has negative impact on power consumption. 1107 * 1108 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, 1109 * think of the BSS as your network segment and then this corresponds 1110 * to the regular ethernet device promiscuous mode. 1111 * 1112 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 1113 * by the user or if the hardware is not capable of filtering by 1114 * multicast address. 1115 * 1116 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 1117 * %RX_FLAG_FAILED_FCS_CRC for them) 1118 * 1119 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 1120 * the %RX_FLAG_FAILED_PLCP_CRC for them 1121 * 1122 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 1123 * to the hardware that it should not filter beacons or probe responses 1124 * by BSSID. Filtering them can greatly reduce the amount of processing 1125 * mac80211 needs to do and the amount of CPU wakeups, so you should 1126 * honour this flag if possible. 1127 * 1128 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then 1129 * only those addressed to this station 1130 * 1131 * @FIF_OTHER_BSS: pass frames destined to other BSSes 1132 */ 1133 enum ieee80211_filter_flags { 1134 FIF_PROMISC_IN_BSS = 1<<0, 1135 FIF_ALLMULTI = 1<<1, 1136 FIF_FCSFAIL = 1<<2, 1137 FIF_PLCPFAIL = 1<<3, 1138 FIF_BCN_PRBRESP_PROMISC = 1<<4, 1139 FIF_CONTROL = 1<<5, 1140 FIF_OTHER_BSS = 1<<6, 1141 }; 1142 1143 /** 1144 * enum ieee80211_ampdu_mlme_action - A-MPDU actions 1145 * 1146 * These flags are used with the ampdu_action() callback in 1147 * &struct ieee80211_ops to indicate which action is needed. 1148 * @IEEE80211_AMPDU_RX_START: start Rx aggregation 1149 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation 1150 * @IEEE80211_AMPDU_TX_START: start Tx aggregation 1151 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation 1152 * @IEEE80211_AMPDU_TX_RESUME: resume TX aggregation 1153 */ 1154 enum ieee80211_ampdu_mlme_action { 1155 IEEE80211_AMPDU_RX_START, 1156 IEEE80211_AMPDU_RX_STOP, 1157 IEEE80211_AMPDU_TX_START, 1158 IEEE80211_AMPDU_TX_STOP, 1159 IEEE80211_AMPDU_TX_RESUME, 1160 }; 1161 1162 /** 1163 * struct ieee80211_ops - callbacks from mac80211 to the driver 1164 * 1165 * This structure contains various callbacks that the driver may 1166 * handle or, in some cases, must handle, for example to configure 1167 * the hardware to a new channel or to transmit a frame. 1168 * 1169 * @tx: Handler that 802.11 module calls for each transmitted frame. 1170 * skb contains the buffer starting from the IEEE 802.11 header. 1171 * The low-level driver should send the frame out based on 1172 * configuration in the TX control data. This handler should, 1173 * preferably, never fail and stop queues appropriately, more 1174 * importantly, however, it must never fail for A-MPDU-queues. 1175 * Must be implemented and atomic. 1176 * 1177 * @start: Called before the first netdevice attached to the hardware 1178 * is enabled. This should turn on the hardware and must turn on 1179 * frame reception (for possibly enabled monitor interfaces.) 1180 * Returns negative error codes, these may be seen in userspace, 1181 * or zero. 1182 * When the device is started it should not have a MAC address 1183 * to avoid acknowledging frames before a non-monitor device 1184 * is added. 1185 * Must be implemented. 1186 * 1187 * @stop: Called after last netdevice attached to the hardware 1188 * is disabled. This should turn off the hardware (at least 1189 * it must turn off frame reception.) 1190 * May be called right after add_interface if that rejects 1191 * an interface. 1192 * Must be implemented. 1193 * 1194 * @add_interface: Called when a netdevice attached to the hardware is 1195 * enabled. Because it is not called for monitor mode devices, @start 1196 * and @stop must be implemented. 1197 * The driver should perform any initialization it needs before 1198 * the device can be enabled. The initial configuration for the 1199 * interface is given in the conf parameter. 1200 * The callback may refuse to add an interface by returning a 1201 * negative error code (which will be seen in userspace.) 1202 * Must be implemented. 1203 * 1204 * @remove_interface: Notifies a driver that an interface is going down. 1205 * The @stop callback is called after this if it is the last interface 1206 * and no monitor interfaces are present. 1207 * When all interfaces are removed, the MAC address in the hardware 1208 * must be cleared so the device no longer acknowledges packets, 1209 * the mac_addr member of the conf structure is, however, set to the 1210 * MAC address of the device going away. 1211 * Hence, this callback must be implemented. 1212 * 1213 * @config: Handler for configuration requests. IEEE 802.11 code calls this 1214 * function to change hardware configuration, e.g., channel. 1215 * 1216 * @config_interface: Handler for configuration requests related to interfaces 1217 * (e.g. BSSID changes.) 1218 * 1219 * @bss_info_changed: Handler for configuration requests related to BSS 1220 * parameters that may vary during BSS's lifespan, and may affect low 1221 * level driver (e.g. assoc/disassoc status, erp parameters). 1222 * This function should not be used if no BSS has been set, unless 1223 * for association indication. The @changed parameter indicates which 1224 * of the bss parameters has changed when a call is made. 1225 * 1226 * @configure_filter: Configure the device's RX filter. 1227 * See the section "Frame filtering" for more information. 1228 * This callback must be implemented and atomic. 1229 * 1230 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit 1231 * must be set or cleared for a given STA. Must be atomic. 1232 * 1233 * @set_key: See the section "Hardware crypto acceleration" 1234 * This callback can sleep, and is only called between add_interface 1235 * and remove_interface calls, i.e. while the interface with the 1236 * given local_address is enabled. 1237 * 1238 * @update_tkip_key: See the section "Hardware crypto acceleration" 1239 * This callback will be called in the context of Rx. Called for drivers 1240 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY. 1241 * 1242 * @hw_scan: Ask the hardware to service the scan request, no need to start 1243 * the scan state machine in stack. The scan must honour the channel 1244 * configuration done by the regulatory agent in the wiphy's registered 1245 * bands. When the scan finishes, ieee80211_scan_completed() must be 1246 * called; note that it also must be called when the scan cannot finish 1247 * because the hardware is turned off! Anything else is a bug! 1248 * 1249 * @get_stats: return low-level statistics 1250 * 1251 * @get_tkip_seq: If your device implements TKIP encryption in hardware this 1252 * callback should be provided to read the TKIP transmit IVs (both IV32 1253 * and IV16) for the given key from hardware. 1254 * 1255 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 1256 * 1257 * @sta_notify: Notifies low level driver about addition, removal or power 1258 * state transition of an associated station, AP, IBSS/WDS/mesh peer etc. 1259 * Must be atomic. 1260 * 1261 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 1262 * bursting) for a hardware TX queue. 1263 * 1264 * @get_tx_stats: Get statistics of the current TX queue status. This is used 1265 * to get number of currently queued packets (queue length), maximum queue 1266 * size (limit), and total number of packets sent using each TX queue 1267 * (count). The 'stats' pointer points to an array that has hw->queues + 1268 * hw->ampdu_queues items. 1269 * 1270 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 1271 * this is only used for IBSS mode debugging and, as such, is not a 1272 * required function. Must be atomic. 1273 * 1274 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 1275 * with other STAs in the IBSS. This is only used in IBSS mode. This 1276 * function is optional if the firmware/hardware takes full care of 1277 * TSF synchronization. 1278 * 1279 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 1280 * This is needed only for IBSS mode and the result of this function is 1281 * used to determine whether to reply to Probe Requests. 1282 * 1283 * @ampdu_action: Perform a certain A-MPDU action 1284 * The RA/TID combination determines the destination and TID we want 1285 * the ampdu action to be performed for. The action is defined through 1286 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn) 1287 * is the first frame we expect to perform the action on. notice 1288 * that TX/RX_STOP can pass NULL for this parameter. 1289 */ 1290 struct ieee80211_ops { 1291 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb); 1292 int (*start)(struct ieee80211_hw *hw); 1293 void (*stop)(struct ieee80211_hw *hw); 1294 int (*add_interface)(struct ieee80211_hw *hw, 1295 struct ieee80211_if_init_conf *conf); 1296 void (*remove_interface)(struct ieee80211_hw *hw, 1297 struct ieee80211_if_init_conf *conf); 1298 int (*config)(struct ieee80211_hw *hw, u32 changed); 1299 int (*config_interface)(struct ieee80211_hw *hw, 1300 struct ieee80211_vif *vif, 1301 struct ieee80211_if_conf *conf); 1302 void (*bss_info_changed)(struct ieee80211_hw *hw, 1303 struct ieee80211_vif *vif, 1304 struct ieee80211_bss_conf *info, 1305 u32 changed); 1306 void (*configure_filter)(struct ieee80211_hw *hw, 1307 unsigned int changed_flags, 1308 unsigned int *total_flags, 1309 int mc_count, struct dev_addr_list *mc_list); 1310 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 1311 bool set); 1312 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, 1313 const u8 *local_address, const u8 *address, 1314 struct ieee80211_key_conf *key); 1315 void (*update_tkip_key)(struct ieee80211_hw *hw, 1316 struct ieee80211_key_conf *conf, const u8 *address, 1317 u32 iv32, u16 *phase1key); 1318 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len); 1319 int (*get_stats)(struct ieee80211_hw *hw, 1320 struct ieee80211_low_level_stats *stats); 1321 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx, 1322 u32 *iv32, u16 *iv16); 1323 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 1324 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1325 enum sta_notify_cmd, struct ieee80211_sta *sta); 1326 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue, 1327 const struct ieee80211_tx_queue_params *params); 1328 int (*get_tx_stats)(struct ieee80211_hw *hw, 1329 struct ieee80211_tx_queue_stats *stats); 1330 u64 (*get_tsf)(struct ieee80211_hw *hw); 1331 void (*reset_tsf)(struct ieee80211_hw *hw); 1332 int (*tx_last_beacon)(struct ieee80211_hw *hw); 1333 int (*ampdu_action)(struct ieee80211_hw *hw, 1334 enum ieee80211_ampdu_mlme_action action, 1335 struct ieee80211_sta *sta, u16 tid, u16 *ssn); 1336 }; 1337 1338 /** 1339 * ieee80211_alloc_hw - Allocate a new hardware device 1340 * 1341 * This must be called once for each hardware device. The returned pointer 1342 * must be used to refer to this device when calling other functions. 1343 * mac80211 allocates a private data area for the driver pointed to by 1344 * @priv in &struct ieee80211_hw, the size of this area is given as 1345 * @priv_data_len. 1346 * 1347 * @priv_data_len: length of private data 1348 * @ops: callbacks for this device 1349 */ 1350 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 1351 const struct ieee80211_ops *ops); 1352 1353 /** 1354 * ieee80211_register_hw - Register hardware device 1355 * 1356 * You must call this function before any other functions in 1357 * mac80211. Note that before a hardware can be registered, you 1358 * need to fill the contained wiphy's information. 1359 * 1360 * @hw: the device to register as returned by ieee80211_alloc_hw() 1361 */ 1362 int ieee80211_register_hw(struct ieee80211_hw *hw); 1363 1364 #ifdef CONFIG_MAC80211_LEDS 1365 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 1366 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 1367 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); 1368 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw); 1369 #endif 1370 /** 1371 * ieee80211_get_tx_led_name - get name of TX LED 1372 * 1373 * mac80211 creates a transmit LED trigger for each wireless hardware 1374 * that can be used to drive LEDs if your driver registers a LED device. 1375 * This function returns the name (or %NULL if not configured for LEDs) 1376 * of the trigger so you can automatically link the LED device. 1377 * 1378 * @hw: the hardware to get the LED trigger name for 1379 */ 1380 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 1381 { 1382 #ifdef CONFIG_MAC80211_LEDS 1383 return __ieee80211_get_tx_led_name(hw); 1384 #else 1385 return NULL; 1386 #endif 1387 } 1388 1389 /** 1390 * ieee80211_get_rx_led_name - get name of RX LED 1391 * 1392 * mac80211 creates a receive LED trigger for each wireless hardware 1393 * that can be used to drive LEDs if your driver registers a LED device. 1394 * This function returns the name (or %NULL if not configured for LEDs) 1395 * of the trigger so you can automatically link the LED device. 1396 * 1397 * @hw: the hardware to get the LED trigger name for 1398 */ 1399 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 1400 { 1401 #ifdef CONFIG_MAC80211_LEDS 1402 return __ieee80211_get_rx_led_name(hw); 1403 #else 1404 return NULL; 1405 #endif 1406 } 1407 1408 /** 1409 * ieee80211_get_assoc_led_name - get name of association LED 1410 * 1411 * mac80211 creates a association LED trigger for each wireless hardware 1412 * that can be used to drive LEDs if your driver registers a LED device. 1413 * This function returns the name (or %NULL if not configured for LEDs) 1414 * of the trigger so you can automatically link the LED device. 1415 * 1416 * @hw: the hardware to get the LED trigger name for 1417 */ 1418 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) 1419 { 1420 #ifdef CONFIG_MAC80211_LEDS 1421 return __ieee80211_get_assoc_led_name(hw); 1422 #else 1423 return NULL; 1424 #endif 1425 } 1426 1427 /** 1428 * ieee80211_get_radio_led_name - get name of radio LED 1429 * 1430 * mac80211 creates a radio change LED trigger for each wireless hardware 1431 * that can be used to drive LEDs if your driver registers a LED device. 1432 * This function returns the name (or %NULL if not configured for LEDs) 1433 * of the trigger so you can automatically link the LED device. 1434 * 1435 * @hw: the hardware to get the LED trigger name for 1436 */ 1437 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) 1438 { 1439 #ifdef CONFIG_MAC80211_LEDS 1440 return __ieee80211_get_radio_led_name(hw); 1441 #else 1442 return NULL; 1443 #endif 1444 } 1445 1446 /** 1447 * ieee80211_unregister_hw - Unregister a hardware device 1448 * 1449 * This function instructs mac80211 to free allocated resources 1450 * and unregister netdevices from the networking subsystem. 1451 * 1452 * @hw: the hardware to unregister 1453 */ 1454 void ieee80211_unregister_hw(struct ieee80211_hw *hw); 1455 1456 /** 1457 * ieee80211_free_hw - free hardware descriptor 1458 * 1459 * This function frees everything that was allocated, including the 1460 * private data for the driver. You must call ieee80211_unregister_hw() 1461 * before calling this function. 1462 * 1463 * @hw: the hardware to free 1464 */ 1465 void ieee80211_free_hw(struct ieee80211_hw *hw); 1466 1467 /* trick to avoid symbol clashes with the ieee80211 subsystem */ 1468 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1469 struct ieee80211_rx_status *status); 1470 1471 /** 1472 * ieee80211_rx - receive frame 1473 * 1474 * Use this function to hand received frames to mac80211. The receive 1475 * buffer in @skb must start with an IEEE 802.11 header or a radiotap 1476 * header if %RX_FLAG_RADIOTAP is set in the @status flags. 1477 * 1478 * This function may not be called in IRQ context. Calls to this function 1479 * for a single hardware must be synchronized against each other. Calls 1480 * to this function and ieee80211_rx_irqsafe() may not be mixed for a 1481 * single hardware. 1482 * 1483 * @hw: the hardware this frame came in on 1484 * @skb: the buffer to receive, owned by mac80211 after this call 1485 * @status: status of this frame; the status pointer need not be valid 1486 * after this function returns 1487 */ 1488 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1489 struct ieee80211_rx_status *status) 1490 { 1491 __ieee80211_rx(hw, skb, status); 1492 } 1493 1494 /** 1495 * ieee80211_rx_irqsafe - receive frame 1496 * 1497 * Like ieee80211_rx() but can be called in IRQ context 1498 * (internally defers to a tasklet.) 1499 * 1500 * Calls to this function and ieee80211_rx() may not be mixed for a 1501 * single hardware. 1502 * 1503 * @hw: the hardware this frame came in on 1504 * @skb: the buffer to receive, owned by mac80211 after this call 1505 * @status: status of this frame; the status pointer need not be valid 1506 * after this function returns and is not freed by mac80211, 1507 * it is recommended that it points to a stack area 1508 */ 1509 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, 1510 struct sk_buff *skb, 1511 struct ieee80211_rx_status *status); 1512 1513 /** 1514 * ieee80211_tx_status - transmit status callback 1515 * 1516 * Call this function for all transmitted frames after they have been 1517 * transmitted. It is permissible to not call this function for 1518 * multicast frames but this can affect statistics. 1519 * 1520 * This function may not be called in IRQ context. Calls to this function 1521 * for a single hardware must be synchronized against each other. Calls 1522 * to this function and ieee80211_tx_status_irqsafe() may not be mixed 1523 * for a single hardware. 1524 * 1525 * @hw: the hardware the frame was transmitted by 1526 * @skb: the frame that was transmitted, owned by mac80211 after this call 1527 */ 1528 void ieee80211_tx_status(struct ieee80211_hw *hw, 1529 struct sk_buff *skb); 1530 1531 /** 1532 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback 1533 * 1534 * Like ieee80211_tx_status() but can be called in IRQ context 1535 * (internally defers to a tasklet.) 1536 * 1537 * Calls to this function and ieee80211_tx_status() may not be mixed for a 1538 * single hardware. 1539 * 1540 * @hw: the hardware the frame was transmitted by 1541 * @skb: the frame that was transmitted, owned by mac80211 after this call 1542 */ 1543 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 1544 struct sk_buff *skb); 1545 1546 /** 1547 * ieee80211_beacon_get - beacon generation function 1548 * @hw: pointer obtained from ieee80211_alloc_hw(). 1549 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1550 * 1551 * If the beacon frames are generated by the host system (i.e., not in 1552 * hardware/firmware), the low-level driver uses this function to receive 1553 * the next beacon frame from the 802.11 code. The low-level is responsible 1554 * for calling this function before beacon data is needed (e.g., based on 1555 * hardware interrupt). Returned skb is used only once and low-level driver 1556 * is responsible for freeing it. 1557 */ 1558 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 1559 struct ieee80211_vif *vif); 1560 1561 /** 1562 * ieee80211_rts_get - RTS frame generation function 1563 * @hw: pointer obtained from ieee80211_alloc_hw(). 1564 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1565 * @frame: pointer to the frame that is going to be protected by the RTS. 1566 * @frame_len: the frame length (in octets). 1567 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1568 * @rts: The buffer where to store the RTS frame. 1569 * 1570 * If the RTS frames are generated by the host system (i.e., not in 1571 * hardware/firmware), the low-level driver uses this function to receive 1572 * the next RTS frame from the 802.11 code. The low-level is responsible 1573 * for calling this function before and RTS frame is needed. 1574 */ 1575 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1576 const void *frame, size_t frame_len, 1577 const struct ieee80211_tx_info *frame_txctl, 1578 struct ieee80211_rts *rts); 1579 1580 /** 1581 * ieee80211_rts_duration - Get the duration field for an RTS frame 1582 * @hw: pointer obtained from ieee80211_alloc_hw(). 1583 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1584 * @frame_len: the length of the frame that is going to be protected by the RTS. 1585 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1586 * 1587 * If the RTS is generated in firmware, but the host system must provide 1588 * the duration field, the low-level driver uses this function to receive 1589 * the duration field value in little-endian byteorder. 1590 */ 1591 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, 1592 struct ieee80211_vif *vif, size_t frame_len, 1593 const struct ieee80211_tx_info *frame_txctl); 1594 1595 /** 1596 * ieee80211_ctstoself_get - CTS-to-self frame generation function 1597 * @hw: pointer obtained from ieee80211_alloc_hw(). 1598 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1599 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 1600 * @frame_len: the frame length (in octets). 1601 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1602 * @cts: The buffer where to store the CTS-to-self frame. 1603 * 1604 * If the CTS-to-self frames are generated by the host system (i.e., not in 1605 * hardware/firmware), the low-level driver uses this function to receive 1606 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 1607 * for calling this function before and CTS-to-self frame is needed. 1608 */ 1609 void ieee80211_ctstoself_get(struct ieee80211_hw *hw, 1610 struct ieee80211_vif *vif, 1611 const void *frame, size_t frame_len, 1612 const struct ieee80211_tx_info *frame_txctl, 1613 struct ieee80211_cts *cts); 1614 1615 /** 1616 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 1617 * @hw: pointer obtained from ieee80211_alloc_hw(). 1618 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1619 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 1620 * @frame_txctl: &struct ieee80211_tx_info of the frame. 1621 * 1622 * If the CTS-to-self is generated in firmware, but the host system must provide 1623 * the duration field, the low-level driver uses this function to receive 1624 * the duration field value in little-endian byteorder. 1625 */ 1626 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, 1627 struct ieee80211_vif *vif, 1628 size_t frame_len, 1629 const struct ieee80211_tx_info *frame_txctl); 1630 1631 /** 1632 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 1633 * @hw: pointer obtained from ieee80211_alloc_hw(). 1634 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1635 * @frame_len: the length of the frame. 1636 * @rate: the rate at which the frame is going to be transmitted. 1637 * 1638 * Calculate the duration field of some generic frame, given its 1639 * length and transmission rate (in 100kbps). 1640 */ 1641 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, 1642 struct ieee80211_vif *vif, 1643 size_t frame_len, 1644 struct ieee80211_rate *rate); 1645 1646 /** 1647 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 1648 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1649 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1650 * 1651 * Function for accessing buffered broadcast and multicast frames. If 1652 * hardware/firmware does not implement buffering of broadcast/multicast 1653 * frames when power saving is used, 802.11 code buffers them in the host 1654 * memory. The low-level driver uses this function to fetch next buffered 1655 * frame. In most cases, this is used when generating beacon frame. This 1656 * function returns a pointer to the next buffered skb or NULL if no more 1657 * buffered frames are available. 1658 * 1659 * Note: buffered frames are returned only after DTIM beacon frame was 1660 * generated with ieee80211_beacon_get() and the low-level driver must thus 1661 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 1662 * NULL if the previous generated beacon was not DTIM, so the low-level driver 1663 * does not need to check for DTIM beacons separately and should be able to 1664 * use common code for all beacons. 1665 */ 1666 struct sk_buff * 1667 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 1668 1669 /** 1670 * ieee80211_get_hdrlen_from_skb - get header length from data 1671 * 1672 * Given an skb with a raw 802.11 header at the data pointer this function 1673 * returns the 802.11 header length in bytes (not including encryption 1674 * headers). If the data in the sk_buff is too short to contain a valid 802.11 1675 * header the function returns 0. 1676 * 1677 * @skb: the frame 1678 */ 1679 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); 1680 1681 /** 1682 * ieee80211_hdrlen - get header length in bytes from frame control 1683 * @fc: frame control field in little-endian format 1684 */ 1685 unsigned int ieee80211_hdrlen(__le16 fc); 1686 1687 /** 1688 * ieee80211_get_tkip_key - get a TKIP rc4 for skb 1689 * 1690 * This function computes a TKIP rc4 key for an skb. It computes 1691 * a phase 1 key if needed (iv16 wraps around). This function is to 1692 * be used by drivers which can do HW encryption but need to compute 1693 * to phase 1/2 key in SW. 1694 * 1695 * @keyconf: the parameter passed with the set key 1696 * @skb: the skb for which the key is needed 1697 * @type: TBD 1698 * @key: a buffer to which the key will be written 1699 */ 1700 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf, 1701 struct sk_buff *skb, 1702 enum ieee80211_tkip_key_type type, u8 *key); 1703 /** 1704 * ieee80211_wake_queue - wake specific queue 1705 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1706 * @queue: queue number (counted from zero). 1707 * 1708 * Drivers should use this function instead of netif_wake_queue. 1709 */ 1710 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 1711 1712 /** 1713 * ieee80211_stop_queue - stop specific queue 1714 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1715 * @queue: queue number (counted from zero). 1716 * 1717 * Drivers should use this function instead of netif_stop_queue. 1718 */ 1719 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 1720 1721 /** 1722 * ieee80211_queue_stopped - test status of the queue 1723 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1724 * @queue: queue number (counted from zero). 1725 * 1726 * Drivers should use this function instead of netif_stop_queue. 1727 */ 1728 1729 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); 1730 1731 /** 1732 * ieee80211_stop_queues - stop all queues 1733 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1734 * 1735 * Drivers should use this function instead of netif_stop_queue. 1736 */ 1737 void ieee80211_stop_queues(struct ieee80211_hw *hw); 1738 1739 /** 1740 * ieee80211_wake_queues - wake all queues 1741 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1742 * 1743 * Drivers should use this function instead of netif_wake_queue. 1744 */ 1745 void ieee80211_wake_queues(struct ieee80211_hw *hw); 1746 1747 /** 1748 * ieee80211_scan_completed - completed hardware scan 1749 * 1750 * When hardware scan offload is used (i.e. the hw_scan() callback is 1751 * assigned) this function needs to be called by the driver to notify 1752 * mac80211 that the scan finished. 1753 * 1754 * @hw: the hardware that finished the scan 1755 */ 1756 void ieee80211_scan_completed(struct ieee80211_hw *hw); 1757 1758 /** 1759 * ieee80211_iterate_active_interfaces - iterate active interfaces 1760 * 1761 * This function iterates over the interfaces associated with a given 1762 * hardware that are currently active and calls the callback for them. 1763 * This function allows the iterator function to sleep, when the iterator 1764 * function is atomic @ieee80211_iterate_active_interfaces_atomic can 1765 * be used. 1766 * 1767 * @hw: the hardware struct of which the interfaces should be iterated over 1768 * @iterator: the iterator function to call 1769 * @data: first argument of the iterator function 1770 */ 1771 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, 1772 void (*iterator)(void *data, u8 *mac, 1773 struct ieee80211_vif *vif), 1774 void *data); 1775 1776 /** 1777 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces 1778 * 1779 * This function iterates over the interfaces associated with a given 1780 * hardware that are currently active and calls the callback for them. 1781 * This function requires the iterator callback function to be atomic, 1782 * if that is not desired, use @ieee80211_iterate_active_interfaces instead. 1783 * 1784 * @hw: the hardware struct of which the interfaces should be iterated over 1785 * @iterator: the iterator function to call, cannot sleep 1786 * @data: first argument of the iterator function 1787 */ 1788 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw, 1789 void (*iterator)(void *data, 1790 u8 *mac, 1791 struct ieee80211_vif *vif), 1792 void *data); 1793 1794 /** 1795 * ieee80211_start_tx_ba_session - Start a tx Block Ack session. 1796 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1797 * @ra: receiver address of the BA session recipient 1798 * @tid: the TID to BA on. 1799 * 1800 * Return: success if addBA request was sent, failure otherwise 1801 * 1802 * Although mac80211/low level driver/user space application can estimate 1803 * the need to start aggregation on a certain RA/TID, the session level 1804 * will be managed by the mac80211. 1805 */ 1806 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid); 1807 1808 /** 1809 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate. 1810 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1811 * @ra: receiver address of the BA session recipient. 1812 * @tid: the TID to BA on. 1813 * 1814 * This function must be called by low level driver once it has 1815 * finished with preparations for the BA session. 1816 */ 1817 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid); 1818 1819 /** 1820 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate. 1821 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1822 * @ra: receiver address of the BA session recipient. 1823 * @tid: the TID to BA on. 1824 * 1825 * This function must be called by low level driver once it has 1826 * finished with preparations for the BA session. 1827 * This version of the function is IRQ-safe. 1828 */ 1829 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra, 1830 u16 tid); 1831 1832 /** 1833 * ieee80211_stop_tx_ba_session - Stop a Block Ack session. 1834 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1835 * @ra: receiver address of the BA session recipient 1836 * @tid: the TID to stop BA. 1837 * @initiator: if indicates initiator DELBA frame will be sent. 1838 * 1839 * Return: error if no sta with matching da found, success otherwise 1840 * 1841 * Although mac80211/low level driver/user space application can estimate 1842 * the need to stop aggregation on a certain RA/TID, the session level 1843 * will be managed by the mac80211. 1844 */ 1845 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw, 1846 u8 *ra, u16 tid, 1847 enum ieee80211_back_parties initiator); 1848 1849 /** 1850 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate. 1851 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1852 * @ra: receiver address of the BA session recipient. 1853 * @tid: the desired TID to BA on. 1854 * 1855 * This function must be called by low level driver once it has 1856 * finished with preparations for the BA session tear down. 1857 */ 1858 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid); 1859 1860 /** 1861 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate. 1862 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1863 * @ra: receiver address of the BA session recipient. 1864 * @tid: the desired TID to BA on. 1865 * 1866 * This function must be called by low level driver once it has 1867 * finished with preparations for the BA session tear down. 1868 * This version of the function is IRQ-safe. 1869 */ 1870 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra, 1871 u16 tid); 1872 1873 /** 1874 * ieee80211_find_sta - find a station 1875 * 1876 * @hw: pointer as obtained from ieee80211_alloc_hw() 1877 * @addr: station's address 1878 * 1879 * This function must be called under RCU lock and the 1880 * resulting pointer is only valid under RCU lock as well. 1881 */ 1882 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw, 1883 const u8 *addr); 1884 1885 1886 /* Rate control API */ 1887 1888 /** 1889 * struct ieee80211_tx_rate_control - rate control information for/from RC algo 1890 * 1891 * @hw: The hardware the algorithm is invoked for. 1892 * @sband: The band this frame is being transmitted on. 1893 * @bss_conf: the current BSS configuration 1894 * @reported_rate: The rate control algorithm can fill this in to indicate 1895 * which rate should be reported to userspace as the current rate and 1896 * used for rate calculations in the mesh network. 1897 * @rts: whether RTS will be used for this frame because it is longer than the 1898 * RTS threshold 1899 * @short_preamble: whether mac80211 will request short-preamble transmission 1900 * if the selected rate supports it 1901 * @max_rate_idx: user-requested maximum rate (not MCS for now) 1902 * @skb: the skb that will be transmitted, the control information in it needs 1903 * to be filled in 1904 */ 1905 struct ieee80211_tx_rate_control { 1906 struct ieee80211_hw *hw; 1907 struct ieee80211_supported_band *sband; 1908 struct ieee80211_bss_conf *bss_conf; 1909 struct sk_buff *skb; 1910 struct ieee80211_tx_rate reported_rate; 1911 bool rts, short_preamble; 1912 u8 max_rate_idx; 1913 }; 1914 1915 struct rate_control_ops { 1916 struct module *module; 1917 const char *name; 1918 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir); 1919 void (*free)(void *priv); 1920 1921 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp); 1922 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband, 1923 struct ieee80211_sta *sta, void *priv_sta); 1924 void (*free_sta)(void *priv, struct ieee80211_sta *sta, 1925 void *priv_sta); 1926 1927 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband, 1928 struct ieee80211_sta *sta, void *priv_sta, 1929 struct sk_buff *skb); 1930 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta, 1931 struct ieee80211_tx_rate_control *txrc); 1932 1933 void (*add_sta_debugfs)(void *priv, void *priv_sta, 1934 struct dentry *dir); 1935 void (*remove_sta_debugfs)(void *priv, void *priv_sta); 1936 }; 1937 1938 static inline int rate_supported(struct ieee80211_sta *sta, 1939 enum ieee80211_band band, 1940 int index) 1941 { 1942 return (sta == NULL || sta->supp_rates[band] & BIT(index)); 1943 } 1944 1945 static inline s8 1946 rate_lowest_index(struct ieee80211_supported_band *sband, 1947 struct ieee80211_sta *sta) 1948 { 1949 int i; 1950 1951 for (i = 0; i < sband->n_bitrates; i++) 1952 if (rate_supported(sta, sband->band, i)) 1953 return i; 1954 1955 /* warn when we cannot find a rate. */ 1956 WARN_ON(1); 1957 1958 return 0; 1959 } 1960 1961 1962 int ieee80211_rate_control_register(struct rate_control_ops *ops); 1963 void ieee80211_rate_control_unregister(struct rate_control_ops *ops); 1964 1965 #endif /* MAC80211_H */ 1966