Package: android.hardware.wifi.offload@1.0

types

Properties

Ssid

typedef vec Ssid

SSID of the Access Point, maximum 32 characters

SecurityMode

enum SecurityMode: uint8_t

Defines a bitmap of security modes

Details
Members
OPEN = 0x1 << 1
WEP = 0x1 << 2
PSK = 0x1 << 3
EAP = 0x1 << 4

Capability

enum Capability: uint16_t

This is a bit mask describing the capabilities of a BSS.See IEEE Std 802.11:8.4.1.4

Details
Members
ESS = 1 << 0
IBSS = 1 << 1
CF_POLLABLE = 1 << 2
CF_PLL_REQ = 1 << 3
PRIVACY = 1 << 4
SHORT_PREAMBLE = 1 << 5
PBCC = 1 << 6
CHANNEL_AGILITY = 1 << 7
SPECTURM_MGMT = 1 << 8
QOS = 1 << 9
SHORT_SLOT_TIME = 1 << 10
APSD = 1 << 11
RADIO_MEASUREMENT = 1 << 12
DSSS_OFDM = 1 << 13
DELAYED_BLOCK_ACK = 1 << 14
IMMEDIATE_BLOCK_ACK = 1 << 15

RecordName

enum RecordName: uint32_t

Enumerates the type of log that is recorded

Details
Members
CMD_BASE = 0x00001000
CMD_INT = CMD_BASE + 0
CMD_CONFIG_SCANS = CMD_BASE + 1
CMD_SUBSCRIBE_SCAN_RESULTS = CMD_BASE + 2
CMD_UNSUBSCRIBE_SCAN_RESULTS = CMD_BASE + 3
CMD_GET_SCAN_STATS = CMD_BASE + 4
CMD_RESET = CMD_BASE + 5
EVENT_RECVD_BASE = 0x00002000
EVENT_RECVD_SCAN_RESULT_ASYNC = EVENT_RECVD_BASE + 0
EVENT_RECVD_SCAN_RESULT = EVENT_RECVD_BASE + 1
EVENT_SENT_BASE = 0x00003000
EVENT_SENT_SCAN_RESULT = EVENT_SENT_BASE + 0
EVENT_SENT_ABORT = EVENT_SENT_BASE + 1
EVENT_SENT_ERROR = EVENT_SENT_BASE + 2
REQ_BASE = 0x00004000
REQ_SCAN = REQ_BASE + 0

OffloadStatusCode

enum OffloadStatusCode: uint32_t

Defines a list of return codes to indicate status of Offload HAL

Details
Members
OK
NO_CONNECTION
TIMEOUT
ERROR

NetworkInfo

struct NetworkInfo {Ssid ssid; bitfield flags}

Preferred network information SSID and associated security mode(s )

Details
Members
ssid
flags

ScanResult

struct ScanResult {NetworkInfo networkInfo; uint8_t bssid; bitfield capability; uint32_t frequency; int8_t rssi; uint64_t tsf}

Scan Results returned by the offload Hal

Details
Members
networkInfo
bssid
capability
frequency
rssi
tsf

ScanParam

struct ScanParam {vec ssidList; vec frequencyList; uint32_t disconnectedModeScanIntervalMs}

Parameters for performing offload scans

Details
Members
ssidList
frequencyList
disconnectedModeScanIntervalMs

ScanFilter

struct ScanFilter {vec preferredNetworkInfoList; int8_t rssiThreshold}

Instruction on how to filter the scan result before performing network selection and waking up the AP to connect

Details
Members
preferredNetworkInfoList
rssiThreshold

ScanRecord

struct ScanRecord {uint64_t durationMs; uint32_t numChannelsScanned; uint32_t numEntriesAggregated}
Details
Members
durationMs
numChannelsScanned
numEntriesAggregated

LogRecord

struct LogRecord {RecordName recordName; uint64_t logTimeMs}

Defines the structure of each log record

Details
Members
recordName
logTimeMs

ScanStats

struct ScanStats {uint32_t numScansRequestedByWifi; uint32_t numScansServicedByWifi; uint32_t numScansServicedbyCache; uint64_t lastUpdated; uint64_t lastRead; uint64_t subscriptionDurationMs; uint8_t histogramChannelsScanned; vec scanRecord; vec logRecord}

Defines the scan statistics to be returned to the framework

Details
Members
numScansRequestedByWifi
numScansServicedByWifi
numScansServicedbyCache
lastUpdated
lastRead
subscriptionDurationMs
histogramChannelsScanned
scanRecord
logRecord

OffloadStatus

struct OffloadStatus {OffloadStatusCode code; string description}

Generic structures to return the status of an operation

Details
Members
code
description