Acronyms
Iface: Interface
Phy: Physical
Mac: Medium Access Control
Sta: Station
Addr: Address
PROTOCOLS
WlanPhyImpl
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
ClearCountry
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.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_ClearCountry_Result
|
CreateIface
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.
Request
| Name | Type |
|---|---|
payload |
WlanPhyImplCreateIfaceRequest
|
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_CreateIface_Result
|
DestroyIface
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.
Request
| Name | Type |
|---|---|
payload |
WlanPhyImplDestroyIfaceRequest
|
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_DestroyIface_Result
|
GetCountry
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.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_GetCountry_Result
|
GetPowerSaveMode
Get current Power Save mode from device. In most implementation this likely to be retrieved from Firmware.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_GetPowerSaveMode_Result
|
GetPowerState
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.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_GetPowerState_Result
|
GetSupportedMacRoles
MAC roles supported for ifaces on the physical device.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_GetSupportedMacRoles_Result
|
PowerDown
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.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_PowerDown_Result
|
PowerUp
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.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_PowerUp_Result
|
Reset
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.
Request
<EMPTY>
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_Reset_Result
|
SetCountry
Set country with a WlanPhyCountry.
Some common error codes are:
ZX_ERR_NOT_FOUND: Specified country code not supported. PHY state is left unchanged.
Request
| Name | Type |
|---|---|
payload |
WlanPhyCountry
|
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_SetCountry_Result
|
SetPowerSaveMode
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.
Request
| Name | Type |
|---|---|
payload |
WlanPhyImplSetPowerSaveModeRequest
|
Response
| Name | Type |
|---|---|
payload |
WlanPhyImpl_SetPowerSaveMode_Result
|
STRUCTS
WlanPhyImpl_ClearCountry_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
<EMPTY>
WlanPhyImpl_DestroyIface_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
<EMPTY>
WlanPhyImpl_PowerDown_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
<EMPTY>
WlanPhyImpl_PowerUp_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
<EMPTY>
WlanPhyImpl_Reset_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
<EMPTY>
WlanPhyImpl_SetCountry_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
<EMPTY>
WlanPhyImpl_SetPowerSaveMode_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
<EMPTY>
TABLES
WlanPhyImplCreateIfaceRequest resource
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Field | Type | Description |
|---|---|---|---|
1 |
role |
fuchsia.wlan.common/WlanMacRole
|
The station role for this interface. A device may support multiple roles, but an interface is instantiated with a single role. This field is required. |
2 |
mlme_channel |
handle<channel>
|
A handle to the direct MLME channel, if supported by the driver. This channel should be used by SME to communicate with MLME via the MLME protocol. This field is required. |
3 |
init_sta_addr |
fuchsia.wlan.ieee80211/MacAddr
|
The initial station address set from configuration layer. This field is optional. |
WlanPhyImplDestroyIfaceRequest
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Field | Type | Description |
|---|---|---|---|
1 |
iface_id |
uint16
|
This field is required. |
WlanPhyImplSetPowerSaveModeRequest
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Field | Type | Description |
|---|---|---|---|
1 |
ps_mode |
fuchsia.wlan.common/PowerSaveType
|
This field is required. |
WlanPhyImpl_CreateIface_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Field | Type | Description |
|---|---|---|---|
1 |
iface_id |
uint16
|
This field is always present. |
WlanPhyImpl_GetPowerSaveMode_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Field | Type | Description |
|---|---|---|---|
1 |
ps_mode |
fuchsia.wlan.common/PowerSaveType
|
This field is required. |
WlanPhyImpl_GetPowerState_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Field | Type | Description |
|---|---|---|---|
1 |
power_on |
bool
|
WlanPhyImpl_GetSupportedMacRoles_Response
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Field | Type | Description |
|---|---|---|---|
1 |
supported_mac_roles |
vector<fuchsia.wlan.common/WlanMacRole>:16
|
UNIONS
WlanPhyCountry flexible
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
alpha2 |
array<uint8, 2>
|
ISO Alpha-2 takes two octet alphabet characters. This needs to be expanded if at least one WLAN device driver or firmware requires more than two octets. |
WlanPhyImpl_ClearCountry_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_ClearCountry_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_CreateIface_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_CreateIface_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_DestroyIface_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_DestroyIface_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_GetCountry_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyCountry
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_GetPowerSaveMode_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_GetPowerSaveMode_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_GetPowerState_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_GetPowerState_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_GetSupportedMacRoles_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_GetSupportedMacRoles_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_PowerDown_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_PowerDown_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_PowerUp_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_PowerUp_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_Reset_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_Reset_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_SetCountry_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_SetCountry_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
WlanPhyImpl_SetPowerSaveMode_Result strict
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Ordinal | Variant | Type | Description |
|---|---|---|---|
1 |
response |
WlanPhyImpl_SetPowerSaveMode_Response
|
|
2 |
err |
zx/Status
|
|
3 |
framework_err |
internal
|
CONSTANTS
| Name | Value | Type | Description |
|---|---|---|---|
| WLANPHY_ALPHA2_LEN |
2
|
uint8 |
SERVICES
Service
Defined in fuchsia.wlan.phyimpl/phyimpl.fidl
| Name | Type | Transport |
|---|---|---|
| wlan_phy_impl |
fuchsia.wlan.phyimpl/WlanPhyImpl
|
Driver |