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