blob: 31688fa541246d9a850f8482e421586344516063 [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * BSS table
Hai Shalom74f70d42019-02-11 14:42:39 -08003 * Copyright (c) 2009-2019, Jouni Malinen <j@w1.fi>
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004 *
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07007 */
8
9#ifndef BSS_H
10#define BSS_H
11
12struct wpa_scan_res;
13
14#define WPA_BSS_QUAL_INVALID BIT(0)
15#define WPA_BSS_NOISE_INVALID BIT(1)
16#define WPA_BSS_LEVEL_INVALID BIT(2)
17#define WPA_BSS_LEVEL_DBM BIT(3)
18#define WPA_BSS_AUTHENTICATED BIT(4)
19#define WPA_BSS_ASSOCIATED BIT(5)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -080020#define WPA_BSS_ANQP_FETCH_TRIED BIT(6)
Hai Shalomfdcde762020-04-02 11:19:20 -070021#define WPA_BSS_OWE_TRANSITION BIT(7)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070022
Hai Shalom60840252021-02-19 19:02:11 -080023#define WPA_BSS_FREQ_CHANGED_FLAG BIT(0)
24#define WPA_BSS_SIGNAL_CHANGED_FLAG BIT(1)
25#define WPA_BSS_PRIVACY_CHANGED_FLAG BIT(2)
26#define WPA_BSS_MODE_CHANGED_FLAG BIT(3)
27#define WPA_BSS_WPAIE_CHANGED_FLAG BIT(4)
28#define WPA_BSS_RSNIE_CHANGED_FLAG BIT(5)
29#define WPA_BSS_WPS_CHANGED_FLAG BIT(6)
30#define WPA_BSS_RATES_CHANGED_FLAG BIT(7)
31#define WPA_BSS_IES_CHANGED_FLAG BIT(8)
32
Dmitry Shmidtd80a4012015-11-05 16:35:40 -080033struct wpa_bss_anqp_elem {
34 struct dl_list list;
35 u16 infoid;
Hai Shalom60840252021-02-19 19:02:11 -080036 bool protected_response; /* received in a protected GAS response */
Dmitry Shmidtd80a4012015-11-05 16:35:40 -080037 struct wpabuf *payload;
38};
39
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080040/**
41 * struct wpa_bss_anqp - ANQP data for a BSS entry (struct wpa_bss)
42 */
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -070043struct wpa_bss_anqp {
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080044 /** Number of BSS entries referring to this ANQP data instance */
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -070045 unsigned int users;
46#ifdef CONFIG_INTERWORKING
Dmitry Shmidt7f656022015-02-25 14:36:37 -080047 struct wpabuf *capability_list;
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -070048 struct wpabuf *venue_name;
49 struct wpabuf *network_auth_type;
50 struct wpabuf *roaming_consortium;
51 struct wpabuf *ip_addr_type_availability;
52 struct wpabuf *nai_realm;
53 struct wpabuf *anqp_3gpp;
54 struct wpabuf *domain_name;
Dmitry Shmidt29333592017-01-09 12:27:11 -080055 struct wpabuf *fils_realm_info;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -080056 struct dl_list anqp_elems; /* list of struct wpa_bss_anqp_elem */
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -070057#endif /* CONFIG_INTERWORKING */
58#ifdef CONFIG_HS20
Dmitry Shmidt7f656022015-02-25 14:36:37 -080059 struct wpabuf *hs20_capability_list;
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -070060 struct wpabuf *hs20_operator_friendly_name;
61 struct wpabuf *hs20_wan_metrics;
62 struct wpabuf *hs20_connection_capability;
63 struct wpabuf *hs20_operating_class;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -080064 struct wpabuf *hs20_osu_providers_list;
Roshan Pius3a1667e2018-07-03 15:17:14 -070065 struct wpabuf *hs20_operator_icon_metadata;
Hai Shalom39ba6fc2019-01-22 12:40:38 -080066 struct wpabuf *hs20_osu_providers_nai_list;
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -070067#endif /* CONFIG_HS20 */
68};
69
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070070/**
71 * struct wpa_bss - BSS table
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070072 *
73 * This structure is used to store information about neighboring BSSes in
74 * generic format. It is mainly updated based on scan results from the driver.
75 */
76struct wpa_bss {
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080077 /** List entry for struct wpa_supplicant::bss */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070078 struct dl_list list;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080079 /** List entry for struct wpa_supplicant::bss_id */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070080 struct dl_list list_id;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080081 /** Unique identifier for this BSS entry */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070082 unsigned int id;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080083 /** Number of counts without seeing this BSS */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070084 unsigned int scan_miss_count;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080085 /** Index of the last scan update */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070086 unsigned int last_update_idx;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080087 /** Information flags about the BSS/IBSS (WPA_BSS_*) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070088 unsigned int flags;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080089 /** BSSID */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070090 u8 bssid[ETH_ALEN];
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080091 /** HESSID */
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -070092 u8 hessid[ETH_ALEN];
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080093 /** SSID */
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -070094 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080095 /** Length of SSID */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070096 size_t ssid_len;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080097 /** Frequency of the channel in MHz (e.g., 2412 = channel 1) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070098 int freq;
Sunil Ravi2a14cf12023-11-21 00:54:38 +000099 /** The max channel width supported by both the AP and the STA */
100 enum chan_width max_cw;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800101 /** Beacon interval in TUs (host byte order) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700102 u16 beacon_int;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800103 /** Capability information field in host byte order */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700104 u16 caps;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800105 /** Signal quality */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700106 int qual;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800107 /** Noise level */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700108 int noise;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800109 /** Signal level */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700110 int level;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800111 /** Timestamp of last Beacon/Probe Response frame */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700112 u64 tsf;
Sunil Ravia04bd252022-05-02 22:54:18 -0700113 /** Whether the Beacon frame data is known to be newer */
114 bool beacon_newer;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800115 /** Time of the last update (i.e., Beacon or Probe Response RX) */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800116 struct os_reltime last_update;
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800117 /** Estimated throughput in kbps */
118 unsigned int est_throughput;
119 /** Signal-to-noise ratio in dB */
120 int snr;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800121 /** ANQP data */
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700122 struct wpa_bss_anqp *anqp;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800123 /** Length of the following IE field in octets (from Probe Response) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700124 size_t ie_len;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800125 /** Length of the following Beacon IE field in octets */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700126 size_t beacon_ie_len;
Sunil Ravi89eba102022-09-13 21:04:37 -0700127 /** MLD address of the AP */
128 u8 mld_addr[ETH_ALEN];
Sunil Ravi99c035e2024-07-12 01:42:03 +0000129 /** Link ID of this affiliated AP of the AP MLD */
130 u8 mld_link_id;
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000131
132 /** An array of MLD links */
Sunil Ravi99c035e2024-07-12 01:42:03 +0000133 u16 valid_links;
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000134 struct mld_link {
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000135 u8 bssid[ETH_ALEN];
136 int freq;
Sunil Ravib0ac25f2024-07-12 01:42:03 +0000137
138 /* Whether the link is valid but currently disabled */
139 bool disabled;
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000140 } mld_links[MAX_NUM_MLD_LINKS];
141
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700142 /* followed by ie_len octets of IEs */
143 /* followed by beacon_ie_len octets of IEs */
Hai Shalom60840252021-02-19 19:02:11 -0800144 u8 ies[];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700145};
146
Hai Shalom60840252021-02-19 19:02:11 -0800147static inline const u8 * wpa_bss_ie_ptr(const struct wpa_bss *bss)
148{
149 return bss->ies;
150}
151
152void notify_bss_changes(struct wpa_supplicant *wpa_s, u32 changes,
153 const struct wpa_bss *bss);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700154void wpa_bss_update_start(struct wpa_supplicant *wpa_s);
155void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800156 struct wpa_scan_res *res,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800157 struct os_reltime *fetch_time);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800158void wpa_bss_remove(struct wpa_supplicant *wpa_s, struct wpa_bss *bss,
159 const char *reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700160void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
161 int new_scan);
162int wpa_bss_init(struct wpa_supplicant *wpa_s);
163void wpa_bss_deinit(struct wpa_supplicant *wpa_s);
164void wpa_bss_flush(struct wpa_supplicant *wpa_s);
165void wpa_bss_flush_by_age(struct wpa_supplicant *wpa_s, int age);
166struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
167 const u8 *ssid, size_t ssid_len);
Sunil Ravic0f5d412024-09-11 22:12:49 +0000168struct wpa_bss * wpa_bss_get_connection(struct wpa_supplicant *wpa_s,
169 const u8 *bssid,
170 const u8 *ssid, size_t ssid_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700171struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
172 const u8 *bssid);
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700173struct wpa_bss * wpa_bss_get_bssid_latest(struct wpa_supplicant *wpa_s,
174 const u8 *bssid);
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800175struct wpa_bss * wpa_bss_get_p2p_dev_addr(struct wpa_supplicant *wpa_s,
176 const u8 *dev_addr);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700177struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id);
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800178struct wpa_bss * wpa_bss_get_id_range(struct wpa_supplicant *wpa_s,
179 unsigned int idf, unsigned int idl);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700180const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie);
Sunil Ravi7f769292024-07-23 22:21:32 +0000181const u8 * wpa_bss_get_ie_beacon(const struct wpa_bss *bss, u8 ie);
Hai Shalom60840252021-02-19 19:02:11 -0800182const u8 * wpa_bss_get_ie_ext(const struct wpa_bss *bss, u8 ext);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700183const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type);
Dmitry Shmidt96571392013-10-14 12:54:46 -0700184const u8 * wpa_bss_get_vendor_ie_beacon(const struct wpa_bss *bss,
185 u32 vendor_type);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700186struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
187 u32 vendor_type);
Dmitry Shmidt9bce59c2012-09-11 15:06:38 -0700188struct wpabuf * wpa_bss_get_vendor_ie_multi_beacon(const struct wpa_bss *bss,
189 u32 vendor_type);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700190int wpa_bss_get_max_rate(const struct wpa_bss *bss);
191int wpa_bss_get_bit_rates(const struct wpa_bss *bss, u8 **rates);
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700192struct wpa_bss_anqp * wpa_bss_anqp_alloc(void);
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800193int wpa_bss_anqp_unshare_alloc(struct wpa_bss *bss);
Hai Shalom60840252021-02-19 19:02:11 -0800194const u8 * wpa_bss_get_fils_cache_id(const struct wpa_bss *bss);
Hai Shalom74f70d42019-02-11 14:42:39 -0800195int wpa_bss_ext_capab(const struct wpa_bss *bss, unsigned int capab);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700196
Dmitry Shmidt76cd2cc2014-05-27 12:56:04 -0700197static inline int bss_is_dmg(const struct wpa_bss *bss)
198{
199 return bss->freq > 45000;
200}
201
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800202/**
203 * Test whether a BSS is a PBSS.
204 * This checks whether a BSS is a DMG-band PBSS. PBSS is used for P2P DMG
205 * network.
206 */
207static inline int bss_is_pbss(struct wpa_bss *bss)
208{
209 return bss_is_dmg(bss) &&
210 (bss->caps & IEEE80211_CAP_DMG_MASK) == IEEE80211_CAP_DMG_PBSS;
211}
212
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800213static inline void wpa_bss_update_level(struct wpa_bss *bss, int new_level)
214{
Hai Shalom60840252021-02-19 19:02:11 -0800215 if (bss != NULL && new_level > -WPA_INVALID_NOISE && new_level < 0)
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800216 bss->level = new_level;
217}
218
Dmitry Shmidt29333592017-01-09 12:27:11 -0800219void calculate_update_time(const struct os_reltime *fetch_time,
220 unsigned int age_ms,
221 struct os_reltime *update_time);
222
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000223int wpa_bss_parse_basic_ml_element(struct wpa_supplicant *wpa_s,
224 struct wpa_bss *bss,
225 u8 *ap_mld_addr,
Sunil Ravib0ac25f2024-07-12 01:42:03 +0000226 u16 *missing_links,
227 struct wpa_ssid *ssid,
228 u8 *ap_mld_id);
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000229u16 wpa_bss_parse_reconf_ml_element(struct wpa_supplicant *wpa_s,
230 struct wpa_bss *bss);
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000231
Sunil Ravi7f769292024-07-23 22:21:32 +0000232const u8 * wpa_bss_get_rsne(struct wpa_supplicant *wpa_s,
233 const struct wpa_bss *bss, struct wpa_ssid *ssid,
234 bool mlo);
235const u8 * wpa_bss_get_rsnxe(struct wpa_supplicant *wpa_s,
236 const struct wpa_bss *bss, struct wpa_ssid *ssid,
237 bool mlo);
238
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700239#endif /* BSS_H */