*\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
* // Initialise the buffer with the created storage array\r
* RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData));\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
+ } RingBuffer_t;\r
\r
/* Inline Functions: */\r
/** Initializes a ring buffer ready for use. Buffers must be initialized via this function\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
{\r
ATOMIC_BLOCK(ATOMIC_RESTORESTATE)\r
{\r
*\r
* \param[in] Buffer Pointer to a ring buffer structure whose count is to be computed.\r
*/\r
- static inline uint16_t RingBuffer_GetCount(RingBuff_t* const Buffer)\r
+ static inline uint16_t RingBuffer_GetCount(RingBuffer_t* const Buffer)\r
{\r
uint16_t Count;\r
\r
*\r
* \return Boolean true if the buffer contains no free space, false otherwise.\r
*/\r
- static inline bool RingBuffer_IsFull(RingBuff_t* const Buffer)\r
+ static inline bool RingBuffer_IsFull(RingBuffer_t* const Buffer)\r
{\r
return (RingBuffer_GetCount(Buffer) == Buffer->Size);\r
}\r
*\r
* \return Boolean true if the buffer contains no free space, false otherwise.\r
*/\r
- static inline bool RingBuffer_IsEmpty(RingBuff_t* const Buffer)\r
+ static inline bool RingBuffer_IsEmpty(RingBuffer_t* const Buffer)\r
{\r
return (RingBuffer_GetCount(Buffer) == 0);\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
+ static inline void RingBuffer_Insert(RingBuffer_t* const Buffer,\r
const uint8_t Data)\r
{\r
*Buffer->In = Data;\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* const Buffer)\r
{\r
uint8_t Data = *Buffer->Out;\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)\r
{\r
return *Buffer->Out;\r
}\r
#include "USBtoSerial.h"
/** Circular buffer to hold data from the host before it is sent to the device via the serial port. */
-RingBuff_t USBtoUSART_Buffer;
+RingBuffer_t USBtoUSART_Buffer;
/** Underlying data buffer for \ref USBtoUSART_Buffer, where the stored bytes are located. */
-uint8_t USBtoUSART_Buffer_Data[128];
+uint8_t USBtoUSART_Buffer_Data[128];
/** Circular buffer to hold data from the serial port before it is sent to the host. */
-RingBuff_t USARTtoUSB_Buffer;
+RingBuffer_t USARTtoUSB_Buffer;
/** Underlying data buffer for \ref USARTtoUSB_Buffer, where the stored bytes are located. */
uint8_t USARTtoUSB_Buffer_Data[128];
};
/** Circular buffer to hold data from the host before it is sent to the device via the serial port. */
-RingBuff_t USBtoUART_Buffer;
+RingBuffer_t USBtoUART_Buffer;
/** Underlying data buffer for \ref USBtoUART_Buffer, where the stored bytes are located. */
-uint8_t USBtoUART_Buffer_Data[128];
+uint8_t USBtoUART_Buffer_Data[128];
/** Circular buffer to hold data from the serial port before it is sent to the host. */
-RingBuff_t UARTtoUSB_Buffer;
+RingBuffer_t UARTtoUSB_Buffer;
/** Underlying data buffer for \ref UARTtoUSB_Buffer, where the stored bytes are located. */
-uint8_t UARTtoUSB_Buffer_Data[128];
+uint8_t UARTtoUSB_Buffer_Data[128];
/** Main program entry point. This routine contains the overall program flow, including initial
#define MODE_PDI_PROGRAMMER true
/* External Variables: */
- extern bool CurrentFirmwareMode;
- extern RingBuff_t UARTtoUSB_Buffer;
- extern RingBuff_t USBtoUART_Buffer;
+ extern bool CurrentFirmwareMode;
+ extern RingBuffer_t UARTtoUSB_Buffer;
+ extern RingBuffer_t USBtoUART_Buffer;
/* Function Prototypes: */
void SetupHardware(void);