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