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