src/common/ringbuf.h

   1 /*
   2  * Copyright (c) 2016 Tilman Sauerbeck (tilman at code-monkey de)
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining
   5  * a copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sublicense, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be
  13  * included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  19  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  20  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  21  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  */
  23
  24 #ifndef RINGBUF_H
  25 #define RINGBUF_H
  26
  27 #include <stdint.h>
  28 #include <stdbool.h>
  29
  30 struct ringbuf {
  31         uint8_t *buffer;
  32         uint32_t size_minus_1;
  33         uint32_t write_index;
  34         uint32_t read_index;
  35 };
  36
  37 /* buffersiz must be a power of two. */
  38 #define RINGBUF_INIT(buffer, buffersiz) \
  39         { (buffer), (buffersiz) - 1, 0, 0 }
  40
  41 bool ringbuf_is_empty (struct ringbuf *rb);
  42 bool ringbuf_is_full (struct ringbuf *rb);
  43 void ringbuf_write (struct ringbuf *rb, uint8_t value);
  44 uint8_t ringbuf_read (struct ringbuf *rb);
  45
  46 #endif