_doxygen/html/pdm__resources_8h_source.html

 // Copyright 2021-2022 XMOS LIMITED.

 // This Software is subject to the terms of the XMOS Public Licence: Version 1.

 #pragma once


 #include "api.h"

 #include "etc/xcore_compat.h"


 #include "xs3_math.h"


 #include <stdint.h>


 C_API_START


 MA_C_API

 typedef struct {


   port_t p_mclk;


   port_t p_pdm_clk;


   port_t p_pdm_mics;


   clock_t clock_a;


   clock_t clock_b;

 } pdm_rx_resources_t;


 #define PDM_RX_RESOURCES_SDR(P_MCLK, P_PDM_CLK, P_PDM_MICS, CLOCK_A)    \

     { (port_t) (P_MCLK), (port_t) (P_PDM_CLK), (port_t) (P_PDM_MICS),   \

       (clock_t) (CLOCK_A) }


 #define PDM_RX_RESOURCES_DDR(P_MCLK, P_PDM_CLK, P_PDM_MICS, CLOCK_A, CLOCK_B) \

     { (port_t) (P_MCLK), (port_t) (P_PDM_CLK), (port_t) (P_PDM_MICS),         \

       (clock_t) (CLOCK_A), (clock_t) (CLOCK_B) }


 C_API_END

pdm_rx_resources_t
Collection of resources IDs required for PDM capture.
Definition: pdm_resources.h:32

pdm_rx_resources_t::clock_a
clock_t clock_a
ID of the clock block used to derive the PDM clock from the master audio clock.
Definition: pdm_resources.h:71

pdm_rx_resources_t::p_pdm_mics
port_t p_pdm_mics
ID of the port on which PDM samples are received.
Definition: pdm_resources.h:63

pdm_rx_resources_t::clock_b
clock_t clock_b
ID of the clock block used only in DDR configurations to trigger reads of the PDM data.
Definition: pdm_resources.h:81

pdm_rx_resources_t::p_mclk
port_t p_mclk
ID of the 1-bit port on which the master audio clock signal is received.
Definition: pdm_resources.h:42

pdm_rx_resources_t::p_pdm_clk
port_t p_pdm_clk
ID of the 1-bit port through which the PDM sample clock is signaled.
Definition: pdm_resources.h:52