nrfx 2.5
Macros | Typedefs | Enumerations | Functions
PDM HAL

Hardware access layer for managing the Pulse Density Modulation (PDM) peripheral. More...

Macros

#define NRF_PDM_HAS_MCLKCONFIG   1
 Symbol indicating whether master clock source configuration is available.
 
#define NRF_PDM_HAS_RATIO_CONFIG   1
 Symbol indicating whether ratio configuration is available.
 
#define NRF_PDM_GAIN_MINIMUM   0x00
 Minimum value of PDM gain.
 
#define NRF_PDM_GAIN_DEFAULT   0x28
 Default value of PDM gain.
 
#define NRF_PDM_GAIN_MAXIMUM   0x50
 Maximum value of PDM gain.
 

Typedefs

typedef uint8_t nrf_pdm_gain_t
 PDM gain type.
 

Enumerations

enum  nrf_pdm_task_t {
  NRF_PDM_TASK_START = offsetof(NRF_PDM_Type, TASKS_START),
  NRF_PDM_TASK_STOP = offsetof(NRF_PDM_Type, TASKS_STOP)
}
 PDM tasks. More...
 
enum  nrf_pdm_event_t {
  NRF_PDM_EVENT_STARTED = offsetof(NRF_PDM_Type, EVENTS_STARTED),
  NRF_PDM_EVENT_STOPPED = offsetof(NRF_PDM_Type, EVENTS_STOPPED),
  NRF_PDM_EVENT_END = offsetof(NRF_PDM_Type, EVENTS_END)
}
 PDM events. More...
 
enum  nrf_pdm_int_mask_t {
  NRF_PDM_INT_STARTED = PDM_INTENSET_STARTED_Msk,
  NRF_PDM_INT_STOPPED = PDM_INTENSET_STOPPED_Msk,
  NRF_PDM_INT_END = PDM_INTENSET_END_Msk
}
 PDM interrupt masks. More...
 
enum  nrf_pdm_freq_t {
  NRF_PDM_FREQ_1000K = PDM_PDMCLKCTRL_FREQ_1000K,
  NRF_PDM_FREQ_1032K = PDM_PDMCLKCTRL_FREQ_Default,
  NRF_PDM_FREQ_1067K = PDM_PDMCLKCTRL_FREQ_1067K,
  NRF_PDM_FREQ_1231K = PDM_PDMCLKCTRL_FREQ_1231K,
  NRF_PDM_FREQ_1280K = PDM_PDMCLKCTRL_FREQ_1280K,
  NRF_PDM_FREQ_1333K = PDM_PDMCLKCTRL_FREQ_1333K
}
 PDM clock frequency. More...
 
enum  nrf_pdm_ratio_t {
  NRF_PDM_RATIO_64X = PDM_RATIO_RATIO_Ratio64,
  NRF_PDM_RATIO_80X = PDM_RATIO_RATIO_Ratio80
}
 PDM ratio between PDM_CLK and output sample rate. More...
 
enum  nrf_pdm_mode_t {
  NRF_PDM_MODE_STEREO = PDM_MODE_OPERATION_Stereo,
  NRF_PDM_MODE_MONO = PDM_MODE_OPERATION_Mono
}
 PDM operation mode. More...
 
enum  nrf_pdm_edge_t {
  NRF_PDM_EDGE_LEFTFALLING = PDM_MODE_EDGE_LeftFalling,
  NRF_PDM_EDGE_LEFTRISING = PDM_MODE_EDGE_LeftRising
}
 PDM sampling mode. More...
 
enum  nrf_pdm_mclksrc_t {
  NRF_PDM_MCLKSRC_PCLK32M = PDM_MCLKCONFIG_SRC_PCLK32M,
  NRF_PDM_MCLKSRC_ACLK = PDM_MCLKCONFIG_SRC_ACLK
}
 PDM master clock source selection. More...
 

Functions

NRF_STATIC_INLINE void nrf_pdm_task_trigger (NRF_PDM_Type *p_reg, nrf_pdm_task_t task)
 Function for triggering a PDM task. More...
 
NRF_STATIC_INLINE uint32_t nrf_pdm_task_address_get (NRF_PDM_Type const *p_reg, nrf_pdm_task_t task)
 Function for getting the address of a PDM task register. More...
 
NRF_STATIC_INLINE bool nrf_pdm_event_check (NRF_PDM_Type const *p_reg, nrf_pdm_event_t event)
 Function for retrieving the state of the PDM event. More...
 
NRF_STATIC_INLINE void nrf_pdm_event_clear (NRF_PDM_Type *p_reg, nrf_pdm_event_t event)
 Function for clearing a PDM event. More...
 
NRF_STATIC_INLINE uint32_t nrf_pdm_event_address_get (NRF_PDM_Type const *p_reg, nrf_pdm_event_t event)
 Function for getting the address of a PDM event register. More...
 
NRF_STATIC_INLINE void nrf_pdm_int_enable (NRF_PDM_Type *p_reg, uint32_t mask)
 Function for enabling PDM interrupts. More...
 
NRF_STATIC_INLINE uint32_t nrf_pdm_int_enable_check (NRF_PDM_Type const *p_reg, uint32_t mask)
 Function for checking if the specified interrupts are enabled. More...
 
NRF_STATIC_INLINE void nrf_pdm_int_disable (NRF_PDM_Type *p_reg, uint32_t mask)
 Function for disabling interrupts. More...
 
NRF_STATIC_INLINE void nrf_pdm_subscribe_set (NRF_PDM_Type *p_reg, nrf_pdm_task_t task, uint8_t channel)
 Function for setting the subscribe configuration for a given PDM task. More...
 
NRF_STATIC_INLINE void nrf_pdm_subscribe_clear (NRF_PDM_Type *p_reg, nrf_pdm_task_t task)
 Function for clearing the subscribe configuration for a given PDM task. More...
 
NRF_STATIC_INLINE void nrf_pdm_publish_set (NRF_PDM_Type *p_reg, nrf_pdm_event_t event, uint8_t channel)
 Function for setting the publish configuration for a given PDM event. More...
 
NRF_STATIC_INLINE void nrf_pdm_publish_clear (NRF_PDM_Type *p_reg, nrf_pdm_event_t event)
 Function for clearing the publish configuration for a given PDM event. More...
 
NRF_STATIC_INLINE void nrf_pdm_enable (NRF_PDM_Type *p_reg)
 Function for enabling the PDM peripheral. More...
 
NRF_STATIC_INLINE void nrf_pdm_disable (NRF_PDM_Type *p_reg)
 Function for disabling the PDM peripheral. More...
 
NRF_STATIC_INLINE bool nrf_pdm_enable_check (NRF_PDM_Type const *p_reg)
 Function for checking if the PDM peripheral is enabled. More...
 
NRF_STATIC_INLINE void nrf_pdm_mode_set (NRF_PDM_Type *p_reg, nrf_pdm_mode_t pdm_mode, nrf_pdm_edge_t pdm_edge)
 Function for setting the PDM operation mode. More...
 
NRF_STATIC_INLINE void nrf_pdm_mode_get (NRF_PDM_Type const *p_reg, nrf_pdm_mode_t *p_pdm_mode, nrf_pdm_edge_t *p_pdm_edge)
 Function for getting the PDM operation mode. More...
 
NRF_STATIC_INLINE void nrf_pdm_clock_set (NRF_PDM_Type *p_reg, nrf_pdm_freq_t pdm_freq)
 Function for setting the PDM clock frequency. More...
 
NRF_STATIC_INLINE nrf_pdm_freq_t nrf_pdm_clock_get (NRF_PDM_Type const *p_reg)
 Function for getting the PDM clock frequency. More...
 
NRF_STATIC_INLINE void nrf_pdm_psel_connect (NRF_PDM_Type *p_reg, uint32_t psel_clk, uint32_t psel_din)
 Function for setting up the PDM pins. More...
 
NRF_STATIC_INLINE uint32_t nrf_pdm_clk_pin_get (NRF_PDM_Type const *p_reg)
 Function for getting the CLK pin selection. More...
 
NRF_STATIC_INLINE uint32_t nrf_pdm_din_pin_get (NRF_PDM_Type const *p_reg)
 Function for getting the DIN pin selection. More...
 
NRF_STATIC_INLINE void nrf_pdm_psel_disconnect (NRF_PDM_Type *p_reg)
 Function for disconnecting the PDM pins. More...
 
NRF_STATIC_INLINE void nrf_pdm_gain_set (NRF_PDM_Type *p_reg, nrf_pdm_gain_t gain_l, nrf_pdm_gain_t gain_r)
 Function for setting the PDM gain. More...
 
NRF_STATIC_INLINE void nrf_pdm_gain_get (NRF_PDM_Type const *p_reg, nrf_pdm_gain_t *p_gain_l, nrf_pdm_gain_t *p_gain_r)
 Function for getting the PDM gain. More...
 
NRF_STATIC_INLINE void nrf_pdm_buffer_set (NRF_PDM_Type *p_reg, uint32_t *p_buffer, uint32_t num)
 Function for setting the PDM sample buffer. More...
 
NRF_STATIC_INLINE uint32_t * nrf_pdm_buffer_get (NRF_PDM_Type const *p_reg)
 Function for getting the current PDM sample buffer address. More...
 
NRF_STATIC_INLINE void nrf_pdm_ratio_set (NRF_PDM_Type *p_reg, nrf_pdm_ratio_t ratio)
 Function for setting ratio between PDM_CLK and output sample rate. More...
 
NRF_STATIC_INLINE void nrf_pdm_mclksrc_configure (NRF_PDM_Type *p_reg, nrf_pdm_mclksrc_t mclksrc)
 Function for configuring PDM master clock source. More...
 

Detailed Description

Hardware access layer for managing the Pulse Density Modulation (PDM) peripheral.

Enumeration Type Documentation

◆ nrf_pdm_edge_t

PDM sampling mode.

Enumerator
NRF_PDM_EDGE_LEFTFALLING 

Left (or mono) is sampled on falling edge of PDM_CLK.

NRF_PDM_EDGE_LEFTRISING 

Left (or mono) is sampled on rising edge of PDM_CLK.

◆ nrf_pdm_event_t

PDM events.

Enumerator
NRF_PDM_EVENT_STARTED 

PDM transfer is started.

NRF_PDM_EVENT_STOPPED 

PDM transfer is finished.

NRF_PDM_EVENT_END 

The PDM has written the last sample specified by SAMPLE.MAXCNT (or the last sample after a STOP task has been received) to Data RAM.

◆ nrf_pdm_freq_t

PDM clock frequency.

Enumerator
NRF_PDM_FREQ_1000K 

PDM_CLK = 1.000 MHz.

NRF_PDM_FREQ_1032K 

PDM_CLK = 1.032 MHz.

NRF_PDM_FREQ_1067K 

PDM_CLK = 1.067 MHz.

NRF_PDM_FREQ_1231K 

PDM_CLK = 1.231 MHz.

NRF_PDM_FREQ_1280K 

PDM_CLK = 1.280 MHz.

NRF_PDM_FREQ_1333K 

PDM_CLK = 1.333 MHz.

◆ nrf_pdm_int_mask_t

PDM interrupt masks.

Enumerator
NRF_PDM_INT_STARTED 

Interrupt on EVENTS_STARTED event.

NRF_PDM_INT_STOPPED 

Interrupt on EVENTS_STOPPED event.

NRF_PDM_INT_END 

Interrupt on EVENTS_END event.

◆ nrf_pdm_mclksrc_t

PDM master clock source selection.

Enumerator
NRF_PDM_MCLKSRC_PCLK32M 

32MHz peripheral clock.

NRF_PDM_MCLKSRC_ACLK 

Audio PLL clock.

◆ nrf_pdm_mode_t

PDM operation mode.

Enumerator
NRF_PDM_MODE_STEREO 

Sample and store one pair (Left + Right) of 16-bit samples per RAM word.

NRF_PDM_MODE_MONO 

Sample and store two successive Left samples (16 bit each) per RAM word.

◆ nrf_pdm_ratio_t

PDM ratio between PDM_CLK and output sample rate.

Enumerator
NRF_PDM_RATIO_64X 

Ratio of 64.

NRF_PDM_RATIO_80X 

Ratio of 80.

◆ nrf_pdm_task_t

PDM tasks.

Enumerator
NRF_PDM_TASK_START 

Starts continuous PDM transfer.

NRF_PDM_TASK_STOP 

Stops PDM transfer.

Function Documentation

◆ nrf_pdm_buffer_get()

NRF_STATIC_INLINE uint32_t * nrf_pdm_buffer_get ( NRF_PDM_Type const *  p_reg)

Function for getting the current PDM sample buffer address.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Pointer to the current sample buffer.

◆ nrf_pdm_buffer_set()

NRF_STATIC_INLINE void nrf_pdm_buffer_set ( NRF_PDM_Type *  p_reg,
uint32_t *  p_buffer,
uint32_t  num 
)

Function for setting the PDM sample buffer.

The amount of allocated RAM depends on the operation mode.

  • For stereo mode: N 32-bit words.
  • For mono mode: Ceil(N/2) 32-bit words.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]p_bufferPointer to the RAM address where samples are to be written with EasyDMA.
[in]numNumber of samples to allocate memory for in EasyDMA mode.

◆ nrf_pdm_clk_pin_get()

NRF_STATIC_INLINE uint32_t nrf_pdm_clk_pin_get ( NRF_PDM_Type const *  p_reg)

Function for getting the CLK pin selection.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
CLK pin selection;

◆ nrf_pdm_clock_get()

NRF_STATIC_INLINE nrf_pdm_freq_t nrf_pdm_clock_get ( NRF_PDM_Type const *  p_reg)

Function for getting the PDM clock frequency.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
PDM clock frequency.

◆ nrf_pdm_clock_set()

NRF_STATIC_INLINE void nrf_pdm_clock_set ( NRF_PDM_Type *  p_reg,
nrf_pdm_freq_t  pdm_freq 
)

Function for setting the PDM clock frequency.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]pdm_freqPDM clock frequency.

◆ nrf_pdm_din_pin_get()

NRF_STATIC_INLINE uint32_t nrf_pdm_din_pin_get ( NRF_PDM_Type const *  p_reg)

Function for getting the DIN pin selection.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
DIN pin selection;

◆ nrf_pdm_disable()

NRF_STATIC_INLINE void nrf_pdm_disable ( NRF_PDM_Type *  p_reg)

Function for disabling the PDM peripheral.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.

◆ nrf_pdm_enable()

NRF_STATIC_INLINE void nrf_pdm_enable ( NRF_PDM_Type *  p_reg)

Function for enabling the PDM peripheral.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.

The PDM peripheral must be enabled before use.

◆ nrf_pdm_enable_check()

NRF_STATIC_INLINE bool nrf_pdm_enable_check ( NRF_PDM_Type const *  p_reg)

Function for checking if the PDM peripheral is enabled.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Return values
trueThe PDM peripheral is enabled.
falseThe PDM peripheral is not enabled.

◆ nrf_pdm_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_pdm_event_address_get ( NRF_PDM_Type const *  p_reg,
nrf_pdm_event_t  event 
)

Function for getting the address of a PDM event register.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventPDM event.
Returns
Address of the specified PDM event.

◆ nrf_pdm_event_check()

NRF_STATIC_INLINE bool nrf_pdm_event_check ( NRF_PDM_Type const *  p_reg,
nrf_pdm_event_t  event 
)

Function for retrieving the state of the PDM event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent to be checked.
Return values
trueThe event has been generated.
falseThe event has not been generated.

◆ nrf_pdm_event_clear()

NRF_STATIC_INLINE void nrf_pdm_event_clear ( NRF_PDM_Type *  p_reg,
nrf_pdm_event_t  event 
)

Function for clearing a PDM event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventPDM event.

◆ nrf_pdm_gain_get()

NRF_STATIC_INLINE void nrf_pdm_gain_get ( NRF_PDM_Type const *  p_reg,
nrf_pdm_gain_t p_gain_l,
nrf_pdm_gain_t p_gain_r 
)

Function for getting the PDM gain.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[out]p_gain_lLeft channel gain.
[out]p_gain_rRight channel gain.

◆ nrf_pdm_gain_set()

NRF_STATIC_INLINE void nrf_pdm_gain_set ( NRF_PDM_Type *  p_reg,
nrf_pdm_gain_t  gain_l,
nrf_pdm_gain_t  gain_r 
)

Function for setting the PDM gain.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]gain_lLeft channel gain.
[in]gain_rRight channel gain.

◆ nrf_pdm_int_disable()

NRF_STATIC_INLINE void nrf_pdm_int_disable ( NRF_PDM_Type *  p_reg,
uint32_t  mask 
)

Function for disabling interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be disabled.

◆ nrf_pdm_int_enable()

NRF_STATIC_INLINE void nrf_pdm_int_enable ( NRF_PDM_Type *  p_reg,
uint32_t  mask 
)

Function for enabling PDM interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be enabled.

◆ nrf_pdm_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_pdm_int_enable_check ( NRF_PDM_Type const *  p_reg,
uint32_t  mask 
)

Function for checking if the specified interrupts are enabled.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be checked.
Returns
Mask of enabled interrupts.

◆ nrf_pdm_mclksrc_configure()

NRF_STATIC_INLINE void nrf_pdm_mclksrc_configure ( NRF_PDM_Type *  p_reg,
nrf_pdm_mclksrc_t  mclksrc 
)

Function for configuring PDM master clock source.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]mclksrcMaster Clock source selection.

◆ nrf_pdm_mode_get()

NRF_STATIC_INLINE void nrf_pdm_mode_get ( NRF_PDM_Type const *  p_reg,
nrf_pdm_mode_t p_pdm_mode,
nrf_pdm_edge_t p_pdm_edge 
)

Function for getting the PDM operation mode.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[out]p_pdm_modePDM operation mode.
[out]p_pdm_edgePDM sampling mode.

◆ nrf_pdm_mode_set()

NRF_STATIC_INLINE void nrf_pdm_mode_set ( NRF_PDM_Type *  p_reg,
nrf_pdm_mode_t  pdm_mode,
nrf_pdm_edge_t  pdm_edge 
)

Function for setting the PDM operation mode.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]pdm_modePDM operation mode.
[in]pdm_edgePDM sampling mode.

◆ nrf_pdm_psel_connect()

NRF_STATIC_INLINE void nrf_pdm_psel_connect ( NRF_PDM_Type *  p_reg,
uint32_t  psel_clk,
uint32_t  psel_din 
)

Function for setting up the PDM pins.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]psel_clkCLK pin number.
[in]psel_dinDIN pin number.

◆ nrf_pdm_psel_disconnect()

NRF_STATIC_INLINE void nrf_pdm_psel_disconnect ( NRF_PDM_Type *  p_reg)

Function for disconnecting the PDM pins.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.

◆ nrf_pdm_publish_clear()

NRF_STATIC_INLINE void nrf_pdm_publish_clear ( NRF_PDM_Type *  p_reg,
nrf_pdm_event_t  event 
)

Function for clearing the publish configuration for a given PDM event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent for which to clear the configuration.

◆ nrf_pdm_publish_set()

NRF_STATIC_INLINE void nrf_pdm_publish_set ( NRF_PDM_Type *  p_reg,
nrf_pdm_event_t  event,
uint8_t  channel 
)

Function for setting the publish configuration for a given PDM event.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent for which to set the configuration.
[in]channelChannel through which to publish the event.

◆ nrf_pdm_ratio_set()

NRF_STATIC_INLINE void nrf_pdm_ratio_set ( NRF_PDM_Type *  p_reg,
nrf_pdm_ratio_t  ratio 
)

Function for setting ratio between PDM_CLK and output sample rate.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]ratioRatio between PDM_CLK and output sample rate.

◆ nrf_pdm_subscribe_clear()

NRF_STATIC_INLINE void nrf_pdm_subscribe_clear ( NRF_PDM_Type *  p_reg,
nrf_pdm_task_t  task 
)

Function for clearing the subscribe configuration for a given PDM task.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask for which to clear the configuration.

◆ nrf_pdm_subscribe_set()

NRF_STATIC_INLINE void nrf_pdm_subscribe_set ( NRF_PDM_Type *  p_reg,
nrf_pdm_task_t  task,
uint8_t  channel 
)

Function for setting the subscribe configuration for a given PDM task.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask for which to set the configuration.
[in]channelChannel through which to subscribe events.

◆ nrf_pdm_task_address_get()

NRF_STATIC_INLINE uint32_t nrf_pdm_task_address_get ( NRF_PDM_Type const *  p_reg,
nrf_pdm_task_t  task 
)

Function for getting the address of a PDM task register.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskPDM task.
Returns
Address of the specified PDM task.

◆ nrf_pdm_task_trigger()

NRF_STATIC_INLINE void nrf_pdm_task_trigger ( NRF_PDM_Type *  p_reg,
nrf_pdm_task_t  task 
)

Function for triggering a PDM task.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskPDM task.

Documentation feedback | Developer Zone | Subscribe | Updated