WIFI_BAND_ABG_WITH_DFS = 7, // 2.4 GHz + 5 GHz with DFS
} wifi_band;
-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;
+#define MAX_CHANNELS 16
+#define MAX_BUCKETS 16
+#define MAX_HOTLIST_APS 128
+#define MAX_SIGNIFICANT_CHANGE_APS 64
+#define MAX_PNO_SSID 128;
+#define MAX_HOTLIST_SSID 8;
wifi_error wifi_get_valid_channels(wifi_interface_handle handle,
int band, int max_channels, wifi_channel *channels, int *num_channels);
/* 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_found_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_ap; // number of hotlist APs
+ ssid_threshold_param ssid[MAX_HOTLIST_APS]; // hotlist APs
+} 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_found_handler handler);
+
+/* Clear the SSID Hotlist */
+wifi_error wifi_reset_ssid_hotlist(wifi_request_id id, wifi_interface_handle iface);
+
+
+
/* Significant wifi change */
typedef struct {
mac_addr bssid; // BSSID
/* 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_EAPOL 4 // any EAPOL
// Enhanced PNO:
-// for each network framework will either specify a ssid or a crc32
-// if ssid is specified (i.e. ssid[0] != 0) then crc32 field shall be ignored.
+// 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 call wifi_set_epno_list.
- // Calling wifi_set_epno_list shall reset the "done" status of pno networks in 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
+ 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_networks; // number of SSIDs
+ int num_networks; // number of SSIDs
wifi_epno_network networks[]; // PNO networks
} wifi_epno_params;
typedef struct {
- int network_index; // index of the network found in the pno list
- char ssid[32+1]; // null terminated
- wifi_channel channel;
- int rssi;
-} wifi_epno_result;
-
-
-typedef struct {
// on results
void (*on_network_found)(wifi_request_id id,
- unsigned num_results, wifi_epno_result *results);
+ unsigned num_results, wifi_scan_result *results);
} wifi_epno_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:
+ * 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,
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_histeresys; // 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_set_lazy_roam(wifi_request_id id, wifi_interface_handle iface, int enable);
+
+/**
+ * Per BSSID preference
+ */
+typedef struct {
+ char bssid[6];
+ int rssi_modifier; // modifier applied to the RSSI of the BSSIDfor the purpose of comparing
+ // it with other roam candidate
+} wifi_bssid_preference;
+
+wifi_error wifi_set_lazy_roam(wifi_request_id id, wifi_interface_handle iface,
+ int num_bssid, wifi_bssid_preference *prefs);
+
+
typedef struct {
- int max_number_epno_networks_by_crc32; //max number of epno entries if crc32 is specified
- int max_number_epno_networks_by_ssid; //max number of epno entries if ssid is specified
- int max_number_of_white_losted_ssid; //max number of white listed SSIDs, M target is 2 to 4 */
+ int max_number_epno_networks; // max number of epno entries, M target is 64
+ int max_number_of_white_listed_ssid; // max number of white listed SSIDs, M target is 2 to 4
+ int max_number_of_hotlist_ssid; // max number of hotlist SSIDs, M target is 4
} wifi_roam_autojoin_offload_capabilities;
wifi_error wifi_get_roam_autojoin_offload_capabilities(wifi_interface_handle handle,
// packet, or packet headers only (up to TCP or RTP/UDP headers) will be copied into the ring\r
} wifi_ring_per_packet_status_entry;\r
\r
+static char per_packet_status_ring_name[] = "wifi_per_packet_status"; // Ring buffer name for per-packet status ring\r
\r
// Below events refer to the wifi_connectivity_event ring and shall be supported\r
\r
u64 timestamp; //present if has_timestamp bit is set.\r
union {\r
u8 data[0];\r
- wifi_ring_buffer_driver_connectivity_event connectivity_event;\r
+ wifi_ring_buffer_driver_connectivity_event connectivity_event[0];\r
+ wifi_ring_per_packet_status_entry packet_status[0];\r
};\r
} wifi_ring_buffer_entry;\r
\r
typedef struct {\r
u8 name[32];\r
u32 flags;\r
- u64 fd; // linux file descriptor for that buffer\r
+ wifi_ring_buffer_id ring_id; // unique integer representing the ring\r
u32 ring_buffer_byte_size; // total memory size allocated for the buffer\r
u32 verbose_level; //\r
u32 written_bytes; // number of bytes that was written to the buffer by driver, monotonously increasing integer\r
u32 read_bytes; // number of bytes that was read from the buffer by user land, monotonously increasing integer\r
+ u32 written_records; // number of records that was written to the buffer by driver, monotonously increasing integer\r
+\r
} wifi_ring_buffer_status;\r
\r
/**\r
+ * Callback for reporting ring data\r
+ *\r
+ * The ring buffer data collection supports 2 modes:\r
+ * - polling : framework periodically calls wifi_get_ringdata()\r
+ * - event based: driver calls on_ring_buffer_data when new records are available\r
+ *\r
+ * The callback is called by driver whenever new data is\r
+ */\r
+typedef struct {\r
+ void (*on_ring_buffer_data) (wifi_request_id id, wifi_ring_buffer_id ring_id, char * buffer, int buffer_size, wifi_ring_buffer_status *status);\r
+} wifi_ring_buffer_data_handler;\r
+\r
+\r
+\r
+/**\r
* API to trigger the debug collection.\r
* Unless his API is invoked - logging is not triggered.\r
* - verbose_level 0 corresponds to no collection\r
*\r
* buffer_name represent the name of the ring for which data collection shall start.\r
*/\r
-wifi_error wifi_set_logging_level(wifi_interface_handle iface, u32 verbose_level, u8 * buffer_name);\r
+wifi_error wifi_set_logging_level(wifi_interface_handle iface, u32 verbose_level, u8 * buffer_name, wifi_ring_buffer_data_handler handler);\r
\r
/* callback for reporting ring buffer status */\r
typedef struct {\r
wifi_interface_handle iface, char * buffer, int buffer_size);\r
\r
\r
+/* api to collect driver records */\r
+wifi_error wifi_get_ringdata(wifi_request_id id,\r
+ wifi_interface_handle iface, wifi_ring_buffer_id ring_id, char * buffer, int buffer_size, wifi_ring_buffer_status *status);\r
+\r
+\r
/* Feature set */\r
#define WIFI_LOGGER_MEMORY_DUMP_SUPPORTED 1\r
#define WIFI_LOGGER_PER_PACKET_TX_RX_STATUS_SUPPORTED 2\r
OSDN Git Service
