1.1.5.4.1 DRV_I2S_ErrorGet Function
DRV_I2S_ERROR DRV_I2S_ErrorGet( const DRV_HANDLE handle )Summary
Gets the I2S hardware errors associated with the client.
Description
This function returns the errors associated with the given client. The call to this function also clears all the associated error flags.
Preconditions
DRV_I2S_Open must have been called to obtain a valid opened device handle.
Parameters
| Parameters | Description |
|---|---|
| handle | A valid open-instance handle, returned from the driver's open routine |
Returns
Errors occurred as listed by DRV_I2S_ERROR. This function reports multiple I2S errors if occurred.
Remarks
I2S errors are normally associated with the receiver. The driver clears all the errors internally and only returns the occurred error information for the client.
Example
_// 'handle', returned from the DRV_I2S_Open_ if (DRV_I2S_ERROR_OVERRUN & DRV_I2S_ErrorGet(handle)) {
_//Errors are cleared by the driver, take respective action_ _//for the overrun error case._
}C
DRV_I2S_ERROR DRV_I2S_ErrorGet(const DRV_HANDLE handle);