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