fuchsia.wlan.fullmac

0 indexed antenna number of freq.

The values of this struct apply to the band indicated in this field.

Basic rates supported in units of 500 kbit/s (as defined in IEEE Std 802.11-2016, 9.4.2.3), e.g., 0x02 represents 1 Mbps. The value returned by this type indicates all the non-HT rates the device supports transmitting and receiving.

If the device supports the HT PHY mode in this band, then ht_supported is set to true, and the value in ht_caps indicates the capabilities. Otherwise, ht_supported is set to false.

If the device supports the VHT PHY mode in this band, then vht_supported is set to true, and the value in vht_caps indicates the capabilities. Otherwise, vht_supported is set to false.

A list of operating channels considered valid by hardware, in the context of regulatory information known to the device driver, at the time of its construction during iface creation. In this context, an operating channel means a channel which APs may transmit Beacon frames on in the current regulatory domain.

This list should be used to determine efficacy of subsequent requests to scan a subset of channels using the iface, or to determine which operating channel to use when starting an AP.

This value corresponds to the dst_addr in the EapolTxRequest we're confirming. IEEE 802.11-2016 does not include this field, but we need it to disambiguate if multiple EAPoL handshakes are ongoing.

Index into a lookup table for each histogram type. The lookup table for each type is described below in the comments for each type.

The count of samples in the bucket.

If hist_scope is PER_ANTENNA, antenna_id must be provided.

Sparse histogram of noise floor of current channel in dBm. Each sample's bucket_index is an index into this list of dBm values: [-255, -254, ... -1]. For example, if noise_floor_samples contains a WlanFullmacHistBucket with bucket_index = 165 and num_samples = 50, that means there were 50 frames counted that had a noise floor of -90 dBm.

Count of invalid samples encountered, if any.

If hist_scope is PER_ANTENNA, antenna_id must be provided.

Sparse histogram of RSSI of AP in dBm. Each sample's bucket_index is an index into this list of dBm values: [-255, -254, ... -1]. For example, if rssi_samples contains a WlanFullmacHistBucket with bucket_index = 225 and num_samples = 50, that means there were 50 frames counted that had a signal level of -30 dBm.

Count of invalid samples encountered, if any.

If hist_scope is PER_ANTENNA, antenna_id must be provided.

Sparse histogram of count of received frames for each rate. Each sample's bucket_index is an index into this lookup table: 0-3: B-MCS 0-3 4-11: G-MCS 0-7 12-27: N-MCS 0-15 (BW20) 28-43: N-MCS 0-15 (BW40) 44-59: N-MCS 0-15 (BW20:SGI) 60-75: N-MCS 0-15 (BW40:SGI) 76-85: AC-MCS 0-9 (VHT:BW20:NSS1) 86-95: AC-MCS 0-9 (VHT:BW20:NSS2) 96-105: AC-MCS 0-9 (VHT:BW40:NSS1) 106-115: AC-MCS 0-9 (VHT:BW40:NSS2) 116-125: AC-MCS 0-9 (VHT:BW80:NSS1) 126-135: AC-MCS 0-9 (VHT:BW80:NSS2) 136-145: AC-MCS 0-9 (VHT:BW20:NSS1:SGI) 146-155: AC-MCS 0-9 (VHT:BW20:NSS2:SGI) 156-165: AC-MCS 0-9 (VHT:BW40:NSS1:SGI) 166-175: AC-MCS 0-9 (VHT:BW40:NSS2:SGI) 176-185: AC-MCS 0-9 (VHT:BW80:NSS1:SGI) 186-195: AC-MCS 0-9 (VHT:BW80:NSS2:SGI)

For example, if rx_rate_index_samples contains a WlanFullmacHistBucket with bucket_index = 75 and num_samples = 50, that means there were 50 frames counted that had a rate corresponding to N-MCS 15 (BW40:SGI).

Count of invalid samples encountered, if any.

If hist_scope is PER_ANTENNA, antenna_id must be provided.

Sparse histogram of signal to noise ratio in dB. Each sample's bucket_index is an index into this list of dB values: [0, 1, ... 255]. For example, if snr_samples contains a WlanFullmacHistBucket with value = 60 and num_samples = 50, that means there were 50 frames counted that had a SNR of 60 dB.

Count of invalid samples encountered, if any.

SUCCESS

REFUSED_REASON_UNSPECIFIED

REFUSED_NOT_AUTHENTICATED

REFUSED_CAPABILITIES_MISMATCH

REFUSED_EXTERNAL_REASON

REFUSED_AP_OUT_OF_MEMORY

REFUSED_BASIC_RATES_MISMATCH

REJECTED_EMERGENCY_SERVICES_NOT_SUPPORTED

REFUSED_TEMPORARILY

SUCCESS

REFUSED

ANTI_CLOGGING_TOKEN_REQUIRED

FINITE_CYCLIC_GROUP_NOT_SUPPORTED

REJECTED

FAILURE_TIMEOUT

OPEN_SYSTEM

SHARED_KEY

FAST_BSS_TRANSITION

SAE

SUCCESS

TRANSMISSION_FAILURE

ANTENNA_2_G

2.4 GHz.

ANTENNA_5_G

5 GHz.

STATION

PER_ANTENNA

SUCCESS

NOT_SUPPORTED

INVALID_ARGS

INTERNAL_ERROR

SHOULD_WAIT

CANCELED_BY_DRIVER_OR_FIRMWARE

ACTIVE

PASSIVE

SUCCESS

BSS_ALREADY_STARTED_OR_JOINED

RESET_REQUIRED_BEFORE_START

NOT_SUPPORTED

SUCCESS

BSS_ALREADY_STOPPED

INTERNAL_ERROR

1

2

3

1

Noise floor histogram(s).

2

Received signal strength indicator (RSSI) histogram(s).

3

Received rate index histogram(s).

4

Signal to noise ratio (SNR) histogram(s).

1

2

3

1

2

1

2

Timeout specified in beacon interval.

3

Additional parameters specific to the authentication exchange.

4

sae_password is ignored except when SAE_DRIVER_AUTH is enabled and the auth_type is SAE.

5

WEP key used in the authentication exchange. Only included for WEP security type.

6

Additional parameters specific to the association exchange.

1

2

1

2

1

2

3

1

2

3

4

5

1

2

1

2

3

4

1

1

MAC address of the peer. Required.

2

Reason code for deauthentication. Required.

3

locally_initiated is true if deauth is initiated from the device, and is false if it's initiated remotely (e.g. due to deauth frame)

1

ZX_OK indicates that the disassociate request was serviced and the peer was disassociated. Other errors indicate that the request could not be serviced, for these or other reasons:

• ZX_ERR_BAD_STATE: association not possible in current state (e.g. disconnected)
• ZX_ERR_INVALID_ARGS: no association exists with specified peer
• ZX_ERR_SHOULD_WAIT: disassociate request could not be serviced because firmware or driver was busy

1

Address of the peer that was disassociated. Required.

2

Reason for the disassociation. Required.

3

Whether the disassociation was initiated from the device. Required. locally_initiated is true if disassociation was initiated from the device (e.g. firmware or vendor driver started the disassociation); false if the disassociation was initiated externally (e.g. due to receipt of a disassociate frame from an AP).

1

2

1

2

3

1

BSSID of the target BSS. Required.

2

Result of the roam attempt. Required.

3

Whether the original BSS association has been maintained through the roam attempt. Required. A successful roam always incurs disassociation from the original BSS, so if status_code is success then this field must be set to false; a roam failure typically incurs disassociation from the original BSS, but may not in some cases (e.g. in some Fast BSS Transition scenarios).

4

Whether the client is authenticated with the target BSS. If status_code is success, then this field must be set to true; if the roam attempt failed, this field may be true or false. This allows higher layers to decide how to clean up connection state after a failed roam attempt.

5

Association ID for this association with the AP. Required if status_code is success.

6

IEs for this association with the AP. Required if status_code is success.

1

BSSID of the target BSS. Required.

2

Result of the roam attempt. Required.

3

Whether the original BSS association has been maintained through the roam attempt. Required. A successful roam always incurs disassociation from the original BSS, so if status_code is success then this field must be set to false; a roam failure typically incurs disassociation from the original BSS, but may not in some cases (e.g. in some Fast BSS Transition scenarios).

4

Whether the client is authenticated with the target BSS. If status_code is success, then this field must be set to true; if the roam attempt failed, this field may be true or false. This allows higher layers to decide how to clean up connection state after a failed roam attempt.

5

Association ID for this association with the AP. Required if status_code is success.

6

IEs for this association with the AP. Required if status_code is success.

1

BSSID of the target BSS. Required.

2

Full BSS description of the target BSS. Required. If the data in BssDescription is incorrect or incomplete, the roam cannot succeed, because higher layers will not be able to complete required actions (e.g. SAE).

3

Whether the original BSS association has been maintained at the start of a roam attempt. Required. 802.11 dictates that a STA can only be associated with a single BSS, so a roam attempt typically incurs disassociation at the start of the roam attempt. However, 802.11 also provides a mechanism (i.e. Fast BSS Transition) that allows a device to maintain association with the original BSS while establishing authentication with the target BSS, in order to avoid losing the original association if authentication with the target BSS fails.

1

The WlanFullmacImplifc client end. Required.

1

1

1

Full BSS description of the target BSS. Required. If the data in BssDescription is incorrect or incomplete, the roam cannot succeed, because higher layers will not be able to complete required actions (e.g. SAE).

1

1

2

3

4

5

6

7

1

Unique transaction id (will be indicated in corresponding scan results).

2

3

List of channels to scan on. An empty list of channels will cause a scan request to immediately return a OnScanEnd with code INVALID_ARGS.

Invalid channel numbers will be silently ignored. The validity of a channel number depends on the current regulatory region, and a FullMAC driver cannot always determine the region setting. This is especially the case when firmware changes the region setting dynamically.

4

List of SSIDs to scan for. An empty list of ssids is the same as specifying a list containing only the wildcard SSID.

There is no limit on the number of SSIDs specified. A large number of SSIDs may result in extended scan times because of hardware limitations on the number of SSIDs permitted per scan request and the technical limitation in IEEE 802.11-2016 that limits the number of SSIDs in a single Probe Request frame to ieee80211.SSID_LIST_MAX SSIDs.

5

Minimum amount of time in msecs spent on a channel during scan.

6

Maximum amount of time in msecs spent on a channel during scan.

1

1

The SME server end channel. Required.

1

Station address. Required.

2

MAC role. Required.

3

Supported bands. Required.

1

2

1

2

1

2

1

2

1

2

1

2

1

2

For each histogram type (e.g. RSSI), there can be multiple histograms up to this limit. For example, an interface might have 1 histogram for station-wide RSSI, but also 1 for each of the antennas used by the interface.

All histograms have a fixed number of buckets. To save space, each histogram type uses a vector to hold only non-empty buckets (a sparse histogram), with these constants as the max size of each vector. Noise floor values range from -255 to -1 dBm.

RSSI values range from -255 to -1 dBm.

Size of RX_RATE_INDEX lookup table (see comments in RxRateIndexHistogram).

SNR values range from 0 to 255 dB.

The number of 802.11AC rates in the WlanFullmacRxRateIndexHistogram lookup table.

The number of 802.11B rates in the WlanFullmacRxRateIndexHistogram lookup table.

The number of 802.11G rates in the WlanFullmacRxRateIndexHistogram lookup table.

The number of 802.11N rates in the WlanFullmacRxRateIndexHistogram lookup table.

Max length for vendor IEs to be added to the association request. This is currently used for WPA.