ENTS-tock/embedded/fifo_8h_source.html

#pragma once


#ifdef __cplusplus

extern "C" {

#endif


#include <stdio.h>


#include "fram.h"


#ifndef FRAM_BUFFER_START

#define FRAM_BUFFER_START 0

#endif /* FRAM_BUFFER_START */


#ifndef FRAM_BUFFER_END

#define FRAM_BUFFER_END 1769

#endif /* FRAM_BUFFER_END */


#if FRAM_BUFFER_START > FRAM_BUFFER_END

#error "Buffer end address must be greater than buffer start address"

#endif


fram_status fifo_put(const uint8_t* data, uint8_t num_bytes);


fram_status fifo_get(uint8_t* data, uint8_t* len);


fram_status fifo_peek(size_t idx, uint8_t* data, uint8_t* len);


fram_status fifo_drop(void);


uint16_t fifo_buffer_len(void);


fram_status fifo_buffer_clear(void);


fram_status fifo_save_buffer_state(void);


fram_status fifo_load_buffer_state(void);


fram_status fifo_init(void);


int fifo_size(void);


#ifdef __cplusplus

}

#endif

data
const char data[]
Definition example_dirtviz.cpp:23

fram.h
Storage interface for onboard FRAM chips.

fifo_get
fram_status fifo_get(uint8_t *data, uint8_t *len)
Reads a measurement from the queue.
Definition fifo.c:102

fifo_size
int fifo_size(void)
Gets the total number of bytes in the buffer.
Definition fifo.c:346

fifo_buffer_len
uint16_t fifo_buffer_len(void)
Get the current number of measurements stored in the buffer.
Definition fifo.c:233

fifo_buffer_clear
fram_status fifo_buffer_clear(void)
Clears the buffer.
Definition fifo.c:235

fifo_put
fram_status fifo_put(const uint8_t *data, uint8_t num_bytes)
Puts a measurement into the circular buffer.
Definition fifo.c:55

fifo_drop
fram_status fifo_drop(void)
Drops the next measurement in the buffer.
Definition fifo.c:210

fifo_save_buffer_state
fram_status fifo_save_buffer_state(void)
Saves the buffer state (read address, write address, and buffer length) to FRAM.
Definition fifo.c:247

fifo_peek
fram_status fifo_peek(size_t idx, uint8_t *data, uint8_t *len)
Peeks at the next measurement in the buffer without removing it.
Definition fifo.c:147

fifo_init
fram_status fifo_init(void)
Initializes the buffer.
Definition fifo.c:326

fifo_load_buffer_state
fram_status fifo_load_buffer_state(void)
Loads the buffer state (read address, write address, and buffer length) from FRAM.
Definition fifo.c:290

fram_status
fram_status
Definition fram.h:32