Initialization and Basic Functions

General Description

This set of functions is for initialization and basic usage.

Functions
cy_en_adcmic_status_t	Cy_ADCMic_Init (MXS40ADCMIC_Type *base, cy_stc_adcmic_config_t const *config, cy_en_adcmic_mode_t mode)
	Initializes the ADCMic block from a pre-initialized configuration structure. More...
void	Cy_ADCMic_InitBiquad (MXS40ADCMIC_Type *base, cy_stc_adcmic_biquad_config_t const *biQuadConfig)
	Initializes the biquad filter coefficients. More...
__STATIC_INLINE void	Cy_ADCMic_BiquadBypass (MXS40ADCMIC_Type *base, bool bypass)
	Bypasses/unbypasses the biquad filter. More...
void	Cy_ADCMic_Enable (MXS40ADCMIC_Type *base)
	Enables the ADCMic block operation. More...
void	Cy_ADCMic_Disable (MXS40ADCMIC_Type *base)
	Disables the ADCMic block operation. More...
cy_en_adcmic_status_t	Cy_ADCMic_SetSampleRate (MXS40ADCMIC_Type *base, cy_en_adcmic_sample_rate_t sampleRate)
	Sets the specified ADC sample rate. More...
__STATIC_INLINE void	Cy_ADCMic_ClearTrigger (MXS40ADCMIC_Type *base, uint32_t trigMask)
	Clears the specified trigger signal. More...

Function Documentation

Cy_ADCMic_Init()

cy_en_adcmic_status_t Cy_ADCMic_Init	(	MXS40ADCMIC_Type *	base,
		cy_stc_adcmic_config_t const *	config,
		cy_en_adcmic_mode_t	mode
	)

Initializes the ADCMic block from a pre-initialized configuration structure.

Parameters

base	The pointer to the hardware ADCMic block.
config	The pointer to the configuration structure cy_stc_adcmic_config_t.
mode	The ADCMic operation mode /ref cy_en_adcmic_mode_t.

Returns

The status cy_en_adcmic_status_t.

Function Usage

    /* Scenario: Initialize ADCMic for the analog microphone operation: */
    if (CY_ADCMIC_SUCCESS != Cy_ADCMic_Init(MXS40ADCMIC0, &config, CY_ADCMIC_MIC))
    {
        /* Something went wrong, insert error handling here */
    }

    if (CY_ADCMIC_SUCCESS != Cy_ADCMic_SetSampleRate(MXS40ADCMIC0, CY_ADCMIC_16KSPS))
    {
        /* Something went wrong, insert error handling here */
    }

    Cy_ADCMic_Enable(MXS40ADCMIC0); /* Enable the block operation */

Cy_ADCMic_InitBiquad()

void Cy_ADCMic_InitBiquad	(	MXS40ADCMIC_Type *	base,
		cy_stc_adcmic_biquad_config_t const *	biQuadConfig
	)

Initializes the biquad filter coefficients.

Usually is called from the Cy_ADCMic_Init.

Parameters

base	The pointer to the hardware ADCMic block.
biQuadConfig	The pointer to the biquad filter configuration structure cy_stc_adcmic_biquad_config_t.

Function Usage

    /* Scenario: Initialize entire ADCMic with biquad filter */
    config.micConfig->biQuadConfig = &biquadCfg;
    if (CY_ADCMIC_SUCCESS != Cy_ADCMic_Init(MXS40ADCMIC0, &config, CY_ADCMIC_MIC))
    {
        /* Something went wrong, insert error handling here */
    }

    /* or initialize the BiQuad filter separately */
    Cy_ADCMic_InitBiquad(MXS40ADCMIC0, &biquadCfg);
    Cy_ADCMic_BiquadBypass(MXS40ADCMIC0, false); /* Unbypass the biquad filter */

Cy_ADCMic_BiquadBypass()

__STATIC_INLINE void Cy_ADCMic_BiquadBypass	(	MXS40ADCMIC_Type *	base,
		bool	bypass
	)

Bypasses/unbypasses the biquad filter.

Usually is called from the Cy_ADCMic_Init.

Parameters

base	The pointer to the hardware ADCMic block.
bypass	The boolean specifier to bypass(true) or unbypass(false) the biquad filter.

Cy_ADCMic_Enable()

void Cy_ADCMic_Enable

(

MXS40ADCMIC_Type *

base

)

Enables the ADCMic block operation.

Parameters

base	The pointer to the hardware ADCMic block.

Function Usage

    /* Scenario: Initialize ADCMic for the analog microphone operation: */
    if (CY_ADCMIC_SUCCESS != Cy_ADCMic_Init(MXS40ADCMIC0, &config, CY_ADCMIC_MIC))
    {
        /* Something went wrong, insert error handling here */
    }

    if (CY_ADCMIC_SUCCESS != Cy_ADCMic_SetSampleRate(MXS40ADCMIC0, CY_ADCMIC_16KSPS))
    {
        /* Something went wrong, insert error handling here */
    }

    Cy_ADCMic_Enable(MXS40ADCMIC0); /* Enable the block operation */

Cy_ADCMic_Disable()

void Cy_ADCMic_Disable

(

MXS40ADCMIC_Type *

base

)

Disables the ADCMic block operation.

Parameters

base	The pointer to the hardware ADCMic block.

Function Usage

    /* Scenario: The ADCMic block is not needed more: */
    Cy_ADCMic_Disable(MXS40ADCMIC0); /* Disable the block operation */

Cy_ADCMic_SetSampleRate()

cy_en_adcmic_status_t Cy_ADCMic_SetSampleRate	(	MXS40ADCMIC_Type *	base,
		cy_en_adcmic_sample_rate_t	sampleRate
	)

Sets the specified ADC sample rate.

Applicable for MIC/PDM modes only.

Parameters

base	The pointer to the hardware ADCMic block.
sampleRate	The source value cy_en_adcmic_sample_rate_t.

Returns

The status cy_en_adcmic_status_t.

Function Usage

    /* Scenario: Initialize ADCMic for the analog microphone operation: */
    if (CY_ADCMIC_SUCCESS != Cy_ADCMic_Init(MXS40ADCMIC0, &config, CY_ADCMIC_MIC))
    {
        /* Something went wrong, insert error handling here */
    }

    if (CY_ADCMIC_SUCCESS != Cy_ADCMic_SetSampleRate(MXS40ADCMIC0, CY_ADCMIC_16KSPS))
    {
        /* Something went wrong, insert error handling here */
    }

    Cy_ADCMic_Enable(MXS40ADCMIC0); /* Enable the block operation */

Cy_ADCMic_ClearTrigger()

__STATIC_INLINE void Cy_ADCMic_ClearTrigger	(	MXS40ADCMIC_Type *	base,
		uint32_t	trigMask
	)

Clears the specified trigger signal.

Parameters

base	The pointer to the hardware ADC block.
trigMask	The mask of triggers to clear. Select one or more masks from Triggers and "OR" them together: CY_ADCMIC_TRIG_DC CY_ADCMIC_TRIG_DATA