diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2010-05-26 06:35:02 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-05-26 06:35:02 +0000 |
| commit | 9b29d1dc5045b74516e0ddd3ffcc200ef8ad9bff (patch) | |
| tree | 77c55d0cc5d3c065be1144bd62e21d18a2d02f30 /Projects/XPLAINBridge/Lib/LightweightRingBuff.h | |
| parent | 9c037a952f5aaf78c4e13398506cfa2d588bb449 (diff) | |
| download | lufa-9b29d1dc5045b74516e0ddd3ffcc200ef8ad9bff.tar.gz lufa-9b29d1dc5045b74516e0ddd3ffcc200ef8ad9bff.tar.bz2 lufa-9b29d1dc5045b74516e0ddd3ffcc200ef8ad9bff.zip | |
Create a new LightweightRingBuffer.h header file for the XPLAIN project to abstract out the new ring buffer without a performance penalty.
Diffstat (limited to 'Projects/XPLAINBridge/Lib/LightweightRingBuff.h')
| -rw-r--r-- | Projects/XPLAINBridge/Lib/LightweightRingBuff.h | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/Projects/XPLAINBridge/Lib/LightweightRingBuff.h b/Projects/XPLAINBridge/Lib/LightweightRingBuff.h new file mode 100644 index 000000000..16e890c07 --- /dev/null +++ b/Projects/XPLAINBridge/Lib/LightweightRingBuff.h @@ -0,0 +1,89 @@ +/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2010.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.fourwalledcubicle.com
+*/
+
+/*
+ Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+ Permission to use, copy, modify, distribute, and sell this
+ software and its documentation for any purpose is hereby granted
+ without fee, provided that the above copyright notice appear in
+ all copies and that both that the copyright notice and this
+ permission notice and warranty disclaimer appear in supporting
+ documentation, and that the name of the author not be used in
+ advertising or publicity pertaining to distribution of the
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ *
+ * Ultra lightweight ring buffer, for fast insertion/deletion.
+ */
+
+#ifndef _ULW_RING_BUFF_H_
+#define _ULW_RING_BUFF_H_
+
+ /* Includes: */
+ #include <stdint.h>
+ #include <stdbool.h>
+
+ /* Defines: */
+ /** Size of each ring buffer, in bytes */
+ #define BUFFER_SIZE 128
+
+ /** Type of data to store into the buffer */
+ #define RingBuff_Data_t uint8_t
+
+ /* Type Defines: */
+ typedef struct
+ {
+ RingBuff_Data_t Buffer[BUFFER_SIZE];
+ RingBuff_Data_t* In;
+ RingBuff_Data_t* Out;
+ } RingBuff_t;
+
+ /* Inline Functions: */
+ static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
+ {
+ Buffer->In = Buffer->Buffer;
+ Buffer->Out = Buffer->Buffer;
+ }
+
+ static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
+ {
+ *Buffer->In = Data;
+
+ if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE])
+ Buffer->In = Buffer->Buffer;
+ }
+
+ static inline RingBuff_Data_t RingBuffer_Remove(RingBuff_t* const Buffer)
+ {
+ RingBuff_Data_t Data = *Buffer->Out;
+
+ if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE])
+ Buffer->Out = Buffer->Buffer;
+
+ return Data;
+ }
+
+ static inline bool RingBuffer_Empty(RingBuff_t* const Buffer)
+ {
+ return (Buffer->In == Buffer->Out);
+ }
+
+#endif
+
\ No newline at end of file |