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