XCORE SDK
XCORE Software Development Kit
Public Attributes | List of all members
pdm_rx_resources_t Struct Reference

Collection of resources IDs required for PDM capture. More...

#include <pdm_resources.h>

Public Attributes

port_t p_mclk
 ID of the 1-bit port on which the master audio clock signal is received. More...
 
port_t p_pdm_clk
 ID of the 1-bit port through which the PDM sample clock is signaled. More...
 
port_t p_pdm_mics
 ID of the port on which PDM samples are received. More...
 
clock_t clock_a
 ID of the clock block used to derive the PDM clock from the master audio clock. More...
 
clock_t clock_b
 ID of the clock block used only in DDR configurations to trigger reads of the PDM data. More...
 

Detailed Description

Collection of resources IDs required for PDM capture.

This struct is a container for the IDs of the xCore hardware resources used by the mic array unit's PdmRx component for capturing PDM data from a port.

An object of this type will be used for initializing and starting the mic array unit.

Member Data Documentation

◆ clock_a

clock_t pdm_rx_resources_t::clock_a

ID of the clock block used to derive the PDM clock from the master audio clock.

In SDR configurations this is also the PDM data capture clock.

◆ clock_b

clock_t pdm_rx_resources_t::clock_b

ID of the clock block used only in DDR configurations to trigger reads of the PDM data.

If operating in an SDR configuration, clock_b must be 0. A value of 0 is what indicates an SDR configuration is being used.

◆ p_mclk

port_t pdm_rx_resources_t::p_mclk

ID of the 1-bit port on which the master audio clock signal is received.

The master audio clock will be divided to produce the PDM sample clock.

This port will be configured as an input.

◆ p_pdm_clk

port_t pdm_rx_resources_t::p_pdm_clk

ID of the 1-bit port through which the PDM sample clock is signaled.

The PDM sample clock is used by the PDM microphones to trigger sample conversion.

This port will be configured as an output.

◆ p_pdm_mics

port_t pdm_rx_resources_t::p_pdm_mics

ID of the port on which PDM samples are received.

In an SDR configuration, the number of microphone channels is the width of this port. In a DDR configuration, the number of microphone channels is twice the width of this port.

This port will be configured as an input.


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