circular_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 <stdint.h>
#include <stddef.h>
 
struct circular_buffer {
  size_t read_offset;
  size_t write_offset;
  size_t _buf_len;
  uint8_t *_buf;
};
 
enum cir_error {
  CIR_ERROR_NO_MSG = -1,                
  CIR_ERROR_BUFFER_TOO_SMALL = -2,      
  CIR_ERROR_NO_SPACE_AVAILABLE = -3,    
  CIR_ERROR_LOCKED = -4,                
};
 
void circular_buffer_init(struct circular_buffer *cb, uint8_t *buffer, size_t len);
 
 
int circular_buffer_get(struct circular_buffer *cb, uint8_t *buf, size_t len);
 
int circular_buffer_put(struct circular_buffer *cb, const uint8_t *buf, size_t len);
 
 
int circular_buffer_drop(struct circular_buffer *cb);