tUSBRingBufObject Struct Reference

#include <usblib.h>

Data Fields
uint32_t	ui32Size
	The ring buffer size. More...
volatile uint32_t	ui32WriteIndex
	The ring buffer write index. More...
volatile uint32_t	ui32ReadIndex
	The ring buffer read index. More...
uint8_t *	pui8Buf
	The ring buffer. More...

Detailed Description

The structure used for encapsulating all the items associated with a ring buffer.

Field Documentation

ui32Size

uint32_t tUSBRingBufObject::ui32Size

The ring buffer size.

Referenced by USBBufferInfoGet(), USBRingBufAdvanceWrite(), USBRingBufContigFree(), USBRingBufContigUsed(), USBRingBufFree(), USBRingBufFull(), USBRingBufInit(), USBRingBufSize(), and USBRingBufUsed().

ui32WriteIndex

volatile uint32_t tUSBRingBufObject::ui32WriteIndex

The ring buffer write index.

Referenced by USBBufferInfoGet(), USBRingBufAdvanceWrite(), USBRingBufContigFree(), USBRingBufContigUsed(), USBRingBufEmpty(), USBRingBufFlush(), USBRingBufFull(), USBRingBufInit(), USBRingBufUsed(), and USBRingBufWriteOne().

ui32ReadIndex

volatile uint32_t tUSBRingBufObject::ui32ReadIndex

The ring buffer read index.

Referenced by USBBufferInfoGet(), USBRingBufAdvanceWrite(), USBRingBufContigFree(), USBRingBufContigUsed(), USBRingBufEmpty(), USBRingBufFlush(), USBRingBufFull(), USBRingBufInit(), USBRingBufReadOne(), and USBRingBufUsed().

pui8Buf

uint8_t* tUSBRingBufObject::pui8Buf

The ring buffer.

Referenced by USBBufferInfoGet(), USBRingBufInit(), USBRingBufReadOne(), and USBRingBufWriteOne().

---

The documentation for this struct was generated from the following file:

• usblib.h