Remove unneeded #include of Device.h in StdDescriptors.h breaking compilation for...

[pub/USBasp.git] / LUFA / Drivers / Misc / RingBuffer.h

diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h
index ea2d7c0..64587e6 100644 (file)
--- a/LUFA/Drivers/Misc/RingBuffer.h
+++ b/LUFA/Drivers/Misc/RingBuffer.h
@@ -1,13 +1,13 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2010.\r
+     Copyright (C) Dean Camera, 2011.\r

 \r
   dean [at] fourwalledcubicle [dot] com\r
            www.lufa-lib.org\r
 */\r
 \r
 /*\r
 \r
   dean [at] fourwalledcubicle [dot] com\r
            www.lufa-lib.org\r
 */\r
 \r
 /*\r

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r

 \r
   Permission to use, copy, modify, distribute, and sell this\r
   software and its documentation for any purpose is hereby granted\r
 \r
   Permission to use, copy, modify, distribute, and sell this\r
   software and its documentation for any purpose is hereby granted\r


@@ -29,19 +29,20 @@
 */\r
 \r
 /** \file\r
 */\r
 \r
 /** \file\r

- *  \brief Lightweight ring buffer, for fast insertion/deletion.\r
+ *  \brief Lightweight ring (circular) buffer, for fast insertion/deletion of bytes.\r

  *\r
  *  Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of\r
  *  different sizes to suit different needs.\r
  *\r
  *  Note that for each buffer, insertion and removal operations may occur at the same time (via\r
  *\r
  *  Lightweight ring buffer, for fast insertion/deletion. Multiple buffers can be created of\r
  *  different sizes to suit different needs.\r
  *\r
  *  Note that for each buffer, insertion and removal operations may occur at the same time (via\r

- *  a multithreaded ISR based system) however the same kind of operation (two or more insertions\r
+ *  a multi-threaded ISR based system) however the same kind of operation (two or more insertions\r

  *  or deletions) must not overlap. If there is possibility of two or more of the same kind of\r
  *  or deletions) must not overlap. If there is possibility of two or more of the same kind of\r

- *  operating occuring at the same point in time, atomic (mutex) locking should be used.\r
+ *  operating occurring at the same point in time, atomic (mutex) locking should be used.\r

  */\r
  \r
 /** \ingroup Group_MiscDrivers\r
  */\r
  \r
 /** \ingroup Group_MiscDrivers\r

- *  @defgroup Group_RingBuff Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h\r
+ *  \defgroup Group_RingBuff Generic Byte Ring Buffer - LUFA/Drivers/Misc/RingBuffer.h\r
+ *  \brief Lightweight ring buffer, for fast insertion/deletion of bytes.\r

  *\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r
  *\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r


@@ -52,9 +53,9 @@
  *  different sizes to suit different needs.\r
  *\r
  *  Note that for each buffer, insertion and removal operations may occur at the same time (via\r
  *  different sizes to suit different needs.\r
  *\r
  *  Note that for each buffer, insertion and removal operations may occur at the same time (via\r

- *  a multithreaded ISR based system) however the same kind of operation (two or more insertions\r
+ *  a multi-threaded ISR based system) however the same kind of operation (two or more insertions\r

  *  or deletions) must not overlap. If there is possibility of two or more of the same kind of\r
  *  or deletions) must not overlap. If there is possibility of two or more of the same kind of\r

- *  operating occuring at the same point in time, atomic (mutex) locking should be used.\r
+ *  operating occurring at the same point in time, atomic (mutex) locking should be used.\r

  *\r
  *  \section Sec_ExampleUsage Example Usage\r
  *  The following snippet is an example of how this module may be used within a typical\r
  *\r
  *  \section Sec_ExampleUsage Example Usage\r
  *  The following snippet is an example of how this module may be used within a typical\r


@@ -62,10 +63,10 @@
  *\r
  *  \code\r
  *      // Create the buffer structure and its underlying storage array\r
  *\r
  *  \code\r
  *      // Create the buffer structure and its underlying storage array\r

- *      RingBuff_t Buffer;\r
- *      uint8_t    BufferData[128];\r
+ *      RingBuffer_t Buffer;\r
+ *      uint8_t      BufferData[128];\r

  *\r
  *\r

- *      // Initialise the buffer with the created storage array\r
+ *      // Initialize the buffer with the created storage array\r

  *      RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData));\r
  *\r
  *      // Insert some data into the buffer\r
  *      RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData));\r
  *\r
  *      // Insert some data into the buffer\r


@@ -89,29 +90,32 @@
  *  @{\r
  */\r
 \r
  *  @{\r
  */\r
 \r

-#ifndef __RING_BUFF_H__\r
-#define __RING_BUFF_H__\r
+#ifndef __RING_BUFFER_H__\r
+#define __RING_BUFFER_H__\r

 \r
        /* Includes: */\r
 \r
        /* Includes: */\r

-               #include <util/atomic.h>\r
-               #include <stdint.h>\r
-               #include <stdbool.h>\r
+               #include "../../Common/Common.h"\r

 \r
 \r

-               #include <LUFA/Common/Common.h>\r
+       /* Enable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       extern "C" {\r
+               #endif\r

 \r
        /* Type Defines: */\r
 \r
        /* Type Defines: */\r

-               /** Type define for a new ring buffer object. Buffers should be initialized via a call to\r
+               /** \brief Ring Buffer Management Structure.\r
+                *\r
+                *  Type define for a new ring buffer object. Buffers should be initialized via a call to\r

                 *  \ref RingBuffer_InitBuffer() before use.\r
                 */\r
                typedef struct\r
                {\r
                 *  \ref RingBuffer_InitBuffer() before use.\r
                 */\r
                typedef struct\r
                {\r

-                       uint8_t* In; /**< Current storage location in the circular buffer */\r
-                       uint8_t* Out; /**< Current retrieval location in the circular buffer */\r
-                       uint8_t* Start; /**< Pointer to the start of the buffer's underlying storage array */\r
-                       uint8_t* End; /**< Pointer to the end of the buffer's underlying storage array */\r
-                       uint8_t  Size; /**< Size of the buffer's underlying storage array */\r
-                       uint16_t Count; /**< Number of bytes currently stored in the buffer */\r
-               } RingBuff_t;\r
+                       uint8_t* In; /**< Current storage location in the circular buffer. */\r
+                       uint8_t* Out; /**< Current retrieval location in the circular buffer. */\r
+                       uint8_t* Start; /**< Pointer to the start of the buffer's underlying storage array. */\r
+                       uint8_t* End; /**< Pointer to the end of the buffer's underlying storage array. */\r
+                       uint8_t  Size; /**< Size of the buffer's underlying storage array. */\r
+                       uint16_t Count; /**< Number of bytes currently stored in the buffer. */\r
+               } RingBuffer_t;\r

 \r
        /* Inline Functions: */\r
                /** Initializes a ring buffer ready for use. Buffers must be initialized via this function\r
 \r
        /* Inline Functions: */\r
                /** Initializes a ring buffer ready for use. Buffers must be initialized via this function\r


@@ -122,57 +126,69 @@
                 *  \param[out] DataPtr  Pointer to a global array that will hold the data stored into the ring buffer.\r
                 *  \param[out] Size     Maximum number of bytes that can be stored in the underlying data array.\r
                 */\r
                 *  \param[out] DataPtr  Pointer to a global array that will hold the data stored into the ring buffer.\r
                 *  \param[out] Size     Maximum number of bytes that can be stored in the underlying data array.\r
                 */\r

-               static inline void RingBuffer_InitBuffer(RingBuff_t* Buffer, uint8_t* const DataPtr, const uint16_t Size)\r
+               static inline void RingBuffer_InitBuffer(RingBuffer_t* Buffer, uint8_t* const DataPtr, const uint16_t Size)\r
+                                                        ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
+               static inline void RingBuffer_InitBuffer(RingBuffer_t* Buffer, uint8_t* const DataPtr, const uint16_t Size)\r

                {\r
                {\r

-                       ATOMIC_BLOCK(ATOMIC_RESTORESTATE)\r
-                       {\r
-                               GCC_FORCE_POINTER_ACCESS(Buffer);\r
-                               \r
-                               Buffer->In     = DataPtr;\r
-                               Buffer->Out    = DataPtr;\r
-                               Buffer->Start  = &DataPtr[0];\r
-                               Buffer->End    = &DataPtr[Size];\r
-                               Buffer->Size   = Size;\r
-                               Buffer->Count  = 0;\r
-                       }\r
+                       GCC_FORCE_POINTER_ACCESS(Buffer);\r
+\r
+                       uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();\r
+                       GlobalInterruptDisable();\r
+       \r
+                       Buffer->In     = DataPtr;\r
+                       Buffer->Out    = DataPtr;\r
+                       Buffer->Start  = &DataPtr[0];\r
+                       Buffer->End    = &DataPtr[Size];\r
+                       Buffer->Size   = Size;\r
+                       Buffer->Count  = 0;\r
+\r
+                       SetGlobalInterruptMask(CurrentGlobalInt);\r

                }\r
 \r
                }\r
 \r

-               /** Retrieves the minimum number of bytes stored in a particular buffer. This value is computed\r
-                *  by entering an atomic lock on the buffer while the IN and OUT locations are fetched, so that\r
-                *  the buffer cannot be modified while the computation takes place. This value should be cached\r
-                *  when reading out the contents of the buffer, so that as small a time as possible is spent\r
-                *  in an atomic lock.\r
+               /** Retrieves the current number of bytes stored in a particular buffer. This value is computed\r
+                *  by entering an atomic lock on the buffer, so that the buffer cannot be modified while the\r
+                *  computation takes place. This value should be cached when reading out the contents of the buffer,\r
+                *  so that as small a time as possible is spent in an atomic lock.\r

                 *\r
                 *  \note The value returned by this function is guaranteed to only be the minimum number of bytes\r
                 *\r
                 *  \note The value returned by this function is guaranteed to only be the minimum number of bytes\r

-                *        stored in the given buffer; this value may change as other threads write new data and so\r
+                *        stored in the given buffer; this value may change as other threads write new data, thus\r

                 *        the returned number should be used only to determine how many successive reads may safely\r
                 *        be performed on the buffer.\r
                 *\r
                 *  \param[in] Buffer  Pointer to a ring buffer structure whose count is to be computed.\r
                 *        the returned number should be used only to determine how many successive reads may safely\r
                 *        be performed on the buffer.\r
                 *\r
                 *  \param[in] Buffer  Pointer to a ring buffer structure whose count is to be computed.\r

+                *\r
+                *  \return Number of bytes currently stored in the buffer.\r

                 */\r
                 */\r

-               static inline uint16_t RingBuffer_GetCount(RingBuff_t* const Buffer)\r
+               static inline uint16_t RingBuffer_GetCount(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);\r
+               static inline uint16_t RingBuffer_GetCount(RingBuffer_t* const Buffer)\r

                {\r
                        uint16_t Count;\r
 \r
                {\r
                        uint16_t Count;\r
 \r

-                       ATOMIC_BLOCK(ATOMIC_RESTORESTATE)\r
-                       {\r
-                               Count = Buffer->Count;\r
-                       }\r
+                       uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();\r
+                       GlobalInterruptDisable();\r
+                       \r
+                       Count = Buffer->Count;\r

 \r
 \r

+                       SetGlobalInterruptMask(CurrentGlobalInt);\r

                        return Count;\r
                }\r
 \r
                        return Count;\r
                }\r
 \r

-               /** Atomically determines if the specified ring buffer contains any free space. This should\r
-                *  be tested before storing data to the buffer, to ensure that no data is lost due to a\r
-                *  buffer overrun.\r
+               /** Retrieves the free space in a particular buffer. This value is computed by entering an atomic lock\r
+                *  on the buffer, so that the buffer cannot be modified while the computation takes place.\r

                 *\r
                 *\r

-                *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.\r
+                *  \note The value returned by this function is guaranteed to only be the maximum number of bytes\r
+                *        free in the given buffer; this value may change as other threads write new data, thus\r
+                *        the returned number should be used only to determine how many successive writes may safely\r
+                *        be performed on the buffer when there is a single writer thread.\r

                 *\r
                 *\r

-                *  \return Boolean true if the buffer contains no free space, false otherwise.\r
+                *  \param[in] Buffer  Pointer to a ring buffer structure whose free count is to be computed.\r
+                *\r
+                *  \return Number of free bytes in the buffer.\r

                 */\r
                 */\r

-               static inline bool RingBuffer_IsFull(RingBuff_t* const Buffer)\r
+               static inline uint16_t RingBuffer_GetFreeCount(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);\r
+               static inline uint16_t RingBuffer_GetFreeCount(RingBuffer_t* const Buffer)\r

                {\r
                {\r

-                       return (RingBuffer_GetCount(Buffer) == Buffer->Size);\r
+                       return (Buffer->Size - RingBuffer_GetCount(Buffer));\r

                }\r
 \r
                /** Atomically determines if the specified ring buffer contains any data. This should\r
                }\r
 \r
                /** Atomically determines if the specified ring buffer contains any data. This should\r


@@ -185,13 +201,28 @@
                 *\r
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.\r
                 *\r
                 *\r
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.\r
                 *\r

-                *  \return Boolean true if the buffer contains no free space, false otherwise.\r
+                *  \return Boolean \c true if the buffer contains no free space, false otherwise.\r

                 */\r
                 */\r

-               static inline bool RingBuffer_IsEmpty(RingBuff_t* const Buffer)\r
+               static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);\r
+               static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer)\r

                {\r
                        return (RingBuffer_GetCount(Buffer) == 0);\r
                }\r
 \r
                {\r
                        return (RingBuffer_GetCount(Buffer) == 0);\r
                }\r
 \r

+               /** Atomically determines if the specified ring buffer contains any free space. This should\r
+                *  be tested before storing data to the buffer, to ensure that no data is lost due to a\r
+                *  buffer overrun.\r
+                *\r
+                *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.\r
+                *\r
+                *  \return Boolean \c true if the buffer contains no free space, false otherwise.\r
+                */\r
+               static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);\r
+               static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer)\r
+               {\r
+                       return (RingBuffer_GetCount(Buffer) == Buffer->Size);\r
+               }\r
+\r

                /** Inserts an element into the ring buffer.\r
                 *\r
                 *  \note Only one execution thread (main program thread or an ISR) may insert into a single buffer\r
                /** Inserts an element into the ring buffer.\r
                 *\r
                 *  \note Only one execution thread (main program thread or an ISR) may insert into a single buffer\r


@@ -201,18 +232,22 @@
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.\r
                 *  \param[in]     Data    Data element to insert into the buffer.\r
                 */\r
                 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into.\r
                 *  \param[in]     Data    Data element to insert into the buffer.\r
                 */\r

-               static inline void RingBuffer_Insert(RingBuff_t* const Buffer,\r
-                                                    const uint8_t Data)\r
+               static inline void RingBuffer_Insert(RingBuffer_t* Buffer, const uint8_t Data) ATTR_NON_NULL_PTR_ARG(1);\r
+               static inline void RingBuffer_Insert(RingBuffer_t* Buffer, const uint8_t Data)\r

                {\r
                {\r

+                       GCC_FORCE_POINTER_ACCESS(Buffer);\r
+\r

                        *Buffer->In = Data;\r
 \r
                        if (++Buffer->In == Buffer->End)\r
                          Buffer->In = Buffer->Start;\r
 \r
                        *Buffer->In = Data;\r
 \r
                        if (++Buffer->In == Buffer->End)\r
                          Buffer->In = Buffer->Start;\r
 \r

-                       ATOMIC_BLOCK(ATOMIC_RESTORESTATE)\r
-                       {\r
-                               Buffer->Count++;\r
-                       }\r
+                       uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();\r
+                       GlobalInterruptDisable();\r
+                       \r
+                       Buffer->Count++;\r
+\r
+                       SetGlobalInterruptMask(CurrentGlobalInt);\r

                }\r
 \r
                /** Removes an element from the ring buffer.\r
                }\r
 \r
                /** Removes an element from the ring buffer.\r


@@ -225,17 +260,22 @@
                 *\r
                 *  \return Next data element stored in the buffer.\r
                 */\r
                 *\r
                 *  \return Next data element stored in the buffer.\r
                 */\r

-               static inline uint8_t RingBuffer_Remove(RingBuff_t* const Buffer)\r
+               static inline uint8_t RingBuffer_Remove(RingBuffer_t* Buffer) ATTR_NON_NULL_PTR_ARG(1);\r
+               static inline uint8_t RingBuffer_Remove(RingBuffer_t* Buffer)\r

                {\r
                {\r

+                       GCC_FORCE_POINTER_ACCESS(Buffer);\r
+               \r

                        uint8_t Data = *Buffer->Out;\r
 \r
                        if (++Buffer->Out == Buffer->End)\r
                          Buffer->Out = Buffer->Start;\r
 \r
                        uint8_t Data = *Buffer->Out;\r
 \r
                        if (++Buffer->Out == Buffer->End)\r
                          Buffer->Out = Buffer->Start;\r
 \r

-                       ATOMIC_BLOCK(ATOMIC_RESTORESTATE)\r
-                       {\r
-                               Buffer->Count--;\r
-                       }\r
+                       uint_reg_t CurrentGlobalInt = GetGlobalInterruptMask();\r
+                       GlobalInterruptDisable();\r
+                       \r
+                       Buffer->Count--;\r
+\r
+                       SetGlobalInterruptMask(CurrentGlobalInt);\r

 \r
                        return Data;\r
                }\r
 \r
                        return Data;\r
                }\r


@@ -246,11 +286,17 @@
                 *\r
                 *  \return Next data element stored in the buffer.\r
                 */\r
                 *\r
                 *  \return Next data element stored in the buffer.\r
                 */\r

-               static inline uint8_t RingBuffer_Peek(RingBuff_t* const Buffer)\r
+               static inline uint8_t RingBuffer_Peek(RingBuffer_t* const Buffer) ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);\r
+               static inline uint8_t RingBuffer_Peek(RingBuffer_t* const Buffer)\r

                {\r
                        return *Buffer->Out;\r
                }\r
 \r
                {\r
                        return *Buffer->Out;\r
                }\r
 \r

+       /* Disable C linkage for C++ Compilers: */\r
+               #if defined(__cplusplus)\r
+                       }\r
+               #endif\r
+\r

 #endif\r
 \r
 /** @} */\r
 #endif\r
 \r
 /** @} */\r