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

Add missing documentation to the lightweight ring buffer code in the XPLAINBridge project.

Browse Source
pull/1469/head
Dean Camera 15 years ago
parent f73f01235e
commit b02217d745
1 changed files with 119 additions and 89 deletions
Show Stats Download Patch File Download Diff File

208
Projects/XPLAINBridge/Lib/LightweightRingBuff.h
Unescape View File

@ -1,90 +1,120 @@
/* /*
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.fourwalledcubicle.com www.fourwalledcubicle.com
*/ */
/* /*
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
* *
* Ultra lightweight ring buffer, for fast insertion/deletion. * Ultra lightweight ring buffer, for fast insertion/deletion.
*/ */
#ifndef _ULW_RING_BUFF_H_ #ifndef _ULW_RING_BUFF_H_
#define _ULW_RING_BUFF_H_ #define _ULW_RING_BUFF_H_
/* Includes: */ /* Includes: */
#include <stdint.h> #include <util/atomic.h>
#include <stdbool.h>
#include <stdint.h>
/* Defines: */ #include <stdbool.h>
/** Size of each ring buffer, in bytes. */
#define BUFFER_SIZE 128 /* Defines: */
/** Size of each ring buffer, in data elements - must be between 1 and 255. */
/** Type of data to store into the buffer. */ #define BUFFER_SIZE 128
#define RingBuff_Data_t uint8_t
/** Type of data to store into the buffer. */
/* Type Defines: */ #define RingBuff_Data_t uint8_t
typedef struct
{ /* Type Defines: */
RingBuff_Data_t Buffer[BUFFER_SIZE]; /** Type define for a new ring buffer object. Buffers should be initialized via a call to
RingBuff_Data_t* In; * \ref RingBuffer_InitBuffer() before use.
RingBuff_Data_t* Out; */
uint8_t Count; typedef struct
} RingBuff_t; {
RingBuff_Data_t Buffer[BUFFER_SIZE]; /**< Internal ring buffer data, referenced by the buffer pointers. */
/* Inline Functions: */ RingBuff_Data_t* In; /**< Current storage location in the circular buffer */
static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer) RingBuff_Data_t* Out; /**< Current retrieval location in the circular buffer */
{ uint8_t Count; /**< Total number of bytes stored in the circular buffer */
Buffer->In = Buffer->Buffer; } RingBuff_t;
Buffer->Out = Buffer->Buffer;
Buffer->Count = 0; /* 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
static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data) * by re-initializing them using this function.
{ *
*Buffer->In = Data; * \ref Buffer Pointer to a ring buffer structure to initialize
*/
if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE]) static inline void RingBuffer_InitBuffer(RingBuff_t* const Buffer)
Buffer->In = Buffer->Buffer; {
Buffer->In = Buffer->Buffer;
Buffer->Count++; Buffer->Out = Buffer->Buffer;
} Buffer->Count = 0;
}
static inline RingBuff_Data_t RingBuffer_Remove(RingBuff_t* const Buffer)
{ /** Inserts an element into the ring buffer.
RingBuff_Data_t Data = *Buffer->Out; *
* \ref Buffer Pointer to a ring buffer structure to insert into
if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE]) * \ref Data Data element to insert into the buffer
Buffer->Out = Buffer->Buffer; */
static inline void RingBuffer_Insert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
Buffer->Count--; {
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
return Data; {
} *Buffer->In = Data;
#endif if (++Buffer->In == &Buffer->Buffer[BUFFER_SIZE])
Buffer->In = Buffer->Buffer;
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)
{
RingBuff_Data_t Data;
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
{
Data = *Buffer->Out;
if (++Buffer->Out == &Buffer->Buffer[BUFFER_SIZE])
Buffer->Out = Buffer->Buffer;
Buffer->Count--;
}
return Data;
}
#endif
Write Preview
Loading…
Cancel
Save