1.1.1.9 WDRV_WINC_Status

SYS_STATUS WDRV_WINC_Status
(
    SYS_MODULE_OBJ object
)

This function provides the current status of the WINC driver module.

WDRV_WINC_Initialize must have been called.

• 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.

• SYS_STATUS_UNINITIALIZED - Driver uninitialized.

SYS_MODULE_OBJ object; // Returned from WDRV_WINC_Initialize
SYS_STATUS status;

status = WDRV_WINC_Status(object);
if (SYS_STATUS_ERROR >= status)
{
    // Handle error
}

Remarks

Any value greater than SYS_STATUS_READY is also a normal running state in which the driver is ready to accept new operations.

This operation can be used to determine when any of the driver's module level operations has completed.

If the status operation returns SYS_STATUS_BUSY, then a previous operation has not yet completed. Once the status operation returns SYS_STATUS_READY, any previous operations have completed.

The value of SYS_STATUS_ERROR is negative (-1). Any value less than that is also an error state.

This function will NEVER block waiting for hardware.

If the Status operation returns an error value, the error may be cleared by calling the reinitialize operation. If that fails, the deinitialize operation will need to be called, followed by the initialize operation to return to normal operations.