Change sreg type to cpuflags_t.

[bertos.git] / mware / fifobuf.h

diff --git a/mware/fifobuf.h b/mware/fifobuf.h
old mode 100755 (executable)
new mode 100644 (file)
index a9b1d6b..96161a6
--- a/mware/fifobuf.h
+++ b/mware/fifobuf.h
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2001 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See devlib/README for information.
+ *
  * -->
  *
  * \version $Id$
@@ -43,6 +68,24 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.22  2006/07/19 12:56:27  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.21  2005/11/04 16:20:02  bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
+ *#* Revision 1.20  2005/04/11 19:10:28  bernie
+ *#* Include top-level headers from cfg/ subdir.
+ *#*
+ *#* Revision 1.19  2004/12/08 08:30:12  bernie
+ *#* Add missing header.
+ *#*
+ *#* Revision 1.18  2004/11/16 21:55:12  bernie
+ *#* Workaround for a known fifobuf bug.
+ *#*
+ *#* Revision 1.17  2004/09/14 20:57:00  bernie
+ *#* Use debug.h instead of kdebug.h.
+ *#*
  *#* Revision 1.16  2004/09/06 21:39:08  bernie
  *#* Simplify code using ATOMIC().
  *#*
@@ -87,8 +130,8 @@
 #ifndef MWARE_FIFO_H
 #define MWARE_FIFO_H
 
-#include <cpu.h>
-#include <drv/kdebug.h>
+#include <cpu/cpu.h>
+#include <cfg/debug.h>
 
 typedef struct FIFOBuffer
 {
@@ -108,7 +151,7 @@ typedef struct FIFOBuffer
        )
 
 
-/*!
+/**
  * Check whether the fifo is empty
  *
  * \note Calling fifo_isempty() is safe while a concurrent
@@ -125,7 +168,7 @@ INLINE bool fifo_isempty(const FIFOBuffer *fb)
 }
 
 
-/*!
+/**
  * Check whether the fifo is full
  *
  * \note Calling fifo_isfull() is safe while a concurrent
@@ -147,7 +190,7 @@ INLINE bool fifo_isfull(const FIFOBuffer *fb)
 }
 
 
-/*!
+/**
  * Pop a character from the fifo buffer.
  *
  * \note Calling \c fifo_push() on a full buffer is undefined.
@@ -180,7 +223,7 @@ INLINE void fifo_push(FIFOBuffer *fb, unsigned char c)
 }
 
 
-/*!
+/**
  * Pop a character from the fifo buffer.
  *
  * \note Calling \c fifo_pop() on an empty buffer is undefined.
@@ -209,7 +252,7 @@ INLINE unsigned char fifo_pop(FIFOBuffer *fb)
 }
 
 
-/*!
+/**
  * Make the fifo empty, discarding all its current contents.
  */
 INLINE void fifo_flush(FIFOBuffer *fb)
@@ -232,7 +275,7 @@ INLINE void fifo_flush(FIFOBuffer *fb)
 
 #else /* CPU_REG_BITS < CPU_BITS_PER_PTR */
 
-       /*!
+       /**
         * Similar to fifo_isempty(), but with stronger guarantees for
         * concurrent access between user and interrupt code.
         *
@@ -248,7 +291,7 @@ INLINE void fifo_flush(FIFOBuffer *fb)
        }
 
 
-       /*!
+       /**
         * Similar to fifo_push(), but with stronger guarantees for
         * concurrent access between user and interrupt code.
         *
@@ -269,7 +312,7 @@ INLINE void fifo_flush(FIFOBuffer *fb)
                return c;
        }
 
-       /*!
+       /**
         * Similar to fifo_flush(), but with stronger guarantees for
         * concurrent access between user and interrupt code.
         *
@@ -285,7 +328,7 @@ INLINE void fifo_flush(FIFOBuffer *fb)
 #endif /* CPU_REG_BITS < BITS_PER_PTR */
 
 
-/*!
+/**
  * Thread safe version of fifo_isfull()
  */
 INLINE bool fifo_isfull_locked(const FIFOBuffer *_fb)
@@ -296,11 +339,14 @@ INLINE bool fifo_isfull_locked(const FIFOBuffer *_fb)
 }
 
 
-/*!
+/**
  * FIFO Initialization.
  */
 INLINE void fifo_init(FIFOBuffer *fb, unsigned char *buf, size_t size)
 {
+       /* FIFO buffers have a known bug with 1-byte buffers. */
+       ASSERT(size > 1);
+
        fb->head = fb->tail = fb->begin = buf;
        fb->end = buf + size - 1;
 }