Open FFBoard
Open source force feedback firmware
Loading...
Searching...
No Matches
ringbuffer.h File Reference

Go to the source code of this file.

Classes

struct  RingBuffer
 

Functions

int ringBufferInit (RingBuffer *buffer, uint8_t *data, size_t len)
 
size_t ringBufferLen (const RingBuffer *buffer)
 
uint8_t ringBufferEmpty (const RingBuffer *buffer)
 
size_t ringBufferFreeSpace (const RingBuffer *buffer)
 
size_t ringBufferMaxSize (const RingBuffer *buffer)
 
void ringBufferAppendOne (RingBuffer *buffer, uint8_t data)
 
void ringBufferAppendMultiple (RingBuffer *buffer, const uint8_t *data, size_t len)
 
uint8_t ringBufferPeekOne (const RingBuffer *buffer)
 
uint8_t ringBufferGetOne (RingBuffer *buffer)
 
void ringBufferGetMultiple (RingBuffer *buffer, uint8_t *dst, size_t len)
 
void ringBufferPeekMultiple (const RingBuffer *buffer, uint8_t *dst, size_t len)
 
void ringBufferDiscardMultiple (RingBuffer *buffer, size_t len)
 
void ringBufferClear (RingBuffer *buffer)
 
static int isMultipleTwo (size_t len)
 

Function Documentation

◆ isMultipleTwo()

static int isMultipleTwo ( size_t len)
inlinestatic

Definition at line 61 of file ringbuffer.h.

◆ ringBufferAppendMultiple()

void ringBufferAppendMultiple ( RingBuffer * buffer,
const uint8_t * data,
size_t len )

Definition at line 77 of file ringbuffer.c.

◆ ringBufferAppendOne()

void ringBufferAppendOne ( RingBuffer * buffer,
uint8_t data )

Definition at line 72 of file ringbuffer.c.

◆ ringBufferClear()

void ringBufferClear ( RingBuffer * buffer)

Definition at line 121 of file ringbuffer.c.

◆ ringBufferDiscardMultiple()

void ringBufferDiscardMultiple ( RingBuffer * buffer,
size_t len )

Definition at line 117 of file ringbuffer.c.

◆ ringBufferEmpty()

uint8_t ringBufferEmpty ( const RingBuffer * buffer)

Definition at line 60 of file ringbuffer.c.

◆ ringBufferFreeSpace()

size_t ringBufferFreeSpace ( const RingBuffer * buffer)

Definition at line 64 of file ringbuffer.c.

◆ ringBufferGetMultiple()

void ringBufferGetMultiple ( RingBuffer * buffer,
uint8_t * dst,
size_t len )

Definition at line 100 of file ringbuffer.c.

◆ ringBufferGetOne()

uint8_t ringBufferGetOne ( RingBuffer * buffer)

Definition at line 94 of file ringbuffer.c.

◆ ringBufferInit()

int ringBufferInit ( RingBuffer * buffer,
uint8_t * data,
size_t len )

Definition at line 40 of file ringbuffer.c.

◆ ringBufferLen()

size_t ringBufferLen ( const RingBuffer * buffer)

Definition at line 52 of file ringbuffer.c.

◆ ringBufferMaxSize()

size_t ringBufferMaxSize ( const RingBuffer * buffer)

Definition at line 68 of file ringbuffer.c.

◆ ringBufferPeekMultiple()

void ringBufferPeekMultiple ( const RingBuffer * buffer,
uint8_t * dst,
size_t len )

Definition at line 105 of file ringbuffer.c.

◆ ringBufferPeekOne()

uint8_t ringBufferPeekOne ( const RingBuffer * buffer)

Definition at line 90 of file ringbuffer.c.