PDMCC26XX_Params Struct Reference

PDMCC26XX Parameters are used to with the PDMCC26XX_open() call. Default values for these parameters are set using PDMCC26XX_Params_init(). More...

#include <PDMCC26XX.h>

Collaboration diagram for PDMCC26XX_Params:

Data Fields
bool	useDefaultFilter
bool	micPowerActiveHigh
bool	applyCompression
uint8_t	pdmBufferQueueDepth
uint16_t	retBufSizeInBytes
int32_t *	decimationFilter
uint32_t	startupDelayWithClockInSamples
PDMCC26XX_CallbackFxn	callbackFxn
PDMCC26XX_Gain	micGain
PDMCC26XX_MallocFxn	mallocFxn
PDMCC26XX_FreeFxn	freeFxn
uintptr_t	custom

Detailed Description

PDMCC26XX Parameters are used to with the PDMCC26XX_open() call. Default values for these parameters are set using PDMCC26XX_Params_init().

See also

PDMCC26XX_Params_init

Field Documentation

bool PDMCC26XX_Params::useDefaultFilter

Set to TRUE to apply default filter. Set to FALSE to apply PDMCC26XX_Params::decimationFilter.

bool PDMCC26XX_Params::micPowerActiveHigh

Set to TRUE if setting the GPIO high powers the microphone

bool PDMCC26XX_Params::applyCompression

Set to TRUE to apply compression. Setting it to FALSE allows user to apply own compression scheme.

uint8_t PDMCC26XX_Params::pdmBufferQueueDepth

uint16_t PDMCC26XX_Params::retBufSizeInBytes

PDM buffer queue depth in number of blocks. We assume that we will be able to consume approximately one buffer per 2ms. This allows us to use the minium number of blocks (3) for the PDMCC26XX driver. If the application can not service the PDM task within the 2ms time window, increase this value to permit more latency in processing incoming PDM data at the cost of increased RAM useage.Size of returned buffers. It is not reccomended to make this value less than 64, the driver will not crash, but the equence numbers may become unaligned with the data in the buffer.

int32_t* PDMCC26XX_Params::decimationFilter

Filter that is applied if PDMCC26XX_Params::useDefaultFilter is set to FALSE

uint32_t PDMCC26XX_Params::startupDelayWithClockInSamples

Some digital microphones have a startup delay. Set the number of samples to discard after powering the microphone starting to clock in data.

PDMCC26XX_CallbackFxn PDMCC26XX_Params::callbackFxn

Callback function pointer

PDMCC26XX_Gain PDMCC26XX_Params::micGain

Microphone gain

PDMCC26XX_MallocFxn PDMCC26XX_Params::mallocFxn

Malloc function pointer

PDMCC26XX_FreeFxn PDMCC26XX_Params::freeFxn

Free function pointer

uintptr_t PDMCC26XX_Params::custom

Custom argument used by driver implementation

---

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

• PDMCC26XX.h