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