Skip to content

Commit ad9021a

Browse files
committed
fix(i2s): fix the crackle using apll with DFS feature
Closes: #14707
1 parent 2a2f0fd commit ad9021a

File tree

11 files changed

+7
-26
lines changed

11 files changed

+7
-26
lines changed

components/driver/deprecated/i2s_legacy.c

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1479,11 +1479,6 @@ static esp_err_t i2s_init_legacy(i2s_port_t i2s_num, int intr_alloc_flag)
14791479
/* Create power management lock */
14801480
#ifdef CONFIG_PM_ENABLE
14811481
esp_pm_lock_type_t pm_lock = ESP_PM_APB_FREQ_MAX;
1482-
#if SOC_I2S_SUPPORTS_APLL
1483-
if (p_i2s[i2s_num]->use_apll) {
1484-
pm_lock = ESP_PM_NO_LIGHT_SLEEP;
1485-
}
1486-
#endif // SOC_I2S_SUPPORTS_APLL
14871482
ESP_RETURN_ON_ERROR(esp_pm_lock_create(pm_lock, 0, "i2s_driver", &p_i2s[i2s_num]->pm_lock), TAG, "I2S pm lock error");
14881483
#endif //CONFIG_PM_ENABLE
14891484

components/esp_driver_dac/dac_continuous.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ esp_err_t dac_continuous_new_channels(const dac_continuous_config_t *cont_cfg, d
228228

229229
/* Create PM lock */
230230
#if CONFIG_PM_ENABLE
231-
esp_pm_lock_type_t pm_lock_type = cont_cfg->clk_src == DAC_DIGI_CLK_SRC_APLL ? ESP_PM_NO_LIGHT_SLEEP : ESP_PM_APB_FREQ_MAX;
231+
esp_pm_lock_type_t pm_lock_type = ESP_PM_APB_FREQ_MAX;
232232
ESP_GOTO_ON_ERROR(esp_pm_lock_create(pm_lock_type, 0, "dac_driver", &handle->pm_lock), err3, TAG, "Failed to create DAC pm lock");
233233
#endif
234234
handle->chan_cnt = __builtin_popcount(cont_cfg->chan_mask);

components/esp_driver_i2s/i2s_pdm.c

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -199,11 +199,6 @@ esp_err_t i2s_channel_init_pdm_tx_mode(i2s_chan_handle_t handle, const i2s_pdm_t
199199

200200
#ifdef CONFIG_PM_ENABLE
201201
esp_pm_lock_type_t pm_type = ESP_PM_APB_FREQ_MAX;
202-
#if SOC_I2S_SUPPORTS_APLL
203-
if (pdm_tx_cfg->clk_cfg.clk_src == I2S_CLK_SRC_APLL) {
204-
pm_type = ESP_PM_NO_LIGHT_SLEEP;
205-
}
206-
#endif // SOC_I2S_SUPPORTS_APLL
207202
ESP_RETURN_ON_ERROR(esp_pm_lock_create(pm_type, 0, "i2s_driver", &handle->pm_lock), TAG, "I2S pm lock create failed");
208203
#endif
209204

components/esp_driver_i2s/i2s_std.c

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -240,11 +240,6 @@ esp_err_t i2s_channel_init_std_mode(i2s_chan_handle_t handle, const i2s_std_conf
240240

241241
#ifdef CONFIG_PM_ENABLE
242242
esp_pm_lock_type_t pm_type = ESP_PM_APB_FREQ_MAX;
243-
#if SOC_I2S_SUPPORTS_APLL
244-
if (std_cfg->clk_cfg.clk_src == I2S_CLK_SRC_APLL) {
245-
pm_type = ESP_PM_NO_LIGHT_SLEEP;
246-
}
247-
#endif // SOC_I2S_SUPPORTS_APLL
248243
ESP_RETURN_ON_ERROR(esp_pm_lock_create(pm_type, 0, "i2s_driver", &handle->pm_lock), TAG, "I2S pm lock create failed");
249244
#endif
250245

components/esp_driver_i2s/i2s_tdm.c

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -246,11 +246,6 @@ esp_err_t i2s_channel_init_tdm_mode(i2s_chan_handle_t handle, const i2s_tdm_conf
246246
#endif
247247
#ifdef CONFIG_PM_ENABLE
248248
esp_pm_lock_type_t pm_type = ESP_PM_APB_FREQ_MAX;
249-
#if SOC_I2S_SUPPORTS_APLL
250-
if (tdm_cfg->clk_cfg.clk_src == I2S_CLK_SRC_APLL) {
251-
pm_type = ESP_PM_NO_LIGHT_SLEEP;
252-
}
253-
#endif // SOC_I2S_SUPPORTS_APLL
254249
ESP_RETURN_ON_ERROR(esp_pm_lock_create(pm_type, 0, "i2s_driver", &handle->pm_lock), TAG, "I2S pm lock create failed");
255250
#endif
256251

components/esp_driver_i2s/test_apps/i2s/sdkconfig.ci.release

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ CONFIG_COMPILER_OPTIMIZATION_SIZE=y
44
CONFIG_BOOTLOADER_COMPILER_OPTIMIZATION_SIZE=y
55
CONFIG_COMPILER_OPTIMIZATION_ASSERTIONS_SILENT=y
66
CONFIG_PM_POWER_DOWN_PERIPHERAL_IN_LIGHT_SLEEP=y
7+
CONFIG_PM_DFS_INIT_AUTO=y

components/esp_lcd/i80/esp_lcd_panel_io_i2s.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -666,7 +666,7 @@ static esp_err_t i2s_lcd_select_periph_clock(esp_lcd_i80_bus_handle_t bus, lcd_c
666666
// create pm lock based on different clock source
667667
// clock sources like PLL and XTAL will be turned off in light sleep
668668
#if CONFIG_PM_ENABLE
669-
ESP_RETURN_ON_ERROR(esp_pm_lock_create(ESP_PM_NO_LIGHT_SLEEP, 0, "i80_bus_lcd", &bus->pm_lock), TAG, "create pm lock failed");
669+
ESP_RETURN_ON_ERROR(esp_pm_lock_create(ESP_PM_APB_FREQ_MAX, 0, "i80_bus_lcd", &bus->pm_lock), TAG, "create pm lock failed");
670670
#endif
671671
return ESP_OK;
672672
}

docs/en/api-reference/peripherals/dac.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Power Management
9696

9797
When the power management is enabled (i.e., :ref:`CONFIG_PM_ENABLE` is on), the system will adjust or stop the clock source of DAC before entering Light-sleep mode, thus potential influence to the DAC signals may lead to false data conversion.
9898

99-
When using DAC driver in continuous mode, it can prevent the system from changing or stopping the clock source in DMA or cosine mode by acquiring a power management lock. When the clock source is generated from APB, the lock type will be set to :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_APB_FREQ_MAX`. When the clock source is APLL (only in DMA mode), it will be set to :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_NO_LIGHT_SLEEP`. Whenever the DAC is converting (i.e., DMA or cosine wave generator is working), the driver guarantees that the power management lock is acquired after calling :cpp:func:`dac_continuous_enable`. Likewise, the driver will release the lock when :cpp:func:`dac_continuous_disable` is called.
99+
When using DAC driver in continuous mode, it can prevent the system from changing or stopping the clock source in DMA or cosine mode by acquiring a power management lock. The power lock type will be set to :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_APB_FREQ_MAX`. Whenever the DAC is converting (i.e., DMA or cosine wave generator is working), the driver guarantees that the power management lock is acquired after calling :cpp:func:`dac_continuous_enable`. Likewise, the driver will release the lock when :cpp:func:`dac_continuous_disable` is called.
100100

101101
IRAM Safe
102102
^^^^^^^^^

docs/en/api-reference/peripherals/i2s.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Power Management
236236

237237
When the power management is enabled (i.e., :ref:`CONFIG_PM_ENABLE` is on), the system will adjust or stop the source clock of I2S before entering Light-sleep, thus potentially changing the I2S signals and leading to transmitting or receiving invalid data.
238238

239-
The I2S driver can prevent the system from changing or stopping the source clock by acquiring a power management lock. When the source clock is generated from APB, the lock type will be set to :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_APB_FREQ_MAX` and when the source clock is APLL (if supported), it will be set to :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_NO_LIGHT_SLEEP`. Whenever the user is reading or writing via I2S (i.e., calling :cpp:func:`i2s_channel_read` or :cpp:func:`i2s_channel_write`), the driver guarantees that the power management lock is acquired. Likewise, the driver releases the lock after the reading or writing finishes.
239+
The I2S driver can prevent the system from changing or stopping the source clock by acquiring a power management lock. The power lock type will be set to :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_APB_FREQ_MAX`. Whenever the user is reading or writing via I2S (i.e., calling :cpp:func:`i2s_channel_read` or :cpp:func:`i2s_channel_write`), the driver guarantees that the power management lock is acquired. Likewise, the driver releases the lock after the reading or writing finishes.
240240

241241
.. only:: SOC_I2S_SUPPORT_SLEEP_RETENTION
242242

docs/zh_CN/api-reference/peripherals/dac.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ DAC 外设中包含一个余弦波发生器,可以在通道上产生余弦波
9696

9797
启用电源管理时(即开启 :ref:`CONFIG_PM_ENABLE`),系统会在进入 Light-sleep 模式前调整或停止 DAC 时钟源,这可能会影响 DAC 信号,从而导致数据无法正确转换。
9898

99-
在连续模式下使用 DAC 驱动时,可以通过获取电源管理锁来防止系统在 DMA 或余弦波模式下改变或停止时钟源。时钟源为 APB 时,锁的类型将被设置为 :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_APB_FREQ_MAX`。时钟源为 APLL 时(仅在 DMA 模式下),锁的类型将被设置为 :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_NO_LIGHT_SLEEP`。在进行 DAC 转换时(即 DMA 或余弦波发生器运行时),驱动程序会保证在调用 :cpp:func:`dac_continuous_enable` 后获取电源管理锁。同样地,在调用 :cpp:func:`dac_continuous_disable` 时,驱动程序会释放锁。
99+
在连续模式下使用 DAC 驱动时,可以通过获取电源管理锁来防止系统在 DMA 或余弦波模式下改变或停止时钟源。电源锁的类型将被设置为 :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_APB_FREQ_MAX`。在进行 DAC 转换时(即 DMA 或余弦波发生器运行时),驱动程序会保证在调用 :cpp:func:`dac_continuous_enable` 后获取电源管理锁。同样地,在调用 :cpp:func:`dac_continuous_disable` 时,驱动程序会释放锁。
100100

101101
IRAM 安全
102102
^^^^^^^^^

docs/zh_CN/api-reference/peripherals/i2s.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ I2S 驱动中的资源可分为三个级别:
236236

237237
电源管理启用(即开启 :ref:`CONFIG_PM_ENABLE`)时,系统将在进入 Light-sleep 前调整或停止 I2S 时钟源,这可能会影响 I2S 信号,从而导致传输或接收的数据无效。
238238

239-
I2S 驱动可以获取电源管理锁,从而防止系统设置更改或时钟源被禁用。时钟源为 APB 时,锁的类型将被设置为 :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_APB_FREQ_MAX`。时钟源为 APLL(若支持)时,锁的类型将被设置为 :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_NO_LIGHT_SLEEP`。用户通过 I2S 读写时(即调用 :cpp:func:`i2s_channel_read` 或 :cpp:func:`i2s_channel_write`),驱动程序将获取电源管理锁,并在读写完成后释放锁。
239+
I2S 驱动可以获取电源管理锁,从而防止系统设置更改或时钟源被禁用。电源锁的类型将被设置为 :cpp:enumerator:`esp_pm_lock_type_t::ESP_PM_APB_FREQ_MAX`。用户通过 I2S 读写时(即调用 :cpp:func:`i2s_channel_read` 或 :cpp:func:`i2s_channel_write`),驱动程序将获取电源管理锁,并在读写完成后释放锁。
240240

241241
.. only:: SOC_I2S_SUPPORT_SLEEP_RETENTION
242242

0 commit comments

Comments
 (0)