PDMCC26XX_BufferRequest Struct Reference

A PDMCC26XX_BufferRequest data structure is used with PDMCC26XX_requestBuffer(). More...

#include <PDMCC26XX.h>

Collaboration diagram for PDMCC26XX_BufferRequest:

Data Fields
PDMCC26XX_pcmBuffer *	buffer
PDMCC26XX_Status	status

Detailed Description

A PDMCC26XX_BufferRequest data structure is used with PDMCC26XX_requestBuffer().

buffer is a pointer to the requested buffer. It is NULL if no buffer is available. Each buffer contains a metadata header of size PCM_METADATA_SIZE. The first byte of the metadata is always an 8 bit sequence number. The other bytes depends on mode.

Mode	Interpretation of bufferIn being NULL after returning
Blocking mode	Request timed out and still no buffer available
Non-Blocking mode	No buffer available

Field Documentation

buffer

PDMCC26XX_pcmBuffer* PDMCC26XX_BufferRequest::buffer

Pointer to requested buffer. Note that this includes PCM_METADATA_SIZE bytes of metadata as a header

status

PDMCC26XX_Status PDMCC26XX_BufferRequest::status

Status code set by PDMCC26XX_requestBuffer

---

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

• PDMCC26XX.h