xref: /OK3568_Linux_fs/u-boot/arch/arm/include/asm/arch-sunxi/spl.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * (C) Copyright 2007-2011
3*4882a593Smuzhiyun  * Allwinner Technology Co., Ltd. <www.allwinnertech.com>
4*4882a593Smuzhiyun  * Tom Cubie <tangliang@allwinnertech.com>
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * SPDX-License-Identifier:	GPL-2.0+
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun #ifndef	_ASM_ARCH_SPL_H_
9*4882a593Smuzhiyun #define	_ASM_ARCH_SPL_H_
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #define BOOT0_MAGIC		"eGON.BT0"
12*4882a593Smuzhiyun #define SPL_SIGNATURE		"SPL" /* marks "sunxi" SPL header */
13*4882a593Smuzhiyun #define SPL_HEADER_VERSION	2
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #ifdef CONFIG_SUNXI_HIGH_SRAM
16*4882a593Smuzhiyun #define SPL_ADDR		0x10000
17*4882a593Smuzhiyun #else
18*4882a593Smuzhiyun #define SPL_ADDR		0x0
19*4882a593Smuzhiyun #endif
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun /* The low 8-bits of the 'boot_media' field in the SPL header */
22*4882a593Smuzhiyun #define SUNXI_BOOTED_FROM_MMC0	0
23*4882a593Smuzhiyun #define SUNXI_BOOTED_FROM_NAND	1
24*4882a593Smuzhiyun #define SUNXI_BOOTED_FROM_MMC2	2
25*4882a593Smuzhiyun #define SUNXI_BOOTED_FROM_SPI	3
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun /* boot head definition from sun4i boot code */
28*4882a593Smuzhiyun struct boot_file_head {
29*4882a593Smuzhiyun 	uint32_t b_instruction;	/* one intruction jumping to real code */
30*4882a593Smuzhiyun 	uint8_t magic[8];	/* ="eGON.BT0" or "eGON.BT1", not C-style str */
31*4882a593Smuzhiyun 	uint32_t check_sum;	/* generated by PC */
32*4882a593Smuzhiyun 	uint32_t length;	/* generated by PC */
33*4882a593Smuzhiyun 	/*
34*4882a593Smuzhiyun 	 * We use a simplified header, only filling in what is needed
35*4882a593Smuzhiyun 	 * by the boot ROM. To be compatible with Allwinner tools we
36*4882a593Smuzhiyun 	 * would need to implement the proper fields here instead of
37*4882a593Smuzhiyun 	 * padding.
38*4882a593Smuzhiyun 	 *
39*4882a593Smuzhiyun 	 * Actually we want the ability to recognize our "sunxi" variant
40*4882a593Smuzhiyun 	 * of the SPL. To do so, let's place a special signature into the
41*4882a593Smuzhiyun 	 * "pub_head_size" field. We can reasonably expect Allwinner's
42*4882a593Smuzhiyun 	 * boot0 to always have the upper 16 bits of this set to 0 (after
43*4882a593Smuzhiyun 	 * all the value shouldn't be larger than the limit imposed by
44*4882a593Smuzhiyun 	 * SRAM size).
45*4882a593Smuzhiyun 	 * If the signature is present (at 0x14), then we know it's safe
46*4882a593Smuzhiyun 	 * to use the remaining 8 bytes (at 0x18) for our own purposes.
47*4882a593Smuzhiyun 	 * (E.g. sunxi-tools "fel" utility can pass information there.)
48*4882a593Smuzhiyun 	 */
49*4882a593Smuzhiyun 	union {
50*4882a593Smuzhiyun 		uint32_t pub_head_size;
51*4882a593Smuzhiyun 		uint8_t spl_signature[4];
52*4882a593Smuzhiyun 	};
53*4882a593Smuzhiyun 	uint32_t fel_script_address;
54*4882a593Smuzhiyun 	/*
55*4882a593Smuzhiyun 	 * If the fel_uEnv_length member below is set to a non-zero value,
56*4882a593Smuzhiyun 	 * it specifies the size (byte count) of data at fel_script_address.
57*4882a593Smuzhiyun 	 * At the same time this indicates that the data is in uEnv.txt
58*4882a593Smuzhiyun 	 * compatible format, ready to be imported via "env import -t".
59*4882a593Smuzhiyun 	 */
60*4882a593Smuzhiyun 	uint32_t fel_uEnv_length;
61*4882a593Smuzhiyun 	/*
62*4882a593Smuzhiyun 	 * Offset of an ASCIIZ string (relative to the SPL header), which
63*4882a593Smuzhiyun 	 * contains the default device tree name (CONFIG_DEFAULT_DEVICE_TREE).
64*4882a593Smuzhiyun 	 * This is optional and may be set to NULL. Is intended to be used
65*4882a593Smuzhiyun 	 * by flash programming tools for providing nice informative messages
66*4882a593Smuzhiyun 	 * to the users.
67*4882a593Smuzhiyun 	 */
68*4882a593Smuzhiyun 	uint32_t dt_name_offset;
69*4882a593Smuzhiyun 	uint32_t reserved1;
70*4882a593Smuzhiyun 	uint32_t boot_media;		/* written here by the boot ROM */
71*4882a593Smuzhiyun 	/* A padding area (may be used for storing text strings) */
72*4882a593Smuzhiyun 	uint32_t string_pool[13];
73*4882a593Smuzhiyun 	/* The header must be a multiple of 32 bytes (for VBAR alignment) */
74*4882a593Smuzhiyun };
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun /* Compile time check to assure proper alignment of structure */
77*4882a593Smuzhiyun typedef char boot_file_head_not_multiple_of_32[1 - 2*(sizeof(struct boot_file_head) % 32)];
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun #define is_boot0_magic(addr)	(memcmp((void *)addr, BOOT0_MAGIC, 8) == 0)
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun #endif
82