wpa_supplicant/bss.h

   1 /*
   2  * BSS table
   3  * Copyright (c) 2009-2010, 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
  22 /**
  23  * struct wpa_bss - BSS table
  24  * @list: List entry for struct wpa_supplicant::bss
  25  * @list_id: List entry for struct wpa_supplicant::bss_id
  26  * @id: Unique identifier for this BSS entry
  27  * @scan_miss_count: Number of counts without seeing this BSS
  28  * @flags: information flags about the BSS/IBSS (WPA_BSS_*)
  29  * @last_update_idx: Index of the last scan update
  30  * @bssid: BSSID
  31  * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
  32  * @beacon_int: beacon interval in TUs (host byte order)
  33  * @caps: capability information field in host byte order
  34  * @qual: signal quality
  35  * @noise: noise level
  36  * @level: signal level
  37  * @tsf: Timestamp of last Beacon/Probe Response frame
  38  * @last_update: Time of the last update (i.e., Beacon or Probe Response RX)
  39  * @ie_len: length of the following IE field in octets (from Probe Response)
  40  * @beacon_ie_len: length of the following Beacon IE field in octets
  41  *
  42  * This structure is used to store information about neighboring BSSes in
  43  * generic format. It is mainly updated based on scan results from the driver.
  44  */
  45 struct wpa_bss {
  46         struct dl_list list;
  47         struct dl_list list_id;
  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 #ifdef CONFIG_INTERWORKING
  64         struct wpabuf *anqp_venue_name;
  65         struct wpabuf *anqp_network_auth_type;
  66         struct wpabuf *anqp_roaming_consortium;
  67         struct wpabuf *anqp_ip_addr_type_availability;
  68         struct wpabuf *anqp_nai_realm;
  69         struct wpabuf *anqp_3gpp;
  70         struct wpabuf *anqp_domain_name;
  71 #endif /* CONFIG_INTERWORKING */
  72         size_t ie_len;
  73         size_t beacon_ie_len;
  74         /* followed by ie_len octets of IEs */
  75         /* followed by beacon_ie_len octets of IEs */
  76 };
  77
  78 void wpa_bss_update_start(struct wpa_supplicant *wpa_s);
  79 void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
  80                              struct wpa_scan_res *res);
  81 void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
  82                         int new_scan);
  83 int wpa_bss_init(struct wpa_supplicant *wpa_s);
  84 void wpa_bss_deinit(struct wpa_supplicant *wpa_s);
  85 void wpa_bss_flush(struct wpa_supplicant *wpa_s);
  86 void wpa_bss_flush_by_age(struct wpa_supplicant *wpa_s, int age);
  87 struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
  88                              const u8 *ssid, size_t ssid_len);
  89 struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
  90                                    const u8 *bssid);
  91 struct wpa_bss * wpa_bss_get_p2p_dev_addr(struct wpa_supplicant *wpa_s,
  92                                           const u8 *dev_addr);
  93 struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id);
  94 const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie);
  95 const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type);
  96 struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
  97                                             u32 vendor_type);
  98 int wpa_bss_get_max_rate(const struct wpa_bss *bss);
  99 int wpa_bss_get_bit_rates(const struct wpa_bss *bss, u8 **rates);
 100
 101 #endif /* BSS_H */