tas58xx.h

Go to the documentation of this file.

#pragma once
 
#include <array>
 
#include "esphome/components/audio_dac/audio_dac.h"
#include "esphome/components/i2c/i2c.h"
#include "esphome/core/component.h"
#include "esphome/core/hal.h"
#include "esphome/core/log.h"
 
#ifdef USE_BINARY_SENSOR
#include "esphome/components/binary_sensor/binary_sensor.h"
#endif
 
namespace esphome::tas58xx {
 
enum DacMode : uint8_t {
  DAC_MODE_BTL = 0,   // Bridge tied load, two speakers
  DAC_MODE_PBTL = 1,  // Parallel bridge tied load, one speaker
};
 
enum MixerMode : uint8_t {
  MIXER_MODE_STEREO = 0,
  MIXER_MODE_STEREO_INVERSE,
  MIXER_MODE_MONO,
  MIXER_MODE_LEFT,
  MIXER_MODE_RIGHT,
};
 
enum FaultSensor : uint8_t {
  // Faults common to TAS5805M and TAS5825M
  FAULT_SENSOR_LEFT_CHANNEL_DC_FAULT,
  FAULT_SENSOR_RIGHT_CHANNEL_DC_FAULT,
  FAULT_SENSOR_LEFT_CHANNEL_OVER_CURRENT,
  FAULT_SENSOR_RIGHT_CHANNEL_OVER_CURRENT,
  FAULT_SENSOR_OTP_CRC_CHECK,
  FAULT_SENSOR_BQ_WRITE_FAILED,
  FAULT_SENSOR_CLOCK_FAULT,
  FAULT_SENSOR_PVDD_OVER_VOLTAGE,
  FAULT_SENSOR_PVDD_UNDER_VOLTAGE,
  FAULT_SENSOR_OVER_TEMP_SHUTDOWN,
  FAULT_SENSOR_OVER_TEMP_WARNING,
  // Faults available for TAS5825M Only
  FAULT_SENSOR_LOAD_EEPROM_ERROR,
  FAULT_SENSOR_RIGHT_CHANNEL_CBC_OVER_CURRENT,
  FAULT_SENSOR_LEFT_CHANNEL_CBC_OVER_CURRENT,
  FAULT_SENSOR_LEFT_CHANNEL_CBC_OVER_CURRENT_WARNING,
  FAULT_SENSOR_RIGHT_CHANNEL_CBC_OVER_CURRENT_WARNING,
  FAULT_SENSOR_OVER_TEMP_146C_WARNING,
  // FAULT_SENSOR_OVER_TEMP_122C_WARNING,
  // FAULT_SENSOR_OVER_TEMP_112C_WARNING,
  FAULT_SENSOR_COUNT,  // keep last
};
 
// compile time check
static_assert(
    FAULT_SENSOR_COUNT == 17,
    "enum FaultSensor altered: Update FAULT_SENSORS in binary_sensor.py and fault_sensor_bits in each model's cpp");
 
static constexpr uint8_t NO_BIT = 0xFF;
 
struct ModelInfo {
  const LogString *(*name)();
  const uint8_t (*startup_sequence)[2];
  uint8_t startup_sequence_length;
  uint8_t mixer_book;
  uint8_t mixer_page;
  uint8_t mixer_register;
  uint32_t fault_error_mask;
  uint32_t fault_warning_mask;
  uint32_t fault_output_off_mask;
  uint32_t fault_latched_mask;
  const LogString *(*fault_name)(uint8_t index);
  uint8_t fault_sensor_bits[FAULT_SENSOR_COUNT];
};
 
#ifdef USE_TAS58XX_TAS5805M
extern const ModelInfo TAS5805M_MODEL;
#endif
#ifdef USE_TAS58XX_TAS5825M
extern const ModelInfo TAS5825M_MODEL;
#endif
 
class TAS58xx : public audio_dac::AudioDac, public PollingComponent, public i2c::I2CDevice {
 public:
  explicit TAS58xx(const ModelInfo *model) : model_(model) {}
 
  void setup() override;
  void dump_config() override;
  float get_setup_priority() const override { return setup_priority::IO; }
  void update() override;
 
  void activate();
  void deactivate();
 
  bool set_mute_off() override { return this->set_mute_(false); }
  bool set_mute_on() override { return this->set_mute_(true); }
  bool set_volume(float volume) override;
 
  bool is_muted() override { return this->is_muted_; }
  float volume() override { return this->volume_; }
 
  void on_audio_started() override;
 
  void set_enable_pin(GPIOPin *enable_pin) { this->enable_pin_ = enable_pin; }
  void set_analog_gain(float analog_gain_db) { this->analog_gain_db_ = analog_gain_db; }
  void set_dac_mode(DacMode dac_mode) { this->dac_mode_ = dac_mode; }
  void set_mixer_mode(MixerMode mixer_mode) { this->mixer_mode_ = mixer_mode; }
  void set_volume_min_db(float volume_min_db) { this->volume_min_db_ = volume_min_db; }
  void set_volume_max_db(float volume_max_db) { this->volume_max_db_ = volume_max_db; }
 
#ifdef USE_BINARY_SENSOR
  SUB_BINARY_SENSOR(have_fault)
  void set_fault_binary_sensor(FaultSensor fault, binary_sensor::BinarySensor *sensor) {
    this->fault_binary_sensors_[fault] = sensor;
  }
#endif
 
 protected:
  bool select_book_page_(uint8_t book, uint8_t page);
  bool init_();
  bool write_ctrl_state_(uint8_t state, bool muted);
  bool set_mute_(bool muted);
  bool write_volume_();
  bool write_mixer_();
  bool read_faults_();
 
  const ModelInfo *model_;
  GPIOPin *enable_pin_{nullptr};
#ifdef USE_BINARY_SENSOR
  std::array<binary_sensor::BinarySensor *, FAULT_SENSOR_COUNT> fault_binary_sensors_{};
#endif
  float volume_{0};
  float analog_gain_db_{-15.5f};
  float volume_min_db_{-103.0f};
  float volume_max_db_{24.0f};
  uint32_t logged_faults_{0};  // Fault bits as last logged, packed like the fault masks
  DacMode dac_mode_{DAC_MODE_BTL};
  MixerMode mixer_mode_{MIXER_MODE_STEREO};
  uint8_t ctrl_state_{0};
  uint8_t power_state_{0xFF};  // Last POWER_STATE seen by update(), 0xFF until the first read
  bool mixer_written_{false};  // Mixer written since the last reset
};
 
}  // namespace esphome::tas58xx