30 lines
1.0 KiB
C
30 lines
1.0 KiB
C
|
#ifndef RING_BUFFER_H
|
||
|
|
#define RING_BUFFER_H
|
||
|
|
|
||
|
|
#include <stdint.h>
|
||
|
|
|
||
|
|
///////////////////////// UINT8_T RING BUFFER //////////////////////////////
|
||
|
|
typedef struct {
|
||
|
|
uint8_t *buf; //points to data array
|
||
|
|
unsigned char length; //length of data array
|
||
|
|
unsigned char head, tail; //producer and consumer indices
|
||
|
|
} ringbuf_uint8t;
|
||
|
|
|
||
|
|
//initializes the given ringbuffer with the supplied array and its length
|
||
|
|
void rb_init(ringbuf_uint8t *rb, uint8_t *array, unsigned char length);
|
||
|
|
|
||
|
|
//returns boolean true if the ringbuffer is empty, false otherwise
|
||
|
|
unsigned char rb_is_empty(ringbuf_uint8t *rb);
|
||
|
|
|
||
|
|
//returns boolean true if the ringbuffer is full, false otherwise
|
||
|
|
unsigned char rb_is_full(ringbuf_uint8t *rb);
|
||
|
|
|
||
|
|
//consumes an element from the buffer
|
||
|
|
//returns NULL if buffer is empty or a pointer to the array element otherwise
|
||
|
|
uint8_t* rb_get(ringbuf_uint8t *rb);
|
||
|
|
|
||
|
|
//puts an element into the buffer
|
||
|
|
//returns 0 if buffer is full, otherwise returns 1
|
||
|
|
unsigned char rb_put(ringbuf_uint8t *rb, uint8_t c);
|
||
|
|
|
||
|
|
#endif
|