blob: 84647a6040e03c0a556d7ace38de054ef23e923f [file] [log] [blame]
Glen Kuhne94814572016-10-25 12:40:35 -07001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17syntax = "proto2";
18
19package clearcut.connectivity;
20
21option java_package = "com.android.server.wifi";
22option java_outer_classname = "WifiMetricsProto";
23
24// The information about the Wifi events.
25message WifiLog {
26
27 // Session information that gets logged for every Wifi connection.
28 repeated ConnectionEvent connection_event = 1;
29
30 // Number of saved networks in the user profile.
31 optional int32 num_saved_networks = 2;
32
33 // Number of open networks in the saved networks.
34 optional int32 num_open_networks = 3;
35
Hai Shalom808ceb32019-01-25 13:49:49 -080036 // Number of legacy personal networks.
37 optional int32 num_legacy_personal_networks = 4;
Glen Kuhne94814572016-10-25 12:40:35 -070038
Hai Shalom808ceb32019-01-25 13:49:49 -080039 // Number of legacy enterprise networks.
40 optional int32 num_legacy_enterprise_networks = 5;
Glen Kuhne94814572016-10-25 12:40:35 -070041
42 // Does the user have location setting enabled.
43 optional bool is_location_enabled = 6;
44
45 // Does the user have scanning enabled.
46 optional bool is_scanning_always_enabled = 7;
47
48 // Number of times user toggled wifi using the settings menu.
49 optional int32 num_wifi_toggled_via_settings = 8;
50
51 // Number of times user toggled wifi using the airplane menu.
52 optional int32 num_wifi_toggled_via_airplane = 9;
53
54 // Number of networks added by the user.
55 optional int32 num_networks_added_by_user = 10;
56
57 // Number of networks added by applications.
58 optional int32 num_networks_added_by_apps = 11;
59
60 // Number scans that returned empty results.
61 optional int32 num_empty_scan_results = 12;
62
63 // Number scans that returned at least one result.
64 optional int32 num_non_empty_scan_results = 13;
65
Ningyuan Wang72886332017-12-20 16:17:33 -080066 // Number of single scans requests.
Glen Kuhne94814572016-10-25 12:40:35 -070067 optional int32 num_oneshot_scans = 14;
68
69 // Number of repeated background scans that were scheduled to the chip.
70 optional int32 num_background_scans = 15;
71
72 // Error codes that a scan can result in.
73 enum ScanReturnCode {
74
75 // Return Code is unknown.
76 SCAN_UNKNOWN = 0;
77
78 // Scan was successful.
79 SCAN_SUCCESS = 1;
80
81 // Scan was successfully started, but was interrupted.
82 SCAN_FAILURE_INTERRUPTED = 2;
83
84 // Scan failed to start because of invalid configuration
85 // (bad channel, etc).
86 SCAN_FAILURE_INVALID_CONFIGURATION = 3;
87
88 // Could not start a scan because wifi is disabled.
89 FAILURE_WIFI_DISABLED = 4;
90
91 }
92
93 // Mapping of error codes to the number of times that scans resulted
94 // in that error.
95 repeated ScanReturnEntry scan_return_entries = 16;
96
97 message ScanReturnEntry {
98
Hai Shaloma18c32c2019-01-22 10:01:09 -080099 // Return code of the scan.
100 optional ScanReturnCode scan_return_code = 1;
Glen Kuhne94814572016-10-25 12:40:35 -0700101
Hai Shaloma18c32c2019-01-22 10:01:09 -0800102 // Number of entries that were found in the scan.
103 optional int32 scan_results_count = 2;
Glen Kuhne94814572016-10-25 12:40:35 -0700104 }
105
106 // State of the Wifi.
107 enum WifiState {
108
109 // State is unknown.
110 WIFI_UNKNOWN = 0;
111
112 // Wifi is disabled.
113 WIFI_DISABLED = 1;
114
115 // Wifi is enabled.
116 WIFI_DISCONNECTED = 2;
117
118 // Wifi is enabled and associated with an AP.
119 WIFI_ASSOCIATED = 3;
120 }
121
122 // Mapping of system state to the number of times that scans were requested in
123 // that state
124 repeated WifiSystemStateEntry wifi_system_state_entries = 17;
125
126 message WifiSystemStateEntry {
127
Hai Shaloma18c32c2019-01-22 10:01:09 -0800128 // Current WiFi state.
129 optional WifiState wifi_state = 1;
Glen Kuhne94814572016-10-25 12:40:35 -0700130
Hai Shaloma18c32c2019-01-22 10:01:09 -0800131 // Count of scans in state.
132 optional int32 wifi_state_count = 2;
Glen Kuhne94814572016-10-25 12:40:35 -0700133
Hai Shaloma18c32c2019-01-22 10:01:09 -0800134 // Is screen on.
135 optional bool is_screen_on = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700136 }
137
138 // Mapping of Error/Success codes to the number of background scans that resulted in it
139 repeated ScanReturnEntry background_scan_return_entries = 18;
140
141 // Mapping of system state to the number of times that Background scans were requested in that
142 // state
143 repeated WifiSystemStateEntry background_scan_request_state = 19;
144
145 // Total number of times the Watchdog of Last Resort triggered, resetting the wifi stack
146 optional int32 num_last_resort_watchdog_triggers = 20;
147
148 // Total number of networks over bad association threshold when watchdog triggered
149 optional int32 num_last_resort_watchdog_bad_association_networks_total = 21;
150
151 // Total number of networks over bad authentication threshold when watchdog triggered
152 optional int32 num_last_resort_watchdog_bad_authentication_networks_total = 22;
153
154 // Total number of networks over bad dhcp threshold when watchdog triggered
155 optional int32 num_last_resort_watchdog_bad_dhcp_networks_total = 23;
156
157 // Total number of networks over bad other threshold when watchdog triggered
158 optional int32 num_last_resort_watchdog_bad_other_networks_total = 24;
159
160 // Total count of networks seen when watchdog triggered
161 optional int32 num_last_resort_watchdog_available_networks_total = 25;
162
163 // Total count of triggers with atleast one bad association network
164 optional int32 num_last_resort_watchdog_triggers_with_bad_association = 26;
165
166 // Total count of triggers with atleast one bad authentication network
167 optional int32 num_last_resort_watchdog_triggers_with_bad_authentication = 27;
168
169 // Total count of triggers with atleast one bad dhcp network
170 optional int32 num_last_resort_watchdog_triggers_with_bad_dhcp = 28;
171
172 // Total count of triggers with atleast one bad other network
173 optional int32 num_last_resort_watchdog_triggers_with_bad_other = 29;
174
175 // Count of times connectivity watchdog confirmed pno is working
176 optional int32 num_connectivity_watchdog_pno_good = 30;
177
178 // Count of times connectivity watchdog found pno not working
179 optional int32 num_connectivity_watchdog_pno_bad = 31;
180
181 // Count of times connectivity watchdog confirmed background scan is working
182 optional int32 num_connectivity_watchdog_background_good = 32;
183
184 // Count of times connectivity watchdog found background scan not working
185 optional int32 num_connectivity_watchdog_background_bad = 33;
186
187 // The time duration represented by this wifi log, from start to end of capture
188 optional int32 record_duration_sec = 34;
189
190 // Counts the occurrences of each individual RSSI poll level
191 repeated RssiPollCount rssi_poll_rssi_count = 35;
192
193 // Total number of times WiFi connected immediately after a Last Resort Watchdog trigger,
194 // without new networks becoming available.
195 optional int32 num_last_resort_watchdog_successes = 36;
196
197 // Total number of saved hidden networks
198 optional int32 num_hidden_networks = 37;
199
200 // Total number of saved passpoint / hotspot 2.0 networks
201 optional int32 num_passpoint_networks = 38;
202
203 // Total number of scan results
204 optional int32 num_total_scan_results = 39;
205
206 // Total number of scan results for open networks
207 optional int32 num_open_network_scan_results = 40;
208
Hai Shalom808ceb32019-01-25 13:49:49 -0800209 // Total number of scan results for legacy personal networks
210 optional int32 num_legacy_personal_network_scan_results = 41;
Glen Kuhne94814572016-10-25 12:40:35 -0700211
Hai Shalom808ceb32019-01-25 13:49:49 -0800212 // Total number of scan results for legacy enterprise networks
213 optional int32 num_legacy_enterprise_network_scan_results = 42;
Glen Kuhne94814572016-10-25 12:40:35 -0700214
215 // Total number of scan results for hidden networks
216 optional int32 num_hidden_network_scan_results = 43;
217
218 // Total number of scan results for hotspot 2.0 r1 networks
219 optional int32 num_hotspot2_r1_network_scan_results = 44;
220
221 // Total number of scan results for hotspot 2.0 r2 networks
222 optional int32 num_hotspot2_r2_network_scan_results = 45;
223
224 // Total number of scans handled by framework (oneshot or otherwise)
225 optional int32 num_scans = 46;
226
227 // Counts the occurrences of each alert reason.
228 repeated AlertReasonCount alert_reason_count = 47;
229
230 // Counts the occurrences of each Wifi score
231 repeated WifiScoreCount wifi_score_count = 48;
232
233 // Histogram of Soft AP Durations
234 repeated SoftApDurationBucket soft_ap_duration = 49;
235
236 // Histogram of Soft AP ReturnCode
237 repeated SoftApReturnCodeCount soft_ap_return_code = 50;
238
239 // Histogram of the delta between scan result RSSI and RSSI polls
240 repeated RssiPollCount rssi_poll_delta_count = 51;
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700241
242 // List of events
243 repeated StaEvent sta_event_list = 52;
Roshan Pius3607a392017-05-11 09:05:58 -0700244
245 // Total number of times WiFi HAL crashed.
246 optional int32 num_hal_crashes = 53;
247
248 // Total number of times WiFicond crashed.
249 optional int32 num_wificond_crashes = 54;
250
251 // Indicates the number of times an error was encountered in
Roshan Piusa66e6382018-03-14 16:10:16 -0700252 // Wifi HAL on |WifiNative.setupInterfaceForClientMode|.
253 optional int32 num_setup_client_interface_failure_due_to_hal = 55;
Roshan Pius3607a392017-05-11 09:05:58 -0700254
255 // Indicates the number of times an error was encountered in
Roshan Piusa66e6382018-03-14 16:10:16 -0700256 // Wificond on |WifiNative.setupInterfaceForClientMode|.
257 optional int32 num_setup_client_interface_failure_due_to_wificond = 56;
Etan Cohen737addc2017-04-26 08:01:57 -0700258
259 // Wi-Fi Aware metrics
260 optional WifiAwareLog wifi_aware_log = 57;
Peter Qiu84243152017-06-22 13:44:04 -0700261
262 // Number of saved Passpoint providers in user profile.
263 optional int32 num_passpoint_providers = 58;
264
265 // Count of times Passpoint provider being installed.
266 optional int32 num_passpoint_provider_installation = 59;
267
268 // Count of times Passpoint provivider is installed successfully.
269 optional int32 num_passpoint_provider_install_success = 60;
270
271 // Count of times Passpoint provider is being uninstalled.
272 optional int32 num_passpoint_provider_uninstallation = 61;
273
274 // Count of times Passpoint provider is uninstalled successfully.
275 optional int32 num_passpoint_provider_uninstall_success = 62;
276
277 // Count of saved Passpoint providers device has ever connected to.
278 optional int32 num_passpoint_providers_successfully_connected = 63;
Glen Kuhnee2d67c02017-04-25 13:08:29 -0700279
280 // Histogram counting instances of scans with N many ScanResults with unique ssids
281 repeated NumConnectableNetworksBucket total_ssids_in_scan_histogram = 64;
282
283 // Histogram counting instances of scans with N many ScanResults/bssids
284 repeated NumConnectableNetworksBucket total_bssids_in_scan_histogram = 65;
285
286 // Histogram counting instances of scans with N many unique open ssids
287 repeated NumConnectableNetworksBucket available_open_ssids_in_scan_histogram = 66;
288
289 // Histogram counting instances of scans with N many bssids for open networks
290 repeated NumConnectableNetworksBucket available_open_bssids_in_scan_histogram = 67;
291
292 // Histogram counting instances of scans with N many unique ssids for saved networks
293 repeated NumConnectableNetworksBucket available_saved_ssids_in_scan_histogram = 68;
294
295 // Histogram counting instances of scans with N many bssids for saved networks
296 repeated NumConnectableNetworksBucket available_saved_bssids_in_scan_histogram = 69;
297
298 // Histogram counting instances of scans with N many unique SSIDs for open or saved networks
299 repeated NumConnectableNetworksBucket available_open_or_saved_ssids_in_scan_histogram = 70;
300
301 // Histogram counting instances of scans with N many BSSIDs for open or saved networks
302 repeated NumConnectableNetworksBucket available_open_or_saved_bssids_in_scan_histogram = 71;
303
304 // Histogram counting instances of scans with N many ScanResults matching unique saved passpoint providers
305 repeated NumConnectableNetworksBucket available_saved_passpoint_provider_profiles_in_scan_histogram = 72;
306
307 // Histogram counting instances of scans with N many ScanResults BSSIDs matching a saved passpoint provider
308 repeated NumConnectableNetworksBucket available_saved_passpoint_provider_bssids_in_scan_histogram = 73;
309
310 // Counts the number of AllSingleScanLister.onResult calls with a full band scan result
311 optional int32 full_band_all_single_scan_listener_results = 74;
312
313 // Counts the number of AllSingleScanLister.onResult calls with a partial (channels) scan result
314 optional int32 partial_all_single_scan_listener_results = 75;
Mehdi Alizadehd9163cf2017-08-10 18:20:25 -0700315
316 // Pno scan metrics
317 optional PnoScanMetrics pno_scan_metrics = 76;
Stephen Chenfc0facb2017-09-14 14:35:15 -0700318
319 // Histogram of "Connect to Network" notifications.
320 // The notification Action should be unset.
321 repeated ConnectToNetworkNotificationAndActionCount connect_to_network_notification_count = 77;
322
323 // Histogram of "Connect to Network" notification user actions.
324 repeated ConnectToNetworkNotificationAndActionCount connect_to_network_notification_action_count = 78;
325
326 // The number of SSIDs blacklisted from recommendation by the open network
327 // notification recommender
328 optional int32 open_network_recommender_blacklist_size = 79;
329
330 // Is the available network notification feature turned on
331 optional bool is_wifi_networks_available_notification_on = 80;
332
333 // Count of recommendation updates made by the open network notification
334 // recommender
335 optional int32 num_open_network_recommendation_updates = 81;
336
337 // Count of connection attempts that were initiated unsuccessfully
338 optional int32 num_open_network_connect_message_failed_to_send = 82;
Etan Cohenc462a7a2017-10-09 10:27:44 -0700339
340 // Histogram counting instances of scans with N many HotSpot 2.0 R1 APs
341 repeated NumConnectableNetworksBucket observed_hotspot_r1_aps_in_scan_histogram = 83;
342
343 // Histogram counting instances of scans with N many HotSpot 2.0 R2 APs
344 repeated NumConnectableNetworksBucket observed_hotspot_r2_aps_in_scan_histogram = 84;
345
346 // Histogram counting instances of scans with N many unique HotSpot 2.0 R1 ESS.
347 // Where ESS is defined as the (HESSID, ANQP Domain ID), (SSID, ANQP Domain ID) or
348 // (SSID, BSSID) tuple depending on AP configuration (in the above priority
349 // order).
350 repeated NumConnectableNetworksBucket observed_hotspot_r1_ess_in_scan_histogram = 85;
351
352 // Histogram counting instances of scans with N many unique HotSpot 2.0 R2 ESS.
353 // Where ESS is defined as the (HESSID, ANQP Domain ID), (SSID, ANQP Domain ID) or
354 // (SSID, BSSID) tuple depending on AP configuration (in the above priority
355 // order).
356 repeated NumConnectableNetworksBucket observed_hotspot_r2_ess_in_scan_histogram = 86;
357
358 // Histogram counting number of HotSpot 2.0 R1 APs per observed ESS in a scan
359 // (one value added per unique ESS - potentially multiple counts per single
360 // scan!)
361 repeated NumConnectableNetworksBucket observed_hotspot_r1_aps_per_ess_in_scan_histogram = 87;
362
363 // Histogram counting number of HotSpot 2.0 R2 APs per observed ESS in a scan
364 // (one value added per unique ESS - potentially multiple counts per single
365 // scan!)
366 repeated NumConnectableNetworksBucket observed_hotspot_r2_aps_per_ess_in_scan_histogram = 88;
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -0700367
368 // SoftAP event list tracking sessions and client counts in tethered mode
369 repeated SoftApConnectedClientsEvent soft_ap_connected_clients_events_tethered = 89;
370
371 // SoftAP event list tracking sessions and client counts in local only mode
372 repeated SoftApConnectedClientsEvent soft_ap_connected_clients_events_local_only = 90;
Jong Wook Kim72c49ee2017-10-26 13:16:36 -0700373
374 // Wps connection metrics
375 optional WpsMetrics wps_metrics = 91;
Siddharth Rayac8b69a2018-01-27 18:05:44 -0800376
377 // Wifi power statistics
378 optional WifiPowerStats wifi_power_stats = 92;
Ningyuan Wang72886332017-12-20 16:17:33 -0800379
380 // Number of connectivity single scan requests.
381 optional int32 num_connectivity_oneshot_scans = 93;
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -0800382
383 // WifiWake statistics
384 optional WifiWakeStats wifi_wake_stats = 94;
Etan Cohenf30125b2018-03-24 16:51:41 -0700385
386 // Histogram counting instances of scans with N many 802.11mc (RTT) supporting APs
387 repeated NumConnectableNetworksBucket observed_80211mc_supporting_aps_in_scan_histogram = 95;
Roshan Piusa66e6382018-03-14 16:10:16 -0700388
389 // Total number of times supplicant crashed.
390 optional int32 num_supplicant_crashes = 96;
391
392 // Total number of times hostapd crashed.
393 optional int32 num_hostapd_crashes = 97;
394
395 // Indicates the number of times an error was encountered in
396 // supplicant on |WifiNative.setupInterfaceForClientMode|.
397 optional int32 num_setup_client_interface_failure_due_to_supplicant = 98;
398
399 // Indicates the number of times an error was encountered in
400 // Wifi HAL on |WifiNative.setupInterfaceForSoftApMode|.
401 optional int32 num_setup_soft_ap_interface_failure_due_to_hal = 99;
402
403 // Indicates the number of times an error was encountered in
404 // Wifi HAL on |WifiNative.setupInterfaceForSoftApMode|.
405 optional int32 num_setup_soft_ap_interface_failure_due_to_wificond = 100;
406
407 // Indicates the number of times an error was encountered in
408 // Wifi HAL on |WifiNative.setupInterfaceForSoftApMode|.
409 optional int32 num_setup_soft_ap_interface_failure_due_to_hostapd = 101;
410
411 // Indicates the number of times we got an interface down in client mode.
412 optional int32 num_client_interface_down = 102;
413
414 // Indicates the number of times we got an interface down in softap mode.
415 optional int32 num_soft_ap_interface_down = 103;
Roshan Pius48f65632018-03-27 14:33:01 -0700416
417 // Indicates the number of scan requests from external apps.
418 optional int32 num_external_app_oneshot_scan_requests = 104;
419
420 // Indicates the number of times a scan request from an external foreground app was throttled.
421 optional int32 num_external_foreground_app_oneshot_scan_requests_throttled = 105;
422
423 // Indicates the number of times a scan request from an external background app was throttled.
424 optional int32 num_external_background_app_oneshot_scan_requests_throttled = 106;
xshu63522622018-03-15 16:48:29 -0700425
426 // WifiLastResortWatchdog time milliseconds delta between trigger and first connection success
427 optional int64 watchdog_trigger_to_connection_success_duration_ms = 107 [default = -1];
428
429 // The number of times wifi experienced failures after watchdog has already been triggered and is
430 // waiting for a connection success
431 optional int64 watchdog_total_connection_failure_count_after_trigger = 108;
xshu39cef4d2018-03-23 15:14:02 -0700432
433 // Number of times DFS channel scans are requested in single scan requests.
434 optional int32 num_oneshot_has_dfs_channel_scans = 109;
Etan Cohen4ec8dd32018-03-16 09:43:01 -0700435
436 // Wi-Fi RTT metrics
437 optional WifiRttLog wifi_rtt_log = 110;
Jong Wook Kim01ad38b2018-04-09 10:14:11 -0700438
439 // Flag which indicates if Connected MAC Randomization is enabled
440 optional bool is_mac_randomization_on = 111 [default = false];
Roshan Pius6de7a672018-04-24 16:30:13 -0700441
442 // Number of radio mode changes to MCC (Multi channel concurrency).
443 optional int32 num_radio_mode_change_to_mcc = 112;
444
445 // Number of radio mode changes to SCC (Single channel concurrency).
446 optional int32 num_radio_mode_change_to_scc = 113;
447
448 // Number of radio mode changes to SBS (Single band simultaneous).
449 optional int32 num_radio_mode_change_to_sbs = 114;
450
451 // Number of radio mode changes to DBS (Dual band simultaneous).
452 optional int32 num_radio_mode_change_to_dbs = 115;
Roshan Piusd3a58cb2018-05-14 15:53:44 -0700453
454 // Number of times the firmware picked a SoftAp channel not satisfying user band preference.
455 optional int32 num_soft_ap_user_band_preference_unsatisfied = 116;
Michael Plass8a779ac2018-05-09 16:56:52 -0700456
457 // Identifier for experimental scoring parameter settings.
458 optional string score_experiment_id = 117;
459
xshub483b722018-05-22 15:46:26 -0700460 // Data on wifi radio usage
461 optional WifiRadioUsage wifi_radio_usage = 118;
Jong Wook Kim411cab92018-04-26 15:09:23 -0700462
463 // Stores settings values used for metrics testing.
464 optional ExperimentValues experiment_values = 119;
465
466 // List of WifiIsUnusableEvents which get logged when we notice that WiFi is unusable.
467 // Collected only when WIFI_IS_UNUSABLE_EVENT_METRICS_ENABLED Settings is enabled.
468 repeated WifiIsUnusableEvent wifi_is_unusable_event_list = 120;
Jong Wook Kime4aa37f2018-04-23 11:18:24 -0700469
470 // Counts the occurrences of each link speed (Mbps) level
471 // with rssi (dBm) and rssi^2 sums (dBm^2)
472 repeated LinkSpeedCount link_speed_counts = 121;
Ahmed ElArabawyba64b612018-06-15 09:17:45 -0700473
474 // Number of times the SarManager failed to register SAR sensor listener
475 optional int32 num_sar_sensor_registration_failures = 122;
Ecco Park5a403002018-07-23 15:53:10 -0700476
477 // Histogram of the EAP method type of all installed Passpoint profiles
478 repeated PasspointProfileTypeCount installed_passpoint_profile_type = 123;
Siddharth Ray191b10b2018-08-10 17:36:17 -0700479
480 // Hardware revision (EVT, DVT, PVT etc.)
481 optional string hardware_revision = 124;
xshu0e0dea42018-09-17 17:30:15 -0700482
483 // Total wifi link layer usage data over the logging duration in ms.
484 optional WifiLinkLayerUsageStats wifi_link_layer_usage_stats = 125;
xshua33726e2018-09-24 15:02:23 -0700485
486 // Multiple lists of timestamped link layer stats with labels to represent whether wifi is usable
487 repeated WifiUsabilityStats wifi_usability_stats_list = 126;
Mingguang Xuca2aab12019-01-12 23:40:42 -0800488
489 // Counts the occurrences of each Wifi usability score provided by external app
490 repeated WifiUsabilityScoreCount wifi_usability_score_count = 127;
David Su367bdff2018-12-13 13:39:11 -0800491
492 // List of PNO scan stats, one element for each mobility state
493 repeated DeviceMobilityStatePnoScanStats mobility_state_pno_stats_list = 128;
Jimmy Chen0142e8b2018-11-23 16:25:57 +0800494
495 // Wifi p2p statistics
496 optional WifiP2pStats wifi_p2p_stats = 129;
Hai Shaloma18c32c2019-01-22 10:01:09 -0800497
498 // Easy Connect (DPP) metrics
499 optional WifiDppLog wifi_dpp_log = 130;
Hai Shalom808ceb32019-01-25 13:49:49 -0800500
501 // Number of Enhanced Open (OWE) networks in the saved networks.
502 optional int32 num_enhanced_open_networks = 131;
503
504 // Number of WPA3-Personal networks.
505 optional int32 num_wpa3_personal_networks = 132;
506
507 // Number of WPA3-Enterprise networks.
508 optional int32 num_wpa3_enterprise_networks = 133;
509
510 // Total number of scan results for Enhanced open networks
511 optional int32 num_enhanced_open_network_scan_results = 134;
512
513 // Total number of scan results for WPA3-Personal networks
514 optional int32 num_wpa3_personal_network_scan_results = 135;
515
516 // Total number of scan results for WPA3-Enterprise networks
517 optional int32 num_wpa3_enterprise_network_scan_results = 136;
Glen Kuhne94814572016-10-25 12:40:35 -0700518}
519
520// Information that gets logged for every WiFi connection.
521message RouterFingerPrint {
522
523 enum RoamType {
524
525 // Type is unknown.
526 ROAM_TYPE_UNKNOWN = 0;
527
528 // No roaming - usually happens on a single band (2.4 GHz) router.
529 ROAM_TYPE_NONE = 1;
530
531 // Enterprise router.
532 ROAM_TYPE_ENTERPRISE = 2;
533
534 // DBDC => Dual Band Dual Concurrent essentially a router that
535 // supports both 2.4 GHz and 5 GHz bands.
536 ROAM_TYPE_DBDC = 3;
537 }
538
539 enum Auth {
540
541 // Auth is unknown.
542 AUTH_UNKNOWN = 0;
543
544 // No authentication.
545 AUTH_OPEN = 1;
546
547 // If the router uses a personal authentication.
548 AUTH_PERSONAL = 2;
549
550 // If the router is setup for enterprise authentication.
551 AUTH_ENTERPRISE = 3;
552 }
553
554 enum RouterTechnology {
555
556 // Router is unknown.
557 ROUTER_TECH_UNKNOWN = 0;
558
559 // Router Channel A.
560 ROUTER_TECH_A = 1;
561
562 // Router Channel B.
563 ROUTER_TECH_B = 2;
564
565 // Router Channel G.
566 ROUTER_TECH_G = 3;
567
568 // Router Channel N.
569 ROUTER_TECH_N = 4;
570
571 // Router Channel AC.
572 ROUTER_TECH_AC = 5;
573
574 // When the channel is not one of the above.
575 ROUTER_TECH_OTHER = 6;
576 }
577
578 optional RoamType roam_type = 1;
579
580 // Channel on which the connection takes place.
581 optional int32 channel_info = 2;
582
583 // DTIM setting of the router.
584 optional int32 dtim = 3;
585
586 // Authentication scheme of the router.
587 optional Auth authentication = 4;
588
589 // If the router is hidden.
590 optional bool hidden = 5;
591
592 // Channel information.
593 optional RouterTechnology router_technology = 6;
594
595 // whether ipv6 is supported.
596 optional bool supports_ipv6 = 7;
597
598 // If the router is a passpoint / hotspot 2.0 network
599 optional bool passpoint = 8;
600}
601
602message ConnectionEvent {
603
604 // Roam Type.
605 enum RoamType {
606
607 // Type is unknown.
608 ROAM_UNKNOWN = 0;
609
610 // No roaming.
Hai Shaloma18c32c2019-01-22 10:01:09 -0800611 ROAM_NONE = 1;
Glen Kuhne94814572016-10-25 12:40:35 -0700612
613 // DBDC roaming.
614 ROAM_DBDC = 2;
615
616 // Enterprise roaming.
617 ROAM_ENTERPRISE = 3;
618
619 // User selected roaming.
620 ROAM_USER_SELECTED = 4;
621
622 // Unrelated.
623 ROAM_UNRELATED = 5;
624 }
625
626 // Connectivity Level Failure.
627 enum ConnectivityLevelFailure {
628
629 // Failure is unknown.
630 HLF_UNKNOWN = 0;
631
632 // No failure.
633 HLF_NONE = 1;
634
635 // DHCP failure.
636 HLF_DHCP = 2;
637
638 // No internet connection.
639 HLF_NO_INTERNET = 3;
640
641 // No internet connection.
642 HLF_UNWANTED = 4;
643 }
644
645 // Start time of the connection.
646 optional int64 start_time_millis = 1;// [(datapol.semantic_type) = ST_TIMESTAMP];
647
648 // Duration to connect.
649 optional int32 duration_taken_to_connect_millis = 2;
650
651 // Router information.
652 optional RouterFingerPrint router_fingerprint = 3;
653
654 // RSSI at the start of the connection.
655 optional int32 signal_strength = 4;
656
657 // Roam Type.
658 optional RoamType roam_type = 5;
659
660 // Result of the connection.
661 optional int32 connection_result = 6;
662
663 // Reasons for level 2 failure (needs to be coordinated with wpa-supplicant).
664 optional int32 level_2_failure_code = 7;
665
666 // Failures that happen at the connectivity layer.
667 optional ConnectivityLevelFailure connectivity_level_failure_code = 8;
668
669 // Has bug report been taken.
670 optional bool automatic_bug_report_taken = 9;
671}
672
673// Number of occurrences of a specific RSSI poll rssi value
674message RssiPollCount {
675 // RSSI
676 optional int32 rssi = 1;
677
678 // Number of RSSI polls with 'rssi'
679 optional int32 count = 2;
xshu122886e2018-05-16 15:38:49 -0700680
681 // Beacon frequency of the channel in MHz
682 optional int32 frequency = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700683}
684
685// Number of occurrences of a specific alert reason value
686message AlertReasonCount {
687 // Alert reason
688 optional int32 reason = 1;
689
690 // Number of alerts with |reason|.
691 optional int32 count = 2;
692}
693
694// Counts the number of instances of a specific Wifi Score calculated by WifiScoreReport
695message WifiScoreCount {
696 // Wifi Score
697 optional int32 score = 1;
698
699 // Number of Wifi score reports with this score
700 optional int32 count = 2;
701}
702
Mingguang Xuca2aab12019-01-12 23:40:42 -0800703// Counts the number of instances of a specific Wifi Usability Score
704message WifiUsabilityScoreCount {
705 // Wifi Usability Score
706 optional int32 score = 1;
707
708 // Number of Wifi score reports with this score
709 optional int32 count = 2;
710}
711
Jong Wook Kime4aa37f2018-04-23 11:18:24 -0700712// Number of occurrences of a specific link speed (Mbps)
713// and sum of rssi (dBm) and rssi^2 (dBm^2)
714message LinkSpeedCount {
715 // Link speed (Mbps)
716 optional int32 link_speed_mbps = 1;
717
718 // Number of RSSI polls with link_speed
719 optional int32 count = 2;
720
721 // Sum of absolute values of rssi values (dBm)
722 optional int32 rssi_sum_dbm = 3;
723
724 // Sum of squares of rssi values (dBm^2)
725 optional int64 rssi_sum_of_squares_dbm_sq = 4;
726}
727
Glen Kuhne94814572016-10-25 12:40:35 -0700728// Number of occurrences of Soft AP session durations
729message SoftApDurationBucket {
730 // Bucket covers duration : [duration_sec, duration_sec + bucket_size_sec)
731 // The (inclusive) lower bound of Soft AP session duration represented by this bucket
732 optional int32 duration_sec = 1;
733
734 // The size of this bucket
735 optional int32 bucket_size_sec = 2;
736
737 // Number of soft AP session durations that fit into this bucket
738 optional int32 count = 3;
739}
740
741// Number of occurrences of a soft AP session return code
742message SoftApReturnCodeCount {
Rebecca Silberstein28d9de22017-01-24 10:42:59 -0800743
744 enum SoftApStartResult {
745
746 // SoftApManager return code unknown
747 SOFT_AP_RETURN_CODE_UNKNOWN = 0;
748
749 // SoftAp started successfully
750 SOFT_AP_STARTED_SUCCESSFULLY = 1;
751
752 // Catch all for failures with no specific failure reason
753 SOFT_AP_FAILED_GENERAL_ERROR = 2;
754
755 // SoftAp failed to start due to NO_CHANNEL error
756 SOFT_AP_FAILED_NO_CHANNEL = 3;
757 }
758
759 // Historical, no longer used for writing as of 01/2017.
760 optional int32 return_code = 1 [deprecated = true];
Glen Kuhne94814572016-10-25 12:40:35 -0700761
762 // Occurrences of this soft AP return code
763 optional int32 count = 2;
Rebecca Silberstein28d9de22017-01-24 10:42:59 -0800764
765 // Result of attempt to start SoftAp
766 optional SoftApStartResult start_result = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700767}
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700768
769message StaEvent {
770 message ConfigInfo {
771 // The set of key management protocols supported by this configuration.
772 optional uint32 allowed_key_management = 1 [default = 0];
773
774 // The set of security protocols supported by this configuration.
775 optional uint32 allowed_protocols = 2 [default = 0];
776
777 // The set of authentication protocols supported by this configuration.
778 optional uint32 allowed_auth_algorithms = 3 [default = 0];
779
780 // The set of pairwise ciphers for WPA supported by this configuration.
781 optional uint32 allowed_pairwise_ciphers = 4 [default = 0];
782
783 // The set of group ciphers supported by this configuration.
784 optional uint32 allowed_group_ciphers = 5;
785
786 // Is this a 'hidden network'
787 optional bool hidden_ssid = 6;
788
789 // Is this a Hotspot 2.0 / passpoint network
790 optional bool is_passpoint = 7;
791
792 // Is this an 'ephemeral' network (Not in saved network list, recommended externally)
793 optional bool is_ephemeral = 8;
794
795 // Has a successful connection ever been established using this WifiConfiguration
796 optional bool has_ever_connected = 9;
797
798 // RSSI of the scan result candidate associated with this WifiConfiguration
799 optional int32 scan_rssi = 10 [default = -127];
800
801 // Frequency of the scan result candidate associated with this WifiConfiguration
802 optional int32 scan_freq = 11 [default = -1];
803 }
804
805 enum EventType {
806 // Default/Invalid event
807 TYPE_UNKNOWN = 0;
808
809 // Supplicant Association Rejection event. Code contains the 802.11
810 TYPE_ASSOCIATION_REJECTION_EVENT = 1;
811
812 // Supplicant L2 event,
813 TYPE_AUTHENTICATION_FAILURE_EVENT = 2;
814
815 // Supplicant L2 event
816 TYPE_NETWORK_CONNECTION_EVENT = 3;
817
818 // Supplicant L2 event
819 TYPE_NETWORK_DISCONNECTION_EVENT = 4;
820
821 // Supplicant L2 event
822 TYPE_SUPPLICANT_STATE_CHANGE_EVENT = 5;
823
824 // Supplicant L2 event
825 TYPE_CMD_ASSOCIATED_BSSID = 6;
826
827 // IP Manager successfully completed IP Provisioning
828 TYPE_CMD_IP_CONFIGURATION_SUCCESSFUL = 7;
829
830 // IP Manager failed to complete IP Provisioning
831 TYPE_CMD_IP_CONFIGURATION_LOST = 8;
832
833 // IP Manager lost reachability to network neighbors
834 TYPE_CMD_IP_REACHABILITY_LOST = 9;
835
836 // Indicator that Supplicant is targeting a BSSID for roam/connection
837 TYPE_CMD_TARGET_BSSID = 10;
838
839 // Wifi framework is initiating a connection attempt
840 TYPE_CMD_START_CONNECT = 11;
841
842 // Wifi framework is initiating a roaming connection attempt
843 TYPE_CMD_START_ROAM = 12;
844
845 // SystemAPI connect() command, Settings App
846 TYPE_CONNECT_NETWORK = 13;
847
848 // Network Agent has validated the internet connection (Captive Portal Check success, or user
849 // validation)
850 TYPE_NETWORK_AGENT_VALID_NETWORK = 14;
851
852 // Framework initiated disconnect. Sometimes generated to give an extra reason for a disconnect
853 // Should typically be followed by a NETWORK_DISCONNECTION_EVENT with a local_gen = true
854 TYPE_FRAMEWORK_DISCONNECT = 15;
Michael Plassbb367b62017-10-06 10:29:51 -0700855
856 // The NetworkAgent score for wifi has changed in a way that may impact
857 // connectivity
858 TYPE_SCORE_BREACH = 16;
Jong Wook Kim01ad38b2018-04-09 10:14:11 -0700859
860 // Framework changed Sta interface MAC address
861 TYPE_MAC_CHANGE = 17;
Jong Wook Kimb56979f2018-08-08 14:50:18 -0700862
863 // Wifi is turned on
864 TYPE_WIFI_ENABLED = 18;
865
866 // Wifi is turned off
867 TYPE_WIFI_DISABLED = 19;
Mingguang Xuca2aab12019-01-12 23:40:42 -0800868
869 // The NetworkAgent Wifi usability score has changed in a way that may
870 // impact connectivity
871 TYPE_WIFI_USABILITY_SCORE_BREACH = 20;
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700872 }
873
874 enum FrameworkDisconnectReason {
875 // default/none/unknown value
876 DISCONNECT_UNKNOWN = 0;
877
878 // API DISCONNECT
879 DISCONNECT_API = 1;
880
881 // Some framework internal reason (generic)
882 DISCONNECT_GENERIC = 2;
883
884 // Network Agent network validation failed, user signaled network unwanted
885 DISCONNECT_UNWANTED = 3;
886
887 // Roaming timed out
888 DISCONNECT_ROAM_WATCHDOG_TIMER = 4;
889
890 // P2P service requested wifi disconnect
891 DISCONNECT_P2P_DISCONNECT_WIFI_REQUEST = 5;
892
893 // SIM was removed while using a SIM config
894 DISCONNECT_RESET_SIM_NETWORKS = 6;
895 }
896
897 // Authentication Failure reasons as reported through the API.
898 enum AuthFailureReason {
899 // Unknown default
900 AUTH_FAILURE_UNKNOWN = 0;
901
902 // The reason code if there is no error during authentication. It could also imply that there no
903 // authentication in progress,
904 AUTH_FAILURE_NONE = 1;
905
906 // The reason code if there was a timeout authenticating.
907 AUTH_FAILURE_TIMEOUT = 2;
908
909 // The reason code if there was a wrong password while authenticating.
910 AUTH_FAILURE_WRONG_PSWD = 3;
911
912 // The reason code if there was EAP failure while authenticating.
913 AUTH_FAILURE_EAP_FAILURE = 4;
914 }
915
916 // What event was this
917 optional EventType type = 1;
918
919 // 80211 death reason code, relevant to NETWORK_DISCONNECTION_EVENTs
920 optional int32 reason = 2 [default = -1];
921
922 // 80211 Association Status code, relevant to ASSOCIATION_REJECTION_EVENTs
923 optional int32 status = 3 [default = -1];
924
925 // Designates whether a NETWORK_DISCONNECT_EVENT was by the STA or AP
926 optional bool local_gen = 4 [default = false];
927
928 // Network information from the WifiConfiguration of a framework initiated connection attempt
929 optional ConfigInfo config_info = 5;
930
931 // RSSI from the last rssi poll (Only valid for active connections)
932 optional int32 last_rssi = 6 [default = -127];
933
934 // Link speed from the last rssi poll (Only valid for active connections)
935 optional int32 last_link_speed = 7 [default = -1];
936
937 // Frequency from the last rssi poll (Only valid for active connections)
938 optional int32 last_freq = 8 [default = -1];
939
940 // Enum used to define bit positions in the supplicant_state_change_bitmask
941 // See {@code frameworks/base/wifi/java/android/net/wifi/SupplicantState.java} for documentation
942 enum SupplicantState {
943 STATE_DISCONNECTED = 0;
944
945 STATE_INTERFACE_DISABLED = 1;
946
947 STATE_INACTIVE = 2;
948
949 STATE_SCANNING = 3;
950
951 STATE_AUTHENTICATING = 4;
952
953 STATE_ASSOCIATING = 5;
954
955 STATE_ASSOCIATED = 6;
956
957 STATE_FOUR_WAY_HANDSHAKE = 7;
958
959 STATE_GROUP_HANDSHAKE = 8;
960
961 STATE_COMPLETED = 9;
962
963 STATE_DORMANT = 10;
964
965 STATE_UNINITIALIZED = 11;
966
967 STATE_INVALID = 12;
968 }
969
Jong Wook Kim411cab92018-04-26 15:09:23 -0700970 // Bit mask of all supplicant state changes that occurred since the last event
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700971 optional uint32 supplicant_state_changes_bitmask = 9 [default = 0];
972
973 // The number of milliseconds that have elapsed since the device booted
974 optional int64 start_time_millis = 10 [default = 0];
975
976 optional FrameworkDisconnectReason framework_disconnect_reason = 11 [default = DISCONNECT_UNKNOWN];
977
Jong Wook Kim411cab92018-04-26 15:09:23 -0700978 // Flag which indicates if an association rejection event occurred due to a timeout
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700979 optional bool association_timed_out = 12 [default = false];
980
981 // Authentication failure reason, as reported by WifiManager (calculated from state & deauth code)
982 optional AuthFailureReason auth_failure_reason = 13 [default = AUTH_FAILURE_UNKNOWN];
Michael Plassbb367b62017-10-06 10:29:51 -0700983
984 // NetworkAgent score of connected wifi
985 optional int32 last_score = 14 [default = -1];
Mingguang Xuca2aab12019-01-12 23:40:42 -0800986
987 // NetworkAgent Wifi usability score of connected wifi
988 optional int32 last_wifi_usability_score = 15 [default = -1];
Mingguang Xue7e344a2019-01-21 16:26:45 -0800989
990 // Prediction horizon (in second) of Wifi usability score provided by external
991 // system app
992 optional int32 last_prediction_horizon_sec = 16 [default = -1];
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700993}
Etan Cohen737addc2017-04-26 08:01:57 -0700994
995// Wi-Fi Aware metrics
996message WifiAwareLog {
997 // total number of unique apps that used Aware (measured on attach)
998 optional int32 num_apps = 1;
999
1000 // total number of unique apps that used an identity callback when attaching
1001 optional int32 num_apps_using_identity_callback = 2;
1002
1003 // maximum number of attaches for an app
1004 optional int32 max_concurrent_attach_sessions_in_app = 3;
1005
1006 // histogram of attach request results
1007 repeated NanStatusHistogramBucket histogram_attach_session_status = 4;
1008
1009 // maximum number of concurrent publish sessions in a single app
1010 optional int32 max_concurrent_publish_in_app = 5;
1011
1012 // maximum number of concurrent subscribe sessions in a single app
1013 optional int32 max_concurrent_subscribe_in_app = 6;
1014
1015 // maximum number of concurrent discovery (publish+subscribe) sessions in a single app
1016 optional int32 max_concurrent_discovery_sessions_in_app = 7;
1017
1018 // maximum number of concurrent publish sessions in the system
1019 optional int32 max_concurrent_publish_in_system = 8;
1020
1021 // maximum number of concurrent subscribe sessions in the system
1022 optional int32 max_concurrent_subscribe_in_system = 9;
1023
1024 // maximum number of concurrent discovery (publish+subscribe) sessions in the system
1025 optional int32 max_concurrent_discovery_sessions_in_system = 10;
1026
1027 // histogram of publish request results
1028 repeated NanStatusHistogramBucket histogram_publish_status = 11;
1029
1030 // histogram of subscribe request results
1031 repeated NanStatusHistogramBucket histogram_subscribe_status = 12;
1032
1033 // number of unique apps which experienced a discovery session creation failure due to lack of
1034 // resources
1035 optional int32 num_apps_with_discovery_session_failure_out_of_resources = 13;
1036
1037 // histogram of create ndp request results
1038 repeated NanStatusHistogramBucket histogram_request_ndp_status = 14;
1039
1040 // histogram of create ndp out-of-band (OOB) request results
1041 repeated NanStatusHistogramBucket histogram_request_ndp_oob_status = 15;
1042
1043 // maximum number of concurrent active data-interfaces (NDI) in a single app
1044 optional int32 max_concurrent_ndi_in_app = 19;
1045
1046 // maximum number of concurrent active data-interfaces (NDI) in the system
1047 optional int32 max_concurrent_ndi_in_system = 20;
1048
1049 // maximum number of concurrent data-paths (NDP) in a single app
1050 optional int32 max_concurrent_ndp_in_app = 21;
1051
1052 // maximum number of concurrent data-paths (NDP) in the system
1053 optional int32 max_concurrent_ndp_in_system = 22;
1054
1055 // maximum number of concurrent secure data-paths (NDP) in a single app
1056 optional int32 max_concurrent_secure_ndp_in_app = 23;
1057
1058 // maximum number of concurrent secure data-paths (NDP) in the system
1059 optional int32 max_concurrent_secure_ndp_in_system = 24;
1060
1061 // maximum number of concurrent data-paths (NDP) per data-interface (NDI)
1062 optional int32 max_concurrent_ndp_per_ndi = 25;
1063
1064 // histogram of durations of Aware being available
1065 repeated HistogramBucket histogram_aware_available_duration_ms = 26;
1066
1067 // histogram of durations of Aware being enabled
1068 repeated HistogramBucket histogram_aware_enabled_duration_ms = 27;
1069
1070 // histogram of duration (in ms) of attach sessions
1071 repeated HistogramBucket histogram_attach_duration_ms = 28;
1072
1073 // histogram of duration (in ms) of publish sessions
1074 repeated HistogramBucket histogram_publish_session_duration_ms = 29;
1075
1076 // histogram of duration (in ms) of subscribe sessions
1077 repeated HistogramBucket histogram_subscribe_session_duration_ms = 30;
1078
1079 // histogram of duration (in ms) of data-paths (NDP)
1080 repeated HistogramBucket histogram_ndp_session_duration_ms = 31;
1081
1082 // histogram of usage (in MB) of data-paths (NDP)
1083 repeated HistogramBucket histogram_ndp_session_data_usage_mb = 32;
1084
1085 // histogram of usage (in MB) of data-path creation time (in ms) measured as request -> confirm
1086 repeated HistogramBucket histogram_ndp_creation_time_ms = 33;
1087
1088 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: minimum
1089 optional int64 ndp_creation_time_ms_min = 34;
1090
1091 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: maximum
1092 optional int64 ndp_creation_time_ms_max = 35;
1093
1094 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: sum
1095 optional int64 ndp_creation_time_ms_sum = 36;
1096
1097 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: sum of sq
1098 optional int64 ndp_creation_time_ms_sum_of_sq = 37;
1099
1100 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: number of
1101 // samples
1102 optional int64 ndp_creation_time_ms_num_samples = 38;
1103
1104 // total time within the logging window that aware was available
1105 optional int64 available_time_ms = 39;
1106
1107 // total time within the logging window that aware was enabled
1108 optional int64 enabled_time_ms = 40;
1109
Etan Cohenfa723572018-03-13 07:25:50 -07001110 // maximum number of concurrent publish sessions enabling ranging in a single app
1111 optional int32 max_concurrent_publish_with_ranging_in_app = 41;
1112
1113 // maximum number of concurrent subscribe sessions specifying a geofence in a single app
1114 optional int32 max_concurrent_subscribe_with_ranging_in_app = 42;
1115
1116 // maximum number of concurrent publish sessions enabling ranging in the system
1117 optional int32 max_concurrent_publish_with_ranging_in_system = 43;
1118
1119 // maximum number of concurrent subscribe sessions specifying a geofence in the system
1120 optional int32 max_concurrent_subscribe_with_ranging_in_system = 44;
1121
1122 // histogram of subscribe session geofence minimum (only when specified)
1123 repeated HistogramBucket histogram_subscribe_geofence_min = 45;
1124
1125 // histogram of subscribe session geofence maximum (only when specified)
1126 repeated HistogramBucket histogram_subscribe_geofence_max = 46;
1127
1128 // total number of subscribe sessions which enabled ranging
1129 optional int32 num_subscribes_with_ranging = 47;
1130
1131 // total number of matches (service discovery indication) with ranging provided
1132 optional int32 num_matches_with_ranging = 48;
1133
1134 // total number of matches (service discovery indication) for service discovery with ranging
1135 // enabled which did not trigger ranging
1136 optional int32 num_matches_without_ranging_for_ranging_enabled_subscribes = 49;
1137
Etan Cohen737addc2017-04-26 08:01:57 -07001138 // Histogram bucket for Wi-Fi Aware logs. Range is [start, end)
1139 message HistogramBucket {
1140 // lower range of the bucket (inclusive)
1141 optional int64 start = 1;
1142
1143 // upper range of the bucket (exclusive)
1144 optional int64 end = 2;
1145
1146 // number of samples in the bucket
1147 optional int32 count = 3;
1148 }
1149
1150 // Status of various NAN operations
1151 enum NanStatusTypeEnum {
1152 // constant to be used by proto
1153 UNKNOWN = 0;
1154
1155 // NAN operation succeeded
1156 SUCCESS = 1;
1157
1158 // NAN Discovery Engine/Host driver failures
1159 INTERNAL_FAILURE = 2;
1160
1161 // NAN OTA failures
1162 PROTOCOL_FAILURE = 3;
1163
1164 // The publish/subscribe discovery session id is invalid
1165 INVALID_SESSION_ID = 4;
1166
1167 // Out of resources to fufill request
1168 NO_RESOURCES_AVAILABLE = 5;
1169
1170 // Invalid arguments passed
1171 INVALID_ARGS = 6;
1172
1173 // Invalid peer id
1174 INVALID_PEER_ID = 7;
1175
1176 // Invalid NAN data-path (ndp) id
1177 INVALID_NDP_ID = 8;
1178
1179 // Attempting to enable NAN when not available, e.g. wifi is disabled
1180 NAN_NOT_ALLOWED = 9;
1181
1182 // Over the air ACK not received
1183 NO_OTA_ACK = 10;
1184
1185 // Attempting to enable NAN when already enabled
1186 ALREADY_ENABLED = 11;
1187
1188 // Can't queue tx followup message foor transmission
1189 FOLLOWUP_TX_QUEUE_FULL = 12;
1190
1191 // Unsupported concurrency of NAN and another feature - NAN disabled
1192 UNSUPPORTED_CONCURRENCY_NAN_DISABLED = 13;
1193
1194 // Unknown NanStatusType
1195 UNKNOWN_HAL_STATUS = 14;
1196 }
1197
1198 // Histogram bucket for Wi-Fi Aware (NAN) status.
1199 message NanStatusHistogramBucket {
1200 // status type defining the bucket
1201 optional NanStatusTypeEnum nan_status_type = 1;
1202
1203 // number of samples in the bucket
1204 optional int32 count = 2;
1205 }
1206}
1207
Glen Kuhnee2d67c02017-04-25 13:08:29 -07001208// Data point used to build 'Number of Connectable Network' histograms
1209message NumConnectableNetworksBucket {
1210 // Number of connectable networks seen in a scan result
1211 optional int32 num_connectable_networks = 1 [default = 0];
1212
1213 // Number of scan results with num_connectable_networks
1214 optional int32 count = 2 [default = 0];
1215}
Mehdi Alizadehd9163cf2017-08-10 18:20:25 -07001216
1217// Pno scan metrics
1218// Here "Pno Scan" refers to the session of offloaded scans, these metrics count the result of a
1219// single session, and not the individual scans within that session.
1220message PnoScanMetrics {
1221 // Total number of attempts to offload pno scans
1222 optional int32 num_pno_scan_attempts = 1;
1223
1224 // Total number of pno scans failed
1225 optional int32 num_pno_scan_failed = 2;
1226
1227 // Number of pno scans started successfully over offload
1228 optional int32 num_pno_scan_started_over_offload = 3;
1229
1230 // Number of pno scans failed over offload
1231 optional int32 num_pno_scan_failed_over_offload = 4;
1232
1233 // Total number of pno scans that found any network
1234 optional int32 num_pno_found_network_events = 5;
1235}
Stephen Chenfc0facb2017-09-14 14:35:15 -07001236
1237// Number of occurrences for a particular "Connect to Network" Notification or
1238// notification Action.
1239message ConnectToNetworkNotificationAndActionCount {
1240
1241 // "Connect to Network" notifications
1242 enum Notification {
1243
1244 // Default
1245 NOTIFICATION_UNKNOWN = 0;
1246
1247 // Initial notification with a recommended network.
1248 NOTIFICATION_RECOMMEND_NETWORK = 1;
1249
1250 // Notification when connecting to the recommended network.
1251 NOTIFICATION_CONNECTING_TO_NETWORK = 2;
1252
1253 // Notification when successfully connected to the network.
1254 NOTIFICATION_CONNECTED_TO_NETWORK = 3;
1255
1256 // Notification when failed to connect to network.
1257 NOTIFICATION_FAILED_TO_CONNECT = 4;
1258 }
1259
1260 // "Connect to Network" notification actions
1261 enum Action {
1262
1263 // Default
1264 ACTION_UNKNOWN = 0;
1265
1266 // User dismissed the "Connect to Network" notification.
1267 ACTION_USER_DISMISSED_NOTIFICATION = 1;
1268
1269 // User tapped action button to connect to recommended network.
1270 ACTION_CONNECT_TO_NETWORK = 2;
1271
1272 // User tapped action button to open Wi-Fi Settings.
1273 ACTION_PICK_WIFI_NETWORK = 3;
1274
1275 // User tapped "Failed to connect" notification to open Wi-Fi Settings.
1276 ACTION_PICK_WIFI_NETWORK_AFTER_CONNECT_FAILURE = 4;
1277 }
1278
1279 // Recommenders of the "Connect to Network" notification
1280 enum Recommender {
1281
1282 // Default.
1283 RECOMMENDER_UNKNOWN = 0;
1284
1285 // Open Network Available recommender.
1286 RECOMMENDER_OPEN = 1;
1287 }
1288
1289 // Notification Type.
1290 optional Notification notification = 1;
1291
1292 // Action Type.
1293 optional Action action = 2;
1294
1295 // Recommender Type.
1296 optional Recommender recommender = 3;
1297
1298 // Occurrences of this action.
1299 optional int32 count = 4;
1300}
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001301
1302// SoftAP event tracking sessions and client counts
1303message SoftApConnectedClientsEvent {
1304
1305 // Soft AP event Types
1306 enum SoftApEventType {
1307
1308 // Soft AP is Up and ready for use
1309 SOFT_AP_UP = 0;
1310
1311 // Soft AP is Down
1312 SOFT_AP_DOWN = 1;
1313
1314 // Number of connected soft AP clients has changed
1315 NUM_CLIENTS_CHANGED = 2;
1316 }
1317
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001318 // Soft AP channel bandwidth types
1319 enum ChannelBandwidth {
1320
1321 BANDWIDTH_INVALID = 0;
1322
1323 BANDWIDTH_20_NOHT = 1;
1324
1325 BANDWIDTH_20 = 2;
1326
1327 BANDWIDTH_40 = 3;
1328
1329 BANDWIDTH_80 = 4;
1330
1331 BANDWIDTH_80P80 = 5;
1332
1333 BANDWIDTH_160 = 6;
1334 }
1335
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001336 // Type of event being recorded
1337 optional SoftApEventType event_type = 1;
1338
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001339 // Time passed since last boot in milliseconds
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001340 optional int64 time_stamp_millis = 2;
1341
1342 // Number of connected clients if event_type is NUM_CLIENTS_CHANGED, otherwise zero.
1343 optional int32 num_connected_clients = 3;
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001344
1345 // Channel frequency used for Soft AP
1346 optional int32 channel_frequency = 4;
1347
1348 // Channel bandwidth used for Soft AP
1349 optional ChannelBandwidth channel_bandwidth = 5;
Jong Wook Kim72c49ee2017-10-26 13:16:36 -07001350}
1351
1352// Wps connection metrics
1353// Keeps track of Wi-Fi Protected Setup usage
1354message WpsMetrics {
1355 // Total number of wps connection attempts
1356 optional int32 num_wps_attempts = 1;
1357
1358 // Total number of wps connection successes
1359 optional int32 num_wps_success = 2;
1360
1361 // Total number of wps failures on start
1362 optional int32 num_wps_start_failure = 3;
1363
1364 // Total number of wps overlap failure
1365 optional int32 num_wps_overlap_failure = 4;
1366
1367 // Total number of wps timeout failure
1368 optional int32 num_wps_timeout_failure = 5;
1369
1370 // Total number of other wps failure during connection
1371 optional int32 num_wps_other_connection_failure = 6;
1372
1373 // Total number of supplicant failure after wps
1374 optional int32 num_wps_supplicant_failure = 7;
1375
1376 // Total number of wps cancellation
1377 optional int32 num_wps_cancellation = 8;
1378}
Siddharth Rayac8b69a2018-01-27 18:05:44 -08001379
1380// Power stats for Wifi
1381message WifiPowerStats {
1382
1383 // Duration of log (ms)
1384 optional int64 logging_duration_ms = 1;
1385
1386 // Energy consumed by wifi (mAh)
1387 optional double energy_consumed_mah = 2;
1388
1389 // Amount of time wifi is in idle (ms)
1390 optional int64 idle_time_ms = 3;
1391
1392 // Amount of time wifi is in rx (ms)
1393 optional int64 rx_time_ms = 4;
1394
1395 // Amount of time wifi is in tx (ms)
1396 optional int64 tx_time_ms = 5;
Blake Kragten354c83d2018-12-04 16:28:44 -08001397
1398 // Amount of time kernel is active because of wifi data (ms)
1399 optional int64 wifi_kernel_active_time_ms = 6;
1400
1401 // Number of packets sent (tx)
1402 optional int64 num_packets_tx = 7;
1403
1404 // Number of bytes sent (tx)
1405 optional int64 num_bytes_tx = 8;
1406
1407 // Number of packets received (rx)
1408 optional int64 num_packets_rx = 9;
1409
1410 // Number of bytes sent (rx)
1411 optional int64 num_bytes_rx = 10;
1412
1413 // Amount of time wifi is in sleep (ms)
1414 optional int64 sleep_time_ms = 11;
1415
1416 // Amount of time wifi is scanning (ms)
1417 optional int64 scan_time_ms = 12;
Ningyuan Wang72886332017-12-20 16:17:33 -08001418}
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001419
1420// Metrics for Wifi Wake
1421message WifiWakeStats {
1422 // An individual session for Wifi Wake
1423 message Session {
1424 // A Wifi Wake lifecycle event
1425 message Event {
1426 // Elapsed time in milliseconds since start of session.
1427 optional int64 elapsed_time_millis = 1;
1428
1429 // Number of scans that have occurred since start of session.
1430 optional int32 elapsed_scans = 2;
1431 }
1432
1433 // Start time of session in milliseconds.
1434 optional int64 start_time_millis = 1;
1435
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001436 // The number of networks the lock was provided with at start.
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001437 optional int32 locked_networks_at_start = 2;
1438
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001439 // The number of networks in the lock at the time of the initialize event. Only valid if
1440 // initialize_event is recorded.
1441 optional int32 locked_networks_at_initialize = 6;
1442
1443 // Event for fully initializing the WakeupLock (i.e. WakeupLock is "locked").
1444 optional Event initialize_event = 7;
1445
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001446 // Event for unlocking the WakeupLock. Does not occur if lock was initialized with 0 networks.
1447 optional Event unlock_event = 3;
1448
1449 // Event for triggering wakeup.
1450 optional Event wakeup_event = 4;
1451
1452 // Event for WifiWake reset event. This event marks the end of a session.
1453 optional Event reset_event = 5;
1454 }
1455
1456 // Total number of sessions for Wifi Wake.
1457 optional int32 num_sessions = 1;
1458
1459 // Session information for every Wifi Wake session (up to a maximum of 10).
1460 repeated Session sessions = 2;
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001461
1462 // Number of ignored calls to start (due to WakeupController already being active).
1463 optional int32 num_ignored_starts = 3;
1464
1465 // Number of Wifi Wake sessions that have recorded wakeup events.
1466 optional int32 num_wakeups = 4;
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001467}
Etan Cohen4ec8dd32018-03-16 09:43:01 -07001468
1469// Metrics for Wi-Fi RTT
1470message WifiRttLog {
1471 // Number of RTT request API calls
1472 optional int32 num_requests = 1;
1473
1474 // Histogram of RTT operation overall status
1475 repeated RttOverallStatusHistogramBucket histogram_overall_status = 2;
1476
1477 // RTT to Access Points metrics
1478 optional RttToPeerLog rtt_to_ap = 3;
1479
1480 // RTT to Wi-Fi Aware peers metrics
1481 optional RttToPeerLog rtt_to_aware = 4;
1482
1483 // Metrics for a RTT to Peer (peer = AP or Wi-Fi Aware)
1484 message RttToPeerLog {
1485 // Total number of API calls
1486 optional int32 num_requests = 1;
1487
1488 // Total number of individual requests
1489 optional int32 num_individual_requests = 2;
1490
1491 // Total number of apps which requested RTT
1492 optional int32 num_apps = 3;
1493
1494 // Histogram of total number of RTT requests by an app (WifiRttManager#startRanging)
1495 repeated HistogramBucket histogram_num_requests_per_app = 4;
1496
1497 // Histogram of number of peers in a single RTT request (RangingRequest entries)
1498 repeated HistogramBucket histogram_num_peers_per_request = 5;
1499
1500 // Histogram of status of individual RTT operations (RangingResult entries)
1501 repeated RttIndividualStatusHistogramBucket histogram_individual_status = 6;
1502
1503 // Histogram of measured distances (RangingResult entries)
1504 repeated HistogramBucket histogram_distance = 7;
1505
1506 // Histogram of interval of RTT requests by an app (WifiRttManager#startRanging)
1507 repeated HistogramBucket histogram_request_interval_ms = 8;
1508 }
1509
Hai Shaloma18c32c2019-01-22 10:01:09 -08001510 // Histogram bucket for Wi-Fi RTT logs. Range is [start, end)
Etan Cohen4ec8dd32018-03-16 09:43:01 -07001511 message HistogramBucket {
1512 // lower range of the bucket (inclusive)
1513 optional int64 start = 1;
1514
1515 // upper range of the bucket (exclusive)
1516 optional int64 end = 2;
1517
1518 // number of samples in the bucket
1519 optional int32 count = 3;
1520 }
1521
1522 // Status codes for overall RTT operation
1523 enum RttOverallStatusTypeEnum {
1524 // constant to be used by proto
1525 OVERALL_UNKNOWN = 0;
1526
1527 // RTT operation succeeded (individual results may still fail)
1528 OVERALL_SUCCESS = 1;
1529
1530 // RTT operation failed (unspecified reason)
1531 OVERALL_FAIL = 2;
1532
1533 // RTT operation failed since RTT was not available (e.g. Airplane mode)
1534 OVERALL_RTT_NOT_AVAILABLE = 3;
1535
1536 // RTT operation timed-out: didn't receive response from HAL in expected time
1537 OVERALL_TIMEOUT = 4;
1538
1539 // RTT operation aborted since the app is spamming the service
1540 OVERALL_THROTTLE = 5;
1541
1542 // RTT request to HAL received immediate failure
1543 OVERALL_HAL_FAILURE = 6;
1544
1545 // RTT to Wi-Fi Aware peer using PeerHandle failed to get a MAC address translation
1546 OVERALL_AWARE_TRANSLATION_FAILURE = 7;
1547
1548 // RTT operation failed due to missing Location permission (post execution)
1549 OVERALL_LOCATION_PERMISSION_MISSING = 8;
1550 }
1551
1552 // Status codes for individual RTT operation
1553 enum RttIndividualStatusTypeEnum {
1554 // constant to be used by proto
1555 UNKNOWN = 0;
1556
1557 // RTT operation succeeded
1558 SUCCESS = 1;
1559
1560 // RTT failure: generic reason (no further information)
1561 FAILURE = 2;
1562
1563 // Target STA does not respond to request
1564 FAIL_NO_RSP = 3;
1565
1566 // Request rejected. Applies to 2-sided RTT only
1567 FAIL_REJECTED = 4;
1568
1569 // Operation not scheduled
1570 FAIL_NOT_SCHEDULED_YET = 5;
1571
1572 // Timing measurement times out
1573 FAIL_TM_TIMEOUT = 6;
1574
1575 // Target on different channel, cannot range
1576 FAIL_AP_ON_DIFF_CHANNEL = 7;
1577
1578 // Ranging not supported
1579 FAIL_NO_CAPABILITY = 8;
1580
1581 // Request aborted for unknown reason
1582 ABORTED = 9;
1583
1584 // Invalid T1-T4 timestamp
1585 FAIL_INVALID_TS = 10;
1586
1587 // 11mc protocol failed
1588 FAIL_PROTOCOL = 11;
1589
1590 // Request could not be scheduled
1591 FAIL_SCHEDULE = 12;
1592
1593 // Responder cannot collaborate at time of request
1594 FAIL_BUSY_TRY_LATER = 13;
1595
1596 // Bad request args
1597 INVALID_REQ = 14;
1598
1599 // WiFi not enabled
1600 NO_WIFI = 15;
1601
1602 // Responder overrides param info, cannot range with new params
1603 FAIL_FTM_PARAM_OVERRIDE = 16;
1604
1605 // HAL did not provide a result to a framework request
1606 MISSING_RESULT = 17;
1607 }
1608
1609 // Histogram bucket for Wi-Fi RTT overall operation status
1610 message RttOverallStatusHistogramBucket {
1611 // status type defining the bucket
1612 optional RttOverallStatusTypeEnum status_type = 1;
1613
1614 // number of samples in the bucket
1615 optional int32 count = 2;
1616 }
1617
1618 // Histogram bucket for Wi-Fi RTT individual operation status
1619 message RttIndividualStatusHistogramBucket {
1620 // status type defining the bucket
1621 optional RttIndividualStatusTypeEnum status_type = 1;
1622
1623 // number of samples in the bucket
1624 optional int32 count = 2;
1625 }
1626}
xshub483b722018-05-22 15:46:26 -07001627
1628// Usage data for the wifi radio while device is running on battery.
1629message WifiRadioUsage {
1630 // Duration of log (ms)
1631 optional int64 logging_duration_ms = 1;
1632
1633 // Total time for which the radio is awake due to scan.
1634 optional int64 scan_time_ms = 2;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001635}
1636
1637message ExperimentValues {
1638 // Indicates if we are logging WifiIsUnusableEvent in metrics
1639 optional bool wifi_is_unusable_logging_enabled = 1;
1640
1641 // Minimum number of txBad to trigger a data stall
1642 optional int32 wifi_data_stall_min_tx_bad = 2;
1643
1644 // Minimum number of txSuccess to trigger a data stall
1645 // when rxSuccess is 0
1646 optional int32 wifi_data_stall_min_tx_success_without_rx = 3;
Jong Wook Kime4aa37f2018-04-23 11:18:24 -07001647
1648 // Indicates if we are logging LinkSpeedCount in metrics
1649 optional bool link_speed_counts_logging_enabled = 4;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001650}
1651
1652message WifiIsUnusableEvent {
1653 enum TriggerType {
1654 // Default/Invalid event
1655 TYPE_UNKNOWN = 0;
1656
1657 // There is a data stall from tx failures
1658 TYPE_DATA_STALL_BAD_TX = 1;
1659
1660 // There is a data stall from rx failures
1661 TYPE_DATA_STALL_TX_WITHOUT_RX = 2;
1662
1663 // There is a data stall from both tx and rx failures
1664 TYPE_DATA_STALL_BOTH = 3;
1665
1666 // Firmware generated an alert
1667 TYPE_FIRMWARE_ALERT = 4;
1668 }
1669
1670 // What event triggered WifiIsUnusableEvent.
1671 optional TriggerType type = 1;
1672
1673 // The timestamp at which this event occurred.
1674 // Measured in milliseconds that have elapsed since the device booted.
1675 optional int64 start_time_millis = 2;
1676
1677 // NetworkAgent score of connected wifi.
1678 // Defaults to -1 if the score was never set.
1679 optional int32 last_score = 3 [default = -1];
1680
1681 // Delta of successfully transmitted (ACKed) unicast data packets
1682 // between the last two WifiLinkLayerStats.
1683 optional int64 tx_success_delta = 4;
1684
1685 // Delta of transmitted unicast data retry packets
1686 // between the last two WifiLinkLayerStats.
1687 optional int64 tx_retries_delta = 5;
1688
1689 // Delta of lost (not ACKed) transmitted unicast data packets
1690 // between the last two WifiLinkLayerStats.
1691 optional int64 tx_bad_delta = 6;
1692
1693 // Delta of received unicast data packets
1694 // between the last two WifiLinkLayerStats.
1695 optional int64 rx_success_delta = 7;
1696
1697 // Time in millisecond between the last two WifiLinkLayerStats.
1698 optional int64 packet_update_time_delta = 8;
1699
1700 // The timestamp at which the last WifiLinkLayerStats was updated.
1701 // Measured in milliseconds that have elapsed since the device booted.
1702 optional int64 last_link_layer_stats_update_time = 9;
1703
1704 // Firmware alert code. Only valid when the event was triggered by a firmware alert, otherwise -1.
1705 optional int32 firmware_alert_code = 10 [default = -1];
Mingguang Xuca2aab12019-01-12 23:40:42 -08001706
1707 // NetworkAgent wifi usability score of connected wifi.
1708 // Defaults to -1 if the score was never set.
1709 optional int32 last_wifi_usability_score = 11 [default = -1];
Mingguang Xue7e344a2019-01-21 16:26:45 -08001710
1711 // Prediction horizon (in second) of Wifi usability score provided by external
1712 // system app
1713 optional int32 last_prediction_horizon_sec = 12 [default = -1];
Ahmed ElArabawyba64b612018-06-15 09:17:45 -07001714}
Ecco Park5a403002018-07-23 15:53:10 -07001715
1716message PasspointProfileTypeCount {
1717 enum EapMethod {
1718 // Unknown Type
1719 TYPE_UNKNOWN = 0;
1720
1721 // EAP_TLS (13)
1722 TYPE_EAP_TLS = 1;
1723
1724 // EAP_TTLS (21)
1725 TYPE_EAP_TTLS = 2;
1726
1727 // EAP_SIM (18)
1728 TYPE_EAP_SIM = 3;
1729
1730 // EAP_AKA (23)
1731 TYPE_EAP_AKA = 4;
1732
1733 // EAP_AKA_PRIME (50)
1734 TYPE_EAP_AKA_PRIME = 5;
1735 }
1736
1737 // Eap method type set in Passpoint profile
1738 optional EapMethod eap_method_type = 1;
1739
1740 // Num of installed Passpoint profile with same eap method
1741 optional int32 count = 2;
xshu0e0dea42018-09-17 17:30:15 -07001742}
1743
1744message WifiLinkLayerUsageStats {
1745 // Total logging duration in ms.
1746 optional int64 logging_duration_ms = 1;
1747
1748 // Total time the wifi radio is on in ms over the logging duration.
1749 optional int64 radio_on_time_ms = 2;
1750
1751 // Total time the wifi radio is doing tx in ms over the logging duration.
1752 optional int64 radio_tx_time_ms = 3;
1753
1754 // Total time the wifi radio is doing rx in ms over the logging duration.
1755 optional int64 radio_rx_time_ms = 4;
1756
1757 // Total time the wifi radio is scanning in ms over the logging duration.
1758 optional int64 radio_scan_time_ms = 5;
xshu0f91dd62018-11-08 15:51:07 -08001759
1760 // Total time the wifi radio spent doing nan scans in ms over the logging duration.
1761 optional int64 radio_nan_scan_time_ms = 6;
1762
1763 // Total time the wifi radio spent doing background scans in ms over the logging duration.
1764 optional int64 radio_background_scan_time_ms = 7;
1765
1766 // Total time the wifi radio spent doing roam scans in ms over the logging duration.
1767 optional int64 radio_roam_scan_time_ms = 8;
1768
1769 // Total time the wifi radio spent doing pno scans in ms over the logging duration.
1770 optional int64 radio_pno_scan_time_ms = 9;
1771
1772 // Total time the wifi radio spent doing hotspot 2.0 scans and GAS exchange
1773 // in ms over the logging duration.
1774 optional int64 radio_hs20_scan_time_ms = 10;
xshua33726e2018-09-24 15:02:23 -07001775}
1776
1777message WifiUsabilityStatsEntry {
1778 // Absolute milliseconds from device boot when these stats were sampled
1779 optional int64 time_stamp_ms = 1;
1780
1781 // The RSSI at the sample time
1782 optional int32 rssi = 2;
1783
1784 // Link speed at the sample time in Mbps
1785 optional int32 link_speed_mbps = 3;
1786
1787 // The total number of tx success counted from the last radio chip reset
1788 optional int64 total_tx_success = 4;
1789
1790 // The total number of MPDU data packet retries counted from the last radio chip reset
1791 optional int64 total_tx_retries = 5;
1792
1793 // The total number of tx bad counted from the last radio chip reset
1794 optional int64 total_tx_bad = 6;
1795
1796 // The total number of rx success counted from the last radio chip reset
1797 optional int64 total_rx_success = 7;
1798
1799 // The total time the wifi radio is on in ms counted from the last radio chip reset
1800 optional int64 total_radio_on_time_ms = 8;
1801
1802 // The total time the wifi radio is doing tx in ms counted from the last radio chip reset
1803 optional int64 total_radio_tx_time_ms = 9;
1804
1805 // The total time the wifi radio is doing rx in ms counted from the last radio chip reset
1806 optional int64 total_radio_rx_time_ms = 10;
1807
1808 // The total time spent on all types of scans in ms counted from the last radio chip reset
1809 optional int64 total_scan_time_ms = 11;
1810
1811 // The total time spent on nan scans in ms counted from the last radio chip reset
1812 optional int64 total_nan_scan_time_ms = 12;
1813
1814 // The total time spent on background scans in ms counted from the last radio chip reset
1815 optional int64 total_background_scan_time_ms = 13;
1816
1817 // The total time spent on roam scans in ms counted from the last radio chip reset
1818 optional int64 total_roam_scan_time_ms = 14;
1819
1820 // The total time spent on pno scans in ms counted from the last radio chip reset
1821 optional int64 total_pno_scan_time_ms = 15;
1822
1823 // The total time spent on hotspot2.0 scans and GAS exchange in ms counted from the last radio
1824 // chip reset
1825 optional int64 total_hotspot_2_scan_time_ms = 16;
Mingguang Xuca2aab12019-01-12 23:40:42 -08001826
1827 // Internal framework Wifi score
1828 optional int32 wifi_score = 17;
1829
1830 // Wifi usability score provided by external system app
1831 optional int32 wifi_usability_score = 18;
1832
1833 // Sequence number from external system app to framework
1834 optional int32 seq_num_to_framework = 19;
Mingguang Xu86833142019-01-09 13:54:29 -08001835
1836 // The total time CCA is on busy status on the current frequency in ms
1837 // counted from the last radio chip reset
1838 optional int64 total_cca_busy_freq_time_ms = 20;
1839
1840 // The total radio on time of the current frequency from the last radio
1841 // chip reset
1842 optional int64 total_radio_on_freq_time_ms = 21;
1843
1844 // The total number of beacons received from the last radio chip reset
1845 optional int64 total_beacon_rx = 22;
Mingguang Xue7e344a2019-01-21 16:26:45 -08001846
1847 // Prediction horizon (in second) of Wifi usability score provided by external
1848 // system app
1849 optional int32 prediction_horizon_sec = 23;
xshua33726e2018-09-24 15:02:23 -07001850}
1851
1852message WifiUsabilityStats {
1853 enum Label {
1854 // Default label
1855 LABEL_UNKNOWN = 0;
1856
1857 // Wifi is usable
1858 LABEL_GOOD = 1;
1859
1860 // Wifi is unusable
1861 LABEL_BAD = 2;
1862 }
1863
1864 // The current wifi usability state
1865 optional Label label = 1;
1866
1867 // The list of timestamped wifi usability stats
1868 repeated WifiUsabilityStatsEntry stats = 2;
David Su367bdff2018-12-13 13:39:11 -08001869}
1870
1871message DeviceMobilityStatePnoScanStats {
1872 // see WifiManager.DEVICE_MOBILITY_STATE_* constants
1873 enum DeviceMobilityState {
1874 // Unknown mobility
1875 UNKNOWN = 0;
1876
1877 // High movement
1878 HIGH_MVMT = 1;
1879
1880 // Low movement
1881 LOW_MVMT = 2;
1882
1883 // Stationary
1884 STATIONARY = 3;
1885 }
1886
1887 // The device mobility state
1888 optional DeviceMobilityState device_mobility_state = 1;
1889
1890 // The number of times that this state was entered
1891 optional int32 num_times_entered_state = 2;
1892
1893 // The total duration elapsed while in this mobility state, in ms
1894 optional int64 total_duration_ms = 3;
1895
Hai Shaloma18c32c2019-01-22 10:01:09 -08001896
David Su367bdff2018-12-13 13:39:11 -08001897 // the total duration elapsed while in this mobility state with PNO scans running, in ms
1898 optional int64 pno_duration_ms = 4;
1899}
Jimmy Chen0142e8b2018-11-23 16:25:57 +08001900
1901// The information about the Wifi P2p events.
1902message WifiP2pStats {
1903
1904 // Group event list tracking sessions and client counts in tethered mode.
1905 repeated GroupEvent group_event = 1;
1906
1907 // Session information that gets logged for every Wifi P2p connection.
1908 repeated P2pConnectionEvent connection_event = 2;
1909
1910 // Number of persistent group in the user profile.
1911 optional int32 num_persistent_group = 3;
1912
1913 // Number of peer scan.
1914 optional int32 num_total_peer_scans = 4;
1915
1916 // Number of service scan.
1917 optional int32 num_total_service_scans = 5;
1918}
1919
1920message P2pConnectionEvent {
1921
1922 enum ConnectionType {
1923
1924 // fresh new connection.
1925 CONNECTION_FRESH = 0;
1926
1927 // reinvoke a group.
1928 CONNECTION_REINVOKE = 1;
1929
1930 // create a group with the current device as the group owner locally.
1931 CONNECTION_LOCAL = 2;
1932
1933 // create a group or join a group with config.
1934 CONNECTION_FAST = 3;
1935 }
1936
1937 enum ConnectivityLevelFailure {
1938
1939 // Failure is unknown.
1940 CLF_UNKNOWN = 0;
1941
1942 // No failure.
1943 CLF_NONE = 1;
1944
1945 // Timeout for current connecting request.
1946 CLF_TIMEOUT = 2;
1947
1948 // The connecting request is canceled by the user.
1949 CLF_CANCEL = 3;
1950
1951 // Provision discovery failure, e.g. no pin code, timeout, rejected by the peer.
1952 CLF_PROV_DISC_FAIL = 4;
1953
1954 // Invitation failure, e.g. rejected by the peer.
1955 CLF_INVITATION_FAIL = 5;
1956
1957 // Incoming request is rejected by the user.
1958 CLF_USER_REJECT = 6;
1959
1960 // New connection request is issued before ending previous connecting request.
1961 CLF_NEW_CONNECTION_ATTEMPT = 7;
1962 }
1963
1964 // WPS method.
1965 enum WpsMethod {
1966 // WPS is skipped for Group Reinvoke.
1967 WPS_NA = -1;
1968
1969 // Push button configuration.
1970 WPS_PBC = 0;
1971
1972 // Display pin method configuration - pin is generated and displayed on device.
1973 WPS_DISPLAY = 1;
1974
1975 // Keypad pin method configuration - pin is entered on device.
1976 WPS_KEYPAD = 2;
1977
1978 // Label pin method configuration - pin is labelled on device.
1979 WPS_LABEL = 3;
1980 }
1981
1982 // Start time of the connection.
1983 optional int64 start_time_millis = 1;
1984
1985 // Type of the connection.
1986 optional ConnectionType connection_type = 2;
1987
1988 // WPS method.
1989 optional WpsMethod wps_method = 3 [default = WPS_NA];
1990
1991 // Duration to connect.
1992 optional int32 duration_taken_to_connect_millis = 4;
1993
1994 // Failures that happen at the connectivity layer.
1995 optional ConnectivityLevelFailure connectivity_level_failure_code = 5;
1996}
1997
1998// GroupEvent tracking group information from GroupStarted to GroupRemoved.
1999message GroupEvent {
2000
2001 enum GroupRole {
2002
2003 GROUP_OWNER = 0;
2004
2005 GROUP_CLIENT = 1;
2006 }
2007
2008 // The ID of network in supplicant for this group.
2009 optional int32 net_id = 1;
2010
2011 // Start time of the group.
2012 optional int64 start_time_millis = 2;
2013
2014 // Channel frequency used for Group.
2015 optional int32 channel_frequency = 3;
2016
2017 // Is group owner or group client.
2018 optional GroupRole group_role = 5;
2019
2020 // Number of connected clients.
2021 optional int32 num_connected_clients = 6;
2022
2023 // Cumulative number of connected clients.
2024 optional int32 num_cumulative_clients = 7;
2025
2026 // The session duration.
2027 optional int32 session_duration_millis = 8;
2028
2029 // The idle duration. A group without any client is in idle.
2030 optional int32 idle_duration_millis = 9;
2031}
Hai Shaloma18c32c2019-01-22 10:01:09 -08002032
2033// Easy Connect (DPP)
2034message WifiDppLog {
2035 // Number of Configurator-Initiator requests
2036 optional int32 num_dpp_configurator_initiator_requests = 1;
2037
2038 // Number of Enrollee-Initiator requests
2039 optional int32 num_dpp_enrollee_initiator_requests = 2;
2040
2041 // Easy Connect (DPP) Enrollee success
2042 optional int32 num_dpp_enrollee_success = 3;
2043
2044 // Easy Connect (DPP) Configurator success code bucket
2045 repeated DppConfiguratorSuccessStatusHistogramBucket dpp_configurator_success_code = 4;
2046
2047 // Easy Connect (DPP) failure code bucket
2048 repeated DppFailureStatusHistogramBucket dpp_failure_code = 5;
2049
2050 // Easy Connect (DPP) operation time bucket
2051 repeated HistogramBucket dpp_operation_time = 6;
2052
2053 // Histogram bucket for Wi-Fi DPP configurator success
2054 message DppConfiguratorSuccessStatusHistogramBucket {
2055 // status type defining the bucket
2056 optional DppConfiguratorSuccessCode dpp_status_type = 1;
2057
2058 // number of samples in the bucket
2059 optional int32 count = 2;
2060 }
2061
2062 // Histogram bucket for Wi-Fi DPP failures
2063 message DppFailureStatusHistogramBucket {
2064 // status type defining the bucket
2065 optional DppFailureCode dpp_status_type = 1;
2066
2067 // number of samples in the bucket
2068 optional int32 count = 2;
2069 }
2070
2071 // Histogram bucket for Wi-Fi DPP logs. Range is [start, end)
2072 message HistogramBucket {
2073 // lower range of the bucket (inclusive)
2074 optional int32 start = 1;
2075
2076 // upper range of the bucket (exclusive)
2077 optional int32 end = 2;
2078
2079 // number of samples in the bucket
2080 optional int32 count = 3;
2081 }
2082
2083 enum DppConfiguratorSuccessCode {
2084 // Unknown success code
2085 EASY_CONNECT_EVENT_SUCCESS_UNKNOWN = 0;
2086
2087 // Easy Connect Configurator success event: Configuration sent to enrollee
2088 EASY_CONNECT_EVENT_SUCCESS_CONFIGURATION_SENT = 1;
2089 }
2090
2091 enum DppFailureCode {
2092 // Unknown failure
2093 EASY_CONNECT_EVENT_FAILURE_UNKNOWN = 0;
2094
2095 // Easy Connect Failure event: Scanned QR code is either not a Easy Connect URI, or the Easy
2096 // Connect URI has errors.
2097 EASY_CONNECT_EVENT_FAILURE_INVALID_URI = 1;
2098
2099 // Easy Connect Failure event: Bootstrapping/Authentication initialization process failure.
2100 EASY_CONNECT_EVENT_FAILURE_AUTHENTICATION = 2;
2101
2102 // Easy Connect Failure event: Both devices are implementing the same role and are
2103 // incompatible.
2104 EASY_CONNECT_EVENT_FAILURE_NOT_COMPATIBLE = 3;
2105
2106 // Easy Connect Failure event: Configuration process has failed due to malformed message.
2107 EASY_CONNECT_EVENT_FAILURE_CONFIGURATION = 4;
2108
2109 // Easy Connect Failure event: Easy Connect request while in another Easy Connect exchange.
2110 EASY_CONNECT_EVENT_FAILURE_BUSY = 5;
2111
2112 // Easy Connect Failure event: No response from the peer.
2113 EASY_CONNECT_EVENT_FAILURE_TIMEOUT = 6;
2114
2115 // Easy Connect Failure event: General protocol failure.
2116 EASY_CONNECT_EVENT_FAILURE_GENERIC = 7;
2117
2118 // Easy Connect Failure event: Feature or option is not supported.
2119 EASY_CONNECT_EVENT_FAILURE_NOT_SUPPORTED = 8;
2120
2121 // Easy Connect Failure event: Invalid network provided to Easy Connect configurator.
2122 // Network must either be WPA3-Personal (SAE) or WPA2-Personal (PSK).
2123 EASY_CONNECT_EVENT_FAILURE_INVALID_NETWORK = 9;
2124 }
2125}