X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/a49b5bfd8a1dce6276ff5dac1bddfe43d6ad73ab..039a714ee46268c07928c79b30403f29d4040fe8:/LUFA/Drivers/Misc/RingBuffer.h diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h index d9d3a8340..37e8a1ba5 100644 --- a/LUFA/Drivers/Misc/RingBuffer.h +++ b/LUFA/Drivers/Misc/RingBuffer.h @@ -35,9 +35,9 @@ * different sizes to suit different needs. * * Note that for each buffer, insertion and removal operations may occur at the same time (via - * a multithreaded ISR based system) however the same kind of operation (two or more insertions + * a multi-threaded ISR based system) however the same kind of operation (two or more insertions * or deletions) must not overlap. If there is possibility of two or more of the same kind of - * operating occuring at the same point in time, atomic (mutex) locking should be used. + * operating occurring at the same point in time, atomic (mutex) locking should be used. */ /** \ingroup Group_MiscDrivers @@ -52,9 +52,9 @@ * different sizes to suit different needs. * * Note that for each buffer, insertion and removal operations may occur at the same time (via - * a multithreaded ISR based system) however the same kind of operation (two or more insertions + * a multi-threaded ISR based system) however the same kind of operation (two or more insertions * or deletions) must not overlap. If there is possibility of two or more of the same kind of - * operating occuring at the same point in time, atomic (mutex) locking should be used. + * operating occurring at the same point in time, atomic (mutex) locking should be used. * * \section Sec_ExampleUsage Example Usage * The following snippet is an example of how this module may be used within a typical @@ -126,10 +126,10 @@ */ static inline void RingBuffer_InitBuffer(RingBuffer_t* Buffer, uint8_t* const DataPtr, const uint16_t Size) { + GCC_FORCE_POINTER_ACCESS(Buffer); + ATOMIC_BLOCK(ATOMIC_RESTORESTATE) - { - GCC_FORCE_POINTER_ACCESS(Buffer); - + { Buffer->In = DataPtr; Buffer->Out = DataPtr; Buffer->Start = &DataPtr[0]; @@ -170,7 +170,7 @@ * * \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. + * \return Boolean \c true if the buffer contains no free space, false otherwise. */ static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) { @@ -187,7 +187,7 @@ * * \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. + * \return Boolean \c true if the buffer contains no free space, false otherwise. */ static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) { @@ -203,9 +203,11 @@ * \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(RingBuffer_t* const Buffer, + static inline void RingBuffer_Insert(RingBuffer_t* Buffer, const uint8_t Data) { + GCC_FORCE_POINTER_ACCESS(Buffer); + *Buffer->In = Data; if (++Buffer->In == Buffer->End) @@ -227,8 +229,10 @@ * * \return Next data element stored in the buffer. */ - static inline uint8_t RingBuffer_Remove(RingBuffer_t* const Buffer) + static inline uint8_t RingBuffer_Remove(RingBuffer_t* Buffer) { + GCC_FORCE_POINTER_ACCESS(Buffer); + uint8_t Data = *Buffer->Out; if (++Buffer->Out == Buffer->End)