New port: FiiO M3K on bare metal

Change-Id: I7517e7d5459e129dcfc9465c6fbd708619888fbe

6 files changed, 402 insertions, 0 deletions

diff --git a/firmware/export/ak4376.h b/firmware/export/ak4376.h
new file mode 100644
index 0000000000..eb06755e92
--- /dev/null
+++ b/firmware/export/ak4376.h
@@ -0,0 +1,152 @@
+/***************************************************************************
+ *             __________               __   ___.
+ *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
+ *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
+ *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
+ *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
+ *                     \/            \/     \/    \/            \/
+ * $Id$
+ *
+ * Copyright (C) 2021 Aidan MacDonald
+ *
+ * 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.
+ *
+ ****************************************************************************/
+
+#ifndef __AK4376_H__
+#define __AK4376_H__
+
+#define AUDIOHW_CAPS (FILTER_ROLL_OFF_CAP|POWER_MODE_CAP)
+#define AUDIOHW_HAVE_SHORT2_ROLL_OFF
+
+#define AK4376_MIN_VOLUME (-890)
+#define AK4376_MAX_VOLUME 150
+
+AUDIOHW_SETTING(VOLUME, "dB", 1, 5, AK4376_MIN_VOLUME, AK4376_MAX_VOLUME, -200)
+AUDIOHW_SETTING(FILTER_ROLL_OFF, "", 0, 1, 0, 3, 0)
+AUDIOHW_SETTING(POWER_MODE, "", 0, 1, 0, 1, 0)
+
+/* Register addresses */
+#define AK4376_REG_PWR1         0x00
+#define AK4376_REG_PWR2         0x01
+#define AK4376_REG_PWR3         0x02
+#define AK4376_REG_PWR4         0x03
+#define AK4376_REG_OUTPUT_MODE  0x04
+#define AK4376_REG_CLOCK_MODE   0x05
+#define AK4376_REG_FILTER       0x06
+#define AK4376_REG_MIXER        0x07
+#define AK4376_REG_LCH_VOLUME   0x0b
+#define AK4376_REG_RCH_VOLUME   0x0c
+#define AK4376_REG_AMP_VOLUME   0x0d
+#define AK4376_REG_PLL_CLK_SRC  0x0e
+#define AK4376_REG_PLL_REF_DIV1 0x0f
+#define AK4376_REG_PLL_REF_DIV2 0x10
+#define AK4376_REG_PLL_FB_DIV1  0x11
+#define AK4376_REG_PLL_FB_DIV2  0x12
+#define AK4376_REG_DAC_CLK_SRC  0x13
+#define AK4376_REG_DAC_CLK_DIV  0x14
+#define AK4376_REG_AUDIO_IF_FMT 0x15
+#define AK4376_REG_CHIP_ID      0x21
+#define AK4376_REG_MODE_CTRL    0x24
+#define AK4376_REG_ADJUST1      0x26
+#define AK4376_REG_ADJUST2      0x2a
+#define AK4376_NUM_REGS         0x2b
+
+/* Mixer controls, simply OR them together.
+ * LCH    = add LCH signal to output
+ * RCH    = add RCH signal to output
+ * HALF   = multiply output by 1/2
+ * INVERT = invert the output after everything else
+ */
+#define AK4376_MIX_MUTE   0
+#define AK4376_MIX_LCH    1
+#define AK4376_MIX_RCH    2
+#define AK4376_MIX_HALF   4
+#define AK4376_MIX_INVERT 8
+
+/* Min/max digital volumes in units of dB/10 */
+#define AK4376_DIG_VOLUME_MIN (-120)
+#define AK4376_DIG_VOLUME_MAX 30
+#define AK4376_DIG_VOLUME_STEP 5
+#define AK4376_DIG_VOLUME_MUTE (AK4376_DIG_VOLUME_MIN - 1)
+
+/* Min/max headphone amp volumes in units of dB/10 */
+#define AK4376_AMP_VOLUME_MIN (-200)
+#define AK4376_AMP_VOLUME_MAX 60
+#define AK4376_AMP_VOLUME_STEP 20
+#define AK4376_AMP_VOLUME_MUTE (AK4376_AMP_VOLUME_MIN - 1)
+
+/* Digital filters */
+#define AK4376_FILTER_SHARP       0
+#define AK4376_FILTER_SLOW        1
+#define AK4376_FILTER_SHORT_SHARP 2
+#define AK4376_FILTER_SHORT_SLOW  3
+
+/* Frequency selection */
+#define AK4376_FS_8   0
+#define AK4376_FS_11  1
+#define AK4376_FS_12  2
+#define AK4376_FS_16  4
+#define AK4376_FS_22  5
+#define AK4376_FS_24  6
+#define AK4376_FS_32  8
+#define AK4376_FS_44  9
+#define AK4376_FS_48  10
+#define AK4376_FS_64  12
+#define AK4376_FS_88  13
+#define AK4376_FS_96  14
+#define AK4376_FS_176 17
+#define AK4376_FS_192 18
+
+/* Functions to power on / off the DAC which should be called from
+ * the target's audiohw_init() / audiohw_close() implementation.
+ */
+extern void ak4376_init(void);
+extern void ak4376_close(void);
+
+/* Register read/write. Cached to avoid redundant reads/writes. */
+extern void ak4376_write(int reg, int value);
+extern int  ak4376_read(int reg);
+
+/* Target-specific function to set the PDN pin level. */
+extern void ak4376_set_pdn_pin(int level);
+
+/* Target-specific function to control the external master clock frequency.
+ * This is called by the ak4376's audiohw implementation when switching to
+ * or from a frequency that is configured to use this clock source.
+ *
+ * - hw_freq is the new sample rate -- one of the HW_FREQ_XX constants.
+ * - enabled is true if clock should be output, false if not.
+ *
+ * The return value is the master clock rate as a multiple of the sampling
+ * frequency. The allowed multiples depend on the sampling frequency, shown
+ * in the table below.
+ *
+ * +-----------+------------------------+
+ * | frequency | master clock rate      |
+ * +-----------+------------------------+
+ * |   8 -  24 | 256fs / 512fs / 1024fs |
+ * |  32 -  48 | 256fs / 512fs          |
+ * |  64 -  96 | 256fs                  |
+ * | 128 - 192 | 128fs                  |
+ * +-----------+------------------------+
+ *
+ * For example, at 48 KHz you could return either 256 or 512 depending on
+ * the rate you decided to actually use.
+ *
+ * You need to return a valid master multiplier for supported frequencies
+ * even when enabled = false, since the driver needs to know the multiplier
+ * _before_ enabling the clock.
+ *
+ * For unsupported frequencies you don't need to return a valid master
+ * multiplier, because the DAC doesn't need the return value in such cases.
+ */
+extern int ak4376_set_mclk_freq(int hw_freq, bool enabled);
+
+#endif /* __AK4376_H__ */
diff --git a/firmware/export/audiohw.h b/firmware/export/audiohw.h
index d862c977db..ceafc6ebf7 100644
--- a/firmware/export/audiohw.h
+++ b/firmware/export/audiohw.h
@@ -194,6 +194,8 @@ struct sound_settings_info
 #include "jz4740-codec.h"
 #elif defined(HAVE_AK4537)
 #include "ak4537.h"
+#elif defined(HAVE_AK4376)
+#include "ak4376.h"
 #elif defined(HAVE_RK27XX_CODEC)
 #include "rk27xx_codec.h"
 #elif defined(HAVE_AIC3X)
diff --git a/firmware/export/axp173.h b/firmware/export/axp173.h
new file mode 100644
index 0000000000..60519138e1
--- /dev/null
+++ b/firmware/export/axp173.h
@@ -0,0 +1,94 @@
+/***************************************************************************
+ *             __________               __   ___.
+ *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
+ *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
+ *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
+ *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
+ *                     \/            \/     \/    \/            \/
+ * $Id$
+ *
+ * Copyright (C) 2021 Aidan MacDonald
+ *
+ * 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.
+ *
+ ****************************************************************************/
+
+#ifndef __AXP173_H__
+#define __AXP173_H__
+
+#include <stdbool.h>
+#include <stdint.h>
+
+#define ADC_ACIN_VOLTAGE        0
+#define ADC_ACIN_CURRENT        1
+#define ADC_VBUS_VOLTAGE        2
+#define ADC_VBUS_CURRENT        3
+#define ADC_INTERNAL_TEMP       4
+#define ADC_TS_INPUT            5
+#define ADC_BATTERY_VOLTAGE     6
+#define ADC_CHARGE_CURRENT      7
+#define ADC_DISCHARGE_CURRENT   8
+#define ADC_APS_VOLTAGE         9
+#define ADC_BATTERY_POWER       10
+#define NUM_ADC_CHANNELS        11
+
+/* ADC sampling rates */
+#define AXP173_ADC_RATE_25HZ    0
+#define AXP173_ADC_RATE_50HZ    1
+#define AXP173_ADC_RATE_100HZ   2
+#define AXP173_ADC_RATE_200HZ   3
+
+/* Return values of axp173_battery_status() */
+#define AXP173_BATT_DISCHARGING   0
+#define AXP173_BATT_CHARGING      1
+#define AXP173_BATT_FULL          2
+
+/* Bits returned by axp173_input_status() */
+#define AXP173_INPUT_AC         (1 << 0)
+#define AXP173_INPUT_USB        (1 << 1)
+#define AXP173_INPUT_BATTERY    (1 << 2)
+#define AXP173_INPUT_EXTERNAL   (AXP173_INPUT_AC|AXP173_INPUT_USB)
+
+/* Must be called from power_init() to initialize the driver state */
+extern void axp173_init(void);
+
+/* Basic battery and power supply status */
+extern int axp173_battery_status(void);
+extern int axp173_input_status(void);
+
+/* ADC access -- ADCs which are not enabled will return INT_MIN if read.
+ * The output of axp173_adc_read() is normalized to appropriate units:
+ *
+ * - for voltages, the scale is millivolts
+ * - for currents, the scale is milliamps
+ * - for temperatures, the scale is tenths of a degree Celsius
+ * - for power, the scale is microwatts
+ *
+ * See the comment in axp173_adc_conv_raw() for raw value precision/scale.
+ */
+extern int axp173_adc_read(int adc);
+extern int axp173_adc_read_raw(int adc);
+extern int axp173_adc_conv_raw(int adc, int value);
+extern int axp173_adc_get_enabled(void);
+extern void axp173_adc_set_enabled(int adc_bits);
+extern int axp173_adc_get_rate(void);
+extern void axp173_adc_set_rate(int rate);
+
+/* - axp173_cc_read() reads the coulomb counters
+ * - axp173_cc_clear() resets both counters to zero
+ * - axp173_cc_enable() will stop/start the counters running
+ */
+extern void axp173_cc_read(uint32_t* charge, uint32_t* discharge);
+extern void axp173_cc_clear(void);
+extern void axp173_cc_enable(bool en);
+
+/* Debug menu */
+extern bool axp173_debug_menu(void);
+
+#endif /* __AXP173_H__ */
diff --git a/firmware/export/config.h b/firmware/export/config.h
index e35d407372..db1c589043 100644
--- a/firmware/export/config.h
+++ b/firmware/export/config.h
@@ -82,6 +82,7 @@
 #define AS3525v2    35252
 #define IMX233        233
 #define RK27XX       2700
+#define X1000        1000
 
 /* platforms
  * bit fields to allow PLATFORM_HOSTED to be OR'ed e.g. with a
@@ -165,6 +166,7 @@
 #define XDUOO_X20_PAD      70
 #define FIIO_M3K_LINUX_PAD 71
 #define EROSQ_PAD          72
+#define FIIO_M3K_PAD       73
 
 /* CONFIG_REMOTE_KEYPAD */
 #define H100_REMOTE   1
@@ -281,6 +283,7 @@
 #define LCD_IHIFI770      66 /* as used by IHIFI 770 */
 #define LCD_IHIFI770C     67 /* as used by IHIFI 770C */
 #define LCD_IHIFI800      68 /* as used by IHIFI 800 */
+#define LCD_FIIOM3K       69 /* as used by the FiiO M3K */
 
 /* LCD_PIXELFORMAT */
 #define HORIZONTAL_PACKING 1
@@ -320,6 +323,7 @@ Lyre prototype 1 */
 #define I2C_S5L8702 16 /* Same as S5L8700, but with two channels */
 #define I2C_IMX233  17
 #define I2C_RK27XX  18
+#define I2C_X1000   19
 
 /* CONFIG_LED */
 #define LED_REAL     1 /* SW controlled LED (Archos recorders, player) */
@@ -356,6 +360,7 @@ Lyre prototype 1 */
 #define RTC_IMX233   20
 #define RTC_STM41T62 21 /* ST M41T62 */
 #define RTC_JZ4760   22 /* Ingenic Jz4760 */
+#define RTC_X1000    23 /* Ingenic X1000 */
 
 /* USB On-the-go */
 #define USBOTG_M66591   6591 /* M:Robe 500 */
@@ -605,6 +610,8 @@ Lyre prototype 1 */
 #include "config/xduoox20.h"
 #elif defined(FIIO_M3K_LINUX)
 #include "config/fiiom3klinux.h"
+#elif defined(FIIO_M3K)
+#include "config/fiiom3k.h"
 #elif defined(EROS_Q)
 #include "config/aigoerosq.h"
 #else
diff --git a/firmware/export/config/fiiom3k.h b/firmware/export/config/fiiom3k.h
new file mode 100644
index 0000000000..68186d7aaf
--- /dev/null
+++ b/firmware/export/config/fiiom3k.h
@@ -0,0 +1,116 @@
+/* RoLo-related defines */
+#define MODEL_NAME      "FiiO M3K"
+#define MODEL_NUMBER    114
+#define BOOTFILE_EXT    "m3k"
+#define BOOTFILE        "rockbox." BOOTFILE_EXT
+#define BOOTDIR         "/.rockbox"
+#define FIRMWARE_OFFSET_FILE_CRC    0
+#define FIRMWARE_OFFSET_FILE_DATA   8
+
+/* CPU defines */
+#define CONFIG_CPU          X1000
+#define X1000_EXCLK_FREQ    24000000
+#define TIMER_FREQ          X1000_EXCLK_FREQ
+#define CPU_FREQ            1008000000
+#define CPUFREQ_MAX         CPU_FREQ
+/* TODO: figure out if this does in fact affect power consumption. */
+#define CPUFREQ_DEFAULT     (CPUFREQ_MAX/4)
+#define CPUFREQ_NORMAL      (CPUFREQ_MAX/4)
+#define HAVE_ADJUSTABLE_CPU_FREQ
+#define HAVE_GUI_BOOST
+
+/* Kernel defines */
+#define INCLUDE_TIMEOUT_API
+#define HAVE_SEMAPHORE_OBJECTS
+
+/* Drivers */
+#define HAVE_I2C_ASYNC
+
+/* Buffer for plugins and codecs. */
+#define PLUGIN_BUFFER_SIZE  0x200000 /* 2 MiB */
+#define CODEC_SIZE          0x100000 /* 1 MiB */
+
+/* LCD defines */
+#define CONFIG_LCD          LCD_FIIOM3K
+#define LCD_WIDTH           240
+#define LCD_HEIGHT          320
+#define LCD_DEPTH           16
+#define LCD_PIXELFORMAT     RGB565
+#define LCD_DPI             200
+#define HAVE_LCD_COLOR
+#define HAVE_LCD_BITMAP
+#define HAVE_LCD_ENABLE
+#define LCD_X1000_FASTSLEEP
+
+/* Backlight defines */
+#define HAVE_BACKLIGHT
+#define HAVE_BACKLIGHT_BRIGHTNESS
+#define HAVE_BUTTON_LIGHT
+#define HAVE_BUTTONLIGHT_BRIGHTNESS
+#define MIN_BRIGHTNESS_SETTING      1
+#define MAX_BRIGHTNESS_SETTING      100
+#define BRIGHTNESS_STEP             5
+#define DEFAULT_BRIGHTNESS_SETTING  70
+#define CONFIG_BACKLIGHT_FADING BACKLIGHT_FADING_SW_SETTING
+
+/* Codec / audio hardware defines */
+#define HW_SAMPR_CAPS   SAMPR_CAP_ALL_192
+#define HAVE_AK4376
+#define HAVE_SW_TONE_CONTROLS
+#define HAVE_SW_VOLUME_CONTROL
+
+/* TODO: Need to implement recording */
+
+/* Button defines */
+#define CONFIG_KEYPAD   FIIO_M3K_PAD
+#define HAVE_HEADPHONE_DETECTION
+#define HAVE_TOUCHPAD
+#define HAVE_TOUCHPAD_SENSITIVITY_SETTING
+#define MIN_TOUCHPAD_SENSITIVITY_SETTING        (-25)
+#define MAX_TOUCHPAD_SENSITIVITY_SETTING        (25)
+#define DEFAULT_TOUCHPAD_SENSITIVITY_SETTING    (0)
+#define HAVE_SCROLLWHEEL
+/* #define HAVE_WHEEL_ACCELERATION */
+/* #define WHEEL_ACCELERATION */
+/* #define WHEEL_ACCEL_START */
+
+/* Storage defines */
+#define CONFIG_STORAGE  STORAGE_SD
+#define HAVE_HOTSWAP
+#define HAVE_HOTSWAP_STORAGE_AS_MAIN
+#define HAVE_MULTIDRIVE
+#define NUM_DRIVES 1
+#define STORAGE_WANTS_ALIGN
+#define STORAGE_NEEDS_BOUNCE_BUFFER
+
+/* RTC settings */
+#define CONFIG_RTC      RTC_X1000
+/* TODO: implement HAVE_RTC_ALARM */
+
+/* Power management */
+#define HAVE_AXP173
+#define CONFIG_BATTERY_MEASURE VOLTAGE_MEASURE
+#define CONFIG_CHARGING        CHARGING_MONITOR
+#define HAVE_SW_POWEROFF
+#define HAVE_POWEROFF_WHILE_CHARGING
+
+/* Only one battery type */
+#define BATTERY_CAPACITY_DEFAULT 1100
+#define BATTERY_CAPACITY_MIN     1100
+#define BATTERY_CAPACITY_MAX     1100
+#define BATTERY_CAPACITY_INC     0
+#define BATTERY_TYPES_COUNT      1
+
+/* USB is still TODO. */
+#define USB_NONE
+
+/* Rockbox capabilities */
+#define HAVE_FAT16SUPPORT
+#define HAVE_ALBUMART
+#define HAVE_BMP_SCALING
+#define HAVE_JPEG
+#define HAVE_TAGCACHE
+#define HAVE_VOLUME_IN_LIST
+#define HAVE_QUICKSCREEN
+#define HAVE_HOTKEY
+#define AB_REPEAT_ENABLE
diff --git a/firmware/export/installer.h b/firmware/export/installer.h
new file mode 100644
index 0000000000..802798618d
--- /dev/null
+++ b/firmware/export/installer.h
@@ -0,0 +1,31 @@
+/***************************************************************************
+ *             __________               __   ___.
+ *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
+ *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
+ *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
+ *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
+ *                     \/            \/     \/    \/            \/
+ * $Id$
+ *
+ * Copyright (C) 2021 Aidan MacDonald
+ *
+ * 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.
+ *
+ ****************************************************************************/
+
+#ifndef _INSTALLER_H_
+#define _INSTALLER_H_
+
+/* Provisional interface for installing/dumping a bootloader */
+
+extern int install_bootloader(const char* path);
+extern int dump_bootloader(const char* path);
+extern const char* installer_strerror(int rc);
+
+#endif /* _INSTALLER_H_ */