Skip to main content

OdpmDeviceRequest

Enum OdpmDeviceRequest 

Source
pub enum OdpmDeviceRequest {
    GetRailMetadata {
        responder: OdpmDeviceGetRailMetadataResponder,
    },
    GetAvailableRails {
        responder: OdpmDeviceGetAvailableRailsResponder,
    },
    SetChannelRail {
        channel_id: u32,
        rail_name: String,
        responder: OdpmDeviceSetChannelRailResponder,
    },
    GetPowerWatts {
        payload: Options,
        responder: OdpmDeviceGetPowerWattsResponder,
    },
    GetCurrentAmperes {
        payload: Options,
        responder: OdpmDeviceGetCurrentAmperesResponder,
    },
    GetEnergyJoules {
        payload: Options,
        responder: OdpmDeviceGetEnergyJoulesResponder,
    },
    SetPollingConfig {
        payload: PollingConfig,
        responder: OdpmDeviceSetPollingConfigResponder,
    },
    GetPollingConfig {
        responder: OdpmDeviceGetPollingConfigResponder,
    },
    ResetPollingConfig {
        responder: OdpmDeviceResetPollingConfigResponder,
    },
#[non_exhaustive]
_UnknownMethod { ordinal: u64, control_handle: OdpmDeviceControlHandle, method_type: MethodType, }, }
Expand description

Provides power and power-related measurements for all actively-monitored rails, dynamic rail multiplexing, and configuration for the ODPM driver’s hardware polling loop.

Variants§

§

GetRailMetadata

Returns metadata for all actively-monitored rails.

§

GetAvailableRails

Returns metadata for all available power rails supported by the hardware (both actively-monitored and unmonitored).

  • measurement_start is reported for rails that are actively monitored or were previously monitored.
  • measurement_stop and energy_uj are reported only for rails that have been swapped out, retaining only the most recent completed measurement window (rather than an entry per session or an aggregate across sessions). If a stopped rail is swapped back onto an active channel, its previous stopped reading (measurement_stop and energy_uj) is cleared and a new measurement window begins.

Returns ZX_ERR_INTERNAL if internal rail state cannot be retrieved.

§

SetChannelRail

Reconfigures an internal telemetry channel (channel_id) to monitor rail_name (matched case-insensitively against name, regulator_name, or schematic_name).

The new assignment is visible to all clients: readings for channel_id from GetPowerWatts, GetCurrentAmperes, and GetEnergyJoules then refer to rail_name and restart from a new measurement window. Clients that cache GetRailMetadata can detect the change by re-querying it and comparing name or measurement_start.

Returns:

  • ZX_OK (as a no-op) if channel_id is already actively monitoring rail_name.
  • ZX_ERR_NOT_FOUND if rail_name does not match any available rail.
  • ZX_ERR_INVALID_ARGS if channel_id is invalid, is an external shunt channel, or if the requested rail is an external shunt rail or belongs to a different PMIC than channel_id.
  • ZX_ERR_ALREADY_BOUND if the requested rail is already monitored on a different active channel.
  • ZX_ERR_UNAVAILABLE if the hardware operation fails.
  • ZX_ERR_INTERNAL if an internal driver error occurs.

Fields

§channel_id: u32
§rail_name: String
§

GetPowerWatts

Returns the power consumption for all actively-monitored rails. Returns ZX_ERR_NOT_SUPPORTED if the requested measurement type is not supported. Returns ZX_ERR_UNAVAILABLE if the hardware read fails. Returns ZX_ERR_INTERNAL if internal rail state is inconsistent.

§

GetCurrentAmperes

Returns the current for all actively-monitored rails. Returns ZX_ERR_NOT_SUPPORTED if the requested measurement type is not supported. Returns ZX_ERR_UNAVAILABLE if the hardware read fails. Returns ZX_ERR_INTERNAL if internal rail state is inconsistent.

§

GetEnergyJoules

Returns the energy consumption for all actively-monitored rails. Returns ZX_ERR_NOT_SUPPORTED if the requested measurement type is not supported. Returns ZX_ERR_UNAVAILABLE if the hardware read fails. Returns ZX_ERR_INTERNAL if internal rail state is inconsistent.

§

SetPollingConfig

Overrides polling configuration parameters. Any omitted fields in PollingConfig remain unchanged. Returns ZX_ERR_INVALID_ARGS if poll_interval is less than MIN_POLL_INTERVAL or polls_per_series_entry == 0.

§

GetPollingConfig

Retrieves the current polling configuration parameters.

§

ResetPollingConfig

Resets polling configuration parameters to the driver’s default values.

§

#[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 OdpmDeviceRequest

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.