[nrf fromlist] drivers: audio: dmic: Add support for multiple nrf PDM instances

Driver now uses multi-instance PDM nrfx API and
defines PDM device based on available instances.
It also introduces calculating PDM frequency using
prescaler, present on nRF54L15 FP1.

Signed-off-by: Michał Stasiak <[email protected]>

Author: mstasiaknordic

drivers/audio/Kconfig.dmic_pdm_nrfx

@@ -5,7 +5,9 @@ config AUDIO_DMIC_NRFX_PDM
 	bool "nRF PDM nrfx driver"
 	default y
 	depends on DT_HAS_NORDIC_NRF_PDM_ENABLED
-	select NRFX_PDM
+	select NRFX_PDM0 if HAS_HW_NRF_PDM0
+	select NRFX_PDM20 if HAS_HW_NRF_PDM20
+	select NRFX_PDM21 if HAS_HW_NRF_PDM21
 	select PINCTRL
 	help
 	  Enable support for nrfx PDM driver for nRF MCU series.

drivers/audio/dmic_nrfx_pdm.c

@@ -15,6 +15,7 @@
 LOG_MODULE_REGISTER(dmic_nrfx_pdm, CONFIG_AUDIO_DMIC_LOG_LEVEL);
 
 struct dmic_nrfx_pdm_drv_data {
+	const nrfx_pdm_t *pdm;
 	struct onoff_manager *clk_mgr;
 	struct onoff_client clk_cli;
 	struct k_mem_slab *mem_slab;
@@ -28,6 +29,7 @@ struct dmic_nrfx_pdm_drv_data {
 
 struct dmic_nrfx_pdm_drv_cfg {
 	nrfx_pdm_event_handler_t event_handler;
+	nrfx_pdm_t pdm;
 	nrfx_pdm_config_t nrfx_def_cfg;
 	const struct pinctrl_dev_config *pcfg;
 	enum clock_source {
@@ -58,8 +60,7 @@ static void event_handler(const struct device *dev, const nrfx_pdm_evt_t *evt)
 			LOG_ERR("Failed to allocate buffer: %d", ret);
 			stop = true;
 		} else {
-			err = nrfx_pdm_buffer_set(buffer,
-						  drv_data->block_size / 2);
+			err = nrfx_pdm_buffer_set(drv_data->pdm, buffer, drv_data->block_size / 2);
 			if (err != NRFX_SUCCESS) {
 				LOG_ERR("Failed to set buffer: 0x%08x", err);
 				stop = true;
@@ -94,7 +95,7 @@ static void event_handler(const struct device *dev, const nrfx_pdm_evt_t *evt)
 
 	if (stop) {
 		drv_data->stopping = true;
-		nrfx_pdm_stop();
+		nrfx_pdm_stop(drv_data->pdm);
 	}
 }
 
@@ -132,6 +133,37 @@ static bool check_pdm_frequencies(const struct dmic_nrfx_pdm_drv_cfg *drv_cfg,
 	uint32_t req_rate = pdm_cfg->streams[0].pcm_rate;
 	bool better_found = false;
 
+#if NRF_PDM_HAS_PRESCALER
+	uint32_t src_freq = 32 * 1000 * 1000UL;
+	uint32_t req_freq = req_rate * ratio;
+	uint32_t prescaler = src_freq / req_freq;
+	uint32_t act_freq = src_freq / prescaler;
+
+	if (act_freq >= pdm_cfg->io.min_pdm_clk_freq && act_freq <= pdm_cfg->io.max_pdm_clk_freq &&
+		is_better(act_freq, ratio, req_rate, best_diff, best_rate, best_freq)) {
+		config->prescaler = prescaler;
+
+		better_found = true;
+	}
+
+	/* Stop if an exact rate match is found. */
+	if (*best_diff == 0) {
+		return true;
+	}
+
+	/* Prescaler value is rounded down by default,
+	 * thus value rounded up should be checked as well.
+	 */
+	prescaler += 1;
+	act_freq  = src_freq / prescaler;
+
+	if (act_freq >= pdm_cfg->io.min_pdm_clk_freq && act_freq <= pdm_cfg->io.max_pdm_clk_freq &&
+		is_better(act_freq, ratio, req_rate, best_diff, best_rate, best_freq)) {
+		config->prescaler = prescaler;
+
+		better_found = true;
+	}
+#else
 	if (IS_ENABLED(CONFIG_SOC_SERIES_NRF53X)) {
 		const uint32_t src_freq =
 			(NRF_PDM_HAS_MCLKCONFIG && drv_cfg->clk_src == ACLK)
@@ -171,17 +203,17 @@ static bool check_pdm_frequencies(const struct dmic_nrfx_pdm_drv_cfg *drv_cfg,
 			uint32_t       freq_val;
 			nrf_pdm_freq_t freq_enum;
 		} freqs[] = {
-			{ 1000000, NRF_PDM_FREQ_1000K },
-			{ 1032000, NRF_PDM_FREQ_1032K },
-			{ 1067000, NRF_PDM_FREQ_1067K },
+			{1000000, NRF_PDM_FREQ_1000K},
+			{1032000, NRF_PDM_FREQ_1032K},
+			{1067000, NRF_PDM_FREQ_1067K},
 #if defined(PDM_PDMCLKCTRL_FREQ_1231K)
-			{ 1231000, NRF_PDM_FREQ_1231K },
+			{1231000, NRF_PDM_FREQ_1231K},
 #endif
 #if defined(PDM_PDMCLKCTRL_FREQ_1280K)
-			{ 1280000, NRF_PDM_FREQ_1280K },
+			{1280000, NRF_PDM_FREQ_1280K},
 #endif
 #if defined(PDM_PDMCLKCTRL_FREQ_1333K)
-			{ 1333000, NRF_PDM_FREQ_1333K }
+			{1333000, NRF_PDM_FREQ_1333K}
 #endif
 		};
 
@@ -216,6 +248,7 @@ static bool check_pdm_frequencies(const struct dmic_nrfx_pdm_drv_cfg *drv_cfg,
 			}
 		}
 	}
+#endif
 
 	return better_found;
 }
@@ -236,8 +269,26 @@ static bool find_suitable_clock(const struct dmic_nrfx_pdm_drv_cfg *drv_cfg,
 		uint8_t         ratio_val;
 		nrf_pdm_ratio_t ratio_enum;
 	} ratios[] = {
-		{  64, NRF_PDM_RATIO_64X },
-		{  80, NRF_PDM_RATIO_80X }
+#if defined(PDM_RATIO_RATIO_Ratio32)
+		{32, NRF_PDM_RATIO_32X},
+#endif
+#if defined(PDM_RATIO_RATIO_Ratio48)
+		{48, NRF_PDM_RATIO_48X},
+#endif
+#if defined(PDM_RATIO_RATIO_Ratio50)
+		{50, NRF_PDM_RATIO_50X},
+#endif
+		{64, NRF_PDM_RATIO_64X},
+		{80, NRF_PDM_RATIO_80X},
+#if defined(PDM_RATIO_RATIO_Ratio96)
+		{96, NRF_PDM_RATIO_96X},
+#endif
+#if defined(PDM_RATIO_RATIO_Ratio100)
+		{100, NRF_PDM_RATIO_100X},
+#endif
+#if defined(PDM_RATIO_RATIO_Ratio128)
+		{128, NRF_PDM_RATIO_128X}
+#endif
 	};
 
 	for (int r = 0; best_diff != 0 && r < ARRAY_SIZE(ratios); ++r) {
@@ -327,7 +378,7 @@ static int dmic_nrfx_pdm_configure(const struct device *dev,
 	/* If either rate or width is 0, the stream is to be disabled. */
 	if (stream->pcm_rate == 0 || stream->pcm_width == 0) {
 		if (drv_data->configured) {
-			nrfx_pdm_uninit();
+			nrfx_pdm_uninit(drv_data->pdm);
 			drv_data->configured = false;
 		}
 
@@ -357,11 +408,11 @@ static int dmic_nrfx_pdm_configure(const struct device *dev,
 	}
 
 	if (drv_data->configured) {
-		nrfx_pdm_uninit();
+		nrfx_pdm_uninit(drv_data->pdm);
 		drv_data->configured = false;
 	}
 
-	err = nrfx_pdm_init(&nrfx_cfg, drv_cfg->event_handler);
+	err = nrfx_pdm_init(drv_data->pdm, &nrfx_cfg, drv_cfg->event_handler);
 	if (err != NRFX_SUCCESS) {
 		LOG_ERR("Failed to initialize PDM: 0x%08x", err);
 		return -EIO;
@@ -385,7 +436,7 @@ static int start_transfer(struct dmic_nrfx_pdm_drv_data *drv_data)
 	nrfx_err_t err;
 	int ret;
 
-	err = nrfx_pdm_start();
+	err = nrfx_pdm_start(drv_data->pdm);
 	if (err == NRFX_SUCCESS) {
 		return 0;
 	}
@@ -460,7 +511,7 @@ static int dmic_nrfx_pdm_trigger(const struct device *dev,
 	case DMIC_TRIGGER_STOP:
 		if (drv_data->active) {
 			drv_data->stopping = true;
-			nrfx_pdm_stop();
+			nrfx_pdm_stop(drv_data->pdm);
 		}
 		break;
 
@@ -540,11 +591,28 @@ static const struct _dmic_ops dmic_ops = {
 
 #define PDM_NRFX_DEVICE(idx)						     \
 	static void *rx_msgs##idx[DT_PROP(PDM(idx), queue_size)];	     \
-	static struct dmic_nrfx_pdm_drv_data dmic_nrfx_pdm_data##idx;	     \
+	static void event_handler##idx(const nrfx_pdm_evt_t *evt)	     \
+	{								     \
+		event_handler(DEVICE_DT_GET(PDM(idx)), evt);		     \
+	}								     \
+	PINCTRL_DT_DEFINE(PDM(idx));					     \
+	static const struct dmic_nrfx_pdm_drv_cfg dmic_nrfx_pdm_cfg##idx = { \
+		.event_handler = event_handler##idx,			     \
+		.pdm = NRFX_PDM_INSTANCE(idx),                               \
+		.nrfx_def_cfg =	NRFX_PDM_DEFAULT_CONFIG(0, 0),		     \
+		.nrfx_def_cfg.skip_gpio_cfg = true,			     \
+		.nrfx_def_cfg.skip_psel_cfg = true,			     \
+		.pcfg = PINCTRL_DT_DEV_CONFIG_GET(PDM(idx)),		     \
+		.clk_src = PDM_CLK_SRC(idx),				     \
+	};								     \
+	static struct dmic_nrfx_pdm_drv_data dmic_nrfx_pdm_data##idx =       \
+	{                                                                    \
+		.pdm = &dmic_nrfx_pdm_cfg##idx.pdm                           \
+	};	                                                             \
 	static int pdm_nrfx_init##idx(const struct device *dev)		     \
 	{								     \
 		IRQ_CONNECT(DT_IRQN(PDM(idx)), DT_IRQ(PDM(idx), priority),   \
-			    nrfx_isr, nrfx_pdm_irq_handler, 0);		     \
+			    nrfx_isr, nrfx_pdm_##idx##_irq_handler, 0);      \
 		const struct dmic_nrfx_pdm_drv_cfg *drv_cfg = dev->config;   \
 		int err = pinctrl_apply_state(drv_cfg->pcfg,		     \
 					      PINCTRL_STATE_DEFAULT);	     \
@@ -557,19 +625,6 @@ static const struct _dmic_ops dmic_ops = {
 		init_clock_manager(dev);				     \
 		return 0;						     \
 	}								     \
-	static void event_handler##idx(const nrfx_pdm_evt_t *evt)	     \
-	{								     \
-		event_handler(DEVICE_DT_GET(PDM(idx)), evt);		     \
-	}								     \
-	PINCTRL_DT_DEFINE(PDM(idx));					     \
-	static const struct dmic_nrfx_pdm_drv_cfg dmic_nrfx_pdm_cfg##idx = { \
-		.event_handler = event_handler##idx,			     \
-		.nrfx_def_cfg =	NRFX_PDM_DEFAULT_CONFIG(0, 0),		     \
-		.nrfx_def_cfg.skip_gpio_cfg = true,			     \
-		.nrfx_def_cfg.skip_psel_cfg = true,			     \
-		.pcfg = PINCTRL_DT_DEV_CONFIG_GET(PDM(idx)),		     \
-		.clk_src = PDM_CLK_SRC(idx),				     \
-	};								     \
 	BUILD_ASSERT(PDM_CLK_SRC(idx) != ACLK || NRF_PDM_HAS_MCLKCONFIG,     \
 		"Clock source ACLK is not available.");			     \
 	BUILD_ASSERT(PDM_CLK_SRC(idx) != ACLK ||			     \
@@ -582,5 +637,14 @@ static const struct _dmic_ops dmic_ops = {
 			 POST_KERNEL, CONFIG_AUDIO_DMIC_INIT_PRIORITY,	     \
 			 &dmic_ops);
 
-/* Existing SoCs only have one PDM instance. */
+#ifdef CONFIG_HAS_HW_NRF_PDM0
 PDM_NRFX_DEVICE(0);
+#endif
+
+#ifdef CONFIG_HAS_HW_NRF_PDM20
+PDM_NRFX_DEVICE(20);
+#endif
+
+#ifdef CONFIG_HAS_HW_NRF_PDM21
+PDM_NRFX_DEVICE(21);
+#endif