blob: 15c04681e38f905a8ea7e30a8227acc8f65f6c91 [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
36 // Number of personal networks.
37 optional int32 num_personal_networks = 4;
38
39 // Number of enterprise networks.
40 optional int32 num_enterprise_networks = 5;
41
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
99 // Return code of the scan.
100 optional ScanReturnCode scan_return_code = 1;
101
102 // Number of entries that were found in the scan.
103 optional int32 scan_results_count = 2;
104 }
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
128 // Current WiFi state.
129 optional WifiState wifi_state = 1;
130
131 // Count of scans in state.
132 optional int32 wifi_state_count = 2;
133
134 // Is screen on.
135 optional bool is_screen_on = 3;
136 }
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
209 // Total number of scan results for personal networks
210 optional int32 num_personal_network_scan_results = 41;
211
212 // Total number of scan results for enterprise networks
213 optional int32 num_enterprise_network_scan_results = 42;
214
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;
Glen Kuhne94814572016-10-25 12:40:35 -0700476}
477
478// Information that gets logged for every WiFi connection.
479message RouterFingerPrint {
480
481 enum RoamType {
482
483 // Type is unknown.
484 ROAM_TYPE_UNKNOWN = 0;
485
486 // No roaming - usually happens on a single band (2.4 GHz) router.
487 ROAM_TYPE_NONE = 1;
488
489 // Enterprise router.
490 ROAM_TYPE_ENTERPRISE = 2;
491
492 // DBDC => Dual Band Dual Concurrent essentially a router that
493 // supports both 2.4 GHz and 5 GHz bands.
494 ROAM_TYPE_DBDC = 3;
495 }
496
497 enum Auth {
498
499 // Auth is unknown.
500 AUTH_UNKNOWN = 0;
501
502 // No authentication.
503 AUTH_OPEN = 1;
504
505 // If the router uses a personal authentication.
506 AUTH_PERSONAL = 2;
507
508 // If the router is setup for enterprise authentication.
509 AUTH_ENTERPRISE = 3;
510 }
511
512 enum RouterTechnology {
513
514 // Router is unknown.
515 ROUTER_TECH_UNKNOWN = 0;
516
517 // Router Channel A.
518 ROUTER_TECH_A = 1;
519
520 // Router Channel B.
521 ROUTER_TECH_B = 2;
522
523 // Router Channel G.
524 ROUTER_TECH_G = 3;
525
526 // Router Channel N.
527 ROUTER_TECH_N = 4;
528
529 // Router Channel AC.
530 ROUTER_TECH_AC = 5;
531
532 // When the channel is not one of the above.
533 ROUTER_TECH_OTHER = 6;
534 }
535
536 optional RoamType roam_type = 1;
537
538 // Channel on which the connection takes place.
539 optional int32 channel_info = 2;
540
541 // DTIM setting of the router.
542 optional int32 dtim = 3;
543
544 // Authentication scheme of the router.
545 optional Auth authentication = 4;
546
547 // If the router is hidden.
548 optional bool hidden = 5;
549
550 // Channel information.
551 optional RouterTechnology router_technology = 6;
552
553 // whether ipv6 is supported.
554 optional bool supports_ipv6 = 7;
555
556 // If the router is a passpoint / hotspot 2.0 network
557 optional bool passpoint = 8;
558}
559
560message ConnectionEvent {
561
562 // Roam Type.
563 enum RoamType {
564
565 // Type is unknown.
566 ROAM_UNKNOWN = 0;
567
568 // No roaming.
569 ROAM_NONE = 1;
570
571 // DBDC roaming.
572 ROAM_DBDC = 2;
573
574 // Enterprise roaming.
575 ROAM_ENTERPRISE = 3;
576
577 // User selected roaming.
578 ROAM_USER_SELECTED = 4;
579
580 // Unrelated.
581 ROAM_UNRELATED = 5;
582 }
583
584 // Connectivity Level Failure.
585 enum ConnectivityLevelFailure {
586
587 // Failure is unknown.
588 HLF_UNKNOWN = 0;
589
590 // No failure.
591 HLF_NONE = 1;
592
593 // DHCP failure.
594 HLF_DHCP = 2;
595
596 // No internet connection.
597 HLF_NO_INTERNET = 3;
598
599 // No internet connection.
600 HLF_UNWANTED = 4;
601 }
602
603 // Start time of the connection.
604 optional int64 start_time_millis = 1;// [(datapol.semantic_type) = ST_TIMESTAMP];
605
606 // Duration to connect.
607 optional int32 duration_taken_to_connect_millis = 2;
608
609 // Router information.
610 optional RouterFingerPrint router_fingerprint = 3;
611
612 // RSSI at the start of the connection.
613 optional int32 signal_strength = 4;
614
615 // Roam Type.
616 optional RoamType roam_type = 5;
617
618 // Result of the connection.
619 optional int32 connection_result = 6;
620
621 // Reasons for level 2 failure (needs to be coordinated with wpa-supplicant).
622 optional int32 level_2_failure_code = 7;
623
624 // Failures that happen at the connectivity layer.
625 optional ConnectivityLevelFailure connectivity_level_failure_code = 8;
626
627 // Has bug report been taken.
628 optional bool automatic_bug_report_taken = 9;
629}
630
631// Number of occurrences of a specific RSSI poll rssi value
632message RssiPollCount {
633 // RSSI
634 optional int32 rssi = 1;
635
636 // Number of RSSI polls with 'rssi'
637 optional int32 count = 2;
xshu122886e2018-05-16 15:38:49 -0700638
639 // Beacon frequency of the channel in MHz
640 optional int32 frequency = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700641}
642
643// Number of occurrences of a specific alert reason value
644message AlertReasonCount {
645 // Alert reason
646 optional int32 reason = 1;
647
648 // Number of alerts with |reason|.
649 optional int32 count = 2;
650}
651
652// Counts the number of instances of a specific Wifi Score calculated by WifiScoreReport
653message WifiScoreCount {
654 // Wifi Score
655 optional int32 score = 1;
656
657 // Number of Wifi score reports with this score
658 optional int32 count = 2;
659}
660
Jong Wook Kime4aa37f2018-04-23 11:18:24 -0700661// Number of occurrences of a specific link speed (Mbps)
662// and sum of rssi (dBm) and rssi^2 (dBm^2)
663message LinkSpeedCount {
664 // Link speed (Mbps)
665 optional int32 link_speed_mbps = 1;
666
667 // Number of RSSI polls with link_speed
668 optional int32 count = 2;
669
670 // Sum of absolute values of rssi values (dBm)
671 optional int32 rssi_sum_dbm = 3;
672
673 // Sum of squares of rssi values (dBm^2)
674 optional int64 rssi_sum_of_squares_dbm_sq = 4;
675}
676
Glen Kuhne94814572016-10-25 12:40:35 -0700677// Number of occurrences of Soft AP session durations
678message SoftApDurationBucket {
679 // Bucket covers duration : [duration_sec, duration_sec + bucket_size_sec)
680 // The (inclusive) lower bound of Soft AP session duration represented by this bucket
681 optional int32 duration_sec = 1;
682
683 // The size of this bucket
684 optional int32 bucket_size_sec = 2;
685
686 // Number of soft AP session durations that fit into this bucket
687 optional int32 count = 3;
688}
689
690// Number of occurrences of a soft AP session return code
691message SoftApReturnCodeCount {
Rebecca Silberstein28d9de22017-01-24 10:42:59 -0800692
693 enum SoftApStartResult {
694
695 // SoftApManager return code unknown
696 SOFT_AP_RETURN_CODE_UNKNOWN = 0;
697
698 // SoftAp started successfully
699 SOFT_AP_STARTED_SUCCESSFULLY = 1;
700
701 // Catch all for failures with no specific failure reason
702 SOFT_AP_FAILED_GENERAL_ERROR = 2;
703
704 // SoftAp failed to start due to NO_CHANNEL error
705 SOFT_AP_FAILED_NO_CHANNEL = 3;
706 }
707
708 // Historical, no longer used for writing as of 01/2017.
709 optional int32 return_code = 1 [deprecated = true];
Glen Kuhne94814572016-10-25 12:40:35 -0700710
711 // Occurrences of this soft AP return code
712 optional int32 count = 2;
Rebecca Silberstein28d9de22017-01-24 10:42:59 -0800713
714 // Result of attempt to start SoftAp
715 optional SoftApStartResult start_result = 3;
Glen Kuhne94814572016-10-25 12:40:35 -0700716}
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700717
718message StaEvent {
719 message ConfigInfo {
720 // The set of key management protocols supported by this configuration.
721 optional uint32 allowed_key_management = 1 [default = 0];
722
723 // The set of security protocols supported by this configuration.
724 optional uint32 allowed_protocols = 2 [default = 0];
725
726 // The set of authentication protocols supported by this configuration.
727 optional uint32 allowed_auth_algorithms = 3 [default = 0];
728
729 // The set of pairwise ciphers for WPA supported by this configuration.
730 optional uint32 allowed_pairwise_ciphers = 4 [default = 0];
731
732 // The set of group ciphers supported by this configuration.
733 optional uint32 allowed_group_ciphers = 5;
734
735 // Is this a 'hidden network'
736 optional bool hidden_ssid = 6;
737
738 // Is this a Hotspot 2.0 / passpoint network
739 optional bool is_passpoint = 7;
740
741 // Is this an 'ephemeral' network (Not in saved network list, recommended externally)
742 optional bool is_ephemeral = 8;
743
744 // Has a successful connection ever been established using this WifiConfiguration
745 optional bool has_ever_connected = 9;
746
747 // RSSI of the scan result candidate associated with this WifiConfiguration
748 optional int32 scan_rssi = 10 [default = -127];
749
750 // Frequency of the scan result candidate associated with this WifiConfiguration
751 optional int32 scan_freq = 11 [default = -1];
752 }
753
754 enum EventType {
755 // Default/Invalid event
756 TYPE_UNKNOWN = 0;
757
758 // Supplicant Association Rejection event. Code contains the 802.11
759 TYPE_ASSOCIATION_REJECTION_EVENT = 1;
760
761 // Supplicant L2 event,
762 TYPE_AUTHENTICATION_FAILURE_EVENT = 2;
763
764 // Supplicant L2 event
765 TYPE_NETWORK_CONNECTION_EVENT = 3;
766
767 // Supplicant L2 event
768 TYPE_NETWORK_DISCONNECTION_EVENT = 4;
769
770 // Supplicant L2 event
771 TYPE_SUPPLICANT_STATE_CHANGE_EVENT = 5;
772
773 // Supplicant L2 event
774 TYPE_CMD_ASSOCIATED_BSSID = 6;
775
776 // IP Manager successfully completed IP Provisioning
777 TYPE_CMD_IP_CONFIGURATION_SUCCESSFUL = 7;
778
779 // IP Manager failed to complete IP Provisioning
780 TYPE_CMD_IP_CONFIGURATION_LOST = 8;
781
782 // IP Manager lost reachability to network neighbors
783 TYPE_CMD_IP_REACHABILITY_LOST = 9;
784
785 // Indicator that Supplicant is targeting a BSSID for roam/connection
786 TYPE_CMD_TARGET_BSSID = 10;
787
788 // Wifi framework is initiating a connection attempt
789 TYPE_CMD_START_CONNECT = 11;
790
791 // Wifi framework is initiating a roaming connection attempt
792 TYPE_CMD_START_ROAM = 12;
793
794 // SystemAPI connect() command, Settings App
795 TYPE_CONNECT_NETWORK = 13;
796
797 // Network Agent has validated the internet connection (Captive Portal Check success, or user
798 // validation)
799 TYPE_NETWORK_AGENT_VALID_NETWORK = 14;
800
801 // Framework initiated disconnect. Sometimes generated to give an extra reason for a disconnect
802 // Should typically be followed by a NETWORK_DISCONNECTION_EVENT with a local_gen = true
803 TYPE_FRAMEWORK_DISCONNECT = 15;
Michael Plassbb367b62017-10-06 10:29:51 -0700804
805 // The NetworkAgent score for wifi has changed in a way that may impact
806 // connectivity
807 TYPE_SCORE_BREACH = 16;
Jong Wook Kim01ad38b2018-04-09 10:14:11 -0700808
809 // Framework changed Sta interface MAC address
810 TYPE_MAC_CHANGE = 17;
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700811 }
812
813 enum FrameworkDisconnectReason {
814 // default/none/unknown value
815 DISCONNECT_UNKNOWN = 0;
816
817 // API DISCONNECT
818 DISCONNECT_API = 1;
819
820 // Some framework internal reason (generic)
821 DISCONNECT_GENERIC = 2;
822
823 // Network Agent network validation failed, user signaled network unwanted
824 DISCONNECT_UNWANTED = 3;
825
826 // Roaming timed out
827 DISCONNECT_ROAM_WATCHDOG_TIMER = 4;
828
829 // P2P service requested wifi disconnect
830 DISCONNECT_P2P_DISCONNECT_WIFI_REQUEST = 5;
831
832 // SIM was removed while using a SIM config
833 DISCONNECT_RESET_SIM_NETWORKS = 6;
834 }
835
836 // Authentication Failure reasons as reported through the API.
837 enum AuthFailureReason {
838 // Unknown default
839 AUTH_FAILURE_UNKNOWN = 0;
840
841 // The reason code if there is no error during authentication. It could also imply that there no
842 // authentication in progress,
843 AUTH_FAILURE_NONE = 1;
844
845 // The reason code if there was a timeout authenticating.
846 AUTH_FAILURE_TIMEOUT = 2;
847
848 // The reason code if there was a wrong password while authenticating.
849 AUTH_FAILURE_WRONG_PSWD = 3;
850
851 // The reason code if there was EAP failure while authenticating.
852 AUTH_FAILURE_EAP_FAILURE = 4;
853 }
854
855 // What event was this
856 optional EventType type = 1;
857
858 // 80211 death reason code, relevant to NETWORK_DISCONNECTION_EVENTs
859 optional int32 reason = 2 [default = -1];
860
861 // 80211 Association Status code, relevant to ASSOCIATION_REJECTION_EVENTs
862 optional int32 status = 3 [default = -1];
863
864 // Designates whether a NETWORK_DISCONNECT_EVENT was by the STA or AP
865 optional bool local_gen = 4 [default = false];
866
867 // Network information from the WifiConfiguration of a framework initiated connection attempt
868 optional ConfigInfo config_info = 5;
869
870 // RSSI from the last rssi poll (Only valid for active connections)
871 optional int32 last_rssi = 6 [default = -127];
872
873 // Link speed from the last rssi poll (Only valid for active connections)
874 optional int32 last_link_speed = 7 [default = -1];
875
876 // Frequency from the last rssi poll (Only valid for active connections)
877 optional int32 last_freq = 8 [default = -1];
878
879 // Enum used to define bit positions in the supplicant_state_change_bitmask
880 // See {@code frameworks/base/wifi/java/android/net/wifi/SupplicantState.java} for documentation
881 enum SupplicantState {
882 STATE_DISCONNECTED = 0;
883
884 STATE_INTERFACE_DISABLED = 1;
885
886 STATE_INACTIVE = 2;
887
888 STATE_SCANNING = 3;
889
890 STATE_AUTHENTICATING = 4;
891
892 STATE_ASSOCIATING = 5;
893
894 STATE_ASSOCIATED = 6;
895
896 STATE_FOUR_WAY_HANDSHAKE = 7;
897
898 STATE_GROUP_HANDSHAKE = 8;
899
900 STATE_COMPLETED = 9;
901
902 STATE_DORMANT = 10;
903
904 STATE_UNINITIALIZED = 11;
905
906 STATE_INVALID = 12;
907 }
908
Jong Wook Kim411cab92018-04-26 15:09:23 -0700909 // Bit mask of all supplicant state changes that occurred since the last event
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700910 optional uint32 supplicant_state_changes_bitmask = 9 [default = 0];
911
912 // The number of milliseconds that have elapsed since the device booted
913 optional int64 start_time_millis = 10 [default = 0];
914
915 optional FrameworkDisconnectReason framework_disconnect_reason = 11 [default = DISCONNECT_UNKNOWN];
916
Jong Wook Kim411cab92018-04-26 15:09:23 -0700917 // Flag which indicates if an association rejection event occurred due to a timeout
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700918 optional bool association_timed_out = 12 [default = false];
919
920 // Authentication failure reason, as reported by WifiManager (calculated from state & deauth code)
921 optional AuthFailureReason auth_failure_reason = 13 [default = AUTH_FAILURE_UNKNOWN];
Michael Plassbb367b62017-10-06 10:29:51 -0700922
923 // NetworkAgent score of connected wifi
924 optional int32 last_score = 14 [default = -1];
Glen Kuhne8ce9a1c2017-03-28 14:02:48 -0700925}
Etan Cohen737addc2017-04-26 08:01:57 -0700926
927// Wi-Fi Aware metrics
928message WifiAwareLog {
929 // total number of unique apps that used Aware (measured on attach)
930 optional int32 num_apps = 1;
931
932 // total number of unique apps that used an identity callback when attaching
933 optional int32 num_apps_using_identity_callback = 2;
934
935 // maximum number of attaches for an app
936 optional int32 max_concurrent_attach_sessions_in_app = 3;
937
938 // histogram of attach request results
939 repeated NanStatusHistogramBucket histogram_attach_session_status = 4;
940
941 // maximum number of concurrent publish sessions in a single app
942 optional int32 max_concurrent_publish_in_app = 5;
943
944 // maximum number of concurrent subscribe sessions in a single app
945 optional int32 max_concurrent_subscribe_in_app = 6;
946
947 // maximum number of concurrent discovery (publish+subscribe) sessions in a single app
948 optional int32 max_concurrent_discovery_sessions_in_app = 7;
949
950 // maximum number of concurrent publish sessions in the system
951 optional int32 max_concurrent_publish_in_system = 8;
952
953 // maximum number of concurrent subscribe sessions in the system
954 optional int32 max_concurrent_subscribe_in_system = 9;
955
956 // maximum number of concurrent discovery (publish+subscribe) sessions in the system
957 optional int32 max_concurrent_discovery_sessions_in_system = 10;
958
959 // histogram of publish request results
960 repeated NanStatusHistogramBucket histogram_publish_status = 11;
961
962 // histogram of subscribe request results
963 repeated NanStatusHistogramBucket histogram_subscribe_status = 12;
964
965 // number of unique apps which experienced a discovery session creation failure due to lack of
966 // resources
967 optional int32 num_apps_with_discovery_session_failure_out_of_resources = 13;
968
969 // histogram of create ndp request results
970 repeated NanStatusHistogramBucket histogram_request_ndp_status = 14;
971
972 // histogram of create ndp out-of-band (OOB) request results
973 repeated NanStatusHistogramBucket histogram_request_ndp_oob_status = 15;
974
975 // maximum number of concurrent active data-interfaces (NDI) in a single app
976 optional int32 max_concurrent_ndi_in_app = 19;
977
978 // maximum number of concurrent active data-interfaces (NDI) in the system
979 optional int32 max_concurrent_ndi_in_system = 20;
980
981 // maximum number of concurrent data-paths (NDP) in a single app
982 optional int32 max_concurrent_ndp_in_app = 21;
983
984 // maximum number of concurrent data-paths (NDP) in the system
985 optional int32 max_concurrent_ndp_in_system = 22;
986
987 // maximum number of concurrent secure data-paths (NDP) in a single app
988 optional int32 max_concurrent_secure_ndp_in_app = 23;
989
990 // maximum number of concurrent secure data-paths (NDP) in the system
991 optional int32 max_concurrent_secure_ndp_in_system = 24;
992
993 // maximum number of concurrent data-paths (NDP) per data-interface (NDI)
994 optional int32 max_concurrent_ndp_per_ndi = 25;
995
996 // histogram of durations of Aware being available
997 repeated HistogramBucket histogram_aware_available_duration_ms = 26;
998
999 // histogram of durations of Aware being enabled
1000 repeated HistogramBucket histogram_aware_enabled_duration_ms = 27;
1001
1002 // histogram of duration (in ms) of attach sessions
1003 repeated HistogramBucket histogram_attach_duration_ms = 28;
1004
1005 // histogram of duration (in ms) of publish sessions
1006 repeated HistogramBucket histogram_publish_session_duration_ms = 29;
1007
1008 // histogram of duration (in ms) of subscribe sessions
1009 repeated HistogramBucket histogram_subscribe_session_duration_ms = 30;
1010
1011 // histogram of duration (in ms) of data-paths (NDP)
1012 repeated HistogramBucket histogram_ndp_session_duration_ms = 31;
1013
1014 // histogram of usage (in MB) of data-paths (NDP)
1015 repeated HistogramBucket histogram_ndp_session_data_usage_mb = 32;
1016
1017 // histogram of usage (in MB) of data-path creation time (in ms) measured as request -> confirm
1018 repeated HistogramBucket histogram_ndp_creation_time_ms = 33;
1019
1020 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: minimum
1021 optional int64 ndp_creation_time_ms_min = 34;
1022
1023 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: maximum
1024 optional int64 ndp_creation_time_ms_max = 35;
1025
1026 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: sum
1027 optional int64 ndp_creation_time_ms_sum = 36;
1028
1029 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: sum of sq
1030 optional int64 ndp_creation_time_ms_sum_of_sq = 37;
1031
1032 // statistics for data-path (NDP) creation time (in ms) measured as request -> confirm: number of
1033 // samples
1034 optional int64 ndp_creation_time_ms_num_samples = 38;
1035
1036 // total time within the logging window that aware was available
1037 optional int64 available_time_ms = 39;
1038
1039 // total time within the logging window that aware was enabled
1040 optional int64 enabled_time_ms = 40;
1041
Etan Cohenfa723572018-03-13 07:25:50 -07001042 // maximum number of concurrent publish sessions enabling ranging in a single app
1043 optional int32 max_concurrent_publish_with_ranging_in_app = 41;
1044
1045 // maximum number of concurrent subscribe sessions specifying a geofence in a single app
1046 optional int32 max_concurrent_subscribe_with_ranging_in_app = 42;
1047
1048 // maximum number of concurrent publish sessions enabling ranging in the system
1049 optional int32 max_concurrent_publish_with_ranging_in_system = 43;
1050
1051 // maximum number of concurrent subscribe sessions specifying a geofence in the system
1052 optional int32 max_concurrent_subscribe_with_ranging_in_system = 44;
1053
1054 // histogram of subscribe session geofence minimum (only when specified)
1055 repeated HistogramBucket histogram_subscribe_geofence_min = 45;
1056
1057 // histogram of subscribe session geofence maximum (only when specified)
1058 repeated HistogramBucket histogram_subscribe_geofence_max = 46;
1059
1060 // total number of subscribe sessions which enabled ranging
1061 optional int32 num_subscribes_with_ranging = 47;
1062
1063 // total number of matches (service discovery indication) with ranging provided
1064 optional int32 num_matches_with_ranging = 48;
1065
1066 // total number of matches (service discovery indication) for service discovery with ranging
1067 // enabled which did not trigger ranging
1068 optional int32 num_matches_without_ranging_for_ranging_enabled_subscribes = 49;
1069
Etan Cohen737addc2017-04-26 08:01:57 -07001070 // Histogram bucket for Wi-Fi Aware logs. Range is [start, end)
1071 message HistogramBucket {
1072 // lower range of the bucket (inclusive)
1073 optional int64 start = 1;
1074
1075 // upper range of the bucket (exclusive)
1076 optional int64 end = 2;
1077
1078 // number of samples in the bucket
1079 optional int32 count = 3;
1080 }
1081
1082 // Status of various NAN operations
1083 enum NanStatusTypeEnum {
1084 // constant to be used by proto
1085 UNKNOWN = 0;
1086
1087 // NAN operation succeeded
1088 SUCCESS = 1;
1089
1090 // NAN Discovery Engine/Host driver failures
1091 INTERNAL_FAILURE = 2;
1092
1093 // NAN OTA failures
1094 PROTOCOL_FAILURE = 3;
1095
1096 // The publish/subscribe discovery session id is invalid
1097 INVALID_SESSION_ID = 4;
1098
1099 // Out of resources to fufill request
1100 NO_RESOURCES_AVAILABLE = 5;
1101
1102 // Invalid arguments passed
1103 INVALID_ARGS = 6;
1104
1105 // Invalid peer id
1106 INVALID_PEER_ID = 7;
1107
1108 // Invalid NAN data-path (ndp) id
1109 INVALID_NDP_ID = 8;
1110
1111 // Attempting to enable NAN when not available, e.g. wifi is disabled
1112 NAN_NOT_ALLOWED = 9;
1113
1114 // Over the air ACK not received
1115 NO_OTA_ACK = 10;
1116
1117 // Attempting to enable NAN when already enabled
1118 ALREADY_ENABLED = 11;
1119
1120 // Can't queue tx followup message foor transmission
1121 FOLLOWUP_TX_QUEUE_FULL = 12;
1122
1123 // Unsupported concurrency of NAN and another feature - NAN disabled
1124 UNSUPPORTED_CONCURRENCY_NAN_DISABLED = 13;
1125
1126 // Unknown NanStatusType
1127 UNKNOWN_HAL_STATUS = 14;
1128 }
1129
1130 // Histogram bucket for Wi-Fi Aware (NAN) status.
1131 message NanStatusHistogramBucket {
1132 // status type defining the bucket
1133 optional NanStatusTypeEnum nan_status_type = 1;
1134
1135 // number of samples in the bucket
1136 optional int32 count = 2;
1137 }
1138}
1139
Glen Kuhnee2d67c02017-04-25 13:08:29 -07001140// Data point used to build 'Number of Connectable Network' histograms
1141message NumConnectableNetworksBucket {
1142 // Number of connectable networks seen in a scan result
1143 optional int32 num_connectable_networks = 1 [default = 0];
1144
1145 // Number of scan results with num_connectable_networks
1146 optional int32 count = 2 [default = 0];
1147}
Mehdi Alizadehd9163cf2017-08-10 18:20:25 -07001148
1149// Pno scan metrics
1150// Here "Pno Scan" refers to the session of offloaded scans, these metrics count the result of a
1151// single session, and not the individual scans within that session.
1152message PnoScanMetrics {
1153 // Total number of attempts to offload pno scans
1154 optional int32 num_pno_scan_attempts = 1;
1155
1156 // Total number of pno scans failed
1157 optional int32 num_pno_scan_failed = 2;
1158
1159 // Number of pno scans started successfully over offload
1160 optional int32 num_pno_scan_started_over_offload = 3;
1161
1162 // Number of pno scans failed over offload
1163 optional int32 num_pno_scan_failed_over_offload = 4;
1164
1165 // Total number of pno scans that found any network
1166 optional int32 num_pno_found_network_events = 5;
1167}
Stephen Chenfc0facb2017-09-14 14:35:15 -07001168
1169// Number of occurrences for a particular "Connect to Network" Notification or
1170// notification Action.
1171message ConnectToNetworkNotificationAndActionCount {
1172
1173 // "Connect to Network" notifications
1174 enum Notification {
1175
1176 // Default
1177 NOTIFICATION_UNKNOWN = 0;
1178
1179 // Initial notification with a recommended network.
1180 NOTIFICATION_RECOMMEND_NETWORK = 1;
1181
1182 // Notification when connecting to the recommended network.
1183 NOTIFICATION_CONNECTING_TO_NETWORK = 2;
1184
1185 // Notification when successfully connected to the network.
1186 NOTIFICATION_CONNECTED_TO_NETWORK = 3;
1187
1188 // Notification when failed to connect to network.
1189 NOTIFICATION_FAILED_TO_CONNECT = 4;
1190 }
1191
1192 // "Connect to Network" notification actions
1193 enum Action {
1194
1195 // Default
1196 ACTION_UNKNOWN = 0;
1197
1198 // User dismissed the "Connect to Network" notification.
1199 ACTION_USER_DISMISSED_NOTIFICATION = 1;
1200
1201 // User tapped action button to connect to recommended network.
1202 ACTION_CONNECT_TO_NETWORK = 2;
1203
1204 // User tapped action button to open Wi-Fi Settings.
1205 ACTION_PICK_WIFI_NETWORK = 3;
1206
1207 // User tapped "Failed to connect" notification to open Wi-Fi Settings.
1208 ACTION_PICK_WIFI_NETWORK_AFTER_CONNECT_FAILURE = 4;
1209 }
1210
1211 // Recommenders of the "Connect to Network" notification
1212 enum Recommender {
1213
1214 // Default.
1215 RECOMMENDER_UNKNOWN = 0;
1216
1217 // Open Network Available recommender.
1218 RECOMMENDER_OPEN = 1;
1219 }
1220
1221 // Notification Type.
1222 optional Notification notification = 1;
1223
1224 // Action Type.
1225 optional Action action = 2;
1226
1227 // Recommender Type.
1228 optional Recommender recommender = 3;
1229
1230 // Occurrences of this action.
1231 optional int32 count = 4;
1232}
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001233
1234// SoftAP event tracking sessions and client counts
1235message SoftApConnectedClientsEvent {
1236
1237 // Soft AP event Types
1238 enum SoftApEventType {
1239
1240 // Soft AP is Up and ready for use
1241 SOFT_AP_UP = 0;
1242
1243 // Soft AP is Down
1244 SOFT_AP_DOWN = 1;
1245
1246 // Number of connected soft AP clients has changed
1247 NUM_CLIENTS_CHANGED = 2;
1248 }
1249
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001250 // Soft AP channel bandwidth types
1251 enum ChannelBandwidth {
1252
1253 BANDWIDTH_INVALID = 0;
1254
1255 BANDWIDTH_20_NOHT = 1;
1256
1257 BANDWIDTH_20 = 2;
1258
1259 BANDWIDTH_40 = 3;
1260
1261 BANDWIDTH_80 = 4;
1262
1263 BANDWIDTH_80P80 = 5;
1264
1265 BANDWIDTH_160 = 6;
1266 }
1267
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001268 // Type of event being recorded
1269 optional SoftApEventType event_type = 1;
1270
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001271 // Time passed since last boot in milliseconds
Mehdi Alizadeh2a59c52ca2017-10-18 15:42:35 -07001272 optional int64 time_stamp_millis = 2;
1273
1274 // Number of connected clients if event_type is NUM_CLIENTS_CHANGED, otherwise zero.
1275 optional int32 num_connected_clients = 3;
Mehdi Alizadeh24498192018-03-15 13:02:51 -07001276
1277 // Channel frequency used for Soft AP
1278 optional int32 channel_frequency = 4;
1279
1280 // Channel bandwidth used for Soft AP
1281 optional ChannelBandwidth channel_bandwidth = 5;
Jong Wook Kim72c49ee2017-10-26 13:16:36 -07001282}
1283
1284// Wps connection metrics
1285// Keeps track of Wi-Fi Protected Setup usage
1286message WpsMetrics {
1287 // Total number of wps connection attempts
1288 optional int32 num_wps_attempts = 1;
1289
1290 // Total number of wps connection successes
1291 optional int32 num_wps_success = 2;
1292
1293 // Total number of wps failures on start
1294 optional int32 num_wps_start_failure = 3;
1295
1296 // Total number of wps overlap failure
1297 optional int32 num_wps_overlap_failure = 4;
1298
1299 // Total number of wps timeout failure
1300 optional int32 num_wps_timeout_failure = 5;
1301
1302 // Total number of other wps failure during connection
1303 optional int32 num_wps_other_connection_failure = 6;
1304
1305 // Total number of supplicant failure after wps
1306 optional int32 num_wps_supplicant_failure = 7;
1307
1308 // Total number of wps cancellation
1309 optional int32 num_wps_cancellation = 8;
1310}
Siddharth Rayac8b69a2018-01-27 18:05:44 -08001311
1312// Power stats for Wifi
1313message WifiPowerStats {
1314
1315 // Duration of log (ms)
1316 optional int64 logging_duration_ms = 1;
1317
1318 // Energy consumed by wifi (mAh)
1319 optional double energy_consumed_mah = 2;
1320
1321 // Amount of time wifi is in idle (ms)
1322 optional int64 idle_time_ms = 3;
1323
1324 // Amount of time wifi is in rx (ms)
1325 optional int64 rx_time_ms = 4;
1326
1327 // Amount of time wifi is in tx (ms)
1328 optional int64 tx_time_ms = 5;
Ningyuan Wang72886332017-12-20 16:17:33 -08001329}
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001330
1331// Metrics for Wifi Wake
1332message WifiWakeStats {
1333 // An individual session for Wifi Wake
1334 message Session {
1335 // A Wifi Wake lifecycle event
1336 message Event {
1337 // Elapsed time in milliseconds since start of session.
1338 optional int64 elapsed_time_millis = 1;
1339
1340 // Number of scans that have occurred since start of session.
1341 optional int32 elapsed_scans = 2;
1342 }
1343
1344 // Start time of session in milliseconds.
1345 optional int64 start_time_millis = 1;
1346
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001347 // The number of networks the lock was provided with at start.
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001348 optional int32 locked_networks_at_start = 2;
1349
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001350 // The number of networks in the lock at the time of the initialize event. Only valid if
1351 // initialize_event is recorded.
1352 optional int32 locked_networks_at_initialize = 6;
1353
1354 // Event for fully initializing the WakeupLock (i.e. WakeupLock is "locked").
1355 optional Event initialize_event = 7;
1356
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001357 // Event for unlocking the WakeupLock. Does not occur if lock was initialized with 0 networks.
1358 optional Event unlock_event = 3;
1359
1360 // Event for triggering wakeup.
1361 optional Event wakeup_event = 4;
1362
1363 // Event for WifiWake reset event. This event marks the end of a session.
1364 optional Event reset_event = 5;
1365 }
1366
1367 // Total number of sessions for Wifi Wake.
1368 optional int32 num_sessions = 1;
1369
1370 // Session information for every Wifi Wake session (up to a maximum of 10).
1371 repeated Session sessions = 2;
Eric Schwarzenbach3cad6242018-03-26 10:23:40 -07001372
1373 // Number of ignored calls to start (due to WakeupController already being active).
1374 optional int32 num_ignored_starts = 3;
1375
1376 // Number of Wifi Wake sessions that have recorded wakeup events.
1377 optional int32 num_wakeups = 4;
Eric Schwarzenbach9f941f92018-02-16 11:10:30 -08001378}
Etan Cohen4ec8dd32018-03-16 09:43:01 -07001379
1380// Metrics for Wi-Fi RTT
1381message WifiRttLog {
1382 // Number of RTT request API calls
1383 optional int32 num_requests = 1;
1384
1385 // Histogram of RTT operation overall status
1386 repeated RttOverallStatusHistogramBucket histogram_overall_status = 2;
1387
1388 // RTT to Access Points metrics
1389 optional RttToPeerLog rtt_to_ap = 3;
1390
1391 // RTT to Wi-Fi Aware peers metrics
1392 optional RttToPeerLog rtt_to_aware = 4;
1393
1394 // Metrics for a RTT to Peer (peer = AP or Wi-Fi Aware)
1395 message RttToPeerLog {
1396 // Total number of API calls
1397 optional int32 num_requests = 1;
1398
1399 // Total number of individual requests
1400 optional int32 num_individual_requests = 2;
1401
1402 // Total number of apps which requested RTT
1403 optional int32 num_apps = 3;
1404
1405 // Histogram of total number of RTT requests by an app (WifiRttManager#startRanging)
1406 repeated HistogramBucket histogram_num_requests_per_app = 4;
1407
1408 // Histogram of number of peers in a single RTT request (RangingRequest entries)
1409 repeated HistogramBucket histogram_num_peers_per_request = 5;
1410
1411 // Histogram of status of individual RTT operations (RangingResult entries)
1412 repeated RttIndividualStatusHistogramBucket histogram_individual_status = 6;
1413
1414 // Histogram of measured distances (RangingResult entries)
1415 repeated HistogramBucket histogram_distance = 7;
1416
1417 // Histogram of interval of RTT requests by an app (WifiRttManager#startRanging)
1418 repeated HistogramBucket histogram_request_interval_ms = 8;
1419 }
1420
1421 // Histogram bucket for Wi-Fi RTT logs. Range is [start, end)
1422 message HistogramBucket {
1423 // lower range of the bucket (inclusive)
1424 optional int64 start = 1;
1425
1426 // upper range of the bucket (exclusive)
1427 optional int64 end = 2;
1428
1429 // number of samples in the bucket
1430 optional int32 count = 3;
1431 }
1432
1433 // Status codes for overall RTT operation
1434 enum RttOverallStatusTypeEnum {
1435 // constant to be used by proto
1436 OVERALL_UNKNOWN = 0;
1437
1438 // RTT operation succeeded (individual results may still fail)
1439 OVERALL_SUCCESS = 1;
1440
1441 // RTT operation failed (unspecified reason)
1442 OVERALL_FAIL = 2;
1443
1444 // RTT operation failed since RTT was not available (e.g. Airplane mode)
1445 OVERALL_RTT_NOT_AVAILABLE = 3;
1446
1447 // RTT operation timed-out: didn't receive response from HAL in expected time
1448 OVERALL_TIMEOUT = 4;
1449
1450 // RTT operation aborted since the app is spamming the service
1451 OVERALL_THROTTLE = 5;
1452
1453 // RTT request to HAL received immediate failure
1454 OVERALL_HAL_FAILURE = 6;
1455
1456 // RTT to Wi-Fi Aware peer using PeerHandle failed to get a MAC address translation
1457 OVERALL_AWARE_TRANSLATION_FAILURE = 7;
1458
1459 // RTT operation failed due to missing Location permission (post execution)
1460 OVERALL_LOCATION_PERMISSION_MISSING = 8;
1461 }
1462
1463 // Status codes for individual RTT operation
1464 enum RttIndividualStatusTypeEnum {
1465 // constant to be used by proto
1466 UNKNOWN = 0;
1467
1468 // RTT operation succeeded
1469 SUCCESS = 1;
1470
1471 // RTT failure: generic reason (no further information)
1472 FAILURE = 2;
1473
1474 // Target STA does not respond to request
1475 FAIL_NO_RSP = 3;
1476
1477 // Request rejected. Applies to 2-sided RTT only
1478 FAIL_REJECTED = 4;
1479
1480 // Operation not scheduled
1481 FAIL_NOT_SCHEDULED_YET = 5;
1482
1483 // Timing measurement times out
1484 FAIL_TM_TIMEOUT = 6;
1485
1486 // Target on different channel, cannot range
1487 FAIL_AP_ON_DIFF_CHANNEL = 7;
1488
1489 // Ranging not supported
1490 FAIL_NO_CAPABILITY = 8;
1491
1492 // Request aborted for unknown reason
1493 ABORTED = 9;
1494
1495 // Invalid T1-T4 timestamp
1496 FAIL_INVALID_TS = 10;
1497
1498 // 11mc protocol failed
1499 FAIL_PROTOCOL = 11;
1500
1501 // Request could not be scheduled
1502 FAIL_SCHEDULE = 12;
1503
1504 // Responder cannot collaborate at time of request
1505 FAIL_BUSY_TRY_LATER = 13;
1506
1507 // Bad request args
1508 INVALID_REQ = 14;
1509
1510 // WiFi not enabled
1511 NO_WIFI = 15;
1512
1513 // Responder overrides param info, cannot range with new params
1514 FAIL_FTM_PARAM_OVERRIDE = 16;
1515
1516 // HAL did not provide a result to a framework request
1517 MISSING_RESULT = 17;
1518 }
1519
1520 // Histogram bucket for Wi-Fi RTT overall operation status
1521 message RttOverallStatusHistogramBucket {
1522 // status type defining the bucket
1523 optional RttOverallStatusTypeEnum status_type = 1;
1524
1525 // number of samples in the bucket
1526 optional int32 count = 2;
1527 }
1528
1529 // Histogram bucket for Wi-Fi RTT individual operation status
1530 message RttIndividualStatusHistogramBucket {
1531 // status type defining the bucket
1532 optional RttIndividualStatusTypeEnum status_type = 1;
1533
1534 // number of samples in the bucket
1535 optional int32 count = 2;
1536 }
1537}
xshub483b722018-05-22 15:46:26 -07001538
1539// Usage data for the wifi radio while device is running on battery.
1540message WifiRadioUsage {
1541 // Duration of log (ms)
1542 optional int64 logging_duration_ms = 1;
1543
1544 // Total time for which the radio is awake due to scan.
1545 optional int64 scan_time_ms = 2;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001546}
1547
1548message ExperimentValues {
1549 // Indicates if we are logging WifiIsUnusableEvent in metrics
1550 optional bool wifi_is_unusable_logging_enabled = 1;
1551
1552 // Minimum number of txBad to trigger a data stall
1553 optional int32 wifi_data_stall_min_tx_bad = 2;
1554
1555 // Minimum number of txSuccess to trigger a data stall
1556 // when rxSuccess is 0
1557 optional int32 wifi_data_stall_min_tx_success_without_rx = 3;
Jong Wook Kime4aa37f2018-04-23 11:18:24 -07001558
1559 // Indicates if we are logging LinkSpeedCount in metrics
1560 optional bool link_speed_counts_logging_enabled = 4;
Jong Wook Kim411cab92018-04-26 15:09:23 -07001561}
1562
1563message WifiIsUnusableEvent {
1564 enum TriggerType {
1565 // Default/Invalid event
1566 TYPE_UNKNOWN = 0;
1567
1568 // There is a data stall from tx failures
1569 TYPE_DATA_STALL_BAD_TX = 1;
1570
1571 // There is a data stall from rx failures
1572 TYPE_DATA_STALL_TX_WITHOUT_RX = 2;
1573
1574 // There is a data stall from both tx and rx failures
1575 TYPE_DATA_STALL_BOTH = 3;
1576
1577 // Firmware generated an alert
1578 TYPE_FIRMWARE_ALERT = 4;
1579 }
1580
1581 // What event triggered WifiIsUnusableEvent.
1582 optional TriggerType type = 1;
1583
1584 // The timestamp at which this event occurred.
1585 // Measured in milliseconds that have elapsed since the device booted.
1586 optional int64 start_time_millis = 2;
1587
1588 // NetworkAgent score of connected wifi.
1589 // Defaults to -1 if the score was never set.
1590 optional int32 last_score = 3 [default = -1];
1591
1592 // Delta of successfully transmitted (ACKed) unicast data packets
1593 // between the last two WifiLinkLayerStats.
1594 optional int64 tx_success_delta = 4;
1595
1596 // Delta of transmitted unicast data retry packets
1597 // between the last two WifiLinkLayerStats.
1598 optional int64 tx_retries_delta = 5;
1599
1600 // Delta of lost (not ACKed) transmitted unicast data packets
1601 // between the last two WifiLinkLayerStats.
1602 optional int64 tx_bad_delta = 6;
1603
1604 // Delta of received unicast data packets
1605 // between the last two WifiLinkLayerStats.
1606 optional int64 rx_success_delta = 7;
1607
1608 // Time in millisecond between the last two WifiLinkLayerStats.
1609 optional int64 packet_update_time_delta = 8;
1610
1611 // The timestamp at which the last WifiLinkLayerStats was updated.
1612 // Measured in milliseconds that have elapsed since the device booted.
1613 optional int64 last_link_layer_stats_update_time = 9;
1614
1615 // Firmware alert code. Only valid when the event was triggered by a firmware alert, otherwise -1.
1616 optional int32 firmware_alert_code = 10 [default = -1];
Ahmed ElArabawyba64b612018-06-15 09:17:45 -07001617}