1 /* 2 * Low-level hardware driver -- IEEE 802.11 driver (80211.o) interface 3 * Copyright 2002-2005, Devicescape Software, Inc. 4 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz> 5 * 6 * This program is free software; you can redistribute it and/or modify 7 * it under the terms of the GNU General Public License version 2 as 8 * published by the Free Software Foundation. 9 */ 10 11 #ifndef MAC80211_H 12 #define MAC80211_H 13 14 #include <linux/kernel.h> 15 #include <linux/if_ether.h> 16 #include <linux/skbuff.h> 17 #include <linux/wireless.h> 18 #include <linux/device.h> 19 #include <linux/ieee80211.h> 20 #include <net/wireless.h> 21 #include <net/cfg80211.h> 22 23 /* Note! Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be 24 * called in hardware interrupt context. The low-level driver must not call any 25 * other functions in hardware interrupt context. If there is a need for such 26 * call, the low-level driver should first ACK the interrupt and perform the 27 * IEEE 802.11 code call after this, e.g., from a scheduled tasklet (in 28 * software interrupt context). 29 */ 30 31 /* 32 * Frame format used when passing frame between low-level hardware drivers 33 * and IEEE 802.11 driver the same as used in the wireless media, i.e., 34 * buffers start with IEEE 802.11 header and include the same octets that 35 * are sent over air. 36 * 37 * If hardware uses IEEE 802.3 headers (and perform 802.3 <-> 802.11 38 * conversion in firmware), upper layer 802.11 code needs to be changed to 39 * support this. 40 * 41 * If the receive frame format is not the same as the real frame sent 42 * on the wireless media (e.g., due to padding etc.), upper layer 802.11 code 43 * could be updated to provide support for such format assuming this would 44 * optimize the performance, e.g., by removing need to re-allocation and 45 * copying of the data. 46 */ 47 48 #define IEEE80211_CHAN_W_SCAN 0x00000001 49 #define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002 50 #define IEEE80211_CHAN_W_IBSS 0x00000004 51 52 /* Channel information structure. Low-level driver is expected to fill in chan, 53 * freq, and val fields. Other fields will be filled in by 80211.o based on 54 * hostapd information and low-level driver does not need to use them. The 55 * limits for each channel will be provided in 'struct ieee80211_conf' when 56 * configuring the low-level driver with hw->config callback. If a device has 57 * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED 58 * can be set to let the driver configure all fields */ 59 struct ieee80211_channel { 60 short chan; /* channel number (IEEE 802.11) */ 61 short freq; /* frequency in MHz */ 62 int val; /* hw specific value for the channel */ 63 int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */ 64 unsigned char power_level; 65 unsigned char antenna_max; 66 }; 67 68 #define IEEE80211_RATE_ERP 0x00000001 69 #define IEEE80211_RATE_BASIC 0x00000002 70 #define IEEE80211_RATE_PREAMBLE2 0x00000004 71 #define IEEE80211_RATE_SUPPORTED 0x00000010 72 #define IEEE80211_RATE_OFDM 0x00000020 73 #define IEEE80211_RATE_CCK 0x00000040 74 #define IEEE80211_RATE_TURBO 0x00000080 75 #define IEEE80211_RATE_MANDATORY 0x00000100 76 77 #define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2) 78 #define IEEE80211_RATE_MODULATION(f) \ 79 (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM)) 80 81 /* Low-level driver should set PREAMBLE2, OFDM, CCK, and TURBO flags. 82 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the 83 * configuration. */ 84 struct ieee80211_rate { 85 int rate; /* rate in 100 kbps */ 86 int val; /* hw specific value for the rate */ 87 int flags; /* IEEE80211_RATE_ flags */ 88 int val2; /* hw specific value for the rate when using short preamble 89 * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for 90 * 2, 5.5, and 11 Mbps) */ 91 signed char min_rssi_ack; 92 unsigned char min_rssi_ack_delta; 93 94 /* following fields are set by 80211.o and need not be filled by the 95 * low-level driver */ 96 int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for 97 * optimizing channel utilization estimates */ 98 }; 99 100 /* 802.11g is backwards-compatible with 802.11b, so a wlan card can 101 * actually be both in 11b and 11g modes at the same time. */ 102 enum { 103 MODE_IEEE80211A, /* IEEE 802.11a */ 104 MODE_IEEE80211B, /* IEEE 802.11b only */ 105 MODE_ATHEROS_TURBO, /* Atheros Turbo mode (2x.11a at 5 GHz) */ 106 MODE_IEEE80211G, /* IEEE 802.11g (and 802.11b compatibility) */ 107 MODE_ATHEROS_TURBOG, /* Atheros Turbo mode (2x.11g at 2.4 GHz) */ 108 109 /* keep last */ 110 NUM_IEEE80211_MODES 111 }; 112 113 struct ieee80211_hw_mode { 114 int mode; /* MODE_IEEE80211... */ 115 int num_channels; /* Number of channels (below) */ 116 struct ieee80211_channel *channels; /* Array of supported channels */ 117 int num_rates; /* Number of rates (below) */ 118 struct ieee80211_rate *rates; /* Array of supported rates */ 119 120 struct list_head list; /* Internal, don't touch */ 121 }; 122 123 struct ieee80211_tx_queue_params { 124 int aifs; /* 0 .. 255; -1 = use default */ 125 int cw_min; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */ 126 int cw_max; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */ 127 int burst_time; /* maximum burst time in 0.1 ms (i.e., 10 = 1 ms); 128 * 0 = disabled */ 129 }; 130 131 struct ieee80211_tx_queue_stats_data { 132 unsigned int len; /* num packets in queue */ 133 unsigned int limit; /* queue len (soft) limit */ 134 unsigned int count; /* total num frames sent */ 135 }; 136 137 enum { 138 IEEE80211_TX_QUEUE_DATA0, 139 IEEE80211_TX_QUEUE_DATA1, 140 IEEE80211_TX_QUEUE_DATA2, 141 IEEE80211_TX_QUEUE_DATA3, 142 IEEE80211_TX_QUEUE_DATA4, 143 IEEE80211_TX_QUEUE_SVP, 144 145 NUM_TX_DATA_QUEUES, 146 147 /* due to stupidity in the sub-ioctl userspace interface, the items in 148 * this struct need to have fixed values. As soon as it is removed, we can 149 * fix these entries. */ 150 IEEE80211_TX_QUEUE_AFTER_BEACON = 6, 151 IEEE80211_TX_QUEUE_BEACON = 7 152 }; 153 154 struct ieee80211_tx_queue_stats { 155 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES]; 156 }; 157 158 struct ieee80211_low_level_stats { 159 unsigned int dot11ACKFailureCount; 160 unsigned int dot11RTSFailureCount; 161 unsigned int dot11FCSErrorCount; 162 unsigned int dot11RTSSuccessCount; 163 }; 164 165 /* Transmit control fields. This data structure is passed to low-level driver 166 * with each TX frame. The low-level driver is responsible for configuring 167 * the hardware to use given values (depending on what is supported). */ 168 #define HW_KEY_IDX_INVALID -1 169 170 struct ieee80211_tx_control { 171 int tx_rate; /* Transmit rate, given as the hw specific value for the 172 * rate (from struct ieee80211_rate) */ 173 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw 174 * specific value for the rate (from 175 * struct ieee80211_rate) */ 176 177 #define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for 178 * this frame */ 179 #define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without 180 * encryption; e.g., for EAPOL 181 * frames */ 182 #define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending 183 * frame */ 184 #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the 185 * frame (e.g., for combined 186 * 802.11g / 802.11b networks) */ 187 #define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to 188 * wait for an ack */ 189 #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5) 190 #define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6) 191 #define IEEE80211_TXCTL_REQUEUE (1<<7) 192 #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of 193 * the frame */ 194 #define IEEE80211_TXCTL_TKIP_NEW_PHASE1_KEY (1<<9) 195 u32 flags; /* tx control flags defined 196 * above */ 197 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, .. */ 198 u8 power_level; /* per-packet transmit power level, in dBm */ 199 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */ 200 s8 key_idx; /* -1 = do not encrypt, >= 0 keyidx from 201 * hw->set_key() */ 202 u8 icv_len; /* length of the ICV/MIC field in octets */ 203 u8 iv_len; /* length of the IV field in octets */ 204 u8 tkip_key[16]; /* generated phase2/phase1 key for hw TKIP */ 205 u8 queue; /* hardware queue to use for this frame; 206 * 0 = highest, hw->queues-1 = lowest */ 207 u8 sw_retry_attempt; /* number of times hw has tried to 208 * transmit frame (not incl. hw retries) */ 209 210 struct ieee80211_rate *rate; /* internal 80211.o rate */ 211 struct ieee80211_rate *rts_rate; /* internal 80211.o rate 212 * for RTS/CTS */ 213 int alt_retry_rate; /* retry rate for the last retries, given as the 214 * hw specific value for the rate (from 215 * struct ieee80211_rate). To be used to limit 216 * packet dropping when probing higher rates, if hw 217 * supports multiple retry rates. -1 = not used */ 218 int type; /* internal */ 219 int ifindex; /* internal */ 220 }; 221 222 /* Receive status. The low-level driver should provide this information 223 * (the subset supported by hardware) to the 802.11 code with each received 224 * frame. */ 225 struct ieee80211_rx_status { 226 u64 mactime; 227 int freq; /* receive frequency in Mhz */ 228 int channel; 229 int phymode; 230 int ssi; 231 int signal; /* used as qual in statistics reporting */ 232 int noise; 233 int antenna; 234 int rate; 235 #define RX_FLAG_MMIC_ERROR (1<<0) 236 #define RX_FLAG_DECRYPTED (1<<1) 237 #define RX_FLAG_RADIOTAP (1<<2) 238 int flag; 239 }; 240 241 /* Transmit status. The low-level driver should provide this information 242 * (the subset supported by hardware) to the 802.11 code for each transmit 243 * frame. */ 244 struct ieee80211_tx_status { 245 /* copied ieee80211_tx_control structure */ 246 struct ieee80211_tx_control control; 247 248 #define IEEE80211_TX_STATUS_TX_FILTERED (1<<0) 249 #define IEEE80211_TX_STATUS_ACK (1<<1) /* whether the TX frame was ACKed */ 250 u32 flags; /* tx staus flags defined above */ 251 252 int ack_signal; /* measured signal strength of the ACK frame */ 253 int excessive_retries; 254 int retry_count; 255 256 int queue_length; /* information about TX queue */ 257 int queue_number; 258 }; 259 260 261 /** 262 * struct ieee80211_conf - configuration of the device 263 * 264 * This struct indicates how the driver shall configure the hardware. 265 * 266 * @radio_enabled: when zero, driver is required to switch off the radio. 267 */ 268 struct ieee80211_conf { 269 int channel; /* IEEE 802.11 channel number */ 270 int freq; /* MHz */ 271 int channel_val; /* hw specific value for the channel */ 272 273 int phymode; /* MODE_IEEE80211A, .. */ 274 struct ieee80211_channel *chan; 275 struct ieee80211_hw_mode *mode; 276 unsigned int regulatory_domain; 277 int radio_enabled; 278 279 int beacon_int; 280 281 #define IEEE80211_CONF_SHORT_SLOT_TIME (1<<0) /* use IEEE 802.11g Short Slot 282 * Time */ 283 #define IEEE80211_CONF_SSID_HIDDEN (1<<1) /* do not broadcast the ssid */ 284 #define IEEE80211_CONF_RADIOTAP (1<<2) /* use radiotap if supported 285 check this bit at RX time */ 286 u32 flags; /* configuration flags defined above */ 287 288 u8 power_level; /* transmit power limit for current 289 * regulatory domain; in dBm */ 290 u8 antenna_max; /* maximum antenna gain */ 291 short tx_power_reduction; /* in 0.1 dBm */ 292 293 /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */ 294 u8 antenna_sel_tx; 295 u8 antenna_sel_rx; 296 297 int antenna_def; 298 int antenna_mode; 299 300 /* Following five fields are used for IEEE 802.11H */ 301 unsigned int radar_detect; 302 unsigned int spect_mgmt; 303 /* All following fields are currently unused. */ 304 unsigned int quiet_duration; /* duration of quiet period */ 305 unsigned int quiet_offset; /* how far into the beacon is the quiet 306 * period */ 307 unsigned int quiet_period; 308 u8 radar_firpwr_threshold; 309 u8 radar_rssi_threshold; 310 u8 pulse_height_threshold; 311 u8 pulse_rssi_threshold; 312 u8 pulse_inband_threshold; 313 }; 314 315 /** 316 * enum ieee80211_if_types - types of 802.11 network interfaces 317 * 318 * @IEEE80211_IF_TYPE_AP: interface in AP mode. 319 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap 320 * daemon. Drivers should never see this type. 321 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode. 322 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode. 323 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode. 324 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode. 325 * @IEEE80211_IF_TYPE_VLAN: not used. 326 */ 327 enum ieee80211_if_types { 328 IEEE80211_IF_TYPE_AP = 0x00000000, 329 IEEE80211_IF_TYPE_MGMT = 0x00000001, 330 IEEE80211_IF_TYPE_STA = 0x00000002, 331 IEEE80211_IF_TYPE_IBSS = 0x00000003, 332 IEEE80211_IF_TYPE_MNTR = 0x00000004, 333 IEEE80211_IF_TYPE_WDS = 0x5A580211, 334 IEEE80211_IF_TYPE_VLAN = 0x00080211, 335 }; 336 337 /** 338 * struct ieee80211_if_init_conf - initial configuration of an interface 339 * 340 * @if_id: internal interface ID. This number has no particular meaning to 341 * drivers and the only allowed usage is to pass it to 342 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions. 343 * This field is not valid for monitor interfaces 344 * (interfaces of %IEEE80211_IF_TYPE_MNTR type). 345 * @type: one of &enum ieee80211_if_types constants. Determines the type of 346 * added/removed interface. 347 * @mac_addr: pointer to MAC address of the interface. This pointer is valid 348 * until the interface is removed (i.e. it cannot be used after 349 * remove_interface() callback was called for this interface). 350 * This pointer will be %NULL for monitor interfaces, be careful. 351 * 352 * This structure is used in add_interface() and remove_interface() 353 * callbacks of &struct ieee80211_hw. 354 * 355 * When you allow multiple interfaces to be added to your PHY, take care 356 * that the hardware can actually handle multiple MAC addresses. However, 357 * also take care that when there's no interface left with mac_addr != %NULL 358 * you remove the MAC address from the device to avoid acknowledging packets 359 * in pure monitor mode. 360 */ 361 struct ieee80211_if_init_conf { 362 int if_id; 363 int type; 364 void *mac_addr; 365 }; 366 367 /** 368 * struct ieee80211_if_conf - configuration of an interface 369 * 370 * @type: type of the interface. This is always the same as was specified in 371 * &struct ieee80211_if_init_conf. The type of an interface never changes 372 * during the life of the interface; this field is present only for 373 * convenience. 374 * @bssid: BSSID of the network we are associated to/creating. 375 * @ssid: used (together with @ssid_len) by drivers for hardware that 376 * generate beacons independently. The pointer is valid only during the 377 * config_interface() call, so copy the value somewhere if you need 378 * it. 379 * @ssid_len: length of the @ssid field. 380 * @generic_elem: used (together with @generic_elem_len) by drivers for 381 * hardware that generate beacons independently. The pointer is valid 382 * only during the config_interface() call, so copy the value somewhere 383 * if you need it. 384 * @generic_elem_len: length of the generic element. 385 * @beacon: beacon template. Valid only if @host_gen_beacon_template in 386 * &struct ieee80211_hw is set. The driver is responsible of freeing 387 * the sk_buff. 388 * @beacon_control: tx_control for the beacon template, this field is only 389 * valid when the @beacon field was set. 390 * 391 * This structure is passed to the config_interface() callback of 392 * &struct ieee80211_hw. 393 */ 394 struct ieee80211_if_conf { 395 int type; 396 u8 *bssid; 397 u8 *ssid; 398 size_t ssid_len; 399 u8 *generic_elem; 400 size_t generic_elem_len; 401 struct sk_buff *beacon; 402 struct ieee80211_tx_control *beacon_control; 403 }; 404 405 typedef enum { ALG_NONE, ALG_WEP, ALG_TKIP, ALG_CCMP, ALG_NULL } 406 ieee80211_key_alg; 407 408 409 struct ieee80211_key_conf { 410 411 int hw_key_idx; /* filled + used by low-level driver */ 412 ieee80211_key_alg alg; 413 int keylen; 414 415 #define IEEE80211_KEY_FORCE_SW_ENCRYPT (1<<0) /* to be cleared by low-level 416 driver */ 417 #define IEEE80211_KEY_DEFAULT_TX_KEY (1<<1) /* This key is the new default TX 418 key (used only for broadcast 419 keys). */ 420 #define IEEE80211_KEY_DEFAULT_WEP_ONLY (1<<2) /* static WEP is the only 421 configured security policy; 422 this allows some low-level 423 drivers to determine when 424 hwaccel can be used */ 425 u32 flags; /* key configuration flags defined above */ 426 427 s8 keyidx; /* WEP key index */ 428 u8 key[0]; 429 }; 430 431 #define IEEE80211_SEQ_COUNTER_RX 0 432 #define IEEE80211_SEQ_COUNTER_TX 1 433 434 typedef enum { 435 SET_KEY, DISABLE_KEY, REMOVE_ALL_KEYS, 436 } set_key_cmd; 437 438 /* This is driver-visible part of the per-hw state the stack keeps. */ 439 struct ieee80211_hw { 440 /* points to the cfg80211 wiphy for this piece. Note 441 * that you must fill in the perm_addr and dev fields 442 * of this structure, use the macros provided below. */ 443 struct wiphy *wiphy; 444 445 /* assigned by mac80211, don't write */ 446 struct ieee80211_conf conf; 447 448 /* Single thread workqueue available for driver use 449 * Allocated by mac80211 on registration */ 450 struct workqueue_struct *workqueue; 451 452 /* Pointer to the private area that was 453 * allocated with this struct for you. */ 454 void *priv; 455 456 /* The rest is information about your hardware */ 457 458 /* TODO: frame_type 802.11/802.3, sw_encryption requirements */ 459 460 /* Some wireless LAN chipsets generate beacons in the hardware/firmware 461 * and others rely on host generated beacons. This option is used to 462 * configure the upper layer IEEE 802.11 module to generate beacons. 463 * The low-level driver can use ieee80211_beacon_get() to fetch the 464 * next beacon frame. */ 465 #define IEEE80211_HW_HOST_GEN_BEACON (1<<0) 466 467 /* The device needs to be supplied with a beacon template only. */ 468 #define IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE (1<<1) 469 470 /* Some devices handle decryption internally and do not 471 * indicate whether the frame was encrypted (unencrypted frames 472 * will be dropped by the hardware, unless specifically allowed 473 * through) */ 474 #define IEEE80211_HW_DEVICE_HIDES_WEP (1<<2) 475 476 /* Whether RX frames passed to ieee80211_rx() include FCS in the end */ 477 #define IEEE80211_HW_RX_INCLUDES_FCS (1<<3) 478 479 /* Some wireless LAN chipsets buffer broadcast/multicast frames for 480 * power saving stations in the hardware/firmware and others rely on 481 * the host system for such buffering. This option is used to 482 * configure the IEEE 802.11 upper layer to buffer broadcast/multicast 483 * frames when there are power saving stations so that low-level driver 484 * can fetch them with ieee80211_get_buffered_bc(). */ 485 #define IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING (1<<4) 486 487 #define IEEE80211_HW_WEP_INCLUDE_IV (1<<5) 488 489 /* will data nullfunc frames get proper TX status callback */ 490 #define IEEE80211_HW_DATA_NULLFUNC_ACK (1<<6) 491 492 /* Force software encryption for TKIP packets if WMM is enabled. */ 493 #define IEEE80211_HW_NO_TKIP_WMM_HWACCEL (1<<7) 494 495 /* Some devices handle Michael MIC internally and do not include MIC in 496 * the received packets passed up. device_strips_mic must be set 497 * for such devices. The 'encryption' frame control bit is expected to 498 * be still set in the IEEE 802.11 header with this option unlike with 499 * the device_hides_wep configuration option. 500 */ 501 #define IEEE80211_HW_DEVICE_STRIPS_MIC (1<<8) 502 503 /* Device is capable of performing full monitor mode even during 504 * normal operation. */ 505 #define IEEE80211_HW_MONITOR_DURING_OPER (1<<9) 506 507 /* Device does not need BSSID filter set to broadcast in order to 508 * receive all probe responses while scanning */ 509 #define IEEE80211_HW_NO_PROBE_FILTERING (1<<10) 510 511 /* Channels are already configured to the default regulatory domain 512 * specified in the device's EEPROM */ 513 #define IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED (1<<11) 514 515 /* calculate Michael MIC for an MSDU when doing hwcrypto */ 516 #define IEEE80211_HW_TKIP_INCLUDE_MMIC (1<<12) 517 /* Do TKIP phase1 key mixing in stack to support cards only do 518 * phase2 key mixing when doing hwcrypto */ 519 #define IEEE80211_HW_TKIP_REQ_PHASE1_KEY (1<<13) 520 /* Do TKIP phase1 and phase2 key mixing in stack and send the generated 521 * per-packet RC4 key with each TX frame when doing hwcrypto */ 522 #define IEEE80211_HW_TKIP_REQ_PHASE2_KEY (1<<14) 523 524 u32 flags; /* hardware flags defined above */ 525 526 /* Set to the size of a needed device specific skb headroom for TX skbs. */ 527 unsigned int extra_tx_headroom; 528 529 /* This is the time in us to change channels 530 */ 531 int channel_change_time; 532 /* Maximum values for various statistics. 533 * Leave at 0 to indicate no support. Use negative numbers for dBm. */ 534 s8 max_rssi; 535 s8 max_signal; 536 s8 max_noise; 537 538 /* Number of available hardware TX queues for data packets. 539 * WMM requires at least four queues. */ 540 int queues; 541 }; 542 543 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 544 { 545 set_wiphy_dev(hw->wiphy, dev); 546 } 547 548 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 549 { 550 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 551 } 552 553 /* Configuration block used by the low-level driver to tell the 802.11 code 554 * about supported hardware features and to pass function pointers to callback 555 * functions. */ 556 struct ieee80211_ops { 557 /* Handler that 802.11 module calls for each transmitted frame. 558 * skb contains the buffer starting from the IEEE 802.11 header. 559 * The low-level driver should send the frame out based on 560 * configuration in the TX control data. 561 * Must be atomic. */ 562 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb, 563 struct ieee80211_tx_control *control); 564 565 /* Handler for performing hardware reset. */ 566 int (*reset)(struct ieee80211_hw *hw); 567 568 /* Handler that is called when any netdevice attached to the hardware 569 * device is set UP for the first time. This can be used, e.g., to 570 * enable interrupts and beacon sending. */ 571 int (*open)(struct ieee80211_hw *hw); 572 573 /* Handler that is called when the last netdevice attached to the 574 * hardware device is set DOWN. This can be used, e.g., to disable 575 * interrupts and beacon sending. */ 576 int (*stop)(struct ieee80211_hw *hw); 577 578 /* Handler for asking a driver if a new interface can be added (or, 579 * more exactly, set UP). If the handler returns zero, the interface 580 * is added. Driver should perform any initialization it needs prior 581 * to returning zero. By returning non-zero addition of the interface 582 * is inhibited. Unless monitor_during_oper is set, it is guaranteed 583 * that monitor interfaces and normal interfaces are mutually 584 * exclusive. If assigned, the open() handler is called after 585 * add_interface() if this is the first device added. The 586 * add_interface() callback has to be assigned because it is the only 587 * way to obtain the requested MAC address for any interface. 588 */ 589 int (*add_interface)(struct ieee80211_hw *hw, 590 struct ieee80211_if_init_conf *conf); 591 592 /* Notify a driver that an interface is going down. The stop() handler 593 * is called prior to this if this is a last interface. */ 594 void (*remove_interface)(struct ieee80211_hw *hw, 595 struct ieee80211_if_init_conf *conf); 596 597 /* Handler for configuration requests. IEEE 802.11 code calls this 598 * function to change hardware configuration, e.g., channel. */ 599 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf); 600 601 /* Handler for configuration requests related to interfaces (e.g. 602 * BSSID). */ 603 int (*config_interface)(struct ieee80211_hw *hw, 604 int if_id, struct ieee80211_if_conf *conf); 605 606 /* ieee80211 drivers do not have access to the &struct net_device 607 * that is (are) connected with their device. Hence (and because 608 * we need to combine the multicast lists and flags for multiple 609 * virtual interfaces), they cannot assign set_multicast_list. 610 * The parameters here replace dev->flags and dev->mc_count, 611 * dev->mc_list is replaced by calling ieee80211_get_mc_list_item. 612 * Must be atomic. */ 613 void (*set_multicast_list)(struct ieee80211_hw *hw, 614 unsigned short flags, int mc_count); 615 616 /* Set TIM bit handler. If the hardware/firmware takes care of beacon 617 * generation, IEEE 802.11 code uses this function to tell the 618 * low-level to set (or clear if set==0) TIM bit for the given aid. If 619 * host system is used to generate beacons, this handler is not used 620 * and low-level driver should set it to NULL. 621 * Must be atomic. */ 622 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set); 623 624 /* Set encryption key. IEEE 802.11 module calls this function to set 625 * encryption keys. addr is ff:ff:ff:ff:ff:ff for default keys and 626 * station hwaddr for individual keys. aid of the station is given 627 * to help low-level driver in selecting which key->hw_key_idx to use 628 * for this key. TX control data will use the hw_key_idx selected by 629 * the low-level driver. 630 * Must be atomic. */ 631 int (*set_key)(struct ieee80211_hw *hw, set_key_cmd cmd, 632 u8 *addr, struct ieee80211_key_conf *key, int aid); 633 634 /* Set TX key index for default/broadcast keys. This is needed in cases 635 * where wlan card is doing full WEP/TKIP encapsulation (wep_include_iv 636 * is not set), in other cases, this function pointer can be set to 637 * NULL since the IEEE 802. 11 module takes care of selecting the key 638 * index for each TX frame. */ 639 int (*set_key_idx)(struct ieee80211_hw *hw, int idx); 640 641 /* Enable/disable IEEE 802.1X. This item requests wlan card to pass 642 * unencrypted EAPOL-Key frames even when encryption is configured. 643 * If the wlan card does not require such a configuration, this 644 * function pointer can be set to NULL. */ 645 int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x); 646 647 /* Set port authorization state (IEEE 802.1X PAE) to be authorized 648 * (authorized=1) or unauthorized (authorized=0). This function can be 649 * used if the wlan hardware or low-level driver implements PAE. 650 * 80211.o module will anyway filter frames based on authorization 651 * state, so this function pointer can be NULL if low-level driver does 652 * not require event notification about port state changes. 653 * Currently unused. */ 654 int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr, 655 int authorized); 656 657 /* Ask the hardware to service the scan request, no need to start 658 * the scan state machine in stack. */ 659 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len); 660 661 /* return low-level statistics */ 662 int (*get_stats)(struct ieee80211_hw *hw, 663 struct ieee80211_low_level_stats *stats); 664 665 /* For devices that generate their own beacons and probe response 666 * or association responses this updates the state of privacy_invoked 667 * returns 0 for success or an error number */ 668 int (*set_privacy_invoked)(struct ieee80211_hw *hw, 669 int privacy_invoked); 670 671 /* For devices that have internal sequence counters, allow 802.11 672 * code to access the current value of a counter */ 673 int (*get_sequence_counter)(struct ieee80211_hw *hw, 674 u8* addr, u8 keyidx, u8 txrx, 675 u32* iv32, u16* iv16); 676 677 /* Configuration of RTS threshold (if device needs it) */ 678 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 679 680 /* Configuration of fragmentation threshold. 681 * Assign this if the device does fragmentation by itself, 682 * if this method is assigned then the stack will not do 683 * fragmentation. */ 684 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); 685 686 /* Configuration of retry limits (if device needs it) */ 687 int (*set_retry_limit)(struct ieee80211_hw *hw, 688 u32 short_retry, u32 long_retr); 689 690 /* Number of STAs in STA table notification (NULL = disabled). 691 * Must be atomic. */ 692 void (*sta_table_notification)(struct ieee80211_hw *hw, 693 int num_sta); 694 695 /* Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 696 * bursting) for a hardware TX queue. 697 * queue = IEEE80211_TX_QUEUE_*. 698 * Must be atomic. */ 699 int (*conf_tx)(struct ieee80211_hw *hw, int queue, 700 const struct ieee80211_tx_queue_params *params); 701 702 /* Get statistics of the current TX queue status. This is used to get 703 * number of currently queued packets (queue length), maximum queue 704 * size (limit), and total number of packets sent using each TX queue 705 * (count). 706 * Currently unused. */ 707 int (*get_tx_stats)(struct ieee80211_hw *hw, 708 struct ieee80211_tx_queue_stats *stats); 709 710 /* Get the current TSF timer value from firmware/hardware. Currently, 711 * this is only used for IBSS mode debugging and, as such, is not a 712 * required function. 713 * Must be atomic. */ 714 u64 (*get_tsf)(struct ieee80211_hw *hw); 715 716 /* Reset the TSF timer and allow firmware/hardware to synchronize with 717 * other STAs in the IBSS. This is only used in IBSS mode. This 718 * function is optional if the firmware/hardware takes full care of 719 * TSF synchronization. */ 720 void (*reset_tsf)(struct ieee80211_hw *hw); 721 722 /* Setup beacon data for IBSS beacons. Unlike access point (Master), 723 * IBSS uses a fixed beacon frame which is configured using this 724 * function. This handler is required only for IBSS mode. */ 725 int (*beacon_update)(struct ieee80211_hw *hw, 726 struct sk_buff *skb, 727 struct ieee80211_tx_control *control); 728 729 /* Determine whether the last IBSS beacon was sent by us. This is 730 * needed only for IBSS mode and the result of this function is used to 731 * determine whether to reply to Probe Requests. */ 732 int (*tx_last_beacon)(struct ieee80211_hw *hw); 733 }; 734 735 /* Allocate a new hardware device. This must be called once for each 736 * hardware device. The returned pointer must be used to refer to this 737 * device when calling other functions. 802.11 code allocates a private data 738 * area for the low-level driver. The size of this area is given as 739 * priv_data_len. 740 */ 741 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 742 const struct ieee80211_ops *ops); 743 744 /* Register hardware device to the IEEE 802.11 code and kernel. Low-level 745 * drivers must call this function before using any other IEEE 802.11 746 * function except ieee80211_register_hwmode. */ 747 int ieee80211_register_hw(struct ieee80211_hw *hw); 748 749 /* driver can use this and ieee80211_get_rx_led_name to get the 750 * name of the registered LEDs after ieee80211_register_hw 751 * was called. 752 * This is useful to set the default trigger on the LED class 753 * device that your driver should export for each LED the device 754 * has, that way the default behaviour will be as expected but 755 * the user can still change it/turn off the LED etc. 756 */ 757 #ifdef CONFIG_MAC80211_LEDS 758 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 759 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 760 #endif 761 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 762 { 763 #ifdef CONFIG_MAC80211_LEDS 764 return __ieee80211_get_tx_led_name(hw); 765 #else 766 return NULL; 767 #endif 768 } 769 770 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 771 { 772 #ifdef CONFIG_MAC80211_LEDS 773 return __ieee80211_get_rx_led_name(hw); 774 #else 775 return NULL; 776 #endif 777 } 778 779 /* Register a new hardware PHYMODE capability to the stack. */ 780 int ieee80211_register_hwmode(struct ieee80211_hw *hw, 781 struct ieee80211_hw_mode *mode); 782 783 /* Unregister a hardware device. This function instructs 802.11 code to free 784 * allocated resources and unregister netdevices from the kernel. */ 785 void ieee80211_unregister_hw(struct ieee80211_hw *hw); 786 787 /* Free everything that was allocated including private data of a driver. */ 788 void ieee80211_free_hw(struct ieee80211_hw *hw); 789 790 /* Receive frame callback function. The low-level driver uses this function to 791 * send received frames to the IEEE 802.11 code. Receive buffer (skb) must 792 * start with IEEE 802.11 header. */ 793 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb, 794 struct ieee80211_rx_status *status); 795 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, 796 struct sk_buff *skb, 797 struct ieee80211_rx_status *status); 798 799 /* Transmit status callback function. The low-level driver must call this 800 * function to report transmit status for all the TX frames that had 801 * req_tx_status set in the transmit control fields. In addition, this should 802 * be called at least for all unicast frames to provide information for TX rate 803 * control algorithm. In order to maintain all statistics, this function is 804 * recommended to be called after each frame, including multicast/broadcast, is 805 * sent. */ 806 void ieee80211_tx_status(struct ieee80211_hw *hw, 807 struct sk_buff *skb, 808 struct ieee80211_tx_status *status); 809 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 810 struct sk_buff *skb, 811 struct ieee80211_tx_status *status); 812 813 /** 814 * ieee80211_beacon_get - beacon generation function 815 * @hw: pointer obtained from ieee80211_alloc_hw(). 816 * @if_id: interface ID from &struct ieee80211_if_init_conf. 817 * @control: will be filled with information needed to send this beacon. 818 * 819 * If the beacon frames are generated by the host system (i.e., not in 820 * hardware/firmware), the low-level driver uses this function to receive 821 * the next beacon frame from the 802.11 code. The low-level is responsible 822 * for calling this function before beacon data is needed (e.g., based on 823 * hardware interrupt). Returned skb is used only once and low-level driver 824 * is responsible of freeing it. 825 */ 826 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 827 int if_id, 828 struct ieee80211_tx_control *control); 829 830 /** 831 * ieee80211_rts_get - RTS frame generation function 832 * @hw: pointer obtained from ieee80211_alloc_hw(). 833 * @frame: pointer to the frame that is going to be protected by the RTS. 834 * @frame_len: the frame length (in octets). 835 * @frame_txctl: &struct ieee80211_tx_control of the frame. 836 * @rts: The buffer where to store the RTS frame. 837 * 838 * If the RTS frames are generated by the host system (i.e., not in 839 * hardware/firmware), the low-level driver uses this function to receive 840 * the next RTS frame from the 802.11 code. The low-level is responsible 841 * for calling this function before and RTS frame is needed. 842 */ 843 void ieee80211_rts_get(struct ieee80211_hw *hw, 844 const void *frame, size_t frame_len, 845 const struct ieee80211_tx_control *frame_txctl, 846 struct ieee80211_rts *rts); 847 848 /** 849 * ieee80211_rts_duration - Get the duration field for an RTS frame 850 * @hw: pointer obtained from ieee80211_alloc_hw(). 851 * @frame_len: the length of the frame that is going to be protected by the RTS. 852 * @frame_txctl: &struct ieee80211_tx_control of the frame. 853 * 854 * If the RTS is generated in firmware, but the host system must provide 855 * the duration field, the low-level driver uses this function to receive 856 * the duration field value in little-endian byteorder. 857 */ 858 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, 859 size_t frame_len, 860 const struct ieee80211_tx_control *frame_txctl); 861 862 /** 863 * ieee80211_ctstoself_get - CTS-to-self frame generation function 864 * @hw: pointer obtained from ieee80211_alloc_hw(). 865 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 866 * @frame_len: the frame length (in octets). 867 * @frame_txctl: &struct ieee80211_tx_control of the frame. 868 * @cts: The buffer where to store the CTS-to-self frame. 869 * 870 * If the CTS-to-self frames are generated by the host system (i.e., not in 871 * hardware/firmware), the low-level driver uses this function to receive 872 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 873 * for calling this function before and CTS-to-self frame is needed. 874 */ 875 void ieee80211_ctstoself_get(struct ieee80211_hw *hw, 876 const void *frame, size_t frame_len, 877 const struct ieee80211_tx_control *frame_txctl, 878 struct ieee80211_cts *cts); 879 880 /** 881 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 882 * @hw: pointer obtained from ieee80211_alloc_hw(). 883 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 884 * @frame_txctl: &struct ieee80211_tx_control of the frame. 885 * 886 * If the CTS-to-self is generated in firmware, but the host system must provide 887 * the duration field, the low-level driver uses this function to receive 888 * the duration field value in little-endian byteorder. 889 */ 890 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, 891 size_t frame_len, 892 const struct ieee80211_tx_control *frame_txctl); 893 894 /** 895 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 896 * @hw: pointer obtained from ieee80211_alloc_hw(). 897 * @frame_len: the length of the frame. 898 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted. 899 * 900 * Calculate the duration field of some generic frame, given its 901 * length and transmission rate (in 100kbps). 902 */ 903 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, 904 size_t frame_len, 905 int rate); 906 907 /** 908 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 909 * @hw: pointer as obtained from ieee80211_alloc_hw(). 910 * @if_id: interface ID from &struct ieee80211_if_init_conf. 911 * @control: will be filled with information needed to send returned frame. 912 * 913 * Function for accessing buffered broadcast and multicast frames. If 914 * hardware/firmware does not implement buffering of broadcast/multicast 915 * frames when power saving is used, 802.11 code buffers them in the host 916 * memory. The low-level driver uses this function to fetch next buffered 917 * frame. In most cases, this is used when generating beacon frame. This 918 * function returns a pointer to the next buffered skb or NULL if no more 919 * buffered frames are available. 920 * 921 * Note: buffered frames are returned only after DTIM beacon frame was 922 * generated with ieee80211_beacon_get() and the low-level driver must thus 923 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 924 * NULL if the previous generated beacon was not DTIM, so the low-level driver 925 * does not need to check for DTIM beacons separately and should be able to 926 * use common code for all beacons. 927 */ 928 struct sk_buff * 929 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id, 930 struct ieee80211_tx_control *control); 931 932 /* Given an sk_buff with a raw 802.11 header at the data pointer this function 933 * returns the 802.11 header length in bytes (not including encryption 934 * headers). If the data in the sk_buff is too short to contain a valid 802.11 935 * header the function returns 0. 936 */ 937 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); 938 939 /* Like ieee80211_get_hdrlen_from_skb() but takes a FC in CPU order. */ 940 int ieee80211_get_hdrlen(u16 fc); 941 942 /** 943 * ieee80211_wake_queue - wake specific queue 944 * @hw: pointer as obtained from ieee80211_alloc_hw(). 945 * @queue: queue number (counted from zero). 946 * 947 * Drivers should use this function instead of netif_wake_queue. 948 */ 949 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 950 951 /** 952 * ieee80211_stop_queue - stop specific queue 953 * @hw: pointer as obtained from ieee80211_alloc_hw(). 954 * @queue: queue number (counted from zero). 955 * 956 * Drivers should use this function instead of netif_stop_queue. 957 */ 958 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 959 960 /** 961 * ieee80211_start_queues - start all queues 962 * @hw: pointer to as obtained from ieee80211_alloc_hw(). 963 * 964 * Drivers should use this function instead of netif_start_queue. 965 */ 966 void ieee80211_start_queues(struct ieee80211_hw *hw); 967 968 /** 969 * ieee80211_stop_queues - stop all queues 970 * @hw: pointer as obtained from ieee80211_alloc_hw(). 971 * 972 * Drivers should use this function instead of netif_stop_queue. 973 */ 974 void ieee80211_stop_queues(struct ieee80211_hw *hw); 975 976 /** 977 * ieee80211_wake_queues - wake all queues 978 * @hw: pointer as obtained from ieee80211_alloc_hw(). 979 * 980 * Drivers should use this function instead of netif_wake_queue. 981 */ 982 void ieee80211_wake_queues(struct ieee80211_hw *hw); 983 984 /** 985 * ieee80211_get_mc_list_item - iteration over items in multicast list 986 * @hw: pointer as obtained from ieee80211_alloc_hw(). 987 * @prev: value returned by previous call to ieee80211_get_mc_list_item() or 988 * NULL to start a new iteration. 989 * @ptr: pointer to buffer of void * type for internal usage of 990 * ieee80211_get_mc_list_item(). 991 * 992 * Iterates over items in multicast list of given device. To get the first 993 * item, pass NULL in @prev and in *@ptr. In subsequent calls, pass the 994 * value returned by previous call in @prev. Don't alter *@ptr during 995 * iteration. When there are no more items, NULL is returned. 996 */ 997 struct dev_mc_list * 998 ieee80211_get_mc_list_item(struct ieee80211_hw *hw, 999 struct dev_mc_list *prev, 1000 void **ptr); 1001 1002 /* called by driver to notify scan status completed */ 1003 void ieee80211_scan_completed(struct ieee80211_hw *hw); 1004 1005 /* Function to indicate Radar Detection. The low level driver must call this 1006 * function to indicate the presence of radar in the current channel. 1007 * Additionally the radar type also could be sent */ 1008 int ieee80211_radar_status(struct ieee80211_hw *hw, int channel, 1009 int radar, int radar_type); 1010 1011 /* return a pointer to the source address (SA) */ 1012 static inline u8 *ieee80211_get_SA(struct ieee80211_hdr *hdr) 1013 { 1014 u8 *raw = (u8 *) hdr; 1015 u8 tofrom = (*(raw+1)) & 3; /* get the TODS and FROMDS bits */ 1016 1017 switch (tofrom) { 1018 case 2: 1019 return hdr->addr3; 1020 case 3: 1021 return hdr->addr4; 1022 } 1023 return hdr->addr2; 1024 } 1025 1026 /* return a pointer to the destination address (DA) */ 1027 static inline u8 *ieee80211_get_DA(struct ieee80211_hdr *hdr) 1028 { 1029 u8 *raw = (u8 *) hdr; 1030 u8 to_ds = (*(raw+1)) & 1; /* get the TODS bit */ 1031 1032 if (to_ds) 1033 return hdr->addr3; 1034 return hdr->addr1; 1035 } 1036 1037 static inline int ieee80211_get_morefrag(struct ieee80211_hdr *hdr) 1038 { 1039 return (le16_to_cpu(hdr->frame_control) & 1040 IEEE80211_FCTL_MOREFRAGS) != 0; 1041 } 1042 1043 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x" 1044 #define MAC_ARG(x) ((u8*)(x))[0], ((u8*)(x))[1], ((u8*)(x))[2], \ 1045 ((u8*)(x))[3], ((u8*)(x))[4], ((u8*)(x))[5] 1046 1047 #endif /* MAC80211_H */ 1048