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