forksand
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document lightweight ring buffer header files.

Browse Source
pull/1469/head
Dean Camera 15 years ago
parent 2dabb4e55f
commit c2e340320c
3 changed files with 100 additions and 40 deletions
Show Stats Download Patch File Download Diff File

2
LUFA.pnproj
View File

File diff suppressed because one or more lines are too long

60
Projects/Benito/Lib/LightweightRingBuff.h
Unescape View File

@ -37,51 +37,81 @@
#define _ULW_RING_BUFF_H_ #define _ULW_RING_BUFF_H_
/* Includes: */ /* Includes: */
#include <util/atomic.h>
#include <stdint.h> #include <stdint.h>
#include <stdbool.h> #include <stdbool.h>
/* Defines: */ /* Defines: */
/** Size of each ring buffer, in bytes. */ /** Size of each ring buffer, in data elements - must be between 1 and 255. */
#define BUFFER_SIZE 128 #define BUFFER_SIZE 128
/** Type of data to store into the buffer. */ /** Type of data to store into the buffer. */
#define RingBuff_Data_t uint8_t #define RingBuff_Data_t uint8_t
/* Type Defines: */ /* 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 typedef struct
{ {
RingBuff_Data_t Buffer[BUFFER_SIZE]; RingBuff_Data_t Buffer[BUFFER_SIZE]; /**< Internal ring buffer data, referenced by the buffer pointers. */
RingBuff_Data_t* In; RingBuff_Data_t* In; /**< Current storage location in the circular buffer */
RingBuff_Data_t* Out; RingBuff_Data_t* Out; /**< Current retrieval location in the circular buffer */
uint8_t Count; uint8_t Count; /**< Total number of bytes stored in the circular buffer */
} RingBuff_t; } RingBuff_t;
/* Inline Functions: */ /* 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.
*
* \ref Buffer Pointer to a ring buffer structure to initialize
*/
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer) static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
{ {
Buffer->In = Buffer->Buffer; Buffer->In = Buffer->Buffer;
Buffer->Out = Buffer->Buffer; Buffer->Out = Buffer->Buffer;
Buffer->Count = 0; Buffer->Count = 0;
} }
/** Inserts an element into the ring buffer.
*
* \ref Buffer Pointer to a ring buffer structure to insert into
* \ref Data Data element to insert into the buffer
*/
static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data) static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
{ {
*Buffer->In = Data; ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
{
*Buffer->In = Data;
if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE]) if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE])
Buffer->In = Buffer->Buffer; Buffer->In = Buffer->Buffer;
Buffer->Count++; Buffer->Count++;
}
} }
/** Retrieves an element from the ring buffer.
*
* \ref 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) static inline RingBuff_Data_t RingBuffer_Remove(RingBuff_t* const Buffer)
{ {
RingBuff_Data_t Data = *Buffer->Out; RingBuff_Data_t Data;
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
{
Data = *Buffer->Out;
if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE]) if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE])
Buffer->Out = Buffer->Buffer; Buffer->Out = Buffer->Buffer;
Buffer->Count--; Buffer->Count--;
}
return Data; return Data;
} }

62
Projects/USBtoSerial/Lib/LightweightRingBuff.h
Unescape View File

@ -37,51 +37,81 @@
#define _ULW_RING_BUFF_H_ #define _ULW_RING_BUFF_H_
/* Includes: */ /* Includes: */
#include <util/atomic.h>
#include <stdint.h> #include <stdint.h>
#include <stdbool.h> #include <stdbool.h>
/* Defines: */ /* Defines: */
/** Size of each ring buffer, in bytes */ /** Size of each ring buffer, in data elements - must be between 1 and 255. */
#define BUFFER_SIZE 128 #define BUFFER_SIZE 128
/** Type of data to store into the buffer */ /** Type of data to store into the buffer. */
#define RingBuff_Data_t uint8_t #define RingBuff_Data_t uint8_t
/* Type Defines: */ /* 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 typedef struct
{ {
RingBuff_Data_t Buffer[BUFFER_SIZE]; RingBuff_Data_t Buffer[BUFFER_SIZE]; /**< Internal ring buffer data, referenced by the buffer pointers. */
RingBuff_Data_t* In; RingBuff_Data_t* In; /**< Current storage location in the circular buffer */
RingBuff_Data_t* Out; RingBuff_Data_t* Out; /**< Current retrieval location in the circular buffer */
uint8_t Count; uint8_t Count; /**< Total number of bytes stored in the circular buffer */
} RingBuff_t; } RingBuff_t;
/* Inline Functions: */ /* 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.
*
* \ref Buffer Pointer to a ring buffer structure to initialize
*/
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer) static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
{ {
Buffer->In = Buffer->Buffer; Buffer->In = Buffer->Buffer;
Buffer->Out = Buffer->Buffer; Buffer->Out = Buffer->Buffer;
Buffer->Count = 0; Buffer->Count = 0;
} }
/** Inserts an element into the ring buffer.
*
* \ref Buffer Pointer to a ring buffer structure to insert into
* \ref Data Data element to insert into the buffer
*/
static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data) static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
{ {
*Buffer->In = Data; ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
{
*Buffer->In = Data;
if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE]) if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE])
Buffer->In = Buffer->Buffer; Buffer->In = Buffer->Buffer;
Buffer->Count++; Buffer->Count++;
}
} }
/** Retrieves an element from the ring buffer.
*
* \ref 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) static inline RingBuff_Data_t RingBuffer_Remove(RingBuff_t* const Buffer)
{ {
RingBuff_Data_t Data = *Buffer->Out; RingBuff_Data_t Data;
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
{
Data = *Buffer->Out;
if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE]) if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE])
Buffer->Out = Buffer->Buffer; Buffer->Out = Buffer->Buffer;
Buffer->Count--; Buffer->Count--;
}
return Data; return Data;
} }

Write Preview
Loading…
Cancel
Save