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