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 struct wpa_bss_anqp_elem {
24 struct dl_list list;
25 u16 infoid;
26 struct wpabuf *payload;
27 };
28
29 /**
30 * struct wpa_bss_anqp - ANQP data for a BSS entry (struct wpa_bss)
31 */
32 struct wpa_bss_anqp {
33 /** Number of BSS entries referring to this ANQP data instance */
34 unsigned int users;
35 #ifdef CONFIG_INTERWORKING
36 struct wpabuf *capability_list;
37 struct wpabuf *venue_name;
38 struct wpabuf *network_auth_type;
39 struct wpabuf *roaming_consortium;
40 struct wpabuf *ip_addr_type_availability;
41 struct wpabuf *nai_realm;
42 struct wpabuf *anqp_3gpp;
43 struct wpabuf *domain_name;
44 struct wpabuf *fils_realm_info;
45 struct dl_list anqp_elems; /* list of struct wpa_bss_anqp_elem */
46 #endif /* CONFIG_INTERWORKING */
47 #ifdef CONFIG_HS20
48 struct wpabuf *hs20_capability_list;
49 struct wpabuf *hs20_operator_friendly_name;
50 struct wpabuf *hs20_wan_metrics;
51 struct wpabuf *hs20_connection_capability;
52 struct wpabuf *hs20_operating_class;
53 struct wpabuf *hs20_osu_providers_list;
54 struct wpabuf *hs20_operator_icon_metadata;
55 struct wpabuf *hs20_osu_providers_nai_list;
56 #endif /* CONFIG_HS20 */
57 };
58
59 /**
60 * struct wpa_bss - BSS table
61 *
62 * This structure is used to store information about neighboring BSSes in
63 * generic format. It is mainly updated based on scan results from the driver.
64 */
65 struct wpa_bss {
66 /** List entry for struct wpa_supplicant::bss */
67 struct dl_list list;
68 /** List entry for struct wpa_supplicant::bss_id */
69 struct dl_list list_id;
70 /** Unique identifier for this BSS entry */
71 unsigned int id;
72 /** Number of counts without seeing this BSS */
73 unsigned int scan_miss_count;
74 /** Index of the last scan update */
75 unsigned int last_update_idx;
76 /** Information flags about the BSS/IBSS (WPA_BSS_*) */
77 unsigned int flags;
78 /** BSSID */
79 u8 bssid[ETH_ALEN];
80 /** HESSID */
81 u8 hessid[ETH_ALEN];
82 /** SSID */
83 u8 ssid[SSID_MAX_LEN];
84 /** Length of SSID */
85 size_t ssid_len;
86 /** Frequency of the channel in MHz (e.g., 2412 = channel 1) */
87 int freq;
88 /** Beacon interval in TUs (host byte order) */
89 u16 beacon_int;
90 /** Capability information field in host byte order */
91 u16 caps;
92 /** Signal quality */
93 int qual;
94 /** Noise level */
95 int noise;
96 /** Signal level */
97 int level;
98 /** Timestamp of last Beacon/Probe Response frame */
99 u64 tsf;
100 /** Time of the last update (i.e., Beacon or Probe Response RX) */
101 struct os_reltime last_update;
102 /** Estimated throughput in kbps */
103 unsigned int est_throughput;
104 /** Signal-to-noise ratio in dB */
105 int snr;
106 /** ANQP data */
107 struct wpa_bss_anqp *anqp;
108 /** Length of the following IE field in octets (from Probe Response) */
109 size_t ie_len;
110 /** Length of the following Beacon IE field in octets */
111 size_t beacon_ie_len;
112 /* followed by ie_len octets of IEs */
113 /* followed by beacon_ie_len octets of IEs */
114 };
115
116 void wpa_bss_update_start(struct wpa_supplicant *wpa_s);
117 void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
118 struct wpa_scan_res *res,
119 struct os_reltime *fetch_time);
120 void wpa_bss_remove(struct wpa_supplicant *wpa_s, struct wpa_bss *bss,
121 const char *reason);
122 void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
123 int new_scan);
124 int wpa_bss_init(struct wpa_supplicant *wpa_s);
125 void wpa_bss_deinit(struct wpa_supplicant *wpa_s);
126 void wpa_bss_flush(struct wpa_supplicant *wpa_s);
127 void wpa_bss_flush_by_age(struct wpa_supplicant *wpa_s, int age);
128 struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
129 const u8 *ssid, size_t ssid_len);
130 struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
131 const u8 *bssid);
132 struct wpa_bss * wpa_bss_get_bssid_latest(struct wpa_supplicant *wpa_s,
133 const u8 *bssid);
134 struct wpa_bss * wpa_bss_get_p2p_dev_addr(struct wpa_supplicant *wpa_s,
135 const u8 *dev_addr);
136 struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id);
137 struct wpa_bss * wpa_bss_get_id_range(struct wpa_supplicant *wpa_s,
138 unsigned int idf, unsigned int idl);
139 const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie);
140 const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type);
141 const u8 * wpa_bss_get_vendor_ie_beacon(const struct wpa_bss *bss,
142 u32 vendor_type);
143 struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
144 u32 vendor_type);
145 struct wpabuf * wpa_bss_get_vendor_ie_multi_beacon(const struct wpa_bss *bss,
146 u32 vendor_type);
147 int wpa_bss_get_max_rate(const struct wpa_bss *bss);
148 int wpa_bss_get_bit_rates(const struct wpa_bss *bss, u8 **rates);
149 struct wpa_bss_anqp * wpa_bss_anqp_alloc(void);
150 int wpa_bss_anqp_unshare_alloc(struct wpa_bss *bss);
151 const u8 * wpa_bss_get_fils_cache_id(struct wpa_bss *bss);
152 int wpa_bss_ext_capab(const struct wpa_bss *bss, unsigned int capab);
153
bss_is_dmg(const struct wpa_bss * bss)154 static inline int bss_is_dmg(const struct wpa_bss *bss)
155 {
156 return bss->freq > 45000;
157 }
158
159 /**
160 * Test whether a BSS is a PBSS.
161 * This checks whether a BSS is a DMG-band PBSS. PBSS is used for P2P DMG
162 * network.
163 */
bss_is_pbss(struct wpa_bss * bss)164 static inline int bss_is_pbss(struct wpa_bss *bss)
165 {
166 return bss_is_dmg(bss) &&
167 (bss->caps & IEEE80211_CAP_DMG_MASK) == IEEE80211_CAP_DMG_PBSS;
168 }
169
wpa_bss_update_level(struct wpa_bss * bss,int new_level)170 static inline void wpa_bss_update_level(struct wpa_bss *bss, int new_level)
171 {
172 if (bss != NULL && new_level < 0)
173 bss->level = new_level;
174 }
175
176 void calculate_update_time(const struct os_reltime *fetch_time,
177 unsigned int age_ms,
178 struct os_reltime *update_time);
179
180 #endif /* BSS_H */
181