1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright 2018 NXP
4 *
5 * Peng Fan <peng.fan@nxp.com>
6 */
7
8
9 #include "imagetool.h"
10 #include <image.h>
11 #include "imximage.h"
12 #include "compiler.h"
13
14 static uint32_t ap_start_addr, sld_start_addr, sld_src_off;
15 static char *ap_img, *sld_img, *signed_hdmi;
16 static imx_header_v3_t imx_header[2]; /* At most there are 3 IVT headers */
17 static uint32_t rom_image_offset;
18 static uint32_t sector_size = 0x200;
19 static uint32_t image_off;
20 static uint32_t sld_header_off;
21 static uint32_t ivt_offset;
22 static uint32_t using_fit;
23
24 #define ROM_V1 1
25 #define ROM_V2 2
26
27 static uint32_t rom_version = ROM_V1;
28
29 #define CSF_SIZE 0x2000
30 #define HDMI_IVT_ID 0
31 #define IMAGE_IVT_ID 1
32
33 #define HDMI_FW_SIZE 0x17000 /* Use Last 0x1000 for IVT and CSF */
34 #define ALIGN_SIZE 0x1000
35 #define ALIGN(x,a) __ALIGN_MASK((x), (__typeof__(x))(a) - 1, a)
36 #define __ALIGN_MASK(x,mask,mask2) (((x) + (mask)) / (mask2) * (mask2))
37
get_cfg_value(char * token,char * name,int linenr)38 static uint32_t get_cfg_value(char *token, char *name, int linenr)
39 {
40 char *endptr;
41 uint32_t value;
42
43 errno = 0;
44 value = strtoul(token, &endptr, 16);
45 if (errno || token == endptr) {
46 fprintf(stderr, "Error: %s[%d] - Invalid hex data(%s)\n",
47 name, linenr, token);
48 exit(EXIT_FAILURE);
49 }
50 return value;
51 }
52
imx8mimage_check_params(struct image_tool_params * params)53 int imx8mimage_check_params(struct image_tool_params *params)
54 {
55 return 0;
56 }
57
imx8mimage_set_header(void * ptr,struct stat * sbuf,int ifd,struct image_tool_params * params)58 static void imx8mimage_set_header(void *ptr, struct stat *sbuf, int ifd,
59 struct image_tool_params *params)
60 {
61 }
62
imx8mimage_print_header(const void * ptr)63 static void imx8mimage_print_header(const void *ptr)
64 {
65 }
66
imx8mimage_check_image_types(uint8_t type)67 static int imx8mimage_check_image_types(uint8_t type)
68 {
69 return (type == IH_TYPE_IMX8MIMAGE) ? EXIT_SUCCESS : EXIT_FAILURE;
70 }
71
72 static table_entry_t imx8mimage_cmds[] = {
73 {CMD_BOOT_FROM, "BOOT_FROM", "boot command", },
74 {CMD_FIT, "FIT", "fit image", },
75 {CMD_SIGNED_HDMI, "SIGNED_HDMI", "signed hdmi image", },
76 {CMD_LOADER, "LOADER", "loader image", },
77 {CMD_SECOND_LOADER, "SECOND_LOADER", "2nd loader image", },
78 {CMD_DDR_FW, "DDR_FW", "ddr firmware", },
79 {CMD_ROM_VERSION, "ROM_VERSION", "rom version", },
80 {-1, "", "", },
81 };
82
83 static table_entry_t imx8mimage_ivt_offset[] = {
84 {0x400, "sd", "sd/emmc",},
85 {0x400, "emmc_fastboot", "emmc fastboot",},
86 {0x1000, "fspi", "flexspi", },
87 {-1, "", "Invalid", },
88 };
89
parse_cfg_cmd(int32_t cmd,char * token,char * name,int lineno)90 static void parse_cfg_cmd(int32_t cmd, char *token, char *name, int lineno)
91 {
92 switch (cmd) {
93 case CMD_BOOT_FROM:
94 ivt_offset = get_table_entry_id(imx8mimage_ivt_offset,
95 "imx8mimage ivt offset",
96 token);
97 if (!strncmp(token, "sd", 2))
98 rom_image_offset = 0x8000;
99
100 if (rom_version == ROM_V2)
101 ivt_offset = 0;
102 break;
103 case CMD_LOADER:
104 ap_img = token;
105 break;
106 case CMD_SECOND_LOADER:
107 sld_img = token;
108 break;
109 case CMD_SIGNED_HDMI:
110 signed_hdmi = token;
111 break;
112 case CMD_DDR_FW:
113 /* Do nothing */
114 break;
115 case CMD_ROM_VERSION:
116 if (!strncmp(token, "v2", 2)) {
117 rom_version = ROM_V2;
118 ivt_offset = 0;
119 } else if (!strncmp(token, "v1", 2)) {
120 rom_version = ROM_V1;
121 }
122 break;
123
124 }
125 }
126
parse_cfg_fld(int32_t * cmd,char * token,char * name,int lineno,int fld)127 static void parse_cfg_fld(int32_t *cmd, char *token,
128 char *name, int lineno, int fld)
129 {
130 switch (fld) {
131 case CFG_COMMAND:
132 *cmd = get_table_entry_id(imx8mimage_cmds,
133 "imx8mimage commands", token);
134 if (*cmd < 0) {
135 fprintf(stderr, "Error: %s[%d] - Invalid command" "(%s)\n",
136 name, lineno, token);
137 exit(EXIT_FAILURE);
138 }
139 switch (*cmd) {
140 case CMD_FIT:
141 using_fit = 1;
142 break;
143 }
144 break;
145 case CFG_REG_SIZE:
146 parse_cfg_cmd(*cmd, token, name, lineno);
147 break;
148 case CFG_REG_ADDRESS:
149 switch (*cmd) {
150 case CMD_LOADER:
151 ap_start_addr = get_cfg_value(token, name, lineno);
152 break;
153 case CMD_SECOND_LOADER:
154 sld_start_addr = get_cfg_value(token, name, lineno);
155 break;
156 }
157 break;
158 case CFG_REG_VALUE:
159 switch (*cmd) {
160 case CMD_SECOND_LOADER:
161 sld_src_off = get_cfg_value(token, name, lineno);
162 break;
163 }
164 default:
165 break;
166 }
167 }
168
parse_cfg_file(char * name)169 static uint32_t parse_cfg_file(char *name)
170 {
171 FILE *fd = NULL;
172 char *line = NULL;
173 char *token, *saveptr1, *saveptr2;
174 int lineno = 0;
175 int fld;
176 size_t len;
177 int32_t cmd;
178
179 fd = fopen(name, "r");
180 if (fd == 0) {
181 fprintf(stderr, "Error: %s - Can't open cfg file\n", name);
182 exit(EXIT_FAILURE);
183 }
184
185 /*
186 * Very simple parsing, line starting with # are comments
187 * and are dropped
188 */
189 while ((getline(&line, &len, fd)) > 0) {
190 lineno++;
191
192 token = strtok_r(line, "\r\n", &saveptr1);
193 if (!token)
194 continue;
195
196 /* Check inside the single line */
197 for (fld = CFG_COMMAND, cmd = CFG_INVALID,
198 line = token; ; line = NULL, fld++) {
199 token = strtok_r(line, " \t", &saveptr2);
200 if (!token)
201 break;
202
203 /* Drop all text starting with '#' as comments */
204 if (token[0] == '#')
205 break;
206
207 parse_cfg_fld(&cmd, token, name, lineno, fld);
208 }
209 }
210
211 return 0;
212 }
213
fill_zero(int ifd,int size,int offset)214 static void fill_zero(int ifd, int size, int offset)
215 {
216 int fill_size;
217 uint8_t zeros[4096];
218 int ret;
219
220 memset(zeros, 0, sizeof(zeros));
221
222 ret = lseek(ifd, offset, SEEK_SET);
223 if (ret < 0) {
224 fprintf(stderr, "%s seek: %s\n", __func__, strerror(errno));
225 exit(EXIT_FAILURE);
226 }
227
228 while (size) {
229 if (size > 4096)
230 fill_size = 4096;
231 else
232 fill_size = size;
233
234 if (write(ifd, (char *)&zeros, fill_size) != fill_size) {
235 fprintf(stderr, "Write error: %s\n",
236 strerror(errno));
237 exit(EXIT_FAILURE);
238 }
239
240 size -= fill_size;
241 };
242 }
243
copy_file(int ifd,const char * datafile,int pad,int offset,int datafile_offset)244 static void copy_file(int ifd, const char *datafile, int pad, int offset,
245 int datafile_offset)
246 {
247 int dfd;
248 struct stat sbuf;
249 unsigned char *ptr;
250 int tail;
251 int zero = 0;
252 uint8_t zeros[4096];
253 int size, ret;
254
255 memset(zeros, 0, sizeof(zeros));
256
257 dfd = open(datafile, O_RDONLY | O_BINARY);
258 if (dfd < 0) {
259 fprintf(stderr, "Can't open %s: %s\n",
260 datafile, strerror(errno));
261 exit(EXIT_FAILURE);
262 }
263
264 if (fstat(dfd, &sbuf) < 0) {
265 fprintf(stderr, "Can't stat %s: %s\n",
266 datafile, strerror(errno));
267 exit(EXIT_FAILURE);
268 }
269
270 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
271 if (ptr == MAP_FAILED) {
272 fprintf(stderr, "Can't read %s: %s\n",
273 datafile, strerror(errno));
274 exit(EXIT_FAILURE);
275 }
276
277 size = sbuf.st_size - datafile_offset;
278 ret = lseek(ifd, offset, SEEK_SET);
279 if (ret < 0) {
280 fprintf(stderr, "lseek ifd fail\n");
281 exit(EXIT_FAILURE);
282 }
283
284 if (write(ifd, ptr + datafile_offset, size) != size) {
285 fprintf(stderr, "Write error %s\n",
286 strerror(errno));
287 exit(EXIT_FAILURE);
288 }
289
290 tail = size % 4;
291 pad = pad - size;
292 if (pad == 1 && tail != 0) {
293 if (write(ifd, (char *)&zero, 4 - tail) != 4 - tail) {
294 fprintf(stderr, "Write error on %s\n",
295 strerror(errno));
296 exit(EXIT_FAILURE);
297 }
298 } else if (pad > 1) {
299 while (pad > 0) {
300 int todo = sizeof(zeros);
301
302 if (todo > pad)
303 todo = pad;
304 if (write(ifd, (char *)&zeros, todo) != todo) {
305 fprintf(stderr, "Write error: %s\n",
306 strerror(errno));
307 exit(EXIT_FAILURE);
308 }
309 pad -= todo;
310 }
311 }
312
313 munmap((void *)ptr, sbuf.st_size);
314 close(dfd);
315 }
316
317 /* Return this IVT offset in the final output file */
generate_ivt_for_fit(int fd,int fit_offset,uint32_t ep,uint32_t * fit_load_addr)318 static int generate_ivt_for_fit(int fd, int fit_offset, uint32_t ep,
319 uint32_t *fit_load_addr)
320 {
321 image_header_t image_header;
322 int ret;
323
324 uint32_t fit_size, load_addr;
325 int align_len = 64 - 1; /* 64 is cacheline size */
326
327 ret = lseek(fd, fit_offset, SEEK_SET);
328 if (ret < 0) {
329 fprintf(stderr, "lseek fd fail for fit\n");
330 exit(EXIT_FAILURE);
331 }
332
333 if (read(fd, (char *)&image_header, sizeof(image_header_t)) !=
334 sizeof(image_header_t)) {
335 fprintf(stderr, "generate_ivt_for_fit read failed: %s\n",
336 strerror(errno));
337 exit(EXIT_FAILURE);
338 }
339
340 if (be32_to_cpu(image_header.ih_magic) != FDT_MAGIC) {
341 fprintf(stderr, "%s error: not a FIT file\n", __func__);
342 exit(EXIT_FAILURE);
343 }
344
345 fit_size = fdt_totalsize(&image_header);
346 fit_size = (fit_size + 3) & ~3;
347
348 fit_size = ALIGN(fit_size, ALIGN_SIZE);
349
350 ret = lseek(fd, fit_offset + fit_size, SEEK_SET);
351 if (ret < 0) {
352 fprintf(stderr, "lseek fd fail for fit\n");
353 exit(EXIT_FAILURE);
354 }
355
356 /*
357 * ep is the u-boot entry. SPL loads the FIT before the u-boot
358 * address. 0x2000 is for CSF_SIZE
359 */
360 load_addr = (ep - (fit_size + CSF_SIZE) - 512 - align_len) &
361 ~align_len;
362
363 flash_header_v2_t ivt_header = { { 0xd1, 0x2000, 0x40 },
364 load_addr, 0, 0, 0,
365 (load_addr + fit_size),
366 (load_addr + fit_size + 0x20),
367 0 };
368
369 if (write(fd, &ivt_header, sizeof(flash_header_v2_t)) !=
370 sizeof(flash_header_v2_t)) {
371 fprintf(stderr, "IVT writing error on fit image\n");
372 exit(EXIT_FAILURE);
373 }
374
375 *fit_load_addr = load_addr;
376
377 return fit_offset + fit_size;
378 }
379
dump_header_v2(imx_header_v3_t * imx_header,int index)380 static void dump_header_v2(imx_header_v3_t *imx_header, int index)
381 {
382 const char *ivt_name[2] = {"HDMI FW", "LOADER IMAGE"};
383
384 fprintf(stdout, "========= IVT HEADER [%s] =========\n",
385 ivt_name[index]);
386 fprintf(stdout, "header.tag: \t\t0x%x\n",
387 imx_header[index].fhdr.header.tag);
388 fprintf(stdout, "header.length: \t\t0x%x\n",
389 imx_header[index].fhdr.header.length);
390 fprintf(stdout, "header.version: \t0x%x\n",
391 imx_header[index].fhdr.header.version);
392 fprintf(stdout, "entry: \t\t\t0x%x\n",
393 imx_header[index].fhdr.entry);
394 fprintf(stdout, "reserved1: \t\t0x%x\n",
395 imx_header[index].fhdr.reserved1);
396 fprintf(stdout, "dcd_ptr: \t\t0x%x\n",
397 imx_header[index].fhdr.dcd_ptr);
398 fprintf(stdout, "boot_data_ptr: \t\t0x%x\n",
399 imx_header[index].fhdr.boot_data_ptr);
400 fprintf(stdout, "self: \t\t\t0x%x\n",
401 imx_header[index].fhdr.self);
402 fprintf(stdout, "csf: \t\t\t0x%x\n",
403 imx_header[index].fhdr.csf);
404 fprintf(stdout, "reserved2: \t\t0x%x\n",
405 imx_header[index].fhdr.reserved2);
406
407 fprintf(stdout, "boot_data.start: \t0x%x\n",
408 imx_header[index].boot_data.start);
409 fprintf(stdout, "boot_data.size: \t0x%x\n",
410 imx_header[index].boot_data.size);
411 fprintf(stdout, "boot_data.plugin: \t0x%x\n",
412 imx_header[index].boot_data.plugin);
413 }
414
build_image(int ofd)415 void build_image(int ofd)
416 {
417 int file_off, header_hdmi_off = 0, header_image_off;
418 int hdmi_fd, ap_fd, sld_fd;
419 uint32_t sld_load_addr = 0;
420 uint32_t csf_off, sld_csf_off = 0;
421 int ret;
422 struct stat sbuf;
423
424 if (!ap_img) {
425 fprintf(stderr, "No LOADER image specificed\n");
426 exit(EXIT_FAILURE);
427 }
428
429 file_off = 0;
430
431 if (signed_hdmi) {
432 header_hdmi_off = file_off + ivt_offset;
433
434 hdmi_fd = open(signed_hdmi, O_RDONLY | O_BINARY);
435 if (hdmi_fd < 0) {
436 fprintf(stderr, "%s: Can't open: %s\n",
437 signed_hdmi, strerror(errno));
438 exit(EXIT_FAILURE);
439 }
440
441 if (fstat(hdmi_fd, &sbuf) < 0) {
442 fprintf(stderr, "%s: Can't stat: %s\n",
443 signed_hdmi, strerror(errno));
444 exit(EXIT_FAILURE);
445 }
446 close(hdmi_fd);
447
448 /*
449 * Aligned to 104KB = 92KB FW image + 0x8000
450 * (IVT and alignment) + 0x4000 (second IVT + CSF)
451 */
452 file_off += ALIGN(sbuf.st_size,
453 HDMI_FW_SIZE + 0x2000 + 0x1000);
454 }
455
456 header_image_off = file_off + ivt_offset;
457
458 ap_fd = open(ap_img, O_RDONLY | O_BINARY);
459 if (ap_fd < 0) {
460 fprintf(stderr, "%s: Can't open: %s\n",
461 ap_img, strerror(errno));
462 exit(EXIT_FAILURE);
463 }
464 if (fstat(ap_fd, &sbuf) < 0) {
465 fprintf(stderr, "%s: Can't stat: %s\n",
466 ap_img, strerror(errno));
467 exit(EXIT_FAILURE);
468 }
469 close(ap_fd);
470
471 imx_header[IMAGE_IVT_ID].fhdr.header.tag = IVT_HEADER_TAG; /* 0xD1 */
472 imx_header[IMAGE_IVT_ID].fhdr.header.length =
473 cpu_to_be16(sizeof(flash_header_v2_t));
474 imx_header[IMAGE_IVT_ID].fhdr.header.version = IVT_VERSION_V3; /* 0x41 */
475 imx_header[IMAGE_IVT_ID].fhdr.entry = ap_start_addr;
476 imx_header[IMAGE_IVT_ID].fhdr.self = ap_start_addr -
477 sizeof(imx_header_v3_t);
478 imx_header[IMAGE_IVT_ID].fhdr.dcd_ptr = 0;
479 imx_header[IMAGE_IVT_ID].fhdr.boot_data_ptr =
480 imx_header[IMAGE_IVT_ID].fhdr.self +
481 offsetof(imx_header_v3_t, boot_data);
482 imx_header[IMAGE_IVT_ID].boot_data.start =
483 imx_header[IMAGE_IVT_ID].fhdr.self - ivt_offset;
484 imx_header[IMAGE_IVT_ID].boot_data.size =
485 ALIGN(sbuf.st_size + sizeof(imx_header_v3_t) + ivt_offset,
486 sector_size);
487
488 image_off = header_image_off + sizeof(imx_header_v3_t);
489 file_off += imx_header[IMAGE_IVT_ID].boot_data.size;
490
491 imx_header[IMAGE_IVT_ID].boot_data.plugin = 0;
492 imx_header[IMAGE_IVT_ID].fhdr.csf =
493 imx_header[IMAGE_IVT_ID].boot_data.start +
494 imx_header[IMAGE_IVT_ID].boot_data.size;
495
496 imx_header[IMAGE_IVT_ID].boot_data.size += CSF_SIZE; /* 8K region dummy CSF */
497
498 csf_off = file_off;
499 file_off += CSF_SIZE;
500
501 /* Second boot loader image */
502 if (sld_img) {
503 if (!using_fit) {
504 fprintf(stderr, "Not support no fit\n");
505 exit(EXIT_FAILURE);
506 } else {
507 sld_header_off = sld_src_off - rom_image_offset;
508 /*
509 * Record the second bootloader relative offset in
510 * image's IVT reserved1
511 */
512 if (rom_version == ROM_V1) {
513 imx_header[IMAGE_IVT_ID].fhdr.reserved1 =
514 sld_header_off - header_image_off;
515 }
516 sld_fd = open(sld_img, O_RDONLY | O_BINARY);
517 if (sld_fd < 0) {
518 fprintf(stderr, "%s: Can't open: %s\n",
519 sld_img, strerror(errno));
520 exit(EXIT_FAILURE);
521 }
522
523 if (fstat(sld_fd, &sbuf) < 0) {
524 fprintf(stderr, "%s: Can't stat: %s\n",
525 sld_img, strerror(errno));
526 exit(EXIT_FAILURE);
527 }
528
529 close(sld_fd);
530
531 file_off = sld_header_off;
532 file_off += sbuf.st_size + sizeof(image_header_t);
533 }
534 }
535
536 if (signed_hdmi) {
537 header_hdmi_off -= ivt_offset;
538 ret = lseek(ofd, header_hdmi_off, SEEK_SET);
539 if (ret < 0) {
540 fprintf(stderr, "lseek ofd fail for hdmi\n");
541 exit(EXIT_FAILURE);
542 }
543
544 /* The signed HDMI FW has 0x400 IVT offset, need remove it */
545 copy_file(ofd, signed_hdmi, 0, header_hdmi_off, 0x400);
546 }
547
548 /* Main Image */
549 header_image_off -= ivt_offset;
550 image_off -= ivt_offset;
551 ret = lseek(ofd, header_image_off, SEEK_SET);
552 if (ret < 0) {
553 fprintf(stderr, "lseek ofd fail\n");
554 exit(EXIT_FAILURE);
555 }
556
557 /* Write image header */
558 if (write(ofd, &imx_header[IMAGE_IVT_ID], sizeof(imx_header_v3_t)) !=
559 sizeof(imx_header_v3_t)) {
560 fprintf(stderr, "error writing image hdr\n");
561 exit(1);
562 }
563
564 copy_file(ofd, ap_img, 0, image_off, 0);
565
566 csf_off -= ivt_offset;
567 fill_zero(ofd, CSF_SIZE, csf_off);
568
569 if (sld_img) {
570 sld_header_off -= ivt_offset;
571 ret = lseek(ofd, sld_header_off, SEEK_SET);
572 if (ret < 0) {
573 fprintf(stderr, "lseek ofd fail for sld_img\n");
574 exit(EXIT_FAILURE);
575 }
576
577 /* Write image header */
578 if (!using_fit) {
579 /* TODO */
580 } else {
581 copy_file(ofd, sld_img, 0, sld_header_off, 0);
582 sld_csf_off =
583 generate_ivt_for_fit(ofd, sld_header_off,
584 sld_start_addr,
585 &sld_load_addr) + 0x20;
586 }
587 }
588
589 if (!signed_hdmi)
590 dump_header_v2(imx_header, 0);
591 dump_header_v2(imx_header, 1);
592
593 fprintf(stdout, "========= OFFSET dump =========");
594 if (signed_hdmi) {
595 fprintf(stdout, "\nSIGNED HDMI FW:\n");
596 fprintf(stdout, " header_hdmi_off \t0x%x\n",
597 header_hdmi_off);
598 }
599
600 fprintf(stdout, "\nLoader IMAGE:\n");
601 fprintf(stdout, " header_image_off \t0x%x\n image_off \t\t0x%x\n csf_off \t\t0x%x\n",
602 header_image_off, image_off, csf_off);
603 fprintf(stdout, " spl hab block: \t0x%x 0x%x 0x%x\n",
604 imx_header[IMAGE_IVT_ID].fhdr.self, header_image_off,
605 csf_off - header_image_off);
606
607 fprintf(stdout, "\nSecond Loader IMAGE:\n");
608 fprintf(stdout, " sld_header_off \t0x%x\n",
609 sld_header_off);
610 fprintf(stdout, " sld_csf_off \t\t0x%x\n",
611 sld_csf_off);
612 fprintf(stdout, " sld hab block: \t0x%x 0x%x 0x%x\n",
613 sld_load_addr, sld_header_off, sld_csf_off - sld_header_off);
614 }
615
imx8mimage_copy_image(int outfd,struct image_tool_params * mparams)616 int imx8mimage_copy_image(int outfd, struct image_tool_params *mparams)
617 {
618 /*
619 * SECO FW is a container image, this is to calculate the
620 * 2nd container offset.
621 */
622 fprintf(stdout, "parsing %s\n", mparams->imagename);
623 parse_cfg_file(mparams->imagename);
624
625 build_image(outfd);
626
627 return 0;
628 }
629
630 /*
631 * imx8mimage parameters
632 */
633 U_BOOT_IMAGE_TYPE(
634 imx8mimage,
635 "NXP i.MX8M Boot Image support",
636 0,
637 NULL,
638 imx8mimage_check_params,
639 NULL,
640 imx8mimage_print_header,
641 imx8mimage_set_header,
642 NULL,
643 imx8mimage_check_image_types,
644 NULL,
645 NULL
646 );
647