X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/0bcc82ac28ef9461f04e47f0b0885ee156d926f9..9597b33c3320969b8ca53aff0b1b38ee1fa24949:/Projects/USBtoSerial/Lib/LightweightRingBuff.h

diff --git a/Projects/USBtoSerial/Lib/LightweightRingBuff.h b/Projects/USBtoSerial/Lib/LightweightRingBuff.h
index 9c25707b4..2faef4382 100644
--- a/Projects/USBtoSerial/Lib/LightweightRingBuff.h
+++ b/Projects/USBtoSerial/Lib/LightweightRingBuff.h
@@ -62,7 +62,7 @@
 		} RingBuff_t;
 	
 	/* Inline Functions: */
-		/** Initializes a ring buffer ready for use. Buffers must be initialized via this function
+		/** Initialises 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.
 		 *
@@ -75,12 +75,33 @@
 			Buffer->Count = 0;
 		}
 		
+		/** Atomically determines if the specified ring buffer contains any free space. This should
+		 *  be tested before storing data to the buffer, to ensure that no data is lost due to a
+		 *  buffer overrun.
+		 *
+		 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into
+		 *
+		 *  \return Boolean true if the buffer contains no free space, false otherwise
+		 */		 
+		static inline bool RingBuffer_IsFull(RingBuff_t* const Buffer)
+		{
+			bool IsFull;
+			
+			ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
+			{
+				IsFull = (Buffer->Count == BUFFER_SIZE);
+			}
+			
+			return IsFull;
+		}
+		
 		/** Atomically inserts an element into the ring buffer.
 		 *
 		 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into
 		 *  \param[in]     Data    Data element to insert into the buffer
 		 */
-		static inline void RingBuffer_AtomicInsert(RingBuff_t* const Buffer, RingBuff_Data_t Data)
+		static inline void RingBuffer_AtomicInsert(RingBuff_t* const Buffer,
+		                                           const RingBuff_Data_t Data)
 		{
 			ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
 			{
@@ -121,7 +142,8 @@
 		 *  \param[in,out] Buffer  Pointer to a ring buffer structure to insert into
 		 *  \param[in]     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,
+		                                     const RingBuff_Data_t Data)
 		{
 			*Buffer->In = Data;
 			
@@ -150,4 +172,4 @@
 		}
 
 #endif
- 
\ No newline at end of file
+