Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
L
lufa
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Erik Strand
lufa
Commits
b02217d7
Commit
b02217d7
authored
15 years ago
by
Dean Camera
Browse files
Options
Downloads
Patches
Plain Diff
Add missing documentation to the lightweight ring buffer code in the XPLAINBridge project.
parent
f73f0123
No related branches found
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
Projects/XPLAINBridge/Lib/LightweightRingBuff.h
+119
-89
119 additions, 89 deletions
Projects/XPLAINBridge/Lib/LightweightRingBuff.h
with
119 additions
and
89 deletions
Projects/XPLAINBridge/Lib/LightweightRingBuff.h
+
119
−
89
View file @
b02217d7
...
...
@@ -37,26 +37,37 @@
#define _ULW_RING_BUFF_H_
/* Includes: */
#include
<util/atomic.h>
#include
<stdint.h>
#include
<stdbool.h>
/* 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
/** Type of data to store into the buffer. */
#define RingBuff_Data_t uint8_t
/* 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
];
RingBuff_Data_t
*
In
;
RingBuff_Data_t
*
Out
;
uint8_t
Count
;
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 */
uint8_t
Count
;
/**< Total number of bytes stored in the circular buffer */
}
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.
*
* \ref Buffer Pointer to a ring buffer structure to initialize
*/
static
inline
void
RingBuffer_InitBuffer
(
RingBuff_t
*
const
Buffer
)
{
Buffer
->
In
=
Buffer
->
Buffer
;
...
...
@@ -64,7 +75,14 @@
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
)
{
ATOMIC_BLOCK
(
ATOMIC_RESTORESTATE
)
{
*
Buffer
->
In
=
Data
;
...
...
@@ -73,15 +91,27 @@
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
=
*
Buffer
->
Out
;
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
;
}
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment