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