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