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