blob: 0e4a2a04d55d1ca8545d11ee180528b6b8f4981e [file] [log] [blame]
Johannes Berg704232c2007-04-23 12:20:05 -07001#ifndef __NET_CFG80211_H
2#define __NET_CFG80211_H
Johannes Bergd3236552009-04-20 14:31:42 +02003/*
4 * 802.11 device and configuration interface
5 *
Jouni Malinen026331c2010-02-15 12:53:10 +02006 * Copyright 2006-2010 Johannes Berg <johannes@sipsolutions.net>
Johannes Berg2740f0c2014-09-03 15:24:58 +03007 * Copyright 2013-2014 Intel Mobile Communications GmbH
Luca Coelho85859892017-02-08 15:00:34 +02008 * Copyright 2015-2017 Intel Deutschland GmbH
Haim Dreyfuss19d35772018-03-28 13:24:11 +03009 * Copyright (C) 2018 Intel Corporation
Johannes Bergd3236552009-04-20 14:31:42 +020010 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
14 */
Johannes Berg704232c2007-04-23 12:20:05 -070015
Johannes Bergd3236552009-04-20 14:31:42 +020016#include <linux/netdevice.h>
17#include <linux/debugfs.h>
18#include <linux/list.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050019#include <linux/bug.h>
Johannes Berg704232c2007-04-23 12:20:05 -070020#include <linux/netlink.h>
21#include <linux/skbuff.h>
Johannes Berg55682962007-09-20 13:09:35 -040022#include <linux/nl80211.h>
Johannes Berg2a519312009-02-10 21:25:55 +010023#include <linux/if_ether.h>
24#include <linux/ieee80211.h>
Johannes Berg2a0e0472013-01-23 22:57:40 +010025#include <linux/net.h>
Johannes Bergd3236552009-04-20 14:31:42 +020026#include <net/regulatory.h>
27
Johannes Bergd70e9692010-08-19 16:11:27 +020028/**
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
Johannes Berg9f5e8f62012-11-22 16:59:45 +010065struct wiphy;
66
Johannes Berg704232c2007-04-23 12:20:05 -070067/*
Johannes Bergd3236552009-04-20 14:31:42 +020068 * wireless hardware capability structures
69 */
70
71/**
Johannes Bergd3236552009-04-20 14:31:42 +020072 * 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.
Luis R. Rodriguez8fe02e12013-10-21 19:22:25 +020077 * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
78 * sending probe requests or beaconing.
Johannes Bergd3236552009-04-20 14:31:42 +020079 * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
Luis R. Rodriguez689da1b2009-05-02 00:37:18 -040080 * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
Johannes Bergd3236552009-04-20 14:31:42 +020081 * is not permitted.
Luis R. Rodriguez689da1b2009-05-02 00:37:18 -040082 * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
Johannes Bergd3236552009-04-20 14:31:42 +020083 * is not permitted.
Seth Forshee03f6b082012-08-01 15:58:42 -050084 * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
Johannes Bergc7a6ee22012-12-12 17:50:39 +010085 * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
86 * this flag indicates that an 80 MHz channel cannot use this
87 * channel as the control or any of the secondary channels.
88 * This may be due to the driver or due to regulatory bandwidth
89 * restrictions.
90 * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
91 * this flag indicates that an 160 MHz channel cannot use this
92 * channel as the control or any of the secondary channels.
93 * This may be due to the driver or due to regulatory bandwidth
94 * restrictions.
David Spinadel570dbde2014-02-23 09:12:59 +020095 * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
Arik Nemtsov06f207f2015-05-06 16:28:31 +030096 * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
Rostislav Lisovyea077c12014-04-15 14:37:55 +020097 * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
98 * on this channel.
99 * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
100 * on this channel.
David Spinadel570dbde2014-02-23 09:12:59 +0200101 *
Johannes Bergd3236552009-04-20 14:31:42 +0200102 */
103enum ieee80211_channel_flags {
104 IEEE80211_CHAN_DISABLED = 1<<0,
Luis R. Rodriguez8fe02e12013-10-21 19:22:25 +0200105 IEEE80211_CHAN_NO_IR = 1<<1,
106 /* hole at 1<<2 */
Johannes Bergd3236552009-04-20 14:31:42 +0200107 IEEE80211_CHAN_RADAR = 1<<3,
Luis R. Rodriguez689da1b2009-05-02 00:37:18 -0400108 IEEE80211_CHAN_NO_HT40PLUS = 1<<4,
109 IEEE80211_CHAN_NO_HT40MINUS = 1<<5,
Seth Forshee03f6b082012-08-01 15:58:42 -0500110 IEEE80211_CHAN_NO_OFDM = 1<<6,
Johannes Bergc7a6ee22012-12-12 17:50:39 +0100111 IEEE80211_CHAN_NO_80MHZ = 1<<7,
112 IEEE80211_CHAN_NO_160MHZ = 1<<8,
David Spinadel570dbde2014-02-23 09:12:59 +0200113 IEEE80211_CHAN_INDOOR_ONLY = 1<<9,
Arik Nemtsov06f207f2015-05-06 16:28:31 +0300114 IEEE80211_CHAN_IR_CONCURRENT = 1<<10,
Rostislav Lisovyea077c12014-04-15 14:37:55 +0200115 IEEE80211_CHAN_NO_20MHZ = 1<<11,
116 IEEE80211_CHAN_NO_10MHZ = 1<<12,
Johannes Bergd3236552009-04-20 14:31:42 +0200117};
118
Luis R. Rodriguez038659e2009-05-02 00:37:17 -0400119#define IEEE80211_CHAN_NO_HT40 \
Luis R. Rodriguez689da1b2009-05-02 00:37:18 -0400120 (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
Luis R. Rodriguez038659e2009-05-02 00:37:17 -0400121
Simon Wunderlich04f39042013-02-08 18:16:19 +0100122#define IEEE80211_DFS_MIN_CAC_TIME_MS 60000
123#define IEEE80211_DFS_MIN_NOP_TIME_MS (30 * 60 * 1000)
124
Johannes Bergd3236552009-04-20 14:31:42 +0200125/**
126 * struct ieee80211_channel - channel definition
127 *
128 * This structure describes a single channel for use
129 * with cfg80211.
130 *
131 * @center_freq: center frequency in MHz
Johannes Bergd3236552009-04-20 14:31:42 +0200132 * @hw_value: hardware-specific value for the channel
133 * @flags: channel flags from &enum ieee80211_channel_flags.
134 * @orig_flags: channel flags at registration time, used by regulatory
135 * code to support devices with additional restrictions
136 * @band: band this channel belongs to.
137 * @max_antenna_gain: maximum antenna gain in dBi
138 * @max_power: maximum transmission power (in dBm)
Hong Wueccc0682012-01-11 20:33:39 +0200139 * @max_reg_power: maximum regulatory transmission power (in dBm)
Johannes Bergd3236552009-04-20 14:31:42 +0200140 * @beacon_found: helper to regulatory code to indicate when a beacon
141 * has been found on this channel. Use regulatory_hint_found_beacon()
Walter Goldens77c20612010-05-18 04:44:54 -0700142 * to enable this, this is useful only on 5 GHz band.
Johannes Bergd3236552009-04-20 14:31:42 +0200143 * @orig_mag: internal use
144 * @orig_mpwr: internal use
Simon Wunderlich04f39042013-02-08 18:16:19 +0100145 * @dfs_state: current state of this channel. Only relevant if radar is required
146 * on this channel.
147 * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
Janusz Dziedzic089027e2014-02-21 19:46:12 +0100148 * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
Johannes Bergd3236552009-04-20 14:31:42 +0200149 */
150struct ieee80211_channel {
Johannes Berg57fbcce2016-04-12 15:56:15 +0200151 enum nl80211_band band;
Johannes Bergd3236552009-04-20 14:31:42 +0200152 u16 center_freq;
Johannes Bergd3236552009-04-20 14:31:42 +0200153 u16 hw_value;
154 u32 flags;
155 int max_antenna_gain;
156 int max_power;
Hong Wueccc0682012-01-11 20:33:39 +0200157 int max_reg_power;
Johannes Bergd3236552009-04-20 14:31:42 +0200158 bool beacon_found;
159 u32 orig_flags;
160 int orig_mag, orig_mpwr;
Simon Wunderlich04f39042013-02-08 18:16:19 +0100161 enum nl80211_dfs_state dfs_state;
162 unsigned long dfs_state_entered;
Janusz Dziedzic089027e2014-02-21 19:46:12 +0100163 unsigned int dfs_cac_ms;
Johannes Bergd3236552009-04-20 14:31:42 +0200164};
165
166/**
167 * enum ieee80211_rate_flags - rate flags
168 *
169 * Hardware/specification flags for rates. These are structured
170 * in a way that allows using the same bitrate structure for
171 * different bands/PHY modes.
172 *
173 * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
174 * preamble on this bitrate; only relevant in 2.4GHz band and
175 * with CCK rates.
176 * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
177 * when used with 802.11a (on the 5 GHz band); filled by the
178 * core code when registering the wiphy.
179 * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
180 * when used with 802.11b (on the 2.4 GHz band); filled by the
181 * core code when registering the wiphy.
182 * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
183 * when used with 802.11g (on the 2.4 GHz band); filled by the
184 * core code when registering the wiphy.
185 * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
Simon Wunderlich30e74732013-05-16 13:00:29 +0200186 * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
187 * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
Johannes Bergd3236552009-04-20 14:31:42 +0200188 */
189enum ieee80211_rate_flags {
190 IEEE80211_RATE_SHORT_PREAMBLE = 1<<0,
191 IEEE80211_RATE_MANDATORY_A = 1<<1,
192 IEEE80211_RATE_MANDATORY_B = 1<<2,
193 IEEE80211_RATE_MANDATORY_G = 1<<3,
194 IEEE80211_RATE_ERP_G = 1<<4,
Simon Wunderlich30e74732013-05-16 13:00:29 +0200195 IEEE80211_RATE_SUPPORTS_5MHZ = 1<<5,
196 IEEE80211_RATE_SUPPORTS_10MHZ = 1<<6,
Johannes Bergd3236552009-04-20 14:31:42 +0200197};
198
199/**
Dedy Lansky6eb18132015-02-08 15:52:03 +0200200 * enum ieee80211_bss_type - BSS type filter
201 *
202 * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
203 * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
204 * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
205 * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
206 * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
207 */
208enum ieee80211_bss_type {
209 IEEE80211_BSS_TYPE_ESS,
210 IEEE80211_BSS_TYPE_PBSS,
211 IEEE80211_BSS_TYPE_IBSS,
212 IEEE80211_BSS_TYPE_MBSS,
213 IEEE80211_BSS_TYPE_ANY
214};
215
216/**
217 * enum ieee80211_privacy - BSS privacy filter
218 *
219 * @IEEE80211_PRIVACY_ON: privacy bit set
220 * @IEEE80211_PRIVACY_OFF: privacy bit clear
221 * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
222 */
223enum ieee80211_privacy {
224 IEEE80211_PRIVACY_ON,
225 IEEE80211_PRIVACY_OFF,
226 IEEE80211_PRIVACY_ANY
227};
228
229#define IEEE80211_PRIVACY(x) \
230 ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
231
232/**
Johannes Bergd3236552009-04-20 14:31:42 +0200233 * struct ieee80211_rate - bitrate definition
234 *
235 * This structure describes a bitrate that an 802.11 PHY can
236 * operate with. The two values @hw_value and @hw_value_short
237 * are only for driver use when pointers to this structure are
238 * passed around.
239 *
240 * @flags: rate-specific flags
241 * @bitrate: bitrate in units of 100 Kbps
242 * @hw_value: driver/hardware value for this rate
243 * @hw_value_short: driver/hardware value for this rate when
244 * short preamble is used
245 */
246struct ieee80211_rate {
247 u32 flags;
248 u16 bitrate;
249 u16 hw_value, hw_value_short;
250};
251
252/**
253 * struct ieee80211_sta_ht_cap - STA's HT capabilities
254 *
255 * This structure describes most essential parameters needed
256 * to describe 802.11n HT capabilities for an STA.
257 *
258 * @ht_supported: is HT supported by the STA
259 * @cap: HT capabilities map as described in 802.11n spec
260 * @ampdu_factor: Maximum A-MPDU length factor
261 * @ampdu_density: Minimum A-MPDU spacing
262 * @mcs: Supported MCS rates
263 */
264struct ieee80211_sta_ht_cap {
265 u16 cap; /* use IEEE80211_HT_CAP_ */
266 bool ht_supported;
267 u8 ampdu_factor;
268 u8 ampdu_density;
269 struct ieee80211_mcs_info mcs;
270};
271
272/**
Mahesh Palivelabf0c111e2012-06-22 07:27:46 +0000273 * struct ieee80211_sta_vht_cap - STA's VHT capabilities
274 *
275 * This structure describes most essential parameters needed
276 * to describe 802.11ac VHT capabilities for an STA.
277 *
278 * @vht_supported: is VHT supported by the STA
279 * @cap: VHT capabilities map as described in 802.11ac spec
280 * @vht_mcs: Supported VHT MCS rates
281 */
282struct ieee80211_sta_vht_cap {
283 bool vht_supported;
284 u32 cap; /* use IEEE80211_VHT_CAP_ */
285 struct ieee80211_vht_mcs_info vht_mcs;
286};
287
288/**
Johannes Bergd3236552009-04-20 14:31:42 +0200289 * struct ieee80211_supported_band - frequency band definition
290 *
291 * This structure describes a frequency band a wiphy
292 * is able to operate in.
293 *
294 * @channels: Array of channels the hardware can operate in
295 * in this band.
296 * @band: the band this structure represents
297 * @n_channels: Number of channels in @channels
298 * @bitrates: Array of bitrates the hardware can operate with
299 * in this band. Must be sorted to give a valid "supported
300 * rates" IE, i.e. CCK rates first, then OFDM.
301 * @n_bitrates: Number of bitrates in @bitrates
Johannes Bergabe37c42010-06-07 11:12:27 +0200302 * @ht_cap: HT capabilities in this band
Robert P. J. Dayc9a0a302012-08-26 14:21:47 -0400303 * @vht_cap: VHT capabilities in this band
Johannes Bergd3236552009-04-20 14:31:42 +0200304 */
305struct ieee80211_supported_band {
306 struct ieee80211_channel *channels;
307 struct ieee80211_rate *bitrates;
Johannes Berg57fbcce2016-04-12 15:56:15 +0200308 enum nl80211_band band;
Johannes Bergd3236552009-04-20 14:31:42 +0200309 int n_channels;
310 int n_bitrates;
311 struct ieee80211_sta_ht_cap ht_cap;
Mahesh Palivelabf0c111e2012-06-22 07:27:46 +0000312 struct ieee80211_sta_vht_cap vht_cap;
Johannes Bergd3236552009-04-20 14:31:42 +0200313};
314
Rafał Miłeckie691ac22017-01-04 18:58:31 +0100315/**
316 * wiphy_read_of_freq_limits - read frequency limits from device tree
317 *
318 * @wiphy: the wireless device to get extra limits for
319 *
320 * Some devices may have extra limitations specified in DT. This may be useful
321 * for chipsets that normally support more bands but are limited due to board
322 * design (e.g. by antennas or external power amplifier).
323 *
324 * This function reads info from DT and uses it to *modify* channels (disable
325 * unavailable ones). It's usually a *bad* idea to use it in drivers with
326 * shared channel data as DT limitations are device specific. You should make
327 * sure to call it only if channels in wiphy are copied and can be modified
328 * without affecting other devices.
329 *
330 * As this function access device node it has to be called after set_wiphy_dev.
331 * It also modifies channels so they have to be set first.
332 * If using this helper, call it before wiphy_register().
333 */
334#ifdef CONFIG_OF
335void wiphy_read_of_freq_limits(struct wiphy *wiphy);
336#else /* CONFIG_OF */
337static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
338{
339}
340#endif /* !CONFIG_OF */
341
342
Johannes Bergd3236552009-04-20 14:31:42 +0200343/*
344 * Wireless hardware/device configuration structures and methods
Johannes Berg704232c2007-04-23 12:20:05 -0700345 */
346
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +0100347/**
Johannes Bergd70e9692010-08-19 16:11:27 +0200348 * DOC: Actions and configuration
349 *
350 * Each wireless device and each virtual interface offer a set of configuration
351 * operations and other actions that are invoked by userspace. Each of these
352 * actions is described in the operations structure, and the parameters these
353 * operations use are described separately.
354 *
355 * Additionally, some operations are asynchronous and expect to get status
356 * information via some functions that drivers need to call.
357 *
358 * Scanning and BSS list handling with its associated functionality is described
359 * in a separate chapter.
360 */
361
Aviya Erenfeldc6e6a0c2016-07-05 15:23:08 +0300362#define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
363 WLAN_USER_POSITION_LEN)
364
Johannes Bergd70e9692010-08-19 16:11:27 +0200365/**
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +0100366 * struct vif_params - describes virtual interface parameters
Johannes Berg818a9862017-04-12 11:23:28 +0200367 * @flags: monitor interface flags, unchanged if 0, otherwise
368 * %MONITOR_FLAG_CHANGED will be set
Felix Fietkau8b787642009-11-10 18:53:10 +0100369 * @use_4addr: use 4-address frames
Ben Greeare8f479b2014-10-22 12:23:05 -0700370 * @macaddr: address to use for this virtual interface.
371 * If this parameter is set to zero address the driver may
372 * determine the address as needed.
373 * This feature is only fully supported by drivers that enable the
374 * %NL80211_FEATURE_MAC_ON_CREATE flag. Others may support creating
375 ** only p2p devices with specified MAC.
Johannes Bergb0265022017-04-12 10:43:49 +0200376 * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
377 * belonging to that MU-MIMO groupID; %NULL if not changed
378 * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
379 * MU-MIMO packets going to the specified station; %NULL if not changed
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +0100380 */
381struct vif_params {
Johannes Berg818a9862017-04-12 11:23:28 +0200382 u32 flags;
Aviya Erenfeldc6e6a0c2016-07-05 15:23:08 +0300383 int use_4addr;
384 u8 macaddr[ETH_ALEN];
Johannes Bergb0265022017-04-12 10:43:49 +0200385 const u8 *vht_mumimo_groups;
386 const u8 *vht_mumimo_follow_addr;
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +0100387};
388
Andy Green179f8312007-07-10 19:29:38 +0200389/**
Johannes Berg41ade002007-12-19 02:03:29 +0100390 * struct key_params - key information
391 *
392 * Information about a key
393 *
394 * @key: key material
395 * @key_len: length of key material
396 * @cipher: cipher suite selector
397 * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
398 * with the get_key() callback, must be in little endian,
399 * length given by @seq_len.
Johannes Bergabe37c42010-06-07 11:12:27 +0200400 * @seq_len: length of @seq.
Johannes Berg41ade002007-12-19 02:03:29 +0100401 */
402struct key_params {
Johannes Bergc1e5f472014-05-19 17:53:16 +0200403 const u8 *key;
404 const u8 *seq;
Johannes Berg41ade002007-12-19 02:03:29 +0100405 int key_len;
406 int seq_len;
407 u32 cipher;
408};
409
Johannes Berged1b6cc2007-12-19 02:03:32 +0100410/**
Johannes Berg683b6d32012-11-08 21:25:48 +0100411 * struct cfg80211_chan_def - channel definition
412 * @chan: the (control) channel
Johannes Berg3d9d1d62012-11-08 23:14:50 +0100413 * @width: channel width
414 * @center_freq1: center frequency of first segment
415 * @center_freq2: center frequency of second segment
416 * (only with 80+80 MHz)
Johannes Berg683b6d32012-11-08 21:25:48 +0100417 */
418struct cfg80211_chan_def {
419 struct ieee80211_channel *chan;
Johannes Berg3d9d1d62012-11-08 23:14:50 +0100420 enum nl80211_chan_width width;
421 u32 center_freq1;
422 u32 center_freq2;
Johannes Berg683b6d32012-11-08 21:25:48 +0100423};
424
Johannes Berg3d9d1d62012-11-08 23:14:50 +0100425/**
426 * cfg80211_get_chandef_type - return old channel type from chandef
427 * @chandef: the channel definition
428 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +0100429 * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
Johannes Berg3d9d1d62012-11-08 23:14:50 +0100430 * chandef, which must have a bandwidth allowing this conversion.
431 */
Johannes Berg683b6d32012-11-08 21:25:48 +0100432static inline enum nl80211_channel_type
433cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
434{
Johannes Berg3d9d1d62012-11-08 23:14:50 +0100435 switch (chandef->width) {
436 case NL80211_CHAN_WIDTH_20_NOHT:
437 return NL80211_CHAN_NO_HT;
438 case NL80211_CHAN_WIDTH_20:
439 return NL80211_CHAN_HT20;
440 case NL80211_CHAN_WIDTH_40:
441 if (chandef->center_freq1 > chandef->chan->center_freq)
442 return NL80211_CHAN_HT40PLUS;
443 return NL80211_CHAN_HT40MINUS;
444 default:
445 WARN_ON(1);
446 return NL80211_CHAN_NO_HT;
447 }
Johannes Berg683b6d32012-11-08 21:25:48 +0100448}
449
450/**
Johannes Berg3d9d1d62012-11-08 23:14:50 +0100451 * cfg80211_chandef_create - create channel definition using channel type
452 * @chandef: the channel definition struct to fill
453 * @channel: the control channel
454 * @chantype: the channel type
455 *
456 * Given a channel type, create a channel definition.
457 */
458void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
459 struct ieee80211_channel *channel,
460 enum nl80211_channel_type chantype);
461
462/**
463 * cfg80211_chandef_identical - check if two channel definitions are identical
464 * @chandef1: first channel definition
465 * @chandef2: second channel definition
466 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +0100467 * Return: %true if the channels defined by the channel definitions are
Johannes Berg3d9d1d62012-11-08 23:14:50 +0100468 * identical, %false otherwise.
469 */
470static inline bool
471cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
472 const struct cfg80211_chan_def *chandef2)
473{
474 return (chandef1->chan == chandef2->chan &&
475 chandef1->width == chandef2->width &&
476 chandef1->center_freq1 == chandef2->center_freq1 &&
477 chandef1->center_freq2 == chandef2->center_freq2);
478}
479
480/**
481 * cfg80211_chandef_compatible - check if two channel definitions are compatible
482 * @chandef1: first channel definition
483 * @chandef2: second channel definition
484 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +0100485 * Return: %NULL if the given channel definitions are incompatible,
Johannes Berg3d9d1d62012-11-08 23:14:50 +0100486 * chandef1 or chandef2 otherwise.
487 */
488const struct cfg80211_chan_def *
489cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
490 const struct cfg80211_chan_def *chandef2);
491
492/**
Johannes Berg9f5e8f62012-11-22 16:59:45 +0100493 * cfg80211_chandef_valid - check if a channel definition is valid
494 * @chandef: the channel definition to check
Yacine Belkadi0ae997d2013-01-12 13:54:14 +0100495 * Return: %true if the channel definition is valid. %false otherwise.
Johannes Berg9f5e8f62012-11-22 16:59:45 +0100496 */
497bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
498
499/**
500 * cfg80211_chandef_usable - check if secondary channels can be used
501 * @wiphy: the wiphy to validate against
502 * @chandef: the channel definition to check
Yacine Belkadi0ae997d2013-01-12 13:54:14 +0100503 * @prohibited_flags: the regulatory channel flags that must not be set
504 * Return: %true if secondary channels are usable. %false otherwise.
Johannes Berg9f5e8f62012-11-22 16:59:45 +0100505 */
506bool cfg80211_chandef_usable(struct wiphy *wiphy,
507 const struct cfg80211_chan_def *chandef,
508 u32 prohibited_flags);
509
510/**
Simon Wunderlich774f0732013-08-28 13:41:28 +0200511 * cfg80211_chandef_dfs_required - checks if radar detection is required
512 * @wiphy: the wiphy to validate against
513 * @chandef: the channel definition to check
Luciano Coelho2beb6dab2014-02-18 11:40:36 +0200514 * @iftype: the interface type as specified in &enum nl80211_iftype
515 * Returns:
516 * 1 if radar detection is required, 0 if it is not, < 0 on error
Simon Wunderlich774f0732013-08-28 13:41:28 +0200517 */
518int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
Luciano Coelho2beb6dab2014-02-18 11:40:36 +0200519 const struct cfg80211_chan_def *chandef,
Luciano Coelhoc3d62032014-05-07 19:07:05 +0300520 enum nl80211_iftype iftype);
Simon Wunderlich774f0732013-08-28 13:41:28 +0200521
522/**
Simon Wunderlich30e74732013-05-16 13:00:29 +0200523 * ieee80211_chandef_rate_flags - returns rate flags for a channel
524 *
525 * In some channel types, not all rates may be used - for example CCK
526 * rates may not be used in 5/10 MHz channels.
527 *
528 * @chandef: channel definition for the channel
529 *
530 * Returns: rate flags which apply for this channel
531 */
532static inline enum ieee80211_rate_flags
533ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
534{
535 switch (chandef->width) {
536 case NL80211_CHAN_WIDTH_5:
537 return IEEE80211_RATE_SUPPORTS_5MHZ;
538 case NL80211_CHAN_WIDTH_10:
539 return IEEE80211_RATE_SUPPORTS_10MHZ;
540 default:
541 break;
542 }
543 return 0;
544}
545
546/**
Simon Wunderlich0430c882013-07-08 16:55:55 +0200547 * ieee80211_chandef_max_power - maximum transmission power for the chandef
548 *
549 * In some regulations, the transmit power may depend on the configured channel
550 * bandwidth which may be defined as dBm/MHz. This function returns the actual
551 * max_power for non-standard (20 MHz) channels.
552 *
553 * @chandef: channel definition for the channel
554 *
555 * Returns: maximum allowed transmission power in dBm for the chandef
556 */
557static inline int
558ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
559{
560 switch (chandef->width) {
561 case NL80211_CHAN_WIDTH_5:
562 return min(chandef->chan->max_reg_power - 6,
563 chandef->chan->max_power);
564 case NL80211_CHAN_WIDTH_10:
565 return min(chandef->chan->max_reg_power - 3,
566 chandef->chan->max_power);
567 default:
568 break;
569 }
570 return chandef->chan->max_power;
571}
572
573/**
Holger Schurig61fa7132009-11-11 12:25:40 +0100574 * enum survey_info_flags - survey information flags
575 *
Johannes Bergabe37c42010-06-07 11:12:27 +0200576 * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
Felix Fietkau17e5a802010-09-29 17:15:30 +0200577 * @SURVEY_INFO_IN_USE: channel is currently being used
Johannes Berg4ed20be2014-11-14 16:35:34 +0100578 * @SURVEY_INFO_TIME: active time (in ms) was filled in
579 * @SURVEY_INFO_TIME_BUSY: busy time was filled in
580 * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
581 * @SURVEY_INFO_TIME_RX: receive time was filled in
582 * @SURVEY_INFO_TIME_TX: transmit time was filled in
Johannes Berg052536a2014-11-14 16:44:11 +0100583 * @SURVEY_INFO_TIME_SCAN: scan time was filled in
Johannes Bergabe37c42010-06-07 11:12:27 +0200584 *
Holger Schurig61fa7132009-11-11 12:25:40 +0100585 * Used by the driver to indicate which info in &struct survey_info
586 * it has filled in during the get_survey().
587 */
588enum survey_info_flags {
Johannes Berg4ed20be2014-11-14 16:35:34 +0100589 SURVEY_INFO_NOISE_DBM = BIT(0),
590 SURVEY_INFO_IN_USE = BIT(1),
591 SURVEY_INFO_TIME = BIT(2),
592 SURVEY_INFO_TIME_BUSY = BIT(3),
593 SURVEY_INFO_TIME_EXT_BUSY = BIT(4),
594 SURVEY_INFO_TIME_RX = BIT(5),
595 SURVEY_INFO_TIME_TX = BIT(6),
Johannes Berg052536a2014-11-14 16:44:11 +0100596 SURVEY_INFO_TIME_SCAN = BIT(7),
Holger Schurig61fa7132009-11-11 12:25:40 +0100597};
598
599/**
600 * struct survey_info - channel survey response
601 *
Johannes Berg11f78ac2014-11-14 16:43:50 +0100602 * @channel: the channel this survey record reports, may be %NULL for a single
603 * record to report global statistics
Holger Schurig61fa7132009-11-11 12:25:40 +0100604 * @filled: bitflag of flags from &enum survey_info_flags
605 * @noise: channel noise in dBm. This and all following fields are
Johannes Bergad24b0d2013-07-05 11:53:28 +0200606 * optional
Johannes Berg4ed20be2014-11-14 16:35:34 +0100607 * @time: amount of time in ms the radio was turn on (on the channel)
608 * @time_busy: amount of time the primary channel was sensed busy
609 * @time_ext_busy: amount of time the extension channel was sensed busy
610 * @time_rx: amount of time the radio spent receiving data
611 * @time_tx: amount of time the radio spent transmitting data
Johannes Berg052536a2014-11-14 16:44:11 +0100612 * @time_scan: amount of time the radio spent for scanning
Holger Schurig61fa7132009-11-11 12:25:40 +0100613 *
Johannes Bergabe37c42010-06-07 11:12:27 +0200614 * Used by dump_survey() to report back per-channel survey information.
615 *
Holger Schurig61fa7132009-11-11 12:25:40 +0100616 * This structure can later be expanded with things like
617 * channel duty cycle etc.
618 */
619struct survey_info {
620 struct ieee80211_channel *channel;
Johannes Berg4ed20be2014-11-14 16:35:34 +0100621 u64 time;
622 u64 time_busy;
623 u64 time_ext_busy;
624 u64 time_rx;
625 u64 time_tx;
Johannes Berg052536a2014-11-14 16:44:11 +0100626 u64 time_scan;
Holger Schurig61fa7132009-11-11 12:25:40 +0100627 u32 filled;
628 s8 noise;
629};
630
David Spinadelb8676222016-09-22 23:16:50 +0300631#define CFG80211_MAX_WEP_KEYS 4
632
Holger Schurig61fa7132009-11-11 12:25:40 +0100633/**
Jouni Malinen5fb628e2011-08-10 23:54:35 +0300634 * struct cfg80211_crypto_settings - Crypto settings
635 * @wpa_versions: indicates which, if any, WPA versions are enabled
636 * (from enum nl80211_wpa_versions)
637 * @cipher_group: group key cipher suite (or 0 if unset)
638 * @n_ciphers_pairwise: number of AP supported unicast ciphers
639 * @ciphers_pairwise: unicast key cipher suites
640 * @n_akm_suites: number of AKM suites
641 * @akm_suites: AKM suites
642 * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
643 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
644 * required to assume that the port is unauthorized until authorized by
645 * user space. Otherwise, port is marked authorized by default.
646 * @control_port_ethertype: the control port protocol that should be
647 * allowed through even on unauthorized ports
648 * @control_port_no_encrypt: TRUE to prevent encryption of control port
649 * protocol frames.
Denis Kenzior64bf3d42018-03-26 12:52:43 -0500650 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
651 * port frames over NL80211 instead of the network interface.
David Spinadelb8676222016-09-22 23:16:50 +0300652 * @wep_keys: static WEP keys, if not NULL points to an array of
653 * CFG80211_MAX_WEP_KEYS WEP keys
654 * @wep_tx_key: key index (0..3) of the default TX static WEP key
Eliad Peller91b5ab62017-06-09 13:08:42 +0100655 * @psk: PSK (for devices supporting 4-way-handshake offload)
Jouni Malinen5fb628e2011-08-10 23:54:35 +0300656 */
657struct cfg80211_crypto_settings {
658 u32 wpa_versions;
659 u32 cipher_group;
660 int n_ciphers_pairwise;
661 u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
662 int n_akm_suites;
663 u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
664 bool control_port;
665 __be16 control_port_ethertype;
666 bool control_port_no_encrypt;
Denis Kenzior64bf3d42018-03-26 12:52:43 -0500667 bool control_port_over_nl80211;
David Spinadelb8676222016-09-22 23:16:50 +0300668 struct key_params *wep_keys;
669 int wep_tx_key;
Eliad Peller91b5ab62017-06-09 13:08:42 +0100670 const u8 *psk;
Jouni Malinen5fb628e2011-08-10 23:54:35 +0300671};
672
673/**
Johannes Berg88600202012-02-13 15:17:18 +0100674 * struct cfg80211_beacon_data - beacon data
Johannes Berged1b6cc2007-12-19 02:03:32 +0100675 * @head: head portion of beacon (before TIM IE)
Johannes Bergad24b0d2013-07-05 11:53:28 +0200676 * or %NULL if not changed
Johannes Berged1b6cc2007-12-19 02:03:32 +0100677 * @tail: tail portion of beacon (after TIM IE)
Johannes Bergad24b0d2013-07-05 11:53:28 +0200678 * or %NULL if not changed
Johannes Berged1b6cc2007-12-19 02:03:32 +0100679 * @head_len: length of @head
680 * @tail_len: length of @tail
Jouni Malinen9946ecf2011-08-10 23:55:56 +0300681 * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
682 * @beacon_ies_len: length of beacon_ies in octets
683 * @proberesp_ies: extra information element(s) to add into Probe Response
684 * frames or %NULL
685 * @proberesp_ies_len: length of proberesp_ies in octets
686 * @assocresp_ies: extra information element(s) to add into (Re)Association
687 * Response frames or %NULL
688 * @assocresp_ies_len: length of assocresp_ies in octets
Arik Nemtsov00f740e2011-11-10 11:28:56 +0200689 * @probe_resp_len: length of probe response template (@probe_resp)
690 * @probe_resp: probe response template (AP mode only)
Johannes Berged1b6cc2007-12-19 02:03:32 +0100691 */
Johannes Berg88600202012-02-13 15:17:18 +0100692struct cfg80211_beacon_data {
693 const u8 *head, *tail;
694 const u8 *beacon_ies;
695 const u8 *proberesp_ies;
696 const u8 *assocresp_ies;
697 const u8 *probe_resp;
698
699 size_t head_len, tail_len;
700 size_t beacon_ies_len;
701 size_t proberesp_ies_len;
702 size_t assocresp_ies_len;
703 size_t probe_resp_len;
704};
705
Vasanthakumar Thiagarajan6d45a742013-01-18 11:18:44 +0530706struct mac_address {
707 u8 addr[ETH_ALEN];
708};
709
Johannes Berg88600202012-02-13 15:17:18 +0100710/**
Vasanthakumar Thiagarajan77765ea2013-01-18 11:18:45 +0530711 * struct cfg80211_acl_data - Access control list data
712 *
713 * @acl_policy: ACL policy to be applied on the station's
Johannes Berg077f8972013-02-08 09:06:36 +0100714 * entry specified by mac_addr
Vasanthakumar Thiagarajan77765ea2013-01-18 11:18:45 +0530715 * @n_acl_entries: Number of MAC address entries passed
716 * @mac_addrs: List of MAC addresses of stations to be used for ACL
717 */
718struct cfg80211_acl_data {
719 enum nl80211_acl_policy acl_policy;
720 int n_acl_entries;
721
722 /* Keep it last */
723 struct mac_address mac_addrs[];
724};
725
Purushottam Kushwahaa7c7fbf2016-09-14 17:38:44 +0530726/*
727 * cfg80211_bitrate_mask - masks for bitrate control
728 */
729struct cfg80211_bitrate_mask {
730 struct {
731 u32 legacy;
732 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
733 u16 vht_mcs[NL80211_VHT_NSS_MAX];
734 enum nl80211_txrate_gi gi;
735 } control[NUM_NL80211_BANDS];
736};
737
Johannes Berg88600202012-02-13 15:17:18 +0100738/**
739 * struct cfg80211_ap_settings - AP configuration
740 *
741 * Used to configure an AP interface.
742 *
Johannes Berg683b6d32012-11-08 21:25:48 +0100743 * @chandef: defines the channel to use
Johannes Berg88600202012-02-13 15:17:18 +0100744 * @beacon: beacon data
745 * @beacon_interval: beacon interval
746 * @dtim_period: DTIM period
747 * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
748 * user space)
749 * @ssid_len: length of @ssid
750 * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
751 * @crypto: crypto settings
752 * @privacy: the BSS uses privacy
753 * @auth_type: Authentication type (algorithm)
Eliad Peller18998c32014-09-10 14:07:34 +0300754 * @smps_mode: SMPS mode
Vasanthakumar Thiagarajan1b658f12012-03-02 15:50:02 +0530755 * @inactivity_timeout: time in seconds to determine station's inactivity.
Johannes Berg53cabad2012-11-14 15:17:28 +0100756 * @p2p_ctwindow: P2P CT Window
757 * @p2p_opp_ps: P2P opportunistic PS
Vasanthakumar Thiagarajan77765ea2013-01-18 11:18:45 +0530758 * @acl: ACL configuration used by the drivers which has support for
759 * MAC address based access control
Lior David34d50512016-01-28 10:58:25 +0200760 * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
761 * networks.
Johannes Berg8564e382016-09-19 09:44:44 +0200762 * @beacon_rate: bitrate to be used for beacons
Johannes Berg66cd7942017-02-07 22:40:44 +0200763 * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
764 * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
765 * @ht_required: stations must support HT
766 * @vht_required: stations must support VHT
Johannes Berg88600202012-02-13 15:17:18 +0100767 */
768struct cfg80211_ap_settings {
Johannes Berg683b6d32012-11-08 21:25:48 +0100769 struct cfg80211_chan_def chandef;
Johannes Bergaa430da2012-05-16 23:50:18 +0200770
Johannes Berg88600202012-02-13 15:17:18 +0100771 struct cfg80211_beacon_data beacon;
772
773 int beacon_interval, dtim_period;
Jouni Malinen32e9de82011-08-10 23:53:31 +0300774 const u8 *ssid;
775 size_t ssid_len;
776 enum nl80211_hidden_ssid hidden_ssid;
Jouni Malinen5fb628e2011-08-10 23:54:35 +0300777 struct cfg80211_crypto_settings crypto;
778 bool privacy;
779 enum nl80211_auth_type auth_type;
Eliad Peller18998c32014-09-10 14:07:34 +0300780 enum nl80211_smps_mode smps_mode;
Vasanthakumar Thiagarajan1b658f12012-03-02 15:50:02 +0530781 int inactivity_timeout;
Johannes Berg53cabad2012-11-14 15:17:28 +0100782 u8 p2p_ctwindow;
783 bool p2p_opp_ps;
Vasanthakumar Thiagarajan77765ea2013-01-18 11:18:45 +0530784 const struct cfg80211_acl_data *acl;
Lior David34d50512016-01-28 10:58:25 +0200785 bool pbss;
Purushottam Kushwahaa7c7fbf2016-09-14 17:38:44 +0530786 struct cfg80211_bitrate_mask beacon_rate;
Johannes Berg66cd7942017-02-07 22:40:44 +0200787
788 const struct ieee80211_ht_cap *ht_cap;
789 const struct ieee80211_vht_cap *vht_cap;
790 bool ht_required, vht_required;
Johannes Berged1b6cc2007-12-19 02:03:32 +0100791};
792
Johannes Berg5727ef12007-12-19 02:03:34 +0100793/**
Simon Wunderlich16ef1fe2013-07-11 16:09:05 +0200794 * struct cfg80211_csa_settings - channel switch settings
795 *
796 * Used for channel switch
797 *
798 * @chandef: defines the channel to use after the switch
799 * @beacon_csa: beacon data while performing the switch
Andrei Otcheretianski9a774c72014-05-09 14:11:46 +0300800 * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
801 * @counter_offsets_presp: offsets of the counters within the probe response
802 * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
803 * @n_counter_offsets_presp: number of csa counters in the probe response
Simon Wunderlich16ef1fe2013-07-11 16:09:05 +0200804 * @beacon_after: beacon data to be used on the new channel
805 * @radar_required: whether radar detection is required on the new channel
806 * @block_tx: whether transmissions should be blocked while changing
807 * @count: number of beacons until switch
808 */
809struct cfg80211_csa_settings {
810 struct cfg80211_chan_def chandef;
811 struct cfg80211_beacon_data beacon_csa;
Andrei Otcheretianski9a774c72014-05-09 14:11:46 +0300812 const u16 *counter_offsets_beacon;
813 const u16 *counter_offsets_presp;
814 unsigned int n_counter_offsets_beacon;
815 unsigned int n_counter_offsets_presp;
Simon Wunderlich16ef1fe2013-07-11 16:09:05 +0200816 struct cfg80211_beacon_data beacon_after;
817 bool radar_required;
818 bool block_tx;
819 u8 count;
820};
821
Johannes Berg51a1aaa2018-01-15 09:32:36 +0100822#define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
823
Simon Wunderlich16ef1fe2013-07-11 16:09:05 +0200824/**
Purushottam Kushwahae2273002016-10-12 18:25:35 +0530825 * struct iface_combination_params - input parameters for interface combinations
826 *
827 * Used to pass interface combination parameters
828 *
829 * @num_different_channels: the number of different channels we want
830 * to use for verification
831 * @radar_detect: a bitmap where each bit corresponds to a channel
832 * width where radar detection is needed, as in the definition of
833 * &struct ieee80211_iface_combination.@radar_detect_widths
834 * @iftype_num: array with the number of interfaces of each interface
835 * type. The index is the interface type as specified in &enum
836 * nl80211_iftype.
Johannes Berg4c8dea62016-10-21 14:25:13 +0200837 * @new_beacon_int: set this to the beacon interval of a new interface
838 * that's not operating yet, if such is to be checked as part of
839 * the verification
Purushottam Kushwahae2273002016-10-12 18:25:35 +0530840 */
841struct iface_combination_params {
842 int num_different_channels;
843 u8 radar_detect;
844 int iftype_num[NUM_NL80211_IFTYPES];
Johannes Berg4c8dea62016-10-21 14:25:13 +0200845 u32 new_beacon_int;
Purushottam Kushwahae2273002016-10-12 18:25:35 +0530846};
847
848/**
Johannes Berg3b9ce802011-09-27 20:56:12 +0200849 * enum station_parameters_apply_mask - station parameter values to apply
850 * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
Jouni Malinen9d62a982013-02-14 21:10:13 +0200851 * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
Johannes Bergf8bacc22013-02-14 23:27:01 +0100852 * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
Johannes Berg3b9ce802011-09-27 20:56:12 +0200853 *
854 * Not all station parameters have in-band "no change" signalling,
855 * for those that don't these flags will are used.
856 */
857enum station_parameters_apply_mask {
858 STATION_PARAM_APPLY_UAPSD = BIT(0),
Jouni Malinen9d62a982013-02-14 21:10:13 +0200859 STATION_PARAM_APPLY_CAPABILITY = BIT(1),
Johannes Bergf8bacc22013-02-14 23:27:01 +0100860 STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
Johannes Berg3b9ce802011-09-27 20:56:12 +0200861};
862
863/**
Johannes Berg5727ef12007-12-19 02:03:34 +0100864 * struct station_parameters - station parameters
865 *
866 * Used to change and create a new station.
867 *
868 * @vlan: vlan interface station should belong to
869 * @supported_rates: supported rates in IEEE 802.11 format
870 * (or NULL for no change)
871 * @supported_rates_len: number of supported rates
Johannes Bergeccb8e82009-05-11 21:57:56 +0300872 * @sta_flags_mask: station flags that changed
Johannes Berg819bf592016-10-11 14:56:53 +0200873 * (bitmask of BIT(%NL80211_STA_FLAG_...))
Johannes Bergeccb8e82009-05-11 21:57:56 +0300874 * @sta_flags_set: station flags values
Johannes Berg819bf592016-10-11 14:56:53 +0200875 * (bitmask of BIT(%NL80211_STA_FLAG_...))
Johannes Berg5727ef12007-12-19 02:03:34 +0100876 * @listen_interval: listen interval or -1 for no change
877 * @aid: AID or zero for no change
Masashi Honma7d27a0b2016-07-01 10:19:34 +0900878 * @peer_aid: mesh peer AID or zero for no change
Johannes Bergabe37c42010-06-07 11:12:27 +0200879 * @plink_action: plink action to take
Javier Cardona9c3990a2011-05-03 16:57:11 -0700880 * @plink_state: set the peer link state for a station
Johannes Bergabe37c42010-06-07 11:12:27 +0200881 * @ht_capa: HT capabilities of station
Mahesh Palivelaf461be3e2012-10-11 08:04:52 +0000882 * @vht_capa: VHT capabilities of station
Eliad Peller910868d2011-09-11 09:46:55 +0300883 * @uapsd_queues: bitmap of queues configured for uapsd. same format
884 * as the AC bitmap in the QoS info field
885 * @max_sp: max Service Period. same format as the MAX_SP in the
886 * QoS info field (but already shifted down)
Johannes Bergc26887d2011-11-08 09:20:07 +0100887 * @sta_modify_mask: bitmap indicating which parameters changed
888 * (for those that don't have a natural "no change" value),
889 * see &enum station_parameters_apply_mask
Marco Porsch3b1c5a52013-01-07 16:04:52 +0100890 * @local_pm: local link-specific mesh power save mode (no change when set
891 * to unknown)
Jouni Malinen9d62a982013-02-14 21:10:13 +0200892 * @capability: station capability
893 * @ext_capab: extended capabilities of the station
894 * @ext_capab_len: number of extended capabilities
Sunil Duttc01fc9a2013-10-09 20:45:21 +0530895 * @supported_channels: supported channels in IEEE 802.11 format
896 * @supported_channels_len: number of supported channels
897 * @supported_oper_classes: supported oper classes in IEEE 802.11 format
898 * @supported_oper_classes_len: number of supported operating classes
Marek Kwaczynski60f4a7b2013-12-03 10:04:59 +0100899 * @opmode_notif: operating mode field from Operating Mode Notification
900 * @opmode_notif_used: information if operating mode field is used
Ayala Beker17b94242016-03-17 15:41:38 +0200901 * @support_p2p_ps: information if station supports P2P PS mechanism
Johannes Berg5727ef12007-12-19 02:03:34 +0100902 */
903struct station_parameters {
Johannes Berg2c1aabf2013-02-14 23:33:40 +0100904 const u8 *supported_rates;
Johannes Berg5727ef12007-12-19 02:03:34 +0100905 struct net_device *vlan;
Johannes Bergeccb8e82009-05-11 21:57:56 +0300906 u32 sta_flags_mask, sta_flags_set;
Johannes Berg3b9ce802011-09-27 20:56:12 +0200907 u32 sta_modify_mask;
Johannes Berg5727ef12007-12-19 02:03:34 +0100908 int listen_interval;
909 u16 aid;
Masashi Honma7d27a0b2016-07-01 10:19:34 +0900910 u16 peer_aid;
Johannes Berg5727ef12007-12-19 02:03:34 +0100911 u8 supported_rates_len;
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +0100912 u8 plink_action;
Javier Cardona9c3990a2011-05-03 16:57:11 -0700913 u8 plink_state;
Johannes Berg2c1aabf2013-02-14 23:33:40 +0100914 const struct ieee80211_ht_cap *ht_capa;
915 const struct ieee80211_vht_cap *vht_capa;
Eliad Pellerc75786c2011-08-23 14:37:46 +0300916 u8 uapsd_queues;
917 u8 max_sp;
Marco Porsch3b1c5a52013-01-07 16:04:52 +0100918 enum nl80211_mesh_power_mode local_pm;
Jouni Malinen9d62a982013-02-14 21:10:13 +0200919 u16 capability;
Johannes Berg2c1aabf2013-02-14 23:33:40 +0100920 const u8 *ext_capab;
Jouni Malinen9d62a982013-02-14 21:10:13 +0200921 u8 ext_capab_len;
Sunil Duttc01fc9a2013-10-09 20:45:21 +0530922 const u8 *supported_channels;
923 u8 supported_channels_len;
924 const u8 *supported_oper_classes;
925 u8 supported_oper_classes_len;
Marek Kwaczynski60f4a7b2013-12-03 10:04:59 +0100926 u8 opmode_notif;
927 bool opmode_notif_used;
Ayala Beker17b94242016-03-17 15:41:38 +0200928 int support_p2p_ps;
Johannes Berg5727ef12007-12-19 02:03:34 +0100929};
930
Johannes Bergfd5b74d2007-12-19 02:03:36 +0100931/**
Jouni Malinen89c771e2014-10-10 20:52:40 +0300932 * struct station_del_parameters - station deletion parameters
933 *
934 * Used to delete a station entry (or all stations).
935 *
936 * @mac: MAC address of the station to remove or NULL to remove all stations
Jouni Malinen98856862014-10-20 13:20:45 +0300937 * @subtype: Management frame subtype to use for indicating removal
938 * (10 = Disassociation, 12 = Deauthentication)
939 * @reason_code: Reason code for the Disassociation/Deauthentication frame
Jouni Malinen89c771e2014-10-10 20:52:40 +0300940 */
941struct station_del_parameters {
942 const u8 *mac;
Jouni Malinen98856862014-10-20 13:20:45 +0300943 u8 subtype;
944 u16 reason_code;
Jouni Malinen89c771e2014-10-10 20:52:40 +0300945};
946
947/**
Johannes Berg77ee7c82013-02-15 00:48:33 +0100948 * enum cfg80211_station_type - the type of station being modified
949 * @CFG80211_STA_AP_CLIENT: client of an AP interface
Ayala Beker47edb112015-09-21 15:49:53 +0300950 * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
951 * unassociated (update properties for this type of client is permitted)
Johannes Berg77ee7c82013-02-15 00:48:33 +0100952 * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
953 * the AP MLME in the device
954 * @CFG80211_STA_AP_STA: AP station on managed interface
955 * @CFG80211_STA_IBSS: IBSS station
956 * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
957 * while TDLS setup is in progress, it moves out of this state when
958 * being marked authorized; use this only if TDLS with external setup is
959 * supported/used)
960 * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
961 * entry that is operating, has been marked authorized by userspace)
Thomas Pederseneef941e2013-03-04 13:06:11 -0800962 * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
963 * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
Johannes Berg77ee7c82013-02-15 00:48:33 +0100964 */
965enum cfg80211_station_type {
966 CFG80211_STA_AP_CLIENT,
Ayala Beker47edb112015-09-21 15:49:53 +0300967 CFG80211_STA_AP_CLIENT_UNASSOC,
Johannes Berg77ee7c82013-02-15 00:48:33 +0100968 CFG80211_STA_AP_MLME_CLIENT,
969 CFG80211_STA_AP_STA,
970 CFG80211_STA_IBSS,
971 CFG80211_STA_TDLS_PEER_SETUP,
972 CFG80211_STA_TDLS_PEER_ACTIVE,
Thomas Pederseneef941e2013-03-04 13:06:11 -0800973 CFG80211_STA_MESH_PEER_KERNEL,
974 CFG80211_STA_MESH_PEER_USER,
Johannes Berg77ee7c82013-02-15 00:48:33 +0100975};
976
977/**
978 * cfg80211_check_station_change - validate parameter changes
979 * @wiphy: the wiphy this operates on
980 * @params: the new parameters for a station
981 * @statype: the type of station being modified
982 *
983 * Utility function for the @change_station driver method. Call this function
984 * with the appropriate station type looking up the station (and checking that
985 * it exists). It will verify whether the station change is acceptable, and if
986 * not will return an error code. Note that it may modify the parameters for
987 * backward compatibility reasons, so don't use them before calling this.
988 */
989int cfg80211_check_station_change(struct wiphy *wiphy,
990 struct station_parameters *params,
991 enum cfg80211_station_type statype);
992
993/**
Henning Rogge420e7fa2008-12-11 22:04:19 +0100994 * enum station_info_rate_flags - bitrate info flags
995 *
996 * Used by the driver to indicate the specific rate transmission
997 * type for 802.11n transmissions.
998 *
Johannes Bergdb9c64c2012-11-09 14:56:41 +0100999 * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1000 * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
Henning Rogge420e7fa2008-12-11 22:04:19 +01001001 * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
Johannes Bergdb9c64c2012-11-09 14:56:41 +01001002 * @RATE_INFO_FLAGS_60G: 60GHz MCS
Henning Rogge420e7fa2008-12-11 22:04:19 +01001003 */
1004enum rate_info_flags {
Johannes Bergdb9c64c2012-11-09 14:56:41 +01001005 RATE_INFO_FLAGS_MCS = BIT(0),
1006 RATE_INFO_FLAGS_VHT_MCS = BIT(1),
Johannes Bergb51f3be2015-01-15 16:14:02 +01001007 RATE_INFO_FLAGS_SHORT_GI = BIT(2),
1008 RATE_INFO_FLAGS_60G = BIT(3),
1009};
1010
1011/**
1012 * enum rate_info_bw - rate bandwidth information
1013 *
1014 * Used by the driver to indicate the rate bandwidth.
1015 *
1016 * @RATE_INFO_BW_5: 5 MHz bandwidth
1017 * @RATE_INFO_BW_10: 10 MHz bandwidth
1018 * @RATE_INFO_BW_20: 20 MHz bandwidth
1019 * @RATE_INFO_BW_40: 40 MHz bandwidth
1020 * @RATE_INFO_BW_80: 80 MHz bandwidth
1021 * @RATE_INFO_BW_160: 160 MHz bandwidth
1022 */
1023enum rate_info_bw {
Johannes Berg842be752017-05-04 08:42:30 +02001024 RATE_INFO_BW_20 = 0,
Johannes Bergb51f3be2015-01-15 16:14:02 +01001025 RATE_INFO_BW_5,
1026 RATE_INFO_BW_10,
Johannes Bergb51f3be2015-01-15 16:14:02 +01001027 RATE_INFO_BW_40,
1028 RATE_INFO_BW_80,
1029 RATE_INFO_BW_160,
Henning Rogge420e7fa2008-12-11 22:04:19 +01001030};
1031
1032/**
1033 * struct rate_info - bitrate information
1034 *
1035 * Information about a receiving or transmitting bitrate
1036 *
1037 * @flags: bitflag of flags from &enum rate_info_flags
1038 * @mcs: mcs index if struct describes a 802.11n bitrate
1039 * @legacy: bitrate in 100kbit/s for 802.11abg
Johannes Bergdb9c64c2012-11-09 14:56:41 +01001040 * @nss: number of streams (VHT only)
Johannes Bergb51f3be2015-01-15 16:14:02 +01001041 * @bw: bandwidth (from &enum rate_info_bw)
Henning Rogge420e7fa2008-12-11 22:04:19 +01001042 */
1043struct rate_info {
1044 u8 flags;
1045 u8 mcs;
1046 u16 legacy;
Johannes Bergdb9c64c2012-11-09 14:56:41 +01001047 u8 nss;
Johannes Bergb51f3be2015-01-15 16:14:02 +01001048 u8 bw;
Johannes Bergfd5b74d2007-12-19 02:03:36 +01001049};
1050
1051/**
Paul Stewartf4263c92011-03-31 09:25:41 -07001052 * enum station_info_rate_flags - bitrate info flags
1053 *
1054 * Used by the driver to indicate the specific rate transmission
1055 * type for 802.11n transmissions.
1056 *
1057 * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1058 * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1059 * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1060 */
1061enum bss_param_flags {
1062 BSS_PARAM_FLAGS_CTS_PROT = 1<<0,
1063 BSS_PARAM_FLAGS_SHORT_PREAMBLE = 1<<1,
1064 BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1065};
1066
1067/**
1068 * struct sta_bss_parameters - BSS parameters for the attached station
1069 *
1070 * Information about the currently associated BSS
1071 *
1072 * @flags: bitflag of flags from &enum bss_param_flags
1073 * @dtim_period: DTIM period for the BSS
1074 * @beacon_interval: beacon interval
1075 */
1076struct sta_bss_parameters {
1077 u8 flags;
1078 u8 dtim_period;
1079 u16 beacon_interval;
1080};
1081
Johannes Berg6de39802014-12-19 12:34:00 +01001082/**
Toke Høiland-Jørgensen52539ca2018-05-08 13:03:50 +02001083 * struct cfg80211_txq_stats - TXQ statistics for this TID
1084 * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1085 * indicate the relevant values in this struct are filled
1086 * @backlog_bytes: total number of bytes currently backlogged
1087 * @backlog_packets: total number of packets currently backlogged
1088 * @flows: number of new flows seen
1089 * @drops: total number of packets dropped
1090 * @ecn_marks: total number of packets marked with ECN CE
1091 * @overlimit: number of drops due to queue space overflow
1092 * @overmemory: number of drops due to memory limit overflow
1093 * @collisions: number of hash collisions
1094 * @tx_bytes: total number of bytes dequeued
1095 * @tx_packets: total number of packets dequeued
1096 * @max_flows: maximum number of flows supported
1097 */
1098struct cfg80211_txq_stats {
1099 u32 filled;
1100 u32 backlog_bytes;
1101 u32 backlog_packets;
1102 u32 flows;
1103 u32 drops;
1104 u32 ecn_marks;
1105 u32 overlimit;
1106 u32 overmemory;
1107 u32 collisions;
1108 u32 tx_bytes;
1109 u32 tx_packets;
1110 u32 max_flows;
1111};
1112
1113/**
Johannes Berg6de39802014-12-19 12:34:00 +01001114 * struct cfg80211_tid_stats - per-TID statistics
1115 * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1116 * indicate the relevant values in this struct are filled
1117 * @rx_msdu: number of received MSDUs
1118 * @tx_msdu: number of (attempted) transmitted MSDUs
1119 * @tx_msdu_retries: number of retries (not counting the first) for
1120 * transmitted MSDUs
1121 * @tx_msdu_failed: number of failed transmitted MSDUs
Toke Høiland-Jørgensen52539ca2018-05-08 13:03:50 +02001122 * @txq_stats: TXQ statistics
Johannes Berg6de39802014-12-19 12:34:00 +01001123 */
1124struct cfg80211_tid_stats {
1125 u32 filled;
1126 u64 rx_msdu;
1127 u64 tx_msdu;
1128 u64 tx_msdu_retries;
1129 u64 tx_msdu_failed;
Toke Høiland-Jørgensen52539ca2018-05-08 13:03:50 +02001130 struct cfg80211_txq_stats txq_stats;
Johannes Berg6de39802014-12-19 12:34:00 +01001131};
1132
Felix Fietkau119363c2013-04-22 16:29:30 +02001133#define IEEE80211_MAX_CHAINS 4
1134
Paul Stewartf4263c92011-03-31 09:25:41 -07001135/**
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001136 * struct station_info - station information
Johannes Bergfd5b74d2007-12-19 02:03:36 +01001137 *
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001138 * Station information filled by driver for get_station() and dump_station.
Johannes Bergfd5b74d2007-12-19 02:03:36 +01001139 *
Johannes Berg319090b2014-11-17 14:08:11 +01001140 * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1141 * indicate the relevant values in this struct for them
Mohammed Shafi Shajakhanebe27c92011-04-08 21:24:24 +05301142 * @connected_time: time(in secs) since a station is last connected
Johannes Bergfd5b74d2007-12-19 02:03:36 +01001143 * @inactive_time: time since last station activity (tx/rx) in milliseconds
Johannes Berg8d791362014-11-21 12:40:05 +01001144 * @rx_bytes: bytes (size of MPDUs) received from this station
1145 * @tx_bytes: bytes (size of MPDUs) transmitted to this station
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001146 * @llid: mesh local link id
1147 * @plid: mesh peer link id
1148 * @plink_state: mesh peer link state
Johannes Berg73c3df32012-06-13 11:17:14 +02001149 * @signal: The signal strength, type depends on the wiphy's signal_type.
1150 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1151 * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1152 * For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
Felix Fietkau119363c2013-04-22 16:29:30 +02001153 * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1154 * @chain_signal: per-chain signal strength of last received packet in dBm
1155 * @chain_signal_avg: per-chain signal strength average in dBm
Randy Dunlap858022a2011-03-18 09:33:02 -07001156 * @txrate: current unicast bitrate from this station
1157 * @rxrate: current unicast bitrate to this station
Johannes Berg8d791362014-11-21 12:40:05 +01001158 * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1159 * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1160 * @tx_retries: cumulative retry counts (MPDUs)
1161 * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
Ben Greear5a5c7312010-10-07 16:39:20 -07001162 * @rx_dropped_misc: Dropped for un-specified reason.
Randy Dunlap1ba01452011-05-22 17:16:20 -07001163 * @bss_param: current BSS parameters
Johannes Bergf5ea9122009-08-07 16:17:38 +02001164 * @generation: generation number for nl80211 dumps.
1165 * This number should increase every time the list of stations
1166 * changes, i.e. when a station is added or removed, so that
1167 * userspace can tell whether it got a consistent snapshot.
Jouni Malinen50d3dfb2011-08-08 12:11:52 +03001168 * @assoc_req_ies: IEs from (Re)Association Request.
1169 * This is used only when in AP mode with drivers that do not use
1170 * user space MLME/SME implementation. The information is provided for
1171 * the cfg80211_new_sta() calls to notify user space of the IEs.
1172 * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
Johannes Bergc26887d2011-11-08 09:20:07 +01001173 * @sta_flags: station flags mask & values
Paul Stewarta85e1d52011-12-09 11:01:49 -08001174 * @beacon_loss_count: Number of times beacon loss event has triggered.
Javier Cardonad299a1f2012-03-31 11:31:33 -07001175 * @t_offset: Time offset of the station relative to this host.
Marco Porsch3b1c5a52013-01-07 16:04:52 +01001176 * @local_pm: local mesh STA power save mode
1177 * @peer_pm: peer mesh STA power save mode
1178 * @nonpeer_pm: non-peer mesh STA power save mode
Antonio Quartulli867d849f2014-05-19 21:53:19 +02001179 * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1180 * towards this station.
Johannes Berga76b1942014-11-17 14:12:22 +01001181 * @rx_beacon: number of beacons received from this peer
1182 * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1183 * from this peer
Mohammed Shafi Shajakhan739960f2016-04-07 19:59:34 +05301184 * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
Johannes Berg6de39802014-12-19 12:34:00 +01001185 * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1186 * (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
Arend van Spriel8689c052018-05-10 13:50:12 +02001187 * Note that this doesn't use the @filled bit, but is used if non-NULL.
Venkateswara Naralasettyc4b50cd2018-02-13 11:03:06 +05301188 * @ack_signal: signal strength (in dBm) of the last ACK frame.
Balaji Pothunoori81d54392018-04-16 20:18:40 +05301189 * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1190 * been sent.
Johannes Bergfd5b74d2007-12-19 02:03:36 +01001191 */
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001192struct station_info {
Mohammed Shafi Shajakhan739960f2016-04-07 19:59:34 +05301193 u64 filled;
Mohammed Shafi Shajakhanebe27c92011-04-08 21:24:24 +05301194 u32 connected_time;
Johannes Bergfd5b74d2007-12-19 02:03:36 +01001195 u32 inactive_time;
Vladimir Kondratiev42745e02013-02-04 13:53:11 +02001196 u64 rx_bytes;
1197 u64 tx_bytes;
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001198 u16 llid;
1199 u16 plid;
1200 u8 plink_state;
Henning Rogge420e7fa2008-12-11 22:04:19 +01001201 s8 signal;
Bruno Randolf541a45a2010-12-02 19:12:43 +09001202 s8 signal_avg;
Felix Fietkau119363c2013-04-22 16:29:30 +02001203
1204 u8 chains;
1205 s8 chain_signal[IEEE80211_MAX_CHAINS];
1206 s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1207
Henning Rogge420e7fa2008-12-11 22:04:19 +01001208 struct rate_info txrate;
Felix Fietkauc8dcfd82011-02-27 22:08:00 +01001209 struct rate_info rxrate;
Jouni Malinen98c8a60a2009-02-17 13:24:57 +02001210 u32 rx_packets;
1211 u32 tx_packets;
Bruno Randolfb206b4ef2010-10-06 18:34:12 +09001212 u32 tx_retries;
1213 u32 tx_failed;
Ben Greear5a5c7312010-10-07 16:39:20 -07001214 u32 rx_dropped_misc;
Paul Stewartf4263c92011-03-31 09:25:41 -07001215 struct sta_bss_parameters bss_param;
Helmut Schaabb6e7532011-10-13 16:30:39 +02001216 struct nl80211_sta_flag_update sta_flags;
Johannes Bergf5ea9122009-08-07 16:17:38 +02001217
1218 int generation;
Jouni Malinen50d3dfb2011-08-08 12:11:52 +03001219
1220 const u8 *assoc_req_ies;
1221 size_t assoc_req_ies_len;
Jouni Malinenf612ced2011-08-11 11:46:22 +03001222
Paul Stewarta85e1d52011-12-09 11:01:49 -08001223 u32 beacon_loss_count;
Javier Cardonad299a1f2012-03-31 11:31:33 -07001224 s64 t_offset;
Marco Porsch3b1c5a52013-01-07 16:04:52 +01001225 enum nl80211_mesh_power_mode local_pm;
1226 enum nl80211_mesh_power_mode peer_pm;
1227 enum nl80211_mesh_power_mode nonpeer_pm;
Paul Stewarta85e1d52011-12-09 11:01:49 -08001228
Antonio Quartulli867d849f2014-05-19 21:53:19 +02001229 u32 expected_throughput;
Johannes Berga76b1942014-11-17 14:12:22 +01001230
1231 u64 rx_beacon;
Mohammed Shafi Shajakhan739960f2016-04-07 19:59:34 +05301232 u64 rx_duration;
Johannes Berga76b1942014-11-17 14:12:22 +01001233 u8 rx_beacon_signal_avg;
Arend van Spriel8689c052018-05-10 13:50:12 +02001234 struct cfg80211_tid_stats *pertid;
Venkateswara Naralasettyc4b50cd2018-02-13 11:03:06 +05301235 s8 ack_signal;
Balaji Pothunoori81d54392018-04-16 20:18:40 +05301236 s8 avg_ack_signal;
Johannes Bergfd5b74d2007-12-19 02:03:36 +01001237};
1238
Linus Lüssing61aaa0e2016-08-19 22:02:48 +02001239#if IS_ENABLED(CONFIG_CFG80211)
Michael Wu66f7ac52008-01-31 19:48:22 +01001240/**
Antonio Quartulli74063532014-05-19 21:53:21 +02001241 * cfg80211_get_station - retrieve information about a given station
1242 * @dev: the device where the station is supposed to be connected to
1243 * @mac_addr: the mac address of the station of interest
1244 * @sinfo: pointer to the structure to fill with the information
1245 *
1246 * Returns 0 on success and sinfo is filled with the available information
1247 * otherwise returns a negative error code and the content of sinfo has to be
1248 * considered undefined.
1249 */
1250int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1251 struct station_info *sinfo);
Linus Lüssing61aaa0e2016-08-19 22:02:48 +02001252#else
1253static inline int cfg80211_get_station(struct net_device *dev,
1254 const u8 *mac_addr,
1255 struct station_info *sinfo)
1256{
1257 return -ENOENT;
1258}
1259#endif
Antonio Quartulli74063532014-05-19 21:53:21 +02001260
1261/**
Michael Wu66f7ac52008-01-31 19:48:22 +01001262 * enum monitor_flags - monitor flags
1263 *
1264 * Monitor interface configuration flags. Note that these must be the bits
1265 * according to the nl80211 flags.
1266 *
Johannes Berg818a9862017-04-12 11:23:28 +02001267 * @MONITOR_FLAG_CHANGED: set if the flags were changed
Michael Wu66f7ac52008-01-31 19:48:22 +01001268 * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1269 * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1270 * @MONITOR_FLAG_CONTROL: pass control frames
1271 * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1272 * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
Felix Fietkaue057d3c2013-05-28 13:01:52 +02001273 * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
Michael Wu66f7ac52008-01-31 19:48:22 +01001274 */
1275enum monitor_flags {
Johannes Berg818a9862017-04-12 11:23:28 +02001276 MONITOR_FLAG_CHANGED = 1<<__NL80211_MNTR_FLAG_INVALID,
Michael Wu66f7ac52008-01-31 19:48:22 +01001277 MONITOR_FLAG_FCSFAIL = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1278 MONITOR_FLAG_PLCPFAIL = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1279 MONITOR_FLAG_CONTROL = 1<<NL80211_MNTR_FLAG_CONTROL,
1280 MONITOR_FLAG_OTHER_BSS = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1281 MONITOR_FLAG_COOK_FRAMES = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
Felix Fietkaue057d3c2013-05-28 13:01:52 +02001282 MONITOR_FLAG_ACTIVE = 1<<NL80211_MNTR_FLAG_ACTIVE,
Michael Wu66f7ac52008-01-31 19:48:22 +01001283};
1284
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001285/**
1286 * enum mpath_info_flags - mesh path information flags
1287 *
1288 * Used by the driver to indicate which info in &struct mpath_info it has filled
1289 * in during get_station() or dump_station().
1290 *
Johannes Bergabe37c42010-06-07 11:12:27 +02001291 * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1292 * @MPATH_INFO_SN: @sn filled
1293 * @MPATH_INFO_METRIC: @metric filled
1294 * @MPATH_INFO_EXPTIME: @exptime filled
1295 * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1296 * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1297 * @MPATH_INFO_FLAGS: @flags filled
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001298 */
1299enum mpath_info_flags {
1300 MPATH_INFO_FRAME_QLEN = BIT(0),
Rui Paulod19b3bf2009-11-09 23:46:55 +00001301 MPATH_INFO_SN = BIT(1),
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001302 MPATH_INFO_METRIC = BIT(2),
1303 MPATH_INFO_EXPTIME = BIT(3),
1304 MPATH_INFO_DISCOVERY_TIMEOUT = BIT(4),
1305 MPATH_INFO_DISCOVERY_RETRIES = BIT(5),
1306 MPATH_INFO_FLAGS = BIT(6),
1307};
1308
1309/**
1310 * struct mpath_info - mesh path information
1311 *
1312 * Mesh path information filled by driver for get_mpath() and dump_mpath().
1313 *
1314 * @filled: bitfield of flags from &enum mpath_info_flags
1315 * @frame_qlen: number of queued frames for this destination
Rui Paulod19b3bf2009-11-09 23:46:55 +00001316 * @sn: target sequence number
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001317 * @metric: metric (cost) of this mesh path
1318 * @exptime: expiration time for the mesh path from now, in msecs
1319 * @flags: mesh path flags
1320 * @discovery_timeout: total mesh path discovery timeout, in msecs
1321 * @discovery_retries: mesh path discovery retries
Johannes Bergf5ea9122009-08-07 16:17:38 +02001322 * @generation: generation number for nl80211 dumps.
1323 * This number should increase every time the list of mesh paths
1324 * changes, i.e. when a station is added or removed, so that
1325 * userspace can tell whether it got a consistent snapshot.
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001326 */
1327struct mpath_info {
1328 u32 filled;
1329 u32 frame_qlen;
Rui Paulod19b3bf2009-11-09 23:46:55 +00001330 u32 sn;
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001331 u32 metric;
1332 u32 exptime;
1333 u32 discovery_timeout;
1334 u8 discovery_retries;
1335 u8 flags;
Johannes Bergf5ea9122009-08-07 16:17:38 +02001336
1337 int generation;
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001338};
1339
Jouni Malinen9f1ba902008-08-07 20:07:01 +03001340/**
1341 * struct bss_parameters - BSS parameters
1342 *
1343 * Used to change BSS parameters (mainly for AP mode).
1344 *
1345 * @use_cts_prot: Whether to use CTS protection
1346 * (0 = no, 1 = yes, -1 = do not change)
1347 * @use_short_preamble: Whether the use of short preambles is allowed
1348 * (0 = no, 1 = yes, -1 = do not change)
1349 * @use_short_slot_time: Whether the use of short slot time is allowed
1350 * (0 = no, 1 = yes, -1 = do not change)
Jouni Malinen90c97a02008-10-30 16:59:22 +02001351 * @basic_rates: basic rates in IEEE 802.11 format
1352 * (or NULL for no change)
1353 * @basic_rates_len: number of basic rates
Felix Fietkaufd8aaaf2010-04-27 01:23:35 +02001354 * @ap_isolate: do not forward packets between connected stations
Helmut Schaa50b12f52010-11-19 12:40:25 +01001355 * @ht_opmode: HT Operation mode
1356 * (u16 = opmode, -1 = do not change)
Johannes Berg53cabad2012-11-14 15:17:28 +01001357 * @p2p_ctwindow: P2P CT Window (-1 = no change)
1358 * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
Jouni Malinen9f1ba902008-08-07 20:07:01 +03001359 */
1360struct bss_parameters {
1361 int use_cts_prot;
1362 int use_short_preamble;
1363 int use_short_slot_time;
Johannes Bergc1e5f472014-05-19 17:53:16 +02001364 const u8 *basic_rates;
Jouni Malinen90c97a02008-10-30 16:59:22 +02001365 u8 basic_rates_len;
Felix Fietkaufd8aaaf2010-04-27 01:23:35 +02001366 int ap_isolate;
Helmut Schaa50b12f52010-11-19 12:40:25 +01001367 int ht_opmode;
Johannes Berg53cabad2012-11-14 15:17:28 +01001368 s8 p2p_ctwindow, p2p_opp_ps;
Jouni Malinen9f1ba902008-08-07 20:07:01 +03001369};
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01001370
Chun-Yeow Yeoh3ddd53f2012-06-11 11:59:10 +08001371/**
Johannes Berg29cbe682010-12-03 09:20:44 +01001372 * struct mesh_config - 802.11s mesh configuration
1373 *
1374 * These parameters can be changed while the mesh is active.
Chun-Yeow Yeoh3ddd53f2012-06-11 11:59:10 +08001375 *
1376 * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1377 * by the Mesh Peering Open message
1378 * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1379 * used by the Mesh Peering Open message
1380 * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1381 * the mesh peering management to close a mesh peering
1382 * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1383 * mesh interface
1384 * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1385 * be sent to establish a new peer link instance in a mesh
1386 * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1387 * @element_ttl: the value of TTL field set at a mesh STA for path selection
1388 * elements
1389 * @auto_open_plinks: whether we should automatically open peer links when we
1390 * detect compatible mesh peers
1391 * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1392 * synchronize to for 11s default synchronization method
1393 * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1394 * that an originator mesh STA can send to a particular path target
1395 * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1396 * @min_discovery_timeout: the minimum length of time to wait until giving up on
1397 * a path discovery in milliseconds
1398 * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1399 * receiving a PREQ shall consider the forwarding information from the
1400 * root to be valid. (TU = time unit)
1401 * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1402 * which a mesh STA can send only one action frame containing a PREQ
1403 * element
1404 * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1405 * which a mesh STA can send only one Action frame containing a PERR
1406 * element
1407 * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1408 * it takes for an HWMP information element to propagate across the mesh
1409 * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1410 * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1411 * announcements are transmitted
1412 * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1413 * station has access to a broader network beyond the MBSS. (This is
1414 * missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1415 * only means that the station will announce others it's a mesh gate, but
1416 * not necessarily using the gate announcement protocol. Still keeping the
1417 * same nomenclature to be in sync with the spec)
1418 * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1419 * entity (default is TRUE - forwarding entity)
1420 * @rssi_threshold: the threshold for average signal strength of candidate
1421 * station to establish a peer link
1422 * @ht_opmode: mesh HT protection mode
Chun-Yeow Yeohac1073a2012-06-14 02:06:06 +08001423 *
1424 * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1425 * receiving a proactive PREQ shall consider the forwarding information to
1426 * the root mesh STA to be valid.
1427 *
1428 * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1429 * PREQs are transmitted.
Chun-Yeow Yeoh728b19e2012-06-14 02:06:10 +08001430 * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1431 * during which a mesh STA can send only one Action frame containing
1432 * a PREQ element for root path confirmation.
Marco Porsch3b1c5a52013-01-07 16:04:52 +01001433 * @power_mode: The default mesh power save mode which will be the initial
1434 * setting for new peer links.
1435 * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1436 * after transmitting its beacon.
Colleen Twitty8e7c0532013-06-03 09:53:39 -07001437 * @plink_timeout: If no tx activity is seen from a STA we've established
1438 * peering with for longer than this time (in seconds), then remove it
1439 * from the STA's list of peers. Default is 30 minutes.
Johannes Berg29cbe682010-12-03 09:20:44 +01001440 */
colin@cozybit.com93da9cc2008-10-21 12:03:48 -07001441struct mesh_config {
colin@cozybit.com93da9cc2008-10-21 12:03:48 -07001442 u16 dot11MeshRetryTimeout;
1443 u16 dot11MeshConfirmTimeout;
1444 u16 dot11MeshHoldingTimeout;
1445 u16 dot11MeshMaxPeerLinks;
Chun-Yeow Yeoha4f606e2012-06-11 11:59:36 +08001446 u8 dot11MeshMaxRetries;
1447 u8 dot11MeshTTL;
1448 u8 element_ttl;
colin@cozybit.com93da9cc2008-10-21 12:03:48 -07001449 bool auto_open_plinks;
Javier Cardonad299a1f2012-03-31 11:31:33 -07001450 u32 dot11MeshNbrOffsetMaxNeighbor;
Chun-Yeow Yeoha4f606e2012-06-11 11:59:36 +08001451 u8 dot11MeshHWMPmaxPREQretries;
colin@cozybit.com93da9cc2008-10-21 12:03:48 -07001452 u32 path_refresh_time;
1453 u16 min_discovery_timeout;
1454 u32 dot11MeshHWMPactivePathTimeout;
1455 u16 dot11MeshHWMPpreqMinInterval;
Thomas Pedersendca7e942011-11-24 17:15:24 -08001456 u16 dot11MeshHWMPperrMinInterval;
colin@cozybit.com93da9cc2008-10-21 12:03:48 -07001457 u16 dot11MeshHWMPnetDiameterTraversalTime;
Chun-Yeow Yeoha4f606e2012-06-11 11:59:36 +08001458 u8 dot11MeshHWMPRootMode;
Javier Cardona0507e152011-08-09 16:45:10 -07001459 u16 dot11MeshHWMPRannInterval;
Chun-Yeow Yeoha4f606e2012-06-11 11:59:36 +08001460 bool dot11MeshGateAnnouncementProtocol;
Chun-Yeow Yeoh94f90652012-01-21 01:02:16 +08001461 bool dot11MeshForwarding;
Ashok Nagarajan55335132012-02-28 17:04:08 -08001462 s32 rssi_threshold;
Ashok Nagarajan70c33ea2012-04-30 14:20:32 -07001463 u16 ht_opmode;
Chun-Yeow Yeohac1073a2012-06-14 02:06:06 +08001464 u32 dot11MeshHWMPactivePathToRootTimeout;
1465 u16 dot11MeshHWMProotInterval;
Chun-Yeow Yeoh728b19e2012-06-14 02:06:10 +08001466 u16 dot11MeshHWMPconfirmationInterval;
Marco Porsch3b1c5a52013-01-07 16:04:52 +01001467 enum nl80211_mesh_power_mode power_mode;
1468 u16 dot11MeshAwakeWindowDuration;
Colleen Twitty8e7c0532013-06-03 09:53:39 -07001469 u32 plink_timeout;
colin@cozybit.com93da9cc2008-10-21 12:03:48 -07001470};
1471
Jouni Malinen31888482008-10-30 16:59:24 +02001472/**
Johannes Berg29cbe682010-12-03 09:20:44 +01001473 * struct mesh_setup - 802.11s mesh setup configuration
Johannes Berg683b6d32012-11-08 21:25:48 +01001474 * @chandef: defines the channel to use
Johannes Berg29cbe682010-12-03 09:20:44 +01001475 * @mesh_id: the mesh ID
1476 * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
Javier Cardonad299a1f2012-03-31 11:31:33 -07001477 * @sync_method: which synchronization method to use
Javier Cardonac80d5452010-12-16 17:37:49 -08001478 * @path_sel_proto: which path selection protocol to use
1479 * @path_metric: which metric to use
Colleen Twitty6e16d902013-05-08 11:45:59 -07001480 * @auth_id: which authentication method this mesh is using
Javier Cardona581a8b02011-04-07 15:08:27 -07001481 * @ie: vendor information elements (optional)
1482 * @ie_len: length of vendor information elements
Javier Cardonab130e5c2011-05-03 16:57:07 -07001483 * @is_authenticated: this mesh requires authentication
1484 * @is_secure: this mesh uses security
Thomas Pedersenbb2798d2013-03-04 13:06:10 -08001485 * @user_mpm: userspace handles all MPM functions
Marco Porsch9bdbf042013-01-07 16:04:51 +01001486 * @dtim_period: DTIM period to use
1487 * @beacon_interval: beacon interval to use
Chun-Yeow Yeoh4bb62342011-11-24 17:15:20 -08001488 * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
Ashok Nagarajanffb3cf32013-06-03 10:33:36 -07001489 * @basic_rates: basic rates to use when creating the mesh
Johannes Berg8564e382016-09-19 09:44:44 +02001490 * @beacon_rate: bitrate to be used for beacons
Benjamin Bergd37d49c2017-05-16 11:23:11 +02001491 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1492 * changes the channel when a radar is detected. This is required
1493 * to operate on DFS channels.
Denis Kenzior1224f582018-03-26 12:52:49 -05001494 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1495 * port frames over NL80211 instead of the network interface.
Johannes Berg29cbe682010-12-03 09:20:44 +01001496 *
1497 * These parameters are fixed when the mesh is created.
1498 */
1499struct mesh_setup {
Johannes Berg683b6d32012-11-08 21:25:48 +01001500 struct cfg80211_chan_def chandef;
Johannes Berg29cbe682010-12-03 09:20:44 +01001501 const u8 *mesh_id;
1502 u8 mesh_id_len;
Javier Cardonad299a1f2012-03-31 11:31:33 -07001503 u8 sync_method;
1504 u8 path_sel_proto;
1505 u8 path_metric;
Colleen Twitty6e16d902013-05-08 11:45:59 -07001506 u8 auth_id;
Javier Cardona581a8b02011-04-07 15:08:27 -07001507 const u8 *ie;
1508 u8 ie_len;
Javier Cardonab130e5c2011-05-03 16:57:07 -07001509 bool is_authenticated;
Javier Cardona15d5dda2011-04-07 15:08:28 -07001510 bool is_secure;
Thomas Pedersenbb2798d2013-03-04 13:06:10 -08001511 bool user_mpm;
Marco Porsch9bdbf042013-01-07 16:04:51 +01001512 u8 dtim_period;
1513 u16 beacon_interval;
Johannes Berg57fbcce2016-04-12 15:56:15 +02001514 int mcast_rate[NUM_NL80211_BANDS];
Ashok Nagarajanffb3cf32013-06-03 10:33:36 -07001515 u32 basic_rates;
Johannes Berg8564e382016-09-19 09:44:44 +02001516 struct cfg80211_bitrate_mask beacon_rate;
Benjamin Bergd37d49c2017-05-16 11:23:11 +02001517 bool userspace_handles_dfs;
Denis Kenzior1224f582018-03-26 12:52:49 -05001518 bool control_port_over_nl80211;
Johannes Berg29cbe682010-12-03 09:20:44 +01001519};
1520
1521/**
Rostislav Lisovy6e0bd6c2014-11-03 10:33:18 +01001522 * struct ocb_setup - 802.11p OCB mode setup configuration
1523 * @chandef: defines the channel to use
1524 *
1525 * These parameters are fixed when connecting to the network
1526 */
1527struct ocb_setup {
1528 struct cfg80211_chan_def chandef;
1529};
1530
1531/**
Jouni Malinen31888482008-10-30 16:59:24 +02001532 * struct ieee80211_txq_params - TX queue parameters
Johannes Berga3304b02012-03-28 11:04:24 +02001533 * @ac: AC identifier
Jouni Malinen31888482008-10-30 16:59:24 +02001534 * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1535 * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1536 * 1..32767]
1537 * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1538 * 1..32767]
1539 * @aifs: Arbitration interframe space [0..255]
1540 */
1541struct ieee80211_txq_params {
Johannes Berga3304b02012-03-28 11:04:24 +02001542 enum nl80211_ac ac;
Jouni Malinen31888482008-10-30 16:59:24 +02001543 u16 txop;
1544 u16 cwmin;
1545 u16 cwmax;
1546 u8 aifs;
1547};
1548
Johannes Bergd70e9692010-08-19 16:11:27 +02001549/**
1550 * DOC: Scanning and BSS list handling
1551 *
1552 * The scanning process itself is fairly simple, but cfg80211 offers quite
1553 * a bit of helper functionality. To start a scan, the scan operation will
1554 * be invoked with a scan definition. This scan definition contains the
1555 * channels to scan, and the SSIDs to send probe requests for (including the
1556 * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1557 * probe. Additionally, a scan request may contain extra information elements
1558 * that should be added to the probe request. The IEs are guaranteed to be
1559 * well-formed, and will not exceed the maximum length the driver advertised
1560 * in the wiphy structure.
1561 *
1562 * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1563 * it is responsible for maintaining the BSS list; the driver should not
1564 * maintain a list itself. For this notification, various functions exist.
1565 *
1566 * Since drivers do not maintain a BSS list, there are also a number of
1567 * functions to search for a BSS and obtain information about it from the
1568 * BSS structure cfg80211 maintains. The BSS list is also made available
1569 * to userspace.
1570 */
Jouni Malinen72bdcf32008-11-26 16:15:24 +02001571
Johannes Berg704232c2007-04-23 12:20:05 -07001572/**
Johannes Berg2a519312009-02-10 21:25:55 +01001573 * struct cfg80211_ssid - SSID description
1574 * @ssid: the SSID
1575 * @ssid_len: length of the ssid
1576 */
1577struct cfg80211_ssid {
1578 u8 ssid[IEEE80211_MAX_SSID_LEN];
1579 u8 ssid_len;
1580};
1581
1582/**
Avraham Stern1d762502016-07-05 17:10:13 +03001583 * struct cfg80211_scan_info - information about completed scan
1584 * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1585 * wireless device that requested the scan is connected to. If this
1586 * information is not available, this field is left zero.
1587 * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1588 * @aborted: set to true if the scan was aborted for any reason,
1589 * userspace will be notified of that
1590 */
1591struct cfg80211_scan_info {
1592 u64 scan_start_tsf;
1593 u8 tsf_bssid[ETH_ALEN] __aligned(2);
1594 bool aborted;
1595};
1596
1597/**
Johannes Berg2a519312009-02-10 21:25:55 +01001598 * struct cfg80211_scan_request - scan request description
1599 *
1600 * @ssids: SSIDs to scan for (active scan only)
1601 * @n_ssids: number of SSIDs
1602 * @channels: channels to scan on.
Helmut Schaaca3dbc22009-07-10 14:54:58 +02001603 * @n_channels: total number of channels to scan
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02001604 * @scan_width: channel width for scanning
Jouni Malinen70692ad2009-02-16 19:39:13 +02001605 * @ie: optional information element(s) to add into Probe Request or %NULL
1606 * @ie_len: length of ie in octets
Avraham Stern1d762502016-07-05 17:10:13 +03001607 * @duration: how long to listen on each channel, in TUs. If
1608 * %duration_mandatory is not set, this is the maximum dwell time and
1609 * the actual dwell time may be shorter.
1610 * @duration_mandatory: if set, the scan duration must be as specified by the
1611 * %duration field.
Sam Lefflered4737712012-10-11 21:03:31 -07001612 * @flags: bit field of flags controlling operation
Johannes Berg34850ab2011-07-18 18:08:35 +02001613 * @rates: bitmap of rates to advertise for each band
Johannes Berg2a519312009-02-10 21:25:55 +01001614 * @wiphy: the wiphy this was for
Sam Leffler15d60302012-10-11 21:03:34 -07001615 * @scan_start: time (in jiffies) when the scan started
Johannes Bergfd014282012-06-18 19:17:03 +02001616 * @wdev: the wireless device to scan for
Avraham Stern1d762502016-07-05 17:10:13 +03001617 * @info: (internal) information about completed scan
Johannes Berg5fe231e2013-05-08 21:45:15 +02001618 * @notified: (internal) scan request was notified as done or aborted
Rajkumar Manoharane9f935e2011-09-25 14:53:30 +05301619 * @no_cck: used to send probe requests at non CCK rate in 2GHz band
Johannes Bergad2b26a2014-06-12 21:39:05 +02001620 * @mac_addr: MAC address used with randomisation
1621 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1622 * are 0 in the mask should be randomised, bits that are 1 should
1623 * be taken from the @mac_addr
Jouni Malinen818965d2016-02-26 22:12:47 +02001624 * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
Johannes Berg2a519312009-02-10 21:25:55 +01001625 */
1626struct cfg80211_scan_request {
1627 struct cfg80211_ssid *ssids;
1628 int n_ssids;
Johannes Berg2a519312009-02-10 21:25:55 +01001629 u32 n_channels;
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02001630 enum nl80211_bss_scan_width scan_width;
Johannes Bergde95a54b2009-04-01 11:58:36 +02001631 const u8 *ie;
Jouni Malinen70692ad2009-02-16 19:39:13 +02001632 size_t ie_len;
Avraham Stern1d762502016-07-05 17:10:13 +03001633 u16 duration;
1634 bool duration_mandatory;
Sam Lefflered4737712012-10-11 21:03:31 -07001635 u32 flags;
Johannes Berg2a519312009-02-10 21:25:55 +01001636
Johannes Berg57fbcce2016-04-12 15:56:15 +02001637 u32 rates[NUM_NL80211_BANDS];
Johannes Berg34850ab2011-07-18 18:08:35 +02001638
Johannes Bergfd014282012-06-18 19:17:03 +02001639 struct wireless_dev *wdev;
1640
Johannes Bergad2b26a2014-06-12 21:39:05 +02001641 u8 mac_addr[ETH_ALEN] __aligned(2);
1642 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
Jouni Malinen818965d2016-02-26 22:12:47 +02001643 u8 bssid[ETH_ALEN] __aligned(2);
Johannes Bergad2b26a2014-06-12 21:39:05 +02001644
Johannes Berg2a519312009-02-10 21:25:55 +01001645 /* internal */
1646 struct wiphy *wiphy;
Sam Leffler15d60302012-10-11 21:03:34 -07001647 unsigned long scan_start;
Avraham Stern1d762502016-07-05 17:10:13 +03001648 struct cfg80211_scan_info info;
1649 bool notified;
Rajkumar Manoharane9f935e2011-09-25 14:53:30 +05301650 bool no_cck;
Johannes Berg5ba63532009-08-07 17:54:07 +02001651
1652 /* keep last */
1653 struct ieee80211_channel *channels[0];
Johannes Berg2a519312009-02-10 21:25:55 +01001654};
1655
Johannes Bergad2b26a2014-06-12 21:39:05 +02001656static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1657{
1658 int i;
1659
1660 get_random_bytes(buf, ETH_ALEN);
1661 for (i = 0; i < ETH_ALEN; i++) {
1662 buf[i] &= ~mask[i];
1663 buf[i] |= addr[i] & mask[i];
1664 }
1665}
1666
Johannes Berg2a519312009-02-10 21:25:55 +01001667/**
Luciano Coelhoa1f1c212011-08-31 16:01:48 +03001668 * struct cfg80211_match_set - sets of attributes to match
1669 *
Arend Van Spriel3007e352017-04-21 13:05:01 +01001670 * @ssid: SSID to be matched; may be zero-length in case of BSSID match
1671 * or no match (RSSI only)
1672 * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
1673 * or no match (RSSI only)
Johannes Bergea73cbc2014-01-24 10:53:53 +01001674 * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
Luciano Coelhoa1f1c212011-08-31 16:01:48 +03001675 */
1676struct cfg80211_match_set {
1677 struct cfg80211_ssid ssid;
Arend Van Spriel3007e352017-04-21 13:05:01 +01001678 u8 bssid[ETH_ALEN];
Johannes Bergea73cbc2014-01-24 10:53:53 +01001679 s32 rssi_thold;
Luciano Coelhoa1f1c212011-08-31 16:01:48 +03001680};
1681
1682/**
Avraham Stern3b06d272015-10-12 09:51:34 +03001683 * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1684 *
1685 * @interval: interval between scheduled scan iterations. In seconds.
1686 * @iterations: number of scan iterations in this scan plan. Zero means
1687 * infinite loop.
1688 * The last scan plan will always have this parameter set to zero,
1689 * all other scan plans will have a finite number of iterations.
1690 */
1691struct cfg80211_sched_scan_plan {
1692 u32 interval;
1693 u32 iterations;
1694};
1695
1696/**
vamsi krishnabf95ecd2017-01-13 01:12:20 +02001697 * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
1698 *
1699 * @band: band of BSS which should match for RSSI level adjustment.
1700 * @delta: value of RSSI level adjustment.
1701 */
1702struct cfg80211_bss_select_adjust {
1703 enum nl80211_band band;
1704 s8 delta;
1705};
1706
1707/**
Luciano Coelho807f8a82011-05-11 17:09:35 +03001708 * struct cfg80211_sched_scan_request - scheduled scan request description
1709 *
Arend Van Spriel96b08fd2017-04-13 13:06:27 +01001710 * @reqid: identifies this request.
Luciano Coelho807f8a82011-05-11 17:09:35 +03001711 * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
1712 * @n_ssids: number of SSIDs
1713 * @n_channels: total number of channels to scan
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02001714 * @scan_width: channel width for scanning
Luciano Coelho807f8a82011-05-11 17:09:35 +03001715 * @ie: optional information element(s) to add into Probe Request or %NULL
1716 * @ie_len: length of ie in octets
Sam Lefflered4737712012-10-11 21:03:31 -07001717 * @flags: bit field of flags controlling operation
Luciano Coelhoa1f1c212011-08-31 16:01:48 +03001718 * @match_sets: sets of parameters to be matched for a scan result
1719 * entry to be considered valid and to be passed to the host
1720 * (others are filtered out).
1721 * If ommited, all results are passed.
1722 * @n_match_sets: number of match sets
Johannes Berg6406c912017-05-02 09:33:40 +02001723 * @report_results: indicates that results were reported for this request
Luciano Coelho807f8a82011-05-11 17:09:35 +03001724 * @wiphy: the wiphy this was for
1725 * @dev: the interface
Johannes Berg077f8972013-02-08 09:06:36 +01001726 * @scan_start: start time of the scheduled scan
Luciano Coelho807f8a82011-05-11 17:09:35 +03001727 * @channels: channels to scan
Johannes Bergea73cbc2014-01-24 10:53:53 +01001728 * @min_rssi_thold: for drivers only supporting a single threshold, this
1729 * contains the minimum over all matchsets
Johannes Bergad2b26a2014-06-12 21:39:05 +02001730 * @mac_addr: MAC address used with randomisation
1731 * @mac_addr_mask: MAC address mask used with randomisation, bits that
1732 * are 0 in the mask should be randomised, bits that are 1 should
1733 * be taken from the @mac_addr
Avraham Stern3b06d272015-10-12 09:51:34 +03001734 * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
1735 * index must be executed first.
1736 * @n_scan_plans: number of scan plans, at least 1.
Jukka Rissanen31a60ed2014-12-15 13:25:38 +02001737 * @rcu_head: RCU callback used to free the struct
Jukka Rissanen93a1e862014-12-15 13:25:39 +02001738 * @owner_nlportid: netlink portid of owner (if this should is a request
1739 * owned by a particular socket)
Arend Van Sprielca986ad2017-04-21 13:05:00 +01001740 * @nl_owner_dead: netlink owner socket was closed - this request be freed
1741 * @list: for keeping list of requests.
Luciano Coelho9c748932015-01-16 16:04:09 +02001742 * @delay: delay in seconds to use before starting the first scan
1743 * cycle. The driver may ignore this parameter and start
1744 * immediately (or at any other time), if this feature is not
1745 * supported.
vamsi krishnabf95ecd2017-01-13 01:12:20 +02001746 * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
1747 * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
1748 * reporting in connected state to cases where a matching BSS is determined
1749 * to have better or slightly worse RSSI than the current connected BSS.
1750 * The relative RSSI threshold values are ignored in disconnected state.
1751 * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
1752 * to the specified band while deciding whether a better BSS is reported
1753 * using @relative_rssi. If delta is a negative number, the BSSs that
1754 * belong to the specified band will be penalized by delta dB in relative
1755 * comparisions.
Luciano Coelho807f8a82011-05-11 17:09:35 +03001756 */
1757struct cfg80211_sched_scan_request {
Arend Van Spriel96b08fd2017-04-13 13:06:27 +01001758 u64 reqid;
Luciano Coelho807f8a82011-05-11 17:09:35 +03001759 struct cfg80211_ssid *ssids;
1760 int n_ssids;
1761 u32 n_channels;
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02001762 enum nl80211_bss_scan_width scan_width;
Luciano Coelho807f8a82011-05-11 17:09:35 +03001763 const u8 *ie;
1764 size_t ie_len;
Sam Lefflered4737712012-10-11 21:03:31 -07001765 u32 flags;
Luciano Coelhoa1f1c212011-08-31 16:01:48 +03001766 struct cfg80211_match_set *match_sets;
1767 int n_match_sets;
Johannes Bergea73cbc2014-01-24 10:53:53 +01001768 s32 min_rssi_thold;
Luciano Coelho9c748932015-01-16 16:04:09 +02001769 u32 delay;
Avraham Stern3b06d272015-10-12 09:51:34 +03001770 struct cfg80211_sched_scan_plan *scan_plans;
1771 int n_scan_plans;
Luciano Coelho807f8a82011-05-11 17:09:35 +03001772
Johannes Bergad2b26a2014-06-12 21:39:05 +02001773 u8 mac_addr[ETH_ALEN] __aligned(2);
1774 u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1775
vamsi krishnabf95ecd2017-01-13 01:12:20 +02001776 bool relative_rssi_set;
1777 s8 relative_rssi;
1778 struct cfg80211_bss_select_adjust rssi_adjust;
1779
Luciano Coelho807f8a82011-05-11 17:09:35 +03001780 /* internal */
1781 struct wiphy *wiphy;
1782 struct net_device *dev;
Sam Leffler15d60302012-10-11 21:03:34 -07001783 unsigned long scan_start;
Arend Van Sprielb34939b2017-04-28 13:40:28 +01001784 bool report_results;
Jukka Rissanen31a60ed2014-12-15 13:25:38 +02001785 struct rcu_head rcu_head;
Jukka Rissanen93a1e862014-12-15 13:25:39 +02001786 u32 owner_nlportid;
Arend Van Sprielca986ad2017-04-21 13:05:00 +01001787 bool nl_owner_dead;
1788 struct list_head list;
Luciano Coelho807f8a82011-05-11 17:09:35 +03001789
1790 /* keep last */
1791 struct ieee80211_channel *channels[0];
1792};
1793
1794/**
Johannes Berg2a519312009-02-10 21:25:55 +01001795 * enum cfg80211_signal_type - signal type
1796 *
1797 * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
1798 * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
1799 * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
1800 */
1801enum cfg80211_signal_type {
1802 CFG80211_SIGNAL_TYPE_NONE,
1803 CFG80211_SIGNAL_TYPE_MBM,
1804 CFG80211_SIGNAL_TYPE_UNSPEC,
1805};
1806
1807/**
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02001808 * struct cfg80211_inform_bss - BSS inform data
1809 * @chan: channel the frame was received on
1810 * @scan_width: scan width that was used
1811 * @signal: signal strength value, according to the wiphy's
1812 * signal type
1813 * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
1814 * received; should match the time when the frame was actually
1815 * received by the device (not just by the host, in case it was
1816 * buffered on the device) and be accurate to about 10ms.
1817 * If the frame isn't buffered, just passing the return value of
1818 * ktime_get_boot_ns() is likely appropriate.
Avraham Stern1d762502016-07-05 17:10:13 +03001819 * @parent_tsf: the time at the start of reception of the first octet of the
1820 * timestamp field of the frame. The time is the TSF of the BSS specified
1821 * by %parent_bssid.
1822 * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
1823 * the BSS that requested the scan in which the beacon/probe was received.
Sunil Dutt983dafa2017-12-13 19:51:36 +02001824 * @chains: bitmask for filled values in @chain_signal.
1825 * @chain_signal: per-chain signal strength of last received BSS in dBm.
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02001826 */
1827struct cfg80211_inform_bss {
1828 struct ieee80211_channel *chan;
1829 enum nl80211_bss_scan_width scan_width;
1830 s32 signal;
1831 u64 boottime_ns;
Avraham Stern1d762502016-07-05 17:10:13 +03001832 u64 parent_tsf;
1833 u8 parent_bssid[ETH_ALEN] __aligned(2);
Sunil Dutt983dafa2017-12-13 19:51:36 +02001834 u8 chains;
1835 s8 chain_signal[IEEE80211_MAX_CHAINS];
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02001836};
1837
1838/**
Akira Moroo2aa4d452016-03-08 23:17:42 +09001839 * struct cfg80211_bss_ies - BSS entry IE data
Johannes Berg8cef2c92013-02-05 16:54:31 +01001840 * @tsf: TSF contained in the frame that carried these IEs
Johannes Berg9caf0362012-11-29 01:25:20 +01001841 * @rcu_head: internal use, for freeing
1842 * @len: length of the IEs
Johannes Berg0e227082014-08-12 20:34:30 +02001843 * @from_beacon: these IEs are known to come from a beacon
Johannes Berg9caf0362012-11-29 01:25:20 +01001844 * @data: IE data
1845 */
1846struct cfg80211_bss_ies {
Johannes Berg8cef2c92013-02-05 16:54:31 +01001847 u64 tsf;
Johannes Berg9caf0362012-11-29 01:25:20 +01001848 struct rcu_head rcu_head;
1849 int len;
Johannes Berg0e227082014-08-12 20:34:30 +02001850 bool from_beacon;
Johannes Berg9caf0362012-11-29 01:25:20 +01001851 u8 data[];
1852};
1853
1854/**
Johannes Berg2a519312009-02-10 21:25:55 +01001855 * struct cfg80211_bss - BSS description
1856 *
1857 * This structure describes a BSS (which may also be a mesh network)
1858 * for use in scan results and similar.
1859 *
Johannes Bergabe37c42010-06-07 11:12:27 +02001860 * @channel: channel this BSS is on
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02001861 * @scan_width: width of the control channel
Johannes Berg2a519312009-02-10 21:25:55 +01001862 * @bssid: BSSID of the BSS
Johannes Berg2a519312009-02-10 21:25:55 +01001863 * @beacon_interval: the beacon interval as from the frame
1864 * @capability: the capability field in host byte order
Johannes Berg83c7aa12013-02-05 16:51:29 +01001865 * @ies: the information elements (Note that there is no guarantee that these
1866 * are well-formed!); this is a pointer to either the beacon_ies or
1867 * proberesp_ies depending on whether Probe Response frame has been
1868 * received. It is always non-%NULL.
Jouni Malinen34a6edd2010-01-06 16:19:24 +02001869 * @beacon_ies: the information elements from the last Beacon frame
Johannes Berg776b3582013-02-01 02:06:18 +01001870 * (implementation note: if @hidden_beacon_bss is set this struct doesn't
1871 * own the beacon_ies, but they're just pointers to the ones from the
1872 * @hidden_beacon_bss struct)
Jouni Malinen34a6edd2010-01-06 16:19:24 +02001873 * @proberesp_ies: the information elements from the last Probe Response frame
Johannes Berg776b3582013-02-01 02:06:18 +01001874 * @hidden_beacon_bss: in case this BSS struct represents a probe response from
1875 * a BSS that hides the SSID in its beacon, this points to the BSS struct
1876 * that holds the beacon data. @beacon_ies is still valid, of course, and
1877 * points to the same data as hidden_beacon_bss->beacon_ies in that case.
Johannes Berg77965c972009-02-18 18:45:06 +01001878 * @signal: signal strength value (type depends on the wiphy's signal_type)
Sunil Dutt983dafa2017-12-13 19:51:36 +02001879 * @chains: bitmask for filled values in @chain_signal.
1880 * @chain_signal: per-chain signal strength of last received BSS in dBm.
Johannes Berg2a519312009-02-10 21:25:55 +01001881 * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
1882 */
1883struct cfg80211_bss {
1884 struct ieee80211_channel *channel;
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02001885 enum nl80211_bss_scan_width scan_width;
Johannes Berg2a519312009-02-10 21:25:55 +01001886
Johannes Berg9caf0362012-11-29 01:25:20 +01001887 const struct cfg80211_bss_ies __rcu *ies;
1888 const struct cfg80211_bss_ies __rcu *beacon_ies;
1889 const struct cfg80211_bss_ies __rcu *proberesp_ies;
1890
Johannes Berg776b3582013-02-01 02:06:18 +01001891 struct cfg80211_bss *hidden_beacon_bss;
Johannes Berg2a519312009-02-10 21:25:55 +01001892
1893 s32 signal;
Johannes Berg2a519312009-02-10 21:25:55 +01001894
Johannes Berg9caf0362012-11-29 01:25:20 +01001895 u16 beacon_interval;
1896 u16 capability;
1897
1898 u8 bssid[ETH_ALEN];
Sunil Dutt983dafa2017-12-13 19:51:36 +02001899 u8 chains;
1900 s8 chain_signal[IEEE80211_MAX_CHAINS];
Johannes Berg9caf0362012-11-29 01:25:20 +01001901
Johannes Berg1c06ef92012-12-28 12:22:02 +01001902 u8 priv[0] __aligned(sizeof(void *));
Johannes Berg2a519312009-02-10 21:25:55 +01001903};
1904
1905/**
Johannes Berg517357c2009-07-02 17:18:40 +02001906 * ieee80211_bss_get_ie - find IE with given ID
1907 * @bss: the bss to search
1908 * @ie: the IE ID
Johannes Berg9caf0362012-11-29 01:25:20 +01001909 *
1910 * Note that the return value is an RCU-protected pointer, so
1911 * rcu_read_lock() must be held when calling this function.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01001912 * Return: %NULL if not found.
Johannes Berg517357c2009-07-02 17:18:40 +02001913 */
1914const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 ie);
1915
1916
1917/**
Jouni Malinen636a5d32009-03-19 13:39:22 +02001918 * struct cfg80211_auth_request - Authentication request data
1919 *
1920 * This structure provides information needed to complete IEEE 802.11
1921 * authentication.
Jouni Malinen636a5d32009-03-19 13:39:22 +02001922 *
Johannes Berg959867f2013-06-19 13:05:42 +02001923 * @bss: The BSS to authenticate with, the callee must obtain a reference
1924 * to it if it needs to keep it.
Jouni Malinen636a5d32009-03-19 13:39:22 +02001925 * @auth_type: Authentication type (algorithm)
1926 * @ie: Extra IEs to add to Authentication frame or %NULL
1927 * @ie_len: Length of ie buffer in octets
Johannes Bergfffd0932009-07-08 14:22:54 +02001928 * @key_len: length of WEP key for shared key authentication
1929 * @key_idx: index of WEP key for shared key authentication
1930 * @key: WEP key for shared key authentication
Jouni Malinen11b6b5a2016-10-27 00:41:58 +03001931 * @auth_data: Fields and elements in Authentication frames. This contains
1932 * the authentication frame body (non-IE and IE data), excluding the
1933 * Authentication algorithm number, i.e., starting at the Authentication
1934 * transaction sequence number field.
1935 * @auth_data_len: Length of auth_data buffer in octets
Jouni Malinen636a5d32009-03-19 13:39:22 +02001936 */
1937struct cfg80211_auth_request {
Johannes Berg19957bb2009-07-02 17:20:43 +02001938 struct cfg80211_bss *bss;
Jouni Malinen636a5d32009-03-19 13:39:22 +02001939 const u8 *ie;
1940 size_t ie_len;
Johannes Berg19957bb2009-07-02 17:20:43 +02001941 enum nl80211_auth_type auth_type;
Johannes Bergfffd0932009-07-08 14:22:54 +02001942 const u8 *key;
1943 u8 key_len, key_idx;
Jouni Malinen11b6b5a2016-10-27 00:41:58 +03001944 const u8 *auth_data;
1945 size_t auth_data_len;
Jouni Malinen636a5d32009-03-19 13:39:22 +02001946};
1947
1948/**
Ben Greear7e7c8922011-11-18 11:31:59 -08001949 * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
1950 *
1951 * @ASSOC_REQ_DISABLE_HT: Disable HT (802.11n)
Johannes Bergee2aca32013-02-21 17:36:01 +01001952 * @ASSOC_REQ_DISABLE_VHT: Disable VHT
Assaf Kraussbab5ab72014-09-03 15:25:01 +03001953 * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
Srinivas Dasari40cbfa92018-01-25 17:13:38 +02001954 * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
1955 * authentication capability. Drivers can offload authentication to
1956 * userspace if this flag is set. Only applicable for cfg80211_connect()
1957 * request (connect callback).
Ben Greear7e7c8922011-11-18 11:31:59 -08001958 */
1959enum cfg80211_assoc_req_flags {
Srinivas Dasari40cbfa92018-01-25 17:13:38 +02001960 ASSOC_REQ_DISABLE_HT = BIT(0),
1961 ASSOC_REQ_DISABLE_VHT = BIT(1),
1962 ASSOC_REQ_USE_RRM = BIT(2),
1963 CONNECT_REQ_EXTERNAL_AUTH_SUPPORT = BIT(3),
Ben Greear7e7c8922011-11-18 11:31:59 -08001964};
1965
1966/**
Jouni Malinen636a5d32009-03-19 13:39:22 +02001967 * struct cfg80211_assoc_request - (Re)Association request data
1968 *
1969 * This structure provides information needed to complete IEEE 802.11
1970 * (re)association.
Johannes Berg959867f2013-06-19 13:05:42 +02001971 * @bss: The BSS to associate with. If the call is successful the driver is
1972 * given a reference that it must give back to cfg80211_send_rx_assoc()
1973 * or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
1974 * association requests while already associating must be rejected.
Jouni Malinen636a5d32009-03-19 13:39:22 +02001975 * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
1976 * @ie_len: Length of ie buffer in octets
Jouni Malinendc6382ce2009-05-06 22:09:37 +03001977 * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
Samuel Ortizb23aa672009-07-01 21:26:54 +02001978 * @crypto: crypto settings
Jouni Malinen35eb8f72016-04-06 17:38:44 +03001979 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
1980 * to indicate a request to reassociate within the ESS instead of a request
1981 * do the initial association with the ESS. When included, this is set to
1982 * the BSSID of the current association, i.e., to the value that is
1983 * included in the Current AP address field of the Reassociation Request
1984 * frame.
Ben Greear7e7c8922011-11-18 11:31:59 -08001985 * @flags: See &enum cfg80211_assoc_req_flags
1986 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
Johannes Bergad24b0d2013-07-05 11:53:28 +02001987 * will be used in ht_capa. Un-supported values will be ignored.
Ben Greear7e7c8922011-11-18 11:31:59 -08001988 * @ht_capa_mask: The bits of ht_capa which are to be used.
Johannes Bergee2aca32013-02-21 17:36:01 +01001989 * @vht_capa: VHT capability override
1990 * @vht_capa_mask: VHT capability mask indicating which fields to use
Jouni Malinen348bd452016-10-27 00:42:03 +03001991 * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
1992 * %NULL if FILS is not used.
1993 * @fils_kek_len: Length of fils_kek in octets
1994 * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
1995 * Request/Response frame or %NULL if FILS is not used. This field starts
1996 * with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
Jouni Malinen636a5d32009-03-19 13:39:22 +02001997 */
1998struct cfg80211_assoc_request {
Johannes Berg19957bb2009-07-02 17:20:43 +02001999 struct cfg80211_bss *bss;
Johannes Berg3e5d7642009-07-07 14:37:26 +02002000 const u8 *ie, *prev_bssid;
Jouni Malinen636a5d32009-03-19 13:39:22 +02002001 size_t ie_len;
Samuel Ortizb23aa672009-07-01 21:26:54 +02002002 struct cfg80211_crypto_settings crypto;
Johannes Berg19957bb2009-07-02 17:20:43 +02002003 bool use_mfp;
Ben Greear7e7c8922011-11-18 11:31:59 -08002004 u32 flags;
2005 struct ieee80211_ht_cap ht_capa;
2006 struct ieee80211_ht_cap ht_capa_mask;
Johannes Bergee2aca32013-02-21 17:36:01 +01002007 struct ieee80211_vht_cap vht_capa, vht_capa_mask;
Jouni Malinen348bd452016-10-27 00:42:03 +03002008 const u8 *fils_kek;
2009 size_t fils_kek_len;
2010 const u8 *fils_nonces;
Jouni Malinen636a5d32009-03-19 13:39:22 +02002011};
2012
2013/**
2014 * struct cfg80211_deauth_request - Deauthentication request data
2015 *
2016 * This structure provides information needed to complete IEEE 802.11
2017 * deauthentication.
2018 *
Johannes Berg95de8172012-01-20 13:55:25 +01002019 * @bssid: the BSSID of the BSS to deauthenticate from
Jouni Malinen636a5d32009-03-19 13:39:22 +02002020 * @ie: Extra IEs to add to Deauthentication frame or %NULL
2021 * @ie_len: Length of ie buffer in octets
Johannes Berg19957bb2009-07-02 17:20:43 +02002022 * @reason_code: The reason code for the deauthentication
Johannes Berg077f8972013-02-08 09:06:36 +01002023 * @local_state_change: if set, change local state only and
2024 * do not set a deauth frame
Jouni Malinen636a5d32009-03-19 13:39:22 +02002025 */
2026struct cfg80211_deauth_request {
Johannes Berg95de8172012-01-20 13:55:25 +01002027 const u8 *bssid;
Jouni Malinen636a5d32009-03-19 13:39:22 +02002028 const u8 *ie;
2029 size_t ie_len;
Johannes Berg19957bb2009-07-02 17:20:43 +02002030 u16 reason_code;
Stanislaw Gruszka68632552012-10-15 14:52:41 +02002031 bool local_state_change;
Jouni Malinen636a5d32009-03-19 13:39:22 +02002032};
2033
2034/**
2035 * struct cfg80211_disassoc_request - Disassociation request data
2036 *
2037 * This structure provides information needed to complete IEEE 802.11
Masahiro Yamada66f00442017-02-27 14:29:42 -08002038 * disassociation.
Jouni Malinen636a5d32009-03-19 13:39:22 +02002039 *
Johannes Berg19957bb2009-07-02 17:20:43 +02002040 * @bss: the BSS to disassociate from
Jouni Malinen636a5d32009-03-19 13:39:22 +02002041 * @ie: Extra IEs to add to Disassociation frame or %NULL
2042 * @ie_len: Length of ie buffer in octets
Johannes Berg19957bb2009-07-02 17:20:43 +02002043 * @reason_code: The reason code for the disassociation
Jouni Malinend5cdfac2010-04-04 09:37:19 +03002044 * @local_state_change: This is a request for a local state only, i.e., no
2045 * Disassociation frame is to be transmitted.
Jouni Malinen636a5d32009-03-19 13:39:22 +02002046 */
2047struct cfg80211_disassoc_request {
Johannes Berg19957bb2009-07-02 17:20:43 +02002048 struct cfg80211_bss *bss;
Jouni Malinen636a5d32009-03-19 13:39:22 +02002049 const u8 *ie;
2050 size_t ie_len;
Johannes Berg19957bb2009-07-02 17:20:43 +02002051 u16 reason_code;
Jouni Malinend5cdfac2010-04-04 09:37:19 +03002052 bool local_state_change;
Jouni Malinen636a5d32009-03-19 13:39:22 +02002053};
2054
2055/**
Johannes Berg04a773a2009-04-19 21:24:32 +02002056 * struct cfg80211_ibss_params - IBSS parameters
2057 *
2058 * This structure defines the IBSS parameters for the join_ibss()
2059 * method.
2060 *
2061 * @ssid: The SSID, will always be non-null.
2062 * @ssid_len: The length of the SSID, will always be non-zero.
2063 * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2064 * search for IBSSs with a different BSSID.
Johannes Berg683b6d32012-11-08 21:25:48 +01002065 * @chandef: defines the channel to use if no other IBSS to join can be found
Johannes Berg04a773a2009-04-19 21:24:32 +02002066 * @channel_fixed: The channel should be fixed -- do not search for
2067 * IBSSs to join on other channels.
2068 * @ie: information element(s) to include in the beacon
2069 * @ie_len: length of that
Johannes Berg8e30bc52009-04-22 17:45:38 +02002070 * @beacon_interval: beacon interval to use
Johannes Bergfffd0932009-07-08 14:22:54 +02002071 * @privacy: this is a protected network, keys will be configured
2072 * after joining
Antonio Quartulli267335d2012-01-31 20:25:47 +01002073 * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2074 * sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2075 * required to assume that the port is unauthorized until authorized by
2076 * user space. Otherwise, port is marked authorized by default.
Denis Kenziorc3bfe1f2018-03-26 12:52:48 -05002077 * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2078 * port frames over NL80211 instead of the network interface.
Simon Wunderlich5336fa82013-10-07 18:41:05 +02002079 * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2080 * changes the channel when a radar is detected. This is required
2081 * to operate on DFS channels.
Teemu Paasikivifbd2c8d2010-06-14 12:55:31 +03002082 * @basic_rates: bitmap of basic rates to use when creating the IBSS
Felix Fietkaudd5b4cc2010-11-22 20:58:24 +01002083 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
Simon Wunderlich803768f2013-06-28 10:39:58 +02002084 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
Johannes Bergad24b0d2013-07-05 11:53:28 +02002085 * will be used in ht_capa. Un-supported values will be ignored.
Simon Wunderlich803768f2013-06-28 10:39:58 +02002086 * @ht_capa_mask: The bits of ht_capa which are to be used.
Tova Mussai9ae3b172017-10-29 11:51:11 +02002087 * @wep_keys: static WEP keys, if not NULL points to an array of
2088 * CFG80211_MAX_WEP_KEYS WEP keys
2089 * @wep_tx_key: key index (0..3) of the default TX static WEP key
Johannes Berg04a773a2009-04-19 21:24:32 +02002090 */
2091struct cfg80211_ibss_params {
Johannes Bergc1e5f472014-05-19 17:53:16 +02002092 const u8 *ssid;
2093 const u8 *bssid;
Johannes Berg683b6d32012-11-08 21:25:48 +01002094 struct cfg80211_chan_def chandef;
Johannes Bergc1e5f472014-05-19 17:53:16 +02002095 const u8 *ie;
Johannes Berg04a773a2009-04-19 21:24:32 +02002096 u8 ssid_len, ie_len;
Johannes Berg8e30bc52009-04-22 17:45:38 +02002097 u16 beacon_interval;
Teemu Paasikivifbd2c8d2010-06-14 12:55:31 +03002098 u32 basic_rates;
Johannes Berg04a773a2009-04-19 21:24:32 +02002099 bool channel_fixed;
Johannes Bergfffd0932009-07-08 14:22:54 +02002100 bool privacy;
Antonio Quartulli267335d2012-01-31 20:25:47 +01002101 bool control_port;
Denis Kenziorc3bfe1f2018-03-26 12:52:48 -05002102 bool control_port_over_nl80211;
Simon Wunderlich5336fa82013-10-07 18:41:05 +02002103 bool userspace_handles_dfs;
Johannes Berg57fbcce2016-04-12 15:56:15 +02002104 int mcast_rate[NUM_NL80211_BANDS];
Simon Wunderlich803768f2013-06-28 10:39:58 +02002105 struct ieee80211_ht_cap ht_capa;
2106 struct ieee80211_ht_cap ht_capa_mask;
Tova Mussai9ae3b172017-10-29 11:51:11 +02002107 struct key_params *wep_keys;
2108 int wep_tx_key;
Johannes Berg04a773a2009-04-19 21:24:32 +02002109};
2110
2111/**
Arend van Spriel38de03d2016-03-02 20:37:18 +01002112 * struct cfg80211_bss_selection - connection parameters for BSS selection.
2113 *
2114 * @behaviour: requested BSS selection behaviour.
2115 * @param: parameters for requestion behaviour.
2116 * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2117 * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2118 */
2119struct cfg80211_bss_selection {
2120 enum nl80211_bss_select_attr behaviour;
2121 union {
Johannes Berg57fbcce2016-04-12 15:56:15 +02002122 enum nl80211_band band_pref;
Arend van Spriel38de03d2016-03-02 20:37:18 +01002123 struct cfg80211_bss_select_adjust adjust;
2124 } param;
2125};
2126
2127/**
Samuel Ortizb23aa672009-07-01 21:26:54 +02002128 * struct cfg80211_connect_params - Connection parameters
2129 *
2130 * This structure provides information needed to complete IEEE 802.11
2131 * authentication and association.
2132 *
2133 * @channel: The channel to use or %NULL if not specified (auto-select based
2134 * on scan results)
Jouni Malinen1df4a512014-01-15 00:00:47 +02002135 * @channel_hint: The channel of the recommended BSS for initial connection or
2136 * %NULL if not specified
Samuel Ortizb23aa672009-07-01 21:26:54 +02002137 * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2138 * results)
Jouni Malinen1df4a512014-01-15 00:00:47 +02002139 * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2140 * %NULL if not specified. Unlike the @bssid parameter, the driver is
2141 * allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2142 * to use.
Samuel Ortizb23aa672009-07-01 21:26:54 +02002143 * @ssid: SSID
2144 * @ssid_len: Length of ssid in octets
2145 * @auth_type: Authentication type (algorithm)
Johannes Bergabe37c42010-06-07 11:12:27 +02002146 * @ie: IEs for association request
2147 * @ie_len: Length of assoc_ie in octets
Samuel Ortizb23aa672009-07-01 21:26:54 +02002148 * @privacy: indicates whether privacy-enabled APs should be used
Jouni Malinencee00a92013-01-15 17:15:57 +02002149 * @mfp: indicate whether management frame protection is used
Samuel Ortizb23aa672009-07-01 21:26:54 +02002150 * @crypto: crypto settings
Johannes Bergfffd0932009-07-08 14:22:54 +02002151 * @key_len: length of WEP key for shared key authentication
2152 * @key_idx: index of WEP key for shared key authentication
2153 * @key: WEP key for shared key authentication
Ben Greear7e7c8922011-11-18 11:31:59 -08002154 * @flags: See &enum cfg80211_assoc_req_flags
Bala Shanmugam4486ea92012-03-07 17:27:12 +05302155 * @bg_scan_period: Background scan period in seconds
Johannes Bergad24b0d2013-07-05 11:53:28 +02002156 * or -1 to indicate that default value is to be used.
Ben Greear7e7c8922011-11-18 11:31:59 -08002157 * @ht_capa: HT Capabilities over-rides. Values set in ht_capa_mask
Johannes Bergad24b0d2013-07-05 11:53:28 +02002158 * will be used in ht_capa. Un-supported values will be ignored.
Ben Greear7e7c8922011-11-18 11:31:59 -08002159 * @ht_capa_mask: The bits of ht_capa which are to be used.
Johannes Bergee2aca32013-02-21 17:36:01 +01002160 * @vht_capa: VHT Capability overrides
2161 * @vht_capa_mask: The bits of vht_capa which are to be used.
Lior David34d50512016-01-28 10:58:25 +02002162 * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2163 * networks.
Arend van Spriel38de03d2016-03-02 20:37:18 +01002164 * @bss_select: criteria to be used for BSS selection.
Jouni Malinen35eb8f72016-04-06 17:38:44 +03002165 * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2166 * to indicate a request to reassociate within the ESS instead of a request
2167 * do the initial association with the ESS. When included, this is set to
2168 * the BSSID of the current association, i.e., to the value that is
2169 * included in the Current AP address field of the Reassociation Request
2170 * frame.
Vidyullatha Kanchanapallya3caf742017-03-31 00:22:34 +03002171 * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2172 * NAI or %NULL if not specified. This is used to construct FILS wrapped
2173 * data IE.
2174 * @fils_erp_username_len: Length of @fils_erp_username in octets.
2175 * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2176 * %NULL if not specified. This specifies the domain name of ER server and
2177 * is used to construct FILS wrapped data IE.
2178 * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2179 * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2180 * messages. This is also used to construct FILS wrapped data IE.
2181 * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2182 * keys in FILS or %NULL if not specified.
2183 * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
Avraham Stern3a00df52017-06-09 13:08:43 +01002184 * @want_1x: indicates user-space supports and wants to use 802.1X driver
2185 * offload of 4-way handshake.
Samuel Ortizb23aa672009-07-01 21:26:54 +02002186 */
2187struct cfg80211_connect_params {
2188 struct ieee80211_channel *channel;
Jouni Malinen1df4a512014-01-15 00:00:47 +02002189 struct ieee80211_channel *channel_hint;
Jouni Malinen664834d2014-01-15 00:01:44 +02002190 const u8 *bssid;
Jouni Malinen1df4a512014-01-15 00:00:47 +02002191 const u8 *bssid_hint;
Jouni Malinen664834d2014-01-15 00:01:44 +02002192 const u8 *ssid;
Samuel Ortizb23aa672009-07-01 21:26:54 +02002193 size_t ssid_len;
2194 enum nl80211_auth_type auth_type;
Johannes Berg4b5800f2014-01-15 14:55:59 +01002195 const u8 *ie;
Samuel Ortizb23aa672009-07-01 21:26:54 +02002196 size_t ie_len;
2197 bool privacy;
Jouni Malinencee00a92013-01-15 17:15:57 +02002198 enum nl80211_mfp mfp;
Samuel Ortizb23aa672009-07-01 21:26:54 +02002199 struct cfg80211_crypto_settings crypto;
Johannes Bergfffd0932009-07-08 14:22:54 +02002200 const u8 *key;
2201 u8 key_len, key_idx;
Ben Greear7e7c8922011-11-18 11:31:59 -08002202 u32 flags;
Bala Shanmugam4486ea92012-03-07 17:27:12 +05302203 int bg_scan_period;
Ben Greear7e7c8922011-11-18 11:31:59 -08002204 struct ieee80211_ht_cap ht_capa;
2205 struct ieee80211_ht_cap ht_capa_mask;
Johannes Bergee2aca32013-02-21 17:36:01 +01002206 struct ieee80211_vht_cap vht_capa;
2207 struct ieee80211_vht_cap vht_capa_mask;
Lior David34d50512016-01-28 10:58:25 +02002208 bool pbss;
Arend van Spriel38de03d2016-03-02 20:37:18 +01002209 struct cfg80211_bss_selection bss_select;
Jouni Malinenba6fbac2016-03-29 13:53:27 +03002210 const u8 *prev_bssid;
Vidyullatha Kanchanapallya3caf742017-03-31 00:22:34 +03002211 const u8 *fils_erp_username;
2212 size_t fils_erp_username_len;
2213 const u8 *fils_erp_realm;
2214 size_t fils_erp_realm_len;
2215 u16 fils_erp_next_seq_num;
2216 const u8 *fils_erp_rrk;
2217 size_t fils_erp_rrk_len;
Avraham Stern3a00df52017-06-09 13:08:43 +01002218 bool want_1x;
Samuel Ortizb23aa672009-07-01 21:26:54 +02002219};
2220
2221/**
vamsi krishna088e8df2016-10-27 16:51:11 +03002222 * enum cfg80211_connect_params_changed - Connection parameters being updated
2223 *
2224 * This enum provides information of all connect parameters that
2225 * have to be updated as part of update_connect_params() call.
2226 *
2227 * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2228 */
2229enum cfg80211_connect_params_changed {
2230 UPDATE_ASSOC_IES = BIT(0),
2231};
2232
2233/**
Jouni Malinenb9a5f8ca2009-04-20 18:39:05 +02002234 * enum wiphy_params_flags - set_wiphy_params bitfield values
Johannes Bergabe37c42010-06-07 11:12:27 +02002235 * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2236 * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2237 * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2238 * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2239 * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
Lorenzo Bianconi3057dbf2014-09-04 23:57:40 +02002240 * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
Toke Høiland-Jørgensen52539ca2018-05-08 13:03:50 +02002241 * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2242 * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2243 * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
Jouni Malinenb9a5f8ca2009-04-20 18:39:05 +02002244 */
2245enum wiphy_params_flags {
2246 WIPHY_PARAM_RETRY_SHORT = 1 << 0,
2247 WIPHY_PARAM_RETRY_LONG = 1 << 1,
2248 WIPHY_PARAM_FRAG_THRESHOLD = 1 << 2,
2249 WIPHY_PARAM_RTS_THRESHOLD = 1 << 3,
Lukáš Turek81077e82009-12-21 22:50:47 +01002250 WIPHY_PARAM_COVERAGE_CLASS = 1 << 4,
Lorenzo Bianconi3057dbf2014-09-04 23:57:40 +02002251 WIPHY_PARAM_DYN_ACK = 1 << 5,
Toke Høiland-Jørgensen52539ca2018-05-08 13:03:50 +02002252 WIPHY_PARAM_TXQ_LIMIT = 1 << 6,
2253 WIPHY_PARAM_TXQ_MEMORY_LIMIT = 1 << 7,
2254 WIPHY_PARAM_TXQ_QUANTUM = 1 << 8,
Jouni Malinenb9a5f8ca2009-04-20 18:39:05 +02002255};
2256
Samuel Ortiz67fbb162009-11-24 23:59:15 +01002257/**
2258 * struct cfg80211_pmksa - PMK Security Association
2259 *
2260 * This structure is passed to the set/del_pmksa() method for PMKSA
2261 * caching.
2262 *
Vidyullatha Kanchanapallya3caf742017-03-31 00:22:34 +03002263 * @bssid: The AP's BSSID (may be %NULL).
2264 * @pmkid: The identifier to refer a PMKSA.
2265 * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2266 * derivation by a FILS STA. Otherwise, %NULL.
2267 * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2268 * the hash algorithm used to generate this.
2269 * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2270 * cache identifier (may be %NULL).
2271 * @ssid_len: Length of the @ssid in octets.
2272 * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2273 * scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2274 * %NULL).
Samuel Ortiz67fbb162009-11-24 23:59:15 +01002275 */
2276struct cfg80211_pmksa {
Johannes Bergc1e5f472014-05-19 17:53:16 +02002277 const u8 *bssid;
2278 const u8 *pmkid;
Vidyullatha Kanchanapallya3caf742017-03-31 00:22:34 +03002279 const u8 *pmk;
2280 size_t pmk_len;
2281 const u8 *ssid;
2282 size_t ssid_len;
2283 const u8 *cache_id;
Samuel Ortiz67fbb162009-11-24 23:59:15 +01002284};
Johannes Berg99303802009-07-01 21:26:59 +02002285
Johannes Berg7643a2c2009-06-02 13:01:39 +02002286/**
Amitkumar Karwar50ac6602013-06-25 19:03:56 -07002287 * struct cfg80211_pkt_pattern - packet pattern
Johannes Bergff1b6e62011-05-04 15:37:28 +02002288 * @mask: bitmask where to match pattern and where to ignore bytes,
2289 * one bit per byte, in same format as nl80211
2290 * @pattern: bytes to match where bitmask is 1
2291 * @pattern_len: length of pattern (in bytes)
Amitkumar Karwarbb92d192013-02-12 12:16:26 -08002292 * @pkt_offset: packet offset (in bytes)
Johannes Bergff1b6e62011-05-04 15:37:28 +02002293 *
2294 * Internal note: @mask and @pattern are allocated in one chunk of
2295 * memory, free @mask only!
2296 */
Amitkumar Karwar50ac6602013-06-25 19:03:56 -07002297struct cfg80211_pkt_pattern {
Johannes Berg922bd802014-05-19 17:59:50 +02002298 const u8 *mask, *pattern;
Johannes Bergff1b6e62011-05-04 15:37:28 +02002299 int pattern_len;
Amitkumar Karwarbb92d192013-02-12 12:16:26 -08002300 int pkt_offset;
Johannes Bergff1b6e62011-05-04 15:37:28 +02002301};
2302
2303/**
Johannes Berg2a0e0472013-01-23 22:57:40 +01002304 * struct cfg80211_wowlan_tcp - TCP connection parameters
2305 *
2306 * @sock: (internal) socket for source port allocation
2307 * @src: source IP address
2308 * @dst: destination IP address
2309 * @dst_mac: destination MAC address
2310 * @src_port: source port
2311 * @dst_port: destination port
2312 * @payload_len: data payload length
2313 * @payload: data payload buffer
2314 * @payload_seq: payload sequence stamping configuration
2315 * @data_interval: interval at which to send data packets
2316 * @wake_len: wakeup payload match length
2317 * @wake_data: wakeup payload match data
2318 * @wake_mask: wakeup payload match mask
2319 * @tokens_size: length of the tokens buffer
2320 * @payload_tok: payload token usage configuration
2321 */
2322struct cfg80211_wowlan_tcp {
2323 struct socket *sock;
2324 __be32 src, dst;
2325 u16 src_port, dst_port;
2326 u8 dst_mac[ETH_ALEN];
2327 int payload_len;
2328 const u8 *payload;
2329 struct nl80211_wowlan_tcp_data_seq payload_seq;
2330 u32 data_interval;
2331 u32 wake_len;
2332 const u8 *wake_data, *wake_mask;
2333 u32 tokens_size;
2334 /* must be last, variable member */
2335 struct nl80211_wowlan_tcp_data_token payload_tok;
Johannes Bergff1b6e62011-05-04 15:37:28 +02002336};
2337
2338/**
2339 * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2340 *
2341 * This structure defines the enabled WoWLAN triggers for the device.
2342 * @any: wake up on any activity -- special trigger if device continues
2343 * operating as normal during suspend
2344 * @disconnect: wake up if getting disconnected
2345 * @magic_pkt: wake up on receiving magic packet
2346 * @patterns: wake up on receiving packet matching a pattern
2347 * @n_patterns: number of patterns
Johannes Berg77dbbb12011-07-13 10:48:55 +02002348 * @gtk_rekey_failure: wake up on GTK rekey failure
2349 * @eap_identity_req: wake up on EAP identity request packet
2350 * @four_way_handshake: wake up on 4-way handshake
2351 * @rfkill_release: wake up when rfkill is released
Johannes Berg2a0e0472013-01-23 22:57:40 +01002352 * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2353 * NULL if not configured.
Luciano Coelho8cd4d452014-09-17 11:55:28 +03002354 * @nd_config: configuration for the scan to be used for net detect wake.
Johannes Bergff1b6e62011-05-04 15:37:28 +02002355 */
2356struct cfg80211_wowlan {
Johannes Berg77dbbb12011-07-13 10:48:55 +02002357 bool any, disconnect, magic_pkt, gtk_rekey_failure,
2358 eap_identity_req, four_way_handshake,
2359 rfkill_release;
Amitkumar Karwar50ac6602013-06-25 19:03:56 -07002360 struct cfg80211_pkt_pattern *patterns;
Johannes Berg2a0e0472013-01-23 22:57:40 +01002361 struct cfg80211_wowlan_tcp *tcp;
Johannes Bergff1b6e62011-05-04 15:37:28 +02002362 int n_patterns;
Luciano Coelho8cd4d452014-09-17 11:55:28 +03002363 struct cfg80211_sched_scan_request *nd_config;
Johannes Bergff1b6e62011-05-04 15:37:28 +02002364};
2365
2366/**
Amitkumar Karwarbe29b99a2013-06-28 11:51:26 -07002367 * struct cfg80211_coalesce_rules - Coalesce rule parameters
2368 *
2369 * This structure defines coalesce rule for the device.
2370 * @delay: maximum coalescing delay in msecs.
2371 * @condition: condition for packet coalescence.
2372 * see &enum nl80211_coalesce_condition.
2373 * @patterns: array of packet patterns
2374 * @n_patterns: number of patterns
2375 */
2376struct cfg80211_coalesce_rules {
2377 int delay;
2378 enum nl80211_coalesce_condition condition;
2379 struct cfg80211_pkt_pattern *patterns;
2380 int n_patterns;
2381};
2382
2383/**
2384 * struct cfg80211_coalesce - Packet coalescing settings
2385 *
2386 * This structure defines coalescing settings.
2387 * @rules: array of coalesce rules
2388 * @n_rules: number of rules
2389 */
2390struct cfg80211_coalesce {
2391 struct cfg80211_coalesce_rules *rules;
2392 int n_rules;
2393};
2394
2395/**
Luciano Coelho8cd4d452014-09-17 11:55:28 +03002396 * struct cfg80211_wowlan_nd_match - information about the match
2397 *
2398 * @ssid: SSID of the match that triggered the wake up
2399 * @n_channels: Number of channels where the match occurred. This
2400 * value may be zero if the driver can't report the channels.
2401 * @channels: center frequencies of the channels where a match
2402 * occurred (in MHz)
2403 */
2404struct cfg80211_wowlan_nd_match {
2405 struct cfg80211_ssid ssid;
2406 int n_channels;
2407 u32 channels[];
2408};
2409
2410/**
2411 * struct cfg80211_wowlan_nd_info - net detect wake up information
2412 *
2413 * @n_matches: Number of match information instances provided in
2414 * @matches. This value may be zero if the driver can't provide
2415 * match information.
2416 * @matches: Array of pointers to matches containing information about
2417 * the matches that triggered the wake up.
2418 */
2419struct cfg80211_wowlan_nd_info {
2420 int n_matches;
2421 struct cfg80211_wowlan_nd_match *matches[];
2422};
2423
2424/**
Johannes Bergcd8f7cb2013-01-22 12:34:29 +01002425 * struct cfg80211_wowlan_wakeup - wakeup report
2426 * @disconnect: woke up by getting disconnected
2427 * @magic_pkt: woke up by receiving magic packet
2428 * @gtk_rekey_failure: woke up by GTK rekey failure
2429 * @eap_identity_req: woke up by EAP identity request packet
2430 * @four_way_handshake: woke up by 4-way handshake
2431 * @rfkill_release: woke up by rfkill being released
2432 * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2433 * @packet_present_len: copied wakeup packet data
2434 * @packet_len: original wakeup packet length
2435 * @packet: The packet causing the wakeup, if any.
2436 * @packet_80211: For pattern match, magic packet and other data
2437 * frame triggers an 802.3 frame should be reported, for
2438 * disconnect due to deauth 802.11 frame. This indicates which
2439 * it is.
Johannes Berg2a0e0472013-01-23 22:57:40 +01002440 * @tcp_match: TCP wakeup packet received
2441 * @tcp_connlost: TCP connection lost or failed to establish
2442 * @tcp_nomoretokens: TCP data ran out of tokens
Luciano Coelho8cd4d452014-09-17 11:55:28 +03002443 * @net_detect: if not %NULL, woke up because of net detect
Johannes Bergcd8f7cb2013-01-22 12:34:29 +01002444 */
2445struct cfg80211_wowlan_wakeup {
2446 bool disconnect, magic_pkt, gtk_rekey_failure,
2447 eap_identity_req, four_way_handshake,
Johannes Berg2a0e0472013-01-23 22:57:40 +01002448 rfkill_release, packet_80211,
2449 tcp_match, tcp_connlost, tcp_nomoretokens;
Johannes Bergcd8f7cb2013-01-22 12:34:29 +01002450 s32 pattern_idx;
2451 u32 packet_present_len, packet_len;
2452 const void *packet;
Luciano Coelho8cd4d452014-09-17 11:55:28 +03002453 struct cfg80211_wowlan_nd_info *net_detect;
Johannes Bergcd8f7cb2013-01-22 12:34:29 +01002454};
2455
2456/**
Johannes Berge5497d72011-07-05 16:35:40 +02002457 * struct cfg80211_gtk_rekey_data - rekey data
Johannes Berg78f686c2014-09-10 22:28:06 +03002458 * @kek: key encryption key (NL80211_KEK_LEN bytes)
2459 * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2460 * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
Johannes Berge5497d72011-07-05 16:35:40 +02002461 */
2462struct cfg80211_gtk_rekey_data {
Johannes Berg78f686c2014-09-10 22:28:06 +03002463 const u8 *kek, *kck, *replay_ctr;
Johannes Berge5497d72011-07-05 16:35:40 +02002464};
2465
2466/**
Jouni Malinen355199e2013-02-27 17:14:27 +02002467 * struct cfg80211_update_ft_ies_params - FT IE Information
2468 *
2469 * This structure provides information needed to update the fast transition IE
2470 *
2471 * @md: The Mobility Domain ID, 2 Octet value
2472 * @ie: Fast Transition IEs
2473 * @ie_len: Length of ft_ie in octets
2474 */
2475struct cfg80211_update_ft_ies_params {
2476 u16 md;
2477 const u8 *ie;
2478 size_t ie_len;
2479};
2480
2481/**
Andrei Otcheretianskib176e622013-11-18 19:06:49 +02002482 * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2483 *
2484 * This structure provides information needed to transmit a mgmt frame
2485 *
2486 * @chan: channel to use
2487 * @offchan: indicates wether off channel operation is required
2488 * @wait: duration for ROC
2489 * @buf: buffer to transmit
2490 * @len: buffer length
2491 * @no_cck: don't use cck rates for this frame
2492 * @dont_wait_for_ack: tells the low level not to wait for an ack
Andrei Otcheretianski34d22ce2014-05-09 14:11:44 +03002493 * @n_csa_offsets: length of csa_offsets array
2494 * @csa_offsets: array of all the csa offsets in the frame
Andrei Otcheretianskib176e622013-11-18 19:06:49 +02002495 */
2496struct cfg80211_mgmt_tx_params {
2497 struct ieee80211_channel *chan;
2498 bool offchan;
2499 unsigned int wait;
2500 const u8 *buf;
2501 size_t len;
2502 bool no_cck;
2503 bool dont_wait_for_ack;
Andrei Otcheretianski34d22ce2014-05-09 14:11:44 +03002504 int n_csa_offsets;
2505 const u16 *csa_offsets;
Andrei Otcheretianskib176e622013-11-18 19:06:49 +02002506};
2507
2508/**
Kyeyoon Parkfa9ffc72013-12-16 23:01:30 -08002509 * struct cfg80211_dscp_exception - DSCP exception
2510 *
2511 * @dscp: DSCP value that does not adhere to the user priority range definition
2512 * @up: user priority value to which the corresponding DSCP value belongs
2513 */
2514struct cfg80211_dscp_exception {
2515 u8 dscp;
2516 u8 up;
2517};
2518
2519/**
2520 * struct cfg80211_dscp_range - DSCP range definition for user priority
2521 *
2522 * @low: lowest DSCP value of this user priority range, inclusive
2523 * @high: highest DSCP value of this user priority range, inclusive
2524 */
2525struct cfg80211_dscp_range {
2526 u8 low;
2527 u8 high;
2528};
2529
2530/* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2531#define IEEE80211_QOS_MAP_MAX_EX 21
2532#define IEEE80211_QOS_MAP_LEN_MIN 16
2533#define IEEE80211_QOS_MAP_LEN_MAX \
2534 (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2535
2536/**
2537 * struct cfg80211_qos_map - QoS Map Information
2538 *
2539 * This struct defines the Interworking QoS map setting for DSCP values
2540 *
2541 * @num_des: number of DSCP exceptions (0..21)
2542 * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2543 * the user priority DSCP range definition
2544 * @up: DSCP range definition for a particular user priority
2545 */
2546struct cfg80211_qos_map {
2547 u8 num_des;
2548 struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2549 struct cfg80211_dscp_range up[8];
2550};
2551
2552/**
Ayala Bekercb3b7d82016-09-20 17:31:13 +03002553 * struct cfg80211_nan_conf - NAN configuration
2554 *
2555 * This struct defines NAN configuration parameters
2556 *
2557 * @master_pref: master preference (1 - 255)
Luca Coelho85859892017-02-08 15:00:34 +02002558 * @bands: operating bands, a bitmap of &enum nl80211_band values.
2559 * For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2560 * (i.e. BIT(NL80211_BAND_2GHZ)).
Ayala Bekercb3b7d82016-09-20 17:31:13 +03002561 */
2562struct cfg80211_nan_conf {
2563 u8 master_pref;
Luca Coelho85859892017-02-08 15:00:34 +02002564 u8 bands;
Ayala Bekercb3b7d82016-09-20 17:31:13 +03002565};
2566
2567/**
Ayala Bekera5a9dcf2016-09-20 17:31:16 +03002568 * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2569 * configuration
2570 *
2571 * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
Luca Coelho85859892017-02-08 15:00:34 +02002572 * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
Ayala Bekera5a9dcf2016-09-20 17:31:16 +03002573 */
2574enum cfg80211_nan_conf_changes {
2575 CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
Luca Coelho85859892017-02-08 15:00:34 +02002576 CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
Ayala Bekera5a9dcf2016-09-20 17:31:16 +03002577};
2578
2579/**
Ayala Bekera442b762016-09-20 17:31:15 +03002580 * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2581 *
2582 * @filter: the content of the filter
2583 * @len: the length of the filter
2584 */
2585struct cfg80211_nan_func_filter {
2586 const u8 *filter;
2587 u8 len;
2588};
2589
2590/**
2591 * struct cfg80211_nan_func - a NAN function
2592 *
2593 * @type: &enum nl80211_nan_function_type
2594 * @service_id: the service ID of the function
2595 * @publish_type: &nl80211_nan_publish_type
2596 * @close_range: if true, the range should be limited. Threshold is
2597 * implementation specific.
2598 * @publish_bcast: if true, the solicited publish should be broadcasted
2599 * @subscribe_active: if true, the subscribe is active
2600 * @followup_id: the instance ID for follow up
2601 * @followup_reqid: the requestor instance ID for follow up
2602 * @followup_dest: MAC address of the recipient of the follow up
2603 * @ttl: time to live counter in DW.
2604 * @serv_spec_info: Service Specific Info
2605 * @serv_spec_info_len: Service Specific Info length
2606 * @srf_include: if true, SRF is inclusive
2607 * @srf_bf: Bloom Filter
2608 * @srf_bf_len: Bloom Filter length
2609 * @srf_bf_idx: Bloom Filter index
2610 * @srf_macs: SRF MAC addresses
2611 * @srf_num_macs: number of MAC addresses in SRF
2612 * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2613 * @tx_filters: filters that should be transmitted in the SDF.
2614 * @num_rx_filters: length of &rx_filters.
2615 * @num_tx_filters: length of &tx_filters.
2616 * @instance_id: driver allocated id of the function.
2617 * @cookie: unique NAN function identifier.
2618 */
2619struct cfg80211_nan_func {
2620 enum nl80211_nan_function_type type;
2621 u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2622 u8 publish_type;
2623 bool close_range;
2624 bool publish_bcast;
2625 bool subscribe_active;
2626 u8 followup_id;
2627 u8 followup_reqid;
2628 struct mac_address followup_dest;
2629 u32 ttl;
2630 const u8 *serv_spec_info;
2631 u8 serv_spec_info_len;
2632 bool srf_include;
2633 const u8 *srf_bf;
2634 u8 srf_bf_len;
2635 u8 srf_bf_idx;
2636 struct mac_address *srf_macs;
2637 int srf_num_macs;
2638 struct cfg80211_nan_func_filter *rx_filters;
2639 struct cfg80211_nan_func_filter *tx_filters;
2640 u8 num_tx_filters;
2641 u8 num_rx_filters;
2642 u8 instance_id;
2643 u64 cookie;
2644};
2645
2646/**
Avraham Stern3a00df52017-06-09 13:08:43 +01002647 * struct cfg80211_pmk_conf - PMK configuration
2648 *
2649 * @aa: authenticator address
2650 * @pmk_len: PMK length in bytes.
2651 * @pmk: the PMK material
2652 * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
2653 * is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
2654 * holds PMK-R0.
2655 */
2656struct cfg80211_pmk_conf {
2657 const u8 *aa;
2658 u8 pmk_len;
2659 const u8 *pmk;
2660 const u8 *pmk_r0_name;
2661};
2662
2663/**
Srinivas Dasari40cbfa92018-01-25 17:13:38 +02002664 * struct cfg80211_external_auth_params - Trigger External authentication.
2665 *
2666 * Commonly used across the external auth request and event interfaces.
2667 *
2668 * @action: action type / trigger for external authentication. Only significant
2669 * for the authentication request event interface (driver to user space).
2670 * @bssid: BSSID of the peer with which the authentication has
2671 * to happen. Used by both the authentication request event and
2672 * authentication response command interface.
2673 * @ssid: SSID of the AP. Used by both the authentication request event and
2674 * authentication response command interface.
2675 * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
2676 * authentication request event interface.
2677 * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
2678 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
2679 * the real status code for failures. Used only for the authentication
2680 * response command interface (user space to driver).
2681 */
2682struct cfg80211_external_auth_params {
2683 enum nl80211_external_auth_action action;
2684 u8 bssid[ETH_ALEN] __aligned(2);
2685 struct cfg80211_ssid ssid;
2686 unsigned int key_mgmt_suite;
2687 u16 status;
2688};
2689
2690/**
Johannes Berg704232c2007-04-23 12:20:05 -07002691 * struct cfg80211_ops - backend description for wireless configuration
2692 *
2693 * This struct is registered by fullmac card drivers and/or wireless stacks
2694 * in order to handle configuration requests on their interfaces.
2695 *
2696 * All callbacks except where otherwise noted should return 0
2697 * on success or a negative error code.
2698 *
Johannes Berg43fb45cb2007-04-24 14:07:27 -07002699 * All operations are currently invoked under rtnl for consistency with the
2700 * wireless extensions but this is subject to reevaluation as soon as this
2701 * code is used more widely and we have a first user without wext.
2702 *
Johannes Bergff1b6e62011-05-04 15:37:28 +02002703 * @suspend: wiphy device needs to be suspended. The variable @wow will
2704 * be %NULL or contain the enabled Wake-on-Wireless triggers that are
2705 * configured for the device.
Johannes Berg0378b3f2009-01-19 11:20:52 -05002706 * @resume: wiphy device needs to be resumed
Johannes Berg6d525632012-04-04 15:05:25 +02002707 * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
2708 * to call device_set_wakeup_enable() to enable/disable wakeup from
2709 * the device.
Johannes Berg0378b3f2009-01-19 11:20:52 -05002710 *
Johannes Berg60719ff2008-09-16 14:55:09 +02002711 * @add_virtual_intf: create a new virtual interface with the given name,
Johannes Berg463d0182009-07-14 00:33:35 +02002712 * must set the struct wireless_dev's iftype. Beware: You must create
Johannes Berg84efbb82012-06-16 00:00:26 +02002713 * the new netdev in the wiphy's network namespace! Returns the struct
Johannes Berg98104fde2012-06-16 00:19:54 +02002714 * wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
2715 * also set the address member in the wdev.
Johannes Berg704232c2007-04-23 12:20:05 -07002716 *
Johannes Berg84efbb82012-06-16 00:00:26 +02002717 * @del_virtual_intf: remove the virtual interface
Johannes Berg55682962007-09-20 13:09:35 -04002718 *
Johannes Berg60719ff2008-09-16 14:55:09 +02002719 * @change_virtual_intf: change type/configuration of virtual interface,
2720 * keep the struct wireless_dev's iftype updated.
Johannes Berg55682962007-09-20 13:09:35 -04002721 *
Johannes Berg41ade002007-12-19 02:03:29 +01002722 * @add_key: add a key with the given parameters. @mac_addr will be %NULL
2723 * when adding a group key.
2724 *
2725 * @get_key: get information about the key with the given parameters.
2726 * @mac_addr will be %NULL when requesting information for a group
2727 * key. All pointers given to the @callback function need not be valid
Johannes Berge3da5742009-05-18 19:56:36 +02002728 * after it returns. This function should return an error if it is
2729 * not possible to retrieve the key, -ENOENT if it doesn't exist.
Johannes Berg41ade002007-12-19 02:03:29 +01002730 *
2731 * @del_key: remove a key given the @mac_addr (%NULL for a group key)
Johannes Berge3da5742009-05-18 19:56:36 +02002732 * and @key_index, return -ENOENT if the key doesn't exist.
Johannes Berg41ade002007-12-19 02:03:29 +01002733 *
2734 * @set_default_key: set the default key on an interface
Johannes Berged1b6cc2007-12-19 02:03:32 +01002735 *
Jouni Malinen3cfcf6ac2009-01-08 13:32:02 +02002736 * @set_default_mgmt_key: set the default management frame key on an interface
2737 *
Johannes Berge5497d72011-07-05 16:35:40 +02002738 * @set_rekey_data: give the data necessary for GTK rekeying to the driver
2739 *
Johannes Bergc04a4ff2012-03-01 15:28:19 +01002740 * @start_ap: Start acting in AP mode defined by the parameters.
2741 * @change_beacon: Change the beacon parameters for an access point mode
2742 * interface. This should reject the call when AP mode wasn't started.
2743 * @stop_ap: Stop being an AP, including stopping beaconing.
Johannes Berg5727ef12007-12-19 02:03:34 +01002744 *
2745 * @add_station: Add a new station.
Jouni Malinen89c771e2014-10-10 20:52:40 +03002746 * @del_station: Remove a station
Johannes Bergbdd90d52011-12-14 12:20:27 +01002747 * @change_station: Modify a given station. Note that flags changes are not much
2748 * validated in cfg80211, in particular the auth/assoc/authorized flags
2749 * might come to the driver in invalid combinations -- make sure to check
Johannes Berg77ee7c82013-02-15 00:48:33 +01002750 * them, also against the existing state! Drivers must call
2751 * cfg80211_check_station_change() to validate the information.
Johannes Bergabe37c42010-06-07 11:12:27 +02002752 * @get_station: get station information for the station identified by @mac
2753 * @dump_station: dump station callback -- resume dump at index @idx
2754 *
2755 * @add_mpath: add a fixed mesh path
2756 * @del_mpath: delete a given mesh path
2757 * @change_mpath: change a given mesh path
2758 * @get_mpath: get a mesh path for the given parameters
2759 * @dump_mpath: dump mesh path callback -- resume dump at index @idx
Henning Rogge66be7d22014-09-12 08:58:49 +02002760 * @get_mpp: get a mesh proxy path for the given parameters
2761 * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
Johannes Bergf52555a2011-01-06 22:36:45 +01002762 * @join_mesh: join the mesh network with the specified parameters
Johannes Berg8d61ffa2013-05-10 12:32:47 +02002763 * (invoked with the wireless_dev mutex held)
Johannes Bergf52555a2011-01-06 22:36:45 +01002764 * @leave_mesh: leave the current mesh network
Johannes Berg8d61ffa2013-05-10 12:32:47 +02002765 * (invoked with the wireless_dev mutex held)
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01002766 *
Javier Cardona24bdd9f2010-12-16 17:37:48 -08002767 * @get_mesh_config: Get the current mesh configuration
colin@cozybit.com93da9cc2008-10-21 12:03:48 -07002768 *
Javier Cardona24bdd9f2010-12-16 17:37:48 -08002769 * @update_mesh_config: Update mesh parameters on a running mesh.
colin@cozybit.com93da9cc2008-10-21 12:03:48 -07002770 * The mask is a bitfield which tells us which parameters to
2771 * set, and which to leave alone.
2772 *
Jouni Malinen9f1ba902008-08-07 20:07:01 +03002773 * @change_bss: Modify parameters for a given BSS.
Jouni Malinen31888482008-10-30 16:59:24 +02002774 *
2775 * @set_txq_params: Set TX queue parameters
Jouni Malinen72bdcf32008-11-26 16:15:24 +02002776 *
Johannes Berge8c9bd52012-06-06 08:18:22 +02002777 * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
2778 * as it doesn't implement join_mesh and needs to set the channel to
2779 * join the mesh instead.
2780 *
2781 * @set_monitor_channel: Set the monitor mode channel for the device. If other
2782 * interfaces are active this callback should reject the configuration.
2783 * If no interfaces are active or the device is down, the channel should
2784 * be stored for when a monitor interface becomes active.
Jouni Malinen9aed3cc2009-01-13 16:03:29 +02002785 *
Johannes Berg2a519312009-02-10 21:25:55 +01002786 * @scan: Request to do a scan. If returning zero, the scan request is given
2787 * the driver, and will be valid until passed to cfg80211_scan_done().
2788 * For scan results, call cfg80211_inform_bss(); you can call this outside
2789 * the scan/scan_done bracket too.
Vidyullatha Kanchanapally91d3ab42015-10-30 19:14:49 +05302790 * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
2791 * indicate the status of the scan through cfg80211_scan_done().
Jouni Malinen636a5d32009-03-19 13:39:22 +02002792 *
2793 * @auth: Request to authenticate with the specified peer
Johannes Berg8d61ffa2013-05-10 12:32:47 +02002794 * (invoked with the wireless_dev mutex held)
Jouni Malinen636a5d32009-03-19 13:39:22 +02002795 * @assoc: Request to (re)associate with the specified peer
Johannes Berg8d61ffa2013-05-10 12:32:47 +02002796 * (invoked with the wireless_dev mutex held)
Jouni Malinen636a5d32009-03-19 13:39:22 +02002797 * @deauth: Request to deauthenticate from the specified peer
Johannes Berg8d61ffa2013-05-10 12:32:47 +02002798 * (invoked with the wireless_dev mutex held)
Jouni Malinen636a5d32009-03-19 13:39:22 +02002799 * @disassoc: Request to disassociate from the specified peer
Johannes Berg8d61ffa2013-05-10 12:32:47 +02002800 * (invoked with the wireless_dev mutex held)
Johannes Berg04a773a2009-04-19 21:24:32 +02002801 *
Samuel Ortizb23aa672009-07-01 21:26:54 +02002802 * @connect: Connect to the ESS with the specified parameters. When connected,
Jouni Malinenbf1ecd22016-05-31 00:16:50 +03002803 * call cfg80211_connect_result()/cfg80211_connect_bss() with status code
2804 * %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
2805 * cfg80211_connect_result()/cfg80211_connect_bss() with the status code
2806 * from the AP or cfg80211_connect_timeout() if no frame with status code
2807 * was received.
2808 * The driver is allowed to roam to other BSSes within the ESS when the
2809 * other BSS matches the connect parameters. When such roaming is initiated
2810 * by the driver, the driver is expected to verify that the target matches
2811 * the configured security parameters and to use Reassociation Request
2812 * frame instead of Association Request frame.
2813 * The connect function can also be used to request the driver to perform a
2814 * specific roam when connected to an ESS. In that case, the prev_bssid
Jouni Malinen35eb8f72016-04-06 17:38:44 +03002815 * parameter is set to the BSSID of the currently associated BSS as an
Jouni Malinenbf1ecd22016-05-31 00:16:50 +03002816 * indication of requesting reassociation.
2817 * In both the driver-initiated and new connect() call initiated roaming
2818 * cases, the result of roaming is indicated with a call to
Avraham Stern29ce6ec2017-04-26 10:58:49 +03002819 * cfg80211_roamed(). (invoked with the wireless_dev mutex held)
vamsi krishna088e8df2016-10-27 16:51:11 +03002820 * @update_connect_params: Update the connect parameters while connected to a
2821 * BSS. The updated parameters can be used by driver/firmware for
2822 * subsequent BSS selection (roaming) decisions and to form the
2823 * Authentication/(Re)Association Request frames. This call does not
2824 * request an immediate disassociation or reassociation with the current
2825 * BSS, i.e., this impacts only subsequent (re)associations. The bits in
2826 * changed are defined in &enum cfg80211_connect_params_changed.
2827 * (invoked with the wireless_dev mutex held)
Ilan Peer0711d632016-10-18 23:12:13 +03002828 * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
2829 * connection is in progress. Once done, call cfg80211_disconnected() in
2830 * case connection was already established (invoked with the
2831 * wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
Samuel Ortizb23aa672009-07-01 21:26:54 +02002832 *
Johannes Berg04a773a2009-04-19 21:24:32 +02002833 * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
2834 * cfg80211_ibss_joined(), also call that function when changing BSSID due
2835 * to a merge.
Johannes Berg8d61ffa2013-05-10 12:32:47 +02002836 * (invoked with the wireless_dev mutex held)
Johannes Berg04a773a2009-04-19 21:24:32 +02002837 * @leave_ibss: Leave the IBSS.
Johannes Berg8d61ffa2013-05-10 12:32:47 +02002838 * (invoked with the wireless_dev mutex held)
Jouni Malinenb9a5f8ca2009-04-20 18:39:05 +02002839 *
Antonio Quartullif4e583c2012-11-02 13:27:48 +01002840 * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
2841 * MESH mode)
2842 *
Jouni Malinenb9a5f8ca2009-04-20 18:39:05 +02002843 * @set_wiphy_params: Notify that wiphy parameters have changed;
2844 * @changed bitfield (see &enum wiphy_params_flags) describes which values
2845 * have changed. The actual parameter values are available in
2846 * struct wiphy. If returning an error, no value should be changed.
Johannes Berg7643a2c2009-06-02 13:01:39 +02002847 *
Luis R. Rodriguez1432de02011-11-28 16:38:46 -05002848 * @set_tx_power: set the transmit power according to the parameters,
Johannes Bergc8442112012-10-24 10:17:18 +02002849 * the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
2850 * wdev may be %NULL if power was set for the wiphy, and will
2851 * always be %NULL unless the driver supports per-vif TX power
2852 * (as advertised by the nl80211 feature flag.)
Johannes Berg7643a2c2009-06-02 13:01:39 +02002853 * @get_tx_power: store the current TX power into the dbm variable;
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002854 * return 0 if successful
2855 *
Johannes Bergabe37c42010-06-07 11:12:27 +02002856 * @set_wds_peer: set the WDS peer for a WDS interface
2857 *
Johannes Berg1f87f7d2009-06-02 13:01:41 +02002858 * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
2859 * functions to adjust rfkill hw state
Johannes Bergaff89a92009-07-01 21:26:51 +02002860 *
Holger Schurig61fa7132009-11-11 12:25:40 +01002861 * @dump_survey: get site survey information.
2862 *
Jouni Malinen9588bbd2009-12-23 13:15:41 +01002863 * @remain_on_channel: Request the driver to remain awake on the specified
2864 * channel for the specified duration to complete an off-channel
2865 * operation (e.g., public action frame exchange). When the driver is
2866 * ready on the requested channel, it must indicate this with an event
2867 * notification by calling cfg80211_ready_on_channel().
2868 * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
2869 * This allows the operation to be terminated prior to timeout based on
2870 * the duration value.
Johannes Bergf7ca38d2010-11-25 10:02:29 +01002871 * @mgmt_tx: Transmit a management frame.
2872 * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
2873 * frame on another channel
Jouni Malinen9588bbd2009-12-23 13:15:41 +01002874 *
David Spinadelfc73f112013-07-31 18:04:15 +03002875 * @testmode_cmd: run a test mode command; @wdev may be %NULL
Wey-Yi Guy71063f02011-05-20 09:05:54 -07002876 * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
2877 * used by the function, but 0 and 1 must not be touched. Additionally,
2878 * return error codes other than -ENOBUFS and -ENOENT will terminate the
2879 * dump and return to userspace with an error, so be careful. If any data
2880 * was passed in from userspace then the data/len arguments will be present
2881 * and point to the data contained in %NL80211_ATTR_TESTDATA.
Samuel Ortiz67fbb162009-11-24 23:59:15 +01002882 *
Johannes Bergabe37c42010-06-07 11:12:27 +02002883 * @set_bitrate_mask: set the bitrate mask configuration
2884 *
Samuel Ortiz67fbb162009-11-24 23:59:15 +01002885 * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
2886 * devices running firmwares capable of generating the (re) association
2887 * RSN IE. It allows for faster roaming between WPA2 BSSIDs.
2888 * @del_pmksa: Delete a cached PMKID.
2889 * @flush_pmksa: Flush all cached PMKIDs.
Juuso Oikarinen9043f3b2010-04-27 12:47:41 +03002890 * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
2891 * allows the driver to adjust the dynamic ps timeout value.
Juuso Oikarinend6dc1a32010-03-23 09:02:33 +02002892 * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
Johannes Berge86abc62015-10-22 17:35:14 +02002893 * After configuration, the driver should (soon) send an event indicating
2894 * the current level is above/below the configured threshold; this may
2895 * need some care when the configuration is changed (without first being
2896 * disabled.)
Andrew Zaborowski4a4b8162017-02-10 10:02:31 +01002897 * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
2898 * connection quality monitor. An event is to be sent only when the
2899 * signal level is found to be outside the two values. The driver should
2900 * set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
2901 * If it is provided then there's no point providing @set_cqm_rssi_config.
Thomas Pedersen84f10702012-07-12 16:17:33 -07002902 * @set_cqm_txe_config: Configure connection quality monitor TX error
2903 * thresholds.
Luciano Coelho807f8a82011-05-11 17:09:35 +03002904 * @sched_scan_start: Tell the driver to start a scheduled scan.
Arend Van Spriel3a3ecf12017-04-21 13:05:02 +01002905 * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
2906 * given request id. This call must stop the scheduled scan and be ready
2907 * for starting a new one before it returns, i.e. @sched_scan_start may be
2908 * called immediately after that again and should not fail in that case.
2909 * The driver should not call cfg80211_sched_scan_stopped() for a requested
2910 * stop (when this method returns 0).
Samuel Ortiz67fbb162009-11-24 23:59:15 +01002911 *
Johannes Berg271733c2010-10-13 12:06:23 +02002912 * @mgmt_frame_register: Notify driver that a management frame type was
Johannes Berg33d87832015-06-23 17:47:05 +02002913 * registered. The callback is allowed to sleep.
Bruno Randolf547025d2010-12-02 16:23:12 +09002914 *
2915 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
2916 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
2917 * reject TX/RX mask combinations they cannot support by returning -EINVAL
2918 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
2919 *
2920 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
John W. Linville36777132011-03-07 16:17:59 -05002921 *
Arik Nemtsov109086c2011-09-28 14:12:50 +03002922 * @tdls_mgmt: Transmit a TDLS management frame.
2923 * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
Johannes Berg7f6cf312011-11-04 11:18:15 +01002924 *
2925 * @probe_client: probe an associated client, must return a cookie that it
2926 * later passes to cfg80211_probe_status().
Simon Wunderlich1d9d9212011-11-18 14:20:43 +01002927 *
2928 * @set_noack_map: Set the NoAck Map for the TIDs.
Ben Greeard6199212012-04-23 12:50:29 -07002929 *
Johannes Berg5b7ccaf2012-07-12 19:45:08 +02002930 * @get_channel: Get the current operating channel for the virtual interface.
2931 * For monitor interfaces, it should return %NULL unless there's a single
2932 * current monitoring channel.
Johannes Berg98104fde2012-06-16 00:19:54 +02002933 *
2934 * @start_p2p_device: Start the given P2P device.
2935 * @stop_p2p_device: Stop the given P2P device.
Vasanthakumar Thiagarajan77765ea2013-01-18 11:18:45 +05302936 *
2937 * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
2938 * Parameters include ACL policy, an array of MAC address of stations
2939 * and the number of MAC addresses. If there is already a list in driver
2940 * this new list replaces the existing one. Driver has to clear its ACL
2941 * when number of MAC addresses entries is passed as 0. Drivers which
2942 * advertise the support for MAC based ACL have to implement this callback.
Simon Wunderlich04f39042013-02-08 18:16:19 +01002943 *
2944 * @start_radar_detection: Start radar detection in the driver.
Jouni Malinen8bf24292013-03-25 11:15:59 +02002945 *
2946 * @update_ft_ies: Provide updated Fast BSS Transition information to the
2947 * driver. If the SME is in the driver/firmware, this information can be
2948 * used in building Authentication and Reassociation Request frames.
Arend van Spriel5de17982013-04-18 15:49:00 +02002949 *
2950 * @crit_proto_start: Indicates a critical protocol needs more link reliability
2951 * for a given duration (milliseconds). The protocol is provided so the
2952 * driver can take the most appropriate actions.
2953 * @crit_proto_stop: Indicates critical protocol no longer needs increased link
2954 * reliability. This operation can not fail.
Amitkumar Karwarbe29b99a2013-06-28 11:51:26 -07002955 * @set_coalesce: Set coalesce parameters.
Simon Wunderlich16ef1fe2013-07-11 16:09:05 +02002956 *
Michal Kazior97dc94f2014-06-25 12:35:10 +02002957 * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
2958 * responsible for veryfing if the switch is possible. Since this is
2959 * inherently tricky driver may decide to disconnect an interface later
2960 * with cfg80211_stop_iface(). This doesn't mean driver can accept
2961 * everything. It should do it's best to verify requests and reject them
2962 * as soon as possible.
Kyeyoon Parkfa9ffc72013-12-16 23:01:30 -08002963 *
2964 * @set_qos_map: Set QoS mapping information to the driver
Jouni Malinene16821b2014-04-28 11:22:08 +03002965 *
2966 * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
2967 * given interface This is used e.g. for dynamic HT 20/40 MHz channel width
2968 * changes during the lifetime of the BSS.
Johannes Berg960d01a2014-09-09 22:55:35 +03002969 *
2970 * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
2971 * with the given parameters; action frame exchange has been handled by
2972 * userspace so this just has to modify the TX path to take the TS into
2973 * account.
2974 * If the admitted time is 0 just validate the parameters to make sure
2975 * the session can be created at all; it is valid to just always return
2976 * success for that but that may result in inefficient behaviour (handshake
2977 * with the peer followed by immediate teardown when the addition is later
2978 * rejected)
2979 * @del_tx_ts: remove an existing TX TS
Rostislav Lisovy6e0bd6c2014-11-03 10:33:18 +01002980 *
2981 * @join_ocb: join the OCB network with the specified parameters
2982 * (invoked with the wireless_dev mutex held)
2983 * @leave_ocb: leave the current OCB network
2984 * (invoked with the wireless_dev mutex held)
Arik Nemtsov1057d352014-11-19 12:54:26 +02002985 *
2986 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
2987 * is responsible for continually initiating channel-switching operations
2988 * and returning to the base channel for communication with the AP.
2989 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
2990 * peers must be on the base channel when the call completes.
Ayala Bekercb3b7d82016-09-20 17:31:13 +03002991 * @start_nan: Start the NAN interface.
2992 * @stop_nan: Stop the NAN interface.
Ayala Bekera442b762016-09-20 17:31:15 +03002993 * @add_nan_func: Add a NAN function. Returns negative value on failure.
2994 * On success @nan_func ownership is transferred to the driver and
2995 * it may access it outside of the scope of this function. The driver
2996 * should free the @nan_func when no longer needed by calling
2997 * cfg80211_free_nan_func().
2998 * On success the driver should assign an instance_id in the
2999 * provided @nan_func.
3000 * @del_nan_func: Delete a NAN function.
Ayala Bekera5a9dcf2016-09-20 17:31:16 +03003001 * @nan_change_conf: changes NAN configuration. The changed parameters must
3002 * be specified in @changes (using &enum cfg80211_nan_conf_changes);
3003 * All other parameters must be ignored.
Michael Braunce0ce132016-10-10 19:12:22 +02003004 *
3005 * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
Avraham Stern3a00df52017-06-09 13:08:43 +01003006 *
Toke Høiland-Jørgensen52539ca2018-05-08 13:03:50 +02003007 * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3008 * function should return phy stats, and interface stats otherwise.
3009 *
Avraham Stern3a00df52017-06-09 13:08:43 +01003010 * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3011 * If not deleted through @del_pmk the PMK remains valid until disconnect
3012 * upon which the driver should clear it.
3013 * (invoked with the wireless_dev mutex held)
3014 * @del_pmk: delete the previously configured PMK for the given authenticator.
3015 * (invoked with the wireless_dev mutex held)
Srinivas Dasari40cbfa92018-01-25 17:13:38 +02003016 *
3017 * @external_auth: indicates result of offloaded authentication processing from
3018 * user space
Denis Kenzior2576a9a2018-03-26 12:52:42 -05003019 *
3020 * @tx_control_port: TX a control port frame (EAPoL). The noencrypt parameter
3021 * tells the driver that the frame should not be encrypted.
Johannes Berg704232c2007-04-23 12:20:05 -07003022 */
3023struct cfg80211_ops {
Johannes Bergff1b6e62011-05-04 15:37:28 +02003024 int (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
Johannes Berg0378b3f2009-01-19 11:20:52 -05003025 int (*resume)(struct wiphy *wiphy);
Johannes Berg6d525632012-04-04 15:05:25 +02003026 void (*set_wakeup)(struct wiphy *wiphy, bool enabled);
Johannes Berg0378b3f2009-01-19 11:20:52 -05003027
Johannes Berg84efbb82012-06-16 00:00:26 +02003028 struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
Johannes Berg552bff02012-09-19 09:26:06 +02003029 const char *name,
Tom Gundersen6bab2e192015-03-18 11:13:39 +01003030 unsigned char name_assign_type,
Johannes Berg84efbb82012-06-16 00:00:26 +02003031 enum nl80211_iftype type,
Johannes Berg84efbb82012-06-16 00:00:26 +02003032 struct vif_params *params);
3033 int (*del_virtual_intf)(struct wiphy *wiphy,
3034 struct wireless_dev *wdev);
Johannes Berge36d56b2009-06-09 21:04:43 +02003035 int (*change_virtual_intf)(struct wiphy *wiphy,
3036 struct net_device *dev,
Johannes Berg818a9862017-04-12 11:23:28 +02003037 enum nl80211_iftype type,
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01003038 struct vif_params *params);
Johannes Berg41ade002007-12-19 02:03:29 +01003039
3040 int (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
Johannes Berge31b8212010-10-05 19:39:30 +02003041 u8 key_index, bool pairwise, const u8 *mac_addr,
Johannes Berg41ade002007-12-19 02:03:29 +01003042 struct key_params *params);
3043 int (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
Johannes Berge31b8212010-10-05 19:39:30 +02003044 u8 key_index, bool pairwise, const u8 *mac_addr,
3045 void *cookie,
Johannes Berg41ade002007-12-19 02:03:29 +01003046 void (*callback)(void *cookie, struct key_params*));
3047 int (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
Johannes Berge31b8212010-10-05 19:39:30 +02003048 u8 key_index, bool pairwise, const u8 *mac_addr);
Johannes Berg41ade002007-12-19 02:03:29 +01003049 int (*set_default_key)(struct wiphy *wiphy,
3050 struct net_device *netdev,
Johannes Bergdbd2fd62010-12-09 19:58:59 +01003051 u8 key_index, bool unicast, bool multicast);
Jouni Malinen3cfcf6ac2009-01-08 13:32:02 +02003052 int (*set_default_mgmt_key)(struct wiphy *wiphy,
3053 struct net_device *netdev,
3054 u8 key_index);
Johannes Berged1b6cc2007-12-19 02:03:32 +01003055
Johannes Berg88600202012-02-13 15:17:18 +01003056 int (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3057 struct cfg80211_ap_settings *settings);
3058 int (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3059 struct cfg80211_beacon_data *info);
3060 int (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
Johannes Berg5727ef12007-12-19 02:03:34 +01003061
3062
3063 int (*add_station)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003064 const u8 *mac,
3065 struct station_parameters *params);
Johannes Berg5727ef12007-12-19 02:03:34 +01003066 int (*del_station)(struct wiphy *wiphy, struct net_device *dev,
Jouni Malinen89c771e2014-10-10 20:52:40 +03003067 struct station_del_parameters *params);
Johannes Berg5727ef12007-12-19 02:03:34 +01003068 int (*change_station)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003069 const u8 *mac,
3070 struct station_parameters *params);
Johannes Bergfd5b74d2007-12-19 02:03:36 +01003071 int (*get_station)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003072 const u8 *mac, struct station_info *sinfo);
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01003073 int (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003074 int idx, u8 *mac, struct station_info *sinfo);
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01003075
3076 int (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003077 const u8 *dst, const u8 *next_hop);
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01003078 int (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003079 const u8 *dst);
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01003080 int (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003081 const u8 *dst, const u8 *next_hop);
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01003082 int (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003083 u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
Luis Carlos Cobo2ec600d2008-02-23 15:17:06 +01003084 int (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003085 int idx, u8 *dst, u8 *next_hop,
3086 struct mpath_info *pinfo);
Henning Rogge66be7d22014-09-12 08:58:49 +02003087 int (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3088 u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3089 int (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3090 int idx, u8 *dst, u8 *mpp,
3091 struct mpath_info *pinfo);
Javier Cardona24bdd9f2010-12-16 17:37:48 -08003092 int (*get_mesh_config)(struct wiphy *wiphy,
colin@cozybit.com93da9cc2008-10-21 12:03:48 -07003093 struct net_device *dev,
3094 struct mesh_config *conf);
Javier Cardona24bdd9f2010-12-16 17:37:48 -08003095 int (*update_mesh_config)(struct wiphy *wiphy,
Johannes Berg29cbe682010-12-03 09:20:44 +01003096 struct net_device *dev, u32 mask,
3097 const struct mesh_config *nconf);
3098 int (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3099 const struct mesh_config *conf,
3100 const struct mesh_setup *setup);
3101 int (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3102
Rostislav Lisovy6e0bd6c2014-11-03 10:33:18 +01003103 int (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3104 struct ocb_setup *setup);
3105 int (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3106
Jouni Malinen9f1ba902008-08-07 20:07:01 +03003107 int (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3108 struct bss_parameters *params);
Jouni Malinen31888482008-10-30 16:59:24 +02003109
Eliad Pellerf70f01c2011-09-25 20:06:53 +03003110 int (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
Jouni Malinen31888482008-10-30 16:59:24 +02003111 struct ieee80211_txq_params *params);
Jouni Malinen72bdcf32008-11-26 16:15:24 +02003112
Johannes Berge8c9bd52012-06-06 08:18:22 +02003113 int (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3114 struct net_device *dev,
3115 struct ieee80211_channel *chan);
3116
3117 int (*set_monitor_channel)(struct wiphy *wiphy,
Johannes Berg683b6d32012-11-08 21:25:48 +01003118 struct cfg80211_chan_def *chandef);
Jouni Malinen9aed3cc2009-01-13 16:03:29 +02003119
Johannes Bergfd014282012-06-18 19:17:03 +02003120 int (*scan)(struct wiphy *wiphy,
Johannes Berg2a519312009-02-10 21:25:55 +01003121 struct cfg80211_scan_request *request);
Vidyullatha Kanchanapally91d3ab42015-10-30 19:14:49 +05303122 void (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
Jouni Malinen636a5d32009-03-19 13:39:22 +02003123
3124 int (*auth)(struct wiphy *wiphy, struct net_device *dev,
3125 struct cfg80211_auth_request *req);
3126 int (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3127 struct cfg80211_assoc_request *req);
3128 int (*deauth)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg63c9c5e2012-02-24 13:50:51 +01003129 struct cfg80211_deauth_request *req);
Jouni Malinen636a5d32009-03-19 13:39:22 +02003130 int (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg63c9c5e2012-02-24 13:50:51 +01003131 struct cfg80211_disassoc_request *req);
Johannes Berg04a773a2009-04-19 21:24:32 +02003132
Samuel Ortizb23aa672009-07-01 21:26:54 +02003133 int (*connect)(struct wiphy *wiphy, struct net_device *dev,
3134 struct cfg80211_connect_params *sme);
vamsi krishna088e8df2016-10-27 16:51:11 +03003135 int (*update_connect_params)(struct wiphy *wiphy,
3136 struct net_device *dev,
3137 struct cfg80211_connect_params *sme,
3138 u32 changed);
Samuel Ortizb23aa672009-07-01 21:26:54 +02003139 int (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3140 u16 reason_code);
3141
Johannes Berg04a773a2009-04-19 21:24:32 +02003142 int (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3143 struct cfg80211_ibss_params *params);
3144 int (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
Jouni Malinenb9a5f8ca2009-04-20 18:39:05 +02003145
Antonio Quartullif4e583c2012-11-02 13:27:48 +01003146 int (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg57fbcce2016-04-12 15:56:15 +02003147 int rate[NUM_NL80211_BANDS]);
Antonio Quartullif4e583c2012-11-02 13:27:48 +01003148
Jouni Malinenb9a5f8ca2009-04-20 18:39:05 +02003149 int (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
Johannes Berg7643a2c2009-06-02 13:01:39 +02003150
Johannes Bergc8442112012-10-24 10:17:18 +02003151 int (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
Juuso Oikarinenfa61cf72010-06-23 12:12:37 +03003152 enum nl80211_tx_power_setting type, int mbm);
Johannes Bergc8442112012-10-24 10:17:18 +02003153 int (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3154 int *dbm);
Johannes Berg1f87f7d2009-06-02 13:01:41 +02003155
Johannes Bergab737a42009-07-01 21:26:58 +02003156 int (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg388ac772010-10-07 13:11:09 +02003157 const u8 *addr);
Johannes Bergab737a42009-07-01 21:26:58 +02003158
Johannes Berg1f87f7d2009-06-02 13:01:41 +02003159 void (*rfkill_poll)(struct wiphy *wiphy);
Johannes Bergaff89a92009-07-01 21:26:51 +02003160
3161#ifdef CONFIG_NL80211_TESTMODE
David Spinadelfc73f112013-07-31 18:04:15 +03003162 int (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3163 void *data, int len);
Wey-Yi Guy71063f02011-05-20 09:05:54 -07003164 int (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3165 struct netlink_callback *cb,
3166 void *data, int len);
Johannes Bergaff89a92009-07-01 21:26:51 +02003167#endif
Johannes Bergbc92afd2009-07-01 21:26:57 +02003168
Johannes Berg99303802009-07-01 21:26:59 +02003169 int (*set_bitrate_mask)(struct wiphy *wiphy,
3170 struct net_device *dev,
3171 const u8 *peer,
3172 const struct cfg80211_bitrate_mask *mask);
3173
Holger Schurig61fa7132009-11-11 12:25:40 +01003174 int (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3175 int idx, struct survey_info *info);
3176
Samuel Ortiz67fbb162009-11-24 23:59:15 +01003177 int (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3178 struct cfg80211_pmksa *pmksa);
3179 int (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3180 struct cfg80211_pmksa *pmksa);
3181 int (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3182
Jouni Malinen9588bbd2009-12-23 13:15:41 +01003183 int (*remain_on_channel)(struct wiphy *wiphy,
Johannes Berg71bbc992012-06-15 15:30:18 +02003184 struct wireless_dev *wdev,
Jouni Malinen9588bbd2009-12-23 13:15:41 +01003185 struct ieee80211_channel *chan,
Jouni Malinen9588bbd2009-12-23 13:15:41 +01003186 unsigned int duration,
3187 u64 *cookie);
3188 int (*cancel_remain_on_channel)(struct wiphy *wiphy,
Johannes Berg71bbc992012-06-15 15:30:18 +02003189 struct wireless_dev *wdev,
Jouni Malinen9588bbd2009-12-23 13:15:41 +01003190 u64 cookie);
3191
Johannes Berg71bbc992012-06-15 15:30:18 +02003192 int (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
Andrei Otcheretianskib176e622013-11-18 19:06:49 +02003193 struct cfg80211_mgmt_tx_params *params,
3194 u64 *cookie);
Johannes Bergf7ca38d2010-11-25 10:02:29 +01003195 int (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
Johannes Berg71bbc992012-06-15 15:30:18 +02003196 struct wireless_dev *wdev,
Johannes Bergf7ca38d2010-11-25 10:02:29 +01003197 u64 cookie);
Jouni Malinen026331c2010-02-15 12:53:10 +02003198
Johannes Bergbc92afd2009-07-01 21:26:57 +02003199 int (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3200 bool enabled, int timeout);
Juuso Oikarinend6dc1a32010-03-23 09:02:33 +02003201
3202 int (*set_cqm_rssi_config)(struct wiphy *wiphy,
3203 struct net_device *dev,
3204 s32 rssi_thold, u32 rssi_hyst);
Johannes Berg271733c2010-10-13 12:06:23 +02003205
Andrew Zaborowski4a4b8162017-02-10 10:02:31 +01003206 int (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3207 struct net_device *dev,
3208 s32 rssi_low, s32 rssi_high);
3209
Thomas Pedersen84f10702012-07-12 16:17:33 -07003210 int (*set_cqm_txe_config)(struct wiphy *wiphy,
3211 struct net_device *dev,
3212 u32 rate, u32 pkts, u32 intvl);
3213
Johannes Berg271733c2010-10-13 12:06:23 +02003214 void (*mgmt_frame_register)(struct wiphy *wiphy,
Johannes Berg71bbc992012-06-15 15:30:18 +02003215 struct wireless_dev *wdev,
Johannes Berg271733c2010-10-13 12:06:23 +02003216 u16 frame_type, bool reg);
Bruno Randolfafe0cbf2010-11-10 12:50:50 +09003217
3218 int (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3219 int (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
John W. Linville36777132011-03-07 16:17:59 -05003220
Luciano Coelho807f8a82011-05-11 17:09:35 +03003221 int (*sched_scan_start)(struct wiphy *wiphy,
3222 struct net_device *dev,
3223 struct cfg80211_sched_scan_request *request);
Arend Van Spriel3a3ecf12017-04-21 13:05:02 +01003224 int (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3225 u64 reqid);
Johannes Berge5497d72011-07-05 16:35:40 +02003226
3227 int (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3228 struct cfg80211_gtk_rekey_data *data);
Arik Nemtsov109086c2011-09-28 14:12:50 +03003229
3230 int (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003231 const u8 *peer, u8 action_code, u8 dialog_token,
Sunil Dutt Undekaridf942e72014-02-20 16:22:09 +05303232 u16 status_code, u32 peer_capability,
Arik Nemtsov31fa97c2014-06-11 17:18:21 +03003233 bool initiator, const u8 *buf, size_t len);
Arik Nemtsov109086c2011-09-28 14:12:50 +03003234 int (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
Johannes Berg3b3a0162014-05-19 17:19:31 +02003235 const u8 *peer, enum nl80211_tdls_operation oper);
Johannes Berg7f6cf312011-11-04 11:18:15 +01003236
3237 int (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3238 const u8 *peer, u64 *cookie);
Johannes Berge9998822011-11-09 10:30:21 +01003239
Simon Wunderlich1d9d9212011-11-18 14:20:43 +01003240 int (*set_noack_map)(struct wiphy *wiphy,
3241 struct net_device *dev,
3242 u16 noack_map);
3243
Johannes Berg683b6d32012-11-08 21:25:48 +01003244 int (*get_channel)(struct wiphy *wiphy,
Johannes Berg5b7ccaf2012-07-12 19:45:08 +02003245 struct wireless_dev *wdev,
Johannes Berg683b6d32012-11-08 21:25:48 +01003246 struct cfg80211_chan_def *chandef);
Johannes Berg98104fde2012-06-16 00:19:54 +02003247
3248 int (*start_p2p_device)(struct wiphy *wiphy,
3249 struct wireless_dev *wdev);
3250 void (*stop_p2p_device)(struct wiphy *wiphy,
3251 struct wireless_dev *wdev);
Vasanthakumar Thiagarajan77765ea2013-01-18 11:18:45 +05303252
3253 int (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3254 const struct cfg80211_acl_data *params);
Simon Wunderlich04f39042013-02-08 18:16:19 +01003255
3256 int (*start_radar_detection)(struct wiphy *wiphy,
3257 struct net_device *dev,
Janusz Dziedzic31559f32014-02-21 19:46:13 +01003258 struct cfg80211_chan_def *chandef,
3259 u32 cac_time_ms);
Jouni Malinen355199e2013-02-27 17:14:27 +02003260 int (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3261 struct cfg80211_update_ft_ies_params *ftie);
Arend van Spriel5de17982013-04-18 15:49:00 +02003262 int (*crit_proto_start)(struct wiphy *wiphy,
3263 struct wireless_dev *wdev,
3264 enum nl80211_crit_proto_id protocol,
3265 u16 duration);
3266 void (*crit_proto_stop)(struct wiphy *wiphy,
3267 struct wireless_dev *wdev);
Amitkumar Karwarbe29b99a2013-06-28 11:51:26 -07003268 int (*set_coalesce)(struct wiphy *wiphy,
3269 struct cfg80211_coalesce *coalesce);
Simon Wunderlich16ef1fe2013-07-11 16:09:05 +02003270
3271 int (*channel_switch)(struct wiphy *wiphy,
3272 struct net_device *dev,
3273 struct cfg80211_csa_settings *params);
Jouni Malinene16821b2014-04-28 11:22:08 +03003274
Kyeyoon Parkfa9ffc72013-12-16 23:01:30 -08003275 int (*set_qos_map)(struct wiphy *wiphy,
3276 struct net_device *dev,
3277 struct cfg80211_qos_map *qos_map);
Jouni Malinene16821b2014-04-28 11:22:08 +03003278
3279 int (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3280 struct cfg80211_chan_def *chandef);
Johannes Berg960d01a2014-09-09 22:55:35 +03003281
3282 int (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3283 u8 tsid, const u8 *peer, u8 user_prio,
3284 u16 admitted_time);
3285 int (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3286 u8 tsid, const u8 *peer);
Arik Nemtsov1057d352014-11-19 12:54:26 +02003287
3288 int (*tdls_channel_switch)(struct wiphy *wiphy,
3289 struct net_device *dev,
3290 const u8 *addr, u8 oper_class,
3291 struct cfg80211_chan_def *chandef);
3292 void (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3293 struct net_device *dev,
3294 const u8 *addr);
Ayala Bekercb3b7d82016-09-20 17:31:13 +03003295 int (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3296 struct cfg80211_nan_conf *conf);
3297 void (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
Ayala Bekera442b762016-09-20 17:31:15 +03003298 int (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3299 struct cfg80211_nan_func *nan_func);
3300 void (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3301 u64 cookie);
Ayala Bekera5a9dcf2016-09-20 17:31:16 +03003302 int (*nan_change_conf)(struct wiphy *wiphy,
3303 struct wireless_dev *wdev,
3304 struct cfg80211_nan_conf *conf,
3305 u32 changes);
Michael Braunce0ce132016-10-10 19:12:22 +02003306
3307 int (*set_multicast_to_unicast)(struct wiphy *wiphy,
3308 struct net_device *dev,
3309 const bool enabled);
Avraham Stern3a00df52017-06-09 13:08:43 +01003310
Toke Høiland-Jørgensen52539ca2018-05-08 13:03:50 +02003311 int (*get_txq_stats)(struct wiphy *wiphy,
3312 struct wireless_dev *wdev,
3313 struct cfg80211_txq_stats *txqstats);
3314
Avraham Stern3a00df52017-06-09 13:08:43 +01003315 int (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3316 const struct cfg80211_pmk_conf *conf);
3317 int (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3318 const u8 *aa);
Srinivas Dasari40cbfa92018-01-25 17:13:38 +02003319 int (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
3320 struct cfg80211_external_auth_params *params);
Denis Kenzior2576a9a2018-03-26 12:52:42 -05003321
3322 int (*tx_control_port)(struct wiphy *wiphy,
3323 struct net_device *dev,
3324 const u8 *buf, size_t len,
3325 const u8 *dest, const __be16 proto,
3326 const bool noencrypt);
Johannes Berg704232c2007-04-23 12:20:05 -07003327};
3328
Johannes Bergd3236552009-04-20 14:31:42 +02003329/*
3330 * wireless hardware and networking interfaces structures
3331 * and registration/helper functions
3332 */
3333
3334/**
Johannes Berg5be83de2009-11-19 00:56:28 +01003335 * enum wiphy_flags - wiphy capability flags
3336 *
Johannes Berg5be83de2009-11-19 00:56:28 +01003337 * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3338 * wiphy at all
3339 * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3340 * by default -- this flag will be set depending on the kernel's default
3341 * on wiphy_new(), but can be changed by the driver if it has a good
3342 * reason to override the default
Johannes Berg9bc383d2009-11-19 11:55:19 +01003343 * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3344 * on a VLAN interface)
3345 * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
Johannes Bergc0692b82010-08-27 14:26:53 +03003346 * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3347 * control port protocol ethertype. The device also honours the
3348 * control_port_no_encrypt flag.
Johannes Berge31b8212010-10-05 19:39:30 +02003349 * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
Javier Cardona15d5dda2011-04-07 15:08:28 -07003350 * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3351 * auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
Vivek Natarajanf4b34b52011-08-29 14:23:03 +05303352 * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3353 * firmware.
Eliad Pellercedb5412011-08-31 11:29:43 +03003354 * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
Arik Nemtsov109086c2011-09-28 14:12:50 +03003355 * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3356 * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3357 * link setup/discovery operations internally. Setup, discovery and
3358 * teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3359 * command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3360 * used for asking the driver/firmware to perform a TDLS operation.
Johannes Berg562a7482011-11-07 12:39:33 +01003361 * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
Johannes Berg5e760232011-11-04 11:18:17 +01003362 * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3363 * when there are virtual interfaces in AP mode by calling
3364 * cfg80211_report_obss_beacon().
Arik Nemtsov87bbbe22011-11-10 11:28:55 +02003365 * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3366 * responds to probe-requests in hardware.
Johannes Berg7c4ef712011-11-18 15:33:48 +01003367 * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3368 * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
Simon Wunderlich2f301ab2013-05-16 13:00:28 +02003369 * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
Simon Wunderlich16ef1fe2013-07-11 16:09:05 +02003370 * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3371 * beaconing mode (AP, IBSS, Mesh, ...).
David Spinadelb8676222016-09-22 23:16:50 +03003372 * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3373 * before connection.
Johannes Berg5be83de2009-11-19 00:56:28 +01003374 */
3375enum wiphy_flags {
Johannes Berg723e73a2014-10-22 09:25:06 +02003376 /* use hole at 0 */
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +01003377 /* use hole at 1 */
3378 /* use hole at 2 */
Johannes Bergc0692b82010-08-27 14:26:53 +03003379 WIPHY_FLAG_NETNS_OK = BIT(3),
3380 WIPHY_FLAG_PS_ON_BY_DEFAULT = BIT(4),
3381 WIPHY_FLAG_4ADDR_AP = BIT(5),
3382 WIPHY_FLAG_4ADDR_STATION = BIT(6),
3383 WIPHY_FLAG_CONTROL_PORT_PROTOCOL = BIT(7),
Jussi Kivilinna309075c2010-11-12 08:53:56 +02003384 WIPHY_FLAG_IBSS_RSN = BIT(8),
Javier Cardona15d5dda2011-04-07 15:08:28 -07003385 WIPHY_FLAG_MESH_AUTH = BIT(10),
Arend Van Sprielca986ad2017-04-21 13:05:00 +01003386 /* use hole at 11 */
Johannes Berg8e8b41f2012-03-15 10:16:16 +01003387 /* use hole at 12 */
Vivek Natarajanf4b34b52011-08-29 14:23:03 +05303388 WIPHY_FLAG_SUPPORTS_FW_ROAM = BIT(13),
Eliad Pellercedb5412011-08-31 11:29:43 +03003389 WIPHY_FLAG_AP_UAPSD = BIT(14),
Arik Nemtsov109086c2011-09-28 14:12:50 +03003390 WIPHY_FLAG_SUPPORTS_TDLS = BIT(15),
3391 WIPHY_FLAG_TDLS_EXTERNAL_SETUP = BIT(16),
Johannes Berg562a7482011-11-07 12:39:33 +01003392 WIPHY_FLAG_HAVE_AP_SME = BIT(17),
Johannes Berg5e760232011-11-04 11:18:17 +01003393 WIPHY_FLAG_REPORTS_OBSS = BIT(18),
Arik Nemtsov87bbbe22011-11-10 11:28:55 +02003394 WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD = BIT(19),
Johannes Berg7c4ef712011-11-18 15:33:48 +01003395 WIPHY_FLAG_OFFCHAN_TX = BIT(20),
3396 WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL = BIT(21),
Simon Wunderlich2f301ab2013-05-16 13:00:28 +02003397 WIPHY_FLAG_SUPPORTS_5_10_MHZ = BIT(22),
Simon Wunderlich16ef1fe2013-07-11 16:09:05 +02003398 WIPHY_FLAG_HAS_CHANNEL_SWITCH = BIT(23),
David Spinadelb8676222016-09-22 23:16:50 +03003399 WIPHY_FLAG_HAS_STATIC_WEP = BIT(24),
Johannes Berg7527a782011-05-13 10:58:57 +02003400};
3401
3402/**
3403 * struct ieee80211_iface_limit - limit on certain interface types
3404 * @max: maximum number of interfaces of these types
3405 * @types: interface types (bits)
3406 */
3407struct ieee80211_iface_limit {
3408 u16 max;
3409 u16 types;
3410};
3411
3412/**
3413 * struct ieee80211_iface_combination - possible interface combination
Johannes Berg7527a782011-05-13 10:58:57 +02003414 *
Luciano Coelhob80edbc2014-02-20 16:45:34 +02003415 * With this structure the driver can describe which interface
3416 * combinations it supports concurrently.
Johannes Berg7527a782011-05-13 10:58:57 +02003417 *
Luciano Coelhob80edbc2014-02-20 16:45:34 +02003418 * Examples:
3419 *
3420 * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
Johannes Berg7527a782011-05-13 10:58:57 +02003421 *
Johannes Berg819bf592016-10-11 14:56:53 +02003422 * .. code-block:: c
3423 *
3424 * struct ieee80211_iface_limit limits1[] = {
3425 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3426 * { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
3427 * };
3428 * struct ieee80211_iface_combination combination1 = {
3429 * .limits = limits1,
3430 * .n_limits = ARRAY_SIZE(limits1),
3431 * .max_interfaces = 2,
3432 * .beacon_int_infra_match = true,
3433 * };
Johannes Berg7527a782011-05-13 10:58:57 +02003434 *
3435 *
Luciano Coelhob80edbc2014-02-20 16:45:34 +02003436 * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
Johannes Berg7527a782011-05-13 10:58:57 +02003437 *
Johannes Berg819bf592016-10-11 14:56:53 +02003438 * .. code-block:: c
3439 *
3440 * struct ieee80211_iface_limit limits2[] = {
3441 * { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
3442 * BIT(NL80211_IFTYPE_P2P_GO), },
3443 * };
3444 * struct ieee80211_iface_combination combination2 = {
3445 * .limits = limits2,
3446 * .n_limits = ARRAY_SIZE(limits2),
3447 * .max_interfaces = 8,
3448 * .num_different_channels = 1,
3449 * };
Johannes Berg7527a782011-05-13 10:58:57 +02003450 *
3451 *
Luciano Coelhob80edbc2014-02-20 16:45:34 +02003452 * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
3453 *
Johannes Berg819bf592016-10-11 14:56:53 +02003454 * This allows for an infrastructure connection and three P2P connections.
Johannes Berg7527a782011-05-13 10:58:57 +02003455 *
Johannes Berg819bf592016-10-11 14:56:53 +02003456 * .. code-block:: c
3457 *
3458 * struct ieee80211_iface_limit limits3[] = {
3459 * { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
3460 * { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
3461 * BIT(NL80211_IFTYPE_P2P_CLIENT), },
3462 * };
3463 * struct ieee80211_iface_combination combination3 = {
3464 * .limits = limits3,
3465 * .n_limits = ARRAY_SIZE(limits3),
3466 * .max_interfaces = 4,
3467 * .num_different_channels = 2,
3468 * };
3469 *
Johannes Berg7527a782011-05-13 10:58:57 +02003470 */
3471struct ieee80211_iface_combination {
Johannes Bergc6c94ae2017-01-13 10:02:13 +01003472 /**
3473 * @limits:
3474 * limits for the given interface types
3475 */
Johannes Berg7527a782011-05-13 10:58:57 +02003476 const struct ieee80211_iface_limit *limits;
Johannes Bergc6c94ae2017-01-13 10:02:13 +01003477
3478 /**
3479 * @num_different_channels:
3480 * can use up to this many different channels
3481 */
Johannes Berg7527a782011-05-13 10:58:57 +02003482 u32 num_different_channels;
Johannes Bergc6c94ae2017-01-13 10:02:13 +01003483
3484 /**
3485 * @max_interfaces:
3486 * maximum number of interfaces in total allowed in this group
3487 */
Johannes Berg7527a782011-05-13 10:58:57 +02003488 u16 max_interfaces;
Johannes Bergc6c94ae2017-01-13 10:02:13 +01003489
3490 /**
3491 * @n_limits:
3492 * number of limitations
3493 */
Johannes Berg7527a782011-05-13 10:58:57 +02003494 u8 n_limits;
Johannes Bergc6c94ae2017-01-13 10:02:13 +01003495
3496 /**
3497 * @beacon_int_infra_match:
3498 * In this combination, the beacon intervals between infrastructure
3499 * and AP types must match. This is required only in special cases.
3500 */
Johannes Berg7527a782011-05-13 10:58:57 +02003501 bool beacon_int_infra_match;
Johannes Bergc6c94ae2017-01-13 10:02:13 +01003502
3503 /**
3504 * @radar_detect_widths:
3505 * bitmap of channel widths supported for radar detection
3506 */
Simon Wunderlich11c4a072013-01-08 14:04:07 +01003507 u8 radar_detect_widths;
Johannes Bergc6c94ae2017-01-13 10:02:13 +01003508
3509 /**
3510 * @radar_detect_regions:
3511 * bitmap of regions supported for radar detection
3512 */
Felix Fietkau8c48b502014-05-05 11:48:40 +02003513 u8 radar_detect_regions;
Johannes Bergc6c94ae2017-01-13 10:02:13 +01003514
3515 /**
3516 * @beacon_int_min_gcd:
3517 * This interface combination supports different beacon intervals.
3518 *
3519 * = 0
3520 * all beacon intervals for different interface must be same.
3521 * > 0
3522 * any beacon interval for the interface part of this combination AND
3523 * GCD of all beacon intervals from beaconing interfaces of this
3524 * combination must be greater or equal to this value.
3525 */
Purushottam Kushwaha0c317a02016-10-12 18:26:51 +05303526 u32 beacon_int_min_gcd;
Johannes Berg5be83de2009-11-19 00:56:28 +01003527};
3528
Johannes Berg2e161f782010-08-12 15:38:38 +02003529struct ieee80211_txrx_stypes {
3530 u16 tx, rx;
3531};
3532
Johannes Berg5be83de2009-11-19 00:56:28 +01003533/**
Johannes Bergff1b6e62011-05-04 15:37:28 +02003534 * enum wiphy_wowlan_support_flags - WoWLAN support flags
3535 * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
3536 * trigger that keeps the device operating as-is and
3537 * wakes up the host on any activity, for example a
3538 * received packet that passed filtering; note that the
3539 * packet should be preserved in that case
3540 * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
3541 * (see nl80211.h)
3542 * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
Johannes Berg77dbbb12011-07-13 10:48:55 +02003543 * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
3544 * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
3545 * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
3546 * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
3547 * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
Luciano Coelho8cd4d452014-09-17 11:55:28 +03003548 * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
Johannes Bergff1b6e62011-05-04 15:37:28 +02003549 */
3550enum wiphy_wowlan_support_flags {
Johannes Berg77dbbb12011-07-13 10:48:55 +02003551 WIPHY_WOWLAN_ANY = BIT(0),
3552 WIPHY_WOWLAN_MAGIC_PKT = BIT(1),
3553 WIPHY_WOWLAN_DISCONNECT = BIT(2),
3554 WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
3555 WIPHY_WOWLAN_GTK_REKEY_FAILURE = BIT(4),
3556 WIPHY_WOWLAN_EAP_IDENTITY_REQ = BIT(5),
3557 WIPHY_WOWLAN_4WAY_HANDSHAKE = BIT(6),
3558 WIPHY_WOWLAN_RFKILL_RELEASE = BIT(7),
Luciano Coelho8cd4d452014-09-17 11:55:28 +03003559 WIPHY_WOWLAN_NET_DETECT = BIT(8),
Johannes Bergff1b6e62011-05-04 15:37:28 +02003560};
3561
Johannes Berg2a0e0472013-01-23 22:57:40 +01003562struct wiphy_wowlan_tcp_support {
3563 const struct nl80211_wowlan_tcp_data_token_feature *tok;
3564 u32 data_payload_max;
3565 u32 data_interval_max;
3566 u32 wake_payload_max;
3567 bool seq;
3568};
3569
Johannes Bergff1b6e62011-05-04 15:37:28 +02003570/**
3571 * struct wiphy_wowlan_support - WoWLAN support data
3572 * @flags: see &enum wiphy_wowlan_support_flags
3573 * @n_patterns: number of supported wakeup patterns
3574 * (see nl80211.h for the pattern definition)
3575 * @pattern_max_len: maximum length of each pattern
3576 * @pattern_min_len: minimum length of each pattern
Amitkumar Karwarbb92d192013-02-12 12:16:26 -08003577 * @max_pkt_offset: maximum Rx packet offset
Luciano Coelho8cd4d452014-09-17 11:55:28 +03003578 * @max_nd_match_sets: maximum number of matchsets for net-detect,
3579 * similar, but not necessarily identical, to max_match_sets for
3580 * scheduled scans.
3581 * See &struct cfg80211_sched_scan_request.@match_sets for more
3582 * details.
Johannes Berg2a0e0472013-01-23 22:57:40 +01003583 * @tcp: TCP wakeup support information
Johannes Bergff1b6e62011-05-04 15:37:28 +02003584 */
3585struct wiphy_wowlan_support {
3586 u32 flags;
3587 int n_patterns;
3588 int pattern_max_len;
3589 int pattern_min_len;
Amitkumar Karwarbb92d192013-02-12 12:16:26 -08003590 int max_pkt_offset;
Luciano Coelho8cd4d452014-09-17 11:55:28 +03003591 int max_nd_match_sets;
Johannes Berg2a0e0472013-01-23 22:57:40 +01003592 const struct wiphy_wowlan_tcp_support *tcp;
Johannes Bergff1b6e62011-05-04 15:37:28 +02003593};
3594
3595/**
Amitkumar Karwarbe29b99a2013-06-28 11:51:26 -07003596 * struct wiphy_coalesce_support - coalesce support data
3597 * @n_rules: maximum number of coalesce rules
3598 * @max_delay: maximum supported coalescing delay in msecs
3599 * @n_patterns: number of supported patterns in a rule
3600 * (see nl80211.h for the pattern definition)
3601 * @pattern_max_len: maximum length of each pattern
3602 * @pattern_min_len: minimum length of each pattern
3603 * @max_pkt_offset: maximum Rx packet offset
3604 */
3605struct wiphy_coalesce_support {
3606 int n_rules;
3607 int max_delay;
3608 int n_patterns;
3609 int pattern_max_len;
3610 int pattern_min_len;
3611 int max_pkt_offset;
3612};
3613
3614/**
Johannes Bergad7e7182013-11-13 13:37:47 +01003615 * enum wiphy_vendor_command_flags - validation flags for vendor commands
3616 * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
3617 * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
3618 * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
3619 * (must be combined with %_WDEV or %_NETDEV)
3620 */
3621enum wiphy_vendor_command_flags {
3622 WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
3623 WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
3624 WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
3625};
3626
3627/**
tamizhr@codeaurora.org466b9932018-01-31 16:24:49 +05303628 * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
3629 *
3630 * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
3631 * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
3632 * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
3633 *
3634 */
3635enum wiphy_opmode_flag {
3636 STA_OPMODE_MAX_BW_CHANGED = BIT(0),
3637 STA_OPMODE_SMPS_MODE_CHANGED = BIT(1),
3638 STA_OPMODE_N_SS_CHANGED = BIT(2),
3639};
3640
3641/**
3642 * struct sta_opmode_info - Station's ht/vht operation mode information
3643 * @changed: contains value from &enum wiphy_opmode_flag
tamizhr@codeaurora.org5e78abd2018-03-27 19:16:15 +05303644 * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
3645 * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
tamizhr@codeaurora.org466b9932018-01-31 16:24:49 +05303646 * @rx_nss: new rx_nss value of a station
3647 */
3648
3649struct sta_opmode_info {
3650 u32 changed;
tamizhr@codeaurora.org5e78abd2018-03-27 19:16:15 +05303651 enum nl80211_smps_mode smps_mode;
3652 enum nl80211_chan_width bw;
tamizhr@codeaurora.org466b9932018-01-31 16:24:49 +05303653 u8 rx_nss;
3654};
3655
3656/**
Johannes Bergad7e7182013-11-13 13:37:47 +01003657 * struct wiphy_vendor_command - vendor command definition
3658 * @info: vendor command identifying information, as used in nl80211
3659 * @flags: flags, see &enum wiphy_vendor_command_flags
3660 * @doit: callback for the operation, note that wdev is %NULL if the
3661 * flags didn't ask for a wdev and non-%NULL otherwise; the data
3662 * pointer may be %NULL if userspace provided no data at all
Johannes Berg7bdbe402015-08-15 22:39:49 +03003663 * @dumpit: dump callback, for transferring bigger/multiple items. The
3664 * @storage points to cb->args[5], ie. is preserved over the multiple
3665 * dumpit calls.
3666 * It's recommended to not have the same sub command with both @doit and
3667 * @dumpit, so that userspace can assume certain ones are get and others
3668 * are used with dump requests.
Johannes Bergad7e7182013-11-13 13:37:47 +01003669 */
3670struct wiphy_vendor_command {
3671 struct nl80211_vendor_cmd_info info;
3672 u32 flags;
3673 int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3674 const void *data, int data_len);
Johannes Berg7bdbe402015-08-15 22:39:49 +03003675 int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
3676 struct sk_buff *skb, const void *data, int data_len,
3677 unsigned long *storage);
Johannes Bergad7e7182013-11-13 13:37:47 +01003678};
3679
3680/**
Kanchanapally, Vidyullatha019ae3a2016-05-16 10:41:04 +05303681 * struct wiphy_iftype_ext_capab - extended capabilities per interface type
3682 * @iftype: interface type
3683 * @extended_capabilities: extended capabilities supported by the driver,
3684 * additional capabilities might be supported by userspace; these are the
3685 * 802.11 extended capabilities ("Extended Capabilities element") and are
3686 * in the same format as in the information element. See IEEE Std
3687 * 802.11-2012 8.4.2.29 for the defined fields.
3688 * @extended_capabilities_mask: mask of the valid values
3689 * @extended_capabilities_len: length of the extended capabilities
3690 */
3691struct wiphy_iftype_ext_capab {
3692 enum nl80211_iftype iftype;
3693 const u8 *extended_capabilities;
3694 const u8 *extended_capabilities_mask;
3695 u8 extended_capabilities_len;
3696};
3697
3698/**
Johannes Berg5be83de2009-11-19 00:56:28 +01003699 * struct wiphy - wireless hardware description
Luis R. Rodriguez2784fe92010-12-15 19:24:11 -08003700 * @reg_notifier: the driver's regulatory notification callback,
3701 * note that if your driver uses wiphy_apply_custom_regulatory()
3702 * the reg_notifier's request can be passed as NULL
Johannes Bergd3236552009-04-20 14:31:42 +02003703 * @regd: the driver's regulatory domain, if one was requested via
3704 * the regulatory_hint() API. This can be used by the driver
3705 * on the reg_notifier() if it chooses to ignore future
3706 * regulatory domain changes caused by other drivers.
3707 * @signal_type: signal type reported in &struct cfg80211_bss.
3708 * @cipher_suites: supported cipher suites
3709 * @n_cipher_suites: number of supported cipher suites
Jouni Malinenb9a5f8ca2009-04-20 18:39:05 +02003710 * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
3711 * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
3712 * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
3713 * -1 = fragmentation disabled, only odd values >= 256 used
3714 * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
Johannes Bergabe37c42010-06-07 11:12:27 +02003715 * @_net: the network namespace this wiphy currently lives in
Johannes Bergef15aac2010-01-20 12:02:33 +01003716 * @perm_addr: permanent MAC address of this device
3717 * @addr_mask: If the device supports multiple MAC addresses by masking,
3718 * set this to a mask with variable bits set to 1, e.g. if the last
Luciano Coelho0fcf8ac2014-02-20 16:45:33 +02003719 * four bits are variable then set it to 00-00-00-00-00-0f. The actual
Johannes Bergef15aac2010-01-20 12:02:33 +01003720 * variable bits shall be determined by the interfaces added, with
3721 * interfaces not matching the mask being rejected to be brought up.
3722 * @n_addresses: number of addresses in @addresses.
3723 * @addresses: If the device has more than one address, set this pointer
3724 * to a list of addresses (6 bytes each). The first one will be used
3725 * by default for perm_addr. In this case, the mask should be set to
3726 * all-zeroes. In this case it is assumed that the device can handle
3727 * the same number of arbitrary MAC addresses.
Randy Dunlapfd235912011-09-08 10:16:50 -07003728 * @registered: protects ->resume and ->suspend sysfs callbacks against
3729 * unregister hardware
Johannes Bergabe37c42010-06-07 11:12:27 +02003730 * @debugfsdir: debugfs directory used for this wiphy, will be renamed
3731 * automatically on wiphy renames
3732 * @dev: (virtual) struct device for this wiphy
Stanislaw Gruszka4a711a82011-08-25 17:07:24 +02003733 * @registered: helps synchronize suspend/resume with wiphy unregister
Johannes Bergabe37c42010-06-07 11:12:27 +02003734 * @wext: wireless extension handlers
3735 * @priv: driver private data (sized according to wiphy_new() parameter)
3736 * @interface_modes: bitmask of interfaces types valid for this wiphy,
3737 * must be set by driver
Johannes Berg7527a782011-05-13 10:58:57 +02003738 * @iface_combinations: Valid interface combinations array, should not
3739 * list single interface types.
3740 * @n_iface_combinations: number of entries in @iface_combinations array.
3741 * @software_iftypes: bitmask of software interface types, these are not
3742 * subject to any restrictions since they are purely managed in SW.
Johannes Bergabe37c42010-06-07 11:12:27 +02003743 * @flags: wiphy flags, see &enum wiphy_flags
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +01003744 * @regulatory_flags: wiphy regulatory flags, see
3745 * &enum ieee80211_regulatory_flags
Johannes Berg1f074bd2011-11-06 14:13:33 +01003746 * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
Gautam Kumar Shuklad75bb062014-12-23 16:55:19 +01003747 * @ext_features: extended features advertised to nl80211, see
3748 * &enum nl80211_ext_feature_index.
Johannes Bergabe37c42010-06-07 11:12:27 +02003749 * @bss_priv_size: each BSS struct has private data allocated with it,
3750 * this variable determines its size
3751 * @max_scan_ssids: maximum number of SSIDs the device can scan for in
3752 * any given scan
Arend Van Sprielca986ad2017-04-21 13:05:00 +01003753 * @max_sched_scan_reqs: maximum number of scheduled scan requests that
3754 * the device can run concurrently.
Luciano Coelho93b6aa62011-07-13 14:57:28 +03003755 * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
3756 * for in any given scheduled scan
Luciano Coelhoa1f1c212011-08-31 16:01:48 +03003757 * @max_match_sets: maximum number of match sets the device can handle
3758 * when performing a scheduled scan, 0 if filtering is not
3759 * supported.
Johannes Bergabe37c42010-06-07 11:12:27 +02003760 * @max_scan_ie_len: maximum length of user-controlled IEs device can
3761 * add to probe request frames transmitted during a scan, must not
3762 * include fixed IEs like supported rates
Luciano Coelho5a865ba2011-07-13 14:57:29 +03003763 * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
3764 * scans
Avraham Stern3b06d272015-10-12 09:51:34 +03003765 * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
3766 * of iterations) for scheduled scan supported by the device.
3767 * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
3768 * single scan plan supported by the device.
3769 * @max_sched_scan_plan_iterations: maximum number of iterations for a single
3770 * scan plan supported by the device.
Johannes Bergabe37c42010-06-07 11:12:27 +02003771 * @coverage_class: current coverage class
3772 * @fw_version: firmware version for ethtool reporting
3773 * @hw_version: hardware version for ethtool reporting
3774 * @max_num_pmkids: maximum number of PMKIDs supported by device
3775 * @privid: a pointer that drivers can use to identify if an arbitrary
3776 * wiphy is theirs, e.g. in global notifiers
3777 * @bands: information about bands/channels supported by this device
Johannes Berg2e161f782010-08-12 15:38:38 +02003778 *
3779 * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
3780 * transmitted through nl80211, points to an array indexed by interface
3781 * type
Bruno Randolfa7ffac92010-12-08 13:59:24 +09003782 *
Bruno Randolf7f531e02010-12-16 11:30:22 +09003783 * @available_antennas_tx: bitmap of antennas which are available to be
3784 * configured as TX antennas. Antenna configuration commands will be
3785 * rejected unless this or @available_antennas_rx is set.
3786 *
3787 * @available_antennas_rx: bitmap of antennas which are available to be
3788 * configured as RX antennas. Antenna configuration commands will be
3789 * rejected unless this or @available_antennas_tx is set.
Johannes Berga2939112010-12-14 17:54:28 +01003790 *
Randy Dunlap15f0ebc2012-01-21 11:03:00 -08003791 * @probe_resp_offload:
3792 * Bitmap of supported protocols for probe response offloading.
3793 * See &enum nl80211_probe_resp_offload_support_attr. Only valid
3794 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3795 *
Johannes Berga2939112010-12-14 17:54:28 +01003796 * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
3797 * may request, if implemented.
Johannes Bergff1b6e62011-05-04 15:37:28 +02003798 *
3799 * @wowlan: WoWLAN support information
Johannes Berg6abb9cb2013-05-15 09:30:07 +02003800 * @wowlan_config: current WoWLAN configuration; this should usually not be
3801 * used since access to it is necessarily racy, use the parameter passed
3802 * to the suspend() operation instead.
Johannes Berg562a7482011-11-07 12:39:33 +01003803 *
3804 * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
Ben Greear7e7c8922011-11-18 11:31:59 -08003805 * @ht_capa_mod_mask: Specify what ht_cap values can be over-ridden.
3806 * If null, then none can be over-ridden.
Johannes Bergee2aca32013-02-21 17:36:01 +01003807 * @vht_capa_mod_mask: Specify what VHT capabilities can be over-ridden.
3808 * If null, then none can be over-ridden.
Vasanthakumar Thiagarajan77765ea2013-01-18 11:18:45 +05303809 *
Johannes Berg53873f12016-05-03 16:52:04 +03003810 * @wdev_list: the list of associated (virtual) interfaces; this list must
3811 * not be modified by the driver, but can be read with RTNL/RCU protection.
3812 *
Vasanthakumar Thiagarajan77765ea2013-01-18 11:18:45 +05303813 * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
3814 * supports for ACL.
Johannes Berga50df0c2013-02-11 14:20:05 +01003815 *
3816 * @extended_capabilities: extended capabilities supported by the driver,
3817 * additional capabilities might be supported by userspace; these are
3818 * the 802.11 extended capabilities ("Extended Capabilities element")
3819 * and are in the same format as in the information element. See
Kanchanapally, Vidyullatha019ae3a2016-05-16 10:41:04 +05303820 * 802.11-2012 8.4.2.29 for the defined fields. These are the default
3821 * extended capabilities to be used if the capabilities are not specified
3822 * for a specific interface type in iftype_ext_capab.
Johannes Berga50df0c2013-02-11 14:20:05 +01003823 * @extended_capabilities_mask: mask of the valid values
3824 * @extended_capabilities_len: length of the extended capabilities
Kanchanapally, Vidyullatha019ae3a2016-05-16 10:41:04 +05303825 * @iftype_ext_capab: array of extended capabilities per interface type
3826 * @num_iftype_ext_capab: number of interface types for which extended
3827 * capabilities are specified separately.
Amitkumar Karwarbe29b99a2013-06-28 11:51:26 -07003828 * @coalesce: packet coalescing support information
Johannes Bergad7e7182013-11-13 13:37:47 +01003829 *
3830 * @vendor_commands: array of vendor commands supported by the hardware
3831 * @n_vendor_commands: number of vendor commands
Johannes Berg567ffc32013-12-18 14:43:31 +01003832 * @vendor_events: array of vendor events supported by the hardware
3833 * @n_vendor_events: number of vendor events
Jouni Malinenb43504c2014-01-15 00:01:08 +02003834 *
3835 * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
3836 * (including P2P GO) or 0 to indicate no such limit is advertised. The
3837 * driver is allowed to advertise a theoretical limit that it can reach in
3838 * some cases, but may not always reach.
Luciano Coelhoc2e43232014-05-15 20:18:09 +03003839 *
3840 * @max_num_csa_counters: Number of supported csa_counters in beacons
3841 * and probe responses. This value should be set if the driver
3842 * wishes to limit the number of csa counters. Default (0) means
3843 * infinite.
Emmanuel Grumbach67af9812014-05-18 10:15:24 +03003844 * @max_adj_channel_rssi_comp: max offset of between the channel on which the
3845 * frame was sent and the channel on which the frame was heard for which
3846 * the reported rssi is still valid. If a driver is able to compensate the
3847 * low rssi when a frame is heard on different channel, then it should set
3848 * this variable to the maximal offset for which it can compensate.
3849 * This value should be set in MHz.
Arend van Spriel38de03d2016-03-02 20:37:18 +01003850 * @bss_select_support: bitmask indicating the BSS selection criteria supported
3851 * by the driver in the .connect() callback. The bit position maps to the
3852 * attribute indices defined in &enum nl80211_bss_select_attr.
Ayala Bekera442b762016-09-20 17:31:15 +03003853 *
3854 * @cookie_counter: unique generic cookie counter, used to identify objects.
Luca Coelho85859892017-02-08 15:00:34 +02003855 * @nan_supported_bands: bands supported by the device in NAN mode, a
3856 * bitmap of &enum nl80211_band values. For instance, for
3857 * NL80211_BAND_2GHZ, bit 0 would be set
3858 * (i.e. BIT(NL80211_BAND_2GHZ)).
Johannes Bergf3a7ca62018-05-22 11:31:59 +02003859 *
3860 * @txq_limit: configuration of internal TX queue frame limit
3861 * @txq_memory_limit: configuration internal TX queue memory limit
3862 * @txq_quantum: configuration of internal TX queue scheduler quantum
Johannes Bergd3236552009-04-20 14:31:42 +02003863 */
3864struct wiphy {
3865 /* assign these fields before you register the wiphy */
3866
Johannes Bergef15aac2010-01-20 12:02:33 +01003867 /* permanent MAC address(es) */
Johannes Bergd3236552009-04-20 14:31:42 +02003868 u8 perm_addr[ETH_ALEN];
Johannes Bergef15aac2010-01-20 12:02:33 +01003869 u8 addr_mask[ETH_ALEN];
3870
Johannes Bergef15aac2010-01-20 12:02:33 +01003871 struct mac_address *addresses;
Johannes Bergd3236552009-04-20 14:31:42 +02003872
Johannes Berg2e161f782010-08-12 15:38:38 +02003873 const struct ieee80211_txrx_stypes *mgmt_stypes;
3874
Johannes Berg7527a782011-05-13 10:58:57 +02003875 const struct ieee80211_iface_combination *iface_combinations;
3876 int n_iface_combinations;
3877 u16 software_iftypes;
3878
Johannes Berg2e161f782010-08-12 15:38:38 +02003879 u16 n_addresses;
3880
Johannes Bergd3236552009-04-20 14:31:42 +02003881 /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
3882 u16 interface_modes;
3883
Vasanthakumar Thiagarajan77765ea2013-01-18 11:18:45 +05303884 u16 max_acl_mac_addrs;
3885
Luis R. Rodrigueza2f73b62013-11-11 22:15:29 +01003886 u32 flags, regulatory_flags, features;
Gautam Kumar Shuklad75bb062014-12-23 16:55:19 +01003887 u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
Johannes Berg463d0182009-07-14 00:33:35 +02003888
Johannes Berg562a7482011-11-07 12:39:33 +01003889 u32 ap_sme_capa;
3890
Johannes Bergd3236552009-04-20 14:31:42 +02003891 enum cfg80211_signal_type signal_type;
3892
3893 int bss_priv_size;
3894 u8 max_scan_ssids;
Arend Van Sprielca986ad2017-04-21 13:05:00 +01003895 u8 max_sched_scan_reqs;
Luciano Coelho93b6aa62011-07-13 14:57:28 +03003896 u8 max_sched_scan_ssids;
Luciano Coelhoa1f1c212011-08-31 16:01:48 +03003897 u8 max_match_sets;
Johannes Bergd3236552009-04-20 14:31:42 +02003898 u16 max_scan_ie_len;
Luciano Coelho5a865ba2011-07-13 14:57:29 +03003899 u16 max_sched_scan_ie_len;
Avraham Stern3b06d272015-10-12 09:51:34 +03003900 u32 max_sched_scan_plans;
3901 u32 max_sched_scan_plan_interval;
3902 u32 max_sched_scan_plan_iterations;
Johannes Bergd3236552009-04-20 14:31:42 +02003903
3904 int n_cipher_suites;
3905 const u32 *cipher_suites;
3906
Jouni Malinenb9a5f8ca2009-04-20 18:39:05 +02003907 u8 retry_short;
3908 u8 retry_long;
3909 u32 frag_threshold;
3910 u32 rts_threshold;
Lukáš Turek81077e82009-12-21 22:50:47 +01003911 u8 coverage_class;
Jouni Malinenb9a5f8ca2009-04-20 18:39:05 +02003912
Jiri Pirko81135542013-01-06 02:12:51 +00003913 char fw_version[ETHTOOL_FWVERS_LEN];
Kalle Valodfce95f2009-09-24 11:02:42 -07003914 u32 hw_version;
3915
Johannes Bergdfb89c52012-06-27 09:23:48 +02003916#ifdef CONFIG_PM
Johannes Berg964dc9e2013-06-03 17:25:34 +02003917 const struct wiphy_wowlan_support *wowlan;
Johannes Berg6abb9cb2013-05-15 09:30:07 +02003918 struct cfg80211_wowlan *wowlan_config;
Johannes Bergdfb89c52012-06-27 09:23:48 +02003919#endif
Johannes Bergff1b6e62011-05-04 15:37:28 +02003920
Johannes Berga2939112010-12-14 17:54:28 +01003921 u16 max_remain_on_channel_duration;
3922
Samuel Ortiz67fbb162009-11-24 23:59:15 +01003923 u8 max_num_pmkids;
3924
Bruno Randolf7f531e02010-12-16 11:30:22 +09003925 u32 available_antennas_tx;
3926 u32 available_antennas_rx;
Bruno Randolfa7ffac92010-12-08 13:59:24 +09003927
Arik Nemtsov87bbbe22011-11-10 11:28:55 +02003928 /*
3929 * Bitmap of supported protocols for probe response offloading
3930 * see &enum nl80211_probe_resp_offload_support_attr. Only valid
3931 * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
3932 */
3933 u32 probe_resp_offload;
3934
Johannes Berga50df0c2013-02-11 14:20:05 +01003935 const u8 *extended_capabilities, *extended_capabilities_mask;
3936 u8 extended_capabilities_len;
3937
Kanchanapally, Vidyullatha019ae3a2016-05-16 10:41:04 +05303938 const struct wiphy_iftype_ext_capab *iftype_ext_capab;
3939 unsigned int num_iftype_ext_capab;
3940
Johannes Bergd3236552009-04-20 14:31:42 +02003941 /* If multiple wiphys are registered and you're handed e.g.
3942 * a regular netdev with assigned ieee80211_ptr, you won't
3943 * know whether it points to a wiphy your driver has registered
3944 * or not. Assign this to something global to your driver to
3945 * help determine whether you own this wiphy or not. */
David Kilroycf5aa2f2009-05-16 23:13:47 +01003946 const void *privid;
Johannes Bergd3236552009-04-20 14:31:42 +02003947
Johannes Berg57fbcce2016-04-12 15:56:15 +02003948 struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
Johannes Bergd3236552009-04-20 14:31:42 +02003949
3950 /* Lets us get back the wiphy on the callback */
Luis R. Rodriguez0c0280b2013-01-11 18:39:36 +00003951 void (*reg_notifier)(struct wiphy *wiphy,
3952 struct regulatory_request *request);
Johannes Bergd3236552009-04-20 14:31:42 +02003953
3954 /* fields below are read-only, assigned by cfg80211 */
3955
Johannes Berg458f4f92012-12-06 15:47:38 +01003956 const struct ieee80211_regdomain __rcu *regd;
Johannes Bergd3236552009-04-20 14:31:42 +02003957
3958 /* the item in /sys/class/ieee80211/ points to this,
3959 * you need use set_wiphy_dev() (see below) */
3960 struct device dev;
3961
Stanislaw Gruszkaecb44332011-08-12 14:00:59 +02003962 /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
3963 bool registered;
3964
Johannes Bergd3236552009-04-20 14:31:42 +02003965 /* dir in debugfs: ieee80211/<wiphyname> */
3966 struct dentry *debugfsdir;
3967
Ben Greear7e7c8922011-11-18 11:31:59 -08003968 const struct ieee80211_ht_cap *ht_capa_mod_mask;
Johannes Bergee2aca32013-02-21 17:36:01 +01003969 const struct ieee80211_vht_cap *vht_capa_mod_mask;
Ben Greear7e7c8922011-11-18 11:31:59 -08003970
Johannes Berg53873f12016-05-03 16:52:04 +03003971 struct list_head wdev_list;
3972
Johannes Berg463d0182009-07-14 00:33:35 +02003973 /* the network namespace this phy lives in currently */
Eric W. Biederman0c5c9fb2015-03-11 23:06:44 -05003974 possible_net_t _net;
Johannes Berg463d0182009-07-14 00:33:35 +02003975
Johannes Berg3d23e342009-09-29 23:27:28 +02003976#ifdef CONFIG_CFG80211_WEXT
3977 const struct iw_handler_def *wext;
3978#endif
3979
Amitkumar Karwarbe29b99a2013-06-28 11:51:26 -07003980 const struct wiphy_coalesce_support *coalesce;
3981
Johannes Bergad7e7182013-11-13 13:37:47 +01003982 const struct wiphy_vendor_command *vendor_commands;
Johannes Berg567ffc32013-12-18 14:43:31 +01003983 const struct nl80211_vendor_cmd_info *vendor_events;
3984 int n_vendor_commands, n_vendor_events;
Johannes Bergad7e7182013-11-13 13:37:47 +01003985
Jouni Malinenb43504c2014-01-15 00:01:08 +02003986 u16 max_ap_assoc_sta;
3987
Andrei Otcheretianski9a774c72014-05-09 14:11:46 +03003988 u8 max_num_csa_counters;
Emmanuel Grumbach67af9812014-05-18 10:15:24 +03003989 u8 max_adj_channel_rssi_comp;
Andrei Otcheretianski9a774c72014-05-09 14:11:46 +03003990
Arend van Spriel38de03d2016-03-02 20:37:18 +01003991 u32 bss_select_support;
3992
Ayala Bekera442b762016-09-20 17:31:15 +03003993 u64 cookie_counter;
3994
Luca Coelho85859892017-02-08 15:00:34 +02003995 u8 nan_supported_bands;
3996
Toke Høiland-Jørgensen52539ca2018-05-08 13:03:50 +02003997 u32 txq_limit;
3998 u32 txq_memory_limit;
3999 u32 txq_quantum;
4000
Johannes Berg1c06ef92012-12-28 12:22:02 +01004001 char priv[0] __aligned(NETDEV_ALIGN);
Johannes Bergd3236552009-04-20 14:31:42 +02004002};
4003
Johannes Berg463d0182009-07-14 00:33:35 +02004004static inline struct net *wiphy_net(struct wiphy *wiphy)
4005{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00004006 return read_pnet(&wiphy->_net);
Johannes Berg463d0182009-07-14 00:33:35 +02004007}
4008
4009static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4010{
Eric Dumazetc2d9ba92010-06-01 06:51:19 +00004011 write_pnet(&wiphy->_net, net);
Johannes Berg463d0182009-07-14 00:33:35 +02004012}
Johannes Berg463d0182009-07-14 00:33:35 +02004013
Johannes Bergd3236552009-04-20 14:31:42 +02004014/**
4015 * wiphy_priv - return priv from wiphy
4016 *
4017 * @wiphy: the wiphy whose priv pointer to return
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004018 * Return: The priv of @wiphy.
Johannes Bergd3236552009-04-20 14:31:42 +02004019 */
4020static inline void *wiphy_priv(struct wiphy *wiphy)
4021{
4022 BUG_ON(!wiphy);
4023 return &wiphy->priv;
4024}
4025
4026/**
David Kilroyf1f74822009-06-18 23:21:13 +01004027 * priv_to_wiphy - return the wiphy containing the priv
4028 *
4029 * @priv: a pointer previously returned by wiphy_priv
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004030 * Return: The wiphy of @priv.
David Kilroyf1f74822009-06-18 23:21:13 +01004031 */
4032static inline struct wiphy *priv_to_wiphy(void *priv)
4033{
4034 BUG_ON(!priv);
4035 return container_of(priv, struct wiphy, priv);
4036}
4037
4038/**
Johannes Bergd3236552009-04-20 14:31:42 +02004039 * set_wiphy_dev - set device pointer for wiphy
4040 *
4041 * @wiphy: The wiphy whose device to bind
4042 * @dev: The device to parent it to
4043 */
4044static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4045{
4046 wiphy->dev.parent = dev;
4047}
4048
4049/**
4050 * wiphy_dev - get wiphy dev pointer
4051 *
4052 * @wiphy: The wiphy whose device struct to look up
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004053 * Return: The dev of @wiphy.
Johannes Bergd3236552009-04-20 14:31:42 +02004054 */
4055static inline struct device *wiphy_dev(struct wiphy *wiphy)
4056{
4057 return wiphy->dev.parent;
4058}
4059
4060/**
4061 * wiphy_name - get wiphy name
4062 *
4063 * @wiphy: The wiphy whose name to return
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004064 * Return: The name of @wiphy.
Johannes Bergd3236552009-04-20 14:31:42 +02004065 */
Joe Perchese1db74f2010-07-26 14:39:57 -07004066static inline const char *wiphy_name(const struct wiphy *wiphy)
Johannes Bergd3236552009-04-20 14:31:42 +02004067{
4068 return dev_name(&wiphy->dev);
4069}
4070
4071/**
Ben Greear1998d902014-10-22 12:23:00 -07004072 * wiphy_new_nm - create a new wiphy for use with cfg80211
4073 *
4074 * @ops: The configuration operations for this device
4075 * @sizeof_priv: The size of the private area to allocate
4076 * @requested_name: Request a particular name.
4077 * NULL is valid value, and means use the default phy%d naming.
4078 *
4079 * Create a new wiphy and associate the given operations with it.
4080 * @sizeof_priv bytes are allocated for private use.
4081 *
4082 * Return: A pointer to the new wiphy. This pointer must be
4083 * assigned to each netdev's ieee80211_ptr for proper operation.
4084 */
4085struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4086 const char *requested_name);
4087
4088/**
Johannes Bergd3236552009-04-20 14:31:42 +02004089 * wiphy_new - create a new wiphy for use with cfg80211
4090 *
4091 * @ops: The configuration operations for this device
4092 * @sizeof_priv: The size of the private area to allocate
4093 *
4094 * Create a new wiphy and associate the given operations with it.
4095 * @sizeof_priv bytes are allocated for private use.
4096 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004097 * Return: A pointer to the new wiphy. This pointer must be
4098 * assigned to each netdev's ieee80211_ptr for proper operation.
Johannes Bergd3236552009-04-20 14:31:42 +02004099 */
Ben Greear1998d902014-10-22 12:23:00 -07004100static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4101 int sizeof_priv)
4102{
4103 return wiphy_new_nm(ops, sizeof_priv, NULL);
4104}
Johannes Bergd3236552009-04-20 14:31:42 +02004105
4106/**
4107 * wiphy_register - register a wiphy with cfg80211
4108 *
4109 * @wiphy: The wiphy to register.
4110 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004111 * Return: A non-negative wiphy index or a negative error code.
Johannes Bergd3236552009-04-20 14:31:42 +02004112 */
Joe Perches10dd9b72013-07-31 17:31:37 -07004113int wiphy_register(struct wiphy *wiphy);
Johannes Bergd3236552009-04-20 14:31:42 +02004114
4115/**
4116 * wiphy_unregister - deregister a wiphy from cfg80211
4117 *
4118 * @wiphy: The wiphy to unregister.
4119 *
4120 * After this call, no more requests can be made with this priv
4121 * pointer, but the call may sleep to wait for an outstanding
4122 * request that is being handled.
4123 */
Joe Perches10dd9b72013-07-31 17:31:37 -07004124void wiphy_unregister(struct wiphy *wiphy);
Johannes Bergd3236552009-04-20 14:31:42 +02004125
4126/**
4127 * wiphy_free - free wiphy
4128 *
4129 * @wiphy: The wiphy to free
4130 */
Joe Perches10dd9b72013-07-31 17:31:37 -07004131void wiphy_free(struct wiphy *wiphy);
Johannes Bergd3236552009-04-20 14:31:42 +02004132
Johannes Bergfffd0932009-07-08 14:22:54 +02004133/* internal structs */
Johannes Berg6829c872009-07-02 09:13:27 +02004134struct cfg80211_conn;
Johannes Berg19957bb2009-07-02 17:20:43 +02004135struct cfg80211_internal_bss;
Johannes Bergfffd0932009-07-08 14:22:54 +02004136struct cfg80211_cached_keys;
Andrew Zaborowski4a4b8162017-02-10 10:02:31 +01004137struct cfg80211_cqm_config;
Johannes Berg19957bb2009-07-02 17:20:43 +02004138
Johannes Bergd3236552009-04-20 14:31:42 +02004139/**
Johannes Berg89a54e42012-06-15 14:33:17 +02004140 * struct wireless_dev - wireless device state
Johannes Bergd3236552009-04-20 14:31:42 +02004141 *
Johannes Berg89a54e42012-06-15 14:33:17 +02004142 * For netdevs, this structure must be allocated by the driver
4143 * that uses the ieee80211_ptr field in struct net_device (this
4144 * is intentional so it can be allocated along with the netdev.)
4145 * It need not be registered then as netdev registration will
4146 * be intercepted by cfg80211 to see the new wireless device.
4147 *
4148 * For non-netdev uses, it must also be allocated by the driver
4149 * in response to the cfg80211 callbacks that require it, as
4150 * there's no netdev registration in that case it may not be
4151 * allocated outside of callback operations that return it.
Johannes Bergd3236552009-04-20 14:31:42 +02004152 *
4153 * @wiphy: pointer to hardware description
4154 * @iftype: interface type
4155 * @list: (private) Used to collect the interfaces
Johannes Berg89a54e42012-06-15 14:33:17 +02004156 * @netdev: (private) Used to reference back to the netdev, may be %NULL
4157 * @identifier: (private) Identifier used in nl80211 to identify this
4158 * wireless device if it has no netdev
Johannes Bergd3236552009-04-20 14:31:42 +02004159 * @current_bss: (private) Used by the internal configuration code
Michal Kazior9e0e2962014-01-29 14:22:27 +01004160 * @chandef: (private) Used by the internal configuration code to track
4161 * the user-set channel definition.
Johannes Berg780b40d2013-06-05 09:32:50 +02004162 * @preset_chandef: (private) Used by the internal configuration code to
Johannes Bergaa430da2012-05-16 23:50:18 +02004163 * track the channel to be used for AP later
Johannes Bergd3236552009-04-20 14:31:42 +02004164 * @bssid: (private) Used by the internal configuration code
4165 * @ssid: (private) Used by the internal configuration code
4166 * @ssid_len: (private) Used by the internal configuration code
Johannes Berg29cbe682010-12-03 09:20:44 +01004167 * @mesh_id_len: (private) Used by the internal configuration code
4168 * @mesh_id_up_len: (private) Used by the internal configuration code
Johannes Bergd3236552009-04-20 14:31:42 +02004169 * @wext: (private) Used by the internal wireless extensions compat code
Johannes Berg9bc383d2009-11-19 11:55:19 +01004170 * @use_4addr: indicates 4addr mode is used on this interface, must be
4171 * set by driver (if supported) on add_interface BEFORE registering the
4172 * netdev and may otherwise be used by driver read-only, will be update
4173 * by cfg80211 on change_interface
Johannes Berg2e161f782010-08-12 15:38:38 +02004174 * @mgmt_registrations: list of registrations for management frames
4175 * @mgmt_registrations_lock: lock for the list
Johannes Berg8d61ffa2013-05-10 12:32:47 +02004176 * @mtx: mutex used to lock data in this struct, may be used by drivers
4177 * and some API functions require it held
Johannes Berg56d18932011-05-09 18:41:15 +02004178 * @beacon_interval: beacon interval used on this device for transmitting
4179 * beacons, 0 when not valid
Johannes Berg98104fde2012-06-16 00:19:54 +02004180 * @address: The address for this device, valid only if @netdev is %NULL
Arend Van Spriel73c7da32016-10-20 20:08:22 +01004181 * @is_running: true if this is a non-netdev device that has been started, e.g.
4182 * the P2P Device.
Simon Wunderlich04f39042013-02-08 18:16:19 +01004183 * @cac_started: true if DFS channel availability check has been started
4184 * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
Janusz Dziedzic31559f32014-02-21 19:46:13 +01004185 * @cac_time_ms: CAC time in ms
Johannes Berg780b40d2013-06-05 09:32:50 +02004186 * @ps: powersave mode is enabled
4187 * @ps_timeout: dynamic powersave timeout
4188 * @ap_unexpected_nlportid: (private) netlink port ID of application
4189 * registered for unexpected class 3 frames (AP mode)
4190 * @conn: (private) cfg80211 software SME connection state machine data
4191 * @connect_keys: (private) keys to set after connection is established
Lior David34d50512016-01-28 10:58:25 +02004192 * @conn_bss_type: connecting/connected BSS type
Andrzej Zaborowskibd2522b2017-01-06 16:33:43 -05004193 * @conn_owner_nlportid: (private) connection owner socket port ID
4194 * @disconnect_wk: (private) auto-disconnect work
4195 * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
Johannes Berg780b40d2013-06-05 09:32:50 +02004196 * @ibss_fixed: (private) IBSS is using fixed BSSID
Simon Wunderlich5336fa82013-10-07 18:41:05 +02004197 * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
Johannes Berg780b40d2013-06-05 09:32:50 +02004198 * @event_list: (private) list for internal event processing
4199 * @event_lock: (private) lock for event list
Johannes Berg78f22b62014-03-24 17:57:27 +01004200 * @owner_nlportid: (private) owner socket port ID
Johannes Bergab810072017-04-26 07:43:41 +02004201 * @nl_owner_dead: (private) owner socket went away
Andrew Zaborowski4a4b8162017-02-10 10:02:31 +01004202 * @cqm_config: (private) nl80211 RSSI monitor state
Johannes Bergd3236552009-04-20 14:31:42 +02004203 */
4204struct wireless_dev {
4205 struct wiphy *wiphy;
4206 enum nl80211_iftype iftype;
4207
Johannes Berg667503d2009-07-07 03:56:11 +02004208 /* the remainder of this struct should be private to cfg80211 */
Johannes Bergd3236552009-04-20 14:31:42 +02004209 struct list_head list;
4210 struct net_device *netdev;
4211
Johannes Berg89a54e42012-06-15 14:33:17 +02004212 u32 identifier;
4213
Johannes Berg2e161f782010-08-12 15:38:38 +02004214 struct list_head mgmt_registrations;
4215 spinlock_t mgmt_registrations_lock;
Jouni Malinen026331c2010-02-15 12:53:10 +02004216
Johannes Berg667503d2009-07-07 03:56:11 +02004217 struct mutex mtx;
4218
Arend Van Spriel73c7da32016-10-20 20:08:22 +01004219 bool use_4addr, is_running;
Johannes Berg98104fde2012-06-16 00:19:54 +02004220
4221 u8 address[ETH_ALEN] __aligned(sizeof(u16));
Johannes Berg9bc383d2009-11-19 11:55:19 +01004222
Samuel Ortizb23aa672009-07-01 21:26:54 +02004223 /* currently used for IBSS and SME - might be rearranged later */
Johannes Bergd3236552009-04-20 14:31:42 +02004224 u8 ssid[IEEE80211_MAX_SSID_LEN];
Johannes Berg29cbe682010-12-03 09:20:44 +01004225 u8 ssid_len, mesh_id_len, mesh_id_up_len;
Johannes Berg6829c872009-07-02 09:13:27 +02004226 struct cfg80211_conn *conn;
Johannes Bergfffd0932009-07-08 14:22:54 +02004227 struct cfg80211_cached_keys *connect_keys;
Lior David34d50512016-01-28 10:58:25 +02004228 enum ieee80211_bss_type conn_bss_type;
Andrzej Zaborowskibd2522b2017-01-06 16:33:43 -05004229 u32 conn_owner_nlportid;
4230
4231 struct work_struct disconnect_wk;
4232 u8 disconnect_bssid[ETH_ALEN];
Johannes Bergd3236552009-04-20 14:31:42 +02004233
Johannes Berg667503d2009-07-07 03:56:11 +02004234 struct list_head event_list;
4235 spinlock_t event_lock;
4236
Johannes Berg19957bb2009-07-02 17:20:43 +02004237 struct cfg80211_internal_bss *current_bss; /* associated / joined */
Johannes Berg683b6d32012-11-08 21:25:48 +01004238 struct cfg80211_chan_def preset_chandef;
Michal Kazior9e0e2962014-01-29 14:22:27 +01004239 struct cfg80211_chan_def chandef;
Michal Kaziorf4489eb2012-06-29 12:46:58 +02004240
Michal Kaziorc30a3d32012-06-29 12:46:59 +02004241 bool ibss_fixed;
Simon Wunderlich5336fa82013-10-07 18:41:05 +02004242 bool ibss_dfs_possible;
Michal Kaziorc30a3d32012-06-29 12:46:59 +02004243
Kalle Valoffb9eb32010-02-17 17:58:10 +02004244 bool ps;
4245 int ps_timeout;
4246
Johannes Berg56d18932011-05-09 18:41:15 +02004247 int beacon_interval;
4248
Eric W. Biederman15e47302012-09-07 20:12:54 +00004249 u32 ap_unexpected_nlportid;
Johannes Berg28946da2011-11-04 11:18:12 +01004250
Johannes Bergab810072017-04-26 07:43:41 +02004251 u32 owner_nlportid;
4252 bool nl_owner_dead;
4253
Simon Wunderlich04f39042013-02-08 18:16:19 +01004254 bool cac_started;
4255 unsigned long cac_start_time;
Janusz Dziedzic31559f32014-02-21 19:46:13 +01004256 unsigned int cac_time_ms;
Simon Wunderlich04f39042013-02-08 18:16:19 +01004257
Johannes Berg3d23e342009-09-29 23:27:28 +02004258#ifdef CONFIG_CFG80211_WEXT
Johannes Bergd3236552009-04-20 14:31:42 +02004259 /* wext data */
Johannes Bergcbe8fa92009-05-09 20:09:03 +02004260 struct {
Johannes Bergc238c8a2009-07-07 03:56:06 +02004261 struct cfg80211_ibss_params ibss;
4262 struct cfg80211_connect_params connect;
Johannes Bergfffd0932009-07-08 14:22:54 +02004263 struct cfg80211_cached_keys *keys;
Johannes Bergc1e5f472014-05-19 17:53:16 +02004264 const u8 *ie;
Johannes Bergf2129352009-07-01 21:26:56 +02004265 size_t ie_len;
Johannes Bergf401a6f2009-08-07 14:51:05 +02004266 u8 bssid[ETH_ALEN], prev_bssid[ETH_ALEN];
Johannes Bergf2129352009-07-01 21:26:56 +02004267 u8 ssid[IEEE80211_MAX_SSID_LEN];
Johannes Berg08645122009-05-11 13:54:58 +02004268 s8 default_key, default_mgmt_key;
Kalle Valoffb9eb32010-02-17 17:58:10 +02004269 bool prev_bssid_valid;
Johannes Bergcbe8fa92009-05-09 20:09:03 +02004270 } wext;
Johannes Bergd3236552009-04-20 14:31:42 +02004271#endif
Andrew Zaborowski4a4b8162017-02-10 10:02:31 +01004272
4273 struct cfg80211_cqm_config *cqm_config;
Johannes Bergd3236552009-04-20 14:31:42 +02004274};
4275
Johannes Berg98104fde2012-06-16 00:19:54 +02004276static inline u8 *wdev_address(struct wireless_dev *wdev)
4277{
4278 if (wdev->netdev)
4279 return wdev->netdev->dev_addr;
4280 return wdev->address;
4281}
4282
Arend Van Spriel73c7da32016-10-20 20:08:22 +01004283static inline bool wdev_running(struct wireless_dev *wdev)
4284{
4285 if (wdev->netdev)
4286 return netif_running(wdev->netdev);
4287 return wdev->is_running;
4288}
4289
Johannes Bergd3236552009-04-20 14:31:42 +02004290/**
4291 * wdev_priv - return wiphy priv from wireless_dev
4292 *
4293 * @wdev: The wireless device whose wiphy's priv pointer to return
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004294 * Return: The wiphy priv of @wdev.
Johannes Bergd3236552009-04-20 14:31:42 +02004295 */
4296static inline void *wdev_priv(struct wireless_dev *wdev)
4297{
4298 BUG_ON(!wdev);
4299 return wiphy_priv(wdev->wiphy);
4300}
4301
Johannes Bergd70e9692010-08-19 16:11:27 +02004302/**
4303 * DOC: Utility functions
4304 *
4305 * cfg80211 offers a number of utility functions that can be useful.
Johannes Bergd3236552009-04-20 14:31:42 +02004306 */
4307
4308/**
4309 * ieee80211_channel_to_frequency - convert channel number to frequency
Johannes Bergabe37c42010-06-07 11:12:27 +02004310 * @chan: channel number
Bruno Randolf59eb21a2011-01-17 13:37:28 +09004311 * @band: band, necessary due to channel number overlap
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004312 * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
Johannes Bergd3236552009-04-20 14:31:42 +02004313 */
Johannes Berg57fbcce2016-04-12 15:56:15 +02004314int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
Johannes Bergd3236552009-04-20 14:31:42 +02004315
4316/**
4317 * ieee80211_frequency_to_channel - convert frequency to channel number
Johannes Bergabe37c42010-06-07 11:12:27 +02004318 * @freq: center frequency
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004319 * Return: The corresponding channel, or 0 if the conversion failed.
Johannes Bergd3236552009-04-20 14:31:42 +02004320 */
Joe Perches10dd9b72013-07-31 17:31:37 -07004321int ieee80211_frequency_to_channel(int freq);
Johannes Bergd3236552009-04-20 14:31:42 +02004322
Johannes Bergd3236552009-04-20 14:31:42 +02004323/**
4324 * ieee80211_get_channel - get channel struct from wiphy for specified frequency
Arend Van Spriel543b9212016-11-17 12:48:53 +00004325 *
Johannes Bergabe37c42010-06-07 11:12:27 +02004326 * @wiphy: the struct wiphy to get the channel for
4327 * @freq: the center frequency of the channel
Arend Van Spriel543b9212016-11-17 12:48:53 +00004328 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004329 * Return: The channel struct from @wiphy at @freq.
Johannes Bergd3236552009-04-20 14:31:42 +02004330 */
Arend Van Spriel543b9212016-11-17 12:48:53 +00004331struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
Johannes Bergd3236552009-04-20 14:31:42 +02004332
4333/**
4334 * ieee80211_get_response_rate - get basic rate for a given rate
4335 *
4336 * @sband: the band to look for rates in
4337 * @basic_rates: bitmap of basic rates
4338 * @bitrate: the bitrate for which to find the basic rate
4339 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004340 * Return: The basic rate corresponding to a given bitrate, that
4341 * is the next lower bitrate contained in the basic rate map,
4342 * which is, for this function, given as a bitmap of indices of
4343 * rates in the band's bitrate table.
Johannes Bergd3236552009-04-20 14:31:42 +02004344 */
4345struct ieee80211_rate *
4346ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
4347 u32 basic_rates, int bitrate);
4348
Ashok Nagarajanb422c6c2013-05-10 17:50:51 -07004349/**
4350 * ieee80211_mandatory_rates - get mandatory rates for a given band
4351 * @sband: the band to look for rates in
Simon Wunderlich74608ac2013-07-08 16:55:54 +02004352 * @scan_width: width of the control channel
Ashok Nagarajanb422c6c2013-05-10 17:50:51 -07004353 *
4354 * This function returns a bitmap of the mandatory rates for the given
4355 * band, bits are set according to the rate position in the bitrates array.
4356 */
Simon Wunderlich74608ac2013-07-08 16:55:54 +02004357u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
4358 enum nl80211_bss_scan_width scan_width);
Ashok Nagarajanb422c6c2013-05-10 17:50:51 -07004359
Johannes Bergd3236552009-04-20 14:31:42 +02004360/*
4361 * Radiotap parsing functions -- for controlled injection support
4362 *
4363 * Implemented in net/wireless/radiotap.c
4364 * Documentation in Documentation/networking/radiotap-headers.txt
4365 */
4366
Johannes Berg33e5a2f2010-02-03 10:24:30 +01004367struct radiotap_align_size {
4368 uint8_t align:4, size:4;
4369};
4370
4371struct ieee80211_radiotap_namespace {
4372 const struct radiotap_align_size *align_size;
4373 int n_bits;
4374 uint32_t oui;
4375 uint8_t subns;
4376};
4377
4378struct ieee80211_radiotap_vendor_namespaces {
4379 const struct ieee80211_radiotap_namespace *ns;
4380 int n_ns;
4381};
4382
Johannes Bergd3236552009-04-20 14:31:42 +02004383/**
4384 * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
Johannes Berg33e5a2f2010-02-03 10:24:30 +01004385 * @this_arg_index: index of current arg, valid after each successful call
4386 * to ieee80211_radiotap_iterator_next()
4387 * @this_arg: pointer to current radiotap arg; it is valid after each
4388 * call to ieee80211_radiotap_iterator_next() but also after
4389 * ieee80211_radiotap_iterator_init() where it will point to
4390 * the beginning of the actual data portion
4391 * @this_arg_size: length of the current arg, for convenience
4392 * @current_namespace: pointer to the current namespace definition
4393 * (or internally %NULL if the current namespace is unknown)
4394 * @is_radiotap_ns: indicates whether the current namespace is the default
4395 * radiotap namespace or not
4396 *
Johannes Berg33e5a2f2010-02-03 10:24:30 +01004397 * @_rtheader: pointer to the radiotap header we are walking through
4398 * @_max_length: length of radiotap header in cpu byte ordering
4399 * @_arg_index: next argument index
4400 * @_arg: next argument pointer
4401 * @_next_bitmap: internal pointer to next present u32
4402 * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
4403 * @_vns: vendor namespace definitions
4404 * @_next_ns_data: beginning of the next namespace's data
4405 * @_reset_on_ext: internal; reset the arg index to 0 when going to the
4406 * next bitmap word
4407 *
4408 * Describes the radiotap parser state. Fields prefixed with an underscore
4409 * must not be used by users of the parser, only by the parser internally.
Johannes Bergd3236552009-04-20 14:31:42 +02004410 */
4411
4412struct ieee80211_radiotap_iterator {
Johannes Berg33e5a2f2010-02-03 10:24:30 +01004413 struct ieee80211_radiotap_header *_rtheader;
4414 const struct ieee80211_radiotap_vendor_namespaces *_vns;
4415 const struct ieee80211_radiotap_namespace *current_namespace;
Johannes Bergd3236552009-04-20 14:31:42 +02004416
Johannes Berg33e5a2f2010-02-03 10:24:30 +01004417 unsigned char *_arg, *_next_ns_data;
Johannes Berg67272442010-04-21 10:25:36 +02004418 __le32 *_next_bitmap;
Johannes Berg33e5a2f2010-02-03 10:24:30 +01004419
4420 unsigned char *this_arg;
4421 int this_arg_index;
4422 int this_arg_size;
4423
4424 int is_radiotap_ns;
4425
4426 int _max_length;
4427 int _arg_index;
4428 uint32_t _bitmap_shifter;
4429 int _reset_on_ext;
Johannes Bergd3236552009-04-20 14:31:42 +02004430};
4431
Joe Perches10dd9b72013-07-31 17:31:37 -07004432int
4433ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
4434 struct ieee80211_radiotap_header *radiotap_header,
4435 int max_length,
4436 const struct ieee80211_radiotap_vendor_namespaces *vns);
Johannes Bergd3236552009-04-20 14:31:42 +02004437
Joe Perches10dd9b72013-07-31 17:31:37 -07004438int
4439ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
Johannes Berg33e5a2f2010-02-03 10:24:30 +01004440
Johannes Bergd3236552009-04-20 14:31:42 +02004441
Zhu Yie31a16d2009-05-21 21:47:03 +08004442extern const unsigned char rfc1042_header[6];
4443extern const unsigned char bridge_tunnel_header[6];
4444
4445/**
4446 * ieee80211_get_hdrlen_from_skb - get header length from data
4447 *
Zhu Yie31a16d2009-05-21 21:47:03 +08004448 * @skb: the frame
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004449 *
4450 * Given an skb with a raw 802.11 header at the data pointer this function
4451 * returns the 802.11 header length.
4452 *
4453 * Return: The 802.11 header length in bytes (not including encryption
4454 * headers). Or 0 if the data in the sk_buff is too short to contain a valid
4455 * 802.11 header.
Zhu Yie31a16d2009-05-21 21:47:03 +08004456 */
4457unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
4458
4459/**
4460 * ieee80211_hdrlen - get header length in bytes from frame control
4461 * @fc: frame control field in little-endian format
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004462 * Return: The header length in bytes.
Zhu Yie31a16d2009-05-21 21:47:03 +08004463 */
Johannes Berg633adf12010-08-12 14:49:58 +02004464unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
Zhu Yie31a16d2009-05-21 21:47:03 +08004465
4466/**
Johannes Berg9b395bc2012-10-26 00:36:40 +02004467 * ieee80211_get_mesh_hdrlen - get mesh extension header length
4468 * @meshhdr: the mesh extension header, only the flags field
4469 * (first byte) will be accessed
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004470 * Return: The length of the extension header, which is always at
Johannes Berg9b395bc2012-10-26 00:36:40 +02004471 * least 6 bytes and at most 18 if address 5 and 6 are present.
4472 */
4473unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
4474
4475/**
Johannes Bergd70e9692010-08-19 16:11:27 +02004476 * DOC: Data path helpers
4477 *
4478 * In addition to generic utilities, cfg80211 also offers
4479 * functions that help implement the data path for devices
4480 * that do not do the 802.11/802.3 conversion on the device.
4481 */
4482
4483/**
Johannes Berg7f6990c2016-10-05 15:29:49 +02004484 * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
4485 * @skb: the 802.11 data frame
4486 * @ehdr: pointer to a &struct ethhdr that will get the header, instead
4487 * of it being pushed into the SKB
4488 * @addr: the device MAC address
4489 * @iftype: the virtual interface type
Felix Fietkau24bba072018-02-27 13:03:07 +01004490 * @data_offset: offset of payload after the 802.11 header
Johannes Berg7f6990c2016-10-05 15:29:49 +02004491 * Return: 0 on success. Non-zero on error.
4492 */
4493int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
Felix Fietkau24bba072018-02-27 13:03:07 +01004494 const u8 *addr, enum nl80211_iftype iftype,
4495 u8 data_offset);
Johannes Berg7f6990c2016-10-05 15:29:49 +02004496
4497/**
Zhu Yie31a16d2009-05-21 21:47:03 +08004498 * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
4499 * @skb: the 802.11 data frame
4500 * @addr: the device MAC address
4501 * @iftype: the virtual interface type
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004502 * Return: 0 on success. Non-zero on error.
Zhu Yie31a16d2009-05-21 21:47:03 +08004503 */
Johannes Berg7f6990c2016-10-05 15:29:49 +02004504static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
4505 enum nl80211_iftype iftype)
4506{
Felix Fietkau24bba072018-02-27 13:03:07 +01004507 return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
Johannes Berg7f6990c2016-10-05 15:29:49 +02004508}
Zhu Yie31a16d2009-05-21 21:47:03 +08004509
4510/**
Zhu Yieaf85ca2009-12-01 10:18:37 +08004511 * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
4512 *
Johannes Berg7f6990c2016-10-05 15:29:49 +02004513 * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
4514 * The @list will be empty if the decode fails. The @skb must be fully
4515 * header-less before being passed in here; it is freed in this function.
Zhu Yieaf85ca2009-12-01 10:18:37 +08004516 *
Johannes Berg7f6990c2016-10-05 15:29:49 +02004517 * @skb: The input A-MSDU frame without any headers.
Zhu Yieaf85ca2009-12-01 10:18:37 +08004518 * @list: The output list of 802.3 frames. It must be allocated and
4519 * initialized by by the caller.
4520 * @addr: The device MAC address.
4521 * @iftype: The device interface type.
4522 * @extra_headroom: The hardware extra headroom for SKBs in the @list.
Johannes Berg8b935ee2016-10-05 16:17:01 +02004523 * @check_da: DA to check in the inner ethernet header, or NULL
4524 * @check_sa: SA to check in the inner ethernet header, or NULL
Zhu Yieaf85ca2009-12-01 10:18:37 +08004525 */
4526void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
4527 const u8 *addr, enum nl80211_iftype iftype,
Yogesh Ashok Powar8b3beca2011-05-13 11:22:31 -07004528 const unsigned int extra_headroom,
Johannes Berg8b935ee2016-10-05 16:17:01 +02004529 const u8 *check_da, const u8 *check_sa);
Zhu Yieaf85ca2009-12-01 10:18:37 +08004530
4531/**
Zhu Yie31a16d2009-05-21 21:47:03 +08004532 * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
4533 * @skb: the data frame
Kyeyoon Parkfa9ffc72013-12-16 23:01:30 -08004534 * @qos_map: Interworking QoS mapping or %NULL if not in use
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004535 * Return: The 802.1p/1d tag.
Zhu Yie31a16d2009-05-21 21:47:03 +08004536 */
Kyeyoon Parkfa9ffc72013-12-16 23:01:30 -08004537unsigned int cfg80211_classify8021d(struct sk_buff *skb,
4538 struct cfg80211_qos_map *qos_map);
Zhu Yie31a16d2009-05-21 21:47:03 +08004539
Johannes Bergc21dbf92010-01-26 14:15:46 +01004540/**
Luca Coelhofbd05e42016-09-15 18:15:09 +03004541 * cfg80211_find_ie_match - match information element and byte array in data
4542 *
4543 * @eid: element ID
4544 * @ies: data consisting of IEs
4545 * @len: length of data
4546 * @match: byte array to match
4547 * @match_len: number of bytes in the match array
4548 * @match_offset: offset in the IE where the byte array should match.
4549 * If match_len is zero, this must also be set to zero.
4550 * Otherwise this must be set to 2 or more, because the first
4551 * byte is the element id, which is already compared to eid, and
4552 * the second byte is the IE length.
4553 *
4554 * Return: %NULL if the element ID could not be found or if
4555 * the element is invalid (claims to be longer than the given
4556 * data) or if the byte array doesn't match, or a pointer to the first
4557 * byte of the requested element, that is the byte containing the
4558 * element ID.
4559 *
4560 * Note: There are no checks on the element length other than
4561 * having to fit into the given data and being large enough for the
4562 * byte array to match.
4563 */
4564const u8 *cfg80211_find_ie_match(u8 eid, const u8 *ies, int len,
4565 const u8 *match, int match_len,
4566 int match_offset);
4567
4568/**
Johannes Bergc21dbf92010-01-26 14:15:46 +01004569 * cfg80211_find_ie - find information element in data
4570 *
4571 * @eid: element ID
4572 * @ies: data consisting of IEs
4573 * @len: length of data
4574 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004575 * Return: %NULL if the element ID could not be found or if
4576 * the element is invalid (claims to be longer than the given
4577 * data), or a pointer to the first byte of the requested
4578 * element, that is the byte containing the element ID.
4579 *
4580 * Note: There are no checks on the element length other than
4581 * having to fit into the given data.
Johannes Bergc21dbf92010-01-26 14:15:46 +01004582 */
Luca Coelhofbd05e42016-09-15 18:15:09 +03004583static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
4584{
4585 return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
4586}
Johannes Bergc21dbf92010-01-26 14:15:46 +01004587
Johannes Bergd70e9692010-08-19 16:11:27 +02004588/**
Jouni Malinen3f817fe2016-10-27 00:42:01 +03004589 * cfg80211_find_ext_ie - find information element with EID Extension in data
4590 *
4591 * @ext_eid: element ID Extension
4592 * @ies: data consisting of IEs
4593 * @len: length of data
4594 *
4595 * Return: %NULL if the extended element ID could not be found or if
4596 * the element is invalid (claims to be longer than the given
4597 * data), or a pointer to the first byte of the requested
4598 * element, that is the byte containing the element ID.
4599 *
4600 * Note: There are no checks on the element length other than
4601 * having to fit into the given data.
4602 */
4603static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
4604{
4605 return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
4606 &ext_eid, 1, 2);
4607}
4608
4609/**
Eliad Peller0c28ec52011-09-15 11:53:01 +03004610 * cfg80211_find_vendor_ie - find vendor specific information element in data
4611 *
4612 * @oui: vendor OUI
Emmanuel Grumbach9e9ea432016-05-03 16:08:07 +03004613 * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
Eliad Peller0c28ec52011-09-15 11:53:01 +03004614 * @ies: data consisting of IEs
4615 * @len: length of data
4616 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004617 * Return: %NULL if the vendor specific element ID could not be found or if the
4618 * element is invalid (claims to be longer than the given data), or a pointer to
4619 * the first byte of the requested element, that is the byte containing the
4620 * element ID.
4621 *
4622 * Note: There are no checks on the element length other than having to fit into
4623 * the given data.
Eliad Peller0c28ec52011-09-15 11:53:01 +03004624 */
Emmanuel Grumbach9e9ea432016-05-03 16:08:07 +03004625const u8 *cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
Eliad Peller0c28ec52011-09-15 11:53:01 +03004626 const u8 *ies, int len);
4627
4628/**
Johannes Bergd70e9692010-08-19 16:11:27 +02004629 * DOC: Regulatory enforcement infrastructure
4630 *
4631 * TODO
Johannes Bergd3236552009-04-20 14:31:42 +02004632 */
4633
4634/**
4635 * regulatory_hint - driver hint to the wireless core a regulatory domain
4636 * @wiphy: the wireless device giving the hint (used only for reporting
4637 * conflicts)
4638 * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
4639 * should be in. If @rd is set this should be NULL. Note that if you
4640 * set this to NULL you should still set rd->alpha2 to some accepted
4641 * alpha2.
4642 *
4643 * Wireless drivers can use this function to hint to the wireless core
4644 * what it believes should be the current regulatory domain by
4645 * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
4646 * domain should be in or by providing a completely build regulatory domain.
4647 * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
4648 * for a regulatory domain structure for the respective country.
4649 *
4650 * The wiphy must have been registered to cfg80211 prior to this call.
4651 * For cfg80211 drivers this means you must first use wiphy_register(),
4652 * for mac80211 drivers you must first use ieee80211_register_hw().
4653 *
4654 * Drivers should check the return value, its possible you can get
4655 * an -ENOMEM.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004656 *
4657 * Return: 0 on success. -ENOMEM.
Johannes Bergd3236552009-04-20 14:31:42 +02004658 */
Joe Perches10dd9b72013-07-31 17:31:37 -07004659int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
Johannes Bergd3236552009-04-20 14:31:42 +02004660
4661/**
Jonathan Doronb0d7aa52014-12-15 19:26:00 +02004662 * regulatory_set_wiphy_regd - set regdom info for self managed drivers
4663 * @wiphy: the wireless device we want to process the regulatory domain on
4664 * @rd: the regulatory domain informatoin to use for this wiphy
4665 *
4666 * Set the regulatory domain information for self-managed wiphys, only they
4667 * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
4668 * information.
4669 *
4670 * Return: 0 on success. -EINVAL, -EPERM
4671 */
4672int regulatory_set_wiphy_regd(struct wiphy *wiphy,
4673 struct ieee80211_regdomain *rd);
4674
4675/**
Arik Nemtsov2c3e8612015-01-07 16:47:19 +02004676 * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
4677 * @wiphy: the wireless device we want to process the regulatory domain on
4678 * @rd: the regulatory domain information to use for this wiphy
4679 *
4680 * This functions requires the RTNL to be held and applies the new regdomain
4681 * synchronously to this wiphy. For more details see
4682 * regulatory_set_wiphy_regd().
4683 *
4684 * Return: 0 on success. -EINVAL, -EPERM
4685 */
4686int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
4687 struct ieee80211_regdomain *rd);
4688
4689/**
Johannes Bergd3236552009-04-20 14:31:42 +02004690 * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
4691 * @wiphy: the wireless device we want to process the regulatory domain on
4692 * @regd: the custom regulatory domain to use for this wiphy
4693 *
4694 * Drivers can sometimes have custom regulatory domains which do not apply
4695 * to a specific country. Drivers can use this to apply such custom regulatory
4696 * domains. This routine must be called prior to wiphy registration. The
4697 * custom regulatory domain will be trusted completely and as such previous
4698 * default channel settings will be disregarded. If no rule is found for a
4699 * channel on the regulatory domain the channel will be disabled.
Luis R. Rodriguez222ea582013-11-05 09:18:00 -08004700 * Drivers using this for a wiphy should also set the wiphy flag
Kalle Valoce261512014-04-03 10:03:45 +03004701 * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
Luis R. Rodriguez222ea582013-11-05 09:18:00 -08004702 * that called this helper.
Johannes Bergd3236552009-04-20 14:31:42 +02004703 */
Joe Perches10dd9b72013-07-31 17:31:37 -07004704void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
4705 const struct ieee80211_regdomain *regd);
Johannes Bergd3236552009-04-20 14:31:42 +02004706
4707/**
4708 * freq_reg_info - get regulatory information for the given frequency
4709 * @wiphy: the wiphy for which we want to process this rule for
4710 * @center_freq: Frequency in KHz for which we want regulatory information for
Johannes Bergd3236552009-04-20 14:31:42 +02004711 *
4712 * Use this function to get the regulatory rule for a specific frequency on
4713 * a given wireless device. If the device has a specific regulatory domain
4714 * it wants to follow we respect that unless a country IE has been received
4715 * and processed already.
4716 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004717 * Return: A valid pointer, or, when an error occurs, for example if no rule
4718 * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
4719 * check and PTR_ERR() to obtain the numeric return value. The numeric return
4720 * value will be -ERANGE if we determine the given center_freq does not even
4721 * have a regulatory rule for a frequency range in the center_freq's band.
4722 * See freq_in_rule_band() for our current definition of a band -- this is
4723 * purely subjective and right now it's 802.11 specific.
Johannes Bergd3236552009-04-20 14:31:42 +02004724 */
Johannes Berg361c9c82012-12-06 15:57:14 +01004725const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
4726 u32 center_freq);
Johannes Bergd3236552009-04-20 14:31:42 +02004727
Luis R. Rodriguez034c6d62013-10-14 17:42:06 -07004728/**
4729 * reg_initiator_name - map regulatory request initiator enum to name
4730 * @initiator: the regulatory request initiator
4731 *
4732 * You can use this to map the regulatory request initiator enum to a
4733 * proper string representation.
4734 */
4735const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
4736
Haim Dreyfuss19d35772018-03-28 13:24:11 +03004737/**
4738 * DOC: Internal regulatory db functions
4739 *
4740 */
4741
4742/**
4743 * reg_query_regdb_wmm - Query internal regulatory db for wmm rule
4744 * Regulatory self-managed driver can use it to proactively
4745 *
4746 * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
4747 * @freq: the freqency(in MHz) to be queried.
4748 * @ptr: pointer where the regdb wmm data is to be stored (or %NULL if
4749 * irrelevant). This can be used later for deduplication.
4750 * @rule: pointer to store the wmm rule from the regulatory db.
4751 *
4752 * Self-managed wireless drivers can use this function to query
4753 * the internal regulatory database to check whether the given
4754 * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
4755 *
4756 * Drivers should check the return value, its possible you can get
4757 * an -ENODATA.
4758 *
4759 * Return: 0 on success. -ENODATA.
4760 */
4761int reg_query_regdb_wmm(char *alpha2, int freq, u32 *ptr,
4762 struct ieee80211_wmm_rule *rule);
4763
Johannes Bergd3236552009-04-20 14:31:42 +02004764/*
Johannes Bergd3236552009-04-20 14:31:42 +02004765 * callbacks for asynchronous cfg80211 methods, notification
4766 * functions and BSS handling helpers
4767 */
4768
Johannes Berg2a519312009-02-10 21:25:55 +01004769/**
4770 * cfg80211_scan_done - notify that scan finished
4771 *
4772 * @request: the corresponding scan request
Avraham Stern1d762502016-07-05 17:10:13 +03004773 * @info: information about the completed scan
Johannes Berg2a519312009-02-10 21:25:55 +01004774 */
Avraham Stern1d762502016-07-05 17:10:13 +03004775void cfg80211_scan_done(struct cfg80211_scan_request *request,
4776 struct cfg80211_scan_info *info);
Johannes Berg2a519312009-02-10 21:25:55 +01004777
4778/**
Luciano Coelho807f8a82011-05-11 17:09:35 +03004779 * cfg80211_sched_scan_results - notify that new scan results are available
4780 *
4781 * @wiphy: the wiphy which got scheduled scan results
Arend Van Sprielb34939b2017-04-28 13:40:28 +01004782 * @reqid: identifier for the related scheduled scan request
Luciano Coelho807f8a82011-05-11 17:09:35 +03004783 */
Arend Van Sprielb34939b2017-04-28 13:40:28 +01004784void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
Luciano Coelho807f8a82011-05-11 17:09:35 +03004785
4786/**
4787 * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
4788 *
4789 * @wiphy: the wiphy on which the scheduled scan stopped
Arend Van Sprielb34939b2017-04-28 13:40:28 +01004790 * @reqid: identifier for the related scheduled scan request
Luciano Coelho807f8a82011-05-11 17:09:35 +03004791 *
4792 * The driver can call this function to inform cfg80211 that the
4793 * scheduled scan had to be stopped, for whatever reason. The driver
4794 * is then called back via the sched_scan_stop operation when done.
4795 */
Arend Van Sprielb34939b2017-04-28 13:40:28 +01004796void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
Luciano Coelho807f8a82011-05-11 17:09:35 +03004797
4798/**
Eliad Peller792e6aa2014-04-30 16:14:23 +03004799 * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
4800 *
4801 * @wiphy: the wiphy on which the scheduled scan stopped
Arend Van Sprielb34939b2017-04-28 13:40:28 +01004802 * @reqid: identifier for the related scheduled scan request
Eliad Peller792e6aa2014-04-30 16:14:23 +03004803 *
4804 * The driver can call this function to inform cfg80211 that the
4805 * scheduled scan had to be stopped, for whatever reason. The driver
4806 * is then called back via the sched_scan_stop operation when done.
4807 * This function should be called with rtnl locked.
4808 */
Arend Van Sprielb34939b2017-04-28 13:40:28 +01004809void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
Eliad Peller792e6aa2014-04-30 16:14:23 +03004810
4811/**
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02004812 * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
Johannes Berg2a519312009-02-10 21:25:55 +01004813 * @wiphy: the wiphy reporting the BSS
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02004814 * @data: the BSS metadata
Johannes Bergabe37c42010-06-07 11:12:27 +02004815 * @mgmt: the management frame (probe response or beacon)
4816 * @len: length of the management frame
Johannes Berg2a519312009-02-10 21:25:55 +01004817 * @gfp: context flags
4818 *
4819 * This informs cfg80211 that BSS information was found and
4820 * the BSS should be updated/added.
Johannes Bergef100682011-10-27 14:45:02 +02004821 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004822 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4823 * Or %NULL on error.
Johannes Berg2a519312009-02-10 21:25:55 +01004824 */
Johannes Bergef100682011-10-27 14:45:02 +02004825struct cfg80211_bss * __must_check
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02004826cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
4827 struct cfg80211_inform_bss *data,
4828 struct ieee80211_mgmt *mgmt, size_t len,
4829 gfp_t gfp);
4830
4831static inline struct cfg80211_bss * __must_check
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004832cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
Emmanuel Grumbach3afc2162014-03-04 16:50:13 +02004833 struct ieee80211_channel *rx_channel,
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004834 enum nl80211_bss_scan_width scan_width,
4835 struct ieee80211_mgmt *mgmt, size_t len,
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02004836 s32 signal, gfp_t gfp)
4837{
4838 struct cfg80211_inform_bss data = {
4839 .chan = rx_channel,
4840 .scan_width = scan_width,
4841 .signal = signal,
4842 };
4843
4844 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
4845}
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004846
4847static inline struct cfg80211_bss * __must_check
Johannes Berg2a519312009-02-10 21:25:55 +01004848cfg80211_inform_bss_frame(struct wiphy *wiphy,
Emmanuel Grumbach3afc2162014-03-04 16:50:13 +02004849 struct ieee80211_channel *rx_channel,
Johannes Berg2a519312009-02-10 21:25:55 +01004850 struct ieee80211_mgmt *mgmt, size_t len,
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004851 s32 signal, gfp_t gfp)
4852{
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02004853 struct cfg80211_inform_bss data = {
4854 .chan = rx_channel,
4855 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4856 .signal = signal,
4857 };
4858
4859 return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004860}
Johannes Berg2a519312009-02-10 21:25:55 +01004861
Johannes Bergabe37c42010-06-07 11:12:27 +02004862/**
Johannes Berg5bc8c1f2014-08-12 21:01:28 +02004863 * enum cfg80211_bss_frame_type - frame type that the BSS data came from
4864 * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
4865 * from a beacon or probe response
4866 * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
4867 * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
4868 */
4869enum cfg80211_bss_frame_type {
4870 CFG80211_BSS_FTYPE_UNKNOWN,
4871 CFG80211_BSS_FTYPE_BEACON,
4872 CFG80211_BSS_FTYPE_PRESP,
4873};
4874
4875/**
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02004876 * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
Johannes Bergabe37c42010-06-07 11:12:27 +02004877 *
4878 * @wiphy: the wiphy reporting the BSS
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02004879 * @data: the BSS metadata
Johannes Berg5bc8c1f2014-08-12 21:01:28 +02004880 * @ftype: frame type (if known)
Johannes Bergabe37c42010-06-07 11:12:27 +02004881 * @bssid: the BSSID of the BSS
Johannes Berg7b8bcff2012-03-13 13:57:04 +01004882 * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
Johannes Bergabe37c42010-06-07 11:12:27 +02004883 * @capability: the capability field sent by the peer
4884 * @beacon_interval: the beacon interval announced by the peer
4885 * @ie: additional IEs sent by the peer
4886 * @ielen: length of the additional IEs
Johannes Bergabe37c42010-06-07 11:12:27 +02004887 * @gfp: context flags
4888 *
4889 * This informs cfg80211 that BSS information was found and
4890 * the BSS should be updated/added.
Johannes Bergef100682011-10-27 14:45:02 +02004891 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01004892 * Return: A referenced struct, must be released with cfg80211_put_bss()!
4893 * Or %NULL on error.
Johannes Bergabe37c42010-06-07 11:12:27 +02004894 */
Johannes Bergef100682011-10-27 14:45:02 +02004895struct cfg80211_bss * __must_check
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02004896cfg80211_inform_bss_data(struct wiphy *wiphy,
4897 struct cfg80211_inform_bss *data,
4898 enum cfg80211_bss_frame_type ftype,
4899 const u8 *bssid, u64 tsf, u16 capability,
4900 u16 beacon_interval, const u8 *ie, size_t ielen,
4901 gfp_t gfp);
4902
4903static inline struct cfg80211_bss * __must_check
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004904cfg80211_inform_bss_width(struct wiphy *wiphy,
Emmanuel Grumbach3afc2162014-03-04 16:50:13 +02004905 struct ieee80211_channel *rx_channel,
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004906 enum nl80211_bss_scan_width scan_width,
Johannes Berg5bc8c1f2014-08-12 21:01:28 +02004907 enum cfg80211_bss_frame_type ftype,
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004908 const u8 *bssid, u64 tsf, u16 capability,
4909 u16 beacon_interval, const u8 *ie, size_t ielen,
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02004910 s32 signal, gfp_t gfp)
4911{
4912 struct cfg80211_inform_bss data = {
4913 .chan = rx_channel,
4914 .scan_width = scan_width,
4915 .signal = signal,
4916 };
4917
4918 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4919 capability, beacon_interval, ie, ielen,
4920 gfp);
4921}
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004922
4923static inline struct cfg80211_bss * __must_check
Jussi Kivilinna06aa7af2009-03-26 23:40:09 +02004924cfg80211_inform_bss(struct wiphy *wiphy,
Emmanuel Grumbach3afc2162014-03-04 16:50:13 +02004925 struct ieee80211_channel *rx_channel,
Johannes Berg5bc8c1f2014-08-12 21:01:28 +02004926 enum cfg80211_bss_frame_type ftype,
Johannes Berg7b8bcff2012-03-13 13:57:04 +01004927 const u8 *bssid, u64 tsf, u16 capability,
4928 u16 beacon_interval, const u8 *ie, size_t ielen,
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004929 s32 signal, gfp_t gfp)
4930{
Dmitry Shmidt6e19bc42015-10-07 11:32:53 +02004931 struct cfg80211_inform_bss data = {
4932 .chan = rx_channel,
4933 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
4934 .signal = signal,
4935 };
4936
4937 return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
4938 capability, beacon_interval, ie, ielen,
4939 gfp);
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004940}
Jussi Kivilinna06aa7af2009-03-26 23:40:09 +02004941
Johannes Berg27548672017-03-31 09:12:39 +02004942/**
4943 * cfg80211_get_bss - get a BSS reference
4944 * @wiphy: the wiphy this BSS struct belongs to
4945 * @channel: the channel to search on (or %NULL)
4946 * @bssid: the desired BSSID (or %NULL)
4947 * @ssid: the desired SSID (or %NULL)
4948 * @ssid_len: length of the SSID (or 0)
4949 * @bss_type: type of BSS, see &enum ieee80211_bss_type
4950 * @privacy: privacy filter, see &enum ieee80211_privacy
4951 */
Johannes Berg2a519312009-02-10 21:25:55 +01004952struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
4953 struct ieee80211_channel *channel,
4954 const u8 *bssid,
Johannes Berg79420f02009-02-10 21:25:59 +01004955 const u8 *ssid, size_t ssid_len,
Dedy Lansky6eb18132015-02-08 15:52:03 +02004956 enum ieee80211_bss_type bss_type,
Johannes Berg27548672017-03-31 09:12:39 +02004957 enum ieee80211_privacy privacy);
Johannes Berg79420f02009-02-10 21:25:59 +01004958static inline struct cfg80211_bss *
4959cfg80211_get_ibss(struct wiphy *wiphy,
4960 struct ieee80211_channel *channel,
4961 const u8 *ssid, size_t ssid_len)
4962{
4963 return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
Dedy Lansky6eb18132015-02-08 15:52:03 +02004964 IEEE80211_BSS_TYPE_IBSS,
4965 IEEE80211_PRIVACY_ANY);
Johannes Berg79420f02009-02-10 21:25:59 +01004966}
4967
Johannes Berg4c0c0b72012-01-20 13:55:26 +01004968/**
4969 * cfg80211_ref_bss - reference BSS struct
Johannes Berg5b112d32013-02-01 01:49:58 +01004970 * @wiphy: the wiphy this BSS struct belongs to
Johannes Berg4c0c0b72012-01-20 13:55:26 +01004971 * @bss: the BSS struct to reference
4972 *
4973 * Increments the refcount of the given BSS struct.
4974 */
Johannes Berg5b112d32013-02-01 01:49:58 +01004975void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
Johannes Berg4c0c0b72012-01-20 13:55:26 +01004976
4977/**
4978 * cfg80211_put_bss - unref BSS struct
Johannes Berg5b112d32013-02-01 01:49:58 +01004979 * @wiphy: the wiphy this BSS struct belongs to
Johannes Berg4c0c0b72012-01-20 13:55:26 +01004980 * @bss: the BSS struct
4981 *
4982 * Decrements the refcount of the given BSS struct.
4983 */
Johannes Berg5b112d32013-02-01 01:49:58 +01004984void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
Johannes Bergd3236552009-04-20 14:31:42 +02004985
Johannes Bergd491af12009-02-10 21:25:58 +01004986/**
4987 * cfg80211_unlink_bss - unlink BSS from internal data structures
4988 * @wiphy: the wiphy
4989 * @bss: the bss to remove
4990 *
4991 * This function removes the given BSS from the internal data structures
4992 * thereby making it no longer show up in scan results etc. Use this
4993 * function when you detect a BSS is gone. Normally BSSes will also time
4994 * out, so it is not necessary to use this function at all.
4995 */
4996void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
Johannes Bergfee52672008-11-26 22:36:31 +01004997
Simon Wunderlichdcd6eac2013-07-08 16:55:49 +02004998static inline enum nl80211_bss_scan_width
4999cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
5000{
5001 switch (chandef->width) {
5002 case NL80211_CHAN_WIDTH_5:
5003 return NL80211_BSS_CHAN_WIDTH_5;
5004 case NL80211_CHAN_WIDTH_10:
5005 return NL80211_BSS_CHAN_WIDTH_10;
5006 default:
5007 return NL80211_BSS_CHAN_WIDTH_20;
5008 }
5009}
5010
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005011/**
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005012 * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005013 * @dev: network device
5014 * @buf: authentication frame (header + body)
5015 * @len: length of the frame data
5016 *
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005017 * This function is called whenever an authentication, disassociation or
5018 * deauthentication frame has been received and processed in station mode.
5019 * After being asked to authenticate via cfg80211_ops::auth() the driver must
5020 * call either this function or cfg80211_auth_timeout().
5021 * After being asked to associate via cfg80211_ops::assoc() the driver must
5022 * call either this function or cfg80211_auth_timeout().
5023 * While connected, the driver must calls this for received and processed
5024 * disassociation and deauthentication frames. If the frame couldn't be used
5025 * because it was unprotected, the driver must call the function
5026 * cfg80211_rx_unprot_mlme_mgmt() instead.
5027 *
5028 * This function may sleep. The caller must hold the corresponding wdev's mutex.
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005029 */
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005030void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005031
5032/**
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005033 * cfg80211_auth_timeout - notification of timed out authentication
Jouni Malinen1965c852009-04-22 21:38:25 +03005034 * @dev: network device
5035 * @addr: The MAC address of the device with which the authentication timed out
Johannes Bergcb0b4be2009-07-07 03:56:07 +02005036 *
Johannes Berg8d61ffa2013-05-10 12:32:47 +02005037 * This function may sleep. The caller must hold the corresponding wdev's
5038 * mutex.
Jouni Malinen1965c852009-04-22 21:38:25 +03005039 */
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005040void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
Jouni Malinen1965c852009-04-22 21:38:25 +03005041
5042/**
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005043 * cfg80211_rx_assoc_resp - notification of processed association response
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005044 * @dev: network device
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005045 * @bss: the BSS that association was requested with, ownership of the pointer
5046 * moves to cfg80211 in this call
5047 * @buf: authentication frame (header + body)
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005048 * @len: length of the frame data
Emmanuel Grumbachf438ceb2016-10-18 23:12:12 +03005049 * @uapsd_queues: bitmap of queues configured for uapsd. Same format
5050 * as the AC bitmap in the QoS info field
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005051 *
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005052 * After being asked to associate via cfg80211_ops::assoc() the driver must
5053 * call either this function or cfg80211_auth_timeout().
5054 *
5055 * This function may sleep. The caller must hold the corresponding wdev's mutex.
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005056 */
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005057void cfg80211_rx_assoc_resp(struct net_device *dev,
5058 struct cfg80211_bss *bss,
Eliad Pellerb0b6aa22014-09-09 17:09:45 +03005059 const u8 *buf, size_t len,
5060 int uapsd_queues);
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005061
5062/**
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005063 * cfg80211_assoc_timeout - notification of timed out association
Jouni Malinen1965c852009-04-22 21:38:25 +03005064 * @dev: network device
Johannes Berg959867f2013-06-19 13:05:42 +02005065 * @bss: The BSS entry with which association timed out.
Johannes Bergcb0b4be2009-07-07 03:56:07 +02005066 *
Johannes Berg8d61ffa2013-05-10 12:32:47 +02005067 * This function may sleep. The caller must hold the corresponding wdev's mutex.
Jouni Malinen1965c852009-04-22 21:38:25 +03005068 */
Johannes Berg959867f2013-06-19 13:05:42 +02005069void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
Jouni Malinen1965c852009-04-22 21:38:25 +03005070
5071/**
Johannes Berge6f462d2016-12-08 17:22:09 +01005072 * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
5073 * @dev: network device
5074 * @bss: The BSS entry with which association was abandoned.
5075 *
5076 * Call this whenever - for reasons reported through other API, like deauth RX,
5077 * an association attempt was abandoned.
5078 * This function may sleep. The caller must hold the corresponding wdev's mutex.
5079 */
5080void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
5081
5082/**
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005083 * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005084 * @dev: network device
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005085 * @buf: 802.11 frame (header + body)
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005086 * @len: length of the frame data
5087 *
5088 * This function is called whenever deauthentication has been processed in
Jouni Malinen53b46b82009-03-27 20:53:56 +02005089 * station mode. This includes both received deauthentication frames and
Johannes Berg8d61ffa2013-05-10 12:32:47 +02005090 * locally generated ones. This function may sleep. The caller must hold the
5091 * corresponding wdev's mutex.
Jouni Malinen6039f6d2009-03-19 13:39:21 +02005092 */
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005093void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
Holger Schurigce470612009-10-13 13:28:13 +02005094
5095/**
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005096 * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
Jouni Malinencf4e5942010-12-16 00:52:40 +02005097 * @dev: network device
5098 * @buf: deauthentication frame (header + body)
5099 * @len: length of the frame data
5100 *
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005101 * This function is called whenever a received deauthentication or dissassoc
5102 * frame has been dropped in station mode because of MFP being used but the
Jouni Malinencf4e5942010-12-16 00:52:40 +02005103 * frame was not protected. This function may sleep.
5104 */
Johannes Berg6ff57cf2013-05-16 00:55:00 +02005105void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
5106 const u8 *buf, size_t len);
Jouni Malinencf4e5942010-12-16 00:52:40 +02005107
5108/**
Jouni Malinena3b8b052009-03-27 21:59:49 +02005109 * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
5110 * @dev: network device
5111 * @addr: The source MAC address of the frame
5112 * @key_type: The key type that the received frame used
Arik Nemtsova66b98d2011-06-23 00:00:24 +03005113 * @key_id: Key identifier (0..3). Can be -1 if missing.
Jouni Malinena3b8b052009-03-27 21:59:49 +02005114 * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
Johannes Berge6d6e342009-07-01 21:26:47 +02005115 * @gfp: allocation flags
Jouni Malinena3b8b052009-03-27 21:59:49 +02005116 *
5117 * This function is called whenever the local MAC detects a MIC failure in a
5118 * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
5119 * primitive.
5120 */
5121void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
5122 enum nl80211_key_type key_type, int key_id,
Johannes Berge6d6e342009-07-01 21:26:47 +02005123 const u8 *tsc, gfp_t gfp);
Jouni Malinena3b8b052009-03-27 21:59:49 +02005124
Johannes Berg04a773a2009-04-19 21:24:32 +02005125/**
5126 * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
5127 *
5128 * @dev: network device
5129 * @bssid: the BSSID of the IBSS joined
Antonio Quartullife94f3a2014-01-29 17:53:43 +01005130 * @channel: the channel of the IBSS joined
Johannes Berg04a773a2009-04-19 21:24:32 +02005131 * @gfp: allocation flags
5132 *
5133 * This function notifies cfg80211 that the device joined an IBSS or
5134 * switched to a different BSSID. Before this function can be called,
5135 * either a beacon has to have been received from the IBSS, or one of
5136 * the cfg80211_inform_bss{,_frame} functions must have been called
5137 * with the locally generated beacon -- this guarantees that there is
5138 * always a scan result for this IBSS. cfg80211 will handle the rest.
5139 */
Antonio Quartullife94f3a2014-01-29 17:53:43 +01005140void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
5141 struct ieee80211_channel *channel, gfp_t gfp);
Johannes Berg04a773a2009-04-19 21:24:32 +02005142
Johannes Berg1f87f7d2009-06-02 13:01:41 +02005143/**
Javier Cardonac93b5e72011-04-07 15:08:34 -07005144 * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
5145 *
5146 * @dev: network device
5147 * @macaddr: the MAC address of the new candidate
5148 * @ie: information elements advertised by the peer candidate
5149 * @ie_len: lenght of the information elements buffer
5150 * @gfp: allocation flags
5151 *
5152 * This function notifies cfg80211 that the mesh peer candidate has been
5153 * detected, most likely via a beacon or, less likely, via a probe response.
5154 * cfg80211 then sends a notification to userspace.
5155 */
5156void cfg80211_notify_new_peer_candidate(struct net_device *dev,
5157 const u8 *macaddr, const u8 *ie, u8 ie_len, gfp_t gfp);
5158
5159/**
Johannes Bergd70e9692010-08-19 16:11:27 +02005160 * DOC: RFkill integration
5161 *
5162 * RFkill integration in cfg80211 is almost invisible to drivers,
5163 * as cfg80211 automatically registers an rfkill instance for each
5164 * wireless device it knows about. Soft kill is also translated
5165 * into disconnecting and turning all interfaces off, drivers are
5166 * expected to turn off the device when all interfaces are down.
5167 *
5168 * However, devices may have a hard RFkill line, in which case they
5169 * also need to interact with the rfkill subsystem, via cfg80211.
5170 * They can do this with a few helper functions documented here.
5171 */
5172
5173/**
Johannes Berg1f87f7d2009-06-02 13:01:41 +02005174 * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
5175 * @wiphy: the wiphy
5176 * @blocked: block status
5177 */
5178void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
5179
5180/**
5181 * wiphy_rfkill_start_polling - start polling rfkill
5182 * @wiphy: the wiphy
5183 */
5184void wiphy_rfkill_start_polling(struct wiphy *wiphy);
5185
5186/**
5187 * wiphy_rfkill_stop_polling - stop polling rfkill
5188 * @wiphy: the wiphy
5189 */
5190void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
5191
Johannes Bergad7e7182013-11-13 13:37:47 +01005192/**
5193 * DOC: Vendor commands
5194 *
5195 * Occasionally, there are special protocol or firmware features that
5196 * can't be implemented very openly. For this and similar cases, the
5197 * vendor command functionality allows implementing the features with
5198 * (typically closed-source) userspace and firmware, using nl80211 as
5199 * the configuration mechanism.
5200 *
5201 * A driver supporting vendor commands must register them as an array
5202 * in struct wiphy, with handlers for each one, each command has an
5203 * OUI and sub command ID to identify it.
5204 *
5205 * Note that this feature should not be (ab)used to implement protocol
5206 * features that could openly be shared across drivers. In particular,
5207 * it must never be required to use vendor commands to implement any
5208 * "normal" functionality that higher-level userspace like connection
5209 * managers etc. need.
5210 */
5211
5212struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
5213 enum nl80211_commands cmd,
5214 enum nl80211_attrs attr,
5215 int approxlen);
5216
Johannes Berg567ffc32013-12-18 14:43:31 +01005217struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
Ahmad Kholaif6c09e792015-02-26 15:26:53 +02005218 struct wireless_dev *wdev,
Johannes Berg567ffc32013-12-18 14:43:31 +01005219 enum nl80211_commands cmd,
5220 enum nl80211_attrs attr,
5221 int vendor_event_idx,
5222 int approxlen, gfp_t gfp);
5223
5224void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
5225
Johannes Bergad7e7182013-11-13 13:37:47 +01005226/**
5227 * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
5228 * @wiphy: the wiphy
5229 * @approxlen: an upper bound of the length of the data that will
5230 * be put into the skb
5231 *
5232 * This function allocates and pre-fills an skb for a reply to
5233 * a vendor command. Since it is intended for a reply, calling
5234 * it outside of a vendor command's doit() operation is invalid.
5235 *
5236 * The returned skb is pre-filled with some identifying data in
5237 * a way that any data that is put into the skb (with skb_put(),
5238 * nla_put() or similar) will end up being within the
5239 * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
5240 * with the skb is adding data for the corresponding userspace tool
5241 * which can then read that data out of the vendor data attribute.
5242 * You must not modify the skb in any other way.
5243 *
5244 * When done, call cfg80211_vendor_cmd_reply() with the skb and return
5245 * its error code as the result of the doit() operation.
5246 *
5247 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5248 */
5249static inline struct sk_buff *
5250cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5251{
5252 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
5253 NL80211_ATTR_VENDOR_DATA, approxlen);
5254}
5255
5256/**
5257 * cfg80211_vendor_cmd_reply - send the reply skb
5258 * @skb: The skb, must have been allocated with
5259 * cfg80211_vendor_cmd_alloc_reply_skb()
5260 *
5261 * Since calling this function will usually be the last thing
5262 * before returning from the vendor command doit() you should
5263 * return the error code. Note that this function consumes the
5264 * skb regardless of the return value.
5265 *
5266 * Return: An error code or 0 on success.
5267 */
5268int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
5269
Johannes Berg567ffc32013-12-18 14:43:31 +01005270/**
5271 * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
5272 * @wiphy: the wiphy
Ahmad Kholaif6c09e792015-02-26 15:26:53 +02005273 * @wdev: the wireless device
Johannes Berg567ffc32013-12-18 14:43:31 +01005274 * @event_idx: index of the vendor event in the wiphy's vendor_events
5275 * @approxlen: an upper bound of the length of the data that will
5276 * be put into the skb
5277 * @gfp: allocation flags
5278 *
5279 * This function allocates and pre-fills an skb for an event on the
5280 * vendor-specific multicast group.
5281 *
Ahmad Kholaif6c09e792015-02-26 15:26:53 +02005282 * If wdev != NULL, both the ifindex and identifier of the specified
5283 * wireless device are added to the event message before the vendor data
5284 * attribute.
5285 *
Johannes Berg567ffc32013-12-18 14:43:31 +01005286 * When done filling the skb, call cfg80211_vendor_event() with the
5287 * skb to send the event.
5288 *
5289 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
5290 */
5291static inline struct sk_buff *
Ahmad Kholaif6c09e792015-02-26 15:26:53 +02005292cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
5293 int approxlen, int event_idx, gfp_t gfp)
Johannes Berg567ffc32013-12-18 14:43:31 +01005294{
Ahmad Kholaif6c09e792015-02-26 15:26:53 +02005295 return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
Johannes Berg567ffc32013-12-18 14:43:31 +01005296 NL80211_ATTR_VENDOR_DATA,
5297 event_idx, approxlen, gfp);
5298}
5299
5300/**
5301 * cfg80211_vendor_event - send the event
5302 * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
5303 * @gfp: allocation flags
5304 *
5305 * This function sends the given @skb, which must have been allocated
5306 * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
5307 */
5308static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
5309{
5310 __cfg80211_send_event_skb(skb, gfp);
5311}
5312
Johannes Bergaff89a92009-07-01 21:26:51 +02005313#ifdef CONFIG_NL80211_TESTMODE
5314/**
Johannes Bergd70e9692010-08-19 16:11:27 +02005315 * DOC: Test mode
5316 *
5317 * Test mode is a set of utility functions to allow drivers to
5318 * interact with driver-specific tools to aid, for instance,
5319 * factory programming.
5320 *
5321 * This chapter describes how drivers interact with it, for more
5322 * information see the nl80211 book's chapter on it.
5323 */
5324
5325/**
Johannes Bergaff89a92009-07-01 21:26:51 +02005326 * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
5327 * @wiphy: the wiphy
5328 * @approxlen: an upper bound of the length of the data that will
5329 * be put into the skb
5330 *
5331 * This function allocates and pre-fills an skb for a reply to
5332 * the testmode command. Since it is intended for a reply, calling
5333 * it outside of the @testmode_cmd operation is invalid.
5334 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005335 * The returned skb is pre-filled with the wiphy index and set up in
5336 * a way that any data that is put into the skb (with skb_put(),
5337 * nla_put() or similar) will end up being within the
5338 * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
5339 * with the skb is adding data for the corresponding userspace tool
5340 * which can then read that data out of the testdata attribute. You
5341 * must not modify the skb in any other way.
Johannes Bergaff89a92009-07-01 21:26:51 +02005342 *
5343 * When done, call cfg80211_testmode_reply() with the skb and return
5344 * its error code as the result of the @testmode_cmd operation.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005345 *
5346 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
Johannes Bergaff89a92009-07-01 21:26:51 +02005347 */
Johannes Bergad7e7182013-11-13 13:37:47 +01005348static inline struct sk_buff *
5349cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
5350{
5351 return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
5352 NL80211_ATTR_TESTDATA, approxlen);
5353}
Johannes Bergaff89a92009-07-01 21:26:51 +02005354
5355/**
5356 * cfg80211_testmode_reply - send the reply skb
5357 * @skb: The skb, must have been allocated with
5358 * cfg80211_testmode_alloc_reply_skb()
5359 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005360 * Since calling this function will usually be the last thing
5361 * before returning from the @testmode_cmd you should return
5362 * the error code. Note that this function consumes the skb
5363 * regardless of the return value.
5364 *
5365 * Return: An error code or 0 on success.
Johannes Bergaff89a92009-07-01 21:26:51 +02005366 */
Johannes Bergad7e7182013-11-13 13:37:47 +01005367static inline int cfg80211_testmode_reply(struct sk_buff *skb)
5368{
5369 return cfg80211_vendor_cmd_reply(skb);
5370}
Johannes Bergaff89a92009-07-01 21:26:51 +02005371
5372/**
5373 * cfg80211_testmode_alloc_event_skb - allocate testmode event
5374 * @wiphy: the wiphy
5375 * @approxlen: an upper bound of the length of the data that will
5376 * be put into the skb
5377 * @gfp: allocation flags
5378 *
5379 * This function allocates and pre-fills an skb for an event on the
5380 * testmode multicast group.
5381 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005382 * The returned skb is set up in the same way as with
5383 * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
5384 * there, you should simply add data to it that will then end up in the
5385 * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
5386 * in any other way.
Johannes Bergaff89a92009-07-01 21:26:51 +02005387 *
5388 * When done filling the skb, call cfg80211_testmode_event() with the
5389 * skb to send the event.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005390 *
5391 * Return: An allocated and pre-filled skb. %NULL if any errors happen.
Johannes Bergaff89a92009-07-01 21:26:51 +02005392 */
Johannes Berg567ffc32013-12-18 14:43:31 +01005393static inline struct sk_buff *
5394cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
5395{
Ahmad Kholaif6c09e792015-02-26 15:26:53 +02005396 return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
Johannes Berg567ffc32013-12-18 14:43:31 +01005397 NL80211_ATTR_TESTDATA, -1,
5398 approxlen, gfp);
5399}
Johannes Bergaff89a92009-07-01 21:26:51 +02005400
5401/**
5402 * cfg80211_testmode_event - send the event
5403 * @skb: The skb, must have been allocated with
5404 * cfg80211_testmode_alloc_event_skb()
5405 * @gfp: allocation flags
5406 *
5407 * This function sends the given @skb, which must have been allocated
5408 * by cfg80211_testmode_alloc_event_skb(), as an event. It always
5409 * consumes it.
5410 */
Johannes Berg567ffc32013-12-18 14:43:31 +01005411static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
5412{
5413 __cfg80211_send_event_skb(skb, gfp);
5414}
Johannes Bergaff89a92009-07-01 21:26:51 +02005415
5416#define CFG80211_TESTMODE_CMD(cmd) .testmode_cmd = (cmd),
Wey-Yi Guy71063f02011-05-20 09:05:54 -07005417#define CFG80211_TESTMODE_DUMP(cmd) .testmode_dump = (cmd),
Johannes Bergaff89a92009-07-01 21:26:51 +02005418#else
5419#define CFG80211_TESTMODE_CMD(cmd)
Wey-Yi Guy71063f02011-05-20 09:05:54 -07005420#define CFG80211_TESTMODE_DUMP(cmd)
Johannes Bergaff89a92009-07-01 21:26:51 +02005421#endif
5422
Samuel Ortizb23aa672009-07-01 21:26:54 +02005423/**
Arend Van Spriel76804d22018-05-22 10:19:06 +02005424 * struct cfg80211_fils_resp_params - FILS connection response params
5425 * @kek: KEK derived from a successful FILS connection (may be %NULL)
5426 * @kek_len: Length of @fils_kek in octets
5427 * @update_erp_next_seq_num: Boolean value to specify whether the value in
5428 * @erp_next_seq_num is valid.
5429 * @erp_next_seq_num: The next sequence number to use in ERP message in
5430 * FILS Authentication. This value should be specified irrespective of the
5431 * status for a FILS connection.
5432 * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
5433 * @pmk_len: Length of @pmk in octets
5434 * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
5435 * used for this FILS connection (may be %NULL).
5436 */
5437struct cfg80211_fils_resp_params {
5438 const u8 *kek;
5439 size_t kek_len;
5440 bool update_erp_next_seq_num;
5441 u16 erp_next_seq_num;
5442 const u8 *pmk;
5443 size_t pmk_len;
5444 const u8 *pmkid;
5445};
5446
5447/**
Vidyullatha Kanchanapally5349a0f2017-03-31 00:22:33 +03005448 * struct cfg80211_connect_resp_params - Connection response params
5449 * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
5450 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5451 * the real status code for failures. If this call is used to report a
5452 * failure due to a timeout (e.g., not receiving an Authentication frame
5453 * from the AP) instead of an explicit rejection by the AP, -1 is used to
5454 * indicate that this is a failure, but without a status code.
5455 * @timeout_reason is used to report the reason for the timeout in that
5456 * case.
5457 * @bssid: The BSSID of the AP (may be %NULL)
5458 * @bss: Entry of bss to which STA got connected to, can be obtained through
5459 * cfg80211_get_bss() (may be %NULL). Only one parameter among @bssid and
5460 * @bss needs to be specified.
5461 * @req_ie: Association request IEs (may be %NULL)
5462 * @req_ie_len: Association request IEs length
5463 * @resp_ie: Association response IEs (may be %NULL)
5464 * @resp_ie_len: Association response IEs length
Arend Van Spriel76804d22018-05-22 10:19:06 +02005465 * @fils: FILS connection response parameters.
Vidyullatha Kanchanapally5349a0f2017-03-31 00:22:33 +03005466 * @timeout_reason: Reason for connection timeout. This is used when the
5467 * connection fails due to a timeout instead of an explicit rejection from
5468 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5469 * not known. This value is used only if @status < 0 to indicate that the
5470 * failure is due to a timeout and not due to explicit rejection by the AP.
5471 * This value is ignored in other cases (@status >= 0).
5472 */
5473struct cfg80211_connect_resp_params {
5474 int status;
5475 const u8 *bssid;
5476 struct cfg80211_bss *bss;
5477 const u8 *req_ie;
5478 size_t req_ie_len;
5479 const u8 *resp_ie;
5480 size_t resp_ie_len;
Arend Van Spriel76804d22018-05-22 10:19:06 +02005481 struct cfg80211_fils_resp_params fils;
Vidyullatha Kanchanapally5349a0f2017-03-31 00:22:33 +03005482 enum nl80211_timeout_reason timeout_reason;
5483};
5484
5485/**
5486 * cfg80211_connect_done - notify cfg80211 of connection result
5487 *
5488 * @dev: network device
5489 * @params: connection response parameters
5490 * @gfp: allocation flags
5491 *
5492 * It should be called by the underlying driver once execution of the connection
5493 * request from connect() has been completed. This is similar to
5494 * cfg80211_connect_bss(), but takes a structure pointer for connection response
5495 * parameters. Only one of the functions among cfg80211_connect_bss(),
5496 * cfg80211_connect_result(), cfg80211_connect_timeout(),
5497 * and cfg80211_connect_done() should be called.
5498 */
5499void cfg80211_connect_done(struct net_device *dev,
5500 struct cfg80211_connect_resp_params *params,
5501 gfp_t gfp);
5502
5503/**
Kanchanapally, Vidyullathae7054982016-04-11 15:16:01 +05305504 * cfg80211_connect_bss - notify cfg80211 of connection result
5505 *
5506 * @dev: network device
5507 * @bssid: the BSSID of the AP
5508 * @bss: entry of bss to which STA got connected to, can be obtained
5509 * through cfg80211_get_bss (may be %NULL)
5510 * @req_ie: association request IEs (maybe be %NULL)
5511 * @req_ie_len: association request IEs length
5512 * @resp_ie: association response IEs (may be %NULL)
5513 * @resp_ie_len: assoc response IEs length
Jouni Malinenc88215d2017-01-13 01:12:22 +02005514 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
5515 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5516 * the real status code for failures. If this call is used to report a
5517 * failure due to a timeout (e.g., not receiving an Authentication frame
5518 * from the AP) instead of an explicit rejection by the AP, -1 is used to
5519 * indicate that this is a failure, but without a status code.
5520 * @timeout_reason is used to report the reason for the timeout in that
5521 * case.
Kanchanapally, Vidyullathae7054982016-04-11 15:16:01 +05305522 * @gfp: allocation flags
Purushottam Kushwaha3093ebbeab2017-01-13 01:12:21 +02005523 * @timeout_reason: reason for connection timeout. This is used when the
5524 * connection fails due to a timeout instead of an explicit rejection from
5525 * the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
5526 * not known. This value is used only if @status < 0 to indicate that the
5527 * failure is due to a timeout and not due to explicit rejection by the AP.
5528 * This value is ignored in other cases (@status >= 0).
Kanchanapally, Vidyullathae7054982016-04-11 15:16:01 +05305529 *
Jouni Malinenc88215d2017-01-13 01:12:22 +02005530 * It should be called by the underlying driver once execution of the connection
5531 * request from connect() has been completed. This is similar to
5532 * cfg80211_connect_result(), but with the option of identifying the exact bss
Vidyullatha Kanchanapally5349a0f2017-03-31 00:22:33 +03005533 * entry for the connection. Only one of the functions among
5534 * cfg80211_connect_bss(), cfg80211_connect_result(),
5535 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
Kanchanapally, Vidyullathae7054982016-04-11 15:16:01 +05305536 */
Vidyullatha Kanchanapally5349a0f2017-03-31 00:22:33 +03005537static inline void
5538cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
5539 struct cfg80211_bss *bss, const u8 *req_ie,
5540 size_t req_ie_len, const u8 *resp_ie,
5541 size_t resp_ie_len, int status, gfp_t gfp,
5542 enum nl80211_timeout_reason timeout_reason)
5543{
5544 struct cfg80211_connect_resp_params params;
5545
5546 memset(&params, 0, sizeof(params));
5547 params.status = status;
5548 params.bssid = bssid;
5549 params.bss = bss;
5550 params.req_ie = req_ie;
5551 params.req_ie_len = req_ie_len;
5552 params.resp_ie = resp_ie;
5553 params.resp_ie_len = resp_ie_len;
5554 params.timeout_reason = timeout_reason;
5555
5556 cfg80211_connect_done(dev, &params, gfp);
5557}
Kanchanapally, Vidyullathae7054982016-04-11 15:16:01 +05305558
5559/**
Samuel Ortizb23aa672009-07-01 21:26:54 +02005560 * cfg80211_connect_result - notify cfg80211 of connection result
5561 *
5562 * @dev: network device
5563 * @bssid: the BSSID of the AP
5564 * @req_ie: association request IEs (maybe be %NULL)
5565 * @req_ie_len: association request IEs length
5566 * @resp_ie: association response IEs (may be %NULL)
5567 * @resp_ie_len: assoc response IEs length
Jouni Malinenc88215d2017-01-13 01:12:22 +02005568 * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
Samuel Ortizb23aa672009-07-01 21:26:54 +02005569 * %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
5570 * the real status code for failures.
5571 * @gfp: allocation flags
5572 *
Jouni Malinenc88215d2017-01-13 01:12:22 +02005573 * It should be called by the underlying driver once execution of the connection
5574 * request from connect() has been completed. This is similar to
5575 * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
Vidyullatha Kanchanapally5349a0f2017-03-31 00:22:33 +03005576 * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
5577 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
Samuel Ortizb23aa672009-07-01 21:26:54 +02005578 */
Kanchanapally, Vidyullathae7054982016-04-11 15:16:01 +05305579static inline void
5580cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
5581 const u8 *req_ie, size_t req_ie_len,
5582 const u8 *resp_ie, size_t resp_ie_len,
5583 u16 status, gfp_t gfp)
5584{
5585 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
Purushottam Kushwaha3093ebbeab2017-01-13 01:12:21 +02005586 resp_ie_len, status, gfp,
5587 NL80211_TIMEOUT_UNSPECIFIED);
Kanchanapally, Vidyullathae7054982016-04-11 15:16:01 +05305588}
Samuel Ortizb23aa672009-07-01 21:26:54 +02005589
5590/**
Jouni Malinenbf1ecd22016-05-31 00:16:50 +03005591 * cfg80211_connect_timeout - notify cfg80211 of connection timeout
5592 *
5593 * @dev: network device
5594 * @bssid: the BSSID of the AP
5595 * @req_ie: association request IEs (maybe be %NULL)
5596 * @req_ie_len: association request IEs length
5597 * @gfp: allocation flags
Purushottam Kushwaha3093ebbeab2017-01-13 01:12:21 +02005598 * @timeout_reason: reason for connection timeout.
Jouni Malinenbf1ecd22016-05-31 00:16:50 +03005599 *
5600 * It should be called by the underlying driver whenever connect() has failed
5601 * in a sequence where no explicit authentication/association rejection was
5602 * received from the AP. This could happen, e.g., due to not being able to send
5603 * out the Authentication or Association Request frame or timing out while
Vidyullatha Kanchanapally5349a0f2017-03-31 00:22:33 +03005604 * waiting for the response. Only one of the functions among
5605 * cfg80211_connect_bss(), cfg80211_connect_result(),
5606 * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
Jouni Malinenbf1ecd22016-05-31 00:16:50 +03005607 */
5608static inline void
5609cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
Purushottam Kushwaha3093ebbeab2017-01-13 01:12:21 +02005610 const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
5611 enum nl80211_timeout_reason timeout_reason)
Jouni Malinenbf1ecd22016-05-31 00:16:50 +03005612{
5613 cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
Purushottam Kushwaha3093ebbeab2017-01-13 01:12:21 +02005614 gfp, timeout_reason);
Jouni Malinenbf1ecd22016-05-31 00:16:50 +03005615}
5616
5617/**
Avraham Stern29ce6ec2017-04-26 10:58:49 +03005618 * struct cfg80211_roam_info - driver initiated roaming information
5619 *
5620 * @channel: the channel of the new AP
5621 * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
5622 * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
5623 * @req_ie: association request IEs (maybe be %NULL)
5624 * @req_ie_len: association request IEs length
5625 * @resp_ie: association response IEs (may be %NULL)
5626 * @resp_ie_len: assoc response IEs length
5627 */
5628struct cfg80211_roam_info {
5629 struct ieee80211_channel *channel;
5630 struct cfg80211_bss *bss;
5631 const u8 *bssid;
5632 const u8 *req_ie;
5633 size_t req_ie_len;
5634 const u8 *resp_ie;
5635 size_t resp_ie_len;
5636};
5637
5638/**
Samuel Ortizb23aa672009-07-01 21:26:54 +02005639 * cfg80211_roamed - notify cfg80211 of roaming
5640 *
5641 * @dev: network device
Avraham Stern29ce6ec2017-04-26 10:58:49 +03005642 * @info: information about the new BSS. struct &cfg80211_roam_info.
Samuel Ortizb23aa672009-07-01 21:26:54 +02005643 * @gfp: allocation flags
5644 *
Avraham Stern29ce6ec2017-04-26 10:58:49 +03005645 * This function may be called with the driver passing either the BSSID of the
5646 * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
5647 * It should be called by the underlying driver whenever it roamed from one AP
5648 * to another while connected. Drivers which have roaming implemented in
5649 * firmware should pass the bss entry to avoid a race in bss entry timeout where
5650 * the bss entry of the new AP is seen in the driver, but gets timed out by the
5651 * time it is accessed in __cfg80211_roamed() due to delay in scheduling
Vasanthakumar Thiagarajanadbde342011-12-08 14:28:47 +05305652 * rdev->event_work. In case of any failures, the reference is released
Avraham Stern29ce6ec2017-04-26 10:58:49 +03005653 * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
5654 * released while diconneting from the current bss.
Vasanthakumar Thiagarajanadbde342011-12-08 14:28:47 +05305655 */
Avraham Stern29ce6ec2017-04-26 10:58:49 +03005656void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
5657 gfp_t gfp);
Vasanthakumar Thiagarajanadbde342011-12-08 14:28:47 +05305658
5659/**
Avraham Stern503c1fb2017-09-29 14:21:49 +02005660 * cfg80211_port_authorized - notify cfg80211 of successful security association
5661 *
5662 * @dev: network device
5663 * @bssid: the BSSID of the AP
5664 * @gfp: allocation flags
5665 *
5666 * This function should be called by a driver that supports 4 way handshake
5667 * offload after a security association was successfully established (i.e.,
5668 * the 4 way handshake was completed successfully). The call to this function
5669 * should be preceded with a call to cfg80211_connect_result(),
5670 * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
5671 * indicate the 802.11 association.
5672 */
5673void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
5674 gfp_t gfp);
5675
5676/**
Samuel Ortizb23aa672009-07-01 21:26:54 +02005677 * cfg80211_disconnected - notify cfg80211 that connection was dropped
5678 *
5679 * @dev: network device
5680 * @ie: information elements of the deauth/disassoc frame (may be %NULL)
5681 * @ie_len: length of IEs
5682 * @reason: reason code for the disconnection, set it to 0 if unknown
Johannes Berg80279fb2015-05-22 16:22:20 +02005683 * @locally_generated: disconnection was requested locally
Samuel Ortizb23aa672009-07-01 21:26:54 +02005684 * @gfp: allocation flags
5685 *
5686 * After it calls this function, the driver should enter an idle state
5687 * and not try to connect to any AP any more.
5688 */
5689void cfg80211_disconnected(struct net_device *dev, u16 reason,
Johannes Berg80279fb2015-05-22 16:22:20 +02005690 const u8 *ie, size_t ie_len,
5691 bool locally_generated, gfp_t gfp);
Samuel Ortizb23aa672009-07-01 21:26:54 +02005692
Jouni Malinen9588bbd2009-12-23 13:15:41 +01005693/**
5694 * cfg80211_ready_on_channel - notification of remain_on_channel start
Johannes Berg71bbc992012-06-15 15:30:18 +02005695 * @wdev: wireless device
Jouni Malinen9588bbd2009-12-23 13:15:41 +01005696 * @cookie: the request cookie
5697 * @chan: The current channel (from remain_on_channel request)
Jouni Malinen9588bbd2009-12-23 13:15:41 +01005698 * @duration: Duration in milliseconds that the driver intents to remain on the
5699 * channel
5700 * @gfp: allocation flags
5701 */
Johannes Berg71bbc992012-06-15 15:30:18 +02005702void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
Jouni Malinen9588bbd2009-12-23 13:15:41 +01005703 struct ieee80211_channel *chan,
Jouni Malinen9588bbd2009-12-23 13:15:41 +01005704 unsigned int duration, gfp_t gfp);
5705
5706/**
5707 * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
Johannes Berg71bbc992012-06-15 15:30:18 +02005708 * @wdev: wireless device
Jouni Malinen9588bbd2009-12-23 13:15:41 +01005709 * @cookie: the request cookie
5710 * @chan: The current channel (from remain_on_channel request)
Jouni Malinen9588bbd2009-12-23 13:15:41 +01005711 * @gfp: allocation flags
5712 */
Johannes Berg71bbc992012-06-15 15:30:18 +02005713void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
Jouni Malinen9588bbd2009-12-23 13:15:41 +01005714 struct ieee80211_channel *chan,
Jouni Malinen9588bbd2009-12-23 13:15:41 +01005715 gfp_t gfp);
Samuel Ortizb23aa672009-07-01 21:26:54 +02005716
Arend van Spriel8689c052018-05-10 13:50:12 +02005717/**
5718 * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
5719 *
5720 * @sinfo: the station information
5721 * @gfp: allocation flags
5722 */
5723int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
Johannes Berg98b62182009-12-23 13:15:44 +01005724
5725/**
Johannes Berg7ea3e112018-05-18 11:40:44 +02005726 * cfg80211_sinfo_release_content - release contents of station info
5727 * @sinfo: the station information
5728 *
5729 * Releases any potentially allocated sub-information of the station
5730 * information, but not the struct itself (since it's typically on
5731 * the stack.)
5732 */
5733static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
5734{
5735 kfree(sinfo->pertid);
5736}
5737
5738/**
Johannes Berg98b62182009-12-23 13:15:44 +01005739 * cfg80211_new_sta - notify userspace about station
5740 *
5741 * @dev: the netdev
5742 * @mac_addr: the station's address
5743 * @sinfo: the station information
5744 * @gfp: allocation flags
5745 */
5746void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
5747 struct station_info *sinfo, gfp_t gfp);
5748
Jouni Malinen026331c2010-02-15 12:53:10 +02005749/**
Johannes Bergcf5ead82014-11-14 17:14:00 +01005750 * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
5751 * @dev: the netdev
5752 * @mac_addr: the station's address
5753 * @sinfo: the station information/statistics
5754 * @gfp: allocation flags
5755 */
5756void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
5757 struct station_info *sinfo, gfp_t gfp);
5758
5759/**
Jouni Malinenec15e682011-03-23 15:29:52 +02005760 * cfg80211_del_sta - notify userspace about deletion of a station
5761 *
5762 * @dev: the netdev
5763 * @mac_addr: the station's address
5764 * @gfp: allocation flags
5765 */
Johannes Bergcf5ead82014-11-14 17:14:00 +01005766static inline void cfg80211_del_sta(struct net_device *dev,
5767 const u8 *mac_addr, gfp_t gfp)
5768{
5769 cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
5770}
Jouni Malinenec15e682011-03-23 15:29:52 +02005771
5772/**
Pandiyarajan Pitchaimuthued44a952012-09-18 16:50:49 +05305773 * cfg80211_conn_failed - connection request failed notification
5774 *
5775 * @dev: the netdev
5776 * @mac_addr: the station's address
5777 * @reason: the reason for connection failure
5778 * @gfp: allocation flags
5779 *
5780 * Whenever a station tries to connect to an AP and if the station
5781 * could not connect to the AP as the AP has rejected the connection
5782 * for some reasons, this function is called.
5783 *
5784 * The reason for connection failure can be any of the value from
5785 * nl80211_connect_failed_reason enum
5786 */
5787void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
5788 enum nl80211_connect_failed_reason reason,
5789 gfp_t gfp);
5790
5791/**
Johannes Berg2e161f782010-08-12 15:38:38 +02005792 * cfg80211_rx_mgmt - notification of received, unprocessed management frame
Johannes Berg71bbc992012-06-15 15:30:18 +02005793 * @wdev: wireless device receiving the frame
Jouni Malinen026331c2010-02-15 12:53:10 +02005794 * @freq: Frequency on which the frame was received in MHz
Sergey Matyukevich6c2fb1e2017-11-09 14:46:30 +03005795 * @sig_dbm: signal strength in dBm, or 0 if unknown
Johannes Berg2e161f782010-08-12 15:38:38 +02005796 * @buf: Management frame (header + body)
Jouni Malinen026331c2010-02-15 12:53:10 +02005797 * @len: length of the frame data
Vladimir Kondratiev19504cf2013-08-15 14:51:28 +03005798 * @flags: flags, as defined in enum nl80211_rxmgmt_flags
Johannes Berg2e161f782010-08-12 15:38:38 +02005799 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005800 * This function is called whenever an Action frame is received for a station
5801 * mode interface, but is not processed in kernel.
5802 *
5803 * Return: %true if a user space application has registered for this frame.
Johannes Berg2e161f782010-08-12 15:38:38 +02005804 * For action frames, that makes it responsible for rejecting unrecognized
5805 * action frames; %false otherwise, in which case for action frames the
5806 * driver is responsible for rejecting the frame.
Jouni Malinen026331c2010-02-15 12:53:10 +02005807 */
Johannes Berg71bbc992012-06-15 15:30:18 +02005808bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
Vladimir Kondratiev970fdfa2014-08-11 03:29:57 -07005809 const u8 *buf, size_t len, u32 flags);
Jouni Malinen026331c2010-02-15 12:53:10 +02005810
5811/**
Johannes Berg2e161f782010-08-12 15:38:38 +02005812 * cfg80211_mgmt_tx_status - notification of TX status for management frame
Johannes Berg71bbc992012-06-15 15:30:18 +02005813 * @wdev: wireless device receiving the frame
Johannes Berg2e161f782010-08-12 15:38:38 +02005814 * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
5815 * @buf: Management frame (header + body)
Jouni Malinen026331c2010-02-15 12:53:10 +02005816 * @len: length of the frame data
5817 * @ack: Whether frame was acknowledged
5818 * @gfp: context flags
5819 *
Johannes Berg2e161f782010-08-12 15:38:38 +02005820 * This function is called whenever a management frame was requested to be
5821 * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
Jouni Malinen026331c2010-02-15 12:53:10 +02005822 * transmission attempt.
5823 */
Johannes Berg71bbc992012-06-15 15:30:18 +02005824void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
Johannes Berg2e161f782010-08-12 15:38:38 +02005825 const u8 *buf, size_t len, bool ack, gfp_t gfp);
Jouni Malinen026331c2010-02-15 12:53:10 +02005826
Juuso Oikarinend6dc1a32010-03-23 09:02:33 +02005827
5828/**
Denis Kenzior6a671a52018-03-26 12:52:41 -05005829 * cfg80211_rx_control_port - notification about a received control port frame
5830 * @dev: The device the frame matched to
5831 * @buf: control port frame
5832 * @len: length of the frame data
5833 * @addr: The peer from which the frame was received
5834 * @proto: frame protocol, typically PAE or Pre-authentication
5835 * @unencrypted: Whether the frame was received unencrypted
5836 *
5837 * This function is used to inform userspace about a received control port
5838 * frame. It should only be used if userspace indicated it wants to receive
5839 * control port frames over nl80211.
5840 *
5841 * The frame is the data portion of the 802.3 or 802.11 data frame with all
5842 * network layer headers removed (e.g. the raw EAPoL frame).
5843 *
5844 * Return: %true if the frame was passed to userspace
5845 */
5846bool cfg80211_rx_control_port(struct net_device *dev,
5847 const u8 *buf, size_t len,
5848 const u8 *addr, u16 proto, bool unencrypted);
5849
5850/**
Juuso Oikarinend6dc1a32010-03-23 09:02:33 +02005851 * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
5852 * @dev: network device
5853 * @rssi_event: the triggered RSSI event
Andrzej Zaborowskibee427b2017-01-25 12:43:41 +01005854 * @rssi_level: new RSSI level value or 0 if not available
Juuso Oikarinend6dc1a32010-03-23 09:02:33 +02005855 * @gfp: context flags
5856 *
5857 * This function is called when a configured connection quality monitoring
5858 * rssi threshold reached event occurs.
5859 */
5860void cfg80211_cqm_rssi_notify(struct net_device *dev,
5861 enum nl80211_cqm_rssi_threshold_event rssi_event,
Andrzej Zaborowskibee427b2017-01-25 12:43:41 +01005862 s32 rssi_level, gfp_t gfp);
Juuso Oikarinend6dc1a32010-03-23 09:02:33 +02005863
Johannes Bergc063dbf2010-11-24 08:10:05 +01005864/**
5865 * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
5866 * @dev: network device
5867 * @peer: peer's MAC address
5868 * @num_packets: how many packets were lost -- should be a fixed threshold
5869 * but probably no less than maybe 50, or maybe a throughput dependent
5870 * threshold (to account for temporary interference)
5871 * @gfp: context flags
5872 */
5873void cfg80211_cqm_pktloss_notify(struct net_device *dev,
5874 const u8 *peer, u32 num_packets, gfp_t gfp);
5875
Johannes Berge5497d72011-07-05 16:35:40 +02005876/**
Thomas Pedersen84f10702012-07-12 16:17:33 -07005877 * cfg80211_cqm_txe_notify - TX error rate event
5878 * @dev: network device
5879 * @peer: peer's MAC address
5880 * @num_packets: how many packets were lost
5881 * @rate: % of packets which failed transmission
5882 * @intvl: interval (in s) over which the TX failure threshold was breached.
5883 * @gfp: context flags
5884 *
5885 * Notify userspace when configured % TX failures over number of packets in a
5886 * given interval is exceeded.
5887 */
5888void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
5889 u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
5890
5891/**
Johannes Berg98f03342014-11-26 12:42:02 +01005892 * cfg80211_cqm_beacon_loss_notify - beacon loss event
5893 * @dev: network device
5894 * @gfp: context flags
5895 *
5896 * Notify userspace about beacon loss from the connected AP.
5897 */
5898void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
5899
5900/**
Johannes Berg5b97f492014-11-26 12:37:43 +01005901 * cfg80211_radar_event - radar detection event
5902 * @wiphy: the wiphy
5903 * @chandef: chandef for the current channel
5904 * @gfp: context flags
5905 *
5906 * This function is called when a radar is detected on the current chanenl.
5907 */
5908void cfg80211_radar_event(struct wiphy *wiphy,
5909 struct cfg80211_chan_def *chandef, gfp_t gfp);
5910
5911/**
tamizhr@codeaurora.org466b9932018-01-31 16:24:49 +05305912 * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
5913 * @dev: network device
5914 * @mac: MAC address of a station which opmode got modified
5915 * @sta_opmode: station's current opmode value
5916 * @gfp: context flags
5917 *
5918 * Driver should call this function when station's opmode modified via action
5919 * frame.
5920 */
5921void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
5922 struct sta_opmode_info *sta_opmode,
5923 gfp_t gfp);
5924
5925/**
Johannes Berg5b97f492014-11-26 12:37:43 +01005926 * cfg80211_cac_event - Channel availability check (CAC) event
5927 * @netdev: network device
5928 * @chandef: chandef for the current channel
5929 * @event: type of event
5930 * @gfp: context flags
5931 *
5932 * This function is called when a Channel availability check (CAC) is finished
5933 * or aborted. This must be called to notify the completion of a CAC process,
5934 * also by full-MAC drivers.
5935 */
5936void cfg80211_cac_event(struct net_device *netdev,
5937 const struct cfg80211_chan_def *chandef,
5938 enum nl80211_radar_event event, gfp_t gfp);
5939
5940
5941/**
Johannes Berge5497d72011-07-05 16:35:40 +02005942 * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
5943 * @dev: network device
5944 * @bssid: BSSID of AP (to avoid races)
5945 * @replay_ctr: new replay counter
Johannes Bergaf71ff82011-07-09 14:48:30 +02005946 * @gfp: allocation flags
Johannes Berge5497d72011-07-05 16:35:40 +02005947 */
5948void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
5949 const u8 *replay_ctr, gfp_t gfp);
5950
Jouni Malinenc9df56b2011-09-16 18:56:23 +03005951/**
5952 * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
5953 * @dev: network device
5954 * @index: candidate index (the smaller the index, the higher the priority)
5955 * @bssid: BSSID of AP
5956 * @preauth: Whether AP advertises support for RSN pre-authentication
5957 * @gfp: allocation flags
5958 */
5959void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
5960 const u8 *bssid, bool preauth, gfp_t gfp);
5961
Johannes Berg28946da2011-11-04 11:18:12 +01005962/**
5963 * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
5964 * @dev: The device the frame matched to
5965 * @addr: the transmitter address
5966 * @gfp: context flags
5967 *
5968 * This function is used in AP mode (only!) to inform userspace that
5969 * a spurious class 3 frame was received, to be able to deauth the
5970 * sender.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005971 * Return: %true if the frame was passed to userspace (or this failed
Johannes Berg28946da2011-11-04 11:18:12 +01005972 * for a reason other than not having a subscription.)
5973 */
5974bool cfg80211_rx_spurious_frame(struct net_device *dev,
5975 const u8 *addr, gfp_t gfp);
5976
Johannes Berg7f6cf312011-11-04 11:18:15 +01005977/**
Johannes Bergb92ab5d2011-11-04 11:18:19 +01005978 * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
5979 * @dev: The device the frame matched to
5980 * @addr: the transmitter address
5981 * @gfp: context flags
5982 *
5983 * This function is used in AP mode (only!) to inform userspace that
5984 * an associated station sent a 4addr frame but that wasn't expected.
5985 * It is allowed and desirable to send this event only once for each
5986 * station to avoid event flooding.
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01005987 * Return: %true if the frame was passed to userspace (or this failed
Johannes Bergb92ab5d2011-11-04 11:18:19 +01005988 * for a reason other than not having a subscription.)
5989 */
5990bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
5991 const u8 *addr, gfp_t gfp);
5992
5993/**
Johannes Berg7f6cf312011-11-04 11:18:15 +01005994 * cfg80211_probe_status - notify userspace about probe status
5995 * @dev: the device the probe was sent on
5996 * @addr: the address of the peer
5997 * @cookie: the cookie filled in @probe_client previously
5998 * @acked: indicates whether probe was acked or not
Venkateswara Naralasettyc4b50cd2018-02-13 11:03:06 +05305999 * @ack_signal: signal strength (in dBm) of the ACK frame.
6000 * @is_valid_ack_signal: indicates the ack_signal is valid or not.
Johannes Berg7f6cf312011-11-04 11:18:15 +01006001 * @gfp: allocation flags
6002 */
6003void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
Venkateswara Naralasettyc4b50cd2018-02-13 11:03:06 +05306004 u64 cookie, bool acked, s32 ack_signal,
6005 bool is_valid_ack_signal, gfp_t gfp);
Johannes Berg7f6cf312011-11-04 11:18:15 +01006006
Johannes Berg5e760232011-11-04 11:18:17 +01006007/**
6008 * cfg80211_report_obss_beacon - report beacon from other APs
6009 * @wiphy: The wiphy that received the beacon
6010 * @frame: the frame
6011 * @len: length of the frame
6012 * @freq: frequency the frame was received on
Sergey Matyukevich6c2fb1e2017-11-09 14:46:30 +03006013 * @sig_dbm: signal strength in dBm, or 0 if unknown
Johannes Berg5e760232011-11-04 11:18:17 +01006014 *
6015 * Use this function to report to userspace when a beacon was
6016 * received. It is not useful to call this when there is no
6017 * netdev that is in AP/GO mode.
6018 */
6019void cfg80211_report_obss_beacon(struct wiphy *wiphy,
6020 const u8 *frame, size_t len,
Ben Greear37c73b52012-10-26 14:49:25 -07006021 int freq, int sig_dbm);
Johannes Berg5e760232011-11-04 11:18:17 +01006022
Johannes Bergd58e7e32012-05-16 23:50:17 +02006023/**
Johannes Berg683b6d32012-11-08 21:25:48 +01006024 * cfg80211_reg_can_beacon - check if beaconing is allowed
Alexander Simon54858ee5b2011-11-30 16:56:32 +01006025 * @wiphy: the wiphy
Johannes Berg683b6d32012-11-08 21:25:48 +01006026 * @chandef: the channel definition
Ilan Peer174e0cd2014-02-23 09:13:01 +02006027 * @iftype: interface type
Johannes Bergd58e7e32012-05-16 23:50:17 +02006028 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01006029 * Return: %true if there is no secondary channel or the secondary channel(s)
6030 * can be used for beaconing (i.e. is not a radar channel etc.)
Alexander Simon54858ee5b2011-11-30 16:56:32 +01006031 */
Johannes Berg683b6d32012-11-08 21:25:48 +01006032bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
Ilan Peer174e0cd2014-02-23 09:13:01 +02006033 struct cfg80211_chan_def *chandef,
6034 enum nl80211_iftype iftype);
Alexander Simon54858ee5b2011-11-30 16:56:32 +01006035
Arik Nemtsov923b3522015-07-08 15:41:44 +03006036/**
6037 * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
6038 * @wiphy: the wiphy
6039 * @chandef: the channel definition
6040 * @iftype: interface type
6041 *
6042 * Return: %true if there is no secondary channel or the secondary channel(s)
6043 * can be used for beaconing (i.e. is not a radar channel etc.). This version
6044 * also checks if IR-relaxation conditions apply, to allow beaconing under
6045 * more permissive conditions.
6046 *
6047 * Requires the RTNL to be held.
6048 */
6049bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
6050 struct cfg80211_chan_def *chandef,
6051 enum nl80211_iftype iftype);
6052
Thomas Pedersen8097e142012-03-05 15:31:47 -08006053/*
Thomas Pedersen53145262012-04-06 13:35:47 -07006054 * cfg80211_ch_switch_notify - update wdev channel and notify userspace
6055 * @dev: the device which switched channels
Johannes Berg683b6d32012-11-08 21:25:48 +01006056 * @chandef: the new channel definition
Thomas Pedersen53145262012-04-06 13:35:47 -07006057 *
Simon Wunderliche487eae2013-11-21 18:19:51 +01006058 * Caller must acquire wdev_lock, therefore must only be called from sleepable
6059 * driver context!
Thomas Pedersen53145262012-04-06 13:35:47 -07006060 */
Johannes Berg683b6d32012-11-08 21:25:48 +01006061void cfg80211_ch_switch_notify(struct net_device *dev,
6062 struct cfg80211_chan_def *chandef);
Thomas Pedersen53145262012-04-06 13:35:47 -07006063
Luciano Coelhof8d75522014-11-07 14:31:35 +02006064/*
6065 * cfg80211_ch_switch_started_notify - notify channel switch start
6066 * @dev: the device on which the channel switch started
6067 * @chandef: the future channel definition
6068 * @count: the number of TBTTs until the channel switch happens
6069 *
6070 * Inform the userspace about the channel switch that has just
6071 * started, so that it can take appropriate actions (eg. starting
6072 * channel switch on other vifs), if necessary.
6073 */
6074void cfg80211_ch_switch_started_notify(struct net_device *dev,
6075 struct cfg80211_chan_def *chandef,
6076 u8 count);
6077
Johannes Berg1ce3e822012-08-01 17:00:55 +02006078/**
6079 * ieee80211_operating_class_to_band - convert operating class to band
6080 *
6081 * @operating_class: the operating class to convert
6082 * @band: band pointer to fill
6083 *
6084 * Returns %true if the conversion was successful, %false otherwise.
6085 */
6086bool ieee80211_operating_class_to_band(u8 operating_class,
Johannes Berg57fbcce2016-04-12 15:56:15 +02006087 enum nl80211_band *band);
Johannes Berg1ce3e822012-08-01 17:00:55 +02006088
Arik Nemtsova38700d2015-03-18 08:46:08 +02006089/**
6090 * ieee80211_chandef_to_operating_class - convert chandef to operation class
6091 *
6092 * @chandef: the chandef to convert
6093 * @op_class: a pointer to the resulting operating class
6094 *
6095 * Returns %true if the conversion was successful, %false otherwise.
6096 */
6097bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
6098 u8 *op_class);
6099
Thomas Pedersen53145262012-04-06 13:35:47 -07006100/*
Jouni Malinen3475b092012-11-16 22:49:57 +02006101 * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
6102 * @dev: the device on which the operation is requested
6103 * @peer: the MAC address of the peer device
6104 * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
6105 * NL80211_TDLS_TEARDOWN)
6106 * @reason_code: the reason code for teardown request
6107 * @gfp: allocation flags
6108 *
6109 * This function is used to request userspace to perform TDLS operation that
6110 * requires knowledge of keys, i.e., link setup or teardown when the AP
6111 * connection uses encryption. This is optional mechanism for the driver to use
6112 * if it can automatically determine when a TDLS link could be useful (e.g.,
6113 * based on traffic and signal strength for a peer).
6114 */
6115void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
6116 enum nl80211_tdls_operation oper,
6117 u16 reason_code, gfp_t gfp);
6118
6119/*
Thomas Pedersen8097e142012-03-05 15:31:47 -08006120 * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
6121 * @rate: given rate_info to calculate bitrate from
6122 *
6123 * return 0 if MCS index >= 32
6124 */
Vladimir Kondratiev8eb41c82012-07-05 14:25:49 +03006125u32 cfg80211_calculate_bitrate(struct rate_info *rate);
Thomas Pedersen8097e142012-03-05 15:31:47 -08006126
Johannes Berg98104fde2012-06-16 00:19:54 +02006127/**
6128 * cfg80211_unregister_wdev - remove the given wdev
6129 * @wdev: struct wireless_dev to remove
6130 *
6131 * Call this function only for wdevs that have no netdev assigned,
6132 * e.g. P2P Devices. It removes the device from the list so that
6133 * it can no longer be used. It is necessary to call this function
6134 * even when cfg80211 requests the removal of the interface by
6135 * calling the del_virtual_intf() callback. The function must also
6136 * be called when the driver wishes to unregister the wdev, e.g.
6137 * when the device is unbound from the driver.
6138 *
6139 * Requires the RTNL to be held.
6140 */
6141void cfg80211_unregister_wdev(struct wireless_dev *wdev);
6142
Johannes Berg0ee45352012-10-29 19:48:40 +01006143/**
Jouni Malinen355199e2013-02-27 17:14:27 +02006144 * struct cfg80211_ft_event - FT Information Elements
6145 * @ies: FT IEs
6146 * @ies_len: length of the FT IE in bytes
6147 * @target_ap: target AP's MAC address
6148 * @ric_ies: RIC IE
6149 * @ric_ies_len: length of the RIC IE in bytes
6150 */
6151struct cfg80211_ft_event_params {
6152 const u8 *ies;
6153 size_t ies_len;
6154 const u8 *target_ap;
6155 const u8 *ric_ies;
6156 size_t ric_ies_len;
6157};
6158
6159/**
6160 * cfg80211_ft_event - notify userspace about FT IE and RIC IE
6161 * @netdev: network device
6162 * @ft_event: IE information
6163 */
6164void cfg80211_ft_event(struct net_device *netdev,
6165 struct cfg80211_ft_event_params *ft_event);
6166
6167/**
Johannes Berg0ee45352012-10-29 19:48:40 +01006168 * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
6169 * @ies: the input IE buffer
6170 * @len: the input length
6171 * @attr: the attribute ID to find
6172 * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
6173 * if the function is only called to get the needed buffer size
6174 * @bufsize: size of the output buffer
6175 *
6176 * The function finds a given P2P attribute in the (vendor) IEs and
6177 * copies its contents to the given buffer.
6178 *
Yacine Belkadi0ae997d2013-01-12 13:54:14 +01006179 * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
6180 * malformed or the attribute can't be found (respectively), or the
6181 * length of the found attribute (which can be zero).
Johannes Berg0ee45352012-10-29 19:48:40 +01006182 */
Arend van Sprielc216e642012-11-25 19:13:28 +01006183int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
6184 enum ieee80211_p2p_attr_id attr,
6185 u8 *buf, unsigned int bufsize);
Johannes Berg0ee45352012-10-29 19:48:40 +01006186
Johannes Bergcd8f7cb2013-01-22 12:34:29 +01006187/**
Johannes Berg29464cc2015-03-31 15:36:22 +02006188 * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
6189 * @ies: the IE buffer
6190 * @ielen: the length of the IE buffer
6191 * @ids: an array with element IDs that are allowed before
Liad Kaufman2512b1b2017-08-05 11:44:31 +03006192 * the split. A WLAN_EID_EXTENSION value means that the next
6193 * EID in the list is a sub-element of the EXTENSION IE.
Johannes Berg29464cc2015-03-31 15:36:22 +02006194 * @n_ids: the size of the element ID array
6195 * @after_ric: array IE types that come after the RIC element
6196 * @n_after_ric: size of the @after_ric array
6197 * @offset: offset where to start splitting in the buffer
6198 *
6199 * This function splits an IE buffer by updating the @offset
6200 * variable to point to the location where the buffer should be
6201 * split.
6202 *
6203 * It assumes that the given IE buffer is well-formed, this
6204 * has to be guaranteed by the caller!
6205 *
6206 * It also assumes that the IEs in the buffer are ordered
6207 * correctly, if not the result of using this function will not
6208 * be ordered correctly either, i.e. it does no reordering.
6209 *
6210 * The function returns the offset where the next part of the
6211 * buffer starts, which may be @ielen if the entire (remainder)
6212 * of the buffer should be used.
6213 */
6214size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
6215 const u8 *ids, int n_ids,
6216 const u8 *after_ric, int n_after_ric,
6217 size_t offset);
6218
6219/**
6220 * ieee80211_ie_split - split an IE buffer according to ordering
6221 * @ies: the IE buffer
6222 * @ielen: the length of the IE buffer
6223 * @ids: an array with element IDs that are allowed before
Liad Kaufman2512b1b2017-08-05 11:44:31 +03006224 * the split. A WLAN_EID_EXTENSION value means that the next
6225 * EID in the list is a sub-element of the EXTENSION IE.
Johannes Berg29464cc2015-03-31 15:36:22 +02006226 * @n_ids: the size of the element ID array
6227 * @offset: offset where to start splitting in the buffer
6228 *
6229 * This function splits an IE buffer by updating the @offset
6230 * variable to point to the location where the buffer should be
6231 * split.
6232 *
6233 * It assumes that the given IE buffer is well-formed, this
6234 * has to be guaranteed by the caller!
6235 *
6236 * It also assumes that the IEs in the buffer are ordered
6237 * correctly, if not the result of using this function will not
6238 * be ordered correctly either, i.e. it does no reordering.
6239 *
6240 * The function returns the offset where the next part of the
6241 * buffer starts, which may be @ielen if the entire (remainder)
6242 * of the buffer should be used.
6243 */
Johannes Berg0483eea2015-10-23 09:50:03 +02006244static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
6245 const u8 *ids, int n_ids, size_t offset)
6246{
6247 return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
6248}
Johannes Berg29464cc2015-03-31 15:36:22 +02006249
6250/**
Johannes Bergcd8f7cb2013-01-22 12:34:29 +01006251 * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
6252 * @wdev: the wireless device reporting the wakeup
6253 * @wakeup: the wakeup report
6254 * @gfp: allocation flags
6255 *
6256 * This function reports that the given device woke up. If it
6257 * caused the wakeup, report the reason(s), otherwise you may
6258 * pass %NULL as the @wakeup parameter to advertise that something
6259 * else caused the wakeup.
6260 */
6261void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
6262 struct cfg80211_wowlan_wakeup *wakeup,
6263 gfp_t gfp);
6264
Arend van Spriel5de17982013-04-18 15:49:00 +02006265/**
6266 * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
6267 *
6268 * @wdev: the wireless device for which critical protocol is stopped.
Robert P. J. Day03f831a2013-05-02 07:15:09 -04006269 * @gfp: allocation flags
Arend van Spriel5de17982013-04-18 15:49:00 +02006270 *
6271 * This function can be called by the driver to indicate it has reverted
6272 * operation back to normal. One reason could be that the duration given
6273 * by .crit_proto_start() has expired.
6274 */
6275void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
6276
Ilan Peerbdfbec22014-01-09 11:37:23 +02006277/**
6278 * ieee80211_get_num_supported_channels - get number of channels device has
6279 * @wiphy: the wiphy
6280 *
6281 * Return: the number of channels supported by the device.
6282 */
6283unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
6284
Luciano Coelhocb2d9562014-02-17 16:52:35 +02006285/**
6286 * cfg80211_check_combinations - check interface combinations
6287 *
6288 * @wiphy: the wiphy
Purushottam Kushwahae2273002016-10-12 18:25:35 +05306289 * @params: the interface combinations parameter
Luciano Coelhocb2d9562014-02-17 16:52:35 +02006290 *
6291 * This function can be called by the driver to check whether a
6292 * combination of interfaces and their types are allowed according to
6293 * the interface combinations.
6294 */
6295int cfg80211_check_combinations(struct wiphy *wiphy,
Purushottam Kushwahae2273002016-10-12 18:25:35 +05306296 struct iface_combination_params *params);
Luciano Coelhocb2d9562014-02-17 16:52:35 +02006297
Michal Kazior65a124d2014-04-09 15:29:22 +02006298/**
6299 * cfg80211_iter_combinations - iterate over matching combinations
6300 *
6301 * @wiphy: the wiphy
Purushottam Kushwahae2273002016-10-12 18:25:35 +05306302 * @params: the interface combinations parameter
Michal Kazior65a124d2014-04-09 15:29:22 +02006303 * @iter: function to call for each matching combination
6304 * @data: pointer to pass to iter function
6305 *
6306 * This function can be called by the driver to check what possible
6307 * combinations it fits in at a given moment, e.g. for channel switching
6308 * purposes.
6309 */
6310int cfg80211_iter_combinations(struct wiphy *wiphy,
Purushottam Kushwahae2273002016-10-12 18:25:35 +05306311 struct iface_combination_params *params,
Michal Kazior65a124d2014-04-09 15:29:22 +02006312 void (*iter)(const struct ieee80211_iface_combination *c,
6313 void *data),
6314 void *data);
6315
Michal Kaziorf04c2202014-04-09 15:11:01 +02006316/*
6317 * cfg80211_stop_iface - trigger interface disconnection
6318 *
6319 * @wiphy: the wiphy
6320 * @wdev: wireless device
6321 * @gfp: context flags
6322 *
6323 * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
6324 * disconnected.
6325 *
6326 * Note: This doesn't need any locks and is asynchronous.
6327 */
6328void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
6329 gfp_t gfp);
6330
Johannes Bergf6837ba82014-04-30 14:19:04 +02006331/**
6332 * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
6333 * @wiphy: the wiphy to shut down
6334 *
6335 * This function shuts down all interfaces belonging to this wiphy by
6336 * calling dev_close() (and treating non-netdev interfaces as needed).
6337 * It shouldn't really be used unless there are some fatal device errors
6338 * that really can't be recovered in any other way.
6339 *
6340 * Callers must hold the RTNL and be able to deal with callbacks into
6341 * the driver while the function is running.
6342 */
6343void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
6344
Gautam Kumar Shuklad75bb062014-12-23 16:55:19 +01006345/**
6346 * wiphy_ext_feature_set - set the extended feature flag
6347 *
6348 * @wiphy: the wiphy to modify.
6349 * @ftidx: extended feature bit index.
6350 *
6351 * The extended features are flagged in multiple bytes (see
6352 * &struct wiphy.@ext_features)
6353 */
6354static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
6355 enum nl80211_ext_feature_index ftidx)
6356{
6357 u8 *ft_byte;
6358
6359 ft_byte = &wiphy->ext_features[ftidx / 8];
6360 *ft_byte |= BIT(ftidx % 8);
6361}
6362
6363/**
6364 * wiphy_ext_feature_isset - check the extended feature flag
6365 *
6366 * @wiphy: the wiphy to modify.
6367 * @ftidx: extended feature bit index.
6368 *
6369 * The extended features are flagged in multiple bytes (see
6370 * &struct wiphy.@ext_features)
6371 */
6372static inline bool
6373wiphy_ext_feature_isset(struct wiphy *wiphy,
6374 enum nl80211_ext_feature_index ftidx)
6375{
6376 u8 ft_byte;
6377
6378 ft_byte = wiphy->ext_features[ftidx / 8];
6379 return (ft_byte & BIT(ftidx % 8)) != 0;
6380}
Johannes Bergb7ffbd72014-06-04 17:31:56 +02006381
Ayala Bekera442b762016-09-20 17:31:15 +03006382/**
6383 * cfg80211_free_nan_func - free NAN function
6384 * @f: NAN function that should be freed
6385 *
6386 * Frees all the NAN function and all it's allocated members.
6387 */
6388void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
6389
Ayala Beker50bcd312016-09-20 17:31:17 +03006390/**
6391 * struct cfg80211_nan_match_params - NAN match parameters
6392 * @type: the type of the function that triggered a match. If it is
6393 * %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
6394 * If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
6395 * result.
6396 * If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
6397 * @inst_id: the local instance id
6398 * @peer_inst_id: the instance id of the peer's function
6399 * @addr: the MAC address of the peer
6400 * @info_len: the length of the &info
6401 * @info: the Service Specific Info from the peer (if any)
6402 * @cookie: unique identifier of the corresponding function
6403 */
6404struct cfg80211_nan_match_params {
6405 enum nl80211_nan_function_type type;
6406 u8 inst_id;
6407 u8 peer_inst_id;
6408 const u8 *addr;
6409 u8 info_len;
6410 const u8 *info;
6411 u64 cookie;
6412};
6413
6414/**
6415 * cfg80211_nan_match - report a match for a NAN function.
6416 * @wdev: the wireless device reporting the match
6417 * @match: match notification parameters
6418 * @gfp: allocation flags
6419 *
6420 * This function reports that the a NAN function had a match. This
6421 * can be a subscribe that had a match or a solicited publish that
6422 * was sent. It can also be a follow up that was received.
6423 */
6424void cfg80211_nan_match(struct wireless_dev *wdev,
6425 struct cfg80211_nan_match_params *match, gfp_t gfp);
6426
Ayala Beker368e5a72016-09-20 17:31:18 +03006427/**
6428 * cfg80211_nan_func_terminated - notify about NAN function termination.
6429 *
6430 * @wdev: the wireless device reporting the match
6431 * @inst_id: the local instance id
6432 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
6433 * @cookie: unique NAN function identifier
6434 * @gfp: allocation flags
6435 *
6436 * This function reports that the a NAN function is terminated.
6437 */
6438void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
6439 u8 inst_id,
6440 enum nl80211_nan_func_term_reason reason,
6441 u64 cookie, gfp_t gfp);
6442
Johannes Bergb7ffbd72014-06-04 17:31:56 +02006443/* ethtool helper */
6444void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
6445
Srinivas Dasari40cbfa92018-01-25 17:13:38 +02006446/**
6447 * cfg80211_external_auth_request - userspace request for authentication
6448 * @netdev: network device
6449 * @params: External authentication parameters
6450 * @gfp: allocation flags
6451 * Returns: 0 on success, < 0 on error
6452 */
6453int cfg80211_external_auth_request(struct net_device *netdev,
6454 struct cfg80211_external_auth_params *params,
6455 gfp_t gfp);
6456
Joe Perchese1db74f2010-07-26 14:39:57 -07006457/* Logging, debugging and troubleshooting/diagnostic helpers. */
6458
6459/* wiphy_printk helpers, similar to dev_printk */
6460
6461#define wiphy_printk(level, wiphy, format, args...) \
Joe Perches9c376632010-08-20 15:13:59 -07006462 dev_printk(level, &(wiphy)->dev, format, ##args)
Joe Perchese1db74f2010-07-26 14:39:57 -07006463#define wiphy_emerg(wiphy, format, args...) \
Joe Perches9c376632010-08-20 15:13:59 -07006464 dev_emerg(&(wiphy)->dev, format, ##args)
Joe Perchese1db74f2010-07-26 14:39:57 -07006465#define wiphy_alert(wiphy, format, args...) \
Joe Perches9c376632010-08-20 15:13:59 -07006466 dev_alert(&(wiphy)->dev, format, ##args)
Joe Perchese1db74f2010-07-26 14:39:57 -07006467#define wiphy_crit(wiphy, format, args...) \
Joe Perches9c376632010-08-20 15:13:59 -07006468 dev_crit(&(wiphy)->dev, format, ##args)
Joe Perchese1db74f2010-07-26 14:39:57 -07006469#define wiphy_err(wiphy, format, args...) \
Joe Perches9c376632010-08-20 15:13:59 -07006470 dev_err(&(wiphy)->dev, format, ##args)
Joe Perchese1db74f2010-07-26 14:39:57 -07006471#define wiphy_warn(wiphy, format, args...) \
Joe Perches9c376632010-08-20 15:13:59 -07006472 dev_warn(&(wiphy)->dev, format, ##args)
Joe Perchese1db74f2010-07-26 14:39:57 -07006473#define wiphy_notice(wiphy, format, args...) \
Joe Perches9c376632010-08-20 15:13:59 -07006474 dev_notice(&(wiphy)->dev, format, ##args)
Joe Perchese1db74f2010-07-26 14:39:57 -07006475#define wiphy_info(wiphy, format, args...) \
Joe Perches9c376632010-08-20 15:13:59 -07006476 dev_info(&(wiphy)->dev, format, ##args)
Joe Perches073730d2010-07-26 14:40:00 -07006477
Joe Perches9c376632010-08-20 15:13:59 -07006478#define wiphy_debug(wiphy, format, args...) \
Joe Perchese1db74f2010-07-26 14:39:57 -07006479 wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
Joe Perches9c376632010-08-20 15:13:59 -07006480
Joe Perchese1db74f2010-07-26 14:39:57 -07006481#define wiphy_dbg(wiphy, format, args...) \
Joe Perches9c376632010-08-20 15:13:59 -07006482 dev_dbg(&(wiphy)->dev, format, ##args)
Joe Perchese1db74f2010-07-26 14:39:57 -07006483
6484#if defined(VERBOSE_DEBUG)
6485#define wiphy_vdbg wiphy_dbg
6486#else
Joe Perchese1db74f2010-07-26 14:39:57 -07006487#define wiphy_vdbg(wiphy, format, args...) \
6488({ \
6489 if (0) \
6490 wiphy_printk(KERN_DEBUG, wiphy, format, ##args); \
Joe Perches9c376632010-08-20 15:13:59 -07006491 0; \
Joe Perchese1db74f2010-07-26 14:39:57 -07006492})
6493#endif
6494
6495/*
6496 * wiphy_WARN() acts like wiphy_printk(), but with the key difference
6497 * of using a WARN/WARN_ON to get the message out, including the
6498 * file/line information and a backtrace.
6499 */
6500#define wiphy_WARN(wiphy, format, args...) \
6501 WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
6502
Johannes Berg704232c2007-04-23 12:20:05 -07006503#endif /* __NET_CFG80211_H */