1 From 18dd1ef9417d0880f2f492b55bd4d9ede499f137 Mon Sep 17 00:00:00 2001
2 From: Weijie Gao <weijie.gao@mediatek.com>
3 Date: Fri, 20 May 2022 11:24:10 +0800
4 Subject: [PATCH 24/25] tools: mtk_image: add support for MT7621 NAND images
6 The BootROM of MT7621 requires a image header for SPL to record its size
7 and load address when booting from NAND.
9 To create such an image, one can use the following command line:
10 mkimage -T mtk_image -a 0x80200000 -e 0x80200000 -n "mt7621=1"
11 -d u-boot-spl-ddr.bin u-boot-spl-ddr.img
13 Reviewed-by: Daniel Schwierzeck <daniel.schwierzeck@gmail.com>
14 Signed-off-by: Weijie Gao <weijie.gao@mediatek.com>
16 tools/mtk_image.c | 182 ++++++++++++++++++++++++++++++++++++++++++++++
17 tools/mtk_image.h | 24 ++++++
18 2 files changed, 206 insertions(+)
20 diff --git a/tools/mtk_image.c b/tools/mtk_image.c
21 index 418c5fd54b..de5ce4d964 100644
22 --- a/tools/mtk_image.c
23 +++ b/tools/mtk_image.c
25 * Author: Weijie Gao <weijie.gao@mediatek.com>
30 +#include <u-boot/crc.h>
31 #include <u-boot/sha256.h>
32 #include "imagetool.h"
33 #include "mtk_image.h"
34 @@ -251,17 +253,45 @@ static uint32_t img_size;
35 static enum brlyt_img_type hdr_media;
36 static uint32_t hdr_offset;
37 static int use_lk_hdr;
38 +static int use_mt7621_hdr;
39 static bool is_arm64_image;
42 static char lk_name[32] = "U-Boot";
44 +/* CRC32 normal table required by MT7621 image */
45 +static uint32_t crc32tbl[256];
47 /* NAND header selected by user */
48 static const union nand_boot_header *hdr_nand;
50 /* GFH header + 2 * 4KB pages of NAND */
51 static char hdr_tmp[sizeof(struct gfh_header) + 0x2000];
53 +static uint32_t crc32_normal_cal(uint32_t crc, const void *data, size_t length,
54 + const uint32_t *crc32c_table)
56 + const uint8_t *p = data;
59 + crc = crc32c_table[(uint8_t)((crc >> 24) ^ *p++)] ^ (crc << 8);
64 +static void crc32_normal_init(uint32_t *crc32c_table, uint32_t poly)
68 + for (i = 0; i < 256; i++) {
70 + for (j = 0; j < 8; j++)
71 + v = (v << 1) ^ ((v & (1 << 31)) ? poly : 0);
73 + crc32c_table[i] = v;
77 static int mtk_image_check_image_types(uint8_t type)
79 if (type == IH_TYPE_MTKIMAGE)
80 @@ -283,6 +313,7 @@ static int mtk_brom_parse_imagename(const char *imagename)
81 static const char *hdr_offs = "";
82 static const char *nandinfo = "";
83 static const char *lk = "";
84 + static const char *mt7621 = "";
85 static const char *arm64_param = "";
88 @@ -332,6 +363,9 @@ static int mtk_brom_parse_imagename(const char *imagename)
89 if (!strcmp(key, "lk"))
92 + if (!strcmp(key, "mt7621"))
95 if (!strcmp(key, "lkname"))
96 snprintf(lk_name, sizeof(lk_name), "%s", val);
98 @@ -352,6 +386,13 @@ static int mtk_brom_parse_imagename(const char *imagename)
102 + /* if user specified MT7621 image header, skip following checks */
103 + if (mt7621 && mt7621[0] == '1') {
104 + use_mt7621_hdr = 1;
109 /* parse media type */
110 for (i = 0; i < ARRAY_SIZE(brom_images); i++) {
111 if (!strcmp(brom_images[i].name, media)) {
112 @@ -419,6 +460,13 @@ static int mtk_image_vrec_header(struct image_tool_params *params,
116 + if (use_mt7621_hdr) {
117 + tparams->header_size = image_get_header_size();
118 + tparams->hdr = &hdr_tmp;
119 + memset(&hdr_tmp, 0, tparams->header_size);
123 if (hdr_media == BRLYT_TYPE_NAND || hdr_media == BRLYT_TYPE_SNAND)
124 tparams->header_size = 2 * le16_to_cpu(hdr_nand->pagesize);
126 @@ -579,9 +627,90 @@ static int mtk_image_verify_nand_header(const uint8_t *ptr, int print)
130 +static uint32_t crc32be_cal(const void *data, size_t length)
135 + if (crc32tbl[1] != MT7621_IH_CRC_POLYNOMIAL)
136 + crc32_normal_init(crc32tbl, MT7621_IH_CRC_POLYNOMIAL);
138 + crc = crc32_normal_cal(crc, data, length, crc32tbl);
140 + for (; length; length >>= 8) {
142 + crc = crc32_normal_cal(crc, &c, 1, crc32tbl);
148 +static int mtk_image_verify_mt7621_header(const uint8_t *ptr, int print)
150 + const image_header_t *hdr = (const image_header_t *)ptr;
151 + struct mt7621_nand_header *nhdr;
152 + uint32_t spl_size, crcval;
153 + image_header_t header;
156 + spl_size = image_get_size(hdr);
158 + if (spl_size > img_size) {
160 + printf("Incomplete SPL image\n");
164 + ret = image_check_hcrc(hdr);
167 + printf("Bad header CRC\n");
171 + ret = image_check_dcrc(hdr);
174 + printf("Bad data CRC\n");
178 + /* Copy header so we can blank CRC field for re-calculation */
179 + memmove(&header, hdr, image_get_header_size());
180 + image_set_hcrc(&header, 0);
182 + nhdr = (struct mt7621_nand_header *)header.ih_name;
183 + crcval = be32_to_cpu(nhdr->crc);
186 + if (crcval != crc32be_cal(&header, image_get_header_size())) {
188 + printf("Bad NAND header CRC\n");
193 + printf("Load Address: %08x\n", image_get_load(hdr));
195 + printf("Image Name: %.*s\n", MT7621_IH_NMLEN,
196 + image_get_name(hdr));
198 + if (IMAGE_ENABLE_TIMESTAMP) {
199 + printf("Created: ");
200 + genimg_print_time((time_t)image_get_time(hdr));
203 + printf("Data Size: ");
204 + genimg_print_size(image_get_data_size(hdr));
210 static int mtk_image_verify_header(unsigned char *ptr, int image_size,
211 struct image_tool_params *params)
213 + image_header_t *hdr = (image_header_t *)ptr;
214 union lk_hdr *lk = (union lk_hdr *)ptr;
216 /* nothing to verify for LK image header */
217 @@ -590,6 +719,9 @@ static int mtk_image_verify_header(unsigned char *ptr, int image_size,
219 img_size = image_size;
221 + if (image_get_magic(hdr) == IH_MAGIC)
222 + return mtk_image_verify_mt7621_header(ptr, 0);
224 if (!strcmp((char *)ptr, NAND_BOOT_NAME))
225 return mtk_image_verify_nand_header(ptr, 0);
227 @@ -600,6 +732,7 @@ static int mtk_image_verify_header(unsigned char *ptr, int image_size,
229 static void mtk_image_print_header(const void *ptr)
231 + image_header_t *hdr = (image_header_t *)ptr;
232 union lk_hdr *lk = (union lk_hdr *)ptr;
234 if (le32_to_cpu(lk->magic) == LK_PART_MAGIC) {
235 @@ -610,6 +743,11 @@ static void mtk_image_print_header(const void *ptr)
237 printf("Image Type: MediaTek BootROM Loadable Image\n");
239 + if (image_get_magic(hdr) == IH_MAGIC) {
240 + mtk_image_verify_mt7621_header(ptr, 1);
244 if (!strcmp((char *)ptr, NAND_BOOT_NAME))
245 mtk_image_verify_nand_header(ptr, 1);
247 @@ -773,6 +911,45 @@ static void mtk_image_set_nand_header(void *ptr, off_t filesize,
248 filesize - 2 * le16_to_cpu(hdr_nand->pagesize) - SHA256_SUM_LEN);
251 +static void mtk_image_set_mt7621_header(void *ptr, off_t filesize,
254 + image_header_t *hdr = (image_header_t *)ptr;
255 + struct mt7621_stage1_header *shdr;
256 + struct mt7621_nand_header *nhdr;
257 + uint32_t datasize, crcval;
259 + datasize = filesize - image_get_header_size();
260 + nhdr = (struct mt7621_nand_header *)hdr->ih_name;
261 + shdr = (struct mt7621_stage1_header *)(ptr + image_get_header_size());
263 + shdr->ep = cpu_to_be32(loadaddr);
264 + shdr->stage_size = cpu_to_be32(datasize);
266 + image_set_magic(hdr, IH_MAGIC);
267 + image_set_time(hdr, time(NULL));
268 + image_set_size(hdr, datasize);
269 + image_set_load(hdr, loadaddr);
270 + image_set_ep(hdr, loadaddr);
271 + image_set_os(hdr, IH_OS_U_BOOT);
272 + image_set_arch(hdr, IH_ARCH_MIPS);
273 + image_set_type(hdr, IH_TYPE_STANDALONE);
274 + image_set_comp(hdr, IH_COMP_NONE);
276 + crcval = crc32(0, (uint8_t *)shdr, datasize);
277 + image_set_dcrc(hdr, crcval);
279 + strncpy(nhdr->ih_name, "MT7621 NAND", MT7621_IH_NMLEN);
281 + nhdr->ih_stage_offset = cpu_to_be32(image_get_header_size());
283 + crcval = crc32be_cal(hdr, image_get_header_size());
284 + nhdr->crc = cpu_to_be32(crcval);
286 + crcval = crc32(0, (uint8_t *)hdr, image_get_header_size());
287 + image_set_hcrc(hdr, crcval);
290 static void mtk_image_set_header(void *ptr, struct stat *sbuf, int ifd,
291 struct image_tool_params *params)
293 @@ -791,6 +968,11 @@ static void mtk_image_set_header(void *ptr, struct stat *sbuf, int ifd,
295 img_size = sbuf->st_size;
297 + if (use_mt7621_hdr) {
298 + mtk_image_set_mt7621_header(ptr, sbuf->st_size, params->addr);
302 if (hdr_media == BRLYT_TYPE_NAND || hdr_media == BRLYT_TYPE_SNAND)
303 mtk_image_set_nand_header(ptr, sbuf->st_size, params->addr);
305 diff --git a/tools/mtk_image.h b/tools/mtk_image.h
306 index 7dda71ce88..d868545a33 100644
307 --- a/tools/mtk_image.h
308 +++ b/tools/mtk_image.h
309 @@ -200,4 +200,28 @@ union lk_hdr {
311 #define LK_PART_MAGIC 0x58881688
313 +/* MT7621 NAND SPL image header */
315 +#define MT7621_IH_NMLEN 12
316 +#define MT7621_IH_CRC_POLYNOMIAL 0x04c11db7
318 +struct mt7621_nand_header {
319 + char ih_name[MT7621_IH_NMLEN];
320 + uint32_t nand_ac_timing;
321 + uint32_t ih_stage_offset;
322 + uint32_t ih_bootloader_offset;
323 + uint32_t nand_info_1_data;
327 +struct mt7621_stage1_header {
328 + uint32_t jump_insn[2];
330 + uint32_t stage_size;
331 + uint32_t has_stage2;
333 + uint32_t next_size;
334 + uint32_t next_offset;
337 #endif /* _MTK_IMAGE_H */