Package: android.hardware.wifi@1.0

IWifi

interface IWifi

This is the root of the HAL module and is the interface returned when loading an implementation of the Wi-Fi HAL.There must be at most one module loaded in the system.

Methods

registerEventCallback

registerEventCallback (IWifiEventCallback callback)
generates (WifiStatus status)

Requests notifications of significant events for the HAL.Multiple calls to this must register multiple callbacks each of which must receive all events.|IWifiEventCallback| object registration must be independent of the state of the rest of the HAL and must persist though stops/starts.These objects must be deleted when the corresponding client process is dead.

Details
Parameters
callback
An instance of the |IWifiEventCallback| HIDL interface object.
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.UNKNOWN|
Annotations
entry
callflow
next= { "*" }

isStarted

isStarted ()
generates (bool started)

Get the current state of the HAL.

Details
Generates
started
true if started, false otherwise.

start

start ()
generates (WifiStatus status)

Perform any setup that is required to make use of the module.If the module is already started then this must be a noop.Must trigger |IWifiEventCallback.onStart| on success.

Details
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.NOT_AVAILABLE|, |WifiStatusCode.UNKNOWN|
Annotations
entry
callflow
next= { "registerEventCallback" , "start" , "stop" , "getChip" }

stop

stop ()
generates (WifiStatus status)

Tear down any state, ongoing commands, etc.If the module is already stopped then this must be a noop.If the HAL is already stopped or it succeeds then onStop must be called.After calling this all IWifiChip objects will be considered invalid.Must trigger |IWifiEventCallback.onStop| on success.Must trigger |IWifiEventCallback.onFailure| on failure.

Calling stop then start is a valid way of resetting state in the HAL, driver, firmware.

Details
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.NOT_STARTED|, |WifiStatusCode.UNKNOWN|
Annotations
exit
callflow
next= { "registerEventCallback" , "start" , "stop" }

getChipIds

getChipIds ()
generates (WifiStatus status, vec<ChipId> chipIds)

Retrieve the list of all chip Id's on the device.The corresponding |IWifiChip| object for any chip can be retrieved using |getChip| method.

Details
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.NOT_STARTED|, |WifiStatusCode.UNKNOWN|
chipIds
List of all chip Id's on the device.
Annotations
callflow
next= { "*" }

getChip

getChip (ChipId chipId)
generates (WifiStatus status, IWifiChip chip)

Gets a HIDL interface object for the chip corresponding to the provided chipId.

Details
Parameters
chipId
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.NOT_STARTED|, |WifiStatusCode.UNKNOWN|
chip
HIDL interface object representing the chip.
Annotations
callflow
next= { "*" }