mac80211.h revision d3c990fb26b78f60614885d9ecaf7b7686b7b098
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 */ 250enum ieee80211_tx_queue { 251 IEEE80211_TX_QUEUE_DATA0, 252 IEEE80211_TX_QUEUE_DATA1, 253 IEEE80211_TX_QUEUE_DATA2, 254 IEEE80211_TX_QUEUE_DATA3, 255 IEEE80211_TX_QUEUE_DATA4, 256 IEEE80211_TX_QUEUE_SVP, 257 258 NUM_TX_DATA_QUEUES, 259 260/* due to stupidity in the sub-ioctl userspace interface, the items in 261 * this struct need to have fixed values. As soon as it is removed, we can 262 * fix these entries. */ 263 IEEE80211_TX_QUEUE_AFTER_BEACON = 6, 264 IEEE80211_TX_QUEUE_BEACON = 7 265}; 266 267struct ieee80211_tx_queue_stats { 268 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES]; 269}; 270 271struct ieee80211_low_level_stats { 272 unsigned int dot11ACKFailureCount; 273 unsigned int dot11RTSFailureCount; 274 unsigned int dot11FCSErrorCount; 275 unsigned int dot11RTSSuccessCount; 276}; 277 278/* Transmit control fields. This data structure is passed to low-level driver 279 * with each TX frame. The low-level driver is responsible for configuring 280 * the hardware to use given values (depending on what is supported). */ 281 282struct ieee80211_tx_control { 283 int tx_rate; /* Transmit rate, given as the hw specific value for the 284 * rate (from struct ieee80211_rate) */ 285 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw 286 * specific value for the rate (from 287 * struct ieee80211_rate) */ 288 289#define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for 290 * this frame */ 291#define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without 292 * encryption; e.g., for EAPOL 293 * frames */ 294#define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending 295 * frame */ 296#define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the 297 * frame (e.g., for combined 298 * 802.11g / 802.11b networks) */ 299#define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to 300 * wait for an ack */ 301#define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5) 302#define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6) 303#define IEEE80211_TXCTL_REQUEUE (1<<7) 304#define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of 305 * the frame */ 306#define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send 307 * using the through 308 * set_retry_limit configured 309 * long retry value */ 310 u32 flags; /* tx control flags defined 311 * above */ 312 u8 key_idx; /* keyidx from hw->set_key(), undefined if 313 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */ 314 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, .. 315 * This could be used when set_retry_limit 316 * is not implemented by the driver */ 317 u8 power_level; /* per-packet transmit power level, in dBm */ 318 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */ 319 u8 icv_len; /* length of the ICV/MIC field in octets */ 320 u8 iv_len; /* length of the IV field in octets */ 321 u8 queue; /* hardware queue to use for this frame; 322 * 0 = highest, hw->queues-1 = lowest */ 323 struct ieee80211_rate *rate; /* internal 80211.o rate */ 324 struct ieee80211_rate *rts_rate; /* internal 80211.o rate 325 * for RTS/CTS */ 326 int alt_retry_rate; /* retry rate for the last retries, given as the 327 * hw specific value for the rate (from 328 * struct ieee80211_rate). To be used to limit 329 * packet dropping when probing higher rates, if hw 330 * supports multiple retry rates. -1 = not used */ 331 int type; /* internal */ 332 int ifindex; /* internal */ 333}; 334 335 336/** 337 * enum mac80211_rx_flags - receive flags 338 * 339 * These flags are used with the @flag member of &struct ieee80211_rx_status. 340 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. 341 * Use together with %RX_FLAG_MMIC_STRIPPED. 342 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. 343 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header. 344 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, 345 * verification has been done by the hardware. 346 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame. 347 * If this flag is set, the stack cannot do any replay detection 348 * hence the driver or hardware will have to do that. 349 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on 350 * the frame. 351 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on 352 * the frame. 353 */ 354enum mac80211_rx_flags { 355 RX_FLAG_MMIC_ERROR = 1<<0, 356 RX_FLAG_DECRYPTED = 1<<1, 357 RX_FLAG_RADIOTAP = 1<<2, 358 RX_FLAG_MMIC_STRIPPED = 1<<3, 359 RX_FLAG_IV_STRIPPED = 1<<4, 360 RX_FLAG_FAILED_FCS_CRC = 1<<5, 361 RX_FLAG_FAILED_PLCP_CRC = 1<<6, 362}; 363 364/** 365 * struct ieee80211_rx_status - receive status 366 * 367 * The low-level driver should provide this information (the subset 368 * supported by hardware) to the 802.11 code with each received 369 * frame. 370 * @mactime: MAC timestamp as defined by 802.11 371 * @freq: frequency the radio was tuned to when receiving this frame, in MHz 372 * @channel: channel the radio was tuned to 373 * @phymode: active PHY mode 374 * @ssi: signal strength when receiving this frame 375 * @signal: used as 'qual' in statistics reporting 376 * @noise: PHY noise when receiving this frame 377 * @antenna: antenna used 378 * @rate: data rate 379 * @flag: %RX_FLAG_* 380 */ 381struct ieee80211_rx_status { 382 u64 mactime; 383 int freq; 384 int channel; 385 enum ieee80211_phymode phymode; 386 int ssi; 387 int signal; 388 int noise; 389 int antenna; 390 int rate; 391 int flag; 392}; 393 394/** 395 * enum ieee80211_tx_status_flags - transmit status flags 396 * 397 * Status flags to indicate various transmit conditions. 398 * 399 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted 400 * because the destination STA was in powersave mode. 401 * 402 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged 403 */ 404enum ieee80211_tx_status_flags { 405 IEEE80211_TX_STATUS_TX_FILTERED = 1<<0, 406 IEEE80211_TX_STATUS_ACK = 1<<1, 407}; 408 409/** 410 * struct ieee80211_tx_status - transmit status 411 * 412 * As much information as possible should be provided for each transmitted 413 * frame with ieee80211_tx_status(). 414 * 415 * @control: a copy of the &struct ieee80211_tx_control passed to the driver 416 * in the tx() callback. 417 * 418 * @flags: transmit status flags, defined above 419 * 420 * @ack_signal: signal strength of the ACK frame 421 * 422 * @excessive_retries: set to 1 if the frame was retried many times 423 * but not acknowledged 424 * 425 * @retry_count: number of retries 426 * 427 * @queue_length: ?? REMOVE 428 * @queue_number: ?? REMOVE 429 */ 430struct ieee80211_tx_status { 431 struct ieee80211_tx_control control; 432 u8 flags; 433 bool excessive_retries; 434 u8 retry_count; 435 int ack_signal; 436 int queue_length; 437 int queue_number; 438}; 439 440/** 441 * enum ieee80211_conf_flags - configuration flags 442 * 443 * Flags to define PHY configuration options 444 * 445 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time 446 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported) 447 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported) 448 */ 449enum ieee80211_conf_flags { 450 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0), 451 IEEE80211_CONF_RADIOTAP = (1<<1), 452 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2), 453}; 454 455/** 456 * struct ieee80211_conf - configuration of the device 457 * 458 * This struct indicates how the driver shall configure the hardware. 459 * 460 * @radio_enabled: when zero, driver is required to switch off the radio. 461 * TODO make a flag 462 * @channel: IEEE 802.11 channel number 463 * @freq: frequency in MHz 464 * @channel_val: hardware specific channel value for the channel 465 * @phymode: PHY mode to activate (REMOVE) 466 * @chan: channel to switch to, pointer to the channel information 467 * @mode: pointer to mode definition 468 * @regulatory_domain: ?? 469 * @beacon_int: beacon interval (TODO make interface config) 470 * @flags: configuration flags defined above 471 * @power_level: transmit power limit for current regulatory domain in dBm 472 * @antenna_max: maximum antenna gain 473 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity, 474 * 1/2: antenna 0/1 475 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx 476 * @ht_conf: describes current self configuration of 802.11n HT capabilies 477 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters 478 */ 479struct ieee80211_conf { 480 int channel; /* IEEE 802.11 channel number */ 481 int freq; /* MHz */ 482 int channel_val; /* hw specific value for the channel */ 483 484 enum ieee80211_phymode phymode; 485 struct ieee80211_channel *chan; 486 struct ieee80211_hw_mode *mode; 487 unsigned int regulatory_domain; 488 int radio_enabled; 489 490 int beacon_int; 491 u32 flags; 492 u8 power_level; 493 u8 antenna_max; 494 u8 antenna_sel_tx; 495 u8 antenna_sel_rx; 496 497 struct ieee80211_ht_info ht_conf; 498 struct ieee80211_ht_bss_info ht_bss_conf; 499}; 500 501/** 502 * enum ieee80211_if_types - types of 802.11 network interfaces 503 * 504 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used 505 * by mac80211 itself 506 * @IEEE80211_IF_TYPE_AP: interface in AP mode. 507 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap 508 * daemon. Drivers should never see this type. 509 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode. 510 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode. 511 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode. 512 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode. 513 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers 514 * will never see this type. 515 */ 516enum ieee80211_if_types { 517 IEEE80211_IF_TYPE_INVALID, 518 IEEE80211_IF_TYPE_AP, 519 IEEE80211_IF_TYPE_STA, 520 IEEE80211_IF_TYPE_IBSS, 521 IEEE80211_IF_TYPE_MNTR, 522 IEEE80211_IF_TYPE_WDS, 523 IEEE80211_IF_TYPE_VLAN, 524}; 525 526/** 527 * struct ieee80211_if_init_conf - initial configuration of an interface 528 * 529 * @if_id: internal interface ID. This number has no particular meaning to 530 * drivers and the only allowed usage is to pass it to 531 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions. 532 * This field is not valid for monitor interfaces 533 * (interfaces of %IEEE80211_IF_TYPE_MNTR type). 534 * @type: one of &enum ieee80211_if_types constants. Determines the type of 535 * added/removed interface. 536 * @mac_addr: pointer to MAC address of the interface. This pointer is valid 537 * until the interface is removed (i.e. it cannot be used after 538 * remove_interface() callback was called for this interface). 539 * 540 * This structure is used in add_interface() and remove_interface() 541 * callbacks of &struct ieee80211_hw. 542 * 543 * When you allow multiple interfaces to be added to your PHY, take care 544 * that the hardware can actually handle multiple MAC addresses. However, 545 * also take care that when there's no interface left with mac_addr != %NULL 546 * you remove the MAC address from the device to avoid acknowledging packets 547 * in pure monitor mode. 548 */ 549struct ieee80211_if_init_conf { 550 int if_id; 551 enum ieee80211_if_types type; 552 void *mac_addr; 553}; 554 555/** 556 * struct ieee80211_if_conf - configuration of an interface 557 * 558 * @type: type of the interface. This is always the same as was specified in 559 * &struct ieee80211_if_init_conf. The type of an interface never changes 560 * during the life of the interface; this field is present only for 561 * convenience. 562 * @bssid: BSSID of the network we are associated to/creating. 563 * @ssid: used (together with @ssid_len) by drivers for hardware that 564 * generate beacons independently. The pointer is valid only during the 565 * config_interface() call, so copy the value somewhere if you need 566 * it. 567 * @ssid_len: length of the @ssid field. 568 * @beacon: beacon template. Valid only if @host_gen_beacon_template in 569 * &struct ieee80211_hw is set. The driver is responsible of freeing 570 * the sk_buff. 571 * @beacon_control: tx_control for the beacon template, this field is only 572 * valid when the @beacon field was set. 573 * 574 * This structure is passed to the config_interface() callback of 575 * &struct ieee80211_hw. 576 */ 577struct ieee80211_if_conf { 578 int type; 579 u8 *bssid; 580 u8 *ssid; 581 size_t ssid_len; 582 struct sk_buff *beacon; 583 struct ieee80211_tx_control *beacon_control; 584}; 585 586/** 587 * enum ieee80211_key_alg - key algorithm 588 * @ALG_WEP: WEP40 or WEP104 589 * @ALG_TKIP: TKIP 590 * @ALG_CCMP: CCMP (AES) 591 */ 592enum ieee80211_key_alg { 593 ALG_WEP, 594 ALG_TKIP, 595 ALG_CCMP, 596}; 597 598 599/** 600 * enum ieee80211_key_flags - key flags 601 * 602 * These flags are used for communication about keys between the driver 603 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. 604 * 605 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates 606 * that the STA this key will be used with could be using QoS. 607 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the 608 * driver to indicate that it requires IV generation for this 609 * particular key. 610 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by 611 * the driver for a TKIP key if it requires Michael MIC 612 * generation in software. 613 */ 614enum ieee80211_key_flags { 615 IEEE80211_KEY_FLAG_WMM_STA = 1<<0, 616 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1, 617 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2, 618}; 619 620/** 621 * struct ieee80211_key_conf - key information 622 * 623 * This key information is given by mac80211 to the driver by 624 * the set_key() callback in &struct ieee80211_ops. 625 * 626 * @hw_key_idx: To be set by the driver, this is the key index the driver 627 * wants to be given when a frame is transmitted and needs to be 628 * encrypted in hardware. 629 * @alg: The key algorithm. 630 * @flags: key flags, see &enum ieee80211_key_flags. 631 * @keyidx: the key index (0-3) 632 * @keylen: key material length 633 * @key: key material 634 */ 635struct ieee80211_key_conf { 636 enum ieee80211_key_alg alg; 637 u8 hw_key_idx; 638 u8 flags; 639 s8 keyidx; 640 u8 keylen; 641 u8 key[0]; 642}; 643 644#define IEEE80211_SEQ_COUNTER_RX 0 645#define IEEE80211_SEQ_COUNTER_TX 1 646 647/** 648 * enum set_key_cmd - key command 649 * 650 * Used with the set_key() callback in &struct ieee80211_ops, this 651 * indicates whether a key is being removed or added. 652 * 653 * @SET_KEY: a key is set 654 * @DISABLE_KEY: a key must be disabled 655 */ 656enum set_key_cmd { 657 SET_KEY, DISABLE_KEY, 658}; 659 660/** 661 * enum sta_notify_cmd - sta notify command 662 * 663 * Used with the sta_notify() callback in &struct ieee80211_ops, this 664 * indicates addition and removal of a station to station table 665 * 666 * @STA_NOTIFY_ADD: a station was added to the station table 667 * @STA_NOTIFY_REMOVE: a station being removed from the station table 668 */ 669enum sta_notify_cmd { 670 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE 671}; 672 673/** 674 * enum ieee80211_hw_flags - hardware flags 675 * 676 * These flags are used to indicate hardware capabilities to 677 * the stack. Generally, flags here should have their meaning 678 * done in a way that the simplest hardware doesn't need setting 679 * any particular flags. There are some exceptions to this rule, 680 * however, so you are advised to review these flags carefully. 681 * 682 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE: 683 * The device only needs to be supplied with a beacon template. 684 * If you need the host to generate each beacon then don't use 685 * this flag and call ieee80211_beacon_get() when you need the 686 * next beacon frame. Note that if you set this flag, you must 687 * implement the set_tim() callback for powersave mode to work 688 * properly. 689 * This flag is only relevant for access-point mode. 690 * 691 * @IEEE80211_HW_RX_INCLUDES_FCS: 692 * Indicates that received frames passed to the stack include 693 * the FCS at the end. 694 * 695 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 696 * Some wireless LAN chipsets buffer broadcast/multicast frames 697 * for power saving stations in the hardware/firmware and others 698 * rely on the host system for such buffering. This option is used 699 * to configure the IEEE 802.11 upper layer to buffer broadcast and 700 * multicast frames when there are power saving stations so that 701 * the driver can fetch them with ieee80211_get_buffered_bc(). Note 702 * that not setting this flag works properly only when the 703 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because 704 * otherwise the stack will not know when the DTIM beacon was sent. 705 * 706 * @IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED: 707 * Channels are already configured to the default regulatory domain 708 * specified in the device's EEPROM 709 */ 710enum ieee80211_hw_flags { 711 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0, 712 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, 713 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, 714 IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED = 1<<3, 715}; 716 717/** 718 * struct ieee80211_hw - hardware information and state 719 * 720 * This structure contains the configuration and hardware 721 * information for an 802.11 PHY. 722 * 723 * @wiphy: This points to the &struct wiphy allocated for this 724 * 802.11 PHY. You must fill in the @perm_addr and @dev 725 * members of this structure using SET_IEEE80211_DEV() 726 * and SET_IEEE80211_PERM_ADDR(). 727 * 728 * @conf: &struct ieee80211_conf, device configuration, don't use. 729 * 730 * @workqueue: single threaded workqueue available for driver use, 731 * allocated by mac80211 on registration and flushed on 732 * unregistration. 733 * 734 * @priv: pointer to private area that was allocated for driver use 735 * along with this structure. 736 * 737 * @flags: hardware flags, see &enum ieee80211_hw_flags. 738 * 739 * @extra_tx_headroom: headroom to reserve in each transmit skb 740 * for use by the driver (e.g. for transmit headers.) 741 * 742 * @channel_change_time: time (in microseconds) it takes to change channels. 743 * 744 * @max_rssi: Maximum value for ssi in RX information, use 745 * negative numbers for dBm and 0 to indicate no support. 746 * 747 * @max_signal: like @max_rssi, but for the signal value. 748 * 749 * @max_noise: like @max_rssi, but for the noise value. 750 * 751 * @queues: number of available hardware transmit queues for 752 * data packets. WMM/QoS requires at least four. 753 * 754 * @rate_control_algorithm: rate control algorithm for this hardware. 755 * If unset (NULL), the default algorithm will be used. Must be 756 * set before calling ieee80211_register_hw(). 757 */ 758struct ieee80211_hw { 759 struct ieee80211_conf conf; 760 struct wiphy *wiphy; 761 struct workqueue_struct *workqueue; 762 const char *rate_control_algorithm; 763 void *priv; 764 u32 flags; 765 unsigned int extra_tx_headroom; 766 int channel_change_time; 767 u8 queues; 768 s8 max_rssi; 769 s8 max_signal; 770 s8 max_noise; 771}; 772 773/** 774 * SET_IEEE80211_DEV - set device for 802.11 hardware 775 * 776 * @hw: the &struct ieee80211_hw to set the device for 777 * @dev: the &struct device of this 802.11 device 778 */ 779static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 780{ 781 set_wiphy_dev(hw->wiphy, dev); 782} 783 784/** 785 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware 786 * 787 * @hw: the &struct ieee80211_hw to set the MAC address for 788 * @addr: the address to set 789 */ 790static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 791{ 792 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 793} 794 795/** 796 * DOC: Hardware crypto acceleration 797 * 798 * mac80211 is capable of taking advantage of many hardware 799 * acceleration designs for encryption and decryption operations. 800 * 801 * The set_key() callback in the &struct ieee80211_ops for a given 802 * device is called to enable hardware acceleration of encryption and 803 * decryption. The callback takes an @address parameter that will be 804 * the broadcast address for default keys, the other station's hardware 805 * address for individual keys or the zero address for keys that will 806 * be used only for transmission. 807 * Multiple transmission keys with the same key index may be used when 808 * VLANs are configured for an access point. 809 * 810 * The @local_address parameter will always be set to our own address, 811 * this is only relevant if you support multiple local addresses. 812 * 813 * When transmitting, the TX control data will use the @hw_key_idx 814 * selected by the driver by modifying the &struct ieee80211_key_conf 815 * pointed to by the @key parameter to the set_key() function. 816 * 817 * The set_key() call for the %SET_KEY command should return 0 if 818 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 819 * added; if you return 0 then hw_key_idx must be assigned to the 820 * hardware key index, you are free to use the full u8 range. 821 * 822 * When the cmd is %DISABLE_KEY then it must succeed. 823 * 824 * Note that it is permissible to not decrypt a frame even if a key 825 * for it has been uploaded to hardware, the stack will not make any 826 * decision based on whether a key has been uploaded or not but rather 827 * based on the receive flags. 828 * 829 * The &struct ieee80211_key_conf structure pointed to by the @key 830 * parameter is guaranteed to be valid until another call to set_key() 831 * removes it, but it can only be used as a cookie to differentiate 832 * keys. 833 */ 834 835/** 836 * DOC: Frame filtering 837 * 838 * mac80211 requires to see many management frames for proper 839 * operation, and users may want to see many more frames when 840 * in monitor mode. However, for best CPU usage and power consumption, 841 * having as few frames as possible percolate through the stack is 842 * desirable. Hence, the hardware should filter as much as possible. 843 * 844 * To achieve this, mac80211 uses filter flags (see below) to tell 845 * the driver's configure_filter() function which frames should be 846 * passed to mac80211 and which should be filtered out. 847 * 848 * The configure_filter() callback is invoked with the parameters 849 * @mc_count and @mc_list for the combined multicast address list 850 * of all virtual interfaces, @changed_flags telling which flags 851 * were changed and @total_flags with the new flag states. 852 * 853 * If your device has no multicast address filters your driver will 854 * need to check both the %FIF_ALLMULTI flag and the @mc_count 855 * parameter to see whether multicast frames should be accepted 856 * or dropped. 857 * 858 * All unsupported flags in @total_flags must be cleared, i.e. you 859 * should clear all bits except those you honoured. 860 */ 861 862/** 863 * enum ieee80211_filter_flags - hardware filter flags 864 * 865 * These flags determine what the filter in hardware should be 866 * programmed to let through and what should not be passed to the 867 * stack. It is always safe to pass more frames than requested, 868 * but this has negative impact on power consumption. 869 * 870 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, 871 * think of the BSS as your network segment and then this corresponds 872 * to the regular ethernet device promiscuous mode. 873 * 874 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 875 * by the user or if the hardware is not capable of filtering by 876 * multicast address. 877 * 878 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 879 * %RX_FLAG_FAILED_FCS_CRC for them) 880 * 881 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 882 * the %RX_FLAG_FAILED_PLCP_CRC for them 883 * 884 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 885 * to the hardware that it should not filter beacons or probe responses 886 * by BSSID. Filtering them can greatly reduce the amount of processing 887 * mac80211 needs to do and the amount of CPU wakeups, so you should 888 * honour this flag if possible. 889 * 890 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then 891 * only those addressed to this station 892 * 893 * @FIF_OTHER_BSS: pass frames destined to other BSSes 894 */ 895enum ieee80211_filter_flags { 896 FIF_PROMISC_IN_BSS = 1<<0, 897 FIF_ALLMULTI = 1<<1, 898 FIF_FCSFAIL = 1<<2, 899 FIF_PLCPFAIL = 1<<3, 900 FIF_BCN_PRBRESP_PROMISC = 1<<4, 901 FIF_CONTROL = 1<<5, 902 FIF_OTHER_BSS = 1<<6, 903}; 904 905/** 906 * enum ieee80211_erp_change_flags - erp change flags 907 * 908 * These flags are used with the erp_ie_changed() callback in 909 * &struct ieee80211_ops to indicate which parameter(s) changed. 910 * @IEEE80211_ERP_CHANGE_PROTECTION: protection changed 911 * @IEEE80211_ERP_CHANGE_PREAMBLE: barker preamble mode changed 912 */ 913enum ieee80211_erp_change_flags { 914 IEEE80211_ERP_CHANGE_PROTECTION = 1<<0, 915 IEEE80211_ERP_CHANGE_PREAMBLE = 1<<1, 916}; 917 918 919/** 920 * struct ieee80211_ops - callbacks from mac80211 to the driver 921 * 922 * This structure contains various callbacks that the driver may 923 * handle or, in some cases, must handle, for example to configure 924 * the hardware to a new channel or to transmit a frame. 925 * 926 * @tx: Handler that 802.11 module calls for each transmitted frame. 927 * skb contains the buffer starting from the IEEE 802.11 header. 928 * The low-level driver should send the frame out based on 929 * configuration in the TX control data. Must be implemented and 930 * atomic. 931 * 932 * @start: Called before the first netdevice attached to the hardware 933 * is enabled. This should turn on the hardware and must turn on 934 * frame reception (for possibly enabled monitor interfaces.) 935 * Returns negative error codes, these may be seen in userspace, 936 * or zero. 937 * When the device is started it should not have a MAC address 938 * to avoid acknowledging frames before a non-monitor device 939 * is added. 940 * Must be implemented. 941 * 942 * @stop: Called after last netdevice attached to the hardware 943 * is disabled. This should turn off the hardware (at least 944 * it must turn off frame reception.) 945 * May be called right after add_interface if that rejects 946 * an interface. 947 * Must be implemented. 948 * 949 * @add_interface: Called when a netdevice attached to the hardware is 950 * enabled. Because it is not called for monitor mode devices, @open 951 * and @stop must be implemented. 952 * The driver should perform any initialization it needs before 953 * the device can be enabled. The initial configuration for the 954 * interface is given in the conf parameter. 955 * The callback may refuse to add an interface by returning a 956 * negative error code (which will be seen in userspace.) 957 * Must be implemented. 958 * 959 * @remove_interface: Notifies a driver that an interface is going down. 960 * The @stop callback is called after this if it is the last interface 961 * and no monitor interfaces are present. 962 * When all interfaces are removed, the MAC address in the hardware 963 * must be cleared so the device no longer acknowledges packets, 964 * the mac_addr member of the conf structure is, however, set to the 965 * MAC address of the device going away. 966 * Hence, this callback must be implemented. 967 * 968 * @config: Handler for configuration requests. IEEE 802.11 code calls this 969 * function to change hardware configuration, e.g., channel. 970 * 971 * @config_interface: Handler for configuration requests related to interfaces 972 * (e.g. BSSID changes.) 973 * 974 * @configure_filter: Configure the device's RX filter. 975 * See the section "Frame filtering" for more information. 976 * This callback must be implemented and atomic. 977 * 978 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon 979 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set) 980 * mac80211 calls this function when a TIM bit must be set or cleared 981 * for a given AID. Must be atomic. 982 * 983 * @set_key: See the section "Hardware crypto acceleration" 984 * This callback can sleep, and is only called between add_interface 985 * and remove_interface calls, i.e. while the interface with the 986 * given local_address is enabled. 987 * 988 * @hw_scan: Ask the hardware to service the scan request, no need to start 989 * the scan state machine in stack. 990 * 991 * @get_stats: return low-level statistics 992 * 993 * @get_sequence_counter: For devices that have internal sequence counters this 994 * callback allows mac80211 to access the current value of a counter. 995 * This callback seems not well-defined, tell us if you need it. 996 * 997 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 998 * 999 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if 1000 * the device does fragmentation by itself; if this method is assigned then 1001 * the stack will not do fragmentation. 1002 * 1003 * @set_retry_limit: Configuration of retry limits (if device needs it) 1004 * 1005 * @sta_notify: Notifies low level driver about addition or removal 1006 * of assocaited station or AP. 1007 * 1008 * @erp_ie_changed: Handle ERP IE change notifications. Must be atomic. 1009 * 1010 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 1011 * bursting) for a hardware TX queue. The @queue parameter uses the 1012 * %IEEE80211_TX_QUEUE_* constants. Must be atomic. 1013 * 1014 * @get_tx_stats: Get statistics of the current TX queue status. This is used 1015 * to get number of currently queued packets (queue length), maximum queue 1016 * size (limit), and total number of packets sent using each TX queue 1017 * (count). This information is used for WMM to find out which TX 1018 * queues have room for more packets and by hostapd to provide 1019 * statistics about the current queueing state to external programs. 1020 * 1021 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 1022 * this is only used for IBSS mode debugging and, as such, is not a 1023 * required function. Must be atomic. 1024 * 1025 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 1026 * with other STAs in the IBSS. This is only used in IBSS mode. This 1027 * function is optional if the firmware/hardware takes full care of 1028 * TSF synchronization. 1029 * 1030 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point, 1031 * IBSS uses a fixed beacon frame which is configured using this 1032 * function. 1033 * If the driver returns success (0) from this callback, it owns 1034 * the skb. That means the driver is responsible to kfree_skb() it. 1035 * The control structure is not dynamically allocated. That means the 1036 * driver does not own the pointer and if it needs it somewhere 1037 * outside of the context of this function, it must copy it 1038 * somewhere else. 1039 * This handler is required only for IBSS mode. 1040 * 1041 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 1042 * This is needed only for IBSS mode and the result of this function is 1043 * used to determine whether to reply to Probe Requests. 1044 * 1045 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic. 1046 */ 1047struct ieee80211_ops { 1048 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb, 1049 struct ieee80211_tx_control *control); 1050 int (*start)(struct ieee80211_hw *hw); 1051 void (*stop)(struct ieee80211_hw *hw); 1052 int (*add_interface)(struct ieee80211_hw *hw, 1053 struct ieee80211_if_init_conf *conf); 1054 void (*remove_interface)(struct ieee80211_hw *hw, 1055 struct ieee80211_if_init_conf *conf); 1056 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf); 1057 int (*config_interface)(struct ieee80211_hw *hw, 1058 int if_id, struct ieee80211_if_conf *conf); 1059 void (*configure_filter)(struct ieee80211_hw *hw, 1060 unsigned int changed_flags, 1061 unsigned int *total_flags, 1062 int mc_count, struct dev_addr_list *mc_list); 1063 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set); 1064 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, 1065 const u8 *local_address, const u8 *address, 1066 struct ieee80211_key_conf *key); 1067 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len); 1068 int (*get_stats)(struct ieee80211_hw *hw, 1069 struct ieee80211_low_level_stats *stats); 1070 int (*get_sequence_counter)(struct ieee80211_hw *hw, 1071 u8* addr, u8 keyidx, u8 txrx, 1072 u32* iv32, u16* iv16); 1073 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 1074 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); 1075 int (*set_retry_limit)(struct ieee80211_hw *hw, 1076 u32 short_retry, u32 long_retr); 1077 void (*sta_notify)(struct ieee80211_hw *hw, int if_id, 1078 enum sta_notify_cmd, const u8 *addr); 1079 void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes, 1080 int cts_protection, int preamble); 1081 int (*conf_tx)(struct ieee80211_hw *hw, int queue, 1082 const struct ieee80211_tx_queue_params *params); 1083 int (*get_tx_stats)(struct ieee80211_hw *hw, 1084 struct ieee80211_tx_queue_stats *stats); 1085 u64 (*get_tsf)(struct ieee80211_hw *hw); 1086 void (*reset_tsf)(struct ieee80211_hw *hw); 1087 int (*beacon_update)(struct ieee80211_hw *hw, 1088 struct sk_buff *skb, 1089 struct ieee80211_tx_control *control); 1090 int (*tx_last_beacon)(struct ieee80211_hw *hw); 1091 int (*conf_ht)(struct ieee80211_hw *hw, struct ieee80211_conf *conf); 1092}; 1093 1094/** 1095 * ieee80211_alloc_hw - Allocate a new hardware device 1096 * 1097 * This must be called once for each hardware device. The returned pointer 1098 * must be used to refer to this device when calling other functions. 1099 * mac80211 allocates a private data area for the driver pointed to by 1100 * @priv in &struct ieee80211_hw, the size of this area is given as 1101 * @priv_data_len. 1102 * 1103 * @priv_data_len: length of private data 1104 * @ops: callbacks for this device 1105 */ 1106struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 1107 const struct ieee80211_ops *ops); 1108 1109/** 1110 * ieee80211_register_hw - Register hardware device 1111 * 1112 * You must call this function before any other functions 1113 * except ieee80211_register_hwmode. 1114 * 1115 * @hw: the device to register as returned by ieee80211_alloc_hw() 1116 */ 1117int ieee80211_register_hw(struct ieee80211_hw *hw); 1118 1119#ifdef CONFIG_MAC80211_LEDS 1120extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 1121extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 1122extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); 1123#endif 1124/** 1125 * ieee80211_get_tx_led_name - get name of TX LED 1126 * 1127 * mac80211 creates a transmit LED trigger for each wireless hardware 1128 * that can be used to drive LEDs if your driver registers a LED device. 1129 * This function returns the name (or %NULL if not configured for LEDs) 1130 * of the trigger so you can automatically link the LED device. 1131 * 1132 * @hw: the hardware to get the LED trigger name for 1133 */ 1134static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 1135{ 1136#ifdef CONFIG_MAC80211_LEDS 1137 return __ieee80211_get_tx_led_name(hw); 1138#else 1139 return NULL; 1140#endif 1141} 1142 1143/** 1144 * ieee80211_get_rx_led_name - get name of RX LED 1145 * 1146 * mac80211 creates a receive LED trigger for each wireless hardware 1147 * that can be used to drive LEDs if your driver registers a LED device. 1148 * This function returns the name (or %NULL if not configured for LEDs) 1149 * of the trigger so you can automatically link the LED device. 1150 * 1151 * @hw: the hardware to get the LED trigger name for 1152 */ 1153static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 1154{ 1155#ifdef CONFIG_MAC80211_LEDS 1156 return __ieee80211_get_rx_led_name(hw); 1157#else 1158 return NULL; 1159#endif 1160} 1161 1162static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) 1163{ 1164#ifdef CONFIG_MAC80211_LEDS 1165 return __ieee80211_get_assoc_led_name(hw); 1166#else 1167 return NULL; 1168#endif 1169} 1170 1171 1172/* Register a new hardware PHYMODE capability to the stack. */ 1173int ieee80211_register_hwmode(struct ieee80211_hw *hw, 1174 struct ieee80211_hw_mode *mode); 1175 1176/** 1177 * ieee80211_unregister_hw - Unregister a hardware device 1178 * 1179 * This function instructs mac80211 to free allocated resources 1180 * and unregister netdevices from the networking subsystem. 1181 * 1182 * @hw: the hardware to unregister 1183 */ 1184void ieee80211_unregister_hw(struct ieee80211_hw *hw); 1185 1186/** 1187 * ieee80211_free_hw - free hardware descriptor 1188 * 1189 * This function frees everything that was allocated, including the 1190 * private data for the driver. You must call ieee80211_unregister_hw() 1191 * before calling this function 1192 * 1193 * @hw: the hardware to free 1194 */ 1195void ieee80211_free_hw(struct ieee80211_hw *hw); 1196 1197/* trick to avoid symbol clashes with the ieee80211 subsystem */ 1198void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1199 struct ieee80211_rx_status *status); 1200 1201/** 1202 * ieee80211_rx - receive frame 1203 * 1204 * Use this function to hand received frames to mac80211. The receive 1205 * buffer in @skb must start with an IEEE 802.11 header or a radiotap 1206 * header if %RX_FLAG_RADIOTAP is set in the @status flags. 1207 * 1208 * This function may not be called in IRQ context. 1209 * 1210 * @hw: the hardware this frame came in on 1211 * @skb: the buffer to receive, owned by mac80211 after this call 1212 * @status: status of this frame; the status pointer need not be valid 1213 * after this function returns 1214 */ 1215static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 1216 struct ieee80211_rx_status *status) 1217{ 1218 __ieee80211_rx(hw, skb, status); 1219} 1220 1221/** 1222 * ieee80211_rx_irqsafe - receive frame 1223 * 1224 * Like ieee80211_rx() but can be called in IRQ context 1225 * (internally defers to a workqueue.) 1226 * 1227 * @hw: the hardware this frame came in on 1228 * @skb: the buffer to receive, owned by mac80211 after this call 1229 * @status: status of this frame; the status pointer need not be valid 1230 * after this function returns and is not freed by mac80211, 1231 * it is recommended that it points to a stack area 1232 */ 1233void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, 1234 struct sk_buff *skb, 1235 struct ieee80211_rx_status *status); 1236 1237/** 1238 * ieee80211_tx_status - transmit status callback 1239 * 1240 * Call this function for all transmitted frames after they have been 1241 * transmitted. It is permissible to not call this function for 1242 * multicast frames but this can affect statistics. 1243 * 1244 * @hw: the hardware the frame was transmitted by 1245 * @skb: the frame that was transmitted, owned by mac80211 after this call 1246 * @status: status information for this frame; the status pointer need not 1247 * be valid after this function returns and is not freed by mac80211, 1248 * it is recommended that it points to a stack area 1249 */ 1250void ieee80211_tx_status(struct ieee80211_hw *hw, 1251 struct sk_buff *skb, 1252 struct ieee80211_tx_status *status); 1253void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 1254 struct sk_buff *skb, 1255 struct ieee80211_tx_status *status); 1256 1257/** 1258 * ieee80211_beacon_get - beacon generation function 1259 * @hw: pointer obtained from ieee80211_alloc_hw(). 1260 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1261 * @control: will be filled with information needed to send this beacon. 1262 * 1263 * If the beacon frames are generated by the host system (i.e., not in 1264 * hardware/firmware), the low-level driver uses this function to receive 1265 * the next beacon frame from the 802.11 code. The low-level is responsible 1266 * for calling this function before beacon data is needed (e.g., based on 1267 * hardware interrupt). Returned skb is used only once and low-level driver 1268 * is responsible of freeing it. 1269 */ 1270struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 1271 int if_id, 1272 struct ieee80211_tx_control *control); 1273 1274/** 1275 * ieee80211_rts_get - RTS frame generation function 1276 * @hw: pointer obtained from ieee80211_alloc_hw(). 1277 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1278 * @frame: pointer to the frame that is going to be protected by the RTS. 1279 * @frame_len: the frame length (in octets). 1280 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1281 * @rts: The buffer where to store the RTS frame. 1282 * 1283 * If the RTS frames are generated by the host system (i.e., not in 1284 * hardware/firmware), the low-level driver uses this function to receive 1285 * the next RTS frame from the 802.11 code. The low-level is responsible 1286 * for calling this function before and RTS frame is needed. 1287 */ 1288void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id, 1289 const void *frame, size_t frame_len, 1290 const struct ieee80211_tx_control *frame_txctl, 1291 struct ieee80211_rts *rts); 1292 1293/** 1294 * ieee80211_rts_duration - Get the duration field for an RTS frame 1295 * @hw: pointer obtained from ieee80211_alloc_hw(). 1296 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1297 * @frame_len: the length of the frame that is going to be protected by the RTS. 1298 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1299 * 1300 * If the RTS is generated in firmware, but the host system must provide 1301 * the duration field, the low-level driver uses this function to receive 1302 * the duration field value in little-endian byteorder. 1303 */ 1304__le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id, 1305 size_t frame_len, 1306 const struct ieee80211_tx_control *frame_txctl); 1307 1308/** 1309 * ieee80211_ctstoself_get - CTS-to-self frame generation function 1310 * @hw: pointer obtained from ieee80211_alloc_hw(). 1311 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1312 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 1313 * @frame_len: the frame length (in octets). 1314 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1315 * @cts: The buffer where to store the CTS-to-self frame. 1316 * 1317 * If the CTS-to-self frames are generated by the host system (i.e., not in 1318 * hardware/firmware), the low-level driver uses this function to receive 1319 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 1320 * for calling this function before and CTS-to-self frame is needed. 1321 */ 1322void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id, 1323 const void *frame, size_t frame_len, 1324 const struct ieee80211_tx_control *frame_txctl, 1325 struct ieee80211_cts *cts); 1326 1327/** 1328 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 1329 * @hw: pointer obtained from ieee80211_alloc_hw(). 1330 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1331 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 1332 * @frame_txctl: &struct ieee80211_tx_control of the frame. 1333 * 1334 * If the CTS-to-self is generated in firmware, but the host system must provide 1335 * the duration field, the low-level driver uses this function to receive 1336 * the duration field value in little-endian byteorder. 1337 */ 1338__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id, 1339 size_t frame_len, 1340 const struct ieee80211_tx_control *frame_txctl); 1341 1342/** 1343 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 1344 * @hw: pointer obtained from ieee80211_alloc_hw(). 1345 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1346 * @frame_len: the length of the frame. 1347 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted. 1348 * 1349 * Calculate the duration field of some generic frame, given its 1350 * length and transmission rate (in 100kbps). 1351 */ 1352__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id, 1353 size_t frame_len, 1354 int rate); 1355 1356/** 1357 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 1358 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1359 * @if_id: interface ID from &struct ieee80211_if_init_conf. 1360 * @control: will be filled with information needed to send returned frame. 1361 * 1362 * Function for accessing buffered broadcast and multicast frames. If 1363 * hardware/firmware does not implement buffering of broadcast/multicast 1364 * frames when power saving is used, 802.11 code buffers them in the host 1365 * memory. The low-level driver uses this function to fetch next buffered 1366 * frame. In most cases, this is used when generating beacon frame. This 1367 * function returns a pointer to the next buffered skb or NULL if no more 1368 * buffered frames are available. 1369 * 1370 * Note: buffered frames are returned only after DTIM beacon frame was 1371 * generated with ieee80211_beacon_get() and the low-level driver must thus 1372 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 1373 * NULL if the previous generated beacon was not DTIM, so the low-level driver 1374 * does not need to check for DTIM beacons separately and should be able to 1375 * use common code for all beacons. 1376 */ 1377struct sk_buff * 1378ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id, 1379 struct ieee80211_tx_control *control); 1380 1381/** 1382 * ieee80211_get_hdrlen_from_skb - get header length from data 1383 * 1384 * Given an skb with a raw 802.11 header at the data pointer this function 1385 * returns the 802.11 header length in bytes (not including encryption 1386 * headers). If the data in the sk_buff is too short to contain a valid 802.11 1387 * header the function returns 0. 1388 * 1389 * @skb: the frame 1390 */ 1391int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); 1392 1393/** 1394 * ieee80211_get_hdrlen - get header length from frame control 1395 * 1396 * This function returns the 802.11 header length in bytes (not including 1397 * encryption headers.) 1398 * 1399 * @fc: the frame control field (in CPU endianness) 1400 */ 1401int ieee80211_get_hdrlen(u16 fc); 1402 1403/** 1404 * ieee80211_wake_queue - wake specific queue 1405 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1406 * @queue: queue number (counted from zero). 1407 * 1408 * Drivers should use this function instead of netif_wake_queue. 1409 */ 1410void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 1411 1412/** 1413 * ieee80211_stop_queue - stop specific queue 1414 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1415 * @queue: queue number (counted from zero). 1416 * 1417 * Drivers should use this function instead of netif_stop_queue. 1418 */ 1419void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 1420 1421/** 1422 * ieee80211_start_queues - start all queues 1423 * @hw: pointer to as obtained from ieee80211_alloc_hw(). 1424 * 1425 * Drivers should use this function instead of netif_start_queue. 1426 */ 1427void ieee80211_start_queues(struct ieee80211_hw *hw); 1428 1429/** 1430 * ieee80211_stop_queues - stop all queues 1431 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1432 * 1433 * Drivers should use this function instead of netif_stop_queue. 1434 */ 1435void ieee80211_stop_queues(struct ieee80211_hw *hw); 1436 1437/** 1438 * ieee80211_wake_queues - wake all queues 1439 * @hw: pointer as obtained from ieee80211_alloc_hw(). 1440 * 1441 * Drivers should use this function instead of netif_wake_queue. 1442 */ 1443void ieee80211_wake_queues(struct ieee80211_hw *hw); 1444 1445/** 1446 * ieee80211_scan_completed - completed hardware scan 1447 * 1448 * When hardware scan offload is used (i.e. the hw_scan() callback is 1449 * assigned) this function needs to be called by the driver to notify 1450 * mac80211 that the scan finished. 1451 * 1452 * @hw: the hardware that finished the scan 1453 */ 1454void ieee80211_scan_completed(struct ieee80211_hw *hw); 1455 1456/** 1457 * ieee80211_iterate_active_interfaces - iterate active interfaces 1458 * 1459 * This function iterates over the interfaces associated with a given 1460 * hardware that are currently active and calls the callback for them. 1461 * 1462 * @hw: the hardware struct of which the interfaces should be iterated over 1463 * @iterator: the iterator function to call, cannot sleep 1464 * @data: first argument of the iterator function 1465 */ 1466void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, 1467 void (*iterator)(void *data, u8 *mac, 1468 int if_id), 1469 void *data); 1470 1471#endif /* MAC80211_H */ 1472