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