C++ fixes.

[bertos.git] / mware / fifobuf.h

diff --git a/mware/fifobuf.h b/mware/fifobuf.h
index 3e4021f6b9cf3f3e308a01e4aaa1aa246d4f9dc4..7ee1e70b230682c04296583fb4dd363b11634eb3 100755 (executable)
--- a/mware/fifobuf.h
+++ b/mware/fifobuf.h
@@ -3,7 +3,7 @@
  * <!--
  * 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.
+ * This file is part of DevLib - See README.devlib for information.
  * -->
  *
  * \version $Id$
@@ -43,6 +43,27 @@
 
 /*#*
  *#* $Log$
+ *#* 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.
+ *#*
  *#* Revision 1.14  2004/08/25 14:12:09  rasky
  *#* Aggiornato il comment block dei log RCS
  *#*
@@ -81,7 +102,8 @@
 #ifndef MWARE_FIFO_H
 #define MWARE_FIFO_H
 
-#include "cpu.h"
+#include <cfg/cpu.h>
+#include <cfg/debug.h>
 
 typedef struct FIFOBuffer
 {
@@ -92,6 +114,15 @@ 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
  *
@@ -104,6 +135,7 @@ typedef struct FIFOBuffer
  */
 INLINE bool fifo_isempty(const FIFOBuffer *fb)
 {
+       //ASSERT_VALID_FIFO(fb);
        return fb->head == fb->tail;
 }
 
@@ -123,6 +155,7 @@ 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);
@@ -148,10 +181,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
@@ -175,7 +210,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;
@@ -192,11 +229,12 @@ INLINE unsigned char fifo_pop(FIFOBuffer *fb)
  */
 INLINE void fifo_flush(FIFOBuffer *fb)
 {
+       //ASSERT_VALID_FIFO(fb);
        fb->head = fb->tail;
 }
 
 
-#if CPU_REG_BITS >= BITS_PER_PTR
+#if CPU_REG_BITS >= CPU_BITS_PER_PTR
 
        /*
         * 16/32bit CPUs that can update a pointer with a single write
@@ -204,9 +242,10 @@ 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 < BITS_PER_PTR */
+#else /* CPU_REG_BITS < CPU_BITS_PER_PTR */
 
        /*!
         * Similar to fifo_isempty(), but with stronger guarantees for
@@ -219,12 +258,7 @@ 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;
        }
 
@@ -239,12 +273,16 @@ 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
@@ -256,10 +294,7 @@ 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 */
@@ -270,14 +305,9 @@ INLINE void fifo_flush(FIFOBuffer *fb)
  */
 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;
 }
 
 
@@ -286,6 +316,9 @@ INLINE bool fifo_isfull_locked(const FIFOBuffer *_fb)
  */
 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;
 }