contrib/wpa/wpa_supplicant/bss.h

   1 /*
   2  * BSS table
   3  * Copyright (c) 2009-2019, 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_elem {
  23         struct dl_list list;
  24         u16 infoid;
  25         struct wpabuf *payload;
  26 };
  27
  28 /**
  29  * struct wpa_bss_anqp - ANQP data for a BSS entry (struct wpa_bss)
  30  */
  31 struct wpa_bss_anqp {
  32         /** Number of BSS entries referring to this ANQP data instance */
  33         unsigned int users;
  34 #ifdef CONFIG_INTERWORKING
  35         struct wpabuf *capability_list;
  36         struct wpabuf *venue_name;
  37         struct wpabuf *network_auth_type;
  38         struct wpabuf *roaming_consortium;
  39         struct wpabuf *ip_addr_type_availability;
  40         struct wpabuf *nai_realm;
  41         struct wpabuf *anqp_3gpp;
  42         struct wpabuf *domain_name;
  43         struct wpabuf *fils_realm_info;
  44         struct dl_list anqp_elems; /* list of struct wpa_bss_anqp_elem */
  45 #endif /* CONFIG_INTERWORKING */
  46 #ifdef CONFIG_HS20
  47         struct wpabuf *hs20_capability_list;
  48         struct wpabuf *hs20_operator_friendly_name;
  49         struct wpabuf *hs20_wan_metrics;
  50         struct wpabuf *hs20_connection_capability;
  51         struct wpabuf *hs20_operating_class;
  52         struct wpabuf *hs20_osu_providers_list;
  53         struct wpabuf *hs20_operator_icon_metadata;
  54         struct wpabuf *hs20_osu_providers_nai_list;
  55 #endif /* CONFIG_HS20 */
  56 };
  57
  58 /**
  59  * struct wpa_bss - BSS table
  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         /** List entry for struct wpa_supplicant::bss */
  66         struct dl_list list;
  67         /** List entry for struct wpa_supplicant::bss_id */
  68         struct dl_list list_id;
  69         /** Unique identifier for this BSS entry */
  70         unsigned int id;
  71         /** Number of counts without seeing this BSS */
  72         unsigned int scan_miss_count;
  73         /** Index of the last scan update */
  74         unsigned int last_update_idx;
  75         /** Information flags about the BSS/IBSS (WPA_BSS_*) */
  76         unsigned int flags;
  77         /** BSSID */
  78         u8 bssid[ETH_ALEN];
  79         /** HESSID */
  80         u8 hessid[ETH_ALEN];
  81         /** SSID */
  82         u8 ssid[SSID_MAX_LEN];
  83         /** Length of SSID */
  84         size_t ssid_len;
  85         /** Frequency of the channel in MHz (e.g., 2412 = channel 1) */
  86         int freq;
  87         /** Beacon interval in TUs (host byte order) */
  88         u16 beacon_int;
  89         /** Capability information field in host byte order */
  90         u16 caps;
  91         /** Signal quality */
  92         int qual;
  93         /** Noise level */
  94         int noise;
  95         /** Signal level */
  96         int level;
  97         /** Timestamp of last Beacon/Probe Response frame */
  98         u64 tsf;
  99         /** Time of the last update (i.e., Beacon or Probe Response RX) */
 100         struct os_reltime last_update;
 101         /** Estimated throughput in kbps */
 102         unsigned int est_throughput;
 103         /** Signal-to-noise ratio in dB */
 104         int snr;
 105         /** ANQP data */
 106         struct wpa_bss_anqp *anqp;
 107         /** Length of the following IE field in octets (from Probe Response) */
 108         size_t ie_len;
 109         /** Length of the following Beacon IE field in octets */
 110         size_t beacon_ie_len;
 111         /* followed by ie_len octets of IEs */
 112         /* followed by beacon_ie_len octets of IEs */
 113 };
 114
 115 void wpa_bss_update_start(struct wpa_supplicant *wpa_s);
 116 void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
 117                              struct wpa_scan_res *res,
 118                              struct os_reltime *fetch_time);
 119 void wpa_bss_remove(struct wpa_supplicant *wpa_s, struct wpa_bss *bss,
 120                     const char *reason);
 121 void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
 122                         int new_scan);
 123 int wpa_bss_init(struct wpa_supplicant *wpa_s);
 124 void wpa_bss_deinit(struct wpa_supplicant *wpa_s);
 125 void wpa_bss_flush(struct wpa_supplicant *wpa_s);
 126 void wpa_bss_flush_by_age(struct wpa_supplicant *wpa_s, int age);
 127 struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
 128                              const u8 *ssid, size_t ssid_len);
 129 struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
 130                                    const u8 *bssid);
 131 struct wpa_bss * wpa_bss_get_bssid_latest(struct wpa_supplicant *wpa_s,
 132                                           const u8 *bssid);
 133 struct wpa_bss * wpa_bss_get_p2p_dev_addr(struct wpa_supplicant *wpa_s,
 134                                           const u8 *dev_addr);
 135 struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id);
 136 struct wpa_bss * wpa_bss_get_id_range(struct wpa_supplicant *wpa_s,
 137                                       unsigned int idf, unsigned int idl);
 138 const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie);
 139 const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type);
 140 const u8 * wpa_bss_get_vendor_ie_beacon(const struct wpa_bss *bss,
 141                                         u32 vendor_type);
 142 struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
 143                                             u32 vendor_type);
 144 struct wpabuf * wpa_bss_get_vendor_ie_multi_beacon(const struct wpa_bss *bss,
 145                                                    u32 vendor_type);
 146 int wpa_bss_get_max_rate(const struct wpa_bss *bss);
 147 int wpa_bss_get_bit_rates(const struct wpa_bss *bss, u8 **rates);
 148 struct wpa_bss_anqp * wpa_bss_anqp_alloc(void);
 149 int wpa_bss_anqp_unshare_alloc(struct wpa_bss *bss);
 150 const u8 * wpa_bss_get_fils_cache_id(struct wpa_bss *bss);
 151 int wpa_bss_ext_capab(const struct wpa_bss *bss, unsigned int capab);
 152
 153 static inline int bss_is_dmg(const struct wpa_bss *bss)
 154 {
 155         return bss->freq > 45000;
 156 }
 157
 158 /**
 159  * Test whether a BSS is a PBSS.
 160  * This checks whether a BSS is a DMG-band PBSS. PBSS is used for P2P DMG
 161  * network.
 162  */
 163 static inline int bss_is_pbss(struct wpa_bss *bss)
 164 {
 165         return bss_is_dmg(bss) &&
 166                 (bss->caps & IEEE80211_CAP_DMG_MASK) == IEEE80211_CAP_DMG_PBSS;
 167 }
 168
 169 static inline void wpa_bss_update_level(struct wpa_bss *bss, int new_level)
 170 {
 171         if (bss != NULL && new_level < 0)
 172                 bss->level = new_level;
 173 }
 174
 175 void calculate_update_time(const struct os_reltime *fetch_time,
 176                            unsigned int age_ms,
 177                            struct os_reltime *update_time);
 178
 179 #endif /* BSS_H */