DMABuffer Class Reference

Public Member Functions
void	dump ()
	Dump the state of the buffer. More...
uint32_t	getData (uint8_t *pData, uint32_t length)
	Populate a buffer of data with the DMA data. More...
lldesc_t *	getDesc ()
	Get the underlying linked list descriptor. More...
uint32_t	getLength ()
	Get the number of populated bytes. More...
DMABuffer *	getNext ()
	Get the next DMA Buffer. More...
bool	isEoF ()
	Have we received all the data we expected? More...
void	setNext (DMABuffer *pNext)
	Set the next DMA buffer in the chain. More...

Detailed Description

A representation of a DMA buffer.

Member Function Documentation

void DMABuffer::dump

(

)

Dump the state of the buffer.

Returns

N/A

uint32_t DMABuffer::getData	(	uint8_t *	pData,
		uint32_t	length
	)

Populate a buffer of data with the DMA data.

Parameters

[in]	pData	A pointer to data to be populated with the DMA data.
[in]	length	The size in bytes of the pData buffer.

Returns

The number of bytes actually copied.

lldesc_t * DMABuffer::getDesc

(

)

Get the underlying linked list descriptor.

Returns

The underlying linked list descriptor.

uint32_t DMABuffer::getLength

(

)

Get the number of populated bytes.

Returns

The number of populated bytes.

DMABuffer * DMABuffer::getNext

(

)

Get the next DMA Buffer.

Returns

The next DMA Buffer;

bool DMABuffer::isEoF

(

)

Have we received all the data we expected?

Returns

True if we have received all the data we expected.

void DMABuffer::setNext

(

DMABuffer *

pNext

)

Set the next DMA buffer in the chain.

Parameters

[in]

pNext

The next DMA buffer in the chain.

---

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

• I2S.cpp