mirror of
				https://github.com/espressif/esp-idf.git
				synced 2025-11-04 06:11:06 +00:00 
			
		
		
		
	fix(i2s): add check for the minimum sample rate
Closes https://github.com/espressif/esp-idf/issues/15659
This commit is contained in:
		@@ -1,5 +1,5 @@
 | 
			
		||||
/*
 | 
			
		||||
 * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 | 
			
		||||
 * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
 | 
			
		||||
 *
 | 
			
		||||
 * SPDX-License-Identifier: Apache-2.0
 | 
			
		||||
 */
 | 
			
		||||
@@ -44,7 +44,8 @@ static esp_err_t i2s_pdm_tx_calculate_clock(i2s_chan_handle_t handle, const i2s_
 | 
			
		||||
    clk_info->mclk_div = clk_info->sclk / clk_info->mclk;
 | 
			
		||||
 | 
			
		||||
    /* Check if the configuration is correct. Use float for check in case the mclk division might be carried up in the fine division calculation */
 | 
			
		||||
    ESP_RETURN_ON_FALSE(clk_info->sclk / (float)clk_info->mclk > 1.99, ESP_ERR_INVALID_ARG, TAG, "sample rate is too large");
 | 
			
		||||
    ESP_RETURN_ON_FALSE((float)clk_info->sclk > clk_info->mclk * 1.99, ESP_ERR_INVALID_ARG, TAG, "sample rate is too large");
 | 
			
		||||
    ESP_RETURN_ON_FALSE(clk_info->mclk_div < 256, ESP_ERR_INVALID_ARG, TAG, "sample rate is too small");
 | 
			
		||||
    /* Set up sampling configuration */
 | 
			
		||||
    i2s_ll_tx_set_pdm_fpfs(handle->controller->hal.dev, pdm_tx_clk->up_sample_fp, pdm_tx_clk->up_sample_fs);
 | 
			
		||||
    i2s_ll_tx_set_pdm_over_sample_ratio(handle->controller->hal.dev, over_sample_ratio);
 | 
			
		||||
@@ -332,7 +333,8 @@ static esp_err_t i2s_pdm_rx_calculate_clock(i2s_chan_handle_t handle, const i2s_
 | 
			
		||||
    clk_info->mclk_div = clk_info->sclk / clk_info->mclk;
 | 
			
		||||
 | 
			
		||||
    /* Check if the configuration is correct. Use float for check in case the mclk division might be carried up in the fine division calculation */
 | 
			
		||||
    ESP_RETURN_ON_FALSE(clk_info->sclk / (float)clk_info->mclk > 1.99, ESP_ERR_INVALID_ARG, TAG, "sample rate is too large");
 | 
			
		||||
    ESP_RETURN_ON_FALSE((float)clk_info->sclk > clk_info->mclk * 1.99, ESP_ERR_INVALID_ARG, TAG, "sample rate is too large");
 | 
			
		||||
    ESP_RETURN_ON_FALSE(clk_info->mclk_div < I2S_LL_CLK_FRAC_DIV_N_MAX, ESP_ERR_INVALID_ARG, TAG, "sample rate is too small");
 | 
			
		||||
    /* Set down-sampling configuration */
 | 
			
		||||
    i2s_ll_rx_set_pdm_dsr(handle->controller->hal.dev, pdm_rx_clk->dn_sample_mode);
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
 
 | 
			
		||||
@@ -49,7 +49,8 @@ static esp_err_t i2s_std_calculate_clock(i2s_chan_handle_t handle, const i2s_std
 | 
			
		||||
    clk_info->mclk_div = clk_info->sclk / clk_info->mclk;
 | 
			
		||||
 | 
			
		||||
    /* Check if the configuration is correct. Use float for check in case the mclk division might be carried up in the fine division calculation */
 | 
			
		||||
    ESP_RETURN_ON_FALSE(clk_info->sclk / (float)clk_info->mclk > 1.99, ESP_ERR_INVALID_ARG, TAG, "sample rate or mclk_multiple is too large for the current clock source");
 | 
			
		||||
    ESP_RETURN_ON_FALSE((float)clk_info->sclk > clk_info->mclk * 1.99, ESP_ERR_INVALID_ARG, TAG, "sample rate is too large");
 | 
			
		||||
    ESP_RETURN_ON_FALSE(clk_info->mclk_div < I2S_LL_CLK_FRAC_DIV_N_MAX, ESP_ERR_INVALID_ARG, TAG, "sample rate is too small");
 | 
			
		||||
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -60,7 +60,8 @@ static esp_err_t i2s_tdm_calculate_clock(i2s_chan_handle_t handle, const i2s_tdm
 | 
			
		||||
    clk_info->mclk_div = clk_info->sclk / clk_info->mclk;
 | 
			
		||||
 | 
			
		||||
    /* Check if the configuration is correct. Use float for check in case the mclk division might be carried up in the fine division calculation */
 | 
			
		||||
    ESP_RETURN_ON_FALSE(clk_info->sclk / (float)clk_info->mclk > 1.99, ESP_ERR_INVALID_ARG, TAG, "sample rate or mclk_multiple is too large for the current clock source");
 | 
			
		||||
    ESP_RETURN_ON_FALSE((float)clk_info->sclk > clk_info->mclk * 1.99, ESP_ERR_INVALID_ARG, TAG, "sample rate is too large");
 | 
			
		||||
    ESP_RETURN_ON_FALSE(clk_info->mclk_div < I2S_LL_CLK_FRAC_DIV_N_MAX, ESP_ERR_INVALID_ARG, TAG, "sample rate is too small");
 | 
			
		||||
 | 
			
		||||
    return ESP_OK;
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -30,6 +30,8 @@ extern "C" {
 | 
			
		||||
#define I2S_LL_AD_BCK_FACTOR           (2)
 | 
			
		||||
#define I2S_LL_PDM_BCK_FACTOR          (64)
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_CLK_FRAC_DIV_N_MAX  256 // I2S_MCLK = I2S_SRC_CLK / (N + b/a), the N register is 8 bit-width
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_BIT_WIDTH  (6)
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_MAX        ((1 << I2S_LL_MCLK_DIVIDER_BIT_WIDTH) - 1)
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -29,6 +29,8 @@ extern "C" {
 | 
			
		||||
#define I2S_LL_TDM_CH_MASK             (0xffff)
 | 
			
		||||
#define I2S_LL_PDM_BCK_FACTOR          (64)
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_CLK_FRAC_DIV_N_MAX  256 // I2S_MCLK = I2S_SRC_CLK / (N + b/a), the N register is 8 bit-width
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_BIT_WIDTH  (9)
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_MAX        ((1 << I2S_LL_MCLK_DIVIDER_BIT_WIDTH) - 1)
 | 
			
		||||
#define I2S_LL_SLOT_FRAME_BIT_MAX  128 // Up-to 128 bits in one frame, determined by MAX(half_sample_bits) * 2
 | 
			
		||||
 
 | 
			
		||||
@@ -30,6 +30,8 @@ extern "C" {
 | 
			
		||||
#define I2S_LL_TDM_CH_MASK             (0xffff)
 | 
			
		||||
#define I2S_LL_PDM_BCK_FACTOR          (64)
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_CLK_FRAC_DIV_N_MAX  256 // I2S_MCLK = I2S_SRC_CLK / (N + b/a), the N register is 8 bit-width
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_BIT_WIDTH  (9)
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_MAX        ((1 << I2S_LL_MCLK_DIVIDER_BIT_WIDTH) - 1)
 | 
			
		||||
#define I2S_LL_SLOT_FRAME_BIT_MAX  128 // Up-to 128 bits in one frame, determined by MAX(half_sample_bits) * 2
 | 
			
		||||
 
 | 
			
		||||
@@ -30,6 +30,8 @@ extern "C" {
 | 
			
		||||
#define I2S_LL_TDM_CH_MASK             (0xffff)
 | 
			
		||||
#define I2S_LL_PDM_BCK_FACTOR          (64)
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_CLK_FRAC_DIV_N_MAX  256 // I2S_MCLK = I2S_SRC_CLK / (N + b/a), the N register is 8 bit-width
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_BIT_WIDTH  (9)
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_MAX        ((1 << I2S_LL_MCLK_DIVIDER_BIT_WIDTH) - 1)
 | 
			
		||||
#define I2S_LL_SLOT_FRAME_BIT_MAX  512 // Up-to 512 bits in one frame, determined by MAX(half_sample_bits) * 2
 | 
			
		||||
 
 | 
			
		||||
@@ -30,6 +30,8 @@ extern "C" {
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_BCK_MAX_PRESCALE  (64)
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_CLK_FRAC_DIV_N_MAX  256 // I2S_MCLK = I2S_SRC_CLK / (N + b/a), the N register is 8 bit-width
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_BIT_WIDTH  (6)
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_MAX        ((1 << I2S_LL_MCLK_DIVIDER_BIT_WIDTH) - 1)
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -30,6 +30,8 @@ extern "C" {
 | 
			
		||||
#define I2S_LL_TDM_CH_MASK (0xffff)
 | 
			
		||||
#define I2S_LL_PDM_BCK_FACTOR          (64)
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_CLK_FRAC_DIV_N_MAX  256 // I2S_MCLK = I2S_SRC_CLK / (N + b/a), the N register is 8 bit-width
 | 
			
		||||
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_BIT_WIDTH  (9)
 | 
			
		||||
#define I2S_LL_MCLK_DIVIDER_MAX        ((1 << I2S_LL_MCLK_DIVIDER_BIT_WIDTH) - 1)
 | 
			
		||||
#define I2S_LL_SLOT_FRAME_BIT_MAX  128 // Up-to 128 bits in one frame, determined by MAX(half_sample_bits) * 2
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user