Struct WlanPhyProxy 

pub struct WlanPhyProxy { /* private fields */ }

Implementations

impl WlanPhyProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.wlan.phy/WlanPhy.

pub fn take_event_stream(&self) -> WlanPhyEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn init( &self, payload: WlanPhyInitRequest, ) -> QueryResponseFut<WlanPhyInitResult, DefaultFuchsiaResourceDialect>

This method can be used by the WlanPhy client to send the client end of the WlanPhyNotify endpoint for the WlanPhy server to use. If the WlanPhy client never invokes this method that is an indirect implication that the WlanPhyNotify is not supported. Some possible error codes are: ZX_ERR_NOT_SUPPORTED: The WlanPhy server does not support the WlanPhyNotify protocol.

pub fn get_supported_mac_roles( &self, ) -> QueryResponseFut<WlanPhyGetSupportedMacRolesResult, DefaultFuchsiaResourceDialect>

MAC roles supported for ifaces on the physical device.

pub fn create_iface( &self, payload: WlanPhyCreateIfaceRequest, ) -> QueryResponseFut<WlanPhyCreateIfaceResult, DefaultFuchsiaResourceDialect>

Create a new interface with the specified role, returning the interface id.
Some common error codes are:
ZX_ERR_NO_RESOURCES: maximum number of interfaces have already been created.
ZX_ERR_NOT_SUPPORTED: device does not support the specified role.

pub fn destroy_iface( &self, payload: &WlanPhyDestroyIfaceRequest, ) -> QueryResponseFut<WlanPhyDestroyIfaceResult, DefaultFuchsiaResourceDialect>

Destroy the interface with the matching id.
Some common error codes are:
ZX_ERR_NOT_FOUND: Specified iface does not exist or has already been removed.
ZX_ERR_SHOULD_WAIT: Device is busy and cannot be removed, try again later.

pub fn set_country( &self, country: &[u8; 2], ) -> QueryResponseFut<WlanPhySetCountryResult, DefaultFuchsiaResourceDialect>

Set country with a 2-byte country code.
Some common error codes are:
ZX_ERR_NOT_FOUND: Specified country code not supported. PHY state is left unchanged.

pub fn clear_country( &self, ) -> QueryResponseFut<WlanPhyClearCountryResult, DefaultFuchsiaResourceDialect>

Set device to a world-safe country, i.e. a mode that conforms to all regulatory constraints globally.
Generally expected to succeed if the device is in a functional state.

pub fn get_country( &self, ) -> QueryResponseFut<WlanPhyGetCountryResult, DefaultFuchsiaResourceDialect>

Read currently configured country. Implementations are advised to read the country directly from the firmware, where possible.
Generally expected to succeed if the device is in a functional state.

pub fn set_power_save_mode( &self, payload: &WlanPhySetPowerSaveModeRequest, ) -> QueryResponseFut<WlanPhySetPowerSaveModeResult, DefaultFuchsiaResourceDialect>

Set Power Save mode on device. In most implementations this likely to be set in Firmware.
Some common error codes are:
ZX_ERR_NOT_SUPPORTED: Specified Power Save mode not supported.

pub fn get_power_save_mode( &self, ) -> QueryResponseFut<WlanPhyGetPowerSaveModeResult, DefaultFuchsiaResourceDialect>

Get current Power Save mode from device. In most implementation this likely to be retrieved from Firmware.

pub fn power_down( &self, ) -> QueryResponseFut<WlanPhyPowerDownResult, DefaultFuchsiaResourceDialect>

Power up/down/reset the wlan chip. If supported, PowerDown will power down the wlan chip if it is currently powered on. Any existing interfaces should have already been deleted before making this call or else the driver will fail the call with error code ZX_ERR_INTERNAL. Other possible error codes are:
ZX_ERR_NOT_SUPPORTED: the feature is not supported by the driver. ZX_ERR_BAD_STATE: the wlan chip is already powered down.

pub fn power_up( &self, ) -> QueryResponseFut<WlanPhyPowerUpResult, DefaultFuchsiaResourceDialect>

If supported, PowerUp will power up the wlan chip if it is currently powered down. Possible error codes are:
ZX_ERR_NOT_SUPPORTED: the feature is not supported by the driver. ZX_ERR_BAD_STATE: the wlan chip is already powered up.

pub fn reset( &self, ) -> QueryResponseFut<WlanPhyResetResult, DefaultFuchsiaResourceDialect>

If supported, Reset functionality implements PowerDown then PowerUp in an attempt to recover from an error state. For example, if an interface gets into a bad state or if firmware crashes, the firmware/chip may be unable to perform some actions and Reset may be able to clear the bad state. Possible error codes are:
ZX_ERR_NOT_SUPPORTED: the feature is not supported by the driver. ZX_ERR_BAD_STATE: the wlan chip is already powered down.

pub fn get_power_state( &self, ) -> QueryResponseFut<WlanPhyGetPowerStateResult, DefaultFuchsiaResourceDialect>

Returns the current power state of the wlan chip. After successful initialization of the wlan driver, the state is set to true (power on) by default. power_on set to true indicates that the wlan chip is powered on and false indicates the wlan chip is powered off.

pub fn set_bt_coexistence_mode( &self, payload: &WlanPhySetBtCoexistenceModeRequest, ) -> QueryResponseFut<WlanPhySetBtCoexistenceModeResult, DefaultFuchsiaResourceDialect>

Set the Bluetooth coexistence mode. Possible error codes are:
ZX_ERR_NOT_SUPPORTED: device does not support the specified BT coexistence mode.

pub fn set_tx_power_scenario( &self, payload: &WlanPhySetTxPowerScenarioRequest, ) -> QueryResponseFut<WlanPhySetTxPowerScenarioResult, DefaultFuchsiaResourceDialect>

pub fn reset_tx_power_scenario( &self, ) -> QueryResponseFut<WlanPhyResetTxPowerScenarioResult, DefaultFuchsiaResourceDialect>

pub fn get_tx_power_scenario( &self, ) -> QueryResponseFut<WlanPhyGetTxPowerScenarioResult, DefaultFuchsiaResourceDialect>

Trait Implementations

impl Clone for WlanPhyProxy

fn clone(&self) -> WlanPhyProxy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WlanPhyProxy

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

Formats the value using the given formatter.

impl Proxy for WlanPhyProxy

type Protocol = WlanPhyMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, NullableHandle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.

impl WlanPhyProxyInterface for WlanPhyProxy

type InitResponseFut = QueryResponseFut<Result<(), i32>>

type GetSupportedMacRolesResponseFut = QueryResponseFut<Result<WlanPhyGetSupportedMacRolesResponse, i32>>

type CreateIfaceResponseFut = QueryResponseFut<Result<WlanPhyCreateIfaceResponse, i32>>

type DestroyIfaceResponseFut = QueryResponseFut<Result<(), i32>>

type SetCountryResponseFut = QueryResponseFut<Result<(), i32>>

type ClearCountryResponseFut = QueryResponseFut<Result<(), i32>>

type GetCountryResponseFut = QueryResponseFut<Result<[u8; 2], i32>>

type SetPowerSaveModeResponseFut = QueryResponseFut<Result<(), i32>>

type GetPowerSaveModeResponseFut = QueryResponseFut<Result<WlanPhyGetPowerSaveModeResponse, i32>>

type PowerDownResponseFut = QueryResponseFut<Result<(), i32>>

type PowerUpResponseFut = QueryResponseFut<Result<(), i32>>

type ResetResponseFut = QueryResponseFut<Result<(), i32>>

type GetPowerStateResponseFut = QueryResponseFut<Result<WlanPhyGetPowerStateResponse, i32>>

type SetBtCoexistenceModeResponseFut = QueryResponseFut<Result<(), i32>>

type SetTxPowerScenarioResponseFut = QueryResponseFut<Result<(), i32>>

type ResetTxPowerScenarioResponseFut = QueryResponseFut<Result<(), i32>>

type GetTxPowerScenarioResponseFut = QueryResponseFut<Result<TxPowerScenario, i32>>

fn init(&self, payload: WlanPhyInitRequest) -> Self::InitResponseFut

fn get_supported_mac_roles(&self) -> Self::GetSupportedMacRolesResponseFut

fn create_iface( &self, payload: WlanPhyCreateIfaceRequest, ) -> Self::CreateIfaceResponseFut

fn destroy_iface( &self, payload: &WlanPhyDestroyIfaceRequest, ) -> Self::DestroyIfaceResponseFut

fn set_country(&self, country: &[u8; 2]) -> Self::SetCountryResponseFut

fn clear_country(&self) -> Self::ClearCountryResponseFut

fn get_country(&self) -> Self::GetCountryResponseFut

fn set_power_save_mode( &self, payload: &WlanPhySetPowerSaveModeRequest, ) -> Self::SetPowerSaveModeResponseFut

fn get_power_save_mode(&self) -> Self::GetPowerSaveModeResponseFut

fn power_down(&self) -> Self::PowerDownResponseFut

fn power_up(&self) -> Self::PowerUpResponseFut

fn reset(&self) -> Self::ResetResponseFut

fn get_power_state(&self) -> Self::GetPowerStateResponseFut

fn set_bt_coexistence_mode( &self, payload: &WlanPhySetBtCoexistenceModeRequest, ) -> Self::SetBtCoexistenceModeResponseFut

fn set_tx_power_scenario( &self, payload: &WlanPhySetTxPowerScenarioRequest, ) -> Self::SetTxPowerScenarioResponseFut

fn reset_tx_power_scenario(&self) -> Self::ResetTxPowerScenarioResponseFut

fn get_tx_power_scenario(&self) -> Self::GetTxPowerScenarioResponseFut