1.1.5.3.2 DRV_I2S_WriteBufferAdd Function
void DRV_I2S_WriteBufferAdd ( const DRV_HANDLE handle, void * buffer, size_t size, DRV_I2S_BUFFER_HANDLE * bufferHandle );
Summary
Queues a write operation.
Description
This function schedules a non-blocking write operation. The function returns with a valid buffer handle in the bufferHandle argument if the write request was scheduled successfully. The function adds the request to the driver instance transmit queue and returns immediately. While the request is in the queue, the application buffer is owned by the driver and should not be modified. On returning, the bufferHandle parameter may be DRV_I2S_BUFFER_HANDLE_INVALID for the following reasons:
if a buffer could not be allocated to the request
if the input buffer pointer is NULL
if the client opened the driver for read-only
if the buffer size is 0
if the transmit queue is full or the queue depth is insufficient
If the requesting client registered an event callback with the driver, the driver will issue a DRV_I2S_BUFFER_EVENT_COMPLETE event if the buffer was processed successfully or a DRV_I2S_BUFFER_EVENT_ERROR event if the buffer was not processed successfully.
Preconditions
DRV_I2S_Open must have been called to obtain a valid opened device handle.
Parameters
| Parameters | Description |
|---|---|
| handle | Handle of the communication channel as return by the DRV_I2S_Open function. |
| buffer | Data to be transmitted. |
| size | Buffer size in bytes. |
| bufferHandle | Pointer to an argument that will contain the return buffer handle. |
Returns
The bufferHandle parameter will contain the return buffer handle. This will be DRV_I2S_BUFFER_HANDLE_INVALID if the function was not successful.
Remarks
This function is thread safe in a RTOS application. It can be called from within the I2S Driver Buffer Event Handler that is registered by this client. It should not be called in the event handler associated with another I2S driver instance. It should not otherwise be called directly in an ISR.
Example
MY_APP_OBJ myAppObj;
uint8_t mybuffer[MY_BUFFER_SIZE]; DRV_I2S_BUFFER_HANDLE bufferHandle;
_// myI2SHandle is the handle returned // by the DRV_I2S_Open function._
DRV_I2S_WriteBufferAdd(myI2Shandle, myBuffer, MY_BUFFER_SIZE,
&bufferHandle);
if(DRV_I2S_BUFFER_HANDLE_INVALID == bufferHandle) {
_// Error handling here_
}
_// Event is received when // the buffer is processed._
C
void DRV_I2S_WriteBufferAdd(const DRV_HANDLE handle, void * buffer, const size_t size, DRV_I2S_BUFFER_HANDLE * bufferHandle);