ErosQ New Revision HW volume

Add HW volume control via ES9018K2M, and reorganize
eros_qn_codec.c/.h, audiohw-erosqnative.c.

This automatically detects the presence of the new DAC and
uses its hardware volume scaling. If not present, use same
SWVOL we have been using so far.

Add debug menu readout of SWVOL/I2C result.

Break out es9018k2m stuff into its own file so that
maybe it can be useful to other ports.

Note that we may need to get smarter about detecting the DAC
type if/when another model emerges.

Change-Id: I586a1cf7f150dd6b4e221157859825952840af56

3 files changed, 133 insertions, 40 deletions

diff --git a/firmware/drivers/audio/eros_qn_codec.c b/firmware/drivers/audio/eros_qn_codec.c
index 39a421ee92..095b3b5305 100644
--- a/firmware/drivers/audio/eros_qn_codec.c
+++ b/firmware/drivers/audio/eros_qn_codec.c
@@ -26,56 +26,30 @@
 #include "audiohw.h"
 #include "settings.h"
 #include "pcm_sw_volume.h"
-#include "gpio-x1000.h"
 
-static long int vol_l_hw = 0;
-static long int vol_r_hw = 0;
+#include "gpio-x1000.h"
 
-/* internal: Switch the output sink. 0 - headphones, 1 - line out */
-void audiohw_switch_output(int select);
+static long int vol_l_hw = PCM5102A_VOLUME_MIN;
+static long int vol_r_hw = PCM5102A_VOLUME_MIN;
+int es9018k2m_present_flag = 0;
 
-void dac_set_outputs(void)
+void eros_qn_set_outputs(void)
 {
     audiohw_set_volume(vol_l_hw, vol_r_hw);
 }
 
-/* this makes less sense here than it does in the audiohw-*.c file,
- * but we need access to settings.h */
-void audiohw_set_volume(int vol_l, int vol_r)
+void eros_qn_set_last_vol(long int vol_l, long int vol_r)
 {
-    int l, r;
-
     vol_l_hw = vol_l;
     vol_r_hw = vol_r;
+}
 
-    l = vol_l;
-    r = vol_r;
-
-#if (defined(HAVE_HEADPHONE_DETECTION) && defined(HAVE_LINEOUT_DETECTION))
-    /* make sure headphones aren't present - don't want to
-     * blow out our eardrums cranking it to full */
-    if (lineout_inserted() && !headphones_inserted())
-    {
-        audiohw_switch_output(1);
-
-        l = r = global_settings.volume_limit * 10;
-    }
-    else
-    {
-        audiohw_switch_output(0);
-        
-        l = vol_l;
-        r = vol_r;
-    }
-#endif
-
-    l = l <= PCM5102A_VOLUME_MIN ? PCM_MUTE_LEVEL : (l / 20);
-    r = r <= PCM5102A_VOLUME_MIN ? PCM_MUTE_LEVEL : (r / 20);
-
-    pcm_set_master_volume(l, r);
+int eros_qn_get_volume_limit(void)
+{
+    return (global_settings.volume_limit * 10);
 }
 
-void audiohw_switch_output(int select)
+void eros_qn_switch_output(int select)
 {
     if (select == 0)
     {
@@ -85,4 +59,4 @@ void audiohw_switch_output(int select)
     {
         gpio_set_level(GPIO_STEREOSW_SEL, 1);
     }
-}
+}
\ No newline at end of file
diff --git a/firmware/drivers/audio/es9018.c b/firmware/drivers/audio/es9018.c
index 89e8c1d46f..6a73f7a2d3 100644
--- a/firmware/drivers/audio/es9018.c
+++ b/firmware/drivers/audio/es9018.c
@@ -25,8 +25,8 @@
 #include "audio.h"
 #include "audiohw.h"
 
-/* NOTE:  The register names are not known, as the register numbering
-   listed in the ES9018 datasheet does not match what is described below.. */
+/* NOTE: This implementation is specifically for the ES9018K2M, which has a different register
+ * structure from the ES9018. */
 
 static uint8_t reg0  = 0x00; /* System settings. Default value of register 0 */
 static uint8_t reg1  = 0x80; /* Input settings. Manual input, I2S, 32-bit (?) */
diff --git a/firmware/drivers/audio/es9018k2m.c b/firmware/drivers/audio/es9018k2m.c
new file mode 100644
index 0000000000..e19cf6e8a9
--- /dev/null
+++ b/firmware/drivers/audio/es9018k2m.c
@@ -0,0 +1,119 @@
+/***************************************************************************
+ *             __________               __   ___.
+ *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
+ *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
+ *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
+ *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
+ *                     \/            \/     \/    \/            \/
+ * $Id$
+ *
+ *
+ * Copyright (c) 2023 Dana Conrad
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+ * KIND, either express or implied.
+ *
+ ****************************************************************************/
+
+#include "system.h"
+#include "es9018k2m.h"
+#include "i2c-async.h"
+#include "action.h"
+
+//======================================================================================
+// ES9018K2M support stuff
+
+#ifndef ES9018K2M_BUS
+# error "No definition for ES9018K2M I2C bus!"
+#endif
+
+#ifndef ES9018K2M_ADDR
+# error "No definition for ES9018K2M I2C address!"
+#endif
+
+static int vol_tenthdb2hw(const int tdb)
+{
+    if (tdb < ES9018K2M_VOLUME_MIN) {
+        return 0xff;
+    } else if (tdb > ES9018K2M_VOLUME_MAX) {
+        return 0x00;
+    } else {
+        return (-tdb/5);
+    }
+}
+
+/* NOTE: This implementation is for the ES9018K2M specifically. */
+/* Register defaults from the datasheet. */
+/* These are basically just for reference. All defaults work out for us.
+ * static uint8_t reg0_system_settings         = 0x00; // System settings. Default value of register 0
+ * static uint8_t reg1_input_configuration     = 0x8C; // Input settings. I2S input, 32-bit
+ * static uint8_t reg4_automute_time           = 0x00; // Automute time. Default = disabled
+ * static uint8_t reg5_automute_level          = 0x68; // Automute level. Default is some level
+ * static uint8_t reg6_deemphasis              = 0x4A; // Deemphasis. Default = disabled
+ * static uint8_t reg7_general_settings        = 0x80; // General settings. Default sharp fir, pcm iir and unmuted
+ * static uint8_t reg8_gpio_configuration      = 0x10; // GPIO configuration
+ * static uint8_t reg10_master_mode_control    = 0x05; // Master Mode Control. Default value: master mode off
+ * static uint8_t reg11_channel_mapping        = 0x02; // Channel Mapping. Default stereo is Ch1=left, Ch2=right
+ * static uint8_t reg12_dpll_settings          = 0x5A; // DPLL Settings. Default = 5 for I2S, A for DSD
+ * static uint8_t reg13_thd_comp               = 0x40; // THD Compensation
+ * static uint8_t reg14_softstart_settings     = 0x8A; // Soft Start Settings
+ * static uint8_t reg21_gpio_input_selection   = 0x00; // Oversampling filter. Default: oversampling ON
+ */
+
+static uint8_t vol_reg_l = ES9018K2M_REG15_VOLUME_L;
+static uint8_t reg15_vol_l = 0;
+i2c_descriptor vol_desc_l = {
+    .slave_addr = ES9018K2M_ADDR,
+    .bus_cond = I2C_START | I2C_STOP,
+    .tran_mode = I2C_WRITE,
+    .buffer[0] = &vol_reg_l,
+    .count[0] = 1,
+    .buffer[1] = &reg15_vol_l,
+    .count[1] = 1,
+    .callback = NULL,
+    .arg = 0,
+    .next = NULL,
+};
+
+static uint8_t vol_reg_r = ES9018K2M_REG16_VOLUME_R;
+static uint8_t reg16_vol_r = 0;
+i2c_descriptor vol_desc_r = {
+    .slave_addr = ES9018K2M_ADDR,
+    .bus_cond = I2C_START | I2C_STOP,
+    .tran_mode = I2C_WRITE,
+    .buffer[0] = &vol_reg_r,
+    .count[0] = 1,
+    .buffer[1] = &reg16_vol_r,
+    .count[1] = 1,
+    .callback = NULL,
+    .arg = 0,
+    .next = NULL,
+};
+
+void es9018k2m_set_volume(int vol_l, int vol_r)
+{
+    /* Queue writes to the DAC's volume.
+     * Note that this needs to be done asynchronously. From testing, calling
+     * synchronous writes from HP/LO detect causes hangs. */
+    reg15_vol_l = vol_tenthdb2hw(vol_l);
+    reg16_vol_r = vol_tenthdb2hw(vol_r);
+    i2c_async_queue(ES9018K2M_BUS, TIMEOUT_NOBLOCK, I2C_Q_ADD, 0, &vol_desc_l);
+    i2c_async_queue(ES9018K2M_BUS, TIMEOUT_NOBLOCK, I2C_Q_ADD, 0, &vol_desc_r);
+}
+
+/* returns I2C_STATUS_OK upon success, I2C_STATUS_* errors upon error */
+int es9018k2m_write_reg(uint8_t reg, uint8_t val)
+{
+    return i2c_reg_write1(ES9018K2M_BUS, ES9018K2M_ADDR, reg, val);
+}
+
+/* returns register value, or -1 upon error */
+int es9018k2m_read_reg(uint8_t reg)
+{
+    return i2c_reg_read1(ES9018K2M_BUS, ES9018K2M_ADDR, reg);
+}
\ No newline at end of file