X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/c05e7cd7d9ec8cb593e837ba9928a02c3449e55f..039a714ee46268c07928c79b30403f29d4040fe8:/LUFA/Drivers/Misc/RingBuffer.h diff --git a/LUFA/Drivers/Misc/RingBuffer.h b/LUFA/Drivers/Misc/RingBuffer.h index ea2d7c074..37e8a1ba5 100644 --- a/LUFA/Drivers/Misc/RingBuffer.h +++ b/LUFA/Drivers/Misc/RingBuffer.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2010. + Copyright (C) Dean Camera, 2011. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted @@ -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 @@ -62,8 +62,8 @@ * * \code * // Create the buffer structure and its underlying storage array - * RingBuff_t Buffer; - * uint8_t BufferData[128]; + * RingBuffer_t Buffer; + * uint8_t BufferData[128]; * * // Initialise the buffer with the created storage array * RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData)); @@ -100,7 +100,9 @@ #include /* Type Defines: */ - /** Type define for a new ring buffer object. Buffers should be initialized via a call to + /** \brief Ring Buffer Management Structure. + * + * Type define for a new ring buffer object. Buffers should be initialized via a call to * \ref RingBuffer_InitBuffer() before use. */ typedef struct @@ -111,7 +113,7 @@ uint8_t* End; /**< Pointer to the end of the buffer's underlying storage array */ uint8_t Size; /**< Size of the buffer's underlying storage array */ uint16_t Count; /**< Number of bytes currently stored in the buffer */ - } RingBuff_t; + } RingBuffer_t; /* Inline Functions: */ /** Initializes a ring buffer ready for use. Buffers must be initialized via this function @@ -122,12 +124,12 @@ * \param[out] DataPtr Pointer to a global array that will hold the data stored into the ring buffer. * \param[out] Size Maximum number of bytes that can be stored in the underlying data array. */ - static inline void RingBuffer_InitBuffer(RingBuff_t* Buffer, uint8_t* const DataPtr, const uint16_t Size) + 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]; @@ -150,7 +152,7 @@ * * \param[in] Buffer Pointer to a ring buffer structure whose count is to be computed. */ - static inline uint16_t RingBuffer_GetCount(RingBuff_t* const Buffer) + static inline uint16_t RingBuffer_GetCount(RingBuffer_t* const Buffer) { uint16_t Count; @@ -168,9 +170,9 @@ * * \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(RingBuff_t* const Buffer) + static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer) { return (RingBuffer_GetCount(Buffer) == Buffer->Size); } @@ -185,9 +187,9 @@ * * \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(RingBuff_t* const Buffer) + static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer) { return (RingBuffer_GetCount(Buffer) == 0); } @@ -201,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(RingBuff_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) @@ -225,8 +229,10 @@ * * \return Next data element stored in the buffer. */ - static inline uint8_t RingBuffer_Remove(RingBuff_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) @@ -246,7 +252,7 @@ * * \return Next data element stored in the buffer. */ - static inline uint8_t RingBuffer_Peek(RingBuff_t* const Buffer) + static inline uint8_t RingBuffer_Peek(RingBuffer_t* const Buffer) { return *Buffer->Out; }