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