Skip to main content

ChargerRequest

Enum ChargerRequest 

Source
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

§

GetStatus

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.
§

ConfigureWatch

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_uv or input_current_ua that do not support active interrupt notifications), the driver enables the supported fields and returns the active subset in effective_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. Both interest and wake_on are 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 any wake_on fields, no lease coordination is performed and any provided token is dropped without returning a wake_lease.

Returns:

  • status: Complete current telemetry snapshot of the charger.
  • wake_lease: An optional lease token provided if the change triggered a wake_on condition. Omitted if the change did not trigger a wake condition or if suspend coordination is inactive.

Errors:

  • ALREADY_WATCHING: A Watch call 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
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.

§control_handle: ChargerControlHandle
§method_type: MethodType

Implementations§

Trait Implementations§

Source§

impl Debug for ChargerRequest

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.