|
Functions | |
| uint16 | Ifx_CircularBuffer_get16 (Ifx_CircularBuffer *buffer) |
| Return the circular buffer 16 bit value, and post-increment the circular buffer pointer. More... | |
| uint32 | Ifx_CircularBuffer_get32 (Ifx_CircularBuffer *buffer) |
| Return the circular buffer 32 bit value, and post-increment the circular buffer pointer. More... | |
| void * | Ifx_CircularBuffer_read8 (Ifx_CircularBuffer *buffer, void *data, Ifx_SizeT count) |
| Copy count bytes from the circular buffer to the data array. More... | |
| void * | Ifx_CircularBuffer_read32 (Ifx_CircularBuffer *buffer, void *data, Ifx_SizeT count) |
| Copy count 32 bit words from the circular buffer to the data array. More... | |
| const void * | Ifx_CircularBuffer_write8 (Ifx_CircularBuffer *buffer, const void *data, Ifx_SizeT count) |
| Copy count bytes from the data array to the circular buffer. More... | |
| const void * | Ifx_CircularBuffer_write32 (Ifx_CircularBuffer *buffer, const void *data, Ifx_SizeT count) |
| Copy count 32 bit words from the data array to the circular buffer. More... | |
Detailed Description
This module implements circular buffer functions.
Function Documentation
| uint16 Ifx_CircularBuffer_get16 | ( | Ifx_CircularBuffer * | buffer) |
Return the circular buffer 16 bit value, and post-increment the circular buffer pointer.
- Parameters
-
buffer Specifies circular buffer.
- Returns
- Return the next circular buffer value.
Definition at line 44 of file Ifx_CircularBuffer.c.
| uint32 Ifx_CircularBuffer_get32 | ( | Ifx_CircularBuffer * | buffer) |
Return the circular buffer 32 bit value, and post-increment the circular buffer pointer.
- Parameters
-
buffer Specifies circular buffer.
- Returns
- Return the next circular buffer value.
Definition at line 29 of file Ifx_CircularBuffer.c.
| void* Ifx_CircularBuffer_read32 | ( | Ifx_CircularBuffer * | buffer, |
| void * | data, | ||
| Ifx_SizeT | count | ||
| ) |
Copy count 32 bit words from the circular buffer to the data array.
- Parameters
-
buffer Specifies circular buffer. data Specifies destination pointer. count Specifies number of 32 bit words to be copied. count MUST be >= 1.
- Returns
- Returns the updated data pointer data = ((uint32*)data) + count
Definition at line 99 of file Ifx_CircularBuffer.c.
| void* Ifx_CircularBuffer_read8 | ( | Ifx_CircularBuffer * | buffer, |
| void * | data, | ||
| Ifx_SizeT | count | ||
| ) |
Copy count bytes from the circular buffer to the data array.
- Parameters
-
buffer Specifies circular buffer. data Specifies destination pointer. count Specifies number of bytes to be copied. count MUST be >= 1.
- Returns
- Returns the updated data pointer data = ((uint8*)data) + count
Definition at line 78 of file Ifx_CircularBuffer.c.
Referenced by Ifx_Fifo_read().
| const void* Ifx_CircularBuffer_write32 | ( | Ifx_CircularBuffer * | buffer, |
| const void * | data, | ||
| Ifx_SizeT | count | ||
| ) |
Copy count 32 bit words from the data array to the circular buffer.
- Parameters
-
buffer Specifies circular buffer. data Specifies source pointer. count Specifies number of 32 bit words to be copied. count MUST be >= 1.
- Returns
- Returns the updated data pointer data = ((uint32*)data) + count
Definition at line 143 of file Ifx_CircularBuffer.c.
| const void* Ifx_CircularBuffer_write8 | ( | Ifx_CircularBuffer * | buffer, |
| const void * | data, | ||
| Ifx_SizeT | count | ||
| ) |
Copy count bytes from the data array to the circular buffer.
- Parameters
-
buffer Specifies circular buffer. data Specifies source pointer. count Specifies number of bytes to be copied. count MUST be >= 1.
- Returns
- Returns the updated data pointer data = ((uint8*)data) + count
Definition at line 122 of file Ifx_CircularBuffer.c.
Referenced by Ifx_Fifo_write().
