ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add better description of the Ultra-Lightweight Ring Buffer header files.

Browse source
This commit is contained in:
Dean Camera 2010-08-29 07:49:36 +00:00
parent cd4c10fefa
commit 263178fbb6
4 changed files with 26 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Projects/Benito/Lib/LightweightRingBuff.h
View file

@ -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_