1 #ifndef __NET_CFG80211_H 2 #define __NET_CFG80211_H 3 /* 4 * 802.11 device and configuration interface 5 * 6 * Copyright 2006-2010 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 #include <linux/netdevice.h> 14 #include <linux/debugfs.h> 15 #include <linux/list.h> 16 #include <linux/bug.h> 17 #include <linux/netlink.h> 18 #include <linux/skbuff.h> 19 #include <linux/nl80211.h> 20 #include <linux/if_ether.h> 21 #include <linux/ieee80211.h> 22 #include <net/regulatory.h> 23 24 /** 25 * DOC: Introduction 26 * 27 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges 28 * userspace and drivers, and offers some utility functionality associated 29 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used 30 * by all modern wireless drivers in Linux, so that they offer a consistent 31 * API through nl80211. For backward compatibility, cfg80211 also offers 32 * wireless extensions to userspace, but hides them from drivers completely. 33 * 34 * Additionally, cfg80211 contains code to help enforce regulatory spectrum 35 * use restrictions. 36 */ 37 38 39 /** 40 * DOC: Device registration 41 * 42 * In order for a driver to use cfg80211, it must register the hardware device 43 * with cfg80211. This happens through a number of hardware capability structs 44 * described below. 45 * 46 * The fundamental structure for each device is the 'wiphy', of which each 47 * instance describes a physical wireless device connected to the system. Each 48 * such wiphy can have zero, one, or many virtual interfaces associated with 49 * it, which need to be identified as such by pointing the network interface's 50 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes 51 * the wireless part of the interface, normally this struct is embedded in the 52 * network interface's private data area. Drivers can optionally allow creating 53 * or destroying virtual interfaces on the fly, but without at least one or the 54 * ability to create some the wireless device isn't useful. 55 * 56 * Each wiphy structure contains device capability information, and also has 57 * a pointer to the various operations the driver offers. The definitions and 58 * structures here describe these capabilities in detail. 59 */ 60 61 /* 62 * wireless hardware capability structures 63 */ 64 65 /** 66 * enum ieee80211_band - supported frequency bands 67 * 68 * The bands are assigned this way because the supported 69 * bitrates differ in these bands. 70 * 71 * @IEEE80211_BAND_2GHZ: 2.4GHz ISM band 72 * @IEEE80211_BAND_5GHZ: around 5GHz band (4.9-5.7) 73 * @IEEE80211_NUM_BANDS: number of defined bands 74 */ 75 enum ieee80211_band { 76 IEEE80211_BAND_2GHZ = NL80211_BAND_2GHZ, 77 IEEE80211_BAND_5GHZ = NL80211_BAND_5GHZ, 78 79 /* keep last */ 80 IEEE80211_NUM_BANDS 81 }; 82 83 /** 84 * enum ieee80211_channel_flags - channel flags 85 * 86 * Channel flags set by the regulatory control code. 87 * 88 * @IEEE80211_CHAN_DISABLED: This channel is disabled. 89 * @IEEE80211_CHAN_PASSIVE_SCAN: Only passive scanning is permitted 90 * on this channel. 91 * @IEEE80211_CHAN_NO_IBSS: IBSS is not allowed on this channel. 92 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel. 93 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel 94 * is not permitted. 95 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel 96 * is not permitted. 97 */ 98 enum ieee80211_channel_flags { 99 IEEE80211_CHAN_DISABLED = 1<<0, 100 IEEE80211_CHAN_PASSIVE_SCAN = 1<<1, 101 IEEE80211_CHAN_NO_IBSS = 1<<2, 102 IEEE80211_CHAN_RADAR = 1<<3, 103 IEEE80211_CHAN_NO_HT40PLUS = 1<<4, 104 IEEE80211_CHAN_NO_HT40MINUS = 1<<5, 105 }; 106 107 #define IEEE80211_CHAN_NO_HT40 \ 108 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS) 109 110 /** 111 * struct ieee80211_channel - channel definition 112 * 113 * This structure describes a single channel for use 114 * with cfg80211. 115 * 116 * @center_freq: center frequency in MHz 117 * @hw_value: hardware-specific value for the channel 118 * @flags: channel flags from &enum ieee80211_channel_flags. 119 * @orig_flags: channel flags at registration time, used by regulatory 120 * code to support devices with additional restrictions 121 * @band: band this channel belongs to. 122 * @max_antenna_gain: maximum antenna gain in dBi 123 * @max_power: maximum transmission power (in dBm) 124 * @max_reg_power: maximum regulatory transmission power (in dBm) 125 * @beacon_found: helper to regulatory code to indicate when a beacon 126 * has been found on this channel. Use regulatory_hint_found_beacon() 127 * to enable this, this is useful only on 5 GHz band. 128 * @orig_mag: internal use 129 * @orig_mpwr: internal use 130 */ 131 struct ieee80211_channel { 132 enum ieee80211_band band; 133 u16 center_freq; 134 u16 hw_value; 135 u32 flags; 136 int max_antenna_gain; 137 int max_power; 138 int max_reg_power; 139 bool beacon_found; 140 u32 orig_flags; 141 int orig_mag, orig_mpwr; 142 }; 143 144 /** 145 * enum ieee80211_rate_flags - rate flags 146 * 147 * Hardware/specification flags for rates. These are structured 148 * in a way that allows using the same bitrate structure for 149 * different bands/PHY modes. 150 * 151 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short 152 * preamble on this bitrate; only relevant in 2.4GHz band and 153 * with CCK rates. 154 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate 155 * when used with 802.11a (on the 5 GHz band); filled by the 156 * core code when registering the wiphy. 157 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate 158 * when used with 802.11b (on the 2.4 GHz band); filled by the 159 * core code when registering the wiphy. 160 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate 161 * when used with 802.11g (on the 2.4 GHz band); filled by the 162 * core code when registering the wiphy. 163 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode. 164 */ 165 enum ieee80211_rate_flags { 166 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0, 167 IEEE80211_RATE_MANDATORY_A = 1<<1, 168 IEEE80211_RATE_MANDATORY_B = 1<<2, 169 IEEE80211_RATE_MANDATORY_G = 1<<3, 170 IEEE80211_RATE_ERP_G = 1<<4, 171 }; 172 173 /** 174 * struct ieee80211_rate - bitrate definition 175 * 176 * This structure describes a bitrate that an 802.11 PHY can 177 * operate with. The two values @hw_value and @hw_value_short 178 * are only for driver use when pointers to this structure are 179 * passed around. 180 * 181 * @flags: rate-specific flags 182 * @bitrate: bitrate in units of 100 Kbps 183 * @hw_value: driver/hardware value for this rate 184 * @hw_value_short: driver/hardware value for this rate when 185 * short preamble is used 186 */ 187 struct ieee80211_rate { 188 u32 flags; 189 u16 bitrate; 190 u16 hw_value, hw_value_short; 191 }; 192 193 /** 194 * struct ieee80211_sta_ht_cap - STA's HT capabilities 195 * 196 * This structure describes most essential parameters needed 197 * to describe 802.11n HT capabilities for an STA. 198 * 199 * @ht_supported: is HT supported by the STA 200 * @cap: HT capabilities map as described in 802.11n spec 201 * @ampdu_factor: Maximum A-MPDU length factor 202 * @ampdu_density: Minimum A-MPDU spacing 203 * @mcs: Supported MCS rates 204 */ 205 struct ieee80211_sta_ht_cap { 206 u16 cap; /* use IEEE80211_HT_CAP_ */ 207 bool ht_supported; 208 u8 ampdu_factor; 209 u8 ampdu_density; 210 struct ieee80211_mcs_info mcs; 211 }; 212 213 /** 214 * struct ieee80211_supported_band - frequency band definition 215 * 216 * This structure describes a frequency band a wiphy 217 * is able to operate in. 218 * 219 * @channels: Array of channels the hardware can operate in 220 * in this band. 221 * @band: the band this structure represents 222 * @n_channels: Number of channels in @channels 223 * @bitrates: Array of bitrates the hardware can operate with 224 * in this band. Must be sorted to give a valid "supported 225 * rates" IE, i.e. CCK rates first, then OFDM. 226 * @n_bitrates: Number of bitrates in @bitrates 227 * @ht_cap: HT capabilities in this band 228 */ 229 struct ieee80211_supported_band { 230 struct ieee80211_channel *channels; 231 struct ieee80211_rate *bitrates; 232 enum ieee80211_band band; 233 int n_channels; 234 int n_bitrates; 235 struct ieee80211_sta_ht_cap ht_cap; 236 }; 237 238 /* 239 * Wireless hardware/device configuration structures and methods 240 */ 241 242 /** 243 * DOC: Actions and configuration 244 * 245 * Each wireless device and each virtual interface offer a set of configuration 246 * operations and other actions that are invoked by userspace. Each of these 247 * actions is described in the operations structure, and the parameters these 248 * operations use are described separately. 249 * 250 * Additionally, some operations are asynchronous and expect to get status 251 * information via some functions that drivers need to call. 252 * 253 * Scanning and BSS list handling with its associated functionality is described 254 * in a separate chapter. 255 */ 256 257 /** 258 * struct vif_params - describes virtual interface parameters 259 * @use_4addr: use 4-address frames 260 */ 261 struct vif_params { 262 int use_4addr; 263 }; 264 265 /** 266 * struct key_params - key information 267 * 268 * Information about a key 269 * 270 * @key: key material 271 * @key_len: length of key material 272 * @cipher: cipher suite selector 273 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used 274 * with the get_key() callback, must be in little endian, 275 * length given by @seq_len. 276 * @seq_len: length of @seq. 277 */ 278 struct key_params { 279 u8 *key; 280 u8 *seq; 281 int key_len; 282 int seq_len; 283 u32 cipher; 284 }; 285 286 /** 287 * enum survey_info_flags - survey information flags 288 * 289 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in 290 * @SURVEY_INFO_IN_USE: channel is currently being used 291 * @SURVEY_INFO_CHANNEL_TIME: channel active time (in ms) was filled in 292 * @SURVEY_INFO_CHANNEL_TIME_BUSY: channel busy time was filled in 293 * @SURVEY_INFO_CHANNEL_TIME_EXT_BUSY: extension channel busy time was filled in 294 * @SURVEY_INFO_CHANNEL_TIME_RX: channel receive time was filled in 295 * @SURVEY_INFO_CHANNEL_TIME_TX: channel transmit time was filled in 296 * 297 * Used by the driver to indicate which info in &struct survey_info 298 * it has filled in during the get_survey(). 299 */ 300 enum survey_info_flags { 301 SURVEY_INFO_NOISE_DBM = 1<<0, 302 SURVEY_INFO_IN_USE = 1<<1, 303 SURVEY_INFO_CHANNEL_TIME = 1<<2, 304 SURVEY_INFO_CHANNEL_TIME_BUSY = 1<<3, 305 SURVEY_INFO_CHANNEL_TIME_EXT_BUSY = 1<<4, 306 SURVEY_INFO_CHANNEL_TIME_RX = 1<<5, 307 SURVEY_INFO_CHANNEL_TIME_TX = 1<<6, 308 }; 309 310 /** 311 * struct survey_info - channel survey response 312 * 313 * @channel: the channel this survey record reports, mandatory 314 * @filled: bitflag of flags from &enum survey_info_flags 315 * @noise: channel noise in dBm. This and all following fields are 316 * optional 317 * @channel_time: amount of time in ms the radio spent on the channel 318 * @channel_time_busy: amount of time the primary channel was sensed busy 319 * @channel_time_ext_busy: amount of time the extension channel was sensed busy 320 * @channel_time_rx: amount of time the radio spent receiving data 321 * @channel_time_tx: amount of time the radio spent transmitting data 322 * 323 * Used by dump_survey() to report back per-channel survey information. 324 * 325 * This structure can later be expanded with things like 326 * channel duty cycle etc. 327 */ 328 struct survey_info { 329 struct ieee80211_channel *channel; 330 u64 channel_time; 331 u64 channel_time_busy; 332 u64 channel_time_ext_busy; 333 u64 channel_time_rx; 334 u64 channel_time_tx; 335 u32 filled; 336 s8 noise; 337 }; 338 339 /** 340 * struct cfg80211_crypto_settings - Crypto settings 341 * @wpa_versions: indicates which, if any, WPA versions are enabled 342 * (from enum nl80211_wpa_versions) 343 * @cipher_group: group key cipher suite (or 0 if unset) 344 * @n_ciphers_pairwise: number of AP supported unicast ciphers 345 * @ciphers_pairwise: unicast key cipher suites 346 * @n_akm_suites: number of AKM suites 347 * @akm_suites: AKM suites 348 * @control_port: Whether user space controls IEEE 802.1X port, i.e., 349 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is 350 * required to assume that the port is unauthorized until authorized by 351 * user space. Otherwise, port is marked authorized by default. 352 * @control_port_ethertype: the control port protocol that should be 353 * allowed through even on unauthorized ports 354 * @control_port_no_encrypt: TRUE to prevent encryption of control port 355 * protocol frames. 356 */ 357 struct cfg80211_crypto_settings { 358 u32 wpa_versions; 359 u32 cipher_group; 360 int n_ciphers_pairwise; 361 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES]; 362 int n_akm_suites; 363 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES]; 364 bool control_port; 365 __be16 control_port_ethertype; 366 bool control_port_no_encrypt; 367 }; 368 369 /** 370 * struct cfg80211_beacon_data - beacon data 371 * @head: head portion of beacon (before TIM IE) 372 * or %NULL if not changed 373 * @tail: tail portion of beacon (after TIM IE) 374 * or %NULL if not changed 375 * @head_len: length of @head 376 * @tail_len: length of @tail 377 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL 378 * @beacon_ies_len: length of beacon_ies in octets 379 * @proberesp_ies: extra information element(s) to add into Probe Response 380 * frames or %NULL 381 * @proberesp_ies_len: length of proberesp_ies in octets 382 * @assocresp_ies: extra information element(s) to add into (Re)Association 383 * Response frames or %NULL 384 * @assocresp_ies_len: length of assocresp_ies in octets 385 * @probe_resp_len: length of probe response template (@probe_resp) 386 * @probe_resp: probe response template (AP mode only) 387 */ 388 struct cfg80211_beacon_data { 389 const u8 *head, *tail; 390 const u8 *beacon_ies; 391 const u8 *proberesp_ies; 392 const u8 *assocresp_ies; 393 const u8 *probe_resp; 394 395 size_t head_len, tail_len; 396 size_t beacon_ies_len; 397 size_t proberesp_ies_len; 398 size_t assocresp_ies_len; 399 size_t probe_resp_len; 400 }; 401 402 /** 403 * struct cfg80211_ap_settings - AP configuration 404 * 405 * Used to configure an AP interface. 406 * 407 * @beacon: beacon data 408 * @beacon_interval: beacon interval 409 * @dtim_period: DTIM period 410 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from 411 * user space) 412 * @ssid_len: length of @ssid 413 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames 414 * @crypto: crypto settings 415 * @privacy: the BSS uses privacy 416 * @auth_type: Authentication type (algorithm) 417 * @inactivity_timeout: time in seconds to determine station's inactivity. 418 */ 419 struct cfg80211_ap_settings { 420 struct cfg80211_beacon_data beacon; 421 422 int beacon_interval, dtim_period; 423 const u8 *ssid; 424 size_t ssid_len; 425 enum nl80211_hidden_ssid hidden_ssid; 426 struct cfg80211_crypto_settings crypto; 427 bool privacy; 428 enum nl80211_auth_type auth_type; 429 int inactivity_timeout; 430 }; 431 432 /** 433 * enum plink_action - actions to perform in mesh peers 434 * 435 * @PLINK_ACTION_INVALID: action 0 is reserved 436 * @PLINK_ACTION_OPEN: start mesh peer link establishment 437 * @PLINK_ACTION_BLOCK: block traffic from this mesh peer 438 */ 439 enum plink_actions { 440 PLINK_ACTION_INVALID, 441 PLINK_ACTION_OPEN, 442 PLINK_ACTION_BLOCK, 443 }; 444 445 /** 446 * enum station_parameters_apply_mask - station parameter values to apply 447 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp) 448 * 449 * Not all station parameters have in-band "no change" signalling, 450 * for those that don't these flags will are used. 451 */ 452 enum station_parameters_apply_mask { 453 STATION_PARAM_APPLY_UAPSD = BIT(0), 454 }; 455 456 /** 457 * struct station_parameters - station parameters 458 * 459 * Used to change and create a new station. 460 * 461 * @vlan: vlan interface station should belong to 462 * @supported_rates: supported rates in IEEE 802.11 format 463 * (or NULL for no change) 464 * @supported_rates_len: number of supported rates 465 * @sta_flags_mask: station flags that changed 466 * (bitmask of BIT(NL80211_STA_FLAG_...)) 467 * @sta_flags_set: station flags values 468 * (bitmask of BIT(NL80211_STA_FLAG_...)) 469 * @listen_interval: listen interval or -1 for no change 470 * @aid: AID or zero for no change 471 * @plink_action: plink action to take 472 * @plink_state: set the peer link state for a station 473 * @ht_capa: HT capabilities of station 474 * @uapsd_queues: bitmap of queues configured for uapsd. same format 475 * as the AC bitmap in the QoS info field 476 * @max_sp: max Service Period. same format as the MAX_SP in the 477 * QoS info field (but already shifted down) 478 * @sta_modify_mask: bitmap indicating which parameters changed 479 * (for those that don't have a natural "no change" value), 480 * see &enum station_parameters_apply_mask 481 */ 482 struct station_parameters { 483 u8 *supported_rates; 484 struct net_device *vlan; 485 u32 sta_flags_mask, sta_flags_set; 486 u32 sta_modify_mask; 487 int listen_interval; 488 u16 aid; 489 u8 supported_rates_len; 490 u8 plink_action; 491 u8 plink_state; 492 struct ieee80211_ht_cap *ht_capa; 493 u8 uapsd_queues; 494 u8 max_sp; 495 }; 496 497 /** 498 * enum station_info_flags - station information flags 499 * 500 * Used by the driver to indicate which info in &struct station_info 501 * it has filled in during get_station() or dump_station(). 502 * 503 * @STATION_INFO_INACTIVE_TIME: @inactive_time filled 504 * @STATION_INFO_RX_BYTES: @rx_bytes filled 505 * @STATION_INFO_TX_BYTES: @tx_bytes filled 506 * @STATION_INFO_LLID: @llid filled 507 * @STATION_INFO_PLID: @plid filled 508 * @STATION_INFO_PLINK_STATE: @plink_state filled 509 * @STATION_INFO_SIGNAL: @signal filled 510 * @STATION_INFO_TX_BITRATE: @txrate fields are filled 511 * (tx_bitrate, tx_bitrate_flags and tx_bitrate_mcs) 512 * @STATION_INFO_RX_PACKETS: @rx_packets filled 513 * @STATION_INFO_TX_PACKETS: @tx_packets filled 514 * @STATION_INFO_TX_RETRIES: @tx_retries filled 515 * @STATION_INFO_TX_FAILED: @tx_failed filled 516 * @STATION_INFO_RX_DROP_MISC: @rx_dropped_misc filled 517 * @STATION_INFO_SIGNAL_AVG: @signal_avg filled 518 * @STATION_INFO_RX_BITRATE: @rxrate fields are filled 519 * @STATION_INFO_BSS_PARAM: @bss_param filled 520 * @STATION_INFO_CONNECTED_TIME: @connected_time filled 521 * @STATION_INFO_ASSOC_REQ_IES: @assoc_req_ies filled 522 * @STATION_INFO_STA_FLAGS: @sta_flags filled 523 * @STATION_INFO_BEACON_LOSS_COUNT: @beacon_loss_count filled 524 */ 525 enum station_info_flags { 526 STATION_INFO_INACTIVE_TIME = 1<<0, 527 STATION_INFO_RX_BYTES = 1<<1, 528 STATION_INFO_TX_BYTES = 1<<2, 529 STATION_INFO_LLID = 1<<3, 530 STATION_INFO_PLID = 1<<4, 531 STATION_INFO_PLINK_STATE = 1<<5, 532 STATION_INFO_SIGNAL = 1<<6, 533 STATION_INFO_TX_BITRATE = 1<<7, 534 STATION_INFO_RX_PACKETS = 1<<8, 535 STATION_INFO_TX_PACKETS = 1<<9, 536 STATION_INFO_TX_RETRIES = 1<<10, 537 STATION_INFO_TX_FAILED = 1<<11, 538 STATION_INFO_RX_DROP_MISC = 1<<12, 539 STATION_INFO_SIGNAL_AVG = 1<<13, 540 STATION_INFO_RX_BITRATE = 1<<14, 541 STATION_INFO_BSS_PARAM = 1<<15, 542 STATION_INFO_CONNECTED_TIME = 1<<16, 543 STATION_INFO_ASSOC_REQ_IES = 1<<17, 544 STATION_INFO_STA_FLAGS = 1<<18, 545 STATION_INFO_BEACON_LOSS_COUNT = 1<<19 546 }; 547 548 /** 549 * enum station_info_rate_flags - bitrate info flags 550 * 551 * Used by the driver to indicate the specific rate transmission 552 * type for 802.11n transmissions. 553 * 554 * @RATE_INFO_FLAGS_MCS: @tx_bitrate_mcs filled 555 * @RATE_INFO_FLAGS_40_MHZ_WIDTH: 40 Mhz width transmission 556 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval 557 */ 558 enum rate_info_flags { 559 RATE_INFO_FLAGS_MCS = 1<<0, 560 RATE_INFO_FLAGS_40_MHZ_WIDTH = 1<<1, 561 RATE_INFO_FLAGS_SHORT_GI = 1<<2, 562 }; 563 564 /** 565 * struct rate_info - bitrate information 566 * 567 * Information about a receiving or transmitting bitrate 568 * 569 * @flags: bitflag of flags from &enum rate_info_flags 570 * @mcs: mcs index if struct describes a 802.11n bitrate 571 * @legacy: bitrate in 100kbit/s for 802.11abg 572 */ 573 struct rate_info { 574 u8 flags; 575 u8 mcs; 576 u16 legacy; 577 }; 578 579 /** 580 * enum station_info_rate_flags - bitrate info flags 581 * 582 * Used by the driver to indicate the specific rate transmission 583 * type for 802.11n transmissions. 584 * 585 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled 586 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled 587 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled 588 */ 589 enum bss_param_flags { 590 BSS_PARAM_FLAGS_CTS_PROT = 1<<0, 591 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1, 592 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2, 593 }; 594 595 /** 596 * struct sta_bss_parameters - BSS parameters for the attached station 597 * 598 * Information about the currently associated BSS 599 * 600 * @flags: bitflag of flags from &enum bss_param_flags 601 * @dtim_period: DTIM period for the BSS 602 * @beacon_interval: beacon interval 603 */ 604 struct sta_bss_parameters { 605 u8 flags; 606 u8 dtim_period; 607 u16 beacon_interval; 608 }; 609 610 /** 611 * struct station_info - station information 612 * 613 * Station information filled by driver for get_station() and dump_station. 614 * 615 * @filled: bitflag of flags from &enum station_info_flags 616 * @connected_time: time(in secs) since a station is last connected 617 * @inactive_time: time since last station activity (tx/rx) in milliseconds 618 * @rx_bytes: bytes received from this station 619 * @tx_bytes: bytes transmitted to this station 620 * @llid: mesh local link id 621 * @plid: mesh peer link id 622 * @plink_state: mesh peer link state 623 * @signal: the signal strength, type depends on the wiphy's signal_type 624 NOTE: For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_. 625 * @signal_avg: avg signal strength, type depends on the wiphy's signal_type 626 NOTE: For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_. 627 * @txrate: current unicast bitrate from this station 628 * @rxrate: current unicast bitrate to this station 629 * @rx_packets: packets received from this station 630 * @tx_packets: packets transmitted to this station 631 * @tx_retries: cumulative retry counts 632 * @tx_failed: number of failed transmissions (retries exceeded, no ACK) 633 * @rx_dropped_misc: Dropped for un-specified reason. 634 * @bss_param: current BSS parameters 635 * @generation: generation number for nl80211 dumps. 636 * This number should increase every time the list of stations 637 * changes, i.e. when a station is added or removed, so that 638 * userspace can tell whether it got a consistent snapshot. 639 * @assoc_req_ies: IEs from (Re)Association Request. 640 * This is used only when in AP mode with drivers that do not use 641 * user space MLME/SME implementation. The information is provided for 642 * the cfg80211_new_sta() calls to notify user space of the IEs. 643 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets. 644 * @sta_flags: station flags mask & values 645 * @beacon_loss_count: Number of times beacon loss event has triggered. 646 */ 647 struct station_info { 648 u32 filled; 649 u32 connected_time; 650 u32 inactive_time; 651 u32 rx_bytes; 652 u32 tx_bytes; 653 u16 llid; 654 u16 plid; 655 u8 plink_state; 656 s8 signal; 657 s8 signal_avg; 658 struct rate_info txrate; 659 struct rate_info rxrate; 660 u32 rx_packets; 661 u32 tx_packets; 662 u32 tx_retries; 663 u32 tx_failed; 664 u32 rx_dropped_misc; 665 struct sta_bss_parameters bss_param; 666 struct nl80211_sta_flag_update sta_flags; 667 668 int generation; 669 670 const u8 *assoc_req_ies; 671 size_t assoc_req_ies_len; 672 673 u32 beacon_loss_count; 674 675 /* 676 * Note: Add a new enum station_info_flags value for each new field and 677 * use it to check which fields are initialized. 678 */ 679 }; 680 681 /** 682 * enum monitor_flags - monitor flags 683 * 684 * Monitor interface configuration flags. Note that these must be the bits 685 * according to the nl80211 flags. 686 * 687 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS 688 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP 689 * @MONITOR_FLAG_CONTROL: pass control frames 690 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering 691 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing 692 */ 693 enum monitor_flags { 694 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL, 695 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL, 696 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL, 697 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS, 698 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES, 699 }; 700 701 /** 702 * enum mpath_info_flags - mesh path information flags 703 * 704 * Used by the driver to indicate which info in &struct mpath_info it has filled 705 * in during get_station() or dump_station(). 706 * 707 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled 708 * @MPATH_INFO_SN: @sn filled 709 * @MPATH_INFO_METRIC: @metric filled 710 * @MPATH_INFO_EXPTIME: @exptime filled 711 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled 712 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled 713 * @MPATH_INFO_FLAGS: @flags filled 714 */ 715 enum mpath_info_flags { 716 MPATH_INFO_FRAME_QLEN = BIT(0), 717 MPATH_INFO_SN = BIT(1), 718 MPATH_INFO_METRIC = BIT(2), 719 MPATH_INFO_EXPTIME = BIT(3), 720 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4), 721 MPATH_INFO_DISCOVERY_RETRIES = BIT(5), 722 MPATH_INFO_FLAGS = BIT(6), 723 }; 724 725 /** 726 * struct mpath_info - mesh path information 727 * 728 * Mesh path information filled by driver for get_mpath() and dump_mpath(). 729 * 730 * @filled: bitfield of flags from &enum mpath_info_flags 731 * @frame_qlen: number of queued frames for this destination 732 * @sn: target sequence number 733 * @metric: metric (cost) of this mesh path 734 * @exptime: expiration time for the mesh path from now, in msecs 735 * @flags: mesh path flags 736 * @discovery_timeout: total mesh path discovery timeout, in msecs 737 * @discovery_retries: mesh path discovery retries 738 * @generation: generation number for nl80211 dumps. 739 * This number should increase every time the list of mesh paths 740 * changes, i.e. when a station is added or removed, so that 741 * userspace can tell whether it got a consistent snapshot. 742 */ 743 struct mpath_info { 744 u32 filled; 745 u32 frame_qlen; 746 u32 sn; 747 u32 metric; 748 u32 exptime; 749 u32 discovery_timeout; 750 u8 discovery_retries; 751 u8 flags; 752 753 int generation; 754 }; 755 756 /** 757 * struct bss_parameters - BSS parameters 758 * 759 * Used to change BSS parameters (mainly for AP mode). 760 * 761 * @use_cts_prot: Whether to use CTS protection 762 * (0 = no, 1 = yes, -1 = do not change) 763 * @use_short_preamble: Whether the use of short preambles is allowed 764 * (0 = no, 1 = yes, -1 = do not change) 765 * @use_short_slot_time: Whether the use of short slot time is allowed 766 * (0 = no, 1 = yes, -1 = do not change) 767 * @basic_rates: basic rates in IEEE 802.11 format 768 * (or NULL for no change) 769 * @basic_rates_len: number of basic rates 770 * @ap_isolate: do not forward packets between connected stations 771 * @ht_opmode: HT Operation mode 772 * (u16 = opmode, -1 = do not change) 773 */ 774 struct bss_parameters { 775 int use_cts_prot; 776 int use_short_preamble; 777 int use_short_slot_time; 778 u8 *basic_rates; 779 u8 basic_rates_len; 780 int ap_isolate; 781 int ht_opmode; 782 }; 783 784 /* 785 * struct mesh_config - 802.11s mesh configuration 786 * 787 * These parameters can be changed while the mesh is active. 788 */ 789 struct mesh_config { 790 /* Timeouts in ms */ 791 /* Mesh plink management parameters */ 792 u16 dot11MeshRetryTimeout; 793 u16 dot11MeshConfirmTimeout; 794 u16 dot11MeshHoldingTimeout; 795 u16 dot11MeshMaxPeerLinks; 796 u8 dot11MeshMaxRetries; 797 u8 dot11MeshTTL; 798 /* ttl used in path selection information elements */ 799 u8 element_ttl; 800 bool auto_open_plinks; 801 /* HWMP parameters */ 802 u8 dot11MeshHWMPmaxPREQretries; 803 u32 path_refresh_time; 804 u16 min_discovery_timeout; 805 u32 dot11MeshHWMPactivePathTimeout; 806 u16 dot11MeshHWMPpreqMinInterval; 807 u16 dot11MeshHWMPperrMinInterval; 808 u16 dot11MeshHWMPnetDiameterTraversalTime; 809 u8 dot11MeshHWMPRootMode; 810 u16 dot11MeshHWMPRannInterval; 811 /* This is missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol 812 * set to true only means that the station will announce others it's a 813 * mesh gate, but not necessarily using the gate announcement protocol. 814 * Still keeping the same nomenclature to be in sync with the spec. */ 815 bool dot11MeshGateAnnouncementProtocol; 816 bool dot11MeshForwarding; 817 s32 rssi_threshold; 818 }; 819 820 /** 821 * struct mesh_setup - 802.11s mesh setup configuration 822 * @mesh_id: the mesh ID 823 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes 824 * @path_sel_proto: which path selection protocol to use 825 * @path_metric: which metric to use 826 * @ie: vendor information elements (optional) 827 * @ie_len: length of vendor information elements 828 * @is_authenticated: this mesh requires authentication 829 * @is_secure: this mesh uses security 830 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a] 831 * 832 * These parameters are fixed when the mesh is created. 833 */ 834 struct mesh_setup { 835 const u8 *mesh_id; 836 u8 mesh_id_len; 837 u8 path_sel_proto; 838 u8 path_metric; 839 const u8 *ie; 840 u8 ie_len; 841 bool is_authenticated; 842 bool is_secure; 843 int mcast_rate[IEEE80211_NUM_BANDS]; 844 }; 845 846 /** 847 * struct ieee80211_txq_params - TX queue parameters 848 * @queue: TX queue identifier (NL80211_TXQ_Q_*) 849 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled 850 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range 851 * 1..32767] 852 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range 853 * 1..32767] 854 * @aifs: Arbitration interframe space [0..255] 855 */ 856 struct ieee80211_txq_params { 857 enum nl80211_txq_q queue; 858 u16 txop; 859 u16 cwmin; 860 u16 cwmax; 861 u8 aifs; 862 }; 863 864 /* from net/wireless.h */ 865 struct wiphy; 866 867 /** 868 * DOC: Scanning and BSS list handling 869 * 870 * The scanning process itself is fairly simple, but cfg80211 offers quite 871 * a bit of helper functionality. To start a scan, the scan operation will 872 * be invoked with a scan definition. This scan definition contains the 873 * channels to scan, and the SSIDs to send probe requests for (including the 874 * wildcard, if desired). A passive scan is indicated by having no SSIDs to 875 * probe. Additionally, a scan request may contain extra information elements 876 * that should be added to the probe request. The IEs are guaranteed to be 877 * well-formed, and will not exceed the maximum length the driver advertised 878 * in the wiphy structure. 879 * 880 * When scanning finds a BSS, cfg80211 needs to be notified of that, because 881 * it is responsible for maintaining the BSS list; the driver should not 882 * maintain a list itself. For this notification, various functions exist. 883 * 884 * Since drivers do not maintain a BSS list, there are also a number of 885 * functions to search for a BSS and obtain information about it from the 886 * BSS structure cfg80211 maintains. The BSS list is also made available 887 * to userspace. 888 */ 889 890 /** 891 * struct cfg80211_ssid - SSID description 892 * @ssid: the SSID 893 * @ssid_len: length of the ssid 894 */ 895 struct cfg80211_ssid { 896 u8 ssid[IEEE80211_MAX_SSID_LEN]; 897 u8 ssid_len; 898 }; 899 900 /** 901 * struct cfg80211_scan_request - scan request description 902 * 903 * @ssids: SSIDs to scan for (active scan only) 904 * @n_ssids: number of SSIDs 905 * @channels: channels to scan on. 906 * @n_channels: total number of channels to scan 907 * @ie: optional information element(s) to add into Probe Request or %NULL 908 * @ie_len: length of ie in octets 909 * @rates: bitmap of rates to advertise for each band 910 * @wiphy: the wiphy this was for 911 * @dev: the interface 912 * @aborted: (internal) scan request was notified as aborted 913 * @no_cck: used to send probe requests at non CCK rate in 2GHz band 914 */ 915 struct cfg80211_scan_request { 916 struct cfg80211_ssid *ssids; 917 int n_ssids; 918 u32 n_channels; 919 const u8 *ie; 920 size_t ie_len; 921 922 u32 rates[IEEE80211_NUM_BANDS]; 923 924 /* internal */ 925 struct wiphy *wiphy; 926 struct net_device *dev; 927 bool aborted; 928 bool no_cck; 929 930 /* keep last */ 931 struct ieee80211_channel *channels[0]; 932 }; 933 934 /** 935 * struct cfg80211_match_set - sets of attributes to match 936 * 937 * @ssid: SSID to be matched 938 */ 939 struct cfg80211_match_set { 940 struct cfg80211_ssid ssid; 941 }; 942 943 /** 944 * struct cfg80211_sched_scan_request - scheduled scan request description 945 * 946 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans) 947 * @n_ssids: number of SSIDs 948 * @n_channels: total number of channels to scan 949 * @interval: interval between each scheduled scan cycle 950 * @ie: optional information element(s) to add into Probe Request or %NULL 951 * @ie_len: length of ie in octets 952 * @match_sets: sets of parameters to be matched for a scan result 953 * entry to be considered valid and to be passed to the host 954 * (others are filtered out). 955 * If ommited, all results are passed. 956 * @n_match_sets: number of match sets 957 * @wiphy: the wiphy this was for 958 * @dev: the interface 959 * @channels: channels to scan 960 */ 961 struct cfg80211_sched_scan_request { 962 struct cfg80211_ssid *ssids; 963 int n_ssids; 964 u32 n_channels; 965 u32 interval; 966 const u8 *ie; 967 size_t ie_len; 968 struct cfg80211_match_set *match_sets; 969 int n_match_sets; 970 971 /* internal */ 972 struct wiphy *wiphy; 973 struct net_device *dev; 974 975 /* keep last */ 976 struct ieee80211_channel *channels[0]; 977 }; 978 979 /** 980 * enum cfg80211_signal_type - signal type 981 * 982 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available 983 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm) 984 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100 985 */ 986 enum cfg80211_signal_type { 987 CFG80211_SIGNAL_TYPE_NONE, 988 CFG80211_SIGNAL_TYPE_MBM, 989 CFG80211_SIGNAL_TYPE_UNSPEC, 990 }; 991 992 /** 993 * struct cfg80211_bss - BSS description 994 * 995 * This structure describes a BSS (which may also be a mesh network) 996 * for use in scan results and similar. 997 * 998 * @channel: channel this BSS is on 999 * @bssid: BSSID of the BSS 1000 * @tsf: timestamp of last received update 1001 * @beacon_interval: the beacon interval as from the frame 1002 * @capability: the capability field in host byte order 1003 * @information_elements: the information elements (Note that there 1004 * is no guarantee that these are well-formed!); this is a pointer to 1005 * either the beacon_ies or proberesp_ies depending on whether Probe 1006 * Response frame has been received 1007 * @len_information_elements: total length of the information elements 1008 * @beacon_ies: the information elements from the last Beacon frame 1009 * @len_beacon_ies: total length of the beacon_ies 1010 * @proberesp_ies: the information elements from the last Probe Response frame 1011 * @len_proberesp_ies: total length of the proberesp_ies 1012 * @signal: signal strength value (type depends on the wiphy's signal_type) 1013 * @free_priv: function pointer to free private data 1014 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes 1015 */ 1016 struct cfg80211_bss { 1017 struct ieee80211_channel *channel; 1018 1019 u8 bssid[ETH_ALEN]; 1020 u64 tsf; 1021 u16 beacon_interval; 1022 u16 capability; 1023 u8 *information_elements; 1024 size_t len_information_elements; 1025 u8 *beacon_ies; 1026 size_t len_beacon_ies; 1027 u8 *proberesp_ies; 1028 size_t len_proberesp_ies; 1029 1030 s32 signal; 1031 1032 void (*free_priv)(struct cfg80211_bss *bss); 1033 u8 priv[0] __attribute__((__aligned__(sizeof(void *)))); 1034 }; 1035 1036 /** 1037 * ieee80211_bss_get_ie - find IE with given ID 1038 * @bss: the bss to search 1039 * @ie: the IE ID 1040 * Returns %NULL if not found. 1041 */ 1042 const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie); 1043 1044 1045 /** 1046 * struct cfg80211_auth_request - Authentication request data 1047 * 1048 * This structure provides information needed to complete IEEE 802.11 1049 * authentication. 1050 * 1051 * @bss: The BSS to authenticate with. 1052 * @auth_type: Authentication type (algorithm) 1053 * @ie: Extra IEs to add to Authentication frame or %NULL 1054 * @ie_len: Length of ie buffer in octets 1055 * @key_len: length of WEP key for shared key authentication 1056 * @key_idx: index of WEP key for shared key authentication 1057 * @key: WEP key for shared key authentication 1058 */ 1059 struct cfg80211_auth_request { 1060 struct cfg80211_bss *bss; 1061 const u8 *ie; 1062 size_t ie_len; 1063 enum nl80211_auth_type auth_type; 1064 const u8 *key; 1065 u8 key_len, key_idx; 1066 }; 1067 1068 /** 1069 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association. 1070 * 1071 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n) 1072 */ 1073 enum cfg80211_assoc_req_flags { 1074 ASSOC_REQ_DISABLE_HT = BIT(0), 1075 }; 1076 1077 /** 1078 * struct cfg80211_assoc_request - (Re)Association request data 1079 * 1080 * This structure provides information needed to complete IEEE 802.11 1081 * (re)association. 1082 * @bss: The BSS to associate with. If the call is successful the driver 1083 * is given a reference that it must release, normally via a call to 1084 * cfg80211_send_rx_assoc(), or, if association timed out, with a 1085 * call to cfg80211_put_bss() (in addition to calling 1086 * cfg80211_send_assoc_timeout()) 1087 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL 1088 * @ie_len: Length of ie buffer in octets 1089 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association 1090 * @crypto: crypto settings 1091 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame 1092 * @flags: See &enum cfg80211_assoc_req_flags 1093 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask 1094 * will be used in ht_capa. Un-supported values will be ignored. 1095 * @ht_capa_mask: The bits of ht_capa which are to be used. 1096 */ 1097 struct cfg80211_assoc_request { 1098 struct cfg80211_bss *bss; 1099 const u8 *ie, *prev_bssid; 1100 size_t ie_len; 1101 struct cfg80211_crypto_settings crypto; 1102 bool use_mfp; 1103 u32 flags; 1104 struct ieee80211_ht_cap ht_capa; 1105 struct ieee80211_ht_cap ht_capa_mask; 1106 }; 1107 1108 /** 1109 * struct cfg80211_deauth_request - Deauthentication request data 1110 * 1111 * This structure provides information needed to complete IEEE 802.11 1112 * deauthentication. 1113 * 1114 * @bssid: the BSSID of the BSS to deauthenticate from 1115 * @ie: Extra IEs to add to Deauthentication frame or %NULL 1116 * @ie_len: Length of ie buffer in octets 1117 * @reason_code: The reason code for the deauthentication 1118 */ 1119 struct cfg80211_deauth_request { 1120 const u8 *bssid; 1121 const u8 *ie; 1122 size_t ie_len; 1123 u16 reason_code; 1124 }; 1125 1126 /** 1127 * struct cfg80211_disassoc_request - Disassociation request data 1128 * 1129 * This structure provides information needed to complete IEEE 802.11 1130 * disassocation. 1131 * 1132 * @bss: the BSS to disassociate from 1133 * @ie: Extra IEs to add to Disassociation frame or %NULL 1134 * @ie_len: Length of ie buffer in octets 1135 * @reason_code: The reason code for the disassociation 1136 * @local_state_change: This is a request for a local state only, i.e., no 1137 * Disassociation frame is to be transmitted. 1138 */ 1139 struct cfg80211_disassoc_request { 1140 struct cfg80211_bss *bss; 1141 const u8 *ie; 1142 size_t ie_len; 1143 u16 reason_code; 1144 bool local_state_change; 1145 }; 1146 1147 /** 1148 * struct cfg80211_ibss_params - IBSS parameters 1149 * 1150 * This structure defines the IBSS parameters for the join_ibss() 1151 * method. 1152 * 1153 * @ssid: The SSID, will always be non-null. 1154 * @ssid_len: The length of the SSID, will always be non-zero. 1155 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not 1156 * search for IBSSs with a different BSSID. 1157 * @channel: The channel to use if no IBSS can be found to join. 1158 * @channel_type: channel type (HT mode) 1159 * @channel_fixed: The channel should be fixed -- do not search for 1160 * IBSSs to join on other channels. 1161 * @ie: information element(s) to include in the beacon 1162 * @ie_len: length of that 1163 * @beacon_interval: beacon interval to use 1164 * @privacy: this is a protected network, keys will be configured 1165 * after joining 1166 * @control_port: whether user space controls IEEE 802.1X port, i.e., 1167 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is 1168 * required to assume that the port is unauthorized until authorized by 1169 * user space. Otherwise, port is marked authorized by default. 1170 * @basic_rates: bitmap of basic rates to use when creating the IBSS 1171 * @mcast_rate: per-band multicast rate index + 1 (0: disabled) 1172 */ 1173 struct cfg80211_ibss_params { 1174 u8 *ssid; 1175 u8 *bssid; 1176 struct ieee80211_channel *channel; 1177 enum nl80211_channel_type channel_type; 1178 u8 *ie; 1179 u8 ssid_len, ie_len; 1180 u16 beacon_interval; 1181 u32 basic_rates; 1182 bool channel_fixed; 1183 bool privacy; 1184 bool control_port; 1185 int mcast_rate[IEEE80211_NUM_BANDS]; 1186 }; 1187 1188 /** 1189 * struct cfg80211_connect_params - Connection parameters 1190 * 1191 * This structure provides information needed to complete IEEE 802.11 1192 * authentication and association. 1193 * 1194 * @channel: The channel to use or %NULL if not specified (auto-select based 1195 * on scan results) 1196 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan 1197 * results) 1198 * @ssid: SSID 1199 * @ssid_len: Length of ssid in octets 1200 * @auth_type: Authentication type (algorithm) 1201 * @ie: IEs for association request 1202 * @ie_len: Length of assoc_ie in octets 1203 * @privacy: indicates whether privacy-enabled APs should be used 1204 * @crypto: crypto settings 1205 * @key_len: length of WEP key for shared key authentication 1206 * @key_idx: index of WEP key for shared key authentication 1207 * @key: WEP key for shared key authentication 1208 * @flags: See &enum cfg80211_assoc_req_flags 1209 * @bg_scan_period: Background scan period in seconds 1210 * or -1 to indicate that default value is to be used. 1211 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask 1212 * will be used in ht_capa. Un-supported values will be ignored. 1213 * @ht_capa_mask: The bits of ht_capa which are to be used. 1214 */ 1215 struct cfg80211_connect_params { 1216 struct ieee80211_channel *channel; 1217 u8 *bssid; 1218 u8 *ssid; 1219 size_t ssid_len; 1220 enum nl80211_auth_type auth_type; 1221 u8 *ie; 1222 size_t ie_len; 1223 bool privacy; 1224 struct cfg80211_crypto_settings crypto; 1225 const u8 *key; 1226 u8 key_len, key_idx; 1227 u32 flags; 1228 int bg_scan_period; 1229 struct ieee80211_ht_cap ht_capa; 1230 struct ieee80211_ht_cap ht_capa_mask; 1231 }; 1232 1233 /** 1234 * enum wiphy_params_flags - set_wiphy_params bitfield values 1235 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed 1236 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed 1237 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed 1238 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed 1239 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed 1240 */ 1241 enum wiphy_params_flags { 1242 WIPHY_PARAM_RETRY_SHORT = 1 << 0, 1243 WIPHY_PARAM_RETRY_LONG = 1 << 1, 1244 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2, 1245 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3, 1246 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4, 1247 }; 1248 1249 /* 1250 * cfg80211_bitrate_mask - masks for bitrate control 1251 */ 1252 struct cfg80211_bitrate_mask { 1253 struct { 1254 u32 legacy; 1255 u8 mcs[IEEE80211_HT_MCS_MASK_LEN]; 1256 } control[IEEE80211_NUM_BANDS]; 1257 }; 1258 /** 1259 * struct cfg80211_pmksa - PMK Security Association 1260 * 1261 * This structure is passed to the set/del_pmksa() method for PMKSA 1262 * caching. 1263 * 1264 * @bssid: The AP's BSSID. 1265 * @pmkid: The PMK material itself. 1266 */ 1267 struct cfg80211_pmksa { 1268 u8 *bssid; 1269 u8 *pmkid; 1270 }; 1271 1272 /** 1273 * struct cfg80211_wowlan_trig_pkt_pattern - packet pattern 1274 * @mask: bitmask where to match pattern and where to ignore bytes, 1275 * one bit per byte, in same format as nl80211 1276 * @pattern: bytes to match where bitmask is 1 1277 * @pattern_len: length of pattern (in bytes) 1278 * 1279 * Internal note: @mask and @pattern are allocated in one chunk of 1280 * memory, free @mask only! 1281 */ 1282 struct cfg80211_wowlan_trig_pkt_pattern { 1283 u8 *mask, *pattern; 1284 int pattern_len; 1285 }; 1286 1287 /** 1288 * struct cfg80211_wowlan - Wake on Wireless-LAN support info 1289 * 1290 * This structure defines the enabled WoWLAN triggers for the device. 1291 * @any: wake up on any activity -- special trigger if device continues 1292 * operating as normal during suspend 1293 * @disconnect: wake up if getting disconnected 1294 * @magic_pkt: wake up on receiving magic packet 1295 * @patterns: wake up on receiving packet matching a pattern 1296 * @n_patterns: number of patterns 1297 * @gtk_rekey_failure: wake up on GTK rekey failure 1298 * @eap_identity_req: wake up on EAP identity request packet 1299 * @four_way_handshake: wake up on 4-way handshake 1300 * @rfkill_release: wake up when rfkill is released 1301 */ 1302 struct cfg80211_wowlan { 1303 bool any, disconnect, magic_pkt, gtk_rekey_failure, 1304 eap_identity_req, four_way_handshake, 1305 rfkill_release; 1306 struct cfg80211_wowlan_trig_pkt_pattern *patterns; 1307 int n_patterns; 1308 }; 1309 1310 /** 1311 * struct cfg80211_gtk_rekey_data - rekey data 1312 * @kek: key encryption key 1313 * @kck: key confirmation key 1314 * @replay_ctr: replay counter 1315 */ 1316 struct cfg80211_gtk_rekey_data { 1317 u8 kek[NL80211_KEK_LEN]; 1318 u8 kck[NL80211_KCK_LEN]; 1319 u8 replay_ctr[NL80211_REPLAY_CTR_LEN]; 1320 }; 1321 1322 /** 1323 * struct cfg80211_ops - backend description for wireless configuration 1324 * 1325 * This struct is registered by fullmac card drivers and/or wireless stacks 1326 * in order to handle configuration requests on their interfaces. 1327 * 1328 * All callbacks except where otherwise noted should return 0 1329 * on success or a negative error code. 1330 * 1331 * All operations are currently invoked under rtnl for consistency with the 1332 * wireless extensions but this is subject to reevaluation as soon as this 1333 * code is used more widely and we have a first user without wext. 1334 * 1335 * @suspend: wiphy device needs to be suspended. The variable @wow will 1336 * be %NULL or contain the enabled Wake-on-Wireless triggers that are 1337 * configured for the device. 1338 * @resume: wiphy device needs to be resumed 1339 * 1340 * @add_virtual_intf: create a new virtual interface with the given name, 1341 * must set the struct wireless_dev's iftype. Beware: You must create 1342 * the new netdev in the wiphy's network namespace! Returns the netdev, 1343 * or an ERR_PTR. 1344 * 1345 * @del_virtual_intf: remove the virtual interface determined by ifindex. 1346 * 1347 * @change_virtual_intf: change type/configuration of virtual interface, 1348 * keep the struct wireless_dev's iftype updated. 1349 * 1350 * @add_key: add a key with the given parameters. @mac_addr will be %NULL 1351 * when adding a group key. 1352 * 1353 * @get_key: get information about the key with the given parameters. 1354 * @mac_addr will be %NULL when requesting information for a group 1355 * key. All pointers given to the @callback function need not be valid 1356 * after it returns. This function should return an error if it is 1357 * not possible to retrieve the key, -ENOENT if it doesn't exist. 1358 * 1359 * @del_key: remove a key given the @mac_addr (%NULL for a group key) 1360 * and @key_index, return -ENOENT if the key doesn't exist. 1361 * 1362 * @set_default_key: set the default key on an interface 1363 * 1364 * @set_default_mgmt_key: set the default management frame key on an interface 1365 * 1366 * @set_rekey_data: give the data necessary for GTK rekeying to the driver 1367 * 1368 * @start_ap: Start acting in AP mode defined by the parameters. 1369 * @change_beacon: Change the beacon parameters for an access point mode 1370 * interface. This should reject the call when AP mode wasn't started. 1371 * @stop_ap: Stop being an AP, including stopping beaconing. 1372 * 1373 * @add_station: Add a new station. 1374 * @del_station: Remove a station; @mac may be NULL to remove all stations. 1375 * @change_station: Modify a given station. Note that flags changes are not much 1376 * validated in cfg80211, in particular the auth/assoc/authorized flags 1377 * might come to the driver in invalid combinations -- make sure to check 1378 * them, also against the existing state! Also, supported_rates changes are 1379 * not checked in station mode -- drivers need to reject (or ignore) them 1380 * for anything but TDLS peers. 1381 * @get_station: get station information for the station identified by @mac 1382 * @dump_station: dump station callback -- resume dump at index @idx 1383 * 1384 * @add_mpath: add a fixed mesh path 1385 * @del_mpath: delete a given mesh path 1386 * @change_mpath: change a given mesh path 1387 * @get_mpath: get a mesh path for the given parameters 1388 * @dump_mpath: dump mesh path callback -- resume dump at index @idx 1389 * @join_mesh: join the mesh network with the specified parameters 1390 * @leave_mesh: leave the current mesh network 1391 * 1392 * @get_mesh_config: Get the current mesh configuration 1393 * 1394 * @update_mesh_config: Update mesh parameters on a running mesh. 1395 * The mask is a bitfield which tells us which parameters to 1396 * set, and which to leave alone. 1397 * 1398 * @change_bss: Modify parameters for a given BSS. 1399 * 1400 * @set_txq_params: Set TX queue parameters 1401 * 1402 * @set_channel: Set channel for a given wireless interface. Some devices 1403 * may support multi-channel operation (by channel hopping) so cfg80211 1404 * doesn't verify much. Note, however, that the passed netdev may be 1405 * %NULL as well if the user requested changing the channel for the 1406 * device itself, or for a monitor interface. 1407 * @get_channel: Get the current operating channel, should return %NULL if 1408 * there's no single defined operating channel if for example the 1409 * device implements channel hopping for multi-channel virtual interfaces. 1410 * 1411 * @scan: Request to do a scan. If returning zero, the scan request is given 1412 * the driver, and will be valid until passed to cfg80211_scan_done(). 1413 * For scan results, call cfg80211_inform_bss(); you can call this outside 1414 * the scan/scan_done bracket too. 1415 * 1416 * @auth: Request to authenticate with the specified peer 1417 * @assoc: Request to (re)associate with the specified peer 1418 * @deauth: Request to deauthenticate from the specified peer 1419 * @disassoc: Request to disassociate from the specified peer 1420 * 1421 * @connect: Connect to the ESS with the specified parameters. When connected, 1422 * call cfg80211_connect_result() with status code %WLAN_STATUS_SUCCESS. 1423 * If the connection fails for some reason, call cfg80211_connect_result() 1424 * with the status from the AP. 1425 * @disconnect: Disconnect from the BSS/ESS. 1426 * 1427 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call 1428 * cfg80211_ibss_joined(), also call that function when changing BSSID due 1429 * to a merge. 1430 * @leave_ibss: Leave the IBSS. 1431 * 1432 * @set_wiphy_params: Notify that wiphy parameters have changed; 1433 * @changed bitfield (see &enum wiphy_params_flags) describes which values 1434 * have changed. The actual parameter values are available in 1435 * struct wiphy. If returning an error, no value should be changed. 1436 * 1437 * @set_tx_power: set the transmit power according to the parameters, 1438 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). 1439 * @get_tx_power: store the current TX power into the dbm variable; 1440 * return 0 if successful 1441 * 1442 * @set_wds_peer: set the WDS peer for a WDS interface 1443 * 1444 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting 1445 * functions to adjust rfkill hw state 1446 * 1447 * @dump_survey: get site survey information. 1448 * 1449 * @remain_on_channel: Request the driver to remain awake on the specified 1450 * channel for the specified duration to complete an off-channel 1451 * operation (e.g., public action frame exchange). When the driver is 1452 * ready on the requested channel, it must indicate this with an event 1453 * notification by calling cfg80211_ready_on_channel(). 1454 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation. 1455 * This allows the operation to be terminated prior to timeout based on 1456 * the duration value. 1457 * @mgmt_tx: Transmit a management frame. 1458 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management 1459 * frame on another channel 1460 * 1461 * @testmode_cmd: run a test mode command 1462 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be 1463 * used by the function, but 0 and 1 must not be touched. Additionally, 1464 * return error codes other than -ENOBUFS and -ENOENT will terminate the 1465 * dump and return to userspace with an error, so be careful. If any data 1466 * was passed in from userspace then the data/len arguments will be present 1467 * and point to the data contained in %NL80211_ATTR_TESTDATA. 1468 * 1469 * @set_bitrate_mask: set the bitrate mask configuration 1470 * 1471 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac 1472 * devices running firmwares capable of generating the (re) association 1473 * RSN IE. It allows for faster roaming between WPA2 BSSIDs. 1474 * @del_pmksa: Delete a cached PMKID. 1475 * @flush_pmksa: Flush all cached PMKIDs. 1476 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1 1477 * allows the driver to adjust the dynamic ps timeout value. 1478 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold. 1479 * @sched_scan_start: Tell the driver to start a scheduled scan. 1480 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled 1481 * scan. The driver_initiated flag specifies whether the driver 1482 * itself has informed that the scan has stopped. 1483 * 1484 * @mgmt_frame_register: Notify driver that a management frame type was 1485 * registered. Note that this callback may not sleep, and cannot run 1486 * concurrently with itself. 1487 * 1488 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device. 1489 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may 1490 * reject TX/RX mask combinations they cannot support by returning -EINVAL 1491 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX). 1492 * 1493 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant). 1494 * 1495 * @set_ringparam: Set tx and rx ring sizes. 1496 * 1497 * @get_ringparam: Get tx and rx ring current and maximum sizes. 1498 * 1499 * @tdls_mgmt: Transmit a TDLS management frame. 1500 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup). 1501 * 1502 * @probe_client: probe an associated client, must return a cookie that it 1503 * later passes to cfg80211_probe_status(). 1504 * 1505 * @set_noack_map: Set the NoAck Map for the TIDs. 1506 */ 1507 struct cfg80211_ops { 1508 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow); 1509 int (*resume)(struct wiphy *wiphy); 1510 1511 struct net_device * (*add_virtual_intf)(struct wiphy *wiphy, 1512 char *name, 1513 enum nl80211_iftype type, 1514 u32 *flags, 1515 struct vif_params *params); 1516 int (*del_virtual_intf)(struct wiphy *wiphy, struct net_device *dev); 1517 int (*change_virtual_intf)(struct wiphy *wiphy, 1518 struct net_device *dev, 1519 enum nl80211_iftype type, u32 *flags, 1520 struct vif_params *params); 1521 1522 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev, 1523 u8 key_index, bool pairwise, const u8 *mac_addr, 1524 struct key_params *params); 1525 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev, 1526 u8 key_index, bool pairwise, const u8 *mac_addr, 1527 void *cookie, 1528 void (*callback)(void *cookie, struct key_params*)); 1529 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev, 1530 u8 key_index, bool pairwise, const u8 *mac_addr); 1531 int (*set_default_key)(struct wiphy *wiphy, 1532 struct net_device *netdev, 1533 u8 key_index, bool unicast, bool multicast); 1534 int (*set_default_mgmt_key)(struct wiphy *wiphy, 1535 struct net_device *netdev, 1536 u8 key_index); 1537 1538 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev, 1539 struct cfg80211_ap_settings *settings); 1540 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev, 1541 struct cfg80211_beacon_data *info); 1542 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev); 1543 1544 1545 int (*add_station)(struct wiphy *wiphy, struct net_device *dev, 1546 u8 *mac, struct station_parameters *params); 1547 int (*del_station)(struct wiphy *wiphy, struct net_device *dev, 1548 u8 *mac); 1549 int (*change_station)(struct wiphy *wiphy, struct net_device *dev, 1550 u8 *mac, struct station_parameters *params); 1551 int (*get_station)(struct wiphy *wiphy, struct net_device *dev, 1552 u8 *mac, struct station_info *sinfo); 1553 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev, 1554 int idx, u8 *mac, struct station_info *sinfo); 1555 1556 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev, 1557 u8 *dst, u8 *next_hop); 1558 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev, 1559 u8 *dst); 1560 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev, 1561 u8 *dst, u8 *next_hop); 1562 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev, 1563 u8 *dst, u8 *next_hop, 1564 struct mpath_info *pinfo); 1565 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev, 1566 int idx, u8 *dst, u8 *next_hop, 1567 struct mpath_info *pinfo); 1568 int (*get_mesh_config)(struct wiphy *wiphy, 1569 struct net_device *dev, 1570 struct mesh_config *conf); 1571 int (*update_mesh_config)(struct wiphy *wiphy, 1572 struct net_device *dev, u32 mask, 1573 const struct mesh_config *nconf); 1574 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev, 1575 const struct mesh_config *conf, 1576 const struct mesh_setup *setup); 1577 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev); 1578 1579 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev, 1580 struct bss_parameters *params); 1581 1582 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev, 1583 struct ieee80211_txq_params *params); 1584 1585 int (*set_channel)(struct wiphy *wiphy, struct net_device *dev, 1586 struct ieee80211_channel *chan, 1587 enum nl80211_channel_type channel_type); 1588 1589 int (*scan)(struct wiphy *wiphy, struct net_device *dev, 1590 struct cfg80211_scan_request *request); 1591 1592 int (*auth)(struct wiphy *wiphy, struct net_device *dev, 1593 struct cfg80211_auth_request *req); 1594 int (*assoc)(struct wiphy *wiphy, struct net_device *dev, 1595 struct cfg80211_assoc_request *req); 1596 int (*deauth)(struct wiphy *wiphy, struct net_device *dev, 1597 struct cfg80211_deauth_request *req); 1598 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev, 1599 struct cfg80211_disassoc_request *req); 1600 1601 int (*connect)(struct wiphy *wiphy, struct net_device *dev, 1602 struct cfg80211_connect_params *sme); 1603 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev, 1604 u16 reason_code); 1605 1606 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev, 1607 struct cfg80211_ibss_params *params); 1608 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev); 1609 1610 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed); 1611 1612 int (*set_tx_power)(struct wiphy *wiphy, 1613 enum nl80211_tx_power_setting type, int mbm); 1614 int (*get_tx_power)(struct wiphy *wiphy, int *dbm); 1615 1616 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev, 1617 const u8 *addr); 1618 1619 void (*rfkill_poll)(struct wiphy *wiphy); 1620 1621 #ifdef CONFIG_NL80211_TESTMODE 1622 int (*testmode_cmd)(struct wiphy *wiphy, void *data, int len); 1623 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb, 1624 struct netlink_callback *cb, 1625 void *data, int len); 1626 #endif 1627 1628 int (*set_bitrate_mask)(struct wiphy *wiphy, 1629 struct net_device *dev, 1630 const u8 *peer, 1631 const struct cfg80211_bitrate_mask *mask); 1632 1633 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev, 1634 int idx, struct survey_info *info); 1635 1636 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev, 1637 struct cfg80211_pmksa *pmksa); 1638 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev, 1639 struct cfg80211_pmksa *pmksa); 1640 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev); 1641 1642 int (*remain_on_channel)(struct wiphy *wiphy, 1643 struct net_device *dev, 1644 struct ieee80211_channel *chan, 1645 enum nl80211_channel_type channel_type, 1646 unsigned int duration, 1647 u64 *cookie); 1648 int (*cancel_remain_on_channel)(struct wiphy *wiphy, 1649 struct net_device *dev, 1650 u64 cookie); 1651 1652 int (*mgmt_tx)(struct wiphy *wiphy, struct net_device *dev, 1653 struct ieee80211_channel *chan, bool offchan, 1654 enum nl80211_channel_type channel_type, 1655 bool channel_type_valid, unsigned int wait, 1656 const u8 *buf, size_t len, bool no_cck, 1657 bool dont_wait_for_ack, u64 *cookie); 1658 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy, 1659 struct net_device *dev, 1660 u64 cookie); 1661 1662 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev, 1663 bool enabled, int timeout); 1664 1665 int (*set_cqm_rssi_config)(struct wiphy *wiphy, 1666 struct net_device *dev, 1667 s32 rssi_thold, u32 rssi_hyst); 1668 1669 void (*mgmt_frame_register)(struct wiphy *wiphy, 1670 struct net_device *dev, 1671 u16 frame_type, bool reg); 1672 1673 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant); 1674 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant); 1675 1676 int (*set_ringparam)(struct wiphy *wiphy, u32 tx, u32 rx); 1677 void (*get_ringparam)(struct wiphy *wiphy, 1678 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max); 1679 1680 int (*sched_scan_start)(struct wiphy *wiphy, 1681 struct net_device *dev, 1682 struct cfg80211_sched_scan_request *request); 1683 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev); 1684 1685 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev, 1686 struct cfg80211_gtk_rekey_data *data); 1687 1688 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev, 1689 u8 *peer, u8 action_code, u8 dialog_token, 1690 u16 status_code, const u8 *buf, size_t len); 1691 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev, 1692 u8 *peer, enum nl80211_tdls_operation oper); 1693 1694 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev, 1695 const u8 *peer, u64 *cookie); 1696 1697 int (*set_noack_map)(struct wiphy *wiphy, 1698 struct net_device *dev, 1699 u16 noack_map); 1700 1701 struct ieee80211_channel *(*get_channel)(struct wiphy *wiphy); 1702 }; 1703 1704 /* 1705 * wireless hardware and networking interfaces structures 1706 * and registration/helper functions 1707 */ 1708 1709 /** 1710 * enum wiphy_flags - wiphy capability flags 1711 * 1712 * @WIPHY_FLAG_CUSTOM_REGULATORY: tells us the driver for this device 1713 * has its own custom regulatory domain and cannot identify the 1714 * ISO / IEC 3166 alpha2 it belongs to. When this is enabled 1715 * we will disregard the first regulatory hint (when the 1716 * initiator is %REGDOM_SET_BY_CORE). 1717 * @WIPHY_FLAG_STRICT_REGULATORY: tells us the driver for this device will 1718 * ignore regulatory domain settings until it gets its own regulatory 1719 * domain via its regulatory_hint() unless the regulatory hint is 1720 * from a country IE. After its gets its own regulatory domain it will 1721 * only allow further regulatory domain settings to further enhance 1722 * compliance. For example if channel 13 and 14 are disabled by this 1723 * regulatory domain no user regulatory domain can enable these channels 1724 * at a later time. This can be used for devices which do not have 1725 * calibration information guaranteed for frequencies or settings 1726 * outside of its regulatory domain. If used in combination with 1727 * WIPHY_FLAG_CUSTOM_REGULATORY the inspected country IE power settings 1728 * will be followed. 1729 * @WIPHY_FLAG_DISABLE_BEACON_HINTS: enable this if your driver needs to ensure 1730 * that passive scan flags and beaconing flags may not be lifted by 1731 * cfg80211 due to regulatory beacon hints. For more information on beacon 1732 * hints read the documenation for regulatory_hint_found_beacon() 1733 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this 1734 * wiphy at all 1735 * @WIPHY_FLAG_ENFORCE_COMBINATIONS: Set this flag to enforce interface 1736 * combinations for this device. This flag is used for backward 1737 * compatibility only until all drivers advertise combinations and 1738 * they will always be enforced. 1739 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled 1740 * by default -- this flag will be set depending on the kernel's default 1741 * on wiphy_new(), but can be changed by the driver if it has a good 1742 * reason to override the default 1743 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station 1744 * on a VLAN interface) 1745 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station 1746 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the 1747 * control port protocol ethertype. The device also honours the 1748 * control_port_no_encrypt flag. 1749 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN. 1750 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing 1751 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH. 1752 * @WIPHY_FLAG_SUPPORTS_SCHED_SCAN: The device supports scheduled scans. 1753 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the 1754 * firmware. 1755 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP. 1756 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation. 1757 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z) 1758 * link setup/discovery operations internally. Setup, discovery and 1759 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT 1760 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be 1761 * used for asking the driver/firmware to perform a TDLS operation. 1762 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME 1763 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes 1764 * when there are virtual interfaces in AP mode by calling 1765 * cfg80211_report_obss_beacon(). 1766 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device 1767 * responds to probe-requests in hardware. 1768 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX. 1769 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call. 1770 */ 1771 enum wiphy_flags { 1772 WIPHY_FLAG_CUSTOM_REGULATORY = BIT(0), 1773 WIPHY_FLAG_STRICT_REGULATORY = BIT(1), 1774 WIPHY_FLAG_DISABLE_BEACON_HINTS = BIT(2), 1775 WIPHY_FLAG_NETNS_OK = BIT(3), 1776 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4), 1777 WIPHY_FLAG_4ADDR_AP = BIT(5), 1778 WIPHY_FLAG_4ADDR_STATION = BIT(6), 1779 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7), 1780 WIPHY_FLAG_IBSS_RSN = BIT(8), 1781 WIPHY_FLAG_MESH_AUTH = BIT(10), 1782 WIPHY_FLAG_SUPPORTS_SCHED_SCAN = BIT(11), 1783 WIPHY_FLAG_ENFORCE_COMBINATIONS = BIT(12), 1784 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13), 1785 WIPHY_FLAG_AP_UAPSD = BIT(14), 1786 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15), 1787 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16), 1788 WIPHY_FLAG_HAVE_AP_SME = BIT(17), 1789 WIPHY_FLAG_REPORTS_OBSS = BIT(18), 1790 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19), 1791 WIPHY_FLAG_OFFCHAN_TX = BIT(20), 1792 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21), 1793 }; 1794 1795 /** 1796 * struct ieee80211_iface_limit - limit on certain interface types 1797 * @max: maximum number of interfaces of these types 1798 * @types: interface types (bits) 1799 */ 1800 struct ieee80211_iface_limit { 1801 u16 max; 1802 u16 types; 1803 }; 1804 1805 /** 1806 * struct ieee80211_iface_combination - possible interface combination 1807 * @limits: limits for the given interface types 1808 * @n_limits: number of limitations 1809 * @num_different_channels: can use up to this many different channels 1810 * @max_interfaces: maximum number of interfaces in total allowed in this 1811 * group 1812 * @beacon_int_infra_match: In this combination, the beacon intervals 1813 * between infrastructure and AP types must match. This is required 1814 * only in special cases. 1815 * 1816 * These examples can be expressed as follows: 1817 * 1818 * Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total: 1819 * 1820 * struct ieee80211_iface_limit limits1[] = { 1821 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), }, 1822 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, }, 1823 * }; 1824 * struct ieee80211_iface_combination combination1 = { 1825 * .limits = limits1, 1826 * .n_limits = ARRAY_SIZE(limits1), 1827 * .max_interfaces = 2, 1828 * .beacon_int_infra_match = true, 1829 * }; 1830 * 1831 * 1832 * Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total: 1833 * 1834 * struct ieee80211_iface_limit limits2[] = { 1835 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) | 1836 * BIT(NL80211_IFTYPE_P2P_GO), }, 1837 * }; 1838 * struct ieee80211_iface_combination combination2 = { 1839 * .limits = limits2, 1840 * .n_limits = ARRAY_SIZE(limits2), 1841 * .max_interfaces = 8, 1842 * .num_different_channels = 1, 1843 * }; 1844 * 1845 * 1846 * Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total. 1847 * This allows for an infrastructure connection and three P2P connections. 1848 * 1849 * struct ieee80211_iface_limit limits3[] = { 1850 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), }, 1851 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) | 1852 * BIT(NL80211_IFTYPE_P2P_CLIENT), }, 1853 * }; 1854 * struct ieee80211_iface_combination combination3 = { 1855 * .limits = limits3, 1856 * .n_limits = ARRAY_SIZE(limits3), 1857 * .max_interfaces = 4, 1858 * .num_different_channels = 2, 1859 * }; 1860 */ 1861 struct ieee80211_iface_combination { 1862 const struct ieee80211_iface_limit *limits; 1863 u32 num_different_channels; 1864 u16 max_interfaces; 1865 u8 n_limits; 1866 bool beacon_int_infra_match; 1867 }; 1868 1869 struct mac_address { 1870 u8 addr[ETH_ALEN]; 1871 }; 1872 1873 struct ieee80211_txrx_stypes { 1874 u16 tx, rx; 1875 }; 1876 1877 /** 1878 * enum wiphy_wowlan_support_flags - WoWLAN support flags 1879 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any" 1880 * trigger that keeps the device operating as-is and 1881 * wakes up the host on any activity, for example a 1882 * received packet that passed filtering; note that the 1883 * packet should be preserved in that case 1884 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet 1885 * (see nl80211.h) 1886 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect 1887 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep 1888 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure 1889 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request 1890 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure 1891 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release 1892 */ 1893 enum wiphy_wowlan_support_flags { 1894 WIPHY_WOWLAN_ANY = BIT(0), 1895 WIPHY_WOWLAN_MAGIC_PKT = BIT(1), 1896 WIPHY_WOWLAN_DISCONNECT = BIT(2), 1897 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3), 1898 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4), 1899 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5), 1900 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6), 1901 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7), 1902 }; 1903 1904 /** 1905 * struct wiphy_wowlan_support - WoWLAN support data 1906 * @flags: see &enum wiphy_wowlan_support_flags 1907 * @n_patterns: number of supported wakeup patterns 1908 * (see nl80211.h for the pattern definition) 1909 * @pattern_max_len: maximum length of each pattern 1910 * @pattern_min_len: minimum length of each pattern 1911 */ 1912 struct wiphy_wowlan_support { 1913 u32 flags; 1914 int n_patterns; 1915 int pattern_max_len; 1916 int pattern_min_len; 1917 }; 1918 1919 /** 1920 * struct wiphy - wireless hardware description 1921 * @reg_notifier: the driver's regulatory notification callback, 1922 * note that if your driver uses wiphy_apply_custom_regulatory() 1923 * the reg_notifier's request can be passed as NULL 1924 * @regd: the driver's regulatory domain, if one was requested via 1925 * the regulatory_hint() API. This can be used by the driver 1926 * on the reg_notifier() if it chooses to ignore future 1927 * regulatory domain changes caused by other drivers. 1928 * @signal_type: signal type reported in &struct cfg80211_bss. 1929 * @cipher_suites: supported cipher suites 1930 * @n_cipher_suites: number of supported cipher suites 1931 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit) 1932 * @retry_long: Retry limit for long frames (dot11LongRetryLimit) 1933 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold); 1934 * -1 = fragmentation disabled, only odd values >= 256 used 1935 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled 1936 * @_net: the network namespace this wiphy currently lives in 1937 * @perm_addr: permanent MAC address of this device 1938 * @addr_mask: If the device supports multiple MAC addresses by masking, 1939 * set this to a mask with variable bits set to 1, e.g. if the last 1940 * four bits are variable then set it to 00:...:00:0f. The actual 1941 * variable bits shall be determined by the interfaces added, with 1942 * interfaces not matching the mask being rejected to be brought up. 1943 * @n_addresses: number of addresses in @addresses. 1944 * @addresses: If the device has more than one address, set this pointer 1945 * to a list of addresses (6 bytes each). The first one will be used 1946 * by default for perm_addr. In this case, the mask should be set to 1947 * all-zeroes. In this case it is assumed that the device can handle 1948 * the same number of arbitrary MAC addresses. 1949 * @registered: protects ->resume and ->suspend sysfs callbacks against 1950 * unregister hardware 1951 * @debugfsdir: debugfs directory used for this wiphy, will be renamed 1952 * automatically on wiphy renames 1953 * @dev: (virtual) struct device for this wiphy 1954 * @registered: helps synchronize suspend/resume with wiphy unregister 1955 * @wext: wireless extension handlers 1956 * @priv: driver private data (sized according to wiphy_new() parameter) 1957 * @interface_modes: bitmask of interfaces types valid for this wiphy, 1958 * must be set by driver 1959 * @iface_combinations: Valid interface combinations array, should not 1960 * list single interface types. 1961 * @n_iface_combinations: number of entries in @iface_combinations array. 1962 * @software_iftypes: bitmask of software interface types, these are not 1963 * subject to any restrictions since they are purely managed in SW. 1964 * @flags: wiphy flags, see &enum wiphy_flags 1965 * @features: features advertised to nl80211, see &enum nl80211_feature_flags. 1966 * @bss_priv_size: each BSS struct has private data allocated with it, 1967 * this variable determines its size 1968 * @max_scan_ssids: maximum number of SSIDs the device can scan for in 1969 * any given scan 1970 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan 1971 * for in any given scheduled scan 1972 * @max_match_sets: maximum number of match sets the device can handle 1973 * when performing a scheduled scan, 0 if filtering is not 1974 * supported. 1975 * @max_scan_ie_len: maximum length of user-controlled IEs device can 1976 * add to probe request frames transmitted during a scan, must not 1977 * include fixed IEs like supported rates 1978 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled 1979 * scans 1980 * @coverage_class: current coverage class 1981 * @fw_version: firmware version for ethtool reporting 1982 * @hw_version: hardware version for ethtool reporting 1983 * @max_num_pmkids: maximum number of PMKIDs supported by device 1984 * @privid: a pointer that drivers can use to identify if an arbitrary 1985 * wiphy is theirs, e.g. in global notifiers 1986 * @bands: information about bands/channels supported by this device 1987 * 1988 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or 1989 * transmitted through nl80211, points to an array indexed by interface 1990 * type 1991 * 1992 * @available_antennas_tx: bitmap of antennas which are available to be 1993 * configured as TX antennas. Antenna configuration commands will be 1994 * rejected unless this or @available_antennas_rx is set. 1995 * 1996 * @available_antennas_rx: bitmap of antennas which are available to be 1997 * configured as RX antennas. Antenna configuration commands will be 1998 * rejected unless this or @available_antennas_tx is set. 1999 * 2000 * @probe_resp_offload: 2001 * Bitmap of supported protocols for probe response offloading. 2002 * See &enum nl80211_probe_resp_offload_support_attr. Only valid 2003 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set. 2004 * 2005 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation 2006 * may request, if implemented. 2007 * 2008 * @wowlan: WoWLAN support information 2009 * 2010 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features. 2011 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden. 2012 * If null, then none can be over-ridden. 2013 */ 2014 struct wiphy { 2015 /* assign these fields before you register the wiphy */ 2016 2017 /* permanent MAC address(es) */ 2018 u8 perm_addr[ETH_ALEN]; 2019 u8 addr_mask[ETH_ALEN]; 2020 2021 struct mac_address *addresses; 2022 2023 const struct ieee80211_txrx_stypes *mgmt_stypes; 2024 2025 const struct ieee80211_iface_combination *iface_combinations; 2026 int n_iface_combinations; 2027 u16 software_iftypes; 2028 2029 u16 n_addresses; 2030 2031 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */ 2032 u16 interface_modes; 2033 2034 u32 flags, features; 2035 2036 u32 ap_sme_capa; 2037 2038 enum cfg80211_signal_type signal_type; 2039 2040 int bss_priv_size; 2041 u8 max_scan_ssids; 2042 u8 max_sched_scan_ssids; 2043 u8 max_match_sets; 2044 u16 max_scan_ie_len; 2045 u16 max_sched_scan_ie_len; 2046 2047 int n_cipher_suites; 2048 const u32 *cipher_suites; 2049 2050 u8 retry_short; 2051 u8 retry_long; 2052 u32 frag_threshold; 2053 u32 rts_threshold; 2054 u8 coverage_class; 2055 2056 char fw_version[ETHTOOL_BUSINFO_LEN]; 2057 u32 hw_version; 2058 2059 struct wiphy_wowlan_support wowlan; 2060 2061 u16 max_remain_on_channel_duration; 2062 2063 u8 max_num_pmkids; 2064 2065 u32 available_antennas_tx; 2066 u32 available_antennas_rx; 2067 2068 /* 2069 * Bitmap of supported protocols for probe response offloading 2070 * see &enum nl80211_probe_resp_offload_support_attr. Only valid 2071 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set. 2072 */ 2073 u32 probe_resp_offload; 2074 2075 /* If multiple wiphys are registered and you're handed e.g. 2076 * a regular netdev with assigned ieee80211_ptr, you won't 2077 * know whether it points to a wiphy your driver has registered 2078 * or not. Assign this to something global to your driver to 2079 * help determine whether you own this wiphy or not. */ 2080 const void *privid; 2081 2082 struct ieee80211_supported_band *bands[IEEE80211_NUM_BANDS]; 2083 2084 /* Lets us get back the wiphy on the callback */ 2085 int (*reg_notifier)(struct wiphy *wiphy, 2086 struct regulatory_request *request); 2087 2088 /* fields below are read-only, assigned by cfg80211 */ 2089 2090 const struct ieee80211_regdomain *regd; 2091 2092 /* the item in /sys/class/ieee80211/ points to this, 2093 * you need use set_wiphy_dev() (see below) */ 2094 struct device dev; 2095 2096 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */ 2097 bool registered; 2098 2099 /* dir in debugfs: ieee80211/<wiphyname> */ 2100 struct dentry *debugfsdir; 2101 2102 const struct ieee80211_ht_cap *ht_capa_mod_mask; 2103 2104 #ifdef CONFIG_NET_NS 2105 /* the network namespace this phy lives in currently */ 2106 struct net *_net; 2107 #endif 2108 2109 #ifdef CONFIG_CFG80211_WEXT 2110 const struct iw_handler_def *wext; 2111 #endif 2112 2113 char priv[0] __attribute__((__aligned__(NETDEV_ALIGN))); 2114 }; 2115 2116 static inline struct net *wiphy_net(struct wiphy *wiphy) 2117 { 2118 return read_pnet(&wiphy->_net); 2119 } 2120 2121 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net) 2122 { 2123 write_pnet(&wiphy->_net, net); 2124 } 2125 2126 /** 2127 * wiphy_priv - return priv from wiphy 2128 * 2129 * @wiphy: the wiphy whose priv pointer to return 2130 */ 2131 static inline void *wiphy_priv(struct wiphy *wiphy) 2132 { 2133 BUG_ON(!wiphy); 2134 return &wiphy->priv; 2135 } 2136 2137 /** 2138 * priv_to_wiphy - return the wiphy containing the priv 2139 * 2140 * @priv: a pointer previously returned by wiphy_priv 2141 */ 2142 static inline struct wiphy *priv_to_wiphy(void *priv) 2143 { 2144 BUG_ON(!priv); 2145 return container_of(priv, struct wiphy, priv); 2146 } 2147 2148 /** 2149 * set_wiphy_dev - set device pointer for wiphy 2150 * 2151 * @wiphy: The wiphy whose device to bind 2152 * @dev: The device to parent it to 2153 */ 2154 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev) 2155 { 2156 wiphy->dev.parent = dev; 2157 } 2158 2159 /** 2160 * wiphy_dev - get wiphy dev pointer 2161 * 2162 * @wiphy: The wiphy whose device struct to look up 2163 */ 2164 static inline struct device *wiphy_dev(struct wiphy *wiphy) 2165 { 2166 return wiphy->dev.parent; 2167 } 2168 2169 /** 2170 * wiphy_name - get wiphy name 2171 * 2172 * @wiphy: The wiphy whose name to return 2173 */ 2174 static inline const char *wiphy_name(const struct wiphy *wiphy) 2175 { 2176 return dev_name(&wiphy->dev); 2177 } 2178 2179 /** 2180 * wiphy_new - create a new wiphy for use with cfg80211 2181 * 2182 * @ops: The configuration operations for this device 2183 * @sizeof_priv: The size of the private area to allocate 2184 * 2185 * Create a new wiphy and associate the given operations with it. 2186 * @sizeof_priv bytes are allocated for private use. 2187 * 2188 * The returned pointer must be assigned to each netdev's 2189 * ieee80211_ptr for proper operation. 2190 */ 2191 struct wiphy *wiphy_new(const struct cfg80211_ops *ops, int sizeof_priv); 2192 2193 /** 2194 * wiphy_register - register a wiphy with cfg80211 2195 * 2196 * @wiphy: The wiphy to register. 2197 * 2198 * Returns a non-negative wiphy index or a negative error code. 2199 */ 2200 extern int wiphy_register(struct wiphy *wiphy); 2201 2202 /** 2203 * wiphy_unregister - deregister a wiphy from cfg80211 2204 * 2205 * @wiphy: The wiphy to unregister. 2206 * 2207 * After this call, no more requests can be made with this priv 2208 * pointer, but the call may sleep to wait for an outstanding 2209 * request that is being handled. 2210 */ 2211 extern void wiphy_unregister(struct wiphy *wiphy); 2212 2213 /** 2214 * wiphy_free - free wiphy 2215 * 2216 * @wiphy: The wiphy to free 2217 */ 2218 extern void wiphy_free(struct wiphy *wiphy); 2219 2220 /* internal structs */ 2221 struct cfg80211_conn; 2222 struct cfg80211_internal_bss; 2223 struct cfg80211_cached_keys; 2224 2225 /** 2226 * struct wireless_dev - wireless per-netdev state 2227 * 2228 * This structure must be allocated by the driver/stack 2229 * that uses the ieee80211_ptr field in struct net_device 2230 * (this is intentional so it can be allocated along with 2231 * the netdev.) 2232 * 2233 * @wiphy: pointer to hardware description 2234 * @iftype: interface type 2235 * @list: (private) Used to collect the interfaces 2236 * @netdev: (private) Used to reference back to the netdev 2237 * @current_bss: (private) Used by the internal configuration code 2238 * @channel: (private) Used by the internal configuration code to track 2239 * user-set AP, monitor and WDS channels for wireless extensions 2240 * @bssid: (private) Used by the internal configuration code 2241 * @ssid: (private) Used by the internal configuration code 2242 * @ssid_len: (private) Used by the internal configuration code 2243 * @mesh_id_len: (private) Used by the internal configuration code 2244 * @mesh_id_up_len: (private) Used by the internal configuration code 2245 * @wext: (private) Used by the internal wireless extensions compat code 2246 * @use_4addr: indicates 4addr mode is used on this interface, must be 2247 * set by driver (if supported) on add_interface BEFORE registering the 2248 * netdev and may otherwise be used by driver read-only, will be update 2249 * by cfg80211 on change_interface 2250 * @mgmt_registrations: list of registrations for management frames 2251 * @mgmt_registrations_lock: lock for the list 2252 * @mtx: mutex used to lock data in this struct 2253 * @cleanup_work: work struct used for cleanup that can't be done directly 2254 * @beacon_interval: beacon interval used on this device for transmitting 2255 * beacons, 0 when not valid 2256 */ 2257 struct wireless_dev { 2258 struct wiphy *wiphy; 2259 enum nl80211_iftype iftype; 2260 2261 /* the remainder of this struct should be private to cfg80211 */ 2262 struct list_head list; 2263 struct net_device *netdev; 2264 2265 struct list_head mgmt_registrations; 2266 spinlock_t mgmt_registrations_lock; 2267 2268 struct mutex mtx; 2269 2270 struct work_struct cleanup_work; 2271 2272 bool use_4addr; 2273 2274 /* currently used for IBSS and SME - might be rearranged later */ 2275 u8 ssid[IEEE80211_MAX_SSID_LEN]; 2276 u8 ssid_len, mesh_id_len, mesh_id_up_len; 2277 enum { 2278 CFG80211_SME_IDLE, 2279 CFG80211_SME_CONNECTING, 2280 CFG80211_SME_CONNECTED, 2281 } sme_state; 2282 struct cfg80211_conn *conn; 2283 struct cfg80211_cached_keys *connect_keys; 2284 2285 struct list_head event_list; 2286 spinlock_t event_lock; 2287 2288 struct cfg80211_internal_bss *current_bss; /* associated / joined */ 2289 struct ieee80211_channel *channel; 2290 2291 bool ps; 2292 int ps_timeout; 2293 2294 int beacon_interval; 2295 2296 u32 ap_unexpected_nlpid; 2297 2298 #ifdef CONFIG_CFG80211_WEXT 2299 /* wext data */ 2300 struct { 2301 struct cfg80211_ibss_params ibss; 2302 struct cfg80211_connect_params connect; 2303 struct cfg80211_cached_keys *keys; 2304 u8 *ie; 2305 size_t ie_len; 2306 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN]; 2307 u8 ssid[IEEE80211_MAX_SSID_LEN]; 2308 s8 default_key, default_mgmt_key; 2309 bool prev_bssid_valid; 2310 } wext; 2311 #endif 2312 }; 2313 2314 /** 2315 * wdev_priv - return wiphy priv from wireless_dev 2316 * 2317 * @wdev: The wireless device whose wiphy's priv pointer to return 2318 */ 2319 static inline void *wdev_priv(struct wireless_dev *wdev) 2320 { 2321 BUG_ON(!wdev); 2322 return wiphy_priv(wdev->wiphy); 2323 } 2324 2325 /** 2326 * DOC: Utility functions 2327 * 2328 * cfg80211 offers a number of utility functions that can be useful. 2329 */ 2330 2331 /** 2332 * ieee80211_channel_to_frequency - convert channel number to frequency 2333 * @chan: channel number 2334 * @band: band, necessary due to channel number overlap 2335 */ 2336 extern int ieee80211_channel_to_frequency(int chan, enum ieee80211_band band); 2337 2338 /** 2339 * ieee80211_frequency_to_channel - convert frequency to channel number 2340 * @freq: center frequency 2341 */ 2342 extern int ieee80211_frequency_to_channel(int freq); 2343 2344 /* 2345 * Name indirection necessary because the ieee80211 code also has 2346 * a function named "ieee80211_get_channel", so if you include 2347 * cfg80211's header file you get cfg80211's version, if you try 2348 * to include both header files you'll (rightfully!) get a symbol 2349 * clash. 2350 */ 2351 extern struct ieee80211_channel *__ieee80211_get_channel(struct wiphy *wiphy, 2352 int freq); 2353 /** 2354 * ieee80211_get_channel - get channel struct from wiphy for specified frequency 2355 * @wiphy: the struct wiphy to get the channel for 2356 * @freq: the center frequency of the channel 2357 */ 2358 static inline struct ieee80211_channel * 2359 ieee80211_get_channel(struct wiphy *wiphy, int freq) 2360 { 2361 return __ieee80211_get_channel(wiphy, freq); 2362 } 2363 2364 /** 2365 * ieee80211_get_response_rate - get basic rate for a given rate 2366 * 2367 * @sband: the band to look for rates in 2368 * @basic_rates: bitmap of basic rates 2369 * @bitrate: the bitrate for which to find the basic rate 2370 * 2371 * This function returns the basic rate corresponding to a given 2372 * bitrate, that is the next lower bitrate contained in the basic 2373 * rate map, which is, for this function, given as a bitmap of 2374 * indices of rates in the band's bitrate table. 2375 */ 2376 struct ieee80211_rate * 2377 ieee80211_get_response_rate(struct ieee80211_supported_band *sband, 2378 u32 basic_rates, int bitrate); 2379 2380 /* 2381 * Radiotap parsing functions -- for controlled injection support 2382 * 2383 * Implemented in net/wireless/radiotap.c 2384 * Documentation in Documentation/networking/radiotap-headers.txt 2385 */ 2386 2387 struct radiotap_align_size { 2388 uint8_t align:4, size:4; 2389 }; 2390 2391 struct ieee80211_radiotap_namespace { 2392 const struct radiotap_align_size *align_size; 2393 int n_bits; 2394 uint32_t oui; 2395 uint8_t subns; 2396 }; 2397 2398 struct ieee80211_radiotap_vendor_namespaces { 2399 const struct ieee80211_radiotap_namespace *ns; 2400 int n_ns; 2401 }; 2402 2403 /** 2404 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args 2405 * @this_arg_index: index of current arg, valid after each successful call 2406 * to ieee80211_radiotap_iterator_next() 2407 * @this_arg: pointer to current radiotap arg; it is valid after each 2408 * call to ieee80211_radiotap_iterator_next() but also after 2409 * ieee80211_radiotap_iterator_init() where it will point to 2410 * the beginning of the actual data portion 2411 * @this_arg_size: length of the current arg, for convenience 2412 * @current_namespace: pointer to the current namespace definition 2413 * (or internally %NULL if the current namespace is unknown) 2414 * @is_radiotap_ns: indicates whether the current namespace is the default 2415 * radiotap namespace or not 2416 * 2417 * @_rtheader: pointer to the radiotap header we are walking through 2418 * @_max_length: length of radiotap header in cpu byte ordering 2419 * @_arg_index: next argument index 2420 * @_arg: next argument pointer 2421 * @_next_bitmap: internal pointer to next present u32 2422 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present 2423 * @_vns: vendor namespace definitions 2424 * @_next_ns_data: beginning of the next namespace's data 2425 * @_reset_on_ext: internal; reset the arg index to 0 when going to the 2426 * next bitmap word 2427 * 2428 * Describes the radiotap parser state. Fields prefixed with an underscore 2429 * must not be used by users of the parser, only by the parser internally. 2430 */ 2431 2432 struct ieee80211_radiotap_iterator { 2433 struct ieee80211_radiotap_header *_rtheader; 2434 const struct ieee80211_radiotap_vendor_namespaces *_vns; 2435 const struct ieee80211_radiotap_namespace *current_namespace; 2436 2437 unsigned char *_arg, *_next_ns_data; 2438 __le32 *_next_bitmap; 2439 2440 unsigned char *this_arg; 2441 int this_arg_index; 2442 int this_arg_size; 2443 2444 int is_radiotap_ns; 2445 2446 int _max_length; 2447 int _arg_index; 2448 uint32_t _bitmap_shifter; 2449 int _reset_on_ext; 2450 }; 2451 2452 extern int ieee80211_radiotap_iterator_init( 2453 struct ieee80211_radiotap_iterator *iterator, 2454 struct ieee80211_radiotap_header *radiotap_header, 2455 int max_length, const struct ieee80211_radiotap_vendor_namespaces *vns); 2456 2457 extern int ieee80211_radiotap_iterator_next( 2458 struct ieee80211_radiotap_iterator *iterator); 2459 2460 2461 extern const unsigned char rfc1042_header[6]; 2462 extern const unsigned char bridge_tunnel_header[6]; 2463 2464 /** 2465 * ieee80211_get_hdrlen_from_skb - get header length from data 2466 * 2467 * Given an skb with a raw 802.11 header at the data pointer this function 2468 * returns the 802.11 header length in bytes (not including encryption 2469 * headers). If the data in the sk_buff is too short to contain a valid 802.11 2470 * header the function returns 0. 2471 * 2472 * @skb: the frame 2473 */ 2474 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); 2475 2476 /** 2477 * ieee80211_hdrlen - get header length in bytes from frame control 2478 * @fc: frame control field in little-endian format 2479 */ 2480 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc); 2481 2482 /** 2483 * DOC: Data path helpers 2484 * 2485 * In addition to generic utilities, cfg80211 also offers 2486 * functions that help implement the data path for devices 2487 * that do not do the 802.11/802.3 conversion on the device. 2488 */ 2489 2490 /** 2491 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3 2492 * @skb: the 802.11 data frame 2493 * @addr: the device MAC address 2494 * @iftype: the virtual interface type 2495 */ 2496 int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr, 2497 enum nl80211_iftype iftype); 2498 2499 /** 2500 * ieee80211_data_from_8023 - convert an 802.3 frame to 802.11 2501 * @skb: the 802.3 frame 2502 * @addr: the device MAC address 2503 * @iftype: the virtual interface type 2504 * @bssid: the network bssid (used only for iftype STATION and ADHOC) 2505 * @qos: build 802.11 QoS data frame 2506 */ 2507 int ieee80211_data_from_8023(struct sk_buff *skb, const u8 *addr, 2508 enum nl80211_iftype iftype, u8 *bssid, bool qos); 2509 2510 /** 2511 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame 2512 * 2513 * Decode an IEEE 802.11n A-MSDU frame and convert it to a list of 2514 * 802.3 frames. The @list will be empty if the decode fails. The 2515 * @skb is consumed after the function returns. 2516 * 2517 * @skb: The input IEEE 802.11n A-MSDU frame. 2518 * @list: The output list of 802.3 frames. It must be allocated and 2519 * initialized by by the caller. 2520 * @addr: The device MAC address. 2521 * @iftype: The device interface type. 2522 * @extra_headroom: The hardware extra headroom for SKBs in the @list. 2523 * @has_80211_header: Set it true if SKB is with IEEE 802.11 header. 2524 */ 2525 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list, 2526 const u8 *addr, enum nl80211_iftype iftype, 2527 const unsigned int extra_headroom, 2528 bool has_80211_header); 2529 2530 /** 2531 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame 2532 * @skb: the data frame 2533 */ 2534 unsigned int cfg80211_classify8021d(struct sk_buff *skb); 2535 2536 /** 2537 * cfg80211_find_ie - find information element in data 2538 * 2539 * @eid: element ID 2540 * @ies: data consisting of IEs 2541 * @len: length of data 2542 * 2543 * This function will return %NULL if the element ID could 2544 * not be found or if the element is invalid (claims to be 2545 * longer than the given data), or a pointer to the first byte 2546 * of the requested element, that is the byte containing the 2547 * element ID. There are no checks on the element length 2548 * other than having to fit into the given data. 2549 */ 2550 const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len); 2551 2552 /** 2553 * cfg80211_find_vendor_ie - find vendor specific information element in data 2554 * 2555 * @oui: vendor OUI 2556 * @oui_type: vendor-specific OUI type 2557 * @ies: data consisting of IEs 2558 * @len: length of data 2559 * 2560 * This function will return %NULL if the vendor specific element ID 2561 * could not be found or if the element is invalid (claims to be 2562 * longer than the given data), or a pointer to the first byte 2563 * of the requested element, that is the byte containing the 2564 * element ID. There are no checks on the element length 2565 * other than having to fit into the given data. 2566 */ 2567 const u8 *cfg80211_find_vendor_ie(unsigned int oui, u8 oui_type, 2568 const u8 *ies, int len); 2569 2570 /** 2571 * DOC: Regulatory enforcement infrastructure 2572 * 2573 * TODO 2574 */ 2575 2576 /** 2577 * regulatory_hint - driver hint to the wireless core a regulatory domain 2578 * @wiphy: the wireless device giving the hint (used only for reporting 2579 * conflicts) 2580 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain 2581 * should be in. If @rd is set this should be NULL. Note that if you 2582 * set this to NULL you should still set rd->alpha2 to some accepted 2583 * alpha2. 2584 * 2585 * Wireless drivers can use this function to hint to the wireless core 2586 * what it believes should be the current regulatory domain by 2587 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory 2588 * domain should be in or by providing a completely build regulatory domain. 2589 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried 2590 * for a regulatory domain structure for the respective country. 2591 * 2592 * The wiphy must have been registered to cfg80211 prior to this call. 2593 * For cfg80211 drivers this means you must first use wiphy_register(), 2594 * for mac80211 drivers you must first use ieee80211_register_hw(). 2595 * 2596 * Drivers should check the return value, its possible you can get 2597 * an -ENOMEM. 2598 */ 2599 extern int regulatory_hint(struct wiphy *wiphy, const char *alpha2); 2600 2601 /** 2602 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain 2603 * @wiphy: the wireless device we want to process the regulatory domain on 2604 * @regd: the custom regulatory domain to use for this wiphy 2605 * 2606 * Drivers can sometimes have custom regulatory domains which do not apply 2607 * to a specific country. Drivers can use this to apply such custom regulatory 2608 * domains. This routine must be called prior to wiphy registration. The 2609 * custom regulatory domain will be trusted completely and as such previous 2610 * default channel settings will be disregarded. If no rule is found for a 2611 * channel on the regulatory domain the channel will be disabled. 2612 */ 2613 extern void wiphy_apply_custom_regulatory( 2614 struct wiphy *wiphy, 2615 const struct ieee80211_regdomain *regd); 2616 2617 /** 2618 * freq_reg_info - get regulatory information for the given frequency 2619 * @wiphy: the wiphy for which we want to process this rule for 2620 * @center_freq: Frequency in KHz for which we want regulatory information for 2621 * @desired_bw_khz: the desired max bandwidth you want to use per 2622 * channel. Note that this is still 20 MHz if you want to use HT40 2623 * as HT40 makes use of two channels for its 40 MHz width bandwidth. 2624 * If set to 0 we'll assume you want the standard 20 MHz. 2625 * @reg_rule: the regulatory rule which we have for this frequency 2626 * 2627 * Use this function to get the regulatory rule for a specific frequency on 2628 * a given wireless device. If the device has a specific regulatory domain 2629 * it wants to follow we respect that unless a country IE has been received 2630 * and processed already. 2631 * 2632 * Returns 0 if it was able to find a valid regulatory rule which does 2633 * apply to the given center_freq otherwise it returns non-zero. It will 2634 * also return -ERANGE if we determine the given center_freq does not even have 2635 * a regulatory rule for a frequency range in the center_freq's band. See 2636 * freq_in_rule_band() for our current definition of a band -- this is purely 2637 * subjective and right now its 802.11 specific. 2638 */ 2639 extern int freq_reg_info(struct wiphy *wiphy, 2640 u32 center_freq, 2641 u32 desired_bw_khz, 2642 const struct ieee80211_reg_rule **reg_rule); 2643 2644 /* 2645 * callbacks for asynchronous cfg80211 methods, notification 2646 * functions and BSS handling helpers 2647 */ 2648 2649 /** 2650 * cfg80211_scan_done - notify that scan finished 2651 * 2652 * @request: the corresponding scan request 2653 * @aborted: set to true if the scan was aborted for any reason, 2654 * userspace will be notified of that 2655 */ 2656 void cfg80211_scan_done(struct cfg80211_scan_request *request, bool aborted); 2657 2658 /** 2659 * cfg80211_sched_scan_results - notify that new scan results are available 2660 * 2661 * @wiphy: the wiphy which got scheduled scan results 2662 */ 2663 void cfg80211_sched_scan_results(struct wiphy *wiphy); 2664 2665 /** 2666 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped 2667 * 2668 * @wiphy: the wiphy on which the scheduled scan stopped 2669 * 2670 * The driver can call this function to inform cfg80211 that the 2671 * scheduled scan had to be stopped, for whatever reason. The driver 2672 * is then called back via the sched_scan_stop operation when done. 2673 */ 2674 void cfg80211_sched_scan_stopped(struct wiphy *wiphy); 2675 2676 /** 2677 * cfg80211_inform_bss_frame - inform cfg80211 of a received BSS frame 2678 * 2679 * @wiphy: the wiphy reporting the BSS 2680 * @channel: The channel the frame was received on 2681 * @mgmt: the management frame (probe response or beacon) 2682 * @len: length of the management frame 2683 * @signal: the signal strength, type depends on the wiphy's signal_type 2684 * @gfp: context flags 2685 * 2686 * This informs cfg80211 that BSS information was found and 2687 * the BSS should be updated/added. 2688 * 2689 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()! 2690 */ 2691 struct cfg80211_bss * __must_check 2692 cfg80211_inform_bss_frame(struct wiphy *wiphy, 2693 struct ieee80211_channel *channel, 2694 struct ieee80211_mgmt *mgmt, size_t len, 2695 s32 signal, gfp_t gfp); 2696 2697 /** 2698 * cfg80211_inform_bss - inform cfg80211 of a new BSS 2699 * 2700 * @wiphy: the wiphy reporting the BSS 2701 * @channel: The channel the frame was received on 2702 * @bssid: the BSSID of the BSS 2703 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0) 2704 * @capability: the capability field sent by the peer 2705 * @beacon_interval: the beacon interval announced by the peer 2706 * @ie: additional IEs sent by the peer 2707 * @ielen: length of the additional IEs 2708 * @signal: the signal strength, type depends on the wiphy's signal_type 2709 * @gfp: context flags 2710 * 2711 * This informs cfg80211 that BSS information was found and 2712 * the BSS should be updated/added. 2713 * 2714 * NOTE: Returns a referenced struct, must be released with cfg80211_put_bss()! 2715 */ 2716 struct cfg80211_bss * __must_check 2717 cfg80211_inform_bss(struct wiphy *wiphy, 2718 struct ieee80211_channel *channel, 2719 const u8 *bssid, u64 tsf, u16 capability, 2720 u16 beacon_interval, const u8 *ie, size_t ielen, 2721 s32 signal, gfp_t gfp); 2722 2723 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy, 2724 struct ieee80211_channel *channel, 2725 const u8 *bssid, 2726 const u8 *ssid, size_t ssid_len, 2727 u16 capa_mask, u16 capa_val); 2728 static inline struct cfg80211_bss * 2729 cfg80211_get_ibss(struct wiphy *wiphy, 2730 struct ieee80211_channel *channel, 2731 const u8 *ssid, size_t ssid_len) 2732 { 2733 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len, 2734 WLAN_CAPABILITY_IBSS, WLAN_CAPABILITY_IBSS); 2735 } 2736 2737 struct cfg80211_bss *cfg80211_get_mesh(struct wiphy *wiphy, 2738 struct ieee80211_channel *channel, 2739 const u8 *meshid, size_t meshidlen, 2740 const u8 *meshcfg); 2741 /** 2742 * cfg80211_ref_bss - reference BSS struct 2743 * @bss: the BSS struct to reference 2744 * 2745 * Increments the refcount of the given BSS struct. 2746 */ 2747 void cfg80211_ref_bss(struct cfg80211_bss *bss); 2748 2749 /** 2750 * cfg80211_put_bss - unref BSS struct 2751 * @bss: the BSS struct 2752 * 2753 * Decrements the refcount of the given BSS struct. 2754 */ 2755 void cfg80211_put_bss(struct cfg80211_bss *bss); 2756 2757 /** 2758 * cfg80211_unlink_bss - unlink BSS from internal data structures 2759 * @wiphy: the wiphy 2760 * @bss: the bss to remove 2761 * 2762 * This function removes the given BSS from the internal data structures 2763 * thereby making it no longer show up in scan results etc. Use this 2764 * function when you detect a BSS is gone. Normally BSSes will also time 2765 * out, so it is not necessary to use this function at all. 2766 */ 2767 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss); 2768 2769 /** 2770 * cfg80211_send_rx_auth - notification of processed authentication 2771 * @dev: network device 2772 * @buf: authentication frame (header + body) 2773 * @len: length of the frame data 2774 * 2775 * This function is called whenever an authentication has been processed in 2776 * station mode. The driver is required to call either this function or 2777 * cfg80211_send_auth_timeout() to indicate the result of cfg80211_ops::auth() 2778 * call. This function may sleep. 2779 */ 2780 void cfg80211_send_rx_auth(struct net_device *dev, const u8 *buf, size_t len); 2781 2782 /** 2783 * cfg80211_send_auth_timeout - notification of timed out authentication 2784 * @dev: network device 2785 * @addr: The MAC address of the device with which the authentication timed out 2786 * 2787 * This function may sleep. 2788 */ 2789 void cfg80211_send_auth_timeout(struct net_device *dev, const u8 *addr); 2790 2791 /** 2792 * cfg80211_send_rx_assoc - notification of processed association 2793 * @dev: network device 2794 * @bss: the BSS struct association was requested for, the struct reference 2795 * is owned by cfg80211 after this call 2796 * @buf: (re)association response frame (header + body) 2797 * @len: length of the frame data 2798 * 2799 * This function is called whenever a (re)association response has been 2800 * processed in station mode. The driver is required to call either this 2801 * function or cfg80211_send_assoc_timeout() to indicate the result of 2802 * cfg80211_ops::assoc() call. This function may sleep. 2803 */ 2804 void cfg80211_send_rx_assoc(struct net_device *dev, struct cfg80211_bss *bss, 2805 const u8 *buf, size_t len); 2806 2807 /** 2808 * cfg80211_send_assoc_timeout - notification of timed out association 2809 * @dev: network device 2810 * @addr: The MAC address of the device with which the association timed out 2811 * 2812 * This function may sleep. 2813 */ 2814 void cfg80211_send_assoc_timeout(struct net_device *dev, const u8 *addr); 2815 2816 /** 2817 * cfg80211_send_deauth - notification of processed deauthentication 2818 * @dev: network device 2819 * @buf: deauthentication frame (header + body) 2820 * @len: length of the frame data 2821 * 2822 * This function is called whenever deauthentication has been processed in 2823 * station mode. This includes both received deauthentication frames and 2824 * locally generated ones. This function may sleep. 2825 */ 2826 void cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len); 2827 2828 /** 2829 * __cfg80211_send_deauth - notification of processed deauthentication 2830 * @dev: network device 2831 * @buf: deauthentication frame (header + body) 2832 * @len: length of the frame data 2833 * 2834 * Like cfg80211_send_deauth(), but doesn't take the wdev lock. 2835 */ 2836 void __cfg80211_send_deauth(struct net_device *dev, const u8 *buf, size_t len); 2837 2838 /** 2839 * cfg80211_send_disassoc - notification of processed disassociation 2840 * @dev: network device 2841 * @buf: disassociation response frame (header + body) 2842 * @len: length of the frame data 2843 * 2844 * This function is called whenever disassociation has been processed in 2845 * station mode. This includes both received disassociation frames and locally 2846 * generated ones. This function may sleep. 2847 */ 2848 void cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, size_t len); 2849 2850 /** 2851 * __cfg80211_send_disassoc - notification of processed disassociation 2852 * @dev: network device 2853 * @buf: disassociation response frame (header + body) 2854 * @len: length of the frame data 2855 * 2856 * Like cfg80211_send_disassoc(), but doesn't take the wdev lock. 2857 */ 2858 void __cfg80211_send_disassoc(struct net_device *dev, const u8 *buf, 2859 size_t len); 2860 2861 /** 2862 * cfg80211_send_unprot_deauth - notification of unprotected deauthentication 2863 * @dev: network device 2864 * @buf: deauthentication frame (header + body) 2865 * @len: length of the frame data 2866 * 2867 * This function is called whenever a received Deauthentication frame has been 2868 * dropped in station mode because of MFP being used but the Deauthentication 2869 * frame was not protected. This function may sleep. 2870 */ 2871 void cfg80211_send_unprot_deauth(struct net_device *dev, const u8 *buf, 2872 size_t len); 2873 2874 /** 2875 * cfg80211_send_unprot_disassoc - notification of unprotected disassociation 2876 * @dev: network device 2877 * @buf: disassociation frame (header + body) 2878 * @len: length of the frame data 2879 * 2880 * This function is called whenever a received Disassociation frame has been 2881 * dropped in station mode because of MFP being used but the Disassociation 2882 * frame was not protected. This function may sleep. 2883 */ 2884 void cfg80211_send_unprot_disassoc(struct net_device *dev, const u8 *buf, 2885 size_t len); 2886 2887 /** 2888 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP) 2889 * @dev: network device 2890 * @addr: The source MAC address of the frame 2891 * @key_type: The key type that the received frame used 2892 * @key_id: Key identifier (0..3). Can be -1 if missing. 2893 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets) 2894 * @gfp: allocation flags 2895 * 2896 * This function is called whenever the local MAC detects a MIC failure in a 2897 * received frame. This matches with MLME-MICHAELMICFAILURE.indication() 2898 * primitive. 2899 */ 2900 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr, 2901 enum nl80211_key_type key_type, int key_id, 2902 const u8 *tsc, gfp_t gfp); 2903 2904 /** 2905 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS 2906 * 2907 * @dev: network device 2908 * @bssid: the BSSID of the IBSS joined 2909 * @gfp: allocation flags 2910 * 2911 * This function notifies cfg80211 that the device joined an IBSS or 2912 * switched to a different BSSID. Before this function can be called, 2913 * either a beacon has to have been received from the IBSS, or one of 2914 * the cfg80211_inform_bss{,_frame} functions must have been called 2915 * with the locally generated beacon -- this guarantees that there is 2916 * always a scan result for this IBSS. cfg80211 will handle the rest. 2917 */ 2918 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, gfp_t gfp); 2919 2920 /** 2921 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate 2922 * 2923 * @dev: network device 2924 * @macaddr: the MAC address of the new candidate 2925 * @ie: information elements advertised by the peer candidate 2926 * @ie_len: lenght of the information elements buffer 2927 * @gfp: allocation flags 2928 * 2929 * This function notifies cfg80211 that the mesh peer candidate has been 2930 * detected, most likely via a beacon or, less likely, via a probe response. 2931 * cfg80211 then sends a notification to userspace. 2932 */ 2933 void cfg80211_notify_new_peer_candidate(struct net_device *dev, 2934 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp); 2935 2936 /** 2937 * DOC: RFkill integration 2938 * 2939 * RFkill integration in cfg80211 is almost invisible to drivers, 2940 * as cfg80211 automatically registers an rfkill instance for each 2941 * wireless device it knows about. Soft kill is also translated 2942 * into disconnecting and turning all interfaces off, drivers are 2943 * expected to turn off the device when all interfaces are down. 2944 * 2945 * However, devices may have a hard RFkill line, in which case they 2946 * also need to interact with the rfkill subsystem, via cfg80211. 2947 * They can do this with a few helper functions documented here. 2948 */ 2949 2950 /** 2951 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state 2952 * @wiphy: the wiphy 2953 * @blocked: block status 2954 */ 2955 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked); 2956 2957 /** 2958 * wiphy_rfkill_start_polling - start polling rfkill 2959 * @wiphy: the wiphy 2960 */ 2961 void wiphy_rfkill_start_polling(struct wiphy *wiphy); 2962 2963 /** 2964 * wiphy_rfkill_stop_polling - stop polling rfkill 2965 * @wiphy: the wiphy 2966 */ 2967 void wiphy_rfkill_stop_polling(struct wiphy *wiphy); 2968 2969 #ifdef CONFIG_NL80211_TESTMODE 2970 /** 2971 * DOC: Test mode 2972 * 2973 * Test mode is a set of utility functions to allow drivers to 2974 * interact with driver-specific tools to aid, for instance, 2975 * factory programming. 2976 * 2977 * This chapter describes how drivers interact with it, for more 2978 * information see the nl80211 book's chapter on it. 2979 */ 2980 2981 /** 2982 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply 2983 * @wiphy: the wiphy 2984 * @approxlen: an upper bound of the length of the data that will 2985 * be put into the skb 2986 * 2987 * This function allocates and pre-fills an skb for a reply to 2988 * the testmode command. Since it is intended for a reply, calling 2989 * it outside of the @testmode_cmd operation is invalid. 2990 * 2991 * The returned skb (or %NULL if any errors happen) is pre-filled 2992 * with the wiphy index and set up in a way that any data that is 2993 * put into the skb (with skb_put(), nla_put() or similar) will end 2994 * up being within the %NL80211_ATTR_TESTDATA attribute, so all that 2995 * needs to be done with the skb is adding data for the corresponding 2996 * userspace tool which can then read that data out of the testdata 2997 * attribute. You must not modify the skb in any other way. 2998 * 2999 * When done, call cfg80211_testmode_reply() with the skb and return 3000 * its error code as the result of the @testmode_cmd operation. 3001 */ 3002 struct sk_buff *cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, 3003 int approxlen); 3004 3005 /** 3006 * cfg80211_testmode_reply - send the reply skb 3007 * @skb: The skb, must have been allocated with 3008 * cfg80211_testmode_alloc_reply_skb() 3009 * 3010 * Returns an error code or 0 on success, since calling this 3011 * function will usually be the last thing before returning 3012 * from the @testmode_cmd you should return the error code. 3013 * Note that this function consumes the skb regardless of the 3014 * return value. 3015 */ 3016 int cfg80211_testmode_reply(struct sk_buff *skb); 3017 3018 /** 3019 * cfg80211_testmode_alloc_event_skb - allocate testmode event 3020 * @wiphy: the wiphy 3021 * @approxlen: an upper bound of the length of the data that will 3022 * be put into the skb 3023 * @gfp: allocation flags 3024 * 3025 * This function allocates and pre-fills an skb for an event on the 3026 * testmode multicast group. 3027 * 3028 * The returned skb (or %NULL if any errors happen) is set up in the 3029 * same way as with cfg80211_testmode_alloc_reply_skb() but prepared 3030 * for an event. As there, you should simply add data to it that will 3031 * then end up in the %NL80211_ATTR_TESTDATA attribute. Again, you must 3032 * not modify the skb in any other way. 3033 * 3034 * When done filling the skb, call cfg80211_testmode_event() with the 3035 * skb to send the event. 3036 */ 3037 struct sk_buff *cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, 3038 int approxlen, gfp_t gfp); 3039 3040 /** 3041 * cfg80211_testmode_event - send the event 3042 * @skb: The skb, must have been allocated with 3043 * cfg80211_testmode_alloc_event_skb() 3044 * @gfp: allocation flags 3045 * 3046 * This function sends the given @skb, which must have been allocated 3047 * by cfg80211_testmode_alloc_event_skb(), as an event. It always 3048 * consumes it. 3049 */ 3050 void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp); 3051 3052 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd), 3053 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd), 3054 #else 3055 #define CFG80211_TESTMODE_CMD(cmd) 3056 #define CFG80211_TESTMODE_DUMP(cmd) 3057 #endif 3058 3059 /** 3060 * cfg80211_connect_result - notify cfg80211 of connection result 3061 * 3062 * @dev: network device 3063 * @bssid: the BSSID of the AP 3064 * @req_ie: association request IEs (maybe be %NULL) 3065 * @req_ie_len: association request IEs length 3066 * @resp_ie: association response IEs (may be %NULL) 3067 * @resp_ie_len: assoc response IEs length 3068 * @status: status code, 0 for successful connection, use 3069 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you 3070 * the real status code for failures. 3071 * @gfp: allocation flags 3072 * 3073 * It should be called by the underlying driver whenever connect() has 3074 * succeeded. 3075 */ 3076 void cfg80211_connect_result(struct net_device *dev, const u8 *bssid, 3077 const u8 *req_ie, size_t req_ie_len, 3078 const u8 *resp_ie, size_t resp_ie_len, 3079 u16 status, gfp_t gfp); 3080 3081 /** 3082 * cfg80211_roamed - notify cfg80211 of roaming 3083 * 3084 * @dev: network device 3085 * @channel: the channel of the new AP 3086 * @bssid: the BSSID of the new AP 3087 * @req_ie: association request IEs (maybe be %NULL) 3088 * @req_ie_len: association request IEs length 3089 * @resp_ie: association response IEs (may be %NULL) 3090 * @resp_ie_len: assoc response IEs length 3091 * @gfp: allocation flags 3092 * 3093 * It should be called by the underlying driver whenever it roamed 3094 * from one AP to another while connected. 3095 */ 3096 void cfg80211_roamed(struct net_device *dev, 3097 struct ieee80211_channel *channel, 3098 const u8 *bssid, 3099 const u8 *req_ie, size_t req_ie_len, 3100 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp); 3101 3102 /** 3103 * cfg80211_roamed_bss - notify cfg80211 of roaming 3104 * 3105 * @dev: network device 3106 * @bss: entry of bss to which STA got roamed 3107 * @req_ie: association request IEs (maybe be %NULL) 3108 * @req_ie_len: association request IEs length 3109 * @resp_ie: association response IEs (may be %NULL) 3110 * @resp_ie_len: assoc response IEs length 3111 * @gfp: allocation flags 3112 * 3113 * This is just a wrapper to notify cfg80211 of roaming event with driver 3114 * passing bss to avoid a race in timeout of the bss entry. It should be 3115 * called by the underlying driver whenever it roamed from one AP to another 3116 * while connected. Drivers which have roaming implemented in firmware 3117 * may use this function to avoid a race in bss entry timeout where the bss 3118 * entry of the new AP is seen in the driver, but gets timed out by the time 3119 * it is accessed in __cfg80211_roamed() due to delay in scheduling 3120 * rdev->event_work. In case of any failures, the reference is released 3121 * either in cfg80211_roamed_bss() or in __cfg80211_romed(), Otherwise, 3122 * it will be released while diconneting from the current bss. 3123 */ 3124 void cfg80211_roamed_bss(struct net_device *dev, struct cfg80211_bss *bss, 3125 const u8 *req_ie, size_t req_ie_len, 3126 const u8 *resp_ie, size_t resp_ie_len, gfp_t gfp); 3127 3128 /** 3129 * cfg80211_disconnected - notify cfg80211 that connection was dropped 3130 * 3131 * @dev: network device 3132 * @ie: information elements of the deauth/disassoc frame (may be %NULL) 3133 * @ie_len: length of IEs 3134 * @reason: reason code for the disconnection, set it to 0 if unknown 3135 * @gfp: allocation flags 3136 * 3137 * After it calls this function, the driver should enter an idle state 3138 * and not try to connect to any AP any more. 3139 */ 3140 void cfg80211_disconnected(struct net_device *dev, u16 reason, 3141 u8 *ie, size_t ie_len, gfp_t gfp); 3142 3143 /** 3144 * cfg80211_ready_on_channel - notification of remain_on_channel start 3145 * @dev: network device 3146 * @cookie: the request cookie 3147 * @chan: The current channel (from remain_on_channel request) 3148 * @channel_type: Channel type 3149 * @duration: Duration in milliseconds that the driver intents to remain on the 3150 * channel 3151 * @gfp: allocation flags 3152 */ 3153 void cfg80211_ready_on_channel(struct net_device *dev, u64 cookie, 3154 struct ieee80211_channel *chan, 3155 enum nl80211_channel_type channel_type, 3156 unsigned int duration, gfp_t gfp); 3157 3158 /** 3159 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired 3160 * @dev: network device 3161 * @cookie: the request cookie 3162 * @chan: The current channel (from remain_on_channel request) 3163 * @channel_type: Channel type 3164 * @gfp: allocation flags 3165 */ 3166 void cfg80211_remain_on_channel_expired(struct net_device *dev, 3167 u64 cookie, 3168 struct ieee80211_channel *chan, 3169 enum nl80211_channel_type channel_type, 3170 gfp_t gfp); 3171 3172 3173 /** 3174 * cfg80211_new_sta - notify userspace about station 3175 * 3176 * @dev: the netdev 3177 * @mac_addr: the station's address 3178 * @sinfo: the station information 3179 * @gfp: allocation flags 3180 */ 3181 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr, 3182 struct station_info *sinfo, gfp_t gfp); 3183 3184 /** 3185 * cfg80211_del_sta - notify userspace about deletion of a station 3186 * 3187 * @dev: the netdev 3188 * @mac_addr: the station's address 3189 * @gfp: allocation flags 3190 */ 3191 void cfg80211_del_sta(struct net_device *dev, const u8 *mac_addr, gfp_t gfp); 3192 3193 /** 3194 * cfg80211_rx_mgmt - notification of received, unprocessed management frame 3195 * @dev: network device 3196 * @freq: Frequency on which the frame was received in MHz 3197 * @sig_dbm: signal strength in mBm, or 0 if unknown 3198 * @buf: Management frame (header + body) 3199 * @len: length of the frame data 3200 * @gfp: context flags 3201 * 3202 * Returns %true if a user space application has registered for this frame. 3203 * For action frames, that makes it responsible for rejecting unrecognized 3204 * action frames; %false otherwise, in which case for action frames the 3205 * driver is responsible for rejecting the frame. 3206 * 3207 * This function is called whenever an Action frame is received for a station 3208 * mode interface, but is not processed in kernel. 3209 */ 3210 bool cfg80211_rx_mgmt(struct net_device *dev, int freq, int sig_dbm, 3211 const u8 *buf, size_t len, gfp_t gfp); 3212 3213 /** 3214 * cfg80211_mgmt_tx_status - notification of TX status for management frame 3215 * @dev: network device 3216 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx() 3217 * @buf: Management frame (header + body) 3218 * @len: length of the frame data 3219 * @ack: Whether frame was acknowledged 3220 * @gfp: context flags 3221 * 3222 * This function is called whenever a management frame was requested to be 3223 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the 3224 * transmission attempt. 3225 */ 3226 void cfg80211_mgmt_tx_status(struct net_device *dev, u64 cookie, 3227 const u8 *buf, size_t len, bool ack, gfp_t gfp); 3228 3229 3230 /** 3231 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event 3232 * @dev: network device 3233 * @rssi_event: the triggered RSSI event 3234 * @gfp: context flags 3235 * 3236 * This function is called when a configured connection quality monitoring 3237 * rssi threshold reached event occurs. 3238 */ 3239 void cfg80211_cqm_rssi_notify(struct net_device *dev, 3240 enum nl80211_cqm_rssi_threshold_event rssi_event, 3241 gfp_t gfp); 3242 3243 /** 3244 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer 3245 * @dev: network device 3246 * @peer: peer's MAC address 3247 * @num_packets: how many packets were lost -- should be a fixed threshold 3248 * but probably no less than maybe 50, or maybe a throughput dependent 3249 * threshold (to account for temporary interference) 3250 * @gfp: context flags 3251 */ 3252 void cfg80211_cqm_pktloss_notify(struct net_device *dev, 3253 const u8 *peer, u32 num_packets, gfp_t gfp); 3254 3255 /** 3256 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying 3257 * @dev: network device 3258 * @bssid: BSSID of AP (to avoid races) 3259 * @replay_ctr: new replay counter 3260 * @gfp: allocation flags 3261 */ 3262 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid, 3263 const u8 *replay_ctr, gfp_t gfp); 3264 3265 /** 3266 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate 3267 * @dev: network device 3268 * @index: candidate index (the smaller the index, the higher the priority) 3269 * @bssid: BSSID of AP 3270 * @preauth: Whether AP advertises support for RSN pre-authentication 3271 * @gfp: allocation flags 3272 */ 3273 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index, 3274 const u8 *bssid, bool preauth, gfp_t gfp); 3275 3276 /** 3277 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame 3278 * @dev: The device the frame matched to 3279 * @addr: the transmitter address 3280 * @gfp: context flags 3281 * 3282 * This function is used in AP mode (only!) to inform userspace that 3283 * a spurious class 3 frame was received, to be able to deauth the 3284 * sender. 3285 * Returns %true if the frame was passed to userspace (or this failed 3286 * for a reason other than not having a subscription.) 3287 */ 3288 bool cfg80211_rx_spurious_frame(struct net_device *dev, 3289 const u8 *addr, gfp_t gfp); 3290 3291 /** 3292 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame 3293 * @dev: The device the frame matched to 3294 * @addr: the transmitter address 3295 * @gfp: context flags 3296 * 3297 * This function is used in AP mode (only!) to inform userspace that 3298 * an associated station sent a 4addr frame but that wasn't expected. 3299 * It is allowed and desirable to send this event only once for each 3300 * station to avoid event flooding. 3301 * Returns %true if the frame was passed to userspace (or this failed 3302 * for a reason other than not having a subscription.) 3303 */ 3304 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev, 3305 const u8 *addr, gfp_t gfp); 3306 3307 /** 3308 * cfg80211_probe_status - notify userspace about probe status 3309 * @dev: the device the probe was sent on 3310 * @addr: the address of the peer 3311 * @cookie: the cookie filled in @probe_client previously 3312 * @acked: indicates whether probe was acked or not 3313 * @gfp: allocation flags 3314 */ 3315 void cfg80211_probe_status(struct net_device *dev, const u8 *addr, 3316 u64 cookie, bool acked, gfp_t gfp); 3317 3318 /** 3319 * cfg80211_report_obss_beacon - report beacon from other APs 3320 * @wiphy: The wiphy that received the beacon 3321 * @frame: the frame 3322 * @len: length of the frame 3323 * @freq: frequency the frame was received on 3324 * @sig_dbm: signal strength in mBm, or 0 if unknown 3325 * @gfp: allocation flags 3326 * 3327 * Use this function to report to userspace when a beacon was 3328 * received. It is not useful to call this when there is no 3329 * netdev that is in AP/GO mode. 3330 */ 3331 void cfg80211_report_obss_beacon(struct wiphy *wiphy, 3332 const u8 *frame, size_t len, 3333 int freq, int sig_dbm, gfp_t gfp); 3334 3335 /* 3336 * cfg80211_can_beacon_sec_chan - test if ht40 on extension channel can be used 3337 * @wiphy: the wiphy 3338 * @chan: main channel 3339 * @channel_type: HT mode 3340 */ 3341 int cfg80211_can_beacon_sec_chan(struct wiphy *wiphy, 3342 struct ieee80211_channel *chan, 3343 enum nl80211_channel_type channel_type); 3344 3345 /* 3346 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units) 3347 * @rate: given rate_info to calculate bitrate from 3348 * 3349 * return 0 if MCS index >= 32 3350 */ 3351 u16 cfg80211_calculate_bitrate(struct rate_info *rate); 3352 3353 /* Logging, debugging and troubleshooting/diagnostic helpers. */ 3354 3355 /* wiphy_printk helpers, similar to dev_printk */ 3356 3357 #define wiphy_printk(level, wiphy, format, args...) \ 3358 dev_printk(level, &(wiphy)->dev, format, ##args) 3359 #define wiphy_emerg(wiphy, format, args...) \ 3360 dev_emerg(&(wiphy)->dev, format, ##args) 3361 #define wiphy_alert(wiphy, format, args...) \ 3362 dev_alert(&(wiphy)->dev, format, ##args) 3363 #define wiphy_crit(wiphy, format, args...) \ 3364 dev_crit(&(wiphy)->dev, format, ##args) 3365 #define wiphy_err(wiphy, format, args...) \ 3366 dev_err(&(wiphy)->dev, format, ##args) 3367 #define wiphy_warn(wiphy, format, args...) \ 3368 dev_warn(&(wiphy)->dev, format, ##args) 3369 #define wiphy_notice(wiphy, format, args...) \ 3370 dev_notice(&(wiphy)->dev, format, ##args) 3371 #define wiphy_info(wiphy, format, args...) \ 3372 dev_info(&(wiphy)->dev, format, ##args) 3373 3374 #define wiphy_debug(wiphy, format, args...) \ 3375 wiphy_printk(KERN_DEBUG, wiphy, format, ##args) 3376 3377 #define wiphy_dbg(wiphy, format, args...) \ 3378 dev_dbg(&(wiphy)->dev, format, ##args) 3379 3380 #if defined(VERBOSE_DEBUG) 3381 #define wiphy_vdbg wiphy_dbg 3382 #else 3383 #define wiphy_vdbg(wiphy, format, args...) \ 3384 ({ \ 3385 if (0) \ 3386 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \ 3387 0; \ 3388 }) 3389 #endif 3390 3391 /* 3392 * wiphy_WARN() acts like wiphy_printk(), but with the key difference 3393 * of using a WARN/WARN_ON to get the message out, including the 3394 * file/line information and a backtrace. 3395 */ 3396 #define wiphy_WARN(wiphy, format, args...) \ 3397 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args); 3398 3399 #endif /* __NET_CFG80211_H */ 3400