diff --git a/LUFA/ManPages/FutureChanges.txt b/LUFA/ManPages/FutureChanges.txt index 020779b973..d30d45d9af 100644 --- a/LUFA/ManPages/FutureChanges.txt +++ b/LUFA/ManPages/FutureChanges.txt @@ -17,10 +17,12 @@ * -# Add ability to get number of bytes not written with pipe/endpoint write routines after an error * -# Add standardized descriptor names to class driver structures * -# Change makefiles to allow for absolute LUFA location to be used + * -# Re-add interrupt Pipe/Endpoint support * - Documentation/Support * -# Add detailed overviews of how each demo works * -# Add board overviews * -# Write LUFA tutorials + * -# Add makefile template * - Demos/Projects * -# Multiple-Report HID device * -# Device/Host USB bridge diff --git a/Projects/Benito/Lib/LightweightRingBuff.h b/Projects/Benito/Lib/LightweightRingBuff.h index cb0f6112a2..768e49a50f 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 cb0f6112a2..768e49a50f 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 cb0f6112a2..768e49a50f 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_