-/*!
+/**
* \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$
* \code head == begin && tail == end \endcode
*/
-/*
- * $Log$
- * Revision 1.13 2004/08/24 13:16:11 bernie
- * Add type-size definitions for preprocessor.
- *
- * Revision 1.12 2004/08/02 20:20:29 aleph
- * Merge from project_ks
- *
- * Revision 1.11 2004/07/30 14:15:53 rasky
- * Nuovo supporto unificato per detect della CPU
- *
- * Revision 1.10 2004/07/29 22:57:09 bernie
- * Doxygen fix.
- *
- * Revision 1.9 2004/07/20 23:54:27 bernie
- * fifo_flush_locked(): New function;
- * Revamp documentation.
- *
- * Revision 1.8 2004/07/20 23:47:39 bernie
- * Finally remove redundant protos.
- *
- * Revision 1.7 2004/07/20 23:46:29 bernie
- * Finally remove redundant protos.
- *
- * Revision 1.6 2004/06/06 17:18:04 bernie
- * Remove redundant declaration of fifo_isempty_locked().
- *
- * Revision 1.5 2004/06/06 16:50:35 bernie
- * Import fixes for race conditions from project_ks.
- *
- * Revision 1.4 2004/06/06 16:11:17 bernie
- * Protect MetroWerks specific pragmas with #ifdef's
- */
-
#ifndef MWARE_FIFO_H
#define MWARE_FIFO_H
-#include "cpu.h"
+#include <cpu/types.h>
+#include <cpu/irq.h>
+#include <cfg/debug.h>
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
*/
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
*/
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.
+/**
+ * Push a character on the fifo buffer.
*
* \note Calling \c fifo_push() on a full buffer is undefined.
* The caller must make sure the buffer has at least
#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
}
-/*!
+/**
* Pop a character from the fifo buffer.
*
* \note Calling \c fifo_pop() on an empty buffer is undefined.
#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;
}
-/*!
+/**
* Make the fifo empty, discarding all its current contents.
*/
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
*/
#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
* concurrent access between user and interrupt code.
*
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.
*
*/
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.
*
*/
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;
}
projects / bertos.git / blobdiff