| // Copyright 2022 The Fuchsia Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| library fuchsia.wlan.softmac; |
| |
| using fuchsia.wlan.common; |
| using fuchsia.wlan.ieee80211 as ieee80211; |
| using zx; |
| |
| type WlanSoftmacBandCapability = table { |
| /// The values of this struct apply to the band indicated in this field. |
| /// This field is required. |
| 1: band fuchsia.wlan.common.WlanBand; |
| |
| /// 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. |
| /// |
| /// The basic_rate_count field is required, and if its value is > 0, then |
| /// the basic_rate_list field is required as well. |
| 2: basic_rate_count uint8; |
| 3: basic_rate_list array<uint8, ieee80211.MAX_SUPPORTED_BASIC_RATES>; |
| |
| /// If the device supports HT PHY mode, then ht_supported must be set to 'true' and ht_caps |
| /// must be populated. If this mode is not supported, then ht_supported must be set to 'false' |
| /// and ht_caps must be left unpopulated. |
| 4: ht_supported bool; |
| 5: ht_caps ieee80211.HtCapabilities; |
| |
| /// If the device supports VHT PHY mode, then vht_supported must be set to 'true' and vht_caps |
| /// must be populated. If this mode is not supported, then vht_supported must be set to 'false' |
| /// and vht_caps must be left unpopulated. |
| 6: vht_supported bool; |
| 7: vht_caps ieee80211.VhtCapabilities; |
| |
| /// 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. |
| /// |
| /// The operating_channel_count field is required, and if its value is > 0, then |
| /// the operating_channel_list field is required as well. |
| 8: operating_channel_count uint16; |
| 9: operating_channel_list array<uint8, ieee80211.MAX_UNIQUE_CHANNEL_NUMBERS>; |
| }; |
| |
| /// High-level information describing the state of a running softmac. |
| /// All fields in this response are required. |
| type WlanSoftmacQueryResponse = table { |
| /// Station address. |
| 1: sta_addr ieee80211.MacAddr; |
| |
| /// MAC role |
| 2: mac_role fuchsia.wlan.common.WlanMacRole; |
| |
| /// Bitmask indicating WlanInfoPhyType values supported by the hardware. |
| @mutable |
| 3: supported_phys |
| vector<fuchsia.wlan.common.WlanPhyType>:fuchsia.wlan.common.MAX_SUPPORTED_PHY_TYPES; |
| |
| /// Bitmask indicating enabled WlanInfoHardwareCapability values. Values defined as fuchsia.wlan.common.WlanSoftmacHardwareCapability |
| 4: hardware_capability fuchsia.wlan.common.WlanSoftmacHardwareCapability; |
| |
| /// Supported bands. |
| @mutable |
| 5: band_caps vector<WlanSoftmacBandCapability>:fuchsia.wlan.common.MAX_BANDS; |
| }; |
| |
| |
| type WlanRxInfoValid = flexible bits : uint32 { |
| PHY = 0x1; |
| DATA_RATE = 0x2; |
| CHAN_WIDTH = 0x4; |
| MCS = 0x8; |
| RSSI = 0x10; |
| SNR = 0x20; |
| // Bits 6-31 reserved |
| }; |
| |
| type WlanRxInfoFlags = flexible bits : uint32 { |
| /// The FCS for the received frame was invalid. |
| FCS_INVALID = 0x1; |
| /// Padding was added after the MAC header to align the frame body to 4 bytes. |
| FRAME_BODY_PADDING_4 = 0x2; |
| // Bits 2-31 reserved |
| }; |
| |
| type WlanRxInfo = struct { |
| /// Receive flags. These represent boolean flags as opposed to enums or value-based info which |
| /// are represented below. Values should be taken from the WLAN_RX_INFO_FLAGS_* enum. |
| rx_flags WlanRxInfoFlags; |
| |
| /// Bitmask indicating which of the following fields are valid in this struct. Reserved flags |
| /// must be zero. |
| valid_fields WlanRxInfoValid; |
| |
| /// The PHY format of the device at the time of the operation. |
| phy fuchsia.wlan.common.WlanPhyType; |
| /// The data rate of the device, measured in units of 0.5 Mb/s. |
| data_rate uint32; |
| /// The channel of the device at the time of the operation. This field must be included. |
| channel fuchsia.wlan.common.WlanChannel; |
| /// The modulation and coding scheme index of the device at the time of the operation. Depends |
| /// on the PHY format and channel width. |
| mcs uint8; |
| |
| /// Received Signal Strength Indicator. |
| rssi_dbm int8; |
| /// Signal-to-Noise Ratio, in 0.5 dB. |
| snr_dbh int16; |
| }; |
| |
| type WlanTxInfoFlags = flexible bits : uint32 { |
| /// Indicate this packet should be protected. |
| PROTECTED = 0x1; |
| /// For rate control: indicate an important data frame, such as EAPOL, which should be sent |
| /// _reliably_ rather than fast, and is exempt from rate probing |
| FAVOR_RELIABILITY = 0x2; |
| /// Indicate that this packet should be sent out with QoS header when possible (11n+). |
| // TODO(fxbug.dev/29622): remove this when MLME supports QoS tag. |
| QOS = 0x4; |
| }; |
| |
| type WlanTxInfoValid = flexible bits : uint32 { |
| DATA_RATE = 0x1; |
| TX_VECTOR_IDX = 0x2; |
| PHY = 0x4; |
| CHANNEL_BANDWIDTH = 0x8; |
| MCS = 0x10; |
| }; |
| |
| type WlanTxInfo = struct { |
| /// Transmit flags. These represent boolean options as opposed to enums or other value-based |
| /// info which are represented below. Values should be taken from the WLAN_TX_INFO_FLAGS_* enum. |
| tx_flags uint32; |
| |
| /// Bitmask indicating which of the following fields are valid in this struct. Reserved flags |
| /// must be zero. Values for fields not indicated by a flag may be chosen at the discretion of |
| /// the softmac driver. |
| valid_fields uint32; |
| // Will be sent back in wlan_tx_result_t if Minstrel is enabled for the device, indicated by |
| // WLAN_TX_INFO_VALID_TX_VECTOR_IDX. |
| tx_vector_idx uint16; |
| // The PHY format to be used to transmit this packet. |
| phy fuchsia.wlan.common.WlanPhyType; |
| // The channel width to be used to transmit this packet. |
| channel_bandwidth fuchsia.wlan.common.ChannelBandwidth; |
| /// The modulation and coding scheme index for this packet. Depends on the PHY format and |
| /// channel width. |
| mcs uint8; |
| }; |
| |
| type WlanProtection = strict enum : uint8 { |
| NONE = 0; |
| RX = 1; |
| TX = 2; |
| RX_TX = 3; |
| }; |
| |
| type WlanKeyConfiguration = table { |
| /// Which path to protect: None, TX, RX, or TX and RX. |
| 1: protection WlanProtection; |
| /// IEEE Cipher suite selector. |
| /// See IEEE Std 802.11-2016, 9.4.2.25.2, Table 9-131 |
| 2: cipher_oui array<uint8, 3>; |
| 3: cipher_type uint8; |
| /// Whether this key is a pairwise, group or peer key. |
| 4: key_type fuchsia.wlan.common.WlanKeyType; |
| /// The peer MAC address for pairwise and peer keys. |
| /// For group keys this value is always the broadcast address. |
| 5: peer_addr ieee80211.MacAddr; |
| /// Index for rotating keys, e.g. group keys. |
| /// This value is always 0 for key types which aren't rotating, e.g. pairwise keys. |
| 6: key_idx uint8; |
| // They key's actual bytes. |
| 7: key vector<uint8>:ieee80211.MAX_KEY_LEN; |
| /// Receive Sequence Counter for group keys only. |
| /// In all other cases the RSC will be 0. |
| 8: rsc uint64; |
| }; |
| |
| type WlanRxPacket = struct { |
| @buffer |
| mac_frame vector<uint8>:MAX; |
| info WlanRxInfo; |
| }; |
| |
| type WlanTxPacket = struct { |
| @buffer |
| mac_frame vector<uint8>:MAX; |
| /// Additional data needed to transmit the packet. |
| /// TODO(fxbug.dev/105579): This field is ignored by iwlwifi. |
| info WlanTxInfo; |
| }; |
| |
| @discoverable |
| @transport("Driver") |
| @banjo_layout("ddk-interface") |
| closed protocol WlanSoftmacIfc { |
| /// Forward up a packet received over the wireless medium. |
| strict Recv(struct { |
| packet WlanRxPacket; |
| }) -> (); |
| |
| /// Reports the result of an attempted transmission. |
| /// |
| /// A device driver indicates support for `ReportTxResult()` using |
| /// `fuchsia.wlan.common/DeviceExtension.report_tx_result_supported`. |
| strict ReportTxResult(struct { |
| tx_result fuchsia.wlan.common.WlanTxResult; |
| }) -> (); |
| |
| /// Reports completion of a scan associated with the unique `scan_id`. `status` |
| /// indicates whether the scan completed successfully, failed due to an error, |
| /// or was cancelled. |
| /// |
| /// Return status indicates the reason for scan completion: |
| /// ZX_OK: All channels were scanned successfully. |
| /// ZX_ERR_CANCELLED: The scan was terminated by a user request, either an |
| /// explicit WlanSoftmac.CancelScan() or the initiation of an |
| /// incompatible request (e.g. connect). |
| /// ZX_ERR_OUT_OF_RANGE: The scan request included a prohibited channel. |
| /// This may be due to the current country setting. |
| strict NotifyScanComplete(table { |
| 1: status zx.Status; |
| 2: scan_id uint64; |
| }) -> (); |
| }; |
| |
| /// Argument struct to be passed as the single argument to WlanSoftmac.StartActiveScan |
| type WlanSoftmacStartActiveScanRequest = table { |
| /// List of channels to scan on. An empty list of channels will cause a |
| /// scan request to immediately return ZX_ERR_INVALID_ARGS. |
| /// |
| /// Invalid channel numbers will be silently ignored. The validity of a channel |
| /// number depends on the current regulatory region, and a SoftMAC driver cannot |
| /// always determine the region setting. This is especially the case when |
| /// firmware changes the region setting dynamically. |
| 1: channels vector<uint8>:ieee80211.MAX_UNIQUE_CHANNEL_NUMBERS; |
| |
| /// List of SSIDs to scan for. For a list with a single SSID, the SSID will be placed in |
| /// the SSID element in the Probe Request frame. For a list with more than one SSID, |
| /// all SSIDs will be placed in an SSID List element in the Probe Request frame with the |
| /// first SSID in the list in the required SSID element. An empty list is the same as |
| /// specifying a list containing only the wildcard SSID. |
| 2: ssids vector<ieee80211.CSsid>:ieee80211.SSID_LIST_MAX; |
| |
| /// Buffer containing a MAC header (as defined in IEEE Std 802.11-2016, 9.3.3.2) to |
| /// include in each Probe Request frame. |
| @buffer |
| 3: mac_header vector<uint8>:ieee80211.MAX_MGMT_FRAME_MAC_HEADER_BYTE_LEN; |
| |
| /// Buffer containing IE bytes to include in each Probe Request frame. |
| @buffer |
| 4: ies vector<uint8>:ieee80211.MAX_VHT_MPDU_BYTE_LEN_2; |
| |
| /// Minimum duration to spend on each channel during the scan. |
| 5: min_channel_time zx.Duration; |
| |
| /// Maximum duration to spend on each channel during the scan. |
| 6: max_channel_time zx.Duration; |
| |
| /// Minimum duration to spend on the home channel(s) between the dwell time on each channel |
| /// where a home channel corresponds to channels the device should otherwise be present |
| /// on while not scanning. |
| 7: min_home_time zx.Duration; |
| |
| /// Minimum number of Probe Request frames to transmit per channel visit during a scan. |
| /// The definition of a channel visit may differ between device drivers, but it is roughly |
| /// the interval of time spent on a specific channel during a scan. |
| /// |
| /// Sending more than one Probe Request frame on a channel may increase the probability that |
| /// it is received in a noisy environment. |
| 8: min_probes_per_channel uint8; |
| |
| /// Maximum number of Probe Request frames to transmit per channel visit during a scan. |
| /// The definition of a channel visit may differ between device drivers, but it is roughly |
| /// the interval of time spent on a specific channel during a scan. Specifying 0 is invalid |
| /// since at least one Probe Request frame must be transmitted for an active scan. |
| /// |
| /// Limiting the number of Probe Request frames sent on a channel reduces the time spent |
| /// transmitting frames, and thus increase the time spent receiving frames, while scanning. |
| 9: max_probes_per_channel uint8; |
| }; |
| |
| const WLAN_MAC_MAX_RATES uint32 = 263; // (8 + 255) |
| |
| /// Argument table to be passed as the single argument to |
| /// WlanSoftmac.NotifyAssociationComplete. |
| /// All information here is relevant only in the context of the association with |
| /// the given peer_addr. |
| /// All fields in this table are required unless stated otherwise. |
| type WlanAssociationConfig = table { |
| /// The MAC address of the peer with which we are now associated. |
| 1: bssid ieee80211.MacAddr; |
| /// A unique identifier for this specific association. This is unique among |
| /// active associations, not necessarily historical ones. |
| 2: aid uint16; |
| 3: listen_interval uint16; |
| /// The channel on which we have associated with this peer. |
| 4: channel fuchsia.wlan.common.WlanChannel; |
| |
| /// QoS capable and parameters |
| 5: qos bool; |
| /// WFA WMM v1.2, 2.2.2 |
| 6: wmm_params fuchsia.wlan.common.WlanWmmParameters; |
| |
| /// Concatenation of SupportedRates and ExtendedSupportedRates |
| /// IEEE Std 802.11-2016, 9.4.2.3 & 9.4.2.13 |
| 7: rates vector<uint8>:WLAN_MAC_MAX_RATES; |
| |
| /// IEEE Std 802.11-2016, 9.4.1.4 |
| 8: capability_info uint16; |
| |
| /// IEEE Std 802.11-2016, 9.4.2.56, 57 |
| /// Rx MCS Bitmask in Supported MCS Set field represents the set of MCS |
| /// the peer can receive at from this device, considering this device's Tx capability. |
| 9: ht_cap ieee80211.HtCapabilities; |
| 10: ht_op ieee80211.HtOperation; |
| |
| /// IEEE Std 802.11-2016, 9.4.2.158, 159 |
| 11: vht_cap ieee80211.VhtCapabilities; |
| 12: vht_op ieee80211.VhtOperation; |
| }; |
| |
| /// The wlansoftmac C++ driver establishes a FIDL channel serving the WlanSoftmacBridge |
| /// protocol to the wlan-mlme Rust library. The WlanSoftmacBridge protocol is similar to |
| /// WlanSoftmac but may not contain methods where the additional FIDL channel hinders |
| /// performance. |
| /// |
| /// WlanSoftmac composes a subset of its methods from WlanSoftmacBridge so |
| /// the wlansoftmac driver can trivially convert messages between the Zircon channel |
| /// transported WlanSoftmacBridge messages to the Driver transported WlanSoftmac messages. |
| /// |
| /// TODO(fxbug.dev/126613): Merge WlanSoftmacBridge into WlanSoftmac when FIDL supports |
| /// generating multiple transports for the same protocol, or generating Rust bindings |
| /// for Driver transported protocols. |
| /// |
| /// TODO(fxbug.dev/124830): This protocol allows wlansoftmac to eventually delete the |
| /// use of Banjo from wlansoftmac. This TODO comment will exist until the migration off |
| /// Banjo is complete. |
| closed protocol WlanSoftmacBridge { |
| /// Notify the device of a successful association and configure additional |
| /// parameters necessary to participate in that association. |
| /// |
| /// Common errors include: |
| /// ZX_ERR_BAD_STATE: The device was not previously informed of this BSS |
| /// via WlanSoftmac.JoinBss(). |
| strict NotifyAssociationComplete(struct { |
| assoc_cfg WlanAssociationConfig; |
| }) -> () error zx.Status; |
| }; |
| |
| @discoverable |
| @transport("Driver") |
| closed protocol WlanSoftmac { |
| compose WlanSoftmacBridge; |
| |
| // TODO(fxbug.dev/87050): the need to nest query response within a struct {} is no longer |
| // necessary. However if the response is a struct, then ReplySuccess() expects each field to be |
| // passed individually, which makes the code harder to read. Once all Query responses switch to |
| // tables, this can beconsidered. |
| |
| /// Obtain information about the device and supported features |
| /// Safe to call when the softmac is not started. |
| strict Query() -> (WlanSoftmacQueryResponse) error zx.Status; |
| |
| /// Query the underlying device for feature support related to station |
| /// discovery (e.g. scans and probes). Safe to call when the softmac is not |
| /// started. |
| strict QueryDiscoverySupport() -> (struct { |
| resp fuchsia.wlan.common.DiscoverySupport; |
| }) error zx.Status; |
| |
| /// Query the underlying device for information related to how it implements |
| /// MAC-level functionality. Safe to call when the softmac is not started. |
| strict QueryMacSublayerSupport() -> (struct { |
| resp fuchsia.wlan.common.MacSublayerSupport; |
| }) error zx.Status; |
| |
| /// Query the underlying device for features related to specific |
| /// security modes. Safe to call when the softmac is not started. |
| strict QuerySecuritySupport() -> (struct { |
| resp fuchsia.wlan.common.SecuritySupport; |
| }) error zx.Status; |
| |
| /// Query the underlying device for features related to spectrum usage, e.g. |
| /// DFS. Safe to call when the softmac is not started. |
| strict QuerySpectrumManagementSupport() -> (struct { |
| resp fuchsia.wlan.common.SpectrumManagementSupport; |
| }) error zx.Status; |
| |
| /// Start a softmac on the underlying device, using the given ifc to pass |
| /// events upwards. Callbacks on ifc may be invoked from now until Stop() |
| /// is called. |
| /// |
| /// The returned sme_channel is the server endpoint of a wlan_mlme.fidl:MLME |
| /// protocol, the client end of which is held by SME. This channel is used for |
| /// SME <-> MLME communication. |
| /// |
| /// Except where noted, WlanSoftmac APIs may only be called while the softmac |
| /// is running after a successful call to Start(). |
| /// |
| /// Common errors include: \ |
| /// ZX_ERR_ALREADY_BOUND: `Start` was already called on this softmac. |
| strict Start(resource struct { |
| ifc client_end:WlanSoftmacIfc; |
| }) -> (resource struct { |
| sme_channel zx.Handle:CHANNEL; |
| }) error zx.Status; |
| |
| /// Shut down the softmac if it is running. |
| /// Safe to call when the softmac is not running. |
| strict Stop() -> (); |
| |
| /// Queue a packet for transmission. May return before a packet has actually |
| /// been transmitted. This call does not take ownership of the buffer passed in |
| /// the WlanTxPacket. |
| /// |
| /// Errors result from a failure to queue the packet for transmission. |
| /// An OK result thus only indicates that the packet was queued, *not* that |
| /// it was successfully transmitted. |
| strict QueueTx(struct { |
| packet WlanTxPacket; |
| }) -> () error zx.Status; |
| |
| /// 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. |
| strict SetChannel(table { |
| 1: channel fuchsia.wlan.common.WlanChannel; |
| }) -> () error zx.Status; |
| |
| /// 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. |
| strict JoinBss(struct { |
| join_request fuchsia.wlan.common.JoinBssRequest; |
| }) -> () error zx.Status; |
| |
| /// Enables hardware Beaconing. This API cannot be invoked while beaconing is active. |
| /// DisableBeaconing() must be called before this API can be re-invoked. \ |
| /// All fields in the message 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. |
| strict EnableBeaconing(table { |
| /// Points to the beacon template. Since this is just the template, some packet content can |
| /// contain only minimum valid info. They will be changed later by hardware/firmware or |
| /// software. |
| 1: packet_template WlanTxPacket; |
| |
| /// TIM offset (in bytes) to the start of |bcn_tmpl|. This points to the first byte of |
| /// TIM IE, which is the tag ID. |
| 2: tim_ele_offset uint64; |
| |
| /// in TU |
| 3: beacon_interval uint16; |
| }) -> () error zx.Status; |
| |
| /// Disables hardware beaconing. |
| strict DisableBeaconing() -> () error zx.Status; |
| |
| /// 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. |
| strict InstallKey(WlanKeyConfiguration) -> () error zx.Status; |
| |
| /// Notifies MAC and PHY that the peer has been de-associated. |
| strict ClearAssociation(table { |
| 1: peer_addr ieee80211.MacAddr; |
| }) -> () error zx.Status; |
| |
| /// Start a passive scan in the device driver. Scan results will be delivered |
| /// as Beacon frames via WlanSoftmacIfc.Recv(). When complete, |
| /// WlanSoftmacIfc.ScanComplete() will be called with the corresponding |
| /// unique `scan_id`. |
| /// |
| /// A device driver 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. |
| strict StartPassiveScan(table { |
| /// List of channels to scan on. An empty list of channels will cause a |
| /// scan request to immediately return ZX_ERR_INVALID_ARGS. |
| /// |
| /// Invalid channel numbers will be silently ignored. The validity of a channel |
| /// number depends on the current regulatory region, and a SoftMAC driver cannot |
| /// always determine the region setting. This is especially the case when |
| /// firmware changes the region setting dynamically. |
| /// |
| /// This is a required parameter. |
| 1: channels vector<uint8>:ieee80211.MAX_UNIQUE_CHANNEL_NUMBERS; |
| |
| /// Minimum duration to spend on each channel during the scan. |
| 2: min_channel_time zx.Duration; |
| |
| /// Maximum duration to spend on each channel during the scan. |
| 3: max_channel_time zx.Duration; |
| |
| /// Minimum duration to spend on the home channel(s) between the dwell time on |
| /// each channel where a home channel corresponds to channels the device should |
| /// otherwise be present on while not scanning. |
| 4: min_home_time zx.Duration; |
| }) -> (table { |
| 1: scan_id uint64; |
| }) error zx.Status; |
| |
| /// Start an active scan in the device driver. Scan results will be delivered |
| /// as Beacon or Probe Response frames via WlanSoftmacIfc.Recv(). When |
| /// complete, WlanSoftmacIfc.ScanComplete() will be called with the |
| /// corresponding unique `scan_id`. |
| /// |
| /// The IEs specified must not result in a Probe Request MMPDU that exceed the |
| /// limits defined by IEEE Std 802.11-2016, 9.2.4.7. MMPDU limit constants can |
| /// be found in fuchsia.wlan.ieee80211. These limits are very large and will |
| /// likely not be exceeded by specifying the most common IEs found in |
| /// Probe Request frames. |
| /// |
| /// 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. |
| strict StartActiveScan(WlanSoftmacStartActiveScanRequest) -> (table { |
| 1: scan_id uint64; |
| }) error zx.Status; |
| |
| /// If supported, cancel the ongoing scan corresponding to `scan_id` in the |
| /// device driver, where `scan_id` is an identifier returned by |
| /// `StartPassiveScan()` or `StartActiveScan()`. The return value of this |
| /// function indicates whether a valid scan_id was passed and will be |
| /// canceled. The actual result of cancellation should be indicated by the |
| /// driver using `fuchsia.hardware.wlan.softmac/WlanSoftmacIfc.ScanComplete()`. |
| /// |
| /// A device driver indicates support for `CancelScan()` using |
| /// `fuchsia.wlan.common/ScanOffloadExtension.scan_cancel_supported`. |
| /// |
| /// Common errors include: \ |
| /// ZX_ERR_NOT_FOUND: The given scan_id does not match an ongoing scan. \ |
| /// ZX_ERR_NOT_SUPPORTED: The device does not support scan cancellation. |
| strict CancelScan(table { |
| 1: scan_id uint64; |
| }) -> () error zx.Status; |
| |
| /// Indicate the device of modified WiFi Multimedia (WMM) parameters for a |
| /// particular access category (AC). |
| strict UpdateWmmParameters(table { |
| 1: ac ieee80211.WlanAccessCategory; |
| 2: params fuchsia.wlan.common.WlanWmmParameters; |
| }) -> () error zx.Status; |
| }; |
| |
| service Service { |
| wlan_softmac client_end:WlanSoftmac; |
| }; |