fidl_fuchsia_power_observability_common/
fidl_fuchsia_power_observability_common.rs

1// WARNING: This file is machine generated by fidlgen.
2
3#![warn(clippy::all)]
4#![allow(unused_parens, unused_mut, unused_imports, nonstandard_style)]
5
6use bitflags::bitflags;
7use fidl::encoding::{MessageBufFor, ProxyChannelBox, ResourceDialect};
8use futures::future::{self, MaybeDone, TryFutureExt};
9use zx_status;
10
11/// The name of current active wake locks, usually recorded if we attempted
12/// to suspend, but failed because there were active wake locks.
13pub const ACTIVE_WAKE_LOCK_NAMES: &str = "active_wake_lock_names";
14
15/// Timestamp in nanos, for the end of resume callback processing.
16/// Resume is not gated on phase completion.
17/// Event is recorded in SUSPEND_EVENTS_NODE.
18pub const RESUME_CALLBACK_PHASE_END_AT: &str = "resume_callbacks_ended_at_ns";
19
20/// Timestamp in nanos, for the start of resume callback processing.
21/// Resume is not gated on phase completion.
22/// Event is recorded in SUSPEND_EVENTS_NODE.
23pub const RESUME_CALLBACK_PHASE_START_AT: &str = "resume_callbacks_started_at_ns";
24
25/// Timestamp in nanos at which suspend was attempted.
26pub const SUSPEND_ATTEMPTED_AT: &str = "attempted_at_ns";
27
28/// Timestamp in nanos for when a suspend attempt was blocked internally.
29/// Suspend may be repeatedly blocked until all suspend locks and suspend
30/// blockers have been dropped.
31pub const SUSPEND_ATTEMPT_BLOCKED_AT: &str = "attempt_blocked_at_ns";
32
33/// Timestamp in nanos for when at least one suspend blocker is acquired.
34/// This occurs when an internal procedure needs to prevent suspension.
35/// For example, when servicing a wake lease request, system-activity-governor
36/// will acquire a suspend blocker for the lifetime of the wake lease token.
37/// This prevents suspension even while the underlying power broker lease is
38/// pending.
39pub const SUSPEND_BLOCKER_ACQUIRED_AT: &str = "suspend_blocker_acquired_at_ns";
40
41/// Timestamp in nanos for when the last suspend blocker is dropped.
42pub const SUSPEND_BLOCKER_DROPPED_AT: &str = "suspend_blocker_dropped_at_ns";
43
44/// Timestamp in nanos, for the end of suspend callback processing.
45/// Suspend is gated on phase completion.
46/// Event is recorded in SUSPEND_EVENTS_NODE.
47pub const SUSPEND_CALLBACK_PHASE_END_AT: &str = "suspend_callbacks_ended_at_ns";
48
49/// Timestamp in nanos, for the start of suspend callback processing.
50/// Suspend is gated on phase completion.
51/// Event is recorded in SUSPEND_EVENTS_NODE.
52pub const SUSPEND_CALLBACK_PHASE_START_AT: &str = "suspend_callbacks_started_at_ns";
53
54/// Label of an inspect node tallying suspend events.
55pub const SUSPEND_EVENTS_NODE: &str = "suspend_events";
56
57/// Timestamp in nanos for resume, after an unsuccessful suspend.
58pub const SUSPEND_FAILED_AT: &str = "failed_at_ns";
59
60/// The number of failed suspends.
61pub const SUSPEND_FAIL_COUNT: &str = "fail_count";
62
63/// The duration of time last spent in operations leading to suspend,
64/// excluding the time actually spent suspended.
65///
66/// TODO: b/354239403 - make this string also end with `_ns` to be consistent
67/// with the conventions above.
68pub const SUSPEND_LAST_DURATION: &str = "last_time_in_suspend_operations";
69
70/// The error code related to the last suspend operation.
71pub const SUSPEND_LAST_FAILED_ERROR: &str = "last_failed_error";
72
73/// The duration of time last spent in suspend.
74pub const SUSPEND_LAST_TIMESTAMP: &str = "last_time_in_suspend_ns";
75
76/// Timestamp in nanos for when suspend requests will be blocked because a
77/// suspend lock is acquired. This event occurs right before a request to the
78/// suspend HAL is made.
79pub const SUSPEND_LOCK_ACQUIRED_AT: &str = "suspend_lock_acquired_at_ns";
80
81/// Timestamp in nanos for when a suspend lock is dropped. This event occurs
82/// after a response from the suspend HAL is received and handled by SAG.
83pub const SUSPEND_LOCK_DROPPED_AT: &str = "suspend_lock_dropped_at_ns";
84
85/// The requested future system state.
86pub const SUSPEND_REQUESTED_STATE: &str = "requested_power_state";
87
88/// Timestamp in nanos for resume, after a successful suspend.
89pub const SUSPEND_RESUMED_AT: &str = "resumed_at_ns";
90
91/// Label of an inspect node keeping suspend statistics.
92pub const SUSPEND_STATS_NODE: &str = "suspend_stats";
93
94/// The number of successful suspends.
95pub const SUSPEND_SUCCESS_COUNT: &str = "success_count";
96
97/// The current state of wake leases, as tracked by SAG.
98/// The wake lease event history is tracked separately in SUSPEND_EVENTS_NODE.
99pub const WAKE_LEASES_NODE: &str = "wake_leases";
100
101/// Timestamp in nanos for when a wake lease was created.
102pub const WAKE_LEASE_CREATED_AT: &str = "wake_lease_created_at_ns";
103
104/// Timestamp in nanos for a wake lease is dropped.
105pub const WAKE_LEASE_DROPPED_AT: &str = "wake_lease_dropped_at_ns";
106
107/// The kernel object ID of the token vended to the client.
108pub const WAKE_LEASE_ITEM_CLIENT_TOKEN_KOID: &str = "wake_lease_client_token_koid";
109
110/// The error message. For example, if the underlying power broker lease failed
111/// to be satisfied.
112pub const WAKE_LEASE_ITEM_ERROR: &str = "error";
113
114/// The name of the wake lease as requested by the client.
115pub const WAKE_LEASE_ITEM_NAME: &str = "wake_lease_name";
116
117/// The time since boot when the wake lease was created in nanoseconds.
118pub const WAKE_LEASE_ITEM_NODE_CREATED_AT: &str = "wake_lease_created_at";
119
120/// The status of the wake lease.
121pub const WAKE_LEASE_ITEM_STATUS: &str = "wake_lease_status";
122
123/// Lease requested in power broker is awaiting satisfaction in the power
124/// topology.
125pub const WAKE_LEASE_ITEM_STATUS_AWAITING_SATISFACTION: &str = "pending";
126
127/// Lease requested in power broker failed to be satisfied.
128pub const WAKE_LEASE_ITEM_STATUS_FAILED_SATISFACTION: &str = "failed";
129
130/// Lease requested in power broker is satisfied by the current state of the
131/// power topology.
132pub const WAKE_LEASE_ITEM_STATUS_SATISFIED: &str = "satisfied";
133
134/// The type of wake lease.
135pub const WAKE_LEASE_ITEM_TYPE: &str = "wake_lease_type";
136
137/// Lease that blocks the system from dropping below the Application Activity
138/// 'Active' state.
139pub const WAKE_LEASE_ITEM_TYPE_APPLICATION_ACTIVITY: &str = "application_activity";
140
141/// Lease that blocks suspension of the hardware platform.
142pub const WAKE_LEASE_ITEM_TYPE_WAKE: &str = "wake";
143
144/// Timestamp in nanos for when a wake lease failed to be satisfied by power broker.
145pub const WAKE_LEASE_SATISFACTION_FAILED_AT: &str = "wake_lease_satisfaction_failed_at_ns";
146
147/// Timestamp in nanos for when a wake lease is satisfaction with power broker.
148pub const WAKE_LEASE_SATISFIED_AT: &str = "wake_lease_satisfied_at_ns";
149
150mod internal {
151    use super::*;
152}
fidl_fuchsia_power_observability_common/fidl_fuchsia_power_observability_common.rs

fidl_fuchsia_power_observability_common/
fidl_fuchsia_power_observability_common.rs
