X-Git-Url: http://git.osdn.net/view?a=blobdiff_plain;f=include%2Fhardware_legacy%2Fgscan.h;h=3d7d5dab7b168c6d82c659175a1daee5c96730fb;hb=28e08ed5cf06ac99ccd4e0213664e5c33bdaf099;hp=be783df46b6a1134fc3f7cbbcbeef018597cbc2b;hpb=439a4dddbcc157ce44e71c11771738d00022ebd4;p=android-x86%2Fhardware-libhardware_legacy.git diff --git a/include/hardware_legacy/gscan.h b/include/hardware_legacy/gscan.h index be783df..3d7d5da 100644 --- a/include/hardware_legacy/gscan.h +++ b/include/hardware_legacy/gscan.h @@ -20,7 +20,9 @@ const unsigned MAX_CHANNELS = 16; const unsigned MAX_BUCKETS = 16; const unsigned MAX_HOTLIST_APS = 128; const unsigned MAX_SIGNIFICANT_CHANGE_APS = 64; -const unsigned MAX_PNO_SSID = 128; +const unsigned MAX_PNO_SSID = 64; +const unsigned MAX_HOTLIST_SSID = 8; +const unsigned MAX_BLACKLIST_BSSID = 16; wifi_error wifi_get_valid_channels(wifi_interface_handle handle, int band, int max_channels, wifi_channel *channels, int *num_channels); @@ -32,10 +34,16 @@ typedef struct { int max_rssi_sample_size; // number of RSSI samples used for averaging RSSI int max_scan_reporting_threshold; // max possible report_threshold as described // in wifi_scan_cmd_params - int max_hotlist_aps; // maximum number of entries for hotlist APs + int max_hotlist_bssids; // maximum number of entries for hotlist BSSIDs + int max_hotlist_ssids; // maximum number of entries for hotlist SSIDs int max_significant_wifi_change_aps; // maximum number of entries for // significant wifi change APs int max_bssid_history_entries; // number of BSSID/RSSI entries that device can hold + int max_number_epno_networks; // max number of epno entries + int max_number_epno_networks_by_ssid; // max number of epno entries if ssid is specified, + // that is, epno entries for which an exact match is + // required, or entries corresponding to hidden ssids + int max_number_of_white_listed_ssid; // max number of white listed SSIDs, M target is 2 to 4 } wifi_gscan_capabilities; wifi_error wifi_get_gscan_capabilities(wifi_interface_handle handle, @@ -171,7 +179,7 @@ typedef struct { typedef struct { int lost_ap_sample_size; - int num_ap; // number of hotlist APs + int num_bssid; // number of hotlist APs ap_threshold_param ap[MAX_HOTLIST_APS]; // hotlist APs } wifi_bssid_hotlist_params; @@ -182,6 +190,47 @@ wifi_error wifi_set_bssid_hotlist(wifi_request_id id, wifi_interface_handle ifac /* Clear the BSSID Hotlist */ wifi_error wifi_reset_bssid_hotlist(wifi_request_id id, wifi_interface_handle iface); +/* SSID Hotlist */ +typedef struct { + void (*on_hotlist_ssid_found)(wifi_request_id id, + unsigned num_results, wifi_scan_result *results); + void (*on_hotlist_ssid_lost)(wifi_request_id id, + unsigned num_results, wifi_scan_result *results); +} wifi_hotlist_ssid_handler; + +typedef struct { + char ssid[32+1]; // SSID + wifi_band band; // band for this set of threshold params + wifi_rssi low; // low threshold + wifi_rssi high; // high threshold +} ssid_threshold_param; + +typedef struct { + int lost_ssid_sample_size; + int num_ssid; // number of hotlist SSIDs + ssid_threshold_param ssid[MAX_HOTLIST_SSID]; // hotlist SSIDs +} wifi_ssid_hotlist_params; + + +/* Set the SSID Hotlist */ +wifi_error wifi_set_ssid_hotlist(wifi_request_id id, wifi_interface_handle iface, + wifi_ssid_hotlist_params params, wifi_hotlist_ssid_handler handler); + +/* Clear the SSID Hotlist */ +wifi_error wifi_reset_ssid_hotlist(wifi_request_id id, wifi_interface_handle iface); + + +/* BSSID blacklist */ +typedef struct { + int num_bssid; // number of blacklisted BSSIDs + mac_addr bssids[MAX_BLACKLIST_BSSID]; // blacklisted BSSIDs +} wifi_bssid_params; + +/* Set the BSSID blacklist */ +wifi_error wifi_set_bssid_blacklist(wifi_request_id id, wifi_interface_handle iface, + wifi_bssid_params params); + + /* Significant wifi change */ typedef struct { mac_addr bssid; // BSSID @@ -204,7 +253,7 @@ typedef struct { int rssi_sample_size; // number of samples for averaging RSSI int lost_ap_sample_size; // number of samples to confirm AP loss int min_breaching; // number of APs breaching threshold - int num_ap; // max 64 + int num_bssid; // max 64 ap_threshold_param ap[MAX_SIGNIFICANT_CHANGE_APS]; } wifi_significant_change_params; @@ -218,30 +267,186 @@ wifi_error wifi_reset_significant_change_handler(wifi_request_id id, wifi_interf /* Random MAC OUI for PNO */ wifi_error wifi_set_scanning_mac_oui(wifi_interface_handle handle, oui scan_oui); - -#define WIFI_PNO_FLAG_DIRECTED_SCAN = 1 // whether directed scan needs to be performed (for hidden SSIDs) -#define WIFI_PNO_FLAG_HASH_PROVIDED = 2 // whether a crc32 hash of the ssid is provided instead of the ssid +// Whether directed scan needs to be performed (for hidden SSIDs) +#define WIFI_PNO_FLAG_DIRECTED_SCAN = 1 +// Whether PNO event shall be triggered if the network is found on A band +#define WIFI_PNO_FLAG_A_BAND = 2 +// Whether PNO event shall be triggered if the network is found on G band +#define WIFI_PNO_FLAG_G_BAND = 4 +// Whether strict matching is required (i.e. firmware shall not match on the entire SSID) +#define WIFI_PNO_FLAG_STRICT_MATCH = 8 // Code for matching the beacon AUTH IE - additional codes TBD #define WIFI_PNO_AUTH_CODE_OPEN 1 // open #define WIFI_PNO_AUTH_CODE_PSK 2 // WPA_PSK or WPA2PSK #define WIFI_PNO_AUTH_CODE_EAPOL 4 // any EAPOL +// Enhanced PNO: +// Enhanced PNO feature is expected to be enabled all of the time (e.g. screen lit) and may thus +// requires firmware to store a large number of networks, covering the whole list of known network. +// Therefore, it is acceptable for firmware to store a crc24, crc32 or other short hash of the SSID, +// such that a low but non-zero probability of collision exist. With that scheme it should be +// possible for firmware to keep an entry as small as 4 bytes for each pno network. +// For instance, a firmware pn0 entry can be implemented in the form of: +// PNO ENTRY = crc24(3 bytes) | RSSI_THRESHOLD>>3 (5 bits) | auth flags(3 bits) +// +// A PNO network shall be reported once, that is, once a network is reported by firmware +// its entry shall be marked as "done" until framework calls wifi_set_epno_list again. +// Calling wifi_set_epno_list shall reset the "done" status of pno networks in firmware. typedef struct { - char ssid[32]; - char rssi_threshold; // threshold for considering this SSID as found - char flags; - int crc32; // crc32 of the SSID, this allows for memory size optimization - // i.e. not passing the whole SSID - // in firmware and instead storing a shorter string - char auth_bit_field; // auth bitfield for matching WPA IE -} wifi_pno_network; + char ssid[32+1]; + char rssi_threshold; // threshold for considering this SSID as found, required granularity for + // this threshold is 4dBm to 8dBm + char flags; // WIFI_PNO_FLAG_XXX + char auth_bit_field; // auth bit field for matching WPA IE +} wifi_epno_network; /* PNO list */ typedef struct { - int num_ssid; // number of SSIDs - char wifi_pno_network[MAX_PNO_SSID]; // SSIDs -} wifi_pno_params; + int num_networks; // number of SSIDs + wifi_epno_network networks[]; // PNO networks +} wifi_epno_params; + +typedef struct { + // on results + void (*on_network_found)(wifi_request_id id, + unsigned num_results, wifi_scan_result *results); +} wifi_epno_handler; + + +/* Set the PNO list */ +wifi_error wifi_set_epno_list(wifi_request_id id, wifi_interface_handle iface, + int num_networks, wifi_epno_network *networks, wifi_epno_handler handler); + + +/* SSID white list */ +/* Note that this feature requires firmware to be able to indicate to kernel sme and wpa_supplicant + * that the SSID of the network has changed + * and thus requires further changed in cfg80211 stack, for instance, + * the below function would change: + + void __cfg80211_roamed(struct wireless_dev *wdev, + struct cfg80211_bss *bss, + const u8 *req_ie, size_t req_ie_len, + const u8 *resp_ie, size_t resp_ie_len) + * when firmware roam to a new SSID the corresponding link layer stats info need to be updated: + struct wifi_interface_link_layer_info; + */ +typedef struct { + char ssid[32+1]; // null terminated +} wifi_ssid; + +wifi_error wifi_set_ssid_white_list(wifi_request_id id, wifi_interface_handle iface, + int num_networks, wifi_ssid *ssids); + +/* Set G-SCAN roam parameters */ +/** + * Firmware roaming is implemented with two modes: + * 1- "Alert" mode roaming, (Note: alert roaming is the pre-L roaming, whereas firmware is + * "urgently" hunting for another BSSID because the RSSI is low, or because many successive + * beacons have been lost or other bad link conditions). + * 2- "Lazy" mode, where firmware is hunting for a better BSSID or white listed SSID even though + * the RSSI of the link is good. + * Lazy mode is configured thru G-scan, that is, the results of G-scans are compared to the + * current RSSI and fed thru the roaming engine. + * Lazy scan will be enabled (and or throttled down by reducing the number of G-scans) by + * framework only in certain conditions, such as: + * - no real time (VO/VI) traffic at the interface + * - low packet rate for BE/BK packets a the interface + * - system conditions (screen lit/dark) etc... + * + * For consistency, the roam parameters will always be configured by framework such that: + * + * condition 1- A_band_boost_threshold >= (alert_roam_rssi_trigger + 10) + * This condition ensures that Lazy roam doesn't cause the device to roam to a 5GHz BSSID whose RSSI + * is lower than the alert threshold, which would consequently trigger a roam to a low RSSI BSSID, + * hence triggering alert mode roaming. + * In other words, in alert mode, the A_band parameters may safely be ignored by WiFi chipset. + * + * condition 2- A_band_boost_threshold > A_band_penalty_factor + * + */ + +/** + * Example: + * A_band_boost_threshold = -65 + * A_band_penalty_threshold = -75 + * A_band_boost_factor = 4 + * A_band_penalty_factor = 2 + * A_band_max_boost = 50 + * + * a 5GHz RSSI value is transformed as below: + * -20 -> -20+ 50 = 30 + * -60 -> -60 + 4 * (-60 - A_band_boost_threshold) = -60 + 16 = -44 + * -70 -> -70 + * -80 -> -80 - 2 * (A_band_penalty_threshold - (-80)) = -80 - 10 = -90 + */ + +typedef struct { + // Lazy roam parameters + // A_band_XX parameters are applied to 5GHz BSSIDs when comparing with a 2.4GHz BSSID + // they may not be applied when comparing two 5GHz BSSIDs + int A_band_boost_threshold; // RSSI threshold above which 5GHz RSSI is favored + int A_band_penalty_threshold; // RSSI threshold below which 5GHz RSSI is penalized + int A_band_boost_factor; // factor by which 5GHz RSSI is boosted + // boost=RSSI_measured-5GHz_boost_threshold)*5GHz_boost_factor + int A_band_penalty_factor; // factor by which 5GHz RSSI is penalized + // penalty=(5GHz_penalty_factor-RSSI_measured)*5GHz_penalty_factor + int A_band_max_boost; // maximum boost that can be applied to a 5GHz RSSI + + // Hysteresis: ensuring the currently associated BSSID is favored + // so as to prevent ping-pong situations + int lazy_roam_hysteresis; // boost applied to current BSSID + + // Alert mode enable, i.e. configuring when firmware enters alert mode + int alert_roam_rssi_trigger; // RSSI below which "Alert" roam is enabled +} wifi_roam_params; + +wifi_error wifi_set_gscan_roam_params(wifi_request_id id, wifi_interface_handle iface, + wifi_roam_params * params); + +/** + * Enable/Disable "Lazy" roam + */ +wifi_error wifi_enable_lazy_roam(wifi_request_id id, wifi_interface_handle iface, int enable); + +/** + * Per BSSID preference + */ +typedef struct { + mac_addr bssid; + int rssi_modifier; // modifier applied to the RSSI of the BSSID for the purpose of comparing + // it with other roam candidate +} wifi_bssid_preference; + +wifi_error wifi_set_bssid_preference(wifi_request_id id, wifi_interface_handle iface, + int num_bssid, wifi_bssid_preference *prefs); + +typedef struct { + int id; // identifier of this network block, report this in event + char realm[256]; // null terminated UTF8 encoded realm, 0 if unspecified + int64_t roamingConsortiumIds[16]; // roaming consortium ids to match, 0s if unspecified + byte plmn[3]; // mcc/mnc combination as per rules, 0s if unspecified +} wifi_passpoint_network; + +typedef struct { + void (*on_passpoint_network_found)( + wifi_request_id id, + int net_id, // network block identifier for the matched network + wifi_scan_result *result, // scan result, with channel and beacon information + int anqp_len, // length of ANQP blob + byte *anqp // ANQP data, in the information_element format + ); +} wifi_passpoint_event_handler; + +/* Sets a list for passpoint networks for PNO purposes; it should be matched + * against any passpoint networks (designated by Interworking element) found + * during regular PNO scan. */ +wifi_error wifi_set_passpoint_list(wifi_request_id id, wifi_interface_handle iface, int num, + wifi_passpoint_network *networks, wifi_passpoint_event_handler handler); + +/* Reset passpoint network list - no Passpoint networks should be matched after this */ +wifi_error wifi_reset_passpoint_list(wifi_request_id id, wifi_interface_handle iface); #endif