sunxi-tools/bare-metal.c

/*
 * Copyright (C) 2016  Siarhei Siamashka <siarhei.siamashka@gmail.com>
 *
 * 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 program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/*
 * Partially based on the uart code from ar100-info
 *
 * (C) Copyright 2013 Stefan Kristiansson <stefan.kristiansson@saunalahti.fi>
 *
 * 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 program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

/*
 * Partially based on the sunxi gpio code from U-Boot
 *
 * (C) Copyright 2012 Henrik Nordstrom <henrik@henriknordstrom.net>
 *
 * Based on earlier arch/arm/cpu/armv7/sunxi/gpio.c:
 *
 * (C) Copyright 2007-2011
 * Allwinner Technology Co., Ltd. <www.allwinnertech.com>
 * Tom Cubie <tangliang@allwinnertech.com>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include "bare-metal.h"

static const struct soc_info soc_table[] = {
	{
		.id	= 0x1623,
		.name	= "A10",
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPB(22), MUX_2 },
	},
	{
		.id	= 0x1625,
		.name	= "A10s",
		.flags	= FLAG_VAR0,
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPB(19), MUX_2 },
	},
	{
		.id	= 0x1625,
		.name	= "A13",
		.flags	= FLAG_VAR1 | FLAG_UART_ON_PORTF,
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPB(19), MUX_2 },
	},
	{
		.id	= 0x1633,
		.name	= "A31/A31s",
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPH(20), MUX_2 },
	},
	{
		.id	= 0x1639,
		.name	= "A80",
		.flags	= FLAG_A80_CLOCK,
		.pio	= { A80_PIO_BASE },
		.ccu	= { A80_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_10000 },
		.uart0	= { A80_UART0_BASE, SUNXI_GPH(12), MUX_2 },
	},
	{
		.id	= 0x1651,
		.name	= "A20",
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPB(22), MUX_2 },
	},
	{
		.id	= 0x1663,
		.name	= "F1C100s",
		.flags	= FLAG_UART_ON_APB1,
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNIV_UART0_BASE, SUNXI_GPE(0), MUX_5 },
	},
	{
		.id	= 0x1673,
		.name	= "A83T",
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPB(9), MUX_2 },
	},
	{
		.id	= 0x1689,
		.name	= "A64",
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_10000 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPB(8), MUX_4 },
	},
	{
		.id	= 0x1680,
		.name	= "H2+",
		.flags	= FLAG_VAR1,
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPA(4), MUX_2 },
	},
	{
		.id	= 0x1680,
		.name	= "H3",
		.flags	= FLAG_VAR0,
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPA(4), MUX_2 },
	},
	{
		.id	= 0x1681,
		.name	= "V3s",
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPB(8), MUX_3 },
	},
	{
		.id	= 0x1701,
		.name	= "R40",
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_0 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPB(22), MUX_2 },
	},
	{
		.id	= 0x1708,
		.name	= "T7",
		.flags	= FLAG_NEW_CLOCK,
		.pio	= { H6_PIO_BASE },
		.ccu	= { H6_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_20000 },
		.uart0	= { H6_UART0_BASE, SUNXI_GPB(8), MUX_4 },
	},
	{
		.id	= 0x1718,
		.name	= "H5",
		.pio	= { SUNXI_PIO_BASE },
		.ccu	= { AW_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_10000 },
		.uart0	= { SUNXI_UART0_BASE, SUNXI_GPA(4), MUX_2 },
	},
	{
		.id	= 0x1719,
		.name	= "A63",
		.flags	= FLAG_NEW_CLOCK,
		.pio	= { H6_PIO_BASE },
		.ccu	= { H6_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_10000 },
		.uart0	= { H6_UART0_BASE, SUNXI_GPB(9), MUX_4 },
	},
	{
		.id	= 0x1721,
		.name	= "V5",
		.flags	= FLAG_NEW_CLOCK,
		.pio	= { H6_PIO_BASE },
		.ccu	= { H6_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_20000 },
		.uart0	= { H6_UART0_BASE, SUNXI_GPB(9), MUX_2 },
	},
	{
		.id	= 0x1728,
		.name	= "H6",
		.flags	= FLAG_NEW_CLOCK,
		.pio	= { H6_PIO_BASE },
		.ccu	= { H6_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_20000 },
		.uart0	= { H6_UART0_BASE, SUNXI_GPH(0), MUX_2 },
	},
	{
		.id	= 0x1817,
		.name	= "V831",
		.flags	= FLAG_NEW_CLOCK,
		.pio	= { H6_PIO_BASE },
		.ccu	= { H6_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_20000 },
		.uart0	= { H6_UART0_BASE, SUNXI_GPH(9), MUX_5 },
	},
	{
		.id	= 0x1823,
		.name	= "H616",
		.flags	= FLAG_NEW_CLOCK,
		.pio	= { H6_PIO_BASE },
		.ccu	= { H6_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_20000 },
		.uart0	= { H6_UART0_BASE, SUNXI_GPH(0), MUX_2 },
	},
	{
		.id	= 0x1851,
		.name	= "R329",
		.flags	= FLAG_NCAT2,
		.pio	= { R329_PIO_BASE },
		.ccu	= { R329_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_100000 },
		.uart0	= { R329_UART0_BASE, SUNXI_GPB(4), MUX_2 },
	},
	{
		.id	= 0x1855,
		.name	= "A133",
		.flags	= FLAG_NEW_CLOCK,
		.pio	= { H6_PIO_BASE },
		.ccu	= { H6_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_20000 },
		.uart0	= { H6_UART0_BASE, SUNXI_GPB(9), MUX_2 },
	},
	{
		.id	= 0x1859,
		.name	= "R528",
		.flags	= FLAG_NCAT2,
		.pio	= { V853_PIO_BASE },
		.ccu	= { R329_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_20000 },
		.uart0	= { R329_UART0_BASE, SUNXI_GPE(2), MUX_6 },
	},
	{
		.id	= 0x1886,
		.name	= "V853",
		.flags	= FLAG_NCAT2,
		.pio	= { V853_PIO_BASE },
		.ccu	= { R329_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_20000 },
		.uart0	= { R329_UART0_BASE, SUNXI_GPH(9), MUX_5 },
	},
	{
		.id	= 0x1890,
		.name	= "A523",
		.flags	= FLAG_NCAT2,
		.pio	= { V853_PIO_BASE },
		.ccu	= { R329_CCM_BASE },
		.sram	= { SRAM_A1_ADDR_20000 },
		.uart0	= { R329_UART0_BASE, SUNXI_GPB(9), MUX_2 },
	},
};

static const struct soc_info *find_soc_info(int id, int variant)
{
	int i;

	for (i = 0; i < ARRAY_SIZE(soc_table); i++) {
		if (soc_table[i].id != id)
			continue;

		if (variant == (soc_table[i].flags & FLAG_VAR1))
			return &soc_table[i];
	}

	return NULL;
}

static u32 pio_base;
static u32 pio_bank_size, pio_dat_off, pio_pull_off;

static int sunxi_gpio_set_cfgpin(u32 pin, u32 val)
{
	u32 cfg;
	u32 bank = GPIO_BANK(pin);
	u32 index = GPIO_CFG_INDEX(pin);
	u32 offset = GPIO_CFG_OFFSET(pin);
	u32 *addr = GPIO_CFG_BASE(bank) + index;
	cfg = readl(addr);
	cfg &= ~(0xf << offset);
	cfg |= val << offset;
	writel(cfg, addr);
	return 0;
}

static int sunxi_gpio_set_pull(u32 pin, u32 val)
{
	u32 cfg;
	u32 bank = GPIO_BANK(pin);
	u32 index = GPIO_PULL_INDEX(pin);
	u32 offset = GPIO_PULL_OFFSET(pin);
	u32 *addr = GPIO_PULL_BASE(bank) + index;
	cfg = readl(addr);
	cfg &= ~(0x3 << offset);
	cfg |= val << offset;
	writel(cfg, addr);
	return 0;
}

/*****************************************************************************
 * Nearly all the Allwinner SoCs are using the same VER_REG register for     *
 * runtime SoC type identification. For additional details see:              *
 *                                                                           *
 *    https://linux-sunxi.org/SRAM_Controller_Register_Guide                 *
 *                                                                           *
 * Allwinner A80 is an oddball and has a non-standard address of the VER_REG *
 *                                                                           *
 * Allwinner A10s and A13 are using the same SoC type id, but they can be    *
 * differentiated using a certain part of the SID register.                  *
 *                                                                           *
 * Allwinner H6 has its memory map totally reworked, but the SRAM controller *
 * remains similar; the base of it is moved to 0x03000000.                   *
 *****************************************************************************/

#define VER_REG			(AW_SRAMCTRL_BASE + 0x24)
#define H6_VER_REG		(H6_SRAMCTRL_BASE + 0x24)
#define A80_VER_REG		(A80_SRAMCTRL_BASE + 0x24)
#define SUN4I_SID_BASE		0x01C23800
#define SUN8I_SID_BASE		0x01C14000

#define SID_PRCTL	0x40	/* SID program/read control register */
#define SID_RDKEY	0x60	/* SID read key value register */

#define SID_OP_LOCK	0xAC	/* Efuse operation lock value */
#define SID_READ_START	(1 << 1) /* bit 1 of SID_PRCTL, Software Read Start */

static u32 sid_read_key(u32 sid_base, u32 offset)
{
	u32 reg_val;

	reg_val = (offset & 0x1FF) << 16; /* PG_INDEX value */
	reg_val |= (SID_OP_LOCK << 8) | SID_READ_START; /* request read access */
	writel(reg_val, sid_base + SID_PRCTL);

	while (readl(sid_base + SID_PRCTL) & SID_READ_START) ; /* wait while busy */

	reg_val = readl(sid_base + SID_RDKEY); /* read SID key value */
	writel(0, sid_base + SID_PRCTL); /* clear SID_PRCTL (removing SID_OP_LOCK) */

	return reg_val;
}

/* A10s and A13 share the same ID, so we need a little more effort on those */
static int sunxi_get_sun5i_variant(void)
{
	if ((readl(SUN4I_SID_BASE + 8) & 0xf000) != 0x7000)
		return FLAG_VAR1;

	return FLAG_VAR0;
}

/* H2+ and H3 share the same ID, we can differentiate them by SID_RKEY0 */
static int sunxi_get_h3_variant(void)
{
	u32 sid0 = sid_read_key(SUN8I_SID_BASE, 0);

	/* H2+ uses those SID IDs */
	if ((sid0 & 0xff) == 0x42 || (sid0 & 0xff) == 0x83)
		return FLAG_VAR1;

	/*
	 * Note: according to Allwinner sources, H3 is expected
	 * to show up as 0x00, 0x81 or ("H3D") 0x58 here.
	 */

	return FLAG_VAR0;
}

const struct soc_info *sunxi_detect_soc(void)
{
	int variant = 0;
	u32 soc_id;
	u32 midr;
	u32 reg;

	asm volatile("mrc p15, 0, %0, c0, c0, 0" : "=r" (midr));
	if (((midr >> 4) & 0xFFF) == 0xc08) { /* ARM Cortex-A8: A10/A10s/A13 */
		reg = VER_REG;
	} else if ((readl(0x03021008) & 0xfff) == 0x43b) {// GICD_IIDR @ NCAT
		reg = H6_VER_REG;
	} else if ((readl(0x01c81008) & 0xfff) == 0x43b) {// GICD_IIDR @ legacy
		reg = VER_REG;
	} else if ((readl(0x01c41008) & 0xfff) == 0x43b) {// GICD_IIDR @ A80
		reg = A80_VER_REG;
	} else if ((readl(0x03400008) & 0xfff) == 0x43b) {// GICD_IIDR @ GIC-600
		reg = H6_VER_REG;
	} else {
		while (1);				// unknown
	}

	set_wbit(reg, 1U << 15);
	soc_id = readl(reg) >> 16;

	switch(soc_id) {
	case 0x1680:
		variant = sunxi_get_h3_variant();
		break;
	case 0x1625:
		variant = sunxi_get_sun5i_variant();
		break;
	}

	return find_soc_info(soc_id, variant);
}

/*****************************************************************************
 * UART is mostly the same on A10/A13/A20/A31/H3/A64, except that newer SoCs *
 * have changed the APB numbering scheme (A10/A13/A20 used to have APB0 and  *
 * APB1 names, but newer SoCs just have renamed them into APB1 and APB2).    *
 * The constants below are using the new APB numbering convention.           *
 * Also the newer SoCs have introduced the APB2_RESET register, but writing  *
 * to it effectively goes nowhere on older SoCs and is harmless.             *
 *****************************************************************************/

#define CONFIG_CONS_INDEX	1

static void clock_init_uart(const struct soc_info *soc)
{
	if (soc->flags & FLAG_NEW_CLOCK) {
		set_wbit(soc->ccu.base + 0x90c,
			 0x10001 << (CONFIG_CONS_INDEX - 1));
	} else {
		int bit = 16 + CONFIG_CONS_INDEX - 1;
		int gate_ofs = 0x06c;
		int reset_ofs = 0x2d8;

		if (soc->flags & FLAG_UART_ON_APB1) {
			bit = 20 + CONFIG_CONS_INDEX - 1;
			gate_ofs = 0x068;
			reset_ofs = 0x2d0;
		} else if (soc->flags & FLAG_A80_CLOCK) {
			gate_ofs = 0x594;
			reset_ofs = 0x5b4;
		}
		/* Open the clock gate for UART0 */
		set_wbit(soc->ccu.base + gate_ofs, 1U << bit);
		/* Deassert UART0 reset (not really needed on old SoCs) */
		set_wbit(soc->ccu.base + reset_ofs, 1U << bit);
	}
}

/*****************************************************************************
 * UART0 pins muxing is different for different SoC variants.                *
 * Allwinner A13 is a bit special, because there are no dedicated UART0 pins *
 * and they are shared with MMC0.                                            *
 *****************************************************************************/

void gpio_init(const struct soc_info *soc)
{
	pio_base = soc->pio.base;

	if (soc->flags & FLAG_NEW_GPIO) {
		/* GPIO V2 */
		pio_bank_size = 0x30;
		pio_dat_off = 0x10;
		pio_pull_off = 0x24;
	} else {
		/* GPIO V1 */
		pio_bank_size = 0x24;
		pio_dat_off = 0x10;
		pio_pull_off = 0x1c;
	}

	if (soc->flags & FLAG_UART_ON_PORTF) {
		/* Disable normal UART0 pins to avoid conflict */
		sunxi_gpio_set_cfgpin(soc->uart0.pin_tx, MUX_GPIO_INPUT);
		sunxi_gpio_set_cfgpin(soc->uart0.pin_tx + 1, MUX_GPIO_INPUT);

		/* Use SD breakout board to access UART0 on MMC0 pins */
		sunxi_gpio_set_cfgpin(SUNXI_GPF(2), soc->uart0.pinmux);
		sunxi_gpio_set_cfgpin(SUNXI_GPF(4), soc->uart0.pinmux);
		sunxi_gpio_set_pull(SUNXI_GPF(4), SUNXI_GPIO_PULL_UP);
	} else {
		sunxi_gpio_set_cfgpin(soc->uart0.pin_tx, soc->uart0.pinmux);
		sunxi_gpio_set_cfgpin(soc->uart0.pin_tx + 1, soc->uart0.pinmux);
		sunxi_gpio_set_pull(soc->uart0.pin_tx + 1, SUNXI_GPIO_PULL_UP);
	}
}

/*****************************************************************************/

static u32 uart0_base;

#define UART0_RBR (uart0_base + 0x0)    /* receive buffer register */
#define UART0_THR (uart0_base + 0x0)    /* transmit holding register */
#define UART0_DLL (uart0_base + 0x0)    /* divisor latch low register */

#define UART0_DLH (uart0_base + 0x4)    /* divisor latch high register */
#define UART0_IER (uart0_base + 0x4)    /* interrupt enable reigster */

#define UART0_IIR (uart0_base + 0x8)    /* interrupt identity register */
#define UART0_FCR (uart0_base + 0x8)    /* fifo control register */

#define UART0_LCR (uart0_base + 0xc)    /* line control register */

#define UART0_LSR (uart0_base + 0x14)   /* line status register */

#define BAUD_115200		13	/* 24 * 1000 * 1000 / 16 / 115200 */
/* The BROM sets the CPU clock to 204MHz, AHB=CPU/2, APB=AHB/2 => 51 MHz */
#define BAUD_115200_SUNIV 	28	/* 51 * 1000 * 1000 / 16 / 115200 */
#define NO_PARITY      (0)
#define ONE_STOP_BIT   (0)
#define DAT_LEN_8_BITS (3)
#define LC_8_N_1       (NO_PARITY << 3 | ONE_STOP_BIT << 2 | DAT_LEN_8_BITS)

void uart0_init(const struct soc_info *soc)
{
	clock_init_uart(soc);

	uart0_base = soc->uart0.base;

	/* select dll dlh */
	writel(0x80, UART0_LCR);
	/* set baudrate */
	writel(0, UART0_DLH);
	if (soc->id == 0x1663)
		writel(BAUD_115200_SUNIV, UART0_DLL);
	else
		writel(BAUD_115200, UART0_DLL);
	/* set line control */
	writel(LC_8_N_1, UART0_LCR);
}

void uart0_putc(char c)
{
	while (!(readl(UART0_LSR) & (1 << 6))) {}
	writel(c, UART0_THR);
}

void uart0_puts(const char *s)
{
	while (*s) {
		if (*s == '\n')
			uart0_putc('\r');
		uart0_putc(*s++);
	}
}

int get_boot_device(const struct soc_info *soc)
{
	u32 *spl_signature = (void *)soc->sram.a1_base + 0x4;

	/* Check the eGON.BT0 magic in the SPL header */
	if (spl_signature[0] != 0x4E4F4765 || spl_signature[1] != 0x3054422E)
		return BOOT_DEVICE_FEL;

	u32 boot_dev = spl_signature[9] & 0xFF; /* offset into SPL = 0x28 */
	if (boot_dev == 0)
		return BOOT_DEVICE_MMC0;
	if (boot_dev == 3)
		return BOOT_DEVICE_SPI;

	return BOOT_DEVICE_UNK;
}

/*****************************************************************************/

/* A workaround for https://patchwork.ozlabs.org/patch/622173 */
void __attribute__((section(".start"))) __attribute__((naked)) start(void)
{
	asm volatile("b     main             \n"
		     ".long 0xffffffff       \n"
		     ".long 0xffffffff       \n"
		     ".long 0xffffffff       \n");
}