fifo_desc Struct Reference

FIFO descriptor used by FIFO driver.

#include <fifo.h>

Data Fields
union {
uint16_t *   u16ptr
	Pointer to unsigned-16 bits location. More...
uint32_t *   u32ptr
	Pointer to unsigned-32 bits location. More...
uint8_t *   u8ptr
	Pointer to unsigned-8 bits location. More...
}	buffer
uint8_t	mask
	Mask used to speed up FIFO operation (wrapping) More...
volatile uint8_t	read_index
	Read index. More...
uint8_t	size
	Size of the FIFO (unit is in number of 'element') More...
volatile uint8_t	write_index
	Write index. More...

union { ... } fifo_desc::buffer

Referenced by fifo_init(), fifo_peek_uint16(), fifo_peek_uint32(), fifo_peek_uint8(), fifo_pull_uint16(), fifo_pull_uint16_nocheck(), fifo_pull_uint32(), fifo_pull_uint32_nocheck(), fifo_pull_uint8(), fifo_pull_uint8_nocheck(), fifo_push_uint16(), fifo_push_uint16_nocheck(), fifo_push_uint32(), fifo_push_uint32_nocheck(), fifo_push_uint8(), and fifo_push_uint8_nocheck().

uint8_t fifo_desc::mask

Mask used to speed up FIFO operation (wrapping)

Referenced by fifo_get_used_size(), fifo_init(), fifo_peek_uint16(), fifo_peek_uint32(), fifo_peek_uint8(), fifo_pull_uint16(), fifo_pull_uint16_nocheck(), fifo_pull_uint32(), fifo_pull_uint32_nocheck(), fifo_pull_uint8(), fifo_pull_uint8_nocheck(), fifo_push_uint16(), fifo_push_uint16_nocheck(), fifo_push_uint32(), fifo_push_uint32_nocheck(), fifo_push_uint8(), and fifo_push_uint8_nocheck().

volatile uint8_t fifo_desc::read_index

Read index.

Referenced by fifo_flush(), fifo_get_used_size(), fifo_init(), fifo_is_empty(), fifo_peek_uint16(), fifo_peek_uint32(), fifo_peek_uint8(), fifo_pull_uint16(), fifo_pull_uint16_nocheck(), fifo_pull_uint32(), fifo_pull_uint32_nocheck(), fifo_pull_uint8(), and fifo_pull_uint8_nocheck().

uint8_t fifo_desc::size

Size of the FIFO (unit is in number of 'element')

Referenced by fifo_get_free_size(), fifo_init(), and fifo_is_full().

uint16_t* fifo_desc::u16ptr

Pointer to unsigned-16 bits location.

Referenced by fifo_peek_uint16(), fifo_pull_uint16(), fifo_pull_uint16_nocheck(), fifo_push_uint16(), and fifo_push_uint16_nocheck().

uint32_t* fifo_desc::u32ptr

Pointer to unsigned-32 bits location.

Referenced by fifo_peek_uint32(), fifo_pull_uint32(), fifo_pull_uint32_nocheck(), fifo_push_uint32(), and fifo_push_uint32_nocheck().

uint8_t* fifo_desc::u8ptr

Pointer to unsigned-8 bits location.

Referenced by fifo_init(), fifo_peek_uint8(), fifo_pull_uint8(), fifo_pull_uint8_nocheck(), fifo_push_uint8(), and fifo_push_uint8_nocheck().

volatile uint8_t fifo_desc::write_index

Write index.

Referenced by fifo_flush(), fifo_get_used_size(), fifo_init(), fifo_is_empty(), fifo_push_uint16(), fifo_push_uint16_nocheck(), fifo_push_uint32(), fifo_push_uint32_nocheck(), fifo_push_uint8(), and fifo_push_uint8_nocheck().