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