Skip to main content

ControllerRequest

Enum ControllerRequest 

Source
pub enum ControllerRequest {
    SetControl {
        options: ControlOptions,
        responder: ControllerSetControlResponder,
    },
    ClearControl {
        options: ControlOptions,
        responder: ControllerClearControlResponder,
    },
#[non_exhaustive]
_UnknownMethod { ordinal: u64, control_handle: ControllerControlHandle, method_type: MethodType, }, }
Expand description

Control interface for mutating charger hardware state.

§Single-Client Exclusivity (Hardware Driver) vs. Policy Arbitrator

On a hardware charger driver, this protocol mutates shared hardware state and admits a single active client: while one client is connected, a second connection attempt is closed immediately with a ZX_ERR_ALREADY_BOUND epitaph before any request is served. When served by a userspace policy arbitrator (such as battery-manager), multiple policy clients may connect concurrently; each connection owns an independent vote that is aggregated using minimum selection on limit fields and Discharging > Passthrough > Charging precedence on operating_mode.

§Connection-Scoped Lifetime (Revert on Close)

The Controller channel encodes the lifetime of the constraints applied through it. When the client closes the channel (or disconnects unexpectedly), all constraints set during that session are withdrawn (equivalent to calling ClearControl with an empty ControlOptions).

§Debug Overrides

Fields overridden through Debug take precedence over this protocol. A request that sets an overridden field is validated and accepted as usual, but the new constraint (like ClearControl or revert on close) reaches the hardware only once the override is cleared. See Debug.

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 requested operating_mode is absent from Spec.supported_modes.
  • INVALID_ARGS: A requested value is outside the range the hardware can program, or the requested operating_mode conflicts with the active power path state (for example, requesting OperatingMode::OTG while 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 options is 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 of ControlOptions fields 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
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§ordinal: u64

Ordinal of the method that was called.

§method_type: MethodType

Implementations§

Trait Implementations§

Source§

impl Debug for ControllerRequest

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

Source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
Source§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

Source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.