diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2010-08-29 07:49:36 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-08-29 07:49:36 +0000 |
| commit | 263178fbb653703273ca3684f16de0ee185f0ae1 (patch) | |
| tree | d67054544dc064d01709fd06b0399220b5d0652d /Projects | |
| parent | cd4c10fefad1b19e3bf9e326abc43711ea1d0fd4 (diff) | |
| download | lufa-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')
| -rw-r--r-- | Projects/Benito/Lib/LightweightRingBuff.h | 9 | ||||
| -rw-r--r-- | Projects/USBtoSerial/Lib/LightweightRingBuff.h | 9 | ||||
| -rw-r--r-- | Projects/XPLAINBridge/Lib/LightweightRingBuff.h | 9 |
3 files changed, 24 insertions, 3 deletions
diff --git a/Projects/Benito/Lib/LightweightRingBuff.h b/Projects/Benito/Lib/LightweightRingBuff.h index cb0f6112a..768e49a50 100644 --- a/Projects/Benito/Lib/LightweightRingBuff.h +++ b/Projects/Benito/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_ 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_ diff --git a/Projects/XPLAINBridge/Lib/LightweightRingBuff.h b/Projects/XPLAINBridge/Lib/LightweightRingBuff.h index cb0f6112a..768e49a50 100644 --- a/Projects/XPLAINBridge/Lib/LightweightRingBuff.h +++ b/Projects/XPLAINBridge/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_ |