1.1.4.3.3 DRV_WM8904_Status Function

SYS_STATUS DRV_WM8904_Status( SYS_MODULE_OBJ object)

Summary

Gets the current status of the WM8904 driver module.

Description

This routine provides the current status of the WM8904 driver module.

Preconditions

Function DRV_WM8904_Initialize should have been called before calling this function.

Parameters

ParametersDescription
objectDriver object handle, returned from the DRV_WM8904_Initialize routine

Returns

SYS_STATUS_DEINITIALIZED - Indicates that the driver has been deinitialized

SYS_STATUS_READY - Indicates that any previous module operation for the specified module has completed

SYS_STATUS_BUSY - Indicates that a previous module operation for the specified module has not yet completed

SYS_STATUS_ERROR - Indicates that the specified module is in an error state

Remarks

A driver can opened only when its status is SYS_STATUS_READY.

Example

SYS_MODULE_OBJ object; _// Returned from DRV_WM8904_Initialize_

SYS_STATUS WM8904Status;

WM8904Status = DRV_WM8904_Status(object); if (SYS_STATUS_READY == WM8904Status) {

_// This means the driver can be opened using the_ _// DRV_WM8904_Open() function._

}

C

SYS_STATUS DRV_WM8904_Status(SYS_MODULE_OBJ object);