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