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