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