mac80211.h revision 9e7234923789897858e1a475c579b5e2e6ad5b74
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 function. 42 */ 43 44/** 45 * DOC: Warning 46 * 47 * If you're reading this document and not the header file itself, it will 48 * be incomplete because not all documentation has been converted yet. 49 */ 50 51/** 52 * DOC: Frame format 53 * 54 * As a general rule, when frames are passed between mac80211 and the driver, 55 * they start with the IEEE 802.11 header and include the same octets that are 56 * sent over the air except for the FCS which should be calculated by the 57 * hardware. 58 * 59 * There are, however, various exceptions to this rule for advanced features: 60 * 61 * The first exception is for hardware encryption and decryption offload 62 * where the IV/ICV may or may not be generated in hardware. 63 * 64 * Secondly, when the hardware handles fragmentation, the frame handed to 65 * the driver from mac80211 is the MSDU, not the MPDU. 66 * 67 * Finally, for received frames, the driver is able to indicate that it has 68 * filled a radiotap header and put that in front of the frame; if it does 69 * not do so then mac80211 may add this under certain circumstances. 70 */ 71 72#define IEEE80211_CHAN_W_SCAN 0x00000001 73#define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002 74#define IEEE80211_CHAN_W_IBSS 0x00000004 75 76/* Channel information structure. Low-level driver is expected to fill in chan, 77 * freq, and val fields. Other fields will be filled in by 80211.o based on 78 * hostapd information and low-level driver does not need to use them. The 79 * limits for each channel will be provided in 'struct ieee80211_conf' when 80 * configuring the low-level driver with hw->config callback. If a device has 81 * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED 82 * can be set to let the driver configure all fields */ 83struct ieee80211_channel { 84 short chan; /* channel number (IEEE 802.11) */ 85 short freq; /* frequency in MHz */ 86 int val; /* hw specific value for the channel */ 87 int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */ 88 unsigned char power_level; 89 unsigned char antenna_max; 90}; 91 92#define IEEE80211_RATE_ERP 0x00000001 93#define IEEE80211_RATE_BASIC 0x00000002 94#define IEEE80211_RATE_PREAMBLE2 0x00000004 95#define IEEE80211_RATE_SUPPORTED 0x00000010 96#define IEEE80211_RATE_OFDM 0x00000020 97#define IEEE80211_RATE_CCK 0x00000040 98#define IEEE80211_RATE_MANDATORY 0x00000100 99 100#define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2) 101#define IEEE80211_RATE_MODULATION(f) \ 102 (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM)) 103 104/* Low-level driver should set PREAMBLE2, OFDM and CCK flags. 105 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the 106 * configuration. */ 107struct ieee80211_rate { 108 int rate; /* rate in 100 kbps */ 109 int val; /* hw specific value for the rate */ 110 int flags; /* IEEE80211_RATE_ flags */ 111 int val2; /* hw specific value for the rate when using short preamble 112 * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for 113 * 2, 5.5, and 11 Mbps) */ 114 signed char min_rssi_ack; 115 unsigned char min_rssi_ack_delta; 116 117 /* following fields are set by 80211.o and need not be filled by the 118 * low-level driver */ 119 int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for 120 * optimizing channel utilization estimates */ 121}; 122 123/** 124 * enum ieee80211_phymode - PHY modes 125 * 126 * @MODE_IEEE80211A: 5GHz as defined by 802.11a/802.11h 127 * @MODE_IEEE80211B: 2.4 GHz as defined by 802.11b 128 * @MODE_IEEE80211G: 2.4 GHz as defined by 802.11g (with OFDM), 129 * backwards compatible with 11b mode 130 * @NUM_IEEE80211_MODES: internal 131 */ 132enum ieee80211_phymode { 133 MODE_IEEE80211A, 134 MODE_IEEE80211B, 135 MODE_IEEE80211G, 136 137 /* keep last */ 138 NUM_IEEE80211_MODES 139}; 140 141/** 142 * struct ieee80211_ht_info - describing STA's HT capabilities 143 * 144 * This structure describes most essential parameters needed 145 * to describe 802.11n HT capabilities for an STA. 146 * 147 * @ht_supported: is HT supported by STA, 0: no, 1: yes 148 * @cap: HT capabilities map as described in 802.11n spec 149 * @ampdu_factor: Maximum A-MPDU length factor 150 * @ampdu_density: Minimum A-MPDU spacing 151 * @supp_mcs_set: Supported MCS set as described in 802.11n spec 152 */ 153struct ieee80211_ht_info { 154 u8 ht_supported; 155 u16 cap; /* use IEEE80211_HT_CAP_ */ 156 u8 ampdu_factor; 157 u8 ampdu_density; 158 u8 supp_mcs_set[16]; 159}; 160 161/** 162 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics 163 * 164 * This structure describes most essential parameters needed 165 * to describe 802.11n HT characteristics in a BSS 166 * 167 * @primary_channel: channel number of primery channel 168 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width) 169 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection) 170 */ 171struct ieee80211_ht_bss_info { 172 u8 primary_channel; 173 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */ 174 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */ 175}; 176 177/** 178 * struct ieee80211_hw_mode - PHY mode definition 179 * 180 * This structure describes the capabilities supported by the device 181 * in a single PHY mode. 182 * 183 * @list: internal 184 * @channels: pointer to array of supported channels 185 * @rates: pointer to array of supported bitrates 186 * @mode: the PHY mode for this definition 187 * @num_channels: number of supported channels 188 * @num_rates: number of supported bitrates 189 * @ht_info: PHY's 802.11n HT abilities for this mode 190 */ 191struct ieee80211_hw_mode { 192 struct list_head list; 193 struct ieee80211_channel *channels; 194 struct ieee80211_rate *rates; 195 enum ieee80211_phymode mode; 196 int num_channels; 197 int num_rates; 198 struct ieee80211_ht_info ht_info; 199}; 200 201/** 202 * struct ieee80211_tx_queue_params - transmit queue configuration 203 * 204 * The information provided in this structure is required for QoS 205 * transmit queue configuration. 206 * 207 * @aifs: arbitration interface space [0..255, -1: use default] 208 * @cw_min: minimum contention window [will be a value of the form 209 * 2^n-1 in the range 1..1023; 0: use default] 210 * @cw_max: maximum contention window [like @cw_min] 211 * @burst_time: maximum burst time in units of 0.1ms, 0 meaning disabled 212 */ 213struct ieee80211_tx_queue_params { 214 int aifs; 215 int cw_min; 216 int cw_max; 217 int burst_time; 218}; 219 220/** 221 * struct ieee80211_tx_queue_stats_data - transmit queue statistics 222 * 223 * @len: number of packets in queue 224 * @limit: queue length limit 225 * @count: number of frames sent 226 */ 227struct ieee80211_tx_queue_stats_data { 228 unsigned int len; 229 unsigned int limit; 230 unsigned int count; 231}; 232 233/** 234 * enum ieee80211_tx_queue - transmit queue number 235 * 236 * These constants are used with some callbacks that take a 237 * queue number to set parameters for a queue. 238 * 239 * @IEEE80211_TX_QUEUE_DATA0: data queue 0 240 * @IEEE80211_TX_QUEUE_DATA1: data queue 1 241 * @IEEE80211_TX_QUEUE_DATA2: data queue 2 242 * @IEEE80211_TX_QUEUE_DATA3: data queue 3 243 * @IEEE80211_TX_QUEUE_DATA4: data queue 4 244 * @IEEE80211_TX_QUEUE_SVP: ?? 245 * @NUM_TX_DATA_QUEUES: number of data queues 246 * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be 247 * sent after a beacon 248 * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames 249 * @NUM_TX_DATA_QUEUES_AMPDU: adding more queues for A-MPDU 250 */ 251enum ieee80211_tx_queue { 252 IEEE80211_TX_QUEUE_DATA0, 253 IEEE80211_TX_QUEUE_DATA1, 254 IEEE80211_TX_QUEUE_DATA2, 255 IEEE80211_TX_QUEUE_DATA3, 256 IEEE80211_TX_QUEUE_DATA4, 257 IEEE80211_TX_QUEUE_SVP, 258 259 NUM_TX_DATA_QUEUES, 260 261/* due to stupidity in the sub-ioctl userspace interface, the items in 262 * this struct need to have fixed values. As soon as it is removed, we can 263 * fix these entries. */ 264 IEEE80211_TX_QUEUE_AFTER_BEACON = 6, 265 IEEE80211_TX_QUEUE_BEACON = 7, 266 NUM_TX_DATA_QUEUES_AMPDU = 16 267}; 268 269struct ieee80211_tx_queue_stats { 270 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES_AMPDU]; 271}; 272 273struct ieee80211_low_level_stats { 274 unsigned int dot11ACKFailureCount; 275 unsigned int dot11RTSFailureCount; 276 unsigned int dot11FCSErrorCount; 277 unsigned int dot11RTSSuccessCount; 278}; 279 280/** 281 * enum ieee80211_bss_change - BSS change notification flags 282 * 283 * These flags are used with the bss_info_changed() callback 284 * to indicate which BSS parameter changed. 285 * 286 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated), 287 * also implies a change in the AID. 288 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed 289 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed 290 */ 291enum ieee80211_bss_change { 292 BSS_CHANGED_ASSOC = 1<<0, 293 BSS_CHANGED_ERP_CTS_PROT = 1<<1, 294 BSS_CHANGED_ERP_PREAMBLE = 1<<2, 295}; 296 297/** 298 * struct ieee80211_bss_conf - holds the BSS's changing parameters 299 * 300 * This structure keeps information about a BSS (and an association 301 * to that BSS) that can change during the lifetime of the BSS. 302 * 303 * @assoc: association status 304 * @aid: association ID number, valid only when @assoc is true 305 * @use_cts_prot: use CTS protection 306 * @use_short_preamble: use 802.11b short preamble 307 */ 308struct ieee80211_bss_conf { 309 /* association related data */ 310 bool assoc; 311 u16 aid; 312 /* erp related data */ 313 bool use_cts_prot; 314 bool use_short_preamble; 315}; 316 317/* Transmit control fields. This data structure is passed to low-level driver 318 * with each TX frame. The low-level driver is responsible for configuring 319 * the hardware to use given values (depending on what is supported). */ 320 321struct ieee80211_tx_control { 322 struct ieee80211_vif *vif; 323 int tx_rate; /* Transmit rate, given as the hw specific value for the 324 * rate (from struct ieee80211_rate) */ 325 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw 326 * specific value for the rate (from 327 * struct ieee80211_rate) */ 328 329#define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for 330 * this frame */ 331#define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without 332 * encryption; e.g., for EAPOL 333 * frames */ 334#define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending 335 * frame */ 336#define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the 337 * frame (e.g., for combined 338 * 802.11g / 802.11b networks) */ 339#define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to 340 * wait for an ack */ 341#define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5) 342#define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6) 343#define IEEE80211_TXCTL_REQUEUE (1<<7) 344#define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of 345 * the frame */ 346#define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send 347 * using the through 348 * set_retry_limit configured 349 * long retry value */ 350#define IEEE80211_TXCTL_EAPOL_FRAME (1<<11) /* internal to mac80211 */ 351#define IEEE80211_TXCTL_SEND_AFTER_DTIM (1<<12) /* send this frame after DTIM 352 * beacon */ 353#define IEEE80211_TXCTL_AMPDU (1<<13) /* this frame should be sent 354 * as part of an A-MPDU */ 355 u32 flags; /* tx control flags defined 356 * above */ 357 u8 key_idx; /* keyidx from hw->set_key(), undefined if 358 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */ 359 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, .. 360 * This could be used when set_retry_limit 361 * is not implemented by the driver */ 362 u8 power_level; /* per-packet transmit power level, in dBm */ 363 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */ 364 u8 icv_len; /* length of the ICV/MIC field in octets */ 365 u8 iv_len; /* length of the IV field in octets */ 366 u8 queue; /* hardware queue to use for this frame; 367 * 0 = highest, hw->queues-1 = lowest */ 368 struct ieee80211_rate *rate; /* internal 80211.o rate */ 369 struct ieee80211_rate *rts_rate; /* internal 80211.o rate 370 * for RTS/CTS */ 371 int alt_retry_rate; /* retry rate for the last retries, given as the 372 * hw specific value for the rate (from 373 * struct ieee80211_rate). To be used to limit 374 * packet dropping when probing higher rates, if hw 375 * supports multiple retry rates. -1 = not used */ 376 int type; /* internal */ 377}; 378 379 380/** 381 * enum mac80211_rx_flags - receive flags 382 * 383 * These flags are used with the @flag member of &struct ieee80211_rx_status. 384 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. 385 * Use together with %RX_FLAG_MMIC_STRIPPED. 386 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. 387 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header. 388 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, 389 * verification has been done by the hardware. 390 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame. 391 * If this flag is set, the stack cannot do any replay detection 392 * hence the driver or hardware will have to do that. 393 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on 394 * the frame. 395 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on 396 * the frame. 397 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field) 398 * is valid. 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}; 410 411/** 412 * struct ieee80211_rx_status - receive status 413 * 414 * The low-level driver should provide this information (the subset 415 * supported by hardware) to the 802.11 code with each received 416 * frame. 417 * @mactime: MAC timestamp as defined by 802.11 418 * @freq: frequency the radio was tuned to when receiving this frame, in MHz 419 * @channel: channel the radio was tuned to 420 * @phymode: active PHY mode 421 * @ssi: signal strength when receiving this frame 422 * @signal: used as 'qual' in statistics reporting 423 * @noise: PHY noise when receiving this frame 424 * @antenna: antenna used 425 * @rate: data rate 426 * @flag: %RX_FLAG_* 427 */ 428struct ieee80211_rx_status { 429 u64 mactime; 430 int freq; 431 int channel; 432 enum ieee80211_phymode phymode; 433 int ssi; 434 int signal; 435 int noise; 436 int antenna; 437 int rate; 438 int flag; 439}; 440 441/** 442 * enum ieee80211_tx_status_flags - transmit status flags 443 * 444 * Status flags to indicate various transmit conditions. 445 * 446 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted 447 * because the destination STA was in powersave mode. 448 * 449 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged 450 */ 451enum ieee80211_tx_status_flags { 452 IEEE80211_TX_STATUS_TX_FILTERED = 1<<0, 453 IEEE80211_TX_STATUS_ACK = 1<<1, 454}; 455 456/** 457 * struct ieee80211_tx_status - transmit status 458 * 459 * As much information as possible should be provided for each transmitted 460 * frame with ieee80211_tx_status(). 461 * 462 * @control: a copy of the &struct ieee80211_tx_control passed to the driver 463 * in the tx() callback. 464 * 465 * @flags: transmit status flags, defined above 466 * 467 * @ack_signal: signal strength of the ACK frame 468 * 469 * @excessive_retries: set to 1 if the frame was retried many times 470 * but not acknowledged 471 * 472 * @retry_count: number of retries 473 * 474 * @queue_length: ?? REMOVE 475 * @queue_number: ?? REMOVE 476 */ 477struct ieee80211_tx_status { 478 struct ieee80211_tx_control control; 479 u8 flags; 480 bool excessive_retries; 481 u8 retry_count; 482 int ack_signal; 483 int queue_length; 484 int queue_number; 485}; 486 487/** 488 * enum ieee80211_conf_flags - configuration flags 489 * 490 * Flags to define PHY configuration options 491 * 492 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time 493 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported) 494 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported) 495 */ 496enum ieee80211_conf_flags { 497 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0), 498 IEEE80211_CONF_RADIOTAP = (1<<1), 499 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2), 500}; 501 502/** 503 * struct ieee80211_conf - configuration of the device 504 * 505 * This struct indicates how the driver shall configure the hardware. 506 * 507 * @radio_enabled: when zero, driver is required to switch off the radio. 508 * TODO make a flag 509 * @channel: IEEE 802.11 channel number 510 * @freq: frequency in MHz 511 * @channel_val: hardware specific channel value for the channel 512 * @phymode: PHY mode to activate (REMOVE) 513 * @chan: channel to switch to, pointer to the channel information 514 * @mode: pointer to mode definition 515 * @regulatory_domain: ?? 516 * @beacon_int: beacon interval (TODO make interface config) 517 * @flags: configuration flags defined above 518 * @power_level: transmit power limit for current regulatory domain in dBm 519 * @antenna_max: maximum antenna gain 520 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity, 521 * 1/2: antenna 0/1 522 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx 523 * @ht_conf: describes current self configuration of 802.11n HT capabilies 524 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters 525 */ 526struct ieee80211_conf { 527 int channel; /* IEEE 802.11 channel number */ 528 int freq; /* MHz */ 529 int channel_val; /* hw specific value for the channel */ 530 531 enum ieee80211_phymode phymode; 532 struct ieee80211_channel *chan; 533 struct ieee80211_hw_mode *mode; 534 unsigned int regulatory_domain; 535 int radio_enabled; 536 537 int beacon_int; 538 u32 flags; 539 u8 power_level; 540 u8 antenna_max; 541 u8 antenna_sel_tx; 542 u8 antenna_sel_rx; 543 544 struct ieee80211_ht_info ht_conf; 545 struct ieee80211_ht_bss_info ht_bss_conf; 546}; 547 548/** 549 * enum ieee80211_if_types - types of 802.11 network interfaces 550 * 551 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used 552 * by mac80211 itself 553 * @IEEE80211_IF_TYPE_AP: interface in AP mode. 554 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap 555 * daemon. Drivers should never see this type. 556 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode. 557 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode. 558 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode. 559 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode. 560 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers 561 * will never see this type. 562 */ 563enum ieee80211_if_types { 564 IEEE80211_IF_TYPE_INVALID, 565 IEEE80211_IF_TYPE_AP, 566 IEEE80211_IF_TYPE_STA, 567 IEEE80211_IF_TYPE_IBSS, 568 IEEE80211_IF_TYPE_MNTR, 569 IEEE80211_IF_TYPE_WDS, 570 IEEE80211_IF_TYPE_VLAN, 571}; 572 573/** 574 * struct ieee80211_vif - per-interface data 575 * 576 * Data in this structure is continually present for driver 577 * use during the life of a virtual interface. 578 * 579 * @type: type of this virtual interface 580 * @drv_priv: data area for driver use, will always be aligned to 581 * sizeof(void *). 582 */ 583struct ieee80211_vif { 584 enum ieee80211_if_types type; 585 /* must be last */ 586 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *)))); 587}; 588 589/** 590 * struct ieee80211_if_init_conf - initial configuration of an interface 591 * 592 * @vif: pointer to a driver-use per-interface structure. The pointer 593 * itself is also used for various functions including 594 * ieee80211_beacon_get() and ieee80211_get_buffered_bc(). 595 * @type: one of &enum ieee80211_if_types constants. Determines the type of 596 * added/removed interface. 597 * @mac_addr: pointer to MAC address of the interface. This pointer is valid 598 * until the interface is removed (i.e. it cannot be used after 599 * remove_interface() callback was called for this interface). 600 * 601 * This structure is used in add_interface() and remove_interface() 602 * callbacks of &struct ieee80211_hw. 603 * 604 * When you allow multiple interfaces to be added to your PHY, take care 605 * that the hardware can actually handle multiple MAC addresses. However, 606 * also take care that when there's no interface left with mac_addr != %NULL 607 * you remove the MAC address from the device to avoid acknowledging packets 608 * in pure monitor mode. 609 */ 610struct ieee80211_if_init_conf { 611 enum ieee80211_if_types type; 612 struct ieee80211_vif *vif; 613 void *mac_addr; 614}; 615 616/** 617 * struct ieee80211_if_conf - configuration of an interface 618 * 619 * @type: type of the interface. This is always the same as was specified in 620 * &struct ieee80211_if_init_conf. The type of an interface never changes 621 * during the life of the interface; this field is present only for 622 * convenience. 623 * @bssid: BSSID of the network we are associated to/creating. 624 * @ssid: used (together with @ssid_len) by drivers for hardware that 625 * generate beacons independently. The pointer is valid only during the 626 * config_interface() call, so copy the value somewhere if you need 627 * it. 628 * @ssid_len: length of the @ssid field. 629 * @beacon: beacon template. Valid only if @host_gen_beacon_template in 630 * &struct ieee80211_hw is set. The driver is responsible of freeing 631 * the sk_buff. 632 * @beacon_control: tx_control for the beacon template, this field is only 633 * valid when the @beacon field was set. 634 * 635 * This structure is passed to the config_interface() callback of 636 * &struct ieee80211_hw. 637 */ 638struct ieee80211_if_conf { 639 int type; 640 u8 *bssid; 641 u8 *ssid; 642 size_t ssid_len; 643 struct sk_buff *beacon; 644 struct ieee80211_tx_control *beacon_control; 645}; 646 647/** 648 * enum ieee80211_key_alg - key algorithm 649 * @ALG_WEP: WEP40 or WEP104 650 * @ALG_TKIP: TKIP 651 * @ALG_CCMP: CCMP (AES) 652 */ 653enum ieee80211_key_alg { 654 ALG_WEP, 655 ALG_TKIP, 656 ALG_CCMP, 657}; 658 659 660/** 661 * enum ieee80211_key_flags - key flags 662 * 663 * These flags are used for communication about keys between the driver 664 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. 665 * 666 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates 667 * that the STA this key will be used with could be using QoS. 668 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the 669 * driver to indicate that it requires IV generation for this 670 * particular key. 671 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by 672 * the driver for a TKIP key if it requires Michael MIC 673 * generation in software. 674 */ 675enum ieee80211_key_flags { 676 IEEE80211_KEY_FLAG_WMM_STA = 1<<0, 677 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1, 678 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2, 679}; 680 681/** 682 * struct ieee80211_key_conf - key information 683 * 684 * This key information is given by mac80211 to the driver by 685 * the set_key() callback in &struct ieee80211_ops. 686 * 687 * @hw_key_idx: To be set by the driver, this is the key index the driver 688 * wants to be given when a frame is transmitted and needs to be 689 * encrypted in hardware. 690 * @alg: The key algorithm. 691 * @flags: key flags, see &enum ieee80211_key_flags. 692 * @keyidx: the key index (0-3) 693 * @keylen: key material length 694 * @key: key material 695 */ 696struct ieee80211_key_conf { 697 enum ieee80211_key_alg alg; 698 u8 hw_key_idx; 699 u8 flags; 700 s8 keyidx; 701 u8 keylen; 702 u8 key[0]; 703}; 704 705/** 706 * enum set_key_cmd - key command 707 * 708 * Used with the set_key() callback in &struct ieee80211_ops, this 709 * indicates whether a key is being removed or added. 710 * 711 * @SET_KEY: a key is set 712 * @DISABLE_KEY: a key must be disabled 713 */ 714enum set_key_cmd { 715 SET_KEY, DISABLE_KEY, 716}; 717 718/** 719 * enum sta_notify_cmd - sta notify command 720 * 721 * Used with the sta_notify() callback in &struct ieee80211_ops, this 722 * indicates addition and removal of a station to station table 723 * 724 * @STA_NOTIFY_ADD: a station was added to the station table 725 * @STA_NOTIFY_REMOVE: a station being removed from the station table 726 */ 727enum sta_notify_cmd { 728 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE 729}; 730 731/** 732 * enum ieee80211_hw_flags - hardware flags 733 * 734 * These flags are used to indicate hardware capabilities to 735 * the stack. Generally, flags here should have their meaning 736 * done in a way that the simplest hardware doesn't need setting 737 * any particular flags. There are some exceptions to this rule, 738 * however, so you are advised to review these flags carefully. 739 * 740 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE: 741 * The device only needs to be supplied with a beacon template. 742 * If you need the host to generate each beacon then don't use 743 * this flag and call ieee80211_beacon_get() when you need the 744 * next beacon frame. Note that if you set this flag, you must 745 * implement the set_tim() callback for powersave mode to work 746 * properly. 747 * This flag is only relevant for access-point mode. 748 * 749 * @IEEE80211_HW_RX_INCLUDES_FCS: 750 * Indicates that received frames passed to the stack include 751 * the FCS at the end. 752 * 753 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 754 * Some wireless LAN chipsets buffer broadcast/multicast frames 755 * for power saving stations in the hardware/firmware and others 756 * rely on the host system for such buffering. This option is used 757 * to configure the IEEE 802.11 upper layer to buffer broadcast and 758 * multicast frames when there are power saving stations so that 759 * the driver can fetch them with ieee80211_get_buffered_bc(). Note 760 * that not setting this flag works properly only when the 761 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because 762 * otherwise the stack will not know when the DTIM beacon was sent. 763 * 764 * @IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED: 765 * Channels are already configured to the default regulatory domain 766 * specified in the device's EEPROM 767 */ 768enum ieee80211_hw_flags { 769 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0, 770 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, 771 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, 772 IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED = 1<<3, 773}; 774 775/** 776 * struct ieee80211_hw - hardware information and state 777 * 778 * This structure contains the configuration and hardware 779 * information for an 802.11 PHY. 780 * 781 * @wiphy: This points to the &struct wiphy allocated for this 782 * 802.11 PHY. You must fill in the @perm_addr and @dev 783 * members of this structure using SET_IEEE80211_DEV() 784 * and SET_IEEE80211_PERM_ADDR(). 785 * 786 * @conf: &struct ieee80211_conf, device configuration, don't use. 787 * 788 * @workqueue: single threaded workqueue available for driver use, 789 * allocated by mac80211 on registration and flushed on 790 * unregistration. 791 * 792 * @priv: pointer to private area that was allocated for driver use 793 * along with this structure. 794 * 795 * @flags: hardware flags, see &enum ieee80211_hw_flags. 796 * 797 * @extra_tx_headroom: headroom to reserve in each transmit skb 798 * for use by the driver (e.g. for transmit headers.) 799 * 800 * @channel_change_time: time (in microseconds) it takes to change channels. 801 * 802 * @max_rssi: Maximum value for ssi in RX information, use 803 * negative numbers for dBm and 0 to indicate no support. 804 * 805 * @max_signal: like @max_rssi, but for the signal value. 806 * 807 * @max_noise: like @max_rssi, but for the noise value. 808 * 809 * @queues: number of available hardware transmit queues for 810 * data packets. WMM/QoS requires at least four. 811 * 812 * @rate_control_algorithm: rate control algorithm for this hardware. 813 * If unset (NULL), the default algorithm will be used. Must be 814 * set before calling ieee80211_register_hw(). 815 * 816 * @vif_data_size: size (in bytes) of the drv_priv data area 817 * within &struct ieee80211_vif. 818 */ 819struct ieee80211_hw { 820 struct ieee80211_conf conf; 821 struct wiphy *wiphy; 822 struct workqueue_struct *workqueue; 823 const char *rate_control_algorithm; 824 void *priv; 825 u32 flags; 826 unsigned int extra_tx_headroom; 827 int channel_change_time; 828 int vif_data_size; 829 u8 queues; 830 s8 max_rssi; 831 s8 max_signal; 832 s8 max_noise; 833}; 834 835/** 836 * SET_IEEE80211_DEV - set device for 802.11 hardware 837 * 838 * @hw: the &struct ieee80211_hw to set the device for 839 * @dev: the &struct device of this 802.11 device 840 */ 841static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 842{ 843 set_wiphy_dev(hw->wiphy, dev); 844} 845 846/** 847 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware 848 * 849 * @hw: the &struct ieee80211_hw to set the MAC address for 850 * @addr: the address to set 851 */ 852static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 853{ 854 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 855} 856 857/** 858 * DOC: Hardware crypto acceleration 859 * 860 * mac80211 is capable of taking advantage of many hardware 861 * acceleration designs for encryption and decryption operations. 862 * 863 * The set_key() callback in the &struct ieee80211_ops for a given 864 * device is called to enable hardware acceleration of encryption and 865 * decryption. The callback takes an @address parameter that will be 866 * the broadcast address for default keys, the other station's hardware 867 * address for individual keys or the zero address for keys that will 868 * be used only for transmission. 869 * Multiple transmission keys with the same key index may be used when 870 * VLANs are configured for an access point. 871 * 872 * The @local_address parameter will always be set to our own address, 873 * this is only relevant if you support multiple local addresses. 874 * 875 * When transmitting, the TX control data will use the @hw_key_idx 876 * selected by the driver by modifying the &struct ieee80211_key_conf 877 * pointed to by the @key parameter to the set_key() function. 878 * 879 * The set_key() call for the %SET_KEY command should return 0 if 880 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 881 * added; if you return 0 then hw_key_idx must be assigned to the 882 * hardware key index, you are free to use the full u8 range. 883 * 884 * When the cmd is %DISABLE_KEY then it must succeed. 885 * 886 * Note that it is permissible to not decrypt a frame even if a key 887 * for it has been uploaded to hardware, the stack will not make any 888 * decision based on whether a key has been uploaded or not but rather 889 * based on the receive flags. 890 * 891 * The &struct ieee80211_key_conf structure pointed to by the @key 892 * parameter is guaranteed to be valid until another call to set_key() 893 * removes it, but it can only be used as a cookie to differentiate 894 * keys. 895 */ 896 897/** 898 * DOC: Frame filtering 899 * 900 * mac80211 requires to see many management frames for proper 901 * operation, and users may want to see many more frames when 902 * in monitor mode. However, for best CPU usage and power consumption, 903 * having as few frames as possible percolate through the stack is 904 * desirable. Hence, the hardware should filter as much as possible. 905 * 906 * To achieve this, mac80211 uses filter flags (see below) to tell 907 * the driver's configure_filter() function which frames should be 908 * passed to mac80211 and which should be filtered out. 909 * 910 * The configure_filter() callback is invoked with the parameters 911 * @mc_count and @mc_list for the combined multicast address list 912 * of all virtual interfaces, @changed_flags telling which flags 913 * were changed and @total_flags with the new flag states. 914 * 915 * If your device has no multicast address filters your driver will 916 * need to check both the %FIF_ALLMULTI flag and the @mc_count 917 * parameter to see whether multicast frames should be accepted 918 * or dropped. 919 * 920 * All unsupported flags in @total_flags must be cleared, i.e. you 921 * should clear all bits except those you honoured. 922 */ 923 924/** 925 * enum ieee80211_filter_flags - hardware filter flags 926 * 927 * These flags determine what the filter in hardware should be 928 * programmed to let through and what should not be passed to the 929 * stack. It is always safe to pass more frames than requested, 930 * but this has negative impact on power consumption. 931 * 932 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, 933 * think of the BSS as your network segment and then this corresponds 934 * to the regular ethernet device promiscuous mode. 935 * 936 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 937 * by the user or if the hardware is not capable of filtering by 938 * multicast address. 939 * 940 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 941 * %RX_FLAG_FAILED_FCS_CRC for them) 942 * 943 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 944 * the %RX_FLAG_FAILED_PLCP_CRC for them 945 * 946 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 947 * to the hardware that it should not filter beacons or probe responses 948 * by BSSID. Filtering them can greatly reduce the amount of processing 949 * mac80211 needs to do and the amount of CPU wakeups, so you should 950 * honour this flag if possible. 951 * 952 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then 953 * only those addressed to this station 954 * 955 * @FIF_OTHER_BSS: pass frames destined to other BSSes 956 */ 957enum ieee80211_filter_flags { 958 FIF_PROMISC_IN_BSS = 1<<0, 959 FIF_ALLMULTI = 1<<1, 960 FIF_FCSFAIL = 1<<2, 961 FIF_PLCPFAIL = 1<<3, 962 FIF_BCN_PRBRESP_PROMISC = 1<<4, 963 FIF_CONTROL = 1<<5, 964 FIF_OTHER_BSS = 1<<6, 965}; 966 967/** 968 * enum ieee80211_ampdu_mlme_action - A-MPDU actions 969 * 970 * These flags are used with the ampdu_action() callback in 971 * &struct ieee80211_ops to indicate which action is needed. 972 * @IEEE80211_AMPDU_RX_START: start Rx aggregation 973 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation 974 * @IEEE80211_AMPDU_TX_START: start Tx aggregation 975 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation 976 */ 977enum ieee80211_ampdu_mlme_action { 978 IEEE80211_AMPDU_RX_START, 979 IEEE80211_AMPDU_RX_STOP, 980 IEEE80211_AMPDU_TX_START, 981 IEEE80211_AMPDU_TX_STOP, 982}; 983 984/** 985 * struct ieee80211_ops - callbacks from mac80211 to the driver 986 * 987 * This structure contains various callbacks that the driver may 988 * handle or, in some cases, must handle, for example to configure 989 * the hardware to a new channel or to transmit a frame. 990 * 991 * @tx: Handler that 802.11 module calls for each transmitted frame. 992 * skb contains the buffer starting from the IEEE 802.11 header. 993 * The low-level driver should send the frame out based on 994 * configuration in the TX control data. Must be implemented and 995 * atomic. 996 * 997 * @start: Called before the first netdevice attached to the hardware 998 * is enabled. This should turn on the hardware and must turn on 999 * frame reception (for possibly enabled monitor interfaces.) 1000 * Returns negative error codes, these may be seen in userspace, 1001 * or zero. 1002 * When the device is started it should not have a MAC address 1003 * to avoid acknowledging frames before a non-monitor device 1004 * is added. 1005 * Must be implemented. 1006 * 1007 * @stop: Called after last netdevice attached to the hardware 1008 * is disabled. This should turn off the hardware (at least 1009 * it must turn off frame reception.) 1010 * May be called right after add_interface if that rejects 1011 * an interface. 1012 * Must be implemented. 1013 * 1014 * @add_interface: Called when a netdevice attached to the hardware is 1015 * enabled. Because it is not called for monitor mode devices, @open 1016 * and @stop must be implemented. 1017 * The driver should perform any initialization it needs before 1018 * the device can be enabled. The initial configuration for the 1019 * interface is given in the conf parameter. 1020 * The callback may refuse to add an interface by returning a 1021 * negative error code (which will be seen in userspace.) 1022 * Must be implemented. 1023 * 1024 * @remove_interface: Notifies a driver that an interface is going down. 1025 * The @stop callback is called after this if it is the last interface 1026 * and no monitor interfaces are present. 1027 * When all interfaces are removed, the MAC address in the hardware 1028 * must be cleared so the device no longer acknowledges packets, 1029 * the mac_addr member of the conf structure is, however, set to the 1030 * MAC address of the device going away. 1031 * Hence, this callback must be implemented. 1032 * 1033 * @config: Handler for configuration requests. IEEE 802.11 code calls this 1034 * function to change hardware configuration, e.g., channel. 1035 * 1036 * @config_interface: Handler for configuration requests related to interfaces 1037 * (e.g. BSSID changes.) 1038 * 1039 * @bss_info_changed: Handler for configuration requests related to BSS 1040 * parameters that may vary during BSS's lifespan, and may affect low 1041 * level driver (e.g. assoc/disassoc status, erp parameters). 1042 * This function should not be used if no BSS has been set, unless 1043 * for association indication. The @changed parameter indicates which 1044 * of the bss parameters has changed when a call is made. This callback 1045 * has to be atomic. 1046 * 1047 * @configure_filter: Configure the device's RX filter. 1048 * See the section "Frame filtering" for more information. 1049 * This callback must be implemented and atomic. 1050 * 1051 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon 1052 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set) 1053 * mac80211 calls this function when a TIM bit must be set or cleared 1054 * for a given AID. Must be atomic. 1055 * 1056 * @set_key: See the section "Hardware crypto acceleration" 1057 * This callback can sleep, and is only called between add_interface 1058 * and remove_interface calls, i.e. while the interface with the 1059 * given local_address is enabled. 1060 * 1061 * @hw_scan: Ask the hardware to service the scan request, no need to start 1062 * the scan state machine in stack. 1063 * 1064 * @get_stats: return low-level statistics 1065 * 1066 * @get_tkip_seq: If your device implements TKIP encryption in hardware this 1067 * callback should be provided to read the TKIP transmit IVs (both IV32 1068 * and IV16) for the given key from hardware. 1069 * 1070 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 1071 * 1072 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if 1073 * the device does fragmentation by itself; if this method is assigned then 1074 * the stack will not do fragmentation. 1075 * 1076 * @set_retry_limit: Configuration of retry limits (if device needs it) 1077 * 1078 * @sta_notify: Notifies low level driver about addition or removal 1079 * of assocaited station or AP. 1080 * 1081 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 1082 * bursting) for a hardware TX queue. The @queue parameter uses the 1083 * %IEEE80211_TX_QUEUE_* constants. Must be atomic. 1084 * 1085 * @get_tx_stats: Get statistics of the current TX queue status. This is used 1086 * to get number of currently queued packets (queue length), maximum queue 1087 * size (limit), and total number of packets sent using each TX queue 1088 * (count). This information is used for WMM to find out which TX 1089 * queues have room for more packets and by hostapd to provide 1090 * statistics about the current queueing state to external programs. 1091 * 1092 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 1093 * this is only used for IBSS mode debugging and, as such, is not a 1094 * required function. Must be atomic. 1095 * 1096 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 1097 * with other STAs in the IBSS. This is only used in IBSS mode. This 1098 * function is optional if the firmware/hardware takes full care of 1099 * TSF synchronization. 1100 * 1101 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point, 1102 * IBSS uses a fixed beacon frame which is configured using this 1103 * function. 1104 * If the driver returns success (0) from this callback, it owns 1105 * the skb. That means the driver is responsible to kfree_skb() it. 1106 * The control structure is not dynamically allocated. That means the 1107 * driver does not own the pointer and if it needs it somewhere 1108 * outside of the context of this function, it must copy it 1109 * somewhere else. 1110 * This handler is required only for IBSS mode. 1111 * 1112 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 1113 * This is needed only for IBSS mode and the result of this function is 1114 * used to determine whether to reply to Probe Requests. 1115 * 1116 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic. 1117 * 1118 * @ampdu_action: Perform a certain A-MPDU action 1119 * The RA/TID combination determines the destination and TID we want 1120 * the ampdu action to be performed for. The action is defined through 1121 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn) 1122 * is the first frame we expect to perform the action on. notice 1123 * that TX/RX_STOP can pass NULL for this parameter. 1124 */ 1125struct ieee80211_ops { 1126 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb, 1127 struct ieee80211_tx_control *control); 1128 int (*start)(struct ieee80211_hw *hw); 1129 void (*stop)(struct ieee80211_hw *hw); 1130 int (*add_interface)(struct ieee80211_hw *hw, 1131 struct ieee80211_if_init_conf *conf); 1132 void (*remove_interface)(struct ieee80211_hw *hw, 1133 struct ieee80211_if_init_conf *conf); 1134 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf); 1135 int (*config_interface)(struct ieee80211_hw *hw, 1136 struct ieee80211_vif *vif, 1137 struct ieee80211_if_conf *conf); 1138 void (*bss_info_changed)(struct ieee80211_hw *hw, 1139 struct ieee80211_vif *vif, 1140 struct ieee80211_bss_conf *info, 1141 u32 changed); 1142 void (*configure_filter)(struct ieee80211_hw *hw, 1143 unsigned int changed_flags, 1144 unsigned int *total_flags, 1145 int mc_count, struct dev_addr_list *mc_list); 1146 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set); 1147 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, 1148 const u8 *local_address, const u8 *address, 1149 struct ieee80211_key_conf *key); 1150 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len); 1151 int (*get_stats)(struct ieee80211_hw *hw, 1152 struct ieee80211_low_level_stats *stats); 1153 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx, 1154 u32 *iv32, u16 *iv16); 1155 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 1156 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); 1157 int (*set_retry_limit)(struct ieee80211_hw *hw, 1158 u32 short_retry, u32 long_retr); 1159 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1160 enum sta_notify_cmd, const u8 *addr); 1161 int (*conf_tx)(struct ieee80211_hw *hw, int queue, 1162 const struct ieee80211_tx_queue_params *params); 1163 int (*get_tx_stats)(struct ieee80211_hw *hw, 1164 struct ieee80211_tx_queue_stats *stats); 1165 u64 (*get_tsf)(struct ieee80211_hw *hw); 1166 void (*reset_tsf)(struct ieee80211_hw *hw); 1167 int (*beacon_update)(struct ieee80211_hw *hw, 1168 struct sk_buff *skb, 1169 struct ieee80211_tx_control *control); 1170 int (*tx_last_beacon)(struct ieee80211_hw *hw); 1171 int (*conf_ht)(struct ieee80211_hw *hw, struct ieee80211_conf *conf); 1172 int (*ampdu_action)(struct ieee80211_hw *hw, 1173 enum ieee80211_ampdu_mlme_action action, 1174 const u8 *addr, u16 tid, u16 *ssn); 1175}; 1176 1177/** 1178 * ieee80211_alloc_hw - Allocate a new hardware device 1179 * 1180 * This must be called once for each hardware device. The returned pointer 1181 * must be used to refer to this device when calling other functions. 1182 * mac80211 allocates a private data area for the driver pointed to by 1183 * @priv in &struct ieee80211_hw, the size of this area is given as 1184 * @priv_data_len. 1185 * 1186 * @priv_data_len: length of private data 1187 * @ops: callbacks for this device 1188 */ 1189struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 1190 const struct ieee80211_ops *ops); 1191 1192/** 1193 * ieee80211_register_hw - Register hardware device 1194 * 1195 * You must call this function before any other functions 1196 * except ieee80211_register_hwmode. 1197 * 1198 * @hw: the device to register as returned by ieee80211_alloc_hw() 1199 */ 1200int ieee80211_register_hw(struct ieee80211_hw *hw); 1201 1202#ifdef CONFIG_MAC80211_LEDS 1203extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 1204extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 1205extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); 1206extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw); 1207#endif 1208/** 1209 * ieee80211_get_tx_led_name - get name of TX LED 1210 * 1211 * mac80211 creates a transmit LED trigger for each wireless hardware 1212 * that can be used to drive LEDs if your driver registers a LED device. 1213 * This function returns the name (or %NULL if not configured for LEDs) 1214 * of the trigger so you can automatically link the LED device. 1215 * 1216 * @hw: the hardware to get the LED trigger name for 1217 */ 1218static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 1219{ 1220#ifdef CONFIG_MAC80211_LEDS 1221 return __ieee80211_get_tx_led_name(hw); 1222#else 1223 return NULL; 1224#endif 1225} 1226 1227/** 1228 * ieee80211_get_rx_led_name - get name of RX LED 1229 * 1230 * mac80211 creates a receive LED trigger for each wireless hardware 1231 * that can be used to drive LEDs if your driver registers a LED device. 1232 * This function returns the name (or %NULL if not configured for LEDs) 1233 * of the trigger so you can automatically link the LED device. 1234 * 1235 * @hw: the hardware to get the LED trigger name for 1236 */ 1237static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 1238{ 1239#ifdef CONFIG_MAC80211_LEDS 1240 return __ieee80211_get_rx_led_name(hw); 1241#else 1242 return NULL; 1243#endif 1244} 1245 1246/** 1247 * ieee80211_get_assoc_led_name - get name of association LED 1248 * 1249 * mac80211 creates a association LED trigger for each wireless hardware 1250 * that can be used to drive LEDs if your driver registers a LED device. 1251 * This function returns the name (or %NULL if not configured for LEDs) 1252 * of the trigger so you can automatically link the LED device. 1253 * 1254 * @hw: the hardware to get the LED trigger name for 1255 */ 1256static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) 1257{ 1258#ifdef CONFIG_MAC80211_LEDS 1259 return __ieee80211_get_assoc_led_name(hw); 1260#else 1261 return NULL; 1262#endif 1263} 1264 1265/** 1266 * ieee80211_get_radio_led_name - get name of radio LED 1267 * 1268 * mac80211 creates a radio change LED trigger for each wireless hardware 1269 * that can be used to drive LEDs if your driver registers a LED device. 1270 * This function returns the name (or %NULL if not configured for LEDs) 1271 * of the trigger so you can automatically link the LED device. 1272 * 1273 * @hw: the hardware to get the LED trigger name for 1274 */ 1275static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) 1276{ 1277#ifdef CONFIG_MAC80211_LEDS 1278 return __ieee80211_get_radio_led_name(hw); 1279#else 1280 return NULL; 1281#endif 1282} 1283 1284/* Register a new hardware PHYMODE capability to the stack. */ 1285int ieee80211_register_hwmode(struct ieee80211_hw *hw, 1286 struct ieee80211_hw_mode *mode); 1287 1288/** 1289 * ieee80211_unregister_hw - Unregister a hardware device 1290 * 1291 * This function instructs mac80211 to free allocated resources 1292 * and unregister netdevices from the networking subsystem. 1293 * 1294 * @hw: the hardware to unregister 1295 */ 1296void ieee80211_unregister_hw(struct ieee80211_hw *hw); 1297 1298/** 1299 * ieee80211_free_hw - free hardware descriptor 1300 * 1301 * This function frees everything that was allocated, including the 1302 * private data for the driver. You must call ieee80211_unregister_hw() 1303 * before calling this function 1304 * 1305 * @hw: the hardware to free 1306 */ 1307void ieee80211_free_hw(struct ieee80211_hw *hw); 1308 1309/* trick to avoid symbol clashes with the ieee80211 subsystem */ 1310void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1311 struct ieee80211_rx_status *status); 1312 1313/** 1314 * ieee80211_rx - receive frame 1315 * 1316 * Use this function to hand received frames to mac80211. The receive 1317 * buffer in @skb must start with an IEEE 802.11 header or a radiotap 1318 * header if %RX_FLAG_RADIOTAP is set in the @status flags. 1319 * 1320 * This function may not be called in IRQ context. 1321 * 1322 * @hw: the hardware this frame came in on 1323 * @skb: the buffer to receive, owned by mac80211 after this call 1324 * @status: status of this frame; the status pointer need not be valid 1325 * after this function returns 1326 */ 1327static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1328 struct ieee80211_rx_status *status) 1329{ 1330 __ieee80211_rx(hw, skb, status); 1331} 1332 1333/** 1334 * ieee80211_rx_irqsafe - receive frame 1335 * 1336 * Like ieee80211_rx() but can be called in IRQ context 1337 * (internally defers to a workqueue.) 1338 * 1339 * @hw: the hardware this frame came in on 1340 * @skb: the buffer to receive, owned by mac80211 after this call 1341 * @status: status of this frame; the status pointer need not be valid 1342 * after this function returns and is not freed by mac80211, 1343 * it is recommended that it points to a stack area 1344 */ 1345void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, 1346 struct sk_buff *skb, 1347 struct ieee80211_rx_status *status); 1348 1349/** 1350 * ieee80211_tx_status - transmit status callback 1351 * 1352 * Call this function for all transmitted frames after they have been 1353 * transmitted. It is permissible to not call this function for 1354 * multicast frames but this can affect statistics. 1355 * 1356 * @hw: the hardware the frame was transmitted by 1357 * @skb: the frame that was transmitted, owned by mac80211 after this call 1358 * @status: status information for this frame; the status pointer need not 1359 * be valid after this function returns and is not freed by mac80211, 1360 * it is recommended that it points to a stack area 1361 */ 1362void ieee80211_tx_status(struct ieee80211_hw *hw, 1363 struct sk_buff *skb, 1364 struct ieee80211_tx_status *status); 1365void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 1366 struct sk_buff *skb, 1367 struct ieee80211_tx_status *status); 1368 1369/** 1370 * ieee80211_beacon_get - beacon generation function 1371 * @hw: pointer obtained from ieee80211_alloc_hw(). 1372 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1373 * @control: will be filled with information needed to send this beacon. 1374 * 1375 * If the beacon frames are generated by the host system (i.e., not in 1376 * hardware/firmware), the low-level driver uses this function to receive 1377 * the next beacon frame from the 802.11 code. The low-level is responsible 1378 * for calling this function before beacon data is needed (e.g., based on 1379 * hardware interrupt). Returned skb is used only once and low-level driver 1380 * is responsible of freeing it. 1381 */ 1382struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 1383 struct ieee80211_vif *vif, 1384 struct ieee80211_tx_control *control); 1385 1386/** 1387 * ieee80211_rts_get - RTS frame generation function 1388 * @hw: pointer obtained from ieee80211_alloc_hw(). 1389 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1390 * @frame: pointer to the frame that is going to be protected by the RTS. 1391 * @frame_len: the frame length (in octets). 1392 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1393 * @rts: The buffer where to store the RTS frame. 1394 * 1395 * If the RTS frames are generated by the host system (i.e., not in 1396 * hardware/firmware), the low-level driver uses this function to receive 1397 * the next RTS frame from the 802.11 code. The low-level is responsible 1398 * for calling this function before and RTS frame is needed. 1399 */ 1400void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1401 const void *frame, size_t frame_len, 1402 const struct ieee80211_tx_control *frame_txctl, 1403 struct ieee80211_rts *rts); 1404 1405/** 1406 * ieee80211_rts_duration - Get the duration field for an RTS frame 1407 * @hw: pointer obtained from ieee80211_alloc_hw(). 1408 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1409 * @frame_len: the length of the frame that is going to be protected by the RTS. 1410 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1411 * 1412 * If the RTS is generated in firmware, but the host system must provide 1413 * the duration field, the low-level driver uses this function to receive 1414 * the duration field value in little-endian byteorder. 1415 */ 1416__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, 1417 struct ieee80211_vif *vif, size_t frame_len, 1418 const struct ieee80211_tx_control *frame_txctl); 1419 1420/** 1421 * ieee80211_ctstoself_get - CTS-to-self frame generation function 1422 * @hw: pointer obtained from ieee80211_alloc_hw(). 1423 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1424 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 1425 * @frame_len: the frame length (in octets). 1426 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1427 * @cts: The buffer where to store the CTS-to-self frame. 1428 * 1429 * If the CTS-to-self frames are generated by the host system (i.e., not in 1430 * hardware/firmware), the low-level driver uses this function to receive 1431 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 1432 * for calling this function before and CTS-to-self frame is needed. 1433 */ 1434void ieee80211_ctstoself_get(struct ieee80211_hw *hw, 1435 struct ieee80211_vif *vif, 1436 const void *frame, size_t frame_len, 1437 const struct ieee80211_tx_control *frame_txctl, 1438 struct ieee80211_cts *cts); 1439 1440/** 1441 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 1442 * @hw: pointer obtained from ieee80211_alloc_hw(). 1443 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1444 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 1445 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1446 * 1447 * If the CTS-to-self is generated in firmware, but the host system must provide 1448 * the duration field, the low-level driver uses this function to receive 1449 * the duration field value in little-endian byteorder. 1450 */ 1451__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, 1452 struct ieee80211_vif *vif, 1453 size_t frame_len, 1454 const struct ieee80211_tx_control *frame_txctl); 1455 1456/** 1457 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 1458 * @hw: pointer obtained from ieee80211_alloc_hw(). 1459 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1460 * @frame_len: the length of the frame. 1461 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted. 1462 * 1463 * Calculate the duration field of some generic frame, given its 1464 * length and transmission rate (in 100kbps). 1465 */ 1466__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, 1467 struct ieee80211_vif *vif, 1468 size_t frame_len, 1469 int rate); 1470 1471/** 1472 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 1473 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1474 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. 1475 * @control: will be filled with information needed to send returned frame. 1476 * 1477 * Function for accessing buffered broadcast and multicast frames. If 1478 * hardware/firmware does not implement buffering of broadcast/multicast 1479 * frames when power saving is used, 802.11 code buffers them in the host 1480 * memory. The low-level driver uses this function to fetch next buffered 1481 * frame. In most cases, this is used when generating beacon frame. This 1482 * function returns a pointer to the next buffered skb or NULL if no more 1483 * buffered frames are available. 1484 * 1485 * Note: buffered frames are returned only after DTIM beacon frame was 1486 * generated with ieee80211_beacon_get() and the low-level driver must thus 1487 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 1488 * NULL if the previous generated beacon was not DTIM, so the low-level driver 1489 * does not need to check for DTIM beacons separately and should be able to 1490 * use common code for all beacons. 1491 */ 1492struct sk_buff * 1493ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 1494 struct ieee80211_tx_control *control); 1495 1496/** 1497 * ieee80211_get_hdrlen_from_skb - get header length from data 1498 * 1499 * Given an skb with a raw 802.11 header at the data pointer this function 1500 * returns the 802.11 header length in bytes (not including encryption 1501 * headers). If the data in the sk_buff is too short to contain a valid 802.11 1502 * header the function returns 0. 1503 * 1504 * @skb: the frame 1505 */ 1506int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); 1507 1508/** 1509 * ieee80211_get_hdrlen - get header length from frame control 1510 * 1511 * This function returns the 802.11 header length in bytes (not including 1512 * encryption headers.) 1513 * 1514 * @fc: the frame control field (in CPU endianness) 1515 */ 1516int ieee80211_get_hdrlen(u16 fc); 1517 1518/** 1519 * ieee80211_wake_queue - wake specific queue 1520 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1521 * @queue: queue number (counted from zero). 1522 * 1523 * Drivers should use this function instead of netif_wake_queue. 1524 */ 1525void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 1526 1527/** 1528 * ieee80211_stop_queue - stop specific queue 1529 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1530 * @queue: queue number (counted from zero). 1531 * 1532 * Drivers should use this function instead of netif_stop_queue. 1533 */ 1534void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 1535 1536/** 1537 * ieee80211_start_queues - start all queues 1538 * @hw: pointer to as obtained from ieee80211_alloc_hw(). 1539 * 1540 * Drivers should use this function instead of netif_start_queue. 1541 */ 1542void ieee80211_start_queues(struct ieee80211_hw *hw); 1543 1544/** 1545 * ieee80211_stop_queues - stop all queues 1546 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1547 * 1548 * Drivers should use this function instead of netif_stop_queue. 1549 */ 1550void ieee80211_stop_queues(struct ieee80211_hw *hw); 1551 1552/** 1553 * ieee80211_wake_queues - wake all queues 1554 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1555 * 1556 * Drivers should use this function instead of netif_wake_queue. 1557 */ 1558void ieee80211_wake_queues(struct ieee80211_hw *hw); 1559 1560/** 1561 * ieee80211_scan_completed - completed hardware scan 1562 * 1563 * When hardware scan offload is used (i.e. the hw_scan() callback is 1564 * assigned) this function needs to be called by the driver to notify 1565 * mac80211 that the scan finished. 1566 * 1567 * @hw: the hardware that finished the scan 1568 */ 1569void ieee80211_scan_completed(struct ieee80211_hw *hw); 1570 1571/** 1572 * ieee80211_iterate_active_interfaces - iterate active interfaces 1573 * 1574 * This function iterates over the interfaces associated with a given 1575 * hardware that are currently active and calls the callback for them. 1576 * 1577 * @hw: the hardware struct of which the interfaces should be iterated over 1578 * @iterator: the iterator function to call, cannot sleep 1579 * @data: first argument of the iterator function 1580 */ 1581void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, 1582 void (*iterator)(void *data, u8 *mac, 1583 struct ieee80211_vif *vif), 1584 void *data); 1585 1586/** 1587 * ieee80211_start_tx_ba_session - Start a tx Block Ack session. 1588 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1589 * @ra: receiver address of the BA session recipient 1590 * @tid: the TID to BA on. 1591 * @return: success if addBA request was sent, failure otherwise 1592 * 1593 * Although mac80211/low level driver/user space application can estimate 1594 * the need to start aggregation on a certain RA/TID, the session level 1595 * will be managed by the mac80211. 1596 */ 1597int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid); 1598 1599/** 1600 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate. 1601 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1602 * @ra: receiver address of the BA session recipient. 1603 * @tid: the TID to BA on. 1604 * 1605 * This function must be called by low level driver once it has 1606 * finished with preparations for the BA session. 1607 */ 1608void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid); 1609 1610/** 1611 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate. 1612 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1613 * @ra: receiver address of the BA session recipient. 1614 * @tid: the TID to BA on. 1615 * 1616 * This function must be called by low level driver once it has 1617 * finished with preparations for the BA session. 1618 * This version of the function is irq safe. 1619 */ 1620void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra, 1621 u16 tid); 1622 1623/** 1624 * ieee80211_stop_tx_ba_session - Stop a Block Ack session. 1625 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1626 * @ra: receiver address of the BA session recipient 1627 * @tid: the TID to stop BA. 1628 * @initiator: if indicates initiator DELBA frame will be sent. 1629 * @return: error if no sta with matching da found, success otherwise 1630 * 1631 * Although mac80211/low level driver/user space application can estimate 1632 * the need to stop aggregation on a certain RA/TID, the session level 1633 * will be managed by the mac80211. 1634 */ 1635int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw, 1636 u8 *ra, u16 tid, 1637 enum ieee80211_back_parties initiator); 1638 1639/** 1640 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate. 1641 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1642 * @ra: receiver address of the BA session recipient. 1643 * @tid: the desired TID to BA on. 1644 * 1645 * This function must be called by low level driver once it has 1646 * finished with preparations for the BA session tear down. 1647 */ 1648void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid); 1649 1650/** 1651 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate. 1652 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1653 * @ra: receiver address of the BA session recipient. 1654 * @tid: the desired TID to BA on. 1655 * 1656 * This function must be called by low level driver once it has 1657 * finished with preparations for the BA session tear down. 1658 * This version of the function is irq safe. 1659 */ 1660void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra, 1661 u16 tid); 1662 1663#endif /* MAC80211_H */ 1664