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