PSOC E8XXGP Device Support Library

| PSOC E8XXGP Device Support Library

Enumerations
Enumerated Types
PDL API Reference » PDM_PCM_v2 (PDM-PCM Converter)

## General Description

## Enumerations
enum | cy_en_pdm_pcm_word_size_t { CY_PDM_PCM_WSIZE_8_BIT = 0U , CY_PDM_PCM_WSIZE_10_BIT = 1U , CY_PDM_PCM_WSIZE_12_BIT = 2U , CY_PDM_PCM_WSIZE_14_BIT = 3U , CY_PDM_PCM_WSIZE_16_BIT = 4U , CY_PDM_PCM_WSIZE_18_BIT = 5U , CY_PDM_PCM_WSIZE_20_BIT = 6U , CY_PDM_PCM_WSIZE_24_BIT = 7U , CY_PDM_PCM_WSIZE_32_BIT = 8U }
| PDM Word Length. More...
enum | cy_en_pdm_pcm_clock_sel_t { CY_PDM_PCM_SEL_SRSS_CLOCK = 0U , CY_PDM_PCM_SEL_PDM_DATA0 = 1U , CY_PDM_PCM_SEL_PDM_DATA1 = 2U , CY_PDM_PCM_SEL_OFF = 3U }
| cy_en_pdm_pcm_clock_sel_t More...
enum | cy_en_pdm_pcm_halve_rate_sel_t { CY_PDM_PCM_RATE_FULL = 0U , CY_PDM_PCM_RATE_HALVE = 1U }
| PDM Halve Rate Sampling. More...
enum | cy_en_pdm_pcm_ch_cic_decimcode_t { CY_PDM_PCM_CHAN_CIC_DECIM_2 = 0U , CY_PDM_PCM_CHAN_CIC_DECIM_4 = 1U , CY_PDM_PCM_CHAN_CIC_DECIM_8 = 2U , CY_PDM_PCM_CHAN_CIC_DECIM_16 = 3U , CY_PDM_PCM_CHAN_CIC_DECIM_32 = 4U }
| CIC DECIMATION CODE. More...
enum | cy_en_pdm_pcm_ch_fir0_decimcode_t { CY_PDM_PCM_CHAN_FIR0_DECIM_1 = 0U , CY_PDM_PCM_CHAN_FIR0_DECIM_2 = 1U , CY_PDM_PCM_CHAN_FIR0_DECIM_3 = 2U , CY_PDM_PCM_CHAN_FIR0_DECIM_4 = 3U , CY_PDM_PCM_CHAN_FIR0_DECIM_5 = 4U }
| FIR0 DECIMATION CODE. More...
enum | cy_en_pdm_pcm_ch_fir1_decimcode_t { CY_PDM_PCM_CHAN_FIR1_DECIM_1 = 0U , CY_PDM_PCM_CHAN_FIR1_DECIM_2 = 1U , CY_PDM_PCM_CHAN_FIR1_DECIM_3 = 2U , CY_PDM_PCM_CHAN_FIR1_DECIM_4 = 3U }
| FIR1 DECIMATION CODE. More...
enum | cy_en_pdm_pcm_ch_dcblock_coef_t { CY_PDM_PCM_CHAN_DCBLOCK_CODE_1 = 0U , CY_PDM_PCM_CHAN_DCBLOCK_CODE_2 = 1U , CY_PDM_PCM_CHAN_DCBLOCK_CODE_4 = 2U , CY_PDM_PCM_CHAN_DCBLOCK_CODE_8 = 3U , CY_PDM_PCM_CHAN_DCBLOCK_CODE_16 = 4U , CY_PDM_PCM_CHAN_DCBLOCK_CODE_32 = 5U , CY_PDM_PCM_CHAN_DCBLOCK_CODE_64 = 6U , CY_PDM_PCM_CHAN_DCBLOCK_CODE_128 = 7U }
| DC Block CODE. More...
enum | cy_en_pdm_pcm_gain_sel_t { CY_PDM_PCM_SEL_GAIN_83DB = 0U , CY_PDM_PCM_SEL_GAIN_77DB = 1U , CY_PDM_PCM_SEL_GAIN_71DB = 2U , CY_PDM_PCM_SEL_GAIN_65DB = 3U , CY_PDM_PCM_SEL_GAIN_59DB = 4U , CY_PDM_PCM_SEL_GAIN_53DB = 5U , CY_PDM_PCM_SEL_GAIN_47DB = 6U , CY_PDM_PCM_SEL_GAIN_41DB = 7U , CY_PDM_PCM_SEL_GAIN_35DB = 8U , CY_PDM_PCM_SEL_GAIN_29DB = 9U , CY_PDM_PCM_SEL_GAIN_23DB = 10U , CY_PDM_PCM_SEL_GAIN_17DB = 11U , CY_PDM_PCM_SEL_GAIN_11DB = 12U , CY_PDM_PCM_SEL_GAIN_5DB = 13U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_1DB = 14U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_7DB = 15U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_13DB = 16U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_19DB = 17U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_25DB = 18U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_31DB = 19U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_37DB = 20U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_43DB = 21U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_49DB = 22U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_55DB = 23U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_61DB = 24U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_67DB = 25U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_73DB = 26U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_79DB = 27U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_85DB = 28U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_91DB = 29U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_97DB = 30U , CY_PDM_PCM_SEL_GAIN_NEGATIVE_103DB = 31U }
| PDM Gain Enums. More...
enum | cy_en_pdm_pcm_status_t { CY_PDM_PCM_SUCCESS = 0x00UL , CY_PDM_PCM_BAD_PARAM = CY_PDM_PCM_V2_ID | CY_PDL_STATUS_ERROR |0x01UL }
| The PDM-PCM status codes. More...
enum | cy_en_pdm_pcm_format_t { CY_PDM_PCM_16BIT = 0U , CY_PDM_PCM_24BIT = 1U }
| The PCM bit size.

## Enumeration Type Documentation

## ◆ cy_en_pdm_pcm_word_size_t

enum cy_en_pdm_pcm_word_size_t

PDM Word Length.

Enumerator
CY_PDM_PCM_WSIZE_8_BIT | Word length: 8 bit.
CY_PDM_PCM_WSIZE_10_BIT | Word length: 10 bit.
CY_PDM_PCM_WSIZE_12_BIT | Word length: 12 bit.
CY_PDM_PCM_WSIZE_14_BIT | Word length: 14 bit.
CY_PDM_PCM_WSIZE_16_BIT | Word length: 16 bit.
CY_PDM_PCM_WSIZE_18_BIT | Word length: 18 bit.
CY_PDM_PCM_WSIZE_20_BIT | Word length: 20 bit.
CY_PDM_PCM_WSIZE_24_BIT | Word length: 24 bit.
CY_PDM_PCM_WSIZE_32_BIT | Word length: 32 bit.

## ◆ cy_en_pdm_pcm_clock_sel_t

enum cy_en_pdm_pcm_clock_sel_t

cy_en_pdm_pcm_clock_sel_t

Enumerator
CY_PDM_PCM_SEL_SRSS_CLOCK | Interface clock is selected as clk_if_srss[0].
CY_PDM_PCM_SEL_PDM_DATA0 | Interface clock is selected as pdm_data[0].
CY_PDM_PCM_SEL_PDM_DATA1 | Interface clock is selected as pdm_data[1].
CY_PDM_PCM_SEL_OFF | Interface clock clk_if is off.

## ◆ cy_en_pdm_pcm_halve_rate_sel_t

enum cy_en_pdm_pcm_halve_rate_sel_t

PDM Halve Rate Sampling.

Enumerator
CY_PDM_PCM_RATE_FULL | Channel full.
CY_PDM_PCM_RATE_HALVE | Channel halve.

## ◆ cy_en_pdm_pcm_ch_cic_decimcode_t

enum cy_en_pdm_pcm_ch_cic_decimcode_t

CIC DECIMATION CODE.

Enumerator
CY_PDM_PCM_CHAN_CIC_DECIM_2 | CIC Filter PCM Frequency is 1/2 * PDM Frequency.
CY_PDM_PCM_CHAN_CIC_DECIM_4 | CIC Filter PCM Frequency is 1/4 * PDM Frequency.
CY_PDM_PCM_CHAN_CIC_DECIM_8 | CIC Filter PCM Frequency is 1/8 * PDM Frequency.
CY_PDM_PCM_CHAN_CIC_DECIM_16 | CIC Filter PCM Frequency is 1/16 * PDM Frequency.
CY_PDM_PCM_CHAN_CIC_DECIM_32 | CIC Filter PCM Frequency is 1/32 * PDM Frequency.

## ◆ cy_en_pdm_pcm_ch_fir0_decimcode_t

enum cy_en_pdm_pcm_ch_fir0_decimcode_t

FIR0 DECIMATION CODE.

Enumerator
CY_PDM_PCM_CHAN_FIR0_DECIM_1 | FIR0 Filter PCM Frequency is 1/1 * PCM Frequency.
CY_PDM_PCM_CHAN_FIR0_DECIM_2 | FIR0 Filter PCM Frequency is 1/2 * PCM Frequency.
CY_PDM_PCM_CHAN_FIR0_DECIM_3 | FIR0 Filter PCM Frequency is 1/3 * PCM Frequency.
CY_PDM_PCM_CHAN_FIR0_DECIM_4 | FIR0 Filter PCM Frequency is 1/4 * PCM Frequency.
CY_PDM_PCM_CHAN_FIR0_DECIM_5 | FIR0 Filter PCM Frequency is 1/5 * PCM Frequency.

## ◆ cy_en_pdm_pcm_ch_fir1_decimcode_t

enum cy_en_pdm_pcm_ch_fir1_decimcode_t

FIR1 DECIMATION CODE.

Enumerator
CY_PDM_PCM_CHAN_FIR1_DECIM_1 | FIR1 Filter PCM Frequency is 1/1 * PCM Frequency.
CY_PDM_PCM_CHAN_FIR1_DECIM_2 | FIR1 Filter PCM Frequency is 1/2 * PCM Frequency.
CY_PDM_PCM_CHAN_FIR1_DECIM_3 | FIR1 Filter PCM Frequency is 1/3 * PCM Frequency.
CY_PDM_PCM_CHAN_FIR1_DECIM_4 | FIR1 Filter PCM Frequency is 1/4 * PCM Frequency.

## ◆ cy_en_pdm_pcm_ch_dcblock_coef_t

enum cy_en_pdm_pcm_ch_dcblock_coef_t

DC Block CODE.

Enumerator
CY_PDM_PCM_CHAN_DCBLOCK_CODE_1 | DCBLOCK Filter alpha = 1 - (1/2^(12-0))
CY_PDM_PCM_CHAN_DCBLOCK_CODE_2 | DCBLOCK Filter alpha = 1 - (1/2^(12-1))
CY_PDM_PCM_CHAN_DCBLOCK_CODE_4 | DCBLOCK Filter alpha = 1 - (1/2^(12-2))
CY_PDM_PCM_CHAN_DCBLOCK_CODE_8 | DCBLOCK Filter alpha = 1 - (1/2^(12-3))
CY_PDM_PCM_CHAN_DCBLOCK_CODE_16 | DCBLOCK Filter alpha = 1 - (1/2^(12-4))
CY_PDM_PCM_CHAN_DCBLOCK_CODE_32 | DCBLOCK Filter alpha = 1 - (1/2^(12-5))
CY_PDM_PCM_CHAN_DCBLOCK_CODE_64 | DCBLOCK Filter alpha = 1 - (1/2^(12-6))
CY_PDM_PCM_CHAN_DCBLOCK_CODE_128 | DCBLOCK Filter alpha = 1 - (1/2^(12-7))

## ◆ cy_en_pdm_pcm_gain_sel_t

enum cy_en_pdm_pcm_gain_sel_t

PDM Gain Enums.

Enumerator
CY_PDM_PCM_SEL_GAIN_83DB | Gain of 83db corresponding to scale 0.
CY_PDM_PCM_SEL_GAIN_77DB | Gain of 77db corresponding to scale 1.
CY_PDM_PCM_SEL_GAIN_71DB | Gain of 71db corresponding to scale 2.
CY_PDM_PCM_SEL_GAIN_65DB | Gain of 65db corresponding to scale 3.
CY_PDM_PCM_SEL_GAIN_59DB | Gain of 59db corresponding to scale 4.
CY_PDM_PCM_SEL_GAIN_53DB | Gain of 53db corresponding to scale 5.
CY_PDM_PCM_SEL_GAIN_47DB | Gain of 47db corresponding to scale 6.
CY_PDM_PCM_SEL_GAIN_41DB | Gain of 41db corresponding to scale 7.
CY_PDM_PCM_SEL_GAIN_35DB | Gain of 35db corresponding to scale 8.
CY_PDM_PCM_SEL_GAIN_29DB | Gain of 29db corresponding to scale 9.
CY_PDM_PCM_SEL_GAIN_23DB | Gain of 23db corresponding to scale 10.
CY_PDM_PCM_SEL_GAIN_17DB | Gain of 17db corresponding to scale 11.
CY_PDM_PCM_SEL_GAIN_11DB | Gain of 11db corresponding to scale 12.
CY_PDM_PCM_SEL_GAIN_5DB | Gain of 5db corresponding to scale 13.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_1DB | Gain of -1db corresponding to scale 14.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_7DB | Gain of -7db corresponding to scale 15.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_13DB | Gain of -13db corresponding to scale 16.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_19DB | Gain of -19db corresponding to scale 17.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_25DB | Gain of -25db corresponding to scale 18.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_31DB | Gain of -31db corresponding to scale 19.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_37DB | Gain of -37db corresponding to scale 20.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_43DB | Gain of -43db corresponding to scale 21.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_49DB | Gain of -49db corresponding to scale 22.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_55DB | Gain of -55db corresponding to scale 23.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_61DB | Gain of -61db corresponding to scale 24.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_67DB | Gain of -67db corresponding to scale 25.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_73DB | Gain of -73db corresponding to scale 26.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_79DB | Gain of -79db corresponding to scale 27.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_85DB | Gain of -85db corresponding to scale 28.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_91DB | Gain of -91db corresponding to scale 29.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_97DB | Gain of -97db corresponding to scale 30.
CY_PDM_PCM_SEL_GAIN_NEGATIVE_103DB | Gain of -103db corresponding to scale 31.

## ◆ cy_en_pdm_pcm_status_t

enum cy_en_pdm_pcm_status_t

The PDM-PCM status codes.

Enumerator
CY_PDM_PCM_SUCCESS | Success status code.
CY_PDM_PCM_BAD_PARAM | Bad parameter status code.