Struct DeviceSynchronousProxy 

pub struct DeviceSynchronousProxy { /* private fields */ }

Implementations

impl DeviceSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<DeviceEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn get_operating_point_info( &self, opp: u32, ___deadline: MonotonicInstant, ) -> Result<DeviceGetOperatingPointInfoResult, Error>

Returns information about a given operating point for this performance domain.

pub fn get_current_operating_point( &self, ___deadline: MonotonicInstant, ) -> Result<u32, Error>

Gets the current operating point of the device.

pub fn set_current_operating_point( &self, requested_opp: u32, ___deadline: MonotonicInstant, ) -> Result<DeviceSetCurrentOperatingPointResult, Error>

Set the operating point of this device to the requested operating point.

Operating points are in numeric P-state order, such that the maximum operating performance point is 0 and the minimum is n-1, where n is the number of operating points returned by GetOperatingPointCount().

The requested operating point may be clamped to the range [min, max] when operating point limits are supported. See SetOperatingPointLimits for details.

Returns ZX_OK, if the device is in a working state and the operating point is changed to requested_opp successfully. out_opp will be same as requested_opp.

Returns ZX_ERR_OUT_OF_RANGE if the minimum_opp is outside of the range [n-1, 0], where n is the number of operating points returned by GetOperatingPointCount().

Returns error status, if switching to the requested_opp was unsuccessful. out_opp is the operating performance point (OPP) that the device is currently in.

pub fn set_minimum_operating_point_limit( &self, minimum_opp: u32, ___deadline: MonotonicInstant, ) -> Result<DeviceSetMinimumOperatingPointLimitResult, Error>

Sets the minimum operating point to use, particularly when the kernel automatically controls the operating points of this device.

See SetOperatingPointLimits for details on the semantics of operating point limits.

Returns ZX_OK on success.

Returns ZX_ERR_OUT_OF_RANGE if the minimum_opp is outside of the range [n-1, 0], where n is the number of operating points returned by GetOperatingPointCount().

Returns ZX_ERR_NOT_SUPPORTED if the device does not support limits.

pub fn set_maximum_operating_point_limit( &self, maximum_opp: u32, ___deadline: MonotonicInstant, ) -> Result<DeviceSetMaximumOperatingPointLimitResult, Error>

Sets the maximum operating point to use, particularly when the kernel automatically controls the operating points of this device.

See SetOperatingPointLimits for details on the semantics of operating point limits.

Returns ZX_OK on success.

Returns ZX_ERR_OUT_OF_RANGE if the maximum_opp is outside of the range [n-1, 0], where n is the number of operating points returned by GetOperatingPointCount().

Returns ZX_ERR_NOT_SUPPORTED if the device does not support limits.

pub fn set_operating_point_limits( &self, minimum_opp: u32, maximum_opp: u32, ___deadline: MonotonicInstant, ) -> Result<DeviceSetOperatingPointLimitsResult, Error>

Sets the operational boundaries (minimum and maximum operating points) for the device, when supported.

Limits define the allowable performance range for the performance domain. They are primarily used for:

• Thermal Mitigation: Progressively lowering the maximum operating point (moving from 0 toward n-1) to reduce power dissipation.
• Performance Boosting: Raising the minimum operating point (moving from n-1 toward 0) when automatic performance matching is insufficient for the current workload.

Limits are useful on platforms where ether hardware or the kernel automatically manages performance. By setting boundaries, userspace can enforce power and performance policies while allowing the underlying system to react to high-fidelity signals in real-time.

When limits are applied, the active operating point is clamped to the range: [max(minimum_opp, maximim_opp), maximum_opp].

Note that maximim_opp and minimum_opp reside in the P-state range [n-1, 0]. This logic ensures that the minimum_opp can be adjusted independently while always respecting the ceiling imposed by the maximim_opp.

Set the operating point limits to (n-1, 0) to effectively remove the limits.

Returns ZX_OK on success.

Returns ZX_ERR_OUT_OF_RANGE if the minimum_opp or maximum_opp is outside of the range [n-1, 0], where n is the number of operating points returned by GetOperatingPointCount().

Returns ZX_ERR_NOT_SUPPORTED if the device does not support limits.

pub fn get_current_operating_point_limits( &self, ___deadline: MonotonicInstant, ) -> Result<DeviceGetCurrentOperatingPointLimitsResult, Error>

Returns the current minimum and maximum operating point limits.

Returns ZX_OK on success.

Returns ZX_ERR_NOT_SUPPORTED if the device does not support limits.

pub fn get_operating_point_count( &self, ___deadline: MonotonicInstant, ) -> Result<DeviceGetOperatingPointCountResult, Error>

Returns the number of operating points within this performance domain.

pub fn get_num_logical_cores( &self, ___deadline: MonotonicInstant, ) -> Result<u64, Error>

Returns the number of logical cores contained within this performance domain.

pub fn get_logical_core_id( &self, index: u64, ___deadline: MonotonicInstant, ) -> Result<u64, Error>

Returns a global system-wide core ID for the nth core in this performance domain. index must be a value in the range [0, n) where n is the value returned by GetNumLogicalCores().

pub fn get_domain_id(&self, ___deadline: MonotonicInstant) -> Result<u32, Error>

Returns the id of this performance domain within its package. This number should be stable across boots, but clients should prefer to use GetRelativePerformance to differentiate cores if possible.

pub fn get_relative_performance( &self, ___deadline: MonotonicInstant, ) -> Result<DeviceGetRelativePerformanceResult, Error>

The relative performance of this domain as configured by the platform, if known. The highest performance domain should return 255, while others should return N/255 fractional values relative to that domain. Returns ZX_ERR_NOT_SUPPORTED if the performance level is unknown.

Trait Implementations

impl Debug for DeviceSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for DeviceSynchronousProxy

Available on Fuchsia only.

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<DeviceSynchronousProxy> for NullableHandle

Available on Fuchsia only.

fn from(value: DeviceSynchronousProxy) -> Self

Converts to this type from the input type.

impl FromClient for DeviceSynchronousProxy

Available on Fuchsia only.

type Protocol = DeviceMarker

The protocol.

fn from_client(value: ClientEnd<DeviceMarker>) -> Self

Converts from a client.

impl SynchronousProxy for DeviceSynchronousProxy

Available on Fuchsia only.

type Proxy = DeviceProxy

The async proxy for the same protocol.

type Protocol = DeviceMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.