wpa_supplicant/bss.h

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