LUFA/Drivers/Misc/RingBuffer.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Lightweight ring buffer, for fast insertion/deletion of bytes.
  33  *
  34  *  Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
  35  *  different sizes to suit different needs.
  36  *
  37  *  Note that for each buffer, insertion and removal operations may occur at the same time (via
  38  *  a multi-threaded ISR based system) however the same kind of operation (two or more insertions
  39  *  or deletions) must not overlap. If there is possibility of two or more of the same kind of
  40  *  operating occurring at the same point in time, atomic (mutex) locking should be used.
  41  */
  42
  43 /** \ingroup Group_MiscDrivers
  44  *  \defgroup Group_RingBuff Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h
  45  *  \brief Lightweight ring buffer, for fast insertion/deletion of bytes.
  46  *
  47  *  \section Sec_Dependencies Module Source Dependencies
  48  *  The following files must be built with any user project that uses this module:
  49  *    - None
  50  *
  51  *  \section Sec_ModDescription Module Description
  52  *  Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of
  53  *  different sizes to suit different needs.
  54  *
  55  *  Note that for each buffer, insertion and removal operations may occur at the same time (via
  56  *  a multi-threaded ISR based system) however the same kind of operation (two or more insertions
  57  *  or deletions) must not overlap. If there is possibility of two or more of the same kind of
  58  *  operating occurring at the same point in time, atomic (mutex) locking should be used.
  59  *
  60  *  \section Sec_ExampleUsage Example Usage
  61  *  The following snippet is an example of how this module may be used within a typical
  62  *  application.
  63  *
  64  *  \code
  65  *      // Create the buffer structure and its underlying storage array
  66  *      RingBuffer_t Buffer;
  67  *      uint8_t      BufferData[128];
  68  *
  69  *      // Initialise the buffer with the created storage array
  70  *      RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData));
  71  *
  72  *      // Insert some data into the buffer
  73  *      RingBuffer_Insert(Buffer, 'H');
  74  *      RingBuffer_Insert(Buffer, 'E');
  75  *      RingBuffer_Insert(Buffer, 'L');
  76  *      RingBuffer_Insert(Buffer, 'L');
  77  *      RingBuffer_Insert(Buffer, 'O');
  78  *
  79  *      // Cache the number of stored bytes in the buffer
  80  *      uint16_t BufferCount = RingBuffer_GetCount(&Buffer);
  81  *
  82  *      // Printer stored data length
  83  *      printf("Buffer Length: %d, Buffer Data: \r\n", BufferCount);
  84  *
  85  *      // Print contents of the buffer one character at a time
  86  *      while (BufferCount--)
  87  *        putc(RingBuffer_Remove(&Buffer));
  88  *  \endcode
  89  *
  90  *  @{
  91  */
  92
  93 #ifndef __RING_BUFFER_H__
  94 #define __RING_BUFFER_H__
  95
  96         /* Includes: */
  97                 #include "../../Common/Common.h"
  98
  99         /* Type Defines: */
 100                 /** \brief Ring Buffer Management Structure.
 101                  *
 102                  *  Type define for a new ring buffer object. Buffers should be initialized via a call to
 103                  *  \ref RingBuffer_InitBuffer() before use.
 104                  */
 105                 typedef struct
 106                 {
 107                         uint8_t* In; /**< Current storage location in the circular buffer. */
 108                         uint8_t* Out; /**< Current retrieval location in the circular buffer. */
 109                         uint8_t* Start; /**< Pointer to the start of the buffer's underlying storage array. */
 110                         uint8_t* End; /**< Pointer to the end of the buffer's underlying storage array. */
 111                         uint8_t  Size; /**< Size of the buffer's underlying storage array. */
 112                         uint16_t Count; /**< Number of bytes currently stored in the buffer. */
 113                 } RingBuffer_t;
 114
 115         /* Inline Functions: */
 116                 /** Initializes a ring buffer ready for use. Buffers must be initialized via this function
 117                  *  before any operations are called upon them. Already initialized buffers may be reset
 118                  *  by re-initializing them using this function.
 119                  *
 120                  *  \param[out] Buffer   Pointer to a ring buffer structure to initialize.
 121                  *  \param[out] DataPtr  Pointer to a global array that will hold the data stored into the ring buffer.
 122                  *  \param[out] Size     Maximum number of bytes that can be stored in the underlying data array.
 123                  */
 124                 static inline void RingBuffer_InitBuffer(RingBuffer_t* Buffer, uint8_t* const DataPtr, const uint16_t Size)
 125                 {
 126                         GCC_FORCE_POINTER_ACCESS(Buffer);
 127
 128                         uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();
 129                         GlobalInterruptDisable();
 130
 131                         Buffer->In     = DataPtr;
 132                         Buffer->Out    = DataPtr;
 133                         Buffer->Start  = &DataPtr[0];
 134                         Buffer->End    = &DataPtr[Size];
 135                         Buffer->Size   = Size;
 136                         Buffer->Count  = 0;
 137
 138                         SetGlobalInterruptMask(CurrentGlobalInt);
 139                 }
 140
 141                 /** Retrieves the minimum number of bytes stored in a particular buffer. This value is computed
 142                  *  by entering an atomic lock on the buffer while the IN and OUT locations are fetched, so that
 143                  *  the buffer cannot be modified while the computation takes place. This value should be cached
 144                  *  when reading out the contents of the buffer, so that as small a time as possible is spent
 145                  *  in an atomic lock.
 146                  *
 147                  *  \note The value returned by this function is guaranteed to only be the minimum number of bytes
 148                  *        stored in the given buffer; this value may change as other threads write new data and so
 149                  *        the returned number should be used only to determine how many successive reads may safely
 150                  *        be performed on the buffer.
 151                  *
 152                  *  \param[in] Buffer  Pointer to a ring buffer structure whose count is to be computed.
 153                  */
 154                 static inline uint16_t RingBuffer_GetCount(RingBuffer_t* const Buffer)
 155                 {
 156                         uint16_t Count;
 157
 158                         uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();
 159                         GlobalInterruptDisable();
 160
 161                         Count = Buffer->Count;
 162
 163                         SetGlobalInterruptMask(CurrentGlobalInt);
 164                         return Count;
 165                 }
 166
 167                 /** Atomically determines if the specified ring buffer contains any free space. This should
 168                  *  be tested before storing data to the buffer, to ensure that no data is lost due to a
 169                  *  buffer overrun.
 170                  *
 171                  *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.
 172                  *
 173                  *  \return Boolean \c true if the buffer contains no free space, false otherwise.
 174                  */
 175                 static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer)
 176                 {
 177                         return (RingBuffer_GetCount(Buffer) == Buffer->Size);
 178                 }
 179
 180                 /** Atomically determines if the specified ring buffer contains any data. This should
 181                  *  be tested before removing data from the buffer, to ensure that the buffer does not
 182                  *  underflow.
 183                  *
 184                  *  If the data is to be removed in a loop, store the total number of bytes stored in the
 185                  *  buffer (via a call to the \ref RingBuffer_GetCount() function) in a temporary variable
 186                  *  to reduce the time spent in atomicity locks.
 187                  *
 188                  *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.
 189                  *
 190                  *  \return Boolean \c true if the buffer contains no free space, false otherwise.
 191                  */
 192                 static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer)
 193                 {
 194                         return (RingBuffer_GetCount(Buffer) == 0);
 195                 }
 196
 197                 /** Inserts an element into the ring buffer.
 198                  *
 199                  *  \note Only one execution thread (main program thread or an ISR) may insert into a single buffer
 200                  *        otherwise data corruption may occur. Insertion and removal may occur from different execution
 201                  *        threads.
 202                  *
 203                  *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.
 204                  *  \param[in]     Data    Data element to insert into the buffer.
 205                  */
 206                 static inline void RingBuffer_Insert(RingBuffer_t* Buffer,
 207                                                      const uint8_t Data)
 208                 {
 209                         GCC_FORCE_POINTER_ACCESS(Buffer);
 210
 211                         *Buffer->In = Data;
 212
 213                         if (++Buffer->In == Buffer->End)
 214                           Buffer->In = Buffer->Start;
 215
 216                         uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();
 217                         GlobalInterruptDisable();
 218
 219                         Buffer->Count++;
 220
 221                         SetGlobalInterruptMask(CurrentGlobalInt);
 222                 }
 223
 224                 /** Removes an element from the ring buffer.
 225                  *
 226                  *  \note Only one execution thread (main program thread or an ISR) may remove from a single buffer
 227                  *        otherwise data corruption may occur. Insertion and removal may occur from different execution
 228                  *        threads.
 229                  *
 230                  *  \param[in,out] Buffer  Pointer to a ring buffer structure to retrieve from.
 231                  *
 232                  *  \return Next data element stored in the buffer.
 233                  */
 234                 static inline uint8_t RingBuffer_Remove(RingBuffer_t* Buffer)
 235                 {
 236                         GCC_FORCE_POINTER_ACCESS(Buffer);
 237
 238                         uint8_t Data = *Buffer->Out;
 239
 240                         if (++Buffer->Out == Buffer->End)
 241                           Buffer->Out = Buffer->Start;
 242
 243                         uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();
 244                         GlobalInterruptDisable();
 245
 246                         Buffer->Count--;
 247
 248                         SetGlobalInterruptMask(CurrentGlobalInt);
 249
 250                         return Data;
 251                 }
 252
 253                 /** Returns the next element stored in the ring buffer, without removing it.
 254                  *
 255                  *  \param[in,out] Buffer  Pointer to a ring buffer structure to retrieve from.
 256                  *
 257                  *  \return Next data element stored in the buffer.
 258                  */
 259                 static inline uint8_t RingBuffer_Peek(RingBuffer_t* const Buffer)
 260                 {
 261                         return *Buffer->Out;
 262                 }
 263
 264 #endif
 265
 266 /** @} */
 267