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