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