X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=mware%2Ffifobuf.h;h=2b749d8fe1c748b275b4ef64d21d7817d2ceb4a1;hb=5f3952176a4e9a00ca8dd5ec4a6b994958f89e0a;hp=d63b08cf0ae5298294ff72532462c6aaa9477d58;hpb=80c2a63229dadaf172ae1935e0ab24d402ea5f97;p=bertos.git diff --git a/mware/fifobuf.h b/mware/fifobuf.h old mode 100755 new mode 100644 index d63b08cf..2b749d8f --- a/mware/fifobuf.h +++ b/mware/fifobuf.h @@ -1,9 +1,9 @@ -/*! +/** * \file * * * \version $Id$ @@ -43,6 +43,18 @@ /*#* *#* $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. *#* @@ -93,7 +105,8 @@ #ifndef MWARE_FIFO_H #define MWARE_FIFO_H -#include +#include +#include typedef struct FIFOBuffer { @@ -113,7 +126,7 @@ typedef struct FIFOBuffer ) -/*! +/** * Check whether the fifo is empty * * \note Calling fifo_isempty() is safe while a concurrent @@ -130,7 +143,7 @@ INLINE bool fifo_isempty(const FIFOBuffer *fb) } -/*! +/** * Check whether the fifo is full * * \note Calling fifo_isfull() is safe while a concurrent @@ -152,7 +165,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. @@ -185,7 +198,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. @@ -214,7 +227,7 @@ INLINE unsigned char fifo_pop(FIFOBuffer *fb) } -/*! +/** * Make the fifo empty, discarding all its current contents. */ INLINE void fifo_flush(FIFOBuffer *fb) @@ -237,7 +250,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. * @@ -253,7 +266,7 @@ INLINE void fifo_flush(FIFOBuffer *fb) } - /*! + /** * Similar to fifo_push(), but with stronger guarantees for * concurrent access between user and interrupt code. * @@ -274,7 +287,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. * @@ -290,7 +303,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) @@ -301,7 +314,7 @@ INLINE bool fifo_isfull_locked(const FIFOBuffer *_fb) } -/*! +/** * FIFO Initialization. */ INLINE void fifo_init(FIFOBuffer *fb, unsigned char *buf, size_t size)