forksand
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Rename RingBuffer header functions and typedefs from RingBuff_* to RingBuffer_* so that it matches the header name.

Browse Source
pull/1469/head
Dean Camera 14 years ago
parent cb9ef559a0
commit 64fe1cd0b2
5 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File

20
LUFA/Drivers/Misc/RingBuffer.h
Unescape View File

@ -62,8 +62,8 @@
* *
* \code * \code
* // Create the buffer structure and its underlying storage array * // Create the buffer structure and its underlying storage array
* RingBuff_t Buffer; * RingBuffer_t Buffer;
* uint8_t BufferData[128]; * uint8_t BufferData[128];
* *
* // Initialise the buffer with the created storage array * // Initialise the buffer with the created storage array
* RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData)); * RingBuffer_InitBuffer(&Buffer, BufferData, sizeof(BufferData));
@ -111,7 +111,7 @@
uint8_t* End; /**< Pointer to the end of the buffer's underlying storage array */ 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 */ uint8_t Size; /**< Size of the buffer's underlying storage array */
uint16_t Count; /**< Number of bytes currently stored in the buffer */ uint16_t Count; /**< Number of bytes currently stored in the buffer */
} RingBuff_t; } RingBuffer_t;
/* Inline Functions: */ /* Inline Functions: */
/** Initializes a ring buffer ready for use. Buffers must be initialized via this function /** Initializes a ring buffer ready for use. Buffers must be initialized via this function
@ -122,7 +122,7 @@
* \param[out] DataPtr Pointer to a global array that will hold the data stored into the ring buffer. * \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. * \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)
{ {
ATOMIC_BLOCK(ATOMIC_RESTORESTATE) ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
{ {
@ -150,7 +150,7 @@
* *
* \param[in] Buffer Pointer to a ring buffer structure whose count is to be computed. * \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; uint16_t Count;
@ -170,7 +170,7 @@
* *
* \return Boolean true if the buffer contains no free space, false otherwise. * \return Boolean 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); return (RingBuffer_GetCount(Buffer) == Buffer->Size);
} }
@ -187,7 +187,7 @@
* *
* \return Boolean true if the buffer contains no free space, false otherwise. * \return Boolean 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); return (RingBuffer_GetCount(Buffer) == 0);
} }
@ -201,7 +201,7 @@
* \param[in,out] Buffer Pointer to a ring buffer structure to insert into. * \param[in,out] Buffer Pointer to a ring buffer structure to insert into.
* \param[in] Data Data element to insert into the buffer. * \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* const Buffer,
const uint8_t Data) const uint8_t Data)
{ {
*Buffer->In = Data; *Buffer->In = Data;
@ -225,7 +225,7 @@
* *
* \return Next data element stored in the buffer. * \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* const Buffer)
{ {
uint8_t Data = *Buffer->Out; uint8_t Data = *Buffer->Out;
@ -246,7 +246,7 @@
* *
* \return Next data element stored in the buffer. * \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; return *Buffer->Out;
} }

4
Projects/Benito/Benito.c
Unescape View File

@ -37,10 +37,10 @@
#include "Benito.h" #include "Benito.h"
/** Circular buffer to hold data from the serial port before it is sent to the host. */ /** 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. */ /** Underlying data buffer for \ref USARTtoUSB_Buffer, where the stored bytes are located. */
uint8_t USARTtoUSB_Buffer_Data[128]; uint8_t USARTtoUSB_Buffer_Data[128];
/** Pulse generation counters to keep track of the number of milliseconds remaining for each pulse type */ /** Pulse generation counters to keep track of the number of milliseconds remaining for each pulse type */
volatile struct volatile struct

6
Projects/USBtoSerial/USBtoSerial.c
Unescape View File

@ -37,13 +37,13 @@
#include "USBtoSerial.h" #include "USBtoSerial.h"
/** Circular buffer to hold data from the host before it is sent to the device via the serial port. */ /** 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. */ /** 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. */ /** 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. */ /** Underlying data buffer for \ref USARTtoUSB_Buffer, where the stored bytes are located. */
uint8_t USARTtoUSB_Buffer_Data[128]; uint8_t USARTtoUSB_Buffer_Data[128];

8
Projects/XPLAINBridge/XPLAINBridge.c
Unescape View File

@ -64,16 +64,16 @@ USB_ClassInfo_CDC_Device_t VirtualSerial_CDC_Interface =
}; };
/** Circular buffer to hold data from the host before it is sent to the device via the serial port. */ /** 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. */ /** 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. */ /** 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. */ /** 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 /** Main program entry point. This routine contains the overall program flow, including initial

6
Projects/XPLAINBridge/XPLAINBridge.h
Unescape View File

@ -77,9 +77,9 @@
#define MODE_PDI_PROGRAMMER true #define MODE_PDI_PROGRAMMER true
/* External Variables: */ /* External Variables: */
extern bool CurrentFirmwareMode; extern bool CurrentFirmwareMode;
extern RingBuff_t UARTtoUSB_Buffer; extern RingBuffer_t UARTtoUSB_Buffer;
extern RingBuff_t USBtoUART_Buffer; extern RingBuffer_t USBtoUART_Buffer;
/* Function Prototypes: */ /* Function Prototypes: */
void SetupHardware(void); void SetupHardware(void);

Write Preview
Loading…
Cancel
Save