feat(codec): Update es8311 to allow sample rate reconfiguration (#550)

* feat(codec): Update `es8311` to allow sample rate reconfiguration

* address comments

Author: finger563

components/codec/es8311/es8311.cpp

@@ -126,6 +126,20 @@ static const struct _coeff_div coeff_div[] = {
     {3072000, 24000, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
     {1536000, 24000, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
 
+    /* 26390 */
+    {11289600, 26390, 0x03, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {6818048, 26390, 0x01, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {5644800, 26390, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {2822400, 26390, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {1411200, 26390, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+
+    /* 26633 */
+    {11289600, 26633, 0x03, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {6818048, 26633, 0x01, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {5644800, 26633, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {2822400, 26633, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {1411200, 26633, 0x01, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+
     /* 32k */
     {12288000, 32000, 0x03, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
     {18432000, 32000, 0x03, 0x04, 0x03, 0x03, 0x00, 0x02, 0xff, 0x0c, 0x10, 0x10},
@@ -138,6 +152,16 @@ static const struct _coeff_div coeff_div[] = {
     {1536000, 32000, 0x03, 0x08, 0x01, 0x01, 0x01, 0x00, 0x7f, 0x02, 0x10, 0x10},
     {1024000, 32000, 0x01, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
 
+    /* 32768 */
+    {12288000, 32768, 0x03, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {18432000, 32768, 0x03, 0x04, 0x03, 0x03, 0x00, 0x02, 0xff, 0x0c, 0x10, 0x10},
+    {16384000, 32768, 0x02, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {8388608, 32768, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {8192000, 32768, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {6144000, 32768, 0x03, 0x04, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {4096000, 32768, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+    {3072000, 32768, 0x03, 0x08, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
+
     /* 44.1k */
     {11289600, 44100, 0x01, 0x01, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
     {5644800, 44100, 0x01, 0x02, 0x01, 0x01, 0x00, 0x00, 0xff, 0x04, 0x10, 0x10},
@@ -340,7 +364,7 @@ esp_err_t es8311_codec_init(audio_hal_codec_config_t *codec_cfg) {
     return ESP_FAIL;
   }
   /*
-   * Set clock parammeters
+   * Set clock parameters
    */
   regv = es8311_read_reg(ES8311_CLK_MANAGER_REG02) & 0x07;
   regv |= (coeff_div[coeff].pre_div - 1) << 5;
@@ -430,6 +454,77 @@ esp_err_t es8311_codec_init(audio_hal_codec_config_t *codec_cfg) {
   return ESP_OK;
 }
 
+esp_err_t es8311_codec_set_sample_rate(int sample_rate) {
+  esp_err_t ret = ESP_OK;
+  int sample_fre = sample_rate;
+  int mclk_fre = sample_fre * MCLK_DIV_FRE;
+  int coeff = get_coeff(mclk_fre, sample_fre);
+  if (coeff < 0) {
+    ESP_LOGE(TAG, "Unable to configure sample rate %dHz with %dHz MCLK", sample_fre, mclk_fre);
+    return ESP_FAIL;
+  }
+  /*
+   * Set clock parameters
+   */
+  uint8_t regv = es8311_read_reg(ES8311_CLK_MANAGER_REG02) & 0x07;
+  regv |= (coeff_div[coeff].pre_div - 1) << 5;
+  uint8_t datmp = 0;
+  switch (coeff_div[coeff].pre_multi) {
+  case 1:
+    datmp = 0;
+    break;
+  case 2:
+    datmp = 1;
+    break;
+  case 4:
+    datmp = 2;
+    break;
+  case 8:
+    datmp = 3;
+    break;
+  default:
+    break;
+  }
+
+  if (ES8311_MCLK_SOURCE == FROM_SCLK_PIN) {
+    datmp = 3; /* DIG_MCLK = LRCK * 256 = BCLK * 8 */
+  }
+  regv |= (datmp) << 3;
+  ret |= es8311_write_reg(ES8311_CLK_MANAGER_REG02, regv);
+
+  regv = es8311_read_reg(ES8311_CLK_MANAGER_REG05) & 0x00;
+  regv |= (coeff_div[coeff].adc_div - 1) << 4;
+  regv |= (coeff_div[coeff].dac_div - 1) << 0;
+  ret |= es8311_write_reg(ES8311_CLK_MANAGER_REG05, regv);
+
+  regv = es8311_read_reg(ES8311_CLK_MANAGER_REG03) & 0x80;
+  regv |= coeff_div[coeff].fs_mode << 6;
+  regv |= coeff_div[coeff].adc_osr << 0;
+  ret |= es8311_write_reg(ES8311_CLK_MANAGER_REG03, regv);
+
+  regv = es8311_read_reg(ES8311_CLK_MANAGER_REG04) & 0x80;
+  regv |= coeff_div[coeff].dac_osr << 0;
+  ret |= es8311_write_reg(ES8311_CLK_MANAGER_REG04, regv);
+
+  regv = es8311_read_reg(ES8311_CLK_MANAGER_REG07) & 0xC0;
+  regv |= coeff_div[coeff].lrck_h << 0;
+  ret |= es8311_write_reg(ES8311_CLK_MANAGER_REG07, regv);
+
+  regv = es8311_read_reg(ES8311_CLK_MANAGER_REG08) & 0x00;
+  regv |= coeff_div[coeff].lrck_l << 0;
+  ret |= es8311_write_reg(ES8311_CLK_MANAGER_REG08, regv);
+
+  regv = es8311_read_reg(ES8311_CLK_MANAGER_REG06) & 0xE0;
+  if (coeff_div[coeff].bclk_div < 19) {
+    regv |= (coeff_div[coeff].bclk_div - 1) << 0;
+  } else {
+    regv |= (coeff_div[coeff].bclk_div) << 0;
+  }
+  ret |= es8311_write_reg(ES8311_CLK_MANAGER_REG06, regv);
+
+  return ret;
+}
+
 esp_err_t es8311_codec_deinit() { return ESP_OK; }
 
 esp_err_t es8311_config_fmt(es_i2s_fmt_t fmt) {

components/codec/es8311/es8311.hpp

@@ -214,6 +214,17 @@ esp_err_t es8311_codec_get_voice_volume(int *volume);
  */
 esp_err_t es8311_config_fmt(es_i2s_fmt_t fmt);
 
+/**
+ * @brief Configure ES8311 data sample rate
+ *
+ * @param sample_rate:  data sample rate
+ *
+ * @return
+ *     - ESP_OK
+ *     - ESP_FAIL
+ */
+esp_err_t es8311_codec_set_sample_rate(int sample_rate);
+
 /**
  * @brief Configure ES8311 data sample bits
  *