Учимся программированию на С вместе: библиотека буфера FIFO

/*******************************************************************
Библиотека, реализующая кольцевой (циклический) буфер.
Автор: N1X
*******************************************************************/
#ifndef FIFO_H
#define FIFO_H

#include <stm32f10x.h>

/*
Здесь задается длина буфера
*/
#define FIFO_LENGTH 16

/*******************************************************************
fifo_t: Тип, описывающий тело нашего буфера:
data: Массив с данными. Здесь хранится содержимое буфера.
head: Переменная, хранящая в себе индекс головы буфера.
tail: Переменная, хранящая в себе индекс хвоста буфера.
count: Переменная, хранящая кол-во элементов, находящихся в буфере.
*******************************************************************/
typedef struct {
  u8 data[FIFO_LENGTH];
  u8 head;
  u8 tail;
  u8 count;
} fifo_t;

/*******************************************************************
Функция: fifo_init - инициализирует буфер
Аргументы: 
  fifo_t *fifo - указатель на буфер
Значение: --
*******************************************************************/
void fifo_init(fifo_t *fifo);

/*******************************************************************
Функция: fifo_put - "кладет" данные в буфер
Аргументы:
  fifo_t *fifo  - указатель на буфер
  void *data    - указатель на данные (любой тип)
  u8 offset     - смещение с начального адреса (удобно при работе с массивом)
  u8 count      - количество байт данных
Значение:
s8 - целое со снаком.
  0 - все ОК
  -1 - не хватает места в буфере для выволнения операции
*******************************************************************/
s8 fifo_put(fifo_t *fifo, void *data, u8 offset, u8 count);
/*******************************************************************
Функция: fifo_get - "берет" данные из буфера
Аргументы:
  fifo_t *fifo  - указатель на буфер
  void *data    - указатель на место для данных (любой тип)
  u8 offset     - смещение с начального адреса (удобно при работе с массивом)
  u8 count      - количество байт данных для чтения
Значение:
s8 - целое со снаком.
  0 - все ОК
  -1 - запрошено больше данных, чем есть в буфере
*******************************************************************/
s8 fifo_get(fifo_t *fifo, void *data, u8 offset, u8 count);
/*******************************************************************
Функция: fifo_count - возвращает количество байт в буфере
Аргументы:
  fifo_t *fifo  - указатель на буфер
Значение:
  s8 - число байт в буфере
*******************************************************************/
u8 fifo_count(fifo_t *fifo);

#endif

#include "fifo.h"


s8 fifo_put(fifo_t *fifo, void *data, u8 offset, u8 count)
{
  if ((FIFO_LENGTH - fifo->count) < count)                      //Проверяем, достаточно ли места
    return -1;                                                  //Нет? Возвращаем "-1" и уходим
  for (u8 i = offset; i < (offset + count); i++)                //Цикл заполнения
  {
    fifo->data[fifo->tail++] =((u8*) data)[i];                  //Кладем сами данные и сразу tail++
    fifo->count++;                                              //Увеличиваем переменную-счетчик
    if (fifo->tail == FIFO_LENGTH)                              //Если уперлись в границу длины
    {
      fifo->tail=0;                                             //Обнуляем хвост
    }                                                           //Т.е. "сворачиваем" буфер в кольцо
  }
  return 0;                                                     //Возвращаем "ОК"
}

s8 fifo_get(fifo_t *fifo, void *data, u8 offset, u8 count)
{
  if (fifo->count < count)                                      //Проверяем, можем ли мы выдать столько,
    return -1;                                                  //сколько у нас просят
  for (u8 i = offset; i < (offset + count); i++)                //Цикл записи
  {
    ((u8*)data)[i] = fifo->data[fifo->head++];                  //Пишем байт по указанному адресу, head++
    fifo->count--;                                              //Уменьшаем счетчик байт
    if (fifo->head == FIFO_LENGTH)                              //Если уперлись в границу длины
    {
      fifo->head=0;                                             //Обнуляем голову
    }
  }
  return 0;
}

u8 fifo_count(fifo_t *fifo)
{
  return fifo->count;
}

void fifo_init(fifo_t *fifo)
{
  fifo->head = fifo->tail = fifo->count = 0;
}