Commit 263178fb authored by Dean Camera's avatar Dean Camera
Browse files

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

parent cd4c10fe
...@@ -17,10 +17,12 @@ ...@@ -17,10 +17,12 @@
* -# Add ability to get number of bytes not written with pipe/endpoint write routines after an error * -# 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 * -# Add standardized descriptor names to class driver structures
* -# Change makefiles to allow for absolute LUFA location to be used * -# Change makefiles to allow for absolute LUFA location to be used
* -# Re-add interrupt Pipe/Endpoint support
* - Documentation/Support * - Documentation/Support
* -# Add detailed overviews of how each demo works * -# Add detailed overviews of how each demo works
* -# Add board overviews * -# Add board overviews
* -# Write LUFA tutorials * -# Write LUFA tutorials
* -# Add makefile template
* - Demos/Projects * - Demos/Projects
* -# Multiple-Report HID device * -# Multiple-Report HID device
* -# Device/Host USB bridge * -# Device/Host USB bridge
......
...@@ -30,7 +30,14 @@ ...@@ -30,7 +30,14 @@
/** \file /** \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_ #ifndef _ULW_RING_BUFF_H_
......
...@@ -30,7 +30,14 @@ ...@@ -30,7 +30,14 @@
/** \file /** \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_ #ifndef _ULW_RING_BUFF_H_
......
...@@ -30,7 +30,14 @@ ...@@ -30,7 +30,14 @@
/** \file /** \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_ #ifndef _ULW_RING_BUFF_H_
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment