1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 #ifndef __NET_CFG80211_H 3 #define __NET_CFG80211_H 4 /* 5 * 802.11 device and configuration interface 6 * 7 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net> 8 * Copyright 2013-2014 Intel Mobile Communications GmbH 9 * Copyright 2015-2017 Intel Deutschland GmbH 10 * Copyright (C) 2018-2021, 2023 Intel Corporation 11 */ 12 13 #include <linux/ethtool.h> 14 #include <uapi/linux/rfkill.h> 15 #include <linux/netdevice.h> 16 #include <linux/debugfs.h> 17 #include <linux/list.h> 18 #include <linux/bug.h> 19 #include <linux/netlink.h> 20 #include <linux/skbuff.h> 21 #include <linux/nl80211.h> 22 #include <linux/if_ether.h> 23 #include <linux/ieee80211.h> 24 #include <linux/net.h> 25 #include <linux/rfkill.h> 26 #include <net/regulatory.h> 27 28 /** 29 * DOC: Introduction 30 * 31 * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges 32 * userspace and drivers, and offers some utility functionality associated 33 * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used 34 * by all modern wireless drivers in Linux, so that they offer a consistent 35 * API through nl80211. For backward compatibility, cfg80211 also offers 36 * wireless extensions to userspace, but hides them from drivers completely. 37 * 38 * Additionally, cfg80211 contains code to help enforce regulatory spectrum 39 * use restrictions. 40 */ 41 42 43 /** 44 * DOC: Device registration 45 * 46 * In order for a driver to use cfg80211, it must register the hardware device 47 * with cfg80211. This happens through a number of hardware capability structs 48 * described below. 49 * 50 * The fundamental structure for each device is the 'wiphy', of which each 51 * instance describes a physical wireless device connected to the system. Each 52 * such wiphy can have zero, one, or many virtual interfaces associated with 53 * it, which need to be identified as such by pointing the network interface's 54 * @ieee80211_ptr pointer to a &struct wireless_dev which further describes 55 * the wireless part of the interface. Normally this struct is embedded in the 56 * network interface's private data area. Drivers can optionally allow creating 57 * or destroying virtual interfaces on the fly, but without at least one or the 58 * ability to create some the wireless device isn't useful. 59 * 60 * Each wiphy structure contains device capability information, and also has 61 * a pointer to the various operations the driver offers. The definitions and 62 * structures here describe these capabilities in detail. 63 */ 64 65 struct wiphy; 66 67 /* 68 * wireless hardware capability structures 69 */ 70 71 /** 72 * enum ieee80211_channel_flags - channel flags 73 * 74 * Channel flags set by the regulatory control code. 75 * 76 * @IEEE80211_CHAN_DISABLED: This channel is disabled. 77 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes 78 * sending probe requests or beaconing. 79 * @IEEE80211_CHAN_PSD: Power spectral density (in dBm) is set for this 80 * channel. 81 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel. 82 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel 83 * is not permitted. 84 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel 85 * is not permitted. 86 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel. 87 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band, 88 * this flag indicates that an 80 MHz channel cannot use this 89 * channel as the control or any of the secondary channels. 90 * This may be due to the driver or due to regulatory bandwidth 91 * restrictions. 92 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band, 93 * this flag indicates that an 160 MHz channel cannot use this 94 * channel as the control or any of the secondary channels. 95 * This may be due to the driver or due to regulatory bandwidth 96 * restrictions. 97 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY 98 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT 99 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted 100 * on this channel. 101 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted 102 * on this channel. 103 * @IEEE80211_CHAN_NO_HE: HE operation is not permitted on this channel. 104 * @IEEE80211_CHAN_1MHZ: 1 MHz bandwidth is permitted 105 * on this channel. 106 * @IEEE80211_CHAN_2MHZ: 2 MHz bandwidth is permitted 107 * on this channel. 108 * @IEEE80211_CHAN_4MHZ: 4 MHz bandwidth is permitted 109 * on this channel. 110 * @IEEE80211_CHAN_8MHZ: 8 MHz bandwidth is permitted 111 * on this channel. 112 * @IEEE80211_CHAN_16MHZ: 16 MHz bandwidth is permitted 113 * on this channel. 114 * @IEEE80211_CHAN_NO_320MHZ: If the driver supports 320 MHz on the band, 115 * this flag indicates that a 320 MHz channel cannot use this 116 * channel as the control or any of the secondary channels. 117 * This may be due to the driver or due to regulatory bandwidth 118 * restrictions. 119 * @IEEE80211_CHAN_NO_EHT: EHT operation is not permitted on this channel. 120 */ 121 enum ieee80211_channel_flags { 122 IEEE80211_CHAN_DISABLED = 1<<0, 123 IEEE80211_CHAN_NO_IR = 1<<1, 124 IEEE80211_CHAN_PSD = 1<<2, 125 IEEE80211_CHAN_RADAR = 1<<3, 126 IEEE80211_CHAN_NO_HT40PLUS = 1<<4, 127 IEEE80211_CHAN_NO_HT40MINUS = 1<<5, 128 IEEE80211_CHAN_NO_OFDM = 1<<6, 129 IEEE80211_CHAN_NO_80MHZ = 1<<7, 130 IEEE80211_CHAN_NO_160MHZ = 1<<8, 131 IEEE80211_CHAN_INDOOR_ONLY = 1<<9, 132 IEEE80211_CHAN_IR_CONCURRENT = 1<<10, 133 IEEE80211_CHAN_NO_20MHZ = 1<<11, 134 IEEE80211_CHAN_NO_10MHZ = 1<<12, 135 IEEE80211_CHAN_NO_HE = 1<<13, 136 IEEE80211_CHAN_1MHZ = 1<<14, 137 IEEE80211_CHAN_2MHZ = 1<<15, 138 IEEE80211_CHAN_4MHZ = 1<<16, 139 IEEE80211_CHAN_8MHZ = 1<<17, 140 IEEE80211_CHAN_16MHZ = 1<<18, 141 IEEE80211_CHAN_NO_320MHZ = 1<<19, 142 IEEE80211_CHAN_NO_EHT = 1<<20, 143 }; 144 145 #define IEEE80211_CHAN_NO_HT40 \ 146 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS) 147 148 #define IEEE80211_DFS_MIN_CAC_TIME_MS 60000 149 #define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000) 150 151 /** 152 * struct ieee80211_channel - channel definition 153 * 154 * This structure describes a single channel for use 155 * with cfg80211. 156 * 157 * @center_freq: center frequency in MHz 158 * @freq_offset: offset from @center_freq, in KHz 159 * @hw_value: hardware-specific value for the channel 160 * @flags: channel flags from &enum ieee80211_channel_flags. 161 * @orig_flags: channel flags at registration time, used by regulatory 162 * code to support devices with additional restrictions 163 * @band: band this channel belongs to. 164 * @max_antenna_gain: maximum antenna gain in dBi 165 * @max_power: maximum transmission power (in dBm) 166 * @max_reg_power: maximum regulatory transmission power (in dBm) 167 * @beacon_found: helper to regulatory code to indicate when a beacon 168 * has been found on this channel. Use regulatory_hint_found_beacon() 169 * to enable this, this is useful only on 5 GHz band. 170 * @orig_mag: internal use 171 * @orig_mpwr: internal use 172 * @dfs_state: current state of this channel. Only relevant if radar is required 173 * on this channel. 174 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered. 175 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels. 176 * @psd: power spectral density (in dBm) 177 */ 178 struct ieee80211_channel { 179 enum nl80211_band band; 180 u32 center_freq; 181 u16 freq_offset; 182 u16 hw_value; 183 u32 flags; 184 int max_antenna_gain; 185 int max_power; 186 int max_reg_power; 187 bool beacon_found; 188 u32 orig_flags; 189 int orig_mag, orig_mpwr; 190 enum nl80211_dfs_state dfs_state; 191 unsigned long dfs_state_entered; 192 unsigned int dfs_cac_ms; 193 s8 psd; 194 }; 195 196 /** 197 * enum ieee80211_rate_flags - rate flags 198 * 199 * Hardware/specification flags for rates. These are structured 200 * in a way that allows using the same bitrate structure for 201 * different bands/PHY modes. 202 * 203 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short 204 * preamble on this bitrate; only relevant in 2.4GHz band and 205 * with CCK rates. 206 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate 207 * when used with 802.11a (on the 5 GHz band); filled by the 208 * core code when registering the wiphy. 209 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate 210 * when used with 802.11b (on the 2.4 GHz band); filled by the 211 * core code when registering the wiphy. 212 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate 213 * when used with 802.11g (on the 2.4 GHz band); filled by the 214 * core code when registering the wiphy. 215 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode. 216 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode 217 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode 218 */ 219 enum ieee80211_rate_flags { 220 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0, 221 IEEE80211_RATE_MANDATORY_A = 1<<1, 222 IEEE80211_RATE_MANDATORY_B = 1<<2, 223 IEEE80211_RATE_MANDATORY_G = 1<<3, 224 IEEE80211_RATE_ERP_G = 1<<4, 225 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5, 226 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6, 227 }; 228 229 /** 230 * enum ieee80211_bss_type - BSS type filter 231 * 232 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS 233 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS 234 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS 235 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS 236 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type 237 */ 238 enum ieee80211_bss_type { 239 IEEE80211_BSS_TYPE_ESS, 240 IEEE80211_BSS_TYPE_PBSS, 241 IEEE80211_BSS_TYPE_IBSS, 242 IEEE80211_BSS_TYPE_MBSS, 243 IEEE80211_BSS_TYPE_ANY 244 }; 245 246 /** 247 * enum ieee80211_privacy - BSS privacy filter 248 * 249 * @IEEE80211_PRIVACY_ON: privacy bit set 250 * @IEEE80211_PRIVACY_OFF: privacy bit clear 251 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting 252 */ 253 enum ieee80211_privacy { 254 IEEE80211_PRIVACY_ON, 255 IEEE80211_PRIVACY_OFF, 256 IEEE80211_PRIVACY_ANY 257 }; 258 259 #define IEEE80211_PRIVACY(x) \ 260 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF) 261 262 /** 263 * struct ieee80211_rate - bitrate definition 264 * 265 * This structure describes a bitrate that an 802.11 PHY can 266 * operate with. The two values @hw_value and @hw_value_short 267 * are only for driver use when pointers to this structure are 268 * passed around. 269 * 270 * @flags: rate-specific flags from &enum ieee80211_rate_flags 271 * @bitrate: bitrate in units of 100 Kbps 272 * @hw_value: driver/hardware value for this rate 273 * @hw_value_short: driver/hardware value for this rate when 274 * short preamble is used 275 */ 276 struct ieee80211_rate { 277 u32 flags; 278 u16 bitrate; 279 u16 hw_value, hw_value_short; 280 }; 281 282 /** 283 * struct ieee80211_he_obss_pd - AP settings for spatial reuse 284 * 285 * @enable: is the feature enabled. 286 * @sr_ctrl: The SR Control field of SRP element. 287 * @non_srg_max_offset: non-SRG maximum tx power offset 288 * @min_offset: minimal tx power offset an associated station shall use 289 * @max_offset: maximum tx power offset an associated station shall use 290 * @bss_color_bitmap: bitmap that indicates the BSS color values used by 291 * members of the SRG 292 * @partial_bssid_bitmap: bitmap that indicates the partial BSSID values 293 * used by members of the SRG 294 */ 295 struct ieee80211_he_obss_pd { 296 bool enable; 297 u8 sr_ctrl; 298 u8 non_srg_max_offset; 299 u8 min_offset; 300 u8 max_offset; 301 u8 bss_color_bitmap[8]; 302 u8 partial_bssid_bitmap[8]; 303 }; 304 305 /** 306 * struct cfg80211_he_bss_color - AP settings for BSS coloring 307 * 308 * @color: the current color. 309 * @enabled: HE BSS color is used 310 * @partial: define the AID equation. 311 */ 312 struct cfg80211_he_bss_color { 313 u8 color; 314 bool enabled; 315 bool partial; 316 }; 317 318 /** 319 * struct ieee80211_sta_ht_cap - STA's HT capabilities 320 * 321 * This structure describes most essential parameters needed 322 * to describe 802.11n HT capabilities for an STA. 323 * 324 * @ht_supported: is HT supported by the STA 325 * @cap: HT capabilities map as described in 802.11n spec 326 * @ampdu_factor: Maximum A-MPDU length factor 327 * @ampdu_density: Minimum A-MPDU spacing 328 * @mcs: Supported MCS rates 329 */ 330 struct ieee80211_sta_ht_cap { 331 u16 cap; /* use IEEE80211_HT_CAP_ */ 332 bool ht_supported; 333 u8 ampdu_factor; 334 u8 ampdu_density; 335 struct ieee80211_mcs_info mcs; 336 }; 337 338 /** 339 * struct ieee80211_sta_vht_cap - STA's VHT capabilities 340 * 341 * This structure describes most essential parameters needed 342 * to describe 802.11ac VHT capabilities for an STA. 343 * 344 * @vht_supported: is VHT supported by the STA 345 * @cap: VHT capabilities map as described in 802.11ac spec 346 * @vht_mcs: Supported VHT MCS rates 347 */ 348 struct ieee80211_sta_vht_cap { 349 bool vht_supported; 350 u32 cap; /* use IEEE80211_VHT_CAP_ */ 351 struct ieee80211_vht_mcs_info vht_mcs; 352 }; 353 354 #define IEEE80211_HE_PPE_THRES_MAX_LEN 25 355 356 /** 357 * struct ieee80211_sta_he_cap - STA's HE capabilities 358 * 359 * This structure describes most essential parameters needed 360 * to describe 802.11ax HE capabilities for a STA. 361 * 362 * @has_he: true iff HE data is valid. 363 * @he_cap_elem: Fixed portion of the HE capabilities element. 364 * @he_mcs_nss_supp: The supported NSS/MCS combinations. 365 * @ppe_thres: Holds the PPE Thresholds data. 366 */ 367 struct ieee80211_sta_he_cap { 368 bool has_he; 369 struct ieee80211_he_cap_elem he_cap_elem; 370 struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp; 371 u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN]; 372 }; 373 374 /** 375 * struct ieee80211_eht_mcs_nss_supp - EHT max supported NSS per MCS 376 * 377 * See P802.11be_D1.3 Table 9-401k - "Subfields of the Supported EHT-MCS 378 * and NSS Set field" 379 * 380 * @only_20mhz: MCS/NSS support for 20 MHz-only STA. 381 * @bw: MCS/NSS support for 80, 160 and 320 MHz 382 * @bw._80: MCS/NSS support for BW <= 80 MHz 383 * @bw._160: MCS/NSS support for BW = 160 MHz 384 * @bw._320: MCS/NSS support for BW = 320 MHz 385 */ 386 struct ieee80211_eht_mcs_nss_supp { 387 union { 388 struct ieee80211_eht_mcs_nss_supp_20mhz_only only_20mhz; 389 struct { 390 struct ieee80211_eht_mcs_nss_supp_bw _80; 391 struct ieee80211_eht_mcs_nss_supp_bw _160; 392 struct ieee80211_eht_mcs_nss_supp_bw _320; 393 } __packed bw; 394 } __packed; 395 } __packed; 396 397 #define IEEE80211_EHT_PPE_THRES_MAX_LEN 32 398 399 /** 400 * struct ieee80211_sta_eht_cap - STA's EHT capabilities 401 * 402 * This structure describes most essential parameters needed 403 * to describe 802.11be EHT capabilities for a STA. 404 * 405 * @has_eht: true iff EHT data is valid. 406 * @eht_cap_elem: Fixed portion of the eht capabilities element. 407 * @eht_mcs_nss_supp: The supported NSS/MCS combinations. 408 * @eht_ppe_thres: Holds the PPE Thresholds data. 409 */ 410 struct ieee80211_sta_eht_cap { 411 bool has_eht; 412 struct ieee80211_eht_cap_elem_fixed eht_cap_elem; 413 struct ieee80211_eht_mcs_nss_supp eht_mcs_nss_supp; 414 u8 eht_ppe_thres[IEEE80211_EHT_PPE_THRES_MAX_LEN]; 415 }; 416 417 /* sparse defines __CHECKER__; see Documentation/dev-tools/sparse.rst */ 418 #ifdef __CHECKER__ 419 /* 420 * This is used to mark the sband->iftype_data pointer which is supposed 421 * to be an array with special access semantics (per iftype), but a lot 422 * of code got it wrong in the past, so with this marking sparse will be 423 * noisy when the pointer is used directly. 424 */ 425 # define __iftd __attribute__((noderef, address_space(__iftype_data))) 426 #else 427 # define __iftd 428 #endif /* __CHECKER__ */ 429 430 /** 431 * struct ieee80211_sband_iftype_data - sband data per interface type 432 * 433 * This structure encapsulates sband data that is relevant for the 434 * interface types defined in @types_mask. Each type in the 435 * @types_mask must be unique across all instances of iftype_data. 436 * 437 * @types_mask: interface types mask 438 * @he_cap: holds the HE capabilities 439 * @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a 440 * 6 GHz band channel (and 0 may be valid value). 441 * @eht_cap: STA's EHT capabilities 442 * @vendor_elems: vendor element(s) to advertise 443 * @vendor_elems.data: vendor element(s) data 444 * @vendor_elems.len: vendor element(s) length 445 */ 446 struct ieee80211_sband_iftype_data { 447 u16 types_mask; 448 struct ieee80211_sta_he_cap he_cap; 449 struct ieee80211_he_6ghz_capa he_6ghz_capa; 450 struct ieee80211_sta_eht_cap eht_cap; 451 struct { 452 const u8 *data; 453 unsigned int len; 454 } vendor_elems; 455 }; 456 457 /** 458 * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations 459 * 460 * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz 461 * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz 462 * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz 463 * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz 464 * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz 465 * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz 466 * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz 467 * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and 468 * 2.16GHz+2.16GHz 469 * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and 470 * 4.32GHz + 4.32GHz 471 * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and 472 * 4.32GHz + 4.32GHz 473 * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz 474 * and 4.32GHz + 4.32GHz 475 * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz, 476 * 2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz 477 */ 478 enum ieee80211_edmg_bw_config { 479 IEEE80211_EDMG_BW_CONFIG_4 = 4, 480 IEEE80211_EDMG_BW_CONFIG_5 = 5, 481 IEEE80211_EDMG_BW_CONFIG_6 = 6, 482 IEEE80211_EDMG_BW_CONFIG_7 = 7, 483 IEEE80211_EDMG_BW_CONFIG_8 = 8, 484 IEEE80211_EDMG_BW_CONFIG_9 = 9, 485 IEEE80211_EDMG_BW_CONFIG_10 = 10, 486 IEEE80211_EDMG_BW_CONFIG_11 = 11, 487 IEEE80211_EDMG_BW_CONFIG_12 = 12, 488 IEEE80211_EDMG_BW_CONFIG_13 = 13, 489 IEEE80211_EDMG_BW_CONFIG_14 = 14, 490 IEEE80211_EDMG_BW_CONFIG_15 = 15, 491 }; 492 493 /** 494 * struct ieee80211_edmg - EDMG configuration 495 * 496 * This structure describes most essential parameters needed 497 * to describe 802.11ay EDMG configuration 498 * 499 * @channels: bitmap that indicates the 2.16 GHz channel(s) 500 * that are allowed to be used for transmissions. 501 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc. 502 * Set to 0 indicate EDMG not supported. 503 * @bw_config: Channel BW Configuration subfield encodes 504 * the allowed channel bandwidth configurations 505 */ 506 struct ieee80211_edmg { 507 u8 channels; 508 enum ieee80211_edmg_bw_config bw_config; 509 }; 510 511 /** 512 * struct ieee80211_sta_s1g_cap - STA's S1G capabilities 513 * 514 * This structure describes most essential parameters needed 515 * to describe 802.11ah S1G capabilities for a STA. 516 * 517 * @s1g: is STA an S1G STA 518 * @cap: S1G capabilities information 519 * @nss_mcs: Supported NSS MCS set 520 */ 521 struct ieee80211_sta_s1g_cap { 522 bool s1g; 523 u8 cap[10]; /* use S1G_CAPAB_ */ 524 u8 nss_mcs[5]; 525 }; 526 527 /** 528 * struct ieee80211_supported_band - frequency band definition 529 * 530 * This structure describes a frequency band a wiphy 531 * is able to operate in. 532 * 533 * @channels: Array of channels the hardware can operate with 534 * in this band. 535 * @band: the band this structure represents 536 * @n_channels: Number of channels in @channels 537 * @bitrates: Array of bitrates the hardware can operate with 538 * in this band. Must be sorted to give a valid "supported 539 * rates" IE, i.e. CCK rates first, then OFDM. 540 * @n_bitrates: Number of bitrates in @bitrates 541 * @ht_cap: HT capabilities in this band 542 * @vht_cap: VHT capabilities in this band 543 * @s1g_cap: S1G capabilities in this band 544 * @edmg_cap: EDMG capabilities in this band 545 * @s1g_cap: S1G capabilities in this band (S1B band only, of course) 546 * @n_iftype_data: number of iftype data entries 547 * @iftype_data: interface type data entries. Note that the bits in 548 * @types_mask inside this structure cannot overlap (i.e. only 549 * one occurrence of each type is allowed across all instances of 550 * iftype_data). 551 */ 552 struct ieee80211_supported_band { 553 struct ieee80211_channel *channels; 554 struct ieee80211_rate *bitrates; 555 enum nl80211_band band; 556 int n_channels; 557 int n_bitrates; 558 struct ieee80211_sta_ht_cap ht_cap; 559 struct ieee80211_sta_vht_cap vht_cap; 560 struct ieee80211_sta_s1g_cap s1g_cap; 561 struct ieee80211_edmg edmg_cap; 562 u16 n_iftype_data; 563 const struct ieee80211_sband_iftype_data __iftd *iftype_data; 564 }; 565 566 /** 567 * _ieee80211_set_sband_iftype_data - set sband iftype data array 568 * @sband: the sband to initialize 569 * @iftd: the iftype data array pointer 570 * @n_iftd: the length of the iftype data array 571 * 572 * Set the sband iftype data array; use this where the length cannot 573 * be derived from the ARRAY_SIZE() of the argument, but prefer 574 * ieee80211_set_sband_iftype_data() where it can be used. 575 */ 576 static inline void 577 _ieee80211_set_sband_iftype_data(struct ieee80211_supported_band *sband, 578 const struct ieee80211_sband_iftype_data *iftd, 579 u16 n_iftd) 580 { 581 sband->iftype_data = (const void __iftd __force *)iftd; 582 sband->n_iftype_data = n_iftd; 583 } 584 585 /** 586 * ieee80211_set_sband_iftype_data - set sband iftype data array 587 * @sband: the sband to initialize 588 * @iftd: the iftype data array 589 */ 590 #define ieee80211_set_sband_iftype_data(sband, iftd) \ 591 _ieee80211_set_sband_iftype_data(sband, iftd, ARRAY_SIZE(iftd)) 592 593 /** 594 * for_each_sband_iftype_data - iterate sband iftype data entries 595 * @sband: the sband whose iftype_data array to iterate 596 * @i: iterator counter 597 * @iftd: iftype data pointer to set 598 */ 599 #define for_each_sband_iftype_data(sband, i, iftd) \ 600 for (i = 0, iftd = (const void __force *)&(sband)->iftype_data[i]; \ 601 i < (sband)->n_iftype_data; \ 602 i++, iftd = (const void __force *)&(sband)->iftype_data[i]) 603 604 /** 605 * ieee80211_get_sband_iftype_data - return sband data for a given iftype 606 * @sband: the sband to search for the STA on 607 * @iftype: enum nl80211_iftype 608 * 609 * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found 610 */ 611 static inline const struct ieee80211_sband_iftype_data * 612 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband, 613 u8 iftype) 614 { 615 const struct ieee80211_sband_iftype_data *data; 616 int i; 617 618 if (WARN_ON(iftype >= NL80211_IFTYPE_MAX)) 619 return NULL; 620 621 if (iftype == NL80211_IFTYPE_AP_VLAN) 622 iftype = NL80211_IFTYPE_AP; 623 624 for_each_sband_iftype_data(sband, i, data) { 625 if (data->types_mask & BIT(iftype)) 626 return data; 627 } 628 629 return NULL; 630 } 631 632 /** 633 * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype 634 * @sband: the sband to search for the iftype on 635 * @iftype: enum nl80211_iftype 636 * 637 * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found 638 */ 639 static inline const struct ieee80211_sta_he_cap * 640 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband, 641 u8 iftype) 642 { 643 const struct ieee80211_sband_iftype_data *data = 644 ieee80211_get_sband_iftype_data(sband, iftype); 645 646 if (data && data->he_cap.has_he) 647 return &data->he_cap; 648 649 return NULL; 650 } 651 652 /** 653 * ieee80211_get_he_6ghz_capa - return HE 6 GHz capabilities 654 * @sband: the sband to search for the STA on 655 * @iftype: the iftype to search for 656 * 657 * Return: the 6GHz capabilities 658 */ 659 static inline __le16 660 ieee80211_get_he_6ghz_capa(const struct ieee80211_supported_band *sband, 661 enum nl80211_iftype iftype) 662 { 663 const struct ieee80211_sband_iftype_data *data = 664 ieee80211_get_sband_iftype_data(sband, iftype); 665 666 if (WARN_ON(!data || !data->he_cap.has_he)) 667 return 0; 668 669 return data->he_6ghz_capa.capa; 670 } 671 672 /** 673 * ieee80211_get_eht_iftype_cap - return ETH capabilities for an sband's iftype 674 * @sband: the sband to search for the iftype on 675 * @iftype: enum nl80211_iftype 676 * 677 * Return: pointer to the struct ieee80211_sta_eht_cap, or NULL is none found 678 */ 679 static inline const struct ieee80211_sta_eht_cap * 680 ieee80211_get_eht_iftype_cap(const struct ieee80211_supported_band *sband, 681 enum nl80211_iftype iftype) 682 { 683 const struct ieee80211_sband_iftype_data *data = 684 ieee80211_get_sband_iftype_data(sband, iftype); 685 686 if (data && data->eht_cap.has_eht) 687 return &data->eht_cap; 688 689 return NULL; 690 } 691 692 /** 693 * wiphy_read_of_freq_limits - read frequency limits from device tree 694 * 695 * @wiphy: the wireless device to get extra limits for 696 * 697 * Some devices may have extra limitations specified in DT. This may be useful 698 * for chipsets that normally support more bands but are limited due to board 699 * design (e.g. by antennas or external power amplifier). 700 * 701 * This function reads info from DT and uses it to *modify* channels (disable 702 * unavailable ones). It's usually a *bad* idea to use it in drivers with 703 * shared channel data as DT limitations are device specific. You should make 704 * sure to call it only if channels in wiphy are copied and can be modified 705 * without affecting other devices. 706 * 707 * As this function access device node it has to be called after set_wiphy_dev. 708 * It also modifies channels so they have to be set first. 709 * If using this helper, call it before wiphy_register(). 710 */ 711 #ifdef CONFIG_OF 712 void wiphy_read_of_freq_limits(struct wiphy *wiphy); 713 #else /* CONFIG_OF */ 714 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy) 715 { 716 } 717 #endif /* !CONFIG_OF */ 718 719 720 /* 721 * Wireless hardware/device configuration structures and methods 722 */ 723 724 /** 725 * DOC: Actions and configuration 726 * 727 * Each wireless device and each virtual interface offer a set of configuration 728 * operations and other actions that are invoked by userspace. Each of these 729 * actions is described in the operations structure, and the parameters these 730 * operations use are described separately. 731 * 732 * Additionally, some operations are asynchronous and expect to get status 733 * information via some functions that drivers need to call. 734 * 735 * Scanning and BSS list handling with its associated functionality is described 736 * in a separate chapter. 737 */ 738 739 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\ 740 WLAN_USER_POSITION_LEN) 741 742 /** 743 * struct vif_params - describes virtual interface parameters 744 * @flags: monitor interface flags, unchanged if 0, otherwise 745 * %MONITOR_FLAG_CHANGED will be set 746 * @use_4addr: use 4-address frames 747 * @macaddr: address to use for this virtual interface. 748 * If this parameter is set to zero address the driver may 749 * determine the address as needed. 750 * This feature is only fully supported by drivers that enable the 751 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating 752 ** only p2p devices with specified MAC. 753 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets 754 * belonging to that MU-MIMO groupID; %NULL if not changed 755 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring 756 * MU-MIMO packets going to the specified station; %NULL if not changed 757 */ 758 struct vif_params { 759 u32 flags; 760 int use_4addr; 761 u8 macaddr[ETH_ALEN]; 762 const u8 *vht_mumimo_groups; 763 const u8 *vht_mumimo_follow_addr; 764 }; 765 766 /** 767 * struct key_params - key information 768 * 769 * Information about a key 770 * 771 * @key: key material 772 * @key_len: length of key material 773 * @cipher: cipher suite selector 774 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used 775 * with the get_key() callback, must be in little endian, 776 * length given by @seq_len. 777 * @seq_len: length of @seq. 778 * @vlan_id: vlan_id for VLAN group key (if nonzero) 779 * @mode: key install mode (RX_TX, NO_TX or SET_TX) 780 */ 781 struct key_params { 782 const u8 *key; 783 const u8 *seq; 784 int key_len; 785 int seq_len; 786 u16 vlan_id; 787 u32 cipher; 788 enum nl80211_key_mode mode; 789 }; 790 791 /** 792 * struct cfg80211_chan_def - channel definition 793 * @chan: the (control) channel 794 * @width: channel width 795 * @center_freq1: center frequency of first segment 796 * @center_freq2: center frequency of second segment 797 * (only with 80+80 MHz) 798 * @edmg: define the EDMG channels configuration. 799 * If edmg is requested (i.e. the .channels member is non-zero), 800 * chan will define the primary channel and all other 801 * parameters are ignored. 802 * @freq1_offset: offset from @center_freq1, in KHz 803 */ 804 struct cfg80211_chan_def { 805 struct ieee80211_channel *chan; 806 enum nl80211_chan_width width; 807 u32 center_freq1; 808 u32 center_freq2; 809 struct ieee80211_edmg edmg; 810 u16 freq1_offset; 811 }; 812 813 /* 814 * cfg80211_bitrate_mask - masks for bitrate control 815 */ 816 struct cfg80211_bitrate_mask { 817 struct { 818 u32 legacy; 819 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN]; 820 u16 vht_mcs[NL80211_VHT_NSS_MAX]; 821 u16 he_mcs[NL80211_HE_NSS_MAX]; 822 enum nl80211_txrate_gi gi; 823 enum nl80211_he_gi he_gi; 824 enum nl80211_he_ltf he_ltf; 825 } control[NUM_NL80211_BANDS]; 826 }; 827 828 829 /** 830 * struct cfg80211_tid_cfg - TID specific configuration 831 * @config_override: Flag to notify driver to reset TID configuration 832 * of the peer. 833 * @tids: bitmap of TIDs to modify 834 * @mask: bitmap of attributes indicating which parameter changed, 835 * similar to &nl80211_tid_config_supp. 836 * @noack: noack configuration value for the TID 837 * @retry_long: retry count value 838 * @retry_short: retry count value 839 * @ampdu: Enable/Disable MPDU aggregation 840 * @rtscts: Enable/Disable RTS/CTS 841 * @amsdu: Enable/Disable MSDU aggregation 842 * @txrate_type: Tx bitrate mask type 843 * @txrate_mask: Tx bitrate to be applied for the TID 844 */ 845 struct cfg80211_tid_cfg { 846 bool config_override; 847 u8 tids; 848 u64 mask; 849 enum nl80211_tid_config noack; 850 u8 retry_long, retry_short; 851 enum nl80211_tid_config ampdu; 852 enum nl80211_tid_config rtscts; 853 enum nl80211_tid_config amsdu; 854 enum nl80211_tx_rate_setting txrate_type; 855 struct cfg80211_bitrate_mask txrate_mask; 856 }; 857 858 /** 859 * struct cfg80211_tid_config - TID configuration 860 * @peer: Station's MAC address 861 * @n_tid_conf: Number of TID specific configurations to be applied 862 * @tid_conf: Configuration change info 863 */ 864 struct cfg80211_tid_config { 865 const u8 *peer; 866 u32 n_tid_conf; 867 struct cfg80211_tid_cfg tid_conf[] __counted_by(n_tid_conf); 868 }; 869 870 /** 871 * struct cfg80211_fils_aad - FILS AAD data 872 * @macaddr: STA MAC address 873 * @kek: FILS KEK 874 * @kek_len: FILS KEK length 875 * @snonce: STA Nonce 876 * @anonce: AP Nonce 877 */ 878 struct cfg80211_fils_aad { 879 const u8 *macaddr; 880 const u8 *kek; 881 u8 kek_len; 882 const u8 *snonce; 883 const u8 *anonce; 884 }; 885 886 /** 887 * struct cfg80211_set_hw_timestamp - enable/disable HW timestamping 888 * @macaddr: peer MAC address. NULL to enable/disable HW timestamping for all 889 * addresses. 890 * @enable: if set, enable HW timestamping for the specified MAC address. 891 * Otherwise disable HW timestamping for the specified MAC address. 892 */ 893 struct cfg80211_set_hw_timestamp { 894 const u8 *macaddr; 895 bool enable; 896 }; 897 898 /** 899 * cfg80211_get_chandef_type - return old channel type from chandef 900 * @chandef: the channel definition 901 * 902 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given 903 * chandef, which must have a bandwidth allowing this conversion. 904 */ 905 static inline enum nl80211_channel_type 906 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef) 907 { 908 switch (chandef->width) { 909 case NL80211_CHAN_WIDTH_20_NOHT: 910 return NL80211_CHAN_NO_HT; 911 case NL80211_CHAN_WIDTH_20: 912 return NL80211_CHAN_HT20; 913 case NL80211_CHAN_WIDTH_40: 914 if (chandef->center_freq1 > chandef->chan->center_freq) 915 return NL80211_CHAN_HT40PLUS; 916 return NL80211_CHAN_HT40MINUS; 917 default: 918 WARN_ON(1); 919 return NL80211_CHAN_NO_HT; 920 } 921 } 922 923 /** 924 * cfg80211_chandef_create - create channel definition using channel type 925 * @chandef: the channel definition struct to fill 926 * @channel: the control channel 927 * @chantype: the channel type 928 * 929 * Given a channel type, create a channel definition. 930 */ 931 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef, 932 struct ieee80211_channel *channel, 933 enum nl80211_channel_type chantype); 934 935 /** 936 * cfg80211_chandef_identical - check if two channel definitions are identical 937 * @chandef1: first channel definition 938 * @chandef2: second channel definition 939 * 940 * Return: %true if the channels defined by the channel definitions are 941 * identical, %false otherwise. 942 */ 943 static inline bool 944 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1, 945 const struct cfg80211_chan_def *chandef2) 946 { 947 return (chandef1->chan == chandef2->chan && 948 chandef1->width == chandef2->width && 949 chandef1->center_freq1 == chandef2->center_freq1 && 950 chandef1->freq1_offset == chandef2->freq1_offset && 951 chandef1->center_freq2 == chandef2->center_freq2); 952 } 953 954 /** 955 * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel 956 * 957 * @chandef: the channel definition 958 * 959 * Return: %true if EDMG defined, %false otherwise. 960 */ 961 static inline bool 962 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef) 963 { 964 return chandef->edmg.channels || chandef->edmg.bw_config; 965 } 966 967 /** 968 * cfg80211_chandef_compatible - check if two channel definitions are compatible 969 * @chandef1: first channel definition 970 * @chandef2: second channel definition 971 * 972 * Return: %NULL if the given channel definitions are incompatible, 973 * chandef1 or chandef2 otherwise. 974 */ 975 const struct cfg80211_chan_def * 976 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1, 977 const struct cfg80211_chan_def *chandef2); 978 979 /** 980 * nl80211_chan_width_to_mhz - get the channel width in MHz 981 * @chan_width: the channel width from &enum nl80211_chan_width 982 * 983 * Return: channel width in MHz if the chan_width from &enum nl80211_chan_width 984 * is valid. -1 otherwise. 985 */ 986 int nl80211_chan_width_to_mhz(enum nl80211_chan_width chan_width); 987 988 /** 989 * cfg80211_chandef_valid - check if a channel definition is valid 990 * @chandef: the channel definition to check 991 * Return: %true if the channel definition is valid. %false otherwise. 992 */ 993 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef); 994 995 /** 996 * cfg80211_chandef_usable - check if secondary channels can be used 997 * @wiphy: the wiphy to validate against 998 * @chandef: the channel definition to check 999 * @prohibited_flags: the regulatory channel flags that must not be set 1000 * Return: %true if secondary channels are usable. %false otherwise. 1001 */ 1002 bool cfg80211_chandef_usable(struct wiphy *wiphy, 1003 const struct cfg80211_chan_def *chandef, 1004 u32 prohibited_flags); 1005 1006 /** 1007 * cfg80211_chandef_dfs_required - checks if radar detection is required 1008 * @wiphy: the wiphy to validate against 1009 * @chandef: the channel definition to check 1010 * @iftype: the interface type as specified in &enum nl80211_iftype 1011 * Returns: 1012 * 1 if radar detection is required, 0 if it is not, < 0 on error 1013 */ 1014 int cfg80211_chandef_dfs_required(struct wiphy *wiphy, 1015 const struct cfg80211_chan_def *chandef, 1016 enum nl80211_iftype iftype); 1017 1018 /** 1019 * cfg80211_chandef_dfs_usable - checks if chandef is DFS usable and we 1020 * can/need start CAC on such channel 1021 * @wiphy: the wiphy to validate against 1022 * @chandef: the channel definition to check 1023 * 1024 * Return: true if all channels available and at least 1025 * one channel requires CAC (NL80211_DFS_USABLE) 1026 */ 1027 bool cfg80211_chandef_dfs_usable(struct wiphy *wiphy, 1028 const struct cfg80211_chan_def *chandef); 1029 1030 /** 1031 * cfg80211_chandef_dfs_cac_time - get the DFS CAC time (in ms) for given 1032 * channel definition 1033 * @wiphy: the wiphy to validate against 1034 * @chandef: the channel definition to check 1035 * 1036 * Returns: DFS CAC time (in ms) which applies for this channel definition 1037 */ 1038 unsigned int 1039 cfg80211_chandef_dfs_cac_time(struct wiphy *wiphy, 1040 const struct cfg80211_chan_def *chandef); 1041 1042 /** 1043 * nl80211_send_chandef - sends the channel definition. 1044 * @msg: the msg to send channel definition 1045 * @chandef: the channel definition to check 1046 * 1047 * Returns: 0 if sent the channel definition to msg, < 0 on error 1048 **/ 1049 int nl80211_send_chandef(struct sk_buff *msg, const struct cfg80211_chan_def *chandef); 1050 1051 /** 1052 * ieee80211_chanwidth_rate_flags - return rate flags for channel width 1053 * @width: the channel width of the channel 1054 * 1055 * In some channel types, not all rates may be used - for example CCK 1056 * rates may not be used in 5/10 MHz channels. 1057 * 1058 * Returns: rate flags which apply for this channel width 1059 */ 1060 static inline enum ieee80211_rate_flags 1061 ieee80211_chanwidth_rate_flags(enum nl80211_chan_width width) 1062 { 1063 switch (width) { 1064 case NL80211_CHAN_WIDTH_5: 1065 return IEEE80211_RATE_SUPPORTS_5MHZ; 1066 case NL80211_CHAN_WIDTH_10: 1067 return IEEE80211_RATE_SUPPORTS_10MHZ; 1068 default: 1069 break; 1070 } 1071 return 0; 1072 } 1073 1074 /** 1075 * ieee80211_chandef_rate_flags - returns rate flags for a channel 1076 * @chandef: channel definition for the channel 1077 * 1078 * See ieee80211_chanwidth_rate_flags(). 1079 * 1080 * Returns: rate flags which apply for this channel 1081 */ 1082 static inline enum ieee80211_rate_flags 1083 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef) 1084 { 1085 return ieee80211_chanwidth_rate_flags(chandef->width); 1086 } 1087 1088 /** 1089 * ieee80211_chandef_max_power - maximum transmission power for the chandef 1090 * 1091 * In some regulations, the transmit power may depend on the configured channel 1092 * bandwidth which may be defined as dBm/MHz. This function returns the actual 1093 * max_power for non-standard (20 MHz) channels. 1094 * 1095 * @chandef: channel definition for the channel 1096 * 1097 * Returns: maximum allowed transmission power in dBm for the chandef 1098 */ 1099 static inline int 1100 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef) 1101 { 1102 switch (chandef->width) { 1103 case NL80211_CHAN_WIDTH_5: 1104 return min(chandef->chan->max_reg_power - 6, 1105 chandef->chan->max_power); 1106 case NL80211_CHAN_WIDTH_10: 1107 return min(chandef->chan->max_reg_power - 3, 1108 chandef->chan->max_power); 1109 default: 1110 break; 1111 } 1112 return chandef->chan->max_power; 1113 } 1114 1115 /** 1116 * cfg80211_any_usable_channels - check for usable channels 1117 * @wiphy: the wiphy to check for 1118 * @band_mask: which bands to check on 1119 * @prohibited_flags: which channels to not consider usable, 1120 * %IEEE80211_CHAN_DISABLED is always taken into account 1121 */ 1122 bool cfg80211_any_usable_channels(struct wiphy *wiphy, 1123 unsigned long band_mask, 1124 u32 prohibited_flags); 1125 1126 /** 1127 * enum survey_info_flags - survey information flags 1128 * 1129 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in 1130 * @SURVEY_INFO_IN_USE: channel is currently being used 1131 * @SURVEY_INFO_TIME: active time (in ms) was filled in 1132 * @SURVEY_INFO_TIME_BUSY: busy time was filled in 1133 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in 1134 * @SURVEY_INFO_TIME_RX: receive time was filled in 1135 * @SURVEY_INFO_TIME_TX: transmit time was filled in 1136 * @SURVEY_INFO_TIME_SCAN: scan time was filled in 1137 * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in 1138 * 1139 * Used by the driver to indicate which info in &struct survey_info 1140 * it has filled in during the get_survey(). 1141 */ 1142 enum survey_info_flags { 1143 SURVEY_INFO_NOISE_DBM = BIT(0), 1144 SURVEY_INFO_IN_USE = BIT(1), 1145 SURVEY_INFO_TIME = BIT(2), 1146 SURVEY_INFO_TIME_BUSY = BIT(3), 1147 SURVEY_INFO_TIME_EXT_BUSY = BIT(4), 1148 SURVEY_INFO_TIME_RX = BIT(5), 1149 SURVEY_INFO_TIME_TX = BIT(6), 1150 SURVEY_INFO_TIME_SCAN = BIT(7), 1151 SURVEY_INFO_TIME_BSS_RX = BIT(8), 1152 }; 1153 1154 /** 1155 * struct survey_info - channel survey response 1156 * 1157 * @channel: the channel this survey record reports, may be %NULL for a single 1158 * record to report global statistics 1159 * @filled: bitflag of flags from &enum survey_info_flags 1160 * @noise: channel noise in dBm. This and all following fields are 1161 * optional 1162 * @time: amount of time in ms the radio was turn on (on the channel) 1163 * @time_busy: amount of time the primary channel was sensed busy 1164 * @time_ext_busy: amount of time the extension channel was sensed busy 1165 * @time_rx: amount of time the radio spent receiving data 1166 * @time_tx: amount of time the radio spent transmitting data 1167 * @time_scan: amount of time the radio spent for scanning 1168 * @time_bss_rx: amount of time the radio spent receiving data on a local BSS 1169 * 1170 * Used by dump_survey() to report back per-channel survey information. 1171 * 1172 * This structure can later be expanded with things like 1173 * channel duty cycle etc. 1174 */ 1175 struct survey_info { 1176 struct ieee80211_channel *channel; 1177 u64 time; 1178 u64 time_busy; 1179 u64 time_ext_busy; 1180 u64 time_rx; 1181 u64 time_tx; 1182 u64 time_scan; 1183 u64 time_bss_rx; 1184 u32 filled; 1185 s8 noise; 1186 }; 1187 1188 #define CFG80211_MAX_NUM_AKM_SUITES 10 1189 1190 /** 1191 * struct cfg80211_crypto_settings - Crypto settings 1192 * @wpa_versions: indicates which, if any, WPA versions are enabled 1193 * (from enum nl80211_wpa_versions) 1194 * @cipher_group: group key cipher suite (or 0 if unset) 1195 * @n_ciphers_pairwise: number of AP supported unicast ciphers 1196 * @ciphers_pairwise: unicast key cipher suites 1197 * @n_akm_suites: number of AKM suites 1198 * @akm_suites: AKM suites 1199 * @control_port: Whether user space controls IEEE 802.1X port, i.e., 1200 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is 1201 * required to assume that the port is unauthorized until authorized by 1202 * user space. Otherwise, port is marked authorized by default. 1203 * @control_port_ethertype: the control port protocol that should be 1204 * allowed through even on unauthorized ports 1205 * @control_port_no_encrypt: TRUE to prevent encryption of control port 1206 * protocol frames. 1207 * @control_port_over_nl80211: TRUE if userspace expects to exchange control 1208 * port frames over NL80211 instead of the network interface. 1209 * @control_port_no_preauth: disables pre-auth rx over the nl80211 control 1210 * port for mac80211 1211 * @psk: PSK (for devices supporting 4-way-handshake offload) 1212 * @sae_pwd: password for SAE authentication (for devices supporting SAE 1213 * offload) 1214 * @sae_pwd_len: length of SAE password (for devices supporting SAE offload) 1215 * @sae_pwe: The mechanisms allowed for SAE PWE derivation: 1216 * 1217 * NL80211_SAE_PWE_UNSPECIFIED 1218 * Not-specified, used to indicate userspace did not specify any 1219 * preference. The driver should follow its internal policy in 1220 * such a scenario. 1221 * 1222 * NL80211_SAE_PWE_HUNT_AND_PECK 1223 * Allow hunting-and-pecking loop only 1224 * 1225 * NL80211_SAE_PWE_HASH_TO_ELEMENT 1226 * Allow hash-to-element only 1227 * 1228 * NL80211_SAE_PWE_BOTH 1229 * Allow either hunting-and-pecking loop or hash-to-element 1230 */ 1231 struct cfg80211_crypto_settings { 1232 u32 wpa_versions; 1233 u32 cipher_group; 1234 int n_ciphers_pairwise; 1235 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES]; 1236 int n_akm_suites; 1237 u32 akm_suites[CFG80211_MAX_NUM_AKM_SUITES]; 1238 bool control_port; 1239 __be16 control_port_ethertype; 1240 bool control_port_no_encrypt; 1241 bool control_port_over_nl80211; 1242 bool control_port_no_preauth; 1243 const u8 *psk; 1244 const u8 *sae_pwd; 1245 u8 sae_pwd_len; 1246 enum nl80211_sae_pwe_mechanism sae_pwe; 1247 }; 1248 1249 /** 1250 * struct cfg80211_mbssid_config - AP settings for multi bssid 1251 * 1252 * @tx_wdev: pointer to the transmitted interface in the MBSSID set 1253 * @index: index of this AP in the multi bssid group. 1254 * @ema: set to true if the beacons should be sent out in EMA mode. 1255 */ 1256 struct cfg80211_mbssid_config { 1257 struct wireless_dev *tx_wdev; 1258 u8 index; 1259 bool ema; 1260 }; 1261 1262 /** 1263 * struct cfg80211_mbssid_elems - Multiple BSSID elements 1264 * 1265 * @cnt: Number of elements in array %elems. 1266 * 1267 * @elem: Array of multiple BSSID element(s) to be added into Beacon frames. 1268 * @elem.data: Data for multiple BSSID elements. 1269 * @elem.len: Length of data. 1270 */ 1271 struct cfg80211_mbssid_elems { 1272 u8 cnt; 1273 struct { 1274 const u8 *data; 1275 size_t len; 1276 } elem[] __counted_by(cnt); 1277 }; 1278 1279 /** 1280 * struct cfg80211_rnr_elems - Reduced neighbor report (RNR) elements 1281 * 1282 * @cnt: Number of elements in array %elems. 1283 * 1284 * @elem: Array of RNR element(s) to be added into Beacon frames. 1285 * @elem.data: Data for RNR elements. 1286 * @elem.len: Length of data. 1287 */ 1288 struct cfg80211_rnr_elems { 1289 u8 cnt; 1290 struct { 1291 const u8 *data; 1292 size_t len; 1293 } elem[] __counted_by(cnt); 1294 }; 1295 1296 /** 1297 * struct cfg80211_beacon_data - beacon data 1298 * @link_id: the link ID for the AP MLD link sending this beacon 1299 * @head: head portion of beacon (before TIM IE) 1300 * or %NULL if not changed 1301 * @tail: tail portion of beacon (after TIM IE) 1302 * or %NULL if not changed 1303 * @head_len: length of @head 1304 * @tail_len: length of @tail 1305 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL 1306 * @beacon_ies_len: length of beacon_ies in octets 1307 * @proberesp_ies: extra information element(s) to add into Probe Response 1308 * frames or %NULL 1309 * @proberesp_ies_len: length of proberesp_ies in octets 1310 * @assocresp_ies: extra information element(s) to add into (Re)Association 1311 * Response frames or %NULL 1312 * @assocresp_ies_len: length of assocresp_ies in octets 1313 * @probe_resp_len: length of probe response template (@probe_resp) 1314 * @probe_resp: probe response template (AP mode only) 1315 * @mbssid_ies: multiple BSSID elements 1316 * @rnr_ies: reduced neighbor report elements 1317 * @ftm_responder: enable FTM responder functionality; -1 for no change 1318 * (which also implies no change in LCI/civic location data) 1319 * @lci: Measurement Report element content, starting with Measurement Token 1320 * (measurement type 8) 1321 * @civicloc: Measurement Report element content, starting with Measurement 1322 * Token (measurement type 11) 1323 * @lci_len: LCI data length 1324 * @civicloc_len: Civic location data length 1325 * @he_bss_color: BSS Color settings 1326 * @he_bss_color_valid: indicates whether bss color 1327 * attribute is present in beacon data or not. 1328 */ 1329 struct cfg80211_beacon_data { 1330 unsigned int link_id; 1331 1332 const u8 *head, *tail; 1333 const u8 *beacon_ies; 1334 const u8 *proberesp_ies; 1335 const u8 *assocresp_ies; 1336 const u8 *probe_resp; 1337 const u8 *lci; 1338 const u8 *civicloc; 1339 struct cfg80211_mbssid_elems *mbssid_ies; 1340 struct cfg80211_rnr_elems *rnr_ies; 1341 s8 ftm_responder; 1342 1343 size_t head_len, tail_len; 1344 size_t beacon_ies_len; 1345 size_t proberesp_ies_len; 1346 size_t assocresp_ies_len; 1347 size_t probe_resp_len; 1348 size_t lci_len; 1349 size_t civicloc_len; 1350 struct cfg80211_he_bss_color he_bss_color; 1351 bool he_bss_color_valid; 1352 }; 1353 1354 struct mac_address { 1355 u8 addr[ETH_ALEN]; 1356 }; 1357 1358 /** 1359 * struct cfg80211_acl_data - Access control list data 1360 * 1361 * @acl_policy: ACL policy to be applied on the station's 1362 * entry specified by mac_addr 1363 * @n_acl_entries: Number of MAC address entries passed 1364 * @mac_addrs: List of MAC addresses of stations to be used for ACL 1365 */ 1366 struct cfg80211_acl_data { 1367 enum nl80211_acl_policy acl_policy; 1368 int n_acl_entries; 1369 1370 /* Keep it last */ 1371 struct mac_address mac_addrs[] __counted_by(n_acl_entries); 1372 }; 1373 1374 /** 1375 * struct cfg80211_fils_discovery - FILS discovery parameters from 1376 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail. 1377 * 1378 * @update: Set to true if the feature configuration should be updated. 1379 * @min_interval: Minimum packet interval in TUs (0 - 10000) 1380 * @max_interval: Maximum packet interval in TUs (0 - 10000) 1381 * @tmpl_len: Template length 1382 * @tmpl: Template data for FILS discovery frame including the action 1383 * frame headers. 1384 */ 1385 struct cfg80211_fils_discovery { 1386 bool update; 1387 u32 min_interval; 1388 u32 max_interval; 1389 size_t tmpl_len; 1390 const u8 *tmpl; 1391 }; 1392 1393 /** 1394 * struct cfg80211_unsol_bcast_probe_resp - Unsolicited broadcast probe 1395 * response parameters in 6GHz. 1396 * 1397 * @update: Set to true if the feature configuration should be updated. 1398 * @interval: Packet interval in TUs. Maximum allowed is 20 TU, as mentioned 1399 * in IEEE P802.11ax/D6.0 26.17.2.3.2 - AP behavior for fast passive 1400 * scanning 1401 * @tmpl_len: Template length 1402 * @tmpl: Template data for probe response 1403 */ 1404 struct cfg80211_unsol_bcast_probe_resp { 1405 bool update; 1406 u32 interval; 1407 size_t tmpl_len; 1408 const u8 *tmpl; 1409 }; 1410 1411 /** 1412 * struct cfg80211_ap_settings - AP configuration 1413 * 1414 * Used to configure an AP interface. 1415 * 1416 * @chandef: defines the channel to use 1417 * @beacon: beacon data 1418 * @beacon_interval: beacon interval 1419 * @dtim_period: DTIM period 1420 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from 1421 * user space) 1422 * @ssid_len: length of @ssid 1423 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames 1424 * @crypto: crypto settings 1425 * @privacy: the BSS uses privacy 1426 * @auth_type: Authentication type (algorithm) 1427 * @smps_mode: SMPS mode 1428 * @inactivity_timeout: time in seconds to determine station's inactivity. 1429 * @p2p_ctwindow: P2P CT Window 1430 * @p2p_opp_ps: P2P opportunistic PS 1431 * @acl: ACL configuration used by the drivers which has support for 1432 * MAC address based access control 1433 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG 1434 * networks. 1435 * @beacon_rate: bitrate to be used for beacons 1436 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled) 1437 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled) 1438 * @he_cap: HE capabilities (or %NULL if HE isn't enabled) 1439 * @eht_cap: EHT capabilities (or %NULL if EHT isn't enabled) 1440 * @eht_oper: EHT operation IE (or %NULL if EHT isn't enabled) 1441 * @ht_required: stations must support HT 1442 * @vht_required: stations must support VHT 1443 * @twt_responder: Enable Target Wait Time 1444 * @he_required: stations must support HE 1445 * @sae_h2e_required: stations must support direct H2E technique in SAE 1446 * @flags: flags, as defined in &enum nl80211_ap_settings_flags 1447 * @he_obss_pd: OBSS Packet Detection settings 1448 * @he_oper: HE operation IE (or %NULL if HE isn't enabled) 1449 * @fils_discovery: FILS discovery transmission parameters 1450 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters 1451 * @mbssid_config: AP settings for multiple bssid 1452 * @punct_bitmap: Preamble puncturing bitmap. Each bit represents 1453 * a 20 MHz channel, lowest bit corresponding to the lowest channel. 1454 * Bit set to 1 indicates that the channel is punctured. 1455 */ 1456 struct cfg80211_ap_settings { 1457 struct cfg80211_chan_def chandef; 1458 1459 struct cfg80211_beacon_data beacon; 1460 1461 int beacon_interval, dtim_period; 1462 const u8 *ssid; 1463 size_t ssid_len; 1464 enum nl80211_hidden_ssid hidden_ssid; 1465 struct cfg80211_crypto_settings crypto; 1466 bool privacy; 1467 enum nl80211_auth_type auth_type; 1468 enum nl80211_smps_mode smps_mode; 1469 int inactivity_timeout; 1470 u8 p2p_ctwindow; 1471 bool p2p_opp_ps; 1472 const struct cfg80211_acl_data *acl; 1473 bool pbss; 1474 struct cfg80211_bitrate_mask beacon_rate; 1475 1476 const struct ieee80211_ht_cap *ht_cap; 1477 const struct ieee80211_vht_cap *vht_cap; 1478 const struct ieee80211_he_cap_elem *he_cap; 1479 const struct ieee80211_he_operation *he_oper; 1480 const struct ieee80211_eht_cap_elem *eht_cap; 1481 const struct ieee80211_eht_operation *eht_oper; 1482 bool ht_required, vht_required, he_required, sae_h2e_required; 1483 bool twt_responder; 1484 u32 flags; 1485 struct ieee80211_he_obss_pd he_obss_pd; 1486 struct cfg80211_fils_discovery fils_discovery; 1487 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp; 1488 struct cfg80211_mbssid_config mbssid_config; 1489 u16 punct_bitmap; 1490 }; 1491 1492 1493 /** 1494 * struct cfg80211_ap_update - AP configuration update 1495 * 1496 * Subset of &struct cfg80211_ap_settings, for updating a running AP. 1497 * 1498 * @beacon: beacon data 1499 * @fils_discovery: FILS discovery transmission parameters 1500 * @unsol_bcast_probe_resp: Unsolicited broadcast probe response parameters 1501 */ 1502 struct cfg80211_ap_update { 1503 struct cfg80211_beacon_data beacon; 1504 struct cfg80211_fils_discovery fils_discovery; 1505 struct cfg80211_unsol_bcast_probe_resp unsol_bcast_probe_resp; 1506 }; 1507 1508 /** 1509 * struct cfg80211_csa_settings - channel switch settings 1510 * 1511 * Used for channel switch 1512 * 1513 * @chandef: defines the channel to use after the switch 1514 * @beacon_csa: beacon data while performing the switch 1515 * @counter_offsets_beacon: offsets of the counters within the beacon (tail) 1516 * @counter_offsets_presp: offsets of the counters within the probe response 1517 * @n_counter_offsets_beacon: number of csa counters the beacon (tail) 1518 * @n_counter_offsets_presp: number of csa counters in the probe response 1519 * @beacon_after: beacon data to be used on the new channel 1520 * @radar_required: whether radar detection is required on the new channel 1521 * @block_tx: whether transmissions should be blocked while changing 1522 * @count: number of beacons until switch 1523 * @punct_bitmap: Preamble puncturing bitmap. Each bit represents 1524 * a 20 MHz channel, lowest bit corresponding to the lowest channel. 1525 * Bit set to 1 indicates that the channel is punctured. 1526 */ 1527 struct cfg80211_csa_settings { 1528 struct cfg80211_chan_def chandef; 1529 struct cfg80211_beacon_data beacon_csa; 1530 const u16 *counter_offsets_beacon; 1531 const u16 *counter_offsets_presp; 1532 unsigned int n_counter_offsets_beacon; 1533 unsigned int n_counter_offsets_presp; 1534 struct cfg80211_beacon_data beacon_after; 1535 bool radar_required; 1536 bool block_tx; 1537 u8 count; 1538 u16 punct_bitmap; 1539 }; 1540 1541 /** 1542 * struct cfg80211_color_change_settings - color change settings 1543 * 1544 * Used for bss color change 1545 * 1546 * @beacon_color_change: beacon data while performing the color countdown 1547 * @counter_offset_beacon: offsets of the counters within the beacon (tail) 1548 * @counter_offset_presp: offsets of the counters within the probe response 1549 * @beacon_next: beacon data to be used after the color change 1550 * @count: number of beacons until the color change 1551 * @color: the color used after the change 1552 */ 1553 struct cfg80211_color_change_settings { 1554 struct cfg80211_beacon_data beacon_color_change; 1555 u16 counter_offset_beacon; 1556 u16 counter_offset_presp; 1557 struct cfg80211_beacon_data beacon_next; 1558 u8 count; 1559 u8 color; 1560 }; 1561 1562 /** 1563 * struct iface_combination_params - input parameters for interface combinations 1564 * 1565 * Used to pass interface combination parameters 1566 * 1567 * @num_different_channels: the number of different channels we want 1568 * to use for verification 1569 * @radar_detect: a bitmap where each bit corresponds to a channel 1570 * width where radar detection is needed, as in the definition of 1571 * &struct ieee80211_iface_combination.@radar_detect_widths 1572 * @iftype_num: array with the number of interfaces of each interface 1573 * type. The index is the interface type as specified in &enum 1574 * nl80211_iftype. 1575 * @new_beacon_int: set this to the beacon interval of a new interface 1576 * that's not operating yet, if such is to be checked as part of 1577 * the verification 1578 */ 1579 struct iface_combination_params { 1580 int num_different_channels; 1581 u8 radar_detect; 1582 int iftype_num[NUM_NL80211_IFTYPES]; 1583 u32 new_beacon_int; 1584 }; 1585 1586 /** 1587 * enum station_parameters_apply_mask - station parameter values to apply 1588 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp) 1589 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability 1590 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state 1591 * 1592 * Not all station parameters have in-band "no change" signalling, 1593 * for those that don't these flags will are used. 1594 */ 1595 enum station_parameters_apply_mask { 1596 STATION_PARAM_APPLY_UAPSD = BIT(0), 1597 STATION_PARAM_APPLY_CAPABILITY = BIT(1), 1598 STATION_PARAM_APPLY_PLINK_STATE = BIT(2), 1599 }; 1600 1601 /** 1602 * struct sta_txpwr - station txpower configuration 1603 * 1604 * Used to configure txpower for station. 1605 * 1606 * @power: tx power (in dBm) to be used for sending data traffic. If tx power 1607 * is not provided, the default per-interface tx power setting will be 1608 * overriding. Driver should be picking up the lowest tx power, either tx 1609 * power per-interface or per-station. 1610 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power 1611 * will be less than or equal to specified from userspace, whereas if TPC 1612 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power. 1613 * NL80211_TX_POWER_FIXED is not a valid configuration option for 1614 * per peer TPC. 1615 */ 1616 struct sta_txpwr { 1617 s16 power; 1618 enum nl80211_tx_power_setting type; 1619 }; 1620 1621 /** 1622 * struct link_station_parameters - link station parameters 1623 * 1624 * Used to change and create a new link station. 1625 * 1626 * @mld_mac: MAC address of the station 1627 * @link_id: the link id (-1 for non-MLD station) 1628 * @link_mac: MAC address of the link 1629 * @supported_rates: supported rates in IEEE 802.11 format 1630 * (or NULL for no change) 1631 * @supported_rates_len: number of supported rates 1632 * @ht_capa: HT capabilities of station 1633 * @vht_capa: VHT capabilities of station 1634 * @opmode_notif: operating mode field from Operating Mode Notification 1635 * @opmode_notif_used: information if operating mode field is used 1636 * @he_capa: HE capabilities of station 1637 * @he_capa_len: the length of the HE capabilities 1638 * @txpwr: transmit power for an associated station 1639 * @txpwr_set: txpwr field is set 1640 * @he_6ghz_capa: HE 6 GHz Band capabilities of station 1641 * @eht_capa: EHT capabilities of station 1642 * @eht_capa_len: the length of the EHT capabilities 1643 */ 1644 struct link_station_parameters { 1645 const u8 *mld_mac; 1646 int link_id; 1647 const u8 *link_mac; 1648 const u8 *supported_rates; 1649 u8 supported_rates_len; 1650 const struct ieee80211_ht_cap *ht_capa; 1651 const struct ieee80211_vht_cap *vht_capa; 1652 u8 opmode_notif; 1653 bool opmode_notif_used; 1654 const struct ieee80211_he_cap_elem *he_capa; 1655 u8 he_capa_len; 1656 struct sta_txpwr txpwr; 1657 bool txpwr_set; 1658 const struct ieee80211_he_6ghz_capa *he_6ghz_capa; 1659 const struct ieee80211_eht_cap_elem *eht_capa; 1660 u8 eht_capa_len; 1661 }; 1662 1663 /** 1664 * struct link_station_del_parameters - link station deletion parameters 1665 * 1666 * Used to delete a link station entry (or all stations). 1667 * 1668 * @mld_mac: MAC address of the station 1669 * @link_id: the link id 1670 */ 1671 struct link_station_del_parameters { 1672 const u8 *mld_mac; 1673 u32 link_id; 1674 }; 1675 1676 /** 1677 * struct cfg80211_ttlm_params: TID to link mapping parameters 1678 * 1679 * Used for setting a TID to link mapping. 1680 * 1681 * @dlink: Downlink TID to link mapping, as defined in section 9.4.2.314 1682 * (TID-To-Link Mapping element) in Draft P802.11be_D4.0. 1683 * @ulink: Uplink TID to link mapping, as defined in section 9.4.2.314 1684 * (TID-To-Link Mapping element) in Draft P802.11be_D4.0. 1685 */ 1686 struct cfg80211_ttlm_params { 1687 u16 dlink[8]; 1688 u16 ulink[8]; 1689 }; 1690 1691 /** 1692 * struct station_parameters - station parameters 1693 * 1694 * Used to change and create a new station. 1695 * 1696 * @vlan: vlan interface station should belong to 1697 * @sta_flags_mask: station flags that changed 1698 * (bitmask of BIT(%NL80211_STA_FLAG_...)) 1699 * @sta_flags_set: station flags values 1700 * (bitmask of BIT(%NL80211_STA_FLAG_...)) 1701 * @listen_interval: listen interval or -1 for no change 1702 * @aid: AID or zero for no change 1703 * @vlan_id: VLAN ID for station (if nonzero) 1704 * @peer_aid: mesh peer AID or zero for no change 1705 * @plink_action: plink action to take 1706 * @plink_state: set the peer link state for a station 1707 * @uapsd_queues: bitmap of queues configured for uapsd. same format 1708 * as the AC bitmap in the QoS info field 1709 * @max_sp: max Service Period. same format as the MAX_SP in the 1710 * QoS info field (but already shifted down) 1711 * @sta_modify_mask: bitmap indicating which parameters changed 1712 * (for those that don't have a natural "no change" value), 1713 * see &enum station_parameters_apply_mask 1714 * @local_pm: local link-specific mesh power save mode (no change when set 1715 * to unknown) 1716 * @capability: station capability 1717 * @ext_capab: extended capabilities of the station 1718 * @ext_capab_len: number of extended capabilities 1719 * @supported_channels: supported channels in IEEE 802.11 format 1720 * @supported_channels_len: number of supported channels 1721 * @supported_oper_classes: supported oper classes in IEEE 802.11 format 1722 * @supported_oper_classes_len: number of supported operating classes 1723 * @support_p2p_ps: information if station supports P2P PS mechanism 1724 * @airtime_weight: airtime scheduler weight for this station 1725 * @link_sta_params: link related params. 1726 */ 1727 struct station_parameters { 1728 struct net_device *vlan; 1729 u32 sta_flags_mask, sta_flags_set; 1730 u32 sta_modify_mask; 1731 int listen_interval; 1732 u16 aid; 1733 u16 vlan_id; 1734 u16 peer_aid; 1735 u8 plink_action; 1736 u8 plink_state; 1737 u8 uapsd_queues; 1738 u8 max_sp; 1739 enum nl80211_mesh_power_mode local_pm; 1740 u16 capability; 1741 const u8 *ext_capab; 1742 u8 ext_capab_len; 1743 const u8 *supported_channels; 1744 u8 supported_channels_len; 1745 const u8 *supported_oper_classes; 1746 u8 supported_oper_classes_len; 1747 int support_p2p_ps; 1748 u16 airtime_weight; 1749 struct link_station_parameters link_sta_params; 1750 }; 1751 1752 /** 1753 * struct station_del_parameters - station deletion parameters 1754 * 1755 * Used to delete a station entry (or all stations). 1756 * 1757 * @mac: MAC address of the station to remove or NULL to remove all stations 1758 * @subtype: Management frame subtype to use for indicating removal 1759 * (10 = Disassociation, 12 = Deauthentication) 1760 * @reason_code: Reason code for the Disassociation/Deauthentication frame 1761 */ 1762 struct station_del_parameters { 1763 const u8 *mac; 1764 u8 subtype; 1765 u16 reason_code; 1766 }; 1767 1768 /** 1769 * enum cfg80211_station_type - the type of station being modified 1770 * @CFG80211_STA_AP_CLIENT: client of an AP interface 1771 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still 1772 * unassociated (update properties for this type of client is permitted) 1773 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has 1774 * the AP MLME in the device 1775 * @CFG80211_STA_AP_STA: AP station on managed interface 1776 * @CFG80211_STA_IBSS: IBSS station 1777 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry 1778 * while TDLS setup is in progress, it moves out of this state when 1779 * being marked authorized; use this only if TDLS with external setup is 1780 * supported/used) 1781 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active 1782 * entry that is operating, has been marked authorized by userspace) 1783 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed) 1784 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed) 1785 */ 1786 enum cfg80211_station_type { 1787 CFG80211_STA_AP_CLIENT, 1788 CFG80211_STA_AP_CLIENT_UNASSOC, 1789 CFG80211_STA_AP_MLME_CLIENT, 1790 CFG80211_STA_AP_STA, 1791 CFG80211_STA_IBSS, 1792 CFG80211_STA_TDLS_PEER_SETUP, 1793 CFG80211_STA_TDLS_PEER_ACTIVE, 1794 CFG80211_STA_MESH_PEER_KERNEL, 1795 CFG80211_STA_MESH_PEER_USER, 1796 }; 1797 1798 /** 1799 * cfg80211_check_station_change - validate parameter changes 1800 * @wiphy: the wiphy this operates on 1801 * @params: the new parameters for a station 1802 * @statype: the type of station being modified 1803 * 1804 * Utility function for the @change_station driver method. Call this function 1805 * with the appropriate station type looking up the station (and checking that 1806 * it exists). It will verify whether the station change is acceptable, and if 1807 * not will return an error code. Note that it may modify the parameters for 1808 * backward compatibility reasons, so don't use them before calling this. 1809 */ 1810 int cfg80211_check_station_change(struct wiphy *wiphy, 1811 struct station_parameters *params, 1812 enum cfg80211_station_type statype); 1813 1814 /** 1815 * enum rate_info_flags - bitrate info flags 1816 * 1817 * Used by the driver to indicate the specific rate transmission 1818 * type for 802.11n transmissions. 1819 * 1820 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS 1821 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS 1822 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval 1823 * @RATE_INFO_FLAGS_DMG: 60GHz MCS 1824 * @RATE_INFO_FLAGS_HE_MCS: HE MCS information 1825 * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode 1826 * @RATE_INFO_FLAGS_EXTENDED_SC_DMG: 60GHz extended SC MCS 1827 * @RATE_INFO_FLAGS_EHT_MCS: EHT MCS information 1828 * @RATE_INFO_FLAGS_S1G_MCS: MCS field filled with S1G MCS 1829 */ 1830 enum rate_info_flags { 1831 RATE_INFO_FLAGS_MCS = BIT(0), 1832 RATE_INFO_FLAGS_VHT_MCS = BIT(1), 1833 RATE_INFO_FLAGS_SHORT_GI = BIT(2), 1834 RATE_INFO_FLAGS_DMG = BIT(3), 1835 RATE_INFO_FLAGS_HE_MCS = BIT(4), 1836 RATE_INFO_FLAGS_EDMG = BIT(5), 1837 RATE_INFO_FLAGS_EXTENDED_SC_DMG = BIT(6), 1838 RATE_INFO_FLAGS_EHT_MCS = BIT(7), 1839 RATE_INFO_FLAGS_S1G_MCS = BIT(8), 1840 }; 1841 1842 /** 1843 * enum rate_info_bw - rate bandwidth information 1844 * 1845 * Used by the driver to indicate the rate bandwidth. 1846 * 1847 * @RATE_INFO_BW_5: 5 MHz bandwidth 1848 * @RATE_INFO_BW_10: 10 MHz bandwidth 1849 * @RATE_INFO_BW_20: 20 MHz bandwidth 1850 * @RATE_INFO_BW_40: 40 MHz bandwidth 1851 * @RATE_INFO_BW_80: 80 MHz bandwidth 1852 * @RATE_INFO_BW_160: 160 MHz bandwidth 1853 * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation 1854 * @RATE_INFO_BW_320: 320 MHz bandwidth 1855 * @RATE_INFO_BW_EHT_RU: bandwidth determined by EHT RU allocation 1856 * @RATE_INFO_BW_1: 1 MHz bandwidth 1857 * @RATE_INFO_BW_2: 2 MHz bandwidth 1858 * @RATE_INFO_BW_4: 4 MHz bandwidth 1859 * @RATE_INFO_BW_8: 8 MHz bandwidth 1860 * @RATE_INFO_BW_16: 16 MHz bandwidth 1861 */ 1862 enum rate_info_bw { 1863 RATE_INFO_BW_20 = 0, 1864 RATE_INFO_BW_5, 1865 RATE_INFO_BW_10, 1866 RATE_INFO_BW_40, 1867 RATE_INFO_BW_80, 1868 RATE_INFO_BW_160, 1869 RATE_INFO_BW_HE_RU, 1870 RATE_INFO_BW_320, 1871 RATE_INFO_BW_EHT_RU, 1872 RATE_INFO_BW_1, 1873 RATE_INFO_BW_2, 1874 RATE_INFO_BW_4, 1875 RATE_INFO_BW_8, 1876 RATE_INFO_BW_16, 1877 }; 1878 1879 /** 1880 * struct rate_info - bitrate information 1881 * 1882 * Information about a receiving or transmitting bitrate 1883 * 1884 * @flags: bitflag of flags from &enum rate_info_flags 1885 * @legacy: bitrate in 100kbit/s for 802.11abg 1886 * @mcs: mcs index if struct describes an HT/VHT/HE/EHT/S1G rate 1887 * @nss: number of streams (VHT & HE only) 1888 * @bw: bandwidth (from &enum rate_info_bw) 1889 * @he_gi: HE guard interval (from &enum nl80211_he_gi) 1890 * @he_dcm: HE DCM value 1891 * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc, 1892 * only valid if bw is %RATE_INFO_BW_HE_RU) 1893 * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4) 1894 * @eht_gi: EHT guard interval (from &enum nl80211_eht_gi) 1895 * @eht_ru_alloc: EHT RU allocation (from &enum nl80211_eht_ru_alloc, 1896 * only valid if bw is %RATE_INFO_BW_EHT_RU) 1897 */ 1898 struct rate_info { 1899 u16 flags; 1900 u16 legacy; 1901 u8 mcs; 1902 u8 nss; 1903 u8 bw; 1904 u8 he_gi; 1905 u8 he_dcm; 1906 u8 he_ru_alloc; 1907 u8 n_bonded_ch; 1908 u8 eht_gi; 1909 u8 eht_ru_alloc; 1910 }; 1911 1912 /** 1913 * enum bss_param_flags - bitrate info flags 1914 * 1915 * Used by the driver to indicate the specific rate transmission 1916 * type for 802.11n transmissions. 1917 * 1918 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled 1919 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled 1920 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled 1921 */ 1922 enum bss_param_flags { 1923 BSS_PARAM_FLAGS_CTS_PROT = 1<<0, 1924 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1, 1925 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2, 1926 }; 1927 1928 /** 1929 * struct sta_bss_parameters - BSS parameters for the attached station 1930 * 1931 * Information about the currently associated BSS 1932 * 1933 * @flags: bitflag of flags from &enum bss_param_flags 1934 * @dtim_period: DTIM period for the BSS 1935 * @beacon_interval: beacon interval 1936 */ 1937 struct sta_bss_parameters { 1938 u8 flags; 1939 u8 dtim_period; 1940 u16 beacon_interval; 1941 }; 1942 1943 /** 1944 * struct cfg80211_txq_stats - TXQ statistics for this TID 1945 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to 1946 * indicate the relevant values in this struct are filled 1947 * @backlog_bytes: total number of bytes currently backlogged 1948 * @backlog_packets: total number of packets currently backlogged 1949 * @flows: number of new flows seen 1950 * @drops: total number of packets dropped 1951 * @ecn_marks: total number of packets marked with ECN CE 1952 * @overlimit: number of drops due to queue space overflow 1953 * @overmemory: number of drops due to memory limit overflow 1954 * @collisions: number of hash collisions 1955 * @tx_bytes: total number of bytes dequeued 1956 * @tx_packets: total number of packets dequeued 1957 * @max_flows: maximum number of flows supported 1958 */ 1959 struct cfg80211_txq_stats { 1960 u32 filled; 1961 u32 backlog_bytes; 1962 u32 backlog_packets; 1963 u32 flows; 1964 u32 drops; 1965 u32 ecn_marks; 1966 u32 overlimit; 1967 u32 overmemory; 1968 u32 collisions; 1969 u32 tx_bytes; 1970 u32 tx_packets; 1971 u32 max_flows; 1972 }; 1973 1974 /** 1975 * struct cfg80211_tid_stats - per-TID statistics 1976 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to 1977 * indicate the relevant values in this struct are filled 1978 * @rx_msdu: number of received MSDUs 1979 * @tx_msdu: number of (attempted) transmitted MSDUs 1980 * @tx_msdu_retries: number of retries (not counting the first) for 1981 * transmitted MSDUs 1982 * @tx_msdu_failed: number of failed transmitted MSDUs 1983 * @txq_stats: TXQ statistics 1984 */ 1985 struct cfg80211_tid_stats { 1986 u32 filled; 1987 u64 rx_msdu; 1988 u64 tx_msdu; 1989 u64 tx_msdu_retries; 1990 u64 tx_msdu_failed; 1991 struct cfg80211_txq_stats txq_stats; 1992 }; 1993 1994 #define IEEE80211_MAX_CHAINS 4 1995 1996 /** 1997 * struct station_info - station information 1998 * 1999 * Station information filled by driver for get_station() and dump_station. 2000 * 2001 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to 2002 * indicate the relevant values in this struct for them 2003 * @connected_time: time(in secs) since a station is last connected 2004 * @inactive_time: time since last station activity (tx/rx) in milliseconds 2005 * @assoc_at: bootime (ns) of the last association 2006 * @rx_bytes: bytes (size of MPDUs) received from this station 2007 * @tx_bytes: bytes (size of MPDUs) transmitted to this station 2008 * @llid: mesh local link id 2009 * @plid: mesh peer link id 2010 * @plink_state: mesh peer link state 2011 * @signal: The signal strength, type depends on the wiphy's signal_type. 2012 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_. 2013 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type. 2014 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_. 2015 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg 2016 * @chain_signal: per-chain signal strength of last received packet in dBm 2017 * @chain_signal_avg: per-chain signal strength average in dBm 2018 * @txrate: current unicast bitrate from this station 2019 * @rxrate: current unicast bitrate to this station 2020 * @rx_packets: packets (MSDUs & MMPDUs) received from this station 2021 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station 2022 * @tx_retries: cumulative retry counts (MPDUs) 2023 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK) 2024 * @rx_dropped_misc: Dropped for un-specified reason. 2025 * @bss_param: current BSS parameters 2026 * @generation: generation number for nl80211 dumps. 2027 * This number should increase every time the list of stations 2028 * changes, i.e. when a station is added or removed, so that 2029 * userspace can tell whether it got a consistent snapshot. 2030 * @assoc_req_ies: IEs from (Re)Association Request. 2031 * This is used only when in AP mode with drivers that do not use 2032 * user space MLME/SME implementation. The information is provided for 2033 * the cfg80211_new_sta() calls to notify user space of the IEs. 2034 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets. 2035 * @sta_flags: station flags mask & values 2036 * @beacon_loss_count: Number of times beacon loss event has triggered. 2037 * @t_offset: Time offset of the station relative to this host. 2038 * @local_pm: local mesh STA power save mode 2039 * @peer_pm: peer mesh STA power save mode 2040 * @nonpeer_pm: non-peer mesh STA power save mode 2041 * @expected_throughput: expected throughput in kbps (including 802.11 headers) 2042 * towards this station. 2043 * @rx_beacon: number of beacons received from this peer 2044 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received 2045 * from this peer 2046 * @connected_to_gate: true if mesh STA has a path to mesh gate 2047 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer 2048 * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer 2049 * @airtime_weight: current airtime scheduling weight 2050 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last 2051 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs. 2052 * Note that this doesn't use the @filled bit, but is used if non-NULL. 2053 * @ack_signal: signal strength (in dBm) of the last ACK frame. 2054 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has 2055 * been sent. 2056 * @rx_mpdu_count: number of MPDUs received from this station 2057 * @fcs_err_count: number of packets (MPDUs) received from this station with 2058 * an FCS error. This counter should be incremented only when TA of the 2059 * received packet with an FCS error matches the peer MAC address. 2060 * @airtime_link_metric: mesh airtime link metric. 2061 * @connected_to_as: true if mesh STA has a path to authentication server 2062 * @mlo_params_valid: Indicates @assoc_link_id and @mld_addr fields are filled 2063 * by driver. Drivers use this only in cfg80211_new_sta() calls when AP 2064 * MLD's MLME/SME is offload to driver. Drivers won't fill this 2065 * information in cfg80211_del_sta_sinfo(), get_station() and 2066 * dump_station() callbacks. 2067 * @assoc_link_id: Indicates MLO link ID of the AP, with which the station 2068 * completed (re)association. This information filled for both MLO 2069 * and non-MLO STA connections when the AP affiliated with an MLD. 2070 * @mld_addr: For MLO STA connection, filled with MLD address of the station. 2071 * For non-MLO STA connection, filled with all zeros. 2072 * @assoc_resp_ies: IEs from (Re)Association Response. 2073 * This is used only when in AP mode with drivers that do not use user 2074 * space MLME/SME implementation. The information is provided only for the 2075 * cfg80211_new_sta() calls to notify user space of the IEs. Drivers won't 2076 * fill this information in cfg80211_del_sta_sinfo(), get_station() and 2077 * dump_station() callbacks. User space needs this information to determine 2078 * the accepted and rejected affiliated links of the connected station. 2079 * @assoc_resp_ies_len: Length of @assoc_resp_ies buffer in octets. 2080 */ 2081 struct station_info { 2082 u64 filled; 2083 u32 connected_time; 2084 u32 inactive_time; 2085 u64 assoc_at; 2086 u64 rx_bytes; 2087 u64 tx_bytes; 2088 u16 llid; 2089 u16 plid; 2090 u8 plink_state; 2091 s8 signal; 2092 s8 signal_avg; 2093 2094 u8 chains; 2095 s8 chain_signal[IEEE80211_MAX_CHAINS]; 2096 s8 chain_signal_avg[IEEE80211_MAX_CHAINS]; 2097 2098 struct rate_info txrate; 2099 struct rate_info rxrate; 2100 u32 rx_packets; 2101 u32 tx_packets; 2102 u32 tx_retries; 2103 u32 tx_failed; 2104 u32 rx_dropped_misc; 2105 struct sta_bss_parameters bss_param; 2106 struct nl80211_sta_flag_update sta_flags; 2107 2108 int generation; 2109 2110 const u8 *assoc_req_ies; 2111 size_t assoc_req_ies_len; 2112 2113 u32 beacon_loss_count; 2114 s64 t_offset; 2115 enum nl80211_mesh_power_mode local_pm; 2116 enum nl80211_mesh_power_mode peer_pm; 2117 enum nl80211_mesh_power_mode nonpeer_pm; 2118 2119 u32 expected_throughput; 2120 2121 u64 tx_duration; 2122 u64 rx_duration; 2123 u64 rx_beacon; 2124 u8 rx_beacon_signal_avg; 2125 u8 connected_to_gate; 2126 2127 struct cfg80211_tid_stats *pertid; 2128 s8 ack_signal; 2129 s8 avg_ack_signal; 2130 2131 u16 airtime_weight; 2132 2133 u32 rx_mpdu_count; 2134 u32 fcs_err_count; 2135 2136 u32 airtime_link_metric; 2137 2138 u8 connected_to_as; 2139 2140 bool mlo_params_valid; 2141 u8 assoc_link_id; 2142 u8 mld_addr[ETH_ALEN] __aligned(2); 2143 const u8 *assoc_resp_ies; 2144 size_t assoc_resp_ies_len; 2145 }; 2146 2147 /** 2148 * struct cfg80211_sar_sub_specs - sub specs limit 2149 * @power: power limitation in 0.25dbm 2150 * @freq_range_index: index the power limitation applies to 2151 */ 2152 struct cfg80211_sar_sub_specs { 2153 s32 power; 2154 u32 freq_range_index; 2155 }; 2156 2157 /** 2158 * struct cfg80211_sar_specs - sar limit specs 2159 * @type: it's set with power in 0.25dbm or other types 2160 * @num_sub_specs: number of sar sub specs 2161 * @sub_specs: memory to hold the sar sub specs 2162 */ 2163 struct cfg80211_sar_specs { 2164 enum nl80211_sar_type type; 2165 u32 num_sub_specs; 2166 struct cfg80211_sar_sub_specs sub_specs[]; 2167 }; 2168 2169 2170 /** 2171 * struct cfg80211_sar_freq_ranges - sar frequency ranges 2172 * @start_freq: start range edge frequency 2173 * @end_freq: end range edge frequency 2174 */ 2175 struct cfg80211_sar_freq_ranges { 2176 u32 start_freq; 2177 u32 end_freq; 2178 }; 2179 2180 /** 2181 * struct cfg80211_sar_capa - sar limit capability 2182 * @type: it's set via power in 0.25dbm or other types 2183 * @num_freq_ranges: number of frequency ranges 2184 * @freq_ranges: memory to hold the freq ranges. 2185 * 2186 * Note: WLAN driver may append new ranges or split an existing 2187 * range to small ones and then append them. 2188 */ 2189 struct cfg80211_sar_capa { 2190 enum nl80211_sar_type type; 2191 u32 num_freq_ranges; 2192 const struct cfg80211_sar_freq_ranges *freq_ranges; 2193 }; 2194 2195 #if IS_ENABLED(CONFIG_CFG80211) 2196 /** 2197 * cfg80211_get_station - retrieve information about a given station 2198 * @dev: the device where the station is supposed to be connected to 2199 * @mac_addr: the mac address of the station of interest 2200 * @sinfo: pointer to the structure to fill with the information 2201 * 2202 * Returns 0 on success and sinfo is filled with the available information 2203 * otherwise returns a negative error code and the content of sinfo has to be 2204 * considered undefined. 2205 */ 2206 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr, 2207 struct station_info *sinfo); 2208 #else 2209 static inline int cfg80211_get_station(struct net_device *dev, 2210 const u8 *mac_addr, 2211 struct station_info *sinfo) 2212 { 2213 return -ENOENT; 2214 } 2215 #endif 2216 2217 /** 2218 * enum monitor_flags - monitor flags 2219 * 2220 * Monitor interface configuration flags. Note that these must be the bits 2221 * according to the nl80211 flags. 2222 * 2223 * @MONITOR_FLAG_CHANGED: set if the flags were changed 2224 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS 2225 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP 2226 * @MONITOR_FLAG_CONTROL: pass control frames 2227 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering 2228 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing 2229 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address 2230 */ 2231 enum monitor_flags { 2232 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID, 2233 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL, 2234 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL, 2235 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL, 2236 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS, 2237 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES, 2238 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE, 2239 }; 2240 2241 /** 2242 * enum mpath_info_flags - mesh path information flags 2243 * 2244 * Used by the driver to indicate which info in &struct mpath_info it has filled 2245 * in during get_station() or dump_station(). 2246 * 2247 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled 2248 * @MPATH_INFO_SN: @sn filled 2249 * @MPATH_INFO_METRIC: @metric filled 2250 * @MPATH_INFO_EXPTIME: @exptime filled 2251 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled 2252 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled 2253 * @MPATH_INFO_FLAGS: @flags filled 2254 * @MPATH_INFO_HOP_COUNT: @hop_count filled 2255 * @MPATH_INFO_PATH_CHANGE: @path_change_count filled 2256 */ 2257 enum mpath_info_flags { 2258 MPATH_INFO_FRAME_QLEN = BIT(0), 2259 MPATH_INFO_SN = BIT(1), 2260 MPATH_INFO_METRIC = BIT(2), 2261 MPATH_INFO_EXPTIME = BIT(3), 2262 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4), 2263 MPATH_INFO_DISCOVERY_RETRIES = BIT(5), 2264 MPATH_INFO_FLAGS = BIT(6), 2265 MPATH_INFO_HOP_COUNT = BIT(7), 2266 MPATH_INFO_PATH_CHANGE = BIT(8), 2267 }; 2268 2269 /** 2270 * struct mpath_info - mesh path information 2271 * 2272 * Mesh path information filled by driver for get_mpath() and dump_mpath(). 2273 * 2274 * @filled: bitfield of flags from &enum mpath_info_flags 2275 * @frame_qlen: number of queued frames for this destination 2276 * @sn: target sequence number 2277 * @metric: metric (cost) of this mesh path 2278 * @exptime: expiration time for the mesh path from now, in msecs 2279 * @flags: mesh path flags from &enum mesh_path_flags 2280 * @discovery_timeout: total mesh path discovery timeout, in msecs 2281 * @discovery_retries: mesh path discovery retries 2282 * @generation: generation number for nl80211 dumps. 2283 * This number should increase every time the list of mesh paths 2284 * changes, i.e. when a station is added or removed, so that 2285 * userspace can tell whether it got a consistent snapshot. 2286 * @hop_count: hops to destination 2287 * @path_change_count: total number of path changes to destination 2288 */ 2289 struct mpath_info { 2290 u32 filled; 2291 u32 frame_qlen; 2292 u32 sn; 2293 u32 metric; 2294 u32 exptime; 2295 u32 discovery_timeout; 2296 u8 discovery_retries; 2297 u8 flags; 2298 u8 hop_count; 2299 u32 path_change_count; 2300 2301 int generation; 2302 }; 2303 2304 /** 2305 * struct bss_parameters - BSS parameters 2306 * 2307 * Used to change BSS parameters (mainly for AP mode). 2308 * 2309 * @link_id: link_id or -1 for non-MLD 2310 * @use_cts_prot: Whether to use CTS protection 2311 * (0 = no, 1 = yes, -1 = do not change) 2312 * @use_short_preamble: Whether the use of short preambles is allowed 2313 * (0 = no, 1 = yes, -1 = do not change) 2314 * @use_short_slot_time: Whether the use of short slot time is allowed 2315 * (0 = no, 1 = yes, -1 = do not change) 2316 * @basic_rates: basic rates in IEEE 802.11 format 2317 * (or NULL for no change) 2318 * @basic_rates_len: number of basic rates 2319 * @ap_isolate: do not forward packets between connected stations 2320 * (0 = no, 1 = yes, -1 = do not change) 2321 * @ht_opmode: HT Operation mode 2322 * (u16 = opmode, -1 = do not change) 2323 * @p2p_ctwindow: P2P CT Window (-1 = no change) 2324 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change) 2325 */ 2326 struct bss_parameters { 2327 int link_id; 2328 int use_cts_prot; 2329 int use_short_preamble; 2330 int use_short_slot_time; 2331 const u8 *basic_rates; 2332 u8 basic_rates_len; 2333 int ap_isolate; 2334 int ht_opmode; 2335 s8 p2p_ctwindow, p2p_opp_ps; 2336 }; 2337 2338 /** 2339 * struct mesh_config - 802.11s mesh configuration 2340 * 2341 * These parameters can be changed while the mesh is active. 2342 * 2343 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used 2344 * by the Mesh Peering Open message 2345 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units 2346 * used by the Mesh Peering Open message 2347 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by 2348 * the mesh peering management to close a mesh peering 2349 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this 2350 * mesh interface 2351 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can 2352 * be sent to establish a new peer link instance in a mesh 2353 * @dot11MeshTTL: the value of TTL field set at a source mesh STA 2354 * @element_ttl: the value of TTL field set at a mesh STA for path selection 2355 * elements 2356 * @auto_open_plinks: whether we should automatically open peer links when we 2357 * detect compatible mesh peers 2358 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to 2359 * synchronize to for 11s default synchronization method 2360 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ 2361 * that an originator mesh STA can send to a particular path target 2362 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds 2363 * @min_discovery_timeout: the minimum length of time to wait until giving up on 2364 * a path discovery in milliseconds 2365 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs 2366 * receiving a PREQ shall consider the forwarding information from the 2367 * root to be valid. (TU = time unit) 2368 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during 2369 * which a mesh STA can send only one action frame containing a PREQ 2370 * element 2371 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during 2372 * which a mesh STA can send only one Action frame containing a PERR 2373 * element 2374 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that 2375 * it takes for an HWMP information element to propagate across the mesh 2376 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA 2377 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root 2378 * announcements are transmitted 2379 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh 2380 * station has access to a broader network beyond the MBSS. (This is 2381 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true 2382 * only means that the station will announce others it's a mesh gate, but 2383 * not necessarily using the gate announcement protocol. Still keeping the 2384 * same nomenclature to be in sync with the spec) 2385 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding 2386 * entity (default is TRUE - forwarding entity) 2387 * @rssi_threshold: the threshold for average signal strength of candidate 2388 * station to establish a peer link 2389 * @ht_opmode: mesh HT protection mode 2390 * 2391 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs 2392 * receiving a proactive PREQ shall consider the forwarding information to 2393 * the root mesh STA to be valid. 2394 * 2395 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive 2396 * PREQs are transmitted. 2397 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs) 2398 * during which a mesh STA can send only one Action frame containing 2399 * a PREQ element for root path confirmation. 2400 * @power_mode: The default mesh power save mode which will be the initial 2401 * setting for new peer links. 2402 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake 2403 * after transmitting its beacon. 2404 * @plink_timeout: If no tx activity is seen from a STA we've established 2405 * peering with for longer than this time (in seconds), then remove it 2406 * from the STA's list of peers. Default is 30 minutes. 2407 * @dot11MeshConnectedToAuthServer: if set to true then this mesh STA 2408 * will advertise that it is connected to a authentication server 2409 * in the mesh formation field. 2410 * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is 2411 * connected to a mesh gate in mesh formation info. If false, the 2412 * value in mesh formation is determined by the presence of root paths 2413 * in the mesh path table 2414 * @dot11MeshNolearn: Try to avoid multi-hop path discovery (e.g. PREQ/PREP 2415 * for HWMP) if the destination is a direct neighbor. Note that this might 2416 * not be the optimal decision as a multi-hop route might be better. So 2417 * if using this setting you will likely also want to disable 2418 * dot11MeshForwarding and use another mesh routing protocol on top. 2419 */ 2420 struct mesh_config { 2421 u16 dot11MeshRetryTimeout; 2422 u16 dot11MeshConfirmTimeout; 2423 u16 dot11MeshHoldingTimeout; 2424 u16 dot11MeshMaxPeerLinks; 2425 u8 dot11MeshMaxRetries; 2426 u8 dot11MeshTTL; 2427 u8 element_ttl; 2428 bool auto_open_plinks; 2429 u32 dot11MeshNbrOffsetMaxNeighbor; 2430 u8 dot11MeshHWMPmaxPREQretries; 2431 u32 path_refresh_time; 2432 u16 min_discovery_timeout; 2433 u32 dot11MeshHWMPactivePathTimeout; 2434 u16 dot11MeshHWMPpreqMinInterval; 2435 u16 dot11MeshHWMPperrMinInterval; 2436 u16 dot11MeshHWMPnetDiameterTraversalTime; 2437 u8 dot11MeshHWMPRootMode; 2438 bool dot11MeshConnectedToMeshGate; 2439 bool dot11MeshConnectedToAuthServer; 2440 u16 dot11MeshHWMPRannInterval; 2441 bool dot11MeshGateAnnouncementProtocol; 2442 bool dot11MeshForwarding; 2443 s32 rssi_threshold; 2444 u16 ht_opmode; 2445 u32 dot11MeshHWMPactivePathToRootTimeout; 2446 u16 dot11MeshHWMProotInterval; 2447 u16 dot11MeshHWMPconfirmationInterval; 2448 enum nl80211_mesh_power_mode power_mode; 2449 u16 dot11MeshAwakeWindowDuration; 2450 u32 plink_timeout; 2451 bool dot11MeshNolearn; 2452 }; 2453 2454 /** 2455 * struct mesh_setup - 802.11s mesh setup configuration 2456 * @chandef: defines the channel to use 2457 * @mesh_id: the mesh ID 2458 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes 2459 * @sync_method: which synchronization method to use 2460 * @path_sel_proto: which path selection protocol to use 2461 * @path_metric: which metric to use 2462 * @auth_id: which authentication method this mesh is using 2463 * @ie: vendor information elements (optional) 2464 * @ie_len: length of vendor information elements 2465 * @is_authenticated: this mesh requires authentication 2466 * @is_secure: this mesh uses security 2467 * @user_mpm: userspace handles all MPM functions 2468 * @dtim_period: DTIM period to use 2469 * @beacon_interval: beacon interval to use 2470 * @mcast_rate: multicast rate for Mesh Node [6Mbps is the default for 802.11a] 2471 * @basic_rates: basic rates to use when creating the mesh 2472 * @beacon_rate: bitrate to be used for beacons 2473 * @userspace_handles_dfs: whether user space controls DFS operation, i.e. 2474 * changes the channel when a radar is detected. This is required 2475 * to operate on DFS channels. 2476 * @control_port_over_nl80211: TRUE if userspace expects to exchange control 2477 * port frames over NL80211 instead of the network interface. 2478 * 2479 * These parameters are fixed when the mesh is created. 2480 */ 2481 struct mesh_setup { 2482 struct cfg80211_chan_def chandef; 2483 const u8 *mesh_id; 2484 u8 mesh_id_len; 2485 u8 sync_method; 2486 u8 path_sel_proto; 2487 u8 path_metric; 2488 u8 auth_id; 2489 const u8 *ie; 2490 u8 ie_len; 2491 bool is_authenticated; 2492 bool is_secure; 2493 bool user_mpm; 2494 u8 dtim_period; 2495 u16 beacon_interval; 2496 int mcast_rate[NUM_NL80211_BANDS]; 2497 u32 basic_rates; 2498 struct cfg80211_bitrate_mask beacon_rate; 2499 bool userspace_handles_dfs; 2500 bool control_port_over_nl80211; 2501 }; 2502 2503 /** 2504 * struct ocb_setup - 802.11p OCB mode setup configuration 2505 * @chandef: defines the channel to use 2506 * 2507 * These parameters are fixed when connecting to the network 2508 */ 2509 struct ocb_setup { 2510 struct cfg80211_chan_def chandef; 2511 }; 2512 2513 /** 2514 * struct ieee80211_txq_params - TX queue parameters 2515 * @ac: AC identifier 2516 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled 2517 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range 2518 * 1..32767] 2519 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range 2520 * 1..32767] 2521 * @aifs: Arbitration interframe space [0..255] 2522 * @link_id: link_id or -1 for non-MLD 2523 */ 2524 struct ieee80211_txq_params { 2525 enum nl80211_ac ac; 2526 u16 txop; 2527 u16 cwmin; 2528 u16 cwmax; 2529 u8 aifs; 2530 int link_id; 2531 }; 2532 2533 /** 2534 * DOC: Scanning and BSS list handling 2535 * 2536 * The scanning process itself is fairly simple, but cfg80211 offers quite 2537 * a bit of helper functionality. To start a scan, the scan operation will 2538 * be invoked with a scan definition. This scan definition contains the 2539 * channels to scan, and the SSIDs to send probe requests for (including the 2540 * wildcard, if desired). A passive scan is indicated by having no SSIDs to 2541 * probe. Additionally, a scan request may contain extra information elements 2542 * that should be added to the probe request. The IEs are guaranteed to be 2543 * well-formed, and will not exceed the maximum length the driver advertised 2544 * in the wiphy structure. 2545 * 2546 * When scanning finds a BSS, cfg80211 needs to be notified of that, because 2547 * it is responsible for maintaining the BSS list; the driver should not 2548 * maintain a list itself. For this notification, various functions exist. 2549 * 2550 * Since drivers do not maintain a BSS list, there are also a number of 2551 * functions to search for a BSS and obtain information about it from the 2552 * BSS structure cfg80211 maintains. The BSS list is also made available 2553 * to userspace. 2554 */ 2555 2556 /** 2557 * struct cfg80211_ssid - SSID description 2558 * @ssid: the SSID 2559 * @ssid_len: length of the ssid 2560 */ 2561 struct cfg80211_ssid { 2562 u8 ssid[IEEE80211_MAX_SSID_LEN]; 2563 u8 ssid_len; 2564 }; 2565 2566 /** 2567 * struct cfg80211_scan_info - information about completed scan 2568 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the 2569 * wireless device that requested the scan is connected to. If this 2570 * information is not available, this field is left zero. 2571 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set. 2572 * @aborted: set to true if the scan was aborted for any reason, 2573 * userspace will be notified of that 2574 */ 2575 struct cfg80211_scan_info { 2576 u64 scan_start_tsf; 2577 u8 tsf_bssid[ETH_ALEN] __aligned(2); 2578 bool aborted; 2579 }; 2580 2581 /** 2582 * struct cfg80211_scan_6ghz_params - relevant for 6 GHz only 2583 * 2584 * @short_ssid: short ssid to scan for 2585 * @bssid: bssid to scan for 2586 * @channel_idx: idx of the channel in the channel array in the scan request 2587 * which the above info is relevant to 2588 * @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU 2589 * @short_ssid_valid: @short_ssid is valid and can be used 2590 * @psc_no_listen: when set, and the channel is a PSC channel, no need to wait 2591 * 20 TUs before starting to send probe requests. 2592 * @psd_20: The AP's 20 MHz PSD value. 2593 */ 2594 struct cfg80211_scan_6ghz_params { 2595 u32 short_ssid; 2596 u32 channel_idx; 2597 u8 bssid[ETH_ALEN]; 2598 bool unsolicited_probe; 2599 bool short_ssid_valid; 2600 bool psc_no_listen; 2601 s8 psd_20; 2602 }; 2603 2604 /** 2605 * struct cfg80211_scan_request - scan request description 2606 * 2607 * @ssids: SSIDs to scan for (active scan only) 2608 * @n_ssids: number of SSIDs 2609 * @channels: channels to scan on. 2610 * @n_channels: total number of channels to scan 2611 * @ie: optional information element(s) to add into Probe Request or %NULL 2612 * @ie_len: length of ie in octets 2613 * @duration: how long to listen on each channel, in TUs. If 2614 * %duration_mandatory is not set, this is the maximum dwell time and 2615 * the actual dwell time may be shorter. 2616 * @duration_mandatory: if set, the scan duration must be as specified by the 2617 * %duration field. 2618 * @flags: control flags from &enum nl80211_scan_flags 2619 * @rates: bitmap of rates to advertise for each band 2620 * @wiphy: the wiphy this was for 2621 * @scan_start: time (in jiffies) when the scan started 2622 * @wdev: the wireless device to scan for 2623 * @info: (internal) information about completed scan 2624 * @notified: (internal) scan request was notified as done or aborted 2625 * @no_cck: used to send probe requests at non CCK rate in 2GHz band 2626 * @mac_addr: MAC address used with randomisation 2627 * @mac_addr_mask: MAC address mask used with randomisation, bits that 2628 * are 0 in the mask should be randomised, bits that are 1 should 2629 * be taken from the @mac_addr 2630 * @scan_6ghz: relevant for split scan request only, 2631 * true if this is the second scan request 2632 * @n_6ghz_params: number of 6 GHz params 2633 * @scan_6ghz_params: 6 GHz params 2634 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID) 2635 * @tsf_report_link_id: for MLO, indicates the link ID of the BSS that should be 2636 * used for TSF reporting. Can be set to -1 to indicate no preference. 2637 */ 2638 struct cfg80211_scan_request { 2639 struct cfg80211_ssid *ssids; 2640 int n_ssids; 2641 u32 n_channels; 2642 const u8 *ie; 2643 size_t ie_len; 2644 u16 duration; 2645 bool duration_mandatory; 2646 u32 flags; 2647 2648 u32 rates[NUM_NL80211_BANDS]; 2649 2650 struct wireless_dev *wdev; 2651 2652 u8 mac_addr[ETH_ALEN] __aligned(2); 2653 u8 mac_addr_mask[ETH_ALEN] __aligned(2); 2654 u8 bssid[ETH_ALEN] __aligned(2); 2655 2656 /* internal */ 2657 struct wiphy *wiphy; 2658 unsigned long scan_start; 2659 struct cfg80211_scan_info info; 2660 bool notified; 2661 bool no_cck; 2662 bool scan_6ghz; 2663 u32 n_6ghz_params; 2664 struct cfg80211_scan_6ghz_params *scan_6ghz_params; 2665 s8 tsf_report_link_id; 2666 2667 /* keep last */ 2668 struct ieee80211_channel *channels[] __counted_by(n_channels); 2669 }; 2670 2671 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask) 2672 { 2673 int i; 2674 2675 get_random_bytes(buf, ETH_ALEN); 2676 for (i = 0; i < ETH_ALEN; i++) { 2677 buf[i] &= ~mask[i]; 2678 buf[i] |= addr[i] & mask[i]; 2679 } 2680 } 2681 2682 /** 2683 * struct cfg80211_match_set - sets of attributes to match 2684 * 2685 * @ssid: SSID to be matched; may be zero-length in case of BSSID match 2686 * or no match (RSSI only) 2687 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match 2688 * or no match (RSSI only) 2689 * @rssi_thold: don't report scan results below this threshold (in s32 dBm) 2690 * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied 2691 * for filtering out scan results received. Drivers advertise this support 2692 * of band specific rssi based filtering through the feature capability 2693 * %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band 2694 * specific rssi thresholds take precedence over rssi_thold, if specified. 2695 * If not specified for any band, it will be assigned with rssi_thold of 2696 * corresponding matchset. 2697 */ 2698 struct cfg80211_match_set { 2699 struct cfg80211_ssid ssid; 2700 u8 bssid[ETH_ALEN]; 2701 s32 rssi_thold; 2702 s32 per_band_rssi_thold[NUM_NL80211_BANDS]; 2703 }; 2704 2705 /** 2706 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan 2707 * 2708 * @interval: interval between scheduled scan iterations. In seconds. 2709 * @iterations: number of scan iterations in this scan plan. Zero means 2710 * infinite loop. 2711 * The last scan plan will always have this parameter set to zero, 2712 * all other scan plans will have a finite number of iterations. 2713 */ 2714 struct cfg80211_sched_scan_plan { 2715 u32 interval; 2716 u32 iterations; 2717 }; 2718 2719 /** 2720 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment. 2721 * 2722 * @band: band of BSS which should match for RSSI level adjustment. 2723 * @delta: value of RSSI level adjustment. 2724 */ 2725 struct cfg80211_bss_select_adjust { 2726 enum nl80211_band band; 2727 s8 delta; 2728 }; 2729 2730 /** 2731 * struct cfg80211_sched_scan_request - scheduled scan request description 2732 * 2733 * @reqid: identifies this request. 2734 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans) 2735 * @n_ssids: number of SSIDs 2736 * @n_channels: total number of channels to scan 2737 * @ie: optional information element(s) to add into Probe Request or %NULL 2738 * @ie_len: length of ie in octets 2739 * @flags: control flags from &enum nl80211_scan_flags 2740 * @match_sets: sets of parameters to be matched for a scan result 2741 * entry to be considered valid and to be passed to the host 2742 * (others are filtered out). 2743 * If omitted, all results are passed. 2744 * @n_match_sets: number of match sets 2745 * @report_results: indicates that results were reported for this request 2746 * @wiphy: the wiphy this was for 2747 * @dev: the interface 2748 * @scan_start: start time of the scheduled scan 2749 * @channels: channels to scan 2750 * @min_rssi_thold: for drivers only supporting a single threshold, this 2751 * contains the minimum over all matchsets 2752 * @mac_addr: MAC address used with randomisation 2753 * @mac_addr_mask: MAC address mask used with randomisation, bits that 2754 * are 0 in the mask should be randomised, bits that are 1 should 2755 * be taken from the @mac_addr 2756 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest 2757 * index must be executed first. 2758 * @n_scan_plans: number of scan plans, at least 1. 2759 * @rcu_head: RCU callback used to free the struct 2760 * @owner_nlportid: netlink portid of owner (if this should is a request 2761 * owned by a particular socket) 2762 * @nl_owner_dead: netlink owner socket was closed - this request be freed 2763 * @list: for keeping list of requests. 2764 * @delay: delay in seconds to use before starting the first scan 2765 * cycle. The driver may ignore this parameter and start 2766 * immediately (or at any other time), if this feature is not 2767 * supported. 2768 * @relative_rssi_set: Indicates whether @relative_rssi is set or not. 2769 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result 2770 * reporting in connected state to cases where a matching BSS is determined 2771 * to have better or slightly worse RSSI than the current connected BSS. 2772 * The relative RSSI threshold values are ignored in disconnected state. 2773 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong 2774 * to the specified band while deciding whether a better BSS is reported 2775 * using @relative_rssi. If delta is a negative number, the BSSs that 2776 * belong to the specified band will be penalized by delta dB in relative 2777 * comparisons. 2778 */ 2779 struct cfg80211_sched_scan_request { 2780 u64 reqid; 2781 struct cfg80211_ssid *ssids; 2782 int n_ssids; 2783 u32 n_channels; 2784 const u8 *ie; 2785 size_t ie_len; 2786 u32 flags; 2787 struct cfg80211_match_set *match_sets; 2788 int n_match_sets; 2789 s32 min_rssi_thold; 2790 u32 delay; 2791 struct cfg80211_sched_scan_plan *scan_plans; 2792 int n_scan_plans; 2793 2794 u8 mac_addr[ETH_ALEN] __aligned(2); 2795 u8 mac_addr_mask[ETH_ALEN] __aligned(2); 2796 2797 bool relative_rssi_set; 2798 s8 relative_rssi; 2799 struct cfg80211_bss_select_adjust rssi_adjust; 2800 2801 /* internal */ 2802 struct wiphy *wiphy; 2803 struct net_device *dev; 2804 unsigned long scan_start; 2805 bool report_results; 2806 struct rcu_head rcu_head; 2807 u32 owner_nlportid; 2808 bool nl_owner_dead; 2809 struct list_head list; 2810 2811 /* keep last */ 2812 struct ieee80211_channel *channels[]; 2813 }; 2814 2815 /** 2816 * enum cfg80211_signal_type - signal type 2817 * 2818 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available 2819 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm) 2820 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100 2821 */ 2822 enum cfg80211_signal_type { 2823 CFG80211_SIGNAL_TYPE_NONE, 2824 CFG80211_SIGNAL_TYPE_MBM, 2825 CFG80211_SIGNAL_TYPE_UNSPEC, 2826 }; 2827 2828 /** 2829 * struct cfg80211_inform_bss - BSS inform data 2830 * @chan: channel the frame was received on 2831 * @signal: signal strength value, according to the wiphy's 2832 * signal type 2833 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was 2834 * received; should match the time when the frame was actually 2835 * received by the device (not just by the host, in case it was 2836 * buffered on the device) and be accurate to about 10ms. 2837 * If the frame isn't buffered, just passing the return value of 2838 * ktime_get_boottime_ns() is likely appropriate. 2839 * @parent_tsf: the time at the start of reception of the first octet of the 2840 * timestamp field of the frame. The time is the TSF of the BSS specified 2841 * by %parent_bssid. 2842 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to 2843 * the BSS that requested the scan in which the beacon/probe was received. 2844 * @chains: bitmask for filled values in @chain_signal. 2845 * @chain_signal: per-chain signal strength of last received BSS in dBm. 2846 * @restrict_use: restrict usage, if not set, assume @use_for is 2847 * %NL80211_BSS_USE_FOR_NORMAL. 2848 * @use_for: bitmap of possible usage for this BSS, see 2849 * &enum nl80211_bss_use_for 2850 * @cannot_use_reasons: the reasons (bitmap) for not being able to connect, 2851 * if @restrict_use is set and @use_for is zero (empty); may be 0 for 2852 * unspecified reasons; see &enum nl80211_bss_cannot_use_reasons 2853 * @drv_data: Data to be passed through to @inform_bss 2854 */ 2855 struct cfg80211_inform_bss { 2856 struct ieee80211_channel *chan; 2857 s32 signal; 2858 u64 boottime_ns; 2859 u64 parent_tsf; 2860 u8 parent_bssid[ETH_ALEN] __aligned(2); 2861 u8 chains; 2862 s8 chain_signal[IEEE80211_MAX_CHAINS]; 2863 2864 u8 restrict_use:1, use_for:7; 2865 u8 cannot_use_reasons; 2866 2867 void *drv_data; 2868 }; 2869 2870 /** 2871 * struct cfg80211_bss_ies - BSS entry IE data 2872 * @tsf: TSF contained in the frame that carried these IEs 2873 * @rcu_head: internal use, for freeing 2874 * @len: length of the IEs 2875 * @from_beacon: these IEs are known to come from a beacon 2876 * @data: IE data 2877 */ 2878 struct cfg80211_bss_ies { 2879 u64 tsf; 2880 struct rcu_head rcu_head; 2881 int len; 2882 bool from_beacon; 2883 u8 data[]; 2884 }; 2885 2886 /** 2887 * struct cfg80211_bss - BSS description 2888 * 2889 * This structure describes a BSS (which may also be a mesh network) 2890 * for use in scan results and similar. 2891 * 2892 * @channel: channel this BSS is on 2893 * @bssid: BSSID of the BSS 2894 * @beacon_interval: the beacon interval as from the frame 2895 * @capability: the capability field in host byte order 2896 * @ies: the information elements (Note that there is no guarantee that these 2897 * are well-formed!); this is a pointer to either the beacon_ies or 2898 * proberesp_ies depending on whether Probe Response frame has been 2899 * received. It is always non-%NULL. 2900 * @beacon_ies: the information elements from the last Beacon frame 2901 * (implementation note: if @hidden_beacon_bss is set this struct doesn't 2902 * own the beacon_ies, but they're just pointers to the ones from the 2903 * @hidden_beacon_bss struct) 2904 * @proberesp_ies: the information elements from the last Probe Response frame 2905 * @hidden_beacon_bss: in case this BSS struct represents a probe response from 2906 * a BSS that hides the SSID in its beacon, this points to the BSS struct 2907 * that holds the beacon data. @beacon_ies is still valid, of course, and 2908 * points to the same data as hidden_beacon_bss->beacon_ies in that case. 2909 * @transmitted_bss: pointer to the transmitted BSS, if this is a 2910 * non-transmitted one (multi-BSSID support) 2911 * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one 2912 * (multi-BSSID support) 2913 * @signal: signal strength value (type depends on the wiphy's signal_type) 2914 * @chains: bitmask for filled values in @chain_signal. 2915 * @chain_signal: per-chain signal strength of last received BSS in dBm. 2916 * @bssid_index: index in the multiple BSS set 2917 * @max_bssid_indicator: max number of members in the BSS set 2918 * @use_for: bitmap of possible usage for this BSS, see 2919 * &enum nl80211_bss_use_for 2920 * @cannot_use_reasons: the reasons (bitmap) for not being able to connect, 2921 * if @restrict_use is set and @use_for is zero (empty); may be 0 for 2922 * unspecified reasons; see &enum nl80211_bss_cannot_use_reasons 2923 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes 2924 */ 2925 struct cfg80211_bss { 2926 struct ieee80211_channel *channel; 2927 2928 const struct cfg80211_bss_ies __rcu *ies; 2929 const struct cfg80211_bss_ies __rcu *beacon_ies; 2930 const struct cfg80211_bss_ies __rcu *proberesp_ies; 2931 2932 struct cfg80211_bss *hidden_beacon_bss; 2933 struct cfg80211_bss *transmitted_bss; 2934 struct list_head nontrans_list; 2935 2936 s32 signal; 2937 2938 u16 beacon_interval; 2939 u16 capability; 2940 2941 u8 bssid[ETH_ALEN]; 2942 u8 chains; 2943 s8 chain_signal[IEEE80211_MAX_CHAINS]; 2944 2945 u8 bssid_index; 2946 u8 max_bssid_indicator; 2947 2948 u8 use_for; 2949 u8 cannot_use_reasons; 2950 2951 u8 priv[] __aligned(sizeof(void *)); 2952 }; 2953 2954 /** 2955 * ieee80211_bss_get_elem - find element with given ID 2956 * @bss: the bss to search 2957 * @id: the element ID 2958 * 2959 * Note that the return value is an RCU-protected pointer, so 2960 * rcu_read_lock() must be held when calling this function. 2961 * Return: %NULL if not found. 2962 */ 2963 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id); 2964 2965 /** 2966 * ieee80211_bss_get_ie - find IE with given ID 2967 * @bss: the bss to search 2968 * @id: the element ID 2969 * 2970 * Note that the return value is an RCU-protected pointer, so 2971 * rcu_read_lock() must be held when calling this function. 2972 * Return: %NULL if not found. 2973 */ 2974 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id) 2975 { 2976 return (const void *)ieee80211_bss_get_elem(bss, id); 2977 } 2978 2979 2980 /** 2981 * struct cfg80211_auth_request - Authentication request data 2982 * 2983 * This structure provides information needed to complete IEEE 802.11 2984 * authentication. 2985 * 2986 * @bss: The BSS to authenticate with, the callee must obtain a reference 2987 * to it if it needs to keep it. 2988 * @auth_type: Authentication type (algorithm) 2989 * @ie: Extra IEs to add to Authentication frame or %NULL 2990 * @ie_len: Length of ie buffer in octets 2991 * @key_len: length of WEP key for shared key authentication 2992 * @key_idx: index of WEP key for shared key authentication 2993 * @key: WEP key for shared key authentication 2994 * @auth_data: Fields and elements in Authentication frames. This contains 2995 * the authentication frame body (non-IE and IE data), excluding the 2996 * Authentication algorithm number, i.e., starting at the Authentication 2997 * transaction sequence number field. 2998 * @auth_data_len: Length of auth_data buffer in octets 2999 * @link_id: if >= 0, indicates authentication should be done as an MLD, 3000 * the interface address is included as the MLD address and the 3001 * necessary link (with the given link_id) will be created (and 3002 * given an MLD address) by the driver 3003 * @ap_mld_addr: AP MLD address in case of authentication request with 3004 * an AP MLD, valid iff @link_id >= 0 3005 */ 3006 struct cfg80211_auth_request { 3007 struct cfg80211_bss *bss; 3008 const u8 *ie; 3009 size_t ie_len; 3010 enum nl80211_auth_type auth_type; 3011 const u8 *key; 3012 u8 key_len; 3013 s8 key_idx; 3014 const u8 *auth_data; 3015 size_t auth_data_len; 3016 s8 link_id; 3017 const u8 *ap_mld_addr; 3018 }; 3019 3020 /** 3021 * struct cfg80211_assoc_link - per-link information for MLO association 3022 * @bss: the BSS pointer, see also &struct cfg80211_assoc_request::bss; 3023 * if this is %NULL for a link, that link is not requested 3024 * @elems: extra elements for the per-STA profile for this link 3025 * @elems_len: length of the elements 3026 * @disabled: If set this link should be included during association etc. but it 3027 * should not be used until enabled by the AP MLD. 3028 * @error: per-link error code, must be <= 0. If there is an error, then the 3029 * operation as a whole must fail. 3030 */ 3031 struct cfg80211_assoc_link { 3032 struct cfg80211_bss *bss; 3033 const u8 *elems; 3034 size_t elems_len; 3035 bool disabled; 3036 int error; 3037 }; 3038 3039 /** 3040 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association. 3041 * 3042 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n) 3043 * @ASSOC_REQ_DISABLE_VHT: Disable VHT 3044 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association 3045 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external 3046 * authentication capability. Drivers can offload authentication to 3047 * userspace if this flag is set. Only applicable for cfg80211_connect() 3048 * request (connect callback). 3049 * @ASSOC_REQ_DISABLE_HE: Disable HE 3050 * @ASSOC_REQ_DISABLE_EHT: Disable EHT 3051 * @CONNECT_REQ_MLO_SUPPORT: Userspace indicates support for handling MLD links. 3052 * Drivers shall disable MLO features for the current association if this 3053 * flag is not set. 3054 */ 3055 enum cfg80211_assoc_req_flags { 3056 ASSOC_REQ_DISABLE_HT = BIT(0), 3057 ASSOC_REQ_DISABLE_VHT = BIT(1), 3058 ASSOC_REQ_USE_RRM = BIT(2), 3059 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3), 3060 ASSOC_REQ_DISABLE_HE = BIT(4), 3061 ASSOC_REQ_DISABLE_EHT = BIT(5), 3062 CONNECT_REQ_MLO_SUPPORT = BIT(6), 3063 }; 3064 3065 /** 3066 * struct cfg80211_assoc_request - (Re)Association request data 3067 * 3068 * This structure provides information needed to complete IEEE 802.11 3069 * (re)association. 3070 * @bss: The BSS to associate with. If the call is successful the driver is 3071 * given a reference that it must give back to cfg80211_send_rx_assoc() 3072 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new 3073 * association requests while already associating must be rejected. 3074 * This also applies to the @links.bss parameter, which is used instead 3075 * of this one (it is %NULL) for MLO associations. 3076 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL 3077 * @ie_len: Length of ie buffer in octets 3078 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association 3079 * @crypto: crypto settings 3080 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used 3081 * to indicate a request to reassociate within the ESS instead of a request 3082 * do the initial association with the ESS. When included, this is set to 3083 * the BSSID of the current association, i.e., to the value that is 3084 * included in the Current AP address field of the Reassociation Request 3085 * frame. 3086 * @flags: See &enum cfg80211_assoc_req_flags 3087 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask 3088 * will be used in ht_capa. Un-supported values will be ignored. 3089 * @ht_capa_mask: The bits of ht_capa which are to be used. 3090 * @vht_capa: VHT capability override 3091 * @vht_capa_mask: VHT capability mask indicating which fields to use 3092 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or 3093 * %NULL if FILS is not used. 3094 * @fils_kek_len: Length of fils_kek in octets 3095 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association 3096 * Request/Response frame or %NULL if FILS is not used. This field starts 3097 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce. 3098 * @s1g_capa: S1G capability override 3099 * @s1g_capa_mask: S1G capability override mask 3100 * @links: per-link information for MLO connections 3101 * @link_id: >= 0 for MLO connections, where links are given, and indicates 3102 * the link on which the association request should be sent 3103 * @ap_mld_addr: AP MLD address in case of MLO association request, 3104 * valid iff @link_id >= 0 3105 */ 3106 struct cfg80211_assoc_request { 3107 struct cfg80211_bss *bss; 3108 const u8 *ie, *prev_bssid; 3109 size_t ie_len; 3110 struct cfg80211_crypto_settings crypto; 3111 bool use_mfp; 3112 u32 flags; 3113 struct ieee80211_ht_cap ht_capa; 3114 struct ieee80211_ht_cap ht_capa_mask; 3115 struct ieee80211_vht_cap vht_capa, vht_capa_mask; 3116 const u8 *fils_kek; 3117 size_t fils_kek_len; 3118 const u8 *fils_nonces; 3119 struct ieee80211_s1g_cap s1g_capa, s1g_capa_mask; 3120 struct cfg80211_assoc_link links[IEEE80211_MLD_MAX_NUM_LINKS]; 3121 const u8 *ap_mld_addr; 3122 s8 link_id; 3123 }; 3124 3125 /** 3126 * struct cfg80211_deauth_request - Deauthentication request data 3127 * 3128 * This structure provides information needed to complete IEEE 802.11 3129 * deauthentication. 3130 * 3131 * @bssid: the BSSID or AP MLD address to deauthenticate from 3132 * @ie: Extra IEs to add to Deauthentication frame or %NULL 3133 * @ie_len: Length of ie buffer in octets 3134 * @reason_code: The reason code for the deauthentication 3135 * @local_state_change: if set, change local state only and 3136 * do not set a deauth frame 3137 */ 3138 struct cfg80211_deauth_request { 3139 const u8 *bssid; 3140 const u8 *ie; 3141 size_t ie_len; 3142 u16 reason_code; 3143 bool local_state_change; 3144 }; 3145 3146 /** 3147 * struct cfg80211_disassoc_request - Disassociation request data 3148 * 3149 * This structure provides information needed to complete IEEE 802.11 3150 * disassociation. 3151 * 3152 * @ap_addr: the BSSID or AP MLD address to disassociate from 3153 * @ie: Extra IEs to add to Disassociation frame or %NULL 3154 * @ie_len: Length of ie buffer in octets 3155 * @reason_code: The reason code for the disassociation 3156 * @local_state_change: This is a request for a local state only, i.e., no 3157 * Disassociation frame is to be transmitted. 3158 */ 3159 struct cfg80211_disassoc_request { 3160 const u8 *ap_addr; 3161 const u8 *ie; 3162 size_t ie_len; 3163 u16 reason_code; 3164 bool local_state_change; 3165 }; 3166 3167 /** 3168 * struct cfg80211_ibss_params - IBSS parameters 3169 * 3170 * This structure defines the IBSS parameters for the join_ibss() 3171 * method. 3172 * 3173 * @ssid: The SSID, will always be non-null. 3174 * @ssid_len: The length of the SSID, will always be non-zero. 3175 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not 3176 * search for IBSSs with a different BSSID. 3177 * @chandef: defines the channel to use if no other IBSS to join can be found 3178 * @channel_fixed: The channel should be fixed -- do not search for 3179 * IBSSs to join on other channels. 3180 * @ie: information element(s) to include in the beacon 3181 * @ie_len: length of that 3182 * @beacon_interval: beacon interval to use 3183 * @privacy: this is a protected network, keys will be configured 3184 * after joining 3185 * @control_port: whether user space controls IEEE 802.1X port, i.e., 3186 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is 3187 * required to assume that the port is unauthorized until authorized by 3188 * user space. Otherwise, port is marked authorized by default. 3189 * @control_port_over_nl80211: TRUE if userspace expects to exchange control 3190 * port frames over NL80211 instead of the network interface. 3191 * @userspace_handles_dfs: whether user space controls DFS operation, i.e. 3192 * changes the channel when a radar is detected. This is required 3193 * to operate on DFS channels. 3194 * @basic_rates: bitmap of basic rates to use when creating the IBSS 3195 * @mcast_rate: per-band multicast rate index + 1 (0: disabled) 3196 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask 3197 * will be used in ht_capa. Un-supported values will be ignored. 3198 * @ht_capa_mask: The bits of ht_capa which are to be used. 3199 * @wep_keys: static WEP keys, if not NULL points to an array of 3200 * CFG80211_MAX_WEP_KEYS WEP keys 3201 * @wep_tx_key: key index (0..3) of the default TX static WEP key 3202 */ 3203 struct cfg80211_ibss_params { 3204 const u8 *ssid; 3205 const u8 *bssid; 3206 struct cfg80211_chan_def chandef; 3207 const u8 *ie; 3208 u8 ssid_len, ie_len; 3209 u16 beacon_interval; 3210 u32 basic_rates; 3211 bool channel_fixed; 3212 bool privacy; 3213 bool control_port; 3214 bool control_port_over_nl80211; 3215 bool userspace_handles_dfs; 3216 int mcast_rate[NUM_NL80211_BANDS]; 3217 struct ieee80211_ht_cap ht_capa; 3218 struct ieee80211_ht_cap ht_capa_mask; 3219 struct key_params *wep_keys; 3220 int wep_tx_key; 3221 }; 3222 3223 /** 3224 * struct cfg80211_bss_selection - connection parameters for BSS selection. 3225 * 3226 * @behaviour: requested BSS selection behaviour. 3227 * @param: parameters for requestion behaviour. 3228 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF. 3229 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST. 3230 */ 3231 struct cfg80211_bss_selection { 3232 enum nl80211_bss_select_attr behaviour; 3233 union { 3234 enum nl80211_band band_pref; 3235 struct cfg80211_bss_select_adjust adjust; 3236 } param; 3237 }; 3238 3239 /** 3240 * struct cfg80211_connect_params - Connection parameters 3241 * 3242 * This structure provides information needed to complete IEEE 802.11 3243 * authentication and association. 3244 * 3245 * @channel: The channel to use or %NULL if not specified (auto-select based 3246 * on scan results) 3247 * @channel_hint: The channel of the recommended BSS for initial connection or 3248 * %NULL if not specified 3249 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan 3250 * results) 3251 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or 3252 * %NULL if not specified. Unlike the @bssid parameter, the driver is 3253 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS 3254 * to use. 3255 * @ssid: SSID 3256 * @ssid_len: Length of ssid in octets 3257 * @auth_type: Authentication type (algorithm) 3258 * @ie: IEs for association request 3259 * @ie_len: Length of assoc_ie in octets 3260 * @privacy: indicates whether privacy-enabled APs should be used 3261 * @mfp: indicate whether management frame protection is used 3262 * @crypto: crypto settings 3263 * @key_len: length of WEP key for shared key authentication 3264 * @key_idx: index of WEP key for shared key authentication 3265 * @key: WEP key for shared key authentication 3266 * @flags: See &enum cfg80211_assoc_req_flags 3267 * @bg_scan_period: Background scan period in seconds 3268 * or -1 to indicate that default value is to be used. 3269 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask 3270 * will be used in ht_capa. Un-supported values will be ignored. 3271 * @ht_capa_mask: The bits of ht_capa which are to be used. 3272 * @vht_capa: VHT Capability overrides 3273 * @vht_capa_mask: The bits of vht_capa which are to be used. 3274 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG 3275 * networks. 3276 * @bss_select: criteria to be used for BSS selection. 3277 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used 3278 * to indicate a request to reassociate within the ESS instead of a request 3279 * do the initial association with the ESS. When included, this is set to 3280 * the BSSID of the current association, i.e., to the value that is 3281 * included in the Current AP address field of the Reassociation Request 3282 * frame. 3283 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the 3284 * NAI or %NULL if not specified. This is used to construct FILS wrapped 3285 * data IE. 3286 * @fils_erp_username_len: Length of @fils_erp_username in octets. 3287 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or 3288 * %NULL if not specified. This specifies the domain name of ER server and 3289 * is used to construct FILS wrapped data IE. 3290 * @fils_erp_realm_len: Length of @fils_erp_realm in octets. 3291 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP 3292 * messages. This is also used to construct FILS wrapped data IE. 3293 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional 3294 * keys in FILS or %NULL if not specified. 3295 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets. 3296 * @want_1x: indicates user-space supports and wants to use 802.1X driver 3297 * offload of 4-way handshake. 3298 * @edmg: define the EDMG channels. 3299 * This may specify multiple channels and bonding options for the driver 3300 * to choose from, based on BSS configuration. 3301 */ 3302 struct cfg80211_connect_params { 3303 struct ieee80211_channel *channel; 3304 struct ieee80211_channel *channel_hint; 3305 const u8 *bssid; 3306 const u8 *bssid_hint; 3307 const u8 *ssid; 3308 size_t ssid_len; 3309 enum nl80211_auth_type auth_type; 3310 const u8 *ie; 3311 size_t ie_len; 3312 bool privacy; 3313 enum nl80211_mfp mfp; 3314 struct cfg80211_crypto_settings crypto; 3315 const u8 *key; 3316 u8 key_len, key_idx; 3317 u32 flags; 3318 int bg_scan_period; 3319 struct ieee80211_ht_cap ht_capa; 3320 struct ieee80211_ht_cap ht_capa_mask; 3321 struct ieee80211_vht_cap vht_capa; 3322 struct ieee80211_vht_cap vht_capa_mask; 3323 bool pbss; 3324 struct cfg80211_bss_selection bss_select; 3325 const u8 *prev_bssid; 3326 const u8 *fils_erp_username; 3327 size_t fils_erp_username_len; 3328 const u8 *fils_erp_realm; 3329 size_t fils_erp_realm_len; 3330 u16 fils_erp_next_seq_num; 3331 const u8 *fils_erp_rrk; 3332 size_t fils_erp_rrk_len; 3333 bool want_1x; 3334 struct ieee80211_edmg edmg; 3335 }; 3336 3337 /** 3338 * enum cfg80211_connect_params_changed - Connection parameters being updated 3339 * 3340 * This enum provides information of all connect parameters that 3341 * have to be updated as part of update_connect_params() call. 3342 * 3343 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated 3344 * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm, 3345 * username, erp sequence number and rrk) are updated 3346 * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated 3347 */ 3348 enum cfg80211_connect_params_changed { 3349 UPDATE_ASSOC_IES = BIT(0), 3350 UPDATE_FILS_ERP_INFO = BIT(1), 3351 UPDATE_AUTH_TYPE = BIT(2), 3352 }; 3353 3354 /** 3355 * enum wiphy_params_flags - set_wiphy_params bitfield values 3356 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed 3357 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed 3358 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed 3359 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed 3360 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed 3361 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled 3362 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed 3363 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed 3364 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum 3365 */ 3366 enum wiphy_params_flags { 3367 WIPHY_PARAM_RETRY_SHORT = 1 << 0, 3368 WIPHY_PARAM_RETRY_LONG = 1 << 1, 3369 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2, 3370 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3, 3371 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4, 3372 WIPHY_PARAM_DYN_ACK = 1 << 5, 3373 WIPHY_PARAM_TXQ_LIMIT = 1 << 6, 3374 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7, 3375 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8, 3376 }; 3377 3378 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT 256 3379 3380 /* The per TXQ device queue limit in airtime */ 3381 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_L 5000 3382 #define IEEE80211_DEFAULT_AQL_TXQ_LIMIT_H 12000 3383 3384 /* The per interface airtime threshold to switch to lower queue limit */ 3385 #define IEEE80211_AQL_THRESHOLD 24000 3386 3387 /** 3388 * struct cfg80211_pmksa - PMK Security Association 3389 * 3390 * This structure is passed to the set/del_pmksa() method for PMKSA 3391 * caching. 3392 * 3393 * @bssid: The AP's BSSID (may be %NULL). 3394 * @pmkid: The identifier to refer a PMKSA. 3395 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key 3396 * derivation by a FILS STA. Otherwise, %NULL. 3397 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on 3398 * the hash algorithm used to generate this. 3399 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS 3400 * cache identifier (may be %NULL). 3401 * @ssid_len: Length of the @ssid in octets. 3402 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the 3403 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be 3404 * %NULL). 3405 * @pmk_lifetime: Maximum lifetime for PMKSA in seconds 3406 * (dot11RSNAConfigPMKLifetime) or 0 if not specified. 3407 * The configured PMKSA must not be used for PMKSA caching after 3408 * expiration and any keys derived from this PMK become invalid on 3409 * expiration, i.e., the current association must be dropped if the PMK 3410 * used for it expires. 3411 * @pmk_reauth_threshold: Threshold time for reauthentication (percentage of 3412 * PMK lifetime, dot11RSNAConfigPMKReauthThreshold) or 0 if not specified. 3413 * Drivers are expected to trigger a full authentication instead of using 3414 * this PMKSA for caching when reassociating to a new BSS after this 3415 * threshold to generate a new PMK before the current one expires. 3416 */ 3417 struct cfg80211_pmksa { 3418 const u8 *bssid; 3419 const u8 *pmkid; 3420 const u8 *pmk; 3421 size_t pmk_len; 3422 const u8 *ssid; 3423 size_t ssid_len; 3424 const u8 *cache_id; 3425 u32 pmk_lifetime; 3426 u8 pmk_reauth_threshold; 3427 }; 3428 3429 /** 3430 * struct cfg80211_pkt_pattern - packet pattern 3431 * @mask: bitmask where to match pattern and where to ignore bytes, 3432 * one bit per byte, in same format as nl80211 3433 * @pattern: bytes to match where bitmask is 1 3434 * @pattern_len: length of pattern (in bytes) 3435 * @pkt_offset: packet offset (in bytes) 3436 * 3437 * Internal note: @mask and @pattern are allocated in one chunk of 3438 * memory, free @mask only! 3439 */ 3440 struct cfg80211_pkt_pattern { 3441 const u8 *mask, *pattern; 3442 int pattern_len; 3443 int pkt_offset; 3444 }; 3445 3446 /** 3447 * struct cfg80211_wowlan_tcp - TCP connection parameters 3448 * 3449 * @sock: (internal) socket for source port allocation 3450 * @src: source IP address 3451 * @dst: destination IP address 3452 * @dst_mac: destination MAC address 3453 * @src_port: source port 3454 * @dst_port: destination port 3455 * @payload_len: data payload length 3456 * @payload: data payload buffer 3457 * @payload_seq: payload sequence stamping configuration 3458 * @data_interval: interval at which to send data packets 3459 * @wake_len: wakeup payload match length 3460 * @wake_data: wakeup payload match data 3461 * @wake_mask: wakeup payload match mask 3462 * @tokens_size: length of the tokens buffer 3463 * @payload_tok: payload token usage configuration 3464 */ 3465 struct cfg80211_wowlan_tcp { 3466 struct socket *sock; 3467 __be32 src, dst; 3468 u16 src_port, dst_port; 3469 u8 dst_mac[ETH_ALEN]; 3470 int payload_len; 3471 const u8 *payload; 3472 struct nl80211_wowlan_tcp_data_seq payload_seq; 3473 u32 data_interval; 3474 u32 wake_len; 3475 const u8 *wake_data, *wake_mask; 3476 u32 tokens_size; 3477 /* must be last, variable member */ 3478 struct nl80211_wowlan_tcp_data_token payload_tok; 3479 }; 3480 3481 /** 3482 * struct cfg80211_wowlan - Wake on Wireless-LAN support info 3483 * 3484 * This structure defines the enabled WoWLAN triggers for the device. 3485 * @any: wake up on any activity -- special trigger if device continues 3486 * operating as normal during suspend 3487 * @disconnect: wake up if getting disconnected 3488 * @magic_pkt: wake up on receiving magic packet 3489 * @patterns: wake up on receiving packet matching a pattern 3490 * @n_patterns: number of patterns 3491 * @gtk_rekey_failure: wake up on GTK rekey failure 3492 * @eap_identity_req: wake up on EAP identity request packet 3493 * @four_way_handshake: wake up on 4-way handshake 3494 * @rfkill_release: wake up when rfkill is released 3495 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h. 3496 * NULL if not configured. 3497 * @nd_config: configuration for the scan to be used for net detect wake. 3498 */ 3499 struct cfg80211_wowlan { 3500 bool any, disconnect, magic_pkt, gtk_rekey_failure, 3501 eap_identity_req, four_way_handshake, 3502 rfkill_release; 3503 struct cfg80211_pkt_pattern *patterns; 3504 struct cfg80211_wowlan_tcp *tcp; 3505 int n_patterns; 3506 struct cfg80211_sched_scan_request *nd_config; 3507 }; 3508 3509 /** 3510 * struct cfg80211_coalesce_rules - Coalesce rule parameters 3511 * 3512 * This structure defines coalesce rule for the device. 3513 * @delay: maximum coalescing delay in msecs. 3514 * @condition: condition for packet coalescence. 3515 * see &enum nl80211_coalesce_condition. 3516 * @patterns: array of packet patterns 3517 * @n_patterns: number of patterns 3518 */ 3519 struct cfg80211_coalesce_rules { 3520 int delay; 3521 enum nl80211_coalesce_condition condition; 3522 struct cfg80211_pkt_pattern *patterns; 3523 int n_patterns; 3524 }; 3525 3526 /** 3527 * struct cfg80211_coalesce - Packet coalescing settings 3528 * 3529 * This structure defines coalescing settings. 3530 * @rules: array of coalesce rules 3531 * @n_rules: number of rules 3532 */ 3533 struct cfg80211_coalesce { 3534 struct cfg80211_coalesce_rules *rules; 3535 int n_rules; 3536 }; 3537 3538 /** 3539 * struct cfg80211_wowlan_nd_match - information about the match 3540 * 3541 * @ssid: SSID of the match that triggered the wake up 3542 * @n_channels: Number of channels where the match occurred. This 3543 * value may be zero if the driver can't report the channels. 3544 * @channels: center frequencies of the channels where a match 3545 * occurred (in MHz) 3546 */ 3547 struct cfg80211_wowlan_nd_match { 3548 struct cfg80211_ssid ssid; 3549 int n_channels; 3550 u32 channels[]; 3551 }; 3552 3553 /** 3554 * struct cfg80211_wowlan_nd_info - net detect wake up information 3555 * 3556 * @n_matches: Number of match information instances provided in 3557 * @matches. This value may be zero if the driver can't provide 3558 * match information. 3559 * @matches: Array of pointers to matches containing information about 3560 * the matches that triggered the wake up. 3561 */ 3562 struct cfg80211_wowlan_nd_info { 3563 int n_matches; 3564 struct cfg80211_wowlan_nd_match *matches[]; 3565 }; 3566 3567 /** 3568 * struct cfg80211_wowlan_wakeup - wakeup report 3569 * @disconnect: woke up by getting disconnected 3570 * @magic_pkt: woke up by receiving magic packet 3571 * @gtk_rekey_failure: woke up by GTK rekey failure 3572 * @eap_identity_req: woke up by EAP identity request packet 3573 * @four_way_handshake: woke up by 4-way handshake 3574 * @rfkill_release: woke up by rfkill being released 3575 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern 3576 * @packet_present_len: copied wakeup packet data 3577 * @packet_len: original wakeup packet length 3578 * @packet: The packet causing the wakeup, if any. 3579 * @packet_80211: For pattern match, magic packet and other data 3580 * frame triggers an 802.3 frame should be reported, for 3581 * disconnect due to deauth 802.11 frame. This indicates which 3582 * it is. 3583 * @tcp_match: TCP wakeup packet received 3584 * @tcp_connlost: TCP connection lost or failed to establish 3585 * @tcp_nomoretokens: TCP data ran out of tokens 3586 * @net_detect: if not %NULL, woke up because of net detect 3587 */ 3588 struct cfg80211_wowlan_wakeup { 3589 bool disconnect, magic_pkt, gtk_rekey_failure, 3590 eap_identity_req, four_way_handshake, 3591 rfkill_release, packet_80211, 3592 tcp_match, tcp_connlost, tcp_nomoretokens; 3593 s32 pattern_idx; 3594 u32 packet_present_len, packet_len; 3595 const void *packet; 3596 struct cfg80211_wowlan_nd_info *net_detect; 3597 }; 3598 3599 /** 3600 * struct cfg80211_gtk_rekey_data - rekey data 3601 * @kek: key encryption key (@kek_len bytes) 3602 * @kck: key confirmation key (@kck_len bytes) 3603 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes) 3604 * @kek_len: length of kek 3605 * @kck_len: length of kck 3606 * @akm: akm (oui, id) 3607 */ 3608 struct cfg80211_gtk_rekey_data { 3609 const u8 *kek, *kck, *replay_ctr; 3610 u32 akm; 3611 u8 kek_len, kck_len; 3612 }; 3613 3614 /** 3615 * struct cfg80211_update_ft_ies_params - FT IE Information 3616 * 3617 * This structure provides information needed to update the fast transition IE 3618 * 3619 * @md: The Mobility Domain ID, 2 Octet value 3620 * @ie: Fast Transition IEs 3621 * @ie_len: Length of ft_ie in octets 3622 */ 3623 struct cfg80211_update_ft_ies_params { 3624 u16 md; 3625 const u8 *ie; 3626 size_t ie_len; 3627 }; 3628 3629 /** 3630 * struct cfg80211_mgmt_tx_params - mgmt tx parameters 3631 * 3632 * This structure provides information needed to transmit a mgmt frame 3633 * 3634 * @chan: channel to use 3635 * @offchan: indicates whether off channel operation is required 3636 * @wait: duration for ROC 3637 * @buf: buffer to transmit 3638 * @len: buffer length 3639 * @no_cck: don't use cck rates for this frame 3640 * @dont_wait_for_ack: tells the low level not to wait for an ack 3641 * @n_csa_offsets: length of csa_offsets array 3642 * @csa_offsets: array of all the csa offsets in the frame 3643 * @link_id: for MLO, the link ID to transmit on, -1 if not given; note 3644 * that the link ID isn't validated (much), it's in range but the 3645 * link might not exist (or be used by the receiver STA) 3646 */ 3647 struct cfg80211_mgmt_tx_params { 3648 struct ieee80211_channel *chan; 3649 bool offchan; 3650 unsigned int wait; 3651 const u8 *buf; 3652 size_t len; 3653 bool no_cck; 3654 bool dont_wait_for_ack; 3655 int n_csa_offsets; 3656 const u16 *csa_offsets; 3657 int link_id; 3658 }; 3659 3660 /** 3661 * struct cfg80211_dscp_exception - DSCP exception 3662 * 3663 * @dscp: DSCP value that does not adhere to the user priority range definition 3664 * @up: user priority value to which the corresponding DSCP value belongs 3665 */ 3666 struct cfg80211_dscp_exception { 3667 u8 dscp; 3668 u8 up; 3669 }; 3670 3671 /** 3672 * struct cfg80211_dscp_range - DSCP range definition for user priority 3673 * 3674 * @low: lowest DSCP value of this user priority range, inclusive 3675 * @high: highest DSCP value of this user priority range, inclusive 3676 */ 3677 struct cfg80211_dscp_range { 3678 u8 low; 3679 u8 high; 3680 }; 3681 3682 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */ 3683 #define IEEE80211_QOS_MAP_MAX_EX 21 3684 #define IEEE80211_QOS_MAP_LEN_MIN 16 3685 #define IEEE80211_QOS_MAP_LEN_MAX \ 3686 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX) 3687 3688 /** 3689 * struct cfg80211_qos_map - QoS Map Information 3690 * 3691 * This struct defines the Interworking QoS map setting for DSCP values 3692 * 3693 * @num_des: number of DSCP exceptions (0..21) 3694 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from 3695 * the user priority DSCP range definition 3696 * @up: DSCP range definition for a particular user priority 3697 */ 3698 struct cfg80211_qos_map { 3699 u8 num_des; 3700 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX]; 3701 struct cfg80211_dscp_range up[8]; 3702 }; 3703 3704 /** 3705 * struct cfg80211_nan_conf - NAN configuration 3706 * 3707 * This struct defines NAN configuration parameters 3708 * 3709 * @master_pref: master preference (1 - 255) 3710 * @bands: operating bands, a bitmap of &enum nl80211_band values. 3711 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set 3712 * (i.e. BIT(NL80211_BAND_2GHZ)). 3713 */ 3714 struct cfg80211_nan_conf { 3715 u8 master_pref; 3716 u8 bands; 3717 }; 3718 3719 /** 3720 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN 3721 * configuration 3722 * 3723 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference 3724 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands 3725 */ 3726 enum cfg80211_nan_conf_changes { 3727 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0), 3728 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1), 3729 }; 3730 3731 /** 3732 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter 3733 * 3734 * @filter: the content of the filter 3735 * @len: the length of the filter 3736 */ 3737 struct cfg80211_nan_func_filter { 3738 const u8 *filter; 3739 u8 len; 3740 }; 3741 3742 /** 3743 * struct cfg80211_nan_func - a NAN function 3744 * 3745 * @type: &enum nl80211_nan_function_type 3746 * @service_id: the service ID of the function 3747 * @publish_type: &nl80211_nan_publish_type 3748 * @close_range: if true, the range should be limited. Threshold is 3749 * implementation specific. 3750 * @publish_bcast: if true, the solicited publish should be broadcasted 3751 * @subscribe_active: if true, the subscribe is active 3752 * @followup_id: the instance ID for follow up 3753 * @followup_reqid: the requester instance ID for follow up 3754 * @followup_dest: MAC address of the recipient of the follow up 3755 * @ttl: time to live counter in DW. 3756 * @serv_spec_info: Service Specific Info 3757 * @serv_spec_info_len: Service Specific Info length 3758 * @srf_include: if true, SRF is inclusive 3759 * @srf_bf: Bloom Filter 3760 * @srf_bf_len: Bloom Filter length 3761 * @srf_bf_idx: Bloom Filter index 3762 * @srf_macs: SRF MAC addresses 3763 * @srf_num_macs: number of MAC addresses in SRF 3764 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter 3765 * @tx_filters: filters that should be transmitted in the SDF. 3766 * @num_rx_filters: length of &rx_filters. 3767 * @num_tx_filters: length of &tx_filters. 3768 * @instance_id: driver allocated id of the function. 3769 * @cookie: unique NAN function identifier. 3770 */ 3771 struct cfg80211_nan_func { 3772 enum nl80211_nan_function_type type; 3773 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN]; 3774 u8 publish_type; 3775 bool close_range; 3776 bool publish_bcast; 3777 bool subscribe_active; 3778 u8 followup_id; 3779 u8 followup_reqid; 3780 struct mac_address followup_dest; 3781 u32 ttl; 3782 const u8 *serv_spec_info; 3783 u8 serv_spec_info_len; 3784 bool srf_include; 3785 const u8 *srf_bf; 3786 u8 srf_bf_len; 3787 u8 srf_bf_idx; 3788 struct mac_address *srf_macs; 3789 int srf_num_macs; 3790 struct cfg80211_nan_func_filter *rx_filters; 3791 struct cfg80211_nan_func_filter *tx_filters; 3792 u8 num_tx_filters; 3793 u8 num_rx_filters; 3794 u8 instance_id; 3795 u64 cookie; 3796 }; 3797 3798 /** 3799 * struct cfg80211_pmk_conf - PMK configuration 3800 * 3801 * @aa: authenticator address 3802 * @pmk_len: PMK length in bytes. 3803 * @pmk: the PMK material 3804 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK 3805 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field 3806 * holds PMK-R0. 3807 */ 3808 struct cfg80211_pmk_conf { 3809 const u8 *aa; 3810 u8 pmk_len; 3811 const u8 *pmk; 3812 const u8 *pmk_r0_name; 3813 }; 3814 3815 /** 3816 * struct cfg80211_external_auth_params - Trigger External authentication. 3817 * 3818 * Commonly used across the external auth request and event interfaces. 3819 * 3820 * @action: action type / trigger for external authentication. Only significant 3821 * for the authentication request event interface (driver to user space). 3822 * @bssid: BSSID of the peer with which the authentication has 3823 * to happen. Used by both the authentication request event and 3824 * authentication response command interface. 3825 * @ssid: SSID of the AP. Used by both the authentication request event and 3826 * authentication response command interface. 3827 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the 3828 * authentication request event interface. 3829 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication, 3830 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you 3831 * the real status code for failures. Used only for the authentication 3832 * response command interface (user space to driver). 3833 * @pmkid: The identifier to refer a PMKSA. 3834 * @mld_addr: MLD address of the peer. Used by the authentication request event 3835 * interface. Driver indicates this to enable MLO during the authentication 3836 * offload to user space. Driver shall look at %NL80211_ATTR_MLO_SUPPORT 3837 * flag capability in NL80211_CMD_CONNECT to know whether the user space 3838 * supports enabling MLO during the authentication offload. 3839 * User space should use the address of the interface (on which the 3840 * authentication request event reported) as self MLD address. User space 3841 * and driver should use MLD addresses in RA, TA and BSSID fields of 3842 * authentication frames sent or received via cfg80211. The driver 3843 * translates the MLD addresses to/from link addresses based on the link 3844 * chosen for the authentication. 3845 */ 3846 struct cfg80211_external_auth_params { 3847 enum nl80211_external_auth_action action; 3848 u8 bssid[ETH_ALEN] __aligned(2); 3849 struct cfg80211_ssid ssid; 3850 unsigned int key_mgmt_suite; 3851 u16 status; 3852 const u8 *pmkid; 3853 u8 mld_addr[ETH_ALEN] __aligned(2); 3854 }; 3855 3856 /** 3857 * struct cfg80211_ftm_responder_stats - FTM responder statistics 3858 * 3859 * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to 3860 * indicate the relevant values in this struct for them 3861 * @success_num: number of FTM sessions in which all frames were successfully 3862 * answered 3863 * @partial_num: number of FTM sessions in which part of frames were 3864 * successfully answered 3865 * @failed_num: number of failed FTM sessions 3866 * @asap_num: number of ASAP FTM sessions 3867 * @non_asap_num: number of non-ASAP FTM sessions 3868 * @total_duration_ms: total sessions durations - gives an indication 3869 * of how much time the responder was busy 3870 * @unknown_triggers_num: number of unknown FTM triggers - triggers from 3871 * initiators that didn't finish successfully the negotiation phase with 3872 * the responder 3873 * @reschedule_requests_num: number of FTM reschedule requests - initiator asks 3874 * for a new scheduling although it already has scheduled FTM slot 3875 * @out_of_window_triggers_num: total FTM triggers out of scheduled window 3876 */ 3877 struct cfg80211_ftm_responder_stats { 3878 u32 filled; 3879 u32 success_num; 3880 u32 partial_num; 3881 u32 failed_num; 3882 u32 asap_num; 3883 u32 non_asap_num; 3884 u64 total_duration_ms; 3885 u32 unknown_triggers_num; 3886 u32 reschedule_requests_num; 3887 u32 out_of_window_triggers_num; 3888 }; 3889 3890 /** 3891 * struct cfg80211_pmsr_ftm_result - FTM result 3892 * @failure_reason: if this measurement failed (PMSR status is 3893 * %NL80211_PMSR_STATUS_FAILURE), this gives a more precise 3894 * reason than just "failure" 3895 * @burst_index: if reporting partial results, this is the index 3896 * in [0 .. num_bursts-1] of the burst that's being reported 3897 * @num_ftmr_attempts: number of FTM request frames transmitted 3898 * @num_ftmr_successes: number of FTM request frames acked 3899 * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY, 3900 * fill this to indicate in how many seconds a retry is deemed possible 3901 * by the responder 3902 * @num_bursts_exp: actual number of bursts exponent negotiated 3903 * @burst_duration: actual burst duration negotiated 3904 * @ftms_per_burst: actual FTMs per burst negotiated 3905 * @lci_len: length of LCI information (if present) 3906 * @civicloc_len: length of civic location information (if present) 3907 * @lci: LCI data (may be %NULL) 3908 * @civicloc: civic location data (may be %NULL) 3909 * @rssi_avg: average RSSI over FTM action frames reported 3910 * @rssi_spread: spread of the RSSI over FTM action frames reported 3911 * @tx_rate: bitrate for transmitted FTM action frame response 3912 * @rx_rate: bitrate of received FTM action frame 3913 * @rtt_avg: average of RTTs measured (must have either this or @dist_avg) 3914 * @rtt_variance: variance of RTTs measured (note that standard deviation is 3915 * the square root of the variance) 3916 * @rtt_spread: spread of the RTTs measured 3917 * @dist_avg: average of distances (mm) measured 3918 * (must have either this or @rtt_avg) 3919 * @dist_variance: variance of distances measured (see also @rtt_variance) 3920 * @dist_spread: spread of distances measured (see also @rtt_spread) 3921 * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid 3922 * @num_ftmr_successes_valid: @num_ftmr_successes is valid 3923 * @rssi_avg_valid: @rssi_avg is valid 3924 * @rssi_spread_valid: @rssi_spread is valid 3925 * @tx_rate_valid: @tx_rate is valid 3926 * @rx_rate_valid: @rx_rate is valid 3927 * @rtt_avg_valid: @rtt_avg is valid 3928 * @rtt_variance_valid: @rtt_variance is valid 3929 * @rtt_spread_valid: @rtt_spread is valid 3930 * @dist_avg_valid: @dist_avg is valid 3931 * @dist_variance_valid: @dist_variance is valid 3932 * @dist_spread_valid: @dist_spread is valid 3933 */ 3934 struct cfg80211_pmsr_ftm_result { 3935 const u8 *lci; 3936 const u8 *civicloc; 3937 unsigned int lci_len; 3938 unsigned int civicloc_len; 3939 enum nl80211_peer_measurement_ftm_failure_reasons failure_reason; 3940 u32 num_ftmr_attempts, num_ftmr_successes; 3941 s16 burst_index; 3942 u8 busy_retry_time; 3943 u8 num_bursts_exp; 3944 u8 burst_duration; 3945 u8 ftms_per_burst; 3946 s32 rssi_avg; 3947 s32 rssi_spread; 3948 struct rate_info tx_rate, rx_rate; 3949 s64 rtt_avg; 3950 s64 rtt_variance; 3951 s64 rtt_spread; 3952 s64 dist_avg; 3953 s64 dist_variance; 3954 s64 dist_spread; 3955 3956 u16 num_ftmr_attempts_valid:1, 3957 num_ftmr_successes_valid:1, 3958 rssi_avg_valid:1, 3959 rssi_spread_valid:1, 3960 tx_rate_valid:1, 3961 rx_rate_valid:1, 3962 rtt_avg_valid:1, 3963 rtt_variance_valid:1, 3964 rtt_spread_valid:1, 3965 dist_avg_valid:1, 3966 dist_variance_valid:1, 3967 dist_spread_valid:1; 3968 }; 3969 3970 /** 3971 * struct cfg80211_pmsr_result - peer measurement result 3972 * @addr: address of the peer 3973 * @host_time: host time (use ktime_get_boottime() adjust to the time when the 3974 * measurement was made) 3975 * @ap_tsf: AP's TSF at measurement time 3976 * @status: status of the measurement 3977 * @final: if reporting partial results, mark this as the last one; if not 3978 * reporting partial results always set this flag 3979 * @ap_tsf_valid: indicates the @ap_tsf value is valid 3980 * @type: type of the measurement reported, note that we only support reporting 3981 * one type at a time, but you can report multiple results separately and 3982 * they're all aggregated for userspace. 3983 * @ftm: FTM result 3984 */ 3985 struct cfg80211_pmsr_result { 3986 u64 host_time, ap_tsf; 3987 enum nl80211_peer_measurement_status status; 3988 3989 u8 addr[ETH_ALEN]; 3990 3991 u8 final:1, 3992 ap_tsf_valid:1; 3993 3994 enum nl80211_peer_measurement_type type; 3995 3996 union { 3997 struct cfg80211_pmsr_ftm_result ftm; 3998 }; 3999 }; 4000 4001 /** 4002 * struct cfg80211_pmsr_ftm_request_peer - FTM request data 4003 * @requested: indicates FTM is requested 4004 * @preamble: frame preamble to use 4005 * @burst_period: burst period to use 4006 * @asap: indicates to use ASAP mode 4007 * @num_bursts_exp: number of bursts exponent 4008 * @burst_duration: burst duration 4009 * @ftms_per_burst: number of FTMs per burst 4010 * @ftmr_retries: number of retries for FTM request 4011 * @request_lci: request LCI information 4012 * @request_civicloc: request civic location information 4013 * @trigger_based: use trigger based ranging for the measurement 4014 * If neither @trigger_based nor @non_trigger_based is set, 4015 * EDCA based ranging will be used. 4016 * @non_trigger_based: use non trigger based ranging for the measurement 4017 * If neither @trigger_based nor @non_trigger_based is set, 4018 * EDCA based ranging will be used. 4019 * @lmr_feedback: negotiate for I2R LMR feedback. Only valid if either 4020 * @trigger_based or @non_trigger_based is set. 4021 * @bss_color: the bss color of the responder. Optional. Set to zero to 4022 * indicate the driver should set the BSS color. Only valid if 4023 * @non_trigger_based or @trigger_based is set. 4024 * 4025 * See also nl80211 for the respective attribute documentation. 4026 */ 4027 struct cfg80211_pmsr_ftm_request_peer { 4028 enum nl80211_preamble preamble; 4029 u16 burst_period; 4030 u8 requested:1, 4031 asap:1, 4032 request_lci:1, 4033 request_civicloc:1, 4034 trigger_based:1, 4035 non_trigger_based:1, 4036 lmr_feedback:1; 4037 u8 num_bursts_exp; 4038 u8 burst_duration; 4039 u8 ftms_per_burst; 4040 u8 ftmr_retries; 4041 u8 bss_color; 4042 }; 4043 4044 /** 4045 * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request 4046 * @addr: MAC address 4047 * @chandef: channel to use 4048 * @report_ap_tsf: report the associated AP's TSF 4049 * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer 4050 */ 4051 struct cfg80211_pmsr_request_peer { 4052 u8 addr[ETH_ALEN]; 4053 struct cfg80211_chan_def chandef; 4054 u8 report_ap_tsf:1; 4055 struct cfg80211_pmsr_ftm_request_peer ftm; 4056 }; 4057 4058 /** 4059 * struct cfg80211_pmsr_request - peer measurement request 4060 * @cookie: cookie, set by cfg80211 4061 * @nl_portid: netlink portid - used by cfg80211 4062 * @drv_data: driver data for this request, if required for aborting, 4063 * not otherwise freed or anything by cfg80211 4064 * @mac_addr: MAC address used for (randomised) request 4065 * @mac_addr_mask: MAC address mask used for randomisation, bits that 4066 * are 0 in the mask should be randomised, bits that are 1 should 4067 * be taken from the @mac_addr 4068 * @list: used by cfg80211 to hold on to the request 4069 * @timeout: timeout (in milliseconds) for the whole operation, if 4070 * zero it means there's no timeout 4071 * @n_peers: number of peers to do measurements with 4072 * @peers: per-peer measurement request data 4073 */ 4074 struct cfg80211_pmsr_request { 4075 u64 cookie; 4076 void *drv_data; 4077 u32 n_peers; 4078 u32 nl_portid; 4079 4080 u32 timeout; 4081 4082 u8 mac_addr[ETH_ALEN] __aligned(2); 4083 u8 mac_addr_mask[ETH_ALEN] __aligned(2); 4084 4085 struct list_head list; 4086 4087 struct cfg80211_pmsr_request_peer peers[] __counted_by(n_peers); 4088 }; 4089 4090 /** 4091 * struct cfg80211_update_owe_info - OWE Information 4092 * 4093 * This structure provides information needed for the drivers to offload OWE 4094 * (Opportunistic Wireless Encryption) processing to the user space. 4095 * 4096 * Commonly used across update_owe_info request and event interfaces. 4097 * 4098 * @peer: MAC address of the peer device for which the OWE processing 4099 * has to be done. 4100 * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info 4101 * processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space 4102 * cannot give you the real status code for failures. Used only for 4103 * OWE update request command interface (user space to driver). 4104 * @ie: IEs obtained from the peer or constructed by the user space. These are 4105 * the IEs of the remote peer in the event from the host driver and 4106 * the constructed IEs by the user space in the request interface. 4107 * @ie_len: Length of IEs in octets. 4108 * @assoc_link_id: MLO link ID of the AP, with which (re)association requested 4109 * by peer. This will be filled by driver for both MLO and non-MLO station 4110 * connections when the AP affiliated with an MLD. For non-MLD AP mode, it 4111 * will be -1. Used only with OWE update event (driver to user space). 4112 * @peer_mld_addr: For MLO connection, MLD address of the peer. For non-MLO 4113 * connection, it will be all zeros. This is applicable only when 4114 * @assoc_link_id is not -1, i.e., the AP affiliated with an MLD. Used only 4115 * with OWE update event (driver to user space). 4116 */ 4117 struct cfg80211_update_owe_info { 4118 u8 peer[ETH_ALEN] __aligned(2); 4119 u16 status; 4120 const u8 *ie; 4121 size_t ie_len; 4122 int assoc_link_id; 4123 u8 peer_mld_addr[ETH_ALEN] __aligned(2); 4124 }; 4125 4126 /** 4127 * struct mgmt_frame_regs - management frame registrations data 4128 * @global_stypes: bitmap of management frame subtypes registered 4129 * for the entire device 4130 * @interface_stypes: bitmap of management frame subtypes registered 4131 * for the given interface 4132 * @global_mcast_stypes: mcast RX is needed globally for these subtypes 4133 * @interface_mcast_stypes: mcast RX is needed on this interface 4134 * for these subtypes 4135 */ 4136 struct mgmt_frame_regs { 4137 u32 global_stypes, interface_stypes; 4138 u32 global_mcast_stypes, interface_mcast_stypes; 4139 }; 4140 4141 /** 4142 * struct cfg80211_ops - backend description for wireless configuration 4143 * 4144 * This struct is registered by fullmac card drivers and/or wireless stacks 4145 * in order to handle configuration requests on their interfaces. 4146 * 4147 * All callbacks except where otherwise noted should return 0 4148 * on success or a negative error code. 4149 * 4150 * All operations are invoked with the wiphy mutex held. The RTNL may be 4151 * held in addition (due to wireless extensions) but this cannot be relied 4152 * upon except in cases where documented below. Note that due to ordering, 4153 * the RTNL also cannot be acquired in any handlers. 4154 * 4155 * @suspend: wiphy device needs to be suspended. The variable @wow will 4156 * be %NULL or contain the enabled Wake-on-Wireless triggers that are 4157 * configured for the device. 4158 * @resume: wiphy device needs to be resumed 4159 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback 4160 * to call device_set_wakeup_enable() to enable/disable wakeup from 4161 * the device. 4162 * 4163 * @add_virtual_intf: create a new virtual interface with the given name, 4164 * must set the struct wireless_dev's iftype. Beware: You must create 4165 * the new netdev in the wiphy's network namespace! Returns the struct 4166 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must 4167 * also set the address member in the wdev. 4168 * This additionally holds the RTNL to be able to do netdev changes. 4169 * 4170 * @del_virtual_intf: remove the virtual interface 4171 * This additionally holds the RTNL to be able to do netdev changes. 4172 * 4173 * @change_virtual_intf: change type/configuration of virtual interface, 4174 * keep the struct wireless_dev's iftype updated. 4175 * This additionally holds the RTNL to be able to do netdev changes. 4176 * 4177 * @add_intf_link: Add a new MLO link to the given interface. Note that 4178 * the wdev->link[] data structure has been updated, so the new link 4179 * address is available. 4180 * @del_intf_link: Remove an MLO link from the given interface. 4181 * 4182 * @add_key: add a key with the given parameters. @mac_addr will be %NULL 4183 * when adding a group key. @link_id will be -1 for non-MLO connection. 4184 * For MLO connection, @link_id will be >= 0 for group key and -1 for 4185 * pairwise key, @mac_addr will be peer's MLD address for MLO pairwise key. 4186 * 4187 * @get_key: get information about the key with the given parameters. 4188 * @mac_addr will be %NULL when requesting information for a group 4189 * key. All pointers given to the @callback function need not be valid 4190 * after it returns. This function should return an error if it is 4191 * not possible to retrieve the key, -ENOENT if it doesn't exist. 4192 * @link_id will be -1 for non-MLO connection. For MLO connection, 4193 * @link_id will be >= 0 for group key and -1 for pairwise key, @mac_addr 4194 * will be peer's MLD address for MLO pairwise key. 4195 * 4196 * @del_key: remove a key given the @mac_addr (%NULL for a group key) 4197 * and @key_index, return -ENOENT if the key doesn't exist. @link_id will 4198 * be -1 for non-MLO connection. For MLO connection, @link_id will be >= 0 4199 * for group key and -1 for pairwise key, @mac_addr will be peer's MLD 4200 * address for MLO pairwise key. 4201 * 4202 * @set_default_key: set the default key on an interface. @link_id will be >= 0 4203 * for MLO connection and -1 for non-MLO connection. 4204 * 4205 * @set_default_mgmt_key: set the default management frame key on an interface. 4206 * @link_id will be >= 0 for MLO connection and -1 for non-MLO connection. 4207 * 4208 * @set_default_beacon_key: set the default Beacon frame key on an interface. 4209 * @link_id will be >= 0 for MLO connection and -1 for non-MLO connection. 4210 * 4211 * @set_rekey_data: give the data necessary for GTK rekeying to the driver 4212 * 4213 * @start_ap: Start acting in AP mode defined by the parameters. 4214 * @change_beacon: Change the beacon parameters for an access point mode 4215 * interface. This should reject the call when AP mode wasn't started. 4216 * @stop_ap: Stop being an AP, including stopping beaconing. 4217 * 4218 * @add_station: Add a new station. 4219 * @del_station: Remove a station 4220 * @change_station: Modify a given station. Note that flags changes are not much 4221 * validated in cfg80211, in particular the auth/assoc/authorized flags 4222 * might come to the driver in invalid combinations -- make sure to check 4223 * them, also against the existing state! Drivers must call 4224 * cfg80211_check_station_change() to validate the information. 4225 * @get_station: get station information for the station identified by @mac 4226 * @dump_station: dump station callback -- resume dump at index @idx 4227 * 4228 * @add_mpath: add a fixed mesh path 4229 * @del_mpath: delete a given mesh path 4230 * @change_mpath: change a given mesh path 4231 * @get_mpath: get a mesh path for the given parameters 4232 * @dump_mpath: dump mesh path callback -- resume dump at index @idx 4233 * @get_mpp: get a mesh proxy path for the given parameters 4234 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx 4235 * @join_mesh: join the mesh network with the specified parameters 4236 * (invoked with the wireless_dev mutex held) 4237 * @leave_mesh: leave the current mesh network 4238 * (invoked with the wireless_dev mutex held) 4239 * 4240 * @get_mesh_config: Get the current mesh configuration 4241 * 4242 * @update_mesh_config: Update mesh parameters on a running mesh. 4243 * The mask is a bitfield which tells us which parameters to 4244 * set, and which to leave alone. 4245 * 4246 * @change_bss: Modify parameters for a given BSS. 4247 * 4248 * @inform_bss: Called by cfg80211 while being informed about new BSS data 4249 * for every BSS found within the reported data or frame. This is called 4250 * from within the cfg8011 inform_bss handlers while holding the bss_lock. 4251 * The data parameter is passed through from drv_data inside 4252 * struct cfg80211_inform_bss. 4253 * The new IE data for the BSS is explicitly passed. 4254 * 4255 * @set_txq_params: Set TX queue parameters 4256 * 4257 * @libertas_set_mesh_channel: Only for backward compatibility for libertas, 4258 * as it doesn't implement join_mesh and needs to set the channel to 4259 * join the mesh instead. 4260 * 4261 * @set_monitor_channel: Set the monitor mode channel for the device. If other 4262 * interfaces are active this callback should reject the configuration. 4263 * If no interfaces are active or the device is down, the channel should 4264 * be stored for when a monitor interface becomes active. 4265 * 4266 * @scan: Request to do a scan. If returning zero, the scan request is given 4267 * the driver, and will be valid until passed to cfg80211_scan_done(). 4268 * For scan results, call cfg80211_inform_bss(); you can call this outside 4269 * the scan/scan_done bracket too. 4270 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall 4271 * indicate the status of the scan through cfg80211_scan_done(). 4272 * 4273 * @auth: Request to authenticate with the specified peer 4274 * (invoked with the wireless_dev mutex held) 4275 * @assoc: Request to (re)associate with the specified peer 4276 * (invoked with the wireless_dev mutex held) 4277 * @deauth: Request to deauthenticate from the specified peer 4278 * (invoked with the wireless_dev mutex held) 4279 * @disassoc: Request to disassociate from the specified peer 4280 * (invoked with the wireless_dev mutex held) 4281 * 4282 * @connect: Connect to the ESS with the specified parameters. When connected, 4283 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code 4284 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call 4285 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code 4286 * from the AP or cfg80211_connect_timeout() if no frame with status code 4287 * was received. 4288 * The driver is allowed to roam to other BSSes within the ESS when the 4289 * other BSS matches the connect parameters. When such roaming is initiated 4290 * by the driver, the driver is expected to verify that the target matches 4291 * the configured security parameters and to use Reassociation Request 4292 * frame instead of Association Request frame. 4293 * The connect function can also be used to request the driver to perform a 4294 * specific roam when connected to an ESS. In that case, the prev_bssid 4295 * parameter is set to the BSSID of the currently associated BSS as an 4296 * indication of requesting reassociation. 4297 * In both the driver-initiated and new connect() call initiated roaming 4298 * cases, the result of roaming is indicated with a call to 4299 * cfg80211_roamed(). (invoked with the wireless_dev mutex held) 4300 * @update_connect_params: Update the connect parameters while connected to a 4301 * BSS. The updated parameters can be used by driver/firmware for 4302 * subsequent BSS selection (roaming) decisions and to form the 4303 * Authentication/(Re)Association Request frames. This call does not 4304 * request an immediate disassociation or reassociation with the current 4305 * BSS, i.e., this impacts only subsequent (re)associations. The bits in 4306 * changed are defined in &enum cfg80211_connect_params_changed. 4307 * (invoked with the wireless_dev mutex held) 4308 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if 4309 * connection is in progress. Once done, call cfg80211_disconnected() in 4310 * case connection was already established (invoked with the 4311 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout(). 4312 * 4313 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call 4314 * cfg80211_ibss_joined(), also call that function when changing BSSID due 4315 * to a merge. 4316 * (invoked with the wireless_dev mutex held) 4317 * @leave_ibss: Leave the IBSS. 4318 * (invoked with the wireless_dev mutex held) 4319 * 4320 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or 4321 * MESH mode) 4322 * 4323 * @set_wiphy_params: Notify that wiphy parameters have changed; 4324 * @changed bitfield (see &enum wiphy_params_flags) describes which values 4325 * have changed. The actual parameter values are available in 4326 * struct wiphy. If returning an error, no value should be changed. 4327 * 4328 * @set_tx_power: set the transmit power according to the parameters, 4329 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The 4330 * wdev may be %NULL if power was set for the wiphy, and will 4331 * always be %NULL unless the driver supports per-vif TX power 4332 * (as advertised by the nl80211 feature flag.) 4333 * @get_tx_power: store the current TX power into the dbm variable; 4334 * return 0 if successful 4335 * 4336 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting 4337 * functions to adjust rfkill hw state 4338 * 4339 * @dump_survey: get site survey information. 4340 * 4341 * @remain_on_channel: Request the driver to remain awake on the specified 4342 * channel for the specified duration to complete an off-channel 4343 * operation (e.g., public action frame exchange). When the driver is 4344 * ready on the requested channel, it must indicate this with an event 4345 * notification by calling cfg80211_ready_on_channel(). 4346 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation. 4347 * This allows the operation to be terminated prior to timeout based on 4348 * the duration value. 4349 * @mgmt_tx: Transmit a management frame. 4350 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management 4351 * frame on another channel 4352 * 4353 * @testmode_cmd: run a test mode command; @wdev may be %NULL 4354 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be 4355 * used by the function, but 0 and 1 must not be touched. Additionally, 4356 * return error codes other than -ENOBUFS and -ENOENT will terminate the 4357 * dump and return to userspace with an error, so be careful. If any data 4358 * was passed in from userspace then the data/len arguments will be present 4359 * and point to the data contained in %NL80211_ATTR_TESTDATA. 4360 * 4361 * @set_bitrate_mask: set the bitrate mask configuration 4362 * 4363 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac 4364 * devices running firmwares capable of generating the (re) association 4365 * RSN IE. It allows for faster roaming between WPA2 BSSIDs. 4366 * @del_pmksa: Delete a cached PMKID. 4367 * @flush_pmksa: Flush all cached PMKIDs. 4368 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1 4369 * allows the driver to adjust the dynamic ps timeout value. 4370 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold. 4371 * After configuration, the driver should (soon) send an event indicating 4372 * the current level is above/below the configured threshold; this may 4373 * need some care when the configuration is changed (without first being 4374 * disabled.) 4375 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the 4376 * connection quality monitor. An event is to be sent only when the 4377 * signal level is found to be outside the two values. The driver should 4378 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented. 4379 * If it is provided then there's no point providing @set_cqm_rssi_config. 4380 * @set_cqm_txe_config: Configure connection quality monitor TX error 4381 * thresholds. 4382 * @sched_scan_start: Tell the driver to start a scheduled scan. 4383 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with 4384 * given request id. This call must stop the scheduled scan and be ready 4385 * for starting a new one before it returns, i.e. @sched_scan_start may be 4386 * called immediately after that again and should not fail in that case. 4387 * The driver should not call cfg80211_sched_scan_stopped() for a requested 4388 * stop (when this method returns 0). 4389 * 4390 * @update_mgmt_frame_registrations: Notify the driver that management frame 4391 * registrations were updated. The callback is allowed to sleep. 4392 * 4393 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device. 4394 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may 4395 * reject TX/RX mask combinations they cannot support by returning -EINVAL 4396 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX). 4397 * 4398 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant). 4399 * 4400 * @tdls_mgmt: Transmit a TDLS management frame. 4401 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup). 4402 * 4403 * @probe_client: probe an associated client, must return a cookie that it 4404 * later passes to cfg80211_probe_status(). 4405 * 4406 * @set_noack_map: Set the NoAck Map for the TIDs. 4407 * 4408 * @get_channel: Get the current operating channel for the virtual interface. 4409 * For monitor interfaces, it should return %NULL unless there's a single 4410 * current monitoring channel. 4411 * 4412 * @start_p2p_device: Start the given P2P device. 4413 * @stop_p2p_device: Stop the given P2P device. 4414 * 4415 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode. 4416 * Parameters include ACL policy, an array of MAC address of stations 4417 * and the number of MAC addresses. If there is already a list in driver 4418 * this new list replaces the existing one. Driver has to clear its ACL 4419 * when number of MAC addresses entries is passed as 0. Drivers which 4420 * advertise the support for MAC based ACL have to implement this callback. 4421 * 4422 * @start_radar_detection: Start radar detection in the driver. 4423 * 4424 * @end_cac: End running CAC, probably because a related CAC 4425 * was finished on another phy. 4426 * 4427 * @update_ft_ies: Provide updated Fast BSS Transition information to the 4428 * driver. If the SME is in the driver/firmware, this information can be 4429 * used in building Authentication and Reassociation Request frames. 4430 * 4431 * @crit_proto_start: Indicates a critical protocol needs more link reliability 4432 * for a given duration (milliseconds). The protocol is provided so the 4433 * driver can take the most appropriate actions. 4434 * @crit_proto_stop: Indicates critical protocol no longer needs increased link 4435 * reliability. This operation can not fail. 4436 * @set_coalesce: Set coalesce parameters. 4437 * 4438 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is 4439 * responsible for veryfing if the switch is possible. Since this is 4440 * inherently tricky driver may decide to disconnect an interface later 4441 * with cfg80211_stop_iface(). This doesn't mean driver can accept 4442 * everything. It should do it's best to verify requests and reject them 4443 * as soon as possible. 4444 * 4445 * @set_qos_map: Set QoS mapping information to the driver 4446 * 4447 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the 4448 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width 4449 * changes during the lifetime of the BSS. 4450 * 4451 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device 4452 * with the given parameters; action frame exchange has been handled by 4453 * userspace so this just has to modify the TX path to take the TS into 4454 * account. 4455 * If the admitted time is 0 just validate the parameters to make sure 4456 * the session can be created at all; it is valid to just always return 4457 * success for that but that may result in inefficient behaviour (handshake 4458 * with the peer followed by immediate teardown when the addition is later 4459 * rejected) 4460 * @del_tx_ts: remove an existing TX TS 4461 * 4462 * @join_ocb: join the OCB network with the specified parameters 4463 * (invoked with the wireless_dev mutex held) 4464 * @leave_ocb: leave the current OCB network 4465 * (invoked with the wireless_dev mutex held) 4466 * 4467 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver 4468 * is responsible for continually initiating channel-switching operations 4469 * and returning to the base channel for communication with the AP. 4470 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both 4471 * peers must be on the base channel when the call completes. 4472 * @start_nan: Start the NAN interface. 4473 * @stop_nan: Stop the NAN interface. 4474 * @add_nan_func: Add a NAN function. Returns negative value on failure. 4475 * On success @nan_func ownership is transferred to the driver and 4476 * it may access it outside of the scope of this function. The driver 4477 * should free the @nan_func when no longer needed by calling 4478 * cfg80211_free_nan_func(). 4479 * On success the driver should assign an instance_id in the 4480 * provided @nan_func. 4481 * @del_nan_func: Delete a NAN function. 4482 * @nan_change_conf: changes NAN configuration. The changed parameters must 4483 * be specified in @changes (using &enum cfg80211_nan_conf_changes); 4484 * All other parameters must be ignored. 4485 * 4486 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS 4487 * 4488 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this 4489 * function should return phy stats, and interface stats otherwise. 4490 * 4491 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake. 4492 * If not deleted through @del_pmk the PMK remains valid until disconnect 4493 * upon which the driver should clear it. 4494 * (invoked with the wireless_dev mutex held) 4495 * @del_pmk: delete the previously configured PMK for the given authenticator. 4496 * (invoked with the wireless_dev mutex held) 4497 * 4498 * @external_auth: indicates result of offloaded authentication processing from 4499 * user space 4500 * 4501 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter 4502 * tells the driver that the frame should not be encrypted. 4503 * 4504 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available. 4505 * Statistics should be cumulative, currently no way to reset is provided. 4506 * @start_pmsr: start peer measurement (e.g. FTM) 4507 * @abort_pmsr: abort peer measurement 4508 * 4509 * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME 4510 * but offloading OWE processing to the user space will get the updated 4511 * DH IE through this interface. 4512 * 4513 * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame 4514 * and overrule HWMP path selection algorithm. 4515 * @set_tid_config: TID specific configuration, this can be peer or BSS specific 4516 * This callback may sleep. 4517 * @reset_tid_config: Reset TID specific configuration for the peer, for the 4518 * given TIDs. This callback may sleep. 4519 * 4520 * @set_sar_specs: Update the SAR (TX power) settings. 4521 * 4522 * @color_change: Initiate a color change. 4523 * 4524 * @set_fils_aad: Set FILS AAD data to the AP driver so that the driver can use 4525 * those to decrypt (Re)Association Request and encrypt (Re)Association 4526 * Response frame. 4527 * 4528 * @set_radar_background: Configure dedicated offchannel chain available for 4529 * radar/CAC detection on some hw. This chain can't be used to transmit 4530 * or receive frames and it is bounded to a running wdev. 4531 * Background radar/CAC detection allows to avoid the CAC downtime 4532 * switching to a different channel during CAC detection on the selected 4533 * radar channel. 4534 * The caller is expected to set chandef pointer to NULL in order to 4535 * disable background CAC/radar detection. 4536 * @add_link_station: Add a link to a station. 4537 * @mod_link_station: Modify a link of a station. 4538 * @del_link_station: Remove a link of a station. 4539 * 4540 * @set_hw_timestamp: Enable/disable HW timestamping of TM/FTM frames. 4541 * @set_ttlm: set the TID to link mapping. 4542 */ 4543 struct cfg80211_ops { 4544 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow); 4545 int (*resume)(struct wiphy *wiphy); 4546 void (*set_wakeup)(struct wiphy *wiphy, bool enabled); 4547 4548 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy, 4549 const char *name, 4550 unsigned char name_assign_type, 4551 enum nl80211_iftype type, 4552 struct vif_params *params); 4553 int (*del_virtual_intf)(struct wiphy *wiphy, 4554 struct wireless_dev *wdev); 4555 int (*change_virtual_intf)(struct wiphy *wiphy, 4556 struct net_device *dev, 4557 enum nl80211_iftype type, 4558 struct vif_params *params); 4559 4560 int (*add_intf_link)(struct wiphy *wiphy, 4561 struct wireless_dev *wdev, 4562 unsigned int link_id); 4563 void (*del_intf_link)(struct wiphy *wiphy, 4564 struct wireless_dev *wdev, 4565 unsigned int link_id); 4566 4567 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev, 4568 int link_id, u8 key_index, bool pairwise, 4569 const u8 *mac_addr, struct key_params *params); 4570 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev, 4571 int link_id, u8 key_index, bool pairwise, 4572 const u8 *mac_addr, void *cookie, 4573 void (*callback)(void *cookie, struct key_params*)); 4574 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev, 4575 int link_id, u8 key_index, bool pairwise, 4576 const u8 *mac_addr); 4577 int (*set_default_key)(struct wiphy *wiphy, 4578 struct net_device *netdev, int link_id, 4579 u8 key_index, bool unicast, bool multicast); 4580 int (*set_default_mgmt_key)(struct wiphy *wiphy, 4581 struct net_device *netdev, int link_id, 4582 u8 key_index); 4583 int (*set_default_beacon_key)(struct wiphy *wiphy, 4584 struct net_device *netdev, 4585 int link_id, 4586 u8 key_index); 4587 4588 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev, 4589 struct cfg80211_ap_settings *settings); 4590 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev, 4591 struct cfg80211_ap_update *info); 4592 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev, 4593 unsigned int link_id); 4594 4595 4596 int (*add_station)(struct wiphy *wiphy, struct net_device *dev, 4597 const u8 *mac, 4598 struct station_parameters *params); 4599 int (*del_station)(struct wiphy *wiphy, struct net_device *dev, 4600 struct station_del_parameters *params); 4601 int (*change_station)(struct wiphy *wiphy, struct net_device *dev, 4602 const u8 *mac, 4603 struct station_parameters *params); 4604 int (*get_station)(struct wiphy *wiphy, struct net_device *dev, 4605 const u8 *mac, struct station_info *sinfo); 4606 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev, 4607 int idx, u8 *mac, struct station_info *sinfo); 4608 4609 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev, 4610 const u8 *dst, const u8 *next_hop); 4611 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev, 4612 const u8 *dst); 4613 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev, 4614 const u8 *dst, const u8 *next_hop); 4615 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev, 4616 u8 *dst, u8 *next_hop, struct mpath_info *pinfo); 4617 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev, 4618 int idx, u8 *dst, u8 *next_hop, 4619 struct mpath_info *pinfo); 4620 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev, 4621 u8 *dst, u8 *mpp, struct mpath_info *pinfo); 4622 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev, 4623 int idx, u8 *dst, u8 *mpp, 4624 struct mpath_info *pinfo); 4625 int (*get_mesh_config)(struct wiphy *wiphy, 4626 struct net_device *dev, 4627 struct mesh_config *conf); 4628 int (*update_mesh_config)(struct wiphy *wiphy, 4629 struct net_device *dev, u32 mask, 4630 const struct mesh_config *nconf); 4631 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev, 4632 const struct mesh_config *conf, 4633 const struct mesh_setup *setup); 4634 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev); 4635 4636 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev, 4637 struct ocb_setup *setup); 4638 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev); 4639 4640 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev, 4641 struct bss_parameters *params); 4642 4643 void (*inform_bss)(struct wiphy *wiphy, struct cfg80211_bss *bss, 4644 const struct cfg80211_bss_ies *ies, void *data); 4645 4646 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev, 4647 struct ieee80211_txq_params *params); 4648 4649 int (*libertas_set_mesh_channel)(struct wiphy *wiphy, 4650 struct net_device *dev, 4651 struct ieee80211_channel *chan); 4652 4653 int (*set_monitor_channel)(struct wiphy *wiphy, 4654 struct cfg80211_chan_def *chandef); 4655 4656 int (*scan)(struct wiphy *wiphy, 4657 struct cfg80211_scan_request *request); 4658 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev); 4659 4660 int (*auth)(struct wiphy *wiphy, struct net_device *dev, 4661 struct cfg80211_auth_request *req); 4662 int (*assoc)(struct wiphy *wiphy, struct net_device *dev, 4663 struct cfg80211_assoc_request *req); 4664 int (*deauth)(struct wiphy *wiphy, struct net_device *dev, 4665 struct cfg80211_deauth_request *req); 4666 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev, 4667 struct cfg80211_disassoc_request *req); 4668 4669 int (*connect)(struct wiphy *wiphy, struct net_device *dev, 4670 struct cfg80211_connect_params *sme); 4671 int (*update_connect_params)(struct wiphy *wiphy, 4672 struct net_device *dev, 4673 struct cfg80211_connect_params *sme, 4674 u32 changed); 4675 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev, 4676 u16 reason_code); 4677 4678 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev, 4679 struct cfg80211_ibss_params *params); 4680 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev); 4681 4682 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev, 4683 int rate[NUM_NL80211_BANDS]); 4684 4685 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed); 4686 4687 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev, 4688 enum nl80211_tx_power_setting type, int mbm); 4689 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev, 4690 int *dbm); 4691 4692 void (*rfkill_poll)(struct wiphy *wiphy); 4693 4694 #ifdef CONFIG_NL80211_TESTMODE 4695 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev, 4696 void *data, int len); 4697 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb, 4698 struct netlink_callback *cb, 4699 void *data, int len); 4700 #endif 4701 4702 int (*set_bitrate_mask)(struct wiphy *wiphy, 4703 struct net_device *dev, 4704 unsigned int link_id, 4705 const u8 *peer, 4706 const struct cfg80211_bitrate_mask *mask); 4707 4708 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev, 4709 int idx, struct survey_info *info); 4710 4711 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev, 4712 struct cfg80211_pmksa *pmksa); 4713 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev, 4714 struct cfg80211_pmksa *pmksa); 4715 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev); 4716 4717 int (*remain_on_channel)(struct wiphy *wiphy, 4718 struct wireless_dev *wdev, 4719 struct ieee80211_channel *chan, 4720 unsigned int duration, 4721 u64 *cookie); 4722 int (*cancel_remain_on_channel)(struct wiphy *wiphy, 4723 struct wireless_dev *wdev, 4724 u64 cookie); 4725 4726 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev, 4727 struct cfg80211_mgmt_tx_params *params, 4728 u64 *cookie); 4729 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy, 4730 struct wireless_dev *wdev, 4731 u64 cookie); 4732 4733 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev, 4734 bool enabled, int timeout); 4735 4736 int (*set_cqm_rssi_config)(struct wiphy *wiphy, 4737 struct net_device *dev, 4738 s32 rssi_thold, u32 rssi_hyst); 4739 4740 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy, 4741 struct net_device *dev, 4742 s32 rssi_low, s32 rssi_high); 4743 4744 int (*set_cqm_txe_config)(struct wiphy *wiphy, 4745 struct net_device *dev, 4746 u32 rate, u32 pkts, u32 intvl); 4747 4748 void (*update_mgmt_frame_registrations)(struct wiphy *wiphy, 4749 struct wireless_dev *wdev, 4750 struct mgmt_frame_regs *upd); 4751 4752 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant); 4753 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant); 4754 4755 int (*sched_scan_start)(struct wiphy *wiphy, 4756 struct net_device *dev, 4757 struct cfg80211_sched_scan_request *request); 4758 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev, 4759 u64 reqid); 4760 4761 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev, 4762 struct cfg80211_gtk_rekey_data *data); 4763 4764 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev, 4765 const u8 *peer, int link_id, 4766 u8 action_code, u8 dialog_token, u16 status_code, 4767 u32 peer_capability, bool initiator, 4768 const u8 *buf, size_t len); 4769 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev, 4770 const u8 *peer, enum nl80211_tdls_operation oper); 4771 4772 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev, 4773 const u8 *peer, u64 *cookie); 4774 4775 int (*set_noack_map)(struct wiphy *wiphy, 4776 struct net_device *dev, 4777 u16 noack_map); 4778 4779 int (*get_channel)(struct wiphy *wiphy, 4780 struct wireless_dev *wdev, 4781 unsigned int link_id, 4782 struct cfg80211_chan_def *chandef); 4783 4784 int (*start_p2p_device)(struct wiphy *wiphy, 4785 struct wireless_dev *wdev); 4786 void (*stop_p2p_device)(struct wiphy *wiphy, 4787 struct wireless_dev *wdev); 4788 4789 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev, 4790 const struct cfg80211_acl_data *params); 4791 4792 int (*start_radar_detection)(struct wiphy *wiphy, 4793 struct net_device *dev, 4794 struct cfg80211_chan_def *chandef, 4795 u32 cac_time_ms); 4796 void (*end_cac)(struct wiphy *wiphy, 4797 struct net_device *dev); 4798 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev, 4799 struct cfg80211_update_ft_ies_params *ftie); 4800 int (*crit_proto_start)(struct wiphy *wiphy, 4801 struct wireless_dev *wdev, 4802 enum nl80211_crit_proto_id protocol, 4803 u16 duration); 4804 void (*crit_proto_stop)(struct wiphy *wiphy, 4805 struct wireless_dev *wdev); 4806 int (*set_coalesce)(struct wiphy *wiphy, 4807 struct cfg80211_coalesce *coalesce); 4808 4809 int (*channel_switch)(struct wiphy *wiphy, 4810 struct net_device *dev, 4811 struct cfg80211_csa_settings *params); 4812 4813 int (*set_qos_map)(struct wiphy *wiphy, 4814 struct net_device *dev, 4815 struct cfg80211_qos_map *qos_map); 4816 4817 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev, 4818 unsigned int link_id, 4819 struct cfg80211_chan_def *chandef); 4820 4821 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev, 4822 u8 tsid, const u8 *peer, u8 user_prio, 4823 u16 admitted_time); 4824 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev, 4825 u8 tsid, const u8 *peer); 4826 4827 int (*tdls_channel_switch)(struct wiphy *wiphy, 4828 struct net_device *dev, 4829 const u8 *addr, u8 oper_class, 4830 struct cfg80211_chan_def *chandef); 4831 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy, 4832 struct net_device *dev, 4833 const u8 *addr); 4834 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev, 4835 struct cfg80211_nan_conf *conf); 4836 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev); 4837 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev, 4838 struct cfg80211_nan_func *nan_func); 4839 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev, 4840 u64 cookie); 4841 int (*nan_change_conf)(struct wiphy *wiphy, 4842 struct wireless_dev *wdev, 4843 struct cfg80211_nan_conf *conf, 4844 u32 changes); 4845 4846 int (*set_multicast_to_unicast)(struct wiphy *wiphy, 4847 struct net_device *dev, 4848 const bool enabled); 4849 4850 int (*get_txq_stats)(struct wiphy *wiphy, 4851 struct wireless_dev *wdev, 4852 struct cfg80211_txq_stats *txqstats); 4853 4854 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev, 4855 const struct cfg80211_pmk_conf *conf); 4856 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev, 4857 const u8 *aa); 4858 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev, 4859 struct cfg80211_external_auth_params *params); 4860 4861 int (*tx_control_port)(struct wiphy *wiphy, 4862 struct net_device *dev, 4863 const u8 *buf, size_t len, 4864 const u8 *dest, const __be16 proto, 4865 const bool noencrypt, int link_id, 4866 u64 *cookie); 4867 4868 int (*get_ftm_responder_stats)(struct wiphy *wiphy, 4869 struct net_device *dev, 4870 struct cfg80211_ftm_responder_stats *ftm_stats); 4871 4872 int (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev, 4873 struct cfg80211_pmsr_request *request); 4874 void (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev, 4875 struct cfg80211_pmsr_request *request); 4876 int (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev, 4877 struct cfg80211_update_owe_info *owe_info); 4878 int (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev, 4879 const u8 *buf, size_t len); 4880 int (*set_tid_config)(struct wiphy *wiphy, struct net_device *dev, 4881 struct cfg80211_tid_config *tid_conf); 4882 int (*reset_tid_config)(struct wiphy *wiphy, struct net_device *dev, 4883 const u8 *peer, u8 tids); 4884 int (*set_sar_specs)(struct wiphy *wiphy, 4885 struct cfg80211_sar_specs *sar); 4886 int (*color_change)(struct wiphy *wiphy, 4887 struct net_device *dev, 4888 struct cfg80211_color_change_settings *params); 4889 int (*set_fils_aad)(struct wiphy *wiphy, struct net_device *dev, 4890 struct cfg80211_fils_aad *fils_aad); 4891 int (*set_radar_background)(struct wiphy *wiphy, 4892 struct cfg80211_chan_def *chandef); 4893 int (*add_link_station)(struct wiphy *wiphy, struct net_device *dev, 4894 struct link_station_parameters *params); 4895 int (*mod_link_station)(struct wiphy *wiphy, struct net_device *dev, 4896 struct link_station_parameters *params); 4897 int (*del_link_station)(struct wiphy *wiphy, struct net_device *dev, 4898 struct link_station_del_parameters *params); 4899 int (*set_hw_timestamp)(struct wiphy *wiphy, struct net_device *dev, 4900 struct cfg80211_set_hw_timestamp *hwts); 4901 int (*set_ttlm)(struct wiphy *wiphy, struct net_device *dev, 4902 struct cfg80211_ttlm_params *params); 4903 }; 4904 4905 /* 4906 * wireless hardware and networking interfaces structures 4907 * and registration/helper functions 4908 */ 4909 4910 /** 4911 * enum wiphy_flags - wiphy capability flags 4912 * 4913 * @WIPHY_FLAG_SPLIT_SCAN_6GHZ: if set to true, the scan request will be split 4914 * into two, first for legacy bands and second for UHB. 4915 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this 4916 * wiphy at all 4917 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled 4918 * by default -- this flag will be set depending on the kernel's default 4919 * on wiphy_new(), but can be changed by the driver if it has a good 4920 * reason to override the default 4921 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station 4922 * on a VLAN interface). This flag also serves an extra purpose of 4923 * supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype. 4924 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station 4925 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the 4926 * control port protocol ethertype. The device also honours the 4927 * control_port_no_encrypt flag. 4928 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN. 4929 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing 4930 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH. 4931 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the 4932 * firmware. 4933 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP. 4934 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation. 4935 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z) 4936 * link setup/discovery operations internally. Setup, discovery and 4937 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT 4938 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be 4939 * used for asking the driver/firmware to perform a TDLS operation. 4940 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME 4941 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes 4942 * when there are virtual interfaces in AP mode by calling 4943 * cfg80211_report_obss_beacon(). 4944 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device 4945 * responds to probe-requests in hardware. 4946 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX. 4947 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call. 4948 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels. 4949 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in 4950 * beaconing mode (AP, IBSS, Mesh, ...). 4951 * @WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK: The device supports bigger kek and kck keys 4952 * @WIPHY_FLAG_SUPPORTS_MLO: This is a temporary flag gating the MLO APIs, 4953 * in order to not have them reachable in normal drivers, until we have 4954 * complete feature/interface combinations/etc. advertisement. No driver 4955 * should set this flag for now. 4956 * @WIPHY_FLAG_SUPPORTS_EXT_KCK_32: The device supports 32-byte KCK keys. 4957 * @WIPHY_FLAG_NOTIFY_REGDOM_BY_DRIVER: The device could handle reg notify for 4958 * NL80211_REGDOM_SET_BY_DRIVER. 4959 * @WIPHY_FLAG_CHANNEL_CHANGE_ON_BEACON: reg_call_notifier() is called if driver 4960 * set this flag to update channels on beacon hints. 4961 * @WIPHY_FLAG_SUPPORTS_NSTR_NONPRIMARY: support connection to non-primary link 4962 * of an NSTR mobile AP MLD. 4963 */ 4964 enum wiphy_flags { 4965 WIPHY_FLAG_SUPPORTS_EXT_KEK_KCK = BIT(0), 4966 WIPHY_FLAG_SUPPORTS_MLO = BIT(1), 4967 WIPHY_FLAG_SPLIT_SCAN_6GHZ = BIT(2), 4968 WIPHY_FLAG_NETNS_OK = BIT(3), 4969 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4), 4970 WIPHY_FLAG_4ADDR_AP = BIT(5), 4971 WIPHY_FLAG_4ADDR_STATION = BIT(6), 4972 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7), 4973 WIPHY_FLAG_IBSS_RSN = BIT(8), 4974 WIPHY_FLAG_MESH_AUTH = BIT(10), 4975 WIPHY_FLAG_SUPPORTS_EXT_KCK_32 = BIT(11), 4976 WIPHY_FLAG_SUPPORTS_NSTR_NONPRIMARY = BIT(12), 4977 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13), 4978 WIPHY_FLAG_AP_UAPSD = BIT(14), 4979 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15), 4980 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16), 4981 WIPHY_FLAG_HAVE_AP_SME = BIT(17), 4982 WIPHY_FLAG_REPORTS_OBSS = BIT(18), 4983 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19), 4984 WIPHY_FLAG_OFFCHAN_TX = BIT(20), 4985 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21), 4986 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22), 4987 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23), 4988 WIPHY_FLAG_NOTIFY_REGDOM_BY_DRIVER = BIT(24), 4989 WIPHY_FLAG_CHANNEL_CHANGE_ON_BEACON = BIT(25), 4990 }; 4991 4992 /** 4993 * struct ieee80211_iface_limit - limit on certain interface types 4994 * @max: maximum number of interfaces of these types 4995 * @types: interface types (bits) 4996 */ 4997 struct ieee80211_iface_limit { 4998 u16 max; 4999 u16 types; 5000 }; 5001 5002 /** 5003 * struct ieee80211_iface_combination - possible interface combination 5004 * 5005 * With this structure the driver can describe which interface 5006 * combinations it supports concurrently. 5007 * 5008 * Examples: 5009 * 5010 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total: 5011 * 5012 * .. code-block:: c 5013 * 5014 * struct ieee80211_iface_limit limits1[] = { 5015 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), }, 5016 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP), }, 5017 * }; 5018 * struct ieee80211_iface_combination combination1 = { 5019 * .limits = limits1, 5020 * .n_limits = ARRAY_SIZE(limits1), 5021 * .max_interfaces = 2, 5022 * .beacon_int_infra_match = true, 5023 * }; 5024 * 5025 * 5026 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total: 5027 * 5028 * .. code-block:: c 5029 * 5030 * struct ieee80211_iface_limit limits2[] = { 5031 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) | 5032 * BIT(NL80211_IFTYPE_P2P_GO), }, 5033 * }; 5034 * struct ieee80211_iface_combination combination2 = { 5035 * .limits = limits2, 5036 * .n_limits = ARRAY_SIZE(limits2), 5037 * .max_interfaces = 8, 5038 * .num_different_channels = 1, 5039 * }; 5040 * 5041 * 5042 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total. 5043 * 5044 * This allows for an infrastructure connection and three P2P connections. 5045 * 5046 * .. code-block:: c 5047 * 5048 * struct ieee80211_iface_limit limits3[] = { 5049 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), }, 5050 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) | 5051 * BIT(NL80211_IFTYPE_P2P_CLIENT), }, 5052 * }; 5053 * struct ieee80211_iface_combination combination3 = { 5054 * .limits = limits3, 5055 * .n_limits = ARRAY_SIZE(limits3), 5056 * .max_interfaces = 4, 5057 * .num_different_channels = 2, 5058 * }; 5059 * 5060 */ 5061 struct ieee80211_iface_combination { 5062 /** 5063 * @limits: 5064 * limits for the given interface types 5065 */ 5066 const struct ieee80211_iface_limit *limits; 5067 5068 /** 5069 * @num_different_channels: 5070 * can use up to this many different channels 5071 */ 5072 u32 num_different_channels; 5073 5074 /** 5075 * @max_interfaces: 5076 * maximum number of interfaces in total allowed in this group 5077 */ 5078 u16 max_interfaces; 5079 5080 /** 5081 * @n_limits: 5082 * number of limitations 5083 */ 5084 u8 n_limits; 5085 5086 /** 5087 * @beacon_int_infra_match: 5088 * In this combination, the beacon intervals between infrastructure 5089 * and AP types must match. This is required only in special cases. 5090 */ 5091 bool beacon_int_infra_match; 5092 5093 /** 5094 * @radar_detect_widths: 5095 * bitmap of channel widths supported for radar detection 5096 */ 5097 u8 radar_detect_widths; 5098 5099 /** 5100 * @radar_detect_regions: 5101 * bitmap of regions supported for radar detection 5102 */ 5103 u8 radar_detect_regions; 5104 5105 /** 5106 * @beacon_int_min_gcd: 5107 * This interface combination supports different beacon intervals. 5108 * 5109 * = 0 5110 * all beacon intervals for different interface must be same. 5111 * > 0 5112 * any beacon interval for the interface part of this combination AND 5113 * GCD of all beacon intervals from beaconing interfaces of this 5114 * combination must be greater or equal to this value. 5115 */ 5116 u32 beacon_int_min_gcd; 5117 }; 5118 5119 struct ieee80211_txrx_stypes { 5120 u16 tx, rx; 5121 }; 5122 5123 /** 5124 * enum wiphy_wowlan_support_flags - WoWLAN support flags 5125 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any" 5126 * trigger that keeps the device operating as-is and 5127 * wakes up the host on any activity, for example a 5128 * received packet that passed filtering; note that the 5129 * packet should be preserved in that case 5130 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet 5131 * (see nl80211.h) 5132 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect 5133 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep 5134 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure 5135 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request 5136 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure 5137 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release 5138 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection 5139 */ 5140 enum wiphy_wowlan_support_flags { 5141 WIPHY_WOWLAN_ANY = BIT(0), 5142 WIPHY_WOWLAN_MAGIC_PKT = BIT(1), 5143 WIPHY_WOWLAN_DISCONNECT = BIT(2), 5144 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3), 5145 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4), 5146 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5), 5147 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6), 5148 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7), 5149 WIPHY_WOWLAN_NET_DETECT = BIT(8), 5150 }; 5151 5152 struct wiphy_wowlan_tcp_support { 5153 const struct nl80211_wowlan_tcp_data_token_feature *tok; 5154 u32 data_payload_max; 5155 u32 data_interval_max; 5156 u32 wake_payload_max; 5157 bool seq; 5158 }; 5159 5160 /** 5161 * struct wiphy_wowlan_support - WoWLAN support data 5162 * @flags: see &enum wiphy_wowlan_support_flags 5163 * @n_patterns: number of supported wakeup patterns 5164 * (see nl80211.h for the pattern definition) 5165 * @pattern_max_len: maximum length of each pattern 5166 * @pattern_min_len: minimum length of each pattern 5167 * @max_pkt_offset: maximum Rx packet offset 5168 * @max_nd_match_sets: maximum number of matchsets for net-detect, 5169 * similar, but not necessarily identical, to max_match_sets for 5170 * scheduled scans. 5171 * See &struct cfg80211_sched_scan_request.@match_sets for more 5172 * details. 5173 * @tcp: TCP wakeup support information 5174 */ 5175 struct wiphy_wowlan_support { 5176 u32 flags; 5177 int n_patterns; 5178 int pattern_max_len; 5179 int pattern_min_len; 5180 int max_pkt_offset; 5181 int max_nd_match_sets; 5182 const struct wiphy_wowlan_tcp_support *tcp; 5183 }; 5184 5185 /** 5186 * struct wiphy_coalesce_support - coalesce support data 5187 * @n_rules: maximum number of coalesce rules 5188 * @max_delay: maximum supported coalescing delay in msecs 5189 * @n_patterns: number of supported patterns in a rule 5190 * (see nl80211.h for the pattern definition) 5191 * @pattern_max_len: maximum length of each pattern 5192 * @pattern_min_len: minimum length of each pattern 5193 * @max_pkt_offset: maximum Rx packet offset 5194 */ 5195 struct wiphy_coalesce_support { 5196 int n_rules; 5197 int max_delay; 5198 int n_patterns; 5199 int pattern_max_len; 5200 int pattern_min_len; 5201 int max_pkt_offset; 5202 }; 5203 5204 /** 5205 * enum wiphy_vendor_command_flags - validation flags for vendor commands 5206 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev 5207 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev 5208 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running 5209 * (must be combined with %_WDEV or %_NETDEV) 5210 */ 5211 enum wiphy_vendor_command_flags { 5212 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0), 5213 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1), 5214 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2), 5215 }; 5216 5217 /** 5218 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags 5219 * 5220 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed 5221 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed 5222 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed 5223 * 5224 */ 5225 enum wiphy_opmode_flag { 5226 STA_OPMODE_MAX_BW_CHANGED = BIT(0), 5227 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1), 5228 STA_OPMODE_N_SS_CHANGED = BIT(2), 5229 }; 5230 5231 /** 5232 * struct sta_opmode_info - Station's ht/vht operation mode information 5233 * @changed: contains value from &enum wiphy_opmode_flag 5234 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station 5235 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station 5236 * @rx_nss: new rx_nss value of a station 5237 */ 5238 5239 struct sta_opmode_info { 5240 u32 changed; 5241 enum nl80211_smps_mode smps_mode; 5242 enum nl80211_chan_width bw; 5243 u8 rx_nss; 5244 }; 5245 5246 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA)) 5247 5248 /** 5249 * struct wiphy_vendor_command - vendor command definition 5250 * @info: vendor command identifying information, as used in nl80211 5251 * @flags: flags, see &enum wiphy_vendor_command_flags 5252 * @doit: callback for the operation, note that wdev is %NULL if the 5253 * flags didn't ask for a wdev and non-%NULL otherwise; the data 5254 * pointer may be %NULL if userspace provided no data at all 5255 * @dumpit: dump callback, for transferring bigger/multiple items. The 5256 * @storage points to cb->args[5], ie. is preserved over the multiple 5257 * dumpit calls. 5258 * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA. 5259 * Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the 5260 * attribute is just raw data (e.g. a firmware command). 5261 * @maxattr: highest attribute number in policy 5262 * It's recommended to not have the same sub command with both @doit and 5263 * @dumpit, so that userspace can assume certain ones are get and others 5264 * are used with dump requests. 5265 */ 5266 struct wiphy_vendor_command { 5267 struct nl80211_vendor_cmd_info info; 5268 u32 flags; 5269 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev, 5270 const void *data, int data_len); 5271 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev, 5272 struct sk_buff *skb, const void *data, int data_len, 5273 unsigned long *storage); 5274 const struct nla_policy *policy; 5275 unsigned int maxattr; 5276 }; 5277 5278 /** 5279 * struct wiphy_iftype_ext_capab - extended capabilities per interface type 5280 * @iftype: interface type 5281 * @extended_capabilities: extended capabilities supported by the driver, 5282 * additional capabilities might be supported by userspace; these are the 5283 * 802.11 extended capabilities ("Extended Capabilities element") and are 5284 * in the same format as in the information element. See IEEE Std 5285 * 802.11-2012 8.4.2.29 for the defined fields. 5286 * @extended_capabilities_mask: mask of the valid values 5287 * @extended_capabilities_len: length of the extended capabilities 5288 * @eml_capabilities: EML capabilities (for MLO) 5289 * @mld_capa_and_ops: MLD capabilities and operations (for MLO) 5290 */ 5291 struct wiphy_iftype_ext_capab { 5292 enum nl80211_iftype iftype; 5293 const u8 *extended_capabilities; 5294 const u8 *extended_capabilities_mask; 5295 u8 extended_capabilities_len; 5296 u16 eml_capabilities; 5297 u16 mld_capa_and_ops; 5298 }; 5299 5300 /** 5301 * cfg80211_get_iftype_ext_capa - lookup interface type extended capability 5302 * @wiphy: the wiphy to look up from 5303 * @type: the interface type to look up 5304 */ 5305 const struct wiphy_iftype_ext_capab * 5306 cfg80211_get_iftype_ext_capa(struct wiphy *wiphy, enum nl80211_iftype type); 5307 5308 /** 5309 * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities 5310 * @max_peers: maximum number of peers in a single measurement 5311 * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement 5312 * @randomize_mac_addr: can randomize MAC address for measurement 5313 * @ftm: FTM measurement data 5314 * @ftm.supported: FTM measurement is supported 5315 * @ftm.asap: ASAP-mode is supported 5316 * @ftm.non_asap: non-ASAP-mode is supported 5317 * @ftm.request_lci: can request LCI data 5318 * @ftm.request_civicloc: can request civic location data 5319 * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble) 5320 * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width) 5321 * @ftm.max_bursts_exponent: maximum burst exponent supported 5322 * (set to -1 if not limited; note that setting this will necessarily 5323 * forbid using the value 15 to let the responder pick) 5324 * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if 5325 * not limited) 5326 * @ftm.trigger_based: trigger based ranging measurement is supported 5327 * @ftm.non_trigger_based: non trigger based ranging measurement is supported 5328 */ 5329 struct cfg80211_pmsr_capabilities { 5330 unsigned int max_peers; 5331 u8 report_ap_tsf:1, 5332 randomize_mac_addr:1; 5333 5334 struct { 5335 u32 preambles; 5336 u32 bandwidths; 5337 s8 max_bursts_exponent; 5338 u8 max_ftms_per_burst; 5339 u8 supported:1, 5340 asap:1, 5341 non_asap:1, 5342 request_lci:1, 5343 request_civicloc:1, 5344 trigger_based:1, 5345 non_trigger_based:1; 5346 } ftm; 5347 }; 5348 5349 /** 5350 * struct wiphy_iftype_akm_suites - This structure encapsulates supported akm 5351 * suites for interface types defined in @iftypes_mask. Each type in the 5352 * @iftypes_mask must be unique across all instances of iftype_akm_suites. 5353 * 5354 * @iftypes_mask: bitmask of interfaces types 5355 * @akm_suites: points to an array of supported akm suites 5356 * @n_akm_suites: number of supported AKM suites 5357 */ 5358 struct wiphy_iftype_akm_suites { 5359 u16 iftypes_mask; 5360 const u32 *akm_suites; 5361 int n_akm_suites; 5362 }; 5363 5364 #define CFG80211_HW_TIMESTAMP_ALL_PEERS 0xffff 5365 5366 /** 5367 * struct wiphy - wireless hardware description 5368 * @mtx: mutex for the data (structures) of this device 5369 * @reg_notifier: the driver's regulatory notification callback, 5370 * note that if your driver uses wiphy_apply_custom_regulatory() 5371 * the reg_notifier's request can be passed as NULL 5372 * @regd: the driver's regulatory domain, if one was requested via 5373 * the regulatory_hint() API. This can be used by the driver 5374 * on the reg_notifier() if it chooses to ignore future 5375 * regulatory domain changes caused by other drivers. 5376 * @signal_type: signal type reported in &struct cfg80211_bss. 5377 * @cipher_suites: supported cipher suites 5378 * @n_cipher_suites: number of supported cipher suites 5379 * @akm_suites: supported AKM suites. These are the default AKMs supported if 5380 * the supported AKMs not advertized for a specific interface type in 5381 * iftype_akm_suites. 5382 * @n_akm_suites: number of supported AKM suites 5383 * @iftype_akm_suites: array of supported akm suites info per interface type. 5384 * Note that the bits in @iftypes_mask inside this structure cannot 5385 * overlap (i.e. only one occurrence of each type is allowed across all 5386 * instances of iftype_akm_suites). 5387 * @num_iftype_akm_suites: number of interface types for which supported akm 5388 * suites are specified separately. 5389 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit) 5390 * @retry_long: Retry limit for long frames (dot11LongRetryLimit) 5391 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold); 5392 * -1 = fragmentation disabled, only odd values >= 256 used 5393 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled 5394 * @_net: the network namespace this wiphy currently lives in 5395 * @perm_addr: permanent MAC address of this device 5396 * @addr_mask: If the device supports multiple MAC addresses by masking, 5397 * set this to a mask with variable bits set to 1, e.g. if the last 5398 * four bits are variable then set it to 00-00-00-00-00-0f. The actual 5399 * variable bits shall be determined by the interfaces added, with 5400 * interfaces not matching the mask being rejected to be brought up. 5401 * @n_addresses: number of addresses in @addresses. 5402 * @addresses: If the device has more than one address, set this pointer 5403 * to a list of addresses (6 bytes each). The first one will be used 5404 * by default for perm_addr. In this case, the mask should be set to 5405 * all-zeroes. In this case it is assumed that the device can handle 5406 * the same number of arbitrary MAC addresses. 5407 * @registered: protects ->resume and ->suspend sysfs callbacks against 5408 * unregister hardware 5409 * @debugfsdir: debugfs directory used for this wiphy (ieee80211/<wiphyname>). 5410 * It will be renamed automatically on wiphy renames 5411 * @dev: (virtual) struct device for this wiphy. The item in 5412 * /sys/class/ieee80211/ points to this. You need use set_wiphy_dev() 5413 * (see below). 5414 * @wext: wireless extension handlers 5415 * @priv: driver private data (sized according to wiphy_new() parameter) 5416 * @interface_modes: bitmask of interfaces types valid for this wiphy, 5417 * must be set by driver 5418 * @iface_combinations: Valid interface combinations array, should not 5419 * list single interface types. 5420 * @n_iface_combinations: number of entries in @iface_combinations array. 5421 * @software_iftypes: bitmask of software interface types, these are not 5422 * subject to any restrictions since they are purely managed in SW. 5423 * @flags: wiphy flags, see &enum wiphy_flags 5424 * @regulatory_flags: wiphy regulatory flags, see 5425 * &enum ieee80211_regulatory_flags 5426 * @features: features advertised to nl80211, see &enum nl80211_feature_flags. 5427 * @ext_features: extended features advertised to nl80211, see 5428 * &enum nl80211_ext_feature_index. 5429 * @bss_priv_size: each BSS struct has private data allocated with it, 5430 * this variable determines its size 5431 * @max_scan_ssids: maximum number of SSIDs the device can scan for in 5432 * any given scan 5433 * @max_sched_scan_reqs: maximum number of scheduled scan requests that 5434 * the device can run concurrently. 5435 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan 5436 * for in any given scheduled scan 5437 * @max_match_sets: maximum number of match sets the device can handle 5438 * when performing a scheduled scan, 0 if filtering is not 5439 * supported. 5440 * @max_scan_ie_len: maximum length of user-controlled IEs device can 5441 * add to probe request frames transmitted during a scan, must not 5442 * include fixed IEs like supported rates 5443 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled 5444 * scans 5445 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number 5446 * of iterations) for scheduled scan supported by the device. 5447 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a 5448 * single scan plan supported by the device. 5449 * @max_sched_scan_plan_iterations: maximum number of iterations for a single 5450 * scan plan supported by the device. 5451 * @coverage_class: current coverage class 5452 * @fw_version: firmware version for ethtool reporting 5453 * @hw_version: hardware version for ethtool reporting 5454 * @max_num_pmkids: maximum number of PMKIDs supported by device 5455 * @privid: a pointer that drivers can use to identify if an arbitrary 5456 * wiphy is theirs, e.g. in global notifiers 5457 * @bands: information about bands/channels supported by this device 5458 * 5459 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or 5460 * transmitted through nl80211, points to an array indexed by interface 5461 * type 5462 * 5463 * @available_antennas_tx: bitmap of antennas which are available to be 5464 * configured as TX antennas. Antenna configuration commands will be 5465 * rejected unless this or @available_antennas_rx is set. 5466 * 5467 * @available_antennas_rx: bitmap of antennas which are available to be 5468 * configured as RX antennas. Antenna configuration commands will be 5469 * rejected unless this or @available_antennas_tx is set. 5470 * 5471 * @probe_resp_offload: 5472 * Bitmap of supported protocols for probe response offloading. 5473 * See &enum nl80211_probe_resp_offload_support_attr. Only valid 5474 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set. 5475 * 5476 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation 5477 * may request, if implemented. 5478 * 5479 * @wowlan: WoWLAN support information 5480 * @wowlan_config: current WoWLAN configuration; this should usually not be 5481 * used since access to it is necessarily racy, use the parameter passed 5482 * to the suspend() operation instead. 5483 * 5484 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features. 5485 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden. 5486 * If null, then none can be over-ridden. 5487 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden. 5488 * If null, then none can be over-ridden. 5489 * 5490 * @wdev_list: the list of associated (virtual) interfaces; this list must 5491 * not be modified by the driver, but can be read with RTNL/RCU protection. 5492 * 5493 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device 5494 * supports for ACL. 5495 * 5496 * @extended_capabilities: extended capabilities supported by the driver, 5497 * additional capabilities might be supported by userspace; these are 5498 * the 802.11 extended capabilities ("Extended Capabilities element") 5499 * and are in the same format as in the information element. See 5500 * 802.11-2012 8.4.2.29 for the defined fields. These are the default 5501 * extended capabilities to be used if the capabilities are not specified 5502 * for a specific interface type in iftype_ext_capab. 5503 * @extended_capabilities_mask: mask of the valid values 5504 * @extended_capabilities_len: length of the extended capabilities 5505 * @iftype_ext_capab: array of extended capabilities per interface type 5506 * @num_iftype_ext_capab: number of interface types for which extended 5507 * capabilities are specified separately. 5508 * @coalesce: packet coalescing support information 5509 * 5510 * @vendor_commands: array of vendor commands supported by the hardware 5511 * @n_vendor_commands: number of vendor commands 5512 * @vendor_events: array of vendor events supported by the hardware 5513 * @n_vendor_events: number of vendor events 5514 * 5515 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode 5516 * (including P2P GO) or 0 to indicate no such limit is advertised. The 5517 * driver is allowed to advertise a theoretical limit that it can reach in 5518 * some cases, but may not always reach. 5519 * 5520 * @max_num_csa_counters: Number of supported csa_counters in beacons 5521 * and probe responses. This value should be set if the driver 5522 * wishes to limit the number of csa counters. Default (0) means 5523 * infinite. 5524 * @bss_select_support: bitmask indicating the BSS selection criteria supported 5525 * by the driver in the .connect() callback. The bit position maps to the 5526 * attribute indices defined in &enum nl80211_bss_select_attr. 5527 * 5528 * @nan_supported_bands: bands supported by the device in NAN mode, a 5529 * bitmap of &enum nl80211_band values. For instance, for 5530 * NL80211_BAND_2GHZ, bit 0 would be set 5531 * (i.e. BIT(NL80211_BAND_2GHZ)). 5532 * 5533 * @txq_limit: configuration of internal TX queue frame limit 5534 * @txq_memory_limit: configuration internal TX queue memory limit 5535 * @txq_quantum: configuration of internal TX queue scheduler quantum 5536 * 5537 * @tx_queue_len: allow setting transmit queue len for drivers not using 5538 * wake_tx_queue 5539 * 5540 * @support_mbssid: can HW support association with nontransmitted AP 5541 * @support_only_he_mbssid: don't parse MBSSID elements if it is not 5542 * HE AP, in order to avoid compatibility issues. 5543 * @support_mbssid must be set for this to have any effect. 5544 * 5545 * @pmsr_capa: peer measurement capabilities 5546 * 5547 * @tid_config_support: describes the per-TID config support that the 5548 * device has 5549 * @tid_config_support.vif: bitmap of attributes (configurations) 5550 * supported by the driver for each vif 5551 * @tid_config_support.peer: bitmap of attributes (configurations) 5552 * supported by the driver for each peer 5553 * @tid_config_support.max_retry: maximum supported retry count for 5554 * long/short retry configuration 5555 * 5556 * @max_data_retry_count: maximum supported per TID retry count for 5557 * configuration through the %NL80211_TID_CONFIG_ATTR_RETRY_SHORT and 5558 * %NL80211_TID_CONFIG_ATTR_RETRY_LONG attributes 5559 * @sar_capa: SAR control capabilities 5560 * @rfkill: a pointer to the rfkill structure 5561 * 5562 * @mbssid_max_interfaces: maximum number of interfaces supported by the driver 5563 * in a multiple BSSID set. This field must be set to a non-zero value 5564 * by the driver to advertise MBSSID support. 5565 * @ema_max_profile_periodicity: maximum profile periodicity supported by 5566 * the driver. Setting this field to a non-zero value indicates that the 5567 * driver supports enhanced multi-BSSID advertisements (EMA AP). 5568 * @max_num_akm_suites: maximum number of AKM suites allowed for 5569 * configuration through %NL80211_CMD_CONNECT, %NL80211_CMD_ASSOCIATE and 5570 * %NL80211_CMD_START_AP. Set to NL80211_MAX_NR_AKM_SUITES if not set by 5571 * driver. If set by driver minimum allowed value is 5572 * NL80211_MAX_NR_AKM_SUITES in order to avoid compatibility issues with 5573 * legacy userspace and maximum allowed value is 5574 * CFG80211_MAX_NUM_AKM_SUITES. 5575 * 5576 * @hw_timestamp_max_peers: maximum number of peers that the driver supports 5577 * enabling HW timestamping for concurrently. Setting this field to a 5578 * non-zero value indicates that the driver supports HW timestamping. 5579 * A value of %CFG80211_HW_TIMESTAMP_ALL_PEERS indicates the driver 5580 * supports enabling HW timestamping for all peers (i.e. no need to 5581 * specify a mac address). 5582 */ 5583 struct wiphy { 5584 struct mutex mtx; 5585 5586 /* assign these fields before you register the wiphy */ 5587 5588 u8 perm_addr[ETH_ALEN]; 5589 u8 addr_mask[ETH_ALEN]; 5590 5591 struct mac_address *addresses; 5592 5593 const struct ieee80211_txrx_stypes *mgmt_stypes; 5594 5595 const struct ieee80211_iface_combination *iface_combinations; 5596 int n_iface_combinations; 5597 u16 software_iftypes; 5598 5599 u16 n_addresses; 5600 5601 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */ 5602 u16 interface_modes; 5603 5604 u16 max_acl_mac_addrs; 5605 5606 u32 flags, regulatory_flags, features; 5607 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)]; 5608 5609 u32 ap_sme_capa; 5610 5611 enum cfg80211_signal_type signal_type; 5612 5613 int bss_priv_size; 5614 u8 max_scan_ssids; 5615 u8 max_sched_scan_reqs; 5616 u8 max_sched_scan_ssids; 5617 u8 max_match_sets; 5618 u16 max_scan_ie_len; 5619 u16 max_sched_scan_ie_len; 5620 u32 max_sched_scan_plans; 5621 u32 max_sched_scan_plan_interval; 5622 u32 max_sched_scan_plan_iterations; 5623 5624 int n_cipher_suites; 5625 const u32 *cipher_suites; 5626 5627 int n_akm_suites; 5628 const u32 *akm_suites; 5629 5630 const struct wiphy_iftype_akm_suites *iftype_akm_suites; 5631 unsigned int num_iftype_akm_suites; 5632 5633 u8 retry_short; 5634 u8 retry_long; 5635 u32 frag_threshold; 5636 u32 rts_threshold; 5637 u8 coverage_class; 5638 5639 char fw_version[ETHTOOL_FWVERS_LEN]; 5640 u32 hw_version; 5641 5642 #ifdef CONFIG_PM 5643 const struct wiphy_wowlan_support *wowlan; 5644 struct cfg80211_wowlan *wowlan_config; 5645 #endif 5646 5647 u16 max_remain_on_channel_duration; 5648 5649 u8 max_num_pmkids; 5650 5651 u32 available_antennas_tx; 5652 u32 available_antennas_rx; 5653 5654 u32 probe_resp_offload; 5655 5656 const u8 *extended_capabilities, *extended_capabilities_mask; 5657 u8 extended_capabilities_len; 5658 5659 const struct wiphy_iftype_ext_capab *iftype_ext_capab; 5660 unsigned int num_iftype_ext_capab; 5661 5662 const void *privid; 5663 5664 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS]; 5665 5666 void (*reg_notifier)(struct wiphy *wiphy, 5667 struct regulatory_request *request); 5668 5669 /* fields below are read-only, assigned by cfg80211 */ 5670 5671 const struct ieee80211_regdomain __rcu *regd; 5672 5673 struct device dev; 5674 5675 bool registered; 5676 5677 struct dentry *debugfsdir; 5678 5679 const struct ieee80211_ht_cap *ht_capa_mod_mask; 5680 const struct ieee80211_vht_cap *vht_capa_mod_mask; 5681 5682 struct list_head wdev_list; 5683 5684 possible_net_t _net; 5685 5686 #ifdef CONFIG_CFG80211_WEXT 5687 const struct iw_handler_def *wext; 5688 #endif 5689 5690 const struct wiphy_coalesce_support *coalesce; 5691 5692 const struct wiphy_vendor_command *vendor_commands; 5693 const struct nl80211_vendor_cmd_info *vendor_events; 5694 int n_vendor_commands, n_vendor_events; 5695 5696 u16 max_ap_assoc_sta; 5697 5698 u8 max_num_csa_counters; 5699 5700 u32 bss_select_support; 5701 5702 u8 nan_supported_bands; 5703 5704 u32 txq_limit; 5705 u32 txq_memory_limit; 5706 u32 txq_quantum; 5707 5708 unsigned long tx_queue_len; 5709 5710 u8 support_mbssid:1, 5711 support_only_he_mbssid:1; 5712 5713 const struct cfg80211_pmsr_capabilities *pmsr_capa; 5714 5715 struct { 5716 u64 peer, vif; 5717 u8 max_retry; 5718 } tid_config_support; 5719 5720 u8 max_data_retry_count; 5721 5722 const struct cfg80211_sar_capa *sar_capa; 5723 5724 struct rfkill *rfkill; 5725 5726 u8 mbssid_max_interfaces; 5727 u8 ema_max_profile_periodicity; 5728 u16 max_num_akm_suites; 5729 5730 u16 hw_timestamp_max_peers; 5731 5732 char priv[] __aligned(NETDEV_ALIGN); 5733 }; 5734 5735 static inline struct net *wiphy_net(struct wiphy *wiphy) 5736 { 5737 return read_pnet(&wiphy->_net); 5738 } 5739 5740 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net) 5741 { 5742 write_pnet(&wiphy->_net, net); 5743 } 5744 5745 /** 5746 * wiphy_priv - return priv from wiphy 5747 * 5748 * @wiphy: the wiphy whose priv pointer to return 5749 * Return: The priv of @wiphy. 5750 */ 5751 static inline void *wiphy_priv(struct wiphy *wiphy) 5752 { 5753 BUG_ON(!wiphy); 5754 return &wiphy->priv; 5755 } 5756 5757 /** 5758 * priv_to_wiphy - return the wiphy containing the priv 5759 * 5760 * @priv: a pointer previously returned by wiphy_priv 5761 * Return: The wiphy of @priv. 5762 */ 5763 static inline struct wiphy *priv_to_wiphy(void *priv) 5764 { 5765 BUG_ON(!priv); 5766 return container_of(priv, struct wiphy, priv); 5767 } 5768 5769 /** 5770 * set_wiphy_dev - set device pointer for wiphy 5771 * 5772 * @wiphy: The wiphy whose device to bind 5773 * @dev: The device to parent it to 5774 */ 5775 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev) 5776 { 5777 wiphy->dev.parent = dev; 5778 } 5779 5780 /** 5781 * wiphy_dev - get wiphy dev pointer 5782 * 5783 * @wiphy: The wiphy whose device struct to look up 5784 * Return: The dev of @wiphy. 5785 */ 5786 static inline struct device *wiphy_dev(struct wiphy *wiphy) 5787 { 5788 return wiphy->dev.parent; 5789 } 5790 5791 /** 5792 * wiphy_name - get wiphy name 5793 * 5794 * @wiphy: The wiphy whose name to return 5795 * Return: The name of @wiphy. 5796 */ 5797 static inline const char *wiphy_name(const struct wiphy *wiphy) 5798 { 5799 return dev_name(&wiphy->dev); 5800 } 5801 5802 /** 5803 * wiphy_new_nm - create a new wiphy for use with cfg80211 5804 * 5805 * @ops: The configuration operations for this device 5806 * @sizeof_priv: The size of the private area to allocate 5807 * @requested_name: Request a particular name. 5808 * NULL is valid value, and means use the default phy%d naming. 5809 * 5810 * Create a new wiphy and associate the given operations with it. 5811 * @sizeof_priv bytes are allocated for private use. 5812 * 5813 * Return: A pointer to the new wiphy. This pointer must be 5814 * assigned to each netdev's ieee80211_ptr for proper operation. 5815 */ 5816 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv, 5817 const char *requested_name); 5818 5819 /** 5820 * wiphy_new - create a new wiphy for use with cfg80211 5821 * 5822 * @ops: The configuration operations for this device 5823 * @sizeof_priv: The size of the private area to allocate 5824 * 5825 * Create a new wiphy and associate the given operations with it. 5826 * @sizeof_priv bytes are allocated for private use. 5827 * 5828 * Return: A pointer to the new wiphy. This pointer must be 5829 * assigned to each netdev's ieee80211_ptr for proper operation. 5830 */ 5831 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops, 5832 int sizeof_priv) 5833 { 5834 return wiphy_new_nm(ops, sizeof_priv, NULL); 5835 } 5836 5837 /** 5838 * wiphy_register - register a wiphy with cfg80211 5839 * 5840 * @wiphy: The wiphy to register. 5841 * 5842 * Return: A non-negative wiphy index or a negative error code. 5843 */ 5844 int wiphy_register(struct wiphy *wiphy); 5845 5846 /* this is a define for better error reporting (file/line) */ 5847 #define lockdep_assert_wiphy(wiphy) lockdep_assert_held(&(wiphy)->mtx) 5848 5849 /** 5850 * rcu_dereference_wiphy - rcu_dereference with debug checking 5851 * @wiphy: the wiphy to check the locking on 5852 * @p: The pointer to read, prior to dereferencing 5853 * 5854 * Do an rcu_dereference(p), but check caller either holds rcu_read_lock() 5855 * or RTNL. Note: Please prefer wiphy_dereference() or rcu_dereference(). 5856 */ 5857 #define rcu_dereference_wiphy(wiphy, p) \ 5858 rcu_dereference_check(p, lockdep_is_held(&wiphy->mtx)) 5859 5860 /** 5861 * wiphy_dereference - fetch RCU pointer when updates are prevented by wiphy mtx 5862 * @wiphy: the wiphy to check the locking on 5863 * @p: The pointer to read, prior to dereferencing 5864 * 5865 * Return the value of the specified RCU-protected pointer, but omit the 5866 * READ_ONCE(), because caller holds the wiphy mutex used for updates. 5867 */ 5868 #define wiphy_dereference(wiphy, p) \ 5869 rcu_dereference_protected(p, lockdep_is_held(&wiphy->mtx)) 5870 5871 /** 5872 * get_wiphy_regdom - get custom regdomain for the given wiphy 5873 * @wiphy: the wiphy to get the regdomain from 5874 */ 5875 const struct ieee80211_regdomain *get_wiphy_regdom(struct wiphy *wiphy); 5876 5877 /** 5878 * wiphy_unregister - deregister a wiphy from cfg80211 5879 * 5880 * @wiphy: The wiphy to unregister. 5881 * 5882 * After this call, no more requests can be made with this priv 5883 * pointer, but the call may sleep to wait for an outstanding 5884 * request that is being handled. 5885 */ 5886 void wiphy_unregister(struct wiphy *wiphy); 5887 5888 /** 5889 * wiphy_free - free wiphy 5890 * 5891 * @wiphy: The wiphy to free 5892 */ 5893 void wiphy_free(struct wiphy *wiphy); 5894 5895 /* internal structs */ 5896 struct cfg80211_conn; 5897 struct cfg80211_internal_bss; 5898 struct cfg80211_cached_keys; 5899 struct cfg80211_cqm_config; 5900 5901 /** 5902 * wiphy_lock - lock the wiphy 5903 * @wiphy: the wiphy to lock 5904 * 5905 * This is needed around registering and unregistering netdevs that 5906 * aren't created through cfg80211 calls, since that requires locking 5907 * in cfg80211 when the notifiers is called, but that cannot 5908 * differentiate which way it's called. 5909 * 5910 * It can also be used by drivers for their own purposes. 5911 * 5912 * When cfg80211 ops are called, the wiphy is already locked. 5913 * 5914 * Note that this makes sure that no workers that have been queued 5915 * with wiphy_queue_work() are running. 5916 */ 5917 static inline void wiphy_lock(struct wiphy *wiphy) 5918 __acquires(&wiphy->mtx) 5919 { 5920 mutex_lock(&wiphy->mtx); 5921 __acquire(&wiphy->mtx); 5922 } 5923 5924 /** 5925 * wiphy_unlock - unlock the wiphy again 5926 * @wiphy: the wiphy to unlock 5927 */ 5928 static inline void wiphy_unlock(struct wiphy *wiphy) 5929 __releases(&wiphy->mtx) 5930 { 5931 __release(&wiphy->mtx); 5932 mutex_unlock(&wiphy->mtx); 5933 } 5934 5935 struct wiphy_work; 5936 typedef void (*wiphy_work_func_t)(struct wiphy *, struct wiphy_work *); 5937 5938 struct wiphy_work { 5939 struct list_head entry; 5940 wiphy_work_func_t func; 5941 }; 5942 5943 static inline void wiphy_work_init(struct wiphy_work *work, 5944 wiphy_work_func_t func) 5945 { 5946 INIT_LIST_HEAD(&work->entry); 5947 work->func = func; 5948 } 5949 5950 /** 5951 * wiphy_work_queue - queue work for the wiphy 5952 * @wiphy: the wiphy to queue for 5953 * @work: the work item 5954 * 5955 * This is useful for work that must be done asynchronously, and work 5956 * queued here has the special property that the wiphy mutex will be 5957 * held as if wiphy_lock() was called, and that it cannot be running 5958 * after wiphy_lock() was called. Therefore, wiphy_cancel_work() can 5959 * use just cancel_work() instead of cancel_work_sync(), it requires 5960 * being in a section protected by wiphy_lock(). 5961 */ 5962 void wiphy_work_queue(struct wiphy *wiphy, struct wiphy_work *work); 5963 5964 /** 5965 * wiphy_work_cancel - cancel previously queued work 5966 * @wiphy: the wiphy, for debug purposes 5967 * @work: the work to cancel 5968 * 5969 * Cancel the work *without* waiting for it, this assumes being 5970 * called under the wiphy mutex acquired by wiphy_lock(). 5971 */ 5972 void wiphy_work_cancel(struct wiphy *wiphy, struct wiphy_work *work); 5973 5974 /** 5975 * wiphy_work_flush - flush previously queued work 5976 * @wiphy: the wiphy, for debug purposes 5977 * @work: the work to flush, this can be %NULL to flush all work 5978 * 5979 * Flush the work (i.e. run it if pending). This must be called 5980 * under the wiphy mutex acquired by wiphy_lock(). 5981 */ 5982 void wiphy_work_flush(struct wiphy *wiphy, struct wiphy_work *work); 5983 5984 struct wiphy_delayed_work { 5985 struct wiphy_work work; 5986 struct wiphy *wiphy; 5987 struct timer_list timer; 5988 }; 5989 5990 void wiphy_delayed_work_timer(struct timer_list *t); 5991 5992 static inline void wiphy_delayed_work_init(struct wiphy_delayed_work *dwork, 5993 wiphy_work_func_t func) 5994 { 5995 timer_setup(&dwork->timer, wiphy_delayed_work_timer, 0); 5996 wiphy_work_init(&dwork->work, func); 5997 } 5998 5999 /** 6000 * wiphy_delayed_work_queue - queue delayed work for the wiphy 6001 * @wiphy: the wiphy to queue for 6002 * @dwork: the delayable worker 6003 * @delay: number of jiffies to wait before queueing 6004 * 6005 * This is useful for work that must be done asynchronously, and work 6006 * queued here has the special property that the wiphy mutex will be 6007 * held as if wiphy_lock() was called, and that it cannot be running 6008 * after wiphy_lock() was called. Therefore, wiphy_cancel_work() can 6009 * use just cancel_work() instead of cancel_work_sync(), it requires 6010 * being in a section protected by wiphy_lock(). 6011 */ 6012 void wiphy_delayed_work_queue(struct wiphy *wiphy, 6013 struct wiphy_delayed_work *dwork, 6014 unsigned long delay); 6015 6016 /** 6017 * wiphy_delayed_work_cancel - cancel previously queued delayed work 6018 * @wiphy: the wiphy, for debug purposes 6019 * @dwork: the delayed work to cancel 6020 * 6021 * Cancel the work *without* waiting for it, this assumes being 6022 * called under the wiphy mutex acquired by wiphy_lock(). 6023 */ 6024 void wiphy_delayed_work_cancel(struct wiphy *wiphy, 6025 struct wiphy_delayed_work *dwork); 6026 6027 /** 6028 * wiphy_delayed_work_flush - flush previously queued delayed work 6029 * @wiphy: the wiphy, for debug purposes 6030 * @dwork: the delayed work to flush 6031 * 6032 * Flush the work (i.e. run it if pending). This must be called 6033 * under the wiphy mutex acquired by wiphy_lock(). 6034 */ 6035 void wiphy_delayed_work_flush(struct wiphy *wiphy, 6036 struct wiphy_delayed_work *dwork); 6037 6038 /** 6039 * struct wireless_dev - wireless device state 6040 * 6041 * For netdevs, this structure must be allocated by the driver 6042 * that uses the ieee80211_ptr field in struct net_device (this 6043 * is intentional so it can be allocated along with the netdev.) 6044 * It need not be registered then as netdev registration will 6045 * be intercepted by cfg80211 to see the new wireless device, 6046 * however, drivers must lock the wiphy before registering or 6047 * unregistering netdevs if they pre-create any netdevs (in ops 6048 * called from cfg80211, the wiphy is already locked.) 6049 * 6050 * For non-netdev uses, it must also be allocated by the driver 6051 * in response to the cfg80211 callbacks that require it, as 6052 * there's no netdev registration in that case it may not be 6053 * allocated outside of callback operations that return it. 6054 * 6055 * @wiphy: pointer to hardware description 6056 * @iftype: interface type 6057 * @registered: is this wdev already registered with cfg80211 6058 * @registering: indicates we're doing registration under wiphy lock 6059 * for the notifier 6060 * @list: (private) Used to collect the interfaces 6061 * @netdev: (private) Used to reference back to the netdev, may be %NULL 6062 * @identifier: (private) Identifier used in nl80211 to identify this 6063 * wireless device if it has no netdev 6064 * @u: union containing data specific to @iftype 6065 * @connected: indicates if connected or not (STA mode) 6066 * @bssid: (private) Used by the internal configuration code 6067 * @wext: (private) Used by the internal wireless extensions compat code 6068 * @wext.ibss: (private) IBSS data part of wext handling 6069 * @wext.connect: (private) connection handling data 6070 * @wext.keys: (private) (WEP) key data 6071 * @wext.ie: (private) extra elements for association 6072 * @wext.ie_len: (private) length of extra elements 6073 * @wext.bssid: (private) selected network BSSID 6074 * @wext.ssid: (private) selected network SSID 6075 * @wext.default_key: (private) selected default key index 6076 * @wext.default_mgmt_key: (private) selected default management key index 6077 * @wext.prev_bssid: (private) previous BSSID for reassociation 6078 * @wext.prev_bssid_valid: (private) previous BSSID validity 6079 * @use_4addr: indicates 4addr mode is used on this interface, must be 6080 * set by driver (if supported) on add_interface BEFORE registering the 6081 * netdev and may otherwise be used by driver read-only, will be update 6082 * by cfg80211 on change_interface 6083 * @mgmt_registrations: list of registrations for management frames 6084 * @mgmt_registrations_need_update: mgmt registrations were updated, 6085 * need to propagate the update to the driver 6086 * @beacon_interval: beacon interval used on this device for transmitting 6087 * beacons, 0 when not valid 6088 * @address: The address for this device, valid only if @netdev is %NULL 6089 * @is_running: true if this is a non-netdev device that has been started, e.g. 6090 * the P2P Device. 6091 * @cac_started: true if DFS channel availability check has been started 6092 * @cac_start_time: timestamp (jiffies) when the dfs state was entered. 6093 * @cac_time_ms: CAC time in ms 6094 * @ps: powersave mode is enabled 6095 * @ps_timeout: dynamic powersave timeout 6096 * @ap_unexpected_nlportid: (private) netlink port ID of application 6097 * registered for unexpected class 3 frames (AP mode) 6098 * @conn: (private) cfg80211 software SME connection state machine data 6099 * @connect_keys: (private) keys to set after connection is established 6100 * @conn_bss_type: connecting/connected BSS type 6101 * @conn_owner_nlportid: (private) connection owner socket port ID 6102 * @disconnect_wk: (private) auto-disconnect work 6103 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect 6104 * @event_list: (private) list for internal event processing 6105 * @event_lock: (private) lock for event list 6106 * @owner_nlportid: (private) owner socket port ID 6107 * @nl_owner_dead: (private) owner socket went away 6108 * @cqm_rssi_work: (private) CQM RSSI reporting work 6109 * @cqm_config: (private) nl80211 RSSI monitor state 6110 * @pmsr_list: (private) peer measurement requests 6111 * @pmsr_lock: (private) peer measurements requests/results lock 6112 * @pmsr_free_wk: (private) peer measurements cleanup work 6113 * @unprot_beacon_reported: (private) timestamp of last 6114 * unprotected beacon report 6115 * @links: array of %IEEE80211_MLD_MAX_NUM_LINKS elements containing @addr 6116 * @ap and @client for each link 6117 * @valid_links: bitmap describing what elements of @links are valid 6118 */ 6119 struct wireless_dev { 6120 struct wiphy *wiphy; 6121 enum nl80211_iftype iftype; 6122 6123 /* the remainder of this struct should be private to cfg80211 */ 6124 struct list_head list; 6125 struct net_device *netdev; 6126 6127 u32 identifier; 6128 6129 struct list_head mgmt_registrations; 6130 u8 mgmt_registrations_need_update:1; 6131 6132 bool use_4addr, is_running, registered, registering; 6133 6134 u8 address[ETH_ALEN] __aligned(sizeof(u16)); 6135 6136 /* currently used for IBSS and SME - might be rearranged later */ 6137 struct cfg80211_conn *conn; 6138 struct cfg80211_cached_keys *connect_keys; 6139 enum ieee80211_bss_type conn_bss_type; 6140 u32 conn_owner_nlportid; 6141 6142 struct work_struct disconnect_wk; 6143 u8 disconnect_bssid[ETH_ALEN]; 6144 6145 struct list_head event_list; 6146 spinlock_t event_lock; 6147 6148 u8 connected:1; 6149 6150 bool ps; 6151 int ps_timeout; 6152 6153 u32 ap_unexpected_nlportid; 6154 6155 u32 owner_nlportid; 6156 bool nl_owner_dead; 6157 6158 /* FIXME: need to rework radar detection for MLO */ 6159 bool cac_started; 6160 unsigned long cac_start_time; 6161 unsigned int cac_time_ms; 6162 6163 #ifdef CONFIG_CFG80211_WEXT 6164 /* wext data */ 6165 struct { 6166 struct cfg80211_ibss_params ibss; 6167 struct cfg80211_connect_params connect; 6168 struct cfg80211_cached_keys *keys; 6169 const u8 *ie; 6170 size_t ie_len; 6171 u8 bssid[ETH_ALEN]; 6172 u8 prev_bssid[ETH_ALEN]; 6173 u8 ssid[IEEE80211_MAX_SSID_LEN]; 6174 s8 default_key, default_mgmt_key; 6175 bool prev_bssid_valid; 6176 } wext; 6177 #endif 6178 6179 struct wiphy_work cqm_rssi_work; 6180 struct cfg80211_cqm_config __rcu *cqm_config; 6181 6182 struct list_head pmsr_list; 6183 spinlock_t pmsr_lock; 6184 struct work_struct pmsr_free_wk; 6185 6186 unsigned long unprot_beacon_reported; 6187 6188 union { 6189 struct { 6190 u8 connected_addr[ETH_ALEN] __aligned(2); 6191 u8 ssid[IEEE80211_MAX_SSID_LEN]; 6192 u8 ssid_len; 6193 } client; 6194 struct { 6195 int beacon_interval; 6196 struct cfg80211_chan_def preset_chandef; 6197 struct cfg80211_chan_def chandef; 6198 u8 id[IEEE80211_MAX_SSID_LEN]; 6199 u8 id_len, id_up_len; 6200 } mesh; 6201 struct { 6202 struct cfg80211_chan_def preset_chandef; 6203 u8 ssid[IEEE80211_MAX_SSID_LEN]; 6204 u8 ssid_len; 6205 } ap; 6206 struct { 6207 struct cfg80211_internal_bss *current_bss; 6208 struct cfg80211_chan_def chandef; 6209 int beacon_interval; 6210 u8 ssid[IEEE80211_MAX_SSID_LEN]; 6211 u8 ssid_len; 6212 } ibss; 6213 struct { 6214 struct cfg80211_chan_def chandef; 6215 } ocb; 6216 } u; 6217 6218 struct { 6219 u8 addr[ETH_ALEN] __aligned(2); 6220 union { 6221 struct { 6222 unsigned int beacon_interval; 6223 struct cfg80211_chan_def chandef; 6224 } ap; 6225 struct { 6226 struct cfg80211_internal_bss *current_bss; 6227 } client; 6228 }; 6229 } links[IEEE80211_MLD_MAX_NUM_LINKS]; 6230 u16 valid_links; 6231 }; 6232 6233 static inline const u8 *wdev_address(struct wireless_dev *wdev) 6234 { 6235 if (wdev->netdev) 6236 return wdev->netdev->dev_addr; 6237 return wdev->address; 6238 } 6239 6240 static inline bool wdev_running(struct wireless_dev *wdev) 6241 { 6242 if (wdev->netdev) 6243 return netif_running(wdev->netdev); 6244 return wdev->is_running; 6245 } 6246 6247 /** 6248 * wdev_priv - return wiphy priv from wireless_dev 6249 * 6250 * @wdev: The wireless device whose wiphy's priv pointer to return 6251 * Return: The wiphy priv of @wdev. 6252 */ 6253 static inline void *wdev_priv(struct wireless_dev *wdev) 6254 { 6255 BUG_ON(!wdev); 6256 return wiphy_priv(wdev->wiphy); 6257 } 6258 6259 /** 6260 * wdev_chandef - return chandef pointer from wireless_dev 6261 * @wdev: the wdev 6262 * @link_id: the link ID for MLO 6263 * 6264 * Return: The chandef depending on the mode, or %NULL. 6265 */ 6266 struct cfg80211_chan_def *wdev_chandef(struct wireless_dev *wdev, 6267 unsigned int link_id); 6268 6269 static inline void WARN_INVALID_LINK_ID(struct wireless_dev *wdev, 6270 unsigned int link_id) 6271 { 6272 WARN_ON(link_id && !wdev->valid_links); 6273 WARN_ON(wdev->valid_links && 6274 !(wdev->valid_links & BIT(link_id))); 6275 } 6276 6277 #define for_each_valid_link(link_info, link_id) \ 6278 for (link_id = 0; \ 6279 link_id < ((link_info)->valid_links ? \ 6280 ARRAY_SIZE((link_info)->links) : 1); \ 6281 link_id++) \ 6282 if (!(link_info)->valid_links || \ 6283 ((link_info)->valid_links & BIT(link_id))) 6284 6285 /** 6286 * DOC: Utility functions 6287 * 6288 * cfg80211 offers a number of utility functions that can be useful. 6289 */ 6290 6291 /** 6292 * ieee80211_channel_equal - compare two struct ieee80211_channel 6293 * 6294 * @a: 1st struct ieee80211_channel 6295 * @b: 2nd struct ieee80211_channel 6296 * Return: true if center frequency of @a == @b 6297 */ 6298 static inline bool 6299 ieee80211_channel_equal(struct ieee80211_channel *a, 6300 struct ieee80211_channel *b) 6301 { 6302 return (a->center_freq == b->center_freq && 6303 a->freq_offset == b->freq_offset); 6304 } 6305 6306 /** 6307 * ieee80211_channel_to_khz - convert ieee80211_channel to frequency in KHz 6308 * @chan: struct ieee80211_channel to convert 6309 * Return: The corresponding frequency (in KHz) 6310 */ 6311 static inline u32 6312 ieee80211_channel_to_khz(const struct ieee80211_channel *chan) 6313 { 6314 return MHZ_TO_KHZ(chan->center_freq) + chan->freq_offset; 6315 } 6316 6317 /** 6318 * ieee80211_s1g_channel_width - get allowed channel width from @chan 6319 * 6320 * Only allowed for band NL80211_BAND_S1GHZ 6321 * @chan: channel 6322 * Return: The allowed channel width for this center_freq 6323 */ 6324 enum nl80211_chan_width 6325 ieee80211_s1g_channel_width(const struct ieee80211_channel *chan); 6326 6327 /** 6328 * ieee80211_channel_to_freq_khz - convert channel number to frequency 6329 * @chan: channel number 6330 * @band: band, necessary due to channel number overlap 6331 * Return: The corresponding frequency (in KHz), or 0 if the conversion failed. 6332 */ 6333 u32 ieee80211_channel_to_freq_khz(int chan, enum nl80211_band band); 6334 6335 /** 6336 * ieee80211_channel_to_frequency - convert channel number to frequency 6337 * @chan: channel number 6338 * @band: band, necessary due to channel number overlap 6339 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed. 6340 */ 6341 static inline int 6342 ieee80211_channel_to_frequency(int chan, enum nl80211_band band) 6343 { 6344 return KHZ_TO_MHZ(ieee80211_channel_to_freq_khz(chan, band)); 6345 } 6346 6347 /** 6348 * ieee80211_freq_khz_to_channel - convert frequency to channel number 6349 * @freq: center frequency in KHz 6350 * Return: The corresponding channel, or 0 if the conversion failed. 6351 */ 6352 int ieee80211_freq_khz_to_channel(u32 freq); 6353 6354 /** 6355 * ieee80211_frequency_to_channel - convert frequency to channel number 6356 * @freq: center frequency in MHz 6357 * Return: The corresponding channel, or 0 if the conversion failed. 6358 */ 6359 static inline int 6360 ieee80211_frequency_to_channel(int freq) 6361 { 6362 return ieee80211_freq_khz_to_channel(MHZ_TO_KHZ(freq)); 6363 } 6364 6365 /** 6366 * ieee80211_get_channel_khz - get channel struct from wiphy for specified 6367 * frequency 6368 * @wiphy: the struct wiphy to get the channel for 6369 * @freq: the center frequency (in KHz) of the channel 6370 * Return: The channel struct from @wiphy at @freq. 6371 */ 6372 struct ieee80211_channel * 6373 ieee80211_get_channel_khz(struct wiphy *wiphy, u32 freq); 6374 6375 /** 6376 * ieee80211_get_channel - get channel struct from wiphy for specified frequency 6377 * 6378 * @wiphy: the struct wiphy to get the channel for 6379 * @freq: the center frequency (in MHz) of the channel 6380 * Return: The channel struct from @wiphy at @freq. 6381 */ 6382 static inline struct ieee80211_channel * 6383 ieee80211_get_channel(struct wiphy *wiphy, int freq) 6384 { 6385 return ieee80211_get_channel_khz(wiphy, MHZ_TO_KHZ(freq)); 6386 } 6387 6388 /** 6389 * cfg80211_channel_is_psc - Check if the channel is a 6 GHz PSC 6390 * @chan: control channel to check 6391 * 6392 * The Preferred Scanning Channels (PSC) are defined in 6393 * Draft IEEE P802.11ax/D5.0, 26.17.2.3.3 6394 */ 6395 static inline bool cfg80211_channel_is_psc(struct ieee80211_channel *chan) 6396 { 6397 if (chan->band != NL80211_BAND_6GHZ) 6398 return false; 6399 6400 return ieee80211_frequency_to_channel(chan->center_freq) % 16 == 5; 6401 } 6402 6403 /** 6404 * ieee80211_get_response_rate - get basic rate for a given rate 6405 * 6406 * @sband: the band to look for rates in 6407 * @basic_rates: bitmap of basic rates 6408 * @bitrate: the bitrate for which to find the basic rate 6409 * 6410 * Return: The basic rate corresponding to a given bitrate, that 6411 * is the next lower bitrate contained in the basic rate map, 6412 * which is, for this function, given as a bitmap of indices of 6413 * rates in the band's bitrate table. 6414 */ 6415 const struct ieee80211_rate * 6416 ieee80211_get_response_rate(struct ieee80211_supported_band *sband, 6417 u32 basic_rates, int bitrate); 6418 6419 /** 6420 * ieee80211_mandatory_rates - get mandatory rates for a given band 6421 * @sband: the band to look for rates in 6422 * 6423 * This function returns a bitmap of the mandatory rates for the given 6424 * band, bits are set according to the rate position in the bitrates array. 6425 */ 6426 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband); 6427 6428 /* 6429 * Radiotap parsing functions -- for controlled injection support 6430 * 6431 * Implemented in net/wireless/radiotap.c 6432 * Documentation in Documentation/networking/radiotap-headers.rst 6433 */ 6434 6435 struct radiotap_align_size { 6436 uint8_t align:4, size:4; 6437 }; 6438 6439 struct ieee80211_radiotap_namespace { 6440 const struct radiotap_align_size *align_size; 6441 int n_bits; 6442 uint32_t oui; 6443 uint8_t subns; 6444 }; 6445 6446 struct ieee80211_radiotap_vendor_namespaces { 6447 const struct ieee80211_radiotap_namespace *ns; 6448 int n_ns; 6449 }; 6450 6451 /** 6452 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args 6453 * @this_arg_index: index of current arg, valid after each successful call 6454 * to ieee80211_radiotap_iterator_next() 6455 * @this_arg: pointer to current radiotap arg; it is valid after each 6456 * call to ieee80211_radiotap_iterator_next() but also after 6457 * ieee80211_radiotap_iterator_init() where it will point to 6458 * the beginning of the actual data portion 6459 * @this_arg_size: length of the current arg, for convenience 6460 * @current_namespace: pointer to the current namespace definition 6461 * (or internally %NULL if the current namespace is unknown) 6462 * @is_radiotap_ns: indicates whether the current namespace is the default 6463 * radiotap namespace or not 6464 * 6465 * @_rtheader: pointer to the radiotap header we are walking through 6466 * @_max_length: length of radiotap header in cpu byte ordering 6467 * @_arg_index: next argument index 6468 * @_arg: next argument pointer 6469 * @_next_bitmap: internal pointer to next present u32 6470 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present 6471 * @_vns: vendor namespace definitions 6472 * @_next_ns_data: beginning of the next namespace's data 6473 * @_reset_on_ext: internal; reset the arg index to 0 when going to the 6474 * next bitmap word 6475 * 6476 * Describes the radiotap parser state. Fields prefixed with an underscore 6477 * must not be used by users of the parser, only by the parser internally. 6478 */ 6479 6480 struct ieee80211_radiotap_iterator { 6481 struct ieee80211_radiotap_header *_rtheader; 6482 const struct ieee80211_radiotap_vendor_namespaces *_vns; 6483 const struct ieee80211_radiotap_namespace *current_namespace; 6484 6485 unsigned char *_arg, *_next_ns_data; 6486 __le32 *_next_bitmap; 6487 6488 unsigned char *this_arg; 6489 int this_arg_index; 6490 int this_arg_size; 6491 6492 int is_radiotap_ns; 6493 6494 int _max_length; 6495 int _arg_index; 6496 uint32_t _bitmap_shifter; 6497 int _reset_on_ext; 6498 }; 6499 6500 int 6501 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator, 6502 struct ieee80211_radiotap_header *radiotap_header, 6503 int max_length, 6504 const struct ieee80211_radiotap_vendor_namespaces *vns); 6505 6506 int 6507 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator); 6508 6509 6510 extern const unsigned char rfc1042_header[6]; 6511 extern const unsigned char bridge_tunnel_header[6]; 6512 6513 /** 6514 * ieee80211_get_hdrlen_from_skb - get header length from data 6515 * 6516 * @skb: the frame 6517 * 6518 * Given an skb with a raw 802.11 header at the data pointer this function 6519 * returns the 802.11 header length. 6520 * 6521 * Return: The 802.11 header length in bytes (not including encryption 6522 * headers). Or 0 if the data in the sk_buff is too short to contain a valid 6523 * 802.11 header. 6524 */ 6525 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb); 6526 6527 /** 6528 * ieee80211_hdrlen - get header length in bytes from frame control 6529 * @fc: frame control field in little-endian format 6530 * Return: The header length in bytes. 6531 */ 6532 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc); 6533 6534 /** 6535 * ieee80211_get_mesh_hdrlen - get mesh extension header length 6536 * @meshhdr: the mesh extension header, only the flags field 6537 * (first byte) will be accessed 6538 * Return: The length of the extension header, which is always at 6539 * least 6 bytes and at most 18 if address 5 and 6 are present. 6540 */ 6541 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr); 6542 6543 /** 6544 * DOC: Data path helpers 6545 * 6546 * In addition to generic utilities, cfg80211 also offers 6547 * functions that help implement the data path for devices 6548 * that do not do the 802.11/802.3 conversion on the device. 6549 */ 6550 6551 /** 6552 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3 6553 * @skb: the 802.11 data frame 6554 * @ehdr: pointer to a &struct ethhdr that will get the header, instead 6555 * of it being pushed into the SKB 6556 * @addr: the device MAC address 6557 * @iftype: the virtual interface type 6558 * @data_offset: offset of payload after the 802.11 header 6559 * @is_amsdu: true if the 802.11 header is A-MSDU 6560 * Return: 0 on success. Non-zero on error. 6561 */ 6562 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr, 6563 const u8 *addr, enum nl80211_iftype iftype, 6564 u8 data_offset, bool is_amsdu); 6565 6566 /** 6567 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3 6568 * @skb: the 802.11 data frame 6569 * @addr: the device MAC address 6570 * @iftype: the virtual interface type 6571 * Return: 0 on success. Non-zero on error. 6572 */ 6573 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr, 6574 enum nl80211_iftype iftype) 6575 { 6576 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0, false); 6577 } 6578 6579 /** 6580 * ieee80211_is_valid_amsdu - check if subframe lengths of an A-MSDU are valid 6581 * 6582 * This is used to detect non-standard A-MSDU frames, e.g. the ones generated 6583 * by ath10k and ath11k, where the subframe length includes the length of the 6584 * mesh control field. 6585 * 6586 * @skb: The input A-MSDU frame without any headers. 6587 * @mesh_hdr: the type of mesh header to test 6588 * 0: non-mesh A-MSDU length field 6589 * 1: big-endian mesh A-MSDU length field 6590 * 2: little-endian mesh A-MSDU length field 6591 * Returns: true if subframe header lengths are valid for the @mesh_hdr mode 6592 */ 6593 bool ieee80211_is_valid_amsdu(struct sk_buff *skb, u8 mesh_hdr); 6594 6595 /** 6596 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame 6597 * 6598 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames. 6599 * The @list will be empty if the decode fails. The @skb must be fully 6600 * header-less before being passed in here; it is freed in this function. 6601 * 6602 * @skb: The input A-MSDU frame without any headers. 6603 * @list: The output list of 802.3 frames. It must be allocated and 6604 * initialized by the caller. 6605 * @addr: The device MAC address. 6606 * @iftype: The device interface type. 6607 * @extra_headroom: The hardware extra headroom for SKBs in the @list. 6608 * @check_da: DA to check in the inner ethernet header, or NULL 6609 * @check_sa: SA to check in the inner ethernet header, or NULL 6610 * @mesh_control: see mesh_hdr in ieee80211_is_valid_amsdu 6611 */ 6612 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list, 6613 const u8 *addr, enum nl80211_iftype iftype, 6614 const unsigned int extra_headroom, 6615 const u8 *check_da, const u8 *check_sa, 6616 u8 mesh_control); 6617 6618 /** 6619 * ieee80211_get_8023_tunnel_proto - get RFC1042 or bridge tunnel encap protocol 6620 * 6621 * Check for RFC1042 or bridge tunnel header and fetch the encapsulated 6622 * protocol. 6623 * 6624 * @hdr: pointer to the MSDU payload 6625 * @proto: destination pointer to store the protocol 6626 * Return: true if encapsulation was found 6627 */ 6628 bool ieee80211_get_8023_tunnel_proto(const void *hdr, __be16 *proto); 6629 6630 /** 6631 * ieee80211_strip_8023_mesh_hdr - strip mesh header from converted 802.3 frames 6632 * 6633 * Strip the mesh header, which was left in by ieee80211_data_to_8023 as part 6634 * of the MSDU data. Also move any source/destination addresses from the mesh 6635 * header to the ethernet header (if present). 6636 * 6637 * @skb: The 802.3 frame with embedded mesh header 6638 */ 6639 int ieee80211_strip_8023_mesh_hdr(struct sk_buff *skb); 6640 6641 /** 6642 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame 6643 * @skb: the data frame 6644 * @qos_map: Interworking QoS mapping or %NULL if not in use 6645 * Return: The 802.1p/1d tag. 6646 */ 6647 unsigned int cfg80211_classify8021d(struct sk_buff *skb, 6648 struct cfg80211_qos_map *qos_map); 6649 6650 /** 6651 * cfg80211_find_elem_match - match information element and byte array in data 6652 * 6653 * @eid: element ID 6654 * @ies: data consisting of IEs 6655 * @len: length of data 6656 * @match: byte array to match 6657 * @match_len: number of bytes in the match array 6658 * @match_offset: offset in the IE data where the byte array should match. 6659 * Note the difference to cfg80211_find_ie_match() which considers 6660 * the offset to start from the element ID byte, but here we take 6661 * the data portion instead. 6662 * 6663 * Return: %NULL if the element ID could not be found or if 6664 * the element is invalid (claims to be longer than the given 6665 * data) or if the byte array doesn't match; otherwise return the 6666 * requested element struct. 6667 * 6668 * Note: There are no checks on the element length other than 6669 * having to fit into the given data and being large enough for the 6670 * byte array to match. 6671 */ 6672 const struct element * 6673 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len, 6674 const u8 *match, unsigned int match_len, 6675 unsigned int match_offset); 6676 6677 /** 6678 * cfg80211_find_ie_match - match information element and byte array in data 6679 * 6680 * @eid: element ID 6681 * @ies: data consisting of IEs 6682 * @len: length of data 6683 * @match: byte array to match 6684 * @match_len: number of bytes in the match array 6685 * @match_offset: offset in the IE where the byte array should match. 6686 * If match_len is zero, this must also be set to zero. 6687 * Otherwise this must be set to 2 or more, because the first 6688 * byte is the element id, which is already compared to eid, and 6689 * the second byte is the IE length. 6690 * 6691 * Return: %NULL if the element ID could not be found or if 6692 * the element is invalid (claims to be longer than the given 6693 * data) or if the byte array doesn't match, or a pointer to the first 6694 * byte of the requested element, that is the byte containing the 6695 * element ID. 6696 * 6697 * Note: There are no checks on the element length other than 6698 * having to fit into the given data and being large enough for the 6699 * byte array to match. 6700 */ 6701 static inline const u8 * 6702 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len, 6703 const u8 *match, unsigned int match_len, 6704 unsigned int match_offset) 6705 { 6706 /* match_offset can't be smaller than 2, unless match_len is 6707 * zero, in which case match_offset must be zero as well. 6708 */ 6709 if (WARN_ON((match_len && match_offset < 2) || 6710 (!match_len && match_offset))) 6711 return NULL; 6712 6713 return (const void *)cfg80211_find_elem_match(eid, ies, len, 6714 match, match_len, 6715 match_offset ? 6716 match_offset - 2 : 0); 6717 } 6718 6719 /** 6720 * cfg80211_find_elem - find information element in data 6721 * 6722 * @eid: element ID 6723 * @ies: data consisting of IEs 6724 * @len: length of data 6725 * 6726 * Return: %NULL if the element ID could not be found or if 6727 * the element is invalid (claims to be longer than the given 6728 * data) or if the byte array doesn't match; otherwise return the 6729 * requested element struct. 6730 * 6731 * Note: There are no checks on the element length other than 6732 * having to fit into the given data. 6733 */ 6734 static inline const struct element * 6735 cfg80211_find_elem(u8 eid, const u8 *ies, int len) 6736 { 6737 return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0); 6738 } 6739 6740 /** 6741 * cfg80211_find_ie - find information element in data 6742 * 6743 * @eid: element ID 6744 * @ies: data consisting of IEs 6745 * @len: length of data 6746 * 6747 * Return: %NULL if the element ID could not be found or if 6748 * the element is invalid (claims to be longer than the given 6749 * data), or a pointer to the first byte of the requested 6750 * element, that is the byte containing the element ID. 6751 * 6752 * Note: There are no checks on the element length other than 6753 * having to fit into the given data. 6754 */ 6755 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len) 6756 { 6757 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0); 6758 } 6759 6760 /** 6761 * cfg80211_find_ext_elem - find information element with EID Extension in data 6762 * 6763 * @ext_eid: element ID Extension 6764 * @ies: data consisting of IEs 6765 * @len: length of data 6766 * 6767 * Return: %NULL if the extended element could not be found or if 6768 * the element is invalid (claims to be longer than the given 6769 * data) or if the byte array doesn't match; otherwise return the 6770 * requested element struct. 6771 * 6772 * Note: There are no checks on the element length other than 6773 * having to fit into the given data. 6774 */ 6775 static inline const struct element * 6776 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len) 6777 { 6778 return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len, 6779 &ext_eid, 1, 0); 6780 } 6781 6782 /** 6783 * cfg80211_find_ext_ie - find information element with EID Extension in data 6784 * 6785 * @ext_eid: element ID Extension 6786 * @ies: data consisting of IEs 6787 * @len: length of data 6788 * 6789 * Return: %NULL if the extended element ID could not be found or if 6790 * the element is invalid (claims to be longer than the given 6791 * data), or a pointer to the first byte of the requested 6792 * element, that is the byte containing the element ID. 6793 * 6794 * Note: There are no checks on the element length other than 6795 * having to fit into the given data. 6796 */ 6797 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len) 6798 { 6799 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len, 6800 &ext_eid, 1, 2); 6801 } 6802 6803 /** 6804 * cfg80211_find_vendor_elem - find vendor specific information element in data 6805 * 6806 * @oui: vendor OUI 6807 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any 6808 * @ies: data consisting of IEs 6809 * @len: length of data 6810 * 6811 * Return: %NULL if the vendor specific element ID could not be found or if the 6812 * element is invalid (claims to be longer than the given data); otherwise 6813 * return the element structure for the requested element. 6814 * 6815 * Note: There are no checks on the element length other than having to fit into 6816 * the given data. 6817 */ 6818 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type, 6819 const u8 *ies, 6820 unsigned int len); 6821 6822 /** 6823 * cfg80211_find_vendor_ie - find vendor specific information element in data 6824 * 6825 * @oui: vendor OUI 6826 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any 6827 * @ies: data consisting of IEs 6828 * @len: length of data 6829 * 6830 * Return: %NULL if the vendor specific element ID could not be found or if the 6831 * element is invalid (claims to be longer than the given data), or a pointer to 6832 * the first byte of the requested element, that is the byte containing the 6833 * element ID. 6834 * 6835 * Note: There are no checks on the element length other than having to fit into 6836 * the given data. 6837 */ 6838 static inline const u8 * 6839 cfg80211_find_vendor_ie(unsigned int oui, int oui_type, 6840 const u8 *ies, unsigned int len) 6841 { 6842 return (const void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len); 6843 } 6844 6845 /** 6846 * cfg80211_defragment_element - Defrag the given element data into a buffer 6847 * 6848 * @elem: the element to defragment 6849 * @ies: elements where @elem is contained 6850 * @ieslen: length of @ies 6851 * @data: buffer to store element data 6852 * @data_len: length of @data 6853 * @frag_id: the element ID of fragments 6854 * 6855 * Return: length of @data, or -EINVAL on error 6856 * 6857 * Copy out all data from an element that may be fragmented into @data, while 6858 * skipping all headers. 6859 * 6860 * The function uses memmove() internally. It is acceptable to defragment an 6861 * element in-place. 6862 */ 6863 ssize_t cfg80211_defragment_element(const struct element *elem, const u8 *ies, 6864 size_t ieslen, u8 *data, size_t data_len, 6865 u8 frag_id); 6866 6867 /** 6868 * cfg80211_send_layer2_update - send layer 2 update frame 6869 * 6870 * @dev: network device 6871 * @addr: STA MAC address 6872 * 6873 * Wireless drivers can use this function to update forwarding tables in bridge 6874 * devices upon STA association. 6875 */ 6876 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr); 6877 6878 /** 6879 * DOC: Regulatory enforcement infrastructure 6880 * 6881 * TODO 6882 */ 6883 6884 /** 6885 * regulatory_hint - driver hint to the wireless core a regulatory domain 6886 * @wiphy: the wireless device giving the hint (used only for reporting 6887 * conflicts) 6888 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain 6889 * should be in. If @rd is set this should be NULL. Note that if you 6890 * set this to NULL you should still set rd->alpha2 to some accepted 6891 * alpha2. 6892 * 6893 * Wireless drivers can use this function to hint to the wireless core 6894 * what it believes should be the current regulatory domain by 6895 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory 6896 * domain should be in or by providing a completely build regulatory domain. 6897 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried 6898 * for a regulatory domain structure for the respective country. 6899 * 6900 * The wiphy must have been registered to cfg80211 prior to this call. 6901 * For cfg80211 drivers this means you must first use wiphy_register(), 6902 * for mac80211 drivers you must first use ieee80211_register_hw(). 6903 * 6904 * Drivers should check the return value, its possible you can get 6905 * an -ENOMEM. 6906 * 6907 * Return: 0 on success. -ENOMEM. 6908 */ 6909 int regulatory_hint(struct wiphy *wiphy, const char *alpha2); 6910 6911 /** 6912 * regulatory_set_wiphy_regd - set regdom info for self managed drivers 6913 * @wiphy: the wireless device we want to process the regulatory domain on 6914 * @rd: the regulatory domain information to use for this wiphy 6915 * 6916 * Set the regulatory domain information for self-managed wiphys, only they 6917 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more 6918 * information. 6919 * 6920 * Return: 0 on success. -EINVAL, -EPERM 6921 */ 6922 int regulatory_set_wiphy_regd(struct wiphy *wiphy, 6923 struct ieee80211_regdomain *rd); 6924 6925 /** 6926 * regulatory_set_wiphy_regd_sync - set regdom for self-managed drivers 6927 * @wiphy: the wireless device we want to process the regulatory domain on 6928 * @rd: the regulatory domain information to use for this wiphy 6929 * 6930 * This functions requires the RTNL and the wiphy mutex to be held and 6931 * applies the new regdomain synchronously to this wiphy. For more details 6932 * see regulatory_set_wiphy_regd(). 6933 * 6934 * Return: 0 on success. -EINVAL, -EPERM 6935 */ 6936 int regulatory_set_wiphy_regd_sync(struct wiphy *wiphy, 6937 struct ieee80211_regdomain *rd); 6938 6939 /** 6940 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain 6941 * @wiphy: the wireless device we want to process the regulatory domain on 6942 * @regd: the custom regulatory domain to use for this wiphy 6943 * 6944 * Drivers can sometimes have custom regulatory domains which do not apply 6945 * to a specific country. Drivers can use this to apply such custom regulatory 6946 * domains. This routine must be called prior to wiphy registration. The 6947 * custom regulatory domain will be trusted completely and as such previous 6948 * default channel settings will be disregarded. If no rule is found for a 6949 * channel on the regulatory domain the channel will be disabled. 6950 * Drivers using this for a wiphy should also set the wiphy flag 6951 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy 6952 * that called this helper. 6953 */ 6954 void wiphy_apply_custom_regulatory(struct wiphy *wiphy, 6955 const struct ieee80211_regdomain *regd); 6956 6957 /** 6958 * freq_reg_info - get regulatory information for the given frequency 6959 * @wiphy: the wiphy for which we want to process this rule for 6960 * @center_freq: Frequency in KHz for which we want regulatory information for 6961 * 6962 * Use this function to get the regulatory rule for a specific frequency on 6963 * a given wireless device. If the device has a specific regulatory domain 6964 * it wants to follow we respect that unless a country IE has been received 6965 * and processed already. 6966 * 6967 * Return: A valid pointer, or, when an error occurs, for example if no rule 6968 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to 6969 * check and PTR_ERR() to obtain the numeric return value. The numeric return 6970 * value will be -ERANGE if we determine the given center_freq does not even 6971 * have a regulatory rule for a frequency range in the center_freq's band. 6972 * See freq_in_rule_band() for our current definition of a band -- this is 6973 * purely subjective and right now it's 802.11 specific. 6974 */ 6975 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy, 6976 u32 center_freq); 6977 6978 /** 6979 * reg_initiator_name - map regulatory request initiator enum to name 6980 * @initiator: the regulatory request initiator 6981 * 6982 * You can use this to map the regulatory request initiator enum to a 6983 * proper string representation. 6984 */ 6985 const char *reg_initiator_name(enum nl80211_reg_initiator initiator); 6986 6987 /** 6988 * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom 6989 * @wiphy: wiphy for which pre-CAC capability is checked. 6990 * 6991 * Pre-CAC is allowed only in some regdomains (notable ETSI). 6992 */ 6993 bool regulatory_pre_cac_allowed(struct wiphy *wiphy); 6994 6995 /** 6996 * DOC: Internal regulatory db functions 6997 * 6998 */ 6999 7000 /** 7001 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule 7002 * Regulatory self-managed driver can use it to proactively 7003 * 7004 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried. 7005 * @freq: the frequency (in MHz) to be queried. 7006 * @rule: pointer to store the wmm rule from the regulatory db. 7007 * 7008 * Self-managed wireless drivers can use this function to query 7009 * the internal regulatory database to check whether the given 7010 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations. 7011 * 7012 * Drivers should check the return value, its possible you can get 7013 * an -ENODATA. 7014 * 7015 * Return: 0 on success. -ENODATA. 7016 */ 7017 int reg_query_regdb_wmm(char *alpha2, int freq, 7018 struct ieee80211_reg_rule *rule); 7019 7020 /* 7021 * callbacks for asynchronous cfg80211 methods, notification 7022 * functions and BSS handling helpers 7023 */ 7024 7025 /** 7026 * cfg80211_scan_done - notify that scan finished 7027 * 7028 * @request: the corresponding scan request 7029 * @info: information about the completed scan 7030 */ 7031 void cfg80211_scan_done(struct cfg80211_scan_request *request, 7032 struct cfg80211_scan_info *info); 7033 7034 /** 7035 * cfg80211_sched_scan_results - notify that new scan results are available 7036 * 7037 * @wiphy: the wiphy which got scheduled scan results 7038 * @reqid: identifier for the related scheduled scan request 7039 */ 7040 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid); 7041 7042 /** 7043 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped 7044 * 7045 * @wiphy: the wiphy on which the scheduled scan stopped 7046 * @reqid: identifier for the related scheduled scan request 7047 * 7048 * The driver can call this function to inform cfg80211 that the 7049 * scheduled scan had to be stopped, for whatever reason. The driver 7050 * is then called back via the sched_scan_stop operation when done. 7051 */ 7052 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid); 7053 7054 /** 7055 * cfg80211_sched_scan_stopped_locked - notify that the scheduled scan has stopped 7056 * 7057 * @wiphy: the wiphy on which the scheduled scan stopped 7058 * @reqid: identifier for the related scheduled scan request 7059 * 7060 * The driver can call this function to inform cfg80211 that the 7061 * scheduled scan had to be stopped, for whatever reason. The driver 7062 * is then called back via the sched_scan_stop operation when done. 7063 * This function should be called with the wiphy mutex held. 7064 */ 7065 void cfg80211_sched_scan_stopped_locked(struct wiphy *wiphy, u64 reqid); 7066 7067 /** 7068 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame 7069 * @wiphy: the wiphy reporting the BSS 7070 * @data: the BSS metadata 7071 * @mgmt: the management frame (probe response or beacon) 7072 * @len: length of the management frame 7073 * @gfp: context flags 7074 * 7075 * This informs cfg80211 that BSS information was found and 7076 * the BSS should be updated/added. 7077 * 7078 * Return: A referenced struct, must be released with cfg80211_put_bss()! 7079 * Or %NULL on error. 7080 */ 7081 struct cfg80211_bss * __must_check 7082 cfg80211_inform_bss_frame_data(struct wiphy *wiphy, 7083 struct cfg80211_inform_bss *data, 7084 struct ieee80211_mgmt *mgmt, size_t len, 7085 gfp_t gfp); 7086 7087 static inline struct cfg80211_bss * __must_check 7088 cfg80211_inform_bss_frame(struct wiphy *wiphy, 7089 struct ieee80211_channel *rx_channel, 7090 struct ieee80211_mgmt *mgmt, size_t len, 7091 s32 signal, gfp_t gfp) 7092 { 7093 struct cfg80211_inform_bss data = { 7094 .chan = rx_channel, 7095 .signal = signal, 7096 }; 7097 7098 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp); 7099 } 7100 7101 /** 7102 * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID 7103 * @bssid: transmitter BSSID 7104 * @max_bssid: max BSSID indicator, taken from Multiple BSSID element 7105 * @mbssid_index: BSSID index, taken from Multiple BSSID index element 7106 * @new_bssid: calculated nontransmitted BSSID 7107 */ 7108 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid, 7109 u8 mbssid_index, u8 *new_bssid) 7110 { 7111 u64 bssid_u64 = ether_addr_to_u64(bssid); 7112 u64 mask = GENMASK_ULL(max_bssid - 1, 0); 7113 u64 new_bssid_u64; 7114 7115 new_bssid_u64 = bssid_u64 & ~mask; 7116 7117 new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask; 7118 7119 u64_to_ether_addr(new_bssid_u64, new_bssid); 7120 } 7121 7122 /** 7123 * cfg80211_is_element_inherited - returns if element ID should be inherited 7124 * @element: element to check 7125 * @non_inherit_element: non inheritance element 7126 */ 7127 bool cfg80211_is_element_inherited(const struct element *element, 7128 const struct element *non_inherit_element); 7129 7130 /** 7131 * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs 7132 * @ie: ies 7133 * @ielen: length of IEs 7134 * @mbssid_elem: current MBSSID element 7135 * @sub_elem: current MBSSID subelement (profile) 7136 * @merged_ie: location of the merged profile 7137 * @max_copy_len: max merged profile length 7138 */ 7139 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen, 7140 const struct element *mbssid_elem, 7141 const struct element *sub_elem, 7142 u8 *merged_ie, size_t max_copy_len); 7143 7144 /** 7145 * enum cfg80211_bss_frame_type - frame type that the BSS data came from 7146 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is 7147 * from a beacon or probe response 7148 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon 7149 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response 7150 */ 7151 enum cfg80211_bss_frame_type { 7152 CFG80211_BSS_FTYPE_UNKNOWN, 7153 CFG80211_BSS_FTYPE_BEACON, 7154 CFG80211_BSS_FTYPE_PRESP, 7155 }; 7156 7157 /** 7158 * cfg80211_get_ies_channel_number - returns the channel number from ies 7159 * @ie: IEs 7160 * @ielen: length of IEs 7161 * @band: enum nl80211_band of the channel 7162 * 7163 * Returns the channel number, or -1 if none could be determined. 7164 */ 7165 int cfg80211_get_ies_channel_number(const u8 *ie, size_t ielen, 7166 enum nl80211_band band); 7167 7168 /** 7169 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS 7170 * 7171 * @wiphy: the wiphy reporting the BSS 7172 * @data: the BSS metadata 7173 * @ftype: frame type (if known) 7174 * @bssid: the BSSID of the BSS 7175 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0) 7176 * @capability: the capability field sent by the peer 7177 * @beacon_interval: the beacon interval announced by the peer 7178 * @ie: additional IEs sent by the peer 7179 * @ielen: length of the additional IEs 7180 * @gfp: context flags 7181 * 7182 * This informs cfg80211 that BSS information was found and 7183 * the BSS should be updated/added. 7184 * 7185 * Return: A referenced struct, must be released with cfg80211_put_bss()! 7186 * Or %NULL on error. 7187 */ 7188 struct cfg80211_bss * __must_check 7189 cfg80211_inform_bss_data(struct wiphy *wiphy, 7190 struct cfg80211_inform_bss *data, 7191 enum cfg80211_bss_frame_type ftype, 7192 const u8 *bssid, u64 tsf, u16 capability, 7193 u16 beacon_interval, const u8 *ie, size_t ielen, 7194 gfp_t gfp); 7195 7196 static inline struct cfg80211_bss * __must_check 7197 cfg80211_inform_bss(struct wiphy *wiphy, 7198 struct ieee80211_channel *rx_channel, 7199 enum cfg80211_bss_frame_type ftype, 7200 const u8 *bssid, u64 tsf, u16 capability, 7201 u16 beacon_interval, const u8 *ie, size_t ielen, 7202 s32 signal, gfp_t gfp) 7203 { 7204 struct cfg80211_inform_bss data = { 7205 .chan = rx_channel, 7206 .signal = signal, 7207 }; 7208 7209 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf, 7210 capability, beacon_interval, ie, ielen, 7211 gfp); 7212 } 7213 7214 /** 7215 * __cfg80211_get_bss - get a BSS reference 7216 * @wiphy: the wiphy this BSS struct belongs to 7217 * @channel: the channel to search on (or %NULL) 7218 * @bssid: the desired BSSID (or %NULL) 7219 * @ssid: the desired SSID (or %NULL) 7220 * @ssid_len: length of the SSID (or 0) 7221 * @bss_type: type of BSS, see &enum ieee80211_bss_type 7222 * @privacy: privacy filter, see &enum ieee80211_privacy 7223 * @use_for: indicates which use is intended 7224 */ 7225 struct cfg80211_bss *__cfg80211_get_bss(struct wiphy *wiphy, 7226 struct ieee80211_channel *channel, 7227 const u8 *bssid, 7228 const u8 *ssid, size_t ssid_len, 7229 enum ieee80211_bss_type bss_type, 7230 enum ieee80211_privacy privacy, 7231 u32 use_for); 7232 7233 /** 7234 * cfg80211_get_bss - get a BSS reference 7235 * @wiphy: the wiphy this BSS struct belongs to 7236 * @channel: the channel to search on (or %NULL) 7237 * @bssid: the desired BSSID (or %NULL) 7238 * @ssid: the desired SSID (or %NULL) 7239 * @ssid_len: length of the SSID (or 0) 7240 * @bss_type: type of BSS, see &enum ieee80211_bss_type 7241 * @privacy: privacy filter, see &enum ieee80211_privacy 7242 * 7243 * This version implies regular usage, %NL80211_BSS_USE_FOR_NORMAL. 7244 */ 7245 static inline struct cfg80211_bss * 7246 cfg80211_get_bss(struct wiphy *wiphy, struct ieee80211_channel *channel, 7247 const u8 *bssid, const u8 *ssid, size_t ssid_len, 7248 enum ieee80211_bss_type bss_type, 7249 enum ieee80211_privacy privacy) 7250 { 7251 return __cfg80211_get_bss(wiphy, channel, bssid, ssid, ssid_len, 7252 bss_type, privacy, 7253 NL80211_BSS_USE_FOR_NORMAL); 7254 } 7255 7256 static inline struct cfg80211_bss * 7257 cfg80211_get_ibss(struct wiphy *wiphy, 7258 struct ieee80211_channel *channel, 7259 const u8 *ssid, size_t ssid_len) 7260 { 7261 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len, 7262 IEEE80211_BSS_TYPE_IBSS, 7263 IEEE80211_PRIVACY_ANY); 7264 } 7265 7266 /** 7267 * cfg80211_ref_bss - reference BSS struct 7268 * @wiphy: the wiphy this BSS struct belongs to 7269 * @bss: the BSS struct to reference 7270 * 7271 * Increments the refcount of the given BSS struct. 7272 */ 7273 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss); 7274 7275 /** 7276 * cfg80211_put_bss - unref BSS struct 7277 * @wiphy: the wiphy this BSS struct belongs to 7278 * @bss: the BSS struct 7279 * 7280 * Decrements the refcount of the given BSS struct. 7281 */ 7282 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss); 7283 7284 /** 7285 * cfg80211_unlink_bss - unlink BSS from internal data structures 7286 * @wiphy: the wiphy 7287 * @bss: the bss to remove 7288 * 7289 * This function removes the given BSS from the internal data structures 7290 * thereby making it no longer show up in scan results etc. Use this 7291 * function when you detect a BSS is gone. Normally BSSes will also time 7292 * out, so it is not necessary to use this function at all. 7293 */ 7294 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss); 7295 7296 /** 7297 * cfg80211_bss_iter - iterate all BSS entries 7298 * 7299 * This function iterates over the BSS entries associated with the given wiphy 7300 * and calls the callback for the iterated BSS. The iterator function is not 7301 * allowed to call functions that might modify the internal state of the BSS DB. 7302 * 7303 * @wiphy: the wiphy 7304 * @chandef: if given, the iterator function will be called only if the channel 7305 * of the currently iterated BSS is a subset of the given channel. 7306 * @iter: the iterator function to call 7307 * @iter_data: an argument to the iterator function 7308 */ 7309 void cfg80211_bss_iter(struct wiphy *wiphy, 7310 struct cfg80211_chan_def *chandef, 7311 void (*iter)(struct wiphy *wiphy, 7312 struct cfg80211_bss *bss, 7313 void *data), 7314 void *iter_data); 7315 7316 /** 7317 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame 7318 * @dev: network device 7319 * @buf: authentication frame (header + body) 7320 * @len: length of the frame data 7321 * 7322 * This function is called whenever an authentication, disassociation or 7323 * deauthentication frame has been received and processed in station mode. 7324 * After being asked to authenticate via cfg80211_ops::auth() the driver must 7325 * call either this function or cfg80211_auth_timeout(). 7326 * After being asked to associate via cfg80211_ops::assoc() the driver must 7327 * call either this function or cfg80211_auth_timeout(). 7328 * While connected, the driver must calls this for received and processed 7329 * disassociation and deauthentication frames. If the frame couldn't be used 7330 * because it was unprotected, the driver must call the function 7331 * cfg80211_rx_unprot_mlme_mgmt() instead. 7332 * 7333 * This function may sleep. The caller must hold the corresponding wdev's mutex. 7334 */ 7335 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len); 7336 7337 /** 7338 * cfg80211_auth_timeout - notification of timed out authentication 7339 * @dev: network device 7340 * @addr: The MAC address of the device with which the authentication timed out 7341 * 7342 * This function may sleep. The caller must hold the corresponding wdev's 7343 * mutex. 7344 */ 7345 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr); 7346 7347 /** 7348 * struct cfg80211_rx_assoc_resp_data - association response data 7349 * @bss: the BSS that association was requested with, ownership of the pointer 7350 * moves to cfg80211 in the call to cfg80211_rx_assoc_resp() 7351 * @buf: (Re)Association Response frame (header + body) 7352 * @len: length of the frame data 7353 * @uapsd_queues: bitmap of queues configured for uapsd. Same format 7354 * as the AC bitmap in the QoS info field 7355 * @req_ies: information elements from the (Re)Association Request frame 7356 * @req_ies_len: length of req_ies data 7357 * @ap_mld_addr: AP MLD address (in case of MLO) 7358 * @links: per-link information indexed by link ID, use links[0] for 7359 * non-MLO connections 7360 * @links.status: Set this (along with a BSS pointer) for links that 7361 * were rejected by the AP. 7362 */ 7363 struct cfg80211_rx_assoc_resp_data { 7364 const u8 *buf; 7365 size_t len; 7366 const u8 *req_ies; 7367 size_t req_ies_len; 7368 int uapsd_queues; 7369 const u8 *ap_mld_addr; 7370 struct { 7371 u8 addr[ETH_ALEN] __aligned(2); 7372 struct cfg80211_bss *bss; 7373 u16 status; 7374 } links[IEEE80211_MLD_MAX_NUM_LINKS]; 7375 }; 7376 7377 /** 7378 * cfg80211_rx_assoc_resp - notification of processed association response 7379 * @dev: network device 7380 * @data: association response data, &struct cfg80211_rx_assoc_resp_data 7381 * 7382 * After being asked to associate via cfg80211_ops::assoc() the driver must 7383 * call either this function or cfg80211_auth_timeout(). 7384 * 7385 * This function may sleep. The caller must hold the corresponding wdev's mutex. 7386 */ 7387 void cfg80211_rx_assoc_resp(struct net_device *dev, 7388 const struct cfg80211_rx_assoc_resp_data *data); 7389 7390 /** 7391 * struct cfg80211_assoc_failure - association failure data 7392 * @ap_mld_addr: AP MLD address, or %NULL 7393 * @bss: list of BSSes, must use entry 0 for non-MLO connections 7394 * (@ap_mld_addr is %NULL) 7395 * @timeout: indicates the association failed due to timeout, otherwise 7396 * the association was abandoned for a reason reported through some 7397 * other API (e.g. deauth RX) 7398 */ 7399 struct cfg80211_assoc_failure { 7400 const u8 *ap_mld_addr; 7401 struct cfg80211_bss *bss[IEEE80211_MLD_MAX_NUM_LINKS]; 7402 bool timeout; 7403 }; 7404 7405 /** 7406 * cfg80211_assoc_failure - notification of association failure 7407 * @dev: network device 7408 * @data: data describing the association failure 7409 * 7410 * This function may sleep. The caller must hold the corresponding wdev's mutex. 7411 */ 7412 void cfg80211_assoc_failure(struct net_device *dev, 7413 struct cfg80211_assoc_failure *data); 7414 7415 /** 7416 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame 7417 * @dev: network device 7418 * @buf: 802.11 frame (header + body) 7419 * @len: length of the frame data 7420 * @reconnect: immediate reconnect is desired (include the nl80211 attribute) 7421 * 7422 * This function is called whenever deauthentication has been processed in 7423 * station mode. This includes both received deauthentication frames and 7424 * locally generated ones. This function may sleep. The caller must hold the 7425 * corresponding wdev's mutex. 7426 */ 7427 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len, 7428 bool reconnect); 7429 7430 /** 7431 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame 7432 * @dev: network device 7433 * @buf: received management frame (header + body) 7434 * @len: length of the frame data 7435 * 7436 * This function is called whenever a received deauthentication or dissassoc 7437 * frame has been dropped in station mode because of MFP being used but the 7438 * frame was not protected. This is also used to notify reception of a Beacon 7439 * frame that was dropped because it did not include a valid MME MIC while 7440 * beacon protection was enabled (BIGTK configured in station mode). 7441 * 7442 * This function may sleep. 7443 */ 7444 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev, 7445 const u8 *buf, size_t len); 7446 7447 /** 7448 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP) 7449 * @dev: network device 7450 * @addr: The source MAC address of the frame 7451 * @key_type: The key type that the received frame used 7452 * @key_id: Key identifier (0..3). Can be -1 if missing. 7453 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets) 7454 * @gfp: allocation flags 7455 * 7456 * This function is called whenever the local MAC detects a MIC failure in a 7457 * received frame. This matches with MLME-MICHAELMICFAILURE.indication() 7458 * primitive. 7459 */ 7460 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr, 7461 enum nl80211_key_type key_type, int key_id, 7462 const u8 *tsc, gfp_t gfp); 7463 7464 /** 7465 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS 7466 * 7467 * @dev: network device 7468 * @bssid: the BSSID of the IBSS joined 7469 * @channel: the channel of the IBSS joined 7470 * @gfp: allocation flags 7471 * 7472 * This function notifies cfg80211 that the device joined an IBSS or 7473 * switched to a different BSSID. Before this function can be called, 7474 * either a beacon has to have been received from the IBSS, or one of 7475 * the cfg80211_inform_bss{,_frame} functions must have been called 7476 * with the locally generated beacon -- this guarantees that there is 7477 * always a scan result for this IBSS. cfg80211 will handle the rest. 7478 */ 7479 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid, 7480 struct ieee80211_channel *channel, gfp_t gfp); 7481 7482 /** 7483 * cfg80211_notify_new_peer_candidate - notify cfg80211 of a new mesh peer 7484 * candidate 7485 * 7486 * @dev: network device 7487 * @macaddr: the MAC address of the new candidate 7488 * @ie: information elements advertised by the peer candidate 7489 * @ie_len: length of the information elements buffer 7490 * @sig_dbm: signal level in dBm 7491 * @gfp: allocation flags 7492 * 7493 * This function notifies cfg80211 that the mesh peer candidate has been 7494 * detected, most likely via a beacon or, less likely, via a probe response. 7495 * cfg80211 then sends a notification to userspace. 7496 */ 7497 void cfg80211_notify_new_peer_candidate(struct net_device *dev, 7498 const u8 *macaddr, const u8 *ie, u8 ie_len, 7499 int sig_dbm, gfp_t gfp); 7500 7501 /** 7502 * DOC: RFkill integration 7503 * 7504 * RFkill integration in cfg80211 is almost invisible to drivers, 7505 * as cfg80211 automatically registers an rfkill instance for each 7506 * wireless device it knows about. Soft kill is also translated 7507 * into disconnecting and turning all interfaces off. Drivers are 7508 * expected to turn off the device when all interfaces are down. 7509 * 7510 * However, devices may have a hard RFkill line, in which case they 7511 * also need to interact with the rfkill subsystem, via cfg80211. 7512 * They can do this with a few helper functions documented here. 7513 */ 7514 7515 /** 7516 * wiphy_rfkill_set_hw_state_reason - notify cfg80211 about hw block state 7517 * @wiphy: the wiphy 7518 * @blocked: block status 7519 * @reason: one of reasons in &enum rfkill_hard_block_reasons 7520 */ 7521 void wiphy_rfkill_set_hw_state_reason(struct wiphy *wiphy, bool blocked, 7522 enum rfkill_hard_block_reasons reason); 7523 7524 static inline void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked) 7525 { 7526 wiphy_rfkill_set_hw_state_reason(wiphy, blocked, 7527 RFKILL_HARD_BLOCK_SIGNAL); 7528 } 7529 7530 /** 7531 * wiphy_rfkill_start_polling - start polling rfkill 7532 * @wiphy: the wiphy 7533 */ 7534 void wiphy_rfkill_start_polling(struct wiphy *wiphy); 7535 7536 /** 7537 * wiphy_rfkill_stop_polling - stop polling rfkill 7538 * @wiphy: the wiphy 7539 */ 7540 static inline void wiphy_rfkill_stop_polling(struct wiphy *wiphy) 7541 { 7542 rfkill_pause_polling(wiphy->rfkill); 7543 } 7544 7545 /** 7546 * DOC: Vendor commands 7547 * 7548 * Occasionally, there are special protocol or firmware features that 7549 * can't be implemented very openly. For this and similar cases, the 7550 * vendor command functionality allows implementing the features with 7551 * (typically closed-source) userspace and firmware, using nl80211 as 7552 * the configuration mechanism. 7553 * 7554 * A driver supporting vendor commands must register them as an array 7555 * in struct wiphy, with handlers for each one. Each command has an 7556 * OUI and sub command ID to identify it. 7557 * 7558 * Note that this feature should not be (ab)used to implement protocol 7559 * features that could openly be shared across drivers. In particular, 7560 * it must never be required to use vendor commands to implement any 7561 * "normal" functionality that higher-level userspace like connection 7562 * managers etc. need. 7563 */ 7564 7565 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy, 7566 enum nl80211_commands cmd, 7567 enum nl80211_attrs attr, 7568 int approxlen); 7569 7570 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy, 7571 struct wireless_dev *wdev, 7572 enum nl80211_commands cmd, 7573 enum nl80211_attrs attr, 7574 unsigned int portid, 7575 int vendor_event_idx, 7576 int approxlen, gfp_t gfp); 7577 7578 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp); 7579 7580 /** 7581 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply 7582 * @wiphy: the wiphy 7583 * @approxlen: an upper bound of the length of the data that will 7584 * be put into the skb 7585 * 7586 * This function allocates and pre-fills an skb for a reply to 7587 * a vendor command. Since it is intended for a reply, calling 7588 * it outside of a vendor command's doit() operation is invalid. 7589 * 7590 * The returned skb is pre-filled with some identifying data in 7591 * a way that any data that is put into the skb (with skb_put(), 7592 * nla_put() or similar) will end up being within the 7593 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done 7594 * with the skb is adding data for the corresponding userspace tool 7595 * which can then read that data out of the vendor data attribute. 7596 * You must not modify the skb in any other way. 7597 * 7598 * When done, call cfg80211_vendor_cmd_reply() with the skb and return 7599 * its error code as the result of the doit() operation. 7600 * 7601 * Return: An allocated and pre-filled skb. %NULL if any errors happen. 7602 */ 7603 static inline struct sk_buff * 7604 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen) 7605 { 7606 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR, 7607 NL80211_ATTR_VENDOR_DATA, approxlen); 7608 } 7609 7610 /** 7611 * cfg80211_vendor_cmd_reply - send the reply skb 7612 * @skb: The skb, must have been allocated with 7613 * cfg80211_vendor_cmd_alloc_reply_skb() 7614 * 7615 * Since calling this function will usually be the last thing 7616 * before returning from the vendor command doit() you should 7617 * return the error code. Note that this function consumes the 7618 * skb regardless of the return value. 7619 * 7620 * Return: An error code or 0 on success. 7621 */ 7622 int cfg80211_vendor_cmd_reply(struct sk_buff *skb); 7623 7624 /** 7625 * cfg80211_vendor_cmd_get_sender - get the current sender netlink ID 7626 * @wiphy: the wiphy 7627 * 7628 * Return the current netlink port ID in a vendor command handler. 7629 * Valid to call only there. 7630 */ 7631 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy); 7632 7633 /** 7634 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb 7635 * @wiphy: the wiphy 7636 * @wdev: the wireless device 7637 * @event_idx: index of the vendor event in the wiphy's vendor_events 7638 * @approxlen: an upper bound of the length of the data that will 7639 * be put into the skb 7640 * @gfp: allocation flags 7641 * 7642 * This function allocates and pre-fills an skb for an event on the 7643 * vendor-specific multicast group. 7644 * 7645 * If wdev != NULL, both the ifindex and identifier of the specified 7646 * wireless device are added to the event message before the vendor data 7647 * attribute. 7648 * 7649 * When done filling the skb, call cfg80211_vendor_event() with the 7650 * skb to send the event. 7651 * 7652 * Return: An allocated and pre-filled skb. %NULL if any errors happen. 7653 */ 7654 static inline struct sk_buff * 7655 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev, 7656 int approxlen, int event_idx, gfp_t gfp) 7657 { 7658 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR, 7659 NL80211_ATTR_VENDOR_DATA, 7660 0, event_idx, approxlen, gfp); 7661 } 7662 7663 /** 7664 * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb 7665 * @wiphy: the wiphy 7666 * @wdev: the wireless device 7667 * @event_idx: index of the vendor event in the wiphy's vendor_events 7668 * @portid: port ID of the receiver 7669 * @approxlen: an upper bound of the length of the data that will 7670 * be put into the skb 7671 * @gfp: allocation flags 7672 * 7673 * This function allocates and pre-fills an skb for an event to send to 7674 * a specific (userland) socket. This socket would previously have been 7675 * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take 7676 * care to register a netlink notifier to see when the socket closes. 7677 * 7678 * If wdev != NULL, both the ifindex and identifier of the specified 7679 * wireless device are added to the event message before the vendor data 7680 * attribute. 7681 * 7682 * When done filling the skb, call cfg80211_vendor_event() with the 7683 * skb to send the event. 7684 * 7685 * Return: An allocated and pre-filled skb. %NULL if any errors happen. 7686 */ 7687 static inline struct sk_buff * 7688 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy, 7689 struct wireless_dev *wdev, 7690 unsigned int portid, int approxlen, 7691 int event_idx, gfp_t gfp) 7692 { 7693 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR, 7694 NL80211_ATTR_VENDOR_DATA, 7695 portid, event_idx, approxlen, gfp); 7696 } 7697 7698 /** 7699 * cfg80211_vendor_event - send the event 7700 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc() 7701 * @gfp: allocation flags 7702 * 7703 * This function sends the given @skb, which must have been allocated 7704 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it. 7705 */ 7706 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp) 7707 { 7708 __cfg80211_send_event_skb(skb, gfp); 7709 } 7710 7711 #ifdef CONFIG_NL80211_TESTMODE 7712 /** 7713 * DOC: Test mode 7714 * 7715 * Test mode is a set of utility functions to allow drivers to 7716 * interact with driver-specific tools to aid, for instance, 7717 * factory programming. 7718 * 7719 * This chapter describes how drivers interact with it. For more 7720 * information see the nl80211 book's chapter on it. 7721 */ 7722 7723 /** 7724 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply 7725 * @wiphy: the wiphy 7726 * @approxlen: an upper bound of the length of the data that will 7727 * be put into the skb 7728 * 7729 * This function allocates and pre-fills an skb for a reply to 7730 * the testmode command. Since it is intended for a reply, calling 7731 * it outside of the @testmode_cmd operation is invalid. 7732 * 7733 * The returned skb is pre-filled with the wiphy index and set up in 7734 * a way that any data that is put into the skb (with skb_put(), 7735 * nla_put() or similar) will end up being within the 7736 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done 7737 * with the skb is adding data for the corresponding userspace tool 7738 * which can then read that data out of the testdata attribute. You 7739 * must not modify the skb in any other way. 7740 * 7741 * When done, call cfg80211_testmode_reply() with the skb and return 7742 * its error code as the result of the @testmode_cmd operation. 7743 * 7744 * Return: An allocated and pre-filled skb. %NULL if any errors happen. 7745 */ 7746 static inline struct sk_buff * 7747 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen) 7748 { 7749 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE, 7750 NL80211_ATTR_TESTDATA, approxlen); 7751 } 7752 7753 /** 7754 * cfg80211_testmode_reply - send the reply skb 7755 * @skb: The skb, must have been allocated with 7756 * cfg80211_testmode_alloc_reply_skb() 7757 * 7758 * Since calling this function will usually be the last thing 7759 * before returning from the @testmode_cmd you should return 7760 * the error code. Note that this function consumes the skb 7761 * regardless of the return value. 7762 * 7763 * Return: An error code or 0 on success. 7764 */ 7765 static inline int cfg80211_testmode_reply(struct sk_buff *skb) 7766 { 7767 return cfg80211_vendor_cmd_reply(skb); 7768 } 7769 7770 /** 7771 * cfg80211_testmode_alloc_event_skb - allocate testmode event 7772 * @wiphy: the wiphy 7773 * @approxlen: an upper bound of the length of the data that will 7774 * be put into the skb 7775 * @gfp: allocation flags 7776 * 7777 * This function allocates and pre-fills an skb for an event on the 7778 * testmode multicast group. 7779 * 7780 * The returned skb is set up in the same way as with 7781 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As 7782 * there, you should simply add data to it that will then end up in the 7783 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb 7784 * in any other way. 7785 * 7786 * When done filling the skb, call cfg80211_testmode_event() with the 7787 * skb to send the event. 7788 * 7789 * Return: An allocated and pre-filled skb. %NULL if any errors happen. 7790 */ 7791 static inline struct sk_buff * 7792 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp) 7793 { 7794 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE, 7795 NL80211_ATTR_TESTDATA, 0, -1, 7796 approxlen, gfp); 7797 } 7798 7799 /** 7800 * cfg80211_testmode_event - send the event 7801 * @skb: The skb, must have been allocated with 7802 * cfg80211_testmode_alloc_event_skb() 7803 * @gfp: allocation flags 7804 * 7805 * This function sends the given @skb, which must have been allocated 7806 * by cfg80211_testmode_alloc_event_skb(), as an event. It always 7807 * consumes it. 7808 */ 7809 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp) 7810 { 7811 __cfg80211_send_event_skb(skb, gfp); 7812 } 7813 7814 #define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd), 7815 #define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd), 7816 #else 7817 #define CFG80211_TESTMODE_CMD(cmd) 7818 #define CFG80211_TESTMODE_DUMP(cmd) 7819 #endif 7820 7821 /** 7822 * struct cfg80211_fils_resp_params - FILS connection response params 7823 * @kek: KEK derived from a successful FILS connection (may be %NULL) 7824 * @kek_len: Length of @fils_kek in octets 7825 * @update_erp_next_seq_num: Boolean value to specify whether the value in 7826 * @erp_next_seq_num is valid. 7827 * @erp_next_seq_num: The next sequence number to use in ERP message in 7828 * FILS Authentication. This value should be specified irrespective of the 7829 * status for a FILS connection. 7830 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL). 7831 * @pmk_len: Length of @pmk in octets 7832 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID 7833 * used for this FILS connection (may be %NULL). 7834 */ 7835 struct cfg80211_fils_resp_params { 7836 const u8 *kek; 7837 size_t kek_len; 7838 bool update_erp_next_seq_num; 7839 u16 erp_next_seq_num; 7840 const u8 *pmk; 7841 size_t pmk_len; 7842 const u8 *pmkid; 7843 }; 7844 7845 /** 7846 * struct cfg80211_connect_resp_params - Connection response params 7847 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use 7848 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you 7849 * the real status code for failures. If this call is used to report a 7850 * failure due to a timeout (e.g., not receiving an Authentication frame 7851 * from the AP) instead of an explicit rejection by the AP, -1 is used to 7852 * indicate that this is a failure, but without a status code. 7853 * @timeout_reason is used to report the reason for the timeout in that 7854 * case. 7855 * @req_ie: Association request IEs (may be %NULL) 7856 * @req_ie_len: Association request IEs length 7857 * @resp_ie: Association response IEs (may be %NULL) 7858 * @resp_ie_len: Association response IEs length 7859 * @fils: FILS connection response parameters. 7860 * @timeout_reason: Reason for connection timeout. This is used when the 7861 * connection fails due to a timeout instead of an explicit rejection from 7862 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is 7863 * not known. This value is used only if @status < 0 to indicate that the 7864 * failure is due to a timeout and not due to explicit rejection by the AP. 7865 * This value is ignored in other cases (@status >= 0). 7866 * @valid_links: For MLO connection, BIT mask of the valid link ids. Otherwise 7867 * zero. 7868 * @ap_mld_addr: For MLO connection, MLD address of the AP. Otherwise %NULL. 7869 * @links : For MLO connection, contains link info for the valid links indicated 7870 * using @valid_links. For non-MLO connection, links[0] contains the 7871 * connected AP info. 7872 * @links.addr: For MLO connection, MAC address of the STA link. Otherwise 7873 * %NULL. 7874 * @links.bssid: For MLO connection, MAC address of the AP link. For non-MLO 7875 * connection, links[0].bssid points to the BSSID of the AP (may be %NULL). 7876 * @links.bss: For MLO connection, entry of bss to which STA link is connected. 7877 * For non-MLO connection, links[0].bss points to entry of bss to which STA 7878 * is connected. It can be obtained through cfg80211_get_bss() (may be 7879 * %NULL). It is recommended to store the bss from the connect_request and 7880 * hold a reference to it and return through this param to avoid a warning 7881 * if the bss is expired during the connection, esp. for those drivers 7882 * implementing connect op. Only one parameter among @bssid and @bss needs 7883 * to be specified. 7884 * @links.status: per-link status code, to report a status code that's not 7885 * %WLAN_STATUS_SUCCESS for a given link, it must also be in the 7886 * @valid_links bitmap and may have a BSS pointer (which is then released) 7887 */ 7888 struct cfg80211_connect_resp_params { 7889 int status; 7890 const u8 *req_ie; 7891 size_t req_ie_len; 7892 const u8 *resp_ie; 7893 size_t resp_ie_len; 7894 struct cfg80211_fils_resp_params fils; 7895 enum nl80211_timeout_reason timeout_reason; 7896 7897 const u8 *ap_mld_addr; 7898 u16 valid_links; 7899 struct { 7900 const u8 *addr; 7901 const u8 *bssid; 7902 struct cfg80211_bss *bss; 7903 u16 status; 7904 } links[IEEE80211_MLD_MAX_NUM_LINKS]; 7905 }; 7906 7907 /** 7908 * cfg80211_connect_done - notify cfg80211 of connection result 7909 * 7910 * @dev: network device 7911 * @params: connection response parameters 7912 * @gfp: allocation flags 7913 * 7914 * It should be called by the underlying driver once execution of the connection 7915 * request from connect() has been completed. This is similar to 7916 * cfg80211_connect_bss(), but takes a structure pointer for connection response 7917 * parameters. Only one of the functions among cfg80211_connect_bss(), 7918 * cfg80211_connect_result(), cfg80211_connect_timeout(), 7919 * and cfg80211_connect_done() should be called. 7920 */ 7921 void cfg80211_connect_done(struct net_device *dev, 7922 struct cfg80211_connect_resp_params *params, 7923 gfp_t gfp); 7924 7925 /** 7926 * cfg80211_connect_bss - notify cfg80211 of connection result 7927 * 7928 * @dev: network device 7929 * @bssid: the BSSID of the AP 7930 * @bss: Entry of bss to which STA got connected to, can be obtained through 7931 * cfg80211_get_bss() (may be %NULL). But it is recommended to store the 7932 * bss from the connect_request and hold a reference to it and return 7933 * through this param to avoid a warning if the bss is expired during the 7934 * connection, esp. for those drivers implementing connect op. 7935 * Only one parameter among @bssid and @bss needs to be specified. 7936 * @req_ie: association request IEs (maybe be %NULL) 7937 * @req_ie_len: association request IEs length 7938 * @resp_ie: association response IEs (may be %NULL) 7939 * @resp_ie_len: assoc response IEs length 7940 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use 7941 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you 7942 * the real status code for failures. If this call is used to report a 7943 * failure due to a timeout (e.g., not receiving an Authentication frame 7944 * from the AP) instead of an explicit rejection by the AP, -1 is used to 7945 * indicate that this is a failure, but without a status code. 7946 * @timeout_reason is used to report the reason for the timeout in that 7947 * case. 7948 * @gfp: allocation flags 7949 * @timeout_reason: reason for connection timeout. This is used when the 7950 * connection fails due to a timeout instead of an explicit rejection from 7951 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is 7952 * not known. This value is used only if @status < 0 to indicate that the 7953 * failure is due to a timeout and not due to explicit rejection by the AP. 7954 * This value is ignored in other cases (@status >= 0). 7955 * 7956 * It should be called by the underlying driver once execution of the connection 7957 * request from connect() has been completed. This is similar to 7958 * cfg80211_connect_result(), but with the option of identifying the exact bss 7959 * entry for the connection. Only one of the functions among 7960 * cfg80211_connect_bss(), cfg80211_connect_result(), 7961 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called. 7962 */ 7963 static inline void 7964 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid, 7965 struct cfg80211_bss *bss, const u8 *req_ie, 7966 size_t req_ie_len, const u8 *resp_ie, 7967 size_t resp_ie_len, int status, gfp_t gfp, 7968 enum nl80211_timeout_reason timeout_reason) 7969 { 7970 struct cfg80211_connect_resp_params params; 7971 7972 memset(¶ms, 0, sizeof(params)); 7973 params.status = status; 7974 params.links[0].bssid = bssid; 7975 params.links[0].bss = bss; 7976 params.req_ie = req_ie; 7977 params.req_ie_len = req_ie_len; 7978 params.resp_ie = resp_ie; 7979 params.resp_ie_len = resp_ie_len; 7980 params.timeout_reason = timeout_reason; 7981 7982 cfg80211_connect_done(dev, ¶ms, gfp); 7983 } 7984 7985 /** 7986 * cfg80211_connect_result - notify cfg80211 of connection result 7987 * 7988 * @dev: network device 7989 * @bssid: the BSSID of the AP 7990 * @req_ie: association request IEs (maybe be %NULL) 7991 * @req_ie_len: association request IEs length 7992 * @resp_ie: association response IEs (may be %NULL) 7993 * @resp_ie_len: assoc response IEs length 7994 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use 7995 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you 7996 * the real status code for failures. 7997 * @gfp: allocation flags 7998 * 7999 * It should be called by the underlying driver once execution of the connection 8000 * request from connect() has been completed. This is similar to 8001 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only 8002 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(), 8003 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called. 8004 */ 8005 static inline void 8006 cfg80211_connect_result(struct net_device *dev, const u8 *bssid, 8007 const u8 *req_ie, size_t req_ie_len, 8008 const u8 *resp_ie, size_t resp_ie_len, 8009 u16 status, gfp_t gfp) 8010 { 8011 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie, 8012 resp_ie_len, status, gfp, 8013 NL80211_TIMEOUT_UNSPECIFIED); 8014 } 8015 8016 /** 8017 * cfg80211_connect_timeout - notify cfg80211 of connection timeout 8018 * 8019 * @dev: network device 8020 * @bssid: the BSSID of the AP 8021 * @req_ie: association request IEs (maybe be %NULL) 8022 * @req_ie_len: association request IEs length 8023 * @gfp: allocation flags 8024 * @timeout_reason: reason for connection timeout. 8025 * 8026 * It should be called by the underlying driver whenever connect() has failed 8027 * in a sequence where no explicit authentication/association rejection was 8028 * received from the AP. This could happen, e.g., due to not being able to send 8029 * out the Authentication or Association Request frame or timing out while 8030 * waiting for the response. Only one of the functions among 8031 * cfg80211_connect_bss(), cfg80211_connect_result(), 8032 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called. 8033 */ 8034 static inline void 8035 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid, 8036 const u8 *req_ie, size_t req_ie_len, gfp_t gfp, 8037 enum nl80211_timeout_reason timeout_reason) 8038 { 8039 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1, 8040 gfp, timeout_reason); 8041 } 8042 8043 /** 8044 * struct cfg80211_roam_info - driver initiated roaming information 8045 * 8046 * @req_ie: association request IEs (maybe be %NULL) 8047 * @req_ie_len: association request IEs length 8048 * @resp_ie: association response IEs (may be %NULL) 8049 * @resp_ie_len: assoc response IEs length 8050 * @fils: FILS related roaming information. 8051 * @valid_links: For MLO roaming, BIT mask of the new valid links is set. 8052 * Otherwise zero. 8053 * @ap_mld_addr: For MLO roaming, MLD address of the new AP. Otherwise %NULL. 8054 * @links : For MLO roaming, contains new link info for the valid links set in 8055 * @valid_links. For non-MLO roaming, links[0] contains the new AP info. 8056 * @links.addr: For MLO roaming, MAC address of the STA link. Otherwise %NULL. 8057 * @links.bssid: For MLO roaming, MAC address of the new AP link. For non-MLO 8058 * roaming, links[0].bssid points to the BSSID of the new AP. May be 8059 * %NULL if %links.bss is set. 8060 * @links.channel: the channel of the new AP. 8061 * @links.bss: For MLO roaming, entry of new bss to which STA link got 8062 * roamed. For non-MLO roaming, links[0].bss points to entry of bss to 8063 * which STA got roamed (may be %NULL if %links.bssid is set) 8064 */ 8065 struct cfg80211_roam_info { 8066 const u8 *req_ie; 8067 size_t req_ie_len; 8068 const u8 *resp_ie; 8069 size_t resp_ie_len; 8070 struct cfg80211_fils_resp_params fils; 8071 8072 const u8 *ap_mld_addr; 8073 u16 valid_links; 8074 struct { 8075 const u8 *addr; 8076 const u8 *bssid; 8077 struct ieee80211_channel *channel; 8078 struct cfg80211_bss *bss; 8079 } links[IEEE80211_MLD_MAX_NUM_LINKS]; 8080 }; 8081 8082 /** 8083 * cfg80211_roamed - notify cfg80211 of roaming 8084 * 8085 * @dev: network device 8086 * @info: information about the new BSS. struct &cfg80211_roam_info. 8087 * @gfp: allocation flags 8088 * 8089 * This function may be called with the driver passing either the BSSID of the 8090 * new AP or passing the bss entry to avoid a race in timeout of the bss entry. 8091 * It should be called by the underlying driver whenever it roamed from one AP 8092 * to another while connected. Drivers which have roaming implemented in 8093 * firmware should pass the bss entry to avoid a race in bss entry timeout where 8094 * the bss entry of the new AP is seen in the driver, but gets timed out by the 8095 * time it is accessed in __cfg80211_roamed() due to delay in scheduling 8096 * rdev->event_work. In case of any failures, the reference is released 8097 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be 8098 * released while disconnecting from the current bss. 8099 */ 8100 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info, 8101 gfp_t gfp); 8102 8103 /** 8104 * cfg80211_port_authorized - notify cfg80211 of successful security association 8105 * 8106 * @dev: network device 8107 * @peer_addr: BSSID of the AP/P2P GO in case of STA/GC or STA/GC MAC address 8108 * in case of AP/P2P GO 8109 * @td_bitmap: transition disable policy 8110 * @td_bitmap_len: Length of transition disable policy 8111 * @gfp: allocation flags 8112 * 8113 * This function should be called by a driver that supports 4 way handshake 8114 * offload after a security association was successfully established (i.e., 8115 * the 4 way handshake was completed successfully). The call to this function 8116 * should be preceded with a call to cfg80211_connect_result(), 8117 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to 8118 * indicate the 802.11 association. 8119 * This function can also be called by AP/P2P GO driver that supports 8120 * authentication offload. In this case the peer_mac passed is that of 8121 * associated STA/GC. 8122 */ 8123 void cfg80211_port_authorized(struct net_device *dev, const u8 *peer_addr, 8124 const u8* td_bitmap, u8 td_bitmap_len, gfp_t gfp); 8125 8126 /** 8127 * cfg80211_disconnected - notify cfg80211 that connection was dropped 8128 * 8129 * @dev: network device 8130 * @ie: information elements of the deauth/disassoc frame (may be %NULL) 8131 * @ie_len: length of IEs 8132 * @reason: reason code for the disconnection, set it to 0 if unknown 8133 * @locally_generated: disconnection was requested locally 8134 * @gfp: allocation flags 8135 * 8136 * After it calls this function, the driver should enter an idle state 8137 * and not try to connect to any AP any more. 8138 */ 8139 void cfg80211_disconnected(struct net_device *dev, u16 reason, 8140 const u8 *ie, size_t ie_len, 8141 bool locally_generated, gfp_t gfp); 8142 8143 /** 8144 * cfg80211_ready_on_channel - notification of remain_on_channel start 8145 * @wdev: wireless device 8146 * @cookie: the request cookie 8147 * @chan: The current channel (from remain_on_channel request) 8148 * @duration: Duration in milliseconds that the driver intents to remain on the 8149 * channel 8150 * @gfp: allocation flags 8151 */ 8152 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie, 8153 struct ieee80211_channel *chan, 8154 unsigned int duration, gfp_t gfp); 8155 8156 /** 8157 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired 8158 * @wdev: wireless device 8159 * @cookie: the request cookie 8160 * @chan: The current channel (from remain_on_channel request) 8161 * @gfp: allocation flags 8162 */ 8163 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie, 8164 struct ieee80211_channel *chan, 8165 gfp_t gfp); 8166 8167 /** 8168 * cfg80211_tx_mgmt_expired - tx_mgmt duration expired 8169 * @wdev: wireless device 8170 * @cookie: the requested cookie 8171 * @chan: The current channel (from tx_mgmt request) 8172 * @gfp: allocation flags 8173 */ 8174 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie, 8175 struct ieee80211_channel *chan, gfp_t gfp); 8176 8177 /** 8178 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics. 8179 * 8180 * @sinfo: the station information 8181 * @gfp: allocation flags 8182 */ 8183 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp); 8184 8185 /** 8186 * cfg80211_sinfo_release_content - release contents of station info 8187 * @sinfo: the station information 8188 * 8189 * Releases any potentially allocated sub-information of the station 8190 * information, but not the struct itself (since it's typically on 8191 * the stack.) 8192 */ 8193 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo) 8194 { 8195 kfree(sinfo->pertid); 8196 } 8197 8198 /** 8199 * cfg80211_new_sta - notify userspace about station 8200 * 8201 * @dev: the netdev 8202 * @mac_addr: the station's address 8203 * @sinfo: the station information 8204 * @gfp: allocation flags 8205 */ 8206 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr, 8207 struct station_info *sinfo, gfp_t gfp); 8208 8209 /** 8210 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station 8211 * @dev: the netdev 8212 * @mac_addr: the station's address. For MLD station, MLD address is used. 8213 * @sinfo: the station information/statistics 8214 * @gfp: allocation flags 8215 */ 8216 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr, 8217 struct station_info *sinfo, gfp_t gfp); 8218 8219 /** 8220 * cfg80211_del_sta - notify userspace about deletion of a station 8221 * 8222 * @dev: the netdev 8223 * @mac_addr: the station's address. For MLD station, MLD address is used. 8224 * @gfp: allocation flags 8225 */ 8226 static inline void cfg80211_del_sta(struct net_device *dev, 8227 const u8 *mac_addr, gfp_t gfp) 8228 { 8229 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp); 8230 } 8231 8232 /** 8233 * cfg80211_conn_failed - connection request failed notification 8234 * 8235 * @dev: the netdev 8236 * @mac_addr: the station's address 8237 * @reason: the reason for connection failure 8238 * @gfp: allocation flags 8239 * 8240 * Whenever a station tries to connect to an AP and if the station 8241 * could not connect to the AP as the AP has rejected the connection 8242 * for some reasons, this function is called. 8243 * 8244 * The reason for connection failure can be any of the value from 8245 * nl80211_connect_failed_reason enum 8246 */ 8247 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr, 8248 enum nl80211_connect_failed_reason reason, 8249 gfp_t gfp); 8250 8251 /** 8252 * struct cfg80211_rx_info - received management frame info 8253 * 8254 * @freq: Frequency on which the frame was received in kHz 8255 * @sig_dbm: signal strength in dBm, or 0 if unknown 8256 * @have_link_id: indicates the frame was received on a link of 8257 * an MLD, i.e. the @link_id field is valid 8258 * @link_id: the ID of the link the frame was received on 8259 * @buf: Management frame (header + body) 8260 * @len: length of the frame data 8261 * @flags: flags, as defined in &enum nl80211_rxmgmt_flags 8262 * @rx_tstamp: Hardware timestamp of frame RX in nanoseconds 8263 * @ack_tstamp: Hardware timestamp of ack TX in nanoseconds 8264 */ 8265 struct cfg80211_rx_info { 8266 int freq; 8267 int sig_dbm; 8268 bool have_link_id; 8269 u8 link_id; 8270 const u8 *buf; 8271 size_t len; 8272 u32 flags; 8273 u64 rx_tstamp; 8274 u64 ack_tstamp; 8275 }; 8276 8277 /** 8278 * cfg80211_rx_mgmt_ext - management frame notification with extended info 8279 * @wdev: wireless device receiving the frame 8280 * @info: RX info as defined in struct cfg80211_rx_info 8281 * 8282 * This function is called whenever an Action frame is received for a station 8283 * mode interface, but is not processed in kernel. 8284 * 8285 * Return: %true if a user space application has registered for this frame. 8286 * For action frames, that makes it responsible for rejecting unrecognized 8287 * action frames; %false otherwise, in which case for action frames the 8288 * driver is responsible for rejecting the frame. 8289 */ 8290 bool cfg80211_rx_mgmt_ext(struct wireless_dev *wdev, 8291 struct cfg80211_rx_info *info); 8292 8293 /** 8294 * cfg80211_rx_mgmt_khz - notification of received, unprocessed management frame 8295 * @wdev: wireless device receiving the frame 8296 * @freq: Frequency on which the frame was received in KHz 8297 * @sig_dbm: signal strength in dBm, or 0 if unknown 8298 * @buf: Management frame (header + body) 8299 * @len: length of the frame data 8300 * @flags: flags, as defined in enum nl80211_rxmgmt_flags 8301 * 8302 * This function is called whenever an Action frame is received for a station 8303 * mode interface, but is not processed in kernel. 8304 * 8305 * Return: %true if a user space application has registered for this frame. 8306 * For action frames, that makes it responsible for rejecting unrecognized 8307 * action frames; %false otherwise, in which case for action frames the 8308 * driver is responsible for rejecting the frame. 8309 */ 8310 static inline bool cfg80211_rx_mgmt_khz(struct wireless_dev *wdev, int freq, 8311 int sig_dbm, const u8 *buf, size_t len, 8312 u32 flags) 8313 { 8314 struct cfg80211_rx_info info = { 8315 .freq = freq, 8316 .sig_dbm = sig_dbm, 8317 .buf = buf, 8318 .len = len, 8319 .flags = flags 8320 }; 8321 8322 return cfg80211_rx_mgmt_ext(wdev, &info); 8323 } 8324 8325 /** 8326 * cfg80211_rx_mgmt - notification of received, unprocessed management frame 8327 * @wdev: wireless device receiving the frame 8328 * @freq: Frequency on which the frame was received in MHz 8329 * @sig_dbm: signal strength in dBm, or 0 if unknown 8330 * @buf: Management frame (header + body) 8331 * @len: length of the frame data 8332 * @flags: flags, as defined in enum nl80211_rxmgmt_flags 8333 * 8334 * This function is called whenever an Action frame is received for a station 8335 * mode interface, but is not processed in kernel. 8336 * 8337 * Return: %true if a user space application has registered for this frame. 8338 * For action frames, that makes it responsible for rejecting unrecognized 8339 * action frames; %false otherwise, in which case for action frames the 8340 * driver is responsible for rejecting the frame. 8341 */ 8342 static inline bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, 8343 int sig_dbm, const u8 *buf, size_t len, 8344 u32 flags) 8345 { 8346 struct cfg80211_rx_info info = { 8347 .freq = MHZ_TO_KHZ(freq), 8348 .sig_dbm = sig_dbm, 8349 .buf = buf, 8350 .len = len, 8351 .flags = flags 8352 }; 8353 8354 return cfg80211_rx_mgmt_ext(wdev, &info); 8355 } 8356 8357 /** 8358 * struct cfg80211_tx_status - TX status for management frame information 8359 * 8360 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx() 8361 * @tx_tstamp: hardware TX timestamp in nanoseconds 8362 * @ack_tstamp: hardware ack RX timestamp in nanoseconds 8363 * @buf: Management frame (header + body) 8364 * @len: length of the frame data 8365 * @ack: Whether frame was acknowledged 8366 */ 8367 struct cfg80211_tx_status { 8368 u64 cookie; 8369 u64 tx_tstamp; 8370 u64 ack_tstamp; 8371 const u8 *buf; 8372 size_t len; 8373 bool ack; 8374 }; 8375 8376 /** 8377 * cfg80211_mgmt_tx_status_ext - TX status notification with extended info 8378 * @wdev: wireless device receiving the frame 8379 * @status: TX status data 8380 * @gfp: context flags 8381 * 8382 * This function is called whenever a management frame was requested to be 8383 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the 8384 * transmission attempt with extended info. 8385 */ 8386 void cfg80211_mgmt_tx_status_ext(struct wireless_dev *wdev, 8387 struct cfg80211_tx_status *status, gfp_t gfp); 8388 8389 /** 8390 * cfg80211_mgmt_tx_status - notification of TX status for management frame 8391 * @wdev: wireless device receiving the frame 8392 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx() 8393 * @buf: Management frame (header + body) 8394 * @len: length of the frame data 8395 * @ack: Whether frame was acknowledged 8396 * @gfp: context flags 8397 * 8398 * This function is called whenever a management frame was requested to be 8399 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the 8400 * transmission attempt. 8401 */ 8402 static inline void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, 8403 u64 cookie, const u8 *buf, 8404 size_t len, bool ack, gfp_t gfp) 8405 { 8406 struct cfg80211_tx_status status = { 8407 .cookie = cookie, 8408 .buf = buf, 8409 .len = len, 8410 .ack = ack 8411 }; 8412 8413 cfg80211_mgmt_tx_status_ext(wdev, &status, gfp); 8414 } 8415 8416 /** 8417 * cfg80211_control_port_tx_status - notification of TX status for control 8418 * port frames 8419 * @wdev: wireless device receiving the frame 8420 * @cookie: Cookie returned by cfg80211_ops::tx_control_port() 8421 * @buf: Data frame (header + body) 8422 * @len: length of the frame data 8423 * @ack: Whether frame was acknowledged 8424 * @gfp: context flags 8425 * 8426 * This function is called whenever a control port frame was requested to be 8427 * transmitted with cfg80211_ops::tx_control_port() to report the TX status of 8428 * the transmission attempt. 8429 */ 8430 void cfg80211_control_port_tx_status(struct wireless_dev *wdev, u64 cookie, 8431 const u8 *buf, size_t len, bool ack, 8432 gfp_t gfp); 8433 8434 /** 8435 * cfg80211_rx_control_port - notification about a received control port frame 8436 * @dev: The device the frame matched to 8437 * @skb: The skbuf with the control port frame. It is assumed that the skbuf 8438 * is 802.3 formatted (with 802.3 header). The skb can be non-linear. 8439 * This function does not take ownership of the skb, so the caller is 8440 * responsible for any cleanup. The caller must also ensure that 8441 * skb->protocol is set appropriately. 8442 * @unencrypted: Whether the frame was received unencrypted 8443 * @link_id: the link the frame was received on, -1 if not applicable or unknown 8444 * 8445 * This function is used to inform userspace about a received control port 8446 * frame. It should only be used if userspace indicated it wants to receive 8447 * control port frames over nl80211. 8448 * 8449 * The frame is the data portion of the 802.3 or 802.11 data frame with all 8450 * network layer headers removed (e.g. the raw EAPoL frame). 8451 * 8452 * Return: %true if the frame was passed to userspace 8453 */ 8454 bool cfg80211_rx_control_port(struct net_device *dev, struct sk_buff *skb, 8455 bool unencrypted, int link_id); 8456 8457 /** 8458 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event 8459 * @dev: network device 8460 * @rssi_event: the triggered RSSI event 8461 * @rssi_level: new RSSI level value or 0 if not available 8462 * @gfp: context flags 8463 * 8464 * This function is called when a configured connection quality monitoring 8465 * rssi threshold reached event occurs. 8466 */ 8467 void cfg80211_cqm_rssi_notify(struct net_device *dev, 8468 enum nl80211_cqm_rssi_threshold_event rssi_event, 8469 s32 rssi_level, gfp_t gfp); 8470 8471 /** 8472 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer 8473 * @dev: network device 8474 * @peer: peer's MAC address 8475 * @num_packets: how many packets were lost -- should be a fixed threshold 8476 * but probably no less than maybe 50, or maybe a throughput dependent 8477 * threshold (to account for temporary interference) 8478 * @gfp: context flags 8479 */ 8480 void cfg80211_cqm_pktloss_notify(struct net_device *dev, 8481 const u8 *peer, u32 num_packets, gfp_t gfp); 8482 8483 /** 8484 * cfg80211_cqm_txe_notify - TX error rate event 8485 * @dev: network device 8486 * @peer: peer's MAC address 8487 * @num_packets: how many packets were lost 8488 * @rate: % of packets which failed transmission 8489 * @intvl: interval (in s) over which the TX failure threshold was breached. 8490 * @gfp: context flags 8491 * 8492 * Notify userspace when configured % TX failures over number of packets in a 8493 * given interval is exceeded. 8494 */ 8495 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer, 8496 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp); 8497 8498 /** 8499 * cfg80211_cqm_beacon_loss_notify - beacon loss event 8500 * @dev: network device 8501 * @gfp: context flags 8502 * 8503 * Notify userspace about beacon loss from the connected AP. 8504 */ 8505 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp); 8506 8507 /** 8508 * __cfg80211_radar_event - radar detection event 8509 * @wiphy: the wiphy 8510 * @chandef: chandef for the current channel 8511 * @offchan: the radar has been detected on the offchannel chain 8512 * @gfp: context flags 8513 * 8514 * This function is called when a radar is detected on the current chanenl. 8515 */ 8516 void __cfg80211_radar_event(struct wiphy *wiphy, 8517 struct cfg80211_chan_def *chandef, 8518 bool offchan, gfp_t gfp); 8519 8520 static inline void 8521 cfg80211_radar_event(struct wiphy *wiphy, 8522 struct cfg80211_chan_def *chandef, 8523 gfp_t gfp) 8524 { 8525 __cfg80211_radar_event(wiphy, chandef, false, gfp); 8526 } 8527 8528 static inline void 8529 cfg80211_background_radar_event(struct wiphy *wiphy, 8530 struct cfg80211_chan_def *chandef, 8531 gfp_t gfp) 8532 { 8533 __cfg80211_radar_event(wiphy, chandef, true, gfp); 8534 } 8535 8536 /** 8537 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event 8538 * @dev: network device 8539 * @mac: MAC address of a station which opmode got modified 8540 * @sta_opmode: station's current opmode value 8541 * @gfp: context flags 8542 * 8543 * Driver should call this function when station's opmode modified via action 8544 * frame. 8545 */ 8546 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac, 8547 struct sta_opmode_info *sta_opmode, 8548 gfp_t gfp); 8549 8550 /** 8551 * cfg80211_cac_event - Channel availability check (CAC) event 8552 * @netdev: network device 8553 * @chandef: chandef for the current channel 8554 * @event: type of event 8555 * @gfp: context flags 8556 * 8557 * This function is called when a Channel availability check (CAC) is finished 8558 * or aborted. This must be called to notify the completion of a CAC process, 8559 * also by full-MAC drivers. 8560 */ 8561 void cfg80211_cac_event(struct net_device *netdev, 8562 const struct cfg80211_chan_def *chandef, 8563 enum nl80211_radar_event event, gfp_t gfp); 8564 8565 /** 8566 * cfg80211_background_cac_abort - Channel Availability Check offchan abort event 8567 * @wiphy: the wiphy 8568 * 8569 * This function is called by the driver when a Channel Availability Check 8570 * (CAC) is aborted by a offchannel dedicated chain. 8571 */ 8572 void cfg80211_background_cac_abort(struct wiphy *wiphy); 8573 8574 /** 8575 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying 8576 * @dev: network device 8577 * @bssid: BSSID of AP (to avoid races) 8578 * @replay_ctr: new replay counter 8579 * @gfp: allocation flags 8580 */ 8581 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid, 8582 const u8 *replay_ctr, gfp_t gfp); 8583 8584 /** 8585 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate 8586 * @dev: network device 8587 * @index: candidate index (the smaller the index, the higher the priority) 8588 * @bssid: BSSID of AP 8589 * @preauth: Whether AP advertises support for RSN pre-authentication 8590 * @gfp: allocation flags 8591 */ 8592 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index, 8593 const u8 *bssid, bool preauth, gfp_t gfp); 8594 8595 /** 8596 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame 8597 * @dev: The device the frame matched to 8598 * @addr: the transmitter address 8599 * @gfp: context flags 8600 * 8601 * This function is used in AP mode (only!) to inform userspace that 8602 * a spurious class 3 frame was received, to be able to deauth the 8603 * sender. 8604 * Return: %true if the frame was passed to userspace (or this failed 8605 * for a reason other than not having a subscription.) 8606 */ 8607 bool cfg80211_rx_spurious_frame(struct net_device *dev, 8608 const u8 *addr, gfp_t gfp); 8609 8610 /** 8611 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame 8612 * @dev: The device the frame matched to 8613 * @addr: the transmitter address 8614 * @gfp: context flags 8615 * 8616 * This function is used in AP mode (only!) to inform userspace that 8617 * an associated station sent a 4addr frame but that wasn't expected. 8618 * It is allowed and desirable to send this event only once for each 8619 * station to avoid event flooding. 8620 * Return: %true if the frame was passed to userspace (or this failed 8621 * for a reason other than not having a subscription.) 8622 */ 8623 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev, 8624 const u8 *addr, gfp_t gfp); 8625 8626 /** 8627 * cfg80211_probe_status - notify userspace about probe status 8628 * @dev: the device the probe was sent on 8629 * @addr: the address of the peer 8630 * @cookie: the cookie filled in @probe_client previously 8631 * @acked: indicates whether probe was acked or not 8632 * @ack_signal: signal strength (in dBm) of the ACK frame. 8633 * @is_valid_ack_signal: indicates the ack_signal is valid or not. 8634 * @gfp: allocation flags 8635 */ 8636 void cfg80211_probe_status(struct net_device *dev, const u8 *addr, 8637 u64 cookie, bool acked, s32 ack_signal, 8638 bool is_valid_ack_signal, gfp_t gfp); 8639 8640 /** 8641 * cfg80211_report_obss_beacon_khz - report beacon from other APs 8642 * @wiphy: The wiphy that received the beacon 8643 * @frame: the frame 8644 * @len: length of the frame 8645 * @freq: frequency the frame was received on in KHz 8646 * @sig_dbm: signal strength in dBm, or 0 if unknown 8647 * 8648 * Use this function to report to userspace when a beacon was 8649 * received. It is not useful to call this when there is no 8650 * netdev that is in AP/GO mode. 8651 */ 8652 void cfg80211_report_obss_beacon_khz(struct wiphy *wiphy, const u8 *frame, 8653 size_t len, int freq, int sig_dbm); 8654 8655 /** 8656 * cfg80211_report_obss_beacon - report beacon from other APs 8657 * @wiphy: The wiphy that received the beacon 8658 * @frame: the frame 8659 * @len: length of the frame 8660 * @freq: frequency the frame was received on 8661 * @sig_dbm: signal strength in dBm, or 0 if unknown 8662 * 8663 * Use this function to report to userspace when a beacon was 8664 * received. It is not useful to call this when there is no 8665 * netdev that is in AP/GO mode. 8666 */ 8667 static inline void cfg80211_report_obss_beacon(struct wiphy *wiphy, 8668 const u8 *frame, size_t len, 8669 int freq, int sig_dbm) 8670 { 8671 cfg80211_report_obss_beacon_khz(wiphy, frame, len, MHZ_TO_KHZ(freq), 8672 sig_dbm); 8673 } 8674 8675 /** 8676 * cfg80211_reg_can_beacon - check if beaconing is allowed 8677 * @wiphy: the wiphy 8678 * @chandef: the channel definition 8679 * @iftype: interface type 8680 * 8681 * Return: %true if there is no secondary channel or the secondary channel(s) 8682 * can be used for beaconing (i.e. is not a radar channel etc.) 8683 */ 8684 bool cfg80211_reg_can_beacon(struct wiphy *wiphy, 8685 struct cfg80211_chan_def *chandef, 8686 enum nl80211_iftype iftype); 8687 8688 /** 8689 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation 8690 * @wiphy: the wiphy 8691 * @chandef: the channel definition 8692 * @iftype: interface type 8693 * 8694 * Return: %true if there is no secondary channel or the secondary channel(s) 8695 * can be used for beaconing (i.e. is not a radar channel etc.). This version 8696 * also checks if IR-relaxation conditions apply, to allow beaconing under 8697 * more permissive conditions. 8698 * 8699 * Requires the wiphy mutex to be held. 8700 */ 8701 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy, 8702 struct cfg80211_chan_def *chandef, 8703 enum nl80211_iftype iftype); 8704 8705 /* 8706 * cfg80211_ch_switch_notify - update wdev channel and notify userspace 8707 * @dev: the device which switched channels 8708 * @chandef: the new channel definition 8709 * @link_id: the link ID for MLO, must be 0 for non-MLO 8710 * @punct_bitmap: the new puncturing bitmap 8711 * 8712 * Caller must hold wiphy mutex, therefore must only be called from sleepable 8713 * driver context! 8714 */ 8715 void cfg80211_ch_switch_notify(struct net_device *dev, 8716 struct cfg80211_chan_def *chandef, 8717 unsigned int link_id, u16 punct_bitmap); 8718 8719 /* 8720 * cfg80211_ch_switch_started_notify - notify channel switch start 8721 * @dev: the device on which the channel switch started 8722 * @chandef: the future channel definition 8723 * @link_id: the link ID for MLO, must be 0 for non-MLO 8724 * @count: the number of TBTTs until the channel switch happens 8725 * @quiet: whether or not immediate quiet was requested by the AP 8726 * @punct_bitmap: the future puncturing bitmap 8727 * 8728 * Inform the userspace about the channel switch that has just 8729 * started, so that it can take appropriate actions (eg. starting 8730 * channel switch on other vifs), if necessary. 8731 */ 8732 void cfg80211_ch_switch_started_notify(struct net_device *dev, 8733 struct cfg80211_chan_def *chandef, 8734 unsigned int link_id, u8 count, 8735 bool quiet, u16 punct_bitmap); 8736 8737 /** 8738 * ieee80211_operating_class_to_band - convert operating class to band 8739 * 8740 * @operating_class: the operating class to convert 8741 * @band: band pointer to fill 8742 * 8743 * Returns %true if the conversion was successful, %false otherwise. 8744 */ 8745 bool ieee80211_operating_class_to_band(u8 operating_class, 8746 enum nl80211_band *band); 8747 8748 /** 8749 * ieee80211_chandef_to_operating_class - convert chandef to operation class 8750 * 8751 * @chandef: the chandef to convert 8752 * @op_class: a pointer to the resulting operating class 8753 * 8754 * Returns %true if the conversion was successful, %false otherwise. 8755 */ 8756 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef, 8757 u8 *op_class); 8758 8759 /** 8760 * ieee80211_chandef_to_khz - convert chandef to frequency in KHz 8761 * 8762 * @chandef: the chandef to convert 8763 * 8764 * Returns the center frequency of chandef (1st segment) in KHz. 8765 */ 8766 static inline u32 8767 ieee80211_chandef_to_khz(const struct cfg80211_chan_def *chandef) 8768 { 8769 return MHZ_TO_KHZ(chandef->center_freq1) + chandef->freq1_offset; 8770 } 8771 8772 /* 8773 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation 8774 * @dev: the device on which the operation is requested 8775 * @peer: the MAC address of the peer device 8776 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or 8777 * NL80211_TDLS_TEARDOWN) 8778 * @reason_code: the reason code for teardown request 8779 * @gfp: allocation flags 8780 * 8781 * This function is used to request userspace to perform TDLS operation that 8782 * requires knowledge of keys, i.e., link setup or teardown when the AP 8783 * connection uses encryption. This is optional mechanism for the driver to use 8784 * if it can automatically determine when a TDLS link could be useful (e.g., 8785 * based on traffic and signal strength for a peer). 8786 */ 8787 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer, 8788 enum nl80211_tdls_operation oper, 8789 u16 reason_code, gfp_t gfp); 8790 8791 /* 8792 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units) 8793 * @rate: given rate_info to calculate bitrate from 8794 * 8795 * return 0 if MCS index >= 32 8796 */ 8797 u32 cfg80211_calculate_bitrate(struct rate_info *rate); 8798 8799 /** 8800 * cfg80211_unregister_wdev - remove the given wdev 8801 * @wdev: struct wireless_dev to remove 8802 * 8803 * This function removes the device so it can no longer be used. It is necessary 8804 * to call this function even when cfg80211 requests the removal of the device 8805 * by calling the del_virtual_intf() callback. The function must also be called 8806 * when the driver wishes to unregister the wdev, e.g. when the hardware device 8807 * is unbound from the driver. 8808 * 8809 * Requires the RTNL and wiphy mutex to be held. 8810 */ 8811 void cfg80211_unregister_wdev(struct wireless_dev *wdev); 8812 8813 /** 8814 * cfg80211_register_netdevice - register the given netdev 8815 * @dev: the netdev to register 8816 * 8817 * Note: In contexts coming from cfg80211 callbacks, you must call this rather 8818 * than register_netdevice(), unregister_netdev() is impossible as the RTNL is 8819 * held. Otherwise, both register_netdevice() and register_netdev() are usable 8820 * instead as well. 8821 * 8822 * Requires the RTNL and wiphy mutex to be held. 8823 */ 8824 int cfg80211_register_netdevice(struct net_device *dev); 8825 8826 /** 8827 * cfg80211_unregister_netdevice - unregister the given netdev 8828 * @dev: the netdev to register 8829 * 8830 * Note: In contexts coming from cfg80211 callbacks, you must call this rather 8831 * than unregister_netdevice(), unregister_netdev() is impossible as the RTNL 8832 * is held. Otherwise, both unregister_netdevice() and unregister_netdev() are 8833 * usable instead as well. 8834 * 8835 * Requires the RTNL and wiphy mutex to be held. 8836 */ 8837 static inline void cfg80211_unregister_netdevice(struct net_device *dev) 8838 { 8839 #if IS_ENABLED(CONFIG_CFG80211) 8840 cfg80211_unregister_wdev(dev->ieee80211_ptr); 8841 #endif 8842 } 8843 8844 /** 8845 * struct cfg80211_ft_event_params - FT Information Elements 8846 * @ies: FT IEs 8847 * @ies_len: length of the FT IE in bytes 8848 * @target_ap: target AP's MAC address 8849 * @ric_ies: RIC IE 8850 * @ric_ies_len: length of the RIC IE in bytes 8851 */ 8852 struct cfg80211_ft_event_params { 8853 const u8 *ies; 8854 size_t ies_len; 8855 const u8 *target_ap; 8856 const u8 *ric_ies; 8857 size_t ric_ies_len; 8858 }; 8859 8860 /** 8861 * cfg80211_ft_event - notify userspace about FT IE and RIC IE 8862 * @netdev: network device 8863 * @ft_event: IE information 8864 */ 8865 void cfg80211_ft_event(struct net_device *netdev, 8866 struct cfg80211_ft_event_params *ft_event); 8867 8868 /** 8869 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer 8870 * @ies: the input IE buffer 8871 * @len: the input length 8872 * @attr: the attribute ID to find 8873 * @buf: output buffer, can be %NULL if the data isn't needed, e.g. 8874 * if the function is only called to get the needed buffer size 8875 * @bufsize: size of the output buffer 8876 * 8877 * The function finds a given P2P attribute in the (vendor) IEs and 8878 * copies its contents to the given buffer. 8879 * 8880 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is 8881 * malformed or the attribute can't be found (respectively), or the 8882 * length of the found attribute (which can be zero). 8883 */ 8884 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len, 8885 enum ieee80211_p2p_attr_id attr, 8886 u8 *buf, unsigned int bufsize); 8887 8888 /** 8889 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC) 8890 * @ies: the IE buffer 8891 * @ielen: the length of the IE buffer 8892 * @ids: an array with element IDs that are allowed before 8893 * the split. A WLAN_EID_EXTENSION value means that the next 8894 * EID in the list is a sub-element of the EXTENSION IE. 8895 * @n_ids: the size of the element ID array 8896 * @after_ric: array IE types that come after the RIC element 8897 * @n_after_ric: size of the @after_ric array 8898 * @offset: offset where to start splitting in the buffer 8899 * 8900 * This function splits an IE buffer by updating the @offset 8901 * variable to point to the location where the buffer should be 8902 * split. 8903 * 8904 * It assumes that the given IE buffer is well-formed, this 8905 * has to be guaranteed by the caller! 8906 * 8907 * It also assumes that the IEs in the buffer are ordered 8908 * correctly, if not the result of using this function will not 8909 * be ordered correctly either, i.e. it does no reordering. 8910 * 8911 * The function returns the offset where the next part of the 8912 * buffer starts, which may be @ielen if the entire (remainder) 8913 * of the buffer should be used. 8914 */ 8915 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen, 8916 const u8 *ids, int n_ids, 8917 const u8 *after_ric, int n_after_ric, 8918 size_t offset); 8919 8920 /** 8921 * ieee80211_ie_split - split an IE buffer according to ordering 8922 * @ies: the IE buffer 8923 * @ielen: the length of the IE buffer 8924 * @ids: an array with element IDs that are allowed before 8925 * the split. A WLAN_EID_EXTENSION value means that the next 8926 * EID in the list is a sub-element of the EXTENSION IE. 8927 * @n_ids: the size of the element ID array 8928 * @offset: offset where to start splitting in the buffer 8929 * 8930 * This function splits an IE buffer by updating the @offset 8931 * variable to point to the location where the buffer should be 8932 * split. 8933 * 8934 * It assumes that the given IE buffer is well-formed, this 8935 * has to be guaranteed by the caller! 8936 * 8937 * It also assumes that the IEs in the buffer are ordered 8938 * correctly, if not the result of using this function will not 8939 * be ordered correctly either, i.e. it does no reordering. 8940 * 8941 * The function returns the offset where the next part of the 8942 * buffer starts, which may be @ielen if the entire (remainder) 8943 * of the buffer should be used. 8944 */ 8945 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen, 8946 const u8 *ids, int n_ids, size_t offset) 8947 { 8948 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset); 8949 } 8950 8951 /** 8952 * ieee80211_fragment_element - fragment the last element in skb 8953 * @skb: The skbuf that the element was added to 8954 * @len_pos: Pointer to length of the element to fragment 8955 * @frag_id: The element ID to use for fragments 8956 * 8957 * This function fragments all data after @len_pos, adding fragmentation 8958 * elements with the given ID as appropriate. The SKB will grow in size 8959 * accordingly. 8960 */ 8961 void ieee80211_fragment_element(struct sk_buff *skb, u8 *len_pos, u8 frag_id); 8962 8963 /** 8964 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN 8965 * @wdev: the wireless device reporting the wakeup 8966 * @wakeup: the wakeup report 8967 * @gfp: allocation flags 8968 * 8969 * This function reports that the given device woke up. If it 8970 * caused the wakeup, report the reason(s), otherwise you may 8971 * pass %NULL as the @wakeup parameter to advertise that something 8972 * else caused the wakeup. 8973 */ 8974 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev, 8975 struct cfg80211_wowlan_wakeup *wakeup, 8976 gfp_t gfp); 8977 8978 /** 8979 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver. 8980 * 8981 * @wdev: the wireless device for which critical protocol is stopped. 8982 * @gfp: allocation flags 8983 * 8984 * This function can be called by the driver to indicate it has reverted 8985 * operation back to normal. One reason could be that the duration given 8986 * by .crit_proto_start() has expired. 8987 */ 8988 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp); 8989 8990 /** 8991 * ieee80211_get_num_supported_channels - get number of channels device has 8992 * @wiphy: the wiphy 8993 * 8994 * Return: the number of channels supported by the device. 8995 */ 8996 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy); 8997 8998 /** 8999 * cfg80211_check_combinations - check interface combinations 9000 * 9001 * @wiphy: the wiphy 9002 * @params: the interface combinations parameter 9003 * 9004 * This function can be called by the driver to check whether a 9005 * combination of interfaces and their types are allowed according to 9006 * the interface combinations. 9007 */ 9008 int cfg80211_check_combinations(struct wiphy *wiphy, 9009 struct iface_combination_params *params); 9010 9011 /** 9012 * cfg80211_iter_combinations - iterate over matching combinations 9013 * 9014 * @wiphy: the wiphy 9015 * @params: the interface combinations parameter 9016 * @iter: function to call for each matching combination 9017 * @data: pointer to pass to iter function 9018 * 9019 * This function can be called by the driver to check what possible 9020 * combinations it fits in at a given moment, e.g. for channel switching 9021 * purposes. 9022 */ 9023 int cfg80211_iter_combinations(struct wiphy *wiphy, 9024 struct iface_combination_params *params, 9025 void (*iter)(const struct ieee80211_iface_combination *c, 9026 void *data), 9027 void *data); 9028 9029 /* 9030 * cfg80211_stop_iface - trigger interface disconnection 9031 * 9032 * @wiphy: the wiphy 9033 * @wdev: wireless device 9034 * @gfp: context flags 9035 * 9036 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA 9037 * disconnected. 9038 * 9039 * Note: This doesn't need any locks and is asynchronous. 9040 */ 9041 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev, 9042 gfp_t gfp); 9043 9044 /** 9045 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy 9046 * @wiphy: the wiphy to shut down 9047 * 9048 * This function shuts down all interfaces belonging to this wiphy by 9049 * calling dev_close() (and treating non-netdev interfaces as needed). 9050 * It shouldn't really be used unless there are some fatal device errors 9051 * that really can't be recovered in any other way. 9052 * 9053 * Callers must hold the RTNL and be able to deal with callbacks into 9054 * the driver while the function is running. 9055 */ 9056 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy); 9057 9058 /** 9059 * wiphy_ext_feature_set - set the extended feature flag 9060 * 9061 * @wiphy: the wiphy to modify. 9062 * @ftidx: extended feature bit index. 9063 * 9064 * The extended features are flagged in multiple bytes (see 9065 * &struct wiphy.@ext_features) 9066 */ 9067 static inline void wiphy_ext_feature_set(struct wiphy *wiphy, 9068 enum nl80211_ext_feature_index ftidx) 9069 { 9070 u8 *ft_byte; 9071 9072 ft_byte = &wiphy->ext_features[ftidx / 8]; 9073 *ft_byte |= BIT(ftidx % 8); 9074 } 9075 9076 /** 9077 * wiphy_ext_feature_isset - check the extended feature flag 9078 * 9079 * @wiphy: the wiphy to modify. 9080 * @ftidx: extended feature bit index. 9081 * 9082 * The extended features are flagged in multiple bytes (see 9083 * &struct wiphy.@ext_features) 9084 */ 9085 static inline bool 9086 wiphy_ext_feature_isset(struct wiphy *wiphy, 9087 enum nl80211_ext_feature_index ftidx) 9088 { 9089 u8 ft_byte; 9090 9091 ft_byte = wiphy->ext_features[ftidx / 8]; 9092 return (ft_byte & BIT(ftidx % 8)) != 0; 9093 } 9094 9095 /** 9096 * cfg80211_free_nan_func - free NAN function 9097 * @f: NAN function that should be freed 9098 * 9099 * Frees all the NAN function and all it's allocated members. 9100 */ 9101 void cfg80211_free_nan_func(struct cfg80211_nan_func *f); 9102 9103 /** 9104 * struct cfg80211_nan_match_params - NAN match parameters 9105 * @type: the type of the function that triggered a match. If it is 9106 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber. 9107 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery 9108 * result. 9109 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up. 9110 * @inst_id: the local instance id 9111 * @peer_inst_id: the instance id of the peer's function 9112 * @addr: the MAC address of the peer 9113 * @info_len: the length of the &info 9114 * @info: the Service Specific Info from the peer (if any) 9115 * @cookie: unique identifier of the corresponding function 9116 */ 9117 struct cfg80211_nan_match_params { 9118 enum nl80211_nan_function_type type; 9119 u8 inst_id; 9120 u8 peer_inst_id; 9121 const u8 *addr; 9122 u8 info_len; 9123 const u8 *info; 9124 u64 cookie; 9125 }; 9126 9127 /** 9128 * cfg80211_nan_match - report a match for a NAN function. 9129 * @wdev: the wireless device reporting the match 9130 * @match: match notification parameters 9131 * @gfp: allocation flags 9132 * 9133 * This function reports that the a NAN function had a match. This 9134 * can be a subscribe that had a match or a solicited publish that 9135 * was sent. It can also be a follow up that was received. 9136 */ 9137 void cfg80211_nan_match(struct wireless_dev *wdev, 9138 struct cfg80211_nan_match_params *match, gfp_t gfp); 9139 9140 /** 9141 * cfg80211_nan_func_terminated - notify about NAN function termination. 9142 * 9143 * @wdev: the wireless device reporting the match 9144 * @inst_id: the local instance id 9145 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*) 9146 * @cookie: unique NAN function identifier 9147 * @gfp: allocation flags 9148 * 9149 * This function reports that the a NAN function is terminated. 9150 */ 9151 void cfg80211_nan_func_terminated(struct wireless_dev *wdev, 9152 u8 inst_id, 9153 enum nl80211_nan_func_term_reason reason, 9154 u64 cookie, gfp_t gfp); 9155 9156 /* ethtool helper */ 9157 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info); 9158 9159 /** 9160 * cfg80211_external_auth_request - userspace request for authentication 9161 * @netdev: network device 9162 * @params: External authentication parameters 9163 * @gfp: allocation flags 9164 * Returns: 0 on success, < 0 on error 9165 */ 9166 int cfg80211_external_auth_request(struct net_device *netdev, 9167 struct cfg80211_external_auth_params *params, 9168 gfp_t gfp); 9169 9170 /** 9171 * cfg80211_pmsr_report - report peer measurement result data 9172 * @wdev: the wireless device reporting the measurement 9173 * @req: the original measurement request 9174 * @result: the result data 9175 * @gfp: allocation flags 9176 */ 9177 void cfg80211_pmsr_report(struct wireless_dev *wdev, 9178 struct cfg80211_pmsr_request *req, 9179 struct cfg80211_pmsr_result *result, 9180 gfp_t gfp); 9181 9182 /** 9183 * cfg80211_pmsr_complete - report peer measurement completed 9184 * @wdev: the wireless device reporting the measurement 9185 * @req: the original measurement request 9186 * @gfp: allocation flags 9187 * 9188 * Report that the entire measurement completed, after this 9189 * the request pointer will no longer be valid. 9190 */ 9191 void cfg80211_pmsr_complete(struct wireless_dev *wdev, 9192 struct cfg80211_pmsr_request *req, 9193 gfp_t gfp); 9194 9195 /** 9196 * cfg80211_iftype_allowed - check whether the interface can be allowed 9197 * @wiphy: the wiphy 9198 * @iftype: interface type 9199 * @is_4addr: use_4addr flag, must be '0' when check_swif is '1' 9200 * @check_swif: check iftype against software interfaces 9201 * 9202 * Check whether the interface is allowed to operate; additionally, this API 9203 * can be used to check iftype against the software interfaces when 9204 * check_swif is '1'. 9205 */ 9206 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype, 9207 bool is_4addr, u8 check_swif); 9208 9209 9210 /** 9211 * cfg80211_assoc_comeback - notification of association that was 9212 * temporarily rejected with a comeback 9213 * @netdev: network device 9214 * @ap_addr: AP (MLD) address that rejected the association 9215 * @timeout: timeout interval value TUs. 9216 * 9217 * this function may sleep. the caller must hold the corresponding wdev's mutex. 9218 */ 9219 void cfg80211_assoc_comeback(struct net_device *netdev, 9220 const u8 *ap_addr, u32 timeout); 9221 9222 /* Logging, debugging and troubleshooting/diagnostic helpers. */ 9223 9224 /* wiphy_printk helpers, similar to dev_printk */ 9225 9226 #define wiphy_printk(level, wiphy, format, args...) \ 9227 dev_printk(level, &(wiphy)->dev, format, ##args) 9228 #define wiphy_emerg(wiphy, format, args...) \ 9229 dev_emerg(&(wiphy)->dev, format, ##args) 9230 #define wiphy_alert(wiphy, format, args...) \ 9231 dev_alert(&(wiphy)->dev, format, ##args) 9232 #define wiphy_crit(wiphy, format, args...) \ 9233 dev_crit(&(wiphy)->dev, format, ##args) 9234 #define wiphy_err(wiphy, format, args...) \ 9235 dev_err(&(wiphy)->dev, format, ##args) 9236 #define wiphy_warn(wiphy, format, args...) \ 9237 dev_warn(&(wiphy)->dev, format, ##args) 9238 #define wiphy_notice(wiphy, format, args...) \ 9239 dev_notice(&(wiphy)->dev, format, ##args) 9240 #define wiphy_info(wiphy, format, args...) \ 9241 dev_info(&(wiphy)->dev, format, ##args) 9242 #define wiphy_info_once(wiphy, format, args...) \ 9243 dev_info_once(&(wiphy)->dev, format, ##args) 9244 9245 #define wiphy_err_ratelimited(wiphy, format, args...) \ 9246 dev_err_ratelimited(&(wiphy)->dev, format, ##args) 9247 #define wiphy_warn_ratelimited(wiphy, format, args...) \ 9248 dev_warn_ratelimited(&(wiphy)->dev, format, ##args) 9249 9250 #define wiphy_debug(wiphy, format, args...) \ 9251 wiphy_printk(KERN_DEBUG, wiphy, format, ##args) 9252 9253 #define wiphy_dbg(wiphy, format, args...) \ 9254 dev_dbg(&(wiphy)->dev, format, ##args) 9255 9256 #if defined(VERBOSE_DEBUG) 9257 #define wiphy_vdbg wiphy_dbg 9258 #else 9259 #define wiphy_vdbg(wiphy, format, args...) \ 9260 ({ \ 9261 if (0) \ 9262 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \ 9263 0; \ 9264 }) 9265 #endif 9266 9267 /* 9268 * wiphy_WARN() acts like wiphy_printk(), but with the key difference 9269 * of using a WARN/WARN_ON to get the message out, including the 9270 * file/line information and a backtrace. 9271 */ 9272 #define wiphy_WARN(wiphy, format, args...) \ 9273 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args); 9274 9275 /** 9276 * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space 9277 * @netdev: network device 9278 * @owe_info: peer's owe info 9279 * @gfp: allocation flags 9280 */ 9281 void cfg80211_update_owe_info_event(struct net_device *netdev, 9282 struct cfg80211_update_owe_info *owe_info, 9283 gfp_t gfp); 9284 9285 /** 9286 * cfg80211_bss_flush - resets all the scan entries 9287 * @wiphy: the wiphy 9288 */ 9289 void cfg80211_bss_flush(struct wiphy *wiphy); 9290 9291 /** 9292 * cfg80211_bss_color_notify - notify about bss color event 9293 * @dev: network device 9294 * @cmd: the actual event we want to notify 9295 * @count: the number of TBTTs until the color change happens 9296 * @color_bitmap: representations of the colors that the local BSS is aware of 9297 */ 9298 int cfg80211_bss_color_notify(struct net_device *dev, 9299 enum nl80211_commands cmd, u8 count, 9300 u64 color_bitmap); 9301 9302 /** 9303 * cfg80211_obss_color_collision_notify - notify about bss color collision 9304 * @dev: network device 9305 * @color_bitmap: representations of the colors that the local BSS is aware of 9306 */ 9307 static inline int cfg80211_obss_color_collision_notify(struct net_device *dev, 9308 u64 color_bitmap) 9309 { 9310 return cfg80211_bss_color_notify(dev, NL80211_CMD_OBSS_COLOR_COLLISION, 9311 0, color_bitmap); 9312 } 9313 9314 /** 9315 * cfg80211_color_change_started_notify - notify color change start 9316 * @dev: the device on which the color is switched 9317 * @count: the number of TBTTs until the color change happens 9318 * 9319 * Inform the userspace about the color change that has started. 9320 */ 9321 static inline int cfg80211_color_change_started_notify(struct net_device *dev, 9322 u8 count) 9323 { 9324 return cfg80211_bss_color_notify(dev, NL80211_CMD_COLOR_CHANGE_STARTED, 9325 count, 0); 9326 } 9327 9328 /** 9329 * cfg80211_color_change_aborted_notify - notify color change abort 9330 * @dev: the device on which the color is switched 9331 * 9332 * Inform the userspace about the color change that has aborted. 9333 */ 9334 static inline int cfg80211_color_change_aborted_notify(struct net_device *dev) 9335 { 9336 return cfg80211_bss_color_notify(dev, NL80211_CMD_COLOR_CHANGE_ABORTED, 9337 0, 0); 9338 } 9339 9340 /** 9341 * cfg80211_color_change_notify - notify color change completion 9342 * @dev: the device on which the color was switched 9343 * 9344 * Inform the userspace about the color change that has completed. 9345 */ 9346 static inline int cfg80211_color_change_notify(struct net_device *dev) 9347 { 9348 return cfg80211_bss_color_notify(dev, 9349 NL80211_CMD_COLOR_CHANGE_COMPLETED, 9350 0, 0); 9351 } 9352 9353 /** 9354 * cfg80211_valid_disable_subchannel_bitmap - validate puncturing bitmap 9355 * @bitmap: bitmap to be validated 9356 * @chandef: channel definition 9357 * 9358 * Validate the puncturing bitmap. 9359 * 9360 * Return: %true if the bitmap is valid. %false otherwise. 9361 */ 9362 bool cfg80211_valid_disable_subchannel_bitmap(u16 *bitmap, 9363 const struct cfg80211_chan_def *chandef); 9364 9365 /** 9366 * cfg80211_links_removed - Notify about removed STA MLD setup links. 9367 * @dev: network device. 9368 * @link_mask: BIT mask of removed STA MLD setup link IDs. 9369 * 9370 * Inform cfg80211 and the userspace about removed STA MLD setup links due to 9371 * AP MLD removing the corresponding affiliated APs with Multi-Link 9372 * reconfiguration. Note that it's not valid to remove all links, in this 9373 * case disconnect instead. 9374 * Also note that the wdev mutex must be held. 9375 */ 9376 void cfg80211_links_removed(struct net_device *dev, u16 link_mask); 9377 9378 #ifdef CONFIG_CFG80211_DEBUGFS 9379 /** 9380 * wiphy_locked_debugfs_read - do a locked read in debugfs 9381 * @wiphy: the wiphy to use 9382 * @file: the file being read 9383 * @buf: the buffer to fill and then read from 9384 * @bufsize: size of the buffer 9385 * @userbuf: the user buffer to copy to 9386 * @count: read count 9387 * @ppos: read position 9388 * @handler: the read handler to call (under wiphy lock) 9389 * @data: additional data to pass to the read handler 9390 */ 9391 ssize_t wiphy_locked_debugfs_read(struct wiphy *wiphy, struct file *file, 9392 char *buf, size_t bufsize, 9393 char __user *userbuf, size_t count, 9394 loff_t *ppos, 9395 ssize_t (*handler)(struct wiphy *wiphy, 9396 struct file *file, 9397 char *buf, 9398 size_t bufsize, 9399 void *data), 9400 void *data); 9401 9402 /** 9403 * wiphy_locked_debugfs_write - do a locked write in debugfs 9404 * @wiphy: the wiphy to use 9405 * @file: the file being written to 9406 * @buf: the buffer to copy the user data to 9407 * @bufsize: size of the buffer 9408 * @userbuf: the user buffer to copy from 9409 * @count: read count 9410 * @handler: the write handler to call (under wiphy lock) 9411 * @data: additional data to pass to the write handler 9412 */ 9413 ssize_t wiphy_locked_debugfs_write(struct wiphy *wiphy, struct file *file, 9414 char *buf, size_t bufsize, 9415 const char __user *userbuf, size_t count, 9416 ssize_t (*handler)(struct wiphy *wiphy, 9417 struct file *file, 9418 char *buf, 9419 size_t count, 9420 void *data), 9421 void *data); 9422 #endif 9423 9424 #endif /* __NET_CFG80211_H */ 9425