fuchsia.wlan.common

Added: 7

STRUCTS

BandRssiAdjustment

Defined in fuchsia.wlan.common/wlan_common.fidl

An adjustment to be made to the observed RSSI values for BSSs in the specified band.

Added: HEAD

FieldTypeDescriptionDefault
band fuchsia.wlan.ieee80211/WlanBand No default
rssi_adjustment int8 No default

ScheduledScanPlan

Defined in fuchsia.wlan.common/wlan_common.fidl

A scan plan defines the number of scan iterations and the interval between scans. Time of first scan (e.g. t=0, t=interval, etc.) is determined by the firmware.

Added: HEAD

FieldTypeDescriptionDefault
interval uint32

The interval between scans, in seconds.

No default
iterations uint32

The number of iterations to scan for. If 0, the scan plan will run indefinitely.

No default

WlanChannel

Defined in fuchsia.wlan.common/history.fidl

Removed: 28

FieldTypeDescriptionDefault
primary uint8 No default
cbw ChannelBandwidth No default
secondary80 uint8 No default

WlanTxResult

Defined in fuchsia.wlan.common/history.fidl

TX status reports are used by the Minstrel rate selection algorithm Tests should use the default value in //src/connectivity/wlan/testing/hw-sim/src/lib.rs

Removed: HEAD Added: 13

FieldTypeDescriptionDefault
tx_result_entry array<WlanTxResultEntry, 8>

up to 8 different tx_result_entry for one PPDU frame. WLAN_TX_VECTOR_IDX_INVALID indicates no more entries.

No default
peer_addr fuchsia.wlan.ieee80211/MacAddr

Destination mac address, or addr1 in packet header.

No default
result_code WlanTxResultCode No default

WlanTxResultEntry

Defined in fuchsia.wlan.common/history.fidl

One entry in a WlanTxResult report. Indicates a number of attempted transmissions on a particular tx vector, but does not imply successful transmission.

Removed: HEAD Added: 13

FieldTypeDescriptionDefault
tx_vector_idx uint16 No default
attempts uint8

Number of total attempts with this specific tx vector, including successful attempts. DDK assumes the number of attempts per packet will not exceed 255. (typically <= 8)

No default

WlanWmmAccessCategoryParameters

Defined in fuchsia.wlan.common/history.fidl

WFA WMM v1.2, 2.2.2

Removed: HEAD Added: 13

FieldTypeDescriptionDefault
ecw_min uint8 No default
ecw_max uint8 No default
aifsn uint8 No default
txop_limit uint16 No default
acm bool No default

WlanWmmParameters

Defined in fuchsia.wlan.common/history.fidl

Removed: HEAD Added: 13

FieldTypeDescriptionDefault
apsd bool No default
ac_be_params WlanWmmAccessCategoryParameters No default
ac_bk_params WlanWmmAccessCategoryParameters No default
ac_vi_params WlanWmmAccessCategoryParameters No default
ac_vo_params WlanWmmAccessCategoryParameters No default

ENUMS

BssType flexible

Type: uint32

Defined in fuchsia.wlan.common/history.fidl

Removed: HEAD Added: 13

NameValueDescription
0
1
2
3
4

ChannelBandwidth flexible

Type: uint32

Defined in fuchsia.wlan.common/history.fidl

Removed: 28 Added: 13

NameValueDescription
1
2
3
4
5
6

DataPlaneType flexible

Type: uint8

Defined in fuchsia.wlan.common/driver_features.fidl

Indicates where data plane is implemented.

NameValueDescription
1
2

GuardInterval strict

Type: uint8

Defined in fuchsia.wlan.common/history.fidl

HT and VHT guard interval. See IEEE 802.11-2016 Table 19-1 and Table 21-1.

Removed: HEAD

NameValueDescription
1
2

MacImplementationType flexible

Type: uint8

Defined in fuchsia.wlan.common/driver_features.fidl

Indicates where MAC layer is implemented.

NameValueDescription
1
2

PowerSaveType strict

Type: uint32

Defined in fuchsia.wlan.common/wlan_common.fidl

NameValueDescription
0
1
2
3

ScanType strict

Type: uint32

Defined in fuchsia.wlan.common/wlan_common.fidl

NameValueDescription
1
2

WlanKeyType flexible

Type: uint8

Defined in fuchsia.wlan.common/history.fidl

Removed: HEAD Added: 13

NameValueDescription
1
2
3
4

WlanMacRole flexible

Type: uint32

Defined in fuchsia.wlan.common/wlan_common.fidl

NameValueDescription
1
2
3

WlanPhyType flexible

Type: uint32

Defined in fuchsia.wlan.common/history.fidl

Removed: HEAD

NameValueDescription
1
2
3
4
5
6
7
8
9
10
11
12

WlanSoftmacHardwareCapabilityBit strict

Type: uint32

Defined in fuchsia.wlan.common/history.fidl

Removed: HEAD

NameValueDescription
32
256
512
1024
4096
65536

WlanTxResultCode flexible

Type: uint8

Defined in fuchsia.wlan.common/history.fidl

Outcome of a packet transmission.

Removed: HEAD Added: 13

NameValueDescription
0

ACK was not received or transmission otherwise failed.

1

ACK was received from peer.

TABLES

ApfPacketFilterSupport

Defined in fuchsia.wlan.common/driver_features.fidl

Android Packet Filter (APF) support.

Added: 31

OrdinalFieldTypeDescription
supported bool
version int32

Only valid if 'supported' is true.

max_filter_length int32

Only valid if 'supported' is true.

DataPlaneExtension

Defined in fuchsia.wlan.common/driver_features.fidl

Indicates where the data plane is implemented. This is a MAC sublayer extension, usable for fullmac or softmac. This extension is not part of the 802.11-2016 spec.

OrdinalFieldTypeDescription
data_plane_type DataPlaneType

DeviceExtension

Defined in fuchsia.wlan.common/driver_features.fidl

Feature-like information specific to the device. This is a MAC sublayer extension. This extension is not part of the 802.11-2016 spec.

OrdinalFieldTypeDescription
is_synthetic bool

Indicates that device is not a real hardware device. This extension only exists to support the SYNTH value in fuchsia.hardware.ethernet/EthernetFeature.

mac_implementation_type MacImplementationType

Indicates where MAC layer is implemented.

tx_status_report_supported bool

Indicates whether device supports transmission reports.

DfsFeature

Defined in fuchsia.wlan.common/driver_features.fidl

Dynamic Frequency Selection. See IEEE 802.11-2016 11.9. This is a spectrum management feature, usable for fullmac or softmac.

OrdinalFieldTypeDescription
supported bool

If true, driver implements DFS procedures (e.g. vacate channel upon detecting RADAR). Based on whether the driver implements DFS procedures, higher layers may adjust their logic (e.g. to include/exclude channels that require DFS).

DiscoverySupport

Defined in fuchsia.wlan.common/driver_features.fidl

Features related to discovery of potential BSSs. See IEEE 802.11-2016 11.1.4.2 and 11.1.4.3.

Removed: HEAD

OrdinalFieldTypeDescription
scan_offload ScanOffloadExtension
probe_response_offload ProbeResponseOffloadExtension

JoinBssRequest

Defined in fuchsia.wlan.common/history.fidl

Input parameters for a join request. This definition is shared between softmac.fidl and wlantap.fidl.

Removed: HEAD Added: 13

OrdinalFieldTypeDescription
bssid fuchsia.wlan.ieee80211/MacAddr
bss_type BssType
remote bool
beacon_period uint16

MacSublayerSupport

Defined in fuchsia.wlan.common/driver_features.fidl

Features related to the MAC sublayer (below MLME). See IEEE 802.11-2016 10.

OrdinalFieldTypeDescription
rate_selection_offload RateSelectionOffloadExtension
data_plane DataPlaneExtension
device DeviceExtension

MfpFeature

Defined in fuchsia.wlan.common/driver_features.fidl

Management Frame Protection. See IEEE 802.11-2016 4.5.4.9. This is a security feature, usable for fullmac or softmac.

OrdinalFieldTypeDescription
supported bool

OweFeature

Defined in fuchsia.wlan.common/driver_features.fidl

Opportunistic Wireless Encryption. See RFC 8110. This is a security feature, usable for fullmac or softmac.

Added: 31

OrdinalFieldTypeDescription
supported bool

ProbeResponseOffloadExtension

Defined in fuchsia.wlan.common/driver_features.fidl

Indicates where and how probe responses are to be handled. See IEEE 802.11-2016 11.1.4.3. This is a discovery extension, expected to be used for softmac only.

Removed: HEAD

OrdinalFieldTypeDescription
supported bool

If true, driver responds to probe requests; otherwise MLME must respond.

RateSelectionOffloadExtension

Defined in fuchsia.wlan.common/driver_features.fidl

Indicates where and how rate selection logic is orchestrated. See IEEE 802.11-2016 10.7. This is a MAC sublayer extension, expected to be used for softmac only.

OrdinalFieldTypeDescription
supported bool

If true, driver orchestrates rate selection; otherwise MLME must do so.

SaeFeature

Defined in fuchsia.wlan.common/driver_features.fidl

Simultaneous Authentication of Equals. See IEEE 802.11-2016 12.4. This is a security feature, usable for fullmac or softmac.

OrdinalFieldTypeDescription
driver_handler_supported bool

SAE can be handled by the driver.

sme_handler_supported bool

SAE can be handled by SME.

hash_to_element_supported bool

Indicates whether the driver is compatible with SAE hash-to-element. In the SME handler case, this just means passing through SAE frames with the SAE_HASH_TO_ELEMENT status code.

Added: 30

ScanOffloadExtension

Defined in fuchsia.wlan.common/driver_features.fidl

Indicates where and how scan logic is orchestrated. See IEEE 802.11-2016 11.1.4.2 and 11.1.4.3. This is a discovery extension, expected to be used for softmac only.

Removed: HEAD

OrdinalFieldTypeDescription
supported bool

If true, driver orchestrates scans; otherwise MLME must do so.

scan_cancel_supported bool
Added: 10

ScheduledScanMatchSet

Defined in fuchsia.wlan.common/wlan_common.fidl

A nested set of attributes to match during scheduled scans. A BSS must meet ALL of the present criteria in the match set to be considered a match.

Since not all hardware supports matching all types of attributes, there is no guarantee that the reported BSSs are fully compliant with the match sets. A driver may return EINVAL if it cannot support a match set, or may ignore the match criteria.

Added: HEAD

OrdinalFieldTypeDescription
ssid fuchsia.wlan.ieee80211/Ssid

Optional.

bssid fuchsia.wlan.ieee80211/MacAddr

Optional.

min_rssi_threshold int8

Optional. Minimum RSSI threshold to be applied to all BSSs.

relative_rssi_threshold int8

Optional. RSSI value delta, relative to the current connected BSS's RSSI to satisfy the match set. May be negative (i.e. -5 dB would require an observed BSS's RSSI to be no less than the current RSSI - 5 dB). If not currently connected, this field is ignored.

band_rssi_adjustments vector<BandRssiAdjustment>

Optional. RSSI band adjustments to make to observed RSSI values before comparing to the minimum and relative RSSI thresholds.

ScheduledScanRequest

Defined in fuchsia.wlan.common/wlan_common.fidl

Request for scheduled scanning.

Added: HEAD

OrdinalFieldTypeDescription
scan_plans vector<ScheduledScanPlan>

Required: one or more scan plans, to be run consecutively. In some firmware implementations, the last scan plan may run indefinitely, regardless of the iterations field value.

ssids vector<fuchsia.wlan.ieee80211/Ssid>

Optional. Zero or more SSIDs to scan for.

If present, SSIDs should be included in probe requests. If an empty string is present, a broadcast SSID should be sent in probe requests. If the vector is empty or not present, only passive scanning should be performed.

frequencies vector<uint32>

Optional. Zero or more channel frequencies that should be scanned. If empty or not present, all channels for the regulatory domain will be scanned.

min_rssi_threshold int8

Optional. Minimum RSSI threshold to be applied to all BSSs.

relative_rssi_threshold int8

Optional. RSSI value delta, relative to the current connected BSS's RSSI to satisfy the match set. May be negative (i.e. -5 dB would require an observed BSS's RSSI to be no less than the current RSSI - 5 dB). If not currently connected, this field is ignored.

band_rssi_adjustments vector<BandRssiAdjustment>

Optional. RSSI band adjustments to make to observed RSSI values before comparing to the minimum and relative RSSI thresholds.

match_sets vector<ScheduledScanMatchSet>

Zero or more sets of match criteria.

If present, only BSSs that pass through the top-level RSSI threshold filters AND match any of the match sets will be reported.

SecuritySupport

Defined in fuchsia.wlan.common/driver_features.fidl

Features related to security / access control and data confidentiality. See IEEE 802.11-2016 4.5.4 and 802.11-2016 12.

OrdinalFieldTypeDescription
sae SaeFeature
mfp MfpFeature
owe OweFeature
Added: 31

SpectrumManagementSupport

Defined in fuchsia.wlan.common/driver_features.fidl

Features related to spectrum management. See IEEE 802.11-2016 4.5.5, 11.8, and 11.9.

OrdinalFieldTypeDescription
dfs DfsFeature

CONSTANTS

NameValueTypeDescription
MAX_BANDS 16 uint8

This constant defined the fixed length for arrays containing the capabilities for each band supported by a device driver.

MAX_SUPPORTED_MAC_ROLES 16 uint8

This constant defines fixed length for arrays containing MAC roles supported by PHY entities.

MAX_SUPPORTED_PHY_TYPES 64 uint8

This constant defines fixed length for arrays containing PHY types supported by PHY entities.

WLAN_MAC_MAX_EXT_RATES 255 uint32
Removed: NEXT Added: 13
WLAN_MAC_MAX_SUPP_RATES 8 uint32
Removed: NEXT Added: 13
WLAN_TX_RESULT_MAX_ENTRY 8 uint32
Removed: HEAD Added: 13
WLAN_TX_VECTOR_IDX_INVALID 0 uint16
Removed: HEAD

ALIASES

NameValueDescription
WlanSoftmacHardwareCapability uint32
Removed: HEAD