ring_buffer_t Struct Reference

data structure to keep track of important ring buffer variables More...

#include <ring_buffer.h>

Data Fields
uint8_t *	head
	pointer to the head of the buffer More...
uint8_t *	tail
	pointer to the tail of the buffer More...
uint8_t *	start
	pointer to the start address of the buffer space More...
uint8_t *	end
	pointer to the end address of the buffer space More...
uint8_t	buff_size
	size of the buffer space More...
uint8_t	error
	error flag (not currently used) More...
uint8_t	unread_items
	number of unread items in the ring buffer More...

Detailed Description

data structure to keep track of important ring buffer variables

Field Documentation

buff_size

uint8_t buff_size

size of the buffer space

end

uint8_t* end

pointer to the end address of the buffer space

error

uint8_t error

error flag (not currently used)

head

uint8_t* head

pointer to the head of the buffer

start

uint8_t* start

pointer to the start address of the buffer space

tail

uint8_t* tail

pointer to the tail of the buffer

unread_items

uint8_t unread_items

number of unread items in the ring buffer

---

The documentation for this struct was generated from the following file:

• /Users/tholmes/projects/BinaryClock/firmware/ring_buffer.h