Add BSS table to track scan results without dropping information
[libeap.git] / wpa_supplicant / bss.h
1 /*
2  * BSS table
3  * Copyright (c) 2009, Jouni Malinen <j@w1.fi>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation.
8  *
9  * Alternatively, this software may be distributed under the terms of BSD
10  * license.
11  *
12  * See README and COPYING for more details.
13  */
14
15 #ifndef BSS_H
16 #define BSS_H
17
18 #define WPA_BSS_QUAL_INVALID            BIT(0)
19 #define WPA_BSS_NOISE_INVALID           BIT(1)
20 #define WPA_BSS_LEVEL_INVALID           BIT(2)
21 #define WPA_BSS_LEVEL_DBM               BIT(3)
22 #define WPA_BSS_AUTHENTICATED           BIT(4)
23 #define WPA_BSS_ASSOCIATED              BIT(5)
24
25 /**
26  * struct wpa_bss - BSS table
27  * @list: List entry for struct wpa_supplicant::bss
28  * @id: Unique identifier for this BSS entry
29  * @scan_miss_count: Number of counts without seeing this BSS
30  * @flags: information flags about the BSS/IBSS (WPA_BSS_*)
31  * @last_update_idx: Index of the last scan update
32  * @bssid: BSSID
33  * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
34  * @beacon_int: beacon interval in TUs (host byte order)
35  * @caps: capability information field in host byte order
36  * @qual: signal quality
37  * @noise: noise level
38  * @level: signal level
39  * @tsf: Timestamp of last Beacon/Probe Response frame
40  * @last_update: Time of the last update (i.e., Beacon or Probe Response RX) 
41  * @ie_len: length of the following IE field in octets
42  *
43  * This structure is used to store information about neighboring BSSes in
44  * generic format. It is mainly updated based on scan results from the driver.
45  */
46 struct wpa_bss {
47         struct dl_list list;
48         unsigned int id;
49         unsigned int scan_miss_count;
50         unsigned int last_update_idx;
51         unsigned int flags;
52         u8 bssid[ETH_ALEN];
53         u8 ssid[32];
54         size_t ssid_len;
55         int freq;
56         u16 beacon_int;
57         u16 caps;
58         int qual;
59         int noise;
60         int level;
61         u64 tsf;
62         struct os_time last_update;
63         size_t ie_len;
64         /* followed by ie_len octets of IEs */
65 };
66
67 void wpa_bss_update_start(struct wpa_supplicant *wpa_s);
68 void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
69                              struct wpa_scan_res *res);
70 void wpa_bss_update_end(struct wpa_supplicant *wpa_s);
71 int wpa_bss_init(struct wpa_supplicant *wpa_s);
72 void wpa_bss_deinit(struct wpa_supplicant *wpa_s);
73
74 #endif /* BSS_H */