X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fstruct%2Ffifobuf.h;h=117431be59980fac7d2fbdb6e78088e309c14281;hb=ee52abf7300bb120fa17966d581afe1938b2d0e8;hp=efb8f10315e2476783d39ec0efbf413160c745b0;hpb=a3a3a24dd211a7e17f27bcd8fd84b6e005c7144d;p=bertos.git

diff --git a/bertos/struct/fifobuf.h b/bertos/struct/fifobuf.h
index efb8f103..117431be 100644
--- a/bertos/struct/fifobuf.h
+++ b/bertos/struct/fifobuf.h
@@ -30,6 +30,10 @@
  * Copyright 2001, 2008 Bernie Innocenti <bernie@codewiz.org>
  * -->
  *
+ * \defgroup fifobuf FIFO buffer
+ * \ingroup struct
+ * \{
+ *
  * \brief General pourpose FIFO buffer implemented with a ring buffer
  *
  * \li \c begin points to the first buffer element;
@@ -60,12 +64,11 @@
  * location and head points to the first one:
  *		\code head == begin && tail == end \endcode
  *
- * \version $Id: fifobuf.h 1532 2008-08-04 07:21:26Z bernie $
  * \author Bernie Innocenti <bernie@codewiz.org>
  */
 
-#ifndef MWARE_FIFO_H
-#define MWARE_FIFO_H
+#ifndef STRUCT_FIFO_H
+#define STRUCT_FIFO_H
 
 #include <cpu/types.h>
 #include <cpu/irq.h>
@@ -89,6 +92,19 @@ typedef struct FIFOBuffer
 	)
 
 
+/**
+ * Declare a static fifo buffer
+ */
+#define DECLARE_FIFO(_name, _ptr, _size)			\
+	FIFOBuffer _name =					\
+	{							\
+		.head = (_ptr),					\
+		.tail = (_ptr),					\
+		.begin = (_ptr),				\
+		.end = (_ptr) + (_size) - 1,			\
+	};							\
+	STATIC_ASSERT((_size) > 1)
+
 /**
  * Check whether the fifo is empty
  *
@@ -355,5 +371,6 @@ void fifo_pushblock(FIFOBuffer *fb, unsigned char *block, size_t len)
 }
 #endif
 
-#endif /* MWARE_FIFO_H */
+/** \} */ /* defgroup fifobuf */
 
+#endif /* STRUCT_FIFO_H */