Enum fidl_fuchsia_wlan_softmac::WlanSoftmacBridgeRequest

pub enum WlanSoftmacBridgeRequest {
    Query {
        responder: WlanSoftmacBridgeQueryResponder,
    },
    QueryDiscoverySupport {
        responder: WlanSoftmacBridgeQueryDiscoverySupportResponder,
    },
    QueryMacSublayerSupport {
        responder: WlanSoftmacBridgeQueryMacSublayerSupportResponder,
    },
    QuerySecuritySupport {
        responder: WlanSoftmacBridgeQuerySecuritySupportResponder,
    },
    QuerySpectrumManagementSupport {
        responder: WlanSoftmacBridgeQuerySpectrumManagementSupportResponder,
    },
    SetChannel {
        payload: WlanSoftmacBaseSetChannelRequest,
        responder: WlanSoftmacBridgeSetChannelResponder,
    },
    JoinBss {
        join_request: JoinBssRequest,
        responder: WlanSoftmacBridgeJoinBssResponder,
    },
    EnableBeaconing {
        payload: WlanSoftmacBaseEnableBeaconingRequest,
        responder: WlanSoftmacBridgeEnableBeaconingResponder,
    },
    DisableBeaconing {
        responder: WlanSoftmacBridgeDisableBeaconingResponder,
    },
    InstallKey {
        payload: WlanKeyConfiguration,
        responder: WlanSoftmacBridgeInstallKeyResponder,
    },
    NotifyAssociationComplete {
        assoc_cfg: WlanAssociationConfig,
        responder: WlanSoftmacBridgeNotifyAssociationCompleteResponder,
    },
    ClearAssociation {
        payload: WlanSoftmacBaseClearAssociationRequest,
        responder: WlanSoftmacBridgeClearAssociationResponder,
    },
    StartPassiveScan {
        payload: WlanSoftmacBaseStartPassiveScanRequest,
        responder: WlanSoftmacBridgeStartPassiveScanResponder,
    },
    StartActiveScan {
        payload: WlanSoftmacStartActiveScanRequest,
        responder: WlanSoftmacBridgeStartActiveScanResponder,
    },
    CancelScan {
        payload: WlanSoftmacBaseCancelScanRequest,
        responder: WlanSoftmacBridgeCancelScanResponder,
    },
    UpdateWmmParameters {
        payload: WlanSoftmacBaseUpdateWmmParametersRequest,
        responder: WlanSoftmacBridgeUpdateWmmParametersResponder,
    },
    Start {
        ifc_bridge: ClientEnd<WlanSoftmacIfcBridgeMarker>,
        frame_processor: u64,
        responder: WlanSoftmacBridgeStartResponder,
    },
    SetEthernetStatus {
        status: u32,
        responder: WlanSoftmacBridgeSetEthernetStatusResponder,
    },
}

WlanSoftmacBridge is the protocol the wlansoftmac driver serves to the bridged driver. This protocol should not be implemented by a vendor driver.

Variants

Query

Gets general information about the device and its supported features. This method is safe to call even when the SoftMAC has not yet started.

Fields

responder: WlanSoftmacBridgeQueryResponder

QueryDiscoverySupport

Gets information about the station discovery (e.g., scanning and probing) features supported by the device. This method is safe to call even when the SoftMAC has not yet started.

Fields

responder: WlanSoftmacBridgeQueryDiscoverySupportResponder

QueryMacSublayerSupport

Gets information about the MAC features supported by the device. This method is safe to call even when the SoftMAC has not yet started.

Fields

responder: WlanSoftmacBridgeQueryMacSublayerSupportResponder

QuerySecuritySupport

Gets information about the security features supported by the device. This method is safe to call even when the SoftMAC has not yet started.

Fields

responder: WlanSoftmacBridgeQuerySecuritySupportResponder

QuerySpectrumManagementSupport

Gets information about the spectrum usage (e.g., DFS) features supported by the device. This method is safe to call even when the SoftMAC has not yet started.

Fields

responder: WlanSoftmacBridgeQuerySpectrumManagementSupportResponder

SetChannel

Set the primary radio channel, e.g. in response to a channel switch event. If successful, this will trigger the channel switch immediately. This may impact the transmission of any frames that are in-flight, and might also interfere with an ongoing scan request.

Common errors include:
ZX_ERR_NOT_SUPPORTED: The device cannot switch to the requested channel.

Fields

payload: WlanSoftmacBaseSetChannelRequest

responder: WlanSoftmacBridgeSetChannelResponder

JoinBss

Join a specific BSS in which we will participate. This applies regardless of if we are hosting the BSS or joining it (indicated by the remote flag in JoinBssRequest). If successful, the device will switch to the correct channel and perform any internal filtering/timing operations required to join the BSS. For client STAs, this is the first step before authenticating.

Common errors include:
ZX_ERR_NOT_SUPPORTED: The device does not support the given bss config.

Fields

join_request: JoinBssRequest

responder: WlanSoftmacBridgeJoinBssResponder

EnableBeaconing

Enables hardware Beaconing.

This method cannot be called while beaconing is enabled and so DisableBeaconing must be called prior to this method if beaconing is enabled.

All request fields are required.

Common errors include:

• ZX_ERR_NOT_SUPPORTED: The device does not support hardware beacons.
• ZX_ERR_INVALID_ARGS: The device cannot transmit the requested beacon.
• ZX_ERR_BAD_STATE: The device is already beaconing.

Fields

payload: WlanSoftmacBaseEnableBeaconingRequest

responder: WlanSoftmacBridgeEnableBeaconingResponder

DisableBeaconing

Disables hardware beaconing.

Fields

responder: WlanSoftmacBridgeDisableBeaconingResponder

InstallKey

Install a key for encryption when transmitting or receiving protected frames.

Common errors include: ZX_ERR_INVALID_ARGS: The given config does not specify a valid key. ZX_ERR_NOT_SUPPORTED: The device does not support the given cipher.

Fields

payload: WlanKeyConfiguration

responder: WlanSoftmacBridgeInstallKeyResponder

NotifyAssociationComplete

Notifies the device of a successful association and configures additional parameters necessary to participate in that association.

Errors

Common errors include:

• ZX_ERR_BAD_STATE: The device was not previously informed of this BSS via WlanSoftmac.JoinBss.

Fields

assoc_cfg: WlanAssociationConfig

responder: WlanSoftmacBridgeNotifyAssociationCompleteResponder

ClearAssociation

Notifies MAC and PHY that the peer has been de-associated.

Fields

payload: WlanSoftmacBaseClearAssociationRequest

responder: WlanSoftmacBridgeClearAssociationResponder

StartPassiveScan

Starts a passive scan. The server will deliver scan results as Beacon frames using WlanSoftmacIfc.Recv(). When complete, the server will call WlanSoftmacIfc.ScanComplete() with the same scan_id returned by StartPassiveScan().

The server indicates support for StartPassiveScan() using fuchsia.wlan.common/ScanOffloadExtension.supported.

Common errors include: ZX_ERR_INVALID_ARGS: The device is not capable of performing the requested scan, e.g. because an incompatible channel was requested. ZX_ERR_UNAVAILABLE: The device cannot currently perform scans. ZX_ERR_SHOULD_WAIT: Another scan is already in-progress.

Fields

payload: WlanSoftmacBaseStartPassiveScanRequest

responder: WlanSoftmacBridgeStartPassiveScanResponder

StartActiveScan

Starts an active scan. The server will deliver scan results as Beacon or Probe Response frames using WlanSoftmacIfc.Recv(). When complete, the server will call WlanSoftmacIfc.ScanComplete() with the same scan_id returned by StartActiveScan().

A device driver indicates support for StartActiveScan() using fuchsia.wlan.common/ProbeRequestOffloadExtension.supported.

Common errors include: ZX_ERR_INVALID_ARGS: The device is not capable of performing the requested scan, e.g. because an incompatible channel was requested. ZX_ERR_UNAVAILABLE: The device cannot currently perform scans. ZX_ERR_SHOULD_WAIT: Another scan is already in-progress.

Fields

payload: WlanSoftmacStartActiveScanRequest

responder: WlanSoftmacBridgeStartActiveScanResponder

CancelScan

Cancels the ongoing scan corresponding to scan_id, where scan_id is an identifier returned by StartPassiveScan() or StartActiveScan(). If cancellation succeeds, the server will soon call WlanSoftmacIfc.ScanComplete() with the same scan_id.

A device driver indicates support for CancelScan() using fuchsia.wlan.common/ScanOffloadExtension.scan_cancel_supported.

Common errors include:

• ZX_ERR_NOT_FOUND: scan_id does not match an ongoing scan.
• ZX_ERR_NOT_SUPPORTED: Server does not support scan cancellation.

Fields

payload: WlanSoftmacBaseCancelScanRequest

responder: WlanSoftmacBridgeCancelScanResponder

UpdateWmmParameters

Indicate the device of modified WiFi Multimedia (WMM) parameters for a particular access category (AC).

Fields

payload: WlanSoftmacBaseUpdateWmmParametersRequest

responder: WlanSoftmacBridgeUpdateWmmParametersResponder

Start

Signal to the server that the MLME for the iface is ready to send and receive frames.

The client provides the following arguments:

• ifc_bridge: The client end of a WlanSoftmacIfcBridge server which the wlansoftmac driver will use to forward WlanSoftmacIfc events to the bridged driver.
• frame_processor: A frame_processor_t* casted to a uint64. The frame_processor_t is defined in //src/connectivity/wlan/drivers/wlansoftmac/rust_driver/c-binding/bindings.h.

The server must copy the contents of the frame_processor_t before returning from this method. The lifetime of the frame_processor_t* is only as long as this method call, but the contents of the frame_processor_t will live until the server stops the MLME.

The server returns a server end of a fuchsia.wlan.mlme/MLME protocol. The SME for the iface owns the client end. Thus, this channel is used for SME <-> MLME communication.

The WlanSoftmacBridge.Start method is different from WlanSoftmac.Start for two reasons. First, Rust bindings do not exist for Driver transported protocols, so WlanSoftmacIfcBridge protocol must be Zircon transported to be usable by the bridged driver. Second, the Zircon transport adds significant latency compared to the Driver transport. As a result, the frame_processor argument provides an FFI for the wlansoftmac driver to send Ethernet and WLAN packets to the bridged driver with latency comparable or better than a Driver transported protocol.

Except where noted, WlanSoftmacBridge methods must only be called after a successful call to WlanSoftmacBridge.Start.

Common errors include:

• ZX_ERR_ALREADY_BOUND: Start was already called on this softmac.

Fields

ifc_bridge: ClientEnd<WlanSoftmacIfcBridgeMarker>

frame_processor: u64

responder: WlanSoftmacBridgeStartResponder

SetEthernetStatus

Forwards a status containing ETHERNET_STATUS_* flags to the fuchsia.hardware.ethernet/EthernetImplIfc proxy owned by the C++ portion of wlansoftmac.

As documented, the value of status is set by bits defined in ETHERNET_STATUS_* flags. However, there is only one flag named ETHERNET_STATUS_ONLINE and no specification of for the meaning of specifying no flags. In practice, 0x1 means the status is up, and 0x0 means the status is down.

While this method should belong in something like an “EthernetImplIfcBridge protocol”, it’s included in the WlanSoftmacBridge protocol as a convenience. The wlansoftmac driver will eventually cease using a fuchsia.hardware.ethernet/EthernetImplIfc proxy and use a fuchsia.hardware.network.driver/NetworkDeviceIfc proxy instead. At that time, an equivalent of this method should be refactored into a separate bridge.

Fields

status: u32

responder: WlanSoftmacBridgeSetEthernetStatusResponder

Implementations

impl WlanSoftmacBridgeRequest

pub fn into_query(self) -> Option<WlanSoftmacBridgeQueryResponder>

pub fn into_query_discovery_support( self ) -> Option<WlanSoftmacBridgeQueryDiscoverySupportResponder>

pub fn into_query_mac_sublayer_support( self ) -> Option<WlanSoftmacBridgeQueryMacSublayerSupportResponder>

pub fn into_query_security_support( self ) -> Option<WlanSoftmacBridgeQuerySecuritySupportResponder>

pub fn into_query_spectrum_management_support( self ) -> Option<WlanSoftmacBridgeQuerySpectrumManagementSupportResponder>

pub fn into_set_channel( self ) -> Option<(WlanSoftmacBaseSetChannelRequest, WlanSoftmacBridgeSetChannelResponder)>

pub fn into_join_bss( self ) -> Option<(JoinBssRequest, WlanSoftmacBridgeJoinBssResponder)>

pub fn into_enable_beaconing( self ) -> Option<(WlanSoftmacBaseEnableBeaconingRequest, WlanSoftmacBridgeEnableBeaconingResponder)>

pub fn into_disable_beaconing( self ) -> Option<WlanSoftmacBridgeDisableBeaconingResponder>

pub fn into_install_key( self ) -> Option<(WlanKeyConfiguration, WlanSoftmacBridgeInstallKeyResponder)>

pub fn into_notify_association_complete( self ) -> Option<(WlanAssociationConfig, WlanSoftmacBridgeNotifyAssociationCompleteResponder)>

pub fn into_clear_association( self ) -> Option<(WlanSoftmacBaseClearAssociationRequest, WlanSoftmacBridgeClearAssociationResponder)>

pub fn into_start_passive_scan( self ) -> Option<(WlanSoftmacBaseStartPassiveScanRequest, WlanSoftmacBridgeStartPassiveScanResponder)>

pub fn into_start_active_scan( self ) -> Option<(WlanSoftmacStartActiveScanRequest, WlanSoftmacBridgeStartActiveScanResponder)>

pub fn into_cancel_scan( self ) -> Option<(WlanSoftmacBaseCancelScanRequest, WlanSoftmacBridgeCancelScanResponder)>

pub fn into_update_wmm_parameters( self ) -> Option<(WlanSoftmacBaseUpdateWmmParametersRequest, WlanSoftmacBridgeUpdateWmmParametersResponder)>

pub fn into_start( self ) -> Option<(ClientEnd<WlanSoftmacIfcBridgeMarker>, u64, WlanSoftmacBridgeStartResponder)>

pub fn into_set_ethernet_status( self ) -> Option<(u32, WlanSoftmacBridgeSetEthernetStatusResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for WlanSoftmacBridgeRequest

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

Formats the value using the given formatter.