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