pub enum ChargerRequest {
GetSpec {
responder: ChargerGetSpecResponder,
},
GetStatus {
responder: ChargerGetStatusResponder,
},
ConfigureWatch {
options: WatchOptions,
responder: ChargerConfigureWatchResponder,
},
Watch {
lease: Option<EventPair>,
responder: ChargerWatchResponder,
},
#[non_exhaustive] _UnknownMethod {
ordinal: u64,
control_handle: ChargerControlHandle,
method_type: MethodType,
},
}Expand description
Diagnostic and telemetry interface for charging hardware.
This is a read-only protocol that supports multiple concurrent clients.
Variants§
GetSpec
Retrieves the static specification of the charger.
Returns:
spec: Static hardware characteristics and driver capabilities of the charger.
Errors:
NOT_SUPPORTED: Hardware does not supply a static specification.IO: Communication failure with the charger hardware (e.g. SPMI transfer failure).INTERNAL: Internal driver error.
Fields
responder: ChargerGetSpecResponderGetStatus
Retrieves an instantaneous snapshot of the charger status.
Returns:
status: Complete current telemetry snapshot of the charging regulator and its inputs.
Errors:
IO: Communication failure with the charger hardware (e.g. SPMI transfer failure).INTERNAL: Internal driver error.
Fields
responder: ChargerGetStatusResponderConfigureWatch
Configures the fields of interest and wake triggers for this client connection.
The driver filters the requested masks against hardware capabilities and returns the
effective configuration in effective_options.
- Partially supported options: If some requested fields are supported and others are not
(e.g., requesting passive fields like
input_voltage_uvorinput_current_uathat do not support active interrupt notifications), the driver enables the supported fields and returns the active subset ineffective_options. The call succeeds (Ok). - Fully unsupported options: If non-empty masks were specified but NONE of the requested
fields are supported, the driver returns
NOT_SUPPORTED.
If ConfigureWatch is never called, Watch defaults to returning on ANY supported field
change. The driver aggregates constraints across all clients to determine hardware reporting
rates.
Calling ConfigureWatch while a Watch call is already pending takes effect immediately:
if the current hardware state already differs from the last-delivered snapshot on a newly
enabled field, the pending Watch resolves immediately; otherwise it remains pending under
the updated mask.
If ConfigureWatch returns an error, the connection’s prior watch configuration remains
unchanged.
Parameters:
options: Requested watch options. Bothinterestandwake_onare optional.
Returns:
effective_options: The subset of requested options supported and enabled by the driver.
Errors:
NOT_SUPPORTED: Non-empty options were requested, but none of the requested interest/wake fields are supported by the driver.
Watch
Watches for changes in charger state using a hanging-get pattern.
The first call returns the full current hardware state immediately. Subsequent calls block
until a state change matches the masks in [ConfigureWatch]. Each return contains a
complete telemetry snapshot of all current charger fields, not a sparse delta.
At most one Watch call may be outstanding per connection; concurrent calls fail with
ALREADY_WATCHING.
Parameters:
lease: An optional power lease token used to coordinate handoff between client and server, preventing the system from suspending before critical charger events are handled. If omitted, or if the driver does not support anywake_onfields, no lease coordination is performed and any provided token is dropped without returning awake_lease.
Returns:
status: Complete current telemetry snapshot of the charger.wake_lease: An optional lease token provided if the change triggered awake_oncondition. Omitted if the change did not trigger a wake condition or if suspend coordination is inactive.
Errors:
ALREADY_WATCHING: AWatchcall is already pending on this connection.IO: Communication failure with the charger hardware (e.g. SPMI transfer failure).INTERNAL: Internal driver error.
#[non_exhaustive]_UnknownMethod
An interaction was received which does not match any known method.
Fields
This variant is marked as non-exhaustive
control_handle: ChargerControlHandlemethod_type: MethodTypeImplementations§
Source§impl ChargerRequest
impl ChargerRequest
pub fn into_get_spec(self) -> Option<ChargerGetSpecResponder>
pub fn into_get_status(self) -> Option<ChargerGetStatusResponder>
pub fn into_configure_watch( self, ) -> Option<(WatchOptions, ChargerConfigureWatchResponder)>
pub fn into_watch(self) -> Option<(Option<EventPair>, ChargerWatchResponder)>
Sourcepub fn method_name(&self) -> &'static str
pub fn method_name(&self) -> &'static str
Name of the method defined in FIDL