1 /*
2 * BSS table
3 * Copyright (c) 2009-2019, Jouni Malinen <j@w1.fi>
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9 #ifndef BSS_H
10 #define BSS_H
11
12 struct 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)
20 #define WPA_BSS_ANQP_FETCH_TRIED BIT(6)
21 #define WPA_BSS_OWE_TRANSITION BIT(7)
22
23 #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
33 struct wpa_bss_anqp_elem {
34 struct dl_list list;
35 u16 infoid;
36 bool protected_response; /* received in a protected GAS response */
37 struct wpabuf *payload;
38 };
39
40 /**
41 * struct wpa_bss_anqp - ANQP data for a BSS entry (struct wpa_bss)
42 */
43 struct wpa_bss_anqp {
44 /** Number of BSS entries referring to this ANQP data instance */
45 unsigned int users;
46 #ifdef CONFIG_INTERWORKING
47 struct wpabuf *capability_list;
48 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;
55 struct wpabuf *fils_realm_info;
56 struct dl_list anqp_elems; /* list of struct wpa_bss_anqp_elem */
57 #endif /* CONFIG_INTERWORKING */
58 #ifdef CONFIG_HS20
59 struct wpabuf *hs20_capability_list;
60 struct wpabuf *hs20_operator_friendly_name;
61 struct wpabuf *hs20_wan_metrics;
62 struct wpabuf *hs20_connection_capability;
63 struct wpabuf *hs20_operating_class;
64 struct wpabuf *hs20_osu_providers_list;
65 struct wpabuf *hs20_operator_icon_metadata;
66 struct wpabuf *hs20_osu_providers_nai_list;
67 #endif /* CONFIG_HS20 */
68 };
69
70 /**
71 * struct wpa_bss - BSS table
72 *
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 */
76 struct wpa_bss {
77 /** List entry for struct wpa_supplicant::bss */
78 struct dl_list list;
79 /** List entry for struct wpa_supplicant::bss_id */
80 struct dl_list list_id;
81 /** Unique identifier for this BSS entry */
82 unsigned int id;
83 /** Number of counts without seeing this BSS */
84 unsigned int scan_miss_count;
85 /** Index of the last scan update */
86 unsigned int last_update_idx;
87 /** Information flags about the BSS/IBSS (WPA_BSS_*) */
88 unsigned int flags;
89 /** BSSID */
90 u8 bssid[ETH_ALEN];
91 /** HESSID */
92 u8 hessid[ETH_ALEN];
93 /** SSID */
94 u8 ssid[SSID_MAX_LEN];
95 /** Length of SSID */
96 size_t ssid_len;
97 /** Frequency of the channel in MHz (e.g., 2412 = channel 1) */
98 int freq;
99 /** Beacon interval in TUs (host byte order) */
100 u16 beacon_int;
101 /** Capability information field in host byte order */
102 u16 caps;
103 /** Signal quality */
104 int qual;
105 /** Noise level */
106 int noise;
107 /** Signal level */
108 int level;
109 /** Timestamp of last Beacon/Probe Response frame */
110 u64 tsf;
111 /** Time of the last update (i.e., Beacon or Probe Response RX) */
112 struct os_reltime last_update;
113 /** Estimated throughput in kbps */
114 unsigned int est_throughput;
115 /** Signal-to-noise ratio in dB */
116 int snr;
117 /** ANQP data */
118 struct wpa_bss_anqp *anqp;
119 /** Length of the following IE field in octets (from Probe Response) */
120 size_t ie_len;
121 /** Length of the following Beacon IE field in octets */
122 size_t beacon_ie_len;
123 /* followed by ie_len octets of IEs */
124 /* followed by beacon_ie_len octets of IEs */
125 u8 ies[];
126 };
127
wpa_bss_ie_ptr(const struct wpa_bss * bss)128 static inline const u8 * wpa_bss_ie_ptr(const struct wpa_bss *bss)
129 {
130 return bss->ies;
131 }
132
133 void notify_bss_changes(struct wpa_supplicant *wpa_s, u32 changes,
134 const struct wpa_bss *bss);
135 void wpa_bss_update_start(struct wpa_supplicant *wpa_s);
136 void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
137 struct wpa_scan_res *res,
138 struct os_reltime *fetch_time);
139 void wpa_bss_remove(struct wpa_supplicant *wpa_s, struct wpa_bss *bss,
140 const char *reason);
141 void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
142 int new_scan);
143 int wpa_bss_init(struct wpa_supplicant *wpa_s);
144 void wpa_bss_deinit(struct wpa_supplicant *wpa_s);
145 void wpa_bss_flush(struct wpa_supplicant *wpa_s);
146 void wpa_bss_flush_by_age(struct wpa_supplicant *wpa_s, int age);
147 struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
148 const u8 *ssid, size_t ssid_len);
149 struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
150 const u8 *bssid);
151 struct wpa_bss * wpa_bss_get_bssid_latest(struct wpa_supplicant *wpa_s,
152 const u8 *bssid);
153 struct wpa_bss * wpa_bss_get_p2p_dev_addr(struct wpa_supplicant *wpa_s,
154 const u8 *dev_addr);
155 struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id);
156 struct wpa_bss * wpa_bss_get_id_range(struct wpa_supplicant *wpa_s,
157 unsigned int idf, unsigned int idl);
158 const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie);
159 const u8 * wpa_bss_get_ie_ext(const struct wpa_bss *bss, u8 ext);
160 const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type);
161 const u8 * wpa_bss_get_vendor_ie_beacon(const struct wpa_bss *bss,
162 u32 vendor_type);
163 struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
164 u32 vendor_type);
165 struct wpabuf * wpa_bss_get_vendor_ie_multi_beacon(const struct wpa_bss *bss,
166 u32 vendor_type);
167 int wpa_bss_get_max_rate(const struct wpa_bss *bss);
168 int wpa_bss_get_bit_rates(const struct wpa_bss *bss, u8 **rates);
169 struct wpa_bss_anqp * wpa_bss_anqp_alloc(void);
170 int wpa_bss_anqp_unshare_alloc(struct wpa_bss *bss);
171 const u8 * wpa_bss_get_fils_cache_id(const struct wpa_bss *bss);
172 int wpa_bss_ext_capab(const struct wpa_bss *bss, unsigned int capab);
173
bss_is_dmg(const struct wpa_bss * bss)174 static inline int bss_is_dmg(const struct wpa_bss *bss)
175 {
176 return bss->freq > 45000;
177 }
178
179 /**
180 * Test whether a BSS is a PBSS.
181 * This checks whether a BSS is a DMG-band PBSS. PBSS is used for P2P DMG
182 * network.
183 */
bss_is_pbss(struct wpa_bss * bss)184 static inline int bss_is_pbss(struct wpa_bss *bss)
185 {
186 return bss_is_dmg(bss) &&
187 (bss->caps & IEEE80211_CAP_DMG_MASK) == IEEE80211_CAP_DMG_PBSS;
188 }
189
wpa_bss_update_level(struct wpa_bss * bss,int new_level)190 static inline void wpa_bss_update_level(struct wpa_bss *bss, int new_level)
191 {
192 if (bss != NULL && new_level > -WPA_INVALID_NOISE && new_level < 0)
193 bss->level = new_level;
194 }
195
196 void calculate_update_time(const struct os_reltime *fetch_time,
197 unsigned int age_ms,
198 struct os_reltime *update_time);
199
200 #endif /* BSS_H */
201
