fifo_private.h

00001 /*-
00002  * Copyright (c) 2012-2013 Jan Breuer,
00003  *
00004  * All Rights Reserved
00005  * 
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions are
00008  * met:
00009  * 1. Redistributions of source code must retain the above copyright notice,
00010  *    this list of conditions and the following disclaimer.
00011  * 2. Redistributions in binary form must reproduce the above copyright
00012  *    notice, this list of conditions and the following disclaimer in the
00013  *    documentation and/or other materials provided with the distribution.
00014  * 
00015  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00016  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00017  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00018  * DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
00019  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
00022  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
00023  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
00024  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
00025  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026  */
00027 
00028 /**
00029  * @file   scpi_fifo.h
00030  * @date   Thu Nov 15 10:58:45 UTC 2012
00031  * 
00032  * @brief  basic FIFO implementation
00033  * 
00034  * 
00035  */
00036 
00037 #ifndef SCPI_FIFO_H
00038 #define SCPI_FIFO_H
00039 
00040 #include "scpi/types.h"
00041 #include "utils_private.h"
00042 
00043 #ifdef  __cplusplus
00044 extern "C" {
00045 #endif
00046 
00047 
00048 #define FIFO_SIZE 16
00049 
00050     struct _scpi_fifo_t {
00051         int16_t wr;
00052         int16_t rd;
00053         int16_t size;
00054         int16_t data[FIFO_SIZE];
00055     };
00056     typedef struct _scpi_fifo_t scpi_fifo_t;
00057 
00058     void fifo_init(scpi_fifo_t * fifo) LOCAL;
00059     void fifo_clear(scpi_fifo_t * fifo) LOCAL;
00060     scpi_bool_t fifo_add(scpi_fifo_t * fifo, int16_t value) LOCAL;
00061     scpi_bool_t fifo_remove(scpi_fifo_t * fifo, int16_t * value) LOCAL;
00062     scpi_bool_t fifo_count(scpi_fifo_t * fifo, int16_t * value) LOCAL;
00063 
00064 #ifdef  __cplusplus
00065 }
00066 #endif
00067 
00068 #endif  /* SCPI_FIFO_H */