Only expire scanned BSSes based on new scan results
[hostap-gosc2009.git] / wpa_supplicant / bss.h
blob2242222ed0f12945292487ce4fb55194e6591684
1 /*
2 * BSS table
3 * Copyright (c) 2009-2010, Jouni Malinen <j@w1.fi>
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.
9 * Alternatively, this software may be distributed under the terms of BSD
10 * license.
12 * See README and COPYING for more details.
15 #ifndef BSS_H
16 #define BSS_H
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)
25 /**
26 * struct wpa_bss - BSS table
27 * @list: List entry for struct wpa_supplicant::bss
28 * @list_id: List entry for struct wpa_supplicant::bss_id
29 * @id: Unique identifier for this BSS entry
30 * @scan_miss_count: Number of counts without seeing this BSS
31 * @flags: information flags about the BSS/IBSS (WPA_BSS_*)
32 * @last_update_idx: Index of the last scan update
33 * @bssid: BSSID
34 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
35 * @beacon_int: beacon interval in TUs (host byte order)
36 * @caps: capability information field in host byte order
37 * @qual: signal quality
38 * @noise: noise level
39 * @level: signal level
40 * @tsf: Timestamp of last Beacon/Probe Response frame
41 * @last_update: Time of the last update (i.e., Beacon or Probe Response RX)
42 * @ie_len: length of the following IE field in octets
44 * This structure is used to store information about neighboring BSSes in
45 * generic format. It is mainly updated based on scan results from the driver.
47 struct wpa_bss {
48 struct dl_list list;
49 struct dl_list list_id;
50 unsigned int id;
51 unsigned int scan_miss_count;
52 unsigned int last_update_idx;
53 unsigned int flags;
54 u8 bssid[ETH_ALEN];
55 u8 ssid[32];
56 size_t ssid_len;
57 int freq;
58 u16 beacon_int;
59 u16 caps;
60 int qual;
61 int noise;
62 int level;
63 u64 tsf;
64 struct os_time last_update;
65 size_t ie_len;
66 /* followed by ie_len octets of IEs */
69 void wpa_bss_update_start(struct wpa_supplicant *wpa_s);
70 void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
71 struct wpa_scan_res *res);
72 void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
73 int new_scan);
74 int wpa_bss_init(struct wpa_supplicant *wpa_s);
75 void wpa_bss_deinit(struct wpa_supplicant *wpa_s);
76 struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
77 const u8 *ssid, size_t ssid_len);
78 struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
79 const u8 *bssid);
80 struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id);
81 const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie);
82 const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type);
83 struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
84 u32 vendor_type);
85 int wpa_bss_get_max_rate(const struct wpa_bss *bss);
87 #endif /* BSS_H */