Make a new general RingBuffer.h misc library driver, instead of the per-application LightweightRingBuff.h ring buffers. Change over projects to use the new driver.
Add ORDERED_EP_CONFIG to the device Projects (only) that use only a single class driver, or where the endpoint ordering is fixed, to save on compiled binary size. Added new GCC_FORCE_POINTER_ACCESS() macro to correct GCC's mishandling of struct pointers.pull/1469/head
Dean Camera
14 years ago
parent
12418e6eaf
commit
39ac72f2d1
File diff suppressed because one or more lines are too long
@ -1,211 +1,254 @@
|
|||||||
/*
|
/*
|
||||||
LUFA Library
|
LUFA Library
|
||||||
Copyright (C) Dean Camera, 2010.
|
Copyright (C) Dean Camera, 2010.
|
||||||
|
|
||||||
dean [at] fourwalledcubicle [dot] com
|
dean [at] fourwalledcubicle [dot] com
|
||||||
www.lufa-lib.org
|
www.lufa-lib.org
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
||||||
|
|
||||||
Permission to use, copy, modify, distribute, and sell this
|
Permission to use, copy, modify, distribute, and sell this
|
||||||
software and its documentation for any purpose is hereby granted
|
software and its documentation for any purpose is hereby granted
|
||||||
without fee, provided that the above copyright notice appear in
|
without fee, provided that the above copyright notice appear in
|
||||||
all copies and that both that the copyright notice and this
|
all copies and that both that the copyright notice and this
|
||||||
permission notice and warranty disclaimer appear in supporting
|
permission notice and warranty disclaimer appear in supporting
|
||||||
documentation, and that the name of the author not be used in
|
documentation, and that the name of the author not be used in
|
||||||
advertising or publicity pertaining to distribution of the
|
advertising or publicity pertaining to distribution of the
|
||||||
software without specific, written prior permission.
|
software without specific, written prior permission.
|
||||||
|
|
||||||
The author disclaim all warranties with regard to this
|
The author disclaim all warranties with regard to this
|
||||||
software, including all implied warranties of merchantability
|
software, including all implied warranties of merchantability
|
||||||
and fitness. In no event shall the author be liable for any
|
and fitness. In no event shall the author be liable for any
|
||||||
special, indirect or consequential damages or any damages
|
special, indirect or consequential damages or any damages
|
||||||
whatsoever resulting from loss of use, data or profits, whether
|
whatsoever resulting from loss of use, data or profits, whether
|
||||||
in an action of contract, negligence or other tortious action,
|
in an action of contract, negligence or other tortious action,
|
||||||
arising out of or in connection with the use or performance of
|
arising out of or in connection with the use or performance of
|
||||||
this software.
|
this software.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** \file
|
/** \file
|
||||||
*
|
* \brief 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
|
* Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
|
||||||
* multiple independant buffers can be created.
|
* different sizes to suit different needs.
|
||||||
*
|
*
|
||||||
* Note that for each buffer, insertion and removal operations may occur at the same time (via
|
* 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
|
* 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
|
* 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.
|
* operating occuring at the same point in time, atomic (mutex) locking should be used.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef _ULW_RING_BUFF_H_
|
/** \ingroup Group_MiscDrivers
|
||||||
#define _ULW_RING_BUFF_H_
|
* @defgroup Group_RingBuff Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h
|
||||||
|
*
|
||||||
/* Includes: */
|
* \section Sec_Dependencies Module Source Dependencies
|
||||||
#include <util/atomic.h>
|
* The following files must be built with any user project that uses this module:
|
||||||
|
* - None
|
||||||
#include <stdint.h>
|
*
|
||||||
#include <stdbool.h>
|
* \section Module Description
|
||||||
|
* Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
|
||||||
/* Defines: */
|
* different sizes to suit different needs.
|
||||||
/** Size of each ring buffer, in data elements - must be between 1 and 255. */
|
*
|
||||||
#define BUFFER_SIZE 128
|
* 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
|
||||||
/** Type of data to store into the buffer. */
|
* or deletions) must not overlap. If there is possibility of two or more of the same kind of
|
||||||
#define RingBuff_Data_t uint8_t
|
* operating occuring at the same point in time, atomic (mutex) locking should be used.
|
||||||
|
*
|
||||||
/** Datatype which may be used to store the count of data stored in a buffer, retrieved
|
* Example Usage:
|
||||||
* via a call to \ref RingBuffer_GetCount().
|
* \code
|
||||||
*/
|
* // Create the buffer structure and its underlying storage array
|
||||||
#if (BUFFER_SIZE <= 0xFF)
|
* RingBuff_t Buffer;
|
||||||
#define RingBuff_Count_t uint8_t
|
* uint8_t BufferData[128];
|
||||||
#else
|
*
|
||||||
#define RingBuff_Count_t uint16_t
|
* // Initialise the buffer with the created storage array
|
||||||
#endif
|
* RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData));
|
||||||
|
*
|
||||||
/* Type Defines: */
|
* // Insert some data into the buffer
|
||||||
/** Type define for a new ring buffer object. Buffers should be initialized via a call to
|
* RingBuffer_Insert(Buffer, 'H');
|
||||||
* \ref RingBuffer_InitBuffer() before use.
|
* RingBuffer_Insert(Buffer, 'E');
|
||||||
*/
|
* RingBuffer_Insert(Buffer, 'L');
|
||||||
typedef struct
|
* RingBuffer_Insert(Buffer, 'L');
|
||||||
{
|
* RingBuffer_Insert(Buffer, 'O');
|
||||||
RingBuff_Data_t Buffer[BUFFER_SIZE]; /**< Internal ring buffer data, referenced by the buffer pointers. */
|
*
|
||||||
RingBuff_Data_t* In; /**< Current storage location in the circular buffer */
|
* // Cache the number of stored bytes in the buffer
|
||||||
RingBuff_Data_t* Out; /**< Current retrieval location in the circular buffer */
|
* uint16_t BufferCount = RingBuffer_GetCount(&Buffer);
|
||||||
RingBuff_Count_t Count;
|
*
|
||||||
} RingBuff_t;
|
* // Printer stored data length
|
||||||
|
* printf("Buffer Length: %d, Buffer Data:\r\n", BufferCount);
|
||||||
/* Inline Functions: */
|
*
|
||||||
/** Initializes a ring buffer ready for use. Buffers must be initialized via this function
|
* // Print contents of the buffer one character at a time
|
||||||
* before any operations are called upon them. Already initialized buffers may be reset
|
* while (BufferCount--)
|
||||||
* by re-initializing them using this function.
|
* putc(RingBuffer_Remove(&Buffer));
|
||||||
*
|
* \endcode
|
||||||
* \param[out] Buffer Pointer to a ring buffer structure to initialize
|
*
|
||||||
*/
|
* @{
|
||||||
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
|
*/
|
||||||
{
|
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
#ifndef __RING_BUFF_H__
|
||||||
{
|
#define __RING_BUFF_H__
|
||||||
Buffer->In = Buffer->Buffer;
|
|
||||||
Buffer->Out = Buffer->Buffer;
|
/* Includes: */
|
||||||
}
|
#include <util/atomic.h>
|
||||||
}
|
#include <stdint.h>
|
||||||
|
#include <stdbool.h>
|
||||||
/** Retrieves the minimum number of bytes stored in a particular buffer. This value is computed
|
|
||||||
* by entering an atomic lock on the buffer while the IN and OUT locations are fetched, so that
|
#include <LUFA/Common/Common.h>
|
||||||
* the buffer cannot be modified while the computation takes place. This value should be cached
|
|
||||||
* when reading out the contents of the buffer, so that as small a time as possible is spent
|
/* Type Defines: */
|
||||||
* in an atomic lock.
|
/** Type define for a new ring buffer object. Buffers should be initialized via a call to
|
||||||
*
|
* \ref RingBuffer_InitBuffer() before use.
|
||||||
* \note The value returned by this function is guaranteed to only be the minimum number of bytes
|
*/
|
||||||
* stored in the given buffer; this value may change as other threads write new data and so
|
typedef struct
|
||||||
* the returned number should be used only to determine how many successive reads may safely
|
{
|
||||||
* be performed on the buffer.
|
uint8_t* In; /**< Current storage location in the circular buffer */
|
||||||
*
|
uint8_t* Out; /**< Current retrieval location in the circular buffer */
|
||||||
* \param[in] Buffer Pointer to a ring buffer structure whose count is to be computed
|
uint8_t* Start; /** Pointer to the start of the buffer's underlying storage array */
|
||||||
*/
|
uint8_t* End; /** Pointer to the end of the buffer's underlying storage array */
|
||||||
static inline RingBuff_Count_t RingBuffer_GetCount(RingBuff_t* const Buffer)
|
uint8_t Size; /** Size of the buffer's underlying storage array */
|
||||||
{
|
uint16_t Count; /** Number of bytes currently stored in the buffer */
|
||||||
RingBuff_Count_t Count;
|
} RingBuff_t;
|
||||||
|
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
/* Inline Functions: */
|
||||||
{
|
/** Initializes a ring buffer ready for use. Buffers must be initialized via this function
|
||||||
Count = Buffer->Count;
|
* before any operations are called upon them. Already initialized buffers may be reset
|
||||||
}
|
* by re-initializing them using this function.
|
||||||
|
*
|
||||||
return Count;
|
* \param[out] Buffer Pointer to a ring buffer structure to initialize
|
||||||
}
|
* \param[out] DataPtr Pointer to a global array that will hold the data stored into the ring buffer
|
||||||
|
* \param[out] Size Maximum number of bytes that can be stored in the underlying data array
|
||||||
/** Atomically determines if the specified ring buffer contains any free space. This should
|
*/
|
||||||
* be tested before storing data to the buffer, to ensure that no data is lost due to a
|
static inline void RingBuffer_InitBuffer(RingBuff_t* Buffer, uint8_t* const DataPtr, const uint16_t Size)
|
||||||
* buffer overrun.
|
{
|
||||||
*
|
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
{
|
||||||
*
|
GCC_FORCE_POINTER_ACCESS(Buffer);
|
||||||
* \return Boolean true if the buffer contains no free space, false otherwise
|
|
||||||
*/
|
Buffer->In = DataPtr;
|
||||||
static inline bool RingBuffer_IsFull(RingBuff_t* const Buffer)
|
Buffer->Out = DataPtr;
|
||||||
{
|
Buffer->Start = &DataPtr[0];
|
||||||
return (RingBuffer_GetCount(Buffer) == BUFFER_SIZE);
|
Buffer->End = &DataPtr[Size];
|
||||||
}
|
Buffer->Size = Size;
|
||||||
|
Buffer->Count = 0;
|
||||||
/** Atomically determines if the specified ring buffer contains any data. This should
|
}
|
||||||
* be tested before removing data from the buffer, to ensure that the buffer does not
|
}
|
||||||
* underflow.
|
|
||||||
*
|
/** Retrieves the minimum number of bytes stored in a particular buffer. This value is computed
|
||||||
* If the data is to be removed in a loop, store the total number of bytes stored in the
|
* by entering an atomic lock on the buffer while the IN and OUT locations are fetched, so that
|
||||||
* buffer (via a call to the \ref RingBuffer_GetCount() function) in a temporary variable
|
* the buffer cannot be modified while the computation takes place. This value should be cached
|
||||||
* to reduce the time spent in atomicity locks.
|
* when reading out the contents of the buffer, so that as small a time as possible is spent
|
||||||
*
|
* in an atomic lock.
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
*
|
||||||
*
|
* \note The value returned by this function is guaranteed to only be the minimum number of bytes
|
||||||
* \return Boolean true if the buffer contains no free space, false otherwise
|
* stored in the given buffer; this value may change as other threads write new data and so
|
||||||
*/
|
* the returned number should be used only to determine how many successive reads may safely
|
||||||
static inline bool RingBuffer_IsEmpty(RingBuff_t* const Buffer)
|
* be performed on the buffer.
|
||||||
{
|
*
|
||||||
return (RingBuffer_GetCount(Buffer) == 0);
|
* \param[in] Buffer Pointer to a ring buffer structure whose count is to be computed
|
||||||
}
|
*/
|
||||||
|
static inline uint16_t RingBuffer_GetCount(RingBuff_t* const Buffer)
|
||||||
/** Inserts an element into the ring buffer.
|
{
|
||||||
*
|
uint16_t Count;
|
||||||
* \note Only one execution thread (main program thread or an ISR) may insert into a single buffer
|
|
||||||
* otherwise data corruption may occur. Insertion and removal may occur from different execution
|
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
||||||
* threads.
|
{
|
||||||
*
|
Count = Buffer->Count;
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
}
|
||||||
* \param[in] Data Data element to insert into the buffer
|
|
||||||
*/
|
return Count;
|
||||||
static inline void RingBuffer_Insert(RingBuff_t* const Buffer,
|
}
|
||||||
const RingBuff_Data_t Data)
|
|
||||||
{
|
/** Atomically determines if the specified ring buffer contains any free space. This should
|
||||||
*Buffer->In = Data;
|
* be tested before storing data to the buffer, to ensure that no data is lost due to a
|
||||||
|
* buffer overrun.
|
||||||
if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE])
|
*
|
||||||
Buffer->In = Buffer->Buffer;
|
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
||||||
|
*
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
* \return Boolean true if the buffer contains no free space, false otherwise
|
||||||
{
|
*/
|
||||||
Buffer->Count++;
|
static inline bool RingBuffer_IsFull(RingBuff_t* const Buffer)
|
||||||
}
|
{
|
||||||
}
|
return (RingBuffer_GetCount(Buffer) == Buffer->Size);
|
||||||
|
}
|
||||||
/** Removes an element from the ring buffer.
|
|
||||||
*
|
/** Atomically determines if the specified ring buffer contains any data. This should
|
||||||
* \note Only one execution thread (main program thread or an ISR) may remove from a single buffer
|
* be tested before removing data from the buffer, to ensure that the buffer does not
|
||||||
* otherwise data corruption may occur. Insertion and removal may occur from different execution
|
* underflow.
|
||||||
* threads.
|
*
|
||||||
*
|
* If the data is to be removed in a loop, store the total number of bytes stored in the
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
|
* buffer (via a call to the \ref RingBuffer_GetCount() function) in a temporary variable
|
||||||
*
|
* to reduce the time spent in atomicity locks.
|
||||||
* \return Next data element stored in the buffer
|
*
|
||||||
*/
|
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
||||||
static inline RingBuff_Data_t RingBuffer_Remove(RingBuff_t* const Buffer)
|
*
|
||||||
{
|
* \return Boolean true if the buffer contains no free space, false otherwise
|
||||||
RingBuff_Data_t Data = *Buffer->Out;
|
*/
|
||||||
|
static inline bool RingBuffer_IsEmpty(RingBuff_t* const Buffer)
|
||||||
if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE])
|
{
|
||||||
Buffer->Out = Buffer->Buffer;
|
return (RingBuffer_GetCount(Buffer) == 0);
|
||||||
|
}
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
|
||||||
{
|
/** Inserts an element into the ring buffer.
|
||||||
Buffer->Count--;
|
*
|
||||||
}
|
* \note Only one execution thread (main program thread or an ISR) may insert into a single buffer
|
||||||
|
* otherwise data corruption may occur. Insertion and removal may occur from different execution
|
||||||
return Data;
|
* threads.
|
||||||
}
|
*
|
||||||
|
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
||||||
/** Returns the next element stored in the ring buffer, without removing it.
|
* \param[in] Data Data element to insert into the buffer
|
||||||
*
|
*/
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
|
static inline void RingBuffer_Insert(RingBuff_t* const Buffer,
|
||||||
*
|
const uint8_t Data)
|
||||||
* \return Next data element stored in the buffer
|
{
|
||||||
*/
|
*Buffer->In = Data;
|
||||||
static inline RingBuff_Data_t RingBuffer_Peek(RingBuff_t* const Buffer)
|
|
||||||
{
|
if (++Buffer->In == Buffer->End)
|
||||||
return *Buffer->Out;
|
Buffer->In = Buffer->Start;
|
||||||
}
|
|
||||||
|
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
||||||
#endif
|
{
|
||||||
|
Buffer->Count++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Removes an element from the ring buffer.
|
||||||
|
*
|
||||||
|
* \note Only one execution thread (main program thread or an ISR) may remove from a single buffer
|
||||||
|
* otherwise data corruption may occur. Insertion and removal may occur from different execution
|
||||||
|
* threads.
|
||||||
|
*
|
||||||
|
* \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
|
||||||
|
*
|
||||||
|
* \return Next data element stored in the buffer
|
||||||
|
*/
|
||||||
|
static inline uint8_t RingBuffer_Remove(RingBuff_t* const Buffer)
|
||||||
|
{
|
||||||
|
uint8_t Data = *Buffer->Out;
|
||||||
|
|
||||||
|
if (++Buffer->Out == Buffer->End)
|
||||||
|
Buffer->Out = Buffer->Start;
|
||||||
|
|
||||||
|
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
||||||
|
{
|
||||||
|
Buffer->Count--;
|
||||||
|
}
|
||||||
|
|
||||||
|
return Data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Returns the next element stored in the ring buffer, without removing it.
|
||||||
|
*
|
||||||
|
* \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
|
||||||
|
*
|
||||||
|
* \return Next data element stored in the buffer
|
||||||
|
*/
|
||||||
|
static inline uint8_t RingBuffer_Peek(RingBuff_t* const Buffer)
|
||||||
|
{
|
||||||
|
return *Buffer->Out;
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
/** @} */
|
||||||
|
|
||||||
@ -1,211 +0,0 @@
|
|||||||
/*
|
|
||||||
LUFA Library
|
|
||||||
Copyright (C) Dean Camera, 2010.
|
|
||||||
|
|
||||||
dean [at] fourwalledcubicle [dot] com
|
|
||||||
www.lufa-lib.org
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
|
||||||
|
|
||||||
Permission to use, copy, modify, distribute, and sell this
|
|
||||||
software and its documentation for any purpose is hereby granted
|
|
||||||
without fee, provided that the above copyright notice appear in
|
|
||||||
all copies and that both that the copyright notice and this
|
|
||||||
permission notice and warranty disclaimer appear in supporting
|
|
||||||
documentation, and that the name of the author not be used in
|
|
||||||
advertising or publicity pertaining to distribution of the
|
|
||||||
software without specific, written prior permission.
|
|
||||||
|
|
||||||
The author disclaim all warranties with regard to this
|
|
||||||
software, including all implied warranties of merchantability
|
|
||||||
and fitness. In no event shall the author be liable for any
|
|
||||||
special, indirect or consequential damages or any damages
|
|
||||||
whatsoever resulting from loss of use, data or profits, whether
|
|
||||||
in an action of contract, negligence or other tortious action,
|
|
||||||
arising out of or in connection with the use or performance of
|
|
||||||
this software.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/** \file
|
|
||||||
*
|
|
||||||
* 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_
|
|
||||||
#define _ULW_RING_BUFF_H_
|
|
||||||
|
|
||||||
/* Includes: */
|
|
||||||
#include <util/atomic.h>
|
|
||||||
|
|
||||||
#include <stdint.h>
|
|
||||||
#include <stdbool.h>
|
|
||||||
|
|
||||||
/* Defines: */
|
|
||||||
/** Size of each ring buffer, in data elements - must be between 1 and 255. */
|
|
||||||
#define BUFFER_SIZE 128
|
|
||||||
|
|
||||||
/** Type of data to store into the buffer. */
|
|
||||||
#define RingBuff_Data_t uint8_t
|
|
||||||
|
|
||||||
/** Datatype which may be used to store the count of data stored in a buffer, retrieved
|
|
||||||
* via a call to \ref RingBuffer_GetCount().
|
|
||||||
*/
|
|
||||||
#if (BUFFER_SIZE <= 0xFF)
|
|
||||||
#define RingBuff_Count_t uint8_t
|
|
||||||
#else
|
|
||||||
#define RingBuff_Count_t uint16_t
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Type Defines: */
|
|
||||||
/** Type define for a new ring buffer object. Buffers should be initialized via a call to
|
|
||||||
* \ref RingBuffer_InitBuffer() before use.
|
|
||||||
*/
|
|
||||||
typedef struct
|
|
||||||
{
|
|
||||||
RingBuff_Data_t Buffer[BUFFER_SIZE]; /**< Internal ring buffer data, referenced by the buffer pointers. */
|
|
||||||
RingBuff_Data_t* In; /**< Current storage location in the circular buffer */
|
|
||||||
RingBuff_Data_t* Out; /**< Current retrieval location in the circular buffer */
|
|
||||||
RingBuff_Count_t Count;
|
|
||||||
} RingBuff_t;
|
|
||||||
|
|
||||||
/* Inline Functions: */
|
|
||||||
/** Initializes a ring buffer ready for use. Buffers must be initialized via this function
|
|
||||||
* before any operations are called upon them. Already initialized buffers may be reset
|
|
||||||
* by re-initializing them using this function.
|
|
||||||
*
|
|
||||||
* \param[out] Buffer Pointer to a ring buffer structure to initialize
|
|
||||||
*/
|
|
||||||
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
|
||||||
{
|
|
||||||
Buffer->In = Buffer->Buffer;
|
|
||||||
Buffer->Out = Buffer->Buffer;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Retrieves the minimum number of bytes stored in a particular buffer. This value is computed
|
|
||||||
* by entering an atomic lock on the buffer while the IN and OUT locations are fetched, so that
|
|
||||||
* the buffer cannot be modified while the computation takes place. This value should be cached
|
|
||||||
* when reading out the contents of the buffer, so that as small a time as possible is spent
|
|
||||||
* in an atomic lock.
|
|
||||||
*
|
|
||||||
* \note The value returned by this function is guaranteed to only be the minimum number of bytes
|
|
||||||
* stored in the given buffer; this value may change as other threads write new data and so
|
|
||||||
* the returned number should be used only to determine how many successive reads may safely
|
|
||||||
* be performed on the buffer.
|
|
||||||
*
|
|
||||||
* \param[in] Buffer Pointer to a ring buffer structure whose count is to be computed
|
|
||||||
*/
|
|
||||||
static inline RingBuff_Count_t RingBuffer_GetCount(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
RingBuff_Count_t Count;
|
|
||||||
|
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
|
||||||
{
|
|
||||||
Count = Buffer->Count;
|
|
||||||
}
|
|
||||||
|
|
||||||
return Count;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Atomically determines if the specified ring buffer contains any free space. This should
|
|
||||||
* be tested before storing data to the buffer, to ensure that no data is lost due to a
|
|
||||||
* buffer overrun.
|
|
||||||
*
|
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
|
||||||
*
|
|
||||||
* \return Boolean true if the buffer contains no free space, false otherwise
|
|
||||||
*/
|
|
||||||
static inline bool RingBuffer_IsFull(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
return (RingBuffer_GetCount(Buffer) == BUFFER_SIZE);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Atomically determines if the specified ring buffer contains any data. This should
|
|
||||||
* be tested before removing data from the buffer, to ensure that the buffer does not
|
|
||||||
* underflow.
|
|
||||||
*
|
|
||||||
* If the data is to be removed in a loop, store the total number of bytes stored in the
|
|
||||||
* buffer (via a call to the \ref RingBuffer_GetCount() function) in a temporary variable
|
|
||||||
* to reduce the time spent in atomicity locks.
|
|
||||||
*
|
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
|
||||||
*
|
|
||||||
* \return Boolean true if the buffer contains no free space, false otherwise
|
|
||||||
*/
|
|
||||||
static inline bool RingBuffer_IsEmpty(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
return (RingBuffer_GetCount(Buffer) == 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Inserts an element into the ring buffer.
|
|
||||||
*
|
|
||||||
* \note Only one execution thread (main program thread or an ISR) may insert into a single buffer
|
|
||||||
* otherwise data corruption may occur. Insertion and removal may occur from different execution
|
|
||||||
* threads.
|
|
||||||
*
|
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
|
||||||
* \param[in] Data Data element to insert into the buffer
|
|
||||||
*/
|
|
||||||
static inline void RingBuffer_Insert(RingBuff_t* const Buffer,
|
|
||||||
const RingBuff_Data_t Data)
|
|
||||||
{
|
|
||||||
*Buffer->In = Data;
|
|
||||||
|
|
||||||
if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE])
|
|
||||||
Buffer->In = Buffer->Buffer;
|
|
||||||
|
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
|
||||||
{
|
|
||||||
Buffer->Count++;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Removes an element from the ring buffer.
|
|
||||||
*
|
|
||||||
* \note Only one execution thread (main program thread or an ISR) may remove from a single buffer
|
|
||||||
* otherwise data corruption may occur. Insertion and removal may occur from different execution
|
|
||||||
* threads.
|
|
||||||
*
|
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
|
|
||||||
*
|
|
||||||
* \return Next data element stored in the buffer
|
|
||||||
*/
|
|
||||||
static inline RingBuff_Data_t RingBuffer_Remove(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
RingBuff_Data_t Data = *Buffer->Out;
|
|
||||||
|
|
||||||
if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE])
|
|
||||||
Buffer->Out = Buffer->Buffer;
|
|
||||||
|
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
|
||||||
{
|
|
||||||
Buffer->Count--;
|
|
||||||
}
|
|
||||||
|
|
||||||
return Data;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Returns the next element stored in the ring buffer, without removing it.
|
|
||||||
*
|
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
|
|
||||||
*
|
|
||||||
* \return Next data element stored in the buffer
|
|
||||||
*/
|
|
||||||
static inline RingBuff_Data_t RingBuffer_Peek(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
return *Buffer->Out;
|
|
||||||
}
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
||||||
@ -1,211 +0,0 @@
|
|||||||
/*
|
|
||||||
LUFA Library
|
|
||||||
Copyright (C) Dean Camera, 2010.
|
|
||||||
|
|
||||||
dean [at] fourwalledcubicle [dot] com
|
|
||||||
www.lufa-lib.org
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
|
||||||
|
|
||||||
Permission to use, copy, modify, distribute, and sell this
|
|
||||||
software and its documentation for any purpose is hereby granted
|
|
||||||
without fee, provided that the above copyright notice appear in
|
|
||||||
all copies and that both that the copyright notice and this
|
|
||||||
permission notice and warranty disclaimer appear in supporting
|
|
||||||
documentation, and that the name of the author not be used in
|
|
||||||
advertising or publicity pertaining to distribution of the
|
|
||||||
software without specific, written prior permission.
|
|
||||||
|
|
||||||
The author disclaim all warranties with regard to this
|
|
||||||
software, including all implied warranties of merchantability
|
|
||||||
and fitness. In no event shall the author be liable for any
|
|
||||||
special, indirect or consequential damages or any damages
|
|
||||||
whatsoever resulting from loss of use, data or profits, whether
|
|
||||||
in an action of contract, negligence or other tortious action,
|
|
||||||
arising out of or in connection with the use or performance of
|
|
||||||
this software.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/** \file
|
|
||||||
*
|
|
||||||
* 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_
|
|
||||||
#define _ULW_RING_BUFF_H_
|
|
||||||
|
|
||||||
/* Includes: */
|
|
||||||
#include <util/atomic.h>
|
|
||||||
|
|
||||||
#include <stdint.h>
|
|
||||||
#include <stdbool.h>
|
|
||||||
|
|
||||||
/* Defines: */
|
|
||||||
/** Size of each ring buffer, in data elements - must be between 1 and 255. */
|
|
||||||
#define BUFFER_SIZE 255
|
|
||||||
|
|
||||||
/** Type of data to store into the buffer. */
|
|
||||||
#define RingBuff_Data_t uint8_t
|
|
||||||
|
|
||||||
/** Datatype which may be used to store the count of data stored in a buffer, retrieved
|
|
||||||
* via a call to \ref RingBuffer_GetCount().
|
|
||||||
*/
|
|
||||||
#if (BUFFER_SIZE <= 0xFF)
|
|
||||||
#define RingBuff_Count_t uint8_t
|
|
||||||
#else
|
|
||||||
#define RingBuff_Count_t uint16_t
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/* Type Defines: */
|
|
||||||
/** Type define for a new ring buffer object. Buffers should be initialized via a call to
|
|
||||||
* \ref RingBuffer_InitBuffer() before use.
|
|
||||||
*/
|
|
||||||
typedef struct
|
|
||||||
{
|
|
||||||
RingBuff_Data_t Buffer[BUFFER_SIZE]; /**< Internal ring buffer data, referenced by the buffer pointers. */
|
|
||||||
RingBuff_Data_t* In; /**< Current storage location in the circular buffer */
|
|
||||||
RingBuff_Data_t* Out; /**< Current retrieval location in the circular buffer */
|
|
||||||
RingBuff_Count_t Count;
|
|
||||||
} RingBuff_t;
|
|
||||||
|
|
||||||
/* Inline Functions: */
|
|
||||||
/** Initializes a ring buffer ready for use. Buffers must be initialized via this function
|
|
||||||
* before any operations are called upon them. Already initialized buffers may be reset
|
|
||||||
* by re-initializing them using this function.
|
|
||||||
*
|
|
||||||
* \param[out] Buffer Pointer to a ring buffer structure to initialize
|
|
||||||
*/
|
|
||||||
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
|
||||||
{
|
|
||||||
Buffer->In = Buffer->Buffer;
|
|
||||||
Buffer->Out = Buffer->Buffer;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Retrieves the minimum number of bytes stored in a particular buffer. This value is computed
|
|
||||||
* by entering an atomic lock on the buffer while the IN and OUT locations are fetched, so that
|
|
||||||
* the buffer cannot be modified while the computation takes place. This value should be cached
|
|
||||||
* when reading out the contents of the buffer, so that as small a time as possible is spent
|
|
||||||
* in an atomic lock.
|
|
||||||
*
|
|
||||||
* \note The value returned by this function is guaranteed to only be the minimum number of bytes
|
|
||||||
* stored in the given buffer; this value may change as other threads write new data and so
|
|
||||||
* the returned number should be used only to determine how many successive reads may safely
|
|
||||||
* be performed on the buffer.
|
|
||||||
*
|
|
||||||
* \param[in] Buffer Pointer to a ring buffer structure whose count is to be computed
|
|
||||||
*/
|
|
||||||
static inline RingBuff_Count_t RingBuffer_GetCount(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
RingBuff_Count_t Count;
|
|
||||||
|
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
|
||||||
{
|
|
||||||
Count = Buffer->Count;
|
|
||||||
}
|
|
||||||
|
|
||||||
return Count;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Atomically determines if the specified ring buffer contains any free space. This should
|
|
||||||
* be tested before storing data to the buffer, to ensure that no data is lost due to a
|
|
||||||
* buffer overrun.
|
|
||||||
*
|
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
|
||||||
*
|
|
||||||
* \return Boolean true if the buffer contains no free space, false otherwise
|
|
||||||
*/
|
|
||||||
static inline bool RingBuffer_IsFull(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
return (RingBuffer_GetCount(Buffer) == BUFFER_SIZE);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Atomically determines if the specified ring buffer contains any data. This should
|
|
||||||
* be tested before removing data from the buffer, to ensure that the buffer does not
|
|
||||||
* underflow.
|
|
||||||
*
|
|
||||||
* If the data is to be removed in a loop, store the total number of bytes stored in the
|
|
||||||
* buffer (via a call to the \ref RingBuffer_GetCount() function) in a temporary variable
|
|
||||||
* to reduce the time spent in atomicity locks.
|
|
||||||
*
|
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
|
||||||
*
|
|
||||||
* \return Boolean true if the buffer contains no free space, false otherwise
|
|
||||||
*/
|
|
||||||
static inline bool RingBuffer_IsEmpty(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
return (RingBuffer_GetCount(Buffer) == 0);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Inserts an element into the ring buffer.
|
|
||||||
*
|
|
||||||
* \note Only one execution thread (main program thread or an ISR) may insert into a single buffer
|
|
||||||
* otherwise data corruption may occur. Insertion and removal may occur from different execution
|
|
||||||
* threads.
|
|
||||||
*
|
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into
|
|
||||||
* \param[in] Data Data element to insert into the buffer
|
|
||||||
*/
|
|
||||||
static inline void RingBuffer_Insert(RingBuff_t* const Buffer,
|
|
||||||
const RingBuff_Data_t Data)
|
|
||||||
{
|
|
||||||
*Buffer->In = Data;
|
|
||||||
|
|
||||||
if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE])
|
|
||||||
Buffer->In = Buffer->Buffer;
|
|
||||||
|
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
|
||||||
{
|
|
||||||
Buffer->Count++;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Removes an element from the ring buffer.
|
|
||||||
*
|
|
||||||
* \note Only one execution thread (main program thread or an ISR) may remove from a single buffer
|
|
||||||
* otherwise data corruption may occur. Insertion and removal may occur from different execution
|
|
||||||
* threads.
|
|
||||||
*
|
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
|
|
||||||
*
|
|
||||||
* \return Next data element stored in the buffer
|
|
||||||
*/
|
|
||||||
static inline RingBuff_Data_t RingBuffer_Remove(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
RingBuff_Data_t Data = *Buffer->Out;
|
|
||||||
|
|
||||||
if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE])
|
|
||||||
Buffer->Out = Buffer->Buffer;
|
|
||||||
|
|
||||||
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
|
||||||
{
|
|
||||||
Buffer->Count--;
|
|
||||||
}
|
|
||||||
|
|
||||||
return Data;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Returns the next element stored in the ring buffer, without removing it.
|
|
||||||
*
|
|
||||||
* \param[in,out] Buffer Pointer to a ring buffer structure to retrieve from
|
|
||||||
*
|
|
||||||
* \return Next data element stored in the buffer
|
|
||||||
*/
|
|
||||||
static inline RingBuff_Data_t RingBuffer_Peek(RingBuff_t* const Buffer)
|
|
||||||
{
|
|
||||||
return *Buffer->Out;
|
|
||||||
}
|
|
||||||
|
|
||||||
#endif
|
|
||||||
|
|
||||||
Loading…
Reference in new issue