summaryrefslogtreecommitdiffstats
path: root/firmware/target/mips
diff options
context:
space:
mode:
authorAidan MacDonald <amachronic@protonmail.com>2021-04-07 22:11:01 +0100
committerAidan MacDonald <amachronic@protonmail.com>2021-04-17 20:22:49 +0000
commit1b8542490da3283dfa0ce0f3363f16eab0609815 (patch)
treed3775ef4ee2739e0f140dc70f70e422bc06059f3 /firmware/target/mips
parent85fbbd9c7f3e1ac84910a16095a297cbe13a8123 (diff)
downloadrockbox-1b8542490da3283dfa0ce0f3363f16eab0609815.tar.gz
rockbox-1b8542490da3283dfa0ce0f3363f16eab0609815.zip
x1000: Redesign SPL, and allow it to flash the bootloader
SPL is now designed so core X1000 code is in control of the boot, under the reasonable assumption that the device boots from flash. It should not be too hard to adapt to other X1000 ports. The biggest functional change is that the SPL can now read/write the flash, under the control of a host computer. The SPL relies on the boot ROM for USB communication, so the host has to execute the SPL multiple times following a protocol. Change-Id: I3ffaa00e4bf191e043c9df0e2e64d15193ff42c9
Diffstat (limited to 'firmware/target/mips')
-rw-r--r--firmware/target/mips/ingenic_x1000/fiiom3k/spl-fiiom3k.c132
-rw-r--r--firmware/target/mips/ingenic_x1000/fiiom3k/spl-target.h29
-rw-r--r--firmware/target/mips/ingenic_x1000/spl-x1000-defs.h66
-rw-r--r--firmware/target/mips/ingenic_x1000/spl-x1000.c312
-rw-r--r--firmware/target/mips/ingenic_x1000/spl-x1000.h49
5 files changed, 588 insertions, 0 deletions
diff --git a/firmware/target/mips/ingenic_x1000/fiiom3k/spl-fiiom3k.c b/firmware/target/mips/ingenic_x1000/fiiom3k/spl-fiiom3k.c
new file mode 100644
index 0000000000..0ebe11e24d
--- /dev/null
+++ b/firmware/target/mips/ingenic_x1000/fiiom3k/spl-fiiom3k.c
@@ -0,0 +1,132 @@
+/***************************************************************************
+ * __________ __ ___.
+ * 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.
+ *
+ ****************************************************************************/
+
+#include "spl-x1000.h"
+#include "gpio-x1000.h"
+#include "nand-x1000.h"
+#include "system.h"
+#include <string.h>
+
+/* Boot select button state must remain stable for this duration
+ * before the choice will be accepted. Currently 100ms.
+ */
+#define BTN_STABLE_TIME (100 * (X1000_EXCLK_FREQ / 4000))
+
+static const char normal_cmdline[] = "mem=64M@0x0\
+ no_console_suspend\
+ console=ttyS2,115200n8\
+ lpj=5009408\
+ ip=off\
+ init=/linuxrc\
+ ubi.mtd=3\
+ root=ubi0:rootfs\
+ ubi.mtd=4\
+ rootfstype=ubifs\
+ rw\
+ loglevel=8";
+
+static const char recovery_cmdline[] = "mem=64M@0x0\
+ no_console_suspend\
+ console=ttyS2,115200n8\
+ lpj=5009408\
+ ip=off";
+
+const struct spl_boot_option spl_boot_options[] = {
+ {
+ /* Rockbox: the first unused NAND page is 26 KiB in, and the
+ * remainder of the block is unused, giving us 102 KiB to use.
+ */
+ .nand_addr = 0x6800,
+ .nand_size = 0x19800,
+ .load_addr = 0x80003ff8, /* first 8 bytes are bootloader ID */
+ .exec_addr = 0x80004000,
+ .cmdline = NULL,
+ },
+ {
+ /* Original firmware */
+ .nand_addr = 0x20000,
+ .nand_size = 0x400000,
+ .load_addr = 0x80efffc0,
+ .exec_addr = 0x80f00000,
+ .cmdline = normal_cmdline,
+ },
+ {
+ /* Recovery image */
+ .nand_addr = 0x420000,
+ .nand_size = 0x500000,
+ .load_addr = 0x80efffc0,
+ .exec_addr = 0x80f00000,
+ .cmdline = recovery_cmdline,
+ },
+};
+
+void spl_error(void)
+{
+ const int pin = (1 << 24);
+
+ /* Turn on button light */
+ jz_clr(GPIO_INT(GPIO_C), pin);
+ jz_set(GPIO_MSK(GPIO_C), pin);
+ jz_clr(GPIO_PAT1(GPIO_C), pin);
+ jz_set(GPIO_PAT0(GPIO_C), pin);
+
+ while(1) {
+ /* Turn it off */
+ mdelay(100);
+ jz_set(GPIO_PAT0(GPIO_C), pin);
+
+ /* Turn it on */
+ mdelay(100);
+ jz_clr(GPIO_PAT0(GPIO_C), pin);
+ }
+}
+
+int spl_get_boot_option(void)
+{
+ const uint32_t pinmask = (1 << 17) | (1 << 19);
+
+ uint32_t pin = 1, lastpin = 0;
+ uint32_t deadline = 0;
+
+ /* Configure the button GPIOs as inputs */
+ gpio_config(GPIO_A, pinmask, GPIO_INPUT);
+
+ /* Poll the pins for a short duration to detect a keypress */
+ do {
+ lastpin = pin;
+ pin = ~REG_GPIO_PIN(GPIO_A) & pinmask;
+ if(pin != lastpin) {
+ /* This will always be set on the first iteration */
+ deadline = __ost_read32() + BTN_STABLE_TIME;
+ }
+ } while(__ost_read32() < deadline);
+
+ /* Play button boots original firmware */
+ if(pin == (1 << 17))
+ return SPL_BOOTOPT_ORIG_FW;
+
+ /* Volume up boots recovery */
+ if(pin == (1 << 19))
+ return SPL_BOOTOPT_RECOVERY;
+
+ /* Default is to boot Rockbox */
+ return SPL_BOOTOPT_ROCKBOX;
+}
diff --git a/firmware/target/mips/ingenic_x1000/fiiom3k/spl-target.h b/firmware/target/mips/ingenic_x1000/fiiom3k/spl-target.h
new file mode 100644
index 0000000000..ac90508f44
--- /dev/null
+++ b/firmware/target/mips/ingenic_x1000/fiiom3k/spl-target.h
@@ -0,0 +1,29 @@
+/***************************************************************************
+ * __________ __ ___.
+ * 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 __SPL_TARGET_H__
+#define __SPL_TARGET_H__
+
+#define SPL_DDR_MEMORYSIZE 64
+#define SPL_DDR_AUTOSR_EN 1
+#define SPL_DDR_NEED_BYPASS 1
+
+#endif /* __SPL_TARGET_H__ */
diff --git a/firmware/target/mips/ingenic_x1000/spl-x1000-defs.h b/firmware/target/mips/ingenic_x1000/spl-x1000-defs.h
new file mode 100644
index 0000000000..1d9f120ee2
--- /dev/null
+++ b/firmware/target/mips/ingenic_x1000/spl-x1000-defs.h
@@ -0,0 +1,66 @@
+/***************************************************************************
+ * __________ __ ___.
+ * 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 __SPL_X1000_DEFS_H__
+#define __SPL_X1000_DEFS_H__
+
+#include <stdint.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define SPL_CMD_BOOT 0
+#define SPL_CMD_FLASH_READ 1
+#define SPL_CMD_FLASH_WRITE 2
+
+#define SPL_BOOTOPT_CHOOSE 0
+#define SPL_BOOTOPT_ROCKBOX 1
+#define SPL_BOOTOPT_ORIG_FW 2
+#define SPL_BOOTOPT_RECOVERY 3
+#define SPL_BOOTOPT_NONE 4
+
+#define SPL_FLAG_SKIP_INIT (1 << 0)
+
+#define SPL_MAX_SIZE (12 * 1024)
+#define SPL_LOAD_ADDRESS 0xf4001000
+#define SPL_EXEC_ADDRESS 0xf4001800
+#define SPL_ARGUMENTS_ADDRESS 0xf40011f0
+#define SPL_STATUS_ADDRESS 0xf40011e0
+#define SPL_BUFFER_ADDRESS 0xa0004000
+
+struct x1000_spl_arguments {
+ uint32_t command;
+ uint32_t param1;
+ uint32_t param2;
+ uint32_t flags;
+};
+
+struct x1000_spl_status {
+ int err_code;
+ int reserved;
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __SPL_X1000_DEFS_H__ */
diff --git a/firmware/target/mips/ingenic_x1000/spl-x1000.c b/firmware/target/mips/ingenic_x1000/spl-x1000.c
new file mode 100644
index 0000000000..59e0fb687d
--- /dev/null
+++ b/firmware/target/mips/ingenic_x1000/spl-x1000.c
@@ -0,0 +1,312 @@
+/***************************************************************************
+ * __________ __ ___.
+ * 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.
+ *
+ ****************************************************************************/
+
+#include "spl-x1000.h"
+#include "spl-target.h"
+#include "clk-x1000.h"
+#include "nand-x1000.h"
+#include "system.h"
+#include "x1000/cpm.h"
+#include "x1000/ost.h"
+#include "x1000/ddrc.h"
+#include "x1000/ddrc_apb.h"
+#include "x1000/ddrphy.h"
+
+struct x1000_spl_arguments* const spl_arguments =
+ (struct x1000_spl_arguments*)SPL_ARGUMENTS_ADDRESS;
+
+struct x1000_spl_status* const spl_status =
+ (struct x1000_spl_status*)SPL_STATUS_ADDRESS;
+
+/* defined to be Linux compatible; Rockbox needs no arguments so there
+ * is no harm in passing them and we save a little code size */
+typedef void(*entry_fn)(int, char**, int, int);
+
+/* Note: This is based purely on disassembly of the SPL from the FiiO M3K.
+ * The code there is somewhat generic and corresponds roughly to Ingenic's
+ * U-Boot code, but isn't entirely the same.
+ *
+ * I converted all the runtime conditionals to compile-time ones in order to
+ * save code space, since they should be constant for any given target.
+ *
+ * I haven't bothered to decode all the register fields. Some of the values
+ * written are going to bits documented as "Reserved" by Ingenic, but their
+ * documentation doesn't seem completely reliable, so either these are bits
+ * which _do_ have a purpose, or they're only defined on other Ingenic CPUs.
+ *
+ * The DDR PHY registers appear to be from Synopsys "PHY Utility Block Lite".
+ * These aren't documented by Ingenic, but the addresses and names can be found
+ * in their U-Boot code.
+ */
+static void ddr_init(void)
+{
+ REG_CPM_DRCG = 0x73;
+ mdelay(3);
+ REG_CPM_DRCG = 0x71;
+ mdelay(3);
+ REG_DDRC_APB_PHYRST_CFG = 0x1a00001;
+ mdelay(3);
+ REG_DDRC_APB_PHYRST_CFG = 0;
+ mdelay(3);
+ REG_DDRC_CTRL = 0xf00000;
+ mdelay(3);
+ REG_DDRC_CTRL = 0;
+ mdelay(3);
+
+ REG_DDRC_CFG = 0xa468a6c;
+ REG_DDRC_CTRL = 2;
+ REG_DDRPHY_DTAR = 0x150000;
+ REG_DDRPHY_DCR = 0;
+ REG_DDRPHY_MR0 = 0x42;
+ REG_DDRPHY_MR2 = 0x98;
+ REG_DDRPHY_PTR0 = 0x21000a;
+ REG_DDRPHY_PTR1 = 0xa09c40;
+ REG_DDRPHY_PTR2 = 0x280014;
+ REG_DDRPHY_DTPR0 = 0x1a69444a;
+ REG_DDRPHY_DTPR1 = 0x180090;
+ REG_DDRPHY_DTPR2 = 0x1ff99428;
+ REG_DDRPHY_DXGCR(0) = 0x90881;
+ REG_DDRPHY_DXGCR(1) = 0x90881;
+ REG_DDRPHY_DXGCR(2) = 0x90e80;
+ REG_DDRPHY_DXGCR(3) = 0x90e80;
+ REG_DDRPHY_PGCR = 0x1042e03;
+ REG_DDRPHY_ACIOCR = 0x30c00813;
+ REG_DDRPHY_DXCCR = 0x4912;
+
+ int i = 10000;
+ while(i > 0 && REG_DDRPHY_PGSR != 7 && REG_DDRPHY_PGSR != 0x1f)
+ i -= 1;
+ if(i == 0)
+ spl_error();
+
+#if SPL_DDR_NEED_BYPASS
+ REG_DDRPHY_ACDLLCR = 0x80000000;
+ REG_DDRPHY_DSGCR &= ~0x10;
+ REG_DDRPHY_DLLGCR |= 0x800000;
+ REG_DDRPHY_PIR = 0x20020041;
+#else
+ REG_DDRPHY_PIR = 0x41;
+#endif
+
+ while(i > 0 && REG_DDRPHY_PGSR != 0xf && REG_DDRPHY_PGSR != 0x1f)
+ i -= 1;
+ if(i == 0)
+ spl_error();
+
+ REG_DDRC_APB_PHYRST_CFG = 0x400000;
+ mdelay(3);
+ REG_DDRC_APB_PHYRST_CFG = 0;
+ mdelay(3);
+
+ REG_DDRC_CFG = 0xa468aec;
+ REG_DDRC_CTRL = 2;
+#if SPL_DDR_NEED_BYPASS
+ REG_DDRPHY_PIR = 0x20020081;
+#else
+ REG_DDRPHY_PIR = 0x85;
+#endif
+
+ i = 500000;
+ while(REG_DDRPHY_PGSR != 0x1f) {
+ if(REG_DDRPHY_PGSR & 0x70)
+ break;
+ i -= 1;
+ }
+
+ if(i == 0)
+ spl_error();
+
+ if((REG_DDRPHY_PGSR & 0x60) != 0 && REG_DDRPHY_PGSR != 0)
+ spl_error();
+
+ REG_DDRC_CTRL = 0;
+ REG_DDRC_CTRL = 10;
+ REG_DDRC_CTRL = 0;
+ REG_DDRC_CFG = 0xa468a6c;
+ REG_DDRC_TIMING1 = 0x2050501;
+ REG_DDRC_TIMING2 = 0x4090404;
+ REG_DDRC_TIMING3 = 0x2704030d;
+ REG_DDRC_TIMING4 = 0xb7a0251;
+ REG_DDRC_TIMING5 = 0xff090200;
+ REG_DDRC_TIMING6 = 0xa0a0202;
+#if SPL_DDR_MEMORYSIZE == 64
+ REG_DDRC_MMAP0 = 0x20fc;
+ REG_DDRC_MMAP1 = 0x2400;
+#elif SPL_DDR_MEMORYSIZE == 32
+ REG_DDRC_MMAP0 = 0x20fe;
+ REG_DDRC_MMAP1 = 0x2200;
+#else
+# error "Unsupported DDR_MEMORYSIZE"
+#endif
+ REG_DDRC_CTRL = 10;
+ REG_DDRC_REFCNT = 0x2f0003;
+ REG_DDRC_CTRL = 0xc91e;
+
+#if SPL_DDR_MEMORYSIZE == 64
+ REG_DDRC_REMAP1 = 0x03020c0b;
+ REG_DDRC_REMAP2 = 0x07060504;
+ REG_DDRC_REMAP3 = 0x000a0908;
+ REG_DDRC_REMAP4 = 0x0f0e0d01;
+ REG_DDRC_REMAP5 = 0x13121110;
+#elif SPL_DDR_MEMORYSIZE == 32
+ REG_DDRC_REMAP1 = 0x03020b0a;
+ REG_DDRC_REMAP2 = 0x07060504;
+ REG_DDRC_REMAP3 = 0x01000908;
+ REG_DDRC_REMAP4 = 0x0f0e0d0c;
+ REG_DDRC_REMAP5 = 0x13121110;
+#else
+# error "Unsupported DDR_MEMORYSIZE"
+#endif
+
+ REG_DDRC_STATUS &= ~0x40;
+
+#if SPL_DDR_AUTOSR_EN
+#if SPL_DDR_NEED_BYPASS
+ jz_writef(CPM_DDRCDR, GATE_EN(1));
+ REG_DDRC_APB_CLKSTP_CFG = 0x9000000f;
+#else
+ REG_DDRC_DLP = 0;
+#endif
+#endif
+
+ REG_DDRC_AUTOSR_EN = SPL_DDR_AUTOSR_EN;
+}
+
+static void init(void)
+{
+ /* from original firmware SPL */
+ REG_CPM_PSWC0ST = 0x00;
+ REG_CPM_PSWC1ST = 0x10;
+ REG_CPM_PSWC2ST = 0x18;
+ REG_CPM_PSWC3ST = 0x08;
+
+ /* enable MPLL */
+#if X1000_EXCLK_FREQ == 24000000
+ /* 24 * (24+1) = 600 MHz */
+ jz_writef(CPM_MPCR, ENABLE(1), BS(1), PLLN(0), PLLM(24), PLLOD(0));
+#elif X1000_EXCLK_FREQ == 26000000
+ /* 26 * (22+1) = 598 MHz */
+ jz_writef(CPM_MPCR, ENABLE(1), BS(1), PLLN(0), PLLM(22), PLLOD(0));
+#else
+# error "unknown EXCLK frequency"
+#endif
+ while(jz_readf(CPM_MPCR, ON) == 0);
+
+ /* set DDR clock to MPLL/3 = 200 MHz */
+ jz_writef(CPM_CLKGR, DDR(0));
+ clk_set_ddr(X1000_CLK_MPLL, 3);
+
+ /* start OST so we can use mdelay/udelay */
+ jz_writef(CPM_CLKGR, OST(0));
+ jz_writef(OST_CTRL, PRESCALE2_V(BY_4));
+ jz_writef(OST_CLEAR, OST2(1));
+ jz_write(OST_2CNTH, 0);
+ jz_write(OST_2CNTL, 0);
+ jz_setf(OST_ENABLE, OST2);
+
+ /* init DDR memory */
+ ddr_init();
+}
+
+static int nandread(uint32_t addr, uint32_t size, void* buffer)
+{
+ int rc;
+
+ if((rc = nand_open()))
+ return rc;
+
+ rc = nand_read_bytes(addr, size, buffer);
+ nand_close();
+ return rc;
+}
+
+static int nandwrite(uint32_t addr, uint32_t size, void* buffer)
+{
+ int rc;
+
+ if((rc = nand_open()))
+ return rc;
+
+ if((rc = nand_enable_writes(true)))
+ goto _end;
+
+ if((rc = nand_erase_bytes(addr, size)))
+ goto _end1;
+
+ rc = nand_write_bytes(addr, size, buffer);
+
+ _end1:
+ /* an error here is very unlikely, so ignore it */
+ nand_enable_writes(false);
+
+ _end:
+ nand_close();
+ return rc;
+}
+
+void main(void)
+{
+ if(!(SPL_ARGUMENTS->flags & SPL_FLAG_SKIP_INIT))
+ init();
+
+ switch(SPL_ARGUMENTS->command) {
+ case SPL_CMD_BOOT: {
+ int option = SPL_ARGUMENTS->param1;
+ if(option == SPL_BOOTOPT_CHOOSE)
+ option = spl_get_boot_option();
+ if(option == SPL_BOOTOPT_NONE)
+ return;
+
+ const struct spl_boot_option* opt = &spl_boot_options[option-1];
+ if(nandread(opt->nand_addr, opt->nand_size, (void*)opt->load_addr))
+ spl_error();
+
+ /* TODO: implement dual boot */
+
+ /* Reading the Linux command line from the bootloader is handled by
+ * arch/mips/xburst/core/prom.c -- see Ingenic kernel sources.
+ *
+ * Rockbox doesn't use arguments, but passing them does not hurt and it
+ * saves an unnecessary branch.
+ */
+ entry_fn entry = (entry_fn)opt->exec_addr;
+ char** argv = (char**)0x80004000;
+ argv[0] = 0;
+ argv[1] = (char*)opt->cmdline;
+
+ commit_discard_idcache();
+ entry(2, argv, 0, 0);
+ __builtin_unreachable();
+ }
+
+ case SPL_CMD_FLASH_READ:
+ SPL_STATUS->err_code = nandread(SPL_ARGUMENTS->param1,
+ SPL_ARGUMENTS->param2,
+ (void*)SPL_BUFFER_ADDRESS);
+ return;
+
+ case SPL_CMD_FLASH_WRITE:
+ SPL_STATUS->err_code = nandwrite(SPL_ARGUMENTS->param1,
+ SPL_ARGUMENTS->param2,
+ (void*)SPL_BUFFER_ADDRESS);
+ return;
+ }
+}
diff --git a/firmware/target/mips/ingenic_x1000/spl-x1000.h b/firmware/target/mips/ingenic_x1000/spl-x1000.h
new file mode 100644
index 0000000000..44601438f3
--- /dev/null
+++ b/firmware/target/mips/ingenic_x1000/spl-x1000.h
@@ -0,0 +1,49 @@
+/***************************************************************************
+ * __________ __ ___.
+ * 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 __SPL_X1000_H__
+#define __SPL_X1000_H__
+
+#include "spl-x1000-defs.h"
+
+#define SPL_ARGUMENTS ((struct x1000_spl_arguments*)SPL_ARGUMENTS_ADDRESS)
+#define SPL_STATUS ((struct x1000_spl_status*)SPL_STATUS_ADDRESS)
+
+struct spl_boot_option {
+ uint32_t nand_addr;
+ uint32_t nand_size;
+ uint32_t load_addr;
+ uint32_t exec_addr;
+ const char* cmdline; /* for Linux */
+};
+
+/* Defined by target, indices are 0 = ROCKBOX, 1 = ORIG_FW, etc... */
+extern const struct spl_boot_option spl_boot_options[];
+
+/* Called on a fatal error */
+void spl_error(void) __attribute__((noreturn));
+
+/* When SPL boots with SPL_BOOTOPTION_CHOOSE, this function is invoked
+ * to let the target figure out the boot option based on buttons the
+ * user is pressing */
+extern int spl_get_boot_option(void);
+
+#endif /* __SPL_X1000_H__ */