X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=mware%2Ffifobuf.h;h=96161a69b7d21e51faae54a0642e025f2868ebc6;hb=65d5e175830e8c2a6a70b419e28714661e42e4fa;hp=d1885a400a0431fd9119888a9b0763c0066d4dcb;hpb=4a500f3b2f112b23b0662c7640eb7e25780c0d5c;p=bertos.git

diff --git a/mware/fifobuf.h b/mware/fifobuf.h
old mode 100755
new mode 100644
index d1885a40..96161a69
--- 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,27 @@
 
 /*#*
  *#* $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().
+ *#*
  *#* Revision 1.15  2004/08/29 22:05:16  bernie
  *#* Rename BITS_PER_PTR to CPU_BITS_PER_PTR.
  *#*
@@ -84,7 +130,8 @@
 #ifndef MWARE_FIFO_H
 #define MWARE_FIFO_H
 
-#include "cpu.h"
+#include <cpu/cpu.h>
+#include <cfg/debug.h>
 
 typedef struct FIFOBuffer
 {
@@ -95,7 +142,16 @@ typedef struct FIFOBuffer
 } FIFOBuffer;
 
 
-/*!
+#define ASSERT_VALID_FIFO(fifo) \
+	ATOMIC( \
+		ASSERT((fifo)->head >= (fifo)->begin); \
+		ASSERT((fifo)->head <= (fifo)->end); \
+		ASSERT((fifo)->tail >= (fifo)->begin); \
+		ASSERT((fifo)->tail <= (fifo)->end); \
+	)
+
+
+/**
  * Check whether the fifo is empty
  *
  * \note Calling fifo_isempty() is safe while a concurrent
@@ -107,11 +163,12 @@ typedef struct FIFOBuffer
  */
 INLINE bool fifo_isempty(const FIFOBuffer *fb)
 {
+	//ASSERT_VALID_FIFO(fb);
 	return fb->head == fb->tail;
 }
 
 
-/*!
+/**
  * Check whether the fifo is full
  *
  * \note Calling fifo_isfull() is safe while a concurrent
@@ -126,13 +183,14 @@ INLINE bool fifo_isempty(const FIFOBuffer *fb)
  */
 INLINE bool fifo_isfull(const FIFOBuffer *fb)
 {
+	//ASSERT_VALID_FIFO(fb);
 	return
 		((fb->head == fb->begin) && (fb->tail == fb->end))
 		|| (fb->tail == fb->head - 1);
 }
 
 
-/*!
+/**
  * Pop a character from the fifo buffer.
  *
  * \note Calling \c fifo_push() on a full buffer is undefined.
@@ -151,10 +209,12 @@ INLINE void fifo_push(FIFOBuffer *fb, unsigned char c)
 #ifdef __MWERKS__
 #pragma interrupt called
 #endif
+	//ASSERT_VALID_FIFO(fb);
+
 	/* Write at tail position */
 	*(fb->tail) = c;
 
-	if (fb->tail == fb->end)
+	if (UNLIKELY(fb->tail == fb->end))
 		/* wrap tail around */
 		fb->tail = fb->begin;
 	else
@@ -163,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.
@@ -178,7 +238,9 @@ INLINE unsigned char fifo_pop(FIFOBuffer *fb)
 #ifdef __MWERKS__
 #pragma interrupt called
 #endif
-	if (fb->head == fb->end)
+	//ASSERT_VALID_FIFO(fb);
+
+	if (UNLIKELY(fb->head == fb->end))
 	{
 		/* wrap head around */
 		fb->head = fb->begin;
@@ -190,11 +252,12 @@ INLINE unsigned char fifo_pop(FIFOBuffer *fb)
 }
 
 
-/*!
+/**
  * Make the fifo empty, discarding all its current contents.
  */
 INLINE void fifo_flush(FIFOBuffer *fb)
 {
+	//ASSERT_VALID_FIFO(fb);
 	fb->head = fb->tail;
 }
 
@@ -207,11 +270,12 @@ INLINE void fifo_flush(FIFOBuffer *fb)
 	 */
 	#define fifo_isempty_locked(fb) fifo_isempty((fb))
 	#define fifo_push_locked(fb, c) fifo_push((fb), (c))
-	#define fifo_flush_locked(fb) fifo_flush((fb))
+	#define fifo_pop_locked(fb)     fifo_pop((fb))
+	#define fifo_flush_locked(fb)   fifo_flush((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.
 	 *
@@ -222,17 +286,12 @@ INLINE void fifo_flush(FIFOBuffer *fb)
 	INLINE bool fifo_isempty_locked(const FIFOBuffer *fb)
 	{
 		bool result;
-		cpuflags_t flags;
-
-		DISABLE_IRQSAVE(flags);
-		result = fifo_isempty(fb);
-		ENABLE_IRQRESTORE(flags);
-
+		ATOMIC(result = fifo_isempty(fb));
 		return result;
 	}
 
 
-	/*!
+	/**
 	 * Similar to fifo_push(), but with stronger guarantees for
 	 * concurrent access between user and interrupt code.
 	 *
@@ -242,14 +301,18 @@ INLINE void fifo_flush(FIFOBuffer *fb)
 	 */
 	INLINE void fifo_push_locked(FIFOBuffer *fb, unsigned char c)
 	{
-		cpuflags_t flags;
-		DISABLE_IRQSAVE(flags);
-		fifo_push(fb, c);
-		ENABLE_IRQRESTORE(flags);
+		ATOMIC(fifo_push(fb, c));
 	}
 
+	/* Probably not really needed, but hard to prove. */
+	INLINE unsigned char fifo_pop_locked(FIFOBuffer *fb)
+	{
+		unsigned char c;
+		ATOMIC(c = fifo_pop(fb));
+		return c;
+	}
 
-	/*!
+	/**
 	 * Similar to fifo_flush(), but with stronger guarantees for
 	 * concurrent access between user and interrupt code.
 	 *
@@ -259,36 +322,31 @@ INLINE void fifo_flush(FIFOBuffer *fb)
 	 */
 	INLINE void fifo_flush_locked(FIFOBuffer *fb)
 	{
-		cpuflags_t flags;
-		DISABLE_IRQSAVE(flags);
-		fifo_flush(fb);
-		ENABLE_IRQRESTORE(flags);
+		ATOMIC(fifo_flush(fb));
 	}
 
 #endif /* CPU_REG_BITS < BITS_PER_PTR */
 
 
-/*!
+/**
  * Thread safe version of fifo_isfull()
  */
 INLINE bool fifo_isfull_locked(const FIFOBuffer *_fb)
 {
-	bool _result;
-	cpuflags_t _flags;
-
-	DISABLE_IRQSAVE(_flags);
-	_result = fifo_isfull(_fb);
-	ENABLE_IRQRESTORE(_flags);
-
-	return _result;
+	bool result;
+	ATOMIC(result = fifo_isfull(_fb));
+	return result;
 }
 
 
-/*!
+/**
  * 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;
 }