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