1.1.5.5.3 DRV_I2S_BUFFER_HANDLE Type

Handle identifying a read or write buffer passed to the driver.

Description

I2S Driver Buffer Handle

A buffer handle value is returned by a call to the DRV_I2S_ReadBufferAdd or DRV_I2S_WriteBufferAdd functions. This handle is associated with the buffer passed into the function and it allows the application to track the completion of the data from (or into) that buffer. The buffer handle value returned from the "buffer add" function is returned back to the client by the "event handler callback" function registered with the driver.

The buffer handle assigned to a client request expires when the client has been notified of the completion of the buffer transfer (after event handler function that notifies the client returns) or after the buffer has been retired by the driver if no event handler callback was set.

Remarks

None

C

typedef uintptr_t DRV_I2S_BUFFER_HANDLE;