mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-07-16 21:01:31 +00:00
Rename RingBuffer header functions and typedefs from RingBuff_* to RingBuffer_* so that it matches the header name.
This commit is contained in:
parent
cb9ef559a0
commit
64fe1cd0b2
@ -62,7 +62,7 @@
|
|||||||
*
|
*
|
||||||
* \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
|
||||||
@ -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;
|
||||||
}
|
}
|
||||||
|
@ -37,7 +37,7 @@
|
|||||||
#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];
|
||||||
|
@ -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];
|
||||||
|
@ -64,13 +64,13 @@ 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];
|
||||||
|
@ -78,8 +78,8 @@
|
|||||||
|
|
||||||
/* 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);
|
||||||
|
Loading…
Reference in New Issue
Block a user