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