pub enum DebugRequest {
SetControl {
options: ControlOptions,
responder: DebugSetControlResponder,
},
ClearControl {
options: ControlOptions,
responder: DebugClearControlResponder,
},
#[non_exhaustive] _UnknownMethod {
ordinal: u64,
control_handle: DebugControlHandle,
method_type: MethodType,
},
}Expand description
Debug control interface for hardware battery chargers.
Composes [Controller] without its single-client exclusivity or revert-on-close lifetime, so
command-line diagnostic utilities (such as batteryutil) and integration tests can apply sticky
charger overrides while the production policy client stays connected to [Controller]. Only
reachable through [DebugService].
§Override Precedence
Each field set through SetControl becomes an override that takes precedence over
[Controller] regardless of request order: a [Controller] request that sets an overridden
field is validated and accepted, but takes effect only once the override is cleared, and a
[Controller] revert on close leaves overridden fields untouched. Fields that are not
overridden stay under [Controller] control.
§Sticky Lifetime (No Revert on Close)
Overrides are not tied to the connection that applied them: closing the channel leaves them in
effect, so a utility can apply an override and exit. They remain in effect until
ClearControl is called on a Debug connection.
§Multiple Connections
Any number of Debug connections may be open concurrently; connections are never rejected with
ZX_ERR_ALREADY_BOUND. All Debug connections share one set of Debug overrides: for each
field, the most recent SetControl wins, and ClearControl withdraws the targeted Debug
overrides.
Variants§
SetControl
Applies operational and electrical constraints to the charger converter.
Validation is atomic: a request rejected with NOT_SUPPORTED or INVALID_ARGS leaves
hardware and session state untouched. The response is returned only after all corresponding
hardware register writes have completed and been acknowledged by the charger IC.
Parameters:
options: The constraints to apply. Present fields overwrite the constraints previously set on this connection for those fields; omitted fields leave this connection’s prior constraints for those fields unchanged.
Errors:
NOT_SUPPORTED: One or more requested constraints are not adjustable on this hardware/arbiter, or the requestedoperating_modeis absent fromSpec.supported_modes.INVALID_ARGS: A requested value is outside the range the hardware can program, or the requestedoperating_modeconflicts with the active power path state (for example, requestingOperatingMode::OTGwhile external input power is online on the same port).IO: Communication failure with the charger hardware (e.g. SPMI transfer failure).INTERNAL: Internal driver error.
ClearControl
Withdraws constraints applied through this connection for the fields present in options.
options acts as a field mask: only field presence (set vs. unset) is inspected, and the
field values themselves are ignored.
- If
optionsis empty (no fields set), all constraints applied through this connection are withdrawn. - If one or more fields are set in
options, only the constraints corresponding to those fields are withdrawn, leaving any other fields untouched.
Each cleared field reverts to the next active constraint, if any, or otherwise to the
autonomous hardware / board-configured default that [Controller] restores on close.
Succeeds without effect for any targeted field that is not currently constrained.
Parameters:
options: Mask ofControlOptionsfields whose constraints should be withdrawn, or an empty table to withdraw all constraints on this connection.
Errors:
IO: Communication failure with the charger hardware. Fields that could not be reverted retain their constraint, so the call can be retried.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: DebugControlHandlemethod_type: MethodTypeImplementations§
Source§impl DebugRequest
impl DebugRequest
pub fn into_set_control( self, ) -> Option<(ControlOptions, DebugSetControlResponder)>
pub fn into_clear_control( self, ) -> Option<(ControlOptions, DebugClearControlResponder)>
Sourcepub fn method_name(&self) -> &'static str
pub fn method_name(&self) -> &'static str
Name of the method defined in FIDL