STM32F4-Environmental-Monitoring/ring__buffer_8h_source.html

#ifndef INC_RING_BUFFER_H_

#define INC_RING_BUFFER_H_


#include "stdint.h"

#include "stdbool.h"


typedef struct

{

    float    *buffer;

    uint16_t  head;

    uint16_t  tail;

    uint16_t  count;

    uint16_t  size;

} buf_handle_t;


void buffer_init(buf_handle_t *p_handle, float *p_buffer, uint16_t size);


bool buffer_isFull(buf_handle_t *p_handle);


void buffer_clear(buf_handle_t *p_handle);


bool buffer_isEmpty(buf_handle_t *p_handle);


int buffer_get_value(buf_handle_t *p_handle, float *p_sensor_data);


int buffer_write_value(buf_handle_t *p_handle, float p_sensor_data);


#endif /* INC_RING_BUFFER_H_ */

buffer_get_value
int buffer_get_value(buf_handle_t *p_handle, float *p_sensor_data)
Reads and removes the oldest sample from the buffer (FIFO order).
Definition ring_buffer.c:37

buffer_init
void buffer_init(buf_handle_t *p_handle, float *p_buffer, uint16_t size)
Initialises a ring buffer handle.
Definition ring_buffer.c:11

buffer_isFull
bool buffer_isFull(buf_handle_t *p_handle)
Checks whether the buffer is full.
Definition ring_buffer.c:20

buffer_isEmpty
bool buffer_isEmpty(buf_handle_t *p_handle)
Checks whether the buffer is empty.
Definition ring_buffer.c:32

buffer_write_value
int buffer_write_value(buf_handle_t *p_handle, float p_sensor_data)
Writes a new sample into the buffer.
Definition ring_buffer.c:48

buffer_clear
void buffer_clear(buf_handle_t *p_handle)
Resets the buffer to an empty state without clearing storage memory.
Definition ring_buffer.c:25

buf_handle_t
Ring buffer control structure.
Definition ring_buffer.h:26

buf_handle_t::size
uint16_t size
Definition ring_buffer.h:31

buf_handle_t::tail
uint16_t tail
Definition ring_buffer.h:29

buf_handle_t::head
uint16_t head
Definition ring_buffer.h:28

buf_handle_t::count
uint16_t count
Definition ring_buffer.h:30

buf_handle_t::buffer
float * buffer
Definition ring_buffer.h:27