ring_buffer.h

Go to the documentation of this file.

/*
 * General purpose circular buffer
 *
 * Copyright (C) 2021 Fabien-B <fabien-b@github.com> 
 *
 * This file is part of paparazzi. See LICENCE file.
 */
 
#pragma once
#include <inttypes.h>
#include <stddef.h>
 
 
typedef struct {
  size_t read_offset;
  size_t write_offset;
  size_t size;
  uint8_t *buf;
} ring_buffer_t;
 
 
void ring_buffer_init (ring_buffer_t *ring_buffer, uint8_t *buf, size_t size);
 
size_t ring_buffer_write(ring_buffer_t *ring_buffer, uint8_t* data, size_t len);
 
size_t ring_buffer_read(ring_buffer_t *ring_buffer, uint8_t* read_buffer, size_t len);
 
size_t ring_buffer_available(ring_buffer_t *ring_buffer);
 
size_t ring_buffer_free_space(ring_buffer_t *ring_buffer);