[es8311] Add es8311 dac component (esphome#7693)

vjurka · Oct 30, 2024 · 765579d · 765579d
1 parent 6afd004
commit 765579d
Show file tree

Hide file tree

Showing 14 changed files with 670 additions and 3 deletions.
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -131,6 +131,7 @@ esphome/components/ens160_base/* @latonita @vincentscode
 esphome/components/ens160_i2c/* @latonita
 esphome/components/ens160_spi/* @latonita
 esphome/components/ens210/* @itn3rd77
+esphome/components/es8311/* @kahrendt @kroimon
 esphome/components/esp32/* @esphome/core
 esphome/components/esp32_ble/* @Rapsssito @jesserockz
 esphome/components/esp32_ble_client/* @jesserockz

diff --git a/esphome/components/es8311/__init__.py b/esphome/components/es8311/__init__.py
diff --git a/esphome/components/es8311/audio_dac.py b/esphome/components/es8311/audio_dac.py
@@ -0,0 +1,70 @@
+import esphome.codegen as cg
+from esphome.components import i2c
+from esphome.components.audio_dac import AudioDac
+import esphome.config_validation as cv
+from esphome.const import CONF_BITS_PER_SAMPLE, CONF_ID, CONF_SAMPLE_RATE
+
+CODEOWNERS = ["@kroimon", "@kahrendt"]
+DEPENDENCIES = ["i2c"]
+
+es8311_ns = cg.esphome_ns.namespace("es8311")
+ES8311 = es8311_ns.class_("ES8311", AudioDac, cg.Component, i2c.I2CDevice)
+
+CONF_MIC_GAIN = "mic_gain"
+CONF_USE_MCLK = "use_mclk"
+CONF_USE_MICROPHONE = "use_microphone"
+
+es8311_resolution = es8311_ns.enum("ES8311Resolution")
+ES8311_BITS_PER_SAMPLE_ENUM = {
+    16: es8311_resolution.ES8311_RESOLUTION_16,
+    24: es8311_resolution.ES8311_RESOLUTION_24,
+    32: es8311_resolution.ES8311_RESOLUTION_32,
+}
+
+es8311_mic_gain = es8311_ns.enum("ES8311MicGain")
+ES8311_MIC_GAIN_ENUM = {
+    "MIN": es8311_mic_gain.ES8311_MIC_GAIN_MIN,
+    "0DB": es8311_mic_gain.ES8311_MIC_GAIN_0DB,
+    "6DB": es8311_mic_gain.ES8311_MIC_GAIN_6DB,
+    "12DB": es8311_mic_gain.ES8311_MIC_GAIN_12DB,
+    "18DB": es8311_mic_gain.ES8311_MIC_GAIN_18DB,
+    "24DB": es8311_mic_gain.ES8311_MIC_GAIN_24DB,
+    "30DB": es8311_mic_gain.ES8311_MIC_GAIN_30DB,
+    "36DB": es8311_mic_gain.ES8311_MIC_GAIN_36DB,
+    "42DB": es8311_mic_gain.ES8311_MIC_GAIN_42DB,
+    "MAX": es8311_mic_gain.ES8311_MIC_GAIN_MAX,
+}
+
+
+_validate_bits = cv.float_with_unit("bits", "bit")
+
+CONFIG_SCHEMA = (
+    cv.Schema(
+        {
+            cv.GenerateID(): cv.declare_id(ES8311),
+            cv.Optional(CONF_BITS_PER_SAMPLE, default="16bit"): cv.All(
+                _validate_bits, cv.enum(ES8311_BITS_PER_SAMPLE_ENUM)
+            ),
+            cv.Optional(CONF_MIC_GAIN, default="42DB"): cv.enum(
+                ES8311_MIC_GAIN_ENUM, upper=True
+            ),
+            cv.Optional(CONF_SAMPLE_RATE, default=16000): cv.int_range(min=1),
+            cv.Optional(CONF_USE_MCLK, default=True): cv.boolean,
+            cv.Optional(CONF_USE_MICROPHONE, default=False): cv.boolean,
+        }
+    )
+    .extend(cv.COMPONENT_SCHEMA)
+    .extend(i2c.i2c_device_schema(0x18))
+)
+
+
+async def to_code(config):
+    var = cg.new_Pvariable(config[CONF_ID])
+    await cg.register_component(var, config)
+    await i2c.register_i2c_device(var, config)
+
+    cg.add(var.set_bits_per_sample(config[CONF_BITS_PER_SAMPLE]))
+    cg.add(var.set_mic_gain(config[CONF_MIC_GAIN]))
+    cg.add(var.set_sample_frequency(config[CONF_SAMPLE_RATE]))
+    cg.add(var.set_use_mclk(config[CONF_USE_MCLK]))
+    cg.add(var.set_use_mic(config[CONF_USE_MICROPHONE]))
diff --git a/esphome/components/es8311/es8311.cpp b/esphome/components/es8311/es8311.cpp
@@ -0,0 +1,227 @@
+#include "es8311.h"
+#include "es8311_const.h"
+#include "esphome/core/hal.h"
+#include "esphome/core/log.h"
+#include <cinttypes>
+
+namespace esphome {
+namespace es8311 {
+
+static const char *const TAG = "es8311";
+
+// Mark the component as failed; use only in setup
+#define ES8311_ERROR_FAILED(func) \
+  if (!(func)) { \
+    this->mark_failed(); \
+    return; \
+  }
+// Return false; use outside of setup
+#define ES8311_ERROR_CHECK(func) \
+  if (!(func)) { \
+    return false; \
+  }
+
+void ES8311::setup() {
+  ESP_LOGCONFIG(TAG, "Setting up ES8311...");
+
+  // Reset
+  ES8311_ERROR_FAILED(this->write_byte(ES8311_REG00_RESET, 0x1F));
+  ES8311_ERROR_FAILED(this->write_byte(ES8311_REG00_RESET, 0x00));
+
+  ES8311_ERROR_FAILED(this->configure_clock_());
+  ES8311_ERROR_FAILED(this->configure_format_());
+  ES8311_ERROR_FAILED(this->configure_mic_());
+
+  // Set initial volume
+  this->set_volume(0.75);  // 0.75 = 0xBF = 0dB
+
+  // Power up analog circuitry
+  ES8311_ERROR_FAILED(this->write_byte(ES8311_REG0D_SYSTEM, 0x01));
+  // Enable analog PGA, enable ADC modulator
+  ES8311_ERROR_FAILED(this->write_byte(ES8311_REG0E_SYSTEM, 0x02));
+  // Power up DAC
+  ES8311_ERROR_FAILED(this->write_byte(ES8311_REG12_SYSTEM, 0x00));
+  // Enable output to HP drive
+  ES8311_ERROR_FAILED(this->write_byte(ES8311_REG13_SYSTEM, 0x10));
+  // ADC Equalizer bypass, cancel DC offset in digital domain
+  ES8311_ERROR_FAILED(this->write_byte(ES8311_REG1C_ADC, 0x6A));
+  // Bypass DAC equalizer
+  ES8311_ERROR_FAILED(this->write_byte(ES8311_REG37_DAC, 0x08));
+  // Power On
+  ES8311_ERROR_FAILED(this->write_byte(ES8311_REG00_RESET, 0x80));
+}
+
+void ES8311::dump_config() {
+  ESP_LOGCONFIG(TAG, "ES8311 Audio Codec:");
+  ESP_LOGCONFIG(TAG, "  Use MCLK: %s", YESNO(this->use_mclk_));
+  ESP_LOGCONFIG(TAG, "  Use Microphone: %s", YESNO(this->use_mic_));
+  ESP_LOGCONFIG(TAG, "  DAC Bits per Sample: %" PRIu8, this->resolution_out_);
+  ESP_LOGCONFIG(TAG, "  Sample Rate: %" PRIu32, this->sample_frequency_);
+
+  if (this->is_failed()) {
+    ESP_LOGCONFIG(TAG, "  Failed to initialize!");
+    return;
+  }
+}
+
+bool ES8311::set_volume(float volume) {
+  volume = clamp(volume, 0.0f, 1.0f);
+  uint8_t reg32 = remap<uint8_t, float>(volume, 0.0f, 1.0f, 0, 255);
+  return this->write_byte(ES8311_REG32_DAC, reg32);
+}
+
+float ES8311::volume() {
+  uint8_t reg32;
+  this->read_byte(ES8311_REG32_DAC, &reg32);
+  return remap<float, uint8_t>(reg32, 0, 255, 0.0f, 1.0f);
+}
+
+uint8_t ES8311::calculate_resolution_value(ES8311Resolution resolution) {
+  switch (resolution) {
+    case ES8311_RESOLUTION_16:
+      return (3 << 2);
+    case ES8311_RESOLUTION_18:
+      return (2 << 2);
+    case ES8311_RESOLUTION_20:
+      return (1 << 2);
+    case ES8311_RESOLUTION_24:
+      return (0 << 2);
+    case ES8311_RESOLUTION_32:
+      return (4 << 2);
+    default:
+      return 0;
+  }
+}
+
+const ES8311Coefficient *ES8311::get_coefficient(uint32_t mclk, uint32_t rate) {
+  for (const auto &coefficient : ES8311_COEFFICIENTS) {
+    if (coefficient.mclk == mclk && coefficient.rate == rate)
+      return &coefficient;
+  }
+  return nullptr;
+}
+
+bool ES8311::configure_clock_() {
+  // Register 0x01: select clock source for internal MCLK and determine its frequency
+  uint8_t reg01 = 0x3F;  // Enable all clocks
+
+  uint32_t mclk_frequency = this->sample_frequency_ * this->mclk_multiple_;
+  if (!this->use_mclk_) {
+    reg01 |= BIT(7);  // Use SCLK
+    mclk_frequency = this->sample_frequency_ * (int) this->resolution_out_ * 2;
+  }
+  if (this->mclk_inverted_) {
+    reg01 |= BIT(6);  // Invert MCLK pin
+  }
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG01_CLK_MANAGER, reg01));
+
+  // Get clock coefficients from coefficient table
+  auto *coefficient = get_coefficient(mclk_frequency, this->sample_frequency_);
+  if (coefficient == nullptr) {
+    ESP_LOGE(TAG, "Unable to configure sample rate %" PRIu32 "Hz with %" PRIu32 "Hz MCLK", this->sample_frequency_,
+             mclk_frequency);
+    return false;
+  }
+
+  // Register 0x02
+  uint8_t reg02;
+  ES8311_ERROR_CHECK(this->read_byte(ES8311_REG02_CLK_MANAGER, &reg02));
+  reg02 &= 0x07;
+  reg02 |= (coefficient->pre_div - 1) << 5;
+  reg02 |= coefficient->pre_mult << 3;
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG02_CLK_MANAGER, reg02));
+
+  // Register 0x03
+  const uint8_t reg03 = (coefficient->fs_mode << 6) | coefficient->adc_osr;
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG03_CLK_MANAGER, reg03));
+
+  // Register 0x04
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG04_CLK_MANAGER, coefficient->dac_osr));
+
+  // Register 0x05
+  const uint8_t reg05 = ((coefficient->adc_div - 1) << 4) | (coefficient->dac_div - 1);
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG05_CLK_MANAGER, reg05));
+
+  // Register 0x06
+  uint8_t reg06;
+  ES8311_ERROR_CHECK(this->read_byte(ES8311_REG06_CLK_MANAGER, &reg06));
+  if (this->sclk_inverted_) {
+    reg06 |= BIT(5);
+  } else {
+    reg06 &= ~BIT(5);
+  }
+  reg06 &= 0xE0;
+  if (coefficient->bclk_div < 19) {
+    reg06 |= (coefficient->bclk_div - 1) << 0;
+  } else {
+    reg06 |= (coefficient->bclk_div) << 0;
+  }
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG06_CLK_MANAGER, reg06));
+
+  // Register 0x07
+  uint8_t reg07;
+  ES8311_ERROR_CHECK(this->read_byte(ES8311_REG07_CLK_MANAGER, &reg07));
+  reg07 &= 0xC0;
+  reg07 |= coefficient->lrck_h << 0;
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG07_CLK_MANAGER, reg07));
+
+  // Register 0x08
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG08_CLK_MANAGER, coefficient->lrck_l));
+
+  // Successfully configured the clock
+  return true;
+}
+
+bool ES8311::configure_format_() {
+  // Configure I2S mode and format
+  uint8_t reg00;
+  ES8311_ERROR_CHECK(this->read_byte(ES8311_REG00_RESET, &reg00));
+  reg00 &= 0xBF;
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG00_RESET, reg00));
+
+  // Configure SDP in resolution
+  uint8_t reg09 = calculate_resolution_value(this->resolution_in_);
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG09_SDPIN, reg09));
+
+  // Configure SDP out resolution
+  uint8_t reg0a = calculate_resolution_value(this->resolution_out_);
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG0A_SDPOUT, reg0a));
+
+  // Successfully configured the format
+  return true;
+}
+
+bool ES8311::configure_mic_() {
+  uint8_t reg14 = 0x1A;  // Enable analog MIC and max PGA gain
+  if (this->use_mic_) {
+    reg14 |= BIT(6);  // Enable PDM digital microphone
+  }
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG14_SYSTEM, reg14));
+
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG16_ADC, this->mic_gain_));  // ADC gain scale up
+  ES8311_ERROR_CHECK(this->write_byte(ES8311_REG17_ADC, 0xC8));             // Set ADC gain
+
+  // Successfully configured the microphones
+  return true;
+}
+
+bool ES8311::set_mute_state_(bool mute_state) {
+  uint8_t reg31;
+
+  this->is_muted_ = mute_state;
+
+  if (!this->read_byte(ES8311_REG31_DAC, &reg31)) {
+    return false;
+  }
+
+  if (mute_state) {
+    reg31 |= BIT(6) | BIT(5);
+  } else {
+    reg31 &= ~(BIT(6) | BIT(5));
+  }
+
+  return this->write_byte(ES8311_REG31_DAC, reg31);
+}
+
+}  // namespace es8311
+}  // namespace esphome