aboutsummaryrefslogtreecommitdiffstats
path: root/Projects/USBtoSerial/Lib/LightweightRingBuff.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2010-08-29 07:49:36 +0000
committerDean Camera <dean@fourwalledcubicle.com>2010-08-29 07:49:36 +0000
commit263178fbb653703273ca3684f16de0ee185f0ae1 (patch)
treed67054544dc064d01709fd06b0399220b5d0652d /Projects/USBtoSerial/Lib/LightweightRingBuff.h
parentcd4c10fefad1b19e3bf9e326abc43711ea1d0fd4 (diff)
downloadlufa-263178fbb653703273ca3684f16de0ee185f0ae1.tar.gz
lufa-263178fbb653703273ca3684f16de0ee185f0ae1.tar.bz2
lufa-263178fbb653703273ca3684f16de0ee185f0ae1.zip
Add better description of the Ultra-Lightweight Ring Buffer header files.
Diffstat (limited to 'Projects/USBtoSerial/Lib/LightweightRingBuff.h')
-rw-r--r--Projects/USBtoSerial/Lib/LightweightRingBuff.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/Projects/USBtoSerial/Lib/LightweightRingBuff.h b/Projects/USBtoSerial/Lib/LightweightRingBuff.h
index cb0f6112a..768e49a50 100644
--- a/Projects/USBtoSerial/Lib/LightweightRingBuff.h
+++ b/Projects/USBtoSerial/Lib/LightweightRingBuff.h
@@ -30,7 +30,14 @@
/** \file
*
- * Ultra lightweight ring buffer, for fast insertion/deletion.
+ * Ultra lightweight ring buffer, for fast insertion/deletion. This uses inlined functions
+ * for maximum speed. All buffers created with this library must be of the same size, however
+ * multiple independant buffers can be created.
+ *
+ * Note that for each buffer, insertion and removal operations may occur at the same time (via
+ * a multithreaded ISR based system) however the same kind of operation (two or more insertions
+ * or deletions) must not overlap. If there is possibility of two or more of the same kind of
+ * operating occuring at the same point in time, atomic (mutex) locking should be used.
*/
#ifndef _ULW_RING_BUFF_H_