]> git.sur5r.net Git - u-boot/blob - tools/kwbimage.h
imx: mx6sl: add lcdif clock support
[u-boot] / tools / kwbimage.h
1 /*
2  * (C) Copyright 2008
3  * Marvell Semiconductor <www.marvell.com>
4  * Written-by: Prafulla Wadaskar <prafulla@marvell.com>
5  *
6  * SPDX-License-Identifier:     GPL-2.0+
7  */
8
9 #ifndef _KWBIMAGE_H_
10 #define _KWBIMAGE_H_
11
12 #include <compiler.h>
13 #include <stdint.h>
14
15 #define KWBIMAGE_MAX_CONFIG     ((0x1dc - 0x20)/sizeof(struct reg_config))
16 #define MAX_TEMPBUF_LEN         32
17
18 /* NAND ECC Mode */
19 #define IBR_HDR_ECC_DEFAULT             0x00
20 #define IBR_HDR_ECC_FORCED_HAMMING      0x01
21 #define IBR_HDR_ECC_FORCED_RS           0x02
22 #define IBR_HDR_ECC_DISABLED            0x03
23
24 /* Boot Type - block ID */
25 #define IBR_HDR_I2C_ID                  0x4D
26 #define IBR_HDR_SPI_ID                  0x5A
27 #define IBR_HDR_NAND_ID                 0x8B
28 #define IBR_HDR_SATA_ID                 0x78
29 #define IBR_HDR_PEX_ID                  0x9C
30 #define IBR_HDR_UART_ID                 0x69
31 #define IBR_DEF_ATTRIB                  0x00
32
33 #define ALIGN_SUP(x, a) (((x) + (a - 1)) & ~(a - 1))
34
35 /* Structure of the main header, version 0 (Kirkwood, Dove) */
36 struct main_hdr_v0 {
37         uint8_t  blockid;               /*0     */
38         uint8_t  nandeccmode;           /*1     */
39         uint16_t nandpagesize;          /*2-3   */
40         uint32_t blocksize;             /*4-7   */
41         uint32_t rsvd1;                 /*8-11  */
42         uint32_t srcaddr;               /*12-15 */
43         uint32_t destaddr;              /*16-19 */
44         uint32_t execaddr;              /*20-23 */
45         uint8_t  satapiomode;           /*24    */
46         uint8_t  rsvd3;                 /*25    */
47         uint16_t ddrinitdelay;          /*26-27 */
48         uint16_t rsvd2;                 /*28-29 */
49         uint8_t  ext;                   /*30    */
50         uint8_t  checksum;              /*31    */
51 };
52
53 struct ext_hdr_v0_reg {
54         uint32_t raddr;
55         uint32_t rdata;
56 };
57
58 #define EXT_HDR_V0_REG_COUNT ((0x1dc - 0x20) / sizeof(struct ext_hdr_v0_reg))
59
60 struct ext_hdr_v0 {
61         uint32_t              offset;
62         uint8_t               reserved[0x20 - sizeof(uint32_t)];
63         struct ext_hdr_v0_reg rcfg[EXT_HDR_V0_REG_COUNT];
64         uint8_t               reserved2[7];
65         uint8_t               checksum;
66 };
67
68 struct kwb_header {
69         struct main_hdr_v0      kwb_hdr;
70         struct ext_hdr_v0       kwb_exthdr;
71 };
72
73 /* Structure of the main header, version 1 (Armada 370, Armada XP) */
74 struct main_hdr_v1 {
75         uint8_t  blockid;               /* 0 */
76         uint8_t  flags;                 /* 1 */
77         uint16_t reserved2;             /* 2-3 */
78         uint32_t blocksize;             /* 4-7 */
79         uint8_t  version;               /* 8 */
80         uint8_t  headersz_msb;          /* 9 */
81         uint16_t headersz_lsb;          /* A-B */
82         uint32_t srcaddr;               /* C-F */
83         uint32_t destaddr;              /* 10-13 */
84         uint32_t execaddr;              /* 14-17 */
85         uint8_t  options;               /* 18 */
86         uint8_t  nandblocksize;         /* 19 */
87         uint8_t  nandbadblklocation;    /* 1A */
88         uint8_t  reserved4;             /* 1B */
89         uint16_t reserved5;             /* 1C-1D */
90         uint8_t  ext;                   /* 1E */
91         uint8_t  checksum;              /* 1F */
92 };
93
94 /*
95  * Main header options
96  */
97 #define MAIN_HDR_V1_OPT_BAUD_DEFAULT    0
98 #define MAIN_HDR_V1_OPT_BAUD_2400       0x1
99 #define MAIN_HDR_V1_OPT_BAUD_4800       0x2
100 #define MAIN_HDR_V1_OPT_BAUD_9600       0x3
101 #define MAIN_HDR_V1_OPT_BAUD_19200      0x4
102 #define MAIN_HDR_V1_OPT_BAUD_38400      0x5
103 #define MAIN_HDR_V1_OPT_BAUD_57600      0x6
104 #define MAIN_HDR_V1_OPT_BAUD_115200     0x7
105
106 /*
107  * Header for the optional headers, version 1 (Armada 370, Armada XP)
108  */
109 struct opt_hdr_v1 {
110         uint8_t  headertype;
111         uint8_t  headersz_msb;
112         uint16_t headersz_lsb;
113         char     data[0];
114 };
115
116 /*
117  * Various values for the opt_hdr_v1->headertype field, describing the
118  * different types of optional headers. The "secure" header contains
119  * informations related to secure boot (encryption keys, etc.). The
120  * "binary" header contains ARM binary code to be executed prior to
121  * executing the main payload (usually the bootloader). This is
122  * typically used to execute DDR3 training code. The "register" header
123  * allows to describe a set of (address, value) tuples that are
124  * generally used to configure the DRAM controller.
125  */
126 #define OPT_HDR_V1_SECURE_TYPE   0x1
127 #define OPT_HDR_V1_BINARY_TYPE   0x2
128 #define OPT_HDR_V1_REGISTER_TYPE 0x3
129
130 #define KWBHEADER_V1_SIZE(hdr) \
131         (((hdr)->headersz_msb << 16) | le16_to_cpu((hdr)->headersz_lsb))
132
133 enum kwbimage_cmd {
134         CMD_INVALID,
135         CMD_BOOT_FROM,
136         CMD_NAND_ECC_MODE,
137         CMD_NAND_PAGE_SIZE,
138         CMD_SATA_PIO_MODE,
139         CMD_DDR_INIT_DELAY,
140         CMD_DATA
141 };
142
143 enum kwbimage_cmd_types {
144         CFG_INVALID = -1,
145         CFG_COMMAND,
146         CFG_DATA0,
147         CFG_DATA1
148 };
149
150 /*
151  * functions
152  */
153 void init_kwb_image_type (void);
154
155 /*
156  * Byte 8 of the image header contains the version number. In the v0
157  * header, byte 8 was reserved, and always set to 0. In the v1 header,
158  * byte 8 has been changed to a proper field, set to 1.
159  */
160 static inline unsigned int image_version(void *header)
161 {
162         unsigned char *ptr = header;
163         return ptr[8];
164 }
165
166 #endif /* _KWBIMAGE_H_ */