Enum WlanSoftmacBaseRequest

pub enum WlanSoftmacBaseRequest {
    Query {
        responder: WlanSoftmacBaseQueryResponder,
    },
    QueryDiscoverySupport {
        responder: WlanSoftmacBaseQueryDiscoverySupportResponder,
    },
    QueryMacSublayerSupport {
        responder: WlanSoftmacBaseQueryMacSublayerSupportResponder,
    },
    QuerySecuritySupport {
        responder: WlanSoftmacBaseQuerySecuritySupportResponder,
    },
    QuerySpectrumManagementSupport {
        responder: WlanSoftmacBaseQuerySpectrumManagementSupportResponder,
    },
    SetChannel {
        payload: WlanSoftmacBaseSetChannelRequest,
        responder: WlanSoftmacBaseSetChannelResponder,
    },
    JoinBss {
        join_request: JoinBssRequest,
        responder: WlanSoftmacBaseJoinBssResponder,
    },
    EnableBeaconing {
        payload: WlanSoftmacBaseEnableBeaconingRequest,
        responder: WlanSoftmacBaseEnableBeaconingResponder,
    },
    DisableBeaconing {
        responder: WlanSoftmacBaseDisableBeaconingResponder,
    },
    InstallKey {
        payload: WlanKeyConfiguration,
        responder: WlanSoftmacBaseInstallKeyResponder,
    },
    NotifyAssociationComplete {
        assoc_cfg: WlanAssociationConfig,
        responder: WlanSoftmacBaseNotifyAssociationCompleteResponder,
    },
    ClearAssociation {
        payload: WlanSoftmacBaseClearAssociationRequest,
        responder: WlanSoftmacBaseClearAssociationResponder,
    },
    StartPassiveScan {
        payload: WlanSoftmacBaseStartPassiveScanRequest,
        responder: WlanSoftmacBaseStartPassiveScanResponder,
    },
    StartActiveScan {
        payload: WlanSoftmacStartActiveScanRequest,
        responder: WlanSoftmacBaseStartActiveScanResponder,
    },
    CancelScan {
        payload: WlanSoftmacBaseCancelScanRequest,
        responder: WlanSoftmacBaseCancelScanResponder,
    },
    UpdateWmmParameters {
        payload: WlanSoftmacBaseUpdateWmmParametersRequest,
        responder: WlanSoftmacBaseUpdateWmmParametersResponder,
    },
}

WlanSoftmacBase is a template protocol intended to be composed into WlanSoftmacBridge and WlanSoftmac. WlanSoftmacBase contains all method that both WlanSoftmacBridge and WlanSoftmac have in common. WlanSoftmacBase should not be implemented directly.

NOTE: All methods use a selector attribute to maintain their ordinal following migration from WlanSoftmac into this protocol. This is necessary to preserve API compatibility.

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.

Note: The implementation of this method must not depend on a response from an ethernet driver, otherwise there is a risk of deadlock. The wlansoftmac driver calls this method synchronously while serving the fuchsia.hardware.ethernet/EthernetImpl.Query method.

Fields

responder: WlanSoftmacBaseQueryResponder

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: WlanSoftmacBaseQueryDiscoverySupportResponder

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.

Note: The implementation of this method must not depend on a response from an ethernet driver, otherwise there is a risk of deadlock. The wlansoftmac driver calls this method synchronously while serving the fuchsia.hardware.ethernet/EthernetImpl.Query method.

Fields

responder: WlanSoftmacBaseQueryMacSublayerSupportResponder

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: WlanSoftmacBaseQuerySecuritySupportResponder

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: WlanSoftmacBaseQuerySpectrumManagementSupportResponder

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: WlanSoftmacBaseSetChannelResponder

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: WlanSoftmacBaseJoinBssResponder

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: WlanSoftmacBaseEnableBeaconingResponder

DisableBeaconing

Disables hardware beaconing.

Fields

responder: WlanSoftmacBaseDisableBeaconingResponder

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: WlanSoftmacBaseInstallKeyResponder

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: WlanSoftmacBaseNotifyAssociationCompleteResponder

ClearAssociation

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

Fields

payload: WlanSoftmacBaseClearAssociationRequest

responder: WlanSoftmacBaseClearAssociationResponder

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: WlanSoftmacBaseStartPassiveScanResponder

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: WlanSoftmacBaseStartActiveScanResponder

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: WlanSoftmacBaseCancelScanResponder

UpdateWmmParameters

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

Fields

payload: WlanSoftmacBaseUpdateWmmParametersRequest

responder: WlanSoftmacBaseUpdateWmmParametersResponder

Implementations

impl WlanSoftmacBaseRequest

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

pub fn into_query_discovery_support( self, ) -> Option<WlanSoftmacBaseQueryDiscoverySupportResponder>

pub fn into_query_mac_sublayer_support( self, ) -> Option<WlanSoftmacBaseQueryMacSublayerSupportResponder>

pub fn into_query_security_support( self, ) -> Option<WlanSoftmacBaseQuerySecuritySupportResponder>

pub fn into_query_spectrum_management_support( self, ) -> Option<WlanSoftmacBaseQuerySpectrumManagementSupportResponder>

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

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

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

pub fn into_disable_beaconing( self, ) -> Option<WlanSoftmacBaseDisableBeaconingResponder>

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

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

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

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

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

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

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

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

Name of the method defined in FIDL

Trait Implementations

impl Debug for WlanSoftmacBaseRequest

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

Formats the value using the given formatter.